geekyrakshit/hyperswitch · Datasets at Hugging Face

repo stringclasses 1 value	instance_id stringlengths 24 24	problem_statement stringlengths 24 8.41k	patch stringlengths 0 367k	created_at stringdate 2023-04-18 16:43:29 2025-10-07 09:18:54	hints_text stringlengths 57 132k	version stringclasses 8 values	base_commit stringlengths 40 40	environment_setup_commit stringlengths 40 40
juspay/hyperswitch	juspay__hyperswitch-8698	Bug: [BUG] FEATURE_MATRIX shows JPMorgan does not support Refunds I added support for refunds 3 weeks ago in #8436. Feature matrix needs to be updated.	diff --git a/crates/hyperswitch_connectors/src/connectors/jpmorgan.rs b/crates/hyperswitch_connectors/src/connectors/jpmorgan.rs index 80e3d61278f..7577154f6b1 100644 --- a/crates/hyperswitch_connectors/src/connectors/jpmorgan.rs +++ b/crates/hyperswitch_connectors/src/connectors/jpmorgan.rs @@ -847,7 +847,7 @@ static JPMORGAN_SUPPORTED_PAYMENT_METHODS: LazyLock<SupportedPaymentMethods> = enums::PaymentMethodType::Debit, PaymentMethodDetails { mandates: enums::FeatureStatus::NotSupported, - refunds: enums::FeatureStatus::NotSupported, + refunds: enums::FeatureStatus::Supported, supported_capture_methods: supported_capture_methods.clone(), specific_features: Some( api_models::feature_matrix::PaymentMethodSpecificFeatures::Card({ @@ -866,7 +866,7 @@ static JPMORGAN_SUPPORTED_PAYMENT_METHODS: LazyLock<SupportedPaymentMethods> = enums::PaymentMethodType::Credit, PaymentMethodDetails { mandates: enums::FeatureStatus::NotSupported, - refunds: enums::FeatureStatus::NotSupported, + refunds: enums::FeatureStatus::Supported, supported_capture_methods: supported_capture_methods.clone(), specific_features: Some( api_models::feature_matrix::PaymentMethodSpecificFeatures::Card({	2025-07-19T18:06:43Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [x] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> This PR marks refunds as supported by JPMorgan connector. Although this does not affect refund flow, the feature matrix marking is wrong. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> I added refunds support 3 weeks ago in #8436 and this was missed. closes #8698 ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> Hit feature matrix endpoint: ```sh curl --location 'http://localhost:8080/feature_matrix' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' ``` ```json { ... "supported_payment_methods": [ { "payment_method": "card", "payment_method_type": "credit", "payment_method_type_display_name": "Credit Card", "mandates": "not_supported", "refunds": "supported", "supported_capture_methods": [ "automatic", "manual" ], "three_ds": "not_supported", "no_three_ds": "supported", "supported_card_networks": [ "AmericanExpress", "DinersClub", "Discover", "JCB", "Mastercard", ... }, { "payment_method": "card", "payment_method_type": "debit", "payment_method_type_display_name": "Debit Card", "mandates": "not_supported", "refunds": "supported", "supported_capture_methods": [ "automatic", "manual" ], "three_ds": "not_supported", "no_three_ds": "supported", "supported_card_networks": [ "AmericanExpress", "DinersClub", "Discover", "JCB", "Mastercard", "UnionPay", "Visa" ], "supported_countries": [ "FRA", "BEL", ... } ``` ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `just clippy && just clippy_v2` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	d42fad73f502933ecf50215503f0bea41813662c	d42fad73f502933ecf50215503f0bea41813662c
juspay/hyperswitch	juspay__hyperswitch-8703	Bug: [REFACTOR] facilitapay destination bank account number should be merchant facing destination bank account number should be added by merchant, not customer. this is a design flaw that needs to be fixed.	diff --git a/api-reference/v1/openapi_spec_v1.json b/api-reference/v1/openapi_spec_v1.json index ccd6d2e11b7..41af730ea71 100644 --- a/api-reference/v1/openapi_spec_v1.json +++ b/api-reference/v1/openapi_spec_v1.json @@ -9645,13 +9645,14 @@ "source_bank_account_id": { "type": "string", "description": "Source bank account number", - "example": "8b2812f0-d6c8-4073-97bb-9fa964d08bc5", + "example": "8b****----***08bc5", "nullable": true }, "destination_bank_account_id": { "type": "string", - "description": "Destination bank account number", - "example": "9b95f84e-de61-460b-a14b-f23b4e71c97b", + "description": "Partially masked destination bank account number _Deprecated: Will be removed in next stable release._", + "deprecated": true, + "example": "****--460b--f23b4e71c97b", "nullable": true }, "expiry_date": { @@ -26293,7 +26294,8 @@ }, "destination_bank_account_id": { "type": "string", - "description": "Partially masked destination bank account number", + "description": "Partially masked destination bank account number _Deprecated: Will be removed in next stable release._", + "deprecated": true, "example": "****--460b--f23b4e71c97b", "nullable": true }, diff --git a/api-reference/v2/openapi_spec_v2.json b/api-reference/v2/openapi_spec_v2.json index 5550c859ca9..ddd13547f3d 100644 --- a/api-reference/v2/openapi_spec_v2.json +++ b/api-reference/v2/openapi_spec_v2.json @@ -6577,13 +6577,14 @@ "source_bank_account_id": { "type": "string", "description": "Source bank account number", - "example": "8b2812f0-d6c8-4073-97bb-9fa964d08bc5", + "example": "8b**----***08bc5", "nullable": true }, "destination_bank_account_id": { "type": "string", - "description": "Destination bank account number", - "example": "9b95f84e-de61-460b-a14b-f23b4e71c97b", + "description": "Partially masked destination bank account number _Deprecated: Will be removed in next stable release._", + "deprecated": true, + "example": "****--460b--f23b4e71c97b", "nullable": true }, "expiry_date": { @@ -20983,7 +20984,8 @@ }, "destination_bank_account_id": { "type": "string", - "description": "Partially masked destination bank account number", + "description": "Partially masked destination bank account number _Deprecated: Will be removed in next stable release._", + "deprecated": true, "example": "****--460b--f23b4e71c97b", "nullable": true }, diff --git a/crates/api_models/src/payments.rs b/crates/api_models/src/payments.rs index 59c609a294d..e62126f9102 100644 --- a/crates/api_models/src/payments.rs +++ b/crates/api_models/src/payments.rs @@ -3433,15 +3433,12 @@ pub enum BankTransferData { /// CNPJ is a Brazilian company tax identification number #[schema(value_type = Option<String>, example = "74469027417312")] cnpj: Option<Secret<String>>, - /// Source bank account number - #[schema(value_type = Option<String>, example = "8b2812f0-d6c8-4073-97bb-9fa964d08bc5")] + #[schema(value_type = Option<String>, example = "8b**----***08bc5")] source_bank_account_id: Option<MaskedBankAccount>, - - /// Destination bank account number - #[schema(value_type = Option<String>, example = "9b95f84e-de61-460b-a14b-f23b4e71c97b")] + /// Partially masked destination bank account number _Deprecated: Will be removed in next stable release._ + #[schema(value_type = Option<String>, example = "****--460b--f23b4e71c97b", deprecated)] destination_bank_account_id: Option<MaskedBankAccount>, - /// The expiration date and time for the Pix QR code in ISO 8601 format #[schema(value_type = Option<String>, example = "2025-09-10T10:11:12Z")] #[serde(default, with = "common_utils::custom_serde::iso8601::option")] diff --git a/crates/api_models/src/payments/additional_info.rs b/crates/api_models/src/payments/additional_info.rs index 099e055980a..96b4209ac41 100644 --- a/crates/api_models/src/payments/additional_info.rs +++ b/crates/api_models/src/payments/additional_info.rs @@ -174,8 +174,8 @@ pub struct PixBankTransferAdditionalData { #[schema(value_type = Option<String>, example = "****--4073--9fa964d08bc5")] pub source_bank_account_id: Option<MaskedBankAccount>, - /// Partially masked destination bank account number - #[schema(value_type = Option<String>, example = "****--460b--f23b4e71c97b")] + /// Partially masked destination bank account number _Deprecated: Will be removed in next stable release._ + #[schema(value_type = Option<String>, example = "****--460b-*-f23b4e71c97b", deprecated)] pub destination_bank_account_id: Option<MaskedBankAccount>, /// The expiration date and time for the Pix QR code in ISO 8601 format diff --git a/crates/connector_configs/toml/development.toml b/crates/connector_configs/toml/development.toml index 9e493eb6a54..0aa70982492 100644 --- a/crates/connector_configs/toml/development.toml +++ b/crates/connector_configs/toml/development.toml @@ -6071,7 +6071,12 @@ api_secret="Secret Key" [facilitapay.connector_auth.BodyKey] api_key="Password" key1="Username" - +[facilitapay.metadata.destination_account_number] + name="destination_account_number" + label="Destination Account Number" + placeholder="Enter Destination Account Number" + required=true + type="Text" [archipel] [archipel.connector_auth.HeaderKey] diff --git a/crates/connector_configs/toml/production.toml b/crates/connector_configs/toml/production.toml index e81c3f6aac9..9a4663d3696 100644 --- a/crates/connector_configs/toml/production.toml +++ b/crates/connector_configs/toml/production.toml @@ -4637,6 +4637,13 @@ payment_method_type = "pix" api_key = "Password" key1 = "Username" +[facilitapay.metadata.destination_account_number] +name="destination_account_number" +label="Destination Account Number" +placeholder="Enter Destination Account Number" +required=true +type="Text" + [archipel] [archipel.connector_auth.HeaderKey] api_key = "Enter CA Certificate PEM" diff --git a/crates/connector_configs/toml/sandbox.toml b/crates/connector_configs/toml/sandbox.toml index bdd9cde57f0..c497c9aca29 100644 --- a/crates/connector_configs/toml/sandbox.toml +++ b/crates/connector_configs/toml/sandbox.toml @@ -6053,6 +6053,13 @@ payment_method_type = "pix" api_key = "Password" key1 = "Username" +[facilitapay.metadata.destination_account_number] +name="destination_account_number" +label="Destination Account Number" +placeholder="Enter Destination Account Number" +required=true +type="Text" + [archipel] [archipel.connector_auth.HeaderKey] api_key = "Enter CA Certificate PEM" diff --git a/crates/hyperswitch_connectors/src/connectors/facilitapay/transformers.rs b/crates/hyperswitch_connectors/src/connectors/facilitapay/transformers.rs index 9e7d4a06a2f..9de5b7454c3 100644 --- a/crates/hyperswitch_connectors/src/connectors/facilitapay/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/facilitapay/transformers.rs @@ -3,6 +3,8 @@ use common_enums::{enums, PaymentMethod}; use common_utils::{ errors::CustomResult, ext_traits::{BytesExt, Encode}, + new_type::MaskedBankAccount, + pii, types::StringMajorUnit, }; use error_stack::ResultExt; @@ -18,6 +20,7 @@ use hyperswitch_interfaces::{ consts, errors, events::connector_api_logs::ConnectorEvent, types::Response, }; use masking::{ExposeInterface, Secret}; +use serde::{Deserialize, Serialize}; use time::PrimitiveDateTime; use url::Url; @@ -34,7 +37,7 @@ use super::{ }; use crate::{ types::{RefreshTokenRouterData, RefundsResponseRouterData, ResponseRouterData}, - utils::{is_payment_failure, missing_field_err, QrImage, RouterData as OtherRouterData}, + utils::{self, is_payment_failure, missing_field_err, QrImage, RouterData as OtherRouterData}, }; type Error = error_stack::Report<errors::ConnectorError>; @@ -47,6 +50,65 @@ impl<T> From<(StringMajorUnit, T)> for FacilitapayRouterData<T> { } } +// Auth Struct +#[derive(Debug, Clone)] +pub struct FacilitapayAuthType { + pub(super) username: Secret<String>, + pub(super) password: Secret<String>, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct FacilitapayConnectorMetadataObject { + // pub destination_account_number: Secret<String>, + pub destination_account_number: MaskedBankAccount, +} + +// Helper to build the request from Hyperswitch Auth Type +impl FacilitapayAuthRequest { + fn from_auth_type(auth: &FacilitapayAuthType) -> Self { + Self { + user: FacilitapayCredentials { + username: auth.username.clone(), + password: auth.password.clone(), + }, + } + } +} + +impl TryFrom<&ConnectorAuthType> for FacilitapayAuthType { + type Error = Error; + fn try_from(auth_type: &ConnectorAuthType) -> Result<Self, Self::Error> { + match auth_type { + ConnectorAuthType::BodyKey { api_key, key1 } => Ok(Self { + username: key1.to_owned(), + password: api_key.to_owned(), + }), + _ => Err(errors::ConnectorError::FailedToObtainAuthType.into()), + } + } +} + +impl TryFrom<&RefreshTokenRouterData> for FacilitapayAuthRequest { + type Error = Error; + fn try_from(item: &RefreshTokenRouterData) -> Result<Self, Self::Error> { + let auth_type = FacilitapayAuthType::try_from(&item.connector_auth_type)?; + Ok(Self::from_auth_type(&auth_type)) + } +} + +impl TryFrom<&Option<pii::SecretSerdeValue>> for FacilitapayConnectorMetadataObject { + type Error = Error; + + fn try_from(meta_data: &Option<pii::SecretSerdeValue>) -> Result<Self, Self::Error> { + let metadata: Self = utils::to_connector_meta_from_secret(meta_data.clone()) + .change_context(errors::ConnectorError::InvalidConnectorConfig { + config: "merchant_connector_account.metadata", + })?; + + Ok(metadata) + } +} + impl TryFrom<&FacilitapayRouterData<&types::PaymentsAuthorizeRouterData>> for FacilitapayPaymentsRequest { @@ -54,11 +116,13 @@ impl TryFrom<&FacilitapayRouterData<&types::PaymentsAuthorizeRouterData>> fn try_from( item: &FacilitapayRouterData<&types::PaymentsAuthorizeRouterData>, ) -> Result<Self, Self::Error> { + let metadata = + FacilitapayConnectorMetadataObject::try_from(&item.router_data.connector_meta_data)?; + match item.router_data.request.payment_method_data.clone() { PaymentMethodData::BankTransfer(bank_transfer_data) => match bank_transfer_data { BankTransferData::Pix { source_bank_account_id, - destination_bank_account_id, .. } => { // Set expiry time to 15 minutes from now @@ -80,11 +144,7 @@ impl TryFrom<&FacilitapayRouterData<&types::PaymentsAuthorizeRouterData>> }, )?, - to_bank_account_id: destination_bank_account_id.clone().ok_or( - errors::ConnectorError::MissingRequiredField { - field_name: "destination bank account id", - }, - )?, + to_bank_account_id: metadata.destination_account_number, currency: item.router_data.request.currency, exchange_currency: item.router_data.request.currency, value: item.amount.clone(), @@ -146,46 +206,6 @@ impl TryFrom<&FacilitapayRouterData<&types::PaymentsAuthorizeRouterData>> } } -// Helper to build the request from Hyperswitch Auth Type -impl FacilitapayAuthRequest { - fn from_auth_type(auth: &FacilitapayAuthType) -> Self { - Self { - user: FacilitapayCredentials { - username: auth.username.clone(), - password: auth.password.clone(), - }, - } - } -} - -// Auth Struct -#[derive(Debug, Clone)] -pub struct FacilitapayAuthType { - pub(super) username: Secret<String>, - pub(super) password: Secret<String>, -} - -impl TryFrom<&ConnectorAuthType> for FacilitapayAuthType { - type Error = Error; - fn try_from(auth_type: &ConnectorAuthType) -> Result<Self, Self::Error> { - match auth_type { - ConnectorAuthType::BodyKey { api_key, key1 } => Ok(Self { - username: key1.to_owned(), - password: api_key.to_owned(), - }), - _ => Err(errors::ConnectorError::FailedToObtainAuthType.into()), - } - } -} - -impl TryFrom<&RefreshTokenRouterData> for FacilitapayAuthRequest { - type Error = Error; - fn try_from(item: &RefreshTokenRouterData) -> Result<Self, Self::Error> { - let auth_type = FacilitapayAuthType::try_from(&item.connector_auth_type)?; - Ok(Self::from_auth_type(&auth_type)) - } -} - fn convert_to_document_type(document_type: &str) -> Result<DocumentType, errors::ConnectorError> { match document_type.to_lowercase().as_str() { "cc" => Ok(DocumentType::CedulaDeCiudadania), @@ -394,7 +414,13 @@ impl<F, T> TryFrom<ResponseRouterData<F, FacilitapayPaymentsResponse, T, Payment let status = if item.data.payment_method == PaymentMethod::BankTransfer && item.response.data.status == FacilitapayPaymentStatus::Identified { - common_enums::AttemptStatus::AuthenticationPending + if item.response.data.currency != item.response.data.exchange_currency { + // Cross-currency: Identified is not terminal + common_enums::AttemptStatus::Pending + } else { + // Local currency: Identified is terminal + common_enums::AttemptStatus::Charged + } } else { common_enums::AttemptStatus::from(item.response.data.status.clone()) }; diff --git a/crates/payment_methods/src/configs/payment_connector_required_fields.rs b/crates/payment_methods/src/configs/payment_connector_required_fields.rs index 2dd291d16f5..a57d3002caf 100644 --- a/crates/payment_methods/src/configs/payment_connector_required_fields.rs +++ b/crates/payment_methods/src/configs/payment_connector_required_fields.rs @@ -193,7 +193,6 @@ enum RequiredField { PixCnpj, PixCpf, PixSourceBankAccountId, - PixDestinationBankAccountId, GiftCardNumber, GiftCardCvc, DcbMsisdn, @@ -808,17 +807,6 @@ impl RequiredField { value: None, }, ), - Self::PixDestinationBankAccountId => ( - "payment_method_data.bank_transfer.pix.destination_bank_account_id".to_string(), - RequiredFieldInfo { - required_field: - "payment_method_data.bank_transfer.pix.destination_bank_account_id" - .to_string(), - display_name: "destination_bank_account_id".to_string(), - field_type: FieldType::UserDestinationBankAccountId, - value: None, - }, - ), Self::GiftCardNumber => ( "payment_method_data.gift_card.number".to_string(), RequiredFieldInfo { @@ -3232,7 +3220,6 @@ fn get_bank_transfer_required_fields() -> HashMap<enums::PaymentMethodType, Conn non_mandate: HashMap::new(), common: HashMap::from([ RequiredField::PixSourceBankAccountId.to_tuple(), - RequiredField::PixDestinationBankAccountId.to_tuple(), RequiredField::BillingAddressCountries(vec!["BR"]).to_tuple(), RequiredField::BillingUserFirstName.to_tuple(), RequiredField::BillingUserLastName.to_tuple(), diff --git a/crates/router/src/core/connector_validation.rs b/crates/router/src/core/connector_validation.rs index f04edb139f2..8f0bce516cb 100644 --- a/crates/router/src/core/connector_validation.rs +++ b/crates/router/src/core/connector_validation.rs @@ -210,6 +210,9 @@ impl ConnectorAuthTypeAndMetadataValidation<'_> { } api_enums::Connector::Facilitapay => { facilitapay::transformers::FacilitapayAuthType::try_from(self.auth_type)?; + facilitapay::transformers::FacilitapayConnectorMetadataObject::try_from( + self.connector_meta_data, + )?; Ok(()) } api_enums::Connector::Fiserv => {	2025-07-21T08:33:27Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [ ] New feature - [ ] Enhancement - [x] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> Destination bank account id should be merchant facing, not customer. This PR removes any references to destination bank account id and moves it to connector metadata instead. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [x] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> /crates/connector_configs/toml/development.toml /crates/connector_configs/toml/sandbox.toml /crates/connector_configs/toml/production.toml ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> Customer should not enter merchant's bank details. It should be merchant facing instead. Closes #8703. ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> Create MCA: ```curl curl --location 'http://localhost:8080/account/postman_merchant_GHAction_1753083253/connectors' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_Dyq5nDoX7lVK7WTywFMzt7RKqlI86c6FFg7kun0keGiZpByVLgo8y4dhdbAqYIm8' \ --data-raw '{ "connector_type": "payment_processor", "connector_name": "facilitapay", "business_country": "US", "business_label": "default", "connector_account_details": { "auth_type": "BodyKey", "api_key": "api_key", "key1": "key1" }, "test_mode": false, "disabled": false, "metadata": { "destination_account_number": "<UUID>" }, "payment_methods_enabled": [ { "payment_method": "bank_transfer", "payment_method_types": [ { "payment_method_type": "pix", "minimum_amount": 1, "maximum_amount": 68607706, "recurring_enabled": true, "installment_payment_enabled": true } ] }, ] }' ``` ```json { "connector_type": "payment_processor", "connector_name": "facilitapay", "connector_label": "facilitapay_US_default", "merchant_connector_id": "mca_rMIEEmHi0UapY2hNpT3H", "profile_id": "pro_0ebkZdbr9FTvQ7UwInzm", "connector_account_details": { "auth_type": "BodyKey", "api_key": "api_key", "key1": "key1" }, "payment_methods_enabled": [ { "payment_method": "bank_transfer", "payment_method_types": [ { "payment_method_type": "pix", "payment_experience": null, "card_networks": null, "accepted_currencies": null, "accepted_countries": null, "minimum_amount": 1, "maximum_amount": 68607706, "recurring_enabled": true, "installment_payment_enabled": true } ] }, ], "connector_webhook_details": null, "metadata": { "destination_account_number": "UUID" }, "test_mode": false, "disabled": false, "frm_configs": null, "business_country": "US", "business_label": "default", "business_sub_label": null, "applepay_verified_domains": null, "pm_auth_config": null, "status": "active", "additional_merchant_data": null, "connector_wallets_details": null } ``` Not passing connector metadata during MCA create call should result in a 4xx like below: ```json { "error": { "type": "invalid_request", "message": "The merchant_connector_account.metadata is invalid", "code": "IR_06" } } ``` <img width="729" height="981" alt="image" src="https://github.com/user-attachments/assets/42100bec-8635-41d5-a71c-d861de229385" /> <img width="642" height="1038" alt="image" src="https://github.com/user-attachments/assets/d0a146e4-f021-49a7-97b5-4b49556bf638" /> I'll fix the 1 failure in next PR. We throw `501`, commons expects a `2xx` ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `just clippy && just clippy_v2` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	be03dd2ae9a4df9b592aa3fc482e5356843a7163	be03dd2ae9a4df9b592aa3fc482e5356843a7163
juspay/hyperswitch	juspay__hyperswitch-8693	Bug: update open api spec for create platform api	diff --git a/api-reference/README.md b/api-reference/README.md index ef3537d6b73..d8de73895da 100644 --- a/api-reference/README.md +++ b/api-reference/README.md @@ -44,5 +44,4 @@ npx @mintlify/scraping@latest openapi-file v1/openapi_spec_v1.json -o v1 This will generate files in [api-reference](api-reference) folder. These routes should be added to the [mint.json](mint.json) file under navigation, under respective group. - -NOTE: For working with V2 API reference, replace every occurrence of `v1` with `v2` in above commands \ No newline at end of file +NOTE: For working with V2 API reference, replace every occurrence of `v1` with `v2` in above commands diff --git a/api-reference/docs.json b/api-reference/docs.json index 9688afc3241..ea1ab01bfcb 100644 --- a/api-reference/docs.json +++ b/api-reference/docs.json @@ -146,6 +146,12 @@ "v1/business-profile/business-profile--list" ] }, + { + "group": "Platform Account", + "pages": [ + "v1/platform/platform--create" + ] + }, { "group": "API Key", "pages": [ diff --git a/api-reference/v1/openapi_spec_v1.json b/api-reference/v1/openapi_spec_v1.json index ccd6d2e11b7..75e5fbea6df 100644 --- a/api-reference/v1/openapi_spec_v1.json +++ b/api-reference/v1/openapi_spec_v1.json @@ -6481,6 +6481,53 @@ } ] } + }, + "/create_platform": { + "post": { + "tags": [ + "Platform" + ], + "summary": "Platform - Create", + "description": "Create a new platform account", + "operationId": "Create a Platform Account", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PlatformAccountCreateRequest" + }, + "examples": { + "Create a platform account with organization_name": { + "value": { + "organization_name": "organization_abc" + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Platform Account Created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PlatformAccountCreateResponse" + } + } + } + }, + "400": { + "description": "Invalid data" + } + }, + "security": [ + { + "jwt_key": [] + } + ] + } } }, "components": { @@ -26305,6 +26352,51 @@ } } }, + "PlatformAccountCreateRequest": { + "type": "object", + "required": [ + "organization_name" + ], + "properties": { + "organization_name": { + "type": "string", + "example": "organization_abc", + "maxLength": 64 + } + } + }, + "PlatformAccountCreateResponse": { + "type": "object", + "required": [ + "org_id", + "org_type", + "merchant_id", + "merchant_account_type" + ], + "properties": { + "org_id": { + "type": "string", + "example": "org_abc", + "maxLength": 64, + "minLength": 1 + }, + "org_name": { + "type": "string", + "example": "organization_abc", + "nullable": true + }, + "org_type": { + "$ref": "#/components/schemas/OrganizationType" + }, + "merchant_id": { + "type": "string", + "example": "merchant_abc" + }, + "merchant_account_type": { + "$ref": "#/components/schemas/MerchantAccountType" + } + } + }, "PollConfig": { "type": "object", "required": [ diff --git a/api-reference/v1/platform/platform--create.mdx b/api-reference/v1/platform/platform--create.mdx new file mode 100644 index 00000000000..61a12fdc6d8 --- /dev/null +++ b/api-reference/v1/platform/platform--create.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /create_platform +--- \ No newline at end of file diff --git a/crates/api_models/src/user.rs b/crates/api_models/src/user.rs index 47608532b54..82d10a16215 100644 --- a/crates/api_models/src/user.rs +++ b/crates/api_models/src/user.rs @@ -3,6 +3,7 @@ use std::fmt::Debug; use common_enums::{EntityType, TokenPurpose}; use common_utils::{crypto::OptionalEncryptableName, id_type, pii}; use masking::Secret; +use utoipa::ToSchema; use crate::user_role::UserStatus; pub mod dashboard_metadata; @@ -150,17 +151,24 @@ pub struct UserOrgMerchantCreateRequest { pub merchant_name: Secret<String>, } -#[derive(Debug, serde::Deserialize, serde::Serialize, Clone)] +#[derive(Debug, serde::Deserialize, serde::Serialize, Clone, ToSchema)] pub struct PlatformAccountCreateRequest { + #[schema(max_length = 64, value_type = String, example = "organization_abc")] pub organization_name: Secret<String>, } -#[derive(Debug, serde::Deserialize, serde::Serialize)] +#[derive(Debug, serde::Deserialize, serde::Serialize, ToSchema)] pub struct PlatformAccountCreateResponse { + #[schema(value_type = String, max_length = 64, min_length = 1, example = "org_abc")] pub org_id: id_type::OrganizationId, + #[schema(value_type = Option<String>, example = "organization_abc")] pub org_name: Option<String>, + + #[schema(value_type = OrganizationType, example = "standard")] pub org_type: common_enums::OrganizationType, + #[schema(value_type = String, example = "merchant_abc")] pub merchant_id: id_type::MerchantId, + #[schema(value_type = MerchantAccountType, example = "standard")] pub merchant_account_type: common_enums::MerchantAccountType, } diff --git a/crates/openapi/src/openapi.rs b/crates/openapi/src/openapi.rs index 54b004e32ba..a5e0a6d95c6 100644 --- a/crates/openapi/src/openapi.rs +++ b/crates/openapi/src/openapi.rs @@ -213,6 +213,9 @@ Never share your secret api keys. Keep them guarded and secure. // Routes for authentication routes::authentication::authentication_create, + + // Routes for platform account + routes::platform::create_platform_account, ), components(schemas( common_utils::types::MinorUnit, @@ -362,8 +365,8 @@ Never share your secret api keys. Keep them guarded and secure. api_models::enums::MerchantProductType, api_models::enums::CtpServiceProvider, api_models::enums::PaymentLinkSdkLabelType, - api_models::enums::PaymentLinkShowSdkTerms, api_models::enums::OrganizationType, + api_models::enums::PaymentLinkShowSdkTerms, api_models::admin::MerchantConnectorCreate, api_models::admin::AdditionalMerchantData, api_models::admin::ConnectorWalletDetails, @@ -806,6 +809,8 @@ Never share your secret api keys. Keep them guarded and secure. api_models::authentication::ThreeDsData, api_models::authentication::AuthenticationEligibilityRequest, api_models::authentication::AuthenticationEligibilityResponse, + api_models::user::PlatformAccountCreateRequest, + api_models::user::PlatformAccountCreateResponse, )), modifiers(&SecurityAddon) )] diff --git a/crates/openapi/src/routes.rs b/crates/openapi/src/routes.rs index 50c7db98ab3..7dcdf60571f 100644 --- a/crates/openapi/src/routes.rs +++ b/crates/openapi/src/routes.rs @@ -14,6 +14,7 @@ pub mod payment_link; pub mod payment_method; pub mod payments; pub mod payouts; +pub mod platform; pub mod poll; pub mod profile; pub mod profile_acquirer; diff --git a/crates/openapi/src/routes/platform.rs b/crates/openapi/src/routes/platform.rs new file mode 100644 index 00000000000..6dc04076e51 --- /dev/null +++ b/crates/openapi/src/routes/platform.rs @@ -0,0 +1,26 @@ +#[cfg(feature = "v1")] +/// Platform - Create +/// +/// Create a new platform account +#[utoipa::path( + post, + path = "/create_platform", + request_body( + content = PlatformAccountCreateRequest, + examples( + ( + "Create a platform account with organization_name" = ( + value = json!({"organization_name": "organization_abc"}) + ) + ), + ) + ), + responses( + (status = 200, description = "Platform Account Created", body = PlatformAccountCreateResponse), + (status = 400, description = "Invalid data") + ), + tag = "Platform", + operation_id = "Create a Platform Account", + security(("jwt_key" = [])) +)] +pub async fn create_platform_account() {}	2025-07-18T12:14:55Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [x] Documentation - [ ] CI/CD ## Description - generated open api spec for create platform api <img width="3182" height="2040" alt="image" src="https://github.com/user-attachments/assets/1373cff4-640d-4a4f-8b21-2fdb50a340e4" /> ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> ## How did you test it? - I run the `mint dev` command to check if the platform create api is reflecting in the api reference docs after these changes - Refer the attached screenshot ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	6214aca5f0f5c617a68f65ef5bcfd700060acccf	6214aca5f0f5c617a68f65ef5bcfd700060acccf
juspay/hyperswitch	juspay__hyperswitch-8706	Bug: [FEATURE] [TRUSTPAYMENTS] Integrate cards non-3ds payments ### Feature Description cards non-3ds payments needs to be integrated for trustpayments ### Possible Implementation cards non-3ds payments needs to be integrated for trustpayments ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? None	diff --git a/api-reference/v1/openapi_spec_v1.json b/api-reference/v1/openapi_spec_v1.json index 34cd0c51473..29fb70620b2 100644 --- a/api-reference/v1/openapi_spec_v1.json +++ b/api-reference/v1/openapi_spec_v1.json @@ -12131,6 +12131,7 @@ "threedsecureio", "tokenio", "trustpay", + "trustpayments", "tsys", "vgs", "volt", @@ -30238,6 +30239,7 @@ "stripe", "stripebilling", "trustpay", + "trustpayments", "tokenio", "tsys", "volt", diff --git a/api-reference/v2/openapi_spec_v2.json b/api-reference/v2/openapi_spec_v2.json index 1559dce9183..fe0836bbc9c 100644 --- a/api-reference/v2/openapi_spec_v2.json +++ b/api-reference/v2/openapi_spec_v2.json @@ -8675,6 +8675,7 @@ "threedsecureio", "tokenio", "trustpay", + "trustpayments", "tsys", "vgs", "volt", @@ -23867,6 +23868,7 @@ "stripe", "stripebilling", "trustpay", + "trustpayments", "tokenio", "tsys", "volt", diff --git a/crates/common_enums/src/connector_enums.rs b/crates/common_enums/src/connector_enums.rs index 3a7d2f535cc..6621440b13d 100644 --- a/crates/common_enums/src/connector_enums.rs +++ b/crates/common_enums/src/connector_enums.rs @@ -156,6 +156,7 @@ pub enum RoutableConnectors { Stripebilling, // Taxjar, Trustpay, + Trustpayments, // Thunes Tokenio, // Tsys, @@ -336,6 +337,7 @@ pub enum Connector { //Thunes, Tokenio, Trustpay, + Trustpayments, Tsys, // UnifiedAuthenticationService, Vgs, @@ -519,6 +521,7 @@ impl Connector { \| Self::Taxjar // \| Self::Thunes \| Self::Trustpay + \| Self::Trustpayments // \| Self::Tokenio \| Self::Tsys // \| Self::UnifiedAuthenticationService @@ -702,6 +705,7 @@ impl From<RoutableConnectors> for Connector { RoutableConnectors::Stripebilling => Self::Stripebilling, RoutableConnectors::Tokenio => Self::Tokenio, RoutableConnectors::Trustpay => Self::Trustpay, + RoutableConnectors::Trustpayments => Self::Trustpayments, // RoutableConnectors::Tokenio => Self::Tokenio, RoutableConnectors::Tsys => Self::Tsys, RoutableConnectors::Volt => Self::Volt, @@ -835,6 +839,7 @@ impl TryFrom<Connector> for RoutableConnectors { Connector::Stripebilling => Ok(Self::Stripebilling), Connector::Tokenio => Ok(Self::Tokenio), Connector::Trustpay => Ok(Self::Trustpay), + Connector::Trustpayments => Ok(Self::Trustpayments), Connector::Tsys => Ok(Self::Tsys), Connector::Volt => Ok(Self::Volt), Connector::Wellsfargo => Ok(Self::Wellsfargo), diff --git a/crates/connector_configs/src/connector.rs b/crates/connector_configs/src/connector.rs index 0a521f7a864..2c89a48aed7 100644 --- a/crates/connector_configs/src/connector.rs +++ b/crates/connector_configs/src/connector.rs @@ -518,6 +518,7 @@ impl ConnectorConfig { Connector::Stripebilling => Ok(connector_data.stripebilling), Connector::Tokenio => Ok(connector_data.tokenio), Connector::Trustpay => Ok(connector_data.trustpay), + Connector::Trustpayments => Ok(connector_data.trustpayments), Connector::Threedsecureio => Ok(connector_data.threedsecureio), Connector::Taxjar => Ok(connector_data.taxjar), Connector::Tsys => Ok(connector_data.tsys), diff --git a/crates/connector_configs/toml/development.toml b/crates/connector_configs/toml/development.toml index 0f9fa995409..838be6e3524 100644 --- a/crates/connector_configs/toml/development.toml +++ b/crates/connector_configs/toml/development.toml @@ -6722,8 +6722,19 @@ api_key = "API Key" key1 = "API Secret" [trustpayments] +[[trustpayments.credit]] + payment_method_type = "Mastercard" +[[trustpayments.credit]] + payment_method_type = "Visa" +[[trustpayments.debit]] + payment_method_type = "Mastercard" +[[trustpayments.debit]] + payment_method_type = "Visa" [trustpayments.connector_auth.HeaderKey] api_key = "API Key" +[trustpayments.connector_webhook_details] +merchant_secret = "Source verification key" + [breadpay] [breadpay.connector_auth.BodyKey] diff --git a/crates/connector_configs/toml/production.toml b/crates/connector_configs/toml/production.toml index 96d473a386c..8a163f6b66d 100644 --- a/crates/connector_configs/toml/production.toml +++ b/crates/connector_configs/toml/production.toml @@ -5374,9 +5374,20 @@ merchant_secret="Source verification key" api_key = "API Key" key1 = "API Secret" + [trustpayments] +[[trustpayments.credit]] +payment_method_type = "Mastercard" +[[trustpayments.credit]] +payment_method_type = "Visa" +[[trustpayments.debit]] +payment_method_type = "Mastercard" +[[trustpayments.debit]] +payment_method_type = "Visa" [trustpayments.connector_auth.HeaderKey] api_key = "API Key" +[trustpayments.connector_webhook_details] +merchant_secret = "Source verification key" [flexiti] diff --git a/crates/connector_configs/toml/sandbox.toml b/crates/connector_configs/toml/sandbox.toml index 45da96d5344..801f18a927b 100644 --- a/crates/connector_configs/toml/sandbox.toml +++ b/crates/connector_configs/toml/sandbox.toml @@ -6703,11 +6703,19 @@ merchant_secret="Source verification key" api_key = "API Key" key1 = "API Secret" + [trustpayments] +[[trustpayments.credit]] +payment_method_type = "Mastercard" +[[trustpayments.credit]] +payment_method_type = "Visa" +[[trustpayments.debit]] +payment_method_type = "Mastercard" +[[trustpayments.debit]] +payment_method_type = "Visa" [trustpayments.connector_auth.HeaderKey] api_key = "API Key" - [breadpay] [breadpay.connector_auth.BodyKey] api_key = "API Key" diff --git a/crates/hyperswitch_connectors/src/connectors/trustpayments.rs b/crates/hyperswitch_connectors/src/connectors/trustpayments.rs index 4b92c5aef60..a5bbb802ea3 100644 --- a/crates/hyperswitch_connectors/src/connectors/trustpayments.rs +++ b/crates/hyperswitch_connectors/src/connectors/trustpayments.rs @@ -24,11 +24,12 @@ use hyperswitch_domain_models::{ RefundsData, SetupMandateRequestData, }, router_response_types::{ - ConnectorInfo, PaymentsResponseData, RefundsResponseData, SupportedPaymentMethods, + ConnectorInfo, PaymentMethodDetails, PaymentsResponseData, RefundsResponseData, + SupportedPaymentMethods, SupportedPaymentMethodsExt, }, types::{ - PaymentsAuthorizeRouterData, PaymentsCaptureRouterData, PaymentsSyncRouterData, - RefundSyncRouterData, RefundsRouterData, + PaymentsAuthorizeRouterData, PaymentsCancelRouterData, PaymentsCaptureRouterData, + PaymentsSyncRouterData, RefundSyncRouterData, RefundsRouterData, }, }; use hyperswitch_interfaces::{ @@ -42,7 +43,7 @@ use hyperswitch_interfaces::{ types::{self, Response}, webhooks, }; -use masking::{ExposeInterface, Mask}; +use masking::Mask; use transformers as trustpayments; use crate::{constants::headers, types::ResponseRouterData, utils}; @@ -76,7 +77,82 @@ impl api::PaymentToken for Trustpayments {} impl ConnectorIntegration<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData> for Trustpayments { - // Not Implemented (R) + fn get_headers( + &self, + req: &RouterData<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData>, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &RouterData<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData>, + connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Ok(format!("{}/json/", self.base_url(connectors))) + } + + fn get_request_body( + &self, + req: &RouterData<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData>, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let connector_req = trustpayments::TrustpaymentsTokenizationRequest::try_from(req)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &RouterData<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData>, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::TokenizationType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::TokenizationType::get_headers(self, req, connectors)?) + .set_body(types::TokenizationType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &RouterData<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData>, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult< + RouterData<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData>, + errors::ConnectorError, + > { + let response: trustpayments::TrustpaymentsTokenizationResponse = res + .response + .parse_struct("Trustpayments TokenizationResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } } impl<Flow, Request, Response> ConnectorCommonExt<Flow, Request, Response> for Trustpayments @@ -104,12 +180,7 @@ impl ConnectorCommon for Trustpayments { } fn get_currency_unit(&self) -> api::CurrencyUnit { - // todo!() api::CurrencyUnit::Minor - - // TODO! Check connector documentation, on which unit they are processing the currency. - // If the connector accepts amount in lower unit ( i.e cents for USD) then return api::CurrencyUnit::Minor, - // if connector accepts amount in base unit (i.e dollars for USD) then return api::CurrencyUnit::Base } fn common_get_content_type(&self) -> &'static str { @@ -128,7 +199,7 @@ impl ConnectorCommon for Trustpayments { .change_context(errors::ConnectorError::FailedToObtainAuthType)?; Ok(vec![( headers::AUTHORIZATION.to_string(), - auth.api_key.expose().into_masked(), + auth.get_basic_auth_header().into_masked(), )]) } @@ -186,9 +257,7 @@ impl ConnectorValidation for Trustpayments { } } -impl ConnectorIntegration<Session, PaymentsSessionData, PaymentsResponseData> for Trustpayments { - //TODO: implement sessions flow -} +impl ConnectorIntegration<Session, PaymentsSessionData, PaymentsResponseData> for Trustpayments {} impl ConnectorIntegration<AccessTokenAuth, AccessTokenRequestData, AccessToken> for Trustpayments {} @@ -215,9 +284,9 @@ impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData fn get_url( &self, _req: &PaymentsAuthorizeRouterData, - _connectors: &Connectors, + connectors: &Connectors, ) -> CustomResult<String, errors::ConnectorError> { - Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + Ok(format!("{}/json/", self.base_url(connectors))) } fn get_request_body( @@ -303,9 +372,18 @@ impl ConnectorIntegration<PSync, PaymentsSyncData, PaymentsResponseData> for Tru fn get_url( &self, _req: &PaymentsSyncRouterData, - _connectors: &Connectors, + connectors: &Connectors, ) -> CustomResult<String, errors::ConnectorError> { - Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + Ok(format!("{}/json/", self.base_url(connectors))) + } + + fn get_request_body( + &self, + req: &PaymentsSyncRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let connector_req = trustpayments::TrustpaymentsSyncRequest::try_from(req)?; + Ok(RequestContent::Json(Box::new(connector_req))) } fn build_request( @@ -315,10 +393,13 @@ impl ConnectorIntegration<PSync, PaymentsSyncData, PaymentsResponseData> for Tru ) -> CustomResult<Option<Request>, errors::ConnectorError> { Ok(Some( RequestBuilder::new() - .method(Method::Get) + .method(Method::Post) .url(&types::PaymentsSyncType::get_url(self, req, connectors)?) .attach_default_headers() .headers(types::PaymentsSyncType::get_headers(self, req, connectors)?) + .set_body(types::PaymentsSyncType::get_request_body( + self, req, connectors, + )?) .build(), )) } @@ -367,17 +448,26 @@ impl ConnectorIntegration<Capture, PaymentsCaptureData, PaymentsResponseData> fo fn get_url( &self, _req: &PaymentsCaptureRouterData, - _connectors: &Connectors, + connectors: &Connectors, ) -> CustomResult<String, errors::ConnectorError> { - Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + Ok(format!("{}/json/", self.base_url(connectors))) } fn get_request_body( &self, - _req: &PaymentsCaptureRouterData, + req: &PaymentsCaptureRouterData, _connectors: &Connectors, ) -> CustomResult<RequestContent, errors::ConnectorError> { - Err(errors::ConnectorError::NotImplemented("get_request_body method".to_string()).into()) + let amount = utils::convert_amount( + self.amount_converter, + req.request.minor_amount_to_capture, + req.request.currency, + )?; + + let connector_router_data = trustpayments::TrustpaymentsRouterData::from((amount, req)); + let connector_req = + trustpayments::TrustpaymentsCaptureRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) } fn build_request( @@ -428,7 +518,81 @@ impl ConnectorIntegration<Capture, PaymentsCaptureData, PaymentsResponseData> fo } } -impl ConnectorIntegration<Void, PaymentsCancelData, PaymentsResponseData> for Trustpayments {} +impl ConnectorIntegration<Void, PaymentsCancelData, PaymentsResponseData> for Trustpayments { + fn get_headers( + &self, + req: &PaymentsCancelRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsCancelRouterData, + connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Ok(format!("{}/json/", self.base_url(connectors))) + } + + fn get_request_body( + &self, + req: &PaymentsCancelRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let connector_req = trustpayments::TrustpaymentsVoidRequest::try_from(req)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &PaymentsCancelRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::PaymentsVoidType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::PaymentsVoidType::get_headers(self, req, connectors)?) + .set_body(types::PaymentsVoidType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsCancelRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsCancelRouterData, errors::ConnectorError> { + let response: trustpayments::TrustpaymentsPaymentsResponse = res + .response + .parse_struct("Trustpayments PaymentsVoidResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} impl ConnectorIntegration<Execute, RefundsData, RefundsResponseData> for Trustpayments { fn get_headers( @@ -446,9 +610,9 @@ impl ConnectorIntegration<Execute, RefundsData, RefundsResponseData> for Trustpa fn get_url( &self, _req: &RefundsRouterData<Execute>, - _connectors: &Connectors, + connectors: &Connectors, ) -> CustomResult<String, errors::ConnectorError> { - Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + Ok(format!("{}/json/", self.base_url(connectors))) } fn get_request_body( @@ -532,9 +696,18 @@ impl ConnectorIntegration<RSync, RefundsData, RefundsResponseData> for Trustpaym fn get_url( &self, _req: &RefundSyncRouterData, - _connectors: &Connectors, + connectors: &Connectors, ) -> CustomResult<String, errors::ConnectorError> { - Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + Ok(format!("{}/json/", self.base_url(connectors))) + } + + fn get_request_body( + &self, + req: &RefundSyncRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let connector_req = trustpayments::TrustpaymentsRefundSyncRequest::try_from(req)?; + Ok(RequestContent::Json(Box::new(connector_req))) } fn build_request( @@ -544,7 +717,7 @@ impl ConnectorIntegration<RSync, RefundsData, RefundsResponseData> for Trustpaym ) -> CustomResult<Option<Request>, errors::ConnectorError> { Ok(Some( RequestBuilder::new() - .method(Method::Get) + .method(Method::Post) .url(&types::RefundSyncType::get_url(self, req, connectors)?) .attach_default_headers() .headers(types::RefundSyncType::get_headers(self, req, connectors)?) @@ -608,7 +781,61 @@ impl webhooks::IncomingWebhook for Trustpayments { } static TRUSTPAYMENTS_SUPPORTED_PAYMENT_METHODS: LazyLock<SupportedPaymentMethods> = - LazyLock::new(SupportedPaymentMethods::new); + LazyLock::new(\|\| { + let supported_capture_methods = vec![ + enums::CaptureMethod::Automatic, + enums::CaptureMethod::Manual, + ]; + + let mut trustpayments_supported_payment_methods = SupportedPaymentMethods::new(); + + trustpayments_supported_payment_methods.add( + enums::PaymentMethod::Card, + enums::PaymentMethodType::Credit, + PaymentMethodDetails { + mandates: enums::FeatureStatus::NotSupported, + refunds: enums::FeatureStatus::Supported, + supported_capture_methods: supported_capture_methods.clone(), + specific_features: Some( + api_models::feature_matrix::PaymentMethodSpecificFeatures::Card({ + api_models::feature_matrix::CardSpecificFeatures { + three_ds: enums::FeatureStatus::NotSupported, + no_three_ds: enums::FeatureStatus::Supported, + supported_card_networks: vec![ + enums::CardNetwork::Visa, + enums::CardNetwork::Mastercard, + enums::CardNetwork::AmericanExpress, + ], + } + }), + ), + }, + ); + + trustpayments_supported_payment_methods.add( + enums::PaymentMethod::Card, + enums::PaymentMethodType::Debit, + PaymentMethodDetails { + mandates: enums::FeatureStatus::NotSupported, + refunds: enums::FeatureStatus::Supported, + supported_capture_methods: supported_capture_methods.clone(), + specific_features: Some( + api_models::feature_matrix::PaymentMethodSpecificFeatures::Card({ + api_models::feature_matrix::CardSpecificFeatures { + three_ds: enums::FeatureStatus::NotSupported, + no_three_ds: enums::FeatureStatus::Supported, + supported_card_networks: vec![ + enums::CardNetwork::Visa, + enums::CardNetwork::Mastercard, + ], + } + }), + ), + }, + ); + + trustpayments_supported_payment_methods + }); static TRUSTPAYMENTS_CONNECTOR_INFO: ConnectorInfo = ConnectorInfo { display_name: "Trustpayments", diff --git a/crates/hyperswitch_connectors/src/connectors/trustpayments/transformers.rs b/crates/hyperswitch_connectors/src/connectors/trustpayments/transformers.rs index debeca6b63a..befb9625536 100644 --- a/crates/hyperswitch_connectors/src/connectors/trustpayments/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/trustpayments/transformers.rs @@ -1,28 +1,300 @@ +use cards; use common_enums::enums; use common_utils::types::StringMinorUnit; +use error_stack::ResultExt; use hyperswitch_domain_models::{ payment_method_data::PaymentMethodData, router_data::{ConnectorAuthType, RouterData}, router_flow_types::refunds::{Execute, RSync}, router_request_types::ResponseId, router_response_types::{PaymentsResponseData, RefundsResponseData}, - types::{PaymentsAuthorizeRouterData, RefundsRouterData}, + types::{ + PaymentsAuthorizeRouterData, PaymentsCancelRouterData, PaymentsCaptureRouterData, + PaymentsSyncRouterData, RefundSyncRouterData, RefundsRouterData, + }, }; use hyperswitch_interfaces::errors; -use masking::Secret; +use masking::{ExposeInterface, Secret}; use serde::{Deserialize, Serialize}; -use crate::types::{RefundsResponseRouterData, ResponseRouterData}; +use crate::{ + types::{RefundsResponseRouterData, ResponseRouterData}, + utils::{self, CardData, RefundsRequestData, RouterData as RouterDataExt}, +}; + +const TRUSTPAYMENTS_API_VERSION: &str = "1.00"; + +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)] +pub enum TrustpaymentsSettleStatus { + #[serde(rename = "0")] + PendingSettlement, + #[serde(rename = "1")] + Settled, + #[serde(rename = "2")] + ManualCapture, + #[serde(rename = "3")] + Voided, +} + +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)] +pub enum TrustpaymentsCredentialsOnFile { + #[serde(rename = "0")] + NoStoredCredentials, + #[serde(rename = "1")] + CardholderInitiatedTransaction, + #[serde(rename = "2")] + MerchantInitiatedTransaction, +} + +impl TrustpaymentsCredentialsOnFile { + pub fn as_str(&self) -> &'static str { + match self { + Self::NoStoredCredentials => "0", + Self::CardholderInitiatedTransaction => "1", + Self::MerchantInitiatedTransaction => "2", + } + } +} + +impl std::fmt::Display for TrustpaymentsCredentialsOnFile { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + write!(f, "{}", self.as_str()) + } +} + +impl TrustpaymentsSettleStatus { + pub fn as_str(&self) -> &'static str { + match self { + Self::PendingSettlement => "0", + Self::Settled => "1", + Self::ManualCapture => "2", + Self::Voided => "3", + } + } +} + +impl std::fmt::Display for TrustpaymentsSettleStatus { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + write!(f, "{}", self.as_str()) + } +} + +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)] +pub enum TrustpaymentsErrorCode { + #[serde(rename = "0")] + Success, + + #[serde(rename = "30000")] + InvalidCredentials, + #[serde(rename = "30001")] + AuthenticationFailed, + #[serde(rename = "30002")] + InvalidSiteReference, + #[serde(rename = "30003")] + AccessDenied, + #[serde(rename = "30004")] + InvalidUsernameOrPassword, + #[serde(rename = "30005")] + AccountSuspended, + #[serde(rename = "50000")] + MissingRequiredField, + #[serde(rename = "50001")] + InvalidFieldFormat, + #[serde(rename = "50002")] + InvalidFieldValue, + #[serde(rename = "50003")] + FieldTooLong, + #[serde(rename = "50004")] + FieldTooShort, + #[serde(rename = "50005")] + InvalidCurrency, + #[serde(rename = "50006")] + InvalidAmount, + #[serde(rename = "60000")] + GeneralProcessingError, + #[serde(rename = "60001")] + SystemError, + #[serde(rename = "60002")] + CommunicationError, + #[serde(rename = "60003")] + Timeout, + #[serde(rename = "60004")] + Processing, + #[serde(rename = "60005")] + InvalidRequest, + #[serde(rename = "60019")] + NoSearchableFilter, + #[serde(rename = "70000")] + InvalidCardNumber, + #[serde(rename = "70001")] + InvalidExpiryDate, + #[serde(rename = "70002")] + InvalidSecurityCode, + #[serde(rename = "70003")] + InvalidCardType, + #[serde(rename = "70004")] + CardExpired, + #[serde(rename = "70005")] + InsufficientFunds, + #[serde(rename = "70006")] + CardDeclined, + #[serde(rename = "70007")] + CardRestricted, + #[serde(rename = "70008")] + InvalidMerchant, + #[serde(rename = "70009")] + TransactionNotPermitted, + #[serde(rename = "70010")] + ExceedsWithdrawalLimit, + #[serde(rename = "70011")] + SecurityViolation, + #[serde(rename = "70012")] + LostOrStolenCard, + #[serde(rename = "70013")] + SuspectedFraud, + #[serde(rename = "70014")] + ContactCardIssuer, + #[serde(rename = "70015")] + InvalidAmountValue, + #[serde(untagged)] + Unknown(String), +} + +impl TrustpaymentsErrorCode { + pub fn as_str(&self) -> &str { + match self { + Self::Success => "0", + Self::InvalidCredentials => "30000", + Self::AuthenticationFailed => "30001", + Self::InvalidSiteReference => "30002", + Self::AccessDenied => "30003", + Self::InvalidUsernameOrPassword => "30004", + Self::AccountSuspended => "30005", + Self::MissingRequiredField => "50000", + Self::InvalidFieldFormat => "50001", + Self::InvalidFieldValue => "50002", + Self::FieldTooLong => "50003", + Self::FieldTooShort => "50004", + Self::InvalidCurrency => "50005", + Self::InvalidAmount => "50006", + Self::GeneralProcessingError => "60000", + Self::SystemError => "60001", + Self::CommunicationError => "60002", + Self::Timeout => "60003", + Self::Processing => "60004", + Self::InvalidRequest => "60005", + Self::NoSearchableFilter => "60019", + Self::InvalidCardNumber => "70000", + Self::InvalidExpiryDate => "70001", + Self::InvalidSecurityCode => "70002", + Self::InvalidCardType => "70003", + Self::CardExpired => "70004", + Self::InsufficientFunds => "70005", + Self::CardDeclined => "70006", + Self::CardRestricted => "70007", + Self::InvalidMerchant => "70008", + Self::TransactionNotPermitted => "70009", + Self::ExceedsWithdrawalLimit => "70010", + Self::SecurityViolation => "70011", + Self::LostOrStolenCard => "70012", + Self::SuspectedFraud => "70013", + Self::ContactCardIssuer => "70014", + Self::InvalidAmountValue => "70015", + Self::Unknown(code) => code, + } + } + + pub fn is_success(&self) -> bool { + matches!(self, Self::Success) + } + + pub fn get_attempt_status(&self) -> common_enums::AttemptStatus { + match self { + // Success cases should be handled by get_payment_status() with settlestatus logic + Self::Success => common_enums::AttemptStatus::Authorized, + // Authentication and configuration errors + Self::InvalidCredentials + \| Self::AuthenticationFailed + \| Self::InvalidSiteReference + \| Self::AccessDenied + \| Self::InvalidUsernameOrPassword + \| Self::AccountSuspended => common_enums::AttemptStatus::Failure, + // Card-related and payment errors that should be treated as failures + Self::InvalidCardNumber + \| Self::InvalidExpiryDate + \| Self::InvalidSecurityCode + \| Self::InvalidCardType + \| Self::CardExpired + \| Self::InsufficientFunds + \| Self::CardDeclined + \| Self::CardRestricted + \| Self::TransactionNotPermitted + \| Self::ExceedsWithdrawalLimit + \| Self::InvalidAmountValue => common_enums::AttemptStatus::Failure, + // Processing states that should remain pending + Self::Processing => common_enums::AttemptStatus::Pending, + // Default fallback for unknown errors + _ => common_enums::AttemptStatus::Pending, + } + } + + pub fn get_description(&self) -> &'static str { + match self { + Self::Success => "Success", + Self::InvalidCredentials => "Invalid credentials", + Self::AuthenticationFailed => "Authentication failed", + Self::InvalidSiteReference => "Invalid site reference", + Self::AccessDenied => "Access denied", + Self::InvalidUsernameOrPassword => "Invalid username or password", + Self::AccountSuspended => "Account suspended", + Self::MissingRequiredField => "Missing required field", + Self::InvalidFieldFormat => "Invalid field format", + Self::InvalidFieldValue => "Invalid field value", + Self::FieldTooLong => "Field value too long", + Self::FieldTooShort => "Field value too short", + Self::InvalidCurrency => "Invalid currency code", + Self::InvalidAmount => "Invalid amount format", + Self::GeneralProcessingError => "General processing error", + Self::SystemError => "System error", + Self::CommunicationError => "Communication error", + Self::Timeout => "Request timeout", + Self::Processing => "Transaction processing", + Self::InvalidRequest => "Invalid request format", + Self::NoSearchableFilter => "No searchable filter specified", + Self::InvalidCardNumber => "Invalid card number", + Self::InvalidExpiryDate => "Invalid expiry date", + Self::InvalidSecurityCode => "Invalid security code", + Self::InvalidCardType => "Invalid card type", + Self::CardExpired => "Card expired", + Self::InsufficientFunds => "Insufficient funds", + Self::CardDeclined => "Card declined by issuer", + Self::CardRestricted => "Card restricted", + Self::InvalidMerchant => "Invalid merchant", + Self::TransactionNotPermitted => "Transaction not permitted", + Self::ExceedsWithdrawalLimit => "Exceeds withdrawal limit", + Self::SecurityViolation => "Security violation", + Self::LostOrStolenCard => "Lost or stolen card", + Self::SuspectedFraud => "Suspected fraud", + Self::ContactCardIssuer => "Contact card issuer", + Self::InvalidAmountValue => "Invalid amount", + Self::Unknown(_) => "Unknown error", + } + } +} + +impl std::fmt::Display for TrustpaymentsErrorCode { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + write!(f, "{}", self.as_str()) + } +} -//TODO: Fill the struct with respective fields pub struct TrustpaymentsRouterData<T> { - pub amount: StringMinorUnit, // The type of amount that a connector accepts, for example, String, i64, f64, etc. + pub amount: StringMinorUnit, pub router_data: T, } impl<T> From<(StringMinorUnit, T)> for TrustpaymentsRouterData<T> { fn from((amount, item): (StringMinorUnit, T)) -> Self { - //Todo : use utils to convert the amount to the type of amount that a connector accepts Self { amount, router_data: item, @@ -30,20 +302,28 @@ impl<T> From<(StringMinorUnit, T)> for TrustpaymentsRouterData<T> { } } -//TODO: Fill the struct with respective fields -#[derive(Default, Debug, Serialize, PartialEq)] +#[derive(Debug, Serialize, PartialEq)] pub struct TrustpaymentsPaymentsRequest { - amount: StringMinorUnit, - card: TrustpaymentsCard, + pub alias: String, + pub version: String, + pub request: Vec<TrustpaymentsPaymentRequestData>, } -#[derive(Default, Debug, Serialize, Eq, PartialEq)] -pub struct TrustpaymentsCard { - number: cards::CardNumber, - expiry_month: Secret<String>, - expiry_year: Secret<String>, - cvc: Secret<String>, - complete: bool, +#[derive(Debug, Serialize, PartialEq)] +pub struct TrustpaymentsPaymentRequestData { + pub accounttypedescription: String, + pub baseamount: StringMinorUnit, + pub billingfirstname: Option<String>, + pub billinglastname: Option<String>, + pub currencyiso3a: String, + pub expirydate: Secret<String>, + pub orderreference: String, + pub pan: cards::CardNumber, + pub requesttypedescriptions: Vec<String>, + pub securitycode: Secret<String>, + pub sitereference: String, + pub credentialsonfile: String, + pub settlestatus: String, } impl TryFrom<&TrustpaymentsRouterData<&PaymentsAuthorizeRouterData>> @@ -53,77 +333,508 @@ impl TryFrom<&TrustpaymentsRouterData<&PaymentsAuthorizeRouterData>> fn try_from( item: &TrustpaymentsRouterData<&PaymentsAuthorizeRouterData>, ) -> Result<Self, Self::Error> { + let auth = TrustpaymentsAuthType::try_from(&item.router_data.connector_auth_type)?; + + if matches!( + item.router_data.auth_type, + enums::AuthenticationType::ThreeDs + ) { + return Err(errors::ConnectorError::NotImplemented( + utils::get_unimplemented_payment_method_error_message("trustpayments"), + ) + .into()); + } + match item.router_data.request.payment_method_data.clone() { - PaymentMethodData::Card(_) => Err(errors::ConnectorError::NotImplemented( - "Card payment method not implemented".to_string(), + PaymentMethodData::Card(req_card) => { + let card = req_card.clone(); + + let request_types = match item.router_data.request.capture_method { + Some(common_enums::CaptureMethod::Automatic) \| None => vec!["AUTH".to_string()], + Some(common_enums::CaptureMethod::Manual) => vec!["AUTH".to_string()], + Some(common_enums::CaptureMethod::ManualMultiple) + \| Some(common_enums::CaptureMethod::Scheduled) + \| Some(common_enums::CaptureMethod::SequentialAutomatic) => { + return Err(errors::ConnectorError::NotSupported { + message: "Capture method not supported by TrustPayments".to_string(), + connector: "TrustPayments", + } + .into()); + } + }; + + Ok(Self { + alias: auth.username.expose(), + version: TRUSTPAYMENTS_API_VERSION.to_string(), + request: vec![TrustpaymentsPaymentRequestData { + accounttypedescription: "ECOM".to_string(), + baseamount: item.amount.clone(), + billingfirstname: item + .router_data + .get_optional_billing_first_name() + .map(\|name\| name.expose()), + billinglastname: item + .router_data + .get_optional_billing_last_name() + .map(\|name\| name.expose()), + currencyiso3a: item.router_data.request.currency.to_string(), + expirydate: card + .get_card_expiry_month_year_2_digit_with_delimiter("/".to_string())?, + orderreference: item.router_data.connector_request_reference_id.clone(), + pan: card.card_number.clone(), + requesttypedescriptions: request_types, + securitycode: card.card_cvc.clone(), + sitereference: auth.site_reference.expose(), + credentialsonfile: + TrustpaymentsCredentialsOnFile::CardholderInitiatedTransaction + .to_string(), + settlestatus: match item.router_data.request.capture_method { + Some(common_enums::CaptureMethod::Manual) => { + TrustpaymentsSettleStatus::ManualCapture + .as_str() + .to_string() + } + Some(common_enums::CaptureMethod::Automatic) \| None => { + TrustpaymentsSettleStatus::PendingSettlement + .as_str() + .to_string() + } + _ => TrustpaymentsSettleStatus::PendingSettlement + .as_str() + .to_string(), + }, + }], + }) + } + _ => Err(errors::ConnectorError::NotImplemented( + "Payment method not supported".to_string(), ) .into()), - _ => Err(errors::ConnectorError::NotImplemented("Payment method".to_string()).into()), } } } -//TODO: Fill the struct with respective fields -// Auth Struct pub struct TrustpaymentsAuthType { - pub(super) api_key: Secret<String>, + pub(super) username: Secret<String>, + pub(super) password: Secret<String>, + pub(super) site_reference: Secret<String>, +} + +impl TrustpaymentsAuthType { + pub fn get_basic_auth_header(&self) -> String { + use base64::Engine; + let credentials = format!( + "{}:{}", + self.username.clone().expose(), + self.password.clone().expose() + ); + let encoded = base64::engine::general_purpose::STANDARD.encode(credentials.as_bytes()); + format!("Basic {encoded}") + } } impl TryFrom<&ConnectorAuthType> for TrustpaymentsAuthType { 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(), + ConnectorAuthType::SignatureKey { + api_key, + key1, + api_secret, + } => Ok(Self { + username: api_key.to_owned(), + password: key1.to_owned(), + site_reference: api_secret.to_owned(), }), _ => Err(errors::ConnectorError::FailedToObtainAuthType.into()), } } } -// PaymentsResponse -//TODO: Append the remaining status flags -#[derive(Debug, Clone, Copy, Default, Serialize, Deserialize, PartialEq)] -#[serde(rename_all = "lowercase")] -pub enum TrustpaymentsPaymentStatus { - Succeeded, - Failed, - #[default] - Processing, +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +pub struct TrustpaymentsPaymentsResponse { + #[serde(alias = "response")] + pub responses: Vec<TrustpaymentsPaymentResponseData>, +} + +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +pub struct TrustpaymentsPaymentResponseData { + pub errorcode: TrustpaymentsErrorCode, + pub errormessage: String, + pub authcode: Option<String>, + pub baseamount: Option<StringMinorUnit>, + pub currencyiso3a: Option<String>, + pub transactionreference: Option<String>, + pub settlestatus: Option<TrustpaymentsSettleStatus>, + pub requesttypedescription: String, + pub securityresponsesecuritycode: Option<String>, } -impl From<TrustpaymentsPaymentStatus> for common_enums::AttemptStatus { - fn from(item: TrustpaymentsPaymentStatus) -> Self { - match item { - TrustpaymentsPaymentStatus::Succeeded => Self::Charged, - TrustpaymentsPaymentStatus::Failed => Self::Failure, - TrustpaymentsPaymentStatus::Processing => Self::Authorizing, +impl TrustpaymentsPaymentResponseData { + pub fn get_payment_status(&self) -> common_enums::AttemptStatus { + match self.errorcode { + TrustpaymentsErrorCode::Success => { + if self.authcode.is_some() { + match &self.settlestatus { + Some(TrustpaymentsSettleStatus::PendingSettlement) => { + // settlestatus "0" = automatic capture, scheduled to settle + common_enums::AttemptStatus::Charged + } + Some(TrustpaymentsSettleStatus::Settled) => { + // settlestatus "1" or "100" = transaction has been settled + common_enums::AttemptStatus::Charged + } + Some(TrustpaymentsSettleStatus::ManualCapture) => { + // settlestatus "2" = suspended, manual capture needed + common_enums::AttemptStatus::Authorized + } + Some(TrustpaymentsSettleStatus::Voided) => { + // settlestatus "3" = transaction has been cancelled + common_enums::AttemptStatus::Voided + } + None => common_enums::AttemptStatus::Authorized, + } + } else { + common_enums::AttemptStatus::Failure + } + } + _ => self.errorcode.get_attempt_status(), + } + } + + pub fn get_payment_status_for_sync(&self) -> common_enums::AttemptStatus { + match self.errorcode { + TrustpaymentsErrorCode::Success => { + if self.requesttypedescription == "TRANSACTIONQUERY" + && self.authcode.is_none() + && self.settlestatus.is_none() + && self.transactionreference.is_none() + { + common_enums::AttemptStatus::Authorized + } else if self.authcode.is_some() { + match &self.settlestatus { + Some(TrustpaymentsSettleStatus::PendingSettlement) => { + common_enums::AttemptStatus::Authorized + } + Some(TrustpaymentsSettleStatus::Settled) => { + common_enums::AttemptStatus::Charged + } + Some(TrustpaymentsSettleStatus::ManualCapture) => { + common_enums::AttemptStatus::Authorized + } + Some(TrustpaymentsSettleStatus::Voided) => { + common_enums::AttemptStatus::Voided + } + None => common_enums::AttemptStatus::Authorized, + } + } else { + common_enums::AttemptStatus::Pending + } + } + _ => self.errorcode.get_attempt_status(), + } + } + + pub fn get_error_message(&self) -> String { + if self.errorcode.is_success() { + "Success".to_string() + } else { + format!("Error {}: {}", self.errorcode, self.errormessage) + } + } + + pub fn get_error_reason(&self) -> Option<String> { + if !self.errorcode.is_success() { + Some(self.errorcode.get_description().to_string()) + } else { + None } } } -//TODO: Fill the struct with respective fields -#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] -pub struct TrustpaymentsPaymentsResponse { - status: TrustpaymentsPaymentStatus, - id: String, +impl + TryFrom< + ResponseRouterData< + hyperswitch_domain_models::router_flow_types::payments::Authorize, + TrustpaymentsPaymentsResponse, + hyperswitch_domain_models::router_request_types::PaymentsAuthorizeData, + PaymentsResponseData, + >, + > + for RouterData< + hyperswitch_domain_models::router_flow_types::payments::Authorize, + hyperswitch_domain_models::router_request_types::PaymentsAuthorizeData, + PaymentsResponseData, + > +{ + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: ResponseRouterData< + hyperswitch_domain_models::router_flow_types::payments::Authorize, + TrustpaymentsPaymentsResponse, + hyperswitch_domain_models::router_request_types::PaymentsAuthorizeData, + PaymentsResponseData, + >, + ) -> Result<Self, Self::Error> { + let response_data = item + .response + .responses + .first() + .ok_or(errors::ConnectorError::ResponseDeserializationFailed)?; + + let status = response_data.get_payment_status(); + let transaction_id = response_data + .transactionreference + .clone() + .unwrap_or_else(\|\| "unknown".to_string()); + + if !response_data.errorcode.is_success() { + let _error_response = TrustpaymentsErrorResponse::from(response_data.clone()); + return Ok(Self { + status, + response: Err(hyperswitch_domain_models::router_data::ErrorResponse { + code: response_data.errorcode.to_string(), + message: response_data.errormessage.clone(), + reason: response_data.get_error_reason(), + status_code: item.http_code, + attempt_status: Some(status), + connector_transaction_id: response_data.transactionreference.clone(), + network_advice_code: None, + network_decline_code: None, + network_error_message: None, + connector_metadata: None, + }), + ..item.data + }); + } + + Ok(Self { + status, + response: Ok(PaymentsResponseData::TransactionResponse { + resource_id: ResponseId::ConnectorTransactionId(transaction_id.clone()), + redirection_data: Box::new(None), + mandate_reference: Box::new(None), + connector_metadata: None, + network_txn_id: None, + connector_response_reference_id: Some(transaction_id), + incremental_authorization_allowed: None, + charges: None, + }), + ..item.data + }) + } +} + +impl + TryFrom< + ResponseRouterData< + hyperswitch_domain_models::router_flow_types::payments::PSync, + TrustpaymentsPaymentsResponse, + hyperswitch_domain_models::router_request_types::PaymentsSyncData, + PaymentsResponseData, + >, + > + for RouterData< + hyperswitch_domain_models::router_flow_types::payments::PSync, + hyperswitch_domain_models::router_request_types::PaymentsSyncData, + PaymentsResponseData, + > +{ + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: ResponseRouterData< + hyperswitch_domain_models::router_flow_types::payments::PSync, + TrustpaymentsPaymentsResponse, + hyperswitch_domain_models::router_request_types::PaymentsSyncData, + PaymentsResponseData, + >, + ) -> Result<Self, Self::Error> { + let response_data = item + .response + .responses + .first() + .ok_or(errors::ConnectorError::ResponseDeserializationFailed)?; + let status = response_data.get_payment_status_for_sync(); + let transaction_id = item + .data + .request + .connector_transaction_id + .get_connector_transaction_id() + .change_context(errors::ConnectorError::MissingConnectorTransactionID)?; + + if !response_data.errorcode.is_success() { + return Ok(Self { + status, + response: Err(hyperswitch_domain_models::router_data::ErrorResponse { + code: response_data.errorcode.to_string(), + message: response_data.errormessage.clone(), + reason: response_data.get_error_reason(), + status_code: item.http_code, + attempt_status: Some(status), + connector_transaction_id: Some(transaction_id.clone()), + network_advice_code: None, + network_decline_code: None, + network_error_message: None, + connector_metadata: None, + }), + ..item.data + }); + } + + Ok(Self { + status, + response: Ok(PaymentsResponseData::TransactionResponse { + resource_id: ResponseId::ConnectorTransactionId(transaction_id.clone()), + redirection_data: Box::new(None), + mandate_reference: Box::new(None), + connector_metadata: None, + network_txn_id: None, + connector_response_reference_id: Some(transaction_id), + incremental_authorization_allowed: None, + charges: None, + }), + ..item.data + }) + } +} + +impl + TryFrom< + ResponseRouterData< + hyperswitch_domain_models::router_flow_types::payments::Capture, + TrustpaymentsPaymentsResponse, + hyperswitch_domain_models::router_request_types::PaymentsCaptureData, + PaymentsResponseData, + >, + > + for RouterData< + hyperswitch_domain_models::router_flow_types::payments::Capture, + hyperswitch_domain_models::router_request_types::PaymentsCaptureData, + PaymentsResponseData, + > +{ + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: ResponseRouterData< + hyperswitch_domain_models::router_flow_types::payments::Capture, + TrustpaymentsPaymentsResponse, + hyperswitch_domain_models::router_request_types::PaymentsCaptureData, + PaymentsResponseData, + >, + ) -> Result<Self, Self::Error> { + let response_data = item + .response + .responses + .first() + .ok_or(errors::ConnectorError::ResponseDeserializationFailed)?; + + let transaction_id = item.data.request.connector_transaction_id.clone(); + let status = if response_data.errorcode.is_success() { + common_enums::AttemptStatus::Charged + } else { + response_data.get_payment_status() + }; + + if !response_data.errorcode.is_success() { + return Ok(Self { + status, + response: Err(hyperswitch_domain_models::router_data::ErrorResponse { + code: response_data.errorcode.to_string(), + message: response_data.errormessage.clone(), + reason: response_data.get_error_reason(), + status_code: item.http_code, + attempt_status: Some(status), + connector_transaction_id: Some(transaction_id.clone()), + network_advice_code: None, + network_decline_code: None, + network_error_message: None, + connector_metadata: None, + }), + ..item.data + }); + } + + Ok(Self { + status, + response: Ok(PaymentsResponseData::TransactionResponse { + resource_id: ResponseId::ConnectorTransactionId(transaction_id.clone()), + redirection_data: Box::new(None), + mandate_reference: Box::new(None), + connector_metadata: None, + network_txn_id: None, + connector_response_reference_id: Some(transaction_id), + incremental_authorization_allowed: None, + charges: None, + }), + ..item.data + }) + } } -impl<F, T> TryFrom<ResponseRouterData<F, TrustpaymentsPaymentsResponse, T, PaymentsResponseData>> - for RouterData<F, T, PaymentsResponseData> +impl + TryFrom< + ResponseRouterData< + hyperswitch_domain_models::router_flow_types::payments::Void, + TrustpaymentsPaymentsResponse, + hyperswitch_domain_models::router_request_types::PaymentsCancelData, + PaymentsResponseData, + >, + > + for RouterData< + hyperswitch_domain_models::router_flow_types::payments::Void, + hyperswitch_domain_models::router_request_types::PaymentsCancelData, + PaymentsResponseData, + > { type Error = error_stack::Report<errors::ConnectorError>; fn try_from( - item: ResponseRouterData<F, TrustpaymentsPaymentsResponse, T, PaymentsResponseData>, + item: ResponseRouterData< + hyperswitch_domain_models::router_flow_types::payments::Void, + TrustpaymentsPaymentsResponse, + hyperswitch_domain_models::router_request_types::PaymentsCancelData, + PaymentsResponseData, + >, ) -> Result<Self, Self::Error> { + let response_data = item + .response + .responses + .first() + .ok_or(errors::ConnectorError::ResponseDeserializationFailed)?; + + let transaction_id = item.data.request.connector_transaction_id.clone(); + let status = if response_data.errorcode.is_success() { + common_enums::AttemptStatus::Voided + } else { + response_data.get_payment_status() + }; + + if !response_data.errorcode.is_success() { + return Ok(Self { + status, + response: Err(hyperswitch_domain_models::router_data::ErrorResponse { + code: response_data.errorcode.to_string(), + message: response_data.errormessage.clone(), + reason: response_data.get_error_reason(), + status_code: item.http_code, + attempt_status: Some(status), + connector_transaction_id: Some(transaction_id.clone()), + network_advice_code: None, + network_decline_code: None, + network_error_message: None, + connector_metadata: None, + }), + ..item.data + }); + } + Ok(Self { - status: common_enums::AttemptStatus::from(item.response.status), + status, response: Ok(PaymentsResponseData::TransactionResponse { - resource_id: ResponseId::ConnectorTransactionId(item.response.id), + resource_id: ResponseId::ConnectorTransactionId(transaction_id.clone()), redirection_data: Box::new(None), mandate_reference: Box::new(None), connector_metadata: None, network_txn_id: None, - connector_response_reference_id: None, + connector_response_reference_id: Some(transaction_id), incremental_authorization_allowed: None, charges: None, }), @@ -132,12 +843,116 @@ impl<F, T> TryFrom<ResponseRouterData<F, TrustpaymentsPaymentsResponse, T, Payme } } -//TODO: Fill the struct with respective fields -// REFUND : -// Type definition for RefundRequest -#[derive(Default, Debug, Serialize)] +#[derive(Debug, Serialize, PartialEq)] +pub struct TrustpaymentsCaptureRequest { + pub alias: String, + pub version: String, + pub request: Vec<TrustpaymentsCaptureRequestData>, +} + +#[derive(Debug, Serialize, PartialEq)] +pub struct TrustpaymentsCaptureRequestData { + pub requesttypedescriptions: Vec<String>, + pub filter: TrustpaymentsFilter, + pub updates: TrustpaymentsCaptureUpdates, +} + +#[derive(Debug, Serialize, PartialEq)] +pub struct TrustpaymentsCaptureUpdates { + pub settlestatus: TrustpaymentsSettleStatus, +} + +impl TryFrom<&TrustpaymentsRouterData<&PaymentsCaptureRouterData>> for TrustpaymentsCaptureRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: &TrustpaymentsRouterData<&PaymentsCaptureRouterData>, + ) -> Result<Self, Self::Error> { + let auth = TrustpaymentsAuthType::try_from(&item.router_data.connector_auth_type)?; + + let transaction_reference = item.router_data.request.connector_transaction_id.clone(); + + Ok(Self { + alias: auth.username.expose(), + version: TRUSTPAYMENTS_API_VERSION.to_string(), + request: vec![TrustpaymentsCaptureRequestData { + requesttypedescriptions: vec!["TRANSACTIONUPDATE".to_string()], + filter: TrustpaymentsFilter { + sitereference: vec![TrustpaymentsFilterValue { + value: auth.site_reference.expose(), + }], + transactionreference: vec![TrustpaymentsFilterValue { + value: transaction_reference, + }], + }, + updates: TrustpaymentsCaptureUpdates { + settlestatus: TrustpaymentsSettleStatus::PendingSettlement, + }, + }], + }) + } +} + +#[derive(Debug, Serialize, PartialEq)] +pub struct TrustpaymentsVoidRequest { + pub alias: String, + pub version: String, + pub request: Vec<TrustpaymentsVoidRequestData>, +} + +#[derive(Debug, Serialize, PartialEq)] +pub struct TrustpaymentsVoidRequestData { + pub requesttypedescriptions: Vec<String>, + pub filter: TrustpaymentsFilter, + pub updates: TrustpaymentsVoidUpdates, +} + +#[derive(Debug, Serialize, PartialEq)] +pub struct TrustpaymentsVoidUpdates { + pub settlestatus: TrustpaymentsSettleStatus, +} + +impl TryFrom<&PaymentsCancelRouterData> for TrustpaymentsVoidRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from(item: &PaymentsCancelRouterData) -> Result<Self, Self::Error> { + let auth = TrustpaymentsAuthType::try_from(&item.connector_auth_type)?; + + let transaction_reference = item.request.connector_transaction_id.clone(); + + Ok(Self { + alias: auth.username.expose(), + version: TRUSTPAYMENTS_API_VERSION.to_string(), + request: vec![TrustpaymentsVoidRequestData { + requesttypedescriptions: vec!["TRANSACTIONUPDATE".to_string()], + filter: TrustpaymentsFilter { + sitereference: vec![TrustpaymentsFilterValue { + value: auth.site_reference.expose(), + }], + transactionreference: vec![TrustpaymentsFilterValue { + value: transaction_reference, + }], + }, + updates: TrustpaymentsVoidUpdates { + settlestatus: TrustpaymentsSettleStatus::Voided, + }, + }], + }) + } +} + +#[derive(Debug, Serialize, PartialEq)] pub struct TrustpaymentsRefundRequest { - pub amount: StringMinorUnit, + pub alias: String, + pub version: String, + pub request: Vec<TrustpaymentsRefundRequestData>, +} + +#[derive(Debug, Serialize, PartialEq)] +pub struct TrustpaymentsRefundRequestData { + pub requesttypedescriptions: Vec<String>, + pub sitereference: String, + pub parenttransactionreference: String, + pub baseamount: StringMinorUnit, + pub currencyiso3a: String, } impl<F> TryFrom<&TrustpaymentsRouterData<&RefundsRouterData<F>>> for TrustpaymentsRefundRequest { @@ -145,50 +960,132 @@ impl<F> TryFrom<&TrustpaymentsRouterData<&RefundsRouterData<F>>> for Trustpaymen fn try_from( item: &TrustpaymentsRouterData<&RefundsRouterData<F>>, ) -> Result<Self, Self::Error> { + let auth = TrustpaymentsAuthType::try_from(&item.router_data.connector_auth_type)?; + + let parent_transaction_reference = + item.router_data.request.connector_transaction_id.clone(); + Ok(Self { - amount: item.amount.to_owned(), + alias: auth.username.expose(), + version: TRUSTPAYMENTS_API_VERSION.to_string(), + request: vec![TrustpaymentsRefundRequestData { + requesttypedescriptions: vec!["REFUND".to_string()], + sitereference: auth.site_reference.expose(), + parenttransactionreference: parent_transaction_reference, + baseamount: item.amount.clone(), + currencyiso3a: item.router_data.request.currency.to_string(), + }], }) } } -// Type definition for Refund Response +#[derive(Debug, Serialize, PartialEq)] +pub struct TrustpaymentsSyncRequest { + pub alias: String, + pub version: String, + pub request: Vec<TrustpaymentsSyncRequestData>, +} -#[allow(dead_code)] -#[derive(Debug, Copy, Serialize, Default, Deserialize, Clone)] -pub enum RefundStatus { - Succeeded, - Failed, - #[default] - Processing, +#[derive(Debug, Serialize, PartialEq)] +pub struct TrustpaymentsSyncRequestData { + pub requesttypedescriptions: Vec<String>, + pub filter: TrustpaymentsFilter, } -impl From<RefundStatus> for enums::RefundStatus { - fn from(item: RefundStatus) -> Self { - match item { - RefundStatus::Succeeded => Self::Success, - RefundStatus::Failed => Self::Failure, - RefundStatus::Processing => Self::Pending, - //TODO: Review mapping - } +#[derive(Debug, Serialize, PartialEq)] +pub struct TrustpaymentsFilter { + pub sitereference: Vec<TrustpaymentsFilterValue>, + pub transactionreference: Vec<TrustpaymentsFilterValue>, +} + +#[derive(Debug, Serialize, PartialEq)] +pub struct TrustpaymentsFilterValue { + pub value: String, +} + +impl TryFrom<&PaymentsSyncRouterData> for TrustpaymentsSyncRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from(item: &PaymentsSyncRouterData) -> Result<Self, Self::Error> { + let auth = TrustpaymentsAuthType::try_from(&item.connector_auth_type)?; + + let transaction_reference = item + .request + .connector_transaction_id + .get_connector_transaction_id() + .change_context(errors::ConnectorError::MissingConnectorTransactionID)?; + + Ok(Self { + alias: auth.username.expose(), + version: TRUSTPAYMENTS_API_VERSION.to_string(), + request: vec![TrustpaymentsSyncRequestData { + requesttypedescriptions: vec!["TRANSACTIONQUERY".to_string()], + filter: TrustpaymentsFilter { + sitereference: vec![TrustpaymentsFilterValue { + value: auth.site_reference.expose(), + }], + transactionreference: vec![TrustpaymentsFilterValue { + value: transaction_reference, + }], + }, + }], + }) } } -//TODO: Fill the struct with respective fields -#[derive(Default, Debug, Clone, Serialize, Deserialize)] -pub struct RefundResponse { - id: String, - status: RefundStatus, +pub type TrustpaymentsRefundSyncRequest = TrustpaymentsSyncRequest; + +impl TryFrom<&RefundSyncRouterData> for TrustpaymentsRefundSyncRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from(item: &RefundSyncRouterData) -> Result<Self, Self::Error> { + let auth = TrustpaymentsAuthType::try_from(&item.connector_auth_type)?; + + let refund_transaction_reference = item + .request + .get_connector_refund_id() + .change_context(errors::ConnectorError::MissingConnectorRefundID)?; + + Ok(Self { + alias: auth.username.expose(), + version: TRUSTPAYMENTS_API_VERSION.to_string(), + request: vec![TrustpaymentsSyncRequestData { + requesttypedescriptions: vec!["TRANSACTIONQUERY".to_string()], + filter: TrustpaymentsFilter { + sitereference: vec![TrustpaymentsFilterValue { + value: auth.site_reference.expose(), + }], + transactionreference: vec![TrustpaymentsFilterValue { + value: refund_transaction_reference, + }], + }, + }], + }) + } } +pub type RefundResponse = TrustpaymentsPaymentsResponse; + impl TryFrom<RefundsResponseRouterData<Execute, RefundResponse>> for RefundsRouterData<Execute> { type Error = error_stack::Report<errors::ConnectorError>; fn try_from( item: RefundsResponseRouterData<Execute, RefundResponse>, ) -> Result<Self, Self::Error> { + let response_data = item + .response + .responses + .first() + .ok_or(errors::ConnectorError::ResponseDeserializationFailed)?; + + let refund_id = response_data + .transactionreference + .clone() + .unwrap_or_else(\|\| "unknown".to_string()); + + let refund_status = response_data.get_refund_status(); + Ok(Self { response: Ok(RefundsResponseData { - connector_refund_id: item.response.id.to_string(), - refund_status: enums::RefundStatus::from(item.response.status), + connector_refund_id: refund_id, + refund_status, }), ..item.data }) @@ -200,17 +1097,136 @@ impl TryFrom<RefundsResponseRouterData<RSync, RefundResponse>> for RefundsRouter fn try_from( item: RefundsResponseRouterData<RSync, RefundResponse>, ) -> Result<Self, Self::Error> { + let response_data = item + .response + .responses + .first() + .ok_or(errors::ConnectorError::ResponseDeserializationFailed)?; + + let refund_id = response_data + .transactionreference + .clone() + .unwrap_or_else(\|\| "unknown".to_string()); + + let refund_status = response_data.get_refund_status(); + Ok(Self { response: Ok(RefundsResponseData { - connector_refund_id: item.response.id.to_string(), - refund_status: enums::RefundStatus::from(item.response.status), + connector_refund_id: refund_id, + refund_status, + }), + ..item.data + }) + } +} + +#[derive(Debug, Serialize, PartialEq)] +pub struct TrustpaymentsTokenizationRequest { + pub alias: String, + pub version: String, + pub request: Vec<TrustpaymentsTokenizationRequestData>, +} + +#[derive(Debug, Serialize, PartialEq)] +pub struct TrustpaymentsTokenizationRequestData { + pub accounttypedescription: String, + pub requesttypedescriptions: Vec<String>, + pub sitereference: String, + pub pan: cards::CardNumber, + pub expirydate: Secret<String>, + pub securitycode: Secret<String>, + pub credentialsonfile: String, +} + +impl + TryFrom< + &RouterData< + hyperswitch_domain_models::router_flow_types::payments::PaymentMethodToken, + hyperswitch_domain_models::router_request_types::PaymentMethodTokenizationData, + PaymentsResponseData, + >, + > for TrustpaymentsTokenizationRequest +{ + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: &RouterData< + hyperswitch_domain_models::router_flow_types::payments::PaymentMethodToken, + hyperswitch_domain_models::router_request_types::PaymentMethodTokenizationData, + PaymentsResponseData, + >, + ) -> Result<Self, Self::Error> { + let auth = TrustpaymentsAuthType::try_from(&item.connector_auth_type)?; + + match &item.request.payment_method_data { + PaymentMethodData::Card(card_data) => Ok(Self { + alias: auth.username.expose(), + version: TRUSTPAYMENTS_API_VERSION.to_string(), + request: vec![TrustpaymentsTokenizationRequestData { + accounttypedescription: "ECOM".to_string(), + requesttypedescriptions: vec!["ACCOUNTCHECK".to_string()], + sitereference: auth.site_reference.expose(), + pan: card_data.card_number.clone(), + expirydate: card_data + .get_card_expiry_month_year_2_digit_with_delimiter("/".to_string())?, + securitycode: card_data.card_cvc.clone(), + credentialsonfile: + TrustpaymentsCredentialsOnFile::CardholderInitiatedTransaction.to_string(), + }], }), + _ => Err(errors::ConnectorError::NotImplemented( + "Payment method not supported for tokenization".to_string(), + ) + .into()), + } + } +} + +pub type TrustpaymentsTokenizationResponse = TrustpaymentsPaymentsResponse; + +impl + TryFrom< + ResponseRouterData< + hyperswitch_domain_models::router_flow_types::payments::PaymentMethodToken, + TrustpaymentsTokenizationResponse, + hyperswitch_domain_models::router_request_types::PaymentMethodTokenizationData, + PaymentsResponseData, + >, + > + for RouterData< + hyperswitch_domain_models::router_flow_types::payments::PaymentMethodToken, + hyperswitch_domain_models::router_request_types::PaymentMethodTokenizationData, + PaymentsResponseData, + > +{ + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: ResponseRouterData< + hyperswitch_domain_models::router_flow_types::payments::PaymentMethodToken, + TrustpaymentsTokenizationResponse, + hyperswitch_domain_models::router_request_types::PaymentMethodTokenizationData, + PaymentsResponseData, + >, + ) -> Result<Self, Self::Error> { + let response_data = item + .response + .responses + .first() + .ok_or(errors::ConnectorError::ResponseDeserializationFailed)?; + + let status = response_data.get_payment_status(); + let token = response_data + .transactionreference + .clone() + .unwrap_or_else(\|\| "unknown".to_string()); + + Ok(Self { + status, + response: Ok(PaymentsResponseData::TokenizationResponse { token }), ..item.data }) } } -//TODO: Fill the struct with respective fields #[derive(Default, Debug, Serialize, Deserialize, PartialEq)] pub struct TrustpaymentsErrorResponse { pub status_code: u16, @@ -221,3 +1237,112 @@ pub struct TrustpaymentsErrorResponse { pub network_decline_code: Option<String>, pub network_error_message: Option<String>, } + +impl TrustpaymentsErrorResponse { + pub fn get_connector_error_type(&self) -> errors::ConnectorError { + let error_code: TrustpaymentsErrorCode = + serde_json::from_str(&format!("\"{}\"", self.code)) + .unwrap_or(TrustpaymentsErrorCode::Unknown(self.code.clone())); + + match error_code { + TrustpaymentsErrorCode::InvalidCredentials + \| TrustpaymentsErrorCode::AuthenticationFailed + \| TrustpaymentsErrorCode::InvalidSiteReference + \| TrustpaymentsErrorCode::AccessDenied + \| TrustpaymentsErrorCode::InvalidUsernameOrPassword + \| TrustpaymentsErrorCode::AccountSuspended => { + errors::ConnectorError::InvalidConnectorConfig { + config: "authentication", + } + } + TrustpaymentsErrorCode::InvalidCardNumber + \| TrustpaymentsErrorCode::InvalidExpiryDate + \| TrustpaymentsErrorCode::InvalidSecurityCode + \| TrustpaymentsErrorCode::InvalidCardType + \| TrustpaymentsErrorCode::CardExpired + \| TrustpaymentsErrorCode::InvalidAmountValue => { + errors::ConnectorError::InvalidDataFormat { + field_name: "payment_method_data", + } + } + TrustpaymentsErrorCode::InsufficientFunds + \| TrustpaymentsErrorCode::CardDeclined + \| TrustpaymentsErrorCode::CardRestricted + \| TrustpaymentsErrorCode::InvalidMerchant + \| TrustpaymentsErrorCode::TransactionNotPermitted + \| TrustpaymentsErrorCode::ExceedsWithdrawalLimit + \| TrustpaymentsErrorCode::SecurityViolation + \| TrustpaymentsErrorCode::LostOrStolenCard + \| TrustpaymentsErrorCode::SuspectedFraud + \| TrustpaymentsErrorCode::ContactCardIssuer => { + errors::ConnectorError::FailedAtConnector { + message: self.message.clone(), + code: self.code.clone(), + } + } + TrustpaymentsErrorCode::GeneralProcessingError + \| TrustpaymentsErrorCode::SystemError + \| TrustpaymentsErrorCode::CommunicationError + \| TrustpaymentsErrorCode::Timeout + \| TrustpaymentsErrorCode::InvalidRequest => { + errors::ConnectorError::ProcessingStepFailed(None) + } + TrustpaymentsErrorCode::Processing => errors::ConnectorError::ProcessingStepFailed( + Some(bytes::Bytes::from("Transaction is being processed")), + ), + TrustpaymentsErrorCode::MissingRequiredField + \| TrustpaymentsErrorCode::InvalidFieldFormat + \| TrustpaymentsErrorCode::InvalidFieldValue + \| TrustpaymentsErrorCode::FieldTooLong + \| TrustpaymentsErrorCode::FieldTooShort + \| TrustpaymentsErrorCode::InvalidCurrency + \| TrustpaymentsErrorCode::InvalidAmount + \| TrustpaymentsErrorCode::NoSearchableFilter => { + errors::ConnectorError::MissingRequiredField { + field_name: "request_data", + } + } + TrustpaymentsErrorCode::Success => errors::ConnectorError::ProcessingStepFailed(Some( + bytes::Bytes::from("Unexpected success code in error response"), + )), + TrustpaymentsErrorCode::Unknown(_) => errors::ConnectorError::ProcessingStepFailed( + Some(bytes::Bytes::from(self.message.clone())), + ), + } + } +} + +impl From<TrustpaymentsPaymentResponseData> for TrustpaymentsErrorResponse { + fn from(response: TrustpaymentsPaymentResponseData) -> Self { + let error_reason = response.get_error_reason(); + Self { + status_code: if response.errorcode.is_success() { + 200 + } else { + 400 + }, + code: response.errorcode.to_string(), + message: response.errormessage, + reason: error_reason, + network_advice_code: None, + network_decline_code: None, + network_error_message: None, + } + } +} + +impl TrustpaymentsPaymentResponseData { + pub fn get_refund_status(&self) -> enums::RefundStatus { + match self.errorcode { + TrustpaymentsErrorCode::Success => match &self.settlestatus { + Some(TrustpaymentsSettleStatus::Settled) => enums::RefundStatus::Success, + Some(TrustpaymentsSettleStatus::PendingSettlement) => enums::RefundStatus::Pending, + Some(TrustpaymentsSettleStatus::ManualCapture) => enums::RefundStatus::Failure, + Some(TrustpaymentsSettleStatus::Voided) => enums::RefundStatus::Failure, + None => enums::RefundStatus::Success, + }, + TrustpaymentsErrorCode::Processing => enums::RefundStatus::Pending, + _ => enums::RefundStatus::Failure, + } + } +} diff --git a/crates/hyperswitch_connectors/src/default_implementations_v2.rs b/crates/hyperswitch_connectors/src/default_implementations_v2.rs index 836ad796a05..16331cd579b 100644 --- a/crates/hyperswitch_connectors/src/default_implementations_v2.rs +++ b/crates/hyperswitch_connectors/src/default_implementations_v2.rs @@ -3897,11 +3897,8 @@ macro_rules! default_imp_for_new_connector_integration_frm { #[cfg(feature = "frm")] default_imp_for_new_connector_integration_frm!( - connectors::Paysafe, - connectors::Trustpayments, connectors::Affirm, connectors::Paytm, - connectors::Vgs, connectors::Airwallex, connectors::Amazonpay, connectors::Authipay, @@ -3936,10 +3933,10 @@ default_imp_for_new_connector_integration_frm!( connectors::Flexiti, connectors::Forte, connectors::Globepay, - connectors::Hipay, connectors::Gocardless, connectors::Gpayments, connectors::Helcim, + connectors::Hipay, connectors::HyperswitchVault, connectors::Hyperwallet, connectors::Inespay, @@ -3947,17 +3944,20 @@ default_imp_for_new_connector_integration_frm!( connectors::Juspaythreedsserver, connectors::Katapult, connectors::Mpgs, - connectors::Nomupay, - connectors::Nordea, - connectors::Novalnet, + connectors::Mollie, + connectors::Multisafepay, connectors::Netcetera, connectors::Nexinets, connectors::Nexixpay, connectors::Nmi, - connectors::Payone, + connectors::Nomupay, + connectors::Nordea, + connectors::Novalnet, connectors::Paybox, connectors::Payeezy, connectors::Payload, + connectors::Payone, + connectors::Paysafe, connectors::Payu, connectors::Peachpayments, connectors::Phonepe, @@ -3965,8 +3965,6 @@ default_imp_for_new_connector_integration_frm!( connectors::Plaid, connectors::Powertranz, connectors::Prophetpay, - connectors::Mollie, - connectors::Multisafepay, connectors::Rapyd, connectors::Razorpay, connectors::Recurly, @@ -3984,11 +3982,13 @@ default_imp_for_new_connector_integration_frm!( connectors::Threedsecureio, connectors::Thunes, connectors::Tokenio, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, + connectors::Vgs, + connectors::Volt, connectors::Wise, connectors::Worldline, - connectors::Volt, connectors::Worldpay, connectors::Worldpayvantiv, connectors::Worldpayxml, @@ -4041,11 +4041,8 @@ macro_rules! default_imp_for_new_connector_integration_connector_authentication } default_imp_for_new_connector_integration_connector_authentication!( - connectors::Paysafe, - connectors::Trustpayments, connectors::Affirm, connectors::Paytm, - connectors::Vgs, connectors::Airwallex, connectors::Amazonpay, connectors::Authipay, @@ -4091,15 +4088,18 @@ default_imp_for_new_connector_integration_connector_authentication!( connectors::Juspaythreedsserver, connectors::Katapult, connectors::Mpgs, - connectors::Nomupay, - connectors::Nordea, - connectors::Novalnet, + connectors::Mollie, + connectors::Multisafepay, connectors::Netcetera, connectors::Nexinets, connectors::Nexixpay, + connectors::Nomupay, + connectors::Nordea, + connectors::Novalnet, connectors::Paybox, connectors::Payeezy, connectors::Payload, + connectors::Paysafe, connectors::Payu, connectors::Peachpayments, connectors::Phonepe, @@ -4107,13 +4107,11 @@ default_imp_for_new_connector_integration_connector_authentication!( connectors::Plaid, connectors::Powertranz, connectors::Prophetpay, - connectors::Mollie, - connectors::Multisafepay, connectors::Rapyd, connectors::Razorpay, + connectors::Recurly, connectors::Redsys, connectors::Riskified, - connectors::Recurly, connectors::Santander, connectors::Shift4, connectors::Sift, @@ -4126,11 +4124,13 @@ default_imp_for_new_connector_integration_connector_authentication!( connectors::Threedsecureio, connectors::Thunes, connectors::Tokenio, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, + connectors::Vgs, + connectors::Volt, connectors::Wise, connectors::Worldline, - connectors::Volt, connectors::Worldpay, connectors::Worldpayvantiv, connectors::Worldpayxml, @@ -4174,11 +4174,8 @@ macro_rules! default_imp_for_new_connector_integration_revenue_recovery { } default_imp_for_new_connector_integration_revenue_recovery!( - connectors::Paysafe, - connectors::Trustpayments, connectors::Affirm, connectors::Paytm, - connectors::Vgs, connectors::Airwallex, connectors::Amazonpay, connectors::Authipay, @@ -4204,8 +4201,8 @@ default_imp_for_new_connector_integration_revenue_recovery!( connectors::Digitalvirgo, connectors::Dlocal, connectors::Dwolla, - connectors::Elavon, connectors::Ebanx, + connectors::Elavon, connectors::Facilitapay, connectors::Fiserv, connectors::Fiservemea, @@ -4224,17 +4221,20 @@ default_imp_for_new_connector_integration_revenue_recovery!( connectors::Juspaythreedsserver, connectors::Katapult, connectors::Mpgs, - connectors::Nomupay, - connectors::Nordea, - connectors::Novalnet, + connectors::Mollie, + connectors::Multisafepay, connectors::Netcetera, connectors::Nexinets, connectors::Nexixpay, connectors::Nmi, - connectors::Payone, + connectors::Nomupay, + connectors::Nordea, + connectors::Novalnet, connectors::Paybox, connectors::Payeezy, connectors::Payload, + connectors::Payone, + connectors::Paysafe, connectors::Payu, connectors::Peachpayments, connectors::Phonepe, @@ -4242,8 +4242,6 @@ default_imp_for_new_connector_integration_revenue_recovery!( connectors::Plaid, connectors::Powertranz, connectors::Prophetpay, - connectors::Mollie, - connectors::Multisafepay, connectors::Rapyd, connectors::Razorpay, connectors::Redsys, @@ -4260,11 +4258,13 @@ default_imp_for_new_connector_integration_revenue_recovery!( connectors::Threedsecureio, connectors::Thunes, connectors::Tokenio, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, + connectors::Vgs, + connectors::Volt, connectors::Wise, connectors::Worldline, - connectors::Volt, connectors::Worldpay, connectors::Worldpayvantiv, connectors::Worldpayxml, diff --git a/crates/payment_methods/src/configs/payment_connector_required_fields.rs b/crates/payment_methods/src/configs/payment_connector_required_fields.rs index 32a1c175ea0..1de18b2bff0 100644 --- a/crates/payment_methods/src/configs/payment_connector_required_fields.rs +++ b/crates/payment_methods/src/configs/payment_connector_required_fields.rs @@ -1566,6 +1566,10 @@ fn get_cards_required_fields() -> HashMap<Connector, RequiredFieldFinal> { vec![], ), ), + ( + Connector::Trustpayments, + fields(vec![], vec![], card_basic()), + ), (Connector::Tsys, fields(vec![], card_basic(), vec![])), ( Connector::Wellsfargo, diff --git a/crates/router/src/core/connector_validation.rs b/crates/router/src/core/connector_validation.rs index 5ff6937754b..1c689f4eeff 100644 --- a/crates/router/src/core/connector_validation.rs +++ b/crates/router/src/core/connector_validation.rs @@ -487,6 +487,10 @@ impl ConnectorAuthTypeAndMetadataValidation<'_> { trustpay::transformers::TrustpayAuthType::try_from(self.auth_type)?; Ok(()) } + api_enums::Connector::Trustpayments => { + trustpayments::transformers::TrustpaymentsAuthType::try_from(self.auth_type)?; + Ok(()) + } api_enums::Connector::Tokenio => { tokenio::transformers::TokenioAuthType::try_from(self.auth_type)?; Ok(()) diff --git a/crates/router/src/types/api/connector_mapping.rs b/crates/router/src/types/api/connector_mapping.rs index 2333f1c8bc1..400a13407e6 100644 --- a/crates/router/src/types/api/connector_mapping.rs +++ b/crates/router/src/types/api/connector_mapping.rs @@ -440,6 +440,9 @@ impl ConnectorData { enums::Connector::Trustpay => { Ok(ConnectorEnum::Old(Box::new(connector::Trustpay::new()))) } + enums::Connector::Trustpayments => Ok(ConnectorEnum::Old(Box::new( + connector::Trustpayments::new(), + ))), enums::Connector::Tsys => Ok(ConnectorEnum::Old(Box::new(connector::Tsys::new()))), // enums::Connector::UnifiedAuthenticationService => Ok(ConnectorEnum::Old(Box::new( // connector::UnifiedAuthenticationService, diff --git a/crates/router/src/types/api/feature_matrix.rs b/crates/router/src/types/api/feature_matrix.rs index d5480ab2c26..7290acb121d 100644 --- a/crates/router/src/types/api/feature_matrix.rs +++ b/crates/router/src/types/api/feature_matrix.rs @@ -359,6 +359,9 @@ impl FeatureMatrixConnectorData { enums::Connector::Trustpay => { Ok(ConnectorEnum::Old(Box::new(connector::Trustpay::new()))) } + enums::Connector::Trustpayments => Ok(ConnectorEnum::Old(Box::new( + connector::Trustpayments::new(), + ))), enums::Connector::Tsys => Ok(ConnectorEnum::Old(Box::new(connector::Tsys::new()))), // enums::Connector::UnifiedAuthenticationService => Ok(ConnectorEnum::Old(Box::new( // connector::UnifiedAuthenticationService, diff --git a/crates/router/src/types/connector_transformers.rs b/crates/router/src/types/connector_transformers.rs index 6bcec0681d4..f931e1a0a8f 100644 --- a/crates/router/src/types/connector_transformers.rs +++ b/crates/router/src/types/connector_transformers.rs @@ -142,6 +142,7 @@ impl ForeignTryFrom<api_enums::Connector> for common_enums::RoutableConnectors { // api_enums::Connector::Thunes => Self::Thunes, api_enums::Connector::Tokenio => Self::Tokenio, api_enums::Connector::Trustpay => Self::Trustpay, + api_enums::Connector::Trustpayments => Self::Trustpayments, api_enums::Connector::Tsys => Self::Tsys, // api_enums::Connector::UnifiedAuthenticationService => { // Self::UnifiedAuthenticationService diff --git a/crates/router/tests/connectors/trustpayments.rs b/crates/router/tests/connectors/trustpayments.rs index 7d07b825aac..3fc6239f1db 100644 --- a/crates/router/tests/connectors/trustpayments.rs +++ b/crates/router/tests/connectors/trustpayments.rs @@ -1,6 +1,7 @@ -use hyperswitch_domain_models::payment_method_data::{Card, PaymentMethodData}; +use std::str::FromStr; + use masking::Secret; -use router::types::{self, api, storage::enums}; +use router::types::{self, api, domain, storage::enums}; use test_utils::connector_auth; use crate::utils::{self, ConnectorActions}; @@ -13,7 +14,7 @@ impl utils::Connector for TrustpaymentsTest { use router::connector::Trustpayments; utils::construct_connector_data_old( Box::new(Trustpayments::new()), - types::Connector::Plaid, + types::Connector::Trustpayments, api::GetToken::Connector, None, ) @@ -36,11 +37,58 @@ impl utils::Connector for TrustpaymentsTest { static CONNECTOR: TrustpaymentsTest = TrustpaymentsTest {}; fn get_default_payment_info() -> Option<utils::PaymentInfo> { - None + Some(utils::PaymentInfo { + address: Some(types::PaymentAddress::new( + None, + None, + Some(hyperswitch_domain_models::address::Address { + address: Some(hyperswitch_domain_models::address::AddressDetails { + country: Some(common_enums::CountryAlpha2::US), + city: Some("New York".to_string()), + zip: Some(Secret::new("10001".to_string())), + line1: Some(Secret::new("123 Main St".to_string())), + line2: None, + line3: None, + state: Some(Secret::new("NY".to_string())), + first_name: Some(Secret::new("John".to_string())), + last_name: Some(Secret::new("Doe".to_string())), + origin_zip: None, + }), + phone: Some(hyperswitch_domain_models::address::PhoneDetails { + number: Some(Secret::new("1234567890".to_string())), + country_code: Some("+1".to_string()), + }), + email: None, + }), + None, + )), + ..Default::default() + }) } fn payment_method_details() -> Option<types::PaymentsAuthorizeData> { - None + Some(types::PaymentsAuthorizeData { + payment_method_data: domain::PaymentMethodData::Card(domain::Card { + card_number: cards::CardNumber::from_str("4111111111111111").unwrap(), + card_exp_month: Secret::new("12".to_string()), + card_exp_year: Secret::new("2025".to_string()), + card_cvc: Secret::new("123".to_string()), + card_issuer: None, + card_network: None, + card_type: None, + card_issuing_country: None, + bank_code: None, + nick_name: None, + card_holder_name: Some(Secret::new("John Doe".to_string())), + co_badged_card_data: None, + }), + confirm: true, + amount: 100, + minor_amount: common_utils::types::MinorUnit::new(100), + currency: enums::Currency::USD, + capture_method: Some(enums::CaptureMethod::Manual), + ..utils::PaymentAuthorizeType::default().0 + }) } // Cards Positive Tests @@ -303,7 +351,7 @@ async fn should_fail_payment_for_incorrect_cvc() { let response = CONNECTOR .make_payment( Some(types::PaymentsAuthorizeData { - payment_method_data: PaymentMethodData::Card(Card { + payment_method_data: domain::PaymentMethodData::Card(domain::Card { card_cvc: Secret::new("12345".to_string()), ..utils::CCardType::default().0 }), @@ -325,7 +373,7 @@ async fn should_fail_payment_for_invalid_exp_month() { let response = CONNECTOR .make_payment( Some(types::PaymentsAuthorizeData { - payment_method_data: PaymentMethodData::Card(Card { + payment_method_data: domain::PaymentMethodData::Card(domain::Card { card_exp_month: Secret::new("20".to_string()), ..utils::CCardType::default().0 }), @@ -347,7 +395,7 @@ async fn should_fail_payment_for_incorrect_expiry_year() { let response = CONNECTOR .make_payment( Some(types::PaymentsAuthorizeData { - payment_method_data: PaymentMethodData::Card(Card { + payment_method_data: domain::PaymentMethodData::Card(domain::Card { card_exp_year: Secret::new("2000".to_string()), ..utils::CCardType::default().0 }),	2025-07-21T10:13:40Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> Cards Non-3DS payments added for Trustpayments ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> Tested using cargo build and cypress test <img width="800" height="990" alt="image" src="https://github.com/user-attachments/assets/c8c11da3-737f-4518-b696-1a1a4ae07dca" /> ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [x] I added unit tests for my changes where possible	v1.117.0	f3ab3d63f69279af9254f15eba5654c0680a0747	f3ab3d63f69279af9254f15eba5654c0680a0747
juspay/hyperswitch	juspay__hyperswitch-8679	Bug: Propage request id to chat service Send request id to chat service in headers.	diff --git a/crates/common_utils/src/consts.rs b/crates/common_utils/src/consts.rs index 3ef0ef555e6..28508749f35 100644 --- a/crates/common_utils/src/consts.rs +++ b/crates/common_utils/src/consts.rs @@ -152,6 +152,9 @@ pub const APPLEPAY_VALIDATION_URL: &str = /// Request ID pub const X_REQUEST_ID: &str = "x-request-id"; +/// Chat Session ID +pub const X_CHAT_SESSION_ID: &str = "x-chat-session-id"; + /// Merchant ID Header pub const X_MERCHANT_ID: &str = "x-merchant-id"; diff --git a/crates/router/src/core/chat.rs b/crates/router/src/core/chat.rs index c30e27f0482..837a259bed4 100644 --- a/crates/router/src/core/chat.rs +++ b/crates/router/src/core/chat.rs @@ -11,18 +11,19 @@ use router_env::{instrument, logger, tracing}; use crate::{ db::errors::chat::ChatErrors, - routes::SessionState, + routes::{app::SessionStateInfo, SessionState}, services::{authentication as auth, ApplicationResponse}, }; -#[instrument(skip_all)] +#[instrument(skip_all, fields(?session_id))] pub async fn get_data_from_hyperswitch_ai_workflow( state: SessionState, user_from_token: auth::UserFromToken, req: chat_api::ChatRequest, + session_id: Option<&str>, ) -> CustomResult<ApplicationResponse<chat_api::ChatResponse>, ChatErrors> { let url = format!("{}/webhook", state.conf.chat.hyperswitch_ai_host); - + let request_id = state.get_request_id(); let request_body = chat_domain::HyperswitchAiDataRequest { query: chat_domain::GetDataMessage { message: req.message, @@ -33,12 +34,20 @@ pub async fn get_data_from_hyperswitch_ai_workflow( }; logger::info!("Request for AI service: {:?}", request_body); - let request = RequestBuilder::new() + let mut request_builder = RequestBuilder::new() .method(Method::Post) .url(&url) .attach_default_headers() - .set_body(RequestContent::Json(Box::new(request_body.clone()))) - .build(); + .set_body(RequestContent::Json(Box::new(request_body.clone()))); + + if let Some(request_id) = request_id { + request_builder = request_builder.header(consts::X_REQUEST_ID, &request_id); + } + if let Some(session_id) = session_id { + request_builder = request_builder.header(consts::X_CHAT_SESSION_ID, session_id); + } + + let request = request_builder.build(); let response = http_client::send_request( &state.conf.proxy, diff --git a/crates/router/src/routes/chat.rs b/crates/router/src/routes/chat.rs index 555bf007d23..e3970cc6a4c 100644 --- a/crates/router/src/routes/chat.rs +++ b/crates/router/src/routes/chat.rs @@ -6,6 +6,7 @@ use router_env::{instrument, tracing, Flow}; use super::AppState; use crate::{ core::{api_locking, chat as chat_core}, + routes::metrics, services::{ api, authentication::{self as auth}, @@ -20,13 +21,21 @@ pub async fn get_data_from_hyperswitch_ai_workflow( payload: web::Json<chat_api::ChatRequest>, ) -> HttpResponse { let flow = Flow::GetDataFromHyperswitchAiFlow; + let session_id = http_req + .headers() + .get(common_utils::consts::X_CHAT_SESSION_ID) + .and_then(\|header_value\| header_value.to_str().ok()); Box::pin(api::server_wrap( flow.clone(), state, &http_req, payload.into_inner(), \|state, user: auth::UserFromToken, payload, _\| { - chat_core::get_data_from_hyperswitch_ai_workflow(state, user, payload) + metrics::CHAT_REQUEST_COUNT.add( + 1, + router_env::metric_attributes!(("merchant_id", user.merchant_id.clone())), + ); + chat_core::get_data_from_hyperswitch_ai_workflow(state, user, payload, session_id) }, // At present, the AI service retrieves data scoped to the merchant level &auth::JWTAuth { diff --git a/crates/router/src/routes/metrics.rs b/crates/router/src/routes/metrics.rs index e8aeef3e406..defb73fa138 100644 --- a/crates/router/src/routes/metrics.rs +++ b/crates/router/src/routes/metrics.rs @@ -140,3 +140,6 @@ histogram_metric_f64!(CHECK_NETWORK_TOKEN_STATUS_TIME, GLOBAL_METER); // A counter to indicate allowed payment method types mismatch counter_metric!(PAYMENT_METHOD_TYPES_MISCONFIGURATION_METRIC, GLOBAL_METER); + +// AI chat metric to track number of chat request +counter_metric!(CHAT_REQUEST_COUNT, GLOBAL_METER);	2025-07-17T12:23:04Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description Propagation request-id to chat service for consistency. Propagate chat session id as well in request Add count metric for chat api ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context Closes #8679 ## How did you test it? Tested locally, x-request-id is getting populated correctly ``` curl --location 'http://localhost:8080/chat/ai/data' \ --header 'x-feature: integ-custom' \ --header 'x-chat-session-id: chat-ssdfasdsf' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer JWT' \ --data '{ "message": "success rate" }' ``` <img width="1316" height="855" alt="image" src="https://github.com/user-attachments/assets/4b99e80c-5906-472d-a017-d9c5c8257d7a" /> AI service logs <img width="1110" height="398" alt="image" src="https://github.com/user-attachments/assets/427f41be-ee48-4e94-b5b8-d6141b6f6400" /> <img width="1092" height="249" alt="image" src="https://github.com/user-attachments/assets/da479ff3-65db-4cec-8af7-a947ab807954" /> ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	260df2836cea8f9aa7448888d3b61e942eda313b	260df2836cea8f9aa7448888d3b61e942eda313b
juspay/hyperswitch	juspay__hyperswitch-8687	Bug: [BUG] refused payment responses missing error codes and messages for Access Worldpay ### Bug Description Worldpay refused payment responses are not populating error codes and error messages due to incorrect deserialization. The `WorldpayPaymentResponseFields` enum incorrectly deserializes refused responses as `AuthorizedResponse` instead of `RefusedResponse`, causing `refusalCode` and `refusalDescription` fields to be silently ignored. ### Expected Behavior Refused payment responses should deserialize as `RefusedResponse` and populate error details in the final response. ### Actual Behavior Refused payment responses deserialize as `AuthorizedResponse`, causing error codes and messages to be missing from the client response. ### Steps To Reproduce 1. Process a Worldpay payment that will be refused (e.g., insufficient funds) 2. Check the deserialized response structure in logs 3. Observe that it matches `AuthorizedResponse` instead of `RefusedResponse` 4. Note that `refusalDescription` and `refusalCode` are missing from the final response ### Context For The Bug Root Cause: Enum variant ordering in `WorldpayPaymentResponseFields` causes `#[serde(untagged)]` to match `AuthorizedResponse` first since both response types share common fields. Sample Worldpay Response: ```json { "outcome": "refused", "refusalDescription": "Insufficient funds", "refusalCode": "51", "paymentInstrument": {...}, "riskFactors": [...] } ``` Current Enum Order: ```rust pub enum WorldpayPaymentResponseFields { AuthorizedResponse(Box<AuthorizedResponse>), // Matches first DDCResponse(DDCResponse), FraudHighRisk(FraudHighRiskResponse), RefusedResponse(RefusedResponse), // Never reached ThreeDsChallenged(ThreeDsChallengedResponse), } ``` Fix: Reorder enum variants to put `RefusedResponse` first and add `#[serde(deny_unknown_fields)]` to `AuthorizedResponse`. ### Environment Are you using hyperswitch hosted version? Yes ### Have you spent some time checking if this bug has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? Yes, I am willing to submit a PR!	diff --git a/crates/hyperswitch_connectors/src/connectors/worldpay/response.rs b/crates/hyperswitch_connectors/src/connectors/worldpay/response.rs index e7fa40c7114..b1a3a86a04f 100644 --- a/crates/hyperswitch_connectors/src/connectors/worldpay/response.rs +++ b/crates/hyperswitch_connectors/src/connectors/worldpay/response.rs @@ -18,11 +18,11 @@ pub struct WorldpayPaymentsResponse { #[derive(Clone, Debug, PartialEq, Serialize, Deserialize)] #[serde(untagged)] pub enum WorldpayPaymentResponseFields { - AuthorizedResponse(Box<AuthorizedResponse>), - DDCResponse(DDCResponse), - FraudHighRisk(FraudHighRiskResponse), RefusedResponse(RefusedResponse), + DDCResponse(DDCResponse), ThreeDsChallenged(ThreeDsChallengedResponse), + FraudHighRisk(FraudHighRiskResponse), + AuthorizedResponse(Box<AuthorizedResponse>), } #[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]	2025-07-18T09:30:09Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [x] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> Fixes Worldpay refused payment responses not populating error codes and messages. Changes in this PR - Reorder `WorldpayPaymentResponseFields` enum variants to prioritize `RefusedResponse` over `AuthorizedResponse` ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. --> Fixes enum deserialization issue where refused responses were incorrectly matched as `AuthorizedResponse` due to variant ordering, causing `refusalCode` and `refusalDescription` fields to be silently ignored. ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> Things to be verified - Failed transactions - Successfull transactions - Across 3DS and Non3DS payments Acceptance criteria - Failed transactions should ALWAYS have error code and error message - Existing behavior should not be impacted <details> <summary>1. Create a refused 3DS payment</summary> cURL curl --location --request POST 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_OcigA2cQZxBX9COYGBfHgAWOZUukSoY32EnWQfuFtRPpW5lmWhJSsxtQxmvFOr3K' \ --data-raw '{"amount":4500,"currency":"EUR","confirm":true,"profile_id":"pro_lIwQy04ZJdIxAZHNj6cf","capture_method":"automatic","authentication_type":"three_ds","setup_future_usage":"off_session","customer_id":"cus_HMf1El4VyvUOTQcyPabO","email":"[email protected]","return_url":"https://google.com","payment_method":"card","payment_method_data":{"card":{"card_number":"4000000000002503","card_exp_month":"12","card_exp_year":"49","card_holder_name":"SOFT_DECLINED","card_cvc":"123"}},"billing":{"address":{"line1":"1467","line2":"Harrison Street","line3":"Harrison Street","city":"San Fransico","zip":"94122","country":"SG","first_name":"joseph","last_name":"Doe"},"phone":{"number":"8056594427","country_code":"+91"},"email":"[email protected]"},"metadata":{"udf1":"value1","new_customer":"true","login_date":"2019-09-10T10:11:12Z"},"browser_info":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36","accept_header":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8","language":"en-US","color_depth":32,"screen_height":1117,"screen_width":1728,"time_zone":-330,"java_enabled":true,"java_script_enabled":true,"ip_address":"127.0.0.1"},"customer_acceptance":{"acceptance_type":"online","accepted_at":"1963-05-03T04:07:52.723Z","online":{"ip_address":"127.0.0.1","user_agent":"amet irure esse"}},"session_expiry":60}' Response {"payment_id":"pay_nf1wozrQrzByP9V4yeoD","merchant_id":"merchant_1752829595","status":"requires_customer_action","amount":4500,"net_amount":4500,"shipping_cost":null,"amount_capturable":4500,"amount_received":null,"connector":"worldpay","client_secret":"pay_nf1wozrQrzByP9V4yeoD_secret_oPWhpyOQDgJxMryKsRGw","created":"2025-07-18T09:23:30.740Z","currency":"EUR","customer_id":"cus_HMf1El4VyvUOTQcyPabO","customer":{"id":"cus_HMf1El4VyvUOTQcyPabO","name":"John Nether","email":"[email protected]","phone":"6168205362","phone_country_code":"+1"},"description":null,"refunds":null,"disputes":null,"mandate_id":null,"mandate_data":null,"setup_future_usage":"on_session","off_session":null,"capture_on":null,"capture_method":"automatic","payment_method":"card","payment_method_data":{"card":{"last4":"2503","card_type":null,"card_network":null,"card_issuer":null,"card_issuing_country":null,"card_isin":"400000","card_extended_bin":null,"card_exp_month":"12","card_exp_year":"49","card_holder_name":"SOFT_DECLINED","payment_checks":null,"authentication_data":null},"billing":null},"payment_token":null,"shipping":null,"billing":{"address":{"city":"San Fransico","country":"SG","line1":"1467","line2":"Harrison Street","line3":"Harrison Street","zip":"94122","state":null,"first_name":"joseph","last_name":"Doe"},"phone":{"number":"8056594427","country_code":"+91"},"email":"[email protected]"},"order_details":null,"email":"[email protected]","name":"John Nether","phone":"6168205362","return_url":"https://google.com/","authentication_type":"three_ds","statement_descriptor_name":null,"statement_descriptor_suffix":null,"next_action":{"type":"redirect_to_url","redirect_to_url":"http://localhost:8080/payments/redirect/pay_nf1wozrQrzByP9V4yeoD/merchant_1752829595/pay_nf1wozrQrzByP9V4yeoD_1"},"cancellation_reason":null,"error_code":null,"error_message":null,"unified_code":null,"unified_message":null,"payment_experience":null,"payment_method_type":null,"connector_label":null,"business_country":null,"business_label":"default","business_sub_label":null,"allowed_payment_method_types":null,"ephemeral_key":{"customer_id":"cus_HMf1El4VyvUOTQcyPabO","created_at":1752830610,"expires":1752834210,"secret":"epk_94ed61cae43c47cfa3812753e04b645a"},"manual_retry_allowed":null,"connector_transaction_id":"eyJrIjoxLCJkIjoiNWwwQkpkeFd4UXA2dUw0b2dHRWlaVzlUUzh0aEhIL0F2WVFJN2ROYnZWNGl3V1R3UXYwb0tLYTdJQm1hY3hQdiJ9_2","frm_message":null,"metadata":{"udf1":"value1","login_date":"2019-09-10T10:11:12Z","new_customer":"true"},"connector_metadata":null,"feature_metadata":null,"reference_id":"06ecb837-d1ff-4baa-b608-18d2e56074f0","payment_link":null,"profile_id":"pro_lIwQy04ZJdIxAZHNj6cf","surcharge_details":null,"attempt_count":1,"merchant_decision":null,"merchant_connector_id":"mca_21oWs6dvHalGcN2EkEzx","incremental_authorization_allowed":null,"authorization_count":null,"incremental_authorizations":null,"external_authentication_details":null,"external_3ds_authentication_attempted":false,"expires_on":"2025-07-18T09:24:30.740Z","fingerprint":null,"browser_info":{"language":"en-US","time_zone":-330,"ip_address":"127.0.0.1","user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36","color_depth":32,"java_enabled":true,"screen_width":1728,"accept_header":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8","screen_height":1117,"java_script_enabled":true},"payment_method_id":null,"payment_method_status":null,"updated":"2025-07-18T09:23:32.148Z","split_payments":null,"frm_metadata":null,"extended_authorization_applied":null,"capture_before":null,"merchant_order_reference_id":null,"order_tax_amount":null,"connector_mandate_id":null,"card_discovery":"manual","force_3ds_challenge":false,"force_3ds_challenge_trigger":false,"issuer_error_code":null,"issuer_error_message":null,"is_iframe_redirection_enabled":null,"whole_connector_response":null} Open and complete the payment Fetch payment cURL curl --location --request GET 'http://localhost:8080/payments/pay_nf1wozrQrzByP9V4yeoD?force_sync=true' \ --header 'Accept: application/json' \ --header 'api-key: dev_OcigA2cQZxBX9COYGBfHgAWOZUukSoY32EnWQfuFtRPpW5lmWhJSsxtQxmvFOr3K' Response {"payment_id":"pay_nf1wozrQrzByP9V4yeoD","merchant_id":"merchant_1752829595","status":"failed","amount":4500,"net_amount":4500,"shipping_cost":null,"amount_capturable":0,"amount_received":null,"connector":"worldpay","client_secret":"pay_nf1wozrQrzByP9V4yeoD_secret_oPWhpyOQDgJxMryKsRGw","created":"2025-07-18T09:23:30.740Z","currency":"EUR","customer_id":"cus_HMf1El4VyvUOTQcyPabO","customer":{"id":"cus_HMf1El4VyvUOTQcyPabO","name":"John Nether","email":"[email protected]","phone":"6168205362","phone_country_code":"+1"},"description":null,"refunds":null,"disputes":null,"mandate_id":null,"mandate_data":null,"setup_future_usage":"on_session","off_session":null,"capture_on":null,"capture_method":"automatic","payment_method":"card","payment_method_data":{"card":{"last4":"2503","card_type":null,"card_network":null,"card_issuer":null,"card_issuing_country":null,"card_isin":"400000","card_extended_bin":null,"card_exp_month":"12","card_exp_year":"49","card_holder_name":"SOFT_DECLINED","payment_checks":null,"authentication_data":null},"billing":null},"payment_token":null,"shipping":null,"billing":{"address":{"city":"San Fransico","country":"SG","line1":"1467","line2":"Harrison Street","line3":"Harrison Street","zip":"94122","state":null,"first_name":"joseph","last_name":"Doe"},"phone":{"number":"8056594427","country_code":"+91"},"email":"[email protected]"},"order_details":null,"email":"[email protected]","name":"John Nether","phone":"6168205362","return_url":"https://google.com/","authentication_type":"three_ds","statement_descriptor_name":null,"statement_descriptor_suffix":null,"next_action":null,"cancellation_reason":null,"error_code":"65","error_message":"Authentication requested","unified_code":"UE_9000","unified_message":"Something went wrong","payment_experience":null,"payment_method_type":null,"connector_label":null,"business_country":null,"business_label":"default","business_sub_label":null,"allowed_payment_method_types":null,"ephemeral_key":null,"manual_retry_allowed":true,"connector_transaction_id":"5d0040f1-bb19-4ac5-8baa-9f083ce53cb0","frm_message":null,"metadata":{"udf1":"value1","login_date":"2019-09-10T10:11:12Z","new_customer":"true"},"connector_metadata":null,"feature_metadata":null,"reference_id":"62043e75-b414-4d8e-aa4d-5970a990152b","payment_link":null,"profile_id":"pro_lIwQy04ZJdIxAZHNj6cf","surcharge_details":null,"attempt_count":1,"merchant_decision":null,"merchant_connector_id":"mca_21oWs6dvHalGcN2EkEzx","incremental_authorization_allowed":false,"authorization_count":null,"incremental_authorizations":null,"external_authentication_details":null,"external_3ds_authentication_attempted":false,"expires_on":"2025-07-18T09:24:30.740Z","fingerprint":null,"browser_info":{"language":"en-US","time_zone":-330,"ip_address":"127.0.0.1","user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36","color_depth":32,"java_enabled":true,"screen_width":1728,"accept_header":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8","screen_height":1117,"java_script_enabled":true},"payment_method_id":"pm_us4PtNRsIDqN5ABOVj7J","payment_method_status":"inactive","updated":"2025-07-18T09:24:31.424Z","split_payments":null,"frm_metadata":null,"extended_authorization_applied":null,"capture_before":null,"merchant_order_reference_id":null,"order_tax_amount":null,"connector_mandate_id":null,"card_discovery":"manual","force_3ds_challenge":false,"force_3ds_challenge_trigger":false,"issuer_error_code":"65","issuer_error_message":"Authentication requested","is_iframe_redirection_enabled":null,"whole_connector_response":null} </details> <details> <summary>2. Create a refused Non3DS payment</summary> cURL curl --location --request POST 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_OcigA2cQZxBX9COYGBfHgAWOZUukSoY32EnWQfuFtRPpW5lmWhJSsxtQxmvFOr3K' \ --data-raw '{"amount":4500,"currency":"EUR","confirm":true,"profile_id":"pro_lIwQy04ZJdIxAZHNj6cf","capture_method":"automatic","authentication_type":"no_three_ds","setup_future_usage":"off_session","customer_id":"cus_HMf1El4VyvUOTQcyPabO","email":"[email protected]","return_url":"https://google.com","payment_method":"card","payment_method_data":{"card":{"card_number":"4000000000002503","card_exp_month":"12","card_exp_year":"49","card_holder_name":"SOFT_DECLINED","card_cvc":"123"}},"billing":{"address":{"line1":"1467","line2":"Harrison Street","line3":"Harrison Street","city":"San Fransico","zip":"94122","country":"SG","first_name":"joseph","last_name":"Doe"},"phone":{"number":"8056594427","country_code":"+91"},"email":"[email protected]"},"metadata":{"udf1":"value1","new_customer":"true","login_date":"2019-09-10T10:11:12Z"},"browser_info":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36","accept_header":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8","language":"en-US","color_depth":32,"screen_height":1117,"screen_width":1728,"time_zone":-330,"java_enabled":true,"java_script_enabled":true,"ip_address":"127.0.0.1"},"customer_acceptance":{"acceptance_type":"online","accepted_at":"1963-05-03T04:07:52.723Z","online":{"ip_address":"127.0.0.1","user_agent":"amet irure esse"}},"session_expiry":60}' Response {"payment_id":"pay_7xBftAitD04sY2GZJ8Z2","merchant_id":"merchant_1752829595","status":"failed","amount":4500,"net_amount":4500,"shipping_cost":null,"amount_capturable":0,"amount_received":null,"connector":"worldpay","client_secret":"pay_7xBftAitD04sY2GZJ8Z2_secret_hKtavE5ciTrVajUHJjZc","created":"2025-07-18T09:25:11.617Z","currency":"EUR","customer_id":"cus_HMf1El4VyvUOTQcyPabO","customer":{"id":"cus_HMf1El4VyvUOTQcyPabO","name":"John Nether","email":"[email protected]","phone":"6168205362","phone_country_code":"+1"},"description":null,"refunds":null,"disputes":null,"mandate_id":null,"mandate_data":null,"setup_future_usage":"off_session","off_session":null,"capture_on":null,"capture_method":"automatic","payment_method":"card","payment_method_data":{"card":{"last4":"2503","card_type":null,"card_network":null,"card_issuer":null,"card_issuing_country":null,"card_isin":"400000","card_extended_bin":null,"card_exp_month":"12","card_exp_year":"49","card_holder_name":"SOFT_DECLINED","payment_checks":null,"authentication_data":null},"billing":null},"payment_token":null,"shipping":null,"billing":{"address":{"city":"San Fransico","country":"SG","line1":"1467","line2":"Harrison Street","line3":"Harrison Street","zip":"94122","state":null,"first_name":"joseph","last_name":"Doe"},"phone":{"number":"8056594427","country_code":"+91"},"email":"[email protected]"},"order_details":null,"email":"[email protected]","name":"John Nether","phone":"6168205362","return_url":"https://google.com/","authentication_type":"no_three_ds","statement_descriptor_name":null,"statement_descriptor_suffix":null,"next_action":null,"cancellation_reason":null,"error_code":"65","error_message":"Authentication requested","unified_code":"UE_9000","unified_message":"Something went wrong","payment_experience":null,"payment_method_type":null,"connector_label":null,"business_country":null,"business_label":"default","business_sub_label":null,"allowed_payment_method_types":null,"ephemeral_key":{"customer_id":"cus_HMf1El4VyvUOTQcyPabO","created_at":1752830711,"expires":1752834311,"secret":"epk_89925864b5a44ace803a9c3bfd9d3a5a"},"manual_retry_allowed":true,"connector_transaction_id":"6ec4e6b4-b2cc-4816-b8de-d682c3799560","frm_message":null,"metadata":{"udf1":"value1","login_date":"2019-09-10T10:11:12Z","new_customer":"true"},"connector_metadata":null,"feature_metadata":null,"reference_id":null,"payment_link":null,"profile_id":"pro_lIwQy04ZJdIxAZHNj6cf","surcharge_details":null,"attempt_count":1,"merchant_decision":null,"merchant_connector_id":"mca_21oWs6dvHalGcN2EkEzx","incremental_authorization_allowed":false,"authorization_count":null,"incremental_authorizations":null,"external_authentication_details":null,"external_3ds_authentication_attempted":false,"expires_on":"2025-07-18T09:26:11.617Z","fingerprint":null,"browser_info":{"language":"en-US","time_zone":-330,"ip_address":"127.0.0.1","user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36","color_depth":32,"java_enabled":true,"screen_width":1728,"accept_header":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8","screen_height":1117,"java_script_enabled":true},"payment_method_id":null,"payment_method_status":null,"updated":"2025-07-18T09:25:12.302Z","split_payments":null,"frm_metadata":null,"extended_authorization_applied":null,"capture_before":null,"merchant_order_reference_id":null,"order_tax_amount":null,"connector_mandate_id":null,"card_discovery":"manual","force_3ds_challenge":false,"force_3ds_challenge_trigger":false,"issuer_error_code":"65","issuer_error_message":"Authentication requested","is_iframe_redirection_enabled":null,"whole_connector_response":null} </details> <details> <summary>3. Create a successful Non3DS payment</summary> cURL curl --location --request POST 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_OcigA2cQZxBX9COYGBfHgAWOZUukSoY32EnWQfuFtRPpW5lmWhJSsxtQxmvFOr3K' \ --data-raw '{"amount":4500,"currency":"EUR","confirm":true,"profile_id":"pro_lIwQy04ZJdIxAZHNj6cf","capture_method":"automatic","authentication_type":"no_three_ds","setup_future_usage":"off_session","customer_id":"cus_HMf1El4VyvUOTQcyPabO","email":"[email protected]","return_url":"https://google.com","payment_method":"card","payment_method_data":{"card":{"card_number":"4000000000002503","card_exp_month":"12","card_exp_year":"49","card_cvc":"123"}},"billing":{"address":{"line1":"1467","line2":"Harrison Street","line3":"Harrison Street","city":"San Fransico","zip":"94122","country":"SG","first_name":"joseph","last_name":"Doe"},"phone":{"number":"8056594427","country_code":"+91"},"email":"[email protected]"},"metadata":{"udf1":"value1","new_customer":"true","login_date":"2019-09-10T10:11:12Z"},"browser_info":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36","accept_header":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8","language":"en-US","color_depth":32,"screen_height":1117,"screen_width":1728,"time_zone":-330,"java_enabled":true,"java_script_enabled":true,"ip_address":"127.0.0.1"},"customer_acceptance":{"acceptance_type":"online","accepted_at":"1963-05-03T04:07:52.723Z","online":{"ip_address":"127.0.0.1","user_agent":"amet irure esse"}},"session_expiry":60}' Response {"payment_id":"pay_fvSgG7vbmiancVdM7egW","merchant_id":"merchant_1752829595","status":"succeeded","amount":4500,"net_amount":4500,"shipping_cost":null,"amount_capturable":0,"amount_received":4500,"connector":"worldpay","client_secret":"pay_fvSgG7vbmiancVdM7egW_secret_Tf1f2y1DQin8y7nQHp7y","created":"2025-07-18T09:27:05.084Z","currency":"EUR","customer_id":"cus_HMf1El4VyvUOTQcyPabO","customer":{"id":"cus_HMf1El4VyvUOTQcyPabO","name":"John Nether","email":"[email protected]","phone":"6168205362","phone_country_code":"+1"},"description":null,"refunds":null,"disputes":null,"mandate_id":null,"mandate_data":null,"setup_future_usage":"on_session","off_session":null,"capture_on":null,"capture_method":"automatic","payment_method":"card","payment_method_data":{"card":{"last4":"2503","card_type":null,"card_network":null,"card_issuer":null,"card_issuing_country":null,"card_isin":"400000","card_extended_bin":null,"card_exp_month":"12","card_exp_year":"49","card_holder_name":null,"payment_checks":null,"authentication_data":null},"billing":null},"payment_token":null,"shipping":null,"billing":{"address":{"city":"San Fransico","country":"SG","line1":"1467","line2":"Harrison Street","line3":"Harrison Street","zip":"94122","state":null,"first_name":"joseph","last_name":"Doe"},"phone":{"number":"8056594427","country_code":"+91"},"email":"[email protected]"},"order_details":null,"email":"[email protected]","name":"John Nether","phone":"6168205362","return_url":"https://google.com/","authentication_type":"no_three_ds","statement_descriptor_name":null,"statement_descriptor_suffix":null,"next_action":null,"cancellation_reason":null,"error_code":null,"error_message":null,"unified_code":null,"unified_message":null,"payment_experience":null,"payment_method_type":null,"connector_label":null,"business_country":null,"business_label":"default","business_sub_label":null,"allowed_payment_method_types":null,"ephemeral_key":{"customer_id":"cus_HMf1El4VyvUOTQcyPabO","created_at":1752830825,"expires":1752834425,"secret":"epk_cb4c1f4042ab432fa0cc74d74ad1bf7f"},"manual_retry_allowed":false,"connector_transaction_id":"eyJrIjoiazNhYjYzMiIsImxpbmtWZXJzaW9uIjoiNi4wLjAifQ==.sN:g8wd64bwkbrp0md+bPxcanBnk2zLdsIqSa1pR99HBj426bdlJXCgTskLhNY5Ml0rXtEPNSyl2cbsnj4b2DZwiqL3HuQDxN:neVn+zbpclW4Z+fnZKMutoUGX3m1:mly6gHHs10vDfRKiqHMymO64+yqY47+sAF1kkNrL23Bs3QiAabaRzXyjYDjJ+U38V81VQ0:KjdVX14V+Q12mM8Z5iKyQs9iW3YxEeAqFJXOYrW66yFNGsWi87tzkRENLR8ix3NBfHPU2KlzlyTrmR0mwasA4zRNlfY:bG7Aaa:GaUgn8jvCNhmdUlN6uDEfAu3+Gpx8cadeYO0VLI6Wl9IlMW1jd8Xy+vVmj3Q+75eENcq03E2danxlr+Vv+81CEF","frm_message":null,"metadata":{"udf1":"value1","login_date":"2019-09-10T10:11:12Z","new_customer":"true"},"connector_metadata":null,"feature_metadata":null,"reference_id":"0d52ed33-52a5-4180-a8c0-a594dfce4250","payment_link":null,"profile_id":"pro_lIwQy04ZJdIxAZHNj6cf","surcharge_details":null,"attempt_count":1,"merchant_decision":null,"merchant_connector_id":"mca_21oWs6dvHalGcN2EkEzx","incremental_authorization_allowed":null,"authorization_count":null,"incremental_authorizations":null,"external_authentication_details":null,"external_3ds_authentication_attempted":false,"expires_on":"2025-07-18T09:28:05.084Z","fingerprint":null,"browser_info":{"language":"en-US","time_zone":-330,"ip_address":"127.0.0.1","user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36","color_depth":32,"java_enabled":true,"screen_width":1728,"accept_header":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8","screen_height":1117,"java_script_enabled":true},"payment_method_id":null,"payment_method_status":null,"updated":"2025-07-18T09:27:07.450Z","split_payments":null,"frm_metadata":null,"extended_authorization_applied":null,"capture_before":null,"merchant_order_reference_id":null,"order_tax_amount":null,"connector_mandate_id":null,"card_discovery":"manual","force_3ds_challenge":false,"force_3ds_challenge_trigger":false,"issuer_error_code":null,"issuer_error_message":null,"is_iframe_redirection_enabled":null,"whole_connector_response":null} </details> <details> <summary>4. Create a successful 3DS payment</summary> cURL curl --location --request POST 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_OcigA2cQZxBX9COYGBfHgAWOZUukSoY32EnWQfuFtRPpW5lmWhJSsxtQxmvFOr3K' \ --data-raw '{"amount":4500,"currency":"EUR","confirm":true,"profile_id":"pro_lIwQy04ZJdIxAZHNj6cf","capture_method":"automatic","authentication_type":"three_ds","setup_future_usage":"off_session","customer_id":"cus_HMf1El4VyvUOTQcyPabO","email":"[email protected]","return_url":"https://google.com","payment_method":"card","payment_method_data":{"card":{"card_number":"4000000000002503","card_exp_month":"12","card_exp_year":"49","card_cvc":"123"}},"billing":{"address":{"line1":"1467","line2":"Harrison Street","line3":"Harrison Street","city":"San Fransico","zip":"94122","country":"SG","first_name":"joseph","last_name":"Doe"},"phone":{"number":"8056594427","country_code":"+91"},"email":"[email protected]"},"metadata":{"udf1":"value1","new_customer":"true","login_date":"2019-09-10T10:11:12Z"},"browser_info":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36","accept_header":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8","language":"en-US","color_depth":32,"screen_height":1117,"screen_width":1728,"time_zone":-330,"java_enabled":true,"java_script_enabled":true,"ip_address":"127.0.0.1"},"customer_acceptance":{"acceptance_type":"online","accepted_at":"1963-05-03T04:07:52.723Z","online":{"ip_address":"127.0.0.1","user_agent":"amet irure esse"}},"session_expiry":60}' Response {"payment_id":"pay_B0btcvBLNpPhJ1s7NEGc","merchant_id":"merchant_1752829595","status":"requires_customer_action","amount":4500,"net_amount":4500,"shipping_cost":null,"amount_capturable":4500,"amount_received":null,"connector":"worldpay","client_secret":"pay_B0btcvBLNpPhJ1s7NEGc_secret_FoMuFj3e5H5vxBtXLOJ6","created":"2025-07-18T09:27:55.106Z","currency":"EUR","customer_id":"cus_HMf1El4VyvUOTQcyPabO","customer":{"id":"cus_HMf1El4VyvUOTQcyPabO","name":"John Nether","email":"[email protected]","phone":"6168205362","phone_country_code":"+1"},"description":null,"refunds":null,"disputes":null,"mandate_id":null,"mandate_data":null,"setup_future_usage":"on_session","off_session":null,"capture_on":null,"capture_method":"automatic","payment_method":"card","payment_method_data":{"card":{"last4":"2503","card_type":null,"card_network":null,"card_issuer":null,"card_issuing_country":null,"card_isin":"400000","card_extended_bin":null,"card_exp_month":"12","card_exp_year":"49","card_holder_name":null,"payment_checks":null,"authentication_data":null},"billing":null},"payment_token":null,"shipping":null,"billing":{"address":{"city":"San Fransico","country":"SG","line1":"1467","line2":"Harrison Street","line3":"Harrison Street","zip":"94122","state":null,"first_name":"joseph","last_name":"Doe"},"phone":{"number":"8056594427","country_code":"+91"},"email":"[email protected]"},"order_details":null,"email":"[email protected]","name":"John Nether","phone":"6168205362","return_url":"https://google.com/","authentication_type":"three_ds","statement_descriptor_name":null,"statement_descriptor_suffix":null,"next_action":{"type":"redirect_to_url","redirect_to_url":"http://localhost:8080/payments/redirect/pay_B0btcvBLNpPhJ1s7NEGc/merchant_1752829595/pay_B0btcvBLNpPhJ1s7NEGc_1"},"cancellation_reason":null,"error_code":null,"error_message":null,"unified_code":null,"unified_message":null,"payment_experience":null,"payment_method_type":null,"connector_label":null,"business_country":null,"business_label":"default","business_sub_label":null,"allowed_payment_method_types":null,"ephemeral_key":{"customer_id":"cus_HMf1El4VyvUOTQcyPabO","created_at":1752830875,"expires":1752834475,"secret":"epk_0ca1d0b0a4324a30b287522647a4e1e7"},"manual_retry_allowed":null,"connector_transaction_id":"eyJrIjoxLCJkIjoiMjVnYzlzNUVaWU94M1hPaFYvbXUwT21hRmZjMFNmZWQvR0pnRGxaWU5vc2l3V1R3UXYwb0tLYTdJQm1hY3hQdiJ9_2","frm_message":null,"metadata":{"udf1":"value1","login_date":"2019-09-10T10:11:12Z","new_customer":"true"},"connector_metadata":null,"feature_metadata":null,"reference_id":"187b8a5d-10e8-4711-8f61-321d497174c5","payment_link":null,"profile_id":"pro_lIwQy04ZJdIxAZHNj6cf","surcharge_details":null,"attempt_count":1,"merchant_decision":null,"merchant_connector_id":"mca_21oWs6dvHalGcN2EkEzx","incremental_authorization_allowed":null,"authorization_count":null,"incremental_authorizations":null,"external_authentication_details":null,"external_3ds_authentication_attempted":false,"expires_on":"2025-07-18T09:28:55.106Z","fingerprint":null,"browser_info":{"language":"en-US","time_zone":-330,"ip_address":"127.0.0.1","user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36","color_depth":32,"java_enabled":true,"screen_width":1728,"accept_header":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8","screen_height":1117,"java_script_enabled":true},"payment_method_id":null,"payment_method_status":null,"updated":"2025-07-18T09:27:55.619Z","split_payments":null,"frm_metadata":null,"extended_authorization_applied":null,"capture_before":null,"merchant_order_reference_id":null,"order_tax_amount":null,"connector_mandate_id":null,"card_discovery":"manual","force_3ds_challenge":false,"force_3ds_challenge_trigger":false,"issuer_error_code":null,"issuer_error_message":null,"is_iframe_redirection_enabled":null,"whole_connector_response":null} Open and complete payment Fetch payment cURL curl --location --request GET 'http://localhost:8080/payments/pay_B0btcvBLNpPhJ1s7NEGc?force_sync=true' \ --header 'Accept: application/json' \ --header 'api-key: dev_OcigA2cQZxBX9COYGBfHgAWOZUukSoY32EnWQfuFtRPpW5lmWhJSsxtQxmvFOr3K' Response {"payment_id":"pay_B0btcvBLNpPhJ1s7NEGc","merchant_id":"merchant_1752829595","status":"succeeded","amount":4500,"net_amount":4500,"shipping_cost":null,"amount_capturable":0,"amount_received":4500,"connector":"worldpay","client_secret":"pay_B0btcvBLNpPhJ1s7NEGc_secret_FoMuFj3e5H5vxBtXLOJ6","created":"2025-07-18T09:27:55.106Z","currency":"EUR","customer_id":"cus_HMf1El4VyvUOTQcyPabO","customer":{"id":"cus_HMf1El4VyvUOTQcyPabO","name":"John Nether","email":"[email protected]","phone":"6168205362","phone_country_code":"+1"},"description":null,"refunds":null,"disputes":null,"mandate_id":null,"mandate_data":null,"setup_future_usage":"on_session","off_session":null,"capture_on":null,"capture_method":"automatic","payment_method":"card","payment_method_data":{"card":{"last4":"2503","card_type":null,"card_network":null,"card_issuer":null,"card_issuing_country":null,"card_isin":"400000","card_extended_bin":null,"card_exp_month":"12","card_exp_year":"49","card_holder_name":null,"payment_checks":null,"authentication_data":null},"billing":null},"payment_token":null,"shipping":null,"billing":{"address":{"city":"San Fransico","country":"SG","line1":"1467","line2":"Harrison Street","line3":"Harrison Street","zip":"94122","state":null,"first_name":"joseph","last_name":"Doe"},"phone":{"number":"8056594427","country_code":"+91"},"email":"[email protected]"},"order_details":null,"email":"[email protected]","name":"John Nether","phone":"6168205362","return_url":"https://google.com/","authentication_type":"three_ds","statement_descriptor_name":null,"statement_descriptor_suffix":null,"next_action":null,"cancellation_reason":null,"error_code":null,"error_message":null,"unified_code":null,"unified_message":null,"payment_experience":null,"payment_method_type":null,"connector_label":null,"business_country":null,"business_label":"default","business_sub_label":null,"allowed_payment_method_types":null,"ephemeral_key":null,"manual_retry_allowed":false,"connector_transaction_id":"3749d357-0130-498e-8c74-6a8e2069fa55","frm_message":null,"metadata":{"udf1":"value1","login_date":"2019-09-10T10:11:12Z","new_customer":"true"},"connector_metadata":null,"feature_metadata":null,"reference_id":"3749d357-0130-498e-8c74-6a8e2069fa55","payment_link":null,"profile_id":"pro_lIwQy04ZJdIxAZHNj6cf","surcharge_details":null,"attempt_count":1,"merchant_decision":null,"merchant_connector_id":"mca_21oWs6dvHalGcN2EkEzx","incremental_authorization_allowed":null,"authorization_count":null,"incremental_authorizations":null,"external_authentication_details":null,"external_3ds_authentication_attempted":false,"expires_on":"2025-07-18T09:28:55.106Z","fingerprint":null,"browser_info":{"language":"en-US","time_zone":-330,"ip_address":"127.0.0.1","user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36","color_depth":32,"java_enabled":true,"screen_width":1728,"accept_header":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8","screen_height":1117,"java_script_enabled":true},"payment_method_id":"pm_fu8PQqH8zNwUxq5cyixG","payment_method_status":"active","updated":"2025-07-18T09:28:08.906Z","split_payments":null,"frm_metadata":null,"extended_authorization_applied":null,"capture_before":null,"merchant_order_reference_id":null,"order_tax_amount":null,"connector_mandate_id":null,"card_discovery":"manual","force_3ds_challenge":false,"force_3ds_challenge_trigger":false,"issuer_error_code":null,"issuer_error_message":null,"is_iframe_redirection_enabled":null,"whole_connector_response":null} </details> ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	126018e217bfbd8bdd44043ace8a815046193818	126018e217bfbd8bdd44043ace8a815046193818
juspay/hyperswitch	juspay__hyperswitch-8682	Bug: refactor(payments): Fetch payment method details n PaymentListAttempt api Need to fetch payment method information for attempts in attempt list api	diff --git a/api-reference/v1/openapi_spec_v1.json b/api-reference/v1/openapi_spec_v1.json index de49d53ada8..36a2896008b 100644 --- a/api-reference/v1/openapi_spec_v1.json +++ b/api-reference/v1/openapi_spec_v1.json @@ -11089,6 +11089,7 @@ "checkout", "coinbase", "coingate", + "custombilling", "cryptopay", "ctp_mastercard", "ctp_visa", @@ -28183,6 +28184,7 @@ "cashtocode", "celero", "chargebee", + "custombilling", "checkout", "coinbase", "coingate", diff --git a/api-reference/v2/openapi_spec_v2.json b/api-reference/v2/openapi_spec_v2.json index 266aa6cec95..671658dc29b 100644 --- a/api-reference/v2/openapi_spec_v2.json +++ b/api-reference/v2/openapi_spec_v2.json @@ -8153,6 +8153,7 @@ "checkout", "coinbase", "coingate", + "custombilling", "cryptopay", "ctp_mastercard", "ctp_visa", @@ -15740,6 +15741,14 @@ } ], "nullable": true + }, + "payment_method_data": { + "allOf": [ + { + "$ref": "#/components/schemas/PaymentMethodDataResponseWithBilling" + } + ], + "nullable": true } } }, @@ -22738,6 +22747,7 @@ "cashtocode", "celero", "chargebee", + "custombilling", "checkout", "coinbase", "coingate", diff --git a/config/docker_compose.toml b/config/docker_compose.toml index 2e37da5728d..faf1d25e3c7 100644 --- a/config/docker_compose.toml +++ b/config/docker_compose.toml @@ -272,6 +272,7 @@ cards = [ "coingate", "cryptopay", "ctp_visa", + "custombilling", "cybersource", "datatrans", "deutschebank", diff --git a/crates/api_models/src/enums.rs b/crates/api_models/src/enums.rs index cad510b26de..ac0cd707350 100644 --- a/crates/api_models/src/enums.rs +++ b/crates/api_models/src/enums.rs @@ -166,6 +166,7 @@ pub enum BillingConnectors { Chargebee, Recurly, Stripebilling, + Custombilling, #[cfg(feature = "dummy_connector")] DummyBillingConnector, } diff --git a/crates/api_models/src/payments.rs b/crates/api_models/src/payments.rs index d1e04037527..3d91e73406c 100644 --- a/crates/api_models/src/payments.rs +++ b/crates/api_models/src/payments.rs @@ -1629,6 +1629,9 @@ pub struct PaymentAttemptResponse { /// Additional data that might be required by hyperswitch, to enable some specific features. pub feature_metadata: Option<PaymentAttemptFeatureMetadata>, + + /// The payment method information for the payment attempt + pub payment_method_data: Option<PaymentMethodDataResponseWithBilling>, } #[cfg(feature = "v2")] diff --git a/crates/common_enums/src/connector_enums.rs b/crates/common_enums/src/connector_enums.rs index 41563d56f27..cb5195925c5 100644 --- a/crates/common_enums/src/connector_enums.rs +++ b/crates/common_enums/src/connector_enums.rs @@ -77,6 +77,7 @@ pub enum RoutableConnectors { Cashtocode, Celero, Chargebee, + Custombilling, // Checkbook, Checkout, Coinbase, @@ -241,6 +242,7 @@ pub enum Connector { Checkout, Coinbase, Coingate, + Custombilling, Cryptopay, CtpMastercard, CtpVisa, @@ -428,6 +430,7 @@ impl Connector { \| Self::Coinbase \| Self::Coingate \| Self::Cryptopay + \| Self::Custombilling \| Self::Deutschebank \| Self::Digitalvirgo \| Self::Dlocal @@ -589,6 +592,7 @@ impl From<RoutableConnectors> for Connector { RoutableConnectors::Cashtocode => Self::Cashtocode, RoutableConnectors::Celero => Self::Celero, RoutableConnectors::Chargebee => Self::Chargebee, + RoutableConnectors::Custombilling => Self::Custombilling, // RoutableConnectors::Checkbook => Self::Checkbook, RoutableConnectors::Checkout => Self::Checkout, RoutableConnectors::Coinbase => Self::Coinbase, @@ -717,6 +721,7 @@ impl TryFrom<Connector> for RoutableConnectors { Connector::Coinbase => Ok(Self::Coinbase), Connector::Coingate => Ok(Self::Coingate), Connector::Cryptopay => Ok(Self::Cryptopay), + Connector::Custombilling => Ok(Self::Custombilling), Connector::Cybersource => Ok(Self::Cybersource), Connector::Datatrans => Ok(Self::Datatrans), Connector::Deutschebank => Ok(Self::Deutschebank), diff --git a/crates/connector_configs/src/connector.rs b/crates/connector_configs/src/connector.rs index f69efb673bc..fdc85a1fbc7 100644 --- a/crates/connector_configs/src/connector.rs +++ b/crates/connector_configs/src/connector.rs @@ -194,6 +194,7 @@ pub struct ConnectorConfig { pub cashtocode: Option<ConnectorTomlConfig>, pub celero: Option<ConnectorTomlConfig>, pub chargebee: Option<ConnectorTomlConfig>, + pub custombilling: Option<ConnectorTomlConfig>, pub checkbook: Option<ConnectorTomlConfig>, pub checkout: Option<ConnectorTomlConfig>, pub coinbase: Option<ConnectorTomlConfig>, @@ -393,6 +394,7 @@ impl ConnectorConfig { Connector::Coingate => Ok(connector_data.coingate), Connector::Cryptopay => Ok(connector_data.cryptopay), Connector::CtpVisa => Ok(connector_data.ctp_visa), + Connector::Custombilling => Ok(connector_data.custombilling), Connector::Cybersource => Ok(connector_data.cybersource), #[cfg(feature = "dummy_connector")] Connector::DummyBillingConnector => Ok(connector_data.dummy_connector), diff --git a/crates/hyperswitch_connectors/src/connectors.rs b/crates/hyperswitch_connectors/src/connectors.rs index f560a84cd8d..6815f288d0c 100644 --- a/crates/hyperswitch_connectors/src/connectors.rs +++ b/crates/hyperswitch_connectors/src/connectors.rs @@ -26,6 +26,7 @@ pub mod coinbase; pub mod coingate; pub mod cryptopay; pub mod ctp_mastercard; +pub mod custombilling; pub mod cybersource; pub mod datatrans; pub mod deutschebank; @@ -124,11 +125,11 @@ pub use self::{ blackhawknetwork::Blackhawknetwork, bluesnap::Bluesnap, boku::Boku, braintree::Braintree, cashtocode::Cashtocode, celero::Celero, chargebee::Chargebee, checkbook::Checkbook, checkout::Checkout, coinbase::Coinbase, coingate::Coingate, cryptopay::Cryptopay, - ctp_mastercard::CtpMastercard, cybersource::Cybersource, datatrans::Datatrans, - deutschebank::Deutschebank, digitalvirgo::Digitalvirgo, dlocal::Dlocal, dwolla::Dwolla, - ebanx::Ebanx, elavon::Elavon, facilitapay::Facilitapay, fiserv::Fiserv, fiservemea::Fiservemea, - fiuu::Fiuu, forte::Forte, getnet::Getnet, globalpay::Globalpay, globepay::Globepay, - gocardless::Gocardless, gpayments::Gpayments, helcim::Helcim, hipay::Hipay, + ctp_mastercard::CtpMastercard, custombilling::Custombilling, cybersource::Cybersource, + datatrans::Datatrans, deutschebank::Deutschebank, digitalvirgo::Digitalvirgo, dlocal::Dlocal, + dwolla::Dwolla, ebanx::Ebanx, elavon::Elavon, facilitapay::Facilitapay, fiserv::Fiserv, + fiservemea::Fiservemea, fiuu::Fiuu, forte::Forte, getnet::Getnet, globalpay::Globalpay, + globepay::Globepay, gocardless::Gocardless, gpayments::Gpayments, helcim::Helcim, hipay::Hipay, hyperswitch_vault::HyperswitchVault, iatapay::Iatapay, inespay::Inespay, itaubank::Itaubank, jpmorgan::Jpmorgan, juspaythreedsserver::Juspaythreedsserver, klarna::Klarna, mifinity::Mifinity, mollie::Mollie, moneris::Moneris, multisafepay::Multisafepay, diff --git a/crates/hyperswitch_connectors/src/connectors/custombilling.rs b/crates/hyperswitch_connectors/src/connectors/custombilling.rs new file mode 100644 index 00000000000..85904369e50 --- /dev/null +++ b/crates/hyperswitch_connectors/src/connectors/custombilling.rs @@ -0,0 +1,579 @@ +pub mod transformers; + +use common_utils::{ + errors::CustomResult, + ext_traits::BytesExt, + request::{Method, Request, RequestBuilder, RequestContent}, + types::{AmountConvertor, StringMinorUnit, StringMinorUnitForConnector}, +}; +use error_stack::{report, ResultExt}; +use hyperswitch_domain_models::{ + router_data::{AccessToken, ConnectorAuthType, ErrorResponse, RouterData}, + router_flow_types::{ + access_token_auth::AccessTokenAuth, + payments::{Authorize, Capture, PSync, PaymentMethodToken, Session, SetupMandate, Void}, + refunds::{Execute, RSync}, + }, + router_request_types::{ + AccessTokenRequestData, PaymentMethodTokenizationData, PaymentsAuthorizeData, + PaymentsCancelData, PaymentsCaptureData, PaymentsSessionData, PaymentsSyncData, + RefundsData, SetupMandateRequestData, + }, + router_response_types::{PaymentsResponseData, RefundsResponseData}, + types::{ + PaymentsAuthorizeRouterData, PaymentsCaptureRouterData, PaymentsSyncRouterData, + RefundSyncRouterData, RefundsRouterData, + }, +}; +use hyperswitch_interfaces::{ + api::{ + self, ConnectorCommon, ConnectorCommonExt, ConnectorIntegration, ConnectorSpecifications, + ConnectorValidation, + }, + configs::Connectors, + errors, + events::connector_api_logs::ConnectorEvent, + types::{self, Response}, + webhooks, +}; +use masking::{ExposeInterface, Mask}; +use transformers as custombilling; + +use crate::{constants::headers, types::ResponseRouterData, utils}; + +#[derive(Clone)] +pub struct Custombilling { + amount_converter: &'static (dyn AmountConvertor<Output = StringMinorUnit> + Sync), +} + +impl Custombilling { + pub fn new() -> &'static Self { + &Self { + amount_converter: &StringMinorUnitForConnector, + } + } +} + +impl api::Payment for Custombilling {} +impl api::PaymentSession for Custombilling {} +impl api::ConnectorAccessToken for Custombilling {} +impl api::MandateSetup for Custombilling {} +impl api::PaymentAuthorize for Custombilling {} +impl api::PaymentSync for Custombilling {} +impl api::PaymentCapture for Custombilling {} +impl api::PaymentVoid for Custombilling {} +impl api::Refund for Custombilling {} +impl api::RefundExecute for Custombilling {} +impl api::RefundSync for Custombilling {} +impl api::PaymentToken for Custombilling {} + +impl ConnectorIntegration<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData> + for Custombilling +{ + // Not Implemented (R) +} + +impl<Flow, Request, Response> ConnectorCommonExt<Flow, Request, Response> for Custombilling +where + Self: ConnectorIntegration<Flow, Request, Response>, +{ + fn build_headers( + &self, + req: &RouterData<Flow, Request, Response>, + _connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + let mut header = vec![( + headers::CONTENT_TYPE.to_string(), + self.get_content_type().to_string().into(), + )]; + let mut api_key = self.get_auth_header(&req.connector_auth_type)?; + header.append(&mut api_key); + Ok(header) + } +} + +impl ConnectorCommon for Custombilling { + fn id(&self) -> &'static str { + "custombilling" + } + + fn get_currency_unit(&self) -> api::CurrencyUnit { + api::CurrencyUnit::Minor + // TODO! Check connector documentation, on which unit they are processing the currency. + // If the connector accepts amount in lower unit ( i.e cents for USD) then return api::CurrencyUnit::Minor, + // if connector accepts amount in base unit (i.e dollars for USD) then return api::CurrencyUnit::Base + } + + fn common_get_content_type(&self) -> &'static str { + "application/json" + } + + fn base_url<'a>(&self, _connectors: &'a Connectors) -> &'a str { + "" + } + + fn get_auth_header( + &self, + 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(), + )]) + } + + fn build_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + let response: custombilling::CustombillingErrorResponse = res + .response + .parse_struct("CustombillingErrorResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + + Ok(ErrorResponse { + status_code: res.status_code, + code: response.code, + message: response.message, + reason: response.reason, + attempt_status: None, + connector_transaction_id: None, + network_advice_code: None, + network_decline_code: None, + network_error_message: None, + }) + } +} + +impl ConnectorValidation for Custombilling { + //TODO: implement functions when support enabled +} + +impl ConnectorIntegration<Session, PaymentsSessionData, PaymentsResponseData> for Custombilling { + //TODO: implement sessions flow +} + +impl ConnectorIntegration<AccessTokenAuth, AccessTokenRequestData, AccessToken> for Custombilling {} + +impl ConnectorIntegration<SetupMandate, SetupMandateRequestData, PaymentsResponseData> + for Custombilling +{ +} + +impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData> + for Custombilling +{ + fn get_headers( + &self, + req: &PaymentsAuthorizeRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsAuthorizeRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn get_request_body( + &self, + req: &PaymentsAuthorizeRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let amount = utils::convert_amount( + self.amount_converter, + req.request.minor_amount, + req.request.currency, + )?; + + let connector_router_data = custombilling::CustombillingRouterData::from((amount, req)); + let connector_req = + custombilling::CustombillingPaymentsRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &PaymentsAuthorizeRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::PaymentsAuthorizeType::get_url( + self, req, connectors, + )?) + .attach_default_headers() + .headers(types::PaymentsAuthorizeType::get_headers( + self, req, connectors, + )?) + .set_body(types::PaymentsAuthorizeType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsAuthorizeRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsAuthorizeRouterData, errors::ConnectorError> { + let response: custombilling::CustombillingPaymentsResponse = res + .response + .parse_struct("Custombilling PaymentsAuthorizeResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<PSync, PaymentsSyncData, PaymentsResponseData> for Custombilling { + fn get_headers( + &self, + req: &PaymentsSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsSyncRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn build_request( + &self, + req: &PaymentsSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Get) + .url(&types::PaymentsSyncType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::PaymentsSyncType::get_headers(self, req, connectors)?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsSyncRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsSyncRouterData, errors::ConnectorError> { + let response: custombilling::CustombillingPaymentsResponse = res + .response + .parse_struct("custombilling PaymentsSyncResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<Capture, PaymentsCaptureData, PaymentsResponseData> for Custombilling { + fn get_headers( + &self, + req: &PaymentsCaptureRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsCaptureRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn get_request_body( + &self, + _req: &PaymentsCaptureRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_request_body method".to_string()).into()) + } + + fn build_request( + &self, + req: &PaymentsCaptureRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::PaymentsCaptureType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::PaymentsCaptureType::get_headers( + self, req, connectors, + )?) + .set_body(types::PaymentsCaptureType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsCaptureRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsCaptureRouterData, errors::ConnectorError> { + let response: custombilling::CustombillingPaymentsResponse = res + .response + .parse_struct("Custombilling PaymentsCaptureResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<Void, PaymentsCancelData, PaymentsResponseData> for Custombilling {} + +impl ConnectorIntegration<Execute, RefundsData, RefundsResponseData> for Custombilling { + fn get_headers( + &self, + req: &RefundsRouterData<Execute>, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &RefundsRouterData<Execute>, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn get_request_body( + &self, + req: &RefundsRouterData<Execute>, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let refund_amount = utils::convert_amount( + self.amount_converter, + req.request.minor_refund_amount, + req.request.currency, + )?; + + let connector_router_data = + custombilling::CustombillingRouterData::from((refund_amount, req)); + let connector_req = + custombilling::CustombillingRefundRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &RefundsRouterData<Execute>, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + let request = RequestBuilder::new() + .method(Method::Post) + .url(&types::RefundExecuteType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::RefundExecuteType::get_headers( + self, req, connectors, + )?) + .set_body(types::RefundExecuteType::get_request_body( + self, req, connectors, + )?) + .build(); + Ok(Some(request)) + } + + fn handle_response( + &self, + data: &RefundsRouterData<Execute>, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<RefundsRouterData<Execute>, errors::ConnectorError> { + let response: custombilling::RefundResponse = res + .response + .parse_struct("custombilling RefundResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<RSync, RefundsData, RefundsResponseData> for Custombilling { + fn get_headers( + &self, + req: &RefundSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &RefundSyncRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn build_request( + &self, + req: &RefundSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Get) + .url(&types::RefundSyncType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::RefundSyncType::get_headers(self, req, connectors)?) + .set_body(types::RefundSyncType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &RefundSyncRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<RefundSyncRouterData, errors::ConnectorError> { + let response: custombilling::RefundResponse = res + .response + .parse_struct("custombilling RefundSyncResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +#[async_trait::async_trait] +impl webhooks::IncomingWebhook for Custombilling { + fn get_webhook_object_reference_id( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<api_models::webhooks::ObjectReferenceId, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } + + fn get_webhook_event_type( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<api_models::webhooks::IncomingWebhookEvent, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } + + fn get_webhook_resource_object( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<Box<dyn masking::ErasedMaskSerialize>, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } +} + +impl ConnectorSpecifications for Custombilling {} diff --git a/crates/hyperswitch_connectors/src/connectors/custombilling/transformers.rs b/crates/hyperswitch_connectors/src/connectors/custombilling/transformers.rs new file mode 100644 index 00000000000..bb8e8f83e38 --- /dev/null +++ b/crates/hyperswitch_connectors/src/connectors/custombilling/transformers.rs @@ -0,0 +1,232 @@ +use common_enums::enums; +use common_utils::types::StringMinorUnit; +use hyperswitch_domain_models::{ + payment_method_data::PaymentMethodData, + router_data::{ConnectorAuthType, RouterData}, + router_flow_types::refunds::{Execute, RSync}, + router_request_types::ResponseId, + router_response_types::{PaymentsResponseData, RefundsResponseData}, + types::{PaymentsAuthorizeRouterData, RefundsRouterData}, +}; +use hyperswitch_interfaces::errors; +use masking::Secret; +use serde::{Deserialize, Serialize}; + +use crate::{ + types::{RefundsResponseRouterData, ResponseRouterData}, + utils::PaymentsAuthorizeRequestData, +}; + +//TODO: Fill the struct with respective fields +pub struct CustombillingRouterData<T> { + pub amount: StringMinorUnit, // The type of amount that a connector accepts, for example, String, i64, f64, etc. + pub router_data: T, +} + +impl<T> From<(StringMinorUnit, T)> for CustombillingRouterData<T> { + fn from((amount, item): (StringMinorUnit, T)) -> Self { + //Todo : use utils to convert the amount to the type of amount that a connector accepts + Self { + amount, + router_data: item, + } + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Serialize, PartialEq)] +pub struct CustombillingPaymentsRequest { + amount: StringMinorUnit, + card: CustombillingCard, +} + +#[derive(Default, Debug, Serialize, Eq, PartialEq)] +pub struct CustombillingCard { + number: cards::CardNumber, + expiry_month: Secret<String>, + expiry_year: Secret<String>, + cvc: Secret<String>, + complete: bool, +} + +impl TryFrom<&CustombillingRouterData<&PaymentsAuthorizeRouterData>> + for CustombillingPaymentsRequest +{ + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: &CustombillingRouterData<&PaymentsAuthorizeRouterData>, + ) -> Result<Self, Self::Error> { + match item.router_data.request.payment_method_data.clone() { + PaymentMethodData::Card(req_card) => { + let card = CustombillingCard { + number: req_card.card_number, + expiry_month: req_card.card_exp_month, + expiry_year: req_card.card_exp_year, + cvc: req_card.card_cvc, + complete: item.router_data.request.is_auto_capture()?, + }; + Ok(Self { + amount: item.amount.clone(), + card, + }) + } + _ => Err(errors::ConnectorError::NotImplemented("Payment method".to_string()).into()), + } + } +} + +//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)] +#[serde(rename_all = "lowercase")] +pub enum CustombillingPaymentStatus { + Succeeded, + Failed, + #[default] + Processing, +} + +impl From<CustombillingPaymentStatus> for common_enums::AttemptStatus { + fn from(item: CustombillingPaymentStatus) -> Self { + match item { + CustombillingPaymentStatus::Succeeded => Self::Charged, + CustombillingPaymentStatus::Failed => Self::Failure, + CustombillingPaymentStatus::Processing => Self::Authorizing, + } + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] +pub struct CustombillingPaymentsResponse { + status: CustombillingPaymentStatus, + id: String, +} + +impl<F, T> TryFrom<ResponseRouterData<F, CustombillingPaymentsResponse, T, PaymentsResponseData>> + for RouterData<F, T, PaymentsResponseData> +{ + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: ResponseRouterData<F, CustombillingPaymentsResponse, T, PaymentsResponseData>, + ) -> Result<Self, Self::Error> { + Ok(Self { + status: common_enums::AttemptStatus::from(item.response.status), + response: Ok(PaymentsResponseData::TransactionResponse { + resource_id: ResponseId::ConnectorTransactionId(item.response.id), + redirection_data: Box::new(None), + mandate_reference: Box::new(None), + connector_metadata: None, + network_txn_id: None, + connector_response_reference_id: None, + incremental_authorization_allowed: None, + charges: None, + }), + ..item.data + }) + } +} + +//TODO: Fill the struct with respective fields +// REFUND : +// Type definition for RefundRequest +#[derive(Default, Debug, Serialize)] +pub struct CustombillingRefundRequest { + pub amount: StringMinorUnit, +} + +impl<F> TryFrom<&CustombillingRouterData<&RefundsRouterData<F>>> for CustombillingRefundRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: &CustombillingRouterData<&RefundsRouterData<F>>, + ) -> Result<Self, Self::Error> { + Ok(Self { + amount: item.amount.to_owned(), + }) + } +} + +// Type definition for Refund Response + +#[allow(dead_code)] +#[derive(Debug, Serialize, Default, Deserialize, Clone)] +pub enum RefundStatus { + Succeeded, + Failed, + #[default] + Processing, +} + +impl From<RefundStatus> for enums::RefundStatus { + fn from(item: RefundStatus) -> Self { + match item { + RefundStatus::Succeeded => Self::Success, + RefundStatus::Failed => Self::Failure, + RefundStatus::Processing => Self::Pending, + //TODO: Review mapping + } + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Clone, Serialize, Deserialize)] +pub struct RefundResponse { + id: String, + status: RefundStatus, +} + +impl TryFrom<RefundsResponseRouterData<Execute, RefundResponse>> for RefundsRouterData<Execute> { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: RefundsResponseRouterData<Execute, RefundResponse>, + ) -> Result<Self, Self::Error> { + Ok(Self { + response: Ok(RefundsResponseData { + connector_refund_id: item.response.id.to_string(), + refund_status: enums::RefundStatus::from(item.response.status), + }), + ..item.data + }) + } +} + +impl TryFrom<RefundsResponseRouterData<RSync, RefundResponse>> for RefundsRouterData<RSync> { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: RefundsResponseRouterData<RSync, RefundResponse>, + ) -> Result<Self, Self::Error> { + Ok(Self { + response: Ok(RefundsResponseData { + connector_refund_id: item.response.id.to_string(), + refund_status: enums::RefundStatus::from(item.response.status), + }), + ..item.data + }) + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Serialize, Deserialize, PartialEq)] +pub struct CustombillingErrorResponse { + pub status_code: u16, + pub code: String, + pub message: String, + pub reason: Option<String>, +} diff --git a/crates/hyperswitch_connectors/src/default_implementations.rs b/crates/hyperswitch_connectors/src/default_implementations.rs index 2e585b1c09b..16bb27e06b7 100644 --- a/crates/hyperswitch_connectors/src/default_implementations.rs +++ b/crates/hyperswitch_connectors/src/default_implementations.rs @@ -169,6 +169,7 @@ default_imp_for_authorize_session_token!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -298,6 +299,7 @@ default_imp_for_calculate_tax!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -428,6 +430,7 @@ default_imp_for_session_update!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Digitalvirgo, @@ -558,6 +561,7 @@ default_imp_for_post_session_tokens!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Digitalvirgo, @@ -687,6 +691,7 @@ default_imp_for_create_order!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Digitalvirgo, @@ -817,6 +822,7 @@ default_imp_for_update_metadata!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Digitalvirgo, @@ -946,6 +952,7 @@ default_imp_for_complete_authorize!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Datatrans, connectors::Dlocal, connectors::Dwolla, @@ -1060,6 +1067,7 @@ default_imp_for_incremental_authorization!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Datatrans, connectors::Deutschebank, connectors::Digitalvirgo, @@ -1189,6 +1197,7 @@ default_imp_for_create_customer!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -1312,6 +1321,7 @@ default_imp_for_connector_redirect_response!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -1427,6 +1437,7 @@ default_imp_for_pre_processing_steps!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Datatrans, connectors::Deutschebank, connectors::Digitalvirgo, @@ -1547,6 +1558,7 @@ default_imp_for_post_processing_steps!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -1678,6 +1690,7 @@ default_imp_for_approve!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -1810,6 +1823,7 @@ default_imp_for_reject!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -1942,6 +1956,7 @@ default_imp_for_webhook_source_verification!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -2072,6 +2087,7 @@ default_imp_for_accept_dispute!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -2202,6 +2218,7 @@ default_imp_for_submit_evidence!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -2331,6 +2348,7 @@ default_imp_for_defend_dispute!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -2470,6 +2488,7 @@ default_imp_for_file_upload!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -2593,6 +2612,7 @@ default_imp_for_payouts!( connectors::Datatrans, connectors::Coinbase, connectors::Coingate, + connectors::Custombilling, connectors::Deutschebank, connectors::Digitalvirgo, connectors::Dlocal, @@ -2717,6 +2737,7 @@ default_imp_for_payouts_create!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -2846,6 +2867,7 @@ default_imp_for_payouts_retrieve!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -2977,6 +2999,7 @@ default_imp_for_payouts_eligibility!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -3106,6 +3129,7 @@ default_imp_for_payouts_fulfill!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Datatrans, connectors::Deutschebank, connectors::Digitalvirgo, @@ -3232,6 +3256,7 @@ default_imp_for_payouts_cancel!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -3362,6 +3387,7 @@ default_imp_for_payouts_quote!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -3493,6 +3519,7 @@ default_imp_for_payouts_recipient!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -3623,6 +3650,7 @@ default_imp_for_payouts_recipient_account!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -3755,6 +3783,7 @@ default_imp_for_frm_sale!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -3887,6 +3916,7 @@ default_imp_for_frm_checkout!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -4019,6 +4049,7 @@ default_imp_for_frm_transaction!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -4151,6 +4182,7 @@ default_imp_for_frm_fulfillment!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -4283,6 +4315,7 @@ default_imp_for_frm_record_return!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -4411,6 +4444,7 @@ default_imp_for_revoking_mandates!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Datatrans, connectors::Deutschebank, connectors::Digitalvirgo, @@ -4540,6 +4574,7 @@ default_imp_for_uas_pre_authentication!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -4669,6 +4704,7 @@ default_imp_for_uas_post_authentication!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -4799,6 +4835,7 @@ default_imp_for_uas_authentication_confirmation!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -4921,6 +4958,7 @@ default_imp_for_connector_request_id!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -5045,6 +5083,7 @@ default_imp_for_fraud_check!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -5199,6 +5238,7 @@ default_imp_for_connector_authentication!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -5326,6 +5366,7 @@ default_imp_for_uas_authentication!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -5448,6 +5489,7 @@ default_imp_for_revenue_recovery!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -5581,6 +5623,7 @@ default_imp_for_billing_connector_payment_sync!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -5712,6 +5755,7 @@ default_imp_for_revenue_recovery_record_back!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -5843,6 +5887,7 @@ default_imp_for_billing_connector_invoice_sync!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -5968,6 +6013,7 @@ default_imp_for_external_vault!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -6099,6 +6145,7 @@ default_imp_for_external_vault_insert!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -6230,6 +6277,7 @@ default_imp_for_external_vault_retrieve!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -6361,6 +6409,7 @@ default_imp_for_external_vault_delete!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -6492,6 +6541,7 @@ default_imp_for_external_vault_create!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, diff --git a/crates/hyperswitch_connectors/src/default_implementations_v2.rs b/crates/hyperswitch_connectors/src/default_implementations_v2.rs index 7e8ddbee352..42a500b8e96 100644 --- a/crates/hyperswitch_connectors/src/default_implementations_v2.rs +++ b/crates/hyperswitch_connectors/src/default_implementations_v2.rs @@ -275,6 +275,7 @@ default_imp_for_new_connector_integration_payment!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -407,6 +408,7 @@ default_imp_for_new_connector_integration_refund!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -534,6 +536,7 @@ default_imp_for_new_connector_integration_connector_access_token!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -667,6 +670,7 @@ default_imp_for_new_connector_integration_accept_dispute!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Datatrans, connectors::Deutschebank, connectors::Digitalvirgo, @@ -798,6 +802,7 @@ default_imp_for_new_connector_integration_submit_evidence!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Datatrans, connectors::Deutschebank, connectors::Digitalvirgo, @@ -929,6 +934,7 @@ default_imp_for_new_connector_integration_defend_dispute!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -1071,6 +1077,7 @@ default_imp_for_new_connector_integration_file_upload!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -1205,6 +1212,7 @@ default_imp_for_new_connector_integration_payouts_create!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -1339,6 +1347,7 @@ default_imp_for_new_connector_integration_payouts_eligibility!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -1473,6 +1482,7 @@ default_imp_for_new_connector_integration_payouts_fulfill!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -1607,6 +1617,7 @@ default_imp_for_new_connector_integration_payouts_cancel!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -1741,6 +1752,7 @@ default_imp_for_new_connector_integration_payouts_quote!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -1875,6 +1887,7 @@ default_imp_for_new_connector_integration_payouts_recipient!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -2009,6 +2022,7 @@ default_imp_for_new_connector_integration_payouts_sync!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -2143,6 +2157,7 @@ default_imp_for_new_connector_integration_payouts_recipient_account!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -2275,6 +2290,7 @@ default_imp_for_new_connector_integration_webhook_source_verification!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -2409,6 +2425,7 @@ default_imp_for_new_connector_integration_frm_sale!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -2543,6 +2560,7 @@ default_imp_for_new_connector_integration_frm_checkout!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -2677,6 +2695,7 @@ default_imp_for_new_connector_integration_frm_transaction!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -2811,6 +2830,7 @@ default_imp_for_new_connector_integration_frm_fulfillment!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -2945,6 +2965,7 @@ default_imp_for_new_connector_integration_frm_record_return!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -3076,6 +3097,7 @@ default_imp_for_new_connector_integration_revoking_mandates!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -3192,6 +3214,7 @@ default_imp_for_new_connector_integration_frm!( connectors::Coinbase, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Datatrans, connectors::Deutschebank, connectors::Digitalvirgo, @@ -3323,6 +3346,7 @@ default_imp_for_new_connector_integration_connector_authentication!( connectors::Coinbase, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Datatrans, connectors::Deutschebank, connectors::Digitalvirgo, @@ -3443,6 +3467,7 @@ default_imp_for_new_connector_integration_revenue_recovery!( connectors::Coinbase, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Datatrans, connectors::Deutschebank, connectors::Digitalvirgo, @@ -3582,6 +3607,7 @@ default_imp_for_new_connector_integration_external_vault!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, diff --git a/crates/hyperswitch_domain_models/src/connector_endpoints.rs b/crates/hyperswitch_domain_models/src/connector_endpoints.rs index 6d2b63bf9b0..63c00ed2e35 100644 --- a/crates/hyperswitch_domain_models/src/connector_endpoints.rs +++ b/crates/hyperswitch_domain_models/src/connector_endpoints.rs @@ -41,6 +41,7 @@ pub struct Connectors { pub cryptopay: ConnectorParams, pub ctp_mastercard: NoParams, pub ctp_visa: NoParams, + pub custombilling: NoParams, pub cybersource: ConnectorParams, pub datatrans: ConnectorParamsWithSecondaryBaseUrl, pub deutschebank: ConnectorParams, diff --git a/crates/router/src/connector.rs b/crates/router/src/connector.rs index 581ba5fb69f..189108d2cb8 100644 --- a/crates/router/src/connector.rs +++ b/crates/router/src/connector.rs @@ -13,34 +13,35 @@ pub use hyperswitch_connectors::connectors::{ boku::Boku, braintree, braintree::Braintree, cashtocode, cashtocode::Cashtocode, celero, celero::Celero, chargebee, chargebee::Chargebee, checkbook, checkbook::Checkbook, checkout, checkout::Checkout, coinbase, coinbase::Coinbase, coingate, coingate::Coingate, cryptopay, - cryptopay::Cryptopay, ctp_mastercard, ctp_mastercard::CtpMastercard, cybersource, - cybersource::Cybersource, datatrans, datatrans::Datatrans, deutschebank, - deutschebank::Deutschebank, digitalvirgo, digitalvirgo::Digitalvirgo, dlocal, dlocal::Dlocal, - dwolla, dwolla::Dwolla, ebanx, ebanx::Ebanx, elavon, elavon::Elavon, facilitapay, - facilitapay::Facilitapay, fiserv, fiserv::Fiserv, fiservemea, fiservemea::Fiservemea, fiuu, - fiuu::Fiuu, forte, forte::Forte, getnet, getnet::Getnet, globalpay, globalpay::Globalpay, - globepay, globepay::Globepay, gocardless, gocardless::Gocardless, gpayments, - gpayments::Gpayments, helcim, helcim::Helcim, hipay, hipay::Hipay, hyperswitch_vault, - hyperswitch_vault::HyperswitchVault, iatapay, iatapay::Iatapay, inespay, inespay::Inespay, - itaubank, itaubank::Itaubank, jpmorgan, jpmorgan::Jpmorgan, juspaythreedsserver, - juspaythreedsserver::Juspaythreedsserver, klarna, klarna::Klarna, mifinity, mifinity::Mifinity, - mollie, mollie::Mollie, moneris, moneris::Moneris, multisafepay, multisafepay::Multisafepay, - netcetera, netcetera::Netcetera, nexinets, nexinets::Nexinets, nexixpay, nexixpay::Nexixpay, - nmi, nmi::Nmi, nomupay, nomupay::Nomupay, noon, noon::Noon, nordea, nordea::Nordea, novalnet, - novalnet::Novalnet, nuvei, nuvei::Nuvei, opayo, opayo::Opayo, opennode, opennode::Opennode, - paybox, paybox::Paybox, payeezy, payeezy::Payeezy, payload, payload::Payload, payme, - payme::Payme, payone, payone::Payone, paypal, paypal::Paypal, paystack, paystack::Paystack, - payu, payu::Payu, placetopay, placetopay::Placetopay, plaid, plaid::Plaid, powertranz, - powertranz::Powertranz, prophetpay, prophetpay::Prophetpay, rapyd, rapyd::Rapyd, razorpay, - razorpay::Razorpay, recurly, recurly::Recurly, redsys, redsys::Redsys, riskified, - riskified::Riskified, santander, santander::Santander, shift4, shift4::Shift4, signifyd, - signifyd::Signifyd, silverflow, silverflow::Silverflow, square, square::Square, stax, - stax::Stax, stripe, stripe::Stripe, stripebilling, stripebilling::Stripebilling, taxjar, - taxjar::Taxjar, threedsecureio, threedsecureio::Threedsecureio, thunes, thunes::Thunes, - tokenio, tokenio::Tokenio, trustpay, trustpay::Trustpay, tsys, tsys::Tsys, - unified_authentication_service, unified_authentication_service::UnifiedAuthenticationService, - vgs, vgs::Vgs, volt, volt::Volt, wellsfargo, wellsfargo::Wellsfargo, wellsfargopayout, - wellsfargopayout::Wellsfargopayout, wise, wise::Wise, worldline, worldline::Worldline, - worldpay, worldpay::Worldpay, worldpayvantiv, worldpayvantiv::Worldpayvantiv, worldpayxml, - worldpayxml::Worldpayxml, xendit, xendit::Xendit, zen, zen::Zen, zsl, zsl::Zsl, + cryptopay::Cryptopay, ctp_mastercard, ctp_mastercard::CtpMastercard, custombilling, + custombilling::Custombilling, cybersource, cybersource::Cybersource, datatrans, + datatrans::Datatrans, deutschebank, deutschebank::Deutschebank, digitalvirgo, + digitalvirgo::Digitalvirgo, dlocal, dlocal::Dlocal, dwolla, dwolla::Dwolla, ebanx, + ebanx::Ebanx, elavon, elavon::Elavon, facilitapay, facilitapay::Facilitapay, fiserv, + fiserv::Fiserv, fiservemea, fiservemea::Fiservemea, fiuu, fiuu::Fiuu, forte, forte::Forte, + getnet, getnet::Getnet, globalpay, globalpay::Globalpay, globepay, globepay::Globepay, + gocardless, gocardless::Gocardless, gpayments, gpayments::Gpayments, helcim, helcim::Helcim, + hipay, hipay::Hipay, hyperswitch_vault, hyperswitch_vault::HyperswitchVault, iatapay, + iatapay::Iatapay, inespay, inespay::Inespay, itaubank, itaubank::Itaubank, jpmorgan, + jpmorgan::Jpmorgan, juspaythreedsserver, juspaythreedsserver::Juspaythreedsserver, klarna, + klarna::Klarna, mifinity, mifinity::Mifinity, mollie, mollie::Mollie, moneris, + moneris::Moneris, multisafepay, multisafepay::Multisafepay, netcetera, netcetera::Netcetera, + nexinets, nexinets::Nexinets, nexixpay, nexixpay::Nexixpay, nmi, nmi::Nmi, nomupay, + nomupay::Nomupay, noon, noon::Noon, nordea, nordea::Nordea, novalnet, novalnet::Novalnet, + nuvei, nuvei::Nuvei, opayo, opayo::Opayo, opennode, opennode::Opennode, paybox, paybox::Paybox, + payeezy, payeezy::Payeezy, payload, payload::Payload, payme, payme::Payme, payone, + payone::Payone, paypal, paypal::Paypal, paystack, paystack::Paystack, payu, payu::Payu, + placetopay, placetopay::Placetopay, plaid, plaid::Plaid, powertranz, powertranz::Powertranz, + prophetpay, prophetpay::Prophetpay, rapyd, rapyd::Rapyd, razorpay, razorpay::Razorpay, recurly, + recurly::Recurly, redsys, redsys::Redsys, riskified, riskified::Riskified, santander, + santander::Santander, shift4, shift4::Shift4, signifyd, signifyd::Signifyd, silverflow, + silverflow::Silverflow, square, square::Square, stax, stax::Stax, stripe, stripe::Stripe, + stripebilling, stripebilling::Stripebilling, taxjar, taxjar::Taxjar, threedsecureio, + threedsecureio::Threedsecureio, thunes, thunes::Thunes, tokenio, tokenio::Tokenio, trustpay, + trustpay::Trustpay, tsys, tsys::Tsys, unified_authentication_service, + unified_authentication_service::UnifiedAuthenticationService, vgs, vgs::Vgs, volt, volt::Volt, + wellsfargo, wellsfargo::Wellsfargo, wellsfargopayout, wellsfargopayout::Wellsfargopayout, wise, + wise::Wise, worldline, worldline::Worldline, worldpay, worldpay::Worldpay, worldpayvantiv, + worldpayvantiv::Worldpayvantiv, worldpayxml, worldpayxml::Worldpayxml, xendit, xendit::Xendit, + zen, zen::Zen, zsl, zsl::Zsl, }; diff --git a/crates/router/src/core/connector_validation.rs b/crates/router/src/core/connector_validation.rs index 6fb5a340ba2..f04edb139f2 100644 --- a/crates/router/src/core/connector_validation.rs +++ b/crates/router/src/core/connector_validation.rs @@ -171,6 +171,7 @@ impl ConnectorAuthTypeAndMetadataValidation<'_> { Ok(()) } api_enums::Connector::CtpMastercard => Ok(()), + api_enums::Connector::Custombilling => Ok(()), api_enums::Connector::CtpVisa => Ok(()), api_enums::Connector::Cybersource => { cybersource::transformers::CybersourceAuthType::try_from(self.auth_type)?; diff --git a/crates/router/src/core/payments/transformers.rs b/crates/router/src/core/payments/transformers.rs index 6785e429984..1974fd3e428 100644 --- a/crates/router/src/core/payments/transformers.rs +++ b/crates/router/src/core/payments/transformers.rs @@ -5047,6 +5047,12 @@ impl ForeignFrom<&hyperswitch_domain_models::payments::payment_attempt::PaymentA fn foreign_from( attempt: &hyperswitch_domain_models::payments::payment_attempt::PaymentAttempt, ) -> Self { + let payment_method_data: Option< + api_models::payments::PaymentMethodDataResponseWithBilling, + > = attempt + .payment_method_data + .clone() + .and_then(\|data\| serde_json::from_value(data.expose().clone()).ok()); Self { id: attempt.get_id().to_owned(), status: attempt.status, @@ -5078,6 +5084,7 @@ impl ForeignFrom<&hyperswitch_domain_models::payments::payment_attempt::PaymentA .feature_metadata .as_ref() .map(api_models::payments::PaymentAttemptFeatureMetadata::foreign_from), + payment_method_data, } } } diff --git a/crates/router/src/types/api/connector_mapping.rs b/crates/router/src/types/api/connector_mapping.rs index 3dbb241622b..e80d75a7ec1 100644 --- a/crates/router/src/types/api/connector_mapping.rs +++ b/crates/router/src/types/api/connector_mapping.rs @@ -175,6 +175,9 @@ impl ConnectorData { enums::Connector::CtpMastercard => { Ok(ConnectorEnum::Old(Box::new(&connector::CtpMastercard))) } + enums::Connector::Custombilling => Ok(ConnectorEnum::Old(Box::new( + connector::Custombilling::new(), + ))), enums::Connector::CtpVisa => Ok(ConnectorEnum::Old(Box::new( connector::UnifiedAuthenticationService::new(), ))), diff --git a/crates/router/src/types/connector_transformers.rs b/crates/router/src/types/connector_transformers.rs index 75b32b3ec11..47cdf592aa1 100644 --- a/crates/router/src/types/connector_transformers.rs +++ b/crates/router/src/types/connector_transformers.rs @@ -32,6 +32,7 @@ impl ForeignTryFrom<api_enums::Connector> for common_enums::RoutableConnectors { api_enums::Connector::Coinbase => Self::Coinbase, api_enums::Connector::Coingate => Self::Coingate, api_enums::Connector::Cryptopay => Self::Cryptopay, + api_enums::Connector::Custombilling => Self::Custombilling, api_enums::Connector::CtpVisa => { Err(common_utils::errors::ValidationError::InvalidValue { message: "ctp visa is not a routable connector".to_string(), diff --git a/crates/router/tests/connectors/custombilling.rs b/crates/router/tests/connectors/custombilling.rs new file mode 100644 index 00000000000..f92552ab14f --- /dev/null +++ b/crates/router/tests/connectors/custombilling.rs @@ -0,0 +1,402 @@ +use masking::Secret; +use router::{ + types::{self, api, storage::enums, +}}; + +use crate::utils::{self, ConnectorActions}; +use test_utils::connector_auth; + +#[derive(Clone, Copy)] +struct CustombillingTest; +impl ConnectorActions for CustombillingTest {} +impl utils::Connector for CustombillingTest { + fn get_data(&self) -> api::ConnectorData { + use router::connector::Custombilling; + api::ConnectorData { + connector: Box::new(Custombilling::new()), + connector_name: types::Connector::Custombilling, + get_token: types::api::GetToken::Connector, + merchant_connector_id: None, + } + } + + fn get_auth_token(&self) -> types::ConnectorAuthType { + utils::to_connector_auth_type( + connector_auth::ConnectorAuthentication::new() + .custombilling + .expect("Missing connector authentication configuration").into(), + ) + } + + fn get_name(&self) -> String { + "custombilling".to_string() + } +} + +static CONNECTOR: CustombillingTest = CustombillingTest {}; + +fn get_default_payment_info() -> Option<utils::PaymentInfo> { + None +} + +fn payment_method_details() -> Option<types::PaymentsAuthorizeData> { + None +} + +// Cards Positive Tests +// Creates a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_only_authorize_payment() { + let response = CONNECTOR + .authorize_payment(payment_method_details(), get_default_payment_info()) + .await + .expect("Authorize payment response"); + assert_eq!(response.status, enums::AttemptStatus::Authorized); +} + +// Captures a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_capture_authorized_payment() { + let response = CONNECTOR + .authorize_and_capture_payment(payment_method_details(), None, get_default_payment_info()) + .await + .expect("Capture payment response"); + assert_eq!(response.status, enums::AttemptStatus::Charged); +} + +// Partially captures a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_capture_authorized_payment() { + let response = CONNECTOR + .authorize_and_capture_payment( + payment_method_details(), + Some(types::PaymentsCaptureData { + amount_to_capture: 50, + ..utils::PaymentCaptureType::default().0 + }), + get_default_payment_info(), + ) + .await + .expect("Capture payment response"); + assert_eq!(response.status, enums::AttemptStatus::Charged); +} + +// Synchronizes a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_authorized_payment() { + let authorize_response = CONNECTOR + .authorize_payment(payment_method_details(), get_default_payment_info()) + .await + .expect("Authorize payment response"); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + let response = CONNECTOR + .psync_retry_till_status_matches( + enums::AttemptStatus::Authorized, + Some(types::PaymentsSyncData { + connector_transaction_id: types::ResponseId::ConnectorTransactionId( + txn_id.unwrap(), + ), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .expect("PSync response"); + assert_eq!(response.status, enums::AttemptStatus::Authorized,); +} + +// Voids a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_void_authorized_payment() { + let response = CONNECTOR + .authorize_and_void_payment( + payment_method_details(), + Some(types::PaymentsCancelData { + connector_transaction_id: String::from(""), + cancellation_reason: Some("requested_by_customer".to_string()), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .expect("Void payment response"); + assert_eq!(response.status, enums::AttemptStatus::Voided); +} + +// Refunds a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_manually_captured_payment() { + let response = CONNECTOR + .capture_payment_and_refund(payment_method_details(), None, None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Partially refunds a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_refund_manually_captured_payment() { + let response = CONNECTOR + .capture_payment_and_refund( + payment_method_details(), + None, + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Synchronizes a refund using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_manually_captured_refund() { + let refund_response = CONNECTOR + .capture_payment_and_refund(payment_method_details(), None, None, get_default_payment_info()) + .await + .unwrap(); + let response = CONNECTOR + .rsync_retry_till_status_matches( + enums::RefundStatus::Success, + refund_response.response.unwrap().connector_refund_id, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Creates a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_make_payment() { + let authorize_response = CONNECTOR.make_payment(payment_method_details(), get_default_payment_info()).await.unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); +} + +// Synchronizes a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_auto_captured_payment() { + let authorize_response = CONNECTOR.make_payment(payment_method_details(), get_default_payment_info()).await.unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + assert_ne!(txn_id, None, "Empty connector transaction id"); + let response = CONNECTOR + .psync_retry_till_status_matches( + enums::AttemptStatus::Charged, + Some(types::PaymentsSyncData { + connector_transaction_id: types::ResponseId::ConnectorTransactionId( + txn_id.unwrap(), + ), + capture_method: Some(enums::CaptureMethod::Automatic), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!(response.status, enums::AttemptStatus::Charged,); +} + +// Refunds a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_auto_captured_payment() { + let response = CONNECTOR + .make_payment_and_refund(payment_method_details(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Partially refunds a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_refund_succeeded_payment() { + let refund_response = CONNECTOR + .make_payment_and_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + refund_response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Creates multiple refunds against a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_succeeded_payment_multiple_times() { + CONNECTOR + .make_payment_and_multiple_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await; +} + +// Synchronizes a refund using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_refund() { + let refund_response = CONNECTOR + .make_payment_and_refund(payment_method_details(), None, get_default_payment_info()) + .await + .unwrap(); + let response = CONNECTOR + .rsync_retry_till_status_matches( + enums::RefundStatus::Success, + refund_response.response.unwrap().connector_refund_id, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Cards Negative scenarios +// Creates a payment with incorrect CVC. +#[actix_web::test] +async fn should_fail_payment_for_incorrect_cvc() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: types::api::PaymentMethodData::Card(api::Card { + card_cvc: Secret::new("12345".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's security code is invalid.".to_string(), + ); +} + +// Creates a payment with incorrect expiry month. +#[actix_web::test] +async fn should_fail_payment_for_invalid_exp_month() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: api::PaymentMethodData::Card(api::Card { + card_exp_month: Secret::new("20".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's expiration month is invalid.".to_string(), + ); +} + +// Creates a payment with incorrect expiry year. +#[actix_web::test] +async fn should_fail_payment_for_incorrect_expiry_year() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: api::PaymentMethodData::Card(api::Card { + card_exp_year: Secret::new("2000".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's expiration year is invalid.".to_string(), + ); +} + +// Voids a payment using automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_fail_void_payment_for_auto_capture() { + let authorize_response = CONNECTOR.make_payment(payment_method_details(), get_default_payment_info()).await.unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + assert_ne!(txn_id, None, "Empty connector transaction id"); + let void_response = CONNECTOR + .void_payment(txn_id.unwrap(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + void_response.response.unwrap_err().message, + "You cannot cancel this PaymentIntent because it has a status of succeeded." + ); +} + +// Captures a payment using invalid connector payment id. +#[actix_web::test] +async fn should_fail_capture_for_invalid_payment() { + let capture_response = CONNECTOR + .capture_payment("123456789".to_string(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + capture_response.response.unwrap_err().message, + String::from("No such payment_intent: '123456789'") + ); +} + +// Refunds a payment with refund amount higher than payment amount. +#[actix_web::test] +async fn should_fail_for_refund_amount_higher_than_payment_amount() { + let response = CONNECTOR + .make_payment_and_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 150, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Refund amount (₹1.50) is greater than charge amount (₹1.00)", + ); +} + +// Connector dependent test cases goes here + +// [#478]: add unit tests for non 3DS, wallets & webhooks in connector tests diff --git a/loadtest/config/development.toml b/loadtest/config/development.toml index 0a64bdbba0f..857d43091bc 100644 --- a/loadtest/config/development.toml +++ b/loadtest/config/development.toml @@ -238,6 +238,7 @@ cards = [ "coingate", "cryptopay", "ctp_visa", + "custombilling", "cybersource", "datatrans", "deutschebank", diff --git a/scripts/add_connector.sh b/scripts/add_connector.sh index fffc5800f67..685175b79ad 100755 --- a/scripts/add_connector.sh +++ b/scripts/add_connector.sh @@ -6,7 +6,7 @@ function find_prev_connector() { git checkout $self cp $self $self.tmp # Add new connector to existing list and sort it - connectors=(aci adyen adyenplatform affirm airwallex amazonpay applepay archipel authipay authorizedotnet bambora bamboraapac bankofamerica barclaycard billwerk bitpay blackhawknetwork bluesnap boku braintree cashtocode celero chargebee checkbook checkout coinbase cryptopay ctp_visa cybersource datatrans deutschebank digitalvirgo dlocal dummyconnector dwolla ebanx elavon facilitapay fiserv fiservemea fiuu forte getnet globalpay globepay gocardless gpayments helcim hipay hyperswitch_vault iatapay inespay itaubank jpmorgan juspaythreedsserver klarna mifinity mollie moneris multisafepay netcetera nexinets nexixpay nomupay noon nordea novalnet nuvei opayo opennode paybox payeezy payload payme payone paypal paystack payu placetopay plaid powertranz prophetpay rapyd razorpay recurly redsys santander shift4 silverflow square stax stripe stripebilling taxjar threedsecureio thunes tokenio trustpay tsys unified_authentication_service vgs volt wellsfargo wellsfargopayout wise worldline worldpay worldpayvantiv worldpayxml xendit zsl "$1") + connectors=(aci adyen adyenplatform affirm airwallex amazonpay applepay archipel authipay authorizedotnet bambora bamboraapac bankofamerica barclaycard billwerk bitpay blackhawknetwork bluesnap boku braintree cashtocode celero chargebee checkbook checkout coinbase cryptopay ctp_visa custombilling cybersource datatrans deutschebank digitalvirgo dlocal dummyconnector dwolla ebanx elavon facilitapay fiserv fiservemea fiuu forte getnet globalpay globepay gocardless gpayments helcim hipay hyperswitch_vault iatapay inespay itaubank jpmorgan juspaythreedsserver klarna mifinity mollie moneris multisafepay netcetera nexinets nexixpay nomupay noon nordea novalnet nuvei opayo opennode paybox payeezy payload payme payone paypal paystack payu placetopay plaid powertranz prophetpay rapyd razorpay recurly redsys santander shift4 silverflow square stax stripe stripebilling taxjar threedsecureio thunes tokenio trustpay tsys unified_authentication_service vgs volt wellsfargo wellsfargopayout wise worldline worldpay worldpayvantiv worldpayxml xendit zsl "$1") IFS=$'\n' sorted=($(sort <<<"${connectors[*]}")); unset IFS res="$(echo ${sorted[@]})"	2025-07-17T14:01:37Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [ ] New feature - [x] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description This pr adds fetches payment method data in payment attempt list v2 api. ### Additional Changes - [x] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> Request: ``` curl --location 'http://localhost:8080/v2/payments/12345_pay_0198179b2de5751292df2b555eaa3cf2/list_attempts' \ --header 'Content-Type: application/json' \ --header 'x-profile-id: pro_2Kk2ddRcJttgm6ONh0zm' \ --header 'api-key: dev_g5HfT4ijuVQs3QLUPf3xAT6M26ebVgHHTivreiSljKPdRvEsqBNSKxHJrhLboLsT' \ --header 'Authorization: api-key=dev_g5HfT4ijuVQs3QLUPf3xAT6M26ebVgHHTivreiSljKPdRvEsqBNSKxHJrhLboLsT' ``` Response ``` { "payment_attempt_list": [ { "id": "12345_att_0198179b2e167703a070a6ec12d40213", "status": "voided", "amount": { "net_amount": 10000, "amount_to_capture": null, "surcharge_amount": null, "tax_on_surcharge": null, "amount_capturable": 0, "shipping_cost": null, "order_tax_amount": null }, "connector": "stripe", "error": { "code": "card_declined", "message": "Your card was declined.", "unified_code": null, "unified_message": null, "network_advice_code": null, "network_decline_code": null, "network_error_message": null }, "authentication_type": "no_three_ds", "created_at": "2025-07-16T12:18:21.000Z", "modified_at": "2025-07-17T08:58:23.034Z", "cancellation_reason": null, "payment_token": null, "connector_metadata": null, "payment_experience": null, "payment_method_type": "card", "connector_reference_id": null, "payment_method_subtype": "credit", "connector_payment_id": { "TxnId": "pi_3RlUHlCZJlEh6syL1TxJJCst" }, "payment_method_id": null, "client_source": null, "client_version": null, "feature_metadata": { "revenue_recovery": { "attempt_triggered_by": "external", "charge_id": "ch_3RlUHlCZJlEh6syL1gLXCiDC" } }, "payment_method_data": { "card": { "last4": "0008", "card_type": null, "card_network": null, "card_issuer": "Chase", "card_issuing_country": null, "card_isin": null, "card_extended_bin": null, "card_exp_month": "06", "card_exp_year": "50", "card_holder_name": null, "payment_checks": null, "authentication_data": null }, "billing": null } } ] } ``` ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	db14764671d18fbbd8d699f0c7c97a327bc1d0db	db14764671d18fbbd8d699f0c7c97a327bc1d0db
juspay/hyperswitch	juspay__hyperswitch-8677	Bug: [BUG]: Success Rate rule being created/listed twice for a new profile When creating an SR rule for a new profile, 2 rules with different algorithm ids are being listed in the get call for listing rules. This is happening only upon creating a new SR rule for a new profile (with no rules existing previously), and not in case of creating an SR rule when other rules already exist. <img width="1728" height="1002" alt="Image" src="https://github.com/user-attachments/assets/eeb0c631-57d2-4e97-8c96-929d705aa4ad" />	diff --git a/crates/api_models/src/events/routing.rs b/crates/api_models/src/events/routing.rs index 9f09bac8274..b1129f96afb 100644 --- a/crates/api_models/src/events/routing.rs +++ b/crates/api_models/src/events/routing.rs @@ -2,7 +2,7 @@ use common_utils::events::{ApiEventMetric, ApiEventsType}; use crate::routing::{ ContractBasedRoutingPayloadWrapper, ContractBasedRoutingSetupPayloadWrapper, - DynamicRoutingUpdateConfigQuery, EliminationRoutingPayloadWrapper, + CreateDynamicRoutingWrapper, DynamicRoutingUpdateConfigQuery, EliminationRoutingPayloadWrapper, LinkedRoutingConfigRetrieveResponse, MerchantRoutingAlgorithm, ProfileDefaultRoutingConfig, RoutingAlgorithmId, RoutingConfigRequest, RoutingDictionaryRecord, RoutingKind, RoutingLinkWrapper, RoutingPayloadWrapper, RoutingRetrieveLinkQuery, @@ -125,6 +125,12 @@ impl ApiEventMetric for ToggleDynamicRoutingWrapper { } } +impl ApiEventMetric for CreateDynamicRoutingWrapper { + fn get_api_event_type(&self) -> Option<ApiEventsType> { + Some(ApiEventsType::Routing) + } +} + impl ApiEventMetric for DynamicRoutingUpdateConfigQuery { fn get_api_event_type(&self) -> Option<ApiEventsType> { Some(ApiEventsType::Routing) diff --git a/crates/api_models/src/routing.rs b/crates/api_models/src/routing.rs index ef5a9422e20..8216f58d4ec 100644 --- a/crates/api_models/src/routing.rs +++ b/crates/api_models/src/routing.rs @@ -836,6 +836,33 @@ impl DynamicRoutingAlgorithmRef { }; } + pub fn update_feature( + &mut self, + enabled_feature: DynamicRoutingFeatures, + dynamic_routing_type: DynamicRoutingType, + ) { + match dynamic_routing_type { + DynamicRoutingType::SuccessRateBasedRouting => { + self.success_based_algorithm = Some(SuccessBasedAlgorithm { + algorithm_id_with_timestamp: DynamicAlgorithmWithTimestamp::new(None), + enabled_feature, + }) + } + DynamicRoutingType::EliminationRouting => { + self.elimination_routing_algorithm = Some(EliminationRoutingAlgorithm { + algorithm_id_with_timestamp: DynamicAlgorithmWithTimestamp::new(None), + enabled_feature, + }) + } + DynamicRoutingType::ContractBasedRouting => { + self.contract_based_routing = Some(ContractRoutingAlgorithm { + algorithm_id_with_timestamp: DynamicAlgorithmWithTimestamp::new(None), + enabled_feature, + }) + } + }; + } + pub fn disable_algorithm_id(&mut self, dynamic_routing_type: DynamicRoutingType) { match dynamic_routing_type { DynamicRoutingType::SuccessRateBasedRouting => { @@ -871,6 +898,11 @@ pub struct ToggleDynamicRoutingQuery { pub enable: DynamicRoutingFeatures, } +#[derive(Debug, Clone, serde::Serialize, serde::Deserialize, ToSchema)] +pub struct CreateDynamicRoutingQuery { + pub enable: DynamicRoutingFeatures, +} + #[derive(Debug, Clone, Copy, serde::Serialize, serde::Deserialize, ToSchema)] pub struct DynamicRoutingVolumeSplitQuery { pub split: u8, @@ -907,6 +939,20 @@ pub struct ToggleDynamicRoutingPath { pub profile_id: common_utils::id_type::ProfileId, } +#[derive(Clone, Debug, serde::Deserialize, serde::Serialize)] +pub struct CreateDynamicRoutingWrapper { + pub profile_id: common_utils::id_type::ProfileId, + pub feature_to_enable: DynamicRoutingFeatures, + pub payload: DynamicRoutingPayload, +} + +#[derive(Debug, Clone, serde::Serialize, serde::Deserialize, ToSchema)] +#[serde(tag = "type", content = "data", rename_all = "snake_case")] +pub enum DynamicRoutingPayload { + SuccessBasedRoutingPayload(SuccessBasedRoutingConfig), + EliminationRoutingPayload(EliminationRoutingConfig), +} + #[derive(Clone, Debug, serde::Deserialize, serde::Serialize, ToSchema)] pub struct RoutingVolumeSplitResponse { pub split: u8, diff --git a/crates/router/src/core/routing.rs b/crates/router/src/core/routing.rs index 2e6f8b09775..6094c9826a1 100644 --- a/crates/router/src/core/routing.rs +++ b/crates/router/src/core/routing.rs @@ -1598,6 +1598,7 @@ pub async fn update_default_routing_config_for_profile( // Toggle the specific routing type as well as add the default configs in RoutingAlgorithm table // and update the same in business profile table. + #[cfg(all(feature = "v1", feature = "dynamic_routing"))] pub async fn toggle_specific_dynamic_routing( state: SessionState, @@ -1647,16 +1648,88 @@ pub async fn toggle_specific_dynamic_routing( // 1. If present with same feature then return response as already enabled // 2. Else update the feature and persist the same on db // 3. If not present in db then create a new default entry - helpers::enable_dynamic_routing_algorithm( + Box::pin(helpers::enable_dynamic_routing_algorithm( &state, merchant_context.get_merchant_key_store().clone(), business_profile, feature_to_enable, dynamic_routing_algo_ref, dynamic_routing_type, + None, + )) + .await + } + routing::DynamicRoutingFeatures::None => { + // disable specific dynamic routing for the requested profile + helpers::disable_dynamic_routing_algorithm( + &state, + merchant_context.get_merchant_key_store().clone(), + business_profile, + dynamic_routing_algo_ref, + dynamic_routing_type, ) .await } + } +} + +#[cfg(all(feature = "v1", feature = "dynamic_routing"))] +pub async fn create_specific_dynamic_routing( + state: SessionState, + merchant_context: domain::MerchantContext, + feature_to_enable: routing::DynamicRoutingFeatures, + profile_id: common_utils::id_type::ProfileId, + dynamic_routing_type: routing::DynamicRoutingType, + payload: routing_types::DynamicRoutingPayload, +) -> RouterResponse<routing_types::RoutingDictionaryRecord> { + metrics::ROUTING_CREATE_REQUEST_RECEIVED.add( + 1, + router_env::metric_attributes!( + ("profile_id", profile_id.clone()), + ("algorithm_type", dynamic_routing_type.to_string()) + ), + ); + let db = state.store.as_ref(); + let key_manager_state = &(&state).into(); + + let business_profile: domain::Profile = core_utils::validate_and_get_business_profile( + db, + key_manager_state, + merchant_context.get_merchant_key_store(), + Some(&profile_id), + merchant_context.get_merchant_account().get_id(), + ) + .await? + .get_required_value("Profile") + .change_context(errors::ApiErrorResponse::ProfileNotFound { + id: profile_id.get_string_repr().to_owned(), + })?; + + let dynamic_routing_algo_ref: routing_types::DynamicRoutingAlgorithmRef = business_profile + .dynamic_routing_algorithm + .clone() + .map(\|val\| val.parse_value("DynamicRoutingAlgorithmRef")) + .transpose() + .change_context(errors::ApiErrorResponse::InternalServerError) + .attach_printable( + "unable to deserialize dynamic routing algorithm ref from business profile", + )? + .unwrap_or_default(); + + match feature_to_enable { + routing::DynamicRoutingFeatures::Metrics + \| routing::DynamicRoutingFeatures::DynamicConnectorSelection => { + Box::pin(helpers::enable_dynamic_routing_algorithm( + &state, + merchant_context.get_merchant_key_store().clone(), + business_profile, + feature_to_enable, + dynamic_routing_algo_ref, + dynamic_routing_type, + Some(payload), + )) + .await + } routing::DynamicRoutingFeatures::None => { // disable specific dynamic routing for the requested profile helpers::disable_dynamic_routing_algorithm( diff --git a/crates/router/src/core/routing/helpers.rs b/crates/router/src/core/routing/helpers.rs index b04df149228..290feb9e306 100644 --- a/crates/router/src/core/routing/helpers.rs +++ b/crates/router/src/core/routing/helpers.rs @@ -1979,6 +1979,7 @@ pub async fn enable_dynamic_routing_algorithm( feature_to_enable: routing_types::DynamicRoutingFeatures, dynamic_routing_algo_ref: routing_types::DynamicRoutingAlgorithmRef, dynamic_routing_type: routing_types::DynamicRoutingType, + payload: Option<routing_types::DynamicRoutingPayload>, ) -> RouterResult<ApplicationResponse<routing_types::RoutingDictionaryRecord>> { let mut dynamic_routing = dynamic_routing_algo_ref.clone(); match dynamic_routing_type { @@ -1994,6 +1995,7 @@ pub async fn enable_dynamic_routing_algorithm( dynamic_routing.clone(), dynamic_routing_type, dynamic_routing.success_based_algorithm, + payload, ) .await } @@ -2006,6 +2008,7 @@ pub async fn enable_dynamic_routing_algorithm( dynamic_routing.clone(), dynamic_routing_type, dynamic_routing.elimination_routing_algorithm, + payload, ) .await } @@ -2018,6 +2021,7 @@ pub async fn enable_dynamic_routing_algorithm( } } +#[allow(clippy::too_many_arguments)] #[cfg(all(feature = "v1", feature = "dynamic_routing"))] pub async fn enable_specific_routing_algorithm<A>( state: &SessionState, @@ -2027,10 +2031,24 @@ pub async fn enable_specific_routing_algorithm<A>( mut dynamic_routing_algo_ref: routing_types::DynamicRoutingAlgorithmRef, dynamic_routing_type: routing_types::DynamicRoutingType, algo_type: Option<A>, + payload: Option<routing_types::DynamicRoutingPayload>, ) -> RouterResult<ApplicationResponse<routing_types::RoutingDictionaryRecord>> where A: routing_types::DynamicRoutingAlgoAccessor + Clone + Debug, { + //Check for payload + if let Some(payload) = payload { + return create_specific_dynamic_routing_setup( + state, + key_store, + business_profile, + feature_to_enable, + dynamic_routing_algo_ref, + dynamic_routing_type, + payload, + ) + .await; + } // Algorithm wasn't created yet let Some(mut algo_type) = algo_type else { return default_specific_dynamic_routing_setup( @@ -2112,6 +2130,7 @@ pub async fn default_specific_dynamic_routing_setup( let merchant_id = business_profile.merchant_id.clone(); let algorithm_id = common_utils::generate_routing_id_of_default_length(); let timestamp = common_utils::date_time::now(); + let algo = match dynamic_routing_type { routing_types::DynamicRoutingType::SuccessRateBasedRouting => { let default_success_based_routing_config = @@ -2142,6 +2161,7 @@ pub async fn default_specific_dynamic_routing_setup( } else { routing_types::EliminationRoutingConfig::default() }; + routing_algorithm::RoutingAlgorithm { algorithm_id: algorithm_id.clone(), profile_id: profile_id.clone(), @@ -2173,6 +2193,7 @@ pub async fn default_specific_dynamic_routing_setup( business_profile.get_id(), dynamic_routing_type, &mut dynamic_routing_algo_ref, + None, ) .await .change_context(errors::ApiErrorResponse::InternalServerError) @@ -2208,6 +2229,122 @@ pub async fn default_specific_dynamic_routing_setup( Ok(ApplicationResponse::Json(new_record)) } +#[cfg(all(feature = "dynamic_routing", feature = "v1"))] +#[instrument(skip_all)] +pub async fn create_specific_dynamic_routing_setup( + state: &SessionState, + key_store: domain::MerchantKeyStore, + business_profile: domain::Profile, + feature_to_enable: routing_types::DynamicRoutingFeatures, + mut dynamic_routing_algo_ref: routing_types::DynamicRoutingAlgorithmRef, + dynamic_routing_type: routing_types::DynamicRoutingType, + payload: routing_types::DynamicRoutingPayload, +) -> RouterResult<ApplicationResponse<routing_types::RoutingDictionaryRecord>> { + let db = state.store.as_ref(); + let key_manager_state = &state.into(); + let profile_id = business_profile.get_id().clone(); + let merchant_id = business_profile.merchant_id.clone(); + let algorithm_id = common_utils::generate_routing_id_of_default_length(); + let timestamp = common_utils::date_time::now(); + + let algo = match dynamic_routing_type { + routing_types::DynamicRoutingType::SuccessRateBasedRouting => { + let success_config = match &payload { + routing_types::DynamicRoutingPayload::SuccessBasedRoutingPayload(config) => config, + _ => { + return Err((errors::ApiErrorResponse::InvalidRequestData { + message: "Invalid payload type for Success Rate Based Routing".to_string(), + }) + .into()) + } + }; + + routing_algorithm::RoutingAlgorithm { + algorithm_id: algorithm_id.clone(), + profile_id: profile_id.clone(), + merchant_id, + name: SUCCESS_BASED_DYNAMIC_ROUTING_ALGORITHM.to_string(), + description: None, + kind: diesel_models::enums::RoutingAlgorithmKind::Dynamic, + algorithm_data: serde_json::json!(success_config), + created_at: timestamp, + modified_at: timestamp, + algorithm_for: common_enums::TransactionType::Payment, + decision_engine_routing_id: None, + } + } + routing_types::DynamicRoutingType::EliminationRouting => { + let elimination_config = match &payload { + routing_types::DynamicRoutingPayload::EliminationRoutingPayload(config) => config, + _ => { + return Err((errors::ApiErrorResponse::InvalidRequestData { + message: "Invalid payload type for Elimination Routing".to_string(), + }) + .into()) + } + }; + + routing_algorithm::RoutingAlgorithm { + algorithm_id: algorithm_id.clone(), + profile_id: profile_id.clone(), + merchant_id, + name: ELIMINATION_BASED_DYNAMIC_ROUTING_ALGORITHM.to_string(), + description: None, + kind: diesel_models::enums::RoutingAlgorithmKind::Dynamic, + algorithm_data: serde_json::json!(elimination_config), + created_at: timestamp, + modified_at: timestamp, + algorithm_for: common_enums::TransactionType::Payment, + decision_engine_routing_id: None, + } + } + + routing_types::DynamicRoutingType::ContractBasedRouting => { + return Err((errors::ApiErrorResponse::InvalidRequestData { + message: "Contract routing cannot be set as default".to_string(), + }) + .into()) + } + }; + + if state.conf.open_router.dynamic_routing_enabled { + enable_decision_engine_dynamic_routing_setup( + state, + business_profile.get_id(), + dynamic_routing_type, + &mut dynamic_routing_algo_ref, + Some(payload), + ) + .await + .change_context(errors::ApiErrorResponse::InternalServerError) + .attach_printable("Unable to setup decision engine dynamic routing")?; + } + + let record = db + .insert_routing_algorithm(algo) + .await + .change_context(errors::ApiErrorResponse::InternalServerError) + .attach_printable("Unable to insert record in routing algorithm table")?; + + dynamic_routing_algo_ref.update_feature(feature_to_enable, dynamic_routing_type); + update_business_profile_active_dynamic_algorithm_ref( + db, + key_manager_state, + &key_store, + business_profile, + dynamic_routing_algo_ref, + ) + .await?; + + let new_record = record.foreign_into(); + + core_metrics::ROUTING_CREATE_SUCCESS_RESPONSE.add( + 1, + router_env::metric_attributes!(("profile_id", profile_id.clone())), + ); + Ok(ApplicationResponse::Json(new_record)) +} + #[derive(Debug, Clone)] pub struct DynamicRoutingConfigParamsInterpolator { pub payment_method: Option<common_enums::PaymentMethod>, @@ -2289,20 +2426,30 @@ pub async fn enable_decision_engine_dynamic_routing_setup( profile_id: &id_type::ProfileId, dynamic_routing_type: routing_types::DynamicRoutingType, dynamic_routing_algo_ref: &mut routing_types::DynamicRoutingAlgorithmRef, + payload: Option<routing_types::DynamicRoutingPayload>, ) -> RouterResult<()> { logger::debug!( "performing call with open_router for profile {}", profile_id.get_string_repr() ); - let default_engine_config_request = match dynamic_routing_type { + let decision_engine_config_request = match dynamic_routing_type { routing_types::DynamicRoutingType::SuccessRateBasedRouting => { - let default_success_based_routing_config = - routing_types::SuccessBasedRoutingConfig::open_router_config_default(); + let success_based_routing_config = payload + .and_then(\|p\| match p { + routing_types::DynamicRoutingPayload::SuccessBasedRoutingPayload(config) => { + Some(config) + } + _ => None, + }) + .unwrap_or_else( + routing_types::SuccessBasedRoutingConfig::open_router_config_default, + ); + open_router::DecisionEngineConfigSetupRequest { merchant_id: profile_id.get_string_repr().to_string(), config: open_router::DecisionEngineConfigVariant::SuccessRate( - default_success_based_routing_config + success_based_routing_config .get_decision_engine_configs() .change_context(errors::ApiErrorResponse::GenericNotFoundError { message: "Decision engine config not found".to_string(), @@ -2312,12 +2459,21 @@ pub async fn enable_decision_engine_dynamic_routing_setup( } } routing_types::DynamicRoutingType::EliminationRouting => { - let default_elimination_based_routing_config = - routing_types::EliminationRoutingConfig::open_router_config_default(); + let elimination_based_routing_config = payload + .and_then(\|p\| match p { + routing_types::DynamicRoutingPayload::EliminationRoutingPayload(config) => { + Some(config) + } + _ => None, + }) + .unwrap_or_else( + routing_types::EliminationRoutingConfig::open_router_config_default, + ); + open_router::DecisionEngineConfigSetupRequest { merchant_id: profile_id.get_string_repr().to_string(), config: open_router::DecisionEngineConfigVariant::Elimination( - default_elimination_based_routing_config + elimination_based_routing_config .get_decision_engine_configs() .change_context(errors::ApiErrorResponse::GenericNotFoundError { message: "Decision engine config not found".to_string(), @@ -2342,7 +2498,7 @@ pub async fn enable_decision_engine_dynamic_routing_setup( state, services::Method::Post, DECISION_ENGINE_RULE_CREATE_ENDPOINT, - Some(default_engine_config_request), + Some(decision_engine_config_request), None, None, ) diff --git a/crates/router/src/routes/app.rs b/crates/router/src/routes/app.rs index 01455e9e17b..62260dc49cc 100644 --- a/crates/router/src/routes/app.rs +++ b/crates/router/src/routes/app.rs @@ -2189,6 +2189,10 @@ impl Profile { web::resource("/toggle") .route(web::post().to(routing::toggle_success_based_routing)), ) + .service( + web::resource("/create") + .route(web::post().to(routing::create_success_based_routing)), + ) .service(web::resource("/config/{algorithm_id}").route( web::patch().to(\|state, req, path, payload\| { routing::success_based_routing_update_configs( @@ -2211,6 +2215,10 @@ impl Profile { web::resource("/toggle") .route(web::post().to(routing::toggle_elimination_routing)), ) + .service( + web::resource("/create") + .route(web::post().to(routing::create_elimination_routing)), + ) .service(web::resource("config/{algorithm_id}").route( web::patch().to(\|state, req, path, payload\| { routing::elimination_routing_update_configs( diff --git a/crates/router/src/routes/lock_utils.rs b/crates/router/src/routes/lock_utils.rs index 62d65211053..dcc5cf0752d 100644 --- a/crates/router/src/routes/lock_utils.rs +++ b/crates/router/src/routes/lock_utils.rs @@ -79,6 +79,7 @@ impl From<Flow> for ApiIdentifier { \| Flow::DecisionManagerDeleteConfig \| Flow::DecisionManagerRetrieveConfig \| Flow::ToggleDynamicRouting + \| Flow::CreateDynamicRoutingConfig \| Flow::UpdateDynamicRoutingConfigs \| Flow::DecisionManagerUpsertConfig \| Flow::RoutingEvaluateRule diff --git a/crates/router/src/routes/routing.rs b/crates/router/src/routes/routing.rs index 53f6a75c5c1..ec118bea8da 100644 --- a/crates/router/src/routes/routing.rs +++ b/crates/router/src/routes/routing.rs @@ -1240,6 +1240,60 @@ pub async fn toggle_success_based_routing( .await } +#[cfg(all(feature = "olap", feature = "v1", feature = "dynamic_routing"))] +#[instrument(skip_all)] +pub async fn create_success_based_routing( + state: web::Data<AppState>, + req: HttpRequest, + query: web::Query<api_models::routing::CreateDynamicRoutingQuery>, + path: web::Path<routing_types::ToggleDynamicRoutingPath>, + success_based_config: web::Json<routing_types::SuccessBasedRoutingConfig>, +) -> impl Responder { + let flow = Flow::CreateDynamicRoutingConfig; + let wrapper = routing_types::CreateDynamicRoutingWrapper { + feature_to_enable: query.into_inner().enable, + profile_id: path.into_inner().profile_id, + payload: api_models::routing::DynamicRoutingPayload::SuccessBasedRoutingPayload( + success_based_config.into_inner(), + ), + }; + Box::pin(oss_api::server_wrap( + flow, + state, + &req, + wrapper.clone(), + \|state, + auth: auth::AuthenticationData, + wrapper: routing_types::CreateDynamicRoutingWrapper, + _\| { + let merchant_context = domain::MerchantContext::NormalMerchant(Box::new( + domain::Context(auth.merchant_account, auth.key_store), + )); + routing::create_specific_dynamic_routing( + state, + merchant_context, + wrapper.feature_to_enable, + wrapper.profile_id, + api_models::routing::DynamicRoutingType::SuccessRateBasedRouting, + wrapper.payload, + ) + }, + auth::auth_type( + &auth::HeaderAuth(auth::ApiKeyAuth { + is_connected_allowed: false, + is_platform_allowed: false, + }), + &auth::JWTAuthProfileFromRoute { + profile_id: wrapper.profile_id, + required_permission: Permission::ProfileRoutingWrite, + }, + req.headers(), + ), + api_locking::LockAction::NotApplicable, + )) + .await +} + #[cfg(all(feature = "olap", feature = "v1", feature = "dynamic_routing"))] #[instrument(skip_all)] pub async fn success_based_routing_update_configs( @@ -1480,6 +1534,60 @@ pub async fn toggle_elimination_routing( .await } +#[cfg(all(feature = "olap", feature = "v1", feature = "dynamic_routing"))] +#[instrument(skip_all)] +pub async fn create_elimination_routing( + state: web::Data<AppState>, + req: HttpRequest, + query: web::Query<api_models::routing::CreateDynamicRoutingQuery>, + path: web::Path<routing_types::ToggleDynamicRoutingPath>, + elimination_config: web::Json<routing_types::EliminationRoutingConfig>, +) -> impl Responder { + let flow = Flow::CreateDynamicRoutingConfig; + let wrapper = routing_types::CreateDynamicRoutingWrapper { + feature_to_enable: query.into_inner().enable, + profile_id: path.into_inner().profile_id, + payload: api_models::routing::DynamicRoutingPayload::EliminationRoutingPayload( + elimination_config.into_inner(), + ), + }; + Box::pin(oss_api::server_wrap( + flow, + state, + &req, + wrapper.clone(), + \|state, + auth: auth::AuthenticationData, + wrapper: routing_types::CreateDynamicRoutingWrapper, + _\| { + let merchant_context = domain::MerchantContext::NormalMerchant(Box::new( + domain::Context(auth.merchant_account, auth.key_store), + )); + routing::create_specific_dynamic_routing( + state, + merchant_context, + wrapper.feature_to_enable, + wrapper.profile_id, + api_models::routing::DynamicRoutingType::EliminationRouting, + wrapper.payload, + ) + }, + auth::auth_type( + &auth::HeaderAuth(auth::ApiKeyAuth { + is_connected_allowed: false, + is_platform_allowed: false, + }), + &auth::JWTAuthProfileFromRoute { + profile_id: wrapper.profile_id, + required_permission: Permission::ProfileRoutingWrite, + }, + req.headers(), + ), + api_locking::LockAction::NotApplicable, + )) + .await +} + #[cfg(all(feature = "olap", feature = "v1"))] #[instrument(skip_all)] pub async fn set_dynamic_routing_volume_split( diff --git a/crates/router_env/src/logger/types.rs b/crates/router_env/src/logger/types.rs index e6651c3c520..722d9bde9aa 100644 --- a/crates/router_env/src/logger/types.rs +++ b/crates/router_env/src/logger/types.rs @@ -261,6 +261,8 @@ pub enum Flow { RoutingUpdateDefaultConfig, /// Routing delete config RoutingDeleteConfig, + /// Create dynamic routing + CreateDynamicRoutingConfig, /// Toggle dynamic routing ToggleDynamicRouting, /// Update dynamic routing config	2025-07-24T13:08:02Z	### Summary This PR introduces the `/create` endpoints for dynamic routing algorithm types (Success-Based and Elimination), allowing merchants to initialize and register dynamic routing logic via a new payload-capable flow. The implementation includes support for optional configuration payloads and integration with the existing routing setup framework. --- ### Key Changes New Features * New endpoint: * `POST /{profile_id}/dynamic_routing/success_based/create` * `POST /{profile_id}/dynamic_routing/elimination/create` * Payload Support: Optional payloads for `SuccessBasedRoutingConfig` and `EliminationRoutingConfig` can now be passed to configure algorithms during creation. * `CreateDynamicRoutingWrapper` added to handle request data (profile ID, feature flag, optional payload). * `DynamicRoutingPayload` enum introduced with tagged serialization for extensibility. Core Logic Additions * `create_specific_dynamic_routing` method introduced to encapsulate algorithm creation logic based on feature + payload. * `enable_dynamic_routing_algorithm` and `enable_specific_routing_algorithm` now accept optional payloads to use custom configs during setup. * New helper: `create_specific_dynamic_routing_setup()` handles inserting the provided configuration payload into the DB, avoiding fallback to defaults. Flow and API Updates * `Flow::CreateDynamicRouting` added for observability and authorization context. * `ApiEventMetric` trait implemented for `CreateDynamicRoutingWrapper`. --- Curls and Responses 1. Flow for success_based (i)Request : Success Based ``` curl --location 'http://localhost:8080/account/merchant_1755085769/business_profile/pro_W03vsc3viNBMsEb2BAGF/dynamic_routing/success_based/create?enable=dynamic_connector_selection' \ --header 'Content-Type: application/json' \ --header 'api-key: dev_bhW5F52tburClYJFA3MhY5QHVD0EjpDPHoROKdB1NLfap0tBhRrH2QiQ5NQfIpHB' \ --data '{ "decision_engine_configs": { "defaultLatencyThreshold": 90, "defaultBucketSize": 200, "defaultHedgingPercent": 5, "subLevelInputConfig": [ { "paymentMethodType": "card", "paymentMethod": "credit", "bucketSize": 250, "hedgingPercent": 1 } ] } }' ``` Response: ``` { "id": "routing_STHAfh9Dyiy3BPLIUQAS", "profile_id": "pro_W03vsc3viNBMsEb2BAGF", "name": "Success rate based dynamic routing algorithm", "kind": "dynamic", "description": "", "created_at": 1755086316, "modified_at": 1755086316, "algorithm_for": "payment", "decision_engine_routing_id": null } ``` (ii)Request : Activate ``` curl --location 'http://localhost:8080/routing/routing_STHAfh9Dyiy3BPLIUQAS/activate' \ --header 'Content-Type: application/json' \ --header 'api-key: dev_bhW5F52tburClYJFA3MhY5QHVD0EjpDPHoROKdB1NLfap0tBhRrH2QiQ5NQfIpHB' \ --data '{}' ``` Response: ``` { "id": "routing_STHAfh9Dyiy3BPLIUQAS", "profile_id": "pro_W03vsc3viNBMsEb2BAGF", "name": "Success rate based dynamic routing algorithm", "kind": "dynamic", "description": "", "created_at": 1755086316, "modified_at": 1755086316, "algorithm_for": "payment", "decision_engine_routing_id": null } ``` (iii)Request: volume_split ``` curl --location --request POST 'http://localhost:8080/account/merchant_1755085769/business_profile/pro_W03vsc3viNBMsEb2BAGF/dynamic_routing/set_volume_split?split=100' \ --header 'api-key: dev_bhW5F52tburClYJFA3MhY5QH****DPHoROKdB1NLfap0tBhRrH2QiQ5NQfIpHB' ``` Response: ``` { "routing_type": "dynamic", "split": 100 } ``` (iv)Request: Payment ``` curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_bhW5F52tburClYJFA3MhY5QHVD0EjpDPHoROKdB1NLfap0tBhRrH2QiQ5NQfIpHB' \ --data-raw '{ "amount": 6540, "currency": "USD", "amount_to_capture": 6540, "confirm": true, "profile_id": "pro_W03vsc3viNBMsEb2BAGF", "capture_method": "automatic", "capture_on": "2022-09-10T10:11:12Z", "authentication_type": "no_three_ds", "setup_future_usage": "on_session", "customer": { "id": "customer123", "name": "John Doe", "email": "[email protected]", "phone": "9999999999", "phone_country_code": "+1" }, "customer_id": "customer123", "phone_country_code": "+1", "description": "Its my first payment request", "return_url": "https://google.com", "payment_method": "card", "payment_method_type": "credit", "payment_method_data": { "card": { "card_number": "4242424242424242", "card_exp_month": "10", "card_exp_year": "25", "card_holder_name": "joseph Doe", "card_cvc": "123" } }, "billing": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" }, "phone": { "number": "8056594427", "country_code": "+91" }, "email": "[email protected]" }, "shipping": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" }, "phone": { "number": "8056594427", "country_code": "+91" }, "email": "[email protected]" }, "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "order_details": [ { "product_name": "Apple iphone 15", "quantity": 1, "amount": 6540, "account_name": "transaction_processing" } ], "metadata": { "udf1": "value1", "new_customer": "true", "login_date": "2019-09-10T10:11:12Z" }, "browser_info": { "user_agent": "Mozilla\/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/70.0.3538.110 Safari\/537.36", "accept_header": "text\/html,application\/xhtml+xml,application\/xml;q=0.9,image\/webp,image\/apng,\/;q=0.8", "language": "nl-NL", "color_depth": 24, "screen_height": 723, "screen_width": 1536, "time_zone": 0, "java_enabled": true, "java_script_enabled": true, "ip_address": "128.0.0.1" }, "customer_acceptance": { "acceptance_type": "offline", "accepted_at": "1963-05-03T04:07:52.723Z", "online": { "ip_address": "125.0.0.1", "user_agent": "amet irure esse" } }, "connector_metadata": { "noon": { "order_category": "pay" } }, "payment_link": false, "payment_link_config": { "theme": "", "logo": "", "seller_name": "", "sdk_layout": "", "display_sdk_only": false, "enabled_saved_payment_method": false }, "payment_type": "normal", "request_incremental_authorization": false, "merchant_order_reference_id": "test_ord", "session_expiry": 900 }' ``` 2. Flow of elimination Resquest : Elimination ``` curl --location 'http://localhost:8080/account/merchant_1755085769/business_profile/pro_W03vsc3viNBMsEb2BAGF/dynamic_routing/elimination/create?enable=dynamic_connector_selection' \ --header 'Content-Type: application/json' \ --header 'api-key: dev_bhW5F52tburClYJFA3MhY5QHVD0EjpDPHoROKdB1NLfap0tBhRrH2QiQ5NQfIpHB' \ --data '{ "decision_engine_configs": { "threshold": 0.35 } }' ``` Response: ``` { "id": "routing_TNPpQ8FtYXyVmBx408it", "profile_id": "pro_W03vsc3viNBMsEb2BAGF", "name": "Elimination based dynamic routing algorithm", "kind": "dynamic", "description": "", "created_at": 1755086640, "modified_at": 1755086640, "algorithm_for": "payment", "decision_engine_routing_id": null } ``` Request : activate ``` curl --location 'http://localhost:8080/routing/routing_TNPpQ8FtYXyVmBx408it/activate' \ --header 'Content-Type: application/json' \ --header 'api-key: dev_bhW5F52tburClYJFA3MhY5QHVD0EjpDPHoROKdB1NLfap0tBhRrH2QiQ5NQfIpHB' \ --data '{}' ``` Response: ``` { "id": "routing_TNPpQ8FtYXyVmBx408it", "profile_id": "pro_W03vsc3viNBMsEb2BAGF", "name": "Elimination based dynamic routing algorithm", "kind": "dynamic", "description": "", "created_at": 1755086640, "modified_at": 1755086640, "algorithm_for": "payment", "decision_engine_routing_id": null } ``` Request: volume_split ``` curl --location --request POST 'http://localhost:8080/account/merchant_1755085769/business_profile/pro_W03vsc3viNBMsEb2BAGF/dynamic_routing/set_volume_split?split=100' \ --header 'api-key: dev_bhW5F52tburClYJFA3MhY5QHVD0EjpDPHoROKd****p0tBhRrH2QiQ5NQfIpHB' ``` Response: ``` { "routing_type": "dynamic", "split": 100 } ``` (iv) Request: Payment	v1.116.0	8bb8b2062e84e8d7116a9ca0e76c8ebd71b2b3ec	8bb8b2062e84e8d7116a9ca0e76c8ebd71b2b3ec
juspay/hyperswitch	juspay__hyperswitch-8678	Bug: Add debit routing support for apple pay In the Apple Pay decryption flow, if debit routing is enabled by the merchant and the card type is debit, a call will be made to the decision engine to retrieve the supported card networks and the potential debit routing savings. Among these networks, the lowest-cost network will be selected to process the Apple Pay payment.	diff --git a/crates/common_enums/src/enums.rs b/crates/common_enums/src/enums.rs index 49f6d15a6da..687e42728f2 100644 --- a/crates/common_enums/src/enums.rs +++ b/crates/common_enums/src/enums.rs @@ -190,6 +190,30 @@ impl AttemptStatus { } } +#[derive( + Clone, + Copy, + Debug, + Hash, + Eq, + PartialEq, + serde::Deserialize, + serde::Serialize, + strum::Display, + strum::EnumString, + strum::EnumIter, + ToSchema, +)] +#[router_derive::diesel_enum(storage_type = "db_enum")] +#[serde(rename_all = "snake_case")] +#[strum(serialize_all = "snake_case")] +pub enum ApplePayPaymentMethodType { + Debit, + Credit, + Prepaid, + Store, +} + /// Indicates the method by which a card is discovered during a payment #[derive( Clone, diff --git a/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs b/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs index bafbc7920af..d972c958b71 100644 --- a/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs @@ -2218,7 +2218,7 @@ impl TryFrom<(&WalletData, &PaymentsAuthorizeRouterData)> for AdyenPaymentMethod number: apple_pay_decrypte.application_primary_account_number, expiry_month: exp_month, expiry_year: expiry_year_4_digit, - brand: "applepay".to_string(), + brand: data.payment_method.network.clone(), payment_type: PaymentType::Scheme, }; Ok(AdyenPaymentMethod::ApplePayDecrypt(Box::new( diff --git a/crates/hyperswitch_domain_models/src/payment_method_data.rs b/crates/hyperswitch_domain_models/src/payment_method_data.rs index 0a5ca7705b8..f2f86479362 100644 --- a/crates/hyperswitch_domain_models/src/payment_method_data.rs +++ b/crates/hyperswitch_domain_models/src/payment_method_data.rs @@ -10,6 +10,7 @@ use common_enums::enums as api_enums; #[cfg(feature = "v2")] use common_utils::ext_traits::OptionExt; use common_utils::{ + ext_traits::StringExt, id_type, new_type::{ MaskedBankAccount, MaskedIban, MaskedRoutingNumber, MaskedSortCode, MaskedUpiVpaId, @@ -75,6 +76,14 @@ impl PaymentMethodData { } } + pub fn get_wallet_data(&self) -> Option<&WalletData> { + if let Self::Wallet(wallet_data) = self { + Some(wallet_data) + } else { + None + } + } + pub fn is_network_token_payment_method_data(&self) -> bool { matches!(self, Self::NetworkToken(_)) } @@ -263,6 +272,32 @@ pub enum WalletData { RevolutPay(RevolutPayData), } +impl WalletData { + pub fn get_paze_wallet_data(&self) -> Option<&PazeWalletData> { + if let Self::Paze(paze_wallet_data) = self { + Some(paze_wallet_data) + } else { + None + } + } + + pub fn get_apple_pay_wallet_data(&self) -> Option<&ApplePayWalletData> { + if let Self::ApplePay(apple_pay_wallet_data) = self { + Some(apple_pay_wallet_data) + } else { + None + } + } + + pub fn get_google_pay_wallet_data(&self) -> Option<&GooglePayWalletData> { + if let Self::GooglePay(google_pay_wallet_data) = self { + Some(google_pay_wallet_data) + } else { + None + } + } +} + #[derive(Eq, PartialEq, Clone, Debug, serde::Deserialize, serde::Serialize)] pub struct MifinityData { pub date_of_birth: Secret<Date>, @@ -432,6 +467,26 @@ pub struct ApplePayWalletData { pub transaction_identifier: String, } +impl ApplePayWalletData { + pub fn get_payment_method_type(&self) -> Option<api_enums::PaymentMethodType> { + self.payment_method + .pm_type + .clone() + .parse_enum("ApplePayPaymentMethodType") + .ok() + .and_then(\|payment_type\| match payment_type { + common_enums::ApplePayPaymentMethodType::Debit => { + Some(api_enums::PaymentMethodType::Debit) + } + common_enums::ApplePayPaymentMethodType::Credit => { + Some(api_enums::PaymentMethodType::Credit) + } + common_enums::ApplePayPaymentMethodType::Prepaid + \| common_enums::ApplePayPaymentMethodType::Store => None, + }) + } +} + #[derive(Eq, PartialEq, Clone, Debug, serde::Deserialize, serde::Serialize)] pub struct ApplepayPaymentMethod { pub display_name: String, diff --git a/crates/router/src/core/debit_routing.rs b/crates/router/src/core/debit_routing.rs index 651f1ea04c3..0aeb2b9777b 100644 --- a/crates/router/src/core/debit_routing.rs +++ b/crates/router/src/core/debit_routing.rs @@ -6,7 +6,7 @@ use common_utils::{ errors::CustomResult, ext_traits::ValueExt, id_type, types::keymanager::KeyManagerState, }; use error_stack::ResultExt; -use masking::Secret; +use masking::{PeekInterface, Secret}; use super::{ payments::{OperationSessionGetters, OperationSessionSetters}, @@ -157,33 +157,76 @@ where match format!("{operation:?}").as_str() { "PaymentConfirm" => { logger::info!("Checking if debit routing is required"); - let payment_intent = payment_data.get_payment_intent(); - let payment_attempt = payment_data.get_payment_attempt(); - request_validation(payment_intent, payment_attempt, debit_routing_config) + request_validation(payment_data, debit_routing_config) } _ => false, } } -pub fn request_validation( - payment_intent: &hyperswitch_domain_models::payments::PaymentIntent, - payment_attempt: &hyperswitch_domain_models::payments::payment_attempt::PaymentAttempt, +fn request_validation<F: Clone, D>( + payment_data: &D, debit_routing_config: &settings::DebitRoutingConfig, -) -> bool { - logger::debug!("Validating request for debit routing"); - let is_currency_supported = payment_intent.currency.map(\|currency\| { - debit_routing_config - .supported_currencies - .contains(&currency) - }); +) -> bool +where + D: OperationSessionGetters<F> + Send + Sync + Clone, +{ + let payment_intent = payment_data.get_payment_intent(); + let payment_attempt = payment_data.get_payment_attempt(); + + let is_currency_supported = is_currency_supported(payment_intent, debit_routing_config); + + let is_valid_payment_method = validate_payment_method_for_debit_routing(payment_data); payment_intent.setup_future_usage != Some(enums::FutureUsage::OffSession) && payment_intent.amount.is_greater_than(0) - && is_currency_supported == Some(true) - && payment_attempt.authentication_type != Some(enums::AuthenticationType::ThreeDs) - && payment_attempt.payment_method == Some(enums::PaymentMethod::Card) - && payment_attempt.payment_method_type == Some(enums::PaymentMethodType::Debit) + && is_currency_supported + && payment_attempt.authentication_type == Some(enums::AuthenticationType::NoThreeDs) + && is_valid_payment_method +} + +fn is_currency_supported( + payment_intent: &hyperswitch_domain_models::payments::PaymentIntent, + debit_routing_config: &settings::DebitRoutingConfig, +) -> bool { + payment_intent + .currency + .map(\|currency\| { + debit_routing_config + .supported_currencies + .contains(&currency) + }) + .unwrap_or(false) +} + +fn validate_payment_method_for_debit_routing<F: Clone, D>(payment_data: &D) -> bool +where + D: OperationSessionGetters<F> + Send + Sync + Clone, +{ + let payment_attempt = payment_data.get_payment_attempt(); + match payment_attempt.payment_method { + Some(enums::PaymentMethod::Card) => { + payment_attempt.payment_method_type == Some(enums::PaymentMethodType::Debit) + } + Some(enums::PaymentMethod::Wallet) => { + payment_attempt.payment_method_type == Some(enums::PaymentMethodType::ApplePay) + && payment_data + .get_payment_method_data() + .and_then(\|data\| data.get_wallet_data()) + .and_then(\|data\| data.get_apple_pay_wallet_data()) + .and_then(\|data\| data.get_payment_method_type()) + == Some(enums::PaymentMethodType::Debit) + && matches!( + payment_data.get_payment_method_token().cloned(), + Some( + hyperswitch_domain_models::router_data::PaymentMethodToken::ApplePayDecrypt( + _ + ) + ) + ) + } + _ => false, + } } pub async fn check_for_debit_routing_connector_in_profile< @@ -318,8 +361,11 @@ pub async fn get_debit_routing_output< ) -> Option<open_router::DebitRoutingOutput> { logger::debug!("Fetching sorted card networks"); - let (saved_co_badged_card_data, saved_card_type, card_isin) = - extract_saved_card_info(payment_data); + let card_info = extract_card_info(payment_data); + + let saved_co_badged_card_data = card_info.co_badged_card_data; + let saved_card_type = card_info.card_type; + let card_isin = card_info.card_isin; match ( saved_co_badged_card_data @@ -370,48 +416,133 @@ pub async fn get_debit_routing_output< } } -fn extract_saved_card_info<F, D>( - payment_data: &D, -) -> ( - Option<api_models::payment_methods::CoBadgedCardData>, - Option<String>, - Option<Secret<String>>, -) +#[derive(Debug, Clone)] +struct ExtractedCardInfo { + co_badged_card_data: Option<api_models::payment_methods::CoBadgedCardData>, + card_type: Option<String>, + card_isin: Option<Secret<String>>, +} + +impl ExtractedCardInfo { + fn new( + co_badged_card_data: Option<api_models::payment_methods::CoBadgedCardData>, + card_type: Option<String>, + card_isin: Option<Secret<String>>, + ) -> Self { + Self { + co_badged_card_data, + card_type, + card_isin, + } + } + + fn empty() -> Self { + Self::new(None, None, None) + } +} + +fn extract_card_info<F, D>(payment_data: &D) -> ExtractedCardInfo +where + D: OperationSessionGetters<F>, +{ + extract_from_saved_payment_method(payment_data) + .unwrap_or_else(\|\| extract_from_payment_method_data(payment_data)) +} + +fn extract_from_saved_payment_method<F, D>(payment_data: &D) -> Option<ExtractedCardInfo> where D: OperationSessionGetters<F>, { - let payment_method_data_optional = payment_data.get_payment_method_data(); - match payment_data - .get_payment_method_info() - .and_then(\|info\| info.get_payment_methods_data()) + let payment_methods_data = payment_data + .get_payment_method_info()? + .get_payment_methods_data()?; + + if let hyperswitch_domain_models::payment_method_data::PaymentMethodsData::Card(card) = + payment_methods_data { - Some(hyperswitch_domain_models::payment_method_data::PaymentMethodsData::Card(card)) => { - match (&card.co_badged_card_data, &card.card_isin) { - (Some(co_badged), _) => { - logger::debug!("Co-badged card data found in saved payment method"); - (Some(co_badged.clone()), card.card_type, None) - } - (None, Some(card_isin)) => { - logger::debug!("No co-badged data; using saved card ISIN"); - (None, None, Some(Secret::new(card_isin.clone()))) - } - _ => (None, None, None), - } + return Some(extract_card_info_from_saved_card(&card)); + } + + None +} + +fn extract_card_info_from_saved_card( + card: &hyperswitch_domain_models::payment_method_data::CardDetailsPaymentMethod, +) -> ExtractedCardInfo { + match (&card.co_badged_card_data, &card.card_isin) { + (Some(co_badged), _) => { + logger::debug!("Co-badged card data found in saved payment method"); + ExtractedCardInfo::new(Some(co_badged.clone()), card.card_type.clone(), None) } - _ => match payment_method_data_optional { - Some(hyperswitch_domain_models::payment_method_data::PaymentMethodData::Card(card)) => { - logger::debug!("Using card data from payment request"); - ( - None, - None, - Some(Secret::new(card.card_number.get_card_isin())), - ) - } - _ => (None, None, None), - }, + (None, Some(card_isin)) => { + logger::debug!("No co-badged data; using saved card ISIN"); + ExtractedCardInfo::new(None, None, Some(Secret::new(card_isin.clone()))) + } + _ => ExtractedCardInfo::empty(), + } +} + +fn extract_from_payment_method_data<F, D>(payment_data: &D) -> ExtractedCardInfo +where + D: OperationSessionGetters<F>, +{ + match payment_data.get_payment_method_data() { + Some(hyperswitch_domain_models::payment_method_data::PaymentMethodData::Card(card)) => { + logger::debug!("Using card data from payment request"); + ExtractedCardInfo::new( + None, + None, + Some(Secret::new(card.card_number.get_extended_card_bin())), + ) + } + Some(hyperswitch_domain_models::payment_method_data::PaymentMethodData::Wallet( + wallet_data, + )) => extract_from_wallet_data(wallet_data, payment_data), + _ => ExtractedCardInfo::empty(), + } +} + +fn extract_from_wallet_data<F, D>( + wallet_data: &hyperswitch_domain_models::payment_method_data::WalletData, + payment_data: &D, +) -> ExtractedCardInfo +where + D: OperationSessionGetters<F>, +{ + match wallet_data { + hyperswitch_domain_models::payment_method_data::WalletData::ApplePay(_) => { + logger::debug!("Using Apple Pay data from payment request"); + let apple_pay_isin = extract_apple_pay_isin(payment_data); + ExtractedCardInfo::new(None, None, apple_pay_isin) + } + _ => ExtractedCardInfo::empty(), } } +fn extract_apple_pay_isin<F, D>(payment_data: &D) -> Option<Secret<String>> +where + D: OperationSessionGetters<F>, +{ + payment_data.get_payment_method_token().and_then(\|token\| { + if let hyperswitch_domain_models::router_data::PaymentMethodToken::ApplePayDecrypt( + apple_pay_decrypt_data, + ) = token + { + logger::debug!("Using Apple Pay decrypt data from payment method token"); + Some(Secret::new( + apple_pay_decrypt_data + .application_primary_account_number + .peek() + .chars() + .take(8) + .collect::<String>(), + )) + } else { + None + } + }) +} + async fn handle_retryable_connector<F, D>( state: &SessionState, debit_routing_supported_connectors: HashSet<api_enums::Connector>, diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs index cf45d15a5a1..a8f718e2391 100644 --- a/crates/router/src/core/payments.rs +++ b/crates/router/src/core/payments.rs @@ -613,6 +613,17 @@ where ) .await?; + let payment_method_token = get_decrypted_wallet_payment_method_token( + &operation, + state, + merchant_context, + &mut payment_data, + connector.as_ref(), + ) + .await?; + + payment_method_token.map(\|token\| payment_data.set_payment_method_token(Some(token))); + let (connector, debit_routing_output) = debit_routing::perform_debit_routing( &operation, state, @@ -3522,6 +3533,101 @@ impl PaymentRedirectFlow for PaymentAuthenticateCompleteAuthorize { } } +#[cfg(feature = "v1")] +pub async fn get_decrypted_wallet_payment_method_token<F, Req, D>( + operation: &BoxedOperation<'_, F, Req, D>, + state: &SessionState, + merchant_context: &domain::MerchantContext, + payment_data: &mut D, + connector_call_type_optional: Option<&ConnectorCallType>, +) -> CustomResult<Option<PaymentMethodToken>, errors::ApiErrorResponse> +where + F: Send + Clone + Sync, + D: OperationSessionGetters<F> + Send + Sync + Clone, +{ + if is_operation_confirm(operation) { + let wallet_type = payment_data + .get_payment_attempt() + .payment_method_type + .get_required_value("payment_method_type")?; + + let wallet: Box<dyn WalletFlow<F, D>> = match wallet_type { + storage_enums::PaymentMethodType::ApplePay => Box::new(ApplePayWallet), + storage_enums::PaymentMethodType::Paze => Box::new(PazeWallet), + storage_enums::PaymentMethodType::GooglePay => Box::new(GooglePayWallet), + _ => return Ok(None), + }; + + let merchant_connector_account = + get_merchant_connector_account_for_wallet_decryption_flow::<F, D>( + state, + merchant_context, + payment_data, + connector_call_type_optional, + ) + .await?; + + let decide_wallet_flow = &wallet + .decide_wallet_flow(state, payment_data, &merchant_connector_account) + .attach_printable("Failed to decide wallet flow")? + .async_map(\|payment_proce_data\| async move { + wallet + .decrypt_wallet_token(&payment_proce_data, payment_data) + .await + }) + .await + .transpose() + .attach_printable("Failed to decrypt Wallet token")?; + Ok(decide_wallet_flow.clone()) + } else { + Ok(None) + } +} + +#[cfg(feature = "v1")] +pub async fn get_merchant_connector_account_for_wallet_decryption_flow<F, D>( + state: &SessionState, + merchant_context: &domain::MerchantContext, + payment_data: &mut D, + connector_call_type_optional: Option<&ConnectorCallType>, +) -> RouterResult<helpers::MerchantConnectorAccountType> +where + F: Send + Clone + Sync, + D: OperationSessionGetters<F> + Send + Sync + Clone, +{ + let connector_call_type = connector_call_type_optional + .get_required_value("connector_call_type") + .change_context(errors::ApiErrorResponse::InternalServerError)?; + let connector_routing_data = match connector_call_type { + ConnectorCallType::PreDetermined(connector_routing_data) => connector_routing_data, + ConnectorCallType::Retryable(connector_routing_datas) => connector_routing_datas + .first() + .ok_or(errors::ApiErrorResponse::InternalServerError) + .attach_printable("Found no connector routing data in retryable call")?, + ConnectorCallType::SessionMultiple(_session_connector_datas) => { + return Err(errors::ApiErrorResponse::InternalServerError).attach_printable( + "SessionMultiple connector call type is invalid in confirm calls", + ); + } + }; + + construct_profile_id_and_get_mca( + state, + merchant_context, + payment_data, + &connector_routing_data + .connector_data + .connector_name + .to_string(), + connector_routing_data + .connector_data + .merchant_connector_id + .as_ref(), + false, + ) + .await +} + #[cfg(feature = "v1")] #[allow(clippy::too_many_arguments)] #[instrument(skip_all)] @@ -3610,13 +3716,7 @@ where router_data.connector_customer = Some(connector_customer_id); } - router_data.payment_method_token = if let Some(decrypted_token) = - add_decrypted_payment_method_token(tokenization_action.clone(), payment_data).await? - { - Some(decrypted_token) - } else { - router_data.payment_method_token - }; + router_data.payment_method_token = payment_data.get_payment_method_token().cloned(); let payment_method_token_response = router_data .add_payment_method_token( @@ -3832,7 +3932,6 @@ where operation, payment_data, validate_result, - &merchant_connector_account, merchant_context.get_merchant_key_store(), customer, business_profile, @@ -4801,134 +4900,273 @@ where Ok(router_data) } +struct ApplePayWallet; +struct PazeWallet; +struct GooglePayWallet; -pub async fn add_decrypted_payment_method_token<F, D>( - tokenization_action: TokenizationAction, - payment_data: &D, -) -> CustomResult<Option<PaymentMethodToken>, errors::ApiErrorResponse> +#[async_trait::async_trait] +pub trait WalletFlow<F, D>: Send + Sync where - F: Send + Clone + Sync, + F: Send + Clone, D: OperationSessionGetters<F> + Send + Sync + Clone, { - // Tokenization Action will be DecryptApplePayToken, only when payment method type is Apple Pay - // and the connector supports Apple Pay predecrypt - match &tokenization_action { - TokenizationAction::DecryptApplePayToken(payment_processing_details) - \| TokenizationAction::TokenizeInConnectorAndApplepayPreDecrypt( - payment_processing_details, - ) => { - let apple_pay_data = match payment_data.get_payment_method_data() { - Some(domain::PaymentMethodData::Wallet(domain::WalletData::ApplePay( - wallet_data, - ))) => Some( - ApplePayData::token_json(domain::WalletData::ApplePay(wallet_data.clone())) - .change_context(errors::ApiErrorResponse::InternalServerError) - .attach_printable("failed to parse apple pay token to json")? - .decrypt( - &payment_processing_details.payment_processing_certificate, - &payment_processing_details.payment_processing_certificate_key, - ) - .await - .change_context(errors::ApiErrorResponse::InternalServerError) - .attach_printable("failed to decrypt apple pay token")?, - ), - _ => None, - }; + fn decide_wallet_flow( + &self, + state: &SessionState, + payment_data: &D, + merchant_connector_account: &helpers::MerchantConnectorAccountType, + ) -> CustomResult<Option<DecideWalletFlow>, errors::ApiErrorResponse>; - let apple_pay_predecrypt = apple_pay_data - .parse_value::<hyperswitch_domain_models::router_data::ApplePayPredecryptData>( - "ApplePayPredecryptData", - ) - .change_context(errors::ApiErrorResponse::InternalServerError) - .attach_printable( - "failed to parse decrypted apple pay response to ApplePayPredecryptData", + async fn decrypt_wallet_token( + &self, + wallet_flow: &DecideWalletFlow, + payment_data: &D, + ) -> CustomResult<PaymentMethodToken, errors::ApiErrorResponse>; +} + +#[async_trait::async_trait] +impl<F, D> WalletFlow<F, D> for PazeWallet +where + F: Send + Clone, + D: OperationSessionGetters<F> + Send + Sync + Clone, +{ + fn decide_wallet_flow( + &self, + state: &SessionState, + _payment_data: &D, + _merchant_connector_account: &helpers::MerchantConnectorAccountType, + ) -> CustomResult<Option<DecideWalletFlow>, errors::ApiErrorResponse> { + let paze_keys = state + .conf + .paze_decrypt_keys + .as_ref() + .get_required_value("Paze decrypt keys") + .attach_printable("Paze decrypt keys not found in the configuration")?; + + let wallet_flow = DecideWalletFlow::PazeDecrypt(PazePaymentProcessingDetails { + paze_private_key: paze_keys.get_inner().paze_private_key.clone(), + paze_private_key_passphrase: paze_keys.get_inner().paze_private_key_passphrase.clone(), + }); + Ok(Some(wallet_flow)) + } + + async fn decrypt_wallet_token( + &self, + wallet_flow: &DecideWalletFlow, + payment_data: &D, + ) -> CustomResult<PaymentMethodToken, errors::ApiErrorResponse> { + let paze_payment_processing_details = wallet_flow + .get_paze_payment_processing_details() + .get_required_value("Paze payment processing details") + .attach_printable( + "Paze payment processing details not found in Paze decryption flow", + )?; + + let paze_wallet_data = payment_data + .get_payment_method_data() + .and_then(\|payment_method_data\| payment_method_data.get_wallet_data()) + .and_then(\|wallet_data\| wallet_data.get_paze_wallet_data()) + .get_required_value("Paze wallet token").attach_printable( + "Paze wallet data not found in the payment method data during the Paze decryption flow", )?; - Ok(Some(PaymentMethodToken::ApplePayDecrypt(Box::new( - apple_pay_predecrypt, - )))) - } - TokenizationAction::DecryptPazeToken(payment_processing_details) => { - let paze_data = match payment_data.get_payment_method_data() { - Some(domain::PaymentMethodData::Wallet(domain::WalletData::Paze(wallet_data))) => { - Some( - decrypt_paze_token( - wallet_data.clone(), - payment_processing_details.paze_private_key.clone(), - payment_processing_details - .paze_private_key_passphrase - .clone(), - ) - .change_context(errors::ApiErrorResponse::InternalServerError) - .attach_printable("failed to decrypt paze token")?, - ) - } - _ => None, - }; - let paze_decrypted_data = paze_data - .parse_value::<hyperswitch_domain_models::router_data::PazeDecryptedData>( - "PazeDecryptedData", + let paze_data = decrypt_paze_token( + paze_wallet_data.clone(), + paze_payment_processing_details.paze_private_key.clone(), + paze_payment_processing_details + .paze_private_key_passphrase + .clone(), + ) + .change_context(errors::ApiErrorResponse::InternalServerError) + .attach_printable("failed to decrypt paze token")?; + + let paze_decrypted_data = paze_data + .parse_value::<hyperswitch_domain_models::router_data::PazeDecryptedData>( + "PazeDecryptedData", + ) + .change_context(errors::ApiErrorResponse::InternalServerError) + .attach_printable("failed to parse PazeDecryptedData")?; + Ok(PaymentMethodToken::PazeDecrypt(Box::new( + paze_decrypted_data, + ))) + } +} + +#[async_trait::async_trait] +impl<F, D> WalletFlow<F, D> for ApplePayWallet +where + F: Send + Clone, + D: OperationSessionGetters<F> + Send + Sync + Clone, +{ + fn decide_wallet_flow( + &self, + state: &SessionState, + payment_data: &D, + merchant_connector_account: &helpers::MerchantConnectorAccountType, + ) -> CustomResult<Option<DecideWalletFlow>, errors::ApiErrorResponse> { + let apple_pay_metadata = check_apple_pay_metadata(state, Some(merchant_connector_account)); + + add_apple_pay_flow_metrics( + &apple_pay_metadata, + payment_data.get_payment_attempt().connector.clone(), + payment_data.get_payment_attempt().merchant_id.clone(), + ); + + let wallet_flow = match apple_pay_metadata { + Some(domain::ApplePayFlow::Simplified(payment_processing_details)) => Some( + DecideWalletFlow::ApplePayDecrypt(payment_processing_details), + ), + Some(domain::ApplePayFlow::Manual) \| None => None, + }; + Ok(wallet_flow) + } + + async fn decrypt_wallet_token( + &self, + wallet_flow: &DecideWalletFlow, + payment_data: &D, + ) -> CustomResult<PaymentMethodToken, errors::ApiErrorResponse> { + let apple_pay_payment_processing_details = wallet_flow + .get_apple_pay_payment_processing_details() + .get_required_value("Apple Pay payment processing details") + .attach_printable( + "Apple Pay payment processing details not found in Apple Pay decryption flow", + )?; + let apple_pay_wallet_data = payment_data + .get_payment_method_data() + .and_then(\|payment_method_data\| payment_method_data.get_wallet_data()) + .and_then(\|wallet_data\| wallet_data.get_apple_pay_wallet_data()) + .get_required_value("Paze wallet token").attach_printable( + "Apple Pay wallet data not found in the payment method data during the Apple Pay decryption flow", + )?; + let apple_pay_data = + ApplePayData::token_json(domain::WalletData::ApplePay(apple_pay_wallet_data.clone())) + .change_context(errors::ApiErrorResponse::InternalServerError) + .attach_printable("failed to parse apple pay token to json")? + .decrypt( + &apple_pay_payment_processing_details.payment_processing_certificate, + &apple_pay_payment_processing_details.payment_processing_certificate_key, ) + .await .change_context(errors::ApiErrorResponse::InternalServerError) - .attach_printable("failed to parse PazeDecryptedData")?; - Ok(Some(PaymentMethodToken::PazeDecrypt(Box::new( - paze_decrypted_data, - )))) - } - TokenizationAction::DecryptGooglePayToken(payment_processing_details) => { - let google_pay_data = match payment_data.get_payment_method_data() { - Some(domain::PaymentMethodData::Wallet(domain::WalletData::GooglePay( - wallet_data, - ))) => { - let decryptor = helpers::GooglePayTokenDecryptor::new( - payment_processing_details - .google_pay_root_signing_keys - .clone(), - payment_processing_details.google_pay_recipient_id.clone(), - payment_processing_details.google_pay_private_key.clone(), - ) - .change_context(errors::ApiErrorResponse::InternalServerError) - .attach_printable("failed to create google pay token decryptor")?; + .attach_printable("failed to decrypt apple pay token")?; - // should_verify_token is set to false to disable verification of token - Some( - decryptor - .decrypt_token(wallet_data.tokenization_data.token.clone(), false) - .change_context(errors::ApiErrorResponse::InternalServerError) - .attach_printable("failed to decrypt google pay token")?, - ) - } - Some(payment_method_data) => { - logger::info!( - "Invalid payment_method_data found for Google Pay Decrypt Flow: {:?}", - payment_method_data.get_payment_method() - ); - None - } - None => { - logger::info!("No payment_method_data found for Google Pay Decrypt Flow"); - None - } - }; + let apple_pay_predecrypt = apple_pay_data + .parse_value::<hyperswitch_domain_models::router_data::ApplePayPredecryptData>( + "ApplePayPredecryptData", + ) + .change_context(errors::ApiErrorResponse::InternalServerError) + .attach_printable( + "failed to parse decrypted apple pay response to ApplePayPredecryptData", + )?; - let google_pay_predecrypt = google_pay_data - .ok_or(errors::ApiErrorResponse::InternalServerError) - .attach_printable("failed to get GooglePayDecryptedData in response")?; + Ok(PaymentMethodToken::ApplePayDecrypt(Box::new( + apple_pay_predecrypt, + ))) + } +} + +#[async_trait::async_trait] +impl<F, D> WalletFlow<F, D> for GooglePayWallet +where + F: Send + Clone, + D: OperationSessionGetters<F> + Send + Sync + Clone, +{ + fn decide_wallet_flow( + &self, + state: &SessionState, + _payment_data: &D, + merchant_connector_account: &helpers::MerchantConnectorAccountType, + ) -> CustomResult<Option<DecideWalletFlow>, errors::ApiErrorResponse> { + Ok( + get_google_pay_connector_wallet_details(state, merchant_connector_account) + .map(DecideWalletFlow::GooglePayDecrypt), + ) + } + + async fn decrypt_wallet_token( + &self, + wallet_flow: &DecideWalletFlow, + payment_data: &D, + ) -> CustomResult<PaymentMethodToken, errors::ApiErrorResponse> { + let google_pay_payment_processing_details = wallet_flow + .get_google_pay_payment_processing_details() + .get_required_value("Google Pay payment processing details") + .attach_printable( + "Google Pay payment processing details not found in Google Pay decryption flow", + )?; + + let google_pay_wallet_data = payment_data + .get_payment_method_data() + .and_then(\|payment_method_data\| payment_method_data.get_wallet_data()) + .and_then(\|wallet_data\| wallet_data.get_google_pay_wallet_data()) + .get_required_value("Paze wallet token").attach_printable( + "Google Pay wallet data not found in the payment method data during the Google Pay decryption flow", + )?; + + let decryptor = helpers::GooglePayTokenDecryptor::new( + google_pay_payment_processing_details + .google_pay_root_signing_keys + .clone(), + google_pay_payment_processing_details + .google_pay_recipient_id + .clone(), + google_pay_payment_processing_details + .google_pay_private_key + .clone(), + ) + .change_context(errors::ApiErrorResponse::InternalServerError) + .attach_printable("failed to create google pay token decryptor")?; + + // should_verify_token is set to false to disable verification of token + let google_pay_data = decryptor + .decrypt_token( + google_pay_wallet_data.tokenization_data.token.clone(), + false, + ) + .change_context(errors::ApiErrorResponse::InternalServerError) + .attach_printable("failed to decrypt google pay token")?; + + Ok(PaymentMethodToken::GooglePayDecrypt(Box::new( + google_pay_data, + ))) + } +} - Ok(Some(PaymentMethodToken::GooglePayDecrypt(Box::new( - google_pay_predecrypt, - )))) +#[derive(Debug, Clone)] +pub enum DecideWalletFlow { + ApplePayDecrypt(payments_api::PaymentProcessingDetails), + PazeDecrypt(PazePaymentProcessingDetails), + GooglePayDecrypt(GooglePayPaymentProcessingDetails), + SkipDecryption, +} + +impl DecideWalletFlow { + fn get_paze_payment_processing_details(&self) -> Option<&PazePaymentProcessingDetails> { + if let Self::PazeDecrypt(details) = self { + Some(details) + } else { + None } - TokenizationAction::ConnectorToken(_) => { - logger::info!("Invalid tokenization action found for decryption flow: ConnectorToken"); - Ok(None) + } + + fn get_apple_pay_payment_processing_details( + &self, + ) -> Option<&payments_api::PaymentProcessingDetails> { + if let Self::ApplePayDecrypt(details) = self { + Some(details) + } else { + None } - token_action => { - logger::info!( - "Invalid tokenization action found for decryption flow: {:?}", - token_action - ); - Ok(None) + } + + fn get_google_pay_payment_processing_details( + &self, + ) -> Option<&GooglePayPaymentProcessingDetails> { + if let Self::GooglePayDecrypt(details) = self { + Some(details) + } else { + None } } } @@ -5926,7 +6164,7 @@ fn is_payment_method_tokenization_enabled_for_connector( connector_name: &str, payment_method: storage::enums::PaymentMethod, payment_method_type: Option<storage::enums::PaymentMethodType>, - apple_pay_flow: &Option<domain::ApplePayFlow>, + payment_method_token: Option<&PaymentMethodToken>, ) -> RouterResult<bool> { let connector_tokenization_filter = state.conf.tokenization.0.get(connector_name); @@ -5942,7 +6180,7 @@ fn is_payment_method_tokenization_enabled_for_connector( ) && is_apple_pay_pre_decrypt_type_connector_tokenization( payment_method_type, - apple_pay_flow, + payment_method_token, connector_filter.apple_pay_pre_decrypt_flow.clone(), ) }) @@ -5951,13 +6189,13 @@ fn is_payment_method_tokenization_enabled_for_connector( fn is_apple_pay_pre_decrypt_type_connector_tokenization( payment_method_type: Option<storage::enums::PaymentMethodType>, - apple_pay_flow: &Option<domain::ApplePayFlow>, + payment_method_token: Option<&PaymentMethodToken>, apple_pay_pre_decrypt_flow_filter: Option<ApplePayPreDecryptFlow>, ) -> bool { - match (payment_method_type, apple_pay_flow) { + match (payment_method_type, payment_method_token) { ( Some(storage::enums::PaymentMethodType::ApplePay), - Some(domain::ApplePayFlow::Simplified(_)), + Some(PaymentMethodToken::ApplePayDecrypt(..)), ) => !matches!( apple_pay_pre_decrypt_flow_filter, Some(ApplePayPreDecryptFlow::NetworkTokenization) @@ -6142,58 +6380,20 @@ async fn decide_payment_method_tokenize_action( payment_intent_data: payments::PaymentIntent, pm_parent_token: Option<&str>, is_connector_tokenization_enabled: bool, - apple_pay_flow: Option<domain::ApplePayFlow>, - payment_method_type: Option<storage_enums::PaymentMethodType>, - merchant_connector_account: &helpers::MerchantConnectorAccountType, ) -> RouterResult<TokenizationAction> { - if let Some(storage_enums::PaymentMethodType::Paze) = payment_method_type { - // Paze generates a one time use network token which should not be tokenized in the connector or router. - match &state.conf.paze_decrypt_keys { - Some(paze_keys) => Ok(TokenizationAction::DecryptPazeToken( - PazePaymentProcessingDetails { - paze_private_key: paze_keys.get_inner().paze_private_key.clone(), - paze_private_key_passphrase: paze_keys - .get_inner() - .paze_private_key_passphrase - .clone(), - }, - )), - None => Err(errors::ApiErrorResponse::InternalServerError) - .attach_printable("Failed to fetch Paze configs"), - } - } else if let Some(storage_enums::PaymentMethodType::GooglePay) = payment_method_type { - let google_pay_details = - get_google_pay_connector_wallet_details(state, merchant_connector_account); - - match google_pay_details { - Some(wallet_details) => Ok(TokenizationAction::DecryptGooglePayToken(wallet_details)), - None => { - if is_connector_tokenization_enabled { - Ok(TokenizationAction::TokenizeInConnectorAndRouter) - } else { - Ok(TokenizationAction::TokenizeInRouter) - } - } - } - } else if matches!( + if matches!( payment_intent_data.split_payments, Some(common_types::payments::SplitPaymentsRequest::StripeSplitPayment(_)) ) { Ok(TokenizationAction::TokenizeInConnector) } else { match pm_parent_token { - None => Ok(match (is_connector_tokenization_enabled, apple_pay_flow) { - (true, Some(domain::ApplePayFlow::Simplified(payment_processing_details))) => { - TokenizationAction::TokenizeInConnectorAndApplepayPreDecrypt( - payment_processing_details, - ) - } - (true, _) => TokenizationAction::TokenizeInConnectorAndRouter, - (false, Some(domain::ApplePayFlow::Simplified(payment_processing_details))) => { - TokenizationAction::DecryptApplePayToken(payment_processing_details) - } - (false, _) => TokenizationAction::TokenizeInRouter, + None => Ok(if is_connector_tokenization_enabled { + TokenizationAction::TokenizeInConnectorAndRouter + } else { + TokenizationAction::TokenizeInRouter }), + Some(token) => { let redis_conn = state .store @@ -6218,19 +6418,10 @@ async fn decide_payment_method_tokenize_action( Some(connector_token) => { Ok(TokenizationAction::ConnectorToken(connector_token)) } - None => Ok(match (is_connector_tokenization_enabled, apple_pay_flow) { - ( - true, - Some(domain::ApplePayFlow::Simplified(payment_processing_details)), - ) => TokenizationAction::TokenizeInConnectorAndApplepayPreDecrypt( - payment_processing_details, - ), - (true, _) => TokenizationAction::TokenizeInConnectorAndRouter, - ( - false, - Some(domain::ApplePayFlow::Simplified(payment_processing_details)), - ) => TokenizationAction::DecryptApplePayToken(payment_processing_details), - (false, _) => TokenizationAction::TokenizeInRouter, + None => Ok(if is_connector_tokenization_enabled { + TokenizationAction::TokenizeInConnectorAndRouter + } else { + TokenizationAction::TokenizeInRouter }), } } @@ -6258,10 +6449,6 @@ pub enum TokenizationAction { TokenizeInConnectorAndRouter, ConnectorToken(String), SkipConnectorTokenization, - DecryptApplePayToken(payments_api::PaymentProcessingDetails), - TokenizeInConnectorAndApplepayPreDecrypt(payments_api::PaymentProcessingDetails), - DecryptPazeToken(PazePaymentProcessingDetails), - DecryptGooglePayToken(GooglePayPaymentProcessingDetails), } #[cfg(feature = "v2")] @@ -6271,7 +6458,6 @@ pub async fn get_connector_tokenization_action_when_confirm_true<F, Req, D>( _operation: &BoxedOperation<'_, F, Req, D>, payment_data: &mut D, _validate_result: &operations::ValidateResult, - _merchant_connector_account: &helpers::MerchantConnectorAccountType, _merchant_key_store: &domain::MerchantKeyStore, _customer: &Option<domain::Customer>, _business_profile: &domain::Profile, @@ -6292,7 +6478,6 @@ pub async fn get_connector_tokenization_action_when_confirm_true<F, Req, D>( operation: &BoxedOperation<'_, F, Req, D>, payment_data: &mut D, validate_result: &operations::ValidateResult, - merchant_connector_account: &helpers::MerchantConnectorAccountType, merchant_key_store: &domain::MerchantKeyStore, customer: &Option<domain::Customer>, business_profile: &domain::Profile, @@ -6327,24 +6512,15 @@ where .get_required_value("payment_method")?; let payment_method_type = payment_data.get_payment_attempt().payment_method_type; - let apple_pay_flow = - decide_apple_pay_flow(state, payment_method_type, Some(merchant_connector_account)); - let is_connector_tokenization_enabled = is_payment_method_tokenization_enabled_for_connector( state, &connector, payment_method, payment_method_type, - &apple_pay_flow, + payment_data.get_payment_method_token(), )?; - add_apple_pay_flow_metrics( - &apple_pay_flow, - payment_data.get_payment_attempt().connector.clone(), - payment_data.get_payment_attempt().merchant_id.clone(), - ); - let payment_method_action = decide_payment_method_tokenize_action( state, &connector, @@ -6352,9 +6528,6 @@ where payment_data.get_payment_intent().clone(), payment_data.get_token(), is_connector_tokenization_enabled, - apple_pay_flow, - payment_method_type, - merchant_connector_account, ) .await?; @@ -6377,7 +6550,6 @@ where TokenizationAction::SkipConnectorTokenization } - TokenizationAction::TokenizeInConnector => TokenizationAction::TokenizeInConnector, TokenizationAction::TokenizeInConnectorAndRouter => { let (_operation, payment_method_data, pm_id) = operation @@ -6404,22 +6576,6 @@ where TokenizationAction::SkipConnectorTokenization => { TokenizationAction::SkipConnectorTokenization } - TokenizationAction::DecryptApplePayToken(payment_processing_details) => { - TokenizationAction::DecryptApplePayToken(payment_processing_details) - } - TokenizationAction::TokenizeInConnectorAndApplepayPreDecrypt( - payment_processing_details, - ) => TokenizationAction::TokenizeInConnectorAndApplepayPreDecrypt( - payment_processing_details, - ), - TokenizationAction::DecryptPazeToken(paze_payment_processing_details) => { - TokenizationAction::DecryptPazeToken(paze_payment_processing_details) - } - TokenizationAction::DecryptGooglePayToken( - google_pay_payment_processing_details, - ) => { - TokenizationAction::DecryptGooglePayToken(google_pay_payment_processing_details) - } }; (payment_data.to_owned(), connector_tokenization_action) } @@ -6520,6 +6676,7 @@ where pub force_sync: Option<bool>, pub all_keys_required: Option<bool>, pub payment_method_data: Option<domain::PaymentMethodData>, + pub payment_method_token: Option<PaymentMethodToken>, pub payment_method_info: Option<domain::PaymentMethod>, pub refunds: Vec<diesel_refund::Refund>, pub disputes: Vec<storage::Dispute>, @@ -9405,6 +9562,7 @@ pub trait OperationSessionGetters<F> { #[cfg(feature = "v2")] fn get_client_secret(&self) -> &Option<Secret<String>>; fn get_payment_method_info(&self) -> Option<&domain::PaymentMethod>; + fn get_payment_method_token(&self) -> Option<&PaymentMethodToken>; fn get_mandate_id(&self) -> Option<&payments_api::MandateIds>; fn get_address(&self) -> &PaymentAddress; fn get_creds_identifier(&self) -> Option<&str>; @@ -9470,6 +9628,7 @@ pub trait OperationSessionSetters<F> { fn set_client_secret(&mut self, client_secret: Option<Secret<String>>); fn set_payment_attempt(&mut self, payment_attempt: storage::PaymentAttempt); fn set_payment_method_data(&mut self, payment_method_data: Option<domain::PaymentMethodData>); + fn set_payment_method_token(&mut self, payment_method_token: Option<PaymentMethodToken>); fn set_email_if_not_present(&mut self, email: pii::Email); fn set_payment_method_id_in_attempt(&mut self, payment_method_id: Option<String>); fn set_pm_token(&mut self, token: String); @@ -9553,6 +9712,10 @@ impl<F: Clone> OperationSessionGetters<F> for PaymentData<F> { self.payment_method_info.as_ref() } + fn get_payment_method_token(&self) -> Option<&PaymentMethodToken> { + self.payment_method_token.as_ref() + } + fn get_mandate_id(&self) -> Option<&payments_api::MandateIds> { self.mandate_id.as_ref() } @@ -9717,6 +9880,10 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentData<F> { self.payment_method_data = payment_method_data; } + fn set_payment_method_token(&mut self, payment_method_token: Option<PaymentMethodToken>) { + self.payment_method_token = payment_method_token; + } + fn set_payment_method_id_in_attempt(&mut self, payment_method_id: Option<String>) { self.payment_attempt.payment_method_id = payment_method_id; } @@ -9749,10 +9916,24 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentData<F> { } fn set_card_network(&mut self, card_network: enums::CardNetwork) { - if let Some(domain::PaymentMethodData::Card(card)) = &mut self.payment_method_data { - logger::debug!("set card network {:?}", card_network.clone()); - card.card_network = Some(card_network); - }; + match &mut self.payment_method_data { + Some(domain::PaymentMethodData::Card(card)) => { + logger::debug!("Setting card network: {:?}", card_network); + card.card_network = Some(card_network); + } + Some(domain::PaymentMethodData::Wallet(wallet_data)) => match wallet_data { + hyperswitch_domain_models::payment_method_data::WalletData::ApplePay(wallet) => { + logger::debug!("Setting Apple Pay card network: {:?}", card_network); + wallet.payment_method.network = card_network.to_string(); + } + _ => { + logger::debug!("Wallet type does not support setting card network."); + } + }, + _ => { + logger::warn!("Payment method data does not support setting card network."); + } + } } fn set_co_badged_card_data( @@ -9878,6 +10059,10 @@ impl<F: Clone> OperationSessionGetters<F> for PaymentIntentData<F> { todo!() } + fn get_payment_method_token(&self) -> Option<&PaymentMethodToken> { + todo!() + } + fn get_mandate_id(&self) -> Option<&payments_api::MandateIds> { todo!() } @@ -10042,6 +10227,10 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentIntentData<F> { todo!() } + fn set_payment_method_token(&mut self, _payment_method_token: Option<PaymentMethodToken>) { + todo!() + } + fn set_payment_method_id_in_attempt(&mut self, _payment_method_id: Option<String>) { todo!() } @@ -10179,6 +10368,10 @@ impl<F: Clone> OperationSessionGetters<F> for PaymentConfirmData<F> { todo!() } + fn get_payment_method_token(&self) -> Option<&PaymentMethodToken> { + todo!() + } + fn get_mandate_id(&self) -> Option<&payments_api::MandateIds> { todo!() } @@ -10340,6 +10533,10 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentConfirmData<F> { todo!() } + fn set_payment_method_token(&mut self, _payment_method_token: Option<PaymentMethodToken>) { + todo!() + } + fn set_payment_method_id_in_attempt(&mut self, _payment_method_id: Option<String>) { todo!() } @@ -10478,6 +10675,10 @@ impl<F: Clone> OperationSessionGetters<F> for PaymentStatusData<F> { todo!() } + fn get_payment_method_token(&self) -> Option<&PaymentMethodToken> { + todo!() + } + fn get_mandate_id(&self) -> Option<&payments_api::MandateIds> { todo!() } @@ -10635,6 +10836,10 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentStatusData<F> { todo!() } + fn set_payment_method_token(&mut self, _payment_method_token: Option<PaymentMethodToken>) { + todo!() + } + fn set_payment_method_id_in_attempt(&mut self, _payment_method_id: Option<String>) { todo!() } @@ -10772,6 +10977,10 @@ impl<F: Clone> OperationSessionGetters<F> for PaymentCaptureData<F> { todo!() } + fn get_payment_method_token(&self) -> Option<&PaymentMethodToken> { + todo!() + } + fn get_mandate_id(&self) -> Option<&payments_api::MandateIds> { todo!() } @@ -10931,6 +11140,10 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentCaptureData<F> { todo!() } + fn set_payment_method_token(&mut self, _payment_method_token: Option<PaymentMethodToken>) { + todo!() + } + fn set_payment_method_id_in_attempt(&mut self, _payment_method_id: Option<String>) { todo!() } @@ -11063,6 +11276,10 @@ impl<F: Clone> OperationSessionGetters<F> for PaymentAttemptListData<F> { todo!() } + fn get_payment_method_token(&self) -> Option<&PaymentMethodToken> { + todo!() + } + fn get_mandate_id(&self) -> Option<&payments_api::MandateIds> { todo!() } diff --git a/crates/router/src/core/payments/operations/payment_approve.rs b/crates/router/src/core/payments/operations/payment_approve.rs index a16c2cd433f..8beac4097a9 100644 --- a/crates/router/src/core/payments/operations/payment_approve.rs +++ b/crates/router/src/core/payments/operations/payment_approve.rs @@ -173,6 +173,7 @@ impl<F: Send + Clone + Sync> GetTracker<F, PaymentData<F>, api::PaymentsCaptureR ), confirm: None, payment_method_data: None, + payment_method_token: None, payment_method_info: None, force_sync: None, all_keys_required: None, diff --git a/crates/router/src/core/payments/operations/payment_cancel.rs b/crates/router/src/core/payments/operations/payment_cancel.rs index 343c1f98a9d..dfe3657b0f7 100644 --- a/crates/router/src/core/payments/operations/payment_cancel.rs +++ b/crates/router/src/core/payments/operations/payment_cancel.rs @@ -184,6 +184,7 @@ impl<F: Send + Clone + Sync> GetTracker<F, PaymentData<F>, api::PaymentsCancelRe ), confirm: None, payment_method_data: None, + payment_method_token: None, payment_method_info: None, force_sync: None, all_keys_required: None, diff --git a/crates/router/src/core/payments/operations/payment_capture.rs b/crates/router/src/core/payments/operations/payment_capture.rs index 8e3a765b8ad..6108ed3658f 100644 --- a/crates/router/src/core/payments/operations/payment_capture.rs +++ b/crates/router/src/core/payments/operations/payment_capture.rs @@ -235,6 +235,7 @@ impl<F: Send + Clone + Sync> GetTracker<F, payments::PaymentData<F>, api::Paymen ), confirm: None, payment_method_data: None, + payment_method_token: None, payment_method_info: None, refunds: vec![], disputes: vec![], diff --git a/crates/router/src/core/payments/operations/payment_complete_authorize.rs b/crates/router/src/core/payments/operations/payment_complete_authorize.rs index 3ce888e6574..38a189e50fd 100644 --- a/crates/router/src/core/payments/operations/payment_complete_authorize.rs +++ b/crates/router/src/core/payments/operations/payment_complete_authorize.rs @@ -332,6 +332,7 @@ impl<F: Send + Clone + Sync> GetTracker<F, PaymentData<F>, api::PaymentsRequest> .payment_method_data .as_ref() .and_then(\|pmd\| pmd.payment_method_data.clone().map(Into::into)), + payment_method_token: None, payment_method_info, force_sync: None, all_keys_required: None, diff --git a/crates/router/src/core/payments/operations/payment_confirm.rs b/crates/router/src/core/payments/operations/payment_confirm.rs index 2aa1a72e73f..abbdc1f5c75 100644 --- a/crates/router/src/core/payments/operations/payment_confirm.rs +++ b/crates/router/src/core/payments/operations/payment_confirm.rs @@ -795,6 +795,7 @@ impl<F: Send + Clone + Sync> GetTracker<F, PaymentData<F>, api::PaymentsRequest> token_data, confirm: request.confirm, payment_method_data: payment_method_data_after_card_bin_call.map(Into::into), + payment_method_token: None, payment_method_info, force_sync: None, all_keys_required: None, diff --git a/crates/router/src/core/payments/operations/payment_create.rs b/crates/router/src/core/payments/operations/payment_create.rs index a73796075a5..1c3a8a0be9a 100644 --- a/crates/router/src/core/payments/operations/payment_create.rs +++ b/crates/router/src/core/payments/operations/payment_create.rs @@ -598,6 +598,7 @@ impl<F: Send + Clone + Sync> GetTracker<F, PaymentData<F>, api::PaymentsRequest> token_data: None, confirm: request.confirm, payment_method_data: payment_method_data_after_card_bin_call.map(Into::into), + payment_method_token: None, payment_method_info, refunds: vec![], disputes: vec![], diff --git a/crates/router/src/core/payments/operations/payment_post_session_tokens.rs b/crates/router/src/core/payments/operations/payment_post_session_tokens.rs index 3df1da1827e..b1543be1544 100644 --- a/crates/router/src/core/payments/operations/payment_post_session_tokens.rs +++ b/crates/router/src/core/payments/operations/payment_post_session_tokens.rs @@ -145,6 +145,7 @@ impl<F: Send + Clone + Sync> GetTracker<F, PaymentData<F>, api::PaymentsPostSess ), confirm: None, payment_method_data: None, + payment_method_token: None, payment_method_info: None, force_sync: None, all_keys_required: None, diff --git a/crates/router/src/core/payments/operations/payment_reject.rs b/crates/router/src/core/payments/operations/payment_reject.rs index 33ec9a0d592..f963baa87c1 100644 --- a/crates/router/src/core/payments/operations/payment_reject.rs +++ b/crates/router/src/core/payments/operations/payment_reject.rs @@ -171,6 +171,7 @@ impl<F: Send + Clone + Sync> GetTracker<F, PaymentData<F>, PaymentsCancelRequest token_data: None, confirm: None, payment_method_data: None, + payment_method_token: None, payment_method_info: None, force_sync: None, all_keys_required: None, diff --git a/crates/router/src/core/payments/operations/payment_session.rs b/crates/router/src/core/payments/operations/payment_session.rs index b0a5f2fc133..8a7c22376a0 100644 --- a/crates/router/src/core/payments/operations/payment_session.rs +++ b/crates/router/src/core/payments/operations/payment_session.rs @@ -193,6 +193,7 @@ impl<F: Send + Clone + Sync> GetTracker<F, PaymentData<F>, api::PaymentsSessionR ), confirm: None, payment_method_data: None, + payment_method_token: None, payment_method_info: None, force_sync: None, all_keys_required: None, diff --git a/crates/router/src/core/payments/operations/payment_start.rs b/crates/router/src/core/payments/operations/payment_start.rs index e702ba1ef50..9727fb399d2 100644 --- a/crates/router/src/core/payments/operations/payment_start.rs +++ b/crates/router/src/core/payments/operations/payment_start.rs @@ -181,6 +181,7 @@ impl<F: Send + Clone + Sync> GetTracker<F, PaymentData<F>, api::PaymentsStartReq confirm: Some(payment_attempt.confirm), payment_attempt, payment_method_data: None, + payment_method_token: None, payment_method_info: None, force_sync: None, all_keys_required: None, diff --git a/crates/router/src/core/payments/operations/payment_status.rs b/crates/router/src/core/payments/operations/payment_status.rs index ac2a7b923fd..c6488bdb75c 100644 --- a/crates/router/src/core/payments/operations/payment_status.rs +++ b/crates/router/src/core/payments/operations/payment_status.rs @@ -517,6 +517,7 @@ async fn get_tracker_for_sync< token_data: None, confirm: Some(request.force_sync), payment_method_data: None, + payment_method_token: None, payment_method_info, force_sync: Some( request.force_sync diff --git a/crates/router/src/core/payments/operations/payment_update.rs b/crates/router/src/core/payments/operations/payment_update.rs index 2299acbe304..0b77e5c31c4 100644 --- a/crates/router/src/core/payments/operations/payment_update.rs +++ b/crates/router/src/core/payments/operations/payment_update.rs @@ -475,6 +475,7 @@ impl<F: Send + Clone + Sync> GetTracker<F, PaymentData<F>, api::PaymentsRequest> .payment_method_data .as_ref() .and_then(\|pmd\| pmd.payment_method_data.clone().map(Into::into)), + payment_method_token: None, payment_method_info, force_sync: None, all_keys_required: None, diff --git a/crates/router/src/core/payments/operations/payment_update_metadata.rs b/crates/router/src/core/payments/operations/payment_update_metadata.rs index 2c6841c44a4..23a300c3c8b 100644 --- a/crates/router/src/core/payments/operations/payment_update_metadata.rs +++ b/crates/router/src/core/payments/operations/payment_update_metadata.rs @@ -131,6 +131,7 @@ impl<F: Send + Clone + Sync> GetTracker<F, PaymentData<F>, api::PaymentsUpdateMe address: payments::PaymentAddress::new(None, None, None, None), confirm: None, payment_method_data: None, + payment_method_token: None, payment_method_info: None, force_sync: None, all_keys_required: None, diff --git a/crates/router/src/core/payments/operations/payments_incremental_authorization.rs b/crates/router/src/core/payments/operations/payments_incremental_authorization.rs index e5262d092c1..a32f89ef4d3 100644 --- a/crates/router/src/core/payments/operations/payments_incremental_authorization.rs +++ b/crates/router/src/core/payments/operations/payments_incremental_authorization.rs @@ -145,6 +145,7 @@ impl<F: Send + Clone + Sync> address: PaymentAddress::new(None, None, None, None), confirm: None, payment_method_data: None, + payment_method_token: None, payment_method_info: None, force_sync: None, all_keys_required: None, diff --git a/crates/router/src/core/payments/operations/tax_calculation.rs b/crates/router/src/core/payments/operations/tax_calculation.rs index 85ad5fb1cb6..9f0863e6767 100644 --- a/crates/router/src/core/payments/operations/tax_calculation.rs +++ b/crates/router/src/core/payments/operations/tax_calculation.rs @@ -160,6 +160,7 @@ impl<F: Send + Clone + Sync> ), confirm: None, payment_method_data: None, + payment_method_token: None, payment_method_info: None, force_sync: None, all_keys_required: None, diff --git a/crates/router/src/core/payments/tokenization.rs b/crates/router/src/core/payments/tokenization.rs index f4389bc1738..d6578ad36c7 100644 --- a/crates/router/src/core/payments/tokenization.rs +++ b/crates/router/src/core/payments/tokenization.rs @@ -1253,8 +1253,7 @@ pub async fn add_payment_method_token<F: Clone, T: types::Tokenizable + Clone>( ) -> RouterResult<types::PaymentMethodTokenResult> { if should_continue_payment { match tokenization_action { - payments::TokenizationAction::TokenizeInConnector - \| payments::TokenizationAction::TokenizeInConnectorAndApplepayPreDecrypt(_) => { + payments::TokenizationAction::TokenizeInConnector => { let connector_integration: services::BoxedPaymentConnectorIntegrationInterface< api::PaymentMethodToken, types::PaymentMethodTokenizationData,	2025-07-17T07:05:49Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> This pull request adds debit routing support for Apple Pay. In the Apple Pay decryption flow, if debit routing is enabled by the merchant and the card type is debit, a call will be made to the decision engine to retrieve the supported card networks and the potential debit routing savings. Among these networks, the lowest-cost network will be selected to process the Apple Pay payment. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> -> enable debit routing and make a apple pay payment ``` curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_tT5kUVUp7uaQHR2Z824Iy7393nL5sEWLxAvJblCxxmttLizAkJbWtsdgoIjdGQE2' \ --data-raw '{ "amount": 650, "currency": "USD", "confirm": true, "business_country": "US", "business_label": "default", "amount_to_capture": 650, "customer_id": "cu_1752747625", "capture_method": "automatic", "capture_on": "2022-09-10T10:11:12Z", "setup_future_usage": "on_session", "authentication_type": "no_three_ds", "return_url": "https://google.com", "email": "[email protected]", "name": "Joseph Doe", "phone": "999999999", "phone_country_code": "+65", "description": "Its my first payment request", "statement_descriptor_name": "Juspay", "statement_descriptor_suffix": "Router", "payment_method": "wallet", "payment_method_type": "apple_pay", "billing": { "address": { "line1": "1467", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" }, "phone": { "number": "8056594427", "country_code": "+91" } }, "customer_acceptance": { "acceptance_type": "offline", "accepted_at": "1963-05-03T04:07:52.723Z", "online": { "ip_address": "in sit", "user_agent": "amet irure esse" } } , "payment_method_data": { "wallet": { "apple_pay": { "payment_data": "==", "payment_method": { "display_name": "Discover 9319", "network": "Discover", "type": "debit" }, "transaction_identifier": "c635c5b3af900d7bd81fecd7028f1262f9d030754ee65ec7afd988a678194751" } } } }' ``` ``` { "payment_id": "pay_O0EoroDslloH3cVj5Xc5", "merchant_id": "merchant_1752747413", "status": "succeeded", "amount": 650, "net_amount": 650, "shipping_cost": null, "amount_capturable": 0, "amount_received": 650, "connector": "adyen", "client_secret": "pay_O0EoroDslloH3cVj5Xc5_secret_mEciQ25Sjl46cuShfITO", "created": "2025-07-17T10:18:35.495Z", "currency": "USD", "customer_id": "cu_1752747515", "customer": { "id": "cu_1752747515", "name": "Joseph Doe", "email": "[email protected]", "phone": "999999999", "phone_country_code": "+65" }, "description": "Its my first payment request", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": "on_session", "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "wallet", "payment_method_data": { "wallet": { "apple_pay": { "last4": "9319", "card_network": "Accel", "type": "debit" } }, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": null, "line3": null, "zip": "94122", "state": "California", "first_name": "joseph", "last_name": "Doe" }, "phone": { "number": "8056594427", "country_code": "+91" }, "email": null }, "order_details": null, "email": "[email protected]", "name": "Joseph Doe", "phone": "999999999", "return_url": "https://google.com/", "authentication_type": "no_three_ds", "statement_descriptor_name": "Juspay", "statement_descriptor_suffix": "Router", "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "apple_pay", "connector_label": "adyen_US_default", "business_country": "US", "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": { "customer_id": "cu_1752747515", "created_at": 1752747515, "expires": 1752751115, "secret": "epk_e7dc207a6f124b47a191ba2daf803e6b" }, "manual_retry_allowed": false, "connector_transaction_id": "P3TQQMQMMQ6M5375", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_O0EoroDslloH3cVj5Xc5_1", "payment_link": null, "profile_id": "pro_0BT05CUisTpwMzBcK4wf", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_dITrhiR4JCNaaJFsaPGH", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-07-17T10:33:35.495Z", "fingerprint": null, "browser_info": null, "payment_method_id": null, "payment_method_status": null, "updated": "2025-07-17T10:18:40.793Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": null, "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` -> Decision engine lookup using 8 digits bin with padded 0s for lookup <img width="1382" height="303" alt="image" src="https://github.com/user-attachments/assets/84305a47-c56c-46e5-bb4e-685e51d7e736" /> ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	bf8dc4959eab4e2a2ca8120055ff80900418fe0b	bf8dc4959eab4e2a2ca8120055ff80900418fe0b
juspay/hyperswitch	juspay__hyperswitch-8668	Bug: [REFACTOR] : Add feature metadata in payments response Currently we are adding feature metadata in the Payment Response. We'll incrementally populate the fields	diff --git a/api-reference/v2/openapi_spec_v2.json b/api-reference/v2/openapi_spec_v2.json index 285a21ba04c..7b4f04a2292 100644 --- a/api-reference/v2/openapi_spec_v2.json +++ b/api-reference/v2/openapi_spec_v2.json @@ -10838,7 +10838,7 @@ ], "nullable": true }, - "payment_revenue_recovery_metadata": { + "revenue_recovery": { "allOf": [ { "$ref": "#/components/schemas/PaymentRevenueRecoveryMetadata" @@ -19319,6 +19319,14 @@ "type": "string", "description": "Stringified connector raw response body. Only returned if `return_raw_connector_response` is true", "nullable": true + }, + "feature_metadata": { + "allOf": [ + { + "$ref": "#/components/schemas/FeatureMetadata" + } + ], + "nullable": true } } }, diff --git a/crates/api_models/src/payments.rs b/crates/api_models/src/payments.rs index f3d7d9b675c..cef094a98d5 100644 --- a/crates/api_models/src/payments.rs +++ b/crates/api_models/src/payments.rs @@ -5808,6 +5808,9 @@ pub struct PaymentsResponse { /// Stringified connector raw response body. Only returned if `return_raw_connector_response` is true #[schema(value_type = Option<String>)] pub raw_connector_response: Option<Secret<String>>, + + /// Additional data that might be required by hyperswitch based on the additional features. + pub feature_metadata: Option<FeatureMetadata>, } #[cfg(feature = "v2")] @@ -7823,13 +7826,13 @@ pub struct FeatureMetadata { /// Recurring payment details required for apple pay Merchant Token pub apple_pay_recurring_details: Option<ApplePayRecurringDetails>, /// revenue recovery data for payment intent - pub payment_revenue_recovery_metadata: Option<PaymentRevenueRecoveryMetadata>, + pub revenue_recovery: Option<PaymentRevenueRecoveryMetadata>, } #[cfg(feature = "v2")] impl FeatureMetadata { pub fn get_retry_count(&self) -> Option<u16> { - self.payment_revenue_recovery_metadata + self.revenue_recovery .as_ref() .map(\|metadata\| metadata.total_retry_count) } @@ -7842,7 +7845,7 @@ impl FeatureMetadata { redirect_response: self.redirect_response, search_tags: self.search_tags, apple_pay_recurring_details: self.apple_pay_recurring_details, - payment_revenue_recovery_metadata: Some(payment_revenue_recovery_metadata), + revenue_recovery: Some(payment_revenue_recovery_metadata), } } } diff --git a/crates/hyperswitch_domain_models/src/lib.rs b/crates/hyperswitch_domain_models/src/lib.rs index 35f619334c3..fd24c3d9f4b 100644 --- a/crates/hyperswitch_domain_models/src/lib.rs +++ b/crates/hyperswitch_domain_models/src/lib.rs @@ -145,7 +145,7 @@ impl ApiModelToDieselModelConvertor<ApiFeatureMetadata> for FeatureMetadata { redirect_response, search_tags, apple_pay_recurring_details, - payment_revenue_recovery_metadata, + revenue_recovery: payment_revenue_recovery_metadata, } = from; Self { @@ -172,8 +172,7 @@ impl ApiModelToDieselModelConvertor<ApiFeatureMetadata> for FeatureMetadata { search_tags, apple_pay_recurring_details: apple_pay_recurring_details .map(\|value\| value.convert_back()), - payment_revenue_recovery_metadata: payment_revenue_recovery_metadata - .map(\|value\| value.convert_back()), + revenue_recovery: payment_revenue_recovery_metadata.map(\|value\| value.convert_back()), } } } diff --git a/crates/router/src/core/payments/transformers.rs b/crates/router/src/core/payments/transformers.rs index 1df3b6ef293..6785e429984 100644 --- a/crates/router/src/core/payments/transformers.rs +++ b/crates/router/src/core/payments/transformers.rs @@ -1989,6 +1989,7 @@ where is_iframe_redirection_enabled: None, merchant_reference_id: payment_intent.merchant_reference_id.clone(), raw_connector_response, + feature_metadata: None, }; Ok(services::ApplicationResponse::JsonWithHeaders(( @@ -2089,6 +2090,7 @@ where is_iframe_redirection_enabled: payment_intent.is_iframe_redirection_enabled, merchant_reference_id: payment_intent.merchant_reference_id.clone(), raw_connector_response, + feature_metadata: None, }; Ok(services::ApplicationResponse::JsonWithHeaders(( @@ -5215,7 +5217,7 @@ impl ForeignFrom<&diesel_models::types::FeatureMetadata> for api_models::payment .clone() .map(api_models::payments::RedirectResponse::foreign_from); Self { - payment_revenue_recovery_metadata: revenue_recovery, + revenue_recovery, apple_pay_recurring_details: apple_pay_details, redirect_response: redirect_res, search_tags: feature_metadata.search_tags.clone(),	2025-07-16T14:37:24Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description Add feature_metadata in the payments response for revenue recovery in v2. Also added it in the open api spec ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> ## How did you test it? - Create a Org and MA and MCA in v2 - Create a payment in v2 ``` curl --location 'http://localhost:8080/v2/payments/create-intent' \ --header 'api-key: dev_RvJ0UsrpfypkXccsGyytfee97LjWGSymDBIoR2K1zpxmUvaDScyXr9e4QH5cSUKc' \ --header 'Content-Type: application/json' \ --header 'x-profile-id: pro_xwf1Kn6sgcq34ih9HHPa' \ --header 'Authorization: api-key=dev_RvJ0UsrpfypkXccsGyytfee97LjWGSymDBIoR2K1zpxmUvaDScyXr9e4QH5cSUKc' \ --data-raw '{ "amount_details": { "order_amount": 100, "currency": "USD" }, "capture_method": "manual", "authentication_type": "no_three_ds", "billing": { "address": { "first_name": "John", "last_name": "Dough" }, "email": "[email protected]" }, "shipping": { "address": { "first_name": "John", "last_name": "Dough", "city": "Karwar", "zip": "581301", "state": "Karnataka" }, "email": "[email protected]" } }' ``` - Confirm the payment ``` Request curl --location 'http://localhost:8080/v2/payments/12345_pay_019813ec28f073d38d5fe2d117a0a660/confirm-intent' \ --header 'x-client-secret: cs_019813ec291571039181693bb212e6dd' \ --header 'x-profile-id: pro_xwf1Kn6sgcq34ih9HHPa' \ --header 'Authorization: api-key=dev_RvJ0UsrpfypkXccsGyytfee97LjWGSymDBIoR2K1zpxmUvaDScyXr9e4QH5cSUKc' \ --header 'Content-Type: application/json' \ --header 'api-key: dev_RvJ0UsrpfypkXccsGyytfee97LjWGSymDBIoR2K1zpxmUvaDScyXr9e4QH5cSUKc' \ --data '{ "payment_method_data": { "card": { "card_number": "4242424242424242", "card_exp_month": "01", "card_exp_year": "25", "card_holder_name": "John Doe", "card_cvc": "100" } }, "payment_method_type": "card", "payment_method_subtype": "credit" }' ``` - Feature Metadata would be present ``` Response { "id": "12345_pay_019813ec28f073d38d5fe2d117a0a660", "status": "failed", "amount": { "order_amount": 100, "currency": "USD", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null, "net_amount": 100, "amount_to_capture": null, "amount_capturable": 0, "amount_captured": null }, "customer_id": null, "connector": "stripe", "created": "2025-07-16T15:48:20.872Z", "payment_method_data": { "billing": null }, "payment_method_type": "card", "payment_method_subtype": "credit", "connector_transaction_id": null, "connector_reference_id": null, "merchant_connector_id": "mca_to621nCh9AUHtzEEgQWp", "browser_info": null, "error": { "code": "No error code", "message": "No error message", "unified_code": null, "unified_message": null, "network_advice_code": null, "network_decline_code": null, "network_error_message": null }, "shipping": null, "billing": null, "attempts": null, "connector_token_details": null, "payment_method_id": null, "next_action": null, "return_url": "https://google.com/success", "authentication_type": "no_three_ds", "authentication_type_applied": "no_three_ds", "is_iframe_redirection_enabled": null, "merchant_reference_id": null, "raw_connector_response": null, "feature_metadata": null } ``` ## Checklist <!-- Put an `x` in the boxes that apply --> - [ ] I formatted the code `cargo +nightly fmt --all` - [ ] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	9bc02516d6ca4ce1a998f0a7c800ca1eaa078ad7	9bc02516d6ca4ce1a998f0a7c800ca1eaa078ad7
juspay/hyperswitch	juspay__hyperswitch-8674	Bug: [FEATURE] TRUSTPAYMENTS Template Code ### Feature Description TRUSTPAYMENTS Template Code ### Possible Implementation [FEATURE] TRUSTPAYMENTS Template Code ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? None	diff --git a/config/config.example.toml b/config/config.example.toml index 9454b3f0adc..cf514a273d6 100644 --- a/config/config.example.toml +++ b/config/config.example.toml @@ -297,6 +297,7 @@ thunes.base_url = "https://api.limonetikqualif.com/" tokenio.base_url = "https://api.sandbox.token.io" stripe.base_url_file_upload = "https://files.stripe.com/" trustpay.base_url = "https://test-tpgw.trustpay.eu/" +trustpayments.base_url = "https://webservices.securetrading.net/" trustpay.base_url_bank_redirects = "https://aapi.trustpay.eu/" tsys.base_url = "https://stagegw.transnox.com/" unified_authentication_service.base_url = "http://localhost:8000" diff --git a/config/deployments/integration_test.toml b/config/deployments/integration_test.toml index ddff65fa9c0..d9194dfa9c7 100644 --- a/config/deployments/integration_test.toml +++ b/config/deployments/integration_test.toml @@ -133,6 +133,7 @@ taxjar.base_url = "https://api.sandbox.taxjar.com/v2/" thunes.base_url = "https://api.limonetikqualif.com/" tokenio.base_url = "https://api.sandbox.token.io" trustpay.base_url = "https://test-tpgw.trustpay.eu/" +trustpayments.base_url = "https://webservices.securetrading.net/" trustpay.base_url_bank_redirects = "https://aapi.trustpay.eu/" tsys.base_url = "https://stagegw.transnox.com/" vgs.base_url = "https://sandbox.vault-api.verygoodvault.com" diff --git a/config/deployments/production.toml b/config/deployments/production.toml index 11d96d6269f..ca52d4d39f3 100644 --- a/config/deployments/production.toml +++ b/config/deployments/production.toml @@ -137,6 +137,7 @@ taxjar.base_url = "https://api.taxjar.com/v2/" thunes.base_url = "https://api.limonetik.com/" tokenio.base_url = "https://api.token.io" trustpay.base_url = "https://tpgw.trustpay.eu/" +trustpayments.base_url = "https://webservices.securetrading.net/" trustpay.base_url_bank_redirects = "https://aapi.trustpay.eu/" tsys.base_url = "https://gateway.transit-pass.com/" vgs.base_url = "https://sandbox.vault-api.verygoodvault.com" diff --git a/config/deployments/sandbox.toml b/config/deployments/sandbox.toml index a372c873c78..c7f3949075d 100644 --- a/config/deployments/sandbox.toml +++ b/config/deployments/sandbox.toml @@ -137,6 +137,7 @@ taxjar.base_url = "https://api.sandbox.taxjar.com/v2/" thunes.base_url = "https://api.limonetikqualif.com/" tokenio.base_url = "https://api.sandbox.token.io" trustpay.base_url = "https://test-tpgw.trustpay.eu/" +trustpayments.base_url = "https://webservices.securetrading.net/" trustpay.base_url_bank_redirects = "https://aapi.trustpay.eu/" tsys.base_url = "https://stagegw.transnox.com/" vgs.base_url = "https://sandbox.vault-api.verygoodvault.com" diff --git a/config/development.toml b/config/development.toml index 173d9363f2a..ab5029f80be 100644 --- a/config/development.toml +++ b/config/development.toml @@ -343,6 +343,7 @@ worldpayvantiv.secondary_base_url = "https://onlinessr.vantivprelive.com" worldpayxml.base_url = "https://secure-test.worldpay.com/jsp/merchant/xml/paymentService.jsp" xendit.base_url = "https://api.xendit.co" trustpay.base_url = "https://test-tpgw.trustpay.eu/" +trustpayments.base_url = "https://webservices.securetrading.net/" tsys.base_url = "https://stagegw.transnox.com/" unified_authentication_service.base_url = "http://localhost:8000/" vgs.base_url = "https://sandbox.vault-api.verygoodvault.com" diff --git a/config/docker_compose.toml b/config/docker_compose.toml index 01abf5e8137..3ef11162a4b 100644 --- a/config/docker_compose.toml +++ b/config/docker_compose.toml @@ -223,6 +223,7 @@ thunes.base_url = "https://api.limonetikqualif.com/" tokenio.base_url = "https://api.sandbox.token.io" stripe.base_url_file_upload = "https://files.stripe.com/" trustpay.base_url = "https://test-tpgw.trustpay.eu/" +trustpayments.base_url = "https://webservices.securetrading.net/" trustpay.base_url_bank_redirects = "https://aapi.trustpay.eu/" tsys.base_url = "https://stagegw.transnox.com/" unified_authentication_service.base_url = "http://localhost:8000" diff --git a/crates/connector_configs/src/connector.rs b/crates/connector_configs/src/connector.rs index 61736a42edf..b6f992db1b5 100644 --- a/crates/connector_configs/src/connector.rs +++ b/crates/connector_configs/src/connector.rs @@ -273,6 +273,7 @@ pub struct ConnectorConfig { pub signifyd: Option<ConnectorTomlConfig>, pub tokenio: Option<ConnectorTomlConfig>, pub trustpay: Option<ConnectorTomlConfig>, + pub trustpayments: Option<ConnectorTomlConfig>, pub threedsecureio: Option<ConnectorTomlConfig>, pub netcetera: Option<ConnectorTomlConfig>, pub tsys: Option<ConnectorTomlConfig>, diff --git a/crates/connector_configs/toml/development.toml b/crates/connector_configs/toml/development.toml index 9e493eb6a54..9e77383604d 100644 --- a/crates/connector_configs/toml/development.toml +++ b/crates/connector_configs/toml/development.toml @@ -6342,6 +6342,10 @@ api_key = "API Key" [blackhawknetwork.connector_auth.HeaderKey] api_key = "API Key" +[trustpayments] +[trustpayments.connector_auth.HeaderKey] +api_key = "API Key" + [breadpay] [breadpay.connector_auth.HeaderKey] api_key = "API Key" diff --git a/crates/connector_configs/toml/production.toml b/crates/connector_configs/toml/production.toml index e81c3f6aac9..84ff257594b 100644 --- a/crates/connector_configs/toml/production.toml +++ b/crates/connector_configs/toml/production.toml @@ -4947,6 +4947,10 @@ key1 = "Secret Key" [affirm.connector_auth.HeaderKey] api_key = "API Key" +[trustpayments] +[trustpayments.connector_auth.HeaderKey] +api_key = "API Key" + [blackhawknetwork] [blackhawknetwork.connector_auth.HeaderKey] api_key = "API Key" diff --git a/crates/connector_configs/toml/sandbox.toml b/crates/connector_configs/toml/sandbox.toml index bdd9cde57f0..5492de4ff48 100644 --- a/crates/connector_configs/toml/sandbox.toml +++ b/crates/connector_configs/toml/sandbox.toml @@ -6317,6 +6317,10 @@ key1 = "Secret Key" [affirm.connector_auth.HeaderKey] api_key = "API Key" +[trustpayments] +[trustpayments.connector_auth.HeaderKey] +api_key = "API Key" + [blackhawknetwork] [blackhawknetwork.connector_auth.HeaderKey] api_key = "API Key" diff --git a/crates/hyperswitch_connectors/src/connectors.rs b/crates/hyperswitch_connectors/src/connectors.rs index bc2313fb0fb..61210b10f01 100644 --- a/crates/hyperswitch_connectors/src/connectors.rs +++ b/crates/hyperswitch_connectors/src/connectors.rs @@ -102,6 +102,7 @@ pub mod threedsecureio; pub mod thunes; pub mod tokenio; pub mod trustpay; +pub mod trustpayments; pub mod tsys; pub mod unified_authentication_service; pub mod vgs; @@ -143,7 +144,8 @@ pub use self::{ santander::Santander, shift4::Shift4, signifyd::Signifyd, silverflow::Silverflow, square::Square, stax::Stax, stripe::Stripe, stripebilling::Stripebilling, taxjar::Taxjar, threedsecureio::Threedsecureio, thunes::Thunes, tokenio::Tokenio, trustpay::Trustpay, - tsys::Tsys, unified_authentication_service::UnifiedAuthenticationService, vgs::Vgs, volt::Volt, + trustpayments::Trustpayments, tsys::Tsys, + unified_authentication_service::UnifiedAuthenticationService, vgs::Vgs, volt::Volt, wellsfargo::Wellsfargo, wellsfargopayout::Wellsfargopayout, wise::Wise, worldline::Worldline, worldpay::Worldpay, worldpayvantiv::Worldpayvantiv, worldpayxml::Worldpayxml, xendit::Xendit, zen::Zen, zsl::Zsl, diff --git a/crates/hyperswitch_connectors/src/connectors/trustpayments.rs b/crates/hyperswitch_connectors/src/connectors/trustpayments.rs new file mode 100644 index 00000000000..0b4ad2b1b1f --- /dev/null +++ b/crates/hyperswitch_connectors/src/connectors/trustpayments.rs @@ -0,0 +1,632 @@ +pub mod transformers; + +use std::sync::LazyLock; + +use common_enums::enums; +use common_utils::{ + errors::CustomResult, + ext_traits::BytesExt, + request::{Method, Request, RequestBuilder, RequestContent}, + types::{AmountConvertor, StringMinorUnit, StringMinorUnitForConnector}, +}; +use error_stack::{report, ResultExt}; +use hyperswitch_domain_models::{ + payment_method_data::PaymentMethodData, + router_data::{AccessToken, ConnectorAuthType, ErrorResponse, RouterData}, + router_flow_types::{ + access_token_auth::AccessTokenAuth, + payments::{Authorize, Capture, PSync, PaymentMethodToken, Session, SetupMandate, Void}, + refunds::{Execute, RSync}, + }, + router_request_types::{ + AccessTokenRequestData, PaymentMethodTokenizationData, PaymentsAuthorizeData, + PaymentsCancelData, PaymentsCaptureData, PaymentsSessionData, PaymentsSyncData, + RefundsData, SetupMandateRequestData, + }, + router_response_types::{ + ConnectorInfo, PaymentsResponseData, RefundsResponseData, SupportedPaymentMethods, + }, + types::{ + PaymentsAuthorizeRouterData, PaymentsCaptureRouterData, PaymentsSyncRouterData, + RefundSyncRouterData, RefundsRouterData, + }, +}; +use hyperswitch_interfaces::{ + api::{ + self, ConnectorCommon, ConnectorCommonExt, ConnectorIntegration, ConnectorSpecifications, + ConnectorValidation, + }, + configs::Connectors, + errors, + events::connector_api_logs::ConnectorEvent, + types::{self, Response}, + webhooks, +}; +use masking::{ExposeInterface, Mask}; +use transformers as trustpayments; + +use crate::{constants::headers, types::ResponseRouterData, utils}; + +#[derive(Clone)] +pub struct Trustpayments { + amount_converter: &'static (dyn AmountConvertor<Output = StringMinorUnit> + Sync), +} + +impl Trustpayments { + pub fn new() -> &'static Self { + &Self { + amount_converter: &StringMinorUnitForConnector, + } + } +} + +impl api::Payment for Trustpayments {} +impl api::PaymentSession for Trustpayments {} +impl api::ConnectorAccessToken for Trustpayments {} +impl api::MandateSetup for Trustpayments {} +impl api::PaymentAuthorize for Trustpayments {} +impl api::PaymentSync for Trustpayments {} +impl api::PaymentCapture for Trustpayments {} +impl api::PaymentVoid for Trustpayments {} +impl api::Refund for Trustpayments {} +impl api::RefundExecute for Trustpayments {} +impl api::RefundSync for Trustpayments {} +impl api::PaymentToken for Trustpayments {} + +impl ConnectorIntegration<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData> + for Trustpayments +{ + // Not Implemented (R) +} + +impl<Flow, Request, Response> ConnectorCommonExt<Flow, Request, Response> for Trustpayments +where + Self: ConnectorIntegration<Flow, Request, Response>, +{ + fn build_headers( + &self, + req: &RouterData<Flow, Request, Response>, + _connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + let mut header = vec![( + headers::CONTENT_TYPE.to_string(), + self.get_content_type().to_string().into(), + )]; + let mut api_key = self.get_auth_header(&req.connector_auth_type)?; + header.append(&mut api_key); + Ok(header) + } +} + +impl ConnectorCommon for Trustpayments { + fn id(&self) -> &'static str { + "trustpayments" + } + + fn get_currency_unit(&self) -> api::CurrencyUnit { + // todo!() + api::CurrencyUnit::Minor + + // TODO! Check connector documentation, on which unit they are processing the currency. + // If the connector accepts amount in lower unit ( i.e cents for USD) then return api::CurrencyUnit::Minor, + // if connector accepts amount in base unit (i.e dollars for USD) then return api::CurrencyUnit::Base + } + + fn common_get_content_type(&self) -> &'static str { + "application/json" + } + + fn base_url<'a>(&self, connectors: &'a Connectors) -> &'a str { + connectors.trustpayments.base_url.as_ref() + } + + fn get_auth_header( + &self, + auth_type: &ConnectorAuthType, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + let auth = trustpayments::TrustpaymentsAuthType::try_from(auth_type) + .change_context(errors::ConnectorError::FailedToObtainAuthType)?; + Ok(vec![( + headers::AUTHORIZATION.to_string(), + auth.api_key.expose().into_masked(), + )]) + } + + fn build_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + let response: trustpayments::TrustpaymentsErrorResponse = res + .response + .parse_struct("TrustpaymentsErrorResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + + Ok(ErrorResponse { + status_code: res.status_code, + code: response.code, + message: response.message, + reason: response.reason, + attempt_status: None, + connector_transaction_id: None, + network_advice_code: None, + network_decline_code: None, + network_error_message: None, + }) + } +} + +impl ConnectorValidation for Trustpayments { + fn validate_mandate_payment( + &self, + _pm_type: Option<enums::PaymentMethodType>, + pm_data: PaymentMethodData, + ) -> CustomResult<(), errors::ConnectorError> { + match pm_data { + PaymentMethodData::Card(_) => Err(errors::ConnectorError::NotImplemented( + "validate_mandate_payment does not support cards".to_string(), + ) + .into()), + _ => Ok(()), + } + } + + fn validate_psync_reference_id( + &self, + _data: &PaymentsSyncData, + _is_three_ds: bool, + _status: enums::AttemptStatus, + _connector_meta_data: Option<common_utils::pii::SecretSerdeValue>, + ) -> CustomResult<(), errors::ConnectorError> { + Ok(()) + } +} + +impl ConnectorIntegration<Session, PaymentsSessionData, PaymentsResponseData> for Trustpayments { + //TODO: implement sessions flow +} + +impl ConnectorIntegration<AccessTokenAuth, AccessTokenRequestData, AccessToken> for Trustpayments {} + +impl ConnectorIntegration<SetupMandate, SetupMandateRequestData, PaymentsResponseData> + for Trustpayments +{ +} + +impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData> + for Trustpayments +{ + fn get_headers( + &self, + req: &PaymentsAuthorizeRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsAuthorizeRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn get_request_body( + &self, + req: &PaymentsAuthorizeRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let amount = utils::convert_amount( + self.amount_converter, + req.request.minor_amount, + req.request.currency, + )?; + + let connector_router_data = trustpayments::TrustpaymentsRouterData::from((amount, req)); + let connector_req = + trustpayments::TrustpaymentsPaymentsRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &PaymentsAuthorizeRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::PaymentsAuthorizeType::get_url( + self, req, connectors, + )?) + .attach_default_headers() + .headers(types::PaymentsAuthorizeType::get_headers( + self, req, connectors, + )?) + .set_body(types::PaymentsAuthorizeType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsAuthorizeRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsAuthorizeRouterData, errors::ConnectorError> { + let response: trustpayments::TrustpaymentsPaymentsResponse = res + .response + .parse_struct("Trustpayments PaymentsAuthorizeResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<PSync, PaymentsSyncData, PaymentsResponseData> for Trustpayments { + fn get_headers( + &self, + req: &PaymentsSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsSyncRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn build_request( + &self, + req: &PaymentsSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Get) + .url(&types::PaymentsSyncType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::PaymentsSyncType::get_headers(self, req, connectors)?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsSyncRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsSyncRouterData, errors::ConnectorError> { + let response: trustpayments::TrustpaymentsPaymentsResponse = res + .response + .parse_struct("trustpayments PaymentsSyncResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<Capture, PaymentsCaptureData, PaymentsResponseData> for Trustpayments { + fn get_headers( + &self, + req: &PaymentsCaptureRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsCaptureRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn get_request_body( + &self, + _req: &PaymentsCaptureRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_request_body method".to_string()).into()) + } + + fn build_request( + &self, + req: &PaymentsCaptureRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::PaymentsCaptureType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::PaymentsCaptureType::get_headers( + self, req, connectors, + )?) + .set_body(types::PaymentsCaptureType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsCaptureRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsCaptureRouterData, errors::ConnectorError> { + let response: trustpayments::TrustpaymentsPaymentsResponse = res + .response + .parse_struct("Trustpayments PaymentsCaptureResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<Void, PaymentsCancelData, PaymentsResponseData> for Trustpayments {} + +impl ConnectorIntegration<Execute, RefundsData, RefundsResponseData> for Trustpayments { + fn get_headers( + &self, + req: &RefundsRouterData<Execute>, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &RefundsRouterData<Execute>, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn get_request_body( + &self, + req: &RefundsRouterData<Execute>, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let refund_amount = utils::convert_amount( + self.amount_converter, + req.request.minor_refund_amount, + req.request.currency, + )?; + + let connector_router_data = + trustpayments::TrustpaymentsRouterData::from((refund_amount, req)); + let connector_req = + trustpayments::TrustpaymentsRefundRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &RefundsRouterData<Execute>, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + let request = RequestBuilder::new() + .method(Method::Post) + .url(&types::RefundExecuteType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::RefundExecuteType::get_headers( + self, req, connectors, + )?) + .set_body(types::RefundExecuteType::get_request_body( + self, req, connectors, + )?) + .build(); + Ok(Some(request)) + } + + fn handle_response( + &self, + data: &RefundsRouterData<Execute>, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<RefundsRouterData<Execute>, errors::ConnectorError> { + let response: trustpayments::RefundResponse = res + .response + .parse_struct("trustpayments RefundResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<RSync, RefundsData, RefundsResponseData> for Trustpayments { + fn get_headers( + &self, + req: &RefundSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &RefundSyncRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn build_request( + &self, + req: &RefundSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Get) + .url(&types::RefundSyncType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::RefundSyncType::get_headers(self, req, connectors)?) + .set_body(types::RefundSyncType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &RefundSyncRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<RefundSyncRouterData, errors::ConnectorError> { + let response: trustpayments::RefundResponse = res + .response + .parse_struct("trustpayments RefundSyncResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +#[async_trait::async_trait] +impl webhooks::IncomingWebhook for Trustpayments { + fn get_webhook_object_reference_id( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<api_models::webhooks::ObjectReferenceId, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } + + fn get_webhook_event_type( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<api_models::webhooks::IncomingWebhookEvent, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } + + fn get_webhook_resource_object( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<Box<dyn masking::ErasedMaskSerialize>, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } +} + +static TRUSTPAYMENTS_SUPPORTED_PAYMENT_METHODS: LazyLock<SupportedPaymentMethods> = + LazyLock::new(SupportedPaymentMethods::new); + +static TRUSTPAYMENTS_CONNECTOR_INFO: ConnectorInfo = ConnectorInfo { + display_name: "Trustpayments", + description: "Trustpayments connector", + connector_type: enums::PaymentConnectorCategory::PaymentGateway, +}; + +static TRUSTPAYMENTS_SUPPORTED_WEBHOOK_FLOWS: [enums::EventClass; 0] = []; + +impl ConnectorSpecifications for Trustpayments { + fn get_connector_about(&self) -> Option<&'static ConnectorInfo> { + Some(&TRUSTPAYMENTS_CONNECTOR_INFO) + } + + fn get_supported_payment_methods(&self) -> Option<&'static SupportedPaymentMethods> { + Some(&TRUSTPAYMENTS_SUPPORTED_PAYMENT_METHODS) + } + + fn get_supported_webhook_flows(&self) -> Option<&'static [enums::EventClass]> { + Some(&TRUSTPAYMENTS_SUPPORTED_WEBHOOK_FLOWS) + } +} diff --git a/crates/hyperswitch_connectors/src/connectors/trustpayments/transformers.rs b/crates/hyperswitch_connectors/src/connectors/trustpayments/transformers.rs new file mode 100644 index 00000000000..debeca6b63a --- /dev/null +++ b/crates/hyperswitch_connectors/src/connectors/trustpayments/transformers.rs @@ -0,0 +1,223 @@ +use common_enums::enums; +use common_utils::types::StringMinorUnit; +use hyperswitch_domain_models::{ + payment_method_data::PaymentMethodData, + router_data::{ConnectorAuthType, RouterData}, + router_flow_types::refunds::{Execute, RSync}, + router_request_types::ResponseId, + router_response_types::{PaymentsResponseData, RefundsResponseData}, + types::{PaymentsAuthorizeRouterData, RefundsRouterData}, +}; +use hyperswitch_interfaces::errors; +use masking::Secret; +use serde::{Deserialize, Serialize}; + +use crate::types::{RefundsResponseRouterData, ResponseRouterData}; + +//TODO: Fill the struct with respective fields +pub struct TrustpaymentsRouterData<T> { + pub amount: StringMinorUnit, // The type of amount that a connector accepts, for example, String, i64, f64, etc. + pub router_data: T, +} + +impl<T> From<(StringMinorUnit, T)> for TrustpaymentsRouterData<T> { + fn from((amount, item): (StringMinorUnit, T)) -> Self { + //Todo : use utils to convert the amount to the type of amount that a connector accepts + Self { + amount, + router_data: item, + } + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Serialize, PartialEq)] +pub struct TrustpaymentsPaymentsRequest { + amount: StringMinorUnit, + card: TrustpaymentsCard, +} + +#[derive(Default, Debug, Serialize, Eq, PartialEq)] +pub struct TrustpaymentsCard { + number: cards::CardNumber, + expiry_month: Secret<String>, + expiry_year: Secret<String>, + cvc: Secret<String>, + complete: bool, +} + +impl TryFrom<&TrustpaymentsRouterData<&PaymentsAuthorizeRouterData>> + for TrustpaymentsPaymentsRequest +{ + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: &TrustpaymentsRouterData<&PaymentsAuthorizeRouterData>, + ) -> Result<Self, Self::Error> { + match item.router_data.request.payment_method_data.clone() { + PaymentMethodData::Card(_) => Err(errors::ConnectorError::NotImplemented( + "Card payment method not implemented".to_string(), + ) + .into()), + _ => Err(errors::ConnectorError::NotImplemented("Payment method".to_string()).into()), + } + } +} + +//TODO: Fill the struct with respective fields +// Auth Struct +pub struct TrustpaymentsAuthType { + pub(super) api_key: Secret<String>, +} + +impl TryFrom<&ConnectorAuthType> for TrustpaymentsAuthType { + 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, Copy, Default, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "lowercase")] +pub enum TrustpaymentsPaymentStatus { + Succeeded, + Failed, + #[default] + Processing, +} + +impl From<TrustpaymentsPaymentStatus> for common_enums::AttemptStatus { + fn from(item: TrustpaymentsPaymentStatus) -> Self { + match item { + TrustpaymentsPaymentStatus::Succeeded => Self::Charged, + TrustpaymentsPaymentStatus::Failed => Self::Failure, + TrustpaymentsPaymentStatus::Processing => Self::Authorizing, + } + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] +pub struct TrustpaymentsPaymentsResponse { + status: TrustpaymentsPaymentStatus, + id: String, +} + +impl<F, T> TryFrom<ResponseRouterData<F, TrustpaymentsPaymentsResponse, T, PaymentsResponseData>> + for RouterData<F, T, PaymentsResponseData> +{ + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: ResponseRouterData<F, TrustpaymentsPaymentsResponse, T, PaymentsResponseData>, + ) -> Result<Self, Self::Error> { + Ok(Self { + status: common_enums::AttemptStatus::from(item.response.status), + response: Ok(PaymentsResponseData::TransactionResponse { + resource_id: ResponseId::ConnectorTransactionId(item.response.id), + redirection_data: Box::new(None), + mandate_reference: Box::new(None), + connector_metadata: None, + network_txn_id: None, + connector_response_reference_id: None, + incremental_authorization_allowed: None, + charges: None, + }), + ..item.data + }) + } +} + +//TODO: Fill the struct with respective fields +// REFUND : +// Type definition for RefundRequest +#[derive(Default, Debug, Serialize)] +pub struct TrustpaymentsRefundRequest { + pub amount: StringMinorUnit, +} + +impl<F> TryFrom<&TrustpaymentsRouterData<&RefundsRouterData<F>>> for TrustpaymentsRefundRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: &TrustpaymentsRouterData<&RefundsRouterData<F>>, + ) -> Result<Self, Self::Error> { + Ok(Self { + amount: item.amount.to_owned(), + }) + } +} + +// Type definition for Refund Response + +#[allow(dead_code)] +#[derive(Debug, Copy, Serialize, Default, Deserialize, Clone)] +pub enum RefundStatus { + Succeeded, + Failed, + #[default] + Processing, +} + +impl From<RefundStatus> for enums::RefundStatus { + fn from(item: RefundStatus) -> Self { + match item { + RefundStatus::Succeeded => Self::Success, + RefundStatus::Failed => Self::Failure, + RefundStatus::Processing => Self::Pending, + //TODO: Review mapping + } + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Clone, Serialize, Deserialize)] +pub struct RefundResponse { + id: String, + status: RefundStatus, +} + +impl TryFrom<RefundsResponseRouterData<Execute, RefundResponse>> for RefundsRouterData<Execute> { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: RefundsResponseRouterData<Execute, RefundResponse>, + ) -> Result<Self, Self::Error> { + Ok(Self { + response: Ok(RefundsResponseData { + connector_refund_id: item.response.id.to_string(), + refund_status: enums::RefundStatus::from(item.response.status), + }), + ..item.data + }) + } +} + +impl TryFrom<RefundsResponseRouterData<RSync, RefundResponse>> for RefundsRouterData<RSync> { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: RefundsResponseRouterData<RSync, RefundResponse>, + ) -> Result<Self, Self::Error> { + Ok(Self { + response: Ok(RefundsResponseData { + connector_refund_id: item.response.id.to_string(), + refund_status: enums::RefundStatus::from(item.response.status), + }), + ..item.data + }) + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Serialize, Deserialize, PartialEq)] +pub struct TrustpaymentsErrorResponse { + pub status_code: u16, + pub code: String, + pub message: String, + pub reason: Option<String>, + pub network_advice_code: Option<String>, + pub network_decline_code: Option<String>, + pub network_error_message: Option<String>, +} diff --git a/crates/hyperswitch_connectors/src/default_implementations.rs b/crates/hyperswitch_connectors/src/default_implementations.rs index d015acc6b86..c43658a0c19 100644 --- a/crates/hyperswitch_connectors/src/default_implementations.rs +++ b/crates/hyperswitch_connectors/src/default_implementations.rs @@ -243,6 +243,7 @@ default_imp_for_authorize_session_token!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::Wise, connectors::Worldline, @@ -373,6 +374,7 @@ default_imp_for_calculate_tax!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Volt, @@ -515,6 +517,7 @@ default_imp_for_session_update!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::Deutschebank, connectors::Volt, @@ -644,6 +647,7 @@ default_imp_for_post_session_tokens!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Deutschebank, @@ -775,6 +779,7 @@ default_imp_for_create_order!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Deutschebank, @@ -907,6 +912,7 @@ default_imp_for_update_metadata!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Deutschebank, @@ -1016,6 +1022,7 @@ default_imp_for_complete_authorize!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -1146,6 +1153,7 @@ default_imp_for_incremental_authorization!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wellsfargopayout, @@ -1274,6 +1282,7 @@ default_imp_for_create_customer!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -1308,6 +1317,7 @@ macro_rules! default_imp_for_connector_redirect_response { } default_imp_for_connector_redirect_response!( + connectors::Trustpayments, connectors::Vgs, connectors::Aci, connectors::Adyen, @@ -1420,6 +1430,7 @@ macro_rules! default_imp_for_pre_processing_steps{ } default_imp_for_pre_processing_steps!( + connectors::Trustpayments, connectors::Silverflow, connectors::Vgs, connectors::Aci, @@ -1642,6 +1653,7 @@ default_imp_for_post_processing_steps!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -1776,6 +1788,7 @@ default_imp_for_approve!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -1910,6 +1923,7 @@ default_imp_for_reject!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -2043,6 +2057,7 @@ default_imp_for_webhook_source_verification!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -2176,6 +2191,7 @@ default_imp_for_accept_dispute!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -2307,6 +2323,7 @@ default_imp_for_submit_evidence!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -2439,6 +2456,7 @@ default_imp_for_defend_dispute!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -2579,6 +2597,7 @@ default_imp_for_file_upload!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -2697,6 +2716,7 @@ default_imp_for_payouts!( connectors::Threedsecureio, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Volt, @@ -2827,6 +2847,7 @@ default_imp_for_payouts_create!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Worldline, @@ -2960,6 +2981,7 @@ default_imp_for_payouts_retrieve!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -3093,6 +3115,7 @@ default_imp_for_payouts_eligibility!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Worldline, @@ -3220,6 +3243,7 @@ default_imp_for_payouts_fulfill!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Worldline, @@ -3351,6 +3375,7 @@ default_imp_for_payouts_cancel!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Worldline, @@ -3484,6 +3509,7 @@ default_imp_for_payouts_quote!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Worldline, @@ -3616,6 +3642,7 @@ default_imp_for_payouts_recipient!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Worldline, @@ -3749,6 +3776,7 @@ default_imp_for_payouts_recipient_account!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -3883,6 +3911,7 @@ default_imp_for_frm_sale!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -4017,6 +4046,7 @@ default_imp_for_frm_checkout!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -4151,6 +4181,7 @@ default_imp_for_frm_transaction!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -4285,6 +4316,7 @@ default_imp_for_frm_fulfillment!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -4419,6 +4451,7 @@ default_imp_for_frm_record_return!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -4549,6 +4582,7 @@ default_imp_for_revoking_mandates!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -4681,6 +4715,7 @@ default_imp_for_uas_pre_authentication!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::Wise, connectors::Worldline, @@ -4812,6 +4847,7 @@ default_imp_for_uas_post_authentication!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::Wise, connectors::Worldline, @@ -4944,6 +4980,7 @@ default_imp_for_uas_authentication_confirmation!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::Wise, connectors::Worldline, @@ -5067,6 +5104,7 @@ default_imp_for_connector_request_id!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -5193,6 +5231,7 @@ default_imp_for_fraud_check!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -5348,6 +5387,7 @@ default_imp_for_connector_authentication!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -5479,6 +5519,7 @@ default_imp_for_uas_authentication!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::Wise, connectors::Wellsfargo, @@ -5604,6 +5645,7 @@ default_imp_for_revenue_recovery!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -5738,6 +5780,7 @@ default_imp_for_billing_connector_payment_sync!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -5871,6 +5914,7 @@ default_imp_for_revenue_recovery_record_back!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -6005,6 +6049,7 @@ default_imp_for_billing_connector_invoice_sync!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -6132,6 +6177,7 @@ default_imp_for_external_vault!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -6265,6 +6311,7 @@ default_imp_for_external_vault_insert!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -6398,6 +6445,7 @@ default_imp_for_external_vault_retrieve!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -6531,6 +6579,7 @@ default_imp_for_external_vault_delete!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -6663,6 +6712,7 @@ default_imp_for_external_vault_create!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, diff --git a/crates/hyperswitch_connectors/src/default_implementations_v2.rs b/crates/hyperswitch_connectors/src/default_implementations_v2.rs index 1978e47c0ab..11e56101bd3 100644 --- a/crates/hyperswitch_connectors/src/default_implementations_v2.rs +++ b/crates/hyperswitch_connectors/src/default_implementations_v2.rs @@ -349,6 +349,7 @@ default_imp_for_new_connector_integration_payment!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -483,6 +484,7 @@ default_imp_for_new_connector_integration_refund!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wellsfargo, @@ -612,6 +614,7 @@ default_imp_for_new_connector_integration_connector_access_token!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -746,6 +749,7 @@ default_imp_for_new_connector_integration_accept_dispute!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -879,6 +883,7 @@ default_imp_for_new_connector_integration_submit_evidence!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -1013,6 +1018,7 @@ default_imp_for_new_connector_integration_defend_dispute!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -1157,6 +1163,7 @@ default_imp_for_new_connector_integration_file_upload!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -1293,6 +1300,7 @@ default_imp_for_new_connector_integration_payouts_create!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -1429,6 +1437,7 @@ default_imp_for_new_connector_integration_payouts_eligibility!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -1565,6 +1574,7 @@ default_imp_for_new_connector_integration_payouts_fulfill!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -1701,6 +1711,7 @@ default_imp_for_new_connector_integration_payouts_cancel!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -1837,6 +1848,7 @@ default_imp_for_new_connector_integration_payouts_quote!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -1973,6 +1985,7 @@ default_imp_for_new_connector_integration_payouts_recipient!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -2109,6 +2122,7 @@ default_imp_for_new_connector_integration_payouts_sync!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -2245,6 +2259,7 @@ default_imp_for_new_connector_integration_payouts_recipient_account!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -2379,6 +2394,7 @@ default_imp_for_new_connector_integration_webhook_source_verification!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -2515,6 +2531,7 @@ default_imp_for_new_connector_integration_frm_sale!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -2651,6 +2668,7 @@ default_imp_for_new_connector_integration_frm_checkout!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -2787,6 +2805,7 @@ default_imp_for_new_connector_integration_frm_transaction!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -2923,6 +2942,7 @@ default_imp_for_new_connector_integration_frm_fulfillment!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -3059,6 +3079,7 @@ default_imp_for_new_connector_integration_frm_record_return!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -3191,6 +3212,7 @@ default_imp_for_new_connector_integration_revoking_mandates!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -3217,6 +3239,7 @@ macro_rules! default_imp_for_new_connector_integration_frm { #[cfg(feature = "frm")] default_imp_for_new_connector_integration_frm!( + connectors::Trustpayments, connectors::Affirm, connectors::Vgs, connectors::Airwallex, @@ -3350,6 +3373,7 @@ macro_rules! default_imp_for_new_connector_integration_connector_authentication } default_imp_for_new_connector_integration_connector_authentication!( + connectors::Trustpayments, connectors::Affirm, connectors::Vgs, connectors::Airwallex, @@ -3472,6 +3496,7 @@ macro_rules! default_imp_for_new_connector_integration_revenue_recovery { } default_imp_for_new_connector_integration_revenue_recovery!( + connectors::Trustpayments, connectors::Affirm, connectors::Vgs, connectors::Airwallex, @@ -3706,6 +3731,7 @@ default_imp_for_new_connector_integration_external_vault!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Vgs, diff --git a/crates/hyperswitch_domain_models/src/connector_endpoints.rs b/crates/hyperswitch_domain_models/src/connector_endpoints.rs index 00f4b9d1e53..ca3c6479dd3 100644 --- a/crates/hyperswitch_domain_models/src/connector_endpoints.rs +++ b/crates/hyperswitch_domain_models/src/connector_endpoints.rs @@ -117,6 +117,7 @@ pub struct Connectors { pub thunes: ConnectorParams, pub tokenio: ConnectorParams, pub trustpay: ConnectorParamsWithMoreUrls, + pub trustpayments: ConnectorParams, pub tsys: ConnectorParams, pub unified_authentication_service: ConnectorParams, pub vgs: ConnectorParams, diff --git a/crates/router/src/connector.rs b/crates/router/src/connector.rs index 5252df7f921..2d7cdbaa21f 100644 --- a/crates/router/src/connector.rs +++ b/crates/router/src/connector.rs @@ -38,10 +38,11 @@ pub use hyperswitch_connectors::connectors::{ signifyd::Signifyd, silverflow, silverflow::Silverflow, square, square::Square, stax, stax::Stax, stripe, stripe::Stripe, stripebilling, stripebilling::Stripebilling, taxjar, taxjar::Taxjar, threedsecureio, threedsecureio::Threedsecureio, thunes, thunes::Thunes, - tokenio, tokenio::Tokenio, trustpay, trustpay::Trustpay, tsys, tsys::Tsys, - unified_authentication_service, unified_authentication_service::UnifiedAuthenticationService, - vgs, vgs::Vgs, volt, volt::Volt, wellsfargo, wellsfargo::Wellsfargo, wellsfargopayout, - wellsfargopayout::Wellsfargopayout, wise, wise::Wise, worldline, worldline::Worldline, - worldpay, worldpay::Worldpay, worldpayvantiv, worldpayvantiv::Worldpayvantiv, worldpayxml, - worldpayxml::Worldpayxml, xendit, xendit::Xendit, zen, zen::Zen, zsl, zsl::Zsl, + tokenio, tokenio::Tokenio, trustpay, trustpay::Trustpay, trustpayments, + trustpayments::Trustpayments, tsys, tsys::Tsys, unified_authentication_service, + unified_authentication_service::UnifiedAuthenticationService, vgs, vgs::Vgs, volt, volt::Volt, + wellsfargo, wellsfargo::Wellsfargo, wellsfargopayout, wellsfargopayout::Wellsfargopayout, wise, + wise::Wise, worldline, worldline::Worldline, worldpay, worldpay::Worldpay, worldpayvantiv, + worldpayvantiv::Worldpayvantiv, worldpayxml, worldpayxml::Worldpayxml, xendit, xendit::Xendit, + zen, zen::Zen, zsl, zsl::Zsl, }; diff --git a/crates/router/tests/connectors/main.rs b/crates/router/tests/connectors/main.rs index c448950eeca..babb7284c76 100644 --- a/crates/router/tests/connectors/main.rs +++ b/crates/router/tests/connectors/main.rs @@ -102,6 +102,7 @@ mod stripebilling; mod taxjar; mod tokenio; mod trustpay; +mod trustpayments; mod tsys; mod unified_authentication_service; mod utils; diff --git a/crates/router/tests/connectors/trustpayments.rs b/crates/router/tests/connectors/trustpayments.rs new file mode 100644 index 00000000000..7d07b825aac --- /dev/null +++ b/crates/router/tests/connectors/trustpayments.rs @@ -0,0 +1,421 @@ +use hyperswitch_domain_models::payment_method_data::{Card, PaymentMethodData}; +use masking::Secret; +use router::types::{self, api, storage::enums}; +use test_utils::connector_auth; + +use crate::utils::{self, ConnectorActions}; + +#[derive(Clone, Copy)] +struct TrustpaymentsTest; +impl ConnectorActions for TrustpaymentsTest {} +impl utils::Connector for TrustpaymentsTest { + fn get_data(&self) -> api::ConnectorData { + use router::connector::Trustpayments; + utils::construct_connector_data_old( + Box::new(Trustpayments::new()), + types::Connector::Plaid, + api::GetToken::Connector, + None, + ) + } + + fn get_auth_token(&self) -> types::ConnectorAuthType { + utils::to_connector_auth_type( + connector_auth::ConnectorAuthentication::new() + .trustpayments + .expect("Missing connector authentication configuration") + .into(), + ) + } + + fn get_name(&self) -> String { + "trustpayments".to_string() + } +} + +static CONNECTOR: TrustpaymentsTest = TrustpaymentsTest {}; + +fn get_default_payment_info() -> Option<utils::PaymentInfo> { + None +} + +fn payment_method_details() -> Option<types::PaymentsAuthorizeData> { + None +} + +// Cards Positive Tests +// Creates a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_only_authorize_payment() { + let response = CONNECTOR + .authorize_payment(payment_method_details(), get_default_payment_info()) + .await + .expect("Authorize payment response"); + assert_eq!(response.status, enums::AttemptStatus::Authorized); +} + +// Captures a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_capture_authorized_payment() { + let response = CONNECTOR + .authorize_and_capture_payment(payment_method_details(), None, get_default_payment_info()) + .await + .expect("Capture payment response"); + assert_eq!(response.status, enums::AttemptStatus::Charged); +} + +// Partially captures a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_capture_authorized_payment() { + let response = CONNECTOR + .authorize_and_capture_payment( + payment_method_details(), + Some(types::PaymentsCaptureData { + amount_to_capture: 50, + ..utils::PaymentCaptureType::default().0 + }), + get_default_payment_info(), + ) + .await + .expect("Capture payment response"); + assert_eq!(response.status, enums::AttemptStatus::Charged); +} + +// Synchronizes a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_authorized_payment() { + let authorize_response = CONNECTOR + .authorize_payment(payment_method_details(), get_default_payment_info()) + .await + .expect("Authorize payment response"); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + let response = CONNECTOR + .psync_retry_till_status_matches( + enums::AttemptStatus::Authorized, + Some(types::PaymentsSyncData { + connector_transaction_id: types::ResponseId::ConnectorTransactionId( + txn_id.unwrap(), + ), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .expect("PSync response"); + assert_eq!(response.status, enums::AttemptStatus::Authorized,); +} + +// Voids a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_void_authorized_payment() { + let response = CONNECTOR + .authorize_and_void_payment( + payment_method_details(), + Some(types::PaymentsCancelData { + connector_transaction_id: String::from(""), + cancellation_reason: Some("requested_by_customer".to_string()), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .expect("Void payment response"); + assert_eq!(response.status, enums::AttemptStatus::Voided); +} + +// Refunds a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_manually_captured_payment() { + let response = CONNECTOR + .capture_payment_and_refund( + payment_method_details(), + None, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Partially refunds a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_refund_manually_captured_payment() { + let response = CONNECTOR + .capture_payment_and_refund( + payment_method_details(), + None, + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Synchronizes a refund using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_manually_captured_refund() { + let refund_response = CONNECTOR + .capture_payment_and_refund( + payment_method_details(), + None, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + let response = CONNECTOR + .rsync_retry_till_status_matches( + enums::RefundStatus::Success, + refund_response.response.unwrap().connector_refund_id, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Creates a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_make_payment() { + let authorize_response = CONNECTOR + .make_payment(payment_method_details(), get_default_payment_info()) + .await + .unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); +} + +// Synchronizes a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_auto_captured_payment() { + let authorize_response = CONNECTOR + .make_payment(payment_method_details(), get_default_payment_info()) + .await + .unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + assert_ne!(txn_id, None, "Empty connector transaction id"); + let response = CONNECTOR + .psync_retry_till_status_matches( + enums::AttemptStatus::Charged, + Some(types::PaymentsSyncData { + connector_transaction_id: types::ResponseId::ConnectorTransactionId( + txn_id.unwrap(), + ), + capture_method: Some(enums::CaptureMethod::Automatic), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!(response.status, enums::AttemptStatus::Charged,); +} + +// Refunds a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_auto_captured_payment() { + let response = CONNECTOR + .make_payment_and_refund(payment_method_details(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Partially refunds a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_refund_succeeded_payment() { + let refund_response = CONNECTOR + .make_payment_and_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + refund_response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Creates multiple refunds against a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_succeeded_payment_multiple_times() { + CONNECTOR + .make_payment_and_multiple_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await; +} + +// Synchronizes a refund using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_refund() { + let refund_response = CONNECTOR + .make_payment_and_refund(payment_method_details(), None, get_default_payment_info()) + .await + .unwrap(); + let response = CONNECTOR + .rsync_retry_till_status_matches( + enums::RefundStatus::Success, + refund_response.response.unwrap().connector_refund_id, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Cards Negative scenarios +// Creates a payment with incorrect CVC. +#[actix_web::test] +async fn should_fail_payment_for_incorrect_cvc() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: PaymentMethodData::Card(Card { + card_cvc: Secret::new("12345".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's security code is invalid.".to_string(), + ); +} + +// Creates a payment with incorrect expiry month. +#[actix_web::test] +async fn should_fail_payment_for_invalid_exp_month() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: PaymentMethodData::Card(Card { + card_exp_month: Secret::new("20".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's expiration month is invalid.".to_string(), + ); +} + +// Creates a payment with incorrect expiry year. +#[actix_web::test] +async fn should_fail_payment_for_incorrect_expiry_year() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: PaymentMethodData::Card(Card { + card_exp_year: Secret::new("2000".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's expiration year is invalid.".to_string(), + ); +} + +// Voids a payment using automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_fail_void_payment_for_auto_capture() { + let authorize_response = CONNECTOR + .make_payment(payment_method_details(), get_default_payment_info()) + .await + .unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + assert_ne!(txn_id, None, "Empty connector transaction id"); + let void_response = CONNECTOR + .void_payment(txn_id.unwrap(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + void_response.response.unwrap_err().message, + "You cannot cancel this PaymentIntent because it has a status of succeeded." + ); +} + +// Captures a payment using invalid connector payment id. +#[actix_web::test] +async fn should_fail_capture_for_invalid_payment() { + let capture_response = CONNECTOR + .capture_payment("123456789".to_string(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + capture_response.response.unwrap_err().message, + String::from("No such payment_intent: '123456789'") + ); +} + +// Refunds a payment with refund amount higher than payment amount. +#[actix_web::test] +async fn should_fail_for_refund_amount_higher_than_payment_amount() { + let response = CONNECTOR + .make_payment_and_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 150, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Refund amount (₹1.50) is greater than charge amount (₹1.00)", + ); +} + +// Connector dependent test cases goes here + +// [#478]: add unit tests for non 3DS, wallets & webhooks in connector tests diff --git a/crates/test_utils/src/connector_auth.rs b/crates/test_utils/src/connector_auth.rs index 1d45f8fb6ff..e2323031d25 100644 --- a/crates/test_utils/src/connector_auth.rs +++ b/crates/test_utils/src/connector_auth.rs @@ -113,6 +113,7 @@ pub struct ConnectorAuthentication { pub stripe_au: Option<HeaderKey>, pub stripe_uk: Option<HeaderKey>, pub trustpay: Option<SignatureKey>, + pub trustpayments: Option<HeaderKey>, pub tsys: Option<SignatureKey>, pub unified_authentication_service: Option<HeaderKey>, pub vgs: Option<SignatureKey>, diff --git a/loadtest/config/development.toml b/loadtest/config/development.toml index b0bc2e9ee1c..174bc900e5c 100644 --- a/loadtest/config/development.toml +++ b/loadtest/config/development.toml @@ -190,6 +190,7 @@ thunes.base_url = "https://api.limonetikqualif.com/" tokenio.base_url = "https://api.sandbox.token.io" stripe.base_url_file_upload = "https://files.stripe.com/" trustpay.base_url = "https://test-tpgw.trustpay.eu/" +trustpayments.base_url = "https://webservices.securetrading.net/" trustpay.base_url_bank_redirects = "https://aapi.trustpay.eu/" tsys.base_url = "https://stagegw.transnox.com/" unified_authentication_service.base_url = "http://localhost:8000" diff --git a/scripts/add_connector.sh b/scripts/add_connector.sh index 5462fdbbb01..25ffac2bb7a 100755 --- a/scripts/add_connector.sh +++ b/scripts/add_connector.sh @@ -6,7 +6,7 @@ function find_prev_connector() { git checkout $self cp $self $self.tmp # Add new connector to existing list and sort it - connectors=(aci adyen adyenplatform affirm airwallex amazonpay applepay archipel authipay authorizedotnet bambora bamboraapac bankofamerica barclaycard billwerk bitpay blackhawknetwork bluesnap boku braintree breadpay cashtocode celero chargebee checkbook checkout coinbase cryptopay ctp_visa custombilling cybersource datatrans deutschebank digitalvirgo dlocal dummyconnector dwolla ebanx elavon facilitapay fiserv fiservemea fiuu forte getnet globalpay globepay gocardless gpayments helcim hipay hyperswitch_vault iatapay inespay itaubank jpmorgan juspaythreedsserver klarna mifinity mollie moneris multisafepay netcetera nexinets nexixpay nomupay noon nordea novalnet nuvei opayo opennode paybox payeezy payload payme payone paypal paystack payu placetopay plaid powertranz prophetpay rapyd razorpay recurly redsys santander shift4 silverflow square stax stripe stripebilling taxjar threedsecureio thunes tokenio trustpay tsys unified_authentication_service vgs volt wellsfargo wellsfargopayout wise worldline worldpay worldpayvantiv worldpayxml xendit zsl "$1") + connectors=(aci adyen adyenplatform affirm airwallex amazonpay applepay archipel authipay authorizedotnet bambora bamboraapac bankofamerica barclaycard billwerk bitpay blackhawknetwork bluesnap boku braintree breadpay cashtocode celero chargebee checkbook checkout coinbase cryptopay ctp_visa custombilling cybersource datatrans deutschebank digitalvirgo dlocal dummyconnector dwolla ebanx elavon facilitapay fiserv fiservemea fiuu forte getnet globalpay globepay gocardless gpayments helcim hipay hyperswitch_vault iatapay inespay itaubank jpmorgan juspaythreedsserver klarna mifinity mollie moneris multisafepay netcetera nexinets nexixpay nomupay noon nordea novalnet nuvei opayo opennode paybox payeezy payload payme payone paypal paystack payu placetopay plaid powertranz prophetpay rapyd razorpay recurly redsys santander shift4 silverflow square stax stripe stripebilling taxjar threedsecureio thunes tokenio trustpay trustpayments tsys unified_authentication_service vgs volt wellsfargo wellsfargopayout wise worldline worldpay worldpayvantiv worldpayxml xendit zsl "$1") IFS=$'\n' sorted=($(sort <<<"${connectors[]}")); unset IFS res="$(echo ${sorted[@]})"	2025-07-17T07:04:50Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description TRUSTPAYMENTS Added Template Code ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> https://github.com/juspay/hyperswitch/pull/8672 ## How did you test it? Only template code added hence no testing required ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	6214aca5f0f5c617a68f65ef5bcfd700060acccf	6214aca5f0f5c617a68f65ef5bcfd700060acccf
juspay/hyperswitch	juspay__hyperswitch-8644	Bug: feat(core): Add kill switch for Unified Connector Service (UCS) # feat(core): Add kill switch for Unified Connector Service (UCS) ## Feature Description We need to implement a kill switch mechanism for the Unified Connector Service (UCS) integration that allows operators to disable UCS immediately without requiring code changes or deployments. ## Problem Statement Currently, if UCS experiences issues or needs to be disabled for operational reasons, there's no quick way to fall back to traditional connector flows without modifying code and deploying. This poses operational risks during incidents. ## Proposed Solution Implement a database-driven kill switch that: - Can be toggled via a configuration entry in the database - Takes effect immediately without requiring service restart - Integrates seamlessly with the existing UCS decision flow - Provides clear logging when the kill switch is active ## Technical Approach 1. Add a new configuration key `UCS_KILL_SWITCH_ACTIVE` that can be stored in the database 2. Implement a helper function to check the kill switch status 3. Integrate the kill switch check into the UCS decision flow before rollout percentage checks 4. Ensure proper error handling when UCS is disabled via kill switch ## Benefits - Operational Control: Immediate ability to disable UCS during incidents - Risk Mitigation: Quick fallback mechanism without deployment delays - Debugging: Easier troubleshooting by toggling UCS on/off - Gradual Rollout: Additional safety layer on top of percentage-based rollout ## Implementation Details The kill switch will be checked in the `should_call_unified_connector_service` function before any other conditions, ensuring it has the highest priority in the decision flow. ## Acceptance Criteria - [ ] Kill switch configuration can be set in the database - [ ] When kill switch is active, UCS is bypassed completely - [ ] Changes take effect immediately without service restart - [ ] Proper logging indicates when kill switch is active - [ ] Traditional connector flow continues to work when UCS is disabled	diff --git a/crates/router/src/consts.rs b/crates/router/src/consts.rs index f9d6daa53eb..a6c0954f8f0 100644 --- a/crates/router/src/consts.rs +++ b/crates/router/src/consts.rs @@ -309,7 +309,10 @@ pub const PSD2_COUNTRIES: [Country; 27] = [ ]; // Rollout percentage config prefix -pub const UCS_ROLLOUT_PERCENT_CONFIG_PREFIX: &str = "UCS_ROLLOUT_CONFIG"; +pub const UCS_ROLLOUT_PERCENT_CONFIG_PREFIX: &str = "ucs_rollout_config"; + +// UCS feature enabled config +pub const UCS_ENABLED: &str = "ucs_enabled"; /// Header value indicating that signature-key-based authentication is used. pub const UCS_AUTH_SIGNATURE_KEY: &str = "signature-key"; diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs index 5319e823614..8a1cf212e15 100644 --- a/crates/router/src/core/payments.rs +++ b/crates/router/src/core/payments.rs @@ -4383,22 +4383,10 @@ where Ok(router_data) } else { - let router_data = if should_continue_further { - router_data - .decide_flows( - state, - &connector, - call_connector_action, - connector_request, - business_profile, - header_payload.clone(), - return_raw_connector_response, - ) - .await - } else { - Ok(router_data) - }?; - Ok(router_data) + Err( + errors::ApiErrorResponse::InternalServerError + ) + .attach_printable("Unified connector service is down and traditional connector service fallback is not implemented") } }) .await diff --git a/crates/router/src/core/payments/helpers.rs b/crates/router/src/core/payments/helpers.rs index d6ce5858299..4a023f7d8c4 100644 --- a/crates/router/src/core/payments/helpers.rs +++ b/crates/router/src/core/payments/helpers.rs @@ -2037,6 +2037,27 @@ pub fn decide_payment_method_retrieval_action( } } +pub async fn is_ucs_enabled(state: &SessionState, config_key: &str) -> bool { + let db = state.store.as_ref(); + let is_enabled = db + .find_config_by_key_unwrap_or(config_key, Some("false".to_string())) + .await + .map_err(\|error\| { + logger::error!( + ?error, + "Failed to fetch `{config_key}` UCS enabled config from DB" + ); + }) + .and_then(\|config\| { + config.config.parse::<bool>().map_err(\|error\| { + logger::error!(?error, "Failed to parse `{config_key}` UCS enabled config"); + }) + }) + .unwrap_or(false); + + is_enabled +} + pub async fn should_execute_based_on_rollout( state: &SessionState, config_key: &str, diff --git a/crates/router/src/core/unified_connector_service.rs b/crates/router/src/core/unified_connector_service.rs index 14836ff20c6..8c246facaf8 100644 --- a/crates/router/src/core/unified_connector_service.rs +++ b/crates/router/src/core/unified_connector_service.rs @@ -22,7 +22,9 @@ use crate::{ consts, core::{ errors::RouterResult, - payments::helpers::{should_execute_based_on_rollout, MerchantConnectorAccountType}, + payments::helpers::{ + is_ucs_enabled, should_execute_based_on_rollout, MerchantConnectorAccountType, + }, utils::get_flow_name, }, routes::SessionState, @@ -36,6 +38,16 @@ pub async fn should_call_unified_connector_service<F: Clone, T>( merchant_context: &MerchantContext, router_data: &RouterData<F, T, PaymentsResponseData>, ) -> RouterResult<bool> { + if state.grpc_client.unified_connector_service_client.is_none() { + return Ok(false); + } + + let ucs_config_key = consts::UCS_ENABLED; + + if !is_ucs_enabled(state, ucs_config_key).await { + return Ok(false); + } + let merchant_id = merchant_context .get_merchant_account() .get_id() @@ -55,7 +67,7 @@ pub async fn should_call_unified_connector_service<F: Clone, T>( ); let should_execute = should_execute_based_on_rollout(state, &config_key).await?; - Ok(should_execute && state.grpc_client.unified_connector_service_client.is_some()) + Ok(should_execute) } pub fn build_unified_connector_service_payment_method(	2025-07-15T11:06:22Z	# feat(core): Implement UCS enable/disable configuration for operational control ## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ### Fixes #8644 ## Description <!-- Describe your changes in detail --> This PR implements a database-driven enable/disable configuration for the Unified Connector Service (UCS) integration, providing operators with immediate control to enable or disable UCS without requiring code changes or deployments. Key Features Implemented: 1. Database Configuration: UCS enabled state stored as `UCS_ENABLED` config 2. Priority Check: UCS enabled check happens before rollout percentage evaluation 3. Immediate Effect: Changes take effect without service restart 4. Clear Error Handling: Returns appropriate error when UCS is disabled Architecture: ``` Payment Request → should_call_unified_connector_service() → ├── Check if UCS client exists ├── Check if UCS is enabled (NEW) ├── Check rollout percentage └── Return decision (true/false) ``` Key Technical Improvements: - Added Enable Check: `is_ucs_enabled()` function queries database config - Early Return Logic: UCS enabled state evaluated before any other UCS conditions - Logging Support: Errors logged when UCS enabled config fetch fails - Consistent Decision Flow: UCS enabled config affects both regular and internal payment operations Files Modified: - `crates/router/src/consts.rs` - Added `UCS_ENABLED` constant - `crates/router/src/core/payments/helpers.rs` - Added `is_ucs_enabled()` helper function - `crates/router/src/core/unified_connector_service.rs` - Integrated UCS enabled check in decision flow - `crates/router/src/core/payments.rs` - Updated fallback behavior for internal operations Important Caveat: - Regular Payment Operations (`payments_operation_core`): When UCS is disabled, `should_call_unified_connector_service()` returns false and traditional connector flow is used - Internal Payment Operations (`internal_payments_operation_core`): Fallback to traditional connector flow has been removed - system now returns error when UCS is unavailable - This ensures that internal operations have explicit failure handling rather than silent fallback ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> Operational Safety Requirements: This change addresses critical operational needs for managing the UCS integration in production environments: Incident Response: - Immediate Control: During UCS outages, operators can disable it instantly - No Deployment Required: Enable/disable via database update - Reduced MTTR: Faster incident resolution without code changes Risk Management: - Additional Safety Layer: Complements existing percentage-based rollout - Granular Control: Can disable UCS while keeping rollout config intact - Debugging Support: Easily isolate UCS-related issues Implementation Benefits: - Zero Downtime: Configuration change without service restart - Audit Trail: Database config changes are trackable - Simple Toggle: Enable/disable UCS by changing config value - Testing Flexibility: Easy A/B testing in production Use Cases: 1. Emergency Response: Disable UCS during critical incidents 2. Maintenance Windows: Temporarily disable during UCS updates 3. Performance Issues: Quick disable if UCS causes latency 4. Debugging: Isolate issues to UCS vs traditional flow ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> ### Manual Testing #### Test Scenario: UCS Enable/Disable Toggle Behavior 1. Default Behavior (UCS Not Configured/Disabled) - Make a payment request - Verify traditional connector flow is used when config is not set - Check logs confirm UCS integration is inactive 2. Enable UCS ```bash curl --location 'http://localhost:8080/configs/UCS_ENABLED' \ --header 'Content-Type: application/json' \ --header 'api-key: test_admin' \ --header 'x-tenant-id: public' \ --data '{ "key": "UCS_ENABLED", "value": "true" }' ``` 3. Test with UCS Enabled - Make payment request and verify UCS is called based on rollout percentage - Check logs for UCS activation based on rollout logic Sample Payment Request: ```bash curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'api-key: dev_test_key' \ --data '{ "amount": 2000, "currency": "USD", "confirm": true, "capture_method": "automatic", "payment_method": "card", "payment_method_data": { "card": { "card_number": "4242424242424242", "card_exp_month": "10", "card_exp_year": "25", "card_holder_name": "John Doe", "card_cvc": "737" } }, "billing": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Francisco", "state": "California", "zip": "94122", "country": "US", "first_name": "John", "last_name": "Doe" } } }' ``` 4. Disable UCS ```bash curl --location 'http://localhost:8080/configs/UCS_ENABLED' \ --header 'Content-Type: application/json' \ --header 'api-key: test_admin' \ --header 'x-tenant-id: public' \ --data '{ "key": "UCS_ENABLED", "value": "false" }' ``` 5. Verify UCS is Disabled - Make another payment request (use same curl command from step 3) - Regular Payment Operations: Verify traditional connector flow is used - Internal Payment Operations: Verify operations return error (no fallback) - Confirm system behavior with UCS disabled Additional Test Cases: Test Invalid Config Value: ```bash curl --location 'http://localhost:8080/configs/UCS_ENABLED' \ --header 'Content-Type: application/json' \ --header 'api-key: test_admin' \ --header 'x-tenant-id: public' \ --data '{ "key": "UCS_ENABLED", "value": "invalid_value" }' ``` - Verify system defaults to UCS disabled - Check error logs for parsing failure Retrieve Current UCS Status: ```bash curl --location 'http://localhost:8080/configs/UCS_ENABLED' \ --header 'api-key: test_admin' \ --header 'x-tenant-id: public' ``` - Verify response shows current UCS enabled state Expected Results: - UCS enable/disable takes immediate effect without service restart - When disabled (`false`), `should_call_unified_connector_service()` returns false - When enabled (`true`), normal UCS rollout logic applies - Regular payment operations use traditional connector flow when UCS disabled - Internal payment operations return error when UCS disabled (no fallback) - Invalid/missing config defaults to UCS disabled for safety ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	064113a4c96c77d83e1e0230a56678863dd8f7db	064113a4c96c77d83e1e0230a56678863dd8f7db
juspay/hyperswitch	juspay__hyperswitch-8653	Bug: Recurring on NMI ### Discussed in https://github.com/juspay/hyperswitch/discussions/8291 <div type='discussions-op-text'> <sup>Originally posted by jschrecurly June 9, 2025</sup> Add recurring payment support for NMI.</div>	diff --git a/crates/hyperswitch_connectors/src/connectors/nmi.rs b/crates/hyperswitch_connectors/src/connectors/nmi.rs index b2037c45256..7ae21664e73 100644 --- a/crates/hyperswitch_connectors/src/connectors/nmi.rs +++ b/crates/hyperswitch_connectors/src/connectors/nmi.rs @@ -38,7 +38,7 @@ use hyperswitch_interfaces::{ types::{ PaymentsAuthorizeType, PaymentsCaptureType, PaymentsCompleteAuthorizeType, PaymentsPreProcessingType, PaymentsSyncType, PaymentsVoidType, RefundExecuteType, - RefundSyncType, Response, + RefundSyncType, Response, SetupMandateType, }, webhooks::{IncomingWebhook, IncomingWebhookRequestDetails}, }; @@ -48,7 +48,7 @@ use transformers as nmi; use crate::{ types::ResponseRouterData, - utils::{construct_not_supported_error_report, convert_amount, get_header_key_value}, + utils::{self, construct_not_supported_error_report, convert_amount, get_header_key_value}, }; #[derive(Clone)] @@ -161,6 +161,16 @@ impl ConnectorValidation for Nmi { // in case we dont have transaction id, we can make psync using attempt id Ok(()) } + + fn validate_mandate_payment( + &self, + pm_type: Option<enums::PaymentMethodType>, + pm_data: hyperswitch_domain_models::payment_method_data::PaymentMethodData, + ) -> CustomResult<(), ConnectorError> { + let mandate_supported_pmd = + std::collections::HashSet::from([utils::PaymentMethodDataType::Card]); + utils::is_mandate_supported(pm_data, pm_type, mandate_supported_pmd, self.id()) + } } impl ConnectorIntegration<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData> @@ -194,27 +204,23 @@ impl ConnectorIntegration<SetupMandate, SetupMandateRequestData, PaymentsRespons req: &SetupMandateRouterData, _connectors: &Connectors, ) -> CustomResult<RequestContent, ConnectorError> { - let connector_req = nmi::NmiPaymentsRequest::try_from(req)?; + let connector_req = nmi::NmiValidateRequest::try_from(req)?; Ok(RequestContent::FormUrlEncoded(Box::new(connector_req))) } fn build_request( &self, - _req: &SetupMandateRouterData, - _connectors: &Connectors, + req: &SetupMandateRouterData, + connectors: &Connectors, ) -> CustomResult<Option<Request>, ConnectorError> { - Err(ConnectorError::NotImplemented("Setup Mandate flow for Nmi".to_string()).into()) - - // Ok(Some( - // RequestBuilder::new() - // .method(Method::Post) - // .url(&SetupMandateType::get_url(self, req, connectors)?) - // .headers(SetupMandateType::get_headers(self, req, connectors)?) - // .set_body(SetupMandateType::get_request_body( - // self, req, connectors, - // )?) - // .build(), - // )) + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&SetupMandateType::get_url(self, req, connectors)?) + .headers(SetupMandateType::get_headers(self, req, connectors)?) + .set_body(SetupMandateType::get_request_body(self, req, connectors)?) + .build(), + )) } fn handle_response( diff --git a/crates/hyperswitch_connectors/src/connectors/nmi/transformers.rs b/crates/hyperswitch_connectors/src/connectors/nmi/transformers.rs index ec5ce3b2e65..32436f307af 100644 --- a/crates/hyperswitch_connectors/src/connectors/nmi/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/nmi/transformers.rs @@ -1,8 +1,6 @@ use api_models::webhooks::IncomingWebhookEvent; use cards::CardNumber; -use common_enums::{ - AttemptStatus, AuthenticationType, CaptureMethod, CountryAlpha2, Currency, RefundStatus, -}; +use common_enums::{AttemptStatus, AuthenticationType, CountryAlpha2, Currency, RefundStatus}; use common_utils::{errors::CustomResult, ext_traits::XmlExt, pii::Email, types::FloatMajorUnit}; use error_stack::{report, Report, ResultExt}; use hyperswitch_domain_models::{ @@ -351,6 +349,7 @@ pub struct NmiCompleteResponse { pub cvvresponse: Option<String>, pub orderid: String, pub response_code: String, + customer_vault_id: Option<Secret<String>>, } impl @@ -377,17 +376,27 @@ impl Ok(PaymentsResponseData::TransactionResponse { resource_id: ResponseId::ConnectorTransactionId(item.response.transactionid), redirection_data: Box::new(None), - mandate_reference: Box::new(None), + mandate_reference: match item.response.customer_vault_id { + Some(vault_id) => Box::new(Some( + hyperswitch_domain_models::router_response_types::MandateReference { + connector_mandate_id: Some(vault_id.expose()), + payment_method_id: None, + mandate_metadata: None, + connector_mandate_request_reference_id: None, + }, + )), + None => Box::new(None), + }, connector_metadata: None, network_txn_id: None, connector_response_reference_id: Some(item.response.orderid), incremental_authorization_allowed: None, charges: None, }), - if let Some(CaptureMethod::Automatic) = item.data.request.capture_method { - AttemptStatus::CaptureInitiated + if item.data.request.is_auto_capture()? { + AttemptStatus::Charged } else { - AttemptStatus::Authorizing + AttemptStatus::Authorized }, ), Response::Declined \| Response::Error => ( @@ -417,6 +426,18 @@ fn get_nmi_error_response(response: NmiCompleteResponse, http_code: u16) -> Erro } } +#[derive(Debug, Serialize)] +pub struct NmiValidateRequest { + #[serde(rename = "type")] + transaction_type: TransactionType, + security_key: Secret<String>, + ccnumber: CardNumber, + ccexp: Secret<String>, + cvv: Secret<String>, + orderid: String, + customer_vault: CustomerAction, +} + #[derive(Debug, Serialize)] pub struct NmiPaymentsRequest { #[serde(rename = "type")] @@ -429,6 +450,8 @@ pub struct NmiPaymentsRequest { #[serde(flatten)] merchant_defined_field: Option<NmiMerchantDefinedField>, orderid: String, + #[serde(skip_serializing_if = "Option::is_none")] + customer_vault: Option<CustomerAction>, } #[derive(Debug, Serialize)] @@ -462,6 +485,12 @@ pub enum PaymentMethod { CardThreeDs(Box<CardThreeDsData>), GPay(Box<GooglePayData>), ApplePay(Box<ApplePayData>), + MandatePayment(Box<MandatePayment>), +} + +#[derive(Debug, Serialize)] +pub struct MandatePayment { + customer_vault_id: Secret<String>, } #[derive(Debug, Serialize)] @@ -503,25 +532,70 @@ impl TryFrom<&NmiRouterData<&PaymentsAuthorizeRouterData>> for NmiPaymentsReques }; let auth_type: NmiAuthType = (&item.router_data.connector_auth_type).try_into()?; let amount = item.amount; - let payment_method = PaymentMethod::try_from(( - &item.router_data.request.payment_method_data, - Some(item.router_data), - ))?; - Ok(Self { - transaction_type, - security_key: auth_type.api_key, - amount, - currency: item.router_data.request.currency, - payment_method, - merchant_defined_field: item - .router_data - .request - .metadata - .as_ref() - .map(NmiMerchantDefinedField::new), - orderid: item.router_data.connector_request_reference_id.clone(), - }) + match item + .router_data + .request + .mandate_id + .clone() + .and_then(\|mandate_ids\| mandate_ids.mandate_reference_id) + { + Some(api_models::payments::MandateReferenceId::ConnectorMandateId( + connector_mandate_id, + )) => Ok(Self { + transaction_type, + security_key: auth_type.api_key, + amount, + currency: item.router_data.request.currency, + payment_method: PaymentMethod::MandatePayment(Box::new(MandatePayment { + customer_vault_id: Secret::new( + connector_mandate_id + .get_connector_mandate_id() + .ok_or(ConnectorError::MissingConnectorMandateID)?, + ), + })), + merchant_defined_field: item + .router_data + .request + .metadata + .as_ref() + .map(NmiMerchantDefinedField::new), + orderid: item.router_data.connector_request_reference_id.clone(), + customer_vault: None, + }), + Some(api_models::payments::MandateReferenceId::NetworkMandateId(_)) + \| Some(api_models::payments::MandateReferenceId::NetworkTokenWithNTI(_)) => { + Err(ConnectorError::NotImplemented( + get_unimplemented_payment_method_error_message("nmi"), + ))? + } + None => { + let payment_method = PaymentMethod::try_from(( + &item.router_data.request.payment_method_data, + Some(item.router_data), + ))?; + + Ok(Self { + transaction_type, + security_key: auth_type.api_key, + amount, + currency: item.router_data.request.currency, + payment_method, + merchant_defined_field: item + .router_data + .request + .metadata + .as_ref() + .map(NmiMerchantDefinedField::new), + orderid: item.router_data.connector_request_reference_id.clone(), + customer_vault: item + .router_data + .request + .is_mandate_payment() + .then_some(CustomerAction::AddCustomer), + }) + } + } } } @@ -662,20 +736,36 @@ impl From<&ApplePayWalletData> for PaymentMethod { } } -impl TryFrom<&SetupMandateRouterData> for NmiPaymentsRequest { +impl TryFrom<&SetupMandateRouterData> for NmiValidateRequest { type Error = Error; fn try_from(item: &SetupMandateRouterData) -> Result<Self, Self::Error> { - let auth_type: NmiAuthType = (&item.connector_auth_type).try_into()?; - let payment_method = PaymentMethod::try_from((&item.request.payment_method_data, None))?; - Ok(Self { - transaction_type: TransactionType::Validate, - security_key: auth_type.api_key, - amount: FloatMajorUnit::zero(), - currency: item.request.currency, - payment_method, - merchant_defined_field: None, - orderid: item.connector_request_reference_id.clone(), - }) + match item.request.amount { + Some(amount) if amount > 0 => Err(ConnectorError::FlowNotSupported { + flow: "Setup Mandate with non zero amount".to_string(), + connector: "NMI".to_string(), + } + .into()), + _ => { + if let PaymentMethodData::Card(card_details) = &item.request.payment_method_data { + let auth_type: NmiAuthType = (&item.connector_auth_type).try_into()?; + Ok(Self { + transaction_type: TransactionType::Validate, + security_key: auth_type.api_key, + ccnumber: card_details.card_number.clone(), + ccexp: card_details + .get_card_expiry_month_year_2_digit_with_delimiter("".to_string())?, + cvv: card_details.card_cvc.clone(), + orderid: item.connector_request_reference_id.clone(), + customer_vault: CustomerAction::AddCustomer, + }) + } else { + Err(ConnectorError::NotImplemented( + get_unimplemented_payment_method_error_message("Nmi"), + ) + .into()) + } + } + } } } @@ -746,7 +836,7 @@ impl incremental_authorization_allowed: None, charges: None, }), - AttemptStatus::CaptureInitiated, + AttemptStatus::Charged, ), Response::Declined \| Response::Error => ( Err(get_standard_error_response(item.response, item.http_code)), @@ -827,6 +917,7 @@ pub struct StandardResponse { pub cvvresponse: Option<String>, pub orderid: String, pub response_code: String, + pub customer_vault_id: Option<Secret<String>>, } impl<T> TryFrom<ResponseRouterData<SetupMandate, StandardResponse, T, PaymentsResponseData>> @@ -843,7 +934,17 @@ impl<T> TryFrom<ResponseRouterData<SetupMandate, StandardResponse, T, PaymentsRe item.response.transactionid.clone(), ), redirection_data: Box::new(None), - mandate_reference: Box::new(None), + mandate_reference: match item.response.customer_vault_id { + Some(vault_id) => Box::new(Some( + hyperswitch_domain_models::router_response_types::MandateReference { + connector_mandate_id: Some(vault_id.expose()), + payment_method_id: None, + mandate_metadata: None, + connector_mandate_request_reference_id: None, + }, + )), + None => Box::new(None), + }, connector_metadata: None, network_txn_id: None, connector_response_reference_id: Some(item.response.orderid), @@ -897,15 +998,25 @@ impl TryFrom<PaymentsResponseRouterData<StandardResponse>> item.response.transactionid.clone(), ), redirection_data: Box::new(None), - mandate_reference: Box::new(None), + mandate_reference: match item.response.customer_vault_id { + Some(vault_id) => Box::new(Some( + hyperswitch_domain_models::router_response_types::MandateReference { + connector_mandate_id: Some(vault_id.expose()), + payment_method_id: None, + mandate_metadata: None, + connector_mandate_request_reference_id: None, + }, + )), + None => Box::new(None), + }, connector_metadata: None, network_txn_id: None, connector_response_reference_id: Some(item.response.orderid), incremental_authorization_allowed: None, charges: None, }), - if let Some(CaptureMethod::Automatic) = item.data.request.capture_method { - AttemptStatus::CaptureInitiated + if item.data.request.is_auto_capture()? { + AttemptStatus::Charged } else { AttemptStatus::Authorized }, @@ -1094,7 +1205,7 @@ impl TryFrom<RefundsResponseRouterData<Capture, StandardResponse>> for RefundsRo impl From<Response> for RefundStatus { fn from(item: Response) -> Self { match item { - Response::Approved => Self::Pending, + Response::Approved => Self::Success, Response::Declined \| Response::Error => Self::Failure, } }	2025-07-15T11:32:51Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> Mandate payments support has been added to NMI. https://support.nmi.com/hc/en-gb/articles/13923047779729-Using-the-Customer-Vault ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> https://github.com/juspay/hyperswitch/discussions/8291 https://github.com/juspay/hyperswitch/issues/8653 ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> Tested and added relevant cypress tests. CIT: Request: ``` curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_6Qh8tlhJxGnzCnYSgZLYUcZg3se94a12xetjLpMLCE3srm2F6E3szTR3vJ8IRzxA' \ --data-raw '{ "amount": 1122, "currency": "USD", "confirm": true, "profile_id": "pro_prQtzjS2YNKFt8NTnPhS", "authentication_type": "no_three_ds", "email": "[email protected]", "customer_id": "vaily", "return_url": "https://google.com", "payment_method": "card", "payment_method_type": "credit", "payment_method_data": { "card": { "card_number": "4532111111111112", "card_exp_month": "10", "card_exp_year": "25", "card_cvc": "123" } }, "setup_future_usage": "off_session", "customer_acceptance": { "acceptance_type": "online" } }' ``` Response: ``` { "payment_id": "pay_VosL2oOd5lEpfI5PFdAF", "merchant_id": "merchant_1754040245", "status": "succeeded", "amount": 1122, "net_amount": 1122, "shipping_cost": null, "amount_capturable": 0, "amount_received": 1122, "connector": "nmi", "client_secret": "pay_VosL2oOd5lEpfI5PFdAF_secret_pwdKA6SfrJQA90LvmvQD", "created": "2025-08-01T10:36:17.871Z", "currency": "USD", "customer_id": "vaily", "customer": { "id": "vaily", "name": null, "email": "[email protected]", "phone": null, "phone_country_code": null }, "description": null, "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": "off_session", "off_session": null, "capture_on": null, "capture_method": null, "payment_method": "card", "payment_method_data": { "card": { "last4": "1112", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "453211", "card_extended_bin": null, "card_exp_month": "10", "card_exp_year": "25", "card_holder_name": null, "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": "token_4z27khJu7gCT1bLHEHse", "shipping": null, "billing": null, "order_details": null, "email": "[email protected]", "name": null, "phone": null, "return_url": "https://google.com/", "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "credit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": { "customer_id": "vaily", "created_at": 1754044577, "expires": 1754048177, "secret": "epk_554d3664984344ca9fe39c48ff4ff5ef" }, "manual_retry_allowed": false, "connector_transaction_id": "10979926051", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_VosL2oOd5lEpfI5PFdAF_1", "payment_link": null, "profile_id": "pro_prQtzjS2YNKFt8NTnPhS", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_PbTIQbItUvYnnqZyRRrC", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-08-01T10:51:17.871Z", "fingerprint": null, "browser_info": null, "payment_method_id": "pm_MFTGiuZQ7jQOCCsyzy8p", "payment_method_status": "active", "updated": "2025-08-01T10:36:20.930Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": "212727464", "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` MIT: Request: ``` curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_6Qh8tlhJxGnzCnYSgZLYUcZg3se94a12xetjLpMLCE3srm2F6E3szTR3vJ8IRzxA' \ --data '{ "amount": 1212, "currency": "USD", "confirm": true, "capture_method": "manual", "customer_id": "vaily2", "recurring_details": { "type": "payment_method_id", "data": "pm_A6hbrqOFGArsNKgjkC9g" }, "off_session": true }' ``` Response: ``` { "payment_id": "pay_vi4nShu5q4lHUEMgOnr3", "merchant_id": "merchant_1754040245", "status": "requires_capture", "amount": 1212, "net_amount": 1212, "shipping_cost": null, "amount_capturable": 1212, "amount_received": null, "connector": "nmi", "client_secret": "pay_vi4nShu5q4lHUEMgOnr3_secret_j3hvcXvZE1amCwsXIEqZ", "created": "2025-08-01T11:40:10.511Z", "currency": "USD", "customer_id": "vaily2", "customer": { "id": "vaily2", "name": null, "email": "[email protected]", "phone": null, "phone_country_code": null }, "description": null, "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": true, "capture_on": null, "capture_method": "manual", "payment_method": "card", "payment_method_data": { "card": { "last4": "1112", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "453211", "card_extended_bin": null, "card_exp_month": "10", "card_exp_year": "25", "card_holder_name": null, "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": null, "billing": null, "order_details": null, "email": "[email protected]", "name": null, "phone": null, "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "credit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": { "customer_id": "vaily2", "created_at": 1754048410, "expires": 1754052010, "secret": "epk_a9715d624aea41ec9f9428eaaaf8a6a6" }, "manual_retry_allowed": false, "connector_transaction_id": "10980179170", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_vi4nShu5q4lHUEMgOnr3_1", "payment_link": null, "profile_id": "pro_prQtzjS2YNKFt8NTnPhS", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_PbTIQbItUvYnnqZyRRrC", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-08-01T11:55:10.511Z", "fingerprint": null, "browser_info": null, "payment_method_id": "pm_A6hbrqOFGArsNKgjkC9g", "payment_method_status": "active", "updated": "2025-08-01T11:40:13.459Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": "1452310032", "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` Zero Dollar CIT: Request: ``` curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_uOYRh8w3a91uu4wD3LFPEXGKB1TqAk6Vi1weDW4da6jde8CnAIK9pjlmixcwDqmk' \ --data-raw '{ "amount": 0, "currency": "USD", "confirm": true, "profile_id": "null", "authentication_type": "no_three_ds", "email": "[email protected]", "customer_id": "email", "payment_method": "card", "payment_method_type": "credit", "payment_method_data": { "card": { "card_number": "4532111111111112", "card_exp_month": "10", "card_exp_year": "25", "card_cvc": "123" } }, "setup_future_usage": "off_session", "customer_acceptance": { "acceptance_type": "online" }, "payment_type": "setup_mandate" }' ``` Response: ``` { "payment_id": "pay_ZMLElkI1TmhSqv7gIOO5", "merchant_id": "merchant_1754412298", "status": "succeeded", "amount": 0, "net_amount": 0, "shipping_cost": null, "amount_capturable": 0, "amount_received": null, "connector": "nmi", "client_secret": "pay_ZMLElkI1TmhSqv7gIOO5_secret_u5yYt4m3R8cDkutUIEV5", "created": "2025-08-05T16:46:39.306Z", "currency": "USD", "customer_id": "email", "customer": { "id": "email", "name": null, "email": "[email protected]", "phone": null, "phone_country_code": null }, "description": null, "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": "off_session", "off_session": null, "capture_on": null, "capture_method": null, "payment_method": "card", "payment_method_data": { "card": { "last4": "1112", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "453211", "card_extended_bin": null, "card_exp_month": "10", "card_exp_year": "25", "card_holder_name": null, "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": "token_QK0QtaO95lHS7dKGUTDd", "shipping": null, "billing": null, "order_details": null, "email": "[email protected]", "name": null, "phone": null, "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "credit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": { "customer_id": "email", "created_at": 1754412399, "expires": 1754415999, "secret": "epk_3d19001aea854585ac6ac597d4c31854" }, "manual_retry_allowed": false, "connector_transaction_id": "10996495844", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_ZMLElkI1TmhSqv7gIOO5_1", "payment_link": null, "profile_id": "pro_IR3qBTXCy9Mf2JnwgGx9", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_a2TxMLhdzJcO8xG0qDSD", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-08-05T17:01:39.305Z", "fingerprint": null, "browser_info": null, "payment_channel": null, "payment_method_id": "pm_w2iyEnG6GTv00S35UfKn", "network_transaction_id": null, "payment_method_status": "active", "updated": "2025-08-05T16:46:42.940Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": "231615292", "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` Cypress Tests: <img width="561" height="861" alt="image" src="https://github.com/user-attachments/assets/16711370-5966-47aa-8f55-f553edbc5370" /> <img width="342" height="674" alt="image" src="https://github.com/user-attachments/assets/268e8139-4d0c-4ab3-be4d-beadcae15835" /> ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	cf5737f48261905997571f2cd64feea7608ee825	cf5737f48261905997571f2cd64feea7608ee825
juspay/hyperswitch	juspay__hyperswitch-8639	Bug: [REFACTOR] payment link's flow An expected high level payment link's lifecycle is mentioned below - Create payment link - Render payment link - Confirm via payment widget - If 3DS [always perform top redirection] - Redirect to external page - Once actions are performed, submit on page - External page redirects back to HS - HS redirects back to merchant's `return_url` - If No3DS - Redirect to status page (current window) - Wait for 5 seconds - Redirect to merchant's `return_url` [always perform top redirection] Current behavior is similar expect for the last step in No3DS - instead of redirecting to merchant's page in top, it performs a redirection in current window. This needs to be updated to perform a top redirection.	diff --git a/crates/router/src/core/payment_link/payment_link_status/status.js b/crates/router/src/core/payment_link/payment_link_status/status.js index 371fdf1d2df..863c4239757 100644 --- a/crates/router/src/core/payment_link/payment_link_status/status.js +++ b/crates/router/src/core/payment_link/payment_link_status/status.js @@ -360,7 +360,7 @@ function renderStatusDetails(paymentDetails) { url.search = params.toString(); setTimeout(function () { // Finally redirect - window.location.href = url.toString(); + window.top.location.href = url.toString(); }, 1000); } }, i * 1000);	2025-07-15T08:42:49Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [ ] New feature - [ ] Enhancement - [x] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description This PR updates the behavior of final redirection to use top redirection when payment link's status page is present in the flow as well. Explained in https://github.com/juspay/hyperswitch/issues/8639 ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context Helps keep the behavior of payment links consistent. ## How did you test it? <details> <summary>1. Create a default payment link</summary> cURL curl --location --request POST 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_l9cbI5mKxdcSM5xnj2wiPTQGwO0lXCXDnHBeiCL9v9mbgQfYPdNcxSyEO8EHhaQN' \ --data '{"payment_id":"25c03e52-2ed0-4ca9-9841-5554f1857d8b","authentication_type":"three_ds","customer_id":"cus_UWxTZBStM3s2FzdDGGun","profile_id":"pro_gSujWAfJukk8ammz6aft","customer_acceptance":{"acceptance_type":"online","accepted_at":"1963-05-03T04:07:52.723Z","online":{"ip_address":"127.0.0.1","user_agent":"amet irure esse"}},"setup_future_usage":"off_session","amount":1,"currency":"EUR","confirm":false,"payment_link":true,"session_expiry":2629800,"payment_link_config":{},"return_url":"https://www.example.com"}' Response {"payment_id":"fdb4c32a-c9ff-4742-a3f4-0cdc03d04f52","merchant_id":"merchant_1752567879","status":"requires_payment_method","amount":1,"net_amount":1,"shipping_cost":null,"amount_capturable":0,"amount_received":null,"connector":null,"client_secret":"fdb4c32a-c9ff-4742-a3f4-0cdc03d04f52_secret_YM3fNu32vNuM3v8lrJzR","created":"2025-07-15T08:28:36.362Z","currency":"EUR","customer_id":"cus_UWxTZBStM3s2FzdDGGun","customer":{"id":"cus_UWxTZBStM3s2FzdDGGun","name":null,"email":null,"phone":null,"phone_country_code":null},"description":null,"refunds":null,"disputes":null,"mandate_id":null,"mandate_data":null,"setup_future_usage":"off_session","off_session":null,"capture_on":null,"capture_method":null,"payment_method":null,"payment_method_data":null,"payment_token":null,"shipping":null,"billing":null,"order_details":null,"email":null,"name":null,"phone":null,"return_url":"https://www.example.com/","authentication_type":"three_ds","statement_descriptor_name":null,"statement_descriptor_suffix":null,"next_action":null,"cancellation_reason":null,"error_code":null,"error_message":null,"unified_code":null,"unified_message":null,"payment_experience":null,"payment_method_type":null,"connector_label":null,"business_country":null,"business_label":"default","business_sub_label":null,"allowed_payment_method_types":null,"ephemeral_key":{"customer_id":"cus_UWxTZBStM3s2FzdDGGun","created_at":1752568116,"expires":1752571716,"secret":"epk_06cd3c6510724493aee541a72cb1a5c2"},"manual_retry_allowed":null,"connector_transaction_id":null,"frm_message":null,"metadata":null,"connector_metadata":null,"feature_metadata":null,"reference_id":null,"payment_link":{"link":"http://localhost:8080/payment_link/merchant_1752567879/fdb4c32a-c9ff-4742-a3f4-0cdc03d04f52?locale=en","secure_link":null,"payment_link_id":"plink_NkEB0uKH4Tg5baxkU7NF"},"profile_id":"pro_gSujWAfJukk8ammz6aft","surcharge_details":null,"attempt_count":1,"merchant_decision":null,"merchant_connector_id":null,"incremental_authorization_allowed":null,"authorization_count":null,"incremental_authorizations":null,"external_authentication_details":null,"external_3ds_authentication_attempted":false,"expires_on":"2025-08-14T18:58:36.361Z","fingerprint":null,"browser_info":null,"payment_method_id":null,"payment_method_status":null,"updated":"2025-07-15T08:28:36.369Z","split_payments":null,"frm_metadata":null,"extended_authorization_applied":null,"capture_before":null,"merchant_order_reference_id":null,"order_tax_amount":null,"connector_mandate_id":null,"card_discovery":null,"force_3ds_challenge":false,"force_3ds_challenge_trigger":false,"issuer_error_code":null,"issuer_error_message":null,"is_iframe_redirection_enabled":null,"whole_connector_response":null} </details> <details> <summary>2. Open payment link inside an and process using a non 3DS card</summary> Iframe template <html lang="en"> <head> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Document</title> <style> html, body { margin: 0; display: flex; align-items: center; justify-content: center; background-color: black; height: 100vh; width: 100vw; } iframe { border-radius: 4px; height: 90vh; width: 90vw; background-color: white; } </style> </head> <body> <iframe allow="payment" src="http://localhost:8080/payment_link/merchant_1752567879/12883fad-a7ce-4535-a327-7eccabb1258c?locale=en" frameborder="0" ></iframe> </body> <!-- <script src="https://6498-49-207-207-180.ngrok-free.app/HyperLoader.js" ></script> --> </html> Test cards https://docs.adyen.com/development-resources/testing/test-card-numbers/#visa Behavior - Redirection to status page happens inside an iframe - Redirection to return_url happens in top <img width="949" height="938" alt="Screenshot 2025-07-15 at 2 08 07 PM" src="https://github.com/user-attachments/assets/66846803-9dba-48e8-a843-a3ddcfdaac20" /> <img width="947" height="939" alt="Screenshot 2025-07-15 at 2 08 11 PM" src="https://github.com/user-attachments/assets/7c5435f0-ac8f-4b49-8a12-34c8032f2269" /> </details> <details> <summary>3. Create a payment link skipping the status screen</summary> cURL curl --location --request POST 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_l9cbI5mKxdcSM5xnj2wiPTQGwO0lXCXDnHBeiCL9v9mbgQfYPdNcxSyEO8EHhaQN' \ --data '{"payment_id":"d60872e7-104d-493d-a88b-1030ccde869d","authentication_type":"three_ds","customer_id":"cus_UWxTZBStM3s2FzdDGGun","profile_id":"pro_gSujWAfJukk8ammz6aft","customer_acceptance":{"acceptance_type":"online","accepted_at":"1963-05-03T04:07:52.723Z","online":{"ip_address":"127.0.0.1","user_agent":"amet irure esse"}},"setup_future_usage":"off_session","amount":1,"currency":"EUR","confirm":false,"payment_link":true,"session_expiry":2629800,"payment_link_config":{"skip_status_screen":true},"return_url":"https://www.example.com"}' Response {"payment_id":"d69f0158-a3bc-44ac-80d7-931f60eb102e","merchant_id":"merchant_1752567879","status":"requires_payment_method","amount":1,"net_amount":1,"shipping_cost":null,"amount_capturable":0,"amount_received":null,"connector":null,"client_secret":"d69f0158-a3bc-44ac-80d7-931f60eb102e_secret_sj4ENrQbMcZM87VvlwSg","created":"2025-07-15T08:34:22.075Z","currency":"EUR","customer_id":"cus_UWxTZBStM3s2FzdDGGun","customer":{"id":"cus_UWxTZBStM3s2FzdDGGun","name":null,"email":null,"phone":null,"phone_country_code":null},"description":null,"refunds":null,"disputes":null,"mandate_id":null,"mandate_data":null,"setup_future_usage":"off_session","off_session":null,"capture_on":null,"capture_method":null,"payment_method":null,"payment_method_data":null,"payment_token":null,"shipping":null,"billing":null,"order_details":null,"email":null,"name":null,"phone":null,"return_url":"https://www.example.com/","authentication_type":"three_ds","statement_descriptor_name":null,"statement_descriptor_suffix":null,"next_action":null,"cancellation_reason":null,"error_code":null,"error_message":null,"unified_code":null,"unified_message":null,"payment_experience":null,"payment_method_type":null,"connector_label":null,"business_country":null,"business_label":"default","business_sub_label":null,"allowed_payment_method_types":null,"ephemeral_key":{"customer_id":"cus_UWxTZBStM3s2FzdDGGun","created_at":1752568462,"expires":1752572062,"secret":"epk_c474ec1928d4487799a10fdec281d647"},"manual_retry_allowed":null,"connector_transaction_id":null,"frm_message":null,"metadata":null,"connector_metadata":null,"feature_metadata":null,"reference_id":null,"payment_link":{"link":"http://localhost:8080/payment_link/merchant_1752567879/d69f0158-a3bc-44ac-80d7-931f60eb102e?locale=en","secure_link":null,"payment_link_id":"plink_AG81wLnXtkzSLv1D499u"},"profile_id":"pro_gSujWAfJukk8ammz6aft","surcharge_details":null,"attempt_count":1,"merchant_decision":null,"merchant_connector_id":null,"incremental_authorization_allowed":null,"authorization_count":null,"incremental_authorizations":null,"external_authentication_details":null,"external_3ds_authentication_attempted":false,"expires_on":"2025-08-14T19:04:22.073Z","fingerprint":null,"browser_info":null,"payment_method_id":null,"payment_method_status":null,"updated":"2025-07-15T08:34:22.081Z","split_payments":null,"frm_metadata":null,"extended_authorization_applied":null,"capture_before":null,"merchant_order_reference_id":null,"order_tax_amount":null,"connector_mandate_id":null,"card_discovery":null,"force_3ds_challenge":false,"force_3ds_challenge_trigger":false,"issuer_error_code":null,"issuer_error_message":null,"is_iframe_redirection_enabled":null,"whole_connector_response":null} </details> <details> <summary>4. Open payment link inside an and process using a non 3DS card</summary> Iframe template <html lang="en"> <head> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Document</title> <style> html, body { margin: 0; display: flex; align-items: center; justify-content: center; background-color: black; height: 100vh; width: 100vw; } iframe { border-radius: 4px; height: 90vh; width: 90vw; background-color: white; } </style> </head> <body> <iframe allow="payment" src="http://localhost:8080/payment_link/merchant_1752567879/12883fad-a7ce-4535-a327-7eccabb1258c?locale=en" frameborder="0" ></iframe> </body> <!-- <script src="https://6498-49-207-207-180.ngrok-free.app/HyperLoader.js" ></script> --> </html> Test cards https://docs.adyen.com/development-resources/testing/test-card-numbers/#visa Behavior - Status screen is skipped - Redirection to return_url happens in top <img width="946" height="936" alt="Screenshot 2025-07-15 at 2 04 05 PM" src="https://github.com/user-attachments/assets/16291a93-a167-4195-9e5c-93f709050578" /> <img width="949" height="943" alt="Screenshot 2025-07-15 at 2 04 16 PM" src="https://github.com/user-attachments/assets/1f50ee1f-ca71-41f6-9db7-806dbdb5cf8a" /> </details> ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	871c08249d8006b54fe46d78f835452a39242ba8	871c08249d8006b54fe46d78f835452a39242ba8
juspay/hyperswitch	juspay__hyperswitch-8666	Bug: Update get organization details api response to contain organization type This is a part of the vsaas changes required. The updated response of retrieve organization`GET` api should also contain the organization type.	diff --git a/api-reference/v1/openapi_spec_v1.json b/api-reference/v1/openapi_spec_v1.json index 9239142f57b..96b8f60def3 100644 --- a/api-reference/v1/openapi_spec_v1.json +++ b/api-reference/v1/openapi_spec_v1.json @@ -18423,9 +18423,24 @@ "created_at": { "type": "string", "format": "date-time" + }, + "organization_type": { + "allOf": [ + { + "$ref": "#/components/schemas/OrganizationType" + } + ], + "nullable": true } } }, + "OrganizationType": { + "type": "string", + "enum": [ + "standard", + "platform" + ] + }, "OrganizationUpdateRequest": { "type": "object", "required": [ diff --git a/api-reference/v2/openapi_spec_v2.json b/api-reference/v2/openapi_spec_v2.json index 285a21ba04c..63057b3a9dd 100644 --- a/api-reference/v2/openapi_spec_v2.json +++ b/api-reference/v2/openapi_spec_v2.json @@ -14971,9 +14971,24 @@ "created_at": { "type": "string", "format": "date-time" + }, + "organization_type": { + "allOf": [ + { + "$ref": "#/components/schemas/OrganizationType" + } + ], + "nullable": true } } }, + "OrganizationType": { + "type": "string", + "enum": [ + "standard", + "platform" + ] + }, "OrganizationUpdateRequest": { "type": "object", "required": [ diff --git a/crates/api_models/src/organization.rs b/crates/api_models/src/organization.rs index 50632e66be7..e12b21c143f 100644 --- a/crates/api_models/src/organization.rs +++ b/crates/api_models/src/organization.rs @@ -74,6 +74,10 @@ pub struct OrganizationResponse { pub metadata: Option<pii::SecretSerdeValue>, pub modified_at: time::PrimitiveDateTime, pub created_at: time::PrimitiveDateTime, + + /// Organization Type of the organization + #[schema(value_type = Option<OrganizationType>, example = "standard")] + pub organization_type: Option<OrganizationType>, } #[cfg(feature = "v2")] @@ -95,4 +99,8 @@ pub struct OrganizationResponse { pub metadata: Option<pii::SecretSerdeValue>, pub modified_at: time::PrimitiveDateTime, pub created_at: time::PrimitiveDateTime, + + /// Organization Type of the organization + #[schema(value_type = Option<OrganizationType>, example = "standard")] + pub organization_type: Option<OrganizationType>, } diff --git a/crates/common_enums/src/enums/accounts.rs b/crates/common_enums/src/enums/accounts.rs index 2d575f4d83a..844ef398248 100644 --- a/crates/common_enums/src/enums/accounts.rs +++ b/crates/common_enums/src/enums/accounts.rs @@ -61,6 +61,7 @@ pub enum MerchantAccountType { serde::Serialize, strum::Display, strum::EnumString, + ToSchema, )] #[router_derive::diesel_enum(storage_type = "text")] #[strum(serialize_all = "snake_case")] diff --git a/crates/openapi/src/openapi.rs b/crates/openapi/src/openapi.rs index 766c69c494f..387be8ec75f 100644 --- a/crates/openapi/src/openapi.rs +++ b/crates/openapi/src/openapi.rs @@ -363,6 +363,7 @@ Never share your secret api keys. Keep them guarded and secure. api_models::enums::CtpServiceProvider, api_models::enums::PaymentLinkSdkLabelType, api_models::enums::PaymentLinkShowSdkTerms, + api_models::enums::OrganizationType, api_models::admin::MerchantConnectorCreate, api_models::admin::AdditionalMerchantData, api_models::admin::ConnectorWalletDetails, diff --git a/crates/openapi/src/openapi_v2.rs b/crates/openapi/src/openapi_v2.rs index ba447a4e457..e1cda388a38 100644 --- a/crates/openapi/src/openapi_v2.rs +++ b/crates/openapi/src/openapi_v2.rs @@ -319,6 +319,7 @@ Never share your secret api keys. Keep them guarded and secure. api_models::enums::CtpServiceProvider, api_models::enums::PaymentLinkSdkLabelType, api_models::enums::PaymentLinkShowSdkTerms, + api_models::enums::OrganizationType, api_models::admin::MerchantConnectorCreate, api_models::admin::AdditionalMerchantData, api_models::admin::CardTestingGuardConfig, diff --git a/crates/router/src/types/api/admin.rs b/crates/router/src/types/api/admin.rs index dea8cc0d770..1b478cee4c6 100644 --- a/crates/router/src/types/api/admin.rs +++ b/crates/router/src/types/api/admin.rs @@ -75,6 +75,7 @@ impl ForeignFrom<diesel_models::organization::Organization> for OrganizationResp metadata: org.metadata, modified_at: org.modified_at, created_at: org.created_at, + organization_type: org.organization_type, } } }	2025-07-16T07:14:24Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [ ] New feature - [x] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description Updated `organization_retrieve` api response to contain `organization_type` for v1 and v2 api ### Additional Changes - [x] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> ## How did you test it? Curl for Organization Retrieve ``` curl --location 'http://localhost:8080/organization/org_nib3yNnE0BcUJJ8ptlh2' \ --header 'api-key: test_admin' \ --header 'Content-Type: application/json' ``` Current response ``` { "organization_id": "org_nib3yNnE0BcUJJ8ptlh2", "organization_name": "org_local", "organization_details": null, "metadata": null, "modified_at": "2025-07-15 15:47:00.992814", "created_at": "2025-07-15 15:47:00.992762", } ``` Updated response ``` { "organization_id": "org_nib3yNnE0BcUJJ8ptlh2", "organization_name": "org_local", "organization_details": null, "metadata": null, "modified_at": "2025-07-15 15:47:00.992814", "created_at": "2025-07-15 15:47:00.992762", "organization_type": "standard" } ``` ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	cb83bf8c2f4486fee99f88bc85bd6e6cb4430e13	cb83bf8c2f4486fee99f88bc85bd6e6cb4430e13
juspay/hyperswitch	juspay__hyperswitch-8637	Bug: [FEATURE] expiration for Pix payments ### Feature Description Pix is a payment method in Brazil where customers can scan a QR and pay. This QR code generation usually has an expiry which can be specified during payment intent creation with the underlying payment processors. Currently, there isn't a way to create a Pix QR code specifying the expiry date using HS payments. This needs to be accepted in the `/payments` create API for Pix payment method data and consumed in the connector integration during integration. Flows to keep in mind - ✅ S2S API integrations - `expiry_date` will be specified explicitly - ✅ Payment links - `expiry_date` will depend on the `session_expiry` which dictates the expiration of the payment links ### Possible Implementation For S2S API integrations - accept a new field in Pix bank transfer for specifying the expiration date (`expiry_date`). ToDos - Accept a new optional field in PixBankTransfer - Consume in Adyen integration - https://docs.adyen.com/payment-methods/pix/api-only/#make-payment ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? None	diff --git a/api-reference/v1/openapi_spec_v1.json b/api-reference/v1/openapi_spec_v1.json index 96b8f60def3..11de67e7744 100644 --- a/api-reference/v1/openapi_spec_v1.json +++ b/api-reference/v1/openapi_spec_v1.json @@ -9413,6 +9413,12 @@ "description": "Destination bank account number", "example": "9b95f84e-de61-460b-a14b-f23b4e71c97b", "nullable": true + }, + "expiry_date": { + "type": "string", + "description": "The expiration date and time for the Pix QR code in ISO 8601 format", + "example": "2025-09-10T10:11:12Z", + "nullable": true } } } @@ -25986,6 +25992,12 @@ "description": "Partially masked destination bank account number", "example": "******--460b--f23b4e71c97b", "nullable": true + }, + "expiry_date": { + "type": "string", + "description": "The expiration date and time for the Pix QR code in ISO 8601 format", + "example": "2025-09-10T10:11:12Z", + "nullable": true } } }, diff --git a/api-reference/v2/openapi_spec_v2.json b/api-reference/v2/openapi_spec_v2.json index 1bce9a47e29..f08a481e54e 100644 --- a/api-reference/v2/openapi_spec_v2.json +++ b/api-reference/v2/openapi_spec_v2.json @@ -6543,6 +6543,12 @@ "description": "Destination bank account number", "example": "9b95f84e-de61-460b-a14b-f23b4e71c97b", "nullable": true + }, + "expiry_date": { + "type": "string", + "description": "The expiration date and time for the Pix QR code in ISO 8601 format", + "example": "2025-09-10T10:11:12Z", + "nullable": true } } } @@ -20907,6 +20913,12 @@ "description": "Partially masked destination bank account number", "example": "****--460b--f23b4e71c97b", "nullable": true + }, + "expiry_date": { + "type": "string", + "description": "The expiration date and time for the Pix QR code in ISO 8601 format", + "example": "2025-09-10T10:11:12Z", + "nullable": true } } }, diff --git a/crates/api_models/src/payments.rs b/crates/api_models/src/payments.rs index cef094a98d5..f7d8a808a71 100644 --- a/crates/api_models/src/payments.rs +++ b/crates/api_models/src/payments.rs @@ -3438,6 +3438,11 @@ pub enum BankTransferData { /// Destination bank account number #[schema(value_type = Option<String>, example = "9b95f84e-de61-460b-a14b-f23b4e71c97b")] destination_bank_account_id: Option<MaskedBankAccount>, + + /// The expiration date and time for the Pix QR code in ISO 8601 format + #[schema(value_type = Option<String>, example = "2025-09-10T10:11:12Z")] + #[serde(default, with = "common_utils::custom_serde::iso8601::option")] + expiry_date: Option<PrimitiveDateTime>, }, Pse {}, LocalBankTransfer { diff --git a/crates/api_models/src/payments/additional_info.rs b/crates/api_models/src/payments/additional_info.rs index ab143975ea4..099e055980a 100644 --- a/crates/api_models/src/payments/additional_info.rs +++ b/crates/api_models/src/payments/additional_info.rs @@ -177,6 +177,11 @@ pub struct PixBankTransferAdditionalData { /// Partially masked destination bank account number #[schema(value_type = Option<String>, example = "****--460b-*-f23b4e71c97b")] pub destination_bank_account_id: Option<MaskedBankAccount>, + + /// The expiration date and time for the Pix QR code in ISO 8601 format + #[schema(value_type = Option<String>, example = "2025-09-10T10:11:12Z")] + #[serde(default, with = "common_utils::custom_serde::iso8601::option")] + pub expiry_date: Option<time::PrimitiveDateTime>, } #[derive(Eq, PartialEq, Clone, Debug, serde::Deserialize, serde::Serialize, ToSchema)] diff --git a/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs b/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs index d972c958b71..5a47dec7cdd 100644 --- a/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs @@ -291,6 +291,8 @@ pub struct AdyenPaymentRequest<'a> { splits: Option<Vec<AdyenSplitData>>, store: Option<String>, device_fingerprint: Option<Secret<String>>, + #[serde(with = "common_utils::custom_serde::iso8601::option")] + session_validity: Option<PrimitiveDateTime>, } #[derive(Debug, Clone, Serialize, Deserialize)] @@ -2922,6 +2924,7 @@ impl store, splits, device_fingerprint, + session_validity: None, }) } } @@ -3005,6 +3008,7 @@ impl TryFrom<(&AdyenRouterData<&PaymentsAuthorizeRouterData>, &Card)> for AdyenP store, splits, device_fingerprint, + session_validity: None, }) } } @@ -3092,6 +3096,7 @@ impl store, splits, device_fingerprint, + session_validity: None, }; Ok(request) } @@ -3167,6 +3172,7 @@ impl TryFrom<(&AdyenRouterData<&PaymentsAuthorizeRouterData>, &VoucherData)> store, splits, device_fingerprint, + session_validity: None, }; Ok(request) } @@ -3213,6 +3219,46 @@ impl let delivery_address = get_address_info(item.router_data.get_optional_shipping()).and_then(Result::ok); let telephone_number = item.router_data.get_optional_billing_phone_number(); + let (session_validity, social_security_number) = match bank_transfer_data { + BankTransferData::Pix { + cpf, + cnpj, + expiry_date, + .. + } => { + // Validate expiry_date doesn't exceed 5 days from now + if let Some(expiry) = expiry_date { + let now = OffsetDateTime::now_utc(); + let max_expiry = now + Duration::days(5); + let max_expiry_primitive = + PrimitiveDateTime::new(max_expiry.date(), max_expiry.time()); + + if expiry > max_expiry_primitive { + return Err(report!(errors::ConnectorError::InvalidDataFormat { + field_name: "expiry_date cannot be more than 5 days from now", + })); + } + } + + (*expiry_date, cpf.as_ref().or(cnpj.as_ref()).cloned()) + } + BankTransferData::LocalBankTransfer { .. } => (None, None), + BankTransferData::AchBankTransfer {} + \| BankTransferData::SepaBankTransfer {} + \| BankTransferData::BacsBankTransfer {} + \| BankTransferData::MultibancoBankTransfer {} + \| BankTransferData::PermataBankTransfer {} + \| BankTransferData::BcaBankTransfer {} + \| BankTransferData::BniVaBankTransfer {} + \| BankTransferData::BriVaBankTransfer {} + \| BankTransferData::CimbVaBankTransfer {} + \| BankTransferData::DanamonVaBankTransfer {} + \| BankTransferData::MandiriVaBankTransfer {} + \| BankTransferData::Pse {} + \| BankTransferData::InstantBankTransfer {} + \| BankTransferData::InstantBankTransferFinland {} + \| BankTransferData::InstantBankTransferPoland {} => (None, None), + }; let request = AdyenPaymentRequest { amount, @@ -3228,7 +3274,7 @@ impl shopper_name: None, shopper_locale: None, shopper_email: item.router_data.get_optional_billing_email(), - social_security_number: None, + social_security_number, telephone_number, billing_address, delivery_address, @@ -3243,6 +3289,7 @@ impl store, splits, device_fingerprint, + session_validity, }; Ok(request) } @@ -3319,6 +3366,7 @@ impl store, splits, device_fingerprint, + session_validity: None, }; Ok(request) } @@ -3399,6 +3447,7 @@ impl store, splits, device_fingerprint, + session_validity: None, }) } } @@ -3529,6 +3578,7 @@ impl TryFrom<(&AdyenRouterData<&PaymentsAuthorizeRouterData>, &WalletData)> store, splits, device_fingerprint, + session_validity: None, }) } } @@ -3618,6 +3668,7 @@ impl store, splits, device_fingerprint, + session_validity: None, }) } } @@ -3699,6 +3750,7 @@ impl store, splits, device_fingerprint, + session_validity: None, }) } } @@ -5945,6 +5997,7 @@ impl store, splits, device_fingerprint, + session_validity: None, }) } } diff --git a/crates/hyperswitch_domain_models/src/payment_method_data.rs b/crates/hyperswitch_domain_models/src/payment_method_data.rs index f2f86479362..b273ec4569c 100644 --- a/crates/hyperswitch_domain_models/src/payment_method_data.rs +++ b/crates/hyperswitch_domain_models/src/payment_method_data.rs @@ -710,6 +710,8 @@ pub enum BankTransferData { source_bank_account_id: Option<MaskedBankAccount>, /// Destination bank account UUID. destination_bank_account_id: Option<MaskedBankAccount>, + /// The expiration date and time for the Pix QR code + expiry_date: Option<time::PrimitiveDateTime>, }, Pse {}, LocalBankTransfer { @@ -1618,12 +1620,14 @@ impl From<api_models::payments::BankTransferData> for BankTransferData { cnpj, source_bank_account_id, destination_bank_account_id, + expiry_date, } => Self::Pix { pix_key, cpf, cnpj, source_bank_account_id, destination_bank_account_id, + expiry_date, }, api_models::payments::BankTransferData::Pse {} => Self::Pse {}, api_models::payments::BankTransferData::LocalBankTransfer { bank_code } => { @@ -1662,6 +1666,7 @@ impl From<BankTransferData> for api_models::payments::additional_info::BankTrans cnpj, source_bank_account_id, destination_bank_account_id, + expiry_date, } => Self::Pix(Box::new( api_models::payments::additional_info::PixBankTransferAdditionalData { pix_key: pix_key.map(MaskedBankAccount::from), @@ -1669,6 +1674,7 @@ impl From<BankTransferData> for api_models::payments::additional_info::BankTrans cnpj: cnpj.map(MaskedBankAccount::from), source_bank_account_id, destination_bank_account_id, + expiry_date, }, )), BankTransferData::Pse {} => Self::Pse {},	2025-07-21T07:08:40Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [x] New feature - [x] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> Enhanced Pix payment support for Adyen connector with two changes: 1. Expiry Date Support: Added `expiry_date` field to `BankTransferData::Pix` variant in API and domain models and mapped it to Adyen's `sessionValidity` 2. CPF/CNPJ Mapping: Map CPF or CNPJ from Pix payment data to Adyen's `socialSecurityNumber` field ### Additional Changes - [x] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. --> Enables merchants to specify expiry dates for Pix QR codes and ensures proper customer identification through CPF/CNPJ mapping as per Adyen's Pix API requirements. ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> <details> <summary>1. Create a Pix payment using custom SSN and expiry date</summary> cURL curl --location --request POST 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_uXENxlgLNNVyGVRpR0D4S1om0k65a6X3nyc5WfAXjwUlVWmBSl3ZPGJHhywazTN6' \ --data-raw '{"amount":4500,"currency":"BRL","confirm":true,"profile_id":"pro_U1KoDSmwFwzKn649yraI","capture_on":"2022-09-10T10:11:12Z","connector":["adyen"],"customer_id":"cus_6vLys2IeaGT4xVbFj2U9","email":"[email protected]","return_url":"https://google.com","payment_method":"bank_transfer","payment_method_type":"pix","payment_method_data":{"bank_transfer":{"pix":{"pix_key":"test","cpf":"test","cnpj":"test","expiry_date":"2025-07-23T10:11:12Z"}}},"billing":{"address":{"line1":"1467","line2":"Harrison Street","line3":"Harrison Street","city":"San Fransico","state":"California","zip":"94122","country":"BR","first_name":"joseph","last_name":"Doe"},"phone":{"number":"8056594427","country_code":"+91"},"email":"[email protected]"},"metadata":{"Force-PSP":"Adyen","udf1":"value1","new_customer":"true","login_date":"2019-09-10T10:11:12Z"},"browser_info":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36","accept_header":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8","language":"en-US","color_depth":32,"screen_height":1117,"screen_width":1728,"time_zone":-330,"java_enabled":true,"java_script_enabled":true,"ip_address":"127.0.0.1"},"customer_acceptance":{"acceptance_type":"online","accepted_at":"1963-05-03T04:07:52.723Z","online":{"ip_address":"127.0.0.1","user_agent":"amet irure esse"}},"session_expiry":60}' Response {"payment_id":"pay_iB7uN0kUtp51wVHpLhQF","merchant_id":"merchant_1753076715","status":"requires_customer_action","amount":4500,"net_amount":4500,"shipping_cost":null,"amount_capturable":4500,"amount_received":null,"connector":"adyen","client_secret":"pay_iB7uN0kUtp51wVHpLhQF_secret_6kerLIBddt2ShUGKwXcP","created":"2025-07-21T08:12:53.420Z","currency":"BRL","customer_id":"cus_6vLys2IeaGT4xVbFj2U9","customer":{"id":"cus_6vLys2IeaGT4xVbFj2U9","name":"John Nether","email":"[email protected]","phone":"6168205362","phone_country_code":"+1"},"description":null,"refunds":null,"disputes":null,"mandate_id":null,"mandate_data":null,"setup_future_usage":null,"off_session":null,"capture_on":null,"capture_method":null,"payment_method":"bank_transfer","payment_method_data":{"bank_transfer":{"pix":{"pix_key":"test","cpf":"test","cnpj":"test","source_bank_account_id":null,"destination_bank_account_id":null,"expiry_date":"2025-07-23T10:11:12.000Z"}},"billing":null},"payment_token":null,"shipping":null,"billing":{"address":{"city":"San Fransico","country":"BR","line1":"1467","line2":"Harrison Street","line3":"Harrison Street","zip":"94122","state":"California","first_name":"joseph","last_name":"Doe"},"phone":{"number":"8056594427","country_code":"+91"},"email":"[email protected]"},"order_details":null,"email":"[email protected]","name":"John Nether","phone":"6168205362","return_url":"https://google.com/","authentication_type":"no_three_ds","statement_descriptor_name":null,"statement_descriptor_suffix":null,"next_action":{"type":"qr_code_information","image_data_url":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAQgAAAEICAAAAACGnTUjAAAGJElEQVR4Ae3gAZAkSZIkSRKLqpm7R0REZmZmVlVVVVV3d3d3d/fMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMdHd3d3dXV1VVVVVmZkZGRIS7m5kKz0xmV3d1d3dPz8zMzMxMYjVXAVSuAqByFQCVqwCoXAVA5SoAKlcBULkKgMpVAFSuAqByFQCVqwCoXAVA5SoAKlcBULkKgMpVAFSuAqByFQCVqwCoXAVA5SoAKlcBULkKgMpVAFSuAqByFQCVqwCoXAVA5SoAKlcBULkKgMq/QPzbmCvEFeY5iedkrhDPn7lC/NuYF4rKVQBUrgKgchUAlasAqFwFQOUqACpXAVB5EZkXjXhO5gpxhXnhzHMSz5950YgXCZWrAKhcBUDlKgAqVwFQuQqAylUAVK4CoPKvJJ4/88KZK8QV5grx/IkrzAsnnj/zr0LlKgAqVwFQuQqAylUAVK4CoHIVAJWrAKj8JxPPn7jCvHDiCvOfispVAFSuAqByFQCVqwCoXAVA5SoAKlcBUPkvZq4Qz5/4b0HlKgAqVwFQuQqAylUAVK4CoHIVAJWrAKj8K5l/H/GcxBXmCvOcxAtn/kNQuQqAylUAVK4CoHIVAJWrAKhcBUDlKgAqLyLx72OuEFeYK8RzEleYF078h6JyFQCVqwCoXAVA5SoAKlcBULkKgMpVAFT+Bea/hrjCvHDmPwWVqwCoXAVA5SoAKlcBULkKgMpVAFSuAqDyLxBXmOdPXGGuEM+fuMK8aMQV5grxojHPSVxhXigqVwFQuQqAylUAVK4CoHIVAJWrAKhcBYDMv494TuYK8fyZK8S/jnn+xBXmOYkrzIuEylUAVK4CoHIVAJWrAKhcBUDlKgAqVwFQ+VcSz5+5QlxhrhAvGvOcxBXmhTPPn/lXoXIVAJWrAKhcBUDlKgAqVwFQuQqAylUAVP4F4oUzV4grzPNnXjTiCvPCiSvMcxJXmH8VKlcBULkKgMpVAFSuAqByFQCVqwCoXAWAzAsnrjBXiBeNeU7iOZnnJJ4/c4V4/swV4oUzLxSVqwCoXAVA5SoAKlcBULkKgMpVAFSuAqDyIhJXmOdPXGGuEFeYF05cYZ6TuEJcYa4QV5grxHMy/yZUrgKgchUAlasAqFwFQOUqACpXAVC5CgCZfxtxhXlO4grznMQV5grxr2Oek3jhzL8KlasAqFwFQOUqACpXAVC5CoDKVQBUrgKg8m9krhDPyTwncYV5/swV4gpzhbjCvGjMFeIKcYV5kVC5CoDKVQBUrgKgchUAlasAqFwFQOUqAGReOPH8medPPCfznMQV5grxnMxzEv865grxnMwLReUqACpXAVC5CoDKVQBUrgKgchUAlasAkPnPJa4wL5x44czzJ64wz0k8J/NCUbkKgMpVAFSuAqByFQCVqwCoXAVA5SoAKv8C8W9j/nXMcxLPn7jCPH/iCvOvQuUqACpXAVC5CoDKVQBUrgKgchUAlasAqLyIzItGPCdzhbjCPCdxhblCXGGuEM/JvGjEczIvFJWrAKhcBUDlKgAqVwFQuQqAylUAVK4CoPKvJJ4/8/yJK8wV4jmZK8QLJ144cYV5TuJFQuUqACpXAVC5CoDKVQBUrgKgchUAlasAqPwnM1eI52SuEFeYfxvz/Il/FSpXAVC5CoDKVQBUrgKgchUAlasAqFwFQOW/iXhO4jmZ589cIZ6TuMI8J/MioXIVAJWrAKhcBUDlKgAqVwFQuQqAylUAVP6VzL+NeU7iCnOFuMI8f+YK8ZzEFeYK8W9C5SoAKlcBULkKgMpVAFSuAqByFQCVqwCovIjEv424wlwhrjBXiOdPXGGuEC8ac4W4QlxhXigqVwFQuQqAylUAVK4CoHIVAJWrAKhcBYDMVQCVqwCoXAVA5SoAKlcBULkKgMpVAFSuAqByFQCVqwCoXAVA5SoAKlcBULkKgMpVAFSuAqByFQCVqwCoXAVA5SoAKlcBULkKgMpVAFSuAqByFQCVqwCoXAVA5SoAKlcBULkKgMpVAFSuAuAfAfHRhAhvVmeEAAAAAElFTkSuQmCC","display_to_timestamp":1753265472000,"qr_code_url":"https://test.adyen.com/hpp/generateQRCodeImage.shtml?url=TestQRCodeEMVToken","display_text":null,"border_color":null},"cancellation_reason":null,"error_code":null,"error_message":null,"unified_code":null,"unified_message":null,"payment_experience":null,"payment_method_type":"pix","connector_label":null,"business_country":null,"business_label":"default","business_sub_label":null,"allowed_payment_method_types":null,"ephemeral_key":{"customer_id":"cus_6vLys2IeaGT4xVbFj2U9","created_at":1753085573,"expires":1753089173,"secret":"epk_e1db82c9ea524cfba83011c631f34bf9"},"manual_retry_allowed":null,"connector_transaction_id":"DVB7NMC4DVHVLD75","frm_message":null,"metadata":{"udf1":"value1","Force-PSP":"Adyen","login_date":"2019-09-10T10:11:12Z","new_customer":"true"},"connector_metadata":null,"feature_metadata":null,"reference_id":"DVB7NMC4DVHVLD75","payment_link":null,"profile_id":"pro_U1KoDSmwFwzKn649yraI","surcharge_details":null,"attempt_count":1,"merchant_decision":null,"merchant_connector_id":"mca_lBjLVbnnprul6b7CLyQE","incremental_authorization_allowed":null,"authorization_count":null,"incremental_authorizations":null,"external_authentication_details":null,"external_3ds_authentication_attempted":false,"expires_on":"2025-07-21T08:13:53.420Z","fingerprint":null,"browser_info":{"language":"en-US","time_zone":-330,"ip_address":"127.0.0.1","user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36","color_depth":32,"java_enabled":true,"screen_width":1728,"accept_header":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8","screen_height":1117,"java_script_enabled":true},"payment_method_id":null,"payment_method_status":null,"updated":"2025-07-21T08:12:53.932Z","split_payments":null,"frm_metadata":null,"extended_authorization_applied":null,"capture_before":null,"merchant_order_reference_id":null,"order_tax_amount":null,"connector_mandate_id":null,"card_discovery":null,"force_3ds_challenge":false,"force_3ds_challenge_trigger":false,"issuer_error_code":null,"issuer_error_message":null,"is_iframe_redirection_enabled":null,"whole_connector_response":null} Things to verify 1. Expiry time in response (display_to_timestamp) - should be same as the one sent in request 2. Social security number must be sent to Adyen <img width="1223" height="618" alt="Screenshot 2025-07-21 at 1 53 44 PM" src="https://github.com/user-attachments/assets/643fb36c-0b60-44fa-91ff-4702114747f6" /> </details> <details> <summary>2. Create a Pix payment using a expiry date > 5 days in future from now</summary> cURL curl --location --request POST 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_uXENxlgLNNVyGVRpR0D4S1om0k65a6X3nyc5WfAXjwUlVWmBSl3ZPGJHhywazTN6' \ --data-raw '{"amount":4500,"currency":"BRL","confirm":true,"profile_id":"pro_U1KoDSmwFwzKn649yraI","capture_on":"2022-09-10T10:11:12Z","connector":["adyen"],"customer_id":"cus_6vLys2IeaGT4xVbFj2U9","email":"[email protected]","return_url":"https://google.com","payment_method":"bank_transfer","payment_method_type":"pix","payment_method_data":{"bank_transfer":{"pix":{"pix_key":"test","cpf":"test","cnpj":"test","expiry_date":"2025-08-23T10:11:12Z"}}},"billing":{"address":{"line1":"1467","line2":"Harrison Street","line3":"Harrison Street","city":"San Fransico","state":"California","zip":"94122","country":"BR","first_name":"joseph","last_name":"Doe"},"phone":{"number":"8056594427","country_code":"+91"},"email":"[email protected]"},"metadata":{"Force-PSP":"Adyen","udf1":"value1","new_customer":"true","login_date":"2019-09-10T10:11:12Z"},"browser_info":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36","accept_header":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8","language":"en-US","color_depth":32,"screen_height":1117,"screen_width":1728,"time_zone":-330,"java_enabled":true,"java_script_enabled":true,"ip_address":"127.0.0.1"},"customer_acceptance":{"acceptance_type":"online","accepted_at":"1963-05-03T04:07:52.723Z","online":{"ip_address":"127.0.0.1","user_agent":"amet irure esse"}},"session_expiry":60}' Response { "error": { "type": "invalid_request", "message": "Invalid value provided: expiry_date cannot be more than 5 days from now", "code": "IR_07" } } </details> ## Checklist <!-- Put an `x` in the boxes that apply --> - [ ] I formatted the code `cargo +nightly fmt --all` - [ ] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	2b6f6c46a690514b9b10958433d89e95cd7e0c2e	2b6f6c46a690514b9b10958433d89e95cd7e0c2e
juspay/hyperswitch	juspay__hyperswitch-8636	Bug: [BUG] card payouts using payout_method_id ### Bug Description Payout method data for card is not being fetched in payouts flow. This bug was introduced in https://github.com/juspay/hyperswitch/pull/7786/files where `get_pm_list_context` was refactored to return back only the additional details by removing the call to card vault. ### Expected Behavior `payout_method_data` should be fetched from card vault in payouts flow. ### Actual Behavior `payout_method_data` is not being fetched in payouts flow. ### Steps To Reproduce 1. Create a card payout with `recurring: true` 2. Obtain the `payout_method_id` 3. Create a payout using this `payout_method_id` - throws an error saying card details not found ### Have you spent some time checking if this bug has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? Yes, I am willing to submit a PR!	diff --git a/crates/payment_methods/src/controller.rs b/crates/payment_methods/src/controller.rs index bd5a9f316ef..095788fa368 100644 --- a/crates/payment_methods/src/controller.rs +++ b/crates/payment_methods/src/controller.rs @@ -229,6 +229,12 @@ pub trait PaymentMethodsController { merchant_id: &id_type::MerchantId, card_network: Option<common_enums::CardNetwork>, ) -> errors::PmResult<()>; + + #[cfg(feature = "v1")] + async fn get_card_details_from_locker( + &self, + pm: &payment_methods::PaymentMethod, + ) -> errors::PmResult<api::CardDetailFromLocker>; } pub async fn create_encrypted_data<T>( diff --git a/crates/router/src/core/payment_methods/cards.rs b/crates/router/src/core/payment_methods/cards.rs index 8f29e05e154..7ba707316c5 100644 --- a/crates/router/src/core/payment_methods/cards.rs +++ b/crates/router/src/core/payment_methods/cards.rs @@ -890,6 +890,14 @@ impl PaymentMethodsController for PmCards<'_> { .await } + #[cfg(feature = "v1")] + async fn get_card_details_from_locker( + &self, + pm: &domain::PaymentMethod, + ) -> errors::RouterResult<api::CardDetailFromLocker> { + get_card_details_from_locker(self.state, pm).await + } + #[cfg(feature = "v1")] #[instrument(skip_all)] async fn retrieve_payment_method( @@ -4205,6 +4213,7 @@ pub async fn list_customer_payment_method( &pm, Some(parent_payment_method_token.clone()), true, + false, &merchant_context, ) .await?; @@ -4349,6 +4358,7 @@ pub async fn list_customer_payment_method( } #[cfg(feature = "v1")] +#[allow(clippy::too_many_arguments)] pub async fn get_pm_list_context( state: &routes::SessionState, payment_method: &enums::PaymentMethod, @@ -4358,6 +4368,7 @@ pub async fn get_pm_list_context( #[cfg(feature = "payouts")] parent_payment_method_token: Option<String>, #[cfg(not(feature = "payouts"))] _parent_payment_method_token: Option<String>, is_payment_associated: bool, + force_fetch_card_from_vault: bool, merchant_context: &domain::MerchantContext, ) -> Result<Option<PaymentMethodListContext>, error_stack::Report<errors::ApiErrorResponse>> { let cards = PmCards { @@ -4366,7 +4377,11 @@ pub async fn get_pm_list_context( }; let payment_method_retrieval_context = match payment_method { enums::PaymentMethod::Card => { - let card_details = cards.get_card_details_with_locker_fallback(pm).await?; + let card_details = if force_fetch_card_from_vault { + Some(cards.get_card_details_from_locker(pm).await?) + } else { + cards.get_card_details_with_locker_fallback(pm).await? + }; card_details.as_ref().map(\|card\| PaymentMethodListContext { card_details: Some(card.clone()), diff --git a/crates/router/src/core/payouts/validator.rs b/crates/router/src/core/payouts/validator.rs index 3d58d1f367e..198caa4b893 100644 --- a/crates/router/src/core/payouts/validator.rs +++ b/crates/router/src/core/payouts/validator.rs @@ -233,6 +233,7 @@ pub async fn validate_create_request( payment_method, None, false, + true, merchant_context, ) .await? @@ -243,7 +244,7 @@ pub async fn validate_create_request( card_number: card.card_number.get_required_value("card_number")?, card_holder_name: card.card_holder_name, expiry_month: card.expiry_month.get_required_value("expiry_month")?, - expiry_year: card.expiry_year.get_required_value("expiry_month")?, + expiry_year: card.expiry_year.get_required_value("expiry_year")?, }, ))), (_, Some(bank)) => Ok(Some(payouts::PayoutMethodData::Bank(bank))),	2025-07-23T09:59:21Z	## Type of Change - [x] Bugfix ## Description Fixed payout method data not being fetched from card vault when using `payout_method_id` in payouts flow. Changes: - Added `force_fetch_card_from_vault` parameter to `get_pm_list_context` to enable card vault lookup for payouts - Added `get_card_details_from_locker` method to PaymentMethodsController trait - Set `force_fetch_card_from_vault=true` in payouts validator to ensure card details are retrieved from vault - Fixed typo in error message for `expiry_year` field ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables ## Motivation and Context Fixes regression introduced in [PR #7786](https://github.com/juspay/hyperswitch/pull/7786) where card vault lookup was removed from `get_pm_list_context`. This broke recurring payouts functionality where `payout_method_id` should retrieve stored card details from vault. ## How did you test it? <details> <summary>1. Create a recurring card payout</summary> cURL curl --location --request POST 'http://localhost:8080/payouts/create' \ --header 'Content-Type: application/json' \ --header 'api-key: dev_ydIiVWyEGA60P3uQa2IHCKACVSRVHceIJEPrmSsb1TFfpJHfBmYRaMoqrrOiSab1' \ --data '{"amount":100,"currency":"EUR","profile_id":"pro_pkpPuJzb8FHi5TYDj6ew","customer_id":"cus_UWxTZBStM3s2FzdDGGun","connector":["adyenplatform"],"description":"Its my first payout request","payout_type":"card","payout_method_data":{"card":{"card_number":"4111111111111111","expiry_month":"03","expiry_year":"2030"}},"billing":{"address":{"line1":"1467","line2":"Harrison Street","line3":"Harrison Street","city":"San Fransico","state":"CA","zip":"94122","country":"FR","first_name":"John","last_name":"Doe"}},"entity_type":"Individual","recurring":true,"metadata":{"ref":"123"},"confirm":true,"auto_fulfill":true}' Response {"payout_id":"payout_s9nuyxhtsta0qQSKSaYC","merchant_id":"merchant_1752554602","merchant_order_reference_id":null,"amount":100,"currency":"EUR","connector":"adyenplatform","payout_type":"card","payout_method_data":{"card":{"card_issuer":null,"card_network":null,"card_type":null,"card_issuing_country":null,"bank_code":null,"last4":"1111","card_isin":"411111","card_extended_bin":null,"card_exp_month":"03","card_exp_year":"2030","card_holder_name":null}},"billing":{"address":{"city":"San Fransico","country":"FR","line1":"1467","line2":"Harrison Street","line3":"Harrison Street","zip":"94122","state":"CA","first_name":"John","last_name":"Doe"},"phone":null,"email":null},"auto_fulfill":true,"customer_id":"cus_UWxTZBStM3s2FzdDGGun","customer":{"id":"cus_UWxTZBStM3s2FzdDGGun","name":"John Nether","email":null,"phone":"6168205362","phone_country_code":"+1"},"client_secret":"payout_payout_s9nuyxhtsta0qQSKSaYC_secret_OxIBwSwo8HWWeZat8yYk","return_url":null,"business_country":null,"business_label":null,"description":"Its my first payout request","entity_type":"Individual","recurring":true,"metadata":{"ref":"123"},"merchant_connector_id":"mca_pjCOTcjEbqMrGm7rRLte","status":"initiated","error_message":null,"error_code":null,"profile_id":"pro_pkpPuJzb8FHi5TYDj6ew","created":"2025-07-15T04:44:24.793Z","connector_transaction_id":"38EBID67N4HZE5UD","priority":null,"payout_link":null,"email":null,"name":"John Nether","phone":"6168205362","phone_country_code":"+1","unified_code":null,"unified_message":null,"payout_method_id":"pm_G5g1xumF3AXWDPY8yl30"} Note down payout method ID </details> <details> <summary>2. Create payout using payout_method_id</summary> cURL curl --location --request POST 'http://localhost:8080/payouts/create' \ --header 'Content-Type: application/json' \ --header 'api-key: dev_ydIiVWyEGA60P3uQa2IHCKACVSRVHceIJEPrmSsb1TFfpJHfBmYRaMoqrrOiSab1' \ --data-raw '{"payout_method_id":"pm_G5g1xumF3AXWDPY8yl30","amount":1,"currency":"EUR","customer_id":"cus_UWxTZBStM3s2FzdDGGun","email":"[email protected]","name":"John Doe","phone":"999999999","phone_country_code":"+65","description":"Its my first payout request","connector":["adyenplatform"],"billing":{"address":{"line1":"1467","line2":"Harrison Street","line3":"Harrison Street","city":"San Fransico","state":"CA","zip":"94122","country":"US","first_name":"John","last_name":"Doe"},"phone":{"number":"8056594427","country_code":"+91"}},"entity_type":"Individual","recurring":true,"metadata":{"ref":"123"},"confirm":true,"auto_fulfill":true}' Response {"payout_id":"payout_QfSUC79LP4YDXjKwvn66","merchant_id":"merchant_1752554602","merchant_order_reference_id":null,"amount":1,"currency":"EUR","connector":"adyenplatform","payout_type":"card","payout_method_data":{"card":{"card_issuer":null,"card_network":null,"card_type":null,"card_issuing_country":null,"bank_code":null,"last4":"1111","card_isin":"411111","card_extended_bin":null,"card_exp_month":"03","card_exp_year":"2030","card_holder_name":null}},"billing":{"address":{"city":"San Fransico","country":"US","line1":"1467","line2":"Harrison Street","line3":"Harrison Street","zip":"94122","state":"CA","first_name":"John","last_name":"Doe"},"phone":{"number":"8056594427","country_code":"+91"},"email":null},"auto_fulfill":true,"customer_id":"cus_UWxTZBStM3s2FzdDGGun","customer":{"id":"cus_UWxTZBStM3s2FzdDGGun","name":"John Nether","email":null,"phone":"6168205362","phone_country_code":"+1"},"client_secret":"payout_payout_QfSUC79LP4YDXjKwvn66_secret_ArtMRkkTVFHDFsrTHMbE","return_url":null,"business_country":null,"business_label":null,"description":"Its my first payout request","entity_type":"Individual","recurring":true,"metadata":{"ref":"123"},"merchant_connector_id":"mca_pjCOTcjEbqMrGm7rRLte","status":"initiated","error_message":null,"error_code":null,"profile_id":"pro_pkpPuJzb8FHi5TYDj6ew","created":"2025-07-15T04:45:13.051Z","connector_transaction_id":"38EBHI67N4I9P28N","priority":null,"payout_link":null,"email":null,"name":"John Nether","phone":"6168205362","phone_country_code":"+1","unified_code":null,"unified_message":null,"payout_method_id":"pm_G5g1xumF3AXWDPY8yl30"} </details> ## Checklist - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	6214aca5f0f5c617a68f65ef5bcfd700060acccf	6214aca5f0f5c617a68f65ef5bcfd700060acccf
juspay/hyperswitch	juspay__hyperswitch-8638	Bug: [FEATURE] add payment_expired outgoing webhook ### Feature Description Payment methods related to QR code which generally has an expiration time / date associated comes to end of its lifecycle if they're not fulfilled. For such payments, underlying connector can send an incoming webhook when they expire. HS needs to provision a status (or if `Cancelled` can be reused?) and a variant for `EventType` which specifies they type of outgoing webhook event being generated. These are needed to be consumed for the supported connectors (Adyen for now) and also send an outgoing webhook once they expire. ### Possible Implementation - Integrate OFFER_CLOSED from Adyen as a part of incoming webhooks - https://docs.adyen.com/development-resources/webhooks/webhook-types/#non-default-event-codes - ** Map it to `cancelled` in `IntentStatus` (map to `voided` in `AttemptStatus`)	diff --git a/api-reference/v1/openapi_spec_v1.json b/api-reference/v1/openapi_spec_v1.json index 835adefad89..e8aab746356 100644 --- a/api-reference/v1/openapi_spec_v1.json +++ b/api-reference/v1/openapi_spec_v1.json @@ -7623,7 +7623,8 @@ "payment_method_awaited", "confirmation_awaited", "device_data_collection_pending", - "integrity_failure" + "integrity_failure", + "expired" ] }, "AuthenticationConnectorDetails": { @@ -14108,6 +14109,7 @@ "payment_cancelled", "payment_authorized", "payment_captured", + "payment_expired", "action_required", "refund_succeeded", "refund_failed", @@ -15894,7 +15896,8 @@ "requires_capture", "partially_captured", "partially_captured_and_capturable", - "conflicted" + "conflicted", + "expired" ] }, "IssuerData": { diff --git a/api-reference/v2/openapi_spec_v2.json b/api-reference/v2/openapi_spec_v2.json index 80bef996758..a8bacd04ad3 100644 --- a/api-reference/v2/openapi_spec_v2.json +++ b/api-reference/v2/openapi_spec_v2.json @@ -4847,7 +4847,8 @@ "payment_method_awaited", "confirmation_awaited", "device_data_collection_pending", - "integrity_failure" + "integrity_failure", + "expired" ] }, "AuthenticationConnectorDetails": { @@ -10682,6 +10683,7 @@ "payment_cancelled", "payment_authorized", "payment_captured", + "payment_expired", "action_required", "refund_succeeded", "refund_failed", @@ -12580,7 +12582,8 @@ "requires_capture", "partially_captured", "partially_captured_and_capturable", - "conflicted" + "conflicted", + "expired" ] }, "JCSVoucherData": { diff --git a/crates/api_models/src/webhooks.rs b/crates/api_models/src/webhooks.rs index 75af0b19cf2..fcab9461a00 100644 --- a/crates/api_models/src/webhooks.rs +++ b/crates/api_models/src/webhooks.rs @@ -22,6 +22,7 @@ pub enum IncomingWebhookEvent { PaymentIntentAuthorizationFailure, PaymentIntentCaptureSuccess, PaymentIntentCaptureFailure, + PaymentIntentExpired, PaymentActionRequired, EventNotSupported, SourceChargeable, @@ -199,7 +200,8 @@ impl From<IncomingWebhookEvent> for WebhookFlow { \| IncomingWebhookEvent::PaymentIntentAuthorizationSuccess \| IncomingWebhookEvent::PaymentIntentAuthorizationFailure \| IncomingWebhookEvent::PaymentIntentCaptureSuccess - \| IncomingWebhookEvent::PaymentIntentCaptureFailure => Self::Payment, + \| IncomingWebhookEvent::PaymentIntentCaptureFailure + \| IncomingWebhookEvent::PaymentIntentExpired => Self::Payment, IncomingWebhookEvent::EventNotSupported => Self::ReturnResponse, IncomingWebhookEvent::RefundSuccess \| IncomingWebhookEvent::RefundFailure => { Self::Refund diff --git a/crates/common_enums/src/enums.rs b/crates/common_enums/src/enums.rs index 12f1fe5581f..a2912e73c45 100644 --- a/crates/common_enums/src/enums.rs +++ b/crates/common_enums/src/enums.rs @@ -156,6 +156,7 @@ pub enum AttemptStatus { ConfirmationAwaited, DeviceDataCollectionPending, IntegrityFailure, + Expired, } impl AttemptStatus { @@ -168,7 +169,8 @@ impl AttemptStatus { \| Self::VoidFailed \| Self::CaptureFailed \| Self::Failure - \| Self::PartialCharged => true, + \| Self::PartialCharged + \| Self::Expired => true, Self::Started \| Self::AuthenticationFailed \| Self::AuthenticationPending @@ -1461,6 +1463,7 @@ impl EventClass { EventType::PaymentCancelled, EventType::PaymentAuthorized, EventType::PaymentCaptured, + EventType::PaymentExpired, EventType::ActionRequired, ]), Self::Refunds => HashSet::from([EventType::RefundSucceeded, EventType::RefundFailed]), @@ -1514,6 +1517,7 @@ pub enum EventType { PaymentCancelled, PaymentAuthorized, PaymentCaptured, + PaymentExpired, ActionRequired, RefundSucceeded, RefundFailed, @@ -1635,13 +1639,19 @@ pub enum IntentStatus { PartiallyCapturedAndCapturable, /// There has been a discrepancy between the amount/currency sent in the request and the amount/currency received by the processor Conflicted, + /// The payment expired before it could be captured. + Expired, } impl IntentStatus { /// Indicates whether the payment intent is in terminal state or not pub fn is_in_terminal_state(self) -> bool { match self { - Self::Succeeded \| Self::Failed \| Self::Cancelled \| Self::PartiallyCaptured => true, + Self::Succeeded + \| Self::Failed + \| Self::Cancelled + \| Self::PartiallyCaptured + \| Self::Expired => true, Self::Processing \| Self::RequiresCustomerAction \| Self::RequiresMerchantAction @@ -1664,7 +1674,7 @@ impl IntentStatus { \| Self::Failed \| Self::Cancelled \| Self::PartiallyCaptured - \| Self::RequiresCapture \| Self::Conflicted => false, + \| Self::RequiresCapture \| Self::Conflicted \| Self::Expired=> false, Self::Processing \| Self::RequiresCustomerAction \| Self::RequiresMerchantAction @@ -1796,7 +1806,8 @@ impl From<AttemptStatus> for PaymentMethodStatus { \| AttemptStatus::PartialChargedAndChargeable \| AttemptStatus::ConfirmationAwaited \| AttemptStatus::DeviceDataCollectionPending - \| AttemptStatus::IntegrityFailure => Self::Inactive, + \| AttemptStatus::IntegrityFailure + \| AttemptStatus::Expired => Self::Inactive, AttemptStatus::Charged \| AttemptStatus::Authorized => Self::Active, } } diff --git a/crates/common_enums/src/transformers.rs b/crates/common_enums/src/transformers.rs index 0dcef36ac97..549be0e0dc6 100644 --- a/crates/common_enums/src/transformers.rs +++ b/crates/common_enums/src/transformers.rs @@ -2121,6 +2121,7 @@ impl From<AttemptStatus> for IntentStatus { \| AttemptStatus::CaptureFailed \| AttemptStatus::Failure => Self::Failed, AttemptStatus::Voided => Self::Cancelled, + AttemptStatus::Expired => Self::Expired, } } } @@ -2135,6 +2136,7 @@ impl From<IntentStatus> for Option<EventType> { \| IntentStatus::RequiresCustomerAction \| IntentStatus::Conflicted => Some(EventType::ActionRequired), IntentStatus::Cancelled => Some(EventType::PaymentCancelled), + IntentStatus::Expired => Some(EventType::PaymentExpired), IntentStatus::PartiallyCaptured \| IntentStatus::PartiallyCapturedAndCapturable => { Some(EventType::PaymentCaptured) } diff --git a/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs b/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs index 6a0cc9c4610..5b424ec5d4d 100644 --- a/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs @@ -428,6 +428,7 @@ impl ForeignTryFrom<(bool, AdyenWebhookStatus)> for storage_enums::AttemptStatus AdyenWebhookStatus::CancelFailed => Ok(Self::VoidFailed), AdyenWebhookStatus::Captured => Ok(Self::Charged), AdyenWebhookStatus::CaptureFailed => Ok(Self::CaptureFailed), + AdyenWebhookStatus::Expired => Ok(Self::Expired), //If Unexpected Event is received, need to understand how it reached this point //Webhooks with Payment Events only should try to conume this resource object. AdyenWebhookStatus::UnexpectedEvent \| AdyenWebhookStatus::Reversed => { @@ -513,6 +514,7 @@ pub enum AdyenWebhookStatus { CaptureFailed, Reversed, UnexpectedEvent, + Expired, } //Creating custom struct which can be consumed in Psync Handler triggered from Webhooks @@ -4798,6 +4800,7 @@ pub enum WebhookEventCode { SecondChargeback, PrearbitrationWon, PrearbitrationLost, + OfferClosed, #[cfg(feature = "payouts")] PayoutThirdparty, #[cfg(feature = "payouts")] @@ -4811,7 +4814,10 @@ pub enum WebhookEventCode { } pub fn is_transaction_event(event_code: &WebhookEventCode) -> bool { - matches!(event_code, WebhookEventCode::Authorisation) + matches!( + event_code, + WebhookEventCode::Authorisation \| WebhookEventCode::OfferClosed + ) } pub fn is_capture_or_cancel_event(event_code: &WebhookEventCode) -> bool { @@ -4928,6 +4934,9 @@ pub(crate) fn get_adyen_webhook_event( WebhookEventCode::CaptureFailed => { api_models::webhooks::IncomingWebhookEvent::PaymentIntentCaptureFailure } + WebhookEventCode::OfferClosed => { + api_models::webhooks::IncomingWebhookEvent::PaymentIntentExpired + } #[cfg(feature = "payouts")] WebhookEventCode::PayoutThirdparty => { api_models::webhooks::IncomingWebhookEvent::PayoutCreated @@ -5015,6 +5024,7 @@ impl From<AdyenNotificationRequestItemWH> for AdyenWebhookResponse { AdyenWebhookStatus::CancelFailed } } + WebhookEventCode::OfferClosed => AdyenWebhookStatus::Expired, WebhookEventCode::Capture => { if is_success_scenario(notif.success) { AdyenWebhookStatus::Captured diff --git a/crates/hyperswitch_connectors/src/connectors/chargebee/transformers.rs b/crates/hyperswitch_connectors/src/connectors/chargebee/transformers.rs index 5a3ec2f96f9..6bb4cf345f7 100644 --- a/crates/hyperswitch_connectors/src/connectors/chargebee/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/chargebee/transformers.rs @@ -706,7 +706,8 @@ impl TryFrom<enums::AttemptStatus> for ChargebeeRecordStatus { \| enums::AttemptStatus::PaymentMethodAwaited \| enums::AttemptStatus::ConfirmationAwaited \| enums::AttemptStatus::DeviceDataCollectionPending - \| enums::AttemptStatus::IntegrityFailure => Err(errors::ConnectorError::NotSupported { + \| enums::AttemptStatus::IntegrityFailure + \| enums::AttemptStatus::Expired => Err(errors::ConnectorError::NotSupported { message: "Record back flow is only supported for terminal status".to_string(), connector: "chargebee", } diff --git a/crates/hyperswitch_connectors/src/connectors/paypal/transformers.rs b/crates/hyperswitch_connectors/src/connectors/paypal/transformers.rs index 289fee48d99..9ffc5a0c13a 100644 --- a/crates/hyperswitch_connectors/src/connectors/paypal/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/paypal/transformers.rs @@ -2701,7 +2701,8 @@ impl TryFrom<PaymentsCaptureResponseRouterData<PaypalCaptureResponse>> \| storage_enums::AttemptStatus::PaymentMethodAwaited \| storage_enums::AttemptStatus::ConfirmationAwaited \| storage_enums::AttemptStatus::DeviceDataCollectionPending - \| storage_enums::AttemptStatus::Voided => 0, + \| storage_enums::AttemptStatus::Voided + \| storage_enums::AttemptStatus::Expired => 0, storage_enums::AttemptStatus::Charged \| storage_enums::AttemptStatus::PartialCharged \| storage_enums::AttemptStatus::PartialChargedAndChargeable diff --git a/crates/hyperswitch_connectors/src/connectors/recurly/transformers.rs b/crates/hyperswitch_connectors/src/connectors/recurly/transformers.rs index b7f7d3d39da..4aef739b979 100644 --- a/crates/hyperswitch_connectors/src/connectors/recurly/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/recurly/transformers.rs @@ -278,7 +278,8 @@ impl TryFrom<enums::AttemptStatus> for RecurlyRecordStatus { \| enums::AttemptStatus::PaymentMethodAwaited \| enums::AttemptStatus::ConfirmationAwaited \| enums::AttemptStatus::DeviceDataCollectionPending - \| enums::AttemptStatus::IntegrityFailure => Err(errors::ConnectorError::NotSupported { + \| enums::AttemptStatus::IntegrityFailure + \| enums::AttemptStatus::Expired => Err(errors::ConnectorError::NotSupported { message: "Record back flow is only supported for terminal status".to_string(), connector: "recurly", } diff --git a/crates/hyperswitch_connectors/src/utils.rs b/crates/hyperswitch_connectors/src/utils.rs index 90a650a2b1f..7b9b314ce5a 100644 --- a/crates/hyperswitch_connectors/src/utils.rs +++ b/crates/hyperswitch_connectors/src/utils.rs @@ -425,7 +425,8 @@ pub(crate) fn is_payment_failure(status: AttemptStatus) -> bool { \| AttemptStatus::AuthorizationFailed \| AttemptStatus::CaptureFailed \| AttemptStatus::VoidFailed - \| AttemptStatus::Failure => true, + \| AttemptStatus::Failure + \| AttemptStatus::Expired => true, AttemptStatus::Started \| AttemptStatus::RouterDeclined \| AttemptStatus::AuthenticationPending @@ -6295,7 +6296,8 @@ impl FrmTransactionRouterDataRequest for FrmTransactionRouterData { \| AttemptStatus::Voided \| AttemptStatus::CaptureFailed \| AttemptStatus::Failure - \| AttemptStatus::AutoRefunded => Some(false), + \| AttemptStatus::AutoRefunded + \| AttemptStatus::Expired => Some(false), AttemptStatus::AuthenticationSuccessful \| AttemptStatus::PartialChargedAndChargeable diff --git a/crates/hyperswitch_domain_models/src/revenue_recovery.rs b/crates/hyperswitch_domain_models/src/revenue_recovery.rs index 6481a81d536..f9506e2ed3d 100644 --- a/crates/hyperswitch_domain_models/src/revenue_recovery.rs +++ b/crates/hyperswitch_domain_models/src/revenue_recovery.rs @@ -150,6 +150,7 @@ impl RecoveryAction { \| webhooks::IncomingWebhookEvent::PaymentIntentAuthorizationFailure \| webhooks::IncomingWebhookEvent::PaymentIntentCaptureSuccess \| webhooks::IncomingWebhookEvent::PaymentIntentCaptureFailure + \| webhooks::IncomingWebhookEvent::PaymentIntentExpired \| webhooks::IncomingWebhookEvent::PaymentActionRequired \| webhooks::IncomingWebhookEvent::EventNotSupported \| webhooks::IncomingWebhookEvent::SourceChargeable diff --git a/crates/hyperswitch_domain_models/src/router_data.rs b/crates/hyperswitch_domain_models/src/router_data.rs index 259f280d49b..8cdcfe7e456 100644 --- a/crates/hyperswitch_domain_models/src/router_data.rs +++ b/crates/hyperswitch_domain_models/src/router_data.rs @@ -702,7 +702,8 @@ impl common_enums::IntentStatus::Succeeded \| common_enums::IntentStatus::Failed \| common_enums::IntentStatus::Cancelled - \| common_enums::IntentStatus::Conflicted => Some(MinorUnit::zero()), + \| common_enums::IntentStatus::Conflicted + \| common_enums::IntentStatus::Expired => Some(MinorUnit::zero()), // For these statuses, update the capturable amount when it reaches terminal / capturable state common_enums::IntentStatus::RequiresCustomerAction \| common_enums::IntentStatus::RequiresMerchantAction @@ -737,9 +738,9 @@ impl Some(total_amount) } // No amount is captured - common_enums::IntentStatus::Cancelled \| common_enums::IntentStatus::Failed => { - Some(MinorUnit::zero()) - } + common_enums::IntentStatus::Cancelled + \| common_enums::IntentStatus::Failed + \| common_enums::IntentStatus::Expired => Some(MinorUnit::zero()), // For these statuses, update the amount captured when it reaches terminal state common_enums::IntentStatus::RequiresCustomerAction \| common_enums::IntentStatus::RequiresMerchantAction @@ -913,7 +914,8 @@ impl common_enums::IntentStatus::Succeeded \| common_enums::IntentStatus::Failed \| common_enums::IntentStatus::Cancelled - \| common_enums::IntentStatus::Conflicted => Some(MinorUnit::zero()), + \| common_enums::IntentStatus::Conflicted + \| common_enums::IntentStatus::Expired => Some(MinorUnit::zero()), // For these statuses, update the capturable amount when it reaches terminal / capturable state common_enums::IntentStatus::RequiresCustomerAction \| common_enums::IntentStatus::RequiresMerchantAction @@ -951,9 +953,9 @@ impl Some(amount_captured) } // No amount is captured - common_enums::IntentStatus::Cancelled \| common_enums::IntentStatus::Failed => { - Some(MinorUnit::zero()) - } + common_enums::IntentStatus::Cancelled + \| common_enums::IntentStatus::Failed + \| common_enums::IntentStatus::Expired => Some(MinorUnit::zero()), common_enums::IntentStatus::RequiresCapture => { let total_amount = payment_data.payment_attempt.amount_details.get_net_amount(); Some(total_amount) @@ -1149,7 +1151,8 @@ impl common_enums::IntentStatus::Succeeded \| common_enums::IntentStatus::Failed \| common_enums::IntentStatus::Cancelled - \| common_enums::IntentStatus::Conflicted => Some(MinorUnit::zero()), + \| common_enums::IntentStatus::Conflicted + \| common_enums::IntentStatus::Expired => Some(MinorUnit::zero()), // For these statuses, update the capturable amount when it reaches terminal / capturable state common_enums::IntentStatus::RequiresCustomerAction \| common_enums::IntentStatus::RequiresMerchantAction @@ -1186,9 +1189,9 @@ impl Some(amount_captured) } // No amount is captured - common_enums::IntentStatus::Cancelled \| common_enums::IntentStatus::Failed => { - Some(MinorUnit::zero()) - } + common_enums::IntentStatus::Cancelled + \| common_enums::IntentStatus::Failed + \| common_enums::IntentStatus::Expired => Some(MinorUnit::zero()), // For these statuses, update the amount captured when it reaches terminal state common_enums::IntentStatus::RequiresCustomerAction \| common_enums::IntentStatus::RequiresMerchantAction @@ -1382,7 +1385,8 @@ impl common_enums::IntentStatus::Succeeded \| common_enums::IntentStatus::Failed \| common_enums::IntentStatus::Cancelled - \| common_enums::IntentStatus::Conflicted => Some(MinorUnit::zero()), + \| common_enums::IntentStatus::Conflicted + \| common_enums::IntentStatus::Expired => Some(MinorUnit::zero()), // For these statuses, update the capturable amount when it reaches terminal / capturable state common_enums::IntentStatus::RequiresCustomerAction \| common_enums::IntentStatus::RequiresMerchantAction @@ -1417,9 +1421,9 @@ impl Some(total_amount) } // No amount is captured - common_enums::IntentStatus::Cancelled \| common_enums::IntentStatus::Failed => { - Some(MinorUnit::zero()) - } + common_enums::IntentStatus::Cancelled + \| common_enums::IntentStatus::Failed + \| common_enums::IntentStatus::Expired => Some(MinorUnit::zero()), // For these statuses, update the amount captured when it reaches terminal state common_enums::IntentStatus::RequiresCustomerAction \| common_enums::IntentStatus::RequiresMerchantAction diff --git a/crates/router/src/compatibility/stripe/payment_intents/types.rs b/crates/router/src/compatibility/stripe/payment_intents/types.rs index e8813fad688..acf2f5e03ab 100644 --- a/crates/router/src/compatibility/stripe/payment_intents/types.rs +++ b/crates/router/src/compatibility/stripe/payment_intents/types.rs @@ -421,7 +421,7 @@ impl From<api_enums::IntentStatus> for StripePaymentStatus { api_enums::IntentStatus::Succeeded \| api_enums::IntentStatus::PartiallyCaptured => { Self::Succeeded } - api_enums::IntentStatus::Failed => Self::Canceled, + api_enums::IntentStatus::Failed \| api_enums::IntentStatus::Expired => Self::Canceled, api_enums::IntentStatus::Processing => Self::Processing, api_enums::IntentStatus::RequiresCustomerAction \| api_enums::IntentStatus::RequiresMerchantAction diff --git a/crates/router/src/compatibility/stripe/setup_intents/types.rs b/crates/router/src/compatibility/stripe/setup_intents/types.rs index 3cf996685ce..90df416ec76 100644 --- a/crates/router/src/compatibility/stripe/setup_intents/types.rs +++ b/crates/router/src/compatibility/stripe/setup_intents/types.rs @@ -312,7 +312,7 @@ impl From<api_enums::IntentStatus> for StripeSetupStatus { api_enums::IntentStatus::Succeeded \| api_enums::IntentStatus::PartiallyCaptured => { Self::Succeeded } - api_enums::IntentStatus::Failed => Self::Canceled, + api_enums::IntentStatus::Failed \| api_enums::IntentStatus::Expired => Self::Canceled, api_enums::IntentStatus::Processing => Self::Processing, api_enums::IntentStatus::RequiresCustomerAction => Self::RequiresAction, api_enums::IntentStatus::RequiresMerchantAction diff --git a/crates/router/src/compatibility/stripe/webhooks.rs b/crates/router/src/compatibility/stripe/webhooks.rs index 3bd0f83b7db..5dad60120ec 100644 --- a/crates/router/src/compatibility/stripe/webhooks.rs +++ b/crates/router/src/compatibility/stripe/webhooks.rs @@ -270,7 +270,8 @@ fn get_stripe_event_type(event_type: api_models::enums::EventType) -> &'static s api_models::enums::EventType::PaymentSucceeded => "payment_intent.succeeded", api_models::enums::EventType::PaymentFailed => "payment_intent.payment_failed", api_models::enums::EventType::PaymentProcessing => "payment_intent.processing", - api_models::enums::EventType::PaymentCancelled => "payment_intent.canceled", + api_models::enums::EventType::PaymentCancelled + \| api_models::enums::EventType::PaymentExpired => "payment_intent.canceled", // the below are not really stripe compatible because stripe doesn't provide this api_models::enums::EventType::ActionRequired => "action.required", diff --git a/crates/router/src/connector/utils.rs b/crates/router/src/connector/utils.rs index 525a9d678ae..02839ee8d78 100644 --- a/crates/router/src/connector/utils.rs +++ b/crates/router/src/connector/utils.rs @@ -2195,7 +2195,8 @@ impl FrmTransactionRouterDataRequest for fraud_check::FrmTransactionRouterData { \| storage_enums::AttemptStatus::Voided \| storage_enums::AttemptStatus::CaptureFailed \| storage_enums::AttemptStatus::Failure - \| storage_enums::AttemptStatus::AutoRefunded => Some(false), + \| storage_enums::AttemptStatus::AutoRefunded + \| storage_enums::AttemptStatus::Expired => Some(false), storage_enums::AttemptStatus::AuthenticationSuccessful \| storage_enums::AttemptStatus::PartialChargedAndChargeable @@ -2226,7 +2227,8 @@ pub fn is_payment_failure(status: enums::AttemptStatus) -> bool { \| common_enums::AttemptStatus::AuthorizationFailed \| common_enums::AttemptStatus::CaptureFailed \| common_enums::AttemptStatus::VoidFailed - \| common_enums::AttemptStatus::Failure => true, + \| common_enums::AttemptStatus::Failure + \| common_enums::AttemptStatus::Expired => true, common_enums::AttemptStatus::Started \| common_enums::AttemptStatus::RouterDeclined \| common_enums::AttemptStatus::AuthenticationPending diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs index fd8615ff8af..5651dae946d 100644 --- a/crates/router/src/core/payments.rs +++ b/crates/router/src/core/payments.rs @@ -3143,7 +3143,8 @@ impl ValidateStatusForOperation for &PaymentRedirectSync { \| common_enums::IntentStatus::RequiresCapture \| common_enums::IntentStatus::PartiallyCaptured \| common_enums::IntentStatus::RequiresConfirmation - \| common_enums::IntentStatus::PartiallyCapturedAndCapturable => { + \| common_enums::IntentStatus::PartiallyCapturedAndCapturable + \| common_enums::IntentStatus::Expired => { Err(errors::ApiErrorResponse::PaymentUnexpectedState { current_flow: format!("{self:?}"), field_name: "status".to_string(), diff --git a/crates/router/src/core/payments/helpers.rs b/crates/router/src/core/payments/helpers.rs index 39eeba8223a..9c9d1d69053 100644 --- a/crates/router/src/core/payments/helpers.rs +++ b/crates/router/src/core/payments/helpers.rs @@ -4276,7 +4276,8 @@ pub fn get_attempt_type( \| enums::AttemptStatus::AutoRefunded \| enums::AttemptStatus::PaymentMethodAwaited \| enums::AttemptStatus::DeviceDataCollectionPending - \| enums::AttemptStatus::IntegrityFailure => { + \| enums::AttemptStatus::IntegrityFailure + \| enums::AttemptStatus::Expired => { metrics::MANUAL_RETRY_VALIDATION_FAILED.add( 1, router_env::metric_attributes!(( @@ -4332,7 +4333,8 @@ pub fn get_attempt_type( \| enums::IntentStatus::PartiallyCapturedAndCapturable \| enums::IntentStatus::Processing \| enums::IntentStatus::Succeeded - \| enums::IntentStatus::Conflicted => { + \| enums::IntentStatus::Conflicted + \| enums::IntentStatus::Expired => { Err(report!(errors::ApiErrorResponse::PreconditionFailed { message: format!( "You cannot {action} this payment because it has status {}", @@ -4579,18 +4581,19 @@ pub fn is_manual_retry_allowed( \| enums::AttemptStatus::AutoRefunded \| enums::AttemptStatus::PaymentMethodAwaited \| enums::AttemptStatus::DeviceDataCollectionPending - \| storage_enums::AttemptStatus::IntegrityFailure => { + \| enums::AttemptStatus::IntegrityFailure + \| enums::AttemptStatus::Expired => { logger::error!("Payment Attempt should not be in this state because Attempt to Intent status mapping doesn't allow it"); None } - storage_enums::AttemptStatus::VoidFailed - \| storage_enums::AttemptStatus::RouterDeclined - \| storage_enums::AttemptStatus::CaptureFailed => Some(false), + enums::AttemptStatus::VoidFailed + \| enums::AttemptStatus::RouterDeclined + \| enums::AttemptStatus::CaptureFailed => Some(false), - storage_enums::AttemptStatus::AuthenticationFailed - \| storage_enums::AttemptStatus::AuthorizationFailed - \| storage_enums::AttemptStatus::Failure => Some(true), + enums::AttemptStatus::AuthenticationFailed + \| enums::AttemptStatus::AuthorizationFailed + \| enums::AttemptStatus::Failure => Some(true), }, enums::IntentStatus::Cancelled \| enums::IntentStatus::RequiresCapture @@ -4598,7 +4601,8 @@ pub fn is_manual_retry_allowed( \| enums::IntentStatus::PartiallyCapturedAndCapturable \| enums::IntentStatus::Processing \| enums::IntentStatus::Succeeded - \| enums::IntentStatus::Conflicted => Some(false), + \| enums::IntentStatus::Conflicted + \| enums::IntentStatus::Expired => Some(false), enums::IntentStatus::RequiresCustomerAction \| enums::IntentStatus::RequiresMerchantAction diff --git a/crates/router/src/core/payments/operations/payment_attempt_record.rs b/crates/router/src/core/payments/operations/payment_attempt_record.rs index b2834f0bfad..3c5259b6bf1 100644 --- a/crates/router/src/core/payments/operations/payment_attempt_record.rs +++ b/crates/router/src/core/payments/operations/payment_attempt_record.rs @@ -87,7 +87,8 @@ impl ValidateStatusForOperation for PaymentAttemptRecord { \| common_enums::IntentStatus::RequiresCapture \| common_enums::IntentStatus::PartiallyCaptured \| common_enums::IntentStatus::RequiresConfirmation - \| common_enums::IntentStatus::PartiallyCapturedAndCapturable => { + \| common_enums::IntentStatus::PartiallyCapturedAndCapturable + \| common_enums::IntentStatus::Expired => { Err(errors::ApiErrorResponse::PaymentUnexpectedState { current_flow: format!("{self:?}"), field_name: "status".to_string(), diff --git a/crates/router/src/core/payments/operations/payment_capture_v2.rs b/crates/router/src/core/payments/operations/payment_capture_v2.rs index 1b46cb85d4a..13100e7762f 100644 --- a/crates/router/src/core/payments/operations/payment_capture_v2.rs +++ b/crates/router/src/core/payments/operations/payment_capture_v2.rs @@ -43,7 +43,8 @@ impl ValidateStatusForOperation for PaymentsCapture { \| common_enums::IntentStatus::RequiresMerchantAction \| common_enums::IntentStatus::RequiresPaymentMethod \| common_enums::IntentStatus::PartiallyCaptured - \| common_enums::IntentStatus::RequiresConfirmation => { + \| common_enums::IntentStatus::RequiresConfirmation + \| common_enums::IntentStatus::Expired => { Err(errors::ApiErrorResponse::PaymentUnexpectedState { current_flow: format!("{self:?}"), field_name: "status".to_string(), diff --git a/crates/router/src/core/payments/operations/payment_confirm_intent.rs b/crates/router/src/core/payments/operations/payment_confirm_intent.rs index 143d6f7d342..a3b81afb4f8 100644 --- a/crates/router/src/core/payments/operations/payment_confirm_intent.rs +++ b/crates/router/src/core/payments/operations/payment_confirm_intent.rs @@ -53,7 +53,8 @@ impl ValidateStatusForOperation for PaymentIntentConfirm { \| common_enums::IntentStatus::RequiresCapture \| common_enums::IntentStatus::PartiallyCaptured \| common_enums::IntentStatus::RequiresConfirmation - \| common_enums::IntentStatus::PartiallyCapturedAndCapturable => { + \| common_enums::IntentStatus::PartiallyCapturedAndCapturable + \| common_enums::IntentStatus::Expired => { Err(errors::ApiErrorResponse::PaymentUnexpectedState { current_flow: format!("{self:?}"), field_name: "status".to_string(), diff --git a/crates/router/src/core/payments/operations/payment_get.rs b/crates/router/src/core/payments/operations/payment_get.rs index 402c11e2f86..621a6e71a70 100644 --- a/crates/router/src/core/payments/operations/payment_get.rs +++ b/crates/router/src/core/payments/operations/payment_get.rs @@ -42,7 +42,8 @@ impl ValidateStatusForOperation for PaymentGet { \| common_enums::IntentStatus::PartiallyCapturedAndCapturable \| common_enums::IntentStatus::PartiallyCaptured \| common_enums::IntentStatus::Cancelled - \| common_enums::IntentStatus::Conflicted => Ok(()), + \| common_enums::IntentStatus::Conflicted + \| common_enums::IntentStatus::Expired => Ok(()), // These statuses are not valid for this operation common_enums::IntentStatus::RequiresConfirmation \| common_enums::IntentStatus::RequiresPaymentMethod => { diff --git a/crates/router/src/core/payments/operations/payment_response.rs b/crates/router/src/core/payments/operations/payment_response.rs index 7fa8a4858f8..425173d4441 100644 --- a/crates/router/src/core/payments/operations/payment_response.rs +++ b/crates/router/src/core/payments/operations/payment_response.rs @@ -2565,7 +2565,8 @@ impl<F: Clone> PostUpdateTracker<F, PaymentConfirmData<F>, types::PaymentsAuthor \| common_enums::AttemptStatus::AutoRefunded \| common_enums::AttemptStatus::Unresolved \| common_enums::AttemptStatus::Pending - \| common_enums::AttemptStatus::Failure => (), + \| common_enums::AttemptStatus::Failure + \| common_enums::AttemptStatus::Expired => (), common_enums::AttemptStatus::Started \| common_enums::AttemptStatus::AuthenticationPending diff --git a/crates/router/src/core/payments/operations/payment_session_intent.rs b/crates/router/src/core/payments/operations/payment_session_intent.rs index 8ae5d2cd19d..d713c5175b2 100644 --- a/crates/router/src/core/payments/operations/payment_session_intent.rs +++ b/crates/router/src/core/payments/operations/payment_session_intent.rs @@ -41,7 +41,7 @@ impl ValidateStatusForOperation for PaymentSessionIntent { \| common_enums::IntentStatus::RequiresConfirmation \| common_enums::IntentStatus::PartiallyCapturedAndCapturable \| common_enums::IntentStatus::Succeeded - \| common_enums::IntentStatus::Failed \| common_enums::IntentStatus::Conflicted => { + \| common_enums::IntentStatus::Failed \| common_enums::IntentStatus::Conflicted \| common_enums::IntentStatus::Expired => { Err(errors::ApiErrorResponse::PreconditionFailed { message: format!( "You cannot create session token for this payment because it has status {intent_status}. Expected status is requires_payment_method.", diff --git a/crates/router/src/core/payments/operations/payment_update_intent.rs b/crates/router/src/core/payments/operations/payment_update_intent.rs index 2c7b2ea4e8b..6e500e3eb0b 100644 --- a/crates/router/src/core/payments/operations/payment_update_intent.rs +++ b/crates/router/src/core/payments/operations/payment_update_intent.rs @@ -59,7 +59,8 @@ impl ValidateStatusForOperation for PaymentUpdateIntent { \| common_enums::IntentStatus::RequiresCapture \| common_enums::IntentStatus::PartiallyCaptured \| common_enums::IntentStatus::RequiresConfirmation - \| common_enums::IntentStatus::PartiallyCapturedAndCapturable => { + \| common_enums::IntentStatus::PartiallyCapturedAndCapturable + \| common_enums::IntentStatus::Expired => { Err(errors::ApiErrorResponse::PaymentUnexpectedState { current_flow: format!("{self:?}"), field_name: "status".to_string(), diff --git a/crates/router/src/core/payments/operations/proxy_payments_intent.rs b/crates/router/src/core/payments/operations/proxy_payments_intent.rs index 30ea6913c6d..3994fd8ef05 100644 --- a/crates/router/src/core/payments/operations/proxy_payments_intent.rs +++ b/crates/router/src/core/payments/operations/proxy_payments_intent.rs @@ -54,7 +54,8 @@ impl ValidateStatusForOperation for PaymentProxyIntent { \| common_enums::IntentStatus::RequiresCapture \| common_enums::IntentStatus::PartiallyCaptured \| common_enums::IntentStatus::RequiresConfirmation - \| common_enums::IntentStatus::PartiallyCapturedAndCapturable => { + \| common_enums::IntentStatus::PartiallyCapturedAndCapturable + \| common_enums::IntentStatus::Expired => { Err(errors::ApiErrorResponse::PaymentUnexpectedState { current_flow: format!("{self:?}"), field_name: "status".to_string(), diff --git a/crates/router/src/core/payments/payment_methods.rs b/crates/router/src/core/payments/payment_methods.rs index e21b3b96105..9bf9d3cc921 100644 --- a/crates/router/src/core/payments/payment_methods.rs +++ b/crates/router/src/core/payments/payment_methods.rs @@ -370,7 +370,8 @@ fn validate_payment_status_for_payment_method_list( \| common_enums::IntentStatus::RequiresCapture \| common_enums::IntentStatus::PartiallyCaptured \| common_enums::IntentStatus::RequiresConfirmation - \| common_enums::IntentStatus::PartiallyCapturedAndCapturable => { + \| common_enums::IntentStatus::PartiallyCapturedAndCapturable + \| common_enums::IntentStatus::Expired => { Err(errors::ApiErrorResponse::PaymentUnexpectedState { current_flow: "list_payment_methods".to_string(), field_name: "status".to_string(), diff --git a/crates/router/src/core/payments/retry.rs b/crates/router/src/core/payments/retry.rs index 8fe9c565e08..aafe25aea67 100644 --- a/crates/router/src/core/payments/retry.rs +++ b/crates/router/src/core/payments/retry.rs @@ -808,7 +808,8 @@ impl<F: Send + Clone + Sync, FData: Send + Sync> \| storage_enums::AttemptStatus::ConfirmationAwaited \| storage_enums::AttemptStatus::Unresolved \| storage_enums::AttemptStatus::DeviceDataCollectionPending - \| storage_enums::AttemptStatus::IntegrityFailure => false, + \| storage_enums::AttemptStatus::IntegrityFailure + \| storage_enums::AttemptStatus::Expired => false, storage_enums::AttemptStatus::AuthenticationFailed \| storage_enums::AttemptStatus::AuthorizationFailed diff --git a/crates/router/src/core/payments/transformers.rs b/crates/router/src/core/payments/transformers.rs index 6f5689ed1cb..0cb84fc75cf 100644 --- a/crates/router/src/core/payments/transformers.rs +++ b/crates/router/src/core/payments/transformers.rs @@ -1943,17 +1943,21 @@ where let next_action_containing_wait_screen = wait_screen_next_steps_check(payment_attempt.clone())?; - let next_action = payment_attempt - .redirection_data - .as_ref() - .map(\|_\| api_models::payments::NextActionData::RedirectToUrl { redirect_to_url }) - .or(next_action_containing_wait_screen.map(\|wait_screen_data\| { - api_models::payments::NextActionData::WaitScreenInformation { - display_from_timestamp: wait_screen_data.display_from_timestamp, - display_to_timestamp: wait_screen_data.display_to_timestamp, - poll_config: wait_screen_data.poll_config, - } - })); + let next_action = if payment_intent.status.is_in_terminal_state() { + None + } else { + payment_attempt + .redirection_data + .as_ref() + .map(\|_\| api_models::payments::NextActionData::RedirectToUrl { redirect_to_url }) + .or(next_action_containing_wait_screen.map(\|wait_screen_data\| { + api_models::payments::NextActionData::WaitScreenInformation { + display_from_timestamp: wait_screen_data.display_from_timestamp, + display_to_timestamp: wait_screen_data.display_to_timestamp, + poll_config: wait_screen_data.poll_config, + } + })) + }; let connector_token_details = payment_attempt .connector_token_details @@ -2641,136 +2645,142 @@ where } else { let mut next_action_response = None; - let bank_transfer_next_steps = bank_transfer_next_steps_check(payment_attempt.clone())?; + // Early exit for terminal payment statuses - don't evaluate next_action at all + if payment_intent.status.is_in_terminal_state() { + next_action_response = None; + } else { + let bank_transfer_next_steps = bank_transfer_next_steps_check(payment_attempt.clone())?; - let next_action_voucher = voucher_next_steps_check(payment_attempt.clone())?; + let next_action_voucher = voucher_next_steps_check(payment_attempt.clone())?; - let next_action_mobile_payment = mobile_payment_next_steps_check(&payment_attempt)?; + let next_action_mobile_payment = mobile_payment_next_steps_check(&payment_attempt)?; - let next_action_containing_qr_code_url = qr_code_next_steps_check(payment_attempt.clone())?; + let next_action_containing_qr_code_url = + qr_code_next_steps_check(payment_attempt.clone())?; - let papal_sdk_next_action = paypal_sdk_next_steps_check(payment_attempt.clone())?; + let papal_sdk_next_action = paypal_sdk_next_steps_check(payment_attempt.clone())?; - let next_action_containing_fetch_qr_code_url = - fetch_qr_code_url_next_steps_check(payment_attempt.clone())?; + let next_action_containing_fetch_qr_code_url = + fetch_qr_code_url_next_steps_check(payment_attempt.clone())?; - let next_action_containing_wait_screen = - wait_screen_next_steps_check(payment_attempt.clone())?; + let next_action_containing_wait_screen = + wait_screen_next_steps_check(payment_attempt.clone())?; - let next_action_invoke_hidden_frame = next_action_invoke_hidden_frame(&payment_attempt)?; + let next_action_invoke_hidden_frame = + next_action_invoke_hidden_frame(&payment_attempt)?; - if payment_intent.status == enums::IntentStatus::RequiresCustomerAction - \|\| bank_transfer_next_steps.is_some() - \|\| next_action_voucher.is_some() - \|\| next_action_containing_qr_code_url.is_some() - \|\| next_action_containing_wait_screen.is_some() - \|\| papal_sdk_next_action.is_some() - \|\| next_action_containing_fetch_qr_code_url.is_some() - \|\| payment_data.get_authentication().is_some() - { - next_action_response = bank_transfer_next_steps - .map(\|bank_transfer\| { - api_models::payments::NextActionData::DisplayBankTransferInformation { - bank_transfer_steps_and_charges_details: bank_transfer, - } - }) - .or(next_action_voucher.map(\|voucher_data\| { - api_models::payments::NextActionData::DisplayVoucherInformation { - voucher_details: voucher_data, - } - })) - .or(next_action_mobile_payment.map(\|mobile_payment_data\| { - api_models::payments::NextActionData::CollectOtp { - consent_data_required: mobile_payment_data.consent_data_required, - } - })) - .or(next_action_containing_qr_code_url.map(\|qr_code_data\| { - api_models::payments::NextActionData::foreign_from(qr_code_data) - })) - .or(next_action_containing_fetch_qr_code_url.map(\|fetch_qr_code_data\| { - api_models::payments::NextActionData::FetchQrCodeInformation { - qr_code_fetch_url: fetch_qr_code_data.qr_code_fetch_url - } - })) - .or(papal_sdk_next_action.map(\|paypal_next_action_data\| { - api_models::payments::NextActionData::InvokeSdkClient{ - next_action_data: paypal_next_action_data - } - })) - .or(next_action_containing_wait_screen.map(\|wait_screen_data\| { - api_models::payments::NextActionData::WaitScreenInformation { - display_from_timestamp: wait_screen_data.display_from_timestamp, - display_to_timestamp: wait_screen_data.display_to_timestamp, - poll_config: wait_screen_data.poll_config, - } - })) - .or(payment_attempt.authentication_data.as_ref().map(\|_\| { - // Check if iframe redirection is enabled in the business profile - let redirect_url = helpers::create_startpay_url( - base_url, - &payment_attempt, - &payment_intent, - ); - // Check if redirection inside popup is enabled in the payment intent - if payment_intent.is_iframe_redirection_enabled.unwrap_or(false) { - api_models::payments::NextActionData::RedirectInsidePopup { - popup_url: redirect_url, - redirect_response_url:router_return_url + if payment_intent.status == enums::IntentStatus::RequiresCustomerAction + \|\| bank_transfer_next_steps.is_some() + \|\| next_action_voucher.is_some() + \|\| next_action_containing_qr_code_url.is_some() + \|\| next_action_containing_wait_screen.is_some() + \|\| papal_sdk_next_action.is_some() + \|\| next_action_containing_fetch_qr_code_url.is_some() + \|\| payment_data.get_authentication().is_some() + { + next_action_response = bank_transfer_next_steps + .map(\|bank_transfer\| { + api_models::payments::NextActionData::DisplayBankTransferInformation { + bank_transfer_steps_and_charges_details: bank_transfer, } - } else { - api_models::payments::NextActionData::RedirectToUrl { - redirect_to_url: redirect_url, + }) + .or(next_action_voucher.map(\|voucher_data\| { + api_models::payments::NextActionData::DisplayVoucherInformation { + voucher_details: voucher_data, } - } - })) - .or(match payment_data.get_authentication(){ - Some(authentication_store) => { - let authentication = &authentication_store.authentication; - if payment_intent.status == common_enums::IntentStatus::RequiresCustomerAction && authentication_store.cavv.is_none() && authentication.is_separate_authn_required(){ - // if preAuthn and separate authentication needed. - let poll_config = payment_data.get_poll_config().unwrap_or_default(); - let request_poll_id = core_utils::get_external_authentication_request_poll_id(&payment_intent.payment_id); - let payment_connector_name = payment_attempt.connector - .as_ref() - .get_required_value("connector")?; - Some(api_models::payments::NextActionData::ThreeDsInvoke { - three_ds_data: api_models::payments::ThreeDsData { - three_ds_authentication_url: helpers::create_authentication_url(base_url, &payment_attempt), - three_ds_authorize_url: helpers::create_authorize_url( - base_url, - &payment_attempt, - payment_connector_name, - ), - three_ds_method_details: authentication.three_ds_method_url.as_ref().zip(authentication.three_ds_method_data.as_ref()).map(\|(three_ds_method_url,three_ds_method_data )\|{ - api_models::payments::ThreeDsMethodData::AcsThreeDsMethodData { - three_ds_method_data_submission: true, - three_ds_method_data: Some(three_ds_method_data.clone()), - three_ds_method_url: Some(three_ds_method_url.to_owned()), - } - }).unwrap_or(api_models::payments::ThreeDsMethodData::AcsThreeDsMethodData { - three_ds_method_data_submission: false, - three_ds_method_data: None, - three_ds_method_url: None, - }), - poll_config: api_models::payments::PollConfigResponse {poll_id: request_poll_id, delay_in_secs: poll_config.delay_in_secs, frequency: poll_config.frequency}, - message_version: authentication.message_version.as_ref() - .map(\|version\| version.to_string()), - directory_server_id: authentication.directory_server_id.clone(), - }, - }) - }else{ - None + })) + .or(next_action_mobile_payment.map(\|mobile_payment_data\| { + api_models::payments::NextActionData::CollectOtp { + consent_data_required: mobile_payment_data.consent_data_required, } - }, - None => None - }) - .or(match next_action_invoke_hidden_frame{ - Some(threeds_invoke_data) => Some(construct_connector_invoke_hidden_frame( - threeds_invoke_data, - )?), - None => None - - }); + })) + .or(next_action_containing_qr_code_url.map(\|qr_code_data\| { + api_models::payments::NextActionData::foreign_from(qr_code_data) + })) + .or(next_action_containing_fetch_qr_code_url.map(\|fetch_qr_code_data\| { + api_models::payments::NextActionData::FetchQrCodeInformation { + qr_code_fetch_url: fetch_qr_code_data.qr_code_fetch_url + } + })) + .or(papal_sdk_next_action.map(\|paypal_next_action_data\| { + api_models::payments::NextActionData::InvokeSdkClient{ + next_action_data: paypal_next_action_data + } + })) + .or(next_action_containing_wait_screen.map(\|wait_screen_data\| { + api_models::payments::NextActionData::WaitScreenInformation { + display_from_timestamp: wait_screen_data.display_from_timestamp, + display_to_timestamp: wait_screen_data.display_to_timestamp, + poll_config: wait_screen_data.poll_config, + } + })) + .or(payment_attempt.authentication_data.as_ref().map(\|_\| { + // Check if iframe redirection is enabled in the business profile + let redirect_url = helpers::create_startpay_url( + base_url, + &payment_attempt, + &payment_intent, + ); + // Check if redirection inside popup is enabled in the payment intent + if payment_intent.is_iframe_redirection_enabled.unwrap_or(false) { + api_models::payments::NextActionData::RedirectInsidePopup { + popup_url: redirect_url, + redirect_response_url:router_return_url + } + } else { + api_models::payments::NextActionData::RedirectToUrl { + redirect_to_url: redirect_url, + } + } + })) + .or(match payment_data.get_authentication(){ + Some(authentication_store) => { + let authentication = &authentication_store.authentication; + if payment_intent.status == common_enums::IntentStatus::RequiresCustomerAction && authentication_store.cavv.is_none() && authentication.is_separate_authn_required(){ + // if preAuthn and separate authentication needed. + let poll_config = payment_data.get_poll_config().unwrap_or_default(); + let request_poll_id = core_utils::get_external_authentication_request_poll_id(&payment_intent.payment_id); + let payment_connector_name = payment_attempt.connector + .as_ref() + .get_required_value("connector")?; + Some(api_models::payments::NextActionData::ThreeDsInvoke { + three_ds_data: api_models::payments::ThreeDsData { + three_ds_authentication_url: helpers::create_authentication_url(base_url, &payment_attempt), + three_ds_authorize_url: helpers::create_authorize_url( + base_url, + &payment_attempt, + payment_connector_name, + ), + three_ds_method_details: authentication.three_ds_method_url.as_ref().zip(authentication.three_ds_method_data.as_ref()).map(\|(three_ds_method_url,three_ds_method_data )\|{ + api_models::payments::ThreeDsMethodData::AcsThreeDsMethodData { + three_ds_method_data_submission: true, + three_ds_method_data: Some(three_ds_method_data.clone()), + three_ds_method_url: Some(three_ds_method_url.to_owned()), + } + }).unwrap_or(api_models::payments::ThreeDsMethodData::AcsThreeDsMethodData { + three_ds_method_data_submission: false, + three_ds_method_data: None, + three_ds_method_url: None, + }), + poll_config: api_models::payments::PollConfigResponse {poll_id: request_poll_id, delay_in_secs: poll_config.delay_in_secs, frequency: poll_config.frequency}, + message_version: authentication.message_version.as_ref() + .map(\|version\| version.to_string()), + directory_server_id: authentication.directory_server_id.clone(), + }, + }) + }else{ + None + } + }, + None => None + }) + .or(match next_action_invoke_hidden_frame{ + Some(threeds_invoke_data) => Some(construct_connector_invoke_hidden_frame( + threeds_invoke_data, + )?), + None => None + }); + } }; // next action check for third party sdk session (for ex: Apple pay through trustpay has third party sdk session response) diff --git a/crates/router/src/core/revenue_recovery/transformers.rs b/crates/router/src/core/revenue_recovery/transformers.rs index a4e40c69b72..76f987673da 100644 --- a/crates/router/src/core/revenue_recovery/transformers.rs +++ b/crates/router/src/core/revenue_recovery/transformers.rs @@ -35,7 +35,8 @@ impl ForeignFrom<AttemptStatus> for RevenueRecoveryPaymentsAttemptStatus { \| AttemptStatus::AuthenticationPending \| AttemptStatus::DeviceDataCollectionPending \| AttemptStatus::Unresolved - \| AttemptStatus::IntegrityFailure => Self::InvalidStatus(s.to_string()), + \| AttemptStatus::IntegrityFailure + \| AttemptStatus::Expired => Self::InvalidStatus(s.to_string()), } } } diff --git a/crates/router/src/core/routing/helpers.rs b/crates/router/src/core/routing/helpers.rs index 32a7b560566..5d5a16912e2 100644 --- a/crates/router/src/core/routing/helpers.rs +++ b/crates/router/src/core/routing/helpers.rs @@ -1714,9 +1714,8 @@ fn get_desired_payment_status_for_dynamic_routing_metrics( \| common_enums::AttemptStatus::IntegrityFailure \| common_enums::AttemptStatus::PaymentMethodAwaited \| common_enums::AttemptStatus::ConfirmationAwaited - \| common_enums::AttemptStatus::DeviceDataCollectionPending => { - common_enums::AttemptStatus::Pending - } + \| common_enums::AttemptStatus::DeviceDataCollectionPending + \| common_enums::AttemptStatus::Expired => common_enums::AttemptStatus::Pending, } } @@ -1734,7 +1733,9 @@ impl ForeignFrom<common_enums::AttemptStatus> for open_router::TxnStatus { common_enums::AttemptStatus::Charged => Self::Charged, common_enums::AttemptStatus::Authorizing => Self::Authorizing, common_enums::AttemptStatus::CodInitiated => Self::CODInitiated, - common_enums::AttemptStatus::Voided => Self::Voided, + common_enums::AttemptStatus::Voided \| common_enums::AttemptStatus::Expired => { + Self::Voided + } common_enums::AttemptStatus::VoidInitiated => Self::VoidInitiated, common_enums::AttemptStatus::CaptureInitiated => Self::CaptureInitiated, common_enums::AttemptStatus::CaptureFailed => Self::CaptureFailed, diff --git a/crates/router/src/types.rs b/crates/router/src/types.rs index 717140cc0ed..4887a80f31a 100644 --- a/crates/router/src/types.rs +++ b/crates/router/src/types.rs @@ -296,12 +296,15 @@ impl Capturable for PaymentsAuthorizeData { { match payment_data.get_capture_method().unwrap_or_default() { - common_enums::CaptureMethod::Automatic\|common_enums::CaptureMethod::SequentialAutomatic => { + common_enums::CaptureMethod::Automatic + \| common_enums::CaptureMethod::SequentialAutomatic => { let intent_status = common_enums::IntentStatus::foreign_from(attempt_status); match intent_status { common_enums::IntentStatus::Succeeded \| common_enums::IntentStatus::Failed - \| common_enums::IntentStatus::Processing \| common_enums::IntentStatus::Conflicted => Some(0), + \| common_enums::IntentStatus::Processing + \| common_enums::IntentStatus::Conflicted + \| common_enums::IntentStatus::Expired => Some(0), common_enums::IntentStatus::Cancelled \| common_enums::IntentStatus::PartiallyCaptured \| common_enums::IntentStatus::RequiresCustomerAction @@ -341,7 +344,8 @@ impl Capturable for PaymentsCaptureData { match intent_status { common_enums::IntentStatus::Succeeded \| common_enums::IntentStatus::PartiallyCaptured - \| common_enums::IntentStatus::Conflicted => Some(0), + \| common_enums::IntentStatus::Conflicted + \| common_enums::IntentStatus::Expired => Some(0), common_enums::IntentStatus::Processing \| common_enums::IntentStatus::Cancelled \| common_enums::IntentStatus::Failed @@ -383,9 +387,11 @@ impl Capturable for CompleteAuthorizeData { common_enums::CaptureMethod::Automatic \| common_enums::CaptureMethod::SequentialAutomatic => { let intent_status = common_enums::IntentStatus::foreign_from(attempt_status); match intent_status { - common_enums::IntentStatus::Succeeded\| - common_enums::IntentStatus::Failed\| - common_enums::IntentStatus::Processing \| common_enums::IntentStatus::Conflicted => Some(0), + common_enums::IntentStatus::Succeeded + \| common_enums::IntentStatus::Failed + \| common_enums::IntentStatus::Processing + \| common_enums::IntentStatus::Conflicted + \| common_enums::IntentStatus::Expired => Some(0), common_enums::IntentStatus::Cancelled \| common_enums::IntentStatus::PartiallyCaptured \| common_enums::IntentStatus::RequiresCustomerAction \| common_enums::IntentStatus::RequiresMerchantAction @@ -433,7 +439,8 @@ impl Capturable for PaymentsCancelData { common_enums::IntentStatus::Cancelled \| common_enums::IntentStatus::Processing \| common_enums::IntentStatus::PartiallyCaptured - \| common_enums::IntentStatus::Conflicted => Some(0), + \| common_enums::IntentStatus::Conflicted + \| common_enums::IntentStatus::Expired => Some(0), common_enums::IntentStatus::Succeeded \| common_enums::IntentStatus::Failed \| common_enums::IntentStatus::RequiresCustomerAction diff --git a/crates/router/src/types/transformers.rs b/crates/router/src/types/transformers.rs index 5cd1c3d3bd1..daf630e6894 100644 --- a/crates/router/src/types/transformers.rs +++ b/crates/router/src/types/transformers.rs @@ -168,7 +168,7 @@ impl ForeignTryFrom<storage_enums::AttemptStatus> for storage_enums::CaptureStat \| storage_enums::AttemptStatus::PaymentMethodAwaited \| storage_enums::AttemptStatus::ConfirmationAwaited \| storage_enums::AttemptStatus::DeviceDataCollectionPending - \| storage_enums::AttemptStatus::PartialChargedAndChargeable => { + \| storage_enums::AttemptStatus::PartialChargedAndChargeable \| storage_enums::AttemptStatus::Expired => { Err(errors::ApiErrorResponse::PreconditionFailed { message: "AttemptStatus must be one of these for multiple partial captures [Charged, PartialCharged, Pending, CaptureInitiated, Failure, CaptureFailed]".into(), }.into()) diff --git a/migrations/2025-07-24-214849_add_expired_to_intent_and_attempt_status_and_event/down.sql b/migrations/2025-07-24-214849_add_expired_to_intent_and_attempt_status_and_event/down.sql new file mode 100644 index 00000000000..e0ac49d1ecf --- /dev/null +++ b/migrations/2025-07-24-214849_add_expired_to_intent_and_attempt_status_and_event/down.sql @@ -0,0 +1 @@ +SELECT 1; diff --git a/migrations/2025-07-24-214849_add_expired_to_intent_and_attempt_status_and_event/up.sql b/migrations/2025-07-24-214849_add_expired_to_intent_and_attempt_status_and_event/up.sql new file mode 100644 index 00000000000..ae322e833e4 --- /dev/null +++ b/migrations/2025-07-24-214849_add_expired_to_intent_and_attempt_status_and_event/up.sql @@ -0,0 +1,5 @@ +ALTER TYPE "IntentStatus" ADD VALUE IF NOT EXISTS 'expired'; + +ALTER TYPE "AttemptStatus" ADD VALUE IF NOT EXISTS 'expired'; + +ALTER TYPE "EventType" ADD VALUE IF NOT EXISTS 'payment_expired'; \ No newline at end of file	2025-07-22T15:19:21Z	## Type of Change - [x] New feature ## Description This PR implements payment expiration handling for QR code-based payments through Adyen's OFFER_CLOSED webhook and fixes next_action display for terminal payment states. ### Changes: 1. Adyen `OFFER_CLOSED` webhook: - Added `OfferClosed` to `WebhookEventCode` enum - Handle `OfferClosed` events as `Expired` status in AttemptStatus - Maps `OFFER_CLOSED` events to `PaymentIntentExpired` webhook 2. Added `Expired` status support: - Added to both `AttemptStatus` and `IntentStatus` enums - Database migration for new enum values - Add `PaymentExpired` event type for outgoing webhooks 3. Fixed next_action for terminal payments - Prevents showing QR codes/redirects data for terminal payments ## Motivation and Context QR code payments (like PIX) have expiration times. When they expire, Adyen sends OFFER_CLOSED webhooks, but Hyperswitch wasn't handling these properly. Additionally, cancelled payments were still showing actionable `next_action` content. ## How did you test it? <details> <summary>1. Create a Pix Payment (with expiry)</summary> cURL curl --location --request POST 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_W8rGDzCct9xjU2Rqd8xxZubP9rRJ4u1Y42J1im7qplUxjOgWmJS4ZPq9lRfvOCnd' \ --data-raw '{"amount":4500,"currency":"BRL","confirm":true,"profile_id":"pro_HvmsPUKxoCtI58mtCUhg","capture_on":"2022-09-10T10:11:12Z","connector":["adyen"],"customer_id":"cus_HXi1vEcMXQ74qsaNq57p","email":"[email protected]","return_url":"https://google.com","payment_method":"bank_transfer","payment_method_type":"pix","payment_method_data":{"bank_transfer":{"pix":{"pix_key":"test","cpf":"test","cnpj":"test","expiry_date":"2025-07-22T14:58:00Z"}}},"billing":{"address":{"line1":"1467","line2":"Harrison Street","line3":"Harrison Street","city":"San Fransico","state":"California","zip":"94122","country":"BR","first_name":"joseph","last_name":"Doe"},"phone":{"number":"8056594427","country_code":"+91"},"email":"[email protected]"},"metadata":{"Force-PSP":"Adyen","udf1":"value1","new_customer":"true","login_date":"2019-09-10T10:11:12Z"},"browser_info":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36","accept_header":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8","language":"en-US","color_depth":32,"screen_height":1117,"screen_width":1728,"time_zone":-330,"java_enabled":true,"java_script_enabled":true,"ip_address":"127.0.0.1"},"customer_acceptance":{"acceptance_type":"online","accepted_at":"1963-05-03T04:07:52.723Z","online":{"ip_address":"127.0.0.1","user_agent":"amet irure esse"}},"session_expiry":60}' Response {"payment_id":"pay_8P2b5MuSkplj8d3U06Nj","merchant_id":"merchant_1753193103","status":"requires_customer_action","amount":4500,"net_amount":4500,"shipping_cost":null,"amount_capturable":4500,"amount_received":null,"connector":"adyen","client_secret":"pay_8P2b5MuSkplj8d3U06Nj_secret_px8ZGtda34okt5ngtFdb","created":"2025-07-22T14:57:52.108Z","currency":"BRL","customer_id":"cus_HXi1vEcMXQ74qsaNq57p","customer":{"id":"cus_HXi1vEcMXQ74qsaNq57p","name":"John Nether","email":"[email protected]","phone":"6168205362","phone_country_code":"+1"},"description":null,"refunds":null,"disputes":null,"mandate_id":null,"mandate_data":null,"setup_future_usage":null,"off_session":null,"capture_on":null,"capture_method":null,"payment_method":"bank_transfer","payment_method_data":{"bank_transfer":{"pix":{"pix_key":"test","cpf":"test","cnpj":"test","source_bank_account_id":null,"destination_bank_account_id":null,"expiry_date":"2025-07-22T14:58:00.000Z"}},"billing":null},"payment_token":null,"shipping":null,"billing":{"address":{"city":"San Fransico","country":"BR","line1":"1467","line2":"Harrison Street","line3":"Harrison Street","zip":"94122","state":"California","first_name":"joseph","last_name":"Doe"},"phone":{"number":"8056594427","country_code":"+91"},"email":"[email protected]"},"order_details":null,"email":"[email protected]","name":"John Nether","phone":"6168205362","return_url":"https://google.com/","authentication_type":"no_three_ds","statement_descriptor_name":null,"statement_descriptor_suffix":null,"next_action":{"type":"qr_code_information","image_data_url":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAQgAAAEICAAAAACGnTUjAAAGJElEQVR4Ae3gAZAkSZIkSRKLqpm7R0REZmZmVlVVVVV3d3d3d/fMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMdHd3d3dXV1VVVVVmZkZGRIS7m5kKz0xmV3d1d3dPz8zMzMxMYjVXAVSuAqByFQCVqwCoXAVA5SoAKlcBULkKgMpVAFSuAqByFQCVqwCoXAVA5SoAKlcBULkKgMpVAFSuAqByFQCVqwCoXAVA5SoAKlcBULkKgMpVAFSuAqByFQCVqwCoXAVA5SoAKlcBULkKgMq/QPzbmCvEFeY5iedkrhDPn7lC/NuYF4rKVQBUrgKgchUAlasAqFwFQOUqACpXAVB5EZkXjXhO5gpxhXnhzHMSz5950YgXCZWrAKhcBUDlKgAqVwFQuQqAylUAVK4CoPKvJJ4/88KZK8QV5grx/IkrzAsnnj/zr0LlKgAqVwFQuQqAylUAVK4CoHIVAJWrAKj8JxPPn7jCvHDiCvOfispVAFSuAqByFQCVqwCoXAVA5SoAKlcBUPkvZq4Qz5/4b0HlKgAqVwFQuQqAylUAVK4CoHIVAJWrAKj8K5l/H/GcxBXmCvOcxAtn/kNQuQqAylUAVK4CoHIVAJWrAKhcBUDlKgAqLyLx72OuEFeYK8RzEleYF078h6JyFQCVqwCoXAVA5SoAKlcBULkKgMpVAFT+Bea/hrjCvHDmPwWVqwCoXAVA5SoAKlcBULkKgMpVAFSuAqDyLxBXmOdPXGGuEM+fuMK8aMQV5grxojHPSVxhXigqVwFQuQqAylUAVK4CoHIVAJWrAKhcBYDMv494TuYK8fyZK8S/jnn+xBXmOYkrzIuEylUAVK4CoHIVAJWrAKhcBUDlKgAqVwFQ+VcSz5+5QlxhrhAvGvOcxBXmhTPPn/lXoXIVAJWrAKhcBUDlKgAqVwFQuQqAylUAVP4F4oUzV4grzPNnXjTiCvPCiSvMcxJXmH8VKlcBULkKgMpVAFSuAqByFQCVqwCoXAWAzAsnrjBXiBeNeU7iOZnnJJ4/c4V4/swV4oUzLxSVqwCoXAVA5SoAKlcBULkKgMpVAFSuAqDyIhJXmOdPXGGuEFeYF05cYZ6TuEJcYa4QV5grxHMy/yZUrgKgchUAlasAqFwFQOUqACpXAVC5CgCZfxtxhXlO4grznMQV5grxr2Oek3jhzL8KlasAqFwFQOUqACpXAVC5CoDKVQBUrgKg8m9krhDPyTwncYV5/swV4gpzhbjCvGjMFeIKcYV5kVC5CoDKVQBUrgKgchUAlasAqFwFQOUqAGReOPH8medPPCfznMQV5grxnMxzEv865grxnMwLReUqACpXAVC5CoDKVQBUrgKgchUAlasAkPnPJa4wL5x44czzJ64wz0k8J/NCUbkKgMpVAFSuAqByFQCVqwCoXAVA5SoAKv8C8W9j/nXMcxLPn7jCPH/iCvOvQuUqACpXAVC5CoDKVQBUrgKgchUAlasAqLyIzItGPCdzhbjCPCdxhblCXGGuEM/JvGjEczIvFJWrAKhcBUDlKgAqVwFQuQqAylUAVK4CoPKvJJ4/8/yJK8wV4jmZK8QLJ144cYV5TuJFQuUqACpXAVC5CoDKVQBUrgKgchUAlasAqPwnM1eI52SuEFeYfxvz/Il/FSpXAVC5CoDKVQBUrgKgchUAlasAqFwFQOW/iXhO4jmZ589cIZ6TuMI8J/MioXIVAJWrAKhcBUDlKgAqVwFQuQqAylUAVP6VzL+NeU7iCnOFuMI8f+YK8ZzEFeYK8W9C5SoAKlcBULkKgMpVAFSuAqByFQCVqwCovIjEv424wlwhrjBXiOdPXGGuEC8ac4W4QlxhXigqVwFQuQqAylUAVK4CoHIVAJWrAKhcBYDMVQCVqwCoXAVA5SoAKlcBULkKgMpVAFSuAqByFQCVqwCoXAVA5SoAKlcBULkKgMpVAFSuAqByFQCVqwCoXAVA5SoAKlcBULkKgMpVAFSuAqByFQCVqwCoXAVA5SoAKlcBULkKgMpVAFSuAuAfAfHRhAhvVmeEAAAAAElFTkSuQmCC","display_to_timestamp":1753196280000,"qr_code_url":"https://test.adyen.com/hpp/generateQRCodeImage.shtml?url=TestQRCodeEMVToken","display_text":null,"border_color":null},"cancellation_reason":null,"error_code":null,"error_message":null,"unified_code":null,"unified_message":null,"payment_experience":null,"payment_method_type":"pix","connector_label":null,"business_country":null,"business_label":"default","business_sub_label":null,"allowed_payment_method_types":null,"ephemeral_key":{"customer_id":"cus_HXi1vEcMXQ74qsaNq57p","created_at":1753196272,"expires":1753199872,"secret":"epk_7b539192a86b4d3baf83c0dcc93da9a6"},"manual_retry_allowed":null,"connector_transaction_id":"BGC4GRDTH5V3NDV5","frm_message":null,"metadata":{"udf1":"value1","Force-PSP":"Adyen","login_date":"2019-09-10T10:11:12Z","new_customer":"true"},"connector_metadata":null,"feature_metadata":null,"reference_id":"BGC4GRDTH5V3NDV5","payment_link":null,"profile_id":"pro_HvmsPUKxoCtI58mtCUhg","surcharge_details":null,"attempt_count":1,"merchant_decision":null,"merchant_connector_id":"mca_c5mj7ZUwHtsNKo5EfexQ","incremental_authorization_allowed":null,"authorization_count":null,"incremental_authorizations":null,"external_authentication_details":null,"external_3ds_authentication_attempted":false,"expires_on":"2025-07-22T14:58:52.108Z","fingerprint":null,"browser_info":{"language":"en-US","time_zone":-330,"ip_address":"127.0.0.1","user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36","color_depth":32,"java_enabled":true,"screen_width":1728,"accept_header":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8","screen_height":1117,"java_script_enabled":true},"payment_method_id":null,"payment_method_status":null,"updated":"2025-07-22T14:57:53.084Z","split_payments":null,"frm_metadata":null,"extended_authorization_applied":null,"capture_before":null,"merchant_order_reference_id":null,"order_tax_amount":null,"connector_mandate_id":null,"card_discovery":null,"force_3ds_challenge":false,"force_3ds_challenge_trigger":false,"issuer_error_code":null,"issuer_error_message":null,"is_iframe_redirection_enabled":null,"whole_connector_response":null} Wait for it to expire Receive incoming webhooks for OFFER_CLOSED </details> <details> <summary>2. Verify outgoing webhook</summary> {"merchant_id":"merchant_1753397156","event_id":"evt_019841219a907f8084065fb9d9e2842e","event_type":"payment_expired","content":{"type":"payment_details","object":{"payment_id":"pay_GE6MyVzON0EXIcyOFh5p","merchant_id":"merchant_1753397156","status":"expired","amount":4500,"net_amount":4500,"shipping_cost":null,"amount_capturable":0,"amount_received":null,"connector":"adyen","client_secret":"pay_GE6MyVzON0EXIcyOFh5p_secret_44s26p5R8wAp9cXOQ3Qt","created":"2025-07-25T10:26:23.600Z","currency":"BRL","customer_id":"cus_J2NWO1RbnwNdiEO6KdIt","customer":{"id":"cus_J2NWO1RbnwNdiEO6KdIt","name":null,"email":"[email protected]","phone":null,"phone_country_code":null},"description":null,"refunds":null,"disputes":null,"mandate_id":null,"mandate_data":null,"setup_future_usage":null,"off_session":null,"capture_on":null,"capture_method":null,"payment_method":"bank_transfer","payment_method_data":{"bank_transfer":{"pix":{"pix_key":"test","cpf":"test","cnpj":"test","source_bank_account_id":null,"destination_bank_account_id":null,"expiry_date":"2025-07-25T10:28:00.000Z"}},"billing":null},"payment_token":null,"shipping":null,"billing":{"address":{"city":"San Fransico","country":"BR","line1":"1467","line2":"Harrison Street","line3":"Harrison Street","zip":"94122","state":"California","first_name":"joseph","last_name":"Doe"},"phone":{"number":"8056594427","country_code":"+91"},"email":"[email protected]"},"order_details":null,"email":"[email protected]","name":null,"phone":null,"return_url":"https://google.com/","authentication_type":"no_three_ds","statement_descriptor_name":null,"statement_descriptor_suffix":null,"next_action":null,"cancellation_reason":null,"error_code":null,"error_message":null,"unified_code":null,"unified_message":null,"payment_experience":null,"payment_method_type":"pix","connector_label":null,"business_country":null,"business_label":"default","business_sub_label":null,"allowed_payment_method_types":null,"ephemeral_key":null,"manual_retry_allowed":false,"connector_transaction_id":"BXSX5X9VLW5PB2V5","frm_message":null,"metadata":{"udf1":"value1","Force-PSP":"Adyen","login_date":"2019-09-10T10:11:12Z","new_customer":"true"},"connector_metadata":null,"feature_metadata":null,"reference_id":"pay_GE6MyVzON0EXIcyOFh5p_1","payment_link":null,"profile_id":"pro_zJpGj6xSodQqoBYltbzl","surcharge_details":null,"attempt_count":1,"merchant_decision":null,"merchant_connector_id":"mca_PTFqfuKnofhHIFDFLBsu","incremental_authorization_allowed":null,"authorization_count":null,"incremental_authorizations":null,"external_authentication_details":null,"external_3ds_authentication_attempted":false,"expires_on":"2025-07-25T10:27:23.600Z","fingerprint":null,"browser_info":{"language":"en-US","time_zone":-330,"ip_address":"127.0.0.1","user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36","color_depth":32,"java_enabled":true,"screen_width":1728,"accept_header":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8","screen_height":1117,"java_script_enabled":true},"payment_method_id":"pm_uHViByM1aRfvzf4cCKYH","payment_method_status":"inactive","updated":"2025-07-25T10:29:38.062Z","split_payments":null,"frm_metadata":null,"extended_authorization_applied":null,"capture_before":null,"merchant_order_reference_id":null,"order_tax_amount":null,"connector_mandate_id":null,"card_discovery":null,"force_3ds_challenge":false,"force_3ds_challenge_trigger":false,"issuer_error_code":null,"issuer_error_message":null,"is_iframe_redirection_enabled":null,"whole_connector_response":null}},"timestamp":"2025-07-25T10:29:38.064Z"} It should have - event_type as payment_expired - status as expired - `next_action` should be null </details> <details> <summary>3. Verify payments retrieve</summary> cURL curl --location --request GET 'http://localhost:8080/payments/pay_8P2b5MuSkplj8d3U06Nj?force_sync=true' \ --header 'Accept: application/json' \ --header 'api-key: dev_W8rGDzCct9xjU2Rqd8xxZubP9rRJ4u1Y42J1im7qplUxjOgWmJS4ZPq9lRfvOCnd' Response {"payment_id":"pay_cqxjoA0Drk0NBgmCpbQf","merchant_id":"merchant_1753397156","status":"expired","amount":4500,"net_amount":4500,"shipping_cost":null,"amount_capturable":0,"amount_received":null,"connector":"adyen","client_secret":"pay_cqxjoA0Drk0NBgmCpbQf_secret_S3VytS4Ym1KOhpKRQvtV","created":"2025-07-24T22:51:17.081Z","currency":"BRL","customer_id":"cus_J2NWO1RbnwNdiEO6KdIt","customer":{"id":"cus_J2NWO1RbnwNdiEO6KdIt","name":null,"email":"[email protected]","phone":null,"phone_country_code":null},"description":null,"refunds":null,"disputes":null,"mandate_id":null,"mandate_data":null,"setup_future_usage":null,"off_session":null,"capture_on":null,"capture_method":null,"payment_method":"bank_transfer","payment_method_data":{"bank_transfer":{"pix":{"pix_key":"test","cpf":"test","cnpj":"test","source_bank_account_id":null,"destination_bank_account_id":null,"expiry_date":"2025-07-24T22:54:00.000Z"}},"billing":null},"payment_token":null,"shipping":null,"billing":{"address":{"city":"San Fransico","country":"BR","line1":"1467","line2":"Harrison Street","line3":"Harrison Street","zip":"94122","state":"California","first_name":"joseph","last_name":"Doe"},"phone":{"number":"8056594427","country_code":"+91"},"email":"[email protected]"},"order_details":null,"email":"[email protected]","name":null,"phone":null,"return_url":"https://google.com/","authentication_type":"no_three_ds","statement_descriptor_name":null,"statement_descriptor_suffix":null,"next_action":null,"cancellation_reason":null,"error_code":null,"error_message":null,"unified_code":null,"unified_message":null,"payment_experience":null,"payment_method_type":"pix","connector_label":null,"business_country":null,"business_label":"default","business_sub_label":null,"allowed_payment_method_types":null,"ephemeral_key":null,"manual_retry_allowed":false,"connector_transaction_id":"BD7QBLW3MDSQNS65","frm_message":null,"metadata":{"udf1":"value1","Force-PSP":"Adyen","login_date":"2019-09-10T10:11:12Z","new_customer":"true"},"connector_metadata":null,"feature_metadata":null,"reference_id":"pay_cqxjoA0Drk0NBgmCpbQf_1","payment_link":null,"profile_id":"pro_zJpGj6xSodQqoBYltbzl","surcharge_details":null,"attempt_count":1,"merchant_decision":null,"merchant_connector_id":"mca_PTFqfuKnofhHIFDFLBsu","incremental_authorization_allowed":null,"authorization_count":null,"incremental_authorizations":null,"external_authentication_details":null,"external_3ds_authentication_attempted":false,"expires_on":"2025-07-24T22:52:17.081Z","fingerprint":null,"browser_info":{"language":"en-US","time_zone":-330,"ip_address":"127.0.0.1","user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36","color_depth":32,"java_enabled":true,"screen_width":1728,"accept_header":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8","screen_height":1117,"java_script_enabled":true},"payment_method_id":"pm_EN1YZr7i5sD4qHXH2uV5","payment_method_status":"inactive","updated":"2025-07-24T22:55:13.196Z","split_payments":null,"frm_metadata":null,"extended_authorization_applied":null,"capture_before":null,"merchant_order_reference_id":null,"order_tax_amount":null,"connector_mandate_id":null,"card_discovery":null,"force_3ds_challenge":false,"force_3ds_challenge_trigger":false,"issuer_error_code":null,"issuer_error_message":null,"is_iframe_redirection_enabled":null,"whole_connector_response":null} </details> ## Checklist - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code	v1.115.0	f94f39ef0cae800a8ecde21e8d4a95b14c074f88	f94f39ef0cae800a8ecde21e8d4a95b14c074f88
juspay/hyperswitch	juspay__hyperswitch-8634	Bug: [FEATURE] add profile acquirer module ### Feature Description add profile acquirer create API, which allows us to create profile acquirer with the following fields - profile_id - acquirer_assigned_merchant_id - merchant_name - merchant_country_code - network - acquirer_bin - acquirer_ica - acquirer_fraud_rate Acquirer details are stored in profile as a array of JSON object, and then to retrieve list of profile acquirers we can retrieve Business Profile ### Possible Implementation add profile acquirer create api - POST `{{BASE_URL}}/profile_acquirer`, which accepts the acquirer details and stores it in profile table as JSONB (List of acquirers can be a added to a profile). retrieve business profile can be used to get the list of available profile acquirers. ProfileAcquirerId id_type can be used as unique identifier for each of the created record.	diff --git a/api-reference/openapi_spec.json b/api-reference/openapi_spec.json index 525f65ea72c..743ddf82541 100644 --- a/api-reference/openapi_spec.json +++ b/api-reference/openapi_spec.json @@ -5957,6 +5957,46 @@ ] } }, + "/profile_acquirers": { + "post": { + "tags": [ + "Profile Acquirer" + ], + "summary": "Profile Acquirer - Create", + "description": "Create a new Profile Acquirer for accessing our APIs from your servers.", + "operationId": "Create a Profile Acquirer", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProfileAcquirerCreate" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Profile Acquirer created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProfileAcquirerResponse" + } + } + } + }, + "400": { + "description": "Invalid data" + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, "/three_ds_decision/execute": { "post": { "tags": [ @@ -6307,6 +6347,63 @@ } } }, + "AcquirerConfig": { + "type": "object", + "description": "Acquirer configuration", + "required": [ + "acquirer_assigned_merchant_id", + "merchant_name", + "merchant_country_code", + "network", + "acquirer_bin", + "acquirer_fraud_rate" + ], + "properties": { + "acquirer_assigned_merchant_id": { + "type": "string", + "description": "The merchant id assigned by the acquirer", + "example": "M123456789" + }, + "merchant_name": { + "type": "string", + "description": "merchant name", + "example": "NewAge Retailer" + }, + "merchant_country_code": { + "type": "string", + "description": "Merchant country code assigned by acquirer", + "example": "US" + }, + "network": { + "type": "string", + "description": "Network provider", + "example": "VISA" + }, + "acquirer_bin": { + "type": "string", + "description": "Acquirer bin", + "example": "456789" + }, + "acquirer_ica": { + "type": "string", + "description": "Acquirer ica provided by acquirer", + "example": "401288", + "nullable": true + }, + "acquirer_fraud_rate": { + "type": "string", + "description": "Fraud rate for the particular acquirer configuration", + "example": "0.01" + } + } + }, + "AcquirerConfigMap": { + "type": "object", + "description": "Acquirer configs", + "additionalProperties": { + "$ref": "#/components/schemas/AcquirerConfig" + } + }, "AcquirerData": { "type": "object", "description": "Represents data about the acquirer used in the 3DS decision rule.", @@ -25296,6 +25393,124 @@ "accommodation" ] }, + "ProfileAcquirerCreate": { + "type": "object", + "required": [ + "acquirer_assigned_merchant_id", + "merchant_name", + "merchant_country_code", + "network", + "acquirer_bin", + "acquirer_fraud_rate", + "profile_id" + ], + "properties": { + "acquirer_assigned_merchant_id": { + "type": "string", + "description": "The merchant id assigned by the acquirer", + "example": "M123456789" + }, + "merchant_name": { + "type": "string", + "description": "merchant name", + "example": "NewAge Retailer" + }, + "merchant_country_code": { + "type": "string", + "description": "Merchant country code assigned by acquirer", + "example": "US" + }, + "network": { + "type": "string", + "description": "Network provider", + "example": "VISA" + }, + "acquirer_bin": { + "type": "string", + "description": "Acquirer bin", + "example": "456789" + }, + "acquirer_ica": { + "type": "string", + "description": "Acquirer ica provided by acquirer", + "example": "401288", + "nullable": true + }, + "acquirer_fraud_rate": { + "type": "number", + "format": "double", + "description": "Fraud rate for the particular acquirer configuration", + "example": 0.01 + }, + "profile_id": { + "type": "string", + "description": "Parent profile id to link the acquirer account with", + "example": "pro_ky0yNyOXXlA5hF8JzE5q" + } + } + }, + "ProfileAcquirerResponse": { + "type": "object", + "required": [ + "profile_acquirer_id", + "acquirer_assigned_merchant_id", + "merchant_name", + "merchant_country_code", + "network", + "acquirer_bin", + "acquirer_fraud_rate", + "profile_id" + ], + "properties": { + "profile_acquirer_id": { + "type": "string", + "description": "The unique identifier of the profile acquirer", + "example": "pro_acq_LCRdERuylQvNQ4qh3QE0" + }, + "acquirer_assigned_merchant_id": { + "type": "string", + "description": "The merchant id assigned by the acquirer", + "example": "M123456789" + }, + "merchant_name": { + "type": "string", + "description": "Merchant name", + "example": "NewAge Retailer" + }, + "merchant_country_code": { + "type": "string", + "description": "Merchant country code assigned by acquirer", + "example": "US" + }, + "network": { + "type": "string", + "description": "Network provider", + "example": "VISA" + }, + "acquirer_bin": { + "type": "string", + "description": "Acquirer bin", + "example": "456789" + }, + "acquirer_ica": { + "type": "string", + "description": "Acquirer ica provided by acquirer", + "example": "401288", + "nullable": true + }, + "acquirer_fraud_rate": { + "type": "number", + "format": "double", + "description": "Fraud rate for the particular acquirer configuration", + "example": 0.01 + }, + "profile_id": { + "type": "string", + "description": "Parent profile id to link the acquirer account with", + "example": "pro_ky0yNyOXXlA5hF8JzE5q" + } + } + }, "ProfileCreate": { "type": "object", "properties": { @@ -25818,6 +26033,14 @@ "default": false, "example": false }, + "acquirer_configs": { + "allOf": [ + { + "$ref": "#/components/schemas/AcquirerConfigMap" + } + ], + "nullable": true + }, "is_iframe_redirection_enabled": { "type": "boolean", "description": "Indicates if the redirection has to open in the iframe", diff --git a/crates/api_models/src/admin.rs b/crates/api_models/src/admin.rs index 5ab7eae75f0..07f3e2431fa 100644 --- a/crates/api_models/src/admin.rs +++ b/crates/api_models/src/admin.rs @@ -2427,6 +2427,10 @@ pub struct ProfileResponse { #[schema(default = false, example = false)] pub is_pre_network_tokenization_enabled: bool, + /// Acquirer configs + #[schema(value_type = Option<AcquirerConfigMap>)] + pub acquirer_configs: Option<common_types::domain::AcquirerConfigMap>, + /// Indicates if the redirection has to open in the iframe #[schema(example = false)] pub is_iframe_redirection_enabled: Option<bool>, diff --git a/crates/api_models/src/lib.rs b/crates/api_models/src/lib.rs index a2258e4bd5c..5fdb56e6966 100644 --- a/crates/api_models/src/lib.rs +++ b/crates/api_models/src/lib.rs @@ -32,6 +32,7 @@ pub mod payouts; pub mod pm_auth; pub mod poll; pub mod process_tracker; +pub mod profile_acquirer; #[cfg(all(feature = "v2", feature = "payment_methods_v2"))] pub mod proxy; #[cfg(feature = "recon")] diff --git a/crates/api_models/src/profile_acquirer.rs b/crates/api_models/src/profile_acquirer.rs new file mode 100644 index 00000000000..86f36db104a --- /dev/null +++ b/crates/api_models/src/profile_acquirer.rs @@ -0,0 +1,66 @@ +use serde::{Deserialize, Serialize}; +use utoipa::ToSchema; + +use crate::enums; + +#[derive(Debug, Serialize, Deserialize, ToSchema)] +pub struct ProfileAcquirerCreate { + /// The merchant id assigned by the acquirer + #[schema(value_type= String,example = "M123456789")] + pub acquirer_assigned_merchant_id: String, + /// merchant name + #[schema(value_type= String,example = "NewAge Retailer")] + pub merchant_name: String, + /// Merchant country code assigned by acquirer + #[schema(value_type= String,example = "US")] + pub merchant_country_code: enums::CountryAlpha2, + /// Network provider + #[schema(value_type= String,example = "VISA")] + pub network: common_enums::enums::CardNetwork, + /// Acquirer bin + #[schema(value_type= String,example = "456789")] + pub acquirer_bin: String, + /// Acquirer ica provided by acquirer + #[schema(value_type= Option<String>,example = "401288")] + pub acquirer_ica: Option<String>, + /// Fraud rate for the particular acquirer configuration + #[schema(value_type= f64,example = 0.01)] + pub acquirer_fraud_rate: f64, + /// Parent profile id to link the acquirer account with + #[schema(value_type= String,example = "pro_ky0yNyOXXlA5hF8JzE5q")] + pub profile_id: common_utils::id_type::ProfileId, +} + +#[derive(Debug, Serialize, Deserialize, ToSchema)] +pub struct ProfileAcquirerResponse { + /// The unique identifier of the profile acquirer + #[schema(value_type= String,example = "pro_acq_LCRdERuylQvNQ4qh3QE0")] + pub profile_acquirer_id: common_utils::id_type::ProfileAcquirerId, + /// The merchant id assigned by the acquirer + #[schema(value_type= String,example = "M123456789")] + pub acquirer_assigned_merchant_id: String, + /// Merchant name + #[schema(value_type= String,example = "NewAge Retailer")] + pub merchant_name: String, + /// Merchant country code assigned by acquirer + #[schema(value_type= String,example = "US")] + pub merchant_country_code: enums::CountryAlpha2, + /// Network provider + #[schema(value_type= String,example = "VISA")] + pub network: common_enums::enums::CardNetwork, + /// Acquirer bin + #[schema(value_type= String,example = "456789")] + pub acquirer_bin: String, + /// Acquirer ica provided by acquirer + #[schema(value_type= Option<String>,example = "401288")] + pub acquirer_ica: Option<String>, + /// Fraud rate for the particular acquirer configuration + #[schema(value_type= f64,example = 0.01)] + pub acquirer_fraud_rate: f64, + /// Parent profile id to link the acquirer account with + #[schema(value_type= String,example = "pro_ky0yNyOXXlA5hF8JzE5q")] + pub profile_id: common_utils::id_type::ProfileId, +} + +impl common_utils::events::ApiEventMetric for ProfileAcquirerCreate {} +impl common_utils::events::ApiEventMetric for ProfileAcquirerResponse {} diff --git a/crates/common_types/src/domain.rs b/crates/common_types/src/domain.rs index 0361f5b0e46..ca6a59abd6a 100644 --- a/crates/common_types/src/domain.rs +++ b/crates/common_types/src/domain.rs @@ -1,5 +1,7 @@ //! Common types +use std::collections::HashMap; + use common_enums::enums; use common_utils::{impl_to_sql_from_sql_json, types::MinorUnit}; use diesel::{sql_types::Jsonb, AsExpression, FromSqlRow}; @@ -53,3 +55,36 @@ pub struct XenditSplitSubMerchantData { pub for_user_id: String, } impl_to_sql_from_sql_json!(XenditSplitSubMerchantData); + +/// Acquirer configuration +#[derive(Clone, Debug, Deserialize, ToSchema, Serialize, PartialEq)] +pub struct AcquirerConfig { + /// The merchant id assigned by the acquirer + #[schema(value_type= String,example = "M123456789")] + pub acquirer_assigned_merchant_id: String, + /// merchant name + #[schema(value_type= String,example = "NewAge Retailer")] + pub merchant_name: String, + /// Merchant country code assigned by acquirer + #[schema(value_type= String,example = "US")] + pub merchant_country_code: common_enums::CountryAlpha2, + /// Network provider + #[schema(value_type= String,example = "VISA")] + pub network: common_enums::CardNetwork, + /// Acquirer bin + #[schema(value_type= String,example = "456789")] + pub acquirer_bin: String, + /// Acquirer ica provided by acquirer + #[schema(value_type= Option<String>,example = "401288")] + pub acquirer_ica: Option<String>, + /// Fraud rate for the particular acquirer configuration + #[schema(value_type= String,example = "0.01")] + pub acquirer_fraud_rate: f64, +} + +#[derive(Serialize, Deserialize, Debug, Clone, FromSqlRow, AsExpression, ToSchema)] +#[diesel(sql_type = Jsonb)] +/// Acquirer configs +pub struct AcquirerConfigMap(pub HashMap<common_utils::id_type::ProfileAcquirerId, AcquirerConfig>); + +impl_to_sql_from_sql_json!(AcquirerConfigMap); diff --git a/crates/common_utils/src/events.rs b/crates/common_utils/src/events.rs index 39a1694a7c1..b06fea4e1ea 100644 --- a/crates/common_utils/src/events.rs +++ b/crates/common_utils/src/events.rs @@ -126,6 +126,9 @@ pub enum ApiEventsType { token_id: Option<id_type::GlobalTokenId>, }, ProcessTracker, + ProfileAcquirer { + profile_acquirer_id: id_type::ProfileAcquirerId, + }, ThreeDsDecisionRule, } diff --git a/crates/common_utils/src/id_type.rs b/crates/common_utils/src/id_type.rs index 34a3844e76b..45b65c9a448 100644 --- a/crates/common_utils/src/id_type.rs +++ b/crates/common_utils/src/id_type.rs @@ -11,6 +11,7 @@ mod merchant_connector_account; mod organization; mod payment; mod profile; +mod profile_acquirer; mod refunds; mod relay; mod routing; @@ -46,6 +47,7 @@ pub use self::{ organization::OrganizationId, payment::{PaymentId, PaymentReferenceId}, profile::ProfileId, + profile_acquirer::ProfileAcquirerId, refunds::RefundReferenceId, relay::RelayId, routing::RoutingId, diff --git a/crates/common_utils/src/id_type/profile_acquirer.rs b/crates/common_utils/src/id_type/profile_acquirer.rs new file mode 100644 index 00000000000..ac5f09646bc --- /dev/null +++ b/crates/common_utils/src/id_type/profile_acquirer.rs @@ -0,0 +1,41 @@ +use std::str::FromStr; + +crate::id_type!( + ProfileAcquirerId, + "A type for profile_acquirer_id that can be used for profile acquirer ids" +); +crate::impl_id_type_methods!(ProfileAcquirerId, "profile_acquirer_id"); + +// This is to display the `ProfileAcquirerId` as ProfileAcquirerId(abcd) +crate::impl_debug_id_type!(ProfileAcquirerId); +crate::impl_try_from_cow_str_id_type!(ProfileAcquirerId, "profile_acquirer_id"); + +crate::impl_generate_id_id_type!(ProfileAcquirerId, "pro_acq"); +crate::impl_serializable_secret_id_type!(ProfileAcquirerId); +crate::impl_queryable_id_type!(ProfileAcquirerId); +crate::impl_to_sql_from_sql_id_type!(ProfileAcquirerId); + +impl crate::events::ApiEventMetric for ProfileAcquirerId { + fn get_api_event_type(&self) -> Option<crate::events::ApiEventsType> { + Some(crate::events::ApiEventsType::ProfileAcquirer { + profile_acquirer_id: self.clone(), + }) + } +} + +impl FromStr for ProfileAcquirerId { + type Err = error_stack::Report<crate::errors::ValidationError>; + + fn from_str(s: &str) -> Result<Self, Self::Err> { + let cow_string = std::borrow::Cow::Owned(s.to_string()); + Self::try_from(cow_string) + } +} + +// This is implemented so that we can use profile acquirer id directly as attribute in metrics +#[cfg(feature = "metrics")] +impl From<ProfileAcquirerId> for router_env::opentelemetry::Value { + fn from(val: ProfileAcquirerId) -> Self { + Self::from(val.0 .0 .0) + } +} diff --git a/crates/common_utils/src/lib.rs b/crates/common_utils/src/lib.rs index 759329ba327..3f491d3e9a6 100644 --- a/crates/common_utils/src/lib.rs +++ b/crates/common_utils/src/lib.rs @@ -253,6 +253,13 @@ pub fn generate_merchant_connector_account_id_of_default_length( id_type::MerchantConnectorAccountId::generate() } +/// Generate a profile_acquirer id with default length, with prefix as `mer_acq` +pub fn generate_profile_acquirer_id_of_default_length() -> id_type::ProfileAcquirerId { + use id_type::GenerateId; + + id_type::ProfileAcquirerId::generate() +} + /// Generate a nanoid with the given prefix and a default length #[inline] pub fn generate_id_with_default_len(prefix: &str) -> String { diff --git a/crates/diesel_models/src/business_profile.rs b/crates/diesel_models/src/business_profile.rs index 848f673f502..a93bab30a49 100644 --- a/crates/diesel_models/src/business_profile.rs +++ b/crates/diesel_models/src/business_profile.rs @@ -74,6 +74,7 @@ pub struct Profile { pub is_iframe_redirection_enabled: Option<bool>, pub is_pre_network_tokenization_enabled: Option<bool>, pub three_ds_decision_rule_algorithm: Option<serde_json::Value>, + pub acquirer_config_map: Option<common_types::domain::AcquirerConfigMap>, } #[cfg(feature = "v1")] @@ -183,6 +184,7 @@ pub struct ProfileUpdateInternal { pub is_iframe_redirection_enabled: Option<bool>, pub is_pre_network_tokenization_enabled: Option<bool>, pub three_ds_decision_rule_algorithm: Option<serde_json::Value>, + pub acquirer_config_map: Option<common_types::domain::AcquirerConfigMap>, } #[cfg(feature = "v1")] @@ -234,6 +236,7 @@ impl ProfileUpdateInternal { is_iframe_redirection_enabled, is_pre_network_tokenization_enabled, three_ds_decision_rule_algorithm, + acquirer_config_map, } = self; Profile { profile_id: source.profile_id, @@ -316,6 +319,7 @@ impl ProfileUpdateInternal { .or(source.is_pre_network_tokenization_enabled), three_ds_decision_rule_algorithm: three_ds_decision_rule_algorithm .or(source.three_ds_decision_rule_algorithm), + acquirer_config_map: acquirer_config_map.or(source.acquirer_config_map), } } } @@ -376,6 +380,7 @@ pub struct Profile { pub id: common_utils::id_type::ProfileId, pub is_iframe_redirection_enabled: Option<bool>, pub three_ds_decision_rule_algorithm: Option<serde_json::Value>, + pub acquirer_config_map: Option<common_types::domain::AcquirerConfigMap>, pub routing_algorithm_id: Option<common_utils::id_type::RoutingId>, pub order_fulfillment_time: Option<i64>, pub order_fulfillment_time_origin: Option<common_enums::OrderFulfillmentTimeOrigin>, @@ -665,6 +670,7 @@ impl ProfileUpdateInternal { external_vault_connector_details: external_vault_connector_details .or(source.external_vault_connector_details), three_ds_decision_rule_algorithm: None, + acquirer_config_map: None, } } } diff --git a/crates/diesel_models/src/schema.rs b/crates/diesel_models/src/schema.rs index 388fcc23759..4e93ecab944 100644 --- a/crates/diesel_models/src/schema.rs +++ b/crates/diesel_models/src/schema.rs @@ -228,6 +228,7 @@ diesel::table! { is_iframe_redirection_enabled -> Nullable<Bool>, is_pre_network_tokenization_enabled -> Nullable<Bool>, three_ds_decision_rule_algorithm -> Nullable<Jsonb>, + acquirer_config_map -> Nullable<Jsonb>, } } diff --git a/crates/diesel_models/src/schema_v2.rs b/crates/diesel_models/src/schema_v2.rs index 5b1201027b7..0c6bdadac84 100644 --- a/crates/diesel_models/src/schema_v2.rs +++ b/crates/diesel_models/src/schema_v2.rs @@ -223,6 +223,7 @@ diesel::table! { id -> Varchar, is_iframe_redirection_enabled -> Nullable<Bool>, three_ds_decision_rule_algorithm -> Nullable<Jsonb>, + acquirer_config_map -> Nullable<Jsonb>, #[max_length = 64] routing_algorithm_id -> Nullable<Varchar>, order_fulfillment_time -> Nullable<Int8>, diff --git a/crates/hyperswitch_domain_models/src/business_profile.rs b/crates/hyperswitch_domain_models/src/business_profile.rs index 80070aa9e50..6c95af4f149 100644 --- a/crates/hyperswitch_domain_models/src/business_profile.rs +++ b/crates/hyperswitch_domain_models/src/business_profile.rs @@ -76,6 +76,7 @@ pub struct Profile { pub is_iframe_redirection_enabled: Option<bool>, pub is_pre_network_tokenization_enabled: bool, pub three_ds_decision_rule_algorithm: Option<serde_json::Value>, + pub acquirer_config_map: Option<common_types::domain::AcquirerConfigMap>, } #[cfg(feature = "v1")] @@ -188,6 +189,7 @@ impl From<ProfileSetter> for Profile { is_iframe_redirection_enabled: value.is_iframe_redirection_enabled, is_pre_network_tokenization_enabled: value.is_pre_network_tokenization_enabled, three_ds_decision_rule_algorithm: None, // three_ds_decision_rule_algorithm is not yet created during profile creation + acquirer_config_map: None, } } } @@ -274,6 +276,9 @@ pub enum ProfileUpdate { CardTestingSecretKeyUpdate { card_testing_secret_key: OptionalEncryptableName, }, + AcquirerConfigMapUpdate { + acquirer_config_map: Option<common_types::domain::AcquirerConfigMap>, + }, } #[cfg(feature = "v1")] @@ -373,6 +378,7 @@ impl From<ProfileUpdate> for ProfileUpdateInternal { is_iframe_redirection_enabled, is_pre_network_tokenization_enabled, three_ds_decision_rule_algorithm: None, + acquirer_config_map: None, } } ProfileUpdate::RoutingAlgorithmUpdate { @@ -425,6 +431,7 @@ impl From<ProfileUpdate> for ProfileUpdateInternal { is_iframe_redirection_enabled: None, is_pre_network_tokenization_enabled: None, three_ds_decision_rule_algorithm, + acquirer_config_map: None, }, ProfileUpdate::DynamicRoutingAlgorithmUpdate { dynamic_routing_algorithm, @@ -474,6 +481,7 @@ impl From<ProfileUpdate> for ProfileUpdateInternal { is_iframe_redirection_enabled: None, is_pre_network_tokenization_enabled: None, three_ds_decision_rule_algorithm: None, + acquirer_config_map: None, }, ProfileUpdate::ExtendedCardInfoUpdate { is_extended_card_info_enabled, @@ -523,6 +531,7 @@ impl From<ProfileUpdate> for ProfileUpdateInternal { is_iframe_redirection_enabled: None, is_pre_network_tokenization_enabled: None, three_ds_decision_rule_algorithm: None, + acquirer_config_map: None, }, ProfileUpdate::ConnectorAgnosticMitUpdate { is_connector_agnostic_mit_enabled, @@ -572,6 +581,7 @@ impl From<ProfileUpdate> for ProfileUpdateInternal { is_iframe_redirection_enabled: None, is_pre_network_tokenization_enabled: None, three_ds_decision_rule_algorithm: None, + acquirer_config_map: None, }, ProfileUpdate::NetworkTokenizationUpdate { is_network_tokenization_enabled, @@ -621,6 +631,7 @@ impl From<ProfileUpdate> for ProfileUpdateInternal { is_iframe_redirection_enabled: None, is_pre_network_tokenization_enabled: None, three_ds_decision_rule_algorithm: None, + acquirer_config_map: None, }, ProfileUpdate::CardTestingSecretKeyUpdate { card_testing_secret_key, @@ -670,6 +681,57 @@ impl From<ProfileUpdate> for ProfileUpdateInternal { is_iframe_redirection_enabled: None, is_pre_network_tokenization_enabled: None, three_ds_decision_rule_algorithm: None, + acquirer_config_map: None, + }, + ProfileUpdate::AcquirerConfigMapUpdate { + acquirer_config_map, + } => Self { + profile_name: None, + modified_at: now, + return_url: None, + enable_payment_response_hash: None, + payment_response_hash_key: None, + redirect_to_merchant_with_http_post: None, + webhook_details: None, + metadata: None, + routing_algorithm: None, + intent_fulfillment_time: None, + frm_routing_algorithm: None, + payout_routing_algorithm: None, + is_recon_enabled: None, + applepay_verified_domains: None, + payment_link_config: None, + session_expiry: None, + authentication_connector_details: None, + payout_link_config: None, + is_extended_card_info_enabled: None, + extended_card_info_config: None, + is_connector_agnostic_mit_enabled: None, + use_billing_as_payment_method_billing: None, + collect_shipping_details_from_wallet_connector: None, + collect_billing_details_from_wallet_connector: None, + outgoing_webhook_custom_http_headers: None, + always_collect_billing_details_from_wallet_connector: None, + always_collect_shipping_details_from_wallet_connector: None, + tax_connector_id: None, + is_tax_connector_enabled: None, + dynamic_routing_algorithm: None, + is_network_tokenization_enabled: None, + is_auto_retries_enabled: None, + max_auto_retries_enabled: None, + always_request_extended_authorization: None, + is_click_to_pay_enabled: None, + authentication_product_ids: None, + card_testing_guard_config: None, + card_testing_secret_key: None, + is_clear_pan_retries_enabled: None, + force_3ds_challenge: None, + is_debit_routing_enabled: None, + merchant_business_country: None, + is_iframe_redirection_enabled: None, + is_pre_network_tokenization_enabled: None, + three_ds_decision_rule_algorithm: None, + acquirer_config_map, }, } } @@ -739,6 +801,7 @@ impl super::behaviour::Conversion for Profile { is_iframe_redirection_enabled: self.is_iframe_redirection_enabled, is_pre_network_tokenization_enabled: Some(self.is_pre_network_tokenization_enabled), three_ds_decision_rule_algorithm: self.three_ds_decision_rule_algorithm, + acquirer_config_map: self.acquirer_config_map, }) } @@ -834,6 +897,7 @@ impl super::behaviour::Conversion for Profile { .is_pre_network_tokenization_enabled .unwrap_or(false), three_ds_decision_rule_algorithm: item.three_ds_decision_rule_algorithm, + acquirer_config_map: item.acquirer_config_map, }) } .await @@ -1825,6 +1889,7 @@ impl super::behaviour::Conversion for Profile { is_external_vault_enabled: self.is_external_vault_enabled, external_vault_connector_details: self.external_vault_connector_details, three_ds_decision_rule_algorithm: None, + acquirer_config_map: None, }) } diff --git a/crates/openapi/src/openapi.rs b/crates/openapi/src/openapi.rs index d0585fd98cc..4f8b96d5fbe 100644 --- a/crates/openapi/src/openapi.rs +++ b/crates/openapi/src/openapi.rs @@ -203,6 +203,9 @@ Never share your secret api keys. Keep them guarded and secure. // Routes for poll apis routes::poll::retrieve_poll_status, + // Routes for profile acquirer account + routes::profile_acquirer::profile_acquirer_create, + // Routes for 3DS Decision Rule routes::three_ds_decision_rule::three_ds_decision_rule_execute, ), @@ -274,6 +277,8 @@ Never share your secret api keys. Keep them guarded and secure. api_models::payment_methods::PaymentMethodResponse, api_models::payment_methods::CustomerPaymentMethod, common_types::three_ds_decision_rule_engine::ThreeDSDecisionRule, + common_types::domain::AcquirerConfigMap, + common_types::domain::AcquirerConfig, api_models::payment_methods::PaymentMethodListResponse, api_models::payment_methods::ResponsePaymentMethodsEnabled, api_models::payment_methods::ResponsePaymentMethodTypes, @@ -773,6 +778,8 @@ Never share your secret api keys. Keep them guarded and secure. api_models::open_router::DecisionEngineGatewayWiseExtraScore, api_models::open_router::DecisionEngineSRSubLevelInputConfig, api_models::open_router::DecisionEngineEliminationData, + api_models::profile_acquirer::ProfileAcquirerCreate, + api_models::profile_acquirer::ProfileAcquirerResponse, euclid::frontend::dir::enums::CustomerDevicePlatform, euclid::frontend::dir::enums::CustomerDeviceType, euclid::frontend::dir::enums::CustomerDeviceDisplaySize, diff --git a/crates/openapi/src/routes.rs b/crates/openapi/src/routes.rs index 23d9a79a4de..c91dd74f0fe 100644 --- a/crates/openapi/src/routes.rs +++ b/crates/openapi/src/routes.rs @@ -15,6 +15,7 @@ pub mod payments; pub mod payouts; pub mod poll; pub mod profile; +pub mod profile_acquirer; pub mod proxy; pub mod refunds; pub mod relay; diff --git a/crates/openapi/src/routes/profile_acquirer.rs b/crates/openapi/src/routes/profile_acquirer.rs new file mode 100644 index 00000000000..2c3467aeb63 --- /dev/null +++ b/crates/openapi/src/routes/profile_acquirer.rs @@ -0,0 +1,18 @@ +#[cfg(feature = "v1")] +/// Profile Acquirer - Create +/// +/// Create a new Profile Acquirer for accessing our APIs from your servers. +#[utoipa::path( + post, + path = "/profile_acquirers", + request_body = ProfileAcquirerCreate, + responses( + (status = 200, description = "Profile Acquirer created", body = ProfileAcquirerResponse), + (status = 400, description = "Invalid data") + ), + tag = "Profile Acquirer", + operation_id = "Create a Profile Acquirer", + security(("api_key" = [])) +)] +pub async fn profile_acquirer_create() { /* … */ +} diff --git a/crates/router/src/core.rs b/crates/router/src/core.rs index e5e97b5dc0b..a46f9742798 100644 --- a/crates/router/src/core.rs +++ b/crates/router/src/core.rs @@ -61,6 +61,7 @@ pub mod verification; pub mod verify_connector; pub mod webhooks; +pub mod profile_acquirer; pub mod unified_authentication_service; #[cfg(all(feature = "v2", feature = "payment_methods_v2"))] diff --git a/crates/router/src/core/payouts.rs b/crates/router/src/core/payouts.rs index ebc462d286d..04b3e05d1e9 100644 --- a/crates/router/src/core/payouts.rs +++ b/crates/router/src/core/payouts.rs @@ -372,13 +372,13 @@ pub async fn payouts_confirm_core( merchant_context: domain::MerchantContext, req: payouts::PayoutCreateRequest, ) -> RouterResponse<payouts::PayoutCreateResponse> { - let mut payout_data = make_payout_data( + let mut payout_data = Box::pin(make_payout_data( &state, &merchant_context, None, &payouts::PayoutRequest::PayoutCreateRequest(Box::new(req.to_owned())), &state.locale, - ) + )) .await?; let payout_attempt = payout_data.payout_attempt.to_owned(); let status = payout_attempt.status; @@ -435,13 +435,13 @@ pub async fn payouts_update_core( req: payouts::PayoutCreateRequest, ) -> RouterResponse<payouts::PayoutCreateResponse> { let payout_id = req.payout_id.clone().get_required_value("payout_id")?; - let mut payout_data = make_payout_data( + let mut payout_data = Box::pin(make_payout_data( &state, &merchant_context, None, &payouts::PayoutRequest::PayoutCreateRequest(Box::new(req.to_owned())), &state.locale, - ) + )) .await?; let payout_attempt = payout_data.payout_attempt.to_owned(); @@ -509,13 +509,13 @@ pub async fn payouts_retrieve_core( profile_id: Option<common_utils::id_type::ProfileId>, req: payouts::PayoutRetrieveRequest, ) -> RouterResponse<payouts::PayoutCreateResponse> { - let mut payout_data = make_payout_data( + let mut payout_data = Box::pin(make_payout_data( &state, &merchant_context, profile_id, &payouts::PayoutRequest::PayoutRetrieveRequest(req.to_owned()), &state.locale, - ) + )) .await?; let payout_attempt = payout_data.payout_attempt.to_owned(); let status = payout_attempt.status; @@ -550,13 +550,13 @@ pub async fn payouts_cancel_core( merchant_context: domain::MerchantContext, req: payouts::PayoutActionRequest, ) -> RouterResponse<payouts::PayoutCreateResponse> { - let mut payout_data = make_payout_data( + let mut payout_data = Box::pin(make_payout_data( &state, &merchant_context, None, &payouts::PayoutRequest::PayoutActionRequest(req.to_owned()), &state.locale, - ) + )) .await?; let payout_attempt = payout_data.payout_attempt.to_owned(); @@ -641,13 +641,13 @@ pub async fn payouts_fulfill_core( merchant_context: domain::MerchantContext, req: payouts::PayoutActionRequest, ) -> RouterResponse<payouts::PayoutCreateResponse> { - let mut payout_data = make_payout_data( + let mut payout_data = Box::pin(make_payout_data( &state, &merchant_context, None, &payouts::PayoutRequest::PayoutActionRequest(req.to_owned()), &state.locale, - ) + )) .await?; let payout_attempt = payout_data.payout_attempt.to_owned(); diff --git a/crates/router/src/core/profile_acquirer.rs b/crates/router/src/core/profile_acquirer.rs new file mode 100644 index 00000000000..747059e540e --- /dev/null +++ b/crates/router/src/core/profile_acquirer.rs @@ -0,0 +1,114 @@ +use api_models::profile_acquirer; +use common_utils::types::keymanager::KeyManagerState; +use error_stack::ResultExt; + +use crate::{ + core::errors::{self, utils::StorageErrorExt, RouterResponse}, + services::api, + types::domain, + SessionState, +}; + +#[cfg(all(feature = "olap", feature = "v1"))] +pub async fn create_profile_acquirer( + state: SessionState, + request: profile_acquirer::ProfileAcquirerCreate, + merchant_context: domain::MerchantContext, +) -> RouterResponse<profile_acquirer::ProfileAcquirerResponse> { + let db = state.store.as_ref(); + let profile_acquirer_id = common_utils::generate_profile_acquirer_id_of_default_length(); + let key_manager_state: KeyManagerState = (&state).into(); + let merchant_key_store = merchant_context.get_merchant_key_store(); + + let mut business_profile = db + .find_business_profile_by_profile_id( + &key_manager_state, + merchant_key_store, + &request.profile_id, + ) + .await + .to_not_found_response(errors::ApiErrorResponse::ProfileNotFound { + id: request.profile_id.get_string_repr().to_owned(), + })?; + + let incoming_acquirer_config = common_types::domain::AcquirerConfig { + acquirer_assigned_merchant_id: request.acquirer_assigned_merchant_id.clone(), + merchant_name: request.merchant_name.clone(), + merchant_country_code: request.merchant_country_code, + network: request.network.clone(), + acquirer_bin: request.acquirer_bin.clone(), + acquirer_ica: request.acquirer_ica.clone(), + acquirer_fraud_rate: request.acquirer_fraud_rate, + }; + + // Check for duplicates before proceeding + + business_profile + .acquirer_config_map + .as_ref() + .map_or(Ok(()), \|configs_wrapper\| { + match configs_wrapper.0.values().any(\|existing_config\| existing_config == &incoming_acquirer_config) { + true => Err(error_stack::report!( + errors::ApiErrorResponse::GenericDuplicateError { + message: format!( + "Duplicate acquirer configuration found for profile_id: {}. Conflicting configuration: {:?}", + request.profile_id.get_string_repr(), + incoming_acquirer_config + ), + } + )), + false => Ok(()), + } + })?; + + // Get a mutable reference to the HashMap inside AcquirerConfigMap, + // initializing if it's None or the inner HashMap is not present. + let configs_map = &mut business_profile + .acquirer_config_map + .get_or_insert_with(\|\| { + common_types::domain::AcquirerConfigMap(std::collections::HashMap::new()) + }) + .0; + + configs_map.insert( + profile_acquirer_id.clone(), + incoming_acquirer_config.clone(), + ); + + let profile_update = domain::ProfileUpdate::AcquirerConfigMapUpdate { + acquirer_config_map: business_profile.acquirer_config_map.clone(), + }; + let updated_business_profile = db + .update_profile_by_profile_id( + &key_manager_state, + merchant_key_store, + business_profile, + profile_update, + ) + .await + .change_context(errors::ApiErrorResponse::InternalServerError) + .attach_printable("Failed to update business profile with new acquirer config")?; + + let updated_acquire_details = updated_business_profile + .acquirer_config_map + .as_ref() + .and_then(\|acquirer_configs_wrapper\| acquirer_configs_wrapper.0.get(&profile_acquirer_id)) + .ok_or(errors::ApiErrorResponse::InternalServerError) + .attach_printable("Failed to get updated acquirer config")?; + + let response = profile_acquirer::ProfileAcquirerResponse { + profile_acquirer_id, + profile_id: request.profile_id.clone(), + acquirer_assigned_merchant_id: updated_acquire_details + .acquirer_assigned_merchant_id + .clone(), + merchant_name: updated_acquire_details.merchant_name.clone(), + merchant_country_code: updated_acquire_details.merchant_country_code, + network: updated_acquire_details.network.clone(), + acquirer_bin: updated_acquire_details.acquirer_bin.clone(), + acquirer_ica: updated_acquire_details.acquirer_ica.clone(), + acquirer_fraud_rate: updated_acquire_details.acquirer_fraud_rate, + }; + + Ok(api::ApplicationResponse::Json(response)) +} diff --git a/crates/router/src/core/webhooks/incoming.rs b/crates/router/src/core/webhooks/incoming.rs index a7a0c76e2f0..3f95d61bfb7 100644 --- a/crates/router/src/core/webhooks/incoming.rs +++ b/crates/router/src/core/webhooks/incoming.rs @@ -822,13 +822,13 @@ async fn payouts_incoming_webhook_flow( payout_id: payouts.payout_id.clone(), }); - let payout_data = payouts::make_payout_data( + let payout_data = Box::pin(payouts::make_payout_data( &state, &merchant_context, None, &action_req, common_utils::consts::DEFAULT_LOCALE, - ) + )) .await?; let updated_payout_attempt = db diff --git a/crates/router/src/db/kafka_store.rs b/crates/router/src/db/kafka_store.rs index e34fad3a2b1..e7136919cee 100644 --- a/crates/router/src/db/kafka_store.rs +++ b/crates/router/src/db/kafka_store.rs @@ -10,8 +10,7 @@ use common_utils::{ #[cfg(feature = "v2")] use diesel_models::ephemeral_key::{ClientSecretType, ClientSecretTypeNew}; use diesel_models::{ - enums, - enums::ProcessTrackerStatus, + enums::{self, ProcessTrackerStatus}, ephemeral_key::{EphemeralKey, EphemeralKeyNew}, reverse_lookup::{ReverseLookup, ReverseLookupNew}, user_role as user_storage, diff --git a/crates/router/src/lib.rs b/crates/router/src/lib.rs index f37b404de41..6a048c59b00 100644 --- a/crates/router/src/lib.rs +++ b/crates/router/src/lib.rs @@ -132,7 +132,8 @@ pub fn mk_app( { server_app = server_app .service(routes::ProfileNew::server(state.clone())) - .service(routes::Forex::server(state.clone())); + .service(routes::Forex::server(state.clone())) + .service(routes::ProfileAcquirer::server(state.clone())); } server_app = server_app.service(routes::Profile::server(state.clone())); diff --git a/crates/router/src/routes.rs b/crates/router/src/routes.rs index 7002a725b79..35221104ae3 100644 --- a/crates/router/src/routes.rs +++ b/crates/router/src/routes.rs @@ -41,6 +41,8 @@ pub mod payouts; pub mod pm_auth; pub mod poll; #[cfg(feature = "olap")] +pub mod profile_acquirer; +#[cfg(feature = "olap")] pub mod profiles; #[cfg(feature = "recon")] pub mod recon; @@ -86,8 +88,8 @@ pub use self::app::{ ApiKeys, AppState, ApplePayCertificatesMigration, Cache, Cards, Configs, ConnectorOnboarding, Customers, Disputes, EphemeralKey, FeatureMatrix, Files, Forex, Gsm, Health, Hypersense, Mandates, MerchantAccount, MerchantConnectorAccount, PaymentLink, PaymentMethods, Payments, - Poll, ProcessTracker, Profile, ProfileNew, Refunds, Relay, RelayWebhooks, SessionState, - ThreeDsDecisionRule, User, Webhooks, + Poll, ProcessTracker, Profile, ProfileAcquirer, ProfileNew, Refunds, Relay, RelayWebhooks, + SessionState, ThreeDsDecisionRule, User, Webhooks, }; #[cfg(feature = "olap")] pub use self::app::{Blocklist, Organization, Routing, Verify, WebhookEvents}; diff --git a/crates/router/src/routes/app.rs b/crates/router/src/routes/app.rs index 82c3e10105e..3d2a6e91700 100644 --- a/crates/router/src/routes/app.rs +++ b/crates/router/src/routes/app.rs @@ -85,6 +85,8 @@ use crate::routes::cards_info::{ use crate::routes::feature_matrix; #[cfg(all(feature = "frm", feature = "oltp"))] use crate::routes::fraud_check as frm_routes; +#[cfg(all(feature = "olap", feature = "v1"))] +use crate::routes::profile_acquirer; #[cfg(all(feature = "recon", feature = "olap"))] use crate::routes::recon as recon_routes; pub use crate::{ @@ -2645,3 +2647,17 @@ impl ProcessTracker { ) } } + +#[cfg(feature = "olap")] +pub struct ProfileAcquirer; + +#[cfg(all(feature = "olap", feature = "v1"))] +impl ProfileAcquirer { + pub fn server(state: AppState) -> Scope { + web::scope("/profile_acquirer") + .app_data(web::Data::new(state)) + .service( + web::resource("").route(web::post().to(profile_acquirer::create_profile_acquirer)), + ) + } +} diff --git a/crates/router/src/routes/lock_utils.rs b/crates/router/src/routes/lock_utils.rs index 91225fa39ab..9f64e31dcff 100644 --- a/crates/router/src/routes/lock_utils.rs +++ b/crates/router/src/routes/lock_utils.rs @@ -44,6 +44,7 @@ pub enum ApiIdentifier { PaymentMethodSession, ProcessTracker, Proxy, + ProfileAcquirer, ThreeDsDecisionRule, GenericTokenization, } @@ -345,6 +346,7 @@ impl From<Flow> for ApiIdentifier { Flow::RevenueRecoveryRetrieve => Self::ProcessTracker, Flow::Proxy => Self::Proxy, + Flow::ProfileAcquirerCreate => Self::ProfileAcquirer, Flow::ThreeDsDecisionRuleExecute => Self::ThreeDsDecisionRule, Flow::TokenizationCreate \| Flow::TokenizationRetrieve => Self::GenericTokenization, } diff --git a/crates/router/src/routes/profile_acquirer.rs b/crates/router/src/routes/profile_acquirer.rs new file mode 100644 index 00000000000..4e8a5eeffaf --- /dev/null +++ b/crates/router/src/routes/profile_acquirer.rs @@ -0,0 +1,50 @@ +use actix_web::{web, HttpRequest, HttpResponse}; +use api_models::profile_acquirer::ProfileAcquirerCreate; +use router_env::{instrument, tracing, Flow}; + +use super::app::AppState; +use crate::{ + core::api_locking, + services::{api, authentication as auth, authorization::permissions::Permission}, + types::domain, +}; + +#[cfg(all(feature = "olap", feature = "v1"))] +#[instrument(skip_all, fields(flow = ?Flow::ProfileAcquirerCreate))] +pub async fn create_profile_acquirer( + state: web::Data<AppState>, + req: HttpRequest, + json_payload: web::Json<ProfileAcquirerCreate>, +) -> HttpResponse { + let flow = Flow::ProfileAcquirerCreate; + let payload = json_payload.into_inner(); + + Box::pin(api::server_wrap( + flow, + state, + &req, + payload, + \|state: super::SessionState, auth_data, req, _\| { + let merchant_context = domain::MerchantContext::NormalMerchant(Box::new( + domain::Context(auth_data.merchant_account, auth_data.key_store), + )); + crate::core::profile_acquirer::create_profile_acquirer( + state, + req, + merchant_context.clone(), + ) + }, + auth::auth_type( + &auth::HeaderAuth(auth::ApiKeyAuth { + is_connected_allowed: false, + is_platform_allowed: true, + }), + &auth::JWTAuth { + permission: Permission::ProfileAccountWrite, + }, + req.headers(), + ), + api_locking::LockAction::NotApplicable, + )) + .await +} diff --git a/crates/router/src/types/api/admin.rs b/crates/router/src/types/api/admin.rs index cbca021f1c9..41069a784b8 100644 --- a/crates/router/src/types/api/admin.rs +++ b/crates/router/src/types/api/admin.rs @@ -197,6 +197,7 @@ impl ForeignTryFrom<domain::Profile> for ProfileResponse { is_debit_routing_enabled: Some(item.is_debit_routing_enabled), merchant_business_country: item.merchant_business_country, is_pre_network_tokenization_enabled: item.is_pre_network_tokenization_enabled, + acquirer_configs: item.acquirer_config_map, is_iframe_redirection_enabled: item.is_iframe_redirection_enabled, }) } diff --git a/crates/router/src/workflows/attach_payout_account_workflow.rs b/crates/router/src/workflows/attach_payout_account_workflow.rs index 910afe3166c..9704ce06d3d 100644 --- a/crates/router/src/workflows/attach_payout_account_workflow.rs +++ b/crates/router/src/workflows/attach_payout_account_workflow.rs @@ -53,9 +53,14 @@ impl ProcessTrackerWorkflow<SessionState> for AttachPayoutAccountWorkflow { merchant_account.clone(), key_store.clone(), ))); - let mut payout_data = - payouts::make_payout_data(state, &merchant_context, None, &request, DEFAULT_LOCALE) - .await?; + let mut payout_data = Box::pin(payouts::make_payout_data( + state, + &merchant_context, + None, + &request, + DEFAULT_LOCALE, + )) + .await?; payouts::payouts_core(state, &merchant_context, &mut payout_data, None, None).await?; diff --git a/crates/router/src/workflows/outgoing_webhook_retry.rs b/crates/router/src/workflows/outgoing_webhook_retry.rs index 56265c788f7..d525763529e 100644 --- a/crates/router/src/workflows/outgoing_webhook_retry.rs +++ b/crates/router/src/workflows/outgoing_webhook_retry.rs @@ -542,13 +542,13 @@ async fn get_outgoing_webhook_content_and_event_type( payout_models::PayoutActionRequest { payout_id }, ); - let payout_data = payouts::make_payout_data( + let payout_data = Box::pin(payouts::make_payout_data( &state, &merchant_context, None, &request, DEFAULT_LOCALE, - ) + )) .await?; let router_response = diff --git a/crates/router_env/src/logger/types.rs b/crates/router_env/src/logger/types.rs index 12fd6108b62..27ab6dd7c10 100644 --- a/crates/router_env/src/logger/types.rs +++ b/crates/router_env/src/logger/types.rs @@ -594,6 +594,7 @@ pub enum Flow { CloneConnector, ///Proxy Flow Proxy, + ProfileAcquirerCreate, /// ThreeDs Decision Rule Execute flow ThreeDsDecisionRuleExecute, } diff --git a/migrations/2025-06-05-122346_add-acquirer-config-in-business-profile/down.sql b/migrations/2025-06-05-122346_add-acquirer-config-in-business-profile/down.sql new file mode 100644 index 00000000000..01490869cff --- /dev/null +++ b/migrations/2025-06-05-122346_add-acquirer-config-in-business-profile/down.sql @@ -0,0 +1,2 @@ +-- This file should undo anything in `up.sql` +ALTER TABLE business_profile DROP COLUMN IF EXISTS acquirer_config_map; \ No newline at end of file diff --git a/migrations/2025-06-05-122346_add-acquirer-config-in-business-profile/up.sql b/migrations/2025-06-05-122346_add-acquirer-config-in-business-profile/up.sql new file mode 100644 index 00000000000..ac326b3ca4f --- /dev/null +++ b/migrations/2025-06-05-122346_add-acquirer-config-in-business-profile/up.sql @@ -0,0 +1,2 @@ +-- Your SQL goes here +ALTER TABLE business_profile ADD COLUMN IF NOT EXISTS acquirer_config_map JSONB; \ No newline at end of file	2025-05-27T11:08:05Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [x] New feature ## Description <!-- Describe your changes in detail --> added merchant acquirer create and list module ### Additional Changes - [ ] This PR modifies the API contract - [x] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables Add new field merchant_acquirer_ids in business_profile This pull request introduces support for managing acquirer configurations and profile acquirer entities, including updates to the OpenAPI specification, the Rust codebase, and database schema. The changes enable the creation, storage, and retrieval of acquirer configuration data and profile acquirer entities, which are essential for linking merchant profiles to acquirer accounts. ### API Enhancements: * Added a new endpoint `/profile_acquirers` for creating profile acquirers in `api-reference/openapi_spec.json`. Includes request and response schemas (`ProfileAcquirerCreate` and `ProfileAcquirerResponse`). [[1]](diffhunk://#diff-120d5ba664a56f45b6d881ccac78000f991d22e2909b5e45c83602c7dfab27cdR5960-R5999) [[2]](diffhunk://#diff-120d5ba664a56f45b6d881ccac78000f991d22e2909b5e45c83602c7dfab27cdR25396-R25513) * Defined schemas for `AcquirerConfig` and `AcquirerConfigMap` to describe acquirer configurations. [[1]](diffhunk://#diff-120d5ba664a56f45b6d881ccac78000f991d22e2909b5e45c83602c7dfab27cdR6350-R6406) [[2]](diffhunk://#diff-120d5ba664a56f45b6d881ccac78000f991d22e2909b5e45c83602c7dfab27cdR26036-R26043) ### Rust Codebase Updates: * Introduced `ProfileAcquirerCreate` and `ProfileAcquirerResponse` structs in the new `crates/api_models/src/profile_acquirer.rs` file for handling profile acquirer data. * Added `AcquirerConfig` and `AcquirerConfigMap` structs in `crates/common_types/src/domain.rs` to represent acquirer configuration data. * Implemented `ProfileAcquirerId` type in `crates/common_utils/src/id_type/profile_acquirer.rs` for unique identification of profile acquirers. ### Database Schema Changes: * Updated `business_profile` table to include a new column `acquirer_config_map` for storing acquirer configuration data in JSON format. [[1]](diffhunk://#diff-b3de56db64ac930fe24b6b0acb45282191598a506d20732f70ef00192b4b18d5R231) [[2]](diffhunk://#diff-22fdeee3005db31c44a9d40cd43c5a244e77a74e17d2e227d4c0b376f133f37eR226) * Modified `Profile` and `ProfileUpdateInternal` structs in `crates/diesel_models/src/business_profile.rs` to include `acquirer_config_map`. [[1]](diffhunk://#diff-9580ab8a5056970f087fa2af0a8de98dae6bf038ade612e3c996b88b23ae6e11R77) [[2]](diffhunk://#diff-9580ab8a5056970f087fa2af0a8de98dae6bf038ade612e3c996b88b23ae6e11R187) [[3]](diffhunk://#diff-9580ab8a5056970f087fa2af0a8de98dae6bf038ade612e3c996b88b23ae6e11R239) ### Event and Utility Enhancements: * Added `ProfileAcquirer` as a new event type in `crates/common_utils/src/events.rs`. * Implemented utility functions for generating and handling `ProfileAcquirerId`. [[1]](diffhunk://#diff-9bbc934a55fcf5282e0b0ba208a3722e9691ee71709d15a5c0d0958759280fa0R256-R262) [[2]](diffhunk://#diff-42f2c04d1e7d6eaf0534968a602f64eb00017fc3799f3426816fd59abae0145cR1-R41) ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> Currently we donot have a table to store merchant acquirer information, have build an api to insert data for merchant acquirer into business profile table ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> Create a merchant account Once done create merchant_acquirer Request ```shell curl --location 'localhost:8080/profile_acquirer' \ --header 'Content-Type: application/json' \ --header 'api-key: dev_rDKEInoZiJlNIfJPYNuqBMC2EOJjegGylLbzRMDw6kmSxV0FztdYfLcSoWZD6ZsT' \ --data '{ "acquirer_assigned_merchant_id": "ACQ1xwjnd23456", "merchant_name": "Demo Merchant", "merchant_country_code": "IN", "network": "Visa", "acquirer_bin": "400000", "acquirer_ica": "ICA98765", "acquirer_fraud_rate": 0.02, "profile_id": "pro_AFTXNDSW2mZadl5tEmqd" }' ``` Response: ```shell { "profile_acquirer_id": "pro_acq_ZlIC3dqlERLvrvLfXCUX", "acquirer_assigned_merchant_id": "ACQ1xwjnd23456", "merchant_name": "Demo Merchant", "merchant_country_code": "IN", "network": "Visa", "acquirer_bin": "400000", "acquirer_ica": "ICA98765", "acquirer_fraud_rate": 0.02, "profile_id": "pro_B9IE9uHjgRVKXHp9MSqG", "created_at": "2025-05-27T11:43:15.477Z" } ``` try hitting the api with same sample set Response:shell ``` { "error": { "type": "invalid_request", "message": "Profile acquirer configuration with id pro_acq_vhDNwqBvqM6BqbCZ8FJa already exists.", "code": "IR_38" } } ``` Business profile schema details ```shell Table "public.business_profile" Column \| Type \| Collation \| Nullable \| Default -------------------------------------------------------+-----------------------------+-----------+----------+------------------------- profile_id \| character varying(64) \| \| not null \| merchant_id \| character varying(64) \| \| not null \| profile_name \| character varying(64) \| \| not null \| created_at \| timestamp without time zone \| \| not null \| modified_at \| timestamp without time zone \| \| not null \| return_url \| text \| \| \| enable_payment_response_hash \| boolean \| \| not null \| true payment_response_hash_key \| character varying(255) \| \| \| NULL::character varying redirect_to_merchant_with_http_post \| boolean \| \| not null \| false webhook_details \| json \| \| \| metadata \| json \| \| \| routing_algorithm \| json \| \| \| intent_fulfillment_time \| bigint \| \| \| frm_routing_algorithm \| jsonb \| \| \| payout_routing_algorithm \| jsonb \| \| \| is_recon_enabled \| boolean \| \| not null \| false applepay_verified_domains \| text[] \| \| \| payment_link_config \| jsonb \| \| \| session_expiry \| bigint \| \| \| authentication_connector_details \| jsonb \| \| \| payout_link_config \| jsonb \| \| \| is_extended_card_info_enabled \| boolean \| \| \| false extended_card_info_config \| jsonb \| \| \| is_connector_agnostic_mit_enabled \| boolean \| \| \| false use_billing_as_payment_method_billing \| boolean \| \| \| true collect_shipping_details_from_wallet_connector \| boolean \| \| \| false collect_billing_details_from_wallet_connector \| boolean \| \| \| false outgoing_webhook_custom_http_headers \| bytea \| \| \| always_collect_billing_details_from_wallet_connector \| boolean \| \| \| false always_collect_shipping_details_from_wallet_connector \| boolean \| \| \| false tax_connector_id \| character varying(64) \| \| \| is_tax_connector_enabled \| boolean \| \| \| version \| "ApiVersion" \| \| not null \| 'v1'::"ApiVersion" dynamic_routing_algorithm \| json \| \| \| is_network_tokenization_enabled \| boolean \| \| not null \| false is_auto_retries_enabled \| boolean \| \| \| max_auto_retries_enabled \| smallint \| \| \| always_request_extended_authorization \| boolean \| \| \| is_click_to_pay_enabled \| boolean \| \| not null \| false authentication_product_ids \| jsonb \| \| \| card_testing_guard_config \| jsonb \| \| \| card_testing_secret_key \| bytea \| \| \| is_clear_pan_retries_enabled \| boolean \| \| not null \| false force_3ds_challenge \| boolean \| \| \| false is_debit_routing_enabled \| boolean \| \| not null \| false merchant_business_country \| "CountryAlpha2" \| \| \| id \| character varying(64) \| \| \| is_iframe_redirection_enabled \| boolean \| \| \| is_pre_network_tokenization_enabled \| boolean \| \| \| three_ds_decision_rule_algorithm \| jsonb \| \| \| acquirer_config_map \| jsonb \| \| \| Indexes: "business_profile_pkey" PRIMARY KEY, btree (profile_id) ``` List profile acquirer account -- do business profile retrieve ```shell curl --location 'localhost:8080/account/sahkal/business_profile/pro_RUyg7qT8yMzgfQpTqqm8' \ --header 'api-key: dev_dzO6ovCaZazaULNtb0AJxDIfCX67yQUQGYP190ZKX8KCd9WYoFhFIFRxVB8B5w6Q' ``` Response ```shell { "merchant_id": "sahkal", "profile_id": "pro_RUyg7qT8yMzgfQpTqqm8", "profile_name": "US_default", "return_url": "https://google.com/success", "enable_payment_response_hash": true, "payment_response_hash_key": "U9qcRdTlSXQc4cnsaEXMEpuiPVgw4RmekxfLjNznZjUt83u2tav6e6XYIdFZA9dw", "redirect_to_merchant_with_http_post": false, "webhook_details": { "webhook_version": "1.0.1", "webhook_username": "ekart_retail", "webhook_password": "password_ekart@123", "webhook_url": null, "payment_created_enabled": true, "payment_succeeded_enabled": true, "payment_failed_enabled": true }, "metadata": null, "routing_algorithm": null, "intent_fulfillment_time": 900, "frm_routing_algorithm": null, "payout_routing_algorithm": null, "applepay_verified_domains": null, "session_expiry": 900, "payment_link_config": null, "authentication_connector_details": null, "use_billing_as_payment_method_billing": true, "extended_card_info_config": null, "collect_shipping_details_from_wallet_connector": false, "collect_billing_details_from_wallet_connector": false, "always_collect_shipping_details_from_wallet_connector": false, "always_collect_billing_details_from_wallet_connector": false, "is_connector_agnostic_mit_enabled": false, "payout_link_config": null, "outgoing_webhook_custom_http_headers": null, "tax_connector_id": null, "is_tax_connector_enabled": false, "is_network_tokenization_enabled": false, "is_auto_retries_enabled": false, "max_auto_retries_enabled": null, "always_request_extended_authorization": null, "is_click_to_pay_enabled": false, "authentication_product_ids": null, "card_testing_guard_config": { "card_ip_blocking_status": "disabled", "card_ip_blocking_threshold": 3, "guest_user_card_blocking_status": "disabled", "guest_user_card_blocking_threshold": 10, "customer_id_blocking_status": "disabled", "customer_id_blocking_threshold": 5, "card_testing_guard_expiry": 3600 }, "is_clear_pan_retries_enabled": false, "force_3ds_challenge": false, "is_debit_routing_enabled": false, "merchant_business_country": null, "is_pre_network_tokenization_enabled": false, "acquirer_configs": { "pro_acq_jkn6Di8kIqBVrmICSEYU": { "acquirer_assigned_merchant_id": "fqwcqsqqwacccwwwec", "merchant_name": "Demo Merchant", "merchant_country_code": "US", "network": "Visa", "acquirer_bin": "400000", "acquirer_ica": null, "acquirer_fraud_rate": 0.06 }, "pro_acq_bbNCgQibI8K1Xr6Cv3fu": { "acquirer_assigned_merchant_id": "fqwcqsqqwacdqwdwqdccwwwec", "merchant_name": "Demo Merchant", "merchant_country_code": "US", "network": "Visa", "acquirer_bin": "400000", "acquirer_ica": null, "acquirer_fraud_rate": 0.06 } } } ``` ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - New Features - Added a new API endpoint to create Profile Acquirers linked to business profiles. - Enabled profiles to store multiple acquirer configurations with detailed attributes like merchant ID, country code, network, BIN, ICA, and fraud rate. - Database - Introduced a new JSONB column to store acquirer configuration maps within business profiles. - API Documentation - Updated OpenAPI specs to document new Profile Acquirer endpoints and related schemas. <!-- end of auto-generated comment: release notes by coderabbit.ai -->	v1.114.0	5ce2ab2d059d48a0f8305d65f45c7960c6939803	5ce2ab2d059d48a0f8305d65f45c7960c6939803
juspay/hyperswitch	juspay__hyperswitch-8633	Bug: [FEATURE] Add Incremental Authorization Flow for Stripe ### Feature Description Add Incremental Authorization Flow for Stripe ### Possible Implementation Add Incremental Authorization Flow for Stripe ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? Yes, I am willing to submit a PR!	diff --git a/api-reference/v2/openapi_spec_v2.json b/api-reference/v2/openapi_spec_v2.json index dc3578ef61c..99ffce36d28 100644 --- a/api-reference/v2/openapi_spec_v2.json +++ b/api-reference/v2/openapi_spec_v2.json @@ -22491,8 +22491,7 @@ "type": "string", "enum": [ "true", - "false", - "default" + "false" ] }, "RequestPaymentMethodTypes": { diff --git a/crates/common_enums/src/enums.rs b/crates/common_enums/src/enums.rs index 99b8c2e600e..f14695a7c74 100644 --- a/crates/common_enums/src/enums.rs +++ b/crates/common_enums/src/enums.rs @@ -2802,9 +2802,8 @@ pub enum CountryAlpha2 { #[strum(serialize_all = "snake_case")] pub enum RequestIncrementalAuthorization { True, - False, #[default] - Default, + False, } #[derive(Clone, Copy, Eq, Hash, PartialEq, Debug, Serialize, Deserialize, strum::Display, ToSchema,)] diff --git a/crates/hyperswitch_connectors/src/connectors/stripe.rs b/crates/hyperswitch_connectors/src/connectors/stripe.rs index a7146fab9cc..ee9e3f86f62 100644 --- a/crates/hyperswitch_connectors/src/connectors/stripe.rs +++ b/crates/hyperswitch_connectors/src/connectors/stripe.rs @@ -22,15 +22,16 @@ use hyperswitch_domain_models::{ payment_method_data::PaymentMethodData, router_data::{AccessToken, ConnectorAuthType, ErrorResponse, RouterData}, router_flow_types::{ - AccessTokenAuth, Authorize, Capture, CreateConnectorCustomer, Evidence, Execute, PSync, - PaymentMethodToken, RSync, Retrieve, Session, SetupMandate, UpdateMetadata, Upload, Void, + AccessTokenAuth, Authorize, Capture, CreateConnectorCustomer, Evidence, Execute, + IncrementalAuthorization, PSync, PaymentMethodToken, RSync, Retrieve, Session, + SetupMandate, UpdateMetadata, Upload, Void, }, router_request_types::{ AccessTokenRequestData, ConnectorCustomerData, PaymentMethodTokenizationData, - PaymentsAuthorizeData, PaymentsCancelData, PaymentsCaptureData, PaymentsSessionData, - PaymentsSyncData, PaymentsUpdateMetadataData, RefundsData, RetrieveFileRequestData, - SetupMandateRequestData, SplitRefundsRequest, SubmitEvidenceRequestData, - UploadFileRequestData, + PaymentsAuthorizeData, PaymentsCancelData, PaymentsCaptureData, + PaymentsIncrementalAuthorizationData, PaymentsSessionData, PaymentsSyncData, + PaymentsUpdateMetadataData, RefundsData, RetrieveFileRequestData, SetupMandateRequestData, + SplitRefundsRequest, SubmitEvidenceRequestData, UploadFileRequestData, }, router_response_types::{ PaymentsResponseData, RefundsResponseData, RetrieveFileResponse, SubmitEvidenceResponse, @@ -38,8 +39,9 @@ use hyperswitch_domain_models::{ }, types::{ ConnectorCustomerRouterData, PaymentsAuthorizeRouterData, PaymentsCancelRouterData, - PaymentsCaptureRouterData, PaymentsSyncRouterData, PaymentsUpdateMetadataRouterData, - RefundsRouterData, TokenizationRouterData, + PaymentsCaptureRouterData, PaymentsIncrementalAuthorizationRouterData, + PaymentsSyncRouterData, PaymentsUpdateMetadataRouterData, RefundsRouterData, + TokenizationRouterData, }, }; #[cfg(feature = "payouts")] @@ -58,7 +60,7 @@ use hyperswitch_interfaces::{ disputes::SubmitEvidence, files::{FilePurpose, FileUpload, RetrieveFile, UploadFile}, ConnectorCommon, ConnectorCommonExt, ConnectorIntegration, ConnectorRedirectResponse, - ConnectorSpecifications, ConnectorValidation, + ConnectorSpecifications, ConnectorValidation, PaymentIncrementalAuthorization, }, configs::Connectors, consts::{NO_ERROR_CODE, NO_ERROR_MESSAGE}, @@ -66,9 +68,10 @@ use hyperswitch_interfaces::{ errors::ConnectorError, events::connector_api_logs::ConnectorEvent, types::{ - ConnectorCustomerType, PaymentsAuthorizeType, PaymentsCaptureType, PaymentsSyncType, - PaymentsUpdateMetadataType, PaymentsVoidType, RefundExecuteType, RefundSyncType, Response, - RetrieveFileType, SubmitEvidenceType, TokenizationType, UploadFileType, + ConnectorCustomerType, IncrementalAuthorizationType, PaymentsAuthorizeType, + PaymentsCaptureType, PaymentsSyncType, PaymentsUpdateMetadataType, PaymentsVoidType, + RefundExecuteType, RefundSyncType, Response, RetrieveFileType, SubmitEvidenceType, + TokenizationType, UploadFileType, }, webhooks::{IncomingWebhook, IncomingWebhookRequestDetails}, }; @@ -1030,6 +1033,150 @@ impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData } } +impl PaymentIncrementalAuthorization for Stripe {} + +impl + ConnectorIntegration< + IncrementalAuthorization, + PaymentsIncrementalAuthorizationData, + PaymentsResponseData, + > for Stripe +{ + fn get_headers( + &self, + req: &PaymentsIncrementalAuthorizationRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, Maskable<String>)>, ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_http_method(&self) -> Method { + Method::Post + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + req: &PaymentsIncrementalAuthorizationRouterData, + connectors: &Connectors, + ) -> CustomResult<String, ConnectorError> { + Ok(format!( + "{}v1/payment_intents/{}/increment_authorization", + self.base_url(connectors), + req.request.connector_transaction_id, + )) + } + + fn get_request_body( + &self, + req: &PaymentsIncrementalAuthorizationRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, ConnectorError> { + let amount = utils::convert_amount( + self.amount_converter, + MinorUnit::new(req.request.total_amount), + req.request.currency, + )?; + let connector_req = stripe::StripeIncrementalAuthRequest { amount }; + + Ok(RequestContent::FormUrlEncoded(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &PaymentsIncrementalAuthorizationRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&IncrementalAuthorizationType::get_url( + self, req, connectors, + )?) + .attach_default_headers() + .headers(IncrementalAuthorizationType::get_headers( + self, req, connectors, + )?) + .set_body(IncrementalAuthorizationType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsIncrementalAuthorizationRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult< + RouterData< + IncrementalAuthorization, + PaymentsIncrementalAuthorizationData, + PaymentsResponseData, + >, + ConnectorError, + > { + let response: stripe::PaymentIntentResponse = res + .response + .parse_struct("PaymentIntentResponse") + .change_context(ConnectorError::ResponseDeserializationFailed)?; + + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + .change_context(ConnectorError::ResponseHandlingFailed) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, ConnectorError> { + let response: stripe::ErrorResponse = res + .response + .parse_struct("ErrorResponse") + .change_context(ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_error_response_body(&response)); + router_env::logger::info!(connector_response=?response); + Ok(ErrorResponse { + status_code: res.status_code, + code: response + .error + .code + .clone() + .unwrap_or_else(\|\| NO_ERROR_CODE.to_string()), + message: response + .error + .code + .unwrap_or_else(\|\| NO_ERROR_MESSAGE.to_string()), + reason: response.error.message.map(\|message\| { + response + .error + .decline_code + .clone() + .map(\|decline_code\| { + format!("message - {message}, decline_code - {decline_code}") + }) + .unwrap_or(message) + }), + attempt_status: None, + connector_transaction_id: response.error.payment_intent.map(\|pi\| pi.id), + network_advice_code: response.error.network_advice_code, + network_decline_code: response.error.network_decline_code, + network_error_message: response.error.decline_code.or(response.error.advice_code), + }) + } +} + impl ConnectorIntegration<UpdateMetadata, PaymentsUpdateMetadataData, PaymentsResponseData> for Stripe { diff --git a/crates/hyperswitch_connectors/src/connectors/stripe/transformers.rs b/crates/hyperswitch_connectors/src/connectors/stripe/transformers.rs index 3cd7aa033d7..e9e5913d593 100644 --- a/crates/hyperswitch_connectors/src/connectors/stripe/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/stripe/transformers.rs @@ -24,7 +24,8 @@ use hyperswitch_domain_models::{ router_flow_types::{Execute, RSync}, router_request_types::{ BrowserInformation, ChargeRefundsOptions, DestinationChargeRefund, DirectChargeRefund, - ResponseId, SplitRefundsRequest, + PaymentsAuthorizeData, PaymentsCancelData, PaymentsCaptureData, + PaymentsIncrementalAuthorizationData, ResponseId, SplitRefundsRequest, }, router_response_types::{ MandateReference, PaymentsResponseData, PreprocessingResponseId, RedirectForm, @@ -66,6 +67,28 @@ pub mod auth_headers { pub const STRIPE_VERSION: &str = "2022-11-15"; } +trait GetRequestIncrementalAuthorization { + fn get_request_incremental_authorization(&self) -> Option<bool>; +} + +impl GetRequestIncrementalAuthorization for PaymentsAuthorizeData { + fn get_request_incremental_authorization(&self) -> Option<bool> { + Some(self.request_incremental_authorization) + } +} + +impl GetRequestIncrementalAuthorization for PaymentsCaptureData { + fn get_request_incremental_authorization(&self) -> Option<bool> { + None + } +} + +impl GetRequestIncrementalAuthorization for PaymentsCancelData { + fn get_request_incremental_authorization(&self) -> Option<bool> { + None + } +} + pub struct StripeAuthType { pub(super) api_key: Secret<String>, } @@ -257,7 +280,18 @@ pub struct StripeCardData { pub payment_method_auth_type: Option<Auth3ds>, #[serde(rename = "payment_method_options[card][network]")] pub payment_method_data_card_preferred_network: Option<StripeCardNetwork>, + #[serde(skip_serializing_if = "Option::is_none")] + #[serde(rename = "payment_method_options[card][request_incremental_authorization]")] + pub request_incremental_authorization: Option<StripeRequestIncrementalAuthorization>, } + +#[derive(Debug, Eq, PartialEq, Serialize)] +#[serde(rename_all = "snake_case")] +pub enum StripeRequestIncrementalAuthorization { + IfAvailable, + Never, +} + #[derive(Debug, Eq, PartialEq, Serialize)] pub struct StripePayLaterData { #[serde(rename = "payment_method_data[type]")] @@ -1219,6 +1253,7 @@ fn create_stripe_payment_method( payment_method_token: Option<PaymentMethodToken>, is_customer_initiated_mandate_payment: Option<bool>, billing_address: StripeBillingAddress, + request_incremental_authorization: bool, ) -> Result< ( StripePaymentMethodData, @@ -1234,7 +1269,11 @@ fn create_stripe_payment_method( enums::AuthenticationType::NoThreeDs => Auth3ds::Automatic, }; Ok(( - StripePaymentMethodData::try_from((card_details, payment_method_auth_type))?, + StripePaymentMethodData::try_from(( + card_details, + payment_method_auth_type, + request_incremental_authorization, + ))?, Some(StripePaymentMethodType::Card), billing_address, )) @@ -1452,9 +1491,11 @@ fn get_stripe_card_network(card_network: common_enums::CardNetwork) -> Option<St } } -impl TryFrom<(&Card, Auth3ds)> for StripePaymentMethodData { +impl TryFrom<(&Card, Auth3ds, bool)> for StripePaymentMethodData { type Error = ConnectorError; - fn try_from((card, payment_method_auth_type): (&Card, Auth3ds)) -> Result<Self, Self::Error> { + fn try_from( + (card, payment_method_auth_type, request_incremental_authorization): (&Card, Auth3ds, bool), + ) -> Result<Self, Self::Error> { Ok(Self::Card(StripeCardData { payment_method_data_type: StripePaymentMethodType::Card, payment_method_data_card_number: card.card_number.clone(), @@ -1466,6 +1507,11 @@ impl TryFrom<(&Card, Auth3ds)> for StripePaymentMethodData { .card_network .clone() .and_then(get_stripe_card_network), + request_incremental_authorization: if request_incremental_authorization { + Some(StripeRequestIncrementalAuthorization::IfAvailable) + } else { + None + }, })) } } @@ -1813,6 +1859,7 @@ impl TryFrom<(&PaymentsAuthorizeRouterData, MinorUnit)> for PaymentIntentRequest .card_network .clone() .and_then(get_stripe_card_network), + request_incremental_authorization: None, }), PaymentMethodData::CardRedirect(_) \| PaymentMethodData::Wallet(_) @@ -1861,6 +1908,7 @@ impl TryFrom<(&PaymentsAuthorizeRouterData, MinorUnit)> for PaymentIntentRequest field_name: "billing_address", } })?, + item.request.request_incremental_authorization, )?; validate_shipping_address_against_payment_method( @@ -2186,6 +2234,7 @@ impl TryFrom<&TokenizationRouterData> for TokenRequest { item.payment_method_token.clone(), None, StripeBillingAddress::default(), + false, )? .0 } @@ -2299,6 +2348,11 @@ impl TryFrom<&PaymentsAuthorizeRouterData> for StripeSplitPaymentRequest { } } +#[derive(Debug, Serialize)] +pub struct StripeIncrementalAuthRequest { + pub amount: MinorUnit, +} + #[derive(Clone, Default, Debug, Eq, PartialEq, Deserialize, Serialize)] #[serde(rename_all = "snake_case")] pub enum StripePaymentStatus { @@ -2660,7 +2714,7 @@ fn extract_payment_method_connector_response_from_latest_attempt( impl<F, T> TryFrom<ResponseRouterData<F, PaymentIntentResponse, T, PaymentsResponseData>> for RouterData<F, T, PaymentsResponseData> where - T: SplitPaymentData, + T: SplitPaymentData + GetRequestIncrementalAuthorization, { type Error = error_stack::Report<ConnectorError>; fn try_from( @@ -2742,7 +2796,10 @@ where connector_metadata, network_txn_id, connector_response_reference_id: Some(item.response.id), - incremental_authorization_allowed: None, + incremental_authorization_allowed: item + .data + .request + .get_request_incremental_authorization(), charges, }) }; @@ -2771,6 +2828,55 @@ where } } +impl From<StripePaymentStatus> for common_enums::AuthorizationStatus { + fn from(item: StripePaymentStatus) -> Self { + match item { + StripePaymentStatus::Succeeded + \| StripePaymentStatus::RequiresCapture + \| StripePaymentStatus::Chargeable + \| StripePaymentStatus::RequiresCustomerAction + \| StripePaymentStatus::RequiresConfirmation + \| StripePaymentStatus::Consumed => Self::Success, + StripePaymentStatus::Processing \| StripePaymentStatus::Pending => Self::Processing, + StripePaymentStatus::Failed + \| StripePaymentStatus::Canceled + \| StripePaymentStatus::RequiresPaymentMethod => Self::Failure, + } + } +} + +impl<F> + TryFrom< + ResponseRouterData< + F, + PaymentIntentResponse, + PaymentsIncrementalAuthorizationData, + PaymentsResponseData, + >, + > for RouterData<F, PaymentsIncrementalAuthorizationData, PaymentsResponseData> +{ + type Error = error_stack::Report<ConnectorError>; + fn try_from( + item: ResponseRouterData< + F, + PaymentIntentResponse, + PaymentsIncrementalAuthorizationData, + PaymentsResponseData, + >, + ) -> Result<Self, Self::Error> { + let status = common_enums::AuthorizationStatus::from(item.response.status); + Ok(Self { + response: Ok(PaymentsResponseData::IncrementalAuthorizationResponse { + status, + error_code: None, + error_message: None, + connector_authorization_id: Some(item.response.id), + }), + ..item.data + }) + } +} + pub fn get_connector_metadata( next_action: Option<&StripeNextActionResponse>, amount: MinorUnit, @@ -4040,7 +4146,11 @@ impl enums::AuthenticationType::ThreeDs => Auth3ds::Any, enums::AuthenticationType::NoThreeDs => Auth3ds::Automatic, }; - Ok(Self::try_from((ccard, payment_method_auth_type))?) + Ok(Self::try_from(( + ccard, + payment_method_auth_type, + item.request.request_incremental_authorization, + ))?) } PaymentMethodData::PayLater(_) => Ok(Self::PayLater(StripePayLaterData { payment_method_data_type: pm_type, diff --git a/crates/hyperswitch_connectors/src/default_implementations.rs b/crates/hyperswitch_connectors/src/default_implementations.rs index 67821e66d72..c2c15cf5308 100644 --- a/crates/hyperswitch_connectors/src/default_implementations.rs +++ b/crates/hyperswitch_connectors/src/default_implementations.rs @@ -1193,7 +1193,6 @@ default_imp_for_incremental_authorization!( connectors::Signifyd, connectors::Stax, connectors::Square, - connectors::Stripe, connectors::Stripebilling, connectors::Taxjar, connectors::Threedsecureio, diff --git a/crates/router/src/core/payments/transformers.rs b/crates/router/src/core/payments/transformers.rs index dd9b41ee9d2..21dd7833b76 100644 --- a/crates/router/src/core/payments/transformers.rs +++ b/crates/router/src/core/payments/transformers.rs @@ -312,7 +312,7 @@ pub async fn construct_payment_router_data_for_authorize<'a>( payment_data .payment_intent .request_incremental_authorization, - RequestIncrementalAuthorization::True \| RequestIncrementalAuthorization::Default + RequestIncrementalAuthorization::True ), metadata: payment_data.payment_intent.metadata.expose_option(), authentication_data: None, @@ -1014,7 +1014,7 @@ pub async fn construct_payment_router_data_for_setup_mandate<'a>( payment_data .payment_intent .request_incremental_authorization, - RequestIncrementalAuthorization::True \| RequestIncrementalAuthorization::Default + RequestIncrementalAuthorization::True ), metadata: payment_data.payment_intent.metadata, minor_amount: Some(payment_data.payment_attempt.amount_details.get_net_amount()), @@ -3822,7 +3822,6 @@ impl<F: Clone> TryFrom<PaymentAdditionalData<'_, F>> for types::PaymentsAuthoriz .payment_intent .request_incremental_authorization, Some(RequestIncrementalAuthorization::True) - \| Some(RequestIncrementalAuthorization::Default) ), metadata: additional_data.payment_data.payment_intent.metadata, authentication_data: payment_data @@ -4694,7 +4693,6 @@ impl<F: Clone> TryFrom<PaymentAdditionalData<'_, F>> for types::SetupMandateRequ .payment_intent .request_incremental_authorization, Some(RequestIncrementalAuthorization::True) - \| Some(RequestIncrementalAuthorization::Default) ), metadata: payment_data.payment_intent.metadata.clone().map(Into::into), shipping_cost: payment_data.payment_intent.shipping_cost,	2025-07-07T14:33:36Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD Closes this [issue](https://github.com/juspay/hyperswitch/issues/8633) ## Description <!-- Describe your changes in detail --> Added Incremental Authorization Flow in Stripe. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> [8633](https://github.com/juspay/hyperswitch/issues/8633) ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> Postman Tests 1. Payments - Create Request: ``` curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_GO27IMaWkZPcdQp7NA8uYvMJowN0WzpbyqEGtW7L3fxAtXZzCzy60mIZTzOjGon1' \ --data-raw ' { "amount": 1000, "currency": "USD", "confirm": true, "capture_method": "manual", "capture_on": "2022-09-10T10:11:12Z", "amount_to_capture": 1000, "customer_id": "StripeCustomer", "email": "[email protected]", "name": "John Doe", "phone": "999999999", "phone_country_code": "+65", "description": "Its my first payment request", "authentication_type": "no_three_ds", "return_url": "https://duck.com", "billing": { "address": { "first_name": "John", "last_name": "Doe", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "AT" } }, "payment_method": "card", "payment_method_type": "credit", "payment_method_data": { "card": { "card_number": "4242424242424242", "card_exp_month": "12", "card_exp_year": "2026", "card_holder_name": "joseph Doe", "card_cvc": "123" } }, "browser_info": { "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8", "language": "nl-NL", "color_depth": 24, "screen_height": 723, "screen_width": 1536, "time_zone": 0, "java_enabled": true, "java_script_enabled": true, "ip_address": "127.0.0.1" }, "shipping": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "John", "last_name": "Doe" } }, "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "metadata": { "udf1": "value1", "new_customer": "true", "login_date": "2019-09-10T10:11:12Z" }, "request_incremental_authorization": true }' ``` Response: ``` { "payment_id": "pay_jQwvRdxooT7YhHSEvann", "merchant_id": "merchant_1751975048", "status": "requires_capture", "amount": 1000, "net_amount": 1000, "shipping_cost": null, "amount_capturable": 1000, "amount_received": 0, "connector": "stripe", "client_secret": "pay_jQwvRdxooT7YhHSEvann_secret_tjC9HRIfeD3ku1ILRS8Y", "created": "2025-07-08T11:44:25.513Z", "currency": "USD", "customer_id": "StripeCustomer", "customer": { "id": "StripeCustomer", "name": "John Doe", "email": "[email protected]", "phone": "999999999", "phone_country_code": "+65" }, "description": "Its my first payment request", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "manual", "payment_method": "card", "payment_method_data": { "card": { "last4": "4242", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "424242", "card_extended_bin": null, "card_exp_month": "12", "card_exp_year": "2026", "card_holder_name": "joseph Doe", "payment_checks": { "cvc_check": "pass", "address_line1_check": "pass", "address_postal_code_check": "pass" }, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "John", "last_name": "Doe" }, "phone": null, "email": null }, "billing": { "address": { "city": "San Fransico", "country": "AT", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "John", "last_name": "Doe" }, "phone": null, "email": null }, "order_details": null, "email": "[email protected]", "name": "John Doe", "phone": "999999999", "return_url": "https://duck.com/", "authentication_type": "no_three_ds", "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "credit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": { "customer_id": "StripeCustomer", "created_at": 1751975065, "expires": 1751978665, "secret": "epk_4ce25909189e412389f732e1cd91ce49" }, "manual_retry_allowed": false, "connector_transaction_id": "pi_3RiZwnE9cSvqiivY0jq3K45T", "frm_message": null, "metadata": { "udf1": "value1", "login_date": "2019-09-10T10:11:12Z", "new_customer": "true" }, "connector_metadata": null, "feature_metadata": null, "reference_id": "pi_3RiZwnE9cSvqiivY0jq3K45T", "payment_link": null, "profile_id": "pro_fql6hf5I69zMoOLyp0gP", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_qTfdo4iBwxJFmMDXJwLD", "incremental_authorization_allowed": true, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-07-08T11:59:25.513Z", "fingerprint": null, "browser_info": { "language": "nl-NL", "time_zone": 0, "ip_address": "127.0.0.1", "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "color_depth": 24, "java_enabled": true, "screen_width": 1536, "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8", "screen_height": 723, "java_script_enabled": true }, "payment_method_id": null, "payment_method_status": null, "updated": "2025-07-08T11:44:30.290Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` 2. Incremental Authorization Request: ``` curl --location 'http://localhost:8080/payments/pay_jQwvRdxooT7YhHSEvann/incremental_authorization' \ --header 'Content-Type: application/json' \ --header 'api-key: dev_GO27IMaWkZPcdQp7NA8uYvMJowN0WzpbyqEGtW7L3fxAtXZzCzy60mIZTzOjGon1' \ --data '{ "amount": 6540, "reason": "customer bought new products" }' ``` Response: ``` { "payment_id": "pay_jQwvRdxooT7YhHSEvann", "merchant_id": "merchant_1751975048", "status": "requires_capture", "amount": 6540, "net_amount": 6540, "shipping_cost": null, "amount_capturable": 6540, "amount_received": 0, "connector": "stripe", "client_secret": "pay_jQwvRdxooT7YhHSEvann_secret_tjC9HRIfeD3ku1ILRS8Y", "created": "2025-07-08T11:44:25.513Z", "currency": "USD", "customer_id": null, "customer": { "id": null, "name": "John Doe", "email": "[email protected]", "phone": "999999999", "phone_country_code": "+65" }, "description": "Its my first payment request", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "manual", "payment_method": "card", "payment_method_data": { "card": { "last4": "4242", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "424242", "card_extended_bin": null, "card_exp_month": "12", "card_exp_year": "2026", "card_holder_name": "joseph Doe", "payment_checks": { "cvc_check": "pass", "address_line1_check": "pass", "address_postal_code_check": "pass" }, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": null, "billing": null, "order_details": null, "email": null, "name": null, "phone": null, "return_url": "https://duck.com/", "authentication_type": "no_three_ds", "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "credit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": false, "connector_transaction_id": "pi_3RiZwnE9cSvqiivY0jq3K45T", "frm_message": null, "metadata": { "udf1": "value1", "login_date": "2019-09-10T10:11:12Z", "new_customer": "true" }, "connector_metadata": null, "feature_metadata": null, "reference_id": "pi_3RiZwnE9cSvqiivY0jq3K45T", "payment_link": null, "profile_id": "pro_fql6hf5I69zMoOLyp0gP", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_qTfdo4iBwxJFmMDXJwLD", "incremental_authorization_allowed": true, "authorization_count": 1, "incremental_authorizations": [ { "authorization_id": "auth_qIHwnbG3etLwlil1piKr_1", "amount": 6540, "status": "success", "error_code": null, "error_message": null, "previously_authorized_amount": 1000 } ], "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-07-08T11:59:25.513Z", "fingerprint": null, "browser_info": { "language": "nl-NL", "time_zone": 0, "ip_address": "127.0.0.1", "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "color_depth": 24, "java_enabled": true, "screen_width": 1536, "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8", "screen_height": 723, "java_script_enabled": true }, "payment_method_id": null, "payment_method_status": null, "updated": "2025-07-08T11:44:36.093Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` Cypress test screenshot: <img width="598" height="399" alt="Screenshot 2025-07-28 at 3 42 50 PM" src="https://github.com/user-attachments/assets/41928a7b-7f92-4165-a8a9-d2829e59b1cf" /> ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.116.0	00b792d8d1027e2997f5e7df7d11d3e072b81aa0	00b792d8d1027e2997f5e7df7d11d3e072b81aa0
juspay/hyperswitch	juspay__hyperswitch-8629	Bug: [FIX]: Make v2 endpoints follow standard API conventions There are a lot of minor inconsistencies in v2 endpoints. Fix them in accordance with https://google.aip.dev/general	diff --git a/api-reference/v2/openapi_spec_v2.json b/api-reference/v2/openapi_spec_v2.json index 1bce9a47e29..266aa6cec95 100644 --- a/api-reference/v2/openapi_spec_v2.json +++ b/api-reference/v2/openapi_spec_v2.json @@ -20,7 +20,7 @@ } ], "paths": { - "/v2/organization": { + "/v2/organizations": { "post": { "tags": [ "Organization" @@ -67,7 +67,7 @@ ] } }, - "/v2/organization/{id}": { + "/v2/organizations/{id}": { "get": { "tags": [ "Organization" @@ -164,7 +164,7 @@ ] } }, - "/v2/organization/{id}/merchant-accounts": { + "/v2/organizations/{id}/merchant-accounts": { "get": { "tags": [ "Organization" @@ -1220,7 +1220,7 @@ ] } }, - "/v2/routing-algorithm": { + "/v2/routing-algorithms": { "post": { "tags": [ "Routing" @@ -1275,7 +1275,7 @@ ] } }, - "/v2/routing-algorithm/{id}": { + "/v2/routing-algorithms/{id}": { "get": { "tags": [ "Routing" @@ -2850,7 +2850,7 @@ ] } }, - "/v2/payment-method-session": { + "/v2/payment-method-sessions": { "post": { "tags": [ "Payment Method Session" @@ -2897,7 +2897,7 @@ ] } }, - "/v2/payment-method-session/{id}": { + "/v2/payment-method-sessions/{id}": { "get": { "tags": [ "Payment Method Session" @@ -2994,7 +2994,7 @@ ] } }, - "/v2/payment-method-session/{id}/list-payment-methods": { + "/v2/payment-method-sessions/{id}/list-payment-methods": { "get": { "tags": [ "Payment Method Session" @@ -3035,7 +3035,7 @@ ] } }, - "/v2/payment-method-session/{id}/update-saved-payment-method": { + "/v2/payment-method-sessions/{id}/update-saved-payment-method": { "put": { "tags": [ "Payment Method Session" @@ -3098,7 +3098,7 @@ ] } }, - "/v2/payment-method-session/{id}/confirm": { + "/v2/payment-method-sessions/{id}/confirm": { "post": { "tags": [ "Payment Method Session" @@ -3241,7 +3241,7 @@ ] } }, - "/v2/refunds/{id}/update_metadata": { + "/v2/refunds/{id}/update-metadata": { "put": { "tags": [ "Refunds" @@ -3377,7 +3377,7 @@ ] } }, - "/v2/process_tracker/revenue_recovery_workflow/{revenue_recovery_id}": { + "/v2/process-trackers/revenue-recovery-workflow/{revenue_recovery_id}": { "get": { "tags": [ "Revenue Recovery" diff --git a/api-reference/v2/organization/organization--create.mdx b/api-reference/v2/organization/organization--create.mdx index 07f4e13222b..4ccc77f2b4b 100644 --- a/api-reference/v2/organization/organization--create.mdx +++ b/api-reference/v2/organization/organization--create.mdx @@ -1,3 +1,3 @@ --- -openapi: post /v2/organization +openapi: post /v2/organizations --- \ No newline at end of file diff --git a/api-reference/v2/organization/organization--merchant-account--list.mdx b/api-reference/v2/organization/organization--merchant-account--list.mdx index 9a03e8713d1..594cc72b13b 100644 --- a/api-reference/v2/organization/organization--merchant-account--list.mdx +++ b/api-reference/v2/organization/organization--merchant-account--list.mdx @@ -1,3 +1,3 @@ --- -openapi: get /v2/organization/{id}/merchant-accounts +openapi: get /v2/organizations/{id}/merchant-accounts --- \ No newline at end of file diff --git a/api-reference/v2/organization/organization--retrieve.mdx b/api-reference/v2/organization/organization--retrieve.mdx index ba06f4cfb66..d49e4db37aa 100644 --- a/api-reference/v2/organization/organization--retrieve.mdx +++ b/api-reference/v2/organization/organization--retrieve.mdx @@ -1,3 +1,3 @@ --- -openapi: get /v2/organization/{id} +openapi: get /v2/organizations/{id} --- \ No newline at end of file diff --git a/api-reference/v2/organization/organization--update.mdx b/api-reference/v2/organization/organization--update.mdx index c365eb093f7..1fd238c28f8 100644 --- a/api-reference/v2/organization/organization--update.mdx +++ b/api-reference/v2/organization/organization--update.mdx @@ -1,3 +1,3 @@ --- -openapi: put /v2/organization/{id} +openapi: put /v2/organizations/{id} --- \ No newline at end of file diff --git a/api-reference/v2/payment-method-session/payment-method-session--confirm-a-payment-method-session.mdx b/api-reference/v2/payment-method-session/payment-method-session--confirm-a-payment-method-session.mdx index ed9cec389da..06094779532 100644 --- a/api-reference/v2/payment-method-session/payment-method-session--confirm-a-payment-method-session.mdx +++ b/api-reference/v2/payment-method-session/payment-method-session--confirm-a-payment-method-session.mdx @@ -1,3 +1,3 @@ --- -openapi: post /v2/payment-method-session/{id}/confirm +openapi: post /v2/payment-method-sessions/{id}/confirm --- \ No newline at end of file diff --git a/api-reference/v2/payment-method-session/payment-method-session--create.mdx b/api-reference/v2/payment-method-session/payment-method-session--create.mdx index b75390a47d1..ad6de7041ae 100644 --- a/api-reference/v2/payment-method-session/payment-method-session--create.mdx +++ b/api-reference/v2/payment-method-session/payment-method-session--create.mdx @@ -1,3 +1,3 @@ --- -openapi: post /v2/payment-method-session +openapi: post /v2/payment-method-sessions --- diff --git a/api-reference/v2/payment-method-session/payment-method-session--delete-a-saved-payment-method.mdx b/api-reference/v2/payment-method-session/payment-method-session--delete-a-saved-payment-method.mdx index a4bcd483c6b..cb438fe1b4f 100644 --- a/api-reference/v2/payment-method-session/payment-method-session--delete-a-saved-payment-method.mdx +++ b/api-reference/v2/payment-method-session/payment-method-session--delete-a-saved-payment-method.mdx @@ -1,3 +1,3 @@ --- -openapi: delete /v2/payment-method-session/{id} +openapi: delete /v2/payment-method-sessions/{id} --- diff --git a/api-reference/v2/payment-method-session/payment-method-session--list-payment-methods.mdx b/api-reference/v2/payment-method-session/payment-method-session--list-payment-methods.mdx index 1dc6cc5eb34..c0077283180 100644 --- a/api-reference/v2/payment-method-session/payment-method-session--list-payment-methods.mdx +++ b/api-reference/v2/payment-method-session/payment-method-session--list-payment-methods.mdx @@ -1,3 +1,3 @@ --- -openapi: get /v2/payment-method-session/{id}/list-payment-methods +openapi: get /v2/payment-method-sessions/{id}/list-payment-methods --- \ No newline at end of file diff --git a/api-reference/v2/payment-method-session/payment-method-session--retrieve.mdx b/api-reference/v2/payment-method-session/payment-method-session--retrieve.mdx index 4e504390a45..a6f77047a74 100644 --- a/api-reference/v2/payment-method-session/payment-method-session--retrieve.mdx +++ b/api-reference/v2/payment-method-session/payment-method-session--retrieve.mdx @@ -1,3 +1,3 @@ --- -openapi: get /v2/payment-method-session/{id} +openapi: get /v2/payment-method-sessions/{id} --- \ No newline at end of file diff --git a/api-reference/v2/payment-method-session/payment-method-session--update-a-saved-payment-method.mdx b/api-reference/v2/payment-method-session/payment-method-session--update-a-saved-payment-method.mdx index f7e887dbb96..8d42dac66b2 100644 --- a/api-reference/v2/payment-method-session/payment-method-session--update-a-saved-payment-method.mdx +++ b/api-reference/v2/payment-method-session/payment-method-session--update-a-saved-payment-method.mdx @@ -1,3 +1,3 @@ --- -openapi: put /v2/payment-method-session/{id}/update-saved-payment-method +openapi: put /v2/payment-method-sessions/{id}/update-saved-payment-method --- diff --git a/api-reference/v2/revenue-recovery/revenue-recovery--retrieve.mdx b/api-reference/v2/revenue-recovery/revenue-recovery--retrieve.mdx index 119f750a7ac..aed5332391c 100644 --- a/api-reference/v2/revenue-recovery/revenue-recovery--retrieve.mdx +++ b/api-reference/v2/revenue-recovery/revenue-recovery--retrieve.mdx @@ -1,3 +1,3 @@ --- -openapi: get /v2/process_tracker/revenue_recovery_workflow/{revenue_recovery_id} +openapi: get /v2/process-trackers/revenue-recovery-workflow/{revenue_recovery_id} --- \ No newline at end of file diff --git a/api-reference/v2/routing/routing--create.mdx b/api-reference/v2/routing/routing--create.mdx index 438abd8e231..74a59ae3971 100644 --- a/api-reference/v2/routing/routing--create.mdx +++ b/api-reference/v2/routing/routing--create.mdx @@ -1,3 +1,3 @@ --- -openapi: post /v2/routing-algorithm +openapi: post /v2/routing-algorithms --- \ No newline at end of file diff --git a/api-reference/v2/routing/routing--retrieve.mdx b/api-reference/v2/routing/routing--retrieve.mdx index 10db0200e18..85efd57b9c8 100644 --- a/api-reference/v2/routing/routing--retrieve.mdx +++ b/api-reference/v2/routing/routing--retrieve.mdx @@ -1,3 +1,3 @@ --- -openapi: get /v2/routing-algorithm/{id} +openapi: get /v2/routing-algorithms/{id} --- \ No newline at end of file diff --git a/crates/hyperswitch_connectors/src/connectors/hyperswitch_vault.rs b/crates/hyperswitch_connectors/src/connectors/hyperswitch_vault.rs index d7e0e93c592..e6007d1e249 100644 --- a/crates/hyperswitch_connectors/src/connectors/hyperswitch_vault.rs +++ b/crates/hyperswitch_connectors/src/connectors/hyperswitch_vault.rs @@ -85,7 +85,7 @@ impl ConnectorIntegration<ExternalVaultCreateFlow, VaultRequestData, VaultRespon connectors: &Connectors, ) -> CustomResult<String, errors::ConnectorError> { Ok(format!( - "{}/v2/payment-methods-session", + "{}/v2/payment-method-sessions", self.base_url(connectors) )) } diff --git a/crates/openapi/src/routes/organization.rs b/crates/openapi/src/routes/organization.rs index d677131d5db..832b203729d 100644 --- a/crates/openapi/src/routes/organization.rs +++ b/crates/openapi/src/routes/organization.rs @@ -77,7 +77,7 @@ pub async fn organization_update() {} /// Create a new organization #[utoipa::path( post, - path = "/v2/organization", + path = "/v2/organizations", request_body( content = OrganizationCreateRequest, examples( @@ -104,7 +104,7 @@ pub async fn organization_create() {} /// Retrieve an existing organization #[utoipa::path( get, - path = "/v2/organization/{id}", + path = "/v2/organizations/{id}", params (("id" = String, Path, description = "The unique identifier for the Organization")), responses( (status = 200, description = "Organization Created", body =OrganizationResponse), @@ -122,7 +122,7 @@ pub async fn organization_retrieve() {} /// Create a new organization for . #[utoipa::path( put, - path = "/v2/organization/{id}", + path = "/v2/organizations/{id}", request_body( content = OrganizationUpdateRequest, examples( @@ -150,7 +150,7 @@ pub async fn organization_update() {} /// List merchant accounts for an Organization #[utoipa::path( get, - path = "/v2/organization/{id}/merchant-accounts", + path = "/v2/organizations/{id}/merchant-accounts", params (("id" = String, Path, description = "The unique identifier for the Organization")), responses( (status = 200, description = "Merchant Account list retrieved successfully", body = Vec<MerchantAccountResponse>), diff --git a/crates/openapi/src/routes/payment_method.rs b/crates/openapi/src/routes/payment_method.rs index 0cfcde2cb7e..3f0ed7d799e 100644 --- a/crates/openapi/src/routes/payment_method.rs +++ b/crates/openapi/src/routes/payment_method.rs @@ -353,7 +353,7 @@ pub async fn list_customer_payment_method_api() {} #[cfg(feature = "v2")] #[utoipa::path( post, - path = "/v2/payment-method-session", + path = "/v2/payment-method-sessions", request_body( content = PaymentMethodSessionRequest, examples (( "Create a payment method session with customer_id" = ( @@ -378,7 +378,7 @@ pub fn payment_method_session_create() {} #[cfg(feature = "v2")] #[utoipa::path( get, - path = "/v2/payment-method-session/{id}", + path = "/v2/payment-method-sessions/{id}", params ( ("id" = String, Path, description = "The unique identifier for the Payment Method Session"), ), @@ -399,7 +399,7 @@ pub fn payment_method_session_retrieve() {} #[cfg(feature = "v2")] #[utoipa::path( get, - path = "/v2/payment-method-session/{id}/list-payment-methods", + path = "/v2/payment-method-sessions/{id}/list-payment-methods", params ( ("id" = String, Path, description = "The unique identifier for the Payment Method Session"), ), @@ -419,7 +419,7 @@ pub fn payment_method_session_list_payment_methods() {} #[cfg(feature = "v2")] #[utoipa::path( put, - path = "/v2/payment-method-session/{id}/update-saved-payment-method", + path = "/v2/payment-method-sessions/{id}/update-saved-payment-method", params ( ("id" = String, Path, description = "The unique identifier for the Payment Method Session"), ), @@ -453,7 +453,7 @@ pub fn payment_method_session_update_saved_payment_method() {} #[cfg(feature = "v2")] #[utoipa::path( delete, - path = "/v2/payment-method-session/{id}", + path = "/v2/payment-method-sessions/{id}", params ( ("id" = String, Path, description = "The unique identifier for the Payment Method Session"), ), @@ -520,7 +520,7 @@ pub async fn tokenize_card_using_pm_api() {} /// Confirms a payment method session object with the payment method data #[utoipa::path( post, - path = "/v2/payment-method-session/{id}/confirm", + path = "/v2/payment-method-sessions/{id}/confirm", params (("id" = String, Path, description = "The unique identifier for the Payment Method Session"), ( "X-Profile-Id" = String, Header, diff --git a/crates/openapi/src/routes/refunds.rs b/crates/openapi/src/routes/refunds.rs index f33369d3888..be8c63e4696 100644 --- a/crates/openapi/src/routes/refunds.rs +++ b/crates/openapi/src/routes/refunds.rs @@ -221,7 +221,7 @@ pub async fn refunds_create() {} /// Updates the properties of a Refund object. This API can be used to attach a reason for the refund or metadata fields #[utoipa::path( put, - path = "/v2/refunds/{id}/update_metadata", + path = "/v2/refunds/{id}/update-metadata", params( ("id" = String, Path, description = "The identifier for refund") ), diff --git a/crates/openapi/src/routes/revenue_recovery.rs b/crates/openapi/src/routes/revenue_recovery.rs index 8e3b2aaf412..0f22b340bd5 100644 --- a/crates/openapi/src/routes/revenue_recovery.rs +++ b/crates/openapi/src/routes/revenue_recovery.rs @@ -4,7 +4,7 @@ /// Retrieve the Revenue Recovery Payment Info #[utoipa::path( get, - path = "/v2/process_tracker/revenue_recovery_workflow/{revenue_recovery_id}", + path = "/v2/process-trackers/revenue-recovery-workflow/{revenue_recovery_id}", params( ("recovery_recovery_id" = String, Path, description = "The payment intent id"), ), diff --git a/crates/openapi/src/routes/routing.rs b/crates/openapi/src/routes/routing.rs index f657915e6a5..78f4c8b187c 100644 --- a/crates/openapi/src/routes/routing.rs +++ b/crates/openapi/src/routes/routing.rs @@ -26,7 +26,7 @@ pub async fn routing_create_config() {} /// Create a routing algorithm #[utoipa::path( post, - path = "/v2/routing-algorithm", + path = "/v2/routing-algorithms", request_body = RoutingConfigRequest, responses( (status = 200, description = "Routing Algorithm created", body = RoutingDictionaryRecord), @@ -92,7 +92,7 @@ pub async fn routing_retrieve_config() {} /// Retrieve a routing algorithm with its algorithm id #[utoipa::path( get, - path = "/v2/routing-algorithm/{id}", + path = "/v2/routing-algorithms/{id}", params( ("id" = String, Path, description = "The unique identifier for a routing algorithm"), ), diff --git a/crates/router/src/lib.rs b/crates/router/src/lib.rs index e002f7fd050..01676a11d49 100644 --- a/crates/router/src/lib.rs +++ b/crates/router/src/lib.rs @@ -210,7 +210,10 @@ pub fn mk_app( #[cfg(feature = "v2")] { - server_app = server_app.service(routes::ProcessTracker::server(state.clone())); + server_app = server_app + .service(routes::UserDeprecated::server(state.clone())) + .service(routes::ProcessTrackerDeprecated::server(state.clone())) + .service(routes::ProcessTracker::server(state.clone())); } } diff --git a/crates/router/src/routes.rs b/crates/router/src/routes.rs index fcf7270fa8a..b8fde79e2a1 100644 --- a/crates/router/src/routes.rs +++ b/crates/router/src/routes.rs @@ -91,8 +91,9 @@ pub use self::app::{ ApiKeys, AppState, ApplePayCertificatesMigration, Authentication, Cache, Cards, Chat, Configs, ConnectorOnboarding, Customers, Disputes, EphemeralKey, FeatureMatrix, Files, Forex, Gsm, Health, Hypersense, Mandates, MerchantAccount, MerchantConnectorAccount, PaymentLink, - PaymentMethods, Payments, Poll, ProcessTracker, Profile, ProfileAcquirer, ProfileNew, Refunds, - Relay, RelayWebhooks, SessionState, ThreeDsDecisionRule, User, Webhooks, + PaymentMethods, Payments, Poll, ProcessTracker, ProcessTrackerDeprecated, Profile, + ProfileAcquirer, ProfileNew, Refunds, Relay, RelayWebhooks, SessionState, ThreeDsDecisionRule, + User, UserDeprecated, Webhooks, }; #[cfg(feature = "olap")] pub use self::app::{Blocklist, Organization, Routing, Verify, WebhookEvents}; diff --git a/crates/router/src/routes/app.rs b/crates/router/src/routes/app.rs index cd132f0da63..d6d10dfe195 100644 --- a/crates/router/src/routes/app.rs +++ b/crates/router/src/routes/app.rs @@ -657,10 +657,15 @@ impl Payments { web::resource("/confirm-intent") .route(web::post().to(payments::payment_confirm_intent)), ) + // TODO: Deprecated. Remove this in favour of /list-attempts .service( web::resource("/list_attempts") .route(web::get().to(payments::list_payment_attempts)), ) + .service( + web::resource("/list-attempts") + .route(web::get().to(payments::list_payment_attempts)), + ) .service( web::resource("/proxy-confirm-intent") .route(web::post().to(payments::proxy_confirm_intent)), @@ -882,7 +887,7 @@ pub struct Routing; #[cfg(all(feature = "olap", feature = "v2"))] impl Routing { pub fn server(state: AppState) -> Scope { - web::scope("/v2/routing-algorithm") + web::scope("/v2/routing-algorithms") .app_data(web::Data::new(state.clone())) .service( web::resource("").route(web::post().to(\|state, req, payload\| { @@ -1242,7 +1247,7 @@ impl Refunds { .route(web::post().to(refunds::refunds_retrieve_with_gateway_creds)), ) .service( - web::resource("/{id}/update_metadata") + web::resource("/{id}/update-metadata") .route(web::put().to(refunds::refunds_metadata_update)), ); } @@ -1412,7 +1417,7 @@ pub struct PaymentMethodSession; #[cfg(all(feature = "v2", feature = "oltp"))] impl PaymentMethodSession { pub fn server(state: AppState) -> Scope { - let mut route = web::scope("/v2/payment-methods-session").app_data(web::Data::new(state)); + let mut route = web::scope("/v2/payment-method-sessions").app_data(web::Data::new(state)); route = route.service( web::resource("") .route(web::post().to(payment_methods::payment_methods_session_create)), @@ -1545,7 +1550,7 @@ impl Organization { #[cfg(all(feature = "v2", feature = "olap"))] impl Organization { pub fn server(state: AppState) -> Scope { - web::scope("/v2/organization") + web::scope("/v2/organizations") .app_data(web::Data::new(state)) .service(web::resource("").route(web::post().to(admin::organization_create))) .service( @@ -2269,11 +2274,12 @@ impl Verify { } } -pub struct User; +pub struct UserDeprecated; #[cfg(all(feature = "olap", feature = "v2"))] -impl User { +impl UserDeprecated { pub fn server(state: AppState) -> Scope { + // TODO: Deprecated. Remove this in favour of /v2/users let mut route = web::scope("/v2/user").app_data(web::Data::new(state)); route = route.service( @@ -2314,6 +2320,51 @@ impl User { } } +pub struct User; + +#[cfg(all(feature = "olap", feature = "v2"))] +impl User { + pub fn server(state: AppState) -> Scope { + let mut route = web::scope("/v2/users").app_data(web::Data::new(state)); + + route = route.service( + web::resource("/create-merchant") + .route(web::post().to(user::user_merchant_account_create)), + ); + route = route.service( + web::scope("/list") + .service( + web::resource("/merchant") + .route(web::get().to(user::list_merchants_for_user_in_org)), + ) + .service( + web::resource("/profile") + .route(web::get().to(user::list_profiles_for_user_in_org_and_merchant)), + ), + ); + + route = route.service( + web::scope("/switch") + .service( + web::resource("/merchant") + .route(web::post().to(user::switch_merchant_for_user_in_org)), + ) + .service( + web::resource("/profile") + .route(web::post().to(user::switch_profile_for_user_in_org_and_merchant)), + ), + ); + + route = route.service( + web::resource("/data") + .route(web::get().to(user::get_multiple_dashboard_metadata)) + .route(web::post().to(user::set_dashboard_metadata)), + ); + + route + } +} + #[cfg(all(feature = "olap", feature = "v1"))] impl User { pub fn server(state: AppState) -> Scope { @@ -2683,6 +2734,23 @@ impl FeatureMatrix { } } +#[cfg(feature = "olap")] +pub struct ProcessTrackerDeprecated; + +#[cfg(all(feature = "olap", feature = "v2"))] +impl ProcessTrackerDeprecated { + pub fn server(state: AppState) -> Scope { + use super::process_tracker::revenue_recovery; + // TODO: Deprecated. Remove this in favour of /v2/process-trackers + web::scope("/v2/process_tracker/revenue_recovery_workflow") + .app_data(web::Data::new(state.clone())) + .service( + web::resource("/{revenue_recovery_id}") + .route(web::get().to(revenue_recovery::revenue_recovery_pt_retrieve_api)), + ) + } +} + #[cfg(feature = "olap")] pub struct ProcessTracker; @@ -2690,7 +2758,7 @@ pub struct ProcessTracker; impl ProcessTracker { pub fn server(state: AppState) -> Scope { use super::process_tracker::revenue_recovery; - web::scope("/v2/process_tracker/revenue_recovery_workflow") + web::scope("/v2/process-trackers/revenue-recovery-workflow") .app_data(web::Data::new(state.clone())) .service( web::resource("/{revenue_recovery_id}") diff --git a/cypress-tests-v2/cypress/support/commands.js b/cypress-tests-v2/cypress/support/commands.js index 54e52495d67..e77a0f65143 100644 --- a/cypress-tests-v2/cypress/support/commands.js +++ b/cypress-tests-v2/cypress/support/commands.js @@ -45,7 +45,7 @@ Cypress.Commands.add( // Define the necessary variables and constants const api_key = globalState.get("adminApiKey"); const base_url = globalState.get("baseUrl"); - const url = `${base_url}/v2/organization`; + const url = `${base_url}/v2/organizations`; // Update request body organizationCreateBody.organization_name += " " + nanoid(); @@ -84,7 +84,7 @@ Cypress.Commands.add("organizationRetrieveCall", (globalState) => { const api_key = globalState.get("adminApiKey"); const base_url = globalState.get("baseUrl"); const organization_id = globalState.get("organizationId"); - const url = `${base_url}/v2/organization/${organization_id}`; + const url = `${base_url}/v2/organizations/${organization_id}`; cy.request({ method: "GET", @@ -125,7 +125,7 @@ Cypress.Commands.add( const api_key = globalState.get("adminApiKey"); const base_url = globalState.get("baseUrl"); const organization_id = globalState.get("organizationId"); - const url = `${base_url}/v2/organization/${organization_id}`; + const url = `${base_url}/v2/organizations/${organization_id}`; // Update request body organizationUpdateBody.organization_name += " " + nanoid(); @@ -805,7 +805,7 @@ Cypress.Commands.add( const api_key = globalState.get("userInfoToken"); const base_url = globalState.get("baseUrl"); const profile_id = globalState.get("profileId"); - const url = `${base_url}/v2/routing-algorithm`; + const url = `${base_url}/v2/routing-algorithms`; // Update request body routingSetupBody.algorithm.data = payload.data; @@ -961,7 +961,7 @@ Cypress.Commands.add("routingRetrieveCall", (globalState) => { const base_url = globalState.get("baseUrl"); const profile_id = globalState.get("profileId"); const routing_algorithm_id = globalState.get("routingAlgorithmId"); - const url = `${base_url}/v2/routing-algorithm/${routing_algorithm_id}`; + const url = `${base_url}/v2/routing-algorithms/${routing_algorithm_id}`; cy.request({ method: "GET", @@ -1170,7 +1170,7 @@ Cypress.Commands.add("merchantAccountsListCall", (globalState) => { const key_id_type = "publishable_key"; const key_id = validateEnv(base_url, key_id_type); const organization_id = globalState.get("organizationId"); - const url = `${base_url}/v2/organization/${organization_id}/merchant-accounts`; + const url = `${base_url}/v2/organizations/${organization_id}/merchant-accounts`; cy.request({ method: "GET",	2025-07-13T22:11:59Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [ ] New feature - [x] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> - Consistently use kebab case in endpoint URLs - Use plural form of resources in URLs, i.e. instead of `/v2/organization`, use `/v2/organizations` Renamed (current version removed) endpoints: `/v2/organization` -> `/v2/organizations` `/v2/routing-algorithm` -> `/v2/routing-algorithms` `/v2/payment-methods-session` -> `/v2/payment-method-sessions` (refunds) `/update_metadata` -> `update-metadata` Duplicated (current version not removed) endpoints: `/v2/user` -> `/v2/users` `/create_merchant` -> `/create-merchant` `/v2/process_tracker/revenue_recovery_workflow` -> `/v2/process-trackers/revenue-recovery-workflow` `/list_attempts` -> `/list-attempts` ### Additional Changes - [x] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> Closes #8629 ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> 1. Organization Request: ``` curl --location 'http://localhost:8080/v2/organizations' \ --header 'Authorization: admin-api-key=test_admin' \ --header 'Content-Type: application/json' \ --data '{ "organization_name": "v2_org_1752571446" }' ``` Response: ```json { "id": "org_4YoqpRWuOelFCr7Lbh2l", "organization_name": "v2_org_1752571419", "organization_details": null, "metadata": null, "modified_at": "2025-07-15 09:23:39.045598", "created_at": "2025-07-15 09:23:39.045496" } ``` 2. Payment Method Sessions: Request: ``` curl --location 'http://localhost:8080/v2/payment-method-sessions' \ --header 'x-profile-id: pro_k5m9OvIbAwRr29ZJrZFN' \ --header 'Authorization: api-key=dev_e0A7pdYme3jeCbLscKnTIXBci4IcuiixFCwaN0H3usrmeVSkKcn5r701nisZsvZc' \ --header 'Content-Type: application/json' \ --header 'api-key: dev_e0A7pdYme3jeCbLscKnTIXBci4IcuiixFCwaN0H3usrmeVSkKcn5r701nisZsvZc' \ --data-raw '{ "customer_id": "12345_cus_01980d66d85c78f28c2f25980c48a60b", "billing": { "address": { "first_name": "John", "last_name": "Dough" }, "email": "[email protected]" } }' ``` Response: ```json { "id": "12345_pms_01980d66e6ab715093173e3078818fc5", "customer_id": "12345_cus_01980d66d85c78f28c2f25980c48a60b", "billing": { "address": { "city": null, "country": null, "line1": null, "line2": null, "line3": null, "zip": null, "state": null, "first_name": "John", "last_name": "Dough" }, "phone": null, "email": "[email protected]" }, "psp_tokenization": null, "network_tokenization": null, "tokenization_data": null, "expires_at": "2025-07-15T09:40:04.299Z", "client_secret": "cs_01980d66e6ab715093173e43f85db63a", "return_url": null, "next_action": null, "authentication_details": null, "associated_payment_methods": null, "associated_token_id": null } ``` ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	53e7e7fa819183eaad1e8321f7e2b89b22867163	53e7e7fa819183eaad1e8321f7e2b89b22867163
juspay/hyperswitch	juspay__hyperswitch-8623	Bug: [BUG] For trust pay in session token card brand is coming as empty so click to pay page is not loading ### Bug Description For trust pay in session token card brand is coming as empty so click to pay page is not loading ### Expected Behavior For trust pay in session token card brand should not come as empty so that click to pay page will load ### Actual Behavior For trust pay in session token card brand is coming as empty so click to pay page is not loading ### Steps To Reproduce Provide an unambiguous set of steps to reproduce this bug. Include code or configuration to reproduce, if relevant. 1. Go to '...' 2. Click on '....' 3. Scroll down to '....' ### Context For The Bug _No response_ ### Environment Are you using hyperswitch hosted version? Yes/No If yes, please provide the value of the `x-request-id` response header to help us debug your issue. If not (or if building/running locally), please provide the following details: 1. Operating System or Linux distribution: 2. Rust version (output of `rustc --version`): `` 3. App version (output of `cargo r --features vergen -- --version`): `` ### Have you spent some time checking if this bug has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? Yes, I am willing to submit a PR!	diff --git a/config/deployments/integration_test.toml b/config/deployments/integration_test.toml index 77775f87bf0..9c85481a235 100644 --- a/config/deployments/integration_test.toml +++ b/config/deployments/integration_test.toml @@ -786,4 +786,4 @@ monitoring_threshold_in_seconds = 2592000 retry_algorithm_type = "cascading" [authentication_providers] -click_to_pay = {connector_list = "adyen, cybersource"} \ No newline at end of file +click_to_pay = {connector_list = "adyen, cybersource, trustpay"} \ No newline at end of file diff --git a/config/deployments/production.toml b/config/deployments/production.toml index 7b0b29e007b..220da03461d 100644 --- a/config/deployments/production.toml +++ b/config/deployments/production.toml @@ -791,7 +791,7 @@ billing_connectors_which_require_payment_sync = "stripebilling, recurly" billing_connectors_which_requires_invoice_sync_call = "recurly" [authentication_providers] -click_to_pay = {connector_list = "adyen, cybersource"} +click_to_pay = {connector_list = "adyen, cybersource, trustpay"} [revenue_recovery] diff --git a/config/deployments/sandbox.toml b/config/deployments/sandbox.toml index 12816d57bf4..efaff9947c1 100644 --- a/config/deployments/sandbox.toml +++ b/config/deployments/sandbox.toml @@ -797,7 +797,7 @@ billing_connectors_which_require_payment_sync = "stripebilling, recurly" billing_connectors_which_requires_invoice_sync_call = "recurly" [authentication_providers] -click_to_pay = {connector_list = "adyen, cybersource"} +click_to_pay = {connector_list = "adyen, cybersource, trustpay"} [revenue_recovery] monitoring_threshold_in_seconds = 2592000 diff --git a/config/development.toml b/config/development.toml index ccc9d7af32d..605873bbe8f 100644 --- a/config/development.toml +++ b/config/development.toml @@ -1204,7 +1204,7 @@ enabled = true allow_connected_merchants = true [authentication_providers] -click_to_pay = {connector_list = "adyen, cybersource"} +click_to_pay = {connector_list = "adyen, cybersource, trustpay"} [open_router] dynamic_routing_enabled = false diff --git a/config/docker_compose.toml b/config/docker_compose.toml index faf1d25e3c7..a972609d592 100644 --- a/config/docker_compose.toml +++ b/config/docker_compose.toml @@ -1116,7 +1116,7 @@ enabled = false hyperswitch_ai_host = "http://0.0.0.0:8000" [authentication_providers] -click_to_pay = {connector_list = "adyen, cybersource"} +click_to_pay = {connector_list = "adyen, cybersource, trustpay"} [revenue_recovery] monitoring_threshold_in_seconds = 2592000 # threshold for monitoring the retry system	2025-07-13T08:29:09Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [x] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD Closes this [issue](https://github.com/juspay/hyperswitch/issues/8623) ## Description <!-- Describe your changes in detail --> Added trustpay in authentication providers config ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> Steps for testing is given in this [PR](https://github.com/juspay/hyperswitch/pull/8304) Screenshot that is showing `card_brands` in Session Call for Trustpay: <img width="653" height="542" alt="Screenshot 2025-07-13 at 2 07 31 PM" src="https://github.com/user-attachments/assets/4249444b-9558-49b3-a257-cabc9219ca19" /> Cypress Screenshot: <img width="1442" height="1932" alt="image (6)" src="https://github.com/user-attachments/assets/e72b900c-a90a-40aa-8230-a6766c75249e" /> ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	8ccaac7c10e9366772e43d34f271d946cc4b3baa	8ccaac7c10e9366772e43d34f271d946cc4b3baa
juspay/hyperswitch	juspay__hyperswitch-8612	Bug: Add support to pass fallback_configs for PL routing in the /routing/evaulate request from hyperswitch	diff --git a/crates/router/src/core/payments/routing.rs b/crates/router/src/core/payments/routing.rs index 7feea3286ca..4bbffcde633 100644 --- a/crates/router/src/core/payments/routing.rs +++ b/crates/router/src/core/payments/routing.rs @@ -442,22 +442,24 @@ pub async fn perform_static_routing_v1( Vec<routing_types::RoutableConnectorChoice>, Option<common_enums::RoutingApproach>, )> { - let algorithm_id = if let Some(id) = algorithm_id { - id - } else { + let get_merchant_fallback_config = \|\| async { #[cfg(feature = "v1")] - let fallback_config = routing::helpers::get_merchant_default_config( + return routing::helpers::get_merchant_default_config( &*state.clone().store, business_profile.get_id().get_string_repr(), &api_enums::TransactionType::from(transaction_data), ) .await - .change_context(errors::RoutingError::FallbackConfigFetchFailed)?; + .change_context(errors::RoutingError::FallbackConfigFetchFailed); #[cfg(feature = "v2")] - let fallback_config = admin::ProfileWrapper::new(business_profile.clone()) + return admin::ProfileWrapper::new(business_profile.clone()) .get_default_fallback_list_of_connector_under_profile() - .change_context(errors::RoutingError::FallbackConfigFetchFailed)?; - + .change_context(errors::RoutingError::FallbackConfigFetchFailed); + }; + let algorithm_id = if let Some(id) = algorithm_id { + id + } else { + let fallback_config = get_merchant_fallback_config().await?; return Ok((fallback_config, None)); }; let cached_algorithm = ensure_algorithm_cached_v1( @@ -507,7 +509,8 @@ pub async fn perform_static_routing_v1( state, backend_input.clone(), business_profile.get_id().get_string_repr().to_string(), - routing_events_wrapper + routing_events_wrapper, + get_merchant_fallback_config().await?, ) .await .map_err(\|e\| diff --git a/crates/router/src/core/payments/routing/utils.rs b/crates/router/src/core/payments/routing/utils.rs index d2167f88498..d217cc04360 100644 --- a/crates/router/src/core/payments/routing/utils.rs +++ b/crates/router/src/core/payments/routing/utils.rs @@ -298,12 +298,21 @@ pub async fn perform_decision_euclid_routing( input: BackendInput, created_by: String, events_wrapper: RoutingEventsWrapper<RoutingEvaluateRequest>, + fallback_output: Vec<RoutableConnectorChoice>, ) -> RoutingResult<Vec<RoutableConnectorChoice>> { logger::debug!("decision_engine_euclid: evaluate api call for euclid routing evaluation"); let mut events_wrapper = events_wrapper; + let fallback_output = fallback_output + .into_iter() + .map(\|c\| DeRoutableConnectorChoice { + gateway_name: c.connector, + gateway_id: c.merchant_connector_id, + }) + .collect::<Vec<_>>(); - let routing_request = convert_backend_input_to_routing_eval(created_by, input)?; + let routing_request = + convert_backend_input_to_routing_eval(created_by, input, fallback_output)?; events_wrapper.set_request_body(routing_request.clone()); let event_response = EuclidApiClient::send_decision_engine_request( @@ -515,6 +524,7 @@ pub struct ListRountingAlgorithmsRequest { pub fn convert_backend_input_to_routing_eval( created_by: String, input: BackendInput, + fallback_output: Vec<DeRoutableConnectorChoice>, ) -> RoutingResult<RoutingEvaluateRequest> { let mut params: HashMap<String, Option<ValueType>> = HashMap::new(); @@ -631,6 +641,7 @@ pub fn convert_backend_input_to_routing_eval( Ok(RoutingEvaluateRequest { created_by, parameters: params, + fallback_output, }) } @@ -677,6 +688,7 @@ impl DecisionEngineErrorsInterface for or_types::ErrorResponse { pub struct RoutingEvaluateRequest { pub created_by: String, pub parameters: HashMap<String, Option<ValueType>>, + pub fallback_output: Vec<DeRoutableConnectorChoice>, } #[derive(Debug, serde::Serialize, serde::Deserialize, Clone)] @@ -690,7 +702,7 @@ pub struct RoutingEvaluateResponse { } /// Routable Connector chosen for a payment -#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)] +#[derive(Debug, Clone, PartialEq, serde::Serialize, serde::Deserialize)] pub struct DeRoutableConnectorChoice { pub gateway_name: common_enums::RoutableConnectors, pub gateway_id: Option<id_type::MerchantConnectorAccountId>,	2025-07-11T11:51:03Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [ ] New feature - [X] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> Decision engine does not have the concept of fallback connectors, so we recently added support to handle the default connectors by allowing them to be passed in the evaluate request. As part of this PR we are making the necessary changes to pass fallback connectors to decision engine ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> On making a payment from hyperswitch, with the routing rules defined and activated already. We will be passing the fallback_output to the decision engine <img width="1038" height="379" alt="Screenshot 2025-07-14 at 6 51 45 PM" src="https://github.com/user-attachments/assets/59540f64-00e6-475f-b528-a19ea0f71411" /> ## Checklist <!-- Put an `x` in the boxes that apply --> - [ ] I formatted the code `cargo +nightly fmt --all` - [ ] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	8a7590cf60a0610863e7b6ef8a3c4b780ba03a85	8a7590cf60a0610863e7b6ef8a3c4b780ba03a85
juspay/hyperswitch	juspay__hyperswitch-8620	Bug: [REFACTOR] Create and use a domain type for profile ID ### Feature Description Create a domain type for business profile ID and use the domain type throughout the codebase. The expected result at the end of this change is that profile IDs are never used as strings directly anywhere in the codebase. - Introduce a trait `GenerateId` for generating IDs - Set the max_length attribute of profile_id in the API models to 64 ### Possible Implementation Introduce the profile_id id_type, and use it throughout the codebase ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? None	diff --git a/Cargo.lock b/Cargo.lock index d2c3baf9fba..65d75aa4d81 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -2094,6 +2094,7 @@ name = "connector_configs" version = "0.1.0" dependencies = [ "api_models", + "common_utils", "serde", "serde_with", "toml 0.8.12", diff --git a/api-reference-v2/openapi_spec.json b/api-reference-v2/openapi_spec.json index af1186ac9ed..9c946eb1654 100644 --- a/api-reference-v2/openapi_spec.json +++ b/api-reference-v2/openapi_spec.json @@ -7529,7 +7529,8 @@ }, "profile_id": { "type": "string", - "description": "Identifier for the business profile, if not provided default will be chosen from merchant account" + "description": "Identifier for the business profile, if not provided default will be chosen from merchant account", + "maxLength": 64 }, "connector_account_details": { "allOf": [ diff --git a/api-reference/openapi_spec.json b/api-reference/openapi_spec.json index 83a505746ef..bf0f2c5c446 100644 --- a/api-reference/openapi_spec.json +++ b/api-reference/openapi_spec.json @@ -7366,7 +7366,7 @@ }, "profile_id": { "type": "string", - "description": "The default business profile that must be used for creating merchant accounts and payments", + "description": "The identifier for business profile. This must be used for creating merchant accounts, payments and payouts", "example": "pro_abcdefghijklmnopqrstuvwxyz", "maxLength": 64 }, @@ -12004,7 +12004,7 @@ }, "default_profile": { "type": "string", - "description": "The default business profile that must be used for creating merchant accounts and payments\nTo unset this field, pass an empty string", + "description": "The default business profile that must be used for creating merchant accounts and payments", "nullable": true, "maxLength": 64 }, @@ -12042,7 +12042,8 @@ "profile_id": { "type": "string", "description": "Identifier for the business profile, if not provided default will be chosen from merchant account", - "nullable": true + "nullable": true, + "maxLength": 64 }, "connector_account_details": { "allOf": [ diff --git a/crates/api_models/src/admin.rs b/crates/api_models/src/admin.rs index 18ad5dbf844..a23b891f65e 100644 --- a/crates/api_models/src/admin.rs +++ b/crates/api_models/src/admin.rs @@ -330,9 +330,8 @@ pub struct MerchantAccountUpdate { pub frm_routing_algorithm: Option<serde_json::Value>, /// The default business profile that must be used for creating merchant accounts and payments - /// To unset this field, pass an empty string - #[schema(max_length = 64)] - pub default_profile: Option<String>, + #[schema(max_length = 64, value_type = Option<String>)] + pub default_profile: Option<id_type::ProfileId>, /// Default payment method collect link config #[schema(value_type = Option<BusinessCollectLinkConfig>)] @@ -526,8 +525,8 @@ pub struct MerchantAccountResponse { pub is_recon_enabled: bool, /// The default business profile that must be used for creating merchant accounts and payments - #[schema(max_length = 64)] - pub default_profile: Option<String>, + #[schema(max_length = 64, value_type = Option<String>)] + pub default_profile: Option<id_type::ProfileId>, /// Used to indicate the status of the recon module for a merchant account #[schema(value_type = ReconStatus, example = "not_requested")] @@ -699,7 +698,8 @@ pub struct MerchantConnectorCreate { pub connector_label: Option<String>, /// Identifier for the business profile, if not provided default will be chosen from merchant account - pub profile_id: String, + #[schema(max_length = 64, value_type = String)] + pub profile_id: id_type::ProfileId, /// An object containing the required details/credentials for a Connector account. #[schema(value_type = Option<MerchantConnectorDetails>,example = json!({ "auth_type": "HeaderKey","api_key": "Basic MyVerySecretApiKey" }))] @@ -829,7 +829,8 @@ pub struct MerchantConnectorCreate { pub connector_label: Option<String>, /// Identifier for the business profile, if not provided default will be chosen from merchant account - pub profile_id: Option<String>, + #[schema(max_length = 64, value_type = Option<String>)] + pub profile_id: Option<id_type::ProfileId>, /// An object containing the required details/credentials for a Connector account. #[schema(value_type = Option<MerchantConnectorDetails>,example = json!({ "auth_type": "HeaderKey","api_key": "Basic MyVerySecretApiKey" }))] @@ -1063,8 +1064,8 @@ pub struct MerchantConnectorResponse { pub id: String, /// Identifier for the business profile, if not provided default will be chosen from merchant account - #[schema(max_length = 64)] - pub profile_id: String, + #[schema(max_length = 64, value_type = String)] + pub profile_id: id_type::ProfileId, /// An object containing the required details/credentials for a Connector account. #[schema(value_type = Option<MerchantConnectorDetails>,example = json!({ "auth_type": "HeaderKey","api_key": "Basic MyVerySecretApiKey" }))] @@ -1170,8 +1171,8 @@ pub struct MerchantConnectorResponse { pub merchant_connector_id: String, /// Identifier for the business profile, if not provided default will be chosen from merchant account - #[schema(max_length = 64)] - pub profile_id: String, + #[schema(max_length = 64, value_type = String)] + pub profile_id: id_type::ProfileId, /// An object containing the required details/credentials for a Connector account. #[schema(value_type = Option<MerchantConnectorDetails>,example = json!({ "auth_type": "HeaderKey","api_key": "Basic MyVerySecretApiKey" }))] @@ -1294,8 +1295,8 @@ pub struct MerchantConnectorListResponse { pub merchant_connector_id: String, /// Identifier for the business profile, if not provided default will be chosen from merchant account - #[schema(max_length = 64)] - pub profile_id: String, + #[schema(max_length = 64, value_type = String)] + pub profile_id: id_type::ProfileId, /// An object containing the details about the payment methods that need to be enabled under this merchant connector account #[schema(example = json!([ @@ -1403,8 +1404,8 @@ pub struct MerchantConnectorListResponse { pub id: String, /// Identifier for the business profile, if not provided default will be chosen from merchant account - #[schema(max_length = 64)] - pub profile_id: String, + #[schema(max_length = 64, value_type = String)] + pub profile_id: id_type::ProfileId, /// An object containing the details about the payment methods that need to be enabled under this merchant connector account #[schema(example = json!([ @@ -2076,9 +2077,9 @@ pub struct BusinessProfileResponse { #[schema(max_length = 64, example = "y3oqhf46pyzuxjbcn2giaqnb44", value_type = String)] pub merchant_id: id_type::MerchantId, - /// The default business profile that must be used for creating merchant accounts and payments - #[schema(max_length = 64, example = "pro_abcdefghijklmnopqrstuvwxyz")] - pub profile_id: String, + /// The identifier for business profile. This must be used for creating merchant accounts, payments and payouts + #[schema(max_length = 64, value_type = String, example = "pro_abcdefghijklmnopqrstuvwxyz")] + pub profile_id: id_type::ProfileId, /// Name of the business profile #[schema(max_length = 64)] @@ -2193,8 +2194,8 @@ pub struct BusinessProfileResponse { pub merchant_id: id_type::MerchantId, /// The identifier for business profile. This must be used for creating merchant accounts, payments and payouts - #[schema(max_length = 64, example = "pro_abcdefghijklmnopqrstuvwxyz")] - pub id: String, + #[schema(max_length = 64, value_type = String, example = "pro_abcdefghijklmnopqrstuvwxyz")] + pub id: id_type::ProfileId, /// Name of the business profile #[schema(max_length = 64)] diff --git a/crates/api_models/src/connector_onboarding.rs b/crates/api_models/src/connector_onboarding.rs index 1ed18392dcb..de4b8843dfc 100644 --- a/crates/api_models/src/connector_onboarding.rs +++ b/crates/api_models/src/connector_onboarding.rs @@ -15,7 +15,7 @@ pub enum ActionUrlResponse { #[derive(serde::Deserialize, serde::Serialize, Debug, Clone)] pub struct OnboardingSyncRequest { - pub profile_id: String, + pub profile_id: common_utils::id_type::ProfileId, pub connector_id: String, pub connector: enums::Connector, } diff --git a/crates/api_models/src/disputes.rs b/crates/api_models/src/disputes.rs index e4c38cef860..5e9db4cdfd1 100644 --- a/crates/api_models/src/disputes.rs +++ b/crates/api_models/src/disputes.rs @@ -44,7 +44,8 @@ pub struct DisputeResponse { #[serde(with = "common_utils::custom_serde::iso8601")] pub created_at: PrimitiveDateTime, /// The `profile_id` associated with the dispute - pub profile_id: Option<String>, + #[schema(value_type = Option<String>)] + pub profile_id: Option<common_utils::id_type::ProfileId>, /// The `merchant_connector_id` of the connector / processor through which the dispute was processed pub merchant_connector_id: Option<String>, } @@ -109,7 +110,8 @@ pub struct DisputeListConstraints { /// limit on the number of objects to return pub limit: Option<i64>, /// The identifier for business profile - pub profile_id: Option<String>, + #[schema(value_type = Option<String>)] + pub profile_id: Option<common_utils::id_type::ProfileId>, /// status of the dispute pub dispute_status: Option<DisputeStatus>, /// stage of the dispute diff --git a/crates/api_models/src/payments.rs b/crates/api_models/src/payments.rs index 5ccde3e6d74..9f782841f1d 100644 --- a/crates/api_models/src/payments.rs +++ b/crates/api_models/src/payments.rs @@ -480,7 +480,8 @@ pub struct PaymentsRequest { /// The business profile to be used for this payment, if not passed the default business profile associated with the merchant account will be used. It is mandatory in case multiple business profiles have been set up. #[remove_in(PaymentsUpdateRequest, PaymentsConfirmRequest)] - pub profile_id: Option<String>, + #[schema(value_type = Option<String>)] + pub profile_id: Option<id_type::ProfileId>, #[remove_in(PaymentsConfirmRequest)] #[schema(value_type = Option<RequestSurchargeDetails>)] @@ -3808,7 +3809,8 @@ pub struct PaymentsResponse { /// Details for Payment link pub payment_link: Option<PaymentLinkResponse>, /// The business profile that is associated with this payment - pub profile_id: Option<String>, + #[schema(value_type = Option<String>)] + pub profile_id: Option<id_type::ProfileId>, /// Details of surcharge applied on this payment pub surcharge_details: Option<RequestSurchargeDetails>, @@ -4024,7 +4026,7 @@ pub struct PaymentListFilterConstraints { /// The identifier for payment pub payment_id: Option<String>, /// The identifier for business profile - pub profile_id: Option<String>, + pub profile_id: Option<id_type::ProfileId>, /// The identifier for customer pub customer_id: Option<id_type::CustomerId>, /// The limit on the number of objects. The default limit is 10 and max limit is 20 diff --git a/crates/api_models/src/payouts.rs b/crates/api_models/src/payouts.rs index 0010c2988e1..b755a07d7ff 100644 --- a/crates/api_models/src/payouts.rs +++ b/crates/api_models/src/payouts.rs @@ -144,7 +144,8 @@ pub struct PayoutCreateRequest { pub payout_token: Option<String>, /// The business profile to use for this payout, especially if there are multiple business profiles associated with the account, otherwise default business profile associated with the merchant account will be used. - pub profile_id: Option<String>, + #[schema(value_type = Option<String>)] + pub profile_id: Option<id_type::ProfileId>, /// The send method which will be required for processing payouts, check options for better understanding. #[schema(value_type = Option<PayoutSendPriority>, example = "instant")] @@ -481,7 +482,8 @@ pub struct PayoutCreateResponse { pub error_code: Option<String>, /// The business profile that is associated with this payout - pub profile_id: String, + #[schema(value_type = String)] + pub profile_id: id_type::ProfileId, /// Time when the payout was created #[schema(example = "2022-09-10T10:11:12Z")] @@ -685,7 +687,8 @@ pub struct PayoutListFilterConstraints { )] pub payout_id: Option<String>, /// The identifier for business profile - pub profile_id: Option<String>, + #[schema(value_type = Option<String>)] + pub profile_id: Option<id_type::ProfileId>, /// The identifier for customer #[schema(value_type = Option<String>,example = "cus_y3oqhf46pyzuxjbcn2giaqnb44")] pub customer_id: Option<id_type::CustomerId>, diff --git a/crates/api_models/src/refunds.rs b/crates/api_models/src/refunds.rs index dd6f1a22503..656416dce96 100644 --- a/crates/api_models/src/refunds.rs +++ b/crates/api_models/src/refunds.rs @@ -156,7 +156,8 @@ pub struct RefundResponse { #[schema(example = "stripe")] pub connector: String, /// The id of business profile for this refund - pub profile_id: Option<String>, + #[schema(value_type = Option<String>)] + pub profile_id: Option<common_utils::id_type::ProfileId>, /// The merchant_connector_id of the processor through which this payment went through pub merchant_connector_id: Option<String>, /// Charge specific fields for controlling the revert of funds from either platform or connected account @@ -171,7 +172,8 @@ pub struct RefundListRequest { /// The identifier for the refund pub refund_id: Option<String>, /// The identifier for business profile - pub profile_id: Option<String>, + #[schema(value_type = Option<String>)] + pub profile_id: Option<common_utils::id_type::ProfileId>, /// Limit on the number of objects to return pub limit: Option<i64>, /// The starting point within a list of objects diff --git a/crates/api_models/src/routing.rs b/crates/api_models/src/routing.rs index 04ca1fd4429..373319333cb 100644 --- a/crates/api_models/src/routing.rs +++ b/crates/api_models/src/routing.rs @@ -36,7 +36,8 @@ pub struct RoutingConfigRequest { pub name: String, pub description: String, pub algorithm: RoutingAlgorithm, - pub profile_id: String, + #[schema(value_type = String)] + pub profile_id: common_utils::id_type::ProfileId, } #[cfg(all(any(feature = "v1", feature = "v2"), not(feature = "routing_v2")))] @@ -45,12 +46,14 @@ pub struct RoutingConfigRequest { pub name: Option<String>, pub description: Option<String>, pub algorithm: Option<RoutingAlgorithm>, - pub profile_id: Option<String>, + #[schema(value_type = Option<String>)] + pub profile_id: Option<common_utils::id_type::ProfileId>, } #[derive(Debug, serde::Serialize, ToSchema)] pub struct ProfileDefaultRoutingConfig { - pub profile_id: String, + #[schema(value_type = String)] + pub profile_id: common_utils::id_type::ProfileId, pub connectors: Vec<RoutableConnectorChoice>, } @@ -62,13 +65,13 @@ pub struct RoutingRetrieveQuery { #[derive(Debug, serde::Deserialize, serde::Serialize)] pub struct RoutingRetrieveLinkQuery { - pub profile_id: Option<String>, + pub profile_id: Option<common_utils::id_type::ProfileId>, } #[derive(Debug, serde::Deserialize, serde::Serialize)] pub struct RoutingRetrieveLinkQueryWrapper { pub routing_query: RoutingRetrieveQuery, - pub profile_id: String, + pub profile_id: common_utils::id_type::ProfileId, } #[derive(Debug, Clone, serde::Serialize, serde::Deserialize, ToSchema)] /// Response of the retrieved routing configs for a merchant account @@ -87,7 +90,8 @@ pub enum LinkedRoutingConfigRetrieveResponse { /// Routing Algorithm specific to merchants pub struct MerchantRoutingAlgorithm { pub id: String, - pub profile_id: String, + #[schema(value_type = String)] + pub profile_id: common_utils::id_type::ProfileId, pub name: String, pub description: String, pub algorithm: RoutingAlgorithm, @@ -257,10 +261,9 @@ pub enum RoutingAlgorithmKind { } #[derive(Debug, Clone, serde::Serialize, serde::Deserialize)] - pub struct RoutingPayloadWrapper { pub updated_config: Vec<RoutableConnectorChoice>, - pub profile_id: String, + pub profile_id: common_utils::id_type::ProfileId, } #[derive(Debug, Clone, serde::Serialize, serde::Deserialize, ToSchema)] @@ -453,8 +456,8 @@ impl RoutingAlgorithmRef { pub struct RoutingDictionaryRecord { pub id: String, - - pub profile_id: String, + #[schema(value_type = String)] + pub profile_id: common_utils::id_type::ProfileId, pub name: String, pub kind: RoutingAlgorithmKind, pub description: String, @@ -485,6 +488,6 @@ pub struct RoutingAlgorithmId(pub String); #[derive(Debug, Clone, serde::Serialize, serde::Deserialize)] pub struct RoutingLinkWrapper { - pub profile_id: String, + pub profile_id: common_utils::id_type::ProfileId, pub algorithm_id: RoutingAlgorithmId, } diff --git a/crates/api_models/src/user.rs b/crates/api_models/src/user.rs index 9867aba7b39..1fdf47425e2 100644 --- a/crates/api_models/src/user.rs +++ b/crates/api_models/src/user.rs @@ -405,6 +405,6 @@ pub struct ListMerchantsForUserInOrgResponse { #[derive(Debug, serde::Serialize)] pub struct ListProfilesForUserInOrgAndMerchantAccountResponse { - pub profile_id: String, + pub profile_id: id_type::ProfileId, pub profile_name: String, } diff --git a/crates/api_models/src/user/sample_data.rs b/crates/api_models/src/user/sample_data.rs index 6d20b20f369..dc95de913fa 100644 --- a/crates/api_models/src/user/sample_data.rs +++ b/crates/api_models/src/user/sample_data.rs @@ -19,5 +19,5 @@ pub struct SampleDataRequest { pub auth_type: Option<Vec<AuthenticationType>>, pub business_country: Option<CountryAlpha2>, pub business_label: Option<String>, - pub profile_id: Option<String>, + pub profile_id: Option<common_utils::id_type::ProfileId>, } diff --git a/crates/api_models/src/webhook_events.rs b/crates/api_models/src/webhook_events.rs index fa61cc0f253..f9741147cd0 100644 --- a/crates/api_models/src/webhook_events.rs +++ b/crates/api_models/src/webhook_events.rs @@ -26,7 +26,8 @@ pub struct EventListConstraints { pub object_id: Option<String>, /// Filter all events associated with the specified business profile ID. - pub profile_id: Option<String>, + #[schema(value_type = Option<String>)] + pub profile_id: Option<common_utils::id_type::ProfileId>, } #[derive(Debug)] @@ -54,8 +55,8 @@ pub struct EventListItemResponse { pub merchant_id: common_utils::id_type::MerchantId, /// The identifier for the Business Profile. - #[schema(max_length = 64, example = "SqB0zwDGR5wHppWf0bx7GKr1f2")] - pub profile_id: String, + #[schema(max_length = 64, value_type = String, example = "SqB0zwDGR5wHppWf0bx7GKr1f2")] + pub profile_id: common_utils::id_type::ProfileId, /// The identifier for the object (Payment Intent ID, Refund ID, etc.) #[schema(max_length = 64, example = "QHrfd5LUDdZaKtAjdJmMu0dMa1")] diff --git a/crates/common_utils/src/events.rs b/crates/common_utils/src/events.rs index 43777143968..48b2e9d98c0 100644 --- a/crates/common_utils/src/events.rs +++ b/crates/common_utils/src/events.rs @@ -35,6 +35,9 @@ pub enum ApiEventsType { Customer { customer_id: id_type::CustomerId, }, + BusinessProfile { + profile_id: id_type::ProfileId, + }, User { user_id: String, }, diff --git a/crates/common_utils/src/id_type.rs b/crates/common_utils/src/id_type.rs index 55e2e3ffb18..cc4c56d6abb 100644 --- a/crates/common_utils/src/id_type.rs +++ b/crates/common_utils/src/id_type.rs @@ -6,6 +6,7 @@ use std::{borrow::Cow, fmt::Debug}; mod customer; mod merchant; mod organization; +mod profile; mod global_id; @@ -19,6 +20,7 @@ use diesel::{ }; pub use merchant::MerchantId; pub use organization::OrganizationId; +pub use profile::ProfileId; use serde::{Deserialize, Serialize}; use thiserror::Error; @@ -198,6 +200,12 @@ where } } +/// An interface to generate object identifiers. +pub trait GenerateId { + /// Generates a random object identifier. + fn generate() -> Self; +} + #[cfg(test)] mod alphanumeric_id_tests { #![allow(clippy::unwrap_used)] diff --git a/crates/common_utils/src/id_type/customer.rs b/crates/common_utils/src/id_type/customer.rs index 65049125960..9d02f201383 100644 --- a/crates/common_utils/src/id_type/customer.rs +++ b/crates/common_utils/src/id_type/customer.rs @@ -9,6 +9,7 @@ crate::impl_debug_id_type!(CustomerId); crate::impl_default_id_type!(CustomerId, "cus"); crate::impl_try_from_cow_str_id_type!(CustomerId, "customer_id"); +crate::impl_generate_id_id_type!(CustomerId, "cus"); crate::impl_serializable_secret_id_type!(CustomerId); crate::impl_queryable_id_type!(CustomerId); crate::impl_to_sql_from_sql_id_type!(CustomerId); diff --git a/crates/common_utils/src/id_type/merchant.rs b/crates/common_utils/src/id_type/merchant.rs index 8358f39051e..08b80249ae3 100644 --- a/crates/common_utils/src/id_type/merchant.rs +++ b/crates/common_utils/src/id_type/merchant.rs @@ -25,6 +25,7 @@ crate::impl_debug_id_type!(MerchantId); crate::impl_default_id_type!(MerchantId, "mer"); crate::impl_try_from_cow_str_id_type!(MerchantId, "merchant_id"); +crate::impl_generate_id_id_type!(MerchantId, "mer"); crate::impl_serializable_secret_id_type!(MerchantId); crate::impl_queryable_id_type!(MerchantId); crate::impl_to_sql_from_sql_id_type!(MerchantId); diff --git a/crates/common_utils/src/id_type/organization.rs b/crates/common_utils/src/id_type/organization.rs index 336442e6057..f88a62daa1d 100644 --- a/crates/common_utils/src/id_type/organization.rs +++ b/crates/common_utils/src/id_type/organization.rs @@ -9,6 +9,7 @@ crate::impl_debug_id_type!(OrganizationId); crate::impl_default_id_type!(OrganizationId, "org"); crate::impl_try_from_cow_str_id_type!(OrganizationId, "organization_id"); +crate::impl_generate_id_id_type!(OrganizationId, "org"); crate::impl_serializable_secret_id_type!(OrganizationId); crate::impl_queryable_id_type!(OrganizationId); crate::impl_to_sql_from_sql_id_type!(OrganizationId); diff --git a/crates/common_utils/src/id_type/profile.rs b/crates/common_utils/src/id_type/profile.rs new file mode 100644 index 00000000000..e9d90e7bba1 --- /dev/null +++ b/crates/common_utils/src/id_type/profile.rs @@ -0,0 +1,22 @@ +crate::id_type!( + ProfileId, + "A type for profile_id that can be used for business profile ids" +); +crate::impl_id_type_methods!(ProfileId, "profile_id"); + +// This is to display the `ProfileId` as ProfileId(abcd) +crate::impl_debug_id_type!(ProfileId); +crate::impl_try_from_cow_str_id_type!(ProfileId, "profile_id"); + +crate::impl_generate_id_id_type!(ProfileId, "pro"); +crate::impl_serializable_secret_id_type!(ProfileId); +crate::impl_queryable_id_type!(ProfileId); +crate::impl_to_sql_from_sql_id_type!(ProfileId); + +impl crate::events::ApiEventMetric for ProfileId { + fn get_api_event_type(&self) -> Option<crate::events::ApiEventsType> { + Some(crate::events::ApiEventsType::BusinessProfile { + profile_id: self.clone(), + }) + } +} diff --git a/crates/common_utils/src/lib.rs b/crates/common_utils/src/lib.rs index 400da349983..67a67bee5c3 100644 --- a/crates/common_utils/src/lib.rs +++ b/crates/common_utils/src/lib.rs @@ -214,12 +214,23 @@ fn generate_ref_id_with_default_length<const MAX_LENGTH: u8, const MIN_LENGTH: u /// Generate a customer id with default length, with prefix as `cus` pub fn generate_customer_id_of_default_length() -> id_type::CustomerId { - id_type::CustomerId::default() + use id_type::GenerateId; + + id_type::CustomerId::generate() } /// Generate a organization id with default length, with prefix as `org` pub fn generate_organization_id_of_default_length() -> id_type::OrganizationId { - id_type::OrganizationId::default() + use id_type::GenerateId; + + id_type::OrganizationId::generate() +} + +/// Generate a profile id with default length, with prefix as `pro` +pub fn generate_profile_id_of_default_length() -> id_type::ProfileId { + use id_type::GenerateId; + + id_type::ProfileId::generate() } /// Generate a nanoid with the given prefix and a default length diff --git a/crates/common_utils/src/macros.rs b/crates/common_utils/src/macros.rs index 06554ee9b51..94d8074c301 100644 --- a/crates/common_utils/src/macros.rs +++ b/crates/common_utils/src/macros.rs @@ -233,6 +233,18 @@ mod id_type { }; } + /// Implements the `GenerateId` trait on the specified ID type. + #[macro_export] + macro_rules! impl_generate_id_id_type { + ($type:ty, $prefix:literal) => { + impl $crate::id_type::GenerateId for $type { + fn generate() -> Self { + Self($crate::generate_ref_id_with_default_length($prefix)) + } + } + }; + } + /// Implements the `SerializableSecret` trait on the specified ID type. #[macro_export] macro_rules! impl_serializable_secret_id_type { diff --git a/crates/connector_configs/Cargo.toml b/crates/connector_configs/Cargo.toml index 1541a0864cc..1809d755834 100644 --- a/crates/connector_configs/Cargo.toml +++ b/crates/connector_configs/Cargo.toml @@ -17,6 +17,7 @@ payouts = ["api_models/payouts"] [dependencies] # First party crates api_models = { version = "0.1.0", path = "../api_models", package = "api_models" } +common_utils = { version = "0.1.0", path = "../common_utils" } # Third party crates serde = { version = "1.0.197", features = ["derive"] } diff --git a/crates/connector_configs/src/common_config.rs b/crates/connector_configs/src/common_config.rs index 88b8165853d..d0becb80468 100644 --- a/crates/connector_configs/src/common_config.rs +++ b/crates/connector_configs/src/common_config.rs @@ -161,7 +161,7 @@ pub struct Provider { #[serde(rename_all = "snake_case")] pub struct ConnectorApiIntegrationPayload { pub connector_type: String, - pub profile_id: String, + pub profile_id: common_utils::id_type::ProfileId, pub connector_name: api_models::enums::Connector, #[serde(skip_deserializing)] #[schema(example = "stripe_US_travel")] diff --git a/crates/diesel_models/src/authentication.rs b/crates/diesel_models/src/authentication.rs index cb518805ebf..606644255bc 100644 --- a/crates/diesel_models/src/authentication.rs +++ b/crates/diesel_models/src/authentication.rs @@ -41,7 +41,7 @@ pub struct Authentication { pub acs_reference_number: Option<String>, pub acs_trans_id: Option<String>, pub acs_signed_content: Option<String>, - pub profile_id: String, + pub profile_id: common_utils::id_type::ProfileId, pub payment_id: Option<String>, pub merchant_connector_id: String, pub ds_trans_id: Option<String>, @@ -88,7 +88,7 @@ pub struct AuthenticationNew { pub acs_reference_number: Option<String>, pub acs_trans_id: Option<String>, pub acs_signed_content: Option<String>, - pub profile_id: String, + pub profile_id: common_utils::id_type::ProfileId, pub payment_id: Option<String>, pub merchant_connector_id: String, pub ds_trans_id: Option<String>, diff --git a/crates/diesel_models/src/business_profile.rs b/crates/diesel_models/src/business_profile.rs index cab1aec410f..20add83bd2c 100644 --- a/crates/diesel_models/src/business_profile.rs +++ b/crates/diesel_models/src/business_profile.rs @@ -25,7 +25,7 @@ use crate::schema_v2::business_profile; #[derive(Clone, Debug, Identifiable, Queryable, Selectable, router_derive::DebugAsDisplay)] #[diesel(table_name = business_profile, primary_key(profile_id), check_for_backend(diesel::pg::Pg))] pub struct BusinessProfile { - pub profile_id: String, + pub profile_id: common_utils::id_type::ProfileId, pub merchant_id: common_utils::id_type::MerchantId, pub profile_name: String, pub created_at: time::PrimitiveDateTime, @@ -67,7 +67,7 @@ pub struct BusinessProfile { #[derive(Clone, Debug, Insertable, router_derive::DebugAsDisplay)] #[diesel(table_name = business_profile, primary_key(profile_id))] pub struct BusinessProfileNew { - pub profile_id: String, + pub profile_id: common_utils::id_type::ProfileId, pub merchant_id: common_utils::id_type::MerchantId, pub profile_name: String, pub created_at: time::PrimitiveDateTime, @@ -242,7 +242,7 @@ impl BusinessProfileUpdateInternal { #[derive(Clone, Debug, Identifiable, Queryable, Selectable, router_derive::DebugAsDisplay)] #[diesel(table_name = business_profile, primary_key(profile_id), check_for_backend(diesel::pg::Pg))] pub struct BusinessProfile { - pub profile_id: String, + pub profile_id: common_utils::id_type::ProfileId, pub merchant_id: common_utils::id_type::MerchantId, pub profile_name: String, pub created_at: time::PrimitiveDateTime, @@ -283,7 +283,7 @@ pub struct BusinessProfile { #[derive(Clone, Debug, Insertable, router_derive::DebugAsDisplay)] #[diesel(table_name = business_profile, primary_key(profile_id))] pub struct BusinessProfileNew { - pub profile_id: String, + pub profile_id: common_utils::id_type::ProfileId, pub merchant_id: common_utils::id_type::MerchantId, pub profile_name: String, pub created_at: time::PrimitiveDateTime, diff --git a/crates/diesel_models/src/dispute.rs b/crates/diesel_models/src/dispute.rs index 704b1781e2a..14fe16c9826 100644 --- a/crates/diesel_models/src/dispute.rs +++ b/crates/diesel_models/src/dispute.rs @@ -27,7 +27,7 @@ pub struct DisputeNew { pub connector_updated_at: Option<PrimitiveDateTime>, pub connector: String, pub evidence: Option<Secret<serde_json::Value>>, - pub profile_id: Option<String>, + pub profile_id: Option<common_utils::id_type::ProfileId>, pub merchant_connector_id: Option<String>, pub dispute_amount: i64, } @@ -56,7 +56,7 @@ pub struct Dispute { pub modified_at: PrimitiveDateTime, pub connector: String, pub evidence: Secret<serde_json::Value>, - pub profile_id: Option<String>, + pub profile_id: Option<common_utils::id_type::ProfileId>, pub merchant_connector_id: Option<String>, pub dispute_amount: i64, } diff --git a/crates/diesel_models/src/events.rs b/crates/diesel_models/src/events.rs index 20c811654a7..2cc2bfff3b2 100644 --- a/crates/diesel_models/src/events.rs +++ b/crates/diesel_models/src/events.rs @@ -22,7 +22,7 @@ pub struct EventNew { pub primary_object_type: storage_enums::EventObjectType, pub created_at: PrimitiveDateTime, pub merchant_id: Option<common_utils::id_type::MerchantId>, - pub business_profile_id: Option<String>, + pub business_profile_id: Option<common_utils::id_type::ProfileId>, pub primary_object_created_at: Option<PrimitiveDateTime>, pub idempotent_event_id: Option<String>, pub initial_attempt_id: Option<String>, @@ -51,7 +51,7 @@ pub struct Event { #[serde(with = "custom_serde::iso8601")] pub created_at: PrimitiveDateTime, pub merchant_id: Option<common_utils::id_type::MerchantId>, - pub business_profile_id: Option<String>, + pub business_profile_id: Option<common_utils::id_type::ProfileId>, // This column can be used to partition the database table, so that all events related to a // single object would reside in the same partition pub primary_object_created_at: Option<PrimitiveDateTime>, diff --git a/crates/diesel_models/src/file.rs b/crates/diesel_models/src/file.rs index e5ad3568d70..523bb1f26ef 100644 --- a/crates/diesel_models/src/file.rs +++ b/crates/diesel_models/src/file.rs @@ -17,7 +17,7 @@ pub struct FileMetadataNew { pub file_upload_provider: Option<common_enums::FileUploadProvider>, pub available: bool, pub connector_label: Option<String>, - pub profile_id: Option<String>, + pub profile_id: Option<common_utils::id_type::ProfileId>, pub merchant_connector_id: Option<String>, } @@ -36,7 +36,7 @@ pub struct FileMetadata { #[serde(with = "custom_serde::iso8601")] pub created_at: time::PrimitiveDateTime, pub connector_label: Option<String>, - pub profile_id: Option<String>, + pub profile_id: Option<common_utils::id_type::ProfileId>, pub merchant_connector_id: Option<String>, } @@ -46,7 +46,7 @@ pub enum FileMetadataUpdate { provider_file_id: Option<String>, file_upload_provider: Option<common_enums::FileUploadProvider>, available: bool, - profile_id: Option<String>, + profile_id: Option<common_utils::id_type::ProfileId>, merchant_connector_id: Option<String>, }, } @@ -57,7 +57,7 @@ pub struct FileMetadataUpdateInternal { provider_file_id: Option<String>, file_upload_provider: Option<common_enums::FileUploadProvider>, available: bool, - profile_id: Option<String>, + profile_id: Option<common_utils::id_type::ProfileId>, merchant_connector_id: Option<String>, } diff --git a/crates/diesel_models/src/merchant_account.rs b/crates/diesel_models/src/merchant_account.rs index b3ef64b3e3d..ac7635e88c5 100644 --- a/crates/diesel_models/src/merchant_account.rs +++ b/crates/diesel_models/src/merchant_account.rs @@ -52,7 +52,7 @@ pub struct MerchantAccount { pub payout_routing_algorithm: Option<serde_json::Value>, pub organization_id: common_utils::id_type::OrganizationId, pub is_recon_enabled: bool, - pub default_profile: Option<String>, + pub default_profile: Option<common_utils::id_type::ProfileId>, pub recon_status: storage_enums::ReconStatus, pub payment_link_config: Option<serde_json::Value>, pub pm_collect_link_config: Option<serde_json::Value>, @@ -87,7 +87,7 @@ pub struct MerchantAccountSetter { pub payout_routing_algorithm: Option<serde_json::Value>, pub organization_id: common_utils::id_type::OrganizationId, pub is_recon_enabled: bool, - pub default_profile: Option<String>, + pub default_profile: Option<common_utils::id_type::ProfileId>, pub recon_status: storage_enums::ReconStatus, pub payment_link_config: Option<serde_json::Value>, pub pm_collect_link_config: Option<serde_json::Value>, @@ -241,7 +241,7 @@ pub struct MerchantAccountNew { pub payout_routing_algorithm: Option<serde_json::Value>, pub organization_id: common_utils::id_type::OrganizationId, pub is_recon_enabled: bool, - pub default_profile: Option<String>, + pub default_profile: Option<common_utils::id_type::ProfileId>, pub recon_status: storage_enums::ReconStatus, pub payment_link_config: Option<serde_json::Value>, pub pm_collect_link_config: Option<serde_json::Value>, @@ -306,7 +306,7 @@ pub struct MerchantAccountUpdateInternal { pub payout_routing_algorithm: Option<serde_json::Value>, pub organization_id: Option<common_utils::id_type::OrganizationId>, pub is_recon_enabled: Option<bool>, - pub default_profile: Option<Option<String>>, + pub default_profile: Option<Option<common_utils::id_type::ProfileId>>, pub recon_status: Option<storage_enums::ReconStatus>, pub payment_link_config: Option<serde_json::Value>, pub pm_collect_link_config: Option<serde_json::Value>, diff --git a/crates/diesel_models/src/merchant_connector_account.rs b/crates/diesel_models/src/merchant_connector_account.rs index 876240f44a3..61f2af238ed 100644 --- a/crates/diesel_models/src/merchant_connector_account.rs +++ b/crates/diesel_models/src/merchant_connector_account.rs @@ -48,7 +48,7 @@ pub struct MerchantConnectorAccount { pub connector_webhook_details: Option<pii::SecretSerdeValue>, #[diesel(deserialize_as = super::OptionalDieselArray<pii::SecretSerdeValue>)] pub frm_config: Option<Vec<pii::SecretSerdeValue>>, - pub profile_id: Option<String>, + pub profile_id: Option<id_type::ProfileId>, #[diesel(deserialize_as = super::OptionalDieselArray<String>)] pub applepay_verified_domains: Option<Vec<String>>, pub pm_auth_config: Option<pii::SecretSerdeValue>, @@ -95,7 +95,7 @@ pub struct MerchantConnectorAccount { pub connector_webhook_details: Option<pii::SecretSerdeValue>, #[diesel(deserialize_as = super::OptionalDieselArray<pii::SecretSerdeValue>)] pub frm_config: Option<Vec<pii::SecretSerdeValue>>, - pub profile_id: String, + pub profile_id: id_type::ProfileId, #[diesel(deserialize_as = super::OptionalDieselArray<String>)] pub applepay_verified_domains: Option<Vec<String>>, pub pm_auth_config: Option<pii::SecretSerdeValue>, @@ -139,7 +139,7 @@ pub struct MerchantConnectorAccountNew { pub connector_webhook_details: Option<pii::SecretSerdeValue>, #[diesel(deserialize_as = super::OptionalDieselArray<pii::SecretSerdeValue>)] pub frm_config: Option<Vec<pii::SecretSerdeValue>>, - pub profile_id: Option<String>, + pub profile_id: Option<id_type::ProfileId>, #[diesel(deserialize_as = super::OptionalDieselArray<String>)] pub applepay_verified_domains: Option<Vec<String>>, pub pm_auth_config: Option<pii::SecretSerdeValue>, @@ -166,7 +166,7 @@ pub struct MerchantConnectorAccountNew { pub connector_webhook_details: Option<pii::SecretSerdeValue>, #[diesel(deserialize_as = super::OptionalDieselArray<pii::SecretSerdeValue>)] pub frm_config: Option<Vec<pii::SecretSerdeValue>>, - pub profile_id: String, + pub profile_id: id_type::ProfileId, #[diesel(deserialize_as = super::OptionalDieselArray<String>)] pub applepay_verified_domains: Option<Vec<String>>, pub pm_auth_config: Option<pii::SecretSerdeValue>, diff --git a/crates/diesel_models/src/payment_intent.rs b/crates/diesel_models/src/payment_intent.rs index bdea1fe52a7..7bd1652ab56 100644 --- a/crates/diesel_models/src/payment_intent.rs +++ b/crates/diesel_models/src/payment_intent.rs @@ -47,7 +47,7 @@ pub struct PaymentIntent { pub connector_metadata: Option<serde_json::Value>, pub feature_metadata: Option<serde_json::Value>, pub attempt_count: i16, - pub profile_id: Option<String>, + pub profile_id: Option<common_utils::id_type::ProfileId>, // Denotes the action(approve or reject) taken by merchant in case of manual review. // Manual review can occur when the transaction is marked as risky by the frm_processor, payment processor or when there is underpayment/over payment incase of crypto payment pub merchant_decision: Option<String>, @@ -108,7 +108,7 @@ pub struct PaymentIntent { pub connector_metadata: Option<serde_json::Value>, pub feature_metadata: Option<serde_json::Value>, pub attempt_count: i16, - pub profile_id: Option<String>, + pub profile_id: Option<common_utils::id_type::ProfileId>, // Denotes the action(approve or reject) taken by merchant in case of manual review. // Manual review can occur when the transaction is marked as risky by the frm_processor, payment processor or when there is underpayment/over payment incase of crypto payment pub merchant_decision: Option<String>, @@ -170,7 +170,7 @@ pub struct PaymentIntentNew { pub connector_metadata: Option<serde_json::Value>, pub feature_metadata: Option<serde_json::Value>, pub attempt_count: i16, - pub profile_id: Option<String>, + pub profile_id: Option<common_utils::id_type::ProfileId>, pub merchant_decision: Option<String>, pub payment_link_id: Option<String>, pub payment_confirm_source: Option<storage_enums::PaymentSource>, diff --git a/crates/diesel_models/src/payment_link.rs b/crates/diesel_models/src/payment_link.rs index 347a730eb68..51e3b89d605 100644 --- a/crates/diesel_models/src/payment_link.rs +++ b/crates/diesel_models/src/payment_link.rs @@ -23,7 +23,7 @@ pub struct PaymentLink { pub custom_merchant_name: Option<String>, pub payment_link_config: Option<serde_json::Value>, pub description: Option<String>, - pub profile_id: Option<String>, + pub profile_id: Option<common_utils::id_type::ProfileId>, pub secure_link: Option<String>, } @@ -54,6 +54,6 @@ pub struct PaymentLinkNew { pub custom_merchant_name: Option<String>, pub payment_link_config: Option<serde_json::Value>, pub description: Option<String>, - pub profile_id: Option<String>, + pub profile_id: Option<common_utils::id_type::ProfileId>, pub secure_link: Option<String>, } diff --git a/crates/diesel_models/src/payout_attempt.rs b/crates/diesel_models/src/payout_attempt.rs index 17600e0cd78..7e9b2ec4e1c 100644 --- a/crates/diesel_models/src/payout_attempt.rs +++ b/crates/diesel_models/src/payout_attempt.rs @@ -27,7 +27,7 @@ pub struct PayoutAttempt { pub created_at: PrimitiveDateTime, #[serde(with = "common_utils::custom_serde::iso8601")] pub last_modified_at: PrimitiveDateTime, - pub profile_id: String, + pub profile_id: common_utils::id_type::ProfileId, pub merchant_connector_id: Option<String>, pub routing_info: Option<serde_json::Value>, } @@ -59,11 +59,11 @@ pub struct PayoutAttemptNew { pub error_code: Option<String>, pub business_country: Option<storage_enums::CountryAlpha2>, pub business_label: Option<String>, - #[serde(default, with = "common_utils::custom_serde::iso8601::option")] - pub created_at: Option<PrimitiveDateTime>, - #[serde(default, with = "common_utils::custom_serde::iso8601::option")] - pub last_modified_at: Option<PrimitiveDateTime>, - pub profile_id: String, + #[serde(with = "common_utils::custom_serde::iso8601")] + pub created_at: PrimitiveDateTime, + #[serde(with = "common_utils::custom_serde::iso8601")] + pub last_modified_at: PrimitiveDateTime, + pub profile_id: common_utils::id_type::ProfileId, pub merchant_connector_id: Option<String>, pub routing_info: Option<serde_json::Value>, } diff --git a/crates/diesel_models/src/payouts.rs b/crates/diesel_models/src/payouts.rs index cb8f6f9a884..8acdc4a0a5a 100644 --- a/crates/diesel_models/src/payouts.rs +++ b/crates/diesel_models/src/payouts.rs @@ -31,7 +31,7 @@ pub struct Payouts { #[serde(with = "common_utils::custom_serde::iso8601")] pub last_modified_at: PrimitiveDateTime, pub attempt_count: i16, - pub profile_id: String, + pub profile_id: common_utils::id_type::ProfileId, pub status: storage_enums::PayoutStatus, pub confirm: Option<bool>, pub payout_link_id: Option<String>, @@ -72,7 +72,7 @@ pub struct PayoutsNew { #[serde(with = "common_utils::custom_serde::iso8601")] pub last_modified_at: PrimitiveDateTime, pub attempt_count: i16, - pub profile_id: String, + pub profile_id: common_utils::id_type::ProfileId, pub status: storage_enums::PayoutStatus, pub confirm: Option<bool>, pub payout_link_id: Option<String>, @@ -92,7 +92,7 @@ pub enum PayoutsUpdate { return_url: Option<String>, entity_type: storage_enums::PayoutEntityType, metadata: Option<pii::SecretSerdeValue>, - profile_id: Option<String>, + profile_id: Option<common_utils::id_type::ProfileId>, status: Option<storage_enums::PayoutStatus>, confirm: Option<bool>, payout_type: Option<storage_enums::PayoutType>, @@ -126,7 +126,7 @@ pub struct PayoutsUpdateInternal { pub entity_type: Option<storage_enums::PayoutEntityType>, pub metadata: Option<pii::SecretSerdeValue>, pub payout_method_id: Option<String>, - pub profile_id: Option<String>, + pub profile_id: Option<common_utils::id_type::ProfileId>, pub status: Option<storage_enums::PayoutStatus>, pub last_modified_at: PrimitiveDateTime, pub attempt_count: Option<i16>, diff --git a/crates/diesel_models/src/query/business_profile.rs b/crates/diesel_models/src/query/business_profile.rs index fb80449cdc6..807648b5dce 100644 --- a/crates/diesel_models/src/query/business_profile.rs +++ b/crates/diesel_models/src/query/business_profile.rs @@ -40,7 +40,10 @@ impl BusinessProfile { } } - pub async fn find_by_profile_id(conn: &PgPooledConn, profile_id: &str) -> StorageResult<Self> { + pub async fn find_by_profile_id( + conn: &PgPooledConn, + profile_id: &common_utils::id_type::ProfileId, + ) -> StorageResult<Self> { generics::generic_find_one::<<Self as HasTable>::Table, _, _>( conn, dsl::profile_id.eq(profile_id.to_owned()), @@ -51,7 +54,7 @@ impl BusinessProfile { pub async fn find_by_merchant_id_profile_id( conn: &PgPooledConn, merchant_id: &common_utils::id_type::MerchantId, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, ) -> StorageResult<Self> { generics::generic_find_one::<<Self as HasTable>::Table, _, _>( conn, @@ -97,7 +100,7 @@ impl BusinessProfile { pub async fn delete_by_profile_id_merchant_id( conn: &PgPooledConn, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, merchant_id: &common_utils::id_type::MerchantId, ) -> StorageResult<bool> { generics::generic_delete::<<Self as HasTable>::Table, _>( diff --git a/crates/diesel_models/src/query/events.rs b/crates/diesel_models/src/query/events.rs index 8b2a1a001f8..34222e6e7d8 100644 --- a/crates/diesel_models/src/query/events.rs +++ b/crates/diesel_models/src/query/events.rs @@ -118,7 +118,7 @@ impl Event { pub async fn list_initial_attempts_by_profile_id_primary_object_id( conn: &PgPooledConn, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, primary_object_id: &str, ) -> StorageResult<Vec<Self>> { generics::generic_filter::<<Self as HasTable>::Table, _, _, _>( @@ -137,7 +137,7 @@ impl Event { pub async fn list_initial_attempts_by_profile_id_constraints( conn: &PgPooledConn, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, created_after: Option<time::PrimitiveDateTime>, created_before: Option<time::PrimitiveDateTime>, limit: Option<i64>, @@ -187,7 +187,7 @@ impl Event { pub async fn list_by_profile_id_initial_attempt_id( conn: &PgPooledConn, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, initial_attempt_id: &str, ) -> StorageResult<Vec<Self>> { generics::generic_filter::<<Self as HasTable>::Table, _, _, _>( diff --git a/crates/diesel_models/src/query/merchant_connector_account.rs b/crates/diesel_models/src/query/merchant_connector_account.rs index e4dcdba5975..7eeddd5d592 100644 --- a/crates/diesel_models/src/query/merchant_connector_account.rs +++ b/crates/diesel_models/src/query/merchant_connector_account.rs @@ -78,7 +78,7 @@ impl MerchantConnectorAccount { pub async fn find_by_profile_id_connector_name( conn: &PgPooledConn, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, connector_name: &str, ) -> StorageResult<Self> { generics::generic_find_one::<<Self as HasTable>::Table, _, _>( diff --git a/crates/diesel_models/src/query/routing_algorithm.rs b/crates/diesel_models/src/query/routing_algorithm.rs index 0f3b709d264..f0fc75430e8 100644 --- a/crates/diesel_models/src/query/routing_algorithm.rs +++ b/crates/diesel_models/src/query/routing_algorithm.rs @@ -34,7 +34,7 @@ impl RoutingAlgorithm { pub async fn find_by_algorithm_id_profile_id( conn: &PgPooledConn, algorithm_id: &str, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, ) -> StorageResult<Self> { generics::generic_find_one::<<Self as HasTable>::Table, _, _>( conn, @@ -48,7 +48,7 @@ impl RoutingAlgorithm { pub async fn find_metadata_by_algorithm_id_profile_id( conn: &PgPooledConn, algorithm_id: &str, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, ) -> StorageResult<RoutingProfileMetadata> { Self::table() .select(( @@ -68,7 +68,7 @@ impl RoutingAlgorithm { ) .limit(1) .load_async::<( - String, + common_utils::id_type::ProfileId, String, String, Option<String>, @@ -109,7 +109,7 @@ impl RoutingAlgorithm { pub async fn list_metadata_by_profile_id( conn: &PgPooledConn, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, limit: i64, offset: i64, ) -> StorageResult<Vec<RoutingProfileMetadata>> { @@ -129,7 +129,7 @@ impl RoutingAlgorithm { .offset(offset) .load_async::<( String, - String, + common_utils::id_type::ProfileId, String, Option<String>, enums::RoutingAlgorithmKind, @@ -188,7 +188,7 @@ impl RoutingAlgorithm { .offset(offset) .order(dsl::modified_at.desc()) .load_async::<( - String, + common_utils::id_type::ProfileId, String, String, Option<String>, @@ -250,7 +250,7 @@ impl RoutingAlgorithm { .offset(offset) .order(dsl::modified_at.desc()) .load_async::<( - String, + common_utils::id_type::ProfileId, String, String, Option<String>, diff --git a/crates/diesel_models/src/query/user_role.rs b/crates/diesel_models/src/query/user_role.rs index b4789b3c169..7904d3c2645 100644 --- a/crates/diesel_models/src/query/user_role.rs +++ b/crates/diesel_models/src/query/user_role.rs @@ -83,7 +83,7 @@ impl UserRole { user_id: String, org_id: id_type::OrganizationId, merchant_id: id_type::MerchantId, - profile_id: Option<String>, + profile_id: Option<id_type::ProfileId>, version: UserRoleVersion, ) -> StorageResult<Self> { // Checking in user roles, for a user in token hierarchy, only one of the relation will be true, either org level, merchant level or profile level @@ -116,7 +116,7 @@ impl UserRole { user_id: String, org_id: id_type::OrganizationId, merchant_id: id_type::MerchantId, - profile_id: Option<String>, + profile_id: Option<id_type::ProfileId>, update: UserRoleUpdate, version: UserRoleVersion, ) -> StorageResult<Self> { @@ -156,7 +156,7 @@ impl UserRole { user_id: String, org_id: id_type::OrganizationId, merchant_id: id_type::MerchantId, - profile_id: Option<String>, + profile_id: Option<id_type::ProfileId>, version: UserRoleVersion, ) -> StorageResult<Self> { // Checking in user roles, for a user in token hierarchy, only one of the relation will be true, either org level, merchant level or profile level @@ -190,7 +190,7 @@ impl UserRole { user_id: String, org_id: Option<id_type::OrganizationId>, merchant_id: Option<id_type::MerchantId>, - profile_id: Option<String>, + profile_id: Option<id_type::ProfileId>, entity_id: Option<String>, version: Option<UserRoleVersion>, ) -> StorageResult<Vec<Self>> { diff --git a/crates/diesel_models/src/refund.rs b/crates/diesel_models/src/refund.rs index e4a74a6d66e..3b73a603677 100644 --- a/crates/diesel_models/src/refund.rs +++ b/crates/diesel_models/src/refund.rs @@ -46,7 +46,7 @@ pub struct Refund { pub attempt_id: String, pub refund_reason: Option<String>, pub refund_error_code: Option<String>, - pub profile_id: Option<String>, + pub profile_id: Option<common_utils::id_type::ProfileId>, pub updated_by: String, pub merchant_connector_id: Option<String>, pub charges: Option<ChargeRefunds>, @@ -88,7 +88,7 @@ pub struct RefundNew { pub description: Option<String>, pub attempt_id: String, pub refund_reason: Option<String>, - pub profile_id: Option<String>, + pub profile_id: Option<common_utils::id_type::ProfileId>, pub updated_by: String, pub merchant_connector_id: Option<String>, pub charges: Option<ChargeRefunds>, diff --git a/crates/diesel_models/src/routing_algorithm.rs b/crates/diesel_models/src/routing_algorithm.rs index e2566783e9b..6be0be3d5e4 100644 --- a/crates/diesel_models/src/routing_algorithm.rs +++ b/crates/diesel_models/src/routing_algorithm.rs @@ -7,7 +7,7 @@ use crate::{enums, schema::routing_algorithm}; #[diesel(table_name = routing_algorithm, primary_key(algorithm_id), check_for_backend(diesel::pg::Pg))] pub struct RoutingAlgorithm { pub algorithm_id: String, - pub profile_id: String, + pub profile_id: common_utils::id_type::ProfileId, pub merchant_id: common_utils::id_type::MerchantId, pub name: String, pub description: Option<String>, @@ -29,7 +29,7 @@ pub struct RoutingAlgorithmMetadata { } pub struct RoutingProfileMetadata { - pub profile_id: String, + pub profile_id: common_utils::id_type::ProfileId, pub algorithm_id: String, pub name: String, pub description: Option<String>, diff --git a/crates/diesel_models/src/user_role.rs b/crates/diesel_models/src/user_role.rs index 1a006f2a4ad..b508c86211b 100644 --- a/crates/diesel_models/src/user_role.rs +++ b/crates/diesel_models/src/user_role.rs @@ -18,7 +18,7 @@ pub struct UserRole { pub last_modified_by: String, pub created_at: PrimitiveDateTime, pub last_modified: PrimitiveDateTime, - pub profile_id: Option<String>, + pub profile_id: Option<id_type::ProfileId>, pub entity_id: Option<String>, pub entity_type: Option<EntityType>, pub version: enums::UserRoleVersion, @@ -36,7 +36,7 @@ pub struct UserRoleNew { pub last_modified_by: String, pub created_at: PrimitiveDateTime, pub last_modified: PrimitiveDateTime, - pub profile_id: Option<String>, + pub profile_id: Option<id_type::ProfileId>, pub entity_id: Option<String>, pub entity_type: Option<EntityType>, pub version: enums::UserRoleVersion, diff --git a/crates/hyperswitch_domain_models/src/business_profile.rs b/crates/hyperswitch_domain_models/src/business_profile.rs index ec072521d99..9a6edc50e73 100644 --- a/crates/hyperswitch_domain_models/src/business_profile.rs +++ b/crates/hyperswitch_domain_models/src/business_profile.rs @@ -23,7 +23,7 @@ use crate::type_encryption::{crypto_operation, AsyncLift, CryptoOperation}; ))] #[derive(Clone, Debug)] pub struct BusinessProfile { - pub profile_id: String, + pub profile_id: common_utils::id_type::ProfileId, pub merchant_id: common_utils::id_type::MerchantId, pub profile_name: String, pub created_at: time::PrimitiveDateTime, @@ -453,7 +453,7 @@ impl super::behaviour::Conversion for BusinessProfile { #[cfg(all(feature = "v2", feature = "business_profile_v2"))] #[derive(Clone, Debug)] pub struct BusinessProfile { - pub profile_id: String, + pub profile_id: common_utils::id_type::ProfileId, pub merchant_id: common_utils::id_type::MerchantId, pub profile_name: String, pub created_at: time::PrimitiveDateTime, diff --git a/crates/hyperswitch_domain_models/src/merchant_account.rs b/crates/hyperswitch_domain_models/src/merchant_account.rs index c86dff60eaa..50b1effd27f 100644 --- a/crates/hyperswitch_domain_models/src/merchant_account.rs +++ b/crates/hyperswitch_domain_models/src/merchant_account.rs @@ -45,7 +45,7 @@ pub struct MerchantAccount { pub payout_routing_algorithm: Option<serde_json::Value>, pub organization_id: common_utils::id_type::OrganizationId, pub is_recon_enabled: bool, - pub default_profile: Option<String>, + pub default_profile: Option<common_utils::id_type::ProfileId>, pub recon_status: diesel_models::enums::ReconStatus, pub payment_link_config: Option<serde_json::Value>, pub pm_collect_link_config: Option<serde_json::Value>, @@ -82,7 +82,7 @@ pub struct MerchantAccountSetter { pub payout_routing_algorithm: Option<serde_json::Value>, pub organization_id: common_utils::id_type::OrganizationId, pub is_recon_enabled: bool, - pub default_profile: Option<String>, + pub default_profile: Option<common_utils::id_type::ProfileId>, pub recon_status: diesel_models::enums::ReconStatus, pub payment_link_config: Option<serde_json::Value>, pub pm_collect_link_config: Option<serde_json::Value>, @@ -231,7 +231,7 @@ pub enum MerchantAccountUpdate { intent_fulfillment_time: Option<i64>, frm_routing_algorithm: Option<serde_json::Value>, payout_routing_algorithm: Option<serde_json::Value>, - default_profile: Option<Option<String>>, + default_profile: Option<Option<common_utils::id_type::ProfileId>>, payment_link_config: Option<serde_json::Value>, pm_collect_link_config: Option<serde_json::Value>, }, diff --git a/crates/hyperswitch_domain_models/src/merchant_connector_account.rs b/crates/hyperswitch_domain_models/src/merchant_connector_account.rs index 9e2f6918b43..76b7cd4a85a 100644 --- a/crates/hyperswitch_domain_models/src/merchant_connector_account.rs +++ b/crates/hyperswitch_domain_models/src/merchant_connector_account.rs @@ -36,7 +36,7 @@ pub struct MerchantConnectorAccount { pub created_at: time::PrimitiveDateTime, pub modified_at: time::PrimitiveDateTime, pub connector_webhook_details: Option<pii::SecretSerdeValue>, - pub profile_id: String, + pub profile_id: common_utils::id_type::ProfileId, pub applepay_verified_domains: Option<Vec<String>>, pub pm_auth_config: Option<pii::SecretSerdeValue>, pub status: enums::ConnectorStatus, @@ -71,7 +71,7 @@ pub struct MerchantConnectorAccount { pub created_at: time::PrimitiveDateTime, pub modified_at: time::PrimitiveDateTime, pub connector_webhook_details: Option<pii::SecretSerdeValue>, - pub profile_id: String, + pub profile_id: common_utils::id_type::ProfileId, pub applepay_verified_domains: Option<Vec<String>>, pub pm_auth_config: Option<pii::SecretSerdeValue>, pub status: enums::ConnectorStatus, diff --git a/crates/hyperswitch_domain_models/src/payments.rs b/crates/hyperswitch_domain_models/src/payments.rs index 3f7cfde2f78..11a2c3c3164 100644 --- a/crates/hyperswitch_domain_models/src/payments.rs +++ b/crates/hyperswitch_domain_models/src/payments.rs @@ -44,7 +44,7 @@ pub struct PaymentIntent { pub connector_metadata: Option<serde_json::Value>, pub feature_metadata: Option<serde_json::Value>, pub attempt_count: i16, - pub profile_id: Option<String>, + pub profile_id: Option<id_type::ProfileId>, pub payment_link_id: Option<String>, // Denotes the action(approve or reject) taken by merchant in case of manual review. // Manual review can occur when the transaction is marked as risky by the frm_processor, payment processor or when there is underpayment/over payment incase of crypto payment diff --git a/crates/hyperswitch_domain_models/src/payments/payment_intent.rs b/crates/hyperswitch_domain_models/src/payments/payment_intent.rs index c129e83d556..4c59a90ba15 100644 --- a/crates/hyperswitch_domain_models/src/payments/payment_intent.rs +++ b/crates/hyperswitch_domain_models/src/payments/payment_intent.rs @@ -133,7 +133,7 @@ pub struct PaymentIntentNew { pub connector_metadata: Option<serde_json::Value>, pub feature_metadata: Option<serde_json::Value>, pub attempt_count: i16, - pub profile_id: Option<String>, + pub profile_id: Option<id_type::ProfileId>, pub merchant_decision: Option<String>, pub payment_link_id: Option<String>, pub payment_confirm_source: Option<storage_enums::PaymentSource>, @@ -746,7 +746,7 @@ pub struct PaymentIntentListParams { pub payment_method_type: Option<Vec<storage_enums::PaymentMethodType>>, pub authentication_type: Option<Vec<storage_enums::AuthenticationType>>, pub merchant_connector_id: Option<Vec<String>>, - pub profile_id: Option<String>, + pub profile_id: Option<id_type::ProfileId>, pub customer_id: Option<id_type::CustomerId>, pub starting_after_id: Option<String>, pub ending_before_id: Option<String>, diff --git a/crates/hyperswitch_domain_models/src/payouts.rs b/crates/hyperswitch_domain_models/src/payouts.rs index bb636d2dc48..952028fab30 100644 --- a/crates/hyperswitch_domain_models/src/payouts.rs +++ b/crates/hyperswitch_domain_models/src/payouts.rs @@ -19,7 +19,7 @@ pub struct PayoutListParams { pub currency: Option<Vec<storage_enums::Currency>>, pub status: Option<Vec<storage_enums::PayoutStatus>>, pub payout_method: Option<Vec<common_enums::PayoutType>>, - pub profile_id: Option<String>, + pub profile_id: Option<id_type::ProfileId>, pub customer_id: Option<id_type::CustomerId>, pub starting_after_id: Option<String>, pub ending_before_id: Option<String>, diff --git a/crates/hyperswitch_domain_models/src/payouts/payout_attempt.rs b/crates/hyperswitch_domain_models/src/payouts/payout_attempt.rs index a1f08610f9c..8182ed35bab 100644 --- a/crates/hyperswitch_domain_models/src/payouts/payout_attempt.rs +++ b/crates/hyperswitch_domain_models/src/payouts/payout_attempt.rs @@ -75,7 +75,7 @@ pub struct PayoutAttempt { pub created_at: PrimitiveDateTime, #[serde(with = "common_utils::custom_serde::iso8601")] pub last_modified_at: PrimitiveDateTime, - pub profile_id: String, + pub profile_id: id_type::ProfileId, pub merchant_connector_id: Option<String>, pub routing_info: Option<serde_json::Value>, } @@ -96,41 +96,13 @@ pub struct PayoutAttemptNew { pub error_code: Option<String>, pub business_country: Option<storage_enums::CountryAlpha2>, pub business_label: Option<String>, - pub created_at: Option<PrimitiveDateTime>, - pub last_modified_at: Option<PrimitiveDateTime>, - pub profile_id: String, + pub created_at: PrimitiveDateTime, + pub last_modified_at: PrimitiveDateTime, + pub profile_id: id_type::ProfileId, pub merchant_connector_id: Option<String>, pub routing_info: Option<serde_json::Value>, } -impl Default for PayoutAttemptNew { - fn default() -> Self { - let now = common_utils::date_time::now(); - - Self { - payout_attempt_id: String::default(), - payout_id: String::default(), - customer_id: None, - merchant_id: id_type::MerchantId::default(), - address_id: None, - connector: None, - connector_payout_id: None, - payout_token: None, - status: storage_enums::PayoutStatus::default(), - is_eligible: None, - error_message: None, - error_code: None, - business_country: None, - business_label: None, - created_at: Some(now), - last_modified_at: Some(now), - profile_id: String::default(), - merchant_connector_id: None, - routing_info: None, - } - } -} - #[derive(Debug, Clone)] pub enum PayoutAttemptUpdate { StatusUpdate { diff --git a/crates/hyperswitch_domain_models/src/payouts/payouts.rs b/crates/hyperswitch_domain_models/src/payouts/payouts.rs index 834b6bb3f76..e514dbfb4c3 100644 --- a/crates/hyperswitch_domain_models/src/payouts/payouts.rs +++ b/crates/hyperswitch_domain_models/src/payouts/payouts.rs @@ -106,7 +106,7 @@ pub struct Payouts { pub created_at: PrimitiveDateTime, pub last_modified_at: PrimitiveDateTime, pub attempt_count: i16, - pub profile_id: String, + pub profile_id: id_type::ProfileId, pub status: storage_enums::PayoutStatus, pub confirm: Option<bool>, pub payout_link_id: Option<String>, @@ -131,10 +131,10 @@ pub struct PayoutsNew { pub return_url: Option<String>, pub entity_type: storage_enums::PayoutEntityType, pub metadata: Option<pii::SecretSerdeValue>, - pub created_at: Option<PrimitiveDateTime>, - pub last_modified_at: Option<PrimitiveDateTime>, + pub created_at: PrimitiveDateTime, + pub last_modified_at: PrimitiveDateTime, pub attempt_count: i16, - pub profile_id: String, + pub profile_id: id_type::ProfileId, pub status: storage_enums::PayoutStatus, pub confirm: Option<bool>, pub payout_link_id: Option<String>, @@ -142,39 +142,6 @@ pub struct PayoutsNew { pub priority: Option<storage_enums::PayoutSendPriority>, } -impl Default for PayoutsNew { - fn default() -> Self { - let now = common_utils::date_time::now(); - - Self { - payout_id: String::default(), - merchant_id: id_type::MerchantId::default(), - customer_id: None, - address_id: None, - payout_type: None, - payout_method_id: None, - amount: MinorUnit::new(i64::default()), - destination_currency: storage_enums::Currency::default(), - source_currency: storage_enums::Currency::default(), - description: None, - recurring: bool::default(), - auto_fulfill: bool::default(), - return_url: None, - entity_type: storage_enums::PayoutEntityType::default(), - metadata: None, - created_at: Some(now), - last_modified_at: Some(now), - attempt_count: 1, - profile_id: String::default(), - status: storage_enums::PayoutStatus::default(), - confirm: None, - payout_link_id: None, - client_secret: None, - priority: None, - } - } -} - #[derive(Debug, Serialize, Deserialize)] pub enum PayoutsUpdate { Update { @@ -187,7 +154,7 @@ pub enum PayoutsUpdate { return_url: Option<String>, entity_type: storage_enums::PayoutEntityType, metadata: Option<pii::SecretSerdeValue>, - profile_id: Option<String>, + profile_id: Option<id_type::ProfileId>, status: Option<storage_enums::PayoutStatus>, confirm: Option<bool>, payout_type: Option<storage_enums::PayoutType>, @@ -220,7 +187,7 @@ pub struct PayoutsUpdateInternal { pub entity_type: Option<storage_enums::PayoutEntityType>, pub metadata: Option<pii::SecretSerdeValue>, pub payout_method_id: Option<String>, - pub profile_id: Option<String>, + pub profile_id: Option<id_type::ProfileId>, pub status: Option<storage_enums::PayoutStatus>, pub attempt_count: Option<i16>, pub confirm: Option<bool>, diff --git a/crates/kgraph_utils/benches/evaluation.rs b/crates/kgraph_utils/benches/evaluation.rs index ab2e8c80ca4..5a078de1d79 100644 --- a/crates/kgraph_utils/benches/evaluation.rs +++ b/crates/kgraph_utils/benches/evaluation.rs @@ -52,6 +52,8 @@ fn build_test_data( }); } + let profile_id = common_utils::generate_profile_id_of_default_length(); + #[cfg(all(feature = "v2", feature = "merchant_connector_account_v2"))] let stripe_account = MerchantConnectorResponse { connector_type: api_enums::ConnectorType::FizOperations, @@ -64,7 +66,7 @@ fn build_test_data( connector_label: Some("something".to_string()), frm_configs: None, connector_webhook_details: None, - profile_id: "profile_id".to_string(), + profile_id, applepay_verified_domains: None, pm_auth_config: None, status: api_enums::ConnectorStatus::Inactive, @@ -90,7 +92,7 @@ fn build_test_data( business_sub_label: Some("something".to_string()), frm_configs: None, connector_webhook_details: None, - profile_id: "profile_id".to_string(), + profile_id, applepay_verified_domains: None, pm_auth_config: None, status: api_enums::ConnectorStatus::Inactive, diff --git a/crates/kgraph_utils/src/mca.rs b/crates/kgraph_utils/src/mca.rs index d4e04669714..1e099589b00 100644 --- a/crates/kgraph_utils/src/mca.rs +++ b/crates/kgraph_utils/src/mca.rs @@ -704,6 +704,8 @@ mod tests { fn build_test_data() -> ConstraintGraph<dir::DirValue> { use api_models::{admin::, payment_methods::}; + let profile_id = common_utils::generate_profile_id_of_default_length(); + #[cfg(all(feature = "v2", feature = "merchant_connector_account_v2"))] let stripe_account = MerchantConnectorResponse { connector_type: api_enums::ConnectorType::FizOperations, @@ -752,7 +754,7 @@ mod tests { }]), frm_configs: None, connector_webhook_details: None, - profile_id: "profile_id".to_string(), + profile_id, applepay_verified_domains: None, pm_auth_config: None, status: api_enums::ConnectorStatus::Inactive, @@ -813,7 +815,7 @@ mod tests { }]), frm_configs: None, connector_webhook_details: None, - profile_id: "profile_id".to_string(), + profile_id, applepay_verified_domains: None, pm_auth_config: None, status: api_enums::ConnectorStatus::Inactive, diff --git a/crates/router/src/core/admin.rs b/crates/router/src/core/admin.rs index e90924a593a..f78d5dca2e0 100644 --- a/crates/router/src/core/admin.rs +++ b/crates/router/src/core/admin.rs @@ -721,7 +721,7 @@ pub async fn list_merchant_account( pub async fn get_merchant_account( state: SessionState, req: api::MerchantId, - _profile_id: Option<String>, + _profile_id: Option<id_type::ProfileId>, ) -> RouterResponse<api::MerchantAccountResponse> { let db = state.store.as_ref(); let key_manager_state = &(&state).into(); @@ -842,8 +842,6 @@ impl MerchantAccountUpdateBridge for api::MerchantAccountUpdate { merchant_id: &id_type::MerchantId, key_store: &domain::MerchantKeyStore, ) -> RouterResult<storage::MerchantAccountUpdate> { - use common_utils::ext_traits::ConfigExt; - let key_manager_state = &state.into(); let key = key_store.key.get_inner().peek(); @@ -885,21 +883,16 @@ impl MerchantAccountUpdateBridge for api::MerchantAccountUpdate { // This supports changing the business profile by passing in the profile_id let business_profile_id_update = if let Some(ref profile_id) = self.default_profile { - if !profile_id.is_empty_after_trim() { - // Validate whether profile_id passed in request is valid and is linked to the merchant - core_utils::validate_and_get_business_profile( - state.store.as_ref(), - key_manager_state, - key_store, - Some(profile_id), - merchant_id, - ) - .await? - .map(\|business_profile\| Some(business_profile.profile_id)) - } else { - // If empty, Update profile_id to None in the database - Some(None) - } + // Validate whether profile_id passed in request is valid and is linked to the merchant + core_utils::validate_and_get_business_profile( + state.store.as_ref(), + key_manager_state, + key_store, + Some(profile_id), + merchant_id, + ) + .await? + .map(\|business_profile\| Some(business_profile.profile_id)) } else { None }; @@ -1047,7 +1040,7 @@ impl MerchantAccountUpdateBridge for api::MerchantAccountUpdate { pub async fn merchant_account_update( state: SessionState, merchant_id: &id_type::MerchantId, - _profile_id: Option<String>, + _profile_id: Option<id_type::ProfileId>, req: api::MerchantAccountUpdate, ) -> RouterResponse<api::MerchantAccountResponse> { let db = state.store.as_ref(); @@ -1765,7 +1758,7 @@ struct PMAuthConfigValidation<'a> { pm_auth_config: &'a Option<pii::SecretSerdeValue>, db: &'a dyn StorageInterface, merchant_id: &'a id_type::MerchantId, - profile_id: &'a String, + profile_id: &'a id_type::ProfileId, key_store: &'a domain::MerchantKeyStore, key_manager_state: &'a KeyManagerState, } @@ -1877,7 +1870,7 @@ struct MerchantDefaultConfigUpdate<'a> { merchant_connector_id: &'a String, store: &'a dyn StorageInterface, merchant_id: &'a id_type::MerchantId, - profile_id: &'a String, + profile_id: &'a id_type::ProfileId, transaction_type: &'a api_enums::TransactionType, } #[cfg(all( @@ -1897,7 +1890,7 @@ impl<'a> MerchantDefaultConfigUpdate<'a> { let mut default_routing_config_for_profile = routing::helpers::get_merchant_default_config( self.store, - self.profile_id, + self.profile_id.get_string_repr(), self.transaction_type, ) .await?; @@ -1922,7 +1915,7 @@ impl<'a> MerchantDefaultConfigUpdate<'a> { default_routing_config_for_profile.push(choice); routing::helpers::update_merchant_default_config( self.store, - self.profile_id, + self.profile_id.get_string_repr(), default_routing_config_for_profile.clone(), self.transaction_type, ) @@ -1969,7 +1962,7 @@ impl<'a> DefaultFallbackRoutingConfigUpdate<'a> { profile_wrapper .update_default_fallback_routing_of_connectors_under_profile( self.store, - &default_routing_config_for_profile, + default_routing_config_for_profile, self.key_manager_state, &self.key_store, ) @@ -2438,7 +2431,9 @@ impl MerchantConnectorAccountCreateBridge for api::MerchantConnectorCreate { ) .await? .get_required_value("BusinessProfile") - .change_context(errors::ApiErrorResponse::BusinessProfileNotFound { id: profile_id })?; + .change_context(errors::ApiErrorResponse::BusinessProfileNotFound { + id: profile_id.get_string_repr().to_owned(), + })?; Ok(business_profile) } @@ -2614,7 +2609,9 @@ impl MerchantConnectorAccountCreateBridge for api::MerchantConnectorCreate { .await? .get_required_value("BusinessProfile") .change_context( - errors::ApiErrorResponse::BusinessProfileNotFound { id: profile_id }, + errors::ApiErrorResponse::BusinessProfileNotFound { + id: profile_id.get_string_repr().to_owned(), + }, )?; Ok(business_profile) @@ -2746,7 +2743,7 @@ pub async fn create_connector( .await .to_duplicate_response( errors::ApiErrorResponse::DuplicateMerchantConnectorAccount { - profile_id: business_profile.profile_id.clone(), + profile_id: business_profile.profile_id.get_string_repr().to_owned(), connector_label: merchant_connector_account .connector_label .unwrap_or_default(), @@ -2809,7 +2806,7 @@ async fn validate_pm_auth( merchant_id: &id_type::MerchantId, key_store: &domain::MerchantKeyStore, merchant_account: domain::MerchantAccount, - profile_id: &String, + profile_id: &id_type::ProfileId, ) -> RouterResponse<()> { let config = serde_json::from_value::<api_models::pm_auth::PaymentMethodAuthConfig>(val.expose()) @@ -2858,7 +2855,7 @@ async fn validate_pm_auth( pub async fn retrieve_connector( state: SessionState, merchant_id: id_type::MerchantId, - profile_id: Option<String>, + profile_id: Option<id_type::ProfileId>, merchant_connector_id: String, ) -> RouterResponse<api_models::admin::MerchantConnectorResponse> { let store = state.store.as_ref(); @@ -2939,7 +2936,7 @@ pub async fn retrieve_connector( pub async fn list_payment_connectors( state: SessionState, merchant_id: id_type::MerchantId, - profile_id_list: Option<Vec<String>>, + profile_id_list: Option<Vec<id_type::ProfileId>>, ) -> RouterResponse<Vec<api_models::admin::MerchantConnectorListResponse>> { let store = state.store.as_ref(); let key_manager_state = &(&state).into(); @@ -2984,7 +2981,7 @@ pub async fn list_payment_connectors( pub async fn update_connector( state: SessionState, merchant_id: &id_type::MerchantId, - profile_id: Option<String>, + profile_id: Option<id_type::ProfileId>, merchant_connector_id: &str, req: api_models::admin::MerchantConnectorUpdate, ) -> RouterResponse<api_models::admin::MerchantConnectorResponse> { @@ -3042,7 +3039,7 @@ pub async fn update_connector( .await .change_context( errors::ApiErrorResponse::DuplicateMerchantConnectorAccount { - profile_id, + profile_id: profile_id.get_string_repr().to_owned(), connector_label: request_connector_label.unwrap_or_default(), }, ) @@ -3409,7 +3406,7 @@ impl BusinessProfileCreateBridge for api::BusinessProfileCreate { } // Generate a unique profile id - let profile_id = common_utils::generate_id_with_default_len("pro"); + let profile_id = common_utils::generate_profile_id_of_default_length(); let profile_name = self.profile_name.unwrap_or("default".to_string()); let current_time = date_time::now(); @@ -3523,7 +3520,7 @@ impl BusinessProfileCreateBridge for api::BusinessProfileCreate { // Generate a unique profile id // TODO: the profile_id should be generated from the profile_name - let profile_id = common_utils::generate_id_with_default_len("pro"); + let profile_id = common_utils::generate_profile_id_of_default_length(); let profile_name = self.profile_name; let current_time = date_time::now(); @@ -3656,7 +3653,10 @@ pub async fn create_business_profile( .insert_business_profile(key_manager_state, &key_store, business_profile) .await .to_duplicate_response(errors::ApiErrorResponse::GenericDuplicateError { - message: format!("Business Profile with the profile_id {profile_id} already exists"), + message: format!( + "Business Profile with the profile_id {} already exists", + profile_id.get_string_repr() + ), }) .attach_printable("Failed to insert Business profile because of duplication error")?; @@ -3715,7 +3715,7 @@ pub async fn list_business_profile( pub async fn retrieve_business_profile( state: SessionState, - profile_id: String, + profile_id: id_type::ProfileId, merchant_id: id_type::MerchantId, ) -> RouterResponse<api_models::admin::BusinessProfileResponse> { let db = state.store.as_ref(); @@ -3731,7 +3731,7 @@ pub async fn retrieve_business_profile( .find_business_profile_by_profile_id(&(&state).into(), &key_store, &profile_id) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id, + id: profile_id.get_string_repr().to_owned(), })?; Ok(service_api::ApplicationResponse::Json( @@ -3743,7 +3743,7 @@ pub async fn retrieve_business_profile( pub async fn delete_business_profile( state: SessionState, - profile_id: String, + profile_id: id_type::ProfileId, merchant_id: &id_type::MerchantId, ) -> RouterResponse<bool> { let db = state.store.as_ref(); @@ -3751,7 +3751,7 @@ pub async fn delete_business_profile( .delete_business_profile_by_profile_id_merchant_id(&profile_id, merchant_id) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id, + id: profile_id.get_string_repr().to_owned(), })?; Ok(service_api::ApplicationResponse::Json(delete_result)) @@ -3977,7 +3977,7 @@ impl BusinessProfileUpdateBridge for api::BusinessProfileUpdate { #[cfg(feature = "olap")] pub async fn update_business_profile( state: SessionState, - profile_id: &str, + profile_id: &id_type::ProfileId, merchant_id: &id_type::MerchantId, request: api::BusinessProfileUpdate, ) -> RouterResponse<api::BusinessProfileResponse> { @@ -3997,12 +3997,12 @@ pub async fn update_business_profile( .find_business_profile_by_profile_id(key_manager_state, &key_store, profile_id) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_owned(), + id: profile_id.get_string_repr().to_owned(), })?; if business_profile.merchant_id != merchant_id { Err(errors::ApiErrorResponse::AccessForbidden { - resource: profile_id.to_string(), + resource: profile_id.get_string_repr().to_owned(), })? } @@ -4019,7 +4019,7 @@ pub async fn update_business_profile( ) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_owned(), + id: profile_id.get_string_repr().to_owned(), })?; Ok(service_api::ApplicationResponse::Json( @@ -4055,8 +4055,9 @@ impl BusinessProfileWrapper { storage_impl::redis::cache::CacheKind::Routing( format!( - "routing_config_{}_{profile_id}", - merchant_id.get_string_repr() + "routing_config_{}_{}", + merchant_id.get_string_repr(), + profile_id.get_string_repr() ) .into(), ) @@ -4177,7 +4178,7 @@ impl BusinessProfileWrapper { pub async fn extended_card_info_toggle( state: SessionState, merchant_id: &id_type::MerchantId, - profile_id: &str, + profile_id: &id_type::ProfileId, ext_card_info_choice: admin_types::ExtendedCardInfoChoice, ) -> RouterResponse<admin_types::ExtendedCardInfoChoice> { let db = state.store.as_ref(); @@ -4197,7 +4198,7 @@ pub async fn extended_card_info_toggle( .find_business_profile_by_profile_id(key_manager_state, &key_store, profile_id) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_string(), + id: profile_id.get_string_repr().to_owned(), })?; if business_profile.is_extended_card_info_enabled.is_none() @@ -4217,7 +4218,7 @@ pub async fn extended_card_info_toggle( ) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_owned(), + id: profile_id.get_string_repr().to_owned(), })?; } @@ -4227,7 +4228,7 @@ pub async fn extended_card_info_toggle( pub async fn connector_agnostic_mit_toggle( state: SessionState, merchant_id: &id_type::MerchantId, - profile_id: &str, + profile_id: &id_type::ProfileId, connector_agnostic_mit_choice: admin_types::ConnectorAgnosticMitChoice, ) -> RouterResponse<admin_types::ConnectorAgnosticMitChoice> { let db = state.store.as_ref(); @@ -4247,12 +4248,12 @@ pub async fn connector_agnostic_mit_toggle( .find_business_profile_by_profile_id(key_manager_state, &key_store, profile_id) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_string(), + id: profile_id.get_string_repr().to_owned(), })?; if business_profile.merchant_id != merchant_id { Err(errors::ApiErrorResponse::AccessForbidden { - resource: profile_id.to_string(), + resource: profile_id.get_string_repr().to_owned(), })? } @@ -4271,7 +4272,7 @@ pub async fn connector_agnostic_mit_toggle( ) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_owned(), + id: profile_id.get_string_repr().to_owned(), })?; } diff --git a/crates/router/src/core/authentication/utils.rs b/crates/router/src/core/authentication/utils.rs index 87235582c09..58862d18906 100644 --- a/crates/router/src/core/authentication/utils.rs +++ b/crates/router/src/core/authentication/utils.rs @@ -178,7 +178,7 @@ pub async fn create_new_authentication( merchant_id: common_utils::id_type::MerchantId, authentication_connector: String, token: String, - profile_id: String, + profile_id: common_utils::id_type::ProfileId, payment_id: Option<String>, merchant_connector_id: String, ) -> RouterResult<storage::Authentication> { @@ -285,7 +285,7 @@ pub async fn get_authentication_connector_data( .ok_or(errors::ApiErrorResponse::UnprocessableEntity { message: format!( "No authentication_connector found for profile_id {}", - business_profile.profile_id + business_profile.profile_id.get_string_repr() ), }) .attach_printable( diff --git a/crates/router/src/core/customers.rs b/crates/router/src/core/customers.rs index 4e45e48cfaa..9d77626ac51 100644 --- a/crates/router/src/core/customers.rs +++ b/crates/router/src/core/customers.rs @@ -433,7 +433,7 @@ impl<'a> MerchantReferenceIdForCustomer<'a> { pub async fn retrieve_customer( state: SessionState, merchant_account: domain::MerchantAccount, - _profile_id: Option<String>, + _profile_id: Option<id_type::ProfileId>, key_store: domain::MerchantKeyStore, req: customers::CustomerId, ) -> errors::CustomerResponse<customers::CustomerResponse> { @@ -495,7 +495,7 @@ pub async fn retrieve_customer( pub async fn list_customers( state: SessionState, merchant_id: id_type::MerchantId, - _profile_id_list: Option<Vec<String>>, + _profile_id_list: Option<Vec<id_type::ProfileId>>, key_store: domain::MerchantKeyStore, ) -> errors::CustomerResponse<Vec<customers::CustomerResponse>> { let db = state.store.as_ref(); diff --git a/crates/router/src/core/disputes.rs b/crates/router/src/core/disputes.rs index 73215959305..24c6c0f8be8 100644 --- a/crates/router/src/core/disputes.rs +++ b/crates/router/src/core/disputes.rs @@ -26,7 +26,7 @@ use crate::{ pub async fn retrieve_dispute( state: SessionState, merchant_account: domain::MerchantAccount, - profile_id: Option<String>, + profile_id: Option<common_utils::id_type::ProfileId>, req: disputes::DisputeId, ) -> RouterResponse<api_models::disputes::DisputeResponse> { let dispute = state @@ -45,7 +45,7 @@ pub async fn retrieve_dispute( pub async fn retrieve_disputes_list( state: SessionState, merchant_account: domain::MerchantAccount, - _profile_id_list: Option<Vec<String>>, + _profile_id_list: Option<Vec<common_utils::id_type::ProfileId>>, constraints: api_models::disputes::DisputeListConstraints, ) -> RouterResponse<Vec<api_models::disputes::DisputeResponse>> { let disputes = state @@ -65,7 +65,7 @@ pub async fn retrieve_disputes_list( pub async fn accept_dispute( state: SessionState, merchant_account: domain::MerchantAccount, - profile_id: Option<String>, + profile_id: Option<common_utils::id_type::ProfileId>, key_store: domain::MerchantKeyStore, req: disputes::DisputeId, ) -> RouterResponse<dispute_models::DisputeResponse> { @@ -169,7 +169,7 @@ pub async fn accept_dispute( pub async fn submit_evidence( state: SessionState, merchant_account: domain::MerchantAccount, - profile_id: Option<String>, + profile_id: Option<common_utils::id_type::ProfileId>, key_store: domain::MerchantKeyStore, req: dispute_models::SubmitEvidenceRequest, ) -> RouterResponse<dispute_models::DisputeResponse> { @@ -336,7 +336,7 @@ pub async fn submit_evidence( pub async fn attach_evidence( state: SessionState, merchant_account: domain::MerchantAccount, - profile_id: Option<String>, + profile_id: Option<common_utils::id_type::ProfileId>, key_store: domain::MerchantKeyStore, attach_evidence_request: api::AttachEvidenceRequest, ) -> RouterResponse<files_api_models::CreateFileResponse> { @@ -415,7 +415,7 @@ pub async fn attach_evidence( pub async fn retrieve_dispute_evidence( state: SessionState, merchant_account: domain::MerchantAccount, - profile_id: Option<String>, + profile_id: Option<common_utils::id_type::ProfileId>, req: disputes::DisputeId, ) -> RouterResponse<Vec<api_models::disputes::DisputeEvidenceBlock>> { let dispute = state diff --git a/crates/router/src/core/files/helpers.rs b/crates/router/src/core/files/helpers.rs index b479d131564..14e404e88a0 100644 --- a/crates/router/src/core/files/helpers.rs +++ b/crates/router/src/core/files/helpers.rs @@ -245,7 +245,7 @@ pub async fn upload_and_get_provider_provider_file_id_profile_id( ( String, api_models::enums::FileUploadProvider, - Option<String>, + Option<common_utils::id_type::ProfileId>, Option<String>, ), errors::ApiErrorResponse, diff --git a/crates/router/src/core/fraud_check.rs b/crates/router/src/core/fraud_check.rs index a5d78377a8f..d185e3545b4 100644 --- a/crates/router/src/core/fraud_check.rs +++ b/crates/router/src/core/fraud_check.rs @@ -128,7 +128,7 @@ pub async fn should_call_frm<F: Send + Clone>( ) -> RouterResult<( bool, Option<FrmRoutingAlgorithm>, - Option<String>, + Option<common_utils::id_type::ProfileId>, Option<FrmConfigsObject>, )> { // Frm routing algorithm is not present in the merchant account @@ -145,7 +145,7 @@ pub async fn should_call_frm<F: Send + Clone>( ) -> RouterResult<( bool, Option<FrmRoutingAlgorithm>, - Option<String>, + Option<common_utils::id_type::ProfileId>, Option<FrmConfigsObject>, )> { use common_utils::ext_traits::OptionExt; @@ -327,7 +327,7 @@ pub async fn should_call_frm<F: Send + Clone>( Ok(( is_frm_enabled, Some(frm_routing_algorithm_struct), - Some(profile_id.to_string()), + Some(profile_id), Some(frm_configs_object), )) } @@ -354,7 +354,7 @@ pub async fn make_frm_data_and_fraud_check_operation<'a, F>( merchant_account: &domain::MerchantAccount, payment_data: payments::PaymentData<F>, frm_routing_algorithm: FrmRoutingAlgorithm, - profile_id: String, + profile_id: common_utils::id_type::ProfileId, frm_configs: FrmConfigsObject, _customer: &Option<domain::Customer>, ) -> RouterResult<FrmInfo<F>> diff --git a/crates/router/src/core/fraud_check/types.rs b/crates/router/src/core/fraud_check/types.rs index d35e3227e6d..7f9d21216bc 100644 --- a/crates/router/src/core/fraud_check/types.rs +++ b/crates/router/src/core/fraud_check/types.rs @@ -69,7 +69,7 @@ pub struct FrmInfo<F> { #[derive(Clone, Debug)] pub struct ConnectorDetailsCore { pub connector_name: String, - pub profile_id: String, + pub profile_id: common_utils::id_type::ProfileId, } #[derive(Clone)] pub struct PaymentToFrmData { diff --git a/crates/router/src/core/mandate/helpers.rs b/crates/router/src/core/mandate/helpers.rs index 9899d85fc73..e5fa762aeb0 100644 --- a/crates/router/src/core/mandate/helpers.rs +++ b/crates/router/src/core/mandate/helpers.rs @@ -16,7 +16,7 @@ pub async fn get_profile_id_for_mandate( merchant_account: &domain::MerchantAccount, key_store: &domain::MerchantKeyStore, mandate: Mandate, -) -> CustomResult<String, errors::ApiErrorResponse> { +) -> CustomResult<common_utils::id_type::ProfileId, errors::ApiErrorResponse> { let profile_id = if let Some(ref payment_id) = mandate.original_payment_id { let pi = state .store @@ -35,6 +35,7 @@ pub async fn get_profile_id_for_mandate( .ok_or(errors::ApiErrorResponse::BusinessProfileNotFound { id: pi .profile_id + .map(\|profile_id\| profile_id.get_string_repr().to_owned()) .unwrap_or_else(\|\| "Profile id is Null".to_string()), })?; Ok(profile_id) diff --git a/crates/router/src/core/payment_link.rs b/crates/router/src/core/payment_link.rs index e7f21ae0fdb..bb39bede2d6 100644 --- a/crates/router/src/core/payment_link.rs +++ b/crates/router/src/core/payment_link.rs @@ -129,7 +129,7 @@ pub async fn form_payment_link_data( .find_business_profile_by_profile_id(key_manager_state, &key_store, &profile_id) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_string(), + id: profile_id.get_string_repr().to_owned(), })?; let return_url = if let Some(payment_create_return_url) = payment_intent.return_url.clone() { @@ -754,7 +754,7 @@ pub async fn get_payment_link_status( .find_business_profile_by_profile_id(key_manager_state, &key_store, &profile_id) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_string(), + id: profile_id.get_string_repr().to_owned(), })?; let return_url = if let Some(payment_create_return_url) = payment_intent.return_url.clone() { diff --git a/crates/router/src/core/payment_methods/cards.rs b/crates/router/src/core/payment_methods/cards.rs index 274ef3c0966..586e93a0fe6 100644 --- a/crates/router/src/core/payment_methods/cards.rs +++ b/crates/router/src/core/payment_methods/cards.rs @@ -2734,7 +2734,7 @@ pub async fn list_payment_methods( format!( "pm_filters_cgraph_{}_{}", merchant_account.get_id().get_string_repr(), - profile_id + profile_id.get_string_repr() ) }; @@ -4909,7 +4909,7 @@ async fn generate_saved_pm_response( pub async fn get_mca_status( state: &routes::SessionState, key_store: &domain::MerchantKeyStore, - profile_id: Option<String>, + profile_id: Option<id_type::ProfileId>, merchant_id: &id_type::MerchantId, is_connector_agnostic_mit_enabled: bool, connector_mandate_details: Option<storage::PaymentsMandateReference>, @@ -5789,7 +5789,7 @@ where pub async fn list_countries_currencies_for_connector_payment_method( state: routes::SessionState, req: ListCountriesCurrenciesRequest, - _profile_id: Option<String>, + _profile_id: Option<id_type::ProfileId>, ) -> errors::RouterResponse<ListCountriesCurrenciesResponse> { Ok(services::ApplicationResponse::Json( list_countries_currencies_for_connector_payment_method_util( diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs index 6938d3c407b..72a188a47ec 100644 --- a/crates/router/src/core/payments.rs +++ b/crates/router/src/core/payments.rs @@ -106,7 +106,7 @@ pub async fn payments_operation_core<F, Req, Op, FData>( state: &SessionState, req_state: ReqState, merchant_account: domain::MerchantAccount, - profile_id_from_auth_layer: Option<String>, + profile_id_from_auth_layer: Option<id_type::ProfileId>, key_store: domain::MerchantKeyStore, operation: Op, req: Req, @@ -828,7 +828,7 @@ pub async fn payments_core<F, Res, Req, Op, FData>( state: SessionState, req_state: ReqState, merchant_account: domain::MerchantAccount, - profile_id: Option<String>, + profile_id: Option<id_type::ProfileId>, key_store: domain::MerchantKeyStore, operation: Op, req: Req, @@ -1067,7 +1067,7 @@ impl PaymentRedirectFlow for PaymentRedirectCompleteAuthorize { .find_business_profile_by_profile_id(key_manager_state, &merchant_key_store, profile_id) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_string(), + id: profile_id.get_string_repr().to_owned(), })?; Ok(router_types::RedirectPaymentFlowResponse { payments_response, @@ -1201,7 +1201,7 @@ impl PaymentRedirectFlow for PaymentRedirectSync { .find_business_profile_by_profile_id(key_manager_state, &merchant_key_store, profile_id) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_string(), + id: profile_id.get_string_repr().to_owned(), })?; Ok(router_types::RedirectPaymentFlowResponse { payments_response, @@ -1432,7 +1432,7 @@ impl PaymentRedirectFlow for PaymentAuthenticateCompleteAuthorize { .find_business_profile_by_profile_id(key_manager_state, &merchant_key_store, profile_id) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_string(), + id: profile_id.get_string_repr().to_owned(), })?; Ok(router_types::AuthenticatePaymentFlowResponse { payments_response, @@ -2019,10 +2019,9 @@ where .as_ref() .get_required_value("profile_id") .change_context(errors::ApiErrorResponse::InternalServerError) - .attach_printable("profile_id is not set in payment_intent")? - .clone(); + .attach_printable("profile_id is not set in payment_intent")?; - format!("{connector_name}_{profile_id}") + format!("{connector_name}_{}", profile_id.get_string_repr()) }; let (should_call_connector, existing_connector_customer_id) = @@ -2912,7 +2911,7 @@ pub fn is_operation_complete_authorize<Op: Debug>(operation: &Op) -> bool { pub async fn list_payments( state: SessionState, merchant: domain::MerchantAccount, - profile_id_list: Option<Vec<String>>, + profile_id_list: Option<Vec<id_type::ProfileId>>, key_store: domain::MerchantKeyStore, constraints: api::PaymentListConstraints, ) -> RouterResponse<api::PaymentListResponse> { @@ -2987,7 +2986,7 @@ pub async fn list_payments( pub async fn apply_filters_on_payments( state: SessionState, merchant: domain::MerchantAccount, - profile_id_list: Option<Vec<String>>, + profile_id_list: Option<Vec<id_type::ProfileId>>, merchant_key_store: domain::MerchantKeyStore, constraints: api::PaymentListFilterConstraints, ) -> RouterResponse<api::PaymentListResponseV2> { @@ -3085,7 +3084,7 @@ pub async fn get_filters_for_payments( pub async fn get_payment_filters( state: SessionState, merchant: domain::MerchantAccount, - profile_id_list: Option<Vec<String>>, + profile_id_list: Option<Vec<id_type::ProfileId>>, ) -> RouterResponse<api::PaymentListFiltersV2> { let merchant_connector_accounts = if let services::ApplicationResponse::Json(data) = super::admin::list_payment_connectors(state, merchant.get_id().to_owned(), profile_id_list) @@ -4329,7 +4328,7 @@ pub async fn payment_external_authentication( .find_business_profile_by_profile_id(key_manager_state, &key_store, profile_id) .await .change_context(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_string(), + id: profile_id.get_string_repr().to_owned(), })?; let authentication_details = business_profile diff --git a/crates/router/src/core/payments/helpers.rs b/crates/router/src/core/payments/helpers.rs index a1b65fa2682..417e655d3b1 100644 --- a/crates/router/src/core/payments/helpers.rs +++ b/crates/router/src/core/payments/helpers.rs @@ -130,7 +130,7 @@ pub fn create_certificate( pub fn filter_mca_based_on_profile_and_connector_type( merchant_connector_accounts: Vec<domain::MerchantConnectorAccount>, - profile_id: &String, + profile_id: &id_type::ProfileId, connector_type: ConnectorType, ) -> Vec<domain::MerchantConnectorAccount> { merchant_connector_accounts @@ -3266,7 +3266,7 @@ pub async fn get_merchant_connector_account( merchant_id: &id_type::MerchantId, creds_identifier: Option<String>, key_store: &domain::MerchantKeyStore, - profile_id: &String, + profile_id: &id_type::ProfileId, connector_name: &str, merchant_connector_id: Option<&String>, ) -> RouterResult<MerchantConnectorAccountType> { @@ -3391,7 +3391,8 @@ pub async fn get_merchant_connector_account( .to_not_found_response( errors::ApiErrorResponse::MerchantConnectorAccountNotFound { id: format!( - "profile id {profile_id} and connector name {connector_name}" + "profile id {} and connector name {connector_name}", + profile_id.get_string_repr() ), }, ) @@ -3832,7 +3833,7 @@ mod test { pub async fn get_additional_payment_data( pm_data: &domain::PaymentMethodData, db: &dyn StorageInterface, - profile_id: &str, + profile_id: &id_type::ProfileId, ) -> Option<api_models::payments::AdditionalPaymentData> { match pm_data { domain::PaymentMethodData::Card(card_data) => { @@ -3840,7 +3841,7 @@ pub async fn get_additional_payment_data( let card_isin = Some(card_data.card_number.get_card_isin()); let enable_extended_bin =db .find_config_by_key_unwrap_or( - format!("{}_enable_extended_card_bin", profile_id).as_str(), + format!("{}_enable_extended_card_bin", profile_id.get_string_repr()).as_str(), Some("false".to_string())) .await.map_err(\|err\| services::logger::error!(message="Failed to fetch the config", extended_card_bin_error=?err)).ok(); @@ -4282,7 +4283,7 @@ where ))] let fallback_connetors_list = crate::core::routing::helpers::get_merchant_default_config( &state.clone().store, - profile_id, + profile_id.get_string_repr(), &api_enums::TransactionType::Payment, ) .await diff --git a/crates/router/src/core/payments/operations/payment_approve.rs b/crates/router/src/core/payments/operations/payment_approve.rs index 401e1c2c7a1..7034cfab2f7 100644 --- a/crates/router/src/core/payments/operations/payment_approve.rs +++ b/crates/router/src/core/payments/operations/payment_approve.rs @@ -81,7 +81,7 @@ impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsCaptureRequest> .find_business_profile_by_profile_id(key_manager_state, key_store, profile_id) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_string(), + id: profile_id.get_string_repr().to_owned(), })?; let attempt_id = payment_intent.active_attempt.get_id().clone(); diff --git a/crates/router/src/core/payments/operations/payment_cancel.rs b/crates/router/src/core/payments/operations/payment_cancel.rs index 84eaf97bfaa..4a26e533443 100644 --- a/crates/router/src/core/payments/operations/payment_cancel.rs +++ b/crates/router/src/core/payments/operations/payment_cancel.rs @@ -150,7 +150,7 @@ impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsCancelRequest> .find_business_profile_by_profile_id(key_manager_state, key_store, profile_id) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_string(), + id: profile_id.get_string_repr().to_owned(), })?; let payment_data = PaymentData { diff --git a/crates/router/src/core/payments/operations/payment_capture.rs b/crates/router/src/core/payments/operations/payment_capture.rs index 0d096e1d3ae..de7ee996195 100644 --- a/crates/router/src/core/payments/operations/payment_capture.rs +++ b/crates/router/src/core/payments/operations/payment_capture.rs @@ -196,7 +196,7 @@ impl<F: Send + Clone> GetTracker<F, payments::PaymentData<F>, api::PaymentsCaptu .find_business_profile_by_profile_id(key_manager_state, key_store, profile_id) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_string(), + id: profile_id.get_string_repr().to_owned(), })?; let payment_data = payments::PaymentData { diff --git a/crates/router/src/core/payments/operations/payment_complete_authorize.rs b/crates/router/src/core/payments/operations/payment_complete_authorize.rs index 8d4e6f7a5f2..c7a2686724f 100644 --- a/crates/router/src/core/payments/operations/payment_complete_authorize.rs +++ b/crates/router/src/core/payments/operations/payment_complete_authorize.rs @@ -290,7 +290,7 @@ impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsRequest> for Co .find_business_profile_by_profile_id(key_manager_state, key_store, profile_id) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_string(), + id: profile_id.get_string_repr().to_owned(), })?; let payment_data = PaymentData { diff --git a/crates/router/src/core/payments/operations/payment_confirm.rs b/crates/router/src/core/payments/operations/payment_confirm.rs index 2e7131edce2..273773a80bb 100644 --- a/crates/router/src/core/payments/operations/payment_confirm.rs +++ b/crates/router/src/core/payments/operations/payment_confirm.rs @@ -164,7 +164,7 @@ impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsRequest> for Pa .map(\|business_profile_result\| { business_profile_result.to_not_found_response( errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_string(), + id: profile_id.get_string_repr().to_owned(), }, ) }) @@ -476,7 +476,7 @@ impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsRequest> for Pa helpers::get_additional_payment_data( &payment_method_data.into(), store.as_ref(), - profile_id.as_ref(), + &profile_id, ) .await }) diff --git a/crates/router/src/core/payments/operations/payment_create.rs b/crates/router/src/core/payments/operations/payment_create.rs index 2b80598adfb..a455f1d4c59 100644 --- a/crates/router/src/core/payments/operations/payment_create.rs +++ b/crates/router/src/core/payments/operations/payment_create.rs @@ -140,7 +140,7 @@ impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsRequest> for Pa .await .to_not_found_response( errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_string(), + id: profile_id.get_string_repr().to_owned(), }, )? }; @@ -883,7 +883,7 @@ impl PaymentCreate { payment_method_billing_address_id: Option<String>, payment_method_info: &Option<PaymentMethod>, key_store: &domain::MerchantKeyStore, - profile_id: String, + profile_id: common_utils::id_type::ProfileId, customer_acceptance: &Option<payments::CustomerAcceptance>, ) -> RouterResult<( storage::PaymentAttemptNew, @@ -1083,7 +1083,7 @@ impl PaymentCreate { payment_link_data: Option<api_models::payments::PaymentLinkResponse>, billing_address_id: Option<String>, active_attempt_id: String, - profile_id: String, + profile_id: common_utils::id_type::ProfileId, session_expiry: PrimitiveDateTime, ) -> RouterResult<storage::PaymentIntent> { let created_at @ modified_at @ last_synced = common_utils::date_time::now(); @@ -1293,7 +1293,7 @@ async fn create_payment_link( db: &dyn StorageInterface, amount: api::Amount, description: Option<String>, - profile_id: String, + profile_id: common_utils::id_type::ProfileId, domain_name: String, session_expiry: PrimitiveDateTime, locale: Option<String>, diff --git a/crates/router/src/core/payments/operations/payment_reject.rs b/crates/router/src/core/payments/operations/payment_reject.rs index a5d0b95a672..b148d5bbccc 100644 --- a/crates/router/src/core/payments/operations/payment_reject.rs +++ b/crates/router/src/core/payments/operations/payment_reject.rs @@ -134,7 +134,7 @@ impl<F: Send + Clone> GetTracker<F, PaymentData<F>, PaymentsCancelRequest> for P .find_business_profile_by_profile_id(key_manager_state, key_store, profile_id) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_string(), + id: profile_id.get_string_repr().to_owned(), })?; let payment_data = PaymentData { diff --git a/crates/router/src/core/payments/operations/payment_session.rs b/crates/router/src/core/payments/operations/payment_session.rs index af5f234e2ce..6b101b6bd1b 100644 --- a/crates/router/src/core/payments/operations/payment_session.rs +++ b/crates/router/src/core/payments/operations/payment_session.rs @@ -159,7 +159,7 @@ impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsSessionRequest> .find_business_profile_by_profile_id(key_manager_state, key_store, profile_id) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_string(), + id: profile_id.get_string_repr().to_owned(), })?; let payment_data = PaymentData { diff --git a/crates/router/src/core/payments/operations/payment_start.rs b/crates/router/src/core/payments/operations/payment_start.rs index ae9397aa8ec..9a29b36b55a 100644 --- a/crates/router/src/core/payments/operations/payment_start.rs +++ b/crates/router/src/core/payments/operations/payment_start.rs @@ -144,7 +144,7 @@ impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsStartRequest> f .find_business_profile_by_profile_id(key_manager_state, key_store, profile_id) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_string(), + id: profile_id.get_string_repr().to_owned(), })?; let payment_data = PaymentData { diff --git a/crates/router/src/core/payments/operations/payment_status.rs b/crates/router/src/core/payments/operations/payment_status.rs index 587bdc8ef00..f2453e52c86 100644 --- a/crates/router/src/core/payments/operations/payment_status.rs +++ b/crates/router/src/core/payments/operations/payment_status.rs @@ -376,7 +376,7 @@ async fn get_tracker_for_sync< .find_business_profile_by_profile_id(key_manager_state, key_store, profile_id) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_string(), + id: profile_id.get_string_repr().to_owned(), })?; let payment_method_info = diff --git a/crates/router/src/core/payments/operations/payment_update.rs b/crates/router/src/core/payments/operations/payment_update.rs index e7045116f23..32d7b32059b 100644 --- a/crates/router/src/core/payments/operations/payment_update.rs +++ b/crates/router/src/core/payments/operations/payment_update.rs @@ -419,7 +419,7 @@ impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsRequest> for Pa .find_business_profile_by_profile_id(key_manager_state, key_store, profile_id) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_string(), + id: profile_id.get_string_repr().to_owned(), })?; let surcharge_details = request.surcharge_details.map(\|request_surcharge_details\| { diff --git a/crates/router/src/core/payments/operations/payments_incremental_authorization.rs b/crates/router/src/core/payments/operations/payments_incremental_authorization.rs index 31883042eca..e3e3bf4260e 100644 --- a/crates/router/src/core/payments/operations/payments_incremental_authorization.rs +++ b/crates/router/src/core/payments/operations/payments_incremental_authorization.rs @@ -112,7 +112,7 @@ impl<F: Send + Clone> .find_business_profile_by_profile_id(key_manager_state, key_store, profile_id) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_string(), + id: profile_id.get_string_repr().to_owned(), })?; let payment_data = payments::PaymentData { diff --git a/crates/router/src/core/payments/routing.rs b/crates/router/src/core/payments/routing.rs index 30c1edb6e04..692a5924a06 100644 --- a/crates/router/src/core/payments/routing.rs +++ b/crates/router/src/core/payments/routing.rs @@ -81,7 +81,7 @@ pub struct SessionRoutingPmTypeInput<'a> { routing_algorithm: &'a MerchantAccountRoutingAlgorithm, backend_input: dsl_inputs::BackendInput, allowed_connectors: FxHashMap<String, api::GetToken>, - profile_id: String, + profile_id: common_utils::id_type::ProfileId, } type RoutingResult<O> = oss_errors::CustomResult<O, errors::RoutingError>; @@ -291,7 +291,7 @@ pub async fn perform_static_routing_v1<F: Clone>( ))] let fallback_config = routing::helpers::get_merchant_default_config( &state.clone().store, - &business_profile.profile_id, + business_profile.profile_id.get_string_repr(), &api_enums::TransactionType::from(transaction_data), ) .await @@ -342,22 +342,24 @@ async fn ensure_algorithm_cached_v1( state: &SessionState, merchant_id: &common_utils::id_type::MerchantId, algorithm_id: &str, - profile_id: String, + profile_id: common_utils::id_type::ProfileId, transaction_type: &api_enums::TransactionType, ) -> RoutingResult<Arc<CachedAlgorithm>> { let key = { match transaction_type { common_enums::TransactionType::Payment => { format!( - "routing_config_{}_{profile_id}", - merchant_id.get_string_repr() + "routing_config_{}_{}", + merchant_id.get_string_repr(), + profile_id.get_string_repr(), ) } #[cfg(feature = "payouts")] common_enums::TransactionType::Payout => { format!( - "routing_config_po_{}_{profile_id}", - merchant_id.get_string_repr() + "routing_config_po_{}_{}", + merchant_id.get_string_repr(), + profile_id.get_string_repr() ) } } @@ -425,7 +427,7 @@ pub async fn refresh_routing_cache_v1( state: &SessionState, key: String, algorithm_id: &str, - profile_id: String, + profile_id: common_utils::id_type::ProfileId, ) -> RoutingResult<Arc<CachedAlgorithm>> { let algorithm = { let algorithm = state @@ -507,7 +509,7 @@ pub fn perform_volume_split( pub async fn get_merchant_cgraph<'a>( state: &SessionState, key_store: &domain::MerchantKeyStore, - profile_id: String, + profile_id: common_utils::id_type::ProfileId, transaction_type: &api_enums::TransactionType, ) -> RoutingResult<Arc<hyperswitch_constraint_graph::ConstraintGraph<euclid_dir::DirValue>>> { let merchant_id = &key_store.merchant_id; @@ -515,11 +517,19 @@ pub async fn get_merchant_cgraph<'a>( let key = { match transaction_type { api_enums::TransactionType::Payment => { - format!("cgraph_{}_{}", merchant_id.get_string_repr(), profile_id) + format!( + "cgraph_{}_{}", + merchant_id.get_string_repr(), + profile_id.get_string_repr() + ) } #[cfg(feature = "payouts")] api_enums::TransactionType::Payout => { - format!("cgraph_po_{}_{}", merchant_id.get_string_repr(), profile_id) + format!( + "cgraph_po_{}_{}", + merchant_id.get_string_repr(), + profile_id.get_string_repr() + ) } } }; @@ -546,7 +556,7 @@ pub async fn refresh_cgraph_cache<'a>( state: &SessionState, key_store: &domain::MerchantKeyStore, key: String, - profile_id: String, + profile_id: common_utils::id_type::ProfileId, transaction_type: &api_enums::TransactionType, ) -> RoutingResult<Arc<hyperswitch_constraint_graph::ConstraintGraph<euclid_dir::DirValue>>> { let mut merchant_connector_accounts = state @@ -645,7 +655,7 @@ async fn perform_cgraph_filtering( chosen: Vec<routing_types::RoutableConnectorChoice>, backend_input: dsl_inputs::BackendInput, eligible_connectors: Option<&Vec<api_enums::RoutableConnectors>>, - profile_id: String, + profile_id: common_utils::id_type::ProfileId, transaction_type: &api_enums::TransactionType, ) -> RoutingResult<Vec<routing_types::RoutableConnectorChoice>> { let context = euclid_graph::AnalysisContext::from_dir_values( @@ -689,7 +699,7 @@ pub async fn perform_eligibility_analysis<F: Clone>( chosen: Vec<routing_types::RoutableConnectorChoice>, transaction_data: &routing::TransactionData<'_, F>, eligible_connectors: Option<&Vec<api_enums::RoutableConnectors>>, - profile_id: String, + profile_id: common_utils::id_type::ProfileId, ) -> RoutingResult<Vec<routing_types::RoutableConnectorChoice>> { let backend_input = match transaction_data { routing::TransactionData::Payment(payment_data) => make_dsl_input(payment_data)?, @@ -728,9 +738,12 @@ pub async fn perform_fallback_routing<F: Clone>( .profile_id .as_ref() .get_required_value("profile_id") - .change_context(errors::RoutingError::ProfileIdMissing)?, + .change_context(errors::RoutingError::ProfileIdMissing)? + .get_string_repr(), #[cfg(feature = "payouts")] - routing::TransactionData::Payout(payout_data) => &payout_data.payout_attempt.profile_id, + routing::TransactionData::Payout(payout_data) => { + payout_data.payout_attempt.profile_id.get_string_repr() + } }, &api_enums::TransactionType::from(transaction_data), ) @@ -1015,7 +1028,7 @@ async fn perform_session_routing_for_pm_type( } else { routing::helpers::get_merchant_default_config( &session_pm_input.state.clone().store, - &session_pm_input.profile_id, + session_pm_input.profile_id.get_string_repr(), transaction_type, ) .await @@ -1036,7 +1049,7 @@ async fn perform_session_routing_for_pm_type( if final_selection.is_empty() { let fallback = routing::helpers::get_merchant_default_config( &session_pm_input.state.clone().store, - &session_pm_input.profile_id, + session_pm_input.profile_id.get_string_repr(), transaction_type, ) .await diff --git a/crates/router/src/core/payouts.rs b/crates/router/src/core/payouts.rs index a54f00d6aa0..e439a052a4c 100644 --- a/crates/router/src/core/payouts.rs +++ b/crates/router/src/core/payouts.rs @@ -66,7 +66,7 @@ pub struct PayoutData { pub payouts: storage::Payouts, pub payout_attempt: storage::PayoutAttempt, pub payout_method_data: Option<payouts::PayoutMethodData>, - pub profile_id: String, + pub profile_id: common_utils::id_type::ProfileId, pub should_terminate: bool, pub payout_link: Option<PayoutLink>, } @@ -514,7 +514,7 @@ pub async fn payouts_update_core( pub async fn payouts_retrieve_core( state: SessionState, merchant_account: domain::MerchantAccount, - profile_id: Option<String>, + profile_id: Option<common_utils::id_type::ProfileId>, key_store: domain::MerchantKeyStore, req: payouts::PayoutRetrieveRequest, ) -> RouterResponse<payouts::PayoutCreateResponse> { @@ -740,7 +740,7 @@ pub async fn payouts_fulfill_core( pub async fn payouts_list_core( _state: SessionState, _merchant_account: domain::MerchantAccount, - _profile_id_list: Option<Vec<String>>, + _profile_id_list: Option<Vec<common_utils::id_type::ProfileId>>, _key_store: domain::MerchantKeyStore, _constraints: payouts::PayoutListConstraints, ) -> RouterResponse<payouts::PayoutListResponse> { @@ -755,7 +755,7 @@ pub async fn payouts_list_core( pub async fn payouts_list_core( state: SessionState, merchant_account: domain::MerchantAccount, - profile_id_list: Option<Vec<String>>, + profile_id_list: Option<Vec<common_utils::id_type::ProfileId>>, key_store: domain::MerchantKeyStore, constraints: payouts::PayoutListConstraints, ) -> RouterResponse<payouts::PayoutListResponse> { @@ -864,7 +864,7 @@ pub async fn payouts_list_core( pub async fn payouts_filtered_list_core( state: SessionState, merchant_account: domain::MerchantAccount, - profile_id_list: Option<Vec<String>>, + profile_id_list: Option<Vec<common_utils::id_type::ProfileId>>, key_store: domain::MerchantKeyStore, filters: payouts::PayoutListFilterConstraints, ) -> RouterResponse<payouts::PayoutListResponse> { @@ -1143,7 +1143,11 @@ pub async fn create_recipient( let connector_name = connector_data.connector_name.to_string(); // Create the connector label using {profile_id}_{connector_name} - let connector_label = format!("{}_{}", payout_data.profile_id, connector_name); + let connector_label = format!( + "{}_{}", + payout_data.profile_id.get_string_repr(), + connector_name + ); let (should_call_connector, _connector_customer_id) = helpers::should_call_payout_connector_create_customer( state, @@ -2217,7 +2221,7 @@ pub async fn payout_create_db_entries( key_store: &domain::MerchantKeyStore, req: &payouts::PayoutCreateRequest, payout_id: &String, - profile_id: &String, + profile_id: &common_utils::id_type::ProfileId, stored_payout_method_data: Option<&payouts::PayoutMethodData>, locale: &String, customer: Option<&domain::Customer>, @@ -2291,7 +2295,7 @@ pub async fn payout_create_db_entries( let payouts_req = storage::PayoutsNew { payout_id: payout_id.to_string(), merchant_id: merchant_id.to_owned(), - customer_id, + customer_id: customer_id.to_owned(), address_id: address_id.to_owned(), payout_type, amount, @@ -2303,7 +2307,7 @@ pub async fn payout_create_db_entries( return_url: req.return_url.to_owned(), entity_type: req.entity_type.unwrap_or_default(), payout_method_id, - profile_id: profile_id.to_string(), + profile_id: profile_id.to_owned(), attempt_count: 1, metadata: req.metadata.clone(), confirm: req.confirm, @@ -2313,7 +2317,8 @@ pub async fn payout_create_db_entries( client_secret: Some(client_secret), priority: req.priority, status, - ..Default::default() + created_at: common_utils::date_time::now(), + last_modified_at: common_utils::date_time::now(), }; let payouts = db .insert_payout(payouts_req, merchant_account.storage_scheme) @@ -2333,8 +2338,18 @@ pub async fn payout_create_db_entries( business_country: req.business_country.to_owned(), business_label: req.business_label.to_owned(), payout_token: req.payout_token.to_owned(), - profile_id: profile_id.to_string(), - ..Default::default() + profile_id: profile_id.to_owned(), + customer_id, + address_id, + connector: None, + connector_payout_id: None, + is_eligible: None, + error_message: None, + error_code: None, + created_at: common_utils::date_time::now(), + last_modified_at: common_utils::date_time::now(), + merchant_connector_id: None, + routing_info: None, }; let payout_attempt = db .insert_payout_attempt( @@ -2371,7 +2386,7 @@ pub async fn payout_create_db_entries( pub async fn make_payout_data( _state: &SessionState, _merchant_account: &domain::MerchantAccount, - _auth_profile_id: Option<String>, + _auth_profile_id: Option<common_utils::id_type::ProfileId>, _key_store: &domain::MerchantKeyStore, _req: &payouts::PayoutRequest, ) -> RouterResult<PayoutData> { @@ -2382,7 +2397,7 @@ pub async fn make_payout_data( pub async fn make_payout_data( state: &SessionState, merchant_account: &domain::MerchantAccount, - auth_profile_id: Option<String>, + auth_profile_id: Option<common_utils::id_type::ProfileId>, key_store: &domain::MerchantKeyStore, req: &payouts::PayoutRequest, ) -> RouterResult<PayoutData> { @@ -2568,7 +2583,7 @@ pub async fn add_external_account_addition_task( async fn validate_and_get_business_profile( state: &SessionState, merchant_key_store: &domain::MerchantKeyStore, - profile_id: &String, + profile_id: &common_utils::id_type::ProfileId, merchant_id: &common_utils::id_type::MerchantId, ) -> RouterResult<domain::BusinessProfile> { let db = &state.store; @@ -2588,7 +2603,7 @@ async fn validate_and_get_business_profile( db.find_business_profile_by_profile_id(key_manager_state, merchant_key_store, profile_id) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_string(), + id: profile_id.get_string_repr().to_owned(), }) } } @@ -2727,7 +2742,7 @@ pub async fn create_payout_link_db_entry( pub async fn get_mca_from_profile_id( state: &SessionState, merchant_account: &domain::MerchantAccount, - profile_id: &String, + profile_id: &common_utils::id_type::ProfileId, connector_name: &str, merchant_connector_id: Option<&String>, key_store: &domain::MerchantKeyStore, diff --git a/crates/router/src/core/payouts/retry.rs b/crates/router/src/core/payouts/retry.rs index 284f81a1702..08fef69988c 100644 --- a/crates/router/src/core/payouts/retry.rs +++ b/crates/router/src/core/payouts/retry.rs @@ -285,8 +285,16 @@ pub async fn modify_trackers( business_country: payout_data.payout_attempt.business_country.to_owned(), business_label: payout_data.payout_attempt.business_label.to_owned(), payout_token: payout_data.payout_attempt.payout_token.to_owned(), - profile_id: payout_data.payout_attempt.profile_id.to_string(), - ..Default::default() + profile_id: payout_data.payout_attempt.profile_id.to_owned(), + connector_payout_id: None, + status: common_enums::PayoutStatus::default(), + is_eligible: None, + error_message: None, + error_code: None, + created_at: common_utils::date_time::now(), + last_modified_at: common_utils::date_time::now(), + merchant_connector_id: None, + routing_info: None, }; payout_data.payout_attempt = db .insert_payout_attempt( diff --git a/crates/router/src/core/payouts/validator.rs b/crates/router/src/core/payouts/validator.rs index d425725645b..bde753a90e0 100644 --- a/crates/router/src/core/payouts/validator.rs +++ b/crates/router/src/core/payouts/validator.rs @@ -56,7 +56,7 @@ pub async fn validate_create_request( ) -> RouterResult<( String, Option<payouts::PayoutMethodData>, - String, + common_utils::id_type::ProfileId, Option<domain::Customer>, )> { let merchant_id = merchant_account.get_id(); diff --git a/crates/router/src/core/refunds.rs b/crates/router/src/core/refunds.rs index 878ec241854..89450347404 100644 --- a/crates/router/src/core/refunds.rs +++ b/crates/router/src/core/refunds.rs @@ -47,7 +47,7 @@ use crate::{ pub async fn refund_create_core( state: SessionState, merchant_account: domain::MerchantAccount, - _profile_id: Option<String>, + _profile_id: Option<common_utils::id_type::ProfileId>, key_store: domain::MerchantKeyStore, req: refunds::RefundRequest, ) -> RouterResponse<refunds::RefundResponse> { @@ -374,7 +374,7 @@ where pub async fn refund_response_wrapper<'a, F, Fut, T, Req>( state: SessionState, merchant_account: domain::MerchantAccount, - profile_id: Option<String>, + profile_id: Option<common_utils::id_type::ProfileId>, key_store: domain::MerchantKeyStore, request: Req, f: F, @@ -383,7 +383,7 @@ where F: Fn( SessionState, domain::MerchantAccount, - Option<String>, + Option<common_utils::id_type::ProfileId>, domain::MerchantKeyStore, Req, ) -> Fut, @@ -401,7 +401,7 @@ where pub async fn refund_retrieve_core( state: SessionState, merchant_account: domain::MerchantAccount, - profile_id: Option<String>, + profile_id: Option<common_utils::id_type::ProfileId>, key_store: domain::MerchantKeyStore, request: refunds::RefundsRetrieveRequest, ) -> RouterResult<storage::Refund> { @@ -865,7 +865,7 @@ pub async fn validate_and_create_refund( pub async fn refund_list( state: SessionState, merchant_account: domain::MerchantAccount, - _profile_id_list: Option<Vec<String>>, + _profile_id_list: Option<Vec<common_utils::id_type::ProfileId>>, req: api_models::refunds::RefundListRequest, ) -> RouterResponse<api_models::refunds::RefundListResponse> { let db = state.store; @@ -987,7 +987,7 @@ pub async fn refund_manual_update( pub async fn get_filters_for_refunds( state: SessionState, merchant_account: domain::MerchantAccount, - profile_id_list: Option<Vec<String>>, + profile_id_list: Option<Vec<common_utils::id_type::ProfileId>>, ) -> RouterResponse<api_models::refunds::RefundListFilters> { let merchant_connector_accounts = if let services::ApplicationResponse::Json(data) = super::admin::list_payment_connectors( diff --git a/crates/router/src/core/routing.rs b/crates/router/src/core/routing.rs index 2b7f2d18306..cdc22bc64d2 100644 --- a/crates/router/src/core/routing.rs +++ b/crates/router/src/core/routing.rs @@ -50,7 +50,7 @@ impl RoutingAlgorithmUpdate { pub fn create_new_routing_algorithm( request: &routing_types::RoutingConfigRequest, merchant_id: &common_utils::id_type::MerchantId, - profile_id: String, + profile_id: common_utils::id_type::ProfileId, transaction_type: &enums::TransactionType, ) -> Self { let algorithm_id = common_utils::generate_id( @@ -279,7 +279,7 @@ pub async fn link_routing_config_under_profile( state: SessionState, merchant_account: domain::MerchantAccount, key_store: domain::MerchantKeyStore, - profile_id: String, + profile_id: common_utils::id_type::ProfileId, algorithm_id: String, transaction_type: &enums::TransactionType, ) -> RouterResponse<routing_types::RoutingDictionaryRecord> { @@ -377,7 +377,7 @@ pub async fn link_routing_config( .await? .get_required_value("BusinessProfile") .change_context(errors::ApiErrorResponse::BusinessProfileNotFound { - id: routing_algorithm.profile_id.clone(), + id: routing_algorithm.profile_id.get_string_repr().to_owned(), })?; let mut routing_ref: routing_types::RoutingAlgorithmRef = business_profile @@ -503,7 +503,7 @@ pub async fn unlink_routing_config_under_profile( state: SessionState, merchant_account: domain::MerchantAccount, key_store: domain::MerchantKeyStore, - profile_id: String, + profile_id: common_utils::id_type::ProfileId, transaction_type: &enums::TransactionType, ) -> RouterResponse<routing_types::RoutingDictionaryRecord> { metrics::ROUTING_UNLINK_CONFIG.add(&metrics::CONTEXT, 1, &[]); @@ -649,7 +649,7 @@ pub async fn update_default_fallback_routing( state: SessionState, merchant_account: domain::MerchantAccount, key_store: domain::MerchantKeyStore, - profile_id: String, + profile_id: common_utils::id_type::ProfileId, updated_list_of_connectors: Vec<routing_types::RoutableConnectorChoice>, ) -> RouterResponse<Vec<routing_types::RoutableConnectorChoice>> { metrics::ROUTING_UPDATE_CONFIG.add(&metrics::CONTEXT, 1, &[]); @@ -785,7 +785,7 @@ pub async fn retrieve_default_fallback_algorithm_for_profile( state: SessionState, merchant_account: domain::MerchantAccount, key_store: domain::MerchantKeyStore, - profile_id: String, + profile_id: common_utils::id_type::ProfileId, ) -> RouterResponse<Vec<routing_types::RoutableConnectorChoice>> { metrics::ROUTING_RETRIEVE_DEFAULT_CONFIG.add(&metrics::CONTEXT, 1, &[]); let db = state.store.as_ref(); @@ -841,7 +841,7 @@ pub async fn retrieve_routing_config_under_profile( merchant_account: domain::MerchantAccount, key_store: domain::MerchantKeyStore, query_params: RoutingRetrieveQuery, - profile_id: String, + profile_id: common_utils::id_type::ProfileId, transaction_type: &enums::TransactionType, ) -> RouterResponse<routing_types::LinkedRoutingConfigRetrieveResponse> { metrics::ROUTING_RETRIEVE_LINK_CONFIG.add(&metrics::CONTEXT, 1, &[]); @@ -905,7 +905,9 @@ pub async fn retrieve_linked_routing_config( .await? .map(\|profile\| vec![profile]) .get_required_value("BusinessProfile") - .change_context(errors::ApiErrorResponse::BusinessProfileNotFound { id: profile_id })? + .change_context(errors::ApiErrorResponse::BusinessProfileNotFound { + id: profile_id.get_string_repr().to_owned(), + })? } else { db.list_business_profile_by_merchant_id( key_manager_state, @@ -972,7 +974,13 @@ pub async fn retrieve_default_routing_config_for_profiles( let retrieve_config_futures = all_profiles .iter() - .map(\|prof\| helpers::get_merchant_default_config(db, &prof.profile_id, transaction_type)) + .map(\|prof\| { + helpers::get_merchant_default_config( + db, + prof.profile_id.get_string_repr(), + transaction_type, + ) + }) .collect::<Vec<_>>(); let configs = futures::future::join_all(retrieve_config_futures) @@ -1000,7 +1008,7 @@ pub async fn update_default_routing_config_for_profile( merchant_account: domain::MerchantAccount, key_store: domain::MerchantKeyStore, updated_config: Vec<routing_types::RoutableConnectorChoice>, - profile_id: String, + profile_id: common_utils::id_type::ProfileId, transaction_type: &enums::TransactionType, ) -> RouterResponse<routing_types::ProfileDefaultRoutingConfig> { metrics::ROUTING_UPDATE_CONFIG_FOR_PROFILE.add(&metrics::CONTEXT, 1, &[]); @@ -1016,10 +1024,15 @@ pub async fn update_default_routing_config_for_profile( ) .await? .get_required_value("BusinessProfile") - .change_context(errors::ApiErrorResponse::BusinessProfileNotFound { id: profile_id })?; - let default_config = - helpers::get_merchant_default_config(db, &business_profile.profile_id, transaction_type) - .await?; + .change_context(errors::ApiErrorResponse::BusinessProfileNotFound { + id: profile_id.get_string_repr().to_owned(), + })?; + let default_config = helpers::get_merchant_default_config( + db, + business_profile.profile_id.get_string_repr(), + transaction_type, + ) + .await?; utils::when(default_config.len() != updated_config.len(), \|\| { Err(errors::ApiErrorResponse::PreconditionFailed { @@ -1058,7 +1071,7 @@ pub async fn update_default_routing_config_for_profile( helpers::update_merchant_default_config( db, - &business_profile.profile_id, + business_profile.profile_id.get_string_repr(), updated_config.clone(), transaction_type, ) diff --git a/crates/router/src/core/routing/helpers.rs b/crates/router/src/core/routing/helpers.rs index 43da2bb2bd0..5cbb1e9fdf6 100644 --- a/crates/router/src/core/routing/helpers.rs +++ b/crates/router/src/core/routing/helpers.rs @@ -207,8 +207,9 @@ pub async fn update_business_profile_active_algorithm_ref( let routing_cache_key = cache::CacheKind::Routing( format!( - "routing_config_{}_{profile_id}", - merchant_id.get_string_repr() + "routing_config_{}_{}", + merchant_id.get_string_repr(), + profile_id.get_string_repr(), ) .into(), ); @@ -300,13 +301,13 @@ impl MerchantConnectorAccounts { pub fn filter_by_profile<'a, T>( &'a self, - profile_id: &'a str, + profile_id: &'a common_utils::id_type::ProfileId, func: impl Fn(&'a MerchantConnectorAccount) -> T, ) -> FxHashSet<T> where T: std::hash::Hash + Eq, { - self.filter_and_map(\|mca\| mca.profile_id == profile_id, func) + self.filter_and_map(\|mca\| mca.profile_id == profile_id, func) } } @@ -396,7 +397,7 @@ pub async fn validate_connectors_in_routing_config( state: &SessionState, key_store: &domain::MerchantKeyStore, merchant_id: &common_utils::id_type::MerchantId, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, routing_algorithm: &routing_types::RoutingAlgorithm, ) -> RouterResult<()> { let all_mcas = &state @@ -413,13 +414,13 @@ pub async fn validate_connectors_in_routing_config( })?; let name_mca_id_set = all_mcas .iter() - .filter(\|mca\| mca.profile_id == profile_id) + .filter(\|mca\| mca.profile_id == profile_id) .map(\|mca\| (&mca.connector_name, mca.get_id())) .collect::<FxHashSet<_>>(); let name_set = all_mcas .iter() - .filter(\|mca\| mca.profile_id == profile_id) + .filter(\|mca\| mca.profile_id == profile_id) .map(\|mca\| &mca.connector_name) .collect::<FxHashSet<_>>(); diff --git a/crates/router/src/core/utils.rs b/crates/router/src/core/utils.rs index 02a10252cd3..c46fac1322c 100644 --- a/crates/router/src/core/utils.rs +++ b/crates/router/src/core/utils.rs @@ -94,7 +94,11 @@ pub async fn construct_payout_router_data<'a, F>( let payouts = &payout_data.payouts; let payout_attempt = &payout_data.payout_attempt; let customer_details = &payout_data.customer_details; - let connector_label = format!("{}_{}", payout_data.profile_id, connector_name); + let connector_label = format!( + "{}_{}", + payout_data.profile_id.get_string_repr(), + connector_name + ); let connector_customer_id = customer_details .as_ref() .and_then(\|c\| c.connector_customer.as_ref()) @@ -394,6 +398,7 @@ pub fn validate_uuid(uuid: String, key: &str) -> Result<String, errors::ApiError #[cfg(test)] mod tests { + #![allow(clippy::expect_used)] use super::; #[test] @@ -425,23 +430,33 @@ mod tests { fn test_filter_objects_based_on_profile_id_list() { #[derive(PartialEq, Debug, Clone)] struct Object { - profile_id: Option<String>, + profile_id: Option<common_utils::id_type::ProfileId>, } impl Object { - pub fn new(profile_id: &str) -> Self { + pub fn new(profile_id: &'static str) -> Self { Self { - profile_id: Some(profile_id.to_string()), + profile_id: Some( + common_utils::id_type::ProfileId::try_from(std::borrow::Cow::from( + profile_id, + )) + .expect("invalid profile ID"), + ), } } } impl GetProfileId for Object { - fn get_profile_id(&self) -> Option<&String> { + fn get_profile_id(&self) -> Option<&common_utils::id_type::ProfileId> { self.profile_id.as_ref() } } + fn new_profile_id(profile_id: &'static str) -> common_utils::id_type::ProfileId { + common_utils::id_type::ProfileId::try_from(std::borrow::Cow::from(profile_id)) + .expect("invalid profile ID") + } + // non empty object_list and profile_id_list let object_list = vec![ Object::new("p1"), @@ -450,7 +465,11 @@ mod tests { Object::new("p4"), Object::new("p5"), ]; - let profile_id_list = vec!["p1".to_string(), "p2".to_string(), "p3".to_string()]; + let profile_id_list = vec![ + new_profile_id("p1"), + new_profile_id("p2"), + new_profile_id("p3"), + ]; let filtered_list = filter_objects_based_on_profile_id_list(Some(profile_id_list), object_list.clone()); let expected_result = vec![Object::new("p1"), Object::new("p2"), Object::new("p2")]; @@ -1040,7 +1059,7 @@ pub async fn validate_and_get_business_profile( db: &dyn StorageInterface, key_manager_state: &common_utils::types::keymanager::KeyManagerState, merchant_key_store: &domain::MerchantKeyStore, - profile_id: Option<&String>, + profile_id: Option<&common_utils::id_type::ProfileId>, merchant_id: &common_utils::id_type::MerchantId, ) -> RouterResult<Option<domain::BusinessProfile>> { profile_id @@ -1052,7 +1071,7 @@ pub async fn validate_and_get_business_profile( ) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_owned(), + id: profile_id.get_string_repr().to_owned(), }) }) .await @@ -1061,7 +1080,7 @@ pub async fn validate_and_get_business_profile( // Check if the merchant_id of business profile is same as the current merchant_id if business_profile.merchant_id.ne(merchant_id) { Err(errors::ApiErrorResponse::AccessForbidden { - resource: business_profile.profile_id, + resource: business_profile.profile_id.get_string_repr().to_owned(), } .into()) } else { @@ -1123,10 +1142,10 @@ pub async fn get_profile_id_from_business_details( business_country: Option<api_models::enums::CountryAlpha2>, business_label: Option<&String>, merchant_account: &domain::MerchantAccount, - request_profile_id: Option<&String>, + request_profile_id: Option<&common_utils::id_type::ProfileId>, db: &dyn StorageInterface, should_validate: bool, -) -> RouterResult<String> { +) -> RouterResult<common_utils::id_type::ProfileId> { match request_profile_id.or(merchant_account.default_profile.as_ref()) { Some(profile_id) => { // Check whether this business profile belongs to the merchant @@ -1297,55 +1316,55 @@ pub fn get_incremental_authorization_allowed_value( } pub(super) trait GetProfileId { - fn get_profile_id(&self) -> Option<&String>; + fn get_profile_id(&self) -> Option<&common_utils::id_type::ProfileId>; } impl GetProfileId for MerchantConnectorAccount { - fn get_profile_id(&self) -> Option<&String> { + fn get_profile_id(&self) -> Option<&common_utils::id_type::ProfileId> { Some(&self.profile_id) } } impl GetProfileId for storage::PaymentIntent { - fn get_profile_id(&self) -> Option<&String> { + fn get_profile_id(&self) -> Option<&common_utils::id_type::ProfileId> { self.profile_id.as_ref() } } impl<A> GetProfileId for (storage::PaymentIntent, A) { - fn get_profile_id(&self) -> Option<&String> { + fn get_profile_id(&self) -> Option<&common_utils::id_type::ProfileId> { self.0.get_profile_id() } } impl GetProfileId for diesel_models::Dispute { - fn get_profile_id(&self) -> Option<&String> { + fn get_profile_id(&self) -> Option<&common_utils::id_type::ProfileId> { self.profile_id.as_ref() } } impl GetProfileId for diesel_models::Refund { - fn get_profile_id(&self) -> Option<&String> { + fn get_profile_id(&self) -> Option<&common_utils::id_type::ProfileId> { self.profile_id.as_ref() } } #[cfg(feature = "payouts")] impl GetProfileId for storage::Payouts { - fn get_profile_id(&self) -> Option<&String> { + fn get_profile_id(&self) -> Option<&common_utils::id_type::ProfileId> { Some(&self.profile_id) } } #[cfg(feature = "payouts")] impl<T, F> GetProfileId for (storage::Payouts, T, F) { - fn get_profile_id(&self) -> Option<&String> { + fn get_profile_id(&self) -> Option<&common_utils::id_type::ProfileId> { self.0.get_profile_id() } } /// Filter Objects based on profile ids pub(super) fn filter_objects_based_on_profile_id_list<T: GetProfileId>( - profile_id_list_auth_layer: Option<Vec<String>>, + profile_id_list_auth_layer: Option<Vec<common_utils::id_type::ProfileId>>, object_list: Vec<T>, ) -> Vec<T> { if let Some(profile_id_list) = profile_id_list_auth_layer { @@ -1369,7 +1388,7 @@ pub(super) fn filter_objects_based_on_profile_id_list<T: GetProfileId>( } pub(super) fn validate_profile_id_from_auth_layer<T: GetProfileId + std::fmt::Debug>( - profile_id_auth_layer: Option<String>, + profile_id_auth_layer: Option<common_utils::id_type::ProfileId>, object: &T, ) -> RouterResult<()> { match (profile_id_auth_layer, object.get_profile_id()) { diff --git a/crates/router/src/core/verification.rs b/crates/router/src/core/verification.rs index 795e188c8aa..44bb67d0baf 100644 --- a/crates/router/src/core/verification.rs +++ b/crates/router/src/core/verification.rs @@ -12,7 +12,7 @@ pub async fn verify_merchant_creds_for_applepay( state: SessionState, body: verifications::ApplepayMerchantVerificationRequest, merchant_id: common_utils::id_type::MerchantId, - profile_id: Option<String>, + profile_id: Option<common_utils::id_type::ProfileId>, ) -> CustomResult<services::ApplicationResponse<ApplepayMerchantResponse>, errors::ApiErrorResponse> { let applepay_merchant_configs = state.conf.applepay_merchant_configs.get_inner(); diff --git a/crates/router/src/core/verification/utils.rs b/crates/router/src/core/verification/utils.rs index dd0aa3edef4..4b8e0ac0748 100644 --- a/crates/router/src/core/verification/utils.rs +++ b/crates/router/src/core/verification/utils.rs @@ -15,7 +15,7 @@ use crate::{ pub async fn check_existence_and_add_domain_to_db( state: &SessionState, merchant_id: common_utils::id_type::MerchantId, - profile_id_from_auth_layer: Option<String>, + profile_id_from_auth_layer: Option<common_utils::id_type::ProfileId>, merchant_connector_id: String, domain_from_req: Vec<String>, ) -> CustomResult<Vec<String>, errors::ApiErrorResponse> { diff --git a/crates/router/src/core/verify_connector.rs b/crates/router/src/core/verify_connector.rs index b6f03c27ab0..f7fa06dee5f 100644 --- a/crates/router/src/core/verify_connector.rs +++ b/crates/router/src/core/verify_connector.rs @@ -19,7 +19,7 @@ use crate::{ pub async fn verify_connector_credentials( state: SessionState, req: VerifyConnectorRequest, - _profile_id: Option<String>, + _profile_id: Option<common_utils::id_type::ProfileId>, ) -> errors::RouterResponse<()> { let boxed_connector = api::ConnectorData::get_connector_by_name( &state.conf.connectors, diff --git a/crates/router/src/core/webhooks/incoming.rs b/crates/router/src/core/webhooks/incoming.rs index d3e5873e9e9..01a1046be36 100644 --- a/crates/router/src/core/webhooks/incoming.rs +++ b/crates/router/src/core/webhooks/incoming.rs @@ -347,14 +347,14 @@ async fn incoming_webhooks_core<W: types::OutgoingWebhookType>( )?, }; - let profile_id = merchant_connector_account.profile_id.as_ref(); + let profile_id = &merchant_connector_account.profile_id; let business_profile = state .store .find_business_profile_by_profile_id(key_manager_state, &key_store, profile_id) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_string(), + id: profile_id.get_string_repr().to_owned(), })?; match flow_type { diff --git a/crates/router/src/core/webhooks/outgoing.rs b/crates/router/src/core/webhooks/outgoing.rs index b075b15e7f8..276d296a4cb 100644 --- a/crates/router/src/core/webhooks/outgoing.rs +++ b/crates/router/src/core/webhooks/outgoing.rs @@ -71,7 +71,7 @@ pub(crate) async fn create_event_and_trigger_outgoing_webhook( \|\| webhook_url_result.as_ref().is_ok_and(String::is_empty) { logger::debug!( - business_profile_id=%business_profile.profile_id, + business_profile_id=?business_profile.profile_id, %idempotent_event_id, "Outgoing webhooks are disabled in application configuration, or merchant webhook URL \ could not be obtained; skipping outgoing webhooks for event" diff --git a/crates/router/src/core/webhooks/types.rs b/crates/router/src/core/webhooks/types.rs index d9eed529e88..d9094bff001 100644 --- a/crates/router/src/core/webhooks/types.rs +++ b/crates/router/src/core/webhooks/types.rs @@ -59,7 +59,7 @@ impl OutgoingWebhookType for webhooks::OutgoingWebhook { #[derive(Debug, serde::Serialize, serde::Deserialize)] pub(crate) struct OutgoingWebhookTrackingData { pub(crate) merchant_id: common_utils::id_type::MerchantId, - pub(crate) business_profile_id: String, + pub(crate) business_profile_id: common_utils::id_type::ProfileId, pub(crate) event_type: enums::EventType, pub(crate) event_class: enums::EventClass, pub(crate) primary_object_id: String, diff --git a/crates/router/src/core/webhooks/webhook_events.rs b/crates/router/src/core/webhooks/webhook_events.rs index cf4a8d87263..13f1e95fc2a 100644 --- a/crates/router/src/core/webhooks/webhook_events.rs +++ b/crates/router/src/core/webhooks/webhook_events.rs @@ -265,7 +265,7 @@ pub async fn retry_delivery_attempt( async fn get_account_and_key_store( state: SessionState, merchant_id: common_utils::id_type::MerchantId, - profile_id: Option<String>, + profile_id: Option<common_utils::id_type::ProfileId>, ) -> errors::RouterResult<(MerchantAccountOrBusinessProfile, domain::MerchantKeyStore)> { let store = state.store.as_ref(); let key_manager_state = &(&state).into(); @@ -292,13 +292,13 @@ async fn get_account_and_key_store( .await .attach_printable_lazy(\|\| { format!( - "Failed to find business profile by merchant_id `{merchant_id:?}` and profile_id `{profile_id}`. \ - The merchant_id associated with the business profile `{profile_id}` may be \ + "Failed to find business profile by merchant_id `{merchant_id:?}` and profile_id `{profile_id:?}`. \ + The merchant_id associated with the business profile `{profile_id:?}` may be \ different than the merchant_id specified (`{merchant_id:?}`)." ) }) .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id, + id: profile_id.get_string_repr().to_owned(), })?; Ok(( diff --git a/crates/router/src/db/business_profile.rs b/crates/router/src/db/business_profile.rs index ed178f275fd..8c81b0c3df1 100644 --- a/crates/router/src/db/business_profile.rs +++ b/crates/router/src/db/business_profile.rs @@ -33,7 +33,7 @@ where &self, key_manager_state: &KeyManagerState, merchant_key_store: &domain::MerchantKeyStore, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, ) -> CustomResult<domain::BusinessProfile, errors::StorageError>; async fn find_business_profile_by_merchant_id_profile_id( @@ -41,7 +41,7 @@ where key_manager_state: &KeyManagerState, merchant_key_store: &domain::MerchantKeyStore, merchant_id: &common_utils::id_type::MerchantId, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, ) -> CustomResult<domain::BusinessProfile, errors::StorageError>; async fn find_business_profile_by_profile_name_merchant_id( @@ -62,7 +62,7 @@ where async fn delete_business_profile_by_profile_id_merchant_id( &self, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, merchant_id: &common_utils::id_type::MerchantId, ) -> CustomResult<bool, errors::StorageError>; @@ -105,7 +105,7 @@ impl BusinessProfileInterface for Store { &self, key_manager_state: &KeyManagerState, merchant_key_store: &domain::MerchantKeyStore, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, ) -> CustomResult<domain::BusinessProfile, errors::StorageError> { let conn = connection::pg_connection_read(self).await?; storage::BusinessProfile::find_by_profile_id(&conn, profile_id) @@ -125,7 +125,7 @@ impl BusinessProfileInterface for Store { key_manager_state: &KeyManagerState, merchant_key_store: &domain::MerchantKeyStore, merchant_id: &common_utils::id_type::MerchantId, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, ) -> CustomResult<domain::BusinessProfile, errors::StorageError> { let conn = connection::pg_connection_read(self).await?; storage::BusinessProfile::find_by_merchant_id_profile_id(&conn, merchant_id, profile_id) @@ -191,7 +191,7 @@ impl BusinessProfileInterface for Store { #[instrument(skip_all)] async fn delete_business_profile_by_profile_id_merchant_id( &self, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, merchant_id: &common_utils::id_type::MerchantId, ) -> CustomResult<bool, errors::StorageError> { let conn = connection::pg_connection_write(self).await?; @@ -262,13 +262,13 @@ impl BusinessProfileInterface for MockDb { &self, key_manager_state: &KeyManagerState, merchant_key_store: &domain::MerchantKeyStore, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, ) -> CustomResult<domain::BusinessProfile, errors::StorageError> { self.business_profiles .lock() .await .iter() - .find(\|business_profile\| business_profile.profile_id == profile_id) + .find(\|business_profile\| business_profile.profile_id == profile_id) .cloned() .async_map(\|business_profile\| async { business_profile @@ -284,7 +284,7 @@ impl BusinessProfileInterface for MockDb { .transpose()? .ok_or( errors::StorageError::ValueNotFound(format!( - "No business profile found for profile_id = {profile_id}" + "No business profile found for profile_id = {profile_id:?}" )) .into(), ) @@ -295,7 +295,7 @@ impl BusinessProfileInterface for MockDb { key_manager_state: &KeyManagerState, merchant_key_store: &domain::MerchantKeyStore, merchant_id: &common_utils::id_type::MerchantId, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, ) -> CustomResult<domain::BusinessProfile, errors::StorageError> { self.business_profiles .lock() @@ -303,7 +303,7 @@ impl BusinessProfileInterface for MockDb { .iter() .find(\|business_profile\| { business_profile.merchant_id == merchant_id - && business_profile.profile_id == profile_id + && business_profile.profile_id == profile_id }) .cloned() .async_map(\|business_profile\| async { @@ -320,7 +320,7 @@ impl BusinessProfileInterface for MockDb { .transpose()? .ok_or( errors::StorageError::ValueNotFound(format!( - "No business profile found for merchant_id = {merchant_id:?} and profile_id = {profile_id}" + "No business profile found for merchant_id = {merchant_id:?} and profile_id = {profile_id:?}" )) .into(), ) @@ -362,7 +362,7 @@ impl BusinessProfileInterface for MockDb { .transpose()? .ok_or( errors::StorageError::ValueNotFound(format!( - "No business profile found for profile_id = {profile_id}" + "No business profile found for profile_id = {profile_id:?}" )) .into(), ) @@ -370,18 +370,18 @@ impl BusinessProfileInterface for MockDb { async fn delete_business_profile_by_profile_id_merchant_id( &self, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, merchant_id: &common_utils::id_type::MerchantId, ) -> CustomResult<bool, errors::StorageError> { let mut business_profiles = self.business_profiles.lock().await; let index = business_profiles .iter() .position(\|business_profile\| { - business_profile.profile_id == profile_id + business_profile.profile_id == profile_id && business_profile.merchant_id == *merchant_id }) .ok_or::<errors::StorageError>(errors::StorageError::ValueNotFound(format!( - "No business profile found for profile_id = {profile_id} and merchant_id = {merchant_id:?}" + "No business profile found for profile_id = {profile_id:?} and merchant_id = {merchant_id:?}" )))?; business_profiles.remove(index); Ok(true) diff --git a/crates/router/src/db/events.rs b/crates/router/src/db/events.rs index edd1eecff95..6aae49f1bde 100644 --- a/crates/router/src/db/events.rs +++ b/crates/router/src/db/events.rs @@ -67,7 +67,7 @@ where async fn list_initial_events_by_profile_id_primary_object_id( &self, state: &KeyManagerState, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, primary_object_id: &str, merchant_key_store: &domain::MerchantKeyStore, ) -> CustomResult<Vec<domain::Event>, errors::StorageError>; @@ -76,7 +76,7 @@ where async fn list_initial_events_by_profile_id_constraints( &self, state: &KeyManagerState, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, created_after: Option<time::PrimitiveDateTime>, created_before: Option<time::PrimitiveDateTime>, limit: Option<i64>, @@ -256,7 +256,7 @@ impl EventInterface for Store { async fn list_initial_events_by_profile_id_primary_object_id( &self, state: &KeyManagerState, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, primary_object_id: &str, merchant_key_store: &domain::MerchantKeyStore, ) -> CustomResult<Vec<domain::Event>, errors::StorageError> { @@ -291,7 +291,7 @@ impl EventInterface for Store { async fn list_initial_events_by_profile_id_constraints( &self, state: &KeyManagerState, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, created_after: Option<time::PrimitiveDateTime>, created_before: Option<time::PrimitiveDateTime>, limit: Option<i64>, @@ -554,7 +554,7 @@ impl EventInterface for MockDb { async fn list_initial_events_by_profile_id_primary_object_id( &self, state: &KeyManagerState, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, primary_object_id: &str, merchant_key_store: &domain::MerchantKeyStore, ) -> CustomResult<Vec<domain::Event>, errors::StorageError> { @@ -589,7 +589,7 @@ impl EventInterface for MockDb { async fn list_initial_events_by_profile_id_constraints( &self, state: &KeyManagerState, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, created_after: Option<time::PrimitiveDateTime>, created_before: Option<time::PrimitiveDateTime>, limit: Option<i64>, @@ -737,7 +737,8 @@ mod tests { let merchant_id = common_utils::id_type::MerchantId::try_from(std::borrow::Cow::from("merchant_1")) .unwrap(); - let business_profile_id = "profile1"; + let business_profile_id = + common_utils::id_type::ProfileId::try_from(std::borrow::Cow::from("profile1")).unwrap(); let payment_id = "test_payment_id"; let key_manager_state = &state.into(); let master_key = mockdb.get_master_key(); diff --git a/crates/router/src/db/kafka_store.rs b/crates/router/src/db/kafka_store.rs index cb3f6db144e..5cbcd2668eb 100644 --- a/crates/router/src/db/kafka_store.rs +++ b/crates/router/src/db/kafka_store.rs @@ -715,7 +715,7 @@ impl EventInterface for KafkaStore { async fn list_initial_events_by_profile_id_primary_object_id( &self, state: &KeyManagerState, - profile_id: &str, + profile_id: &id_type::ProfileId, primary_object_id: &str, merchant_key_store: &domain::MerchantKeyStore, ) -> CustomResult<Vec<domain::Event>, errors::StorageError> { @@ -732,7 +732,7 @@ impl EventInterface for KafkaStore { async fn list_initial_events_by_profile_id_constraints( &self, state: &KeyManagerState, - profile_id: &str, + profile_id: &id_type::ProfileId, created_after: Option<PrimitiveDateTime>, created_before: Option<PrimitiveDateTime>, limit: Option<i64>, @@ -1130,7 +1130,7 @@ impl MerchantConnectorAccountInterface for KafkaStore { async fn find_merchant_connector_account_by_profile_id_connector_name( &self, state: &KeyManagerState, - profile_id: &str, + profile_id: &id_type::ProfileId, connector_name: &str, key_store: &domain::MerchantKeyStore, ) -> CustomResult<domain::MerchantConnectorAccount, errors::StorageError> { @@ -2374,7 +2374,7 @@ impl BusinessProfileInterface for KafkaStore { &self, key_manager_state: &KeyManagerState, merchant_key_store: &domain::MerchantKeyStore, - profile_id: &str, + profile_id: &id_type::ProfileId, ) -> CustomResult<domain::BusinessProfile, errors::StorageError> { self.diesel_store .find_business_profile_by_profile_id(key_manager_state, merchant_key_store, profile_id) @@ -2386,7 +2386,7 @@ impl BusinessProfileInterface for KafkaStore { key_manager_state: &KeyManagerState, merchant_key_store: &domain::MerchantKeyStore, merchant_id: &id_type::MerchantId, - profile_id: &str, + profile_id: &id_type::ProfileId, ) -> CustomResult<domain::BusinessProfile, errors::StorageError> { self.diesel_store .find_business_profile_by_merchant_id_profile_id( @@ -2417,7 +2417,7 @@ impl BusinessProfileInterface for KafkaStore { async fn delete_business_profile_by_profile_id_merchant_id( &self, - profile_id: &str, + profile_id: &id_type::ProfileId, merchant_id: &id_type::MerchantId, ) -> CustomResult<bool, errors::StorageError> { self.diesel_store @@ -2494,7 +2494,7 @@ impl RoutingAlgorithmInterface for KafkaStore { async fn find_routing_algorithm_by_profile_id_algorithm_id( &self, - profile_id: &str, + profile_id: &id_type::ProfileId, algorithm_id: &str, ) -> CustomResult<storage::RoutingAlgorithm, errors::StorageError> { self.diesel_store @@ -2515,7 +2515,7 @@ impl RoutingAlgorithmInterface for KafkaStore { async fn find_routing_algorithm_metadata_by_algorithm_id_profile_id( &self, algorithm_id: &str, - profile_id: &str, + profile_id: &id_type::ProfileId, ) -> CustomResult<storage::RoutingProfileMetadata, errors::StorageError> { self.diesel_store .find_routing_algorithm_metadata_by_algorithm_id_profile_id(algorithm_id, profile_id) @@ -2524,7 +2524,7 @@ impl RoutingAlgorithmInterface for KafkaStore { async fn list_routing_algorithm_metadata_by_profile_id( &self, - profile_id: &str, + profile_id: &id_type::ProfileId, limit: i64, offset: i64, ) -> CustomResult<Vec<storage::RoutingProfileMetadata>, errors::StorageError> { @@ -2808,7 +2808,7 @@ impl UserRoleInterface for KafkaStore { user_id: &str, org_id: &id_type::OrganizationId, merchant_id: &id_type::MerchantId, - profile_id: Option<&String>, + profile_id: Option<&id_type::ProfileId>, version: enums::UserRoleVersion, ) -> CustomResult<storage::UserRole, errors::StorageError> { self.diesel_store @@ -2827,7 +2827,7 @@ impl UserRoleInterface for KafkaStore { user_id: &str, org_id: &id_type::OrganizationId, merchant_id: &id_type::MerchantId, - profile_id: Option<&String>, + profile_id: Option<&id_type::ProfileId>, update: user_storage::UserRoleUpdate, version: enums::UserRoleVersion, ) -> CustomResult<storage::UserRole, errors::StorageError> { @@ -2848,7 +2848,7 @@ impl UserRoleInterface for KafkaStore { user_id: &str, org_id: &id_type::OrganizationId, merchant_id: &id_type::MerchantId, - profile_id: Option<&String>, + profile_id: Option<&id_type::ProfileId>, version: enums::UserRoleVersion, ) -> CustomResult<storage::UserRole, errors::StorageError> { self.diesel_store @@ -2877,7 +2877,7 @@ impl UserRoleInterface for KafkaStore { user_id: &str, org_id: Option<&id_type::OrganizationId>, merchant_id: Option<&id_type::MerchantId>, - profile_id: Option<&String>, + profile_id: Option<&id_type::ProfileId>, entity_id: Option<&String>, version: Option<enums::UserRoleVersion>, ) -> CustomResult<Vec<storage::UserRole>, errors::StorageError> { diff --git a/crates/router/src/db/merchant_account.rs b/crates/router/src/db/merchant_account.rs index 5a828ebb0cd..8aa013ab08f 100644 --- a/crates/router/src/db/merchant_account.rs +++ b/crates/router/src/db/merchant_account.rs @@ -589,7 +589,7 @@ async fn publish_and_redact_merchant_account_cache( format!( "cgraph_{}_{}", merchant_account.get_id().get_string_repr(), - profile_id, + profile_id.get_string_repr(), ) .into(), ) diff --git a/crates/router/src/db/merchant_connector_account.rs b/crates/router/src/db/merchant_connector_account.rs index f039728de46..1908e01e94f 100644 --- a/crates/router/src/db/merchant_connector_account.rs +++ b/crates/router/src/db/merchant_connector_account.rs @@ -141,7 +141,7 @@ where async fn find_merchant_connector_account_by_profile_id_connector_name( &self, state: &KeyManagerState, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, connector_name: &str, key_store: &domain::MerchantKeyStore, ) -> CustomResult<domain::MerchantConnectorAccount, errors::StorageError>; @@ -290,7 +290,7 @@ impl MerchantConnectorAccountInterface for Store { async fn find_merchant_connector_account_by_profile_id_connector_name( &self, state: &KeyManagerState, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, connector_name: &str, key_store: &domain::MerchantKeyStore, ) -> CustomResult<domain::MerchantConnectorAccount, errors::StorageError> { @@ -322,7 +322,7 @@ impl MerchantConnectorAccountInterface for Store { { cache::get_or_populate_in_memory( self, - &format!("{}_{}", profile_id, connector_name), + &format!("{}_{}", profile_id.get_string_repr(), connector_name), find_call, &cache::ACCOUNTS_CACHE, ) @@ -587,7 +587,7 @@ impl MerchantConnectorAccountInterface for Store { self, [ cache::CacheKind::Accounts( - format!("{}_{}", _profile_id, _connector_name).into(), + format!("{}_{}", _profile_id.get_string_repr(), _connector_name).into(), ), cache::CacheKind::Accounts( format!( @@ -598,8 +598,12 @@ impl MerchantConnectorAccountInterface for Store { .into(), ), cache::CacheKind::CGraph( - format!("cgraph_{}_{_profile_id}", _merchant_id.get_string_repr()) - .into(), + format!( + "cgraph_{}_{}", + _merchant_id.get_string_repr(), + _profile_id.get_string_repr() + ) + .into(), ), ], \|\| update, @@ -683,7 +687,7 @@ impl MerchantConnectorAccountInterface for Store { self, [ cache::CacheKind::Accounts( - format!("{}_{}", _profile_id, _connector_name).into(), + format!("{}_{}", _profile_id.get_string_repr(), _connector_name).into(), ), cache::CacheKind::Accounts( format!( @@ -694,12 +698,18 @@ impl MerchantConnectorAccountInterface for Store { .into(), ), cache::CacheKind::CGraph( - format!("cgraph_{}_{_profile_id}", _merchant_id.get_string_repr()).into(), + format!( + "cgraph_{}_{}", + _merchant_id.get_string_repr(), + _profile_id.get_string_repr() + ) + .into(), ), cache::CacheKind::PmFiltersCGraph( format!( - "pm_filters_cgraph_{}_{_profile_id}", - _merchant_id.get_string_repr() + "pm_filters_cgraph_{}_{}", + _merchant_id.get_string_repr(), + _profile_id.get_string_repr(), ) .into(), ), @@ -759,7 +769,7 @@ impl MerchantConnectorAccountInterface for Store { self, [ cache::CacheKind::Accounts( - format!("{}_{}", _profile_id, _connector_name).into(), + format!("{}_{}", _profile_id.get_string_repr(), _connector_name).into(), ), cache::CacheKind::Accounts( format!( @@ -770,12 +780,18 @@ impl MerchantConnectorAccountInterface for Store { .into(), ), cache::CacheKind::CGraph( - format!("cgraph_{}_{_profile_id}", _merchant_id.get_string_repr()).into(), + format!( + "cgraph_{}_{}", + _merchant_id.get_string_repr(), + _profile_id.get_string_repr() + ) + .into(), ), cache::CacheKind::PmFiltersCGraph( format!( - "pm_filters_cgraph_{}_{_profile_id}", - _merchant_id.get_string_repr() + "pm_filters_cgraph_{}_{}", + _merchant_id.get_string_repr(), + _profile_id.get_string_repr() ) .into(), ), @@ -835,16 +851,26 @@ impl MerchantConnectorAccountInterface for Store { self, [ cache::CacheKind::Accounts( - format!("{}_{}", mca.merchant_id.get_string_repr(), _profile_id).into(), + format!( + "{}_{}", + mca.merchant_id.get_string_repr(), + _profile_id.get_string_repr() + ) + .into(), ), cache::CacheKind::CGraph( - format!("cgraph_{}_{_profile_id}", mca.merchant_id.get_string_repr()) - .into(), + format!( + "cgraph_{}_{}", + mca.merchant_id.get_string_repr(), + _profile_id.get_string_repr() + ) + .into(), ), cache::CacheKind::PmFiltersCGraph( format!( - "pm_filters_cgraph_{}_{_profile_id}", - mca.merchant_id.get_string_repr() + "pm_filters_cgraph_{}_{}", + mca.merchant_id.get_string_repr(), + _profile_id.get_string_repr() ) .into(), ), @@ -890,16 +916,26 @@ impl MerchantConnectorAccountInterface for Store { self, [ cache::CacheKind::Accounts( - format!("{}_{}", mca.merchant_id.get_string_repr(), _profile_id).into(), + format!( + "{}_{}", + mca.merchant_id.get_string_repr(), + _profile_id.get_string_repr() + ) + .into(), ), cache::CacheKind::CGraph( - format!("cgraph_{}_{_profile_id}", mca.merchant_id.get_string_repr()) - .into(), + format!( + "cgraph_{}_{}", + mca.merchant_id.get_string_repr(), + _profile_id.get_string_repr() + ) + .into(), ), cache::CacheKind::PmFiltersCGraph( format!( - "pm_filters_cgraph_{}_{_profile_id}", - mca.merchant_id.get_string_repr() + "pm_filters_cgraph_{}_{}", + mca.merchant_id.get_string_repr(), + _profile_id.get_string_repr() ) .into(), ), @@ -1016,7 +1052,7 @@ impl MerchantConnectorAccountInterface for MockDb { async fn find_merchant_connector_account_by_profile_id_connector_name( &self, state: &KeyManagerState, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, connector_name: &str, key_store: &domain::MerchantKeyStore, ) -> CustomResult<domain::MerchantConnectorAccount, errors::StorageError> { @@ -1475,7 +1511,9 @@ mod merchant_connector_account_cache_tests { let connector_label = "stripe_USA"; let merchant_connector_id = "simple_merchant_connector_id"; - let profile_id = "pro_max_ultra"; + let profile_id = + common_utils::id_type::ProfileId::try_from(std::borrow::Cow::from("pro_max_ultra")) + .unwrap(); let key_manager_state = &state.into(); db.insert_merchant_key_store( key_manager_state, @@ -1536,7 +1574,7 @@ mod merchant_connector_account_cache_tests { created_at: date_time::now(), modified_at: date_time::now(), connector_webhook_details: None, - profile_id: profile_id.to_string(), + profile_id: profile_id.to_owned(), applepay_verified_domains: None, pm_auth_config: None, status: common_enums::ConnectorStatus::Inactive, @@ -1564,7 +1602,7 @@ mod merchant_connector_account_cache_tests { Conversion::convert( db.find_merchant_connector_account_by_profile_id_connector_name( key_manager_state, - profile_id, + &profile_id, &mca.connector_name, &merchant_key, ) @@ -1576,7 +1614,11 @@ mod merchant_connector_account_cache_tests { }; let _: storage::MerchantConnectorAccount = cache::get_or_populate_in_memory( &db, - &format!("{}_{}", merchant_id.get_string_repr(), profile_id), + &format!( + "{}_{}", + merchant_id.get_string_repr(), + profile_id.get_string_repr(), + ), find_call, &ACCOUNTS_CACHE, ) @@ -1644,7 +1686,9 @@ mod merchant_connector_account_cache_tests { .unwrap(); let connector_label = "stripe_USA"; let id = "simple_id"; - let profile_id = "pro_max_ultra"; + let profile_id = + common_utils::id_type::ProfileId::try_from(std::borrow::Cow::from("pro_max_ultra")) + .unwrap(); let key_manager_state = &state.into(); db.insert_merchant_key_store( key_manager_state, @@ -1701,7 +1745,7 @@ mod merchant_connector_account_cache_tests { created_at: date_time::now(), modified_at: date_time::now(), connector_webhook_details: None, - profile_id: profile_id.to_string(), + profile_id: profile_id.to_owned(), applepay_verified_domains: None, pm_auth_config: None, status: common_enums::ConnectorStatus::Inactive, @@ -1748,7 +1792,11 @@ mod merchant_connector_account_cache_tests { let _: storage::MerchantConnectorAccount = cache::get_or_populate_in_memory( &db, - &format!("{}_{}", merchant_id.clone().get_string_repr(), profile_id), + &format!( + "{}_{}", + merchant_id.clone().get_string_repr(), + profile_id.get_string_repr() + ), find_call, &ACCOUNTS_CACHE, ) diff --git a/crates/router/src/db/routing_algorithm.rs b/crates/router/src/db/routing_algorithm.rs index ad4b3bd9192..5672777bfa2 100644 --- a/crates/router/src/db/routing_algorithm.rs +++ b/crates/router/src/db/routing_algorithm.rs @@ -20,7 +20,7 @@ pub trait RoutingAlgorithmInterface { async fn find_routing_algorithm_by_profile_id_algorithm_id( &self, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, algorithm_id: &str, ) -> StorageResult<routing_storage::RoutingAlgorithm>; @@ -33,12 +33,12 @@ pub trait RoutingAlgorithmInterface { async fn find_routing_algorithm_metadata_by_algorithm_id_profile_id( &self, algorithm_id: &str, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, ) -> StorageResult<routing_storage::RoutingProfileMetadata>; async fn list_routing_algorithm_metadata_by_profile_id( &self, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, limit: i64, offset: i64, ) -> StorageResult<Vec<routing_storage::RoutingProfileMetadata>>; @@ -76,7 +76,7 @@ impl RoutingAlgorithmInterface for Store { #[instrument(skip_all)] async fn find_routing_algorithm_by_profile_id_algorithm_id( &self, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, algorithm_id: &str, ) -> StorageResult<routing_storage::RoutingAlgorithm> { let conn = connection::pg_connection_write(self).await?; @@ -109,7 +109,7 @@ impl RoutingAlgorithmInterface for Store { async fn find_routing_algorithm_metadata_by_algorithm_id_profile_id( &self, algorithm_id: &str, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, ) -> StorageResult<routing_storage::RoutingProfileMetadata> { let conn = connection::pg_connection_write(self).await?; routing_storage::RoutingAlgorithm::find_metadata_by_algorithm_id_profile_id( @@ -124,7 +124,7 @@ impl RoutingAlgorithmInterface for Store { #[instrument(skip_all)] async fn list_routing_algorithm_metadata_by_profile_id( &self, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, limit: i64, offset: i64, ) -> StorageResult<Vec<routing_storage::RoutingProfileMetadata>> { @@ -185,7 +185,7 @@ impl RoutingAlgorithmInterface for MockDb { async fn find_routing_algorithm_by_profile_id_algorithm_id( &self, - _profile_id: &str, + _profile_id: &common_utils::id_type::ProfileId, _algorithm_id: &str, ) -> StorageResult<routing_storage::RoutingAlgorithm> { Err(errors::StorageError::MockDbError)? @@ -202,14 +202,14 @@ impl RoutingAlgorithmInterface for MockDb { async fn find_routing_algorithm_metadata_by_algorithm_id_profile_id( &self, _algorithm_id: &str, - _profile_id: &str, + _profile_id: &common_utils::id_type::ProfileId, ) -> StorageResult<routing_storage::RoutingProfileMetadata> { Err(errors::StorageError::MockDbError)? } async fn list_routing_algorithm_metadata_by_profile_id( &self, - _profile_id: &str, + _profile_id: &common_utils::id_type::ProfileId, _limit: i64, _offset: i64, ) -> StorageResult<Vec<routing_storage::RoutingProfileMetadata>> { diff --git a/crates/router/src/db/user_role.rs b/crates/router/src/db/user_role.rs index f028437b346..524eaaaab79 100644 --- a/crates/router/src/db/user_role.rs +++ b/crates/router/src/db/user_role.rs @@ -47,7 +47,7 @@ pub trait UserRoleInterface { user_id: &str, org_id: &id_type::OrganizationId, merchant_id: &id_type::MerchantId, - profile_id: Option<&String>, + profile_id: Option<&id_type::ProfileId>, version: enums::UserRoleVersion, ) -> CustomResult<storage::UserRole, errors::StorageError>; @@ -56,7 +56,7 @@ pub trait UserRoleInterface { user_id: &str, org_id: &id_type::OrganizationId, merchant_id: &id_type::MerchantId, - profile_id: Option<&String>, + profile_id: Option<&id_type::ProfileId>, update: storage::UserRoleUpdate, version: enums::UserRoleVersion, ) -> CustomResult<storage::UserRole, errors::StorageError>; @@ -66,7 +66,7 @@ pub trait UserRoleInterface { user_id: &str, org_id: &id_type::OrganizationId, merchant_id: &id_type::MerchantId, - profile_id: Option<&String>, + profile_id: Option<&id_type::ProfileId>, version: enums::UserRoleVersion, ) -> CustomResult<storage::UserRole, errors::StorageError>; @@ -75,7 +75,7 @@ pub trait UserRoleInterface { user_id: &str, org_id: Option<&id_type::OrganizationId>, merchant_id: Option<&id_type::MerchantId>, - profile_id: Option<&String>, + profile_id: Option<&id_type::ProfileId>, entity_id: Option<&String>, version: Option<enums::UserRoleVersion>, ) -> CustomResult<Vec<storage::UserRole>, errors::StorageError>; @@ -155,7 +155,7 @@ impl UserRoleInterface for Store { user_id: &str, org_id: &id_type::OrganizationId, merchant_id: &id_type::MerchantId, - profile_id: Option<&String>, + profile_id: Option<&id_type::ProfileId>, version: enums::UserRoleVersion, ) -> CustomResult<storage::UserRole, errors::StorageError> { let conn = connection::pg_connection_write(self).await?; @@ -177,7 +177,7 @@ impl UserRoleInterface for Store { user_id: &str, org_id: &id_type::OrganizationId, merchant_id: &id_type::MerchantId, - profile_id: Option<&String>, + profile_id: Option<&id_type::ProfileId>, update: storage::UserRoleUpdate, version: enums::UserRoleVersion, ) -> CustomResult<storage::UserRole, errors::StorageError> { @@ -201,7 +201,7 @@ impl UserRoleInterface for Store { user_id: &str, org_id: &id_type::OrganizationId, merchant_id: &id_type::MerchantId, - profile_id: Option<&String>, + profile_id: Option<&id_type::ProfileId>, version: enums::UserRoleVersion, ) -> CustomResult<storage::UserRole, errors::StorageError> { let conn = connection::pg_connection_write(self).await?; @@ -222,7 +222,7 @@ impl UserRoleInterface for Store { user_id: &str, org_id: Option<&id_type::OrganizationId>, merchant_id: Option<&id_type::MerchantId>, - profile_id: Option<&String>, + profile_id: Option<&id_type::ProfileId>, entity_id: Option<&String>, version: Option<enums::UserRoleVersion>, ) -> CustomResult<Vec<storage::UserRole>, errors::StorageError> { @@ -377,7 +377,7 @@ impl UserRoleInterface for MockDb { user_id: &str, org_id: &id_type::OrganizationId, merchant_id: &id_type::MerchantId, - profile_id: Option<&String>, + profile_id: Option<&id_type::ProfileId>, version: enums::UserRoleVersion, ) -> CustomResult<storage::UserRole, errors::StorageError> { let user_roles = self.user_roles.lock().await; @@ -416,7 +416,7 @@ impl UserRoleInterface for MockDb { user_id: &str, org_id: &id_type::OrganizationId, merchant_id: &id_type::MerchantId, - profile_id: Option<&String>, + profile_id: Option<&id_type::ProfileId>, update: storage::UserRoleUpdate, version: enums::UserRoleVersion, ) -> CustomResult<storage::UserRole, errors::StorageError> { @@ -470,7 +470,7 @@ impl UserRoleInterface for MockDb { user_id: &str, org_id: &id_type::OrganizationId, merchant_id: &id_type::MerchantId, - profile_id: Option<&String>, + profile_id: Option<&id_type::ProfileId>, version: enums::UserRoleVersion, ) -> CustomResult<storage::UserRole, errors::StorageError> { let mut user_roles = self.user_roles.lock().await; @@ -510,7 +510,7 @@ impl UserRoleInterface for MockDb { user_id: &str, org_id: Option<&id_type::OrganizationId>, merchant_id: Option<&id_type::MerchantId>, - profile_id: Option<&String>, + profile_id: Option<&id_type::ProfileId>, entity_id: Option<&String>, version: Option<enums::UserRoleVersion>, ) -> CustomResult<Vec<storage::UserRole>, errors::StorageError> { diff --git a/crates/router/src/routes/admin.rs b/crates/router/src/routes/admin.rs index 80ee0494847..343246e31a0 100644 --- a/crates/router/src/routes/admin.rs +++ b/crates/router/src/routes/admin.rs @@ -946,7 +946,10 @@ pub async fn business_profile_create( pub async fn business_profile_retrieve( state: web::Data<AppState>, req: HttpRequest, - path: web::Path<(common_utils::id_type::MerchantId, String)>, + path: web::Path<( + common_utils::id_type::MerchantId, + common_utils::id_type::ProfileId, + )>, ) -> HttpResponse { let flow = Flow::BusinessProfileRetrieve; let (merchant_id, profile_id) = path.into_inner(); @@ -975,7 +978,7 @@ pub async fn business_profile_retrieve( pub async fn business_profile_retrieve( state: web::Data<AppState>, req: HttpRequest, - path: web::Path<String>, + path: web::Path<common_utils::id_type::ProfileId>, ) -> HttpResponse { let flow = Flow::BusinessProfileRetrieve; let profile_id = path.into_inner(); @@ -1015,7 +1018,10 @@ pub async fn business_profile_retrieve( pub async fn business_profile_update( state: web::Data<AppState>, req: HttpRequest, - path: web::Path<(common_utils::id_type::MerchantId, String)>, + path: web::Path<( + common_utils::id_type::MerchantId, + common_utils::id_type::ProfileId, + )>, json_payload: web::Json<api_models::admin::BusinessProfileUpdate>, ) -> HttpResponse { let flow = Flow::BusinessProfileUpdate; @@ -1045,7 +1051,7 @@ pub async fn business_profile_update( pub async fn business_profile_update( state: web::Data<AppState>, req: HttpRequest, - path: web::Path<String>, + path: web::Path<common_utils::id_type::ProfileId>, json_payload: web::Json<api_models::admin::BusinessProfileUpdate>, ) -> HttpResponse { let flow = Flow::BusinessProfileUpdate; @@ -1081,7 +1087,10 @@ pub async fn business_profile_update( pub async fn business_profile_delete( state: web::Data<AppState>, req: HttpRequest, - path: web::Path<(common_utils::id_type::MerchantId, String)>, + path: web::Path<( + common_utils::id_type::MerchantId, + common_utils::id_type::ProfileId, + )>, ) -> HttpResponse { let flow = Flow::BusinessProfileDelete; let (merchant_id, profile_id) = path.into_inner(); @@ -1129,7 +1138,10 @@ pub async fn business_profiles_list( pub async fn toggle_connector_agnostic_mit( state: web::Data<AppState>, req: HttpRequest, - path: web::Path<(common_utils::id_type::MerchantId, String)>, + path: web::Path<( + common_utils::id_type::MerchantId, + common_utils::id_type::ProfileId, + )>, json_payload: web::Json<api_models::admin::ConnectorAgnosticMitChoice>, ) -> HttpResponse { let flow = Flow::ToggleConnectorAgnosticMit; @@ -1200,7 +1212,10 @@ pub async fn merchant_account_transfer_keys( pub async fn toggle_extended_card_info( state: web::Data<AppState>, req: HttpRequest, - path: web::Path<(common_utils::id_type::MerchantId, String)>, + path: web::Path<( + common_utils::id_type::MerchantId, + common_utils::id_type::ProfileId, + )>, json_payload: web::Json<api_models::admin::ExtendedCardInfoChoice>, ) -> HttpResponse { let flow = Flow::ToggleExtendedCardInfo; diff --git a/crates/router/src/routes/payments.rs b/crates/router/src/routes/payments.rs index 11cdf4eb7e9..63c40580e53 100644 --- a/crates/router/src/routes/payments.rs +++ b/crates/router/src/routes/payments.rs @@ -1327,7 +1327,7 @@ async fn authorize_verify_select<Op>( state: app::SessionState, req_state: ReqState, merchant_account: domain::MerchantAccount, - profile_id: Option<String>, + profile_id: Option<common_utils::id_type::ProfileId>, key_store: domain::MerchantKeyStore, header_payload: HeaderPayload, req: api_models::payments::PaymentsRequest, diff --git a/crates/router/src/routes/routing.rs b/crates/router/src/routes/routing.rs index 30edfc187b8..93fb2fc0d2d 100644 --- a/crates/router/src/routes/routing.rs +++ b/crates/router/src/routes/routing.rs @@ -96,7 +96,7 @@ pub async fn routing_link_config( pub async fn routing_link_config( state: web::Data<AppState>, req: HttpRequest, - path: web::Path<String>, + path: web::Path<common_utils::id_type::ProfileId>, json_payload: web::Json<routing_types::RoutingAlgorithmId>, transaction_type: &enums::TransactionType, ) -> impl Responder { @@ -209,7 +209,7 @@ pub async fn list_routing_configs( pub async fn routing_unlink_config( state: web::Data<AppState>, req: HttpRequest, - path: web::Path<String>, + path: web::Path<common_utils::id_type::ProfileId>, transaction_type: &enums::TransactionType, ) -> impl Responder { let flow = Flow::RoutingUnlinkConfig; @@ -290,7 +290,7 @@ pub async fn routing_unlink_config( pub async fn routing_update_default_config( state: web::Data<AppState>, req: HttpRequest, - path: web::Path<String>, + path: web::Path<common_utils::id_type::ProfileId>, json_payload: web::Json<Vec<routing_types::RoutableConnectorChoice>>, ) -> impl Responder { let wrapper = routing_types::ProfileDefaultRoutingConfig { @@ -372,7 +372,7 @@ pub async fn routing_update_default_config( pub async fn routing_retrieve_default_config( state: web::Data<AppState>, req: HttpRequest, - path: web::Path<String>, + path: web::Path<common_utils::id_type::ProfileId>, ) -> impl Responder { Box::pin(oss_api::server_wrap( Flow::RoutingRetrieveDefaultConfig, @@ -674,7 +674,7 @@ pub async fn routing_retrieve_linked_config( state: web::Data<AppState>, req: HttpRequest, query: web::Query<RoutingRetrieveQuery>, - path: web::Path<String>, + path: web::Path<common_utils::id_type::ProfileId>, transaction_type: &enums::TransactionType, ) -> impl Responder { use crate::services::authentication::AuthenticationData; @@ -753,7 +753,7 @@ pub async fn routing_retrieve_default_config_for_profiles( pub async fn routing_update_default_config_for_profile( state: web::Data<AppState>, req: HttpRequest, - path: web::Path<String>, + path: web::Path<common_utils::id_type::ProfileId>, json_payload: web::Json<Vec<routing_types::RoutableConnectorChoice>>, transaction_type: &enums::TransactionType, ) -> impl Responder { diff --git a/crates/router/src/services/authentication.rs b/crates/router/src/services/authentication.rs index 9ab2e2e3b07..f1de5528224 100644 --- a/crates/router/src/services/authentication.rs +++ b/crates/router/src/services/authentication.rs @@ -59,14 +59,14 @@ mod detached; pub struct AuthenticationData { pub merchant_account: domain::MerchantAccount, pub key_store: domain::MerchantKeyStore, - pub profile_id: Option<String>, + pub profile_id: Option<id_type::ProfileId>, } #[derive(Clone, Debug)] pub struct AuthenticationDataWithMultipleProfiles { pub merchant_account: domain::MerchantAccount, pub key_store: domain::MerchantKeyStore, - pub profile_id_list: Option<Vec<String>>, + pub profile_id_list: Option<Vec<id_type::ProfileId>>, } #[derive(Clone, Debug, Eq, PartialEq, Serialize)] @@ -195,7 +195,7 @@ pub struct AuthToken { pub role_id: String, pub exp: u64, pub org_id: id_type::OrganizationId, - pub profile_id: Option<String>, + pub profile_id: Option<id_type::ProfileId>, } #[cfg(feature = "olap")] @@ -206,7 +206,7 @@ impl AuthToken { role_id: String, settings: &Settings, org_id: id_type::OrganizationId, - profile_id: Option<String>, + profile_id: Option<id_type::ProfileId>, ) -> UserResult<String> { let exp_duration = std::time::Duration::from_secs(consts::JWT_TOKEN_TIME_IN_SECS); let exp = jwt::generate_exp(exp_duration)?.as_secs(); @@ -228,7 +228,7 @@ pub struct UserFromToken { pub merchant_id: id_type::MerchantId, pub role_id: String, pub org_id: id_type::OrganizationId, - pub profile_id: Option<String>, + pub profile_id: Option<id_type::ProfileId>, } pub struct UserIdFromAuth { diff --git a/crates/router/src/services/kafka/authentication.rs b/crates/router/src/services/kafka/authentication.rs index be3e0933342..42079525d8a 100644 --- a/crates/router/src/services/kafka/authentication.rs +++ b/crates/router/src/services/kafka/authentication.rs @@ -35,7 +35,7 @@ pub struct KafkaAuthentication<'a> { pub acs_reference_number: Option<&'a String>, pub acs_trans_id: Option<&'a String>, pub acs_signed_content: Option<&'a String>, - pub profile_id: &'a String, + pub profile_id: &'a common_utils::id_type::ProfileId, pub payment_id: Option<&'a String>, pub merchant_connector_id: &'a String, pub ds_trans_id: Option<&'a String>, diff --git a/crates/router/src/services/kafka/authentication_event.rs b/crates/router/src/services/kafka/authentication_event.rs index 3f10c7596ac..6213488a6d3 100644 --- a/crates/router/src/services/kafka/authentication_event.rs +++ b/crates/router/src/services/kafka/authentication_event.rs @@ -36,7 +36,7 @@ pub struct KafkaAuthenticationEvent<'a> { pub acs_reference_number: Option<&'a String>, pub acs_trans_id: Option<&'a String>, pub acs_signed_content: Option<&'a String>, - pub profile_id: &'a String, + pub profile_id: &'a common_utils::id_type::ProfileId, pub payment_id: Option<&'a String>, pub merchant_connector_id: &'a String, pub ds_trans_id: Option<&'a String>, diff --git a/crates/router/src/services/kafka/dispute.rs b/crates/router/src/services/kafka/dispute.rs index b4b493a79df..6f789cbe94e 100644 --- a/crates/router/src/services/kafka/dispute.rs +++ b/crates/router/src/services/kafka/dispute.rs @@ -30,7 +30,7 @@ pub struct KafkaDispute<'a> { pub modified_at: OffsetDateTime, pub connector: &'a String, pub evidence: &'a Secret<serde_json::Value>, - pub profile_id: Option<&'a String>, + pub profile_id: Option<&'a common_utils::id_type::ProfileId>, pub merchant_connector_id: Option<&'a String>, } diff --git a/crates/router/src/services/kafka/dispute_event.rs b/crates/router/src/services/kafka/dispute_event.rs index d6cb5d58491..e4254912597 100644 --- a/crates/router/src/services/kafka/dispute_event.rs +++ b/crates/router/src/services/kafka/dispute_event.rs @@ -31,7 +31,7 @@ pub struct KafkaDisputeEvent<'a> { pub modified_at: OffsetDateTime, pub connector: &'a String, pub evidence: &'a Secret<serde_json::Value>, - pub profile_id: Option<&'a String>, + pub profile_id: Option<&'a common_utils::id_type::ProfileId>, pub merchant_connector_id: Option<&'a String>, } diff --git a/crates/router/src/services/kafka/payment_intent.rs b/crates/router/src/services/kafka/payment_intent.rs index 3296956797b..29aa5632837 100644 --- a/crates/router/src/services/kafka/payment_intent.rs +++ b/crates/router/src/services/kafka/payment_intent.rs @@ -33,7 +33,7 @@ pub struct KafkaPaymentIntent<'a> { pub business_country: Option<storage_enums::CountryAlpha2>, pub business_label: Option<&'a String>, pub attempt_count: i16, - pub profile_id: Option<&'a String>, + pub profile_id: Option<&'a id_type::ProfileId>, pub payment_confirm_source: Option<storage_enums::PaymentSource>, pub billing_details: Option<Encryptable<Secret<Value>>>, pub shipping_details: Option<Encryptable<Secret<Value>>>, diff --git a/crates/router/src/services/kafka/payment_intent_event.rs b/crates/router/src/services/kafka/payment_intent_event.rs index f5186a0b2bb..50d2c48a4bd 100644 --- a/crates/router/src/services/kafka/payment_intent_event.rs +++ b/crates/router/src/services/kafka/payment_intent_event.rs @@ -34,7 +34,7 @@ pub struct KafkaPaymentIntentEvent<'a> { pub business_country: Option<storage_enums::CountryAlpha2>, pub business_label: Option<&'a String>, pub attempt_count: i16, - pub profile_id: Option<&'a String>, + pub profile_id: Option<&'a id_type::ProfileId>, pub payment_confirm_source: Option<storage_enums::PaymentSource>, pub billing_details: Option<Encryptable<Secret<Value>>>, pub shipping_details: Option<Encryptable<Secret<Value>>>, diff --git a/crates/router/src/services/kafka/payout.rs b/crates/router/src/services/kafka/payout.rs index ca89a34f18d..08733c46008 100644 --- a/crates/router/src/services/kafka/payout.rs +++ b/crates/router/src/services/kafka/payout.rs @@ -10,7 +10,7 @@ pub struct KafkaPayout<'a> { pub merchant_id: &'a id_type::MerchantId, pub customer_id: Option<&'a id_type::CustomerId>, pub address_id: Option<&'a String>, - pub profile_id: &'a String, + pub profile_id: &'a id_type::ProfileId, pub payout_method_id: Option<&'a String>, pub payout_type: Option<storage_enums::PayoutType>, pub amount: MinorUnit, diff --git a/crates/router/src/types/api/admin.rs b/crates/router/src/types/api/admin.rs index 912cc1c1fad..c959c59badc 100644 --- a/crates/router/src/types/api/admin.rs +++ b/crates/router/src/types/api/admin.rs @@ -250,7 +250,7 @@ pub async fn create_business_profile_from_merchant_account( use crate::core; // Generate a unique profile id - let profile_id = common_utils::generate_id_with_default_len("pro"); + let profile_id = common_utils::generate_profile_id_of_default_length(); let merchant_id = merchant_account.get_id().to_owned(); let current_time = common_utils::date_time::now(); diff --git a/crates/router/src/types/domain/event.rs b/crates/router/src/types/domain/event.rs index 872eb303901..badbb9df7b4 100644 --- a/crates/router/src/types/domain/event.rs +++ b/crates/router/src/types/domain/event.rs @@ -26,7 +26,7 @@ pub struct Event { pub primary_object_type: EventObjectType, pub created_at: time::PrimitiveDateTime, pub merchant_id: Option<common_utils::id_type::MerchantId>, - pub business_profile_id: Option<String>, + pub business_profile_id: Option<common_utils::id_type::ProfileId>, pub primary_object_created_at: Option<time::PrimitiveDateTime>, pub idempotent_event_id: Option<String>, pub initial_attempt_id: Option<String>, diff --git a/crates/router/src/utils.rs b/crates/router/src/utils.rs index ef07ab6a846..7e5f8571340 100644 --- a/crates/router/src/utils.rs +++ b/crates/router/src/utils.rs @@ -467,7 +467,10 @@ pub async fn get_mca_from_payment_intent( .await .to_not_found_response( errors::ApiErrorResponse::MerchantConnectorAccountNotFound { - id: format!("profile_id {profile_id} and connector_name {connector_name}"), + id: format!( + "profile_id {} and connector_name {connector_name}", + profile_id.get_string_repr() + ), }, ) } @@ -556,7 +559,8 @@ pub async fn get_mca_from_payout_attempt( errors::ApiErrorResponse::MerchantConnectorAccountNotFound { id: format!( "profile_id {} and connector_name {}", - payout.profile_id, connector_name + payout.profile_id.get_string_repr(), + connector_name ), }, ) @@ -603,7 +607,10 @@ pub async fn get_mca_from_object_reference_id( .await .to_not_found_response( errors::ApiErrorResponse::MerchantConnectorAccountNotFound { - id: format!("profile_id {profile_id} and connector_name {connector_name}"), + id: format!( + "profile_id {} and connector_name {connector_name}", + profile_id.get_string_repr() + ), }, ) } diff --git a/crates/router/src/utils/user.rs b/crates/router/src/utils/user.rs index 1de45b74360..30a0e1ca788 100644 --- a/crates/router/src/utils/user.rs +++ b/crates/router/src/utils/user.rs @@ -114,7 +114,7 @@ pub async fn generate_jwt_auth_token_with_custom_role_attributes( merchant_id: id_type::MerchantId, org_id: id_type::OrganizationId, role_id: String, - profile_id: Option<String>, + profile_id: Option<id_type::ProfileId>, ) -> UserResult<Secret<String>> { let token = AuthToken::new_token( user.get_user_id().to_string(), diff --git a/crates/router/src/utils/user_role.rs b/crates/router/src/utils/user_role.rs index 7aebbe1bbcf..792a79c91eb 100644 --- a/crates/router/src/utils/user_role.rs +++ b/crates/router/src/utils/user_role.rs @@ -182,7 +182,7 @@ pub async fn update_v1_and_v2_user_roles_in_db( user_id: &str, org_id: &id_type::OrganizationId, merchant_id: &id_type::MerchantId, - profile_id: Option<&String>, + profile_id: Option<&id_type::ProfileId>, update: UserRoleUpdate, ) -> ( Result<UserRole, Report<StorageError>>, diff --git a/crates/router/src/workflows/payment_sync.rs b/crates/router/src/workflows/payment_sync.rs index c536ec7e4e9..207af2ea4bf 100644 --- a/crates/router/src/workflows/payment_sync.rs +++ b/crates/router/src/workflows/payment_sync.rs @@ -177,7 +177,7 @@ impl ProcessTrackerWorkflow<SessionState> for PaymentsSyncWorkflow { .await .to_not_found_response( errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_string(), + id: profile_id.get_string_repr().to_owned(), }, )?; diff --git a/crates/storage_impl/src/payouts/payout_attempt.rs b/crates/storage_impl/src/payouts/payout_attempt.rs index aba6f2016ba..08843a060a7 100644 --- a/crates/storage_impl/src/payouts/payout_attempt.rs +++ b/crates/storage_impl/src/payouts/payout_attempt.rs @@ -60,7 +60,6 @@ impl<T: DatabaseStore> PayoutAttemptInterface for KVRouterStore<T> { payout_attempt_id: &payout_attempt_id, }; let key_str = key.to_string(); - let now = common_utils::date_time::now(); let created_attempt = PayoutAttempt { payout_attempt_id: new_payout_attempt.payout_attempt_id.clone(), payout_id: new_payout_attempt.payout_id.clone(), @@ -76,8 +75,8 @@ impl<T: DatabaseStore> PayoutAttemptInterface for KVRouterStore<T> { error_code: new_payout_attempt.error_code.clone(), business_country: new_payout_attempt.business_country, business_label: new_payout_attempt.business_label.clone(), - created_at: new_payout_attempt.created_at.unwrap_or(now), - last_modified_at: new_payout_attempt.last_modified_at.unwrap_or(now), + created_at: new_payout_attempt.created_at, + last_modified_at: new_payout_attempt.last_modified_at, profile_id: new_payout_attempt.profile_id.clone(), merchant_connector_id: new_payout_attempt.merchant_connector_id.clone(), routing_info: new_payout_attempt.routing_info.clone(), diff --git a/crates/storage_impl/src/payouts/payouts.rs b/crates/storage_impl/src/payouts/payouts.rs index 680d535a652..45227092b48 100644 --- a/crates/storage_impl/src/payouts/payouts.rs +++ b/crates/storage_impl/src/payouts/payouts.rs @@ -87,7 +87,6 @@ impl<T: DatabaseStore> PayoutsInterface for KVRouterStore<T> { }; let key_str = key.to_string(); let field = format!("po_{}", new.payout_id); - let now = common_utils::date_time::now(); let created_payout = Payouts { payout_id: new.payout_id.clone(), merchant_id: new.merchant_id.clone(), @@ -104,8 +103,8 @@ impl<T: DatabaseStore> PayoutsInterface for KVRouterStore<T> { return_url: new.return_url.clone(), entity_type: new.entity_type, metadata: new.metadata.clone(), - created_at: new.created_at.unwrap_or(now), - last_modified_at: new.last_modified_at.unwrap_or(now), + created_at: new.created_at, + last_modified_at: new.last_modified_at, profile_id: new.profile_id.clone(), status: new.status, attempt_count: new.attempt_count, @@ -932,10 +931,8 @@ impl DataModelExt for PayoutsNew { return_url: self.return_url, entity_type: self.entity_type, metadata: self.metadata, - created_at: self.created_at.unwrap_or_else(common_utils::date_time::now), - last_modified_at: self - .last_modified_at - .unwrap_or_else(common_utils::date_time::now), + created_at: self.created_at, + last_modified_at: self.last_modified_at, profile_id: self.profile_id, status: self.status, attempt_count: self.attempt_count, @@ -963,8 +960,8 @@ impl DataModelExt for PayoutsNew { return_url: storage_model.return_url, entity_type: storage_model.entity_type, metadata: storage_model.metadata, - created_at: Some(storage_model.created_at), - last_modified_at: Some(storage_model.last_modified_at), + created_at: storage_model.created_at, + last_modified_at: storage_model.last_modified_at, profile_id: storage_model.profile_id, status: storage_model.status, attempt_count: storage_model.attempt_count, diff --git a/scripts/ci-checks-v2.sh b/scripts/ci-checks-v2.sh index 151e5a382d0..93bd2921a38 100755 --- a/scripts/ci-checks-v2.sh +++ b/scripts/ci-checks-v2.sh @@ -1,8 +1,7 @@ #!/usr/bin/env bash set -euo pipefail -crates_to_check=\ -'api_models +crates_to_check='api_models diesel_models hyperswitch_domain_models storage_impl' @@ -38,7 +37,7 @@ if [[ "${GITHUB_EVENT_NAME:-}" == 'pull_request' ]]; then # A package must be checked if it has been modified if grep --quiet --extended-regexp "^crates/${package_name}" <<< "${files_modified}"; then if [[ "${package_name}" == "storage_impl" ]]; then - all_commands+=("cargo hack clippy --features 'v2,payment_v2,customer_v2,payment_methods_v2' -p storage_impl") + all_commands+=("cargo hack clippy --features 'v2,payment_v2,customer_v2' -p storage_impl") else valid_features="$(features_to_run "$package_name")" all_commands+=("cargo hack clippy --feature-powerset --depth 2 --ignore-unknown-features --at-least-one-of 'v2 ' --include-features '${valid_features}' --package '${package_name}'") @@ -54,7 +53,7 @@ if [[ "${GITHUB_EVENT_NAME:-}" == 'pull_request' ]]; then else # If we are doing this locally or on merge queue, then check for all the V2 crates - all_commands+=("cargo hack clippy --features 'v2,payment_v2' -p storage_impl") + all_commands+=("cargo hack clippy --features 'v2,payment_v2,customer_v2' -p storage_impl") common_command="cargo hack clippy --feature-powerset --depth 2 --ignore-unknown-features --at-least-one-of 'v2 '" while IFS= read -r crate; do if [[ "${crate}" != "storage_impl" ]]; then	2024-08-25T11:36:59Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [ ] New feature - [ ] Enhancement - [x] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> This PR introduces a domain type for profile ID and refactors the existing code to use the domain type in place of strings being used today. In addition, this PR has the following changes: - Introduces a trait `GenerateId` for generating IDs. - Removes the `Default` implementation on `PayoutsNew` and `PayoutAttemptNew` types defined in the `hyperswitch_domain_models` crate, since the `ProfileId` type does not implement `Default`. ### Additional Changes - [x] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> This PR has no new contract changes, this PR only updates the merchant connector account create request in the OpenAPI documentation to include the maximum character length restriction placed on the `profile_id` field. ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> Using a domain type should help better enforce restrictions like minimum and maximum character restrictions, and should help prevent from incorrect values being passed around (to some extent). ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> Sanity testing with Postman. <!-- This shouldn't affect any existing behavior (as far as I know), since we don't require the merchant to provide a profile ID during creation and almost always generate it ourselves. --> ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.111.0	963a2547e87fc7a4e8ed55627d3e7b9da2022f21	963a2547e87fc7a4e8ed55627d3e7b9da2022f21
juspay/hyperswitch	juspay__hyperswitch-8614	Bug: Add support to call decision engine PL Routing from hyperswitch after API key authentication	diff --git a/crates/router/src/core/payments/routing/utils.rs b/crates/router/src/core/payments/routing/utils.rs index d217cc04360..d373b4188b1 100644 --- a/crates/router/src/core/payments/routing/utils.rs +++ b/crates/router/src/core/payments/routing/utils.rs @@ -690,6 +690,7 @@ pub struct RoutingEvaluateRequest { pub parameters: HashMap<String, Option<ValueType>>, pub fallback_output: Vec<DeRoutableConnectorChoice>, } +impl common_utils::events::ApiEventMetric for RoutingEvaluateRequest {} #[derive(Debug, serde::Serialize, serde::Deserialize, Clone)] pub struct RoutingEvaluateResponse { @@ -700,7 +701,7 @@ pub struct RoutingEvaluateResponse { #[serde(deserialize_with = "deserialize_connector_choices")] pub eligible_connectors: Vec<RoutableConnectorChoice>, } - +impl common_utils::events::ApiEventMetric for RoutingEvaluateResponse {} /// Routable Connector chosen for a payment #[derive(Debug, Clone, PartialEq, serde::Serialize, serde::Deserialize)] pub struct DeRoutableConnectorChoice { diff --git a/crates/router/src/routes/app.rs b/crates/router/src/routes/app.rs index 9935ab5fd9f..e3070077e94 100644 --- a/crates/router/src/routes/app.rs +++ b/crates/router/src/routes/app.rs @@ -1093,6 +1093,10 @@ impl Routing { routing::routing_link_config(state, req, path, payload, None) }, )), + ) + .service( + web::resource("/rule/evaluate") + .route(web::post().to(routing::evaluate_routing_rule)), ); route } diff --git a/crates/router/src/routes/lock_utils.rs b/crates/router/src/routes/lock_utils.rs index fa616a3da3e..8fb15df6fab 100644 --- a/crates/router/src/routes/lock_utils.rs +++ b/crates/router/src/routes/lock_utils.rs @@ -80,6 +80,7 @@ impl From<Flow> for ApiIdentifier { \| Flow::ToggleDynamicRouting \| Flow::UpdateDynamicRoutingConfigs \| Flow::DecisionManagerUpsertConfig + \| Flow::RoutingEvaluateRule \| Flow::DecisionEngineRuleMigration \| Flow::VolumeSplitOnRoutingType => Self::Routing, diff --git a/crates/router/src/routes/routing.rs b/crates/router/src/routes/routing.rs index d247a8af6ea..024d4c0cfbe 100644 --- a/crates/router/src/routes/routing.rs +++ b/crates/router/src/routes/routing.rs @@ -8,6 +8,7 @@ use api_models::{ enums, routing::{self as routing_types, RoutingRetrieveQuery}, }; +use error_stack::ResultExt; use hyperswitch_domain_models::merchant_context::MerchantKeyStore; use payment_methods::core::errors::ApiErrorResponse; use router_env::{ @@ -16,9 +17,17 @@ use router_env::{ }; use crate::{ - core::{api_locking, conditional_config, routing, surcharge_decision_config}, + core::{ + api_locking, conditional_config, + payments::routing::utils::{ + DecisionEngineApiHandler, EuclidApiClient, RoutingEvaluateRequest, + RoutingEvaluateResponse, + }, + routing, surcharge_decision_config, + }, db::errors::StorageErrorExt, routes::AppState, + services, services::{api as oss_api, authentication as auth, authorization::permissions::Permission}, types::domain, }; @@ -1564,6 +1573,47 @@ pub async fn get_dynamic_routing_volume_split( )) .await } +const EUCLID_API_TIMEOUT: u64 = 5; +#[cfg(all(feature = "olap", feature = "v1"))] +#[instrument(skip_all)] +pub async fn evaluate_routing_rule( + state: web::Data<AppState>, + req: HttpRequest, + json_payload: web::Json<RoutingEvaluateRequest>, +) -> impl Responder { + let json_payload = json_payload.into_inner(); + let flow = Flow::RoutingEvaluateRule; + Box::pin(oss_api::server_wrap( + flow, + state, + &req, + json_payload.clone(), + \|state, _auth: auth::AuthenticationData, payload, _\| async move { + let euclid_response: RoutingEvaluateResponse = + EuclidApiClient::send_decision_engine_request( + &state, + services::Method::Post, + "routing/evaluate", + Some(payload), + Some(EUCLID_API_TIMEOUT), + None, + ) + .await + .change_context(ApiErrorResponse::InternalServerError)? + .response + .ok_or(ApiErrorResponse::InternalServerError) + .attach_printable("Failed to evaluate routing rule")?; + + Ok(services::ApplicationResponse::Json(euclid_response)) + }, + &auth::ApiKeyAuth { + is_connected_allowed: false, + is_platform_allowed: false, + }, + api_locking::LockAction::NotApplicable, + )) + .await +} use actix_web::HttpResponse; #[instrument(skip_all, fields(flow = ?Flow::DecisionEngineRuleMigration))] @@ -1591,7 +1641,7 @@ pub async fn migrate_routing_rules_for_profile( query_params, )) .await?; - Ok(crate::services::ApplicationResponse::Json(res)) + Ok(services::ApplicationResponse::Json(res)) }, &auth::AdminApiAuth, api_locking::LockAction::NotApplicable, diff --git a/crates/router_env/src/logger/types.rs b/crates/router_env/src/logger/types.rs index d395cd1f6da..20ae48484d5 100644 --- a/crates/router_env/src/logger/types.rs +++ b/crates/router_env/src/logger/types.rs @@ -550,6 +550,8 @@ pub enum Flow { PaymentStartRedirection, /// Volume split on the routing type VolumeSplitOnRoutingType, + /// Routing evaluate rule flow + RoutingEvaluateRule, /// Relay flow Relay, /// Relay retrieve flow	2025-07-15T12:45:54Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> This PR adds the routing rule evaluation endpoint to Hyperswitch, which calls the decision engine Added `evaluate_routing_rule` function, which calls `send_decision_engine_request` with `ApiKeyAuth` auth ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> Curl ``` curl --location 'http://localhost:8080/routing/rule/evaluate' \ --header 'Content-Type: application/json' \ --header 'api-key: dev_Zgz3AVVEqf4l1IZtWu****tLXfe0CcbUmdQ3Ol91gfvt0aytHG5C2FXmCxc' \ --data '{ "created_by":"merchant_1752591820", "parameters": { "payment_method": { "type": "enum_variant", "value": "upi"}, "amount": { "type": "number","value": 100} }, "fallback_output": [ { "gateway_name": "cybersource", "gateway_id": "mca_51nE*0cuknbQRaWz" } ] }' ``` Response ``` { "status": "default_selection", "output": { "type": "priority", "connectors": [ { "gateway_name": "stripe", "gateway_id": "mca_111" }, { "gateway_name": "adyen", "gateway_id": "mca_112" }, { "gateway_name": "checkout", "gateway_id": "mca_113" } ] }, "evaluated_output": [ { "gateway_name": "stripe", "gateway_id": "mca_111" } ], "eligible_connectors": [] } ``` Logs at Decision-engine <img width="1944" height="838" alt="image" src="https://github.com/user-attachments/assets/e9347077-916a-4dc7-9a9e-a0765067f2b4" /> Logs at Hyperswitch** <img width="1789" height="791" alt="image" src="https://github.com/user-attachments/assets/1fdab0fe-36ab-4ef8-be16-d2b2c261b864" /> ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	a6f4d7267f9d324096c112d824ba79fcaaa9648b	a6f4d7267f9d324096c112d824ba79fcaaa9648b
juspay/hyperswitch	juspay__hyperswitch-8613	Bug: Add support to call decision engine Dynamic Routing from hyperswitch after API key authentication	diff --git a/crates/api_models/src/events/routing.rs b/crates/api_models/src/events/routing.rs index 62bc49dbe1b..9f09bac8274 100644 --- a/crates/api_models/src/events/routing.rs +++ b/crates/api_models/src/events/routing.rs @@ -178,3 +178,27 @@ impl ApiEventMetric for RuleMigrationError { Some(ApiEventsType::Routing) } } + +impl ApiEventMetric for crate::open_router::DecideGatewayResponse { + fn get_api_event_type(&self) -> Option<ApiEventsType> { + Some(ApiEventsType::Routing) + } +} + +impl ApiEventMetric for crate::open_router::OpenRouterDecideGatewayRequest { + fn get_api_event_type(&self) -> Option<ApiEventsType> { + Some(ApiEventsType::Routing) + } +} + +impl ApiEventMetric for crate::open_router::UpdateScorePayload { + fn get_api_event_type(&self) -> Option<ApiEventsType> { + Some(ApiEventsType::Routing) + } +} + +impl ApiEventMetric for crate::open_router::UpdateScoreResponse { + fn get_api_event_type(&self) -> Option<ApiEventsType> { + Some(ApiEventsType::Routing) + } +} diff --git a/crates/api_models/src/open_router.rs b/crates/api_models/src/open_router.rs index f5b80383bfb..aefbd3eb211 100644 --- a/crates/api_models/src/open_router.rs +++ b/crates/api_models/src/open_router.rs @@ -26,6 +26,41 @@ pub struct OpenRouterDecideGatewayRequest { pub elimination_enabled: Option<bool>, } +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct DecideGatewayResponse { + pub decided_gateway: Option<String>, + pub gateway_priority_map: Option<serde_json::Value>, + pub filter_wise_gateways: Option<serde_json::Value>, + pub priority_logic_tag: Option<String>, + pub routing_approach: Option<String>, + pub gateway_before_evaluation: Option<String>, + pub priority_logic_output: Option<PriorityLogicOutput>, + pub reset_approach: Option<String>, + pub routing_dimension: Option<String>, + pub routing_dimension_level: Option<String>, + pub is_scheduled_outage: Option<bool>, + pub is_dynamic_mga_enabled: Option<bool>, + pub gateway_mga_id_map: Option<serde_json::Value>, +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct PriorityLogicOutput { + pub is_enforcement: Option<bool>, + pub gws: Option<Vec<String>>, + pub priority_logic_tag: Option<String>, + pub gateway_reference_ids: Option<HashMap<String, String>>, + pub primary_logic: Option<PriorityLogicData>, + pub fallback_logic: Option<PriorityLogicData>, +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct PriorityLogicData { + pub name: Option<String>, + pub status: Option<String>, + pub failure_reason: Option<String>, +} + #[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] #[serde(rename_all = "SCREAMING_SNAKE_CASE")] pub enum RankingAlgorithm { diff --git a/crates/router/src/core/payments/routing/utils.rs b/crates/router/src/core/payments/routing/utils.rs index d373b4188b1..5eb929a92d0 100644 --- a/crates/router/src/core/payments/routing/utils.rs +++ b/crates/router/src/core/payments/routing/utils.rs @@ -1232,7 +1232,7 @@ where String(String), } -#[derive(Debug)] +#[derive(Debug, Serialize)] pub struct RoutingEventsResponse<Res> where Res: Serialize + serde::de::DeserializeOwned + Clone, diff --git a/crates/router/src/core/routing.rs b/crates/router/src/core/routing.rs index 806a01235f3..2e6f8b09775 100644 --- a/crates/router/src/core/routing.rs +++ b/crates/router/src/core/routing.rs @@ -5,7 +5,12 @@ use std::collections::HashSet; #[cfg(all(feature = "v1", feature = "dynamic_routing"))] use api_models::routing::DynamicRoutingAlgoAccessor; use api_models::{ - enums, mandates as mandates_api, routing, + enums, mandates as mandates_api, + open_router::{ + DecideGatewayResponse, OpenRouterDecideGatewayRequest, UpdateScorePayload, + UpdateScoreResponse, + }, + routing, routing::{ self as routing_types, RoutingRetrieveQuery, RuleMigrationError, RuleMigrationResponse, }, @@ -13,6 +18,7 @@ use api_models::{ use async_trait::async_trait; #[cfg(all(feature = "v1", feature = "dynamic_routing"))] use common_utils::ext_traits::AsyncExt; +use common_utils::request::Method; use diesel_models::routing_algorithm::RoutingAlgorithm; use error_stack::ResultExt; #[cfg(all(feature = "v1", feature = "dynamic_routing"))] @@ -2621,3 +2627,59 @@ pub async fn migrate_rules_for_profile( errors: error_list, }) } + +pub async fn decide_gateway_open_router( + state: SessionState, + req_body: OpenRouterDecideGatewayRequest, +) -> RouterResponse<DecideGatewayResponse> { + let response = if state.conf.open_router.dynamic_routing_enabled { + SRApiClient::send_decision_engine_request( + &state, + Method::Post, + "decide-gateway", + Some(req_body), + None, + None, + ) + .await + .change_context(errors::ApiErrorResponse::InternalServerError)? + .response + .ok_or(errors::ApiErrorResponse::InternalServerError) + .attach_printable("Failed to perform decide gateway call with open router")? + } else { + Err(errors::ApiErrorResponse::InternalServerError) + .attach_printable("Dynamic routing is not enabled")? + }; + + Ok(hyperswitch_domain_models::api::ApplicationResponse::Json( + response, + )) +} + +pub async fn update_gateway_score_open_router( + state: SessionState, + req_body: UpdateScorePayload, +) -> RouterResponse<UpdateScoreResponse> { + let response = if state.conf.open_router.dynamic_routing_enabled { + SRApiClient::send_decision_engine_request( + &state, + Method::Post, + "update-gateway-score", + Some(req_body), + None, + None, + ) + .await + .change_context(errors::ApiErrorResponse::InternalServerError)? + .response + .ok_or(errors::ApiErrorResponse::InternalServerError) + .attach_printable("Failed to perform update gateway score call with open router")? + } else { + Err(errors::ApiErrorResponse::InternalServerError) + .attach_printable("Dynamic routing is not enabled")? + }; + + Ok(hyperswitch_domain_models::api::ApplicationResponse::Json( + response, + )) +} diff --git a/crates/router/src/routes/app.rs b/crates/router/src/routes/app.rs index cd132f0da63..e7127f43e87 100644 --- a/crates/router/src/routes/app.rs +++ b/crates/router/src/routes/app.rs @@ -973,6 +973,19 @@ impl Routing { })), ); + #[cfg(feature = "dynamic_routing")] + { + route = route + .service( + web::resource("/evaluate") + .route(web::post().to(routing::call_decide_gateway_open_router)), + ) + .service( + web::resource("/feedback") + .route(web::post().to(routing::call_update_gateway_score_open_router)), + ) + } + #[cfg(feature = "payouts")] { route = route diff --git a/crates/router/src/routes/lock_utils.rs b/crates/router/src/routes/lock_utils.rs index fda52ad9b0d..ab1e7bb1030 100644 --- a/crates/router/src/routes/lock_utils.rs +++ b/crates/router/src/routes/lock_utils.rs @@ -83,7 +83,9 @@ impl From<Flow> for ApiIdentifier { \| Flow::DecisionManagerUpsertConfig \| Flow::RoutingEvaluateRule \| Flow::DecisionEngineRuleMigration - \| Flow::VolumeSplitOnRoutingType => Self::Routing, + \| Flow::VolumeSplitOnRoutingType + \| Flow::DecisionEngineDecideGatewayCall + \| Flow::DecisionEngineGatewayFeedbackCall => Self::Routing, Flow::RetrieveForexFlow => Self::Forex, diff --git a/crates/router/src/routes/routing.rs b/crates/router/src/routes/routing.rs index 024d4c0cfbe..ffd5c265db0 100644 --- a/crates/router/src/routes/routing.rs +++ b/crates/router/src/routes/routing.rs @@ -1672,3 +1672,51 @@ async fn get_merchant_account( .to_not_found_response(ApiErrorResponse::MerchantAccountNotFound)?; Ok((key_store, merchant_account)) } + +#[cfg(all(feature = "olap", feature = "v1", feature = "dynamic_routing"))] +#[instrument(skip_all)] +pub async fn call_decide_gateway_open_router( + state: web::Data<AppState>, + req: HttpRequest, + payload: web::Json<api_models::open_router::OpenRouterDecideGatewayRequest>, +) -> impl Responder { + let flow = Flow::DecisionEngineDecideGatewayCall; + Box::pin(oss_api::server_wrap( + flow, + state, + &req, + payload.clone(), + \|state, _auth, payload, _\| routing::decide_gateway_open_router(state.clone(), payload), + &auth::ApiKeyAuth { + is_connected_allowed: false, + is_platform_allowed: false, + }, + api_locking::LockAction::NotApplicable, + )) + .await +} + +#[cfg(all(feature = "olap", feature = "v1", feature = "dynamic_routing"))] +#[instrument(skip_all)] +pub async fn call_update_gateway_score_open_router( + state: web::Data<AppState>, + req: HttpRequest, + payload: web::Json<api_models::open_router::UpdateScorePayload>, +) -> impl Responder { + let flow = Flow::DecisionEngineGatewayFeedbackCall; + Box::pin(oss_api::server_wrap( + flow, + state, + &req, + payload.clone(), + \|state, _auth, payload, _\| { + routing::update_gateway_score_open_router(state.clone(), payload) + }, + &auth::ApiKeyAuth { + is_connected_allowed: false, + is_platform_allowed: false, + }, + api_locking::LockAction::NotApplicable, + )) + .await +} diff --git a/crates/router_env/src/logger/types.rs b/crates/router_env/src/logger/types.rs index 155c5223375..d00d0f4e622 100644 --- a/crates/router_env/src/logger/types.rs +++ b/crates/router_env/src/logger/types.rs @@ -612,6 +612,10 @@ pub enum Flow { ThreeDsDecisionRuleExecute, /// Incoming Network Token Webhook Receive IncomingNetworkTokenWebhookReceive, + /// Decision Engine Decide Gateway Call + DecisionEngineDecideGatewayCall, + /// Decision Engine Gateway Feedback Call + DecisionEngineGatewayFeedbackCall, } /// Trait for providing generic behaviour to flow metric	2025-07-15T08:27:49Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> This PR adds API key auth to the decision engine endpoints for the decide gateway call and the update gateway score call. ### Additional Changes - [x] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> Closes #8613 ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> <details> <summary>decide-gateway</summary> curl --location 'http://localhost:8080/routing/evaluate' \ --header 'Content-Type: application/json' \ --header 'api-key: dev_UnrorzUwWmt9GUkRTalEmIjrWu3JwKNh8TkSZmMJ2Fsm*** \ --data '{ "merchantId": "pro_VTQjooFPAyPOBC0aj9Jk", "eligibleGatewayList": ["GatewayA", "GatewayB", "GatewayC"], "rankingAlgorithm": "SR_BASED_ROUTING", "eliminationEnabled": true, "paymentInfo": { "paymentId": "PAY12359", "amount": 100, "currency": "USD", "customerId": "CUST12345", "udfs": null, "preferredGateway": null, "paymentType": "ORDER_PAYMENT", "metadata": null, "internalMetadata": null, "isEmi": false, "emiBank": null, "emiTenure": null, "paymentMethodType": "credit", "paymentMethod": "card", "paymentSource": null, "authType": null, "cardIssuerBankName": null, "cardIsin": null, "cardType": null, "cardSwitchProvider": null } }' </details> <details> <summary>response</summary> { "decided_gateway": "GatewayA", "gateway_priority_map": { "GatewayA": 1.0, "GatewayB": 1.0, "GatewayC": 1.0 }, "filter_wise_gateways": null, "priority_logic_tag": null, "routing_approach": "SR_SELECTION_V3_ROUTING", "gateway_before_evaluation": "GatewayC", "priority_logic_output": { "isEnforcement": false, "gws": [ "GatewayA", "GatewayB", "GatewayC" ], "priorityLogicTag": null, "gatewayReferenceIds": {}, "primaryLogic": null, "fallbackLogic": null }, "reset_approach": "NO_RESET", "routing_dimension": "ORDER_PAYMENT, CREDIT, card", "routing_dimension_level": "PM_LEVEL", "is_scheduled_outage": false, "is_dynamic_mga_enabled": false, "gateway_mga_id_map": null } </details> --- <details> <summary>update-gateway-score</summary> curl --location 'http://localhost:8080/routing/feedback' \ --header 'Content-Type: application/json' \ --header 'api-key: dev_UnrorzUwWmt9GUkRTalEmIjrWu3JwKNh8TkSZmMJ2Fs****' \ --data '{ "merchantId" : "pro_VTQjooFPAyPOBC0aj9Jk", "gateway": "GatewayC", "gatewayReferenceId": null, "status": "FAILURE", "paymentId": "PAY12359", "enforceDynamicRoutingFailure" : null }' </details> <details> <summary>response</summary> { "message": "Success" } </details> ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	126018e217bfbd8bdd44043ace8a815046193818	126018e217bfbd8bdd44043ace8a815046193818
juspay/hyperswitch	juspay__hyperswitch-8601	Bug: Deleting a user role and again assigning a role to user is not updating its previous role to new role Role id is not getting updated in the invited user account in case the role is deleted and assigned again to invited user. This is happening due to the lineage context stored in db not updating the role id in case that role id does not exist any more. Steps to duplicate this edge case: 1. Invite a user with any user role 2. Accept the invitation and login to invited user account 3. Delete the user role from the account who invited the user 4. Assign a user role, then try to login to the invited account 5. Invited account still operates on the previous user role because of the lineage context getting stored in db	diff --git a/crates/router/src/types/domain/user/decision_manager.rs b/crates/router/src/types/domain/user/decision_manager.rs index 7bc11383da0..15d5463ecff 100644 --- a/crates/router/src/types/domain/user/decision_manager.rs +++ b/crates/router/src/types/domain/user/decision_manager.rs @@ -158,7 +158,11 @@ impl JWTFlow { UserRoleVersion::V2, ) .await - .is_ok(); + .inspect_err(\|e\| { + logger::error!("Failed to validate V2 role: {e:?}"); + }) + .map(\|role\| role.role_id == ctx.role_id) + .unwrap_or_default(); if user_role_match_v2 { ctx @@ -174,7 +178,11 @@ impl JWTFlow { UserRoleVersion::V1, ) .await - .is_ok(); + .inspect_err(\|e\| { + logger::error!("Failed to validate V1 role: {e:?}"); + }) + .map(\|role\| role.role_id == ctx.role_id) + .unwrap_or_default(); if user_role_match_v1 { ctx	2025-07-09T15:17:58Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [x] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> This PR fixes an issue where a stale `role_id` from the cached `lineage_context` was being used to generate the JWT token during sign-in, even if the actual user role was modified (e.g., role deleted and recreated with a different `role_id` but same lineage). Previously, we only validated if a user role existed for the lineage (`user_id`, `tenant_id`, `org_id`, `merchant_id`, `profile_id`), but did not verify that the `role_id` matched the current assigned role. This led to JWTs being issued with outdated `role_id` values. ### Changes Made - During sign-in, added a strict match check for `role_id` in the fetched user role. - If the `role_id` from cached `lineage_context` does not match the current role fetched from DB (v2 fallback to v1), we now resolve the lineage afresh from the current `user_role` object. - Logged errors for failed role fetch attempts for better traceability. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> In systems where roles can be modified dynamically (e.g., deleted and recreated), relying on cached `lineage_context.role_id` without validating it introduces a silent inconsistency. This can lead to: - Unexpected authorization behavior - Hard-to-debug permission issues - Stale tokens being issued This fix ensures that JWTs are always generated using valid and current `role_id` information associated with the user role. ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> #### Scenario: Validate fallback when `role_id` has changed 1. Initial Setup - Log in as an `org_admin` of Org A. - Invite User X to Org A with the role `org_admin`. - Ensure User X is also part of another organization (Org B) and has a valid user role there. 2. Initial Sign-In - Sign in as User X to Org A, selecting a specific merchant and profile. - This populates and stores the `lineage_context` based on the selected values. 3. Modify Role Assignment - Log back in as the original `org_admin` of Org A. - Delete the current user role (`org_admin`) of User X in Org A. - Create a new role in Org A named `profile_admin` using the same merchant and profile from the stored `lineage_context`. - Re-invite User X to Org A with this new `profile_admin` role. 4. Re-Sign-In Validation - Now sign in again as User X. - Since the original role (`org_admin`) no longer exists, the cached lineage context will fail validation. - The system should fall back to the default sign-in flow and pick a valid user role for JWT construction. 5. Verify Correct Role Assignment - If sign-in occurs into a different organization, it's acceptable. - If signed into Org A, validate the `role_id`: - Check the response from `/user` API. - OR decode the JWT token. - The `role_id` should now correctly reflect `profile_admin`. ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [x] I added unit tests for my changes where possible	v1.115.0	99885b699d7524e87697f78608e6f2b36c9d8a8e	99885b699d7524e87697f78608e6f2b36c9d8a8e
juspay/hyperswitch	juspay__hyperswitch-8604	Bug: add apple pay decrypt support for Adyen add apple pay decrypt support for Adyen	diff --git a/crates/connector_configs/toml/development.toml b/crates/connector_configs/toml/development.toml index cdf94d6e439..77fb8141c0f 100644 --- a/crates/connector_configs/toml/development.toml +++ b/crates/connector_configs/toml/development.toml @@ -286,7 +286,7 @@ label="Payment Processing Details At" placeholder="Enter Payment Processing Details At" required=true type="Radio" -options=["Connector"] +options=["Connector", "Hyperswitch"] [[adyen.metadata.google_pay]] name="merchant_name" diff --git a/crates/connector_configs/toml/production.toml b/crates/connector_configs/toml/production.toml index b9a98f5aedd..cf9c19fcaba 100644 --- a/crates/connector_configs/toml/production.toml +++ b/crates/connector_configs/toml/production.toml @@ -192,7 +192,7 @@ label="Payment Processing Details At" placeholder="Enter Payment Processing Details At" required=true type="Radio" -options=["Connector"] +options=["Connector", "Hyperswitch"] [[adyen.metadata.google_pay]] name="merchant_name" diff --git a/crates/connector_configs/toml/sandbox.toml b/crates/connector_configs/toml/sandbox.toml index 21801d380b5..28aca80b17b 100644 --- a/crates/connector_configs/toml/sandbox.toml +++ b/crates/connector_configs/toml/sandbox.toml @@ -284,7 +284,7 @@ label="Payment Processing Details At" placeholder="Enter Payment Processing Details At" required=true type="Radio" -options=["Connector"] +options=["Connector", "Hyperswitch"] [[adyen.metadata.google_pay]] name="merchant_name" diff --git a/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs b/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs index 8f4d667711b..f435338f22f 100644 --- a/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs @@ -57,9 +57,10 @@ use crate::{ SubmitEvidenceRouterData, }, utils::{ - self, is_manual_capture, missing_field_err, AddressDetailsData, BrowserInformationData, - CardData, ForeignTryFrom, NetworkTokenData as UtilsNetworkTokenData, - PaymentsAuthorizeRequestData, PhoneDetailsData, RouterData as OtherRouterData, + self, is_manual_capture, missing_field_err, AddressDetailsData, ApplePayDecrypt, + BrowserInformationData, CardData, ForeignTryFrom, + NetworkTokenData as UtilsNetworkTokenData, PaymentsAuthorizeRequestData, PhoneDetailsData, + RouterData as OtherRouterData, }, }; @@ -309,7 +310,8 @@ struct AdyenSplitData { struct AdyenMpiData { directory_response: String, authentication_response: String, - token_authentication_verification_value: Secret<String>, + cavv: Option<Secret<String>>, + token_authentication_verification_value: Option<Secret<String>>, eci: Option<String>, } @@ -675,6 +677,7 @@ pub enum AdyenPaymentMethod<'a> { #[serde(rename = "alipay_hk")] AliPayHk, ApplePay(Box<AdyenApplePay>), + ApplePayDecrypt(Box<AdyenApplePayDecryptData>), Atome, #[serde(rename = "scheme")] BancontactCard(Box<AdyenCard>), @@ -1253,6 +1256,18 @@ pub struct AdyenPazeData { network_payment_reference: Option<Secret<String>>, } +#[serde_with::skip_serializing_none] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct AdyenApplePayDecryptData { + number: Secret<String>, + expiry_month: Secret<String>, + expiry_year: Secret<String>, + brand: String, + #[serde(rename = "type")] + payment_type: PaymentType, +} + #[derive(Debug, Clone, Serialize, Deserialize)] #[serde(rename_all = "lowercase")] pub enum CardBrand { @@ -2194,11 +2209,27 @@ impl TryFrom<(&WalletData, &PaymentsAuthorizeRouterData)> for AdyenPaymentMethod Ok(AdyenPaymentMethod::Gpay(Box::new(gpay_data))) } WalletData::ApplePay(data) => { - let apple_pay_data = AdyenApplePay { - apple_pay_token: Secret::new(data.payment_data.to_string()), - }; - - Ok(AdyenPaymentMethod::ApplePay(Box::new(apple_pay_data))) + if let Some(PaymentMethodToken::ApplePayDecrypt(apple_pay_decrypte)) = + item.payment_method_token.clone() + { + let expiry_year_4_digit = apple_pay_decrypte.get_four_digit_expiry_year()?; + let exp_month = apple_pay_decrypte.get_expiry_month()?; + let apple_pay_decrypted_data = AdyenApplePayDecryptData { + number: apple_pay_decrypte.application_primary_account_number, + expiry_month: exp_month, + expiry_year: expiry_year_4_digit, + brand: "applepay".to_string(), + payment_type: PaymentType::Scheme, + }; + Ok(AdyenPaymentMethod::ApplePayDecrypt(Box::new( + apple_pay_decrypted_data, + ))) + } else { + let apple_pay_data = AdyenApplePay { + apple_pay_token: Secret::new(data.payment_data.to_string()), + }; + Ok(AdyenPaymentMethod::ApplePay(Box::new(apple_pay_data))) + } } WalletData::PaypalRedirect(_) => Ok(AdyenPaymentMethod::AdyenPaypal), WalletData::AliPayRedirect(_) => Ok(AdyenPaymentMethod::AliPay), @@ -3426,15 +3457,23 @@ impl TryFrom<(&AdyenRouterData<&PaymentsAuthorizeRouterData>, &WalletData)> let shopper_email = get_shopper_email(item.router_data, store_payment_method.is_some())?; let billing_address = get_address_info(item.router_data.get_optional_billing()).and_then(Result::ok); - let mpi_data = if let WalletData::Paze(_) = wallet_data { + let mpi_data = if matches!(wallet_data, WalletData::Paze(_) \| WalletData::ApplePay(_)) { match item.router_data.payment_method_token.clone() { - Some(PaymentMethodToken::PazeDecrypt(paze_decrypted_data)) => Some(AdyenMpiData { + Some(PaymentMethodToken::PazeDecrypt(paze_data)) => Some(AdyenMpiData { directory_response: "Y".to_string(), authentication_response: "Y".to_string(), - token_authentication_verification_value: paze_decrypted_data - .token - .payment_account_reference, - eci: paze_decrypted_data.eci, + cavv: None, + token_authentication_verification_value: Some( + paze_data.token.payment_account_reference, + ), + eci: paze_data.eci, + }), + Some(PaymentMethodToken::ApplePayDecrypt(apple_data)) => Some(AdyenMpiData { + directory_response: "Y".to_string(), + authentication_response: "Y".to_string(), + cavv: Some(apple_data.payment_data.online_payment_cryptogram), + token_authentication_verification_value: None, + eci: apple_data.payment_data.eci_indicator, }), _ => None, } @@ -5852,10 +5891,10 @@ impl let mpi_data = AdyenMpiData { directory_response: "Y".to_string(), authentication_response: "Y".to_string(), - token_authentication_verification_value: token_data - .get_cryptogram() - .clone() - .unwrap_or_default(), + cavv: None, + token_authentication_verification_value: Some( + token_data.get_cryptogram().clone().unwrap_or_default(), + ), eci: Some("02".to_string()), }; let (store, splits) = match item.router_data.request.split_payments.as_ref() {	2025-07-10T11:41:04Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [x] feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> This pull request introduces support for decrypting Apple Pay payment data in the Adyen connector. It includes updates to the `AdyenPaymentMethod` enum, new structures for handling decrypted Apple Pay data, and modifications to existing logic for processing payment tokens. The changes enhance functionality and improve flexibility in handling payment methods. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> -> Create a merchant connector account for adyen and enable apple pay ``` "apple_pay_combined": { "manual": { "session_token_data": { "initiative": "web", "certificate": "", "display_name": "apple pay", "certificate_keys": "", "initiative_context": "debuglab.basilisk-char.ts.net", "merchant_identifier": "", "merchant_business_country": "AU", "payment_processing_details_at": "", "payment_processing_certificate": "", "payment_processing_certificate_key": "" }, "payment_request_data": { "label": "applepay", "supported_networks": [ "visa", "masterCard", "amex", "discover" ], "merchant_capabilities": [ "supports3DS" ] } } }, ``` -> Make a apple pay payment ``` curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: api-key' \ --data-raw '{ "amount": 650, "currency": "USD", "confirm": true, "business_country": "US", "business_label": "default", "amount_to_capture": 650, "customer_id": "cu_1752147534", "capture_method": "automatic", "capture_on": "2022-09-10T10:11:12Z", "setup_future_usage": "off_session", "authentication_type": "no_three_ds", "return_url": "https://google.com", "email": "[email protected]", "name": "Joseph Doe", "phone": "999999999", "phone_country_code": "+65", "description": "Its my first payment request", "statement_descriptor_name": "Juspay", "statement_descriptor_suffix": "Router", "payment_method": "wallet", "payment_method_type": "apple_pay", "billing": { "address": { "line1": "1467", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" }, "phone": { "number": "8056594427", "country_code": "+91" } }, "customer_acceptance": { "acceptance_type": "offline", "accepted_at": "1963-05-03T04:07:52.723Z", "online": { "ip_address": "in sit", "user_agent": "amet irure esse" } }, "payment_method_data": { "wallet": { "apple_pay": { "payment_data": "==", "payment_method": { "display_name": "Discover 9319", "network": "Discover", "type": "credit" }, "transaction_identifier": "c635c5b3af900d7bd81fecd7028f1262f9d030754ee65ec7afd988a678194751" } } } }' ``` ``` { "payment_id": "pay_dJrJVGuuuMcTx3ZMr3sn", "merchant_id": "merchant_1752143545", "status": "succeeded", "amount": 650, "net_amount": 650, "shipping_cost": null, "amount_capturable": 0, "amount_received": 650, "connector": "adyen", "client_secret": "pay_dJrJVGuuuMcTx3ZMr3sn_secret_uJD9kz6I3hUvC0333wj0", "created": "2025-07-10T11:38:51.845Z", "currency": "USD", "customer_id": "cu_1752147532", "customer": { "id": "cu_1752147532", "name": "Joseph Doe", "email": "[email protected]", "phone": "999999999", "phone_country_code": "+65" }, "description": "Its my first payment request", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": "off_session", "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "wallet", "payment_method_data": { "wallet": { "apple_pay": { "last4": "9319", "card_network": "Discover", "type": "credit" } }, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": null, "line3": null, "zip": "94122", "state": "California", "first_name": "joseph", "last_name": "Doe" }, "phone": { "number": "8056594427", "country_code": "+91" }, "email": null }, "order_details": null, "email": "[email protected]", "name": "Joseph Doe", "phone": "999999999", "return_url": "https://google.com/", "authentication_type": "no_three_ds", "statement_descriptor_name": "Juspay", "statement_descriptor_suffix": "Router", "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "apple_pay", "connector_label": "adyen_US_default", "business_country": "US", "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": { "customer_id": "cu_1752147532", "created_at": 1752147531, "expires": 1752151131, "secret": "epk_29209a3a0b8744e78745fc53120e2606" }, "manual_retry_allowed": false, "connector_transaction_id": "FFRWLKGL9GMTT475", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_dJrJVGuuuMcTx3ZMr3sn_1", "payment_link": null, "profile_id": "pro_J2FnaaW4M2zfdqhM1pGa", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_r2IwjAwwrKATInMfX2Ga", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-07-10T11:53:51.845Z", "fingerprint": null, "browser_info": null, "payment_method_id": "pm_GNhWI2uXCdrKCcNiZ9Cg", "payment_method_status": "active", "updated": "2025-07-10T11:38:53.596Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": "QSJDL57GX6C68775", "card_discovery": null, "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` -> connector request ``` { "amount": { "currency": "USD", "value": 650 }, "merchantAccount": "* alloc::string::String ", "paymentMethod": { "type": "scheme", "number": " alloc::string::String ", "expiryMonth": " alloc::string::String ", "expiryYear": " alloc::string::String ", "brand": "applepay" }, "mpiData": { "directoryResponse": "Y", "authenticationResponse": "Y", "cavv": " alloc::string::String ", "eci": "7" }, "reference": "pay_dJrJVGuuuMcTx3ZMr3sn_1", "returnUrl": "http://localhost:8080/payments/pay_dJrJVGuuuMcTx3ZMr3sn/merchant_1752143545/redirect/response/adyen", "shopperInteraction": "Ecommerce", "recurringProcessingModel": "UnscheduledCardOnFile", "shopperReference": "merchant_1752143545_cu_1752147532", "storePaymentMethod": true, "shopperStatement": "Juspay", "telephoneNumber": " alloc::string::String ", "billingAddress": { "city": "San Fransico", "country": "US", "houseNumberOrName": " alloc::string::String ", "postalCode": " alloc::string::String ", "stateOrProvince": " alloc::string::String *" } } ``` <img width="1426" height="973" alt="image" src="https://github.com/user-attachments/assets/544ca966-7267-46ae-869a-d6e5cdbe96b1" /> ### testing existing connector decryption flow ``` { "amount": 1, "currency": "EUR", "confirm": true, "business_country": "US", "business_label": "default", "amount_to_capture": 1, "customer_id": "cu_{{$timestamp}}", "capture_method": "automatic", "capture_on": "2022-09-10T10:11:12Z", "setup_future_usage": "off_session", "authentication_type": "no_three_ds", "return_url": "https://google.com", "email": "[email protected]", "name": "Joseph Doe", "phone": "999999999", "phone_country_code": "+65", "description": "Its my first payment request", "statement_descriptor_name": "Juspay", "statement_descriptor_suffix": "Router", "payment_method": "wallet", "payment_method_type": "apple_pay", "billing": { "address": { "line1": "1467", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" }, "phone": { "number": "8056594427", "country_code": "+91" } }, "customer_acceptance": { "acceptance_type": "offline", "accepted_at": "1963-05-03T04:07:52.723Z", "online": { "ip_address": "in sit", "user_agent": "amet irure esse" } }, "payment_method_data": { "wallet": { "apple_pay": { "payment_data": "eyJkYXRhIjoiK3NLL0trRWMvRXlFb203N2FJenFYMkNyNG1ldFlranRla1h3eEIyQTJYRzA4ekMwMFJwdFowU0xlSExabnRvZTZpeVNnbzFNVmUyWWVCRVk2b2VteUpwU053TE5PQVU0K3M2eU9zSXNJQ0VITTlMa3FjZGoyc0IwU2RzUHAyUklHVGp3TWozVGtsTFhQV295NlJ0NlZyVVFQemxldlRobE9OZ3piR2psd0I1OVlxN3J0VHFHN0h5eFd3WTJLaDBzcytySWpDbHdnQkRzSzNXMVJ2bzB2NVlDVEdFYWhHRUQxMlN1RTYxbzVOU1NmUjBGUHlDbWtEaTBBYm1XbXBHN0ZmSGMxTkY2MDRkMUtTcmlMclpUU2hYYnhxZVFGdjlxZXpibUVOck1CZXpsLzdFU2NvMU5GMFpyZ1h1Z29oa3JkQkpPeXlJc0I4Qmw5QTl1emFJL2RoU3dpYTFMWGw0Zml0Q3p6U1diUDhBUDV2UkN3TEhMT3M5eTFKNmpYMDJJamtDSlBybU5KYmVTeUE9PSIsInNpZ25hdHVyZSI6Ik1JQUdDU3FHU0liM0RRRUhBcUNBTUlBQ0FRRXhEVEFMQmdsZ2hrZ0JaUU1FQWdFd2dBWUpLb1pJaHZjTkFRY0JBQUNnZ0RDQ0ErUXdnZ09Mb0FNQ0FRSUNDRm5Zb2J5cTlPUE5NQW9HQ0NxR1NNNDlCQU1DTUhveExqQXNCZ05WQkFNTUpVRndjR3hsSUVGd2NHeHBZMkYwYVc5dUlFbHVkR1ZuY21GMGFXOXVJRU5CSUMwZ1J6TXhKakFrQmdOVkJBc01IVUZ3Y0d4bElFTmxjblJwWm1sallYUnBiMjRnUVhWMGFHOXlhWFI1TVJNd0VRWURWUVFLREFwQmNIQnNaU0JKYm1NdU1Rc3dDUVlEVlFRR0V3SlZVekFlRncweU1UQTBNakF4T1RNM01EQmFGdzB5TmpBME1Ua3hPVE0yTlRsYU1HSXhLREFtQmdOVkJBTU1IMlZqWXkxemJYQXRZbkp2YTJWeUxYTnBaMjVmVlVNMExWTkJUa1JDVDFneEZEQVNCZ05WQkFzTUMybFBVeUJUZVhOMFpXMXpNUk13RVFZRFZRUUtEQXBCY0hCc1pTQkpibU11TVFzd0NRWURWUVFHRXdKVlV6QlpNQk1HQnlxR1NNNDlBZ0VHQ0NxR1NNNDlBd0VIQTBJQUJJSXcvYXZEblBkZUlDeFEyWnRGRXVZMzRxa0IzV3l6NExITlMxSm5tUGpQVHIzb0dpV293aDVNTTkzT2ppcVd3dmF2b1pNRFJjVG9la1FtenBVYkVwV2pnZ0lSTUlJQ0RUQU1CZ05WSFJNQkFmOEVBakFBTUI4R0ExVWRJd1FZTUJhQUZDUHlTY1JQaytUdkorYkU5aWhzUDZLNy9TNUxNRVVHQ0NzR0FRVUZCd0VCQkRrd056QTFCZ2dyQmdFRkJRY3dBWVlwYUhSMGNEb3ZMMjlqYzNBdVlYQndiR1V1WTI5dEwyOWpjM0F3TkMxaGNIQnNaV0ZwWTJFek1ESXdnZ0VkQmdOVkhTQUVnZ0VVTUlJQkVEQ0NBUXdHQ1NxR1NJYjNZMlFGQVRDQi9qQ0J3d1lJS3dZQkJRVUhBZ0l3Z2JZTWdiTlNaV3hwWVc1alpTQnZiaUIwYUdseklHTmxjblJwWm1sallYUmxJR0o1SUdGdWVTQndZWEowZVNCaGMzTjFiV1Z6SUdGalkyVndkR0Z1WTJVZ2IyWWdkR2hsSUhSb1pXNGdZWEJ3YkdsallXSnNaU0J6ZEdGdVpHRnlaQ0IwWlhKdGN5QmhibVFnWTI5dVpHbDBhVzl1Y3lCdlppQjFjMlVzSUdObGNuUnBabWxqWVhSbElIQnZiR2xqZVNCaGJtUWdZMlZ5ZEdsbWFXTmhkR2x2YmlCd2NtRmpkR2xqWlNCemRHRjBaVzFsYm5SekxqQTJCZ2dyQmdFRkJRY0NBUllxYUhSMGNEb3ZMM2QzZHk1aGNIQnNaUzVqYjIwdlkyVnlkR2xtYVdOaGRHVmhkWFJvYjNKcGRIa3ZNRFFHQTFVZEh3UXRNQ3N3S2FBbm9DV0dJMmgwZEhBNkx5OWpjbXd1WVhCd2JHVXVZMjl0TDJGd2NHeGxZV2xqWVRNdVkzSnNNQjBHQTFVZERnUVdCQlFDSkRBTG11N3RSakdYcEtaYUtaNUNjWUljUlRBT0JnTlZIUThCQWY4RUJBTUNCNEF3RHdZSktvWklodmRqWkFZZEJBSUZBREFLQmdncWhrak9QUVFEQWdOSEFEQkVBaUIwb2JNazIwSkpRdzNUSjB4UWRNU0FqWm9mU0E0NmhjWEJOaVZtTWwrOG93SWdhVGFRVTZ2MUMxcFMrZllBVGNXS3JXeFFwOVlJYURlUTRLYzYwQjVLMllFd2dnTHVNSUlDZGFBREFnRUNBZ2hKYlMrL09wamFsekFLQmdncWhrak9QUVFEQWpCbk1Sc3dHUVlEVlFRRERCSkJjSEJzWlNCU2IyOTBJRU5CSUMwZ1J6TXhKakFrQmdOVkJBc01IVUZ3Y0d4bElFTmxjblJwWm1sallYUnBiMjRnUVhWMGFHOXlhWFI1TVJNd0VRWURWUVFLREFwQmNIQnNaU0JKYm1NdU1Rc3dDUVlEVlFRR0V3SlZVekFlRncweE5EQTFNRFl5TXpRMk16QmFGdzB5T1RBMU1EWXlNelEyTXpCYU1Ib3hMakFzQmdOVkJBTU1KVUZ3Y0d4bElFRndjR3hwWTJGMGFXOXVJRWx1ZEdWbmNtRjBhVzl1SUVOQklDMGdSek14SmpBa0JnTlZCQXNNSFVGd2NHeGxJRU5sY25ScFptbGpZWFJwYjI0Z1FYVjBhRzl5YVhSNU1STXdFUVlEVlFRS0RBcEJjSEJzWlNCSmJtTXVNUXN3Q1FZRFZRUUdFd0pWVXpCWk1CTUdCeXFHU000OUFnRUdDQ3FHU000OUF3RUhBMElBQlBBWEVZUVoxMlNGMVJwZUpZRUhkdWlBb3UvZWU2NU40STM4UzVQaE0xYlZabHMxcmlMUWwzWU5JazU3dWdqOWRoZk9pTXQydTJad3Zzam9LWVQvVkVXamdmY3dnZlF3UmdZSUt3WUJCUVVIQVFFRU9qQTRNRFlHQ0NzR0FRVUZCekFCaGlwb2RIUndPaTh2YjJOemNDNWhjSEJzWlM1amIyMHZiMk56Y0RBMExXRndjR3hsY205dmRHTmhaek13SFFZRFZSME9CQllFRkNQeVNjUlBrK1R2SitiRTlpaHNQNks3L1M1TE1BOEdBMVVkRXdFQi93UUZNQU1CQWY4d0h3WURWUjBqQkJnd0ZvQVV1N0Rlb1ZnemlKcWtpcG5ldnIzcnI5ckxKS3N3TndZRFZSMGZCREF3TGpBc29DcWdLSVltYUhSMGNEb3ZMMk55YkM1aGNIQnNaUzVqYjIwdllYQndiR1Z5YjI5MFkyRm5NeTVqY213d0RnWURWUjBQQVFIL0JBUURBZ0VHTUJBR0NpcUdTSWIzWTJRR0FnNEVBZ1VBTUFvR0NDcUdTTTQ5QkFNQ0EyY0FNR1FDTURyUGNvTlJGcG14aHZzMXcxYktZci8wRiszWkQzVk5vbzYrOFp5QlhrSzNpZmlZOTV0Wm41alZRUTJQbmVuQy9nSXdNaTNWUkNHd293VjNiRjN6T0R1UVovMFhmQ3doYlpaUHhuSnBnaEp2VlBoNmZSdVp5NXNKaVNGaEJwa1BDWklkQUFBeGdnR0hNSUlCZ3dJQkFUQ0JoakI2TVM0d0xBWURWUVFERENWQmNIQnNaU0JCY0hCc2FXTmhkR2x2YmlCSmJuUmxaM0poZEdsdmJpQkRRU0F0SUVjek1TWXdKQVlEVlFRTERCMUJjSEJzWlNCRFpYSjBhV1pwWTJGMGFXOXVJRUYxZEdodmNtbDBlVEVUTUJFR0ExVUVDZ3dLUVhCd2JHVWdTVzVqTGpFTE1Ba0dBMVVFQmhNQ1ZWTUNDRm5Zb2J5cTlPUE5NQXNHQ1dDR1NBRmxBd1FDQWFDQmt6QVlCZ2txaGtpRzl3MEJDUU14Q3dZSktvWklodmNOQVFjQk1Cd0dDU3FHU0liM0RRRUpCVEVQRncweU5UQTNNVFV3TXpNMU16UmFNQ2dHQ1NxR1NJYjNEUUVKTkRFYk1Ca3dDd1lKWUlaSUFXVURCQUlCb1FvR0NDcUdTTTQ5QkFNQ01DOEdDU3FHU0liM0RRRUpCREVpQkNBZ0VKd0VMWm1LQ3Y4SFUraEhQVVAwdnNNdFB6UjI4UzJVNzFvVEdRMURvakFLQmdncWhrak9QUVFEQWdSR01FUUNJRE5JZnNod1lQYWFXd1prYWtmSWZtcVJNZVc5eE96S1RCZmY4MDIrVWF1MkFpQVltb2FnbVJMSFNzUjk0Z1IxMHlvKzBrL1ZRVlFvNUhRRllEUjEyWkg2d0FBQUFBQUFBQT09IiwiaGVhZGVyIjp7InB1YmxpY0tleUhhc2giOiJFYzRPbEFveXRpNFpyZ1lCclRMZzZMQ1NVSzdCdHBQekozblpQeC9Sd3RBPSIsImVwaGVtZXJhbFB1YmxpY0tleSI6Ik1Ga3dFd1lIS29aSXpqMENBUVlJS29aSXpqMERBUWNEUWdBRXZ0QlVudThhS244alBNQzM4SFdnQ00zeVRTT3ZiaDFsakRtWFVsZzJUUExtYWhwTS9RcEtqRkdYeVEyY2JKWW5aeU1HVjRzR2w1T0NWcFR2eld0cjBBPT0iLCJ0cmFuc2FjdGlvbklkIjoiNzI5NWY3NTc4ZGM4ODI2OWE5ZGY0MWU0YzgxZjQ2ODE2NWYzMmE3NjFjMTA5MGIzNDhlMjAxYzk1YmI0ZmUxMyJ9LCJ2ZXJzaW9uIjoiRUNfdjEifQ==", "payment_method": { "display_name": "Discover 9319", "network": "Discover", "type": "credit" }, "transaction_identifier": "c635c5b3af900d7bd81fecd7028f1262f9d030754ee65ec7afd988a678194751" } } } } ``` ``` { "payment_id": "pay_kM6NBnxuHTlzY5ybGLqx", "merchant_id": "merchant_1752565724", "status": "succeeded", "amount": 1, "net_amount": 1, "shipping_cost": null, "amount_capturable": 0, "amount_received": 1, "connector": "adyen", "client_secret": "pay_kM6NBnxuHTlzY5ybGLqx_secret_5mV0RX2Rs2mOQ4X67Yjs", "created": "2025-07-15T07:53:29.564Z", "currency": "EUR", "customer_id": "cu_1752566010", "customer": { "id": "cu_1752566010", "name": "Joseph Doe", "email": "[email protected]", "phone": "999999999", "phone_country_code": "+65" }, "description": "Its my first payment request", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": "off_session", "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "wallet", "payment_method_data": { "wallet": { "apple_pay": { "last4": "9319", "card_network": "Discover", "type": "credit" } }, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": null, "line3": null, "zip": "94122", "state": "California", "first_name": "joseph", "last_name": "Doe" }, "phone": { "number": "8056594427", "country_code": "+91" }, "email": null }, "order_details": null, "email": "[email protected]", "name": "Joseph Doe", "phone": "999999999", "return_url": "https://google.com/", "authentication_type": "no_three_ds", "statement_descriptor_name": "Juspay", "statement_descriptor_suffix": "Router", "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "apple_pay", "connector_label": "adyen_US_default", "business_country": "US", "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": { "customer_id": "cu_1752566010", "created_at": 1752566009, "expires": 1752569609, "secret": "epk_dd5dd4d6b20d4c18a9db60922145f7b6" }, "manual_retry_allowed": false, "connector_transaction_id": "SHKNSMTDM6STT475", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_kM6NBnxuHTlzY5ybGLqx_1", "payment_link": null, "profile_id": "pro_BECixFE1QlimjLqJalgs", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_7SBGsmaaqWT9TrbNL747", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-07-15T08:08:29.564Z", "fingerprint": null, "browser_info": null, "payment_method_id": "pm_oGV7tOINPnAnIWUo0w9U", "payment_method_status": "active", "updated": "2025-07-15T07:53:31.250Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": "SQGB2PFPQLSMC375", "card_discovery": null, "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	cb055134603478c5fb68e882fad65f25649e8cb4	cb055134603478c5fb68e882fad65f25649e8cb4
juspay/hyperswitch	juspay__hyperswitch-8595	Bug: fix(cypress): cypress tests for incremental auth getting skipped for all connectors ### 📌 Problem The Cypress test suite `00029-IncrementalAuth.cy.js` is currently being entirely, even though it should work for `cybersource` . <img width="930" height="320" alt="Image" src="https://github.com/user-attachments/assets/26e4a754-025e-4c9c-8bfc-618bf423362d" />		2025-07-09T17:08:39Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [x] Bugfix - [ ] New feature - [x] Enhancement - [x] Refactoring - [ ] Dependency updates - [ ] Documentation - [x] CI/CD ## Description <!-- Describe your changes in detail --> This PR introduces a set of improvements and refactors in the Cypress test suite specifically for Incremental Authorization test cases. --- ### ✅ Key Changes: 1. Connector Inclusion List for Incremental Auth * Introduced a new list `INCREMENTAL_AUTH` in `Utils.js` under `CONNECTOR_LISTS.INCLUDE`. * This inclusion list determines which connectors support Incremental Authorization and should execute related tests. 2. Dynamic Skipping of Tests Based on Connector Support * Refactored the test flow to dynamically `skip()` test blocks at runtime if the connector isn't included in `INCREMENTAL_AUTH`. * Prevents false negatives and unwanted test runs on unsupported connectors (like CyberSource with known `MULTIPLE_CONNECTORS` issues). 3. Refactored `before` and `after` Hooks * Replaced arrow functions with regular functions in `before()` hooks to correctly utilize `this.skip()`. * Ensured proper state flushing with `afterEach` instead of `after`. 4. Improved Capture Test for Incremental Auth * Modified the capture test logic to simulate an incremented capture amount. * Prevents test result from falling into `partially_captured` due to stale `previously_authorized_amount`. 5. Enhanced Assertions for Incremental Auth Response * Added deep assertions for `previously_authorized_amount` from `incremental_authorizations` to validate correctness of incremental logic. * Ensures the captured amount matches the expected post-incremented value. ### 🧪 Test Impact: * Only connectors in `INCREMENTAL_AUTH` list will now run Incremental Authorization tests. * Currently includes: `cybersource` (commented out due to known issue), `paypal`, and `archipel` (handled in related PR #8189). * Other connectors will auto-skip these tests, improving CI stability and relevance. ### 💡 Reference Followed the pattern used in working test files like `00020-MandatesUsingNTIDProxy.cy.js`, which implement `this.skip()` with proper connector inclusion checks. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> The test suite for Incremental Auth (`00029-IncrementalAuth.cy.js`) was being entirely skipped due to usage of `describe.skip` and context handling. ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> \| Cybersource (Skipped) \| ArchiPEL \| \|----\|----\| \| <img height="300" alt="image" src="https://github.com/user-attachments/assets/343f556a-26e8-43dc-b714-9b74446d4e35" /> \| <img width="300" alt="image" src="https://github.com/user-attachments/assets/8fa0bf09-0cea-4b23-b656-5d0f3c236ab9" /> \| ### Sanity \| Stripe \| Adyen \| Bluesnap \| Bank of America \| \|----\|----\|----\|----\| \| <img width="300" alt="image" src="https://github.com/user-attachments/assets/8b567f21-fbde-4ad3-88e1-2a8cca70084f" /> \| <img width="300" alt="image" src="https://github.com/user-attachments/assets/8b567f21-fbde-4ad3-88e1-2a8cca70084f" /> \| <img width="300" alt="image" src="https://github.com/user-attachments/assets/8b567f21-fbde-4ad3-88e1-2a8cca70084f" /> \| <img width="300" alt="image" src="https://github.com/user-attachments/assets/8b567f21-fbde-4ad3-88e1-2a8cca70084f" /> \| ## Checklist <!-- Put an `x` in the boxes that apply --> - [ ] I formatted the code `cargo +nightly fmt --all` - [ ] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	1991e38457f713daeb280e22b2dd19c2944840b6	1991e38457f713daeb280e22b2dd19c2944840b6
juspay/hyperswitch	juspay__hyperswitch-8592	Bug: [FEATURE] [CONNECTOR : SILVERFLOW] Cards No 3ds Alpha integration ### Feature Description Cards Non-3DS payments added for silverflow (Alpha Integration). ### Possible Implementation Cards Non-3DS payments added for silverflow (Alpha Integration). ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? None	diff --git a/crates/connector_configs/toml/development.toml b/crates/connector_configs/toml/development.toml index 9e493eb6a54..2737d7a2323 100644 --- a/crates/connector_configs/toml/development.toml +++ b/crates/connector_configs/toml/development.toml @@ -6330,9 +6330,20 @@ type="Text" api_key="API Key" [silverflow] -[silverflow.connector_auth.BodyKey] +[[silverflow.credit]] + payment_method_type = "Mastercard" +[[silverflow.credit]] + payment_method_type = "Visa" +[[silverflow.debit]] + payment_method_type = "Mastercard" +[[silverflow.debit]] + payment_method_type = "Visa" +[silverflow.connector_auth.SignatureKey] api_key="API Key" -key1="Secret Key" +api_secret="API Secret" +key1="Merchant Acceptor Key" +[silverflow.connector_webhook_details] +merchant_secret="Source verification key" [affirm] [affirm.connector_auth.HeaderKey] @@ -6345,3 +6356,4 @@ api_key = "API Key" [breadpay] [breadpay.connector_auth.HeaderKey] api_key = "API Key" + diff --git a/crates/connector_configs/toml/production.toml b/crates/connector_configs/toml/production.toml index e81c3f6aac9..8bd08758dd5 100644 --- a/crates/connector_configs/toml/production.toml +++ b/crates/connector_configs/toml/production.toml @@ -4939,9 +4939,20 @@ payment_method_type = "Visa" api_key = "API Key" [silverflow] -[silverflow.connector_auth.BodyKey] -api_key = "API Key" -key1 = "Secret Key" +[[silverflow.credit]] + payment_method_type = "Mastercard" +[[silverflow.credit]] + payment_method_type = "Visa" +[[silverflow.debit]] + payment_method_type = "Mastercard" +[[silverflow.debit]] + payment_method_type = "Visa" +[silverflow.connector_auth.SignatureKey] +api_key="API Key" +api_secret="API Secret" +key1="Merchant Acceptor Key" +[silverflow.connector_webhook_details] +merchant_secret="Source verification key" [affirm] [affirm.connector_auth.HeaderKey] @@ -4954,3 +4965,4 @@ api_key = "API Key" [breadpay] [breadpay.connector_auth.HeaderKey] api_key = "API Key" + diff --git a/crates/connector_configs/toml/sandbox.toml b/crates/connector_configs/toml/sandbox.toml index bdd9cde57f0..e8b9894696e 100644 --- a/crates/connector_configs/toml/sandbox.toml +++ b/crates/connector_configs/toml/sandbox.toml @@ -6309,9 +6309,20 @@ payment_method_type = "Visa" api_key = "API Key" [silverflow] -[silverflow.connector_auth.BodyKey] -api_key = "API Key" -key1 = "Secret Key" +[[silverflow.credit]] + payment_method_type = "Mastercard" +[[silverflow.credit]] + payment_method_type = "Visa" +[[silverflow.debit]] + payment_method_type = "Mastercard" +[[silverflow.debit]] + payment_method_type = "Visa" +[silverflow.connector_auth.SignatureKey] +api_key="API Key" +api_secret="API Secret" +key1="Merchant Acceptor Key" +[silverflow.connector_webhook_details] +merchant_secret="Source verification key" [affirm] [affirm.connector_auth.HeaderKey] @@ -6324,3 +6335,4 @@ api_key = "API Key" [breadpay] [breadpay.connector_auth.HeaderKey] api_key = "API Key" + diff --git a/crates/hyperswitch_connectors/src/connectors/silverflow.rs b/crates/hyperswitch_connectors/src/connectors/silverflow.rs index 7042380d9e0..ac1db77b4db 100644 --- a/crates/hyperswitch_connectors/src/connectors/silverflow.rs +++ b/crates/hyperswitch_connectors/src/connectors/silverflow.rs @@ -2,16 +2,16 @@ pub mod transformers; use std::sync::LazyLock; -use common_enums::enums; +use base64::Engine; +use common_enums::{enums, CardNetwork}; use common_utils::{ + crypto, errors::CustomResult, - ext_traits::BytesExt, + ext_traits::{BytesExt, StringExt}, request::{Method, Request, RequestBuilder, RequestContent}, - types::{AmountConvertor, StringMinorUnit, StringMinorUnitForConnector}, }; -use error_stack::{report, ResultExt}; +use error_stack::ResultExt; use hyperswitch_domain_models::{ - payment_method_data::PaymentMethodData, router_data::{AccessToken, ConnectorAuthType, ErrorResponse, RouterData}, router_flow_types::{ access_token_auth::AccessTokenAuth, @@ -24,7 +24,8 @@ use hyperswitch_domain_models::{ RefundsData, SetupMandateRequestData, }, router_response_types::{ - ConnectorInfo, PaymentsResponseData, RefundsResponseData, SupportedPaymentMethods, + ConnectorInfo, PaymentMethodDetails, PaymentsResponseData, RefundsResponseData, + SupportedPaymentMethods, SupportedPaymentMethodsExt, }, types::{ PaymentsAuthorizeRouterData, PaymentsCaptureRouterData, PaymentsSyncRouterData, @@ -48,15 +49,11 @@ use transformers as silverflow; use crate::{constants::headers, types::ResponseRouterData, utils}; #[derive(Clone)] -pub struct Silverflow { - amount_converter: &'static (dyn AmountConvertor<Output = StringMinorUnit> + Sync), -} +pub struct Silverflow; impl Silverflow { pub fn new() -> &'static Self { - &Self { - amount_converter: &StringMinorUnitForConnector, - } + &Self } } @@ -76,7 +73,83 @@ impl api::PaymentToken for Silverflow {} impl ConnectorIntegration<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData> for Silverflow { - // Not Implemented (R) + fn get_headers( + &self, + req: &RouterData<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData>, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &RouterData<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData>, + connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Ok(format!("{}/processorTokens", self.base_url(connectors))) + } + + fn get_request_body( + &self, + req: &RouterData<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData>, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + // Create a simplified tokenization request directly from the tokenization data + let connector_req = silverflow::SilverflowTokenizationRequest::try_from(req)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &RouterData<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData>, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::TokenizationType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::TokenizationType::get_headers(self, req, connectors)?) + .set_body(types::TokenizationType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &RouterData<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData>, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult< + RouterData<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData>, + errors::ConnectorError, + > { + let response: silverflow::SilverflowTokenizationResponse = res + .response + .parse_struct("Silverflow TokenizationResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } } impl<Flow, Request, Response> ConnectorCommonExt<Flow, Request, Response> for Silverflow @@ -88,10 +161,31 @@ where req: &RouterData<Flow, Request, Response>, _connectors: &Connectors, ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { - let mut header = vec![( - headers::CONTENT_TYPE.to_string(), - self.get_content_type().to_string().into(), - )]; + let mut header = vec![ + ( + headers::CONTENT_TYPE.to_string(), + self.get_content_type().to_string().into(), + ), + ( + headers::ACCEPT.to_string(), + "application/json".to_string().into(), + ), + ]; + + // Add Idempotency-Key for POST requests (Authorize, Capture, Execute, PaymentMethodToken, Void) + let flow_type = std::any::type_name::<Flow>(); + if flow_type.contains("Authorize") + \|\| flow_type.contains("Capture") + \|\| flow_type.contains("Execute") + \|\| flow_type.contains("PaymentMethodToken") + \|\| flow_type.contains("Void") + { + header.push(( + "Idempotency-Key".to_string(), + format!("hs_{}", req.payment_id).into(), + )); + } + let mut api_key = self.get_auth_header(&req.connector_auth_type)?; header.append(&mut api_key); Ok(header) @@ -104,11 +198,8 @@ impl ConnectorCommon for Silverflow { } fn get_currency_unit(&self) -> api::CurrencyUnit { - // todo!() + // Silverflow processes amounts in minor units (cents) api::CurrencyUnit::Minor - // TODO! Check connector documentation, on which unit they are processing the currency. - // If the connector accepts amount in lower unit ( i.e cents for USD) then return api::CurrencyUnit::Minor, - // if connector accepts amount in base unit (i.e dollars for USD) then return api::CurrencyUnit::Base } fn common_get_content_type(&self) -> &'static str { @@ -125,9 +216,11 @@ impl ConnectorCommon for Silverflow { ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { let auth = silverflow::SilverflowAuthType::try_from(auth_type) .change_context(errors::ConnectorError::FailedToObtainAuthType)?; + let auth_string = format!("{}:{}", auth.api_key.expose(), auth.api_secret.expose()); + let encoded = common_utils::consts::BASE64_ENGINE.encode(auth_string.as_bytes()); Ok(vec![( headers::AUTHORIZATION.to_string(), - auth.api_key.expose().into_masked(), + format!("Basic {encoded}").into_masked(), )]) } @@ -146,42 +239,39 @@ impl ConnectorCommon for Silverflow { Ok(ErrorResponse { status_code: res.status_code, - code: response.code, - message: response.message, - reason: response.reason, + code: response.error.code, + message: response.error.message, + reason: response + .error + .details + .map(\|d\| format!("Field: {}, Issue: {}", d.field, d.issue)), attempt_status: None, connector_transaction_id: None, - network_advice_code: None, network_decline_code: None, + network_advice_code: None, network_error_message: None, }) } } impl ConnectorValidation for Silverflow { - fn validate_mandate_payment( + fn validate_connector_against_payment_request( &self, - _pm_type: Option<enums::PaymentMethodType>, - pm_data: PaymentMethodData, + capture_method: Option<enums::CaptureMethod>, + _payment_method: enums::PaymentMethod, + _pmt: Option<enums::PaymentMethodType>, ) -> CustomResult<(), errors::ConnectorError> { - match pm_data { - PaymentMethodData::Card(_) => Err(errors::ConnectorError::NotImplemented( - "validate_mandate_payment does not support cards".to_string(), - ) - .into()), - _ => Ok(()), + let capture_method = capture_method.unwrap_or_default(); + match capture_method { + enums::CaptureMethod::Automatic \| enums::CaptureMethod::Manual => Ok(()), + enums::CaptureMethod::ManualMultiple \| enums::CaptureMethod::Scheduled => Err( + utils::construct_not_implemented_error_report(capture_method, self.id()), + ), + enums::CaptureMethod::SequentialAutomatic => Err( + utils::construct_not_implemented_error_report(capture_method, self.id()), + ), } } - - fn validate_psync_reference_id( - &self, - _data: &PaymentsSyncData, - _is_three_ds: bool, - _status: enums::AttemptStatus, - _connector_meta_data: Option<common_utils::pii::SecretSerdeValue>, - ) -> CustomResult<(), errors::ConnectorError> { - Ok(()) - } } impl ConnectorIntegration<Session, PaymentsSessionData, PaymentsResponseData> for Silverflow { @@ -211,9 +301,9 @@ impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData fn get_url( &self, _req: &PaymentsAuthorizeRouterData, - _connectors: &Connectors, + connectors: &Connectors, ) -> CustomResult<String, errors::ConnectorError> { - Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + Ok(format!("{}/charges", self.base_url(connectors))) } fn get_request_body( @@ -221,13 +311,8 @@ impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData req: &PaymentsAuthorizeRouterData, _connectors: &Connectors, ) -> CustomResult<RequestContent, errors::ConnectorError> { - let amount = utils::convert_amount( - self.amount_converter, - req.request.minor_amount, - req.request.currency, - )?; - - let connector_router_data = silverflow::SilverflowRouterData::from((amount, req)); + let connector_router_data = + silverflow::SilverflowRouterData::from((req.request.minor_amount, req)); let connector_req = silverflow::SilverflowPaymentsRequest::try_from(&connector_router_data)?; Ok(RequestContent::Json(Box::new(connector_req))) @@ -298,10 +383,21 @@ impl ConnectorIntegration<PSync, PaymentsSyncData, PaymentsResponseData> for Sil fn get_url( &self, - _req: &PaymentsSyncRouterData, - _connectors: &Connectors, + req: &PaymentsSyncRouterData, + connectors: &Connectors, ) -> CustomResult<String, errors::ConnectorError> { - Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + let connector_payment_id = req + .request + .connector_transaction_id + .get_connector_transaction_id() + .change_context(errors::ConnectorError::MissingRequiredField { + field_name: "connector_transaction_id for payment sync", + })?; + Ok(format!( + "{}/charges/{}", + self.base_url(connectors), + connector_payment_id + )) } fn build_request( @@ -362,18 +458,24 @@ impl ConnectorIntegration<Capture, PaymentsCaptureData, PaymentsResponseData> fo fn get_url( &self, - _req: &PaymentsCaptureRouterData, - _connectors: &Connectors, + req: &PaymentsCaptureRouterData, + connectors: &Connectors, ) -> CustomResult<String, errors::ConnectorError> { - Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + let connector_payment_id = &req.request.connector_transaction_id; + Ok(format!( + "{}/charges/{}/clear", + self.base_url(connectors), + connector_payment_id + )) } fn get_request_body( &self, - _req: &PaymentsCaptureRouterData, + req: &PaymentsCaptureRouterData, _connectors: &Connectors, ) -> CustomResult<RequestContent, errors::ConnectorError> { - Err(errors::ConnectorError::NotImplemented("get_request_body method".to_string()).into()) + let connector_req = silverflow::SilverflowCaptureRequest::try_from(req)?; + Ok(RequestContent::Json(Box::new(connector_req))) } fn build_request( @@ -402,7 +504,7 @@ impl ConnectorIntegration<Capture, PaymentsCaptureData, PaymentsResponseData> fo event_builder: Option<&mut ConnectorEvent>, res: Response, ) -> CustomResult<PaymentsCaptureRouterData, errors::ConnectorError> { - let response: silverflow::SilverflowPaymentsResponse = res + let response: silverflow::SilverflowCaptureResponse = res .response .parse_struct("Silverflow PaymentsCaptureResponse") .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; @@ -424,7 +526,89 @@ impl ConnectorIntegration<Capture, PaymentsCaptureData, PaymentsResponseData> fo } } -impl ConnectorIntegration<Void, PaymentsCancelData, PaymentsResponseData> for Silverflow {} +impl ConnectorIntegration<Void, PaymentsCancelData, PaymentsResponseData> for Silverflow { + fn get_headers( + &self, + req: &RouterData<Void, PaymentsCancelData, PaymentsResponseData>, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + req: &RouterData<Void, PaymentsCancelData, PaymentsResponseData>, + connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + let connector_payment_id = &req.request.connector_transaction_id; + Ok(format!( + "{}/charges/{}/reverse", + self.base_url(connectors), + connector_payment_id + )) + } + + fn get_request_body( + &self, + req: &RouterData<Void, PaymentsCancelData, PaymentsResponseData>, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let connector_req = silverflow::SilverflowVoidRequest::try_from(req)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &RouterData<Void, PaymentsCancelData, PaymentsResponseData>, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::PaymentsVoidType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::PaymentsVoidType::get_headers(self, req, connectors)?) + .set_body(types::PaymentsVoidType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &RouterData<Void, PaymentsCancelData, PaymentsResponseData>, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult< + RouterData<Void, PaymentsCancelData, PaymentsResponseData>, + errors::ConnectorError, + > { + let response: silverflow::SilverflowVoidResponse = res + .response + .parse_struct("Silverflow PaymentsVoidResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} impl ConnectorIntegration<Execute, RefundsData, RefundsResponseData> for Silverflow { fn get_headers( @@ -441,10 +625,15 @@ impl ConnectorIntegration<Execute, RefundsData, RefundsResponseData> for Silverf fn get_url( &self, - _req: &RefundsRouterData<Execute>, - _connectors: &Connectors, + req: &RefundsRouterData<Execute>, + connectors: &Connectors, ) -> CustomResult<String, errors::ConnectorError> { - Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + let connector_payment_id = &req.request.connector_transaction_id; + Ok(format!( + "{}/charges/{}/refund", + self.base_url(connectors), + connector_payment_id + )) } fn get_request_body( @@ -452,13 +641,8 @@ impl ConnectorIntegration<Execute, RefundsData, RefundsResponseData> for Silverf req: &RefundsRouterData<Execute>, _connectors: &Connectors, ) -> CustomResult<RequestContent, errors::ConnectorError> { - let refund_amount = utils::convert_amount( - self.amount_converter, - req.request.minor_refund_amount, - req.request.currency, - )?; - - let connector_router_data = silverflow::SilverflowRouterData::from((refund_amount, req)); + let connector_router_data = + silverflow::SilverflowRouterData::from((req.request.minor_refund_amount, req)); let connector_req = silverflow::SilverflowRefundRequest::try_from(&connector_router_data)?; Ok(RequestContent::Json(Box::new(connector_req))) } @@ -525,10 +709,19 @@ impl ConnectorIntegration<RSync, RefundsData, RefundsResponseData> for Silverflo fn get_url( &self, - _req: &RefundSyncRouterData, - _connectors: &Connectors, + req: &RefundSyncRouterData, + connectors: &Connectors, ) -> CustomResult<String, errors::ConnectorError> { - Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + // According to Silverflow API documentation, refunds are actions on charges + // Endpoint: GET /charges/{chargeKey}/actions/{actionKey} + let charge_key = &req.request.connector_transaction_id; + let action_key = &req.request.refund_id; + Ok(format!( + "{}/charges/{}/actions/{}", + self.base_url(connectors), + charge_key, + action_key + )) } fn build_request( @@ -581,36 +774,195 @@ impl ConnectorIntegration<RSync, RefundsData, RefundsResponseData> for Silverflo impl webhooks::IncomingWebhook for Silverflow { fn get_webhook_object_reference_id( &self, - _request: &webhooks::IncomingWebhookRequestDetails<'_>, + request: &webhooks::IncomingWebhookRequestDetails<'_>, ) -> CustomResult<api_models::webhooks::ObjectReferenceId, errors::ConnectorError> { - Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + let webhook_body = String::from_utf8(request.body.to_vec()) + .change_context(errors::ConnectorError::WebhookReferenceIdNotFound)?; + + let webhook_event: silverflow::SilverflowWebhookEvent = webhook_body + .parse_struct("SilverflowWebhookEvent") + .change_context(errors::ConnectorError::WebhookReferenceIdNotFound)?; + + // For payments, use charge_key; for refunds, use refund_key + if let Some(charge_key) = webhook_event.event_data.charge_key { + Ok(api_models::webhooks::ObjectReferenceId::PaymentId( + api_models::payments::PaymentIdType::ConnectorTransactionId(charge_key), + )) + } else if let Some(refund_key) = webhook_event.event_data.refund_key { + Ok(api_models::webhooks::ObjectReferenceId::RefundId( + api_models::webhooks::RefundIdType::ConnectorRefundId(refund_key), + )) + } else { + Err(errors::ConnectorError::WebhookReferenceIdNotFound.into()) + } } fn get_webhook_event_type( &self, - _request: &webhooks::IncomingWebhookRequestDetails<'_>, + request: &webhooks::IncomingWebhookRequestDetails<'_>, ) -> CustomResult<api_models::webhooks::IncomingWebhookEvent, errors::ConnectorError> { - Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + let webhook_body = String::from_utf8(request.body.to_vec()) + .change_context(errors::ConnectorError::WebhookEventTypeNotFound)?; + + let webhook_event: silverflow::SilverflowWebhookEvent = webhook_body + .parse_struct("SilverflowWebhookEvent") + .change_context(errors::ConnectorError::WebhookEventTypeNotFound)?; + + match webhook_event.event_type.as_str() { + "charge.authorization.succeeded" => { + // Handle manual capture flow: check if clearing is still pending + if let Some(status) = webhook_event.event_data.status { + match (&status.authorization, &status.clearing) { + ( + silverflow::SilverflowAuthorizationStatus::Approved, + silverflow::SilverflowClearingStatus::Pending, + ) => { + // Manual capture: authorization succeeded, but clearing is pending + Ok(api_models::webhooks::IncomingWebhookEvent::PaymentIntentAuthorizationSuccess) + } + ( + silverflow::SilverflowAuthorizationStatus::Approved, + silverflow::SilverflowClearingStatus::Cleared, + ) => { + // Automatic capture: authorization and clearing both completed + Ok(api_models::webhooks::IncomingWebhookEvent::PaymentIntentSuccess) + } + _ => { + // Fallback for other authorization states + Ok(api_models::webhooks::IncomingWebhookEvent::PaymentIntentAuthorizationSuccess) + } + } + } else { + // Fallback when status is not available + Ok(api_models::webhooks::IncomingWebhookEvent::PaymentIntentAuthorizationSuccess) + } + } + "charge.authorization.failed" => { + Ok(api_models::webhooks::IncomingWebhookEvent::PaymentIntentFailure) + } + "charge.clearing.succeeded" => { + Ok(api_models::webhooks::IncomingWebhookEvent::PaymentIntentSuccess) + } + "charge.clearing.failed" => { + Ok(api_models::webhooks::IncomingWebhookEvent::PaymentIntentFailure) + } + "refund.succeeded" => Ok(api_models::webhooks::IncomingWebhookEvent::RefundSuccess), + "refund.failed" => Ok(api_models::webhooks::IncomingWebhookEvent::RefundFailure), + _ => Ok(api_models::webhooks::IncomingWebhookEvent::EventNotSupported), + } } fn get_webhook_resource_object( &self, - _request: &webhooks::IncomingWebhookRequestDetails<'_>, + request: &webhooks::IncomingWebhookRequestDetails<'_>, ) -> CustomResult<Box<dyn masking::ErasedMaskSerialize>, errors::ConnectorError> { - Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + let webhook_body = String::from_utf8(request.body.to_vec()) + .change_context(errors::ConnectorError::WebhookResourceObjectNotFound)?; + + let webhook_event: silverflow::SilverflowWebhookEvent = webhook_body + .parse_struct("SilverflowWebhookEvent") + .change_context(errors::ConnectorError::WebhookResourceObjectNotFound)?; + + Ok(Box::new(webhook_event)) + } + + fn get_webhook_source_verification_algorithm( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<Box<dyn crypto::VerifySignature + Send>, errors::ConnectorError> { + Ok(Box::new(crypto::HmacSha256)) + } + + fn get_webhook_source_verification_signature( + &self, + request: &webhooks::IncomingWebhookRequestDetails<'_>, + _connector_webhook_secrets: &api_models::webhooks::ConnectorWebhookSecrets, + ) -> CustomResult<Vec<u8>, errors::ConnectorError> { + let signature = request + .headers + .get("X-Silverflow-Signature") + .ok_or(errors::ConnectorError::WebhookSignatureNotFound)? + .to_str() + .change_context(errors::ConnectorError::WebhookSignatureNotFound)?; + + hex::decode(signature).change_context(errors::ConnectorError::WebhookSignatureNotFound) + } + + fn get_webhook_source_verification_message( + &self, + request: &webhooks::IncomingWebhookRequestDetails<'_>, + _merchant_id: &common_utils::id_type::MerchantId, + _connector_webhook_secrets: &api_models::webhooks::ConnectorWebhookSecrets, + ) -> CustomResult<Vec<u8>, errors::ConnectorError> { + Ok(request.body.to_vec()) } } static SILVERFLOW_SUPPORTED_PAYMENT_METHODS: LazyLock<SupportedPaymentMethods> = - LazyLock::new(SupportedPaymentMethods::new); + LazyLock::new(\|\| { + let supported_capture_methods = vec![ + enums::CaptureMethod::Automatic, + enums::CaptureMethod::Manual, + ]; + + let supported_card_networks = vec![ + CardNetwork::Visa, + CardNetwork::Mastercard, + CardNetwork::AmericanExpress, + CardNetwork::Discover, + ]; + + let mut silverflow_supported_payment_methods = SupportedPaymentMethods::new(); + + silverflow_supported_payment_methods.add( + enums::PaymentMethod::Card, + enums::PaymentMethodType::Credit, + PaymentMethodDetails { + mandates: enums::FeatureStatus::NotSupported, + refunds: enums::FeatureStatus::Supported, + supported_capture_methods: supported_capture_methods.clone(), + specific_features: Some( + api_models::feature_matrix::PaymentMethodSpecificFeatures::Card({ + api_models::feature_matrix::CardSpecificFeatures { + three_ds: common_enums::FeatureStatus::NotSupported, + no_three_ds: common_enums::FeatureStatus::Supported, + supported_card_networks: supported_card_networks.clone(), + } + }), + ), + }, + ); + + silverflow_supported_payment_methods.add( + enums::PaymentMethod::Card, + enums::PaymentMethodType::Debit, + PaymentMethodDetails { + mandates: enums::FeatureStatus::NotSupported, + refunds: enums::FeatureStatus::Supported, + supported_capture_methods: supported_capture_methods.clone(), + specific_features: Some( + api_models::feature_matrix::PaymentMethodSpecificFeatures::Card({ + api_models::feature_matrix::CardSpecificFeatures { + three_ds: common_enums::FeatureStatus::NotSupported, + no_three_ds: common_enums::FeatureStatus::Supported, + supported_card_networks: supported_card_networks.clone(), + } + }), + ), + }, + ); + + silverflow_supported_payment_methods + }); static SILVERFLOW_CONNECTOR_INFO: ConnectorInfo = ConnectorInfo { display_name: "Silverflow", - description: "Silverflow connector", + description: "Silverflow is a global payment processor that provides secure and reliable payment processing services with support for multiple capture methods and 3DS authentication.", connector_type: enums::PaymentConnectorCategory::PaymentGateway, }; -static SILVERFLOW_SUPPORTED_WEBHOOK_FLOWS: [enums::EventClass; 0] = []; +static SILVERFLOW_SUPPORTED_WEBHOOK_FLOWS: [enums::EventClass; 2] = + [enums::EventClass::Payments, enums::EventClass::Refunds]; impl ConnectorSpecifications for Silverflow { fn get_connector_about(&self) -> Option<&'static ConnectorInfo> { diff --git a/crates/hyperswitch_connectors/src/connectors/silverflow/transformers.rs b/crates/hyperswitch_connectors/src/connectors/silverflow/transformers.rs index 8a1bb52a5bb..87a99417dd6 100644 --- a/crates/hyperswitch_connectors/src/connectors/silverflow/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/silverflow/transformers.rs @@ -1,27 +1,33 @@ use common_enums::enums; -use common_utils::types::StringMinorUnit; +use common_utils::types::MinorUnit; use hyperswitch_domain_models::{ payment_method_data::PaymentMethodData, router_data::{ConnectorAuthType, RouterData}, - router_flow_types::refunds::{Execute, RSync}, - router_request_types::ResponseId, + router_flow_types::{ + payments::Void, + refunds::{Execute, RSync}, + }, + router_request_types::{PaymentsCancelData, ResponseId}, router_response_types::{PaymentsResponseData, RefundsResponseData}, - types::{PaymentsAuthorizeRouterData, RefundsRouterData}, + types::{PaymentsAuthorizeRouterData, PaymentsCaptureRouterData, RefundsRouterData}, }; use hyperswitch_interfaces::errors; -use masking::Secret; +use masking::{ExposeInterface, PeekInterface, Secret}; use serde::{Deserialize, Serialize}; -use crate::types::{RefundsResponseRouterData, ResponseRouterData}; +use crate::{ + types::{RefundsResponseRouterData, ResponseRouterData}, + utils::CardData, +}; //TODO: Fill the struct with respective fields pub struct SilverflowRouterData<T> { - pub amount: StringMinorUnit, // The type of amount that a connector accepts, for example, String, i64, f64, etc. + pub amount: MinorUnit, // The type of amount that a connector accepts, for example, String, i64, f64, etc. pub router_data: T, } -impl<T> From<(StringMinorUnit, T)> for SilverflowRouterData<T> { - fn from((amount, item): (StringMinorUnit, T)) -> Self { +impl<T> From<(MinorUnit, T)> for SilverflowRouterData<T> { + fn from((amount, item): (MinorUnit, T)) -> Self { //Todo : use utils to convert the amount to the type of amount that a connector accepts Self { amount, @@ -30,20 +36,45 @@ impl<T> From<(StringMinorUnit, T)> for SilverflowRouterData<T> { } } -//TODO: Fill the struct with respective fields -#[derive(Default, Debug, Serialize, PartialEq)] -pub struct SilverflowPaymentsRequest { - amount: StringMinorUnit, - card: SilverflowCard, +// Basic structures for Silverflow API +#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] +pub struct Amount { + value: MinorUnit, + currency: String, } -#[derive(Default, Debug, Serialize, Eq, PartialEq)] -pub struct SilverflowCard { +#[derive(Default, Debug, Serialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct Card { number: cards::CardNumber, expiry_month: Secret<String>, expiry_year: Secret<String>, cvc: Secret<String>, - complete: bool, + holder_name: Option<Secret<String>>, +} + +#[derive(Default, Debug, Serialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct MerchantAcceptorResolver { + merchant_acceptor_key: String, +} + +#[derive(Default, Debug, Serialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct SilverflowPaymentsRequest { + merchant_acceptor_resolver: MerchantAcceptorResolver, + card: Card, + amount: Amount, + #[serde(rename = "type")] + payment_type: PaymentType, +} + +#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct PaymentType { + intent: String, + card_entry: String, + order: String, } impl TryFrom<&SilverflowRouterData<&PaymentsAuthorizeRouterData>> for SilverflowPaymentsRequest { @@ -52,58 +83,184 @@ impl TryFrom<&SilverflowRouterData<&PaymentsAuthorizeRouterData>> for Silverflow item: &SilverflowRouterData<&PaymentsAuthorizeRouterData>, ) -> Result<Self, Self::Error> { match item.router_data.request.payment_method_data.clone() { - PaymentMethodData::Card(_) => Err(errors::ConnectorError::NotImplemented( - "Card payment method not implemented".to_string(), - ) - .into()), + PaymentMethodData::Card(req_card) => { + // Extract merchant acceptor key from connector auth + let auth = SilverflowAuthType::try_from(&item.router_data.connector_auth_type)?; + + let card = Card { + number: req_card.card_number.clone(), + expiry_month: req_card.card_exp_month.clone(), + expiry_year: req_card.card_exp_year.clone(), + cvc: req_card.card_cvc.clone(), + holder_name: req_card.get_cardholder_name().ok(), + }; + + Ok(Self { + merchant_acceptor_resolver: MerchantAcceptorResolver { + merchant_acceptor_key: auth.merchant_acceptor_key.expose(), + }, + card, + amount: Amount { + value: item.amount, + currency: item.router_data.request.currency.to_string(), + }, + payment_type: PaymentType { + intent: "purchase".to_string(), + card_entry: "e-commerce".to_string(), + order: "checkout".to_string(), + }, + }) + } _ => Err(errors::ConnectorError::NotImplemented("Payment method".to_string()).into()), } } } -//TODO: Fill the struct with respective fields -// Auth Struct +// Auth Struct for HTTP Basic Authentication pub struct SilverflowAuthType { pub(super) api_key: Secret<String>, + pub(super) api_secret: Secret<String>, + pub(super) merchant_acceptor_key: Secret<String>, } impl TryFrom<&ConnectorAuthType> for SilverflowAuthType { 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(), + ConnectorAuthType::SignatureKey { + api_key, + key1, + api_secret, + } => Ok(Self { + api_key: api_key.clone(), + api_secret: api_secret.clone(), + merchant_acceptor_key: key1.clone(), }), _ => Err(errors::ConnectorError::FailedToObtainAuthType.into()), } } } -// PaymentsResponse -//TODO: Append the remaining status flags -#[derive(Debug, Clone, Copy, Default, Serialize, Deserialize, PartialEq)] +// Enum for Silverflow payment authorization status +#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] #[serde(rename_all = "lowercase")] -pub enum SilverflowPaymentStatus { - Succeeded, +pub enum SilverflowAuthorizationStatus { + Approved, + Declined, Failed, #[default] - Processing, + Pending, } -impl From<SilverflowPaymentStatus> for common_enums::AttemptStatus { - fn from(item: SilverflowPaymentStatus) -> Self { - match item { - SilverflowPaymentStatus::Succeeded => Self::Charged, - SilverflowPaymentStatus::Failed => Self::Failure, - SilverflowPaymentStatus::Processing => Self::Authorizing, - } - } +// Enum for Silverflow payment clearing status +#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "lowercase")] +pub enum SilverflowClearingStatus { + Cleared, + #[default] + Pending, + Failed, +} + +// Payment Authorization Response Structures +#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] +pub struct PaymentStatus { + pub authentication: String, + pub authorization: SilverflowAuthorizationStatus, + pub clearing: SilverflowClearingStatus, +} + +#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] +pub struct MerchantAcceptorRef { + pub key: String, + pub version: i32, +} + +#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct CardResponse { + pub masked_number: String, +} + +#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] +pub struct Authentication { + pub sca: SCA, + pub cvc: Secret<String>, + pub avs: String, } -//TODO: Fill the struct with respective fields #[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct SCA { + pub compliance: String, + pub compliance_reason: String, + pub method: String, + #[serde(skip_serializing_if = "Option::is_none")] + pub result: Option<SCAResult>, +} + +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct SCAResult { + pub version: String, + pub directory_server_trans_id: String, +} + +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct AuthorizationIsoFields { + pub response_code: String, + pub response_code_description: String, + pub authorization_code: String, + pub network_code: String, + pub system_trace_audit_number: Secret<String>, + pub retrieval_reference_number: String, + pub eci: String, + pub network_specific_fields: NetworkSpecificFields, +} + +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct NetworkSpecificFields { + pub transaction_identifier: String, + pub cvv2_result_code: String, +} + +#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] pub struct SilverflowPaymentsResponse { - status: SilverflowPaymentStatus, - id: String, + pub key: String, + pub merchant_acceptor_ref: MerchantAcceptorRef, + pub card: CardResponse, + pub amount: Amount, + #[serde(rename = "type")] + pub payment_type: PaymentType, + pub clearing_mode: String, + pub status: PaymentStatus, + pub authentication: Authentication, + pub local_transaction_date_time: String, + pub fraud_liability: String, + pub authorization_iso_fields: Option<AuthorizationIsoFields>, + pub created: String, + pub version: i32, +} + +impl From<&PaymentStatus> for common_enums::AttemptStatus { + fn from(status: &PaymentStatus) -> Self { + match (&status.authorization, &status.clearing) { + (SilverflowAuthorizationStatus::Approved, SilverflowClearingStatus::Cleared) => { + Self::Charged + } + (SilverflowAuthorizationStatus::Approved, SilverflowClearingStatus::Pending) => { + Self::Authorized + } + (SilverflowAuthorizationStatus::Approved, SilverflowClearingStatus::Failed) => { + Self::Failure + } + (SilverflowAuthorizationStatus::Declined, _) => Self::Failure, + (SilverflowAuthorizationStatus::Failed, _) => Self::Failure, + (SilverflowAuthorizationStatus::Pending, _) => Self::Pending, + } + } } impl<F, T> TryFrom<ResponseRouterData<F, SilverflowPaymentsResponse, T, PaymentsResponseData>> @@ -114,15 +271,207 @@ impl<F, T> TryFrom<ResponseRouterData<F, SilverflowPaymentsResponse, T, Payments item: ResponseRouterData<F, SilverflowPaymentsResponse, T, PaymentsResponseData>, ) -> Result<Self, Self::Error> { Ok(Self { - status: common_enums::AttemptStatus::from(item.response.status), + status: common_enums::AttemptStatus::from(&item.response.status), response: Ok(PaymentsResponseData::TransactionResponse { - resource_id: ResponseId::ConnectorTransactionId(item.response.id), + resource_id: ResponseId::ConnectorTransactionId(item.response.key.clone()), + redirection_data: Box::new(None), + mandate_reference: Box::new(None), + connector_metadata: None, + network_txn_id: item + .response + .authorization_iso_fields + .as_ref() + .map(\|fields\| { + fields + .network_specific_fields + .transaction_identifier + .clone() + }), + connector_response_reference_id: Some(item.response.key.clone()), + incremental_authorization_allowed: Some(false), + charges: None, + }), + ..item.data + }) + } +} + +// CAPTURE: +// Type definition for CaptureRequest based on Silverflow API documentation +#[derive(Default, Debug, Serialize)] +#[serde(rename_all = "camelCase")] +pub struct SilverflowCaptureRequest { + #[serde(skip_serializing_if = "Option::is_none")] + pub amount: Option<i64>, + #[serde(skip_serializing_if = "Option::is_none")] + pub close_charge: Option<bool>, + #[serde(skip_serializing_if = "Option::is_none")] + pub reference: Option<String>, +} + +impl TryFrom<&PaymentsCaptureRouterData> for SilverflowCaptureRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from(item: &PaymentsCaptureRouterData) -> Result<Self, Self::Error> { + // amount_to_capture is directly an i64, representing the amount in minor units + let amount_to_capture = Some(item.request.amount_to_capture); + + Ok(Self { + amount: amount_to_capture, + close_charge: Some(true), // Default to closing charge after capture + reference: Some(format!("capture-{}", item.payment_id)), + }) + } +} + +// Enum for Silverflow capture status +#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "lowercase")] +pub enum SilverflowCaptureStatus { + Completed, + #[default] + Pending, + Failed, +} + +// Type definition for CaptureResponse based on Silverflow clearing action response +#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct SilverflowCaptureResponse { + #[serde(rename = "type")] + pub action_type: String, + pub key: String, + pub charge_key: String, + pub status: SilverflowCaptureStatus, + #[serde(skip_serializing_if = "Option::is_none")] + pub reference: Option<String>, + pub amount: Amount, + pub created: String, + pub last_modified: String, + pub version: i32, +} + +impl From<&SilverflowCaptureResponse> for common_enums::AttemptStatus { + fn from(response: &SilverflowCaptureResponse) -> Self { + match response.status { + SilverflowCaptureStatus::Completed => Self::Charged, + SilverflowCaptureStatus::Pending => Self::Pending, + SilverflowCaptureStatus::Failed => Self::Failure, + } + } +} + +impl<F, T> TryFrom<ResponseRouterData<F, SilverflowCaptureResponse, T, PaymentsResponseData>> + for RouterData<F, T, PaymentsResponseData> +{ + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: ResponseRouterData<F, SilverflowCaptureResponse, T, PaymentsResponseData>, + ) -> Result<Self, Self::Error> { + Ok(Self { + status: common_enums::AttemptStatus::from(&item.response), + response: Ok(PaymentsResponseData::TransactionResponse { + resource_id: ResponseId::ConnectorTransactionId(item.response.charge_key.clone()), redirection_data: Box::new(None), mandate_reference: Box::new(None), connector_metadata: None, network_txn_id: None, - connector_response_reference_id: None, - incremental_authorization_allowed: None, + connector_response_reference_id: Some(item.response.key.clone()), + incremental_authorization_allowed: Some(false), + charges: None, + }), + ..item.data + }) + } +} + +// VOID/REVERSE: +// Type definition for Reverse Charge Request based on Silverflow API documentation +#[derive(Default, Debug, Serialize)] +#[serde(rename_all = "camelCase")] +pub struct SilverflowVoidRequest { + #[serde(skip_serializing_if = "Option::is_none")] + pub replacement_amount: Option<i64>, + #[serde(skip_serializing_if = "Option::is_none")] + pub reference: Option<String>, +} + +impl TryFrom<&RouterData<Void, PaymentsCancelData, PaymentsResponseData>> + for SilverflowVoidRequest +{ + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: &RouterData<Void, PaymentsCancelData, PaymentsResponseData>, + ) -> Result<Self, Self::Error> { + Ok(Self { + replacement_amount: Some(0), // Default to 0 for full reversal + reference: Some(format!("void-{}", item.payment_id)), + }) + } +} + +// Enum for Silverflow void authorization status +#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "lowercase")] +pub enum SilverflowVoidAuthorizationStatus { + Approved, + Declined, + Failed, + #[default] + Pending, +} + +// Type definition for Void Status (only authorization, no clearing) +#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] +pub struct VoidStatus { + pub authorization: SilverflowVoidAuthorizationStatus, +} + +// Type definition for Reverse Charge Response based on Silverflow API documentation +#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct SilverflowVoidResponse { + #[serde(rename = "type")] + pub action_type: String, + pub key: String, + pub charge_key: String, + #[serde(skip_serializing_if = "Option::is_none")] + pub reference: Option<String>, + pub replacement_amount: Amount, + pub status: VoidStatus, + pub authorization_response: Option<AuthorizationResponse>, + pub created: String, + pub last_modified: String, + pub version: i32, +} + +impl From<&SilverflowVoidResponse> for common_enums::AttemptStatus { + fn from(response: &SilverflowVoidResponse) -> Self { + match response.status.authorization { + SilverflowVoidAuthorizationStatus::Approved => Self::Voided, + SilverflowVoidAuthorizationStatus::Declined + \| SilverflowVoidAuthorizationStatus::Failed => Self::VoidFailed, + SilverflowVoidAuthorizationStatus::Pending => Self::Pending, + } + } +} + +impl<F, T> TryFrom<ResponseRouterData<F, SilverflowVoidResponse, T, PaymentsResponseData>> + for RouterData<F, T, PaymentsResponseData> +{ + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: ResponseRouterData<F, SilverflowVoidResponse, T, PaymentsResponseData>, + ) -> Result<Self, Self::Error> { + Ok(Self { + status: common_enums::AttemptStatus::from(&item.response), + response: Ok(PaymentsResponseData::TransactionResponse { + resource_id: ResponseId::ConnectorTransactionId(item.response.charge_key.clone()), + redirection_data: Box::new(None), + mandate_reference: Box::new(None), + connector_metadata: None, + network_txn_id: None, + connector_response_reference_id: Some(item.response.key.clone()), + incremental_authorization_allowed: Some(false), charges: None, }), ..item.data @@ -130,50 +479,90 @@ impl<F, T> TryFrom<ResponseRouterData<F, SilverflowPaymentsResponse, T, Payments } } -//TODO: Fill the struct with respective fields // REFUND : +// Type definition for DynamicDescriptor +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct DynamicDescriptor { + pub merchant_name: String, + pub merchant_city: String, +} + // Type definition for RefundRequest #[derive(Default, Debug, Serialize)] pub struct SilverflowRefundRequest { - pub amount: StringMinorUnit, + #[serde(rename = "refundAmount")] + pub refund_amount: MinorUnit, + pub reference: String, } impl<F> TryFrom<&SilverflowRouterData<&RefundsRouterData<F>>> for SilverflowRefundRequest { type Error = error_stack::Report<errors::ConnectorError>; fn try_from(item: &SilverflowRouterData<&RefundsRouterData<F>>) -> Result<Self, Self::Error> { Ok(Self { - amount: item.amount.to_owned(), + refund_amount: item.amount, + reference: format!("refund-{}", item.router_data.request.refund_id), }) } } -// Type definition for Refund Response +// Type definition for Authorization Response +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct AuthorizationResponse { + pub network: String, + + pub response_code: String, + + pub response_code_description: String, +} -#[allow(dead_code)] -#[derive(Debug, Copy, Serialize, Default, Deserialize, Clone)] -pub enum RefundStatus { - Succeeded, +// Enum for Silverflow refund authorization status +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "lowercase")] +pub enum SilverflowRefundAuthorizationStatus { + Approved, + Declined, Failed, + Pending, +} + +// Enum for Silverflow refund status +#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "lowercase")] +pub enum SilverflowRefundStatus { + Success, + Failure, #[default] - Processing, + Pending, } -impl From<RefundStatus> for enums::RefundStatus { - fn from(item: RefundStatus) -> Self { +impl From<&SilverflowRefundStatus> for enums::RefundStatus { + fn from(item: &SilverflowRefundStatus) -> Self { match item { - RefundStatus::Succeeded => Self::Success, - RefundStatus::Failed => Self::Failure, - RefundStatus::Processing => Self::Pending, - //TODO: Review mapping + SilverflowRefundStatus::Success => Self::Success, + SilverflowRefundStatus::Failure => Self::Failure, + SilverflowRefundStatus::Pending => Self::Pending, } } } -//TODO: Fill the struct with respective fields -#[derive(Default, Debug, Clone, Serialize, Deserialize)] +// Type definition for Refund Response +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] pub struct RefundResponse { - id: String, - status: RefundStatus, + #[serde(rename = "type")] + pub action_type: String, + pub key: String, + pub charge_key: String, + pub reference: String, + pub amount: Amount, + pub status: SilverflowRefundStatus, + pub clear_after: Option<String>, + pub authorization_response: Option<AuthorizationResponse>, + pub created: String, + pub last_modified: String, + pub version: i32, } impl TryFrom<RefundsResponseRouterData<Execute, RefundResponse>> for RefundsRouterData<Execute> { @@ -183,8 +572,8 @@ impl TryFrom<RefundsResponseRouterData<Execute, RefundResponse>> for RefundsRout ) -> Result<Self, Self::Error> { Ok(Self { response: Ok(RefundsResponseData { - connector_refund_id: item.response.id.to_string(), - refund_status: enums::RefundStatus::from(item.response.status), + connector_refund_id: item.response.key.clone(), + refund_status: enums::RefundStatus::from(&item.response.status), }), ..item.data }) @@ -198,22 +587,189 @@ impl TryFrom<RefundsResponseRouterData<RSync, RefundResponse>> for RefundsRouter ) -> Result<Self, Self::Error> { Ok(Self { response: Ok(RefundsResponseData { - connector_refund_id: item.response.id.to_string(), - refund_status: enums::RefundStatus::from(item.response.status), + connector_refund_id: item.response.key.clone(), + refund_status: enums::RefundStatus::from(&item.response.status), }), ..item.data }) } } -//TODO: Fill the struct with respective fields +// TOKENIZATION: +// Type definition for TokenizationRequest +#[derive(Default, Debug, Serialize)] +#[serde(rename_all = "camelCase")] +pub struct SilverflowTokenizationRequest { + pub reference: String, + + pub card_data: SilverflowCardData, +} + +#[derive(Default, Debug, Serialize)] +#[serde(rename_all = "camelCase")] +pub struct SilverflowCardData { + pub number: String, + pub expiry_month: Secret<String>, + pub expiry_year: Secret<String>, + pub cvc: String, + pub holder_name: String, +} + +impl TryFrom<&PaymentsAuthorizeRouterData> for SilverflowTokenizationRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from(item: &PaymentsAuthorizeRouterData) -> Result<Self, Self::Error> { + match item.request.payment_method_data.clone() { + PaymentMethodData::Card(req_card) => { + let card_data = SilverflowCardData { + number: req_card.card_number.peek().to_string(), + expiry_month: req_card.card_exp_month.clone(), + expiry_year: req_card.card_exp_year.clone(), + cvc: req_card.card_cvc.clone().expose(), + holder_name: req_card + .get_cardholder_name() + .unwrap_or(Secret::new("".to_string())) + .expose(), + }; + + Ok(Self { + reference: format!("CUSTOMER_ID_{}", item.payment_id), + card_data, + }) + } + _ => Err(errors::ConnectorError::NotImplemented("Payment method".to_string()).into()), + } + } +} + +// Add TryFrom implementation for direct tokenization router data +impl + TryFrom< + &RouterData< + hyperswitch_domain_models::router_flow_types::payments::PaymentMethodToken, + hyperswitch_domain_models::router_request_types::PaymentMethodTokenizationData, + PaymentsResponseData, + >, + > for SilverflowTokenizationRequest +{ + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: &RouterData< + hyperswitch_domain_models::router_flow_types::payments::PaymentMethodToken, + hyperswitch_domain_models::router_request_types::PaymentMethodTokenizationData, + PaymentsResponseData, + >, + ) -> Result<Self, Self::Error> { + match item.request.payment_method_data.clone() { + PaymentMethodData::Card(req_card) => { + let card_data = SilverflowCardData { + number: req_card.card_number.peek().to_string(), + expiry_month: req_card.card_exp_month.clone(), + expiry_year: req_card.card_exp_year.clone(), + cvc: req_card.card_cvc.clone().expose(), + holder_name: req_card + .get_cardholder_name() + .unwrap_or(Secret::new("".to_string())) + .expose(), + }; + + Ok(Self { + reference: format!("CUSTOMER_ID_{}", item.payment_id), + card_data, + }) + } + _ => Err(errors::ConnectorError::NotImplemented("Payment method".to_string()).into()), + } + } +} + +// Type definition for TokenizationResponse +#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] +pub struct SilverflowTokenizationResponse { + pub key: String, + #[serde(rename = "agentKey")] + pub agent_key: String, + pub last4: String, + pub status: String, + pub reference: String, + #[serde(rename = "cardInfo")] + pub card_info: Vec<CardInfo>, + pub created: String, + #[serde(rename = "cvcPresent")] + pub cvc_present: bool, + pub version: i32, +} + +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +pub struct CardInfo { + #[serde(rename = "infoSource")] + pub info_source: String, + pub network: String, + #[serde(rename = "primaryNetwork")] + pub primary_network: bool, +} + +impl<F, T> TryFrom<ResponseRouterData<F, SilverflowTokenizationResponse, T, PaymentsResponseData>> + for RouterData<F, T, PaymentsResponseData> +{ + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: ResponseRouterData<F, SilverflowTokenizationResponse, T, PaymentsResponseData>, + ) -> Result<Self, Self::Error> { + Ok(Self { + response: Ok(PaymentsResponseData::TokenizationResponse { + token: item.response.key, + }), + ..item.data + }) + } +} + +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct TokenizedCardDetails { + pub masked_card_number: String, + pub expiry_month: Secret<String>, + pub expiry_year: Secret<String>, + pub card_brand: String, +} + +// WEBHOOKS: +// Type definition for Webhook Event structures +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct SilverflowWebhookEvent { + pub event_type: String, + pub event_data: SilverflowWebhookEventData, + pub event_id: String, + pub created: String, + pub version: i32, +} + +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct SilverflowWebhookEventData { + pub charge_key: Option<String>, + pub refund_key: Option<String>, + pub status: Option<PaymentStatus>, + pub amount: Option<Amount>, + pub transaction_reference: Option<String>, +} + +// Error Response Structures based on Silverflow API format +#[derive(Debug, Serialize, Deserialize, PartialEq)] +pub struct ErrorDetails { + pub field: String, + pub issue: String, +} + #[derive(Default, Debug, Serialize, Deserialize, PartialEq)] pub struct SilverflowErrorResponse { - pub status_code: u16, + pub error: SilverflowError, +} + +#[derive(Default, Debug, Serialize, Deserialize, PartialEq)] +pub struct SilverflowError { pub code: String, pub message: String, - pub reason: Option<String>, - pub network_advice_code: Option<String>, - pub network_decline_code: Option<String>, - pub network_error_message: Option<String>, + pub details: Option<ErrorDetails>, } diff --git a/crates/test_utils/src/connector_auth.rs b/crates/test_utils/src/connector_auth.rs index 1d45f8fb6ff..605be655816 100644 --- a/crates/test_utils/src/connector_auth.rs +++ b/crates/test_utils/src/connector_auth.rs @@ -101,7 +101,7 @@ pub struct ConnectorAuthentication { pub redsys: Option<HeaderKey>, pub santander: Option<BodyKey>, pub shift4: Option<HeaderKey>, - pub silverflow: Option<BodyKey>, + pub silverflow: Option<SignatureKey>, pub square: Option<BodyKey>, pub stax: Option<HeaderKey>, pub stripe: Option<HeaderKey>,	2025-07-09T14:05:09Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description Cards Non-3DS payments added for silverflow (Alpha Integration). Ref: https://www.silverflow.com/ ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> https://github.com/juspay/hyperswitch/issues/8592 ## How did you test it? Compilation and Clippy checks by cargo build and cargo clippy No cypress due to Alpha integration. ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	6214aca5f0f5c617a68f65ef5bcfd700060acccf	6214aca5f0f5c617a68f65ef5bcfd700060acccf
juspay/hyperswitch	juspay__hyperswitch-8588	Bug: refactor(dynamic_routing): make the dynamo configs optional	diff --git a/crates/external_services/src/grpc_client.rs b/crates/external_services/src/grpc_client.rs index 5a9bd6143da..1b93ac6bd89 100644 --- a/crates/external_services/src/grpc_client.rs +++ b/crates/external_services/src/grpc_client.rs @@ -35,7 +35,7 @@ pub type Client = hyper_util::client::legacy::Client<HttpConnector, Body>; pub struct GrpcClients { /// The routing client #[cfg(feature = "dynamic_routing")] - pub dynamic_routing: RoutingStrategy, + pub dynamic_routing: Option<RoutingStrategy>, /// Health Check client for all gRPC services #[cfg(feature = "dynamic_routing")] pub health_client: HealthCheckClient, @@ -47,7 +47,7 @@ pub struct GrpcClients { pub struct GrpcClientSettings { #[cfg(feature = "dynamic_routing")] /// Configs for Dynamic Routing Client - pub dynamic_routing_client: DynamicRoutingClientConfig, + pub dynamic_routing_client: Option<DynamicRoutingClientConfig>, /// Configs for Unified Connector Service client pub unified_connector_service: Option<UnifiedConnectorServiceClientConfig>, } @@ -69,9 +69,10 @@ impl GrpcClientSettings { let dynamic_routing_connection = self .dynamic_routing_client .clone() - .get_dynamic_routing_connection(client.clone()) - .await - .expect("Failed to establish a connection with the Dynamic Routing Server"); + .map(\|config\| config.get_dynamic_routing_connection(client.clone())) + .transpose() + .expect("Failed to establish a connection with the Dynamic Routing Server") + .flatten(); #[cfg(feature = "dynamic_routing")] let health_client = HealthCheckClient::build_connections(self, client) diff --git a/crates/external_services/src/grpc_client/dynamic_routing.rs b/crates/external_services/src/grpc_client/dynamic_routing.rs index a9ee7852d31..f4aeec76551 100644 --- a/crates/external_services/src/grpc_client/dynamic_routing.rs +++ b/crates/external_services/src/grpc_client/dynamic_routing.rs @@ -47,11 +47,11 @@ pub enum DynamicRoutingError { #[derive(Debug, Clone)] pub struct RoutingStrategy { /// success rate service for Dynamic Routing - pub success_rate_client: Option<SuccessRateCalculatorClient<Client>>, + pub success_rate_client: SuccessRateCalculatorClient<Client>, /// contract based routing service for Dynamic Routing - pub contract_based_client: Option<ContractScoreCalculatorClient<Client>>, + pub contract_based_client: ContractScoreCalculatorClient<Client>, /// elimination service for Dynamic Routing - pub elimination_based_client: Option<EliminationAnalyserClient<Client>>, + pub elimination_based_client: EliminationAnalyserClient<Client>, } /// Contains the Dynamic Routing Client Config @@ -74,32 +74,28 @@ pub enum DynamicRoutingClientConfig { impl DynamicRoutingClientConfig { /// establish connection with the server - pub async fn get_dynamic_routing_connection( + pub fn get_dynamic_routing_connection( self, client: Client, - ) -> Result<RoutingStrategy, Box<dyn std::error::Error>> { - let (success_rate_client, contract_based_client, elimination_based_client) = match self { + ) -> Result<Option<RoutingStrategy>, Box<dyn std::error::Error>> { + match self { Self::Enabled { host, port, .. } => { let uri = format!("http://{host}:{port}").parse::<tonic::transport::Uri>()?; logger::info!("Connection established with dynamic routing gRPC Server"); - ( - Some(SuccessRateCalculatorClient::with_origin( - client.clone(), - uri.clone(), - )), - Some(ContractScoreCalculatorClient::with_origin( - client.clone(), - uri.clone(), - )), - Some(EliminationAnalyserClient::with_origin(client, uri)), - ) + + let (success_rate_client, contract_based_client, elimination_based_client) = ( + SuccessRateCalculatorClient::with_origin(client.clone(), uri.clone()), + ContractScoreCalculatorClient::with_origin(client.clone(), uri.clone()), + EliminationAnalyserClient::with_origin(client, uri), + ); + + Ok(Some(RoutingStrategy { + success_rate_client, + contract_based_client, + elimination_based_client, + })) } - Self::Disabled => (None, None, None), - }; - Ok(RoutingStrategy { - success_rate_client, - contract_based_client, - elimination_based_client, - }) + Self::Disabled => Ok(None), + } } } diff --git a/crates/external_services/src/grpc_client/health_check_client.rs b/crates/external_services/src/grpc_client/health_check_client.rs index 94d78df7955..e0dac3a8fb9 100644 --- a/crates/external_services/src/grpc_client/health_check_client.rs +++ b/crates/external_services/src/grpc_client/health_check_client.rs @@ -53,11 +53,11 @@ impl HealthCheckClient { ) -> Result<Self, Box<dyn std::error::Error>> { let dynamic_routing_config = &config.dynamic_routing_client; let connection = match dynamic_routing_config { - DynamicRoutingClientConfig::Enabled { + Some(DynamicRoutingClientConfig::Enabled { host, port, service, - } => Some((host.clone(), port, service.clone())), + }) => Some((host.clone(), port, service.clone())), _ => None, }; @@ -81,11 +81,11 @@ impl HealthCheckClient { ) -> HealthCheckResult<HealthCheckMap> { let dynamic_routing_config = &config.dynamic_routing_client; let connection = match dynamic_routing_config { - DynamicRoutingClientConfig::Enabled { + Some(DynamicRoutingClientConfig::Enabled { host, port, service, - } => Some((host.clone(), port, service.clone())), + }) => Some((host.clone(), port, service.clone())), _ => None, }; diff --git a/crates/router/src/core/payments/routing.rs b/crates/router/src/core/payments/routing.rs index 7feea3286ca..87ed5ff40a8 100644 --- a/crates/router/src/core/payments/routing.rs +++ b/crates/router/src/core/payments/routing.rs @@ -2100,13 +2100,13 @@ where "performing success_based_routing for profile {}", profile_id.get_string_repr() ); - let client = state + let client = &state .grpc_client .dynamic_routing - .success_rate_client .as_ref() .ok_or(errors::RoutingError::SuccessRateClientInitializationError) - .attach_printable("success_rate gRPC client not found")?; + .attach_printable("dynamic routing gRPC client not found")? + .success_rate_client; let success_based_routing_configs = routing::helpers::fetch_dynamic_routing_configs::< api_routing::SuccessBasedRoutingConfig, @@ -2284,13 +2284,13 @@ pub async fn perform_elimination_routing( "performing elimination_routing for profile {}", profile_id.get_string_repr() ); - let client = state + let client = &state .grpc_client .dynamic_routing - .elimination_based_client .as_ref() .ok_or(errors::RoutingError::EliminationClientInitializationError) - .attach_printable("elimination routing's gRPC client not found")?; + .attach_printable("dynamic routing gRPC client not found")? + .elimination_based_client; let elimination_routing_config = routing::helpers::fetch_dynamic_routing_configs::< api_routing::EliminationRoutingConfig, @@ -2484,13 +2484,13 @@ where "performing contract_based_routing for profile {}", profile_id.get_string_repr() ); - let client = state + let client = &state .grpc_client .dynamic_routing - .contract_based_client .as_ref() .ok_or(errors::RoutingError::ContractRoutingClientInitializationError) - .attach_printable("contract routing gRPC client not found")?; + .attach_printable("dynamic routing gRPC client not found")? + .contract_based_client; let contract_based_routing_configs = routing::helpers::fetch_dynamic_routing_configs::< api_routing::ContractBasedRoutingConfig, diff --git a/crates/router/src/core/routing.rs b/crates/router/src/core/routing.rs index 52a3b4f1a7b..806a01235f3 100644 --- a/crates/router/src/core/routing.rs +++ b/crates/router/src/core/routing.rs @@ -1848,10 +1848,10 @@ pub async fn success_based_routing_update_configs( state .grpc_client .dynamic_routing - .success_rate_client .as_ref() - .async_map(\|sr_client\| async { - sr_client + .async_map(\|dr_client\| async { + dr_client + .success_rate_client .invalidate_success_rate_routing_keys( profile_id.get_string_repr().into(), state.get_grpc_headers(), @@ -1952,10 +1952,10 @@ pub async fn elimination_routing_update_configs( state .grpc_client .dynamic_routing - .elimination_based_client .as_ref() - .async_map(\|er_client\| async { - er_client + .async_map(\|dr_client\| async { + dr_client + .elimination_based_client .invalidate_elimination_bucket( profile_id.get_string_repr().into(), state.get_grpc_headers(), @@ -2287,12 +2287,11 @@ pub async fn contract_based_routing_update_configs( state .grpc_client - .clone() .dynamic_routing - .contract_based_client - .clone() - .async_map(\|ct_client\| async move { - ct_client + .as_ref() + .async_map(\|dr_client\| async { + dr_client + .contract_based_client .invalidate_contracts( profile_id.get_string_repr().into(), state.get_grpc_headers(), diff --git a/crates/router/src/core/routing/helpers.rs b/crates/router/src/core/routing/helpers.rs index 8b4c747d13f..32a7b560566 100644 --- a/crates/router/src/core/routing/helpers.rs +++ b/crates/router/src/core/routing/helpers.rs @@ -845,14 +845,14 @@ pub async fn push_metrics_with_update_window_for_success_based_routing( ) -> RouterResult<()> { if let Some(success_based_algo_ref) = dynamic_routing_algo_ref.success_based_algorithm { if success_based_algo_ref.enabled_feature != routing_types::DynamicRoutingFeatures::None { - let client = state + let client = &state .grpc_client .dynamic_routing - .success_rate_client .as_ref() .ok_or(errors::ApiErrorResponse::GenericNotFoundError { - message: "success_rate gRPC client not found".to_string(), - })?; + message: "dynamic routing gRPC client not found".to_string(), + })? + .success_rate_client; let payment_connector = &payment_attempt.connector.clone().ok_or( errors::ApiErrorResponse::GenericNotFoundError { @@ -1214,14 +1214,14 @@ pub async fn update_window_for_elimination_routing( ) -> RouterResult<()> { if let Some(elimination_algo_ref) = dynamic_algo_ref.elimination_routing_algorithm { if elimination_algo_ref.enabled_feature != routing_types::DynamicRoutingFeatures::None { - let client = state + let client = &state .grpc_client .dynamic_routing - .elimination_based_client .as_ref() .ok_or(errors::ApiErrorResponse::GenericNotFoundError { - message: "elimination_rate gRPC client not found".to_string(), - })?; + message: "dynamic routing gRPC client not found".to_string(), + })? + .elimination_based_client; let elimination_routing_config = fetch_dynamic_routing_configs::< routing_types::EliminationRoutingConfig, @@ -1394,14 +1394,14 @@ pub async fn push_metrics_with_update_window_for_contract_based_routing( if let Some(contract_routing_algo_ref) = dynamic_routing_algo_ref.contract_based_routing { if contract_routing_algo_ref.enabled_feature != routing_types::DynamicRoutingFeatures::None { - let client = state + let client = &state .grpc_client .dynamic_routing - .contract_based_client - .clone() + .as_ref() .ok_or(errors::ApiErrorResponse::GenericNotFoundError { - message: "contract_routing gRPC client not found".to_string(), - })?; + message: "dynamic routing gRPC client not found".to_string(), + })? + .contract_based_client; let payment_connector = &payment_attempt.connector.clone().ok_or( errors::ApiErrorResponse::GenericNotFoundError {	2025-07-09T11:09:09Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [ ] New feature - [ ] Enhancement - [x] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> This pull request introduces changes to improve the handling of optional configurations for dynamic routing in the gRPC client module. The updates include modifying the `GrpcClientSettings` structure to use `Option` types, enhancing error handling, and simplifying connection establishment logic. Additionally, default implementations are added to certain structs to streamline initialization. ### Enhancements to dynamic routing configuration: * [`crates/external_services/src/grpc_client.rs`](diffhunk://#diff-0129f28e4a26fac6ce00609c3a3542c380baabb72d04d977daa28f364ab319beL50-R51): Changed `dynamic_routing_client` in `GrpcClientSettings` to use `Option<DynamicRoutingClientConfig>` instead of a direct type, allowing for better handling of cases where the configuration might be absent. * [`crates/external_services/src/grpc_client.rs`](diffhunk://#diff-0129f28e4a26fac6ce00609c3a3542c380baabb72d04d977daa28f364ab319beL72-R77): Updated connection establishment logic to use `async_map` for optional configurations, added error handling with `transpose`, and provided a default value when no connection is established. ### Improvements to struct initialization: * [`crates/external_services/src/grpc_client/dynamic_routing.rs`](diffhunk://#diff-7b95c78b2ff78bd774ff3483d1565e28529f49d7cd3e819944cd6e14471e89f4L47-R47): Added a `Default` implementation to the `RoutingStrategy` struct, simplifying initialization when certain fields are optional. ### Simplification of dynamic routing checks: * [`crates/external_services/src/grpc_client/health_check_client.rs`](diffhunk://#diff-66f886eb2cc6f5e4e295e28e98bd77c97d1769cf82c54dd2c440156cdd9b16f0L56-R60): Refactored logic to handle `DynamicRoutingClientConfig` as an `Option` type, simplifying pattern matching and reducing code duplication. [[1]](diffhunk://#diff-66f886eb2cc6f5e4e295e28e98bd77c97d1769cf82c54dd2c440156cdd9b16f0L56-R60) [[2]](diffhunk://#diff-66f886eb2cc6f5e4e295e28e98bd77c97d1769cf82c54dd2c440156cdd9b16f0L84-R88) ### Added utility for asynchronous operations: * [`crates/external_services/src/grpc_client.rs`](diffhunk://#diff-0129f28e4a26fac6ce00609c3a3542c380baabb72d04d977daa28f364ab319beR13): Imported `AsyncExt` from `common_utils::ext_traits` to leverage its utilities for asynchronous operations like `async_map`. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> This is a configuration level changes making the dynamo configs optional. CI checks should suffice ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	b1c9be1600dbd897c32adcc2d8b98e77ec67c516	b1c9be1600dbd897c32adcc2d8b98e77ec67c516
juspay/hyperswitch	juspay__hyperswitch-8582	Bug: feat(router): refactor PML response Remove duplicate responses and return bank_names	diff --git a/api-reference/v2/openapi_spec_v2.json b/api-reference/v2/openapi_spec_v2.json index 53bbace7dfb..bd1cee6d8ef 100644 --- a/api-reference/v2/openapi_spec_v2.json +++ b/api-reference/v2/openapi_spec_v2.json @@ -17619,10 +17619,7 @@ ], "properties": { "bank_names": { - "type": "array", - "items": { - "$ref": "#/components/schemas/BankCodeResponse" - } + "$ref": "#/components/schemas/BankNames" } } } @@ -22329,11 +22326,11 @@ "$ref": "#/components/schemas/PaymentMethodType" }, "payment_experience": { - "allOf": [ - { - "$ref": "#/components/schemas/PaymentExperience" - } - ], + "type": "array", + "items": { + "$ref": "#/components/schemas/PaymentExperience" + }, + "description": "The payment experience for the payment method", "nullable": true }, "required_fields": { diff --git a/crates/api_models/src/payment_methods.rs b/crates/api_models/src/payment_methods.rs index 4cdfe9dcfe8..a70dceb962d 100644 --- a/crates/api_models/src/payment_methods.rs +++ b/crates/api_models/src/payment_methods.rs @@ -16,12 +16,11 @@ use masking::PeekInterface; use serde::de; use utoipa::{schema, ToSchema}; +#[cfg(feature = "v1")] +use crate::payments::BankCodeResponse; #[cfg(feature = "payouts")] use crate::payouts; -use crate::{ - admin, enums as api_enums, open_router, - payments::{self, BankCodeResponse}, -}; +use crate::{admin, enums as api_enums, open_router, payments}; #[cfg(feature = "v1")] #[derive(Debug, serde::Deserialize, serde::Serialize, Clone, ToSchema)] @@ -1471,7 +1470,10 @@ pub enum PaymentMethodSubtypeSpecificData { card_networks: Vec<CardNetworkTypes>, }, #[schema(title = "bank")] - Bank { bank_names: Vec<BankCodeResponse> }, + Bank { + #[schema(value_type = BankNames)] + bank_names: Vec<common_enums::BankNames>, + }, } #[cfg(feature = "v2")] diff --git a/crates/api_models/src/payments.rs b/crates/api_models/src/payments.rs index 90792e9633a..3697c555e7e 100644 --- a/crates/api_models/src/payments.rs +++ b/crates/api_models/src/payments.rs @@ -7727,8 +7727,8 @@ pub struct ResponsePaymentMethodTypesForPayments { pub payment_method_subtype: common_enums::PaymentMethodType, /// The payment experience for the payment method - #[schema(value_type = Option<PaymentExperience>)] - pub payment_experience: Option<common_enums::PaymentExperience>, + #[schema(value_type = Option<Vec<PaymentExperience>>)] + pub payment_experience: Option<Vec<common_enums::PaymentExperience>>, /// payment method subtype specific information #[serde(flatten)] diff --git a/crates/common_enums/src/enums.rs b/crates/common_enums/src/enums.rs index 1d00a451708..893473cfbc4 100644 --- a/crates/common_enums/src/enums.rs +++ b/crates/common_enums/src/enums.rs @@ -1832,7 +1832,9 @@ pub enum SamsungPayCardBrand { Copy, Debug, Eq, + Ord, Hash, + PartialOrd, PartialEq, serde::Deserialize, serde::Serialize, @@ -2081,6 +2083,8 @@ impl masking::SerializableSecret for PaymentMethodType {} Debug, Default, Eq, + PartialOrd, + Ord, Hash, PartialEq, serde::Deserialize, diff --git a/crates/router/src/core/payment_methods/vault.rs b/crates/router/src/core/payment_methods/vault.rs index d5848c7f418..ca2d5d1015b 100644 --- a/crates/router/src/core/payment_methods/vault.rs +++ b/crates/router/src/core/payment_methods/vault.rs @@ -1598,7 +1598,7 @@ pub async fn retrieve_and_delete_cvc_from_payment_token( .change_context(errors::ApiErrorResponse::InternalServerError) .attach_printable("Failed to get redis connection")?; - let key = format!("pm_token_{payment_token}_{payment_method}_hyperswitch_cvc"); + let key = format!("pm_token_{payment_token}_{payment_method}_hyperswitch_cvc",); let data = redis_conn .get_key::<bytes::Bytes>(&key.clone().into()) diff --git a/crates/router/src/core/payments/payment_methods.rs b/crates/router/src/core/payments/payment_methods.rs index 1cf17289a24..e21b3b96105 100644 --- a/crates/router/src/core/payments/payment_methods.rs +++ b/crates/router/src/core/payments/payment_methods.rs @@ -1,11 +1,15 @@ //! Contains functions of payment methods that are used in payments //! one of such functions is `list_payment_methods` +use std::collections::{BTreeMap, HashSet}; + use common_utils::{ext_traits::OptionExt, id_type}; use error_stack::ResultExt; use super::errors; -use crate::{core::payment_methods, db::errors::StorageErrorExt, routes, types::domain}; +use crate::{ + core::payment_methods, db::errors::StorageErrorExt, logger, routes, settings, types::domain, +}; #[cfg(feature = "v2")] pub async fn list_payment_methods( @@ -55,10 +59,12 @@ pub async fn list_payment_methods( }; let response = - hyperswitch_domain_models::merchant_connector_account::FlattenedPaymentMethodsEnabled::from_payment_connectors_list(payment_connector_accounts) + FlattenedPaymentMethodsEnabled(hyperswitch_domain_models::merchant_connector_account::FlattenedPaymentMethodsEnabled::from_payment_connectors_list(payment_connector_accounts)) .perform_filtering() + .merge_and_transform() .get_required_fields(RequiredFieldsInput::new()) .perform_surcharge_calculation() + .populate_pm_subtype_specific_data(&state.conf.bank_config) .generate_response(customer_payment_methods); Ok(hyperswitch_domain_models::api::ApplicationResponse::Json( @@ -75,12 +81,79 @@ impl RequiredFieldsInput { } } +struct FlattenedPaymentMethodsEnabled( + hyperswitch_domain_models::merchant_connector_account::FlattenedPaymentMethodsEnabled, +); + +impl FlattenedPaymentMethodsEnabled { + fn perform_filtering(self) -> FilteredPaymentMethodsEnabled { + FilteredPaymentMethodsEnabled(self.0.payment_methods_enabled) + } +} + /// Container for the filtered payment methods struct FilteredPaymentMethodsEnabled( Vec<hyperswitch_domain_models::merchant_connector_account::PaymentMethodsEnabledForConnector>, ); impl FilteredPaymentMethodsEnabled { + fn merge_and_transform(self) -> MergedEnabledPaymentMethodTypes { + let values = self + .0 + .into_iter() + // BTreeMap used to ensure soretd response, otherwise the response is arbitrarily ordered + .fold(BTreeMap::new(), \|mut acc, item\| { + let key = ( + item.payment_method, + item.payment_methods_enabled.payment_method_subtype, + ); + let (experiences, connectors) = acc + .entry(key) + // HashSet used to ensure payment_experience does not have duplicates, due to multiple connectors for a pm_subtype + .or_insert_with(\|\| (HashSet::new(), Vec::new())); + + if let Some(experience) = item.payment_methods_enabled.payment_experience { + experiences.insert(experience); + } + connectors.push(item.connector); + + acc + }) + .into_iter() + .map( + \|( + (payment_method_type, payment_method_subtype), + (payment_experience, connectors), + )\| { + MergedEnabledPaymentMethod { + payment_method_type, + payment_method_subtype, + payment_experience: if payment_experience.is_empty() { + None + } else { + Some(payment_experience.into_iter().collect()) + }, + connectors, + } + }, + ) + .collect(); + MergedEnabledPaymentMethodTypes(values) + } +} + +/// Element container to hold the filtered payment methods with payment_experience and connectors merged for a pm_subtype +struct MergedEnabledPaymentMethod { + payment_method_subtype: common_enums::PaymentMethodType, + payment_method_type: common_enums::PaymentMethod, + payment_experience: Option<Vec<common_enums::PaymentExperience>>, + connectors: Vec<api_models::enums::Connector>, +} + +/// Container to hold the filtered payment methods with payment_experience and connectors merged for a pm_subtype +struct MergedEnabledPaymentMethodTypes(Vec<MergedEnabledPaymentMethod>); + +impl MergedEnabledPaymentMethodTypes { fn get_required_fields( self, _input: RequiredFieldsInput, @@ -91,13 +164,10 @@ impl FilteredPaymentMethodsEnabled { .map( \|payment_methods_enabled\| RequiredFieldsForEnabledPaymentMethod { required_field: None, - payment_method_type: payment_methods_enabled.payment_method, - payment_method_subtype: payment_methods_enabled - .payment_methods_enabled - .payment_method_subtype, - payment_experience: payment_methods_enabled - .payment_methods_enabled - .payment_experience, + payment_method_type: payment_methods_enabled.payment_method_type, + payment_method_subtype: payment_methods_enabled.payment_method_subtype, + payment_experience: payment_methods_enabled.payment_experience, + connectors: payment_methods_enabled.connectors, }, ) .collect(); @@ -111,18 +181,44 @@ struct RequiredFieldsForEnabledPaymentMethod { required_field: Option<Vec<api_models::payment_methods::RequiredFieldInfo>>, payment_method_subtype: common_enums::PaymentMethodType, payment_method_type: common_enums::PaymentMethod, - payment_experience: Option<common_enums::PaymentExperience>, + payment_experience: Option<Vec<common_enums::PaymentExperience>>, + connectors: Vec<api_models::enums::Connector>, } /// Container to hold the filtered payment methods enabled with required fields struct RequiredFieldsForEnabledPaymentMethodTypes(Vec<RequiredFieldsForEnabledPaymentMethod>); +impl RequiredFieldsForEnabledPaymentMethodTypes { + fn perform_surcharge_calculation( + self, + ) -> RequiredFieldsAndSurchargeForEnabledPaymentMethodTypes { + // TODO: Perform surcharge calculation + let details_with_surcharge = self + .0 + .into_iter() + .map( + \|payment_methods_enabled\| RequiredFieldsAndSurchargeForEnabledPaymentMethodType { + payment_method_type: payment_methods_enabled.payment_method_type, + required_field: payment_methods_enabled.required_field, + payment_method_subtype: payment_methods_enabled.payment_method_subtype, + payment_experience: payment_methods_enabled.payment_experience, + surcharge: None, + connectors: payment_methods_enabled.connectors, + }, + ) + .collect(); + + RequiredFieldsAndSurchargeForEnabledPaymentMethodTypes(details_with_surcharge) + } +} + /// Element Container to hold the filtered payment methods enabled with required fields and surcharge struct RequiredFieldsAndSurchargeForEnabledPaymentMethodType { required_field: Option<Vec<api_models::payment_methods::RequiredFieldInfo>>, payment_method_subtype: common_enums::PaymentMethodType, payment_method_type: common_enums::PaymentMethod, - payment_experience: Option<common_enums::PaymentExperience>, + payment_experience: Option<Vec<common_enums::PaymentExperience>>, + connectors: Vec<api_models::enums::Connector>, surcharge: Option<api_models::payment_methods::SurchargeDetailsResponse>, } @@ -131,7 +227,105 @@ struct RequiredFieldsAndSurchargeForEnabledPaymentMethodTypes( Vec<RequiredFieldsAndSurchargeForEnabledPaymentMethodType>, ); +fn get_pm_subtype_specific_data( + bank_config: &settings::BankRedirectConfig, + payment_method_type: common_enums::enums::PaymentMethod, + payment_method_subtype: common_enums::enums::PaymentMethodType, + connectors: &[api_models::enums::Connector], +) -> Option<api_models::payment_methods::PaymentMethodSubtypeSpecificData> { + match payment_method_type { + // TODO: Return card_networks + common_enums::PaymentMethod::Card \| common_enums::PaymentMethod::CardRedirect => None, + + common_enums::PaymentMethod::BankRedirect + \| common_enums::PaymentMethod::BankTransfer + \| common_enums::PaymentMethod::BankDebit + \| common_enums::PaymentMethod::OpenBanking => { + if let Some(connector_bank_names) = bank_config.0.get(&payment_method_subtype) { + let bank_names = connectors + .iter() + .filter_map(\|connector\| { + connector_bank_names.0.get(&connector.to_string()) + .map(\|connector_hash_set\| { + connector_hash_set.banks.clone() + }) + .or_else(\|\| { + logger::debug!("Could not find any configured connectors for payment_method -> {payment_method_subtype} for connector -> {connector}"); + None + }) + }) + .flatten() + .collect(); + Some( + api_models::payment_methods::PaymentMethodSubtypeSpecificData::Bank { + bank_names, + }, + ) + } else { + logger::debug!("Could not find any configured banks for payment_method -> {payment_method_subtype}"); + None + } + } + + common_enums::PaymentMethod::PayLater + \| common_enums::PaymentMethod::Wallet + \| common_enums::PaymentMethod::Crypto + \| common_enums::PaymentMethod::Reward + \| common_enums::PaymentMethod::RealTimePayment + \| common_enums::PaymentMethod::Upi + \| common_enums::PaymentMethod::Voucher + \| common_enums::PaymentMethod::GiftCard + \| common_enums::PaymentMethod::MobilePayment => None, + } +} + impl RequiredFieldsAndSurchargeForEnabledPaymentMethodTypes { + fn populate_pm_subtype_specific_data( + self, + bank_config: &settings::BankRedirectConfig, + ) -> RequiredFieldsAndSurchargeWithExtraInfoForEnabledPaymentMethodTypes { + let response_payment_methods = self + .0 + .into_iter() + .map(\|payment_methods_enabled\| { + RequiredFieldsAndSurchargeWithExtraInfoForEnabledPaymentMethodType { + payment_method_type: payment_methods_enabled.payment_method_type, + payment_method_subtype: payment_methods_enabled.payment_method_subtype, + payment_experience: payment_methods_enabled.payment_experience, + required_field: payment_methods_enabled.required_field, + surcharge: payment_methods_enabled.surcharge, + pm_subtype_specific_data: get_pm_subtype_specific_data( + bank_config, + payment_methods_enabled.payment_method_type, + payment_methods_enabled.payment_method_subtype, + &payment_methods_enabled.connectors, + ), + } + }) + .collect(); + + RequiredFieldsAndSurchargeWithExtraInfoForEnabledPaymentMethodTypes( + response_payment_methods, + ) + } +} + +/// Element Container to hold the filtered payment methods enabled with required fields, surcharge and subtype specific data +struct RequiredFieldsAndSurchargeWithExtraInfoForEnabledPaymentMethodType { + required_field: Option<Vec<api_models::payment_methods::RequiredFieldInfo>>, + payment_method_subtype: common_enums::PaymentMethodType, + payment_method_type: common_enums::PaymentMethod, + payment_experience: Option<Vec<common_enums::PaymentExperience>>, + surcharge: Option<api_models::payment_methods::SurchargeDetailsResponse>, + pm_subtype_specific_data: Option<api_models::payment_methods::PaymentMethodSubtypeSpecificData>, +} + +/// Container to hold the filtered payment methods enabled with required fields, surcharge and subtype specific data +struct RequiredFieldsAndSurchargeWithExtraInfoForEnabledPaymentMethodTypes( + Vec<RequiredFieldsAndSurchargeWithExtraInfoForEnabledPaymentMethodType>, +); + +impl RequiredFieldsAndSurchargeWithExtraInfoForEnabledPaymentMethodTypes { fn generate_response( self, customer_payment_methods: Option< @@ -148,7 +342,7 @@ impl RequiredFieldsAndSurchargeForEnabledPaymentMethodTypes { payment_experience: payment_methods_enabled.payment_experience, required_fields: payment_methods_enabled.required_field, surcharge_details: payment_methods_enabled.surcharge, - extra_information: None, + extra_information: payment_methods_enabled.pm_subtype_specific_data, } }) .collect(); @@ -160,40 +354,6 @@ impl RequiredFieldsAndSurchargeForEnabledPaymentMethodTypes { } } -impl RequiredFieldsForEnabledPaymentMethodTypes { - fn perform_surcharge_calculation( - self, - ) -> RequiredFieldsAndSurchargeForEnabledPaymentMethodTypes { - let details_with_surcharge = self - .0 - .into_iter() - .map( - \|payment_methods_enabled\| RequiredFieldsAndSurchargeForEnabledPaymentMethodType { - payment_method_type: payment_methods_enabled.payment_method_type, - required_field: payment_methods_enabled.required_field, - payment_method_subtype: payment_methods_enabled.payment_method_subtype, - payment_experience: payment_methods_enabled.payment_experience, - surcharge: None, - }, - ) - .collect(); - - RequiredFieldsAndSurchargeForEnabledPaymentMethodTypes(details_with_surcharge) - } -} - -trait PerformFilteringOnPaymentMethodsEnabled { - fn perform_filtering(self) -> FilteredPaymentMethodsEnabled; -} - -impl PerformFilteringOnPaymentMethodsEnabled - for hyperswitch_domain_models::merchant_connector_account::FlattenedPaymentMethodsEnabled -{ - fn perform_filtering(self) -> FilteredPaymentMethodsEnabled { - FilteredPaymentMethodsEnabled(self.payment_methods_enabled) - } -} - /// Validate if payment methods list can be performed on the current status of payment intent fn validate_payment_status_for_payment_method_list( intent_status: common_enums::IntentStatus,	2025-07-09T08:23:18Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [ ] New feature - [x] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> - Merge `payment_experience` for a pm_type, subtype into an array - Return `bank_names` ### Additional Changes - [x] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> Closes #8582 ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> Request: ``` curl --location 'http://localhost:8080/v2/payments/12345_pay_0197ee3c52887d51b074cecb88687a33/payment-methods' \ --header 'Content-Type: application/json' \ --header 'Authorization: publishable-key=pk_dev_bef28bbe20d64d52bf4658ad5f7bc91e,client-secret=cs_0197ee3c52bd71a38bf7932a4484b345' \ --header 'X-Profile-Id: pro_eW12tyr48EHRHFF9MfLa' \ --header 'api-key: pk_dev_bef28bbe20d64d52bf4658ad5f7bc91e' ``` Response: ```json { "payment_methods_enabled": [ { "payment_method_type": "card", "payment_method_subtype": "card", "payment_experience": null, "required_fields": null, "surcharge_details": null }, { "payment_method_type": "card_redirect", "payment_method_subtype": "card_redirect", "payment_experience": [ "redirect_to_url" ], "required_fields": null, "surcharge_details": null }, { "payment_method_type": "pay_later", "payment_method_subtype": "klarna", "payment_experience": [ "redirect_to_url", "invoke_sdk_client" ], "required_fields": null, "surcharge_details": null }, { "payment_method_type": "wallet", "payment_method_subtype": "google_pay", "payment_experience": null, "required_fields": null, "surcharge_details": null }, { "payment_method_type": "wallet", "payment_method_subtype": "paypal", "payment_experience": null, "required_fields": null, "surcharge_details": null }, { "payment_method_type": "bank_redirect", "payment_method_subtype": "eps", "payment_experience": [ "redirect_to_url" ], "bank_names": [ "posojilnica_bank_e_gen", "schoellerbank_ag", "volksbank_gruppe", "hypo_tirol_bank_ag", "volkskreditbank_ag", "bawag_psk_ag", "easybank_ag", "raiffeisen_bankengruppe_osterreich", "sparda_bank_wien", "dolomitenbank", "erste_bank_und_sparkassen", "bank_austria" ], "required_fields": null, "surcharge_details": null }, { "payment_method_type": "bank_redirect", "payment_method_subtype": "ideal", "payment_experience": [ "redirect_to_url" ], "bank_names": [ "n26", "knab", "nationale_nederlanden", "ing", "rabobank", "sns_bank", "asn_bank", "bunq", "revolut", "triodos_bank", "regiobank", "abn_amro", "van_lanschot", "yoursafe" ], "required_fields": null, "surcharge_details": null }, { "payment_method_type": "bank_debit", "payment_method_subtype": "sepa", "payment_experience": null, "bank_names": [], "required_fields": null, "surcharge_details": null } ], "customer_payment_methods": [] } ``` ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	0f70fc512c90e4d5603af7b965c137465999b73c	0f70fc512c90e4d5603af7b965c137465999b73c
juspay/hyperswitch	juspay__hyperswitch-8584	Bug: Add endpoints to support ai chat interactions - Add endpoints to talk to different ai services. - Add config for URLS - make feature flag for ai chat service that will help to manage feature across different environments.	diff --git a/config/config.example.toml b/config/config.example.toml index 2c35b1778cf..22ad2d6c666 100644 --- a/config/config.example.toml +++ b/config/config.example.toml @@ -1132,4 +1132,8 @@ version = "HOSTNAME" # value of HOSTNAME from deployment which tells its [platform] enabled = true # Enable or disable platform features -allow_connected_merchants = false # Enable or disable connected merchant account features \ No newline at end of file +allow_connected_merchants = false # Enable or disable connected merchant account features + +[chat] +enabled = false # Enable or disable chat features +hyperswitch_ai_host = "http://0.0.0.0:8000" # Hyperswitch ai workflow host \ No newline at end of file diff --git a/config/deployments/env_specific.toml b/config/deployments/env_specific.toml index cab8777aa97..4428b508017 100644 --- a/config/deployments/env_specific.toml +++ b/config/deployments/env_specific.toml @@ -380,4 +380,8 @@ connector_names = "connector_names" # Comma-separated list of allowed connec [grpc_client.unified_connector_service] host = "localhost" # Unified Connector Service Client Host port = 8000 # Unified Connector Service Client Port -connection_timeout = 10 # Connection Timeout Duration in Seconds \ No newline at end of file +connection_timeout = 10 # Connection Timeout Duration in Seconds + +[chat] +enabled = false # Enable or disable chat features +hyperswitch_ai_host = "http://0.0.0.0:8000" # Hyperswitch ai workflow host diff --git a/config/development.toml b/config/development.toml index 5a03b7a4b20..8c9a20362d1 100644 --- a/config/development.toml +++ b/config/development.toml @@ -1225,3 +1225,7 @@ connector_names = "stripe, adyen" # Comma-separated list of allowe [infra_values] cluster = "CLUSTER" version = "HOSTNAME" + +[chat] +enabled = false +hyperswitch_ai_host = "http://0.0.0.0:8000" \ No newline at end of file diff --git a/config/docker_compose.toml b/config/docker_compose.toml index 448fa0390f0..299644a8632 100644 --- a/config/docker_compose.toml +++ b/config/docker_compose.toml @@ -1108,6 +1108,10 @@ background_color = "#FFFFFF" enabled = true allow_connected_merchants = true +[chat] +enabled = false +hyperswitch_ai_host = "http://0.0.0.0:8000" + [authentication_providers] click_to_pay = {connector_list = "adyen, cybersource"} diff --git a/crates/api_models/src/chat.rs b/crates/api_models/src/chat.rs new file mode 100644 index 00000000000..c66b42cc4f4 --- /dev/null +++ b/crates/api_models/src/chat.rs @@ -0,0 +1,18 @@ +use common_utils::id_type; +use masking::Secret; + +#[derive(Debug, serde::Deserialize, serde::Serialize, Clone)] +pub struct ChatRequest { + pub message: Secret<String>, +} + +#[derive(Debug, serde::Deserialize, serde::Serialize)] +pub struct ChatResponse { + pub response: Secret<serde_json::Value>, + pub merchant_id: id_type::MerchantId, + pub status: String, + #[serde(skip_serializing)] + pub query_executed: Option<Secret<String>>, + #[serde(skip_serializing)] + pub row_count: Option<i32>, +} diff --git a/crates/api_models/src/events.rs b/crates/api_models/src/events.rs index 768aed75a7a..dd54cd63222 100644 --- a/crates/api_models/src/events.rs +++ b/crates/api_models/src/events.rs @@ -1,4 +1,5 @@ pub mod apple_pay_certificates_migration; +pub mod chat; pub mod connector_onboarding; pub mod customer; pub mod dispute; diff --git a/crates/api_models/src/events/chat.rs b/crates/api_models/src/events/chat.rs new file mode 100644 index 00000000000..42fefe487e9 --- /dev/null +++ b/crates/api_models/src/events/chat.rs @@ -0,0 +1,5 @@ +use common_utils::events::{ApiEventMetric, ApiEventsType}; + +use crate::chat::{ChatRequest, ChatResponse}; + +common_utils::impl_api_event_type!(Chat, (ChatRequest, ChatResponse)); diff --git a/crates/api_models/src/lib.rs b/crates/api_models/src/lib.rs index cbc50ed7ff2..3b343459e9e 100644 --- a/crates/api_models/src/lib.rs +++ b/crates/api_models/src/lib.rs @@ -5,6 +5,7 @@ pub mod apple_pay_certificates_migration; pub mod authentication; pub mod blocklist; pub mod cards_info; +pub mod chat; pub mod conditional_configs; pub mod connector_enums; pub mod connector_onboarding; diff --git a/crates/common_utils/src/consts.rs b/crates/common_utils/src/consts.rs index c8cf1e8c579..3ef0ef555e6 100644 --- a/crates/common_utils/src/consts.rs +++ b/crates/common_utils/src/consts.rs @@ -191,3 +191,6 @@ pub const METRICS_HOST_TAG_NAME: &str = "host"; /// API client request timeout (in seconds) pub const REQUEST_TIME_OUT: u64 = 30; + +/// API client request timeout for ai service (in seconds) +pub const REQUEST_TIME_OUT_FOR_AI_SERVICE: u64 = 120; diff --git a/crates/common_utils/src/events.rs b/crates/common_utils/src/events.rs index e1964296755..49be22fc931 100644 --- a/crates/common_utils/src/events.rs +++ b/crates/common_utils/src/events.rs @@ -137,6 +137,7 @@ pub enum ApiEventsType { profile_acquirer_id: id_type::ProfileAcquirerId, }, ThreeDsDecisionRule, + Chat, } impl ApiEventMetric for serde_json::Value {} diff --git a/crates/hyperswitch_domain_models/src/chat.rs b/crates/hyperswitch_domain_models/src/chat.rs new file mode 100644 index 00000000000..31b9f806db7 --- /dev/null +++ b/crates/hyperswitch_domain_models/src/chat.rs @@ -0,0 +1,15 @@ +use common_utils::id_type; +use masking::Secret; + +#[derive(Debug, serde::Deserialize, serde::Serialize, Clone)] +pub struct GetDataMessage { + pub message: Secret<String>, +} + +#[derive(Debug, serde::Deserialize, serde::Serialize, Clone)] +pub struct HyperswitchAiDataRequest { + pub merchant_id: id_type::MerchantId, + pub profile_id: id_type::ProfileId, + pub org_id: id_type::OrganizationId, + pub query: GetDataMessage, +} diff --git a/crates/hyperswitch_domain_models/src/lib.rs b/crates/hyperswitch_domain_models/src/lib.rs index 35f619334c3..b89613c5413 100644 --- a/crates/hyperswitch_domain_models/src/lib.rs +++ b/crates/hyperswitch_domain_models/src/lib.rs @@ -6,6 +6,7 @@ pub mod business_profile; pub mod callback_mapper; pub mod card_testing_guard_data; pub mod cards_info; +pub mod chat; pub mod connector_endpoints; pub mod consts; pub mod customer; diff --git a/crates/router/src/configs/secrets_transformers.rs b/crates/router/src/configs/secrets_transformers.rs index 9129a9a78f6..d4eb34838d6 100644 --- a/crates/router/src/configs/secrets_transformers.rs +++ b/crates/router/src/configs/secrets_transformers.rs @@ -452,6 +452,7 @@ pub(crate) async fn fetch_raw_secrets( Settings { server: conf.server, + chat: conf.chat, master_database, redis: conf.redis, log: conf.log, diff --git a/crates/router/src/configs/settings.rs b/crates/router/src/configs/settings.rs index 6157a4fab20..ae4c8a3cda0 100644 --- a/crates/router/src/configs/settings.rs +++ b/crates/router/src/configs/settings.rs @@ -70,6 +70,7 @@ pub struct Settings<S: SecretState> { pub server: Server, pub proxy: Proxy, pub env: Env, + pub chat: ChatSettings, pub master_database: SecretStateContainer<Database, S>, #[cfg(feature = "olap")] pub replica_database: SecretStateContainer<Database, S>, @@ -195,6 +196,13 @@ pub struct Platform { pub allow_connected_merchants: bool, } +#[derive(Debug, Deserialize, Clone, Default)] +#[serde(default)] +pub struct ChatSettings { + pub enabled: bool, + pub hyperswitch_ai_host: String, +} + #[derive(Debug, Clone, Default, Deserialize)] pub struct Multitenancy { pub tenants: TenantConfig, @@ -1016,6 +1024,7 @@ impl Settings<SecuredSecret> { self.secrets.get_inner().validate()?; self.locker.validate()?; self.connectors.validate("connectors")?; + self.chat.validate()?; self.cors.validate()?; diff --git a/crates/router/src/configs/validations.rs b/crates/router/src/configs/validations.rs index 4fc254760a0..023b9ee5bec 100644 --- a/crates/router/src/configs/validations.rs +++ b/crates/router/src/configs/validations.rs @@ -343,3 +343,15 @@ impl super::settings::OpenRouter { ) } } + +impl super::settings::ChatSettings { + pub fn validate(&self) -> Result<(), ApplicationError> { + use common_utils::fp_utils::when; + + when(self.enabled && self.hyperswitch_ai_host.is_empty(), \|\| { + Err(ApplicationError::InvalidConfigurationValueError( + "hyperswitch ai host must be set if chat is enabled".into(), + )) + }) + } +} diff --git a/crates/router/src/core.rs b/crates/router/src/core.rs index 2334eddfd64..0fe3e57f872 100644 --- a/crates/router/src/core.rs +++ b/crates/router/src/core.rs @@ -72,4 +72,5 @@ pub mod relay; #[cfg(feature = "v2")] pub mod revenue_recovery; +pub mod chat; pub mod tokenization; diff --git a/crates/router/src/core/chat.rs b/crates/router/src/core/chat.rs new file mode 100644 index 00000000000..c30e27f0482 --- /dev/null +++ b/crates/router/src/core/chat.rs @@ -0,0 +1,57 @@ +use api_models::chat as chat_api; +use common_utils::{ + consts, + errors::CustomResult, + request::{Method, RequestBuilder, RequestContent}, +}; +use error_stack::ResultExt; +use external_services::http_client; +use hyperswitch_domain_models::chat as chat_domain; +use router_env::{instrument, logger, tracing}; + +use crate::{ + db::errors::chat::ChatErrors, + routes::SessionState, + services::{authentication as auth, ApplicationResponse}, +}; + +#[instrument(skip_all)] +pub async fn get_data_from_hyperswitch_ai_workflow( + state: SessionState, + user_from_token: auth::UserFromToken, + req: chat_api::ChatRequest, +) -> CustomResult<ApplicationResponse<chat_api::ChatResponse>, ChatErrors> { + let url = format!("{}/webhook", state.conf.chat.hyperswitch_ai_host); + + let request_body = chat_domain::HyperswitchAiDataRequest { + query: chat_domain::GetDataMessage { + message: req.message, + }, + org_id: user_from_token.org_id, + merchant_id: user_from_token.merchant_id, + profile_id: user_from_token.profile_id, + }; + logger::info!("Request for AI service: {:?}", request_body); + + let request = RequestBuilder::new() + .method(Method::Post) + .url(&url) + .attach_default_headers() + .set_body(RequestContent::Json(Box::new(request_body.clone()))) + .build(); + + let response = http_client::send_request( + &state.conf.proxy, + request, + Some(consts::REQUEST_TIME_OUT_FOR_AI_SERVICE), + ) + .await + .change_context(ChatErrors::InternalServerError) + .attach_printable("Error when sending request to AI service")? + .json::<_>() + .await + .change_context(ChatErrors::InternalServerError) + .attach_printable("Error when deserializing response from AI service")?; + + Ok(ApplicationResponse::Json(response)) +} diff --git a/crates/router/src/core/errors.rs b/crates/router/src/core/errors.rs index 93d4414a5b4..c8e7cb4e6f4 100644 --- a/crates/router/src/core/errors.rs +++ b/crates/router/src/core/errors.rs @@ -1,3 +1,4 @@ +pub mod chat; pub mod customers_error_response; pub mod error_handlers; pub mod transformers; diff --git a/crates/router/src/core/errors/chat.rs b/crates/router/src/core/errors/chat.rs new file mode 100644 index 00000000000..a96afa67de8 --- /dev/null +++ b/crates/router/src/core/errors/chat.rs @@ -0,0 +1,37 @@ +#[derive(Debug, thiserror::Error)] +pub enum ChatErrors { + #[error("User InternalServerError")] + InternalServerError, + #[error("Missing Config error")] + MissingConfigError, + #[error("Chat response deserialization failed")] + ChatResponseDeserializationFailed, +} + +impl common_utils::errors::ErrorSwitch<api_models::errors::types::ApiErrorResponse> for ChatErrors { + fn switch(&self) -> api_models::errors::types::ApiErrorResponse { + use api_models::errors::types::{ApiError, ApiErrorResponse as AER}; + let sub_code = "AI"; + match self { + Self::InternalServerError => { + AER::InternalServerError(ApiError::new("HE", 0, self.get_error_message(), None)) + } + Self::MissingConfigError => { + AER::InternalServerError(ApiError::new(sub_code, 1, self.get_error_message(), None)) + } + Self::ChatResponseDeserializationFailed => { + AER::BadRequest(ApiError::new(sub_code, 2, self.get_error_message(), None)) + } + } + } +} + +impl ChatErrors { + pub fn get_error_message(&self) -> String { + match self { + Self::InternalServerError => "Something went wrong".to_string(), + Self::MissingConfigError => "Missing webhook url".to_string(), + Self::ChatResponseDeserializationFailed => "Failed to parse chat response".to_string(), + } + } +} diff --git a/crates/router/src/lib.rs b/crates/router/src/lib.rs index 6bcb17ad1a5..e002f7fd050 100644 --- a/crates/router/src/lib.rs +++ b/crates/router/src/lib.rs @@ -189,7 +189,8 @@ pub fn mk_app( .service(routes::MerchantAccount::server(state.clone())) .service(routes::User::server(state.clone())) .service(routes::ApiKeys::server(state.clone())) - .service(routes::Routing::server(state.clone())); + .service(routes::Routing::server(state.clone())) + .service(routes::Chat::server(state.clone())); #[cfg(feature = "v1")] { diff --git a/crates/router/src/routes.rs b/crates/router/src/routes.rs index f639ee06ab0..fcf7270fa8a 100644 --- a/crates/router/src/routes.rs +++ b/crates/router/src/routes.rs @@ -75,6 +75,8 @@ pub mod process_tracker; #[cfg(feature = "v2")] pub mod proxy; +pub mod chat; + #[cfg(feature = "dummy_connector")] pub use self::app::DummyConnector; #[cfg(feature = "v2")] @@ -86,7 +88,7 @@ pub use self::app::Recon; #[cfg(feature = "v2")] pub use self::app::Tokenization; pub use self::app::{ - ApiKeys, AppState, ApplePayCertificatesMigration, Authentication, Cache, Cards, Configs, + ApiKeys, AppState, ApplePayCertificatesMigration, Authentication, Cache, Cards, Chat, Configs, ConnectorOnboarding, Customers, Disputes, EphemeralKey, FeatureMatrix, Files, Forex, Gsm, Health, Hypersense, Mandates, MerchantAccount, MerchantConnectorAccount, PaymentLink, PaymentMethods, Payments, Poll, ProcessTracker, Profile, ProfileAcquirer, ProfileNew, Refunds, diff --git a/crates/router/src/routes/app.rs b/crates/router/src/routes/app.rs index 9935ab5fd9f..3cbf532b951 100644 --- a/crates/router/src/routes/app.rs +++ b/crates/router/src/routes/app.rs @@ -59,8 +59,8 @@ use super::verification::{apple_pay_merchant_registration, retrieve_apple_pay_ve #[cfg(feature = "oltp")] use super::webhooks::; use super::{ - admin, api_keys, cache::, connector_onboarding, disputes, files, gsm, health::, profiles, - relay, user, user_role, + admin, api_keys, cache::, chat, connector_onboarding, disputes, files, gsm, health::*, + profiles, relay, user, user_role, }; #[cfg(feature = "v1")] use super::{apple_pay_certificates_migration, blocklist, payment_link, webhook_events}; @@ -2215,6 +2215,23 @@ impl Gsm { } } +pub struct Chat; + +#[cfg(feature = "olap")] +impl Chat { + pub fn server(state: AppState) -> Scope { + let mut route = web::scope("/chat").app_data(web::Data::new(state.clone())); + if state.conf.chat.enabled { + route = route.service( + web::scope("/ai").service( + web::resource("/data") + .route(web::post().to(chat::get_data_from_hyperswitch_ai_workflow)), + ), + ); + } + route + } +} pub struct ThreeDsDecisionRule; #[cfg(feature = "oltp")] diff --git a/crates/router/src/routes/chat.rs b/crates/router/src/routes/chat.rs new file mode 100644 index 00000000000..555bf007d23 --- /dev/null +++ b/crates/router/src/routes/chat.rs @@ -0,0 +1,38 @@ +use actix_web::{web, HttpRequest, HttpResponse}; +#[cfg(feature = "olap")] +use api_models::chat as chat_api; +use router_env::{instrument, tracing, Flow}; + +use super::AppState; +use crate::{ + core::{api_locking, chat as chat_core}, + services::{ + api, + authentication::{self as auth}, + authorization::permissions::Permission, + }, +}; + +#[instrument(skip_all)] +pub async fn get_data_from_hyperswitch_ai_workflow( + state: web::Data<AppState>, + http_req: HttpRequest, + payload: web::Json<chat_api::ChatRequest>, +) -> HttpResponse { + let flow = Flow::GetDataFromHyperswitchAiFlow; + Box::pin(api::server_wrap( + flow.clone(), + state, + &http_req, + payload.into_inner(), + \|state, user: auth::UserFromToken, payload, _\| { + chat_core::get_data_from_hyperswitch_ai_workflow(state, user, payload) + }, + // At present, the AI service retrieves data scoped to the merchant level + &auth::JWTAuth { + permission: Permission::MerchantPaymentRead, + }, + api_locking::LockAction::NotApplicable, + )) + .await +} diff --git a/crates/router/src/routes/lock_utils.rs b/crates/router/src/routes/lock_utils.rs index fa616a3da3e..365d54fc84a 100644 --- a/crates/router/src/routes/lock_utils.rs +++ b/crates/router/src/routes/lock_utils.rs @@ -35,6 +35,7 @@ pub enum ApiIdentifier { UserRole, ConnectorOnboarding, Recon, + AiWorkflow, Poll, ApplePayCertificatesMigration, Relay, @@ -300,6 +301,8 @@ impl From<Flow> for ApiIdentifier { \| Flow::DeleteTheme \| Flow::CloneConnector => Self::User, + Flow::GetDataFromHyperswitchAiFlow => Self::AiWorkflow, + Flow::ListRolesV2 \| Flow::ListInvitableRolesAtEntityLevel \| Flow::ListUpdatableRolesAtEntityLevel diff --git a/crates/router_env/src/logger/types.rs b/crates/router_env/src/logger/types.rs index d395cd1f6da..0eafefd112f 100644 --- a/crates/router_env/src/logger/types.rs +++ b/crates/router_env/src/logger/types.rs @@ -349,6 +349,8 @@ pub enum Flow { ApplePayCertificatesMigration, /// Gsm Rule Delete flow GsmRuleDelete, + /// Get data from embedded flow + GetDataFromHyperswitchAiFlow, /// User Sign Up UserSignUp, /// User Sign Up diff --git a/loadtest/config/development.toml b/loadtest/config/development.toml index 8b19ee9c1fa..7e0a123f8d7 100644 --- a/loadtest/config/development.toml +++ b/loadtest/config/development.toml @@ -723,3 +723,7 @@ redsys = { payment_method = "card" } billing_connectors_which_require_payment_sync = "stripebilling, recurly" [billing_connectors_invoice_sync] billing_connectors_which_requires_invoice_sync_call = "recurly" + +[chat] +enabled = false +hyperswitch_ai_host = "http://0.0.0.0:8000" \ No newline at end of file	2025-07-09T09:19:51Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description The PR does the following actions - Adds endpoints to talk to ai services, particularly to n8n flow and embedded flow - Introduces a feature flag to manage chat features across different envs ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context Closes #8584 ## How did you test it? curl to test this ``` curl --location 'http://localhost:8080/chat/ai/data' \ --header 'x-feature: integ-custom' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer JWT' \ --data '{ "message": "get count of failed payments" }' ``` <img width="1340" height="674" alt="image" src="https://github.com/user-attachments/assets/bd7722d8-a6c0-4494-ab44-d2fb821e5146" /> ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	064113a4c96c77d83e1e0230a56678863dd8f7db	064113a4c96c77d83e1e0230a56678863dd8f7db
juspay/hyperswitch	juspay__hyperswitch-8581	Bug: chore(stripe:EPS): enable bank_name as required field for eps stripe. bank_name should be mandatory for stripe/EPS for sdk changes	diff --git a/api-reference/v1/openapi_spec_v1.json b/api-reference/v1/openapi_spec_v1.json index d748f65261a..5656a7f8874 100644 --- a/api-reference/v1/openapi_spec_v1.json +++ b/api-reference/v1/openapi_spec_v1.json @@ -14281,6 +14281,28 @@ "user_bank" ] }, + { + "type": "object", + "required": [ + "user_bank_options" + ], + "properties": { + "user_bank_options": { + "type": "object", + "required": [ + "options" + ], + "properties": { + "options": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, { "type": "string", "enum": [ diff --git a/api-reference/v2/openapi_spec_v2.json b/api-reference/v2/openapi_spec_v2.json index 53bbace7dfb..ecd899a3728 100644 --- a/api-reference/v2/openapi_spec_v2.json +++ b/api-reference/v2/openapi_spec_v2.json @@ -11096,6 +11096,28 @@ "user_bank" ] }, + { + "type": "object", + "required": [ + "user_bank_options" + ], + "properties": { + "user_bank_options": { + "type": "object", + "required": [ + "options" + ], + "properties": { + "options": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, { "type": "string", "enum": [ diff --git a/crates/api_models/src/enums.rs b/crates/api_models/src/enums.rs index df1827053a2..cad510b26de 100644 --- a/crates/api_models/src/enums.rs +++ b/crates/api_models/src/enums.rs @@ -257,6 +257,7 @@ pub enum FieldType { UserSocialSecurityNumber, UserBlikCode, UserBank, + UserBankOptions { options: Vec<String> }, UserBankAccountNumber, UserSourceBankAccountId, UserDestinationBankAccountId, diff --git a/crates/payment_methods/src/configs/payment_connector_required_fields.rs b/crates/payment_methods/src/configs/payment_connector_required_fields.rs index ec3ea46ccd2..2dd291d16f5 100644 --- a/crates/payment_methods/src/configs/payment_connector_required_fields.rs +++ b/crates/payment_methods/src/configs/payment_connector_required_fields.rs @@ -173,6 +173,7 @@ enum RequiredField { BanContactCardExpYear, IdealBankName, EpsBankName, + EpsBankOptions(HashSet<enums::BankNames>), BlikCode, MifinityDateOfBirth, MifinityLanguagePreference(Vec<&'static str>), @@ -610,6 +611,17 @@ impl RequiredField { value: None, }, ), + Self::EpsBankOptions(bank) => ( + "payment_method_data.bank_redirect.eps.bank_name".to_string(), + RequiredFieldInfo { + required_field: "payment_method_data.bank_redirect.eps.bank_name".to_string(), + display_name: "bank_name".to_string(), + field_type: FieldType::UserBankOptions { + options: bank.iter().map(\|bank\| bank.to_string()).collect(), + }, + value: None, + }, + ), Self::BlikCode => ( "payment_method_data.bank_redirect.blik.blik_code".to_string(), RequiredFieldInfo { @@ -2015,6 +2027,71 @@ fn get_bank_redirect_required_fields() -> HashMap<enums::PaymentMethodType, Conn "billing_name", FieldType::UserFullName, ), + RequiredField::EpsBankOptions( + vec![ + enums::BankNames::AbnAmro, + enums::BankNames::ArzteUndApothekerBank, + enums::BankNames::AsnBank, + enums::BankNames::AustrianAnadiBankAg, + enums::BankNames::BankAustria, + enums::BankNames::BankhausCarlSpangler, + enums::BankNames::BankhausSchelhammerUndSchatteraAg, + enums::BankNames::BawagPskAg, + enums::BankNames::BksBankAg, + enums::BankNames::BrullKallmusBankAg, + enums::BankNames::BtvVierLanderBank, + enums::BankNames::Bunq, + enums::BankNames::CapitalBankGraweGruppeAg, + enums::BankNames::Citi, + enums::BankNames::Dolomitenbank, + enums::BankNames::EasybankAg, + enums::BankNames::ErsteBankUndSparkassen, + enums::BankNames::Handelsbanken, + enums::BankNames::HypoAlpeadriabankInternationalAg, + enums::BankNames::HypoNoeLbFurNiederosterreichUWien, + enums::BankNames::HypoOberosterreichSalzburgSteiermark, + enums::BankNames::HypoTirolBankAg, + enums::BankNames::HypoVorarlbergBankAg, + enums::BankNames::HypoBankBurgenlandAktiengesellschaft, + enums::BankNames::Ing, + enums::BankNames::Knab, + enums::BankNames::MarchfelderBank, + enums::BankNames::OberbankAg, + enums::BankNames::RaiffeisenBankengruppeOsterreich, + enums::BankNames::Rabobank, + enums::BankNames::Regiobank, + enums::BankNames::Revolut, + enums::BankNames::SnsBank, + enums::BankNames::TriodosBank, + enums::BankNames::VanLanschot, + enums::BankNames::Moneyou, + enums::BankNames::SchoellerbankAg, + enums::BankNames::SpardaBankWien, + enums::BankNames::VolksbankGruppe, + enums::BankNames::VolkskreditbankAg, + enums::BankNames::VrBankBraunau, + enums::BankNames::PlusBank, + enums::BankNames::EtransferPocztowy24, + enums::BankNames::BankiSpbdzielcze, + enums::BankNames::BankNowyBfgSa, + enums::BankNames::GetinBank, + enums::BankNames::Blik, + enums::BankNames::NoblePay, + enums::BankNames::IdeaBank, + enums::BankNames::EnveloBank, + enums::BankNames::NestPrzelew, + enums::BankNames::MbankMtransfer, + enums::BankNames::Inteligo, + enums::BankNames::PbacZIpko, + enums::BankNames::BnpParibas, + enums::BankNames::BankPekaoSa, + enums::BankNames::VolkswagenBank, + enums::BankNames::AliorBank, + enums::BankNames::Boz, + ] + .into_iter() + .collect(), + ), RequiredField::BillingLastName("billing_name", FieldType::UserFullName), ], vec![],	2025-07-08T11:26:24Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [x] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> Make bank_name field for EPS in stripe mandatore ### Additional Changes - [x] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> <details> <summary>Payment Request</summary> ```json { "payment_id": "pay_6W7NAlavGWBsNle4fjCm", "merchant_id": "merchant_1751973151", "status": "requires_payment_method", "amount": 6500, "net_amount": 6500, "amount_capturable": 0, "client_secret": "pay_6W7NAlavGWBsNle4fjCm_secret_cGp7blq0k5NBezW6gCmH", "created": "2025-07-08T11:49:13.894Z", "currency": "EUR", "customer_id": "hyperswitch_sdk_demo_id", "customer": { "id": "hyperswitch_sdk_demo_id", "email": "[email protected]" }, "description": "Hello this is description", "setup_future_usage": "on_session", "capture_method": "automatic", "shipping": { "address": { "city": "Banglore", "country": "AT", "line1": "sdsdfsdf", "line2": "hsgdbhd", "line3": "alsksoe", "zip": "571201", "state": "California", "first_name": "John", "last_name": "Doe" }, "phone": { "number": "123456789", "country_code": "+1" } }, "billing": { "address": { "city": "San Fransico", "country": "AT", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "joseph", "last_name": "Doe" }, "phone": { "number": "8056594427", "country_code": "+91" } }, "order_details": [ { "amount": 6500, "quantity": 1, "product_name": "Apple iphone 15" } ], "email": "[email protected]", "business_label": "default", "ephemeral_key": { "customer_id": "hyperswitch_sdk_demo_id", "created_at": 1751975353, "expires": 1751978953, "secret": "epk_78740ac9b3a7426e9ed57c14c801fb4f" }, "metadata": { "udf1": "value1", "login_date": "2019-09-10T10:11:12Z", "new_customer": "true" }, "connector_metadata": { "noon": { "order_category": "applepay" } }, "profile_id": "pro_2UxGWjdVxvRMEw6zBI2V", "attempt_count": 1, "external_3ds_authentication_attempted": false, "expires_on": "2025-07-08T12:04:13.894Z", "updated": "2025-07-08T11:49:13.908Z", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false } ``` </details> <details> <summary> Supported payment methods has bank_name mandatory </summary> ```json { "redirect_url": "https://google.com/success", "currency": "EUR", "payment_methods": [ { "payment_method": "bank_redirect", "payment_method_types": [ { "payment_method_type": "eps", "bank_names": [ { "bank_name": [ "easybank_ag", "bank_austria", "hypo_tirol_bank_ag", "hypo_alpeadriabank_international_ag", "sparda_bank_wien", "bankhaus_schelhammer_und_schattera_ag", "erste_bank_und_sparkassen", "vr_bank_braunau", "raiffeisen_bankengruppe_osterreich", "volksbank_gruppe", "bankhaus_carl_spangler", "bawag_psk_ag", "hypo_noe_lb_fur_niederosterreich_u_wien", "hypo_bank_burgenland_aktiengesellschaft", "hypo_vorarlberg_bank_ag", "dolomitenbank", "marchfelder_bank", "oberbank_ag", "bks_bank_ag", "arzte_und_apotheker_bank", "btv_vier_lander_bank", "hypo_oberosterreich_salzburg_steiermark", "volkskreditbank_ag", "austrian_anadi_bank_ag", "brull_kallmus_bank_ag", "capital_bank_grawe_gruppe_ag", "schoellerbank_ag" ], "eligible_connectors": ["stripe"] } ], "required_fields": { "billing.address.first_name": { "required_field": "payment_method_data.billing.address.first_name", "display_name": "billing_name", "field_type": "user_full_name", "value": "joseph" }, "payment_method_data.bank_redirect.eps.bank_name": { "required_field": "payment_method_data.bank_redirect.eps.bank_name", "display_name": "bank_name", "field_type": { "user_bank_options": { "options": [ "triodos_bank", "austrian_anadi_bank_ag", "boz", "brull_kallmus_bank_ag", "pbac_z_ipko", "schoellerbank_ag", "hypo_oberosterreich_salzburg_steiermark", "bank_pekao_sa", "bnp_paribas", "asn_bank", "hypo_alpeadriabank_international_ag", "plus_bank", "volkswagen_bank", "sparda_bank_wien", "sns_bank", "hypo_tirol_bank_ag", "knab", "citi", "bunq", "bks_bank_ag", "mbank_mtransfer", "dolomitenbank", "idea_bank", "rabobank", "getin_bank", "raiffeisen_bankengruppe_osterreich", "bankhaus_carl_spangler", "van_lanschot", "envelo_bank", "volkskreditbank_ag", "banki_spbdzielcze", "etransfer_pocztowy24", "btv_vier_lander_bank", "easybank_ag", "bawag_psk_ag", "noble_pay", "capital_bank_grawe_gruppe_ag", "moneyou", "blik", "regiobank", "arzte_und_apotheker_bank", "abn_amro", "marchfelder_bank", "handelsbanken", "erste_bank_und_sparkassen", "volksbank_gruppe", "ing", "bankhaus_schelhammer_und_schattera_ag", "revolut", "bank_austria", "hypo_vorarlberg_bank_ag", "hypo_bank_burgenland_aktiengesellschaft", "vr_bank_braunau", "bank_nowy_bfg_sa", "nest_przelew", "alior_bank", "hypo_noe_lb_fur_niederosterreich_u_wien", "inteligo", "oberbank_ag" ] } } }, "billing.address.last_name": { "required_field": "payment_method_data.billing.address.last_name", "display_name": "billing_name", "field_type": "user_full_name", "value": "Doe" } } } ] } ], "merchant_name": "NewAge Retailer", "show_surcharge_breakup_screen": false, "payment_type": "normal", "request_external_three_ds_authentication": false, "collect_shipping_details_from_wallets": false, "collect_billing_details_from_wallets": false, "is_tax_calculation_enabled": false } ``` </details> <img width="1728" alt="Screenshot 2025-07-09 at 4 49 05 PM" src="https://github.com/user-attachments/assets/8a6cef3f-df11-411e-89d1-41ad5d1618ac" /> ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	99885b699d7524e87697f78608e6f2b36c9d8a8e	99885b699d7524e87697f78608e6f2b36c9d8a8e
juspay/hyperswitch	juspay__hyperswitch-8566	Bug: [REFACTOR] raw_connector_response as secret refactor raw_connector_response as secret	diff --git a/crates/api_models/src/payments.rs b/crates/api_models/src/payments.rs index 13cd8fa472f..f3d7d9b675c 100644 --- a/crates/api_models/src/payments.rs +++ b/crates/api_models/src/payments.rs @@ -5186,7 +5186,8 @@ pub struct PaymentsResponse { pub is_iframe_redirection_enabled: Option<bool>, /// Contains whole connector response - pub whole_connector_response: Option<String>, + #[schema(value_type = Option<String>)] + pub whole_connector_response: Option<Secret<String>>, } #[cfg(feature = "v2")] @@ -5805,7 +5806,8 @@ pub struct PaymentsResponse { pub merchant_reference_id: Option<id_type::PaymentReferenceId>, /// Stringified connector raw response body. Only returned if `return_raw_connector_response` is true - pub raw_connector_response: Option<String>, + #[schema(value_type = Option<String>)] + pub raw_connector_response: Option<Secret<String>>, } #[cfg(feature = "v2")] diff --git a/crates/common_types/src/domain.rs b/crates/common_types/src/domain.rs index 6b5d1cf835d..e800cb9cb61 100644 --- a/crates/common_types/src/domain.rs +++ b/crates/common_types/src/domain.rs @@ -5,6 +5,8 @@ use std::collections::HashMap; use common_enums::enums; use common_utils::{impl_to_sql_from_sql_json, types::MinorUnit}; use diesel::{sql_types::Jsonb, AsExpression, FromSqlRow}; +#[cfg(feature = "v2")] +use masking::Secret; use serde::{Deserialize, Serialize}; use utoipa::ToSchema; @@ -104,10 +106,10 @@ pub struct MerchantConnectorAuthDetails { pub merchant_connector_creds: common_utils::pii::SecretSerdeValue, } -/// Connector Response Data that are required to be populated in response +/// Connector Response Data that are required to be populated in response, but not persisted in DB. #[cfg(feature = "v2")] #[derive(Clone, Debug)] pub struct ConnectorResponseData { /// Stringified connector raw response body - pub raw_connector_response: Option<String>, + pub raw_connector_response: Option<Secret<String>>, } diff --git a/crates/hyperswitch_connectors/src/connectors/razorpay.rs b/crates/hyperswitch_connectors/src/connectors/razorpay.rs index 33cdc326987..cdb636aab58 100644 --- a/crates/hyperswitch_connectors/src/connectors/razorpay.rs +++ b/crates/hyperswitch_connectors/src/connectors/razorpay.rs @@ -10,6 +10,7 @@ use common_utils::{ }; use error_stack::{report, Report, ResultExt}; use hyperswitch_domain_models::{ + payment_method_data::PaymentMethodData, router_data::{AccessToken, ConnectorAuthType, ErrorResponse, RouterData}, router_flow_types::{ access_token_auth::AccessTokenAuth, @@ -315,10 +316,16 @@ impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData _req: &PaymentsAuthorizeRouterData, connectors: &Connectors, ) -> CustomResult<String, errors::ConnectorError> { - Ok(format!( - "{}v1/payments/create/upi", - self.base_url(connectors) - )) + match _req.request.payment_method_data { + PaymentMethodData::Upi(_) => Ok(format!( + "{}v1/payments/create/upi", + self.base_url(connectors) + )), + _ => Err(errors::ConnectorError::NotImplemented( + "Payment method not implemented for Razorpay".to_string(), + ) + .into()), + } } fn get_request_body( diff --git a/crates/hyperswitch_domain_models/src/router_data.rs b/crates/hyperswitch_domain_models/src/router_data.rs index a18f9e5dc6e..259f280d49b 100644 --- a/crates/hyperswitch_domain_models/src/router_data.rs +++ b/crates/hyperswitch_domain_models/src/router_data.rs @@ -104,7 +104,7 @@ pub struct RouterData<Flow, Request, Response> { pub psd2_sca_exemption_type: Option<common_enums::ScaExemptionType>, /// Contains stringified connector raw response body - pub raw_connector_response: Option<String>, + pub raw_connector_response: Option<Secret<String>>, /// Indicates whether the payment ID was provided by the merchant (true), /// or generated internally by Hyperswitch (false) @@ -1260,7 +1260,6 @@ impl resource_id, redirection_data, connector_metadata, - connector_response_reference_id, .. } => { let attempt_status = self.get_attempt_status_for_db_update(payment_data); @@ -1289,9 +1288,7 @@ impl token_details.get_connector_token_request_reference_id() }), ), - - connector_response_reference_id: connector_response_reference_id - .clone(), + connector_response_reference_id: None, }, )) } diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs index 5319e823614..cf45d15a5a1 100644 --- a/crates/router/src/core/payments.rs +++ b/crates/router/src/core/payments.rs @@ -6549,7 +6549,7 @@ where Option<hyperswitch_domain_models::card_testing_guard_data::CardTestingGuardData>, pub vault_operation: Option<domain_payments::VaultOperation>, pub threeds_method_comp_ind: Option<api_models::payments::ThreeDsCompletionIndicator>, - pub whole_connector_response: Option<String>, + pub whole_connector_response: Option<Secret<String>>, } #[derive(Clone, serde::Serialize, Debug)] @@ -9446,7 +9446,7 @@ pub trait OperationSessionGetters<F> { fn get_connector_customer_id(&self) -> Option<String>; #[cfg(feature = "v1")] - fn get_whole_connector_response(&self) -> Option<String>; + fn get_whole_connector_response(&self) -> Option<Secret<String>>; #[cfg(feature = "v1")] fn get_vault_operation(&self) -> Option<&domain_payments::VaultOperation>; @@ -9673,7 +9673,7 @@ impl<F: Clone> OperationSessionGetters<F> for PaymentData<F> { self.all_keys_required } - fn get_whole_connector_response(&self) -> Option<String> { + fn get_whole_connector_response(&self) -> Option<Secret<String>> { self.whole_connector_response.clone() } diff --git a/crates/router/src/core/payments/flows/authorize_flow.rs b/crates/router/src/core/payments/flows/authorize_flow.rs index f42efa0c1e4..21215ea7235 100644 --- a/crates/router/src/core/payments/flows/authorize_flow.rs +++ b/crates/router/src/core/payments/flows/authorize_flow.rs @@ -5,7 +5,7 @@ use error_stack::ResultExt; use hyperswitch_domain_models::errors::api_error_response::ApiErrorResponse; #[cfg(feature = "v2")] use hyperswitch_domain_models::payments::PaymentConfirmData; -use masking::ExposeInterface; +use masking::{ExposeInterface, Secret}; use unified_connector_service_client::payments as payments_grpc; // use router_env::tracing::Instrument; @@ -555,7 +555,9 @@ impl Feature<api::Authorize, types::PaymentsAuthorizeData> for types::PaymentsAu self.status = status; self.response = router_data_response; - self.raw_connector_response = payment_authorize_response.raw_connector_response; + self.raw_connector_response = payment_authorize_response + .raw_connector_response + .map(Secret::new); Ok(()) } diff --git a/crates/router/src/core/payments/flows/psync_flow.rs b/crates/router/src/core/payments/flows/psync_flow.rs index e27c9974406..84752f16520 100644 --- a/crates/router/src/core/payments/flows/psync_flow.rs +++ b/crates/router/src/core/payments/flows/psync_flow.rs @@ -2,6 +2,7 @@ use std::collections::HashMap; use async_trait::async_trait; use error_stack::ResultExt; +use masking::Secret; use unified_connector_service_client::payments as payments_grpc; use super::{ConstructFlowSpecificData, Feature}; @@ -256,7 +257,7 @@ impl Feature<api::PSync, types::PaymentsSyncData> self.status = status; self.response = router_data_response; - self.raw_connector_response = payment_get_response.raw_connector_response; + self.raw_connector_response = payment_get_response.raw_connector_response.map(Secret::new); Ok(()) } diff --git a/crates/router/src/core/payments/operations/payment_confirm_intent.rs b/crates/router/src/core/payments/operations/payment_confirm_intent.rs index 5de3b754083..143d6f7d342 100644 --- a/crates/router/src/core/payments/operations/payment_confirm_intent.rs +++ b/crates/router/src/core/payments/operations/payment_confirm_intent.rs @@ -597,6 +597,7 @@ impl<F: Clone + Sync> UpdateTracker<F, PaymentConfirmData<F>, PaymentsConfirmInt .connector_request_reference_id .clone(); + // Updates payment_attempt for cases where authorize flow is not performed. let connector_response_reference_id = payment_data .payment_attempt .connector_response_reference_id diff --git a/crates/router/src/services/api.rs b/crates/router/src/services/api.rs index fabfe3e38d2..9b6c091a577 100644 --- a/crates/router/src/services/api.rs +++ b/crates/router/src/services/api.rs @@ -45,7 +45,7 @@ pub use hyperswitch_interfaces::{ BoxedConnectorIntegrationV2, ConnectorIntegrationAnyV2, ConnectorIntegrationV2, }, }; -use masking::{Maskable, PeekInterface}; +use masking::{Maskable, PeekInterface, Secret}; use router_env::{instrument, tracing, tracing_actix_web::RequestId, Tag}; use serde::Serialize; use serde_json::json; @@ -310,7 +310,8 @@ where .trim_start_matches('\u{feff}') .to_string(); } - data.raw_connector_response = Some(decoded); + data.raw_connector_response = + Some(Secret::new(decoded)); } Ok(data) }	2025-07-07T08:27:00Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [ ] New feature - [ ] Enhancement - [x] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> This PR makes raw_connector_response as a Secret and it also addresses unresolved comments of https://github.com/juspay/hyperswitch/pull/8499 ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> Payments - Create ``` curl --location 'http://localhost:8080/v2/payments' \ --header 'Content-Type: application/json' \ --header 'x-profile-id: pro_2Epn3j4dw4PTTcAeiYCq' \ --header 'Authorization: api-key=dev_rVjIA9bnmFxbtjq0nZeACzzLz9mqAMLNNRBG26wWmCMnkUb3kAs2MaPXR0Nlxzkx' \ --data-raw '{ "amount_details": { "currency": "USD", "order_amount": 6540 }, "payment_method_data": { "card": { "card_cvc": "123", "card_exp_month": "10", "card_exp_year": "25", "card_holder_name": "joseph Doe", "card_number": "4242424242424242" }, "billing": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "IN", "first_name": "Swangi", "last_name": "Kumari" }, "phone": { "number": "8056594427", "country_code": "+91" }, "email": "[email protected]" } }, "payment_method_subtype": "credit", "payment_method_type": "card", "return_raw_connector_response": true }' ``` Response ``` { "id": "12345_pay_0197ede6d02c77d1a499530bf675e725", "status": "succeeded", "amount": { "order_amount": 6540, "currency": "USD", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null, "net_amount": 6540, "amount_to_capture": null, "amount_capturable": 0, "amount_captured": 6540 }, "customer_id": null, "connector": "stripe", "created": "2025-07-09T06:36:56.236Z", "payment_method_data": { "billing": { "address": { "city": "San Fransico", "country": "IN", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "Swangi", "last_name": "Kumari" }, "phone": { "number": "8056594427", "country_code": "+91" }, "email": "[email protected]" } }, "payment_method_type": "card", "payment_method_subtype": "credit", "connector_transaction_id": "pi_3RirciD5R7gDAGff0JSMZ9vN", "connector_reference_id": "pi_3RirciD5R7gDAGff0JSMZ9vN", "merchant_connector_id": "mca_afJBIsuaoPHhNuVG2CCo", "browser_info": null, "error": null, "shipping": null, "billing": null, "attempts": null, "connector_token_details": { "token": "pm_1RirciD5R7gDAGff9P1tYKQk", "connector_token_request_reference_id": "cRhwNEwZyiEAeSeCCv" }, "payment_method_id": null, "next_action": null, "return_url": "https://google.com/success", "authentication_type": null, "authentication_type_applied": "no_three_ds", "is_iframe_redirection_enabled": null, "merchant_reference_id": null, "raw_connector_response": "{\n \"id\": \"pi_3RirciD5R7gDAGff0JSMZ9vN\",\n \"object\": \"payment_intent\",\n \"amount\": 6540,\n \"amount_capturable\": 0,\n \"amount_details\": {\n \"tip\": {}\n },\n \"amount_received\": 6540,\n \"application\": null,\n \"application_fee_amount\": null,\n \"automatic_payment_methods\": null,\n \"canceled_at\": null,\n \"cancellation_reason\": null,\n \"capture_method\": \"automatic\",\n \"client_secret\": \"pi_3RirciD5R7gDAGff0JSMZ9vN_secret_UW4tYLvjQrDi7NHt8Scv7Bade\",\n \"confirmation_method\": \"automatic\",\n \"created\": 1752043016,\n \"currency\": \"usd\",\n \"customer\": null,\n \"description\": null,\n \"invoice\": null,\n \"last_payment_error\": null,\n \"latest_charge\": {\n \"id\": \"ch_3RirciD5R7gDAGff0T483Brp\",\n \"object\": \"charge\",\n \"amount\": 6540,\n \"amount_captured\": 6540,\n \"amount_refunded\": 0,\n \"amount_updates\": [],\n \"application\": null,\n \"application_fee\": null,\n \"application_fee_amount\": null,\n \"balance_transaction\": \"txn_3RirciD5R7gDAGff0YvvPlkn\",\n \"billing_details\": {\n \"address\": {\n \"city\": \"San Fransico\",\n \"country\": \"IN\",\n \"line1\": \"1467\",\n \"line2\": \"Harrison Street\",\n \"postal_code\": \"94122\",\n \"state\": \"California\"\n },\n \"email\": \"[email protected]\",\n \"name\": \"Swangi Kumari\",\n \"phone\": \"8056594427\",\n \"tax_id\": null\n },\n \"calculated_statement_descriptor\": \"D2CSTORE0\",\n \"captured\": true,\n \"created\": 1752043017,\n \"currency\": \"usd\",\n \"customer\": null,\n \"description\": null,\n \"destination\": null,\n \"dispute\": null,\n \"disputed\": false,\n \"failure_balance_transaction\": null,\n \"failure_code\": null,\n \"failure_message\": null,\n \"fraud_details\": {},\n \"invoice\": null,\n \"livemode\": false,\n \"metadata\": {\n \"order_id\": \"12345_att_0197ede6d0497bc3b00553f0bd9bf01c\"\n },\n \"on_behalf_of\": null,\n \"order\": null,\n \"outcome\": {\n \"advice_code\": null,\n \"network_advice_code\": null,\n \"network_decline_code\": null,\n \"network_status\": \"approved_by_network\",\n \"reason\": null,\n \"risk_level\": \"normal\",\n \"risk_score\": 4,\n \"rule\": \"allow_if_in_allowlist\",\n \"seller_message\": \"Payment complete.\",\n \"type\": \"authorized\"\n },\n \"paid\": true,\n \"payment_intent\": \"pi_3RirciD5R7gDAGff0JSMZ9vN\",\n \"payment_method\": \"pm_1RirciD5R7gDAGff9P1tYKQk\",\n \"payment_method_details\": {\n \"card\": {\n \"amount_authorized\": 6540,\n \"authorization_code\": \"667270\",\n \"brand\": \"visa\",\n \"checks\": {\n \"address_line1_check\": \"pass\",\n \"address_postal_code_check\": \"pass\",\n \"cvc_check\": \"pass\"\n },\n \"country\": \"US\",\n \"exp_month\": 10,\n \"exp_year\": 2025,\n \"extended_authorization\": {\n \"status\": \"disabled\"\n },\n \"fingerprint\": \"h7L3P7Ht9VtwZ6yb\",\n \"funding\": \"credit\",\n \"incremental_authorization\": {\n \"status\": \"unavailable\"\n },\n \"installments\": null,\n \"last4\": \"4242\",\n \"mandate\": null,\n \"multicapture\": {\n \"status\": \"unavailable\"\n },\n \"network\": \"visa\",\n \"network_token\": {\n \"used\": false\n },\n \"network_transaction_id\": \"104557651805572\",\n \"overcapture\": {\n \"maximum_amount_capturable\": 6540,\n \"status\": \"unavailable\"\n },\n \"regulated_status\": \"unregulated\",\n \"three_d_secure\": null,\n \"wallet\": null\n },\n \"type\": \"card\"\n },\n \"radar_options\": {},\n \"receipt_email\": null,\n \"receipt_number\": null,\n \"receipt_url\": \"https://pay.stripe.com/receipts/payment/CAcaFwoVYWNjdF8xTTdmVGFENVI3Z0RBR2ZmKImcuMMGMgZ0E_VSu6k6LBYDbs4wzaE7cYX2DHDMygwy6f_E0Q1SGSjyRrHheoBChPHBQVxXj4zo7kwE\",\n \"refunded\": false,\n \"review\": null,\n \"shipping\": null,\n \"source\": null,\n \"source_transfer\": null,\n \"statement_descriptor\": null,\n \"statement_descriptor_suffix\": null,\n \"status\": \"succeeded\",\n \"transfer_data\": null,\n \"transfer_group\": null\n },\n \"livemode\": false,\n \"metadata\": {\n \"order_id\": \"12345_att_0197ede6d0497bc3b00553f0bd9bf01c\"\n },\n \"next_action\": null,\n \"on_behalf_of\": null,\n \"payment_method\": \"pm_1RirciD5R7gDAGff9P1tYKQk\",\n \"payment_method_configuration_details\": null,\n \"payment_method_options\": {\n \"card\": {\n \"installments\": null,\n \"mandate_options\": null,\n \"network\": null,\n \"request_three_d_secure\": \"automatic\"\n }\n },\n \"payment_method_types\": [\n \"card\"\n ],\n \"processing\": null,\n \"receipt_email\": null,\n \"review\": null,\n \"setup_future_usage\": \"on_session\",\n \"shipping\": null,\n \"source\": null,\n \"statement_descriptor\": null,\n \"statement_descriptor_suffix\": null,\n \"status\": \"succeeded\",\n \"transfer_data\": null,\n \"transfer_group\": null\n}" } ``` The raw_connector_response was a JSON in logs, now it is a Secret ![image](https://github.com/user-attachments/assets/ce19a048-0bca-43e6-b293-7940b0cedd4f) ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	cb83bf8c2f4486fee99f88bc85bd6e6cb4430e13	cb83bf8c2f4486fee99f88bc85bd6e6cb4430e13
juspay/hyperswitch	juspay__hyperswitch-8564	Bug: chore: Conditoinal config for invoking DE routing There should be a conditional check for Decision Engine (DE) Euclid API integration within the static routing flow. Right now, the system always attempted to perform Euclid-based routing regardless of configuration. With this change, the Euclid routing flow is invoked only if the OpenRouter URL is configured.	diff --git a/config/config.example.toml b/config/config.example.toml index 3c6da56b240..02224da9024 100644 --- a/config/config.example.toml +++ b/config/config.example.toml @@ -1094,7 +1094,8 @@ background_color = "#FFFFFF" billing_connectors_which_require_payment_sync = "stripebilling, recurly" # List of billing connectors which has payment sync api call [open_router] -enabled = true # Enable or disable Open Router +dynamic_routing_enabled = true # Enable or disable Open Router for dynamic routing +static_routing_enabled = true # Enable or disable Open Router for static routing url = "http://localhost:8080" # Open Router URL [grpc_client.unified_connector_service] diff --git a/config/development.toml b/config/development.toml index ab885503c85..ece582a388f 100644 --- a/config/development.toml +++ b/config/development.toml @@ -1189,7 +1189,8 @@ allow_connected_merchants = true click_to_pay = {connector_list = "adyen, cybersource"} [open_router] -enabled = false +dynamic_routing_enabled = false +static_routing_enabled = false url = "http://localhost:8080" [grpc_client.unified_connector_service] diff --git a/crates/router/src/configs/settings.rs b/crates/router/src/configs/settings.rs index ee7b3ed820e..6157a4fab20 100644 --- a/crates/router/src/configs/settings.rs +++ b/crates/router/src/configs/settings.rs @@ -175,7 +175,8 @@ pub struct DebitRoutingConfig { #[derive(Debug, Deserialize, Clone, Default)] pub struct OpenRouter { - pub enabled: bool, + pub dynamic_routing_enabled: bool, + pub static_routing_enabled: bool, pub url: String, } @@ -1080,6 +1081,8 @@ impl Settings<SecuredSecret> { self.platform.validate()?; + self.open_router.validate()?; + Ok(()) } } diff --git a/crates/router/src/configs/validations.rs b/crates/router/src/configs/validations.rs index ab5f2af4160..4fc254760a0 100644 --- a/crates/router/src/configs/validations.rs +++ b/crates/router/src/configs/validations.rs @@ -327,3 +327,19 @@ impl super::settings::Platform { }) } } + +impl super::settings::OpenRouter { + pub fn validate(&self) -> Result<(), ApplicationError> { + use common_utils::fp_utils::when; + + when( + (self.dynamic_routing_enabled \|\| self.static_routing_enabled) + && self.url.is_default_or_empty(), + \|\| { + Err(ApplicationError::InvalidConfigurationValueError( + "OpenRouter base URL must not be empty when it is enabled".into(), + )) + }, + ) + } +} diff --git a/crates/router/src/core/admin.rs b/crates/router/src/core/admin.rs index f362d413d3e..18772bd7100 100644 --- a/crates/router/src/core/admin.rs +++ b/crates/router/src/core/admin.rs @@ -1230,7 +1230,7 @@ pub async fn merchant_account_delete( // Call to DE here #[cfg(all(feature = "dynamic_routing", feature = "v1"))] { - if state.conf.open_router.enabled && is_deleted { + if state.conf.open_router.dynamic_routing_enabled && is_deleted { merchant_account .default_profile .as_ref() diff --git a/crates/router/src/core/debit_routing.rs b/crates/router/src/core/debit_routing.rs index d4f7c8bd753..651f1ea04c3 100644 --- a/crates/router/src/core/debit_routing.rs +++ b/crates/router/src/core/debit_routing.rs @@ -123,7 +123,7 @@ where F: Send + Clone, D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, { - if business_profile.is_debit_routing_enabled && state.conf.open_router.enabled { + if business_profile.is_debit_routing_enabled && state.conf.open_router.dynamic_routing_enabled { logger::info!("Debit routing is enabled for the profile"); let debit_routing_config = &state.conf.debit_routing_config; diff --git a/crates/router/src/core/health_check.rs b/crates/router/src/core/health_check.rs index 49138d3bda0..7bc65e4d0e4 100644 --- a/crates/router/src/core/health_check.rs +++ b/crates/router/src/core/health_check.rs @@ -194,7 +194,7 @@ impl HealthCheckInterface for app::SessionState { async fn health_check_decision_engine( &self, ) -> CustomResult<HealthState, errors::HealthCheckDecisionEngineError> { - if self.conf.open_router.enabled { + if self.conf.open_router.dynamic_routing_enabled { let url = format!("{}/{}", &self.conf.open_router.url, "health"); let request = services::Request::new(services::Method::Get, &url); let _ = services::call_connector_api(self, request, "health_check_for_decision_engine") diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs index 32b6aa1bfbd..8a0058b79e4 100644 --- a/crates/router/src/core/payments.rs +++ b/crates/router/src/core/payments.rs @@ -8409,7 +8409,7 @@ where .attach_printable("failed to perform volume split on routing type")?; if routing_choice.routing_type.is_dynamic_routing() { - if state.conf.open_router.enabled { + if state.conf.open_router.dynamic_routing_enabled { routing::perform_dynamic_routing_with_open_router( state, connectors.clone(), diff --git a/crates/router/src/core/payments/operations/payment_response.rs b/crates/router/src/core/payments/operations/payment_response.rs index e72555b2ede..7fa8a4858f8 100644 --- a/crates/router/src/core/payments/operations/payment_response.rs +++ b/crates/router/src/core/payments/operations/payment_response.rs @@ -2167,7 +2167,8 @@ async fn payment_response_update_tracker<F: Clone, T: types::Capturable>( ); tokio::spawn( async move { - let should_route_to_open_router = state.conf.open_router.enabled; + let should_route_to_open_router = + state.conf.open_router.dynamic_routing_enabled; if should_route_to_open_router { routing_helpers::update_gateway_score_helper_with_open_router( diff --git a/crates/router/src/core/payments/routing.rs b/crates/router/src/core/payments/routing.rs index c3823aa2f30..7feea3286ca 100644 --- a/crates/router/src/core/payments/routing.rs +++ b/crates/router/src/core/payments/routing.rs @@ -490,29 +490,33 @@ pub async fn perform_static_routing_v1( .to_string(), }; - let routing_events_wrapper = utils::RoutingEventsWrapper::new( - state.tenant.tenant_id.clone(), - state.request_id, - payment_id, - business_profile.get_id().to_owned(), - business_profile.merchant_id.to_owned(), - "DecisionEngine: Euclid Static Routing".to_string(), - None, - true, - false, - ); + let de_euclid_connectors = if state.conf.open_router.static_routing_enabled { + let routing_events_wrapper = utils::RoutingEventsWrapper::new( + state.tenant.tenant_id.clone(), + state.request_id, + payment_id, + business_profile.get_id().to_owned(), + business_profile.merchant_id.to_owned(), + "DecisionEngine: Euclid Static Routing".to_string(), + None, + true, + false, + ); - let de_euclid_connectors = perform_decision_euclid_routing( - state, - backend_input.clone(), - business_profile.get_id().get_string_repr().to_string(), - routing_events_wrapper - ) - .await - .map_err(\|e\| - // errors are ignored as this is just for diff checking as of now (optional flow). - logger::error!(decision_engine_euclid_evaluate_error=?e, "decision_engine_euclid: error in evaluation of rule") - ).unwrap_or_default(); + perform_decision_euclid_routing( + state, + backend_input.clone(), + business_profile.get_id().get_string_repr().to_string(), + routing_events_wrapper + ) + .await + .map_err(\|e\| + // errors are ignored as this is just for diff checking as of now (optional flow). + logger::error!(decision_engine_euclid_evaluate_error=?e, "decision_engine_euclid: error in evaluation of rule") + ).unwrap_or_default() + } else { + Vec::default() + }; let (routable_connectors, routing_approach) = match cached_algorithm.as_ref() { CachedAlgorithm::Single(conn) => ( diff --git a/crates/router/src/core/payments/routing/utils.rs b/crates/router/src/core/payments/routing/utils.rs index bef71d5fc66..d2167f88498 100644 --- a/crates/router/src/core/payments/routing/utils.rs +++ b/crates/router/src/core/payments/routing/utils.rs @@ -335,8 +335,6 @@ pub async fn perform_decision_euclid_routing( routing_event.set_routable_connectors(euclid_response.evaluated_output.clone()); state.event_handler.log_event(&routing_event); - // Need to log euclid response event here - logger::debug!(decision_engine_euclid_response=?euclid_response,"decision_engine_euclid"); logger::debug!(decision_engine_euclid_selected_connector=?euclid_response.evaluated_output,"decision_engine_euclid"); diff --git a/crates/router/src/core/routing.rs b/crates/router/src/core/routing.rs index ffd5f60e79d..52a3b4f1a7b 100644 --- a/crates/router/src/core/routing.rs +++ b/crates/router/src/core/routing.rs @@ -687,7 +687,7 @@ pub async fn link_routing_config( // Call to DE here to update SR configs #[cfg(all(feature = "dynamic_routing", feature = "v1"))] { - if state.conf.open_router.enabled { + if state.conf.open_router.dynamic_routing_enabled { update_decision_engine_dynamic_routing_setup( &state, business_profile.get_id(), @@ -718,7 +718,7 @@ pub async fn link_routing_config( ); #[cfg(all(feature = "dynamic_routing", feature = "v1"))] { - if state.conf.open_router.enabled { + if state.conf.open_router.dynamic_routing_enabled { update_decision_engine_dynamic_routing_setup( &state, business_profile.get_id(), @@ -1844,7 +1844,7 @@ pub async fn success_based_routing_update_configs( router_env::metric_attributes!(("profile_id", profile_id.clone())), ); - if !state.conf.open_router.enabled { + if !state.conf.open_router.dynamic_routing_enabled { state .grpc_client .dynamic_routing @@ -1948,7 +1948,7 @@ pub async fn elimination_routing_update_configs( router_env::metric_attributes!(("profile_id", profile_id.clone())), ); - if !state.conf.open_router.enabled { + if !state.conf.open_router.dynamic_routing_enabled { state .grpc_client .dynamic_routing diff --git a/crates/router/src/core/routing/helpers.rs b/crates/router/src/core/routing/helpers.rs index df9c11efe45..8b4c747d13f 100644 --- a/crates/router/src/core/routing/helpers.rs +++ b/crates/router/src/core/routing/helpers.rs @@ -1923,7 +1923,7 @@ pub async fn disable_dynamic_routing_algorithm( }; // Call to DE here - if state.conf.open_router.enabled { + if state.conf.open_router.dynamic_routing_enabled { disable_decision_engine_dynamic_routing_setup( state, business_profile.get_id(), @@ -2111,11 +2111,12 @@ pub async fn default_specific_dynamic_routing_setup( let timestamp = common_utils::date_time::now(); let algo = match dynamic_routing_type { routing_types::DynamicRoutingType::SuccessRateBasedRouting => { - let default_success_based_routing_config = if state.conf.open_router.enabled { - routing_types::SuccessBasedRoutingConfig::open_router_config_default() - } else { - routing_types::SuccessBasedRoutingConfig::default() - }; + let default_success_based_routing_config = + if state.conf.open_router.dynamic_routing_enabled { + routing_types::SuccessBasedRoutingConfig::open_router_config_default() + } else { + routing_types::SuccessBasedRoutingConfig::default() + }; routing_algorithm::RoutingAlgorithm { algorithm_id: algorithm_id.clone(), @@ -2132,11 +2133,12 @@ pub async fn default_specific_dynamic_routing_setup( } } routing_types::DynamicRoutingType::EliminationRouting => { - let default_elimination_routing_config = if state.conf.open_router.enabled { - routing_types::EliminationRoutingConfig::open_router_config_default() - } else { - routing_types::EliminationRoutingConfig::default() - }; + let default_elimination_routing_config = + if state.conf.open_router.dynamic_routing_enabled { + routing_types::EliminationRoutingConfig::open_router_config_default() + } else { + routing_types::EliminationRoutingConfig::default() + }; routing_algorithm::RoutingAlgorithm { algorithm_id: algorithm_id.clone(), profile_id: profile_id.clone(), @@ -2162,7 +2164,7 @@ pub async fn default_specific_dynamic_routing_setup( // Call to DE here // Need to map out the cases if this call should always be made or not - if state.conf.open_router.enabled { + if state.conf.open_router.dynamic_routing_enabled { enable_decision_engine_dynamic_routing_setup( state, business_profile.get_id(),	2025-07-06T15:12:12Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [x] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description This PR introduces a conditional check for Decision Engine (DE) Euclid API integration within the static routing flow. Previously, the system always attempted to perform Euclid-based routing regardless of configuration. With this change, the Euclid routing flow is invoked only if the OpenRouter URL is configured. Additionally, some unused or redundant code around logging and comments has been cleaned up in `utils.rs`. ## Outcomes - Prevents unnecessary calls to the Euclid API when the OpenRouter URL is not configured, reducing overhead and potential timeouts. - Ensures cleaner and more consistent logs by removing redundant debug statements and placeholders. - Improves maintainability by scoping the Euclid integration behind a clear configuration flag. ## Diff Hunk Explanation ### `crates/router/src/core/payments/routing.rs` - Wrapped the `perform_decision_euclid_routing` call with a check for `state.conf.open_router.url`. - Added a fallback to return an empty connector list if OpenRouter is not configured. ### `crates/router/src/core/payments/routing/utils.rs` - Removed a redundant placeholder comment about logging Euclid response events. - Streamlined debug logs for Euclid responses. This PR addresses an integration improvement for Euclid static routing checks in the decision engine. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [x] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> Can be tested directly in prod as that is the only environment where this env in missing. ## Checklist <!-- Put an `x` in the boxes that apply --> - [ ] I formatted the code `cargo +nightly fmt --all` - [ ] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	eb94cfe7e558348e8da3aeaaa01224a1ea2dbbe2	eb94cfe7e558348e8da3aeaaa01224a1ea2dbbe2
juspay/hyperswitch	juspay__hyperswitch-8557	Bug: [FEATURE] [CONNECTOR: PAYLOAD] Add Webhook support connector does not support signature verification. - https://docs.payload.com/apis/webhooks/ - https://docs.payload.com/apis/webhooks/triggers/ - https://docs.payload.com/apis/webhooks/oauth/ - https://docs.payload.com/apis/object-reference/webhook/ - https://docs.payload.com/apis/object-reference/webhook-logs/ - https://docs.payload.com/apis/authentication/ - https://docs.payload.com/apis/api-design/	diff --git a/crates/api_models/src/webhooks.rs b/crates/api_models/src/webhooks.rs index 177310de18f..75af0b19cf2 100644 --- a/crates/api_models/src/webhooks.rs +++ b/crates/api_models/src/webhooks.rs @@ -10,9 +10,9 @@ use crate::{disputes, enums as api_enums, mandates, payments, refunds}; #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize, Copy)] #[serde(rename_all = "snake_case")] pub enum IncomingWebhookEvent { - /// Authorization + Capture success - PaymentIntentFailure, /// Authorization + Capture failure + PaymentIntentFailure, + /// Authorization + Capture success PaymentIntentSuccess, PaymentIntentProcessing, PaymentIntentPartiallyFunded, diff --git a/crates/connector_configs/toml/development.toml b/crates/connector_configs/toml/development.toml index a8a0baa2661..cdf94d6e439 100644 --- a/crates/connector_configs/toml/development.toml +++ b/crates/connector_configs/toml/development.toml @@ -6328,8 +6328,7 @@ type="Text" payment_method_type = "Visa" [payload.connector_auth.HeaderKey] api_key="API Key" -[payload.connector_webhook_details] -merchant_secret="Source verification key" + [silverflow] [silverflow.connector_auth.BodyKey] api_key="API Key" diff --git a/crates/connector_configs/toml/production.toml b/crates/connector_configs/toml/production.toml index a22b50a9b4f..b9a98f5aedd 100644 --- a/crates/connector_configs/toml/production.toml +++ b/crates/connector_configs/toml/production.toml @@ -4935,10 +4935,8 @@ type="Text" payment_method_type = "Visa" [payload.connector_auth.HeaderKey] api_key="API Key" -[payload.connector_webhook_details] -merchant_secret="Source verification key" [silverflow] [silverflow.connector_auth.BodyKey] api_key="API Key" -key1="Secret Key" \ No newline at end of file +key1="Secret Key" diff --git a/crates/connector_configs/toml/sandbox.toml b/crates/connector_configs/toml/sandbox.toml index d7026129699..21801d380b5 100644 --- a/crates/connector_configs/toml/sandbox.toml +++ b/crates/connector_configs/toml/sandbox.toml @@ -6302,8 +6302,7 @@ type="Text" payment_method_type = "Visa" [payload.connector_auth.HeaderKey] api_key="API Key" -[payload.connector_webhook_details] -merchant_secret="Source verification key" + [silverflow] [silverflow.connector_auth.BodyKey] api_key="API Key" diff --git a/crates/hyperswitch_connectors/src/connectors/payload.rs b/crates/hyperswitch_connectors/src/connectors/payload.rs index c1f1516e63b..03c41d367aa 100644 --- a/crates/hyperswitch_connectors/src/connectors/payload.rs +++ b/crates/hyperswitch_connectors/src/connectors/payload.rs @@ -8,12 +8,12 @@ use base64::Engine; use common_enums::enums; use common_utils::{ consts::BASE64_ENGINE, - errors::CustomResult, - ext_traits::BytesExt, + errors::{CustomResult, ReportSwitchExt}, + ext_traits::{ByteSliceExt, BytesExt}, request::{Method, Request, RequestBuilder, RequestContent}, types::{AmountConvertor, StringMajorUnit, StringMajorUnitForConnector}, }; -use error_stack::{report, ResultExt}; +use error_stack::ResultExt; use hyperswitch_domain_models::{ payment_method_data::PaymentMethodData, router_data::{AccessToken, ConnectorAuthType, ErrorResponse, RouterData}, @@ -47,7 +47,7 @@ use hyperswitch_interfaces::{ types::{self, PaymentsVoidType, Response}, webhooks, }; -use masking::{ExposeInterface, Mask}; +use masking::{ExposeInterface, Mask, Secret}; use transformers as payload; use crate::{constants::headers, types::ResponseRouterData, utils}; @@ -195,7 +195,18 @@ impl ConnectorIntegration<Session, PaymentsSessionData, PaymentsResponseData> fo impl ConnectorIntegration<AccessTokenAuth, AccessTokenRequestData, AccessToken> for Payload {} -impl ConnectorIntegration<SetupMandate, SetupMandateRequestData, PaymentsResponseData> for Payload {} +impl ConnectorIntegration<SetupMandate, SetupMandateRequestData, PaymentsResponseData> for Payload { + fn build_request( + &self, + _req: &RouterData<SetupMandate, SetupMandateRequestData, PaymentsResponseData>, + _connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Err( + errors::ConnectorError::NotImplemented("Setup Mandate flow for Payload".to_string()) + .into(), + ) + } +} impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData> for Payload { fn get_headers( @@ -701,25 +712,95 @@ impl ConnectorIntegration<RSync, RefundsData, RefundsResponseData> for Payload { #[async_trait::async_trait] impl webhooks::IncomingWebhook for Payload { - fn get_webhook_object_reference_id( + async fn verify_webhook_source( &self, _request: &webhooks::IncomingWebhookRequestDetails<'_>, + _merchant_id: &common_utils::id_type::MerchantId, + _connector_webhook_details: Option<common_utils::pii::SecretSerdeValue>, + _connector_account_details: common_utils::crypto::Encryptable<Secret<serde_json::Value>>, + _connector_label: &str, + ) -> CustomResult<bool, errors::ConnectorError> { + // Payload does not support source verification + // It does, but the client id and client secret generation is not possible at present + // It requires OAuth connect which falls under Access Token flow and it also requires multiple calls to be made + // We return false just so that a PSync call is triggered internally + Ok(false) + } + + fn get_webhook_object_reference_id( + &self, + request: &webhooks::IncomingWebhookRequestDetails<'_>, ) -> CustomResult<api_models::webhooks::ObjectReferenceId, errors::ConnectorError> { - Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + let webhook_body: responses::PayloadWebhookEvent = request + .body + .parse_struct("PayloadWebhookEvent") + .change_context(errors::ConnectorError::WebhookBodyDecodingFailed)?; + + let reference_id = match webhook_body.trigger { + responses::PayloadWebhooksTrigger::Payment + \| responses::PayloadWebhooksTrigger::Processed + \| responses::PayloadWebhooksTrigger::Authorized + \| responses::PayloadWebhooksTrigger::Credit + \| responses::PayloadWebhooksTrigger::Reversal + \| responses::PayloadWebhooksTrigger::Void + \| responses::PayloadWebhooksTrigger::AutomaticPayment + \| responses::PayloadWebhooksTrigger::Decline + \| responses::PayloadWebhooksTrigger::Deposit + \| responses::PayloadWebhooksTrigger::Reject + \| responses::PayloadWebhooksTrigger::PaymentActivationStatus + \| responses::PayloadWebhooksTrigger::PaymentLinkStatus + \| responses::PayloadWebhooksTrigger::ProcessingStatus + \| responses::PayloadWebhooksTrigger::BankAccountReject + \| responses::PayloadWebhooksTrigger::Chargeback + \| responses::PayloadWebhooksTrigger::ChargebackReversal + \| responses::PayloadWebhooksTrigger::TransactionOperation + \| responses::PayloadWebhooksTrigger::TransactionOperationClear => { + api_models::webhooks::ObjectReferenceId::PaymentId( + api_models::payments::PaymentIdType::ConnectorTransactionId( + webhook_body + .triggered_on + .transaction_id + .ok_or(errors::ConnectorError::WebhookReferenceIdNotFound)?, + ), + ) + } + + responses::PayloadWebhooksTrigger::Refund => { + api_models::webhooks::ObjectReferenceId::RefundId( + api_models::webhooks::RefundIdType::ConnectorRefundId( + webhook_body + .triggered_on + .transaction_id + .ok_or(errors::ConnectorError::WebhookReferenceIdNotFound)?, + ), + ) + } + }; + + Ok(reference_id) } fn get_webhook_event_type( &self, - _request: &webhooks::IncomingWebhookRequestDetails<'_>, + request: &webhooks::IncomingWebhookRequestDetails<'_>, ) -> CustomResult<api_models::webhooks::IncomingWebhookEvent, errors::ConnectorError> { - Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + let webhook_body: responses::PayloadWebhookEvent = + request.body.parse_struct("PayloadWebhookEvent").switch()?; + + Ok(api_models::webhooks::IncomingWebhookEvent::from( + webhook_body.trigger, + )) } fn get_webhook_resource_object( &self, - _request: &webhooks::IncomingWebhookRequestDetails<'_>, + request: &webhooks::IncomingWebhookRequestDetails<'_>, ) -> CustomResult<Box<dyn masking::ErasedMaskSerialize>, errors::ConnectorError> { - Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + let webhook_body: responses::PayloadWebhookEvent = request + .body + .parse_struct("PayloadWebhookEvent") + .change_context(errors::ConnectorError::WebhookReferenceIdNotFound)?; + Ok(Box::new(webhook_body)) } } @@ -782,7 +863,11 @@ static PAYLOAD_CONNECTOR_INFO: ConnectorInfo = ConnectorInfo { connector_type: enums::PaymentConnectorCategory::PaymentGateway, }; -static PAYLOAD_SUPPORTED_WEBHOOK_FLOWS: [enums::EventClass; 0] = []; +static PAYLOAD_SUPPORTED_WEBHOOK_FLOWS: [enums::EventClass; 3] = [ + enums::EventClass::Disputes, + enums::EventClass::Payments, + enums::EventClass::Refunds, +]; impl ConnectorSpecifications for Payload { fn get_connector_about(&self) -> Option<&'static ConnectorInfo> { diff --git a/crates/hyperswitch_connectors/src/connectors/payload/responses.rs b/crates/hyperswitch_connectors/src/connectors/payload/responses.rs index 63699d09810..444e794e6bd 100644 --- a/crates/hyperswitch_connectors/src/connectors/payload/responses.rs +++ b/crates/hyperswitch_connectors/src/connectors/payload/responses.rs @@ -38,6 +38,7 @@ pub struct PayloadCardsResponseData { #[serde(rename = "id")] pub transaction_id: String, pub payment_method_id: Option<Secret<String>>, + // Connector customer id pub processing_id: Option<String>, pub processing_method_id: Option<String>, pub ref_number: Option<String>, @@ -84,6 +85,7 @@ pub struct PayloadRefundResponse { pub transaction_id: String, pub ledger: Vec<RefundsLedger>, pub payment_method_id: Option<Secret<String>>, + // Connector customer id pub processing_id: Option<String>, pub ref_number: Option<String>, pub status: RefundStatus, @@ -99,3 +101,51 @@ pub struct PayloadErrorResponse { /// Payload returns arbitrary details in JSON format pub details: Option<serde_json::Value>, } + +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "snake_case")] +pub enum PayloadWebhooksTrigger { + Payment, + Processed, + Authorized, + Credit, + Refund, + Reversal, + Void, + AutomaticPayment, + Decline, + Deposit, + Reject, + #[serde(rename = "payment_activation:status")] + PaymentActivationStatus, + #[serde(rename = "payment_link:status")] + PaymentLinkStatus, + ProcessingStatus, + BankAccountReject, + Chargeback, + ChargebackReversal, + #[serde(rename = "transaction:operation")] + TransactionOperation, + #[serde(rename = "transaction:operation:clear")] + TransactionOperationClear, +} + +// Webhook response structures +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct PayloadWebhookEvent { + pub object: String, // Added to match actual webhook structure + pub trigger: PayloadWebhooksTrigger, + pub webhook_id: String, + pub triggered_at: String, // Added to match actual webhook structure + // Webhooks Payload + pub triggered_on: PayloadEventDetails, + pub url: String, +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct PayloadEventDetails { + #[serde(rename = "id")] + pub transaction_id: Option<String>, + pub object: String, + pub value: Option<serde_json::Value>, // Changed to handle any value type including null +} diff --git a/crates/hyperswitch_connectors/src/connectors/payload/transformers.rs b/crates/hyperswitch_connectors/src/connectors/payload/transformers.rs index 994b4a7cfce..707a8db9366 100644 --- a/crates/hyperswitch_connectors/src/connectors/payload/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/payload/transformers.rs @@ -1,20 +1,24 @@ +use api_models::webhooks::IncomingWebhookEvent; use common_enums::enums; use common_utils::types::StringMajorUnit; use hyperswitch_domain_models::{ payment_method_data::PaymentMethodData, - router_data::{ConnectorAuthType, RouterData}, + router_data::{ConnectorAuthType, ErrorResponse, RouterData}, router_flow_types::refunds::{Execute, RSync}, router_request_types::ResponseId, router_response_types::{PaymentsResponseData, RefundsResponseData}, types::{PaymentsAuthorizeRouterData, PaymentsCaptureRouterData, RefundsRouterData}, }; -use hyperswitch_interfaces::errors; +use hyperswitch_interfaces::{ + consts::{NO_ERROR_CODE, NO_ERROR_MESSAGE}, + errors, +}; use masking::Secret; use super::{requests, responses}; use crate::{ types::{RefundsResponseRouterData, ResponseRouterData}, - utils::{is_manual_capture, CardData, RouterData as OtherRouterData}, + utils::{is_manual_capture, AddressDetailsData, CardData, RouterData as OtherRouterData}, }; //TODO: Fill the struct with respective fields @@ -56,12 +60,20 @@ impl TryFrom<&PayloadRouterData<&PaymentsAuthorizeRouterData>> cvc: req_card.card_cvc, }; let address = item.router_data.get_billing_address()?; + + // Check for required fields and fail if they're missing + let city = address.get_city()?.to_owned(); + let country = address.get_country()?.to_owned(); + let postal_code = address.get_zip()?.to_owned(); + let state_province = address.get_state()?.to_owned(); + let street_address = address.get_line1()?.to_owned(); + let billing_address = requests::BillingAddress { - city: address.city.clone().unwrap_or_default(), - country: address.country.unwrap_or_default(), - postal_code: address.zip.clone().unwrap_or_default(), - state_province: address.state.clone().unwrap_or_default(), - street_address: address.line1.clone().unwrap_or_default(), + city, + country, + postal_code, + state_province, + street_address, }; // For manual capture, set status to "authorized" @@ -127,13 +139,29 @@ impl<F, T> ) -> Result<Self, Self::Error> { match item.response.clone() { responses::PayloadPaymentsResponse::PayloadCardsResponse(response) => { - let payment_status = response.status; - let transaction_id = response.transaction_id; - - Ok(Self { - status: common_enums::AttemptStatus::from(payment_status), - response: Ok(PaymentsResponseData::TransactionResponse { - resource_id: ResponseId::ConnectorTransactionId(transaction_id), + let status = enums::AttemptStatus::from(response.status); + let connector_customer = response.processing_id.clone(); + let response_result = if status == enums::AttemptStatus::Failure { + Err(ErrorResponse { + attempt_status: None, + code: response + .status_code + .clone() + .unwrap_or_else(\|\| NO_ERROR_CODE.to_string()), + message: response + .status_message + .clone() + .unwrap_or_else(\|\| NO_ERROR_MESSAGE.to_string()), + reason: response.status_message, + status_code: item.http_code, + connector_transaction_id: Some(response.transaction_id.clone()), + network_decline_code: None, + network_advice_code: None, + network_error_message: None, + }) + } else { + Ok(PaymentsResponseData::TransactionResponse { + resource_id: ResponseId::ConnectorTransactionId(response.transaction_id), redirection_data: Box::new(None), mandate_reference: Box::new(None), connector_metadata: None, @@ -141,7 +169,12 @@ impl<F, T> connector_response_reference_id: response.ref_number, incremental_authorization_allowed: None, charges: None, - }), + }) + }; + Ok(Self { + status, + response: response_result, + connector_customer, ..item.data }) } @@ -225,3 +258,41 @@ impl TryFrom<RefundsResponseRouterData<RSync, responses::PayloadRefundResponse>> }) } } + +// Webhook transformations +impl From<responses::PayloadWebhooksTrigger> for IncomingWebhookEvent { + fn from(trigger: responses::PayloadWebhooksTrigger) -> Self { + match trigger { + // Payment Success Events + responses::PayloadWebhooksTrigger::Processed => Self::PaymentIntentSuccess, + responses::PayloadWebhooksTrigger::Authorized => { + Self::PaymentIntentAuthorizationSuccess + } + // Payment Processing Events + responses::PayloadWebhooksTrigger::Payment + \| responses::PayloadWebhooksTrigger::AutomaticPayment => Self::PaymentIntentProcessing, + // Payment Failure Events + responses::PayloadWebhooksTrigger::Decline + \| responses::PayloadWebhooksTrigger::Reject + \| responses::PayloadWebhooksTrigger::BankAccountReject => Self::PaymentIntentFailure, + responses::PayloadWebhooksTrigger::Void + \| responses::PayloadWebhooksTrigger::Reversal => Self::PaymentIntentCancelled, + // Refund Events + responses::PayloadWebhooksTrigger::Refund => Self::RefundSuccess, + // Dispute Events + responses::PayloadWebhooksTrigger::Chargeback => Self::DisputeOpened, + responses::PayloadWebhooksTrigger::ChargebackReversal => Self::DisputeWon, + // Other payment-related events + // Events not supported by our standard flows + responses::PayloadWebhooksTrigger::PaymentActivationStatus + \| responses::PayloadWebhooksTrigger::Credit + \| responses::PayloadWebhooksTrigger::Deposit + \| responses::PayloadWebhooksTrigger::PaymentLinkStatus + \| responses::PayloadWebhooksTrigger::ProcessingStatus + \| responses::PayloadWebhooksTrigger::TransactionOperation + \| responses::PayloadWebhooksTrigger::TransactionOperationClear => { + Self::EventNotSupported + } + } + } +}	2025-07-06T10:29:15Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [x] Bugfix - [x] New feature - [ ] Enhancement - [x] Refactoring - [ ] Dependency updates - [ ] Documentation - [x] CI/CD ## Description <!-- Describe your changes in detail --> This PR: - Adds support for webhooks to Payload connector. The connector does not support source verification. - Address Cypress comments that was asked in #8545. - Fixes setup mandate not throwing `501` ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [x] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> 1. crates/connector_configs/toml/development.toml 2. crates/connector_configs/toml/production.toml 3. crates/connector_configs/toml/sandbox.toml ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> Closes #8557 ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> <details> <summary>Setup Webhooks in Merchant Account</summary> ```curl curl --location 'https://pix-mbp.orthrus-monster.ts.net/accounts' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: test_admin' \ --data-raw '{ "merchant_id": "postman_merchant_GHAction_1751796781", "locker_id": "m0010", "merchant_name": "NewAge Retailer", "merchant_details": { "primary_contact_person": "John Test", "primary_email": "[email protected]", "primary_phone": "sunt laborum", "secondary_contact_person": "John Test2", "secondary_email": "[email protected]", "secondary_phone": "cillum do dolor id", "website": "www.example.com", "about_business": "Online Retail with a wide selection of organic products for North America" , "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US" } }, "return_url": "https://duck.com", "webhook_details": { "webhook_url": "https://webhook.site/02225e46-1016-4c2c-a492-efaaa5d41cf3", "webhook_version": "1.0.1", "webhook_username": "ekart_retail", "webhook_password": "password_ekart@123" }, "sub_merchants_enabled": false, "metadata": { "city": "NY", "unit": "245" }, "primary_business_details": [ { "country": "US", "business": "default" } ] }' ``` ```json { "merchant_id": "postman_merchant_GHAction_1751738744", "merchant_name": "NewAge Retailer", "return_url": "https://duck.com/", "enable_payment_response_hash": true, "payment_response_hash_key": "wsJ8BLD1TuNdKjCCMpoonWCJduaS9CT1EperKUJVLOQftECdAK7d4a7otMdv2EMq", "redirect_to_merchant_with_http_post": false, "merchant_details": { "primary_contact_person": "John Test", "primary_phone": "sunt laborum", "primary_email": "[email protected]", "secondary_contact_person": "John Test2", "secondary_phone": "cillum do dolor id", "secondary_email": "[email protected]", "website": "www.example.com", "about_business": "Online Retail with a wide selection of organic products for North America", "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": null, "last_name": null } }, "webhook_details": { "webhook_version": "1.0.1", "webhook_username": "ekart_retail", "webhook_password": "password_ekart@123", "webhook_url": "https://webhook.site/02225e46-1016-4c2c-a492-efaaa5d41cf3", "payment_created_enabled": null, "payment_succeeded_enabled": null, "payment_failed_enabled": null, "payment_statuses_enabled": null, "refund_statuses_enabled": null, "payout_statuses_enabled": null }, "payout_routing_algorithm": null, "sub_merchants_enabled": false, "parent_merchant_id": null, "publishable_key": "pk_dev_4ab91f8e35424d11acdd8c639a974f0c", "metadata": { "city": "NY", "unit": "245", "compatible_connector": null }, "locker_id": "m0010", "primary_business_details": [ { "country": "US", "business": "default" } ], "frm_routing_algorithm": null, "organization_id": "org_oZUZY7YEM9gts3EC4kbC", "is_recon_enabled": false, "default_profile": "pro_ZVgp4CWyKZKnx99AD7BL", "recon_status": "not_requested", "pm_collect_link_config": null, "product_type": "orchestration", "merchant_account_type": "standard" } ``` </details> <details> <summary>Setup Webhooks at Connector's end below commands by referring to the [trigger docs](https://docs.payload.com/apis/webhooks/triggers/)</summary> ```curl curl --location 'https://api.payload.com/webhooks/' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: api_key' \ --data-urlencode 'trigger=processed' \ --data-urlencode 'url=<base_url>/webhooks/<merchant_id>/<mca_id/connector_name>' ``` ```json { "attrs": null, "created_at": "Sun, 06 Jul 2025 07:24:29 GMT", "id": "<webhook_id>", "modified_at": "Sun, 06 Jul 2025 07:24:29 GMT", "oauth_params": null, "object": "webhook", "retries": 0, "trigger": "processed", "url": "<base_url>/webhooks/<merchant_id>/<mca_id/connector_name>" } ``` </details> <details> <summary>Make Payment</summary> ```curl curl --location 'https://pix-mbp.orthrus-monster.ts.net/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'Accept-Language: ja' \ --header 'api-key: dev_PCJYsjpYCN6C9ECuYT5g9LR1epAx5Jeqc7WpsXzoxpTbCcHqSqJ5CdUPnxdEh29y' \ --data-raw '{ "amount": 40, "currency": "USD", "confirm": true, "capture_method": "automatic", "capture_on": "2022-09-10T10:11:12Z", "amount_to_capture": 40, "customer_id": "customer", "email": "[email protected]", "phone": "999999999", "phone_country_code": "+1", "description": "Its my first payment request", "authentication_type": "no_three_ds", "return_url": "https://duck.com", "payment_method": "card", "payment_method_data": { "card": { "card_number": "4111111111111111", "card_exp_month": "10", "card_exp_year": "25", "card_holder_name": "Joseph Doe", "card_cvc": "123" } }, "billing": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US" , "first_name": "PiX" , "last_name": "THE" } }, "shipping": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "PiX" } }, "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "metadata": { "udf1": "value1", "new_customer": "true", "login_date": "2019-09-10T10:11:12Z" }, "browser_info": { "color_depth": 24, "java_enabled": true, "java_script_enabled": true, "language": "en-GB", "screen_height": 720, "screen_width": 1280, "time_zone": -330, "ip_address": "208.127.127.193", "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8", "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36 Edg/126.0.0.0" } }' ``` ```json { "payment_id": "pay_IMknbnvAK8MSCd1WXmrI", "merchant_id": "postman_merchant_GHAction_1751797139", "status": "succeeded", "amount": 40, "net_amount": 40, "shipping_cost": null, "amount_capturable": 0, "amount_received": 40, "connector": "payload", "client_secret": "pay_IMknbnvAK8MSCd1WXmrI_secret_Gj1Vtt77ai6KPzJ5AGHC", "created": "2025-07-06T10:20:56.697Z", "currency": "USD", "customer_id": "customer", "customer": { "id": "customer", "name": null, "email": "[email protected]", "phone": "999999999", "phone_country_code": "+1" }, "description": "Its my first payment request", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "card", "payment_method_data": { "card": { "last4": "1111", "card_type": "CREDIT", "card_network": "Visa", "card_issuer": "JP Morgan", "card_issuing_country": "INDIA", "card_isin": "411111", "card_extended_bin": null, "card_exp_month": "10", "card_exp_year": "25", "card_holder_name": "Joseph Doe", "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "PiX", "last_name": null }, "phone": null, "email": null }, "billing": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "PiX", "last_name": "THE" }, "phone": null, "email": null }, "order_details": null, "email": "[email protected]", "name": null, "phone": "999999999", "return_url": "https://duck.com/", "authentication_type": "no_three_ds", "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "credit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": { "customer_id": "customer", "created_at": 1751797256, "expires": 1751800856, "secret": "epk_d97417b2937b49a98be4f3bab68e34b1" }, "manual_retry_allowed": false, "connector_transaction_id": "txn_3ephQ2TpDLsQSnekEK1a8", "frm_message": null, "metadata": { "udf1": "value1", "login_date": "2019-09-10T10:11:12Z", "new_customer": "true" }, "connector_metadata": null, "feature_metadata": null, "reference_id": "PL-M3P-9HY-9T7", "payment_link": null, "profile_id": "pro_VaPL7y7qI4IY0F9cvRU2", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_KOpDieOFRmWvh26OJ9OH", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-07-06T10:35:56.697Z", "fingerprint": null, "browser_info": { "language": "en-GB", "time_zone": -330, "ip_address": "208.127.127.193", "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36 Edg/126.0.0.0", "color_depth": 24, "java_enabled": true, "screen_width": 1280, "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8", "screen_height": 720, "java_script_enabled": true }, "payment_method_id": null, "payment_method_status": null, "updated": "2025-07-06T10:20:57.632Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` </details> <details> <summary>Check website for outgoing webhooks</summary> <img width="1695" alt="image" src="https://github.com/user-attachments/assets/5a6890aa-85de-4b31-9337-d001e61b5236" /> </details> <details> <summary>Check logs for incoming webhooks</summary> <img width="1286" alt="image" src="https://github.com/user-attachments/assets/0963fdfc-d21f-4acf-b795-b9d829409a75" /> <img width="1291" alt="image" src="https://github.com/user-attachments/assets/b12582e5-b732-427b-abf3-f31582fa1b92" /> </details> <details> <summary>Cypress</summary> `19` failures is because the connector marked them as duplicate even with 15 seconds timeout. <img width="553" alt="image" src="https://github.com/user-attachments/assets/b217d420-a5ce-4a68-b0cc-89cd920049ba" /> </details> ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `just clippy && just clippy_v2` - [x] I reviewed the submitted code - [x] I added unit tests for my changes where possible <!-- @coderabbitai ignore -->	v1.115.0	99885b699d7524e87697f78608e6f2b36c9d8a8e	99885b699d7524e87697f78608e6f2b36c9d8a8e
juspay/hyperswitch	juspay__hyperswitch-8575	Bug: [FEATURE] Cellero commerce integration ### Feature Description Integrate celero commerce Connector ### Possible Implementation Celero commerce integration ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? Yes, I am willing to submit a PR!	diff --git a/crates/connector_configs/toml/development.toml b/crates/connector_configs/toml/development.toml index 83544e40cc1..160a29aa1a3 100644 --- a/crates/connector_configs/toml/development.toml +++ b/crates/connector_configs/toml/development.toml @@ -1446,6 +1446,35 @@ merchant_id_evoucher="MerchantId Evoucher" [cashtocode.connector_webhook_details] merchant_secret="Source verification key" +[celero] +[[celero.credit]] + payment_method_type = "AmericanExpress" +[[celero.credit]] + payment_method_type = "Discover" +[[celero.credit]] + payment_method_type = "DinersClub" +[[celero.credit]] + payment_method_type = "JCB" +[[celero.credit]] + payment_method_type = "Mastercard" +[[celero.credit]] + payment_method_type = "Visa" +[[celero.debit]] + payment_method_type = "AmericanExpress" +[[celero.debit]] + payment_method_type = "Discover" +[[celero.debit]] + payment_method_type = "DinersClub" +[[celero.debit]] + payment_method_type = "JCB" +[[celero.debit]] + payment_method_type = "Mastercard" +[[celero.debit]] + payment_method_type = "Visa" +[celero.connector_auth.HeaderKey] +api_key="Celero API Key" + + [checkbook] [[checkbook.bank_transfer]] payment_method_type = "ach" diff --git a/crates/connector_configs/toml/production.toml b/crates/connector_configs/toml/production.toml index 019d842b8d1..47aff66d845 100644 --- a/crates/connector_configs/toml/production.toml +++ b/crates/connector_configs/toml/production.toml @@ -1212,6 +1212,34 @@ key1 = "Secret Key" [cryptopay.connector_webhook_details] merchant_secret = "Source verification key" +[celero] +[[celero.credit]] + payment_method_type = "AmericanExpress" +[[celero.credit]] + payment_method_type = "Discover" +[[celero.credit]] + payment_method_type = "DinersClub" +[[celero.credit]] + payment_method_type = "JCB" +[[celero.credit]] + payment_method_type = "Mastercard" +[[celero.credit]] + payment_method_type = "Visa" +[[celero.debit]] + payment_method_type = "AmericanExpress" +[[celero.debit]] + payment_method_type = "Discover" +[[celero.debit]] + payment_method_type = "DinersClub" +[[celero.debit]] + payment_method_type = "JCB" +[[celero.debit]] + payment_method_type = "Mastercard" +[[celero.debit]] + payment_method_type = "Visa" +[celero.connector_auth.HeaderKey] +api_key="Celero API Key" + [checkbook] [[checkbook.bank_transfer]] payment_method_type = "ach" diff --git a/crates/connector_configs/toml/sandbox.toml b/crates/connector_configs/toml/sandbox.toml index 8571315082e..d1ea6ba609f 100644 --- a/crates/connector_configs/toml/sandbox.toml +++ b/crates/connector_configs/toml/sandbox.toml @@ -1445,6 +1445,35 @@ merchant_id_evoucher = "MerchantId Evoucher" [cashtocode.connector_webhook_details] merchant_secret = "Source verification key" +[celero] +[[celero.credit]] + payment_method_type = "AmericanExpress" +[[celero.credit]] + payment_method_type = "Discover" +[[celero.credit]] + payment_method_type = "DinersClub" +[[celero.credit]] + payment_method_type = "JCB" +[[celero.credit]] + payment_method_type = "Mastercard" +[[celero.credit]] + payment_method_type = "Visa" +[[celero.debit]] + payment_method_type = "AmericanExpress" +[[celero.debit]] + payment_method_type = "Discover" +[[celero.debit]] + payment_method_type = "DinersClub" +[[celero.debit]] + payment_method_type = "JCB" +[[celero.debit]] + payment_method_type = "Mastercard" +[[celero.debit]] + payment_method_type = "Visa" +[celero.connector_auth.HeaderKey] +api_key="Celero API Key" + + [checkbook] [[checkbook.bank_transfer]] payment_method_type = "ach" diff --git a/crates/hyperswitch_connectors/src/connectors/celero.rs b/crates/hyperswitch_connectors/src/connectors/celero.rs index 9db111a10e4..726791a72eb 100644 --- a/crates/hyperswitch_connectors/src/connectors/celero.rs +++ b/crates/hyperswitch_connectors/src/connectors/celero.rs @@ -1,10 +1,13 @@ pub mod transformers; +use std::sync::LazyLock; + +use common_enums::enums; use common_utils::{ errors::CustomResult, ext_traits::BytesExt, request::{Method, Request, RequestBuilder, RequestContent}, - types::{AmountConvertor, StringMinorUnit, StringMinorUnitForConnector}, + types::{AmountConvertor, MinorUnit, MinorUnitForConnector}, }; use error_stack::{report, ResultExt}; use hyperswitch_domain_models::{ @@ -19,7 +22,10 @@ use hyperswitch_domain_models::{ PaymentsCancelData, PaymentsCaptureData, PaymentsSessionData, PaymentsSyncData, RefundsData, SetupMandateRequestData, }, - router_response_types::{PaymentsResponseData, RefundsResponseData}, + router_response_types::{ + ConnectorInfo, PaymentMethodDetails, PaymentsResponseData, RefundsResponseData, + SupportedPaymentMethods, SupportedPaymentMethodsExt, + }, types::{ PaymentsAuthorizeRouterData, PaymentsCaptureRouterData, PaymentsSyncRouterData, RefundSyncRouterData, RefundsRouterData, @@ -43,13 +49,13 @@ use crate::{constants::headers, types::ResponseRouterData, utils}; #[derive(Clone)] pub struct Celero { - amount_converter: &'static (dyn AmountConvertor<Output = StringMinorUnit> + Sync), + amount_converter: &'static (dyn AmountConvertor<Output = MinorUnit> + Sync), } impl Celero { pub fn new() -> &'static Self { &Self { - amount_converter: &StringMinorUnitForConnector, + amount_converter: &MinorUnitForConnector, } } } @@ -98,10 +104,7 @@ impl ConnectorCommon for Celero { } fn get_currency_unit(&self) -> api::CurrencyUnit { - api::CurrencyUnit::Base - // TODO! Check connector documentation, on which unit they are processing the currency. - // If the connector accepts amount in lower unit ( i.e cents for USD) then return api::CurrencyUnit::Minor, - // if connector accepts amount in base unit (i.e dollars for USD) then return api::CurrencyUnit::Base + api::CurrencyUnit::Minor } fn common_get_content_type(&self) -> &'static str { @@ -137,23 +140,53 @@ impl ConnectorCommon for Celero { event_builder.map(\|i\| i.set_response_body(&response)); router_env::logger::info!(connector_response=?response); + // Extract error details from the response + let error_details = celero::CeleroErrorDetails::from(response); + Ok(ErrorResponse { status_code: res.status_code, - code: response.code, - message: response.message, - reason: response.reason, + code: error_details + .error_code + .unwrap_or_else(\|\| "UNKNOWN_ERROR".to_string()), + message: error_details.error_message, + reason: error_details.decline_reason, attempt_status: None, connector_transaction_id: None, - network_decline_code: None, + network_decline_code: error_details.processor_response_code.clone(), network_advice_code: None, - network_error_message: None, + network_error_message: error_details.processor_response_code, connector_metadata: None, }) } } impl ConnectorValidation for Celero { - //TODO: implement functions when support enabled + fn validate_connector_against_payment_request( + &self, + capture_method: Option<enums::CaptureMethod>, + _payment_method: enums::PaymentMethod, + _pmt: Option<enums::PaymentMethodType>, + ) -> CustomResult<(), errors::ConnectorError> { + let capture_method = capture_method.unwrap_or_default(); + + // CeleroCommerce supports both automatic (sale) and manual (authorize + capture) flows + let is_capture_method_supported = matches!( + capture_method, + enums::CaptureMethod::Automatic + \| enums::CaptureMethod::Manual + \| enums::CaptureMethod::SequentialAutomatic + ); + + if is_capture_method_supported { + Ok(()) + } else { + Err(errors::ConnectorError::NotSupported { + message: capture_method.to_string(), + connector: self.id(), + } + .into()) + } + } } impl ConnectorIntegration<Session, PaymentsSessionData, PaymentsResponseData> for Celero { @@ -180,9 +213,9 @@ impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData fn get_url( &self, _req: &PaymentsAuthorizeRouterData, - _connectors: &Connectors, + connectors: &Connectors, ) -> CustomResult<String, errors::ConnectorError> { - Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + Ok(format!("{}/api/transaction", self.base_url(connectors))) } fn get_request_body( @@ -196,7 +229,7 @@ impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData req.request.currency, )?; - let connector_router_data = celero::CeleroRouterData::from((amount, req)); + let connector_router_data = celero::CeleroRouterData::try_from((amount, req))?; let connector_req = celero::CeleroPaymentsRequest::try_from(&connector_router_data)?; Ok(RequestContent::Json(Box::new(connector_req))) } @@ -267,9 +300,22 @@ impl ConnectorIntegration<PSync, PaymentsSyncData, PaymentsResponseData> for Cel fn get_url( &self, _req: &PaymentsSyncRouterData, - _connectors: &Connectors, + connectors: &Connectors, ) -> CustomResult<String, errors::ConnectorError> { - Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + // CeleroCommerce uses search API for payment sync + Ok(format!( + "{}/api/transaction/search", + self.base_url(connectors) + )) + } + + fn get_request_body( + &self, + req: &PaymentsSyncRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let connector_req = celero::CeleroSearchRequest::try_from(req)?; + Ok(RequestContent::Json(Box::new(connector_req))) } fn build_request( @@ -279,10 +325,13 @@ impl ConnectorIntegration<PSync, PaymentsSyncData, PaymentsResponseData> for Cel ) -> CustomResult<Option<Request>, errors::ConnectorError> { Ok(Some( RequestBuilder::new() - .method(Method::Get) + .method(Method::Post) .url(&types::PaymentsSyncType::get_url(self, req, connectors)?) .attach_default_headers() .headers(types::PaymentsSyncType::get_headers(self, req, connectors)?) + .set_body(types::PaymentsSyncType::get_request_body( + self, req, connectors, + )?) .build(), )) } @@ -330,18 +379,31 @@ impl ConnectorIntegration<Capture, PaymentsCaptureData, PaymentsResponseData> fo fn get_url( &self, - _req: &PaymentsCaptureRouterData, - _connectors: &Connectors, + req: &PaymentsCaptureRouterData, + connectors: &Connectors, ) -> CustomResult<String, errors::ConnectorError> { - Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + let connector_payment_id = req.request.connector_transaction_id.clone(); + Ok(format!( + "{}/api/transaction/{}/capture", + self.base_url(connectors), + connector_payment_id + )) } fn get_request_body( &self, - _req: &PaymentsCaptureRouterData, + req: &PaymentsCaptureRouterData, _connectors: &Connectors, ) -> CustomResult<RequestContent, errors::ConnectorError> { - Err(errors::ConnectorError::NotImplemented("get_request_body method".to_string()).into()) + let amount = utils::convert_amount( + self.amount_converter, + req.request.minor_amount_to_capture, + req.request.currency, + )?; + + let connector_router_data = celero::CeleroRouterData::try_from((amount, req))?; + let connector_req = celero::CeleroCaptureRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) } fn build_request( @@ -370,7 +432,7 @@ impl ConnectorIntegration<Capture, PaymentsCaptureData, PaymentsResponseData> fo event_builder: Option<&mut ConnectorEvent>, res: Response, ) -> CustomResult<PaymentsCaptureRouterData, errors::ConnectorError> { - let response: celero::CeleroPaymentsResponse = res + let response: celero::CeleroCaptureResponse = res .response .parse_struct("Celero PaymentsCaptureResponse") .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; @@ -392,7 +454,77 @@ impl ConnectorIntegration<Capture, PaymentsCaptureData, PaymentsResponseData> fo } } -impl ConnectorIntegration<Void, PaymentsCancelData, PaymentsResponseData> for Celero {} +impl ConnectorIntegration<Void, PaymentsCancelData, PaymentsResponseData> for Celero { + fn get_headers( + &self, + req: &RouterData<Void, PaymentsCancelData, PaymentsResponseData>, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + req: &RouterData<Void, PaymentsCancelData, PaymentsResponseData>, + connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + let connector_payment_id = req.request.connector_transaction_id.clone(); + Ok(format!( + "{}/api/transaction/{}/void", + self.base_url(connectors), + connector_payment_id + )) + } + + fn build_request( + &self, + req: &RouterData<Void, PaymentsCancelData, PaymentsResponseData>, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::PaymentsVoidType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::PaymentsVoidType::get_headers(self, req, connectors)?) + .build(), + )) + } + + fn handle_response( + &self, + data: &RouterData<Void, PaymentsCancelData, PaymentsResponseData>, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult< + RouterData<Void, PaymentsCancelData, PaymentsResponseData>, + errors::ConnectorError, + > { + let response: celero::CeleroVoidResponse = res + .response + .parse_struct("Celero PaymentsVoidResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} impl ConnectorIntegration<Execute, RefundsData, RefundsResponseData> for Celero { fn get_headers( @@ -409,10 +541,15 @@ impl ConnectorIntegration<Execute, RefundsData, RefundsResponseData> for Celero fn get_url( &self, - _req: &RefundsRouterData<Execute>, - _connectors: &Connectors, + req: &RefundsRouterData<Execute>, + connectors: &Connectors, ) -> CustomResult<String, errors::ConnectorError> { - Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + let connector_payment_id = req.request.connector_transaction_id.clone(); + Ok(format!( + "{}/api/transaction/{}/refund", + self.base_url(connectors), + connector_payment_id + )) } fn get_request_body( @@ -426,7 +563,7 @@ impl ConnectorIntegration<Execute, RefundsData, RefundsResponseData> for Celero req.request.currency, )?; - let connector_router_data = celero::CeleroRouterData::from((refund_amount, req)); + let connector_router_data = celero::CeleroRouterData::try_from((refund_amount, req))?; let connector_req = celero::CeleroRefundRequest::try_from(&connector_router_data)?; Ok(RequestContent::Json(Box::new(connector_req))) } @@ -456,10 +593,10 @@ impl ConnectorIntegration<Execute, RefundsData, RefundsResponseData> for Celero event_builder: Option<&mut ConnectorEvent>, res: Response, ) -> CustomResult<RefundsRouterData<Execute>, errors::ConnectorError> { - let response: celero::RefundResponse = - res.response - .parse_struct("celero RefundResponse") - .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + let response: celero::CeleroRefundResponse = res + .response + .parse_struct("celero RefundResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; event_builder.map(\|i\| i.set_response_body(&response)); router_env::logger::info!(connector_response=?response); RouterData::try_from(ResponseRouterData { @@ -494,9 +631,22 @@ impl ConnectorIntegration<RSync, RefundsData, RefundsResponseData> for Celero { fn get_url( &self, _req: &RefundSyncRouterData, - _connectors: &Connectors, + connectors: &Connectors, ) -> CustomResult<String, errors::ConnectorError> { - Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + // CeleroCommerce uses search API for refund sync + Ok(format!( + "{}/api/transaction/search", + self.base_url(connectors) + )) + } + + fn get_request_body( + &self, + req: &RefundSyncRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let connector_req = celero::CeleroSearchRequest::try_from(req)?; + Ok(RequestContent::Json(Box::new(connector_req))) } fn build_request( @@ -506,7 +656,7 @@ impl ConnectorIntegration<RSync, RefundsData, RefundsResponseData> for Celero { ) -> CustomResult<Option<Request>, errors::ConnectorError> { Ok(Some( RequestBuilder::new() - .method(Method::Get) + .method(Method::Post) .url(&types::RefundSyncType::get_url(self, req, connectors)?) .attach_default_headers() .headers(types::RefundSyncType::get_headers(self, req, connectors)?) @@ -523,7 +673,7 @@ impl ConnectorIntegration<RSync, RefundsData, RefundsResponseData> for Celero { event_builder: Option<&mut ConnectorEvent>, res: Response, ) -> CustomResult<RefundSyncRouterData, errors::ConnectorError> { - let response: celero::RefundResponse = res + let response: celero::CeleroRefundResponse = res .response .parse_struct("celero RefundSyncResponse") .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; @@ -569,4 +719,80 @@ impl webhooks::IncomingWebhook for Celero { } } -impl ConnectorSpecifications for Celero {} +static CELERO_SUPPORTED_PAYMENT_METHODS: LazyLock<SupportedPaymentMethods> = LazyLock::new(\|\| { + let supported_capture_methods = vec![ + enums::CaptureMethod::Automatic, + enums::CaptureMethod::Manual, + enums::CaptureMethod::SequentialAutomatic, + ]; + let supported_card_network = vec![ + common_enums::CardNetwork::AmericanExpress, + common_enums::CardNetwork::Discover, + common_enums::CardNetwork::DinersClub, + common_enums::CardNetwork::JCB, + common_enums::CardNetwork::Mastercard, + common_enums::CardNetwork::Visa, + ]; + + let mut celero_supported_payment_methods = SupportedPaymentMethods::new(); + + celero_supported_payment_methods.add( + enums::PaymentMethod::Card, + enums::PaymentMethodType::Credit, + PaymentMethodDetails { + mandates: enums::FeatureStatus::NotSupported, + refunds: enums::FeatureStatus::Supported, + supported_capture_methods: supported_capture_methods.clone(), + specific_features: Some( + api_models::feature_matrix::PaymentMethodSpecificFeatures::Card({ + api_models::feature_matrix::CardSpecificFeatures { + three_ds: common_enums::FeatureStatus::NotSupported, + no_three_ds: common_enums::FeatureStatus::Supported, + supported_card_networks: supported_card_network.clone(), + } + }), + ), + }, + ); + + celero_supported_payment_methods.add( + enums::PaymentMethod::Card, + enums::PaymentMethodType::Debit, + PaymentMethodDetails { + mandates: enums::FeatureStatus::NotSupported, + refunds: enums::FeatureStatus::Supported, + supported_capture_methods: supported_capture_methods.clone(), + specific_features: Some( + api_models::feature_matrix::PaymentMethodSpecificFeatures::Card({ + api_models::feature_matrix::CardSpecificFeatures { + three_ds: common_enums::FeatureStatus::NotSupported, + no_three_ds: common_enums::FeatureStatus::Supported, + supported_card_networks: supported_card_network.clone(), + } + }), + ), + }, + ); + + celero_supported_payment_methods +}); + +static CELERO_CONNECTOR_INFO: ConnectorInfo = ConnectorInfo { + display_name: "Celero", + description: "Celero is your trusted provider for payment processing technology and solutions, with a commitment to helping small to mid-sized businesses thrive", + connector_type: enums::PaymentConnectorCategory::PaymentGateway, +}; + +impl ConnectorSpecifications for Celero { + fn get_connector_about(&self) -> Option<&'static ConnectorInfo> { + Some(&CELERO_CONNECTOR_INFO) + } + + fn get_supported_payment_methods(&self) -> Option<&'static SupportedPaymentMethods> { + Some(&*CELERO_SUPPORTED_PAYMENT_METHODS) + } + + fn get_supported_webhook_flows(&self) -> Option<&'static [enums::EventClass]> { + None + } +} diff --git a/crates/hyperswitch_connectors/src/connectors/celero/transformers.rs b/crates/hyperswitch_connectors/src/connectors/celero/transformers.rs index 2579c81ae6b..76990260923 100644 --- a/crates/hyperswitch_connectors/src/connectors/celero/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/celero/transformers.rs @@ -1,80 +1,260 @@ -use common_enums::enums; -use common_utils::types::StringMinorUnit; +use common_enums::{enums, Currency}; +use common_utils::{pii::Email, types::MinorUnit}; use hyperswitch_domain_models::{ + address::Address as DomainAddress, payment_method_data::PaymentMethodData, - router_data::{ConnectorAuthType, RouterData}, - router_flow_types::refunds::{Execute, RSync}, - router_request_types::ResponseId, + router_data::{ + AdditionalPaymentMethodConnectorResponse, ConnectorAuthType, ConnectorResponseData, + RouterData, + }, + router_flow_types::{ + payments::Capture, + refunds::{Execute, RSync}, + }, + router_request_types::{PaymentsCaptureData, ResponseId}, router_response_types::{PaymentsResponseData, RefundsResponseData}, - types::{PaymentsAuthorizeRouterData, RefundsRouterData}, + types::{ + PaymentsAuthorizeRouterData, PaymentsCaptureRouterData, PaymentsSyncRouterData, + RefundSyncRouterData, RefundsRouterData, + }, }; -use hyperswitch_interfaces::errors; -use masking::Secret; +use hyperswitch_interfaces::{consts, errors}; +use masking::{PeekInterface, Secret}; use serde::{Deserialize, Serialize}; use crate::{ types::{RefundsResponseRouterData, ResponseRouterData}, - utils::PaymentsAuthorizeRequestData, + utils::{ + AddressDetailsData, PaymentsAuthorizeRequestData, RefundsRequestData, RouterData as _, + }, }; //TODO: Fill the struct with respective fields pub struct CeleroRouterData<T> { - pub amount: StringMinorUnit, // The type of amount that a connector accepts, for example, String, i64, f64, etc. + pub amount: MinorUnit, // CeleroCommerce expects integer cents pub router_data: T, } -impl<T> From<(StringMinorUnit, T)> for CeleroRouterData<T> { - fn from((amount, item): (StringMinorUnit, T)) -> Self { - //Todo : use utils to convert the amount to the type of amount that a connector accepts - Self { +impl<T> TryFrom<(MinorUnit, T)> for CeleroRouterData<T> { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from((amount, item): (MinorUnit, T)) -> Result<Self, Self::Error> { + Ok(Self { amount, router_data: item, - } + }) } } +// CeleroCommerce Search Request for sync operations - POST /api/transaction/search +#[derive(Debug, Serialize, PartialEq)] +pub struct CeleroSearchRequest { + transaction_id: String, +} -//TODO: Fill the struct with respective fields -#[derive(Default, Debug, Serialize, PartialEq)] +impl TryFrom<&PaymentsSyncRouterData> for CeleroSearchRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from(item: &PaymentsSyncRouterData) -> Result<Self, Self::Error> { + let transaction_id = match &item.request.connector_transaction_id { + ResponseId::ConnectorTransactionId(id) => id.clone(), + _ => { + return Err(errors::ConnectorError::MissingConnectorTransactionID.into()); + } + }; + Ok(Self { transaction_id }) + } +} + +impl TryFrom<&RefundSyncRouterData> for CeleroSearchRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from(item: &RefundSyncRouterData) -> Result<Self, Self::Error> { + Ok(Self { + transaction_id: item.request.get_connector_refund_id()?, + }) + } +} + +// CeleroCommerce Payment Request according to API specs +#[derive(Debug, Serialize, PartialEq)] pub struct CeleroPaymentsRequest { - amount: StringMinorUnit, - card: CeleroCard, + idempotency_key: String, + #[serde(rename = "type")] + transaction_type: TransactionType, + amount: MinorUnit, // CeleroCommerce expects integer cents + currency: Currency, + payment_method: CeleroPaymentMethod, + #[serde(skip_serializing_if = "Option::is_none")] + billing_address: Option<CeleroAddress>, + #[serde(skip_serializing_if = "Option::is_none")] + shipping_address: Option<CeleroAddress>, + #[serde(skip_serializing_if = "Option::is_none")] + create_vault_record: Option<bool>, +} + +#[derive(Debug, Serialize, PartialEq)] +pub struct CeleroAddress { + first_name: Option<Secret<String>>, + last_name: Option<Secret<String>>, + address_line_1: Option<Secret<String>>, + address_line_2: Option<Secret<String>>, + city: Option<String>, + state: Option<Secret<String>>, + postal_code: Option<Secret<String>>, + country: Option<common_enums::CountryAlpha2>, + phone: Option<Secret<String>>, + email: Option<Email>, } -#[derive(Default, Debug, Serialize, Eq, PartialEq)] +impl TryFrom<&DomainAddress> for CeleroAddress { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from(address: &DomainAddress) -> Result<Self, Self::Error> { + let address_details = address.address.as_ref(); + match address_details { + Some(address_details) => Ok(Self { + first_name: address_details.get_optional_first_name(), + last_name: address_details.get_optional_last_name(), + address_line_1: address_details.get_optional_line1(), + address_line_2: address_details.get_optional_line2(), + city: address_details.get_optional_city(), + state: address_details.get_optional_state(), + postal_code: address_details.get_optional_zip(), + country: address_details.get_optional_country(), + phone: address + .phone + .as_ref() + .and_then(\|phone\| phone.number.clone()), + email: address.email.clone(), + }), + None => Err(errors::ConnectorError::MissingRequiredField { + field_name: "address_details", + } + .into()), + } + } +} + +#[derive(Debug, Serialize, PartialEq)] +#[serde(rename_all = "lowercase")] +pub enum CeleroPaymentMethod { + Card(CeleroCard), +} + +#[derive(Debug, Serialize, PartialEq, Clone, Copy)] +#[serde(rename_all = "lowercase")] +pub enum CeleroEntryType { + Keyed, +} + +#[derive(Debug, Serialize, PartialEq)] pub struct CeleroCard { + entry_type: CeleroEntryType, number: cards::CardNumber, - expiry_month: Secret<String>, - expiry_year: Secret<String>, + expiration_date: Secret<String>, cvc: Secret<String>, - complete: bool, } -impl TryFrom<&CeleroRouterData<&PaymentsAuthorizeRouterData>> for CeleroPaymentsRequest { +impl TryFrom<&PaymentMethodData> for CeleroPaymentMethod { type Error = error_stack::Report<errors::ConnectorError>; - fn try_from( - item: &CeleroRouterData<&PaymentsAuthorizeRouterData>, - ) -> Result<Self, Self::Error> { - match item.router_data.request.payment_method_data.clone() { + fn try_from(item: &PaymentMethodData) -> Result<Self, Self::Error> { + match item { PaymentMethodData::Card(req_card) => { let card = CeleroCard { - number: req_card.card_number, - expiry_month: req_card.card_exp_month, - expiry_year: req_card.card_exp_year, - cvc: req_card.card_cvc, - complete: item.router_data.request.is_auto_capture()?, + entry_type: CeleroEntryType::Keyed, + number: req_card.card_number.clone(), + expiration_date: Secret::new(format!( + "{}/{}", + req_card.card_exp_month.peek(), + req_card.card_exp_year.peek() + )), + cvc: req_card.card_cvc.clone(), }; - Ok(Self { - amount: item.amount.clone(), - card, - }) + Ok(Self::Card(card)) } - _ => Err(errors::ConnectorError::NotImplemented("Payment method".to_string()).into()), + PaymentMethodData::CardDetailsForNetworkTransactionId(_) + \| PaymentMethodData::CardRedirect(_) + \| PaymentMethodData::Wallet(_) + \| PaymentMethodData::PayLater(_) + \| PaymentMethodData::BankRedirect(_) + \| PaymentMethodData::BankDebit(_) + \| PaymentMethodData::BankTransfer(_) + \| PaymentMethodData::Crypto(_) + \| PaymentMethodData::MandatePayment + \| PaymentMethodData::Reward + \| PaymentMethodData::RealTimePayment(_) + \| PaymentMethodData::Upi(_) + \| PaymentMethodData::Voucher(_) + \| PaymentMethodData::GiftCard(_) + \| PaymentMethodData::CardToken(_) + \| PaymentMethodData::OpenBanking(_) + \| PaymentMethodData::NetworkToken(_) + \| PaymentMethodData::MobilePayment(_) => Err(errors::ConnectorError::NotImplemented( + "Selected payment method through celero".to_string(), + ) + .into()), } } } -//TODO: Fill the struct with respective fields -// Auth Struct +// Implementation for handling 3DS specifically +impl TryFrom<(&PaymentMethodData, bool)> for CeleroPaymentMethod { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from((item, is_three_ds): (&PaymentMethodData, bool)) -> Result<Self, Self::Error> { + // If 3DS is requested, return an error + if is_three_ds { + return Err(errors::ConnectorError::NotSupported { + message: "Cards 3DS".to_string(), + connector: "celero", + } + .into()); + } + + // Otherwise, delegate to the standard implementation + Self::try_from(item) + } +} + +impl TryFrom<&CeleroRouterData<&PaymentsAuthorizeRouterData>> for CeleroPaymentsRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: &CeleroRouterData<&PaymentsAuthorizeRouterData>, + ) -> Result<Self, Self::Error> { + let is_auto_capture = item.router_data.request.is_auto_capture()?; + let transaction_type = if is_auto_capture { + TransactionType::Sale + } else { + TransactionType::Authorize + }; + + let billing_address: Option<CeleroAddress> = item + .router_data + .get_optional_billing() + .and_then(\|address\| address.try_into().ok()); + + let shipping_address: Option<CeleroAddress> = item + .router_data + .get_optional_shipping() + .and_then(\|address\| address.try_into().ok()); + + // Check if 3DS is requested + let is_three_ds = item.router_data.is_three_ds(); + + let request = Self { + idempotency_key: item.router_data.connector_request_reference_id.clone(), + transaction_type, + amount: item.amount, + currency: item.router_data.request.currency, + payment_method: CeleroPaymentMethod::try_from(( + &item.router_data.request.payment_method_data, + is_three_ds, + ))?, + billing_address, + shipping_address, + create_vault_record: Some(false), + }; + + Ok(request) + } +} + +// Auth Struct for CeleroCommerce API key authentication pub struct CeleroAuthType { pub(super) api_key: Secret<String>, } @@ -84,38 +264,100 @@ impl TryFrom<&ConnectorAuthType> for CeleroAuthType { 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(), + api_key: api_key.clone(), }), _ => Err(errors::ConnectorError::FailedToObtainAuthType.into()), } } } -// PaymentsResponse -//TODO: Append the remaining status flags -#[derive(Debug, Clone, Default, Serialize, Deserialize, PartialEq)] -#[serde(rename_all = "lowercase")] -pub enum CeleroPaymentStatus { - Succeeded, - Failed, - #[default] - Processing, +// CeleroCommerce API Response Structures +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +pub enum CeleroResponseStatus { + #[serde(alias = "success", alias = "Success", alias = "SUCCESS")] + Success, + #[serde(alias = "error", alias = "Error", alias = "ERROR")] + Error, } -impl From<CeleroPaymentStatus> for common_enums::AttemptStatus { - fn from(item: CeleroPaymentStatus) -> Self { +#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "snake_case")] +pub enum CeleroTransactionStatus { + Approved, + Declined, + Error, + Pending, + PendingSettlement, + Settled, + Voided, + Reversed, +} + +impl From<CeleroTransactionStatus> for common_enums::AttemptStatus { + fn from(item: CeleroTransactionStatus) -> Self { match item { - CeleroPaymentStatus::Succeeded => Self::Charged, - CeleroPaymentStatus::Failed => Self::Failure, - CeleroPaymentStatus::Processing => Self::Authorizing, + CeleroTransactionStatus::Approved => Self::Authorized, + CeleroTransactionStatus::Settled => Self::Charged, + CeleroTransactionStatus::Declined \| CeleroTransactionStatus::Error => Self::Failure, + CeleroTransactionStatus::Pending \| CeleroTransactionStatus::PendingSettlement => { + Self::Pending + } + CeleroTransactionStatus::Voided \| CeleroTransactionStatus::Reversed => Self::Voided, } } } +#[serde_with::skip_serializing_none] +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +pub struct CeleroCardResponse { + pub status: CeleroTransactionStatus, + pub auth_code: Option<String>, + pub processor_response_code: Option<String>, + pub avs_response_code: Option<String>, +} -//TODO: Fill the struct with respective fields -#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "lowercase")] +pub enum CeleroPaymentMethodResponse { + Card(CeleroCardResponse), +} + +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "lowercase")] +pub enum TransactionType { + Sale, + Authorize, +} +#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)] +#[serde_with::skip_serializing_none] +pub struct CeleroTransactionResponseData { + pub id: String, + #[serde(rename = "type")] + pub transaction_type: TransactionType, + pub amount: i64, + pub currency: String, + pub response: CeleroPaymentMethodResponse, + pub billing_address: Option<CeleroAddressResponse>, + pub shipping_address: Option<CeleroAddressResponse>, +} + +#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)] +pub struct CeleroAddressResponse { + first_name: Option<Secret<String>>, + last_name: Option<Secret<String>>, + address_line_1: Option<Secret<String>>, + address_line_2: Option<Secret<String>>, + city: Option<String>, + state: Option<Secret<String>>, + postal_code: Option<Secret<String>>, + country: Option<common_enums::CountryAlpha2>, + phone: Option<Secret<String>>, + email: Option<Secret<String>>, +} + +#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)] pub struct CeleroPaymentsResponse { - status: CeleroPaymentStatus, - id: String, + pub status: CeleroResponseStatus, + pub msg: String, + pub data: Option<CeleroTransactionResponseData>, } impl<F, T> TryFrom<ResponseRouterData<F, CeleroPaymentsResponse, T, PaymentsResponseData>> @@ -125,104 +367,508 @@ impl<F, T> TryFrom<ResponseRouterData<F, CeleroPaymentsResponse, T, PaymentsResp fn try_from( item: ResponseRouterData<F, CeleroPaymentsResponse, T, PaymentsResponseData>, ) -> Result<Self, Self::Error> { - Ok(Self { - status: common_enums::AttemptStatus::from(item.response.status), - response: Ok(PaymentsResponseData::TransactionResponse { - resource_id: ResponseId::ConnectorTransactionId(item.response.id), - redirection_data: Box::new(None), - mandate_reference: Box::new(None), - connector_metadata: None, - network_txn_id: None, - connector_response_reference_id: None, - incremental_authorization_allowed: None, - charges: None, - }), - ..item.data - }) + match item.response.status { + CeleroResponseStatus::Success => { + if let Some(data) = item.response.data { + let CeleroPaymentMethodResponse::Card(response) = &data.response; + // Check if transaction itself failed despite successful API call + match response.status { + CeleroTransactionStatus::Declined \| CeleroTransactionStatus::Error => { + // Transaction failed - create error response with transaction details + let error_details = CeleroErrorDetails::from_transaction_response( + response, + item.response.msg, + ); + + Ok(Self { + status: common_enums::AttemptStatus::Failure, + response: Err( + hyperswitch_domain_models::router_data::ErrorResponse { + code: error_details + .error_code + .unwrap_or_else(\|\| "TRANSACTION_FAILED".to_string()), + message: error_details.error_message, + reason: error_details.decline_reason, + status_code: item.http_code, + attempt_status: None, + connector_transaction_id: Some(data.id), + network_decline_code: None, + network_advice_code: None, + network_error_message: None, + connector_metadata: None, + }, + ), + ..item.data + }) + } + _ => { + let connector_response_data = + convert_to_additional_payment_method_connector_response( + response.avs_response_code.clone(), + ) + .map(ConnectorResponseData::with_additional_payment_method_data); + let final_status: enums::AttemptStatus = response.status.into(); + Ok(Self { + status: final_status, + response: Ok(PaymentsResponseData::TransactionResponse { + resource_id: ResponseId::ConnectorTransactionId(data.id), + redirection_data: Box::new(None), + mandate_reference: Box::new(None), + connector_metadata: None, + network_txn_id: None, + connector_response_reference_id: response.auth_code.clone(), + incremental_authorization_allowed: None, + charges: None, + }), + connector_response: connector_response_data, + ..item.data + }) + } + } + } else { + // No transaction data in successful response + Ok(Self { + status: common_enums::AttemptStatus::Failure, + response: Err(hyperswitch_domain_models::router_data::ErrorResponse { + code: "MISSING_DATA".to_string(), + message: "No transaction data in response".to_string(), + reason: Some(item.response.msg), + status_code: item.http_code, + attempt_status: None, + connector_transaction_id: None, + network_decline_code: None, + network_advice_code: None, + network_error_message: None, + connector_metadata: None, + }), + ..item.data + }) + } + } + CeleroResponseStatus::Error => { + // Top-level API error + let error_details = + CeleroErrorDetails::from_top_level_error(item.response.msg.clone()); + + Ok(Self { + status: common_enums::AttemptStatus::Failure, + response: Err(hyperswitch_domain_models::router_data::ErrorResponse { + code: error_details + .error_code + .unwrap_or_else(\|\| "API_ERROR".to_string()), + message: error_details.error_message, + reason: error_details.decline_reason, + status_code: item.http_code, + attempt_status: None, + connector_transaction_id: None, + network_decline_code: None, + network_advice_code: None, + network_error_message: None, + connector_metadata: None, + }), + ..item.data + }) + } + } } } -//TODO: Fill the struct with respective fields -// REFUND : -// Type definition for RefundRequest +// CAPTURE: +// Type definition for CaptureRequest #[derive(Default, Debug, Serialize)] -pub struct CeleroRefundRequest { - pub amount: StringMinorUnit, +pub struct CeleroCaptureRequest { + pub amount: MinorUnit, + #[serde(skip_serializing_if = "Option::is_none")] + pub order_id: Option<String>, } -impl<F> TryFrom<&CeleroRouterData<&RefundsRouterData<F>>> for CeleroRefundRequest { +impl TryFrom<&CeleroRouterData<&PaymentsCaptureRouterData>> for CeleroCaptureRequest { type Error = error_stack::Report<errors::ConnectorError>; - fn try_from(item: &CeleroRouterData<&RefundsRouterData<F>>) -> Result<Self, Self::Error> { + fn try_from(item: &CeleroRouterData<&PaymentsCaptureRouterData>) -> Result<Self, Self::Error> { Ok(Self { - amount: item.amount.to_owned(), + amount: item.amount, + order_id: Some(item.router_data.payment_id.clone()), }) } } -// Type definition for Refund Response - -#[allow(dead_code)] -#[derive(Debug, Serialize, Default, Deserialize, Clone)] -pub enum RefundStatus { - Succeeded, - Failed, - #[default] - Processing, +// CeleroCommerce Capture Response +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +pub struct CeleroCaptureResponse { + pub status: CeleroResponseStatus, + pub msg: Option<String>, + pub data: Option<serde_json::Value>, // Usually null for capture responses } -impl From<RefundStatus> for enums::RefundStatus { - fn from(item: RefundStatus) -> Self { - match item { - RefundStatus::Succeeded => Self::Success, - RefundStatus::Failed => Self::Failure, - RefundStatus::Processing => Self::Pending, - //TODO: Review mapping +impl + TryFrom< + ResponseRouterData< + Capture, + CeleroCaptureResponse, + PaymentsCaptureData, + PaymentsResponseData, + >, + > for RouterData<Capture, PaymentsCaptureData, PaymentsResponseData> +{ + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: ResponseRouterData< + Capture, + CeleroCaptureResponse, + PaymentsCaptureData, + PaymentsResponseData, + >, + ) -> Result<Self, Self::Error> { + match item.response.status { + CeleroResponseStatus::Success => Ok(Self { + status: common_enums::AttemptStatus::Charged, + response: Ok(PaymentsResponseData::TransactionResponse { + resource_id: ResponseId::ConnectorTransactionId( + item.data.request.connector_transaction_id.clone(), + ), + redirection_data: Box::new(None), + mandate_reference: Box::new(None), + connector_metadata: None, + network_txn_id: None, + connector_response_reference_id: None, + incremental_authorization_allowed: None, + charges: None, + }), + ..item.data + }), + CeleroResponseStatus::Error => Ok(Self { + status: common_enums::AttemptStatus::Failure, + response: Err(hyperswitch_domain_models::router_data::ErrorResponse { + code: "CAPTURE_FAILED".to_string(), + message: item + .response + .msg + .clone() + .unwrap_or(consts::NO_ERROR_MESSAGE.to_string()), + reason: None, + status_code: item.http_code, + attempt_status: None, + connector_transaction_id: Some( + item.data.request.connector_transaction_id.clone(), + ), + network_decline_code: None, + network_advice_code: None, + network_error_message: None, + connector_metadata: None, + }), + ..item.data + }), } } } -//TODO: Fill the struct with respective fields -#[derive(Default, Debug, Clone, Serialize, Deserialize)] -pub struct RefundResponse { - id: String, - status: RefundStatus, +// CeleroCommerce Void Response - matches API spec format +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +pub struct CeleroVoidResponse { + pub status: CeleroResponseStatus, + pub msg: String, + pub data: Option<serde_json::Value>, // Usually null for void responses } -impl TryFrom<RefundsResponseRouterData<Execute, RefundResponse>> for RefundsRouterData<Execute> { +impl + TryFrom< + ResponseRouterData< + hyperswitch_domain_models::router_flow_types::payments::Void, + CeleroVoidResponse, + hyperswitch_domain_models::router_request_types::PaymentsCancelData, + PaymentsResponseData, + >, + > + for RouterData< + hyperswitch_domain_models::router_flow_types::payments::Void, + hyperswitch_domain_models::router_request_types::PaymentsCancelData, + PaymentsResponseData, + > +{ type Error = error_stack::Report<errors::ConnectorError>; fn try_from( - item: RefundsResponseRouterData<Execute, RefundResponse>, + item: ResponseRouterData< + hyperswitch_domain_models::router_flow_types::payments::Void, + CeleroVoidResponse, + hyperswitch_domain_models::router_request_types::PaymentsCancelData, + PaymentsResponseData, + >, ) -> Result<Self, Self::Error> { - Ok(Self { - response: Ok(RefundsResponseData { - connector_refund_id: item.response.id.to_string(), - refund_status: enums::RefundStatus::from(item.response.status), + match item.response.status { + CeleroResponseStatus::Success => Ok(Self { + status: common_enums::AttemptStatus::Voided, + response: Ok(PaymentsResponseData::TransactionResponse { + resource_id: ResponseId::ConnectorTransactionId( + item.data.request.connector_transaction_id.clone(), + ), + redirection_data: Box::new(None), + mandate_reference: Box::new(None), + connector_metadata: None, + network_txn_id: None, + connector_response_reference_id: None, + incremental_authorization_allowed: None, + charges: None, + }), + ..item.data + }), + CeleroResponseStatus::Error => Ok(Self { + status: common_enums::AttemptStatus::Failure, + response: Err(hyperswitch_domain_models::router_data::ErrorResponse { + code: "VOID_FAILED".to_string(), + message: item.response.msg.clone(), + reason: Some(item.response.msg), + status_code: item.http_code, + attempt_status: None, + connector_transaction_id: Some( + item.data.request.connector_transaction_id.clone(), + ), + network_decline_code: None, + network_advice_code: None, + network_error_message: None, + connector_metadata: None, + }), + ..item.data }), - ..item.data + } + } +} +#[derive(Default, Debug, Serialize)] +pub struct CeleroRefundRequest { + pub amount: MinorUnit, + pub surcharge: MinorUnit, // Required field as per API specification +} + +impl<F> TryFrom<&CeleroRouterData<&RefundsRouterData<F>>> for CeleroRefundRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from(item: &CeleroRouterData<&RefundsRouterData<F>>) -> Result<Self, Self::Error> { + Ok(Self { + amount: item.amount, + surcharge: MinorUnit::zero(), // Default to 0 as per API specification }) } } -impl TryFrom<RefundsResponseRouterData<RSync, RefundResponse>> for RefundsRouterData<RSync> { +// CeleroCommerce Refund Response - matches API spec format +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +pub struct CeleroRefundResponse { + pub status: CeleroResponseStatus, + pub msg: String, + pub data: Option<serde_json::Value>, // Usually null for refund responses +} + +impl TryFrom<RefundsResponseRouterData<Execute, CeleroRefundResponse>> + for RefundsRouterData<Execute> +{ type Error = error_stack::Report<errors::ConnectorError>; fn try_from( - item: RefundsResponseRouterData<RSync, RefundResponse>, + item: RefundsResponseRouterData<Execute, CeleroRefundResponse>, ) -> Result<Self, Self::Error> { - Ok(Self { - response: Ok(RefundsResponseData { - connector_refund_id: item.response.id.to_string(), - refund_status: enums::RefundStatus::from(item.response.status), + match item.response.status { + CeleroResponseStatus::Success => Ok(Self { + response: Ok(RefundsResponseData { + connector_refund_id: item.data.request.refund_id.clone(), + refund_status: enums::RefundStatus::Success, + }), + ..item.data }), - ..item.data - }) + CeleroResponseStatus::Error => Ok(Self { + response: Err(hyperswitch_domain_models::router_data::ErrorResponse { + code: "REFUND_FAILED".to_string(), + message: item.response.msg.clone(), + reason: Some(item.response.msg), + status_code: item.http_code, + attempt_status: None, + connector_transaction_id: Some( + item.data.request.connector_transaction_id.clone(), + ), + network_decline_code: None, + network_advice_code: None, + network_error_message: None, + connector_metadata: None, + }), + ..item.data + }), + } } } -//TODO: Fill the struct with respective fields -#[derive(Default, Debug, Serialize, Deserialize, PartialEq)] +impl TryFrom<RefundsResponseRouterData<RSync, CeleroRefundResponse>> for RefundsRouterData<RSync> { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: RefundsResponseRouterData<RSync, CeleroRefundResponse>, + ) -> Result<Self, Self::Error> { + match item.response.status { + CeleroResponseStatus::Success => Ok(Self { + response: Ok(RefundsResponseData { + connector_refund_id: item.data.request.refund_id.clone(), + refund_status: enums::RefundStatus::Success, + }), + ..item.data + }), + CeleroResponseStatus::Error => Ok(Self { + response: Err(hyperswitch_domain_models::router_data::ErrorResponse { + code: "REFUND_SYNC_FAILED".to_string(), + message: item.response.msg.clone(), + reason: Some(item.response.msg), + status_code: item.http_code, + attempt_status: None, + connector_transaction_id: Some( + item.data.request.connector_transaction_id.clone(), + ), + network_decline_code: None, + network_advice_code: None, + network_error_message: None, + connector_metadata: None, + }), + ..item.data + }), + } + } +} + +// CeleroCommerce Error Response Structures + +// Main error response structure - matches API spec format +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] pub struct CeleroErrorResponse { - pub status_code: u16, - pub code: String, - pub message: String, - pub reason: Option<String>, + pub status: CeleroResponseStatus, + pub msg: String, + #[serde(skip_serializing_if = "Option::is_none")] + pub data: Option<serde_json::Value>, +} + +// Error details that can be extracted from various response fields +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +pub struct CeleroErrorDetails { + pub error_code: Option<String>, + pub error_message: String, + pub processor_response_code: Option<String>, + pub decline_reason: Option<String>, +} + +impl From<CeleroErrorResponse> for CeleroErrorDetails { + fn from(error_response: CeleroErrorResponse) -> Self { + Self { + error_code: Some("API_ERROR".to_string()), + error_message: error_response.msg, + processor_response_code: None, + decline_reason: None, + } + } +} + +// Function to extract error details from transaction response data +impl CeleroErrorDetails { + pub fn from_transaction_response(response: &CeleroCardResponse, msg: String) -> Self { + // Map specific error codes based on common response patterns + let decline_reason = Self::map_processor_error(&response.processor_response_code, &msg); + + Self { + error_code: None, + error_message: msg, + processor_response_code: response.processor_response_code.clone(), + decline_reason, + } + } + + pub fn from_top_level_error(msg: String) -> Self { + // Map specific error codes from top-level API errors + + Self { + error_code: None, + error_message: msg, + processor_response_code: None, + decline_reason: None, + } + } + + /// Map processor response codes and messages to specific Hyperswitch error codes + fn map_processor_error(processor_code: &Option<String>, message: &str) -> Option<String> { + let message_lower = message.to_lowercase(); + // Check processor response codes if available + if let Some(code) = processor_code { + match code.as_str() { + "05" => Some("TRANSACTION_DECLINED".to_string()), + "14" => Some("INVALID_CARD_DATA".to_string()), + "51" => Some("INSUFFICIENT_FUNDS".to_string()), + "54" => Some("EXPIRED_CARD".to_string()), + "55" => Some("INCORRECT_CVC".to_string()), + "61" => Some("Exceeds withdrawal amount limit".to_string()), + "62" => Some("TRANSACTION_DECLINED".to_string()), + "65" => Some("Exceeds withdrawal frequency limit".to_string()), + "78" => Some("INVALID_CARD_DATA".to_string()), + "91" => Some("PROCESSING_ERROR".to_string()), + "96" => Some("PROCESSING_ERROR".to_string()), + _ => { + router_env::logger::info!( + "Celero response error code ({:?}) is not mapped to any error state ", + code + ); + Some("Transaction failed".to_string()) + } + } + } else { + Some(message_lower) + } + } +} + +pub fn get_avs_definition(code: &str) -> Option<&'static str> { + match code { + "0" => Some("AVS Not Available"), + "A" => Some("Address match only"), + "B" => Some("Address matches, ZIP not verified"), + "C" => Some("Incompatible format"), + "D" => Some("Exact match"), + "F" => Some("Exact match, UK-issued cards"), + "G" => Some("Non-U.S. Issuer does not participate"), + "I" => Some("Not verified"), + "M" => Some("Exact match"), + "N" => Some("No address or ZIP match"), + "P" => Some("Postal Code match"), + "R" => Some("Issuer system unavailable"), + "S" => Some("Service not supported"), + "U" => Some("Address unavailable"), + "W" => Some("9-character numeric ZIP match only"), + "X" => Some("Exact match, 9-character numeric ZIP"), + "Y" => Some("Exact match, 5-character numeric ZIP"), + "Z" => Some("5-character ZIP match only"), + "L" => Some("Partial match, Name and billing postal code match"), + "1" => Some("Cardholder name and ZIP match"), + "2" => Some("Cardholder name, address and ZIP match"), + "3" => Some("Cardholder name and address match"), + "4" => Some("Cardholder name matches"), + "5" => Some("Cardholder name incorrect, ZIP matches"), + "6" => Some("Cardholder name incorrect, address and zip match"), + "7" => Some("Cardholder name incorrect, address matches"), + "8" => Some("Cardholder name, address, and ZIP do not match"), + _ => { + router_env::logger::info!( + "Celero avs response code ({:?}) is not mapped to any defination.", + code + ); + + None + } // No definition found for the given code + } +} +fn convert_to_additional_payment_method_connector_response( + response_code: Option<String>, +) -> Option<AdditionalPaymentMethodConnectorResponse> { + match response_code { + None => None, + Some(code) => { + let description = get_avs_definition(&code); + let payment_checks = serde_json::json!({ + "avs_result_code": code, + "description": description + }); + Some(AdditionalPaymentMethodConnectorResponse::Card { + authentication_data: None, + payment_checks: Some(payment_checks), + card_network: None, + domestic_network: None, + }) + } + } } diff --git a/crates/payment_methods/src/configs/payment_connector_required_fields.rs b/crates/payment_methods/src/configs/payment_connector_required_fields.rs index 5ce306c5976..15a4ef90a95 100644 --- a/crates/payment_methods/src/configs/payment_connector_required_fields.rs +++ b/crates/payment_methods/src/configs/payment_connector_required_fields.rs @@ -1305,6 +1305,7 @@ fn get_cards_required_fields() -> HashMap<Connector, RequiredFieldFinal> { ), (Connector::Boku, fields(vec![], vec![], card_basic())), (Connector::Braintree, fields(vec![], vec![], card_basic())), + (Connector::Celero, fields(vec![], vec![], card_basic())), (Connector::Checkout, fields(vec![], card_basic(), vec![])), ( Connector::Coinbase,	2025-07-08T05:02:05Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> Integrate celero commerce connector Doc : https://sandbox.gotnpgateway.com/docs/api/transactions [x] Cards [x] Avs ### Additional Changes - [x] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> MOCK SERVER results <img width="803" height="920" alt="Screenshot 2025-08-05 at 11 37 29 AM" src="https://github.com/user-attachments/assets/19bee0c6-f0e4-4123-b423-b959c229899b" /> <img width="560" height="926" alt="Screenshot 2025-08-05 at 11 37 38 AM" src="https://github.com/user-attachments/assets/2e9c08e7-aba4-4799-b3b5-4a0f3df9360e" /> <img width="930" height="1001" alt="Screenshot 2025-08-05 at 11 37 54 AM" src="https://github.com/user-attachments/assets/e8b202e1-a5a0-4afe-8574-93944b61d816" /> ![Uploading Screenshot 2025-08-06 at 3.00.16 PM.png…]() ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> https://github.com/juspay/hyperswitch/issues/8575 ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> No creds for testing ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [x] I added unit tests for my changes where possible	v1.116.0	a56d78a46a3ee80cdb2b48f9abfd2cd7b297e328	a56d78a46a3ee80cdb2b48f9abfd2cd7b297e328
juspay/hyperswitch	juspay__hyperswitch-8556	Bug: [FEATURE] Add auto retries configs in profile CRUD apis ### Feature Description Add auto retries configs in profile CRUD apis 1. is_auto_retries_enabled - Boolean (denotes whether auto retries should be performed for a profile) 2. max_auto_retries_enabled - Int (i16) (maximum auto retries to be performed) ### Possible Implementation Create two new fields in Profile Create, Update APIs and then send them back in the Profile Response	diff --git a/api-reference/openapi_spec.json b/api-reference/openapi_spec.json index dfcaf157c21..50278f2b00f 100644 --- a/api-reference/openapi_spec.json +++ b/api-reference/openapi_spec.json @@ -20944,6 +20944,18 @@ "is_network_tokenization_enabled": { "type": "boolean", "description": "Indicates if is_network_tokenization_enabled is enabled or not.\nIf set to `true` is_network_tokenization_enabled will be checked." + }, + "is_auto_retries_enabled": { + "type": "boolean", + "description": "Indicates if is_auto_retries_enabled is enabled or not.", + "nullable": true + }, + "max_auto_retries_enabled": { + "type": "integer", + "format": "int32", + "description": "Maximum number of auto retries allowed for a payment", + "nullable": true, + "minimum": 0 } }, "additionalProperties": false @@ -20975,7 +20987,8 @@ "enable_payment_response_hash", "redirect_to_merchant_with_http_post", "is_tax_connector_enabled", - "is_network_tokenization_enabled" + "is_network_tokenization_enabled", + "is_auto_retries_enabled" ], "properties": { "merchant_id": { @@ -21160,6 +21173,18 @@ "description": "Indicates if is_network_tokenization_enabled is enabled or not.\nIf set to `true` is_network_tokenization_enabled will be checked.", "default": false, "example": false + }, + "is_auto_retries_enabled": { + "type": "boolean", + "description": "Indicates if is_auto_retries_enabled is enabled or not.", + "default": false, + "example": false + }, + "max_auto_retries_enabled": { + "type": "integer", + "format": "int32", + "description": "Maximum number of auto retries allowed for a payment", + "nullable": true } } }, diff --git a/crates/api_models/src/admin.rs b/crates/api_models/src/admin.rs index 6f656339569..6e7f4f29d03 100644 --- a/crates/api_models/src/admin.rs +++ b/crates/api_models/src/admin.rs @@ -1971,6 +1971,12 @@ pub struct ProfileCreate { /// If set to `true` is_network_tokenization_enabled will be checked. #[serde(default)] pub is_network_tokenization_enabled: bool, + + /// Indicates if is_auto_retries_enabled is enabled or not. + pub is_auto_retries_enabled: Option<bool>, + + /// Maximum number of auto retries allowed for a payment + pub max_auto_retries_enabled: Option<u8>, } #[nutype::nutype( @@ -2202,6 +2208,13 @@ pub struct ProfileResponse { /// If set to `true` is_network_tokenization_enabled will be checked. #[schema(default = false, example = false)] pub is_network_tokenization_enabled: bool, + + /// Indicates if is_auto_retries_enabled is enabled or not. + #[schema(default = false, example = false)] + pub is_auto_retries_enabled: bool, + + /// Maximum number of auto retries allowed for a payment + pub max_auto_retries_enabled: Option<i16>, } #[cfg(feature = "v2")] @@ -2431,6 +2444,12 @@ pub struct ProfileUpdate { /// Indicates if is_network_tokenization_enabled is enabled or not. pub is_network_tokenization_enabled: Option<bool>, + + /// Indicates if is_auto_retries_enabled is enabled or not. + pub is_auto_retries_enabled: Option<bool>, + + /// Maximum number of auto retries allowed for a payment + pub max_auto_retries_enabled: Option<u8>, } #[cfg(feature = "v2")] diff --git a/crates/diesel_models/src/business_profile.rs b/crates/diesel_models/src/business_profile.rs index 4edc2ba2432..fd0abc16614 100644 --- a/crates/diesel_models/src/business_profile.rs +++ b/crates/diesel_models/src/business_profile.rs @@ -55,6 +55,8 @@ pub struct Profile { pub version: common_enums::ApiVersion, pub dynamic_routing_algorithm: Option<serde_json::Value>, pub is_network_tokenization_enabled: bool, + pub is_auto_retries_enabled: Option<bool>, + pub max_auto_retries_enabled: Option<i16>, } #[cfg(feature = "v1")] @@ -96,6 +98,8 @@ pub struct ProfileNew { pub is_tax_connector_enabled: Option<bool>, pub version: common_enums::ApiVersion, pub is_network_tokenization_enabled: bool, + pub is_auto_retries_enabled: Option<bool>, + pub max_auto_retries_enabled: Option<i16>, } #[cfg(feature = "v1")] @@ -134,6 +138,8 @@ pub struct ProfileUpdateInternal { pub is_tax_connector_enabled: Option<bool>, pub dynamic_routing_algorithm: Option<serde_json::Value>, pub is_network_tokenization_enabled: Option<bool>, + pub is_auto_retries_enabled: Option<bool>, + pub max_auto_retries_enabled: Option<i16>, } #[cfg(feature = "v1")] @@ -171,6 +177,8 @@ impl ProfileUpdateInternal { is_tax_connector_enabled, dynamic_routing_algorithm, is_network_tokenization_enabled, + is_auto_retries_enabled, + max_auto_retries_enabled, } = self; Profile { profile_id: source.profile_id, @@ -228,6 +236,8 @@ impl ProfileUpdateInternal { .or(source.dynamic_routing_algorithm), is_network_tokenization_enabled: is_network_tokenization_enabled .unwrap_or(source.is_network_tokenization_enabled), + is_auto_retries_enabled: is_auto_retries_enabled.or(source.is_auto_retries_enabled), + max_auto_retries_enabled: max_auto_retries_enabled.or(source.max_auto_retries_enabled), } } } @@ -279,6 +289,8 @@ pub struct Profile { pub version: common_enums::ApiVersion, pub dynamic_routing_algorithm: Option<serde_json::Value>, pub is_network_tokenization_enabled: bool, + pub is_auto_retries_enabled: Option<bool>, + pub max_auto_retries_enabled: Option<i16>, } impl Profile { @@ -334,6 +346,8 @@ pub struct ProfileNew { pub id: common_utils::id_type::ProfileId, pub version: common_enums::ApiVersion, pub is_network_tokenization_enabled: bool, + pub is_auto_retries_enabled: Option<bool>, + pub max_auto_retries_enabled: Option<i16>, } #[cfg(feature = "v2")] @@ -373,6 +387,8 @@ pub struct ProfileUpdateInternal { pub payout_routing_algorithm_id: Option<common_utils::id_type::RoutingId>, pub default_fallback_routing: Option<pii::SecretSerdeValue>, pub is_network_tokenization_enabled: Option<bool>, + pub is_auto_retries_enabled: Option<bool>, + pub max_auto_retries_enabled: Option<i16>, } #[cfg(feature = "v2")] @@ -411,6 +427,8 @@ impl ProfileUpdateInternal { payout_routing_algorithm_id, default_fallback_routing, is_network_tokenization_enabled, + is_auto_retries_enabled, + max_auto_retries_enabled, } = self; Profile { id: source.id, @@ -471,6 +489,8 @@ impl ProfileUpdateInternal { dynamic_routing_algorithm: None, is_network_tokenization_enabled: is_network_tokenization_enabled .unwrap_or(source.is_network_tokenization_enabled), + is_auto_retries_enabled: is_auto_retries_enabled.or(source.is_auto_retries_enabled), + max_auto_retries_enabled: max_auto_retries_enabled.or(source.max_auto_retries_enabled), } } } diff --git a/crates/diesel_models/src/schema.rs b/crates/diesel_models/src/schema.rs index 9ff7c958df1..fe22dcd87a3 100644 --- a/crates/diesel_models/src/schema.rs +++ b/crates/diesel_models/src/schema.rs @@ -211,6 +211,8 @@ diesel::table! { version -> ApiVersion, dynamic_routing_algorithm -> Nullable<Json>, is_network_tokenization_enabled -> Bool, + is_auto_retries_enabled -> Nullable<Bool>, + max_auto_retries_enabled -> Nullable<Int2>, } } diff --git a/crates/diesel_models/src/schema_v2.rs b/crates/diesel_models/src/schema_v2.rs index a66286e02db..674123fbaae 100644 --- a/crates/diesel_models/src/schema_v2.rs +++ b/crates/diesel_models/src/schema_v2.rs @@ -218,6 +218,8 @@ diesel::table! { version -> ApiVersion, dynamic_routing_algorithm -> Nullable<Json>, is_network_tokenization_enabled -> Bool, + is_auto_retries_enabled -> Nullable<Bool>, + max_auto_retries_enabled -> Nullable<Int2>, } } diff --git a/crates/hyperswitch_domain_models/src/business_profile.rs b/crates/hyperswitch_domain_models/src/business_profile.rs index 156ca4d2feb..75cdd40024f 100644 --- a/crates/hyperswitch_domain_models/src/business_profile.rs +++ b/crates/hyperswitch_domain_models/src/business_profile.rs @@ -56,6 +56,8 @@ pub struct Profile { pub version: common_enums::ApiVersion, pub dynamic_routing_algorithm: Option<serde_json::Value>, pub is_network_tokenization_enabled: bool, + pub is_auto_retries_enabled: bool, + pub max_auto_retries_enabled: Option<i16>, } #[cfg(feature = "v1")] @@ -94,6 +96,8 @@ pub struct ProfileSetter { pub is_tax_connector_enabled: bool, pub dynamic_routing_algorithm: Option<serde_json::Value>, pub is_network_tokenization_enabled: bool, + pub is_auto_retries_enabled: bool, + pub max_auto_retries_enabled: Option<i16>, } #[cfg(feature = "v1")] @@ -139,6 +143,8 @@ impl From<ProfileSetter> for Profile { version: consts::API_VERSION, dynamic_routing_algorithm: value.dynamic_routing_algorithm, is_network_tokenization_enabled: value.is_network_tokenization_enabled, + is_auto_retries_enabled: value.is_auto_retries_enabled, + max_auto_retries_enabled: value.max_auto_retries_enabled, } } } @@ -186,6 +192,8 @@ pub struct ProfileGeneralUpdate { pub is_tax_connector_enabled: Option<bool>, pub dynamic_routing_algorithm: Option<serde_json::Value>, pub is_network_tokenization_enabled: Option<bool>, + pub is_auto_retries_enabled: Option<bool>, + pub max_auto_retries_enabled: Option<i16>, } #[cfg(feature = "v1")] @@ -246,6 +254,8 @@ impl From<ProfileUpdate> for ProfileUpdateInternal { is_tax_connector_enabled, dynamic_routing_algorithm, is_network_tokenization_enabled, + is_auto_retries_enabled, + max_auto_retries_enabled, } = *update; Self { @@ -281,6 +291,8 @@ impl From<ProfileUpdate> for ProfileUpdateInternal { is_tax_connector_enabled, dynamic_routing_algorithm, is_network_tokenization_enabled, + is_auto_retries_enabled, + max_auto_retries_enabled, } } ProfileUpdate::RoutingAlgorithmUpdate { @@ -318,6 +330,8 @@ impl From<ProfileUpdate> for ProfileUpdateInternal { is_tax_connector_enabled: None, dynamic_routing_algorithm: None, is_network_tokenization_enabled: None, + is_auto_retries_enabled: None, + max_auto_retries_enabled: None, }, ProfileUpdate::DynamicRoutingAlgorithmUpdate { dynamic_routing_algorithm, @@ -353,6 +367,8 @@ impl From<ProfileUpdate> for ProfileUpdateInternal { is_tax_connector_enabled: None, dynamic_routing_algorithm, is_network_tokenization_enabled: None, + is_auto_retries_enabled: None, + max_auto_retries_enabled: None, }, ProfileUpdate::ExtendedCardInfoUpdate { is_extended_card_info_enabled, @@ -388,6 +404,8 @@ impl From<ProfileUpdate> for ProfileUpdateInternal { is_tax_connector_enabled: None, dynamic_routing_algorithm: None, is_network_tokenization_enabled: None, + is_auto_retries_enabled: None, + max_auto_retries_enabled: None, }, ProfileUpdate::ConnectorAgnosticMitUpdate { is_connector_agnostic_mit_enabled, @@ -423,6 +441,8 @@ impl From<ProfileUpdate> for ProfileUpdateInternal { is_tax_connector_enabled: None, dynamic_routing_algorithm: None, is_network_tokenization_enabled: None, + is_auto_retries_enabled: None, + max_auto_retries_enabled: None, }, ProfileUpdate::NetworkTokenizationUpdate { is_network_tokenization_enabled, @@ -458,6 +478,8 @@ impl From<ProfileUpdate> for ProfileUpdateInternal { is_tax_connector_enabled: None, dynamic_routing_algorithm: None, is_network_tokenization_enabled, + is_auto_retries_enabled: None, + max_auto_retries_enabled: None, }, } } @@ -512,6 +534,8 @@ impl super::behaviour::Conversion for Profile { version: self.version, dynamic_routing_algorithm: self.dynamic_routing_algorithm, is_network_tokenization_enabled: self.is_network_tokenization_enabled, + is_auto_retries_enabled: Some(self.is_auto_retries_enabled), + max_auto_retries_enabled: self.max_auto_retries_enabled, }) } @@ -578,6 +602,8 @@ impl super::behaviour::Conversion for Profile { version: item.version, dynamic_routing_algorithm: item.dynamic_routing_algorithm, is_network_tokenization_enabled: item.is_network_tokenization_enabled, + is_auto_retries_enabled: item.is_auto_retries_enabled.unwrap_or(false), + max_auto_retries_enabled: item.max_auto_retries_enabled, }) } .await @@ -628,6 +654,8 @@ impl super::behaviour::Conversion for Profile { is_tax_connector_enabled: Some(self.is_tax_connector_enabled), version: self.version, is_network_tokenization_enabled: self.is_network_tokenization_enabled, + is_auto_retries_enabled: Some(self.is_auto_retries_enabled), + max_auto_retries_enabled: self.max_auto_retries_enabled, }) } } @@ -896,6 +924,8 @@ impl From<ProfileUpdate> for ProfileUpdateInternal { tax_connector_id: None, is_tax_connector_enabled: None, is_network_tokenization_enabled, + is_auto_retries_enabled: None, + max_auto_retries_enabled: None, } } ProfileUpdate::RoutingAlgorithmUpdate { @@ -934,6 +964,8 @@ impl From<ProfileUpdate> for ProfileUpdateInternal { tax_connector_id: None, is_tax_connector_enabled: None, is_network_tokenization_enabled: None, + is_auto_retries_enabled: None, + max_auto_retries_enabled: None, }, ProfileUpdate::ExtendedCardInfoUpdate { is_extended_card_info_enabled, @@ -970,6 +1002,8 @@ impl From<ProfileUpdate> for ProfileUpdateInternal { tax_connector_id: None, is_tax_connector_enabled: None, is_network_tokenization_enabled: None, + is_auto_retries_enabled: None, + max_auto_retries_enabled: None, }, ProfileUpdate::ConnectorAgnosticMitUpdate { is_connector_agnostic_mit_enabled, @@ -1006,6 +1040,8 @@ impl From<ProfileUpdate> for ProfileUpdateInternal { tax_connector_id: None, is_tax_connector_enabled: None, is_network_tokenization_enabled: None, + is_auto_retries_enabled: None, + max_auto_retries_enabled: None, }, ProfileUpdate::DefaultRoutingFallbackUpdate { default_fallback_routing, @@ -1042,6 +1078,8 @@ impl From<ProfileUpdate> for ProfileUpdateInternal { tax_connector_id: None, is_tax_connector_enabled: None, is_network_tokenization_enabled: None, + is_auto_retries_enabled: None, + max_auto_retries_enabled: None, }, ProfileUpdate::NetworkTokenizationUpdate { is_network_tokenization_enabled, @@ -1078,6 +1116,8 @@ impl From<ProfileUpdate> for ProfileUpdateInternal { tax_connector_id: None, is_tax_connector_enabled: None, is_network_tokenization_enabled, + is_auto_retries_enabled: None, + max_auto_retries_enabled: None, }, } } @@ -1134,6 +1174,8 @@ impl super::behaviour::Conversion for Profile { version: self.version, dynamic_routing_algorithm: None, is_network_tokenization_enabled: self.is_network_tokenization_enabled, + is_auto_retries_enabled: None, + max_auto_retries_enabled: None, }) } @@ -1253,6 +1295,8 @@ impl super::behaviour::Conversion for Profile { is_tax_connector_enabled: Some(self.is_tax_connector_enabled), version: self.version, is_network_tokenization_enabled: self.is_network_tokenization_enabled, + is_auto_retries_enabled: None, + max_auto_retries_enabled: None, }) } } diff --git a/crates/router/src/core/admin.rs b/crates/router/src/core/admin.rs index ad9925a241f..d27b6b82fd4 100644 --- a/crates/router/src/core/admin.rs +++ b/crates/router/src/core/admin.rs @@ -3537,6 +3537,8 @@ impl ProfileCreateBridge for api::ProfileCreate { .always_collect_shipping_details_from_wallet_connector, dynamic_routing_algorithm: None, is_network_tokenization_enabled: self.is_network_tokenization_enabled, + is_auto_retries_enabled: self.is_auto_retries_enabled.unwrap_or_default(), + max_auto_retries_enabled: self.max_auto_retries_enabled.map(i16::from), })) } @@ -3884,6 +3886,8 @@ impl ProfileUpdateBridge for api::ProfileUpdate { is_tax_connector_enabled: self.is_tax_connector_enabled, dynamic_routing_algorithm: self.dynamic_routing_algorithm, is_network_tokenization_enabled: self.is_network_tokenization_enabled, + is_auto_retries_enabled: self.is_auto_retries_enabled, + max_auto_retries_enabled: self.max_auto_retries_enabled.map(i16::from), }, ))) } diff --git a/crates/router/src/types/api/admin.rs b/crates/router/src/types/api/admin.rs index c7b76d1780a..8d52e5dc11a 100644 --- a/crates/router/src/types/api/admin.rs +++ b/crates/router/src/types/api/admin.rs @@ -168,6 +168,8 @@ impl ForeignTryFrom<domain::Profile> for ProfileResponse { tax_connector_id: item.tax_connector_id, is_tax_connector_enabled: item.is_tax_connector_enabled, is_network_tokenization_enabled: item.is_network_tokenization_enabled, + is_auto_retries_enabled: item.is_auto_retries_enabled, + max_auto_retries_enabled: item.max_auto_retries_enabled, }) } } @@ -353,5 +355,7 @@ pub async fn create_profile_from_merchant_account( is_tax_connector_enabled: request.is_tax_connector_enabled, dynamic_routing_algorithm: None, is_network_tokenization_enabled: request.is_network_tokenization_enabled, + is_auto_retries_enabled: request.is_auto_retries_enabled.unwrap_or_default(), + max_auto_retries_enabled: request.max_auto_retries_enabled.map(i16::from), })) } diff --git a/migrations/2024-09-26-113912_add-auto-retries-configs-in-profile/down.sql b/migrations/2024-09-26-113912_add-auto-retries-configs-in-profile/down.sql new file mode 100644 index 00000000000..3751f25da4b --- /dev/null +++ b/migrations/2024-09-26-113912_add-auto-retries-configs-in-profile/down.sql @@ -0,0 +1,6 @@ +-- This file should undo anything in `up.sql` +-- Drop is_auto_retries_enabled column from business_profile table +ALTER TABLE business_profile DROP COLUMN IF EXISTS is_auto_retries_enabled; + +-- Drop max_auto_retries_enabled column from business_profile table +ALTER TABLE business_profile DROP COLUMN IF EXISTS max_auto_retries_enabled; diff --git a/migrations/2024-09-26-113912_add-auto-retries-configs-in-profile/up.sql b/migrations/2024-09-26-113912_add-auto-retries-configs-in-profile/up.sql new file mode 100644 index 00000000000..05b6a114a31 --- /dev/null +++ b/migrations/2024-09-26-113912_add-auto-retries-configs-in-profile/up.sql @@ -0,0 +1,6 @@ +-- Your SQL goes here +-- Add is_auto_retries_enabled column in business_profile table +ALTER TABLE business_profile ADD COLUMN IF NOT EXISTS is_auto_retries_enabled BOOLEAN; + +-- Add max_auto_retries_enabled column in business_profile table +ALTER TABLE business_profile ADD COLUMN IF NOT EXISTS max_auto_retries_enabled SMALLINT;	2024-09-26T17:43:50Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> add auto retries configs in profile CRUD apis 1. is_auto_retries_enabled - Boolean (denotes whether auto retries should be performed for a profile) 2. max_auto_retries_enabled - Int (maximum auto retries to be performed) closes - https://github.com/juspay/hyperswitch/issues/8556 ### Additional Changes - [x] This PR modifies the API contract - [x] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 4. `crates/router/src/configs` 5. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> Tested Manually 1. Profile Create ``` curl --location '{{BASE_URL}}/account/{{MERCHANT_ID}}/business_profile' \ --header 'Content-Type: application/json' \ --header 'api-key: {{ADMIN_API_KEY}}' \ --data '{ "is_auto_retries_enabled": true, "max_auto_retries_enabled": 1 }' ``` Response `{ "merchant_id": "merchant_1727371477", "profile_id": "pro_jIc12oz9zLreWO4gJqXZ", "profile_name": "default", "return_url": "https://example.com/success", "enable_payment_response_hash": true, "payment_response_hash_key": "uskD31l0vpyRXItGriQ2FZvyhgNJvY5eo3rpy7mnJ0iqm0ExGMgenVstuaVaTxtI", "redirect_to_merchant_with_http_post": false, "webhook_details": { "webhook_version": "1.0.1", "webhook_username": "ekart_retail", "webhook_password": "password_ekart@123", "webhook_url": "https://eop67yav2axa2pv.m.pipedream.net/", "payment_created_enabled": true, "payment_succeeded_enabled": true, "payment_failed_enabled": true }, "metadata": null, "routing_algorithm": null, "intent_fulfillment_time": 900, "frm_routing_algorithm": null, "payout_routing_algorithm": null, "applepay_verified_domains": null, "session_expiry": 900, "payment_link_config": null, "authentication_connector_details": null, "use_billing_as_payment_method_billing": true, "extended_card_info_config": null, "collect_shipping_details_from_wallet_connector": false, "collect_billing_details_from_wallet_connector": false, "always_collect_shipping_details_from_wallet_connector": false, "always_collect_billing_details_from_wallet_connector": false, "is_connector_agnostic_mit_enabled": false, "payout_link_config": null, "outgoing_webhook_custom_http_headers": null, "tax_connector_id": null, "is_tax_connector_enabled": false, "is_network_tokenization_enabled": false, "is_auto_retries_enabled": true, "max_auto_retries_enabled": 1 }` 2. Profile Update ``` curl --location '{{BASE_URL}}/account/{{MERCHANT_ID}}/business_profile/{{PROFILE_ID}}' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: {{ADMIN_API_KEY}}' \ --data '{ "is_auto_retries_enabled": false, "max_auto_retries_enabled": 2 }' ``` Response: `{ "merchant_id": "merchant_1727371477", "profile_id": "pro_jIc12oz9zLreWO4gJqXZ", "profile_name": "default", "return_url": "https://example.com/success", "enable_payment_response_hash": true, "payment_response_hash_key": "uskD31l0vpyRXItGriQ2FZvyhgNJvY5eo3rpy7mnJ0iqm0ExGMgenVstuaVaTxtI", "redirect_to_merchant_with_http_post": false, "webhook_details": { "webhook_version": "1.0.1", "webhook_username": "ekart_retail", "webhook_password": "password_ekart@123", "webhook_url": "https://eop67yav2axa2pv.m.pipedream.net/", "payment_created_enabled": true, "payment_succeeded_enabled": true, "payment_failed_enabled": true }, "metadata": null, "routing_algorithm": null, "intent_fulfillment_time": 900, "frm_routing_algorithm": null, "payout_routing_algorithm": null, "applepay_verified_domains": null, "session_expiry": 900, "payment_link_config": null, "authentication_connector_details": null, "use_billing_as_payment_method_billing": true, "extended_card_info_config": null, "collect_shipping_details_from_wallet_connector": false, "collect_billing_details_from_wallet_connector": false, "always_collect_shipping_details_from_wallet_connector": false, "always_collect_billing_details_from_wallet_connector": false, "is_connector_agnostic_mit_enabled": false, "payout_link_config": null, "outgoing_webhook_custom_http_headers": null, "tax_connector_id": null, "is_tax_connector_enabled": false, "is_network_tokenization_enabled": false, "is_auto_retries_enabled": false, "max_auto_retries_enabled": 2 }` ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.111.0	5912936f9f2178f002c96e25636b25f532b1ecb2	5912936f9f2178f002c96e25636b25f532b1ecb2
juspay/hyperswitch	juspay__hyperswitch-8537	Bug: [FEATURE] Multisafe pay : EPS \| MBWAY \| SOFORT ### Feature Description Integrate EPS \| MBWAY \| SOFORT for multisafepay ### Possible Implementation integrate payments menthods ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? None	diff --git a/config/deployments/integration_test.toml b/config/deployments/integration_test.toml index 6d5cfb6585a..fcf7f12ec3d 100644 --- a/config/deployments/integration_test.toml +++ b/config/deployments/integration_test.toml @@ -229,12 +229,12 @@ wallet.twint.connector_list = "adyen" wallet.vipps.connector_list = "adyen" bank_redirect.ideal.connector_list = "stripe,adyen,globalpay,multisafepay,nexinets,aci" -bank_redirect.sofort.connector_list = "globalpay,aci" +bank_redirect.sofort.connector_list = "globalpay,aci,multisafepay" bank_redirect.giropay.connector_list = "globalpay,multisafepay,nexinets,aci" bank_redirect.bancontact_card.connector_list="adyen,stripe" bank_redirect.trustly.connector_list="adyen,aci" bank_redirect.open_banking_uk.connector_list="adyen" -bank_redirect.eps.connector_list="globalpay,nexinets,aci" +bank_redirect.eps.connector_list="globalpay,nexinets,aci,multisafepay" [mandates.update_mandate_supported] card.credit = { connector_list = "cybersource" } # Update Mandate supported payment method type and connector for card @@ -548,6 +548,9 @@ klarna = { country = "AT,BE,DK,FI,FR,DE,IT,NL,NO,PT,ES,SE,GB", currency = "DKK,E trustly = { country = "AT,CZ,DK,EE,FI,DE,LV,LT,NL,NO,PL,PT,ES,SE,GB" , currency = "EUR,GBP,SEK"} ali_pay = {currency = "EUR,USD"} we_chat_pay = { currency = "EUR"} +eps = { country = "AT" , currency = "EUR" } +mb_way = { country = "PT" , currency = "EUR" } +sofort = { country = "AT,BE,FR,DE,IT,PL,ES,CH,GB" , currency = "EUR"} [pm_filters.cashtocode] classic = { country = "AF,AX,AL,DZ,AS,AD,AO,AI,AQ,AG,AR,AM,AW,AU,AT,AZ,BS,BH,BD,BB,BY,BE,BZ,BJ,BM,BT,BO,BQ,BA,BW,BV,BR,IO,BN,BG,BF,BI,KH,CM,CA,CV,KY,CF,TD,CL,CN,CX,CC,CO,KM,CG,CD,CK,CR,CI,HR,CU,CW,CY,CZ,DK,DJ,DM,DO,EC,EG,SV,GQ,ER,EE,ET,FK,FO,FJ,FI,FR,GF,PF,TF,GA,GM,GE,DE,GH,GI,GR,GL,GD,GP,GU,GT,GG,GN,GW,GY,HT,HM,VA,HN,HK,HU,IS,IN,ID,IR,IQ,IE,IM,IL,IT,JM,JP,JE,JO,KZ,KE,KI,KP,KR,KW,KG,LA,LV,LB,LS,LR,LY,LI,LT,LU,MO,MK,MG,MW,MY,MV,ML,MT,MH,MQ,MR,MU,YT,MX,FM,MD,MC,MN,ME,MS,MA,MZ,MM,NA,NR,NP,NL,NC,NZ,NI,NE,NG,NU,NF,MP,NO,OM,PK,PW,PS,PA,PG,PY,PE,PH,PN,PL,PT,PR,QA,RE,RO,RU,RW,BL,SH,KN,LC,MF,PM,VC,WS,SM,ST,SA,SN,RS,SC,SL,SG,SX,SK,SI,SB,SO,ZA,GS,SS,ES,LK,SD,SR,SJ,SZ,SE,CH,SY,TW,TJ,TZ,TH,TL,TG,TK,TO,TT,TN,TR,TM,TC,TV,UG,UA,AE,GB,UM,UY,UZ,VU,VE,VN,VG,VI,WF,EH,YE,ZM,ZW,US", currency = "AED,AFN,ALL,AMD,ANG,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BHD,BIF,BMD,BND,BOB,BRL,BSD,BTN,BWP,BYN,BZD,CAD,CDF,CHF,CLF,CLP,CNY,COP,CRC,CUC,CUP,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ERN,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,IQD,IRR,ISK,JMD,JOD,JPY,KES,KGS,KHR,KMF,KPW,KRW,KWD,KYD,KZT,LAK,LBP,LKR,LRD,LSL,LYD,MAD,MDL,MGA,MKD,MMK,MNT,MOP,MRU,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SDG,SEK,SGD,SHP,SLE,SLL,SOS,SRD,SSP,STD,STN,SVC,SYP,SZL,THB,TJS,TMT,TND,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VES,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL" } diff --git a/config/deployments/production.toml b/config/deployments/production.toml index 4e68cadd284..a6b1d1c3f64 100644 --- a/config/deployments/production.toml +++ b/config/deployments/production.toml @@ -229,12 +229,12 @@ wallet.twint.connector_list = "adyen" wallet.vipps.connector_list = "adyen" bank_redirect.ideal.connector_list = "stripe,adyen,globalpay,multisafepay,nexinets,aci" -bank_redirect.sofort.connector_list = "globalpay,aci" +bank_redirect.sofort.connector_list = "globalpay,aci,multisafepay" bank_redirect.giropay.connector_list = "globalpay,multisafepay,nexinets,aci" bank_redirect.bancontact_card.connector_list="adyen,stripe" bank_redirect.trustly.connector_list="adyen,aci" bank_redirect.open_banking_uk.connector_list="adyen" -bank_redirect.eps.connector_list="globalpay,nexinets,aci" +bank_redirect.eps.connector_list="globalpay,nexinets,aci,multisafepay" [mandates.update_mandate_supported] card.credit = { connector_list = "cybersource" } # Update Mandate supported payment method type and connector for card @@ -531,6 +531,9 @@ klarna = { country = "AT,BE,DK,FI,FR,DE,IT,NL,NO,PT,ES,SE,GB", currency = "DKK,E trustly = { country = "AT,CZ,DK,EE,FI,DE,LV,LT,NL,NO,PL,PT,ES,SE,GB" , currency = "EUR,GBP,SEK"} ali_pay = {currency = "EUR,USD"} we_chat_pay = { currency = "EUR"} +eps = { country = "AT" , currency = "EUR" } +mb_way = { country = "PT" , currency = "EUR" } +sofort = { country = "AT,BE,FR,DE,IT,PL,ES,CH,GB" , currency = "EUR"} [pm_filters.cashtocode] classic = { country = "AF,AX,AL,DZ,AS,AD,AO,AI,AQ,AG,AR,AM,AW,AU,AT,AZ,BS,BH,BD,BB,BY,BE,BZ,BJ,BM,BT,BO,BQ,BA,BW,BV,BR,IO,BN,BG,BF,BI,KH,CM,CA,CV,KY,CF,TD,CL,CN,CX,CC,CO,KM,CG,CD,CK,CR,CI,HR,CU,CW,CY,CZ,DK,DJ,DM,DO,EC,EG,SV,GQ,ER,EE,ET,FK,FO,FJ,FI,FR,GF,PF,TF,GA,GM,GE,DE,GH,GI,GR,GL,GD,GP,GU,GT,GG,GN,GW,GY,HT,HM,VA,HN,HK,HU,IS,IN,ID,IR,IQ,IE,IM,IL,IT,JM,JP,JE,JO,KZ,KE,KI,KP,KR,KW,KG,LA,LV,LB,LS,LR,LY,LI,LT,LU,MO,MK,MG,MW,MY,MV,ML,MT,MH,MQ,MR,MU,YT,MX,FM,MD,MC,MN,ME,MS,MA,MZ,MM,NA,NR,NP,NL,NC,NZ,NI,NE,NG,NU,NF,MP,NO,OM,PK,PW,PS,PA,PG,PY,PE,PH,PN,PL,PT,PR,QA,RE,RO,RU,RW,BL,SH,KN,LC,MF,PM,VC,WS,SM,ST,SA,SN,RS,SC,SL,SG,SX,SK,SI,SB,SO,ZA,GS,SS,ES,LK,SD,SR,SJ,SZ,SE,CH,SY,TW,TJ,TZ,TH,TL,TG,TK,TO,TT,TN,TR,TM,TC,TV,UG,UA,AE,GB,UM,UY,UZ,VU,VE,VN,VG,VI,WF,EH,YE,ZM,ZW,US", currency = "AED,AFN,ALL,AMD,ANG,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BHD,BIF,BMD,BND,BOB,BRL,BSD,BTN,BWP,BYN,BZD,CAD,CDF,CHF,CLF,CLP,CNY,COP,CRC,CUC,CUP,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ERN,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,IQD,IRR,ISK,JMD,JOD,JPY,KES,KGS,KHR,KMF,KPW,KRW,KWD,KYD,KZT,LAK,LBP,LKR,LRD,LSL,LYD,MAD,MDL,MGA,MKD,MMK,MNT,MOP,MRU,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SDG,SEK,SGD,SHP,SLE,SLL,SOS,SRD,SSP,STD,STN,SVC,SYP,SZL,THB,TJS,TMT,TND,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VES,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL" } diff --git a/config/deployments/sandbox.toml b/config/deployments/sandbox.toml index 699f24e76ca..528f855647b 100644 --- a/config/deployments/sandbox.toml +++ b/config/deployments/sandbox.toml @@ -236,12 +236,12 @@ wallet.twint.connector_list = "adyen" wallet.vipps.connector_list = "adyen" bank_redirect.ideal.connector_list = "stripe,adyen,globalpay,multisafepay,nexinets,aci" -bank_redirect.sofort.connector_list = "globalpay,aci" +bank_redirect.sofort.connector_list = "globalpay,aci,multisafepay" bank_redirect.giropay.connector_list = "globalpay,multisafepay,nexinets,aci" bank_redirect.bancontact_card.connector_list="adyen,stripe" bank_redirect.trustly.connector_list="adyen,aci" bank_redirect.open_banking_uk.connector_list="adyen" -bank_redirect.eps.connector_list="globalpay,nexinets,aci" +bank_redirect.eps.connector_list="globalpay,nexinets,aci,multisafepay" [mandates.update_mandate_supported] card.credit = { connector_list = "cybersource" } # Update Mandate supported payment method type and connector for card @@ -539,6 +539,9 @@ klarna = { country = "AT,BE,DK,FI,FR,DE,IT,NL,NO,PT,ES,SE,GB", currency = "DKK,E trustly = { country = "AT,CZ,DK,EE,FI,DE,LV,LT,NL,NO,PL,PT,ES,SE,GB" , currency = "EUR,GBP,SEK"} ali_pay = {currency = "EUR,USD"} we_chat_pay = { currency = "EUR"} +eps = { country = "AT" , currency = "EUR" } +mb_way = { country = "PT" , currency = "EUR" } +sofort = { country = "AT,BE,FR,DE,IT,PL,ES,CH,GB" , currency = "EUR"} [pm_filters.cashtocode] classic = { country = "AF,AX,AL,DZ,AS,AD,AO,AI,AQ,AG,AR,AM,AW,AU,AT,AZ,BS,BH,BD,BB,BY,BE,BZ,BJ,BM,BT,BO,BQ,BA,BW,BV,BR,IO,BN,BG,BF,BI,KH,CM,CA,CV,KY,CF,TD,CL,CN,CX,CC,CO,KM,CG,CD,CK,CR,CI,HR,CU,CW,CY,CZ,DK,DJ,DM,DO,EC,EG,SV,GQ,ER,EE,ET,FK,FO,FJ,FI,FR,GF,PF,TF,GA,GM,GE,DE,GH,GI,GR,GL,GD,GP,GU,GT,GG,GN,GW,GY,HT,HM,VA,HN,HK,HU,IS,IN,ID,IR,IQ,IE,IM,IL,IT,JM,JP,JE,JO,KZ,KE,KI,KP,KR,KW,KG,LA,LV,LB,LS,LR,LY,LI,LT,LU,MO,MK,MG,MW,MY,MV,ML,MT,MH,MQ,MR,MU,YT,MX,FM,MD,MC,MN,ME,MS,MA,MZ,MM,NA,NR,NP,NL,NC,NZ,NI,NE,NG,NU,NF,MP,NO,OM,PK,PW,PS,PA,PG,PY,PE,PH,PN,PL,PT,PR,QA,RE,RO,RU,RW,BL,SH,KN,LC,MF,PM,VC,WS,SM,ST,SA,SN,RS,SC,SL,SG,SX,SK,SI,SB,SO,ZA,GS,SS,ES,LK,SD,SR,SJ,SZ,SE,CH,SY,TW,TJ,TZ,TH,TL,TG,TK,TO,TT,TN,TR,TM,TC,TV,UG,UA,AE,GB,UM,UY,UZ,VU,VE,VN,VG,VI,WF,EH,YE,ZM,ZW,US", currency = "AED,AFN,ALL,AMD,ANG,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BHD,BIF,BMD,BND,BOB,BRL,BSD,BTN,BWP,BYN,BZD,CAD,CDF,CHF,CLF,CLP,CNY,COP,CRC,CUC,CUP,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ERN,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,IQD,IRR,ISK,JMD,JOD,JPY,KES,KGS,KHR,KMF,KPW,KRW,KWD,KYD,KZT,LAK,LBP,LKR,LRD,LSL,LYD,MAD,MDL,MGA,MKD,MMK,MNT,MOP,MRU,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SDG,SEK,SGD,SHP,SLE,SLL,SOS,SRD,SSP,STD,STN,SVC,SYP,SZL,THB,TJS,TMT,TND,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VES,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL" } diff --git a/config/development.toml b/config/development.toml index b4cb8fa259b..d2088f04a7a 100644 --- a/config/development.toml +++ b/config/development.toml @@ -738,6 +738,9 @@ klarna = { country = "AT,BE,DK,FI,FR,DE,IT,NL,NO,PT,ES,SE,GB", currency = "DKK,E trustly = { country = "AT,CZ,DK,EE,FI,DE,LV,LT,NL,NO,PL,PT,ES,SE,GB" , currency = "EUR,GBP,SEK"} ali_pay = { currency = "EUR,USD" } we_chat_pay = { currency = "EUR"} +eps = { country = "AT" , currency = "EUR" } +mb_way = { country = "PT" , currency = "EUR" } +sofort = { country = "AT,BE,FR,DE,IT,PL,ES,CH,GB" , currency = "EUR"} [pm_filters.cashtocode] classic = { country = "AF,AX,AL,DZ,AS,AD,AO,AI,AQ,AG,AR,AM,AW,AU,AT,AZ,BS,BH,BD,BB,BY,BE,BZ,BJ,BM,BT,BO,BQ,BA,BW,BV,BR,IO,BN,BG,BF,BI,KH,CM,CA,CV,KY,CF,TD,CL,CN,CX,CC,CO,KM,CG,CD,CK,CR,CI,HR,CU,CW,CY,CZ,DK,DJ,DM,DO,EC,EG,SV,GQ,ER,EE,ET,FK,FO,FJ,FI,FR,GF,PF,TF,GA,GM,GE,DE,GH,GI,GR,GL,GD,GP,GU,GT,GG,GN,GW,GY,HT,HM,VA,HN,HK,HU,IS,IN,ID,IR,IQ,IE,IM,IL,IT,JM,JP,JE,JO,KZ,KE,KI,KP,KR,KW,KG,LA,LV,LB,LS,LR,LY,LI,LT,LU,MO,MK,MG,MW,MY,MV,ML,MT,MH,MQ,MR,MU,YT,MX,FM,MD,MC,MN,ME,MS,MA,MZ,MM,NA,NR,NP,NL,NC,NZ,NI,NE,NG,NU,NF,MP,NO,OM,PK,PW,PS,PA,PG,PY,PE,PH,PN,PL,PT,PR,QA,RE,RO,RU,RW,BL,SH,KN,LC,MF,PM,VC,WS,SM,ST,SA,SN,RS,SC,SL,SG,SX,SK,SI,SB,SO,ZA,GS,SS,ES,LK,SD,SR,SJ,SZ,SE,CH,SY,TW,TJ,TZ,TH,TL,TG,TK,TO,TT,TN,TR,TM,TC,TV,UG,UA,AE,GB,UM,UY,UZ,VU,VE,VN,VG,VI,WF,EH,YE,ZM,ZW,US", currency = "AED,AFN,ALL,AMD,ANG,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BHD,BIF,BMD,BND,BOB,BRL,BSD,BTN,BWP,BYN,BZD,CAD,CDF,CHF,CLF,CLP,CNY,COP,CRC,CUC,CUP,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ERN,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,IQD,IRR,ISK,JMD,JOD,JPY,KES,KGS,KHR,KMF,KPW,KRW,KWD,KYD,KZT,LAK,LBP,LKR,LRD,LSL,LYD,MAD,MDL,MGA,MKD,MMK,MNT,MOP,MRU,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SDG,SEK,SGD,SHP,SLE,SLL,SOS,SRD,SSP,STD,STN,SVC,SYP,SZL,THB,TJS,TMT,TND,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VES,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL" } @@ -970,12 +973,12 @@ wallet.twint.connector_list = "adyen" wallet.vipps.connector_list = "adyen" bank_redirect.ideal.connector_list = "stripe,adyen,globalpay,multisafepay,nexinets,aci" -bank_redirect.sofort.connector_list = "stripe,globalpay,aci" +bank_redirect.sofort.connector_list = "stripe,globalpay,aci,multisafepay" bank_redirect.giropay.connector_list = "globalpay,multisafepay,nexinets,aci" bank_redirect.bancontact_card.connector_list = "adyen,stripe" bank_redirect.trustly.connector_list = "adyen,aci" bank_redirect.open_banking_uk.connector_list = "adyen" -bank_redirect.eps.connector_list = "globalpay,nexinets,aci" +bank_redirect.eps.connector_list = "globalpay,nexinets,aci,multisafepay" [mandates.update_mandate_supported] card.credit = { connector_list = "cybersource" } diff --git a/crates/hyperswitch_connectors/src/connectors/multisafepay.rs b/crates/hyperswitch_connectors/src/connectors/multisafepay.rs index 08e76940237..0213f59cfd7 100644 --- a/crates/hyperswitch_connectors/src/connectors/multisafepay.rs +++ b/crates/hyperswitch_connectors/src/connectors/multisafepay.rs @@ -698,6 +698,38 @@ static MULTISAFEPAY_SUPPORTED_PAYMENT_METHODS: LazyLock<SupportedPaymentMethods> }, ); + multisafepay_supported_payment_methods.add( + enums::PaymentMethod::BankRedirect, + enums::PaymentMethodType::Eps, + PaymentMethodDetails { + mandates: enums::FeatureStatus::NotSupported, + refunds: enums::FeatureStatus::Supported, + supported_capture_methods: supported_capture_methods.clone(), + specific_features: None, + }, + ); + + multisafepay_supported_payment_methods.add( + enums::PaymentMethod::BankRedirect, + enums::PaymentMethodType::Sofort, + PaymentMethodDetails { + mandates: enums::FeatureStatus::NotSupported, + refunds: enums::FeatureStatus::Supported, + supported_capture_methods: supported_capture_methods.clone(), + specific_features: None, + }, + ); + + multisafepay_supported_payment_methods.add( + enums::PaymentMethod::Wallet, + enums::PaymentMethodType::MbWay, + PaymentMethodDetails { + mandates: enums::FeatureStatus::NotSupported, + refunds: enums::FeatureStatus::Supported, + supported_capture_methods: supported_capture_methods.clone(), + specific_features: None, + }, + ); multisafepay_supported_payment_methods }); diff --git a/crates/hyperswitch_connectors/src/connectors/multisafepay/transformers.rs b/crates/hyperswitch_connectors/src/connectors/multisafepay/transformers.rs index bcdbd7e28e6..212c4d11eee 100644 --- a/crates/hyperswitch_connectors/src/connectors/multisafepay/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/multisafepay/transformers.rs @@ -70,6 +70,10 @@ pub enum Gateway { Alipay, #[serde(rename = "WECHAT")] WeChatPay, + Eps, + MbWay, + #[serde(rename = "DIRECTBANK")] + Sofort, } #[serde_with::skip_serializing_none] @@ -189,11 +193,14 @@ pub enum WalletInfo { GooglePay(GpayInfo), Alipay(AlipayInfo), WeChatPay(WeChatPayInfo), + MbWay(MbWayInfo), } #[derive(Debug, Clone, Serialize, Eq, PartialEq)] -pub struct WeChatPayInfo {} +pub struct MbWayInfo {} +#[derive(Debug, Clone, Serialize, Eq, PartialEq)] +pub struct WeChatPayInfo {} #[derive(Debug, Clone, Serialize, Eq, PartialEq)] pub struct AlipayInfo {} @@ -202,7 +209,15 @@ pub struct AlipayInfo {} pub enum BankRedirectInfo { Ideal(IdealInfo), Trustly(TrustlyInfo), + Eps(EpsInfo), + Sofort(SofortInfo), } + +#[derive(Debug, Clone, Serialize, Eq, PartialEq)] +pub struct SofortInfo {} + +#[derive(Debug, Clone, Serialize, Eq, PartialEq)] +pub struct EpsInfo {} #[derive(Debug, Clone, Serialize, Eq, PartialEq)] pub struct TrustlyInfo {} #[derive(Debug, Clone, Serialize, Eq, PartialEq)] @@ -506,6 +521,7 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> WalletData::PaypalRedirect(_) => Type::Redirect, WalletData::AliPayRedirect(_) => Type::Redirect, WalletData::WeChatPayRedirect(_) => Type::Redirect, + WalletData::MbWayRedirect(_) => Type::Redirect, WalletData::AliPayQr(_) \| WalletData::AliPayHkRedirect(_) \| WalletData::AmazonPayRedirect(_) @@ -519,7 +535,6 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> \| WalletData::DanaRedirect {} \| WalletData::GooglePayRedirect(_) \| WalletData::GooglePayThirdPartySdk(_) - \| WalletData::MbWayRedirect(_) \| WalletData::MobilePayRedirect(_) \| WalletData::PaypalSdk(_) \| WalletData::Paze(_) @@ -539,11 +554,12 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> BankRedirectData::Giropay { .. } => Type::Redirect, BankRedirectData::Ideal { .. } => Type::Direct, BankRedirectData::Trustly { .. } => Type::Redirect, + BankRedirectData::Eps { .. } => Type::Redirect, + BankRedirectData::Sofort { .. } => Type::Redirect, BankRedirectData::BancontactCard { .. } \| BankRedirectData::Bizum { .. } \| BankRedirectData::Blik { .. } \| BankRedirectData::Eft { .. } - \| BankRedirectData::Eps { .. } \| BankRedirectData::Interac { .. } \| BankRedirectData::OnlineBankingCzechRepublic { .. } \| BankRedirectData::OnlineBankingFinland { .. } @@ -551,7 +567,6 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> \| BankRedirectData::OnlineBankingSlovakia { .. } \| BankRedirectData::OpenBankingUk { .. } \| BankRedirectData::Przelewy24 { .. } - \| BankRedirectData::Sofort { .. } \| BankRedirectData::OnlineBankingFpx { .. } \| BankRedirectData::OnlineBankingThailand { .. } \| BankRedirectData::LocalBankRedirect {} => { @@ -573,6 +588,7 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> WalletData::PaypalRedirect(_) => Gateway::Paypal, WalletData::AliPayRedirect(_) => Gateway::Alipay, WalletData::WeChatPayRedirect(_) => Gateway::WeChatPay, + WalletData::MbWayRedirect(_) => Gateway::MbWay, WalletData::AliPayQr(_) \| WalletData::AliPayHkRedirect(_) \| WalletData::AmazonPayRedirect(_) @@ -586,7 +602,6 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> \| WalletData::DanaRedirect {} \| WalletData::GooglePayRedirect(_) \| WalletData::GooglePayThirdPartySdk(_) - \| WalletData::MbWayRedirect(_) \| WalletData::MobilePayRedirect(_) \| WalletData::PaypalSdk(_) \| WalletData::Paze(_) @@ -606,11 +621,12 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> BankRedirectData::Giropay { .. } => Gateway::Giropay, BankRedirectData::Ideal { .. } => Gateway::Ideal, BankRedirectData::Trustly { .. } => Gateway::Trustly, + BankRedirectData::Eps { .. } => Gateway::Eps, + BankRedirectData::Sofort { .. } => Gateway::Sofort, BankRedirectData::BancontactCard { .. } \| BankRedirectData::Bizum { .. } \| BankRedirectData::Blik { .. } \| BankRedirectData::Eft { .. } - \| BankRedirectData::Eps { .. } \| BankRedirectData::Interac { .. } \| BankRedirectData::OnlineBankingCzechRepublic { .. } \| BankRedirectData::OnlineBankingFinland { .. } @@ -618,7 +634,6 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> \| BankRedirectData::OnlineBankingSlovakia { .. } \| BankRedirectData::OpenBankingUk { .. } \| BankRedirectData::Przelewy24 { .. } - \| BankRedirectData::Sofort { .. } \| BankRedirectData::OnlineBankingFpx { .. } \| BankRedirectData::OnlineBankingThailand { .. } \| BankRedirectData::LocalBankRedirect {} => { @@ -739,6 +754,9 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> WalletData::WeChatPayRedirect(_) => { Some(GatewayInfo::Wallet(WalletInfo::WeChatPay(WeChatPayInfo {}))) } + WalletData::MbWayRedirect(_) => { + Some(GatewayInfo::Wallet(WalletInfo::MbWay(MbWayInfo {}))) + } WalletData::AliPayQr(_) \| WalletData::AliPayHkRedirect(_) \| WalletData::AmazonPayRedirect(_) @@ -752,7 +770,6 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> \| WalletData::DanaRedirect {} \| WalletData::GooglePayRedirect(_) \| WalletData::GooglePayThirdPartySdk(_) - \| WalletData::MbWayRedirect(_) \| WalletData::MobilePayRedirect(_) \| WalletData::PaypalSdk(_) \| WalletData::Paze(_) @@ -801,11 +818,16 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> BankRedirectData::Trustly { .. } => Some(GatewayInfo::BankRedirect( BankRedirectInfo::Trustly(TrustlyInfo {}), )), + BankRedirectData::Eps { .. } => { + Some(GatewayInfo::BankRedirect(BankRedirectInfo::Eps(EpsInfo {}))) + } + BankRedirectData::Sofort { .. } => Some(GatewayInfo::BankRedirect( + BankRedirectInfo::Sofort(SofortInfo {}), + )), BankRedirectData::BancontactCard { .. } \| BankRedirectData::Bizum { .. } \| BankRedirectData::Blik { .. } \| BankRedirectData::Eft { .. } - \| BankRedirectData::Eps { .. } \| BankRedirectData::Giropay { .. } \| BankRedirectData::Interac { .. } \| BankRedirectData::OnlineBankingCzechRepublic { .. } @@ -814,7 +836,6 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> \| BankRedirectData::OnlineBankingSlovakia { .. } \| BankRedirectData::OpenBankingUk { .. } \| BankRedirectData::Przelewy24 { .. } - \| BankRedirectData::Sofort { .. } \| BankRedirectData::OnlineBankingFpx { .. } \| BankRedirectData::OnlineBankingThailand { .. } \| BankRedirectData::LocalBankRedirect {} => None,	2025-07-01T05:58:27Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> ADD new pm for multisafepay - EPS - SOFORT - MBWAY ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> <details> <summary>MCA</summary> ```json { "connector_type": "payment_processor", "connector_account_details": { "auth_type": "HeaderKey", "api_key": "****" }, "connector_name": "multisafepay", "test_mode": false, "disabled": false, "payment_methods_enabled": [ { "payment_method": "wallet", "payment_method_types": [ { "payment_method_type": "paypal", "payment_experience": "redirect_to_url" } ] }, { "payment_method": "wallet", "payment_method_types": [ { "payment_method_type": "we_chat_pay", "payment_experience": "redirect_to_url" } ] }, { "payment_method": "wallet", "payment_method_types": [ { "payment_method_type": "ali_pay", "payment_experience": "redirect_to_url" } ] }, { "payment_method": "wallet", "payment_method_types": [ { "payment_method_type": "amazon_pay", "payment_experience": "redirect_to_url" } ] }, { "payment_method": "bank_redirect", "payment_method_types": [ { "payment_method_type": "trustly" } ] }, { "payment_method": "bank_redirect", "payment_method_types": [ { "payment_method_type": "eps", "payment_experience": "redirect_to_url" } ] }, { "payment_method": "bank_redirect", "payment_method_types": [ { "payment_method_type": "mb_way", "payment_experience": "redirect_to_url" } ] }, { "payment_method": "bank_redirect", "payment_method_types": [ { "payment_method_type": "sofort", "payment_experience": "redirect_to_url" } ] }, { "payment_method": "card", "payment_method_types": [ { "payment_method_type": "credit", "card_networks": [ "Visa", "Mastercard" ], "minimum_amount": 1, "maximum_amount": 68607706, "recurring_enabled": true, "installment_payment_enabled": true }, { "payment_method_type": "debit", "card_networks": [ "Visa", "Mastercard" ], "minimum_amount": 1, "maximum_amount": 68607706, "recurring_enabled": true, "installment_payment_enabled": true } ] } ], "metadata": { "city": "NY", "unit": "245" }, "business_country": "US", "business_label": "default" } ``` </details> ## SOFORT <details> <summary>Payment Request</summary> ```json { "amount": 333, "currency": "EUR", "confirm": true, "capture_method": "automatic", "payment_method": "bank_redirect", "payment_method_type": "sofort", "authentication_type": "no_three_ds", "description": "hellow world", "billing": { "address": { "zip": "560095", "first_name": "Sakil", "last_name": "Mostak", "line1": "Fasdf", "country": "CN", "line2": "Fasdf", "city": "Fasdf" } }, "payment_method_data": { "bank_redirect": { "sofort": {} } } } ``` </details> <details> <summary>Confirm page</summary> <img width="1356" alt="Screenshot 2025-07-01 at 11 20 05 AM" src="https://github.com/user-attachments/assets/13699a4f-db05-4e44-ab48-f19948c2645f" /> </details> <details> <summary>Psync Response</summary> ```json { "payment_id": "pay_2VuZLa8gqY25CfYd0j9g", "merchant_id": "merchant_1751348844", "status": "succeeded", "amount": 333, "net_amount": 333, "shipping_cost": null, "amount_capturable": 0, "amount_received": 333, "connector": "multisafepay", "client_secret": "pay_2VuZLa8gqY25CfYd0j9g_secret_uJ6cIqUaMlLLZjxdduEB", "created": "2025-07-01T05:49:46.290Z", "currency": "EUR", "customer_id": null, "customer": null, "description": "hellow world", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "bank_redirect", "payment_method_data": { "bank_redirect": { "type": "BankRedirectResponse", "bank_name": null }, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": "Fasdf", "country": "CN", "line1": "Fasdf", "line2": "Fasdf", "line3": null, "zip": "560095", "state": null, "first_name": "Sakil", "last_name": "Mostak" }, "phone": null, "email": null }, "order_details": null, "email": null, "name": null, "phone": null, "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "sofort", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": false, "connector_transaction_id": "pay_2VuZLa8gqY25CfYd0j9g_1", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_2VuZLa8gqY25CfYd0j9g_1", "payment_link": null, "profile_id": "pro_3OEvbwtJss77rpYRZpK9", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_lpvLYRnYLwlFl8HyiR3C", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-07-01T06:04:46.290Z", "fingerprint": null, "browser_info": null, "payment_method_id": null, "payment_method_status": null, "updated": "2025-07-01T05:50:08.187Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": null, "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` </details> ## EPS <details> <summary>Payment request</summary> ```json { "amount": 333, "currency": "EUR", "confirm": true, "capture_method": "automatic", "payment_method": "bank_redirect", "payment_method_type": "eps", "authentication_type": "no_three_ds", "description": "hellow world", "billing": { "address": { "zip": "560095", "first_name": "Sakil", "last_name": "Mostak", "line1": "Fasdf", "country": "AT", "line2": "Fasdf", "city": "Fasdf" } }, "payment_method_data": { "bank_redirect": { "eps": {} } } } ``` </details> <details> <summary>Payment page</summary> ``` NOTE there is a bug in confirm page by multisafe page where it shows gyropay instead eps. But after success the payment is regestered under eps only in the merchant page ``` <img width="1324" alt="Screenshot 2025-07-01 at 11 34 03 AM" src="https://github.com/user-attachments/assets/b768ba16-a351-40aa-bfa3-5ae8356593d0" /> </details> <details> <summary>Psync response</summary> ```json { "payment_id": "pay_5wcVD9r07H9USnvnkmj8", "merchant_id": "merchant_1751348844", "status": "succeeded", "amount": 333, "net_amount": 333, "shipping_cost": null, "amount_capturable": 0, "amount_received": 333, "connector": "multisafepay", "client_secret": "pay_5wcVD9r07H9USnvnkmj8_secret_gszuW3VnyepDNGQycnkG", "created": "2025-07-01T06:03:45.907Z", "currency": "EUR", "customer_id": null, "customer": null, "description": "hellow world", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "bank_redirect", "payment_method_data": { "bank_redirect": { "type": "BankRedirectResponse", "bank_name": null }, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": "Fasdf", "country": "AT", "line1": "Fasdf", "line2": "Fasdf", "line3": null, "zip": "560095", "state": null, "first_name": "Sakil", "last_name": "Mostak" }, "phone": null, "email": null }, "order_details": null, "email": null, "name": null, "phone": null, "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "eps", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": false, "connector_transaction_id": "pay_5wcVD9r07H9USnvnkmj8_1", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_5wcVD9r07H9USnvnkmj8_1", "payment_link": null, "profile_id": "pro_3OEvbwtJss77rpYRZpK9", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_lpvLYRnYLwlFl8HyiR3C", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-07-01T06:18:45.907Z", "fingerprint": null, "browser_info": null, "payment_method_id": null, "payment_method_status": null, "updated": "2025-07-01T06:04:06.199Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": null, "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` </details> ## MB WAY <details> <summary>Payment</summary> ```json { "amount": 333, "currency": "EUR", "confirm": true, "capture_method": "automatic", "payment_method": "wallet", "payment_method_type": "mb_way", "authentication_type": "no_three_ds", "description": "hellow world", "billing": { "address": { "zip": "560095", "first_name": "Sakil", "last_name": "Mostak", "line1": "Fasdf", "country": "PT", "line2": "Fasdf", "city": "Fasdf" } }, "payment_method_data": { "wallet": { "mb_way_redirect": {} } } } ``` </details> <details> <summary>Payment Response </summary> ```json { "payment_id": "pay_5FG8mrPdW4jnQERhOSSW", "merchant_id": "merchant_1751348844", "status": "requires_customer_action", "amount": 333, "net_amount": 333, "shipping_cost": null, "amount_capturable": 333, "amount_received": null, "connector": "multisafepay", "client_secret": "pay_5FG8mrPdW4jnQERhOSSW_secret_OZ8fONDt6UUY4YyCHZRh", "created": "2025-07-01T06:10:53.544Z", "currency": "EUR", "customer_id": null, "customer": null, "description": "hellow world", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "wallet", "payment_method_data": { "wallet": {}, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": "Fasdf", "country": "PT", "line1": "Fasdf", "line2": "Fasdf", "line3": null, "zip": "560095", "state": null, "first_name": "Sakil", "last_name": "Mostak" }, "phone": null, "email": null }, "order_details": null, "email": null, "name": null, "phone": null, "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": { "type": "redirect_to_url", "redirect_to_url": "http://localhost:8080/payments/redirect/pay_5FG8mrPdW4jnQERhOSSW/merchant_1751348844/pay_5FG8mrPdW4jnQERhOSSW_1" }, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "mb_way", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": null, "connector_transaction_id": "pay_5FG8mrPdW4jnQERhOSSW_1", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_5FG8mrPdW4jnQERhOSSW_1", "payment_link": null, "profile_id": "pro_3OEvbwtJss77rpYRZpK9", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_NafK7LHPOhPMyNsUBOfH", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-07-01T06:25:53.544Z", "fingerprint": null, "browser_info": null, "payment_method_id": null, "payment_method_status": null, "updated": "2025-07-01T06:10:55.158Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": null, "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` </details> <details> <summary>Confirm page</summary> <img width="1356" alt="Screenshot 2025-07-01 at 11 20 05 AM" src="https://github.com/user-attachments/assets/96558e15-dc30-4b36-a1a1-2b3de10f3262" /> <img width="1324" alt="Screenshot 2025-07-01 at 11 34 03 AM" src="https://github.com/user-attachments/assets/60ce6a5f-4c57-42aa-9175-69a47c1ec20e" /> SOME PROBLEM WITH CONFIRMATION </details> <details> <summary>Psync</summary> ``` UNABLE TO VERIFY due to issue from multisafepay . Needs alpha testing ``` </details> ### cypress test - UNABLE TO TEST REDIRECTION VIA CYPRESS DUE TO CSRF BLOCKING <img width="696" alt="Screenshot 2025-07-09 at 4 18 29 PM" src="https://github.com/user-attachments/assets/d875b5a0-6ef7-4475-a615-5cacf6c4e8bc" /> ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [x] I added unit tests for my changes where possible	v1.115.0	7f5ec7439b3469df7d77b8151ae3f4218847641a	7f5ec7439b3469df7d77b8151ae3f4218847641a
juspay/hyperswitch	juspay__hyperswitch-8554	Bug: [FEATURE] [CONNECTOR] Silverflow ### Feature Description Integrate a new connector Silverflow in alpha integration ref: https://www.silverflow.com/ ### Possible Implementation Integrate a new connector Silverflow in alpha integration ref: https://www.silverflow.com/ ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? None	diff --git a/config/config.example.toml b/config/config.example.toml index 0bb5cb13007..10f796128f7 100644 --- a/config/config.example.toml +++ b/config/config.example.toml @@ -280,6 +280,7 @@ redsys.base_url = "https://sis-t.redsys.es:25443" riskified.base_url = "https://sandbox.riskified.com/api" santander.base_url = "https://pix.santander.com.br/api/v1/sandbox/" shift4.base_url = "https://api.shift4.com/" +silverflow.base_url = "https://api-sbx.silverflow.co/v1" signifyd.base_url = "https://api.signifyd.com/" square.base_url = "https://connect.squareupsandbox.com/" square.secondary_base_url = "https://pci-connect.squareupsandbox.com/" diff --git a/config/deployments/integration_test.toml b/config/deployments/integration_test.toml index c92570aaeef..803047dca2e 100644 --- a/config/deployments/integration_test.toml +++ b/config/deployments/integration_test.toml @@ -116,6 +116,7 @@ recurly.base_url = "https://v3.recurly.com" redsys.base_url = "https://sis-t.redsys.es:25443" santander.base_url = "https://pix.santander.com.br/api/v1/sandbox/" shift4.base_url = "https://api.shift4.com/" +silverflow.base_url = "https://api-sbx.silverflow.co/v1" signifyd.base_url = "https://api.signifyd.com/" riskified.base_url = "https://sandbox.riskified.com/api" square.base_url = "https://connect.squareupsandbox.com/" diff --git a/config/deployments/production.toml b/config/deployments/production.toml index 8e7fd10702c..94d8f18d44d 100644 --- a/config/deployments/production.toml +++ b/config/deployments/production.toml @@ -121,6 +121,7 @@ redsys.base_url = "https://sis.redsys.es" riskified.base_url = "https://wh.riskified.com/api/" santander.base_url = "https://trust-pix.santander.com.br/" shift4.base_url = "https://api.shift4.com/" +silverflow.base_url = "https://api.silverflow.co/v1" signifyd.base_url = "https://api.signifyd.com/" square.base_url = "https://connect.squareup.com/" square.secondary_base_url = "https://pci-connect.squareup.com/" diff --git a/config/deployments/sandbox.toml b/config/deployments/sandbox.toml index 2011b50b756..99daaab178d 100644 --- a/config/deployments/sandbox.toml +++ b/config/deployments/sandbox.toml @@ -121,6 +121,7 @@ redsys.base_url = "https://sis-t.redsys.es:25443" riskified.base_url = "https://sandbox.riskified.com/api" santander.base_url = "https://pix.santander.com.br/api/v1/sandbox/" shift4.base_url = "https://api.shift4.com/" +silverflow.base_url = "https://api-sbx.silverflow.co/v1" signifyd.base_url = "https://api.signifyd.com/" square.base_url = "https://connect.squareupsandbox.com/" square.secondary_base_url = "https://pci-connect.squareupsandbox.com/" diff --git a/config/development.toml b/config/development.toml index 49e5bb8a52e..b72f7bcbaee 100644 --- a/config/development.toml +++ b/config/development.toml @@ -171,6 +171,7 @@ cards = [ "redsys", "santander", "shift4", + "silverflow", "square", "stax", "stripe", @@ -317,6 +318,7 @@ redsys.base_url = "https://sis-t.redsys.es:25443" riskified.base_url = "https://sandbox.riskified.com/api" santander.base_url = "https://pix.santander.com.br/api/v1/sandbox/" shift4.base_url = "https://api.shift4.com/" +silverflow.base_url = "https://api-sbx.silverflow.co/v1" signifyd.base_url = "https://api.signifyd.com/" square.base_url = "https://connect.squareupsandbox.com/" square.secondary_base_url = "https://pci-connect.squareupsandbox.com/" diff --git a/config/docker_compose.toml b/config/docker_compose.toml index 329c3743d39..ef3ad0b1b05 100644 --- a/config/docker_compose.toml +++ b/config/docker_compose.toml @@ -206,6 +206,7 @@ redsys.base_url = "https://sis-t.redsys.es:25443" riskified.base_url = "https://sandbox.riskified.com/api" santander.base_url = "https://pix.santander.com.br/api/v1/sandbox/" shift4.base_url = "https://api.shift4.com/" +silverflow.base_url = "https://api-sbx.silverflow.co/v1" signifyd.base_url = "https://api.signifyd.com/" square.base_url = "https://connect.squareupsandbox.com/" square.secondary_base_url = "https://pci-connect.squareupsandbox.com/" @@ -322,6 +323,7 @@ cards = [ "redsys", "santander", "shift4", + "silverflow", "square", "stax", "stripe", diff --git a/crates/connector_configs/src/connector.rs b/crates/connector_configs/src/connector.rs index 3e36dc023b9..f092b543f8c 100644 --- a/crates/connector_configs/src/connector.rs +++ b/crates/connector_configs/src/connector.rs @@ -261,6 +261,7 @@ pub struct ConnectorConfig { pub redsys: Option<ConnectorTomlConfig>, pub santander: Option<ConnectorTomlConfig>, pub shift4: Option<ConnectorTomlConfig>, + pub silverflow: Option<ConnectorTomlConfig>, pub stripe: Option<ConnectorTomlConfig>, #[cfg(feature = "payouts")] pub stripe_payout: Option<ConnectorTomlConfig>, diff --git a/crates/connector_configs/toml/development.toml b/crates/connector_configs/toml/development.toml index 99663984715..f8919cba957 100644 --- a/crates/connector_configs/toml/development.toml +++ b/crates/connector_configs/toml/development.toml @@ -6315,4 +6315,8 @@ type="Text" [payload.connector_auth.HeaderKey] api_key="API Key" [payload.connector_webhook_details] -merchant_secret="Source verification key" \ No newline at end of file +merchant_secret="Source verification key" +[silverflow] +[silverflow.connector_auth.BodyKey] +api_key="API Key" +key1="Secret Key" diff --git a/crates/connector_configs/toml/production.toml b/crates/connector_configs/toml/production.toml index a7d81b2c22d..667c5028c95 100644 --- a/crates/connector_configs/toml/production.toml +++ b/crates/connector_configs/toml/production.toml @@ -4921,3 +4921,8 @@ type="Text" api_key="API Key" [payload.connector_webhook_details] merchant_secret="Source verification key" + +[silverflow] +[silverflow.connector_auth.BodyKey] +api_key="API Key" +key1="Secret Key" \ No newline at end of file diff --git a/crates/connector_configs/toml/sandbox.toml b/crates/connector_configs/toml/sandbox.toml index 2660bd1a365..20b7cdf09bf 100644 --- a/crates/connector_configs/toml/sandbox.toml +++ b/crates/connector_configs/toml/sandbox.toml @@ -6289,4 +6289,8 @@ type="Text" [payload.connector_auth.HeaderKey] api_key="API Key" [payload.connector_webhook_details] -merchant_secret="Source verification key" \ No newline at end of file +merchant_secret="Source verification key" +[silverflow] +[silverflow.connector_auth.BodyKey] +api_key="API Key" +key1="Secret Key" diff --git a/crates/hyperswitch_connectors/src/connectors.rs b/crates/hyperswitch_connectors/src/connectors.rs index 0861bbb4610..6583e2ce5b9 100644 --- a/crates/hyperswitch_connectors/src/connectors.rs +++ b/crates/hyperswitch_connectors/src/connectors.rs @@ -87,6 +87,7 @@ pub mod riskified; pub mod santander; pub mod shift4; pub mod signifyd; +pub mod silverflow; pub mod square; pub mod stax; pub mod stripe; @@ -133,10 +134,11 @@ pub use self::{ paypal::Paypal, paystack::Paystack, payu::Payu, placetopay::Placetopay, plaid::Plaid, powertranz::Powertranz, prophetpay::Prophetpay, rapyd::Rapyd, razorpay::Razorpay, recurly::Recurly, redsys::Redsys, riskified::Riskified, santander::Santander, shift4::Shift4, - signifyd::Signifyd, square::Square, stax::Stax, stripe::Stripe, stripebilling::Stripebilling, - taxjar::Taxjar, threedsecureio::Threedsecureio, thunes::Thunes, tokenio::Tokenio, - trustpay::Trustpay, tsys::Tsys, unified_authentication_service::UnifiedAuthenticationService, - vgs::Vgs, volt::Volt, wellsfargo::Wellsfargo, wellsfargopayout::Wellsfargopayout, wise::Wise, - worldline::Worldline, worldpay::Worldpay, worldpayvantiv::Worldpayvantiv, - worldpayxml::Worldpayxml, xendit::Xendit, zen::Zen, zsl::Zsl, + signifyd::Signifyd, silverflow::Silverflow, square::Square, stax::Stax, stripe::Stripe, + stripebilling::Stripebilling, taxjar::Taxjar, threedsecureio::Threedsecureio, thunes::Thunes, + tokenio::Tokenio, trustpay::Trustpay, tsys::Tsys, + unified_authentication_service::UnifiedAuthenticationService, vgs::Vgs, volt::Volt, + wellsfargo::Wellsfargo, wellsfargopayout::Wellsfargopayout, wise::Wise, worldline::Worldline, + worldpay::Worldpay, worldpayvantiv::Worldpayvantiv, worldpayxml::Worldpayxml, xendit::Xendit, + zen::Zen, zsl::Zsl, }; diff --git a/crates/hyperswitch_connectors/src/connectors/silverflow.rs b/crates/hyperswitch_connectors/src/connectors/silverflow.rs new file mode 100644 index 00000000000..7042380d9e0 --- /dev/null +++ b/crates/hyperswitch_connectors/src/connectors/silverflow.rs @@ -0,0 +1,627 @@ +pub mod transformers; + +use std::sync::LazyLock; + +use common_enums::enums; +use common_utils::{ + errors::CustomResult, + ext_traits::BytesExt, + request::{Method, Request, RequestBuilder, RequestContent}, + types::{AmountConvertor, StringMinorUnit, StringMinorUnitForConnector}, +}; +use error_stack::{report, ResultExt}; +use hyperswitch_domain_models::{ + payment_method_data::PaymentMethodData, + router_data::{AccessToken, ConnectorAuthType, ErrorResponse, RouterData}, + router_flow_types::{ + access_token_auth::AccessTokenAuth, + payments::{Authorize, Capture, PSync, PaymentMethodToken, Session, SetupMandate, Void}, + refunds::{Execute, RSync}, + }, + router_request_types::{ + AccessTokenRequestData, PaymentMethodTokenizationData, PaymentsAuthorizeData, + PaymentsCancelData, PaymentsCaptureData, PaymentsSessionData, PaymentsSyncData, + RefundsData, SetupMandateRequestData, + }, + router_response_types::{ + ConnectorInfo, PaymentsResponseData, RefundsResponseData, SupportedPaymentMethods, + }, + types::{ + PaymentsAuthorizeRouterData, PaymentsCaptureRouterData, PaymentsSyncRouterData, + RefundSyncRouterData, RefundsRouterData, + }, +}; +use hyperswitch_interfaces::{ + api::{ + self, ConnectorCommon, ConnectorCommonExt, ConnectorIntegration, ConnectorSpecifications, + ConnectorValidation, + }, + configs::Connectors, + errors, + events::connector_api_logs::ConnectorEvent, + types::{self, Response}, + webhooks, +}; +use masking::{ExposeInterface, Mask}; +use transformers as silverflow; + +use crate::{constants::headers, types::ResponseRouterData, utils}; + +#[derive(Clone)] +pub struct Silverflow { + amount_converter: &'static (dyn AmountConvertor<Output = StringMinorUnit> + Sync), +} + +impl Silverflow { + pub fn new() -> &'static Self { + &Self { + amount_converter: &StringMinorUnitForConnector, + } + } +} + +impl api::Payment for Silverflow {} +impl api::PaymentSession for Silverflow {} +impl api::ConnectorAccessToken for Silverflow {} +impl api::MandateSetup for Silverflow {} +impl api::PaymentAuthorize for Silverflow {} +impl api::PaymentSync for Silverflow {} +impl api::PaymentCapture for Silverflow {} +impl api::PaymentVoid for Silverflow {} +impl api::Refund for Silverflow {} +impl api::RefundExecute for Silverflow {} +impl api::RefundSync for Silverflow {} +impl api::PaymentToken for Silverflow {} + +impl ConnectorIntegration<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData> + for Silverflow +{ + // Not Implemented (R) +} + +impl<Flow, Request, Response> ConnectorCommonExt<Flow, Request, Response> for Silverflow +where + Self: ConnectorIntegration<Flow, Request, Response>, +{ + fn build_headers( + &self, + req: &RouterData<Flow, Request, Response>, + _connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + let mut header = vec![( + headers::CONTENT_TYPE.to_string(), + self.get_content_type().to_string().into(), + )]; + let mut api_key = self.get_auth_header(&req.connector_auth_type)?; + header.append(&mut api_key); + Ok(header) + } +} + +impl ConnectorCommon for Silverflow { + fn id(&self) -> &'static str { + "silverflow" + } + + fn get_currency_unit(&self) -> api::CurrencyUnit { + // todo!() + api::CurrencyUnit::Minor + // TODO! Check connector documentation, on which unit they are processing the currency. + // If the connector accepts amount in lower unit ( i.e cents for USD) then return api::CurrencyUnit::Minor, + // if connector accepts amount in base unit (i.e dollars for USD) then return api::CurrencyUnit::Base + } + + fn common_get_content_type(&self) -> &'static str { + "application/json" + } + + fn base_url<'a>(&self, connectors: &'a Connectors) -> &'a str { + connectors.silverflow.base_url.as_ref() + } + + fn get_auth_header( + &self, + auth_type: &ConnectorAuthType, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + let auth = silverflow::SilverflowAuthType::try_from(auth_type) + .change_context(errors::ConnectorError::FailedToObtainAuthType)?; + Ok(vec![( + headers::AUTHORIZATION.to_string(), + auth.api_key.expose().into_masked(), + )]) + } + + fn build_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + let response: silverflow::SilverflowErrorResponse = res + .response + .parse_struct("SilverflowErrorResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + + Ok(ErrorResponse { + status_code: res.status_code, + code: response.code, + message: response.message, + reason: response.reason, + attempt_status: None, + connector_transaction_id: None, + network_advice_code: None, + network_decline_code: None, + network_error_message: None, + }) + } +} + +impl ConnectorValidation for Silverflow { + fn validate_mandate_payment( + &self, + _pm_type: Option<enums::PaymentMethodType>, + pm_data: PaymentMethodData, + ) -> CustomResult<(), errors::ConnectorError> { + match pm_data { + PaymentMethodData::Card(_) => Err(errors::ConnectorError::NotImplemented( + "validate_mandate_payment does not support cards".to_string(), + ) + .into()), + _ => Ok(()), + } + } + + fn validate_psync_reference_id( + &self, + _data: &PaymentsSyncData, + _is_three_ds: bool, + _status: enums::AttemptStatus, + _connector_meta_data: Option<common_utils::pii::SecretSerdeValue>, + ) -> CustomResult<(), errors::ConnectorError> { + Ok(()) + } +} + +impl ConnectorIntegration<Session, PaymentsSessionData, PaymentsResponseData> for Silverflow { + //TODO: implement sessions flow +} + +impl ConnectorIntegration<AccessTokenAuth, AccessTokenRequestData, AccessToken> for Silverflow {} + +impl ConnectorIntegration<SetupMandate, SetupMandateRequestData, PaymentsResponseData> + for Silverflow +{ +} + +impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData> for Silverflow { + fn get_headers( + &self, + req: &PaymentsAuthorizeRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsAuthorizeRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn get_request_body( + &self, + req: &PaymentsAuthorizeRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let amount = utils::convert_amount( + self.amount_converter, + req.request.minor_amount, + req.request.currency, + )?; + + let connector_router_data = silverflow::SilverflowRouterData::from((amount, req)); + let connector_req = + silverflow::SilverflowPaymentsRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &PaymentsAuthorizeRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::PaymentsAuthorizeType::get_url( + self, req, connectors, + )?) + .attach_default_headers() + .headers(types::PaymentsAuthorizeType::get_headers( + self, req, connectors, + )?) + .set_body(types::PaymentsAuthorizeType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsAuthorizeRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsAuthorizeRouterData, errors::ConnectorError> { + let response: silverflow::SilverflowPaymentsResponse = res + .response + .parse_struct("Silverflow PaymentsAuthorizeResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<PSync, PaymentsSyncData, PaymentsResponseData> for Silverflow { + fn get_headers( + &self, + req: &PaymentsSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsSyncRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn build_request( + &self, + req: &PaymentsSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Get) + .url(&types::PaymentsSyncType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::PaymentsSyncType::get_headers(self, req, connectors)?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsSyncRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsSyncRouterData, errors::ConnectorError> { + let response: silverflow::SilverflowPaymentsResponse = res + .response + .parse_struct("silverflow PaymentsSyncResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<Capture, PaymentsCaptureData, PaymentsResponseData> for Silverflow { + fn get_headers( + &self, + req: &PaymentsCaptureRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsCaptureRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn get_request_body( + &self, + _req: &PaymentsCaptureRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_request_body method".to_string()).into()) + } + + fn build_request( + &self, + req: &PaymentsCaptureRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::PaymentsCaptureType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::PaymentsCaptureType::get_headers( + self, req, connectors, + )?) + .set_body(types::PaymentsCaptureType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsCaptureRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsCaptureRouterData, errors::ConnectorError> { + let response: silverflow::SilverflowPaymentsResponse = res + .response + .parse_struct("Silverflow PaymentsCaptureResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<Void, PaymentsCancelData, PaymentsResponseData> for Silverflow {} + +impl ConnectorIntegration<Execute, RefundsData, RefundsResponseData> for Silverflow { + fn get_headers( + &self, + req: &RefundsRouterData<Execute>, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &RefundsRouterData<Execute>, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn get_request_body( + &self, + req: &RefundsRouterData<Execute>, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let refund_amount = utils::convert_amount( + self.amount_converter, + req.request.minor_refund_amount, + req.request.currency, + )?; + + let connector_router_data = silverflow::SilverflowRouterData::from((refund_amount, req)); + let connector_req = silverflow::SilverflowRefundRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &RefundsRouterData<Execute>, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + let request = RequestBuilder::new() + .method(Method::Post) + .url(&types::RefundExecuteType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::RefundExecuteType::get_headers( + self, req, connectors, + )?) + .set_body(types::RefundExecuteType::get_request_body( + self, req, connectors, + )?) + .build(); + Ok(Some(request)) + } + + fn handle_response( + &self, + data: &RefundsRouterData<Execute>, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<RefundsRouterData<Execute>, errors::ConnectorError> { + let response: silverflow::RefundResponse = res + .response + .parse_struct("silverflow RefundResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<RSync, RefundsData, RefundsResponseData> for Silverflow { + fn get_headers( + &self, + req: &RefundSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &RefundSyncRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn build_request( + &self, + req: &RefundSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Get) + .url(&types::RefundSyncType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::RefundSyncType::get_headers(self, req, connectors)?) + .set_body(types::RefundSyncType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &RefundSyncRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<RefundSyncRouterData, errors::ConnectorError> { + let response: silverflow::RefundResponse = res + .response + .parse_struct("silverflow RefundSyncResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +#[async_trait::async_trait] +impl webhooks::IncomingWebhook for Silverflow { + fn get_webhook_object_reference_id( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<api_models::webhooks::ObjectReferenceId, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } + + fn get_webhook_event_type( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<api_models::webhooks::IncomingWebhookEvent, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } + + fn get_webhook_resource_object( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<Box<dyn masking::ErasedMaskSerialize>, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } +} + +static SILVERFLOW_SUPPORTED_PAYMENT_METHODS: LazyLock<SupportedPaymentMethods> = + LazyLock::new(SupportedPaymentMethods::new); + +static SILVERFLOW_CONNECTOR_INFO: ConnectorInfo = ConnectorInfo { + display_name: "Silverflow", + description: "Silverflow connector", + connector_type: enums::PaymentConnectorCategory::PaymentGateway, +}; + +static SILVERFLOW_SUPPORTED_WEBHOOK_FLOWS: [enums::EventClass; 0] = []; + +impl ConnectorSpecifications for Silverflow { + fn get_connector_about(&self) -> Option<&'static ConnectorInfo> { + Some(&SILVERFLOW_CONNECTOR_INFO) + } + + fn get_supported_payment_methods(&self) -> Option<&'static SupportedPaymentMethods> { + Some(&SILVERFLOW_SUPPORTED_PAYMENT_METHODS) + } + + fn get_supported_webhook_flows(&self) -> Option<&'static [enums::EventClass]> { + Some(&SILVERFLOW_SUPPORTED_WEBHOOK_FLOWS) + } +} diff --git a/crates/hyperswitch_connectors/src/connectors/silverflow/transformers.rs b/crates/hyperswitch_connectors/src/connectors/silverflow/transformers.rs new file mode 100644 index 00000000000..8a1bb52a5bb --- /dev/null +++ b/crates/hyperswitch_connectors/src/connectors/silverflow/transformers.rs @@ -0,0 +1,219 @@ +use common_enums::enums; +use common_utils::types::StringMinorUnit; +use hyperswitch_domain_models::{ + payment_method_data::PaymentMethodData, + router_data::{ConnectorAuthType, RouterData}, + router_flow_types::refunds::{Execute, RSync}, + router_request_types::ResponseId, + router_response_types::{PaymentsResponseData, RefundsResponseData}, + types::{PaymentsAuthorizeRouterData, RefundsRouterData}, +}; +use hyperswitch_interfaces::errors; +use masking::Secret; +use serde::{Deserialize, Serialize}; + +use crate::types::{RefundsResponseRouterData, ResponseRouterData}; + +//TODO: Fill the struct with respective fields +pub struct SilverflowRouterData<T> { + pub amount: StringMinorUnit, // The type of amount that a connector accepts, for example, String, i64, f64, etc. + pub router_data: T, +} + +impl<T> From<(StringMinorUnit, T)> for SilverflowRouterData<T> { + fn from((amount, item): (StringMinorUnit, T)) -> Self { + //Todo : use utils to convert the amount to the type of amount that a connector accepts + Self { + amount, + router_data: item, + } + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Serialize, PartialEq)] +pub struct SilverflowPaymentsRequest { + amount: StringMinorUnit, + card: SilverflowCard, +} + +#[derive(Default, Debug, Serialize, Eq, PartialEq)] +pub struct SilverflowCard { + number: cards::CardNumber, + expiry_month: Secret<String>, + expiry_year: Secret<String>, + cvc: Secret<String>, + complete: bool, +} + +impl TryFrom<&SilverflowRouterData<&PaymentsAuthorizeRouterData>> for SilverflowPaymentsRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: &SilverflowRouterData<&PaymentsAuthorizeRouterData>, + ) -> Result<Self, Self::Error> { + match item.router_data.request.payment_method_data.clone() { + PaymentMethodData::Card(_) => Err(errors::ConnectorError::NotImplemented( + "Card payment method not implemented".to_string(), + ) + .into()), + _ => Err(errors::ConnectorError::NotImplemented("Payment method".to_string()).into()), + } + } +} + +//TODO: Fill the struct with respective fields +// Auth Struct +pub struct SilverflowAuthType { + pub(super) api_key: Secret<String>, +} + +impl TryFrom<&ConnectorAuthType> for SilverflowAuthType { + 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, Copy, Default, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "lowercase")] +pub enum SilverflowPaymentStatus { + Succeeded, + Failed, + #[default] + Processing, +} + +impl From<SilverflowPaymentStatus> for common_enums::AttemptStatus { + fn from(item: SilverflowPaymentStatus) -> Self { + match item { + SilverflowPaymentStatus::Succeeded => Self::Charged, + SilverflowPaymentStatus::Failed => Self::Failure, + SilverflowPaymentStatus::Processing => Self::Authorizing, + } + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] +pub struct SilverflowPaymentsResponse { + status: SilverflowPaymentStatus, + id: String, +} + +impl<F, T> TryFrom<ResponseRouterData<F, SilverflowPaymentsResponse, T, PaymentsResponseData>> + for RouterData<F, T, PaymentsResponseData> +{ + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: ResponseRouterData<F, SilverflowPaymentsResponse, T, PaymentsResponseData>, + ) -> Result<Self, Self::Error> { + Ok(Self { + status: common_enums::AttemptStatus::from(item.response.status), + response: Ok(PaymentsResponseData::TransactionResponse { + resource_id: ResponseId::ConnectorTransactionId(item.response.id), + redirection_data: Box::new(None), + mandate_reference: Box::new(None), + connector_metadata: None, + network_txn_id: None, + connector_response_reference_id: None, + incremental_authorization_allowed: None, + charges: None, + }), + ..item.data + }) + } +} + +//TODO: Fill the struct with respective fields +// REFUND : +// Type definition for RefundRequest +#[derive(Default, Debug, Serialize)] +pub struct SilverflowRefundRequest { + pub amount: StringMinorUnit, +} + +impl<F> TryFrom<&SilverflowRouterData<&RefundsRouterData<F>>> for SilverflowRefundRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from(item: &SilverflowRouterData<&RefundsRouterData<F>>) -> Result<Self, Self::Error> { + Ok(Self { + amount: item.amount.to_owned(), + }) + } +} + +// Type definition for Refund Response + +#[allow(dead_code)] +#[derive(Debug, Copy, Serialize, Default, Deserialize, Clone)] +pub enum RefundStatus { + Succeeded, + Failed, + #[default] + Processing, +} + +impl From<RefundStatus> for enums::RefundStatus { + fn from(item: RefundStatus) -> Self { + match item { + RefundStatus::Succeeded => Self::Success, + RefundStatus::Failed => Self::Failure, + RefundStatus::Processing => Self::Pending, + //TODO: Review mapping + } + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Clone, Serialize, Deserialize)] +pub struct RefundResponse { + id: String, + status: RefundStatus, +} + +impl TryFrom<RefundsResponseRouterData<Execute, RefundResponse>> for RefundsRouterData<Execute> { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: RefundsResponseRouterData<Execute, RefundResponse>, + ) -> Result<Self, Self::Error> { + Ok(Self { + response: Ok(RefundsResponseData { + connector_refund_id: item.response.id.to_string(), + refund_status: enums::RefundStatus::from(item.response.status), + }), + ..item.data + }) + } +} + +impl TryFrom<RefundsResponseRouterData<RSync, RefundResponse>> for RefundsRouterData<RSync> { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: RefundsResponseRouterData<RSync, RefundResponse>, + ) -> Result<Self, Self::Error> { + Ok(Self { + response: Ok(RefundsResponseData { + connector_refund_id: item.response.id.to_string(), + refund_status: enums::RefundStatus::from(item.response.status), + }), + ..item.data + }) + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Serialize, Deserialize, PartialEq)] +pub struct SilverflowErrorResponse { + pub status_code: u16, + pub code: String, + pub message: String, + pub reason: Option<String>, + pub network_advice_code: Option<String>, + pub network_decline_code: Option<String>, + pub network_error_message: Option<String>, +} diff --git a/crates/hyperswitch_connectors/src/default_implementations.rs b/crates/hyperswitch_connectors/src/default_implementations.rs index a2a5c163865..9cc798d57cd 100644 --- a/crates/hyperswitch_connectors/src/default_implementations.rs +++ b/crates/hyperswitch_connectors/src/default_implementations.rs @@ -226,6 +226,7 @@ default_imp_for_authorize_session_token!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -352,6 +353,7 @@ default_imp_for_calculate_tax!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Square, @@ -444,6 +446,7 @@ default_imp_for_session_update!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stripe, connectors::Stax, @@ -570,6 +573,7 @@ default_imp_for_post_session_tokens!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Square, connectors::Stax, @@ -694,6 +698,7 @@ default_imp_for_create_order!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Square, connectors::Stax, @@ -821,6 +826,7 @@ default_imp_for_update_metadata!( connectors::Redsys, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Square, connectors::Stax, @@ -898,6 +904,7 @@ macro_rules! default_imp_for_complete_authorize { } default_imp_for_complete_authorize!( + connectors::Silverflow, connectors::Vgs, connectors::Aci, connectors::Adyen, @@ -1089,6 +1096,7 @@ default_imp_for_incremental_authorization!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Square, @@ -1213,6 +1221,7 @@ default_imp_for_create_customer!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Square, connectors::Stripebilling, @@ -1324,6 +1333,7 @@ default_imp_for_connector_redirect_response!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Square, @@ -1361,6 +1371,7 @@ macro_rules! default_imp_for_pre_processing_steps{ } default_imp_for_pre_processing_steps!( + connectors::Silverflow, connectors::Vgs, connectors::Aci, connectors::Adyenplatform, @@ -1561,6 +1572,7 @@ default_imp_for_post_processing_steps!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Square, @@ -1689,6 +1701,7 @@ default_imp_for_approve!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Square, @@ -1817,6 +1830,7 @@ default_imp_for_reject!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Square, @@ -1944,6 +1958,7 @@ default_imp_for_webhook_source_verification!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Square, @@ -2071,6 +2086,7 @@ default_imp_for_accept_dispute!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Square, @@ -2197,6 +2213,7 @@ default_imp_for_submit_evidence!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Square, @@ -2322,6 +2339,7 @@ default_imp_for_defend_dispute!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Square, @@ -2457,6 +2475,7 @@ default_imp_for_file_upload!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Square, @@ -2570,6 +2589,7 @@ default_imp_for_payouts!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Square, connectors::Stax, @@ -2693,6 +2713,7 @@ default_imp_for_payouts_create!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Square, @@ -2819,6 +2840,7 @@ default_imp_for_payouts_retrieve!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Square, @@ -2946,6 +2968,7 @@ default_imp_for_payouts_eligibility!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Square, @@ -3068,6 +3091,7 @@ default_imp_for_payouts_fulfill!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Square, @@ -3193,6 +3217,7 @@ default_imp_for_payouts_cancel!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Square, @@ -3319,6 +3344,7 @@ default_imp_for_payouts_quote!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Square, @@ -3446,6 +3472,7 @@ default_imp_for_payouts_recipient!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Square, @@ -3573,6 +3600,7 @@ default_imp_for_payouts_recipient_account!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Square, @@ -3701,6 +3729,7 @@ default_imp_for_frm_sale!( connectors::Redsys, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Stax, connectors::Square, connectors::Stripe, @@ -3829,6 +3858,7 @@ default_imp_for_frm_checkout!( connectors::Redsys, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Stax, connectors::Square, connectors::Stripe, @@ -3957,6 +3987,7 @@ default_imp_for_frm_transaction!( connectors::Redsys, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Stax, connectors::Square, connectors::Stripe, @@ -4085,6 +4116,7 @@ default_imp_for_frm_fulfillment!( connectors::Redsys, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Stax, connectors::Square, connectors::Stripe, @@ -4213,6 +4245,7 @@ default_imp_for_frm_record_return!( connectors::Redsys, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Stripe, connectors::Stax, connectors::Square, @@ -4336,6 +4369,7 @@ default_imp_for_revoking_mandates!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Square, @@ -4462,6 +4496,7 @@ default_imp_for_uas_pre_authentication!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stripe, connectors::Stax, @@ -4587,6 +4622,7 @@ default_imp_for_uas_post_authentication!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stripe, connectors::Stax, @@ -4713,6 +4749,7 @@ default_imp_for_uas_authentication_confirmation!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Square, @@ -4830,6 +4867,7 @@ default_imp_for_connector_request_id!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Square, @@ -4951,6 +4989,7 @@ default_imp_for_fraud_check!( connectors::Redsys, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Stax, connectors::Square, connectors::Stripe, @@ -5100,6 +5139,7 @@ default_imp_for_connector_authentication!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Square, @@ -5224,6 +5264,7 @@ default_imp_for_uas_authentication!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Square, @@ -5343,6 +5384,7 @@ default_imp_for_revenue_recovery!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -5472,6 +5514,7 @@ default_imp_for_billing_connector_payment_sync!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stripe, connectors::Stax, @@ -5599,6 +5642,7 @@ default_imp_for_revenue_recovery_record_back!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stripe, connectors::Stax, @@ -5727,6 +5771,7 @@ default_imp_for_billing_connector_invoice_sync!( connectors::Santander, connectors::Signifyd, connectors::Shift4, + connectors::Silverflow, connectors::Stax, connectors::Square, connectors::Stripe, @@ -5848,6 +5893,7 @@ default_imp_for_external_vault!( connectors::Santander, connectors::Signifyd, connectors::Shift4, + connectors::Silverflow, connectors::Stax, connectors::Stripe, connectors::Stripebilling, @@ -5975,6 +6021,7 @@ default_imp_for_external_vault_insert!( connectors::Santander, connectors::Signifyd, connectors::Shift4, + connectors::Silverflow, connectors::Stax, connectors::Stripe, connectors::Stripebilling, @@ -6102,6 +6149,7 @@ default_imp_for_external_vault_retrieve!( connectors::Santander, connectors::Signifyd, connectors::Shift4, + connectors::Silverflow, connectors::Stax, connectors::Stripe, connectors::Stripebilling, @@ -6229,6 +6277,7 @@ default_imp_for_external_vault_delete!( connectors::Santander, connectors::Signifyd, connectors::Shift4, + connectors::Silverflow, connectors::Stax, connectors::Stripe, connectors::Stripebilling, @@ -6355,6 +6404,7 @@ default_imp_for_external_vault_create!( connectors::Santander, connectors::Signifyd, connectors::Shift4, + connectors::Silverflow, connectors::Stax, connectors::Stripe, connectors::Stripebilling, diff --git a/crates/hyperswitch_connectors/src/default_implementations_v2.rs b/crates/hyperswitch_connectors/src/default_implementations_v2.rs index 2c3e849d4c9..7bc66a1e6cf 100644 --- a/crates/hyperswitch_connectors/src/default_implementations_v2.rs +++ b/crates/hyperswitch_connectors/src/default_implementations_v2.rs @@ -333,6 +333,7 @@ default_imp_for_new_connector_integration_payment!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -461,6 +462,7 @@ default_imp_for_new_connector_integration_refund!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -584,6 +586,7 @@ default_imp_for_new_connector_integration_connector_access_token!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -712,6 +715,7 @@ default_imp_for_new_connector_integration_accept_dispute!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -839,6 +843,7 @@ default_imp_for_new_connector_integration_submit_evidence!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -967,6 +972,7 @@ default_imp_for_new_connector_integration_defend_dispute!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -1105,6 +1111,7 @@ default_imp_for_new_connector_integration_file_upload!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -1235,6 +1242,7 @@ default_imp_for_new_connector_integration_payouts_create!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -1365,6 +1373,7 @@ default_imp_for_new_connector_integration_payouts_eligibility!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -1495,6 +1504,7 @@ default_imp_for_new_connector_integration_payouts_fulfill!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -1625,6 +1635,7 @@ default_imp_for_new_connector_integration_payouts_cancel!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -1755,6 +1766,7 @@ default_imp_for_new_connector_integration_payouts_quote!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -1885,6 +1897,7 @@ default_imp_for_new_connector_integration_payouts_recipient!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -2015,6 +2028,7 @@ default_imp_for_new_connector_integration_payouts_sync!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -2145,6 +2159,7 @@ default_imp_for_new_connector_integration_payouts_recipient_account!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -2273,6 +2288,7 @@ default_imp_for_new_connector_integration_webhook_source_verification!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -2403,6 +2419,7 @@ default_imp_for_new_connector_integration_frm_sale!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -2533,6 +2550,7 @@ default_imp_for_new_connector_integration_frm_checkout!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -2663,6 +2681,7 @@ default_imp_for_new_connector_integration_frm_transaction!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -2793,6 +2812,7 @@ default_imp_for_new_connector_integration_frm_fulfillment!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -2923,6 +2943,7 @@ default_imp_for_new_connector_integration_frm_record_return!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -3049,6 +3070,7 @@ default_imp_for_new_connector_integration_revoking_mandates!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -3147,6 +3169,7 @@ default_imp_for_new_connector_integration_frm!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -3272,6 +3295,7 @@ default_imp_for_new_connector_integration_connector_authentication!( connectors::Recurly, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -3389,6 +3413,7 @@ default_imp_for_new_connector_integration_revenue_recovery!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -3540,6 +3565,7 @@ default_imp_for_new_connector_integration_external_vault!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Square, diff --git a/crates/hyperswitch_domain_models/src/configs.rs b/crates/hyperswitch_domain_models/src/configs.rs index 89f8ddf673f..9e64262f78f 100644 --- a/crates/hyperswitch_domain_models/src/configs.rs +++ b/crates/hyperswitch_domain_models/src/configs.rs @@ -101,6 +101,7 @@ pub struct Connectors { pub riskified: ConnectorParams, pub santander: ConnectorParams, pub shift4: ConnectorParams, + pub silverflow: ConnectorParams, pub signifyd: ConnectorParams, pub square: ConnectorParams, pub stax: ConnectorParams, diff --git a/crates/router/src/connector.rs b/crates/router/src/connector.rs index 49aa7c61cd9..619608a95de 100644 --- a/crates/router/src/connector.rs +++ b/crates/router/src/connector.rs @@ -32,9 +32,9 @@ pub use hyperswitch_connectors::connectors::{ placetopay, placetopay::Placetopay, plaid, plaid::Plaid, powertranz, powertranz::Powertranz, prophetpay, prophetpay::Prophetpay, rapyd, rapyd::Rapyd, razorpay, razorpay::Razorpay, recurly, recurly::Recurly, redsys, redsys::Redsys, riskified, riskified::Riskified, santander, - santander::Santander, shift4, shift4::Shift4, signifyd, signifyd::Signifyd, square, - square::Square, stax, stax::Stax, stripe, stripe::Stripe, stripebilling, - stripebilling::Stripebilling, taxjar, taxjar::Taxjar, threedsecureio, + santander::Santander, shift4, shift4::Shift4, signifyd, signifyd::Signifyd, silverflow, + silverflow::Silverflow, square, square::Square, stax, stax::Stax, stripe, stripe::Stripe, + stripebilling, stripebilling::Stripebilling, taxjar, taxjar::Taxjar, threedsecureio, threedsecureio::Threedsecureio, thunes, thunes::Thunes, tokenio, tokenio::Tokenio, trustpay, trustpay::Trustpay, tsys, tsys::Tsys, unified_authentication_service, unified_authentication_service::UnifiedAuthenticationService, vgs, vgs::Vgs, volt, volt::Volt, diff --git a/crates/router/tests/connectors/main.rs b/crates/router/tests/connectors/main.rs index 10707ba2f4e..62066918099 100644 --- a/crates/router/tests/connectors/main.rs +++ b/crates/router/tests/connectors/main.rs @@ -91,6 +91,7 @@ mod razorpay; mod redsys; mod santander; mod shift4; +mod silverflow; mod square; mod stax; mod stripe; diff --git a/crates/router/tests/connectors/silverflow.rs b/crates/router/tests/connectors/silverflow.rs new file mode 100644 index 00000000000..5d4f48943da --- /dev/null +++ b/crates/router/tests/connectors/silverflow.rs @@ -0,0 +1,421 @@ +use hyperswitch_domain_models::payment_method_data::{Card, PaymentMethodData}; +use masking::Secret; +use router::types::{self, api, storage::enums}; +use test_utils::connector_auth; + +use crate::utils::{self, ConnectorActions}; + +#[derive(Clone, Copy)] +struct SilverflowTest; +impl ConnectorActions for SilverflowTest {} +impl utils::Connector for SilverflowTest { + fn get_data(&self) -> api::ConnectorData { + use router::connector::Silverflow; + utils::construct_connector_data_old( + Box::new(Silverflow::new()), + types::Connector::Plaid, + api::GetToken::Connector, + None, + ) + } + + fn get_auth_token(&self) -> types::ConnectorAuthType { + utils::to_connector_auth_type( + connector_auth::ConnectorAuthentication::new() + .silverflow + .expect("Missing connector authentication configuration") + .into(), + ) + } + + fn get_name(&self) -> String { + "silverflow".to_string() + } +} + +static CONNECTOR: SilverflowTest = SilverflowTest {}; + +fn get_default_payment_info() -> Option<utils::PaymentInfo> { + None +} + +fn payment_method_details() -> Option<types::PaymentsAuthorizeData> { + None +} + +// Cards Positive Tests +// Creates a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_only_authorize_payment() { + let response = CONNECTOR + .authorize_payment(payment_method_details(), get_default_payment_info()) + .await + .expect("Authorize payment response"); + assert_eq!(response.status, enums::AttemptStatus::Authorized); +} + +// Captures a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_capture_authorized_payment() { + let response = CONNECTOR + .authorize_and_capture_payment(payment_method_details(), None, get_default_payment_info()) + .await + .expect("Capture payment response"); + assert_eq!(response.status, enums::AttemptStatus::Charged); +} + +// Partially captures a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_capture_authorized_payment() { + let response = CONNECTOR + .authorize_and_capture_payment( + payment_method_details(), + Some(types::PaymentsCaptureData { + amount_to_capture: 50, + ..utils::PaymentCaptureType::default().0 + }), + get_default_payment_info(), + ) + .await + .expect("Capture payment response"); + assert_eq!(response.status, enums::AttemptStatus::Charged); +} + +// Synchronizes a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_authorized_payment() { + let authorize_response = CONNECTOR + .authorize_payment(payment_method_details(), get_default_payment_info()) + .await + .expect("Authorize payment response"); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + let response = CONNECTOR + .psync_retry_till_status_matches( + enums::AttemptStatus::Authorized, + Some(types::PaymentsSyncData { + connector_transaction_id: types::ResponseId::ConnectorTransactionId( + txn_id.unwrap(), + ), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .expect("PSync response"); + assert_eq!(response.status, enums::AttemptStatus::Authorized,); +} + +// Voids a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_void_authorized_payment() { + let response = CONNECTOR + .authorize_and_void_payment( + payment_method_details(), + Some(types::PaymentsCancelData { + connector_transaction_id: String::from(""), + cancellation_reason: Some("requested_by_customer".to_string()), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .expect("Void payment response"); + assert_eq!(response.status, enums::AttemptStatus::Voided); +} + +// Refunds a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_manually_captured_payment() { + let response = CONNECTOR + .capture_payment_and_refund( + payment_method_details(), + None, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Partially refunds a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_refund_manually_captured_payment() { + let response = CONNECTOR + .capture_payment_and_refund( + payment_method_details(), + None, + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Synchronizes a refund using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_manually_captured_refund() { + let refund_response = CONNECTOR + .capture_payment_and_refund( + payment_method_details(), + None, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + let response = CONNECTOR + .rsync_retry_till_status_matches( + enums::RefundStatus::Success, + refund_response.response.unwrap().connector_refund_id, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Creates a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_make_payment() { + let authorize_response = CONNECTOR + .make_payment(payment_method_details(), get_default_payment_info()) + .await + .unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); +} + +// Synchronizes a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_auto_captured_payment() { + let authorize_response = CONNECTOR + .make_payment(payment_method_details(), get_default_payment_info()) + .await + .unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + assert_ne!(txn_id, None, "Empty connector transaction id"); + let response = CONNECTOR + .psync_retry_till_status_matches( + enums::AttemptStatus::Charged, + Some(types::PaymentsSyncData { + connector_transaction_id: types::ResponseId::ConnectorTransactionId( + txn_id.unwrap(), + ), + capture_method: Some(enums::CaptureMethod::Automatic), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!(response.status, enums::AttemptStatus::Charged,); +} + +// Refunds a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_auto_captured_payment() { + let response = CONNECTOR + .make_payment_and_refund(payment_method_details(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Partially refunds a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_refund_succeeded_payment() { + let refund_response = CONNECTOR + .make_payment_and_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + refund_response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Creates multiple refunds against a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_succeeded_payment_multiple_times() { + CONNECTOR + .make_payment_and_multiple_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await; +} + +// Synchronizes a refund using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_refund() { + let refund_response = CONNECTOR + .make_payment_and_refund(payment_method_details(), None, get_default_payment_info()) + .await + .unwrap(); + let response = CONNECTOR + .rsync_retry_till_status_matches( + enums::RefundStatus::Success, + refund_response.response.unwrap().connector_refund_id, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Cards Negative scenarios +// Creates a payment with incorrect CVC. +#[actix_web::test] +async fn should_fail_payment_for_incorrect_cvc() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: PaymentMethodData::Card(Card { + card_cvc: Secret::new("12345".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's security code is invalid.".to_string(), + ); +} + +// Creates a payment with incorrect expiry month. +#[actix_web::test] +async fn should_fail_payment_for_invalid_exp_month() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: PaymentMethodData::Card(Card { + card_exp_month: Secret::new("20".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's expiration month is invalid.".to_string(), + ); +} + +// Creates a payment with incorrect expiry year. +#[actix_web::test] +async fn should_fail_payment_for_incorrect_expiry_year() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: PaymentMethodData::Card(Card { + card_exp_year: Secret::new("2000".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's expiration year is invalid.".to_string(), + ); +} + +// Voids a payment using automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_fail_void_payment_for_auto_capture() { + let authorize_response = CONNECTOR + .make_payment(payment_method_details(), get_default_payment_info()) + .await + .unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + assert_ne!(txn_id, None, "Empty connector transaction id"); + let void_response = CONNECTOR + .void_payment(txn_id.unwrap(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + void_response.response.unwrap_err().message, + "You cannot cancel this PaymentIntent because it has a status of succeeded." + ); +} + +// Captures a payment using invalid connector payment id. +#[actix_web::test] +async fn should_fail_capture_for_invalid_payment() { + let capture_response = CONNECTOR + .capture_payment("123456789".to_string(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + capture_response.response.unwrap_err().message, + String::from("No such payment_intent: '123456789'") + ); +} + +// Refunds a payment with refund amount higher than payment amount. +#[actix_web::test] +async fn should_fail_for_refund_amount_higher_than_payment_amount() { + let response = CONNECTOR + .make_payment_and_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 150, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Refund amount (₹1.50) is greater than charge amount (₹1.00)", + ); +} + +// Connector dependent test cases goes here + +// [#478]: add unit tests for non 3DS, wallets & webhooks in connector tests diff --git a/crates/test_utils/src/connector_auth.rs b/crates/test_utils/src/connector_auth.rs index 31141205523..25fffd09b0f 100644 --- a/crates/test_utils/src/connector_auth.rs +++ b/crates/test_utils/src/connector_auth.rs @@ -97,6 +97,7 @@ pub struct ConnectorAuthentication { pub redsys: Option<HeaderKey>, pub santander: Option<BodyKey>, pub shift4: Option<HeaderKey>, + pub silverflow: Option<BodyKey>, pub square: Option<BodyKey>, pub stax: Option<HeaderKey>, pub stripe: Option<HeaderKey>, diff --git a/loadtest/config/development.toml b/loadtest/config/development.toml index d2c62a57796..b1c7a7581c4 100644 --- a/loadtest/config/development.toml +++ b/loadtest/config/development.toml @@ -173,6 +173,7 @@ redsys.base_url = "https://sis-t.redsys.es:25443" riskified.base_url = "https://sandbox.riskified.com/api" santander.base_url = "https://pix.santander.com.br/api/v1/sandbox/" shift4.base_url = "https://api.shift4.com/" +silverflow.base_url = "https://api-sbx.silverflow.co/v1" signifyd.base_url = "https://api.signifyd.com/" square.base_url = "https://connect.squareupsandbox.com/" square.secondary_base_url = "https://pci-connect.squareupsandbox.com/" @@ -288,6 +289,7 @@ cards = [ "redsys", "santander", "shift4", + "silverflow", "square", "stax", "stripe", diff --git a/scripts/add_connector.sh b/scripts/add_connector.sh index 648d2e68993..90424011957 100755 --- a/scripts/add_connector.sh +++ b/scripts/add_connector.sh @@ -6,7 +6,8 @@ function find_prev_connector() { git checkout $self cp $self $self.tmp # Add new connector to existing list and sort it - connectors=(aci adyen adyenplatform airwallex amazonpay applepay archipel authorizedotnet bambora bamboraapac bankofamerica barclaycard billwerk bitpay bluesnap boku braintree cashtocode celero chargebee checkbook checkout coinbase cryptopay ctp_visa cybersource datatrans deutschebank digitalvirgo dlocal dummyconnector dwolla ebanx elavon facilitapay fiserv fiservemea fiuu forte getnet globalpay globepay gocardless gpayments helcim hipay hyperswitch_vault iatapay inespay itaubank jpmorgan juspaythreedsserver klarna mifinity mollie moneris multisafepay netcetera nexinets nexixpay nomupay noon nordea novalnet nuvei opayo opennode paybox payeezy payload payme payone paypal paystack payu placetopay plaid powertranz prophetpay rapyd razorpay recurly redsys santander shift4 square stax stripe stripebilling taxjar threedsecureio thunes tokenio trustpay tsys unified_authentication_service vgs volt wellsfargo wellsfargopayout wise worldline worldpay worldpayvantiv worldpayxml xendit zsl "$1") + connectors=(aci adyen adyenplatform airwallex amazonpay applepay archipel authorizedotnet bambora bamboraapac bankofamerica barclaycard billwerk bitpay bluesnap boku braintree cashtocode celero chargebee checkbook checkout coinbase cryptopay ctp_visa cybersource datatrans deutschebank digitalvirgo dlocal dummyconnector dwolla ebanx elavon facilitapay fiserv fiservemea fiuu forte getnet globalpay globepay gocardless gpayments helcim hipay hyperswitch_vault iatapay inespay itaubank jpmorgan juspaythreedsserver klarna mifinity mollie moneris multisafepay netcetera nexinets nexixpay nomupay noon nordea novalnet nuvei opayo opennode paybox payeezy payload payme payone paypal paystack payu placetopay plaid powertranz prophetpay rapyd razorpay recurly redsys santander shift4 silverflow square stax stripe stripebilling taxjar threedsecureio thunes tokenio trustpay tsys unified_authentication_service vgs volt wellsfargo wellsfargopayout wise worldline worldpay worldpayvantiv worldpayxml xendit zsl "$1") + IFS=$'\n' sorted=($(sort <<<"${connectors[]}")); unset IFS res="$(echo ${sorted[@]})" sed -i'' -e "s/^ connectors=.*/ connectors=($res \"\$1\")/" $self.tmp	2025-07-04T14:25:37Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description Connector template code for new connector silverflow. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> ## How did you test it? This is a template PR for Silverflow, just checked for compilation. Nothing else to test. ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	6197df2e35a292238a9b393d7a1848f0d50ec09b	6197df2e35a292238a9b393d7a1848f0d50ec09b
juspay/hyperswitch	juspay__hyperswitch-8538	Bug: Migrate from cargo2nix to rust-flake Migrate the Nix build/shell system from cargo2nix to rust-flake. Parent Issue: #57 Related PR: #8503 ## Acceptance Criteria - [x] Migrate from cargo2nix to rust-flake - [x] Verify nix CI/CD compatibility	diff --git a/.gitignore b/.gitignore index 01f1f2e9007..1f31c3c1525 100644 --- a/.gitignore +++ b/.gitignore @@ -270,3 +270,4 @@ creds.json # Nix services data /data +.pre-commit-config.yaml diff --git a/flake.lock b/flake.lock index 36c888e7db1..9b65a841327 100644 --- a/flake.lock +++ b/flake.lock @@ -1,102 +1,113 @@ { "nodes": { - "cargo2nix": { + "crane": { + "locked": { + "lastModified": 1750266157, + "narHash": "sha256-tL42YoNg9y30u7zAqtoGDNdTyXTi8EALDeCB13FtbQA=", + "owner": "ipetkov", + "repo": "crane", + "rev": "e37c943371b73ed87faf33f7583860f81f1d5a48", + "type": "github" + }, + "original": { + "owner": "ipetkov", + "repo": "crane", + "type": "github" + } + }, + "flake-parts": { "inputs": { - "flake-compat": "flake-compat", - "flake-utils": "flake-utils", - "nixpkgs": "nixpkgs", - "rust-overlay": "rust-overlay" + "nixpkgs-lib": "nixpkgs-lib" }, "locked": { - "lastModified": 1742755793, - "narHash": "sha256-nz3zSO5a/cB/XPcP4c3cddUceKH9V3LNMuNpfV3TDeE=", - "owner": "cargo2nix", - "repo": "cargo2nix", - "rev": "f7b2c744b1e6ee39c7b4528ea34f06db598266a6", + "lastModified": 1751413152, + "narHash": "sha256-Tyw1RjYEsp5scoigs1384gIg6e0GoBVjms4aXFfRssQ=", + "owner": "hercules-ci", + "repo": "flake-parts", + "rev": "77826244401ea9de6e3bac47c2db46005e1f30b5", "type": "github" }, "original": { - "owner": "cargo2nix", - "ref": "release-0.11.0", - "repo": "cargo2nix", + "owner": "hercules-ci", + "repo": "flake-parts", "type": "github" } }, - "flake-compat": { + "git-hooks": { "flake": false, "locked": { - "lastModified": 1696426674, - "narHash": "sha256-kvjfFW7WAETZlt09AgDn1MrtKzP7t90Vf7vypd3OL1U=", - "owner": "edolstra", - "repo": "flake-compat", - "rev": "0f9255e01c2351cc7d116c072cb317785dd33b33", + "lastModified": 1750779888, + "narHash": "sha256-wibppH3g/E2lxU43ZQHC5yA/7kIKLGxVEnsnVK1BtRg=", + "owner": "cachix", + "repo": "git-hooks.nix", + "rev": "16ec914f6fb6f599ce988427d9d94efddf25fe6d", "type": "github" }, "original": { - "owner": "edolstra", - "repo": "flake-compat", + "owner": "cachix", + "repo": "git-hooks.nix", "type": "github" } }, - "flake-parts": { + "globset": { "inputs": { - "nixpkgs-lib": "nixpkgs-lib" + "nixpkgs-lib": [ + "rust-flake", + "nixpkgs" + ] }, "locked": { - "lastModified": 1749398372, - "narHash": "sha256-tYBdgS56eXYaWVW3fsnPQ/nFlgWi/Z2Ymhyu21zVM98=", - "owner": "hercules-ci", - "repo": "flake-parts", - "rev": "9305fe4e5c2a6fcf5ba6a3ff155720fbe4076569", + "lastModified": 1744379919, + "narHash": "sha256-ieaQegt7LdMDFweeHhRaUQFYyF0U3pWD/XiCvq5L5U8=", + "owner": "pdtpartners", + "repo": "globset", + "rev": "4e21c96ab1259b8cd864272f96a8891b589c8eda", "type": "github" }, "original": { - "owner": "hercules-ci", - "repo": "flake-parts", + "owner": "pdtpartners", + "repo": "globset", "type": "github" } }, - "flake-utils": { - "inputs": { - "systems": "systems" - }, + "nixos-unified": { "locked": { - "lastModified": 1694529238, - "narHash": "sha256-zsNZZGTGnMOf9YpHKJqMSsa0dXbfmxeoJ7xHlrt+xmY=", - "owner": "numtide", - "repo": "flake-utils", - "rev": "ff7b65b44d01cf9ba6a71320833626af21126384", + "lastModified": 1751174231, + "narHash": "sha256-OLPo3ZI/gKH0C6P6l2W9RYm1ow/Jl4qBrasQ3rjAA0E=", + "owner": "srid", + "repo": "nixos-unified", + "rev": "05eb3d59d3b48460ea01c419702d4fc0c3210805", "type": "github" }, "original": { - "owner": "numtide", - "repo": "flake-utils", + "owner": "srid", + "repo": "nixos-unified", "type": "github" } }, "nixpkgs": { "locked": { - "lastModified": 1705099185, - "narHash": "sha256-SxJenKtvcrKJd0TyJQMO3p6VA7PEp+vmMnmlKFzWMNs=", - "owner": "nixos", + "lastModified": 1751271578, + "narHash": "sha256-P/SQmKDu06x8yv7i0s8bvnnuJYkxVGBWLWHaU+tt4YY=", + "owner": "NixOS", "repo": "nixpkgs", - "rev": "2bce5ccff0ad7abda23e8bb56434b6877a446694", + "rev": "3016b4b15d13f3089db8a41ef937b13a9e33a8df", "type": "github" }, "original": { - "owner": "nixos", - "ref": "release-23.11", + "owner": "NixOS", + "ref": "nixos-unstable", "repo": "nixpkgs", "type": "github" } }, "nixpkgs-lib": { "locked": { - "lastModified": 1748740939, - "narHash": "sha256-rQaysilft1aVMwF14xIdGS3sj1yHlI6oKQNBRTF40cc=", + "lastModified": 1751159883, + "narHash": "sha256-urW/Ylk9FIfvXfliA1ywh75yszAbiTEVgpPeinFyVZo=", "owner": "nix-community", "repo": "nixpkgs.lib", - "rev": "656a64127e9d791a334452c6b6606d17539476e2", + "rev": "14a40a1d7fb9afa4739275ac642ed7301a9ba1ab", "type": "github" }, "original": { @@ -107,36 +118,20 @@ }, "nixpkgs_2": { "locked": { - "lastModified": 1749285348, - "narHash": "sha256-frdhQvPbmDYaScPFiCnfdh3B/Vh81Uuoo0w5TkWmmjU=", - "owner": "NixOS", + "lastModified": 1751271578, + "narHash": "sha256-P/SQmKDu06x8yv7i0s8bvnnuJYkxVGBWLWHaU+tt4YY=", + "owner": "nixos", "repo": "nixpkgs", - "rev": "3e3afe5174c561dee0df6f2c2b2236990146329f", + "rev": "3016b4b15d13f3089db8a41ef937b13a9e33a8df", "type": "github" }, "original": { - "owner": "NixOS", + "owner": "nixos", "ref": "nixos-unstable", "repo": "nixpkgs", "type": "github" } }, - "nixpkgs_3": { - "locked": { - "lastModified": 1744536153, - "narHash": "sha256-awS2zRgF4uTwrOKwwiJcByDzDOdo3Q1rPZbiHQg/N38=", - "owner": "NixOS", - "repo": "nixpkgs", - "rev": "18dd725c29603f582cf1900e0d25f9f1063dbf11", - "type": "github" - }, - "original": { - "owner": "NixOS", - "ref": "nixpkgs-unstable", - "repo": "nixpkgs", - "type": "github" - } - }, "process-compose-flake": { "locked": { "lastModified": 1749418557, @@ -154,49 +149,49 @@ }, "root": { "inputs": { - "cargo2nix": "cargo2nix", "flake-parts": "flake-parts", - "nixpkgs": "nixpkgs_2", + "git-hooks": "git-hooks", + "nixos-unified": "nixos-unified", + "nixpkgs": "nixpkgs", "process-compose-flake": "process-compose-flake", - "rust-overlay": "rust-overlay_2", + "rust-flake": "rust-flake", "services-flake": "services-flake" } }, - "rust-overlay": { + "rust-flake": { "inputs": { - "flake-utils": [ - "cargo2nix", - "flake-utils" - ], - "nixpkgs": [ - "cargo2nix", - "nixpkgs" - ] + "crane": "crane", + "globset": "globset", + "nixpkgs": "nixpkgs_2", + "rust-overlay": "rust-overlay" }, "locked": { - "lastModified": 1705112162, - "narHash": "sha256-IAM0+Uijh/fwlfoeDrOwau9MxcZW3zeDoUHc6Z3xfqM=", - "owner": "oxalica", - "repo": "rust-overlay", - "rev": "9e0af26ffe52bf955ad5575888f093e41fba0104", + "lastModified": 1751562414, + "narHash": "sha256-0ohW9/OWtkRHFteFdbhWJPGNHD00UWHjVA/qOTeuNfM=", + "owner": "juspay", + "repo": "rust-flake", + "rev": "a1c9995285b1288b3249a6ee1ac19443535bbb94", "type": "github" }, "original": { - "owner": "oxalica", - "repo": "rust-overlay", + "owner": "juspay", + "repo": "rust-flake", "type": "github" } }, - "rust-overlay_2": { + "rust-overlay": { "inputs": { - "nixpkgs": "nixpkgs_3" + "nixpkgs": [ + "rust-flake", + "nixpkgs" + ] }, "locked": { - "lastModified": 1749695868, - "narHash": "sha256-debjTLOyqqsYOUuUGQsAHskFXH5+Kx2t3dOo/FCoNRA=", + "lastModified": 1751510438, + "narHash": "sha256-m8PjOoyyCR4nhqtHEBP1tB/jF+gJYYguSZmUmVTEAQE=", "owner": "oxalica", "repo": "rust-overlay", - "rev": "55f914d5228b5c8120e9e0f9698ed5b7214d09cd", + "rev": "7f415261f298656f8164bd636c0dc05af4e95b6b", "type": "github" }, "original": { @@ -207,11 +202,11 @@ }, "services-flake": { "locked": { - "lastModified": 1749343305, - "narHash": "sha256-K4bK5OOJJlSWbJB7TbVzZQzJ694Qm7iGxOr0BpbqRpc=", + "lastModified": 1751536468, + "narHash": "sha256-lgzxvPlpx2uxkMznGBB0ID0byZBlMvcSadotcfnKIbM=", "owner": "juspay", "repo": "services-flake", - "rev": "62ef1d7436e7f07667a9b979c95ac2f706fdf3bb", + "rev": "a4c8b34362dc86a2d417aff1d0b87fbfef17a3c7", "type": "github" }, "original": { @@ -219,21 +214,6 @@ "repo": "services-flake", "type": "github" } - }, - "systems": { - "locked": { - "lastModified": 1681028828, - "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=", - "owner": "nix-systems", - "repo": "default", - "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e", - "type": "github" - }, - "original": { - "owner": "nix-systems", - "repo": "default", - "type": "github" - } } }, "root": "root", diff --git a/flake.nix b/flake.nix index 05058a75d9e..a9b99a93d19 100644 --- a/flake.nix +++ b/flake.nix @@ -5,110 +5,18 @@ nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable"; flake-parts.url = "github:hercules-ci/flake-parts"; - # TODO: Move away from these to https://github.com/juspay/rust-flake - cargo2nix.url = "github:cargo2nix/cargo2nix/release-0.11.0"; - rust-overlay.url = "github:oxalica/rust-overlay"; + rust-flake.url = "github:juspay/rust-flake"; + + nixos-unified.url = "github:srid/nixos-unified"; + + git-hooks.url = "github:cachix/git-hooks.nix"; + git-hooks.flake = false; process-compose-flake.url = "github:Platonic-Systems/process-compose-flake"; services-flake.url = "github:juspay/services-flake"; }; outputs = inputs: - inputs.flake-parts.lib.mkFlake { inherit inputs; } { - imports = [ inputs.process-compose-flake.flakeModule ]; - systems = inputs.nixpkgs.lib.systems.flakeExposed; - perSystem = { self', pkgs, lib, system, ... }: - let - cargoToml = lib.importTOML ./Cargo.toml; - rustDevVersion = "1.87.0"; - rustMsrv = cargoToml.workspace.package.rust-version; - - # Common packages - base = with pkgs; [ - diesel-cli - just - jq - openssl - pkg-config - postgresql # for libpq - protobuf - ]; - - # Minimal packages for running hyperswitch - runPackages = base ++ (with pkgs; [ - rust-bin.stable.${rustMsrv}.default - ]); - - # Development packages - devPackages = base ++ (with pkgs; [ - cargo-watch - nixd - protobuf - rust-bin.stable.${rustDevVersion}.default - swagger-cli - ]); - - # QA packages - qaPackages = devPackages ++ (with pkgs; [ - cypress - nodejs - parallel - ]); - - in - { - _module.args.pkgs = import inputs.nixpkgs { - inherit system; - overlays = [ inputs.cargo2nix.overlays.default (import inputs.rust-overlay) ]; - }; - - # Minimal shell - devShells.default = pkgs.mkShell { - name = "hyperswitch-shell"; - packages = base; - }; - - # Development shell - devShells.dev = pkgs.mkShell { - name = "hyperswitch-dev-shell"; - packages = devPackages; - }; - - # QA development shell - devShells.qa = pkgs.mkShell { - name = "hyperswitch-qa-shell"; - packages = qaPackages; - }; - - /* For running external services - - Redis - - Postgres - / - process-compose."ext-services" = - let - developmentToml = lib.importTOML ./config/development.toml; - databaseName = developmentToml.master_database.dbname; - databaseUser = developmentToml.master_database.username; - databasePass = developmentToml.master_database.password; - in - { - imports = [ inputs.services-flake.processComposeModules.default ]; - services.redis."r1".enable = true; - / Postgres - - Create an user and grant all privileges - - Create a database - / - services.postgres."p1" = { - enable = true; - initialScript = { - before = "CREATE USER ${databaseUser} WITH PASSWORD '${databasePass}' SUPERUSER CREATEDB CREATEROLE INHERIT LOGIN;"; - after = "GRANT ALL PRIVILEGES ON DATABASE ${databaseName} to ${databaseUser};"; - }; - initialDatabases = [ - { name = databaseName; } - ]; - }; - }; - }; - }; + inputs.nixos-unified.lib.mkFlake + { inherit inputs; root = ./.; }; } diff --git a/nix/modules/flake/devshell.nix b/nix/modules/flake/devshell.nix new file mode 100644 index 00000000000..6df0f5951f1 --- /dev/null +++ b/nix/modules/flake/devshell.nix @@ -0,0 +1,52 @@ +{ + debug = true; + perSystem = { config, pkgs, self', ... }: + let + rustMsrv = config.rust-project.cargoToml.workspace.package.rust-version; + rustDevVersion = config.rust-project.toolchain.version; + in + { + devShells = { + default = + pkgs.mkShell { + name = "hyperswitch-shell"; + meta.description = "Environment for Hyperswitch development"; + inputsFrom = [ config.pre-commit.devShell ]; + packages = with pkgs; [ + diesel-cli + just + jq + openssl + pkg-config + postgresql # for libpq + protobuf + ]; + }; + dev = pkgs.mkShell { + name = "hyperswitch-dev-shell"; + meta.description = "Environment for Hyperswitch development with additional tools"; + inputsFrom = [ self'.devShells.default ]; + packages = with pkgs; [ + cargo-watch + nixd + rust-bin.stable.${rustDevVersion}.default + swagger-cli + ]; + shellHook = '' + echo 1>&2 "Ready to work on hyperswitch!" + rustc --version + ''; + }; + qa = pkgs.mkShell { + name = "hyperswitch-qa-shell"; + meta.description = "Environment for Hyperswitch QA"; + inputsFrom = [ self'.devShells.dev ]; + packages = with pkgs; [ + cypress + nodejs + parallel + ]; + }; + }; + }; +} diff --git a/nix/modules/flake/git-hooks.nix b/nix/modules/flake/git-hooks.nix new file mode 100644 index 00000000000..0f658711219 --- /dev/null +++ b/nix/modules/flake/git-hooks.nix @@ -0,0 +1,11 @@ +{ inputs, ... }: +{ + imports = [ + (inputs.git-hooks + /flake-module.nix) + ]; + perSystem = { ... }: { + pre-commit.settings.hooks = { + nixpkgs-fmt.enable = true; + }; + }; +} diff --git a/nix/modules/flake/rust.nix b/nix/modules/flake/rust.nix new file mode 100644 index 00000000000..2d71ade0332 --- /dev/null +++ b/nix/modules/flake/rust.nix @@ -0,0 +1,12 @@ +{ inputs, ... }: +{ + imports = [ + inputs.rust-flake.flakeModules.default + inputs.rust-flake.flakeModules.nixpkgs + ]; + perSystem = { pkgs, ... }: { + rust-project.toolchain = pkgs.rust-bin.fromRustupToolchain { + channel = "1.88.0"; + }; + }; +} diff --git a/nix/modules/flake/services.nix b/nix/modules/flake/services.nix new file mode 100644 index 00000000000..39154183af8 --- /dev/null +++ b/nix/modules/flake/services.nix @@ -0,0 +1,38 @@ +{ inputs, lib, ... }: +{ + imports = [ + inputs.process-compose-flake.flakeModule + ]; + perSystem = { ... }: { + / For running external services + - Redis + - Postgres + / + process-compose."ext-services" = + let + developmentToml = lib.importTOML (inputs.self + /config/development.toml); + databaseName = developmentToml.master_database.dbname; + databaseUser = developmentToml.master_database.username; + databasePass = developmentToml.master_database.password; + in + { + imports = [ inputs.services-flake.processComposeModules.default ]; + services.redis."r1".enable = true; + + / Postgres + - Create an user and grant all privileges + - Create a database + */ + services.postgres."p1" = { + enable = true; + initialScript = { + before = "CREATE USER ${databaseUser} WITH PASSWORD '${databasePass}' SUPERUSER CREATEDB CREATEROLE INHERIT LOGIN;"; + after = "GRANT ALL PRIVILEGES ON DATABASE ${databaseName} to ${databaseUser};"; + }; + initialDatabases = [ + { name = databaseName; } + ]; + }; + }; + }; +}	2025-06-30T14:11:32Z	# Migrate Nix Configuration to rust-flake This PR refactors the existing Nix setup by migrating from `cargo2nix` to `rust-flake`. Resolves: #8538 ## TODO: - [x] Initial port - Port current `flake.nix` functionality using rust-flake - [x] @kashif-m The current [`flake.nix`](https://github.com/juspay/hyperswitch/blob/d305fad2e6c403fde11b9eea785fddefbf3477df/flake.nix#L63-L78) has `default`, `dev`, and `qa` shells. Are all three required? Typically we use `default` for development and additional shells for specific purposes. Currently the PR has `default` as development shell and `qa` for QA work. https://github.com/juspay/hyperswitch/blob/d305fad2e6c403fde11b9eea785fddefbf3477df/flake.nix#L63-L78 - [x] Configuration review - @kashif-m This ports the existing flake.nix structure, but we should discuss additional features needed and fix any broken functionality - [x] The [`flake.nix`](https://github.com/juspay/hyperswitch/blob/d305fad2e6c403fde11b9eea785fddefbf3477df/flake.nix#L23-L24) defines two rust versions: `rustDevVersion` and `rustMsrv`. The `rustMsrv` is [defined but unused](https://github.com/juspay/hyperswitch/blob/d305fad2e6c403fde11b9eea785fddefbf3477df/flake.nix#L37-L39). Is `rustDevVersion` supposed to be different from the version in `Cargo.toml`? https://github.com/juspay/hyperswitch/blob/d305fad2e6c403fde11b9eea785fddefbf3477df/flake.nix#L23-L24 - [ ] ~~Nixify Docker images using [`nix2container`](https://github.com/nlewo/nix2container)~~ (To be addressed in different PR) - [ ] ~~Additional nix integration items (to be discussed)~~ (To be addressed in different PR) - [x] Testing - Ensure nothing breaks and everything works as expected - [x] Approval - Get approval from @srid and @kashif-m ## Benefits - Reproducible builds across environments - Consistent development setup - Simplified dependency management	v1.115.0	8a7590cf60a0610863e7b6ef8a3c4b780ba03a85	8a7590cf60a0610863e7b6ef8a3c4b780ba03a85
juspay/hyperswitch	juspay__hyperswitch-8549	Bug: fix(revenue_recovery) : Skip record-back for failed invoices on auto-voiding billing connectors ## Description <!-- Describe your changes in detail --> This PR addresses two issues : #### Unnecessary record-back for certain billing processors billing processors (like Stripebilling, Recurly) automatically void invoices after 30 days and cancel the associated subscription. Because of this, we don't need to call a record-back flow for failed invoices on our end. #### PSync flow fetching incorrect transaction In the billing connector PSync flow, we were fetching invoice and transaction details using the invoice ID. However, the logic always selected the last transaction from the list, regardless of its status or relevance. This caused the retry count to not be updated correctly.	diff --git a/crates/hyperswitch_connectors/src/connectors/stripebilling.rs b/crates/hyperswitch_connectors/src/connectors/stripebilling.rs index a15ce5f1561..9d731621b77 100644 --- a/crates/hyperswitch_connectors/src/connectors/stripebilling.rs +++ b/crates/hyperswitch_connectors/src/connectors/stripebilling.rs @@ -597,7 +597,7 @@ impl connectors: &Connectors, ) -> CustomResult<String, errors::ConnectorError> { Ok(format!( - "{}v1/payment_intents/{}?expand[0]=latest_charge", + "{}v1/charges/{}", self.base_url(connectors), req.request.billing_connector_psync_id )) @@ -630,10 +630,10 @@ impl recovery_router_data_types::BillingConnectorPaymentsSyncRouterData, errors::ConnectorError, > { - let response: stripebilling::StripebillingBillingConnectorPaymentSyncResponseData = res + let response: stripebilling::StripebillingRecoveryDetailsData = res .response - .parse_struct::<stripebilling::StripebillingBillingConnectorPaymentSyncResponseData>( - "StripebillingBillingConnectorPaymentSyncResponseData", + .parse_struct::<stripebilling::StripebillingRecoveryDetailsData>( + "StripebillingRecoveryDetailsData", ) .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; @@ -805,9 +805,7 @@ impl webhooks::IncomingWebhook for Stripebilling { stripebilling::StripebillingWebhookBody::get_webhook_object_from_body(request.body) .change_context(errors::ConnectorError::WebhookReferenceIdNotFound)?; Ok(api_models::webhooks::ObjectReferenceId::PaymentId( - api_models::payments::PaymentIdType::ConnectorTransactionId( - webhook.data.object.payment_intent, - ), + api_models::payments::PaymentIdType::ConnectorTransactionId(webhook.data.object.charge), )) } diff --git a/crates/hyperswitch_connectors/src/connectors/stripebilling/transformers.rs b/crates/hyperswitch_connectors/src/connectors/stripebilling/transformers.rs index ae80cb48ea1..4cf4d2b542f 100644 --- a/crates/hyperswitch_connectors/src/connectors/stripebilling/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/stripebilling/transformers.rs @@ -426,12 +426,7 @@ impl TryFrom<StripebillingInvoiceBody> for revenue_recovery::RevenueRecoveryInvo } #[derive(Serialize, Deserialize, Debug, Clone)] -pub struct StripebillingBillingConnectorPaymentSyncResponseData { - pub latest_charge: StripebillingLatestChargeData, -} - -#[derive(Serialize, Deserialize, Debug, Clone)] -pub struct StripebillingLatestChargeData { +pub struct StripebillingRecoveryDetailsData { #[serde(rename = "id")] pub charge_id: String, pub status: StripebillingChargeStatus, @@ -517,7 +512,7 @@ impl TryFrom< ResponseRouterData< recovery_router_flows::BillingConnectorPaymentsSync, - StripebillingBillingConnectorPaymentSyncResponseData, + StripebillingRecoveryDetailsData, recovery_request_types::BillingConnectorPaymentsSyncRequest, recovery_response_types::BillingConnectorPaymentsSyncResponse, >, @@ -527,12 +522,12 @@ impl fn try_from( item: ResponseRouterData< recovery_router_flows::BillingConnectorPaymentsSync, - StripebillingBillingConnectorPaymentSyncResponseData, + StripebillingRecoveryDetailsData, recovery_request_types::BillingConnectorPaymentsSyncRequest, recovery_response_types::BillingConnectorPaymentsSyncResponse, >, ) -> Result<Self, Self::Error> { - let charge_details = item.response.latest_charge; + let charge_details = item.response; let merchant_reference_id = id_type::PaymentReferenceId::from_str(charge_details.invoice_id.as_str()) .change_context(errors::ConnectorError::MissingRequiredField { diff --git a/crates/router/src/core/revenue_recovery/types.rs b/crates/router/src/core/revenue_recovery/types.rs index c043641dabd..1e533751f0e 100644 --- a/crates/router/src/core/revenue_recovery/types.rs +++ b/crates/router/src/core/revenue_recovery/types.rs @@ -192,18 +192,6 @@ impl RevenueRecoveryPaymentsAttemptStatus { db.as_scheduler() .retry_process(process_tracker.clone(), schedule_time) .await?; - } else { - // Record a failure transaction back to Billing Connector - // TODO: Add support for retrying failed outgoing recordback webhooks - record_back_to_billing_connector( - state, - &payment_attempt, - payment_intent, - &revenue_recovery_payment_data.billing_mca, - ) - .await - .change_context(errors::RecoveryError::RecordBackToBillingConnectorFailed) - .attach_printable("Failed to record back the billing connector")?; } } Self::Processing => { @@ -504,17 +492,8 @@ impl Action { .await .change_context(errors::RecoveryError::ProcessTrackerFailure) .attach_printable("Failed to update the process tracker")?; - // Record back to billing connector for terminal status // TODO: Add support for retrying failed outgoing recordback webhooks - record_back_to_billing_connector( - state, - payment_attempt, - payment_intent, - &revenue_recovery_payment_data.billing_mca, - ) - .await - .change_context(errors::RecoveryError::RecordBackToBillingConnectorFailed) - .attach_printable("Failed to record back the billing connector")?; + Ok(()) } Self::SuccessfulPayment(payment_attempt) => { @@ -702,18 +681,7 @@ impl Action { } Self::TerminalFailure(payment_attempt) => { - // Record a failure transaction back to Billing Connector // TODO: Add support for retrying failed outgoing recordback webhooks - record_back_to_billing_connector( - state, - payment_attempt, - payment_intent, - &revenue_recovery_payment_data.billing_mca, - ) - .await - .change_context(errors::RecoveryError::RecordBackToBillingConnectorFailed) - .attach_printable("Failed to record back the billing connector")?; - // finish the current psync task db.as_scheduler() .finish_process_with_business_status(	2025-07-04T11:18:12Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [x] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> This PR addresses two issues : #### Unnecessary record-back for certain billing processors billing processors (like Stripebilling, Recurly) automatically void invoices after 30 days and cancel the associated subscription. Because of this, we don't need to call a record-back flow for failed invoices on our end. #### PSync flow fetching incorrect transaction In the billing connector PSync flow, we were fetching invoice and transaction details using the invoice ID. However, the logic always selected the last transaction from the list, regardless of its status or relevance. This caused the retry count to not be updated correctly. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [x] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> #### Create a mca ``` curl --location 'http://localhost:8080/v2/connector-accounts' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'x-merchant-id: cloth_seller_UtjuUuRAKVfLLLoRfZgg' \ --header 'x-profile-id: pro_oCx1cn5sCSpSnwZaw63U' \ --header 'Authorization: admin-api-key=test_admin' \ --data '{ "connector_type": "payment_processor", "connector_name": "stripe", "connector_account_details": { "auth_type": "HeaderKey", "api_key": "" }, "payment_methods_enabled": [ { "payment_method_type": "card", "payment_method_subtypes": [ { "payment_method_subtype": "credit", "payment_experience": null, "card_networks": [ "Visa", "Mastercard" ], "accepted_currencies": null, "accepted_countries": null, "minimum_amount": -1, "maximum_amount": 68607706, "recurring_enabled": true, "installment_payment_enabled": true }, { "payment_method_subtype": "debit", "payment_experience": null, "card_networks": [ "Visa", "Mastercard" ], "accepted_currencies": null, "accepted_countries": null, "minimum_amount": -1, "maximum_amount": 68607706, "recurring_enabled": true, "installment_payment_enabled": true } ] } ], "metadata": { "status_url": "https://2753-2401-4900-1cb8-2ff9-24dd-1ccf-ed12-b464.in.ngrok.io/webhooks/merchant_1678699058/globalpay", "account_name": "transaction_processing", "pricing_type": "fixed_price", "acquirer_bin": "438309", "acquirer_merchant_id": "00002000000" }, "frm_configs": null, "connector_webhook_details": { "merchant_secret": "" }, "profile_id": "" }' ``` #### Create billing processor ``` curl --location 'http://localhost:8080/v2/connector-accounts' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'x-merchant-id: cloth_seller_UtjuUuRAKVfLLLoRfZgg' \ --header 'x-profile-id: pro_oCx1cn5sCSpSnwZaw63U' \ --header 'Authorization: admin-api-key=test_admin' \ --data '{ "connector_type": "billing_processor", "connector_name": "stripebilling", "connector_account_details": { "auth_type": "HeaderKey", "api_key": "" }, "connector_webhook_details": { "merchant_secret": "secret_needed", "additional_secret": "password" }, "feature_metadata": { "revenue_recovery": { "max_retry_count": 7, "billing_connector_retry_threshold": 2, "billing_account_reference": { "mca_id": "stripebilling" } } }, "profile_id": "" }' ``` ### Webhook ``` curl --location 'http://localhost:8080/v2/webhooks/cloth_seller_UtjuUuRAKVfLLLoRfZgg/pro_oCx1cn5sCSpSnwZaw63U/mca_BRNBJA0Q8sBoqhgNrqKc' \ --header 'stripe-signature: t=1751527430,v1=d0436759f119bd0d4c32d9601b0fb7a1b0c614a41fa8774189d82f143ceb0d54,v0=d718933a2ded633f9dae5b23d642d9c819cc618dca8b055b61810e25e961b1dc' \ --header 'accept: /; q=0.5, application/json' \ --header 'user-agent: Stripe/1.0 (+https://stripe.com/docs/webhooks)' \ --header 'cache-control: no-cache' \ --header 'content-type: application/json; charset=utf-8' \ --data '{ "id": "evt_1RghUoCZJlEh6syL2Rj25wzT", "object": "event", "api_version": "2025-02-24.acacia", "created": 1751527427, "data": { "object": { "id": "in_1RghUdCZJlEh6syL1Mn3uN6W", "object": "invoice", "account_country": "US", "account_name": "nishanth2", "account_tax_ids": null, "amount_due": 10000, "amount_overpaid": 0, "amount_paid": 0, "amount_remaining": 10000, "amount_shipping": 0, "application": null, "application_fee_amount": null, "attempt_count": 1, "attempted": true, "auto_advance": true, "automatic_tax": { "disabled_reason": null, "enabled": false, "liability": null, "provider": null, "status": null }, "automatically_finalizes_at": null, "billing_reason": "subscription_cycle", "charge": "ch_3RghUiCZJlEh6syL1A8rC285", "collection_method": "charge_automatically", "created": 1751567400, "currency": "usd", "custom_fields": null, "customer": "cus_SbvK4XDxQhrfp2", "customer_address": null, "customer_email": null, "customer_name": "Anikwet", "customer_phone": null, "customer_shipping": null, "customer_tax_exempt": "none", "customer_tax_ids": [], "default_payment_method": null, "default_source": null, "default_tax_rates": [], "description": null, "discount": null, "discounts": [], "due_date": null, "effective_at": 1751571000, "ending_balance": 0, "footer": null, "from_invoice": null, "hosted_invoice_url": "https://invoice.stripe.com/i/acct_1R156rCZJlEh6syL/test_YWNjdF8xUjE1NnJDWkpsRWg2c3lMLF9TYnZMZkJVZWxLc21ka3NnanVpcFRBaUZpdnlvdE8wLDE0MjA2ODIzMA0200ziIDipdc?s=ap", "invoice_pdf": "https://pay.stripe.com/invoice/acct_1R156rCZJlEh6syL/test_YWNjdF8xUjE1NnJDWkpsRWg2c3lMLF9TYnZMZkJVZWxLc21ka3NnanVpcFRBaUZpdnlvdE8wLDE0MjA2ODIzMA0200ziIDipdc/pdf?s=ap", "issuer": { "type": "self" }, "last_finalization_error": null, "latest_revision": null, "lines": { "object": "list", "data": [ { "id": "il_1RgrtUCZJlEh6syLIS3D3MBo", "object": "line_item", "amount": 10000, "amount_excluding_tax": 10000, "currency": "usd", "description": "1 × bhfhbwfh (at $100.00 / month)", "discount_amounts": [], "discountable": true, "discounts": [], "invoice": "in_1RghUdCZJlEh6syL1Mn3uN6W", "livemode": false, "metadata": {}, "parent": { "invoice_item_details": null, "subscription_item_details": { "invoice_item": null, "proration": false, "proration_details": { "credited_items": null }, "subscription": "sub_1RghUJCZJlEh6syLYSoCZ5DF", "subscription_item": "si_SbvKW8KTf722nZ" }, "type": "subscription_item_details" }, "period": { "end": 1754245800, "start": 1751567400 }, "plan": { "id": "price_1RNvrDCZJlEh6syLxM0yTOmJ", "object": "plan", "active": true, "aggregate_usage": null, "amount": 10000, "amount_decimal": "10000", "billing_scheme": "per_unit", "created": 1747054403, "currency": "usd", "interval": "month", "interval_count": 1, "livemode": false, "metadata": {}, "meter": null, "nickname": null, "product": "prod_SIWvOH70HUE0k4", "tiers_mode": null, "transform_usage": null, "trial_period_days": null, "usage_type": "licensed" }, "pretax_credit_amounts": [], "price": { "id": "price_1RNvrDCZJlEh6syLxM0yTOmJ", "object": "price", "active": true, "billing_scheme": "per_unit", "created": 1747054403, "currency": "usd", "custom_unit_amount": null, "livemode": false, "lookup_key": null, "metadata": {}, "nickname": null, "product": "prod_SIWvOH70HUE0k4", "recurring": { "aggregate_usage": null, "interval": "month", "interval_count": 1, "meter": null, "trial_period_days": null, "usage_type": "licensed" }, "tax_behavior": "unspecified", "tiers_mode": null, "transform_quantity": null, "type": "recurring", "unit_amount": 10000, "unit_amount_decimal": "10000" }, "pricing": { "price_details": { "price": "price_1RNvrDCZJlEh6syLxM0yTOmJ", "product": "prod_SIWvOH70HUE0k4" }, "type": "price_details", "unit_amount_decimal": "10000" }, "proration": false, "proration_details": { "credited_items": null }, "quantity": 1, "subscription": "sub_1RghUJCZJlEh6syLYSoCZ5DF", "subscription_item": "si_SbvKW8KTf722nZ", "tax_amounts": [], "tax_rates": [], "taxes": [], "type": "subscription", "unit_amount_excluding_tax": "10000" } ], "has_more": false, "total_count": 1, "url": "/v1/invoices/in_1RghUdCZJlEh6syL1Mn3uN6W/lines" }, "livemode": false, "metadata": {}, "next_payment_attempt": 1751728637, "number": "5AY2AUB1-0001", "on_behalf_of": null, "paid": false, "paid_out_of_band": false, "parent": { "quote_details": null, "subscription_details": { "metadata": {}, "subscription": "sub_1RghUJCZJlEh6syLYSoCZ5DF" }, "type": "subscription_details" }, "payment_intent": "pi_3RghUiCZJlEh6syL1nf1DJjU", "payment_settings": { "default_mandate": null, "payment_method_options": null, "payment_method_types": null }, "period_end": 1751567400, "period_start": 1751527399, "post_payment_credit_notes_amount": 0, "pre_payment_credit_notes_amount": 0, "quote": null, "receipt_number": null, "rendering": null, "shipping_cost": null, "shipping_details": null, "starting_balance": 0, "statement_descriptor": null, "status": "open", "status_transitions": { "finalized_at": 1751571000, "marked_uncollectible_at": null, "paid_at": null, "voided_at": null }, "subscription": "sub_1RghUJCZJlEh6syLYSoCZ5DF", "subscription_details": { "metadata": {} }, "subtotal": 10000, "subtotal_excluding_tax": 10000, "tax": null, "test_clock": "clock_1RghUYCZJlEh6syL7rjupJQi", "total": 10000, "total_discount_amounts": [], "total_excluding_tax": 10000, "total_pretax_credit_amounts": [], "total_tax_amounts": [], "total_taxes": [], "transfer_data": null, "webhooks_delivered_at": 1751567400 } }, "livemode": false, "pending_webhooks": 1, "request": { "id": null, "idempotency_key": null }, "type": "invoice.payment_failed" }' ``` #### Webhook 2 ``` curl --location 'http://localhost:8080/v2/webhooks/cloth_seller_UtjuUuRAKVfLLLoRfZgg/pro_oCx1cn5sCSpSnwZaw63U/mca_BRNBJA0Q8sBoqhgNrqKc' \ --header 'stripe-signature: t=1751528782,v1=3949ccd6d2cf800faabbae0d9444831d1b00b75c098e0b4a5c5be2fcfcc99c68,v0=97e97facf998e448ee86130da153924e8905ac8fc94b5fb4bd48e6382b26caac' \ --header 'accept: /; q=0.5, application/json' \ --header 'user-agent: Stripe/1.0 (+https://stripe.com/docs/webhooks)' \ --header 'cache-control: no-cache' \ --header 'content-type: application/json; charset=utf-8' \ --header 'api-key;' \ --data '{ "id": "evt_1RghqcCZJlEh6syLWc3NGaNJ", "object": "event", "api_version": "2025-02-24.acacia", "created": 1751528781, "data": { "object": { "id": "in_1RghUdCZJlEh6syL1Mn3uN6W", "object": "invoice", "account_country": "US", "account_name": "nishanth2", "account_tax_ids": null, "amount_due": 10000, "amount_overpaid": 0, "amount_paid": 0, "amount_remaining": 10000, "amount_shipping": 0, "application": null, "application_fee_amount": null, "attempt_count": 1, "attempted": true, "auto_advance": true, "automatic_tax": { "disabled_reason": null, "enabled": false, "liability": null, "provider": null, "status": null }, "automatically_finalizes_at": null, "billing_reason": "subscription_cycle", "charge": "ch_3RghUiCZJlEh6syL17CszxuH", "collection_method": "charge_automatically", "created": 1751567400, "currency": "usd", "custom_fields": null, "customer": "cus_SbvK4XDxQhrfp2", "customer_address": null, "customer_email": null, "customer_name": "Anikwet", "customer_phone": null, "customer_shipping": null, "customer_tax_exempt": "none", "customer_tax_ids": [], "default_payment_method": null, "default_source": null, "default_tax_rates": [], "description": null, "discount": null, "discounts": [], "due_date": null, "effective_at": 1751571000, "ending_balance": 0, "footer": null, "from_invoice": null, "hosted_invoice_url": "https://invoice.stripe.com/i/acct_1R156rCZJlEh6syL/test_YWNjdF8xUjE1NnJDWkpsRWg2c3lMLF9TYnZMZkJVZWxLc21ka3NnanVpcFRBaUZpdnlvdE8wLDE0MjA2OTU4Mg0200bHHKOjrD?s=ap", "invoice_pdf": "https://pay.stripe.com/invoice/acct_1R156rCZJlEh6syL/test_YWNjdF8xUjE1NnJDWkpsRWg2c3lMLF9TYnZMZkJVZWxLc21ka3NnanVpcFRBaUZpdnlvdE8wLDE0MjA2OTU4Mg0200bHHKOjrD/pdf?s=ap", "issuer": { "type": "self" }, "last_finalization_error": null, "latest_revision": null, "lines": { "object": "list", "data": [ { "id": "il_1RgrtUCZJlEh6syLIS3D3MBo", "object": "line_item", "amount": 10000, "amount_excluding_tax": 10000, "currency": "usd", "description": "1 × bhfhbwfh (at $100.00 / month)", "discount_amounts": [], "discountable": true, "discounts": [], "invoice": "in_1RghUdCZJlEh6syL1Mn3uN6W", "livemode": false, "metadata": {}, "parent": { "invoice_item_details": null, "subscription_item_details": { "invoice_item": null, "proration": false, "proration_details": { "credited_items": null }, "subscription": "sub_1RghUJCZJlEh6syLYSoCZ5DF", "subscription_item": "si_SbvKW8KTf722nZ" }, "type": "subscription_item_details" }, "period": { "end": 1754245800, "start": 1751567400 }, "plan": { "id": "price_1RNvrDCZJlEh6syLxM0yTOmJ", "object": "plan", "active": true, "aggregate_usage": null, "amount": 10000, "amount_decimal": "10000", "billing_scheme": "per_unit", "created": 1747054403, "currency": "usd", "interval": "month", "interval_count": 1, "livemode": false, "metadata": {}, "meter": null, "nickname": null, "product": "prod_SIWvOH70HUE0k4", "tiers_mode": null, "transform_usage": null, "trial_period_days": null, "usage_type": "licensed" }, "pretax_credit_amounts": [], "price": { "id": "price_1RNvrDCZJlEh6syLxM0yTOmJ", "object": "price", "active": true, "billing_scheme": "per_unit", "created": 1747054403, "currency": "usd", "custom_unit_amount": null, "livemode": false, "lookup_key": null, "metadata": {}, "nickname": null, "product": "prod_SIWvOH70HUE0k4", "recurring": { "aggregate_usage": null, "interval": "month", "interval_count": 1, "meter": null, "trial_period_days": null, "usage_type": "licensed" }, "tax_behavior": "unspecified", "tiers_mode": null, "transform_quantity": null, "type": "recurring", "unit_amount": 10000, "unit_amount_decimal": "10000" }, "pricing": { "price_details": { "price": "price_1RNvrDCZJlEh6syLxM0yTOmJ", "product": "prod_SIWvOH70HUE0k4" }, "type": "price_details", "unit_amount_decimal": "10000" }, "proration": false, "proration_details": { "credited_items": null }, "quantity": 1, "subscription": "sub_1RghUJCZJlEh6syLYSoCZ5DF", "subscription_item": "si_SbvKW8KTf722nZ", "tax_amounts": [], "tax_rates": [], "taxes": [], "type": "subscription", "unit_amount_excluding_tax": "10000" } ], "has_more": false, "total_count": 1, "url": "/v1/invoices/in_1RghUdCZJlEh6syL1Mn3uN6W/lines" }, "livemode": false, "metadata": {}, "next_payment_attempt": 1751728637, "number": "5AY2AUB1-0001", "on_behalf_of": null, "paid": false, "paid_out_of_band": false, "parent": { "quote_details": null, "subscription_details": { "metadata": {}, "subscription": "sub_1RghUJCZJlEh6syLYSoCZ5DF" }, "type": "subscription_details" }, "payment_intent": "pi_3RghUiCZJlEh6syL1nf1DJjU", "payment_settings": { "default_mandate": null, "payment_method_options": null, "payment_method_types": null }, "period_end": 1751567400, "period_start": 1751527399, "post_payment_credit_notes_amount": 0, "pre_payment_credit_notes_amount": 0, "quote": null, "receipt_number": null, "rendering": null, "shipping_cost": null, "shipping_details": null, "starting_balance": 0, "statement_descriptor": null, "status": "open", "status_transitions": { "finalized_at": 1751571000, "marked_uncollectible_at": null, "paid_at": null, "voided_at": null }, "subscription": "sub_1RghUJCZJlEh6syLYSoCZ5DF", "subscription_details": { "metadata": {} }, "subtotal": 10000, "subtotal_excluding_tax": 10000, "tax": null, "test_clock": "clock_1RghUYCZJlEh6syL7rjupJQi", "total": 10000, "total_discount_amounts": [], "total_excluding_tax": 10000, "total_pretax_credit_amounts": [], "total_tax_amounts": [], "total_taxes": [], "transfer_data": null, "webhooks_delivered_at": 1751567400 } }, "livemode": false, "pending_webhooks": 1, "request": { "id": "req_3YsUGkNRBqgJ2c", "idempotency_key": "072f9dde-db1d-45bd-9a64-483cc341b70a" }, "type": "invoice.payment_failed" }' ``` #### Webhook 3 ``` curl --location 'http://localhost:8080/v2/webhooks/cloth_seller_UtjuUuRAKVfLLLoRfZgg/pro_oCx1cn5sCSpSnwZaw63U/mca_BRNBJA0Q8sBoqhgNrqKc' \ --header 'stripe-signature: t=1751528824,v1=4fd343c36f9b1c61a77b2f430b525ce3b435e4cbf6e58a8946752418aedf10d3,v0=b122d260854d5ad2b8f86f3bc78e09e8a19f1914e5bdf399e6a52a4da2c7190a' \ --header 'accept: /; q=0.5, application/json' \ --header 'user-agent: Stripe/1.0 (+https://stripe.com/docs/webhooks)' \ --header 'cache-control: no-cache' \ --header 'content-type: application/json; charset=utf-8' \ --header 'api-key;' \ --data '{ "id": "evt_1RghrICZJlEh6syL9K2XJoSP", "object": "event", "api_version": "2025-02-24.acacia", "created": 1751528823, "data": { "object": { "id": "in_1RghUdCZJlEh6syL1Mn3uN6W", "object": "invoice", "account_country": "US", "account_name": "nishanth2", "account_tax_ids": null, "amount_due": 10000, "amount_overpaid": 0, "amount_paid": 0, "amount_remaining": 10000, "amount_shipping": 0, "application": null, "application_fee_amount": null, "attempt_count": 1, "attempted": true, "auto_advance": true, "automatic_tax": { "disabled_reason": null, "enabled": false, "liability": null, "provider": null, "status": null }, "automatically_finalizes_at": null, "billing_reason": "subscription_cycle", "charge": "ch_3RghUiCZJlEh6syL1aUfCKJ9", "collection_method": "charge_automatically", "created": 1751567400, "currency": "usd", "custom_fields": null, "customer": "cus_SbvK4XDxQhrfp2", "customer_address": null, "customer_email": null, "customer_name": "Anikwet", "customer_phone": null, "customer_shipping": null, "customer_tax_exempt": "none", "customer_tax_ids": [], "default_payment_method": null, "default_source": null, "default_tax_rates": [], "description": null, "discount": null, "discounts": [], "due_date": null, "effective_at": 1751571000, "ending_balance": 0, "footer": null, "from_invoice": null, "hosted_invoice_url": "https://invoice.stripe.com/i/acct_1R156rCZJlEh6syL/test_YWNjdF8xUjE1NnJDWkpsRWg2c3lMLF9TYnZMZkJVZWxLc21ka3NnanVpcFRBaUZpdnlvdE8wLDE0MjA2OTYyNA0200i196xMb2?s=ap", "invoice_pdf": "https://pay.stripe.com/invoice/acct_1R156rCZJlEh6syL/test_YWNjdF8xUjE1NnJDWkpsRWg2c3lMLF9TYnZMZkJVZWxLc21ka3NnanVpcFRBaUZpdnlvdE8wLDE0MjA2OTYyNA0200i196xMb2/pdf?s=ap", "issuer": { "type": "self" }, "last_finalization_error": null, "latest_revision": null, "lines": { "object": "list", "data": [ { "id": "il_1RgrtUCZJlEh6syLIS3D3MBo", "object": "line_item", "amount": 10000, "amount_excluding_tax": 10000, "currency": "usd", "description": "1 × bhfhbwfh (at $100.00 / month)", "discount_amounts": [], "discountable": true, "discounts": [], "invoice": "in_1RghUdCZJlEh6syL1Mn3uN6W", "livemode": false, "metadata": {}, "parent": { "invoice_item_details": null, "subscription_item_details": { "invoice_item": null, "proration": false, "proration_details": { "credited_items": null }, "subscription": "sub_1RghUJCZJlEh6syLYSoCZ5DF", "subscription_item": "si_SbvKW8KTf722nZ" }, "type": "subscription_item_details" }, "period": { "end": 1754245800, "start": 1751567400 }, "plan": { "id": "price_1RNvrDCZJlEh6syLxM0yTOmJ", "object": "plan", "active": true, "aggregate_usage": null, "amount": 10000, "amount_decimal": "10000", "billing_scheme": "per_unit", "created": 1747054403, "currency": "usd", "interval": "month", "interval_count": 1, "livemode": false, "metadata": {}, "meter": null, "nickname": null, "product": "prod_SIWvOH70HUE0k4", "tiers_mode": null, "transform_usage": null, "trial_period_days": null, "usage_type": "licensed" }, "pretax_credit_amounts": [], "price": { "id": "price_1RNvrDCZJlEh6syLxM0yTOmJ", "object": "price", "active": true, "billing_scheme": "per_unit", "created": 1747054403, "currency": "usd", "custom_unit_amount": null, "livemode": false, "lookup_key": null, "metadata": {}, "nickname": null, "product": "prod_SIWvOH70HUE0k4", "recurring": { "aggregate_usage": null, "interval": "month", "interval_count": 1, "meter": null, "trial_period_days": null, "usage_type": "licensed" }, "tax_behavior": "unspecified", "tiers_mode": null, "transform_quantity": null, "type": "recurring", "unit_amount": 10000, "unit_amount_decimal": "10000" }, "pricing": { "price_details": { "price": "price_1RNvrDCZJlEh6syLxM0yTOmJ", "product": "prod_SIWvOH70HUE0k4" }, "type": "price_details", "unit_amount_decimal": "10000" }, "proration": false, "proration_details": { "credited_items": null }, "quantity": 1, "subscription": "sub_1RghUJCZJlEh6syLYSoCZ5DF", "subscription_item": "si_SbvKW8KTf722nZ", "tax_amounts": [], "tax_rates": [], "taxes": [], "type": "subscription", "unit_amount_excluding_tax": "10000" } ], "has_more": false, "total_count": 1, "url": "/v1/invoices/in_1RghUdCZJlEh6syL1Mn3uN6W/lines" }, "livemode": false, "metadata": {}, "next_payment_attempt": 1751728637, "number": "5AY2AUB1-0001", "on_behalf_of": null, "paid": false, "paid_out_of_band": false, "parent": { "quote_details": null, "subscription_details": { "metadata": {}, "subscription": "sub_1RghUJCZJlEh6syLYSoCZ5DF" }, "type": "subscription_details" }, "payment_intent": "pi_3RghUiCZJlEh6syL1nf1DJjU", "payment_settings": { "default_mandate": null, "payment_method_options": null, "payment_method_types": null }, "period_end": 1751567400, "period_start": 1751527399, "post_payment_credit_notes_amount": 0, "pre_payment_credit_notes_amount": 0, "quote": null, "receipt_number": null, "rendering": null, "shipping_cost": null, "shipping_details": null, "starting_balance": 0, "statement_descriptor": null, "status": "open", "status_transitions": { "finalized_at": 1751571000, "marked_uncollectible_at": null, "paid_at": null, "voided_at": null }, "subscription": "sub_1RghUJCZJlEh6syLYSoCZ5DF", "subscription_details": { "metadata": {} }, "subtotal": 10000, "subtotal_excluding_tax": 10000, "tax": null, "test_clock": "clock_1RghUYCZJlEh6syL7rjupJQi", "total": 10000, "total_discount_amounts": [], "total_excluding_tax": 10000, "total_pretax_credit_amounts": [], "total_tax_amounts": [], "total_taxes": [], "transfer_data": null, "webhooks_delivered_at": 1751567400 } }, "livemode": false, "pending_webhooks": 1, "request": { "id": "req_mRsFYF3quUnlh5", "idempotency_key": "53d702db-6ee1-4964-a2bc-a6e34fe4f834" }, "type": "invoice.payment_failed" }' ``` PASSIVE_RECOVERY_WORKFLOW_EXECUTE_WORKFLOW was executed and on failure the invoice was not voided. <img width="1140" alt="Screenshot 2025-07-04 at 4 47 45 PM" src="https://github.com/user-attachments/assets/62d5a3bd-da78-46a3-bd65-e1560357e7ad" /> ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	1e6a088c04b40c7fdd5bc65c1973056bf58de764	1e6a088c04b40c7fdd5bc65c1973056bf58de764
juspay/hyperswitch	juspay__hyperswitch-8520	Bug: add `debit_routing_savings` in analytics payment attempt We need to add debit_routing_savings to the payment analytics. This will provide the savings per card network, as well as the total savings for a profile.	diff --git a/crates/analytics/docs/clickhouse/scripts/payment_attempts.sql b/crates/analytics/docs/clickhouse/scripts/payment_attempts.sql index 6673b73fedb..16815e9a33d 100644 --- a/crates/analytics/docs/clickhouse/scripts/payment_attempts.sql +++ b/crates/analytics/docs/clickhouse/scripts/payment_attempts.sql @@ -44,6 +44,7 @@ CREATE TABLE payment_attempt_queue ( `profile_id` String, `card_network` Nullable(String), `routing_approach` LowCardinality(Nullable(String)), + `debit_routing_savings` Nullable(UInt32), `sign_flag` Int8 ) ENGINE = Kafka SETTINGS kafka_broker_list = 'kafka0:29092', kafka_topic_list = 'hyperswitch-payment-attempt-events', @@ -98,6 +99,7 @@ CREATE TABLE payment_attempts ( `profile_id` String, `card_network` Nullable(String), `routing_approach` LowCardinality(Nullable(String)), + `debit_routing_savings` Nullable(UInt32), `sign_flag` Int8, INDEX connectorIndex connector TYPE bloom_filter GRANULARITY 1, INDEX paymentMethodIndex payment_method TYPE bloom_filter GRANULARITY 1, @@ -155,6 +157,7 @@ CREATE MATERIALIZED VIEW payment_attempt_mv TO payment_attempts ( `profile_id` String, `card_network` Nullable(String), `routing_approach` LowCardinality(Nullable(String)), + `debit_routing_savings` Nullable(UInt32), `sign_flag` Int8 ) AS SELECT @@ -204,6 +207,7 @@ SELECT profile_id, card_network, routing_approach, + debit_routing_savings, sign_flag FROM payment_attempt_queue diff --git a/crates/analytics/src/payments/accumulator.rs b/crates/analytics/src/payments/accumulator.rs index 20ccc634068..6d7dca22a30 100644 --- a/crates/analytics/src/payments/accumulator.rs +++ b/crates/analytics/src/payments/accumulator.rs @@ -18,6 +18,7 @@ pub struct PaymentMetricsAccumulator { pub connector_success_rate: SuccessRateAccumulator, pub payments_distribution: PaymentsDistributionAccumulator, pub failure_reasons_distribution: FailureReasonsDistributionAccumulator, + pub debit_routing: DebitRoutingAccumulator, } #[derive(Debug, Default)] @@ -58,6 +59,12 @@ pub struct ProcessedAmountAccumulator { pub total_without_retries: Option<i64>, } +#[derive(Debug, Default)] +pub struct DebitRoutingAccumulator { + pub transaction_count: u64, + pub savings_amount: u64, +} + #[derive(Debug, Default)] pub struct AverageAccumulator { pub total: u32, @@ -183,6 +190,27 @@ impl PaymentMetricAccumulator for SuccessRateAccumulator { } } +impl PaymentMetricAccumulator for DebitRoutingAccumulator { + type MetricOutput = (Option<u64>, Option<u64>, Option<u64>); + + fn add_metrics_bucket(&mut self, metrics: &PaymentMetricRow) { + if let Some(count) = metrics.count { + self.transaction_count += u64::try_from(count).unwrap_or(0); + } + if let Some(total) = metrics.total.as_ref().and_then(ToPrimitive::to_u64) { + self.savings_amount += total; + } + } + + fn collect(self) -> Self::MetricOutput { + ( + Some(self.transaction_count), + Some(self.savings_amount), + Some(0), + ) + } +} + impl PaymentMetricAccumulator for PaymentsDistributionAccumulator { type MetricOutput = ( Option<f64>, @@ -440,6 +468,9 @@ impl PaymentMetricsAccumulator { ) = self.payments_distribution.collect(); let (failure_reason_count, failure_reason_count_without_smart_retries) = self.failure_reasons_distribution.collect(); + let (debit_routed_transaction_count, debit_routing_savings, debit_routing_savings_in_usd) = + self.debit_routing.collect(); + PaymentMetricsBucketValue { payment_success_rate: self.payment_success_rate.collect(), payment_count: self.payment_count.collect(), @@ -463,6 +494,9 @@ impl PaymentMetricsAccumulator { failure_reason_count_without_smart_retries, payment_processed_amount_in_usd, payment_processed_amount_without_smart_retries_usd, + debit_routed_transaction_count, + debit_routing_savings, + debit_routing_savings_in_usd, } } } diff --git a/crates/analytics/src/payments/core.rs b/crates/analytics/src/payments/core.rs index e55ba2726af..c1922ffe924 100644 --- a/crates/analytics/src/payments/core.rs +++ b/crates/analytics/src/payments/core.rs @@ -171,6 +171,9 @@ pub async fn get_metrics( .connector_success_rate .add_metrics_bucket(&value); } + PaymentMetrics::DebitRouting \| PaymentMetrics::SessionizedDebitRouting => { + metrics_builder.debit_routing.add_metrics_bucket(&value); + } PaymentMetrics::PaymentsDistribution => { metrics_builder .payments_distribution @@ -294,6 +297,33 @@ pub async fn get_metrics( if let Some(count) = collected_values.failure_reason_count_without_smart_retries { total_failure_reasons_count_without_smart_retries += count; } + if let Some(savings) = collected_values.debit_routing_savings { + let savings_in_usd = if let Some(ex_rates) = ex_rates { + id.currency + .and_then(\|currency\| { + i64::try_from(savings) + .inspect_err(\|e\| { + logger::error!( + "Debit Routing savings conversion error: {:?}", + e + ) + }) + .ok() + .and_then(\|savings_i64\| { + convert(ex_rates, currency, Currency::USD, savings_i64) + .inspect_err(\|e\| { + logger::error!("Currency conversion error: {:?}", e) + }) + .ok() + }) + }) + .map(\|savings\| (savings * rust_decimal::Decimal::new(100, 0)).to_u64()) + .unwrap_or_default() + } else { + None + }; + collected_values.debit_routing_savings_in_usd = savings_in_usd; + } MetricsBucketResponse { values: collected_values, dimensions: id, diff --git a/crates/analytics/src/payments/metrics.rs b/crates/analytics/src/payments/metrics.rs index 67dc50c5152..b19c661322d 100644 --- a/crates/analytics/src/payments/metrics.rs +++ b/crates/analytics/src/payments/metrics.rs @@ -15,6 +15,7 @@ use crate::{ mod avg_ticket_size; mod connector_success_rate; +mod debit_routing; mod payment_count; mod payment_processed_amount; mod payment_success_count; @@ -24,6 +25,7 @@ mod success_rate; use avg_ticket_size::AvgTicketSize; use connector_success_rate::ConnectorSuccessRate; +use debit_routing::DebitRouting; use payment_count::PaymentCount; use payment_processed_amount::PaymentProcessedAmount; use payment_success_count::PaymentSuccessCount; @@ -130,6 +132,11 @@ where .load_metrics(dimensions, auth, filters, granularity, time_range, pool) .await } + Self::DebitRouting => { + DebitRouting + .load_metrics(dimensions, auth, filters, granularity, time_range, pool) + .await + } Self::SessionizedPaymentSuccessRate => { sessionized_metrics::PaymentSuccessRate .load_metrics(dimensions, auth, filters, granularity, time_range, pool) @@ -175,6 +182,11 @@ where .load_metrics(dimensions, auth, filters, granularity, time_range, pool) .await } + Self::SessionizedDebitRouting => { + sessionized_metrics::DebitRouting + .load_metrics(dimensions, auth, filters, granularity, time_range, pool) + .await + } } } } diff --git a/crates/analytics/src/payments/metrics/debit_routing.rs b/crates/analytics/src/payments/metrics/debit_routing.rs new file mode 100644 index 00000000000..584221205cd --- /dev/null +++ b/crates/analytics/src/payments/metrics/debit_routing.rs @@ -0,0 +1,151 @@ +use std::collections::HashSet; + +use api_models::analytics::{ + payments::{PaymentDimensions, PaymentFilters, PaymentMetricsBucketIdentifier}, + Granularity, TimeRange, +}; +use common_utils::errors::ReportSwitchExt; +use diesel_models::enums as storage_enums; +use error_stack::ResultExt; +use time::PrimitiveDateTime; + +use super::PaymentMetricRow; +use crate::{ + enums::AuthInfo, + query::{Aggregate, GroupByClause, QueryBuilder, QueryFilter, SeriesBucket, ToSql, Window}, + types::{AnalyticsCollection, AnalyticsDataSource, MetricsError, MetricsResult}, +}; + +#[derive(Default)] +pub(super) struct DebitRouting; + +#[async_trait::async_trait] +impl<T> super::PaymentMetric<T> for DebitRouting +where + T: AnalyticsDataSource + super::PaymentMetricAnalytics, + PrimitiveDateTime: ToSql<T>, + AnalyticsCollection: ToSql<T>, + Granularity: GroupByClause<T>, + Aggregate<&'static str>: ToSql<T>, + Window<&'static str>: ToSql<T>, +{ + async fn load_metrics( + &self, + dimensions: &[PaymentDimensions], + auth: &AuthInfo, + filters: &PaymentFilters, + granularity: Option<Granularity>, + time_range: &TimeRange, + pool: &T, + ) -> MetricsResult<HashSet<(PaymentMetricsBucketIdentifier, PaymentMetricRow)>> { + let mut query_builder: QueryBuilder<T> = QueryBuilder::new(AnalyticsCollection::Payment); + + for dim in dimensions.iter() { + query_builder.add_select_column(dim).switch()?; + } + query_builder + .add_select_column(Aggregate::Count { + field: None, + alias: Some("count"), + }) + .switch()?; + query_builder + .add_select_column(Aggregate::Sum { + field: "debit_routing_savings", + alias: Some("total"), + }) + .switch()?; + query_builder.add_select_column("currency").switch()?; + query_builder + .add_select_column(Aggregate::Min { + field: "created_at", + alias: Some("start_bucket"), + }) + .switch()?; + query_builder + .add_select_column(Aggregate::Max { + field: "created_at", + alias: Some("end_bucket"), + }) + .switch()?; + + filters.set_filter_clause(&mut query_builder).switch()?; + + auth.set_filter_clause(&mut query_builder).switch()?; + + time_range + .set_filter_clause(&mut query_builder) + .attach_printable("Error filtering time range") + .switch()?; + + for dim in dimensions.iter() { + query_builder + .add_group_by_clause(dim) + .attach_printable("Error grouping by dimensions") + .switch()?; + } + + query_builder + .add_group_by_clause("currency") + .attach_printable("Error grouping by currency") + .switch()?; + + if let Some(granularity) = granularity { + granularity + .set_group_by_clause(&mut query_builder) + .attach_printable("Error adding granularity") + .switch()?; + } + + query_builder + .add_filter_clause( + PaymentDimensions::PaymentStatus, + storage_enums::AttemptStatus::Charged, + ) + .switch()?; + + query_builder + .execute_query::<PaymentMetricRow, _>(pool) + .await + .change_context(MetricsError::QueryBuildingError)? + .change_context(MetricsError::QueryExecutionFailure)? + .into_iter() + .map(\|i\| { + Ok(( + PaymentMetricsBucketIdentifier::new( + i.currency.as_ref().map(\|i\| i.0), + None, + i.connector.clone(), + i.authentication_type.as_ref().map(\|i\| i.0), + i.payment_method.clone(), + i.payment_method_type.clone(), + i.client_source.clone(), + i.client_version.clone(), + i.profile_id.clone(), + i.card_network.clone(), + i.merchant_id.clone(), + i.card_last_4.clone(), + i.card_issuer.clone(), + i.error_reason.clone(), + i.routing_approach.as_ref().map(\|i\| i.0), + TimeRange { + start_time: match (granularity, i.start_bucket) { + (Some(g), Some(st)) => g.clip_to_start(st)?, + _ => time_range.start_time, + }, + end_time: granularity.as_ref().map_or_else( + \|\| Ok(time_range.end_time), + \|g\| i.end_bucket.map(\|et\| g.clip_to_end(et)).transpose(), + )?, + }, + ), + i, + )) + }) + .collect::<error_stack::Result< + HashSet<(PaymentMetricsBucketIdentifier, PaymentMetricRow)>, + crate::query::PostProcessingError, + >>() + .change_context(MetricsError::PostProcessingFailure) + } +} diff --git a/crates/analytics/src/payments/metrics/sessionized_metrics.rs b/crates/analytics/src/payments/metrics/sessionized_metrics.rs index e3a5e370534..9d10c9db008 100644 --- a/crates/analytics/src/payments/metrics/sessionized_metrics.rs +++ b/crates/analytics/src/payments/metrics/sessionized_metrics.rs @@ -1,5 +1,6 @@ mod avg_ticket_size; mod connector_success_rate; +mod debit_routing; mod failure_reasons; mod payment_count; mod payment_processed_amount; @@ -9,6 +10,7 @@ mod retries_count; mod success_rate; pub(super) use avg_ticket_size::AvgTicketSize; pub(super) use connector_success_rate::ConnectorSuccessRate; +pub(super) use debit_routing::DebitRouting; pub(super) use failure_reasons::FailureReasons; pub(super) use payment_count::PaymentCount; pub(super) use payment_processed_amount::PaymentProcessedAmount; diff --git a/crates/analytics/src/payments/metrics/sessionized_metrics/debit_routing.rs b/crates/analytics/src/payments/metrics/sessionized_metrics/debit_routing.rs new file mode 100644 index 00000000000..f7c84e1b65c --- /dev/null +++ b/crates/analytics/src/payments/metrics/sessionized_metrics/debit_routing.rs @@ -0,0 +1,152 @@ +use std::collections::HashSet; + +use api_models::analytics::{ + payments::{PaymentDimensions, PaymentFilters, PaymentMetricsBucketIdentifier}, + Granularity, TimeRange, +}; +use common_utils::errors::ReportSwitchExt; +use diesel_models::enums as storage_enums; +use error_stack::ResultExt; +use time::PrimitiveDateTime; + +use super::PaymentMetricRow; +use crate::{ + enums::AuthInfo, + query::{Aggregate, GroupByClause, QueryBuilder, QueryFilter, SeriesBucket, ToSql, Window}, + types::{AnalyticsCollection, AnalyticsDataSource, MetricsError, MetricsResult}, +}; + +#[derive(Default)] +pub(crate) struct DebitRouting; + +#[async_trait::async_trait] +impl<T> super::PaymentMetric<T> for DebitRouting +where + T: AnalyticsDataSource + super::PaymentMetricAnalytics, + PrimitiveDateTime: ToSql<T>, + AnalyticsCollection: ToSql<T>, + Granularity: GroupByClause<T>, + Aggregate<&'static str>: ToSql<T>, + Window<&'static str>: ToSql<T>, +{ + async fn load_metrics( + &self, + dimensions: &[PaymentDimensions], + auth: &AuthInfo, + filters: &PaymentFilters, + granularity: Option<Granularity>, + time_range: &TimeRange, + pool: &T, + ) -> MetricsResult<HashSet<(PaymentMetricsBucketIdentifier, PaymentMetricRow)>> { + let mut query_builder: QueryBuilder<T> = + QueryBuilder::new(AnalyticsCollection::PaymentSessionized); + + for dim in dimensions.iter() { + query_builder.add_select_column(dim).switch()?; + } + query_builder + .add_select_column(Aggregate::Count { + field: None, + alias: Some("count"), + }) + .switch()?; + query_builder + .add_select_column(Aggregate::Sum { + field: "debit_routing_savings", + alias: Some("total"), + }) + .switch()?; + query_builder.add_select_column("currency").switch()?; + query_builder + .add_select_column(Aggregate::Min { + field: "created_at", + alias: Some("start_bucket"), + }) + .switch()?; + query_builder + .add_select_column(Aggregate::Max { + field: "created_at", + alias: Some("end_bucket"), + }) + .switch()?; + + filters.set_filter_clause(&mut query_builder).switch()?; + + auth.set_filter_clause(&mut query_builder).switch()?; + + time_range + .set_filter_clause(&mut query_builder) + .attach_printable("Error filtering time range") + .switch()?; + + for dim in dimensions.iter() { + query_builder + .add_group_by_clause(dim) + .attach_printable("Error grouping by dimensions") + .switch()?; + } + + query_builder + .add_group_by_clause("currency") + .attach_printable("Error grouping by currency") + .switch()?; + + if let Some(granularity) = granularity { + granularity + .set_group_by_clause(&mut query_builder) + .attach_printable("Error adding granularity") + .switch()?; + } + + query_builder + .add_filter_clause( + PaymentDimensions::PaymentStatus, + storage_enums::AttemptStatus::Charged, + ) + .switch()?; + + query_builder + .execute_query::<PaymentMetricRow, _>(pool) + .await + .change_context(MetricsError::QueryBuildingError)? + .change_context(MetricsError::QueryExecutionFailure)? + .into_iter() + .map(\|i\| { + Ok(( + PaymentMetricsBucketIdentifier::new( + i.currency.as_ref().map(\|i\| i.0), + None, + i.connector.clone(), + i.authentication_type.as_ref().map(\|i\| i.0), + i.payment_method.clone(), + i.payment_method_type.clone(), + i.client_source.clone(), + i.client_version.clone(), + i.profile_id.clone(), + i.card_network.clone(), + i.merchant_id.clone(), + i.card_last_4.clone(), + i.card_issuer.clone(), + i.error_reason.clone(), + i.routing_approach.as_ref().map(\|i\| i.0), + TimeRange { + start_time: match (granularity, i.start_bucket) { + (Some(g), Some(st)) => g.clip_to_start(st)?, + _ => time_range.start_time, + }, + end_time: granularity.as_ref().map_or_else( + \|\| Ok(time_range.end_time), + \|g\| i.end_bucket.map(\|et\| g.clip_to_end(et)).transpose(), + )?, + }, + ), + i, + )) + }) + .collect::<error_stack::Result< + HashSet<(PaymentMetricsBucketIdentifier, PaymentMetricRow)>, + crate::query::PostProcessingError, + >>() + .change_context(MetricsError::PostProcessingFailure) + } +} diff --git a/crates/api_models/src/analytics/payments.rs b/crates/api_models/src/analytics/payments.rs index 537d6df09d1..ec5719f1adb 100644 --- a/crates/api_models/src/analytics/payments.rs +++ b/crates/api_models/src/analytics/payments.rs @@ -111,6 +111,7 @@ pub enum PaymentMetrics { AvgTicketSize, RetriesCount, ConnectorSuccessRate, + DebitRouting, SessionizedPaymentSuccessRate, SessionizedPaymentCount, SessionizedPaymentSuccessCount, @@ -118,6 +119,7 @@ pub enum PaymentMetrics { SessionizedAvgTicketSize, SessionizedRetriesCount, SessionizedConnectorSuccessRate, + SessionizedDebitRouting, PaymentsDistribution, FailureReasons, } @@ -128,8 +130,10 @@ impl ForexMetric for PaymentMetrics { self, Self::PaymentProcessedAmount \| Self::AvgTicketSize + \| Self::DebitRouting \| Self::SessionizedPaymentProcessedAmount \| Self::SessionizedAvgTicketSize + \| Self::SessionizedDebitRouting, ) } } @@ -309,6 +313,9 @@ pub struct PaymentMetricsBucketValue { pub payments_failure_rate_distribution_with_only_retries: Option<f64>, pub failure_reason_count: Option<u64>, pub failure_reason_count_without_smart_retries: Option<u64>, + pub debit_routed_transaction_count: Option<u64>, + pub debit_routing_savings: Option<u64>, + pub debit_routing_savings_in_usd: Option<u64>, } #[derive(Debug, serde::Serialize)] diff --git a/crates/api_models/src/open_router.rs b/crates/api_models/src/open_router.rs index ba53f4c1f00..f5b80383bfb 100644 --- a/crates/api_models/src/open_router.rs +++ b/crates/api_models/src/open_router.rs @@ -67,7 +67,7 @@ pub struct DecidedGateway { #[derive(Debug, Serialize, Deserialize, PartialEq, Clone)] pub struct DebitRoutingOutput { - pub co_badged_card_networks_info: Vec<CoBadgedCardNetworksInfo>, + pub co_badged_card_networks_info: CoBadgedCardNetworks, pub issuer_country: common_enums::CountryAlpha2, pub is_regulated: bool, pub regulated_name: Option<common_enums::RegulatedName>, @@ -80,19 +80,19 @@ pub struct CoBadgedCardNetworksInfo { pub saving_percentage: f64, } -impl DebitRoutingOutput { - pub fn get_co_badged_card_networks(&self) -> Vec<common_enums::CardNetwork> { - self.co_badged_card_networks_info - .iter() - .map(\|data\| data.network.clone()) - .collect() +#[derive(Debug, Serialize, Deserialize, PartialEq, Clone)] +pub struct CoBadgedCardNetworks(pub Vec<CoBadgedCardNetworksInfo>); + +impl CoBadgedCardNetworks { + pub fn get_card_networks(&self) -> Vec<common_enums::CardNetwork> { + self.0.iter().map(\|info\| info.network.clone()).collect() } } impl From<&DebitRoutingOutput> for payment_methods::CoBadgedCardData { fn from(output: &DebitRoutingOutput) -> Self { Self { - co_badged_card_networks: output.get_co_badged_card_networks(), + co_badged_card_networks_info: output.co_badged_card_networks_info.clone(), issuer_country_code: output.issuer_country, is_regulated: output.is_regulated, regulated_name: output.regulated_name.clone(), @@ -111,7 +111,7 @@ impl TryFrom<(payment_methods::CoBadgedCardData, String)> for DebitRoutingReques })?; Ok(Self { - co_badged_card_networks_info: output.co_badged_card_networks, + co_badged_card_networks_info: output.co_badged_card_networks_info.get_card_networks(), issuer_country: output.issuer_country_code, is_regulated: output.is_regulated, regulated_name: output.regulated_name, diff --git a/crates/api_models/src/payment_methods.rs b/crates/api_models/src/payment_methods.rs index 6a8f61484dc..0745fade987 100644 --- a/crates/api_models/src/payment_methods.rs +++ b/crates/api_models/src/payment_methods.rs @@ -19,7 +19,7 @@ use utoipa::{schema, ToSchema}; #[cfg(feature = "payouts")] use crate::payouts; use crate::{ - admin, enums as api_enums, + admin, enums as api_enums, open_router, payments::{self, BankCodeResponse}, }; @@ -937,14 +937,14 @@ pub struct PaymentMethodResponse { pub network_token: Option<NetworkTokenResponse>, } -#[derive(Clone, Debug, Eq, PartialEq, serde::Deserialize, serde::Serialize)] +#[derive(Clone, Debug, PartialEq, serde::Deserialize, serde::Serialize)] pub enum PaymentMethodsData { Card(CardDetailsPaymentMethod), BankDetails(PaymentMethodDataBankCreds), WalletDetails(PaymentMethodDataWalletInfo), } -#[derive(Clone, Debug, Eq, PartialEq, serde::Deserialize, serde::Serialize)] +#[derive(Clone, Debug, PartialEq, serde::Deserialize, serde::Serialize)] pub struct CardDetailsPaymentMethod { pub last4_digits: Option<String>, pub issuer_country: Option<String>, @@ -958,12 +958,33 @@ pub struct CardDetailsPaymentMethod { pub card_type: Option<String>, #[serde(default = "saved_in_locker_default")] pub saved_to_locker: bool, - pub co_badged_card_data: Option<CoBadgedCardData>, + pub co_badged_card_data: Option<CoBadgedCardDataToBeSaved>, } -#[derive(Clone, Debug, Eq, PartialEq, serde::Deserialize, serde::Serialize)] +impl From<&CoBadgedCardData> for CoBadgedCardDataToBeSaved { + fn from(co_badged_card_data: &CoBadgedCardData) -> Self { + Self { + co_badged_card_networks: co_badged_card_data + .co_badged_card_networks_info + .get_card_networks(), + issuer_country_code: co_badged_card_data.issuer_country_code, + is_regulated: co_badged_card_data.is_regulated, + regulated_name: co_badged_card_data.regulated_name.clone(), + } + } +} + +#[derive(Clone, Debug, PartialEq, serde::Deserialize, serde::Serialize)] pub struct CoBadgedCardData { - pub co_badged_card_networks: Vec<api_enums::CardNetwork>, + pub co_badged_card_networks_info: open_router::CoBadgedCardNetworks, + pub issuer_country_code: common_enums::CountryAlpha2, + pub is_regulated: bool, + pub regulated_name: Option<common_enums::RegulatedName>, +} + +#[derive(Clone, Debug, PartialEq, serde::Deserialize, serde::Serialize)] +pub struct CoBadgedCardDataToBeSaved { + pub co_badged_card_networks: Vec<common_enums::CardNetwork>, pub issuer_country_code: common_enums::CountryAlpha2, pub is_regulated: bool, pub regulated_name: Option<common_enums::RegulatedName>, @@ -1325,7 +1346,7 @@ impl From<(CardDetailFromLocker, Option<&CoBadgedCardData>)> for CardDetailsPaym card_network: item.card_network, card_type: item.card_type, saved_to_locker: item.saved_to_locker, - co_badged_card_data: co_badged_card_data.cloned(), + co_badged_card_data: co_badged_card_data.map(CoBadgedCardDataToBeSaved::from), } } } diff --git a/crates/hyperswitch_domain_models/src/api.rs b/crates/hyperswitch_domain_models/src/api.rs index f6d93497627..723cc458e7b 100644 --- a/crates/hyperswitch_domain_models/src/api.rs +++ b/crates/hyperswitch_domain_models/src/api.rs @@ -7,7 +7,7 @@ use common_utils::{ use super::payment_method_data::PaymentMethodData; -#[derive(Debug, Eq, PartialEq)] +#[derive(Debug, PartialEq)] pub enum ApplicationResponse<R> { Json(R), StatusOk, @@ -54,7 +54,7 @@ impl<T: ApiEventMetric> ApiEventMetric for ApplicationResponse<T> { impl_api_event_type!(Miscellaneous, (PaymentLinkFormData, GenericLinkFormData)); -#[derive(Debug, Eq, PartialEq)] +#[derive(Debug, PartialEq)] pub struct RedirectionFormData { pub redirect_form: crate::router_response_types::RedirectForm, pub payment_method_data: Option<PaymentMethodData>, diff --git a/crates/hyperswitch_domain_models/src/payment_method_data.rs b/crates/hyperswitch_domain_models/src/payment_method_data.rs index 5433c486fbe..7a420010657 100644 --- a/crates/hyperswitch_domain_models/src/payment_method_data.rs +++ b/crates/hyperswitch_domain_models/src/payment_method_data.rs @@ -24,7 +24,7 @@ use time::Date; // We need to derive Serialize and Deserialize because some parts of payment method data are being // stored in the database as serde_json::Value -#[derive(Eq, PartialEq, Clone, Debug, Serialize, Deserialize)] +#[derive(PartialEq, Clone, Debug, Serialize, Deserialize)] pub enum PaymentMethodData { Card(Card), CardDetailsForNetworkTransactionId(CardDetailsForNetworkTransactionId), @@ -88,9 +88,21 @@ impl PaymentMethodData { None } } + + pub fn extract_debit_routing_saving_percentage( + &self, + network: &common_enums::CardNetwork, + ) -> Option<f64> { + self.get_co_badged_card_data()? + .co_badged_card_networks_info + .0 + .iter() + .find(\|info\| &info.network == network) + .map(\|info\| info.saving_percentage) + } } -#[derive(Eq, PartialEq, Clone, Debug, Serialize, Deserialize, Default)] +#[derive(PartialEq, Clone, Debug, Serialize, Deserialize, Default)] pub struct Card { pub card_number: cards::CardNumber, pub card_exp_month: Secret<String>, @@ -120,7 +132,7 @@ pub struct CardDetailsForNetworkTransactionId { pub card_holder_name: Option<Secret<String>>, } -#[derive(Eq, PartialEq, Clone, Debug, Serialize, Deserialize, Default)] +#[derive(PartialEq, Clone, Debug, Serialize, Deserialize, Default)] pub struct CardDetail { pub card_number: cards::CardNumber, pub card_exp_month: Secret<String>, @@ -1961,7 +1973,7 @@ impl From<GooglePayWalletData> for payment_methods::PaymentMethodDataWalletInfo } } -#[derive(Clone, Debug, Eq, PartialEq, serde::Deserialize, serde::Serialize)] +#[derive(Clone, Debug, PartialEq, serde::Deserialize, serde::Serialize)] pub enum PaymentMethodsData { Card(CardDetailsPaymentMethod), BankDetails(payment_methods::PaymentMethodDataBankCreds), //PaymentMethodDataBankCreds and its transformations should be moved to the domain models @@ -2005,7 +2017,7 @@ fn saved_in_locker_default() -> bool { } #[cfg(feature = "v1")] -#[derive(Clone, Debug, Eq, PartialEq, serde::Deserialize, serde::Serialize)] +#[derive(Clone, Debug, PartialEq, serde::Deserialize, serde::Serialize)] pub struct CardDetailsPaymentMethod { pub last4_digits: Option<String>, pub issuer_country: Option<String>, diff --git a/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs b/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs index 2b568b70af8..3baddfa98c5 100644 --- a/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs +++ b/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs @@ -9,14 +9,12 @@ use common_types::primitive_wrappers::{ }; #[cfg(feature = "v2")] use common_utils::{ - crypto::Encryptable, - encryption::Encryption, - ext_traits::{Encode, ValueExt}, + crypto::Encryptable, encryption::Encryption, ext_traits::Encode, types::keymanager::ToEncryptable, }; use common_utils::{ errors::{CustomResult, ValidationError}, - ext_traits::OptionExt, + ext_traits::{OptionExt, ValueExt}, id_type, pii, types::{ keymanager::{self, KeyManagerState}, @@ -906,6 +904,7 @@ pub struct PaymentAttempt { pub setup_future_usage_applied: Option<storage_enums::FutureUsage>, pub routing_approach: Option<storage_enums::RoutingApproach>, pub connector_request_reference_id: Option<String>, + pub debit_routing_savings: Option<MinorUnit>, } #[cfg(feature = "v1")] @@ -1063,6 +1062,10 @@ impl PaymentAttempt { pub fn get_total_surcharge_amount(&self) -> Option<MinorUnit> { self.amount_details.surcharge_amount } + + pub fn extract_card_network(&self) -> Option<common_enums::CardNetwork> { + todo!() + } } #[cfg(feature = "v1")] @@ -1074,6 +1077,25 @@ impl PaymentAttempt { pub fn get_total_surcharge_amount(&self) -> Option<MinorUnit> { self.net_amount.get_total_surcharge_amount() } + + pub fn set_debit_routing_savings(&mut self, debit_routing_savings: Option<&MinorUnit>) { + self.debit_routing_savings = debit_routing_savings.copied(); + } + + pub fn extract_card_network(&self) -> Option<common_enums::CardNetwork> { + self.payment_method_data + .as_ref() + .and_then(\|value\| { + value + .clone() + .parse_value::<api_models::payments::AdditionalPaymentData>( + "AdditionalPaymentData", + ) + .ok() + }) + .and_then(\|data\| data.get_additional_card_info()) + .and_then(\|card_info\| card_info.card_network) + } } #[derive(Clone, Debug, Eq, PartialEq)] @@ -1283,6 +1305,7 @@ pub enum PaymentAttemptUpdate { connector_mandate_detail: Option<ConnectorMandateReferenceId>, charges: Option<common_types::payments::ConnectorChargeResponseData>, setup_future_usage_applied: Option<storage_enums::FutureUsage>, + debit_routing_savings: Option<MinorUnit>, }, UnresolvedResponseUpdate { status: storage_enums::AttemptStatus, @@ -1566,6 +1589,7 @@ impl PaymentAttemptUpdate { connector_mandate_detail, charges, setup_future_usage_applied, + debit_routing_savings: _, } => DieselPaymentAttemptUpdate::ResponseUpdate { status, connector, @@ -1756,6 +1780,35 @@ impl PaymentAttemptUpdate { }, } } + + pub fn get_debit_routing_savings(&self) -> Option<&MinorUnit> { + match self { + Self::ResponseUpdate { + debit_routing_savings, + .. + } => debit_routing_savings.as_ref(), + Self::Update { .. } + \| Self::UpdateTrackers { .. } + \| Self::AuthenticationTypeUpdate { .. } + \| Self::ConfirmUpdate { .. } + \| Self::RejectUpdate { .. } + \| Self::BlocklistUpdate { .. } + \| Self::PaymentMethodDetailsUpdate { .. } + \| Self::ConnectorMandateDetailUpdate { .. } + \| Self::VoidUpdate { .. } + \| Self::UnresolvedResponseUpdate { .. } + \| Self::StatusUpdate { .. } + \| Self::ErrorUpdate { .. } + \| Self::CaptureUpdate { .. } + \| Self::AmountToCaptureUpdate { .. } + \| Self::PreprocessingUpdate { .. } + \| Self::ConnectorResponse { .. } + \| Self::IncrementalAuthorizationAmountUpdate { .. } + \| Self::AuthenticationUpdate { .. } + \| Self::ManualUpdate { .. } + \| Self::PostSessionTokensUpdate { .. } => None, + } + } } #[cfg(feature = "v2")] @@ -2033,6 +2086,7 @@ impl behaviour::Conversion for PaymentAttempt { setup_future_usage_applied: storage_model.setup_future_usage_applied, routing_approach: storage_model.routing_approach, connector_request_reference_id: storage_model.connector_request_reference_id, + debit_routing_savings: None, }) } .await diff --git a/crates/router/src/core/debit_routing.rs b/crates/router/src/core/debit_routing.rs index 4975ffc4bd1..d4f7c8bd753 100644 --- a/crates/router/src/core/debit_routing.rs +++ b/crates/router/src/core/debit_routing.rs @@ -281,7 +281,10 @@ where &profile_id, &key_store, vec![connector_data.clone()], - debit_routing_output.get_co_badged_card_networks(), + debit_routing_output + .co_badged_card_networks_info + .clone() + .get_card_networks(), ) .await .map_err(\|error\| { @@ -454,7 +457,10 @@ where &profile_id, &key_store, connector_data_list.clone(), - debit_routing_output.get_co_badged_card_networks(), + debit_routing_output + .co_badged_card_networks_info + .clone() + .get_card_networks(), ) .await .map_err(\|error\| { diff --git a/crates/router/src/core/payment_methods.rs b/crates/router/src/core/payment_methods.rs index 4b1cff09be2..e8e5b2040ed 100644 --- a/crates/router/src/core/payment_methods.rs +++ b/crates/router/src/core/payment_methods.rs @@ -865,12 +865,15 @@ fn get_card_network_with_us_local_debit_network_override( .map(\|network\| network.is_us_local_network()) { services::logger::debug!("Card network is a US local network, checking for global network in co-badged card data"); - co_badged_card_data.and_then(\|data\| { - data.co_badged_card_networks - .iter() - .find(\|network\| network.is_global_network()) - .cloned() - }) + let info: Option<api_models::open_router::CoBadgedCardNetworksInfo> = co_badged_card_data + .and_then(\|data\| { + data.co_badged_card_networks_info + .0 + .iter() + .find(\|info\| info.network.is_global_network()) + .cloned() + }); + info.map(\|data\| data.network) } else { card_network } diff --git a/crates/router/src/core/payment_methods/tokenize.rs b/crates/router/src/core/payment_methods/tokenize.rs index 3556673510c..f0eaea45d98 100644 --- a/crates/router/src/core/payment_methods/tokenize.rs +++ b/crates/router/src/core/payment_methods/tokenize.rs @@ -272,8 +272,12 @@ where card_network: card_details.card_network.clone(), card_type: card_details.card_type.clone(), saved_to_locker, - co_badged_card_data: card_details.co_badged_card_data.clone(), + co_badged_card_data: card_details + .co_badged_card_data + .as_ref() + .map(\|data\| data.into()), }); + create_encrypted_data(&self.state.into(), self.key_store, pm_data) .await .inspect_err(\|err\| logger::info!("Error encrypting payment method data: {:?}", err)) diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs index b12704aab1f..1d5e2a7b4af 100644 --- a/crates/router/src/core/payments.rs +++ b/crates/router/src/core/payments.rs @@ -471,7 +471,7 @@ where // To perform router related operation for PaymentResponse PaymentResponse: Operation<F, FData, Data = D>, - FData: Send + Sync + Clone, + FData: Send + Sync + Clone + router_types::Capturable, { let operation: BoxedOperation<'_, F, Req, D> = Box::new(operation); @@ -1844,7 +1844,7 @@ pub async fn payments_core<F, Res, Req, Op, FData, D>( ) -> RouterResponse<Res> where F: Send + Clone + Sync, - FData: Send + Sync + Clone, + FData: Send + Sync + Clone + router_types::Capturable, Op: Operation<F, Req, Data = D> + Send + Sync + Clone, Req: Debug + Authenticate + Clone, D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, diff --git a/crates/router/src/core/payments/helpers.rs b/crates/router/src/core/payments/helpers.rs index d855ca84e18..9065dcd2ce3 100644 --- a/crates/router/src/core/payments/helpers.rs +++ b/crates/router/src/core/payments/helpers.rs @@ -44,6 +44,7 @@ use hyperswitch_domain_models::{ use hyperswitch_interfaces::integrity::{CheckIntegrity, FlowIntegrity, GetIntegrityObject}; use josekit::jwe; use masking::{ExposeInterface, PeekInterface, SwitchStrategy}; +use num_traits::{FromPrimitive, ToPrimitive}; use openssl::{ derive::Deriver, pkey::PKey, @@ -52,6 +53,7 @@ use openssl::{ #[cfg(feature = "v2")] use redis_interface::errors::RedisError; use router_env::{instrument, logger, tracing}; +use rust_decimal::Decimal; use serde::{Deserialize, Serialize}; use uuid::Uuid; use x509_parser::parse_x509_certificate; @@ -5208,6 +5210,54 @@ pub fn get_applepay_metadata( }) } +pub fn calculate_debit_routing_savings(net_amount: i64, saving_percentage: f64) -> MinorUnit { + logger::debug!( + ?net_amount, + ?saving_percentage, + "Calculating debit routing saving amount" + ); + + let net_decimal = Decimal::from_i64(net_amount).unwrap_or_else(\|\| { + logger::warn!(?net_amount, "Invalid net_amount, using 0"); + Decimal::ZERO + }); + + let percentage_decimal = Decimal::from_f64(saving_percentage).unwrap_or_else(\|\| { + logger::warn!(?saving_percentage, "Invalid saving_percentage, using 0"); + Decimal::ZERO + }); + + let savings_decimal = net_decimal * percentage_decimal / Decimal::from(100); + let rounded_savings = savings_decimal.round(); + + let savings_int = rounded_savings.to_i64().unwrap_or_else(\|\| { + logger::warn!( + ?rounded_savings, + "Debit routing savings calculation overflowed when converting to i64" + ); + 0 + }); + + MinorUnit::new(savings_int) +} + +pub fn get_debit_routing_savings_amount( + payment_method_data: &domain::PaymentMethodData, + payment_attempt: &PaymentAttempt, +) -> Option<MinorUnit> { + let card_network = payment_attempt.extract_card_network()?; + + let saving_percentage = + payment_method_data.extract_debit_routing_saving_percentage(&card_network)?; + + let net_amount = payment_attempt.get_total_amount().get_amount_as_i64(); + + Some(calculate_debit_routing_savings( + net_amount, + saving_percentage, + )) +} + #[cfg(all(feature = "retry", feature = "v1"))] pub async fn get_apple_pay_retryable_connectors<F, D>( state: &SessionState, diff --git a/crates/router/src/core/payments/operations/payment_response.rs b/crates/router/src/core/payments/operations/payment_response.rs index 939679ef51f..e72555b2ede 100644 --- a/crates/router/src/core/payments/operations/payment_response.rs +++ b/crates/router/src/core/payments/operations/payment_response.rs @@ -1767,6 +1767,14 @@ async fn payment_response_update_tracker<F: Clone, T: types::Capturable>( let payment_method_id = payment_data.payment_attempt.payment_method_id.clone(); + let debit_routing_savings = + payment_data.payment_method_data.as_ref().and_then(\|data\| { + payments_helpers::get_debit_routing_savings_amount( + data, + &payment_data.payment_attempt, + ) + }); + utils::add_apple_pay_payment_status_metrics( router_data.status, router_data.apple_pay_flow.clone(), @@ -1857,6 +1865,7 @@ async fn payment_response_update_tracker<F: Clone, T: types::Capturable>( setup_future_usage_applied: payment_data .payment_attempt .setup_future_usage_applied, + debit_routing_savings, }), ), }; diff --git a/crates/router/src/core/payments/retry.rs b/crates/router/src/core/payments/retry.rs index 728396ef530..f7d8b3e888b 100644 --- a/crates/router/src/core/payments/retry.rs +++ b/crates/router/src/core/payments/retry.rs @@ -48,7 +48,7 @@ pub async fn do_gsm_actions<F, ApiRequest, FData, D>( ) -> RouterResult<types::RouterData<F, FData, types::PaymentsResponseData>> where F: Clone + Send + Sync, - FData: Send + Sync, + FData: Send + Sync + types::Capturable, payments::PaymentResponse: operations::Operation<F, FData>, D: payments::OperationSessionGetters<F> + payments::OperationSessionSetters<F> @@ -345,7 +345,7 @@ pub async fn do_retry<F, ApiRequest, FData, D>( ) -> RouterResult<types::RouterData<F, FData, types::PaymentsResponseData>> where F: Clone + Send + Sync, - FData: Send + Sync, + FData: Send + Sync + types::Capturable, payments::PaymentResponse: operations::Operation<F, FData>, D: payments::OperationSessionGetters<F> + payments::OperationSessionSetters<F> @@ -425,7 +425,7 @@ pub async fn modify_trackers<F, FData, D>( ) -> RouterResult<()> where F: Clone + Send, - FData: Send, + FData: Send + types::Capturable, D: payments::OperationSessionGetters<F> + payments::OperationSessionSetters<F> + Send + Sync, { let new_attempt_count = payment_data.get_payment_intent().attempt_count + 1; @@ -451,6 +451,13 @@ where .and_then(\|connector_response\| connector_response.additional_payment_method_data), )?; + let debit_routing_savings = payment_data.get_payment_method_data().and_then(\|data\| { + payments::helpers::get_debit_routing_savings_amount( + data, + payment_data.get_payment_attempt(), + ) + }); + match router_data.response { Ok(types::PaymentsResponseData::TransactionResponse { resource_id, @@ -506,6 +513,7 @@ where connector_mandate_detail: None, charges, setup_future_usage_applied: None, + debit_routing_savings, }; #[cfg(feature = "v1")] diff --git a/crates/router/src/core/routing/transformers.rs b/crates/router/src/core/routing/transformers.rs index 6560e6786c8..b13dee1bcb4 100644 --- a/crates/router/src/core/routing/transformers.rs +++ b/crates/router/src/core/routing/transformers.rs @@ -180,7 +180,7 @@ impl OpenRouterDecideGatewayRequestExt for OpenRouterDecideGatewayRequest { Self { payment_info: PaymentInfo { payment_id: attempt.payment_id.clone(), - amount: attempt.net_amount.get_order_amount(), + amount: attempt.net_amount.get_total_amount(), currency: attempt.currency.unwrap_or(storage_enums::Currency::USD), payment_type: "ORDER_PAYMENT".to_string(), card_isin: card_isin.map(\|value\| value.peek().clone()), diff --git a/crates/router/src/db/kafka_store.rs b/crates/router/src/db/kafka_store.rs index 7f24d2f5c99..68af56f2262 100644 --- a/crates/router/src/db/kafka_store.rs +++ b/crates/router/src/db/kafka_store.rs @@ -1520,11 +1520,18 @@ impl PaymentAttemptInterface for KafkaStore { payment_attempt: storage::PaymentAttemptUpdate, storage_scheme: MerchantStorageScheme, ) -> CustomResult<storage::PaymentAttempt, errors::StorageError> { - let attempt = self + let mut attempt = self .diesel_store - .update_payment_attempt_with_attempt_id(this.clone(), payment_attempt, storage_scheme) + .update_payment_attempt_with_attempt_id( + this.clone(), + payment_attempt.clone(), + storage_scheme, + ) .await?; + let debit_routing_savings = payment_attempt.get_debit_routing_savings(); + + attempt.set_debit_routing_savings(debit_routing_savings); if let Err(er) = self .kafka_producer .log_payment_attempt(&attempt, Some(this), self.tenant_id.clone()) diff --git a/crates/router/src/services/kafka/payment_attempt.rs b/crates/router/src/services/kafka/payment_attempt.rs index f51e5a12d29..e0dbc6ad213 100644 --- a/crates/router/src/services/kafka/payment_attempt.rs +++ b/crates/router/src/services/kafka/payment_attempt.rs @@ -70,6 +70,7 @@ pub struct KafkaPaymentAttempt<'a> { pub card_network: Option<String>, pub card_discovery: Option<String>, pub routing_approach: Option<storage_enums::RoutingApproach>, + pub debit_routing_savings: Option<MinorUnit>, } #[cfg(feature = "v1")] @@ -132,6 +133,7 @@ impl<'a> KafkaPaymentAttempt<'a> { .card_discovery .map(\|discovery\| discovery.to_string()), routing_approach: attempt.routing_approach, + debit_routing_savings: attempt.debit_routing_savings, } } } diff --git a/crates/router/src/services/kafka/payment_attempt_event.rs b/crates/router/src/services/kafka/payment_attempt_event.rs index e2a88e2c29d..a54ff3cc28a 100644 --- a/crates/router/src/services/kafka/payment_attempt_event.rs +++ b/crates/router/src/services/kafka/payment_attempt_event.rs @@ -71,6 +71,7 @@ pub struct KafkaPaymentAttemptEvent<'a> { pub card_network: Option<String>, pub card_discovery: Option<String>, pub routing_approach: Option<storage_enums::RoutingApproach>, + pub debit_routing_savings: Option<MinorUnit>, } #[cfg(feature = "v1")] @@ -133,6 +134,7 @@ impl<'a> KafkaPaymentAttemptEvent<'a> { .card_discovery .map(\|discovery\| discovery.to_string()), routing_approach: attempt.routing_approach, + debit_routing_savings: attempt.debit_routing_savings, } } } diff --git a/crates/storage_impl/src/mock_db/payment_attempt.rs b/crates/storage_impl/src/mock_db/payment_attempt.rs index 88ddc824b2f..ec27f9bed65 100644 --- a/crates/storage_impl/src/mock_db/payment_attempt.rs +++ b/crates/storage_impl/src/mock_db/payment_attempt.rs @@ -237,6 +237,7 @@ impl PaymentAttemptInterface for MockDb { setup_future_usage_applied: payment_attempt.setup_future_usage_applied, routing_approach: payment_attempt.routing_approach, connector_request_reference_id: payment_attempt.connector_request_reference_id, + debit_routing_savings: None, }; payment_attempts.push(payment_attempt.clone()); Ok(payment_attempt) diff --git a/crates/storage_impl/src/payments/payment_attempt.rs b/crates/storage_impl/src/payments/payment_attempt.rs index 2c69c0766ba..b3fccea353e 100644 --- a/crates/storage_impl/src/payments/payment_attempt.rs +++ b/crates/storage_impl/src/payments/payment_attempt.rs @@ -689,6 +689,7 @@ impl<T: DatabaseStore> PaymentAttemptInterface for KVRouterStore<T> { connector_request_reference_id: payment_attempt .connector_request_reference_id .clone(), + debit_routing_savings: None, }; let field = format!("pa_{}", created_attempt.attempt_id); @@ -1989,6 +1990,7 @@ impl DataModelExt for PaymentAttempt { setup_future_usage_applied: storage_model.setup_future_usage_applied, routing_approach: storage_model.routing_approach, connector_request_reference_id: storage_model.connector_request_reference_id, + debit_routing_savings: None, } } }	2025-07-02T07:21:14Z	<!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> This pull request introduces a new feature to track and analyze debit routing savings and integrates it across multiple components of the analytics system. It also refactors the handling of co-badged card networks to provide additional details, such as saving percentages. Below is a breakdown of the most important changes grouped by theme: ### Debit Routing Analytics Integration: * Added a new column `debit_routing_savings` to the `payment_attempt_queue`, `payment_attempts`, and `payment_attempt_mv` tables in ClickHouse for tracking debit routing savings. * Updated the `PaymentMetricsAccumulator` struct to include a new `DebitRoutingAccumulator`, which tracks transaction counts and savings amounts. Implemented the necessary methods for metric collection and aggregation. * Introduced a new `PaymentMetrics::DebitRouting` enum variant and its corresponding implementation to load metrics, process data, and convert savings to USD. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> -> Enable debit routing for a profile -> Configure adyen connector with local debit networks enabled -> Make some debit routing payments ``` { "amount": 1, "amount_to_capture": 1, "currency": "USD", "confirm": true, "capture_method": "automatic", "setup_future_usage": "on_session", "capture_on": "2022-09-10T10:11:12Z", "email": "[email protected]", "name": "John Doe", "phone": "999999999", "phone_country_code": "+1", "description": "Its my first payment request", "authentication_type": "no_three_ds", "customer_id": "cu_{{$timestamp}}", "return_url": "http://127.0.0.1:4040", "payment_method": "card", "payment_method_type": "debit", "payment_method_data": { "card": { "card_number": "4000 0330 0330 0335", "card_exp_month": "03", "card_exp_year": "2030", "card_holder_name": "joseph Doe", "card_cvc": "737" } }, "billing": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San", "state": "California", "zip": "94122", "country": "US", "first_name": "PiX", "last_name": "ss" }, "email": "[email protected]" }, "shipping": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "PiX" } }, "customer_acceptance": { "acceptance_type": "offline", "accepted_at": "1963-05-03T04:07:52.723Z", "online": { "ip_address": "in sit", "user_agent": "amet irure esse" } }, "browser_info": { "user_agent": "Mozilla\/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/70.0.3538.110 Safari\/537.36", "accept_header": "text\/html,application\/xhtml+xml,application\/xml;q=0.9,image\/webp,image\/apng,\/;q=0.8", "language": "nl-NL", "color_depth": 24, "screen_height": 723, "screen_width": 1536, "time_zone": 0, "java_enabled": true, "java_script_enabled": true, "ip_address": "125.0.0.1" }, "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "metadata": { "udf1": "value1", "new_customer": "true", "login_date": "2019-09-10T10:11:12Z" } } ``` ``` { "payment_id": "pay_xrXjk0rlKJG83LNngQ2B", "merchant_id": "merchant_1751293949", "status": "succeeded", "amount": 150000, "net_amount": 150000, "shipping_cost": null, "amount_capturable": 0, "amount_received": 150000, "connector": "adyen", "client_secret": "pay_xrXjk0rlKJG83LNngQ2B_secret_doz5GI9CEnlmcQoBpiNT", "created": "2025-06-30T15:09:44.649Z", "currency": "USD", "customer_id": "cu_1751296185", "customer": { "id": "cu_1751296185", "name": "John Doe", "email": "[email protected]", "phone": "999999999", "phone_country_code": "+1" }, "description": "Its my first payment request", "refunds": null, "disputes": null, "attempts": [ { "attempt_id": "pay_xrXjk0rlKJG83LNngQ2B_1", "status": "charged", "amount": 150000, "order_tax_amount": null, "currency": "USD", "connector": "adyen", "error_message": null, "payment_method": "card", "connector_transaction_id": "KGRXNH7KQZ9TPM75", "capture_method": "automatic", "authentication_type": "no_three_ds", "created_at": "2025-06-30T15:09:44.649Z", "modified_at": "2025-06-30T15:09:45.587Z", "cancellation_reason": null, "mandate_id": null, "error_code": null, "payment_token": null, "connector_metadata": null, "payment_experience": null, "payment_method_type": "debit", "reference_id": "pay_xrXjk0rlKJG83LNngQ2B_1", "unified_code": null, "unified_message": null, "client_source": null, "client_version": null } ], "mandate_id": null, "mandate_data": null, "setup_future_usage": "on_session", "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "card", "payment_method_data": { "card": { "last4": "0335", "card_type": null, "card_network": "Nyce", "card_issuer": null, "card_issuing_country": null, "card_isin": "400003", "card_extended_bin": null, "card_exp_month": "03", "card_exp_year": "2030", "card_holder_name": "joseph Doe", "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "PiX", "last_name": null }, "phone": null, "email": null }, "billing": { "address": { "city": "San", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "PiX", "last_name": "ss" }, "phone": null, "email": "[email protected]" }, "order_details": null, "email": "[email protected]", "name": "John Doe", "phone": "999999999", "return_url": "http://127.0.0.1:4040/", "authentication_type": "no_three_ds", "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "debit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": false, "connector_transaction_id": "KGRXNH7KQZ9TPM75", "frm_message": null, "metadata": { "udf1": "value1", "login_date": "2019-09-10T10:11:12Z", "new_customer": "true" }, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_xrXjk0rlKJG83LNngQ2B_1", "payment_link": null, "profile_id": "pro_0YmTwtjkst9iUDkg4R5D", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_d1x2St1F4pbgEFYNmxOV", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-06-30T15:24:44.649Z", "fingerprint": null, "browser_info": { "language": "nl-NL", "time_zone": 0, "ip_address": "125.0.0.1", "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "color_depth": 24, "java_enabled": true, "screen_width": 1536, "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8", "screen_height": 723, "java_script_enabled": true }, "payment_method_id": "pm_pRJ3v7spaJ1pfIsMlAqD", "payment_method_status": "active", "updated": "2025-06-30T15:09:45.566Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` -> Payment FIlters ``` curl --location 'http://localhost:8080/analytics/v1/org/filters/payments' \ --header 'Accept: /' \ --header 'Accept-Language: en-US,en;q=0.9' \ --header 'Connection: keep-alive' \ --header 'Content-Type: application/json' \ --header 'Origin: http://localhost:9000' \ --header 'Referer: http://localhost:9000/' \ --header 'Sec-Fetch-Dest: empty' \ --header 'Sec-Fetch-Mode: cors' \ --header 'Sec-Fetch-Site: same-site' \ --header 'User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/128.0.0.0 Safari/537.36' \ --header 'api-key: hyperswitch' \ --header 'authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiZTAxZDlhMzgtMDdlMi00ZmFiLTg3ZmYtZWU0NmE2YTU2MDlhIiwibWVyY2hhbnRfaWQiOiJtZXJjaGFudF8xNzUxMjkzOTQ5Iiwicm9sZV9pZCI6Im9yZ19hZG1pbiIsImV4cCI6MTc1MTQ2Njc1MSwib3JnX2lkIjoib3JnX2tOa2k3aXBKS1h4NFc3bGVJU3FQIiwicHJvZmlsZV9pZCI6InByb18wWW1Ud3Rqa3N0OWlVRGtnNFI1RCIsInRlbmFudF9pZCI6InB1YmxpYyJ9.jty5ccBH_Em-odSAlde-FQLMC34aoGdV_UYsJFoUN-w' \ --header 'sec-ch-ua: "Chromium";v="128", "Not;A=Brand";v="24", "Google Chrome";v="128"' \ --header 'sec-ch-ua-mobile: ?0' \ --header 'sec-ch-ua-platform: "macOS"' \ --data '{ "timeRange": { "startTime": "2024-09-03T18:30:00.000Z", "endTime": "2025-09-12T09:22:30.000Z" }, "groupByNames": [ "connector", "payment_method", "payment_method_type", "currency", "authentication_type", "status", "client_source", "client_version", "profile_id", "routing_approach" ], "source": "BATCH", "delta": true }' ``` ``` { "queryData": [ { "dimension": "connector", "values": [ "adyen" ] }, { "dimension": "payment_method", "values": [ "card" ] }, { "dimension": "payment_method_type", "values": [ "debit" ] }, { "dimension": "currency", "values": [ "USD" ] }, { "dimension": "authentication_type", "values": [ "no_three_ds" ] }, { "dimension": "status", "values": [ "charged" ] }, { "dimension": "client_source", "values": [] }, { "dimension": "client_version", "values": [] }, { "dimension": "profile_id", "values": [ "pro_0YmTwtjkst9iUDkg4R5D" ] }, { "dimension": "routing_approach", "values": [ "default_fallback", "debit_routing" ] } ] } ``` -> Payment metric that gives total debit routed txn and savings ``` curl --location 'http://localhost:8080/analytics/v1/org/metrics/payments' \ --header 'Accept: /' \ --header 'Accept-Language: en-US,en;q=0.9' \ --header 'Connection: keep-alive' \ --header 'Content-Type: application/json' \ --header 'Origin: http://localhost:9000' \ --header 'Referer: http://localhost:9000/' \ --header 'Sec-Fetch-Dest: empty' \ --header 'Sec-Fetch-Mode: cors' \ --header 'Sec-Fetch-Site: same-site' \ --header 'User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/128.0.0.0 Safari/537.36' \ --header 'sec-ch-ua: "Chromium";v="128", "Not;A=Brand";v="24", "Google Chrome";v="128"' \ --header 'sec-ch-ua-mobile: ?0' \ --header 'sec-ch-ua-platform: "macOS"' \ --header 'api-key: dev_cW7LmHwdGurYUqCHLMkUX8AfU9uYzKJc6sT0bsAB1wQJFe6lOP01lRO30Dj0WpcH' \ --header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiZTAxZDlhMzgtMDdlMi00ZmFiLTg3ZmYtZWU0NmE2YTU2MDlhIiwibWVyY2hhbnRfaWQiOiJtZXJjaGFudF8xNzUxMjkzOTQ5Iiwicm9sZV9pZCI6Im9yZ19hZG1pbiIsImV4cCI6MTc1MTQ2Njc1MSwib3JnX2lkIjoib3JnX2tOa2k3aXBKS1h4NFc3bGVJU3FQIiwicHJvZmlsZV9pZCI6InByb18wWW1Ud3Rqa3N0OWlVRGtnNFI1RCIsInRlbmFudF9pZCI6InB1YmxpYyJ9.jty5ccBH_Em-odSAlde-FQLMC34aoGdV_UYsJFoUN-w' \ --data '[ { "timeRange": { "startTime": "2025-03-01T18:30:00Z", "endTime": "2025-07-31T09:22:00Z" }, "filters": { "routing_approach": [ "debit_routing" ] }, "source": "BATCH", "metrics": [ "debit_routing" ], "timeSeries": { "granularity": "G_ONEDAY" }, "delta": true } ]' ``` ``` { "queryData": [ { "payment_success_rate": null, "payment_count": null, "payment_success_count": null, "payment_processed_amount": 0, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "debit_routed_transaction_count": 8, "debit_routing_savings": 369, "debit_routing_savings_in_usd": null, "currency": "USD", "status": null, "connector": null, "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": null, "time_range": { "start_time": "2025-06-30T00:00:00.000Z", "end_time": "2025-06-30T23:00:00.000Z" }, "time_bucket": "2025-06-30 00:00:00" } ], "metaData": [ { "total_payment_processed_amount": 0, "total_payment_processed_amount_in_usd": null, "total_payment_processed_amount_without_smart_retries": 0, "total_payment_processed_amount_without_smart_retries_usd": null, "total_payment_processed_count": 0, "total_payment_processed_count_without_smart_retries": 0, "total_failure_reasons_count": 0, "total_failure_reasons_count_without_smart_retries": 0 } ] } ``` -> Payment metrics that gives savings per txn ``` curl --location 'http://localhost:8080/analytics/v1/org/metrics/payments' \ --header 'Accept: /' \ --header 'Accept-Language: en-US,en;q=0.9' \ --header 'Connection: keep-alive' \ --header 'Content-Type: application/json' \ --header 'Origin: http://localhost:9000' \ --header 'Referer: http://localhost:9000/' \ --header 'Sec-Fetch-Dest: empty' \ --header 'Sec-Fetch-Mode: cors' \ --header 'Sec-Fetch-Site: same-site' \ --header 'User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/128.0.0.0 Safari/537.36' \ --header 'sec-ch-ua: "Chromium";v="128", "Not;A=Brand";v="24", "Google Chrome";v="128"' \ --header 'sec-ch-ua-mobile: ?0' \ --header 'sec-ch-ua-platform: "macOS"' \ --header 'api-key: dev_cW7LmHwdGurYUqCHLMkUX8AfU9uYzKJc6sT0bsAB1wQJFe6lOP01lRO30Dj0WpcH' \ --header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiZTAxZDlhMzgtMDdlMi00ZmFiLTg3ZmYtZWU0NmE2YTU2MDlhIiwibWVyY2hhbnRfaWQiOiJtZXJjaGFudF8xNzUxMjkzOTQ5Iiwicm9sZV9pZCI6Im9yZ19hZG1pbiIsImV4cCI6MTc1MTQ2Njc1MSwib3JnX2lkIjoib3JnX2tOa2k3aXBKS1h4NFc3bGVJU3FQIiwicHJvZmlsZV9pZCI6InByb18wWW1Ud3Rqa3N0OWlVRGtnNFI1RCIsInRlbmFudF9pZCI6InB1YmxpYyJ9.jty5ccBH_Em-odSAlde-FQLMC34aoGdV_UYsJFoUN-w' \ --data '[ { "timeRange": { "startTime": "2025-03-01T18:30:00Z", "endTime": "2025-07-31T09:22:00Z" }, "groupByNames": [ "card_network" ], "filters": { "routing_approach": [ "debit_routing" ] }, "source": "BATCH", "metrics": [ "debit_routing" ], "timeSeries": { "granularity": "G_ONEDAY" }, "delta": true } ]' ``` ``` { "queryData": [ { "payment_success_rate": null, "payment_count": null, "payment_success_count": null, "payment_processed_amount": 0, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "debit_routed_transaction_count": 2, "debit_routing_savings": 107, "debit_routing_savings_in_usd": null, "currency": "USD", "status": null, "connector": null, "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": "Star", "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": null, "time_range": { "start_time": "2025-06-30T00:00:00.000Z", "end_time": "2025-06-30T23:00:00.000Z" }, "time_bucket": "2025-06-30 00:00:00" }, { "payment_success_rate": null, "payment_count": null, "payment_success_count": null, "payment_processed_amount": 0, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "debit_routed_transaction_count": 2, "debit_routing_savings": 199, "debit_routing_savings_in_usd": null, "currency": "USD", "status": null, "connector": null, "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": "Nyce", "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": null, "time_range": { "start_time": "2025-06-30T00:00:00.000Z", "end_time": "2025-06-30T23:00:00.000Z" }, "time_bucket": "2025-06-30 00:00:00" }, { "payment_success_rate": null, "payment_count": null, "payment_success_count": null, "payment_processed_amount": 0, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "debit_routed_transaction_count": 3, "debit_routing_savings": 0, "debit_routing_savings_in_usd": null, "currency": "USD", "status": null, "connector": null, "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": "Visa", "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": null, "time_range": { "start_time": "2025-06-30T00:00:00.000Z", "end_time": "2025-06-30T23:00:00.000Z" }, "time_bucket": "2025-06-30 00:00:00" }, { "payment_success_rate": null, "payment_count": null, "payment_success_count": null, "payment_processed_amount": 0, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "debit_routed_transaction_count": 1, "debit_routing_savings": 63, "debit_routing_savings_in_usd": null, "currency": "USD", "status": null, "connector": null, "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": "Accel", "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": null, "time_range": { "start_time": "2025-06-30T00:00:00.000Z", "end_time": "2025-06-30T23:00:00.000Z" }, "time_bucket": "2025-06-30 00:00:00" } ], "metaData": [ { "total_payment_processed_amount": 0, "total_payment_processed_amount_in_usd": null, "total_payment_processed_amount_without_smart_retries": 0, "total_payment_processed_amount_without_smart_retries_usd": null, "total_payment_processed_count": 0, "total_payment_processed_count_without_smart_retries": 0, "total_failure_reasons_count": 0, "total_failure_reasons_count_without_smart_retries": 0 } ] } ``` ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	6678ee351748e5629a22e84677d58297cbac62a5	6678ee351748e5629a22e84677d58297cbac62a5
juspay/hyperswitch	juspay__hyperswitch-8527	Bug: [FEATURE] [CONNECTOR] Payload Integrate a new connector Payload. Developer Docs: https://docs.payload.com Login Dashboard: https://app.payload.com	diff --git a/config/config.example.toml b/config/config.example.toml index 7d072f93e47..54d3fa43be4 100644 --- a/config/config.example.toml +++ b/config/config.example.toml @@ -262,6 +262,7 @@ opennode.base_url = "https://dev-api.opennode.com" paybox.base_url = "https://preprod-ppps.paybox.com/PPPS.php" paybox.secondary_base_url="https://preprod-tpeweb.paybox.com/" payeezy.base_url = "https://api-cert.payeezy.com/" +payload.base_url = "https://api.payload.com" payme.base_url = "https://sandbox.payme.io/" payone.base_url = "https://payment.preprod.payone.com/" paypal.base_url = "https://api-m.sandbox.paypal.com/" diff --git a/config/deployments/integration_test.toml b/config/deployments/integration_test.toml index 568509b8442..b99958aaa13 100644 --- a/config/deployments/integration_test.toml +++ b/config/deployments/integration_test.toml @@ -99,6 +99,7 @@ opennode.base_url = "https://dev-api.opennode.com" paybox.base_url = "https://preprod-ppps.paybox.com/PPPS.php" paybox.secondary_base_url="https://preprod-tpeweb.paybox.com/" payeezy.base_url = "https://api-cert.payeezy.com/" +payload.base_url = "https://api.payload.com" payme.base_url = "https://sandbox.payme.io/" payone.base_url = "https://payment.preprod.payone.com/" paypal.base_url = "https://api-m.sandbox.paypal.com/" diff --git a/config/deployments/production.toml b/config/deployments/production.toml index 499b98fe16c..06e5c94eecb 100644 --- a/config/deployments/production.toml +++ b/config/deployments/production.toml @@ -103,6 +103,7 @@ opennode.base_url = "https://api.opennode.com" paybox.base_url = "https://ppps.paybox.com/PPPS.php" paybox.secondary_base_url="https://tpeweb.paybox.com/" payeezy.base_url = "https://api.payeezy.com/" +payload.base_url = "https://api.payload.com" payme.base_url = "https://live.payme.io/" payone.base_url = "https://payment.payone.com/" paypal.base_url = "https://api-m.paypal.com/" diff --git a/config/deployments/sandbox.toml b/config/deployments/sandbox.toml index 4ca4c787981..93ac9d14c67 100644 --- a/config/deployments/sandbox.toml +++ b/config/deployments/sandbox.toml @@ -103,6 +103,7 @@ opennode.base_url = "https://dev-api.opennode.com" paybox.base_url = "https://preprod-ppps.paybox.com/PPPS.php" paybox.secondary_base_url="https://preprod-tpeweb.paybox.com/" payeezy.base_url = "https://api-cert.payeezy.com/" +payload.base_url = "https://api.payload.com" payme.base_url = "https://sandbox.payme.io/" payone.base_url = "https://payment.preprod.payone.com/" paypal.base_url = "https://api-m.sandbox.paypal.com/" diff --git a/config/development.toml b/config/development.toml index 11d4d8ae7ab..210e7fe22a6 100644 --- a/config/development.toml +++ b/config/development.toml @@ -157,6 +157,7 @@ cards = [ "opennode", "paybox", "payeezy", + "payload", "payme", "payone", "paypal", @@ -297,6 +298,7 @@ opennode.base_url = "https://dev-api.opennode.com" paybox.base_url = "https://preprod-ppps.paybox.com/PPPS.php" paybox.secondary_base_url = "https://preprod-tpeweb.paybox.com/" payeezy.base_url = "https://api-cert.payeezy.com/" +payload.base_url = "https://api.payload.com" payme.base_url = "https://sandbox.payme.io/" payone.base_url = "https://payment.preprod.payone.com/" paypal.base_url = "https://api-m.sandbox.paypal.com/" diff --git a/config/docker_compose.toml b/config/docker_compose.toml index 80a672453ea..e35b85bb18e 100644 --- a/config/docker_compose.toml +++ b/config/docker_compose.toml @@ -188,6 +188,7 @@ opennode.base_url = "https://dev-api.opennode.com" paybox.base_url = "https://preprod-ppps.paybox.com/PPPS.php" paybox.secondary_base_url="https://preprod-tpeweb.paybox.com/" payeezy.base_url = "https://api-cert.payeezy.com/" +payload.base_url = "https://api.payload.com" payme.base_url = "https://sandbox.payme.io/" payone.base_url = "https://payment.preprod.payone.com/" paypal.base_url = "https://api-m.sandbox.paypal.com/" @@ -306,6 +307,7 @@ cards = [ "opennode", "paybox", "payeezy", + "payload", "payme", "payone", "paypal", diff --git a/connector-template/mod.rs b/connector-template/mod.rs index 09ccdf9544e..56b2b5bc18d 100644 --- a/connector-template/mod.rs +++ b/connector-template/mod.rs @@ -593,9 +593,7 @@ impl webhooks::IncomingWebhook for {{project-name \| downcase \| pascal_case}} { } static {{project-name \| upcase}}_SUPPORTED_PAYMENT_METHODS: LazyLock<SupportedPaymentMethods> = - LazyLock::new(\|\| { - SupportedPaymentMethods::new() - }); + LazyLock::new(SupportedPaymentMethods::new); static {{project-name \| upcase}}_CONNECTOR_INFO: ConnectorInfo = ConnectorInfo { display_name: "{{project-name \| downcase \| pascal_case}}", diff --git a/crates/common_enums/src/connector_enums.rs b/crates/common_enums/src/connector_enums.rs index afe83a0f40f..fd145d61488 100644 --- a/crates/common_enums/src/connector_enums.rs +++ b/crates/common_enums/src/connector_enums.rs @@ -121,6 +121,7 @@ pub enum RoutableConnectors { // Payeezy, As psync and rsync are not supported by this connector, it is added as template code for future usage Paybox, Payme, + // Payload, Payone, Paypal, Paystack, @@ -283,6 +284,7 @@ pub enum Connector { Opennode, Paybox, // Payeezy, As psync and rsync are not supported by this connector, it is added as template code for future usage + // Payload, Payme, Payone, Paypal, @@ -457,6 +459,7 @@ impl Connector { \| Self::Nuvei \| Self::Opennode \| Self::Paybox + // \| Self::Payload \| Self::Payme \| Self::Payone \| Self::Paypal @@ -618,6 +621,7 @@ impl From<RoutableConnectors> for Connector { RoutableConnectors::Nuvei => Self::Nuvei, RoutableConnectors::Opennode => Self::Opennode, RoutableConnectors::Paybox => Self::Paybox, + // RoutableConnectors::Paybox => Self::Payload, RoutableConnectors::Payme => Self::Payme, RoutableConnectors::Payone => Self::Payone, RoutableConnectors::Paypal => Self::Paypal, @@ -738,6 +742,7 @@ impl TryFrom<Connector> for RoutableConnectors { Connector::Nuvei => Ok(Self::Nuvei), Connector::Opennode => Ok(Self::Opennode), Connector::Paybox => Ok(Self::Paybox), + // Connector::Paybox => Ok(Self::Payload), Connector::Payme => Ok(Self::Payme), Connector::Payone => Ok(Self::Payone), Connector::Paypal => Ok(Self::Paypal), diff --git a/crates/connector_configs/src/connector.rs b/crates/connector_configs/src/connector.rs index abf73e20acc..f82ceecb052 100644 --- a/crates/connector_configs/src/connector.rs +++ b/crates/connector_configs/src/connector.rs @@ -240,6 +240,7 @@ pub struct ConnectorConfig { pub novalnet: Option<ConnectorTomlConfig>, pub nuvei: Option<ConnectorTomlConfig>, pub paybox: Option<ConnectorTomlConfig>, + pub payload: Option<ConnectorTomlConfig>, pub payme: Option<ConnectorTomlConfig>, #[cfg(feature = "payouts")] pub payone_payout: Option<ConnectorTomlConfig>, @@ -429,6 +430,7 @@ impl ConnectorConfig { Connector::Noon => Ok(connector_data.noon), Connector::Nuvei => Ok(connector_data.nuvei), Connector::Paybox => Ok(connector_data.paybox), + // Connector::Payload => Ok(connector_data.payload), Connector::Payme => Ok(connector_data.payme), Connector::Payone => Err("Use get_payout_connector_config".to_string()), Connector::Paypal => Ok(connector_data.paypal), diff --git a/crates/connector_configs/toml/development.toml b/crates/connector_configs/toml/development.toml index 7d304066f91..a5a448fb0a5 100644 --- a/crates/connector_configs/toml/development.toml +++ b/crates/connector_configs/toml/development.toml @@ -6285,4 +6285,26 @@ name="merchant_name" label="Merchant Name" placeholder="Enter the merchant name" required=true -type="Text" \ No newline at end of file +type="Text" + +[payload] +[[payload.credit]] + payment_method_type = "AmericanExpress" +[[payload.credit]] + payment_method_type = "Discover" +[[payload.credit]] + payment_method_type = "Mastercard" +[[payload.credit]] + payment_method_type = "Visa" +[[payload.debit]] + payment_method_type = "AmericanExpress" +[[payload.debit]] + payment_method_type = "Discover" +[[payload.debit]] + payment_method_type = "Mastercard" +[[payload.debit]] + payment_method_type = "Visa" +[payload.connector_auth.HeaderKey] +api_key="API Key" +[payload.connector_webhook_details] +merchant_secret="Source verification key" \ No newline at end of file diff --git a/crates/connector_configs/toml/production.toml b/crates/connector_configs/toml/production.toml index aba744d778c..09f94adbcd2 100644 --- a/crates/connector_configs/toml/production.toml +++ b/crates/connector_configs/toml/production.toml @@ -4890,4 +4890,26 @@ name="merchant_name" label="Merchant Name" placeholder="Enter the merchant name" required=true -type="Text" \ No newline at end of file +type="Text" + +[payload] +[[payload.credit]] + payment_method_type = "AmericanExpress" +[[payload.credit]] + payment_method_type = "Discover" +[[payload.credit]] + payment_method_type = "Mastercard" +[[payload.credit]] + payment_method_type = "Visa" +[[payload.debit]] + payment_method_type = "AmericanExpress" +[[payload.debit]] + payment_method_type = "Discover" +[[payload.debit]] + payment_method_type = "Mastercard" +[[payload.debit]] + payment_method_type = "Visa" +[payload.connector_auth.HeaderKey] +api_key="API Key" +[payload.connector_webhook_details] +merchant_secret="Source verification key" diff --git a/crates/connector_configs/toml/sandbox.toml b/crates/connector_configs/toml/sandbox.toml index b027876614b..bb02a3197fa 100644 --- a/crates/connector_configs/toml/sandbox.toml +++ b/crates/connector_configs/toml/sandbox.toml @@ -6259,4 +6259,26 @@ name="merchant_name" label="Merchant Name" placeholder="Enter the merchant name" required=true -type="Text" \ No newline at end of file +type="Text" + +[payload] +[[payload.credit]] + payment_method_type = "AmericanExpress" +[[payload.credit]] + payment_method_type = "Discover" +[[payload.credit]] + payment_method_type = "Mastercard" +[[payload.credit]] + payment_method_type = "Visa" +[[payload.debit]] + payment_method_type = "AmericanExpress" +[[payload.debit]] + payment_method_type = "Discover" +[[payload.debit]] + payment_method_type = "Mastercard" +[[payload.debit]] + payment_method_type = "Visa" +[payload.connector_auth.HeaderKey] +api_key="API Key" +[payload.connector_webhook_details] +merchant_secret="Source verification key" \ No newline at end of file diff --git a/crates/hyperswitch_connectors/src/connectors.rs b/crates/hyperswitch_connectors/src/connectors.rs index 55f2047a59f..16b56bed6fc 100644 --- a/crates/hyperswitch_connectors/src/connectors.rs +++ b/crates/hyperswitch_connectors/src/connectors.rs @@ -68,6 +68,7 @@ pub mod opayo; pub mod opennode; pub mod paybox; pub mod payeezy; +pub mod payload; pub mod payme; pub mod payone; pub mod paypal; @@ -126,14 +127,15 @@ pub use self::{ juspaythreedsserver::Juspaythreedsserver, klarna::Klarna, mifinity::Mifinity, mollie::Mollie, moneris::Moneris, multisafepay::Multisafepay, netcetera::Netcetera, nexinets::Nexinets, nexixpay::Nexixpay, nmi::Nmi, nomupay::Nomupay, noon::Noon, nordea::Nordea, novalnet::Novalnet, - nuvei::Nuvei, opayo::Opayo, opennode::Opennode, paybox::Paybox, payeezy::Payeezy, payme::Payme, - payone::Payone, paypal::Paypal, paystack::Paystack, payu::Payu, placetopay::Placetopay, - plaid::Plaid, powertranz::Powertranz, prophetpay::Prophetpay, rapyd::Rapyd, razorpay::Razorpay, - recurly::Recurly, redsys::Redsys, riskified::Riskified, santander::Santander, shift4::Shift4, - signifyd::Signifyd, square::Square, stax::Stax, stripe::Stripe, stripebilling::Stripebilling, - taxjar::Taxjar, threedsecureio::Threedsecureio, thunes::Thunes, tokenio::Tokenio, - trustpay::Trustpay, tsys::Tsys, unified_authentication_service::UnifiedAuthenticationService, - vgs::Vgs, volt::Volt, wellsfargo::Wellsfargo, wellsfargopayout::Wellsfargopayout, wise::Wise, - worldline::Worldline, worldpay::Worldpay, worldpayvantiv::Worldpayvantiv, - worldpayxml::Worldpayxml, xendit::Xendit, zen::Zen, zsl::Zsl, + nuvei::Nuvei, opayo::Opayo, opennode::Opennode, paybox::Paybox, payeezy::Payeezy, + payload::Payload, payme::Payme, payone::Payone, paypal::Paypal, paystack::Paystack, payu::Payu, + placetopay::Placetopay, plaid::Plaid, powertranz::Powertranz, prophetpay::Prophetpay, + rapyd::Rapyd, razorpay::Razorpay, recurly::Recurly, redsys::Redsys, riskified::Riskified, + santander::Santander, shift4::Shift4, signifyd::Signifyd, square::Square, stax::Stax, + stripe::Stripe, stripebilling::Stripebilling, taxjar::Taxjar, threedsecureio::Threedsecureio, + thunes::Thunes, tokenio::Tokenio, trustpay::Trustpay, tsys::Tsys, + unified_authentication_service::UnifiedAuthenticationService, vgs::Vgs, volt::Volt, + wellsfargo::Wellsfargo, wellsfargopayout::Wellsfargopayout, wise::Wise, worldline::Worldline, + worldpay::Worldpay, worldpayvantiv::Worldpayvantiv, worldpayxml::Worldpayxml, xendit::Xendit, + zen::Zen, zsl::Zsl, }; diff --git a/crates/hyperswitch_connectors/src/connectors/payload.rs b/crates/hyperswitch_connectors/src/connectors/payload.rs new file mode 100644 index 00000000000..b4d930bf03f --- /dev/null +++ b/crates/hyperswitch_connectors/src/connectors/payload.rs @@ -0,0 +1,619 @@ +pub mod transformers; + +use std::sync::LazyLock; + +use common_enums::enums; +use common_utils::{ + errors::CustomResult, + ext_traits::BytesExt, + request::{Method, Request, RequestBuilder, RequestContent}, + types::{AmountConvertor, StringMinorUnit, StringMinorUnitForConnector}, +}; +use error_stack::{report, ResultExt}; +use hyperswitch_domain_models::{ + payment_method_data::PaymentMethodData, + router_data::{AccessToken, ConnectorAuthType, ErrorResponse, RouterData}, + router_flow_types::{ + access_token_auth::AccessTokenAuth, + payments::{Authorize, Capture, PSync, PaymentMethodToken, Session, SetupMandate, Void}, + refunds::{Execute, RSync}, + }, + router_request_types::{ + AccessTokenRequestData, PaymentMethodTokenizationData, PaymentsAuthorizeData, + PaymentsCancelData, PaymentsCaptureData, PaymentsSessionData, PaymentsSyncData, + RefundsData, SetupMandateRequestData, + }, + router_response_types::{ + ConnectorInfo, PaymentsResponseData, RefundsResponseData, SupportedPaymentMethods, + }, + types::{ + PaymentsAuthorizeRouterData, PaymentsCaptureRouterData, PaymentsSyncRouterData, + RefundSyncRouterData, RefundsRouterData, + }, +}; +use hyperswitch_interfaces::{ + api::{ + self, ConnectorCommon, ConnectorCommonExt, ConnectorIntegration, ConnectorSpecifications, + ConnectorValidation, + }, + configs::Connectors, + errors, + events::connector_api_logs::ConnectorEvent, + types::{self, Response}, + webhooks, +}; +use masking::{ExposeInterface, Mask}; +use transformers as payload; + +use crate::{constants::headers, types::ResponseRouterData, utils}; + +#[derive(Clone)] +pub struct Payload { + amount_converter: &'static (dyn AmountConvertor<Output = StringMinorUnit> + Sync), +} + +impl Payload { + pub fn new() -> &'static Self { + &Self { + amount_converter: &StringMinorUnitForConnector, + } + } +} + +impl api::Payment for Payload {} +impl api::PaymentSession for Payload {} +impl api::ConnectorAccessToken for Payload {} +impl api::MandateSetup for Payload {} +impl api::PaymentAuthorize for Payload {} +impl api::PaymentSync for Payload {} +impl api::PaymentCapture for Payload {} +impl api::PaymentVoid for Payload {} +impl api::Refund for Payload {} +impl api::RefundExecute for Payload {} +impl api::RefundSync for Payload {} +impl api::PaymentToken for Payload {} + +impl ConnectorIntegration<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData> + for Payload +{ + // Not Implemented (R) +} + +impl<Flow, Request, Response> ConnectorCommonExt<Flow, Request, Response> for Payload +where + Self: ConnectorIntegration<Flow, Request, Response>, +{ + fn build_headers( + &self, + req: &RouterData<Flow, Request, Response>, + _connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + let mut header = vec![( + headers::CONTENT_TYPE.to_string(), + self.get_content_type().to_string().into(), + )]; + let mut api_key = self.get_auth_header(&req.connector_auth_type)?; + header.append(&mut api_key); + Ok(header) + } +} + +impl ConnectorCommon for Payload { + fn id(&self) -> &'static str { + "payload" + } + + fn get_currency_unit(&self) -> api::CurrencyUnit { + api::CurrencyUnit::Base + } + + fn common_get_content_type(&self) -> &'static str { + "application/json" + } + + fn base_url<'a>(&self, connectors: &'a Connectors) -> &'a str { + connectors.payload.base_url.as_ref() + } + + fn get_auth_header( + &self, + auth_type: &ConnectorAuthType, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + let auth = payload::PayloadAuthType::try_from(auth_type) + .change_context(errors::ConnectorError::FailedToObtainAuthType)?; + Ok(vec![( + headers::AUTHORIZATION.to_string(), + auth.api_key.expose().into_masked(), + )]) + } + + fn build_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + let response: payload::PayloadErrorResponse = res + .response + .parse_struct("PayloadErrorResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + + Ok(ErrorResponse { + status_code: res.status_code, + code: response.code, + message: response.message, + reason: response.reason, + attempt_status: None, + connector_transaction_id: None, + network_advice_code: None, + network_decline_code: None, + network_error_message: None, + }) + } +} + +impl ConnectorValidation for Payload { + fn validate_mandate_payment( + &self, + _pm_type: Option<enums::PaymentMethodType>, + pm_data: PaymentMethodData, + ) -> CustomResult<(), errors::ConnectorError> { + match pm_data { + PaymentMethodData::Card(_) => Err(errors::ConnectorError::NotImplemented( + "validate_mandate_payment does not support cards".to_string(), + ) + .into()), + _ => Ok(()), + } + } + + fn validate_psync_reference_id( + &self, + _data: &PaymentsSyncData, + _is_three_ds: bool, + _status: enums::AttemptStatus, + _connector_meta_data: Option<common_utils::pii::SecretSerdeValue>, + ) -> CustomResult<(), errors::ConnectorError> { + Ok(()) + } +} + +impl ConnectorIntegration<Session, PaymentsSessionData, PaymentsResponseData> for Payload { + //TODO: implement sessions flow +} + +impl ConnectorIntegration<AccessTokenAuth, AccessTokenRequestData, AccessToken> for Payload {} + +impl ConnectorIntegration<SetupMandate, SetupMandateRequestData, PaymentsResponseData> for Payload {} + +impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData> for Payload { + fn get_headers( + &self, + req: &PaymentsAuthorizeRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsAuthorizeRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn get_request_body( + &self, + req: &PaymentsAuthorizeRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let amount = utils::convert_amount( + self.amount_converter, + req.request.minor_amount, + req.request.currency, + )?; + + let connector_router_data = payload::PayloadRouterData::from((amount, req)); + let connector_req = payload::PayloadPaymentsRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &PaymentsAuthorizeRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::PaymentsAuthorizeType::get_url( + self, req, connectors, + )?) + .attach_default_headers() + .headers(types::PaymentsAuthorizeType::get_headers( + self, req, connectors, + )?) + .set_body(types::PaymentsAuthorizeType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsAuthorizeRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsAuthorizeRouterData, errors::ConnectorError> { + let response: payload::PayloadPaymentsResponse = res + .response + .parse_struct("Payload PaymentsAuthorizeResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<PSync, PaymentsSyncData, PaymentsResponseData> for Payload { + fn get_headers( + &self, + req: &PaymentsSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsSyncRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn build_request( + &self, + req: &PaymentsSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Get) + .url(&types::PaymentsSyncType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::PaymentsSyncType::get_headers(self, req, connectors)?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsSyncRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsSyncRouterData, errors::ConnectorError> { + let response: payload::PayloadPaymentsResponse = res + .response + .parse_struct("payload PaymentsSyncResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<Capture, PaymentsCaptureData, PaymentsResponseData> for Payload { + fn get_headers( + &self, + req: &PaymentsCaptureRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsCaptureRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn get_request_body( + &self, + _req: &PaymentsCaptureRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_request_body method".to_string()).into()) + } + + fn build_request( + &self, + req: &PaymentsCaptureRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::PaymentsCaptureType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::PaymentsCaptureType::get_headers( + self, req, connectors, + )?) + .set_body(types::PaymentsCaptureType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsCaptureRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsCaptureRouterData, errors::ConnectorError> { + let response: payload::PayloadPaymentsResponse = res + .response + .parse_struct("Payload PaymentsCaptureResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<Void, PaymentsCancelData, PaymentsResponseData> for Payload {} + +impl ConnectorIntegration<Execute, RefundsData, RefundsResponseData> for Payload { + fn get_headers( + &self, + req: &RefundsRouterData<Execute>, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &RefundsRouterData<Execute>, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn get_request_body( + &self, + req: &RefundsRouterData<Execute>, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let refund_amount = utils::convert_amount( + self.amount_converter, + req.request.minor_refund_amount, + req.request.currency, + )?; + + let connector_router_data = payload::PayloadRouterData::from((refund_amount, req)); + let connector_req = payload::PayloadRefundRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &RefundsRouterData<Execute>, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + let request = RequestBuilder::new() + .method(Method::Post) + .url(&types::RefundExecuteType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::RefundExecuteType::get_headers( + self, req, connectors, + )?) + .set_body(types::RefundExecuteType::get_request_body( + self, req, connectors, + )?) + .build(); + Ok(Some(request)) + } + + fn handle_response( + &self, + data: &RefundsRouterData<Execute>, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<RefundsRouterData<Execute>, errors::ConnectorError> { + let response: payload::RefundResponse = res + .response + .parse_struct("payload RefundResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<RSync, RefundsData, RefundsResponseData> for Payload { + fn get_headers( + &self, + req: &RefundSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &RefundSyncRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn build_request( + &self, + req: &RefundSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Get) + .url(&types::RefundSyncType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::RefundSyncType::get_headers(self, req, connectors)?) + .set_body(types::RefundSyncType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &RefundSyncRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<RefundSyncRouterData, errors::ConnectorError> { + let response: payload::RefundResponse = res + .response + .parse_struct("payload RefundSyncResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +#[async_trait::async_trait] +impl webhooks::IncomingWebhook for Payload { + fn get_webhook_object_reference_id( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<api_models::webhooks::ObjectReferenceId, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } + + fn get_webhook_event_type( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<api_models::webhooks::IncomingWebhookEvent, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } + + fn get_webhook_resource_object( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<Box<dyn masking::ErasedMaskSerialize>, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } +} + +static PAYLOAD_SUPPORTED_PAYMENT_METHODS: LazyLock<SupportedPaymentMethods> = + LazyLock::new(SupportedPaymentMethods::new); + +static PAYLOAD_CONNECTOR_INFO: ConnectorInfo = ConnectorInfo { + display_name: "Payload", + description: "Payload connector", + connector_type: enums::PaymentConnectorCategory::PaymentGateway, +}; + +static PAYLOAD_SUPPORTED_WEBHOOK_FLOWS: [enums::EventClass; 0] = []; + +impl ConnectorSpecifications for Payload { + fn get_connector_about(&self) -> Option<&'static ConnectorInfo> { + Some(&PAYLOAD_CONNECTOR_INFO) + } + + fn get_supported_payment_methods(&self) -> Option<&'static SupportedPaymentMethods> { + Some(&PAYLOAD_SUPPORTED_PAYMENT_METHODS) + } + + fn get_supported_webhook_flows(&self) -> Option<&'static [enums::EventClass]> { + Some(&PAYLOAD_SUPPORTED_WEBHOOK_FLOWS) + } +} diff --git a/crates/hyperswitch_connectors/src/connectors/payload/transformers.rs b/crates/hyperswitch_connectors/src/connectors/payload/transformers.rs new file mode 100644 index 00000000000..9275cd1a15c --- /dev/null +++ b/crates/hyperswitch_connectors/src/connectors/payload/transformers.rs @@ -0,0 +1,231 @@ +use common_enums::enums; +use common_utils::types::StringMinorUnit; +use hyperswitch_domain_models::{ + payment_method_data::PaymentMethodData, + router_data::{ConnectorAuthType, RouterData}, + router_flow_types::refunds::{Execute, RSync}, + router_request_types::ResponseId, + router_response_types::{PaymentsResponseData, RefundsResponseData}, + types::{PaymentsAuthorizeRouterData, RefundsRouterData}, +}; +use hyperswitch_interfaces::errors; +use masking::Secret; +use serde::{Deserialize, Serialize}; + +use crate::{ + types::{RefundsResponseRouterData, ResponseRouterData}, + utils::PaymentsAuthorizeRequestData, +}; + +//TODO: Fill the struct with respective fields +pub struct PayloadRouterData<T> { + pub amount: StringMinorUnit, // The type of amount that a connector accepts, for example, String, i64, f64, etc. + pub router_data: T, +} + +impl<T> From<(StringMinorUnit, T)> for PayloadRouterData<T> { + fn from((amount, item): (StringMinorUnit, T)) -> Self { + //Todo : use utils to convert the amount to the type of amount that a connector accepts + Self { + amount, + router_data: item, + } + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Serialize, PartialEq)] +pub struct PayloadPaymentsRequest { + amount: StringMinorUnit, + card: PayloadCard, +} + +#[derive(Default, Debug, Serialize, Eq, PartialEq)] +pub struct PayloadCard { + number: cards::CardNumber, + expiry_month: Secret<String>, + expiry_year: Secret<String>, + cvc: Secret<String>, + complete: bool, +} + +impl TryFrom<&PayloadRouterData<&PaymentsAuthorizeRouterData>> for PayloadPaymentsRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: &PayloadRouterData<&PaymentsAuthorizeRouterData>, + ) -> Result<Self, Self::Error> { + match item.router_data.request.payment_method_data.clone() { + PaymentMethodData::Card(req_card) => { + let card = PayloadCard { + number: req_card.card_number, + expiry_month: req_card.card_exp_month, + expiry_year: req_card.card_exp_year, + cvc: req_card.card_cvc, + complete: item.router_data.request.is_auto_capture()?, + }; + Ok(Self { + amount: item.amount.clone(), + card, + }) + } + _ => Err(errors::ConnectorError::NotImplemented("Payment method".to_string()).into()), + } + } +} + +//TODO: Fill the struct with respective fields +// Auth Struct +pub struct PayloadAuthType { + pub(super) api_key: Secret<String>, +} + +impl TryFrom<&ConnectorAuthType> for PayloadAuthType { + 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, Copy, Default, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "lowercase")] +pub enum PayloadPaymentStatus { + Succeeded, + Failed, + #[default] + Processing, +} + +impl From<PayloadPaymentStatus> for common_enums::AttemptStatus { + fn from(item: PayloadPaymentStatus) -> Self { + match item { + PayloadPaymentStatus::Succeeded => Self::Charged, + PayloadPaymentStatus::Failed => Self::Failure, + PayloadPaymentStatus::Processing => Self::Authorizing, + } + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] +pub struct PayloadPaymentsResponse { + status: PayloadPaymentStatus, + id: String, +} + +impl<F, T> TryFrom<ResponseRouterData<F, PayloadPaymentsResponse, T, PaymentsResponseData>> + for RouterData<F, T, PaymentsResponseData> +{ + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: ResponseRouterData<F, PayloadPaymentsResponse, T, PaymentsResponseData>, + ) -> Result<Self, Self::Error> { + Ok(Self { + status: common_enums::AttemptStatus::from(item.response.status), + response: Ok(PaymentsResponseData::TransactionResponse { + resource_id: ResponseId::ConnectorTransactionId(item.response.id), + redirection_data: Box::new(None), + mandate_reference: Box::new(None), + connector_metadata: None, + network_txn_id: None, + connector_response_reference_id: None, + incremental_authorization_allowed: None, + charges: None, + }), + ..item.data + }) + } +} + +//TODO: Fill the struct with respective fields +// REFUND : +// Type definition for RefundRequest +#[derive(Default, Debug, Serialize)] +pub struct PayloadRefundRequest { + pub amount: StringMinorUnit, +} + +impl<F> TryFrom<&PayloadRouterData<&RefundsRouterData<F>>> for PayloadRefundRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from(item: &PayloadRouterData<&RefundsRouterData<F>>) -> Result<Self, Self::Error> { + Ok(Self { + amount: item.amount.to_owned(), + }) + } +} + +// Type definition for Refund Response + +#[allow(dead_code)] +#[derive(Debug, Copy, Serialize, Default, Deserialize, Clone)] +pub enum RefundStatus { + Succeeded, + Failed, + #[default] + Processing, +} + +impl From<RefundStatus> for enums::RefundStatus { + fn from(item: RefundStatus) -> Self { + match item { + RefundStatus::Succeeded => Self::Success, + RefundStatus::Failed => Self::Failure, + RefundStatus::Processing => Self::Pending, + //TODO: Review mapping + } + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Clone, Serialize, Deserialize)] +pub struct RefundResponse { + id: String, + status: RefundStatus, +} + +impl TryFrom<RefundsResponseRouterData<Execute, RefundResponse>> for RefundsRouterData<Execute> { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: RefundsResponseRouterData<Execute, RefundResponse>, + ) -> Result<Self, Self::Error> { + Ok(Self { + response: Ok(RefundsResponseData { + connector_refund_id: item.response.id.to_string(), + refund_status: enums::RefundStatus::from(item.response.status), + }), + ..item.data + }) + } +} + +impl TryFrom<RefundsResponseRouterData<RSync, RefundResponse>> for RefundsRouterData<RSync> { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: RefundsResponseRouterData<RSync, RefundResponse>, + ) -> Result<Self, Self::Error> { + Ok(Self { + response: Ok(RefundsResponseData { + connector_refund_id: item.response.id.to_string(), + refund_status: enums::RefundStatus::from(item.response.status), + }), + ..item.data + }) + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Serialize, Deserialize, PartialEq)] +pub struct PayloadErrorResponse { + pub status_code: u16, + pub code: String, + pub message: String, + pub reason: Option<String>, + pub network_advice_code: Option<String>, + pub network_decline_code: Option<String>, + pub network_error_message: Option<String>, +} diff --git a/crates/hyperswitch_connectors/src/default_implementations.rs b/crates/hyperswitch_connectors/src/default_implementations.rs index 54c5d81edd9..a338b96bc55 100644 --- a/crates/hyperswitch_connectors/src/default_implementations.rs +++ b/crates/hyperswitch_connectors/src/default_implementations.rs @@ -204,6 +204,7 @@ default_imp_for_authorize_session_token!( connectors::Opennode, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Payone, connectors::Paypal, @@ -332,6 +333,7 @@ default_imp_for_calculate_tax!( connectors::Novalnet, connectors::Nuvei, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Payone, connectors::Paypal, @@ -462,6 +464,7 @@ default_imp_for_session_update!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Payone, connectors::Paystack, @@ -586,6 +589,7 @@ default_imp_for_post_session_tokens!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Payone, connectors::Paystack, @@ -708,6 +712,7 @@ default_imp_for_create_order!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Payone, connectors::Paypal, @@ -832,6 +837,7 @@ default_imp_for_update_metadata!( connectors::Nmi, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paystack, connectors::Payu, @@ -940,6 +946,7 @@ default_imp_for_complete_authorize!( connectors::Opayo, connectors::Opennode, connectors::Payeezy, + connectors::Payload, connectors::Payone, connectors::Paystack, connectors::Payu, @@ -1053,6 +1060,7 @@ default_imp_for_incremental_authorization!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Payone, connectors::Paypal, @@ -1179,6 +1187,7 @@ default_imp_for_create_customer!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Payone, connectors::Paypal, @@ -1290,6 +1299,7 @@ default_imp_for_connector_redirect_response!( connectors::Opayo, connectors::Opennode, connectors::Payeezy, + connectors::Payload, connectors::Paystack, connectors::Payone, connectors::Payu, @@ -1398,6 +1408,7 @@ default_imp_for_pre_processing_steps!( connectors::Opennode, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Paystack, connectors::Payone, connectors::Payu, @@ -1518,6 +1529,7 @@ default_imp_for_post_processing_steps!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Payone, connectors::Paypal, @@ -1643,6 +1655,7 @@ default_imp_for_approve!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, @@ -1769,6 +1782,7 @@ default_imp_for_reject!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payone, connectors::Payme, connectors::Paypal, @@ -1896,6 +1910,7 @@ default_imp_for_webhook_source_verification!( connectors::Payone, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paystack, connectors::Payu, @@ -2019,6 +2034,7 @@ default_imp_for_accept_dispute!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Payone, connectors::Paypal, @@ -2143,6 +2159,7 @@ default_imp_for_submit_evidence!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Payone, @@ -2266,6 +2283,7 @@ default_imp_for_defend_dispute!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Payone, connectors::Paypal, @@ -2399,6 +2417,7 @@ default_imp_for_file_upload!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Payone, connectors::Paypal, @@ -2516,6 +2535,7 @@ default_imp_for_payouts!( connectors::Novalnet, connectors::Nuvei, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paystack, connectors::Payu, @@ -2632,6 +2652,7 @@ default_imp_for_payouts_create!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Payone, connectors::Paystack, @@ -2756,6 +2777,7 @@ default_imp_for_payouts_retrieve!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paystack, connectors::Payu, @@ -2880,6 +2902,7 @@ default_imp_for_payouts_eligibility!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, @@ -3002,6 +3025,7 @@ default_imp_for_payouts_fulfill!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paystack, connectors::Payu, @@ -3123,6 +3147,7 @@ default_imp_for_payouts_cancel!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, @@ -3247,6 +3272,7 @@ default_imp_for_payouts_quote!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payone, connectors::Payme, connectors::Paypal, @@ -3372,6 +3398,7 @@ default_imp_for_payouts_recipient!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Payone, connectors::Paypal, @@ -3497,6 +3524,7 @@ default_imp_for_payouts_recipient_account!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Payone, connectors::Paypal, @@ -3624,6 +3652,7 @@ default_imp_for_frm_sale!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Payone, connectors::Paypal, @@ -3750,6 +3779,7 @@ default_imp_for_frm_checkout!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Payone, connectors::Paypal, @@ -3876,6 +3906,7 @@ default_imp_for_frm_transaction!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Payone, connectors::Paypal, @@ -4003,6 +4034,7 @@ default_imp_for_frm_fulfillment!( connectors::Payone, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, @@ -4128,6 +4160,7 @@ default_imp_for_frm_record_return!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Payone, connectors::Paypal, @@ -4248,6 +4281,7 @@ default_imp_for_revoking_mandates!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Payone, connectors::Paypal, @@ -4371,6 +4405,7 @@ default_imp_for_uas_pre_authentication!( connectors::Opennode, connectors::Nuvei, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Payone, connectors::Paypal, @@ -4494,6 +4529,7 @@ default_imp_for_uas_post_authentication!( connectors::Opennode, connectors::Nuvei, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Payone, connectors::Paypal, @@ -4618,6 +4654,7 @@ default_imp_for_uas_authentication_confirmation!( connectors::Opennode, connectors::Nuvei, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Payone, connectors::Paystack, @@ -4733,6 +4770,7 @@ default_imp_for_connector_request_id!( connectors::Opayo, connectors::Opennode, connectors::Payeezy, + connectors::Payload, connectors::Paystack, connectors::Payu, connectors::Payme, @@ -4852,6 +4890,7 @@ default_imp_for_fraud_check!( connectors::Nuvei, connectors::Opayo, connectors::Payeezy, + connectors::Payload, connectors::Paystack, connectors::Paypal, connectors::Payu, @@ -4999,6 +5038,7 @@ default_imp_for_connector_authentication!( connectors::Opayo, connectors::Opennode, connectors::Payeezy, + connectors::Payload, connectors::Paystack, connectors::Payu, connectors::Payone, @@ -5118,6 +5158,7 @@ default_imp_for_uas_authentication!( connectors::Nexixpay, connectors::Nuvei, connectors::Payeezy, + connectors::Payload, connectors::Paypal, connectors::Paystack, connectors::Payu, @@ -5238,6 +5279,7 @@ default_imp_for_revenue_recovery!( connectors::Opayo, connectors::Opennode, connectors::Payeezy, + connectors::Payload, connectors::Paystack, connectors::Payu, connectors::Paypal, @@ -5365,6 +5407,7 @@ default_imp_for_billing_connector_payment_sync!( connectors::Opayo, connectors::Opennode, connectors::Payeezy, + connectors::Payload, connectors::Paystack, connectors::Payu, connectors::Paypal, @@ -5490,6 +5533,7 @@ default_imp_for_revenue_recovery_record_back!( connectors::Opayo, connectors::Opennode, connectors::Payeezy, + connectors::Payload, connectors::Paystack, connectors::Payu, connectors::Paypal, @@ -5615,6 +5659,7 @@ default_imp_for_billing_connector_invoice_sync!( connectors::Opayo, connectors::Opennode, connectors::Payeezy, + connectors::Payload, connectors::Paystack, connectors::Payu, connectors::Paypal, @@ -5734,6 +5779,7 @@ default_imp_for_external_vault!( connectors::Opayo, connectors::Opennode, connectors::Payeezy, + connectors::Payload, connectors::Paystack, connectors::Payu, connectors::Paypal, @@ -5859,6 +5905,7 @@ default_imp_for_external_vault_insert!( connectors::Opayo, connectors::Opennode, connectors::Payeezy, + connectors::Payload, connectors::Paystack, connectors::Payu, connectors::Paypal, @@ -5984,6 +6031,7 @@ default_imp_for_external_vault_retrieve!( connectors::Opayo, connectors::Opennode, connectors::Payeezy, + connectors::Payload, connectors::Paystack, connectors::Payu, connectors::Paypal, @@ -6109,6 +6157,7 @@ default_imp_for_external_vault_delete!( connectors::Opayo, connectors::Opennode, connectors::Payeezy, + connectors::Payload, connectors::Paystack, connectors::Payu, connectors::Paypal, @@ -6233,6 +6282,7 @@ default_imp_for_external_vault_create!( connectors::Opayo, connectors::Opennode, connectors::Payeezy, + connectors::Payload, connectors::Paystack, connectors::Payu, connectors::Paypal, diff --git a/crates/hyperswitch_connectors/src/default_implementations_v2.rs b/crates/hyperswitch_connectors/src/default_implementations_v2.rs index 27c13c9d6be..99685607c48 100644 --- a/crates/hyperswitch_connectors/src/default_implementations_v2.rs +++ b/crates/hyperswitch_connectors/src/default_implementations_v2.rs @@ -312,6 +312,7 @@ default_imp_for_new_connector_integration_payment!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, @@ -438,6 +439,7 @@ default_imp_for_new_connector_integration_refund!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, @@ -559,6 +561,7 @@ default_imp_for_new_connector_integration_connector_access_token!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, @@ -685,6 +688,7 @@ default_imp_for_new_connector_integration_accept_dispute!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, @@ -810,6 +814,7 @@ default_imp_for_new_connector_integration_submit_evidence!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, @@ -936,6 +941,7 @@ default_imp_for_new_connector_integration_defend_dispute!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, @@ -1072,6 +1078,7 @@ default_imp_for_new_connector_integration_file_upload!( connectors::Payone, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, @@ -1200,6 +1207,7 @@ default_imp_for_new_connector_integration_payouts_create!( connectors::Payone, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, @@ -1328,6 +1336,7 @@ default_imp_for_new_connector_integration_payouts_eligibility!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, @@ -1456,6 +1465,7 @@ default_imp_for_new_connector_integration_payouts_fulfill!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, @@ -1584,6 +1594,7 @@ default_imp_for_new_connector_integration_payouts_cancel!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, @@ -1712,6 +1723,7 @@ default_imp_for_new_connector_integration_payouts_quote!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, @@ -1840,6 +1852,7 @@ default_imp_for_new_connector_integration_payouts_recipient!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, @@ -1968,6 +1981,7 @@ default_imp_for_new_connector_integration_payouts_sync!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, @@ -2096,6 +2110,7 @@ default_imp_for_new_connector_integration_payouts_recipient_account!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, @@ -2222,6 +2237,7 @@ default_imp_for_new_connector_integration_webhook_source_verification!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, @@ -2350,6 +2366,7 @@ default_imp_for_new_connector_integration_frm_sale!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, @@ -2478,6 +2495,7 @@ default_imp_for_new_connector_integration_frm_checkout!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, @@ -2606,6 +2624,7 @@ default_imp_for_new_connector_integration_frm_transaction!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, @@ -2734,6 +2753,7 @@ default_imp_for_new_connector_integration_frm_fulfillment!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, @@ -2862,6 +2882,7 @@ default_imp_for_new_connector_integration_frm_record_return!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, @@ -2987,6 +3008,7 @@ default_imp_for_new_connector_integration_revoking_mandates!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paystack, connectors::Payu, @@ -3087,6 +3109,7 @@ default_imp_for_new_connector_integration_frm!( connectors::Payone, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payu, connectors::Placetopay, connectors::Plaid, @@ -3210,6 +3233,7 @@ default_imp_for_new_connector_integration_connector_authentication!( connectors::Nexixpay, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payu, connectors::Placetopay, connectors::Plaid, @@ -3326,6 +3350,7 @@ default_imp_for_new_connector_integration_revenue_recovery!( connectors::Payone, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payu, connectors::Placetopay, connectors::Plaid, @@ -3469,6 +3494,7 @@ default_imp_for_new_connector_integration_external_vault!( connectors::Payone, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, diff --git a/crates/hyperswitch_domain_models/src/configs.rs b/crates/hyperswitch_domain_models/src/configs.rs index f15ea290f56..16fbd3e1d31 100644 --- a/crates/hyperswitch_domain_models/src/configs.rs +++ b/crates/hyperswitch_domain_models/src/configs.rs @@ -83,6 +83,7 @@ pub struct Connectors { pub opennode: ConnectorParams, pub paybox: ConnectorParamsWithSecondaryBaseUrl, pub payeezy: ConnectorParams, + pub payload: ConnectorParams, pub payme: ConnectorParams, pub payone: ConnectorParams, pub paypal: ConnectorParams, diff --git a/crates/router/src/connector.rs b/crates/router/src/connector.rs index af2d9a52352..4b12c47118b 100644 --- a/crates/router/src/connector.rs +++ b/crates/router/src/connector.rs @@ -26,14 +26,14 @@ pub use hyperswitch_connectors::connectors::{ netcetera, netcetera::Netcetera, nexinets, nexinets::Nexinets, nexixpay, nexixpay::Nexixpay, nmi, nmi::Nmi, nomupay, nomupay::Nomupay, noon, noon::Noon, nordea, nordea::Nordea, novalnet, novalnet::Novalnet, nuvei, nuvei::Nuvei, opayo, opayo::Opayo, opennode, opennode::Opennode, - paybox, paybox::Paybox, payeezy, payeezy::Payeezy, payme, payme::Payme, payone, payone::Payone, - paypal, paypal::Paypal, paystack, paystack::Paystack, payu, payu::Payu, placetopay, - placetopay::Placetopay, plaid, plaid::Plaid, powertranz, powertranz::Powertranz, prophetpay, - prophetpay::Prophetpay, rapyd, rapyd::Rapyd, razorpay, razorpay::Razorpay, recurly, - recurly::Recurly, redsys, redsys::Redsys, riskified, riskified::Riskified, santander, - santander::Santander, shift4, shift4::Shift4, signifyd, signifyd::Signifyd, square, - square::Square, stax, stax::Stax, stripe, stripe::Stripe, stripebilling, - stripebilling::Stripebilling, taxjar, taxjar::Taxjar, threedsecureio, + paybox, paybox::Paybox, payeezy, payeezy::Payeezy, payload, payload::Payload, payme, + payme::Payme, payone, payone::Payone, paypal, paypal::Paypal, paystack, paystack::Paystack, + payu, payu::Payu, placetopay, placetopay::Placetopay, plaid, plaid::Plaid, powertranz, + powertranz::Powertranz, prophetpay, prophetpay::Prophetpay, rapyd, rapyd::Rapyd, razorpay, + razorpay::Razorpay, recurly, recurly::Recurly, redsys, redsys::Redsys, riskified, + riskified::Riskified, santander, santander::Santander, shift4, shift4::Shift4, signifyd, + signifyd::Signifyd, square, square::Square, stax, stax::Stax, stripe, stripe::Stripe, + stripebilling, stripebilling::Stripebilling, taxjar, taxjar::Taxjar, threedsecureio, threedsecureio::Threedsecureio, thunes, thunes::Thunes, tokenio, tokenio::Tokenio, trustpay, trustpay::Trustpay, tsys, tsys::Tsys, unified_authentication_service, unified_authentication_service::UnifiedAuthenticationService, vgs, vgs::Vgs, volt, volt::Volt, diff --git a/crates/router/src/core/admin.rs b/crates/router/src/core/admin.rs index 87b51c5ebb9..bf42028cbeb 100644 --- a/crates/router/src/core/admin.rs +++ b/crates/router/src/core/admin.rs @@ -1662,6 +1662,10 @@ impl ConnectorAuthTypeAndMetadataValidation<'_> { paybox::transformers::PayboxAuthType::try_from(self.auth_type)?; Ok(()) } + // api_enums::Connector::Payload => { + // paybox::transformers::PayloadAuthType::try_from(self.auth_type)?; + // Ok(()) + // } api_enums::Connector::Payme => { payme::transformers::PaymeAuthType::try_from(self.auth_type)?; Ok(()) diff --git a/crates/router/src/types/api.rs b/crates/router/src/types/api.rs index f26f8e7ae8d..e48c0268e82 100644 --- a/crates/router/src/types/api.rs +++ b/crates/router/src/types/api.rs @@ -529,6 +529,9 @@ impl ConnectorData { Ok(ConnectorEnum::Old(Box::new(connector::Paybox::new()))) } // "payeezy" => Ok(ConnectorIntegrationEnum::Old(Box::new(&connector::Payeezy)), As psync and rsync are not supported by this connector, it is added as template code for future usage + // enums::Connector::Payload => { + // Ok(ConnectorEnum::Old(Box::new(connector::Paybload::new()))) + // } enums::Connector::Payme => { Ok(ConnectorEnum::Old(Box::new(connector::Payme::new()))) } diff --git a/crates/router/src/types/transformers.rs b/crates/router/src/types/transformers.rs index 82ca2f7ae67..895e1764ad0 100644 --- a/crates/router/src/types/transformers.rs +++ b/crates/router/src/types/transformers.rs @@ -297,6 +297,7 @@ impl ForeignTryFrom<api_enums::Connector> for common_enums::RoutableConnectors { api_enums::Connector::Nuvei => Self::Nuvei, api_enums::Connector::Opennode => Self::Opennode, api_enums::Connector::Paybox => Self::Paybox, + // api_enums::Connector::Payload => Self::Payload, api_enums::Connector::Payme => Self::Payme, api_enums::Connector::Payone => Self::Payone, api_enums::Connector::Paypal => Self::Paypal, diff --git a/crates/router/tests/connectors/main.rs b/crates/router/tests/connectors/main.rs index 8005e84652b..90af2bd8d80 100644 --- a/crates/router/tests/connectors/main.rs +++ b/crates/router/tests/connectors/main.rs @@ -74,6 +74,7 @@ mod opennode; mod paybox; #[cfg(feature = "dummy_connector")] mod payeezy; +mod payload; mod payme; mod payone; mod paypal; diff --git a/crates/router/tests/connectors/payload.rs b/crates/router/tests/connectors/payload.rs new file mode 100644 index 00000000000..fcbff7090eb --- /dev/null +++ b/crates/router/tests/connectors/payload.rs @@ -0,0 +1,420 @@ +use masking::Secret; +use router::types::{self, api, domain, storage::enums}; +use test_utils::connector_auth; + +use crate::utils::{self, ConnectorActions}; + +#[derive(Clone, Copy)] +struct PayloadTest; +impl ConnectorActions for PayloadTest {} +impl utils::Connector for PayloadTest { + fn get_data(&self) -> api::ConnectorData { + use router::connector::Payload; + utils::construct_connector_data_old( + Box::new(Payload::new()), + types::Connector::DummyConnector1, + api::GetToken::Connector, + None, + ) + } + + fn get_auth_token(&self) -> types::ConnectorAuthType { + utils::to_connector_auth_type( + connector_auth::ConnectorAuthentication::new() + .payload + .expect("Missing connector authentication configuration") + .into(), + ) + } + + fn get_name(&self) -> String { + "payload".to_string() + } +} + +static CONNECTOR: PayloadTest = PayloadTest {}; + +fn get_default_payment_info() -> Option<utils::PaymentInfo> { + None +} + +fn payment_method_details() -> Option<types::PaymentsAuthorizeData> { + None +} + +// Cards Positive Tests +// Creates a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_only_authorize_payment() { + let response = CONNECTOR + .authorize_payment(payment_method_details(), get_default_payment_info()) + .await + .expect("Authorize payment response"); + assert_eq!(response.status, enums::AttemptStatus::Authorized); +} + +// Captures a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_capture_authorized_payment() { + let response = CONNECTOR + .authorize_and_capture_payment(payment_method_details(), None, get_default_payment_info()) + .await + .expect("Capture payment response"); + assert_eq!(response.status, enums::AttemptStatus::Charged); +} + +// Partially captures a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_capture_authorized_payment() { + let response = CONNECTOR + .authorize_and_capture_payment( + payment_method_details(), + Some(types::PaymentsCaptureData { + amount_to_capture: 50, + ..utils::PaymentCaptureType::default().0 + }), + get_default_payment_info(), + ) + .await + .expect("Capture payment response"); + assert_eq!(response.status, enums::AttemptStatus::Charged); +} + +// Synchronizes a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_authorized_payment() { + let authorize_response = CONNECTOR + .authorize_payment(payment_method_details(), get_default_payment_info()) + .await + .expect("Authorize payment response"); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + let response = CONNECTOR + .psync_retry_till_status_matches( + enums::AttemptStatus::Authorized, + Some(types::PaymentsSyncData { + connector_transaction_id: types::ResponseId::ConnectorTransactionId( + txn_id.unwrap(), + ), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .expect("PSync response"); + assert_eq!(response.status, enums::AttemptStatus::Authorized,); +} + +// Voids a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_void_authorized_payment() { + let response = CONNECTOR + .authorize_and_void_payment( + payment_method_details(), + Some(types::PaymentsCancelData { + connector_transaction_id: String::from(""), + cancellation_reason: Some("requested_by_customer".to_string()), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .expect("Void payment response"); + assert_eq!(response.status, enums::AttemptStatus::Voided); +} + +// Refunds a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_manually_captured_payment() { + let response = CONNECTOR + .capture_payment_and_refund( + payment_method_details(), + None, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Partially refunds a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_refund_manually_captured_payment() { + let response = CONNECTOR + .capture_payment_and_refund( + payment_method_details(), + None, + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Synchronizes a refund using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_manually_captured_refund() { + let refund_response = CONNECTOR + .capture_payment_and_refund( + payment_method_details(), + None, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + let response = CONNECTOR + .rsync_retry_till_status_matches( + enums::RefundStatus::Success, + refund_response.response.unwrap().connector_refund_id, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Creates a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_make_payment() { + let authorize_response = CONNECTOR + .make_payment(payment_method_details(), get_default_payment_info()) + .await + .unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); +} + +// Synchronizes a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_auto_captured_payment() { + let authorize_response = CONNECTOR + .make_payment(payment_method_details(), get_default_payment_info()) + .await + .unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + assert_ne!(txn_id, None, "Empty connector transaction id"); + let response = CONNECTOR + .psync_retry_till_status_matches( + enums::AttemptStatus::Charged, + Some(types::PaymentsSyncData { + connector_transaction_id: types::ResponseId::ConnectorTransactionId( + txn_id.unwrap(), + ), + capture_method: Some(enums::CaptureMethod::Automatic), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!(response.status, enums::AttemptStatus::Charged,); +} + +// Refunds a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_auto_captured_payment() { + let response = CONNECTOR + .make_payment_and_refund(payment_method_details(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Partially refunds a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_refund_succeeded_payment() { + let refund_response = CONNECTOR + .make_payment_and_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + refund_response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Creates multiple refunds against a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_succeeded_payment_multiple_times() { + CONNECTOR + .make_payment_and_multiple_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await; +} + +// Synchronizes a refund using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_refund() { + let refund_response = CONNECTOR + .make_payment_and_refund(payment_method_details(), None, get_default_payment_info()) + .await + .unwrap(); + let response = CONNECTOR + .rsync_retry_till_status_matches( + enums::RefundStatus::Success, + refund_response.response.unwrap().connector_refund_id, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Cards Negative scenarios +// Creates a payment with incorrect CVC. +#[actix_web::test] +async fn should_fail_payment_for_incorrect_cvc() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: domain::PaymentMethodData::Card(domain::Card { + card_cvc: Secret::new("12345".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's security code is invalid.".to_string(), + ); +} + +// Creates a payment with incorrect expiry month. +#[actix_web::test] +async fn should_fail_payment_for_invalid_exp_month() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: domain::PaymentMethodData::Card(domain::Card { + card_exp_month: Secret::new("20".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's expiration month is invalid.".to_string(), + ); +} + +// Creates a payment with incorrect expiry year. +#[actix_web::test] +async fn should_fail_payment_for_incorrect_expiry_year() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: domain::PaymentMethodData::Card(domain::Card { + card_exp_year: Secret::new("2000".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's expiration year is invalid.".to_string(), + ); +} + +// Voids a payment using automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_fail_void_payment_for_auto_capture() { + let authorize_response = CONNECTOR + .make_payment(payment_method_details(), get_default_payment_info()) + .await + .unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + assert_ne!(txn_id, None, "Empty connector transaction id"); + let void_response = CONNECTOR + .void_payment(txn_id.unwrap(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + void_response.response.unwrap_err().message, + "You cannot cancel this PaymentIntent because it has a status of succeeded." + ); +} + +// Captures a payment using invalid connector payment id. +#[actix_web::test] +async fn should_fail_capture_for_invalid_payment() { + let capture_response = CONNECTOR + .capture_payment("123456789".to_string(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + capture_response.response.unwrap_err().message, + String::from("No such payment_intent: '123456789'") + ); +} + +// Refunds a payment with refund amount higher than payment amount. +#[actix_web::test] +async fn should_fail_for_refund_amount_higher_than_payment_amount() { + let response = CONNECTOR + .make_payment_and_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 150, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Refund amount (₹1.50) is greater than charge amount (₹1.00)", + ); +} + +// Connector dependent test cases goes here + +// [#478]: add unit tests for non 3DS, wallets & webhooks in connector tests diff --git a/crates/router/tests/connectors/sample_auth.toml b/crates/router/tests/connectors/sample_auth.toml index 25c63908448..7d5a742aaf5 100644 --- a/crates/router/tests/connectors/sample_auth.toml +++ b/crates/router/tests/connectors/sample_auth.toml @@ -351,4 +351,7 @@ key1 ="Client Secret" [dwolla] api_key="Client ID" -key1="Client Secret" \ No newline at end of file +key1="Client Secret" + +[payload] +api_key="API Key" \ No newline at end of file diff --git a/crates/test_utils/src/connector_auth.rs b/crates/test_utils/src/connector_auth.rs index c92d4aa8591..fd0f9180910 100644 --- a/crates/test_utils/src/connector_auth.rs +++ b/crates/test_utils/src/connector_auth.rs @@ -80,6 +80,7 @@ pub struct ConnectorAuthentication { pub opennode: Option<HeaderKey>, pub paybox: Option<HeaderKey>, pub payeezy: Option<SignatureKey>, + pub payload: Option<HeaderKey>, pub payme: Option<BodyKey>, pub payone: Option<HeaderKey>, pub paypal: Option<BodyKey>, diff --git a/loadtest/config/development.toml b/loadtest/config/development.toml index 102daf94c6a..02298b9cc44 100644 --- a/loadtest/config/development.toml +++ b/loadtest/config/development.toml @@ -155,6 +155,7 @@ opennode.base_url = "https://dev-api.opennode.com" paybox.base_url = "https://preprod-ppps.paybox.com/PPPS.php" paybox.secondary_base_url = "https://preprod-tpeweb.paybox.com/" payeezy.base_url = "https://api-cert.payeezy.com/" +payload.base_url = "https://api.payload.com" payme.base_url = "https://sandbox.payme.io/" payone.base_url = "https://payment.preprod.payone.com/" paypal.base_url = "https://api-m.sandbox.paypal.com/" @@ -272,6 +273,7 @@ cards = [ "opennode", "paybox", "payeezy", + "payload", "payme", "payone", "paypal", diff --git a/scripts/add_connector.sh b/scripts/add_connector.sh index a76e9beacf9..534c1614a5e 100755 --- a/scripts/add_connector.sh +++ b/scripts/add_connector.sh @@ -6,7 +6,7 @@ function find_prev_connector() { git checkout $self cp $self $self.tmp # Add new connector to existing list and sort it - connectors=(aci adyen adyenplatform airwallex amazonpay applepay archipel authorizedotnet bambora bamboraapac bankofamerica barclaycard billwerk bitpay bluesnap boku braintree cashtocode chargebee checkbook checkout coinbase cryptopay ctp_visa cybersource datatrans deutschebank digitalvirgo dlocal dummyconnector dwolla ebanx elavon facilitapay fiserv fiservemea fiuu forte getnet globalpay globepay gocardless gpayments helcim hipay hyperswitch_vault iatapay inespay itaubank jpmorgan juspaythreedsserver klarna mifinity mollie moneris multisafepay netcetera nexinets nexixpay nomupay noon nordea novalnet nuvei opayo opennode paybox payeezy payme payone paypal paystack payu placetopay plaid powertranz prophetpay rapyd razorpay recurly redsys santander shift4 square stax stripe stripebilling taxjar threedsecureio thunes tokenio trustpay tsys unified_authentication_service vgs volt wellsfargo wellsfargopayout wise worldline worldpay worldpayvantiv worldpayxml xendit zsl "$1") + connectors=(aci adyen adyenplatform airwallex amazonpay applepay archipel authorizedotnet bambora bamboraapac bankofamerica barclaycard billwerk bitpay bluesnap boku braintree cashtocode chargebee checkbook checkout coinbase cryptopay ctp_visa cybersource datatrans deutschebank digitalvirgo dlocal dummyconnector dwolla ebanx elavon facilitapay fiserv fiservemea fiuu forte getnet globalpay globepay gocardless gpayments helcim hipay hyperswitch_vault iatapay inespay itaubank jpmorgan juspaythreedsserver klarna mifinity mollie moneris multisafepay netcetera nexinets nexixpay nomupay noon nordea novalnet nuvei opayo opennode paybox payeezy payload payme payone paypal paystack payu placetopay plaid powertranz prophetpay rapyd razorpay recurly redsys santander shift4 square stax stripe stripebilling taxjar threedsecureio thunes tokenio trustpay tsys unified_authentication_service vgs volt wellsfargo wellsfargopayout wise worldline worldpay worldpayvantiv worldpayxml xendit zsl "$1") IFS=$'\n' sorted=($(sort <<<"${connectors[]}")); unset IFS res="$(echo ${sorted[@]})" sed -i'' -e "s/^ connectors=.*/ connectors=($res \"\$1\")/" $self.tmp @@ -210,4 +210,4 @@ echo "${GREEN}Successfully created connector. Running the tests of $payment_gate # Runs tests for the new connector cargo test --package router --test connectors -- $payment_gateway -echo "${ORANGE}Update your credentials for $payment_gateway connector in crates/router/tests/connectors/sample_auth.toml" \ No newline at end of file +echo "${ORANGE}Update your credentials for $payment_gateway connector in crates/router/tests/connectors/sample_auth.toml"	2025-07-02T07:58:09Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> Connector template code for new connector `Payload`. Check the attached issue for documentation and dashboard. Ref: https://github.com/juspay/hyperswitch/pull/8500 ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> Closes https://github.com/juspay/hyperswitch/issues/8527 ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> This is a template PR for Payload, just checked for compilation. Nothing else to test. ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `just clippy && just clippy_v2` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible <!-- @coderabbitai ignore -->	v1.115.0	f6aab3de0dbb57a7ac44a90e345dd5f00ea998c1	f6aab3de0dbb57a7ac44a90e345dd5f00ea998c1
juspay/hyperswitch	juspay__hyperswitch-8516	Bug: [FEATURE] Add incremental authorization for Paypal, AuthorizeDotNet, Stripe ### Feature Description Add incremental authorization for Paypal, AuthorizeDotNet, Stripe ### Possible Implementation Add incremental authorization for Paypal, AuthorizeDotNet, Stripe ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? Yes, I am willing to submit a PR!	diff --git a/crates/hyperswitch_connectors/src/connectors/helcim.rs b/crates/hyperswitch_connectors/src/connectors/helcim.rs index 05165fbe91b..4845b2cbc7b 100644 --- a/crates/hyperswitch_connectors/src/connectors/helcim.rs +++ b/crates/hyperswitch_connectors/src/connectors/helcim.rs @@ -924,7 +924,7 @@ impl ConnectorTransactionId for Helcim { #[cfg(feature = "v1")] fn connector_transaction_id( &self, - payment_attempt: PaymentAttempt, + payment_attempt: &PaymentAttempt, ) -> Result<Option<String>, ApiErrorResponse> { if payment_attempt.get_connector_payment_id().is_none() { let metadata = @@ -940,7 +940,7 @@ impl ConnectorTransactionId for Helcim { #[cfg(feature = "v2")] fn connector_transaction_id( &self, - payment_attempt: PaymentAttempt, + payment_attempt: &PaymentAttempt, ) -> Result<Option<String>, ApiErrorResponse> { use hyperswitch_domain_models::errors::api_error_response::ApiErrorResponse; diff --git a/crates/hyperswitch_connectors/src/connectors/nexinets.rs b/crates/hyperswitch_connectors/src/connectors/nexinets.rs index 08084973c50..8733bede9c4 100644 --- a/crates/hyperswitch_connectors/src/connectors/nexinets.rs +++ b/crates/hyperswitch_connectors/src/connectors/nexinets.rs @@ -886,7 +886,7 @@ impl ConnectorTransactionId for Nexinets { #[cfg(feature = "v1")] fn connector_transaction_id( &self, - payment_attempt: PaymentAttempt, + payment_attempt: &PaymentAttempt, ) -> Result<Option<String>, ApiErrorResponse> { let metadata = Self::connector_transaction_id(self, payment_attempt.connector_metadata.as_ref()); @@ -896,7 +896,7 @@ impl ConnectorTransactionId for Nexinets { #[cfg(feature = "v2")] fn connector_transaction_id( &self, - payment_attempt: PaymentAttempt, + payment_attempt: &PaymentAttempt, ) -> Result<Option<String>, ApiErrorResponse> { use hyperswitch_domain_models::errors::api_error_response::ApiErrorResponse; diff --git a/crates/hyperswitch_connectors/src/connectors/paypal.rs b/crates/hyperswitch_connectors/src/connectors/paypal.rs index 578baba88b5..f90ac021fb2 100644 --- a/crates/hyperswitch_connectors/src/connectors/paypal.rs +++ b/crates/hyperswitch_connectors/src/connectors/paypal.rs @@ -20,8 +20,8 @@ use hyperswitch_domain_models::{ router_flow_types::{ access_token_auth::AccessTokenAuth, payments::{ - Authorize, Capture, PSync, PaymentMethodToken, PostSessionTokens, PreProcessing, - SdkSessionUpdate, Session, SetupMandate, Void, + Authorize, Capture, IncrementalAuthorization, PSync, PaymentMethodToken, + PostSessionTokens, PreProcessing, SdkSessionUpdate, Session, SetupMandate, Void, }, refunds::{Execute, RSync}, CompleteAuthorize, VerifyWebhookSource, @@ -29,19 +29,19 @@ use hyperswitch_domain_models::{ router_request_types::{ AccessTokenRequestData, CompleteAuthorizeData, PaymentMethodTokenizationData, PaymentsAuthorizeData, PaymentsCancelData, PaymentsCaptureData, - PaymentsPostSessionTokensData, PaymentsPreProcessingData, PaymentsSessionData, - PaymentsSyncData, RefundsData, ResponseId, SdkPaymentsSessionUpdateData, - SetupMandateRequestData, VerifyWebhookSourceRequestData, + PaymentsIncrementalAuthorizationData, PaymentsPostSessionTokensData, + PaymentsPreProcessingData, PaymentsSessionData, PaymentsSyncData, RefundsData, ResponseId, + SdkPaymentsSessionUpdateData, SetupMandateRequestData, VerifyWebhookSourceRequestData, }, router_response_types::{ PaymentsResponseData, RefundsResponseData, VerifyWebhookSourceResponseData, }, types::{ PaymentsAuthorizeRouterData, PaymentsCancelRouterData, PaymentsCaptureRouterData, - PaymentsCompleteAuthorizeRouterData, PaymentsPostSessionTokensRouterData, - PaymentsPreProcessingRouterData, PaymentsSyncRouterData, RefreshTokenRouterData, - RefundSyncRouterData, RefundsRouterData, SdkSessionUpdateRouterData, - SetupMandateRouterData, VerifyWebhookSourceRouterData, + PaymentsCompleteAuthorizeRouterData, PaymentsIncrementalAuthorizationRouterData, + PaymentsPostSessionTokensRouterData, PaymentsPreProcessingRouterData, + PaymentsSyncRouterData, RefreshTokenRouterData, RefundSyncRouterData, RefundsRouterData, + SdkSessionUpdateRouterData, SetupMandateRouterData, VerifyWebhookSourceRouterData, }, }; #[cfg(feature = "payouts")] @@ -55,17 +55,17 @@ use hyperswitch_interfaces::types::{PayoutFulfillType, PayoutSyncType}; use hyperswitch_interfaces::{ api::{ self, ConnectorCommon, ConnectorCommonExt, ConnectorIntegration, ConnectorRedirectResponse, - ConnectorSpecifications, ConnectorValidation, + ConnectorSpecifications, ConnectorValidation, PaymentIncrementalAuthorization, }, configs::Connectors, consts::{NO_ERROR_CODE, NO_ERROR_MESSAGE}, disputes, errors, events::connector_api_logs::ConnectorEvent, types::{ - PaymentsAuthorizeType, PaymentsCaptureType, PaymentsCompleteAuthorizeType, - PaymentsPostSessionTokensType, PaymentsPreProcessingType, PaymentsSyncType, - PaymentsVoidType, RefreshTokenType, RefundExecuteType, RefundSyncType, Response, - SdkSessionUpdateType, SetupMandateType, VerifyWebhookSourceType, + IncrementalAuthorizationType, PaymentsAuthorizeType, PaymentsCaptureType, + PaymentsCompleteAuthorizeType, PaymentsPostSessionTokensType, PaymentsPreProcessingType, + PaymentsSyncType, PaymentsVoidType, RefreshTokenType, RefundExecuteType, RefundSyncType, + Response, SdkSessionUpdateType, SetupMandateType, VerifyWebhookSourceType, }, webhooks::{IncomingWebhook, IncomingWebhookRequestDetails}, }; @@ -73,7 +73,8 @@ use masking::{ExposeInterface, Mask, Maskable, PeekInterface, Secret}; #[cfg(feature = "payouts")] use router_env::{instrument, tracing}; use transformers::{ - self as paypal, auth_headers, PaypalAuthResponse, PaypalMeta, PaypalWebhookEventType, + self as paypal, auth_headers, PaypalAuthResponse, PaypalIncrementalAuthResponse, PaypalMeta, + PaypalWebhookEventType, }; use crate::{ @@ -1105,6 +1106,123 @@ impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData } } +impl PaymentIncrementalAuthorization for Paypal {} + +impl + ConnectorIntegration< + IncrementalAuthorization, + PaymentsIncrementalAuthorizationData, + PaymentsResponseData, + > for Paypal +{ + fn get_headers( + &self, + req: &PaymentsIncrementalAuthorizationRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_http_method(&self) -> Method { + Method::Post + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + req: &PaymentsIncrementalAuthorizationRouterData, + connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + let paypal_meta: PaypalMeta = to_connector_meta(req.request.connector_meta.clone())?; + let incremental_authorization_id = paypal_meta.incremental_authorization_id.ok_or( + errors::ConnectorError::RequestEncodingFailedWithReason( + "Missing incremental authorization id".to_string(), + ), + )?; + Ok(format!( + "{}v2/payments/authorizations/{}/reauthorize", + self.base_url(connectors), + incremental_authorization_id + )) + } + + fn get_request_body( + &self, + req: &PaymentsIncrementalAuthorizationRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let amount = connector_utils::convert_amount( + self.amount_converter, + MinorUnit::new(req.request.total_amount), + req.request.currency, + )?; + let connector_router_data = + paypal::PaypalRouterData::try_from((amount, None, None, None, req))?; + let connector_req = paypal::PaypalIncrementalAuthRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &PaymentsIncrementalAuthorizationRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&IncrementalAuthorizationType::get_url( + self, req, connectors, + )?) + .attach_default_headers() + .headers(IncrementalAuthorizationType::get_headers( + self, req, connectors, + )?) + .set_body(IncrementalAuthorizationType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsIncrementalAuthorizationRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult< + RouterData< + IncrementalAuthorization, + PaymentsIncrementalAuthorizationData, + PaymentsResponseData, + >, + errors::ConnectorError, + > { + let response: PaypalIncrementalAuthResponse = res + .response + .parse_struct("Paypal IncrementalAuthResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + .change_context(errors::ConnectorError::ResponseHandlingFailed) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + impl api::PaymentsPreProcessing for Paypal {} impl ConnectorIntegration<PreProcessing, PaymentsPreProcessingData, PaymentsResponseData> diff --git a/crates/hyperswitch_connectors/src/connectors/paypal/transformers.rs b/crates/hyperswitch_connectors/src/connectors/paypal/transformers.rs index 8cabfcf4663..3814694b08b 100644 --- a/crates/hyperswitch_connectors/src/connectors/paypal/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/paypal/transformers.rs @@ -19,7 +19,8 @@ use hyperswitch_domain_models::{ VerifyWebhookSource, }, router_request_types::{ - PaymentsAuthorizeData, PaymentsPostSessionTokensData, PaymentsSyncData, ResponseId, + CompleteAuthorizeData, PaymentsAuthorizeData, PaymentsIncrementalAuthorizationData, + PaymentsPostSessionTokensData, PaymentsSyncData, ResponseId, VerifyWebhookSourceRequestData, }, router_response_types::{ @@ -28,8 +29,9 @@ use hyperswitch_domain_models::{ }, types::{ PaymentsAuthorizeRouterData, PaymentsCaptureRouterData, - PaymentsPostSessionTokensRouterData, RefreshTokenRouterData, RefundsRouterData, - SdkSessionUpdateRouterData, SetupMandateRouterData, VerifyWebhookSourceRouterData, + PaymentsIncrementalAuthorizationRouterData, PaymentsPostSessionTokensRouterData, + RefreshTokenRouterData, RefundsRouterData, SdkSessionUpdateRouterData, + SetupMandateRouterData, VerifyWebhookSourceRouterData, }, }; #[cfg(feature = "payouts")] @@ -55,6 +57,28 @@ use crate::{ }, }; +trait GetRequestIncrementalAuthorization { + fn get_request_incremental_authorization(&self) -> Option<bool>; +} + +impl GetRequestIncrementalAuthorization for PaymentsAuthorizeData { + fn get_request_incremental_authorization(&self) -> Option<bool> { + Some(self.request_incremental_authorization) + } +} + +impl GetRequestIncrementalAuthorization for CompleteAuthorizeData { + fn get_request_incremental_authorization(&self) -> Option<bool> { + None + } +} + +impl GetRequestIncrementalAuthorization for PaymentsSyncData { + fn get_request_incremental_authorization(&self) -> Option<bool> { + None + } +} + #[derive(Debug, Serialize)] pub struct PaypalRouterData<T> { pub amount: StringMajorUnit, @@ -237,7 +261,7 @@ pub struct PurchaseUnitRequest { items: Vec<ItemDetails>, } -#[derive(Default, Debug, Serialize, Eq, PartialEq)] +#[derive(Default, Debug, Deserialize, Serialize, Eq, PartialEq)] pub struct Payee { merchant_id: Secret<String>, } @@ -1425,6 +1449,119 @@ impl<F, T> TryFrom<ResponseRouterData<F, PaypalAuthUpdateResponse, T, AccessToke } } +#[derive(Debug, Serialize)] +pub struct PaypalIncrementalAuthRequest { + amount: OrderAmount, +} + +impl TryFrom<&PaypalRouterData<&PaymentsIncrementalAuthorizationRouterData>> + for PaypalIncrementalAuthRequest +{ + type Error = error_stack::Report<errors::ConnectorError>; + + fn try_from( + item: &PaypalRouterData<&PaymentsIncrementalAuthorizationRouterData>, + ) -> Result<Self, Self::Error> { + Ok(Self { + amount: OrderAmount { + currency_code: item.router_data.request.currency, + value: item.amount.clone(), + }, + }) + } +} + +#[derive(Debug, Deserialize, Serialize)] +pub struct PaypalIncrementalAuthResponse { + status: PaypalIncrementalStatus, + status_details: PaypalIncrementalAuthStatusDetails, + id: String, + invoice_id: String, + custom_id: String, + links: Vec<PaypalLinks>, + amount: OrderAmount, + network_transaction_reference: PaypalNetworkTransactionReference, + expiration_time: String, + create_time: String, + update_time: String, + supplementary_data: PaypalSupplementaryData, + payee: Payee, + name: Option<String>, + message: Option<String>, +} + +#[derive(Debug, Deserialize, Serialize)] +#[serde(rename_all = "SCREAMING_SNAKE_CASE")] +pub enum PaypalIncrementalStatus { + CREATED, + CAPTURED, + DENIED, + PARTIALLYCAPTURED, + VOIDED, + PENDING, +} + +#[derive(Debug, Deserialize, Serialize)] +pub struct PaypalNetworkTransactionReference { + id: String, +} + +#[derive(Debug, Deserialize, Serialize)] +pub struct PaypalIncrementalAuthStatusDetails { + reason: PaypalStatusPendingReason, +} + +#[derive(Debug, Deserialize, Serialize)] +#[serde(rename_all = "SCREAMING_SNAKE_CASE")] +pub enum PaypalStatusPendingReason { + PENDINGREVIEW, + DECLINEDBYRISKFRAUDFILTERS, +} + +impl From<PaypalIncrementalStatus> for common_enums::AuthorizationStatus { + fn from(item: PaypalIncrementalStatus) -> Self { + match item { + PaypalIncrementalStatus::CREATED + \| PaypalIncrementalStatus::CAPTURED + \| PaypalIncrementalStatus::PARTIALLYCAPTURED => Self::Success, + PaypalIncrementalStatus::PENDING => Self::Processing, + PaypalIncrementalStatus::DENIED \| PaypalIncrementalStatus::VOIDED => Self::Failure, + } + } +} + +impl<F> + TryFrom< + ResponseRouterData< + F, + PaypalIncrementalAuthResponse, + PaymentsIncrementalAuthorizationData, + PaymentsResponseData, + >, + > for RouterData<F, PaymentsIncrementalAuthorizationData, PaymentsResponseData> +{ + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: ResponseRouterData< + F, + PaypalIncrementalAuthResponse, + PaymentsIncrementalAuthorizationData, + PaymentsResponseData, + >, + ) -> Result<Self, Self::Error> { + let status = common_enums::AuthorizationStatus::from(item.response.status); + Ok(Self { + response: Ok(PaymentsResponseData::IncrementalAuthorizationResponse { + status, + error_code: None, + error_message: None, + connector_authorization_id: Some(item.response.id), + }), + ..item.data + }) + } +} + #[derive(Debug)] pub enum PaypalAuthType { TemporaryAuth, @@ -1747,6 +1884,7 @@ pub struct CardDetails { pub struct PaypalMeta { pub authorize_id: Option<String>, pub capture_id: Option<String>, + pub incremental_authorization_id: Option<String>, pub psync_flow: PaypalPaymentIntent, pub next_action: Option<api_models::payments::NextActionCall>, pub order_id: Option<String>, @@ -1782,12 +1920,25 @@ fn get_id_based_on_intent( .ok_or_else(\|\| errors::ConnectorError::MissingConnectorTransactionID.into()) } -impl<F, T> TryFrom<ResponseRouterData<F, PaypalOrdersResponse, T, PaymentsResponseData>> - for RouterData<F, T, PaymentsResponseData> +fn extract_incremental_authorization_id(response: &PaypalOrdersResponse) -> Option<String> { + for unit in &response.purchase_units { + if let Some(authorizations) = &unit.payments.authorizations { + if let Some(first_auth) = authorizations.first() { + return Some(first_auth.id.clone()); + } + } + } + None +} + +impl<F, Req> TryFrom<ResponseRouterData<F, PaypalOrdersResponse, Req, PaymentsResponseData>> + for RouterData<F, Req, PaymentsResponseData> +where + Req: GetRequestIncrementalAuthorization, { type Error = error_stack::Report<errors::ConnectorError>; fn try_from( - item: ResponseRouterData<F, PaypalOrdersResponse, T, PaymentsResponseData>, + item: ResponseRouterData<F, PaypalOrdersResponse, Req, PaymentsResponseData>, ) -> Result<Self, Self::Error> { let purchase_units = item .response @@ -1801,6 +1952,7 @@ impl<F, T> TryFrom<ResponseRouterData<F, PaypalOrdersResponse, T, PaymentsRespon serde_json::json!(PaypalMeta { authorize_id: None, capture_id: Some(id), + incremental_authorization_id: None, psync_flow: item.response.intent.clone(), next_action: None, order_id: None, @@ -1812,6 +1964,9 @@ impl<F, T> TryFrom<ResponseRouterData<F, PaypalOrdersResponse, T, PaymentsRespon serde_json::json!(PaypalMeta { authorize_id: Some(id), capture_id: None, + incremental_authorization_id: extract_incremental_authorization_id( + &item.response + ), psync_flow: item.response.intent.clone(), next_action: None, order_id: None, @@ -1872,7 +2027,10 @@ impl<F, T> TryFrom<ResponseRouterData<F, PaypalOrdersResponse, T, PaymentsRespon .invoice_id .clone() .or(Some(item.response.id)), - incremental_authorization_allowed: None, + incremental_authorization_allowed: item + .data + .request + .get_request_incremental_authorization(), charges: None, }), ..item.data @@ -1965,6 +2123,7 @@ impl<F, T> let connector_meta = serde_json::json!(PaypalMeta { authorize_id: None, capture_id: None, + incremental_authorization_id: None, psync_flow: item.response.intent, next_action, order_id: None, @@ -2017,6 +2176,7 @@ impl let connector_meta = serde_json::json!(PaypalMeta { authorize_id: None, capture_id: None, + incremental_authorization_id: None, psync_flow: item.response.intent, next_action: None, order_id: None, @@ -2072,6 +2232,7 @@ impl let connector_meta = serde_json::json!(PaypalMeta { authorize_id: None, capture_id: None, + incremental_authorization_id: None, psync_flow: item.response.intent, next_action, order_id: Some(item.response.id.clone()), @@ -2144,6 +2305,7 @@ impl<F> let connector_meta = serde_json::json!(PaypalMeta { authorize_id: None, capture_id: None, + incremental_authorization_id: None, psync_flow: PaypalPaymentIntent::Authenticate, // when there is no capture or auth id present next_action: None, order_id: None, @@ -2550,6 +2712,7 @@ impl TryFrom<PaymentsCaptureResponseRouterData<PaypalCaptureResponse>> connector_metadata: Some(serde_json::json!(PaypalMeta { authorize_id: connector_payment_id.authorize_id, capture_id: Some(item.response.id.clone()), + incremental_authorization_id: None, psync_flow: PaypalPaymentIntent::Capture, next_action: None, order_id: None, diff --git a/crates/hyperswitch_connectors/src/default_implementations.rs b/crates/hyperswitch_connectors/src/default_implementations.rs index 38e63124029..bdf3ee5604b 100644 --- a/crates/hyperswitch_connectors/src/default_implementations.rs +++ b/crates/hyperswitch_connectors/src/default_implementations.rs @@ -1086,7 +1086,6 @@ default_imp_for_incremental_authorization!( connectors::Payload, connectors::Payme, connectors::Payone, - connectors::Paypal, connectors::Paystack, connectors::Payu, connectors::Placetopay, diff --git a/crates/hyperswitch_domain_models/src/router_request_types.rs b/crates/hyperswitch_domain_models/src/router_request_types.rs index 31879b4cfe3..fd37b30f6f8 100644 --- a/crates/hyperswitch_domain_models/src/router_request_types.rs +++ b/crates/hyperswitch_domain_models/src/router_request_types.rs @@ -155,6 +155,7 @@ pub struct PaymentsIncrementalAuthorizationData { pub currency: storage_enums::Currency, pub reason: Option<String>, pub connector_transaction_id: String, + pub connector_meta: Option<serde_json::Value>, } #[derive(Debug, Clone, Default)] diff --git a/crates/hyperswitch_interfaces/src/api.rs b/crates/hyperswitch_interfaces/src/api.rs index 4162eb29094..70d1bc2c1b6 100644 --- a/crates/hyperswitch_interfaces/src/api.rs +++ b/crates/hyperswitch_interfaces/src/api.rs @@ -722,7 +722,7 @@ pub trait ConnectorTransactionId: ConnectorCommon + Sync { /// fn connector_transaction_id fn connector_transaction_id( &self, - payment_attempt: hyperswitch_domain_models::payments::payment_attempt::PaymentAttempt, + payment_attempt: &hyperswitch_domain_models::payments::payment_attempt::PaymentAttempt, ) -> Result<Option<String>, ApiErrorResponse> { Ok(payment_attempt .get_connector_payment_id() diff --git a/crates/hyperswitch_interfaces/src/connector_integration_interface.rs b/crates/hyperswitch_interfaces/src/connector_integration_interface.rs index 998df9ec61c..c40c65ac5f7 100644 --- a/crates/hyperswitch_interfaces/src/connector_integration_interface.rs +++ b/crates/hyperswitch_interfaces/src/connector_integration_interface.rs @@ -793,7 +793,7 @@ impl api::ConnectorTransactionId for ConnectorEnum { /// A `Result` containing an optional transaction ID or an ApiErrorResponse fn connector_transaction_id( &self, - payment_attempt: hyperswitch_domain_models::payments::payment_attempt::PaymentAttempt, + payment_attempt: &hyperswitch_domain_models::payments::payment_attempt::PaymentAttempt, ) -> Result<Option<String>, ApiErrorResponse> { match self { Self::Old(connector) => connector.connector_transaction_id(payment_attempt), diff --git a/crates/router/src/core/payments/transformers.rs b/crates/router/src/core/payments/transformers.rs index 2379dddb8fd..1cd67d61f68 100644 --- a/crates/router/src/core/payments/transformers.rs +++ b/crates/router/src/core/payments/transformers.rs @@ -478,7 +478,7 @@ pub async fn construct_payment_router_data_for_capture<'a>( currency: payment_data.payment_intent.amount_details.currency, connector_transaction_id: connector .connector - .connector_transaction_id(payment_data.payment_attempt.clone())? + .connector_transaction_id(&payment_data.payment_attempt)? .ok_or(errors::ApiErrorResponse::ResourceIdNotFound)?, payment_amount: amount.get_amount_as_i64(), // This should be removed once we start moving to connector module minor_payment_amount: amount, @@ -3756,6 +3756,7 @@ impl<F: Clone> TryFrom<PaymentAdditionalData<'_, F>> for types::PaymentsSyncData } } +#[cfg(feature = "v1")] impl<F: Clone> TryFrom<PaymentAdditionalData<'_, F>> for types::PaymentsIncrementalAuthorizationData { @@ -3763,39 +3764,68 @@ impl<F: Clone> TryFrom<PaymentAdditionalData<'_, F>> fn try_from(additional_data: PaymentAdditionalData<'_, F>) -> Result<Self, Self::Error> { let payment_data = additional_data.payment_data; + let payment_attempt = &payment_data.payment_attempt; let connector = api::ConnectorData::get_connector_by_name( &additional_data.state.conf.connectors, &additional_data.connector_name, api::GetToken::Connector, - payment_data.payment_attempt.merchant_connector_id.clone(), + payment_attempt.merchant_connector_id.clone(), )?; - let total_amount = payment_data + let incremental_details = payment_data .incremental_authorization_details - .clone() - .map(\|details\| details.total_amount) + .as_ref() .ok_or( report!(errors::ApiErrorResponse::InternalServerError) .attach_printable("missing incremental_authorization_details in payment_data"), )?; - let additional_amount = payment_data + Ok(Self { + total_amount: incremental_details.total_amount.get_amount_as_i64(), + additional_amount: incremental_details.additional_amount.get_amount_as_i64(), + reason: incremental_details.reason.clone(), + currency: payment_data.currency, + connector_transaction_id: connector + .connector + .connector_transaction_id(payment_attempt)? + .ok_or(errors::ApiErrorResponse::ResourceIdNotFound)?, + connector_meta: payment_attempt.connector_metadata.clone(), + }) + } +} + +#[cfg(feature = "v2")] +impl<F: Clone> TryFrom<PaymentAdditionalData<'_, F>> + for types::PaymentsIncrementalAuthorizationData +{ + type Error = error_stack::Report<errors::ApiErrorResponse>; + + fn try_from(additional_data: PaymentAdditionalData<'_, F>) -> Result<Self, Self::Error> { + let payment_data = additional_data.payment_data; + let connector = api::ConnectorData::get_connector_by_name( + &additional_data.state.conf.connectors, + &additional_data.connector_name, + api::GetToken::Connector, + payment_data.payment_attempt.merchant_connector_id.clone(), + )?; + let incremental_details = payment_data .incremental_authorization_details - .clone() - .map(\|details\| details.additional_amount) + .as_ref() .ok_or( report!(errors::ApiErrorResponse::InternalServerError) .attach_printable("missing incremental_authorization_details in payment_data"), )?; Ok(Self { - total_amount: total_amount.get_amount_as_i64(), - additional_amount: additional_amount.get_amount_as_i64(), - reason: payment_data - .incremental_authorization_details - .and_then(\|details\| details.reason), + total_amount: incremental_details.total_amount.get_amount_as_i64(), + additional_amount: incremental_details.additional_amount.get_amount_as_i64(), + reason: incremental_details.reason.clone(), currency: payment_data.currency, connector_transaction_id: connector .connector - .connector_transaction_id(payment_data.payment_attempt.clone())? + .connector_transaction_id(&payment_data.payment_attempt)? .ok_or(errors::ApiErrorResponse::ResourceIdNotFound)?, + connector_meta: payment_data + .payment_attempt + .connector_metadata + .map(\|secret\| secret.expose()), }) } } @@ -3828,7 +3858,7 @@ impl<F: Clone> TryFrom<PaymentAdditionalData<'_, F>> for types::PaymentsCaptureD currency: payment_data.currency, connector_transaction_id: connector .connector - .connector_transaction_id(payment_data.payment_attempt.clone())? + .connector_transaction_id(&payment_data.payment_attempt)? .ok_or(errors::ApiErrorResponse::ResourceIdNotFound)?, payment_amount: amount.get_amount_as_i64(), // This should be removed once we start moving to connector module minor_payment_amount: amount, @@ -3896,7 +3926,7 @@ impl<F: Clone> TryFrom<PaymentAdditionalData<'_, F>> for types::PaymentsCaptureD currency: payment_data.currency, connector_transaction_id: connector .connector - .connector_transaction_id(payment_data.payment_attempt.clone())? + .connector_transaction_id(&payment_data.payment_attempt)? .ok_or(errors::ApiErrorResponse::ResourceIdNotFound)?, payment_amount: amount.get_amount_as_i64(), // This should be removed once we start moving to connector module minor_payment_amount: amount, @@ -3973,7 +4003,7 @@ impl<F: Clone> TryFrom<PaymentAdditionalData<'_, F>> for types::PaymentsCancelDa currency: Some(payment_data.currency), connector_transaction_id: connector .connector - .connector_transaction_id(payment_data.payment_attempt.clone())? + .connector_transaction_id(&payment_data.payment_attempt)? .ok_or(errors::ApiErrorResponse::ResourceIdNotFound)?, cancellation_reason: payment_data.payment_attempt.cancellation_reason, connector_meta: payment_data.payment_attempt.connector_metadata, @@ -4127,7 +4157,7 @@ impl<F: Clone> TryFrom<PaymentAdditionalData<'_, F>> for types::PaymentsUpdateMe .attach_printable("payment_intent.metadata not found")?, connector_transaction_id: connector .connector - .connector_transaction_id(payment_data.payment_attempt.clone())? + .connector_transaction_id(&payment_data.payment_attempt)? .ok_or(errors::ApiErrorResponse::ResourceIdNotFound)?, }) }	2025-07-01T23:24:24Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD Closes this [issue](https://github.com/juspay/hyperswitch/issues/8516) ## Description <!-- Describe your changes in detail --> Added Incremental Authorization flow for Paypal ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> https://github.com/juspay/hyperswitch/issues/8516 ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> Postman Test Payments - Create: Request: ``` curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_1PzpFzUXX4ZALEpOUNRFMeXyRB2WCZHfhd6AXOKifb7fqVRfrUFQLiqS4DchmszP' \ --data-raw ' { "amount": 1000, "currency": "USD", "confirm": true, "capture_method": "manual", "capture_on": "2022-09-10T10:11:12Z", "amount_to_capture": 1000, "customer_id": "StripeCustomer", "email": "[email protected]", "name": "John Doe", "phone": "999999999", "phone_country_code": "+65", "description": "Its my first payment request", "authentication_type": "no_three_ds", "return_url": "https://duck.com", "billing": { "address": { "first_name": "John", "last_name": "Doe", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "AT" } }, "payment_method": "card", "payment_method_type": "credit", "payment_method_data": { "card": { "card_number": "4111111111111111", "card_exp_month": "11", "card_exp_year": "2030", "card_holder_name": "joseph Doe", "card_cvc": "276" } }, "browser_info": { "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8", "language": "nl-NL", "color_depth": 24, "screen_height": 723, "screen_width": 1536, "time_zone": 0, "java_enabled": true, "java_script_enabled": true, "ip_address": "127.0.0.1" }, "shipping": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "John", "last_name": "Doe" } }, "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "metadata": { "udf1": "value1", "new_customer": "true", "login_date": "2019-09-10T10:11:12Z" }, "request_incremental_authorization": true }' ``` Response: ``` { "payment_id": "pay_1agl8yqCWefEuD7cM9DK", "merchant_id": "merchant_1751411099", "status": "requires_capture", "amount": 1000, "net_amount": 1000, "shipping_cost": null, "amount_capturable": 1000, "amount_received": null, "connector": "paypal", "client_secret": "pay_1agl8yqCWefEuD7cM9DK_secret_iYISlExnoU9wZBlUbA0J", "created": "2025-07-01T23:05:08.941Z", "currency": "USD", "customer_id": "StripeCustomer", "customer": { "id": "StripeCustomer", "name": "John Doe", "email": "[email protected]", "phone": "999999999", "phone_country_code": "+65" }, "description": "Its my first payment request", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "manual", "payment_method": "card", "payment_method_data": { "card": { "last4": "1111", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "411111", "card_extended_bin": null, "card_exp_month": "11", "card_exp_year": "2030", "card_holder_name": "joseph Doe", "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "John", "last_name": "Doe" }, "phone": null, "email": null }, "billing": { "address": { "city": "San Fransico", "country": "AT", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "John", "last_name": "Doe" }, "phone": null, "email": null }, "order_details": null, "email": "[email protected]", "name": "John Doe", "phone": "999999999", "return_url": "https://duck.com/", "authentication_type": "no_three_ds", "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "credit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": { "customer_id": "StripeCustomer", "created_at": 1751411108, "expires": 1751414708, "secret": "epk_dc7e9d0a449a4c28816179c01355a423" }, "manual_retry_allowed": false, "connector_transaction_id": "120066274887", "frm_message": null, "metadata": { "udf1": "value1", "login_date": "2019-09-10T10:11:12Z", "new_customer": "true" }, "connector_metadata": null, "feature_metadata": null, "reference_id": "120066274887", "payment_link": null, "profile_id": "pro_ufQauYhoCJvm3iPPC8mG", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_6BJ52EkitWXtjk3xh9jx", "incremental_authorization_allowed": true, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-07-01T23:20:08.940Z", "fingerprint": null, "browser_info": { "language": "nl-NL", "time_zone": 0, "ip_address": "127.0.0.1", "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "color_depth": 24, "java_enabled": true, "screen_width": 1536, "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8", "screen_height": 723, "java_script_enabled": true }, "payment_method_id": null, "payment_method_status": null, "updated": "2025-07-01T23:05:11.094Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` Incremental Authorization: Request: ``` curl --location 'http://localhost:8080/payments/pay_1agl8yqCWefEuD7cM9DK/incremental_authorization' \ --header 'Content-Type: application/json' \ --header 'api-key: dev_1PzpFzUXX4ZALEpOUNRFMeXyRB2WCZHfhd6AXOKifb7fqVRfrUFQLiqS4DchmszP' \ --data '{ "amount": 6540, "reason": "customer gone overbudget" }' ``` NOTE: The response will return failure status if the payment authorization has not yet surpassed the 4-day threshold. As per Paypal's documentation, a payment becomes eligible for incremental authorization only after the initial authorization is older than 4 days. Response: ``` { "payment_id": "pay_KorlaZqtqUdTrpKtGhwj", "merchant_id": "merchant_1751412204", "status": "requires_capture", "amount": 1050, "net_amount": 1050, "shipping_cost": null, "amount_capturable": 1050, "amount_received": null, "connector": "paypal", "client_secret": "pay_KorlaZqtqUdTrpKtGhwj_secret_JvQWos0QgC06DTMUIUod", "created": "2025-07-01T23:23:32.564Z", "currency": "USD", "customer_id": null, "customer": { "id": null, "name": "John Doe", "email": "[email protected]", "phone": "999999999", "phone_country_code": "+65" }, "description": "Its my first payment request", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "manual", "payment_method": "card", "payment_method_data": { "card": { "last4": "1111", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "411111", "card_extended_bin": null, "card_exp_month": "11", "card_exp_year": "2030", "card_holder_name": "joseph Doe", "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": null, "billing": null, "order_details": null, "email": null, "name": null, "phone": null, "return_url": "https://duck.com/", "authentication_type": "no_three_ds", "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "credit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": false, "connector_transaction_id": "4657001324168371U", "frm_message": null, "metadata": { "udf1": "value1", "login_date": "2019-09-10T10:11:12Z", "new_customer": "true" }, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_KorlaZqtqUdTrpKtGhwj_1", "payment_link": null, "profile_id": "pro_K0AcXOIDkvcyvNd6AU0K", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_frPGdve129UARoghNL0x", "incremental_authorization_allowed": true, "authorization_count": 2, "incremental_authorizations": [ { "authorization_id": "auth_bdKFP2R2zflE7nGe7DSm_1", "amount": 6540, "status": "failure", "error_code": "REAUTHORIZATION_TOO_SOON", "error_message": "REAUTHORIZATION_TOO_SOON", "previously_authorized_amount": 1000 }, { "authorization_id": "auth_fkKGl3yaPor09wvHf7KmS_2", "amount": 1050, "status": "succeeded", "error_code": null, "error_message": null, "previously_authorized_amount": 1000 }, ], "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-07-01T23:38:32.564Z", "fingerprint": null, "browser_info": { "language": "nl-NL", "time_zone": 0, "ip_address": "127.0.0.1", "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "color_depth": 24, "java_enabled": true, "screen_width": 1536, "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8", "screen_height": 723, "java_script_enabled": true }, "payment_method_id": null, "payment_method_status": null, "updated": "2025-07-01T23:23:41.215Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` Cypress Screenshot for Incremental Authorization: <img width="627" height="416" alt="Screenshot 2025-07-14 at 1 34 28 PM" src="https://github.com/user-attachments/assets/b7917284-2f90-484e-b720-162ae28a1b32" /> ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	3c498714e76b400657fc0fc25b7559ca3dca1908	3c498714e76b400657fc0fc25b7559ca3dca1908
juspay/hyperswitch	juspay__hyperswitch-8493	Bug: [FEATURE] [CONNECTOR] Checkbook ### Feature Description Integrate a new connector : Checkbook API Ref: https://docs.checkbook.io/reference/ ### Possible Implementation Integrate a new connector : Checkbook API Ref: https://docs.checkbook.io/reference/ ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? Yes, I am willing to submit a PR!	diff --git a/config/config.example.toml b/config/config.example.toml index c781ec3705b..7d072f93e47 100644 --- a/config/config.example.toml +++ b/config/config.example.toml @@ -203,6 +203,7 @@ boku.base_url = "https://$-api4-stage.boku.com" braintree.base_url = "https://payments.sandbox.braintree-api.com/graphql" cashtocode.base_url = "https://cluster05.api-test.cashtocode.com" chargebee.base_url = "https://$.chargebee.com/api/" +checkbook.base_url = "https://api.sandbox.checkbook.io" checkout.base_url = "https://api.sandbox.checkout.com/" coinbase.base_url = "https://api.commerce.coinbase.com" coingate.base_url = "https://api-sandbox.coingate.com" @@ -344,6 +345,7 @@ cards = [ "coingate", "cryptopay", "braintree", + "checkbook", "checkout", "cybersource", "datatrans", diff --git a/config/deployments/integration_test.toml b/config/deployments/integration_test.toml index 898a84e7db0..2431f89a0ab 100644 --- a/config/deployments/integration_test.toml +++ b/config/deployments/integration_test.toml @@ -42,6 +42,7 @@ boku.base_url = "https://$-api4-stage.boku.com" braintree.base_url = "https://payments.sandbox.braintree-api.com/graphql" cashtocode.base_url = "https://cluster05.api-test.cashtocode.com" chargebee.base_url = "https://$.chargebee.com/api/" +checkbook.base_url = "https://api.sandbox.checkbook.io" checkout.base_url = "https://api.sandbox.checkout.com/" coinbase.base_url = "https://api.commerce.coinbase.com" coingate.base_url = "https://api-sandbox.coingate.com" diff --git a/config/deployments/production.toml b/config/deployments/production.toml index f08bb64136c..2f4e00d1137 100644 --- a/config/deployments/production.toml +++ b/config/deployments/production.toml @@ -46,6 +46,7 @@ boku.base_url = "https://country-api4-stage.boku.com" braintree.base_url = "https://payments.braintree-api.com/graphql" cashtocode.base_url = "https://cluster14.api.cashtocode.com" chargebee.base_url = "https://{{merchant_endpoint_prefix}}.chargebee.com/api/" +checkbook.base_url = "https://api.checkbook.io" checkout.base_url = "https://api.checkout.com/" coinbase.base_url = "https://api.commerce.coinbase.com" coingate.base_url = "https://api.coingate.com" diff --git a/config/deployments/sandbox.toml b/config/deployments/sandbox.toml index e48ddf3ff0b..b05d9d04a82 100644 --- a/config/deployments/sandbox.toml +++ b/config/deployments/sandbox.toml @@ -45,6 +45,7 @@ bluesnap.secondary_base_url = "https://sandpay.bluesnap.com/" boku.base_url = "https://$-api4-stage.boku.com" braintree.base_url = "https://payments.sandbox.braintree-api.com/graphql" cashtocode.base_url = "https://cluster05.api-test.cashtocode.com" +checkbook.base_url = "https://api.sandbox.checkbook.io" checkout.base_url = "https://api.sandbox.checkout.com/" chargebee.base_url = "https://$.chargebee.com/api/" coinbase.base_url = "https://api.commerce.coinbase.com" diff --git a/config/development.toml b/config/development.toml index d340abae6ef..84afa679d11 100644 --- a/config/development.toml +++ b/config/development.toml @@ -109,6 +109,7 @@ cards = [ "bluesnap", "boku", "braintree", + "checkbook", "checkout", "coinbase", "coingate", @@ -237,6 +238,7 @@ boku.base_url = "https://$-api4-stage.boku.com" braintree.base_url = "https://payments.sandbox.braintree-api.com/graphql" cashtocode.base_url = "https://cluster05.api-test.cashtocode.com" chargebee.base_url = "https://$.chargebee.com/api/" +checkbook.base_url = "https://api.sandbox.checkbook.io" checkout.base_url = "https://api.sandbox.checkout.com/" coinbase.base_url = "https://api.commerce.coinbase.com" coingate.base_url = "https://api-sandbox.coingate.com" diff --git a/config/docker_compose.toml b/config/docker_compose.toml index 31ecb58bb6f..80a672453ea 100644 --- a/config/docker_compose.toml +++ b/config/docker_compose.toml @@ -129,6 +129,7 @@ boku.base_url = "https://$-api4-stage.boku.com" braintree.base_url = "https://payments.sandbox.braintree-api.com/graphql" cashtocode.base_url = "https://cluster05.api-test.cashtocode.com" chargebee.base_url = "https://$.chargebee.com/api/" +checkbook.base_url = "https://api.sandbox.checkbook.io" checkout.base_url = "https://api.sandbox.checkout.com/" coinbase.base_url = "https://api.commerce.coinbase.com" coingate.base_url = "https://api-sandbox.coingate.com" @@ -258,6 +259,7 @@ cards = [ "boku", "braintree", "checkout", + "checkbook", "coinbase", "coingate", "cryptopay", diff --git a/crates/common_enums/src/connector_enums.rs b/crates/common_enums/src/connector_enums.rs index 58c627cca84..afe83a0f40f 100644 --- a/crates/common_enums/src/connector_enums.rs +++ b/crates/common_enums/src/connector_enums.rs @@ -75,6 +75,7 @@ pub enum RoutableConnectors { Braintree, Cashtocode, Chargebee, + // Checkbook, Checkout, Coinbase, Coingate, @@ -231,6 +232,7 @@ pub enum Connector { Braintree, Cashtocode, Chargebee, + // Checkbook, Checkout, Coinbase, Coingate, @@ -414,6 +416,7 @@ impl Connector { \| Self::Braintree \| Self::Cashtocode \| Self::Chargebee + // \| Self::Checkbook \| Self::Coinbase \| Self::Coingate \| Self::Cryptopay @@ -575,6 +578,7 @@ impl From<RoutableConnectors> for Connector { RoutableConnectors::Braintree => Self::Braintree, RoutableConnectors::Cashtocode => Self::Cashtocode, RoutableConnectors::Chargebee => Self::Chargebee, + // RoutableConnectors::Checkbook => Self::Checkbook, RoutableConnectors::Checkout => Self::Checkout, RoutableConnectors::Coinbase => Self::Coinbase, RoutableConnectors::Cryptopay => Self::Cryptopay, @@ -694,6 +698,7 @@ impl TryFrom<Connector> for RoutableConnectors { Connector::Braintree => Ok(Self::Braintree), Connector::Cashtocode => Ok(Self::Cashtocode), Connector::Chargebee => Ok(Self::Chargebee), + // Connector::Checkbook => Ok(Self::Checkbook), Connector::Checkout => Ok(Self::Checkout), Connector::Coinbase => Ok(Self::Coinbase), Connector::Coingate => Ok(Self::Coingate), diff --git a/crates/connector_configs/src/connector.rs b/crates/connector_configs/src/connector.rs index 62ad0993f03..abf73e20acc 100644 --- a/crates/connector_configs/src/connector.rs +++ b/crates/connector_configs/src/connector.rs @@ -191,6 +191,7 @@ pub struct ConnectorConfig { pub braintree: Option<ConnectorTomlConfig>, pub cashtocode: Option<ConnectorTomlConfig>, pub chargebee: Option<ConnectorTomlConfig>, + pub checkbook: Option<ConnectorTomlConfig>, pub checkout: Option<ConnectorTomlConfig>, pub coinbase: Option<ConnectorTomlConfig>, pub coingate: Option<ConnectorTomlConfig>, diff --git a/crates/hyperswitch_connectors/src/connectors.rs b/crates/hyperswitch_connectors/src/connectors.rs index 9f1355a1372..55f2047a59f 100644 --- a/crates/hyperswitch_connectors/src/connectors.rs +++ b/crates/hyperswitch_connectors/src/connectors.rs @@ -16,6 +16,7 @@ pub mod boku; pub mod braintree; pub mod cashtocode; pub mod chargebee; +pub mod checkbook; pub mod checkout; pub mod coinbase; pub mod coingate; @@ -114,8 +115,8 @@ pub use self::{ amazonpay::Amazonpay, archipel::Archipel, authorizedotnet::Authorizedotnet, bambora::Bambora, bamboraapac::Bamboraapac, bankofamerica::Bankofamerica, barclaycard::Barclaycard, billwerk::Billwerk, bitpay::Bitpay, bluesnap::Bluesnap, boku::Boku, braintree::Braintree, - cashtocode::Cashtocode, chargebee::Chargebee, checkout::Checkout, coinbase::Coinbase, - coingate::Coingate, cryptopay::Cryptopay, ctp_mastercard::CtpMastercard, + cashtocode::Cashtocode, chargebee::Chargebee, checkbook::Checkbook, checkout::Checkout, + coinbase::Coinbase, coingate::Coingate, cryptopay::Cryptopay, ctp_mastercard::CtpMastercard, cybersource::Cybersource, datatrans::Datatrans, deutschebank::Deutschebank, digitalvirgo::Digitalvirgo, dlocal::Dlocal, dwolla::Dwolla, ebanx::Ebanx, elavon::Elavon, facilitapay::Facilitapay, fiserv::Fiserv, fiservemea::Fiservemea, fiuu::Fiuu, forte::Forte, diff --git a/crates/hyperswitch_connectors/src/connectors/checkbook.rs b/crates/hyperswitch_connectors/src/connectors/checkbook.rs new file mode 100644 index 00000000000..e0f31ceb57f --- /dev/null +++ b/crates/hyperswitch_connectors/src/connectors/checkbook.rs @@ -0,0 +1,571 @@ +pub mod transformers; + +use common_utils::{ + errors::CustomResult, + ext_traits::BytesExt, + request::{Method, Request, RequestBuilder, RequestContent}, + types::{AmountConvertor, FloatMajorUnit, FloatMajorUnitForConnector}, +}; +use error_stack::{report, ResultExt}; +use hyperswitch_domain_models::{ + router_data::{AccessToken, ConnectorAuthType, ErrorResponse, RouterData}, + router_flow_types::{ + access_token_auth::AccessTokenAuth, + payments::{Authorize, Capture, PSync, PaymentMethodToken, Session, SetupMandate, Void}, + refunds::{Execute, RSync}, + }, + router_request_types::{ + AccessTokenRequestData, PaymentMethodTokenizationData, PaymentsAuthorizeData, + PaymentsCancelData, PaymentsCaptureData, PaymentsSessionData, PaymentsSyncData, + RefundsData, SetupMandateRequestData, + }, + router_response_types::{PaymentsResponseData, RefundsResponseData}, + types::{ + PaymentsAuthorizeRouterData, PaymentsCaptureRouterData, PaymentsSyncRouterData, + RefundSyncRouterData, RefundsRouterData, + }, +}; +use hyperswitch_interfaces::{ + api::{ + self, ConnectorCommon, ConnectorCommonExt, ConnectorIntegration, ConnectorSpecifications, + ConnectorValidation, + }, + configs::Connectors, + errors, + events::connector_api_logs::ConnectorEvent, + types::{self, Response}, + webhooks, +}; +use masking::{ExposeInterface, Mask}; +use transformers as checkbook; + +use crate::{constants::headers, types::ResponseRouterData, utils}; + +#[derive(Clone)] +pub struct Checkbook { + amount_converter: &'static (dyn AmountConvertor<Output = FloatMajorUnit> + Sync), +} + +impl Checkbook { + pub fn new() -> &'static Self { + &Self { + amount_converter: &FloatMajorUnitForConnector, + } + } +} + +impl api::Payment for Checkbook {} +impl api::PaymentSession for Checkbook {} +impl api::ConnectorAccessToken for Checkbook {} +impl api::MandateSetup for Checkbook {} +impl api::PaymentAuthorize for Checkbook {} +impl api::PaymentSync for Checkbook {} +impl api::PaymentCapture for Checkbook {} +impl api::PaymentVoid for Checkbook {} +impl api::Refund for Checkbook {} +impl api::RefundExecute for Checkbook {} +impl api::RefundSync for Checkbook {} +impl api::PaymentToken for Checkbook {} + +impl ConnectorIntegration<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData> + for Checkbook +{ + // Not Implemented (R) +} + +impl<Flow, Request, Response> ConnectorCommonExt<Flow, Request, Response> for Checkbook +where + Self: ConnectorIntegration<Flow, Request, Response>, +{ + fn build_headers( + &self, + req: &RouterData<Flow, Request, Response>, + _connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + let mut header = vec![( + headers::CONTENT_TYPE.to_string(), + self.get_content_type().to_string().into(), + )]; + let mut api_key = self.get_auth_header(&req.connector_auth_type)?; + header.append(&mut api_key); + Ok(header) + } +} + +impl ConnectorCommon for Checkbook { + fn id(&self) -> &'static str { + "checkbook" + } + + fn get_currency_unit(&self) -> api::CurrencyUnit { + api::CurrencyUnit::Base + } + + fn common_get_content_type(&self) -> &'static str { + "application/json" + } + + fn base_url<'a>(&self, connectors: &'a Connectors) -> &'a str { + connectors.checkbook.base_url.as_ref() + } + + fn get_auth_header( + &self, + auth_type: &ConnectorAuthType, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + let auth = checkbook::CheckbookAuthType::try_from(auth_type) + .change_context(errors::ConnectorError::FailedToObtainAuthType)?; + Ok(vec![( + headers::AUTHORIZATION.to_string(), + auth.api_key.expose().into_masked(), + )]) + } + + fn build_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + let response: checkbook::CheckbookErrorResponse = res + .response + .parse_struct("CheckbookErrorResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + + Ok(ErrorResponse { + status_code: res.status_code, + code: response.code, + message: response.message, + reason: response.reason, + attempt_status: None, + connector_transaction_id: None, + network_advice_code: None, + network_decline_code: None, + network_error_message: None, + }) + } +} + +impl ConnectorValidation for Checkbook { + //TODO: implement functions when support enabled +} + +impl ConnectorIntegration<Session, PaymentsSessionData, PaymentsResponseData> for Checkbook { + //TODO: implement sessions flow +} + +impl ConnectorIntegration<AccessTokenAuth, AccessTokenRequestData, AccessToken> for Checkbook {} + +impl ConnectorIntegration<SetupMandate, SetupMandateRequestData, PaymentsResponseData> + for Checkbook +{ +} + +impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData> for Checkbook { + fn get_headers( + &self, + req: &PaymentsAuthorizeRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsAuthorizeRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn get_request_body( + &self, + req: &PaymentsAuthorizeRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let amount = utils::convert_amount( + self.amount_converter, + req.request.minor_amount, + req.request.currency, + )?; + + let connector_router_data = checkbook::CheckbookRouterData::from((amount, req)); + let connector_req = checkbook::CheckbookPaymentsRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &PaymentsAuthorizeRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::PaymentsAuthorizeType::get_url( + self, req, connectors, + )?) + .attach_default_headers() + .headers(types::PaymentsAuthorizeType::get_headers( + self, req, connectors, + )?) + .set_body(types::PaymentsAuthorizeType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsAuthorizeRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsAuthorizeRouterData, errors::ConnectorError> { + let response: checkbook::CheckbookPaymentsResponse = res + .response + .parse_struct("Checkbook PaymentsAuthorizeResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<PSync, PaymentsSyncData, PaymentsResponseData> for Checkbook { + fn get_headers( + &self, + req: &PaymentsSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsSyncRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn build_request( + &self, + req: &PaymentsSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Get) + .url(&types::PaymentsSyncType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::PaymentsSyncType::get_headers(self, req, connectors)?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsSyncRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsSyncRouterData, errors::ConnectorError> { + let response: checkbook::CheckbookPaymentsResponse = res + .response + .parse_struct("checkbook PaymentsSyncResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<Capture, PaymentsCaptureData, PaymentsResponseData> for Checkbook { + fn get_headers( + &self, + req: &PaymentsCaptureRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsCaptureRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn get_request_body( + &self, + _req: &PaymentsCaptureRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_request_body method".to_string()).into()) + } + + fn build_request( + &self, + req: &PaymentsCaptureRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::PaymentsCaptureType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::PaymentsCaptureType::get_headers( + self, req, connectors, + )?) + .set_body(types::PaymentsCaptureType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsCaptureRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsCaptureRouterData, errors::ConnectorError> { + let response: checkbook::CheckbookPaymentsResponse = res + .response + .parse_struct("Checkbook PaymentsCaptureResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<Void, PaymentsCancelData, PaymentsResponseData> for Checkbook {} + +impl ConnectorIntegration<Execute, RefundsData, RefundsResponseData> for Checkbook { + fn get_headers( + &self, + req: &RefundsRouterData<Execute>, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &RefundsRouterData<Execute>, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn get_request_body( + &self, + req: &RefundsRouterData<Execute>, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let refund_amount = utils::convert_amount( + self.amount_converter, + req.request.minor_refund_amount, + req.request.currency, + )?; + + let connector_router_data = checkbook::CheckbookRouterData::from((refund_amount, req)); + let connector_req = checkbook::CheckbookRefundRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &RefundsRouterData<Execute>, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + let request = RequestBuilder::new() + .method(Method::Post) + .url(&types::RefundExecuteType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::RefundExecuteType::get_headers( + self, req, connectors, + )?) + .set_body(types::RefundExecuteType::get_request_body( + self, req, connectors, + )?) + .build(); + Ok(Some(request)) + } + + fn handle_response( + &self, + data: &RefundsRouterData<Execute>, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<RefundsRouterData<Execute>, errors::ConnectorError> { + let response: checkbook::RefundResponse = res + .response + .parse_struct("checkbook RefundResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<RSync, RefundsData, RefundsResponseData> for Checkbook { + fn get_headers( + &self, + req: &RefundSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &RefundSyncRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn build_request( + &self, + req: &RefundSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Get) + .url(&types::RefundSyncType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::RefundSyncType::get_headers(self, req, connectors)?) + .set_body(types::RefundSyncType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &RefundSyncRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<RefundSyncRouterData, errors::ConnectorError> { + let response: checkbook::RefundResponse = res + .response + .parse_struct("checkbook RefundSyncResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +#[async_trait::async_trait] +impl webhooks::IncomingWebhook for Checkbook { + fn get_webhook_object_reference_id( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<api_models::webhooks::ObjectReferenceId, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } + + fn get_webhook_event_type( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<api_models::webhooks::IncomingWebhookEvent, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } + + fn get_webhook_resource_object( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<Box<dyn masking::ErasedMaskSerialize>, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } +} + +impl ConnectorSpecifications for Checkbook {} diff --git a/crates/hyperswitch_connectors/src/connectors/checkbook/transformers.rs b/crates/hyperswitch_connectors/src/connectors/checkbook/transformers.rs new file mode 100644 index 00000000000..d9f009f78fe --- /dev/null +++ b/crates/hyperswitch_connectors/src/connectors/checkbook/transformers.rs @@ -0,0 +1,228 @@ +use common_enums::enums; +use common_utils::types::FloatMajorUnit; +use hyperswitch_domain_models::{ + payment_method_data::PaymentMethodData, + router_data::{ConnectorAuthType, RouterData}, + router_flow_types::refunds::{Execute, RSync}, + router_request_types::ResponseId, + router_response_types::{PaymentsResponseData, RefundsResponseData}, + types::{PaymentsAuthorizeRouterData, RefundsRouterData}, +}; +use hyperswitch_interfaces::errors; +use masking::Secret; +use serde::{Deserialize, Serialize}; + +use crate::{ + types::{RefundsResponseRouterData, ResponseRouterData}, + utils::PaymentsAuthorizeRequestData, +}; + +//TODO: Fill the struct with respective fields +pub struct CheckbookRouterData<T> { + pub amount: FloatMajorUnit, // The type of amount that a connector accepts, for example, String, i64, f64, etc. + pub router_data: T, +} + +impl<T> From<(FloatMajorUnit, T)> for CheckbookRouterData<T> { + fn from((amount, item): (FloatMajorUnit, T)) -> Self { + //Todo : use utils to convert the amount to the type of amount that a connector accepts + Self { + amount, + router_data: item, + } + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Serialize, PartialEq)] +pub struct CheckbookPaymentsRequest { + amount: FloatMajorUnit, + card: CheckbookCard, +} + +#[derive(Default, Debug, Serialize, Eq, PartialEq)] +pub struct CheckbookCard { + number: cards::CardNumber, + expiry_month: Secret<String>, + expiry_year: Secret<String>, + cvc: Secret<String>, + complete: bool, +} + +impl TryFrom<&CheckbookRouterData<&PaymentsAuthorizeRouterData>> for CheckbookPaymentsRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: &CheckbookRouterData<&PaymentsAuthorizeRouterData>, + ) -> Result<Self, Self::Error> { + match item.router_data.request.payment_method_data.clone() { + PaymentMethodData::Card(req_card) => { + let card = CheckbookCard { + number: req_card.card_number, + expiry_month: req_card.card_exp_month, + expiry_year: req_card.card_exp_year, + cvc: req_card.card_cvc, + complete: item.router_data.request.is_auto_capture()?, + }; + Ok(Self { + amount: item.amount, + card, + }) + } + _ => Err(errors::ConnectorError::NotImplemented("Payment method".to_string()).into()), + } + } +} + +//TODO: Fill the struct with respective fields +// Auth Struct +pub struct CheckbookAuthType { + pub(super) api_key: Secret<String>, +} + +impl TryFrom<&ConnectorAuthType> for CheckbookAuthType { + 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)] +#[serde(rename_all = "lowercase")] +pub enum CheckbookPaymentStatus { + Succeeded, + Failed, + #[default] + Processing, +} + +impl From<CheckbookPaymentStatus> for common_enums::AttemptStatus { + fn from(item: CheckbookPaymentStatus) -> Self { + match item { + CheckbookPaymentStatus::Succeeded => Self::Charged, + CheckbookPaymentStatus::Failed => Self::Failure, + CheckbookPaymentStatus::Processing => Self::Authorizing, + } + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] +pub struct CheckbookPaymentsResponse { + status: CheckbookPaymentStatus, + id: String, +} + +impl<F, T> TryFrom<ResponseRouterData<F, CheckbookPaymentsResponse, T, PaymentsResponseData>> + for RouterData<F, T, PaymentsResponseData> +{ + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: ResponseRouterData<F, CheckbookPaymentsResponse, T, PaymentsResponseData>, + ) -> Result<Self, Self::Error> { + Ok(Self { + status: common_enums::AttemptStatus::from(item.response.status), + response: Ok(PaymentsResponseData::TransactionResponse { + resource_id: ResponseId::ConnectorTransactionId(item.response.id), + redirection_data: Box::new(None), + mandate_reference: Box::new(None), + connector_metadata: None, + network_txn_id: None, + connector_response_reference_id: None, + incremental_authorization_allowed: None, + charges: None, + }), + ..item.data + }) + } +} + +//TODO: Fill the struct with respective fields +// REFUND : +// Type definition for RefundRequest +#[derive(Default, Debug, Serialize)] +pub struct CheckbookRefundRequest { + pub amount: FloatMajorUnit, +} + +impl<F> TryFrom<&CheckbookRouterData<&RefundsRouterData<F>>> for CheckbookRefundRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from(item: &CheckbookRouterData<&RefundsRouterData<F>>) -> Result<Self, Self::Error> { + Ok(Self { + amount: item.amount.to_owned(), + }) + } +} + +// Type definition for Refund Response + +#[allow(dead_code)] +#[derive(Debug, Serialize, Default, Deserialize, Clone)] +pub enum RefundStatus { + Succeeded, + Failed, + #[default] + Processing, +} + +impl From<RefundStatus> for enums::RefundStatus { + fn from(item: RefundStatus) -> Self { + match item { + RefundStatus::Succeeded => Self::Success, + RefundStatus::Failed => Self::Failure, + RefundStatus::Processing => Self::Pending, + //TODO: Review mapping + } + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Clone, Serialize, Deserialize)] +pub struct RefundResponse { + id: String, + status: RefundStatus, +} + +impl TryFrom<RefundsResponseRouterData<Execute, RefundResponse>> for RefundsRouterData<Execute> { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: RefundsResponseRouterData<Execute, RefundResponse>, + ) -> Result<Self, Self::Error> { + Ok(Self { + response: Ok(RefundsResponseData { + connector_refund_id: item.response.id.to_string(), + refund_status: enums::RefundStatus::from(item.response.status), + }), + ..item.data + }) + } +} + +impl TryFrom<RefundsResponseRouterData<RSync, RefundResponse>> for RefundsRouterData<RSync> { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: RefundsResponseRouterData<RSync, RefundResponse>, + ) -> Result<Self, Self::Error> { + Ok(Self { + response: Ok(RefundsResponseData { + connector_refund_id: item.response.id.to_string(), + refund_status: enums::RefundStatus::from(item.response.status), + }), + ..item.data + }) + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Serialize, Deserialize, PartialEq)] +pub struct CheckbookErrorResponse { + pub status_code: u16, + pub code: String, + pub message: String, + pub reason: Option<String>, +} diff --git a/crates/hyperswitch_connectors/src/default_implementations.rs b/crates/hyperswitch_connectors/src/default_implementations.rs index 6717a25d2ac..54c5d81edd9 100644 --- a/crates/hyperswitch_connectors/src/default_implementations.rs +++ b/crates/hyperswitch_connectors/src/default_implementations.rs @@ -160,6 +160,7 @@ default_imp_for_authorize_session_token!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -282,6 +283,7 @@ default_imp_for_calculate_tax!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -405,6 +407,7 @@ default_imp_for_session_update!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -528,6 +531,7 @@ default_imp_for_post_session_tokens!( connectors::Billwerk, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -650,6 +654,7 @@ default_imp_for_create_order!( connectors::Billwerk, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -773,6 +778,7 @@ default_imp_for_update_metadata!( connectors::Billwerk, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -894,6 +900,7 @@ default_imp_for_complete_authorize!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1002,6 +1009,7 @@ default_imp_for_incremental_authorization!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1125,6 +1133,7 @@ default_imp_for_create_customer!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1242,6 +1251,7 @@ default_imp_for_connector_redirect_response!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, @@ -1348,6 +1358,7 @@ default_imp_for_pre_processing_steps!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1462,6 +1473,7 @@ default_imp_for_post_processing_steps!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1586,6 +1598,7 @@ default_imp_for_approve!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1711,6 +1724,7 @@ default_imp_for_reject!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1836,6 +1850,7 @@ default_imp_for_webhook_source_verification!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1960,6 +1975,7 @@ default_imp_for_accept_dispute!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, @@ -2083,6 +2099,7 @@ default_imp_for_submit_evidence!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, @@ -2205,6 +2222,7 @@ default_imp_for_defend_dispute!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, @@ -2337,6 +2355,7 @@ default_imp_for_file_upload!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, @@ -2451,6 +2470,7 @@ default_imp_for_payouts!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Cryptopay, connectors::Datatrans, @@ -2569,6 +2589,7 @@ default_imp_for_payouts_create!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -2691,6 +2712,7 @@ default_imp_for_payouts_retrieve!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -2815,6 +2837,7 @@ default_imp_for_payouts_eligibility!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -2937,6 +2960,7 @@ default_imp_for_payouts_fulfill!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -3056,6 +3080,7 @@ default_imp_for_payouts_cancel!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -3179,6 +3204,7 @@ default_imp_for_payouts_quote!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -3303,6 +3329,7 @@ default_imp_for_payouts_recipient!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -3426,6 +3453,7 @@ default_imp_for_payouts_recipient_account!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -3551,6 +3579,7 @@ default_imp_for_frm_sale!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -3676,6 +3705,7 @@ default_imp_for_frm_checkout!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -3801,6 +3831,7 @@ default_imp_for_frm_transaction!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -3926,6 +3957,7 @@ default_imp_for_frm_fulfillment!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -4051,6 +4083,7 @@ default_imp_for_frm_record_return!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -4172,6 +4205,7 @@ default_imp_for_revoking_mandates!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -4293,6 +4327,7 @@ default_imp_for_uas_pre_authentication!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -4415,6 +4450,7 @@ default_imp_for_uas_post_authentication!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -4538,6 +4574,7 @@ default_imp_for_uas_authentication_confirmation!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -4653,6 +4690,7 @@ default_imp_for_connector_request_id!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -4770,6 +4808,7 @@ default_imp_for_fraud_check!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -4917,6 +4956,7 @@ default_imp_for_connector_authentication!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -5037,6 +5077,7 @@ default_imp_for_uas_authentication!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -5151,8 +5192,9 @@ default_imp_for_revenue_recovery!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, - connectors::Checkout, connectors::Chargebee, + connectors::Checkbook, + connectors::Checkout, connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, @@ -5278,6 +5320,7 @@ default_imp_for_billing_connector_payment_sync!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -5402,6 +5445,7 @@ default_imp_for_revenue_recovery_record_back!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -5526,6 +5570,7 @@ default_imp_for_billing_connector_invoice_sync!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -5644,6 +5689,7 @@ default_imp_for_external_vault!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -5768,6 +5814,7 @@ default_imp_for_external_vault_insert!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -5892,6 +5939,7 @@ default_imp_for_external_vault_retrieve!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -6016,6 +6064,7 @@ default_imp_for_external_vault_delete!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -6140,6 +6189,7 @@ default_imp_for_external_vault_create!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, diff --git a/crates/hyperswitch_connectors/src/default_implementations_v2.rs b/crates/hyperswitch_connectors/src/default_implementations_v2.rs index 0121aa1d951..27c13c9d6be 100644 --- a/crates/hyperswitch_connectors/src/default_implementations_v2.rs +++ b/crates/hyperswitch_connectors/src/default_implementations_v2.rs @@ -265,6 +265,7 @@ default_imp_for_new_connector_integration_payment!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -390,6 +391,7 @@ default_imp_for_new_connector_integration_refund!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -510,6 +512,7 @@ default_imp_for_new_connector_integration_connector_access_token!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -636,6 +639,7 @@ default_imp_for_new_connector_integration_accept_dispute!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -760,6 +764,7 @@ default_imp_for_new_connector_integration_submit_evidence!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -884,6 +889,7 @@ default_imp_for_new_connector_integration_defend_dispute!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1019,6 +1025,7 @@ default_imp_for_new_connector_integration_file_upload!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1146,6 +1153,7 @@ default_imp_for_new_connector_integration_payouts_create!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1273,6 +1281,7 @@ default_imp_for_new_connector_integration_payouts_eligibility!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1400,6 +1409,7 @@ default_imp_for_new_connector_integration_payouts_fulfill!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1527,6 +1537,7 @@ default_imp_for_new_connector_integration_payouts_cancel!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1654,6 +1665,7 @@ default_imp_for_new_connector_integration_payouts_quote!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1781,6 +1793,7 @@ default_imp_for_new_connector_integration_payouts_recipient!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1908,6 +1921,7 @@ default_imp_for_new_connector_integration_payouts_sync!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -2035,6 +2049,7 @@ default_imp_for_new_connector_integration_payouts_recipient_account!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -2160,6 +2175,7 @@ default_imp_for_new_connector_integration_webhook_source_verification!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -2287,6 +2303,7 @@ default_imp_for_new_connector_integration_frm_sale!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -2414,6 +2431,7 @@ default_imp_for_new_connector_integration_frm_checkout!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -2541,6 +2559,7 @@ default_imp_for_new_connector_integration_frm_transaction!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -2668,6 +2687,7 @@ default_imp_for_new_connector_integration_frm_fulfillment!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -2795,6 +2815,7 @@ default_imp_for_new_connector_integration_frm_record_return!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -2919,6 +2940,7 @@ default_imp_for_new_connector_integration_revoking_mandates!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -3030,6 +3052,7 @@ default_imp_for_new_connector_integration_frm!( connectors::Bluesnap, connectors::Boku, connectors::Cashtocode, + connectors::Checkbook, connectors::Coinbase, connectors::Cryptopay, connectors::CtpMastercard, @@ -3154,6 +3177,7 @@ default_imp_for_new_connector_integration_connector_authentication!( connectors::Bluesnap, connectors::Boku, connectors::Cashtocode, + connectors::Checkbook, connectors::Coinbase, connectors::Cryptopay, connectors::CtpMastercard, @@ -3267,6 +3291,7 @@ default_imp_for_new_connector_integration_revenue_recovery!( connectors::Bluesnap, connectors::Boku, connectors::Cashtocode, + connectors::Checkbook, connectors::Coinbase, connectors::Cryptopay, connectors::CtpMastercard, @@ -3397,6 +3422,7 @@ default_imp_for_new_connector_integration_external_vault!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, diff --git a/crates/hyperswitch_domain_models/src/configs.rs b/crates/hyperswitch_domain_models/src/configs.rs index ab84cf26aa4..f15ea290f56 100644 --- a/crates/hyperswitch_domain_models/src/configs.rs +++ b/crates/hyperswitch_domain_models/src/configs.rs @@ -30,6 +30,7 @@ pub struct Connectors { pub braintree: ConnectorParams, pub cashtocode: ConnectorParams, pub chargebee: ConnectorParams, + pub checkbook: ConnectorParams, pub checkout: ConnectorParams, pub coinbase: ConnectorParams, pub coingate: ConnectorParams, diff --git a/crates/router/src/connector.rs b/crates/router/src/connector.rs index de9eb4f3923..af2d9a52352 100644 --- a/crates/router/src/connector.rs +++ b/crates/router/src/connector.rs @@ -9,30 +9,31 @@ pub use hyperswitch_connectors::connectors::{ bamboraapac::Bamboraapac, bankofamerica, bankofamerica::Bankofamerica, barclaycard, barclaycard::Barclaycard, billwerk, billwerk::Billwerk, bitpay, bitpay::Bitpay, bluesnap, bluesnap::Bluesnap, boku, boku::Boku, braintree, braintree::Braintree, cashtocode, - cashtocode::Cashtocode, chargebee, chargebee::Chargebee, checkout, checkout::Checkout, - coinbase, coinbase::Coinbase, coingate, coingate::Coingate, cryptopay, cryptopay::Cryptopay, - ctp_mastercard, ctp_mastercard::CtpMastercard, cybersource, cybersource::Cybersource, - datatrans, datatrans::Datatrans, deutschebank, deutschebank::Deutschebank, digitalvirgo, - digitalvirgo::Digitalvirgo, dlocal, dlocal::Dlocal, dwolla, dwolla::Dwolla, ebanx, - ebanx::Ebanx, elavon, elavon::Elavon, facilitapay, facilitapay::Facilitapay, fiserv, - fiserv::Fiserv, fiservemea, fiservemea::Fiservemea, fiuu, fiuu::Fiuu, forte, forte::Forte, - getnet, getnet::Getnet, globalpay, globalpay::Globalpay, globepay, globepay::Globepay, - gocardless, gocardless::Gocardless, gpayments, gpayments::Gpayments, helcim, helcim::Helcim, - hipay, hipay::Hipay, hyperswitch_vault, hyperswitch_vault::HyperswitchVault, iatapay, - iatapay::Iatapay, inespay, inespay::Inespay, itaubank, itaubank::Itaubank, jpmorgan, - jpmorgan::Jpmorgan, juspaythreedsserver, juspaythreedsserver::Juspaythreedsserver, klarna, - klarna::Klarna, mifinity, mifinity::Mifinity, mollie, mollie::Mollie, moneris, - moneris::Moneris, multisafepay, multisafepay::Multisafepay, netcetera, netcetera::Netcetera, - nexinets, nexinets::Nexinets, nexixpay, nexixpay::Nexixpay, nmi, nmi::Nmi, nomupay, - nomupay::Nomupay, noon, noon::Noon, nordea, nordea::Nordea, novalnet, novalnet::Novalnet, - nuvei, nuvei::Nuvei, opayo, opayo::Opayo, opennode, opennode::Opennode, paybox, paybox::Paybox, - payeezy, payeezy::Payeezy, payme, payme::Payme, payone, payone::Payone, paypal, paypal::Paypal, - paystack, paystack::Paystack, payu, payu::Payu, placetopay, placetopay::Placetopay, plaid, - plaid::Plaid, powertranz, powertranz::Powertranz, prophetpay, prophetpay::Prophetpay, rapyd, - rapyd::Rapyd, razorpay, razorpay::Razorpay, recurly, recurly::Recurly, redsys, redsys::Redsys, - riskified, riskified::Riskified, santander, santander::Santander, shift4, shift4::Shift4, - signifyd, signifyd::Signifyd, square, square::Square, stax, stax::Stax, stripe, stripe::Stripe, - stripebilling, stripebilling::Stripebilling, taxjar, taxjar::Taxjar, threedsecureio, + cashtocode::Cashtocode, chargebee, chargebee::Chargebee, checkbook, checkbook::Checkbook, + checkout, checkout::Checkout, coinbase, coinbase::Coinbase, coingate, coingate::Coingate, + cryptopay, cryptopay::Cryptopay, ctp_mastercard, ctp_mastercard::CtpMastercard, cybersource, + cybersource::Cybersource, datatrans, datatrans::Datatrans, deutschebank, + deutschebank::Deutschebank, digitalvirgo, digitalvirgo::Digitalvirgo, dlocal, dlocal::Dlocal, + dwolla, dwolla::Dwolla, ebanx, ebanx::Ebanx, elavon, elavon::Elavon, facilitapay, + facilitapay::Facilitapay, fiserv, fiserv::Fiserv, fiservemea, fiservemea::Fiservemea, fiuu, + fiuu::Fiuu, forte, forte::Forte, getnet, getnet::Getnet, globalpay, globalpay::Globalpay, + globepay, globepay::Globepay, gocardless, gocardless::Gocardless, gpayments, + gpayments::Gpayments, helcim, helcim::Helcim, hipay, hipay::Hipay, hyperswitch_vault, + hyperswitch_vault::HyperswitchVault, iatapay, iatapay::Iatapay, inespay, inespay::Inespay, + itaubank, itaubank::Itaubank, jpmorgan, jpmorgan::Jpmorgan, juspaythreedsserver, + juspaythreedsserver::Juspaythreedsserver, klarna, klarna::Klarna, mifinity, mifinity::Mifinity, + mollie, mollie::Mollie, moneris, moneris::Moneris, multisafepay, multisafepay::Multisafepay, + netcetera, netcetera::Netcetera, nexinets, nexinets::Nexinets, nexixpay, nexixpay::Nexixpay, + nmi, nmi::Nmi, nomupay, nomupay::Nomupay, noon, noon::Noon, nordea, nordea::Nordea, novalnet, + novalnet::Novalnet, nuvei, nuvei::Nuvei, opayo, opayo::Opayo, opennode, opennode::Opennode, + paybox, paybox::Paybox, payeezy, payeezy::Payeezy, payme, payme::Payme, payone, payone::Payone, + paypal, paypal::Paypal, paystack, paystack::Paystack, payu, payu::Payu, placetopay, + placetopay::Placetopay, plaid, plaid::Plaid, powertranz, powertranz::Powertranz, prophetpay, + prophetpay::Prophetpay, rapyd, rapyd::Rapyd, razorpay, razorpay::Razorpay, recurly, + recurly::Recurly, redsys, redsys::Redsys, riskified, riskified::Riskified, santander, + santander::Santander, shift4, shift4::Shift4, signifyd, signifyd::Signifyd, square, + square::Square, stax, stax::Stax, stripe, stripe::Stripe, stripebilling, + stripebilling::Stripebilling, taxjar, taxjar::Taxjar, threedsecureio, threedsecureio::Threedsecureio, thunes, thunes::Thunes, tokenio, tokenio::Tokenio, trustpay, trustpay::Trustpay, tsys, tsys::Tsys, unified_authentication_service, unified_authentication_service::UnifiedAuthenticationService, vgs, vgs::Vgs, volt, volt::Volt, diff --git a/crates/router/src/core/admin.rs b/crates/router/src/core/admin.rs index eeb4557daf3..6763bd029b2 100644 --- a/crates/router/src/core/admin.rs +++ b/crates/router/src/core/admin.rs @@ -1456,6 +1456,10 @@ impl ConnectorAuthTypeAndMetadataValidation<'_> { chargebee::transformers::ChargebeeMetadata::try_from(self.connector_meta_data)?; Ok(()) } + // api_enums::Connector::Checkbook => { + // checkbook::transformers::CheckbookAuthType::try_from(self.auth_type)?; + // Ok(()) + // }, api_enums::Connector::Checkout => { checkout::transformers::CheckoutAuthType::try_from(self.auth_type)?; Ok(()) diff --git a/crates/router/src/types/api.rs b/crates/router/src/types/api.rs index e189a0f1a43..f40520a42e7 100644 --- a/crates/router/src/types/api.rs +++ b/crates/router/src/types/api.rs @@ -378,6 +378,9 @@ impl ConnectorData { enums::Connector::Chargebee => { Ok(ConnectorEnum::Old(Box::new(connector::Chargebee::new()))) } + // enums::Connector::Checkbook => { + // Ok(ConnectorEnum::Old(Box::new(connector::Checkbook))) + // } enums::Connector::Checkout => { Ok(ConnectorEnum::Old(Box::new(connector::Checkout::new()))) } diff --git a/crates/router/src/types/transformers.rs b/crates/router/src/types/transformers.rs index ad3d4de7f94..82ca2f7ae67 100644 --- a/crates/router/src/types/transformers.rs +++ b/crates/router/src/types/transformers.rs @@ -224,6 +224,7 @@ impl ForeignTryFrom<api_enums::Connector> for common_enums::RoutableConnectors { api_enums::Connector::Braintree => Self::Braintree, api_enums::Connector::Cashtocode => Self::Cashtocode, api_enums::Connector::Chargebee => Self::Chargebee, + // api_enums::Connector::Checkbook => Self::Checkbook, api_enums::Connector::Checkout => Self::Checkout, api_enums::Connector::Coinbase => Self::Coinbase, api_enums::Connector::Coingate => Self::Coingate, diff --git a/crates/router/tests/connectors/checkbook.rs b/crates/router/tests/connectors/checkbook.rs new file mode 100644 index 00000000000..b6b4252f852 --- /dev/null +++ b/crates/router/tests/connectors/checkbook.rs @@ -0,0 +1,420 @@ +use masking::Secret; +use router::types::{self, api, domain, storage::enums}; +use test_utils::connector_auth; + +use crate::utils::{self, ConnectorActions}; + +#[derive(Clone, Copy)] +struct CheckbookTest; +impl ConnectorActions for CheckbookTest {} +impl utils::Connector for CheckbookTest { + fn get_data(&self) -> api::ConnectorData { + use router::connector::Checkbook; + utils::construct_connector_data_old( + Box::new(Checkbook::new()), + types::Connector::DummyConnector1, + api::GetToken::Connector, + None, + ) + } + + fn get_auth_token(&self) -> types::ConnectorAuthType { + utils::to_connector_auth_type( + connector_auth::ConnectorAuthentication::new() + .checkbook + .expect("Missing connector authentication configuration") + .into(), + ) + } + + fn get_name(&self) -> String { + "checkbook".to_string() + } +} + +static CONNECTOR: CheckbookTest = CheckbookTest {}; + +fn get_default_payment_info() -> Option<utils::PaymentInfo> { + None +} + +fn payment_method_details() -> Option<types::PaymentsAuthorizeData> { + None +} + +// Cards Positive Tests +// Creates a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_only_authorize_payment() { + let response = CONNECTOR + .authorize_payment(payment_method_details(), get_default_payment_info()) + .await + .expect("Authorize payment response"); + assert_eq!(response.status, enums::AttemptStatus::Authorized); +} + +// Captures a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_capture_authorized_payment() { + let response = CONNECTOR + .authorize_and_capture_payment(payment_method_details(), None, get_default_payment_info()) + .await + .expect("Capture payment response"); + assert_eq!(response.status, enums::AttemptStatus::Charged); +} + +// Partially captures a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_capture_authorized_payment() { + let response = CONNECTOR + .authorize_and_capture_payment( + payment_method_details(), + Some(types::PaymentsCaptureData { + amount_to_capture: 50, + ..utils::PaymentCaptureType::default().0 + }), + get_default_payment_info(), + ) + .await + .expect("Capture payment response"); + assert_eq!(response.status, enums::AttemptStatus::Charged); +} + +// Synchronizes a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_authorized_payment() { + let authorize_response = CONNECTOR + .authorize_payment(payment_method_details(), get_default_payment_info()) + .await + .expect("Authorize payment response"); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + let response = CONNECTOR + .psync_retry_till_status_matches( + enums::AttemptStatus::Authorized, + Some(types::PaymentsSyncData { + connector_transaction_id: types::ResponseId::ConnectorTransactionId( + txn_id.unwrap(), + ), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .expect("PSync response"); + assert_eq!(response.status, enums::AttemptStatus::Authorized,); +} + +// Voids a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_void_authorized_payment() { + let response = CONNECTOR + .authorize_and_void_payment( + payment_method_details(), + Some(types::PaymentsCancelData { + connector_transaction_id: String::from(""), + cancellation_reason: Some("requested_by_customer".to_string()), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .expect("Void payment response"); + assert_eq!(response.status, enums::AttemptStatus::Voided); +} + +// Refunds a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_manually_captured_payment() { + let response = CONNECTOR + .capture_payment_and_refund( + payment_method_details(), + None, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Partially refunds a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_refund_manually_captured_payment() { + let response = CONNECTOR + .capture_payment_and_refund( + payment_method_details(), + None, + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Synchronizes a refund using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_manually_captured_refund() { + let refund_response = CONNECTOR + .capture_payment_and_refund( + payment_method_details(), + None, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + let response = CONNECTOR + .rsync_retry_till_status_matches( + enums::RefundStatus::Success, + refund_response.response.unwrap().connector_refund_id, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Creates a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_make_payment() { + let authorize_response = CONNECTOR + .make_payment(payment_method_details(), get_default_payment_info()) + .await + .unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); +} + +// Synchronizes a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_auto_captured_payment() { + let authorize_response = CONNECTOR + .make_payment(payment_method_details(), get_default_payment_info()) + .await + .unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + assert_ne!(txn_id, None, "Empty connector transaction id"); + let response = CONNECTOR + .psync_retry_till_status_matches( + enums::AttemptStatus::Charged, + Some(types::PaymentsSyncData { + connector_transaction_id: types::ResponseId::ConnectorTransactionId( + txn_id.unwrap(), + ), + capture_method: Some(enums::CaptureMethod::Automatic), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!(response.status, enums::AttemptStatus::Charged,); +} + +// Refunds a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_auto_captured_payment() { + let response = CONNECTOR + .make_payment_and_refund(payment_method_details(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Partially refunds a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_refund_succeeded_payment() { + let refund_response = CONNECTOR + .make_payment_and_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + refund_response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Creates multiple refunds against a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_succeeded_payment_multiple_times() { + CONNECTOR + .make_payment_and_multiple_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await; +} + +// Synchronizes a refund using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_refund() { + let refund_response = CONNECTOR + .make_payment_and_refund(payment_method_details(), None, get_default_payment_info()) + .await + .unwrap(); + let response = CONNECTOR + .rsync_retry_till_status_matches( + enums::RefundStatus::Success, + refund_response.response.unwrap().connector_refund_id, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Cards Negative scenarios +// Creates a payment with incorrect CVC. +#[actix_web::test] +async fn should_fail_payment_for_incorrect_cvc() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: domain::PaymentMethodData::Card(domain::Card { + card_cvc: Secret::new("12345".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's security code is invalid.".to_string(), + ); +} + +// Creates a payment with incorrect expiry month. +#[actix_web::test] +async fn should_fail_payment_for_invalid_exp_month() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: domain::PaymentMethodData::Card(domain::Card { + card_exp_month: Secret::new("20".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's expiration month is invalid.".to_string(), + ); +} + +// Creates a payment with incorrect expiry year. +#[actix_web::test] +async fn should_fail_payment_for_incorrect_expiry_year() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: domain::PaymentMethodData::Card(domain::Card { + card_exp_year: Secret::new("2000".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's expiration year is invalid.".to_string(), + ); +} + +// Voids a payment using automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_fail_void_payment_for_auto_capture() { + let authorize_response = CONNECTOR + .make_payment(payment_method_details(), get_default_payment_info()) + .await + .unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + assert_ne!(txn_id, None, "Empty connector transaction id"); + let void_response = CONNECTOR + .void_payment(txn_id.unwrap(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + void_response.response.unwrap_err().message, + "You cannot cancel this PaymentIntent because it has a status of succeeded." + ); +} + +// Captures a payment using invalid connector payment id. +#[actix_web::test] +async fn should_fail_capture_for_invalid_payment() { + let capture_response = CONNECTOR + .capture_payment("123456789".to_string(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + capture_response.response.unwrap_err().message, + String::from("No such payment_intent: '123456789'") + ); +} + +// Refunds a payment with refund amount higher than payment amount. +#[actix_web::test] +async fn should_fail_for_refund_amount_higher_than_payment_amount() { + let response = CONNECTOR + .make_payment_and_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 150, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Refund amount (₹1.50) is greater than charge amount (₹1.00)", + ); +} + +// Connector dependent test cases goes here + +// [#478]: add unit tests for non 3DS, wallets & webhooks in connector tests diff --git a/crates/router/tests/connectors/main.rs b/crates/router/tests/connectors/main.rs index fced1b6bff3..8005e84652b 100644 --- a/crates/router/tests/connectors/main.rs +++ b/crates/router/tests/connectors/main.rs @@ -24,6 +24,7 @@ mod bluesnap; mod boku; mod cashtocode; mod chargebee; +mod checkbook; mod checkout; mod coinbase; mod cryptopay; diff --git a/crates/router/tests/connectors/sample_auth.toml b/crates/router/tests/connectors/sample_auth.toml index 354959856bf..25c63908448 100644 --- a/crates/router/tests/connectors/sample_auth.toml +++ b/crates/router/tests/connectors/sample_auth.toml @@ -341,6 +341,10 @@ api_key = "MyApiKey" key1 = "Merchant id" api_secret = "Secret key" +[checkbook] +api_key="Client ID" +key1 ="Client Secret" + [santander] api_key="Client ID" key1 ="Client Secret" diff --git a/crates/test_utils/src/connector_auth.rs b/crates/test_utils/src/connector_auth.rs index 17d442315c6..c92d4aa8591 100644 --- a/crates/test_utils/src/connector_auth.rs +++ b/crates/test_utils/src/connector_auth.rs @@ -30,6 +30,7 @@ pub struct ConnectorAuthentication { pub boku: Option<BodyKey>, pub cashtocode: Option<BodyKey>, pub chargebee: Option<HeaderKey>, + pub checkbook: Option<BodyKey>, pub checkout: Option<SignatureKey>, pub coinbase: Option<HeaderKey>, pub coingate: Option<HeaderKey>, diff --git a/loadtest/config/development.toml b/loadtest/config/development.toml index 4fade351226..102daf94c6a 100644 --- a/loadtest/config/development.toml +++ b/loadtest/config/development.toml @@ -96,6 +96,7 @@ boku.base_url = "https://country-api4-stage.boku.com" braintree.base_url = "https://payments.sandbox.braintree-api.com/graphql" cashtocode.base_url = "https://cluster05.api-test.cashtocode.com" chargebee.base_url = "https://$.chargebee.com/api/" +checkbook.base_url = "https://api.sandbox.checkbook.io" checkout.base_url = "https://api.sandbox.checkout.com/" coinbase.base_url = "https://api.commerce.coinbase.com" coingate.base_url = "https://api-sandbox.coingate.com" @@ -223,6 +224,7 @@ cards = [ "bluesnap", "boku", "braintree", + "checkbook", "checkout", "coinbase", "coingate", diff --git a/scripts/add_connector.sh b/scripts/add_connector.sh index a8fbbb15af8..a76e9beacf9 100755 --- a/scripts/add_connector.sh +++ b/scripts/add_connector.sh @@ -6,7 +6,7 @@ function find_prev_connector() { git checkout $self cp $self $self.tmp # Add new connector to existing list and sort it - connectors=(aci adyen adyenplatform airwallex amazonpay applepay archipel authorizedotnet bambora bamboraapac bankofamerica barclaycard billwerk bitpay bluesnap boku braintree cashtocode chargebee checkout coinbase cryptopay ctp_visa cybersource datatrans deutschebank digitalvirgo dlocal dummyconnector dwolla ebanx elavon facilitapay fiserv fiservemea fiuu forte getnet globalpay globepay gocardless gpayments helcim hipay hyperswitch_vault iatapay inespay itaubank jpmorgan juspaythreedsserver klarna mifinity mollie moneris multisafepay netcetera nexinets nexixpay nomupay noon nordea novalnet nuvei opayo opennode paybox payeezy payme payone paypal paystack payu placetopay plaid powertranz prophetpay rapyd razorpay recurly redsys santander shift4 square stax stripe stripebilling taxjar threedsecureio thunes tokenio trustpay tsys unified_authentication_service vgs volt wellsfargo wellsfargopayout wise worldline worldpay worldpayvantiv worldpayxml xendit zsl "$1") + connectors=(aci adyen adyenplatform airwallex amazonpay applepay archipel authorizedotnet bambora bamboraapac bankofamerica barclaycard billwerk bitpay bluesnap boku braintree cashtocode chargebee checkbook checkout coinbase cryptopay ctp_visa cybersource datatrans deutschebank digitalvirgo dlocal dummyconnector dwolla ebanx elavon facilitapay fiserv fiservemea fiuu forte getnet globalpay globepay gocardless gpayments helcim hipay hyperswitch_vault iatapay inespay itaubank jpmorgan juspaythreedsserver klarna mifinity mollie moneris multisafepay netcetera nexinets nexixpay nomupay noon nordea novalnet nuvei opayo opennode paybox payeezy payme payone paypal paystack payu placetopay plaid powertranz prophetpay rapyd razorpay recurly redsys santander shift4 square stax stripe stripebilling taxjar threedsecureio thunes tokenio trustpay tsys unified_authentication_service vgs volt wellsfargo wellsfargopayout wise worldline worldpay worldpayvantiv worldpayxml xendit zsl "$1") IFS=$'\n' sorted=($(sort <<<"${connectors[]}")); unset IFS res="$(echo ${sorted[@]})" sed -i'' -e "s/^ connectors=./ connectors=($res \"\$1\")/" $self.tmp	2025-06-30T09:30:05Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD Closes this [issue](https://github.com/juspay/hyperswitch/issues/8493) ## Description <!-- Describe your changes in detail --> Added template code for [Checkbook](https://docs.checkbook.io/reference/) ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> No tests required ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.114.0	28d63575e63d87b1cba7c6215faee803f2fff7d8	28d63575e63d87b1cba7c6215faee803f2fff7d8
juspay/hyperswitch	juspay__hyperswitch-8507	Bug: [FEATURE] populate connector raw response and connector_response_reference_id in v2 populate connector raw response and connector_response_reference_id	diff --git a/api-reference/v2/openapi_spec_v2.json b/api-reference/v2/openapi_spec_v2.json index 8da8f56f709..76a35e926e2 100644 --- a/api-reference/v2/openapi_spec_v2.json +++ b/api-reference/v2/openapi_spec_v2.json @@ -17881,41 +17881,6 @@ "propertyName": "payment_processing_details_at" } }, - "PaymentRetrieveBody": { - "type": "object", - "properties": { - "merchant_id": { - "type": "string", - "description": "The identifier for the Merchant Account.", - "nullable": true - }, - "force_sync": { - "type": "boolean", - "description": "Decider to enable or disable the connector call for retrieve request", - "nullable": true - }, - "client_secret": { - "type": "string", - "description": "This is a token which expires after 15 minutes, used from the client to authenticate and create sessions from the SDK", - "nullable": true - }, - "expand_captures": { - "type": "boolean", - "description": "If enabled provides list of captures linked to latest attempt", - "nullable": true - }, - "expand_attempts": { - "type": "boolean", - "description": "If enabled provides list of attempts linked to payment intent", - "nullable": true - }, - "all_keys_required": { - "type": "boolean", - "description": "If enabled, provides whole connector response", - "nullable": true - } - } - }, "PaymentRevenueRecoveryMetadata": { "type": "object", "required": [ @@ -18128,6 +18093,11 @@ } ], "nullable": true + }, + "return_raw_connector_response": { + "type": "boolean", + "description": "If true, returns stringified connector raw response body", + "nullable": true } }, "additionalProperties": false @@ -19127,6 +19097,11 @@ } ], "nullable": true + }, + "return_raw_connector_response": { + "type": "boolean", + "description": "Stringified connector raw response body. Only returned if `return_raw_connector_response` is true", + "nullable": true } }, "additionalProperties": false @@ -19311,6 +19286,11 @@ "nullable": true, "maxLength": 30, "minLength": 30 + }, + "raw_connector_response": { + "type": "string", + "description": "Stringified connector raw response body. Only returned if `return_raw_connector_response` is true", + "nullable": true } } }, @@ -19331,9 +19311,9 @@ "description": "These are the query params that are sent in case of redirect response.\nThese can be ingested by the connector to take necessary actions.", "nullable": true }, - "all_keys_required": { + "return_raw_connector_response": { "type": "boolean", - "description": "If enabled, provides whole connector response", + "description": "If true, returns stringified connector raw response body", "nullable": true }, "merchant_connector_details": { @@ -19394,9 +19374,9 @@ "description": "These are the query params that are sent in case of redirect response.\nThese can be ingested by the connector to take necessary actions.", "nullable": true }, - "all_keys_required": { + "return_raw_connector_response": { "type": "boolean", - "description": "If enabled, provides whole connector response", + "description": "If true, returns stringified connector raw response body", "nullable": true } } diff --git a/crates/api_models/src/payments.rs b/crates/api_models/src/payments.rs index 2ff07472a0d..9150697aa19 100644 --- a/crates/api_models/src/payments.rs +++ b/crates/api_models/src/payments.rs @@ -5347,6 +5347,9 @@ pub struct PaymentsConfirmIntentRequest { /// Merchant connector details used to make payments. #[schema(value_type = Option<MerchantConnectorAuthDetails>)] pub merchant_connector_details: Option<common_types::domain::MerchantConnectorAuthDetails>, + + /// If true, returns stringified connector raw response body + pub return_raw_connector_response: Option<bool>, } #[cfg(feature = "v2")] @@ -5523,6 +5526,9 @@ pub struct PaymentsRequest { /// Merchant connector details used to make payments. #[schema(value_type = Option<MerchantConnectorAuthDetails>)] pub merchant_connector_details: Option<common_types::domain::MerchantConnectorAuthDetails>, + + /// Stringified connector raw response body. Only returned if `return_raw_connector_response` is true + pub return_raw_connector_response: Option<bool>, } #[cfg(feature = "v2")] @@ -5575,6 +5581,7 @@ impl From<&PaymentsRequest> for PaymentsConfirmIntentRequest { payment_method_id: request.payment_method_id.clone(), payment_token: None, merchant_connector_details: request.merchant_connector_details.clone(), + return_raw_connector_response: request.return_raw_connector_response, } } } @@ -5597,8 +5604,8 @@ pub struct PaymentsRetrieveRequest { /// These are the query params that are sent in case of redirect response. /// These can be ingested by the connector to take necessary actions. pub param: Option<String>, - /// If enabled, provides whole connector response - pub all_keys_required: Option<bool>, + /// If true, returns stringified connector raw response body + pub return_raw_connector_response: Option<bool>, /// Merchant connector details used to make payments. #[schema(value_type = Option<MerchantConnectorAuthDetails>)] pub merchant_connector_details: Option<common_types::domain::MerchantConnectorAuthDetails>, @@ -5619,8 +5626,8 @@ pub struct PaymentsStatusRequest { /// These are the query params that are sent in case of redirect response. /// These can be ingested by the connector to take necessary actions. pub param: Option<String>, - /// If enabled, provides whole connector response - pub all_keys_required: Option<bool>, + /// If true, returns stringified connector raw response body + pub return_raw_connector_response: Option<bool>, } /// Error details for the payment @@ -5776,6 +5783,9 @@ pub struct PaymentsResponse { example = "pay_mbabizu24mvu3mela5njyhpit4" )] pub merchant_reference_id: Option<id_type::PaymentReferenceId>, + + /// Stringified connector raw response body. Only returned if `return_raw_connector_response` is true + pub raw_connector_response: Option<String>, } #[cfg(feature = "v2")] @@ -7496,6 +7506,7 @@ pub struct PaymentsSessionResponse { pub vault_details: Option<VaultSessionDetails>, } +#[cfg(feature = "v1")] #[derive(Default, Debug, serde::Deserialize, serde::Serialize, Clone, ToSchema)] pub struct PaymentRetrieveBody { /// The identifier for the Merchant Account. @@ -7513,6 +7524,7 @@ pub struct PaymentRetrieveBody { pub all_keys_required: Option<bool>, } +#[cfg(feature = "v1")] #[derive(Default, Debug, serde::Deserialize, serde::Serialize, Clone, ToSchema)] pub struct PaymentRetrieveBodyWithCredentials { /// The identifier for payment. diff --git a/crates/common_types/src/domain.rs b/crates/common_types/src/domain.rs index f41f874cd06..66ffa6029d0 100644 --- a/crates/common_types/src/domain.rs +++ b/crates/common_types/src/domain.rs @@ -106,3 +106,11 @@ pub struct MerchantConnectorAuthDetails { }"#)] pub merchant_connector_creds: common_utils::pii::SecretSerdeValue, } + +/// Connector Response Data that are required to be populated in response +#[cfg(feature = "v2")] +#[derive(Clone, Debug)] +pub struct ConnectorResponseData { + /// Stringified connector raw response body + pub raw_connector_response: Option<String>, +} diff --git a/crates/diesel_models/src/payment_attempt.rs b/crates/diesel_models/src/payment_attempt.rs index eeda9e78877..95bb5a875d1 100644 --- a/crates/diesel_models/src/payment_attempt.rs +++ b/crates/diesel_models/src/payment_attempt.rs @@ -852,7 +852,7 @@ pub struct PaymentAttemptUpdateInternal { // payment_experience: Option<storage_enums::PaymentExperience>, // preprocessing_step_id: Option<String>, pub error_reason: Option<String>, - // connector_response_reference_id: Option<String>, + pub connector_response_reference_id: Option<String>, // multiple_capture_count: Option<i16>, // pub surcharge_amount: Option<MinorUnit>, // tax_on_surcharge: Option<MinorUnit>, @@ -910,6 +910,7 @@ impl PaymentAttemptUpdateInternal { network_error_message, payment_method_id, connector_request_reference_id, + connector_response_reference_id, } = self; PaymentAttempt { @@ -939,7 +940,8 @@ impl PaymentAttemptUpdateInternal { preprocessing_step_id: source.preprocessing_step_id, error_reason: error_reason.or(source.error_reason), multiple_capture_count: source.multiple_capture_count, - connector_response_reference_id: source.connector_response_reference_id, + connector_response_reference_id: connector_response_reference_id + .or(source.connector_response_reference_id), amount_capturable: amount_capturable.unwrap_or(source.amount_capturable), updated_by, merchant_connector_id: merchant_connector_id.or(source.merchant_connector_id), diff --git a/crates/hyperswitch_connectors/src/connectors/razorpay.rs b/crates/hyperswitch_connectors/src/connectors/razorpay.rs index 39b83c73e43..33cdc326987 100644 --- a/crates/hyperswitch_connectors/src/connectors/razorpay.rs +++ b/crates/hyperswitch_connectors/src/connectors/razorpay.rs @@ -316,7 +316,7 @@ impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData connectors: &Connectors, ) -> CustomResult<String, errors::ConnectorError> { Ok(format!( - "{}v1/payments/create/json", + "{}v1/payments/create/upi", self.base_url(connectors) )) } @@ -404,15 +404,15 @@ impl ConnectorIntegration<PSync, PaymentsSyncData, PaymentsResponseData> for Raz req: &PaymentsSyncRouterData, connectors: &Connectors, ) -> CustomResult<String, errors::ConnectorError> { - let connector_payment_id = req + let order_id = req .request - .connector_transaction_id - .get_connector_transaction_id() - .change_context(errors::ConnectorError::MissingConnectorTransactionID)?; + .connector_reference_id + .clone() + .ok_or(errors::ConnectorError::RequestEncodingFailed)?; Ok(format!( - "{}v1/payments/{}", + "{}v1/orders/{}/payments", self.base_url(connectors), - connector_payment_id, + order_id, )) } @@ -512,21 +512,11 @@ impl ConnectorIntegration<Capture, PaymentsCaptureData, PaymentsResponseData> fo fn handle_response( &self, - data: &PaymentsCaptureRouterData, - event_builder: Option<&mut ConnectorEvent>, - res: Response, + _data: &PaymentsCaptureRouterData, + _event_builder: Option<&mut ConnectorEvent>, + _res: Response, ) -> CustomResult<PaymentsCaptureRouterData, errors::ConnectorError> { - let response: razorpay::RazorpayPaymentsResponse = res - .response - .parse_struct("Razorpay PaymentsCaptureResponse") - .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; - event_builder.map(\|i\| i.set_response_body(&response)); - router_env::logger::info!(connector_response=?response); - RouterData::try_from(ResponseRouterData { - response, - data: data.clone(), - http_code: res.status_code, - }) + Err(errors::ConnectorError::NotImplemented("get_request_body method".to_string()).into()) } fn get_error_response( diff --git a/crates/hyperswitch_connectors/src/connectors/razorpay/transformers.rs b/crates/hyperswitch_connectors/src/connectors/razorpay/transformers.rs index 23aa8828291..0176ae47854 100644 --- a/crates/hyperswitch_connectors/src/connectors/razorpay/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/razorpay/transformers.rs @@ -11,7 +11,7 @@ use hyperswitch_domain_models::{ payment_method_data::{PaymentMethodData, UpiData}, router_data::{ConnectorAuthType, RouterData}, router_flow_types::refunds::{Execute, RSync}, - router_request_types::ResponseId, + router_request_types::{PaymentsAuthorizeData, ResponseId}, router_response_types::{PaymentsResponseData, RefundsResponseData}, types, }; @@ -227,18 +227,29 @@ pub struct NextAction { #[derive(Debug, Clone, Serialize, Deserialize)] pub struct RazorpayPaymentsResponse { pub razorpay_payment_id: String, - pub next: Option<Vec<NextAction>>, } -impl<F, T> TryFrom<ResponseRouterData<F, RazorpayPaymentsResponse, T, PaymentsResponseData>> - for RouterData<F, T, PaymentsResponseData> +impl<F> + TryFrom< + ResponseRouterData< + F, + RazorpayPaymentsResponse, + PaymentsAuthorizeData, + PaymentsResponseData, + >, + > for RouterData<F, PaymentsAuthorizeData, PaymentsResponseData> { type Error = error_stack::Report<errors::ConnectorError>; fn try_from( - item: ResponseRouterData<F, RazorpayPaymentsResponse, T, PaymentsResponseData>, + item: ResponseRouterData< + F, + RazorpayPaymentsResponse, + PaymentsAuthorizeData, + PaymentsResponseData, + >, ) -> Result<Self, Self::Error> { let connector_metadata = get_wait_screen_metadata()?; - + let order_id = item.data.request.get_order_id()?; Ok(Self { status: enums::AttemptStatus::AuthenticationPending, response: Ok(PaymentsResponseData::TransactionResponse { @@ -249,7 +260,7 @@ impl<F, T> TryFrom<ResponseRouterData<F, RazorpayPaymentsResponse, T, PaymentsRe mandate_reference: Box::new(None), connector_metadata, network_txn_id: None, - connector_response_reference_id: Some(item.response.razorpay_payment_id), + connector_response_reference_id: Some(order_id), incremental_authorization_allowed: None, charges: None, }), @@ -281,6 +292,12 @@ pub fn get_wait_screen_metadata() -> CustomResult<Option<serde_json::Value>, err #[derive(Debug, Clone, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct RazorpaySyncResponse { + items: Vec<RazorpaySyncItem>, +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct RazorpaySyncItem { id: String, status: RazorpayStatus, } @@ -311,8 +328,15 @@ impl<F, T> TryFrom<ResponseRouterData<F, RazorpaySyncResponse, T, PaymentsRespon fn try_from( item: ResponseRouterData<F, RazorpaySyncResponse, T, PaymentsResponseData>, ) -> Result<Self, Self::Error> { + let status = match item.response.items.last() { + Some(last_item) => { + let razorpay_status = last_item.status; + get_psync_razorpay_payment_status(razorpay_status) + } + None => item.data.status, + }; Ok(Self { - status: get_psync_razorpay_payment_status(item.response.status), + status, response: Ok(PaymentsResponseData::TransactionResponse { resource_id: ResponseId::NoResponseId, redirection_data: Box::new(None), diff --git a/crates/hyperswitch_connectors/src/utils.rs b/crates/hyperswitch_connectors/src/utils.rs index b346b40d970..1353d068190 100644 --- a/crates/hyperswitch_connectors/src/utils.rs +++ b/crates/hyperswitch_connectors/src/utils.rs @@ -6209,7 +6209,7 @@ pub(crate) fn convert_payment_authorize_router_response<F1, F2, T1, T2>( connector_mandate_request_reference_id: data.connector_mandate_request_reference_id.clone(), authentication_id: data.authentication_id.clone(), psd2_sca_exemption_type: data.psd2_sca_exemption_type, - whole_connector_response: data.whole_connector_response.clone(), + raw_connector_response: data.raw_connector_response.clone(), } } diff --git a/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs b/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs index d644c519ea9..9078f1d49df 100644 --- a/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs +++ b/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs @@ -1763,6 +1763,7 @@ pub struct ConfirmIntentResponseUpdate { pub connector_metadata: Option<pii::SecretSerdeValue>, pub amount_capturable: Option<MinorUnit>, pub connector_token_details: Option<diesel_models::ConnectorTokenDetails>, + pub connector_response_reference_id: Option<String>, } #[cfg(feature = "v2")] @@ -1776,6 +1777,7 @@ pub enum PaymentAttemptUpdate { merchant_connector_id: Option<id_type::MerchantConnectorAccountId>, authentication_type: storage_enums::AuthenticationType, connector_request_reference_id: Option<String>, + connector_response_reference_id: Option<String>, }, /// Update the payment attempt on confirming the intent, before calling the connector, when payment_method_id is present ConfirmIntentTokenized { @@ -2569,6 +2571,7 @@ impl From<PaymentAttemptUpdate> for diesel_models::PaymentAttemptUpdateInternal merchant_connector_id, authentication_type, connector_request_reference_id, + connector_response_reference_id, } => Self { status: Some(status), payment_method_id: None, @@ -2594,6 +2597,7 @@ impl From<PaymentAttemptUpdate> for diesel_models::PaymentAttemptUpdateInternal network_decline_code: None, network_error_message: None, connector_request_reference_id, + connector_response_reference_id, }, PaymentAttemptUpdate::ErrorUpdate { status, @@ -2626,6 +2630,7 @@ impl From<PaymentAttemptUpdate> for diesel_models::PaymentAttemptUpdateInternal network_decline_code: error.network_decline_code, network_error_message: error.network_error_message, connector_request_reference_id: None, + connector_response_reference_id: None, }, PaymentAttemptUpdate::ConfirmIntentResponse(confirm_intent_response_update) => { let ConfirmIntentResponseUpdate { @@ -2636,6 +2641,7 @@ impl From<PaymentAttemptUpdate> for diesel_models::PaymentAttemptUpdateInternal connector_metadata, amount_capturable, connector_token_details, + connector_response_reference_id, } = *confirm_intent_response_update; Self { status: Some(status), @@ -2663,6 +2669,7 @@ impl From<PaymentAttemptUpdate> for diesel_models::PaymentAttemptUpdateInternal network_decline_code: None, network_error_message: None, connector_request_reference_id: None, + connector_response_reference_id, } } PaymentAttemptUpdate::SyncUpdate { @@ -2694,6 +2701,7 @@ impl From<PaymentAttemptUpdate> for diesel_models::PaymentAttemptUpdateInternal network_decline_code: None, network_error_message: None, connector_request_reference_id: None, + connector_response_reference_id: None, }, PaymentAttemptUpdate::CaptureUpdate { status, @@ -2724,6 +2732,7 @@ impl From<PaymentAttemptUpdate> for diesel_models::PaymentAttemptUpdateInternal network_decline_code: None, network_error_message: None, connector_request_reference_id: None, + connector_response_reference_id: None, }, PaymentAttemptUpdate::PreCaptureUpdate { amount_to_capture, @@ -2753,6 +2762,7 @@ impl From<PaymentAttemptUpdate> for diesel_models::PaymentAttemptUpdateInternal network_decline_code: None, network_error_message: None, connector_request_reference_id: None, + connector_response_reference_id: None, }, PaymentAttemptUpdate::ConfirmIntentTokenized { status, @@ -2786,6 +2796,7 @@ impl From<PaymentAttemptUpdate> for diesel_models::PaymentAttemptUpdateInternal network_decline_code: None, network_error_message: None, connector_request_reference_id: None, + connector_response_reference_id: None, }, } } diff --git a/crates/hyperswitch_domain_models/src/router_data.rs b/crates/hyperswitch_domain_models/src/router_data.rs index dd1004c7018..851ac69a81c 100644 --- a/crates/hyperswitch_domain_models/src/router_data.rs +++ b/crates/hyperswitch_domain_models/src/router_data.rs @@ -103,8 +103,8 @@ pub struct RouterData<Flow, Request, Response> { /// Contains the type of sca exemption required for the transaction pub psd2_sca_exemption_type: Option<common_enums::ScaExemptionType>, - /// Contains whole connector response - pub whole_connector_response: Option<String>, + /// Contains stringified connector raw response body + pub raw_connector_response: Option<String>, } // Different patterns of authentication. @@ -567,6 +567,7 @@ impl resource_id, redirection_data, connector_metadata, + connector_response_reference_id, .. } => { let attempt_status = self.get_attempt_status_for_db_update(payment_data); @@ -595,6 +596,8 @@ impl token_details.get_connector_token_request_reference_id() }), ), + connector_response_reference_id: connector_response_reference_id + .clone(), }, )) } @@ -1253,6 +1256,7 @@ impl resource_id, redirection_data, connector_metadata, + connector_response_reference_id, .. } => { let attempt_status = self.get_attempt_status_for_db_update(payment_data); @@ -1281,6 +1285,9 @@ impl token_details.get_connector_token_request_reference_id() }), ), + + connector_response_reference_id: connector_response_reference_id + .clone(), }, )) } diff --git a/crates/hyperswitch_domain_models/src/router_request_types.rs b/crates/hyperswitch_domain_models/src/router_request_types.rs index c7987122ead..31879b4cfe3 100644 --- a/crates/hyperswitch_domain_models/src/router_request_types.rs +++ b/crates/hyperswitch_domain_models/src/router_request_types.rs @@ -508,6 +508,7 @@ pub struct PaymentsSyncData { pub split_payments: Option<common_types::payments::SplitPaymentsRequest>, pub amount: MinorUnit, pub integrity_object: Option<SyncIntegrityObject>, + pub connector_reference_id: Option<String>, } #[derive(Debug, Default, Clone)] diff --git a/crates/hyperswitch_interfaces/src/conversion_impls.rs b/crates/hyperswitch_interfaces/src/conversion_impls.rs index 252caed961e..ae5f071a209 100644 --- a/crates/hyperswitch_interfaces/src/conversion_impls.rs +++ b/crates/hyperswitch_interfaces/src/conversion_impls.rs @@ -84,7 +84,7 @@ fn get_default_router_data<F, Req, Resp>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, } } diff --git a/crates/openapi/src/openapi_v2.rs b/crates/openapi/src/openapi_v2.rs index 4a3c03d69fb..11dae0588ab 100644 --- a/crates/openapi/src/openapi_v2.rs +++ b/crates/openapi/src/openapi_v2.rs @@ -424,7 +424,6 @@ Never share your secret api keys. Keep them guarded and secure. api_models::payments::PaymentsRequest, api_models::payments::PaymentsResponse, api_models::payments::PaymentsListResponseItem, - api_models::payments::PaymentRetrieveBody, api_models::payments::PaymentsRetrieveRequest, api_models::payments::PaymentsStatusRequest, api_models::payments::PaymentsCaptureRequest, diff --git a/crates/router/src/core/authentication/transformers.rs b/crates/router/src/core/authentication/transformers.rs index e1cf04c20aa..91b7c23f053 100644 --- a/crates/router/src/core/authentication/transformers.rs +++ b/crates/router/src/core/authentication/transformers.rs @@ -206,7 +206,7 @@ pub fn construct_router_data<F: Clone, Req, Res>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type, - whole_connector_response: None, + raw_connector_response: None, }) } diff --git a/crates/router/src/core/fraud_check/flows/checkout_flow.rs b/crates/router/src/core/fraud_check/flows/checkout_flow.rs index 786192f8e98..a33dcc89a99 100644 --- a/crates/router/src/core/fraud_check/flows/checkout_flow.rs +++ b/crates/router/src/core/fraud_check/flows/checkout_flow.rs @@ -161,7 +161,7 @@ impl ConstructFlowSpecificData<frm_api::Checkout, FraudCheckCheckoutData, FraudC connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) diff --git a/crates/router/src/core/fraud_check/flows/fulfillment_flow.rs b/crates/router/src/core/fraud_check/flows/fulfillment_flow.rs index 421c255e117..08b3c789264 100644 --- a/crates/router/src/core/fraud_check/flows/fulfillment_flow.rs +++ b/crates/router/src/core/fraud_check/flows/fulfillment_flow.rs @@ -128,7 +128,7 @@ pub async fn construct_fulfillment_router_data<'a>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) } diff --git a/crates/router/src/core/fraud_check/flows/record_return.rs b/crates/router/src/core/fraud_check/flows/record_return.rs index ea34b8af172..d33cd51e574 100644 --- a/crates/router/src/core/fraud_check/flows/record_return.rs +++ b/crates/router/src/core/fraud_check/flows/record_return.rs @@ -129,7 +129,7 @@ impl ConstructFlowSpecificData<RecordReturn, FraudCheckRecordReturnData, FraudCh connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) diff --git a/crates/router/src/core/fraud_check/flows/sale_flow.rs b/crates/router/src/core/fraud_check/flows/sale_flow.rs index efdeeec7747..55d53f00964 100644 --- a/crates/router/src/core/fraud_check/flows/sale_flow.rs +++ b/crates/router/src/core/fraud_check/flows/sale_flow.rs @@ -137,7 +137,7 @@ impl ConstructFlowSpecificData<frm_api::Sale, FraudCheckSaleData, FraudCheckResp connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) diff --git a/crates/router/src/core/fraud_check/flows/transaction_flow.rs b/crates/router/src/core/fraud_check/flows/transaction_flow.rs index eae995be4b4..29013c70e92 100644 --- a/crates/router/src/core/fraud_check/flows/transaction_flow.rs +++ b/crates/router/src/core/fraud_check/flows/transaction_flow.rs @@ -146,7 +146,7 @@ impl connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) diff --git a/crates/router/src/core/mandate/utils.rs b/crates/router/src/core/mandate/utils.rs index 642a28c5671..1298162d412 100644 --- a/crates/router/src/core/mandate/utils.rs +++ b/crates/router/src/core/mandate/utils.rs @@ -85,7 +85,7 @@ pub async fn construct_mandate_revoke_router_data( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) diff --git a/crates/router/src/core/payment_methods.rs b/crates/router/src/core/payment_methods.rs index 6d36f7d4341..d04bf5b39ed 100644 --- a/crates/router/src/core/payment_methods.rs +++ b/crates/router/src/core/payment_methods.rs @@ -2922,6 +2922,7 @@ fn construct_zero_auth_payments_request( force_3ds_challenge: None, is_iframe_redirection_enabled: None, merchant_connector_details: None, + return_raw_connector_response: None, }) } @@ -3263,7 +3264,7 @@ async fn create_single_use_tokenization_flow( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; let payment_method_token_response = tokenization::add_token_for_payment_method( diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs index 66334148b09..7e5328763fd 100644 --- a/crates/router/src/core/payments.rs +++ b/crates/router/src/core/payments.rs @@ -148,7 +148,14 @@ pub async fn payments_operation_core<F, Req, Op, FData, D>( get_tracker_response: operations::GetTrackerResponse<D>, call_connector_action: CallConnectorAction, header_payload: HeaderPayload, -) -> RouterResult<(D, Req, Option<domain::Customer>, Option<u16>, Option<u128>)> +) -> RouterResult<( + D, + Req, + Option<domain::Customer>, + Option<u16>, + Option<u128>, + common_types::domain::ConnectorResponseData, +)> where F: Send + Clone + Sync, Req: Send + Sync + Authenticate, @@ -204,7 +211,7 @@ where .perform_routing(&merchant_context, profile, state, &mut payment_data) .await?; - let payment_data = match connector { + let (payment_data, connector_response_data) = match connector { ConnectorCallType::PreDetermined(connector_data) => { let router_data = call_connector_service( state, @@ -224,10 +231,14 @@ where profile, false, false, //should_retry_with_pan is set to false in case of PreDetermined ConnectorCallType - req.get_all_keys_required(), + req.should_return_raw_response(), ) .await?; + let connector_response_data = common_types::domain::ConnectorResponseData { + raw_connector_response: router_data.raw_connector_response.clone(), + }; + let payments_response_operation = Box::new(PaymentResponse); payments_response_operation @@ -241,7 +252,7 @@ where ) .await?; - payments_response_operation + let payment_data = payments_response_operation .to_post_update_tracker()? .update_tracker( state, @@ -250,7 +261,9 @@ where merchant_context.get_merchant_key_store(), merchant_context.get_merchant_account().storage_scheme, ) - .await? + .await?; + + (payment_data, connector_response_data) } ConnectorCallType::Retryable(connectors) => { let mut connectors = connectors.clone().into_iter(); @@ -273,10 +286,14 @@ where profile, false, false, //should_retry_with_pan is set to false in case of PreDetermined ConnectorCallType - req.get_all_keys_required(), + req.should_return_raw_response(), ) .await?; + let connector_response_data = common_types::domain::ConnectorResponseData { + raw_connector_response: router_data.raw_connector_response.clone(), + }; + let payments_response_operation = Box::new(PaymentResponse); payments_response_operation @@ -290,7 +307,7 @@ where ) .await?; - payments_response_operation + let payment_data = payments_response_operation .to_post_update_tracker()? .update_tracker( state, @@ -299,10 +316,17 @@ where merchant_context.get_merchant_key_store(), merchant_context.get_merchant_account().storage_scheme, ) - .await? + .await?; + + (payment_data, connector_response_data) } ConnectorCallType::SessionMultiple(vec) => todo!(), - ConnectorCallType::Skip => payment_data, + ConnectorCallType::Skip => ( + payment_data, + common_types::domain::ConnectorResponseData { + raw_connector_response: None, + }, + ), }; let payment_intent_status = payment_data.get_payment_intent().status; @@ -321,7 +345,14 @@ where }) .await; - Ok((payment_data, req, customer, None, None)) + Ok(( + payment_data, + req, + customer, + None, + None, + connector_response_data, + )) } #[cfg(feature = "v2")] @@ -337,7 +368,13 @@ pub async fn internal_payments_operation_core<F, Req, Op, FData, D>( get_tracker_response: operations::GetTrackerResponse<D>, call_connector_action: CallConnectorAction, header_payload: HeaderPayload, -) -> RouterResult<(D, Req, Option<u16>, Option<u128>)> +) -> RouterResult<( + D, + Req, + Option<u16>, + Option<u128>, + common_types::domain::ConnectorResponseData, +)> where F: Send + Clone + Sync, Req: Send + Sync + Authenticate, @@ -379,10 +416,14 @@ where call_connector_action.clone(), header_payload.clone(), profile, - req.get_all_keys_required(), + req.should_return_raw_response(), ) .await?; + let connector_response_data = common_types::domain::ConnectorResponseData { + raw_connector_response: router_data.raw_connector_response.clone(), + }; + let payments_response_operation = Box::new(PaymentResponse); let payment_data = payments_response_operation @@ -396,7 +437,7 @@ where ) .await?; - Ok((payment_data, req, None, None)) + Ok((payment_data, req, None, None, connector_response_data)) } #[cfg(feature = "v1")] @@ -686,7 +727,7 @@ where false, false, None, - <Req as Authenticate>::get_all_keys_required(&req), + <Req as Authenticate>::should_return_raw_response(&req), ) .await?; @@ -810,7 +851,7 @@ where false, false, routing_decision, - <Req as Authenticate>::get_all_keys_required(&req), + <Req as Authenticate>::should_return_raw_response(&req), ) .await?; @@ -941,7 +982,7 @@ where session_surcharge_details, &business_profile, header_payload.clone(), - <Req as Authenticate>::get_all_keys_required(&req), + <Req as Authenticate>::should_return_raw_response(&req), )) .await? } @@ -1070,7 +1111,7 @@ pub async fn proxy_for_payments_operation_core<F, Req, Op, FData, D>( call_connector_action: CallConnectorAction, auth_flow: services::AuthFlow, header_payload: HeaderPayload, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<(D, Req, Option<domain::Customer>, Option<u16>, Option<u128>)> where F: Send + Clone + Sync, @@ -1184,7 +1225,7 @@ where schedule_time, header_payload.clone(), &business_profile, - all_keys_required, + return_raw_connector_response, ) .await?; @@ -1270,7 +1311,7 @@ pub async fn proxy_for_payments_operation_core<F, Req, Op, FData, D>( get_tracker_response: operations::GetTrackerResponse<D>, call_connector_action: CallConnectorAction, header_payload: HeaderPayload, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<(D, Req, Option<u16>, Option<u128>)> where F: Send + Clone + Sync, @@ -1315,7 +1356,7 @@ where call_connector_action.clone(), header_payload.clone(), &profile, - all_keys_required, + return_raw_connector_response, ) .await?; @@ -1865,7 +1906,7 @@ pub async fn proxy_for_payments_core<F, Res, Req, Op, FData, D>( auth_flow: services::AuthFlow, call_connector_action: CallConnectorAction, header_payload: HeaderPayload, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResponse<Res> where F: Send + Clone + Sync, @@ -1896,7 +1937,7 @@ where call_connector_action, auth_flow, header_payload.clone(), - all_keys_required, + return_raw_connector_response, ) .await?; @@ -1925,7 +1966,7 @@ pub async fn proxy_for_payments_core<F, Res, Req, Op, FData, D>( payment_id: id_type::GlobalPaymentId, call_connector_action: CallConnectorAction, header_payload: HeaderPayload, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResponse<Res> where F: Send + Clone + Sync, @@ -1977,7 +2018,7 @@ where get_tracker_response, call_connector_action, header_payload.clone(), - all_keys_required, + return_raw_connector_response, ) .await?; @@ -1988,6 +2029,7 @@ where header_payload.x_hs_latency, &merchant_context, &profile, + None, ) } @@ -2065,7 +2107,7 @@ pub async fn record_attempt_core( force_sync: true, expand_attempts: false, param: None, - all_keys_required: None, + return_raw_connector_response: None, merchant_connector_details: None, }, operations::GetTrackerResponse { @@ -2125,6 +2167,7 @@ pub async fn record_attempt_core( header_payload.x_hs_latency, &merchant_context, &profile, + None, ) } @@ -2334,37 +2377,58 @@ where ) .await?; - let (payment_data, connector_http_status_code, external_latency) = + let (payment_data, connector_http_status_code, external_latency, connector_response_data) = if state.conf.merchant_id_auth.merchant_id_auth_enabled { - let (payment_data, _req, connector_http_status_code, external_latency) = - internal_payments_operation_core::<_, _, _, _, _>( - &state, - req_state, - merchant_context.clone(), - &profile, - operation.clone(), - req, - get_tracker_response, - call_connector_action, - header_payload.clone(), - ) - .await?; - (payment_data, connector_http_status_code, external_latency) + let ( + payment_data, + _req, + connector_http_status_code, + external_latency, + connector_response_data, + ) = internal_payments_operation_core::<_, _, _, _, _>( + &state, + req_state, + merchant_context.clone(), + &profile, + operation.clone(), + req, + get_tracker_response, + call_connector_action, + header_payload.clone(), + ) + .await?; + ( + payment_data, + connector_http_status_code, + external_latency, + connector_response_data, + ) } else { - let (payment_data, _req, _customer, connector_http_status_code, external_latency) = - payments_operation_core::<_, _, _, _, _>( - &state, - req_state, - merchant_context.clone(), - &profile, - operation.clone(), - req, - get_tracker_response, - call_connector_action, - header_payload.clone(), - ) - .await?; - (payment_data, connector_http_status_code, external_latency) + let ( + payment_data, + _req, + _customer, + connector_http_status_code, + external_latency, + connector_response_data, + ) = payments_operation_core::<_, _, _, _, _>( + &state, + req_state, + merchant_context.clone(), + &profile, + operation.clone(), + req, + get_tracker_response, + call_connector_action, + header_payload.clone(), + ) + .await?; + ( + payment_data, + connector_http_status_code, + external_latency, + connector_response_data, + ) }; payment_data.generate_response( @@ -2374,6 +2438,7 @@ where header_payload.x_hs_latency, &merchant_context, &profile, + Some(connector_response_data), ) } @@ -3000,7 +3065,7 @@ impl PaymentRedirectFlow for PaymentRedirectSync { param: Some(req.query_params.clone()), force_sync: true, expand_attempts: false, - all_keys_required: None, + return_raw_connector_response: None, merchant_connector_details: None, // TODO: Implement for connectors requiring 3DS or redirection-based authentication flows. }; @@ -3056,7 +3121,7 @@ impl PaymentRedirectFlow for PaymentRedirectSync { .change_context(errors::ApiErrorResponse::InternalServerError) .attach_printable("Failed to decide the response flow")?; - let (payment_data, _, _, _, _) = + let (payment_data, _, _, _, _, _) = Box::pin(payments_operation_core::<api::PSync, _, _, _, _>( state, req_state, @@ -3378,7 +3443,7 @@ pub async fn call_connector_service<F, RouterDReq, ApiRequest, D>( is_retry_payment: bool, should_retry_with_pan: bool, routing_decision: Option<routing_helpers::RoutingDecisionData>, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<( RouterData<F, RouterDReq, router_types::PaymentsResponseData>, helpers::MerchantConnectorAccountType, @@ -3539,16 +3604,28 @@ where router_data = router_data.add_session_token(state, &connector).await?; - let should_continue_further = access_token::update_router_data_with_access_token_result( + let mut should_continue_further = access_token::update_router_data_with_access_token_result( &add_access_token_result, &mut router_data, &call_connector_action, ); - let should_continue_further = router_data + let add_create_order_result = router_data .create_order_at_connector(state, &connector, should_continue_further) .await?; + if add_create_order_result.is_create_order_performed { + if let Ok(order_id_opt) = &add_create_order_result.create_order_result { + payment_data.set_connector_response_reference_id(order_id_opt.clone()); + } + should_continue_further = router_data + .update_router_data_with_create_order_result( + add_create_order_result, + should_continue_further, + ) + .await?; + } + let updated_customer = call_create_connector_customer_if_required( state, customer, @@ -3664,7 +3741,7 @@ where connector_request, business_profile, header_payload.clone(), - all_keys_required, + return_raw_connector_response, ) .await } else { @@ -3696,7 +3773,7 @@ pub async fn call_connector_service<F, RouterDReq, ApiRequest, D>( business_profile: &domain::Profile, is_retry_payment: bool, should_retry_with_pan: bool, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<RouterData<F, RouterDReq, router_types::PaymentsResponseData>> where F: Send + Clone + Sync, @@ -3765,16 +3842,28 @@ where router_data = router_data.add_session_token(state, &connector).await?; - let should_continue_further = access_token::update_router_data_with_access_token_result( + let mut should_continue_further = access_token::update_router_data_with_access_token_result( &add_access_token_result, &mut router_data, &call_connector_action, ); - let should_continue_further = router_data + let add_create_order_result = router_data .create_order_at_connector(state, &connector, should_continue_further) .await?; + if add_create_order_result.is_create_order_performed { + if let Ok(order_id_opt) = &add_create_order_result.create_order_result { + payment_data.set_connector_response_reference_id(order_id_opt.clone()); + } + should_continue_further = router_data + .update_router_data_with_create_order_result( + add_create_order_result, + should_continue_further, + ) + .await?; + } + // In case of authorize flow, pre-task and post-tasks are being called in build request // if we do not want to proceed further, then the function will return Ok(None, false) let (connector_request, should_continue_further) = if should_continue_further { @@ -3819,7 +3908,7 @@ where connector_request, business_profile, header_payload.clone(), - all_keys_required, + return_raw_connector_response, ) .await } else { @@ -3851,7 +3940,7 @@ pub async fn proxy_for_call_connector_service<F, RouterDReq, ApiRequest, D>( header_payload: HeaderPayload, business_profile: &domain::Profile, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<( RouterData<F, RouterDReq, router_types::PaymentsResponseData>, helpers::MerchantConnectorAccountType, @@ -3992,7 +4081,7 @@ where connector_request, business_profile, header_payload.clone(), - all_keys_required, + return_raw_connector_response, ) .await } else { @@ -4019,7 +4108,7 @@ pub async fn proxy_for_call_connector_service<F, RouterDReq, ApiRequest, D>( call_connector_action: CallConnectorAction, header_payload: HeaderPayload, business_profile: &domain::Profile, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<RouterData<F, RouterDReq, router_types::PaymentsResponseData>> where F: Send + Clone + Sync, @@ -4116,7 +4205,7 @@ where connector_request, business_profile, header_payload.clone(), - all_keys_required, + return_raw_connector_response, ) .await } else { @@ -4143,7 +4232,7 @@ pub async fn internal_call_connector_service<F, RouterDReq, ApiRequest, D>( call_connector_action: CallConnectorAction, header_payload: HeaderPayload, business_profile: &domain::Profile, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<RouterData<F, RouterDReq, router_types::PaymentsResponseData>> where F: Send + Clone + Sync, @@ -4211,10 +4300,22 @@ where &call_connector_action, ); - let should_continue_further = router_data + let add_create_order_result = router_data .create_order_at_connector(state, &connector, should_continue_further) .await?; + if add_create_order_result.is_create_order_performed { + if let Ok(order_id_opt) = &add_create_order_result.create_order_result { + payment_data.set_connector_response_reference_id(order_id_opt.clone()); + } + should_continue_further = router_data + .update_router_data_with_create_order_result( + add_create_order_result, + should_continue_further, + ) + .await?; + } + let (connector_request, should_continue_further) = if should_continue_further { router_data .build_flow_specific_connector_request(state, &connector, call_connector_action.clone()) @@ -4247,7 +4348,7 @@ where connector_request, business_profile, header_payload.clone(), - all_keys_required, + return_raw_connector_response, ) .await } else { @@ -4509,7 +4610,7 @@ pub async fn call_multiple_connectors_service<F, Op, Req, D>( _session_surcharge_details: Option<api::SessionSurchargeDetails>, business_profile: &domain::Profile, header_payload: HeaderPayload, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<D> where Op: Debug, @@ -4560,7 +4661,7 @@ where None, business_profile, header_payload.clone(), - all_keys_required, + return_raw_connector_response, ); join_handlers.push(res); @@ -4620,7 +4721,7 @@ pub async fn call_multiple_connectors_service<F, Op, Req, D>( session_surcharge_details: Option<api::SessionSurchargeDetails>, business_profile: &domain::Profile, header_payload: HeaderPayload, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<D> where Op: Debug, @@ -4682,7 +4783,7 @@ where None, business_profile, header_payload.clone(), - all_keys_required, + return_raw_connector_response, ); join_handlers.push(res); @@ -8894,6 +8995,7 @@ pub trait OperationSessionGetters<F> { fn get_token_data(&self) -> Option<&storage::PaymentTokenData>; fn get_mandate_connector(&self) -> Option<&MandateConnectorDetails>; fn get_force_sync(&self) -> Option<bool>; + #[cfg(feature = "v1")] fn get_all_keys_required(&self) -> Option<bool>; fn get_capture_method(&self) -> Option<enums::CaptureMethod>; fn get_merchant_connector_id_in_attempt(&self) -> Option<id_type::MerchantConnectorAccountId>; @@ -8903,6 +9005,8 @@ pub trait OperationSessionGetters<F> { ) -> Option<common_types::domain::MerchantConnectorAuthDetails>; fn get_connector_customer_id(&self) -> Option<String>; + + #[cfg(feature = "v1")] fn get_whole_connector_response(&self) -> Option<String>; #[cfg(feature = "v1")] @@ -8981,6 +9085,8 @@ pub trait OperationSessionSetters<F> { #[cfg(feature = "v2")] fn set_connector_request_reference_id(&mut self, reference_id: Option<String>); + fn set_connector_response_reference_id(&mut self, reference_id: Option<String>); + #[cfg(feature = "v2")] fn set_vault_session_details( &mut self, @@ -9293,6 +9399,10 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentData<F> { ) { self.payment_attempt.routing_approach = routing_approach; } + + fn set_connector_response_reference_id(&mut self, reference_id: Option<String>) { + self.payment_attempt.connector_response_reference_id = reference_id; + } } #[cfg(feature = "v2")] @@ -9447,14 +9557,6 @@ impl<F: Clone> OperationSessionGetters<F> for PaymentIntentData<F> { todo!(); } - fn get_all_keys_required(&self) -> Option<bool> { - todo!(); - } - - fn get_whole_connector_response(&self) -> Option<String> { - todo!(); - } - fn get_pre_routing_result( &self, ) -> Option<HashMap<enums::PaymentMethodType, domain::PreRoutingConnectorChoice>> { @@ -9573,6 +9675,10 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentIntentData<F> { todo!() } + fn set_connector_response_reference_id(&mut self, reference_id: Option<String>) { + todo!() + } + fn set_vault_session_details( &mut self, vault_session_details: Option<api::VaultSessionDetails>, @@ -9738,14 +9844,6 @@ impl<F: Clone> OperationSessionGetters<F> for PaymentConfirmData<F> { Some(&self.payment_attempt) } - fn get_all_keys_required(&self) -> Option<bool> { - todo!() - } - - fn get_whole_connector_response(&self) -> Option<String> { - todo!() - } - fn get_pre_routing_result( &self, ) -> Option<HashMap<enums::PaymentMethodType, domain::PreRoutingConnectorChoice>> { @@ -9869,6 +9967,10 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentConfirmData<F> { self.payment_attempt.connector_request_reference_id = reference_id; } + fn set_connector_response_reference_id(&mut self, reference_id: Option<String>) { + self.payment_attempt.connector_response_reference_id = reference_id; + } + fn set_vault_session_details( &mut self, external_vault_session_details: Option<api::VaultSessionDetails>, @@ -10034,14 +10136,6 @@ impl<F: Clone> OperationSessionGetters<F> for PaymentStatusData<F> { Some(&self.payment_attempt) } - fn get_all_keys_required(&self) -> Option<bool> { - todo!() - } - - fn get_whole_connector_response(&self) -> Option<String> { - todo!() - } - fn get_pre_routing_result( &self, ) -> Option<HashMap<enums::PaymentMethodType, domain::PreRoutingConnectorChoice>> { @@ -10161,6 +10255,10 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentStatusData<F> { todo!() } + fn set_connector_response_reference_id(&mut self, reference_id: Option<String>) { + todo!() + } + fn set_vault_session_details( &mut self, external_vault_session_details: Option<api::VaultSessionDetails>, @@ -10327,13 +10425,6 @@ impl<F: Clone> OperationSessionGetters<F> for PaymentCaptureData<F> { Some(&self.payment_attempt) } - fn get_all_keys_required(&self) -> Option<bool> { - todo!(); - } - - fn get_whole_connector_response(&self) -> Option<String> { - todo!(); - } fn get_pre_routing_result( &self, ) -> Option<HashMap<enums::PaymentMethodType, domain::PreRoutingConnectorChoice>> { @@ -10453,6 +10544,10 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentCaptureData<F> { todo!() } + fn set_connector_response_reference_id(&mut self, reference_id: Option<String>) { + todo!() + } + fn set_vault_session_details( &mut self, external_vault_session_details: Option<api::VaultSessionDetails>, @@ -10614,13 +10709,6 @@ impl<F: Clone> OperationSessionGetters<F> for PaymentAttemptListData<F> { todo!() } - fn get_all_keys_required(&self) -> Option<bool> { - todo!(); - } - - fn get_whole_connector_response(&self) -> Option<String> { - todo!(); - } fn get_pre_routing_result( &self, ) -> Option<HashMap<enums::PaymentMethodType, domain::PreRoutingConnectorChoice>> { diff --git a/crates/router/src/core/payments/flows.rs b/crates/router/src/core/payments/flows.rs index 2b681202743..5cc7cfa777e 100644 --- a/crates/router/src/core/payments/flows.rs +++ b/crates/router/src/core/payments/flows.rs @@ -78,7 +78,7 @@ pub trait Feature<F, T> { connector_request: Option<services::Request>, business_profile: &domain::Profile, header_payload: hyperswitch_domain_models::payments::HeaderPayload, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> where Self: Sized, @@ -182,6 +182,22 @@ pub trait Feature<F, T> { &mut self, _state: &SessionState, _connector: &api::ConnectorData, + _should_continue_payment: bool, + ) -> RouterResult<types::CreateOrderResult> + where + F: Clone, + Self: Sized, + dyn api::Connector: services::ConnectorIntegration<F, T, types::PaymentsResponseData>, + { + Ok(types::CreateOrderResult { + create_order_result: Ok(None), + is_create_order_performed: false, + }) + } + + async fn update_router_data_with_create_order_result( + &mut self, + _create_order_result: types::CreateOrderResult, should_continue_payment: bool, ) -> RouterResult<bool> where diff --git a/crates/router/src/core/payments/flows/approve_flow.rs b/crates/router/src/core/payments/flows/approve_flow.rs index 30b7b834f5a..e2f671d914b 100644 --- a/crates/router/src/core/payments/flows/approve_flow.rs +++ b/crates/router/src/core/payments/flows/approve_flow.rs @@ -80,7 +80,7 @@ impl Feature<api::Approve, types::PaymentsApproveData> _connector_request: Option<services::Request>, _business_profile: &domain::Profile, _header_payload: hyperswitch_domain_models::payments::HeaderPayload, - _all_keys_required: Option<bool>, + _return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { Err(ApiErrorResponse::NotImplemented { message: NotImplementedMessage::Reason("Flow not supported".to_string()), diff --git a/crates/router/src/core/payments/flows/authorize_flow.rs b/crates/router/src/core/payments/flows/authorize_flow.rs index ace3588c229..4df6ae9fe91 100644 --- a/crates/router/src/core/payments/flows/authorize_flow.rs +++ b/crates/router/src/core/payments/flows/authorize_flow.rs @@ -171,7 +171,7 @@ impl Feature<api::Authorize, types::PaymentsAuthorizeData> for types::PaymentsAu connector_request: Option<services::Request>, business_profile: &domain::Profile, header_payload: hyperswitch_domain_models::payments::HeaderPayload, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { let connector_integration: services::BoxedPaymentConnectorIntegrationInterface< api::Authorize, @@ -188,7 +188,7 @@ impl Feature<api::Authorize, types::PaymentsAuthorizeData> for types::PaymentsAu &self, call_connector_action.clone(), connector_request, - all_keys_required, + return_raw_connector_response, ) .await .to_payment_failed_response()?; @@ -422,17 +422,92 @@ impl Feature<api::Authorize, types::PaymentsAuthorizeData> for types::PaymentsAu state: &SessionState, connector: &api::ConnectorData, should_continue_payment: bool, - ) -> RouterResult<bool> { - let create_order_result = - create_order_at_connector(self, state, connector, should_continue_payment).await?; + ) -> RouterResult<types::CreateOrderResult> { + if connector + .connector_name + .requires_order_creation_before_payment(self.payment_method) + && should_continue_payment + { + let connector_integration: services::BoxedPaymentConnectorIntegrationInterface< + api::CreateOrder, + types::CreateOrderRequestData, + types::PaymentsResponseData, + > = connector.connector.get_connector_integration(); + + let request_data = types::CreateOrderRequestData::try_from(self.request.clone())?; + + let response_data: Result<types::PaymentsResponseData, types::ErrorResponse> = + Err(types::ErrorResponse::default()); + + let createorder_router_data = + helpers::router_data_type_conversion::<_, api::CreateOrder, _, _, _, _>( + self.clone(), + request_data, + response_data, + ); - let should_continue_payment = update_router_data_with_create_order_result( - create_order_result, - self, - should_continue_payment, - )?; + let resp = services::execute_connector_processing_step( + state, + connector_integration, + &createorder_router_data, + payments::CallConnectorAction::Trigger, + None, + None, + ) + .await + .to_payment_failed_response()?; + + let create_order_resp = match resp.response { + Ok(res) => { + if let types::PaymentsResponseData::PaymentsCreateOrderResponse { order_id } = + res + { + Ok(Some(order_id)) + } else { + Err(error_stack::report!(ApiErrorResponse::InternalServerError) + .attach_printable(format!( + "Unexpected response format from connector: {res:?}", + )))? + } + } + Err(error) => Err(error), + }; + + Ok(types::CreateOrderResult { + create_order_result: create_order_resp, + is_create_order_performed: true, + }) + } else { + Ok(types::CreateOrderResult { + create_order_result: Ok(None), + is_create_order_performed: false, + }) + } + } - Ok(should_continue_payment) + async fn update_router_data_with_create_order_result( + &mut self, + create_order_result: types::CreateOrderResult, + should_continue_further: bool, + ) -> RouterResult<bool> { + if create_order_result.is_create_order_performed { + match create_order_result.create_order_result { + Ok(Some(order_id)) => { + self.request.order_id = Some(order_id.clone()); + self.response = + Ok(types::PaymentsResponseData::PaymentsCreateOrderResponse { order_id }); + Ok(true) + } + Ok(None) => Err(error_stack::report!(ApiErrorResponse::InternalServerError) + .attach_printable("Order Id not found."))?, + Err(err) => { + self.response = Err(err.clone()); + Ok(false) + } + } + } else { + Ok(should_continue_further) + } } } @@ -719,102 +794,3 @@ async fn process_capture_flow( router_data.response = Ok(updated_response); Ok(router_data) } - -async fn create_order_at_connector<F: Clone>( - router_data: &mut types::RouterData< - F, - types::PaymentsAuthorizeData, - types::PaymentsResponseData, - >, - state: &SessionState, - connector: &api::ConnectorData, - should_continue_payment: bool, -) -> RouterResult<types::CreateOrderResult> { - if connector - .connector_name - .requires_order_creation_before_payment(router_data.payment_method) - && should_continue_payment - { - let connector_integration: services::BoxedPaymentConnectorIntegrationInterface< - api::CreateOrder, - types::CreateOrderRequestData, - types::PaymentsResponseData, - > = connector.connector.get_connector_integration(); - - let request_data = types::CreateOrderRequestData::try_from(router_data.request.clone())?; - - let response_data: Result<types::PaymentsResponseData, types::ErrorResponse> = - Err(types::ErrorResponse::default()); - - let createorder_router_data = - helpers::router_data_type_conversion::<_, api::CreateOrder, _, _, _, _>( - router_data.clone(), - request_data, - response_data, - ); - - let resp = services::execute_connector_processing_step( - state, - connector_integration, - &createorder_router_data, - payments::CallConnectorAction::Trigger, - None, - None, - ) - .await - .to_payment_failed_response()?; - - let create_order_resp = match resp.response { - Ok(res) => { - if let types::PaymentsResponseData::PaymentsCreateOrderResponse { order_id } = res { - Ok(Some(order_id)) - } else { - Err(error_stack::report!(ApiErrorResponse::InternalServerError) - .attach_printable(format!( - "Unexpected response format from connector: {res:?}", - )))? - } - } - Err(error) => Err(error), - }; - - Ok(types::CreateOrderResult { - create_order_result: create_order_resp, - is_create_order_performed: true, - }) - } else { - Ok(types::CreateOrderResult { - create_order_result: Ok(None), - is_create_order_performed: false, - }) - } -} - -fn update_router_data_with_create_order_result<F>( - create_order_result: types::CreateOrderResult, - router_data: &mut types::RouterData< - F, - types::PaymentsAuthorizeData, - types::PaymentsResponseData, - >, - should_continue_further: bool, -) -> RouterResult<bool> { - if create_order_result.is_create_order_performed { - match create_order_result.create_order_result { - Ok(Some(order_id)) => { - router_data.request.order_id = Some(order_id.clone()); - router_data.response = - Ok(types::PaymentsResponseData::PaymentsCreateOrderResponse { order_id }); - Ok(true) - } - Ok(None) => Err(error_stack::report!(ApiErrorResponse::InternalServerError) - .attach_printable("Order Id not found."))?, - Err(err) => { - router_data.response = Err(err.clone()); - Ok(false) - } - } - } else { - Ok(should_continue_further) - } -} diff --git a/crates/router/src/core/payments/flows/cancel_flow.rs b/crates/router/src/core/payments/flows/cancel_flow.rs index fc27a600421..046213dbe52 100644 --- a/crates/router/src/core/payments/flows/cancel_flow.rs +++ b/crates/router/src/core/payments/flows/cancel_flow.rs @@ -79,7 +79,7 @@ impl Feature<api::Void, types::PaymentsCancelData> connector_request: Option<services::Request>, _business_profile: &domain::Profile, _header_payload: hyperswitch_domain_models::payments::HeaderPayload, - _all_keys_required: Option<bool>, + _return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { metrics::PAYMENT_CANCEL_COUNT.add( 1, diff --git a/crates/router/src/core/payments/flows/capture_flow.rs b/crates/router/src/core/payments/flows/capture_flow.rs index 545b3fc2631..09d60db9a48 100644 --- a/crates/router/src/core/payments/flows/capture_flow.rs +++ b/crates/router/src/core/payments/flows/capture_flow.rs @@ -108,7 +108,7 @@ impl Feature<api::Capture, types::PaymentsCaptureData> connector_request: Option<services::Request>, _business_profile: &domain::Profile, _header_payload: hyperswitch_domain_models::payments::HeaderPayload, - _all_keys_required: Option<bool>, + _return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { let connector_integration: services::BoxedPaymentConnectorIntegrationInterface< api::Capture, diff --git a/crates/router/src/core/payments/flows/complete_authorize_flow.rs b/crates/router/src/core/payments/flows/complete_authorize_flow.rs index 4fb4e7574a4..d734f195cec 100644 --- a/crates/router/src/core/payments/flows/complete_authorize_flow.rs +++ b/crates/router/src/core/payments/flows/complete_authorize_flow.rs @@ -100,7 +100,7 @@ impl Feature<api::CompleteAuthorize, types::CompleteAuthorizeData> connector_request: Option<services::Request>, business_profile: &domain::Profile, header_payload: hyperswitch_domain_models::payments::HeaderPayload, - _all_keys_required: Option<bool>, + _return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { let connector_integration: services::BoxedPaymentConnectorIntegrationInterface< api::CompleteAuthorize, diff --git a/crates/router/src/core/payments/flows/incremental_authorization_flow.rs b/crates/router/src/core/payments/flows/incremental_authorization_flow.rs index 092be332191..c7dee2ad9e8 100644 --- a/crates/router/src/core/payments/flows/incremental_authorization_flow.rs +++ b/crates/router/src/core/payments/flows/incremental_authorization_flow.rs @@ -87,7 +87,7 @@ impl Feature<api::IncrementalAuthorization, types::PaymentsIncrementalAuthorizat connector_request: Option<services::Request>, _business_profile: &domain::Profile, _header_payload: hyperswitch_domain_models::payments::HeaderPayload, - _all_keys_required: Option<bool>, + _return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { let connector_integration: services::BoxedPaymentConnectorIntegrationInterface< api::IncrementalAuthorization, diff --git a/crates/router/src/core/payments/flows/post_session_tokens_flow.rs b/crates/router/src/core/payments/flows/post_session_tokens_flow.rs index e29739cf01b..118dd17a10a 100644 --- a/crates/router/src/core/payments/flows/post_session_tokens_flow.rs +++ b/crates/router/src/core/payments/flows/post_session_tokens_flow.rs @@ -87,7 +87,7 @@ impl Feature<api::PostSessionTokens, types::PaymentsPostSessionTokensData> connector_request: Option<services::Request>, _business_profile: &domain::Profile, _header_payload: hyperswitch_domain_models::payments::HeaderPayload, - _all_keys_required: Option<bool>, + _return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { let connector_integration: services::BoxedPaymentConnectorIntegrationInterface< api::PostSessionTokens, diff --git a/crates/router/src/core/payments/flows/psync_flow.rs b/crates/router/src/core/payments/flows/psync_flow.rs index 38fc08a1df1..87536525beb 100644 --- a/crates/router/src/core/payments/flows/psync_flow.rs +++ b/crates/router/src/core/payments/flows/psync_flow.rs @@ -111,7 +111,7 @@ impl Feature<api::PSync, types::PaymentsSyncData> connector_request: Option<services::Request>, _business_profile: &domain::Profile, _header_payload: hyperswitch_domain_models::payments::HeaderPayload, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { let connector_integration: services::BoxedPaymentConnectorIntegrationInterface< api::PSync, @@ -134,7 +134,7 @@ impl Feature<api::PSync, types::PaymentsSyncData> pending_connector_capture_id_list, call_connector_action, connector_integration, - all_keys_required, + return_raw_connector_response, ) .await?; // Initiating Integrity checks @@ -156,7 +156,7 @@ impl Feature<api::PSync, types::PaymentsSyncData> &self, call_connector_action, connector_request, - all_keys_required, + return_raw_connector_response, ) .await .to_payment_failed_response()?; @@ -241,7 +241,7 @@ where types::PaymentsSyncData, types::PaymentsResponseData, >, - _all_keys_required: Option<bool>, + _return_raw_connector_response: Option<bool>, ) -> RouterResult<Self>; } @@ -259,7 +259,7 @@ impl RouterDataPSync types::PaymentsSyncData, types::PaymentsResponseData, >, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { let mut capture_sync_response_map = HashMap::new(); if let payments::CallConnectorAction::HandleResponse(_) = call_connector_action { @@ -270,7 +270,7 @@ impl RouterDataPSync self, call_connector_action.clone(), None, - all_keys_required, + return_raw_connector_response, ) .await .to_payment_failed_response()?; @@ -289,7 +289,7 @@ impl RouterDataPSync &cloned_router_data, call_connector_action.clone(), None, - all_keys_required, + return_raw_connector_response, ) .await .to_payment_failed_response()?; diff --git a/crates/router/src/core/payments/flows/reject_flow.rs b/crates/router/src/core/payments/flows/reject_flow.rs index 852058dc377..efb34be54b3 100644 --- a/crates/router/src/core/payments/flows/reject_flow.rs +++ b/crates/router/src/core/payments/flows/reject_flow.rs @@ -79,7 +79,7 @@ impl Feature<api::Reject, types::PaymentsRejectData> _connector_request: Option<services::Request>, _business_profile: &domain::Profile, _header_payload: hyperswitch_domain_models::payments::HeaderPayload, - _all_keys_required: Option<bool>, + _return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { Err(ApiErrorResponse::NotImplemented { message: NotImplementedMessage::Reason("Flow not supported".to_string()), diff --git a/crates/router/src/core/payments/flows/session_flow.rs b/crates/router/src/core/payments/flows/session_flow.rs index a805f455b4b..ae0450f28f0 100644 --- a/crates/router/src/core/payments/flows/session_flow.rs +++ b/crates/router/src/core/payments/flows/session_flow.rs @@ -121,7 +121,7 @@ impl Feature<api::Session, types::PaymentsSessionData> for types::PaymentsSessio _connector_request: Option<services::Request>, business_profile: &domain::Profile, header_payload: hyperswitch_domain_models::payments::HeaderPayload, - _all_keys_required: Option<bool>, + _return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { metrics::SESSION_TOKEN_CREATED.add( 1, diff --git a/crates/router/src/core/payments/flows/session_update_flow.rs b/crates/router/src/core/payments/flows/session_update_flow.rs index e717ff50c26..cd42f855c11 100644 --- a/crates/router/src/core/payments/flows/session_update_flow.rs +++ b/crates/router/src/core/payments/flows/session_update_flow.rs @@ -87,7 +87,7 @@ impl Feature<api::SdkSessionUpdate, types::SdkPaymentsSessionUpdateData> connector_request: Option<services::Request>, _business_profile: &domain::Profile, _header_payload: hyperswitch_domain_models::payments::HeaderPayload, - _all_keys_required: Option<bool>, + _return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { let connector_integration: services::BoxedPaymentConnectorIntegrationInterface< api::SdkSessionUpdate, diff --git a/crates/router/src/core/payments/flows/setup_mandate_flow.rs b/crates/router/src/core/payments/flows/setup_mandate_flow.rs index a5bcdb4f55e..f99d13bd312 100644 --- a/crates/router/src/core/payments/flows/setup_mandate_flow.rs +++ b/crates/router/src/core/payments/flows/setup_mandate_flow.rs @@ -117,7 +117,7 @@ impl Feature<api::SetupMandate, types::SetupMandateRequestData> for types::Setup connector_request: Option<services::Request>, _business_profile: &domain::Profile, _header_payload: hyperswitch_domain_models::payments::HeaderPayload, - _all_keys_required: Option<bool>, + _return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { let connector_integration: services::BoxedPaymentConnectorIntegrationInterface< api::SetupMandate, diff --git a/crates/router/src/core/payments/flows/update_metadata_flow.rs b/crates/router/src/core/payments/flows/update_metadata_flow.rs index a6a35833255..f654b7ead13 100644 --- a/crates/router/src/core/payments/flows/update_metadata_flow.rs +++ b/crates/router/src/core/payments/flows/update_metadata_flow.rs @@ -86,7 +86,7 @@ impl Feature<api::UpdateMetadata, types::PaymentsUpdateMetadataData> connector_request: Option<services::Request>, _business_profile: &domain::Profile, _header_payload: hyperswitch_domain_models::payments::HeaderPayload, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { let connector_integration: services::BoxedPaymentConnectorIntegrationInterface< api::UpdateMetadata, @@ -100,7 +100,7 @@ impl Feature<api::UpdateMetadata, types::PaymentsUpdateMetadataData> &self, call_connector_action, connector_request, - all_keys_required, + return_raw_connector_response, ) .await .to_payment_failed_response()?; diff --git a/crates/router/src/core/payments/helpers.rs b/crates/router/src/core/payments/helpers.rs index 4b7791bb084..5eaee11c18a 100644 --- a/crates/router/src/core/payments/helpers.rs +++ b/crates/router/src/core/payments/helpers.rs @@ -4175,7 +4175,7 @@ pub fn router_data_type_conversion<F1, F2, Req1, Req2, Res1, Res2>( connector_mandate_request_reference_id: router_data.connector_mandate_request_reference_id, authentication_id: router_data.authentication_id, psd2_sca_exemption_type: router_data.psd2_sca_exemption_type, - whole_connector_response: router_data.whole_connector_response, + raw_connector_response: router_data.raw_connector_response, } } diff --git a/crates/router/src/core/payments/operations/payment_confirm_intent.rs b/crates/router/src/core/payments/operations/payment_confirm_intent.rs index dce33895fde..8ab7ddcfa28 100644 --- a/crates/router/src/core/payments/operations/payment_confirm_intent.rs +++ b/crates/router/src/core/payments/operations/payment_confirm_intent.rs @@ -588,6 +588,11 @@ impl<F: Clone + Sync> UpdateTracker<F, PaymentConfirmData<F>, PaymentsConfirmInt .connector_request_reference_id .clone(); + let connector_response_reference_id = payment_data + .payment_attempt + .connector_response_reference_id + .clone(); + let payment_attempt_update = match &payment_data.payment_method { // In the case of a tokenized payment method, we update the payment attempt with the tokenized payment method details. Some(payment_method) => { @@ -611,6 +616,7 @@ impl<F: Clone + Sync> UpdateTracker<F, PaymentConfirmData<F>, PaymentsConfirmInt merchant_connector_id, authentication_type, connector_request_reference_id, + connector_response_reference_id, } } }; diff --git a/crates/router/src/core/payments/operations/payment_response.rs b/crates/router/src/core/payments/operations/payment_response.rs index ff618a7b349..939679ef51f 100644 --- a/crates/router/src/core/payments/operations/payment_response.rs +++ b/crates/router/src/core/payments/operations/payment_response.rs @@ -1412,7 +1412,7 @@ async fn payment_response_update_tracker<F: Clone, T: types::Capturable>( .as_mut() .map(\|info\| info.status = status) }); - payment_data.whole_connector_response = router_data.whole_connector_response.clone(); + payment_data.whole_connector_response = router_data.raw_connector_response.clone(); // TODO: refactor of gsm_error_category with respective feature flag #[allow(unused_variables)] diff --git a/crates/router/src/core/payments/operations/proxy_payments_intent.rs b/crates/router/src/core/payments/operations/proxy_payments_intent.rs index a65f4cdd99e..30ea6913c6d 100644 --- a/crates/router/src/core/payments/operations/proxy_payments_intent.rs +++ b/crates/router/src/core/payments/operations/proxy_payments_intent.rs @@ -409,6 +409,11 @@ impl<F: Clone + Sync> UpdateTracker<F, PaymentConfirmData<F>, ProxyPaymentsReque .connector_request_reference_id .clone(); + let connector_response_reference_id = payment_data + .payment_attempt + .connector_response_reference_id + .clone(); + let payment_attempt_update = hyperswitch_domain_models::payments::payment_attempt::PaymentAttemptUpdate::ConfirmIntent { status: attempt_status, updated_by: storage_scheme.to_string(), @@ -416,6 +421,7 @@ impl<F: Clone + Sync> UpdateTracker<F, PaymentConfirmData<F>, ProxyPaymentsReque merchant_connector_id, authentication_type, connector_request_reference_id, + connector_response_reference_id, }; let updated_payment_intent = db diff --git a/crates/router/src/core/payments/transformers.rs b/crates/router/src/core/payments/transformers.rs index 636b1da0bbc..71ff92b0bb2 100644 --- a/crates/router/src/core/payments/transformers.rs +++ b/crates/router/src/core/payments/transformers.rs @@ -171,7 +171,7 @@ where connector_mandate_request_reference_id, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) } @@ -399,7 +399,7 @@ pub async fn construct_payment_router_data_for_authorize<'a>( connector_mandate_request_reference_id, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) @@ -563,7 +563,7 @@ pub async fn construct_payment_router_data_for_capture<'a>( connector_mandate_request_reference_id, psd2_sca_exemption_type: None, authentication_id: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) @@ -626,6 +626,7 @@ pub async fn construct_router_data_for_psync<'a>( // TODO: Get the charges object from feature metadata split_payments: None, payment_experience: None, + connector_reference_id: attempt.connector_response_reference_id.clone(), }; // TODO: evaluate the fields in router data, if they are required or not @@ -689,7 +690,7 @@ pub async fn construct_router_data_for_psync<'a>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) @@ -871,7 +872,7 @@ pub async fn construct_payment_router_data_for_sdk_session<'a>( connector_mandate_request_reference_id: None, psd2_sca_exemption_type: None, authentication_id: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) @@ -1088,7 +1089,7 @@ pub async fn construct_payment_router_data_for_setup_mandate<'a>( connector_mandate_request_reference_id, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) @@ -1287,7 +1288,7 @@ where connector_mandate_request_reference_id, authentication_id: None, psd2_sca_exemption_type: payment_data.payment_intent.psd2_sca_exemption_type, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) @@ -1477,7 +1478,7 @@ pub async fn construct_payment_router_data_for_update_metadata<'a>( connector_mandate_request_reference_id, authentication_id: None, psd2_sca_exemption_type: payment_data.payment_intent.psd2_sca_exemption_type, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) @@ -1524,6 +1525,7 @@ where Self: Sized, { #[cfg(feature = "v2")] + #[allow(clippy::too_many_arguments)] fn generate_response( self, state: &SessionState, @@ -1532,6 +1534,7 @@ where is_latency_header_enabled: Option<bool>, merchant_context: &domain::MerchantContext, profile: &domain::Profile, + connector_response_data: Option<common_types::domain::ConnectorResponseData>, ) -> RouterResponse<Response>; } @@ -1549,6 +1552,7 @@ where is_latency_header_enabled: Option<bool>, merchant_context: &domain::MerchantContext, profile: &domain::Profile, + _connector_response_data: Option<common_types::domain::ConnectorResponseData>, ) -> RouterResponse<api_models::payments::PaymentsCaptureResponse> { let payment_intent = &self.payment_intent; let payment_attempt = &self.payment_attempt; @@ -1872,6 +1876,7 @@ where is_latency_header_enabled: Option<bool>, merchant_context: &domain::MerchantContext, profile: &domain::Profile, + connector_response_data: Option<common_types::domain::ConnectorResponseData>, ) -> RouterResponse<api_models::payments::PaymentsResponse> { let payment_intent = self.payment_intent; let payment_attempt = self.payment_attempt; @@ -1897,6 +1902,9 @@ where let payment_address = self.payment_address; + let raw_connector_response = + connector_response_data.and_then(\|data\| data.raw_connector_response); + let payment_method_data = Some(api_models::payments::PaymentMethodDataResponseWithBilling { payment_method_data: None, @@ -1951,7 +1959,7 @@ where payment_method_subtype: Some(payment_attempt.payment_method_subtype), next_action, connector_transaction_id: payment_attempt.connector_payment_id.clone(), - connector_reference_id: None, + connector_reference_id: payment_attempt.connector_response_reference_id.clone(), connector_token_details, merchant_connector_id, browser_info: None, @@ -1965,6 +1973,7 @@ where shipping: None, //TODO: add this is_iframe_redirection_enabled: None, merchant_reference_id: payment_intent.merchant_reference_id.clone(), + raw_connector_response, }; Ok(services::ApplicationResponse::JsonWithHeaders(( @@ -1988,6 +1997,7 @@ where is_latency_header_enabled: Option<bool>, merchant_context: &domain::MerchantContext, profile: &domain::Profile, + connector_response_data: Option<common_types::domain::ConnectorResponseData>, ) -> RouterResponse<api_models::payments::PaymentsResponse> { let payment_intent = self.payment_intent; let payment_attempt = &self.payment_attempt; @@ -2022,6 +2032,9 @@ where .map(From::from), }); + let raw_connector_response = + connector_response_data.and_then(\|data\| data.raw_connector_response); + let connector_token_details = self .payment_attempt .connector_token_details @@ -2047,7 +2060,7 @@ where payment_method_type: Some(payment_attempt.payment_method_type), payment_method_subtype: Some(payment_attempt.payment_method_subtype), connector_transaction_id: payment_attempt.connector_payment_id.clone(), - connector_reference_id: None, + connector_reference_id: payment_attempt.connector_response_reference_id.clone(), merchant_connector_id, browser_info: None, connector_token_details, @@ -2060,6 +2073,7 @@ where return_url, is_iframe_redirection_enabled: payment_intent.is_iframe_redirection_enabled, merchant_reference_id: payment_intent.merchant_reference_id.clone(), + raw_connector_response, }; Ok(services::ApplicationResponse::JsonWithHeaders(( @@ -2083,6 +2097,7 @@ where _is_latency_header_enabled: Option<bool>, _merchant_context: &domain::MerchantContext, _profile: &domain::Profile, + _connector_response_data: Option<common_types::domain::ConnectorResponseData>, ) -> RouterResponse<api_models::payments::PaymentAttemptResponse> { let payment_attempt = self.payment_attempt; let response = api_models::payments::PaymentAttemptResponse::foreign_from(&payment_attempt); @@ -2107,6 +2122,7 @@ where _is_latency_header_enabled: Option<bool>, _merchant_context: &domain::MerchantContext, _profile: &domain::Profile, + _connector_response_data: Option<common_types::domain::ConnectorResponseData>, ) -> RouterResponse<api_models::payments::PaymentAttemptRecordResponse> { let payment_attempt = self.payment_attempt; let payment_intent = self.payment_intent; @@ -3718,6 +3734,10 @@ impl<F: Clone> TryFrom<PaymentAdditionalData<'_, F>> for types::PaymentsSyncData currency: payment_data.currency, split_payments: payment_data.payment_intent.split_payments, payment_experience: payment_data.payment_attempt.payment_experience, + connector_reference_id: payment_data + .payment_attempt + .connector_response_reference_id + .clone(), }) } } diff --git a/crates/router/src/core/relay/utils.rs b/crates/router/src/core/relay/utils.rs index effc2178ec3..1adacfbe949 100644 --- a/crates/router/src/core/relay/utils.rs +++ b/crates/router/src/core/relay/utils.rs @@ -143,7 +143,7 @@ pub async fn construct_relay_refund_router_data<F>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) diff --git a/crates/router/src/core/revenue_recovery/api.rs b/crates/router/src/core/revenue_recovery/api.rs index 3627d5062c6..052f4351c7e 100644 --- a/crates/router/src/core/revenue_recovery/api.rs +++ b/crates/router/src/core/revenue_recovery/api.rs @@ -31,7 +31,7 @@ pub async fn call_psync_api( force_sync: false, param: None, expand_attempts: true, - all_keys_required: None, + return_raw_connector_response: None, merchant_connector_details: None, }; let merchant_context_from_revenue_recovery_data = @@ -53,7 +53,7 @@ pub async fn call_psync_api( ) .await?; - let (payment_data, _req, _, _, _) = Box::pin(payments::payments_operation_core::< + let (payment_data, _req, _, _, _, _) = Box::pin(payments::payments_operation_core::< api_types::PSync, _, _, diff --git a/crates/router/src/core/unified_authentication_service/utils.rs b/crates/router/src/core/unified_authentication_service/utils.rs index 6c841a02d31..20ac12a9940 100644 --- a/crates/router/src/core/unified_authentication_service/utils.rs +++ b/crates/router/src/core/unified_authentication_service/utils.rs @@ -124,7 +124,7 @@ pub fn construct_uas_router_data<F: Clone, Req, Res>( connector_mandate_request_reference_id: None, authentication_id, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }) } diff --git a/crates/router/src/core/utils.rs b/crates/router/src/core/utils.rs index d1d298bd17b..c097b3fbfe6 100644 --- a/crates/router/src/core/utils.rs +++ b/crates/router/src/core/utils.rs @@ -234,7 +234,7 @@ pub async fn construct_payout_router_data<'a, F>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) @@ -401,7 +401,7 @@ pub async fn construct_refund_router_data<'a, F>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) @@ -604,7 +604,7 @@ pub async fn construct_refund_router_data<'a, F>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) @@ -1028,7 +1028,7 @@ pub async fn construct_accept_dispute_router_data<'a>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) } @@ -1126,7 +1126,7 @@ pub async fn construct_submit_evidence_router_data<'a>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) } @@ -1230,7 +1230,7 @@ pub async fn construct_upload_file_router_data<'a>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) } @@ -1353,7 +1353,7 @@ pub async fn construct_payments_dynamic_tax_calculation_router_data<F: Clone>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) } @@ -1454,7 +1454,7 @@ pub async fn construct_defend_dispute_router_data<'a>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) } @@ -1549,7 +1549,7 @@ pub async fn construct_retrieve_file_router_data<'a>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) } diff --git a/crates/router/src/core/webhooks/incoming_v2.rs b/crates/router/src/core/webhooks/incoming_v2.rs index 0cf8b2bfe7b..464781876cf 100644 --- a/crates/router/src/core/webhooks/incoming_v2.rs +++ b/crates/router/src/core/webhooks/incoming_v2.rs @@ -456,31 +456,37 @@ async fn payments_incoming_webhook_flow( ) .await?; - let (payment_data, _req, customer, connector_http_status_code, external_latency) = - Box::pin(payments::payments_operation_core::< - api::PSync, - _, - _, - _, - PaymentStatusData<api::PSync>, - >( - &state, - req_state, - merchant_context.clone(), - &profile, - payments::operations::PaymentGet, - api::PaymentsRetrieveRequest { - force_sync: true, - expand_attempts: false, - param: None, - all_keys_required: None, - merchant_connector_details: None, - }, - get_trackers_response, - consume_or_trigger_flow, - HeaderPayload::default(), - )) - .await?; + let ( + payment_data, + _req, + customer, + connector_http_status_code, + external_latency, + connector_response_data, + ) = Box::pin(payments::payments_operation_core::< + api::PSync, + _, + _, + _, + PaymentStatusData<api::PSync>, + >( + &state, + req_state, + merchant_context.clone(), + &profile, + payments::operations::PaymentGet, + api::PaymentsRetrieveRequest { + force_sync: true, + expand_attempts: false, + param: None, + return_raw_connector_response: None, + merchant_connector_details: None, + }, + get_trackers_response, + consume_or_trigger_flow, + HeaderPayload::default(), + )) + .await?; let response = payment_data.generate_response( &state, @@ -489,6 +495,7 @@ async fn payments_incoming_webhook_flow( None, &merchant_context, &profile, + Some(connector_response_data), ); lock_action diff --git a/crates/router/src/core/webhooks/utils.rs b/crates/router/src/core/webhooks/utils.rs index 4cf0d784a05..c0c362a9dd3 100644 --- a/crates/router/src/core/webhooks/utils.rs +++ b/crates/router/src/core/webhooks/utils.rs @@ -133,7 +133,7 @@ pub async fn construct_webhook_router_data( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) } diff --git a/crates/router/src/routes/payments.rs b/crates/router/src/routes/payments.rs index e2363633dad..163bc2dab2e 100644 --- a/crates/router/src/routes/payments.rs +++ b/crates/router/src/routes/payments.rs @@ -2953,7 +2953,7 @@ pub async fn payment_status( force_sync: payload.force_sync, expand_attempts: payload.expand_attempts, param: payload.param.clone(), - all_keys_required: payload.all_keys_required, + return_raw_connector_response: payload.return_raw_connector_response, merchant_connector_details: None, }; diff --git a/crates/router/src/services/api.rs b/crates/router/src/services/api.rs index 57bb8ec2427..fabfe3e38d2 100644 --- a/crates/router/src/services/api.rs +++ b/crates/router/src/services/api.rs @@ -142,7 +142,7 @@ pub async fn execute_connector_processing_step< req: &'b types::RouterData<T, Req, Resp>, call_connector_action: payments::CallConnectorAction, connector_request: Option<Request>, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> CustomResult<types::RouterData<T, Req, Resp>, errors::ConnectorError> where T: Clone + Debug + 'static, @@ -302,7 +302,7 @@ where val + external_latency }), ); - if all_keys_required == Some(true) { + if return_raw_connector_response == Some(true) { let mut decoded = String::from_utf8(body.response.as_ref().to_vec()) .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; if decoded.starts_with('\u{feff}') { @@ -310,7 +310,7 @@ where .trim_start_matches('\u{feff}') .to_string(); } - data.whole_connector_response = Some(decoded); + data.raw_connector_response = Some(decoded); } Ok(data) } @@ -1076,13 +1076,17 @@ pub trait Authenticate { None } - fn get_all_keys_required(&self) -> Option<bool> { + fn should_return_raw_response(&self) -> Option<bool> { None } } #[cfg(feature = "v2")] -impl Authenticate for api_models::payments::PaymentsConfirmIntentRequest {} +impl Authenticate for api_models::payments::PaymentsConfirmIntentRequest { + fn should_return_raw_response(&self) -> Option<bool> { + self.return_raw_connector_response + } +} #[cfg(feature = "v2")] impl Authenticate for api_models::payments::ProxyPaymentsRequest {} @@ -1092,7 +1096,9 @@ impl Authenticate for api_models::payments::PaymentsRequest { self.client_secret.as_ref() } - fn get_all_keys_required(&self) -> Option<bool> { + fn should_return_raw_response(&self) -> Option<bool> { + // In v1, this maps to `all_keys_required` to retain backward compatibility. + // The equivalent field in v2 is `return_raw_connector_response`. self.all_keys_required } } @@ -1123,7 +1129,15 @@ impl Authenticate for api_models::payments::PaymentsPostSessionTokensRequest { impl Authenticate for api_models::payments::PaymentsUpdateMetadataRequest {} impl Authenticate for api_models::payments::PaymentsRetrieveRequest { - fn get_all_keys_required(&self) -> Option<bool> { + #[cfg(feature = "v2")] + fn should_return_raw_response(&self) -> Option<bool> { + self.return_raw_connector_response + } + + #[cfg(feature = "v1")] + fn should_return_raw_response(&self) -> Option<bool> { + // In v1, this maps to `all_keys_required` to retain backward compatibility. + // The equivalent field in v2 is `return_raw_connector_response`. self.all_keys_required } } diff --git a/crates/router/src/types.rs b/crates/router/src/types.rs index 52e3f267c84..dd64c5b3703 100644 --- a/crates/router/src/types.rs +++ b/crates/router/src/types.rs @@ -1151,7 +1151,7 @@ impl<F1, F2, T1, T2> ForeignFrom<(&RouterData<F1, T1, PaymentsResponseData>, T2) .clone(), authentication_id: data.authentication_id.clone(), psd2_sca_exemption_type: data.psd2_sca_exemption_type, - whole_connector_response: data.whole_connector_response.clone(), + raw_connector_response: data.raw_connector_response.clone(), } } } @@ -1219,7 +1219,7 @@ impl<F1, F2> psd2_sca_exemption_type: None, additional_merchant_data: data.additional_merchant_data.clone(), connector_mandate_request_reference_id: None, - whole_connector_response: None, + raw_connector_response: None, } } } diff --git a/crates/router/src/types/api/payments.rs b/crates/router/src/types/api/payments.rs index 62738680b1b..02fad384f59 100644 --- a/crates/router/src/types/api/payments.rs +++ b/crates/router/src/types/api/payments.rs @@ -5,7 +5,8 @@ pub use api_models::payments::{ }; #[cfg(feature = "v1")] pub use api_models::payments::{ - PaymentListFilterConstraints, PaymentListResponse, PaymentListResponseV2, + PaymentListFilterConstraints, PaymentListResponse, PaymentListResponseV2, PaymentRetrieveBody, + PaymentRetrieveBodyWithCredentials, }; pub use api_models::{ feature_matrix::{ @@ -18,18 +19,17 @@ pub use api_models::{ MandateValidationFields, NextActionType, OpenBankingSessionToken, PayLaterData, PaymentIdType, PaymentListConstraints, PaymentListFilters, PaymentListFiltersV2, PaymentMethodData, PaymentMethodDataRequest, PaymentMethodDataResponse, PaymentOp, - PaymentRetrieveBody, PaymentRetrieveBodyWithCredentials, PaymentsAggregateResponse, - PaymentsApproveRequest, PaymentsCancelRequest, PaymentsCaptureRequest, - PaymentsCompleteAuthorizeRequest, PaymentsDynamicTaxCalculationRequest, - PaymentsDynamicTaxCalculationResponse, PaymentsExternalAuthenticationRequest, - PaymentsIncrementalAuthorizationRequest, PaymentsManualUpdateRequest, - PaymentsPostSessionTokensRequest, PaymentsPostSessionTokensResponse, - PaymentsRedirectRequest, PaymentsRedirectionResponse, PaymentsRejectRequest, - PaymentsRequest, PaymentsResponse, PaymentsResponseForm, PaymentsRetrieveRequest, - PaymentsSessionRequest, PaymentsSessionResponse, PaymentsStartRequest, - PaymentsUpdateMetadataRequest, PaymentsUpdateMetadataResponse, PgRedirectResponse, - PhoneDetails, RedirectionResponse, SessionToken, UrlDetails, VaultSessionDetails, - VerifyRequest, VerifyResponse, VgsSessionDetails, WalletData, + PaymentsAggregateResponse, PaymentsApproveRequest, PaymentsCancelRequest, + PaymentsCaptureRequest, PaymentsCompleteAuthorizeRequest, + PaymentsDynamicTaxCalculationRequest, PaymentsDynamicTaxCalculationResponse, + PaymentsExternalAuthenticationRequest, PaymentsIncrementalAuthorizationRequest, + PaymentsManualUpdateRequest, PaymentsPostSessionTokensRequest, + PaymentsPostSessionTokensResponse, PaymentsRedirectRequest, PaymentsRedirectionResponse, + PaymentsRejectRequest, PaymentsRequest, PaymentsResponse, PaymentsResponseForm, + PaymentsRetrieveRequest, PaymentsSessionRequest, PaymentsSessionResponse, + PaymentsStartRequest, PaymentsUpdateMetadataRequest, PaymentsUpdateMetadataResponse, + PgRedirectResponse, PhoneDetails, RedirectionResponse, SessionToken, UrlDetails, + VaultSessionDetails, VerifyRequest, VerifyResponse, VgsSessionDetails, WalletData, }, }; pub use common_types::payments::{AcceptanceType, CustomerAcceptance, OnlineMandate}; diff --git a/crates/router/src/types/api/verify_connector.rs b/crates/router/src/types/api/verify_connector.rs index c9be34037cb..8298be10aab 100644 --- a/crates/router/src/types/api/verify_connector.rs +++ b/crates/router/src/types/api/verify_connector.rs @@ -127,7 +127,7 @@ impl VerifyConnectorData { connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, } } } diff --git a/crates/router/tests/connectors/aci.rs b/crates/router/tests/connectors/aci.rs index 61272a05877..cf0889931d8 100644 --- a/crates/router/tests/connectors/aci.rs +++ b/crates/router/tests/connectors/aci.rs @@ -133,7 +133,7 @@ fn construct_payment_router_data() -> types::PaymentsAuthorizeRouterData { connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, } } @@ -206,7 +206,7 @@ fn construct_refund_router_data<F>() -> types::RefundsRouterData<F> { connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, } } diff --git a/crates/router/tests/connectors/utils.rs b/crates/router/tests/connectors/utils.rs index bf9bc355334..db3aeddfb8c 100644 --- a/crates/router/tests/connectors/utils.rs +++ b/crates/router/tests/connectors/utils.rs @@ -553,7 +553,7 @@ pub trait ConnectorActions: Connector { connector_mandate_request_reference_id: None, psd2_sca_exemption_type: None, authentication_id: None, - whole_connector_response: None, + raw_connector_response: None, } }	2025-06-30T11:36:23Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [ ] New feature - [ ] Enhancement - [x] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> This PR populates raw_connector_response for Payments when return_raw_connector_response is set to True. It also changes Payments Create and Psync endpoint for Razorpay connector. Additional Changes: - Introduces a struct ConnectorResponseData which sends raw_connector_response at core flows instead of it being in PaymentData (changed only in v2) - Rename `all_keys_required` as `return_raw_connector_response`, `get_all_keys_required()` as `should_return_raw_response()` , `whole_connector_response` as `raw_connector_response`. This rename is applied only on v2 Api and core flows to retain backward compatibility at v1. - `get_whole_connector_response()` and `get_all_keys_required()` at OperationSessionGetters are marked under v1 feature - `connector_response_reference_id` is updated in Payment_attempt at both update_trackers and post_update_trackers for v2. This is included in update_trackers in cases where Authorize flow is not performed at Connector End - Also marked this PaymentRetrieveBody, PaymentRetrieveBodyWithCredentials under v1 feature as it is not required in v2 flows ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> - Payments - Create ``` curl --location 'http://localhost:8080/v2/payments' \ --header 'Content-Type: application/json' \ --header 'x-profile-id: pro_L5WeuuGWl0EUYBhEEME1' \ --header 'Authorization: api-key=_' \ --data-raw '{ "amount_details": { "order_amount": 100, "currency": "INR" }, "capture_method":"automatic", "description": "Its my first payment request", "authentication_type": "no_three_ds", "return_url": "https://google.com", "payment_method_data": { "upi": { "upi_collect": { "vpa_id": "success@razorpay" } }, "billing": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "IN", "first_name": "Swangi", "last_name": "Kumari" }, "phone": { "number": "8056594427", "country_code": "+91" }, "email": "[email protected]" } }, "payment_method_subtype": "upi_collect", "payment_method_type": "upi", "return_raw_connector_response": true }' ``` Response ``` { "id": "12345_pay_0197c4e2b8087181963fdaae32be36b3", "status": "requires_customer_action", "amount": { "order_amount": 100, "currency": "INR", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null, "net_amount": 100, "amount_to_capture": null, "amount_capturable": 0, "amount_captured": null }, "customer_id": null, "connector": "razorpay", "created": "2025-07-01T07:28:02.057Z", "payment_method_data": { "billing": { "address": { "city": "San Fransico", "country": "IN", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "Swangi", "last_name": "Kumari" }, "phone": { "number": "8056594427", "country_code": "+91" }, "email": "[email protected]" } }, "payment_method_type": "upi", "payment_method_subtype": "upi_collect", "connector_transaction_id": "pay_Qnik5RSCB4oVjf", "connector_reference_id": "order_Qnik4SrNFCdv8H", "merchant_connector_id": "mca_GWx9LT38SlIQ1qNFfw1p", "browser_info": null, "error": null, "shipping": null, "billing": null, "attempts": null, "connector_token_details": null, "payment_method_id": null, "next_action": { "type": "wait_screen_information", "display_from_timestamp": 1751354885589516000, "display_to_timestamp": 1751355185589516000, "poll_config": { "delay_in_secs": 5, "frequency": 5 } }, "return_url": "https://google.com/", "authentication_type": "no_three_ds", "authentication_type_applied": "no_three_ds", "is_iframe_redirection_enabled": null, "merchant_reference_id": null, "raw_connector_response": "{\"razorpay_payment_id\":\"pay_Qnik5RSCB4oVjf\"}" } ``` - Payments - Retrieve ``` curl --location 'http://localhost:8080/v2/payments/12345_pay_0197c4e2b8087181963fdaae32be36b3?force_sync=true&return_raw_connector_response=true' \ --header 'x-profile-id: pro_L5WeuuGWl0EUYBhEEME1' \ --header 'Authorization: api-key=_' \ --data '' ``` Response ``` { "id": "12345_pay_0197c4e2b8087181963fdaae32be36b3", "status": "requires_capture", "amount": { "order_amount": 100, "currency": "INR", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null, "net_amount": 100, "amount_to_capture": null, "amount_capturable": 100, "amount_captured": 100 }, "customer_id": null, "connector": "razorpay", "created": "2025-07-01T07:36:11.733Z", "payment_method_data": { "billing": { "address": { "city": "San Fransico", "country": "IN", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "Swangi", "last_name": "Kumari" }, "phone": { "number": "8056594427", "country_code": "+91" }, "email": "[email protected]" } }, "payment_method_type": "upi", "payment_method_subtype": "upi_collect", "connector_transaction_id": "pay_Qnik5RSCB4oVjf", "connector_reference_id": "order_Qnik4SrNFCdv8H", "merchant_connector_id": "mca_GWx9LT38SlIQ1qNFfw1p", "browser_info": null, "error": null, "shipping": null, "billing": null, "attempts": null, "connector_token_details": null, "payment_method_id": null, "next_action": null, "return_url": "https://google.com/", "authentication_type": "no_three_ds", "authentication_type_applied": null, "is_iframe_redirection_enabled": null, "merchant_reference_id": null, "raw_connector_response": "{\"entity\":\"collection\",\"count\":1,\"items\":[{\"id\":\"pay_QnishOLxdHvKJ6\",\"entity\":\"payment\",\"amount\":100,\"currency\":\"INR\",\"status\":\"authorized\",\"order_id\":\"order_QnisgYZGQHtI92\",\"invoice_id\":null,\"international\":false,\"method\":\"upi\",\"amount_refunded\":0,\"refund_status\":null,\"captured\":false,\"description\":null,\"card_id\":null,\"bank\":null,\"wallet\":null,\"vpa\":\"success@razorpay\",\"email\":\"[email protected]\",\"contact\":\"+918056594427\",\"notes\":{\"optimizer_provider_name\":\"razorpay\"},\"fee\":null,\"tax\":null,\"error_code\":null,\"error_description\":null,\"error_source\":null,\"error_step\":null,\"error_reason\":null,\"acquirer_data\":{\"rrn\":\"216013077213\",\"upi_transaction_id\":\"614E93092FDA8E2A9FA28264CF769689\"},\"gateway_provider\":\"Razorpay\",\"created_at\":1751355374,\"upi\":{\"vpa\":\"success@razorpay\"}}]}" } ``` ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	c275e13caf22362173e77d2260b440159abcabb3	c275e13caf22362173e77d2260b440159abcabb3
juspay/hyperswitch	juspay__hyperswitch-8497	Bug: chore: address Rust 1.88.0 clippy lints Address the clippy lints occurring due to new rust version 1.88.0 See https://github.com/juspay/hyperswitch/issues/3391 for more information.	diff --git a/crates/router/src/core/payment_methods/vault.rs b/crates/router/src/core/payment_methods/vault.rs index c59a2f84c35..d5848c7f418 100644 --- a/crates/router/src/core/payment_methods/vault.rs +++ b/crates/router/src/core/payment_methods/vault.rs @@ -1555,10 +1555,7 @@ pub async fn insert_cvc_using_payment_token( .change_context(errors::ApiErrorResponse::InternalServerError) .attach_printable("Failed to get redis connection")?; - let key = format!( - "pm_token_{}_{}_hyperswitch_cvc", - payment_token, payment_method - ); + let key = format!("pm_token_{payment_token}_{payment_method}_hyperswitch_cvc"); let payload_to_be_encrypted = TemporaryVaultCvc { card_cvc }; @@ -1601,10 +1598,7 @@ pub async fn retrieve_and_delete_cvc_from_payment_token( .change_context(errors::ApiErrorResponse::InternalServerError) .attach_printable("Failed to get redis connection")?; - let key = format!( - "pm_token_{}_{}_hyperswitch_cvc", - payment_token, payment_method - ); + let key = format!("pm_token_{payment_token}_{payment_method}_hyperswitch_cvc"); let data = redis_conn .get_key::<bytes::Bytes>(&key.clone().into()) diff --git a/crates/router/src/core/unified_connector_service.rs b/crates/router/src/core/unified_connector_service.rs index d9c00fbadba..3cdcb28d4d8 100644 --- a/crates/router/src/core/unified_connector_service.rs +++ b/crates/router/src/core/unified_connector_service.rs @@ -101,8 +101,7 @@ pub fn build_unified_connector_service_payment_method( } _ => { return Err(UnifiedConnectorServiceError::NotImplemented(format!( - "Unimplemented card payment method type: {:?}", - payment_method_type + "Unimplemented card payment method type: {payment_method_type:?}" )) .into()); }	2025-07-10T13:43:08Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [ ] New feature - [ ] Enhancement - [x] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> This pull request includes a minor improvement to error message formatting in the `build_unified_connector_service_payment_method` function. * [`crates/router/src/core/unified_connector_service.rs`](diffhunk://#diff-b8e808846f58e455687a9e192c1c8d192598081aac942628640c42c1d397dfaeL104-R104): Updated the error message to use inline formatting for `payment_method_type`, improving readability and consistency. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	1b08de652f6b0f3c08374d0806c8999f4b73ec2f	1b08de652f6b0f3c08374d0806c8999f4b73ec2f
juspay/hyperswitch	juspay__hyperswitch-8470	Bug: [FEATURE] allow a dummy connector to succeed for a failure card to show smart routing ### Feature Description Objective is to show user how smart retry works ### Possible Implementation stripe_test if the card number is 4000000000009995 previously it was failure with insufficient funds. But now we need to allow it to become success. ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? None	diff --git a/crates/router/src/routes/dummy_connector/utils.rs b/crates/router/src/routes/dummy_connector/utils.rs index 367c3bc63d4..0bec0398193 100644 --- a/crates/router/src/routes/dummy_connector/utils.rs +++ b/crates/router/src/routes/dummy_connector/utils.rs @@ -11,7 +11,10 @@ use super::{ consts, errors, types::{self, GetPaymentMethodDetails}, }; -use crate::{configs::settings, routes::SessionState}; +use crate::{ + configs::settings, + routes::{dummy_connector::types::DummyConnectors, SessionState}, +}; pub async fn tokio_mock_sleep(delay: u64, tolerance: u64) { let mut rng = rand::thread_rng(); @@ -219,7 +222,7 @@ impl ProcessPaymentAttempt for types::DummyConnectorCard { payment_attempt: types::DummyConnectorPaymentAttempt, redirect_url: String, ) -> types::DummyConnectorResult<types::DummyConnectorPaymentData> { - match self.get_flow_from_card_number()? { + match self.get_flow_from_card_number(payment_attempt.payment_request.connector.clone())? { types::DummyConnectorCardFlow::NoThreeDS(status, error) => { if let Some(error) = error { Err(error)?; @@ -291,6 +294,7 @@ impl types::DummyConnectorUpiCollect { impl types::DummyConnectorCard { pub fn get_flow_from_card_number( self, + connector: DummyConnectors, ) -> types::DummyConnectorResult<types::DummyConnectorCardFlow> { let card_number = self.number.peek(); match card_number.as_str() { @@ -309,12 +313,21 @@ impl types::DummyConnectorCard { }), )) } - "4000000000009995" => Ok(types::DummyConnectorCardFlow::NoThreeDS( - types::DummyConnectorStatus::Failed, - Some(errors::DummyConnectorErrors::PaymentDeclined { - message: "Insufficient funds", - }), - )), + "4000000000009995" => { + if connector == DummyConnectors::StripeTest { + Ok(types::DummyConnectorCardFlow::NoThreeDS( + types::DummyConnectorStatus::Succeeded, + None, + )) + } else { + Ok(types::DummyConnectorCardFlow::NoThreeDS( + types::DummyConnectorStatus::Failed, + Some(errors::DummyConnectorErrors::PaymentDeclined { + message: "Internal Server Error from Connector, Please try again later", + }), + )) + } + } "4000000000009987" => Ok(types::DummyConnectorCardFlow::NoThreeDS( types::DummyConnectorStatus::Failed, Some(errors::DummyConnectorErrors::PaymentDeclined {	2025-06-26T10:37:04Z	…rd payment ## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [ ] New feature - [x] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> For one connector alone to hard code success with a particular failure card ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> `stripe_test` if the card number is `4000000000009995` previously it was failure with insufficient funds. But now we need to allow it to become success. ## Motivation and Context Objective is to show user how smart retry works so a relevant error message will help ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> ## failure for other gateways <details> <summary>Request </summary> ```json { "amount": 333, "currency": "EUR", "confirm": true, "capture_method": "automatic", "payment_method": "card", "payment_method_type": "credit", "authentication_type": "no_three_ds", "description": "hellow world", "connector":["paypal_test"], "billing": { "address": { "zip": "560095", "country": "IN", "first_name": "Sakil", "last_name": "Mostak", "line1": "Fasdf", "line2": "Fasdf", "city": "Fasdf" } }, "payment_method_data": { "card": { "card_number": "4000000000009995", "card_exp_month": "01", "card_exp_year": "2026", "card_holder_name": "John Smith", "card_cvc": "100" } } } ``` </details> <details> <summary>Response</summary> ```json { "payment_id": "pay_04Vahgm5zSgQLH5y5o0S", "merchant_id": "merchant_1750933328", "status": "failed", "amount": 333, "net_amount": 333, "shipping_cost": null, "amount_capturable": 0, "amount_received": null, "connector": "paypal_test", "client_secret": "pay_04Vahgm5zSgQLH5y5o0S_secret_iKiVIRw76fiMFvPXCzU7", "created": "2025-06-26T10:32:26.951Z", "currency": "EUR", "customer_id": null, "customer": null, "description": "hellow world", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "card", "payment_method_data": { "card": { "last4": "9995", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "400000", "card_extended_bin": null, "card_exp_month": "01", "card_exp_year": "2026", "card_holder_name": "John Smith", "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": "Fasdf", "country": "IN", "line1": "Fasdf", "line2": "Fasdf", "line3": null, "zip": "560095", "state": null, "first_name": "Sakil", "last_name": "Mostak" }, "phone": null, "email": null }, "order_details": null, "email": null, "name": null, "phone": null, "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": null, "cancellation_reason": null, "error_code": "DC_08", "error_message": "Payment declined: Internal Server Error", "unified_code": "UE_9000", "unified_message": "Something went wrong", "payment_experience": null, "payment_method_type": "credit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": true, "connector_transaction_id": null, "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": null, "payment_link": null, "profile_id": "pro_tvhMochAzQxRKYmWKPgs", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_XioVM508jgIaVMwxgAsw", "incremental_authorization_allowed": false, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-06-26T10:47:26.951Z", "fingerprint": null, "browser_info": null, "payment_method_id": null, "payment_method_status": null, "updated": "2025-06-26T10:32:28.008Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` </details> ## success for `stripe_test` <details> <summary>Request</summary> ```json { "amount": 333, "currency": "EUR", "confirm": true, "capture_method": "automatic", "payment_method": "card", "payment_method_type": "credit", "authentication_type": "no_three_ds", "description": "hellow world", "connector":["stripe_test"], "billing": { "address": { "zip": "560095", "country": "IN", "first_name": "Sakil", "last_name": "Mostak", "line1": "Fasdf", "line2": "Fasdf", "city": "Fasdf" } }, "payment_method_data": { "card": { "card_number": "4000000000009995", "card_exp_month": "01", "card_exp_year": "2026", "card_holder_name": "John Smith", "card_cvc": "100" } } } ``` </details> <details> <summary>Response</summary> ```json { "payment_id": "pay_OqK97rLSs9s7NnwRvLV0", "merchant_id": "merchant_1750933328", "status": "succeeded", "amount": 333, "net_amount": 333, "shipping_cost": null, "amount_capturable": 0, "amount_received": 333, "connector": "stripe_test", "client_secret": "pay_OqK97rLSs9s7NnwRvLV0_secret_ZfXwEiZvzXjz0jiQFt7y", "created": "2025-06-26T10:39:21.936Z", "currency": "EUR", "customer_id": null, "customer": null, "description": "hellow world", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "card", "payment_method_data": { "card": { "last4": "9995", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "400000", "card_extended_bin": null, "card_exp_month": "01", "card_exp_year": "2026", "card_holder_name": "John Smith", "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": "Fasdf", "country": "IN", "line1": "Fasdf", "line2": "Fasdf", "line3": null, "zip": "560095", "state": null, "first_name": "Sakil", "last_name": "Mostak" }, "phone": null, "email": null }, "order_details": null, "email": null, "name": null, "phone": null, "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "credit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": false, "connector_transaction_id": "pay_LDgbgr5HUer6sqe8YSsq", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": null, "payment_link": null, "profile_id": "pro_tvhMochAzQxRKYmWKPgs", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_KNpkA14s7QSE6SE8SuUA", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-06-26T10:54:21.936Z", "fingerprint": null, "browser_info": null, "payment_method_id": null, "payment_method_status": null, "updated": "2025-06-26T10:39:22.945Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` </details> ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.114.0	ec6d0e4d62a530163ae1c806dcf40ccfd264b246	ec6d0e4d62a530163ae1c806dcf40ccfd264b246
juspay/hyperswitch	juspay__hyperswitch-8492	Bug: [FIX] Fix routing approach update in wallet flow ### Feature Description Fix routing approach update in wallet flow ### Possible Implementation Fix routing approach update in wallet flow ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? Yes, I am willing to submit a PR!	diff --git a/crates/common_enums/src/enums.rs b/crates/common_enums/src/enums.rs index 29cf75ac504..1d00a451708 100644 --- a/crates/common_enums/src/enums.rs +++ b/crates/common_enums/src/enums.rs @@ -8523,6 +8523,7 @@ pub enum RoutingApproach { DebitRouting, RuleBasedRouting, VolumeBasedRouting, + StraightThroughRouting, #[default] DefaultFallback, } @@ -8533,6 +8534,7 @@ impl RoutingApproach { "SR_SELECTION_V3_ROUTING" => Self::SuccessRateExploitation, "SR_V3_HEDGING" => Self::SuccessRateExploration, "NTW_BASED_ROUTING" => Self::DebitRouting, + "DEFAULT" => Self::StraightThroughRouting, _ => Self::DefaultFallback, } } diff --git a/crates/diesel_models/src/payment_attempt.rs b/crates/diesel_models/src/payment_attempt.rs index 0afea0574a7..eeda9e78877 100644 --- a/crates/diesel_models/src/payment_attempt.rs +++ b/crates/diesel_models/src/payment_attempt.rs @@ -459,6 +459,7 @@ pub enum PaymentAttemptUpdate { tax_amount: Option<MinorUnit>, updated_by: String, merchant_connector_id: Option<id_type::MerchantConnectorAccountId>, + routing_approach: Option<storage_enums::RoutingApproach>, }, AuthenticationTypeUpdate { authentication_type: storage_enums::AuthenticationType, @@ -3088,6 +3089,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { tax_amount, updated_by, merchant_connector_id, + routing_approach, } => Self { payment_token, modified_at: common_utils::date_time::now(), @@ -3146,7 +3148,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, - routing_approach: None, + routing_approach, }, PaymentAttemptUpdate::UnresolvedResponseUpdate { status, diff --git a/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs b/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs index 3a2692e5830..d644c519ea9 100644 --- a/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs +++ b/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs @@ -1191,6 +1191,7 @@ pub enum PaymentAttemptUpdate { tax_amount: Option<MinorUnit>, updated_by: String, merchant_connector_id: Option<id_type::MerchantConnectorAccountId>, + routing_approach: Option<storage_enums::RoutingApproach>, }, AuthenticationTypeUpdate { authentication_type: storage_enums::AuthenticationType, @@ -1227,7 +1228,7 @@ pub enum PaymentAttemptUpdate { customer_acceptance: Option<pii::SecretSerdeValue>, connector_mandate_detail: Option<ConnectorMandateReferenceId>, card_discovery: Option<common_enums::CardDiscovery>, - routing_approach: Option<storage_enums::RoutingApproach>, // where all to add this one + routing_approach: Option<storage_enums::RoutingApproach>, }, RejectUpdate { status: storage_enums::AttemptStatus, @@ -1413,6 +1414,7 @@ impl PaymentAttemptUpdate { surcharge_amount, tax_amount, merchant_connector_id, + routing_approach, } => DieselPaymentAttemptUpdate::UpdateTrackers { payment_token, connector, @@ -1422,6 +1424,7 @@ impl PaymentAttemptUpdate { tax_amount, updated_by, merchant_connector_id, + routing_approach, }, Self::AuthenticationTypeUpdate { authentication_type, diff --git a/crates/router/src/core/payment_methods/cards.rs b/crates/router/src/core/payment_methods/cards.rs index 11b1489b5cf..c42b05bd424 100644 --- a/crates/router/src/core/payment_methods/cards.rs +++ b/crates/router/src/core/payment_methods/cards.rs @@ -2845,7 +2845,7 @@ pub async fn list_payment_methods( payment_intent, chosen, }; - let result = routing::perform_session_flow_routing( + let (result, routing_approach) = routing::perform_session_flow_routing( sfr, &business_profile, &enums::TransactionType::Payment, @@ -3027,6 +3027,7 @@ pub async fn list_payment_methods( merchant_connector_id: None, surcharge_amount: None, tax_amount: None, + routing_approach, }; state diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs index 83176881ead..83ff156ea95 100644 --- a/crates/router/src/core/payments.rs +++ b/crates/router/src/core/payments.rs @@ -7331,6 +7331,10 @@ where .change_context(errors::ApiErrorResponse::InternalServerError) .attach_printable("Failed execution of straight through routing")?; + payment_data.set_routing_approach_in_attempt(Some( + common_enums::RoutingApproach::StraightThroughRouting, + )); + if check_eligibility { let transaction_data = core_routing::PaymentsDslInput::new( payment_data.get_setup_mandate(), @@ -7911,12 +7915,12 @@ pub async fn perform_session_token_routing<F, D>( state: SessionState, merchant_context: &domain::MerchantContext, business_profile: &domain::Profile, - payment_data: &D, + payment_data: &mut D, connectors: api::SessionConnectorDatas, ) -> RouterResult<api::SessionConnectorDatas> where F: Clone, - D: OperationSessionGetters<F>, + D: OperationSessionGetters<F> + OperationSessionSetters<F>, { let chosen = connectors.apply_filter_for_session_routing(); let sfr = SessionFlowRoutingInput { @@ -7932,7 +7936,7 @@ where payment_intent: payment_data.get_payment_intent(), chosen, }; - let result = self_routing::perform_session_flow_routing( + let (result, routing_approach) = self_routing::perform_session_flow_routing( sfr, business_profile, &enums::TransactionType::Payment, @@ -7941,6 +7945,8 @@ where .change_context(errors::ApiErrorResponse::InternalServerError) .attach_printable("error performing session flow routing")?; + payment_data.set_routing_approach_in_attempt(routing_approach); + let final_list = connectors.filter_and_validate_for_session_flow(&result)?; Ok(final_list) diff --git a/crates/router/src/core/payments/operations/payment_create.rs b/crates/router/src/core/payments/operations/payment_create.rs index 4c463c74ed7..413aa121a9c 100644 --- a/crates/router/src/core/payments/operations/payment_create.rs +++ b/crates/router/src/core/payments/operations/payment_create.rs @@ -880,6 +880,8 @@ impl<F: Clone + Sync> UpdateTracker<F, PaymentData<F>, api::PaymentsRequest> for .as_ref() .map(\|surcharge_details\| surcharge_details.tax_on_surcharge_amount); + let routing_approach = payment_data.payment_attempt.routing_approach; + payment_data.payment_attempt = state .store .update_payment_attempt_with_attempt_id( @@ -896,6 +898,7 @@ impl<F: Clone + Sync> UpdateTracker<F, PaymentData<F>, api::PaymentsRequest> for tax_amount, updated_by: storage_scheme.to_string(), merchant_connector_id, + routing_approach, }, storage_scheme, ) diff --git a/crates/router/src/core/payments/routing.rs b/crates/router/src/core/payments/routing.rs index 7126ed9617e..c3823aa2f30 100644 --- a/crates/router/src/core/payments/routing.rs +++ b/crates/router/src/core/payments/routing.rs @@ -515,7 +515,10 @@ pub async fn perform_static_routing_v1( ).unwrap_or_default(); let (routable_connectors, routing_approach) = match cached_algorithm.as_ref() { - CachedAlgorithm::Single(conn) => (vec![(conn).clone()], None), + CachedAlgorithm::Single(conn) => ( + vec![(conn).clone()], + Some(common_enums::RoutingApproach::StraightThroughRouting), + ), CachedAlgorithm::Priority(plist) => (plist.clone(), None), CachedAlgorithm::VolumeSplit(splits) => ( perform_volume_split(splits.to_vec()) @@ -1208,8 +1211,10 @@ pub async fn perform_session_flow_routing( session_input: SessionFlowRoutingInput<'_>, business_profile: &domain::Profile, transaction_type: &api_enums::TransactionType, -) -> RoutingResult<FxHashMap<api_enums::PaymentMethodType, Vec<routing_types::SessionRoutingChoice>>> -{ +) -> RoutingResult<( + FxHashMap<api_enums::PaymentMethodType, Vec<routing_types::SessionRoutingChoice>>, + Option<common_enums::RoutingApproach>, +)> { let mut pm_type_map: FxHashMap<api_enums::PaymentMethodType, FxHashMap<String, api::GetToken>> = FxHashMap::default(); @@ -1297,6 +1302,7 @@ pub async fn perform_session_flow_routing( api_enums::PaymentMethodType, Vec<routing_types::SessionRoutingChoice>, > = FxHashMap::default(); + let mut final_routing_approach = None; for (pm_type, allowed_connectors) in pm_type_map { let euclid_pmt: euclid_enums::PaymentMethodType = pm_type; @@ -1315,12 +1321,15 @@ pub async fn perform_session_flow_routing( profile_id: &profile_id, }; - let routable_connector_choice_option = perform_session_routing_for_pm_type( - &session_pm_input, - transaction_type, - business_profile, - ) - .await?; + let (routable_connector_choice_option, routing_approach) = + perform_session_routing_for_pm_type( + &session_pm_input, + transaction_type, + business_profile, + ) + .await?; + + final_routing_approach = routing_approach; if let Some(routable_connector_choice) = routable_connector_choice_option { let mut session_routing_choice: Vec<routing_types::SessionRoutingChoice> = Vec::new(); @@ -1348,7 +1357,7 @@ pub async fn perform_session_flow_routing( } } - Ok(result) + Ok((result, final_routing_approach)) } #[cfg(feature = "v1")] @@ -1356,14 +1365,17 @@ async fn perform_session_routing_for_pm_type( session_pm_input: &SessionRoutingPmTypeInput<'_>, transaction_type: &api_enums::TransactionType, _business_profile: &domain::Profile, -) -> RoutingResult<Option<Vec<api_models::routing::RoutableConnectorChoice>>> { +) -> RoutingResult<( + Option<Vec<api_models::routing::RoutableConnectorChoice>>, + Option<common_enums::RoutingApproach>, +)> { let merchant_id = &session_pm_input.key_store.merchant_id; let algorithm_id = match session_pm_input.routing_algorithm { MerchantAccountRoutingAlgorithm::V1(algorithm_ref) => &algorithm_ref.algorithm_id, }; - let chosen_connectors = if let Some(ref algorithm_id) = algorithm_id { + let (chosen_connectors, routing_approach) = if let Some(ref algorithm_id) = algorithm_id { let cached_algorithm = ensure_algorithm_cached_v1( &session_pm_input.state.clone(), merchant_id, @@ -1374,23 +1386,35 @@ async fn perform_session_routing_for_pm_type( .await?; match cached_algorithm.as_ref() { - CachedAlgorithm::Single(conn) => vec![(conn).clone()], - CachedAlgorithm::Priority(plist) => plist.clone(), - CachedAlgorithm::VolumeSplit(splits) => perform_volume_split(splits.to_vec()) - .change_context(errors::RoutingError::ConnectorSelectionFailed)?, - CachedAlgorithm::Advanced(interpreter) => execute_dsl_and_get_connector_v1( - session_pm_input.backend_input.clone(), - interpreter, - )?, + CachedAlgorithm::Single(conn) => ( + vec![(conn).clone()], + Some(common_enums::RoutingApproach::StraightThroughRouting), + ), + CachedAlgorithm::Priority(plist) => (plist.clone(), None), + CachedAlgorithm::VolumeSplit(splits) => ( + perform_volume_split(splits.to_vec()) + .change_context(errors::RoutingError::ConnectorSelectionFailed)?, + Some(common_enums::RoutingApproach::VolumeBasedRouting), + ), + CachedAlgorithm::Advanced(interpreter) => ( + execute_dsl_and_get_connector_v1( + session_pm_input.backend_input.clone(), + interpreter, + )?, + Some(common_enums::RoutingApproach::RuleBasedRouting), + ), } } else { - routing::helpers::get_merchant_default_config( - &session_pm_input.state.clone().store, - session_pm_input.profile_id.get_string_repr(), - transaction_type, + ( + routing::helpers::get_merchant_default_config( + &session_pm_input.state.clone().store, + session_pm_input.profile_id.get_string_repr(), + transaction_type, + ) + .await + .change_context(errors::RoutingError::FallbackConfigFetchFailed)?, + None, ) - .await - .change_context(errors::RoutingError::FallbackConfigFetchFailed)? }; let mut final_selection = perform_cgraph_filtering( @@ -1426,9 +1450,9 @@ async fn perform_session_routing_for_pm_type( } if final_selection.is_empty() { - Ok(None) + Ok((None, routing_approach)) } else { - Ok(Some(final_selection)) + Ok((Some(final_selection), routing_approach)) } } diff --git a/migrations/2025-06-27-120507_update_routing_approach/down.sql b/migrations/2025-06-27-120507_update_routing_approach/down.sql new file mode 100644 index 00000000000..c7c9cbeb401 --- /dev/null +++ b/migrations/2025-06-27-120507_update_routing_approach/down.sql @@ -0,0 +1,2 @@ +-- This file should undo anything in `up.sql` +SELECT 1; \ No newline at end of file diff --git a/migrations/2025-06-27-120507_update_routing_approach/up.sql b/migrations/2025-06-27-120507_update_routing_approach/up.sql new file mode 100644 index 00000000000..c7f75cb5235 --- /dev/null +++ b/migrations/2025-06-27-120507_update_routing_approach/up.sql @@ -0,0 +1,3 @@ +-- Your SQL goes here +ALTER TYPE "RoutingApproach" +ADD VALUE 'straight_through_routing';	2025-06-30T08:06:48Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [x] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> Fixes routing approach updation for wallets flow ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> 1. make wallet payment and check for `routing_approach` column in payment_attempt ApplePay payment create - ``` curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_BNOaWRzwyZ3hMAbhRNtp9t6Mx7ZSVyK5gPvd1bavl0FWehvrHlre1eMifYA244TE' \ --data-raw '{ "amount": 650, "currency": "USD", "confirm": false, "business_country": "US", "business_label": "default", "amount_to_capture": 650, "customer_id": "cu_1751271429", "capture_method": "automatic", "capture_on": "2022-09-10T10:11:12Z", "setup_future_usage": "off_session", "authentication_type": "no_three_ds", "return_url": "https://google.com", "email": "[email protected]", "name": "Joseph Doe", "phone": "999999999", "phone_country_code": "+65", "description": "Its my first payment request", "statement_descriptor_name": "Juspay", "statement_descriptor_suffix": "Router", "payment_method": "wallet", "payment_method_type": "apple_pay", "billing": { "address": { "line1": "1467", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" }, "phone": { "number": "8056594427", "country_code": "+91" } }, "customer_acceptance": { "acceptance_type": "offline", "accepted_at": "1963-05-03T04:07:52.723Z", "online": { "ip_address": "in sit", "user_agent": "amet irure esse" } }, "payment_method_data": { "wallet": { "apple_pay": { "payment_data": "eyJkYXRhIjogInR1OHlCcFY3MHJ5WFpSTUJqaEt3T2VtTGhrbHlPREIzNVVLdnpNUDVFRk50eW9OMUdtK2pRRkZnaTF1T0t3WmJQZUUwdmxVUnJIeU5vQkhLOUZSY1pmYzJVL2cydytHbExweWxVcEQwc2VXdU9rRTZYb1E1SHFsZ085bFZRclZacHZsNmFndHdVYU5Cc2pqWTB0Q1F1SHRMRHQzQWI4c2pJdWhpL1g1cFNYakM0ak5PdUoxRkdJKy9CS016OHBNdUZGMkUvbmJWenhNQjhoT1lDWjlUVGdFZlN3Z3VwbE9SaFY5dFV1by9VVFhFUG40cGljNVpPYUR6WnB6Z1BuK0d1V2JVVExuL0h5Rk9MQW5xc3pNZzFkdklHcjd3c0pWRE1LUzJIdHZ5VzA2QXUzNGVSZGxkaEVWbFhnYWNDcWFualVwZlJBcVhod2VtQjNwd2p4bFBUMkxrcUE3VzJwWnNLNkF1Z0lwUi9tMTUwazFRRjl3d1AwVTF6YkpBbGc5bE9VL1IyRlVZR1BKRUZ4ay92SWowL3ZiYnkvcE96L0RBY1ZRd3NGek9UbUk9IiwKICAgICAgInNpZ25hdHVyZSI6ICJNSUFHQ1NxR1NJYjNEUUVIQXFDQU1JQUNBUUV4RFRBTEJnbGdoa2dCWlFNRUFnRXdnQVlKS29aSWh2Y05BUWNCQUFDZ2dEQ0NBK1F3Z2dPTG9BTUNBUUlDQ0ZuWW9ieXE5T1BOTUFvR0NDcUdTTTQ5QkFNQ01Ib3hMakFzQmdOVkJBTU1KVUZ3Y0d4bElFRndjR3hwWTJGMGFXOXVJRWx1ZEdWbmNtRjBhVzl1SUVOQklDMGdSek14SmpBa0JnTlZCQXNNSFVGd2NHeGxJRU5sY25ScFptbGpZWFJwYjI0Z1FYVjBhRzl5YVhSNU1STXdFUVlEVlFRS0RBcEJjSEJzWlNCSmJtTXVNUXN3Q1FZRFZRUUdFd0pWVXpBZUZ3MHlNVEEwTWpBeE9UTTNNREJhRncweU5qQTBNVGt4T1RNMk5UbGFNR0l4S0RBbUJnTlZCQU1NSDJWall5MXpiWEF0WW5KdmEyVnlMWE5wWjI1ZlZVTTBMVk5CVGtSQ1QxZ3hGREFTQmdOVkJBc01DMmxQVXlCVGVYTjBaVzF6TVJNd0VRWURWUVFLREFwQmNIQnNaU0JKYm1NdU1Rc3dDUVlEVlFRR0V3SlZVekJaTUJNR0J5cUdTTTQ5QWdFR0NDcUdTTTQ5QXdFSEEwSUFCSUl3L2F2RG5QZGVJQ3hRMlp0RkV1WTM0cWtCM1d5ejRMSE5TMUpubVBqUFRyM29HaVdvd2g1TU05M09qaXFXd3Zhdm9aTURSY1RvZWtRbXpwVWJFcFdqZ2dJUk1JSUNEVEFNQmdOVkhSTUJBZjhFQWpBQU1COEdBMVVkSXdRWU1CYUFGQ1B5U2NSUGsrVHZKK2JFOWloc1A2SzcvUzVMTUVVR0NDc0dBUVVGQndFQkJEa3dOekExQmdnckJnRUZCUWN3QVlZcGFIUjBjRG92TDI5amMzQXVZWEJ3YkdVdVkyOXRMMjlqYzNBd05DMWhjSEJzWldGcFkyRXpNREl3Z2dFZEJnTlZIU0FFZ2dFVU1JSUJFRENDQVF3R0NTcUdTSWIzWTJRRkFUQ0IvakNCd3dZSUt3WUJCUVVIQWdJd2diWU1nYk5TWld4cFlXNWpaU0J2YmlCMGFHbHpJR05sY25ScFptbGpZWFJsSUdKNUlHRnVlU0J3WVhKMGVTQmhjM04xYldWeklHRmpZMlZ3ZEdGdVkyVWdiMllnZEdobElIUm9aVzRnWVhCd2JHbGpZV0pzWlNCemRHRnVaR0Z5WkNCMFpYSnRjeUJoYm1RZ1kyOXVaR2wwYVc5dWN5QnZaaUIxYzJVc0lHTmxjblJwWm1sallYUmxJSEJ2YkdsamVTQmhibVFnWTJWeWRHbG1hV05oZEdsdmJpQndjbUZqZEdsalpTQnpkR0YwWlcxbGJuUnpMakEyQmdnckJnRUZCUWNDQVJZcWFIUjBjRG92TDNkM2R5NWhjSEJzWlM1amIyMHZZMlZ5ZEdsbWFXTmhkR1ZoZFhSb2IzSnBkSGt2TURRR0ExVWRId1F0TUNzd0thQW5vQ1dHSTJoMGRIQTZMeTlqY213dVlYQndiR1V1WTI5dEwyRndjR3hsWVdsallUTXVZM0pzTUIwR0ExVWREZ1FXQkJRQ0pEQUxtdTd0UmpHWHBLWmFLWjVDY1lJY1JUQU9CZ05WSFE4QkFmOEVCQU1DQjRBd0R3WUpLb1pJaHZkalpBWWRCQUlGQURBS0JnZ3Foa2pPUFFRREFnTkhBREJFQWlCMG9iTWsyMEpKUXczVEoweFFkTVNBalpvZlNBNDZoY1hCTmlWbU1sKzhvd0lnYVRhUVU2djFDMXBTK2ZZQVRjV0tyV3hRcDlZSWFEZVE0S2M2MEI1SzJZRXdnZ0x1TUlJQ2RhQURBZ0VDQWdoSmJTKy9PcGphbHpBS0JnZ3Foa2pPUFFRREFqQm5NUnN3R1FZRFZRUUREQkpCY0hCc1pTQlNiMjkwSUVOQklDMGdSek14SmpBa0JnTlZCQXNNSFVGd2NHeGxJRU5sY25ScFptbGpZWFJwYjI0Z1FYVjBhRzl5YVhSNU1STXdFUVlEVlFRS0RBcEJjSEJzWlNCSmJtTXVNUXN3Q1FZRFZRUUdFd0pWVXpBZUZ3MHhOREExTURZeU16UTJNekJhRncweU9UQTFNRFl5TXpRMk16QmFNSG94TGpBc0JnTlZCQU1NSlVGd2NHeGxJRUZ3Y0d4cFkyRjBhVzl1SUVsdWRHVm5jbUYwYVc5dUlFTkJJQzBnUnpNeEpqQWtCZ05WQkFzTUhVRndjR3hsSUVObGNuUnBabWxqWVhScGIyNGdRWFYwYUc5eWFYUjVNUk13RVFZRFZRUUtEQXBCY0hCc1pTQkpibU11TVFzd0NRWURWUVFHRXdKVlV6QlpNQk1HQnlxR1NNNDlBZ0VHQ0NxR1NNNDlBd0VIQTBJQUJQQVhFWVFaMTJTRjFScGVKWUVIZHVpQW91L2VlNjVONEkzOFM1UGhNMWJWWmxzMXJpTFFsM1lOSWs1N3VnajlkaGZPaU10MnUyWnd2c2pvS1lUL1ZFV2pnZmN3Z2ZRd1JnWUlLd1lCQlFVSEFRRUVPakE0TURZR0NDc0dBUVVGQnpBQmhpcG9kSFJ3T2k4dmIyTnpjQzVoY0hCc1pTNWpiMjB2YjJOemNEQTBMV0Z3Y0d4bGNtOXZkR05oWnpNd0hRWURWUjBPQkJZRUZDUHlTY1JQaytUdkorYkU5aWhzUDZLNy9TNUxNQThHQTFVZEV3RUIvd1FGTUFNQkFmOHdId1lEVlIwakJCZ3dGb0FVdTdEZW9WZ3ppSnFraXBuZXZyM3JyOXJMSktzd053WURWUjBmQkRBd0xqQXNvQ3FnS0lZbWFIUjBjRG92TDJOeWJDNWhjSEJzWlM1amIyMHZZWEJ3YkdWeWIyOTBZMkZuTXk1amNtd3dEZ1lEVlIwUEFRSC9CQVFEQWdFR01CQUdDaXFHU0liM1kyUUdBZzRFQWdVQU1Bb0dDQ3FHU000OUJBTUNBMmNBTUdRQ01EclBjb05SRnBteGh2czF3MWJLWXIvMEYrM1pEM1ZOb282KzhaeUJYa0szaWZpWTk1dFpuNWpWUVEyUG5lbkMvZ0l3TWkzVlJDR3dvd1YzYkYzek9EdVFaLzBYZkN3aGJaWlB4bkpwZ2hKdlZQaDZmUnVaeTVzSmlTRmhCcGtQQ1pJZEFBQXhnZ0dITUlJQmd3SUJBVENCaGpCNk1TNHdMQVlEVlFRRERDVkJjSEJzWlNCQmNIQnNhV05oZEdsdmJpQkpiblJsWjNKaGRHbHZiaUJEUVNBdElFY3pNU1l3SkFZRFZRUUxEQjFCY0hCc1pTQkRaWEowYVdacFkyRjBhVzl1SUVGMWRHaHZjbWwwZVRFVE1CRUdBMVVFQ2d3S1FYQndiR1VnU1c1akxqRUxNQWtHQTFVRUJoTUNWVk1DQ0ZuWW9ieXE5T1BOTUFzR0NXQ0dTQUZsQXdRQ0FhQ0JrekFZQmdrcWhraUc5dzBCQ1FNeEN3WUpLb1pJaHZjTkFRY0JNQndHQ1NxR1NJYjNEUUVKQlRFUEZ3MHlOREV5TVRJd09ESTFNalphTUNnR0NTcUdTSWIzRFFFSk5ERWJNQmt3Q3dZSllJWklBV1VEQkFJQm9Rb0dDQ3FHU000OUJBTUNNQzhHQ1NxR1NJYjNEUUVKQkRFaUJDQmZHSHBFQ2RnOWQ0YWl0VTlDRndSTGVEYXNZSDRMdUNuQjIvZHd2VFE2SWpBS0JnZ3Foa2pPUFFRREFnUkdNRVFDSUhnK3dKd25RdlJuZEdIN1UrL1hVb094c21VRVI2a2RqQ0RQNStTajF4eXpBaUJydEdIUGtWUXB1VEFHeDQ5SllEUFl5MzdhUDhoeGxtK1VjRThzVWFFa0V3QUFBQUFBQUE9PSIsCiAgICAgICJoZWFkZXIiOiB7CiAgICAgICAgInB1YmxpY0tleUhhc2giOiAiMkNnWTU3TERJVFVEMHFSN0R3eUhsdVRtMTIyQnowOXNhczJCVVorRUU5VT0iLAogICAgICAgICJlcGhlbWVyYWxQdWJsaWNLZXkiOiAiTUZrd0V3WUhLb1pJemowQ0FRWUlLb1pJemowREFRY0RRZ0FFQmN1VGNHRGl0V1B3UVE5SFZ0d1dEZmRkZDlhelJ3VFJlL00zVUNSb3NHaEhhUklQUnNoZWp2ZWpaL0Z4MlFiamVYRmNRSnVra0creUdYUmlnTDR2MUE9PSIsCiAgICAgICAgInRyYW5zYWN0aW9uSWQiOiAiNzAwOTVhMWFjMTZkNGQ4NzAyODQ0ZDdjZDJhZGVkZWMxZmQyMzA0YTFkNmU3OTBhZWVmOWJjYzA5MmZkYjk2MSIKICAgICAgfSwKICAgICAgInZlcnNpb24iOiAiRUNfdjEifQ==", "payment_method": { "display_name": "Discover 9319", "network": "Discover", "type": "credit" }, "transaction_identifier": "c635c5b3af900d7bd81fecd7028f1262f9d030754ee65ec7afd988a678194751" } } } }' ``` Payment method list - ``` curl --location 'http://localhost:8080/account/payment_methods?client_secret=pay_mgPMJsvP0EXSt7fDSmIF_secret_TbYn03eKtktMmmjUMTKe' \ --header 'Accept: application/json' \ --header 'api-key: pk_dev_bc5af669d7594cb7aaf277fc6b6c60dc' ``` Routing approach after this - <img width="850" alt="image" src="https://github.com/user-attachments/assets/4d637044-03e0-4c34-ab7c-abbe60a700fc" /> test straight_through routing - ``` curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_BNOaWRzwyZ3hMAbhRNtp9t6Mx7ZSVyK5gPvd1bavl0FWehvrHlre1eMifYA244TE' \ --data-raw '{ "amount": 6540, "currency": "USD", "confirm": true, "capture_method": "automatic", "capture_on": "2022-09-10T10:11:12Z", "amount_to_capture": 6540, "customer_id": "StripeCustomer", "profile_id": "pro_EfD8EtQQSPZxXStG6B7x", "email": "[email protected]", "name": "John Doe", "phone": "999999999", "phone_country_code": "+1", "description": "Its my first payment request", "authentication_type": "no_three_ds", "return_url": "https://google.com", "payment_method": "card", "routing": { "type": "single", "data": {"connector": "stripe", "merchant_connector_id": "mca_SdftCCtpClu32qA6oijC"} }, "payment_method_type": "credit", "payment_method_data": { "card": { "card_number": "4242424242424242", "card_exp_month": "03", "card_exp_year": "30", "card_holder_name": "joseph Doe", "card_cvc": "737" } }, "billing": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "NL", "first_name": "joseph", "last_name": "Doe" }, "phone": { "number": "8056594427", "country_code": "+91" } }, "shipping": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" }, "phone": { "number": "8056594427", "country_code": "+91" } }, "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "metadata": { "udf1": "value1", "new_customer": "true", "login_date": "2019-09-10T10:11:12Z" }, "browser_info": { "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8", "language": "nl-NL", "color_depth": 24, "screen_height": 723, "screen_width": 1536, "time_zone": 0, "java_enabled": true, "java_script_enabled": true, "ip_address": "127.0.0.1" } }' ``` DB - <img width="852" alt="image" src="https://github.com/user-attachments/assets/6fa08603-19af-485b-bce2-9266b3419749" /> ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [ ] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	1c3811773ded20da19fac6f1dc679e337384f1cb	1c3811773ded20da19fac6f1dc679e337384f1cb
juspay/hyperswitch	juspay__hyperswitch-8481	Bug: [BUG] GlobalPay throws 501 for mandates below function is the culprit: ```rs fn get_payment_method_data( item: &PaymentsAuthorizeRouterData, brand_reference: Option<String>, ) -> Result<PaymentMethodData, Error> { match &item.request.payment_method_data { payment_method_data::PaymentMethodData::Card(ccard) => { Ok(PaymentMethodData::Card(requests::Card { number: ccard.card_number.clone(), expiry_month: ccard.card_exp_month.clone(), expiry_year: ccard.get_card_expiry_year_2_digit()?, cvv: ccard.card_cvc.clone(), account_type: None, authcode: None, avs_address: None, avs_postal_code: None, brand_reference, chip_condition: None, funding: None, pin_block: None, tag: None, track: None, })) } payment_method_data::PaymentMethodData::Wallet(wallet_data) => get_wallet_data(wallet_data), payment_method_data::PaymentMethodData::BankRedirect(bank_redirect) => { PaymentMethodData::try_from(bank_redirect) } _ => Err(errors::ConnectorError::NotImplemented( "Payment methods".to_string(), ))?, } } ``` just because `MandatePayment` isn't covered, it falls back to the default case which throws `501`. relevant docs: - [Tokenization](https://developer.globalpay.com/api/payment-methods-tokenization#/Create/post-payment-method) - [MIT](https://developer.globalpay.com/docs/MIT) - [Recurring](https://developer.globalpay.com/docs/payments/recurring/credentials-on-file)	diff --git a/config/config.example.toml b/config/config.example.toml index 9454b3f0adc..c6ae6f75ec5 100644 --- a/config/config.example.toml +++ b/config/config.example.toml @@ -467,6 +467,7 @@ square = { long_lived_token = false, payment_method = "card" } braintree = { long_lived_token = false, payment_method = "card" } gocardless = { long_lived_token = true, payment_method = "bank_debit" } billwerk = { long_lived_token = false, payment_method = "card" } +globalpay = { long_lived_token = false, payment_method = "card", flow = "mandates" } [debit_routing_config] # Debit Routing configs supported_currencies = "USD" # Supported currencies for debit routing diff --git a/config/deployments/integration_test.toml b/config/deployments/integration_test.toml index ddff65fa9c0..426b3ba808a 100644 --- a/config/deployments/integration_test.toml +++ b/config/deployments/integration_test.toml @@ -748,6 +748,7 @@ square = { long_lived_token = false, payment_method = "card" } stax = { long_lived_token = true, payment_method = "card,bank_debit" } stripe = { long_lived_token = false, payment_method = "wallet", payment_method_type = { list = "google_pay", type = "disable_only" } } billwerk = {long_lived_token = false, payment_method = "card"} +globalpay = { long_lived_token = false, payment_method = "card", flow = "mandates" } [webhooks] outgoing_enabled = true diff --git a/config/deployments/production.toml b/config/deployments/production.toml index 11d96d6269f..7c5cc65f2ca 100644 --- a/config/deployments/production.toml +++ b/config/deployments/production.toml @@ -758,6 +758,7 @@ square = { long_lived_token = false, payment_method = "card" } stax = { long_lived_token = true, payment_method = "card,bank_debit" } stripe = { long_lived_token = false, payment_method = "wallet", payment_method_type = { list = "google_pay", type = "disable_only" } } billwerk = {long_lived_token = false, payment_method = "card"} +globalpay = { long_lived_token = false, payment_method = "card", flow = "mandates" } [webhooks] outgoing_enabled = true diff --git a/config/deployments/sandbox.toml b/config/deployments/sandbox.toml index a372c873c78..305210ecb64 100644 --- a/config/deployments/sandbox.toml +++ b/config/deployments/sandbox.toml @@ -764,6 +764,7 @@ square = { long_lived_token = false, payment_method = "card" } stax = { long_lived_token = true, payment_method = "card,bank_debit" } stripe = { long_lived_token = false, payment_method = "wallet", payment_method_type = { list = "google_pay", type = "disable_only" } } billwerk = {long_lived_token = false, payment_method = "card"} +globalpay = { long_lived_token = false, payment_method = "card", flow = "mandates" } [webhooks] outgoing_enabled = true diff --git a/config/development.toml b/config/development.toml index 173d9363f2a..a3078b05089 100644 --- a/config/development.toml +++ b/config/development.toml @@ -895,6 +895,7 @@ braintree = { long_lived_token = false, payment_method = "card" } payme = { long_lived_token = false, payment_method = "card" } gocardless = { long_lived_token = true, payment_method = "bank_debit" } billwerk = { long_lived_token = false, payment_method = "card" } +globalpay = { long_lived_token = false, payment_method = "card", flow = "mandates" } [temp_locker_enable_config] stripe = { payment_method = "bank_transfer" } diff --git a/config/docker_compose.toml b/config/docker_compose.toml index 01abf5e8137..621b437bd28 100644 --- a/config/docker_compose.toml +++ b/config/docker_compose.toml @@ -390,6 +390,7 @@ hipay = { long_lived_token = false, payment_method = "card" } braintree = { long_lived_token = false, payment_method = "card" } gocardless = { long_lived_token = true, payment_method = "bank_debit" } billwerk = { long_lived_token = false, payment_method = "card" } +globalpay = { long_lived_token = false, payment_method = "card", flow = "mandates" } [temp_locker_enable_config] stripe = { payment_method = "bank_transfer" } diff --git a/crates/hyperswitch_connectors/src/connectors/globalpay.rs b/crates/hyperswitch_connectors/src/connectors/globalpay.rs index 7e9ad1aa820..215c8322dff 100644 --- a/crates/hyperswitch_connectors/src/connectors/globalpay.rs +++ b/crates/hyperswitch_connectors/src/connectors/globalpay.rs @@ -34,7 +34,7 @@ use hyperswitch_domain_models::{ types::{ PaymentsAuthorizeRouterData, PaymentsCancelRouterData, PaymentsCaptureRouterData, PaymentsCompleteAuthorizeRouterData, PaymentsSyncRouterData, RefundSyncRouterData, - RefundsRouterData, + RefundsRouterData, TokenizationRouterData, }, }; use hyperswitch_interfaces::{ @@ -49,7 +49,7 @@ use hyperswitch_interfaces::{ types::{ PaymentsAuthorizeType, PaymentsCaptureType, PaymentsCompleteAuthorizeType, PaymentsSyncType, PaymentsVoidType, RefreshTokenType, RefundExecuteType, RefundSyncType, - Response, + Response, TokenizationType, }, webhooks::{IncomingWebhook, IncomingWebhookRequestDetails}, }; @@ -61,6 +61,7 @@ use response::{ use serde_json::Value; use crate::{ + connectors::globalpay::response::GlobalpayPaymentMethodsResponse, constants::headers, types::{RefreshTokenRouterData, ResponseRouterData}, utils::{ @@ -381,7 +382,79 @@ impl api::PaymentToken for Globalpay {} impl ConnectorIntegration<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData> for Globalpay { - // Not Implemented (R) + fn get_headers( + &self, + req: &TokenizationRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + fn get_url( + &self, + _req: &TokenizationRouterData, + connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Ok(format!("{}/payment-methods", self.base_url(connectors),)) + } + + fn build_request( + &self, + req: &TokenizationRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&TokenizationType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(TokenizationType::get_headers(self, req, connectors)?) + .set_body(TokenizationType::get_request_body(self, req, connectors)?) + .build(), + )) + } + + fn get_request_body( + &self, + req: &TokenizationRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let connector_req = requests::GlobalPayPaymentMethodsRequest::try_from(req)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn handle_response( + &self, + data: &TokenizationRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<TokenizationRouterData, errors::ConnectorError> { + let response: GlobalpayPaymentMethodsResponse = res + .response + .parse_struct("GlobalpayPaymentMethodsResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + .change_context(errors::ConnectorError::ResponseHandlingFailed) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } } impl api::MandateSetup for Globalpay {} diff --git a/crates/hyperswitch_connectors/src/connectors/globalpay/requests.rs b/crates/hyperswitch_connectors/src/connectors/globalpay/requests.rs index 45749332081..056e546db20 100644 --- a/crates/hyperswitch_connectors/src/connectors/globalpay/requests.rs +++ b/crates/hyperswitch_connectors/src/connectors/globalpay/requests.rs @@ -16,78 +16,17 @@ pub struct GlobalpayCancelRouterData<T> { #[derive(Debug, Serialize)] pub struct GlobalpayPaymentsRequest { - /// A meaningful label for the merchant account set by Global Payments. pub account_name: Secret<String>, - /// The amount to transfer between Payer and Merchant for a SALE or a REFUND. It is always - /// represented in the lowest denomiation of the related currency. pub amount: Option<StringMinorUnit>, - /// Indicates if the merchant would accept an authorization for an amount less than the - /// requested amount. This is available for CP channel - /// only where the balance not authorized can be processed again using a different card. - pub authorization_mode: Option<AuthorizationMode>, - /// Indicates whether the transaction is to be captured automatically, later or later using - /// more than 1 partial capture. + pub currency: String, + pub reference: String, + pub country: api_models::enums::CountryAlpha2, pub capture_mode: Option<CaptureMode>, - /// The amount of the transaction that relates to cashback.It is always represented in the - /// lowest denomiation of the related currency. - pub cashback_amount: Option<StringMinorUnit>, - /// Describes whether the transaction was processed in a face to face(CP) scenario or a - /// Customer Not Present (CNP) scenario. + pub notifications: Option<Notifications>, + pub payment_method: GlobalPayPaymentMethodData, pub channel: Channel, - /// The amount that reflects the charge the merchant applied to the transaction for availing - /// of a more convenient purchase.It is always represented in the lowest denomiation of the - /// related currency. - pub convenience_amount: Option<StringMinorUnit>, - /// The country in ISO-3166-1(alpha-2 code) format. - pub country: api_models::enums::CountryAlpha2, - /// The currency of the amount in ISO-4217(alpha-3) - pub currency: String, - - pub currency_conversion: Option<CurrencyConversion>, - /// Merchant defined field to describe the transaction. - pub description: Option<String>, - - pub device: Option<Device>, - /// The amount of the gratuity for a transaction.It is always represented in the lowest - /// denomiation of the related currency. - pub gratuity_amount: Option<StringMinorUnit>, - /// Indicates whether the Merchant or the Payer initiated the creation of a transaction. pub initiator: Option<Initiator>, - /// Indicates the source IP Address of the system used to create the transaction. - pub ip_address: Option<Secret<String, common_utils::pii::IpAddress>>, - /// Indicates the language the transaction was executed in. In the format ISO-639-1 (alpha-2) - /// or ISO-639-1 (alpha-2)_ISO-3166(alpha-2) - pub language: Option<Language>, - - pub lodging: Option<Lodging>, - /// Indicates to Global Payments where the merchant wants to receive notifications of certain - /// events that occur on the Global Payments system. - pub notifications: Option<Notifications>, - - pub order: Option<Order>, - /// The merchant's payer reference for the transaction - pub payer_reference: Option<String>, - pub payment_method: PaymentMethod, - /// Merchant defined field to reference the transaction. - pub reference: String, - /// A merchant defined reference for the location that created the transaction. - pub site_reference: Option<String>, - /// Stored data information used to create a transaction. pub stored_credential: Option<StoredCredential>, - /// The amount that reflects the additional charge the merchant applied to the transaction - /// for using a specific payment method.It is always represented in the lowest denomiation of - /// the related currency. - pub surcharge_amount: Option<StringMinorUnit>, - /// Indicates the total or expected total of captures that will executed against a - /// transaction flagged as being captured multiple times. - pub total_capture_count: Option<i64>, - /// Describes whether the transaction is a SALE, that moves funds from Payer to Merchant, or - /// a REFUND where funds move from Merchant to Payer. - #[serde(rename = "type")] - pub globalpay_payments_request_type: Option<GlobalpayPaymentsRequestType>, - /// The merchant's user reference for the transaction. This represents the person who - /// processed the transaction on the merchant's behalf like a clerk or cashier reference. - pub user_reference: Option<String>, } #[derive(Debug, Serialize)] @@ -98,256 +37,60 @@ pub struct GlobalpayRefreshTokenRequest { pub grant_type: String, } -#[derive(Debug, Serialize, Deserialize)] -pub struct CurrencyConversion { - /// A unique identifier generated by Global Payments to identify the currency conversion. It - /// can be used to reference a currency conversion when processing a sale or a refund - /// transaction. - pub id: Option<String>, -} - -#[derive(Debug, Serialize, Deserialize)] -pub struct Device { - pub capabilities: Option<Capabilities>, - - pub entry_modes: Option<Vec<Vec<DeviceEntryMode>>>, - /// Describes whether a device prompts a payer for a gratuity when the payer is entering - /// their payment method details to the device. - pub gratuity_prompt_mode: Option<GratuityPromptMode>, - /// Describes the receipts a device prints when processing a transaction. - pub print_receipt_mode: Option<PrintReceiptMode>, - /// The sequence number from the device used to align with processing platform. - pub sequence_number: Option<Secret<String>>, - /// A unique identifier for the physical device. This value persists with the device even if - /// it is repurposed. - pub serial_number: Option<Secret<String>>, - /// The time from the device in ISO8601 format - pub time: Option<String>, -} - -#[derive(Debug, Serialize, Deserialize)] -pub struct Capabilities { - pub authorization_modes: Option<Vec<AuthorizationMode>>, - /// The number of lines that can be used to display information on the device. - pub display_line_count: Option<f64>, - - pub enabled_response: Option<Vec<EnabledResponse>>, - - pub entry_modes: Option<Vec<CapabilitiesEntryMode>>, - - pub fraud: Option<Vec<AuthorizationMode>>, - - pub mobile: Option<Vec<Mobile>>, - - pub payer_verifications: Option<Vec<PayerVerification>>, -} - -#[derive(Debug, Serialize, Deserialize)] -pub struct Lodging { - /// A reference that identifies the booking reference for a lodging stay. - pub booking_reference: Option<String>, - /// The amount charged for one nights lodging. - pub daily_rate_amount: Option<StringMinorUnit>, - /// A reference that identifies the booking reference for a lodging stay. - pub date_checked_in: Option<String>, - /// The check out date for a lodging stay. - pub date_checked_out: Option<String>, - /// The total number of days of the lodging stay. - pub duration_days: Option<f64>, - #[serde(rename = "lodging.charge_items")] - pub lodging_charge_items: Option<Vec<LodgingChargeItem>>, -} - -#[derive(Debug, Serialize, Deserialize)] -pub struct LodgingChargeItem { - pub payment_method_program_codes: Option<Vec<PaymentMethodProgramCode>>, - /// A reference that identifies the charge item, such as a lodging folio number. - pub reference: Option<String>, - /// The total amount for the list of charge types for a charge item. - pub total_amount: Option<StringMinorUnit>, - - pub types: Option<Vec<TypeElement>>, -} - -/// Indicates to Global Payments where the merchant wants to receive notifications of certain -/// events that occur on the Global Payments system. #[derive(Debug, Serialize, Deserialize, Default)] pub struct Notifications { - /// The merchant URL that will receive the notification when the customer has completed the - /// authentication. - pub challenge_return_url: Option<String>, - /// The merchant URL that will receive the notification when the customer has completed the - /// authentication when the authentication is decoupled and separate to the purchase. - pub decoupled_challenge_return_url: Option<String>, - /// The merchant URL to return the payer to, once the payer has completed payment using the - /// payment method. This returns control of the payer's payment experience to the merchant. pub return_url: Option<String>, - /// The merchant URL to notify the merchant of the latest status of the transaction. pub status_url: Option<String>, - /// The merchant URL that will receive the notification when the 3DS ACS successfully gathers - /// de ice informatiSon and tonotification_configurations.cordingly. - pub three_ds_method_return_url: Option<String>, - /// The URL on merchant's website to which the customer should be redirected in the event of - /// the customer canceling the transaction. pub cancel_url: Option<String>, } -#[derive(Debug, Serialize, Deserialize)] -pub struct Order { - /// Merchant defined field common to all transactions that are part of the same order. - pub reference: Option<String>, -} - #[derive(Debug, Serialize, Deserialize)] #[serde(rename_all = "snake_case")] pub enum PaymentMethodData { Card(Card), Apm(Apm), - BankTransfer(BankTransfer), DigitalWallet(DigitalWallet), + Token(TokenizationData), } #[derive(Debug, Serialize, Deserialize)] -pub struct PaymentMethod { +pub struct CommonPaymentMethodData { #[serde(flatten)] pub payment_method_data: PaymentMethodData, - pub authentication: Option<Authentication>, - pub encryption: Option<Encryption>, - /// Indicates how the payment method information was obtained by the Merchant for this - /// transaction. pub entry_mode: PaymentMethodEntryMode, - /// Indicates whether to execute the fingerprint signature functionality. - pub fingerprint_mode: Option<FingerprintMode>, - /// Specify the first name of the owner of the payment method. - pub first_name: Option<Secret<String>>, - /// Unique Global Payments generated id used to reference a stored payment method on the - /// Global Payments system. Often referred to as the payment method token. This value can be - /// used instead of payment method details such as a card number and expiry date. - pub id: Option<Secret<String>>, - /// Specify the surname of the owner of the payment method. - pub last_name: Option<Secret<String>>, - /// The full name of the owner of the payment method. - pub name: Option<Secret<String>>, - /// Contains the value a merchant wishes to appear on the payer's payment method statement - /// for this transaction - pub narrative: Option<String>, - /// Indicates whether to store the card as part of a transaction. - pub storage_mode: Option<CardStorageMode>, -} - -#[derive(Debug, Serialize, Deserialize)] -pub struct Apm { - /// A string used to identify the payment method provider being used to execute this - /// transaction. - pub provider: Option<ApmProvider>, -} - -/// Information outlining the degree of authentication executed related to a transaction. -#[derive(Debug, Serialize, Deserialize)] -pub struct Authentication { - /// Information outlining the degree of 3D Secure authentication executed. - pub three_ds: Option<ThreeDs>, - /// A message authentication code that is used to confirm the security and integrity of the - /// messaging to Global Payments. - pub mac: Option<String>, } -/// Information outlining the degree of 3D Secure authentication executed. #[derive(Debug, Serialize, Deserialize)] -pub struct ThreeDs { - /// The reference created by the 3DSecure Directory Server to identify the specific - /// authentication attempt. - pub ds_trans_reference: Option<String>, - /// An indication of the degree of the authentication and liability shift obtained for this - /// transaction. It is determined during the 3D Secure process. 2 or 1 for Mastercard - /// indicates the merchant has a liability shift. 5 or 6 for Visa or Amex indicates the - /// merchant has a liability shift. However for Amex if the payer is not enrolled the eci may - /// still be 6 but liability shift has not bee achieved. - pub eci: Option<String>, - /// Indicates if any exemptions apply to this transaction. - pub exempt_status: Option<ExemptStatus>, - /// Indicates the version of 3DS - pub message_version: Option<String>, - /// The reference created by the 3DSecure provider to identify the specific authentication - /// attempt. - pub server_trans_reference: Option<String>, - /// The authentication value created as part of the 3D Secure process. - pub value: Option<String>, +pub struct MandatePaymentMethodData { + pub entry_mode: PaymentMethodEntryMode, + pub id: Option<String>, } #[derive(Debug, Serialize, Deserialize)] -pub struct BankTransfer { - /// The number or reference for the payer's bank account. - pub account_number: Option<Secret<String>>, - - pub bank: Option<Bank>, - /// The number or reference for the check - pub check_reference: Option<Secret<String>>, - /// The type of bank account associated with the payer's bank account. - pub number_type: Option<NumberType>, - /// Indicates how the transaction was authorized by the merchant. - pub sec_code: Option<SecCode>, -} -#[derive(Debug, Serialize, Deserialize)] -pub struct Bank { - pub address: Option<Address>, - /// The local identifier code for the bank. - pub code: Option<Secret<String>>, - /// The name of the bank. - pub name: Option<String>, +#[serde(untagged)] +pub enum GlobalPayPaymentMethodData { + Common(CommonPaymentMethodData), + Mandate(MandatePaymentMethodData), } #[derive(Debug, Serialize, Deserialize)] -pub struct Address { - /// Merchant defined field common to all transactions that are part of the same order. - pub city: Option<Secret<String>>, - /// The country in ISO-3166-1(alpha-2 code) format. - pub country: Option<String>, - /// First line of the address. - pub line_1: Option<Secret<String>>, - /// Second line of the address. - pub line_2: Option<Secret<String>>, - /// Third line of the address. - pub line_3: Option<Secret<String>>, - /// The city or town of the address. - pub postal_code: Option<Secret<String>>, - /// The state or region of the address. ISO 3166-2 minus the country code itself. For - /// example, US Illinois = IL, or in the case of GB counties Wiltshire = WI or Aberdeenshire - /// = ABD - pub state: Option<String>, +pub struct Apm { + /// A string used to identify the payment method provider being used to execute this + /// transaction. + pub provider: Option<ApmProvider>, } #[derive(Debug, Default, Serialize, Deserialize)] pub struct Card { - /// The card providers description of their card product. - pub account_type: Option<String>, - /// Code generated when the card is successfully authorized. - pub authcode: Option<Secret<String>>, - /// First line of the address associated with the card. - pub avs_address: Option<String>, - /// Postal code of the address associated with the card. - pub avs_postal_code: Option<String>, - /// The unique reference created by the brands/schemes to uniquely identify the transaction. - pub brand_reference: Option<String>, - /// Indicates if a fallback mechanism was used to obtain the card information when EMV/chip - /// did not work as expected. - pub chip_condition: Option<ChipCondition>, - /// The numeric value printed on the physical card. pub cvv: Secret<String>, - /// The 2 digit expiry date month of the card. pub expiry_month: Secret<String>, - /// The 2 digit expiry date year of the card. pub expiry_year: Secret<String>, - /// Indicates whether the card is a debit or credit card. - pub funding: Option<Funding>, - /// The card account number used to authorize the transaction. Also known as PAN. pub number: cards::CardNumber, - /// Contains the pin block info, relating to the pin code the Payer entered. - pub pin_block: Option<Secret<String>>, - /// The full card tag data for an EMV/chip card transaction. - pub tag: Option<Secret<String>>, - /// Data from magnetic stripe of a card - pub track: Option<Secret<String>>, +} + +#[derive(Debug, Default, Serialize, Deserialize)] +pub struct TokenizationData { + pub brand_reference: Option<String>, } #[derive(Debug, Serialize, Deserialize)] @@ -358,16 +101,6 @@ pub struct DigitalWallet { pub payment_token: Option<serde_json::Value>, } -#[derive(Debug, Serialize, Deserialize)] -pub struct Encryption { - /// The encryption info used when sending encrypted card data to Global Payments. - pub info: Option<Secret<String>>, - /// The encryption method used when sending encrypted card data to Global Payments. - pub method: Option<Method>, - /// The version of encryption being used. - pub version: Option<String>, -} - /// Stored data information used to create a transaction. #[derive(Debug, Serialize, Deserialize)] pub struct StoredCredential { @@ -379,22 +112,6 @@ pub struct StoredCredential { pub sequence: Option<Sequence>, } -/// Indicates if the merchant would accept an authorization for an amount less than the -/// requested amount. This is available for CP channel -/// only where the balance not authorized can be processed again using a different card. -/// -/// Describes the instruction a device can indicate to the clerk in the case of fraud. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum AuthorizationMode { - /// Indicates merchant would accept an authorization for an amount less than the - /// requested amount. - /// pub example: PARTIAL - /// - /// Describes whether the device can process partial authorizations. - Partial, -} - /// Indicates whether the transaction is to be captured automatically, later or later using /// more than 1 partial capture. #[derive(Debug, Serialize, Deserialize)] @@ -432,88 +149,6 @@ pub enum Channel { CustomerPresent, } -/// Describes the data the device can handle when it receives a response for a card -/// authorization. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum EnabledResponse { - Avs, - BrandReference, - Cvv, - MaskedNumberLast4, -} - -/// Describes the entry mode capabilities a device has. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum CapabilitiesEntryMode { - Chip, - Contactless, - ContactlessSwipe, - Manual, - Swipe, -} - -/// Describes the mobile features a device has -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum Mobile { - IntegratedCardReader, - SeparateCardReader, -} - -/// Describes the capabilities a device has to verify a payer. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum PayerVerification { - ContactlessSignature, - PayerDevice, - Pinpad, -} - -/// Describes the allowed entry modes to obtain payment method information from the payer as -/// part of a transaction request. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum DeviceEntryMode { - Chip, - Contactless, - Manual, - Swipe, -} - -/// Describes whether a device prompts a payer for a gratuity when the payer is entering -/// their payment method details to the device. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum GratuityPromptMode { - NotRequired, - Prompt, -} - -/// Describes the receipts a device prints when processing a transaction. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum PrintReceiptMode { - Both, - Merchant, - None, - Payer, -} - -/// Describes whether the transaction is a SALE, that moves funds from Payer to Merchant, or -/// a REFUND where funds move from Merchant to Payer. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum GlobalpayPaymentsRequestType { - /// indicates the movement, or the attempt to move, funds from merchant to the - /// payer. - Refund, - /// indicates the movement, or the attempt to move, funds from payer to a - /// merchant. - Sale, -} - /// Indicates whether the Merchant or the Payer initiated the creation of a transaction. #[derive(Debug, Serialize, Deserialize)] #[serde(rename_all = "SCREAMING_SNAKE_CASE")] @@ -525,45 +160,6 @@ pub enum Initiator { Payer, } -/// Indicates the language the transaction was executed in. In the format ISO-639-1 (alpha-2) -/// or ISO-639-1 (alpha-2)_ISO-3166(alpha-2) -#[derive(Debug, Serialize, Deserialize)] -pub enum Language { - #[serde(rename = "fr")] - Fr, - #[serde(rename = "fr_CA")] - FrCa, - #[serde(rename = "ISO-639(alpha-2)")] - Iso639Alpha2, - #[serde(rename = "ISO-639(alpha-2)_ISO-3166(alpha-2)")] - Iso639alpha2Iso3166alpha2, -} - -/// Describes the payment method programs, typically run by card brands such as Amex, Visa -/// and MC. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum PaymentMethodProgramCode { - AssuredReservation, - CardDeposit, - Other, - Purchase, -} - -/// Describes the types of charges associated with a transaction. This can be one or more -/// than more charge type. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum TypeElement { - GiftShop, - Laundry, - MiniBar, - NoShow, - Other, - Phone, - Restaurant, -} - /// A string used to identify the payment method provider being used to execute this /// transaction. #[derive(Debug, Serialize, Deserialize)] @@ -577,87 +173,6 @@ pub enum ApmProvider { Testpay, } -/// Indicates if any exemptions apply to this transaction. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum ExemptStatus { - LowValue, - ScaDelegation, - SecureCorporatePayment, - TransactionRiskAnalysis, - TrustedMerchant, -} - -/// The type of bank account associated with the payer's bank account. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum NumberType { - Checking, - Savings, -} - -/// Indicates how the transaction was authorized by the merchant. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum SecCode { - /// Cash Concentration or Disbursement - Can be either a credit or debit application - /// where funds are wither distributed or consolidated between corporate entities. - #[serde(rename = "CCD")] - CashConcentrationOrDisbursement, - - /// Point of Sale Entry - Point of sale debit applications non-shared (POS) - /// environment. These transactions are most often initiated by the consumer via a plastic - /// access card. This is only support for normal ACH transactions - #[serde(rename = "POP")] - PointOfSaleEntry, - /// Prearranged Payment and Deposits - used to credit or debit a consumer account. - /// Popularity used for payroll direct deposits and pre-authorized bill payments. - #[serde(rename = "PPD")] - PrearrangedPaymentAndDeposits, - /// Telephone-Initiated Entry - Used for the origination of a single entry debit - /// transaction to a consumer's account pursuant to a verbal authorization obtained from the - /// consumer via the telephone. - #[serde(rename = "TEL")] - TelephoneInitiatedEntry, - /// Internet (Web)-Initiated Entry - Used for the origination of debit entries - /// (either Single or Recurring Entry) to a consumer's account pursuant to a to an - /// authorization that is obtained from the Receiver via the Internet. - #[serde(rename = "WEB")] - WebInitiatedEntry, -} - -/// Indicates if a fallback mechanism was used to obtain the card information when EMV/chip -/// did not work as expected. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum ChipCondition { - /// indicates the previous transaction with this card failed. - PrevFailed, - /// indicates the previous transaction with this card was a success. - PrevSuccess, -} - -/// Indicates whether the card is a debit or credit card. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum Funding { - /// indicates the card is an, Electronic Benefits Transfer, for cash - /// benefits. - CashBenefits, - /// indicates the card is a credit card where the funds may be available on credit - /// to the payer to fulfill the transaction amount. - Credit, - /// indicates the card is a debit card where the funds may be present in an account - /// to fulfill the transaction amount. - Debit, - /// indicates the card is an, Electronic Benefits Transfer, for food stamps. - FoodStamp, - /// indicates the card is a prepaid card where the funds are loaded to the card - /// account to fulfill the transaction amount. Unlike a debit card, a prepaid is not linked - /// to a bank account. - Prepaid, -} - /// Identifies who provides the digital wallet for the Payer. #[derive(Debug, Serialize, Deserialize)] #[serde(rename_all = "SCREAMING_SNAKE_CASE")] @@ -666,27 +181,6 @@ pub enum DigitalWalletProvider { PayByGoogle, } -/// Indicates if the actual card number or a token is being used to process the -/// transaction. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum TokenFormat { - /// The value in the digital wallet token field is a real card number - /// (PAN) - CardNumber, - /// The value in the digital wallet token field is a temporary token in the - /// format of a card number (PAN) but is not a real card number. - CardToken, -} - -/// The encryption method used when sending encrypted card data to Global Payments. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum Method { - Ksn, - Ktb, -} - /// Indicates how the payment method information was obtained by the Merchant for this /// transaction. #[derive(Debug, Default, Serialize, Deserialize)] @@ -727,30 +221,6 @@ pub enum PaymentMethodEntryMode { Swipe, } -/// Indicates whether to execute the fingerprint signature functionality. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum FingerprintMode { - /// Always check and create the fingerprint value regardless of the result of the - /// card authorization. - Always, - /// Always check and create the fingerprint value when the card authorization - /// is successful. - OnSuccess, -} - -/// Indicates whether to store the card as part of a transaction. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum CardStorageMode { - /// /// The card information is always stored irrespective of whether the payment - /// method authorization was successful or not. - Always, - /// The card information is only stored if the payment method authorization was - /// successful. - OnSuccess, -} - /// Indicates the transaction processing model being executed when using stored /// credentials. #[derive(Debug, Serialize, Deserialize)] @@ -775,17 +245,6 @@ pub enum Model { Unscheduled, } -/// The reason stored credentials are being used to create a transaction. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum Reason { - Delayed, - Incremental, - NoShow, - Reauthorization, - Resubmission, -} - /// Indicates the order of this transaction in the sequence of a planned repeating /// transaction processing model. #[derive(Debug, Serialize, Deserialize)] @@ -812,3 +271,34 @@ pub struct GlobalpayCaptureRequest { pub struct GlobalpayCancelRequest { pub amount: Option<StringMinorUnit>, } + +#[derive(Default, Debug, Serialize, Deserialize)] +#[serde(rename_all = "SCREAMING_SNAKE_CASE")] +pub enum UsageMode { + /// This value must be used if using the Hosted Fields or the Drop-in UI integration types. + /// When creating the payment method token, this option ensures the payment method token is temporary and will be removed once a transaction is executed or after a short period of time. + #[default] + Single, + /// When creating the payment method token, this indicates it is permanent and can be used to create many transactions. + Multiple, + /// When using the payment method token to transaction process, this indicates to use the card number also known as the PAN or FPAN when both the card number and the network token are available. + UseCardNumber, + /// When using the payment method token to transaction process, this indicates to use the network token instead of the card number if both are available. + UseNetworkToken, +} + +#[derive(Default, Debug, Serialize, Deserialize)] +pub struct GlobalPayPayer { + /// Unique identifier for the Payer on the Global Payments system. + #[serde(rename = "id", skip_serializing_if = "Option::is_none")] + pub payer_id: Option<String>, +} + +#[derive(Default, Debug, Serialize)] +pub struct GlobalPayPaymentMethodsRequest { + pub reference: String, + #[serde(skip_serializing_if = "Option::is_none")] + pub usage_mode: Option<UsageMode>, + #[serde(skip_serializing_if = "Option::is_none")] + pub card: Option<Card>, +} diff --git a/crates/hyperswitch_connectors/src/connectors/globalpay/response.rs b/crates/hyperswitch_connectors/src/connectors/globalpay/response.rs index 11bd9e1a047..daa629641e6 100644 --- a/crates/hyperswitch_connectors/src/connectors/globalpay/response.rs +++ b/crates/hyperswitch_connectors/src/connectors/globalpay/response.rs @@ -3,75 +3,17 @@ use common_utils::types::StringMinorUnit; use masking::Secret; use serde::{Deserialize, Serialize}; -use super::requests; use crate::utils::deserialize_optional_currency; #[derive(Debug, Serialize, Deserialize)] pub struct GlobalpayPaymentsResponse { - /// A unique identifier for the merchant account set by Global Payments. - pub account_id: Option<Secret<String>>, - /// A meaningful label for the merchant account set by Global Payments. - pub account_name: Option<Secret<String>>, - /// Information about the Action executed. - pub action: Option<Action>, - /// The amount to transfer between Payer and Merchant for a SALE or a REFUND. It is always - /// represented in the lowest denomiation of the related currency. + pub status: GlobalpayPaymentStatus, + pub payment_method: Option<PaymentMethod>, + pub id: String, pub amount: Option<StringMinorUnit>, - /// Indicates if the merchant would accept an authorization for an amount less than the - /// requested amount. This is available for CP channel - /// only where the balance not authorized can be processed again using a different card. - pub authorization_mode: Option<requests::AuthorizationMode>, - /// A Global Payments created reference that uniquely identifies the batch. - pub batch_id: Option<String>, - /// Indicates whether the transaction is to be captured automatically, later or later using - /// more than 1 partial capture. - pub capture_mode: Option<requests::CaptureMode>, - /// Describes whether the transaction was processed in a face to face(CP) scenario or a - /// Customer Not Present (CNP) scenario. - pub channel: Option<requests::Channel>, - /// The country in ISO-3166-1(alpha-2 code) format. - pub country: Option<String>, - /// The currency of the amount in ISO-4217(alpha-3) #[serde(deserialize_with = "deserialize_optional_currency")] pub currency: Option<Currency>, - /// Information relating to a currency conversion. - pub currency_conversion: Option<requests::CurrencyConversion>, - /// A unique identifier generated by Global Payments to identify the transaction. - pub id: String, - /// A unique identifier for the merchant set by Global Payments. - pub merchant_id: Option<String>, - /// A meaningful label for the merchant set by Global Payments. - pub merchant_name: Option<Secret<String>>, - pub payment_method: Option<PaymentMethod>, - /// Merchant defined field to reference the transaction. pub reference: Option<String>, - /// Indicates where a transaction is in its lifecycle. - pub status: GlobalpayPaymentStatus, - /// Global Payments time indicating when the object was created in ISO-8601 format. - pub time_created: Option<String>, - /// Describes whether the transaction is a SALE, that moves funds from Payer to Merchant, or - /// a REFUND where funds move from Merchant to Payer. - #[serde(rename = "type")] - pub globalpay_payments_response_type: Option<requests::GlobalpayPaymentsRequestType>, -} - -/// Information about the Action executed. -#[derive(Debug, Serialize, Deserialize)] -pub struct Action { - /// The id of the app that was used to create the token. - pub app_id: Option<Secret<String>>, - /// The name of the app the user gave to the application. - pub app_name: Option<Secret<String>>, - /// A unique identifier for the object created by Global Payments. The first 3 characters - /// identifies the resource an id relates to. - pub id: Option<Secret<String>>, - /// The result of the action executed. - pub result_code: Option<ResultCode>, - /// Global Payments time indicating when the object was created in ISO-8601 format. - pub time_created: Option<String>, - /// Indicates the action taken. - #[serde(rename = "type")] - pub action_type: Option<ActionType>, } #[derive(Debug, Deserialize, Serialize)] @@ -86,230 +28,25 @@ pub struct GlobalpayRefreshTokenErrorResponse { pub detailed_error_description: String, } -/// Information relating to a currency conversion. -#[derive(Debug, Serialize, Deserialize)] -pub struct CurrencyConversion { - /// The percentage commission taken for providing the currency conversion. - pub commission_percentage: Option<String>, - /// The exchange rate used to convert one currency to another. - pub conversion_rate: Option<String>, - /// The source of the base exchange rate was obtained to execute the currency conversion. - pub exchange_rate_source: Option<String>, - /// The time the base exchange rate was obtained from the source. - pub exchange_source_time: Option<String>, - /// The exchange rate used to convert one currency to another. - pub margin_rate_percentage: Option<String>, - /// The amount that will affect the payer's account. - pub payer_amount: Option<StringMinorUnit>, - /// The currency of the amount that will affect the payer's account. - pub payer_currency: Option<String>, -} - #[derive(Debug, Serialize, Deserialize)] pub struct PaymentMethod { - /// Data associated with the response of an APM transaction. pub apm: Option<Apm>, - /// Information outlining the degree of authentication executed related to a transaction. - pub authentication: Option<Authentication>, - pub bank_transfer: Option<BankTransfer>, pub card: Option<Card>, - pub digital_wallet: Option<requests::DigitalWallet>, - /// Indicates how the payment method information was obtained by the Merchant for this - /// transaction. - pub entry_mode: Option<requests::PaymentMethodEntryMode>, - /// If enabled, this field contains the unique fingerprint signature for that payment method - /// for that merchant. If the payment method is seen again this same value is generated. For - /// cards the primary account number is checked only. The expiry date or the CVV is not used - /// for this check. - pub fingerprint: Option<Secret<String>>, - /// If enabled, this field indicates whether the payment method has been seen before or is - /// new. - /// * EXISTS - Indicates that the payment method was seen on the platform before by this - /// merchant. - /// * NEW - Indicates that the payment method was not seen on the platform before by this - /// merchant. - pub fingerprint_presence_indicator: Option<String>, - /// Unique Global Payments generated id used to reference a stored payment method on the - /// Global Payments system. Often referred to as the payment method token. This value can be - /// used instead of payment method details such as a card number and expiry date. pub id: Option<Secret<String>>, - /// Result message from the payment method provider corresponding to the result code. pub message: Option<String>, - /// Result code from the payment method provider. - /// If a card authorization declines, the payment_method result and message include more detail from the Issuer on why it was declined. - /// For example, 51 - INSUFFICIENT FUNDS. This is generated by the issuing bank, who will provide decline codes in the response back to the authorization platform. pub result: Option<String>, } /// Data associated with the response of an APM transaction. #[derive(Debug, Serialize, Deserialize)] pub struct Apm { - pub bank: Option<Bank>, - /// A string generated by the payment method that represents to what degree the merchant is - /// funded for the transaction. - #[serde(skip_deserializing)] - pub fund_status: Option<FundStatus>, - pub mandate: Option<Mandate>, - /// A string used to identify the payment method provider being used to execute this - /// transaction. - pub provider: Option<ApmProvider>, - /// A name of the payer from the payment method system. - pub provider_payer_name: Option<Secret<String>>, - /// The time the payment method provider created the transaction at on their system. - pub provider_time_created: Option<String>, - /// The reference the payment method provider created for the transaction. - pub provider_transaction_reference: Option<String>, - /// URL to redirect the payer from the merchant's system to the payment method's system. - //1)paypal sends redirect_url as provider_redirect_url for require_customer_action - //2)bankredirects sends redirect_url as redirect_url for require_customer_action - //3)after completeauthorize in paypal it doesn't send redirect_url - //4)after customer action in bankredirects it sends empty string in redirect_url #[serde(alias = "provider_redirect_url")] pub redirect_url: Option<String>, - /// A string generated by the payment method to represent the session created on the payment - /// method's platform to facilitate the creation of a transaction. - pub session_token: Option<Secret<String>>, - pub payment_description: Option<String>, -} - -#[derive(Debug, Serialize, Deserialize)] -pub struct Bank { - /// The local identifier of the bank account. - pub account_number: Option<Secret<String>>, - /// The local identifier of the bank. - pub code: Option<Secret<String>>, - /// The international identifier of the bank account. - pub iban: Option<Secret<String>>, - /// The international identifier code for the bank. - pub identifier_code: Option<Secret<String>>, - /// The name associated with the bank account - pub name: Option<Secret<String>>, -} - -#[derive(Debug, Serialize, Deserialize)] -pub struct Mandate { - /// The reference to identify the mandate. - pub code: Option<Secret<String>>, -} - -/// Information outlining the degree of authentication executed related to a transaction. -#[derive(Debug, Serialize, Deserialize)] -pub struct Authentication { - /// Information outlining the degree of 3D Secure authentication executed. - pub three_ds: Option<ThreeDs>, -} - -/// Information outlining the degree of 3D Secure authentication executed. -#[derive(Debug, Serialize, Deserialize)] -pub struct ThreeDs { - /// The result of the three_ds value validation by the brands or issuing bank. - pub value_result: Option<String>, -} - -#[derive(Debug, Serialize, Deserialize)] -pub struct BankTransfer { - /// The last 4 characters of the local reference for a bank account number. - pub masked_number_last4: Option<String>, - /// The name of the bank. - pub name: Option<Secret<String>>, - /// The type of bank account associated with the payer's bank account. - pub number_type: Option<NumberType>, } #[derive(Debug, Serialize, Deserialize)] pub struct Card { - /// Code generated when the card is successfully authorized. - pub authcode: Option<Secret<String>>, - /// The recommended AVS action to be taken by the agent processing the card transaction. - pub avs_action: Option<String>, - /// The result of the AVS address check. - pub avs_address_result: Option<String>, - /// The result of the AVS postal code check. - pub avs_postal_code_result: Option<String>, - /// Indicates the card brand that issued the card. - pub brand: Option<Brand>, - /// The unique reference created by the brands/schemes to uniquely identify the transaction. pub brand_reference: Option<Secret<String>>, - /// The time returned by the card brand indicating when the transaction was processed on - /// their system. - pub brand_time_reference: Option<String>, - /// The result of the CVV check. - pub cvv_result: Option<String>, - /// Masked card number with last 4 digits showing. - pub masked_number_last4: Option<String>, - /// The result codes directly from the card issuer. - pub provider: Option<ProviderClass>, - /// The card EMV tag response data from the card issuer for a contactless or chip card - /// transaction. - pub tag_response: Option<Secret<String>>, -} - -/// The result codes directly from the card issuer. -#[derive(Debug, Serialize, Deserialize)] -pub struct ProviderClass { - /// The result code of the AVS address check from the card issuer. - #[serde(rename = "card.provider.avs_address_result")] - pub card_provider_avs_address_result: Option<String>, - /// The result of the AVS postal code check from the card issuer.. - #[serde(rename = "card.provider.avs_postal_code_result")] - pub card_provider_avs_postal_code_result: Option<String>, - /// The result code of the AVS check from the card issuer. - #[serde(rename = "card.provider.avs_result")] - pub card_provider_avs_result: Option<String>, - /// The result code of the CVV check from the card issuer. - #[serde(rename = "card.provider.cvv_result")] - pub card_provider_cvv_result: Option<String>, - /// Result code from the card issuer. - #[serde(rename = "card.provider.result")] - pub card_provider_result: Option<String>, -} - -/// The result of the action executed. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum ResultCode { - Declined, - Success, - Pending, - Error, -} - -/// Indicates the specific action taken. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum ActionType { - Adjust, - Authorize, - Capture, - Confirm, - Force, - Increment, - Initiate, - MultipleCapture, - Preauthorize, - PreauthorizeMultipleCapturere, - Authorization, - RedirectFrom, - RedirectTo, - Refund, - Hold, - Release, - Reverse, - Split, - StatusNotification, - TransactionList, - TransactionSingle, -} - -/// A string generated by the payment method that represents to what degree the merchant is -/// funded for the transaction. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum FundStatus { - Missing, - NotExpected, - Received, - Waiting, } /// A string used to identify the payment method provider being used to execute this @@ -325,49 +62,6 @@ pub enum ApmProvider { Testpay, } -/// The type of bank account associated with the payer's bank account. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum NumberType { - Checking, - Savings, -} - -/// The recommended AVS action to be taken by the agent processing the card transaction. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum AvsAction { - Accept, - Decline, - Prompt, -} - -/// The result of the AVS address check. -/// -/// The result of the AVS postal code check. -/// -/// The result of the CVV check. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum GlobalPayResult { - Matched, - NotChecked, - NotMatched, -} - -/// Indicates the card brand that issued the card. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum Brand { - Amex, - Cup, - Diners, - Discover, - Jcb, - Mastercard, - Visa, -} - /// Indicates where a transaction is in its lifecycle. #[derive(Clone, Copy, Debug, Serialize, Deserialize)] #[serde(rename_all = "SCREAMING_SNAKE_CASE")] @@ -417,3 +111,22 @@ pub enum GlobalpayWebhookStatus { #[serde(other)] Unknown, } + +#[derive(Debug, Serialize, Deserialize)] +#[serde(rename_all = "SCREAMING_SNAKE_CASE")] +pub enum GlobalpayPaymentMethodStatus { + /// The entity is ACTIVE and can be used. + Active, + /// The entity is INACTIVE and cannot be used. + Inactive, + /// The status is DELETED. Once returned in an action response for a resource. + /// The resource has been removed from the platform. + Delete, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct GlobalpayPaymentMethodsResponse { + #[serde(rename = "id")] + pub payment_method_token_id: Option<Secret<String>>, + pub card: Card, +} diff --git a/crates/hyperswitch_connectors/src/connectors/globalpay/transformers.rs b/crates/hyperswitch_connectors/src/connectors/globalpay/transformers.rs index a7fd9abd2f8..e4239d28395 100644 --- a/crates/hyperswitch_connectors/src/connectors/globalpay/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/globalpay/transformers.rs @@ -8,7 +8,7 @@ use common_utils::{ use error_stack::ResultExt; use hyperswitch_domain_models::{ payment_method_data, - router_data::{AccessToken, ConnectorAuthType, ErrorResponse, RouterData}, + router_data::{AccessToken, ConnectorAuthType, ErrorResponse, PaymentMethodToken, RouterData}, router_flow_types::{Execute, RSync}, router_request_types::ResponseId, router_response_types::{ @@ -17,6 +17,7 @@ use hyperswitch_domain_models::{ types::{ PaymentsAuthorizeRouterData, PaymentsCancelRouterData, PaymentsCaptureRouterData, PaymentsSyncRouterData, RefreshTokenRouterData, RefundExecuteRouterData, RefundsRouterData, + TokenizationRouterData, }, }; use hyperswitch_interfaces::{ @@ -37,10 +38,14 @@ use super::{ response::{GlobalpayPaymentStatus, GlobalpayPaymentsResponse, GlobalpayRefreshTokenResponse}, }; use crate::{ + connectors::globalpay::{ + requests::CommonPaymentMethodData, response::GlobalpayPaymentMethodsResponse, + }, types::{PaymentsSyncResponseRouterData, RefundsResponseRouterData, ResponseRouterData}, utils::{ self, construct_captures_response_hashmap, CardData, ForeignTryFrom, - MultipleCaptureSyncResponse, PaymentsAuthorizeRequestData, RouterData as _, WalletData, + MultipleCaptureSyncResponse, PaymentMethodTokenizationRequestData, + PaymentsAuthorizeRequestData, RouterData as _, WalletData, }, }; @@ -82,65 +87,115 @@ impl TryFrom<&Option<pii::SecretSerdeValue>> for GlobalPayMeta { impl TryFrom<&GlobalPayRouterData<&PaymentsAuthorizeRouterData>> for GlobalpayPaymentsRequest { type Error = Error; + fn try_from( item: &GlobalPayRouterData<&PaymentsAuthorizeRouterData>, ) -> Result<Self, Self::Error> { + if item.router_data.is_three_ds() { + return Err(errors::ConnectorError::NotSupported { + message: "3DS flow".to_string(), + connector: "Globalpay", + } + .into()); + } + let metadata = GlobalPayMeta::try_from(&item.router_data.connector_meta_data)?; let account_name = metadata.account_name; - let (initiator, stored_credential, brand_reference) = - get_mandate_details(item.router_data)?; - let payment_method_data = get_payment_method_data(item.router_data, brand_reference)?; + + let (initiator, stored_credential, connector_mandate_id) = + if item.router_data.request.is_mandate_payment() { + let connector_mandate_id = + item.router_data + .request + .mandate_id + .as_ref() + .and_then(\|mandate_ids\| match &mandate_ids.mandate_reference_id { + Some(api_models::payments::MandateReferenceId::ConnectorMandateId( + connector_mandate_ids, + )) => connector_mandate_ids.get_connector_mandate_id(), + _ => None, + }); + + let initiator = Some(match item.router_data.request.off_session { + Some(true) => Initiator::Merchant, + _ => Initiator::Payer, + }); + + let stored_credential = Some(StoredCredential { + model: Some(if connector_mandate_id.is_some() { + requests::Model::Recurring + } else { + requests::Model::Unscheduled + }), + sequence: Some(if connector_mandate_id.is_some() { + Sequence::Subsequent + } else { + Sequence::First + }), + }); + + (initiator, stored_credential, connector_mandate_id) + } else { + (None, None, None) + }; + + let payment_method = match &item.router_data.request.payment_method_data { + payment_method_data::PaymentMethodData::Card(ccard) => { + requests::GlobalPayPaymentMethodData::Common(CommonPaymentMethodData { + payment_method_data: PaymentMethodData::Card(requests::Card { + number: ccard.card_number.clone(), + expiry_month: ccard.card_exp_month.clone(), + expiry_year: ccard.get_card_expiry_year_2_digit()?, + cvv: ccard.card_cvc.clone(), + }), + entry_mode: Default::default(), + }) + } + + payment_method_data::PaymentMethodData::Wallet(wallet_data) => { + requests::GlobalPayPaymentMethodData::Common(CommonPaymentMethodData { + payment_method_data: get_wallet_data(wallet_data)?, + entry_mode: Default::default(), + }) + } + + payment_method_data::PaymentMethodData::BankRedirect(bank_redirect) => { + requests::GlobalPayPaymentMethodData::Common(CommonPaymentMethodData { + payment_method_data: PaymentMethodData::try_from(bank_redirect)?, + entry_mode: Default::default(), + }) + } + + payment_method_data::PaymentMethodData::MandatePayment => { + requests::GlobalPayPaymentMethodData::Mandate(requests::MandatePaymentMethodData { + entry_mode: Default::default(), + id: connector_mandate_id, + }) + } + + _ => Err(errors::ConnectorError::NotImplemented( + "Payment methods".to_string(), + ))?, + }; + Ok(Self { account_name, amount: Some(item.amount.to_owned()), currency: item.router_data.request.currency.to_string(), - reference: item.router_data.connector_request_reference_id.to_string(), country: item.router_data.get_billing_country()?, capture_mode: Some(requests::CaptureMode::from( item.router_data.request.capture_method, )), - payment_method: requests::PaymentMethod { - payment_method_data, - authentication: None, - encryption: None, - entry_mode: Default::default(), - fingerprint_mode: None, - first_name: None, - id: None, - last_name: None, - name: None, - narrative: None, - storage_mode: None, - }, + payment_method, notifications: Some(requests::Notifications { return_url: get_return_url(item.router_data), - challenge_return_url: None, - decoupled_challenge_return_url: None, status_url: item.router_data.request.webhook_url.clone(), - three_ds_method_return_url: None, cancel_url: get_return_url(item.router_data), }), - authorization_mode: None, - cashback_amount: None, + stored_credential, channel: Default::default(), - convenience_amount: None, - currency_conversion: None, - description: None, - device: None, - gratuity_amount: None, initiator, - ip_address: None, - language: None, - lodging: None, - order: None, - payer_reference: None, - site_reference: None, - stored_credential, - surcharge_amount: None, - total_capture_count: None, - globalpay_payments_request_type: None, - user_reference: None, }) } } @@ -176,6 +231,32 @@ impl TryFrom<&GlobalPayRouterData<&PaymentsCaptureRouterData>> } } +impl TryFrom<&TokenizationRouterData> for requests::GlobalPayPaymentMethodsRequest { + type Error = Error; + fn try_from(item: &TokenizationRouterData) -> Result<Self, Self::Error> { + if !item.request.is_mandate_payment() { + return Err(errors::ConnectorError::FlowNotSupported { + flow: "Tokenization apart from Mandates".to_string(), + connector: "Globalpay".to_string(), + } + .into()); + } + Ok(Self { + reference: item.connector_request_reference_id.clone(), + usage_mode: Some(requests::UsageMode::Multiple), + card: match &item.request.payment_method_data { + payment_method_data::PaymentMethodData::Card(card_data) => Some(requests::Card { + number: card_data.card_number.clone(), + expiry_month: card_data.card_exp_month.clone(), + expiry_year: card_data.get_card_expiry_year_2_digit()?, + cvv: card_data.card_cvc.clone(), + }), + _ => None, + }, + }) + } +} + impl TryFrom<&GlobalpayCancelRouterData<&PaymentsCancelRouterData>> for requests::GlobalpayCancelRequest { @@ -278,73 +359,18 @@ impl From<Option<common_enums::CaptureMethod>> for requests::CaptureMode { } } -fn get_payment_response( - status: common_enums::AttemptStatus, - response: GlobalpayPaymentsResponse, - redirection_data: Option<RedirectForm>, - status_code: u16, -) -> Result<PaymentsResponseData, Box<ErrorResponse>> { - let mandate_reference = response.payment_method.as_ref().and_then(\|pm\| { - pm.card - .as_ref() - .and_then(\|card\| card.brand_reference.to_owned()) - .map(\|id\| MandateReference { - connector_mandate_id: Some(id.expose()), - payment_method_id: None, - mandate_metadata: None, - connector_mandate_request_reference_id: None, - }) - }); - match status { - common_enums::AttemptStatus::Failure => Err(Box::new(ErrorResponse { - message: response - .payment_method - .as_ref() - .and_then(\|payment_method\| payment_method.message.clone()) - .unwrap_or_else(\|\| NO_ERROR_MESSAGE.to_string()), - code: response - .payment_method - .as_ref() - .and_then(\|payment_method\| payment_method.result.clone()) - .unwrap_or_else(\|\| consts::NO_ERROR_CODE.to_string()), - reason: response - .payment_method - .as_ref() - .and_then(\|payment_method\| payment_method.message.clone()), - status_code, - attempt_status: Some(status), - connector_transaction_id: Some(response.id), - network_decline_code: response - .payment_method - .as_ref() - .and_then(\|payment_method\| payment_method.result.clone()), - network_advice_code: None, - network_error_message: response - .payment_method - .as_ref() - .and_then(\|payment_method\| payment_method.message.clone()), - })), - _ => Ok(PaymentsResponseData::TransactionResponse { - resource_id: ResponseId::ConnectorTransactionId(response.id.clone()), - redirection_data: Box::new(redirection_data), - mandate_reference: Box::new(mandate_reference), - connector_metadata: None, - network_txn_id: None, - connector_response_reference_id: response.reference, - incremental_authorization_allowed: None, - charges: None, - }), - } -} +// } impl<F, T> TryFrom<ResponseRouterData<F, GlobalpayPaymentsResponse, T, PaymentsResponseData>> for RouterData<F, T, PaymentsResponseData> { type Error = Error; + fn try_from( item: ResponseRouterData<F, GlobalpayPaymentsResponse, T, PaymentsResponseData>, ) -> Result<Self, Self::Error> { let status = common_enums::AttemptStatus::from(item.response.status); + let redirect_url = item .response .payment_method @@ -360,12 +386,92 @@ impl<F, T> TryFrom<ResponseRouterData<F, GlobalpayPaymentsResponse, T, PaymentsR Url::parse(url).change_context(errors::ConnectorError::FailedToObtainIntegrationUrl) }) .transpose()?; + let redirection_data = redirect_url.map(\|url\| RedirectForm::from((url, Method::Get))); + let payment_method_token = item.data.get_payment_method_token(); let status_code = item.http_code; + + let mandate_reference = payment_method_token.ok().and_then(\|token\| match token { + PaymentMethodToken::Token(token_string) => Some(MandateReference { + connector_mandate_id: Some(token_string.clone().expose()), + payment_method_id: None, + mandate_metadata: None, + connector_mandate_request_reference_id: None, + }), + _ => None, + }); + + let response = match status { + common_enums::AttemptStatus::Failure => Err(Box::new(ErrorResponse { + message: item + .response + .payment_method + .as_ref() + .and_then(\|payment_method\| payment_method.message.clone()) + .unwrap_or_else(\|\| NO_ERROR_MESSAGE.to_string()), + code: item + .response + .payment_method + .as_ref() + .and_then(\|payment_method\| payment_method.result.clone()) + .unwrap_or_else(\|\| consts::NO_ERROR_CODE.to_string()), + reason: item + .response + .payment_method + .as_ref() + .and_then(\|payment_method\| payment_method.message.clone()), + status_code, + attempt_status: Some(status), + connector_transaction_id: Some(item.response.id.clone()), + network_decline_code: item + .response + .payment_method + .as_ref() + .and_then(\|payment_method\| payment_method.result.clone()), + network_advice_code: None, + network_error_message: item + .response + .payment_method + .as_ref() + .and_then(\|payment_method\| payment_method.message.clone()), + })), + _ => Ok(PaymentsResponseData::TransactionResponse { + resource_id: ResponseId::ConnectorTransactionId(item.response.id.clone()), + redirection_data: Box::new(redirection_data), + mandate_reference: Box::new(mandate_reference), + connector_metadata: None, + network_txn_id: None, + connector_response_reference_id: item.response.reference.clone(), + incremental_authorization_allowed: None, + charges: None, + }), + }; + Ok(Self { status, - response: get_payment_response(status, item.response, redirection_data, status_code) - .map_err(\|err\| err), + response: response.map_err(\|err\| err), + ..item.data + }) + } +} + +impl<F, T> TryFrom<ResponseRouterData<F, GlobalpayPaymentMethodsResponse, T, PaymentsResponseData>> + for RouterData<F, T, PaymentsResponseData> +{ + type Error = Error; + fn try_from( + item: ResponseRouterData<F, GlobalpayPaymentMethodsResponse, T, PaymentsResponseData>, + ) -> Result<Self, Self::Error> { + let token = item + .response + .payment_method_token_id + .clone() + .unwrap_or_default(); + + Ok(Self { + response: Ok(PaymentsResponseData::TokenizationResponse { + token: token.expose(), + }), ..item.data }) } @@ -467,39 +573,6 @@ pub struct GlobalpayErrorResponse { pub detailed_error_description: String, } -fn get_payment_method_data( - item: &PaymentsAuthorizeRouterData, - brand_reference: Option<String>, -) -> Result<PaymentMethodData, Error> { - match &item.request.payment_method_data { - payment_method_data::PaymentMethodData::Card(ccard) => { - Ok(PaymentMethodData::Card(requests::Card { - number: ccard.card_number.clone(), - expiry_month: ccard.card_exp_month.clone(), - expiry_year: ccard.get_card_expiry_year_2_digit()?, - cvv: ccard.card_cvc.clone(), - account_type: None, - authcode: None, - avs_address: None, - avs_postal_code: None, - brand_reference, - chip_condition: None, - funding: None, - pin_block: None, - tag: None, - track: None, - })) - } - payment_method_data::PaymentMethodData::Wallet(wallet_data) => get_wallet_data(wallet_data), - payment_method_data::PaymentMethodData::BankRedirect(bank_redirect) => { - PaymentMethodData::try_from(bank_redirect) - } - _ => Err(errors::ConnectorError::NotImplemented( - "Payment methods".to_string(), - ))?, - } -} - fn get_return_url(item: &PaymentsAuthorizeRouterData) -> Option<String> { match item.request.payment_method_data.clone() { payment_method_data::PaymentMethodData::Wallet( @@ -516,36 +589,6 @@ fn get_return_url(item: &PaymentsAuthorizeRouterData) -> Option<String> { } } -type MandateDetails = (Option<Initiator>, Option<StoredCredential>, Option<String>); -fn get_mandate_details(item: &PaymentsAuthorizeRouterData) -> Result<MandateDetails, Error> { - Ok(if item.request.is_mandate_payment() { - let connector_mandate_id = item.request.mandate_id.as_ref().and_then(\|mandate_ids\| { - match mandate_ids.mandate_reference_id.clone() { - Some(api_models::payments::MandateReferenceId::ConnectorMandateId( - connector_mandate_ids, - )) => connector_mandate_ids.get_connector_mandate_id(), - _ => None, - } - }); - ( - Some(match item.request.off_session { - Some(true) => Initiator::Merchant, - _ => Initiator::Payer, - }), - Some(StoredCredential { - model: Some(requests::Model::Recurring), - sequence: Some(match connector_mandate_id.is_some() { - true => Sequence::Subsequent, - false => Sequence::First, - }), - }), - connector_mandate_id, - ) - } else { - (None, None, None) - }) -} - fn get_wallet_data( wallet_data: &payment_method_data::WalletData, ) -> Result<PaymentMethodData, Error> { diff --git a/crates/hyperswitch_connectors/src/utils.rs b/crates/hyperswitch_connectors/src/utils.rs index 143e7474dd3..09a56474c27 100644 --- a/crates/hyperswitch_connectors/src/utils.rs +++ b/crates/hyperswitch_connectors/src/utils.rs @@ -2190,6 +2190,7 @@ impl PaymentsSetupMandateRequestData for SetupMandateRequestData { pub trait PaymentMethodTokenizationRequestData { fn get_browser_info(&self) -> Result<BrowserInformation, Error>; + fn is_mandate_payment(&self) -> bool; } impl PaymentMethodTokenizationRequestData for PaymentMethodTokenizationData { @@ -2198,6 +2199,15 @@ impl PaymentMethodTokenizationRequestData for PaymentMethodTokenizationData { .clone() .ok_or_else(missing_field_err("browser_info")) } + fn is_mandate_payment(&self) -> bool { + ((self.customer_acceptance.is_some() \|\| self.setup_mandate_details.is_some()) + && (self.setup_future_usage == Some(FutureUsage::OffSession))) + \|\| self + .mandate_id + .as_ref() + .and_then(\|mandate_ids\| mandate_ids.mandate_reference_id.as_ref()) + .is_some() + } } pub trait PaymentsCompleteAuthorizeRequestData { diff --git a/crates/hyperswitch_domain_models/src/router_request_types.rs b/crates/hyperswitch_domain_models/src/router_request_types.rs index b9e2e4a74a6..e919538ea5e 100644 --- a/crates/hyperswitch_domain_models/src/router_request_types.rs +++ b/crates/hyperswitch_domain_models/src/router_request_types.rs @@ -254,6 +254,10 @@ pub struct PaymentMethodTokenizationData { pub currency: storage_enums::Currency, pub amount: Option<i64>, pub split_payments: Option<common_types::payments::SplitPaymentsRequest>, + pub customer_acceptance: Option<common_payments_types::CustomerAcceptance>, + pub setup_future_usage: Option<storage_enums::FutureUsage>, + pub setup_mandate_details: Option<mandates::MandateData>, + pub mandate_id: Option<api_models::payments::MandateIds>, } impl TryFrom<SetupMandateRequestData> for PaymentMethodTokenizationData { @@ -266,6 +270,10 @@ impl TryFrom<SetupMandateRequestData> for PaymentMethodTokenizationData { currency: data.currency, amount: data.amount, split_payments: None, + customer_acceptance: data.customer_acceptance, + setup_future_usage: data.setup_future_usage, + setup_mandate_details: data.setup_mandate_details, + mandate_id: data.mandate_id, }) } } @@ -281,6 +289,10 @@ impl<F> From<&RouterData<F, PaymentsAuthorizeData, response_types::PaymentsRespo currency: data.request.currency, amount: Some(data.request.amount), split_payments: data.request.split_payments.clone(), + customer_acceptance: data.request.customer_acceptance.clone(), + setup_future_usage: data.request.setup_future_usage, + setup_mandate_details: data.request.setup_mandate_details.clone(), + mandate_id: data.request.mandate_id.clone(), } } } @@ -295,6 +307,10 @@ impl TryFrom<PaymentsAuthorizeData> for PaymentMethodTokenizationData { currency: data.currency, amount: Some(data.amount), split_payments: data.split_payments.clone(), + customer_acceptance: data.customer_acceptance, + setup_future_usage: data.setup_future_usage, + setup_mandate_details: data.setup_mandate_details, + mandate_id: data.mandate_id, }) } } @@ -314,6 +330,10 @@ impl TryFrom<CompleteAuthorizeData> for PaymentMethodTokenizationData { currency: data.currency, amount: Some(data.amount), split_payments: None, + customer_acceptance: data.customer_acceptance, + setup_future_usage: data.setup_future_usage, + setup_mandate_details: data.setup_mandate_details, + mandate_id: data.mandate_id, }) } } diff --git a/crates/router/src/configs/settings.rs b/crates/router/src/configs/settings.rs index ae4c8a3cda0..f381712ddfc 100644 --- a/crates/router/src/configs/settings.rs +++ b/crates/router/src/configs/settings.rs @@ -620,6 +620,13 @@ pub struct PaymentMethodTokenFilter { pub payment_method_type: Option<PaymentMethodTypeTokenFilter>, pub long_lived_token: bool, pub apple_pay_pre_decrypt_flow: Option<ApplePayPreDecryptFlow>, + pub flow: Option<PaymentFlow>, +} + +#[derive(Debug, Deserialize, Clone, PartialEq)] +#[serde(deny_unknown_fields, rename_all = "snake_case")] +pub enum PaymentFlow { + Mandates, } #[derive(Debug, Deserialize, Clone, Default)] diff --git a/crates/router/src/core/payment_methods.rs b/crates/router/src/core/payment_methods.rs index 4a23f04cda6..b9d17129249 100644 --- a/crates/router/src/core/payment_methods.rs +++ b/crates/router/src/core/payment_methods.rs @@ -3249,6 +3249,10 @@ async fn create_single_use_tokenization_flow( currency: api_models::enums::Currency::default(), amount: None, split_payments: None, + mandate_id: None, + setup_future_usage: None, + customer_acceptance: None, + setup_mandate_details: None, }; let payment_method_session_address = types::PaymentAddress::new( @@ -3317,12 +3321,12 @@ async fn create_single_use_tokenization_flow( is_payment_id_from_merchant: None, }; - let payment_method_token_response = tokenization::add_token_for_payment_method( + let payment_method_token_response = Box::pin(tokenization::add_token_for_payment_method( &mut router_data, payment_method_data_request.clone(), state.clone(), &merchant_connector_account_details.clone(), - ) + )) .await?; let token_response = payment_method_token_response.token.map_err(\|err\| { diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs index cc6f3384a22..b5c04cfc927 100644 --- a/crates/router/src/core/payments.rs +++ b/crates/router/src/core/payments.rs @@ -106,7 +106,7 @@ use crate::core::routing::helpers as routing_helpers; #[cfg(all(feature = "v1", feature = "dynamic_routing"))] use crate::types::api::convert_connector_data_to_routable_connectors; use crate::{ - configs::settings::{ApplePayPreDecryptFlow, PaymentMethodTypeTokenFilter}, + configs::settings::{ApplePayPreDecryptFlow, PaymentFlow, PaymentMethodTypeTokenFilter}, consts, core::{ errors::{self, CustomResult, RouterResponse, RouterResult}, @@ -6153,6 +6153,7 @@ fn is_payment_method_tokenization_enabled_for_connector( payment_method: storage::enums::PaymentMethod, payment_method_type: Option<storage::enums::PaymentMethodType>, payment_method_token: Option<&PaymentMethodToken>, + mandate_flow_enabled: Option<storage_enums::FutureUsage>, ) -> RouterResult<bool> { let connector_tokenization_filter = state.conf.tokenization.0.get(connector_name); @@ -6171,10 +6172,29 @@ fn is_payment_method_tokenization_enabled_for_connector( payment_method_token, connector_filter.apple_pay_pre_decrypt_flow.clone(), ) + && is_payment_flow_allowed_for_connector( + mandate_flow_enabled, + connector_filter.flow.clone(), + ) }) .unwrap_or(false)) } +fn is_payment_flow_allowed_for_connector( + mandate_flow_enabled: Option<storage_enums::FutureUsage>, + payment_flow: Option<PaymentFlow>, +) -> bool { + if payment_flow.is_none() { + true + } else { + matches!(payment_flow, Some(PaymentFlow::Mandates)) + && matches!( + mandate_flow_enabled, + Some(storage_enums::FutureUsage::OffSession) + ) + } +} + fn is_apple_pay_pre_decrypt_type_connector_tokenization( payment_method_type: Option<storage::enums::PaymentMethodType>, payment_method_token: Option<&PaymentMethodToken>, @@ -6500,6 +6520,10 @@ where .get_required_value("payment_method")?; let payment_method_type = payment_data.get_payment_attempt().payment_method_type; + let mandate_flow_enabled = payment_data + .get_payment_attempt() + .setup_future_usage_applied; + let is_connector_tokenization_enabled = is_payment_method_tokenization_enabled_for_connector( state, @@ -6507,6 +6531,7 @@ where payment_method, payment_method_type, payment_data.get_payment_method_token(), + mandate_flow_enabled, )?; let payment_method_action = decide_payment_method_tokenize_action( @@ -8341,7 +8366,7 @@ where .change_context(errors::ApiErrorResponse::InternalServerError) .attach_printable("Failed to get the common mandate reference")?; - let connector_mandate_details = connector_common_mandate_details.payments; + let connector_mandate_details = connector_common_mandate_details.payments.clone(); let mut connector_choice = None; diff --git a/crates/router/src/core/payments/helpers.rs b/crates/router/src/core/payments/helpers.rs index 4a023f7d8c4..0b1758990ab 100644 --- a/crates/router/src/core/payments/helpers.rs +++ b/crates/router/src/core/payments/helpers.rs @@ -2039,8 +2039,7 @@ pub fn decide_payment_method_retrieval_action( pub async fn is_ucs_enabled(state: &SessionState, config_key: &str) -> bool { let db = state.store.as_ref(); - let is_enabled = db - .find_config_by_key_unwrap_or(config_key, Some("false".to_string())) + db.find_config_by_key_unwrap_or(config_key, Some("false".to_string())) .await .map_err(\|error\| { logger::error!( @@ -2053,9 +2052,7 @@ pub async fn is_ucs_enabled(state: &SessionState, config_key: &str) -> bool { logger::error!(?error, "Failed to parse `{config_key}` UCS enabled config"); }) }) - .unwrap_or(false); - - is_enabled + .unwrap_or(false) } pub async fn should_execute_based_on_rollout( diff --git a/crates/router/tests/connectors/square.rs b/crates/router/tests/connectors/square.rs index 81ea8112276..760e8ebdaea 100644 --- a/crates/router/tests/connectors/square.rs +++ b/crates/router/tests/connectors/square.rs @@ -68,6 +68,10 @@ fn token_details() -> Option<types::PaymentMethodTokenizationData> { amount: None, currency: enums::Currency::USD, split_payments: None, + mandate_id: None, + setup_future_usage: None, + customer_acceptance: None, + setup_mandate_details: None, }) } @@ -442,6 +446,10 @@ async fn should_fail_payment_for_incorrect_cvc() { amount: None, currency: enums::Currency::USD, split_payments: None, + mandate_id: None, + setup_future_usage: None, + customer_acceptance: None, + setup_mandate_details: None, }), get_default_payment_info(None), ) @@ -474,6 +482,10 @@ async fn should_fail_payment_for_invalid_exp_month() { amount: None, currency: enums::Currency::USD, split_payments: None, + mandate_id: None, + setup_future_usage: None, + customer_acceptance: None, + setup_mandate_details: None, }), get_default_payment_info(None), ) @@ -506,6 +518,10 @@ async fn should_fail_payment_for_incorrect_expiry_year() { amount: None, currency: enums::Currency::USD, split_payments: None, + mandate_id: None, + setup_future_usage: None, + customer_acceptance: None, + setup_mandate_details: None, }), get_default_payment_info(None), ) diff --git a/crates/router/tests/connectors/stax.rs b/crates/router/tests/connectors/stax.rs index 93c2394354b..89b1bc7f4b9 100644 --- a/crates/router/tests/connectors/stax.rs +++ b/crates/router/tests/connectors/stax.rs @@ -73,6 +73,10 @@ fn token_details() -> Option<types::PaymentMethodTokenizationData> { amount: None, currency: enums::Currency::USD, split_payments: None, + mandate_id: None, + setup_future_usage: None, + customer_acceptance: None, + setup_mandate_details: None, }) } @@ -484,6 +488,10 @@ async fn should_fail_payment_for_incorrect_cvc() { amount: None, currency: enums::Currency::USD, split_payments: None, + mandate_id: None, + setup_future_usage: None, + customer_acceptance: None, + setup_mandate_details: None, }), get_default_payment_info(connector_customer_id, None), ) @@ -523,6 +531,10 @@ async fn should_fail_payment_for_invalid_exp_month() { amount: None, currency: enums::Currency::USD, split_payments: None, + mandate_id: None, + setup_future_usage: None, + customer_acceptance: None, + setup_mandate_details: None, }), get_default_payment_info(connector_customer_id, None), ) @@ -562,6 +574,10 @@ async fn should_fail_payment_for_incorrect_expiry_year() { amount: None, currency: enums::Currency::USD, split_payments: None, + mandate_id: None, + setup_future_usage: None, + customer_acceptance: None, + setup_mandate_details: None, }), get_default_payment_info(connector_customer_id, None), ) diff --git a/crates/router/tests/connectors/utils.rs b/crates/router/tests/connectors/utils.rs index e3884894b33..a8676834040 100644 --- a/crates/router/tests/connectors/utils.rs +++ b/crates/router/tests/connectors/utils.rs @@ -1121,6 +1121,10 @@ impl Default for TokenType { amount: Some(100), currency: enums::Currency::USD, split_payments: None, + mandate_id: None, + setup_future_usage: None, + customer_acceptance: None, + setup_mandate_details: None, }; Self(data) } diff --git a/loadtest/config/development.toml b/loadtest/config/development.toml index b0bc2e9ee1c..0d1e27961d4 100644 --- a/loadtest/config/development.toml +++ b/loadtest/config/development.toml @@ -591,6 +591,7 @@ mollie = { long_lived_token = false, payment_method = "card" } braintree = { long_lived_token = false, payment_method = "card" } gocardless = { long_lived_token = true, payment_method = "bank_debit" } billwerk = { long_lived_token = false, payment_method = "card" } +globalpay = { long_lived_token = false, payment_method = "card", flow = "mandates" } [connector_customer] connector_list = "adyen,facilitapay,gocardless,hyperswitch_vault,stax,stripe"	2025-07-07T11:53:46Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> In One-off payments, we donot need to create the token. Just passing raw cards would be enough. In CITs, we need to create a token and store it in `connector_mandate_id` for future MITs but while executing the CIT, raw cards need to be passed. In MITs, we need to use that previously stored token in CIT and no more need to hit the tokenization endpoint at connector. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [x] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> 1. Payments Create - One-off cURL: ``` curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_v5jp7Ow9W5g6tgWaDHs4UR385iFfpg9dXQGYQkxxRXQdHlcvR70WmjJRPWJt7Xe7' \ --header 'Cookie: PHPSESSID=0b47db9d7de94c37b6b272087a9f2fa7' \ --data-raw '{ "currency":"USD", "amount": 300, "confirm": true, "amount_to_capture": 300, "capture_method": "automatic", "capture_on": "2022-09-10T10:11:12Z", "authentication_type": "no_three_ds", "return_url": "https://www.google.com", "email": "[email protected]", "name": "Joseph Doe", "phone": "999999999", "phone_country_code": "+65", "description": "Its my first payment request", "statement_descriptor_name": "Juspay", "statement_descriptor_suffix": "Router", "payment_method": "card", "payment_method_type": "credit", "payment_method_data": { "card": { "card_number": "4242424242424242", "card_exp_month": "03", "card_exp_year": "2030", "card_holder_name": "joseph Doe", "card_cvc": "737" } }, "billing": { "address": { "line1": "1467", "line2": "CA", "line3": "Harrison Street", "city": "San Fransico", "state": "CA", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" }, "phone": { "number": "8056594427", "country_code": "+91" } }, "browser_info": { "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8", "language": "nl-NL", "color_depth": 24, "screen_height": 723, "screen_width": 1536, "time_zone": 0, "java_enabled": true, "java_script_enabled": true, "ip_address": "109.71.40.0" }, "metadata": { "order_category": "applepay" }, "order_details": [ { "product_name": "Apple iphone 15", "quantity": 1, "amount": 300, "account_name": "transaction_processing" } ] }' ``` Response: ``` { "payment_id": "pay_j2mMaanCWkdCD2ytx5gg", "merchant_id": "merchant_1751871882", "status": "succeeded", "amount": 300, "net_amount": 300, "shipping_cost": null, "amount_capturable": 0, "amount_received": 300, "connector": "globalpay", "client_secret": "pay_j2mMaanCWkdCD2ytx5gg_secret_CqzsQEqF82ClZdEAoVF3", "created": "2025-07-07T11:03:44.204Z", "currency": "USD", "customer_id": null, "customer": { "id": null, "name": "Joseph Doe", "email": "[email protected]", "phone": "999999999", "phone_country_code": "+65" }, "description": "Its my first payment request", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "card", "payment_method_data": { "card": { "last4": "4242", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "424242", "card_extended_bin": null, "card_exp_month": "03", "card_exp_year": "2030", "card_holder_name": "joseph Doe", "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "CA", "line3": "Harrison Street", "zip": "94122", "state": "CA", "first_name": "joseph", "last_name": "Doe" }, "phone": { "number": "8056594427", "country_code": "+91" }, "email": null }, "order_details": [ { "brand": null, "amount": 300, "category": null, "quantity": 1, "tax_rate": null, "product_id": null, "product_name": "Apple iphone 15", "product_type": null, "sub_category": null, "product_img_link": null, "product_tax_code": null, "total_tax_amount": null, "requires_shipping": null } ], "email": null, "name": null, "phone": null, "return_url": "https://www.google.com/", "authentication_type": "no_three_ds", "statement_descriptor_name": "Juspay", "statement_descriptor_suffix": "Router", "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "credit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": false, "connector_transaction_id": "TRN_IORyBbPseO4Qiy0L2v8YpZpgWA9auN_dCD2ytx5gg_1", "frm_message": null, "metadata": { "order_category": "applepay" }, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_j2mMaanCWkdCD2ytx5gg_1", "payment_link": null, "profile_id": "pro_GIxd8tTl8PWNt9L2ynbr", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_ghTQYltef3iCpp4cdsVu", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-07-07T11:18:44.204Z", "fingerprint": null, "browser_info": { "language": "nl-NL", "time_zone": 0, "ip_address": "109.71.40.0", "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "color_depth": 24, "java_enabled": true, "screen_width": 1536, "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8", "screen_height": 723, "java_script_enabled": true }, "payment_method_id": null, "payment_method_status": null, "updated": "2025-07-07T11:03:46.731Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` 2. CIT using `mandate_id` Request: ``` curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_otcCi6DyRzeDWx38OH5BTLBjBK1WS7Jt1BbsMpPepSR2Rr5dIPgVgPMoeekaqoXL' \ --header 'Cookie: PHPSESSID=0b47db9d7de94c37b6b272087a9f2fa7' \ --data-raw '{ "amount": 6000, "all_keys_required": true, "currency": "USD", "confirm": true, "capture_method": "automatic", "capture_on": "2022-09-10T10:11:12Z", "customer_id": "cus_LI9DQMmb1tHRjnfnkjwknjfXtonFkU", "email": "[email protected]", "name": "John Doe", "phone": "999999999", "phone_country_code": "+65", "description": "Its my first payment request", "authentication_type": "no_three_ds", "return_url": "https://example.com", "payment_method": "card", "payment_method_type": "debit", "payment_method_data": { "card": { "card_number": "4111111111111111", "card_exp_month": "12", "card_exp_year": "2030", "card_holder_name": "joseph Doe", "card_cvc": "123" } }, "setup_future_usage": "off_session", "customer_acceptance": { "acceptance_type": "offline", "accepted_at": "1963-05-03T04:07:52.723Z", "online": { "ip_address": "in sit", "user_agent": "amet irure esse" } }, "mandate_data": { "customer_acceptance": { "acceptance_type": "offline", "accepted_at": "1963-05-03T04:07:52.723Z", "online": { "ip_address": "127.0.0.1", "user_agent": "amet irure esse" } }, "mandate_type": { "single_use": { "amount": 8000, "currency": "USD" } } }, "payment_type": "new_mandate", "billing": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "john", "last_name": "Doe" } }, "shipping": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "john", "last_name": "Doe" } }, "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "metadata": { "udf1": "value1", "new_customer": "true", "login_date": "2019-09-10T10:11:12Z" }, "browser_info": { "ip_address": "129.0.0.1", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36", "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8", "language": "en-US", "color_depth": 32, "screen_height": 1117, "screen_width": 1728, "time_zone": -330, "java_enabled": true, "java_script_enabled": true } }' ``` Response: ``` { "payment_id": "pay_pgbcY6mXYI4IYk2Zt5kc", "merchant_id": "merchant_1753277415", "status": "succeeded", "amount": 6000, "net_amount": 6000, "shipping_cost": null, "amount_capturable": 0, "amount_received": 6000, "connector": "globalpay", "client_secret": "pay_pgbcY6mXYI4IYk2Zt5kc_secret_H0sK1auIjNZsIcfjVE1d", "created": "2025-07-23T17:30:07.918Z", "currency": "USD", "customer_id": "cus_LI9DQMmb1tHRjnfnkjwknjfXtonFkU", "customer": { "id": "cus_LI9DQMmb1tHRjnfnkjwknjfXtonFkU", "name": "John Doe", "email": "[email protected]", "phone": "999999999", "phone_country_code": "+65" }, "description": "Its my first payment request", "refunds": null, "disputes": null, "mandate_id": "man_bRinPSQhGM8Pky90uBNb", "mandate_data": { "update_mandate_id": null, "customer_acceptance": { "acceptance_type": "offline", "accepted_at": "1963-05-03T04:07:52.723Z", "online": { "ip_address": "127.0.0.1", "user_agent": "amet irure esse" } }, "mandate_type": { "single_use": { "amount": 8000, "currency": "USD", "start_date": null, "end_date": null, "metadata": null } } }, "setup_future_usage": "off_session", "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "card", "payment_method_data": { "card": { "last4": "1111", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "411111", "card_extended_bin": null, "card_exp_month": "12", "card_exp_year": "2030", "card_holder_name": "joseph Doe", "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "john", "last_name": "Doe" }, "phone": null, "email": null }, "billing": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "john", "last_name": "Doe" }, "phone": null, "email": null }, "order_details": null, "email": "[email protected]", "name": "John Doe", "phone": "999999999", "return_url": "https://example.com/", "authentication_type": "no_three_ds", "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "debit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": { "customer_id": "cus_LI9DQMmb1tHRjnfnkjwknjfXtonFkU", "created_at": 1753291807, "expires": 1753295407, "secret": "epk_222a00737e6c47d181b899d8afc76813" }, "manual_retry_allowed": false, "connector_transaction_id": "TRN_gBpefdKHlBxfmgVgFSlfPuCQXj86TT_4IYk2Zt5kc_1", "frm_message": null, "metadata": { "udf1": "value1", "login_date": "2019-09-10T10:11:12Z", "new_customer": "true" }, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_pgbcY6mXYI4IYk2Zt5kc_1", "payment_link": null, "profile_id": "pro_roCz974ra9LQxsifUris", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_5Y545k7TI4upQYSbJJ9L", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-07-23T17:45:07.918Z", "fingerprint": null, "browser_info": { "language": "en-US", "time_zone": -330, "ip_address": "129.0.0.1", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36", "color_depth": 32, "java_enabled": true, "screen_width": 1728, "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8", "screen_height": 1117, "java_script_enabled": true }, "payment_method_id": "pm_uDtgQsunDERQMrEXxbcy", "payment_method_status": null, "updated": "2025-07-23T17:30:11.412Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": "{\"id\":\"TRN_gBpefdKHlBxfmgVgFSlfPuCQXj86TT_4IYk2Zt5kc_1\",\"time_created\":\"2025-07-23T17:30:11.323Z\",\"type\":\"SALE\",\"status\":\"CAPTURED\",\"channel\":\"CNP\",\"capture_mode\":\"AUTO\",\"amount\":\"6000\",\"currency\":\"USD\",\"country\":\"US\",\"merchant_id\":\"MER_7e3e2c7df34f42819b3edee31022ee3f\",\"merchant_name\":\"Sandbox_merchant_3\",\"account_id\":\"TRA_c9967ad7d8ec4b46b6dd44a61cde9a91\",\"account_name\":\"transaction_processing\",\"reference\":\"pay_pgbcY6mXYI4IYk2Zt5kc_1\",\"payment_method\":{\"result\":\"00\",\"message\":\"(00)[ test system ] Authorised\",\"entry_mode\":\"ECOM\",\"card\":{\"brand\":\"VISA\",\"masked_number_last4\":\"XXXXXXXXXXXX1111\",\"authcode\":\"123456\",\"brand_reference\":\"R0LEZpZE51h4fEcD\",\"brand_time_created\":\"\",\"cvv_result\":\"MATCHED\",\"provider\":{\"result\":\"00\",\"cvv_result\":\"M\",\"avs_address_result\":\"M\",\"avs_postal_code_result\":\"M\"}}},\"risk_assessment\":[{\"mode\":\"ACTIVE\",\"result\":\"ACCEPTED\",\"rules\":[{\"reference\":\"0c93a6c9-7649-4822-b5ea-1efa356337fd\",\"description\":\"Cardholder Name Rule\",\"mode\":\"ACTIVE\",\"result\":\"ACCEPTED\"},{\"reference\":\"a539d51a-abc1-4fff-a38e-b34e00ad0cc3\",\"description\":\"CardNumber block\",\"mode\":\"ACTIVE\",\"result\":\"ACCEPTED\"},{\"reference\":\"d023a19e-6985-4fda-bb9b-5d4e0dedbb1e\",\"description\":\"Amount test\",\"mode\":\"ACTIVE\",\"result\":\"ACCEPTED\"}]}],\"batch_id\":\"BAT_1558804\",\"action\":{\"id\":\"ACT_gBpefdKHlBxfmgVgFSlfPuCQXj86TT\",\"type\":\"AUTHORIZE\",\"time_created\":\"2025-07-23T17:30:11.323Z\",\"result_code\":\"SUCCESS\",\"app_id\":\"OXKlGGm6ecZLIqMyRgPHRfMxdUAiEcp8\",\"app_name\":\"rotate_again\"}}" } ``` 3. MIT using `mandate_id` Request: ``` curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_otcCi6DyRzeDWx38OH5BTLBjBK1WS7Jt1BbsMpPepSR2Rr5dIPgVgPMoeekaqoXL' \ --header 'Cookie: PHPSESSID=0b47db9d7de94c37b6b272087a9f2fa7' \ --data '{ "amount": 6000, "currency": "USD", "capture_method": "automatic", "off_session": true, "confirm": true, "description": "Initiated by merchant", "mandate_id": "man_bRinPSQhGM8Pky90uBNb", "customer_id": "cus_LI9DQMmb1tHRjnfnkjwknjfXtonFkU" }' ``` Response: ``` { "payment_id": "pay_RI5mPEtiRZOUPPBEckqZ", "merchant_id": "merchant_1753277415", "status": "succeeded", "amount": 6000, "net_amount": 6000, "shipping_cost": null, "amount_capturable": 0, "amount_received": 6000, "connector": "globalpay", "client_secret": "pay_RI5mPEtiRZOUPPBEckqZ_secret_Aj61vZbZEdJkamRrE2EK", "created": "2025-07-23T17:30:20.230Z", "currency": "USD", "customer_id": "cus_LI9DQMmb1tHRjnfnkjwknjfXtonFkU", "customer": { "id": "cus_LI9DQMmb1tHRjnfnkjwknjfXtonFkU", "name": "John Doe", "email": "[email protected]", "phone": "999999999", "phone_country_code": "+65" }, "description": "Initiated by merchant", "refunds": null, "disputes": null, "mandate_id": "man_bRinPSQhGM8Pky90uBNb", "mandate_data": null, "setup_future_usage": null, "off_session": true, "capture_on": null, "capture_method": "automatic", "payment_method": "card", "payment_method_data": { "card": { "last4": "1111", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "411111", "card_extended_bin": null, "card_exp_month": "12", "card_exp_year": "2030", "card_holder_name": "joseph Doe", "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": "23420a93-c0ad-435f-885f-2d57c30c14d9", "shipping": null, "billing": null, "order_details": null, "email": "[email protected]", "name": "John Doe", "phone": "999999999", "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "debit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": { "customer_id": "cus_LI9DQMmb1tHRjnfnkjwknjfXtonFkU", "created_at": 1753291820, "expires": 1753295420, "secret": "epk_ceed93e4ac414b0ea6c2f454b9187067" }, "manual_retry_allowed": false, "connector_transaction_id": "TRN_VlfWAjrCer1pEZaQ7BRJsxE9tqGHnn_OUPPBEckqZ_1", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_RI5mPEtiRZOUPPBEckqZ_1", "payment_link": null, "profile_id": "pro_roCz974ra9LQxsifUris", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_5Y545k7TI4upQYSbJJ9L", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-07-23T17:45:20.230Z", "fingerprint": null, "browser_info": null, "payment_method_id": "pm_uDtgQsunDERQMrEXxbcy", "payment_method_status": "active", "updated": "2025-07-23T17:30:23.884Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": "PMT_9fd7c105-65f1-4b54-9b3f-d3f34c35100d", "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` 4. CIT using `payment_method_id` cURL: ``` curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_otcCi6DyRzeDWx38OH5BTLBjBK1WS7Jt1BbsMpPepSR2Rr5dIPgVgPMoeekaqoXL' \ --header 'Cookie: PHPSESSID=0b47db9d7de94c37b6b272087a9f2fa7' \ --data-raw '{ "amount": 1650, "currency": "USD", "connector": ["globalpay"], "confirm": true, "customer_id": "customer123ffffa", "setup_future_usage": "off_session", "payment_method_type": "debit", "payment_method": "card", "payment_method_data": { "card": { "card_number": "4111111111111111", "card_exp_month": "03", "card_exp_year": "30", "card_holder_name": "joseph Doe", "card_cvc": "737" } }, "billing": { "address": { "first_name": "joseph", "last_name": "Doe", "country": "US" } }, "email": "[email protected]", "customer_acceptance": { "acceptance_type": "offline" } }' ``` Response: ``` { "payment_id": "pay_CNM35m7O7JfdmH9qYyFq", "merchant_id": "merchant_1753277415", "status": "succeeded", "amount": 1650, "net_amount": 1650, "shipping_cost": null, "amount_capturable": 0, "amount_received": 1650, "connector": "globalpay", "client_secret": "pay_CNM35m7O7JfdmH9qYyFq_secret_uz67njQIBT8dhkSR2jcr", "created": "2025-07-23T17:29:50.150Z", "currency": "USD", "customer_id": "customer123ffffa", "customer": { "id": "customer123ffffa", "name": null, "email": "[email protected]", "phone": null, "phone_country_code": null }, "description": null, "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": "off_session", "off_session": null, "capture_on": null, "capture_method": null, "payment_method": "card", "payment_method_data": { "card": { "last4": "1111", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "411111", "card_extended_bin": null, "card_exp_month": "03", "card_exp_year": "30", "card_holder_name": "joseph Doe", "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": null, "country": "US", "line1": null, "line2": null, "line3": null, "zip": null, "state": null, "first_name": "joseph", "last_name": "Doe" }, "phone": null, "email": null }, "order_details": null, "email": "[email protected]", "name": null, "phone": null, "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "debit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": { "customer_id": "customer123ffffa", "created_at": 1753291790, "expires": 1753295390, "secret": "epk_b79f5365965648aea900af73ee98fc51" }, "manual_retry_allowed": false, "connector_transaction_id": "TRN_hR9reO0fbf15HP7SDBznXeKNnhvb6u_fdmH9qYyFq_1", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_CNM35m7O7JfdmH9qYyFq_1", "payment_link": null, "profile_id": "pro_roCz974ra9LQxsifUris", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_5Y545k7TI4upQYSbJJ9L", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-07-23T17:44:50.150Z", "fingerprint": null, "browser_info": null, "payment_method_id": "pm_P66KYq7rG0B7f7RENNf2", "payment_method_status": "active", "updated": "2025-07-23T17:29:53.258Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": "PMT_d6001c7b-6150-404d-92f3-56b217fb8a3d", "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` 5. MIT using `payment_method_id` cURL: ``` curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_otcCi6DyRzeDWx38OH5BTLBjBK1WS7Jt1BbsMpPepSR2Rr5dIPgVgPMoeekaqoXL' \ --header 'Cookie: PHPSESSID=0b47db9d7de94c37b6b272087a9f2fa7' \ --data '{ "amount": 179, "currency": "USD", "confirm": true, "customer_id": "customer123ffffa", "recurring_details": { "type": "payment_method_id", "data": "pm_P66KYq7rG0B7f7RENNf2" }, "off_session": true }' ``` Response: ``` { "payment_id": "pay_6pONwGPfaI6X8zmyOPcS", "merchant_id": "merchant_1753277415", "status": "succeeded", "amount": 179, "net_amount": 179, "shipping_cost": null, "amount_capturable": 0, "amount_received": 179, "connector": "globalpay", "client_secret": "pay_6pONwGPfaI6X8zmyOPcS_secret_XRjvCntYf6esUICifOQg", "created": "2025-07-23T17:30:01.371Z", "currency": "USD", "customer_id": "customer123ffffa", "customer": { "id": "customer123ffffa", "name": null, "email": "[email protected]", "phone": null, "phone_country_code": null }, "description": null, "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": true, "capture_on": null, "capture_method": null, "payment_method": "card", "payment_method_data": { "card": { "last4": "1111", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "411111", "card_extended_bin": null, "card_exp_month": "03", "card_exp_year": "30", "card_holder_name": "joseph Doe", "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": null, "billing": null, "order_details": null, "email": "[email protected]", "name": null, "phone": null, "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "debit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": { "customer_id": "customer123ffffa", "created_at": 1753291801, "expires": 1753295401, "secret": "epk_66d9de3b79db4ee3b35e9dd6db9c18e4" }, "manual_retry_allowed": false, "connector_transaction_id": "TRN_xgxrFV1PkebYZKabeA2R4qN63rqTka_6X8zmyOPcS_1", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_6pONwGPfaI6X8zmyOPcS_1", "payment_link": null, "profile_id": "pro_roCz974ra9LQxsifUris", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_5Y545k7TI4upQYSbJJ9L", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-07-23T17:45:01.371Z", "fingerprint": null, "browser_info": null, "payment_method_id": "pm_P66KYq7rG0B7f7RENNf2", "payment_method_status": "active", "updated": "2025-07-23T17:30:05.264Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": "PMT_d6001c7b-6150-404d-92f3-56b217fb8a3d", "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` ## Cypress test <details> <summary> Globalpay </summary> <img width="490" height="1088" alt="Screenshot 2025-07-15 at 7 31 52 PM" src="https://github.com/user-attachments/assets/fc412951-43e1-4be9-bd07-28c7980db3a4" /> </details> ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	260df2836cea8f9aa7448888d3b61e942eda313b	260df2836cea8f9aa7448888d3b61e942eda313b
juspay/hyperswitch	juspay__hyperswitch-8467	Bug: [FEATURE] multisafepay : addpayment methods \| TRUSTLY \| WeChatpay \| Alipay ### Feature Description Integrate 1. Turstly 2. WeChatPay 3. Alipay ### Possible Implementation Integrate the redirection flows for the wallet ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? Yes, I am willing to submit a PR!	diff --git a/config/deployments/integration_test.toml b/config/deployments/integration_test.toml index 513cb587176..e04583cbfb5 100644 --- a/config/deployments/integration_test.toml +++ b/config/deployments/integration_test.toml @@ -541,6 +541,9 @@ paypal = { country = "AF,AX,AL,DZ,AS,AD,AO,AI,AQ,AG,AR,AM,AW,AU,AT,AZ,BS,BH,BD,B giropay = { country = "DE", currency = "EUR" } ideal = { country = "NL", currency = "EUR" } klarna = { country = "AT,BE,DK,FI,FR,DE,IT,NL,NO,PT,ES,SE,GB", currency = "DKK,EUR,GBP,NOK,SEK" } +trustly = { country = "AT,CZ,DK,EE,FI,DE,LV,LT,NL,NO,PL,PT,ES,SE,GB" , currency = "EUR,GBP,SEK"} +ali_pay = {currency = "EUR,USD"} +we_chat_pay = { currency = "EUR"} [pm_filters.cashtocode] classic = { country = "AF,AX,AL,DZ,AS,AD,AO,AI,AQ,AG,AR,AM,AW,AU,AT,AZ,BS,BH,BD,BB,BY,BE,BZ,BJ,BM,BT,BO,BQ,BA,BW,BV,BR,IO,BN,BG,BF,BI,KH,CM,CA,CV,KY,CF,TD,CL,CN,CX,CC,CO,KM,CG,CD,CK,CR,CI,HR,CU,CW,CY,CZ,DK,DJ,DM,DO,EC,EG,SV,GQ,ER,EE,ET,FK,FO,FJ,FI,FR,GF,PF,TF,GA,GM,GE,DE,GH,GI,GR,GL,GD,GP,GU,GT,GG,GN,GW,GY,HT,HM,VA,HN,HK,HU,IS,IN,ID,IR,IQ,IE,IM,IL,IT,JM,JP,JE,JO,KZ,KE,KI,KP,KR,KW,KG,LA,LV,LB,LS,LR,LY,LI,LT,LU,MO,MK,MG,MW,MY,MV,ML,MT,MH,MQ,MR,MU,YT,MX,FM,MD,MC,MN,ME,MS,MA,MZ,MM,NA,NR,NP,NL,NC,NZ,NI,NE,NG,NU,NF,MP,NO,OM,PK,PW,PS,PA,PG,PY,PE,PH,PN,PL,PT,PR,QA,RE,RO,RU,RW,BL,SH,KN,LC,MF,PM,VC,WS,SM,ST,SA,SN,RS,SC,SL,SG,SX,SK,SI,SB,SO,ZA,GS,SS,ES,LK,SD,SR,SJ,SZ,SE,CH,SY,TW,TJ,TZ,TH,TL,TG,TK,TO,TT,TN,TR,TM,TC,TV,UG,UA,AE,GB,UM,UY,UZ,VU,VE,VN,VG,VI,WF,EH,YE,ZM,ZW,US", currency = "AED,AFN,ALL,AMD,ANG,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BHD,BIF,BMD,BND,BOB,BRL,BSD,BTN,BWP,BYN,BZD,CAD,CDF,CHF,CLF,CLP,CNY,COP,CRC,CUC,CUP,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ERN,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,IQD,IRR,ISK,JMD,JOD,JPY,KES,KGS,KHR,KMF,KPW,KRW,KWD,KYD,KZT,LAK,LBP,LKR,LRD,LSL,LYD,MAD,MDL,MGA,MKD,MMK,MNT,MOP,MRU,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SDG,SEK,SGD,SHP,SLE,SLL,SOS,SRD,SSP,STD,STN,SVC,SYP,SZL,THB,TJS,TMT,TND,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VES,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL" } diff --git a/config/deployments/production.toml b/config/deployments/production.toml index 4b990ad0464..eba6e2334b7 100644 --- a/config/deployments/production.toml +++ b/config/deployments/production.toml @@ -524,6 +524,9 @@ paypal = { country = "AF,AX,AL,DZ,AS,AD,AO,AI,AQ,AG,AR,AM,AW,AU,AT,AZ,BS,BH,BD,B giropay = { country = "DE", currency = "EUR" } ideal = { country = "NL", currency = "EUR" } klarna = { country = "AT,BE,DK,FI,FR,DE,IT,NL,NO,PT,ES,SE,GB", currency = "DKK,EUR,GBP,NOK,SEK" } +trustly = { country = "AT,CZ,DK,EE,FI,DE,LV,LT,NL,NO,PL,PT,ES,SE,GB" , currency = "EUR,GBP,SEK"} +ali_pay = {currency = "EUR,USD"} +we_chat_pay = { currency = "EUR"} [pm_filters.cashtocode] classic = { country = "AF,AX,AL,DZ,AS,AD,AO,AI,AQ,AG,AR,AM,AW,AU,AT,AZ,BS,BH,BD,BB,BY,BE,BZ,BJ,BM,BT,BO,BQ,BA,BW,BV,BR,IO,BN,BG,BF,BI,KH,CM,CA,CV,KY,CF,TD,CL,CN,CX,CC,CO,KM,CG,CD,CK,CR,CI,HR,CU,CW,CY,CZ,DK,DJ,DM,DO,EC,EG,SV,GQ,ER,EE,ET,FK,FO,FJ,FI,FR,GF,PF,TF,GA,GM,GE,DE,GH,GI,GR,GL,GD,GP,GU,GT,GG,GN,GW,GY,HT,HM,VA,HN,HK,HU,IS,IN,ID,IR,IQ,IE,IM,IL,IT,JM,JP,JE,JO,KZ,KE,KI,KP,KR,KW,KG,LA,LV,LB,LS,LR,LY,LI,LT,LU,MO,MK,MG,MW,MY,MV,ML,MT,MH,MQ,MR,MU,YT,MX,FM,MD,MC,MN,ME,MS,MA,MZ,MM,NA,NR,NP,NL,NC,NZ,NI,NE,NG,NU,NF,MP,NO,OM,PK,PW,PS,PA,PG,PY,PE,PH,PN,PL,PT,PR,QA,RE,RO,RU,RW,BL,SH,KN,LC,MF,PM,VC,WS,SM,ST,SA,SN,RS,SC,SL,SG,SX,SK,SI,SB,SO,ZA,GS,SS,ES,LK,SD,SR,SJ,SZ,SE,CH,SY,TW,TJ,TZ,TH,TL,TG,TK,TO,TT,TN,TR,TM,TC,TV,UG,UA,AE,GB,UM,UY,UZ,VU,VE,VN,VG,VI,WF,EH,YE,ZM,ZW,US", currency = "AED,AFN,ALL,AMD,ANG,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BHD,BIF,BMD,BND,BOB,BRL,BSD,BTN,BWP,BYN,BZD,CAD,CDF,CHF,CLF,CLP,CNY,COP,CRC,CUC,CUP,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ERN,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,IQD,IRR,ISK,JMD,JOD,JPY,KES,KGS,KHR,KMF,KPW,KRW,KWD,KYD,KZT,LAK,LBP,LKR,LRD,LSL,LYD,MAD,MDL,MGA,MKD,MMK,MNT,MOP,MRU,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SDG,SEK,SGD,SHP,SLE,SLL,SOS,SRD,SSP,STD,STN,SVC,SYP,SZL,THB,TJS,TMT,TND,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VES,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL" } diff --git a/config/deployments/sandbox.toml b/config/deployments/sandbox.toml index d00b12c751f..ac5442fcdd6 100644 --- a/config/deployments/sandbox.toml +++ b/config/deployments/sandbox.toml @@ -532,6 +532,9 @@ google_pay = { country = "AF,AX,AL,DZ,AS,AD,AO,AI,AQ,AG,AR,AM,AW,AU,AT,AZ,BS,BH, paypal = { country = "AF,AX,AL,DZ,AS,AD,AO,AI,AQ,AG,AR,AM,AW,AU,AT,AZ,BS,BH,BD,BB,BY,BE,BZ,BJ,BM,BT,BO,BQ,BA,BW,BV,BR,IO,BN,BG,BF,BI,CV,KH,CM,CA,KY,CF,TD,CL,CN,CX,CC,CO,KM,CG,CD,CK,CR,CI,HR,CU,CW,CY,CZ,DK,DJ,DM,DO,EC,EG,SV,GQ,ER,EE,ET,FK,FO,FJ,FI,FR,GF,PF,TF,GA,GM,GE,DE,GH,GI,GR,GL,GD,GP,GU,GT,GG,GN,GW,GY,HT,HM,VA,HN,HK,HU,IS,IN,ID,IR,IQ,IE,IM,IL,IT,JM,JP,JE,JO,KZ,KE,KI,KP,KR,KW,KG,LA,LV,LB,LS,LR,LY,LI,LT,LU,MO,MK,MG,MW,MY,MV,ML,MT,MH,MQ,MR,MU,YT,MX,FM,MD,MC,MN,ME,MS,MA,MZ,MM,NA,NR,NP,NL,NC,NZ,NI,NE,NG,NU,NF,MP,NO,OM,PK,PW,PS,PA,PG,PY,PE,PH,PN,PL,PT,PR,QA,RE,RO,RU,RW,BL,SH,KN,LC,MF,PM,VC,WS,SM,ST,SA,SN,RS,SC,SL,SG,SX,SK,SI,SB,SO,ZA,GS,SS,ES,LK,SD,SR,SJ,SZ,SE,CH,SY,TW,TJ,TZ,TH,TL,TG,TK,TO,TT,TN,TR,TM,TC,TV,UG,UA,AE,GB,US,UM,UY,UZ,VU,VE,VN,VG,VI,WF,EH,YE,ZM,ZW", currency = "AUD,BRL,CAD,CHF,CZK,DKK,EUR,GBP,HKD,HRK,HUF,JPY,MXN,MYR,NOK,NZD,PHP,PLN,RUB,SEK,SGD,THB,TRY,TWD,USD" } ideal = { country = "NL", currency = "EUR" } klarna = { country = "AT,BE,DK,FI,FR,DE,IT,NL,NO,PT,ES,SE,GB", currency = "DKK,EUR,GBP,NOK,SEK" } +trustly = { country = "AT,CZ,DK,EE,FI,DE,LV,LT,NL,NO,PL,PT,ES,SE,GB" , currency = "EUR,GBP,SEK"} +ali_pay = {currency = "EUR,USD"} +we_chat_pay = { currency = "EUR"} [pm_filters.cashtocode] classic = { country = "AF,AX,AL,DZ,AS,AD,AO,AI,AQ,AG,AR,AM,AW,AU,AT,AZ,BS,BH,BD,BB,BY,BE,BZ,BJ,BM,BT,BO,BQ,BA,BW,BV,BR,IO,BN,BG,BF,BI,KH,CM,CA,CV,KY,CF,TD,CL,CN,CX,CC,CO,KM,CG,CD,CK,CR,CI,HR,CU,CW,CY,CZ,DK,DJ,DM,DO,EC,EG,SV,GQ,ER,EE,ET,FK,FO,FJ,FI,FR,GF,PF,TF,GA,GM,GE,DE,GH,GI,GR,GL,GD,GP,GU,GT,GG,GN,GW,GY,HT,HM,VA,HN,HK,HU,IS,IN,ID,IR,IQ,IE,IM,IL,IT,JM,JP,JE,JO,KZ,KE,KI,KP,KR,KW,KG,LA,LV,LB,LS,LR,LY,LI,LT,LU,MO,MK,MG,MW,MY,MV,ML,MT,MH,MQ,MR,MU,YT,MX,FM,MD,MC,MN,ME,MS,MA,MZ,MM,NA,NR,NP,NL,NC,NZ,NI,NE,NG,NU,NF,MP,NO,OM,PK,PW,PS,PA,PG,PY,PE,PH,PN,PL,PT,PR,QA,RE,RO,RU,RW,BL,SH,KN,LC,MF,PM,VC,WS,SM,ST,SA,SN,RS,SC,SL,SG,SX,SK,SI,SB,SO,ZA,GS,SS,ES,LK,SD,SR,SJ,SZ,SE,CH,SY,TW,TJ,TZ,TH,TL,TG,TK,TO,TT,TN,TR,TM,TC,TV,UG,UA,AE,GB,UM,UY,UZ,VU,VE,VN,VG,VI,WF,EH,YE,ZM,ZW,US", currency = "AED,AFN,ALL,AMD,ANG,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BHD,BIF,BMD,BND,BOB,BRL,BSD,BTN,BWP,BYN,BZD,CAD,CDF,CHF,CLF,CLP,CNY,COP,CRC,CUC,CUP,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ERN,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,IQD,IRR,ISK,JMD,JOD,JPY,KES,KGS,KHR,KMF,KPW,KRW,KWD,KYD,KZT,LAK,LBP,LKR,LRD,LSL,LYD,MAD,MDL,MGA,MKD,MMK,MNT,MOP,MRU,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SDG,SEK,SGD,SHP,SLE,SLL,SOS,SRD,SSP,STD,STN,SVC,SYP,SZL,THB,TJS,TMT,TND,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VES,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL" } diff --git a/config/development.toml b/config/development.toml index 95484d6b014..d85f36cef18 100644 --- a/config/development.toml +++ b/config/development.toml @@ -728,6 +728,9 @@ paypal = { country = "AF,AX,AL,DZ,AS,AD,AO,AI,AQ,AG,AR,AM,AW,AU,AT,AZ,BS,BH,BD,B giropay = { country = "DE", currency = "EUR" } ideal = { country = "NL", currency = "EUR" } klarna = { country = "AT,BE,DK,FI,FR,DE,IT,NL,NO,PT,ES,SE,GB", currency = "DKK,EUR,GBP,NOK,SEK" } +trustly = { country = "AT,CZ,DK,EE,FI,DE,LV,LT,NL,NO,PL,PT,ES,SE,GB" , currency = "EUR,GBP,SEK"} +ali_pay = { currency = "EUR,USD" } +we_chat_pay = { currency = "EUR"} [pm_filters.cashtocode] classic = { country = "AF,AX,AL,DZ,AS,AD,AO,AI,AQ,AG,AR,AM,AW,AU,AT,AZ,BS,BH,BD,BB,BY,BE,BZ,BJ,BM,BT,BO,BQ,BA,BW,BV,BR,IO,BN,BG,BF,BI,KH,CM,CA,CV,KY,CF,TD,CL,CN,CX,CC,CO,KM,CG,CD,CK,CR,CI,HR,CU,CW,CY,CZ,DK,DJ,DM,DO,EC,EG,SV,GQ,ER,EE,ET,FK,FO,FJ,FI,FR,GF,PF,TF,GA,GM,GE,DE,GH,GI,GR,GL,GD,GP,GU,GT,GG,GN,GW,GY,HT,HM,VA,HN,HK,HU,IS,IN,ID,IR,IQ,IE,IM,IL,IT,JM,JP,JE,JO,KZ,KE,KI,KP,KR,KW,KG,LA,LV,LB,LS,LR,LY,LI,LT,LU,MO,MK,MG,MW,MY,MV,ML,MT,MH,MQ,MR,MU,YT,MX,FM,MD,MC,MN,ME,MS,MA,MZ,MM,NA,NR,NP,NL,NC,NZ,NI,NE,NG,NU,NF,MP,NO,OM,PK,PW,PS,PA,PG,PY,PE,PH,PN,PL,PT,PR,QA,RE,RO,RU,RW,BL,SH,KN,LC,MF,PM,VC,WS,SM,ST,SA,SN,RS,SC,SL,SG,SX,SK,SI,SB,SO,ZA,GS,SS,ES,LK,SD,SR,SJ,SZ,SE,CH,SY,TW,TJ,TZ,TH,TL,TG,TK,TO,TT,TN,TR,TM,TC,TV,UG,UA,AE,GB,UM,UY,UZ,VU,VE,VN,VG,VI,WF,EH,YE,ZM,ZW,US", currency = "AED,AFN,ALL,AMD,ANG,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BHD,BIF,BMD,BND,BOB,BRL,BSD,BTN,BWP,BYN,BZD,CAD,CDF,CHF,CLF,CLP,CNY,COP,CRC,CUC,CUP,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ERN,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,IQD,IRR,ISK,JMD,JOD,JPY,KES,KGS,KHR,KMF,KPW,KRW,KWD,KYD,KZT,LAK,LBP,LKR,LRD,LSL,LYD,MAD,MDL,MGA,MKD,MMK,MNT,MOP,MRU,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SDG,SEK,SGD,SHP,SLE,SLL,SOS,SRD,SSP,STD,STN,SVC,SYP,SZL,THB,TJS,TMT,TND,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VES,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL" } diff --git a/crates/hyperswitch_connectors/src/connectors/multisafepay.rs b/crates/hyperswitch_connectors/src/connectors/multisafepay.rs index f2fc62d6cbf..08e76940237 100644 --- a/crates/hyperswitch_connectors/src/connectors/multisafepay.rs +++ b/crates/hyperswitch_connectors/src/connectors/multisafepay.rs @@ -634,6 +634,27 @@ static MULTISAFEPAY_SUPPORTED_PAYMENT_METHODS: LazyLock<SupportedPaymentMethods> }, ); + multisafepay_supported_payment_methods.add( + enums::PaymentMethod::Wallet, + enums::PaymentMethodType::AliPay, + PaymentMethodDetails { + mandates: enums::FeatureStatus::NotSupported, + refunds: enums::FeatureStatus::Supported, + supported_capture_methods: supported_capture_methods.clone(), + specific_features: None, + }, + ); + multisafepay_supported_payment_methods.add( + enums::PaymentMethod::Wallet, + enums::PaymentMethodType::WeChatPay, + PaymentMethodDetails { + mandates: enums::FeatureStatus::NotSupported, + refunds: enums::FeatureStatus::Supported, + supported_capture_methods: supported_capture_methods.clone(), + specific_features: None, + }, + ); + multisafepay_supported_payment_methods.add( enums::PaymentMethod::BankRedirect, enums::PaymentMethodType::Giropay, @@ -644,6 +665,16 @@ static MULTISAFEPAY_SUPPORTED_PAYMENT_METHODS: LazyLock<SupportedPaymentMethods> specific_features: None, }, ); + multisafepay_supported_payment_methods.add( + enums::PaymentMethod::BankRedirect, + enums::PaymentMethodType::Trustly, + PaymentMethodDetails { + mandates: enums::FeatureStatus::NotSupported, + refunds: enums::FeatureStatus::Supported, + supported_capture_methods: supported_capture_methods.clone(), + specific_features: None, + }, + ); multisafepay_supported_payment_methods.add( enums::PaymentMethod::BankRedirect, diff --git a/crates/hyperswitch_connectors/src/connectors/multisafepay/transformers.rs b/crates/hyperswitch_connectors/src/connectors/multisafepay/transformers.rs index c7cc7967c4c..bcdbd7e28e6 100644 --- a/crates/hyperswitch_connectors/src/connectors/multisafepay/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/multisafepay/transformers.rs @@ -66,6 +66,10 @@ pub enum Gateway { Paypal, Ideal, Giropay, + Trustly, + Alipay, + #[serde(rename = "WECHAT")] + WeChatPay, } #[serde_with::skip_serializing_none] @@ -183,14 +187,24 @@ pub enum GatewayInfo { #[serde(untagged)] pub enum WalletInfo { GooglePay(GpayInfo), + Alipay(AlipayInfo), + WeChatPay(WeChatPayInfo), } +#[derive(Debug, Clone, Serialize, Eq, PartialEq)] +pub struct WeChatPayInfo {} + +#[derive(Debug, Clone, Serialize, Eq, PartialEq)] +pub struct AlipayInfo {} + #[derive(Clone, Debug, Eq, PartialEq, Serialize)] #[serde(untagged)] pub enum BankRedirectInfo { Ideal(IdealInfo), + Trustly(TrustlyInfo), } - +#[derive(Debug, Clone, Serialize, Eq, PartialEq)] +pub struct TrustlyInfo {} #[derive(Debug, Clone, Serialize, Eq, PartialEq)] pub struct IdealInfo { pub issuer_id: MultisafepayBankNames, @@ -490,8 +504,9 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> PaymentMethodData::Wallet(ref wallet_data) => match wallet_data { WalletData::GooglePay(_) => Type::Direct, WalletData::PaypalRedirect(_) => Type::Redirect, + WalletData::AliPayRedirect(_) => Type::Redirect, + WalletData::WeChatPayRedirect(_) => Type::Redirect, WalletData::AliPayQr(_) - \| WalletData::AliPayRedirect(_) \| WalletData::AliPayHkRedirect(_) \| WalletData::AmazonPayRedirect(_) \| WalletData::MomoRedirect(_) @@ -512,7 +527,6 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> \| WalletData::TwintRedirect {} \| WalletData::VippsRedirect {} \| WalletData::TouchNGoRedirect(_) - \| WalletData::WeChatPayRedirect(_) \| WalletData::WeChatPayQr(_) \| WalletData::CashappQr(_) \| WalletData::SwishQr(_) @@ -524,6 +538,7 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> PaymentMethodData::BankRedirect(ref bank_data) => match bank_data { BankRedirectData::Giropay { .. } => Type::Redirect, BankRedirectData::Ideal { .. } => Type::Direct, + BankRedirectData::Trustly { .. } => Type::Redirect, BankRedirectData::BancontactCard { .. } \| BankRedirectData::Bizum { .. } \| BankRedirectData::Blik { .. } @@ -537,7 +552,6 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> \| BankRedirectData::OpenBankingUk { .. } \| BankRedirectData::Przelewy24 { .. } \| BankRedirectData::Sofort { .. } - \| BankRedirectData::Trustly { .. } \| BankRedirectData::OnlineBankingFpx { .. } \| BankRedirectData::OnlineBankingThailand { .. } \| BankRedirectData::LocalBankRedirect {} => { @@ -557,8 +571,9 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> PaymentMethodData::Wallet(ref wallet_data) => Some(match wallet_data { WalletData::GooglePay(_) => Gateway::Googlepay, WalletData::PaypalRedirect(_) => Gateway::Paypal, + WalletData::AliPayRedirect(_) => Gateway::Alipay, + WalletData::WeChatPayRedirect(_) => Gateway::WeChatPay, WalletData::AliPayQr(_) - \| WalletData::AliPayRedirect(_) \| WalletData::AliPayHkRedirect(_) \| WalletData::AmazonPayRedirect(_) \| WalletData::MomoRedirect(_) @@ -579,7 +594,6 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> \| WalletData::TwintRedirect {} \| WalletData::VippsRedirect {} \| WalletData::TouchNGoRedirect(_) - \| WalletData::WeChatPayRedirect(_) \| WalletData::WeChatPayQr(_) \| WalletData::CashappQr(_) \| WalletData::SwishQr(_) @@ -591,6 +605,7 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> PaymentMethodData::BankRedirect(ref bank_data) => Some(match bank_data { BankRedirectData::Giropay { .. } => Gateway::Giropay, BankRedirectData::Ideal { .. } => Gateway::Ideal, + BankRedirectData::Trustly { .. } => Gateway::Trustly, BankRedirectData::BancontactCard { .. } \| BankRedirectData::Bizum { .. } \| BankRedirectData::Blik { .. } @@ -604,7 +619,6 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> \| BankRedirectData::OpenBankingUk { .. } \| BankRedirectData::Przelewy24 { .. } \| BankRedirectData::Sofort { .. } - \| BankRedirectData::Trustly { .. } \| BankRedirectData::OnlineBankingFpx { .. } \| BankRedirectData::OnlineBankingThailand { .. } \| BankRedirectData::LocalBankRedirect {} => { @@ -718,9 +732,14 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> } }))) } + WalletData::AliPayRedirect(_) => { + Some(GatewayInfo::Wallet(WalletInfo::Alipay(AlipayInfo {}))) + } WalletData::PaypalRedirect(_) => None, + WalletData::WeChatPayRedirect(_) => { + Some(GatewayInfo::Wallet(WalletInfo::WeChatPay(WeChatPayInfo {}))) + } WalletData::AliPayQr(_) - \| WalletData::AliPayRedirect(_) \| WalletData::AliPayHkRedirect(_) \| WalletData::AmazonPayRedirect(_) \| WalletData::MomoRedirect(_) @@ -741,7 +760,6 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> \| WalletData::TwintRedirect {} \| WalletData::VippsRedirect {} \| WalletData::TouchNGoRedirect(_) - \| WalletData::WeChatPayRedirect(_) \| WalletData::WeChatPayQr(_) \| WalletData::CashappQr(_) \| WalletData::SwishQr(_) @@ -780,6 +798,9 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> )?)?, }), )), + BankRedirectData::Trustly { .. } => Some(GatewayInfo::BankRedirect( + BankRedirectInfo::Trustly(TrustlyInfo {}), + )), BankRedirectData::BancontactCard { .. } \| BankRedirectData::Bizum { .. } \| BankRedirectData::Blik { .. } @@ -794,7 +815,6 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> \| BankRedirectData::OpenBankingUk { .. } \| BankRedirectData::Przelewy24 { .. } \| BankRedirectData::Sofort { .. } - \| BankRedirectData::Trustly { .. } \| BankRedirectData::OnlineBankingFpx { .. } \| BankRedirectData::OnlineBankingThailand { .. } \| BankRedirectData::LocalBankRedirect {} => None,	2025-06-26T04:34:28Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description Add newer payment methods for `multisafepay` connector - Trustly - WeChatPay - Alipay ### MCA <details> <summary>Create Merchant Account</summary> ```json { "connector_type": "payment_processor", "connector_account_details": { "auth_type": "HeaderKey", "api_key": "**************" }, "connector_name": "multisafepay", "test_mode": false, "disabled": false, "payment_methods_enabled": [ { "payment_method": "wallet", "payment_method_types": [ { "payment_method_type": "we_chat_pay", "payment_experience": "redirect_to_url" } ] }, { "payment_method": "wallet", "payment_method_types": [ { "payment_method_type": "ali_pay", "payment_experience": "redirect_to_url" } ] }, { "payment_method": "wallet", "payment_method_types": [ { "payment_method_type": "amazon_pay", "payment_experience": "redirect_to_url" } ] }, { "payment_method": "bank_redirect", "payment_method_types": [ { "payment_method_type": "trustly" } ] }, { "payment_method": "card", "payment_method_types": [ { "payment_method_type": "credit", "card_networks": ["Visa", "Mastercard"], "minimum_amount": 1, "maximum_amount": 68607706, "recurring_enabled": true, "installment_payment_enabled": true }, { "payment_method_type": "debit", "card_networks": ["Visa", "Mastercard"], "minimum_amount": 1, "maximum_amount": 68607706, "recurring_enabled": true, "installment_payment_enabled": true } ] } ], "metadata": { "city": "NY", "unit": "245" }, "business_country": "US", "business_label": "default" } ``` </details> ## Trustly <details> <summary>Create payement</summary> ```json { "amount": 333, "currency": "EUR", "confirm": true, "capture_method": "automatic", "payment_method": "bank_redirect", "payment_method_type": "trustly", "description": "hellow world", "billing": { "address": { "zip": "560095", "first_name": "Sakil", "last_name": "Mostak", "line1": "Fasdf", "country": "AT", "line2": "Fasdf", "city": "Fasdf" } }, "payment_method_data": { "bank_redirect": { "trustly": { "country": "AT" } } } } ``` </details> <details> <summary> Response</summary> ```json { "payment_id": "pay_wRU9qZTZ8Q8VGd8Bry2i", "merchant_id": "merchant_1750676714", "status": "requires_customer_action", "amount": 333, "net_amount": 333, "shipping_cost": null, "amount_capturable": 333, "amount_received": null, "connector": "multisafepay", "client_secret": "pay_wRU9qZTZ8Q8VGd8Bry2i_secret_Cikbt0vSVNo1G9dXT8LR", "created": "2025-06-26T04:55:03.318Z", "currency": "EUR", "customer_id": null, "customer": null, "description": "hellow world", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "bank_redirect", "payment_method_data": { "bank_redirect": { "type": "BankRedirectResponse", "bank_name": null }, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": "Fasdf", "country": "AT", "line1": "Fasdf", "line2": "Fasdf", "line3": null, "zip": "560095", "state": null, "first_name": "Sakil", "last_name": "Mostak" }, "phone": null, "email": null }, "order_details": null, "email": null, "name": null, "phone": null, "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": { "type": "redirect_to_url", "redirect_to_url": "http://localhost:8080/payments/redirect/pay_wRU9qZTZ8Q8VGd8Bry2i/merchant_1750676714/pay_wRU9qZTZ8Q8VGd8Bry2i_1" }, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "trustly", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": null, "connector_transaction_id": "pay_wRU9qZTZ8Q8VGd8Bry2i_1", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_wRU9qZTZ8Q8VGd8Bry2i_1", "payment_link": null, "profile_id": "pro_7Pno0Wbshvrioh4kTJLM", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_aliGZhhX1SDuuEtkipSs", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-06-26T05:10:03.318Z", "fingerprint": null, "browser_info": null, "payment_method_id": null, "payment_method_status": null, "updated": "2025-06-26T04:55:05.045Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": null, "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` </details> <details> <summary>Confirm page</summary> <img width="1322" alt="Screenshot 2025-06-26 at 10 26 20 AM" src="https://github.com/user-attachments/assets/6a428b08-d3fb-4b6d-bf94-d6348025d208" /> </details> <details> <summary>Psync</summary> ```json { "payment_id": "pay_wRU9qZTZ8Q8VGd8Bry2i", "merchant_id": "merchant_1750676714", "status": "succeeded", "amount": 333, "net_amount": 333, "shipping_cost": null, "amount_capturable": 0, "amount_received": 333, "connector": "multisafepay", "client_secret": "pay_wRU9qZTZ8Q8VGd8Bry2i_secret_Cikbt0vSVNo1G9dXT8LR", "created": "2025-06-26T04:55:03.318Z", "currency": "EUR", "customer_id": null, "customer": null, "description": "hellow world", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "bank_redirect", "payment_method_data": { "bank_redirect": { "type": "BankRedirectResponse", "bank_name": null }, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": "Fasdf", "country": "AT", "line1": "Fasdf", "line2": "Fasdf", "line3": null, "zip": "560095", "state": null, "first_name": "Sakil", "last_name": "Mostak" }, "phone": null, "email": null }, "order_details": null, "email": null, "name": null, "phone": null, "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "trustly", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": false, "connector_transaction_id": "pay_wRU9qZTZ8Q8VGd8Bry2i_1", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_wRU9qZTZ8Q8VGd8Bry2i_1", "payment_link": null, "profile_id": "pro_7Pno0Wbshvrioh4kTJLM", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_aliGZhhX1SDuuEtkipSs", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-06-26T05:10:03.318Z", "fingerprint": null, "browser_info": null, "payment_method_id": null, "payment_method_status": null, "updated": "2025-06-26T04:56:22.878Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": null, "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` </details> ## Alipay <details> <summary> Payment create </summary> ```json { "amount": 333, "currency": "EUR", "confirm": true, "capture_method": "automatic", "payment_method": "wallet", "payment_method_type": "ali_pay", "authentication_type": "no_three_ds", "description": "hellow world", "billing": { "address": { "zip": "560095", "first_name": "Sakil", "last_name": "Mostak", "line1": "Fasdf", "country": "AT", "line2": "Fasdf", "city": "Fasdf" } }, "payment_method_data": { "wallet": { "ali_pay_redirect": {} } } } ``` </details> <details> <summary>Payment Response</summary> ```json { "payment_id": "pay_Ovu6Gi04d695EdCCEUlP", "merchant_id": "merchant_1750676714", "status": "requires_customer_action", "amount": 333, "net_amount": 333, "shipping_cost": null, "amount_capturable": 333, "amount_received": null, "connector": "multisafepay", "client_secret": "pay_Ovu6Gi04d695EdCCEUlP_secret_M57QtvAffR5Z5DEAkVko", "created": "2025-06-26T05:00:28.713Z", "currency": "EUR", "customer_id": null, "customer": null, "description": "hellow world", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "wallet", "payment_method_data": { "wallet": {}, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": "Fasdf", "country": "AT", "line1": "Fasdf", "line2": "Fasdf", "line3": null, "zip": "560095", "state": null, "first_name": "Sakil", "last_name": "Mostak" }, "phone": null, "email": null }, "order_details": null, "email": null, "name": null, "phone": null, "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": { "type": "redirect_to_url", "redirect_to_url": "http://localhost:8080/payments/redirect/pay_Ovu6Gi04d695EdCCEUlP/merchant_1750676714/pay_Ovu6Gi04d695EdCCEUlP_1" }, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "ali_pay", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": null, "connector_transaction_id": "pay_Ovu6Gi04d695EdCCEUlP_1", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_Ovu6Gi04d695EdCCEUlP_1", "payment_link": null, "profile_id": "pro_7Pno0Wbshvrioh4kTJLM", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_aliGZhhX1SDuuEtkipSs", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-06-26T05:15:28.713Z", "fingerprint": null, "browser_info": null, "payment_method_id": null, "payment_method_status": null, "updated": "2025-06-26T05:00:30.315Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": null, "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` </details> <details> <summary> Confirm page </summary> <img width="1188" alt="Screenshot 2025-06-26 at 10 44 33 AM" src="https://github.com/user-attachments/assets/86978961-b4c1-42e0-8ae0-a28f72ea44a4" /> </details> <details> <summary>Psync</summary> ```json { "payment_id": "pay_Ovu6Gi04d695EdCCEUlP", "merchant_id": "merchant_1750676714", "status": "succeeded", "amount": 333, "net_amount": 333, "shipping_cost": null, "amount_capturable": 0, "amount_received": 333, "connector": "multisafepay", "client_secret": "pay_Ovu6Gi04d695EdCCEUlP_secret_M57QtvAffR5Z5DEAkVko", "created": "2025-06-26T05:00:28.713Z", "currency": "EUR", "customer_id": null, "customer": null, "description": "hellow world", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "wallet", "payment_method_data": { "wallet": {}, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": "Fasdf", "country": "AT", "line1": "Fasdf", "line2": "Fasdf", "line3": null, "zip": "560095", "state": null, "first_name": "Sakil", "last_name": "Mostak" }, "phone": null, "email": null }, "order_details": null, "email": null, "name": null, "phone": null, "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "ali_pay", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": false, "connector_transaction_id": "pay_Ovu6Gi04d695EdCCEUlP_1", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_Ovu6Gi04d695EdCCEUlP_1", "payment_link": null, "profile_id": "pro_7Pno0Wbshvrioh4kTJLM", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_aliGZhhX1SDuuEtkipSs", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-06-26T05:15:28.713Z", "fingerprint": null, "browser_info": null, "payment_method_id": null, "payment_method_status": null, "updated": "2025-06-26T05:14:27.864Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": null, "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` </details> ## WeChat pay <details> <summary>Create payment </summary> ```json { "amount": 333, "currency": "EUR", "confirm": true, "capture_method": "automatic", "payment_method": "wallet", "payment_method_type": "we_chat_pay", "authentication_type": "no_three_ds", "description": "hellow world", "billing": { "address": { "zip": "560095", "first_name": "Sakil", "last_name": "Mostak", "line1": "Fasdf", "country": "CN", "line2": "Fasdf", "city": "Fasdf" } }, "payment_method_data": { "wallet": { "we_chat_pay_redirect": {} } } } ``` </details> <details> <summary>create payment response</summary> ```json { "payment_id": "pay_ly7Ihm9zEVRPGi4Q9rAY", "merchant_id": "merchant_1750676714", "status": "requires_customer_action", "amount": 333, "net_amount": 333, "shipping_cost": null, "amount_capturable": 333, "amount_received": null, "connector": "multisafepay", "client_secret": "pay_ly7Ihm9zEVRPGi4Q9rAY_secret_0QAA4w1LChiYL9nlsVW7", "created": "2025-06-26T05:22:38.368Z", "currency": "EUR", "customer_id": null, "customer": null, "description": "hellow world", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "wallet", "payment_method_data": { "wallet": {}, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": "Fasdf", "country": "CN", "line1": "Fasdf", "line2": "Fasdf", "line3": null, "zip": "560095", "state": null, "first_name": "Sakil", "last_name": "Mostak" }, "phone": null, "email": null }, "order_details": null, "email": null, "name": null, "phone": null, "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": { "type": "redirect_to_url", "redirect_to_url": "http://localhost:8080/payments/redirect/pay_ly7Ihm9zEVRPGi4Q9rAY/merchant_1750676714/pay_ly7Ihm9zEVRPGi4Q9rAY_1" }, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "we_chat_pay", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": null, "connector_transaction_id": "pay_ly7Ihm9zEVRPGi4Q9rAY_1", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_ly7Ihm9zEVRPGi4Q9rAY_1", "payment_link": null, "profile_id": "pro_7Pno0Wbshvrioh4kTJLM", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_aliGZhhX1SDuuEtkipSs", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-06-26T05:37:38.368Z", "fingerprint": null, "browser_info": null, "payment_method_id": null, "payment_method_status": null, "updated": "2025-06-26T05:22:39.622Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": null, "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` </details> <details> <summary>Confirm page</summary> ## You will get a qr page and it needs to be scanned normally and it will direct to confirm page (test mode) <img width="1105" alt="Screenshot 2025-06-26 at 10 53 31 AM" src="https://github.com/user-attachments/assets/e7385469-ae56-4849-a131-d3ff941445ba" /> </details> <details> <summary>Psync </summary> ```json { "payment_id": "pay_ly7Ihm9zEVRPGi4Q9rAY", "merchant_id": "merchant_1750676714", "status": "succeeded", "amount": 333, "net_amount": 333, "shipping_cost": null, "amount_capturable": 0, "amount_received": 333, "connector": "multisafepay", "client_secret": "pay_ly7Ihm9zEVRPGi4Q9rAY_secret_0QAA4w1LChiYL9nlsVW7", "created": "2025-06-26T05:22:38.368Z", "currency": "EUR", "customer_id": null, "customer": null, "description": "hellow world", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "wallet", "payment_method_data": { "wallet": {}, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": "Fasdf", "country": "CN", "line1": "Fasdf", "line2": "Fasdf", "line3": null, "zip": "560095", "state": null, "first_name": "Sakil", "last_name": "Mostak" }, "phone": null, "email": null }, "order_details": null, "email": null, "name": null, "phone": null, "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "we_chat_pay", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": false, "connector_transaction_id": "pay_ly7Ihm9zEVRPGi4Q9rAY_1", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_ly7Ihm9zEVRPGi4Q9rAY_1", "payment_link": null, "profile_id": "pro_7Pno0Wbshvrioh4kTJLM", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_aliGZhhX1SDuuEtkipSs", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-06-26T05:37:38.368Z", "fingerprint": null, "browser_info": null, "payment_method_id": null, "payment_method_status": null, "updated": "2025-06-26T05:23:57.958Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": null, "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` </details> ## Checklist - [x] I formatted the code `cargo +nightly fmt --all` - [ ] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.114.0	6d98d5721be41bbd2b9674ab0dbdeafe6c95b95f	6d98d5721be41bbd2b9674ab0dbdeafe6c95b95f
juspay/hyperswitch	juspay__hyperswitch-8491	Bug: [FEATURE] celero connector template ### Feature Description Create connector template ### Possible Implementation https://celerocommerce.com/developers/ ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? None	diff --git a/api-reference/v1/openapi_spec_v1.json b/api-reference/v1/openapi_spec_v1.json index 84cfe8e6199..940922743ca 100644 --- a/api-reference/v1/openapi_spec_v1.json +++ b/api-reference/v1/openapi_spec_v1.json @@ -10940,6 +10940,7 @@ "boku", "braintree", "cashtocode", + "celero", "chargebee", "checkout", "coinbase", @@ -27949,6 +27950,7 @@ "boku", "braintree", "cashtocode", + "celero", "chargebee", "checkout", "coinbase", diff --git a/api-reference/v2/openapi_spec_v2.json b/api-reference/v2/openapi_spec_v2.json index 63a25bf4fc2..12340ea5dcb 100644 --- a/api-reference/v2/openapi_spec_v2.json +++ b/api-reference/v2/openapi_spec_v2.json @@ -8147,6 +8147,7 @@ "boku", "braintree", "cashtocode", + "celero", "chargebee", "checkout", "coinbase", @@ -22666,6 +22667,7 @@ "boku", "braintree", "cashtocode", + "celero", "chargebee", "checkout", "coinbase", diff --git a/config/config.example.toml b/config/config.example.toml index 3c6da56b240..0bb5cb13007 100644 --- a/config/config.example.toml +++ b/config/config.example.toml @@ -202,6 +202,7 @@ bluesnap.secondary_base_url = "https://sandpay.bluesnap.com/" boku.base_url = "https://$-api4-stage.boku.com" braintree.base_url = "https://payments.sandbox.braintree-api.com/graphql" cashtocode.base_url = "https://cluster05.api-test.cashtocode.com" +celero.base_url = "https://sandbox.gotnpgateway.com" chargebee.base_url = "https://$.chargebee.com/api/" checkbook.base_url = "https://api.sandbox.checkbook.io" checkout.base_url = "https://api.sandbox.checkout.com/" @@ -342,6 +343,7 @@ cards = [ "adyenplatform", "archipel", "authorizedotnet", + "celero", "coinbase", "coingate", "cryptopay", diff --git a/config/deployments/integration_test.toml b/config/deployments/integration_test.toml index 495847bd896..c92570aaeef 100644 --- a/config/deployments/integration_test.toml +++ b/config/deployments/integration_test.toml @@ -41,6 +41,7 @@ bluesnap.secondary_base_url = "https://sandpay.bluesnap.com/" boku.base_url = "https://$-api4-stage.boku.com" braintree.base_url = "https://payments.sandbox.braintree-api.com/graphql" cashtocode.base_url = "https://cluster05.api-test.cashtocode.com" +celero.base_url = "https://sandbox.gotnpgateway.com" chargebee.base_url = "https://$.chargebee.com/api/" checkbook.base_url = "https://api.sandbox.checkbook.io" checkout.base_url = "https://api.sandbox.checkout.com/" diff --git a/config/deployments/production.toml b/config/deployments/production.toml index 335d7f5acea..8e7fd10702c 100644 --- a/config/deployments/production.toml +++ b/config/deployments/production.toml @@ -45,6 +45,7 @@ bluesnap.secondary_base_url = "https://pay.bluesnap.com/" boku.base_url = "https://country-api4-stage.boku.com" braintree.base_url = "https://payments.braintree-api.com/graphql" cashtocode.base_url = "https://cluster14.api.cashtocode.com" +celero.base_url = "https://app.gotnpgateway.com" chargebee.base_url = "https://{{merchant_endpoint_prefix}}.chargebee.com/api/" checkbook.base_url = "https://api.checkbook.io" checkout.base_url = "https://api.checkout.com/" diff --git a/config/deployments/sandbox.toml b/config/deployments/sandbox.toml index 721e32b9b8e..2011b50b756 100644 --- a/config/deployments/sandbox.toml +++ b/config/deployments/sandbox.toml @@ -45,6 +45,7 @@ bluesnap.secondary_base_url = "https://sandpay.bluesnap.com/" boku.base_url = "https://$-api4-stage.boku.com" braintree.base_url = "https://payments.sandbox.braintree-api.com/graphql" cashtocode.base_url = "https://cluster05.api-test.cashtocode.com" +celero.base_url = "https://sandbox.gotnpgateway.com" checkbook.base_url = "https://api.sandbox.checkbook.io" checkout.base_url = "https://api.sandbox.checkout.com/" chargebee.base_url = "https://$.chargebee.com/api/" diff --git a/config/development.toml b/config/development.toml index ab885503c85..49e5bb8a52e 100644 --- a/config/development.toml +++ b/config/development.toml @@ -109,6 +109,7 @@ cards = [ "bluesnap", "boku", "braintree", + "celero", "checkbook", "checkout", "coinbase", @@ -238,6 +239,7 @@ bluesnap.secondary_base_url = "https://sandpay.bluesnap.com/" boku.base_url = "https://$-api4-stage.boku.com" braintree.base_url = "https://payments.sandbox.braintree-api.com/graphql" cashtocode.base_url = "https://cluster05.api-test.cashtocode.com" +celero.base_url = "https://sandbox.gotnpgateway.com" chargebee.base_url = "https://$.chargebee.com/api/" checkbook.base_url = "https://api.sandbox.checkbook.io" checkout.base_url = "https://api.sandbox.checkout.com/" diff --git a/config/docker_compose.toml b/config/docker_compose.toml index dbfeccf7cd0..329c3743d39 100644 --- a/config/docker_compose.toml +++ b/config/docker_compose.toml @@ -128,6 +128,7 @@ bluesnap.secondary_base_url = "https://sandpay.bluesnap.com/" boku.base_url = "https://$-api4-stage.boku.com" braintree.base_url = "https://payments.sandbox.braintree-api.com/graphql" cashtocode.base_url = "https://cluster05.api-test.cashtocode.com" +celero.base_url = "https://sandbox.gotnpgateway.com" chargebee.base_url = "https://$.chargebee.com/api/" checkbook.base_url = "https://api.sandbox.checkbook.io" checkout.base_url = "https://api.sandbox.checkout.com/" @@ -259,6 +260,7 @@ cards = [ "bluesnap", "boku", "braintree", + "celero", "checkout", "checkbook", "coinbase", diff --git a/crates/common_enums/src/connector_enums.rs b/crates/common_enums/src/connector_enums.rs index e975dc8bcbd..5251b9b3177 100644 --- a/crates/common_enums/src/connector_enums.rs +++ b/crates/common_enums/src/connector_enums.rs @@ -74,6 +74,7 @@ pub enum RoutableConnectors { Boku, Braintree, Cashtocode, + Celero, Chargebee, // Checkbook, Checkout, @@ -232,6 +233,7 @@ pub enum Connector { Boku, Braintree, Cashtocode, + Celero, Chargebee, // Checkbook, Checkout, @@ -417,6 +419,7 @@ impl Connector { \| Self::Boku \| Self::Braintree \| Self::Cashtocode + \| Self::Celero \| Self::Chargebee // \| Self::Checkbook \| Self::Coinbase @@ -580,6 +583,7 @@ impl From<RoutableConnectors> for Connector { RoutableConnectors::Boku => Self::Boku, RoutableConnectors::Braintree => Self::Braintree, RoutableConnectors::Cashtocode => Self::Cashtocode, + RoutableConnectors::Celero => Self::Celero, RoutableConnectors::Chargebee => Self::Chargebee, // RoutableConnectors::Checkbook => Self::Checkbook, RoutableConnectors::Checkout => Self::Checkout, @@ -701,6 +705,7 @@ impl TryFrom<Connector> for RoutableConnectors { Connector::Boku => Ok(Self::Boku), Connector::Braintree => Ok(Self::Braintree), Connector::Cashtocode => Ok(Self::Cashtocode), + Connector::Celero => Ok(Self::Celero), Connector::Chargebee => Ok(Self::Chargebee), // Connector::Checkbook => Ok(Self::Checkbook), Connector::Checkout => Ok(Self::Checkout), diff --git a/crates/connector_configs/src/connector.rs b/crates/connector_configs/src/connector.rs index 6ec11e8ca78..3e36dc023b9 100644 --- a/crates/connector_configs/src/connector.rs +++ b/crates/connector_configs/src/connector.rs @@ -190,6 +190,7 @@ pub struct ConnectorConfig { pub boku: Option<ConnectorTomlConfig>, pub braintree: Option<ConnectorTomlConfig>, pub cashtocode: Option<ConnectorTomlConfig>, + pub celero: Option<ConnectorTomlConfig>, pub chargebee: Option<ConnectorTomlConfig>, pub checkbook: Option<ConnectorTomlConfig>, pub checkout: Option<ConnectorTomlConfig>, @@ -381,6 +382,7 @@ impl ConnectorConfig { Connector::Boku => Ok(connector_data.boku), Connector::Braintree => Ok(connector_data.braintree), Connector::Cashtocode => Ok(connector_data.cashtocode), + Connector::Celero => Ok(connector_data.celero), Connector::Chargebee => Ok(connector_data.chargebee), Connector::Checkout => Ok(connector_data.checkout), Connector::Coinbase => Ok(connector_data.coinbase), diff --git a/crates/hyperswitch_connectors/src/connectors.rs b/crates/hyperswitch_connectors/src/connectors.rs index 16b56bed6fc..0861bbb4610 100644 --- a/crates/hyperswitch_connectors/src/connectors.rs +++ b/crates/hyperswitch_connectors/src/connectors.rs @@ -15,6 +15,7 @@ pub mod bluesnap; pub mod boku; pub mod braintree; pub mod cashtocode; +pub mod celero; pub mod chargebee; pub mod checkbook; pub mod checkout; @@ -116,26 +117,26 @@ pub use self::{ amazonpay::Amazonpay, archipel::Archipel, authorizedotnet::Authorizedotnet, bambora::Bambora, bamboraapac::Bamboraapac, bankofamerica::Bankofamerica, barclaycard::Barclaycard, billwerk::Billwerk, bitpay::Bitpay, bluesnap::Bluesnap, boku::Boku, braintree::Braintree, - cashtocode::Cashtocode, chargebee::Chargebee, checkbook::Checkbook, checkout::Checkout, - coinbase::Coinbase, coingate::Coingate, cryptopay::Cryptopay, ctp_mastercard::CtpMastercard, - cybersource::Cybersource, datatrans::Datatrans, deutschebank::Deutschebank, - digitalvirgo::Digitalvirgo, dlocal::Dlocal, dwolla::Dwolla, ebanx::Ebanx, elavon::Elavon, - facilitapay::Facilitapay, fiserv::Fiserv, fiservemea::Fiservemea, fiuu::Fiuu, forte::Forte, - getnet::Getnet, globalpay::Globalpay, globepay::Globepay, gocardless::Gocardless, - gpayments::Gpayments, helcim::Helcim, hipay::Hipay, hyperswitch_vault::HyperswitchVault, - iatapay::Iatapay, inespay::Inespay, itaubank::Itaubank, jpmorgan::Jpmorgan, - juspaythreedsserver::Juspaythreedsserver, klarna::Klarna, mifinity::Mifinity, mollie::Mollie, - moneris::Moneris, multisafepay::Multisafepay, netcetera::Netcetera, nexinets::Nexinets, - nexixpay::Nexixpay, nmi::Nmi, nomupay::Nomupay, noon::Noon, nordea::Nordea, novalnet::Novalnet, - nuvei::Nuvei, opayo::Opayo, opennode::Opennode, paybox::Paybox, payeezy::Payeezy, - payload::Payload, payme::Payme, payone::Payone, paypal::Paypal, paystack::Paystack, payu::Payu, - placetopay::Placetopay, plaid::Plaid, powertranz::Powertranz, prophetpay::Prophetpay, - rapyd::Rapyd, razorpay::Razorpay, recurly::Recurly, redsys::Redsys, riskified::Riskified, - santander::Santander, shift4::Shift4, signifyd::Signifyd, square::Square, stax::Stax, - stripe::Stripe, stripebilling::Stripebilling, taxjar::Taxjar, threedsecureio::Threedsecureio, - thunes::Thunes, tokenio::Tokenio, trustpay::Trustpay, tsys::Tsys, - unified_authentication_service::UnifiedAuthenticationService, vgs::Vgs, volt::Volt, - wellsfargo::Wellsfargo, wellsfargopayout::Wellsfargopayout, wise::Wise, worldline::Worldline, - worldpay::Worldpay, worldpayvantiv::Worldpayvantiv, worldpayxml::Worldpayxml, xendit::Xendit, - zen::Zen, zsl::Zsl, + cashtocode::Cashtocode, celero::Celero, chargebee::Chargebee, checkbook::Checkbook, + checkout::Checkout, coinbase::Coinbase, coingate::Coingate, cryptopay::Cryptopay, + ctp_mastercard::CtpMastercard, cybersource::Cybersource, datatrans::Datatrans, + deutschebank::Deutschebank, digitalvirgo::Digitalvirgo, dlocal::Dlocal, dwolla::Dwolla, + ebanx::Ebanx, elavon::Elavon, facilitapay::Facilitapay, fiserv::Fiserv, fiservemea::Fiservemea, + fiuu::Fiuu, forte::Forte, getnet::Getnet, globalpay::Globalpay, globepay::Globepay, + gocardless::Gocardless, gpayments::Gpayments, helcim::Helcim, hipay::Hipay, + hyperswitch_vault::HyperswitchVault, iatapay::Iatapay, inespay::Inespay, itaubank::Itaubank, + jpmorgan::Jpmorgan, juspaythreedsserver::Juspaythreedsserver, klarna::Klarna, + mifinity::Mifinity, mollie::Mollie, moneris::Moneris, multisafepay::Multisafepay, + netcetera::Netcetera, nexinets::Nexinets, nexixpay::Nexixpay, nmi::Nmi, nomupay::Nomupay, + noon::Noon, nordea::Nordea, novalnet::Novalnet, nuvei::Nuvei, opayo::Opayo, opennode::Opennode, + paybox::Paybox, payeezy::Payeezy, payload::Payload, payme::Payme, payone::Payone, + paypal::Paypal, paystack::Paystack, payu::Payu, placetopay::Placetopay, plaid::Plaid, + powertranz::Powertranz, prophetpay::Prophetpay, rapyd::Rapyd, razorpay::Razorpay, + recurly::Recurly, redsys::Redsys, riskified::Riskified, santander::Santander, shift4::Shift4, + signifyd::Signifyd, square::Square, stax::Stax, stripe::Stripe, stripebilling::Stripebilling, + taxjar::Taxjar, threedsecureio::Threedsecureio, thunes::Thunes, tokenio::Tokenio, + trustpay::Trustpay, tsys::Tsys, unified_authentication_service::UnifiedAuthenticationService, + vgs::Vgs, volt::Volt, wellsfargo::Wellsfargo, wellsfargopayout::Wellsfargopayout, wise::Wise, + worldline::Worldline, worldpay::Worldpay, worldpayvantiv::Worldpayvantiv, + worldpayxml::Worldpayxml, xendit::Xendit, zen::Zen, zsl::Zsl, }; diff --git a/crates/hyperswitch_connectors/src/connectors/celero.rs b/crates/hyperswitch_connectors/src/connectors/celero.rs new file mode 100644 index 00000000000..5d37d737355 --- /dev/null +++ b/crates/hyperswitch_connectors/src/connectors/celero.rs @@ -0,0 +1,571 @@ +pub mod transformers; + +use common_utils::{ + errors::CustomResult, + ext_traits::BytesExt, + request::{Method, Request, RequestBuilder, RequestContent}, + types::{AmountConvertor, StringMinorUnit, StringMinorUnitForConnector}, +}; +use error_stack::{report, ResultExt}; +use hyperswitch_domain_models::{ + router_data::{AccessToken, ConnectorAuthType, ErrorResponse, RouterData}, + router_flow_types::{ + access_token_auth::AccessTokenAuth, + payments::{Authorize, Capture, PSync, PaymentMethodToken, Session, SetupMandate, Void}, + refunds::{Execute, RSync}, + }, + router_request_types::{ + AccessTokenRequestData, PaymentMethodTokenizationData, PaymentsAuthorizeData, + PaymentsCancelData, PaymentsCaptureData, PaymentsSessionData, PaymentsSyncData, + RefundsData, SetupMandateRequestData, + }, + router_response_types::{PaymentsResponseData, RefundsResponseData}, + types::{ + PaymentsAuthorizeRouterData, PaymentsCaptureRouterData, PaymentsSyncRouterData, + RefundSyncRouterData, RefundsRouterData, + }, +}; +use hyperswitch_interfaces::{ + api::{ + self, ConnectorCommon, ConnectorCommonExt, ConnectorIntegration, ConnectorSpecifications, + ConnectorValidation, + }, + configs::Connectors, + errors, + events::connector_api_logs::ConnectorEvent, + types::{self, Response}, + webhooks, +}; +use masking::{ExposeInterface, Mask}; +use transformers as celero; + +use crate::{constants::headers, types::ResponseRouterData, utils}; + +#[derive(Clone)] +pub struct Celero { + amount_converter: &'static (dyn AmountConvertor<Output = StringMinorUnit> + Sync), +} + +impl Celero { + pub fn new() -> &'static Self { + &Self { + amount_converter: &StringMinorUnitForConnector, + } + } +} + +impl api::Payment for Celero {} +impl api::PaymentSession for Celero {} +impl api::ConnectorAccessToken for Celero {} +impl api::MandateSetup for Celero {} +impl api::PaymentAuthorize for Celero {} +impl api::PaymentSync for Celero {} +impl api::PaymentCapture for Celero {} +impl api::PaymentVoid for Celero {} +impl api::Refund for Celero {} +impl api::RefundExecute for Celero {} +impl api::RefundSync for Celero {} +impl api::PaymentToken for Celero {} + +impl ConnectorIntegration<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData> + for Celero +{ + // Not Implemented (R) +} + +impl<Flow, Request, Response> ConnectorCommonExt<Flow, Request, Response> for Celero +where + Self: ConnectorIntegration<Flow, Request, Response>, +{ + fn build_headers( + &self, + req: &RouterData<Flow, Request, Response>, + _connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + let mut header = vec![( + headers::CONTENT_TYPE.to_string(), + self.get_content_type().to_string().into(), + )]; + let mut api_key = self.get_auth_header(&req.connector_auth_type)?; + header.append(&mut api_key); + Ok(header) + } +} + +impl ConnectorCommon for Celero { + fn id(&self) -> &'static str { + "celero" + } + + fn get_currency_unit(&self) -> api::CurrencyUnit { + api::CurrencyUnit::Base + // TODO! Check connector documentation, on which unit they are processing the currency. + // If the connector accepts amount in lower unit ( i.e cents for USD) then return api::CurrencyUnit::Minor, + // if connector accepts amount in base unit (i.e dollars for USD) then return api::CurrencyUnit::Base + } + + fn common_get_content_type(&self) -> &'static str { + "application/json" + } + + fn base_url<'a>(&self, connectors: &'a Connectors) -> &'a str { + connectors.celero.base_url.as_ref() + } + + fn get_auth_header( + &self, + auth_type: &ConnectorAuthType, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + let auth = celero::CeleroAuthType::try_from(auth_type) + .change_context(errors::ConnectorError::FailedToObtainAuthType)?; + Ok(vec![( + headers::AUTHORIZATION.to_string(), + auth.api_key.expose().into_masked(), + )]) + } + + fn build_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + let response: celero::CeleroErrorResponse = res + .response + .parse_struct("CeleroErrorResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + + Ok(ErrorResponse { + status_code: res.status_code, + code: response.code, + message: response.message, + reason: response.reason, + attempt_status: None, + connector_transaction_id: None, + network_decline_code: None, + network_advice_code: None, + network_error_message: None, + }) + } +} + +impl ConnectorValidation for Celero { + //TODO: implement functions when support enabled +} + +impl ConnectorIntegration<Session, PaymentsSessionData, PaymentsResponseData> for Celero { + //TODO: implement sessions flow +} + +impl ConnectorIntegration<AccessTokenAuth, AccessTokenRequestData, AccessToken> for Celero {} + +impl ConnectorIntegration<SetupMandate, SetupMandateRequestData, PaymentsResponseData> for Celero {} + +impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData> for Celero { + fn get_headers( + &self, + req: &PaymentsAuthorizeRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsAuthorizeRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn get_request_body( + &self, + req: &PaymentsAuthorizeRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let amount = utils::convert_amount( + self.amount_converter, + req.request.minor_amount, + req.request.currency, + )?; + + let connector_router_data = celero::CeleroRouterData::from((amount, req)); + let connector_req = celero::CeleroPaymentsRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &PaymentsAuthorizeRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::PaymentsAuthorizeType::get_url( + self, req, connectors, + )?) + .attach_default_headers() + .headers(types::PaymentsAuthorizeType::get_headers( + self, req, connectors, + )?) + .set_body(types::PaymentsAuthorizeType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsAuthorizeRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsAuthorizeRouterData, errors::ConnectorError> { + let response: celero::CeleroPaymentsResponse = res + .response + .parse_struct("Celero PaymentsAuthorizeResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<PSync, PaymentsSyncData, PaymentsResponseData> for Celero { + fn get_headers( + &self, + req: &PaymentsSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsSyncRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn build_request( + &self, + req: &PaymentsSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Get) + .url(&types::PaymentsSyncType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::PaymentsSyncType::get_headers(self, req, connectors)?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsSyncRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsSyncRouterData, errors::ConnectorError> { + let response: celero::CeleroPaymentsResponse = res + .response + .parse_struct("celero PaymentsSyncResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<Capture, PaymentsCaptureData, PaymentsResponseData> for Celero { + fn get_headers( + &self, + req: &PaymentsCaptureRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsCaptureRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn get_request_body( + &self, + _req: &PaymentsCaptureRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_request_body method".to_string()).into()) + } + + fn build_request( + &self, + req: &PaymentsCaptureRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::PaymentsCaptureType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::PaymentsCaptureType::get_headers( + self, req, connectors, + )?) + .set_body(types::PaymentsCaptureType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsCaptureRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsCaptureRouterData, errors::ConnectorError> { + let response: celero::CeleroPaymentsResponse = res + .response + .parse_struct("Celero PaymentsCaptureResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<Void, PaymentsCancelData, PaymentsResponseData> for Celero {} + +impl ConnectorIntegration<Execute, RefundsData, RefundsResponseData> for Celero { + fn get_headers( + &self, + req: &RefundsRouterData<Execute>, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &RefundsRouterData<Execute>, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn get_request_body( + &self, + req: &RefundsRouterData<Execute>, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let refund_amount = utils::convert_amount( + self.amount_converter, + req.request.minor_refund_amount, + req.request.currency, + )?; + + let connector_router_data = celero::CeleroRouterData::from((refund_amount, req)); + let connector_req = celero::CeleroRefundRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &RefundsRouterData<Execute>, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + let request = RequestBuilder::new() + .method(Method::Post) + .url(&types::RefundExecuteType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::RefundExecuteType::get_headers( + self, req, connectors, + )?) + .set_body(types::RefundExecuteType::get_request_body( + self, req, connectors, + )?) + .build(); + Ok(Some(request)) + } + + fn handle_response( + &self, + data: &RefundsRouterData<Execute>, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<RefundsRouterData<Execute>, errors::ConnectorError> { + let response: celero::RefundResponse = + res.response + .parse_struct("celero RefundResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<RSync, RefundsData, RefundsResponseData> for Celero { + fn get_headers( + &self, + req: &RefundSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &RefundSyncRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn build_request( + &self, + req: &RefundSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Get) + .url(&types::RefundSyncType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::RefundSyncType::get_headers(self, req, connectors)?) + .set_body(types::RefundSyncType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &RefundSyncRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<RefundSyncRouterData, errors::ConnectorError> { + let response: celero::RefundResponse = res + .response + .parse_struct("celero RefundSyncResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +#[async_trait::async_trait] +impl webhooks::IncomingWebhook for Celero { + fn get_webhook_object_reference_id( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<api_models::webhooks::ObjectReferenceId, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } + + fn get_webhook_event_type( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<api_models::webhooks::IncomingWebhookEvent, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } + + fn get_webhook_resource_object( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<Box<dyn masking::ErasedMaskSerialize>, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } +} + +impl ConnectorSpecifications for Celero {} diff --git a/crates/hyperswitch_connectors/src/connectors/celero/transformers.rs b/crates/hyperswitch_connectors/src/connectors/celero/transformers.rs new file mode 100644 index 00000000000..2579c81ae6b --- /dev/null +++ b/crates/hyperswitch_connectors/src/connectors/celero/transformers.rs @@ -0,0 +1,228 @@ +use common_enums::enums; +use common_utils::types::StringMinorUnit; +use hyperswitch_domain_models::{ + payment_method_data::PaymentMethodData, + router_data::{ConnectorAuthType, RouterData}, + router_flow_types::refunds::{Execute, RSync}, + router_request_types::ResponseId, + router_response_types::{PaymentsResponseData, RefundsResponseData}, + types::{PaymentsAuthorizeRouterData, RefundsRouterData}, +}; +use hyperswitch_interfaces::errors; +use masking::Secret; +use serde::{Deserialize, Serialize}; + +use crate::{ + types::{RefundsResponseRouterData, ResponseRouterData}, + utils::PaymentsAuthorizeRequestData, +}; + +//TODO: Fill the struct with respective fields +pub struct CeleroRouterData<T> { + pub amount: StringMinorUnit, // The type of amount that a connector accepts, for example, String, i64, f64, etc. + pub router_data: T, +} + +impl<T> From<(StringMinorUnit, T)> for CeleroRouterData<T> { + fn from((amount, item): (StringMinorUnit, T)) -> Self { + //Todo : use utils to convert the amount to the type of amount that a connector accepts + Self { + amount, + router_data: item, + } + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Serialize, PartialEq)] +pub struct CeleroPaymentsRequest { + amount: StringMinorUnit, + card: CeleroCard, +} + +#[derive(Default, Debug, Serialize, Eq, PartialEq)] +pub struct CeleroCard { + number: cards::CardNumber, + expiry_month: Secret<String>, + expiry_year: Secret<String>, + cvc: Secret<String>, + complete: bool, +} + +impl TryFrom<&CeleroRouterData<&PaymentsAuthorizeRouterData>> for CeleroPaymentsRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: &CeleroRouterData<&PaymentsAuthorizeRouterData>, + ) -> Result<Self, Self::Error> { + match item.router_data.request.payment_method_data.clone() { + PaymentMethodData::Card(req_card) => { + let card = CeleroCard { + number: req_card.card_number, + expiry_month: req_card.card_exp_month, + expiry_year: req_card.card_exp_year, + cvc: req_card.card_cvc, + complete: item.router_data.request.is_auto_capture()?, + }; + Ok(Self { + amount: item.amount.clone(), + card, + }) + } + _ => Err(errors::ConnectorError::NotImplemented("Payment method".to_string()).into()), + } + } +} + +//TODO: Fill the struct with respective fields +// Auth Struct +pub struct CeleroAuthType { + pub(super) api_key: Secret<String>, +} + +impl TryFrom<&ConnectorAuthType> for CeleroAuthType { + 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)] +#[serde(rename_all = "lowercase")] +pub enum CeleroPaymentStatus { + Succeeded, + Failed, + #[default] + Processing, +} + +impl From<CeleroPaymentStatus> for common_enums::AttemptStatus { + fn from(item: CeleroPaymentStatus) -> Self { + match item { + CeleroPaymentStatus::Succeeded => Self::Charged, + CeleroPaymentStatus::Failed => Self::Failure, + CeleroPaymentStatus::Processing => Self::Authorizing, + } + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] +pub struct CeleroPaymentsResponse { + status: CeleroPaymentStatus, + id: String, +} + +impl<F, T> TryFrom<ResponseRouterData<F, CeleroPaymentsResponse, T, PaymentsResponseData>> + for RouterData<F, T, PaymentsResponseData> +{ + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: ResponseRouterData<F, CeleroPaymentsResponse, T, PaymentsResponseData>, + ) -> Result<Self, Self::Error> { + Ok(Self { + status: common_enums::AttemptStatus::from(item.response.status), + response: Ok(PaymentsResponseData::TransactionResponse { + resource_id: ResponseId::ConnectorTransactionId(item.response.id), + redirection_data: Box::new(None), + mandate_reference: Box::new(None), + connector_metadata: None, + network_txn_id: None, + connector_response_reference_id: None, + incremental_authorization_allowed: None, + charges: None, + }), + ..item.data + }) + } +} + +//TODO: Fill the struct with respective fields +// REFUND : +// Type definition for RefundRequest +#[derive(Default, Debug, Serialize)] +pub struct CeleroRefundRequest { + pub amount: StringMinorUnit, +} + +impl<F> TryFrom<&CeleroRouterData<&RefundsRouterData<F>>> for CeleroRefundRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from(item: &CeleroRouterData<&RefundsRouterData<F>>) -> Result<Self, Self::Error> { + Ok(Self { + amount: item.amount.to_owned(), + }) + } +} + +// Type definition for Refund Response + +#[allow(dead_code)] +#[derive(Debug, Serialize, Default, Deserialize, Clone)] +pub enum RefundStatus { + Succeeded, + Failed, + #[default] + Processing, +} + +impl From<RefundStatus> for enums::RefundStatus { + fn from(item: RefundStatus) -> Self { + match item { + RefundStatus::Succeeded => Self::Success, + RefundStatus::Failed => Self::Failure, + RefundStatus::Processing => Self::Pending, + //TODO: Review mapping + } + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Clone, Serialize, Deserialize)] +pub struct RefundResponse { + id: String, + status: RefundStatus, +} + +impl TryFrom<RefundsResponseRouterData<Execute, RefundResponse>> for RefundsRouterData<Execute> { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: RefundsResponseRouterData<Execute, RefundResponse>, + ) -> Result<Self, Self::Error> { + Ok(Self { + response: Ok(RefundsResponseData { + connector_refund_id: item.response.id.to_string(), + refund_status: enums::RefundStatus::from(item.response.status), + }), + ..item.data + }) + } +} + +impl TryFrom<RefundsResponseRouterData<RSync, RefundResponse>> for RefundsRouterData<RSync> { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: RefundsResponseRouterData<RSync, RefundResponse>, + ) -> Result<Self, Self::Error> { + Ok(Self { + response: Ok(RefundsResponseData { + connector_refund_id: item.response.id.to_string(), + refund_status: enums::RefundStatus::from(item.response.status), + }), + ..item.data + }) + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Serialize, Deserialize, PartialEq)] +pub struct CeleroErrorResponse { + pub status_code: u16, + pub code: String, + pub message: String, + pub reason: Option<String>, +} diff --git a/crates/hyperswitch_connectors/src/default_implementations.rs b/crates/hyperswitch_connectors/src/default_implementations.rs index a338b96bc55..a2a5c163865 100644 --- a/crates/hyperswitch_connectors/src/default_implementations.rs +++ b/crates/hyperswitch_connectors/src/default_implementations.rs @@ -159,6 +159,7 @@ default_imp_for_authorize_session_token!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -283,6 +284,7 @@ default_imp_for_calculate_tax!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -408,6 +410,7 @@ default_imp_for_session_update!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -533,6 +536,7 @@ default_imp_for_post_session_tokens!( connectors::Boku, connectors::Billwerk, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -657,6 +661,7 @@ default_imp_for_create_order!( connectors::Boku, connectors::Billwerk, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -782,6 +787,7 @@ default_imp_for_update_metadata!( connectors::Boku, connectors::Billwerk, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -905,6 +911,7 @@ default_imp_for_complete_authorize!( connectors::Bitpay, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1015,6 +1022,7 @@ default_imp_for_incremental_authorization!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1140,6 +1148,7 @@ default_imp_for_create_customer!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1259,6 +1268,7 @@ default_imp_for_connector_redirect_response!( connectors::Barclaycard, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Coinbase, @@ -1367,6 +1377,7 @@ default_imp_for_pre_processing_steps!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1483,6 +1494,7 @@ default_imp_for_post_processing_steps!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1609,6 +1621,7 @@ default_imp_for_approve!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1736,6 +1749,7 @@ default_imp_for_reject!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1863,6 +1877,7 @@ default_imp_for_webhook_source_verification!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1989,6 +2004,7 @@ default_imp_for_accept_dispute!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Coinbase, @@ -2114,6 +2130,7 @@ default_imp_for_submit_evidence!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Coinbase, @@ -2238,6 +2255,7 @@ default_imp_for_defend_dispute!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Coinbase, @@ -2372,6 +2390,7 @@ default_imp_for_file_upload!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Coinbase, @@ -2488,6 +2507,7 @@ default_imp_for_payouts!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -2608,6 +2628,7 @@ default_imp_for_payouts_create!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -2732,6 +2753,7 @@ default_imp_for_payouts_retrieve!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -2858,6 +2880,7 @@ default_imp_for_payouts_eligibility!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -2982,6 +3005,7 @@ default_imp_for_payouts_fulfill!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -3103,6 +3127,7 @@ default_imp_for_payouts_cancel!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -3228,6 +3253,7 @@ default_imp_for_payouts_quote!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -3354,6 +3380,7 @@ default_imp_for_payouts_recipient!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -3479,6 +3506,7 @@ default_imp_for_payouts_recipient_account!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -3606,6 +3634,7 @@ default_imp_for_frm_sale!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -3733,6 +3762,7 @@ default_imp_for_frm_checkout!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -3860,6 +3890,7 @@ default_imp_for_frm_transaction!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -3987,6 +4018,7 @@ default_imp_for_frm_fulfillment!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -4114,6 +4146,7 @@ default_imp_for_frm_record_return!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -4237,6 +4270,7 @@ default_imp_for_revoking_mandates!( connectors::Bluesnap, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -4360,6 +4394,7 @@ default_imp_for_uas_pre_authentication!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -4484,6 +4519,7 @@ default_imp_for_uas_post_authentication!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -4609,6 +4645,7 @@ default_imp_for_uas_authentication_confirmation!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -4726,6 +4763,7 @@ default_imp_for_connector_request_id!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -4845,6 +4883,7 @@ default_imp_for_fraud_check!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -4994,6 +5033,7 @@ default_imp_for_connector_authentication!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -5116,6 +5156,7 @@ default_imp_for_uas_authentication!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -5233,6 +5274,7 @@ default_imp_for_revenue_recovery!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -5361,6 +5403,7 @@ default_imp_for_billing_connector_payment_sync!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -5488,6 +5531,7 @@ default_imp_for_revenue_recovery_record_back!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Checkbook, connectors::Checkout, connectors::Coinbase, @@ -5613,6 +5657,7 @@ default_imp_for_billing_connector_invoice_sync!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -5733,6 +5778,7 @@ default_imp_for_external_vault!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -5859,6 +5905,7 @@ default_imp_for_external_vault_insert!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -5985,6 +6032,7 @@ default_imp_for_external_vault_retrieve!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -6111,6 +6159,7 @@ default_imp_for_external_vault_delete!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -6237,6 +6286,7 @@ default_imp_for_external_vault_create!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, diff --git a/crates/hyperswitch_connectors/src/default_implementations_v2.rs b/crates/hyperswitch_connectors/src/default_implementations_v2.rs index 99685607c48..2c3e849d4c9 100644 --- a/crates/hyperswitch_connectors/src/default_implementations_v2.rs +++ b/crates/hyperswitch_connectors/src/default_implementations_v2.rs @@ -264,6 +264,7 @@ default_imp_for_new_connector_integration_payment!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -391,6 +392,7 @@ default_imp_for_new_connector_integration_refund!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -513,6 +515,7 @@ default_imp_for_new_connector_integration_connector_access_token!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -641,6 +644,7 @@ default_imp_for_new_connector_integration_accept_dispute!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -767,6 +771,7 @@ default_imp_for_new_connector_integration_submit_evidence!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -893,6 +898,7 @@ default_imp_for_new_connector_integration_defend_dispute!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1030,6 +1036,7 @@ default_imp_for_new_connector_integration_file_upload!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1159,6 +1166,7 @@ default_imp_for_new_connector_integration_payouts_create!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1288,6 +1296,7 @@ default_imp_for_new_connector_integration_payouts_eligibility!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1417,6 +1426,7 @@ default_imp_for_new_connector_integration_payouts_fulfill!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1546,6 +1556,7 @@ default_imp_for_new_connector_integration_payouts_cancel!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1675,6 +1686,7 @@ default_imp_for_new_connector_integration_payouts_quote!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1804,6 +1816,7 @@ default_imp_for_new_connector_integration_payouts_recipient!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1933,6 +1946,7 @@ default_imp_for_new_connector_integration_payouts_sync!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -2062,6 +2076,7 @@ default_imp_for_new_connector_integration_payouts_recipient_account!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -2189,6 +2204,7 @@ default_imp_for_new_connector_integration_webhook_source_verification!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -2318,6 +2334,7 @@ default_imp_for_new_connector_integration_frm_sale!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -2447,6 +2464,7 @@ default_imp_for_new_connector_integration_frm_checkout!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -2576,6 +2594,7 @@ default_imp_for_new_connector_integration_frm_transaction!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -2705,6 +2724,7 @@ default_imp_for_new_connector_integration_frm_fulfillment!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -2834,6 +2854,7 @@ default_imp_for_new_connector_integration_frm_record_return!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -2960,6 +2981,7 @@ default_imp_for_new_connector_integration_revoking_mandates!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -3074,6 +3096,7 @@ default_imp_for_new_connector_integration_frm!( connectors::Bluesnap, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Checkbook, connectors::Coinbase, connectors::Cryptopay, @@ -3200,6 +3223,7 @@ default_imp_for_new_connector_integration_connector_authentication!( connectors::Bluesnap, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Checkbook, connectors::Coinbase, connectors::Cryptopay, @@ -3315,6 +3339,7 @@ default_imp_for_new_connector_integration_revenue_recovery!( connectors::Bluesnap, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Checkbook, connectors::Coinbase, connectors::Cryptopay, @@ -3446,6 +3471,7 @@ default_imp_for_new_connector_integration_external_vault!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, diff --git a/crates/hyperswitch_domain_models/src/configs.rs b/crates/hyperswitch_domain_models/src/configs.rs index 16fbd3e1d31..89f8ddf673f 100644 --- a/crates/hyperswitch_domain_models/src/configs.rs +++ b/crates/hyperswitch_domain_models/src/configs.rs @@ -29,6 +29,7 @@ pub struct Connectors { pub boku: ConnectorParams, pub braintree: ConnectorParams, pub cashtocode: ConnectorParams, + pub celero: ConnectorParams, pub chargebee: ConnectorParams, pub checkbook: ConnectorParams, pub checkout: ConnectorParams, diff --git a/crates/router/src/connector.rs b/crates/router/src/connector.rs index 4b12c47118b..49aa7c61cd9 100644 --- a/crates/router/src/connector.rs +++ b/crates/router/src/connector.rs @@ -9,31 +9,32 @@ pub use hyperswitch_connectors::connectors::{ bamboraapac::Bamboraapac, bankofamerica, bankofamerica::Bankofamerica, barclaycard, barclaycard::Barclaycard, billwerk, billwerk::Billwerk, bitpay, bitpay::Bitpay, bluesnap, bluesnap::Bluesnap, boku, boku::Boku, braintree, braintree::Braintree, cashtocode, - cashtocode::Cashtocode, chargebee, chargebee::Chargebee, checkbook, checkbook::Checkbook, - checkout, checkout::Checkout, coinbase, coinbase::Coinbase, coingate, coingate::Coingate, - cryptopay, cryptopay::Cryptopay, ctp_mastercard, ctp_mastercard::CtpMastercard, cybersource, - cybersource::Cybersource, datatrans, datatrans::Datatrans, deutschebank, - deutschebank::Deutschebank, digitalvirgo, digitalvirgo::Digitalvirgo, dlocal, dlocal::Dlocal, - dwolla, dwolla::Dwolla, ebanx, ebanx::Ebanx, elavon, elavon::Elavon, facilitapay, - facilitapay::Facilitapay, fiserv, fiserv::Fiserv, fiservemea, fiservemea::Fiservemea, fiuu, - fiuu::Fiuu, forte, forte::Forte, getnet, getnet::Getnet, globalpay, globalpay::Globalpay, - globepay, globepay::Globepay, gocardless, gocardless::Gocardless, gpayments, - gpayments::Gpayments, helcim, helcim::Helcim, hipay, hipay::Hipay, hyperswitch_vault, - hyperswitch_vault::HyperswitchVault, iatapay, iatapay::Iatapay, inespay, inespay::Inespay, - itaubank, itaubank::Itaubank, jpmorgan, jpmorgan::Jpmorgan, juspaythreedsserver, - juspaythreedsserver::Juspaythreedsserver, klarna, klarna::Klarna, mifinity, mifinity::Mifinity, - mollie, mollie::Mollie, moneris, moneris::Moneris, multisafepay, multisafepay::Multisafepay, - netcetera, netcetera::Netcetera, nexinets, nexinets::Nexinets, nexixpay, nexixpay::Nexixpay, - nmi, nmi::Nmi, nomupay, nomupay::Nomupay, noon, noon::Noon, nordea, nordea::Nordea, novalnet, - novalnet::Novalnet, nuvei, nuvei::Nuvei, opayo, opayo::Opayo, opennode, opennode::Opennode, - paybox, paybox::Paybox, payeezy, payeezy::Payeezy, payload, payload::Payload, payme, - payme::Payme, payone, payone::Payone, paypal, paypal::Paypal, paystack, paystack::Paystack, - payu, payu::Payu, placetopay, placetopay::Placetopay, plaid, plaid::Plaid, powertranz, - powertranz::Powertranz, prophetpay, prophetpay::Prophetpay, rapyd, rapyd::Rapyd, razorpay, - razorpay::Razorpay, recurly, recurly::Recurly, redsys, redsys::Redsys, riskified, - riskified::Riskified, santander, santander::Santander, shift4, shift4::Shift4, signifyd, - signifyd::Signifyd, square, square::Square, stax, stax::Stax, stripe, stripe::Stripe, - stripebilling, stripebilling::Stripebilling, taxjar, taxjar::Taxjar, threedsecureio, + cashtocode::Cashtocode, celero, celero::Celero, chargebee, chargebee::Chargebee, checkbook, + checkbook::Checkbook, checkout, checkout::Checkout, coinbase, coinbase::Coinbase, coingate, + coingate::Coingate, cryptopay, cryptopay::Cryptopay, ctp_mastercard, + ctp_mastercard::CtpMastercard, cybersource, cybersource::Cybersource, datatrans, + datatrans::Datatrans, deutschebank, deutschebank::Deutschebank, digitalvirgo, + digitalvirgo::Digitalvirgo, dlocal, dlocal::Dlocal, dwolla, dwolla::Dwolla, ebanx, + ebanx::Ebanx, elavon, elavon::Elavon, facilitapay, facilitapay::Facilitapay, fiserv, + fiserv::Fiserv, fiservemea, fiservemea::Fiservemea, fiuu, fiuu::Fiuu, forte, forte::Forte, + getnet, getnet::Getnet, globalpay, globalpay::Globalpay, globepay, globepay::Globepay, + gocardless, gocardless::Gocardless, gpayments, gpayments::Gpayments, helcim, helcim::Helcim, + hipay, hipay::Hipay, hyperswitch_vault, hyperswitch_vault::HyperswitchVault, iatapay, + iatapay::Iatapay, inespay, inespay::Inespay, itaubank, itaubank::Itaubank, jpmorgan, + jpmorgan::Jpmorgan, juspaythreedsserver, juspaythreedsserver::Juspaythreedsserver, klarna, + klarna::Klarna, mifinity, mifinity::Mifinity, mollie, mollie::Mollie, moneris, + moneris::Moneris, multisafepay, multisafepay::Multisafepay, netcetera, netcetera::Netcetera, + nexinets, nexinets::Nexinets, nexixpay, nexixpay::Nexixpay, nmi, nmi::Nmi, nomupay, + nomupay::Nomupay, noon, noon::Noon, nordea, nordea::Nordea, novalnet, novalnet::Novalnet, + nuvei, nuvei::Nuvei, opayo, opayo::Opayo, opennode, opennode::Opennode, paybox, paybox::Paybox, + payeezy, payeezy::Payeezy, payload, payload::Payload, payme, payme::Payme, payone, + payone::Payone, paypal, paypal::Paypal, paystack, paystack::Paystack, payu, payu::Payu, + placetopay, placetopay::Placetopay, plaid, plaid::Plaid, powertranz, powertranz::Powertranz, + prophetpay, prophetpay::Prophetpay, rapyd, rapyd::Rapyd, razorpay, razorpay::Razorpay, recurly, + recurly::Recurly, redsys, redsys::Redsys, riskified, riskified::Riskified, santander, + santander::Santander, shift4, shift4::Shift4, signifyd, signifyd::Signifyd, square, + square::Square, stax, stax::Stax, stripe, stripe::Stripe, stripebilling, + stripebilling::Stripebilling, taxjar, taxjar::Taxjar, threedsecureio, threedsecureio::Threedsecureio, thunes, thunes::Thunes, tokenio, tokenio::Tokenio, trustpay, trustpay::Trustpay, tsys, tsys::Tsys, unified_authentication_service, unified_authentication_service::UnifiedAuthenticationService, vgs, vgs::Vgs, volt, volt::Volt, diff --git a/crates/router/src/core/connector_validation.rs b/crates/router/src/core/connector_validation.rs index d23a3a175f7..655636197d8 100644 --- a/crates/router/src/core/connector_validation.rs +++ b/crates/router/src/core/connector_validation.rs @@ -136,7 +136,10 @@ impl ConnectorAuthTypeAndMetadataValidation<'_> { } api_enums::Connector::Chargebee => { chargebee::transformers::ChargebeeAuthType::try_from(self.auth_type)?; - chargebee::transformers::ChargebeeMetadata::try_from(self.connector_meta_data)?; + Ok(()) + } + api_enums::Connector::Celero => { + celero::transformers::CeleroAuthType::try_from(self.auth_type)?; Ok(()) } // api_enums::Connector::Checkbook => { diff --git a/crates/router/src/types/api.rs b/crates/router/src/types/api.rs index 3fa8aebf2cf..45d6dd0d75e 100644 --- a/crates/router/src/types/api.rs +++ b/crates/router/src/types/api.rs @@ -372,6 +372,9 @@ impl ConnectorData { enums::Connector::Cashtocode => { Ok(ConnectorEnum::Old(Box::new(connector::Cashtocode::new()))) } + enums::Connector::Celero => { + Ok(ConnectorEnum::Old(Box::new(connector::Celero::new()))) + } enums::Connector::Chargebee => { Ok(ConnectorEnum::Old(Box::new(connector::Chargebee::new()))) } diff --git a/crates/router/src/types/transformers.rs b/crates/router/src/types/transformers.rs index 284a5243d05..713293568b3 100644 --- a/crates/router/src/types/transformers.rs +++ b/crates/router/src/types/transformers.rs @@ -223,6 +223,7 @@ impl ForeignTryFrom<api_enums::Connector> for common_enums::RoutableConnectors { api_enums::Connector::Boku => Self::Boku, api_enums::Connector::Braintree => Self::Braintree, api_enums::Connector::Cashtocode => Self::Cashtocode, + api_enums::Connector::Celero => Self::Celero, api_enums::Connector::Chargebee => Self::Chargebee, // api_enums::Connector::Checkbook => Self::Checkbook, api_enums::Connector::Checkout => Self::Checkout, diff --git a/crates/router/tests/connectors/celero.rs b/crates/router/tests/connectors/celero.rs new file mode 100644 index 00000000000..7d4e942471b --- /dev/null +++ b/crates/router/tests/connectors/celero.rs @@ -0,0 +1,420 @@ +use masking::Secret; +use router::types::{self, api, domain, storage::enums}; +use test_utils::connector_auth; + +use crate::utils::{self, ConnectorActions}; + +#[derive(Clone, Copy)] +struct CeleroTest; +impl ConnectorActions for CeleroTest {} +impl utils::Connector for CeleroTest { + fn get_data(&self) -> api::ConnectorData { + use router::connector::Celero; + utils::construct_connector_data_old( + Box::new(Celero::new()), + types::Connector::Celero, + api::GetToken::Connector, + None, + ) + } + + fn get_auth_token(&self) -> types::ConnectorAuthType { + utils::to_connector_auth_type( + connector_auth::ConnectorAuthentication::new() + .celero + .expect("Missing connector authentication configuration") + .into(), + ) + } + + fn get_name(&self) -> String { + "celero".to_string() + } +} + +static CONNECTOR: CeleroTest = CeleroTest {}; + +fn get_default_payment_info() -> Option<utils::PaymentInfo> { + None +} + +fn payment_method_details() -> Option<types::PaymentsAuthorizeData> { + None +} + +// Cards Positive Tests +// Creates a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_only_authorize_payment() { + let response = CONNECTOR + .authorize_payment(payment_method_details(), get_default_payment_info()) + .await + .expect("Authorize payment response"); + assert_eq!(response.status, enums::AttemptStatus::Authorized); +} + +// Captures a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_capture_authorized_payment() { + let response = CONNECTOR + .authorize_and_capture_payment(payment_method_details(), None, get_default_payment_info()) + .await + .expect("Capture payment response"); + assert_eq!(response.status, enums::AttemptStatus::Charged); +} + +// Partially captures a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_capture_authorized_payment() { + let response = CONNECTOR + .authorize_and_capture_payment( + payment_method_details(), + Some(types::PaymentsCaptureData { + amount_to_capture: 50, + ..utils::PaymentCaptureType::default().0 + }), + get_default_payment_info(), + ) + .await + .expect("Capture payment response"); + assert_eq!(response.status, enums::AttemptStatus::Charged); +} + +// Synchronizes a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_authorized_payment() { + let authorize_response = CONNECTOR + .authorize_payment(payment_method_details(), get_default_payment_info()) + .await + .expect("Authorize payment response"); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + let response = CONNECTOR + .psync_retry_till_status_matches( + enums::AttemptStatus::Authorized, + Some(types::PaymentsSyncData { + connector_transaction_id: types::ResponseId::ConnectorTransactionId( + txn_id.unwrap(), + ), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .expect("PSync response"); + assert_eq!(response.status, enums::AttemptStatus::Authorized,); +} + +// Voids a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_void_authorized_payment() { + let response = CONNECTOR + .authorize_and_void_payment( + payment_method_details(), + Some(types::PaymentsCancelData { + connector_transaction_id: String::from(""), + cancellation_reason: Some("requested_by_customer".to_string()), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .expect("Void payment response"); + assert_eq!(response.status, enums::AttemptStatus::Voided); +} + +// Refunds a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_manually_captured_payment() { + let response = CONNECTOR + .capture_payment_and_refund( + payment_method_details(), + None, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Partially refunds a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_refund_manually_captured_payment() { + let response = CONNECTOR + .capture_payment_and_refund( + payment_method_details(), + None, + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Synchronizes a refund using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_manually_captured_refund() { + let refund_response = CONNECTOR + .capture_payment_and_refund( + payment_method_details(), + None, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + let response = CONNECTOR + .rsync_retry_till_status_matches( + enums::RefundStatus::Success, + refund_response.response.unwrap().connector_refund_id, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Creates a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_make_payment() { + let authorize_response = CONNECTOR + .make_payment(payment_method_details(), get_default_payment_info()) + .await + .unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); +} + +// Synchronizes a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_auto_captured_payment() { + let authorize_response = CONNECTOR + .make_payment(payment_method_details(), get_default_payment_info()) + .await + .unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + assert_ne!(txn_id, None, "Empty connector transaction id"); + let response = CONNECTOR + .psync_retry_till_status_matches( + enums::AttemptStatus::Charged, + Some(types::PaymentsSyncData { + connector_transaction_id: types::ResponseId::ConnectorTransactionId( + txn_id.unwrap(), + ), + capture_method: Some(enums::CaptureMethod::Automatic), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!(response.status, enums::AttemptStatus::Charged,); +} + +// Refunds a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_auto_captured_payment() { + let response = CONNECTOR + .make_payment_and_refund(payment_method_details(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Partially refunds a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_refund_succeeded_payment() { + let refund_response = CONNECTOR + .make_payment_and_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + refund_response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Creates multiple refunds against a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_succeeded_payment_multiple_times() { + CONNECTOR + .make_payment_and_multiple_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await; +} + +// Synchronizes a refund using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_refund() { + let refund_response = CONNECTOR + .make_payment_and_refund(payment_method_details(), None, get_default_payment_info()) + .await + .unwrap(); + let response = CONNECTOR + .rsync_retry_till_status_matches( + enums::RefundStatus::Success, + refund_response.response.unwrap().connector_refund_id, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Cards Negative scenarios +// Creates a payment with incorrect CVC. +#[actix_web::test] +async fn should_fail_payment_for_incorrect_cvc() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: domain::PaymentMethodData::Card(domain::Card { + card_cvc: Secret::new("12345".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's security code is invalid.".to_string(), + ); +} + +// Creates a payment with incorrect expiry month. +#[actix_web::test] +async fn should_fail_payment_for_invalid_exp_month() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: domain::PaymentMethodData::Card(domain::Card { + card_exp_month: Secret::new("20".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's expiration month is invalid.".to_string(), + ); +} + +// Creates a payment with incorrect expiry year. +#[actix_web::test] +async fn should_fail_payment_for_incorrect_expiry_year() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: domain::PaymentMethodData::Card(domain::Card { + card_exp_year: Secret::new("2000".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's expiration year is invalid.".to_string(), + ); +} + +// Voids a payment using automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_fail_void_payment_for_auto_capture() { + let authorize_response = CONNECTOR + .make_payment(payment_method_details(), get_default_payment_info()) + .await + .unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + assert_ne!(txn_id, None, "Empty connector transaction id"); + let void_response = CONNECTOR + .void_payment(txn_id.unwrap(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + void_response.response.unwrap_err().message, + "You cannot cancel this PaymentIntent because it has a status of succeeded." + ); +} + +// Captures a payment using invalid connector payment id. +#[actix_web::test] +async fn should_fail_capture_for_invalid_payment() { + let capture_response = CONNECTOR + .capture_payment("123456789".to_string(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + capture_response.response.unwrap_err().message, + String::from("No such payment_intent: '123456789'") + ); +} + +// Refunds a payment with refund amount higher than payment amount. +#[actix_web::test] +async fn should_fail_for_refund_amount_higher_than_payment_amount() { + let response = CONNECTOR + .make_payment_and_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 150, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Refund amount (₹1.50) is greater than charge amount (₹1.00)", + ); +} + +// Connector dependent test cases goes here + +// [#478]: add unit tests for non 3DS, wallets & webhooks in connector tests diff --git a/crates/router/tests/connectors/main.rs b/crates/router/tests/connectors/main.rs index 90af2bd8d80..10707ba2f4e 100644 --- a/crates/router/tests/connectors/main.rs +++ b/crates/router/tests/connectors/main.rs @@ -23,6 +23,7 @@ mod bitpay; mod bluesnap; mod boku; mod cashtocode; +mod celero; mod chargebee; mod checkbook; mod checkout; diff --git a/crates/test_utils/src/connector_auth.rs b/crates/test_utils/src/connector_auth.rs index fd0f9180910..31141205523 100644 --- a/crates/test_utils/src/connector_auth.rs +++ b/crates/test_utils/src/connector_auth.rs @@ -29,6 +29,7 @@ pub struct ConnectorAuthentication { pub bluesnap: Option<BodyKey>, pub boku: Option<BodyKey>, pub cashtocode: Option<BodyKey>, + pub celero: Option<HeaderKey>, pub chargebee: Option<HeaderKey>, pub checkbook: Option<BodyKey>, pub checkout: Option<SignatureKey>, diff --git a/loadtest/config/development.toml b/loadtest/config/development.toml index 28e3e724c3a..d2c62a57796 100644 --- a/loadtest/config/development.toml +++ b/loadtest/config/development.toml @@ -95,6 +95,7 @@ bluesnap.secondary_base_url = "https://sandpay.bluesnap.com/" boku.base_url = "https://country-api4-stage.boku.com" braintree.base_url = "https://payments.sandbox.braintree-api.com/graphql" cashtocode.base_url = "https://cluster05.api-test.cashtocode.com" +celero.base_url = "https://sandbox.gotnpgateway.com" chargebee.base_url = "https://$.chargebee.com/api/" checkbook.base_url = "https://api.sandbox.checkbook.io" checkout.base_url = "https://api.sandbox.checkout.com/" @@ -225,6 +226,7 @@ cards = [ "bluesnap", "boku", "braintree", + "celero", "checkbook", "checkout", "coinbase", @@ -332,36 +334,36 @@ przelewy24 = { country = "PL", currency = "PLN,EUR" } mifinity = { country = "BR,CN,SG,MY,DE,CH,DK,GB,ES,AD,GI,FI,FR,GR,HR,IT,JP,MX,AR,CO,CL,PE,VE,UY,PY,BO,EC,GT,HN,SV,NI,CR,PA,DO,CU,PR,NL,NO,PL,PT,SE,RU,TR,TW,HK,MO,AX,AL,DZ,AS,AO,AI,AG,AM,AW,AU,AT,AZ,BS,BH,BD,BB,BE,BZ,BJ,BM,BT,BQ,BA,BW,IO,BN,BG,BF,BI,KH,CM,CA,CV,KY,CF,TD,CX,CC,KM,CG,CK,CI,CW,CY,CZ,DJ,DM,EG,GQ,ER,EE,ET,FK,FO,FJ,GF,PF,TF,GA,GM,GE,GH,GL,GD,GP,GU,GG,GN,GW,GY,HT,HM,VA,IS,IN,ID,IE,IM,IL,JE,JO,KZ,KE,KI,KW,KG,LA,LV,LB,LS,LI,LT,LU,MK,MG,MW,MV,ML,MT,MH,MQ,MR,MU,YT,FM,MD,MC,MN,ME,MS,MA,MZ,NA,NR,NP,NC,NZ,NE,NG,NU,NF,MP,OM,PK,PW,PS,PG,PH,PN,QA,RE,RO,RW,BL,SH,KN,LC,MF,PM,VC,WS,SM,ST,SA,SN,RS,SC,SL,SX,SK,SI,SB,SO,ZA,GS,KR,LK,SR,SJ,SZ,TH,TL,TG,TK,TO,TT,TN,TM,TC,TV,UG,UA,AE,UZ,VU,VN,VG,VI,WF,EH,ZM", currency = "AUD,CAD,CHF,CNY,CZK,DKK,EUR,GBP,INR,JPY,NOK,NZD,PLN,RUB,SEK,ZAR,USD,EGP,UYU,UZS" } [pm_filters.globepay] -ali_pay = { country = "GB",currency = "GBP,CNY" } -we_chat_pay = { country = "GB",currency = "GBP,CNY" } +ali_pay = { country = "GB", currency = "GBP,CNY" } +we_chat_pay = { country = "GB", currency = "GBP,CNY" } [pm_filters.itaubank] pix = { country = "BR", currency = "BRL" } [pm_filters.nexinets] -credit = { country = "DE",currency = "EUR" } -debit = { country = "DE",currency = "EUR" } -ideal = { country = "DE",currency = "EUR" } -giropay = { country = "DE",currency = "EUR" } -sofort = { country = "DE",currency = "EUR" } -eps = { country = "DE",currency = "EUR" } -apple_pay = { country = "DE",currency = "EUR" } -paypal = { country = "DE",currency = "EUR" } +credit = { country = "DE", currency = "EUR" } +debit = { country = "DE", currency = "EUR" } +ideal = { country = "DE", currency = "EUR" } +giropay = { country = "DE", currency = "EUR" } +sofort = { country = "DE", currency = "EUR" } +eps = { country = "DE", currency = "EUR" } +apple_pay = { country = "DE", currency = "EUR" } +paypal = { country = "DE", currency = "EUR" } [pm_filters.nuvei] -credit = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US",currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } -debit = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US",currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } -klarna = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US",currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } -afterpay_clearpay = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US",currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } -ideal = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US",currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } -giropay = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US",currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } -sofort = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US",currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } -eps = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US",currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } -apple_pay = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US",currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } -google_pay = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US",currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } -paypal = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US",currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } +credit = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US", currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } +debit = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US", currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } +klarna = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US", currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } +afterpay_clearpay = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US", currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } +ideal = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US", currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } +giropay = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US", currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } +sofort = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US", currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } +eps = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US", currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } +apple_pay = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US", currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } +google_pay = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US", currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } +paypal = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US", currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } [pm_filters.prophetpay] card_redirect = { country = "US", currency = "USD" } @@ -495,16 +497,16 @@ crypto_currency = { country = "US, CA, GB, AU, BR, MX, SG, PH, NZ, ZA, JP, AT, B klarna = { country = "AU,AT,BE,CA,CZ,DK,FI,FR,DE,GR,IE,IT,NL,NZ,NO,PL,PT,ES,SE,CH,GB,US", currency = "CHF,DKK,EUR,GBP,NOK,PLN,SEK,USD,AUD,NZD,CAD" } [pm_filters.bluesnap] -credit = { country = "AD,AE,AG,AL,AM,AO,AR,AT,AU,AZ,BA,BB,BD,BE,BG,BH,BI,BJ,BN,BO,BR,BS,BT,BW,BY,BZ,CA,CD,CF,CG,CH,CI,CL,CM,CN,CO,CR,CV,CY,CZ,DE,DK,DJ,DM,DO,DZ,EC,EE,EG,ER,ES,ET,FI,FJ,FM,FR,GA,GB,GD,GE,GG,GH,GM,GN,GQ,GR,GT,GW,GY,HN,HR,HT,HU,ID,IE,IL,IN,IS,IT,JM,JP,JO,KE,KG,KH,KI,KM,KN,KR,KW,KZ,LA,LB,LC,LI,LK,LR,LS,LT,LU,LV,MA,MC,MD,ME,MG,MH,MK,ML,MM,MN,MR,MT,MU,MV,MW,MX,MY,MZ,NA,NE,NG,NI,NL,NO,NP,NR,NZ,OM,PA,PE,PG,PH,PK,PL,PS,PT,PW,PY,QA,RO,RS,RW,SA,SB,SC,SE,SG,SI,SK,SL,SM,SN,SO,SR,SS,ST,SV,SZ,TD,TG,TH,TJ,TL,TM,TN,TO,TR,TT,TV,TZ,UA,UG,US,UY,UZ,VA,VC,VE,VN,VU,WS,ZA,ZM,ZW", currency = "AED,AFN,ALL,AMD,ANG,ARS,AUD,AWG,BAM,BBD,BGN,BHD,BMD,BND,BOB,BRL,BSD,BWP,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,FJD,GBP,GEL,GIP,GTQ,HKD,HUF,IDR,ILS,INR,ISK,JMD,JPY,KES,KHR,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MUR,MWK,MXN,MYR,NAD,NGN,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PLN,PKR,QAR,RON,RSD,RUB,SAR,SCR,SDG,SEK,SGD,THB,TND,TRY,TTD,TWD,TZS,UAH,USD,UYU,UZS,VND,XAF,XCD,XOF,ZAR"} -google_pay = { country = "AD,AE,AG,AL,AM,AO,AR,AT,AU,AZ,BA,BB,BD,BE,BG,BH,BI,BJ,BN,BO,BR,BS,BT,BW,BY,BZ,CA,CD,CF,CG,CH,CI,CL,CM,CN,CO,CR,CV,CY,CZ,DE,DK,DJ,DM,DO,DZ,EC,EE,EG,ER,ES,ET,FI,FJ,FM,FR,GA,GB,GD,GE,GG,GH,GM,GN,GQ,GR,GT,GW,GY,HN,HR,HT,HU,ID,IE,IL,IN,IS,IT,JM,JP,JO,KE,KG,KH,KI,KM,KN,KR,KW,KZ,LA,LB,LC,LI,LK,LR,LS,LT,LU,LV,MA,MC,MD,ME,MG,MH,MK,ML,MM,MN,MR,MT,MU,MV,MW,MX,MY,MZ,NA,NE,NG,NI,NL,NO,NP,NR,NZ,OM,PA,PE,PG,PH,PK,PL,PS,PT,PW,PY,QA,RO,RS,RW,SA,SB,SC,SE,SG,SI,SK,SL,SM,SN,SO,SR,SS,ST,SV,SZ,TD,TG,TH,TJ,TL,TM,TN,TO,TR,TT,TV,TZ,UA,UG,US,UY,UZ,VA,VC,VE,VN,VU,WS,ZA,ZM,ZW", currency = "AED,AFN,ALL,AMD,ANG,ARS,AUD,AWG,BAM,BBD,BGN,BHD,BMD,BND,BOB,BRL,BSD,BWP,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,FJD,GBP,GEL,GIP,GTQ,HKD,HUF,IDR,ILS,INR,ISK,JMD,JPY,KES,KHR,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MUR,MWK,MXN,MYR,NAD,NGN,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PLN,PKR,QAR,RON,RSD,RUB,SAR,SCR,SDG,SEK,SGD,THB,TND,TRY,TTD,TWD,TZS,UAH,USD,UYU,UZS,VND,XAF,XCD,XOF,ZAR"} -apple_pay = { country = "AD,AE,AG,AL,AM,AO,AR,AT,AU,AZ,BA,BB,BD,BE,BG,BH,BI,BJ,BN,BO,BR,BS,BT,BW,BY,BZ,CA,CD,CF,CG,CH,CI,CL,CM,CN,CO,CR,CV,CY,CZ,DE,DK,DJ,DM,DO,DZ,EC,EE,EG,ER,ES,ET,FI,FJ,FM,FR,GA,GB,GD,GE,GG,GH,GM,GN,GQ,GR,GT,GW,GY,HN,HR,HT,HU,ID,IE,IL,IN,IS,IT,JM,JP,JO,KE,KG,KH,KI,KM,KN,KR,KW,KZ,LA,LB,LC,LI,LK,LR,LS,LT,LU,LV,MA,MC,MD,ME,MG,MH,MK,ML,MM,MN,MR,MT,MU,MV,MW,MX,MY,MZ,NA,NE,NG,NI,NL,NO,NP,NR,NZ,OM,PA,PE,PG,PH,PK,PL,PS,PT,PW,PY,QA,RO,RS,RW,SA,SB,SC,SE,SG,SI,SK,SL,SM,SN,SO,SR,SS,ST,SV,SZ,TD,TG,TH,TJ,TL,TM,TN,TO,TR,TT,TV,TZ,UA,UG,US,UY,UZ,VA,VC,VE,VN,VU,WS,ZA,ZM,ZW", currency = "AED,AFN,ALL,AMD,ANG,ARS,AUD,AWG,BAM,BBD,BGN,BHD,BMD,BND,BOB,BRL,BSD,BWP,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,FJD,GBP,GEL,GIP,GTQ,HKD,HUF,IDR,ILS,INR,ISK,JMD,JPY,KES,KHR,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MUR,MWK,MXN,MYR,NAD,NGN,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PLN,PKR,QAR,RON,RSD,RUB,SAR,SCR,SDG,SEK,SGD,THB,TND,TRY,TTD,TWD,TZS,UAH,USD,UYU,UZS,VND,XAF,XCD,XOF,ZAR"} +credit = { country = "AD,AE,AG,AL,AM,AO,AR,AT,AU,AZ,BA,BB,BD,BE,BG,BH,BI,BJ,BN,BO,BR,BS,BT,BW,BY,BZ,CA,CD,CF,CG,CH,CI,CL,CM,CN,CO,CR,CV,CY,CZ,DE,DK,DJ,DM,DO,DZ,EC,EE,EG,ER,ES,ET,FI,FJ,FM,FR,GA,GB,GD,GE,GG,GH,GM,GN,GQ,GR,GT,GW,GY,HN,HR,HT,HU,ID,IE,IL,IN,IS,IT,JM,JP,JO,KE,KG,KH,KI,KM,KN,KR,KW,KZ,LA,LB,LC,LI,LK,LR,LS,LT,LU,LV,MA,MC,MD,ME,MG,MH,MK,ML,MM,MN,MR,MT,MU,MV,MW,MX,MY,MZ,NA,NE,NG,NI,NL,NO,NP,NR,NZ,OM,PA,PE,PG,PH,PK,PL,PS,PT,PW,PY,QA,RO,RS,RW,SA,SB,SC,SE,SG,SI,SK,SL,SM,SN,SO,SR,SS,ST,SV,SZ,TD,TG,TH,TJ,TL,TM,TN,TO,TR,TT,TV,TZ,UA,UG,US,UY,UZ,VA,VC,VE,VN,VU,WS,ZA,ZM,ZW", currency = "AED,AFN,ALL,AMD,ANG,ARS,AUD,AWG,BAM,BBD,BGN,BHD,BMD,BND,BOB,BRL,BSD,BWP,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,FJD,GBP,GEL,GIP,GTQ,HKD,HUF,IDR,ILS,INR,ISK,JMD,JPY,KES,KHR,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MUR,MWK,MXN,MYR,NAD,NGN,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PLN,PKR,QAR,RON,RSD,RUB,SAR,SCR,SDG,SEK,SGD,THB,TND,TRY,TTD,TWD,TZS,UAH,USD,UYU,UZS,VND,XAF,XCD,XOF,ZAR" } +google_pay = { country = "AD,AE,AG,AL,AM,AO,AR,AT,AU,AZ,BA,BB,BD,BE,BG,BH,BI,BJ,BN,BO,BR,BS,BT,BW,BY,BZ,CA,CD,CF,CG,CH,CI,CL,CM,CN,CO,CR,CV,CY,CZ,DE,DK,DJ,DM,DO,DZ,EC,EE,EG,ER,ES,ET,FI,FJ,FM,FR,GA,GB,GD,GE,GG,GH,GM,GN,GQ,GR,GT,GW,GY,HN,HR,HT,HU,ID,IE,IL,IN,IS,IT,JM,JP,JO,KE,KG,KH,KI,KM,KN,KR,KW,KZ,LA,LB,LC,LI,LK,LR,LS,LT,LU,LV,MA,MC,MD,ME,MG,MH,MK,ML,MM,MN,MR,MT,MU,MV,MW,MX,MY,MZ,NA,NE,NG,NI,NL,NO,NP,NR,NZ,OM,PA,PE,PG,PH,PK,PL,PS,PT,PW,PY,QA,RO,RS,RW,SA,SB,SC,SE,SG,SI,SK,SL,SM,SN,SO,SR,SS,ST,SV,SZ,TD,TG,TH,TJ,TL,TM,TN,TO,TR,TT,TV,TZ,UA,UG,US,UY,UZ,VA,VC,VE,VN,VU,WS,ZA,ZM,ZW", currency = "AED,AFN,ALL,AMD,ANG,ARS,AUD,AWG,BAM,BBD,BGN,BHD,BMD,BND,BOB,BRL,BSD,BWP,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,FJD,GBP,GEL,GIP,GTQ,HKD,HUF,IDR,ILS,INR,ISK,JMD,JPY,KES,KHR,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MUR,MWK,MXN,MYR,NAD,NGN,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PLN,PKR,QAR,RON,RSD,RUB,SAR,SCR,SDG,SEK,SGD,THB,TND,TRY,TTD,TWD,TZS,UAH,USD,UYU,UZS,VND,XAF,XCD,XOF,ZAR" } +apple_pay = { country = "AD,AE,AG,AL,AM,AO,AR,AT,AU,AZ,BA,BB,BD,BE,BG,BH,BI,BJ,BN,BO,BR,BS,BT,BW,BY,BZ,CA,CD,CF,CG,CH,CI,CL,CM,CN,CO,CR,CV,CY,CZ,DE,DK,DJ,DM,DO,DZ,EC,EE,EG,ER,ES,ET,FI,FJ,FM,FR,GA,GB,GD,GE,GG,GH,GM,GN,GQ,GR,GT,GW,GY,HN,HR,HT,HU,ID,IE,IL,IN,IS,IT,JM,JP,JO,KE,KG,KH,KI,KM,KN,KR,KW,KZ,LA,LB,LC,LI,LK,LR,LS,LT,LU,LV,MA,MC,MD,ME,MG,MH,MK,ML,MM,MN,MR,MT,MU,MV,MW,MX,MY,MZ,NA,NE,NG,NI,NL,NO,NP,NR,NZ,OM,PA,PE,PG,PH,PK,PL,PS,PT,PW,PY,QA,RO,RS,RW,SA,SB,SC,SE,SG,SI,SK,SL,SM,SN,SO,SR,SS,ST,SV,SZ,TD,TG,TH,TJ,TL,TM,TN,TO,TR,TT,TV,TZ,UA,UG,US,UY,UZ,VA,VC,VE,VN,VU,WS,ZA,ZM,ZW", currency = "AED,AFN,ALL,AMD,ANG,ARS,AUD,AWG,BAM,BBD,BGN,BHD,BMD,BND,BOB,BRL,BSD,BWP,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,FJD,GBP,GEL,GIP,GTQ,HKD,HUF,IDR,ILS,INR,ISK,JMD,JPY,KES,KHR,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MUR,MWK,MXN,MYR,NAD,NGN,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PLN,PKR,QAR,RON,RSD,RUB,SAR,SCR,SDG,SEK,SGD,THB,TND,TRY,TTD,TWD,TZS,UAH,USD,UYU,UZS,VND,XAF,XCD,XOF,ZAR" } [pm_filters.inespay] -sepa = { country = "ES", currency = "EUR"} +sepa = { country = "ES", currency = "EUR" } [pm_filters.fiserv] -credit = {country = "AU,NZ,CN,HK,IN,LK,KR,MY,SG,GB,BE,FR,DE,IT,ME,NL,PL,ES,ZA,AR,BR,CO,MX,PA,UY,US,CA", currency = "AFN,ALL,DZD,AOA,ARS,AMD,AWG,AUD,AZN,BSD,BHD,BDT,BBD,BYN,BZD,BMD,BTN,BOB,VES,BAM,BWP,BRL,BND,BGN,BIF,KHR,CAD,CVE,KYD,XAF,CLP,CNY,COP,KMF,CDF,CRC,HRK,CUP,CZK,DKK,DJF,DOP,XCD,EGP,ERN,ETB,EUR,FKP,FJD,XPF,GMD,GEL,GHS,GIP,GTQ,GNF,GYD,HTG,HNL,HKD,HUF,ISK,INR,IDR,IRR,IQD,ILS,JMD,JPY,JOD,KZT,KES,KGS,KWD,LAK,LBP,LSL,LRD,LYD,MOP,MKD,MGA,MWK,MYR,MVR,MRU,MUR,MXN,MDL,MNT,MAD,MZN,MMK,NAD,NPR,ANG,NZD,NIO,NGN,VUV,KPW,NOK,OMR,PKR,PAB,PGK,PYG,PEN,PHP,PLN,GBP,QAR,RON,RUB,RWF,SHP,SVC,WST,STN,SAR,RSD,SCR,SLL,SGD,SBD,SOS,ZAR,KRW,SSP,LKR,SDG,SRD,SZL,SEK,CHF,SYP,TWD,TJS,TZS,THB,TOP,TTD,TND,TRY,TMT,UGX,UAH,AED,USD,UYU,UZS,VND,XOF,YER,ZMW,ZWL"} -debit = {country = "AU,NZ,CN,HK,IN,LK,KR,MY,SG,GB,BE,FR,DE,IT,ME,NL,PL,ES,ZA,AR,BR,CO,MX,PA,UY,US,CA", currency = "AFN,ALL,DZD,AOA,ARS,AMD,AWG,AUD,AZN,BSD,BHD,BDT,BBD,BYN,BZD,BMD,BTN,BOB,VES,BAM,BWP,BRL,BND,BGN,BIF,KHR,CAD,CVE,KYD,XAF,CLP,CNY,COP,KMF,CDF,CRC,HRK,CUP,CZK,DKK,DJF,DOP,XCD,EGP,ERN,ETB,EUR,FKP,FJD,XPF,GMD,GEL,GHS,GIP,GTQ,GNF,GYD,HTG,HNL,HKD,HUF,ISK,INR,IDR,IRR,IQD,ILS,JMD,JPY,JOD,KZT,KES,KGS,KWD,LAK,LBP,LSL,LRD,LYD,MOP,MKD,MGA,MWK,MYR,MVR,MRU,MUR,MXN,MDL,MNT,MAD,MZN,MMK,NAD,NPR,ANG,NZD,NIO,NGN,VUV,KPW,NOK,OMR,PKR,PAB,PGK,PYG,PEN,PHP,PLN,GBP,QAR,RON,RUB,RWF,SHP,SVC,WST,STN,SAR,RSD,SCR,SLL,SGD,SBD,SOS,ZAR,KRW,SSP,LKR,SDG,SRD,SZL,SEK,CHF,SYP,TWD,TJS,TZS,THB,TOP,TTD,TND,TRY,TMT,UGX,UAH,AED,USD,UYU,UZS,VND,XOF,YER,ZMW,ZWL"} +credit = { country = "AU,NZ,CN,HK,IN,LK,KR,MY,SG,GB,BE,FR,DE,IT,ME,NL,PL,ES,ZA,AR,BR,CO,MX,PA,UY,US,CA", currency = "AFN,ALL,DZD,AOA,ARS,AMD,AWG,AUD,AZN,BSD,BHD,BDT,BBD,BYN,BZD,BMD,BTN,BOB,VES,BAM,BWP,BRL,BND,BGN,BIF,KHR,CAD,CVE,KYD,XAF,CLP,CNY,COP,KMF,CDF,CRC,HRK,CUP,CZK,DKK,DJF,DOP,XCD,EGP,ERN,ETB,EUR,FKP,FJD,XPF,GMD,GEL,GHS,GIP,GTQ,GNF,GYD,HTG,HNL,HKD,HUF,ISK,INR,IDR,IRR,IQD,ILS,JMD,JPY,JOD,KZT,KES,KGS,KWD,LAK,LBP,LSL,LRD,LYD,MOP,MKD,MGA,MWK,MYR,MVR,MRU,MUR,MXN,MDL,MNT,MAD,MZN,MMK,NAD,NPR,ANG,NZD,NIO,NGN,VUV,KPW,NOK,OMR,PKR,PAB,PGK,PYG,PEN,PHP,PLN,GBP,QAR,RON,RUB,RWF,SHP,SVC,WST,STN,SAR,RSD,SCR,SLL,SGD,SBD,SOS,ZAR,KRW,SSP,LKR,SDG,SRD,SZL,SEK,CHF,SYP,TWD,TJS,TZS,THB,TOP,TTD,TND,TRY,TMT,UGX,UAH,AED,USD,UYU,UZS,VND,XOF,YER,ZMW,ZWL" } +debit = { country = "AU,NZ,CN,HK,IN,LK,KR,MY,SG,GB,BE,FR,DE,IT,ME,NL,PL,ES,ZA,AR,BR,CO,MX,PA,UY,US,CA", currency = "AFN,ALL,DZD,AOA,ARS,AMD,AWG,AUD,AZN,BSD,BHD,BDT,BBD,BYN,BZD,BMD,BTN,BOB,VES,BAM,BWP,BRL,BND,BGN,BIF,KHR,CAD,CVE,KYD,XAF,CLP,CNY,COP,KMF,CDF,CRC,HRK,CUP,CZK,DKK,DJF,DOP,XCD,EGP,ERN,ETB,EUR,FKP,FJD,XPF,GMD,GEL,GHS,GIP,GTQ,GNF,GYD,HTG,HNL,HKD,HUF,ISK,INR,IDR,IRR,IQD,ILS,JMD,JPY,JOD,KZT,KES,KGS,KWD,LAK,LBP,LSL,LRD,LYD,MOP,MKD,MGA,MWK,MYR,MVR,MRU,MUR,MXN,MDL,MNT,MAD,MZN,MMK,NAD,NPR,ANG,NZD,NIO,NGN,VUV,KPW,NOK,OMR,PKR,PAB,PGK,PYG,PEN,PHP,PLN,GBP,QAR,RON,RUB,RWF,SHP,SVC,WST,STN,SAR,RSD,SCR,SLL,SGD,SBD,SOS,ZAR,KRW,SSP,LKR,SDG,SRD,SZL,SEK,CHF,SYP,TWD,TJS,TZS,THB,TOP,TTD,TND,TRY,TMT,UGX,UAH,AED,USD,UYU,UZS,VND,XOF,YER,ZMW,ZWL" } [pm_filters.stax] credit = { country = "US", currency = "USD" } @@ -512,8 +514,8 @@ debit = { country = "US", currency = "USD" } ach = { country = "US", currency = "USD" } [pm_filters.braintree] -credit = { country = "AD,AT,AU,BE,BG,CA,CH,CY,CZ,DE,DK,EE,ES,FI,FR,GB,GG,GI,GR,HK,HR,HU,IE,IM,IT,JE,LI,LT,LU,LV,MT,MC,MY,NL,NO,NZ,PL,PT,RO,SE,SG,SI,SK,SM,US", currency = "AED,AMD,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BIF,BMD,BND,BOB,BRL,BSD,BWP,BYN,BZD,CAD,CHF,CLP,CNY,COP,CRC,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,ISK,JMD,JPY,KES,KGS,KHR,KMF,KRW,KYD,KZT,LAK,LBP,LKR,LRD,LSL,MAD,MDL,MKD,MNT,MOP,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SEK,SGD,SHP,SLL,SOS,SRD,STD,SVC,SYP,SZL,THB,TJS,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VES,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL"} -debit = { country = "AD,AT,AU,BE,BG,CA,CH,CY,CZ,DE,DK,EE,ES,FI,FR,GB,GG,GI,GR,HK,HR,HU,IE,IM,IT,JE,LI,LT,LU,LV,MT,MC,MY,NL,NO,NZ,PL,PT,RO,SE,SG,SI,SK,SM,US", currency = "AED,AMD,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BIF,BMD,BND,BOB,BRL,BSD,BWP,BYN,BZD,CAD,CHF,CLP,CNY,COP,CRC,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,ISK,JMD,JPY,KES,KGS,KHR,KMF,KRW,KYD,KZT,LAK,LBP,LKR,LRD,LSL,MAD,MDL,MKD,MNT,MOP,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SEK,SGD,SHP,SLL,SOS,SRD,STD,SVC,SYP,SZL,THB,TJS,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VES,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL"} +credit = { country = "AD,AT,AU,BE,BG,CA,CH,CY,CZ,DE,DK,EE,ES,FI,FR,GB,GG,GI,GR,HK,HR,HU,IE,IM,IT,JE,LI,LT,LU,LV,MT,MC,MY,NL,NO,NZ,PL,PT,RO,SE,SG,SI,SK,SM,US", currency = "AED,AMD,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BIF,BMD,BND,BOB,BRL,BSD,BWP,BYN,BZD,CAD,CHF,CLP,CNY,COP,CRC,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,ISK,JMD,JPY,KES,KGS,KHR,KMF,KRW,KYD,KZT,LAK,LBP,LKR,LRD,LSL,MAD,MDL,MKD,MNT,MOP,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SEK,SGD,SHP,SLL,SOS,SRD,STD,SVC,SYP,SZL,THB,TJS,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VES,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL" } +debit = { country = "AD,AT,AU,BE,BG,CA,CH,CY,CZ,DE,DK,EE,ES,FI,FR,GB,GG,GI,GR,HK,HR,HU,IE,IM,IT,JE,LI,LT,LU,LV,MT,MC,MY,NL,NO,NZ,PL,PT,RO,SE,SG,SI,SK,SM,US", currency = "AED,AMD,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BIF,BMD,BND,BOB,BRL,BSD,BWP,BYN,BZD,CAD,CHF,CLP,CNY,COP,CRC,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,ISK,JMD,JPY,KES,KGS,KHR,KMF,KRW,KYD,KZT,LAK,LBP,LKR,LRD,LSL,MAD,MDL,MKD,MNT,MOP,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SEK,SGD,SHP,SLL,SOS,SRD,STD,SVC,SYP,SZL,THB,TJS,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VES,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL" } [pm_filters.aci] credit = { country = "AD,AE,AT,BE,BG,CH,CN,CO,CR,CY,CZ,DE,DK,DO,EE,EG,ES,ET,FI,FR,GB,GH,GI,GR,GT,HN,HK,HR,HU,ID,IE,IS,IT,JP,KH,LA,LI,LT,LU,LY,MK,MM,MX,MY,MZ,NG,NZ,OM,PA,PE,PK,PL,PT,QA,RO,SA,SN,SE,SI,SK,SV,TH,UA,US,UY,VN,ZM", currency = "AED,ALL,ARS,BGN,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,EGP,EUR,GBP,GHS,HKD,HNL,HRK,HUF,IDR,ILS,ISK,JPY,KHR,KPW,LAK,LKR,MAD,MKD,MMK,MXN,MYR,MZN,NGN,NOK,NZD,OMR,PAB,PEN,PHP,PKR,PLN,QAR,RON,RSD,SAR,SEK,SGD,THB,TRY,TWD,UAH,USD,UYU,VND,ZAR,ZMW" } @@ -523,22 +525,22 @@ ali_pay = { country = "CN", currency = "CNY" } eps = { country = "AT", currency = "EUR" } ideal = { country = "NL", currency = "EUR" } giropay = { country = "DE", currency = "EUR" } -sofort = { country = "AT,BE,CH,DE,ES,GB,IT,NL,PL", currency = "CHF,EUR,GBP,HUF,PLN"} -interac = { country = "CA", currency = "CAD,USD"} +sofort = { country = "AT,BE,CH,DE,ES,GB,IT,NL,PL", currency = "CHF,EUR,GBP,HUF,PLN" } +interac = { country = "CA", currency = "CAD,USD" } przelewy24 = { country = "PL", currency = "CZK,EUR,GBP,PLN" } trustly = { country = "ES,GB,SE,NO,AT,NL,DE,DK,FI,EE,LT,LV", currency = "CZK,DKK,EUR,GBP,NOK,SEK" } klarna = { country = "AU,AT,BE,CA,CZ,DK,FI,FR,DE,GR,IE,IT,NL,NZ,NO,PL,PT,ES,SE,CH,GB,US", currency = "CHF,DKK,EUR,GBP,NOK,PLN,SEK,USD,AUD,NZD,CAD" } [pm_filters.authorizedotnet] -credit = {currency = "CAD,USD"} -debit = {currency = "CAD,USD"} -google_pay = {currency = "CHF,DKK,EUR,GBP,NOK,PLN,SEK,USD,AUD,NZD,CAD"} -apple_pay = {currency = "EUR,GBP,ISK,USD,AUD,CAD,BRL,CLP,COP,CRC,CZK,DKK,EGP,GEL,GHS,GTQ,HNL,HKD,HUF,ILS,INR,JPY,KZT,KRW,KWD,MAD,MXN,MYR,NOK,NZD,PEN,PLN,PYG,QAR,RON,SAR,SEK,SGD,THB,TWD,UAH,AED,VND,ZAR"} -paypal = {currency = "AUD,BRL,CAD,CHF,CNY,CZK,DKK,EUR,GBP,HKD,HUF,ILS,JPY,MXN,MYR,NOK,NZD,PHP,PLN,SEK,SGD,THB,TWD,USD"} +credit = { currency = "CAD,USD" } +debit = { currency = "CAD,USD" } +google_pay = { currency = "CHF,DKK,EUR,GBP,NOK,PLN,SEK,USD,AUD,NZD,CAD" } +apple_pay = { currency = "EUR,GBP,ISK,USD,AUD,CAD,BRL,CLP,COP,CRC,CZK,DKK,EGP,GEL,GHS,GTQ,HNL,HKD,HUF,ILS,INR,JPY,KZT,KRW,KWD,MAD,MXN,MYR,NOK,NZD,PEN,PLN,PYG,QAR,RON,SAR,SEK,SGD,THB,TWD,UAH,AED,VND,ZAR" } +paypal = { currency = "AUD,BRL,CAD,CHF,CNY,CZK,DKK,EUR,GBP,HKD,HUF,ILS,JPY,MXN,MYR,NOK,NZD,PHP,PLN,SEK,SGD,THB,TWD,USD" } [pm_filters.forte] -credit = { country = "US, CA", currency = "CAD,USD"} -debit = { country = "US, CA", currency = "CAD,USD"} +credit = { country = "US, CA", currency = "CAD,USD" } +debit = { country = "US, CA", currency = "CAD,USD" } [pm_filters.fiuu] duit_now = { country = "MY", currency = "MYR" } @@ -549,8 +551,8 @@ credit = { country = "CN,HK,ID,MY,PH,SG,TH,TW,VN", currency = "CNY,HKD,IDR,MYR,P debit = { country = "CN,HK,ID,MY,PH,SG,TH,TW,VN", currency = "CNY,HKD,IDR,MYR,PHP,SGD,THB,TWD,VND" } [pm_filters.placetopay] -credit = { country = "BE,CH,CO,CR,EC,HN,MX,PA,PR,UY", currency = "CLP,COP,USD"} -debit = { country = "BE,CH,CO,CR,EC,HN,MX,PA,PR,UY", currency = "CLP,COP,USD"} +credit = { country = "BE,CH,CO,CR,EC,HN,MX,PA,PR,UY", currency = "CLP,COP,USD" } +debit = { country = "BE,CH,CO,CR,EC,HN,MX,PA,PR,UY", currency = "CLP,COP,USD" } [pm_filters.coingate] crypto_currency = { country = "AL, AD, AT, BE, BA, BG, HR, CZ, DK, EE, FI, FR, DE, GR, HU, IS, IE, IT, LV, LT, LU, MT, MD, NL, NO, PL, PT, RO, RS, SK, SI, ES, SE, CH, UA, GB, AR, BR, CL, CO, CR, DO, SV, GD, MX, PE, LC, AU, NZ, CY, HK, IN, IL, JP, KR, QA, SA, SG, EG", currency = "EUR, USD, GBP" } @@ -704,4 +706,4 @@ redsys = { payment_method = "card" } [billing_connectors_payment_sync] billing_connectors_which_require_payment_sync = "stripebilling, recurly" [billing_connectors_invoice_sync] -billing_connectors_which_requires_invoice_sync_call = "recurly" \ No newline at end of file +billing_connectors_which_requires_invoice_sync_call = "recurly" diff --git a/scripts/add_connector.sh b/scripts/add_connector.sh index 534c1614a5e..648d2e68993 100755 --- a/scripts/add_connector.sh +++ b/scripts/add_connector.sh @@ -6,7 +6,7 @@ function find_prev_connector() { git checkout $self cp $self $self.tmp # Add new connector to existing list and sort it - connectors=(aci adyen adyenplatform airwallex amazonpay applepay archipel authorizedotnet bambora bamboraapac bankofamerica barclaycard billwerk bitpay bluesnap boku braintree cashtocode chargebee checkbook checkout coinbase cryptopay ctp_visa cybersource datatrans deutschebank digitalvirgo dlocal dummyconnector dwolla ebanx elavon facilitapay fiserv fiservemea fiuu forte getnet globalpay globepay gocardless gpayments helcim hipay hyperswitch_vault iatapay inespay itaubank jpmorgan juspaythreedsserver klarna mifinity mollie moneris multisafepay netcetera nexinets nexixpay nomupay noon nordea novalnet nuvei opayo opennode paybox payeezy payload payme payone paypal paystack payu placetopay plaid powertranz prophetpay rapyd razorpay recurly redsys santander shift4 square stax stripe stripebilling taxjar threedsecureio thunes tokenio trustpay tsys unified_authentication_service vgs volt wellsfargo wellsfargopayout wise worldline worldpay worldpayvantiv worldpayxml xendit zsl "$1") + connectors=(aci adyen adyenplatform airwallex amazonpay applepay archipel authorizedotnet bambora bamboraapac bankofamerica barclaycard billwerk bitpay bluesnap boku braintree cashtocode celero chargebee checkbook checkout coinbase cryptopay ctp_visa cybersource datatrans deutschebank digitalvirgo dlocal dummyconnector dwolla ebanx elavon facilitapay fiserv fiservemea fiuu forte getnet globalpay globepay gocardless gpayments helcim hipay hyperswitch_vault iatapay inespay itaubank jpmorgan juspaythreedsserver klarna mifinity mollie moneris multisafepay netcetera nexinets nexixpay nomupay noon nordea novalnet nuvei opayo opennode paybox payeezy payload payme payone paypal paystack payu placetopay plaid powertranz prophetpay rapyd razorpay recurly redsys santander shift4 square stax stripe stripebilling taxjar threedsecureio thunes tokenio trustpay tsys unified_authentication_service vgs volt wellsfargo wellsfargopayout wise worldline worldpay worldpayvantiv worldpayxml xendit zsl "$1") IFS=$'\n' sorted=($(sort <<<"${connectors[]}")); unset IFS res="$(echo ${sorted[@]})" sed -i'' -e "s/^ connectors=./ connectors=($res \"\$1\")/" $self.tmp	2025-06-30T08:05:39Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [x] New feature - [ ] Enhancement - [x] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> Template new connection integration `celero` ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> No testing required as this is template ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [ ] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	9d7edb5cee030a13c8699a914a0d3600b058853d	9d7edb5cee030a13c8699a914a0d3600b058853d
juspay/hyperswitch	juspay__hyperswitch-8462	Bug: chore: bump tonic version bumping tonic version from 0.12 to 0.13.1	diff --git a/Cargo.lock b/Cargo.lock index 42add100ade..b578a5ff88f 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1186,14 +1186,14 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "3a6c9af12842a67734c9a2e355436e5d03b22383ed60cf13cd0c18fbfe3dcbcf" dependencies = [ "async-trait", - "axum-core", + "axum-core 0.4.3", "bytes 1.10.1", "futures-util", "http 1.3.1", "http-body 1.0.1", "http-body-util", "itoa", - "matchit", + "matchit 0.7.3", "memchr", "mime", "percent-encoding", @@ -1201,7 +1201,33 @@ dependencies = [ "rustversion", "serde", "sync_wrapper 1.0.1", - "tower", + "tower 0.4.13", + "tower-layer", + "tower-service", +] + +[[package]] +name = "axum" +version = "0.8.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "021e862c184ae977658b36c4500f7feac3221ca5da43e3f25bd04ab6c79a29b5" +dependencies = [ + "axum-core 0.5.2", + "bytes 1.10.1", + "futures-util", + "http 1.3.1", + "http-body 1.0.1", + "http-body-util", + "itoa", + "matchit 0.8.4", + "memchr", + "mime", + "percent-encoding", + "pin-project-lite", + "rustversion", + "serde", + "sync_wrapper 1.0.1", + "tower 0.5.2", "tower-layer", "tower-service", ] @@ -1226,6 +1252,25 @@ dependencies = [ "tower-service", ] +[[package]] +name = "axum-core" +version = "0.5.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "68464cd0412f486726fb3373129ef5d2993f90c34bc2bc1c1e9943b2f4fc7ca6" +dependencies = [ + "bytes 1.10.1", + "futures-core", + "http 1.3.1", + "http-body 1.0.1", + "http-body-util", + "mime", + "pin-project-lite", + "rustversion", + "sync_wrapper 1.0.1", + "tower-layer", + "tower-service", +] + [[package]] name = "backtrace" version = "0.3.74" @@ -2969,7 +3014,7 @@ dependencies = [ "serde", "thiserror 1.0.69", "tokio 1.45.1", - "tonic", + "tonic 0.13.1", "tonic-build", "tonic-reflection", "tonic-types", @@ -4704,6 +4749,12 @@ version = "0.7.3" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "0e7465ac9959cc2b1404e8e2367b43684a6d13790fe23056cc8c6c5a6b7bcb94" +[[package]] +name = "matchit" +version = "0.8.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "47e1ffaa40ddd1f3ed91f717a33c8c0ee23fff369e3aa8772b9605cc1d22f4c3" + [[package]] name = "maud" version = "0.26.0" @@ -5337,7 +5388,7 @@ dependencies = [ "prost", "thiserror 1.0.69", "tokio 1.45.1", - "tonic", + "tonic 0.12.3", ] [[package]] @@ -5349,7 +5400,7 @@ dependencies = [ "opentelemetry", "opentelemetry_sdk", "prost", - "tonic", + "tonic 0.12.3", ] [[package]] @@ -5951,8 +6002,8 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "f8650aabb6c35b860610e9cff5dc1af886c9e25073b7b1712a68972af4281302" dependencies = [ "bytes 1.10.1", - "heck 0.4.1", - "itertools 0.10.5", + "heck 0.5.0", + "itertools 0.13.0", "log", "multimap", "once_cell", @@ -5972,7 +6023,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "acf0c195eebb4af52c752bec4f52f645da98b6e92077a04110c7f349477ae5ac" dependencies = [ "anyhow", - "itertools 0.10.5", + "itertools 0.13.0", "proc-macro2", "quote", "syn 2.0.101", @@ -8796,7 +8847,7 @@ checksum = "877c5b330756d856ffcc4553ab34a5684481ade925ecc54bcd1bf02b1d0d4d52" dependencies = [ "async-stream", "async-trait", - "axum", + "axum 0.7.5", "base64 0.22.1", "bytes 1.10.1", "h2 0.4.8", @@ -8812,7 +8863,36 @@ dependencies = [ "socket2", "tokio 1.45.1", "tokio-stream", - "tower", + "tower 0.4.13", + "tower-layer", + "tower-service", + "tracing", +] + +[[package]] +name = "tonic" +version = "0.13.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7e581ba15a835f4d9ea06c55ab1bd4dce26fc53752c69a04aac00703bfb49ba9" +dependencies = [ + "async-trait", + "axum 0.8.4", + "base64 0.22.1", + "bytes 1.10.1", + "h2 0.4.8", + "http 1.3.1", + "http-body 1.0.1", + "http-body-util", + "hyper 1.6.0", + "hyper-timeout", + "hyper-util", + "percent-encoding", + "pin-project", + "prost", + "socket2", + "tokio 1.45.1", + "tokio-stream", + "tower 0.5.2", "tower-layer", "tower-service", "tracing", @@ -8820,39 +8900,40 @@ dependencies = [ [[package]] name = "tonic-build" -version = "0.12.2" +version = "0.13.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "fe4ee8877250136bd7e3d2331632810a4df4ea5e004656990d8d66d2f5ee8a67" +checksum = "eac6f67be712d12f0b41328db3137e0d0757645d8904b4cb7d51cd9c2279e847" dependencies = [ "prettyplease", "proc-macro2", "prost-build", + "prost-types", "quote", "syn 2.0.101", ] [[package]] name = "tonic-reflection" -version = "0.12.3" +version = "0.13.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "878d81f52e7fcfd80026b7fdb6a9b578b3c3653ba987f87f0dce4b64043cba27" +checksum = "f9687bd5bfeafebdded2356950f278bba8226f0b32109537c4253406e09aafe1" dependencies = [ "prost", "prost-types", "tokio 1.45.1", "tokio-stream", - "tonic", + "tonic 0.13.1", ] [[package]] name = "tonic-types" -version = "0.12.3" +version = "0.13.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0081d8ee0847d01271392a5aebe960a4600f5d4da6c67648a6382a0940f8b367" +checksum = "07439468da24d5f211d3f3bd7b63665d8f45072804457e838a87414a478e2db8" dependencies = [ "prost", "prost-types", - "tonic", + "tonic 0.13.1", ] [[package]] @@ -8891,6 +8972,25 @@ dependencies = [ "tracing", ] +[[package]] +name = "tower" +version = "0.5.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d039ad9159c98b70ecfd540b2573b97f7f52c3e8d9f8ad57a24b916a536975f9" +dependencies = [ + "futures-core", + "futures-util", + "indexmap 2.9.0", + "pin-project-lite", + "slab", + "sync_wrapper 1.0.1", + "tokio 1.45.1", + "tokio-util", + "tower-layer", + "tower-service", + "tracing", +] + [[package]] name = "tower-layer" version = "0.3.3" @@ -9057,7 +9157,7 @@ version = "1.6.3" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "97fee6b57c6a41524a810daee9286c02d7752c4253064d0b05472833a438f675" dependencies = [ - "cfg-if 0.1.10", + "cfg-if 1.0.0", "static_assertions", ] @@ -9610,7 +9710,7 @@ version = "0.1.9" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "cf221c93e13a30d793f7645a0e7762c55d169dbb0a49671918a2319d289b10bb" dependencies = [ - "windows-sys 0.48.0", + "windows-sys 0.59.0", ] [[package]] diff --git a/crates/external_services/Cargo.toml b/crates/external_services/Cargo.toml index 34aca99f399..4002e117c62 100644 --- a/crates/external_services/Cargo.toml +++ b/crates/external_services/Cargo.toml @@ -48,9 +48,9 @@ thiserror = "1.0.69" vaultrs = { version = "0.7.4", optional = true } prost = { version = "0.13", optional = true } tokio = "1.45.1" -tonic = { version = "0.12.3", optional = true } -tonic-reflection = { version = "0.12.3", optional = true } -tonic-types = { version = "0.12.3", optional = true } +tonic = { version = "0.13.1", optional = true } +tonic-reflection = { version = "0.13.1", optional = true } +tonic-types = { version = "0.13.1", optional = true } hyper-util = { version = "0.1.12", optional = true } http-body-util = { version = "0.1.3", optional = true } reqwest = { version = "0.11.27", features = ["rustls-tls"] } @@ -71,7 +71,7 @@ api_models = { version = "0.1.0", path = "../api_models", optional = true } [build-dependencies] -tonic-build = { version = "0.12", optional = true } +tonic-build = { version = "0.13.1", optional = true } router_env = { version = "0.1.0", path = "../router_env", default-features = false, optional = true } [lints] diff --git a/crates/external_services/build.rs b/crates/external_services/build.rs index 8dba0bb3e98..c9d9017560b 100644 --- a/crates/external_services/build.rs +++ b/crates/external_services/build.rs @@ -14,7 +14,7 @@ fn main() -> Result<(), Box<dyn std::error::Error>> { // Compile the .proto file tonic_build::configure() .out_dir(out_dir) - .compile( + .compile_protos( &[ success_rate_proto_file, health_check_proto_file, diff --git a/crates/external_services/src/grpc_client.rs b/crates/external_services/src/grpc_client.rs index 7a627d3ab27..45b98c51154 100644 --- a/crates/external_services/src/grpc_client.rs +++ b/crates/external_services/src/grpc_client.rs @@ -13,20 +13,16 @@ use dynamic_routing::{DynamicRoutingClientConfig, RoutingStrategy}; #[cfg(feature = "dynamic_routing")] use health_check_client::HealthCheckClient; #[cfg(feature = "dynamic_routing")] -use http_body_util::combinators::UnsyncBoxBody; -#[cfg(feature = "dynamic_routing")] -use hyper::body::Bytes; -#[cfg(feature = "dynamic_routing")] use hyper_util::client::legacy::connect::HttpConnector; #[cfg(feature = "dynamic_routing")] use router_env::logger; use serde; #[cfg(feature = "dynamic_routing")] -use tonic::Status; +use tonic::body::Body; #[cfg(feature = "dynamic_routing")] /// Hyper based Client type for maintaining connection pool for all gRPC services -pub type Client = hyper_util::client::legacy::Client<HttpConnector, UnsyncBoxBody<Bytes, Status>>; +pub type Client = hyper_util::client::legacy::Client<HttpConnector, Body>; /// Struct contains all the gRPC Clients #[derive(Debug, Clone)]	2025-06-25T12:29:54Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description bumping tonic version from 0.12 to 0.13 ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> ## How did you test it? - The client connection was success <img width="1725" alt="Screenshot 2025-06-25 at 6 00 12 PM" src="https://github.com/user-attachments/assets/7981c4cc-041e-4426-a158-d66af2d1e2cd" /> - got response for the health check api ``` { "database": true, "redis": true, "analytics": true, "opensearch": false, "outgoing_request": true, "grpc_health_check": { "dynamic_routing_service": true }, "decision_engine": false } ``` ## Checklist <!-- Put an `x` in the boxes that apply --> - [ ] I formatted the code `cargo +nightly fmt --all` - [ ] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.114.0	0a06ad91252d76d0c937344d8c76c9a2bbbc84d7	0a06ad91252d76d0c937344d8c76c9a2bbbc84d7
juspay/hyperswitch	juspay__hyperswitch-8464	Bug: [FEATURE] allow data migration at profile level ### Feature Description The `migrate_payment_methods` API is used for migrating customer and payment method data. Currently, it operates at the merchant level, but since the `merchant_connector_id` is tied to a specific profile, migrations are limited to a single profile at a time. This feature aims to enhance the data migration process to support multiple profiles. The goal is to allow a single payment method to be migrated across several `merchant_connector_id`s, enabling data migration at the profile level. ### Implementation Plan Below are the the changes: Customer Data Migration: * Update `PaymentMethodRecord` to allow `merchant_connector_id` and `connector_customer_id` to accept comma-separated strings. * Update `PaymentMethodCustomerMigrate` to handle a list of connector customer details. * The `From` implementation for `PaymentMethodCustomerMigrate` will be updated to parse these new comma-separated strings. * Finally, update the `create_customer` function to handle the list of connector details, allowing a customer to be associated with multiple connector accounts. Payment Method Migration: * Update `PaymentMethodsMigrateForm` to accept a comma-separated string for `merchant_connector_id`. * The functions `get_payment_method_records` and `migrate_payment_methods` will be updated to handle this change. * The `TryFrom` implementation for `PaymentMethodMigrate` will be modified to create a `PaymentsMandateReference` for each `merchant_connector_id` in the comma-separated string. All changes will be backward-compatible. ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? Yes, I am willing to submit a PR!	diff --git a/crates/api_models/src/payment_methods.rs b/crates/api_models/src/payment_methods.rs index c681cf7edd0..b3e76e37291 100644 --- a/crates/api_models/src/payment_methods.rs +++ b/crates/api_models/src/payment_methods.rs @@ -19,7 +19,7 @@ use utoipa::{schema, ToSchema}; #[cfg(feature = "payouts")] use crate::payouts; use crate::{ - admin, customers, enums as api_enums, + admin, enums as api_enums, payments::{self, BankCodeResponse}, }; @@ -2517,6 +2517,7 @@ pub struct PaymentMethodRecord { pub billing_address_line3: Option<masking::Secret<String>>, pub raw_card_number: Option<masking::Secret<String>>, pub merchant_connector_id: Option<id_type::MerchantConnectorAccountId>, + pub merchant_connector_ids: Option<String>, pub original_transaction_amount: Option<i64>, pub original_transaction_currency: Option<common_enums::Currency>, pub line_number: Option<i64>, @@ -2526,18 +2527,6 @@ pub struct PaymentMethodRecord { pub network_token_requestor_ref_id: Option<String>, } -#[derive(Debug, Clone, serde::Deserialize, serde::Serialize)] -pub struct ConnectorCustomerDetails { - pub connector_customer_id: String, - pub merchant_connector_id: id_type::MerchantConnectorAccountId, -} - -#[derive(Debug, Clone, serde::Deserialize, serde::Serialize)] -pub struct PaymentMethodCustomerMigrate { - pub customer: customers::CustomerRequest, - pub connector_customer_details: Option<ConnectorCustomerDetails>, -} - #[derive(Debug, Default, serde::Serialize)] pub struct PaymentMethodMigrationResponse { pub line_number: Option<i64>, @@ -2654,47 +2643,56 @@ impl From<PaymentMethodMigrationResponseType> for PaymentMethodMigrationResponse impl TryFrom<( - PaymentMethodRecord, + &PaymentMethodRecord, id_type::MerchantId, - Option<id_type::MerchantConnectorAccountId>, + Option<&Vec<id_type::MerchantConnectorAccountId>>, )> for PaymentMethodMigrate { type Error = error_stack::Report<errors::ValidationError>; + fn try_from( item: ( - PaymentMethodRecord, + &PaymentMethodRecord, id_type::MerchantId, - Option<id_type::MerchantConnectorAccountId>, + Option<&Vec<id_type::MerchantConnectorAccountId>>, ), ) -> Result<Self, Self::Error> { - let (record, merchant_id, mca_id) = item; + let (record, merchant_id, mca_ids) = item; let billing = record.create_billing(); - - // if payment instrument id is present then only construct this - let connector_mandate_details = if record.payment_instrument_id.is_some() { - Some(PaymentsMandateReference(HashMap::from([( - mca_id.get_required_value("merchant_connector_id")?, - PaymentsMandateReferenceRecord { - connector_mandate_id: record - .payment_instrument_id - .get_required_value("payment_instrument_id")? - .peek() - .to_string(), - payment_method_type: record.payment_method_type, - original_payment_authorized_amount: record.original_transaction_amount, - original_payment_authorized_currency: record.original_transaction_currency, - }, - )]))) + let connector_mandate_details = if let Some(payment_instrument_id) = + &record.payment_instrument_id + { + let ids = mca_ids.get_required_value("mca_ids")?; + let mandate_map: HashMap<_, _> = ids + .iter() + .map(\|mca_id\| { + ( + mca_id.clone(), + PaymentsMandateReferenceRecord { + connector_mandate_id: payment_instrument_id.peek().to_string(), + payment_method_type: record.payment_method_type, + original_payment_authorized_amount: record.original_transaction_amount, + original_payment_authorized_currency: record + .original_transaction_currency, + }, + ) + }) + .collect(); + Some(PaymentsMandateReference(mandate_map)) } else { None }; + Ok(Self { merchant_id, - customer_id: Some(record.customer_id), + customer_id: Some(record.customer_id.clone()), card: Some(MigrateCardDetail { - card_number: record.raw_card_number.unwrap_or(record.card_number_masked), - card_exp_month: record.card_expiry_month, - card_exp_year: record.card_expiry_year, + card_number: record + .raw_card_number + .clone() + .unwrap_or_else(\|\| record.card_number_masked.clone()), + card_exp_month: record.card_expiry_month.clone(), + card_exp_year: record.card_expiry_year.clone(), card_holder_name: record.name.clone(), card_network: None, card_type: None, @@ -2704,10 +2702,16 @@ impl }), network_token: Some(MigrateNetworkTokenDetail { network_token_data: MigrateNetworkTokenData { - network_token_number: record.network_token_number.unwrap_or_default(), - network_token_exp_month: record.network_token_expiry_month.unwrap_or_default(), - network_token_exp_year: record.network_token_expiry_year.unwrap_or_default(), - card_holder_name: record.name, + network_token_number: record.network_token_number.clone().unwrap_or_default(), + network_token_exp_month: record + .network_token_expiry_month + .clone() + .unwrap_or_default(), + network_token_exp_year: record + .network_token_expiry_year + .clone() + .unwrap_or_default(), + card_holder_name: record.name.clone(), nick_name: record.nick_name.clone(), card_issuing_country: None, card_network: None, @@ -2716,6 +2720,7 @@ impl }, network_token_requestor_ref_id: record .network_token_requestor_ref_id + .clone() .unwrap_or_default(), }), payment_method: record.payment_method, @@ -2740,45 +2745,6 @@ impl } } -#[cfg(feature = "v1")] -impl From<(PaymentMethodRecord, id_type::MerchantId)> for PaymentMethodCustomerMigrate { - fn from(value: (PaymentMethodRecord, id_type::MerchantId)) -> Self { - let (record, merchant_id) = value; - Self { - customer: customers::CustomerRequest { - customer_id: Some(record.customer_id), - merchant_id, - name: record.name, - email: record.email, - phone: record.phone, - description: None, - phone_country_code: record.phone_country_code, - address: Some(payments::AddressDetails { - city: record.billing_address_city, - country: record.billing_address_country, - line1: record.billing_address_line1, - line2: record.billing_address_line2, - state: record.billing_address_state, - line3: record.billing_address_line3, - zip: record.billing_address_zip, - first_name: record.billing_address_first_name, - last_name: record.billing_address_last_name, - }), - metadata: None, - }, - connector_customer_details: record - .connector_customer_id - .zip(record.merchant_connector_id) - .map( - \|(connector_customer_id, merchant_connector_id)\| ConnectorCustomerDetails { - connector_customer_id, - merchant_connector_id, - }, - ), - } - } -} - #[derive(Debug, serde::Deserialize, serde::Serialize, ToSchema)] pub struct CardNetworkTokenizeRequest { /// Merchant ID associated with the tokenization request diff --git a/crates/hyperswitch_domain_models/src/lib.rs b/crates/hyperswitch_domain_models/src/lib.rs index 4ee8620e35e..35570036c20 100644 --- a/crates/hyperswitch_domain_models/src/lib.rs +++ b/crates/hyperswitch_domain_models/src/lib.rs @@ -36,6 +36,7 @@ pub mod router_response_types; pub mod routing; #[cfg(feature = "tokenization_v2")] pub mod tokenization; +pub mod transformers; pub mod type_encryption; pub mod types; pub mod vault; diff --git a/crates/hyperswitch_domain_models/src/payment_methods.rs b/crates/hyperswitch_domain_models/src/payment_methods.rs index 0f6d4d6f924..aa01465408e 100644 --- a/crates/hyperswitch_domain_models/src/payment_methods.rs +++ b/crates/hyperswitch_domain_models/src/payment_methods.rs @@ -1,5 +1,6 @@ #[cfg(feature = "v2")] use api_models::payment_methods::PaymentMethodsData; +use api_models::{customers, payment_methods, payments}; // specific imports because of using the macro use common_enums::enums::MerchantStorageScheme; #[cfg(feature = "v1")] @@ -27,11 +28,12 @@ use time::PrimitiveDateTime; #[cfg(feature = "v2")] use crate::address::Address; #[cfg(feature = "v1")] -use crate::{mandates, type_encryption::AsyncLift}; +use crate::type_encryption::AsyncLift; use crate::{ - mandates::CommonMandateReference, + mandates::{self, CommonMandateReference}, merchant_key_store::MerchantKeyStore, payment_method_data as domain_payment_method_data, + transformers::ForeignTryFrom, type_encryption::{crypto_operation, CryptoOperation}, }; @@ -87,7 +89,6 @@ pub struct PaymentMethod { pub network_token_locker_id: Option<String>, pub network_token_payment_method_data: OptionalEncryptableValue, } - #[cfg(feature = "v2")] #[derive(Clone, Debug, router_derive::ToEncryption)] pub struct PaymentMethod { @@ -915,6 +916,136 @@ pub struct PaymentMethodsSessionUpdateInternal { pub tokenization_data: Option<pii::SecretSerdeValue>, } +#[derive(Debug, Clone, serde::Deserialize, serde::Serialize)] +pub struct ConnectorCustomerDetails { + pub connector_customer_id: String, + pub merchant_connector_id: id_type::MerchantConnectorAccountId, +} + +#[derive(Debug, Clone, serde::Deserialize, serde::Serialize)] +pub struct PaymentMethodCustomerMigrate { + pub customer: customers::CustomerRequest, + pub connector_customer_details: Option<Vec<ConnectorCustomerDetails>>, +} + +#[cfg(feature = "v1")] +impl TryFrom<(payment_methods::PaymentMethodRecord, id_type::MerchantId)> + for PaymentMethodCustomerMigrate +{ + type Error = error_stack::Report<ValidationError>; + fn try_from( + value: (payment_methods::PaymentMethodRecord, id_type::MerchantId), + ) -> Result<Self, Self::Error> { + let (record, merchant_id) = value; + let connector_customer_details = record + .connector_customer_id + .and_then(\|connector_customer_id\| { + // Handle single merchant_connector_id + record + .merchant_connector_id + .as_ref() + .map(\|merchant_connector_id\| { + Ok(vec![ConnectorCustomerDetails { + connector_customer_id: connector_customer_id.clone(), + merchant_connector_id: merchant_connector_id.clone(), + }]) + }) + // Handle comma-separated merchant_connector_ids + .or_else(\|\| { + record + .merchant_connector_ids + .as_ref() + .map(\|merchant_connector_ids_str\| { + merchant_connector_ids_str + .split(',') + .map(\|id\| id.trim()) + .filter(\|id\| !id.is_empty()) + .map(\|merchant_connector_id\| { + id_type::MerchantConnectorAccountId::wrap( + merchant_connector_id.to_string(), + ) + .map_err(\|_\| { + error_stack::report!(ValidationError::InvalidValue { + message: format!( + "Invalid merchant_connector_account_id: {}", + merchant_connector_id + ), + }) + }) + .map( + \|merchant_connector_id\| ConnectorCustomerDetails { + connector_customer_id: connector_customer_id + .clone(), + merchant_connector_id, + }, + ) + }) + .collect::<Result<Vec<_>, _>>() + }) + }) + }) + .transpose()?; + + Ok(Self { + customer: customers::CustomerRequest { + customer_id: Some(record.customer_id), + merchant_id, + name: record.name, + email: record.email, + phone: record.phone, + description: None, + phone_country_code: record.phone_country_code, + address: Some(payments::AddressDetails { + city: record.billing_address_city, + country: record.billing_address_country, + line1: record.billing_address_line1, + line2: record.billing_address_line2, + state: record.billing_address_state, + line3: record.billing_address_line3, + zip: record.billing_address_zip, + first_name: record.billing_address_first_name, + last_name: record.billing_address_last_name, + }), + metadata: None, + }, + connector_customer_details, + }) + } +} + +#[cfg(feature = "v1")] +impl ForeignTryFrom<(&[payment_methods::PaymentMethodRecord], id_type::MerchantId)> + for Vec<PaymentMethodCustomerMigrate> +{ + type Error = error_stack::Report<ValidationError>; + + fn foreign_try_from( + (records, merchant_id): (&[payment_methods::PaymentMethodRecord], id_type::MerchantId), + ) -> Result<Self, Self::Error> { + let (customers_migration, migration_errors): (Self, Vec<_>) = records + .iter() + .map(\|record\| { + PaymentMethodCustomerMigrate::try_from((record.clone(), merchant_id.clone())) + }) + .fold((Self::new(), Vec::new()), \|mut acc, result\| { + match result { + Ok(customer) => acc.0.push(customer), + Err(e) => acc.1.push(e.to_string()), + } + acc + }); + + migration_errors + .is_empty() + .then_some(customers_migration) + .ok_or_else(\|\| { + error_stack::report!(ValidationError::InvalidValue { + message: migration_errors.join(", "), + }) + }) + } +} + #[cfg(feature = "v1")] #[cfg(test)] mod tests { diff --git a/crates/hyperswitch_domain_models/src/transformers.rs b/crates/hyperswitch_domain_models/src/transformers.rs new file mode 100644 index 00000000000..1208d80c323 --- /dev/null +++ b/crates/hyperswitch_domain_models/src/transformers.rs @@ -0,0 +1,9 @@ +pub trait ForeignFrom<F> { + fn foreign_from(from: F) -> Self; +} + +pub trait ForeignTryFrom<F>: Sized { + type Error; + + fn foreign_try_from(from: F) -> Result<Self, Self::Error>; +} diff --git a/crates/payment_methods/src/core/migration.rs b/crates/payment_methods/src/core/migration.rs index 8b2694cf6fe..6b7ce30b4c5 100644 --- a/crates/payment_methods/src/core/migration.rs +++ b/crates/payment_methods/src/core/migration.rs @@ -24,20 +24,22 @@ pub async fn migrate_payment_methods( payment_methods: Vec<pm_api::PaymentMethodRecord>, merchant_id: &common_utils::id_type::MerchantId, merchant_context: &merchant_context::MerchantContext, - mca_id: Option<common_utils::id_type::MerchantConnectorAccountId>, + mca_ids: Option<Vec<common_utils::id_type::MerchantConnectorAccountId>>, controller: &dyn pm::PaymentMethodsController, ) -> PmMigrationResult<Vec<pm_api::PaymentMethodMigrationResponse>> { - let mut result = Vec::new(); + let mut result = Vec::with_capacity(payment_methods.len()); + for record in payment_methods { let req = pm_api::PaymentMethodMigrate::try_from(( - record.clone(), + &record, merchant_id.clone(), - mca_id.clone(), + mca_ids.as_ref(), )) .map_err(\|err\| errors::ApiErrorResponse::InvalidRequestData { message: format!("error: {:?}", err), }) .attach_printable("record deserialization failed"); + let res = match req { Ok(migrate_request) => { let res = migrate_payment_method( @@ -56,6 +58,7 @@ pub async fn migrate_payment_methods( } Err(e) => Err(e.to_string()), }; + result.push(pm_api::PaymentMethodMigrationResponse::from((res, record))); } Ok(api::ApplicationResponse::Json(result)) @@ -69,7 +72,138 @@ pub struct PaymentMethodsMigrateForm { pub merchant_id: text::Text<common_utils::id_type::MerchantId>, pub merchant_connector_id: - text::Text<Option<common_utils::id_type::MerchantConnectorAccountId>>, + Option<text::Text<common_utils::id_type::MerchantConnectorAccountId>>, + + pub merchant_connector_ids: Option<text::Text<String>>, +} + +struct MerchantConnectorValidator; + +impl MerchantConnectorValidator { + fn parse_comma_separated_ids( + ids_string: &str, + ) -> Result<Vec<common_utils::id_type::MerchantConnectorAccountId>, errors::ApiErrorResponse> + { + // Estimate capacity based on comma count + let capacity = ids_string.matches(',').count() + 1; + let mut result = Vec::with_capacity(capacity); + + for id in ids_string.split(',') { + let trimmed_id = id.trim(); + if !trimmed_id.is_empty() { + let mca_id = + common_utils::id_type::MerchantConnectorAccountId::wrap(trimmed_id.to_string()) + .map_err(\|_\| errors::ApiErrorResponse::InvalidRequestData { + message: format!( + "Invalid merchant_connector_account_id: {}", + trimmed_id + ), + })?; + result.push(mca_id); + } + } + + Ok(result) + } + + fn validate_form_csv_conflicts( + records: &[pm_api::PaymentMethodRecord], + form_has_single_id: bool, + form_has_multiple_ids: bool, + ) -> Result<(), errors::ApiErrorResponse> { + if form_has_single_id { + // If form has merchant_connector_id, CSV records should not have merchant_connector_ids + for (index, record) in records.iter().enumerate() { + if record.merchant_connector_ids.is_some() { + return Err(errors::ApiErrorResponse::InvalidRequestData { + message: format!( + "Record at line {} has merchant_connector_ids but form has merchant_connector_id. Only one should be provided", + index + 1 + ), + }); + } + } + } + + if form_has_multiple_ids { + // If form has merchant_connector_ids, CSV records should not have merchant_connector_id + for (index, record) in records.iter().enumerate() { + if record.merchant_connector_id.is_some() { + return Err(errors::ApiErrorResponse::InvalidRequestData { + message: format!( + "Record at line {} has merchant_connector_id but form has merchant_connector_ids. Only one should be provided", + index + 1 + ), + }); + } + } + } + + Ok(()) + } +} + +type MigrationValidationResult = Result< + ( + common_utils::id_type::MerchantId, + Vec<pm_api::PaymentMethodRecord>, + Option<Vec<common_utils::id_type::MerchantConnectorAccountId>>, + ), + errors::ApiErrorResponse, +>; + +impl PaymentMethodsMigrateForm { + pub fn validate_and_get_payment_method_records(self) -> MigrationValidationResult { + // Step 1: Validate form-level conflicts + let form_has_single_id = self.merchant_connector_id.is_some(); + let form_has_multiple_ids = self.merchant_connector_ids.is_some(); + + if form_has_single_id && form_has_multiple_ids { + return Err(errors::ApiErrorResponse::InvalidRequestData { + message: "Both merchant_connector_id and merchant_connector_ids cannot be provided" + .to_string(), + }); + } + + // Ensure at least one is provided + if !form_has_single_id && !form_has_multiple_ids { + return Err(errors::ApiErrorResponse::InvalidRequestData { + message: "Either merchant_connector_id or merchant_connector_ids must be provided" + .to_string(), + }); + } + + // Step 2: Parse CSV + let records = parse_csv(self.file.data.to_bytes()).map_err(\|e\| { + errors::ApiErrorResponse::PreconditionFailed { + message: e.to_string(), + } + })?; + + // Step 3: Validate CSV vs Form conflicts + MerchantConnectorValidator::validate_form_csv_conflicts( + &records, + form_has_single_id, + form_has_multiple_ids, + )?; + + // Step 4: Prepare the merchant connector account IDs for return + let mca_ids = if let Some(ref single_id) = self.merchant_connector_id { + Some(vec![(**single_id).clone()]) + } else if let Some(ref ids_string) = self.merchant_connector_ids { + let parsed_ids = MerchantConnectorValidator::parse_comma_separated_ids(ids_string)?; + if parsed_ids.is_empty() { + None + } else { + Some(parsed_ids) + } + } else { + None + }; + + // Step 5: Return the updated structure + Ok((self.merchant_id.clone(), records, mca_ids)) + } } fn parse_csv(data: &[u8]) -> csv::Result<Vec<pm_api::PaymentMethodRecord>> { @@ -84,27 +218,6 @@ fn parse_csv(data: &[u8]) -> csv::Result<Vec<pm_api::PaymentMethodRecord>> { } Ok(records) } -pub fn get_payment_method_records( - form: PaymentMethodsMigrateForm, -) -> Result< - ( - common_utils::id_type::MerchantId, - Vec<pm_api::PaymentMethodRecord>, - Option<common_utils::id_type::MerchantConnectorAccountId>, - ), - errors::ApiErrorResponse, -> { - match parse_csv(form.file.data.to_bytes()) { - Ok(records) => { - let merchant_id = form.merchant_id.clone(); - let mca_id = form.merchant_connector_id.clone(); - Ok((merchant_id.clone(), records, mca_id)) - } - Err(e) => Err(errors::ApiErrorResponse::PreconditionFailed { - message: e.to_string(), - }), - } -} #[instrument(skip_all)] pub fn validate_card_expiry( diff --git a/crates/router/src/core/customers.rs b/crates/router/src/core/customers.rs index 2cad1d91eb8..43dbf28c0e0 100644 --- a/crates/router/src/core/customers.rs +++ b/crates/router/src/core/customers.rs @@ -9,6 +9,7 @@ use common_utils::{ }, }; use error_stack::{report, ResultExt}; +use hyperswitch_domain_models::payment_methods as payment_methods_domain; use masking::{ExposeInterface, Secret, SwitchStrategy}; use payment_methods::controller::PaymentMethodsController; use router_env::{instrument, tracing}; @@ -27,7 +28,7 @@ use crate::{ routes::{metrics, SessionState}, services, types::{ - api::{customers, payment_methods as payment_methods_api}, + api::customers, domain::{self, types}, storage::{self, enums}, transformers::ForeignFrom, @@ -41,7 +42,7 @@ pub async fn create_customer( state: SessionState, merchant_context: domain::MerchantContext, customer_data: customers::CustomerRequest, - connector_customer_details: Option<payment_methods_api::ConnectorCustomerDetails>, + connector_customer_details: Option<Vec<payment_methods_domain::ConnectorCustomerDetails>>, ) -> errors::CustomerResponse<customers::CustomerResponse> { let db: &dyn StorageInterface = state.store.as_ref(); let key_manager_state = &(&state).into(); @@ -96,7 +97,9 @@ pub async fn create_customer( trait CustomerCreateBridge { async fn create_domain_model_from_request<'a>( &'a self, - connector_customer_details: &'a Option<payment_methods_api::ConnectorCustomerDetails>, + connector_customer_details: &'a Option< + Vec<payment_methods_domain::ConnectorCustomerDetails>, + >, db: &'a dyn StorageInterface, merchant_reference_id: &'a Option<id_type::CustomerId>, merchant_context: &'a domain::MerchantContext, @@ -115,7 +118,9 @@ trait CustomerCreateBridge { impl CustomerCreateBridge for customers::CustomerRequest { async fn create_domain_model_from_request<'a>( &'a self, - connector_customer_details: &'a Option<payment_methods_api::ConnectorCustomerDetails>, + connector_customer_details: &'a Option< + Vec<payment_methods_domain::ConnectorCustomerDetails>, + >, db: &'a dyn StorageInterface, merchant_reference_id: &'a Option<id_type::CustomerId>, merchant_context: &'a domain::MerchantContext, @@ -175,13 +180,15 @@ impl CustomerCreateBridge for customers::CustomerRequest { domain::FromRequestEncryptableCustomer::from_encryptable(encrypted_data) .change_context(errors::CustomersErrorResponse::InternalServerError)?; - let connector_customer = connector_customer_details.as_ref().map(\|details\| { - let merchant_connector_id = details.merchant_connector_id.get_string_repr().to_string(); - let connector_customer_id = details.connector_customer_id.to_string(); - let object = serde_json::json!({ - merchant_connector_id: connector_customer_id - }); - pii::SecretSerdeValue::new(object) + let connector_customer = connector_customer_details.as_ref().map(\|details_vec\| { + let mut map = serde_json::Map::new(); + for details in details_vec { + let merchant_connector_id = + details.merchant_connector_id.get_string_repr().to_string(); + let connector_customer_id = details.connector_customer_id.clone(); + map.insert(merchant_connector_id, connector_customer_id.into()); + } + pii::SecretSerdeValue::new(serde_json::Value::Object(map)) }); Ok(domain::Customer { @@ -227,7 +234,9 @@ impl CustomerCreateBridge for customers::CustomerRequest { impl CustomerCreateBridge for customers::CustomerRequest { async fn create_domain_model_from_request<'a>( &'a self, - connector_customer_details: &'a Option<payment_methods_api::ConnectorCustomerDetails>, + connector_customer_details: &'a Option< + Vec<payment_methods_domain::ConnectorCustomerDetails>, + >, _db: &'a dyn StorageInterface, merchant_reference_id: &'a Option<id_type::CustomerId>, merchant_context: &'a domain::MerchantContext, @@ -297,12 +306,16 @@ impl CustomerCreateBridge for customers::CustomerRequest { domain::FromRequestEncryptableCustomer::from_encryptable(encrypted_data) .change_context(errors::CustomersErrorResponse::InternalServerError)?; - let connector_customer = connector_customer_details.as_ref().map(\|details\| { - let mut map = std::collections::HashMap::new(); - map.insert( - details.merchant_connector_id.clone(), - details.connector_customer_id.to_string(), - ); + let connector_customer = connector_customer_details.as_ref().map(\|details_vec\| { + let map: std::collections::HashMap<_, _> = details_vec + .iter() + .map(\|details\| { + ( + details.merchant_connector_id.clone(), + details.connector_customer_id.to_string(), + ) + }) + .collect(); common_types::customers::ConnectorCustomerMap::new(map) }); @@ -1060,7 +1073,9 @@ pub async fn update_customer( trait CustomerUpdateBridge { async fn create_domain_model_from_request<'a>( &'a self, - connector_customer_details: &'a Option<payment_methods_api::ConnectorCustomerDetails>, + connector_customer_details: &'a Option< + Vec<payment_methods_domain::ConnectorCustomerDetails>, + >, db: &'a dyn StorageInterface, merchant_context: &'a domain::MerchantContext, key_manager_state: &'a KeyManagerState, @@ -1232,7 +1247,9 @@ impl VerifyIdForUpdateCustomer<'_> { impl CustomerUpdateBridge for customers::CustomerUpdateRequest { async fn create_domain_model_from_request<'a>( &'a self, - _connector_customer_details: &'a Option<payment_methods_api::ConnectorCustomerDetails>, + _connector_customer_details: &'a Option< + Vec<payment_methods_domain::ConnectorCustomerDetails>, + >, db: &'a dyn StorageInterface, merchant_context: &'a domain::MerchantContext, key_manager_state: &'a KeyManagerState, @@ -1337,7 +1354,9 @@ impl CustomerUpdateBridge for customers::CustomerUpdateRequest { impl CustomerUpdateBridge for customers::CustomerUpdateRequest { async fn create_domain_model_from_request<'a>( &'a self, - connector_customer_details: &'a Option<payment_methods_api::ConnectorCustomerDetails>, + connector_customer_details: &'a Option< + Vec<payment_methods_domain::ConnectorCustomerDetails>, + >, db: &'a dyn StorageInterface, merchant_context: &'a domain::MerchantContext, key_manager_state: &'a KeyManagerState, @@ -1454,7 +1473,7 @@ impl CustomerUpdateBridge for customers::CustomerUpdateRequest { pub async fn migrate_customers( state: SessionState, - customers_migration: Vec<payment_methods_api::PaymentMethodCustomerMigrate>, + customers_migration: Vec<payment_methods_domain::PaymentMethodCustomerMigrate>, merchant_context: domain::MerchantContext, ) -> errors::CustomerResponse<()> { for customer_migration in customers_migration { diff --git a/crates/router/src/routes/payment_methods.rs b/crates/router/src/routes/payment_methods.rs index 20d0121ebde..31558c2d323 100644 --- a/crates/router/src/routes/payment_methods.rs +++ b/crates/router/src/routes/payment_methods.rs @@ -10,6 +10,7 @@ use diesel_models::enums::IntentStatus; use error_stack::ResultExt; use hyperswitch_domain_models::{ bulk_tokenization::CardNetworkTokenizeRequest, merchant_key_store::MerchantKeyStore, + payment_methods::PaymentMethodCustomerMigrate, transformers::ForeignTryFrom, }; use router_env::{instrument, logger, tracing, Flow}; @@ -331,10 +332,10 @@ pub async fn migrate_payment_methods( MultipartForm(form): MultipartForm<migration::PaymentMethodsMigrateForm>, ) -> HttpResponse { let flow = Flow::PaymentMethodsMigrate; - let (merchant_id, records, merchant_connector_id) = - match migration::get_payment_method_records(form) { - Ok((merchant_id, records, merchant_connector_id)) => { - (merchant_id, records, merchant_connector_id) + let (merchant_id, records, merchant_connector_ids) = + match form.validate_and_get_payment_method_records() { + Ok((merchant_id, records, merchant_connector_ids)) => { + (merchant_id, records, merchant_connector_ids) } Err(e) => return api::log_and_return_error_response(e.into()), }; @@ -345,7 +346,7 @@ pub async fn migrate_payment_methods( records, \|state, _, req, _\| { let merchant_id = merchant_id.clone(); - let merchant_connector_id = merchant_connector_id.clone(); + let merchant_connector_ids = merchant_connector_ids.clone(); async move { let (key_store, merchant_account) = get_merchant_account(&state, &merchant_id).await?; @@ -354,20 +355,43 @@ pub async fn migrate_payment_methods( domain::Context(merchant_account.clone(), key_store.clone()), )); - customers::migrate_customers( - state.clone(), - req.iter() - .map(\|e\| { - payment_methods::PaymentMethodCustomerMigrate::from(( - e.clone(), - merchant_id.clone(), - )) - }) - .collect(), - merchant_context.clone(), - ) - .await - .change_context(errors::ApiErrorResponse::InternalServerError)?; + let mut mca_cache = std::collections::HashMap::new(); + let customers = Vec::<PaymentMethodCustomerMigrate>::foreign_try_from(( + &req, + merchant_id.clone(), + )) + .map_err(\|e\| errors::ApiErrorResponse::InvalidRequestData { + message: e.to_string(), + })?; + + for record in &customers { + if let Some(connector_customer_details) = &record.connector_customer_details { + for connector_customer in connector_customer_details { + if !mca_cache.contains_key(&connector_customer.merchant_connector_id) { + let mca = state + .store + .find_by_merchant_connector_account_merchant_id_merchant_connector_id( + &(&state).into(), + &merchant_id, + &connector_customer.merchant_connector_id, + merchant_context.get_merchant_key_store(), + ) + .await + .to_not_found_response( + errors::ApiErrorResponse::MerchantConnectorAccountNotFound { + id: connector_customer.merchant_connector_id.get_string_repr().to_string(), + }, + )?; + mca_cache + .insert(connector_customer.merchant_connector_id.clone(), mca); + } + } + } + } + + customers::migrate_customers(state.clone(), customers, merchant_context.clone()) + .await + .change_context(errors::ApiErrorResponse::InternalServerError)?; let controller = cards::PmCards { state: &state, merchant_context: &merchant_context, @@ -377,7 +401,7 @@ pub async fn migrate_payment_methods( req, &merchant_id, &merchant_context, - merchant_connector_id, + merchant_connector_ids, &controller, )) .await diff --git a/crates/router/src/types/api/payment_methods.rs b/crates/router/src/types/api/payment_methods.rs index 0c29b58cbb6..4c094af5acc 100644 --- a/crates/router/src/types/api/payment_methods.rs +++ b/crates/router/src/types/api/payment_methods.rs @@ -1,32 +1,30 @@ #[cfg(feature = "v2")] pub use api_models::payment_methods::{ CardDetail, CardDetailFromLocker, CardDetailsPaymentMethod, CardNetworkTokenizeRequest, - CardNetworkTokenizeResponse, CardType, ConnectorCustomerDetails, - CustomerPaymentMethodResponseItem, DeleteTokenizeByTokenRequest, GetTokenizePayloadRequest, - GetTokenizePayloadResponse, ListCountriesCurrenciesRequest, MigrateCardDetail, - NetworkTokenDetailsPaymentMethod, NetworkTokenDetailsResponse, NetworkTokenResponse, - PaymentMethodCollectLinkRenderRequest, PaymentMethodCollectLinkRequest, PaymentMethodCreate, - PaymentMethodCreateData, PaymentMethodCustomerMigrate, PaymentMethodDeleteResponse, - PaymentMethodId, PaymentMethodIntentConfirm, PaymentMethodIntentCreate, PaymentMethodListData, - PaymentMethodListRequest, PaymentMethodListResponseForSession, PaymentMethodMigrate, - PaymentMethodMigrateResponse, PaymentMethodResponse, PaymentMethodResponseData, - PaymentMethodUpdate, PaymentMethodUpdateData, PaymentMethodsData, TokenDataResponse, - TokenDetailsResponse, TokenizePayloadEncrypted, TokenizePayloadRequest, TokenizedCardValue1, - TokenizedCardValue2, TokenizedWalletValue1, TokenizedWalletValue2, - TotalPaymentMethodCountResponse, + CardNetworkTokenizeResponse, CardType, CustomerPaymentMethodResponseItem, + DeleteTokenizeByTokenRequest, GetTokenizePayloadRequest, GetTokenizePayloadResponse, + ListCountriesCurrenciesRequest, MigrateCardDetail, NetworkTokenDetailsPaymentMethod, + NetworkTokenDetailsResponse, NetworkTokenResponse, PaymentMethodCollectLinkRenderRequest, + PaymentMethodCollectLinkRequest, PaymentMethodCreate, PaymentMethodCreateData, + PaymentMethodDeleteResponse, PaymentMethodId, PaymentMethodIntentConfirm, + PaymentMethodIntentCreate, PaymentMethodListData, PaymentMethodListRequest, + PaymentMethodListResponseForSession, PaymentMethodMigrate, PaymentMethodMigrateResponse, + PaymentMethodResponse, PaymentMethodResponseData, PaymentMethodUpdate, PaymentMethodUpdateData, + PaymentMethodsData, TokenDataResponse, TokenDetailsResponse, TokenizePayloadEncrypted, + TokenizePayloadRequest, TokenizedCardValue1, TokenizedCardValue2, TokenizedWalletValue1, + TokenizedWalletValue2, TotalPaymentMethodCountResponse, }; #[cfg(feature = "v1")] pub use api_models::payment_methods::{ CardDetail, CardDetailFromLocker, CardDetailsPaymentMethod, CardNetworkTokenizeRequest, - CardNetworkTokenizeResponse, ConnectorCustomerDetails, CustomerPaymentMethod, - CustomerPaymentMethodsListResponse, DefaultPaymentMethod, DeleteTokenizeByTokenRequest, - GetTokenizePayloadRequest, GetTokenizePayloadResponse, ListCountriesCurrenciesRequest, - MigrateCardDetail, PaymentMethodCollectLinkRenderRequest, PaymentMethodCollectLinkRequest, - PaymentMethodCreate, PaymentMethodCreateData, PaymentMethodCustomerMigrate, - PaymentMethodDeleteResponse, PaymentMethodId, PaymentMethodListRequest, - PaymentMethodListResponse, PaymentMethodMigrate, PaymentMethodMigrateResponse, - PaymentMethodResponse, PaymentMethodUpdate, PaymentMethodsData, TokenizeCardRequest, - TokenizeDataRequest, TokenizePayloadEncrypted, TokenizePayloadRequest, + CardNetworkTokenizeResponse, CustomerPaymentMethod, CustomerPaymentMethodsListResponse, + DefaultPaymentMethod, DeleteTokenizeByTokenRequest, GetTokenizePayloadRequest, + GetTokenizePayloadResponse, ListCountriesCurrenciesRequest, MigrateCardDetail, + PaymentMethodCollectLinkRenderRequest, PaymentMethodCollectLinkRequest, PaymentMethodCreate, + PaymentMethodCreateData, PaymentMethodDeleteResponse, PaymentMethodId, + PaymentMethodListRequest, PaymentMethodListResponse, PaymentMethodMigrate, + PaymentMethodMigrateResponse, PaymentMethodResponse, PaymentMethodUpdate, PaymentMethodsData, + TokenizeCardRequest, TokenizeDataRequest, TokenizePayloadEncrypted, TokenizePayloadRequest, TokenizePaymentMethodRequest, TokenizedCardValue1, TokenizedCardValue2, TokenizedWalletValue1, TokenizedWalletValue2, }; diff --git a/flake.nix b/flake.nix index e9bcb936d7b..35fa05b73a7 100644 --- a/flake.nix +++ b/flake.nix @@ -31,6 +31,7 @@ openssl pkg-config postgresql # for libpq + protobuf ]; # Minimal packages for running hyperswitch @@ -40,6 +41,7 @@ # Development packages devPackages = base ++ (with pkgs; [ + cargo-watch nixd rust-bin.stable.${rustDevVersion}.default swagger-cli	2025-06-26T18:47:13Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description This pull request enhances the data migration API to support migrating customer and payment method data across multiple business profiles in a single request. Specifically, the following changes have been made: 1. Customer Data Migration: * Updated `PaymentMethodRecord` to allow `merchant_connector_id` to accept comma-separated string values. * Modified `PaymentMethodCustomerMigrate` to use a `Vec` of connector-specific customer details. * The `TryFrom<PaymentMethodRecord>` implementation for `PaymentMethodCustomerMigrate` has been updated to parse this comma-separated string. 2. Payment Method Migration: * Updated `PaymentMethodsMigrateForm` to accept a comma-separated string for `merchant_connector_id`. * The `get_payment_method_records` and `migrate_payment_methods` functions are updated to process multiple `merchant_connector_id`s. * The `TryFrom` implementation for `PaymentMethodMigrate` is modified to create a `PaymentsMandateReference` for each `merchant_connector_id` provided. ### Additional Changes - [x] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context This allows migrating a payment method entity across multiple profiles (as `MerchantConnectorAccountId` is tied to a profile) during batch migration. ## How did you test it? <details> <summary>1. Batch migration for multiple profiles</summary> cURL curl --location --request POST 'http://localhost:8080/payment_methods/migrate-batch' \ --header 'api-key: test_admin' \ --form 'merchant_id="merchant_1751020165"' \ --form 'merchant_connector_ids="mca_lwpasOxD1FtFmG4SVdjX,mca_4tsKLvIinX1uVL8p9mhy"' \ --form 'file=@"migrate.csv"' Response [{"line_number":1,"payment_method_id":"pm_AO2rTJwFIH0I9yQiZ0zT","payment_method":"card","payment_method_type":"debit","customer_id":"45CC60D1F2283097BB1DE41A2636414445908518D50B8B4CDC57959CD7FB4539","migration_status":"Success","card_number_masked":"4360000 xxxx 0005","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":2,"payment_method_id":"pm_ZN9z4oKF439uxyBerwfL","payment_method":"card","payment_method_type":"credit","customer_id":"782BC898951D910C1A99DA69A4E4FAD6CEE53AB9311FA2C552028DA89428DB7F","migration_status":"Success","card_number_masked":"4111111 xxxx 1111","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null}] Things to verify in DB 1. `connector_mandate_details` for a given payment_method_id in response has connector_mandate_id for multiple MCAs <img width="421" alt="Screenshot 2025-06-28 at 3 09 18 PM" src="https://github.com/user-attachments/assets/8cfe8449-5ed1-441e-bd77-26540d5b6531" /> 2. `connector_customer` for a given customer_id in response has mappings for multiple MCAs <img width="748" alt="Screenshot 2025-06-28 at 3 09 41 PM" src="https://github.com/user-attachments/assets/dec23184-8014-4d8c-91b4-369ec6670e22" /> </details> <details> <summary>2. Batch migration for a single profile - For ensuring backwards compatibility</summary> cURL curl --location --request POST 'http://localhost:8080/payment_methods/migrate-batch' \ --header 'api-key: test_admin' \ --form 'merchant_id="merchant_1751020165"' \ --form 'merchant_connector_id="mca_lwpasOxD1FtFmG4SVdjX"' \ --form 'file=@"migrate.csv"' Response [{"line_number":1,"payment_method_id":"pm_ZGPPsRrU5f4IgVpMS9tj","payment_method":"card","payment_method_type":"debit","customer_id":"45CC60D1F2283097BB1DE41A2636414445908518D50B8B4CDC57959CD7FB4539","migration_status":"Success","card_number_masked":"4360000 xxxx 0005","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":2,"payment_method_id":"pm_Lf2vcheQkYIiZx8PIDHt","payment_method":"card","payment_method_type":"credit","customer_id":"782BC898951D910C1A99DA69A4E4FAD6CEE53AB9311FA2C552028DA89428DB7F","migration_status":"Success","card_number_masked":"4111111 xxxx 1111","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null}] Things to verify in DB - PM migration happens for a single MCA (connector_mandate_details) - Customer migration happens for a single MCA (connector_customer) </details> Sample migration data for multi profile migration [multi-migrate-sample.csv](https://github.com/user-attachments/files/20974125/multi-migrate-sample.csv) ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.114.0	6c66c36a66b6644c43761b7ac9c1326945a6a820	6c66c36a66b6644c43761b7ac9c1326945a6a820
juspay/hyperswitch	juspay__hyperswitch-8442	Bug: [FEATURE] Add x-mcp extension to OpenAPI schema Mintlify supports extracting API endpoints from openAPI json into MCP servers: https://mintlify.com/docs/mcp We need to add: ```json "x-mcp": { "enabled": true }, ``` at the top level of our OpenAPI schema to enable this functionality	diff --git a/README.md b/README.md index a46baab5244..35964d72bf5 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ <a href="https://x.com/hyperswitchio"> <img src="https://img.shields.io/badge/follow-%40hyperswitchio-white?logo=x&labelColor=grey"/> </a> - <a href="https://join.slack.com/t/hyperswitch-io/shared_invite/zt-2jqxmpsbm-WXUENx022HjNEy~Ark7Orw"> + <a href="https://inviter.co/hyperswitch-slack"> <img src="https://img.shields.io/badge/chat-on_slack-blue?logo=slack&labelColor=grey&color=%233f0e40"/> </a> </p> @@ -196,7 +196,7 @@ We welcome contributors from around the world to help build Hyperswitch. Whether Please read our [contributing guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) to get started. -Join the conversation on [Slack](https://join.slack.com/t/hyperswitch-io/shared_invite/zt-2jqxmpsbm-WXUENx022HjNEy~Ark7Orw) or explore open issues on [GitHub](https://github.com/juspay/hyperswitch/issues). +Join the conversation on [Slack](https://inviter.co/hyperswitch-slack) or explore open issues on [GitHub](https://github.com/juspay/hyperswitch/issues). <a href="#feature-requests"> <h2 id="feature-requests">Feature requests & Bugs</h2> diff --git a/api-reference/v1/openapi_spec_v1.json b/api-reference/v1/openapi_spec_v1.json index 6045147a050..c4601519965 100644 --- a/api-reference/v1/openapi_spec_v1.json +++ b/api-reference/v1/openapi_spec_v1.json @@ -1,5 +1,8 @@ { "openapi": "3.0.3", + "x-mcp": { + "enabled": true + }, "info": { "title": "Hyperswitch - API Documentation", "description": "\n## Get started\n\nHyperswitch provides a collection of APIs that enable you to process and manage payments.\nOur APIs accept and return JSON in the HTTP body, and return standard HTTP response codes.\n\nYou can consume the APIs directly using your favorite HTTP/REST library.\n\nWe have a testing environment referred to \"sandbox\", which you can setup to test API calls without\naffecting production data.\nCurrently, our sandbox environment is live while our production environment is under development\nand will be available soon.\nYou can sign up on our Dashboard to get API keys to access Hyperswitch API.\n\n### Environment\n\nUse the following base URLs when making requests to the APIs:\n\n\| Environment \| Base URL \|\n\|---------------\|------------------------------------\|\n\| Sandbox \| <https://sandbox.hyperswitch.io> \|\n\| Production \| <https://api.hyperswitch.io> \|\n\n## Authentication\n\nWhen you sign up on our [dashboard](https://app.hyperswitch.io) and create a merchant\naccount, you are given a secret key (also referred as api-key) and a publishable key.\nYou may authenticate all API requests with Hyperswitch server by providing the appropriate key in\nthe request Authorization header.\n\n\| Key \| Description \|\n\|-----------------\|-----------------------------------------------------------------------------------------------\|\n\| api-key \| Private key. Used to authenticate all API requests from your merchant server \|\n\| publishable key \| Unique identifier for your account. Used to authenticate API requests from your app's client \|\n\nNever share your secret api keys. Keep them guarded and secure.\n", diff --git a/api-reference/v1/payments/payment--flows.mdx b/api-reference/v1/payments/payment--flows.mdx index eff90a0dcb8..9338f835f38 100644 --- a/api-reference/v1/payments/payment--flows.mdx +++ b/api-reference/v1/payments/payment--flows.mdx @@ -226,7 +226,9 @@ sequenceDiagram Required Fields: - `off_session: true` -- `recurring_details: { payment_method_id: "<from_setup>" }` +- `recurring_details: { + "type": "payment_method_id", + "data": "<from_setup>"}` Use Case: Subscription charges, scheduled billing without customer interaction diff --git a/crates/openapi/src/main.rs b/crates/openapi/src/main.rs index cf8158cfb02..d25b24442df 100644 --- a/crates/openapi/src/main.rs +++ b/crates/openapi/src/main.rs @@ -29,13 +29,33 @@ fn main() { #[allow(clippy::expect_used)] #[cfg(any(feature = "v1", feature = "v2"))] std::fs::write( - file_path, + &file_path, openapi .to_pretty_json() .expect("Failed to serialize OpenAPI specification as JSON"), ) .expect("Failed to write OpenAPI specification to file"); + #[allow(clippy::expect_used)] + #[cfg(feature = "v1")] + { + // TODO: Do this using utoipa::extensions after we have upgraded to 5.x + let file_content = + std::fs::read_to_string(&file_path).expect("Failed to read OpenAPI specification file"); + + let mut lines: Vec<&str> = file_content.lines().collect(); + + // Insert the new text at line 3 (index 2) + if lines.len() > 2 { + let new_line = " \"x-mcp\": {\n \"enabled\": true\n },"; + lines.insert(2, new_line); + } + + let modified_content = lines.join("\n"); + std::fs::write(&file_path, modified_content) + .expect("Failed to write modified OpenAPI specification to file"); + } + #[cfg(any(feature = "v1", feature = "v2"))] println!("Successfully saved OpenAPI specification file at '{relative_file_path}'");	2025-06-24T09:35:51Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [x] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> Modified `openapi/src/main.rs` to append `x-mcp` extension to v1 OpenAPI schema ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> Closes #8442 ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> Verified using: `mintlify openapi-check api-reference/v1/openapi_spec_v1.json` Tested mintlify's mcp server generation functionality by deploying the updated OpenAPI spec file on a custom mintlify account. Used the generated mcp server to do payments - create in cursor. ![image](https://github.com/user-attachments/assets/1a6e37a3-a682-4b84-9cd7-1292f3ed1787) ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.114.0	bc767b9131e2637ce90997da9018085d2dadb80b	bc767b9131e2637ce90997da9018085d2dadb80b
juspay/hyperswitch	juspay__hyperswitch-8445	Bug: fix(recovery) : Populate connector request reference id in revenue recovery record attempt flow. Previously there was no restriction in confirmData to connector request reference id to be mandatory. Recovery internally uses proxy flow, which internally uses confirmData where connector request reference id was hardcoded to none.	diff --git a/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs b/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs index c35fbc3163e..86821bfe6ef 100644 --- a/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs +++ b/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs @@ -646,7 +646,6 @@ impl PaymentAttempt { let payment_method_type_data = payment_intent.get_payment_method_type(); let payment_method_subtype_data = payment_intent.get_payment_method_sub_type(); - let authentication_type = payment_intent.authentication_type.unwrap_or_default(); Ok(Self { payment_id: payment_intent.id.clone(), @@ -752,7 +751,10 @@ impl PaymentAttempt { .as_ref() .map(\|txn_id\| txn_id.get_id().clone()); let connector = request.connector.map(\|connector\| connector.to_string()); - + let connector_request_reference_id = payment_intent + .merchant_reference_id + .as_ref() + .map(\|id\| id.get_string_repr().to_owned()); Ok(Self { payment_id: payment_intent.id.clone(), merchant_id: payment_intent.merchant_id.clone(), @@ -804,7 +806,7 @@ impl PaymentAttempt { charges: None, processor_merchant_id: payment_intent.merchant_id.clone(), created_by: None, - connector_request_reference_id: None, + connector_request_reference_id, }) } diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs index 59de54f41fa..2f70a79ec87 100644 --- a/crates/router/src/core/payments.rs +++ b/crates/router/src/core/payments.rs @@ -4042,6 +4042,16 @@ where ) .await?, )); + operation + .to_domain()? + .populate_payment_data( + state, + payment_data, + merchant_context, + business_profile, + &connector, + ) + .await?; let mut router_data = payment_data .construct_router_data( diff --git a/crates/router/src/core/payments/operations/proxy_payments_intent.rs b/crates/router/src/core/payments/operations/proxy_payments_intent.rs index 838cbf9dedf..a65f4cdd99e 100644 --- a/crates/router/src/core/payments/operations/proxy_payments_intent.rs +++ b/crates/router/src/core/payments/operations/proxy_payments_intent.rs @@ -6,6 +6,7 @@ use error_stack::ResultExt; use hyperswitch_domain_models::{ payment_method_data::PaymentMethodData, payments::PaymentConfirmData, }; +use hyperswitch_interfaces::api::ConnectorSpecifications; use masking::PeekInterface; use router_env::{instrument, tracing}; @@ -15,7 +16,7 @@ use crate::{ errors::{self, CustomResult, RouterResult, StorageErrorExt}, payments::{ operations::{self, ValidateStatusForOperation}, - OperationSessionGetters, + OperationSessionGetters, OperationSessionSetters, }, }, routes::{app::ReqState, SessionState}, @@ -303,6 +304,24 @@ impl<F: Clone + Send + Sync> Domain<F, ProxyPaymentsRequest, PaymentConfirmData< )> { Ok((Box::new(self), None, None)) } + #[instrument(skip_all)] + async fn populate_payment_data<'a>( + &'a self, + _state: &SessionState, + payment_data: &mut PaymentConfirmData<F>, + _merchant_context: &domain::MerchantContext, + _business_profile: &domain::Profile, + connector_data: &api::ConnectorData, + ) -> CustomResult<(), errors::ApiErrorResponse> { + let connector_request_reference_id = connector_data + .connector + .generate_connector_request_reference_id( + &payment_data.payment_intent, + &payment_data.payment_attempt, + ); + payment_data.set_connector_request_reference_id(Some(connector_request_reference_id)); + Ok(()) + } async fn perform_routing<'a>( &'a self, diff --git a/crates/router/src/routes/payments.rs b/crates/router/src/routes/payments.rs index 020a1fbf713..e2363633dad 100644 --- a/crates/router/src/routes/payments.rs +++ b/crates/router/src/routes/payments.rs @@ -232,7 +232,7 @@ pub async fn payments_get_intent( header_payload.clone(), ) }, - auth::api_or_client_auth( + auth::api_or_client_or_jwt_auth( &auth::V2ApiKeyAuth { is_connected_allowed: false, is_platform_allowed: false, @@ -240,6 +240,9 @@ pub async fn payments_get_intent( &auth::V2ClientAuth(common_utils::types::authentication::ResourceId::Payment( global_payment_id.clone(), )), + &auth::JWTAuth { + permission: Permission::ProfileRevenueRecoveryRead, + }, req.headers(), ), api_locking::LockAction::NotApplicable, diff --git a/crates/router/src/services/authentication.rs b/crates/router/src/services/authentication.rs index 41b7bd3d87b..d16063939a1 100644 --- a/crates/router/src/services/authentication.rs +++ b/crates/router/src/services/authentication.rs @@ -2698,7 +2698,27 @@ where api_auth } } - +#[cfg(feature = "v2")] +pub fn api_or_client_or_jwt_auth<'a, T, A>( + api_auth: &'a dyn AuthenticateAndFetch<T, A>, + client_auth: &'a dyn AuthenticateAndFetch<T, A>, + jwt_auth: &'a dyn AuthenticateAndFetch<T, A>, + headers: &HeaderMap, +) -> &'a dyn AuthenticateAndFetch<T, A> +where +{ + if let Ok(val) = HeaderMapStruct::new(headers).get_auth_string_from_header() { + if val.trim().starts_with("api-key=") { + api_auth + } else if is_jwt_auth(headers) { + jwt_auth + } else { + client_auth + } + } else { + api_auth + } +} #[derive(Debug)] pub struct PublishableKeyAuth;	2025-06-23T13:31:41Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [x] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> Previously there was no restriction in confirmData to connector request reference id to be mandatory. Recovery internally uses proxy flow, which internally uses confirmData where connector request reference id was hardcoded to none. This Pr adds supports to generate connector request reference to merchant reference id. This Pr also has changes of adding support for jwt auth to payment get for dashboard use case. Previously payment sync was used in dashboard to retrieve payment details, but this would fail now in v2 because if there are no attempts created payment get would return 4xx since active attempt is mandotory. To solve this now dashboard is relying on payment get and payment get attempt list api's . ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> Test case 1 : step 1 : create a profile in hyperswitch and wait for 8 mins to move it from monitering to cascading , this would only get updated when webhooks are triggered . step 2 : create payment mca ``` curl --location 'http://localhost:8080/v2/connector-accounts' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'x-merchant-id: test_seller_AGZCJiHwUNV1seyoepOE' \ --header 'x-profile-id: pro_kYmv4lQjIZFbAqoOVY4M' \ --header 'Authorization: admin-api-key=test_admin' \ --data '{ "connector_type": "payment_processor", "connector_name": "stripe", "connector_account_details": { "auth_type": "HeaderKey", "api_key": "stripe-api-key" }, "profile_id": "pro_kYmv4lQjIZFbAqoOVY4M" }' ``` step 4 : configure stripe billing connector. ``` curl --location 'http://localhost:8080/v2/connector-accounts' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'x-merchant-id: test_seller_AGZCJiHwUNV1seyoepOE' \ --header 'x-profile-id: pro_kYmv4lQjIZFbAqoOVY4M' \ --header 'Authorization: admin-api-key=test_admin' \ --data '{ "connector_type": "billing_processor", "connector_name": "stripebilling", "connector_account_details": { "auth_type": "HeaderKey", "api_key": "{{stripe-api-key}}" }, "connector_webhook_details": { "merchant_secret": "{{stripe-webhook-key}}", "additional_secret": "password" }, "feature_metadata": { "revenue_recovery": { "max_retry_count": 7, "billing_connector_retry_threshold": 2, "billing_account_reference": { "{{payment_connector_mca_created_in_last_step}}": "stripebilling" } } }, "profile_id": "pro_kYmv4lQjIZFbAqoOVY4M" }' ``` step 5 : Trigger failed invoice from stripe billing by creating new subscription and move the test clock to 1 week. This would trigger few external payments. once it exhausts retry threshold it will create process tracker entry. Follwed by 2 mins it would create all retries by hyperswitch as shown below. <img width="935" alt="Screenshot 2025-06-23 at 7 00 57 PM" src="https://github.com/user-attachments/assets/d51d3d9e-82ff-4385-b318-dbb37230cee8" /> ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.114.0	6fd7626c99e006bb7dcac864c30299bb8ef1d742	6fd7626c99e006bb7dcac864c30299bb8ef1d742
juspay/hyperswitch	juspay__hyperswitch-8460	Bug: [BUG] DB constraints for events table ### Bug Description `idempotent_event_id` column is a combination of `payment_id` and the `event_type`. Length of this field in DB can be a maximum of 64 characters. However, since `payment_id` can also be 64 characters, the resulting `idempotent_event_id` can easily exceed 64 characters leading to inconsistent behavior in the flows. Currently, this is breaking outgoing webhooks flow. ### Expected Behavior Outgoing webhooks flow should succeed. ### Actual Behavior Outgoing webhooks flow breaks due to DB constraints. ``` { "message": "[INCOMING_WEBHOOKS_CORE - EVENT] Incoming webhook flow failed", "extra": { "error": "{\"error\":{\"type\":\"router_error\",\"code\":\"WE_03\",\"message\":\"There was some issue processing the webhook\"}}\\n├╴at crates/router/src/core/webhooks/outgoing.rs:196:18\\n├╴Failed to insert event in events table\\n├╴Incoming webhook flow for payments failed\\n│\\n╰─▶ DatabaseError: An unknown error occurred\\n ├╴at /router/crates/diesel_models/src/query/generics.rs:89:36\\n ├╴Error while inserting EventNew { event_id: \"evt_01979b2125017d93bb4d846d42979839\", event_type: PaymentAuthorized, event_class: Payments, is_webhook_notified: false, primary_object_id: \"AFR_202506237e491a4f-1bd8-4d97-a9a6-a2f86832bc79\", primary_object_type: PaymentDetails, created_at: 2025-06-23 4:52:10.113410262, merchant_id: Some(MerchantId(\"merchant_1741787326\")), business_profile_id: Some(ProfileId(\"pro_r3uCseg4NT35RBFpmUPA\")), primary_object_created_at: Some(2025-06-23 4:51:14.154239), idempotent_event_id: Some(\"AFR_202506237e491a4f-1bd8-4d97-a9a6-a2f86832bc79_payment_authorized\"), initial_attempt_id: Some(\"evt_01979b2125017d93bb4d846d42979839\"), request: Some(Encryption { inner: * Encrypted data of length 7223 bytes * }), response: None, delivery_attempt: Some(InitialAttempt), metadata: Some(Payment { payment_id: PaymentId(\"AFR_202506237e491a4f-1bd8-4d97-a9a6-a2f86832bc79\") }), is_overall_delivery_successful: Some(false) }\\n │\\n ╰─▶ value too long for type character varying(64)\\n ╰╴at /router/crates/diesel_models/src/query/generics.rs:89:22\\n ╰╴at crates/router/src/db/events.rs:129:30" } } ``` ### Steps To Reproduce -- ### Context For The Bug -- ### Environment -- ### Have you spent some time checking if this bug has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? None	diff --git a/crates/common_utils/src/consts.rs b/crates/common_utils/src/consts.rs index 59ec5377690..bbb65e1afc6 100644 --- a/crates/common_utils/src/consts.rs +++ b/crates/common_utils/src/consts.rs @@ -97,6 +97,11 @@ pub const BASE64_ENGINE: base64::engine::GeneralPurpose = base64::engine::genera /// URL Safe base64 engine pub const BASE64_ENGINE_URL_SAFE: base64::engine::GeneralPurpose = base64::engine::general_purpose::URL_SAFE; + +/// URL Safe base64 engine without padding +pub const BASE64_ENGINE_URL_SAFE_NO_PAD: base64::engine::GeneralPurpose = + base64::engine::general_purpose::URL_SAFE_NO_PAD; + /// Regex for matching a domain /// Eg - /// http://www.example.com diff --git a/crates/router/src/core/errors.rs b/crates/router/src/core/errors.rs index bf5330a9325..a980bb664ef 100644 --- a/crates/router/src/core/errors.rs +++ b/crates/router/src/core/errors.rs @@ -157,6 +157,8 @@ pub enum WebhooksFlowError { OutgoingWebhookRetrySchedulingFailed, #[error("Outgoing webhook response encoding failed")] OutgoingWebhookResponseEncodingFailed, + #[error("ID generation failed")] + IdGenerationFailed, } impl WebhooksFlowError { @@ -174,7 +176,8 @@ impl WebhooksFlowError { \| Self::DisputeWebhookValidationFailed \| Self::OutgoingWebhookEncodingFailed \| Self::OutgoingWebhookProcessTrackerTaskUpdateFailed - \| Self::OutgoingWebhookRetrySchedulingFailed => true, + \| Self::OutgoingWebhookRetrySchedulingFailed + \| Self::IdGenerationFailed => true, } } } diff --git a/crates/router/src/core/webhooks/outgoing.rs b/crates/router/src/core/webhooks/outgoing.rs index 34b49c2fc8a..adc54b09b94 100644 --- a/crates/router/src/core/webhooks/outgoing.rs +++ b/crates/router/src/core/webhooks/outgoing.rs @@ -60,7 +60,9 @@ pub(crate) async fn create_event_and_trigger_outgoing_webhook( ) -> CustomResult<(), errors::ApiErrorResponse> { let delivery_attempt = enums::WebhookDeliveryAttempt::InitialAttempt; let idempotent_event_id = - utils::get_idempotent_event_id(&primary_object_id, event_type, delivery_attempt); + utils::get_idempotent_event_id(&primary_object_id, event_type, delivery_attempt) + .change_context(errors::ApiErrorResponse::WebhookProcessingFailure) + .attach_printable("Failed to generate idempotent event ID")?; let webhook_url_result = get_webhook_url_from_business_profile(&business_profile); if !state.conf.webhooks.outgoing_enabled diff --git a/crates/router/src/core/webhooks/outgoing_v2.rs b/crates/router/src/core/webhooks/outgoing_v2.rs index 07758817e68..d0e0ecaa69a 100644 --- a/crates/router/src/core/webhooks/outgoing_v2.rs +++ b/crates/router/src/core/webhooks/outgoing_v2.rs @@ -48,7 +48,9 @@ pub(crate) async fn create_event_and_trigger_outgoing_webhook( ) -> CustomResult<(), errors::ApiErrorResponse> { let delivery_attempt = enums::WebhookDeliveryAttempt::InitialAttempt; let idempotent_event_id = - utils::get_idempotent_event_id(&primary_object_id, event_type, delivery_attempt); + utils::get_idempotent_event_id(&primary_object_id, event_type, delivery_attempt) + .change_context(errors::ApiErrorResponse::WebhookProcessingFailure) + .attach_printable("Failed to generate idempotent event ID")?; let webhook_url_result = business_profile .get_webhook_url_from_profile() .change_context(errors::WebhooksFlowError::MerchantWebhookUrlNotConfigured); diff --git a/crates/router/src/core/webhooks/utils.rs b/crates/router/src/core/webhooks/utils.rs index 45b6c24a2ed..0344d7d010e 100644 --- a/crates/router/src/core/webhooks/utils.rs +++ b/crates/router/src/core/webhooks/utils.rs @@ -1,6 +1,12 @@ use std::marker::PhantomData; -use common_utils::{errors::CustomResult, ext_traits::ValueExt}; +use base64::Engine; +use common_utils::{ + consts, + crypto::{self, GenerateDigest}, + errors::CustomResult, + ext_traits::ValueExt, +}; use error_stack::{Report, ResultExt}; use redis_interface as redis; use router_env::tracing; @@ -146,18 +152,28 @@ pub(crate) fn get_idempotent_event_id( primary_object_id: &str, event_type: types::storage::enums::EventType, delivery_attempt: types::storage::enums::WebhookDeliveryAttempt, -) -> String { +) -> Result<String, Report<errors::WebhooksFlowError>> { use crate::types::storage::enums::WebhookDeliveryAttempt; const EVENT_ID_SUFFIX_LENGTH: usize = 8; let common_prefix = format!("{primary_object_id}_{event_type}"); - match delivery_attempt { - WebhookDeliveryAttempt::InitialAttempt => common_prefix, + + // Hash the common prefix with SHA256 and encode with URL-safe base64 without padding + let digest = crypto::Sha256 + .generate_digest(common_prefix.as_bytes()) + .change_context(errors::WebhooksFlowError::IdGenerationFailed) + .attach_printable("Failed to generate idempotent event ID")?; + let base_encoded = consts::BASE64_ENGINE_URL_SAFE_NO_PAD.encode(digest); + + let result = match delivery_attempt { + WebhookDeliveryAttempt::InitialAttempt => base_encoded, WebhookDeliveryAttempt::AutomaticRetry \| WebhookDeliveryAttempt::ManualRetry => { - common_utils::generate_id(EVENT_ID_SUFFIX_LENGTH, &common_prefix) + common_utils::generate_id(EVENT_ID_SUFFIX_LENGTH, &base_encoded) } - } + }; + + Ok(result) } #[inline] diff --git a/crates/router/src/core/webhooks/webhook_events.rs b/crates/router/src/core/webhooks/webhook_events.rs index 44ce4fdd515..700295af0ec 100644 --- a/crates/router/src/core/webhooks/webhook_events.rs +++ b/crates/router/src/core/webhooks/webhook_events.rs @@ -287,7 +287,9 @@ pub async fn retry_delivery_attempt( &event_to_retry.primary_object_id, event_to_retry.event_type, delivery_attempt, - ); + ) + .change_context(errors::ApiErrorResponse::WebhookProcessingFailure) + .attach_printable("Failed to generate idempotent event ID")?; let now = common_utils::date_time::now(); let new_event = domain::Event { diff --git a/crates/router/src/workflows/outgoing_webhook_retry.rs b/crates/router/src/workflows/outgoing_webhook_retry.rs index 559f62b1a4a..d84f0b26dc7 100644 --- a/crates/router/src/workflows/outgoing_webhook_retry.rs +++ b/crates/router/src/workflows/outgoing_webhook_retry.rs @@ -72,7 +72,9 @@ impl ProcessTrackerWorkflow<SessionState> for OutgoingWebhookRetryWorkflow { &tracking_data.primary_object_id, tracking_data.event_type, delivery_attempt, - ); + ) + .change_context(errors::ApiErrorResponse::WebhookProcessingFailure) + .attach_printable("Failed to generate idempotent event ID")?; let initial_event = match &tracking_data.initial_attempt_id { Some(initial_attempt_id) => {	2025-09-16T13:24:24Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [x] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> This change updates the idempotent_event_id generation to first hash the base string with SHA256 and then encode it using URL-safe Base64 without padding. By doing this, the generated IDs are guaranteed to be short and deterministic, ensuring they always fit within the 64-character database column limit. This fix addresses the issue where long payment_ids combined with event types were exceeding the DB constraint and breaking the outgoing webhooks flow. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> The idempotent_event_id column is a combination of payment_id and event_type. The DB column length is limited to 64 characters. Since payment_id itself can be up to 64 characters long, appending event_type causes the field to exceed the limit, leading to database constraint violations. Currently, this breaks the outgoing webhooks flow. Additionally, during staggered deployments and rollback, the uniqueness of these IDs may cause dual webhook dispatches. closes #8460 ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> 1. Started the local Node.js Express webhook listener on port 3000 using the server.js script. <details> <summary>server.js script</summary> ``` mkdir -p /tmp/hs-webhooks && cd /tmp/hs-webhooks npm init -y >/dev/null npm i express >/dev/null cat > server.js <<'JS' const express = require('express'); const app = express(); app.use(express.json({ type: '/' })); app.post('/webhooks/hs', (req, res) => { console.log('---- Webhook received ----'); console.log('Headers:', req.headers); console.log('Body:', JSON.stringify(req.body, null, 2)); res.sendStatus(200); }); app.listen(3000, () => console.log('Webhook listener running on port 3000')); JS node server.js ``` </details> 2. Merchant Creation <details> <summary>Merchant creation Curl</summary> ```bash curl --location 'http://localhost:8080/accounts' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: test_admin' \ --data-raw '{ "merchant_id": "merchant_1758029612", "locker_id": "m0010", "merchant_name": "worldpay", "merchant_details": { "primary_contact_person": "John Test", "primary_email": "[email protected]", "primary_phone": "sunt laborum", "secondary_contact_person": "John Test2", "secondary_email": "[email protected]", "secondary_phone": "cillum do dolor id", "website": "https://www.example.com", "about_business": "Online Retail with a wide selection of organic products for North America", "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name":"john", "last_name":"Doe" } }, "return_url": "https://google.com/success", "webhook_details": { "webhook_version": "1.0.1", "webhook_username": "ekart_retail", "webhook_password": "password_ekart@123", "webhook_url":"http://localhost:3000/webhooks/hs", "payment_created_enabled": true, "payment_succeeded_enabled": true, "payment_failed_enabled": true }, "sub_merchants_enabled": false, "parent_merchant_id":"merchant_123", "metadata": { "city": "NY", "unit": "245", "merchant_name": "Acme Widgets LLC" }, "primary_business_details": [ { "country": "US", "business": "default" } ] }' ``` </details> After this when i created payment it created event with these idempotent_event_id. <img width="533" height="165" alt="image" src="https://github.com/user-attachments/assets/6610ede4-6ffe-4de1-bde3-664ac00abec4" /> <details> <summary>Manual Retry Curl</summary> ``` curl --location --request POST 'http://localhost:8080/events/merchant_1758190753/evt_01995ce5346575608391d7f8b825175d/retry' \ --header 'api-key: test_admin' ``` </details> <img width="559" height="252" alt="image" src="https://github.com/user-attachments/assets/cb652d7b-5749-48f0-b2f7-78726411e789" /> For primary object id greater than 64 chars still generated idempotent_event_id will always be less than 64 characters in length. <img width="831" height="33" alt="image" src="https://github.com/user-attachments/assets/3d7b838a-df61-401e-ac2c-fd7e5cd5b4c8" /> ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.117.0	f3ab3d63f69279af9254f15eba5654c0680a0747	f3ab3d63f69279af9254f15eba5654c0680a0747
juspay/hyperswitch	juspay__hyperswitch-8449	Bug: remove frm rule migration support as it is not supported in DE	diff --git a/crates/router/src/core/routing.rs b/crates/router/src/core/routing.rs index b52fc966721..0d34986c838 100644 --- a/crates/router/src/core/routing.rs +++ b/crates/router/src/core/routing.rs @@ -2483,11 +2483,6 @@ pub async fn migrate_rules_for_profile( .attach_printable("Failed to get payout routing algorithm")? .unwrap_or_default() .algorithm_id, - business_profile - .get_frm_routing_algorithm() - .attach_printable("Failed to get frm routing algorithm")? - .unwrap_or_default() - .algorithm_id, ]; #[cfg(feature = "v2")]	2025-06-24T10:58:00Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [X] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> As FRM routing is not supported in DE we can remove support for it from DE migration endpoint ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> Compilation and cypress is working as expected. ## Checklist <!-- Put an `x` in the boxes that apply --> - [ ] I formatted the code `cargo +nightly fmt --all` - [ ] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.114.0	bc767b9131e2637ce90997da9018085d2dadb80b	bc767b9131e2637ce90997da9018085d2dadb80b
juspay/hyperswitch	juspay__hyperswitch-8440	Bug: [FEATURE] Implement V2 UCS (Unified Connector Service) Integration for Authorization Flow ### Feature Description # [Feature Request] Implement V2 UCS (Unified Connector Service) Integration for Authorization Flow ## Issue Type - [x] Feature Request - [ ] Bug Report - [ ] Enhancement - [ ] Documentation ## Priority - [x] High - [ ] Medium - [ ] Low ## Labels `A-core` `C-feature` `payment-flows` `ucs-integration` `v2-api` ## Summary Implement V2 UCS (Unified Connector Service) integration for the authorization payment flow, upgrading from the existing V1 UCS integration to support the updated gRPC schema and enhanced V2 payment architecture. ## Background Currently, Hyperswitch has V1 UCS integration that works with the legacy gRPC schema. However, the UCS service has evolved to V2 with improved: - Enhanced gRPC schema with better type safety - Improved field structures for card details, addresses, and identifiers - Better error handling and response parsing - Enhanced payment method data transformation ## Problem Statement ### Current State - V1 UCS integration uses outdated `PaymentsAuthorizeRequest` schema - Limited support for V2 payment flow architecture - Outdated transformer implementations for V2 data structures - Monolithic UCS function structure affecting maintainability ### Pain Points 1. Schema Incompatibility: V1 gRPC schema doesn't support V2 enhanced data models 2. Limited Error Handling: V1 response parsing lacks V2 identifier structure support 3. Technical Debt: Monolithic UCS functions make debugging and enhancement difficult 4. Missing V2 Features: Cannot leverage V2 payment flow improvements through UCS ### Possible Implementation ## Proposed Solution ### High-Level Approach Implement V2 UCS integration that: 1. Updates gRPC Schema: Migrate to `PaymentServiceAuthorizeRequest` with V2 field structure 2. Enhances Architecture: Refactor payment flow with better separation of concerns 3. Improves Transformers: Update V2 transformers for new schema compatibility 4. Maintains Backward Compatibility: Preserve V1 integration with feature flag separation ### Technical Requirements #### 1. gRPC Schema Migration - [ ] Update `rust-grpc-client` dependency to latest version - [ ] Migrate from `PaymentsAuthorizeRequest` to `PaymentServiceAuthorizeRequest` - [ ] Update authentication headers and request metadata handling - [ ] Implement new identifier structure for response parsing #### 2. Payment Flow Architecture - [ ] Refactor `call_connector_service()` into separate prerequisite and decision functions - [ ] Implement `call_connector_service_prerequisites()` for V2 flow preparation - [ ] Create `decide_unified_connector_service_call()` for UCS routing logic - [ ] Maintain feature flag separation between V1 and V2 implementations #### 3. V2 Transformer Enhancements - [ ] Update card data transformation for new schema structure - [ ] Enhance address handling with improved field mapping - [ ] Implement customer ID support in V2 transformers #### 4. Error Handling & Response Parsing - [ ] Update response handlers for new identifier structure - [ ] Enhance error context and fallback mechanisms - [ ] Maintain automatic fallback to traditional connector flow #### 5. Testing & Validation - [ ] Create comprehensive test cases for V2 UCS flow - [ ] Test schema compatibility and field mapping - [ ] Validate fallback mechanisms and error handling ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? Yes, I am willing to submit a PR!	diff --git a/Cargo.lock b/Cargo.lock index 848ccc6648f..f3ab37bbb5b 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1651,6 +1651,20 @@ dependencies = [ "thiserror 1.0.69", ] +[[package]] +name = "cargo_metadata" +version = "0.19.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dd5eb614ed4c27c5d706420e4320fbe3216ab31fa1c33cd8246ac36dae4479ba" +dependencies = [ + "camino", + "cargo-platform", + "semver 1.0.26", + "serde", + "serde_json", + "thiserror 2.0.12", +] + [[package]] name = "cast" version = "0.3.0" @@ -3347,13 +3361,18 @@ dependencies = [ [[package]] name = "g2h" -version = "0.2.0" +version = "0.4.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "312ad594dd0e3c26f860a52c8b703ab509c546931920f277f1afa9b7127fd755" +checksum = "0aece561ff748cdd2a37c8ee938a47bbf9b2c03823b393a332110599b14ee827" dependencies = [ + "cargo_metadata 0.19.2", "heck 0.5.0", + "proc-macro2", + "prost", "prost-build", + "prost-types", "quote", + "thiserror 2.0.12", "tonic-build", ] @@ -3506,7 +3525,7 @@ dependencies = [ [[package]] name = "grpc-api-types" version = "0.1.0" -source = "git+https://github.com/juspay/connector-service?rev=afaef3427f815befe253da152e5f37d3858bbc9f#afaef3427f815befe253da152e5f37d3858bbc9f" +source = "git+https://github.com/juspay/connector-service?rev=4918efedd5ea6c33e4a1600b988b2cf4948bed10#4918efedd5ea6c33e4a1600b988b2cf4948bed10" dependencies = [ "axum 0.8.4", "error-stack 0.5.0", @@ -6827,7 +6846,7 @@ dependencies = [ name = "router_env" version = "0.1.0" dependencies = [ - "cargo_metadata", + "cargo_metadata 0.18.1", "config", "error-stack 0.4.1", "gethostname", @@ -6880,7 +6899,7 @@ dependencies = [ [[package]] name = "rust-grpc-client" version = "0.1.0" -source = "git+https://github.com/juspay/connector-service?rev=afaef3427f815befe253da152e5f37d3858bbc9f#afaef3427f815befe253da152e5f37d3858bbc9f" +source = "git+https://github.com/juspay/connector-service?rev=4918efedd5ea6c33e4a1600b988b2cf4948bed10#4918efedd5ea6c33e4a1600b988b2cf4948bed10" dependencies = [ "grpc-api-types", ] @@ -9501,7 +9520,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "2990d9ea5967266ea0ccf413a4aa5c42a93dbcfda9cb49a97de6931726b12566" dependencies = [ "anyhow", - "cargo_metadata", + "cargo_metadata 0.18.1", "cfg-if 1.0.0", "git2", "regex", diff --git a/crates/external_services/Cargo.toml b/crates/external_services/Cargo.toml index 906f8e9b596..30ee8ee5a2c 100644 --- a/crates/external_services/Cargo.toml +++ b/crates/external_services/Cargo.toml @@ -53,7 +53,7 @@ reqwest = { version = "0.11.27", features = ["rustls-tls"] } http = "0.2.12" url = { version = "2.5.4", features = ["serde"] } quick-xml = { version = "0.31.0", features = ["serialize"] } -unified-connector-service-client = { git = "https://github.com/juspay/connector-service", rev = "afaef3427f815befe253da152e5f37d3858bbc9f", package = "rust-grpc-client" } +unified-connector-service-client = { git = "https://github.com/juspay/connector-service", rev = "4918efedd5ea6c33e4a1600b988b2cf4948bed10", package = "rust-grpc-client" } # First party crates diff --git a/crates/external_services/src/grpc_client/unified_connector_service.rs b/crates/external_services/src/grpc_client/unified_connector_service.rs index 0ad9602985d..5a4a912b798 100644 --- a/crates/external_services/src/grpc_client/unified_connector_service.rs +++ b/crates/external_services/src/grpc_client/unified_connector_service.rs @@ -84,6 +84,10 @@ pub enum UnifiedConnectorServiceError { /// Failed to perform Payment Authorize from gRPC Server #[error("Failed to perform Payment Authorize from gRPC Server")] PaymentAuthorizeFailure, + + /// Failed to perform Payment Get from gRPC Server + #[error("Failed to perform Payment Get from gRPC Server")] + PaymentGetFailure, } /// Result type for Dynamic Routing @@ -191,6 +195,28 @@ impl UnifiedConnectorServiceClient { .change_context(UnifiedConnectorServiceError::PaymentAuthorizeFailure) .inspect_err(\|error\| logger::error!(?error)) } + + /// Performs Payment Sync/Get + pub async fn payment_get( + &self, + payment_get_request: payments_grpc::PaymentServiceGetRequest, + connector_auth_metadata: ConnectorAuthMetadata, + grpc_headers: GrpcHeaders, + ) -> UnifiedConnectorServiceResult<tonic::Response<payments_grpc::PaymentServiceGetResponse>> + { + let mut request = tonic::Request::new(payment_get_request); + + let metadata = + build_unified_connector_service_grpc_headers(connector_auth_metadata, grpc_headers)?; + request.metadata_mut() = metadata; + + self.client + .clone() + .get(request) + .await + .change_context(UnifiedConnectorServiceError::PaymentGetFailure) + .inspect_err(\|error\| logger::error!(?error)) + } } /// Build the gRPC Headers for Unified Connector Service Request diff --git a/crates/hyperswitch_domain_models/src/merchant_connector_account.rs b/crates/hyperswitch_domain_models/src/merchant_connector_account.rs index 92ec2f51de2..1e460ee7306 100644 --- a/crates/hyperswitch_domain_models/src/merchant_connector_account.rs +++ b/crates/hyperswitch_domain_models/src/merchant_connector_account.rs @@ -163,7 +163,9 @@ impl MerchantConnectorAccountTypeDetails { Self::MerchantConnectorAccount(merchant_connector_account) => { Some(merchant_connector_account.connector_name) } - Self::MerchantConnectorDetails(_) => None, + Self::MerchantConnectorDetails(merchant_connector_details) => { + Some(merchant_connector_details.connector_name) + } } } diff --git a/crates/router/Cargo.toml b/crates/router/Cargo.toml index 585c49ffe18..8b80d22dc2a 100644 --- a/crates/router/Cargo.toml +++ b/crates/router/Cargo.toml @@ -88,7 +88,7 @@ reqwest = { version = "0.11.27", features = ["json", "rustls-tls", "gzip", "mult ring = "0.17.14" rust_decimal = { version = "1.37.1", features = ["serde-with-float", "serde-with-str"] } rust-i18n = { git = "https://github.com/kashif-m/rust-i18n", rev = "f2d8096aaaff7a87a847c35a5394c269f75e077a" } -unified-connector-service-client = { git = "https://github.com/juspay/connector-service", rev = "afaef3427f815befe253da152e5f37d3858bbc9f", package = "rust-grpc-client" } +unified-connector-service-client = { git = "https://github.com/juspay/connector-service", rev = "4918efedd5ea6c33e4a1600b988b2cf4948bed10", package = "rust-grpc-client" } rustc-hash = "1.1.0" rustls = "0.22" rustls-pemfile = "2" diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs index 8a0058b79e4..5319e823614 100644 --- a/crates/router/src/core/payments.rs +++ b/crates/router/src/core/payments.rs @@ -216,7 +216,27 @@ where let (payment_data, connector_response_data) = match connector { ConnectorCallType::PreDetermined(connector_data) => { - let router_data = call_connector_service( + let (mca_type_details, updated_customer, router_data) = + call_connector_service_prerequisites( + state, + req_state.clone(), + &merchant_context, + connector_data.connector_data.clone(), + &operation, + &mut payment_data, + &customer, + call_connector_action.clone(), + None, + header_payload.clone(), + None, + profile, + false, + false, //should_retry_with_pan is set to false in case of PreDetermined ConnectorCallType + req.should_return_raw_response(), + ) + .await?; + + let router_data = decide_unified_connector_service_call( state, req_state.clone(), &merchant_context, @@ -225,16 +245,17 @@ where &mut payment_data, &customer, call_connector_action.clone(), - None, + None, // schedule_time is not used in PreDetermined ConnectorCallType header_payload.clone(), #[cfg(feature = "frm")] None, - #[cfg(not(feature = "frm"))] - None, profile, false, false, //should_retry_with_pan is set to false in case of PreDetermined ConnectorCallType req.should_return_raw_response(), + mca_type_details, + router_data, + updated_customer, ) .await?; @@ -271,7 +292,28 @@ where ConnectorCallType::Retryable(connectors) => { let mut connectors = connectors.clone().into_iter(); let connector_data = get_connector_data(&mut connectors)?; - let router_data = call_connector_service( + + let (mca_type_details, updated_customer, router_data) = + call_connector_service_prerequisites( + state, + req_state.clone(), + &merchant_context, + connector_data.connector_data.clone(), + &operation, + &mut payment_data, + &customer, + call_connector_action.clone(), + None, + header_payload.clone(), + None, + profile, + false, + false, //should_retry_with_pan is set to false in case of Retryable ConnectorCallType + req.should_return_raw_response(), + ) + .await?; + + let router_data = decide_unified_connector_service_call( state, req_state.clone(), &merchant_context, @@ -280,16 +322,17 @@ where &mut payment_data, &customer, call_connector_action.clone(), - None, + None, // schedule_time is not used in Retryable ConnectorCallType header_payload.clone(), #[cfg(feature = "frm")] None, - #[cfg(not(feature = "frm"))] - None, profile, - false, + true, false, //should_retry_with_pan is set to false in case of PreDetermined ConnectorCallType req.should_return_raw_response(), + mca_type_details, + router_data, + updated_customer, ) .await?; @@ -409,17 +452,37 @@ where .get_connector_from_request(state, &req, &mut payment_data) .await?; - let router_data = internal_call_connector_service( + let merchant_connector_account = payment_data + .get_merchant_connector_details() + .map(domain::MerchantConnectorAccountTypeDetails::MerchantConnectorDetails) + .ok_or_else(\|\| { + error_stack::report!(errors::ApiErrorResponse::InternalServerError) + .attach_printable("Merchant connector details not found in payment data") + })?; + + operation + .to_domain()? + .populate_payment_data( + state, + &mut payment_data, + &merchant_context, + profile, + &connector_data, + ) + .await?; + + let router_data = connector_service_decider( state, req_state.clone(), &merchant_context, - connector_data, + connector_data.clone(), &operation, &mut payment_data, call_connector_action.clone(), header_payload.clone(), profile, req.should_return_raw_response(), + merchant_connector_account, ) .await?; @@ -3508,27 +3571,29 @@ where router_data = router_data.add_session_token(state, &connector).await?; - let mut should_continue_further = access_token::update_router_data_with_access_token_result( + let should_continue_further = access_token::update_router_data_with_access_token_result( &add_access_token_result, &mut router_data, &call_connector_action, ); - let add_create_order_result = router_data + let should_continue_further = match router_data .create_order_at_connector(state, &connector, should_continue_further) - .await?; + .await? + { + Some(create_order_response) => { + if let Ok(order_id) = create_order_response.clone().create_order_result { + payment_data.set_connector_response_reference_id(Some(order_id.clone())) + } - if add_create_order_result.is_create_order_performed { - if let Ok(order_id_opt) = &add_create_order_result.create_order_result { - payment_data.set_connector_response_reference_id(order_id_opt.clone()); + // Set the response in routerdata response to carry forward + router_data + .update_router_data_with_create_order_response(create_order_response.clone()); + create_order_response.create_order_result.ok().is_some() } - should_continue_further = router_data - .update_router_data_with_create_order_result( - add_create_order_result, - should_continue_further, - ) - .await?; - } + // If create order is not required, then we can proceed with further processing + None => true, + }; let updated_customer = call_create_connector_customer_if_required( state, @@ -3948,6 +4013,9 @@ pub async fn call_connector_service<F, RouterDReq, ApiRequest, D>( is_retry_payment: bool, should_retry_with_pan: bool, return_raw_connector_response: Option<bool>, + merchant_connector_account_type_details: domain::MerchantConnectorAccountTypeDetails, + mut router_data: RouterData<F, RouterDReq, router_types::PaymentsResponseData>, + updated_customer: Option<storage::CustomerUpdate>, ) -> RouterResult<RouterData<F, RouterDReq, router_types::PaymentsResponseData>> where F: Send + Clone + Sync, @@ -3961,50 +4029,6 @@ where dyn api::Connector: services::api::ConnectorIntegration<F, RouterDReq, router_types::PaymentsResponseData>, { - let stime_connector = Instant::now(); - - let merchant_connector_account = - domain::MerchantConnectorAccountTypeDetails::MerchantConnectorAccount(Box::new( - helpers::get_merchant_connector_account_v2( - state, - merchant_context.get_merchant_key_store(), - connector.merchant_connector_id.as_ref(), - ) - .await?, - )); - - operation - .to_domain()? - .populate_payment_data( - state, - payment_data, - merchant_context, - business_profile, - &connector, - ) - .await?; - - let updated_customer = call_create_connector_customer_if_required( - state, - customer, - merchant_context, - &merchant_connector_account, - payment_data, - ) - .await?; - - let mut router_data = payment_data - .construct_router_data( - state, - connector.connector.id(), - merchant_context, - customer, - &merchant_connector_account, - None, - None, - ) - .await?; - let add_access_token_result = router_data .add_access_token( state, @@ -4016,37 +4040,43 @@ where router_data = router_data.add_session_token(state, &connector).await?; - let mut should_continue_further = access_token::update_router_data_with_access_token_result( + let should_continue_further = access_token::update_router_data_with_access_token_result( &add_access_token_result, &mut router_data, &call_connector_action, ); - let add_create_order_result = router_data + let should_continue = match router_data .create_order_at_connector(state, &connector, should_continue_further) - .await?; + .await? + { + Some(create_order_response) => { + if let Ok(order_id) = create_order_response.clone().create_order_result { + payment_data.set_connector_response_reference_id(Some(order_id)) + } - if add_create_order_result.is_create_order_performed { - if let Ok(order_id_opt) = &add_create_order_result.create_order_result { - payment_data.set_connector_response_reference_id(order_id_opt.clone()); + // Set the response in routerdata response to carry forward + router_data + .update_router_data_with_create_order_response(create_order_response.clone()); + create_order_response.create_order_result.ok().map(\|_\| ()) } - should_continue_further = router_data - .update_router_data_with_create_order_result( - add_create_order_result, - should_continue_further, - ) - .await?; - } + // If create order is not required, then we can proceed with further processing + None => Some(()), + }; // In case of authorize flow, pre-task and post-tasks are being called in build request // if we do not want to proceed further, then the function will return Ok(None, false) - let (connector_request, should_continue_further) = if should_continue_further { - // Check if the actual flow specific request can be built with available data - router_data - .build_flow_specific_connector_request(state, &connector, call_connector_action.clone()) - .await? - } else { - (None, false) + let (connector_request, should_continue_further) = match should_continue { + Some(_) => { + router_data + .build_flow_specific_connector_request( + state, + &connector, + call_connector_action.clone(), + ) + .await? + } + None => (None, false), }; // Update the payment trackers just before calling the connector @@ -4089,18 +4119,14 @@ where Ok(router_data) }?; - let etime_connector = Instant::now(); - let duration_connector = etime_connector.saturating_duration_since(stime_connector); - tracing::info!(duration = format!("Duration taken: {}", duration_connector.as_millis())); - Ok(router_data) } -#[cfg(feature = "v1")] -// This function does not perform the tokenization action, as the payment method is not saved in this flow. +#[cfg(feature = "v2")] #[allow(clippy::too_many_arguments)] +#[allow(clippy::type_complexity)] #[instrument(skip_all)] -pub async fn proxy_for_call_connector_service<F, RouterDReq, ApiRequest, D>( +pub async fn call_connector_service_prerequisites<F, RouterDReq, ApiRequest, D>( state: &SessionState, req_state: ReqState, merchant_context: &domain::MerchantContext, @@ -4109,15 +4135,17 @@ pub async fn proxy_for_call_connector_service<F, RouterDReq, ApiRequest, D>( payment_data: &mut D, customer: &Option<domain::Customer>, call_connector_action: CallConnectorAction, - validate_result: &operations::ValidateResult, schedule_time: Option<time::PrimitiveDateTime>, header_payload: HeaderPayload, - + frm_suggestion: Option<storage_enums::FrmSuggestion>, business_profile: &domain::Profile, - return_raw_connector_response: Option<bool>, + is_retry_payment: bool, + should_retry_with_pan: bool, + all_keys_required: Option<bool>, ) -> RouterResult<( + domain::MerchantConnectorAccountTypeDetails, + Option<storage::CustomerUpdate>, RouterData<F, RouterDReq, router_types::PaymentsResponseData>, - helpers::MerchantConnectorAccountType, )> where F: Send + Clone + Sync, @@ -4131,145 +4159,354 @@ where dyn api::Connector: services::api::ConnectorIntegration<F, RouterDReq, router_types::PaymentsResponseData>, { - let stime_connector = Instant::now(); + let merchant_connector_account_type_details = + domain::MerchantConnectorAccountTypeDetails::MerchantConnectorAccount(Box::new( + helpers::get_merchant_connector_account_v2( + state, + merchant_context.get_merchant_key_store(), + connector.merchant_connector_id.as_ref(), + ) + .await?, + )); - let merchant_connector_account = construct_profile_id_and_get_mca( + operation + .to_domain()? + .populate_payment_data( + state, + payment_data, + merchant_context, + business_profile, + &connector, + ) + .await?; + + let updated_customer = call_create_connector_customer_if_required( state, + customer, merchant_context, + &merchant_connector_account_type_details, payment_data, - &connector.connector_name.to_string(), - connector.merchant_connector_id.as_ref(), - false, ) .await?; - if payment_data - .get_payment_attempt() - .merchant_connector_id - .is_none() - { - payment_data.set_merchant_connector_id_in_attempt(merchant_connector_account.get_mca_id()); - } - - let merchant_recipient_data = None; - - let mut router_data = payment_data + let router_data = payment_data .construct_router_data( state, connector.connector.id(), merchant_context, customer, - &merchant_connector_account, - merchant_recipient_data, + &merchant_connector_account_type_details, + None, None, ) .await?; - let add_access_token_result = router_data - .add_access_token( + Ok(( + merchant_connector_account_type_details, + updated_customer, + router_data, + )) +} + +#[cfg(feature = "v2")] +#[instrument(skip_all)] +pub async fn internal_call_connector_service_prerequisites<F, RouterDReq, ApiRequest, D>( + state: &SessionState, + merchant_context: &domain::MerchantContext, + connector: api::ConnectorData, + operation: &BoxedOperation<'_, F, ApiRequest, D>, + payment_data: &mut D, + business_profile: &domain::Profile, +) -> RouterResult<( + domain::MerchantConnectorAccountTypeDetails, + RouterData<F, RouterDReq, router_types::PaymentsResponseData>, +)> +where + F: Send + Clone + Sync, + RouterDReq: Send + Sync, + + // To create connector flow specific interface data + D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, + D: ConstructFlowSpecificData<F, RouterDReq, router_types::PaymentsResponseData>, + RouterData<F, RouterDReq, router_types::PaymentsResponseData>: Feature<F, RouterDReq> + Send, + // To construct connector flow specific api + dyn api::Connector: + services::api::ConnectorIntegration<F, RouterDReq, router_types::PaymentsResponseData>, +{ + let merchant_connector_details = + payment_data + .get_merchant_connector_details() + .ok_or_else(\|\| { + error_stack::report!(errors::ApiErrorResponse::InternalServerError) + .attach_printable("Merchant connector details not found in payment data") + })?; + let merchant_connector_account = + domain::MerchantConnectorAccountTypeDetails::MerchantConnectorDetails( + merchant_connector_details, + ); + + operation + .to_domain()? + .populate_payment_data( state, - &connector, + payment_data, merchant_context, - payment_data.get_creds_identifier(), + business_profile, + &connector, ) .await?; - router_data = router_data.add_session_token(state, &connector).await?; + let router_data = payment_data + .construct_router_data( + state, + connector.connector.id(), + merchant_context, + &None, + &merchant_connector_account, + None, + None, + ) + .await?; - let mut should_continue_further = access_token::update_router_data_with_access_token_result( - &add_access_token_result, - &mut router_data, - &call_connector_action, - ); + Ok((merchant_connector_account, router_data)) +} - (router_data, should_continue_further) = complete_preprocessing_steps_if_required( - state, - &connector, - payment_data, - router_data, - operation, - should_continue_further, - ) - .await?; +#[cfg(feature = "v2")] +#[allow(clippy::too_many_arguments)] +#[instrument(skip_all)] +pub async fn connector_service_decider<F, RouterDReq, ApiRequest, D>( + state: &SessionState, + req_state: ReqState, + merchant_context: &domain::MerchantContext, + connector: api::ConnectorData, + operation: &BoxedOperation<'_, F, ApiRequest, D>, + payment_data: &mut D, + call_connector_action: CallConnectorAction, + header_payload: HeaderPayload, + business_profile: &domain::Profile, + return_raw_connector_response: Option<bool>, + merchant_connector_account_type_details: domain::MerchantConnectorAccountTypeDetails, +) -> RouterResult<RouterData<F, RouterDReq, router_types::PaymentsResponseData>> +where + F: Send + Clone + Sync, + RouterDReq: Send + Sync, - if let Ok(router_types::PaymentsResponseData::PreProcessingResponse { - session_token: Some(session_token), - .. - }) = router_data.response.to_owned() - { - payment_data.push_sessions_token(session_token); - }; + // To create connector flow specific interface data + D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, + D: ConstructFlowSpecificData<F, RouterDReq, router_types::PaymentsResponseData>, + RouterData<F, RouterDReq, router_types::PaymentsResponseData>: Feature<F, RouterDReq> + Send, + // To construct connector flow specific api + dyn api::Connector: + services::api::ConnectorIntegration<F, RouterDReq, router_types::PaymentsResponseData>, +{ + let mut router_data = payment_data + .construct_router_data( + state, + connector.connector.id(), + merchant_context, + &None, + &merchant_connector_account_type_details, + None, + None, + ) + .await?; - let (connector_request, should_continue_further) = if should_continue_further { - // Check if the actual flow specific request can be built with available data - router_data - .build_flow_specific_connector_request(state, &connector, call_connector_action.clone()) + // do order creation + let should_call_unified_connector_service = + should_call_unified_connector_service(state, merchant_context, &router_data).await?; + + let (connector_request, should_continue_further) = if !should_call_unified_connector_service { + let mut should_continue_further = true; + + let should_continue = match router_data + .create_order_at_connector(state, &connector, should_continue_further) .await? + { + Some(create_order_response) => { + if let Ok(order_id) = create_order_response.clone().create_order_result { + payment_data.set_connector_response_reference_id(Some(order_id)) + } + + // Set the response in routerdata response to carry forward + router_data + .update_router_data_with_create_order_response(create_order_response.clone()); + create_order_response.create_order_result.ok().map(\|_\| ()) + } + // If create order is not required, then we can proceed with further processing + None => Some(()), + }; + + let should_continue: (Option<common_utils::request::Request>, bool) = match should_continue + { + Some(_) => { + router_data + .build_flow_specific_connector_request( + state, + &connector, + call_connector_action.clone(), + ) + .await? + } + None => (None, false), + }; + should_continue } else { + // If unified connector service is called, these values are not used + // as the request is built in the unified connector service call (None, false) }; - if should_add_task_to_process_tracker(payment_data) { - operation - .to_domain()? - .add_task_to_process_tracker( - state, - payment_data.get_payment_attempt(), - validate_result.requeue, - schedule_time, - ) - .await - .map_err(\|error\| logger::error!(process_tracker_error=?error)) - .ok(); - } - - let updated_customer = None; - let frm_suggestion = None; - (_, payment_data) = operation .to_update_tracker()? .update_trackers( state, req_state, payment_data.clone(), - customer.clone(), + None, // customer is not used in internal flows merchant_context.get_merchant_account().storage_scheme, - updated_customer, + None, merchant_context.get_merchant_key_store(), - frm_suggestion, + None, // frm_suggestion is not used in internal flows header_payload.clone(), ) .await?; - let router_data = if should_continue_further { - // The status of payment_attempt and intent will be updated in the previous step - // update this in router_data. - // This is added because few connector integrations do not update the status, - // and rely on previous status set in router_data - router_data.status = payment_data.get_payment_attempt().status; - router_data - .decide_flows( + record_time_taken_with(\|\| async { + if should_call_unified_connector_service { + router_data + .call_unified_connector_service( + state, + merchant_connector_account_type_details.clone(), + merchant_context, + ) + .await?; + + Ok(router_data) + } else { + let router_data = if should_continue_further { + router_data + .decide_flows( + state, + &connector, + call_connector_action, + connector_request, + business_profile, + header_payload.clone(), + return_raw_connector_response, + ) + .await + } else { + Ok(router_data) + }?; + Ok(router_data) + } + }) + .await +} + +#[cfg(feature = "v2")] +#[allow(clippy::too_many_arguments)] +#[instrument(skip_all)] +pub async fn decide_unified_connector_service_call<F, RouterDReq, ApiRequest, D>( + state: &SessionState, + req_state: ReqState, + merchant_context: &domain::MerchantContext, + connector: api::ConnectorData, + operation: &BoxedOperation<'_, F, ApiRequest, D>, + payment_data: &mut D, + customer: &Option<domain::Customer>, + call_connector_action: CallConnectorAction, + schedule_time: Option<time::PrimitiveDateTime>, + header_payload: HeaderPayload, + frm_suggestion: Option<storage_enums::FrmSuggestion>, + business_profile: &domain::Profile, + is_retry_payment: bool, + should_retry_with_pan: bool, + return_raw_connector_response: Option<bool>, + merchant_connector_account_type_details: domain::MerchantConnectorAccountTypeDetails, + mut router_data: RouterData<F, RouterDReq, router_types::PaymentsResponseData>, + updated_customer: Option<storage::CustomerUpdate>, +) -> RouterResult<RouterData<F, RouterDReq, router_types::PaymentsResponseData>> +where + F: Send + Clone + Sync, + RouterDReq: Send + Sync, + + // To create connector flow specific interface data + D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, + D: ConstructFlowSpecificData<F, RouterDReq, router_types::PaymentsResponseData>, + RouterData<F, RouterDReq, router_types::PaymentsResponseData>: Feature<F, RouterDReq> + Send, + // To construct connector flow specific api + dyn api::Connector: + services::api::ConnectorIntegration<F, RouterDReq, router_types::PaymentsResponseData>, +{ + record_time_taken_with(\|\| async { + if should_call_unified_connector_service(state, merchant_context, &router_data).await? { + if should_add_task_to_process_tracker(payment_data) { + operation + .to_domain()? + .add_task_to_process_tracker( + state, + payment_data.get_payment_attempt(), + false, + schedule_time, + ) + .await + .map_err(\|error\| logger::error!(process_tracker_error=?error)) + .ok(); + } + + (_, payment_data) = operation + .to_update_tracker()? + .update_trackers( + state, + req_state, + payment_data.clone(), + customer.clone(), + merchant_context.get_merchant_account().storage_scheme, + None, + merchant_context.get_merchant_key_store(), + frm_suggestion, + header_payload.clone(), + ) + .await?; + + router_data + .call_unified_connector_service( + state, + merchant_connector_account_type_details.clone(), + merchant_context, + ) + .await?; + + Ok(router_data) + } else { + call_connector_service( state, - &connector, + req_state, + merchant_context, + connector, + operation, + payment_data, + customer, call_connector_action, - connector_request, + schedule_time, + header_payload, + frm_suggestion, business_profile, - header_payload.clone(), + is_retry_payment, + should_retry_with_pan, return_raw_connector_response, + merchant_connector_account_type_details, + router_data, + updated_customer, ) .await - } else { - Ok(router_data) - }?; - - let etime_connector = Instant::now(); - let duration_connector = etime_connector.saturating_duration_since(stime_connector); - tracing::info!(duration = format!("Duration taken: {}", duration_connector.as_millis())); - - Ok((router_data, merchant_connector_account)) + } + }) + .await } - -#[cfg(feature = "v2")] +#[cfg(feature = "v1")] +// This function does not perform the tokenization action, as the payment method is not saved in this flow. #[allow(clippy::too_many_arguments)] #[instrument(skip_all)] pub async fn proxy_for_call_connector_service<F, RouterDReq, ApiRequest, D>( @@ -4279,11 +4516,18 @@ pub async fn proxy_for_call_connector_service<F, RouterDReq, ApiRequest, D>( connector: api::ConnectorData, operation: &BoxedOperation<'_, F, ApiRequest, D>, payment_data: &mut D, + customer: &Option<domain::Customer>, call_connector_action: CallConnectorAction, + validate_result: &operations::ValidateResult, + schedule_time: Option<time::PrimitiveDateTime>, header_payload: HeaderPayload, + business_profile: &domain::Profile, return_raw_connector_response: Option<bool>, -) -> RouterResult<RouterData<F, RouterDReq, router_types::PaymentsResponseData>> +) -> RouterResult<( + RouterData<F, RouterDReq, router_types::PaymentsResponseData>, + helpers::MerchantConnectorAccountType, +)> where F: Send + Clone + Sync, RouterDReq: Send + Sync, @@ -4298,34 +4542,34 @@ where { let stime_connector = Instant::now(); - let merchant_connector_account = - domain::MerchantConnectorAccountTypeDetails::MerchantConnectorAccount(Box::new( - helpers::get_merchant_connector_account_v2( - state, - merchant_context.get_merchant_key_store(), - connector.merchant_connector_id.as_ref(), - ) - .await?, - )); - operation - .to_domain()? - .populate_payment_data( - state, - payment_data, - merchant_context, - business_profile, - &connector, - ) - .await?; + let merchant_connector_account = construct_profile_id_and_get_mca( + state, + merchant_context, + payment_data, + &connector.connector_name.to_string(), + connector.merchant_connector_id.as_ref(), + false, + ) + .await?; + + if payment_data + .get_payment_attempt() + .merchant_connector_id + .is_none() + { + payment_data.set_merchant_connector_id_in_attempt(merchant_connector_account.get_mca_id()); + } + + let merchant_recipient_data = None; let mut router_data = payment_data .construct_router_data( state, connector.connector.id(), merchant_context, - &None, + customer, &merchant_connector_account, - None, + merchant_recipient_data, None, ) .await?; @@ -4347,7 +4591,26 @@ where &call_connector_action, ); + (router_data, should_continue_further) = complete_preprocessing_steps_if_required( + state, + &connector, + payment_data, + router_data, + operation, + should_continue_further, + ) + .await?; + + if let Ok(router_types::PaymentsResponseData::PreProcessingResponse { + session_token: Some(session_token), + .. + }) = router_data.response.to_owned() + { + payment_data.push_sessions_token(session_token); + }; + let (connector_request, should_continue_further) = if should_continue_further { + // Check if the actual flow specific request can be built with available data router_data .build_flow_specific_connector_request(state, &connector, call_connector_action.clone()) .await? @@ -4355,22 +4618,44 @@ where (None, false) }; + if should_add_task_to_process_tracker(payment_data) { + operation + .to_domain()? + .add_task_to_process_tracker( + state, + payment_data.get_payment_attempt(), + validate_result.requeue, + schedule_time, + ) + .await + .map_err(\|error\| logger::error!(process_tracker_error=?error)) + .ok(); + } + + let updated_customer = None; + let frm_suggestion = None; + (_, payment_data) = operation .to_update_tracker()? .update_trackers( state, req_state, payment_data.clone(), - None, + customer.clone(), merchant_context.get_merchant_account().storage_scheme, - None, + updated_customer, merchant_context.get_merchant_key_store(), - None, + frm_suggestion, header_payload.clone(), ) .await?; let router_data = if should_continue_further { + // The status of payment_attempt and intent will be updated in the previous step + // update this in router_data. + // This is added because few connector integrations do not update the status, + // and rely on previous status set in router_data + router_data.status = payment_data.get_payment_attempt().status; router_data .decide_flows( state, @@ -4390,13 +4675,13 @@ where let duration_connector = etime_connector.saturating_duration_since(stime_connector); tracing::info!(duration = format!("Duration taken: {}", duration_connector.as_millis())); - Ok(router_data) + Ok((router_data, merchant_connector_account)) } #[cfg(feature = "v2")] #[allow(clippy::too_many_arguments)] #[instrument(skip_all)] -pub async fn internal_call_connector_service<F, RouterDReq, ApiRequest, D>( +pub async fn proxy_for_call_connector_service<F, RouterDReq, ApiRequest, D>( state: &SessionState, req_state: ReqState, merchant_context: &domain::MerchantContext, @@ -4422,18 +4707,15 @@ where { let stime_connector = Instant::now(); - let merchant_connector_details = - payment_data - .get_merchant_connector_details() - .ok_or_else(\|\| { - error_stack::report!(errors::ApiErrorResponse::InternalServerError) - .attach_printable("Merchant connector details not found in payment data") - })?; let merchant_connector_account = - domain::MerchantConnectorAccountTypeDetails::MerchantConnectorDetails( - merchant_connector_details, - ); - + domain::MerchantConnectorAccountTypeDetails::MerchantConnectorAccount(Box::new( + helpers::get_merchant_connector_account_v2( + state, + merchant_context.get_merchant_key_store(), + connector.merchant_connector_id.as_ref(), + ) + .await?, + )); operation .to_domain()? .populate_payment_data( @@ -4474,22 +4756,6 @@ where &call_connector_action, ); - let add_create_order_result = router_data - .create_order_at_connector(state, &connector, should_continue_further) - .await?; - - if add_create_order_result.is_create_order_performed { - if let Ok(order_id_opt) = &add_create_order_result.create_order_result { - payment_data.set_connector_response_reference_id(order_id_opt.clone()); - } - should_continue_further = router_data - .update_router_data_with_create_order_result( - add_create_order_result, - should_continue_further, - ) - .await?; - } - let (connector_request, should_continue_further) = if should_continue_further { router_data .build_flow_specific_connector_request(state, &connector, call_connector_action.clone()) diff --git a/crates/router/src/core/payments/flows.rs b/crates/router/src/core/payments/flows.rs index a93e2f391fe..2cae2f0600d 100644 --- a/crates/router/src/core/payments/flows.rs +++ b/crates/router/src/core/payments/flows.rs @@ -185,35 +185,27 @@ pub trait Feature<F, T> { _state: &SessionState, _connector: &api::ConnectorData, _should_continue_payment: bool, - ) -> RouterResult<types::CreateOrderResult> + ) -> RouterResult<Option<types::CreateOrderResult>> where F: Clone, Self: Sized, dyn api::Connector: services::ConnectorIntegration<F, T, types::PaymentsResponseData>, { - Ok(types::CreateOrderResult { - create_order_result: Ok(None), - is_create_order_performed: false, - }) + Ok(None) } - async fn update_router_data_with_create_order_result( + fn update_router_data_with_create_order_response( &mut self, _create_order_result: types::CreateOrderResult, - should_continue_payment: bool, - ) -> RouterResult<bool> - where - F: Clone, - Self: Sized, - dyn api::Connector: services::ConnectorIntegration<F, T, types::PaymentsResponseData>, - { - Ok(should_continue_payment) + ) { } async fn call_unified_connector_service<'a>( &mut self, _state: &SessionState, - _merchant_connector_account: helpers::MerchantConnectorAccountType, + #[cfg(feature = "v1")] _merchant_connector_account: helpers::MerchantConnectorAccountType, + #[cfg(feature = "v2")] + _merchant_connector_account: domain::MerchantConnectorAccountTypeDetails, _merchant_context: &domain::MerchantContext, ) -> RouterResult<()> where diff --git a/crates/router/src/core/payments/flows/authorize_flow.rs b/crates/router/src/core/payments/flows/authorize_flow.rs index 1532fffa3f9..f42efa0c1e4 100644 --- a/crates/router/src/core/payments/flows/authorize_flow.rs +++ b/crates/router/src/core/payments/flows/authorize_flow.rs @@ -431,7 +431,7 @@ impl Feature<api::Authorize, types::PaymentsAuthorizeData> for types::PaymentsAu state: &SessionState, connector: &api::ConnectorData, should_continue_payment: bool, - ) -> RouterResult<types::CreateOrderResult> { + ) -> RouterResult<Option<types::CreateOrderResult>> { if connector .connector_name .requires_order_creation_before_payment(self.payment_method) @@ -471,7 +471,7 @@ impl Feature<api::Authorize, types::PaymentsAuthorizeData> for types::PaymentsAu if let types::PaymentsResponseData::PaymentsCreateOrderResponse { order_id } = res { - Ok(Some(order_id)) + Ok(order_id) } else { Err(error_stack::report!(ApiErrorResponse::InternalServerError) .attach_printable(format!( @@ -482,47 +482,37 @@ impl Feature<api::Authorize, types::PaymentsAuthorizeData> for types::PaymentsAu Err(error) => Err(error), }; - Ok(types::CreateOrderResult { + Ok(Some(types::CreateOrderResult { create_order_result: create_order_resp, - is_create_order_performed: true, - }) + })) } else { - Ok(types::CreateOrderResult { - create_order_result: Ok(None), - is_create_order_performed: false, - }) + // If the connector does not require order creation, return None + Ok(None) } } - async fn update_router_data_with_create_order_result( + fn update_router_data_with_create_order_response( &mut self, create_order_result: types::CreateOrderResult, - should_continue_further: bool, - ) -> RouterResult<bool> { - if create_order_result.is_create_order_performed { - match create_order_result.create_order_result { - Ok(Some(order_id)) => { - self.request.order_id = Some(order_id.clone()); - self.response = - Ok(types::PaymentsResponseData::PaymentsCreateOrderResponse { order_id }); - Ok(true) - } - Ok(None) => Err(error_stack::report!(ApiErrorResponse::InternalServerError) - .attach_printable("Order Id not found."))?, - Err(err) => { - self.response = Err(err.clone()); - Ok(false) - } + ) { + match create_order_result.create_order_result { + Ok(order_id) => { + self.request.order_id = Some(order_id.clone()); // ? why this is assigned here and ucs also wants this to populate data + self.response = + Ok(types::PaymentsResponseData::PaymentsCreateOrderResponse { order_id }); + } + Err(err) => { + self.response = Err(err.clone()); } - } else { - Ok(should_continue_further) } } async fn call_unified_connector_service<'a>( &mut self, state: &SessionState, - merchant_connector_account: helpers::MerchantConnectorAccountType, + #[cfg(feature = "v1")] merchant_connector_account: helpers::MerchantConnectorAccountType, + #[cfg(feature = "v2")] + merchant_connector_account: domain::MerchantConnectorAccountTypeDetails, merchant_context: &domain::MerchantContext, ) -> RouterResult<()> { let client = state @@ -558,13 +548,14 @@ impl Feature<api::Authorize, types::PaymentsAuthorizeData> for types::PaymentsAu let (status, router_data_response) = handle_unified_connector_service_response_for_payment_authorize( - payment_authorize_response, + payment_authorize_response.clone(), ) .change_context(ApiErrorResponse::InternalServerError) .attach_printable("Failed to deserialize UCS response")?; self.status = status; self.response = router_data_response; + self.raw_connector_response = payment_authorize_response.raw_connector_response; Ok(()) } diff --git a/crates/router/src/core/payments/flows/psync_flow.rs b/crates/router/src/core/payments/flows/psync_flow.rs index f2ffbe24d11..e27c9974406 100644 --- a/crates/router/src/core/payments/flows/psync_flow.rs +++ b/crates/router/src/core/payments/flows/psync_flow.rs @@ -1,6 +1,8 @@ use std::collections::HashMap; use async_trait::async_trait; +use error_stack::ResultExt; +use unified_connector_service_client::payments as payments_grpc; use super::{ConstructFlowSpecificData, Feature}; use crate::{ @@ -8,10 +10,14 @@ use crate::{ core::{ errors::{ApiErrorResponse, ConnectorErrorExt, RouterResult}, payments::{self, access_token, helpers, transformers, PaymentData}, + unified_connector_service::{ + build_unified_connector_service_auth_metadata, + handle_unified_connector_service_response_for_payment_get, + }, }, routes::SessionState, services::{self, api::ConnectorValidation, logger}, - types::{self, api, domain}, + types::{self, api, domain, transformers::ForeignTryFrom}, }; #[cfg(feature = "v1")] @@ -204,6 +210,56 @@ impl Feature<api::PSync, types::PaymentsSyncData> Ok((request, true)) } + + async fn call_unified_connector_service<'a>( + &mut self, + state: &SessionState, + #[cfg(feature = "v1")] merchant_connector_account: helpers::MerchantConnectorAccountType, + #[cfg(feature = "v2")] + merchant_connector_account: domain::MerchantConnectorAccountTypeDetails, + merchant_context: &domain::MerchantContext, + ) -> RouterResult<()> { + let client = state + .grpc_client + .unified_connector_service_client + .clone() + .ok_or(ApiErrorResponse::InternalServerError) + .attach_printable("Failed to fetch Unified Connector Service client")?; + + let payment_get_request = payments_grpc::PaymentServiceGetRequest::foreign_try_from(self) + .change_context(ApiErrorResponse::InternalServerError) + .attach_printable("Failed to construct Payment Get Request")?; + + let connector_auth_metadata = build_unified_connector_service_auth_metadata( + merchant_connector_account, + merchant_context, + ) + .change_context(ApiErrorResponse::InternalServerError) + .attach_printable("Failed to construct request metadata")?; + + let response = client + .payment_get( + payment_get_request, + connector_auth_metadata, + state.get_grpc_headers(), + ) + .await + .change_context(ApiErrorResponse::InternalServerError) + .attach_printable("Failed to get payment")?; + + let payment_get_response = response.into_inner(); + + let (status, router_data_response) = + handle_unified_connector_service_response_for_payment_get(payment_get_response.clone()) + .change_context(ApiErrorResponse::InternalServerError) + .attach_printable("Failed to deserialize UCS response")?; + + self.status = status; + self.response = router_data_response; + self.raw_connector_response = payment_get_response.raw_connector_response; + + Ok(()) + } } #[async_trait] diff --git a/crates/router/src/core/payments/transformers.rs b/crates/router/src/core/payments/transformers.rs index 2379dddb8fd..59359429080 100644 --- a/crates/router/src/core/payments/transformers.rs +++ b/crates/router/src/core/payments/transformers.rs @@ -304,7 +304,7 @@ pub async fn construct_payment_router_data_for_authorize<'a>( router_return_url: Some(router_return_url), webhook_url, complete_authorize_url, - customer_id: None, + customer_id: customer_id.clone(), surcharge_details: None, request_extended_authorization: None, request_incremental_authorization: matches!( @@ -3466,8 +3466,126 @@ where impl<F: Clone> TryFrom<PaymentAdditionalData<'_, F>> for types::PaymentsAuthorizeData { type Error = error_stack::Report<errors::ApiErrorResponse>; - fn try_from(_additional_data: PaymentAdditionalData<'_, F>) -> Result<Self, Self::Error> { - todo!() + fn try_from(additional_data: PaymentAdditionalData<'_, F>) -> Result<Self, Self::Error> { + let payment_data = additional_data.payment_data.clone(); + let router_base_url = &additional_data.router_base_url; + let connector_name = &additional_data.connector_name; + let attempt = &payment_data.payment_attempt; + let browser_info: Option<types::BrowserInformation> = attempt + .browser_info + .clone() + .map(types::BrowserInformation::from); + + let complete_authorize_url = Some(helpers::create_complete_authorize_url( + router_base_url, + attempt, + connector_name, + payment_data.creds_identifier.as_deref(), + )); + + let merchant_connector_account_id_or_connector_name = payment_data + .payment_attempt + .merchant_connector_id + .as_ref() + .map(\|mca_id\| mca_id.get_string_repr()) + .unwrap_or(connector_name); + + let webhook_url = Some(helpers::create_webhook_url( + router_base_url, + &attempt.merchant_id, + merchant_connector_account_id_or_connector_name, + )); + let router_return_url = Some(helpers::create_redirect_url( + router_base_url, + attempt, + connector_name, + payment_data.creds_identifier.as_deref(), + )); + + let payment_method_data = payment_data.payment_method_data.or_else(\|\| { + if payment_data.mandate_id.is_some() { + Some(domain::PaymentMethodData::MandatePayment) + } else { + None + } + }); + + let amount = payment_data + .payment_attempt + .get_total_amount() + .get_amount_as_i64(); + + let customer_name = additional_data + .customer_data + .as_ref() + .and_then(\|customer_data\| { + customer_data + .name + .as_ref() + .map(\|customer\| customer.clone().into_inner()) + }); + + let customer_id = additional_data + .customer_data + .as_ref() + .and_then(\|data\| data.get_id().clone().try_into().ok()); + + let merchant_order_reference_id = payment_data + .payment_intent + .merchant_reference_id + .map(\|s\| s.get_string_repr().to_string()); + + let shipping_cost = payment_data.payment_intent.amount_details.shipping_cost; + + Ok(Self { + payment_method_data: payment_method_data + .unwrap_or(domain::PaymentMethodData::Card(domain::Card::default())), + amount, + order_tax_amount: None, // V2 doesn't currently support order tax amount + email: None, // V2 doesn't store email directly in payment_intent + customer_name, + currency: payment_data.currency, + confirm: true, + statement_descriptor_suffix: None, + statement_descriptor: None, + capture_method: Some(payment_data.payment_intent.capture_method), + router_return_url, + webhook_url, + complete_authorize_url, + setup_future_usage: Some(payment_data.payment_intent.setup_future_usage), + mandate_id: payment_data.mandate_id.clone(), + off_session: get_off_session(payment_data.mandate_id.as_ref(), None), + customer_acceptance: None, + setup_mandate_details: None, + browser_info, + order_details: None, + order_category: None, + session_token: None, + enrolled_for_3ds: false, + related_transaction_id: None, + payment_experience: None, + payment_method_type: Some(payment_data.payment_attempt.payment_method_subtype), + surcharge_details: None, + customer_id, + request_incremental_authorization: false, + metadata: payment_data + .payment_intent + .metadata + .clone() + .map(\|m\| m.expose()), + authentication_data: None, + request_extended_authorization: None, + split_payments: None, + minor_amount: payment_data.payment_attempt.get_total_amount(), + merchant_order_reference_id, + integrity_object: None, + shipping_cost, + additional_payment_method_data: None, + merchant_account_id: None, + merchant_config_currency: None, + connector_testing_data: None, + order_id: None, + }) } } diff --git a/crates/router/src/core/unified_connector_service.rs b/crates/router/src/core/unified_connector_service.rs index 3cdcb28d4d8..14836ff20c6 100644 --- a/crates/router/src/core/unified_connector_service.rs +++ b/crates/router/src/core/unified_connector_service.rs @@ -1,4 +1,3 @@ -use api_models::admin::ConnectorAuthType; use common_enums::{AttemptStatus, PaymentMethodType}; use common_utils::{errors::CustomResult, ext_traits::ValueExt}; use error_stack::ResultExt; @@ -6,9 +5,11 @@ use external_services::grpc_client::unified_connector_service::{ ConnectorAuthMetadata, UnifiedConnectorServiceError, }; use hyperswitch_connectors::utils::CardData; +#[cfg(feature = "v2")] +use hyperswitch_domain_models::merchant_connector_account::MerchantConnectorAccountTypeDetails; use hyperswitch_domain_models::{ merchant_context::MerchantContext, - router_data::{ErrorResponse, RouterData}, + router_data::{ConnectorAuthType, ErrorResponse, RouterData}, router_response_types::{PaymentsResponseData, RedirectForm}, }; use masking::{ExposeInterface, PeekInterface, Secret}; @@ -101,7 +102,7 @@ pub fn build_unified_connector_service_payment_method( } _ => { return Err(UnifiedConnectorServiceError::NotImplemented(format!( - "Unimplemented card payment method type: {payment_method_type:?}" + "Unimplemented payment method subtype: {payment_method_type:?}" )) .into()); } @@ -113,24 +114,52 @@ pub fn build_unified_connector_service_payment_method( })), }) } + hyperswitch_domain_models::payment_method_data::PaymentMethodData::Upi(upi_data) => { + let upi_type = match upi_data { + hyperswitch_domain_models::payment_method_data::UpiData::UpiCollect( + upi_collect_data, + ) => { + let vpa_id = upi_collect_data.vpa_id.map(\|vpa\| vpa.expose()); + let upi_details = payments_grpc::UpiCollect { vpa_id }; + PaymentMethod::UpiCollect(upi_details) + } + _ => { + return Err(UnifiedConnectorServiceError::NotImplemented(format!( + "Unimplemented payment method subtype: {payment_method_type:?}" + )) + .into()); + } + }; - _ => Err(UnifiedConnectorServiceError::NotImplemented( - "Unimplemented Payment Method".to_string(), - ) + Ok(payments_grpc::PaymentMethod { + payment_method: Some(upi_type), + }) + } + _ => Err(UnifiedConnectorServiceError::NotImplemented(format!( + "Unimplemented payment method: {payment_method_data:?}" + )) .into()), } } pub fn build_unified_connector_service_auth_metadata( - merchant_connector_account: MerchantConnectorAccountType, + #[cfg(feature = "v1")] merchant_connector_account: MerchantConnectorAccountType, + #[cfg(feature = "v2")] merchant_connector_account: MerchantConnectorAccountTypeDetails, merchant_context: &MerchantContext, ) -> CustomResult<ConnectorAuthMetadata, UnifiedConnectorServiceError> { + #[cfg(feature = "v1")] let auth_type: ConnectorAuthType = merchant_connector_account .get_connector_account_details() .parse_value("ConnectorAuthType") .change_context(UnifiedConnectorServiceError::FailedToObtainAuthType) .attach_printable("Failed while parsing value for ConnectorAuthType")?; + #[cfg(feature = "v2")] + let auth_type: ConnectorAuthType = merchant_connector_account + .get_connector_account_details() + .change_context(UnifiedConnectorServiceError::FailedToObtainAuthType) + .attach_printable("Failed to obtain ConnectorAuthType")?; + let connector_name = { #[cfg(feature = "v1")] { @@ -211,30 +240,126 @@ pub fn handle_unified_connector_service_response_for_payment_authorize( }) }); + let transaction_id = response.transaction_id.as_ref().and_then(\|id\| { + id.id_type.clone().and_then(\|id_type\| match id_type { + payments_grpc::identifier::IdType::Id(id) => Some(id), + payments_grpc::identifier::IdType::EncodedData(encoded_data) => Some(encoded_data), + payments_grpc::identifier::IdType::NoResponseIdMarker(_) => None, + }) + }); + let router_data_response = match status { AttemptStatus::Charged \| - AttemptStatus::Authorized \| - AttemptStatus::AuthenticationPending \| - AttemptStatus::DeviceDataCollectionPending => Ok(PaymentsResponseData::TransactionResponse { - resource_id: match connector_response_reference_id.as_ref() { + AttemptStatus::Authorized \| + AttemptStatus::AuthenticationPending \| + AttemptStatus::DeviceDataCollectionPending \| + AttemptStatus::Started \| + AttemptStatus::AuthenticationSuccessful \| + AttemptStatus::Authorizing \| + AttemptStatus::ConfirmationAwaited \| + AttemptStatus::Pending => Ok(PaymentsResponseData::TransactionResponse { + resource_id: match transaction_id.as_ref() { + Some(transaction_id) => hyperswitch_domain_models::router_request_types::ResponseId::ConnectorTransactionId(transaction_id.clone()), + None => hyperswitch_domain_models::router_request_types::ResponseId::NoResponseId, + }, + redirection_data: Box::new( + response + .redirection_data + .clone() + .map(RedirectForm::foreign_try_from) + .transpose()? + ), + mandate_reference: Box::new(None), + connector_metadata: None, + network_txn_id: response.network_txn_id.clone(), + connector_response_reference_id, + incremental_authorization_allowed: response.incremental_authorization_allowed, + charges: None, + }), + AttemptStatus::AuthenticationFailed + \| AttemptStatus::AuthorizationFailed + \| AttemptStatus::Unresolved + \| AttemptStatus::Failure => Err(ErrorResponse { + code: response.error_code().to_owned(), + message: response.error_message().to_owned(), + reason: Some(response.error_message().to_owned()), + status_code: 500, + attempt_status: Some(status), + connector_transaction_id: connector_response_reference_id, + network_decline_code: None, + network_advice_code: None, + network_error_message: None, + }), + AttemptStatus::RouterDeclined \| + AttemptStatus::CodInitiated \| + AttemptStatus::Voided \| + AttemptStatus::VoidInitiated \| + AttemptStatus::CaptureInitiated \| + AttemptStatus::VoidFailed \| + AttemptStatus::AutoRefunded \| + AttemptStatus::PartialCharged \| + AttemptStatus::PartialChargedAndChargeable \| + AttemptStatus::PaymentMethodAwaited \| + AttemptStatus::CaptureFailed \| + AttemptStatus::IntegrityFailure => return Err(UnifiedConnectorServiceError::NotImplemented(format!( + "AttemptStatus {status:?} is not implemented for Unified Connector Service" + )).into()), + }; + + Ok((status, router_data_response)) +} + +pub fn handle_unified_connector_service_response_for_payment_get( + response: payments_grpc::PaymentServiceGetResponse, +) -> CustomResult< + (AttemptStatus, Result<PaymentsResponseData, ErrorResponse>), + UnifiedConnectorServiceError, +> { + let status = AttemptStatus::foreign_try_from(response.status())?; + + let connector_response_reference_id = + response.response_ref_id.as_ref().and_then(\|identifier\| { + identifier + .id_type + .clone() + .and_then(\|id_type\| match id_type { + payments_grpc::identifier::IdType::Id(id) => Some(id), + payments_grpc::identifier::IdType::EncodedData(encoded_data) => { + Some(encoded_data) + } + payments_grpc::identifier::IdType::NoResponseIdMarker(_) => None, + }) + }); + + let router_data_response = match status { + AttemptStatus::Charged \| + AttemptStatus::Authorized \| + AttemptStatus::AuthenticationPending \| + AttemptStatus::DeviceDataCollectionPending \| + AttemptStatus::Started \| + AttemptStatus::AuthenticationSuccessful \| + AttemptStatus::Authorizing \| + AttemptStatus::ConfirmationAwaited \| + AttemptStatus::Pending => Ok( + PaymentsResponseData::TransactionResponse { + resource_id: match connector_response_reference_id.as_ref() { Some(connector_response_reference_id) => hyperswitch_domain_models::router_request_types::ResponseId::ConnectorTransactionId(connector_response_reference_id.clone()), None => hyperswitch_domain_models::router_request_types::ResponseId::NoResponseId, }, - redirection_data: Box::new( - response - .redirection_data - .clone() - .map(RedirectForm::foreign_try_from) - .transpose()? - ), - mandate_reference: Box::new(None), - connector_metadata: None, - network_txn_id: response.network_txn_id.clone(), - connector_response_reference_id, - incremental_authorization_allowed: response.incremental_authorization_allowed, - charges: None, - }), - _ => Err(ErrorResponse { + redirection_data: Box::new( + None + ), + mandate_reference: Box::new(None), + connector_metadata: None, + network_txn_id: response.network_txn_id.clone(), + connector_response_reference_id, + incremental_authorization_allowed: None, + charges: None, + } + ), + AttemptStatus::AuthenticationFailed + \| AttemptStatus::AuthorizationFailed + \| AttemptStatus::Failure => Err(ErrorResponse { code: response.error_code().to_owned(), message: response.error_message().to_owned(), reason: Some(response.error_message().to_owned()), @@ -244,7 +369,22 @@ pub fn handle_unified_connector_service_response_for_payment_authorize( network_decline_code: None, network_advice_code: None, network_error_message: None, - }) + }), + AttemptStatus::RouterDeclined \| + AttemptStatus::CodInitiated \| + AttemptStatus::Voided \| + AttemptStatus::VoidInitiated \| + AttemptStatus::CaptureInitiated \| + AttemptStatus::VoidFailed \| + AttemptStatus::AutoRefunded \| + AttemptStatus::PartialCharged \| + AttemptStatus::PartialChargedAndChargeable \| + AttemptStatus::Unresolved \| + AttemptStatus::PaymentMethodAwaited \| + AttemptStatus::CaptureFailed \| + AttemptStatus::IntegrityFailure => return Err(UnifiedConnectorServiceError::NotImplemented(format!( + "AttemptStatus {status:?} is not implemented for Unified Connector Service" + )).into()), }; Ok((status, router_data_response)) diff --git a/crates/router/src/core/unified_connector_service/transformers.rs b/crates/router/src/core/unified_connector_service/transformers.rs index 0e2ae6fd343..e937a7e7d2d 100644 --- a/crates/router/src/core/unified_connector_service/transformers.rs +++ b/crates/router/src/core/unified_connector_service/transformers.rs @@ -7,8 +7,8 @@ use error_stack::ResultExt; use external_services::grpc_client::unified_connector_service::UnifiedConnectorServiceError; use hyperswitch_domain_models::{ router_data::RouterData, - router_flow_types::payments::Authorize, - router_request_types::{AuthenticationData, PaymentsAuthorizeData}, + router_flow_types::payments::{Authorize, PSync}, + router_request_types::{AuthenticationData, PaymentsAuthorizeData, PaymentsSyncData}, router_response_types::{PaymentsResponseData, RedirectForm}, }; use masking::{ExposeInterface, PeekInterface}; @@ -18,6 +18,37 @@ use crate::{ core::unified_connector_service::build_unified_connector_service_payment_method, types::transformers::ForeignTryFrom, }; +impl ForeignTryFrom<&RouterData<PSync, PaymentsSyncData, PaymentsResponseData>> + for payments_grpc::PaymentServiceGetRequest +{ + type Error = error_stack::Report<UnifiedConnectorServiceError>; + + fn foreign_try_from( + router_data: &RouterData<PSync, PaymentsSyncData, PaymentsResponseData>, + ) -> Result<Self, Self::Error> { + let connector_transaction_id = router_data + .request + .connector_transaction_id + .get_connector_transaction_id() + .map(\|id\| Identifier { + id_type: Some(payments_grpc::identifier::IdType::Id(id)), + }) + .ok(); + + let connector_ref_id = router_data + .request + .connector_reference_id + .clone() + .map(\|id\| Identifier { + id_type: Some(payments_grpc::identifier::IdType::Id(id)), + }); + + Ok(Self { + transaction_id: connector_transaction_id, + request_ref_id: connector_ref_id, + }) + } +} impl ForeignTryFrom<&RouterData<Authorize, PaymentsAuthorizeData, PaymentsResponseData>> for payments_grpc::PaymentServiceAuthorizeRequest @@ -113,7 +144,7 @@ impl ForeignTryFrom<&RouterData<Authorize, PaymentsAuthorizeData, PaymentsRespon .map(\|shipping_cost\| shipping_cost.get_amount_as_i64()), request_ref_id: Some(Identifier { id_type: Some(payments_grpc::identifier::IdType::Id( - router_data.payment_id.clone(), + router_data.connector_request_reference_id.clone(), )), }), connector_customer_id: router_data @@ -181,89 +212,115 @@ impl ForeignTryFrom<hyperswitch_domain_models::payment_address::PaymentAddress> fn foreign_try_from( payment_address: hyperswitch_domain_models::payment_address::PaymentAddress, ) -> Result<Self, Self::Error> { - let shipping = payment_address.get_shipping().and_then(\|address\| { - let details = address.address.as_ref()?; + let shipping = payment_address.get_shipping().map(\|address\| { + let details = address.address.as_ref(); let get_str = \|opt: &Option<masking::Secret<String>>\| opt.as_ref().map(\|s\| s.peek().to_owned()); let get_plain = \|opt: &Option<String>\| opt.clone(); - let country = details - .country - .as_ref() - .and_then(\|c\| payments_grpc::CountryAlpha2::from_str_name(&c.to_string())) - .ok_or_else(\|\| { - UnifiedConnectorServiceError::RequestEncodingFailedWithReason( - "Invalid country code".to_string(), - ) - }) - .attach_printable("Invalid country code") - .ok()? // Return None if invalid - .into(); - - Some(payments_grpc::Address { - first_name: get_str(&details.first_name), - last_name: get_str(&details.last_name), - line1: get_str(&details.line1), - line2: get_str(&details.line2), - line3: get_str(&details.line3), - city: get_plain(&details.city), - state: get_str(&details.state), - zip_code: get_str(&details.zip), - country_alpha2_code: Some(country), + let country = details.and_then(\|details\| { + details + .country + .as_ref() + .and_then(\|c\| payments_grpc::CountryAlpha2::from_str_name(&c.to_string())) + .map(\|country\| country.into()) + }); + + payments_grpc::Address { + first_name: get_str(&details.and_then(\|d\| d.first_name.clone())), + last_name: get_str(&details.and_then(\|d\| d.last_name.clone())), + line1: get_str(&details.and_then(\|d\| d.line1.clone())), + line2: get_str(&details.and_then(\|d\| d.line2.clone())), + line3: get_str(&details.and_then(\|d\| d.line3.clone())), + city: get_plain(&details.and_then(\|d\| d.city.clone())), + state: get_str(&details.and_then(\|d\| d.state.clone())), + zip_code: get_str(&details.and_then(\|d\| d.zip.clone())), + country_alpha2_code: country, email: address.email.as_ref().map(\|e\| e.peek().to_string()), phone_number: address .phone .as_ref() .and_then(\|phone\| phone.number.as_ref().map(\|n\| n.peek().to_string())), phone_country_code: address.phone.as_ref().and_then(\|p\| p.country_code.clone()), - }) + } }); - let billing = payment_address.get_payment_billing().and_then(\|address\| { - let details = address.address.as_ref()?; + let billing = payment_address.get_payment_billing().map(\|address\| { + let details = address.address.as_ref(); let get_str = \|opt: &Option<masking::Secret<String>>\| opt.as_ref().map(\|s\| s.peek().to_owned()); let get_plain = \|opt: &Option<String>\| opt.clone(); - let country = details - .country - .as_ref() - .and_then(\|c\| payments_grpc::CountryAlpha2::from_str_name(&c.to_string())) - .ok_or_else(\|\| { - UnifiedConnectorServiceError::RequestEncodingFailedWithReason( - "Invalid country code".to_string(), - ) - }) - .attach_printable("Invalid country code") - .ok()? // Return None if invalid - .into(); - - Some(payments_grpc::Address { - first_name: get_str(&details.first_name), - last_name: get_str(&details.last_name), - line1: get_str(&details.line1), - line2: get_str(&details.line2), - line3: get_str(&details.line3), - city: get_plain(&details.city), - state: get_str(&details.state), - zip_code: get_str(&details.zip), - country_alpha2_code: Some(country), + let country = details.and_then(\|details\| { + details + .country + .as_ref() + .and_then(\|c\| payments_grpc::CountryAlpha2::from_str_name(&c.to_string())) + .map(\|country\| country.into()) + }); + + payments_grpc::Address { + first_name: get_str(&details.and_then(\|d\| d.first_name.clone())), + last_name: get_str(&details.and_then(\|d\| d.last_name.clone())), + line1: get_str(&details.and_then(\|d\| d.line1.clone())), + line2: get_str(&details.and_then(\|d\| d.line2.clone())), + line3: get_str(&details.and_then(\|d\| d.line3.clone())), + city: get_plain(&details.and_then(\|d\| d.city.clone())), + state: get_str(&details.and_then(\|d\| d.state.clone())), + zip_code: get_str(&details.and_then(\|d\| d.zip.clone())), + country_alpha2_code: country, email: address.email.as_ref().map(\|e\| e.peek().to_string()), phone_number: address .phone .as_ref() .and_then(\|phone\| phone.number.as_ref().map(\|n\| n.peek().to_string())), phone_country_code: address.phone.as_ref().and_then(\|p\| p.country_code.clone()), - }) + } }); + let unified_payment_method_billing = + payment_address.get_payment_method_billing().map(\|address\| { + let details = address.address.as_ref(); + + let get_str = \|opt: &Option<masking::Secret<String>>\| { + opt.as_ref().map(\|s\| s.peek().to_owned()) + }; + + let get_plain = \|opt: &Option<String>\| opt.clone(); + + let country = details.and_then(\|details\| { + details + .country + .as_ref() + .and_then(\|c\| payments_grpc::CountryAlpha2::from_str_name(&c.to_string())) + .map(\|country\| country.into()) + }); + + payments_grpc::Address { + first_name: get_str(&details.and_then(\|d\| d.first_name.clone())), + last_name: get_str(&details.and_then(\|d\| d.last_name.clone())), + line1: get_str(&details.and_then(\|d\| d.line1.clone())), + line2: get_str(&details.and_then(\|d\| d.line2.clone())), + line3: get_str(&details.and_then(\|d\| d.line3.clone())), + city: get_plain(&details.and_then(\|d\| d.city.clone())), + state: get_str(&details.and_then(\|d\| d.state.clone())), + zip_code: get_str(&details.and_then(\|d\| d.zip.clone())), + country_alpha2_code: country, + email: address.email.as_ref().map(\|e\| e.peek().to_string()), + phone_number: address + .phone + .as_ref() + .and_then(\|phone\| phone.number.as_ref().map(\|n\| n.peek().to_string())), + phone_country_code: address.phone.as_ref().and_then(\|p\| p.country_code.clone()), + } + }); Ok(Self { - shipping_address: shipping, - billing_address: billing, + shipping_address: shipping.or(unified_payment_method_billing.clone()), + billing_address: billing.or(unified_payment_method_billing), }) } } @@ -391,6 +448,12 @@ impl ForeignTryFrom<payments_grpc::RedirectForm> for RedirectForm { Some(payments_grpc::redirect_form::FormType::Html(html)) => Ok(Self::Html { html_data: html.html_data, }), + Some(payments_grpc::redirect_form::FormType::Uri(_)) => Err( + UnifiedConnectorServiceError::RequestEncodingFailedWithReason( + "URI form type is not implemented".to_string(), + ) + .into(), + ), None => Err( UnifiedConnectorServiceError::RequestEncodingFailedWithReason( "Missing form type".to_string(), diff --git a/crates/router/src/types.rs b/crates/router/src/types.rs index a5740561c7f..57043bbcc05 100644 --- a/crates/router/src/types.rs +++ b/crates/router/src/types.rs @@ -514,9 +514,9 @@ pub struct PaymentMethodTokenResult { pub connector_response: Option<ConnectorResponseData>, } +#[derive(Clone)] pub struct CreateOrderResult { - pub create_order_result: Result<Option<String>, ErrorResponse>, - pub is_create_order_performed: bool, + pub create_order_result: Result<String, ErrorResponse>, } pub struct PspTokenResult {	2025-06-24T06:16:40Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ### Fixes #8440 ## Description <!-- Describe your changes in detail --> This PR implements V2 UCS (Unified Connector Service) Integration for authorization and synchronization flows, building upon the existing V1 UCS integration (PR#[8280](https://github.com/juspay/hyperswitch/pull/8280)), with enhanced V2 schema support according to updated gRPC contract. Key Features Implemented: 1. Authorization Flow (Payments): Full V2 schema support for payment authorization 2. PSync Flow: Payment status synchronization through UCS V2 3. UPI Payment Method: Support for UPI Collect payment method 4. Enhanced Response Handling: Improved status mapping and error handling 5. Address Transformation Fix: Better handling of optional address fields Key Changes from V1 to V2: 1. Updated gRPC Schema: - Migrated from `PaymentsAuthorizeRequest` to `PaymentServiceAuthorizeRequest` - Added `PaymentServiceGetRequest` for PSync flow - Enhanced field structure for better type safety 2. New Payment Methods: - Added UPI Collect payment method support - Proper VPA ID extraction and handling 3. Enhanced Transformers: - Updated transformers for authorization and sync flows - Improved card details, address structure, and payment method handling - Fixed address transformation to handle None values gracefully 4. V2 Flow Architecture: - Refactored payment flow to separate UCS prerequisites and decision logic - Added PSync flow integration through UCS - Feature flag protection for clean V1/V2 separation 5. Improved Response Handling: - Enhanced response parsing with new identifier structure - Added support for more payment states (Started, AuthenticationSuccessful, Authorizing, etc.) - Better error handling and status mapping V2 Architecture Flow: V2 Payment Request → call_connector_service_prerequisites() → decide_unified_connector_service_call() → ├── UCS Available → V2 Transformers → gRPC Call → V2 Response Handling └── UCS Unavailable → Traditional Connector Flow (Fallback) V2 PSync Request → call_unified_connector_service() → ├── UCS Available → V2 PSync Transformer → gRPC Get Call → Status Response └── UCS Unavailable → Traditional Connector Sync Flow Key Technical Improvements: - Refactored Payment Functions: Split `call_connector_service()` into `call_connector_service_prerequisites()` and `decide_unified_connector_service_call()` for better separation of concerns - Enhanced V2 Transformers: Updated card data transformation, address structure, and authentication data handling - PSync Flow Integration: Added complete payment synchronization support through UCS - UPI Payment Support: Added UPI Collect payment method with VPA ID handling - Improved Error Handling: Better response parsing with new identifier structure - Customer ID Support: Added customer ID mapping in V2 transformer implementation - Enhanced Authentication: Added tenant_id and merchant_id to ConnectorAuthMetadata Files Modified: - `crates/router/Cargo.toml` - Updated rust-grpc-client dependency to main branch - `crates/router/src/core/payments.rs` - Refactored UCS integration with V2 prerequisite and decision functions - `crates/router/src/core/payments/flows/authorize_flow.rs` - Updated to use `PaymentServiceAuthorizeRequest` - `crates/router/src/core/payments/flows/psync_flow.rs` - Added UCS V2 support for payment synchronization - `crates/router/src/core/payments/transformers.rs` - Added V2 PaymentsAuthorizeData transformer implementation and customer_id support - `crates/router/src/core/unified_connector_service/` - Updated transformers and response handlers for V2 schema - `crates/router/src/core/unified_connector_service.rs` - Added UPI payment method support and enhanced response handling - `crates/router/src/core/unified_connector_service/transformers.rs` - Major updates for V2 gRPC schema compatibility - `crates/external_services/src/grpc_client/unified_connector_service.rs` - Added payment get operations support ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> V2 UCS Integration Evolution: This change builds upon the existing V1 UCS integration to support the updated V2 gRPC schema and enhanced payment flow architecture. Key motivations: Schema Evolution: - Updated gRPC Contracts: V2 introduces improved field structures for better type safety and extensibility - Enhanced Data Models: New card details structure, improved address handling, and better identifier management - Backward Compatibility: V2 implementation maintains compatibility while leveraging new schema features Feature Additions: - PSync Flow Support: Enables payment status synchronization through UCS, reducing direct connector calls - UPI Payment Method: Adds support for popular Indian payment method through unified interface - Enhanced Status Handling: More granular payment states for better payment lifecycle tracking Architectural Improvements: - Separation of Concerns: Split monolithic UCS functions into prerequisite preparation and decision logic phases - Better Feature Flag Management: Clean V1/V2 separation using `#[cfg(feature = "v2")]` prevents conflicts - Enhanced Error Handling: Improved response parsing and identifier handling for better reliability - Maintainability: Cleaner code structure for easier debugging and future enhancements Business Value: - Future-Proofing: V2 schema supports upcoming UCS enhancements and new payment flows - Improved Reliability: Better error handling and response parsing reduces failure rates - Enhanced Developer Experience: Cleaner API interfaces and better type safety - Operational Excellence: Maintains existing rollout controls while improving monitoring capabilities - Broader Payment Support: UPI integration opens up access to Indian market payment preferences ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> ### Manual Testing (HAPPY CASE) #### V2 Payment Intent Creation (Adyen via UCS) Request: ```bash curl --location 'http://localhost:8080/v2/payments/create-intent' \ --header 'api-key: dev_ymXSN8By3WESknjGnFyLVwDE4tK9v8ZjnkMZsKb2cM7KgjlzLfU1SOnJ63LsIrfR' \ --header 'Content-Type: application/json' \ --header 'x-profile-id: pro_2MBjeGslBsr2Lr7AoLvr' \ --header 'Authorization: api-key=dev_ymXSN8By3WESknjGnFyLVwDE4tK9v8ZjnkMZsKb2cM7KgjlzLfU1SOnJ63LsIrfR' \ --data '{ "amount_details": { "order_amount": 100, "currency": "USD" }, "capture_method": "automatic", "authentication_type": "no_three_ds", "customer_id": "12345_cus_0197abe38df57a408b928b4111ff5038", "billing": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" } }, "shipping": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" } } }' ``` Response: ```json { "id": "12345_pay_0197ac4f440c73c0b34c7050d248e483", "status": "requires_payment_method", "amount_details": { "order_amount": 100, "currency": "USD", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null }, "client_secret": "cs_0197ac4f4421744094d3abffdeae634c", "profile_id": "pro_2MBjeGslBsr2Lr7AoLvr", "merchant_reference_id": null, "routing_algorithm_id": null, "capture_method": "automatic", "authentication_type": "no_three_ds", "billing": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "joseph", "last_name": "Doe" }, "phone": null, "email": null }, "shipping": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "joseph", "last_name": "Doe" }, "phone": null, "email": null }, "customer_id": "12345_cus_0197abe38df57a408b928b4111ff5038", "customer_present": "present", "description": null, "return_url": null, "setup_future_usage": "on_session", "apply_mit_exemption": "Skip", "statement_descriptor": null, "order_details": null, "allowed_payment_method_types": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "payment_link_enabled": "Skip", "payment_link_config": null, "request_incremental_authorization": "default", "expires_on": "2025-06-26T13:11:05.403Z", "frm_metadata": null, "request_external_three_ds_authentication": "Skip" } ``` #### V2 Payment Confirmation (Adyen via UCS) Request: ```bash curl --location 'http://localhost:8080/v2/payments/12345_pay_0197ac4f440c73c0b34c7050d248e483/confirm-intent' \ --header 'x-client-secret: cs_0197ac4f4421744094d3abffdeae634c' \ --header 'x-profile-id: pro_2MBjeGslBsr2Lr7AoLvr' \ --header 'x-connected-merchant-id: cloth_seller_2_X5u3WjKKaUMMtPMYCNQM' \ --header 'Authorization: publishable-key=pk_dev_b78d41b686d54407842e55c1be492fce,client-secret=cs_0197ac4f4421744094d3abffdeae634c' \ --header 'Content-Type: application/json' \ --header 'api-key: pk_dev_b78d41b686d54407842e55c1be492fce' \ --data '{ "payment_method_type": "card", "payment_method_subtype": "credit", "payment_method_data": { "card": { "card_number": "4111111111111111", "card_exp_month": "03", "card_exp_year": "30", "card_holder_name": "Joseph Doe", "card_cvc": "737" } }, "browser_info": { "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8", "language": "nl-NL", "color_depth": 24, "screen_height": 723, "screen_width": 1536, "time_zone": 0, "java_enabled": true, "java_script_enabled": true } }' ``` Response: ```json { "id": "12345_pay_0197ac4f440c73c0b34c7050d248e483", "status": "succeeded", "amount": { "order_amount": 100, "currency": "USD", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null, "net_amount": 100, "amount_to_capture": null, "amount_capturable": 0, "amount_captured": 100 }, "customer_id": "12345_cus_0197abe38df57a408b928b4111ff5038", "connector": "adyen", "created": "2025-06-26T12:56:05.403Z", "payment_method_data": { "billing": null }, "payment_method_type": "card", "payment_method_subtype": "credit", "connector_transaction_id": "12345_pay_0197ac4f440c73c0b34c7050d248e483", "connector_reference_id": null, "merchant_connector_id": "mca_YUhrsoeHfh0EQJE6Zqut", "browser_info": null, "error": null, "shipping": null, "billing": null, "attempts": null, "connector_token_details": null, "payment_method_id": null, "next_action": null, "return_url": "https://google.com/success", "authentication_type": "no_three_ds", "authentication_type_applied": "no_three_ds", "is_iframe_redirection_enabled": null, "merchant_reference_id": null } ``` #### V2 Payment Intent Creation (Adyen via Traditional Connector Flow) Request: ```bash curl --location 'http://localhost:8080/v2/payments/create-intent' \ --header 'api-key: dev_ymXSN8By3WESknjGnFyLVwDE4tK9v8ZjnkMZsKb2cM7KgjlzLfU1SOnJ63LsIrfR' \ --header 'Content-Type: application/json' \ --header 'x-profile-id: pro_2MBjeGslBsr2Lr7AoLvr' \ --header 'Authorization: api-key=dev_ymXSN8By3WESknjGnFyLVwDE4tK9v8ZjnkMZsKb2cM7KgjlzLfU1SOnJ63LsIrfR' \ --data '{ "amount_details": { "order_amount": 100, "currency": "USD" }, "capture_method": "automatic", "authentication_type": "no_three_ds", "customer_id": "12345_cus_0197abe38df57a408b928b4111ff5038", "billing": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" } }, "shipping": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" } } }' ``` Response: ```json { "id": "12345_pay_0197ac4c67657d81a796bc358b364d04", "status": "requires_payment_method", "amount_details": { "order_amount": 100, "currency": "USD", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null }, "client_secret": "cs_0197ac4c67ac7731907d52f9dac88996", "profile_id": "pro_2MBjeGslBsr2Lr7AoLvr", "merchant_reference_id": null, "routing_algorithm_id": null, "capture_method": "automatic", "authentication_type": "no_three_ds", "billing": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "joseph", "last_name": "Doe" }, "phone": null, "email": null }, "shipping": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "joseph", "last_name": "Doe" }, "phone": null, "email": null }, "customer_id": "12345_cus_0197abe38df57a408b928b4111ff5038", "customer_present": "present", "description": null, "return_url": null, "setup_future_usage": "on_session", "apply_mit_exemption": "Skip", "statement_descriptor": null, "order_details": null, "allowed_payment_method_types": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "payment_link_enabled": "Skip", "payment_link_config": null, "request_incremental_authorization": "default", "expires_on": "2025-06-26T13:07:57.887Z", "frm_metadata": null, "request_external_three_ds_authentication": "Skip" } ``` #### V2 Payment Confirmation (Adyen via Traditional Connector Flow) Request: ```bash curl --location 'http://localhost:8080/v2/payments/12345_pay_0197ac4c67657d81a796bc358b364d04/confirm-intent' \ --header 'x-client-secret: cs_0197ac4c67ac7731907d52f9dac88996' \ --header 'x-profile-id: pro_2MBjeGslBsr2Lr7AoLvr' \ --header 'x-connected-merchant-id: cloth_seller_2_X5u3WjKKaUMMtPMYCNQM' \ --header 'Authorization: publishable-key=pk_dev_b78d41b686d54407842e55c1be492fce,client-secret=cs_0197ac4c67ac7731907d52f9dac88996' \ --header 'Content-Type: application/json' \ --header 'api-key: pk_dev_b78d41b686d54407842e55c1be492fce' \ --data '{ "payment_method_type": "card", "payment_method_subtype": "credit", "payment_method_data": { "card": { "card_number": "4111111111111111", "card_exp_month": "03", "card_exp_year": "30", "card_holder_name": "Joseph Doe", "card_cvc": "737" } }, "browser_info": { "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8", "language": "nl-NL", "color_depth": 24, "screen_height": 723, "screen_width": 1536, "time_zone": 0, "java_enabled": true, "java_script_enabled": true } }' ``` Response: ```json { "id": "12345_pay_0197ac4c67657d81a796bc358b364d04", "status": "succeeded", "amount": { "order_amount": 100, "currency": "USD", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null, "net_amount": 100, "amount_to_capture": null, "amount_capturable": 0, "amount_captured": 100 }, "customer_id": "12345_cus_0197abe38df57a408b928b4111ff5038", "connector": "adyen", "created": "2025-06-26T12:52:57.887Z", "payment_method_data": { "billing": null }, "payment_method_type": "card", "payment_method_subtype": "credit", "connector_transaction_id": "K2LGMPJFQZ9TPM75", "connector_reference_id": null, "merchant_connector_id": "mca_YUhrsoeHfh0EQJE6Zqut", "browser_info": null, "error": null, "shipping": null, "billing": null, "attempts": null, "connector_token_details": null, "payment_method_id": null, "next_action": null, "return_url": "https://google.com/success", "authentication_type": "no_three_ds", "authentication_type_applied": "no_three_ds", "is_iframe_redirection_enabled": null, "merchant_reference_id": null } ``` ### Manual Testing (FAILURE CASE) #### V2 Payment Intent Creation (Adyen via UCS) Request: ```bash curl --location 'http://localhost:8080/v2/payments/create-intent' \ --header 'api-key: dev_ymXSN8By3WESknjGnFyLVwDE4tK9v8ZjnkMZsKb2cM7KgjlzLfU1SOnJ63LsIrfR' \ --header 'Content-Type: application/json' \ --header 'x-profile-id: pro_2MBjeGslBsr2Lr7AoLvr' \ --header 'Authorization: api-key=dev_ymXSN8By3WESknjGnFyLVwDE4tK9v8ZjnkMZsKb2cM7KgjlzLfU1SOnJ63LsIrfR' \ --data '{ "amount_details": { "order_amount": 100, "currency": "USD" }, "capture_method": "automatic", "authentication_type": "no_three_ds", "customer_id": "12345_cus_0197abe38df57a408b928b4111ff5038", "billing": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" } }, "shipping": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" } } }' ``` Response: ```json { "id": "12345_pay_0197ac52cee5796099a0ae352092a707", "status": "requires_payment_method", "amount_details": { "order_amount": 100, "currency": "USD", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null }, "client_secret": "cs_0197ac52cefb77e2be6097f5d54b1152", "profile_id": "pro_2MBjeGslBsr2Lr7AoLvr", "merchant_reference_id": null, "routing_algorithm_id": null, "capture_method": "automatic", "authentication_type": "no_three_ds", "billing": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "joseph", "last_name": "Doe" }, "phone": null, "email": null }, "shipping": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "joseph", "last_name": "Doe" }, "phone": null, "email": null }, "customer_id": "12345_cus_0197abe38df57a408b928b4111ff5038", "customer_present": "present", "description": null, "return_url": null, "setup_future_usage": "on_session", "apply_mit_exemption": "Skip", "statement_descriptor": null, "order_details": null, "allowed_payment_method_types": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "payment_link_enabled": "Skip", "payment_link_config": null, "request_incremental_authorization": "default", "expires_on": "2025-06-26T13:14:57.559Z", "frm_metadata": null, "request_external_three_ds_authentication": "Skip" } ``` #### V2 Payment Confirmation (Adyen via UCS) Request: ```bash curl --location 'http://localhost:8080/v2/payments/12345_pay_0197ac52cee5796099a0ae352092a707/confirm-intent' \ --header 'x-client-secret: cs_0197ac52cefb77e2be6097f5d54b1152' \ --header 'x-profile-id: pro_2MBjeGslBsr2Lr7AoLvr' \ --header 'x-connected-merchant-id: cloth_seller_2_X5u3WjKKaUMMtPMYCNQM' \ --header 'Authorization: publishable-key=pk_dev_b78d41b686d54407842e55c1be492fce,client-secret=cs_0197ac52cefb77e2be6097f5d54b1152' \ --header 'Content-Type: application/json' \ --header 'api-key: pk_dev_b78d41b686d54407842e55c1be492fce' \ --data '{ "payment_method_type": "card", "payment_method_subtype": "credit", "payment_method_data": { "card": { "card_number": "4111111111111111", "card_exp_month": "03", "card_exp_year": "30", "card_holder_name": "Joseph Doe", "card_cvc": "730" } }, "browser_info": { "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8", "language": "nl-NL", "color_depth": 24, "screen_height": 723, "screen_width": 1536, "time_zone": 0, "java_enabled": true, "java_script_enabled": true } }' ``` Response: ```json { "id": "12345_pay_0197ac52cee5796099a0ae352092a707", "status": "failed", "amount": { "order_amount": 100, "currency": "USD", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null, "net_amount": 100, "amount_to_capture": null, "amount_capturable": 0, "amount_captured": 0 }, "customer_id": "12345_cus_0197abe38df57a408b928b4111ff5038", "connector": "adyen", "created": "2025-06-26T12:59:57.559Z", "payment_method_data": { "billing": null }, "payment_method_type": "card", "payment_method_subtype": "credit", "connector_transaction_id": "G4QT66CH8WCFHJ75", "connector_reference_id": null, "merchant_connector_id": "mca_YUhrsoeHfh0EQJE6Zqut", "browser_info": null, "error": { "code": "24", "message": "CVC Declined", "unified_code": null, "unified_message": null, "network_advice_code": null, "network_decline_code": null, "network_error_message": null }, "shipping": null, "billing": null, "attempts": null, "connector_token_details": null, "payment_method_id": null, "next_action": null, "return_url": "https://google.com/success", "authentication_type": "no_three_ds", "authentication_type_applied": "no_three_ds", "is_iframe_redirection_enabled": null, "merchant_reference_id": null } ``` #### V2 Payment Intent Creation (Adyen via Traditional Connector Flow) Request: ```bash curl --location 'http://localhost:8080/v2/payments/create-intent' \ --header 'api-key: dev_ymXSN8By3WESknjGnFyLVwDE4tK9v8ZjnkMZsKb2cM7KgjlzLfU1SOnJ63LsIrfR' \ --header 'Content-Type: application/json' \ --header 'x-profile-id: pro_2MBjeGslBsr2Lr7AoLvr' \ --header 'Authorization: api-key=dev_ymXSN8By3WESknjGnFyLVwDE4tK9v8ZjnkMZsKb2cM7KgjlzLfU1SOnJ63LsIrfR' \ --data '{ "amount_details": { "order_amount": 100, "currency": "USD" }, "capture_method": "automatic", "authentication_type": "no_three_ds", "customer_id": "12345_cus_0197abe38df57a408b928b4111ff5038", "billing": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" } }, "shipping": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" } } }' ``` Response: ```json { "id": "12345_pay_0197ac5574b37982b150606298590cfb", "status": "requires_payment_method", "amount_details": { "order_amount": 100, "currency": "USD", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null }, "client_secret": "cs_0197ac5574c57c50b773a7230ffffe69", "profile_id": "pro_2MBjeGslBsr2Lr7AoLvr", "merchant_reference_id": null, "routing_algorithm_id": null, "capture_method": "automatic", "authentication_type": "no_three_ds", "billing": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "joseph", "last_name": "Doe" }, "phone": null, "email": null }, "shipping": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "joseph", "last_name": "Doe" }, "phone": null, "email": null }, "customer_id": "12345_cus_0197abe38df57a408b928b4111ff5038", "customer_present": "present", "description": null, "return_url": null, "setup_future_usage": "on_session", "apply_mit_exemption": "Skip", "statement_descriptor": null, "order_details": null, "allowed_payment_method_types": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "payment_link_enabled": "Skip", "payment_link_config": null, "request_incremental_authorization": "default", "expires_on": "2025-06-26T13:17:51.072Z", "frm_metadata": null, "request_external_three_ds_authentication": "Skip" } ``` #### V2 Payment Confirmation (Adyen via Traditional Connector Flow) Request: ```bash curl --location 'http://localhost:8080/v2/payments/12345_pay_0197ac5574b37982b150606298590cfb/confirm-intent' \ --header 'x-client-secret: cs_0197ac5574c57c50b773a7230ffffe69' \ --header 'x-profile-id: pro_2MBjeGslBsr2Lr7AoLvr' \ --header 'x-connected-merchant-id: cloth_seller_2_X5u3WjKKaUMMtPMYCNQM' \ --header 'Authorization: publishable-key=pk_dev_b78d41b686d54407842e55c1be492fce,client-secret=cs_0197ac5574c57c50b773a7230ffffe69' \ --header 'Content-Type: application/json' \ --header 'api-key: pk_dev_b78d41b686d54407842e55c1be492fce' \ --data '{ "payment_method_type": "card", "payment_method_subtype": "credit", "payment_method_data": { "card": { "card_number": "4111111111111111", "card_exp_month": "03", "card_exp_year": "30", "card_holder_name": "Joseph Doe", "card_cvc": "730" } }, "browser_info": { "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8", "language": "nl-NL", "color_depth": 24, "screen_height": 723, "screen_width": 1536, "time_zone": 0, "java_enabled": true, "java_script_enabled": true } }' ``` Response: ```json { "id": "12345_pay_0197ac5574b37982b150606298590cfb", "status": "failed", "amount": { "order_amount": 100, "currency": "USD", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null, "net_amount": 100, "amount_to_capture": null, "amount_capturable": 0, "amount_captured": 0 }, "customer_id": "12345_cus_0197abe38df57a408b928b4111ff5038", "connector": "adyen", "created": "2025-06-26T13:02:51.072Z", "payment_method_data": { "billing": null }, "payment_method_type": "card", "payment_method_subtype": "credit", "connector_transaction_id": "DXZQPDL34QGTPM75", "connector_reference_id": null, "merchant_connector_id": "mca_YUhrsoeHfh0EQJE6Zqut", "browser_info": null, "error": { "code": "24", "message": "CVC Declined", "unified_code": null, "unified_message": null, "network_advice_code": null, "network_decline_code": null, "network_error_message": "DECLINED CVC Incorrect" }, "shipping": null, "billing": null, "attempts": null, "connector_token_details": null, "payment_method_id": null, "next_action": null, "return_url": "https://google.com/success", "authentication_type": "no_three_ds", "authentication_type_applied": "no_three_ds", "is_iframe_redirection_enabled": null, "merchant_reference_id": null } ``` ###UPI Collect payment through UCS Request ```bash curl --location 'http://localhost:8080/v2/payments' \ --header 'x-profile-id: pro_2MBjeGslBsr2Lr7AoLvr' \ --header 'x-merchant-id: cloth_seller_2_H3Oh1h4iu0wg8BWGvMzu' \ --header 'x-tenant-id: public' \ --header 'Content-Type: application/json' \ --header 'api-key: dev_ymXSN8By3WESknjGnFyLVwDE4tK9v8ZjnkMZsKb2cM7KgjlzLfU1SOnJ63LsIrfR' \ --data-raw '{ "amount_details": { "currency": "INR", "order_amount": 1000 }, "merchant_connector_details": { "connector_name": "razorpay", "merchant_connector_creds": { "auth_type": "SignatureKey", "key1": "***********************", "api_key": "****************", "api_secret": "****************" } }, "merchant_reference_id": "12345_pay_01970c787911751013554", "payment_method_data": { "upi": { "upi_collect": { "vpa_id": "failure@razorpay" } }, "billing": { "phone": { "number": "8800574493", "country_code": "+91" }, "email": "[email protected]" } }, "payment_method_subtype": "upi_collect", "payment_method_type": "upi" }' ``` Response* ```json { "id": "12345_pay_0197ceee564473609731b2ab35827cc7", "status": "processing", "amount": { "order_amount": 1000, "currency": "INR", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null, "net_amount": 1000, "amount_to_capture": null, "amount_capturable": 0, "amount_captured": null }, "customer_id": null, "connector": "razorpay", "created": "2025-07-03T06:16:55.621Z", "payment_method_data": { "billing": { "address": null, "phone": { "number": "8800574493", "country_code": "+91" }, "email": "[email protected]" } }, "payment_method_type": "upi", "payment_method_subtype": "upi_collect", "connector_transaction_id": "pay_QoUbCBtcPCfaWY", "connector_reference_id": "order_QoUbBDL6PKnuZY", "merchant_connector_id": null, "browser_info": null, "error": null, "shipping": null, "billing": null, "attempts": null, "connector_token_details": null, "payment_method_id": null, "next_action": null, "return_url": "https://google.com/success", "authentication_type": null, "authentication_type_applied": "no_three_ds", "is_iframe_redirection_enabled": null, "merchant_reference_id": "12345_pay_01970c787911751013554", "whole_connector_response": null } ``` ### PSync through UCS Request ```bash curl --location 'http://localhost:8080/v2/payments/12345_pay_0197ceee564473609731b2ab35827cc7' \ --header 'x-profile-id: pro_2MBjeGslBsr2Lr7AoLvr' \ --header 'x-merchant-id: cloth_seller_2_H3Oh1h4iu0wg8BWGvMzu' \ --header 'x-tenant-id: public' \ --header 'Content-Type: application/json' \ --header 'api-key: dev_ymXSN8By3WESknjGnFyLVwDE4tK9v8ZjnkMZsKb2cM7KgjlzLfU1SOnJ63LsIrfR' \ --data '{ "merchant_connector_details": { "connector_name": "razorpay", "merchant_connector_creds": { "auth_type": "SignatureKey", "key1": "************", "api_key": "****************", "api_secret": "***************" } }, "force_sync": true }'``` Response* ```json { "id": "12345_pay_0197ceee564473609731b2ab35827cc7", "status": "failed", "amount": { "order_amount": 1000, "currency": "INR", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null, "net_amount": 1000, "amount_to_capture": null, "amount_capturable": 0, "amount_captured": 0 }, "customer_id": null, "connector": "razorpay", "created": "2025-07-03T06:16:55.621Z", "payment_method_data": { "billing": { "address": null, "phone": { "number": "8800574493", "country_code": "+91" }, "email": "[email protected]" } }, "payment_method_type": "upi", "payment_method_subtype": "upi_collect", "connector_transaction_id": "pay_QoUbCBtcPCfaWY", "connector_reference_id": "order_QoUbBDL6PKnuZY", "merchant_connector_id": null, "browser_info": null, "error": { "code": "", "message": "", "unified_code": null, "unified_message": null, "network_advice_code": null, "network_decline_code": null, "network_error_message": null }, "shipping": null, "billing": null, "attempts": null, "connector_token_details": null, "payment_method_id": null, "next_action": null, "return_url": "https://google.com/success", "authentication_type": null, "authentication_type_applied": null, "is_iframe_redirection_enabled": null, "merchant_reference_id": "12345_pay_01970c787911751013554", "whole_connector_response": null } ``` V2 Schema Testing: - V2 gRPC schema compatibility verification - `PaymentServiceAuthorizeRequest` field mapping validation - Enhanced card details and address structure testing - Response identifier parsing with new structure Fallback Testing: - UCS service unavailable → Automatic fallback to traditional connector flow - Invalid authentication → Fallback with error logging - V2 transformer errors → Graceful degradation to V1 flow - Rollout percentage = 0% → Traditional flow used - Rollout percentage = 100% → UCS V2 flow used ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	b1c9be1600dbd897c32adcc2d8b98e77ec67c516	b1c9be1600dbd897c32adcc2d8b98e77ec67c516
juspay/hyperswitch	juspay__hyperswitch-8437	Bug: [REFACTOR] allow option for skipping billing details during batched data migration Problem Statement Currently, `/migrate-batch` API has below mandatory parameters ```rust { pub customer_id: id_type::CustomerId, pub nick_name: masking::Secret<String>, pub card_number_masked: masking::Secret<String>, pub card_expiry_month: masking::Secret<String>, pub card_expiry_year: masking::Secret<String>, pub billing_address_zip: masking::Secret<String>, pub billing_address_state: masking::Secret<String>, pub billing_address_first_name: masking::Secret<String>, pub billing_address_last_name: masking::Secret<String>, pub billing_address_city: String, pub billing_address_line1: masking::Secret<String>, } ``` Billing details are mandatory but there can be use cases when these details are not be required by the underlying connector during payments. For such cases, these details become a blocker for using the migrate API. These can be made optional. Proposed Solution Fields related to billing details can be made `Optional`	diff --git a/crates/api_models/src/payment_methods.rs b/crates/api_models/src/payment_methods.rs index 5ecd2f71ef7..25b583f5dc4 100644 --- a/crates/api_models/src/payment_methods.rs +++ b/crates/api_models/src/payment_methods.rs @@ -2481,7 +2481,7 @@ pub struct PaymentMethodRecord { pub merchant_id: Option<id_type::MerchantId>, pub payment_method: Option<api_enums::PaymentMethod>, pub payment_method_type: Option<api_enums::PaymentMethodType>, - pub nick_name: masking::Secret<String>, + pub nick_name: Option<masking::Secret<String>>, pub payment_instrument_id: Option<masking::Secret<String>>, pub connector_customer_id: Option<String>, pub card_number_masked: masking::Secret<String>, @@ -2489,13 +2489,13 @@ pub struct PaymentMethodRecord { pub card_expiry_year: masking::Secret<String>, pub card_scheme: Option<String>, pub original_transaction_id: Option<String>, - pub billing_address_zip: masking::Secret<String>, - pub billing_address_state: masking::Secret<String>, - pub billing_address_first_name: masking::Secret<String>, - pub billing_address_last_name: masking::Secret<String>, - pub billing_address_city: String, + pub billing_address_zip: Option<masking::Secret<String>>, + pub billing_address_state: Option<masking::Secret<String>>, + pub billing_address_first_name: Option<masking::Secret<String>>, + pub billing_address_last_name: Option<masking::Secret<String>>, + pub billing_address_city: Option<String>, pub billing_address_country: Option<api_enums::CountryAlpha2>, - pub billing_address_line1: masking::Secret<String>, + pub billing_address_line1: Option<masking::Secret<String>>, pub billing_address_line2: Option<masking::Secret<String>>, pub billing_address_line3: Option<masking::Secret<String>>, pub raw_card_number: Option<masking::Secret<String>>, @@ -2548,6 +2548,57 @@ pub enum MigrationStatus { Failed, } +impl PaymentMethodRecord { + fn create_address(&self) -> Option<payments::AddressDetails> { + if self.billing_address_first_name.is_some() + && self.billing_address_line1.is_some() + && self.billing_address_zip.is_some() + && self.billing_address_city.is_some() + && self.billing_address_country.is_some() + { + Some(payments::AddressDetails { + city: self.billing_address_city.clone(), + country: self.billing_address_country, + line1: self.billing_address_line1.clone(), + line2: self.billing_address_line2.clone(), + state: self.billing_address_state.clone(), + line3: self.billing_address_line3.clone(), + zip: self.billing_address_zip.clone(), + first_name: self.billing_address_first_name.clone(), + last_name: self.billing_address_last_name.clone(), + }) + } else { + None + } + } + + fn create_phone(&self) -> Option<payments::PhoneDetails> { + if self.phone.is_some() \|\| self.phone_country_code.is_some() { + Some(payments::PhoneDetails { + number: self.phone.clone(), + country_code: self.phone_country_code.clone(), + }) + } else { + None + } + } + + fn create_billing(&self) -> Option<payments::Address> { + let address = self.create_address(); + let phone = self.create_phone(); + + if address.is_some() \|\| phone.is_some() \|\| self.email.is_some() { + Some(payments::Address { + address, + phone, + email: self.email.clone(), + }) + } else { + None + } + } +} + #[cfg(feature = "v1")] type PaymentMethodMigrationResponseType = ( Result<PaymentMethodMigrateResponse, String>, @@ -2600,6 +2651,7 @@ impl ), ) -> Result<Self, Self::Error> { let (record, merchant_id, mca_id) = item; + let billing = record.create_billing(); // if payment instrument id is present then only construct this let connector_mandate_details = if record.payment_instrument_id.is_some() { @@ -2631,7 +2683,7 @@ impl card_type: None, card_issuer: None, card_issuing_country: None, - nick_name: Some(record.nick_name.clone()), + nick_name: record.nick_name.clone(), }), network_token: Some(MigrateNetworkTokenDetail { network_token_data: MigrateNetworkTokenData { @@ -2639,7 +2691,7 @@ impl network_token_exp_month: record.network_token_expiry_month.unwrap_or_default(), network_token_exp_year: record.network_token_expiry_year.unwrap_or_default(), card_holder_name: record.name, - nick_name: Some(record.nick_name.clone()), + nick_name: record.nick_name.clone(), card_issuing_country: None, card_network: None, card_issuer: None, @@ -2652,24 +2704,7 @@ impl payment_method: record.payment_method, payment_method_type: record.payment_method_type, payment_method_issuer: None, - billing: Some(payments::Address { - address: Some(payments::AddressDetails { - city: Some(record.billing_address_city), - country: record.billing_address_country, - line1: Some(record.billing_address_line1), - line2: record.billing_address_line2, - state: Some(record.billing_address_state), - line3: record.billing_address_line3, - zip: Some(record.billing_address_zip), - first_name: Some(record.billing_address_first_name), - last_name: Some(record.billing_address_last_name), - }), - phone: Some(payments::PhoneDetails { - number: record.phone, - country_code: record.phone_country_code, - }), - email: record.email, - }), + billing, connector_mandate_details: connector_mandate_details.map( \|payments_mandate_reference\| { CommonMandateReference::from(payments_mandate_reference) @@ -2683,7 +2718,7 @@ impl #[cfg(feature = "payouts")] wallet: None, payment_method_data: None, - network_transaction_id: record.original_transaction_id, + network_transaction_id: record.original_transaction_id.clone(), }) } } @@ -2702,15 +2737,15 @@ impl From<(PaymentMethodRecord, id_type::MerchantId)> for PaymentMethodCustomerM description: None, phone_country_code: record.phone_country_code, address: Some(payments::AddressDetails { - city: Some(record.billing_address_city), + city: record.billing_address_city, country: record.billing_address_country, - line1: Some(record.billing_address_line1), + line1: record.billing_address_line1, line2: record.billing_address_line2, - state: Some(record.billing_address_state), + state: record.billing_address_state, line3: record.billing_address_line3, - zip: Some(record.billing_address_zip), - first_name: Some(record.billing_address_first_name), - last_name: Some(record.billing_address_last_name), + zip: record.billing_address_zip, + first_name: record.billing_address_first_name, + last_name: record.billing_address_last_name, }), metadata: None, }, diff --git a/crates/payment_methods/src/core/migration/payment_methods.rs b/crates/payment_methods/src/core/migration/payment_methods.rs index 10808f08a25..5c30698f615 100644 --- a/crates/payment_methods/src/core/migration/payment_methods.rs +++ b/crates/payment_methods/src/core/migration/payment_methods.rs @@ -184,7 +184,7 @@ pub async fn populate_bin_details_for_masked_card( card_number.peek(), ) .change_context(errors::ApiErrorResponse::InvalidRequestData { - message: "Invalid card number".to_string(), + message: "Invalid masked card number".to_string(), })?; let card_bin_details = if card_details.card_issuer.is_some() @@ -223,7 +223,7 @@ impl let (card_isin, last4_digits) = get_card_bin_and_last4_digits_for_masked_card(card_details.card_number.peek()) .change_context(errors::ApiErrorResponse::InvalidRequestData { - message: "Invalid card number".to_string(), + message: "Invalid masked card number".to_string(), })?; if let Some(card_bin_info) = card_info { Ok(Self { @@ -298,7 +298,7 @@ impl let (card_isin, last4_digits) = get_card_bin_and_last4_digits_for_masked_card(card_details.card_number.peek()) .change_context(errors::ApiErrorResponse::InvalidRequestData { - message: "Invalid card number".to_string(), + message: "Invalid masked card number".to_string(), })?; if let Some(card_bin_info) = card_info { Ok(Self {	2025-06-23T19:23:01Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [ ] New feature - [ ] Enhancement - [x] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description This PR includes changes to make billing details related fields optional during batched operation of data migration. ### Additional Changes - [x] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context Allows merchants who use connectors which does not mandate address fields to be present during a payment txn to be able to migrate their data. Billing details will not be mandated during batched operation of data migration. ## How did you test it? 1. Create MCA <details> <summary>2. Run batch migration</summary> cURL curl --location --request POST 'http://localhost:8080/payment_methods/migrate-batch' \ --header 'api-key: test_admin' \ --form 'merchant_id="merchant_1750764063"' \ --form 'merchant_connector_id="mca_F0qqizsBSwbZ77gQYLRs"' \ --form 'file=@"sample.csv"' Response [{"line_number":1,"payment_method_id":"pm_wY7TUBMPZZISgu2Zf74M","payment_method":"card","payment_method_type":"debit","customer_id":"45CC60D1F2283097BB1DE41A2636414445908518D50B8B4CDC57959CD7FB4539","migration_status":"Success","card_number_masked":"4360000 xxxx 0005","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":2,"payment_method_id":"pm_gNTfSTNVhvlURJPnsiYQ","payment_method":"card","payment_method_type":"credit","customer_id":"782BC898951D910C1A99DA69A4E4FAD6CEE53AB9311FA2C552028DA89428DB7F","migration_status":"Success","card_number_masked":"4111111 xxxx 1111","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":3,"payment_method_id":"pm_EeJ2hgF3OmHgTFEfe58X","payment_method":"card","payment_method_type":"credit","customer_id":"C81CC958611A803D9CC3E2E7818A1691943E3143E6DF603A7F45E55BA7629938","migration_status":"Success","card_number_masked":"222300 xxxx 0010","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":4,"payment_method_id":"pm_p1ckEakoWB12EtHYtjtm","payment_method":"card","payment_method_type":"credit","customer_id":"9F4BB23B3ED615753F5A27CF6D75274713B30A67ACFEA7CE44B058F6AC044E33","migration_status":"Success","card_number_masked":"5555555 xxxx 4444","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":5,"payment_method_id":"pm_0HrpkOfnLuIPSJiU3fdZ","payment_method":"card","payment_method_type":"debit","customer_id":"B22BFDD8BB5840B5F6EE0026A430B72359C50E631C7A2D9D2BC014BDB1EB212C","migration_status":"Success","card_number_masked":"222300 xxxx 0010","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":6,"payment_method_id":"pm_iOtdYdcOErhUz4bXmZgX","payment_method":"card","payment_method_type":"credit","customer_id":"EECB88827D346EDCFB9AB7302B0C387C42FB5EBAD87EC0E4FA4301F6148BB22B","migration_status":"Success","card_number_masked":"557700 xxxx 0004","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":7,"payment_method_id":"pm_JnzwASYJStJUQ02LEcqf","payment_method":"card","payment_method_type":"credit","customer_id":"C81CC958611A803D9CC3E2E7818A1691943E3143E6DF603A7F45E55BA7629938","migration_status":"Success","card_number_masked":"222241 xxxx 0002","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":8,"payment_method_id":"pm_CJsKWoBsOqkRlikFMO2t","payment_method":"card","payment_method_type":"credit","customer_id":"66C96C852E423B701EF06C5109C40D72E77B4C7F4CDD108AD4FCC3DCCC38AB2F","migration_status":"Success","card_number_masked":"513029 xxxx 0009","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":9,"payment_method_id":"pm_z0jFnOfXn1andQp9qbXd","payment_method":"card","payment_method_type":"credit","customer_id":"C81CC958611A803D9CC3E2E7818A1691943E3143E6DF603A7F45E55BA7629938","migration_status":"Success","card_number_masked":"510322 xxxx 9245","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":10,"payment_method_id":"pm_4lJAPwuf8iepQCWKDub1","payment_method":"card","payment_method_type":"credit","customer_id":"C81CC958611A803D9CC3E2E7818A1691943E3143E6DF603A7F45E55BA7629938","migration_status":"Success","card_number_masked":"222241 xxxx 0002","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":11,"payment_method_id":"pm_J1ZMlj5lzHyf2P5Lid6S","payment_method":"card","payment_method_type":"credit","customer_id":"ADE2795AC3C88525528F0DB95677BE9DB27E792850B1A67CA654BFFAEB31AFE3","migration_status":"Success","card_number_masked":"222241 xxxx 0018","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":12,"payment_method_id":"pm_zySRb0JCNxcCMH2Ubocc","payment_method":"card","payment_method_type":"credit","customer_id":"ADE2795AC3C88525528F0DB95677BE9DB27E792850B1A67CA654BFFAEB31AFE3","migration_status":"Success","card_number_masked":"411111 xxxx 1111","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":13,"payment_method_id":"pm_M9wKyu4kEYNcHIjyrVfI","payment_method":"card","payment_method_type":"credit","customer_id":"D83D0437F8883C26C75C04756D95E21B90877020743EA1C1CC49883A90E8DF97","migration_status":"Success","card_number_masked":"411111 xxxx 1111","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":14,"payment_method_id":"pm_RDiPAalAZkCj1uOqKYSb","payment_method":"card","payment_method_type":"credit","customer_id":"ADE2795AC3C88525528F0DB95677BE9DB27E792850B1A67CA654BFFAEB31AFE3","migration_status":"Success","card_number_masked":"624303 xxxx 0001","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":15,"payment_method_id":"pm_0XTr9lrG6LGNl9d4iFPR","payment_method":"card","payment_method_type":"debit","customer_id":"ADE2795AC3C88525528F0DB95677BE9DB27E792850B1A67CA654BFFAEB31AFE3","migration_status":"Success","card_number_masked":"222241 xxxx 0002","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":16,"payment_method_id":"pm_aUtJIRDcCH7CIwJ2hQEk","payment_method":"card","payment_method_type":"credit","customer_id":"D83D0437F8883C26C75C04756D95E21B90877020743EA1C1CC49883A90E8DF97","migration_status":"Success","card_number_masked":"817199 xxxx 0000","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":17,"payment_method_id":"pm_THz5Ds8VHAgyJPPOA4GY","payment_method":"card","payment_method_type":"credit","customer_id":"D83D0437F8883C26C75C04756D95E21B90877020743EA1C1CC49883A90E8DF97","migration_status":"Success","card_number_masked":"464646 xxxx 4644","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":18,"payment_method_id":"pm_l82mYW4tMsRkJF4hq5fn","payment_method":"card","payment_method_type":"credit","customer_id":"ADE2795AC3C88525528F0DB95677BE9DB27E792850B1A67CA654BFFAEB31AFE3","migration_status":"Success","card_number_masked":"222240 xxxx 0007","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":19,"payment_method_id":"pm_E8fkAc9RHknoPmnYFBOa","payment_method":"card","payment_method_type":"debit","customer_id":"ADE2795AC3C88525528F0DB95677BE9DB27E792850B1A67CA654BFFAEB31AFE3","migration_status":"Success","card_number_masked":"400006 xxxx 0006","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":20,"payment_method_id":"pm_TEEJO7DdZTkl55PH8P1T","payment_method":"card","payment_method_type":"credit","customer_id":"D83D0437F8883C26C75C04756D95E21B90877020743EA1C1CC49883A90E8DF97","migration_status":"Success","card_number_masked":"497794 xxxx 9497","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":21,"payment_method_id":"pm_3gTcA4MJsTjasj2XlJs2","payment_method":"card","payment_method_type":"credit","customer_id":"C81CC958611A803D9CC3E2E7818A1691943E3143E6DF603A7F45E55BA7629938","migration_status":"Success","card_number_masked":"436000 xxxx 0005","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":22,"payment_method_id":"pm_GzUYGU3GpOXOIkWFRkM0","payment_method":"card","payment_method_type":"credit","customer_id":"C80162F403CCA7AF1CB6732291D6D53B88636BB6A9B82D2CD43AC30775925B4F","migration_status":"Success","card_number_masked":"222241 xxxx 0002","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null}] </details> ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.114.0	a3cc44c6e15ce69f39104b2ce205bed632e3971e	a3cc44c6e15ce69f39104b2ce205bed632e3971e
juspay/hyperswitch	juspay__hyperswitch-8430	Bug: [BUG] adyen connector creates connector's customer reference on the fly ### Bug Description Connector's customer ID is a unique identifier for a customer's entity in the underlying connector for HyperSwitch for mapping a customer. This identifier is stored under `connector_customer` in `customers` table. However, for Adyen - this field is a combination of merchant ID and customer ID in HyperSwitch which is unique across different merchants and customers. This is a blocker for migrated customers whose `shopperReference` (customer ID in Adyen) can be in a different format. ### Expected Behavior Adyen should rely on the `connector_customer` field for customer and fallback to any default connector specific behavior. ### Actual Behavior Adyen uses a default behavior for generating `connector_customer_id` ### Steps To Reproduce -- ### Context For The Bug -- ### Environment -- ### Have you spent some time checking if this bug has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? None	diff --git a/config/config.example.toml b/config/config.example.toml index 040e027dcf9..08589cbcc65 100644 --- a/config/config.example.toml +++ b/config/config.example.toml @@ -827,7 +827,7 @@ credit = {country = "AU,NZ,CN,HK,IN,LK,KR,MY,SG,GB,BE,FR,DE,IT,ME,NL,PL,ES,ZA,AR debit = {country = "AU,NZ,CN,HK,IN,LK,KR,MY,SG,GB,BE,FR,DE,IT,ME,NL,PL,ES,ZA,AR,BR,CO,MX,PA,UY,US,CA", currency = "AFN,ALL,DZD,AOA,ARS,AMD,AWG,AUD,AZN,BSD,BHD,BDT,BBD,BYN,BZD,BMD,BTN,BOB,VES,BAM,BWP,BRL,BND,BGN,BIF,KHR,CAD,CVE,KYD,XAF,CLP,CNY,COP,KMF,CDF,CRC,HRK,CUP,CZK,DKK,DJF,DOP,XCD,EGP,ERN,ETB,EUR,FKP,FJD,XPF,GMD,GEL,GHS,GIP,GTQ,GNF,GYD,HTG,HNL,HKD,HUF,ISK,INR,IDR,IRR,IQD,ILS,JMD,JPY,JOD,KZT,KES,KGS,KWD,LAK,LBP,LSL,LRD,LYD,MOP,MKD,MGA,MWK,MYR,MVR,MRU,MUR,MXN,MDL,MNT,MAD,MZN,MMK,NAD,NPR,ANG,NZD,NIO,NGN,VUV,KPW,NOK,OMR,PKR,PAB,PGK,PYG,PEN,PHP,PLN,GBP,QAR,RON,RUB,RWF,SHP,SVC,WST,STN,SAR,RSD,SCR,SLL,SGD,SBD,SOS,ZAR,KRW,SSP,LKR,SDG,SRD,SZL,SEK,CHF,SYP,TWD,TJS,TZS,THB,TOP,TTD,TND,TRY,TMT,UGX,UAH,AED,USD,UYU,UZS,VND,XOF,YER,ZMW,ZWL"} [connector_customer] -connector_list = "gocardless,stax,stripe,facilitapay,hyperswitch_vault" +connector_list = "adyen,facilitapay,gocardless,hyperswitch_vault,stax,stripe" payout_connector_list = "nomupay,stripe,wise" [bank_config.online_banking_fpx] diff --git a/config/deployments/integration_test.toml b/config/deployments/integration_test.toml index 513cb587176..f4c3e3815d0 100644 --- a/config/deployments/integration_test.toml +++ b/config/deployments/integration_test.toml @@ -174,7 +174,7 @@ force_cookies = true enabled = true [connector_customer] -connector_list = "gocardless,stax,stripe,facilitapay,hyperswitch_vault" +connector_list = "adyen,facilitapay,gocardless,hyperswitch_vault,stax,stripe" payout_connector_list = "nomupay,stripe,wise" [delayed_session_response] diff --git a/config/deployments/production.toml b/config/deployments/production.toml index 4b990ad0464..23f5c72e3cd 100644 --- a/config/deployments/production.toml +++ b/config/deployments/production.toml @@ -15,7 +15,7 @@ open_banking_uk.adyen.banks = "aib,bank_of_scotland,danske_bank,first_direct,fir przelewy24.stripe.banks = "alior_bank,bank_millennium,bank_nowy_bfg_sa,bank_pekao_sa,banki_spbdzielcze,blik,bnp_paribas,boz,citi,credit_agricole,e_transfer_pocztowy24,getin_bank,idea_bank,inteligo,mbank_mtransfer,nest_przelew,noble_pay,pbac_z_ipko,plus_bank,santander_przelew24,toyota_bank,volkswagen_bank" [connector_customer] -connector_list = "stax,stripe,gocardless,facilitapay,hyperswitch_vault" +connector_list = "adyen,facilitapay,gocardless,hyperswitch_vault,stax,stripe" payout_connector_list = "nomupay,stripe,wise" # Connector configuration, provided attributes will be used to fulfill API requests. diff --git a/config/deployments/sandbox.toml b/config/deployments/sandbox.toml index d00b12c751f..e09aa5f88fd 100644 --- a/config/deployments/sandbox.toml +++ b/config/deployments/sandbox.toml @@ -15,7 +15,7 @@ open_banking_uk.adyen.banks = "aib,bank_of_scotland,danske_bank,first_direct,fir przelewy24.stripe.banks = "alior_bank,bank_millennium,bank_nowy_bfg_sa,bank_pekao_sa,banki_spbdzielcze,blik,bnp_paribas,boz,citi,credit_agricole,e_transfer_pocztowy24,getin_bank,idea_bank,inteligo,mbank_mtransfer,nest_przelew,noble_pay,pbac_z_ipko,plus_bank,santander_przelew24,toyota_bank,volkswagen_bank" [connector_customer] -connector_list = "stax,stripe,gocardless,facilitapay,hyperswitch_vault" +connector_list = "adyen,facilitapay,gocardless,hyperswitch_vault,stax,stripe" payout_connector_list = "nomupay,stripe,wise" # Connector configuration, provided attributes will be used to fulfill API requests. diff --git a/config/development.toml b/config/development.toml index 95484d6b014..8107dce3886 100644 --- a/config/development.toml +++ b/config/development.toml @@ -872,7 +872,7 @@ nexixpay = { payment_method = "card" } redsys = { payment_method = "card" } [connector_customer] -connector_list = "gocardless,stax,stripe,facilitapay,hyperswitch_vault" +connector_list = "adyen,facilitapay,gocardless,hyperswitch_vault,stax,stripe" payout_connector_list = "nomupay,stripe,wise" [dummy_connector] diff --git a/config/docker_compose.toml b/config/docker_compose.toml index b029fb9987f..484dd76097a 100644 --- a/config/docker_compose.toml +++ b/config/docker_compose.toml @@ -883,7 +883,7 @@ card.debit = { connector_list = "cybersource" } connector_list = "adyen,archipel,cybersource,novalnet,stripe,worldpay" [connector_customer] -connector_list = "gocardless,stax,stripe,facilitapay,hyperswitch_vault" +connector_list = "adyen,facilitapay,gocardless,hyperswitch_vault,stax,stripe" payout_connector_list = "nomupay,stripe,wise" diff --git a/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs b/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs index c78daba6c4e..504635fe070 100644 --- a/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs @@ -1765,29 +1765,31 @@ type RecurringDetails = (Option<AdyenRecurringModel>, Option<bool>, Option<Strin fn get_recurring_processing_model( item: &PaymentsAuthorizeRouterData, ) -> Result<RecurringDetails, Error> { - match (item.request.setup_future_usage, item.request.off_session) { - (Some(storage_enums::FutureUsage::OffSession), _) => { + let shopper_reference = match item.get_connector_customer_id() { + Ok(connector_customer_id) => Some(connector_customer_id), + Err(_) => { let customer_id = item.get_customer_id()?; - let shopper_reference = format!( + Some(format!( "{}_{}", item.merchant_id.get_string_repr(), customer_id.get_string_repr() - ); + )) + } + }; + + match (item.request.setup_future_usage, item.request.off_session) { + (Some(storage_enums::FutureUsage::OffSession), _) => { let store_payment_method = item.request.is_mandate_payment(); Ok(( Some(AdyenRecurringModel::UnscheduledCardOnFile), Some(store_payment_method), - Some(shopper_reference), + shopper_reference, )) } (_, Some(true)) => Ok(( Some(AdyenRecurringModel::UnscheduledCardOnFile), None, - Some(format!( - "{}_{}", - item.merchant_id.get_string_repr(), - item.get_customer_id()?.get_string_repr() - )), + shopper_reference, )), _ => Ok((None, None, None)), } @@ -1967,17 +1969,18 @@ fn get_social_security_number(voucher_data: &VoucherData) -> Option<Secret<Strin } } -fn build_shopper_reference( - customer_id: &Option<common_utils::id_type::CustomerId>, - merchant_id: common_utils::id_type::MerchantId, -) -> Option<String> { - customer_id.clone().map(\|c_id\| { - format!( - "{}_{}", - merchant_id.get_string_repr(), - c_id.get_string_repr() - ) - }) +fn build_shopper_reference(item: &PaymentsAuthorizeRouterData) -> Option<String> { + match item.get_connector_customer_id() { + Ok(connector_customer_id) => Some(connector_customer_id), + Err(_) => match item.get_customer_id() { + Ok(customer_id) => Some(format!( + "{}_{}", + item.merchant_id.get_string_repr(), + customer_id.get_string_repr() + )), + Err(_) => None, + }, + } } impl TryFrom<(&BankDebitData, &PaymentsAuthorizeRouterData)> for AdyenPaymentMethod<'_> { @@ -2898,10 +2901,7 @@ impl TryFrom<(&AdyenRouterData<&PaymentsAuthorizeRouterData>, &Card)> for AdyenP let amount = get_amount_data(item); let auth_type = AdyenAuthType::try_from(&item.router_data.connector_auth_type)?; let shopper_interaction = AdyenShopperInteraction::from(item.router_data); - let shopper_reference = build_shopper_reference( - &item.router_data.customer_id, - item.router_data.merchant_id.clone(), - ); + let shopper_reference = build_shopper_reference(item.router_data); let (recurring_processing_model, store_payment_method, _) = get_recurring_processing_model(item.router_data)?; let browser_info = get_browser_info(item.router_data)?; @@ -3506,10 +3506,7 @@ impl let additional_data = get_additional_data(item.router_data); let country_code = get_country_code(item.router_data.get_optional_billing()); let shopper_interaction = AdyenShopperInteraction::from(item.router_data); - let shopper_reference = build_shopper_reference( - &item.router_data.customer_id, - item.router_data.merchant_id.clone(), - ); + let shopper_reference = build_shopper_reference(item.router_data); let (recurring_processing_model, store_payment_method, _) = get_recurring_processing_model(item.router_data)?; let return_url = item.router_data.request.get_router_return_url()?; @@ -5822,10 +5819,7 @@ impl let amount = get_amount_data(item); let auth_type = AdyenAuthType::try_from(&item.router_data.connector_auth_type)?; let shopper_interaction = AdyenShopperInteraction::from(item.router_data); - let shopper_reference = build_shopper_reference( - &item.router_data.customer_id, - item.router_data.merchant_id.clone(), - ); + let shopper_reference = build_shopper_reference(item.router_data); let (recurring_processing_model, store_payment_method, _) = get_recurring_processing_model(item.router_data)?; let browser_info = get_browser_info(item.router_data)?; diff --git a/loadtest/config/development.toml b/loadtest/config/development.toml index 5a59523eeb3..b82746362d0 100644 --- a/loadtest/config/development.toml +++ b/loadtest/config/development.toml @@ -554,7 +554,7 @@ gocardless = { long_lived_token = true, payment_method = "bank_debit" } billwerk = { long_lived_token = false, payment_method = "card" } [connector_customer] -connector_list = "gocardless,stax,stripe,facilitapay,hyperswitch_vault" +connector_list = "adyen,facilitapay,gocardless,hyperswitch_vault,stax,stripe" payout_connector_list = "nomupay,wise" [dummy_connector]	2025-06-24T10:42:43Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> Adyen now uses `connector_customer_id` to form `shopper_reference` if the field is present, else falls to previous implementation. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> <img width="1081" alt="Screenshot 2025-06-24 at 4 01 08 PM" src="https://github.com/user-attachments/assets/08ad7563-b19a-41a5-8729-74aa3b5f6295" /> ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.114.0	bc767b9131e2637ce90997da9018085d2dadb80b	bc767b9131e2637ce90997da9018085d2dadb80b
juspay/hyperswitch	juspay__hyperswitch-8435	Bug: [FEAT] Implement Refund for JPMorgan this connector lacks basic feature i.e., refunds. relevant docs: - https://developer.payments.jpmorgan.com/api/commerce/online-payments/overview - https://developer.payments.jpmorgan.com/api/commerce/online-payments/online-payments/online-payments#/operations/V2RefundPost	diff --git a/crates/hyperswitch_connectors/src/connectors/jpmorgan.rs b/crates/hyperswitch_connectors/src/connectors/jpmorgan.rs index 9783324c042..043f140a174 100644 --- a/crates/hyperswitch_connectors/src/connectors/jpmorgan.rs +++ b/crates/hyperswitch_connectors/src/connectors/jpmorgan.rs @@ -665,9 +665,9 @@ impl ConnectorIntegration<Execute, RefundsData, RefundsResponseData> for Jpmorga fn get_url( &self, _req: &RefundsRouterData<Execute>, - _connectors: &Connectors, + connectors: &Connectors, ) -> CustomResult<String, errors::ConnectorError> { - Err(errors::ConnectorError::NotImplemented("Refunds".to_string()).into()) + Ok(format!("{}/refunds", self.base_url(connectors))) } fn get_request_body( diff --git a/crates/hyperswitch_connectors/src/connectors/jpmorgan/transformers.rs b/crates/hyperswitch_connectors/src/connectors/jpmorgan/transformers.rs index 9f253c0ffb7..0c2f6110f30 100644 --- a/crates/hyperswitch_connectors/src/connectors/jpmorgan/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/jpmorgan/transformers.rs @@ -272,18 +272,10 @@ pub struct JpmorganPaymentsResponse { #[serde(rename_all = "camelCase")] pub struct Merchant { merchant_id: Option<String>, - merchant_software: MerchantSoftware, + merchant_software: JpmorganMerchantSoftware, merchant_category_code: Option<String>, } -#[derive(Default, Debug, Serialize, Deserialize)] -#[serde(rename_all = "camelCase")] -pub struct MerchantSoftware { - company_name: Secret<String>, - product_name: Secret<String>, - version: Option<Secret<String>>, -} - #[derive(Default, Debug, Deserialize, Serialize)] #[serde(rename_all = "camelCase")] pub struct PaymentMethodType { @@ -522,18 +514,31 @@ pub struct TransactionData { pub struct JpmorganRefundRequest { pub merchant: MerchantRefundReq, pub amount: MinorUnit, + pub currency: common_enums::Currency, } #[derive(Default, Debug, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct MerchantRefundReq { - pub merchant_software: MerchantSoftware, + pub merchant_software: JpmorganMerchantSoftware, } impl<F> TryFrom<&JpmorganRouterData<&RefundsRouterData<F>>> for JpmorganRefundRequest { type Error = error_stack::Report<errors::ConnectorError>; - fn try_from(_item: &JpmorganRouterData<&RefundsRouterData<F>>) -> Result<Self, Self::Error> { - Err(errors::ConnectorError::NotImplemented("Refunds".to_string()).into()) + fn try_from(item: &JpmorganRouterData<&RefundsRouterData<F>>) -> Result<Self, Self::Error> { + let merchant_software = JpmorganMerchantSoftware { + company_name: String::from("JPMC").into(), + product_name: String::from("Hyperswitch").into(), + }; + let merchant = MerchantRefundReq { merchant_software }; + let amount = item.amount; + let currency = item.router_data.request.currency; + + Ok(Self { + merchant, + amount, + currency, + }) } } @@ -552,7 +557,6 @@ pub struct JpmorganRefundResponse { pub remaining_refundable_amount: Option<i64>, } -#[allow(dead_code)] #[derive(Debug, Serialize, Default, Deserialize, Clone)] pub enum RefundStatus { Succeeded, @@ -571,24 +575,23 @@ impl From<RefundStatus> for common_enums::RefundStatus { } } -#[derive(Default, Debug, Clone, Serialize, Deserialize)] -pub struct RefundResponse { - id: String, - status: RefundStatus, -} - -pub fn refund_status_from_transaction_state( - transaction_state: JpmorganTransactionState, -) -> common_enums::RefundStatus { - match transaction_state { - JpmorganTransactionState::Voided \| JpmorganTransactionState::Closed => { - common_enums::RefundStatus::Success - } - JpmorganTransactionState::Declined \| JpmorganTransactionState::Error => { - common_enums::RefundStatus::Failure - } - JpmorganTransactionState::Pending \| JpmorganTransactionState::Authorized => { - common_enums::RefundStatus::Pending +impl From<(JpmorganResponseStatus, JpmorganTransactionState)> for RefundStatus { + fn from( + (response_status, transaction_state): (JpmorganResponseStatus, JpmorganTransactionState), + ) -> Self { + match response_status { + JpmorganResponseStatus::Success => match transaction_state { + JpmorganTransactionState::Voided \| JpmorganTransactionState::Closed => { + Self::Succeeded + } + JpmorganTransactionState::Declined \| JpmorganTransactionState::Error => { + Self::Failed + } + JpmorganTransactionState::Pending \| JpmorganTransactionState::Authorized => { + Self::Processing + } + }, + JpmorganResponseStatus::Denied \| JpmorganResponseStatus::Error => Self::Failed, } } } @@ -607,9 +610,11 @@ impl TryFrom<RefundsResponseRouterData<Execute, JpmorganRefundResponse>> .transaction_id .clone() .ok_or(errors::ConnectorError::ResponseHandlingFailed)?, - refund_status: refund_status_from_transaction_state( + refund_status: RefundStatus::from(( + item.response.response_status, item.response.transaction_state, - ), + )) + .into(), }), ..item.data }) @@ -638,9 +643,11 @@ impl TryFrom<RefundsResponseRouterData<RSync, JpmorganRefundSyncResponse>> Ok(Self { response: Ok(RefundsResponseData { connector_refund_id: item.response.transaction_id.clone(), - refund_status: refund_status_from_transaction_state( + refund_status: RefundStatus::from(( + item.response.response_status, item.response.transaction_state, - ), + )) + .into(), }), ..item.data })	2025-06-23T17:30:48Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [x] CI/CD ## Description <!-- Describe your changes in detail --> This PR implements refund flow for JPMorgan connector. Connector returns `Authorized` state (`Pending`). Post RSync call, the status gets updated to `Success`. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> The connector lacked this basic feature until now. Closes #8435 ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> Updated Cypress tests: <img width="558" alt="image" src="https://github.com/user-attachments/assets/cb18d34e-d6d2-4145-8e94-773ab6638389" /> There exist an issue from the connector where it returns same `transaction_id` (`connector_transaction_id`) every single time which we have no control. Because of this, refunds tend to exceed the maximum refundable amount resulting in 4xx as shown below: <img width="557" alt="image" src="https://github.com/user-attachments/assets/549c517b-cc54-4114-b034-5df64783bd68" /> <img width="477" alt="image" src="https://github.com/user-attachments/assets/47018470-5798-4a07-b480-1f0694540d68" /> ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `just clippy && jut clippy_v2` - [x] I reviewed the submitted code - [x] I added unit tests for my changes where possible <!-- @coderabbitai ignore -->	v1.114.0	786fe699c2abd1a3eb752121a1915acd2012d94a	786fe699c2abd1a3eb752121a1915acd2012d94a
juspay/hyperswitch	juspay__hyperswitch-8407	Bug: ci(connector): [ARCHIPEL] configure test cases Automate CI Checks by Fixing, Adding and Configuring Test Cases over:- - [Postman](https://github.com/juspay/hyperswitch/pull/8360) - [Cypress](https://github.com/juspay/hyperswitch/pull/8189)		2025-05-30T16:25:08Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [ ] New feature - [x] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [x] CI/CD ## Description <!-- Describe your changes in detail --> Enhancements for `archipel` Cypress Tests. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> `archipel` Cypress Tests were failing. ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> <!-- img width="720" alt="image" src="https://github.com/user-attachments/assets/23559711-59e2-41d7-8fb4-1572e524fc49" /--> <img width="726" height="962" alt="image" src="https://github.com/user-attachments/assets/ee72bc01-69a1-4afb-ac76-8c3edec1c124" /> _PS: There is an issue with Incremental Auth, not anything related to the configs, but the spec itself, addressing it in another PR because that would affect 1 other connector as well, and after it is fixed, it would affect 3 connectors in total._ ## Checklist <!-- Put an `x` in the boxes that apply --> - [ ] I formatted the code `cargo +nightly fmt --all` - [ ] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	8ccaac7c10e9366772e43d34f271d946cc4b3baa	8ccaac7c10e9366772e43d34f271d946cc4b3baa
juspay/hyperswitch	juspay__hyperswitch-8409	Bug: [FEATURE] Add routing metrics endpoint ### Feature Description Need to add an endpoint for routing metrics. Also add routing approach as a filter in payment analytics ### Possible Implementation Need to add an endpoint for routing metrics. Also add routing approach as a filter in payment analytics ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? Yes, I am willing to submit a PR!	diff --git a/crates/analytics/docs/clickhouse/scripts/payment_attempts.sql b/crates/analytics/docs/clickhouse/scripts/payment_attempts.sql index f5d0ca51fd7..6673b73fedb 100644 --- a/crates/analytics/docs/clickhouse/scripts/payment_attempts.sql +++ b/crates/analytics/docs/clickhouse/scripts/payment_attempts.sql @@ -43,6 +43,7 @@ CREATE TABLE payment_attempt_queue ( `organization_id` String, `profile_id` String, `card_network` Nullable(String), + `routing_approach` LowCardinality(Nullable(String)), `sign_flag` Int8 ) ENGINE = Kafka SETTINGS kafka_broker_list = 'kafka0:29092', kafka_topic_list = 'hyperswitch-payment-attempt-events', @@ -96,6 +97,7 @@ CREATE TABLE payment_attempts ( `organization_id` String, `profile_id` String, `card_network` Nullable(String), + `routing_approach` LowCardinality(Nullable(String)), `sign_flag` Int8, INDEX connectorIndex connector TYPE bloom_filter GRANULARITY 1, INDEX paymentMethodIndex payment_method TYPE bloom_filter GRANULARITY 1, @@ -152,6 +154,7 @@ CREATE MATERIALIZED VIEW payment_attempt_mv TO payment_attempts ( `organization_id` String, `profile_id` String, `card_network` Nullable(String), + `routing_approach` LowCardinality(Nullable(String)), `sign_flag` Int8 ) AS SELECT @@ -200,6 +203,7 @@ SELECT organization_id, profile_id, card_network, + routing_approach, sign_flag FROM payment_attempt_queue diff --git a/crates/analytics/src/core.rs b/crates/analytics/src/core.rs index 980e17bc90a..f3dd8e8eb8c 100644 --- a/crates/analytics/src/core.rs +++ b/crates/analytics/src/core.rs @@ -46,6 +46,11 @@ pub async fn get_domain_info( download_dimensions: None, dimensions: utils::get_dispute_dimensions(), }, + AnalyticsDomain::Routing => GetInfoResponse { + metrics: utils::get_payment_metrics_info(), + download_dimensions: None, + dimensions: utils::get_payment_dimensions(), + }, }; Ok(info) } diff --git a/crates/analytics/src/payments/core.rs b/crates/analytics/src/payments/core.rs index 7291d2f1fcc..e55ba2726af 100644 --- a/crates/analytics/src/payments/core.rs +++ b/crates/analytics/src/payments/core.rs @@ -410,6 +410,7 @@ pub async fn get_filters( PaymentDimensions::CardLast4 => fil.card_last_4, PaymentDimensions::CardIssuer => fil.card_issuer, PaymentDimensions::ErrorReason => fil.error_reason, + PaymentDimensions::RoutingApproach => fil.routing_approach.map(\|i\| i.as_ref().to_string()), }) .collect::<Vec<String>>(); res.query_data.push(FilterValue { diff --git a/crates/analytics/src/payments/distribution.rs b/crates/analytics/src/payments/distribution.rs index 86a2f06c5f5..ab82e48f407 100644 --- a/crates/analytics/src/payments/distribution.rs +++ b/crates/analytics/src/payments/distribution.rs @@ -37,6 +37,7 @@ pub struct PaymentDistributionRow { pub total: Option<bigdecimal::BigDecimal>, pub count: Option<i64>, pub error_message: Option<String>, + pub routing_approach: Option<DBEnumWrapper<storage_enums::RoutingApproach>>, #[serde(with = "common_utils::custom_serde::iso8601::option")] pub start_bucket: Option<PrimitiveDateTime>, #[serde(with = "common_utils::custom_serde::iso8601::option")] diff --git a/crates/analytics/src/payments/distribution/payment_error_message.rs b/crates/analytics/src/payments/distribution/payment_error_message.rs index 0a92cfbe470..d5fa0569452 100644 --- a/crates/analytics/src/payments/distribution/payment_error_message.rs +++ b/crates/analytics/src/payments/distribution/payment_error_message.rs @@ -160,6 +160,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(\|i\| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/filters.rs b/crates/analytics/src/payments/filters.rs index 668bdaa6c8b..b6ebf094e81 100644 --- a/crates/analytics/src/payments/filters.rs +++ b/crates/analytics/src/payments/filters.rs @@ -1,6 +1,6 @@ use api_models::analytics::{payments::PaymentDimensions, Granularity, TimeRange}; use common_utils::errors::ReportSwitchExt; -use diesel_models::enums::{AttemptStatus, AuthenticationType, Currency}; +use diesel_models::enums::{AttemptStatus, AuthenticationType, Currency, RoutingApproach}; use error_stack::ResultExt; use time::PrimitiveDateTime; @@ -65,4 +65,5 @@ pub struct PaymentFilterRow { pub card_issuer: Option<String>, pub error_reason: Option<String>, pub first_attempt: Option<bool>, + pub routing_approach: Option<DBEnumWrapper<RoutingApproach>>, } diff --git a/crates/analytics/src/payments/metrics.rs b/crates/analytics/src/payments/metrics.rs index 71d2e57d7fa..67dc50c5152 100644 --- a/crates/analytics/src/payments/metrics.rs +++ b/crates/analytics/src/payments/metrics.rs @@ -50,6 +50,7 @@ pub struct PaymentMetricRow { pub first_attempt: Option<bool>, pub total: Option<bigdecimal::BigDecimal>, pub count: Option<i64>, + pub routing_approach: Option<DBEnumWrapper<storage_enums::RoutingApproach>>, #[serde(with = "common_utils::custom_serde::iso8601::option")] pub start_bucket: Option<PrimitiveDateTime>, #[serde(with = "common_utils::custom_serde::iso8601::option")] diff --git a/crates/analytics/src/payments/metrics/avg_ticket_size.rs b/crates/analytics/src/payments/metrics/avg_ticket_size.rs index 10f350e30ce..8ec175cf8da 100644 --- a/crates/analytics/src/payments/metrics/avg_ticket_size.rs +++ b/crates/analytics/src/payments/metrics/avg_ticket_size.rs @@ -122,6 +122,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(\|i\| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/connector_success_rate.rs b/crates/analytics/src/payments/metrics/connector_success_rate.rs index 9e6bf31fbfb..eb4518f6d23 100644 --- a/crates/analytics/src/payments/metrics/connector_success_rate.rs +++ b/crates/analytics/src/payments/metrics/connector_success_rate.rs @@ -117,6 +117,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(\|i\| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/payment_count.rs b/crates/analytics/src/payments/metrics/payment_count.rs index 297aef4fec5..ed23a400fb7 100644 --- a/crates/analytics/src/payments/metrics/payment_count.rs +++ b/crates/analytics/src/payments/metrics/payment_count.rs @@ -108,6 +108,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(\|i\| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/payment_processed_amount.rs b/crates/analytics/src/payments/metrics/payment_processed_amount.rs index 95846924665..302acf097ed 100644 --- a/crates/analytics/src/payments/metrics/payment_processed_amount.rs +++ b/crates/analytics/src/payments/metrics/payment_processed_amount.rs @@ -122,6 +122,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(\|i\| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/payment_success_count.rs b/crates/analytics/src/payments/metrics/payment_success_count.rs index 843e2858977..d1f437d812d 100644 --- a/crates/analytics/src/payments/metrics/payment_success_count.rs +++ b/crates/analytics/src/payments/metrics/payment_success_count.rs @@ -115,6 +115,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(\|i\| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/retries_count.rs b/crates/analytics/src/payments/metrics/retries_count.rs index ced845651cf..63ebfaefca6 100644 --- a/crates/analytics/src/payments/metrics/retries_count.rs +++ b/crates/analytics/src/payments/metrics/retries_count.rs @@ -112,6 +112,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(\|i\| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/sessionized_metrics/avg_ticket_size.rs b/crates/analytics/src/payments/metrics/sessionized_metrics/avg_ticket_size.rs index e29c19bda88..a5138777361 100644 --- a/crates/analytics/src/payments/metrics/sessionized_metrics/avg_ticket_size.rs +++ b/crates/analytics/src/payments/metrics/sessionized_metrics/avg_ticket_size.rs @@ -123,6 +123,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(\|i\| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/sessionized_metrics/connector_success_rate.rs b/crates/analytics/src/payments/metrics/sessionized_metrics/connector_success_rate.rs index d8ee7fcb473..626f11aa229 100644 --- a/crates/analytics/src/payments/metrics/sessionized_metrics/connector_success_rate.rs +++ b/crates/analytics/src/payments/metrics/sessionized_metrics/connector_success_rate.rs @@ -118,6 +118,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(\|i\| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/sessionized_metrics/failure_reasons.rs b/crates/analytics/src/payments/metrics/sessionized_metrics/failure_reasons.rs index d6944d8d0bd..f19185b345e 100644 --- a/crates/analytics/src/payments/metrics/sessionized_metrics/failure_reasons.rs +++ b/crates/analytics/src/payments/metrics/sessionized_metrics/failure_reasons.rs @@ -183,6 +183,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(\|i\| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/sessionized_metrics/payment_count.rs b/crates/analytics/src/payments/metrics/sessionized_metrics/payment_count.rs index 98735b9383a..79d57477e13 100644 --- a/crates/analytics/src/payments/metrics/sessionized_metrics/payment_count.rs +++ b/crates/analytics/src/payments/metrics/sessionized_metrics/payment_count.rs @@ -109,6 +109,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(\|i\| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/sessionized_metrics/payment_processed_amount.rs b/crates/analytics/src/payments/metrics/sessionized_metrics/payment_processed_amount.rs index 453f988d229..0a2ab1f8a23 100644 --- a/crates/analytics/src/payments/metrics/sessionized_metrics/payment_processed_amount.rs +++ b/crates/analytics/src/payments/metrics/sessionized_metrics/payment_processed_amount.rs @@ -140,6 +140,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(\|i\| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/sessionized_metrics/payment_success_count.rs b/crates/analytics/src/payments/metrics/sessionized_metrics/payment_success_count.rs index 14391588b48..e59402933aa 100644 --- a/crates/analytics/src/payments/metrics/sessionized_metrics/payment_success_count.rs +++ b/crates/analytics/src/payments/metrics/sessionized_metrics/payment_success_count.rs @@ -116,6 +116,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(\|i\| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/sessionized_metrics/payments_distribution.rs b/crates/analytics/src/payments/metrics/sessionized_metrics/payments_distribution.rs index 5c6a8c6adec..d7305cd0792 100644 --- a/crates/analytics/src/payments/metrics/sessionized_metrics/payments_distribution.rs +++ b/crates/analytics/src/payments/metrics/sessionized_metrics/payments_distribution.rs @@ -119,6 +119,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(\|i\| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/sessionized_metrics/retries_count.rs b/crates/analytics/src/payments/metrics/sessionized_metrics/retries_count.rs index 7d81c48274b..83307d75f7a 100644 --- a/crates/analytics/src/payments/metrics/sessionized_metrics/retries_count.rs +++ b/crates/analytics/src/payments/metrics/sessionized_metrics/retries_count.rs @@ -112,6 +112,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(\|i\| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/sessionized_metrics/success_rate.rs b/crates/analytics/src/payments/metrics/sessionized_metrics/success_rate.rs index f20308ed3b1..8159a615ba8 100644 --- a/crates/analytics/src/payments/metrics/sessionized_metrics/success_rate.rs +++ b/crates/analytics/src/payments/metrics/sessionized_metrics/success_rate.rs @@ -112,6 +112,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(\|i\| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/success_rate.rs b/crates/analytics/src/payments/metrics/success_rate.rs index 6698fe8ce65..032f3219a68 100644 --- a/crates/analytics/src/payments/metrics/success_rate.rs +++ b/crates/analytics/src/payments/metrics/success_rate.rs @@ -111,6 +111,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(\|i\| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/types.rs b/crates/analytics/src/payments/types.rs index b9af3cd0610..7bb23d7af78 100644 --- a/crates/analytics/src/payments/types.rs +++ b/crates/analytics/src/payments/types.rs @@ -109,6 +109,16 @@ where .add_filter_in_range_clause("first_attempt", &self.first_attempt) .attach_printable("Error adding first attempt filter")?; } + + if !self.routing_approach.is_empty() { + builder + .add_filter_in_range_clause( + PaymentDimensions::RoutingApproach, + &self.routing_approach, + ) + .attach_printable("Error adding routing approach filter")?; + } + Ok(()) } } diff --git a/crates/analytics/src/query.rs b/crates/analytics/src/query.rs index 5effd9e70a7..50d16c68e6f 100644 --- a/crates/analytics/src/query.rs +++ b/crates/analytics/src/query.rs @@ -15,7 +15,7 @@ use api_models::{ }, enums::{ AttemptStatus, AuthenticationType, Connector, Currency, DisputeStage, IntentStatus, - PaymentMethod, PaymentMethodType, + PaymentMethod, PaymentMethodType, RoutingApproach, }, refunds::RefundStatus, }; @@ -514,7 +514,8 @@ impl_to_sql_for_to_string!( &bool, &u64, u64, - Order + Order, + RoutingApproach ); impl_to_sql_for_to_string!( diff --git a/crates/analytics/src/sqlx.rs b/crates/analytics/src/sqlx.rs index 028a1ddc143..53b9cc10e10 100644 --- a/crates/analytics/src/sqlx.rs +++ b/crates/analytics/src/sqlx.rs @@ -13,7 +13,7 @@ use common_utils::{ }; use diesel_models::enums::{ AttemptStatus, AuthenticationType, Currency, FraudCheckStatus, IntentStatus, PaymentMethod, - RefundStatus, + RefundStatus, RoutingApproach, }; use error_stack::ResultExt; use sqlx::{ @@ -103,6 +103,7 @@ db_type!(AuthenticationStatus); db_type!(TransactionStatus); db_type!(AuthenticationConnectors); db_type!(DecoupledAuthenticationType); +db_type!(RoutingApproach); impl<'q, Type> Encode<'q, Postgres> for DBEnumWrapper<Type> where @@ -730,6 +731,11 @@ impl<'a> FromRow<'a, PgRow> for super::payments::metrics::PaymentMetricRow { ColumnNotFound(_) => Ok(Default::default()), e => Err(e), })?; + let routing_approach: Option<DBEnumWrapper<RoutingApproach>> = + row.try_get("routing_approach").or_else(\|e\| match e { + ColumnNotFound(_) => Ok(Default::default()), + e => Err(e), + })?; let total: Option<bigdecimal::BigDecimal> = row.try_get("total").or_else(\|e\| match e { ColumnNotFound(_) => Ok(Default::default()), e => Err(e), @@ -761,6 +767,7 @@ impl<'a> FromRow<'a, PgRow> for super::payments::metrics::PaymentMetricRow { card_issuer, error_reason, first_attempt, + routing_approach, total, count, start_bucket, @@ -833,6 +840,11 @@ impl<'a> FromRow<'a, PgRow> for super::payments::distribution::PaymentDistributi ColumnNotFound(_) => Ok(Default::default()), e => Err(e), })?; + let routing_approach: Option<DBEnumWrapper<RoutingApproach>> = + row.try_get("routing_approach").or_else(\|e\| match e { + ColumnNotFound(_) => Ok(Default::default()), + e => Err(e), + })?; let total: Option<bigdecimal::BigDecimal> = row.try_get("total").or_else(\|e\| match e { ColumnNotFound(_) => Ok(Default::default()), e => Err(e), @@ -875,6 +887,7 @@ impl<'a> FromRow<'a, PgRow> for super::payments::distribution::PaymentDistributi total, count, error_message, + routing_approach, start_bucket, end_bucket, }) @@ -949,6 +962,11 @@ impl<'a> FromRow<'a, PgRow> for super::payments::filters::PaymentFilterRow { ColumnNotFound(_) => Ok(Default::default()), e => Err(e), })?; + let routing_approach: Option<DBEnumWrapper<RoutingApproach>> = + row.try_get("routing_approach").or_else(\|e\| match e { + ColumnNotFound(_) => Ok(Default::default()), + e => Err(e), + })?; Ok(Self { currency, status, @@ -965,6 +983,7 @@ impl<'a> FromRow<'a, PgRow> for super::payments::filters::PaymentFilterRow { card_issuer, error_reason, first_attempt, + routing_approach, }) } } diff --git a/crates/analytics/src/types.rs b/crates/analytics/src/types.rs index 28ff2cec8bd..4f9a7655ede 100644 --- a/crates/analytics/src/types.rs +++ b/crates/analytics/src/types.rs @@ -21,6 +21,7 @@ pub enum AnalyticsDomain { SdkEvents, ApiEvents, Dispute, + Routing, } #[derive(Debug, strum::AsRefStr, strum::Display, Clone, Copy)] diff --git a/crates/analytics/src/utils.rs b/crates/analytics/src/utils.rs index 06cc998f3da..36121e56ebb 100644 --- a/crates/analytics/src/utils.rs +++ b/crates/analytics/src/utils.rs @@ -24,6 +24,7 @@ pub fn get_payment_dimensions() -> Vec<NameDescription> { PaymentDimensions::ProfileId, PaymentDimensions::CardNetwork, PaymentDimensions::MerchantId, + PaymentDimensions::RoutingApproach, ] .into_iter() .map(Into::into) diff --git a/crates/api_models/src/analytics/payments.rs b/crates/api_models/src/analytics/payments.rs index 691e827043f..537d6df09d1 100644 --- a/crates/api_models/src/analytics/payments.rs +++ b/crates/api_models/src/analytics/payments.rs @@ -8,7 +8,7 @@ use common_utils::id_type; use super::{ForexMetric, NameDescription, TimeRange}; use crate::enums::{ AttemptStatus, AuthenticationType, CardNetwork, Connector, Currency, PaymentMethod, - PaymentMethodType, + PaymentMethodType, RoutingApproach, }; #[derive(Clone, Debug, Default, serde::Deserialize, serde::Serialize)] @@ -43,6 +43,8 @@ pub struct PaymentFilters { pub error_reason: Vec<String>, #[serde(default)] pub first_attempt: Vec<bool>, + #[serde(default)] + pub routing_approach: Vec<RoutingApproach>, } #[derive( @@ -84,6 +86,7 @@ pub enum PaymentDimensions { CardLast4, CardIssuer, ErrorReason, + RoutingApproach, } #[derive( @@ -200,6 +203,7 @@ pub struct PaymentMetricsBucketIdentifier { pub card_last_4: Option<String>, pub card_issuer: Option<String>, pub error_reason: Option<String>, + pub routing_approach: Option<RoutingApproach>, #[serde(rename = "time_range")] pub time_bucket: TimeRange, // Coz FE sucks @@ -225,6 +229,7 @@ impl PaymentMetricsBucketIdentifier { card_last_4: Option<String>, card_issuer: Option<String>, error_reason: Option<String>, + routing_approach: Option<RoutingApproach>, normalized_time_range: TimeRange, ) -> Self { Self { @@ -242,6 +247,7 @@ impl PaymentMetricsBucketIdentifier { card_last_4, card_issuer, error_reason, + routing_approach, time_bucket: normalized_time_range, start_time: normalized_time_range.start_time, } @@ -264,6 +270,7 @@ impl Hash for PaymentMetricsBucketIdentifier { self.card_last_4.hash(state); self.card_issuer.hash(state); self.error_reason.hash(state); + self.routing_approach.map(\|i\| i.to_string()).hash(state); self.time_bucket.hash(state); } } diff --git a/crates/common_enums/src/enums.rs b/crates/common_enums/src/enums.rs index 641dc83291c..d7f4a1b2a20 100644 --- a/crates/common_enums/src/enums.rs +++ b/crates/common_enums/src/enums.rs @@ -29,7 +29,7 @@ pub mod diesel_exports { DbPaymentType as PaymentType, DbProcessTrackerStatus as ProcessTrackerStatus, DbRefundStatus as RefundStatus, DbRequestIncrementalAuthorization as RequestIncrementalAuthorization, - DbScaExemptionType as ScaExemptionType, + DbRoutingApproach as RoutingApproach, DbScaExemptionType as ScaExemptionType, DbSuccessBasedRoutingConclusiveState as SuccessBasedRoutingConclusiveState, DbTokenizationFlag as TokenizationFlag, DbWebhookDeliveryAttempt as WebhookDeliveryAttempt, }; @@ -8494,3 +8494,44 @@ pub enum TokenDataType { /// Fetch network token for the given payment method NetworkToken, } + +#[derive( + Clone, + Copy, + Debug, + Default, + Eq, + Hash, + PartialEq, + serde::Deserialize, + serde::Serialize, + strum::Display, + strum::VariantNames, + strum::EnumIter, + strum::EnumString, + ToSchema, +)] +#[router_derive::diesel_enum(storage_type = "db_enum")] +#[serde(rename_all = "snake_case")] +#[strum(serialize_all = "snake_case")] +pub enum RoutingApproach { + SuccessRateExploitation, + SuccessRateExploration, + ContractBasedRouting, + DebitRouting, + RuleBasedRouting, + VolumeBasedRouting, + #[default] + DefaultFallback, +} + +impl RoutingApproach { + pub fn from_decision_engine_approach(approach: &str) -> Self { + match approach { + "SR_SELECTION_V3_ROUTING" => Self::SuccessRateExploitation, + "SR_V3_HEDGING" => Self::SuccessRateExploration, + "NTW_BASED_ROUTING" => Self::DebitRouting, + _ => Self::DefaultFallback, + } + } +} diff --git a/crates/diesel_models/src/enums.rs b/crates/diesel_models/src/enums.rs index fc9417342e1..f7c84368b42 100644 --- a/crates/diesel_models/src/enums.rs +++ b/crates/diesel_models/src/enums.rs @@ -21,7 +21,8 @@ pub mod diesel_exports { DbRelayType as RelayType, DbRequestIncrementalAuthorization as RequestIncrementalAuthorization, DbRevenueRecoveryAlgorithmType as RevenueRecoveryAlgorithmType, DbRoleScope as RoleScope, - DbRoutingAlgorithmKind as RoutingAlgorithmKind, DbScaExemptionType as ScaExemptionType, + DbRoutingAlgorithmKind as RoutingAlgorithmKind, DbRoutingApproach as RoutingApproach, + DbScaExemptionType as ScaExemptionType, DbSuccessBasedRoutingConclusiveState as SuccessBasedRoutingConclusiveState, DbTokenizationFlag as TokenizationFlag, DbTotpStatus as TotpStatus, DbTransactionType as TransactionType, DbUserRoleVersion as UserRoleVersion, diff --git a/crates/diesel_models/src/payment_attempt.rs b/crates/diesel_models/src/payment_attempt.rs index 473502ad746..d438b093513 100644 --- a/crates/diesel_models/src/payment_attempt.rs +++ b/crates/diesel_models/src/payment_attempt.rs @@ -203,6 +203,7 @@ pub struct PaymentAttempt { pub processor_merchant_id: Option<id_type::MerchantId>, pub created_by: Option<String>, pub setup_future_usage_applied: Option<storage_enums::FutureUsage>, + pub routing_approach: Option<storage_enums::RoutingApproach>, } #[cfg(feature = "v1")] @@ -422,6 +423,7 @@ pub struct PaymentAttemptNew { pub processor_merchant_id: Option<id_type::MerchantId>, pub created_by: Option<String>, pub setup_future_usage_applied: Option<storage_enums::FutureUsage>, + pub routing_approach: Option<storage_enums::RoutingApproach>, } #[cfg(feature = "v1")] @@ -495,6 +497,7 @@ pub enum PaymentAttemptUpdate { order_tax_amount: Option<MinorUnit>, connector_mandate_detail: Option<ConnectorMandateReferenceId>, card_discovery: Option<storage_enums::CardDiscovery>, + routing_approach: Option<storage_enums::RoutingApproach>, }, VoidUpdate { status: storage_enums::AttemptStatus, @@ -937,6 +940,7 @@ pub struct PaymentAttemptUpdateInternal { pub issuer_error_code: Option<String>, pub issuer_error_message: Option<String>, pub setup_future_usage_applied: Option<storage_enums::FutureUsage>, + pub routing_approach: Option<storage_enums::RoutingApproach>, } #[cfg(feature = "v1")] @@ -1126,6 +1130,7 @@ impl PaymentAttemptUpdate { issuer_error_code, issuer_error_message, setup_future_usage_applied, + routing_approach, } = PaymentAttemptUpdateInternal::from(self).populate_derived_fields(&source); PaymentAttempt { amount: amount.unwrap_or(source.amount), @@ -1192,6 +1197,7 @@ impl PaymentAttemptUpdate { issuer_error_message: issuer_error_message.or(source.issuer_error_message), setup_future_usage_applied: setup_future_usage_applied .or(source.setup_future_usage_applied), + routing_approach: routing_approach.or(source.routing_approach), ..source } } @@ -2250,6 +2256,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::AuthenticationTypeUpdate { authentication_type, @@ -2312,6 +2319,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::ConfirmUpdate { amount, @@ -2348,6 +2356,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { order_tax_amount, connector_mandate_detail, card_discovery, + routing_approach, } => Self { amount: Some(amount), currency: Some(currency), @@ -2406,6 +2415,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach, }, PaymentAttemptUpdate::VoidUpdate { status, @@ -2469,6 +2479,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::RejectUpdate { status, @@ -2533,6 +2544,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::BlocklistUpdate { status, @@ -2597,6 +2609,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::ConnectorMandateDetailUpdate { connector_mandate_detail, @@ -2659,6 +2672,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::PaymentMethodDetailsUpdate { payment_method_id, @@ -2721,6 +2735,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::ResponseUpdate { status, @@ -2811,6 +2826,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied, + routing_approach: None, } } PaymentAttemptUpdate::ErrorUpdate { @@ -2892,6 +2908,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { card_discovery: None, charges: None, setup_future_usage_applied: None, + routing_approach: None, } } PaymentAttemptUpdate::StatusUpdate { status, updated_by } => Self { @@ -2952,6 +2969,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::UpdateTrackers { payment_token, @@ -3020,6 +3038,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::UnresolvedResponseUpdate { status, @@ -3095,6 +3114,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, } } PaymentAttemptUpdate::PreprocessingUpdate { @@ -3169,6 +3189,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, } } PaymentAttemptUpdate::CaptureUpdate { @@ -3233,6 +3254,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::AmountToCaptureUpdate { status, @@ -3296,6 +3318,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::ConnectorResponse { authentication_data, @@ -3368,6 +3391,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, } } PaymentAttemptUpdate::IncrementalAuthorizationAmountUpdate { @@ -3431,6 +3455,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::AuthenticationUpdate { status, @@ -3496,6 +3521,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::ManualUpdate { status, @@ -3570,6 +3596,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, } } PaymentAttemptUpdate::PostSessionTokensUpdate { @@ -3633,6 +3660,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, } } diff --git a/crates/diesel_models/src/schema.rs b/crates/diesel_models/src/schema.rs index 522ad271be9..cb690e3f602 100644 --- a/crates/diesel_models/src/schema.rs +++ b/crates/diesel_models/src/schema.rs @@ -950,6 +950,7 @@ diesel::table! { #[max_length = 255] created_by -> Nullable<Varchar>, setup_future_usage_applied -> Nullable<FutureUsage>, + routing_approach -> Nullable<RoutingApproach>, } } diff --git a/crates/diesel_models/src/user/sample_data.rs b/crates/diesel_models/src/user/sample_data.rs index 3e445bb5020..2a21bb7c404 100644 --- a/crates/diesel_models/src/user/sample_data.rs +++ b/crates/diesel_models/src/user/sample_data.rs @@ -216,6 +216,7 @@ pub struct PaymentAttemptBatchNew { pub processor_merchant_id: Option<common_utils::id_type::MerchantId>, pub created_by: Option<String>, pub setup_future_usage_applied: Option<common_enums::FutureUsage>, + pub routing_approach: Option<common_enums::RoutingApproach>, } #[cfg(feature = "v1")] @@ -301,6 +302,7 @@ impl PaymentAttemptBatchNew { processor_merchant_id: self.processor_merchant_id, created_by: self.created_by, setup_future_usage_applied: self.setup_future_usage_applied, + routing_approach: self.routing_approach, } } } diff --git a/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs b/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs index c35fbc3163e..6369c2168fe 100644 --- a/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs +++ b/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs @@ -902,6 +902,7 @@ pub struct PaymentAttempt { /// merchantwho invoked the resource based api (identifier) and through what source (Api, Jwt(Dashboard)) pub created_by: Option<CreatedBy>, pub setup_future_usage_applied: Option<storage_enums::FutureUsage>, + pub routing_approach: Option<storage_enums::RoutingApproach>, } #[cfg(feature = "v1")] @@ -1156,6 +1157,7 @@ pub struct PaymentAttemptNew { /// merchantwho invoked the resource based api (identifier) and through what source (Api, Jwt(Dashboard)) pub created_by: Option<CreatedBy>, pub setup_future_usage_applied: Option<storage_enums::FutureUsage>, + pub routing_approach: Option<storage_enums::RoutingApproach>, } #[cfg(feature = "v1")] @@ -1223,6 +1225,7 @@ pub enum PaymentAttemptUpdate { customer_acceptance: Option<pii::SecretSerdeValue>, connector_mandate_detail: Option<ConnectorMandateReferenceId>, card_discovery: Option<common_enums::CardDiscovery>, + routing_approach: Option<storage_enums::RoutingApproach>, // where all to add this one }, RejectUpdate { status: storage_enums::AttemptStatus, @@ -1481,6 +1484,7 @@ impl PaymentAttemptUpdate { customer_acceptance, connector_mandate_detail, card_discovery, + routing_approach, } => DieselPaymentAttemptUpdate::ConfirmUpdate { amount: net_amount.get_order_amount(), currency, @@ -1516,6 +1520,7 @@ impl PaymentAttemptUpdate { order_tax_amount: net_amount.get_order_tax_amount(), connector_mandate_detail, card_discovery, + routing_approach, }, Self::VoidUpdate { status, @@ -1917,6 +1922,7 @@ impl behaviour::Conversion for PaymentAttempt { connector_transaction_data: None, processor_merchant_id: Some(self.processor_merchant_id), created_by: self.created_by.map(\|cb\| cb.to_string()), + routing_approach: self.routing_approach, }) } @@ -2012,6 +2018,7 @@ impl behaviour::Conversion for PaymentAttempt { .created_by .and_then(\|created_by\| created_by.parse::<CreatedBy>().ok()), setup_future_usage_applied: storage_model.setup_future_usage_applied, + routing_approach: storage_model.routing_approach, }) } .await @@ -2100,6 +2107,7 @@ impl behaviour::Conversion for PaymentAttempt { processor_merchant_id: Some(self.processor_merchant_id), created_by: self.created_by.map(\|cb\| cb.to_string()), setup_future_usage_applied: self.setup_future_usage_applied, + routing_approach: self.routing_approach, }) } } diff --git a/crates/router/src/analytics.rs b/crates/router/src/analytics.rs index ffac49e7a8e..e40bce12339 100644 --- a/crates/router/src/analytics.rs +++ b/crates/router/src/analytics.rs @@ -62,6 +62,10 @@ pub mod routes { web::resource("metrics/payments") .route(web::post().to(get_merchant_payment_metrics)), ) + .service( + web::resource("metrics/routing") + .route(web::post().to(get_merchant_payment_metrics)), + ) .service( web::resource("metrics/refunds") .route(web::post().to(get_merchant_refund_metrics)), @@ -70,6 +74,10 @@ pub mod routes { web::resource("filters/payments") .route(web::post().to(get_merchant_payment_filters)), ) + .service( + web::resource("filters/routing") + .route(web::post().to(get_merchant_payment_filters)), + ) .service( web::resource("filters/frm").route(web::post().to(get_frm_filters)), ) @@ -175,6 +183,10 @@ pub mod routes { web::resource("metrics/payments") .route(web::post().to(get_merchant_payment_metrics)), ) + .service( + web::resource("metrics/routing") + .route(web::post().to(get_merchant_payment_metrics)), + ) .service( web::resource("metrics/refunds") .route(web::post().to(get_merchant_refund_metrics)), @@ -183,6 +195,10 @@ pub mod routes { web::resource("filters/payments") .route(web::post().to(get_merchant_payment_filters)), ) + .service( + web::resource("filters/routing") + .route(web::post().to(get_merchant_payment_filters)), + ) .service( web::resource("filters/refunds") .route(web::post().to(get_merchant_refund_filters)), @@ -241,6 +257,14 @@ pub mod routes { web::resource("filters/payments") .route(web::post().to(get_org_payment_filters)), ) + .service( + web::resource("metrics/routing") + .route(web::post().to(get_org_payment_metrics)), + ) + .service( + web::resource("filters/routing") + .route(web::post().to(get_org_payment_filters)), + ) .service( web::resource("metrics/refunds") .route(web::post().to(get_org_refund_metrics)), @@ -291,6 +315,14 @@ pub mod routes { web::resource("filters/payments") .route(web::post().to(get_profile_payment_filters)), ) + .service( + web::resource("metrics/routing") + .route(web::post().to(get_profile_payment_metrics)), + ) + .service( + web::resource("filters/routing") + .route(web::post().to(get_profile_payment_filters)), + ) .service( web::resource("metrics/refunds") .route(web::post().to(get_profile_refund_metrics)), diff --git a/crates/router/src/core/debit_routing.rs b/crates/router/src/core/debit_routing.rs index ca03f5d2532..4975ffc4bd1 100644 --- a/crates/router/src/core/debit_routing.rs +++ b/crates/router/src/core/debit_routing.rs @@ -306,15 +306,14 @@ where } pub async fn get_debit_routing_output< - F: Clone, - D: OperationSessionGetters<F> + OperationSessionSetters<F>, + F: Clone + Send, + D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, >( state: &SessionState, payment_data: &mut D, acquirer_country: enums::CountryAlpha2, ) -> Option<open_router::DebitRoutingOutput> { logger::debug!("Fetching sorted card networks"); - let payment_attempt = payment_data.get_payment_attempt(); let (saved_co_badged_card_data, saved_card_type, card_isin) = extract_saved_card_info(payment_data); @@ -355,9 +354,9 @@ pub async fn get_debit_routing_output< routing::perform_open_routing_for_debit_routing( state, - payment_attempt, co_badged_card_request, card_isin, + payment_data, ) .await .map_err(\|error\| { diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs index 59de54f41fa..f361be5a76c 100644 --- a/crates/router/src/core/payments.rs +++ b/crates/router/src/core/payments.rs @@ -7996,7 +7996,7 @@ pub async fn route_connector_v2_for_payments( .as_ref() .or(business_profile.routing_algorithm_id.as_ref()); - let connectors = routing::perform_static_routing_v1( + let (connectors, _) = routing::perform_static_routing_v1( state, merchant_context.get_merchant_account().get_id(), routing_algorithm_id, @@ -8063,7 +8063,7 @@ where algorithm_ref.algorithm_id }; - let connectors = routing::perform_static_routing_v1( + let (connectors, routing_approach) = routing::perform_static_routing_v1( state, merchant_context.get_merchant_account().get_id(), routing_algorithm_id.as_ref(), @@ -8073,6 +8073,8 @@ where .await .change_context(errors::ApiErrorResponse::InternalServerError)?; + payment_data.set_routing_approach_in_attempt(routing_approach); + #[cfg(all(feature = "v1", feature = "dynamic_routing"))] let payment_attempt = transaction_data.payment_attempt.clone(); @@ -8121,6 +8123,7 @@ where connectors.clone(), business_profile, payment_attempt, + payment_data, ) .await .map_err(\|e\| logger::error!(open_routing_error=?e)) @@ -8163,7 +8166,7 @@ where connectors.clone(), business_profile, dynamic_routing_config_params_interpolator, - payment_data.get_payment_attempt(), + payment_data, ) .await .map_err(\|e\| logger::error!(dynamic_routing_error=?e)) @@ -8240,7 +8243,7 @@ pub async fn route_connector_v1_for_payouts( algorithm_ref.algorithm_id }; - let connectors = routing::perform_static_routing_v1( + let (connectors, _) = routing::perform_static_routing_v1( state, merchant_context.get_merchant_account().get_id(), routing_algorithm_id.as_ref(), @@ -8965,6 +8968,7 @@ pub trait OperationSessionSetters<F> { &mut self, external_vault_session_details: Option<api::VaultSessionDetails>, ); + fn set_routing_approach_in_attempt(&mut self, routing_approach: Option<enums::RoutingApproach>); } #[cfg(feature = "v1")] @@ -9264,6 +9268,13 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentData<F> { fn set_vault_operation(&mut self, vault_operation: domain_payments::VaultOperation) { self.vault_operation = Some(vault_operation); } + + fn set_routing_approach_in_attempt( + &mut self, + routing_approach: Option<enums::RoutingApproach>, + ) { + self.payment_attempt.routing_approach = routing_approach; + } } #[cfg(feature = "v2")] @@ -9550,6 +9561,13 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentIntentData<F> { ) { self.vault_session_details = vault_session_details; } + + fn set_routing_approach_in_attempt( + &mut self, + routing_approach: Option<enums::RoutingApproach>, + ) { + todo!() + } } #[cfg(feature = "v2")] @@ -9839,6 +9857,13 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentConfirmData<F> { ) { todo!() } + + fn set_routing_approach_in_attempt( + &mut self, + routing_approach: Option<enums::RoutingApproach>, + ) { + todo!() + } } #[cfg(feature = "v2")] @@ -10124,6 +10149,12 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentStatusData<F> { ) { todo!() } + fn set_routing_approach_in_attempt( + &mut self, + routing_approach: Option<enums::RoutingApproach>, + ) { + todo!() + } } #[cfg(feature = "v2")] @@ -10410,6 +10441,13 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentCaptureData<F> { ) { todo!() } + + fn set_routing_approach_in_attempt( + &mut self, + routing_approach: Option<enums::RoutingApproach>, + ) { + todo!() + } } #[cfg(feature = "v2")] diff --git a/crates/router/src/core/payments/helpers.rs b/crates/router/src/core/payments/helpers.rs index 9f6e317531a..a34a169d38a 100644 --- a/crates/router/src/core/payments/helpers.rs +++ b/crates/router/src/core/payments/helpers.rs @@ -4399,6 +4399,7 @@ impl AttemptType { processor_merchant_id: old_payment_attempt.processor_merchant_id, created_by: old_payment_attempt.created_by, setup_future_usage_applied: None, + routing_approach: old_payment_attempt.routing_approach, } } diff --git a/crates/router/src/core/payments/operations/payment_confirm.rs b/crates/router/src/core/payments/operations/payment_confirm.rs index 944f2852b18..866449c74dd 100644 --- a/crates/router/src/core/payments/operations/payment_confirm.rs +++ b/crates/router/src/core/payments/operations/payment_confirm.rs @@ -1794,6 +1794,7 @@ impl<F: Clone + Sync> UpdateTracker<F, PaymentData<F>, api::PaymentsRequest> for .payment_attempt .connector_mandate_detail, card_discovery, + routing_approach: payment_data.payment_attempt.routing_approach, }, storage_scheme, ) diff --git a/crates/router/src/core/payments/operations/payment_create.rs b/crates/router/src/core/payments/operations/payment_create.rs index 68f1b9d9c15..43e9c39c566 100644 --- a/crates/router/src/core/payments/operations/payment_create.rs +++ b/crates/router/src/core/payments/operations/payment_create.rs @@ -1362,6 +1362,7 @@ impl PaymentCreate { processor_merchant_id: merchant_id.to_owned(), created_by: None, setup_future_usage_applied: request.setup_future_usage, + routing_approach: Some(common_enums::RoutingApproach::default()) }, additional_pm_data, diff --git a/crates/router/src/core/payments/retry.rs b/crates/router/src/core/payments/retry.rs index a4d1cc51518..1cc886be828 100644 --- a/crates/router/src/core/payments/retry.rs +++ b/crates/router/src/core/payments/retry.rs @@ -702,6 +702,7 @@ pub fn make_new_payment_attempt( processor_merchant_id: old_payment_attempt.processor_merchant_id, created_by: old_payment_attempt.created_by, setup_future_usage_applied: setup_future_usage_intent, // setup future usage is picked from intent for new payment attempt + routing_approach: old_payment_attempt.routing_approach, } } diff --git a/crates/router/src/core/payments/routing.rs b/crates/router/src/core/payments/routing.rs index 2ab004cccd1..ef7d1d46f53 100644 --- a/crates/router/src/core/payments/routing.rs +++ b/crates/router/src/core/payments/routing.rs @@ -59,7 +59,12 @@ use crate::core::routing::transformers::OpenRouterDecideGatewayRequestExt; use crate::routes::app::SessionStateInfo; use crate::{ core::{ - errors, errors as oss_errors, payments::routing::utils::DecisionEngineApiHandler, routing, + errors, errors as oss_errors, + payments::{ + routing::utils::DecisionEngineApiHandler, OperationSessionGetters, + OperationSessionSetters, + }, + routing, }, logger, services, types::{ @@ -432,7 +437,10 @@ pub async fn perform_static_routing_v1( algorithm_id: Option<&common_utils::id_type::RoutingId>, business_profile: &domain::Profile, transaction_data: &routing::TransactionData<'_>, -) -> RoutingResult<Vec<routing_types::RoutableConnectorChoice>> { +) -> RoutingResult<( + Vec<routing_types::RoutableConnectorChoice>, + Option<common_enums::RoutingApproach>, +)> { let algorithm_id = if let Some(id) = algorithm_id { id } else { @@ -449,7 +457,7 @@ pub async fn perform_static_routing_v1( .get_default_fallback_list_of_connector_under_profile() .change_context(errors::RoutingError::FallbackConfigFetchFailed)?; - return Ok(fallback_config); + return Ok((fallback_config, None)); }; let cached_algorithm = ensure_algorithm_cached_v1( state, @@ -503,14 +511,18 @@ pub async fn perform_static_routing_v1( logger::error!(decision_engine_euclid_evaluate_error=?e, "decision_engine_euclid: error in evaluation of rule") ).unwrap_or_default(); - let routable_connectors = match cached_algorithm.as_ref() { - CachedAlgorithm::Single(conn) => vec![(conn).clone()], - CachedAlgorithm::Priority(plist) => plist.clone(), - CachedAlgorithm::VolumeSplit(splits) => perform_volume_split(splits.to_vec()) - .change_context(errors::RoutingError::ConnectorSelectionFailed)?, - CachedAlgorithm::Advanced(interpreter) => { - execute_dsl_and_get_connector_v1(backend_input, interpreter)? - } + let (routable_connectors, routing_approach) = match cached_algorithm.as_ref() { + CachedAlgorithm::Single(conn) => (vec![(conn).clone()], None), + CachedAlgorithm::Priority(plist) => (plist.clone(), None), + CachedAlgorithm::VolumeSplit(splits) => ( + perform_volume_split(splits.to_vec()) + .change_context(errors::RoutingError::ConnectorSelectionFailed)?, + Some(common_enums::RoutingApproach::VolumeBasedRouting), + ), + CachedAlgorithm::Advanced(interpreter) => ( + execute_dsl_and_get_connector_v1(backend_input, interpreter)?, + Some(common_enums::RoutingApproach::RuleBasedRouting), + ), }; utils::compare_and_log_result( @@ -519,13 +531,16 @@ pub async fn perform_static_routing_v1( "evaluate_routing".to_string(), ); - Ok(utils::select_routing_result( - state, - business_profile, - routable_connectors, - de_euclid_connectors, - ) - .await) + Ok(( + utils::select_routing_result( + state, + business_profile, + routable_connectors, + de_euclid_connectors, + ) + .await, + routing_approach, + )) } async fn ensure_algorithm_cached_v1( @@ -1573,12 +1588,17 @@ pub fn make_dsl_input_for_surcharge( } #[cfg(all(feature = "v1", feature = "dynamic_routing"))] -pub async fn perform_dynamic_routing_with_open_router( +pub async fn perform_dynamic_routing_with_open_router<F, D>( state: &SessionState, routable_connectors: Vec<api_routing::RoutableConnectorChoice>, profile: &domain::Profile, payment_data: oss_storage::PaymentAttempt, -) -> RoutingResult<Vec<api_routing::RoutableConnectorChoice>> { + old_payment_data: &mut D, +) -> RoutingResult<Vec<api_routing::RoutableConnectorChoice>> +where + F: Send + Clone, + D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, +{ let dynamic_routing_algo_ref: api_routing::DynamicRoutingAlgorithmRef = profile .dynamic_routing_algorithm .clone() @@ -1610,6 +1630,7 @@ pub async fn perform_dynamic_routing_with_open_router( profile.get_id(), &payment_data, is_elimination_enabled, + old_payment_data, ) .await?; @@ -1642,12 +1663,18 @@ pub async fn perform_dynamic_routing_with_open_router( } #[cfg(feature = "v1")] -pub async fn perform_open_routing_for_debit_routing( +pub async fn perform_open_routing_for_debit_routing<F, D>( state: &SessionState, - payment_attempt: &oss_storage::PaymentAttempt, co_badged_card_request: or_types::CoBadgedCardRequest, card_isin: Option<Secret<String>>, -) -> RoutingResult<or_types::DebitRoutingOutput> { + old_payment_data: &mut D, +) -> RoutingResult<or_types::DebitRoutingOutput> +where + F: Send + Clone, + D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, +{ + let payment_attempt = old_payment_data.get_payment_attempt().clone(); + logger::debug!( "performing debit routing with open_router for profile {}", payment_attempt.profile_id.get_string_repr() @@ -1661,7 +1688,7 @@ pub async fn perform_open_routing_for_debit_routing( ); let open_router_req_body = OpenRouterDecideGatewayRequest::construct_debit_request( - payment_attempt, + &payment_attempt, metadata, card_isin, Some(or_types::RankingAlgorithm::NtwBasedRouting), @@ -1692,11 +1719,14 @@ pub async fn perform_open_routing_for_debit_routing( let output = match response { Ok(events_response) => { - let debit_routing_output = events_response - .response - .ok_or(errors::RoutingError::OpenRouterError( - "Response from decision engine API is empty".to_string(), - ))? + let response = + events_response + .response + .ok_or(errors::RoutingError::OpenRouterError( + "Response from decision engine API is empty".to_string(), + ))?; + + let debit_routing_output = response .debit_routing_output .get_required_value("debit_routing_output") .change_context(errors::RoutingError::OpenRouterError( @@ -1704,6 +1734,12 @@ pub async fn perform_open_routing_for_debit_routing( )) .attach_printable("debit_routing_output is missing in the open routing response")?; + old_payment_data.set_routing_approach_in_attempt(Some( + common_enums::RoutingApproach::from_decision_engine_approach( + &response.routing_approach, + ), + )); + Ok(debit_routing_output) } Err(error_response) => { @@ -1718,13 +1754,17 @@ pub async fn perform_open_routing_for_debit_routing( } #[cfg(all(feature = "v1", feature = "dynamic_routing"))] -pub async fn perform_dynamic_routing_with_intelligent_router( +pub async fn perform_dynamic_routing_with_intelligent_router<F, D>( state: &SessionState, routable_connectors: Vec<api_routing::RoutableConnectorChoice>, profile: &domain::Profile, dynamic_routing_config_params_interpolator: routing::helpers::DynamicRoutingConfigParamsInterpolator, - payment_attempt: &oss_storage::PaymentAttempt, -) -> RoutingResult<Vec<api_routing::RoutableConnectorChoice>> { + payment_data: &mut D, +) -> RoutingResult<Vec<api_routing::RoutableConnectorChoice>> +where + F: Send + Clone, + D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, +{ let dynamic_routing_algo_ref: api_routing::DynamicRoutingAlgorithmRef = profile .dynamic_routing_algorithm .clone() @@ -1744,6 +1784,8 @@ pub async fn perform_dynamic_routing_with_intelligent_router( profile.get_id().get_string_repr() ); + let payment_attempt = payment_data.get_payment_attempt().clone(); + let mut connector_list = match dynamic_routing_algo_ref .success_based_algorithm .as_ref() @@ -1756,6 +1798,7 @@ pub async fn perform_dynamic_routing_with_intelligent_router( &payment_attempt.payment_id, dynamic_routing_config_params_interpolator.clone(), algorithm.clone(), + payment_data, ) }) .await @@ -1779,6 +1822,7 @@ pub async fn perform_dynamic_routing_with_intelligent_router( &payment_attempt.payment_id, dynamic_routing_config_params_interpolator.clone(), algorithm.clone(), + payment_data, ) }) .await @@ -1816,13 +1860,18 @@ pub async fn perform_dynamic_routing_with_intelligent_router( #[cfg(all(feature = "v1", feature = "dynamic_routing"))] #[instrument(skip_all)] -pub async fn perform_decide_gateway_call_with_open_router( +pub async fn perform_decide_gateway_call_with_open_router<F, D>( state: &SessionState, mut routable_connectors: Vec<api_routing::RoutableConnectorChoice>, profile_id: &common_utils::id_type::ProfileId, payment_attempt: &oss_storage::PaymentAttempt, is_elimination_enabled: bool, -) -> RoutingResult<Vec<api_routing::RoutableConnectorChoice>> { + old_payment_data: &mut D, +) -> RoutingResult<Vec<api_routing::RoutableConnectorChoice>> +where + F: Send + Clone, + D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, +{ logger::debug!( "performing decide_gateway call with open_router for profile {}", profile_id.get_string_repr() @@ -1879,6 +1928,12 @@ pub async fn perform_decide_gateway_call_with_open_router( .to_string(), ); + old_payment_data.set_routing_approach_in_attempt(Some( + common_enums::RoutingApproach::from_decision_engine_approach( + &decided_gateway.routing_approach, + ), + )); + if let Some(gateway_priority_map) = decided_gateway.gateway_priority_map { logger::debug!(gateway_priority_map=?gateway_priority_map, routing_approach=decided_gateway.routing_approach, "open_router decide_gateway call response"); routable_connectors.sort_by(\|connector_choice_a, connector_choice_b\| { @@ -1992,7 +2047,8 @@ pub async fn update_gateway_score_with_open_router( /// success based dynamic routing #[cfg(all(feature = "v1", feature = "dynamic_routing"))] #[instrument(skip_all)] -pub async fn perform_success_based_routing( +#[allow(clippy::too_many_arguments)] +pub async fn perform_success_based_routing<F, D>( state: &SessionState, routable_connectors: Vec<api_routing::RoutableConnectorChoice>, profile_id: &common_utils::id_type::ProfileId, @@ -2000,7 +2056,12 @@ pub async fn perform_success_based_routing( payment_id: &common_utils::id_type::PaymentId, success_based_routing_config_params_interpolator: routing::helpers::DynamicRoutingConfigParamsInterpolator, success_based_algo_ref: api_routing::SuccessBasedAlgorithm, -) -> RoutingResult<Vec<api_routing::RoutableConnectorChoice>> { + payment_data: &mut D, +) -> RoutingResult<Vec<api_routing::RoutableConnectorChoice>> +where + F: Send + Clone, + D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, +{ if success_based_algo_ref.enabled_feature == api_routing::DynamicRoutingFeatures::DynamicConnectorSelection { @@ -2131,6 +2192,9 @@ pub async fn perform_success_based_routing( })?; routing_event.set_routing_approach(success_based_connectors.routing_approach.to_string()); + payment_data.set_routing_approach_in_attempt(Some(common_enums::RoutingApproach::from( + success_based_connectors.routing_approach, + ))); let mut connectors = Vec::with_capacity(success_based_connectors.labels_with_score.len()); for label_with_score in success_based_connectors.labels_with_score { @@ -2367,7 +2431,8 @@ pub async fn perform_elimination_routing( } #[cfg(all(feature = "v1", feature = "dynamic_routing"))] -pub async fn perform_contract_based_routing( +#[allow(clippy::too_many_arguments)] +pub async fn perform_contract_based_routing<F, D>( state: &SessionState, routable_connectors: Vec<api_routing::RoutableConnectorChoice>, profile_id: &common_utils::id_type::ProfileId, @@ -2375,7 +2440,12 @@ pub async fn perform_contract_based_routing( payment_id: &common_utils::id_type::PaymentId, _dynamic_routing_config_params_interpolator: routing::helpers::DynamicRoutingConfigParamsInterpolator, contract_based_algo_ref: api_routing::ContractRoutingAlgorithm, -) -> RoutingResult<Vec<api_routing::RoutableConnectorChoice>> { + payment_data: &mut D, +) -> RoutingResult<Vec<api_routing::RoutableConnectorChoice>> +where + F: Send + Clone, + D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, +{ if contract_based_algo_ref.enabled_feature == api_routing::DynamicRoutingFeatures::DynamicConnectorSelection { @@ -2528,6 +2598,10 @@ pub async fn perform_contract_based_routing( status_code: 500, })?; + payment_data.set_routing_approach_in_attempt(Some( + common_enums::RoutingApproach::ContractBasedRouting, + )); + let mut connectors = Vec::with_capacity(contract_based_connectors.labels_with_score.len()); for label_with_score in contract_based_connectors.labels_with_score { @@ -2565,6 +2639,7 @@ pub async fn perform_contract_based_routing( routing_event.set_status_code(200); routing_event.set_routable_connectors(connectors.clone()); + routing_event.set_routing_approach(api_routing::RoutingApproach::ContractBased.to_string()); state.event_handler().log_event(&routing_event); Ok(connectors) } else { diff --git a/crates/router/src/core/payments/routing/utils.rs b/crates/router/src/core/payments/routing/utils.rs index 4296fea819f..0b74273419b 100644 --- a/crates/router/src/core/payments/routing/utils.rs +++ b/crates/router/src/core/payments/routing/utils.rs @@ -1522,6 +1522,18 @@ impl RoutingApproach { } } +impl From<RoutingApproach> for common_enums::RoutingApproach { + fn from(approach: RoutingApproach) -> Self { + match approach { + RoutingApproach::Exploitation => Self::SuccessRateExploitation, + RoutingApproach::Exploration => Self::SuccessRateExploration, + RoutingApproach::ContractBased => Self::ContractBasedRouting, + RoutingApproach::StaticRouting => Self::RuleBasedRouting, + _ => Self::DefaultFallback, + } + } +} + impl std::fmt::Display for RoutingApproach { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { match self { diff --git a/crates/router/src/core/routing/helpers.rs b/crates/router/src/core/routing/helpers.rs index e73c9c5bc75..6d263eece26 100644 --- a/crates/router/src/core/routing/helpers.rs +++ b/crates/router/src/core/routing/helpers.rs @@ -54,7 +54,10 @@ use crate::{ }; #[cfg(feature = "v1")] use crate::{ - core::payments::routing::utils::{self as routing_utils, DecisionEngineApiHandler}, + core::payments::{ + routing::utils::{self as routing_utils, DecisionEngineApiHandler}, + OperationSessionGetters, OperationSessionSetters, + }, services, }; #[cfg(all(feature = "dynamic_routing", feature = "v1"))] @@ -338,11 +341,7 @@ impl RoutingDecisionData { pub fn apply_routing_decision<F, D>(&self, payment_data: &mut D) where F: Send + Clone, - D: crate::core::payments::OperationSessionGetters<F> - + crate::core::payments::OperationSessionSetters<F> - + Send - + Sync - + Clone, + D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, { match self { Self::DebitRouting(data) => data.apply_debit_routing_decision(payment_data), @@ -364,11 +363,7 @@ impl DebitRoutingDecisionData { pub fn apply_debit_routing_decision<F, D>(&self, payment_data: &mut D) where F: Send + Clone, - D: crate::core::payments::OperationSessionGetters<F> - + crate::core::payments::OperationSessionSetters<F> - + Send - + Sync - + Clone, + D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, { payment_data.set_card_network(self.card_network.clone()); self.debit_routing_result diff --git a/crates/router/src/services/kafka/payment_attempt.rs b/crates/router/src/services/kafka/payment_attempt.rs index f2c18ae9302..68f1d013517 100644 --- a/crates/router/src/services/kafka/payment_attempt.rs +++ b/crates/router/src/services/kafka/payment_attempt.rs @@ -69,6 +69,7 @@ pub struct KafkaPaymentAttempt<'a> { pub organization_id: &'a id_type::OrganizationId, pub card_network: Option<String>, pub card_discovery: Option<String>, + pub routing_approach: Option<storage_enums::RoutingApproach>, } #[cfg(feature = "v1")] @@ -130,6 +131,7 @@ impl<'a> KafkaPaymentAttempt<'a> { card_discovery: attempt .card_discovery .map(\|discovery\| discovery.to_string()), + routing_approach: attempt.routing_approach, } } } diff --git a/crates/router/src/services/kafka/payment_attempt_event.rs b/crates/router/src/services/kafka/payment_attempt_event.rs index e06f4e014dd..9bfc6f8c31d 100644 --- a/crates/router/src/services/kafka/payment_attempt_event.rs +++ b/crates/router/src/services/kafka/payment_attempt_event.rs @@ -70,6 +70,7 @@ pub struct KafkaPaymentAttemptEvent<'a> { pub organization_id: &'a id_type::OrganizationId, pub card_network: Option<String>, pub card_discovery: Option<String>, + pub routing_approach: Option<storage_enums::RoutingApproach>, } #[cfg(feature = "v1")] @@ -131,6 +132,7 @@ impl<'a> KafkaPaymentAttemptEvent<'a> { card_discovery: attempt .card_discovery .map(\|discovery\| discovery.to_string()), + routing_approach: attempt.routing_approach, } } } diff --git a/crates/router/src/types/storage/payment_attempt.rs b/crates/router/src/types/storage/payment_attempt.rs index 3a942f70e32..5289ed02af9 100644 --- a/crates/router/src/types/storage/payment_attempt.rs +++ b/crates/router/src/types/storage/payment_attempt.rs @@ -225,6 +225,7 @@ mod tests { processor_merchant_id: Default::default(), created_by: None, setup_future_usage_applied: Default::default(), + routing_approach: Default::default(), }; let store = state @@ -315,6 +316,7 @@ mod tests { processor_merchant_id: Default::default(), created_by: None, setup_future_usage_applied: Default::default(), + routing_approach: Default::default(), }; let store = state .stores @@ -418,6 +420,7 @@ mod tests { processor_merchant_id: Default::default(), created_by: None, setup_future_usage_applied: Default::default(), + routing_approach: Default::default(), }; let store = state .stores diff --git a/crates/router/src/utils/user/sample_data.rs b/crates/router/src/utils/user/sample_data.rs index 989e7db3c0c..52c3d29482e 100644 --- a/crates/router/src/utils/user/sample_data.rs +++ b/crates/router/src/utils/user/sample_data.rs @@ -381,6 +381,7 @@ pub async fn generate_sample_data( processor_merchant_id: Some(merchant_id.clone()), created_by: None, setup_future_usage_applied: None, + routing_approach: None, }; let refund = if refunds_count < number_of_refunds && !is_failed_payment { diff --git a/crates/storage_impl/src/mock_db/payment_attempt.rs b/crates/storage_impl/src/mock_db/payment_attempt.rs index feec3a1f3a9..0de343b94ea 100644 --- a/crates/storage_impl/src/mock_db/payment_attempt.rs +++ b/crates/storage_impl/src/mock_db/payment_attempt.rs @@ -235,6 +235,7 @@ impl PaymentAttemptInterface for MockDb { processor_merchant_id: payment_attempt.processor_merchant_id, created_by: payment_attempt.created_by, setup_future_usage_applied: payment_attempt.setup_future_usage_applied, + routing_approach: payment_attempt.routing_approach, }; payment_attempts.push(payment_attempt.clone()); Ok(payment_attempt) diff --git a/crates/storage_impl/src/payments/payment_attempt.rs b/crates/storage_impl/src/payments/payment_attempt.rs index db3400c5fa4..ea1552248b9 100644 --- a/crates/storage_impl/src/payments/payment_attempt.rs +++ b/crates/storage_impl/src/payments/payment_attempt.rs @@ -680,6 +680,7 @@ impl<T: DatabaseStore> PaymentAttemptInterface for KVRouterStore<T> { processor_merchant_id: payment_attempt.processor_merchant_id.clone(), created_by: payment_attempt.created_by.clone(), setup_future_usage_applied: payment_attempt.setup_future_usage_applied, + routing_approach: payment_attempt.routing_approach, }; let field = format!("pa_{}", created_attempt.attempt_id); @@ -1704,6 +1705,7 @@ impl DataModelExt for PaymentAttempt { issuer_error_code: self.issuer_error_code, issuer_error_message: self.issuer_error_message, setup_future_usage_applied: self.setup_future_usage_applied, + routing_approach: self.routing_approach, // Below fields are deprecated. Please add any new fields above this line. connector_transaction_data: None, processor_merchant_id: Some(self.processor_merchant_id), @@ -1798,6 +1800,7 @@ impl DataModelExt for PaymentAttempt { .created_by .and_then(\|created_by\| created_by.parse::<CreatedBy>().ok()), setup_future_usage_applied: storage_model.setup_future_usage_applied, + routing_approach: storage_model.routing_approach, } } } @@ -1887,6 +1890,7 @@ impl DataModelExt for PaymentAttemptNew { processor_merchant_id: Some(self.processor_merchant_id), created_by: self.created_by.map(\|created_by\| created_by.to_string()), setup_future_usage_applied: self.setup_future_usage_applied, + routing_approach: self.routing_approach, } } @@ -1969,6 +1973,7 @@ impl DataModelExt for PaymentAttemptNew { .created_by .and_then(\|created_by\| created_by.parse::<CreatedBy>().ok()), setup_future_usage_applied: storage_model.setup_future_usage_applied, + routing_approach: storage_model.routing_approach, } } } diff --git a/migrations/2025-06-19-124558_add_routing_approach_to_attempt/down.sql b/migrations/2025-06-19-124558_add_routing_approach_to_attempt/down.sql new file mode 100644 index 00000000000..0c6fce15b58 --- /dev/null +++ b/migrations/2025-06-19-124558_add_routing_approach_to_attempt/down.sql @@ -0,0 +1,6 @@ +-- This file should undo anything in `up.sql` + +ALTER TABLE payment_attempt +DROP COLUMN IF EXISTS routing_approach; + +DROP TYPE "RoutingApproach"; diff --git a/migrations/2025-06-19-124558_add_routing_approach_to_attempt/up.sql b/migrations/2025-06-19-124558_add_routing_approach_to_attempt/up.sql new file mode 100644 index 00000000000..f5ec97a93f3 --- /dev/null +++ b/migrations/2025-06-19-124558_add_routing_approach_to_attempt/up.sql @@ -0,0 +1,15 @@ +-- Your SQL goes here +CREATE TYPE "RoutingApproach" AS ENUM ( + 'success_rate_exploitation', + 'success_rate_exploration', + 'contract_based_routing', + 'debit_routing', + 'rule_based_routing', + 'volume_based_routing', + 'default_fallback' +); + + +ALTER TABLE payment_attempt +ADD COLUMN IF NOT EXISTS routing_approach "RoutingApproach"; + diff --git a/v2_migrations/2025-01-13-081847_drop_v1_columns/up.sql b/v2_migrations/2025-01-13-081847_drop_v1_columns/up.sql index 7913af26d66..8eac6ae97ac 100644 --- a/v2_migrations/2025-01-13-081847_drop_v1_columns/up.sql +++ b/v2_migrations/2025-01-13-081847_drop_v1_columns/up.sql @@ -93,7 +93,8 @@ ALTER TABLE payment_attempt DROP COLUMN attempt_id, DROP COLUMN charge_id, DROP COLUMN issuer_error_code, DROP COLUMN issuer_error_message, - DROP COLUMN setup_future_usage_applied; + DROP COLUMN setup_future_usage_applied, + DROP COLUMN routing_approach; ALTER TABLE payment_methods	2025-06-20T18:09:08Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> - Added RoutingApproach column in Payment attempt - Added RoutingApproach as a filter and dimension in payment analytics - Added routing metric endpoints DB queries - ```sql CREATE TYPE "RoutingApproach" AS ENUM ( 'success_rate_exploitation', 'success_rate_exploration', 'contract_based_routing', 'debit_routing', 'rule_based_routing', 'volume_based_routing', 'default_fallback' ); ALTER TABLE payment_attempt ADD COLUMN IF NOT EXISTS routing_approach "RoutingApproach"; ``` ### Additional Changes - [x] This PR modifies the API contract - [x] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> ```bash curl -X GET 'http://localhost:8080/analytics/v1/org/routing/info' \ -H 'Accept: /' \ -H 'Accept-Language: en-GB,en-US;q=0.9,en;q=0.8' \ -H 'Connection: keep-alive' \ -H 'Content-Type: application/json' \ -H 'Origin: http://localhost:9000' \ -H 'Referer: http://localhost:9000/' \ -H 'Sec-Fetch-Dest: empty' \ -H 'Sec-Fetch-Mode: cors' \ -H 'Sec-Fetch-Site: same-site' \ -H 'User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/136.0.0.0 Safari/537.36' \ -H 'X-Merchant-Id: merchant_1750414514' \ -H 'X-Profile-Id: pro_8QBK8uJG8ZHGwiZfWcAr' \ -H 'api-key: hyperswitch' \ -H 'authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiOGMzNzEwZmMtNDU3NS00NDlmLWFhNzItNWFjOWUyYmJlODViIiwibWVyY2hhbnRfaWQiOiJtZXJjaGFudF8xNzUwNDE0NTE0Iiwicm9sZV9pZCI6Im9yZ19hZG1pbiIsImV4cCI6MTc1MDg1MDY3MCwib3JnX2lkIjoib3JnX2EycGVlblVCaVNqY2dmVzNMQ2xXIiwicHJvZmlsZV9pZCI6InByb184UUJLOHVKRzhaSEd3aVpmV2NBciIsInRlbmFudF9pZCI6InB1YmxpYyJ9.wutHNAmKapYOM4kcOF0t-Lrrx-ZVFKelyFCXk_Xk8JA' \ -H 'sec-ch-ua: "Chromium";v="136", "Google Chrome";v="136", "Not.A/Brand";v="99"' \ -H 'sec-ch-ua-mobile: ?0' \ -H 'sec-ch-ua-platform: "macOS"' ``` response - ```json { "metrics": [ { "name": "payment_success_rate", "desc": "" }, { "name": "payment_count", "desc": "" }, { "name": "payment_success_count", "desc": "" }, { "name": "payment_processed_amount", "desc": "" }, { "name": "avg_ticket_size", "desc": "" }, { "name": "retries_count", "desc": "" }, { "name": "connector_success_rate", "desc": "" }, { "name": "sessionized_payment_success_rate", "desc": "" }, { "name": "sessionized_payment_count", "desc": "" }, { "name": "sessionized_payment_success_count", "desc": "" }, { "name": "sessionized_payment_processed_amount", "desc": "" }, { "name": "sessionized_avg_ticket_size", "desc": "" }, { "name": "sessionized_retries_count", "desc": "" }, { "name": "sessionized_connector_success_rate", "desc": "" }, { "name": "payments_distribution", "desc": "" }, { "name": "failure_reasons", "desc": "" } ], "downloadDimensions": null, "dimensions": [ { "name": "connector", "desc": "" }, { "name": "payment_method", "desc": "" }, { "name": "payment_method_type", "desc": "" }, { "name": "currency", "desc": "" }, { "name": "authentication_type", "desc": "" }, { "name": "status", "desc": "" }, { "name": "client_source", "desc": "" }, { "name": "client_version", "desc": "" }, { "name": "profile_id", "desc": "" }, { "name": "card_network", "desc": "" }, { "name": "merchant_id", "desc": "" }, { "name": "routing_approach", "desc": "" } ] } ``` ```bash curl -X POST http://localhost:8080/analytics/v1/org/filters/routing \ -H "Content-Type: application/json" \ -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiOGMzNzEwZmMtNDU3NS00NDlmLWFhNzItNWFjOWUyYmJlODViIiwibWVyY2hhbnRfaWQiOiJtZXJjaGFudF8xNzUwNDE0NTE0Iiwicm9sZV9pZCI6Im9yZ19hZG1pbiIsImV4cCI6MTc1MDU4NzUzMCwib3JnX2lkIjoib3JnX2EycGVlblVCaVNqY2dmVzNMQ2xXIiwicHJvZmlsZV9pZCI6InByb184UUJLOHVKRzhaSEd3aVpmV2NBciIsInRlbmFudF9pZCI6InB1YmxpYyJ9.4PuaaBWunN6wnLnm6Pxj08r9rXuuMrZ6GfYewQX9IFE" \ -d '{ "timeRange": { "startTime": "2025-06-11T18:30:00.000Z", "endTime": "2025-06-20T11:10:32.000Z" }, "groupByNames": [ "connector", "payment_method", "payment_method_type", "currency", "authentication_type", "status", "client_source", "client_version", "profile_id", "card_network", "merchant_id", "routing_approach" ], "source": "BATCH", "delta": true }' ``` ```bash curl 'http://localhost:8080/analytics/v1/org/metrics/routing' \ -H 'Accept: /' \ -H 'Accept-Language: en-GB,en-US;q=0.9,en;q=0.8' \ -H 'Connection: keep-alive' \ -H 'Content-Type: application/json' \ -H 'Origin: http://localhost:9000' \ -H 'Referer: http://localhost:9000/' \ -H 'Sec-Fetch-Dest: empty' \ -H 'Sec-Fetch-Mode: cors' \ -H 'Sec-Fetch-Site: same-site' \ -H 'User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/136.0.0.0 Safari/537.36' \ -H 'X-Merchant-Id: merchant_1750414514' \ -H 'X-Profile-Id: pro_8QBK8uJG8ZHGwiZfWcAr' \ -H 'api-key: hyperswitch' \ -H 'authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiOGMzNzEwZmMtNDU3NS00NDlmLWFhNzItNWFjOWUyYmJlODViIiwibWVyY2hhbnRfaWQiOiJtZXJjaGFudF8xNzUwNDE0NTE0Iiwicm9sZV9pZCI6Im9yZ19hZG1pbiIsImV4cCI6MTc1MDg1MDY3MCwib3JnX2lkIjoib3JnX2EycGVlblVCaVNqY2dmVzNMQ2xXIiwicHJvZmlsZV9pZCI6InByb184UUJLOHVKRzhaSEd3aVpmV2NBciIsInRlbmFudF9pZCI6InB1YmxpYyJ9.wutHNAmKapYOM4kcOF0t-Lrrx-ZVFKelyFCXk_Xk8JA' \ -H 'sec-ch-ua: "Chromium";v="136", "Google Chrome";v="136", "Not.A/Brand";v="99"' \ -H 'sec-ch-ua-mobile: ?0' \ -H 'sec-ch-ua-platform: "macOS"' \ --data-raw '[{"timeRange":{"startTime":"2025-06-12T18:30:00Z","endTime":"2025-06-23T18:23:53Z"},"groupByNames":["routing_approach","connector"],"source":"BATCH","metrics":[ "payment_count","payment_success_rate", "payment_processed_amount"],"delta":true}]' ``` Response ```json { "queryData": [ { "payment_success_rate": null, "payment_count": null, "payment_success_count": null, "payment_processed_amount": 20400, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "currency": "USD", "status": null, "connector": "stripe", "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": "rule_based_routing", "time_range": { "start_time": "2025-06-12T18:30:00.000Z", "end_time": "2025-06-23T18:23:53.000Z" }, "time_bucket": "2025-06-12 18:30:00" }, { "payment_success_rate": null, "payment_count": null, "payment_success_count": null, "payment_processed_amount": 20300, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "currency": "USD", "status": null, "connector": "pretendpay", "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": null, "time_range": { "start_time": "2025-06-12T18:30:00.000Z", "end_time": "2025-06-23T18:23:53.000Z" }, "time_bucket": "2025-06-12 18:30:00" }, { "payment_success_rate": 100.0, "payment_count": 2, "payment_success_count": null, "payment_processed_amount": 0, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "currency": null, "status": null, "connector": "stripe", "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": "volume_based_routing", "time_range": { "start_time": "2025-06-12T18:30:00.000Z", "end_time": "2025-06-23T18:23:53.000Z" }, "time_bucket": "2025-06-12 18:30:00" }, { "payment_success_rate": 100.0, "payment_count": 2, "payment_success_count": null, "payment_processed_amount": 0, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "currency": null, "status": null, "connector": "stripe", "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": "rule_based_routing", "time_range": { "start_time": "2025-06-12T18:30:00.000Z", "end_time": "2025-06-23T18:23:53.000Z" }, "time_bucket": "2025-06-12 18:30:00" }, { "payment_success_rate": null, "payment_count": null, "payment_success_count": null, "payment_processed_amount": 10200, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "currency": "USD", "status": null, "connector": "stripe", "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": "default_fallback", "time_range": { "start_time": "2025-06-12T18:30:00.000Z", "end_time": "2025-06-23T18:23:53.000Z" }, "time_bucket": "2025-06-12 18:30:00" }, { "payment_success_rate": 100.0, "payment_count": 4, "payment_success_count": null, "payment_processed_amount": 0, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "currency": null, "status": null, "connector": "stripe", "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": null, "time_range": { "start_time": "2025-06-12T18:30:00.000Z", "end_time": "2025-06-23T18:23:53.000Z" }, "time_bucket": "2025-06-12 18:30:00" }, { "payment_success_rate": 0.0, "payment_count": 12, "payment_success_count": null, "payment_processed_amount": 0, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "currency": null, "status": null, "connector": null, "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": null, "time_range": { "start_time": "2025-06-12T18:30:00.000Z", "end_time": "2025-06-23T18:23:53.000Z" }, "time_bucket": "2025-06-12 18:30:00" }, { "payment_success_rate": 0.0, "payment_count": 6, "payment_success_count": null, "payment_processed_amount": 0, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "currency": null, "status": null, "connector": null, "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": "rule_based_routing", "time_range": { "start_time": "2025-06-12T18:30:00.000Z", "end_time": "2025-06-23T18:23:53.000Z" }, "time_bucket": "2025-06-12 18:30:00" }, { "payment_success_rate": null, "payment_count": null, "payment_success_count": null, "payment_processed_amount": 20000, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "currency": "USD", "status": null, "connector": "stripe", "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": "volume_based_routing", "time_range": { "start_time": "2025-06-12T18:30:00.000Z", "end_time": "2025-06-23T18:23:53.000Z" }, "time_bucket": "2025-06-12 18:30:00" }, { "payment_success_rate": null, "payment_count": null, "payment_success_count": null, "payment_processed_amount": 40000, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "currency": "USD", "status": null, "connector": "stripe", "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": null, "time_range": { "start_time": "2025-06-12T18:30:00.000Z", "end_time": "2025-06-23T18:23:53.000Z" }, "time_bucket": "2025-06-12 18:30:00" }, { "payment_success_rate": 100.0, "payment_count": 2, "payment_success_count": null, "payment_processed_amount": 0, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "currency": null, "status": null, "connector": "pretendpay", "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": null, "time_range": { "start_time": "2025-06-12T18:30:00.000Z", "end_time": "2025-06-23T18:23:53.000Z" }, "time_bucket": "2025-06-12 18:30:00" }, { "payment_success_rate": 100.0, "payment_count": 1, "payment_success_count": null, "payment_processed_amount": 0, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "currency": null, "status": null, "connector": "stripe", "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": "default_fallback", "time_range": { "start_time": "2025-06-12T18:30:00.000Z", "end_time": "2025-06-23T18:23:53.000Z" }, "time_bucket": "2025-06-12 18:30:00" } ], "metaData": [ { "total_payment_processed_amount": 110900, "total_payment_processed_amount_in_usd": null, "total_payment_processed_amount_without_smart_retries": 0, "total_payment_processed_amount_without_smart_retries_usd": null, "total_payment_processed_count": 0, "total_payment_processed_count_without_smart_retries": 0, "total_failure_reasons_count": 0, "total_failure_reasons_count_without_smart_retries": 0 } ] } ``` ## Checklist <!-- Put an `x` in the boxes that apply --> - [ ] I formatted the code `cargo +nightly fmt --all` - [ ] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.114.0	0851c6ece574ce961830c14d91e6e2040cb3b286	0851c6ece574ce961830c14d91e6e2040cb3b286
juspay/hyperswitch	juspay__hyperswitch-8406	Bug: Fix payment redirects for v2 Fix payment redirects for v2	diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs index 59de54f41fa..e3fdf6e1cac 100644 --- a/crates/router/src/core/payments.rs +++ b/crates/router/src/core/payments.rs @@ -2996,7 +2996,7 @@ impl PaymentRedirectFlow for PaymentRedirectSync { force_sync: true, expand_attempts: false, all_keys_required: None, - merchant_connector_details: todo!(), // TODO: Implement for connectors requiring 3DS or redirection-based authentication flows. + merchant_connector_details: None, // TODO: Implement for connectors requiring 3DS or redirection-based authentication flows. }; let operation = operations::PaymentGet;	2025-06-20T11:02:47Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [x] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> This PR fixes payment redirects in v2. This was due to the field merchant_connector_details set as todo!() ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> - Make 3DS payment ``` curl --location 'http://localhost:8080/v2/payments' \ --header 'Content-Type: application/json' \ --header 'x-profile-id: pro_295oknnkIU8LhiO6RTCy' \ --header 'Authorization: api-key=dev_8OKnwsVtu4ZIxxgqDfVQwnQrUfdORX3Ivo9i8Yxp0rB3mEZxiv9UZchQimjPgNnx' \ --data-raw '{ "amount_details": { "currency": "USD", "order_amount": 6540 }, "authentication_type": "three_ds", "payment_method_data": { "card": { "card_cvc": "123", "card_exp_month": "10", "card_exp_year": "25", "card_holder_name": "joseph Doe", "card_number": "4242424242424242" } }, "payment_method_subtype": "credit", "payment_method_type": "card" }' ``` Response ``` { "id": "12345_pay_01978cfda5fa7c12b1ba298cca0470c2", "status": "requires_customer_action", "amount": { "order_amount": 6540, "currency": "USD", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null, "net_amount": 6540, "amount_to_capture": null, "amount_capturable": 0, "amount_captured": null }, "customer_id": null, "connector": "stripe", "created": "2025-06-20T10:58:42.813Z", "payment_method_data": { "billing": null }, "payment_method_type": "card", "payment_method_subtype": "credit", "connector_transaction_id": "pi_3Rc2edD5R7gDAGff01vwkClL", "connector_reference_id": null, "merchant_connector_id": "mca_0GI0dABwex0qdnwlUelt", "browser_info": null, "error": null, "shipping": null, "billing": null, "attempts": null, "connector_token_details": { "token": "pm_1Rc2edD5R7gDAGffEOosatGV", "connector_token_request_reference_id": "eDuVwDClp0zQPbbkLZ" }, "payment_method_id": null, "next_action": { "type": "redirect_to_url", "redirect_to_url": "http://localhost:8080/v2/payments/12345_pay_01978cfda5fa7c12b1ba298cca0470c2/start-redirection?publishable_key=pk_dev_4499ca4660714d6b83b379218164187a&profile_id=pro_295oknnkIU8LhiO6RTCy" }, "return_url": "https://google.com/success", "authentication_type": "three_ds", "authentication_type_applied": "three_ds", "is_iframe_redirection_enabled": null, "merchant_reference_id": null } ``` Redirect to URL - Payments Sync ``` curl --location 'http://localhost:8080/v2/payments/12345_pay_01978cfda5fa7c12b1ba298cca0470c2?force_sync=true' \ --header 'x-profile-id: pro_295oknnkIU8LhiO6RTCy' \ --header 'Authorization: api-key=dev_8OKnwsVtu4ZIxxgqDfVQwnQrUfdORX3Ivo9i8Yxp0rB3mEZxiv9UZchQimjPgNnx' \ --data '' ``` Response ``` { "id": "12345_pay_01978cfda5fa7c12b1ba298cca0470c2", "status": "succeeded", "amount": { "order_amount": 6540, "currency": "USD", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null, "net_amount": 6540, "amount_to_capture": null, "amount_capturable": 0, "amount_captured": 6540 }, "customer_id": null, "connector": "stripe", "created": "2025-06-20T10:58:42.813Z", "payment_method_data": { "billing": null }, "payment_method_type": "card", "payment_method_subtype": "credit", "connector_transaction_id": "pi_3Rc2edD5R7gDAGff01vwkClL", "connector_reference_id": null, "merchant_connector_id": "mca_0GI0dABwex0qdnwlUelt", "browser_info": null, "error": null, "shipping": null, "billing": null, "attempts": null, "connector_token_details": { "token": "pm_1Rc2edD5R7gDAGffEOosatGV", "connector_token_request_reference_id": "eDuVwDClp0zQPbbkLZ" }, "payment_method_id": null, "next_action": null, "return_url": "https://google.com/success", "authentication_type": "three_ds", "authentication_type_applied": null, "is_iframe_redirection_enabled": null, "merchant_reference_id": null } ``` ## Checklist <!-- Put an `x` in the boxes that apply --> - [ ] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.114.0	c99ec73885e0c64552f01826b20a1af7a934a65c	c99ec73885e0c64552f01826b20a1af7a934a65c
juspay/hyperswitch	juspay__hyperswitch-8394	Bug: feat(revenue_recovery): Invoke attempt list instead of payment get in recovery webhooks flow Previously we were using payment get to find whether attempt is present in db or not, but for the first invoice webhook there won't be any attempt present in db and recently we added a validation to use payment get only in case of attempt is present. Also for stripe billing / stripe connector_transaction_id remains same instead charge id keeps changing , so we need to add support for this by checking if charge id is present we compare charge id if not we check for connector transaction id.	diff --git a/api-reference/README.md b/api-reference/README.md index b0343f44e62..ef3537d6b73 100644 --- a/api-reference/README.md +++ b/api-reference/README.md @@ -45,4 +45,4 @@ npx @mintlify/scraping@latest openapi-file v1/openapi_spec_v1.json -o v1 This will generate files in [api-reference](api-reference) folder. These routes should be added to the [mint.json](mint.json) file under navigation, under respective group. -NOTE: For working with V2 API reference, replace every occurence of `v1` with `v2` in above commands \ No newline at end of file +NOTE: For working with V2 API reference, replace every occurrence of `v1` with `v2` in above commands \ No newline at end of file diff --git a/api-reference/v2/openapi_spec_v2.json b/api-reference/v2/openapi_spec_v2.json index b213d96accd..853b0c3c5b5 100644 --- a/api-reference/v2/openapi_spec_v2.json +++ b/api-reference/v2/openapi_spec_v2.json @@ -15711,6 +15711,11 @@ } ], "nullable": true + }, + "charge_id": { + "type": "string", + "example": "ch_123abc456def789ghi012klmn", + "nullable": true } } }, diff --git a/crates/api_models/src/payments.rs b/crates/api_models/src/payments.rs index cb5480ed1f4..25e85c3f90c 100644 --- a/crates/api_models/src/payments.rs +++ b/crates/api_models/src/payments.rs @@ -1668,6 +1668,9 @@ pub struct PaymentAttemptRevenueRecoveryData { /// Flag to find out whether an attempt was created by external or internal system. #[schema(value_type = Option<TriggeredBy>, example = "internal")] pub attempt_triggered_by: common_enums::TriggeredBy, + // stripe specific field used to identify duplicate attempts. + #[schema(value_type = Option<String>, example = "ch_123abc456def789ghi012klmn")] + pub charge_id: Option<String>, } #[derive( @@ -5812,22 +5815,34 @@ pub struct PaymentsResponse { } #[cfg(feature = "v2")] -impl PaymentsResponse { +impl PaymentAttemptListResponse { pub fn find_attempt_in_attempts_list_using_connector_transaction_id( - self, + &self, connector_transaction_id: &common_utils::types::ConnectorTransactionId, ) -> Option<PaymentAttemptResponse> { - self.attempts - .as_ref() - .and_then(\|attempts\| { - attempts.iter().find(\|attempt\| { - attempt - .connector_payment_id + self.payment_attempt_list.iter().find_map(\|attempt\| { + attempt + .connector_payment_id + .as_ref() + .filter(\|txn_id\| txn_id == connector_transaction_id) + .map(\|_\| attempt.clone()) + }) + } + pub fn find_attempt_in_attempts_list_using_charge_id( + &self, + charge_id: String, + ) -> Option<PaymentAttemptResponse> { + self.payment_attempt_list.iter().find_map(\|attempt\| { + attempt.feature_metadata.as_ref().and_then(\|metadata\| { + metadata.revenue_recovery.as_ref().and_then(\|recovery\| { + recovery + .charge_id .as_ref() - .is_some_and(\|txn_id\| txn_id == connector_transaction_id) + .filter(\|id\| *id == charge_id) + .map(\|_\| attempt.clone()) }) }) - .cloned() + }) } } diff --git a/crates/diesel_models/src/payment_attempt.rs b/crates/diesel_models/src/payment_attempt.rs index fa373d2305b..473502ad746 100644 --- a/crates/diesel_models/src/payment_attempt.rs +++ b/crates/diesel_models/src/payment_attempt.rs @@ -3708,6 +3708,8 @@ pub struct PaymentAttemptFeatureMetadata { #[diesel(sql_type = diesel::pg::sql_types::Jsonb)] pub struct PaymentAttemptRecoveryData { pub attempt_triggered_by: common_enums::TriggeredBy, + // stripe specific field used to identify duplicate attempts. + pub charge_id: Option<String>, } #[cfg(feature = "v2")] common_utils::impl_to_sql_from_sql_json!(PaymentAttemptFeatureMetadata); diff --git a/crates/hyperswitch_connectors/src/connectors/chargebee/transformers.rs b/crates/hyperswitch_connectors/src/connectors/chargebee/transformers.rs index 6436cd952e7..e0c84b4b459 100644 --- a/crates/hyperswitch_connectors/src/connectors/chargebee/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/chargebee/transformers.rs @@ -509,6 +509,8 @@ impl TryFrom<ChargebeeWebhookBody> for revenue_recovery::RevenueRecoveryAttemptD invoice_next_billing_time, card_network: Some(payment_method_details.card.brand), card_isin: Some(payment_method_details.card.iin), + // This field is none because it is specific to stripebilling. + charge_id: None, }) } } diff --git a/crates/hyperswitch_connectors/src/connectors/recurly/transformers.rs b/crates/hyperswitch_connectors/src/connectors/recurly/transformers.rs index 9ffd900dc45..70edb327ded 100644 --- a/crates/hyperswitch_connectors/src/connectors/recurly/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/recurly/transformers.rs @@ -208,6 +208,8 @@ impl ), card_network: Some(item.response.payment_method.card_type), card_isin: Some(item.response.payment_method.first_six), + // This none because this field is specific to stripebilling. + charge_id: None, }, ), ..item.data diff --git a/crates/hyperswitch_connectors/src/connectors/stripebilling/transformers.rs b/crates/hyperswitch_connectors/src/connectors/stripebilling/transformers.rs index 1352b874c8a..ca0875ba4ce 100644 --- a/crates/hyperswitch_connectors/src/connectors/stripebilling/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/stripebilling/transformers.rs @@ -561,6 +561,7 @@ impl )), // Todo: Fetch Card issuer details. Generally in the other billing connector we are getting card_issuer using the card bin info. But stripe dosent provide any such details. We should find a way for stripe billing case card_isin: None, + charge_id: Some(charge_details.charge_id.clone()), }, ), ..item.data diff --git a/crates/hyperswitch_domain_models/src/payments.rs b/crates/hyperswitch_domain_models/src/payments.rs index 99ce4ca17f3..25e194ca391 100644 --- a/crates/hyperswitch_domain_models/src/payments.rs +++ b/crates/hyperswitch_domain_models/src/payments.rs @@ -746,6 +746,8 @@ impl PaymentIntent { invoice_next_billing_time: None, card_isin: None, card_network: None, + // No charge id is present here since it is an internal payment and we didn't call connector yet. + charge_id: None, }) } diff --git a/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs b/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs index 56e0942431c..c35fbc3163e 100644 --- a/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs +++ b/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs @@ -726,6 +726,12 @@ impl PaymentAttempt { revenue_recovery: Some({ PaymentAttemptRevenueRecoveryData { attempt_triggered_by: request.triggered_by, + charge_id: request.feature_metadata.as_ref().and_then(\|metadata\| { + metadata + .revenue_recovery + .as_ref() + .and_then(\|data\| data.charge_id.clone()) + }), } }), }; @@ -2781,6 +2787,8 @@ pub struct PaymentAttemptFeatureMetadata { #[derive(Debug, Clone, serde::Serialize, PartialEq)] pub struct PaymentAttemptRevenueRecoveryData { pub attempt_triggered_by: common_enums::TriggeredBy, + // stripe specific field used to identify duplicate attempts. + pub charge_id: Option<String>, } #[cfg(feature = "v2")] @@ -2791,6 +2799,7 @@ impl From<&PaymentAttemptFeatureMetadata> for DieselPaymentAttemptFeatureMetadat .as_ref() .map(\|recovery_data\| DieselPassiveChurnRecoveryData { attempt_triggered_by: recovery_data.attempt_triggered_by, + charge_id: recovery_data.charge_id.clone(), }); Self { revenue_recovery } } @@ -2803,6 +2812,7 @@ impl From<DieselPaymentAttemptFeatureMetadata> for PaymentAttemptFeatureMetadata item.revenue_recovery .map(\|recovery_data\| PaymentAttemptRevenueRecoveryData { attempt_triggered_by: recovery_data.attempt_triggered_by, + charge_id: recovery_data.charge_id, }); Self { revenue_recovery } } diff --git a/crates/hyperswitch_domain_models/src/revenue_recovery.rs b/crates/hyperswitch_domain_models/src/revenue_recovery.rs index 837d5d90839..0485644628a 100644 --- a/crates/hyperswitch_domain_models/src/revenue_recovery.rs +++ b/crates/hyperswitch_domain_models/src/revenue_recovery.rs @@ -52,6 +52,8 @@ pub struct RevenueRecoveryAttemptData { pub card_network: Option<common_enums::CardNetwork>, /// card isin pub card_isin: Option<String>, + /// stripe specific id used to validate duplicate attempts in revenue recovery flow + pub charge_id: Option<String>, } /// This is unified struct for Revenue Recovery Invoice Data and it is constructed from billing connectors @@ -278,6 +280,7 @@ impl invoice_next_billing_time: invoice_details.next_billing_at, card_network: billing_connector_payment_details.card_network.clone(), card_isin: billing_connector_payment_details.card_isin.clone(), + charge_id: billing_connector_payment_details.charge_id.clone(), } } } diff --git a/crates/hyperswitch_domain_models/src/router_response_types/revenue_recovery.rs b/crates/hyperswitch_domain_models/src/router_response_types/revenue_recovery.rs index 8dd6aa2e74c..3df81e6b66d 100644 --- a/crates/hyperswitch_domain_models/src/router_response_types/revenue_recovery.rs +++ b/crates/hyperswitch_domain_models/src/router_response_types/revenue_recovery.rs @@ -32,6 +32,8 @@ pub struct BillingConnectorPaymentsSyncResponse { pub card_network: Option<common_enums::CardNetwork>, /// card isin pub card_isin: Option<String>, + /// stripe specific id used to validate duplicate attempts. + pub charge_id: Option<String>, } #[derive(Debug, Clone)] diff --git a/crates/router/src/core/payments/transformers.rs b/crates/router/src/core/payments/transformers.rs index 5d40a603cbb..65f526af2e3 100644 --- a/crates/router/src/core/payments/transformers.rs +++ b/crates/router/src/core/payments/transformers.rs @@ -4989,6 +4989,7 @@ impl let revenue_recovery = feature_metadata.revenue_recovery.as_ref().map(\|recovery\| { api_models::payments::PaymentAttemptRevenueRecoveryData { attempt_triggered_by: recovery.attempt_triggered_by, + charge_id: recovery.charge_id.clone(), } }); Self { revenue_recovery } diff --git a/crates/router/src/core/routing/helpers.rs b/crates/router/src/core/routing/helpers.rs index 1dd965a71ce..666d0020260 100644 --- a/crates/router/src/core/routing/helpers.rs +++ b/crates/router/src/core/routing/helpers.rs @@ -1539,7 +1539,7 @@ pub async fn push_metrics_with_update_window_for_contract_based_routing( routing_events::RoutingEngine::IntelligentRouter, routing_events::ApiMethod::Grpc) .change_context(errors::ApiErrorResponse::InternalServerError) - .attach_printable("ContractRouting-Intelligent-Router: Failed to contruct RoutingEventsBuilder")? + .attach_printable("ContractRouting-Intelligent-Router: Failed to construct RoutingEventsBuilder")? .trigger_event(state, closure) .await .change_context(errors::ApiErrorResponse::InternalServerError) diff --git a/crates/router/src/core/webhooks/recovery_incoming.rs b/crates/router/src/core/webhooks/recovery_incoming.rs index cc4e08861ac..f13caeefb76 100644 --- a/crates/router/src/core/webhooks/recovery_incoming.rs +++ b/crates/router/src/core/webhooks/recovery_incoming.rs @@ -467,45 +467,49 @@ impl RevenueRecoveryAttempt { )>, errors::RevenueRecoveryError, > { - let attempt_response = Box::pin(payments::payments_core::< - router_flow_types::payments::PSync, - api_payments::PaymentsResponse, - _, - _, - _, - hyperswitch_domain_models::payments::PaymentStatusData< - router_flow_types::payments::PSync, - >, - >( - state.clone(), - req_state.clone(), - merchant_context.clone(), - profile.clone(), - payments::operations::PaymentGet, - api_payments::PaymentsRetrieveRequest { - force_sync: false, - expand_attempts: true, - param: None, - all_keys_required: None, - merchant_connector_details: None, - }, - payment_intent.payment_id.clone(), - payments::CallConnectorAction::Avoid, - hyperswitch_domain_models::payments::HeaderPayload::default(), - )) - .await; + let attempt_response = + Box::pin(payments::payments_list_attempts_using_payment_intent_id::< + payments::operations::PaymentGetListAttempts, + api_payments::PaymentAttemptListResponse, + _, + payments::operations::payment_attempt_list::PaymentGetListAttempts, + hyperswitch_domain_models::payments::PaymentAttemptListData< + payments::operations::PaymentGetListAttempts, + >, + >( + state.clone(), + req_state.clone(), + merchant_context.clone(), + profile.clone(), + payments::operations::PaymentGetListAttempts, + api_payments::PaymentAttemptListRequest { + payment_intent_id: payment_intent.payment_id.clone(), + }, + payment_intent.payment_id.clone(), + hyperswitch_domain_models::payments::HeaderPayload::default(), + )) + .await; let response = match attempt_response { Ok(services::ApplicationResponse::JsonWithHeaders((payments_response, _))) => { - let final_attempt = - self.0 - .connector_transaction_id - .as_ref() - .and_then(\|transaction_id\| { - payments_response - .find_attempt_in_attempts_list_using_connector_transaction_id( - transaction_id, - ) - }); + let final_attempt = self + .0 + .charge_id + .as_ref() + .map(\|charge_id\| { + payments_response + .find_attempt_in_attempts_list_using_charge_id(charge_id.clone()) + }) + .unwrap_or_else(\|\| { + self.0 + .connector_transaction_id + .as_ref() + .and_then(\|transaction_id\| { + payments_response + .find_attempt_in_attempts_list_using_connector_transaction_id( + transaction_id, + ) + }) + }); let payment_attempt = final_attempt.map(\|attempt_res\| revenue_recovery::RecoveryPaymentAttempt { attempt_id: attempt_res.id.to_owned(), @@ -613,6 +617,7 @@ impl RevenueRecoveryAttempt { revenue_recovery: Some(api_payments::PaymentAttemptRevenueRecoveryData { // Since we are recording the external paymenmt attempt, this is hardcoded to External attempt_triggered_by: triggered_by, + charge_id: self.0.charge_id.clone(), }), };	2025-06-19T17:51:05Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [x] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> Previously we were using payment get to find whether attempt is present in db or not, but for the first invoice webhook there won't be any attempt present in db and recently we added a validation to use payment get only in case of attempt is present. This PR solves this issue by invoking payment get attempt list instead of payment get. Also for stripe billing / stripe connector_transaction_id remains same instead charge id keeps changing , so we added a support for this by checking if charge id is present we compare charge id if not we check for connector transaction id. ### Additional Changes - [x] This PR modifies the API contract - [x] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> Tested complete revenue recovery flow with stripebilling 1) Set up merchant and mca for billing and payment connector for stripebilling and stripe 2) Make sure merchant have retry_algorithm_type to cascading in business profile 3) Trigger payment invoice from stripe, after threshold external attempts , pt entry should be done in and start triggering internal payments. ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.114.0	7943fb4bfb156e22d5329d45a580f90e02283604	7943fb4bfb156e22d5329d45a580f90e02283604
juspay/hyperswitch	juspay__hyperswitch-8398	Bug: [FEATURE] [AUTHIPAY] Integrate cards non-3ds payments ### Feature Description cards non-3ds payments needs to be integrated for authipay ### Possible Implementation cards non-3ds payments needs to be integrated for authipay ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? None	diff --git a/api-reference/v1/openapi_spec_v1.json b/api-reference/v1/openapi_spec_v1.json index 940922743ca..d748f65261a 100644 --- a/api-reference/v1/openapi_spec_v1.json +++ b/api-reference/v1/openapi_spec_v1.json @@ -10916,6 +10916,7 @@ "Connector": { "type": "string", "enum": [ + "authipay", "adyenplatform", "stripe_billing_test", "phonypay", @@ -27926,6 +27927,7 @@ "type": "string", "description": "RoutableConnectors are the subset of Connectors that are eligible for payments routing", "enum": [ + "authipay", "adyenplatform", "stripe_billing_test", "phonypay", diff --git a/api-reference/v2/openapi_spec_v2.json b/api-reference/v2/openapi_spec_v2.json index 12340ea5dcb..53bbace7dfb 100644 --- a/api-reference/v2/openapi_spec_v2.json +++ b/api-reference/v2/openapi_spec_v2.json @@ -8123,6 +8123,7 @@ "Connector": { "type": "string", "enum": [ + "authipay", "adyenplatform", "stripe_billing_test", "phonypay", @@ -22643,6 +22644,7 @@ "type": "string", "description": "RoutableConnectors are the subset of Connectors that are eligible for payments routing", "enum": [ + "authipay", "adyenplatform", "stripe_billing_test", "phonypay", diff --git a/config/config.example.toml b/config/config.example.toml index 10f796128f7..2b1916d41c2 100644 --- a/config/config.example.toml +++ b/config/config.example.toml @@ -189,6 +189,7 @@ airwallex.base_url = "https://api-demo.airwallex.com/" amazonpay.base_url = "https://pay-api.amazon.com/v2" applepay.base_url = "https://apple-pay-gateway.apple.com/" archipel.base_url = "https://{{merchant_endpoint_prefix}}/ArchiPEL/Transaction/v1" +authipay.base_url = "https://prod.emea.api.fiservapps.com/sandbox/ipp/payments-gateway/v2" authorizedotnet.base_url = "https://apitest.authorize.net/xml/v1/request.api" bambora.base_url = "https://api.na.bambora.com" bamboraapac.base_url = "https://demo.ippayments.com.au/interface/api" @@ -343,6 +344,7 @@ cards = [ "adyen", "adyenplatform", "archipel", + "authipay", "authorizedotnet", "celero", "coinbase", diff --git a/config/deployments/integration_test.toml b/config/deployments/integration_test.toml index 803047dca2e..f839aabbf60 100644 --- a/config/deployments/integration_test.toml +++ b/config/deployments/integration_test.toml @@ -28,6 +28,7 @@ airwallex.base_url = "https://api-demo.airwallex.com/" amazonpay.base_url = "https://pay-api.amazon.com/v2" applepay.base_url = "https://apple-pay-gateway.apple.com/" archipel.base_url = "https://{{merchant_endpoint_prefix}}/ArchiPEL/Transaction/v1" +authipay.base_url = "https://prod.emea.api.fiservapps.com/sandbox/ipp/payments-gateway/v2/" authorizedotnet.base_url = "https://apitest.authorize.net/xml/v1/request.api" bambora.base_url = "https://api.na.bambora.com" bamboraapac.base_url = "https://demo.ippayments.com.au/interface/api" diff --git a/config/deployments/production.toml b/config/deployments/production.toml index 94d8f18d44d..36f80248f9b 100644 --- a/config/deployments/production.toml +++ b/config/deployments/production.toml @@ -32,6 +32,7 @@ airwallex.base_url = "https://api.airwallex.com/" amazonpay.base_url = "https://pay-api.amazon.com/v2" applepay.base_url = "https://apple-pay-gateway.apple.com/" archipel.base_url = "https://{{merchant_endpoint_prefix}}/ArchiPEL/Transaction/v1" +authipay.base_url = "https://prod.emea.api.fiservapps.com/ipp/payments-gateway/v2/" authorizedotnet.base_url = "https://api.authorize.net/xml/v1/request.api" bambora.base_url = "https://api.na.bambora.com" bamboraapac.base_url = "https://www.bambora.co.nz/interface/api/dts.asmx" diff --git a/config/deployments/sandbox.toml b/config/deployments/sandbox.toml index 99daaab178d..3018fb176d0 100644 --- a/config/deployments/sandbox.toml +++ b/config/deployments/sandbox.toml @@ -32,6 +32,7 @@ airwallex.base_url = "https://api-demo.airwallex.com/" amazonpay.base_url = "https://pay-api.amazon.com/v2" applepay.base_url = "https://apple-pay-gateway.apple.com/" archipel.base_url = "https://{{merchant_endpoint_prefix}}/ArchiPEL/Transaction/v1" +authipay.base_url = "https://prod.emea.api.fiservapps.com/sandbox/ipp/payments-gateway/v2" authorizedotnet.base_url = "https://apitest.authorize.net/xml/v1/request.api" bambora.base_url = "https://api.na.bambora.com" bamboraapac.base_url = "https://demo.ippayments.com.au/interface/api" diff --git a/config/development.toml b/config/development.toml index b72f7bcbaee..8808aabb0ef 100644 --- a/config/development.toml +++ b/config/development.toml @@ -99,6 +99,7 @@ cards = [ "airwallex", "amazonpay", "archipel", + "authipay", "authorizedotnet", "bambora", "bamboraapac", @@ -227,6 +228,7 @@ airwallex.base_url = "https://api-demo.airwallex.com/" amazonpay.base_url = "https://pay-api.amazon.com/v2" applepay.base_url = "https://apple-pay-gateway.apple.com/" archipel.base_url = "https://{{merchant_endpoint_prefix}}/ArchiPEL/Transaction/v1" +authipay.base_url = "https://prod.emea.api.fiservapps.com/sandbox/ipp/payments-gateway/v2/" authorizedotnet.base_url = "https://apitest.authorize.net/xml/v1/request.api" bambora.base_url = "https://api.na.bambora.com" bamboraapac.base_url = "https://demo.ippayments.com.au/interface/api" diff --git a/config/docker_compose.toml b/config/docker_compose.toml index ef3ad0b1b05..b232636421f 100644 --- a/config/docker_compose.toml +++ b/config/docker_compose.toml @@ -115,6 +115,7 @@ airwallex.base_url = "https://api-demo.airwallex.com/" amazonpay.base_url = "https://pay-api.amazon.com/v2" applepay.base_url = "https://apple-pay-gateway.apple.com/" archipel.base_url = "https://{{merchant_endpoint_prefix}}/ArchiPEL/Transaction/v1" +authipay.base_url = "https://prod.emea.api.fiservapps.com/sandbox/ipp/payments-gateway/v2/" authorizedotnet.base_url = "https://apitest.authorize.net/xml/v1/request.api" bambora.base_url = "https://api.na.bambora.com" bamboraapac.base_url = "https://demo.ippayments.com.au/interface/api" @@ -251,6 +252,7 @@ cards = [ "airwallex", "amazonpay", "archipel", + "authipay", "authorizedotnet", "bambora", "bamboraapac", diff --git a/config/payment_required_fields_v2.toml b/config/payment_required_fields_v2.toml index cc9ffee29e2..fe1e6e050d2 100644 --- a/config/payment_required_fields_v2.toml +++ b/config/payment_required_fields_v2.toml @@ -47,6 +47,14 @@ common = [ { required_field = "payment_method_data.billing.address.last_name", display_name = "card_holder_name", field_type = "user_full_name" } ] +[required_fields.Card.Debit.fields.Authipay] +common = [ + { required_field = "payment_method_data.card.card_number", display_name = "card_number", field_type = "user_card_number" }, + { required_field = "payment_method_data.card.card_exp_month", display_name = "card_exp_month", field_type = "user_card_expiry_month" }, + { required_field = "payment_method_data.card.card_exp_year", display_name = "card_exp_year", field_type = "user_card_expiry_year" }, + { required_field = "payment_method_data.card.card_cvc", display_name = "card_cvc", field_type = "user_card_cvc" } +] + [required_fields.Card.Debit.fields.Bambora] non_mandate = [ { required_field = "payment_method_data.card.card_number", display_name = "card_number", field_type = "user_card_number" }, @@ -546,6 +554,14 @@ common = [ { required_field = "payment_method_data.card.card_cvc", display_name = "card_cvc", field_type = "user_card_cvc" } ] +[required_fields.Card.Credit.fields.Authipay] +common = [ + { required_field = "payment_method_data.card.card_number", display_name = "card_number", field_type = "user_card_number" }, + { required_field = "payment_method_data.card.card_exp_month", display_name = "card_exp_month", field_type = "user_card_expiry_month" }, + { required_field = "payment_method_data.card.card_exp_year", display_name = "card_exp_year", field_type = "user_card_expiry_year" }, + { required_field = "payment_method_data.card.card_cvc", display_name = "card_cvc", field_type = "user_card_cvc" } +] + [required_fields.Card.Credit.fields.Bambora] non_mandate = [ { required_field = "payment_method_data.card.card_number", display_name = "card_number", field_type = "user_card_number" }, @@ -2341,4 +2357,4 @@ non_mandate = [ [required_fields.card_redirect.momo_atm.fields.Adyen] common = [] mandate = [] -non_mandate = [] \ No newline at end of file +non_mandate = [] diff --git a/crates/common_enums/src/connector_enums.rs b/crates/common_enums/src/connector_enums.rs index 5251b9b3177..41563d56f27 100644 --- a/crates/common_enums/src/connector_enums.rs +++ b/crates/common_enums/src/connector_enums.rs @@ -25,6 +25,7 @@ pub use crate::PaymentMethodType; #[strum(serialize_all = "snake_case")] /// RoutableConnectors are the subset of Connectors that are eligible for payments routing pub enum RoutableConnectors { + Authipay, Adyenplatform, #[cfg(feature = "dummy_connector")] #[serde(rename = "stripe_billing_test")] @@ -184,6 +185,7 @@ pub enum RoutableConnectors { #[serde(rename_all = "snake_case")] #[strum(serialize_all = "snake_case")] pub enum Connector { + Authipay, Adyenplatform, #[cfg(feature = "dummy_connector")] #[serde(rename = "stripe_billing_test")] @@ -404,6 +406,7 @@ impl Connector { \| Self::DummyConnector7 => false, Self::Aci // Add Separate authentication support for connectors + \| Self::Authipay \| Self::Adyen \| Self::Adyenplatform \| Self::Airwallex @@ -551,6 +554,7 @@ impl Connector { impl From<RoutableConnectors> for Connector { fn from(routable_connector: RoutableConnectors) -> Self { match routable_connector { + RoutableConnectors::Authipay => Self::Authipay, RoutableConnectors::Adyenplatform => Self::Adyenplatform, #[cfg(feature = "dummy_connector")] RoutableConnectors::DummyBillingConnector => Self::DummyBillingConnector, @@ -673,6 +677,7 @@ impl TryFrom<Connector> for RoutableConnectors { fn try_from(connector: Connector) -> Result<Self, Self::Error> { match connector { + Connector::Authipay => Ok(Self::Authipay), Connector::Adyenplatform => Ok(Self::Adyenplatform), #[cfg(feature = "dummy_connector")] Connector::DummyBillingConnector => Ok(Self::DummyBillingConnector), diff --git a/crates/connector_configs/src/connector.rs b/crates/connector_configs/src/connector.rs index f092b543f8c..67e340fa155 100644 --- a/crates/connector_configs/src/connector.rs +++ b/crates/connector_configs/src/connector.rs @@ -171,6 +171,7 @@ pub struct ConnectorTomlConfig { #[serde_with::skip_serializing_none] #[derive(Debug, Deserialize, serde::Serialize, Clone)] pub struct ConnectorConfig { + pub authipay: Option<ConnectorTomlConfig>, pub juspaythreedsserver: Option<ConnectorTomlConfig>, pub aci: Option<ConnectorTomlConfig>, pub adyen: Option<ConnectorTomlConfig>, @@ -369,6 +370,7 @@ impl ConnectorConfig { let connector_data = Self::new()?; match connector { Connector::Aci => Ok(connector_data.aci), + Connector::Authipay => Ok(connector_data.authipay), Connector::Adyen => Ok(connector_data.adyen), Connector::Adyenplatform => Err("Use get_payout_connector_config".to_string()), Connector::Airwallex => Ok(connector_data.airwallex), diff --git a/crates/connector_configs/toml/development.toml b/crates/connector_configs/toml/development.toml index f8919cba957..a8a0baa2661 100644 --- a/crates/connector_configs/toml/development.toml +++ b/crates/connector_configs/toml/development.toml @@ -502,7 +502,21 @@ required=true type="MultiSelect" options=["PAN_ONLY", "CRYPTOGRAM_3DS"] - +[authipay] +[[authipay.credit]] + payment_method_type = "Mastercard" +[[authipay.credit]] + payment_method_type = "Visa" +[[authipay.debit]] + payment_method_type = "Mastercard" +[[authipay.debit]] + payment_method_type = "Visa" +[authipay.connector_auth.SignatureKey] +api_key="API Key" +api_secret="API Secret" +key1="Merchant ID" +[authipay.connector_webhook_details] +merchant_secret="Source verification key" [authorizedotnet] [[authorizedotnet.credit]] diff --git a/crates/connector_configs/toml/production.toml b/crates/connector_configs/toml/production.toml index 667c5028c95..a22b50a9b4f 100644 --- a/crates/connector_configs/toml/production.toml +++ b/crates/connector_configs/toml/production.toml @@ -305,6 +305,22 @@ key1="Client ID" [airwallex.connector_webhook_details] merchant_secret="Source verification key" +[authipay] +[[authipay.credit]] + payment_method_type = "Mastercard" +[[authipay.credit]] + payment_method_type = "Visa" +[[authipay.debit]] + payment_method_type = "Mastercard" +[[authipay.debit]] + payment_method_type = "Visa" +[authipay.connector_auth.SignatureKey] +api_key="API Key" +api_secret="API Secret" +key1="Merchant ID" +[authipay.connector_webhook_details] +merchant_secret="Source verification key" + [authorizedotnet] [[authorizedotnet.credit]] payment_method_type = "Mastercard" diff --git a/crates/connector_configs/toml/sandbox.toml b/crates/connector_configs/toml/sandbox.toml index 20b7cdf09bf..d7026129699 100644 --- a/crates/connector_configs/toml/sandbox.toml +++ b/crates/connector_configs/toml/sandbox.toml @@ -503,7 +503,21 @@ required=true type="MultiSelect" options=["PAN_ONLY", "CRYPTOGRAM_3DS"] - +[authipay] +[[authipay.credit]] + payment_method_type = "Mastercard" +[[authipay.credit]] + payment_method_type = "Visa" +[[authipay.debit]] + payment_method_type = "Mastercard" +[[authipay.debit]] + payment_method_type = "Visa" +[authipay.connector_auth.SignatureKey] +api_key="API Key" +api_secret="API Secret" +key1="Merchant ID" +[authipay.connector_webhook_details] +merchant_secret="Source verification key" [authorizedotnet] [[authorizedotnet.credit]] diff --git a/crates/hyperswitch_connectors/src/connectors.rs b/crates/hyperswitch_connectors/src/connectors.rs index 6583e2ce5b9..84b53c97143 100644 --- a/crates/hyperswitch_connectors/src/connectors.rs +++ b/crates/hyperswitch_connectors/src/connectors.rs @@ -4,6 +4,7 @@ pub mod adyenplatform; pub mod airwallex; pub mod amazonpay; pub mod archipel; +pub mod authipay; pub mod authorizedotnet; pub mod bambora; pub mod bamboraapac; @@ -115,16 +116,16 @@ pub mod zsl; pub use self::dummyconnector::DummyConnector; pub use self::{ aci::Aci, adyen::Adyen, adyenplatform::Adyenplatform, airwallex::Airwallex, - amazonpay::Amazonpay, archipel::Archipel, authorizedotnet::Authorizedotnet, bambora::Bambora, - bamboraapac::Bamboraapac, bankofamerica::Bankofamerica, barclaycard::Barclaycard, - billwerk::Billwerk, bitpay::Bitpay, bluesnap::Bluesnap, boku::Boku, braintree::Braintree, - cashtocode::Cashtocode, celero::Celero, chargebee::Chargebee, checkbook::Checkbook, - checkout::Checkout, coinbase::Coinbase, coingate::Coingate, cryptopay::Cryptopay, - ctp_mastercard::CtpMastercard, cybersource::Cybersource, datatrans::Datatrans, - deutschebank::Deutschebank, digitalvirgo::Digitalvirgo, dlocal::Dlocal, dwolla::Dwolla, - ebanx::Ebanx, elavon::Elavon, facilitapay::Facilitapay, fiserv::Fiserv, fiservemea::Fiservemea, - fiuu::Fiuu, forte::Forte, getnet::Getnet, globalpay::Globalpay, globepay::Globepay, - gocardless::Gocardless, gpayments::Gpayments, helcim::Helcim, hipay::Hipay, + amazonpay::Amazonpay, archipel::Archipel, authipay::Authipay, authorizedotnet::Authorizedotnet, + bambora::Bambora, bamboraapac::Bamboraapac, bankofamerica::Bankofamerica, + barclaycard::Barclaycard, billwerk::Billwerk, bitpay::Bitpay, bluesnap::Bluesnap, boku::Boku, + braintree::Braintree, cashtocode::Cashtocode, celero::Celero, chargebee::Chargebee, + checkbook::Checkbook, checkout::Checkout, coinbase::Coinbase, coingate::Coingate, + cryptopay::Cryptopay, ctp_mastercard::CtpMastercard, cybersource::Cybersource, + datatrans::Datatrans, deutschebank::Deutschebank, digitalvirgo::Digitalvirgo, dlocal::Dlocal, + dwolla::Dwolla, ebanx::Ebanx, elavon::Elavon, facilitapay::Facilitapay, fiserv::Fiserv, + fiservemea::Fiservemea, fiuu::Fiuu, forte::Forte, getnet::Getnet, globalpay::Globalpay, + globepay::Globepay, gocardless::Gocardless, gpayments::Gpayments, helcim::Helcim, hipay::Hipay, hyperswitch_vault::HyperswitchVault, iatapay::Iatapay, inespay::Inespay, itaubank::Itaubank, jpmorgan::Jpmorgan, juspaythreedsserver::Juspaythreedsserver, klarna::Klarna, mifinity::Mifinity, mollie::Mollie, moneris::Moneris, multisafepay::Multisafepay, diff --git a/crates/hyperswitch_connectors/src/connectors/authipay.rs b/crates/hyperswitch_connectors/src/connectors/authipay.rs new file mode 100644 index 00000000000..5a5179ef5f1 --- /dev/null +++ b/crates/hyperswitch_connectors/src/connectors/authipay.rs @@ -0,0 +1,849 @@ +pub mod transformers; + +use std::sync::LazyLock; + +use base64::Engine; +use common_enums::enums; +use common_utils::{ + errors::CustomResult, + ext_traits::BytesExt, + request::{Method, Request, RequestBuilder, RequestContent}, + types::{AmountConvertor, FloatMajorUnit, FloatMajorUnitForConnector}, +}; +use error_stack::{report, ResultExt}; +use hyperswitch_domain_models::{ + router_data::{AccessToken, ConnectorAuthType, ErrorResponse, RouterData}, + router_flow_types::{ + access_token_auth::AccessTokenAuth, + payments::{Authorize, Capture, PSync, PaymentMethodToken, Session, SetupMandate, Void}, + refunds::{Execute, RSync}, + }, + router_request_types::{ + AccessTokenRequestData, PaymentMethodTokenizationData, PaymentsAuthorizeData, + PaymentsCancelData, PaymentsCaptureData, PaymentsSessionData, PaymentsSyncData, + RefundsData, SetupMandateRequestData, + }, + router_response_types::{ + ConnectorInfo, PaymentMethodDetails, PaymentsResponseData, RefundsResponseData, + SupportedPaymentMethods, SupportedPaymentMethodsExt, + }, + types::{ + PaymentsAuthorizeRouterData, PaymentsCancelRouterData, PaymentsCaptureRouterData, + PaymentsSyncRouterData, RefundSyncRouterData, RefundsRouterData, + }, +}; +use hyperswitch_interfaces::{ + api::{ + self, ConnectorCommon, ConnectorCommonExt, ConnectorIntegration, ConnectorSpecifications, + ConnectorValidation, + }, + configs::Connectors, + errors, + events::connector_api_logs::ConnectorEvent, + types::{self, Response}, + webhooks, +}; +use masking::{ExposeInterface, Mask, PeekInterface}; +use transformers as authipay; + +use crate::{constants::headers, types::ResponseRouterData, utils}; + +#[derive(Clone)] +pub struct Authipay { + amount_converter: &'static (dyn AmountConvertor<Output = FloatMajorUnit> + Sync), +} + +impl Authipay { + pub fn new() -> &'static Self { + &Self { + amount_converter: &FloatMajorUnitForConnector, + } + } + + pub fn generate_authorization_signature( + &self, + auth: authipay::AuthipayAuthType, + request_id: &str, + payload: &str, + timestamp: i128, + ) -> CustomResult<String, errors::ConnectorError> { + let authipay::AuthipayAuthType { + api_key, + api_secret, + } = auth; + let raw_signature = format!("{}{request_id}{timestamp}{payload}", api_key.peek()); + + let key = ring::hmac::Key::new(ring::hmac::HMAC_SHA256, api_secret.expose().as_bytes()); + let signature_value = common_utils::consts::BASE64_ENGINE + .encode(ring::hmac::sign(&key, raw_signature.as_bytes()).as_ref()); + Ok(signature_value) + } +} + +impl api::Payment for Authipay {} +impl api::PaymentSession for Authipay {} +impl api::ConnectorAccessToken for Authipay {} +impl api::MandateSetup for Authipay {} +impl api::PaymentAuthorize for Authipay {} +impl api::PaymentSync for Authipay {} +impl api::PaymentCapture for Authipay {} +impl api::PaymentVoid for Authipay {} +impl api::Refund for Authipay {} +impl api::RefundExecute for Authipay {} +impl api::RefundSync for Authipay {} +impl api::PaymentToken for Authipay {} + +impl ConnectorIntegration<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData> + for Authipay +{ + // Not Implemented (R) +} + +impl<Flow, Request, Response> ConnectorCommonExt<Flow, Request, Response> for Authipay +where + Self: ConnectorIntegration<Flow, Request, Response>, +{ + fn build_headers( + &self, + req: &RouterData<Flow, Request, Response>, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + let timestamp = time::OffsetDateTime::now_utc().unix_timestamp_nanos() / 1_000_000; + let auth: authipay::AuthipayAuthType = + authipay::AuthipayAuthType::try_from(&req.connector_auth_type)?; + let mut auth_header = self.get_auth_header(&req.connector_auth_type)?; + + let authipay_req = self.get_request_body(req, connectors)?; + + let client_request_id = uuid::Uuid::new_v4().to_string(); + let hmac = self + .generate_authorization_signature( + auth, + &client_request_id, + authipay_req.get_inner_value().peek(), + timestamp, + ) + .change_context(errors::ConnectorError::RequestEncodingFailed)?; + let mut headers = vec![ + ( + headers::CONTENT_TYPE.to_string(), + types::PaymentsAuthorizeType::get_content_type(self) + .to_string() + .into(), + ), + ("Client-Request-Id".to_string(), client_request_id.into()), + ("Auth-Token-Type".to_string(), "HMAC".to_string().into()), + (headers::TIMESTAMP.to_string(), timestamp.to_string().into()), + ("Message-Signature".to_string(), hmac.into_masked()), + ]; + headers.append(&mut auth_header); + Ok(headers) + } +} + +impl ConnectorCommon for Authipay { + fn id(&self) -> &'static str { + "authipay" + } + + fn get_currency_unit(&self) -> api::CurrencyUnit { + api::CurrencyUnit::Base + } + + fn common_get_content_type(&self) -> &'static str { + "application/json" + } + + fn base_url<'a>(&self, connectors: &'a Connectors) -> &'a str { + connectors.authipay.base_url.as_ref() + } + + fn get_auth_header( + &self, + auth_type: &ConnectorAuthType, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + let auth = authipay::AuthipayAuthType::try_from(auth_type) + .change_context(errors::ConnectorError::FailedToObtainAuthType)?; + Ok(vec![( + headers::API_KEY.to_string(), + auth.api_key.into_masked(), + )]) + } + + fn build_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + let response: authipay::AuthipayErrorResponse = res + .response + .parse_struct("AuthipayErrorResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + + event_builder.map(\|i\| i.set_error_response_body(&response)); + + let mut error_response = ErrorResponse::from(&response); + + // Set status code from the response, or 400 if error code is a "404" + if let Some(error_code) = &response.error.code { + if error_code == "404" { + error_response.status_code = 404; + } else { + error_response.status_code = res.status_code; + } + } else { + error_response.status_code = res.status_code; + } + + Ok(error_response) + } +} + +impl ConnectorValidation for Authipay { + fn validate_connector_against_payment_request( + &self, + capture_method: Option<enums::CaptureMethod>, + _payment_method: enums::PaymentMethod, + _pmt: Option<enums::PaymentMethodType>, + ) -> CustomResult<(), errors::ConnectorError> { + let capture_method = capture_method.unwrap_or_default(); + match capture_method { + enums::CaptureMethod::Automatic + \| enums::CaptureMethod::Manual + \| enums::CaptureMethod::SequentialAutomatic => Ok(()), + enums::CaptureMethod::Scheduled \| enums::CaptureMethod::ManualMultiple => Err( + utils::construct_not_implemented_error_report(capture_method, self.id()), + ), + } + } +} + +impl ConnectorIntegration<Session, PaymentsSessionData, PaymentsResponseData> for Authipay { + //TODO: implement sessions flow +} + +impl ConnectorIntegration<AccessTokenAuth, AccessTokenRequestData, AccessToken> for Authipay {} + +impl ConnectorIntegration<SetupMandate, SetupMandateRequestData, PaymentsResponseData> + for Authipay +{ +} + +impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData> for Authipay { + fn get_headers( + &self, + req: &PaymentsAuthorizeRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsAuthorizeRouterData, + connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Ok(format!("{}payments", self.base_url(connectors))) + } + + fn get_request_body( + &self, + req: &PaymentsAuthorizeRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let amount = utils::convert_amount( + self.amount_converter, + req.request.minor_amount, + req.request.currency, + )?; + + let connector_router_data = authipay::AuthipayRouterData::from((amount, req)); + let connector_req = authipay::AuthipayPaymentsRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &PaymentsAuthorizeRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::PaymentsAuthorizeType::get_url( + self, req, connectors, + )?) + .attach_default_headers() + .headers(types::PaymentsAuthorizeType::get_headers( + self, req, connectors, + )?) + .set_body(types::PaymentsAuthorizeType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsAuthorizeRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsAuthorizeRouterData, errors::ConnectorError> { + let response: authipay::AuthipayPaymentsResponse = res + .response + .parse_struct("Authipay PaymentsAuthorizeResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<PSync, PaymentsSyncData, PaymentsResponseData> for Authipay { + fn get_headers( + &self, + req: &PaymentsSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + req: &PaymentsSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + let connector_transaction_id = req + .request + .connector_transaction_id + .get_connector_transaction_id() + .change_context(errors::ConnectorError::RequestEncodingFailed)?; + Ok(format!( + "{}payments/{}", + self.base_url(connectors), + connector_transaction_id + )) + } + + fn get_request_body( + &self, + _req: &PaymentsSyncRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + Ok(RequestContent::RawBytes(Vec::new())) + } + + fn build_request( + &self, + req: &PaymentsSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Get) + .url(&types::PaymentsSyncType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::PaymentsSyncType::get_headers(self, req, connectors)?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsSyncRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsSyncRouterData, errors::ConnectorError> { + let response: authipay::AuthipayPaymentsResponse = res + .response + .parse_struct("authipay PaymentsSyncResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<Capture, PaymentsCaptureData, PaymentsResponseData> for Authipay { + fn get_headers( + &self, + req: &PaymentsCaptureRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + req: &PaymentsCaptureRouterData, + connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + let connector_transaction_id = req.request.connector_transaction_id.clone(); + Ok(format!( + "{}payments/{}", + self.base_url(connectors), + connector_transaction_id + )) + } + + fn get_request_body( + &self, + req: &PaymentsCaptureRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let amount = utils::convert_amount( + self.amount_converter, + req.request.minor_amount_to_capture, + req.request.currency, + )?; + + let connector_router_data = authipay::AuthipayRouterData::from((amount, req)); + let connector_req = authipay::AuthipayCaptureRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &PaymentsCaptureRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::PaymentsCaptureType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::PaymentsCaptureType::get_headers( + self, req, connectors, + )?) + .set_body(types::PaymentsCaptureType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsCaptureRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsCaptureRouterData, errors::ConnectorError> { + let response: authipay::AuthipayPaymentsResponse = res + .response + .parse_struct("Authipay PaymentsCaptureResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<Void, PaymentsCancelData, PaymentsResponseData> for Authipay { + fn get_headers( + &self, + req: &PaymentsCancelRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + req: &PaymentsCancelRouterData, + connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + // For void operations, Authipay requires using the /orders/{orderId} endpoint + // The orderId should be stored in connector_meta from the authorization response + let order_id = req + .request + .connector_meta + .as_ref() + .and_then(\|meta\| meta.get("order_id")) + .and_then(\|v\| v.as_str()) + .ok_or(errors::ConnectorError::RequestEncodingFailed)?; + + Ok(format!("{}orders/{}", self.base_url(connectors), order_id)) + } + + fn get_request_body( + &self, + req: &PaymentsCancelRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + // For void, we don't need amount conversion since it's always full amount + let connector_router_data = + authipay::AuthipayRouterData::from((FloatMajorUnit::zero(), req)); + let connector_req = authipay::AuthipayVoidRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &PaymentsCancelRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::PaymentsVoidType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::PaymentsVoidType::get_headers(self, req, connectors)?) + .set_body(types::PaymentsVoidType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsCancelRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsCancelRouterData, errors::ConnectorError> { + let response: authipay::AuthipayPaymentsResponse = res + .response + .parse_struct("Authipay PaymentsVoidResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<Execute, RefundsData, RefundsResponseData> for Authipay { + fn get_headers( + &self, + req: &RefundsRouterData<Execute>, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + req: &RefundsRouterData<Execute>, + connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + let connector_payment_id = req.request.connector_transaction_id.clone(); + Ok(format!( + "{}payments/{}", + self.base_url(connectors), + connector_payment_id + )) + } + + fn get_request_body( + &self, + req: &RefundsRouterData<Execute>, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let refund_amount = utils::convert_amount( + self.amount_converter, + req.request.minor_refund_amount, + req.request.currency, + )?; + + let connector_router_data = authipay::AuthipayRouterData::from((refund_amount, req)); + let connector_req = authipay::AuthipayRefundRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &RefundsRouterData<Execute>, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + let request = RequestBuilder::new() + .method(Method::Post) + .url(&types::RefundExecuteType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::RefundExecuteType::get_headers( + self, req, connectors, + )?) + .set_body(types::RefundExecuteType::get_request_body( + self, req, connectors, + )?) + .build(); + Ok(Some(request)) + } + + fn handle_response( + &self, + data: &RefundsRouterData<Execute>, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<RefundsRouterData<Execute>, errors::ConnectorError> { + let response: authipay::RefundResponse = res + .response + .parse_struct("authipay RefundResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<RSync, RefundsData, RefundsResponseData> for Authipay { + fn get_headers( + &self, + req: &RefundSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + req: &RefundSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + let refund_id = req + .request + .connector_refund_id + .clone() + .ok_or(errors::ConnectorError::RequestEncodingFailed)?; + Ok(format!( + "{}payments/{}", + self.base_url(connectors), + refund_id + )) + } + + fn get_request_body( + &self, + _req: &RefundSyncRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + Ok(RequestContent::RawBytes(Vec::new())) + } + + fn build_request( + &self, + req: &RefundSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Get) + .url(&types::RefundSyncType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::RefundSyncType::get_headers(self, req, connectors)?) + .build(), + )) + } + + fn handle_response( + &self, + data: &RefundSyncRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<RefundSyncRouterData, errors::ConnectorError> { + let response: authipay::RefundResponse = res + .response + .parse_struct("authipay RefundSyncResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +#[async_trait::async_trait] +impl webhooks::IncomingWebhook for Authipay { + fn get_webhook_object_reference_id( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<api_models::webhooks::ObjectReferenceId, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } + + fn get_webhook_event_type( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<api_models::webhooks::IncomingWebhookEvent, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } + + fn get_webhook_resource_object( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<Box<dyn masking::ErasedMaskSerialize>, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } +} + +static AUTHIPAY_SUPPORTED_PAYMENT_METHODS: LazyLock<SupportedPaymentMethods> = + LazyLock::new(\|\| { + let supported_capture_methods = vec![ + enums::CaptureMethod::Automatic, + enums::CaptureMethod::SequentialAutomatic, + enums::CaptureMethod::Manual, + ]; + + let supported_card_network = vec![ + common_enums::CardNetwork::Visa, + common_enums::CardNetwork::Mastercard, + ]; + + let mut authipay_supported_payment_methods = SupportedPaymentMethods::new(); + + authipay_supported_payment_methods.add( + enums::PaymentMethod::Card, + enums::PaymentMethodType::Credit, + PaymentMethodDetails { + mandates: enums::FeatureStatus::NotSupported, + refunds: enums::FeatureStatus::Supported, + supported_capture_methods: supported_capture_methods.clone(), + specific_features: Some( + api_models::feature_matrix::PaymentMethodSpecificFeatures::Card({ + api_models::feature_matrix::CardSpecificFeatures { + three_ds: common_enums::FeatureStatus::NotSupported, + no_three_ds: common_enums::FeatureStatus::Supported, + supported_card_networks: supported_card_network.clone(), + } + }), + ), + }, + ); + + authipay_supported_payment_methods.add( + enums::PaymentMethod::Card, + enums::PaymentMethodType::Debit, + PaymentMethodDetails { + mandates: enums::FeatureStatus::NotSupported, + refunds: enums::FeatureStatus::Supported, + supported_capture_methods: supported_capture_methods.clone(), + specific_features: Some( + api_models::feature_matrix::PaymentMethodSpecificFeatures::Card({ + api_models::feature_matrix::CardSpecificFeatures { + three_ds: common_enums::FeatureStatus::NotSupported, + no_three_ds: common_enums::FeatureStatus::Supported, + supported_card_networks: supported_card_network.clone(), + } + }), + ), + }, + ); + + authipay_supported_payment_methods + }); + +static AUTHIPAY_CONNECTOR_INFO: ConnectorInfo = ConnectorInfo { + display_name: "Authipay", + description: "Authipay is a Fiserv-powered payment gateway for the EMEA region supporting Visa and Mastercard transactions. Features include flexible capture methods (automatic, manual, sequential), partial captures/refunds, payment tokenization, and secure HMAC SHA256 authentication.", + connector_type: enums::PaymentConnectorCategory::PaymentGateway, +}; + +static AUTHIPAY_SUPPORTED_WEBHOOK_FLOWS: [enums::EventClass; 0] = []; + +impl ConnectorSpecifications for Authipay { + fn get_connector_about(&self) -> Option<&'static ConnectorInfo> { + Some(&AUTHIPAY_CONNECTOR_INFO) + } + + fn get_supported_payment_methods(&self) -> Option<&'static SupportedPaymentMethods> { + Some(&AUTHIPAY_SUPPORTED_PAYMENT_METHODS) + } + + fn get_supported_webhook_flows(&self) -> Option<&'static [enums::EventClass]> { + Some(&AUTHIPAY_SUPPORTED_WEBHOOK_FLOWS) + } +} diff --git a/crates/hyperswitch_connectors/src/connectors/authipay/transformers.rs b/crates/hyperswitch_connectors/src/connectors/authipay/transformers.rs new file mode 100644 index 00000000000..c7c21404752 --- /dev/null +++ b/crates/hyperswitch_connectors/src/connectors/authipay/transformers.rs @@ -0,0 +1,624 @@ +use cards; +use common_enums::enums; +use common_utils::types::FloatMajorUnit; +use hyperswitch_domain_models::{ + payment_method_data::PaymentMethodData, + router_data::{ConnectorAuthType, ErrorResponse, RouterData}, + router_flow_types::refunds::{Execute, RSync}, + router_request_types::ResponseId, + router_response_types::{PaymentsResponseData, RefundsResponseData}, + types::{ + PaymentsAuthorizeRouterData, PaymentsCancelRouterData, PaymentsCaptureRouterData, + RefundsRouterData, + }, +}; +use hyperswitch_interfaces::errors; +use masking::Secret; +use serde::{Deserialize, Serialize}; + +use crate::{ + types::{RefundsResponseRouterData, ResponseRouterData}, + utils, +}; + +// Type definition for router data with amount +pub struct AuthipayRouterData<T> { + pub amount: FloatMajorUnit, // Amount in major units (e.g., dollars instead of cents) + pub router_data: T, +} + +impl<T> From<(FloatMajorUnit, T)> for AuthipayRouterData<T> { + fn from((amount, item): (FloatMajorUnit, T)) -> Self { + Self { + amount, + router_data: item, + } + } +} + +// Basic request/response structs used across multiple operations + +#[derive(Default, Debug, Serialize, Deserialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct Amount { + total: FloatMajorUnit, + currency: String, + #[serde(skip_serializing_if = "Option::is_none")] + components: Option<AmountComponents>, +} + +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct AmountComponents { + subtotal: FloatMajorUnit, +} + +#[derive(Default, Debug, Serialize, Deserialize, Clone, Eq, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct ExpiryDate { + month: Secret<String>, + year: Secret<String>, +} + +#[derive(Default, Debug, Serialize, Eq, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct Card { + number: cards::CardNumber, + security_code: Secret<String>, + expiry_date: ExpiryDate, +} + +#[derive(Default, Debug, Serialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct PaymentMethod { + payment_card: Card, +} + +#[derive(Default, Debug, Serialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct SplitShipment { + total_count: i32, + final_shipment: bool, +} + +#[derive(Debug, Serialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct AuthipayPaymentsRequest { + request_type: &'static str, + transaction_amount: Amount, + payment_method: PaymentMethod, + // split_shipment: Option<SplitShipment>, + // incremental_flag: Option<bool>, +} + +impl TryFrom<&AuthipayRouterData<&PaymentsAuthorizeRouterData>> for AuthipayPaymentsRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: &AuthipayRouterData<&PaymentsAuthorizeRouterData>, + ) -> Result<Self, Self::Error> { + // Check if 3DS is being requested - Authipay doesn't support 3DS + if matches!( + item.router_data.auth_type, + enums::AuthenticationType::ThreeDs + ) { + return Err(errors::ConnectorError::NotImplemented( + utils::get_unimplemented_payment_method_error_message("authipay"), + ) + .into()); + } + + match item.router_data.request.payment_method_data.clone() { + PaymentMethodData::Card(req_card) => { + let expiry_date = ExpiryDate { + month: req_card.card_exp_month.clone(), + year: req_card.card_exp_year.clone(), + }; + + let card = Card { + number: req_card.card_number.clone(), + security_code: req_card.card_cvc.clone(), + expiry_date, + }; + + let payment_method = PaymentMethod { payment_card: card }; + + let transaction_amount = Amount { + total: item.amount, + currency: item.router_data.request.currency.to_string(), + components: None, + }; + + // Determine request type based on capture method + let request_type = match item.router_data.request.capture_method { + Some(enums::CaptureMethod::Manual) => "PaymentCardPreAuthTransaction", + Some(enums::CaptureMethod::Automatic) => "PaymentCardSaleTransaction", + Some(enums::CaptureMethod::SequentialAutomatic) => "PaymentCardSaleTransaction", + Some(enums::CaptureMethod::ManualMultiple) + \| Some(enums::CaptureMethod::Scheduled) => { + return Err(errors::ConnectorError::NotSupported { + message: "Capture method not supported by Authipay".to_string(), + connector: "Authipay", + } + .into()); + } + None => "PaymentCardSaleTransaction", // Default when not specified + }; + + let request = Self { + request_type, + transaction_amount, + payment_method, + }; + + Ok(request) + } + _ => Err(errors::ConnectorError::NotImplemented( + utils::get_unimplemented_payment_method_error_message("authipay"), + ) + .into()), + } + } +} + +//TODO: Fill the struct with respective fields +// Auth Struct +pub struct AuthipayAuthType { + pub(super) api_key: Secret<String>, + pub(super) api_secret: Secret<String>, +} + +impl TryFrom<&ConnectorAuthType> for AuthipayAuthType { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from(auth_type: &ConnectorAuthType) -> Result<Self, Self::Error> { + match auth_type { + ConnectorAuthType::SignatureKey { + api_key, + api_secret, + .. + } => Ok(Self { + api_key: api_key.to_owned(), + api_secret: api_secret.to_owned(), + }), + _ => Err(errors::ConnectorError::FailedToObtainAuthType.into()), + } + } +} +// Transaction Status enum (like Fiserv's FiservPaymentStatus) +#[derive(Debug, Clone, Default, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "UPPERCASE")] +pub enum AuthipayTransactionStatus { + Authorized, + Captured, + Voided, + Declined, + Failed, + #[default] + Processing, +} + +impl From<AuthipayTransactionStatus> for enums::AttemptStatus { + fn from(item: AuthipayTransactionStatus) -> Self { + match item { + AuthipayTransactionStatus::Captured => Self::Charged, + AuthipayTransactionStatus::Declined \| AuthipayTransactionStatus::Failed => { + Self::Failure + } + AuthipayTransactionStatus::Processing => Self::Pending, + AuthipayTransactionStatus::Authorized => Self::Authorized, + AuthipayTransactionStatus::Voided => Self::Voided, + } + } +} + +// Transaction Processing Details (like Fiserv's TransactionProcessingDetails) +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct AuthipayTransactionProcessingDetails { + pub order_id: String, + pub transaction_id: String, +} + +// Gateway Response (like Fiserv's GatewayResponse) +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct AuthipayGatewayResponse { + pub transaction_state: AuthipayTransactionStatus, + pub transaction_processing_details: AuthipayTransactionProcessingDetails, +} + +// Payment Receipt (like Fiserv's PaymentReceipt) +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct AuthipayPaymentReceipt { + pub approved_amount: Amount, + pub processor_response_details: Option<Processor>, +} + +// Main Response (like Fiserv's FiservPaymentsResponse) - but flat for JSON deserialization +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct AuthipayPaymentsResponse { + #[serde(rename = "type")] + response_type: Option<String>, + client_request_id: String, + api_trace_id: String, + ipg_transaction_id: String, + order_id: String, + transaction_type: String, + payment_token: Option<PaymentToken>, + transaction_origin: Option<String>, + payment_method_details: Option<PaymentMethodDetails>, + country: Option<String>, + terminal_id: Option<String>, + merchant_id: Option<String>, + transaction_time: i64, + approved_amount: Amount, + transaction_amount: Amount, + // For payment transactions (SALE) + transaction_status: Option<String>, + // For refund transactions (RETURN) + transaction_result: Option<String>, + transaction_state: Option<String>, + approval_code: String, + scheme_transaction_id: Option<String>, + processor: Processor, +} + +impl AuthipayPaymentsResponse { + /// Get gateway response (like Fiserv's gateway_response) + pub fn gateway_response(&self) -> AuthipayGatewayResponse { + AuthipayGatewayResponse { + transaction_state: self.get_transaction_status(), + transaction_processing_details: AuthipayTransactionProcessingDetails { + order_id: self.order_id.clone(), + transaction_id: self.ipg_transaction_id.clone(), + }, + } + } + + /// Get payment receipt (like Fiserv's payment_receipt) + pub fn payment_receipt(&self) -> AuthipayPaymentReceipt { + AuthipayPaymentReceipt { + approved_amount: self.approved_amount.clone(), + processor_response_details: Some(self.processor.clone()), + } + } + + /// Determine the transaction status based on transaction type and various status fields (like Fiserv) + fn get_transaction_status(&self) -> AuthipayTransactionStatus { + match self.transaction_type.as_str() { + "RETURN" => { + // Refund transaction - use transaction_result + match self.transaction_result.as_deref() { + Some("APPROVED") => AuthipayTransactionStatus::Captured, + Some("DECLINED") \| Some("FAILED") => AuthipayTransactionStatus::Failed, + _ => AuthipayTransactionStatus::Processing, + } + } + "VOID" => { + // Void transaction - use transaction_result, fallback to transaction_state + match self.transaction_result.as_deref() { + Some("APPROVED") => AuthipayTransactionStatus::Voided, + Some("DECLINED") \| Some("FAILED") => AuthipayTransactionStatus::Failed, + Some("PENDING") \| Some("PROCESSING") => AuthipayTransactionStatus::Processing, + _ => { + // Fallback to transaction_state for void operations + match self.transaction_state.as_deref() { + Some("VOIDED") => AuthipayTransactionStatus::Voided, + Some("FAILED") \| Some("DECLINED") => AuthipayTransactionStatus::Failed, + _ => AuthipayTransactionStatus::Voided, // Default assumption for void requests + } + } + } + } + _ => { + // Payment transaction - prioritize transaction_state over transaction_status + match self.transaction_state.as_deref() { + Some("AUTHORIZED") => AuthipayTransactionStatus::Authorized, + Some("CAPTURED") => AuthipayTransactionStatus::Captured, + Some("VOIDED") => AuthipayTransactionStatus::Voided, + Some("DECLINED") \| Some("FAILED") => AuthipayTransactionStatus::Failed, + _ => { + // Fallback to transaction_status with transaction_type context + match ( + self.transaction_type.as_str(), + self.transaction_status.as_deref(), + ) { + // For PREAUTH transactions, "APPROVED" means authorized and awaiting capture + ("PREAUTH", Some("APPROVED")) => AuthipayTransactionStatus::Authorized, + // For POSTAUTH transactions, "APPROVED" means successfully captured + ("POSTAUTH", Some("APPROVED")) => AuthipayTransactionStatus::Captured, + // For SALE transactions, "APPROVED" means completed payment + ("SALE", Some("APPROVED")) => AuthipayTransactionStatus::Captured, + // For VOID transactions, "APPROVED" means successfully voided + ("VOID", Some("APPROVED")) => AuthipayTransactionStatus::Voided, + // Generic status mappings for other cases + (_, Some("APPROVED")) => AuthipayTransactionStatus::Captured, + (_, Some("AUTHORIZED")) => AuthipayTransactionStatus::Authorized, + (_, Some("DECLINED") \| Some("FAILED")) => { + AuthipayTransactionStatus::Failed + } + _ => AuthipayTransactionStatus::Processing, + } + } + } + } + } + } +} + +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct PaymentToken { + reusable: Option<bool>, + decline_duplicates: Option<bool>, + brand: Option<String>, + #[serde(rename = "type")] + token_type: Option<String>, +} + +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct PaymentMethodDetails { + payment_card: Option<PaymentCardDetails>, + payment_method_type: Option<String>, + payment_method_brand: Option<String>, +} + +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct PaymentCardDetails { + expiry_date: ExpiryDate, + bin: String, + last4: String, + brand: String, +} + +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct Processor { + reference_number: Option<String>, + authorization_code: Option<String>, + response_code: String, + response_message: String, + avs_response: Option<AvsResponse>, + security_code_response: Option<String>, + tax_refund_data: Option<serde_json::Value>, +} + +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct AvsResponse { + street_match: Option<String>, + postal_code_match: Option<String>, +} + +impl<F, T> TryFrom<ResponseRouterData<F, AuthipayPaymentsResponse, T, PaymentsResponseData>> + for RouterData<F, T, PaymentsResponseData> +{ + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: ResponseRouterData<F, AuthipayPaymentsResponse, T, PaymentsResponseData>, + ) -> Result<Self, Self::Error> { + // Get gateway response (like Fiserv pattern) + let gateway_resp = item.response.gateway_response(); + + // Store order_id in connector_metadata for void operations (like Fiserv) + let mut metadata = std::collections::HashMap::new(); + metadata.insert( + "order_id".to_string(), + serde_json::Value::String(gateway_resp.transaction_processing_details.order_id.clone()), + ); + let connector_metadata = Some(serde_json::Value::Object(serde_json::Map::from_iter( + metadata, + ))); + + Ok(Self { + status: enums::AttemptStatus::from(gateway_resp.transaction_state.clone()), + response: Ok(PaymentsResponseData::TransactionResponse { + resource_id: ResponseId::ConnectorTransactionId( + gateway_resp + .transaction_processing_details + .transaction_id + .clone(), + ), + redirection_data: Box::new(None), + mandate_reference: Box::new(None), + connector_metadata, + network_txn_id: None, + connector_response_reference_id: Some( + gateway_resp.transaction_processing_details.order_id.clone(), + ), + incremental_authorization_allowed: None, + charges: None, + }), + ..item.data + }) + } +} + +// Type definition for CaptureRequest +#[derive(Debug, Serialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct AuthipayCaptureRequest { + request_type: &'static str, + transaction_amount: Amount, +} + +impl TryFrom<&AuthipayRouterData<&PaymentsCaptureRouterData>> for AuthipayCaptureRequest { + type Error = error_stack::Report<errors::ConnectorError>; + + fn try_from( + item: &AuthipayRouterData<&PaymentsCaptureRouterData>, + ) -> Result<Self, Self::Error> { + Ok(Self { + request_type: "PostAuthTransaction", + transaction_amount: Amount { + total: item.amount, + currency: item.router_data.request.currency.to_string(), + components: None, + }, + }) + } +} + +// Type definition for VoidRequest +#[derive(Debug, Serialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct AuthipayVoidRequest { + request_type: &'static str, +} + +impl TryFrom<&AuthipayRouterData<&PaymentsCancelRouterData>> for AuthipayVoidRequest { + type Error = error_stack::Report<errors::ConnectorError>; + + fn try_from( + _item: &AuthipayRouterData<&PaymentsCancelRouterData>, + ) -> Result<Self, Self::Error> { + Ok(Self { + request_type: "VoidTransaction", + }) + } +} + +// Type definition for RefundRequest +#[derive(Default, Debug, Serialize)] +#[serde(rename_all = "camelCase")] +pub struct AuthipayRefundRequest { + request_type: &'static str, + transaction_amount: Amount, +} + +impl<F> TryFrom<&AuthipayRouterData<&RefundsRouterData<F>>> for AuthipayRefundRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from(item: &AuthipayRouterData<&RefundsRouterData<F>>) -> Result<Self, Self::Error> { + Ok(Self { + request_type: "ReturnTransaction", + transaction_amount: Amount { + total: item.amount.to_owned(), + currency: item.router_data.request.currency.to_string(), + components: None, + }, + }) + } +} + +// Type definition for Refund Response + +#[allow(dead_code)] +#[derive(Debug, Serialize, Default, Deserialize, Clone)] +pub enum RefundStatus { + Succeeded, + Failed, + #[default] + Processing, +} + +impl From<RefundStatus> for enums::RefundStatus { + fn from(item: RefundStatus) -> Self { + match item { + RefundStatus::Succeeded => Self::Success, + RefundStatus::Failed => Self::Failure, + RefundStatus::Processing => Self::Pending, + //TODO: Review mapping + } + } +} + +// Reusing the payments response structure for refunds +// because Authipay uses the same endpoint and response format +pub type RefundResponse = AuthipayPaymentsResponse; + +impl TryFrom<RefundsResponseRouterData<Execute, RefundResponse>> for RefundsRouterData<Execute> { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: RefundsResponseRouterData<Execute, RefundResponse>, + ) -> Result<Self, Self::Error> { + let refund_status = if item.response.transaction_type == "RETURN" { + match item.response.transaction_result.as_deref() { + Some("APPROVED") => RefundStatus::Succeeded, + Some("DECLINED") \| Some("FAILED") => RefundStatus::Failed, + _ => RefundStatus::Processing, + } + } else { + RefundStatus::Processing + }; + + Ok(Self { + response: Ok(RefundsResponseData { + connector_refund_id: item.response.ipg_transaction_id.to_string(), + refund_status: enums::RefundStatus::from(refund_status), + }), + ..item.data + }) + } +} + +impl TryFrom<RefundsResponseRouterData<RSync, RefundResponse>> for RefundsRouterData<RSync> { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: RefundsResponseRouterData<RSync, RefundResponse>, + ) -> Result<Self, Self::Error> { + let refund_status = if item.response.transaction_type == "RETURN" { + match item.response.transaction_result.as_deref() { + Some("APPROVED") => RefundStatus::Succeeded, + Some("DECLINED") \| Some("FAILED") => RefundStatus::Failed, + _ => RefundStatus::Processing, + } + } else { + RefundStatus::Processing + }; + + Ok(Self { + response: Ok(RefundsResponseData { + connector_refund_id: item.response.ipg_transaction_id.to_string(), + refund_status: enums::RefundStatus::from(refund_status), + }), + ..item.data + }) + } +} + +// Error Response structs +#[derive(Default, Debug, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ErrorDetailItem { + pub field: String, + pub message: String, +} + +#[derive(Default, Debug, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ErrorDetails { + pub code: Option<String>, + pub message: String, + pub details: Option<Vec<ErrorDetailItem>>, +} + +#[derive(Default, Debug, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct AuthipayErrorResponse { + pub client_request_id: Option<String>, + pub api_trace_id: Option<String>, + pub response_type: Option<String>, + #[serde(rename = "type")] + pub response_object_type: Option<String>, + pub error: ErrorDetails, + pub decline_reason_code: Option<String>, +} + +impl From<&AuthipayErrorResponse> for ErrorResponse { + fn from(item: &AuthipayErrorResponse) -> Self { + Self { + status_code: 500, // Default to Internal Server Error, will be overridden by actual HTTP status + code: item.error.code.clone().unwrap_or_default(), + message: item.error.message.clone(), + reason: None, + attempt_status: None, + connector_transaction_id: None, + network_decline_code: None, + network_advice_code: None, + network_error_message: None, + } + } +} diff --git a/crates/hyperswitch_connectors/src/default_implementations.rs b/crates/hyperswitch_connectors/src/default_implementations.rs index 9cc798d57cd..38e63124029 100644 --- a/crates/hyperswitch_connectors/src/default_implementations.rs +++ b/crates/hyperswitch_connectors/src/default_implementations.rs @@ -148,6 +148,7 @@ default_imp_for_authorize_session_token!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -274,6 +275,7 @@ default_imp_for_calculate_tax!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -401,6 +403,7 @@ default_imp_for_session_update!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -528,6 +531,7 @@ default_imp_for_post_session_tokens!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -654,6 +658,7 @@ default_imp_for_create_order!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -781,6 +786,7 @@ default_imp_for_update_metadata!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -911,6 +917,7 @@ default_imp_for_complete_authorize!( connectors::Adyenplatform, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Bamboraapac, connectors::Bankofamerica, connectors::Barclaycard, @@ -1018,6 +1025,7 @@ default_imp_for_incremental_authorization!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1145,6 +1153,7 @@ default_imp_for_create_customer!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1270,6 +1279,7 @@ default_imp_for_connector_redirect_response!( connectors::Adyenplatform, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Billwerk, connectors::Bitpay, connectors::Bamboraapac, @@ -1377,6 +1387,7 @@ default_imp_for_pre_processing_steps!( connectors::Adyenplatform, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1494,6 +1505,7 @@ default_imp_for_post_processing_steps!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1622,6 +1634,7 @@ default_imp_for_approve!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1751,6 +1764,7 @@ default_imp_for_reject!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1880,6 +1894,7 @@ default_imp_for_webhook_source_verification!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2008,6 +2023,7 @@ default_imp_for_accept_dispute!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2135,6 +2151,7 @@ default_imp_for_submit_evidence!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2261,6 +2278,7 @@ default_imp_for_defend_dispute!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2397,6 +2415,7 @@ default_imp_for_file_upload!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2515,6 +2534,7 @@ default_imp_for_payouts!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2637,6 +2657,7 @@ default_imp_for_payouts_create!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2763,6 +2784,7 @@ default_imp_for_payouts_retrieve!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2891,6 +2913,7 @@ default_imp_for_payouts_eligibility!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -3017,6 +3040,7 @@ default_imp_for_payouts_fulfill!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -3140,6 +3164,7 @@ default_imp_for_payouts_cancel!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -3267,6 +3292,7 @@ default_imp_for_payouts_quote!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -3395,6 +3421,7 @@ default_imp_for_payouts_recipient!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -3522,6 +3549,7 @@ default_imp_for_payouts_recipient_account!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -3651,6 +3679,7 @@ default_imp_for_frm_sale!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -3780,6 +3809,7 @@ default_imp_for_frm_checkout!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -3909,6 +3939,7 @@ default_imp_for_frm_transaction!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -4038,6 +4069,7 @@ default_imp_for_frm_fulfillment!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -4167,6 +4199,7 @@ default_imp_for_frm_record_return!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -4293,6 +4326,7 @@ default_imp_for_revoking_mandates!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -4417,6 +4451,7 @@ default_imp_for_uas_pre_authentication!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -4543,6 +4578,7 @@ default_imp_for_uas_post_authentication!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -4670,6 +4706,7 @@ default_imp_for_uas_authentication_confirmation!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -4788,6 +4825,7 @@ default_imp_for_connector_request_id!( connectors::Adyenplatform, connectors::Airwallex, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Amazonpay, connectors::Bambora, @@ -4910,6 +4948,7 @@ default_imp_for_fraud_check!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -5061,6 +5100,7 @@ default_imp_for_connector_authentication!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -5185,6 +5225,7 @@ default_imp_for_uas_authentication!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -5304,6 +5345,7 @@ default_imp_for_revenue_recovery!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -5434,6 +5476,7 @@ default_imp_for_billing_connector_payment_sync!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -5563,6 +5606,7 @@ default_imp_for_revenue_recovery_record_back!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -5690,6 +5734,7 @@ default_imp_for_billing_connector_invoice_sync!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -5812,6 +5857,7 @@ default_imp_for_external_vault!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Barclaycard, connectors::Bambora, @@ -5940,6 +5986,7 @@ default_imp_for_external_vault_insert!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Barclaycard, connectors::Bambora, @@ -6068,6 +6115,7 @@ default_imp_for_external_vault_retrieve!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Barclaycard, connectors::Bambora, @@ -6196,6 +6244,7 @@ default_imp_for_external_vault_delete!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Barclaycard, connectors::Bambora, @@ -6324,6 +6373,7 @@ default_imp_for_external_vault_create!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Barclaycard, connectors::Bambora, diff --git a/crates/hyperswitch_connectors/src/default_implementations_v2.rs b/crates/hyperswitch_connectors/src/default_implementations_v2.rs index 7bc66a1e6cf..89a7b3de2ac 100644 --- a/crates/hyperswitch_connectors/src/default_implementations_v2.rs +++ b/crates/hyperswitch_connectors/src/default_implementations_v2.rs @@ -253,6 +253,7 @@ default_imp_for_new_connector_integration_payment!( connectors::Airwallex, connectors::Amazonpay, connectors::Adyenplatform, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -382,6 +383,7 @@ default_imp_for_new_connector_integration_refund!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -506,6 +508,7 @@ default_imp_for_new_connector_integration_connector_access_token!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -636,6 +639,7 @@ default_imp_for_new_connector_integration_accept_dispute!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -764,6 +768,7 @@ default_imp_for_new_connector_integration_submit_evidence!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -892,6 +897,7 @@ default_imp_for_new_connector_integration_defend_dispute!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1031,6 +1037,7 @@ default_imp_for_new_connector_integration_file_upload!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1162,6 +1169,7 @@ default_imp_for_new_connector_integration_payouts_create!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1293,6 +1301,7 @@ default_imp_for_new_connector_integration_payouts_eligibility!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1424,6 +1433,7 @@ default_imp_for_new_connector_integration_payouts_fulfill!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1555,6 +1565,7 @@ default_imp_for_new_connector_integration_payouts_cancel!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1686,6 +1697,7 @@ default_imp_for_new_connector_integration_payouts_quote!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1817,6 +1829,7 @@ default_imp_for_new_connector_integration_payouts_recipient!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1948,6 +1961,7 @@ default_imp_for_new_connector_integration_payouts_sync!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2079,6 +2093,7 @@ default_imp_for_new_connector_integration_payouts_recipient_account!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2208,6 +2223,7 @@ default_imp_for_new_connector_integration_webhook_source_verification!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2339,6 +2355,7 @@ default_imp_for_new_connector_integration_frm_sale!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2470,6 +2487,7 @@ default_imp_for_new_connector_integration_frm_checkout!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2601,6 +2619,7 @@ default_imp_for_new_connector_integration_frm_transaction!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2732,6 +2751,7 @@ default_imp_for_new_connector_integration_frm_fulfillment!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2863,6 +2883,7 @@ default_imp_for_new_connector_integration_frm_record_return!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2991,6 +3012,7 @@ default_imp_for_new_connector_integration_revoking_mandates!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -3110,6 +3132,7 @@ default_imp_for_new_connector_integration_frm!( connectors::Vgs, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Bambora, connectors::Bamboraapac, connectors::Barclaycard, @@ -3238,6 +3261,7 @@ default_imp_for_new_connector_integration_connector_authentication!( connectors::Vgs, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Bambora, connectors::Bamboraapac, connectors::Barclaycard, @@ -3355,6 +3379,7 @@ default_imp_for_new_connector_integration_revenue_recovery!( connectors::Vgs, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Bambora, connectors::Bamboraapac, connectors::Barclaycard, @@ -3485,6 +3510,7 @@ default_imp_for_new_connector_integration_external_vault!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Barclaycard, connectors::Bambora, diff --git a/crates/hyperswitch_domain_models/src/configs.rs b/crates/hyperswitch_domain_models/src/configs.rs index 9e64262f78f..9e4b94f9465 100644 --- a/crates/hyperswitch_domain_models/src/configs.rs +++ b/crates/hyperswitch_domain_models/src/configs.rs @@ -12,6 +12,7 @@ use crate::errors::api_error_response; #[serde(default)] pub struct Connectors { pub aci: ConnectorParams, + pub authipay: ConnectorParams, pub adyen: AdyenParamsWithThreeBaseUrls, pub adyenplatform: ConnectorParams, pub airwallex: ConnectorParams, diff --git a/crates/payment_methods/src/configs/payment_connector_required_fields.rs b/crates/payment_methods/src/configs/payment_connector_required_fields.rs index 08baca7e35f..ec3ea46ccd2 100644 --- a/crates/payment_methods/src/configs/payment_connector_required_fields.rs +++ b/crates/payment_methods/src/configs/payment_connector_required_fields.rs @@ -1195,6 +1195,7 @@ impl Default for RequiredFields { fn get_cards_required_fields() -> HashMap<Connector, RequiredFieldFinal> { HashMap::from([ (Connector::Aci, fields(vec![], vec![], card_with_name())), + (Connector::Authipay, fields(vec![], vec![], card_basic())), (Connector::Adyen, fields(vec![], vec![], card_with_name())), (Connector::Airwallex, fields(vec![], card_basic(), vec![])), ( diff --git a/crates/router/src/connector.rs b/crates/router/src/connector.rs index 619608a95de..d50086f5481 100644 --- a/crates/router/src/connector.rs +++ b/crates/router/src/connector.rs @@ -4,16 +4,16 @@ pub mod utils; pub use hyperswitch_connectors::connectors::DummyConnector; pub use hyperswitch_connectors::connectors::{ aci, aci::Aci, adyen, adyen::Adyen, adyenplatform, adyenplatform::Adyenplatform, airwallex, - airwallex::Airwallex, amazonpay, amazonpay::Amazonpay, archipel, archipel::Archipel, - authorizedotnet, authorizedotnet::Authorizedotnet, bambora, bambora::Bambora, bamboraapac, - bamboraapac::Bamboraapac, bankofamerica, bankofamerica::Bankofamerica, barclaycard, - barclaycard::Barclaycard, billwerk, billwerk::Billwerk, bitpay, bitpay::Bitpay, bluesnap, - bluesnap::Bluesnap, boku, boku::Boku, braintree, braintree::Braintree, cashtocode, - cashtocode::Cashtocode, celero, celero::Celero, chargebee, chargebee::Chargebee, checkbook, - checkbook::Checkbook, checkout, checkout::Checkout, coinbase, coinbase::Coinbase, coingate, - coingate::Coingate, cryptopay, cryptopay::Cryptopay, ctp_mastercard, - ctp_mastercard::CtpMastercard, cybersource, cybersource::Cybersource, datatrans, - datatrans::Datatrans, deutschebank, deutschebank::Deutschebank, digitalvirgo, + airwallex::Airwallex, amazonpay, amazonpay::Amazonpay, archipel, archipel::Archipel, authipay, + authipay::Authipay, authorizedotnet, authorizedotnet::Authorizedotnet, bambora, + bambora::Bambora, bamboraapac, bamboraapac::Bamboraapac, bankofamerica, + bankofamerica::Bankofamerica, barclaycard, barclaycard::Barclaycard, billwerk, + billwerk::Billwerk, bitpay, bitpay::Bitpay, bluesnap, bluesnap::Bluesnap, boku, boku::Boku, + braintree, braintree::Braintree, cashtocode, cashtocode::Cashtocode, celero, celero::Celero, + chargebee, chargebee::Chargebee, checkbook, checkbook::Checkbook, checkout, checkout::Checkout, + coinbase, coinbase::Coinbase, coingate, coingate::Coingate, cryptopay, cryptopay::Cryptopay, + ctp_mastercard, ctp_mastercard::CtpMastercard, cybersource, cybersource::Cybersource, + datatrans, datatrans::Datatrans, deutschebank, deutschebank::Deutschebank, digitalvirgo, digitalvirgo::Digitalvirgo, dlocal, dlocal::Dlocal, dwolla, dwolla::Dwolla, ebanx, ebanx::Ebanx, elavon, elavon::Elavon, facilitapay, facilitapay::Facilitapay, fiserv, fiserv::Fiserv, fiservemea, fiservemea::Fiservemea, fiuu, fiuu::Fiuu, forte, forte::Forte, diff --git a/crates/router/src/core/connector_validation.rs b/crates/router/src/core/connector_validation.rs index 655636197d8..6fb5a340ba2 100644 --- a/crates/router/src/core/connector_validation.rs +++ b/crates/router/src/core/connector_validation.rs @@ -89,6 +89,10 @@ impl ConnectorAuthTypeAndMetadataValidation<'_> { archipel::transformers::ArchipelConfigData::try_from(self.connector_meta_data)?; Ok(()) } + api_enums::Connector::Authipay => { + authipay::transformers::AuthipayAuthType::try_from(self.auth_type)?; + Ok(()) + } api_enums::Connector::Authorizedotnet => { authorizedotnet::transformers::AuthorizedotnetAuthType::try_from(self.auth_type)?; Ok(()) diff --git a/crates/router/src/types/api.rs b/crates/router/src/types/api.rs index 45d6dd0d75e..eab04a9f0cc 100644 --- a/crates/router/src/types/api.rs +++ b/crates/router/src/types/api.rs @@ -328,6 +328,10 @@ impl ConnectorData { match enums::Connector::from_str(connector_name) { Ok(name) => match name { enums::Connector::Aci => Ok(ConnectorEnum::Old(Box::new(connector::Aci::new()))), + + enums::Connector::Authipay => { + Ok(ConnectorEnum::Old(Box::new(connector::Authipay::new()))) + } enums::Connector::Adyen => { Ok(ConnectorEnum::Old(Box::new(connector::Adyen::new()))) } diff --git a/crates/router/src/types/transformers.rs b/crates/router/src/types/transformers.rs index 713293568b3..35ba30da6a7 100644 --- a/crates/router/src/types/transformers.rs +++ b/crates/router/src/types/transformers.rs @@ -207,6 +207,7 @@ impl ForeignTryFrom<api_enums::Connector> for common_enums::RoutableConnectors { fn foreign_try_from(from: api_enums::Connector) -> Result<Self, Self::Error> { Ok(match from { api_enums::Connector::Aci => Self::Aci, + api_enums::Connector::Authipay => Self::Authipay, api_enums::Connector::Adyen => Self::Adyen, api_enums::Connector::Adyenplatform => Self::Adyenplatform, api_enums::Connector::Airwallex => Self::Airwallex, diff --git a/crates/router/tests/connectors/authipay.rs b/crates/router/tests/connectors/authipay.rs new file mode 100644 index 00000000000..aa362166fdf --- /dev/null +++ b/crates/router/tests/connectors/authipay.rs @@ -0,0 +1,454 @@ +use std::str::FromStr; +use masking::Secret; +use router::{ + types::{self, api, storage::enums}, + core::errors, +}; +use cards; + +use crate::utils::{self, ConnectorActions}; +use test_utils::connector_auth; + +#[derive(Clone, Copy)] +struct AuthipayTest; +impl ConnectorActions for AuthipayTest {} +impl utils::Connector for AuthipayTest { + fn get_data(&self) -> api::ConnectorData { + use router::connector::Authipay; + api::ConnectorData { + connector: Box::new(Authipay::new()), + connector_name: types::Connector::Authipay, + get_token: types::api::GetToken::Connector, + merchant_connector_id: None, + } + } + + fn get_auth_token(&self) -> types::ConnectorAuthType { + utils::to_connector_auth_type( + connector_auth::ConnectorAuthentication::new() + .authipay + .expect("Missing connector authentication configuration").into(), + ) + } + + fn get_name(&self) -> String { + "authipay".to_string() + } +} + +static CONNECTOR: AuthipayTest = AuthipayTest {}; + +fn get_default_payment_info() -> Option<utils::PaymentInfo> { + Some(utils::PaymentInfo { + payment_id: utils::get_payment_id(), + payment_method: enums::PaymentMethod::Card, + payment_method_type: Some(enums::PaymentMethodType::Credit), + amount: 100, // $1.00 + currency: enums::Currency::USD, + capture_method: Some(enums::CaptureMethod::Manual), + mandate_id: None, + setup_future_usage: None, + off_session: None, + merchant_connector_id: None, + browser_info: None, + recurring_mandate_payment: None, + router_return_url: None, + connector_meta: None, + allowed_payment_method_types: None, + pm_token: None, + payment_experience: None, + webhook_url: None, + customer_id: None, + surcharge_details: None, + connector_request_reference_id: None, + request_incremental_authorization: None, + metadata: None, + payment_type: None, + session_token: None, + terminal_id: None, + card_network: None, + capture_on: None, + incremental_authorization_allowed: None, + }) +} + +fn payment_method_details() -> Option<types::PaymentsAuthorizeData> { + Some(types::PaymentsAuthorizeData { + payment_method_data: api::PaymentMethodData::Card(api::Card { + card_number: cards::CardNumber::from_str("4035874000424977").unwrap(), // Visa test card from Authipay specs + card_exp_month: Secret::new("12".to_string()), + card_exp_year: Secret::new("2024".to_string()), + card_cvc: Secret::new("123".to_string()), + card_holder_name: Secret::new("John Doe".to_string()), + card_issuer: None, + card_network: None, + card_type: None, + card_issuing_country: None, + bank_code: None, + nick_name: Some("Default Card".to_string()), + }), + currency: enums::Currency::USD, + amount: 100, // $1.00 + router_return_url: String::from("http://localhost:8080/"), + payment_method_type: Some(enums::PaymentMethodType::Credit), + ..utils::PaymentAuthorizeType::default().0 + }) +} + +// Cards Positive Tests +// Creates a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_only_authorize_payment() { + let response = CONNECTOR + .authorize_payment(payment_method_details(), get_default_payment_info()) + .await + .expect("Authorize payment response"); + assert_eq!(response.status, enums::AttemptStatus::Authorized); +} + +// Captures a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_capture_authorized_payment() { + let response = CONNECTOR + .authorize_and_capture_payment(payment_method_details(), None, get_default_payment_info()) + .await + .expect("Capture payment response"); + assert_eq!(response.status, enums::AttemptStatus::Charged); +} + +// Partially captures a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_capture_authorized_payment() { + let response = CONNECTOR + .authorize_and_capture_payment( + payment_method_details(), + Some(types::PaymentsCaptureData { + amount_to_capture: 50, + ..utils::PaymentCaptureType::default().0 + }), + get_default_payment_info(), + ) + .await + .expect("Capture payment response"); + assert_eq!(response.status, enums::AttemptStatus::Charged); +} + +// Synchronizes a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_authorized_payment() { + let authorize_response = CONNECTOR + .authorize_payment(payment_method_details(), get_default_payment_info()) + .await + .expect("Authorize payment response"); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + let response = CONNECTOR + .psync_retry_till_status_matches( + enums::AttemptStatus::Authorized, + Some(types::PaymentsSyncData { + connector_transaction_id: types::ResponseId::ConnectorTransactionId( + txn_id.unwrap(), + ), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .expect("PSync response"); + assert_eq!(response.status, enums::AttemptStatus::Authorized,); +} + +// Voids a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_void_authorized_payment() { + let response = CONNECTOR + .authorize_and_void_payment( + payment_method_details(), + Some(types::PaymentsCancelData { + connector_transaction_id: String::from(""), + cancellation_reason: Some("requested_by_customer".to_string()), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .expect("Void payment response"); + assert_eq!(response.status, enums::AttemptStatus::Voided); +} + +// Refunds a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_manually_captured_payment() { + let response = CONNECTOR + .capture_payment_and_refund(payment_method_details(), None, None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Partially refunds a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_refund_manually_captured_payment() { + let response = CONNECTOR + .capture_payment_and_refund( + payment_method_details(), + None, + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Synchronizes a refund using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_manually_captured_refund() { + let refund_response = CONNECTOR + .capture_payment_and_refund(payment_method_details(), None, None, get_default_payment_info()) + .await + .unwrap(); + let response = CONNECTOR + .rsync_retry_till_status_matches( + enums::RefundStatus::Success, + refund_response.response.unwrap().connector_refund_id, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Creates a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_make_payment() { + let authorize_response = CONNECTOR.make_payment(payment_method_details(), get_default_payment_info()).await.unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); +} + +// Synchronizes a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_auto_captured_payment() { + let authorize_response = CONNECTOR.make_payment(payment_method_details(), get_default_payment_info()).await.unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + assert_ne!(txn_id, None, "Empty connector transaction id"); + let response = CONNECTOR + .psync_retry_till_status_matches( + enums::AttemptStatus::Charged, + Some(types::PaymentsSyncData { + connector_transaction_id: types::ResponseId::ConnectorTransactionId( + txn_id.unwrap(), + ), + capture_method: Some(enums::CaptureMethod::Automatic), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!(response.status, enums::AttemptStatus::Charged,); +} + +// Refunds a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_auto_captured_payment() { + let response = CONNECTOR + .make_payment_and_refund(payment_method_details(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Partially refunds a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_refund_succeeded_payment() { + let refund_response = CONNECTOR + .make_payment_and_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + refund_response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Creates multiple refunds against a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_succeeded_payment_multiple_times() { + CONNECTOR + .make_payment_and_multiple_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await; +} + +// Synchronizes a refund using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_refund() { + let refund_response = CONNECTOR + .make_payment_and_refund(payment_method_details(), None, get_default_payment_info()) + .await + .unwrap(); + let response = CONNECTOR + .rsync_retry_till_status_matches( + enums::RefundStatus::Success, + refund_response.response.unwrap().connector_refund_id, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Cards Negative scenarios +// Creates a payment with incorrect CVC. +#[actix_web::test] +async fn should_fail_payment_for_incorrect_cvc() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: types::api::PaymentMethodData::Card(api::Card { + card_cvc: Secret::new("12345".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's security code is invalid.".to_string(), + ); +} + +// Creates a payment with incorrect expiry month. +#[actix_web::test] +async fn should_fail_payment_for_invalid_exp_month() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: api::PaymentMethodData::Card(api::Card { + card_exp_month: Secret::new("20".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's expiration month is invalid.".to_string(), + ); +} + +// Creates a payment with incorrect expiry year. +#[actix_web::test] +async fn should_fail_payment_for_incorrect_expiry_year() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: api::PaymentMethodData::Card(api::Card { + card_exp_year: Secret::new("2000".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's expiration year is invalid.".to_string(), + ); +} + +// Voids a payment using automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_fail_void_payment_for_auto_capture() { + let authorize_response = CONNECTOR.make_payment(payment_method_details(), get_default_payment_info()).await.unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + assert_ne!(txn_id, None, "Empty connector transaction id"); + let void_response = CONNECTOR + .void_payment(txn_id.unwrap(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + void_response.response.unwrap_err().message, + "You cannot cancel this PaymentIntent because it has a status of succeeded." + ); +} + +// Captures a payment using invalid connector payment id. +#[actix_web::test] +async fn should_fail_capture_for_invalid_payment() { + let capture_response = CONNECTOR + .capture_payment("123456789".to_string(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + capture_response.response.unwrap_err().message, + String::from("No such payment_intent: '123456789'") + ); +} + +// Refunds a payment with refund amount higher than payment amount. +#[actix_web::test] +async fn should_fail_for_refund_amount_higher_than_payment_amount() { + let response = CONNECTOR + .make_payment_and_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 150, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Refund amount (₹1.50) is greater than charge amount (₹1.00)", + ); +} + +// Connector dependent test cases goes here + +// [#478]: add unit tests for non 3DS, wallets & webhooks in connector tests diff --git a/crates/router/tests/connectors/sample_auth.toml b/crates/router/tests/connectors/sample_auth.toml index 7d5a742aaf5..a7f18afcb78 100644 --- a/crates/router/tests/connectors/sample_auth.toml +++ b/crates/router/tests/connectors/sample_auth.toml @@ -341,10 +341,16 @@ api_key = "MyApiKey" key1 = "Merchant id" api_secret = "Secret key" + +[authipay] +api_key = "MyApiKey" +api_secret = "MySecretKey" + [checkbook] api_key="Client ID" key1 ="Client Secret" + [santander] api_key="Client ID" key1 ="Client Secret" @@ -354,4 +360,5 @@ api_key="Client ID" key1="Client Secret" [payload] -api_key="API Key" \ No newline at end of file +api_key="API Key" + diff --git a/crates/test_utils/src/connector_auth.rs b/crates/test_utils/src/connector_auth.rs index 25fffd09b0f..14e08be1623 100644 --- a/crates/test_utils/src/connector_auth.rs +++ b/crates/test_utils/src/connector_auth.rs @@ -19,6 +19,7 @@ pub struct ConnectorAuthentication { pub airwallex: Option<BodyKey>, pub amazonpay: Option<HeaderKey>, pub archipel: Option<NoKey>, + pub authipay: Option<SignatureKey>, pub authorizedotnet: Option<BodyKey>, pub bambora: Option<BodyKey>, pub bamboraapac: Option<HeaderKey>, diff --git a/loadtest/config/development.toml b/loadtest/config/development.toml index b1c7a7581c4..4711699bdf9 100644 --- a/loadtest/config/development.toml +++ b/loadtest/config/development.toml @@ -82,6 +82,7 @@ airwallex.base_url = "https://api-demo.airwallex.com/" amazonpay.base_url = "https://pay-api.amazon.com/v2" applepay.base_url = "https://apple-pay-gateway.apple.com/" archipel.base_url = "https://{{merchant_endpoint_prefix}}/ArchiPEL/Transaction/v1" +authipay.base_url = "https://prod.emea.api.fiservapps.com/sandbox/ipp/payments-gateway/v2/" authorizedotnet.base_url = "https://apitest.authorize.net/xml/v1/request.api" bambora.base_url = "https://api.na.bambora.com" bamboraapac.base_url = "https://demo.ippayments.com.au/interface/api" @@ -217,6 +218,7 @@ cards = [ "airwallex", "amazonpay", "archipel", + "authipay", "authorizedotnet", "bambora", "bamboraapac", diff --git a/scripts/add_connector.sh b/scripts/add_connector.sh index 90424011957..98490f12324 100755 --- a/scripts/add_connector.sh +++ b/scripts/add_connector.sh @@ -6,7 +6,7 @@ function find_prev_connector() { git checkout $self cp $self $self.tmp # Add new connector to existing list and sort it - connectors=(aci adyen adyenplatform airwallex amazonpay applepay archipel authorizedotnet bambora bamboraapac bankofamerica barclaycard billwerk bitpay bluesnap boku braintree cashtocode celero chargebee checkbook checkout coinbase cryptopay ctp_visa cybersource datatrans deutschebank digitalvirgo dlocal dummyconnector dwolla ebanx elavon facilitapay fiserv fiservemea fiuu forte getnet globalpay globepay gocardless gpayments helcim hipay hyperswitch_vault iatapay inespay itaubank jpmorgan juspaythreedsserver klarna mifinity mollie moneris multisafepay netcetera nexinets nexixpay nomupay noon nordea novalnet nuvei opayo opennode paybox payeezy payload payme payone paypal paystack payu placetopay plaid powertranz prophetpay rapyd razorpay recurly redsys santander shift4 silverflow square stax stripe stripebilling taxjar threedsecureio thunes tokenio trustpay tsys unified_authentication_service vgs volt wellsfargo wellsfargopayout wise worldline worldpay worldpayvantiv worldpayxml xendit zsl "$1") + connectors=(aci adyen adyenplatform airwallex amazonpay applepay archipel authipay authorizedotnet bambora bamboraapac bankofamerica barclaycard billwerk bitpay bluesnap boku braintree cashtocode celero chargebee checkbook checkout coinbase cryptopay ctp_visa cybersource datatrans deutschebank digitalvirgo dlocal dummyconnector dwolla ebanx elavon facilitapay fiserv fiservemea fiuu forte getnet globalpay globepay gocardless gpayments helcim hipay hyperswitch_vault iatapay inespay itaubank jpmorgan juspaythreedsserver klarna mifinity mollie moneris multisafepay netcetera nexinets nexixpay nomupay noon nordea novalnet nuvei opayo opennode paybox payeezy payload payme payone paypal paystack payu placetopay plaid powertranz prophetpay rapyd razorpay recurly redsys santander shift4 silverflow square stax stripe stripebilling taxjar threedsecureio thunes tokenio trustpay tsys unified_authentication_service vgs volt wellsfargo wellsfargopayout wise worldline worldpay worldpayvantiv worldpayxml xendit zsl "$1") IFS=$'\n' sorted=($(sort <<<"${connectors[]}")); unset IFS res="$(echo ${sorted[@]})"	2025-06-05T09:43:43Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description Cards Non-3DS payments added for authipay https://docs.fiserv.dev/public/reference/payments-intro ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> https://github.com/juspay/hyperswitch/issues/8398 ## How did you test it? Tested using cargo build and cypress test <img width="738" alt="Screenshot 2025-07-04 at 11 49 02 AM" src="https://github.com/user-attachments/assets/d4927935-5af6-4b14-88c4-dc1c9f723886" /> <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> ## Checklist <!-- Put an `x` in the boxes that apply --> - [`x`] I formatted the code `cargo +nightly fmt --all` - [`x`] I addressed lints thrown by `cargo clippy` - [`x`] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	c322eb9cabb2ca7a8ad0c3ed57192dde9bf7eaa4	c322eb9cabb2ca7a8ad0c3ed57192dde9bf7eaa4
juspay/hyperswitch	juspay__hyperswitch-8389	Bug: [FEATURE] Kv Redis feature for V2 models ### Feature Description Extend kv support for v2 models ### Possible Implementation Use existing construct to extend to v2 models ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? Yes, I am willing to submit a PR!	diff --git a/crates/diesel_models/src/kv.rs b/crates/diesel_models/src/kv.rs index 6c0666e5903..ed984649e92 100644 --- a/crates/diesel_models/src/kv.rs +++ b/crates/diesel_models/src/kv.rs @@ -126,12 +126,7 @@ impl DBOperation { )), #[cfg(feature = "v2")] Updateable::PaymentAttemptUpdate(a) => DBResult::PaymentAttempt(Box::new( - a.orig - .update_with_attempt_id( - conn, - PaymentAttemptUpdateInternal::from(a.update_data), - ) - .await?, + a.orig.update_with_attempt_id(conn, a.update_data).await?, )), #[cfg(feature = "v1")] Updateable::RefundUpdate(a) => { @@ -263,12 +258,20 @@ pub struct PaymentIntentUpdateMems { pub update_data: PaymentIntentUpdateInternal, } +#[cfg(feature = "v1")] #[derive(Debug, Serialize, Deserialize)] pub struct PaymentAttemptUpdateMems { pub orig: PaymentAttempt, pub update_data: PaymentAttemptUpdate, } +#[cfg(feature = "v2")] +#[derive(Debug, Serialize, Deserialize)] +pub struct PaymentAttemptUpdateMems { + pub orig: PaymentAttempt, + pub update_data: PaymentAttemptUpdateInternal, +} + #[derive(Debug, Serialize, Deserialize)] pub struct RefundUpdateMems { pub orig: Refund, diff --git a/crates/diesel_models/src/payment_attempt.rs b/crates/diesel_models/src/payment_attempt.rs index 95fb600adc4..0afea0574a7 100644 --- a/crates/diesel_models/src/payment_attempt.rs +++ b/crates/diesel_models/src/payment_attempt.rs @@ -833,7 +833,7 @@ pub enum PaymentAttemptUpdate { // TODO: uncomment fields as and when required #[cfg(feature = "v2")] -#[derive(Clone, Debug, AsChangeset, router_derive::DebugAsDisplay)] +#[derive(Clone, Debug, AsChangeset, router_derive::DebugAsDisplay, Serialize, Deserialize)] #[diesel(table_name = payment_attempt)] pub struct PaymentAttemptUpdateInternal { pub status: Option<storage_enums::AttemptStatus>, @@ -881,6 +881,112 @@ pub struct PaymentAttemptUpdateInternal { pub connector_request_reference_id: Option<String>, } +#[cfg(feature = "v2")] +impl PaymentAttemptUpdateInternal { + pub fn apply_changeset(self, source: PaymentAttempt) -> PaymentAttempt { + let Self { + status, + authentication_type, + error_message, + connector_payment_id, + modified_at, + browser_info, + error_code, + connector_metadata, + error_reason, + amount_capturable, + amount_to_capture, + updated_by, + merchant_connector_id, + connector, + redirection_data, + unified_code, + unified_message, + connector_token_details, + feature_metadata, + network_decline_code, + network_advice_code, + network_error_message, + payment_method_id, + connector_request_reference_id, + } = self; + + PaymentAttempt { + payment_id: source.payment_id, + merchant_id: source.merchant_id, + status: status.unwrap_or(source.status), + connector: connector.or(source.connector), + error_message: error_message.or(source.error_message), + surcharge_amount: source.surcharge_amount, + payment_method_id: payment_method_id.or(source.payment_method_id), + authentication_type: authentication_type.unwrap_or(source.authentication_type), + created_at: source.created_at, + modified_at: common_utils::date_time::now(), + last_synced: source.last_synced, + cancellation_reason: source.cancellation_reason, + amount_to_capture: amount_to_capture.or(source.amount_to_capture), + browser_info: browser_info + .and_then(\|val\| { + serde_json::from_value::<common_utils::types::BrowserInformation>(val).ok() + }) + .or(source.browser_info), + error_code: error_code.or(source.error_code), + payment_token: source.payment_token, + connector_metadata: connector_metadata.or(source.connector_metadata), + payment_experience: source.payment_experience, + payment_method_data: source.payment_method_data, + preprocessing_step_id: source.preprocessing_step_id, + error_reason: error_reason.or(source.error_reason), + multiple_capture_count: source.multiple_capture_count, + connector_response_reference_id: source.connector_response_reference_id, + amount_capturable: amount_capturable.unwrap_or(source.amount_capturable), + updated_by, + merchant_connector_id: merchant_connector_id.or(source.merchant_connector_id), + encoded_data: source.encoded_data, + unified_code: unified_code.flatten().or(source.unified_code), + unified_message: unified_message.flatten().or(source.unified_message), + net_amount: source.net_amount, + external_three_ds_authentication_attempted: source + .external_three_ds_authentication_attempted, + authentication_connector: source.authentication_connector, + authentication_id: source.authentication_id, + fingerprint_id: source.fingerprint_id, + client_source: source.client_source, + client_version: source.client_version, + customer_acceptance: source.customer_acceptance, + profile_id: source.profile_id, + organization_id: source.organization_id, + card_network: source.card_network, + shipping_cost: source.shipping_cost, + order_tax_amount: source.order_tax_amount, + request_extended_authorization: source.request_extended_authorization, + extended_authorization_applied: source.extended_authorization_applied, + capture_before: source.capture_before, + card_discovery: source.card_discovery, + charges: source.charges, + processor_merchant_id: source.processor_merchant_id, + created_by: source.created_by, + payment_method_type_v2: source.payment_method_type_v2, + connector_payment_id: source.connector_payment_id, + payment_method_subtype: source.payment_method_subtype, + routing_result: source.routing_result, + authentication_applied: source.authentication_applied, + external_reference_id: source.external_reference_id, + tax_on_surcharge: source.tax_on_surcharge, + payment_method_billing_address: source.payment_method_billing_address, + redirection_data: redirection_data.or(source.redirection_data), + connector_payment_data: source.connector_payment_data, + connector_token_details: connector_token_details.or(source.connector_token_details), + id: source.id, + feature_metadata: feature_metadata.or(source.feature_metadata), + network_advice_code: network_advice_code.or(source.network_advice_code), + network_decline_code: network_decline_code.or(source.network_decline_code), + network_error_message: network_error_message.or(source.network_error_message), + connector_request_reference_id: connector_request_reference_id + .or(source.connector_request_reference_id), + } + } +} #[cfg(feature = "v1")] #[derive(Clone, Debug, AsChangeset, router_derive::DebugAsDisplay)] #[diesel(table_name = payment_attempt)] diff --git a/crates/diesel_models/src/payment_intent.rs b/crates/diesel_models/src/payment_intent.rs index ea0a9cead20..bcaefa512db 100644 --- a/crates/diesel_models/src/payment_intent.rs +++ b/crates/diesel_models/src/payment_intent.rs @@ -632,6 +632,122 @@ pub struct PaymentIntentUpdateInternal { pub is_iframe_redirection_enabled: Option<bool>, } +#[cfg(feature = "v2")] +impl PaymentIntentUpdateInternal { + pub fn apply_changeset(self, source: PaymentIntent) -> PaymentIntent { + let Self { + status, + prerouting_algorithm, + amount_captured, + modified_at: _, // This will be ignored from self + active_attempt_id, + amount, + currency, + shipping_cost, + tax_details, + skip_external_tax_calculation, + surcharge_applicable, + surcharge_amount, + tax_on_surcharge, + routing_algorithm_id, + capture_method, + authentication_type, + billing_address, + shipping_address, + customer_present, + description, + return_url, + setup_future_usage, + apply_mit_exemption, + statement_descriptor, + order_details, + allowed_payment_method_types, + metadata, + connector_metadata, + feature_metadata, + payment_link_config, + request_incremental_authorization, + session_expiry, + frm_metadata, + request_external_three_ds_authentication, + updated_by, + force_3ds_challenge, + is_iframe_redirection_enabled, + } = self; + + PaymentIntent { + status: status.unwrap_or(source.status), + prerouting_algorithm: prerouting_algorithm.or(source.prerouting_algorithm), + amount_captured: amount_captured.or(source.amount_captured), + modified_at: common_utils::date_time::now(), + active_attempt_id: match active_attempt_id { + Some(v_option) => v_option, + None => source.active_attempt_id, + }, + amount: amount.unwrap_or(source.amount), + currency: currency.unwrap_or(source.currency), + shipping_cost: shipping_cost.or(source.shipping_cost), + tax_details: tax_details.or(source.tax_details), + skip_external_tax_calculation: skip_external_tax_calculation + .or(source.skip_external_tax_calculation), + surcharge_applicable: surcharge_applicable.or(source.surcharge_applicable), + surcharge_amount: surcharge_amount.or(source.surcharge_amount), + tax_on_surcharge: tax_on_surcharge.or(source.tax_on_surcharge), + routing_algorithm_id: routing_algorithm_id.or(source.routing_algorithm_id), + capture_method: capture_method.or(source.capture_method), + authentication_type: authentication_type.or(source.authentication_type), + billing_address: billing_address.or(source.billing_address), + shipping_address: shipping_address.or(source.shipping_address), + customer_present: customer_present.or(source.customer_present), + description: description.or(source.description), + return_url: return_url.or(source.return_url), + setup_future_usage: setup_future_usage.or(source.setup_future_usage), + apply_mit_exemption: apply_mit_exemption.or(source.apply_mit_exemption), + statement_descriptor: statement_descriptor.or(source.statement_descriptor), + order_details: order_details.or(source.order_details), + allowed_payment_method_types: allowed_payment_method_types + .or(source.allowed_payment_method_types), + metadata: metadata.or(source.metadata), + connector_metadata: connector_metadata.or(source.connector_metadata), + feature_metadata: feature_metadata.or(source.feature_metadata), + payment_link_config: payment_link_config.or(source.payment_link_config), + request_incremental_authorization: request_incremental_authorization + .or(source.request_incremental_authorization), + session_expiry: session_expiry.unwrap_or(source.session_expiry), + frm_metadata: frm_metadata.or(source.frm_metadata), + request_external_three_ds_authentication: request_external_three_ds_authentication + .or(source.request_external_three_ds_authentication), + updated_by, + force_3ds_challenge: force_3ds_challenge.or(source.force_3ds_challenge), + is_iframe_redirection_enabled: is_iframe_redirection_enabled + .or(source.is_iframe_redirection_enabled), + + // Fields from source + merchant_id: source.merchant_id, + customer_id: source.customer_id, + created_at: source.created_at, + last_synced: source.last_synced, + attempt_count: source.attempt_count, + profile_id: source.profile_id, + payment_link_id: source.payment_link_id, + authorization_count: source.authorization_count, + customer_details: source.customer_details, + organization_id: source.organization_id, + request_extended_authorization: source.request_extended_authorization, + psd2_sca_exemption_type: source.psd2_sca_exemption_type, + split_payments: source.split_payments, + platform_merchant_id: source.platform_merchant_id, + force_3ds_challenge_trigger: source.force_3ds_challenge_trigger, + processor_merchant_id: source.processor_merchant_id, + created_by: source.created_by, + merchant_reference_id: source.merchant_reference_id, + frm_merchant_decision: source.frm_merchant_decision, + enable_payment_link: source.enable_payment_link, + id: source.id, + } + } +} + #[cfg(feature = "v1")] #[derive(Clone, Debug, AsChangeset, router_derive::DebugAsDisplay)] #[diesel(table_name = payment_intent)] diff --git a/crates/drainer/Cargo.toml b/crates/drainer/Cargo.toml index 1a02f9f3d95..800622cf36a 100644 --- a/crates/drainer/Cargo.toml +++ b/crates/drainer/Cargo.toml @@ -11,6 +11,7 @@ license.workspace = true release = ["vergen", "external_services/aws_kms"] vergen = ["router_env/vergen"] v1 = ["diesel_models/v1", "hyperswitch_interfaces/v1", "common_utils/v1"] +v2 = ["diesel_models/v2", "hyperswitch_interfaces/v2", "common_utils/v2"] [dependencies] actix-web = "4.11.0" diff --git a/crates/hyperswitch_interfaces/Cargo.toml b/crates/hyperswitch_interfaces/Cargo.toml index 04cb644a1d7..6b216d5c86f 100644 --- a/crates/hyperswitch_interfaces/Cargo.toml +++ b/crates/hyperswitch_interfaces/Cargo.toml @@ -10,7 +10,7 @@ license.workspace = true default = ["dummy_connector", "frm", "payouts"] dummy_connector = [] v1 = ["hyperswitch_domain_models/v1", "api_models/v1", "common_utils/v1"] -v2 = [] +v2 = ["api_models/v2", "common_utils/v2", "hyperswitch_domain_models/v2"] payouts = ["hyperswitch_domain_models/payouts"] frm = ["hyperswitch_domain_models/frm"] revenue_recovery = [] diff --git a/crates/router/src/lib.rs b/crates/router/src/lib.rs index ed51b12ff00..6bcb17ad1a5 100644 --- a/crates/router/src/lib.rs +++ b/crates/router/src/lib.rs @@ -116,7 +116,7 @@ pub fn mk_app( > { let mut server_app = get_application_builder(request_body_limit, state.conf.cors.clone()); - #[cfg(all(feature = "dummy_connector", feature = "v1"))] + #[cfg(feature = "dummy_connector")] { use routes::DummyConnector; server_app = server_app.service(DummyConnector::server(state.clone())); diff --git a/crates/router/src/routes/admin.rs b/crates/router/src/routes/admin.rs index d3ffb715b73..20de3c492e7 100644 --- a/crates/router/src/routes/admin.rs +++ b/crates/router/src/routes/admin.rs @@ -915,6 +915,7 @@ pub async fn connector_delete( /// Merchant Account - Toggle KV /// /// Toggle KV mode for the Merchant Account +#[cfg(feature = "v1")] #[instrument(skip_all)] pub async fn merchant_account_toggle_kv( state: web::Data<AppState>, @@ -938,6 +939,29 @@ pub async fn merchant_account_toggle_kv( .await } +#[cfg(feature = "v2")] +#[instrument(skip_all)] +pub async fn merchant_account_toggle_kv( + state: web::Data<AppState>, + req: HttpRequest, + path: web::Path<common_utils::id_type::MerchantId>, + json_payload: web::Json<admin::ToggleKVRequest>, +) -> HttpResponse { + let flow = Flow::ConfigKeyUpdate; + let mut payload = json_payload.into_inner(); + payload.merchant_id = path.into_inner(); + + api::server_wrap( + flow, + state, + &req, + payload, + \|state, _, payload, _\| kv_for_merchant(state, payload.merchant_id, payload.kv_enabled), + &auth::V2AdminApiAuth, + api_locking::LockAction::NotApplicable, + ) + .await +} /// Merchant Account - Transfer Keys /// /// Transfer Merchant Encryption key to keymanager @@ -965,6 +989,7 @@ pub async fn merchant_account_toggle_all_kv( /// Merchant Account - KV Status /// /// Toggle KV mode for the Merchant Account +#[cfg(feature = "v1")] #[instrument(skip_all)] pub async fn merchant_account_kv_status( state: web::Data<AppState>, @@ -986,6 +1011,27 @@ pub async fn merchant_account_kv_status( .await } +#[cfg(feature = "v2")] +#[instrument(skip_all)] +pub async fn merchant_account_kv_status( + state: web::Data<AppState>, + req: HttpRequest, + path: web::Path<common_utils::id_type::MerchantId>, +) -> HttpResponse { + let flow = Flow::ConfigKeyFetch; + let merchant_id = path.into_inner(); + + api::server_wrap( + flow, + state, + &req, + merchant_id, + \|state, _, req, _\| check_merchant_account_kv_status(state, req), + &auth::V2AdminApiAuth, + api_locking::LockAction::NotApplicable, + ) + .await +} /// Merchant Account - KV Status /// /// Toggle KV mode for the Merchant Account diff --git a/crates/router/src/routes/app.rs b/crates/router/src/routes/app.rs index 8656d3f2890..cabcc8d1507 100644 --- a/crates/router/src/routes/app.rs +++ b/crates/router/src/routes/app.rs @@ -600,6 +600,22 @@ impl DummyConnector { } } +#[cfg(all(feature = "dummy_connector", feature = "v2"))] +impl DummyConnector { + pub fn server(state: AppState) -> Scope { + let mut routes_with_restricted_access = web::scope(""); + #[cfg(not(feature = "external_access_dc"))] + { + routes_with_restricted_access = + routes_with_restricted_access.guard(actix_web::guard::Host("localhost")); + } + routes_with_restricted_access = routes_with_restricted_access + .service(web::resource("/payment").route(web::post().to(dummy_connector_payment))); + web::scope("/dummy-connector") + .app_data(web::Data::new(state)) + .service(routes_with_restricted_access) + } +} pub struct Payments; #[cfg(all(any(feature = "olap", feature = "oltp"), feature = "v2"))] @@ -1556,6 +1572,11 @@ impl MerchantAccount { ) .service( web::resource("/profiles").route(web::get().to(profiles::profiles_list)), + ) + .service( + web::resource("/kv") + .route(web::post().to(admin::merchant_account_toggle_kv)) + .route(web::get().to(admin::merchant_account_kv_status)), ), ) } diff --git a/crates/router/src/routes/dummy_connector.rs b/crates/router/src/routes/dummy_connector.rs index 5d425c675a5..c0a7bc9f7fc 100644 --- a/crates/router/src/routes/dummy_connector.rs +++ b/crates/router/src/routes/dummy_connector.rs @@ -61,7 +61,7 @@ pub async fn dummy_connector_complete_payment( .await } -#[cfg(all(feature = "dummy_connector", feature = "v1"))] +#[cfg(feature = "dummy_connector")] #[instrument(skip_all, fields(flow = ?types::Flow::DummyPaymentCreate))] pub async fn dummy_connector_payment( state: web::Data<app::AppState>, @@ -82,7 +82,7 @@ pub async fn dummy_connector_payment( .await } -#[cfg(all(feature = "dummy_connector", feature = "v1"))] +#[cfg(feature = "dummy_connector")] #[instrument(skip_all, fields(flow = ?types::Flow::DummyPaymentRetrieve))] pub async fn dummy_connector_payment_data( state: web::Data<app::AppState>, diff --git a/crates/router/src/routes/dummy_connector/core.rs b/crates/router/src/routes/dummy_connector/core.rs index cafb6b58bca..0d7fb9627cc 100644 --- a/crates/router/src/routes/dummy_connector/core.rs +++ b/crates/router/src/routes/dummy_connector/core.rs @@ -9,7 +9,7 @@ use crate::{ utils::OptionExt, }; -#[cfg(all(feature = "dummy_connector", feature = "v1"))] +#[cfg(feature = "dummy_connector")] pub async fn payment( state: SessionState, req: types::DummyConnectorPaymentRequest, diff --git a/crates/storage_impl/src/customers.rs b/crates/storage_impl/src/customers.rs index bedbcadd6a8..53056a137c1 100644 --- a/crates/storage_impl/src/customers.rs +++ b/crates/storage_impl/src/customers.rs @@ -23,6 +23,32 @@ use crate::{ impl KvStorePartition for customers::Customer {} +#[cfg(feature = "v2")] +mod label { + use common_utils::id_type; + + pub(super) const MODEL_NAME: &str = "customer_v2"; + pub(super) const CLUSTER_LABEL: &str = "cust"; + + pub(super) fn get_global_id_label(global_customer_id: &id_type::GlobalCustomerId) -> String { + format!( + "customer_global_id_{}", + global_customer_id.get_string_repr() + ) + } + + pub(super) fn get_merchant_scoped_id_label( + merchant_id: &id_type::MerchantId, + merchant_reference_id: &id_type::CustomerId, + ) -> String { + format!( + "customer_mid_{}_mrefid_{}", + merchant_id.get_string_repr(), + merchant_reference_id.get_string_repr() + ) + } +} + #[async_trait::async_trait] impl<T: DatabaseStore> domain::CustomerInterface for kv_router_store::KVRouterStore<T> { type Error = StorageError; @@ -283,22 +309,32 @@ impl<T: DatabaseStore> domain::CustomerInterface for kv_router_store::KVRouterSt .construct_new() .await .change_context(StorageError::EncryptionError)?; - let storage_scheme = Box::pin(decide_storage_scheme::<_, customers::Customer>( + + let decided_storage_scheme = Box::pin(decide_storage_scheme::<_, customers::Customer>( self, storage_scheme, Op::Insert, )) .await; - new_customer.update_storage_scheme(storage_scheme); + new_customer.update_storage_scheme(decided_storage_scheme); + + let mut reverse_lookups = Vec::new(); + + if let Some(ref merchant_ref_id) = new_customer.merchant_reference_id { + let reverse_lookup_merchant_scoped_id = + label::get_merchant_scoped_id_label(&new_customer.merchant_id, merchant_ref_id); + reverse_lookups.push(reverse_lookup_merchant_scoped_id); + } + self.insert_resource( state, key_store, - storage_scheme, + decided_storage_scheme, new_customer.clone().insert(&conn), new_customer.clone().into(), kv_router_store::InsertResourceParams { insertable: kv::Insertable::Customer(new_customer.clone()), - reverse_lookups: vec![], + reverse_lookups, identifier, key, resource_type: "customer", diff --git a/crates/storage_impl/src/lib.rs b/crates/storage_impl/src/lib.rs index 814314f4351..156ebee2dea 100644 --- a/crates/storage_impl/src/lib.rs +++ b/crates/storage_impl/src/lib.rs @@ -378,6 +378,16 @@ impl UniqueConstraints for diesel_models::PaymentAttempt { } } +#[cfg(feature = "v2")] +impl UniqueConstraints for diesel_models::PaymentAttempt { + fn unique_constraints(&self) -> Vec<String> { + vec![format!("pa_{}", self.id.get_string_repr())] + } + fn table_name(&self) -> &str { + "PaymentAttempt" + } +} + #[cfg(feature = "v1")] impl UniqueConstraints for diesel_models::Refund { fn unique_constraints(&self) -> Vec<String> { diff --git a/crates/storage_impl/src/payments/payment_attempt.rs b/crates/storage_impl/src/payments/payment_attempt.rs index 8eb8222afbf..78531b78ad6 100644 --- a/crates/storage_impl/src/payments/payment_attempt.rs +++ b/crates/storage_impl/src/payments/payment_attempt.rs @@ -6,16 +6,17 @@ use common_utils::{ fallback_reverse_lookup_not_found, types::{ConnectorTransactionId, ConnectorTransactionIdTrait, CreatedBy}, }; +#[cfg(feature = "v1")] +use diesel_models::payment_attempt::PaymentAttemptNew as DieselPaymentAttemptNew; use diesel_models::{ enums::{ MandateAmountData as DieselMandateAmountData, MandateDataType as DieselMandateType, MandateDetails as DieselMandateDetails, MerchantStorageScheme, }, + kv, payment_attempt::PaymentAttempt as DieselPaymentAttempt, reverse_lookup::{ReverseLookup, ReverseLookupNew}, }; -#[cfg(feature = "v1")] -use diesel_models::{kv, payment_attempt::PaymentAttemptNew as DieselPaymentAttemptNew}; use error_stack::ResultExt; #[cfg(feature = "v1")] use hyperswitch_domain_models::payments::payment_attempt::PaymentAttemptNew; @@ -32,22 +33,21 @@ use hyperswitch_domain_models::{ use hyperswitch_domain_models::{ payments::payment_attempt::PaymentListFilters, payments::PaymentIntent, }; -#[cfg(feature = "v1")] +#[cfg(feature = "v2")] +use label::; use redis_interface::HsetnxReply; use router_env::{instrument, tracing}; +#[cfg(feature = "v2")] +use crate::kv_router_store::{FilterResourceParams, FindResourceBy, UpdateResourceParams}; use crate::{ diesel_error_to_data_error, errors, + errors::RedisErrorExt, kv_router_store::KVRouterStore, lookup::ReverseLookupInterface, - utils::{pg_connection_read, pg_connection_write}, - DataModelExt, DatabaseStore, RouterStore, -}; -#[cfg(feature = "v1")] -use crate::{ - errors::RedisErrorExt, redis::kv_store::{decide_storage_scheme, kv_wrapper, KvOperation, Op, PartitionKey}, - utils::try_redis_get_else_try_database_get, + utils::{pg_connection_read, pg_connection_write, try_redis_get_else_try_database_get}, + DataModelExt, DatabaseStore, RouterStore, }; #[async_trait::async_trait] @@ -747,15 +747,98 @@ impl<T: DatabaseStore> PaymentAttemptInterface for KVRouterStore<T> { payment_attempt: PaymentAttempt, storage_scheme: MerchantStorageScheme, ) -> error_stack::Result<PaymentAttempt, errors::StorageError> { - // Ignoring storage scheme for v2 implementation - self.router_store - .insert_payment_attempt( - key_manager_state, - merchant_key_store, - payment_attempt, - storage_scheme, - ) - .await + let decided_storage_scheme = Box::pin(decide_storage_scheme::<_, DieselPaymentAttempt>( + self, + storage_scheme, + Op::Insert, + )) + .await; + + match decided_storage_scheme { + MerchantStorageScheme::PostgresOnly => { + self.router_store + .insert_payment_attempt( + key_manager_state, + merchant_key_store, + payment_attempt, + decided_storage_scheme, + ) + .await + } + MerchantStorageScheme::RedisKv => { + let key = PartitionKey::GlobalPaymentId { + id: &payment_attempt.payment_id, + }; + let key_str = key.to_string(); + let field = format!( + "{}_{}", + label::CLUSTER_LABEL, + payment_attempt.id.get_string_repr() + ); + + let diesel_payment_attempt_new = payment_attempt + .clone() + .construct_new() + .await + .change_context(errors::StorageError::EncryptionError)?; + + let diesel_payment_attempt_for_redis: DieselPaymentAttempt = + Conversion::convert(payment_attempt.clone()) + .await + .change_context(errors::StorageError::EncryptionError)?; + + let redis_entry = kv::TypedSql { + op: kv::DBOperation::Insert { + insertable: Box::new(kv::Insertable::PaymentAttempt(Box::new( + diesel_payment_attempt_new.clone(), + ))), + }, + }; + + let reverse_lookup_attempt_id = ReverseLookupNew { + lookup_id: label::get_global_id_label(&payment_attempt.id), + pk_id: key_str.clone(), + sk_id: field.clone(), + source: "payment_attempt".to_string(), + updated_by: decided_storage_scheme.to_string(), + }; + self.insert_reverse_lookup(reverse_lookup_attempt_id, decided_storage_scheme) + .await?; + + if let Some(ref conn_txn_id_val) = payment_attempt.connector_payment_id { + let reverse_lookup_conn_txn_id = ReverseLookupNew { + lookup_id: label::get_profile_id_connector_transaction_label( + payment_attempt.profile_id.get_string_repr(), + conn_txn_id_val, + ), + pk_id: key_str.clone(), + sk_id: field.clone(), + source: "payment_attempt".to_string(), + updated_by: decided_storage_scheme.to_string(), + }; + self.insert_reverse_lookup(reverse_lookup_conn_txn_id, decided_storage_scheme) + .await?; + } + + match Box::pin(kv_wrapper::<DieselPaymentAttempt, _, _>( + self, + KvOperation::HSetNx(&field, &diesel_payment_attempt_for_redis, redis_entry), + key, + )) + .await + .map_err(\|err\| err.to_redis_failed_response(&key_str))? + .try_into_hsetnx() + { + Ok(HsetnxReply::KeyNotSet) => Err(errors::StorageError::DuplicateValue { + entity: "payment_attempt", + key: Some(payment_attempt.id.get_string_repr().to_owned()), + } + .into()), + Ok(HsetnxReply::KeySet) => Ok(payment_attempt), + Err(error) => Err(error.change_context(errors::StorageError::KVError)), + } + } + } } #[cfg(feature = "v1")] @@ -889,19 +972,48 @@ impl<T: DatabaseStore> PaymentAttemptInterface for KVRouterStore<T> { key_manager_state: &KeyManagerState, merchant_key_store: &MerchantKeyStore, this: PaymentAttempt, - payment_attempt: PaymentAttemptUpdate, + payment_attempt_update: PaymentAttemptUpdate, storage_scheme: MerchantStorageScheme, ) -> error_stack::Result<PaymentAttempt, errors::StorageError> { - // Ignoring storage scheme for v2 implementation - self.router_store - .update_payment_attempt( - key_manager_state, - merchant_key_store, - this, - payment_attempt, - storage_scheme, - ) + let payment_attempt = Conversion::convert(this.clone()) .await + .change_context(errors::StorageError::DecryptionError)?; + + let key = PartitionKey::GlobalPaymentId { + id: &this.payment_id, + }; + + let field = format!("{}_{}", label::CLUSTER_LABEL, this.id.get_string_repr()); + let conn = pg_connection_write(self).await?; + + let payment_attempt_internal = + diesel_models::PaymentAttemptUpdateInternal::from(payment_attempt_update); + let updated_payment_attempt = payment_attempt_internal + .clone() + .apply_changeset(payment_attempt.clone()); + + let updated_by = updated_payment_attempt.updated_by.to_owned(); + let updated_payment_attempt_with_id = payment_attempt + .clone() + .update_with_attempt_id(&conn, payment_attempt_internal.clone()); + + Box::pin(self.update_resource( + key_manager_state, + merchant_key_store, + storage_scheme, + updated_payment_attempt_with_id, + updated_payment_attempt, + UpdateResourceParams { + updateable: kv::Updateable::PaymentAttemptUpdate(Box::new( + kv::PaymentAttemptUpdateMems { + orig: payment_attempt, + update_data: payment_attempt_internal, + }, + )), + operation: Op::Update(key.clone(), &field, Some(updated_by.as_str())), + }, + )) + .await } #[cfg(feature = "v1")] @@ -1095,15 +1207,69 @@ impl<T: DatabaseStore> PaymentAttemptInterface for KVRouterStore<T> { payment_id: &common_utils::id_type::GlobalPaymentId, storage_scheme: MerchantStorageScheme, ) -> error_stack::Result<PaymentAttempt, errors::StorageError> { - // Ignoring storage scheme for v2 implementation - self.router_store - .find_payment_attempt_last_successful_or_partially_captured_attempt_by_payment_id( - key_manager_state, - merchant_key_store, - payment_id, - storage_scheme, - ) - .await + let database_call = \|\| { + self.router_store + .find_payment_attempt_last_successful_or_partially_captured_attempt_by_payment_id( + key_manager_state, + merchant_key_store, + payment_id, + storage_scheme, + ) + }; + + let decided_storage_scheme = Box::pin(decide_storage_scheme::<_, DieselPaymentAttempt>( + self, + storage_scheme, + Op::Find, + )) + .await; + + match decided_storage_scheme { + MerchantStorageScheme::PostgresOnly => database_call().await, + MerchantStorageScheme::RedisKv => { + let key = PartitionKey::GlobalPaymentId { id: payment_id }; + + let redis_fut = async { + let kv_result = kv_wrapper::<DieselPaymentAttempt, _, _>( + self, + KvOperation::<DieselPaymentAttempt>::Scan("pa_"), + key.clone(), + ) + .await? + .try_into_scan(); + + let payment_attempt = kv_result.and_then(\|mut payment_attempts\| { + payment_attempts.sort_by(\|a, b\| b.modified_at.cmp(&a.modified_at)); + payment_attempts + .iter() + .find(\|&pa\| { + pa.status == diesel_models::enums::AttemptStatus::Charged + \|\| pa.status + == diesel_models::enums::AttemptStatus::PartialCharged + }) + .cloned() + .ok_or(error_stack::report!( + redis_interface::errors::RedisError::NotFound + )) + })?; + let merchant_id = payment_attempt.merchant_id.clone(); + PaymentAttempt::convert_back( + key_manager_state, + payment_attempt, + merchant_key_store.key.get_inner(), + merchant_id.into(), + ) + .await + .change_context(redis_interface::errors::RedisError::UnknownResult) + }; + + Box::pin(try_redis_get_else_try_database_get( + redis_fut, + database_call, + )) + .await + } + } } #[cfg(feature = "v2")] @@ -1115,16 +1281,22 @@ impl<T: DatabaseStore> PaymentAttemptInterface for KVRouterStore<T> { connector_transaction_id: &str, storage_scheme: MerchantStorageScheme, ) -> CustomResult<PaymentAttempt, errors::StorageError> { - // Ignoring storage scheme for v2 implementation - self.router_store - .find_payment_attempt_by_profile_id_connector_transaction_id( - key_manager_state, - merchant_key_store, + let conn = pg_connection_read(self).await?; + self.find_resource_by_id( + key_manager_state, + merchant_key_store, + storage_scheme, + DieselPaymentAttempt::find_by_profile_id_connector_transaction_id( + &conn, profile_id, connector_transaction_id, - storage_scheme, - ) - .await + ), + FindResourceBy::LookupId(label::get_profile_id_connector_transaction_label( + profile_id.get_string_repr(), + connector_transaction_id, + )), + ) + .await } #[instrument(skip_all)] @@ -1329,15 +1501,15 @@ impl<T: DatabaseStore> PaymentAttemptInterface for KVRouterStore<T> { attempt_id: &common_utils::id_type::GlobalAttemptId, storage_scheme: MerchantStorageScheme, ) -> error_stack::Result<PaymentAttempt, errors::StorageError> { - // Ignoring storage scheme for v2 implementation - self.router_store - .find_payment_attempt_by_id( - key_manager_state, - merchant_key_store, - attempt_id, - storage_scheme, - ) - .await + let conn = pg_connection_read(self).await?; + self.find_resource_by_id( + key_manager_state, + merchant_key_store, + storage_scheme, + DieselPaymentAttempt::find_by_id(&conn, attempt_id), + FindResourceBy::LookupId(label::get_global_id_label(attempt_id)), + ) + .await } #[cfg(feature = "v2")] @@ -1349,14 +1521,20 @@ impl<T: DatabaseStore> PaymentAttemptInterface for KVRouterStore<T> { merchant_key_store: &MerchantKeyStore, storage_scheme: MerchantStorageScheme, ) -> error_stack::Result<Vec<PaymentAttempt>, errors::StorageError> { - self.router_store - .find_payment_attempts_by_payment_intent_id( - key_manager_state, - payment_id, - merchant_key_store, - storage_scheme, - ) - .await + let conn = pg_connection_read(self).await?; + self.filter_resources( + key_manager_state, + merchant_key_store, + storage_scheme, + DieselPaymentAttempt::find_by_payment_id(&conn, payment_id), + \|_\| true, + FilterResourceParams { + key: PartitionKey::GlobalPaymentId { id: payment_id }, + pattern: "pa_", + limit: None, + }, + ) + .await } #[cfg(feature = "v1")] @@ -2036,3 +2214,25 @@ async fn add_preprocessing_id_to_reverse_lookup<T: DatabaseStore>( .insert_reverse_lookup(reverse_lookup_new, storage_scheme) .await } + +#[cfg(feature = "v2")] +mod label { + pub(super) const MODEL_NAME: &str = "payment_attempt_v2"; + pub(super) const CLUSTER_LABEL: &str = "pa"; + + pub(super) fn get_profile_id_connector_transaction_label( + profile_id: &str, + connector_transaction_id: &str, + ) -> String { + format!( + "profile_{}_conn_txn_{}", + profile_id, connector_transaction_id + ) + } + + pub(super) fn get_global_id_label( + attempt_id: &common_utils::id_type::GlobalAttemptId, + ) -> String { + format!("attempt_global_id_{}", attempt_id.get_string_repr()) + } +} diff --git a/crates/storage_impl/src/payments/payment_intent.rs b/crates/storage_impl/src/payments/payment_intent.rs index 17156855e13..d054a4b1650 100644 --- a/crates/storage_impl/src/payments/payment_intent.rs +++ b/crates/storage_impl/src/payments/payment_intent.rs @@ -2,13 +2,22 @@ use api_models::payments::{AmountFilter, Order, SortBy, SortOn}; #[cfg(feature = "olap")] use async_bb8_diesel::{AsyncConnection, AsyncRunQueryDsl}; -#[cfg(feature = "v1")] -use common_utils::ext_traits::Encode; -use common_utils::{ext_traits::AsyncExt, types::keymanager::KeyManagerState}; +#[cfg(feature = "v2")] +use common_utils::fallback_reverse_lookup_not_found; +use common_utils::{ + ext_traits::{AsyncExt, Encode}, + types::keymanager::KeyManagerState, +}; #[cfg(feature = "olap")] use diesel::{associations::HasTable, ExpressionMethods, JoinOnDsl, QueryDsl}; +#[cfg(feature = "v1")] +use diesel_models::payment_intent::PaymentIntentUpdate as DieselPaymentIntentUpdate; +#[cfg(feature = "v2")] +use diesel_models::payment_intent::PaymentIntentUpdateInternal; #[cfg(feature = "olap")] use diesel_models::query::generics::db_metrics; +#[cfg(feature = "v2")] +use diesel_models::reverse_lookup::ReverseLookupNew; #[cfg(all(feature = "v1", feature = "olap"))] use diesel_models::schema::{ payment_attempt::{self as payment_attempt_schema, dsl as pa_dsl}, @@ -20,10 +29,8 @@ use diesel_models::schema_v2::{ payment_intent::dsl as pi_dsl, }; use diesel_models::{ - enums::MerchantStorageScheme, payment_intent::PaymentIntent as DieselPaymentIntent, + enums::MerchantStorageScheme, kv, payment_intent::PaymentIntent as DieselPaymentIntent, }; -#[cfg(feature = "v1")] -use diesel_models::{kv, payment_intent::PaymentIntentUpdate as DieselPaymentIntentUpdate}; use error_stack::ResultExt; #[cfg(feature = "olap")] use hyperswitch_domain_models::payments::{ @@ -37,7 +44,6 @@ use hyperswitch_domain_models::{ PaymentIntent, }, }; -#[cfg(feature = "v1")] use redis_interface::HsetnxReply; #[cfg(feature = "olap")] use router_env::logger; @@ -47,17 +53,14 @@ use router_env::{instrument, tracing}; use crate::connection; use crate::{ diesel_error_to_data_error, - errors::StorageError, + errors::{RedisErrorExt, StorageError}, kv_router_store::KVRouterStore, - utils::{pg_connection_read, pg_connection_write}, - DatabaseStore, -}; -#[cfg(feature = "v1")] -use crate::{ - errors::RedisErrorExt, redis::kv_store::{decide_storage_scheme, kv_wrapper, KvOperation, Op, PartitionKey}, - utils, + utils::{self, pg_connection_read, pg_connection_write}, + DatabaseStore, }; +#[cfg(feature = "v2")] +use crate::{errors, lookup::ReverseLookupInterface}; #[async_trait::async_trait] impl<T: DatabaseStore> PaymentIntentInterface for KVRouterStore<T> { @@ -163,7 +166,68 @@ impl<T: DatabaseStore> PaymentIntentInterface for KVRouterStore<T> { } MerchantStorageScheme::RedisKv => { - todo!("Implement payment intent insert for kv") + let id = payment_intent.id.clone(); + let key = PartitionKey::GlobalPaymentId { id: &id }; + let field = format!("pi_{}", id.get_string_repr()); + let key_str = key.to_string(); + + let new_payment_intent = payment_intent + .clone() + .construct_new() + .await + .change_context(StorageError::EncryptionError)?; + + let redis_entry = kv::TypedSql { + op: kv::DBOperation::Insert { + insertable: Box::new(kv::Insertable::PaymentIntent(Box::new( + new_payment_intent, + ))), + }, + }; + + let diesel_payment_intent = payment_intent + .clone() + .convert() + .await + .change_context(StorageError::EncryptionError)?; + + if let Some(merchant_reference_id) = &payment_intent.merchant_reference_id { + let reverse_lookup = ReverseLookupNew { + lookup_id: format!( + "pi_merchant_reference_{}_{}", + payment_intent.profile_id.get_string_repr(), + merchant_reference_id.get_string_repr() + ), + pk_id: key_str.clone(), + sk_id: field.clone(), + source: "payment_intent".to_string(), + updated_by: storage_scheme.to_string(), + }; + self.insert_reverse_lookup(reverse_lookup, storage_scheme) + .await?; + } + + match Box::pin(kv_wrapper::<DieselPaymentIntent, _, _>( + self, + KvOperation::<DieselPaymentIntent>::HSetNx( + &field, + &diesel_payment_intent, + redis_entry, + ), + key, + )) + .await + .map_err(\|err\| err.to_redis_failed_response(&key_str))? + .try_into_hsetnx() + { + Ok(HsetnxReply::KeyNotSet) => Err(StorageError::DuplicateValue { + entity: "payment_intent", + key: Some(key_str), + } + .into()), + Ok(HsetnxReply::KeySet) => Ok(payment_intent), + Err(error) => Err(error.change_context(StorageError::KVError)), + } } } } @@ -300,7 +364,59 @@ impl<T: DatabaseStore> PaymentIntentInterface for KVRouterStore<T> { .await } MerchantStorageScheme::RedisKv => { - todo!() + let id = this.id.clone(); + let merchant_id = this.merchant_id.clone(); + let key = PartitionKey::GlobalPaymentId { id: &id }; + let field = format!("pi_{}", id.get_string_repr()); + let key_str = key.to_string(); + + let diesel_intent_update = + PaymentIntentUpdateInternal::try_from(payment_intent_update) + .change_context(StorageError::DeserializationFailed)?; + let origin_diesel_intent = this + .convert() + .await + .change_context(StorageError::EncryptionError)?; + + let diesel_intent = diesel_intent_update + .clone() + .apply_changeset(origin_diesel_intent.clone()); + + let redis_value = diesel_intent + .encode_to_string_of_json() + .change_context(StorageError::SerializationFailed)?; + + let redis_entry = kv::TypedSql { + op: kv::DBOperation::Update { + updatable: Box::new(kv::Updateable::PaymentIntentUpdate(Box::new( + kv::PaymentIntentUpdateMems { + orig: origin_diesel_intent, + update_data: diesel_intent_update, + }, + ))), + }, + }; + + Box::pin(kv_wrapper::<(), _, _>( + self, + KvOperation::<DieselPaymentIntent>::Hset((&field, redis_value), redis_entry), + key, + )) + .await + .map_err(\|err\| err.to_redis_failed_response(&key_str))? + .try_into_hset() + .change_context(StorageError::KVError)?; + + let payment_intent = PaymentIntent::convert_back( + state, + diesel_intent, + merchant_key_store.key.get_inner(), + merchant_id.into(), + ) + .await + .change_context(StorageError::DecryptionError)?; + + Ok(payment_intent) } } } @@ -372,18 +488,50 @@ impl<T: DatabaseStore> PaymentIntentInterface for KVRouterStore<T> { state: &KeyManagerState, id: &common_utils::id_type::GlobalPaymentId, merchant_key_store: &MerchantKeyStore, - _storage_scheme: MerchantStorageScheme, + storage_scheme: MerchantStorageScheme, ) -> error_stack::Result<PaymentIntent, StorageError> { - let conn: bb8::PooledConnection< - '_, - async_bb8_diesel::ConnectionManager<diesel::PgConnection>, - > = pg_connection_read(self).await?; - let diesel_payment_intent = DieselPaymentIntent::find_by_global_id(&conn, id) - .await - .map_err(\|er\| { - let new_err = diesel_error_to_data_error(er.current_context()); - er.change_context(new_err) - })?; + let storage_scheme = Box::pin(decide_storage_scheme::<_, DieselPaymentIntent>( + self, + storage_scheme, + Op::Find, + )) + .await; + + let database_call = \|\| async { + let conn: bb8::PooledConnection< + '_, + async_bb8_diesel::ConnectionManager<diesel::PgConnection>, + > = pg_connection_read(self).await?; + + DieselPaymentIntent::find_by_global_id(&conn, id) + .await + .map_err(\|er\| { + let new_err = diesel_error_to_data_error(er.current_context()); + er.change_context(new_err) + }) + }; + + let diesel_payment_intent = match storage_scheme { + MerchantStorageScheme::PostgresOnly => database_call().await, + MerchantStorageScheme::RedisKv => { + let key = PartitionKey::GlobalPaymentId { id }; + let field = format!("pi_{}", id.get_string_repr()); + + Box::pin(utils::try_redis_get_else_try_database_get( + async { + Box::pin(kv_wrapper::<DieselPaymentIntent, _, _>( + self, + KvOperation::<DieselPaymentIntent>::HGet(&field), + key, + )) + .await? + .try_into_hget() + }, + database_call, + )) + .await + } + }?; let merchant_id = diesel_payment_intent.merchant_id.clone(); @@ -391,7 +539,7 @@ impl<T: DatabaseStore> PaymentIntentInterface for KVRouterStore<T> { state, diesel_payment_intent, merchant_key_store.key.get_inner(), - merchant_id.to_owned().into(), + merchant_id.into(), ) .await .change_context(StorageError::DecryptionError) @@ -523,7 +671,68 @@ impl<T: DatabaseStore> PaymentIntentInterface for KVRouterStore<T> { .await } MerchantStorageScheme::RedisKv => { - todo!() + let lookup_id = format!( + "pi_merchant_reference_{}_{}", + profile_id.get_string_repr(), + merchant_reference_id.get_string_repr() + ); + + let lookup = fallback_reverse_lookup_not_found!( + self.get_lookup_by_lookup_id(&lookup_id, storage_scheme) + .await, + self.router_store + .find_payment_intent_by_merchant_reference_id_profile_id( + state, + merchant_reference_id, + profile_id, + merchant_key_store, + storage_scheme, + ) + .await + ); + + let key = PartitionKey::CombinationKey { + combination: &lookup.pk_id, + }; + + let database_call = \|\| async { + let conn = pg_connection_read(self).await?; + DieselPaymentIntent::find_by_merchant_reference_id_profile_id( + &conn, + merchant_reference_id, + profile_id, + ) + .await + .map_err(\|er\| { + let new_err = diesel_error_to_data_error(*er.current_context()); + er.change_context(new_err) + }) + }; + + let diesel_payment_intent = Box::pin(utils::try_redis_get_else_try_database_get( + async { + Box::pin(kv_wrapper::<DieselPaymentIntent, _, _>( + self, + KvOperation::<DieselPaymentIntent>::HGet(&lookup.sk_id), + key, + )) + .await? + .try_into_hget() + }, + database_call, + )) + .await?; + + let merchant_id = diesel_payment_intent.merchant_id.clone(); + + PaymentIntent::convert_back( + state, + diesel_payment_intent, + merchant_key_store.key.get_inner(), + merchant_id.into(), + ) + .await + .change_context(StorageError::DecryptionError) } } } @@ -607,9 +816,8 @@ impl<T: DatabaseStore> PaymentIntentInterface for crate::RouterStore<T> { _storage_scheme: MerchantStorageScheme, ) -> error_stack::Result<PaymentIntent, StorageError> { let conn = pg_connection_write(self).await?; - let diesel_payment_intent_update = - diesel_models::PaymentIntentUpdateInternal::try_from(payment_intent) - .change_context(StorageError::DeserializationFailed)?; + let diesel_payment_intent_update = PaymentIntentUpdateInternal::try_from(payment_intent) + .change_context(StorageError::DeserializationFailed)?; let diesel_payment_intent = this .convert() .await diff --git a/crates/storage_impl/src/redis/kv_store.rs b/crates/storage_impl/src/redis/kv_store.rs index f09506bc76b..fd583f500ed 100644 --- a/crates/storage_impl/src/redis/kv_store.rs +++ b/crates/storage_impl/src/redis/kv_store.rs @@ -55,6 +55,10 @@ pub enum PartitionKey<'a> { GlobalId { id: &'a str, }, + #[cfg(feature = "v2")] + GlobalPaymentId { + id: &'a common_utils::id_type::GlobalPaymentId, + }, } // PartitionKey::MerchantIdPaymentId {merchant_id, payment_id} impl std::fmt::Display for PartitionKey<'_> { @@ -108,7 +112,11 @@ impl std::fmt::Display for PartitionKey<'_> { )), #[cfg(feature = "v2")] - PartitionKey::GlobalId { id } => f.write_str(&format!("cust_{id}",)), + PartitionKey::GlobalId { id } => f.write_str(&format!("global_cust_{id}",)), + #[cfg(feature = "v2")] + PartitionKey::GlobalPaymentId { id } => { + f.write_str(&format!("global_payment_{}", id.get_string_repr())) + } } } }	2025-06-02T04:50:28Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [ ] New feature - [x] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description #8389 - Added Kv Redis support to - payment_intent V2, payment_attempt V2 models - Added enable Kv route for v2 merchant-account added enable kv api for v2 merchant account ` curl --location 'https://<host>/v2/merchant-accounts/:mid/kv' \ --header 'Authorization: admin-api-key=*' \ --header 'x-organization-id:*' \ --header 'Content-Type: application/json' \ --data '{"kv_enabled" : true}' ` ### Additional Changes - [x] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> Locally tested kv writes and drainer functionality ## Checklist <!-- Put an `x` in the boxes that apply --> - [ ] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.114.0	c5c0e677f2a2d43170a66330c98e0ebc4d771717	c5c0e677f2a2d43170a66330c98e0ebc4d771717
juspay/hyperswitch	juspay__hyperswitch-8392	Bug: [FEATURE] allow payout_id to be configurable ### Feature Description `payout_id` is an unique identifier for payout resource which is auto generated during payout creation. This field needs to be configurable during payout creation by accepting in the API. Along with this, a `merchant_order_reference_id` needs to be added which is an unique identifier for the consumer of the API. ### Possible Implementation Below changes are needed in payout flow across different components - - Add `payout_id` to API models - Add `PayoutId` domain type - Add `merchant_order_reference_id` to API and diesel models - Add DB queries for fetching orders using `merchant_order_reference_id` - Add `merchant_order_reference_id` as a filter for OLAP APIs - Use uuidv4 for payout ID creation for Wise ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? None	diff --git a/api-reference/v1/openapi_spec_v1.json b/api-reference/v1/openapi_spec_v1.json index fe57a935d16..85223163b29 100644 --- a/api-reference/v1/openapi_spec_v1.json +++ b/api-reference/v1/openapi_spec_v1.json @@ -24303,6 +24303,13 @@ "client_secret" ], "properties": { + "merchant_order_reference_id": { + "type": "string", + "description": "Your unique identifier for this payout or order. This ID helps you reconcile payouts on your system. If provided, it is passed to the connector if supported.", + "example": "merchant_order_ref_123", + "nullable": true, + "maxLength": 255 + }, "amount": { "type": "integer", "format": "int64", @@ -24609,6 +24616,13 @@ "example": "merchant_1668273825", "maxLength": 255 }, + "merchant_order_reference_id": { + "type": "string", + "description": "Your unique identifier for this payout or order. This ID helps you reconcile payouts on your system. If provided, it is passed to the connector if supported.", + "example": "merchant_order_ref_123", + "nullable": true, + "maxLength": 255 + }, "amount": { "type": "integer", "format": "int64", @@ -24902,13 +24916,13 @@ "starting_after": { "type": "string", "description": "A cursor for use in pagination, fetch the next list after some object", - "example": "pay_fafa124123", + "example": "payout_fafa124123", "nullable": true }, "ending_before": { "type": "string", "description": "A cursor for use in pagination, fetch the previous list before some object", - "example": "pay_fafa124123", + "example": "payout_fafa124123", "nullable": true }, "limit": { @@ -24955,6 +24969,13 @@ "maxLength": 30, "minLength": 30 }, + "merchant_order_reference_id": { + "type": "string", + "description": "The merchant order reference ID for payout", + "example": "merchant_order_ref_123", + "nullable": true, + "maxLength": 255 + }, "profile_id": { "type": "string", "description": "The identifier for business profile", @@ -25249,6 +25270,13 @@ "PayoutUpdateRequest": { "type": "object", "properties": { + "merchant_order_reference_id": { + "type": "string", + "description": "Your unique identifier for this payout or order. This ID helps you reconcile payouts on your system. If provided, it is passed to the connector if supported.", + "example": "merchant_order_ref_123", + "nullable": true, + "maxLength": 255 + }, "amount": { "type": "integer", "format": "int64", @@ -25479,6 +25507,13 @@ "currency" ], "properties": { + "merchant_order_reference_id": { + "type": "string", + "description": "Your unique identifier for this payout or order. This ID helps you reconcile payouts on your system. If provided, it is passed to the connector if supported.", + "example": "merchant_order_ref_123", + "nullable": true, + "maxLength": 255 + }, "amount": { "type": "integer", "format": "int64", diff --git a/api-reference/v2/openapi_spec_v2.json b/api-reference/v2/openapi_spec_v2.json index 5ceb5f032f5..0bd642c8be8 100644 --- a/api-reference/v2/openapi_spec_v2.json +++ b/api-reference/v2/openapi_spec_v2.json @@ -19579,7 +19579,19 @@ "additionalProperties": false }, "PayoutActionRequest": { - "type": "object" + "type": "object", + "required": [ + "payout_id" + ], + "properties": { + "payout_id": { + "type": "string", + "description": "Unique identifier for the payout. This ensures idempotency for multiple payouts\nthat have been done by a single merchant. This field is auto generated and is returned in the API response.", + "example": "187282ab-40ef-47a9-9206-5099ba31e432", + "maxLength": 30, + "minLength": 30 + } + } }, "PayoutAttemptResponse": { "type": "object", @@ -19746,6 +19758,13 @@ "nullable": true, "maxLength": 255 }, + "merchant_order_reference_id": { + "type": "string", + "description": "Your unique identifier for this payout or order. This ID helps you reconcile payouts on your system. If provided, it is passed to the connector if supported.", + "example": "merchant_order_ref_123", + "nullable": true, + "maxLength": 255 + }, "amount": { "type": "integer", "format": "int64", @@ -20001,6 +20020,13 @@ "example": "merchant_1668273825", "maxLength": 255 }, + "merchant_order_reference_id": { + "type": "string", + "description": "Your unique identifier for this payout or order. This ID helps you reconcile payouts on your system. If provided, it is passed to the connector if supported.", + "example": "merchant_order_ref_123", + "nullable": true, + "maxLength": 255 + }, "amount": { "type": "integer", "format": "int64", @@ -20279,13 +20305,13 @@ "starting_after": { "type": "string", "description": "A cursor for use in pagination, fetch the next list after some object", - "example": "pay_fafa124123", + "example": "payout_fafa124123", "nullable": true }, "ending_before": { "type": "string", "description": "A cursor for use in pagination, fetch the previous list before some object", - "example": "pay_fafa124123", + "example": "payout_fafa124123", "nullable": true }, "limit": { @@ -20332,6 +20358,13 @@ "maxLength": 30, "minLength": 30 }, + "merchant_order_reference_id": { + "type": "string", + "description": "The merchant order reference ID for payout", + "example": "merchant_order_ref_123", + "nullable": true, + "maxLength": 255 + }, "profile_id": { "type": "string", "description": "The identifier for business profile", diff --git a/crates/api_models/src/events/payouts.rs b/crates/api_models/src/events/payouts.rs index a08f3ed94a8..b7eded681a3 100644 --- a/crates/api_models/src/events/payouts.rs +++ b/crates/api_models/src/events/payouts.rs @@ -9,7 +9,7 @@ use crate::payouts::{ impl ApiEventMetric for PayoutRetrieveRequest { fn get_api_event_type(&self) -> Option<ApiEventsType> { Some(ApiEventsType::Payout { - payout_id: self.payout_id.clone(), + payout_id: self.payout_id.to_owned(), }) } } @@ -17,7 +17,7 @@ impl ApiEventMetric for PayoutRetrieveRequest { impl ApiEventMetric for PayoutCreateRequest { fn get_api_event_type(&self) -> Option<ApiEventsType> { self.payout_id.as_ref().map(\|id\| ApiEventsType::Payout { - payout_id: id.clone(), + payout_id: id.to_owned(), }) } } @@ -25,7 +25,7 @@ impl ApiEventMetric for PayoutCreateRequest { impl ApiEventMetric for PayoutCreateResponse { fn get_api_event_type(&self) -> Option<ApiEventsType> { Some(ApiEventsType::Payout { - payout_id: self.payout_id.clone(), + payout_id: self.payout_id.to_owned(), }) } } @@ -33,7 +33,7 @@ impl ApiEventMetric for PayoutCreateResponse { impl ApiEventMetric for PayoutActionRequest { fn get_api_event_type(&self) -> Option<ApiEventsType> { Some(ApiEventsType::Payout { - payout_id: self.payout_id.clone(), + payout_id: self.payout_id.to_owned(), }) } } @@ -65,7 +65,7 @@ impl ApiEventMetric for PayoutListFilters { impl ApiEventMetric for PayoutLinkInitiateRequest { fn get_api_event_type(&self) -> Option<ApiEventsType> { Some(ApiEventsType::Payout { - payout_id: self.payout_id.clone(), + payout_id: self.payout_id.to_owned(), }) } } diff --git a/crates/api_models/src/payouts.rs b/crates/api_models/src/payouts.rs index cf07fd9e109..a6fdaa2b6e5 100644 --- a/crates/api_models/src/payouts.rs +++ b/crates/api_models/src/payouts.rs @@ -16,7 +16,7 @@ use utoipa::ToSchema; use crate::{enums as api_enums, payment_methods::RequiredFieldInfo, payments}; -#[derive(Debug, Deserialize, Serialize, Clone, ToSchema)] +#[derive(Debug, Serialize, Clone, ToSchema)] pub enum PayoutRequest { PayoutActionRequest(PayoutActionRequest), PayoutCreateRequest(Box<PayoutCreateRequest>), @@ -37,13 +37,17 @@ pub struct PayoutCreateRequest { example = "187282ab-40ef-47a9-9206-5099ba31e432" )] #[remove_in(PayoutsCreateRequest, PayoutUpdateRequest, PayoutConfirmRequest)] - pub payout_id: Option<String>, // TODO: #1321 https://github.com/juspay/hyperswitch/issues/1321 + pub payout_id: Option<id_type::PayoutId>, /// This is an identifier for the merchant account. This is inferred from the API key provided during the request, not required to be included in the Payout Create/Update Request. #[schema(max_length = 255, value_type = Option<String>, example = "merchant_1668273825")] #[remove_in(PayoutsCreateRequest, PayoutUpdateRequest, PayoutConfirmRequest)] pub merchant_id: Option<id_type::MerchantId>, + /// Your unique identifier for this payout or order. This ID helps you reconcile payouts on your system. If provided, it is passed to the connector if supported. + #[schema(value_type = Option<String>, max_length = 255, example = "merchant_order_ref_123")] + pub merchant_order_reference_id: Option<String>, + /// The payout amount. Amount for the payout in lowest denomination of the currency. (i.e) in cents for USD denomination, in paisa for INR denomination etc., #[schema(value_type = Option<u64>, example = 1000)] #[mandatory_in(PayoutsCreateRequest = u64)] @@ -399,13 +403,17 @@ pub struct PayoutCreateResponse { max_length = 30, example = "187282ab-40ef-47a9-9206-5099ba31e432" )] - pub payout_id: String, // TODO: Update this to PayoutIdType similar to PaymentIdType + pub payout_id: id_type::PayoutId, /// This is an identifier for the merchant account. This is inferred from the API key /// provided during the request #[schema(max_length = 255, value_type = String, example = "merchant_1668273825")] pub merchant_id: id_type::MerchantId, + /// Your unique identifier for this payout or order. This ID helps you reconcile payouts on your system. If provided, it is passed to the connector if supported. + #[schema(value_type = Option<String>, max_length = 255, example = "merchant_order_ref_123")] + pub merchant_order_reference_id: Option<String>, + /// The payout amount. Amount for the payout in lowest denomination of the currency. (i.e) in cents for USD denomination, in paisa for INR denomination etc., #[schema(value_type = i64, example = 1000)] pub amount: common_utils::types::MinorUnit, @@ -638,7 +646,7 @@ pub struct PayoutRetrieveBody { pub merchant_id: Option<id_type::MerchantId>, } -#[derive(Default, Debug, Serialize, ToSchema, Clone, Deserialize)] +#[derive(Debug, Serialize, ToSchema, Clone, Deserialize)] pub struct PayoutRetrieveRequest { /// Unique identifier for the payout. This ensures idempotency for multiple payouts /// that have been done by a single merchant. This field is auto generated and is returned in the API response. @@ -648,7 +656,7 @@ pub struct PayoutRetrieveRequest { max_length = 30, example = "187282ab-40ef-47a9-9206-5099ba31e432" )] - pub payout_id: String, + pub payout_id: id_type::PayoutId, /// `force_sync` with the connector to get payout details /// (defaults to false) @@ -660,9 +668,7 @@ pub struct PayoutRetrieveRequest { pub merchant_id: Option<id_type::MerchantId>, } -#[derive( - Default, Debug, Deserialize, Serialize, Clone, ToSchema, router_derive::PolymorphicSchema, -)] +#[derive(Debug, Serialize, Clone, ToSchema, router_derive::PolymorphicSchema)] #[generate_schemas(PayoutCancelRequest, PayoutFulfillRequest)] pub struct PayoutActionRequest { /// Unique identifier for the payout. This ensures idempotency for multiple payouts @@ -673,8 +679,7 @@ pub struct PayoutActionRequest { max_length = 30, example = "187282ab-40ef-47a9-9206-5099ba31e432" )] - #[serde(skip_deserializing)] - pub payout_id: String, + pub payout_id: id_type::PayoutId, } #[derive(Default, Debug, ToSchema, Clone, Deserialize)] @@ -722,12 +727,12 @@ pub struct PayoutListConstraints { pub customer_id: Option<id_type::CustomerId>, /// A cursor for use in pagination, fetch the next list after some object - #[schema(example = "pay_fafa124123")] - pub starting_after: Option<String>, + #[schema(example = "payout_fafa124123", value_type = Option<String>,)] + pub starting_after: Option<id_type::PayoutId>, /// A cursor for use in pagination, fetch the previous list before some object - #[schema(example = "pay_fafa124123")] - pub ending_before: Option<String>, + #[schema(example = "payout_fafa124123", value_type = Option<String>,)] + pub ending_before: Option<id_type::PayoutId>, /// limit on the number of objects to return #[schema(default = 10, maximum = 100)] @@ -755,7 +760,10 @@ pub struct PayoutListFilterConstraints { max_length = 30, example = "187282ab-40ef-47a9-9206-5099ba31e432" )] - pub payout_id: Option<String>, + pub payout_id: Option<id_type::PayoutId>, + /// The merchant order reference ID for payout + #[schema(value_type = Option<String>, max_length = 255, example = "merchant_order_ref_123")] + pub merchant_order_reference_id: Option<String>, /// The identifier for business profile #[schema(value_type = Option<String>)] pub profile_id: Option<id_type::ProfileId>, @@ -826,7 +834,8 @@ pub struct PayoutLinkResponse { pub struct PayoutLinkInitiateRequest { #[schema(value_type = String)] pub merchant_id: id_type::MerchantId, - pub payout_id: String, + #[schema(value_type = String)] + pub payout_id: id_type::PayoutId, } #[derive(Clone, Debug, serde::Serialize)] @@ -834,7 +843,7 @@ pub struct PayoutLinkDetails { pub publishable_key: Secret<String>, pub client_secret: Secret<String>, pub payout_link_id: String, - pub payout_id: String, + pub payout_id: id_type::PayoutId, pub customer_id: id_type::CustomerId, #[serde(with = "common_utils::custom_serde::iso8601")] pub session_expiry: PrimitiveDateTime, @@ -870,7 +879,7 @@ pub struct RequiredFieldsOverrideRequest { #[derive(Clone, Debug, serde::Serialize)] pub struct PayoutLinkStatusDetails { pub payout_link_id: String, - pub payout_id: String, + pub payout_id: id_type::PayoutId, pub customer_id: id_type::CustomerId, #[serde(with = "common_utils::custom_serde::iso8601")] pub session_expiry: PrimitiveDateTime, diff --git a/crates/api_models/src/webhooks.rs b/crates/api_models/src/webhooks.rs index 4667866073b..177310de18f 100644 --- a/crates/api_models/src/webhooks.rs +++ b/crates/api_models/src/webhooks.rs @@ -98,7 +98,7 @@ pub enum WebhookResponseTracker { }, #[cfg(feature = "payouts")] Payout { - payout_id: String, + payout_id: common_utils::id_type::PayoutId, status: common_enums::PayoutStatus, }, #[cfg(feature = "v1")] diff --git a/crates/common_utils/src/events.rs b/crates/common_utils/src/events.rs index 376b57fbb47..e1964296755 100644 --- a/crates/common_utils/src/events.rs +++ b/crates/common_utils/src/events.rs @@ -12,7 +12,7 @@ pub trait ApiEventMetric { #[serde(tag = "flow_type", rename_all = "snake_case")] pub enum ApiEventsType { Payout { - payout_id: String, + payout_id: id_type::PayoutId, }, #[cfg(feature = "v1")] Payment { diff --git a/crates/common_utils/src/id_type.rs b/crates/common_utils/src/id_type.rs index d9daa5caf9d..6d73a90eab2 100644 --- a/crates/common_utils/src/id_type.rs +++ b/crates/common_utils/src/id_type.rs @@ -11,6 +11,7 @@ mod merchant; mod merchant_connector_account; mod organization; mod payment; +mod payout; mod profile; mod profile_acquirer; mod refunds; @@ -27,6 +28,7 @@ use diesel::{ serialize::{Output, ToSql}, sql_types, }; +pub use payout::PayoutId; use serde::{Deserialize, Serialize}; use thiserror::Error; diff --git a/crates/common_utils/src/id_type/payout.rs b/crates/common_utils/src/id_type/payout.rs new file mode 100644 index 00000000000..8faa661d363 --- /dev/null +++ b/crates/common_utils/src/id_type/payout.rs @@ -0,0 +1,10 @@ +crate::id_type!( + PayoutId, + "A domain type for payout_id that can be used for payout ids" +); +crate::impl_id_type_methods!(PayoutId, "payout_id"); +crate::impl_debug_id_type!(PayoutId); +crate::impl_try_from_cow_str_id_type!(PayoutId, "payout_id"); +crate::impl_generate_id_id_type!(PayoutId, "payout"); +crate::impl_queryable_id_type!(PayoutId); +crate::impl_to_sql_from_sql_id_type!(PayoutId); diff --git a/crates/common_utils/src/link_utils.rs b/crates/common_utils/src/link_utils.rs index 2201000d062..89a52f44792 100644 --- a/crates/common_utils/src/link_utils.rs +++ b/crates/common_utils/src/link_utils.rs @@ -149,7 +149,7 @@ pub struct PayoutLinkData { /// Identifier for the customer pub customer_id: id_type::CustomerId, /// Identifier for the payouts resource - pub payout_id: String, + pub payout_id: id_type::PayoutId, /// Link to render the payout link pub link: url::Url, /// Client secret generated for authenticating frontend APIs diff --git a/crates/diesel_models/src/events.rs b/crates/diesel_models/src/events.rs index cbc39340dcf..bc9f0788113 100644 --- a/crates/diesel_models/src/events.rs +++ b/crates/diesel_models/src/events.rs @@ -74,7 +74,7 @@ pub enum EventMetadata { payment_id: common_utils::id_type::GlobalPaymentId, }, Payout { - payout_id: String, + payout_id: common_utils::id_type::PayoutId, }, #[cfg(feature = "v1")] Refund { diff --git a/crates/diesel_models/src/generic_link.rs b/crates/diesel_models/src/generic_link.rs index 28402692480..d6071268eae 100644 --- a/crates/diesel_models/src/generic_link.rs +++ b/crates/diesel_models/src/generic_link.rs @@ -156,7 +156,7 @@ pub struct PaymentMethodCollectLinkData { #[diesel(primary_key(link_id))] pub struct PayoutLink { pub link_id: String, - pub primary_reference: String, + pub primary_reference: common_utils::id_type::PayoutId, pub merchant_id: common_utils::id_type::MerchantId, #[serde(with = "common_utils::custom_serde::iso8601")] pub created_at: PrimitiveDateTime, diff --git a/crates/diesel_models/src/payout_attempt.rs b/crates/diesel_models/src/payout_attempt.rs index 0e12a9ed801..a908ef7bdf5 100644 --- a/crates/diesel_models/src/payout_attempt.rs +++ b/crates/diesel_models/src/payout_attempt.rs @@ -14,7 +14,7 @@ use crate::{enums as storage_enums, schema::payout_attempt}; #[diesel(table_name = payout_attempt, primary_key(payout_attempt_id), check_for_backend(diesel::pg::Pg))] pub struct PayoutAttempt { pub payout_attempt_id: String, - pub payout_id: String, + pub payout_id: common_utils::id_type::PayoutId, pub customer_id: Option<common_utils::id_type::CustomerId>, pub merchant_id: common_utils::id_type::MerchantId, pub address_id: Option<String>, @@ -37,6 +37,7 @@ pub struct PayoutAttempt { pub unified_code: Option<UnifiedCode>, pub unified_message: Option<UnifiedMessage>, pub additional_payout_method_data: Option<payout_method_utils::AdditionalPayoutMethodData>, + pub merchant_order_reference_id: Option<String>, } #[derive( @@ -53,7 +54,7 @@ pub struct PayoutAttempt { #[diesel(table_name = payout_attempt)] pub struct PayoutAttemptNew { pub payout_attempt_id: String, - pub payout_id: String, + pub payout_id: common_utils::id_type::PayoutId, pub customer_id: Option<common_utils::id_type::CustomerId>, pub merchant_id: common_utils::id_type::MerchantId, pub address_id: Option<String>, @@ -76,6 +77,7 @@ pub struct PayoutAttemptNew { pub unified_code: Option<UnifiedCode>, pub unified_message: Option<UnifiedMessage>, pub additional_payout_method_data: Option<payout_method_utils::AdditionalPayoutMethodData>, + pub merchant_order_reference_id: Option<String>, } #[derive(Debug, Clone, Serialize, Deserialize)] @@ -128,6 +130,7 @@ pub struct PayoutAttemptUpdateInternal { pub unified_code: Option<UnifiedCode>, pub unified_message: Option<UnifiedMessage>, pub additional_payout_method_data: Option<payout_method_utils::AdditionalPayoutMethodData>, + pub merchant_order_reference_id: Option<String>, } impl Default for PayoutAttemptUpdateInternal { @@ -150,6 +153,7 @@ impl Default for PayoutAttemptUpdateInternal { unified_code: None, unified_message: None, additional_payout_method_data: None, + merchant_order_reference_id: None, } } } @@ -231,6 +235,7 @@ impl PayoutAttemptUpdate { unified_code, unified_message, additional_payout_method_data, + merchant_order_reference_id, } = self.into(); PayoutAttempt { payout_token: payout_token.or(source.payout_token), @@ -251,6 +256,8 @@ impl PayoutAttemptUpdate { unified_message: unified_message.or(source.unified_message), additional_payout_method_data: additional_payout_method_data .or(source.additional_payout_method_data), + merchant_order_reference_id: merchant_order_reference_id + .or(source.merchant_order_reference_id), ..source } } diff --git a/crates/diesel_models/src/payouts.rs b/crates/diesel_models/src/payouts.rs index 8acdc4a0a5a..881875494ab 100644 --- a/crates/diesel_models/src/payouts.rs +++ b/crates/diesel_models/src/payouts.rs @@ -11,7 +11,7 @@ use crate::{enums as storage_enums, schema::payouts}; )] #[diesel(table_name = payouts, primary_key(payout_id), check_for_backend(diesel::pg::Pg))] pub struct Payouts { - pub payout_id: String, + pub payout_id: common_utils::id_type::PayoutId, pub merchant_id: common_utils::id_type::MerchantId, pub customer_id: Option<common_utils::id_type::CustomerId>, pub address_id: Option<String>, @@ -52,7 +52,7 @@ pub struct Payouts { )] #[diesel(table_name = payouts)] pub struct PayoutsNew { - pub payout_id: String, + pub payout_id: common_utils::id_type::PayoutId, pub merchant_id: common_utils::id_type::MerchantId, pub customer_id: Option<common_utils::id_type::CustomerId>, pub address_id: Option<String>, diff --git a/crates/diesel_models/src/query/generic_link.rs b/crates/diesel_models/src/query/generic_link.rs index 75f1fc8ded8..96966e14547 100644 --- a/crates/diesel_models/src/query/generic_link.rs +++ b/crates/diesel_models/src/query/generic_link.rs @@ -224,7 +224,11 @@ impl TryFrom<GenericLink> for PayoutLink { Ok(Self { link_id: db_val.link_id, - primary_reference: db_val.primary_reference, + primary_reference: common_utils::id_type::PayoutId::try_from(std::borrow::Cow::Owned( + db_val.primary_reference, + )) + .change_context(errors::ParsingError::UnknownError) + .attach_printable("Failed to parse PayoutId from primary_reference string")?, merchant_id: db_val.merchant_id, created_at: db_val.created_at, last_modified_at: db_val.last_modified_at, diff --git a/crates/diesel_models/src/query/payout_attempt.rs b/crates/diesel_models/src/query/payout_attempt.rs index 939336a223a..300b6fdb647 100644 --- a/crates/diesel_models/src/query/payout_attempt.rs +++ b/crates/diesel_models/src/query/payout_attempt.rs @@ -56,7 +56,7 @@ impl PayoutAttempt { pub async fn find_by_merchant_id_payout_id( conn: &PgPooledConn, merchant_id: &common_utils::id_type::MerchantId, - payout_id: &str, + payout_id: &common_utils::id_type::PayoutId, ) -> StorageResult<Self> { generics::generic_find_one::<<Self as HasTable>::Table, _, _>( conn, @@ -95,10 +95,24 @@ impl PayoutAttempt { .await } + pub async fn find_by_merchant_id_merchant_order_reference_id( + conn: &PgPooledConn, + merchant_id_input: &common_utils::id_type::MerchantId, + merchant_order_reference_id_input: &str, + ) -> StorageResult<Self> { + generics::generic_find_one::<<Self as HasTable>::Table, _, _>( + conn, + dsl::merchant_id.eq(merchant_id_input.to_owned()).and( + dsl::merchant_order_reference_id.eq(merchant_order_reference_id_input.to_owned()), + ), + ) + .await + } + pub async fn update_by_merchant_id_payout_id( conn: &PgPooledConn, merchant_id: &common_utils::id_type::MerchantId, - payout_id: &str, + payout_id: &common_utils::id_type::PayoutId, payout: PayoutAttemptUpdate, ) -> StorageResult<Self> { generics::generic_update_with_results::<<Self as HasTable>::Table, _, _, _>( @@ -152,7 +166,7 @@ impl PayoutAttempt { .map(\|payout\| { format!( "{}_{}", - payout.payout_id.clone(), + payout.payout_id.get_string_repr(), payout.attempt_count.clone() ) }) @@ -160,8 +174,8 @@ impl PayoutAttempt { let active_payout_ids = payouts .iter() - .map(\|payout\| payout.payout_id.clone()) - .collect::<Vec<String>>(); + .map(\|payout\| payout.payout_id.to_owned()) + .collect::<Vec<common_utils::id_type::PayoutId>>(); let filter = <Self as HasTable>::table() .filter(dsl::merchant_id.eq(merchant_id.to_owned())) diff --git a/crates/diesel_models/src/query/payouts.rs b/crates/diesel_models/src/query/payouts.rs index 25c7bfc4f7e..e7d06d05ffe 100644 --- a/crates/diesel_models/src/query/payouts.rs +++ b/crates/diesel_models/src/query/payouts.rs @@ -47,7 +47,7 @@ impl Payouts { pub async fn find_by_merchant_id_payout_id( conn: &PgPooledConn, merchant_id: &common_utils::id_type::MerchantId, - payout_id: &str, + payout_id: &common_utils::id_type::PayoutId, ) -> StorageResult<Self> { generics::generic_find_one::<<Self as HasTable>::Table, _, _>( conn, @@ -61,7 +61,7 @@ impl Payouts { pub async fn update_by_merchant_id_payout_id( conn: &PgPooledConn, merchant_id: &common_utils::id_type::MerchantId, - payout_id: &str, + payout_id: &common_utils::id_type::PayoutId, payout: PayoutsUpdate, ) -> StorageResult<Self> { generics::generic_update_with_results::<<Self as HasTable>::Table, _, _, _>( @@ -82,7 +82,7 @@ impl Payouts { pub async fn find_optional_by_merchant_id_payout_id( conn: &PgPooledConn, merchant_id: &common_utils::id_type::MerchantId, - payout_id: &str, + payout_id: &common_utils::id_type::PayoutId, ) -> StorageResult<Option<Self>> { generics::generic_find_one_optional::<<Self as HasTable>::Table, _, _>( conn, @@ -96,7 +96,7 @@ impl Payouts { pub async fn get_total_count_of_payouts( conn: &PgPooledConn, merchant_id: &common_utils::id_type::MerchantId, - active_payout_ids: &[String], + active_payout_ids: &[common_utils::id_type::PayoutId], connector: Option<Vec<String>>, currency: Option<Vec<enums::Currency>>, status: Option<Vec<enums::PayoutStatus>>, @@ -106,7 +106,7 @@ impl Payouts { .inner_join(payout_attempt::table.on(payout_attempt::dsl::payout_id.eq(dsl::payout_id))) .count() .filter(dsl::merchant_id.eq(merchant_id.to_owned())) - .filter(dsl::payout_id.eq_any(active_payout_ids.to_owned())) + .filter(dsl::payout_id.eq_any(active_payout_ids.to_vec())) .into_boxed(); if let Some(connector) = connector { diff --git a/crates/diesel_models/src/schema.rs b/crates/diesel_models/src/schema.rs index e303dfc553f..1629780458c 100644 --- a/crates/diesel_models/src/schema.rs +++ b/crates/diesel_models/src/schema.rs @@ -1151,7 +1151,7 @@ diesel::table! { use diesel::sql_types::; use crate::enums::diesel_exports::; - payout_attempt (payout_attempt_id) { + payout_attempt (merchant_id, payout_attempt_id) { #[max_length = 64] payout_attempt_id -> Varchar, #[max_length = 64] @@ -1188,6 +1188,8 @@ diesel::table! { #[max_length = 1024] unified_message -> Nullable<Varchar>, additional_payout_method_data -> Nullable<Jsonb>, + #[max_length = 255] + merchant_order_reference_id -> Nullable<Varchar>, } } @@ -1195,7 +1197,7 @@ diesel::table! { use diesel::sql_types::; use crate::enums::diesel_exports::; - payouts (payout_id) { + payouts (merchant_id, payout_id) { #[max_length = 64] payout_id -> Varchar, #[max_length = 64] diff --git a/crates/diesel_models/src/schema_v2.rs b/crates/diesel_models/src/schema_v2.rs index 9ba5cdfaff6..c931cec977a 100644 --- a/crates/diesel_models/src/schema_v2.rs +++ b/crates/diesel_models/src/schema_v2.rs @@ -1090,7 +1090,7 @@ diesel::table! { use diesel::sql_types::; use crate::enums::diesel_exports::; - payout_attempt (payout_attempt_id) { + payout_attempt (merchant_id, payout_attempt_id) { #[max_length = 64] payout_attempt_id -> Varchar, #[max_length = 64] @@ -1127,6 +1127,8 @@ diesel::table! { #[max_length = 1024] unified_message -> Nullable<Varchar>, additional_payout_method_data -> Nullable<Jsonb>, + #[max_length = 255] + merchant_order_reference_id -> Nullable<Varchar>, } } @@ -1134,7 +1136,7 @@ diesel::table! { use diesel::sql_types::; use crate::enums::diesel_exports::; - payouts (payout_id) { + payouts (merchant_id, payout_id) { #[max_length = 64] payout_id -> Varchar, #[max_length = 64] diff --git a/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs b/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs index 8eec0abb9fc..8f4d667711b 100644 --- a/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs @@ -5351,7 +5351,7 @@ impl<F> TryFrom<&AdyenRouterData<&PayoutsRouterData<F>>> for AdyenPayoutCreateRe }, merchant_account, payment_data: PayoutPaymentMethodData::PayoutWalletData(payout_wallet), - reference: item.router_data.request.payout_id.to_owned(), + reference: item.router_data.connector_request_reference_id.clone(), shopper_reference: item.router_data.merchant_id.get_string_repr().to_owned(), shopper_email: customer_email, shopper_name: ShopperName { diff --git a/crates/hyperswitch_connectors/src/connectors/adyenplatform/transformers/payouts.rs b/crates/hyperswitch_connectors/src/connectors/adyenplatform/transformers/payouts.rs index 7262ec9f3ff..82c9afadeed 100644 --- a/crates/hyperswitch_connectors/src/connectors/adyenplatform/transformers/payouts.rs +++ b/crates/hyperswitch_connectors/src/connectors/adyenplatform/transformers/payouts.rs @@ -361,7 +361,7 @@ impl<F> TryFrom<&AdyenPlatformRouterData<&types::PayoutsRouterData<F>>> for Adye counterparty, priority, reference: item.router_data.connector_request_reference_id.clone(), - reference_for_beneficiary: request.payout_id.clone(), + reference_for_beneficiary: item.router_data.connector_request_reference_id.clone(), description: item.router_data.description.clone(), }) } diff --git a/crates/hyperswitch_connectors/src/connectors/cybersource/transformers.rs b/crates/hyperswitch_connectors/src/connectors/cybersource/transformers.rs index 6b4101a15d2..09b468c3caf 100644 --- a/crates/hyperswitch_connectors/src/connectors/cybersource/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/cybersource/transformers.rs @@ -3958,7 +3958,7 @@ impl TryFrom<&CybersourceRouterData<&PayoutsRouterData<PoFulfill>>> match payout_type { enums::PayoutType::Card => { let client_reference_information = ClientReferenceInformation { - code: Some(item.router_data.request.payout_id.clone()), + code: Some(item.router_data.connector_request_reference_id.clone()), }; let order_information = OrderInformation { @@ -3974,7 +3974,7 @@ impl TryFrom<&CybersourceRouterData<&PayoutsRouterData<PoFulfill>>> CybersourceRecipientInfo::try_from((billing_address, phone_address))?; let sender_information = CybersourceSenderInfo { - reference_number: item.router_data.request.payout_id.clone(), + reference_number: item.router_data.connector_request_reference_id.clone(), account: CybersourceAccountInfo { funds_source: CybersourcePayoutFundSourceType::Disbursement, }, diff --git a/crates/hyperswitch_connectors/src/connectors/nomupay/transformers.rs b/crates/hyperswitch_connectors/src/connectors/nomupay/transformers.rs index 9a1a50e8642..3eab923ff16 100644 --- a/crates/hyperswitch_connectors/src/connectors/nomupay/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/nomupay/transformers.rs @@ -385,7 +385,7 @@ impl<F> TryFrom<&PayoutsRouterData<F>> for OnboardSubAccountRequest { match payout_type { Some(common_enums::PayoutType::Bank) => Ok(Self { account_id: nomupay_auth_type.eid, - client_sub_account_id: Secret::new(request.payout_id), + client_sub_account_id: Secret::new(item.connector_request_reference_id.clone()), profile, }), _ => Err(errors::ConnectorError::NotImplemented( @@ -498,7 +498,7 @@ impl<F> TryFrom<(&PayoutsRouterData<F>, FloatMajorUnit)> for NomupayPaymentReque Ok(Self { source_id: nomupay_auth_type.eid, destination_id: Secret::new(destination), - payment_reference: item.request.clone().payout_id, + payment_reference: item.connector_request_reference_id.clone(), amount, currency_code: item.request.destination_currency, purpose: PURPOSE_OF_PAYMENT_IS_OTHER.to_string(), diff --git a/crates/hyperswitch_connectors/src/connectors/paypal/transformers.rs b/crates/hyperswitch_connectors/src/connectors/paypal/transformers.rs index 6b56ccea208..18c7ac02e71 100644 --- a/crates/hyperswitch_connectors/src/connectors/paypal/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/paypal/transformers.rs @@ -2309,7 +2309,7 @@ impl TryFrom<&PaypalRouterData<&PayoutsRouterData<PoFulfill>>> for PaypalFulfill let item_data = PaypalPayoutItem::try_from(item)?; Ok(Self { sender_batch_header: PayoutBatchHeader { - sender_batch_id: item.router_data.request.payout_id.to_owned(), + sender_batch_id: item.router_data.connector_request_reference_id.to_owned(), }, items: vec![item_data], }) diff --git a/crates/hyperswitch_connectors/src/connectors/stripe/transformers/connect.rs b/crates/hyperswitch_connectors/src/connectors/stripe/transformers/connect.rs index bb8d4509dac..321aad76551 100644 --- a/crates/hyperswitch_connectors/src/connectors/stripe/transformers/connect.rs +++ b/crates/hyperswitch_connectors/src/connectors/stripe/transformers/connect.rs @@ -216,7 +216,7 @@ impl<F> TryFrom<&PayoutsRouterData<F>> for StripeConnectPayoutCreateRequest { amount: request.amount, currency: request.destination_currency, destination: connector_customer_id, - transfer_group: request.payout_id, + transfer_group: item.connector_request_reference_id.clone(), }) } } diff --git a/crates/hyperswitch_connectors/src/connectors/wise/transformers.rs b/crates/hyperswitch_connectors/src/connectors/wise/transformers.rs index 1a9ff7bf89f..f844e15a488 100644 --- a/crates/hyperswitch_connectors/src/connectors/wise/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/wise/transformers.rs @@ -510,7 +510,7 @@ impl<F> TryFrom<&PayoutsRouterData<F>> for WisePayoutCreateRequest { Ok(Self { target_account, quote_uuid, - customer_transaction_id: request.payout_id, + customer_transaction_id: request.payout_id.get_string_repr().to_string(), details: wise_transfer_details, }) } diff --git a/crates/hyperswitch_domain_models/src/errors/api_error_response.rs b/crates/hyperswitch_domain_models/src/errors/api_error_response.rs index 21accfa22c5..2924093da3a 100644 --- a/crates/hyperswitch_domain_models/src/errors/api_error_response.rs +++ b/crates/hyperswitch_domain_models/src/errors/api_error_response.rs @@ -79,8 +79,10 @@ pub enum ApiErrorResponse { DuplicatePayment { payment_id: common_utils::id_type::PaymentId, }, - #[error(error_type = ErrorType::DuplicateRequest, code = "HE_01", message = "The payout with the specified payout_id '{payout_id}' already exists in our records")] - DuplicatePayout { payout_id: String }, + #[error(error_type = ErrorType::DuplicateRequest, code = "HE_01", message = "The payout with the specified payout_id '{payout_id:?}' already exists in our records")] + DuplicatePayout { + payout_id: common_utils::id_type::PayoutId, + }, #[error(error_type = ErrorType::DuplicateRequest, code = "HE_01", message = "The config with the specified key already exists in our records")] DuplicateConfig, #[error(error_type = ErrorType::ObjectNotFound, code = "HE_02", message = "Refund does not exist in our records")] @@ -403,7 +405,7 @@ impl ErrorSwitch<api_models::errors::types::ApiErrorResponse> for ApiErrorRespon AER::BadRequest(ApiError::new("HE", 1, "The payment with the specified payment_id already exists in our records", Some(Extra {reason: Some(format!("{payment_id:?} already exists")), ..Default::default()}))) } Self::DuplicatePayout { payout_id } => { - AER::BadRequest(ApiError::new("HE", 1, format!("The payout with the specified payout_id '{payout_id}' already exists in our records"), None)) + AER::BadRequest(ApiError::new("HE", 1, format!("The payout with the specified payout_id '{payout_id:?}' already exists in our records"), None)) } Self::DuplicateConfig => { AER::BadRequest(ApiError::new("HE", 1, "The config with the specified key already exists in our records", None)) diff --git a/crates/hyperswitch_domain_models/src/payouts.rs b/crates/hyperswitch_domain_models/src/payouts.rs index 8c6d751ebec..9a40dc119c0 100644 --- a/crates/hyperswitch_domain_models/src/payouts.rs +++ b/crates/hyperswitch_domain_models/src/payouts.rs @@ -7,7 +7,7 @@ use common_utils::{consts, id_type}; use time::PrimitiveDateTime; pub enum PayoutFetchConstraints { - Single { payout_id: String }, + Single { payout_id: id_type::PayoutId }, List(Box<PayoutListParams>), } @@ -21,10 +21,11 @@ pub struct PayoutListParams { pub payout_method: Option<Vec<common_enums::PayoutType>>, pub profile_id: Option<id_type::ProfileId>, pub customer_id: Option<id_type::CustomerId>, - pub starting_after_id: Option<String>, - pub ending_before_id: Option<String>, + pub starting_after_id: Option<id_type::PayoutId>, + pub ending_before_id: Option<id_type::PayoutId>, pub entity_type: Option<common_enums::PayoutEntityType>, pub limit: Option<u32>, + pub merchant_order_reference_id: Option<String>, } impl From<api_models::payouts::PayoutListConstraints> for PayoutFetchConstraints { @@ -44,6 +45,7 @@ impl From<api_models::payouts::PayoutListConstraints> for PayoutFetchConstraints starting_after_id: value.starting_after, ending_before_id: value.ending_before, entity_type: None, + merchant_order_reference_id: None, limit: Some(std::cmp::min( value.limit, consts::PAYOUTS_LIST_MAX_LIMIT_GET, @@ -67,6 +69,7 @@ impl From<common_utils::types::TimeRange> for PayoutFetchConstraints { starting_after_id: None, ending_before_id: None, entity_type: None, + merchant_order_reference_id: None, limit: None, })) } @@ -90,6 +93,7 @@ impl From<api_models::payouts::PayoutListFilterConstraints> for PayoutFetchConst starting_after_id: None, ending_before_id: None, entity_type: value.entity_type, + merchant_order_reference_id: value.merchant_order_reference_id, limit: Some(std::cmp::min( value.limit, consts::PAYOUTS_LIST_MAX_LIMIT_POST, diff --git a/crates/hyperswitch_domain_models/src/payouts/payout_attempt.rs b/crates/hyperswitch_domain_models/src/payouts/payout_attempt.rs index dcb61bddc97..b6293faa841 100644 --- a/crates/hyperswitch_domain_models/src/payouts/payout_attempt.rs +++ b/crates/hyperswitch_domain_models/src/payouts/payout_attempt.rs @@ -42,6 +42,13 @@ pub trait PayoutAttemptInterface { _storage_scheme: MerchantStorageScheme, ) -> error_stack::Result<PayoutAttempt, Self::Error>; + async fn find_payout_attempt_by_merchant_id_merchant_order_reference_id( + &self, + _merchant_id: &id_type::MerchantId, + _merchant_order_reference_id: &str, + _storage_scheme: MerchantStorageScheme, + ) -> error_stack::Result<PayoutAttempt, Self::Error>; + async fn get_filters_for_payouts( &self, _payout: &[Payouts], @@ -61,7 +68,7 @@ pub struct PayoutListFilters { #[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)] pub struct PayoutAttempt { pub payout_attempt_id: String, - pub payout_id: String, + pub payout_id: id_type::PayoutId, pub customer_id: Option<id_type::CustomerId>, pub merchant_id: id_type::MerchantId, pub address_id: Option<String>, @@ -84,12 +91,13 @@ pub struct PayoutAttempt { pub unified_code: Option<UnifiedCode>, pub unified_message: Option<UnifiedMessage>, pub additional_payout_method_data: Option<payout_method_utils::AdditionalPayoutMethodData>, + pub merchant_order_reference_id: Option<String>, } #[derive(Clone, Debug, PartialEq)] pub struct PayoutAttemptNew { pub payout_attempt_id: String, - pub payout_id: String, + pub payout_id: id_type::PayoutId, pub customer_id: Option<id_type::CustomerId>, pub merchant_id: id_type::MerchantId, pub address_id: Option<String>, @@ -110,6 +118,7 @@ pub struct PayoutAttemptNew { pub unified_code: Option<UnifiedCode>, pub unified_message: Option<UnifiedMessage>, pub additional_payout_method_data: Option<payout_method_utils::AdditionalPayoutMethodData>, + pub merchant_order_reference_id: Option<String>, } #[derive(Debug, Clone)] diff --git a/crates/hyperswitch_domain_models/src/payouts/payouts.rs b/crates/hyperswitch_domain_models/src/payouts/payouts.rs index 7c34b3c26df..1d41a5f9a32 100644 --- a/crates/hyperswitch_domain_models/src/payouts/payouts.rs +++ b/crates/hyperswitch_domain_models/src/payouts/payouts.rs @@ -20,7 +20,7 @@ pub trait PayoutsInterface { async fn find_payout_by_merchant_id_payout_id( &self, _merchant_id: &id_type::MerchantId, - _payout_id: &str, + _payout_id: &id_type::PayoutId, _storage_scheme: MerchantStorageScheme, ) -> error_stack::Result<Payouts, Self::Error>; @@ -35,7 +35,7 @@ pub trait PayoutsInterface { async fn find_optional_payout_by_merchant_id_payout_id( &self, _merchant_id: &id_type::MerchantId, - _payout_id: &str, + _payout_id: &id_type::PayoutId, _storage_scheme: MerchantStorageScheme, ) -> error_stack::Result<Option<Payouts>, Self::Error>; @@ -76,7 +76,7 @@ pub trait PayoutsInterface { async fn get_total_count_of_filtered_payouts( &self, _merchant_id: &id_type::MerchantId, - _active_payout_ids: &[String], + _active_payout_ids: &[id_type::PayoutId], _connector: Option<Vec<api_models::enums::PayoutConnectors>>, _currency: Option<Vec<storage_enums::Currency>>, _status: Option<Vec<storage_enums::PayoutStatus>>, @@ -88,12 +88,12 @@ pub trait PayoutsInterface { &self, _merchant_id: &id_type::MerchantId, _constraints: &PayoutFetchConstraints, - ) -> error_stack::Result<Vec<String>, Self::Error>; + ) -> error_stack::Result<Vec<id_type::PayoutId>, Self::Error>; } #[derive(Clone, Debug, Eq, PartialEq)] pub struct Payouts { - pub payout_id: String, + pub payout_id: id_type::PayoutId, pub merchant_id: id_type::MerchantId, pub customer_id: Option<id_type::CustomerId>, pub address_id: Option<String>, @@ -121,7 +121,7 @@ pub struct Payouts { #[derive(Clone, Debug, Eq, PartialEq)] pub struct PayoutsNew { - pub payout_id: String, + pub payout_id: id_type::PayoutId, pub merchant_id: id_type::MerchantId, pub customer_id: Option<id_type::CustomerId>, pub address_id: Option<String>, diff --git a/crates/hyperswitch_domain_models/src/router_request_types.rs b/crates/hyperswitch_domain_models/src/router_request_types.rs index e811b872c8c..c7987122ead 100644 --- a/crates/hyperswitch_domain_models/src/router_request_types.rs +++ b/crates/hyperswitch_domain_models/src/router_request_types.rs @@ -890,7 +890,7 @@ pub struct UploadFileRequestData { #[cfg(feature = "payouts")] #[derive(Debug, Clone)] pub struct PayoutsData { - pub payout_id: String, + pub payout_id: id_type::PayoutId, pub amount: i64, pub connector_payout_id: Option<String>, pub destination_currency: storage_enums::Currency, diff --git a/crates/router/src/compatibility/stripe/errors.rs b/crates/router/src/compatibility/stripe/errors.rs index 58f707b2db6..83f7fe69053 100644 --- a/crates/router/src/compatibility/stripe/errors.rs +++ b/crates/router/src/compatibility/stripe/errors.rs @@ -1,4 +1,4 @@ -use common_utils::errors::ErrorSwitch; +use common_utils::{errors::ErrorSwitch, id_type}; use hyperswitch_domain_models::errors::api_error_response as errors; use crate::core::errors::CustomersErrorResponse; @@ -133,7 +133,7 @@ pub enum StripeErrorCode { EventNotFound, #[error(error_type = StripeErrorType::InvalidRequestError, code = "token_already_used", message = "Duplicate payout request")] - DuplicatePayout { payout_id: String }, + DuplicatePayout { payout_id: id_type::PayoutId }, #[error(error_type = StripeErrorType::InvalidRequestError, code = "parameter_missing", message = "Return url is not available")] ReturnUrlUnavailable, @@ -209,9 +209,7 @@ pub enum StripeErrorCode { PaymentIntentMandateInvalid { message: String }, #[error(error_type = StripeErrorType::InvalidRequestError, code = "", message = "The payment with the specified payment_id already exists in our records.")] - DuplicatePayment { - payment_id: common_utils::id_type::PaymentId, - }, + DuplicatePayment { payment_id: id_type::PaymentId }, #[error(error_type = StripeErrorType::ConnectorError, code = "", message = "{code}: {message}")] ExternalConnectorError { diff --git a/crates/router/src/compatibility/stripe/webhooks.rs b/crates/router/src/compatibility/stripe/webhooks.rs index f5dde401b35..3bd0f83b7db 100644 --- a/crates/router/src/compatibility/stripe/webhooks.rs +++ b/crates/router/src/compatibility/stripe/webhooks.rs @@ -4,9 +4,12 @@ use api_models::{ enums::{Currency, DisputeStatus, MandateStatus}, webhooks::{self as api}, }; -#[cfg(feature = "payouts")] -use common_utils::pii::{self, Email}; use common_utils::{crypto::SignMessage, date_time, ext_traits::Encode}; +#[cfg(feature = "payouts")] +use common_utils::{ + id_type, + pii::{self, Email}, +}; use error_stack::ResultExt; use router_env::logger; use serde::Serialize; @@ -94,7 +97,7 @@ pub struct StripeDisputeResponse { pub id: String, pub amount: String, pub currency: Currency, - pub payment_intent: common_utils::id_type::PaymentId, + pub payment_intent: id_type::PaymentId, pub reason: Option<String>, pub status: StripeDisputeStatus, } @@ -110,7 +113,7 @@ pub struct StripeMandateResponse { #[cfg(feature = "payouts")] #[derive(Clone, Serialize, Debug)] pub struct StripePayoutResponse { - pub id: String, + pub id: id_type::PayoutId, pub amount: i64, pub currency: String, pub payout_type: Option<common_enums::PayoutType>, diff --git a/crates/router/src/core/payments/routing.rs b/crates/router/src/core/payments/routing.rs index 4cc667bdc8a..7126ed9617e 100644 --- a/crates/router/src/core/payments/routing.rs +++ b/crates/router/src/core/payments/routing.rs @@ -483,9 +483,11 @@ pub async fn perform_static_routing_v1( .get_string_repr() .to_string(), #[cfg(feature = "payouts")] - routing::TransactionData::Payout(payout_data) => { - payout_data.payout_attempt.payout_id.clone() - } + routing::TransactionData::Payout(payout_data) => payout_data + .payout_attempt + .payout_id + .get_string_repr() + .to_string(), }; let routing_events_wrapper = utils::RoutingEventsWrapper::new( diff --git a/crates/router/src/core/payout_link.rs b/crates/router/src/core/payout_link.rs index 8c234889630..1d224ffbd79 100644 --- a/crates/router/src/core/payout_link.rs +++ b/crates/router/src/core/payout_link.rs @@ -22,6 +22,7 @@ use crate::{ routes::{app::StorageInterface, SessionState}, services, types::{api, domain, transformers::ForeignFrom}, + utils::get_payout_attempt_id, }; #[cfg(feature = "v2")] @@ -56,7 +57,7 @@ pub async fn initiate_payout_link( let payout_attempt = db .find_payout_attempt_by_merchant_id_payout_attempt_id( merchant_id, - &format!("{}_{}", payout.payout_id, payout.attempt_count), + &get_payout_attempt_id(payout.payout_id.get_string_repr(), payout.attempt_count), merchant_context.get_merchant_account().storage_scheme, ) .await @@ -146,13 +147,11 @@ pub async fn initiate_payout_link( .await .change_context(errors::ApiErrorResponse::InvalidRequestData { message: format!( - "Customer [{}] not found for link_id - {}", - payout_link.primary_reference, payout_link.link_id + "Customer [{:?}] not found for link_id - {}", + customer_id, payout_link.link_id ), }) - .attach_printable_lazy(\|\| { - format!("customer [{}] not found", payout_link.primary_reference) - })?; + .attach_printable_lazy(\|\| format!("customer [{:?}] not found", customer_id))?; let address = payout .address_id .as_ref() @@ -169,7 +168,7 @@ pub async fn initiate_payout_link( .change_context(errors::ApiErrorResponse::InternalServerError) .attach_printable_lazy(\|\| { format!( - "Failed while fetching address [id - {:?}] for payout [id - {}]", + "Failed while fetching address [id - {:?}] for payout [id - {:?}]", payout.address_id, payout.payout_id ) })?; @@ -227,7 +226,7 @@ pub async fn initiate_payout_link( ), client_secret: link_data.client_secret.clone(), payout_link_id: payout_link.link_id, - payout_id: payout_link.primary_reference, + payout_id: payout_link.primary_reference.clone(), customer_id: customer.customer_id, session_expiry: payout_link.expiry, return_url: payout_link @@ -284,7 +283,7 @@ pub async fn initiate_payout_link( .await?; let js_data = payouts::PayoutLinkStatusDetails { payout_link_id: payout_link.link_id, - payout_id: payout_link.primary_reference, + payout_id: payout_link.primary_reference.clone(), customer_id: link_data.customer_id, session_expiry: payout_link.expiry, return_url: payout_link diff --git a/crates/router/src/core/payouts.rs b/crates/router/src/core/payouts.rs index 495bea84eac..3cc996bd9a6 100644 --- a/crates/router/src/core/payouts.rs +++ b/crates/router/src/core/payouts.rs @@ -17,7 +17,7 @@ use common_enums::PayoutRetryType; use common_utils::{ consts, ext_traits::{AsyncExt, ValueExt}, - id_type::CustomerId, + id_type::{self, GenerateId}, link_utils::{GenericLinkStatus, GenericLinkUiConfig, PayoutLinkData, PayoutLinkStatus}, types::{MinorUnit, UnifiedCode, UnifiedMessage}, }; @@ -73,7 +73,7 @@ pub struct PayoutData { pub payouts: storage::Payouts, pub payout_attempt: storage::PayoutAttempt, pub payout_method_data: Option<payouts::PayoutMethodData>, - pub profile_id: common_utils::id_type::ProfileId, + pub profile_id: id_type::ProfileId, pub should_terminate: bool, pub payout_link: Option<PayoutLink>, pub current_locale: String, @@ -451,7 +451,7 @@ pub async fn payouts_update_core( if helpers::is_payout_terminal_state(status) \|\| helpers::is_payout_initiated(status) { return Err(report!(errors::ApiErrorResponse::InvalidRequestData { message: format!( - "Payout {} cannot be updated for status {}", + "Payout {:?} cannot be updated for status {}", payout_id, status ), })); @@ -506,7 +506,7 @@ pub async fn payouts_update_core( pub async fn payouts_retrieve_core( state: SessionState, merchant_context: domain::MerchantContext, - profile_id: Option<common_utils::id_type::ProfileId>, + profile_id: Option<id_type::ProfileId>, req: payouts::PayoutRetrieveRequest, ) -> RouterResponse<payouts::PayoutCreateResponse> { let mut payout_data = Box::pin(make_payout_data( @@ -568,7 +568,7 @@ pub async fn payouts_cancel_core( if helpers::is_payout_terminal_state(status) { return Err(report!(errors::ApiErrorResponse::InvalidRequestData { message: format!( - "Payout {} cannot be cancelled for status {}", + "Payout {:?} cannot be cancelled for status {}", payout_attempt.payout_id, status ), })); @@ -663,7 +663,7 @@ pub async fn payouts_fulfill_core( { return Err(report!(errors::ApiErrorResponse::InvalidRequestData { message: format!( - "Payout {} cannot be fulfilled for status {}", + "Payout {:?} cannot be fulfilled for status {}", payout_attempt.payout_id, status ), })); @@ -733,7 +733,7 @@ pub async fn payouts_fulfill_core( pub async fn payouts_list_core( _state: SessionState, _merchant_context: domain::MerchantContext, - _profile_id_list: Option<Vec<common_utils::id_type::ProfileId>>, + _profile_id_list: Option<Vec<id_type::ProfileId>>, _constraints: payouts::PayoutListConstraints, ) -> RouterResponse<payouts::PayoutListResponse> { todo!() @@ -743,7 +743,7 @@ pub async fn payouts_list_core( pub async fn payouts_list_core( state: SessionState, merchant_context: domain::MerchantContext, - profile_id_list: Option<Vec<common_utils::id_type::ProfileId>>, + profile_id_list: Option<Vec<id_type::ProfileId>>, constraints: payouts::PayoutListConstraints, ) -> RouterResponse<payouts::PayoutListResponse> { validator::validate_payout_list_request(&constraints)?; @@ -765,7 +765,10 @@ pub async fn payouts_list_core( match db .find_payout_attempt_by_merchant_id_payout_attempt_id( merchant_id, - &utils::get_payout_attempt_id(payout.payout_id.clone(), payout.attempt_count), + &utils::get_payout_attempt_id( + payout.payout_id.get_string_repr(), + payout.attempt_count, + ), storage_enums::MerchantStorageScheme::PostgresOnly, ) .await @@ -795,7 +798,7 @@ pub async fn payouts_list_core( }; let payout_id_as_payment_id_type = - common_utils::id_type::PaymentId::wrap(payout.payout_id.clone()) + id_type::PaymentId::wrap(payout.payout_id.get_string_repr().to_string()) .change_context(errors::ApiErrorResponse::InvalidRequestData { message: "payout_id contains invalid data".to_string(), }) @@ -862,7 +865,7 @@ pub async fn payouts_list_core( pub async fn payouts_filtered_list_core( state: SessionState, merchant_context: domain::MerchantContext, - profile_id_list: Option<Vec<common_utils::id_type::ProfileId>>, + profile_id_list: Option<Vec<id_type::ProfileId>>, filters: payouts::PayoutListFilterConstraints, ) -> RouterResponse<payouts::PayoutListResponse> { let limit = &filters.limit; @@ -976,7 +979,7 @@ pub async fn payouts_filtered_list_core( pub async fn payouts_list_available_filters_core( state: SessionState, merchant_context: domain::MerchantContext, - profile_id_list: Option<Vec<common_utils::id_type::ProfileId>>, + profile_id_list: Option<Vec<id_type::ProfileId>>, time_range: common_utils::types::TimeRange, ) -> RouterResponse<api::PayoutListFilters> { let db = state.store.as_ref(); @@ -2540,6 +2543,7 @@ pub async fn response_handler( let response = api::PayoutCreateResponse { payout_id: payouts.payout_id.to_owned(), merchant_id: merchant_context.get_merchant_account().get_id().to_owned(), + merchant_order_reference_id: payout_attempt.merchant_order_reference_id.clone(), amount: payouts.amount, currency: payouts.destination_currency.to_owned(), connector: payout_attempt.connector, @@ -2615,8 +2619,8 @@ pub async fn payout_create_db_entries( state: &SessionState, merchant_context: &domain::MerchantContext, req: &payouts::PayoutCreateRequest, - payout_id: &String, - profile_id: &common_utils::id_type::ProfileId, + payout_id: &id_type::PayoutId, + profile_id: &id_type::ProfileId, stored_payout_method_data: Option<&payouts::PayoutMethodData>, locale: &str, customer: Option<&domain::Customer>, @@ -2655,12 +2659,13 @@ pub async fn payout_create_db_entries( // We have to do this because the function that is being used to create / get address is from payments // which expects a payment_id - let payout_id_as_payment_id_type = - common_utils::id_type::PaymentId::try_from(std::borrow::Cow::Owned(payout_id.to_string())) - .change_context(errors::ApiErrorResponse::InvalidRequestData { - message: "payout_id contains invalid data".to_string(), - }) - .attach_printable("Error converting payout_id to PaymentId type")?; + let payout_id_as_payment_id_type = id_type::PaymentId::try_from(std::borrow::Cow::Owned( + payout_id.get_string_repr().to_string(), + )) + .change_context(errors::ApiErrorResponse::InvalidRequestData { + message: "payout_id contains invalid data".to_string(), + }) + .attach_printable("Error converting payout_id to PaymentId type")?; // Get or create address let billing_address = payment_helpers::create_or_find_address_for_payment_by_request( @@ -2696,7 +2701,7 @@ pub async fn payout_create_db_entries( let client_secret = utils::generate_id( consts::ID_LENGTH, - format!("payout_{payout_id}_secret").as_str(), + format!("payout_{payout_id:?}_secret").as_str(), ); let amount = MinorUnit::from(req.amount.unwrap_or(api::Amount::Zero)); let status = if req.payout_method_data.is_some() @@ -2712,7 +2717,7 @@ pub async fn payout_create_db_entries( }; let payouts_req = storage::PayoutsNew { - payout_id: payout_id.to_string(), + payout_id: payout_id.clone(), merchant_id: merchant_id.to_owned(), customer_id: customer_id.to_owned(), address_id: address_id.to_owned(), @@ -2746,11 +2751,11 @@ pub async fn payout_create_db_entries( ) .await .to_duplicate_response(errors::ApiErrorResponse::DuplicatePayout { - payout_id: payout_id.to_owned(), + payout_id: payout_id.clone(), }) .attach_printable("Error inserting payouts in db")?; // Make payout_attempt entry - let payout_attempt_id = utils::get_payout_attempt_id(payout_id, 1); + let payout_attempt_id = utils::get_payout_attempt_id(payout_id.get_string_repr(), 1); let additional_pm_data_value = req .payout_method_data @@ -2764,9 +2769,10 @@ pub async fn payout_create_db_entries( let payout_attempt_req = storage::PayoutAttemptNew { payout_attempt_id: payout_attempt_id.to_string(), - payout_id: payout_id.to_owned(), + payout_id: payout_id.clone(), additional_payout_method_data: additional_pm_data_value, merchant_id: merchant_id.to_owned(), + merchant_order_reference_id: req.merchant_order_reference_id.clone(), status, business_country: req.business_country.to_owned(), business_label: req.business_label.to_owned(), @@ -2794,7 +2800,7 @@ pub async fn payout_create_db_entries( ) .await .to_duplicate_response(errors::ApiErrorResponse::DuplicatePayout { - payout_id: payout_id.to_owned(), + payout_id: payout_id.clone(), }) .attach_printable("Error inserting payout_attempt in db")?; @@ -2823,7 +2829,7 @@ pub async fn payout_create_db_entries( pub async fn make_payout_data( _state: &SessionState, _merchant_context: &domain::MerchantContext, - _auth_profile_id: Option<common_utils::id_type::ProfileId>, + _auth_profile_id: Option<id_type::ProfileId>, _req: &payouts::PayoutRequest, locale: &str, ) -> RouterResult<PayoutData> { @@ -2834,7 +2840,7 @@ pub async fn make_payout_data( pub async fn make_payout_data( state: &SessionState, merchant_context: &domain::MerchantContext, - auth_profile_id: Option<common_utils::id_type::ProfileId>, + auth_profile_id: Option<id_type::ProfileId>, req: &payouts::PayoutRequest, locale: &str, ) -> RouterResult<PayoutData> { @@ -2842,7 +2848,9 @@ pub async fn make_payout_data( let merchant_id = merchant_context.get_merchant_account().get_id(); let payout_id = match req { payouts::PayoutRequest::PayoutActionRequest(r) => r.payout_id.clone(), - payouts::PayoutRequest::PayoutCreateRequest(r) => r.payout_id.clone().unwrap_or_default(), + payouts::PayoutRequest::PayoutCreateRequest(r) => { + r.payout_id.clone().unwrap_or(id_type::PayoutId::generate()) + } payouts::PayoutRequest::PayoutRetrieveRequest(r) => r.payout_id.clone(), }; @@ -2856,7 +2864,8 @@ pub async fn make_payout_data( .to_not_found_response(errors::ApiErrorResponse::PayoutNotFound)?; core_utils::validate_profile_id_from_auth_layer(auth_profile_id, &payouts)?; - let payout_attempt_id = utils::get_payout_attempt_id(payout_id, payouts.attempt_count); + let payout_attempt_id = + utils::get_payout_attempt_id(payouts.payout_id.get_string_repr(), payouts.attempt_count); let mut payout_attempt = db .find_payout_attempt_by_merchant_id_payout_attempt_id( @@ -2871,9 +2880,9 @@ pub async fn make_payout_data( // We have to do this because the function that is being used to create / get address is from payments // which expects a payment_id - let payout_id_as_payment_id_type = common_utils::id_type::PaymentId::try_from( - std::borrow::Cow::Owned(payouts.payout_id.clone()), - ) + let payout_id_as_payment_id_type = id_type::PaymentId::try_from(std::borrow::Cow::Owned( + payouts.payout_id.get_string_repr().to_string(), + )) .change_context(errors::ApiErrorResponse::InvalidRequestData { message: "payout_id contains invalid data".to_string(), }) @@ -2906,7 +2915,7 @@ pub async fn make_payout_data( .map_err(\|err\| err.change_context(errors::ApiErrorResponse::InternalServerError)) .attach_printable_lazy(\|\| { format!( - "Failed while fetching optional customer [id - {:?}] for payout [id - {}]", + "Failed while fetching optional customer [id - {:?}] for payout [id - {:?}]", customer_id, payout_id ) }) @@ -3079,8 +3088,8 @@ pub async fn add_external_account_addition_task( async fn validate_and_get_business_profile( state: &SessionState, merchant_key_store: &domain::MerchantKeyStore, - profile_id: &common_utils::id_type::ProfileId, - merchant_id: &common_utils::id_type::MerchantId, + profile_id: &id_type::ProfileId, + merchant_id: &id_type::MerchantId, ) -> RouterResult<domain::Profile> { let db = &state.store; let key_manager_state = &state.into(); @@ -3108,10 +3117,10 @@ async fn validate_and_get_business_profile( pub async fn create_payout_link( state: &SessionState, business_profile: &domain::Profile, - customer_id: &CustomerId, - merchant_id: &common_utils::id_type::MerchantId, + customer_id: &id_type::CustomerId, + merchant_id: &id_type::MerchantId, req: &payouts::PayoutCreateRequest, - payout_id: &str, + payout_id: &id_type::PayoutId, locale: &str, ) -> RouterResult<PayoutLink> { let payout_link_config_req = req.payout_link_config.to_owned(); @@ -3175,7 +3184,7 @@ pub async fn create_payout_link( .as_ref() .map_or(default_config.expiry, \|expiry\| expiry); let url = format!( - "{base_url}/payout_link/{}/{payout_id}?locale={}", + "{base_url}/payout_link/{}/{payout_id:?}?locale={}", merchant_id.get_string_repr(), locale ); @@ -3214,7 +3223,7 @@ pub async fn create_payout_link( let data = PayoutLinkData { payout_link_id: payout_link_id.clone(), customer_id: customer_id.clone(), - payout_id: payout_id.to_string(), + payout_id: payout_id.clone(), link, client_secret: Secret::new(client_secret), session_expiry, @@ -3232,7 +3241,7 @@ pub async fn create_payout_link( pub async fn create_payout_link_db_entry( state: &SessionState, - merchant_id: &common_utils::id_type::MerchantId, + merchant_id: &id_type::MerchantId, payout_link_data: &PayoutLinkData, return_url: Option<String>, ) -> RouterResult<PayoutLink> { @@ -3244,7 +3253,7 @@ pub async fn create_payout_link_db_entry( let payout_link = GenericLinkNew { link_id: payout_link_data.payout_link_id.to_string(), - primary_reference: payout_link_data.payout_id.to_string(), + primary_reference: payout_link_data.payout_id.get_string_repr().to_string(), merchant_id: merchant_id.to_owned(), link_type: common_enums::GenericLinkType::PayoutLink, link_status: GenericLinkStatus::PayoutLink(PayoutLinkStatus::Initiated), @@ -3267,9 +3276,9 @@ pub async fn create_payout_link_db_entry( pub async fn get_mca_from_profile_id( state: &SessionState, merchant_context: &domain::MerchantContext, - profile_id: &common_utils::id_type::ProfileId, + profile_id: &id_type::ProfileId, connector_name: &str, - merchant_connector_id: Option<&common_utils::id_type::MerchantConnectorAccountId>, + merchant_connector_id: Option<&id_type::MerchantConnectorAccountId>, ) -> RouterResult<payment_helpers::MerchantConnectorAccountType> { let merchant_connector_account = payment_helpers::get_merchant_connector_account( state, diff --git a/crates/router/src/core/payouts/helpers.rs b/crates/router/src/core/payouts/helpers.rs index 1003ee699f2..9e006ed9ce4 100644 --- a/crates/router/src/core/payouts/helpers.rs +++ b/crates/router/src/core/payouts/helpers.rs @@ -1201,7 +1201,8 @@ pub async fn update_payouts_and_payout_attempt( return Err(report!(errors::ApiErrorResponse::InvalidRequestData { message: format!( "Payout {} cannot be updated for status {}", - payout_id, status + payout_id.get_string_repr(), + status ), })); } @@ -1226,12 +1227,13 @@ pub async fn update_payouts_and_payout_attempt( // We have to do this because the function that is being used to create / get address is from payments // which expects a payment_id - let payout_id_as_payment_id_type = - id_type::PaymentId::try_from(std::borrow::Cow::Owned(payout_id.clone())) - .change_context(errors::ApiErrorResponse::InvalidRequestData { - message: "payout_id contains invalid data".to_string(), - }) - .attach_printable("Error converting payout_id to PaymentId type")?; + let payout_id_as_payment_id_type = id_type::PaymentId::try_from(std::borrow::Cow::Owned( + payout_id.get_string_repr().to_string(), + )) + .change_context(errors::ApiErrorResponse::InvalidRequestData { + message: "payout_id contains invalid data for PaymentId conversion".to_string(), + }) + .attach_printable("Error converting payout_id to PaymentId type")?; // Fetch address details from request and create new or else use existing address that was attached let billing_address = payment_helpers::create_or_find_address_for_payment_by_request( diff --git a/crates/router/src/core/payouts/retry.rs b/crates/router/src/core/payouts/retry.rs index 3b5e93eaf11..30100a580d4 100644 --- a/crates/router/src/core/payouts/retry.rs +++ b/crates/router/src/core/payouts/retry.rs @@ -269,12 +269,18 @@ pub async fn modify_trackers( .change_context(errors::ApiErrorResponse::InternalServerError) .attach_printable("Error updating payouts")?; - let payout_attempt_id = - utils::get_payout_attempt_id(payout_id.to_owned(), payout_data.payouts.attempt_count); + let payout_attempt_id = utils::get_payout_attempt_id( + payout_id.get_string_repr(), + payout_data.payouts.attempt_count, + ); let payout_attempt_req = storage::PayoutAttemptNew { payout_attempt_id: payout_attempt_id.to_string(), payout_id: payout_id.to_owned(), + merchant_order_reference_id: payout_data + .payout_attempt + .merchant_order_reference_id + .clone(), customer_id: payout_data.payout_attempt.customer_id.to_owned(), connector: Some(connector.connector_name.to_string()), merchant_id: payout_data.payout_attempt.merchant_id.to_owned(), diff --git a/crates/router/src/core/payouts/transformers.rs b/crates/router/src/core/payouts/transformers.rs index a1c92ec3b29..7040559d9f4 100644 --- a/crates/router/src/core/payouts/transformers.rs +++ b/crates/router/src/core/payouts/transformers.rs @@ -69,6 +69,7 @@ impl payout_id: payout.payout_id, merchant_id: payout.merchant_id, merchant_connector_id: payout_attempt.merchant_connector_id, + merchant_order_reference_id: payout_attempt.merchant_order_reference_id.clone(), amount: payout.amount, currency: payout.destination_currency, connector: payout_attempt.connector, diff --git a/crates/router/src/core/payouts/validator.rs b/crates/router/src/core/payouts/validator.rs index 35c4599dbc2..1af3f4d2cb5 100644 --- a/crates/router/src/core/payouts/validator.rs +++ b/crates/router/src/core/payouts/validator.rs @@ -3,7 +3,10 @@ use std::collections::HashSet; use actix_web::http::header; #[cfg(feature = "olap")] use common_utils::errors::CustomResult; -use common_utils::validation::validate_domain_against_allowed_domains; +use common_utils::{ + id_type::{self, GenerateId}, + validation::validate_domain_against_allowed_domains, +}; use diesel_models::generic_link::PayoutLink; use error_stack::{report, ResultExt}; use hyperswitch_domain_models::payment_methods::PaymentMethod; @@ -29,8 +32,8 @@ use crate::{ #[instrument(skip(db))] pub async fn validate_uniqueness_of_payout_id_against_merchant_id( db: &dyn StorageInterface, - payout_id: &str, - merchant_id: &common_utils::id_type::MerchantId, + payout_id: &id_type::PayoutId, + merchant_id: &id_type::MerchantId, storage_scheme: storage::enums::MerchantStorageScheme, ) -> RouterResult<Option<storage::Payouts>> { let maybe_payouts = db @@ -75,9 +78,9 @@ pub async fn validate_create_request( merchant_context: &domain::MerchantContext, req: &payouts::PayoutCreateRequest, ) -> RouterResult<( - String, + id_type::PayoutId, Option<payouts::PayoutMethodData>, - common_utils::id_type::ProfileId, + id_type::ProfileId, Option<domain::Customer>, Option<PaymentMethod>, )> { @@ -101,7 +104,11 @@ pub async fn validate_create_request( // Payout ID let db: &dyn StorageInterface = &state.store; - let payout_id = core_utils::get_or_generate_uuid("payout_id", req.payout_id.as_ref())?; + let payout_id = match req.payout_id.as_ref() { + Some(provided_payout_id) => provided_payout_id.clone(), + None => id_type::PayoutId::generate(), + }; + match validate_uniqueness_of_payout_id_against_merchant_id( db, &payout_id, @@ -111,13 +118,12 @@ pub async fn validate_create_request( .await .attach_printable_lazy(\|\| { format!( - "Unique violation while checking payout_id: {} against merchant_id: {:?}", - payout_id.to_owned(), - merchant_id + "Unique violation while checking payout_id: {:?} against merchant_id: {:?}", + payout_id, merchant_id ) })? { Some(_) => Err(report!(errors::ApiErrorResponse::DuplicatePayout { - payout_id: payout_id.to_owned() + payout_id: payout_id.clone() })), None => Ok(()), }?; diff --git a/crates/router/src/core/utils.rs b/crates/router/src/core/utils.rs index 17ac3f9abd0..d0a27406eb5 100644 --- a/crates/router/src/core/utils.rs +++ b/crates/router/src/core/utils.rs @@ -34,7 +34,6 @@ use masking::{ExposeInterface, PeekInterface}; use maud::{html, PreEscaped}; use regex::Regex; use router_env::{instrument, tracing}; -use uuid::Uuid; use super::payments::helpers; #[cfg(feature = "payouts")] @@ -57,7 +56,7 @@ use crate::{ storage::{self, enums}, PollConfig, }, - utils::{generate_id, generate_uuid, OptionExt, ValueExt}, + utils::{generate_id, OptionExt, ValueExt}, }; pub const IRRELEVANT_CONNECTOR_REQUEST_REFERENCE_ID_IN_DISPUTE_FLOW: &str = @@ -188,7 +187,7 @@ pub async fn construct_payout_router_data<'a, F>( minor_amount_captured: None, payment_method_status: None, request: types::PayoutsData { - payout_id: payouts.payout_id.to_owned(), + payout_id: payouts.payout_id.clone(), amount: payouts.amount.get_amount_as_i64(), minor_amount: payouts.amount, connector_payout_id: payout_attempt.connector_payout_id.clone(), @@ -622,16 +621,6 @@ pub fn get_or_generate_id( .map_or(Ok(generate_id(consts::ID_LENGTH, prefix)), validate_id) } -pub fn get_or_generate_uuid( - key: &str, - provided_id: Option<&String>, -) -> Result<String, errors::ApiErrorResponse> { - let validate_id = \|id: String\| validate_uuid(id, key); - provided_id - .cloned() - .map_or(Ok(generate_uuid()), validate_id) -} - fn invalid_id_format_error(key: &str) -> errors::ApiErrorResponse { errors::ApiErrorResponse::InvalidDataFormat { field_name: key.to_string(), @@ -650,13 +639,6 @@ pub fn validate_id(id: String, key: &str) -> Result<String, errors::ApiErrorResp } } -pub fn validate_uuid(uuid: String, key: &str) -> Result<String, errors::ApiErrorResponse> { - match (Uuid::parse_str(&uuid), uuid.len() > consts::MAX_ID_LENGTH) { - (Ok(_), false) => Ok(uuid), - (_, _) => Err(invalid_id_format_error(key)), - } -} - #[cfg(feature = "v1")] pub fn get_split_refunds( split_refund_input: refunds_transformers::SplitRefundInput, diff --git a/crates/router/src/core/webhooks/incoming.rs b/crates/router/src/core/webhooks/incoming.rs index 5fef952532f..cc1dc7bc506 100644 --- a/crates/router/src/core/webhooks/incoming.rs +++ b/crates/router/src/core/webhooks/incoming.rs @@ -997,7 +997,10 @@ async fn payouts_incoming_webhook_flow( business_profile, outgoing_event_type, enums::EventClass::Payouts, - updated_payout_attempt.payout_id.clone(), + updated_payout_attempt + .payout_id + .get_string_repr() + .to_string(), enums::EventObjectType::PayoutDetails, api::OutgoingWebhookContent::PayoutDetails(Box::new(payout_create_response)), Some(updated_payout_attempt.created_at), diff --git a/crates/router/src/db/kafka_store.rs b/crates/router/src/db/kafka_store.rs index 48d0d582abb..7f24d2f5c99 100644 --- a/crates/router/src/db/kafka_store.rs +++ b/crates/router/src/db/kafka_store.rs @@ -2325,6 +2325,22 @@ impl PayoutAttemptInterface for KafkaStore {} #[async_trait::async_trait] impl PayoutAttemptInterface for KafkaStore { type Error = errors::StorageError; + + async fn find_payout_attempt_by_merchant_id_merchant_order_reference_id( + &self, + merchant_id: &id_type::MerchantId, + merchant_order_reference_id: &str, + storage_scheme: MerchantStorageScheme, + ) -> CustomResult<storage::PayoutAttempt, errors::StorageError> { + self.diesel_store + .find_payout_attempt_by_merchant_id_merchant_order_reference_id( + merchant_id, + merchant_order_reference_id, + storage_scheme, + ) + .await + } + async fn find_payout_attempt_by_merchant_id_payout_attempt_id( &self, merchant_id: &id_type::MerchantId, @@ -2431,7 +2447,7 @@ impl PayoutsInterface for KafkaStore { async fn find_payout_by_merchant_id_payout_id( &self, merchant_id: &id_type::MerchantId, - payout_id: &str, + payout_id: &id_type::PayoutId, storage_scheme: MerchantStorageScheme, ) -> CustomResult<storage::Payouts, errors::StorageError> { self.diesel_store @@ -2477,7 +2493,7 @@ impl PayoutsInterface for KafkaStore { async fn find_optional_payout_by_merchant_id_payout_id( &self, merchant_id: &id_type::MerchantId, - payout_id: &str, + payout_id: &id_type::PayoutId, storage_scheme: MerchantStorageScheme, ) -> CustomResult<Option<storage::Payouts>, errors::StorageError> { self.diesel_store @@ -2533,7 +2549,7 @@ impl PayoutsInterface for KafkaStore { async fn get_total_count_of_filtered_payouts( &self, merchant_id: &id_type::MerchantId, - active_payout_ids: &[String], + active_payout_ids: &[id_type::PayoutId], connector: Option<Vec<api_models::enums::PayoutConnectors>>, currency: Option<Vec<enums::Currency>>, status: Option<Vec<enums::PayoutStatus>>, @@ -2556,7 +2572,7 @@ impl PayoutsInterface for KafkaStore { &self, merchant_id: &id_type::MerchantId, constraints: &hyperswitch_domain_models::payouts::PayoutFetchConstraints, - ) -> CustomResult<Vec<String>, errors::StorageError> { + ) -> CustomResult<Vec<id_type::PayoutId>, errors::StorageError> { self.diesel_store .filter_active_payout_ids_by_constraints(merchant_id, constraints) .await diff --git a/crates/router/src/events/outgoing_webhook_logs.rs b/crates/router/src/events/outgoing_webhook_logs.rs index 7574332f778..43f2ae54be4 100644 --- a/crates/router/src/events/outgoing_webhook_logs.rs +++ b/crates/router/src/events/outgoing_webhook_logs.rs @@ -38,7 +38,7 @@ pub enum OutgoingWebhookEventContent { content: Value, }, Payout { - payout_id: String, + payout_id: common_utils::id_type::PayoutId, content: Value, }, #[cfg(feature = "v1")] diff --git a/crates/router/src/routes/payout_link.rs b/crates/router/src/routes/payout_link.rs index 0727890bb32..71e3439d337 100644 --- a/crates/router/src/routes/payout_link.rs +++ b/crates/router/src/routes/payout_link.rs @@ -15,7 +15,10 @@ use crate::{ pub async fn render_payout_link( state: web::Data<AppState>, req: actix_web::HttpRequest, - path: web::Path<(common_utils::id_type::MerchantId, String)>, + path: web::Path<( + common_utils::id_type::MerchantId, + common_utils::id_type::PayoutId, + )>, ) -> impl Responder { let flow = Flow::PayoutLinkInitiate; let (merchant_id, payout_id) = path.into_inner(); diff --git a/crates/router/src/routes/payouts.rs b/crates/router/src/routes/payouts.rs index be0aa027d70..5bccdd06668 100644 --- a/crates/router/src/routes/payouts.rs +++ b/crates/router/src/routes/payouts.rs @@ -2,6 +2,7 @@ use actix_web::{ body::{BoxBody, MessageBody}, web, HttpRequest, HttpResponse, Responder, }; +use common_utils::id_type; use router_env::{instrument, tracing, Flow}; use super::app::AppState; @@ -50,7 +51,7 @@ pub async fn payouts_create( pub async fn payouts_retrieve( state: web::Data<AppState>, req: HttpRequest, - path: web::Path<String>, + path: web::Path<id_type::PayoutId>, query_params: web::Query<payout_types::PayoutRetrieveBody>, ) -> HttpResponse { let payout_retrieve_request = payout_types::PayoutRetrieveRequest { @@ -90,7 +91,7 @@ pub async fn payouts_retrieve( pub async fn payouts_update( state: web::Data<AppState>, req: HttpRequest, - path: web::Path<String>, + path: web::Path<id_type::PayoutId>, json_payload: web::Json<payout_types::PayoutCreateRequest>, ) -> HttpResponse { let flow = Flow::PayoutsUpdate; @@ -122,12 +123,12 @@ pub async fn payouts_confirm( state: web::Data<AppState>, req: HttpRequest, json_payload: web::Json<payout_types::PayoutCreateRequest>, - path: web::Path<String>, + path: web::Path<id_type::PayoutId>, ) -> HttpResponse { let flow = Flow::PayoutsConfirm; let mut payload = json_payload.into_inner(); let payout_id = path.into_inner(); - tracing::Span::current().record("payout_id", &payout_id); + tracing::Span::current().record("payout_id", payout_id.get_string_repr()); payload.payout_id = Some(payout_id); payload.confirm = Some(true); let api_auth = auth::ApiKeyAuth::default(); @@ -160,12 +161,12 @@ pub async fn payouts_confirm( pub async fn payouts_cancel( state: web::Data<AppState>, req: HttpRequest, - json_payload: web::Json<payout_types::PayoutActionRequest>, - path: web::Path<String>, + path: web::Path<id_type::PayoutId>, ) -> HttpResponse { let flow = Flow::PayoutsCancel; - let mut payload = json_payload.into_inner(); - payload.payout_id = path.into_inner(); + let payload = payout_types::PayoutActionRequest { + payout_id: path.into_inner(), + }; Box::pin(api::server_wrap( flow, @@ -191,12 +192,12 @@ pub async fn payouts_cancel( pub async fn payouts_fulfill( state: web::Data<AppState>, req: HttpRequest, - json_payload: web::Json<payout_types::PayoutActionRequest>, - path: web::Path<String>, + path: web::Path<id_type::PayoutId>, ) -> HttpResponse { let flow = Flow::PayoutsFulfill; - let mut payload = json_payload.into_inner(); - payload.payout_id = path.into_inner(); + let payload = payout_types::PayoutActionRequest { + payout_id: path.into_inner(), + }; Box::pin(api::server_wrap( flow, diff --git a/crates/router/src/services/kafka/payout.rs b/crates/router/src/services/kafka/payout.rs index babf7c1c568..e27009b3989 100644 --- a/crates/router/src/services/kafka/payout.rs +++ b/crates/router/src/services/kafka/payout.rs @@ -5,7 +5,7 @@ use time::OffsetDateTime; #[derive(serde::Serialize, Debug)] pub struct KafkaPayout<'a> { - pub payout_id: &'a String, + pub payout_id: &'a id_type::PayoutId, pub payout_attempt_id: &'a String, pub merchant_id: &'a id_type::MerchantId, pub customer_id: Option<&'a id_type::CustomerId>, diff --git a/crates/router/src/utils.rs b/crates/router/src/utils.rs index f89dbbec70a..a733de87656 100644 --- a/crates/router/src/utils.rs +++ b/crates/router/src/utils.rs @@ -41,7 +41,6 @@ use nanoid::nanoid; use serde::de::DeserializeOwned; use serde_json::Value; use tracing_futures::Instrument; -use uuid::Uuid; pub use self::ext_traits::{OptionExt, ValidateCall}; use crate::{ @@ -115,11 +114,6 @@ pub fn generate_id(length: usize, prefix: &str) -> String { format!("{}_{}", prefix, nanoid!(length, &consts::ALPHABETS)) } -#[inline] -pub fn generate_uuid() -> String { - Uuid::new_v4().to_string() -} - pub trait ConnectorResponseExt: Sized { fn get_response(self) -> RouterResult<types::Response>; fn get_error_response(self) -> RouterResult<types::Response>; @@ -164,7 +158,7 @@ impl<E> ConnectorResponseExt } #[inline] -pub fn get_payout_attempt_id(payout_id: impl std::fmt::Display, attempt_count: i16) -> String { +pub fn get_payout_attempt_id(payout_id: &str, attempt_count: i16) -> String { format!("{payout_id}_{attempt_count}") } @@ -1356,7 +1350,7 @@ pub async fn trigger_payouts_webhook( business_profile, event_type, diesel_models::enums::EventClass::Payouts, - cloned_response.payout_id.clone(), + cloned_response.payout_id.get_string_repr().to_owned(), diesel_models::enums::EventObjectType::PayoutDetails, webhooks::OutgoingWebhookContent::PayoutDetails(Box::new(cloned_response)), primary_object_created_at, diff --git a/crates/router/src/workflows/outgoing_webhook_retry.rs b/crates/router/src/workflows/outgoing_webhook_retry.rs index 8a04094f31d..243c7382023 100644 --- a/crates/router/src/workflows/outgoing_webhook_retry.rs +++ b/crates/router/src/workflows/outgoing_webhook_retry.rs @@ -8,6 +8,7 @@ use api_models::{ use common_utils::{ consts::DEFAULT_LOCALE, ext_traits::{StringExt, ValueExt}, + id_type, }; use diesel_models::process_tracker::business_status; use error_stack::ResultExt; @@ -283,7 +284,7 @@ impl ProcessTrackerWorkflow<SessionState> for OutgoingWebhookRetryWorkflow { #[instrument(skip_all)] pub(crate) async fn get_webhook_delivery_retry_schedule_time( db: &dyn StorageInterface, - merchant_id: &common_utils::id_type::MerchantId, + merchant_id: &id_type::MerchantId, retry_count: i32, ) -> Option<time::PrimitiveDateTime> { let key = "pt_mapping_outgoing_webhooks"; @@ -329,7 +330,7 @@ pub(crate) async fn get_webhook_delivery_retry_schedule_time( #[instrument(skip_all)] pub(crate) async fn retry_webhook_delivery_task( db: &dyn StorageInterface, - merchant_id: &common_utils::id_type::MerchantId, + merchant_id: &id_type::MerchantId, process: storage::ProcessTracker, ) -> errors::CustomResult<(), errors::StorageError> { let schedule_time = @@ -385,15 +386,14 @@ async fn get_outgoing_webhook_content_and_event_type( match tracking_data.event_class { diesel_models::enums::EventClass::Payments => { let payment_id = tracking_data.primary_object_id.clone(); - let payment_id = - common_utils::id_type::PaymentId::try_from(std::borrow::Cow::Owned(payment_id)) - .map_err(\|payment_id_parsing_error\| { - logger::error!( - ?payment_id_parsing_error, - "Failed to parse payment ID from tracking data" - ); - errors::ProcessTrackerError::DeserializationFailed - })?; + let payment_id = id_type::PaymentId::try_from(std::borrow::Cow::Owned(payment_id)) + .map_err(\|payment_id_parsing_error\| { + logger::error!( + ?payment_id_parsing_error, + "Failed to parse payment ID from tracking data" + ); + errors::ProcessTrackerError::DeserializationFailed + })?; let request = PaymentsRetrieveRequest { resource_id: PaymentIdType::PaymentIntentId(payment_id), merchant_id: Some(tracking_data.merchant_id.clone()), @@ -539,7 +539,9 @@ async fn get_outgoing_webhook_content_and_event_type( diesel_models::enums::EventClass::Payouts => { let payout_id = tracking_data.primary_object_id.clone(); let request = payout_models::PayoutRequest::PayoutActionRequest( - payout_models::PayoutActionRequest { payout_id }, + payout_models::PayoutActionRequest { + payout_id: id_type::PayoutId::try_from(std::borrow::Cow::Owned(payout_id))?, + }, ); let payout_data = Box::pin(payouts::make_payout_data( diff --git a/crates/router/tests/connectors/utils.rs b/crates/router/tests/connectors/utils.rs index 4bc234cca24..bf9bc355334 100644 --- a/crates/router/tests/connectors/utils.rs +++ b/crates/router/tests/connectors/utils.rs @@ -1,11 +1,9 @@ use std::{fmt::Debug, marker::PhantomData, str::FromStr, sync::Arc, time::Duration}; use async_trait::async_trait; -use common_utils::pii::Email; +use common_utils::{id_type::GenerateId, pii::Email}; use error_stack::Report; use masking::Secret; -#[cfg(feature = "payouts")] -use router::core::utils as core_utils; use router::{ configs::settings::Settings, core::{errors::ConnectorError, payments}, @@ -454,8 +452,7 @@ pub trait ConnectorActions: Connector { ) -> RouterData<Flow, types::PayoutsData, Res> { self.generate_data( types::PayoutsData { - payout_id: core_utils::get_or_generate_uuid("payout_id", None) - .map_or("payout_3154763247".to_string(), \|p\| p), + payout_id: common_utils::id_type::PayoutId::generate(), amount: 1, minor_amount: MinorUnit::new(1), connector_payout_id, diff --git a/crates/storage_impl/src/lib.rs b/crates/storage_impl/src/lib.rs index 156ebee2dea..b2a2dba5779 100644 --- a/crates/storage_impl/src/lib.rs +++ b/crates/storage_impl/src/lib.rs @@ -427,7 +427,7 @@ impl UniqueConstraints for diesel_models::Payouts { vec![format!( "po_{}_{}", self.merchant_id.get_string_repr(), - self.payout_id + self.payout_id.get_string_repr() )] } fn table_name(&self) -> &str { diff --git a/crates/storage_impl/src/mock_db/payout_attempt.rs b/crates/storage_impl/src/mock_db/payout_attempt.rs index 1fd2058e95a..008e9f921b0 100644 --- a/crates/storage_impl/src/mock_db/payout_attempt.rs +++ b/crates/storage_impl/src/mock_db/payout_attempt.rs @@ -65,4 +65,13 @@ impl PayoutAttemptInterface for MockDb { > { Err(StorageError::MockDbError)? } + + async fn find_payout_attempt_by_merchant_id_merchant_order_reference_id( + &self, + _merchant_id: &common_utils::id_type::MerchantId, + _merchant_order_reference_id: &str, + _storage_scheme: storage_enums::MerchantStorageScheme, + ) -> CustomResult<PayoutAttempt, StorageError> { + Err(StorageError::MockDbError)? + } } diff --git a/crates/storage_impl/src/mock_db/payouts.rs b/crates/storage_impl/src/mock_db/payouts.rs index ecba8f88df6..648e09bd5c6 100644 --- a/crates/storage_impl/src/mock_db/payouts.rs +++ b/crates/storage_impl/src/mock_db/payouts.rs @@ -13,7 +13,7 @@ impl PayoutsInterface for MockDb { async fn find_payout_by_merchant_id_payout_id( &self, _merchant_id: &common_utils::id_type::MerchantId, - _payout_id: &str, + _payout_id: &common_utils::id_type::PayoutId, _storage_scheme: storage_enums::MerchantStorageScheme, ) -> CustomResult<Payouts, StorageError> { // TODO: Implement function for `MockDb` @@ -43,7 +43,7 @@ impl PayoutsInterface for MockDb { async fn find_optional_payout_by_merchant_id_payout_id( &self, _merchant_id: &common_utils::id_type::MerchantId, - _payout_id: &str, + _payout_id: &common_utils::id_type::PayoutId, _storage_scheme: storage_enums::MerchantStorageScheme, ) -> CustomResult<Option<Payouts>, StorageError> { // TODO: Implement function for `MockDb` @@ -95,7 +95,7 @@ impl PayoutsInterface for MockDb { async fn get_total_count_of_filtered_payouts( &self, _merchant_id: &common_utils::id_type::MerchantId, - _active_payout_ids: &[String], + _active_payout_ids: &[common_utils::id_type::PayoutId], _connector: Option<Vec<api_models::enums::PayoutConnectors>>, _currency: Option<Vec<storage_enums::Currency>>, _status: Option<Vec<storage_enums::PayoutStatus>>, @@ -110,7 +110,7 @@ impl PayoutsInterface for MockDb { &self, _merchant_id: &common_utils::id_type::MerchantId, _constraints: &hyperswitch_domain_models::payouts::PayoutFetchConstraints, - ) -> CustomResult<Vec<String>, StorageError> { + ) -> CustomResult<Vec<common_utils::id_type::PayoutId>, StorageError> { // TODO: Implement function for `MockDb` Err(StorageError::MockDbError)? } diff --git a/crates/storage_impl/src/payouts/payout_attempt.rs b/crates/storage_impl/src/payouts/payout_attempt.rs index e1706fad124..35939c11323 100644 --- a/crates/storage_impl/src/payouts/payout_attempt.rs +++ b/crates/storage_impl/src/payouts/payout_attempt.rs @@ -60,7 +60,7 @@ impl<T: DatabaseStore> PayoutAttemptInterface for KVRouterStore<T> { let payout_attempt_id = new_payout_attempt.payout_id.clone(); let key = PartitionKey::MerchantIdPayoutAttemptId { merchant_id: &merchant_id, - payout_attempt_id: &payout_attempt_id, + payout_attempt_id: payout_attempt_id.get_string_repr(), }; let key_str = key.to_string(); let created_attempt = PayoutAttempt { @@ -88,6 +88,9 @@ impl<T: DatabaseStore> PayoutAttemptInterface for KVRouterStore<T> { routing_info: new_payout_attempt.routing_info.clone(), unified_code: new_payout_attempt.unified_code.clone(), unified_message: new_payout_attempt.unified_message.clone(), + merchant_order_reference_id: new_payout_attempt + .merchant_order_reference_id + .clone(), }; let redis_entry = kv::TypedSql { @@ -149,7 +152,7 @@ impl<T: DatabaseStore> PayoutAttemptInterface for KVRouterStore<T> { ) -> error_stack::Result<PayoutAttempt, errors::StorageError> { let key = PartitionKey::MerchantIdPayoutAttemptId { merchant_id: &this.merchant_id, - payout_attempt_id: &this.payout_id, + payout_attempt_id: this.payout_id.get_string_repr(), }; let field = format!("poa_{}", this.payout_attempt_id); let storage_scheme = Box::pin(decide_storage_scheme::<_, DieselPayoutAttempt>( @@ -378,6 +381,22 @@ impl<T: DatabaseStore> PayoutAttemptInterface for KVRouterStore<T> { .get_filters_for_payouts(payouts, merchant_id, storage_scheme) .await } + + #[instrument(skip_all)] + async fn find_payout_attempt_by_merchant_id_merchant_order_reference_id( + &self, + merchant_id: &common_utils::id_type::MerchantId, + merchant_order_reference_id: &str, + storage_scheme: MerchantStorageScheme, + ) -> error_stack::Result<PayoutAttempt, errors::StorageError> { + self.router_store + .find_payout_attempt_by_merchant_id_merchant_order_reference_id( + merchant_id, + merchant_order_reference_id, + storage_scheme, + ) + .await + } } #[async_trait::async_trait] @@ -504,6 +523,27 @@ impl<T: DatabaseStore> PayoutAttemptInterface for crate::RouterStore<T> { }, ) } + + #[instrument(skip_all)] + async fn find_payout_attempt_by_merchant_id_merchant_order_reference_id( + &self, + merchant_id: &common_utils::id_type::MerchantId, + merchant_order_reference_id: &str, + _storage_scheme: MerchantStorageScheme, + ) -> error_stack::Result<PayoutAttempt, errors::StorageError> { + let conn = pg_connection_read(self).await?; + DieselPayoutAttempt::find_by_merchant_id_merchant_order_reference_id( + &conn, + merchant_id, + merchant_order_reference_id, + ) + .await + .map(PayoutAttempt::from_storage_model) + .map_err(\|er\| { + let new_err = diesel_error_to_data_error(er.current_context()); + er.change_context(new_err) + }) + } } impl DataModelExt for PayoutAttempt { @@ -533,6 +573,7 @@ impl DataModelExt for PayoutAttempt { unified_code: self.unified_code, unified_message: self.unified_message, additional_payout_method_data: self.additional_payout_method_data, + merchant_order_reference_id: self.merchant_order_reference_id, } } @@ -560,6 +601,7 @@ impl DataModelExt for PayoutAttempt { unified_code: storage_model.unified_code, unified_message: storage_model.unified_message, additional_payout_method_data: storage_model.additional_payout_method_data, + merchant_order_reference_id: storage_model.merchant_order_reference_id, } } } @@ -590,6 +632,7 @@ impl DataModelExt for PayoutAttemptNew { unified_code: self.unified_code, unified_message: self.unified_message, additional_payout_method_data: self.additional_payout_method_data, + merchant_order_reference_id: self.merchant_order_reference_id, } } @@ -617,6 +660,7 @@ impl DataModelExt for PayoutAttemptNew { unified_code: storage_model.unified_code, unified_message: storage_model.unified_message, additional_payout_method_data: storage_model.additional_payout_method_data, + merchant_order_reference_id: storage_model.merchant_order_reference_id, } } } diff --git a/crates/storage_impl/src/payouts/payouts.rs b/crates/storage_impl/src/payouts/payouts.rs index 484328aabab..c9d16b7d8a2 100644 --- a/crates/storage_impl/src/payouts/payouts.rs +++ b/crates/storage_impl/src/payouts/payouts.rs @@ -80,7 +80,7 @@ impl<T: DatabaseStore> PayoutsInterface for KVRouterStore<T> { payout_id: &payout_id, }; let key_str = key.to_string(); - let field = format!("po_{}", new.payout_id); + let field = format!("po_{}", new.payout_id.get_string_repr()); let created_payout = Payouts { payout_id: new.payout_id.clone(), merchant_id: new.merchant_id.clone(), @@ -151,7 +151,7 @@ impl<T: DatabaseStore> PayoutsInterface for KVRouterStore<T> { merchant_id: &this.merchant_id, payout_id: &this.payout_id, }; - let field = format!("po_{}", this.payout_id); + let field = format!("po_{}", this.payout_id.get_string_repr()); let storage_scheme = Box::pin(decide_storage_scheme::<_, DieselPayouts>( self, storage_scheme, @@ -207,7 +207,7 @@ impl<T: DatabaseStore> PayoutsInterface for KVRouterStore<T> { async fn find_payout_by_merchant_id_payout_id( &self, merchant_id: &common_utils::id_type::MerchantId, - payout_id: &str, + payout_id: &common_utils::id_type::PayoutId, storage_scheme: MerchantStorageScheme, ) -> error_stack::Result<Payouts, StorageError> { let database_call = \|\| async { @@ -232,7 +232,7 @@ impl<T: DatabaseStore> PayoutsInterface for KVRouterStore<T> { merchant_id, payout_id, }; - let field = format!("po_{payout_id}"); + let field = format!("po_{}", payout_id.get_string_repr()); Box::pin(utils::try_redis_get_else_try_database_get( async { Box::pin(kv_wrapper::<DieselPayouts, _, _>( @@ -255,7 +255,7 @@ impl<T: DatabaseStore> PayoutsInterface for KVRouterStore<T> { async fn find_optional_payout_by_merchant_id_payout_id( &self, merchant_id: &common_utils::id_type::MerchantId, - payout_id: &str, + payout_id: &common_utils::id_type::PayoutId, storage_scheme: MerchantStorageScheme, ) -> error_stack::Result<Option<Payouts>, StorageError> { let database_call = \|\| async { @@ -276,20 +276,14 @@ impl<T: DatabaseStore> PayoutsInterface for KVRouterStore<T> { match storage_scheme { MerchantStorageScheme::PostgresOnly => { let maybe_payouts = database_call().await?; - Ok(maybe_payouts.and_then(\|payout\| { - if payout.payout_id == payout_id { - Some(payout) - } else { - None - } - })) + Ok(maybe_payouts.filter(\|payout\| &payout.payout_id == payout_id)) } MerchantStorageScheme::RedisKv => { let key = PartitionKey::MerchantIdPayoutId { merchant_id, payout_id, }; - let field = format!("po_{payout_id}"); + let field = format!("po_{}", payout_id.get_string_repr()); Box::pin(utils::try_redis_get_else_try_database_get( async { Box::pin(kv_wrapper::<DieselPayouts, _, _>( @@ -360,7 +354,7 @@ impl<T: DatabaseStore> PayoutsInterface for KVRouterStore<T> { async fn get_total_count_of_filtered_payouts( &self, merchant_id: &common_utils::id_type::MerchantId, - active_payout_ids: &[String], + active_payout_ids: &[common_utils::id_type::PayoutId], connector: Option<Vec<PayoutConnectors>>, currency: Option<Vec<storage_enums::Currency>>, status: Option<Vec<storage_enums::PayoutStatus>>, @@ -383,7 +377,7 @@ impl<T: DatabaseStore> PayoutsInterface for KVRouterStore<T> { &self, merchant_id: &common_utils::id_type::MerchantId, constraints: &PayoutFetchConstraints, - ) -> error_stack::Result<Vec<String>, StorageError> { + ) -> error_stack::Result<Vec<common_utils::id_type::PayoutId>, StorageError> { self.router_store .filter_active_payout_ids_by_constraints(merchant_id, constraints) .await @@ -434,7 +428,7 @@ impl<T: DatabaseStore> PayoutsInterface for crate::RouterStore<T> { async fn find_payout_by_merchant_id_payout_id( &self, merchant_id: &common_utils::id_type::MerchantId, - payout_id: &str, + payout_id: &common_utils::id_type::PayoutId, _storage_scheme: MerchantStorageScheme, ) -> error_stack::Result<Payouts, StorageError> { let conn = pg_connection_read(self).await?; @@ -451,7 +445,7 @@ impl<T: DatabaseStore> PayoutsInterface for crate::RouterStore<T> { async fn find_optional_payout_by_merchant_id_payout_id( &self, merchant_id: &common_utils::id_type::MerchantId, - payout_id: &str, + payout_id: &common_utils::id_type::PayoutId, _storage_scheme: MerchantStorageScheme, ) -> error_stack::Result<Option<Payouts>, StorageError> { let conn = pg_connection_read(self).await?; @@ -498,7 +492,7 @@ impl<T: DatabaseStore> PayoutsInterface for crate::RouterStore<T> { query = query.filter(po_dsl::profile_id.eq(profile_id.clone())); } - query = match (params.starting_at, &params.starting_after_id) { + query = match (params.starting_at, params.starting_after_id.as_ref()) { (Some(starting_at), _) => query.filter(po_dsl::created_at.ge(starting_at)), (None, Some(starting_after_id)) => { // TODO: Fetch partial columns for this query since we only need some columns @@ -515,7 +509,7 @@ impl<T: DatabaseStore> PayoutsInterface for crate::RouterStore<T> { (None, None) => query, }; - query = match (params.ending_at, &params.ending_before_id) { + query = match (params.ending_at, params.ending_before_id.as_ref()) { (Some(ending_at), _) => query.filter(po_dsl::created_at.le(ending_at)), (None, Some(ending_before_id)) => { // TODO: Fetch partial columns for this query since we only need some columns @@ -619,10 +613,18 @@ impl<T: DatabaseStore> PayoutsInterface for crate::RouterStore<T> { query = query.filter(po_dsl::profile_id.eq(profile_id.clone())); } - query = match (params.starting_at, &params.starting_after_id) { + if let Some(merchant_order_reference_id_filter) = + &params.merchant_order_reference_id + { + query = query.filter( + poa_dsl::merchant_order_reference_id + .eq(merchant_order_reference_id_filter.clone()), + ); + } + + query = match (params.starting_at, params.starting_after_id.as_ref()) { (Some(starting_at), _) => query.filter(po_dsl::created_at.ge(starting_at)), (None, Some(starting_after_id)) => { - // TODO: Fetch partial columns for this query since we only need some columns let starting_at = self .find_payout_by_merchant_id_payout_id( merchant_id, @@ -636,10 +638,9 @@ impl<T: DatabaseStore> PayoutsInterface for crate::RouterStore<T> { (None, None) => query, }; - query = match (params.ending_at, &params.ending_before_id) { + query = match (params.ending_at, params.ending_before_id.as_ref()) { (Some(ending_at), _) => query.filter(po_dsl::created_at.le(ending_at)), (None, Some(ending_before_id)) => { - // TODO: Fetch partial columns for this query since we only need some columns let ending_at = self .find_payout_by_merchant_id_payout_id( merchant_id, @@ -665,20 +666,24 @@ impl<T: DatabaseStore> PayoutsInterface for crate::RouterStore<T> { .map(\|c\| c.iter().map(\|c\| c.to_string()).collect::<Vec<String>>()); query = match connectors { - Some(connectors) => query.filter(poa_dsl::connector.eq_any(connectors)), - None => query, + Some(conn_filters) if !conn_filters.is_empty() => { + query.filter(poa_dsl::connector.eq_any(conn_filters)) + } + _ => query, }; query = match &params.status { - Some(status) => query.filter(po_dsl::status.eq_any(status.clone())), - None => query, + Some(status_filters) if !status_filters.is_empty() => { + query.filter(po_dsl::status.eq_any(status_filters.clone())) + } + _ => query, }; query = match &params.payout_method { - Some(payout_method) => { + Some(payout_method) if !payout_method.is_empty() => { query.filter(po_dsl::payout_type.eq_any(payout_method.clone())) } - None => query, + _ => query, }; query @@ -760,7 +765,7 @@ impl<T: DatabaseStore> PayoutsInterface for crate::RouterStore<T> { async fn get_total_count_of_filtered_payouts( &self, merchant_id: &common_utils::id_type::MerchantId, - active_payout_ids: &[String], + active_payout_ids: &[common_utils::id_type::PayoutId], connector: Option<Vec<PayoutConnectors>>, currency: Option<Vec<storage_enums::Currency>>, status: Option<Vec<storage_enums::PayoutStatus>>, @@ -800,7 +805,7 @@ impl<T: DatabaseStore> PayoutsInterface for crate::RouterStore<T> { &self, merchant_id: &common_utils::id_type::MerchantId, constraints: &PayoutFetchConstraints, - ) -> error_stack::Result<Vec<String>, StorageError> { + ) -> error_stack::Result<Vec<common_utils::id_type::PayoutId>, StorageError> { let conn = connection::pg_connection_read(self).await?; let conn = async_bb8_diesel::Connection::as_async_conn(&conn); let mut query = DieselPayouts::table() @@ -868,8 +873,14 @@ impl<T: DatabaseStore> PayoutsInterface for crate::RouterStore<T> { error_stack::report!(diesel_models::errors::DatabaseError::from(er)) .attach_printable("Error filtering payout records"), ) - .into() + })? + .into_iter() + .map(\|s\| { + common_utils::id_type::PayoutId::try_from(std::borrow::Cow::Owned(s)) + .change_context(StorageError::DeserializationFailed) + .attach_printable("Failed to deserialize PayoutId from database string") }) + .collect::<error_stack::Result<Vec<_>, _>>() } #[cfg(all(feature = "olap", feature = "v2"))] @@ -878,7 +889,7 @@ impl<T: DatabaseStore> PayoutsInterface for crate::RouterStore<T> { &self, _merchant_id: &common_utils::id_type::MerchantId, _constraints: &PayoutFetchConstraints, - ) -> error_stack::Result<Vec<String>, StorageError> { + ) -> error_stack::Result<Vec<common_utils::id_type::PayoutId>, StorageError> { todo!() } } diff --git a/crates/storage_impl/src/redis/kv_store.rs b/crates/storage_impl/src/redis/kv_store.rs index fd583f500ed..e7c47c58996 100644 --- a/crates/storage_impl/src/redis/kv_store.rs +++ b/crates/storage_impl/src/redis/kv_store.rs @@ -41,7 +41,7 @@ pub enum PartitionKey<'a> { }, MerchantIdPayoutId { merchant_id: &'a common_utils::id_type::MerchantId, - payout_id: &'a str, + payout_id: &'a common_utils::id_type::PayoutId, }, MerchantIdPayoutAttemptId { merchant_id: &'a common_utils::id_type::MerchantId, @@ -93,8 +93,9 @@ impl std::fmt::Display for PartitionKey<'_> { merchant_id, payout_id, } => f.write_str(&format!( - "mid_{}_po_{payout_id}", - merchant_id.get_string_repr() + "mid_{}_po_{}", + merchant_id.get_string_repr(), + payout_id.get_string_repr() )), PartitionKey::MerchantIdPayoutAttemptId { merchant_id, diff --git a/flake.nix b/flake.nix index 35fa05b73a7..05058a75d9e 100644 --- a/flake.nix +++ b/flake.nix @@ -43,6 +43,7 @@ devPackages = base ++ (with pkgs; [ cargo-watch nixd + protobuf rust-bin.stable.${rustDevVersion}.default swagger-cli ]); diff --git a/migrations/2025-06-19-170656_alter_payout_primary_key/down.sql b/migrations/2025-06-19-170656_alter_payout_primary_key/down.sql new file mode 100644 index 00000000000..e8ff6e1c5a1 --- /dev/null +++ b/migrations/2025-06-19-170656_alter_payout_primary_key/down.sql @@ -0,0 +1,7 @@ +ALTER TABLE payout_attempt DROP COLUMN merchant_order_reference_id; + +ALTER TABLE payout_attempt DROP CONSTRAINT payout_attempt_pkey; +ALTER TABLE payout_attempt ADD PRIMARY KEY (payout_attempt_id); + +ALTER TABLE payouts DROP CONSTRAINT payouts_pkey; +ALTER TABLE payouts ADD PRIMARY KEY (payout_id); diff --git a/migrations/2025-06-19-170656_alter_payout_primary_key/up.sql b/migrations/2025-06-19-170656_alter_payout_primary_key/up.sql new file mode 100644 index 00000000000..d65c931719f --- /dev/null +++ b/migrations/2025-06-19-170656_alter_payout_primary_key/up.sql @@ -0,0 +1,7 @@ +ALTER TABLE payout_attempt DROP CONSTRAINT payout_attempt_pkey; +ALTER TABLE payout_attempt ADD PRIMARY KEY (merchant_id, payout_attempt_id); + +ALTER TABLE payouts DROP CONSTRAINT payouts_pkey; +ALTER TABLE payouts ADD PRIMARY KEY (merchant_id, payout_id); + +ALTER TABLE payout_attempt ADD COLUMN merchant_order_reference_id VARCHAR(255) NULL;	2025-06-20T04:35:56Z	feat(payouts): allow payout_id to be configurable in API request feat(payouts): add merchant_order_reference_id for referencing payouts ## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [x] New feature - [ ] Enhancement - [x] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description This pull request introduces two main features for payouts: 1. Configurable `payout_id` in API Requests: * The `payout_id` field in payout creation API requests can now be optionally provided by the merchant. If provided, this ID will be used for the payout. If not provided, the system will generate one. * Internally, the usage of `payout_id` has been standardized to use the strongly-typed `common_utils::id_type::PayoutId` instead of `String`. This change has been propagated throughout relevant structs and functionalities like `PayoutsData`, data handling logic in `crates/router/src/core/utils.rs`, test utilities and DB queries. 2. `merchant_order_reference_id` for Payout Referencing: * The `merchant_order_reference_id` field has been added/updated in payout API models (e.g., `PayoutListFilterConstraints` in `crates/api_models/src/payouts.rs`). This allows merchants to use their own unique identifier to reference payouts. Refactoring and Connector Updates: * To support the `id_type::PayoutId` change and ensure correct data flow, connector integrations (Adyen, Adyenplatform, Cybersource, Nomupay) have been refactored. * Connectors now consistently use `RouterData.connector_request_reference_id` (which typically holds the `payout_attempt_id` as a `String`) when a string-based reference is required by the external service, rather than converting the internal `PayoutsData.payout_id`. This ensures that connectors receive the appropriate string identifier (e.g., `payout_attempt_id`) they expect. ### Additional Changes - [x] This PR modifies the API contract. - [x] This PR modifies the database schema. - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context These changes address the need for greater flexibility and type safety in payout processing, as outlined in GitHub issues #8392 and #1321. * Configurable `payout_id`: Allows merchants more control over their payout identifiers within the Hyperswitch. * `merchant_order_reference_id`: Provides a dedicated field for merchants to use their internal order or reference IDs. * `PayoutId` Type Standardization: Using `common_utils::id_type::PayoutId` enhances code robustness and maintainability by leveraging Rust's type system to prevent errors related to ID handling. * Connector Refactoring: Ensures that connectors use the correct string-based identifiers (like `payout_attempt_id` via `connector_request_reference_id`) required by external payout processors, maintaining correctness of integrations. Links to issues: * https://github.com/juspay/hyperswitch/issues/8392 * https://github.com/juspay/hyperswitch/issues/1321 ## How did you test it? <details> <summary>1. Card payouts via API</summary> cURL curl --location --request POST 'http://localhost:8080/payouts/create' \ --header 'Content-Type: application/json' \ --header 'api-key: dev_lAISInmiO4UNrMmvkJogzRVKEGKlBKQbRCBFOkLJTXmq6nsD5G1H65BjOd4H72H8' \ --data '{"amount":100,"currency":"EUR","profile_id":"pro_vVSlzCG7M1GSX9SyssY8","customer_id":"cus_WULwykbL8laUbxDUeGEB","connector":["adyenplatform"],"description":"Its my first payout request","payout_type":"card","payout_method_data":{"card":{"card_number":"4111111111111111","expiry_month":"03","expiry_year":"2030"}},"billing":{"address":{"line1":"1467","line2":"Harrison Street","line3":"Harrison Street","city":"San Fransico","state":"CA","zip":"94122","country":"FR","first_name":"John","last_name":"Doe"}},"entity_type":"Individual","recurring":true,"metadata":{"ref":"123"},"confirm":true,"auto_fulfill":true}' Response {"payout_id":"ff21b89d-3cfd-4f0f-b3ff-c468d90d7074","merchant_id":"merchant_1751292662","amount":100,"currency":"EUR","connector":"adyenplatform","payout_type":"card","payout_method_data":{"card":{"card_issuer":null,"card_network":null,"card_type":null,"card_issuing_country":null,"bank_code":null,"last4":"1111","card_isin":"411111","card_extended_bin":null,"card_exp_month":"03","card_exp_year":"2030","card_holder_name":null}},"billing":{"address":{"city":"San Fransico","country":"FR","line1":"1467","line2":"Harrison Street","line3":"Harrison Street","zip":"94122","state":"CA","first_name":"John","last_name":"Doe"},"phone":null,"email":null},"auto_fulfill":true,"customer_id":"cus_WULwykbL8laUbxDUeGEB","customer":{"id":"cus_WULwykbL8laUbxDUeGEB","name":"John Nether","email":null,"phone":"6168205362","phone_country_code":"+1"},"client_secret":"payout_ff21b89d-3cfd-4f0f-b3ff-c468d90d7074_secret_qzFALtOg6ZhYAOAUr2qY","return_url":null,"business_country":null,"business_label":null,"description":"Its my first payout request","entity_type":"Individual","recurring":true,"metadata":{"ref":"123"},"merchant_connector_id":"mca_SfssFvg5RBT2k7iKRRsS","status":"initiated","error_message":null,"error_code":null,"profile_id":"pro_vVSlzCG7M1GSX9SyssY8","created":"2025-06-30T14:12:47.886Z","connector_transaction_id":"38EBIX67HBSYZ30V","priority":null,"payout_link":null,"email":null,"name":"John Nether","phone":"6168205362","phone_country_code":"+1","unified_code":null,"unified_message":null,"payout_method_id":"pm_wScFhCfxELZ7gN13Nbxz"} </details> <details> <summary>2. Card payouts via Payout Links</summary> cURL curl --location --request POST 'http://localhost:8080/payouts/create' \ --header 'Content-Type: application/json' \ --header 'api-key: dev_lAISInmiO4UNrMmvkJogzRVKEGKlBKQbRCBFOkLJTXmq6nsD5G1H65BjOd4H72H8' \ --data '{"amount":1,"currency":"EUR","customer_id":"cus_WULwykbL8laUbxDUeGEB","description":"Its my first payout request","entity_type":"Individual","confirm":false,"auto_fulfill":true,"session_expiry":1000000,"profile_id":"pro_vVSlzCG7M1GSX9SyssY8","payout_link":true,"return_url":"https://www.google.com","payout_link_config":{"form_layout":"journey","theme":"#0066ff","logo":"https://hyperswitch.io/favicon.ico","merchant_name":"HyperSwitch Inc.","test_mode":true}}' Response {"payout_id":"2371746b-df3d-41da-8fa2-455faf921ea9","merchant_id":"merchant_1751292662","amount":1,"currency":"EUR","connector":null,"payout_type":null,"payout_method_data":null,"billing":null,"auto_fulfill":true,"customer_id":"cus_WULwykbL8laUbxDUeGEB","customer":{"id":"cus_WULwykbL8laUbxDUeGEB","name":"John Nether","email":null,"phone":"6168205362","phone_country_code":"+1"},"client_secret":"payout_2371746b-df3d-41da-8fa2-455faf921ea9_secret_VwDeIScMTLFzG7Iz1DZU","return_url":"https://www.google.com","business_country":null,"business_label":null,"description":"Its my first payout request","entity_type":"Individual","recurring":false,"metadata":{},"merchant_connector_id":null,"status":"requires_payout_method_data","error_message":null,"error_code":null,"profile_id":"pro_vVSlzCG7M1GSX9SyssY8","created":"2025-06-30T14:14:48.897Z","connector_transaction_id":null,"priority":null,"payout_link":{"payout_link_id":"payout_link_vITmtOWGkaUfeXopruRs","link":"http://localhost:8080/payout_link/merchant_1751292662/2371746b-df3d-41da-8fa2-455faf921ea9?locale=en"},"email":null,"name":"John Nether","phone":"6168205362","phone_country_code":"+1","unified_code":null,"unified_message":null,"payout_method_id":null} <img width="1719" alt="Screenshot 2025-06-30 at 7 45 32 PM" src="https://github.com/user-attachments/assets/e1ace815-74b5-411a-83be-badb2c04bf7d" /> <img width="1721" alt="Screenshot 2025-06-30 at 7 45 48 PM" src="https://github.com/user-attachments/assets/a8233053-9c1e-402d-87af-e59783fefc9d" /> <img width="913" alt="Screenshot 2025-06-30 at 7 45 54 PM" src="https://github.com/user-attachments/assets/586d1aa9-0116-46f3-b597-91b1f46ba5d2" /> </details> ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.114.0	0c649158a8ee491e2ff6ff37e922266d5b64b22d	0c649158a8ee491e2ff6ff37e922266d5b64b22d
juspay/hyperswitch	juspay__hyperswitch-8386	Bug: Api contract changes to accept `saving_percentage` in the decision engine response Api contract changes to accept `saving_percentage` in the decision engine response	diff --git a/crates/api_models/src/open_router.rs b/crates/api_models/src/open_router.rs index af91ece3f12..5d5f8f016c0 100644 --- a/crates/api_models/src/open_router.rs +++ b/crates/api_models/src/open_router.rs @@ -67,17 +67,32 @@ pub struct DecidedGateway { #[derive(Debug, Serialize, Deserialize, PartialEq, Clone)] pub struct DebitRoutingOutput { - pub co_badged_card_networks: Vec<common_enums::CardNetwork>, + pub co_badged_card_networks_info: Vec<CoBadgedCardNetworksInfo>, pub issuer_country: common_enums::CountryAlpha2, pub is_regulated: bool, pub regulated_name: Option<common_enums::RegulatedName>, pub card_type: common_enums::CardType, } +#[derive(Debug, Serialize, Deserialize, PartialEq, Clone)] +pub struct CoBadgedCardNetworksInfo { + pub network: common_enums::CardNetwork, + pub saving_percentage: f64, +} + +impl DebitRoutingOutput { + pub fn get_co_badged_card_networks(&self) -> Vec<common_enums::CardNetwork> { + self.co_badged_card_networks_info + .iter() + .map(\|data\| data.network.clone()) + .collect() + } +} + impl From<&DebitRoutingOutput> for payment_methods::CoBadgedCardData { fn from(output: &DebitRoutingOutput) -> Self { Self { - co_badged_card_networks: output.co_badged_card_networks.clone(), + co_badged_card_networks: output.get_co_badged_card_networks(), issuer_country_code: output.issuer_country, is_regulated: output.is_regulated, regulated_name: output.regulated_name.clone(), @@ -96,7 +111,7 @@ impl TryFrom<(payment_methods::CoBadgedCardData, String)> for DebitRoutingReques })?; Ok(Self { - co_badged_card_networks: output.co_badged_card_networks, + co_badged_card_networks_info: output.co_badged_card_networks, issuer_country: output.issuer_country_code, is_regulated: output.is_regulated, regulated_name: output.regulated_name, @@ -114,7 +129,7 @@ pub struct CoBadgedCardRequest { #[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] pub struct DebitRoutingRequestData { - pub co_badged_card_networks: Vec<common_enums::CardNetwork>, + pub co_badged_card_networks_info: Vec<common_enums::CardNetwork>, pub issuer_country: common_enums::CountryAlpha2, pub is_regulated: bool, pub regulated_name: Option<common_enums::RegulatedName>, diff --git a/crates/router/src/core/debit_routing.rs b/crates/router/src/core/debit_routing.rs index c7de440bbf6..ca03f5d2532 100644 --- a/crates/router/src/core/debit_routing.rs +++ b/crates/router/src/core/debit_routing.rs @@ -256,8 +256,8 @@ where get_debit_routing_output::<F, D>(state, payment_data, acquirer_country).await?; logger::debug!( - "Sorted co-badged networks: {:?}", - debit_routing_output.co_badged_card_networks + "Sorted co-badged networks info: {:?}", + debit_routing_output.co_badged_card_networks_info ); let key_store = db @@ -281,7 +281,7 @@ where &profile_id, &key_store, vec![connector_data.clone()], - debit_routing_output.co_badged_card_networks.clone(), + debit_routing_output.get_co_badged_card_networks(), ) .await .map_err(\|error\| { @@ -455,7 +455,7 @@ where &profile_id, &key_store, connector_data_list.clone(), - debit_routing_output.co_badged_card_networks.clone(), + debit_routing_output.get_co_badged_card_networks(), ) .await .map_err(\|error\| {	2025-06-19T08:01:15Z	<!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [ ] New feature - [ ] Enhancement - [x] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> This pull request refactors the `DebitRoutingOutput` structure to introduce a new `CoBadgedCardNetworksInfo` type, enhancing the representation of co-badged card networks by including additional metadata such as saving percentages. It also updates related methods and structures to align with this change. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> -> Enable debit routing for a profile and configure adyen connector -> Make a payment ``` curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'x-feature: router-custom' \ --header 'x-tenant-id: hyperswitch' \ --header 'api-key: ' \ --data-raw '{ "amount": 10000, "amount_to_capture": 10000, "currency": "USD", "confirm": true, "capture_method": "automatic", "setup_future_usage": "on_session", "capture_on": "2022-09-10T10:11:12Z", "email": "[email protected]", "name": "John Doe", "phone": "999999999", "phone_country_code": "+1", "description": "Its my first payment request", "authentication_type": "no_three_ds", "customer_id": "cu_1750319776", "return_url": "http://127.0.0.1:4040", "payment_method": "card", "payment_method_type": "debit", "payment_method_data": { "card": { "card_number": "4400 0020 0000 0004", "card_exp_month": "03", "card_exp_year": "2030", "card_holder_name": "joseph Doe", "card_cvc": "737" } }, "billing": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San", "state": "California", "zip": "94122", "country": "US", "first_name": "PiX", "last_name": "ss" }, "email": "[email protected]" }, "shipping": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "PiX" } }, "customer_acceptance": { "acceptance_type": "offline", "accepted_at": "1963-05-03T04:07:52.723Z", "online": { "ip_address": "in sit", "user_agent": "amet irure esse" } }, "browser_info": { "user_agent": "Mozilla\/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/70.0.3538.110 Safari\/537.36", "accept_header": "text\/html,application\/xhtml+xml,application\/xml;q=0.9,image\/webp,image\/apng,\/;q=0.8", "language": "nl-NL", "color_depth": 24, "screen_height": 723, "screen_width": 1536, "time_zone": 0, "java_enabled": true, "java_script_enabled": true, "ip_address": "125.0.0.1" }, "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "metadata": { "udf1": "value1", "new_customer": "true", "login_date": "2019-09-10T10:11:12Z" } }' ``` ``` { "payment_id": "pay_7aTZkTRH72iemhbxOqvc", "merchant_id": "merchant_1750232289", "status": "succeeded", "amount": 10000, "net_amount": 10000, "shipping_cost": null, "amount_capturable": 0, "amount_received": 10000, "connector": "adyen", "client_secret": "pay_7aTZkTRH72iemhbxOqvc_secret_2v6ATAqLFQsKVhms16hF", "created": "2025-06-18T07:40:06.149Z", "currency": "USD", "customer_id": "cu_1750232406", "customer": { "id": "cu_1750232406", "name": "John Doe", "email": "[email protected]", "phone": "999999999", "phone_country_code": "+1" }, "description": "Its my first payment request", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": "on_session", "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "card", "payment_method_data": { "card": { "last4": "0004", "card_type": null, "card_network": "Accel", "card_issuer": null, "card_issuing_country": null, "card_isin": "440000", "card_extended_bin": null, "card_exp_month": "03", "card_exp_year": "2030", "card_holder_name": "joseph Doe", "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "PiX", "last_name": null }, "phone": null, "email": null }, "billing": { "address": { "city": "San", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "PiX", "last_name": "ss" }, "phone": null, "email": "[email protected]" }, "order_details": null, "email": "[email protected]", "name": "John Doe", "phone": "999999999", "return_url": "http://127.0.0.1:4040/", "authentication_type": "no_three_ds", "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "debit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": { "customer_id": "cu_1750232406", "created_at": 1750232406, "expires": 1750236006, "secret": "epk_1a8a73a55db941eb89b3c5a54b42bc3d" }, "manual_retry_allowed": false, "connector_transaction_id": "JKCHRB6V9DDHL975", "frm_message": null, "metadata": { "udf1": "value1", "login_date": "2019-09-10T10:11:12Z", "new_customer": "true" }, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_7aTZkTRH72iemhbxOqvc_1", "payment_link": null, "profile_id": "pro_n23wrYOtUyaiFMM71SEq", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_xC22XUKnNCBkg5vHm1W0", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-06-18T07:55:06.149Z", "fingerprint": null, "browser_info": { "language": "nl-NL", "time_zone": 0, "ip_address": "125.0.0.1", "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "color_depth": 24, "java_enabled": true, "screen_width": 1536, "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8", "screen_height": 723, "java_script_enabled": true }, "payment_method_id": null, "payment_method_status": null, "updated": "2025-06-18T07:40:07.133Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` Once the payment is done the api events should have the `saving_percentage` in the decision engine response ``` { "decided_gateway": "ADYEN", "gateway_priority_map": null, "filter_wise_gateways": null, "priority_logic_tag": null, "routing_approach": "NONE", "gateway_before_evaluation": null, "priority_logic_output": null, "debit_routing_output": { "co_badged_card_networks_info": [ { "network": "ACCEL", "saving_percentage": 0.14 }, { "network": "STAR", "saving_percentage": 0.04 }, { "network": "VISA", "saving_percentage": 0.0 } ], "issuer_country": "US", "is_regulated": true, "regulated_name": "GOVERNMENT EXEMPT INTERCHANGE FEE", "card_type": "debit" }, "reset_approach": "NO_RESET", "routing_dimension": null, "routing_dimension_level": null, "is_scheduled_outage": false, "is_dynamic_mga_enabled": false, "gateway_mga_id_map": null } ``` ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.114.0	305ca9bda9d3c5bf3cc97458b7ed07b79e894154	305ca9bda9d3c5bf3cc97458b7ed07b79e894154
juspay/hyperswitch	juspay__hyperswitch-8492	Bug: [FIX] Fix routing approach update in wallet flow ### Feature Description Fix routing approach update in wallet flow ### Possible Implementation Fix routing approach update in wallet flow ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? Yes, I am willing to submit a PR!	diff --git a/crates/common_enums/src/enums.rs b/crates/common_enums/src/enums.rs index 29cf75ac504..1d00a451708 100644 --- a/crates/common_enums/src/enums.rs +++ b/crates/common_enums/src/enums.rs @@ -8523,6 +8523,7 @@ pub enum RoutingApproach { DebitRouting, RuleBasedRouting, VolumeBasedRouting, + StraightThroughRouting, #[default] DefaultFallback, } @@ -8533,6 +8534,7 @@ impl RoutingApproach { "SR_SELECTION_V3_ROUTING" => Self::SuccessRateExploitation, "SR_V3_HEDGING" => Self::SuccessRateExploration, "NTW_BASED_ROUTING" => Self::DebitRouting, + "DEFAULT" => Self::StraightThroughRouting, _ => Self::DefaultFallback, } } diff --git a/crates/diesel_models/src/payment_attempt.rs b/crates/diesel_models/src/payment_attempt.rs index 0afea0574a7..eeda9e78877 100644 --- a/crates/diesel_models/src/payment_attempt.rs +++ b/crates/diesel_models/src/payment_attempt.rs @@ -459,6 +459,7 @@ pub enum PaymentAttemptUpdate { tax_amount: Option<MinorUnit>, updated_by: String, merchant_connector_id: Option<id_type::MerchantConnectorAccountId>, + routing_approach: Option<storage_enums::RoutingApproach>, }, AuthenticationTypeUpdate { authentication_type: storage_enums::AuthenticationType, @@ -3088,6 +3089,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { tax_amount, updated_by, merchant_connector_id, + routing_approach, } => Self { payment_token, modified_at: common_utils::date_time::now(), @@ -3146,7 +3148,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, - routing_approach: None, + routing_approach, }, PaymentAttemptUpdate::UnresolvedResponseUpdate { status, diff --git a/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs b/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs index 3a2692e5830..d644c519ea9 100644 --- a/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs +++ b/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs @@ -1191,6 +1191,7 @@ pub enum PaymentAttemptUpdate { tax_amount: Option<MinorUnit>, updated_by: String, merchant_connector_id: Option<id_type::MerchantConnectorAccountId>, + routing_approach: Option<storage_enums::RoutingApproach>, }, AuthenticationTypeUpdate { authentication_type: storage_enums::AuthenticationType, @@ -1227,7 +1228,7 @@ pub enum PaymentAttemptUpdate { customer_acceptance: Option<pii::SecretSerdeValue>, connector_mandate_detail: Option<ConnectorMandateReferenceId>, card_discovery: Option<common_enums::CardDiscovery>, - routing_approach: Option<storage_enums::RoutingApproach>, // where all to add this one + routing_approach: Option<storage_enums::RoutingApproach>, }, RejectUpdate { status: storage_enums::AttemptStatus, @@ -1413,6 +1414,7 @@ impl PaymentAttemptUpdate { surcharge_amount, tax_amount, merchant_connector_id, + routing_approach, } => DieselPaymentAttemptUpdate::UpdateTrackers { payment_token, connector, @@ -1422,6 +1424,7 @@ impl PaymentAttemptUpdate { tax_amount, updated_by, merchant_connector_id, + routing_approach, }, Self::AuthenticationTypeUpdate { authentication_type, diff --git a/crates/router/src/core/payment_methods/cards.rs b/crates/router/src/core/payment_methods/cards.rs index 11b1489b5cf..c42b05bd424 100644 --- a/crates/router/src/core/payment_methods/cards.rs +++ b/crates/router/src/core/payment_methods/cards.rs @@ -2845,7 +2845,7 @@ pub async fn list_payment_methods( payment_intent, chosen, }; - let result = routing::perform_session_flow_routing( + let (result, routing_approach) = routing::perform_session_flow_routing( sfr, &business_profile, &enums::TransactionType::Payment, @@ -3027,6 +3027,7 @@ pub async fn list_payment_methods( merchant_connector_id: None, surcharge_amount: None, tax_amount: None, + routing_approach, }; state diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs index 83176881ead..83ff156ea95 100644 --- a/crates/router/src/core/payments.rs +++ b/crates/router/src/core/payments.rs @@ -7331,6 +7331,10 @@ where .change_context(errors::ApiErrorResponse::InternalServerError) .attach_printable("Failed execution of straight through routing")?; + payment_data.set_routing_approach_in_attempt(Some( + common_enums::RoutingApproach::StraightThroughRouting, + )); + if check_eligibility { let transaction_data = core_routing::PaymentsDslInput::new( payment_data.get_setup_mandate(), @@ -7911,12 +7915,12 @@ pub async fn perform_session_token_routing<F, D>( state: SessionState, merchant_context: &domain::MerchantContext, business_profile: &domain::Profile, - payment_data: &D, + payment_data: &mut D, connectors: api::SessionConnectorDatas, ) -> RouterResult<api::SessionConnectorDatas> where F: Clone, - D: OperationSessionGetters<F>, + D: OperationSessionGetters<F> + OperationSessionSetters<F>, { let chosen = connectors.apply_filter_for_session_routing(); let sfr = SessionFlowRoutingInput { @@ -7932,7 +7936,7 @@ where payment_intent: payment_data.get_payment_intent(), chosen, }; - let result = self_routing::perform_session_flow_routing( + let (result, routing_approach) = self_routing::perform_session_flow_routing( sfr, business_profile, &enums::TransactionType::Payment, @@ -7941,6 +7945,8 @@ where .change_context(errors::ApiErrorResponse::InternalServerError) .attach_printable("error performing session flow routing")?; + payment_data.set_routing_approach_in_attempt(routing_approach); + let final_list = connectors.filter_and_validate_for_session_flow(&result)?; Ok(final_list) diff --git a/crates/router/src/core/payments/operations/payment_create.rs b/crates/router/src/core/payments/operations/payment_create.rs index 4c463c74ed7..413aa121a9c 100644 --- a/crates/router/src/core/payments/operations/payment_create.rs +++ b/crates/router/src/core/payments/operations/payment_create.rs @@ -880,6 +880,8 @@ impl<F: Clone + Sync> UpdateTracker<F, PaymentData<F>, api::PaymentsRequest> for .as_ref() .map(\|surcharge_details\| surcharge_details.tax_on_surcharge_amount); + let routing_approach = payment_data.payment_attempt.routing_approach; + payment_data.payment_attempt = state .store .update_payment_attempt_with_attempt_id( @@ -896,6 +898,7 @@ impl<F: Clone + Sync> UpdateTracker<F, PaymentData<F>, api::PaymentsRequest> for tax_amount, updated_by: storage_scheme.to_string(), merchant_connector_id, + routing_approach, }, storage_scheme, ) diff --git a/crates/router/src/core/payments/routing.rs b/crates/router/src/core/payments/routing.rs index 7126ed9617e..c3823aa2f30 100644 --- a/crates/router/src/core/payments/routing.rs +++ b/crates/router/src/core/payments/routing.rs @@ -515,7 +515,10 @@ pub async fn perform_static_routing_v1( ).unwrap_or_default(); let (routable_connectors, routing_approach) = match cached_algorithm.as_ref() { - CachedAlgorithm::Single(conn) => (vec![(conn).clone()], None), + CachedAlgorithm::Single(conn) => ( + vec![(conn).clone()], + Some(common_enums::RoutingApproach::StraightThroughRouting), + ), CachedAlgorithm::Priority(plist) => (plist.clone(), None), CachedAlgorithm::VolumeSplit(splits) => ( perform_volume_split(splits.to_vec()) @@ -1208,8 +1211,10 @@ pub async fn perform_session_flow_routing( session_input: SessionFlowRoutingInput<'_>, business_profile: &domain::Profile, transaction_type: &api_enums::TransactionType, -) -> RoutingResult<FxHashMap<api_enums::PaymentMethodType, Vec<routing_types::SessionRoutingChoice>>> -{ +) -> RoutingResult<( + FxHashMap<api_enums::PaymentMethodType, Vec<routing_types::SessionRoutingChoice>>, + Option<common_enums::RoutingApproach>, +)> { let mut pm_type_map: FxHashMap<api_enums::PaymentMethodType, FxHashMap<String, api::GetToken>> = FxHashMap::default(); @@ -1297,6 +1302,7 @@ pub async fn perform_session_flow_routing( api_enums::PaymentMethodType, Vec<routing_types::SessionRoutingChoice>, > = FxHashMap::default(); + let mut final_routing_approach = None; for (pm_type, allowed_connectors) in pm_type_map { let euclid_pmt: euclid_enums::PaymentMethodType = pm_type; @@ -1315,12 +1321,15 @@ pub async fn perform_session_flow_routing( profile_id: &profile_id, }; - let routable_connector_choice_option = perform_session_routing_for_pm_type( - &session_pm_input, - transaction_type, - business_profile, - ) - .await?; + let (routable_connector_choice_option, routing_approach) = + perform_session_routing_for_pm_type( + &session_pm_input, + transaction_type, + business_profile, + ) + .await?; + + final_routing_approach = routing_approach; if let Some(routable_connector_choice) = routable_connector_choice_option { let mut session_routing_choice: Vec<routing_types::SessionRoutingChoice> = Vec::new(); @@ -1348,7 +1357,7 @@ pub async fn perform_session_flow_routing( } } - Ok(result) + Ok((result, final_routing_approach)) } #[cfg(feature = "v1")] @@ -1356,14 +1365,17 @@ async fn perform_session_routing_for_pm_type( session_pm_input: &SessionRoutingPmTypeInput<'_>, transaction_type: &api_enums::TransactionType, _business_profile: &domain::Profile, -) -> RoutingResult<Option<Vec<api_models::routing::RoutableConnectorChoice>>> { +) -> RoutingResult<( + Option<Vec<api_models::routing::RoutableConnectorChoice>>, + Option<common_enums::RoutingApproach>, +)> { let merchant_id = &session_pm_input.key_store.merchant_id; let algorithm_id = match session_pm_input.routing_algorithm { MerchantAccountRoutingAlgorithm::V1(algorithm_ref) => &algorithm_ref.algorithm_id, }; - let chosen_connectors = if let Some(ref algorithm_id) = algorithm_id { + let (chosen_connectors, routing_approach) = if let Some(ref algorithm_id) = algorithm_id { let cached_algorithm = ensure_algorithm_cached_v1( &session_pm_input.state.clone(), merchant_id, @@ -1374,23 +1386,35 @@ async fn perform_session_routing_for_pm_type( .await?; match cached_algorithm.as_ref() { - CachedAlgorithm::Single(conn) => vec![(conn).clone()], - CachedAlgorithm::Priority(plist) => plist.clone(), - CachedAlgorithm::VolumeSplit(splits) => perform_volume_split(splits.to_vec()) - .change_context(errors::RoutingError::ConnectorSelectionFailed)?, - CachedAlgorithm::Advanced(interpreter) => execute_dsl_and_get_connector_v1( - session_pm_input.backend_input.clone(), - interpreter, - )?, + CachedAlgorithm::Single(conn) => ( + vec![(conn).clone()], + Some(common_enums::RoutingApproach::StraightThroughRouting), + ), + CachedAlgorithm::Priority(plist) => (plist.clone(), None), + CachedAlgorithm::VolumeSplit(splits) => ( + perform_volume_split(splits.to_vec()) + .change_context(errors::RoutingError::ConnectorSelectionFailed)?, + Some(common_enums::RoutingApproach::VolumeBasedRouting), + ), + CachedAlgorithm::Advanced(interpreter) => ( + execute_dsl_and_get_connector_v1( + session_pm_input.backend_input.clone(), + interpreter, + )?, + Some(common_enums::RoutingApproach::RuleBasedRouting), + ), } } else { - routing::helpers::get_merchant_default_config( - &session_pm_input.state.clone().store, - session_pm_input.profile_id.get_string_repr(), - transaction_type, + ( + routing::helpers::get_merchant_default_config( + &session_pm_input.state.clone().store, + session_pm_input.profile_id.get_string_repr(), + transaction_type, + ) + .await + .change_context(errors::RoutingError::FallbackConfigFetchFailed)?, + None, ) - .await - .change_context(errors::RoutingError::FallbackConfigFetchFailed)? }; let mut final_selection = perform_cgraph_filtering( @@ -1426,9 +1450,9 @@ async fn perform_session_routing_for_pm_type( } if final_selection.is_empty() { - Ok(None) + Ok((None, routing_approach)) } else { - Ok(Some(final_selection)) + Ok((Some(final_selection), routing_approach)) } } diff --git a/migrations/2025-06-27-120507_update_routing_approach/down.sql b/migrations/2025-06-27-120507_update_routing_approach/down.sql new file mode 100644 index 00000000000..c7c9cbeb401 --- /dev/null +++ b/migrations/2025-06-27-120507_update_routing_approach/down.sql @@ -0,0 +1,2 @@ +-- This file should undo anything in `up.sql` +SELECT 1; \ No newline at end of file diff --git a/migrations/2025-06-27-120507_update_routing_approach/up.sql b/migrations/2025-06-27-120507_update_routing_approach/up.sql new file mode 100644 index 00000000000..c7f75cb5235 --- /dev/null +++ b/migrations/2025-06-27-120507_update_routing_approach/up.sql @@ -0,0 +1,3 @@ +-- Your SQL goes here +ALTER TYPE "RoutingApproach" +ADD VALUE 'straight_through_routing';	2025-06-30T08:06:48Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [x] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> Fixes routing approach updation for wallets flow ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> 1. make wallet payment and check for `routing_approach` column in payment_attempt ApplePay payment create - ``` curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_BNOaWRzwyZ3hMAbhRNtp9t6Mx7ZSVyK5gPvd1bavl0FWehvrHlre1eMifYA244TE' \ --data-raw '{ "amount": 650, "currency": "USD", "confirm": false, "business_country": "US", "business_label": "default", "amount_to_capture": 650, "customer_id": "cu_1751271429", "capture_method": "automatic", "capture_on": "2022-09-10T10:11:12Z", "setup_future_usage": "off_session", "authentication_type": "no_three_ds", "return_url": "https://google.com", "email": "[email protected]", "name": "Joseph Doe", "phone": "999999999", "phone_country_code": "+65", "description": "Its my first payment request", "statement_descriptor_name": "Juspay", "statement_descriptor_suffix": "Router", "payment_method": "wallet", "payment_method_type": "apple_pay", "billing": { "address": { "line1": "1467", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" }, "phone": { "number": "8056594427", "country_code": "+91" } }, "customer_acceptance": { "acceptance_type": "offline", "accepted_at": "1963-05-03T04:07:52.723Z", "online": { "ip_address": "in sit", "user_agent": "amet irure esse" } }, "payment_method_data": { "wallet": { "apple_pay": { "payment_data": "eyJkYXRhIjogInR1OHlCcFY3MHJ5WFpSTUJqaEt3T2VtTGhrbHlPREIzNVVLdnpNUDVFRk50eW9OMUdtK2pRRkZnaTF1T0t3WmJQZUUwdmxVUnJIeU5vQkhLOUZSY1pmYzJVL2cydytHbExweWxVcEQwc2VXdU9rRTZYb1E1SHFsZ085bFZRclZacHZsNmFndHdVYU5Cc2pqWTB0Q1F1SHRMRHQzQWI4c2pJdWhpL1g1cFNYakM0ak5PdUoxRkdJKy9CS016OHBNdUZGMkUvbmJWenhNQjhoT1lDWjlUVGdFZlN3Z3VwbE9SaFY5dFV1by9VVFhFUG40cGljNVpPYUR6WnB6Z1BuK0d1V2JVVExuL0h5Rk9MQW5xc3pNZzFkdklHcjd3c0pWRE1LUzJIdHZ5VzA2QXUzNGVSZGxkaEVWbFhnYWNDcWFualVwZlJBcVhod2VtQjNwd2p4bFBUMkxrcUE3VzJwWnNLNkF1Z0lwUi9tMTUwazFRRjl3d1AwVTF6YkpBbGc5bE9VL1IyRlVZR1BKRUZ4ay92SWowL3ZiYnkvcE96L0RBY1ZRd3NGek9UbUk9IiwKICAgICAgInNpZ25hdHVyZSI6ICJNSUFHQ1NxR1NJYjNEUUVIQXFDQU1JQUNBUUV4RFRBTEJnbGdoa2dCWlFNRUFnRXdnQVlKS29aSWh2Y05BUWNCQUFDZ2dEQ0NBK1F3Z2dPTG9BTUNBUUlDQ0ZuWW9ieXE5T1BOTUFvR0NDcUdTTTQ5QkFNQ01Ib3hMakFzQmdOVkJBTU1KVUZ3Y0d4bElFRndjR3hwWTJGMGFXOXVJRWx1ZEdWbmNtRjBhVzl1SUVOQklDMGdSek14SmpBa0JnTlZCQXNNSFVGd2NHeGxJRU5sY25ScFptbGpZWFJwYjI0Z1FYVjBhRzl5YVhSNU1STXdFUVlEVlFRS0RBcEJjSEJzWlNCSmJtTXVNUXN3Q1FZRFZRUUdFd0pWVXpBZUZ3MHlNVEEwTWpBeE9UTTNNREJhRncweU5qQTBNVGt4T1RNMk5UbGFNR0l4S0RBbUJnTlZCQU1NSDJWall5MXpiWEF0WW5KdmEyVnlMWE5wWjI1ZlZVTTBMVk5CVGtSQ1QxZ3hGREFTQmdOVkJBc01DMmxQVXlCVGVYTjBaVzF6TVJNd0VRWURWUVFLREFwQmNIQnNaU0JKYm1NdU1Rc3dDUVlEVlFRR0V3SlZVekJaTUJNR0J5cUdTTTQ5QWdFR0NDcUdTTTQ5QXdFSEEwSUFCSUl3L2F2RG5QZGVJQ3hRMlp0RkV1WTM0cWtCM1d5ejRMSE5TMUpubVBqUFRyM29HaVdvd2g1TU05M09qaXFXd3Zhdm9aTURSY1RvZWtRbXpwVWJFcFdqZ2dJUk1JSUNEVEFNQmdOVkhSTUJBZjhFQWpBQU1COEdBMVVkSXdRWU1CYUFGQ1B5U2NSUGsrVHZKK2JFOWloc1A2SzcvUzVMTUVVR0NDc0dBUVVGQndFQkJEa3dOekExQmdnckJnRUZCUWN3QVlZcGFIUjBjRG92TDI5amMzQXVZWEJ3YkdVdVkyOXRMMjlqYzNBd05DMWhjSEJzWldGcFkyRXpNREl3Z2dFZEJnTlZIU0FFZ2dFVU1JSUJFRENDQVF3R0NTcUdTSWIzWTJRRkFUQ0IvakNCd3dZSUt3WUJCUVVIQWdJd2diWU1nYk5TWld4cFlXNWpaU0J2YmlCMGFHbHpJR05sY25ScFptbGpZWFJsSUdKNUlHRnVlU0J3WVhKMGVTQmhjM04xYldWeklHRmpZMlZ3ZEdGdVkyVWdiMllnZEdobElIUm9aVzRnWVhCd2JHbGpZV0pzWlNCemRHRnVaR0Z5WkNCMFpYSnRjeUJoYm1RZ1kyOXVaR2wwYVc5dWN5QnZaaUIxYzJVc0lHTmxjblJwWm1sallYUmxJSEJ2YkdsamVTQmhibVFnWTJWeWRHbG1hV05oZEdsdmJpQndjbUZqZEdsalpTQnpkR0YwWlcxbGJuUnpMakEyQmdnckJnRUZCUWNDQVJZcWFIUjBjRG92TDNkM2R5NWhjSEJzWlM1amIyMHZZMlZ5ZEdsbWFXTmhkR1ZoZFhSb2IzSnBkSGt2TURRR0ExVWRId1F0TUNzd0thQW5vQ1dHSTJoMGRIQTZMeTlqY213dVlYQndiR1V1WTI5dEwyRndjR3hsWVdsallUTXVZM0pzTUIwR0ExVWREZ1FXQkJRQ0pEQUxtdTd0UmpHWHBLWmFLWjVDY1lJY1JUQU9CZ05WSFE4QkFmOEVCQU1DQjRBd0R3WUpLb1pJaHZkalpBWWRCQUlGQURBS0JnZ3Foa2pPUFFRREFnTkhBREJFQWlCMG9iTWsyMEpKUXczVEoweFFkTVNBalpvZlNBNDZoY1hCTmlWbU1sKzhvd0lnYVRhUVU2djFDMXBTK2ZZQVRjV0tyV3hRcDlZSWFEZVE0S2M2MEI1SzJZRXdnZ0x1TUlJQ2RhQURBZ0VDQWdoSmJTKy9PcGphbHpBS0JnZ3Foa2pPUFFRREFqQm5NUnN3R1FZRFZRUUREQkpCY0hCc1pTQlNiMjkwSUVOQklDMGdSek14SmpBa0JnTlZCQXNNSFVGd2NHeGxJRU5sY25ScFptbGpZWFJwYjI0Z1FYVjBhRzl5YVhSNU1STXdFUVlEVlFRS0RBcEJjSEJzWlNCSmJtTXVNUXN3Q1FZRFZRUUdFd0pWVXpBZUZ3MHhOREExTURZeU16UTJNekJhRncweU9UQTFNRFl5TXpRMk16QmFNSG94TGpBc0JnTlZCQU1NSlVGd2NHeGxJRUZ3Y0d4cFkyRjBhVzl1SUVsdWRHVm5jbUYwYVc5dUlFTkJJQzBnUnpNeEpqQWtCZ05WQkFzTUhVRndjR3hsSUVObGNuUnBabWxqWVhScGIyNGdRWFYwYUc5eWFYUjVNUk13RVFZRFZRUUtEQXBCY0hCc1pTQkpibU11TVFzd0NRWURWUVFHRXdKVlV6QlpNQk1HQnlxR1NNNDlBZ0VHQ0NxR1NNNDlBd0VIQTBJQUJQQVhFWVFaMTJTRjFScGVKWUVIZHVpQW91L2VlNjVONEkzOFM1UGhNMWJWWmxzMXJpTFFsM1lOSWs1N3VnajlkaGZPaU10MnUyWnd2c2pvS1lUL1ZFV2pnZmN3Z2ZRd1JnWUlLd1lCQlFVSEFRRUVPakE0TURZR0NDc0dBUVVGQnpBQmhpcG9kSFJ3T2k4dmIyTnpjQzVoY0hCc1pTNWpiMjB2YjJOemNEQTBMV0Z3Y0d4bGNtOXZkR05oWnpNd0hRWURWUjBPQkJZRUZDUHlTY1JQaytUdkorYkU5aWhzUDZLNy9TNUxNQThHQTFVZEV3RUIvd1FGTUFNQkFmOHdId1lEVlIwakJCZ3dGb0FVdTdEZW9WZ3ppSnFraXBuZXZyM3JyOXJMSktzd053WURWUjBmQkRBd0xqQXNvQ3FnS0lZbWFIUjBjRG92TDJOeWJDNWhjSEJzWlM1amIyMHZZWEJ3YkdWeWIyOTBZMkZuTXk1amNtd3dEZ1lEVlIwUEFRSC9CQVFEQWdFR01CQUdDaXFHU0liM1kyUUdBZzRFQWdVQU1Bb0dDQ3FHU000OUJBTUNBMmNBTUdRQ01EclBjb05SRnBteGh2czF3MWJLWXIvMEYrM1pEM1ZOb282KzhaeUJYa0szaWZpWTk1dFpuNWpWUVEyUG5lbkMvZ0l3TWkzVlJDR3dvd1YzYkYzek9EdVFaLzBYZkN3aGJaWlB4bkpwZ2hKdlZQaDZmUnVaeTVzSmlTRmhCcGtQQ1pJZEFBQXhnZ0dITUlJQmd3SUJBVENCaGpCNk1TNHdMQVlEVlFRRERDVkJjSEJzWlNCQmNIQnNhV05oZEdsdmJpQkpiblJsWjNKaGRHbHZiaUJEUVNBdElFY3pNU1l3SkFZRFZRUUxEQjFCY0hCc1pTQkRaWEowYVdacFkyRjBhVzl1SUVGMWRHaHZjbWwwZVRFVE1CRUdBMVVFQ2d3S1FYQndiR1VnU1c1akxqRUxNQWtHQTFVRUJoTUNWVk1DQ0ZuWW9ieXE5T1BOTUFzR0NXQ0dTQUZsQXdRQ0FhQ0JrekFZQmdrcWhraUc5dzBCQ1FNeEN3WUpLb1pJaHZjTkFRY0JNQndHQ1NxR1NJYjNEUUVKQlRFUEZ3MHlOREV5TVRJd09ESTFNalphTUNnR0NTcUdTSWIzRFFFSk5ERWJNQmt3Q3dZSllJWklBV1VEQkFJQm9Rb0dDQ3FHU000OUJBTUNNQzhHQ1NxR1NJYjNEUUVKQkRFaUJDQmZHSHBFQ2RnOWQ0YWl0VTlDRndSTGVEYXNZSDRMdUNuQjIvZHd2VFE2SWpBS0JnZ3Foa2pPUFFRREFnUkdNRVFDSUhnK3dKd25RdlJuZEdIN1UrL1hVb094c21VRVI2a2RqQ0RQNStTajF4eXpBaUJydEdIUGtWUXB1VEFHeDQ5SllEUFl5MzdhUDhoeGxtK1VjRThzVWFFa0V3QUFBQUFBQUE9PSIsCiAgICAgICJoZWFkZXIiOiB7CiAgICAgICAgInB1YmxpY0tleUhhc2giOiAiMkNnWTU3TERJVFVEMHFSN0R3eUhsdVRtMTIyQnowOXNhczJCVVorRUU5VT0iLAogICAgICAgICJlcGhlbWVyYWxQdWJsaWNLZXkiOiAiTUZrd0V3WUhLb1pJemowQ0FRWUlLb1pJemowREFRY0RRZ0FFQmN1VGNHRGl0V1B3UVE5SFZ0d1dEZmRkZDlhelJ3VFJlL00zVUNSb3NHaEhhUklQUnNoZWp2ZWpaL0Z4MlFiamVYRmNRSnVra0creUdYUmlnTDR2MUE9PSIsCiAgICAgICAgInRyYW5zYWN0aW9uSWQiOiAiNzAwOTVhMWFjMTZkNGQ4NzAyODQ0ZDdjZDJhZGVkZWMxZmQyMzA0YTFkNmU3OTBhZWVmOWJjYzA5MmZkYjk2MSIKICAgICAgfSwKICAgICAgInZlcnNpb24iOiAiRUNfdjEifQ==", "payment_method": { "display_name": "Discover 9319", "network": "Discover", "type": "credit" }, "transaction_identifier": "c635c5b3af900d7bd81fecd7028f1262f9d030754ee65ec7afd988a678194751" } } } }' ``` Payment method list - ``` curl --location 'http://localhost:8080/account/payment_methods?client_secret=pay_mgPMJsvP0EXSt7fDSmIF_secret_TbYn03eKtktMmmjUMTKe' \ --header 'Accept: application/json' \ --header 'api-key: pk_dev_bc5af669d7594cb7aaf277fc6b6c60dc' ``` Routing approach after this - <img width="850" alt="image" src="https://github.com/user-attachments/assets/4d637044-03e0-4c34-ab7c-abbe60a700fc" /> test straight_through routing - ``` curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_BNOaWRzwyZ3hMAbhRNtp9t6Mx7ZSVyK5gPvd1bavl0FWehvrHlre1eMifYA244TE' \ --data-raw '{ "amount": 6540, "currency": "USD", "confirm": true, "capture_method": "automatic", "capture_on": "2022-09-10T10:11:12Z", "amount_to_capture": 6540, "customer_id": "StripeCustomer", "profile_id": "pro_EfD8EtQQSPZxXStG6B7x", "email": "[email protected]", "name": "John Doe", "phone": "999999999", "phone_country_code": "+1", "description": "Its my first payment request", "authentication_type": "no_three_ds", "return_url": "https://google.com", "payment_method": "card", "routing": { "type": "single", "data": {"connector": "stripe", "merchant_connector_id": "mca_SdftCCtpClu32qA6oijC"} }, "payment_method_type": "credit", "payment_method_data": { "card": { "card_number": "4242424242424242", "card_exp_month": "03", "card_exp_year": "30", "card_holder_name": "joseph Doe", "card_cvc": "737" } }, "billing": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "NL", "first_name": "joseph", "last_name": "Doe" }, "phone": { "number": "8056594427", "country_code": "+91" } }, "shipping": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" }, "phone": { "number": "8056594427", "country_code": "+91" } }, "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "metadata": { "udf1": "value1", "new_customer": "true", "login_date": "2019-09-10T10:11:12Z" }, "browser_info": { "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8", "language": "nl-NL", "color_depth": 24, "screen_height": 723, "screen_width": 1536, "time_zone": 0, "java_enabled": true, "java_script_enabled": true, "ip_address": "127.0.0.1" } }' ``` DB - <img width="852" alt="image" src="https://github.com/user-attachments/assets/6fa08603-19af-485b-bce2-9266b3419749" /> ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [ ] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	1c3811773ded20da19fac6f1dc679e337384f1cb	1c3811773ded20da19fac6f1dc679e337384f1cb
juspay/hyperswitch	juspay__hyperswitch-8491	Bug: [FEATURE] celero connector template ### Feature Description Create connector template ### Possible Implementation https://celerocommerce.com/developers/ ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? None	diff --git a/api-reference/v1/openapi_spec_v1.json b/api-reference/v1/openapi_spec_v1.json index 84cfe8e6199..940922743ca 100644 --- a/api-reference/v1/openapi_spec_v1.json +++ b/api-reference/v1/openapi_spec_v1.json @@ -10940,6 +10940,7 @@ "boku", "braintree", "cashtocode", + "celero", "chargebee", "checkout", "coinbase", @@ -27949,6 +27950,7 @@ "boku", "braintree", "cashtocode", + "celero", "chargebee", "checkout", "coinbase", diff --git a/api-reference/v2/openapi_spec_v2.json b/api-reference/v2/openapi_spec_v2.json index 63a25bf4fc2..12340ea5dcb 100644 --- a/api-reference/v2/openapi_spec_v2.json +++ b/api-reference/v2/openapi_spec_v2.json @@ -8147,6 +8147,7 @@ "boku", "braintree", "cashtocode", + "celero", "chargebee", "checkout", "coinbase", @@ -22666,6 +22667,7 @@ "boku", "braintree", "cashtocode", + "celero", "chargebee", "checkout", "coinbase", diff --git a/config/config.example.toml b/config/config.example.toml index 3c6da56b240..0bb5cb13007 100644 --- a/config/config.example.toml +++ b/config/config.example.toml @@ -202,6 +202,7 @@ bluesnap.secondary_base_url = "https://sandpay.bluesnap.com/" boku.base_url = "https://$-api4-stage.boku.com" braintree.base_url = "https://payments.sandbox.braintree-api.com/graphql" cashtocode.base_url = "https://cluster05.api-test.cashtocode.com" +celero.base_url = "https://sandbox.gotnpgateway.com" chargebee.base_url = "https://$.chargebee.com/api/" checkbook.base_url = "https://api.sandbox.checkbook.io" checkout.base_url = "https://api.sandbox.checkout.com/" @@ -342,6 +343,7 @@ cards = [ "adyenplatform", "archipel", "authorizedotnet", + "celero", "coinbase", "coingate", "cryptopay", diff --git a/config/deployments/integration_test.toml b/config/deployments/integration_test.toml index 495847bd896..c92570aaeef 100644 --- a/config/deployments/integration_test.toml +++ b/config/deployments/integration_test.toml @@ -41,6 +41,7 @@ bluesnap.secondary_base_url = "https://sandpay.bluesnap.com/" boku.base_url = "https://$-api4-stage.boku.com" braintree.base_url = "https://payments.sandbox.braintree-api.com/graphql" cashtocode.base_url = "https://cluster05.api-test.cashtocode.com" +celero.base_url = "https://sandbox.gotnpgateway.com" chargebee.base_url = "https://$.chargebee.com/api/" checkbook.base_url = "https://api.sandbox.checkbook.io" checkout.base_url = "https://api.sandbox.checkout.com/" diff --git a/config/deployments/production.toml b/config/deployments/production.toml index 335d7f5acea..8e7fd10702c 100644 --- a/config/deployments/production.toml +++ b/config/deployments/production.toml @@ -45,6 +45,7 @@ bluesnap.secondary_base_url = "https://pay.bluesnap.com/" boku.base_url = "https://country-api4-stage.boku.com" braintree.base_url = "https://payments.braintree-api.com/graphql" cashtocode.base_url = "https://cluster14.api.cashtocode.com" +celero.base_url = "https://app.gotnpgateway.com" chargebee.base_url = "https://{{merchant_endpoint_prefix}}.chargebee.com/api/" checkbook.base_url = "https://api.checkbook.io" checkout.base_url = "https://api.checkout.com/" diff --git a/config/deployments/sandbox.toml b/config/deployments/sandbox.toml index 721e32b9b8e..2011b50b756 100644 --- a/config/deployments/sandbox.toml +++ b/config/deployments/sandbox.toml @@ -45,6 +45,7 @@ bluesnap.secondary_base_url = "https://sandpay.bluesnap.com/" boku.base_url = "https://$-api4-stage.boku.com" braintree.base_url = "https://payments.sandbox.braintree-api.com/graphql" cashtocode.base_url = "https://cluster05.api-test.cashtocode.com" +celero.base_url = "https://sandbox.gotnpgateway.com" checkbook.base_url = "https://api.sandbox.checkbook.io" checkout.base_url = "https://api.sandbox.checkout.com/" chargebee.base_url = "https://$.chargebee.com/api/" diff --git a/config/development.toml b/config/development.toml index ab885503c85..49e5bb8a52e 100644 --- a/config/development.toml +++ b/config/development.toml @@ -109,6 +109,7 @@ cards = [ "bluesnap", "boku", "braintree", + "celero", "checkbook", "checkout", "coinbase", @@ -238,6 +239,7 @@ bluesnap.secondary_base_url = "https://sandpay.bluesnap.com/" boku.base_url = "https://$-api4-stage.boku.com" braintree.base_url = "https://payments.sandbox.braintree-api.com/graphql" cashtocode.base_url = "https://cluster05.api-test.cashtocode.com" +celero.base_url = "https://sandbox.gotnpgateway.com" chargebee.base_url = "https://$.chargebee.com/api/" checkbook.base_url = "https://api.sandbox.checkbook.io" checkout.base_url = "https://api.sandbox.checkout.com/" diff --git a/config/docker_compose.toml b/config/docker_compose.toml index dbfeccf7cd0..329c3743d39 100644 --- a/config/docker_compose.toml +++ b/config/docker_compose.toml @@ -128,6 +128,7 @@ bluesnap.secondary_base_url = "https://sandpay.bluesnap.com/" boku.base_url = "https://$-api4-stage.boku.com" braintree.base_url = "https://payments.sandbox.braintree-api.com/graphql" cashtocode.base_url = "https://cluster05.api-test.cashtocode.com" +celero.base_url = "https://sandbox.gotnpgateway.com" chargebee.base_url = "https://$.chargebee.com/api/" checkbook.base_url = "https://api.sandbox.checkbook.io" checkout.base_url = "https://api.sandbox.checkout.com/" @@ -259,6 +260,7 @@ cards = [ "bluesnap", "boku", "braintree", + "celero", "checkout", "checkbook", "coinbase", diff --git a/crates/common_enums/src/connector_enums.rs b/crates/common_enums/src/connector_enums.rs index e975dc8bcbd..5251b9b3177 100644 --- a/crates/common_enums/src/connector_enums.rs +++ b/crates/common_enums/src/connector_enums.rs @@ -74,6 +74,7 @@ pub enum RoutableConnectors { Boku, Braintree, Cashtocode, + Celero, Chargebee, // Checkbook, Checkout, @@ -232,6 +233,7 @@ pub enum Connector { Boku, Braintree, Cashtocode, + Celero, Chargebee, // Checkbook, Checkout, @@ -417,6 +419,7 @@ impl Connector { \| Self::Boku \| Self::Braintree \| Self::Cashtocode + \| Self::Celero \| Self::Chargebee // \| Self::Checkbook \| Self::Coinbase @@ -580,6 +583,7 @@ impl From<RoutableConnectors> for Connector { RoutableConnectors::Boku => Self::Boku, RoutableConnectors::Braintree => Self::Braintree, RoutableConnectors::Cashtocode => Self::Cashtocode, + RoutableConnectors::Celero => Self::Celero, RoutableConnectors::Chargebee => Self::Chargebee, // RoutableConnectors::Checkbook => Self::Checkbook, RoutableConnectors::Checkout => Self::Checkout, @@ -701,6 +705,7 @@ impl TryFrom<Connector> for RoutableConnectors { Connector::Boku => Ok(Self::Boku), Connector::Braintree => Ok(Self::Braintree), Connector::Cashtocode => Ok(Self::Cashtocode), + Connector::Celero => Ok(Self::Celero), Connector::Chargebee => Ok(Self::Chargebee), // Connector::Checkbook => Ok(Self::Checkbook), Connector::Checkout => Ok(Self::Checkout), diff --git a/crates/connector_configs/src/connector.rs b/crates/connector_configs/src/connector.rs index 6ec11e8ca78..3e36dc023b9 100644 --- a/crates/connector_configs/src/connector.rs +++ b/crates/connector_configs/src/connector.rs @@ -190,6 +190,7 @@ pub struct ConnectorConfig { pub boku: Option<ConnectorTomlConfig>, pub braintree: Option<ConnectorTomlConfig>, pub cashtocode: Option<ConnectorTomlConfig>, + pub celero: Option<ConnectorTomlConfig>, pub chargebee: Option<ConnectorTomlConfig>, pub checkbook: Option<ConnectorTomlConfig>, pub checkout: Option<ConnectorTomlConfig>, @@ -381,6 +382,7 @@ impl ConnectorConfig { Connector::Boku => Ok(connector_data.boku), Connector::Braintree => Ok(connector_data.braintree), Connector::Cashtocode => Ok(connector_data.cashtocode), + Connector::Celero => Ok(connector_data.celero), Connector::Chargebee => Ok(connector_data.chargebee), Connector::Checkout => Ok(connector_data.checkout), Connector::Coinbase => Ok(connector_data.coinbase), diff --git a/crates/hyperswitch_connectors/src/connectors.rs b/crates/hyperswitch_connectors/src/connectors.rs index 16b56bed6fc..0861bbb4610 100644 --- a/crates/hyperswitch_connectors/src/connectors.rs +++ b/crates/hyperswitch_connectors/src/connectors.rs @@ -15,6 +15,7 @@ pub mod bluesnap; pub mod boku; pub mod braintree; pub mod cashtocode; +pub mod celero; pub mod chargebee; pub mod checkbook; pub mod checkout; @@ -116,26 +117,26 @@ pub use self::{ amazonpay::Amazonpay, archipel::Archipel, authorizedotnet::Authorizedotnet, bambora::Bambora, bamboraapac::Bamboraapac, bankofamerica::Bankofamerica, barclaycard::Barclaycard, billwerk::Billwerk, bitpay::Bitpay, bluesnap::Bluesnap, boku::Boku, braintree::Braintree, - cashtocode::Cashtocode, chargebee::Chargebee, checkbook::Checkbook, checkout::Checkout, - coinbase::Coinbase, coingate::Coingate, cryptopay::Cryptopay, ctp_mastercard::CtpMastercard, - cybersource::Cybersource, datatrans::Datatrans, deutschebank::Deutschebank, - digitalvirgo::Digitalvirgo, dlocal::Dlocal, dwolla::Dwolla, ebanx::Ebanx, elavon::Elavon, - facilitapay::Facilitapay, fiserv::Fiserv, fiservemea::Fiservemea, fiuu::Fiuu, forte::Forte, - getnet::Getnet, globalpay::Globalpay, globepay::Globepay, gocardless::Gocardless, - gpayments::Gpayments, helcim::Helcim, hipay::Hipay, hyperswitch_vault::HyperswitchVault, - iatapay::Iatapay, inespay::Inespay, itaubank::Itaubank, jpmorgan::Jpmorgan, - juspaythreedsserver::Juspaythreedsserver, klarna::Klarna, mifinity::Mifinity, mollie::Mollie, - moneris::Moneris, multisafepay::Multisafepay, netcetera::Netcetera, nexinets::Nexinets, - nexixpay::Nexixpay, nmi::Nmi, nomupay::Nomupay, noon::Noon, nordea::Nordea, novalnet::Novalnet, - nuvei::Nuvei, opayo::Opayo, opennode::Opennode, paybox::Paybox, payeezy::Payeezy, - payload::Payload, payme::Payme, payone::Payone, paypal::Paypal, paystack::Paystack, payu::Payu, - placetopay::Placetopay, plaid::Plaid, powertranz::Powertranz, prophetpay::Prophetpay, - rapyd::Rapyd, razorpay::Razorpay, recurly::Recurly, redsys::Redsys, riskified::Riskified, - santander::Santander, shift4::Shift4, signifyd::Signifyd, square::Square, stax::Stax, - stripe::Stripe, stripebilling::Stripebilling, taxjar::Taxjar, threedsecureio::Threedsecureio, - thunes::Thunes, tokenio::Tokenio, trustpay::Trustpay, tsys::Tsys, - unified_authentication_service::UnifiedAuthenticationService, vgs::Vgs, volt::Volt, - wellsfargo::Wellsfargo, wellsfargopayout::Wellsfargopayout, wise::Wise, worldline::Worldline, - worldpay::Worldpay, worldpayvantiv::Worldpayvantiv, worldpayxml::Worldpayxml, xendit::Xendit, - zen::Zen, zsl::Zsl, + cashtocode::Cashtocode, celero::Celero, chargebee::Chargebee, checkbook::Checkbook, + checkout::Checkout, coinbase::Coinbase, coingate::Coingate, cryptopay::Cryptopay, + ctp_mastercard::CtpMastercard, cybersource::Cybersource, datatrans::Datatrans, + deutschebank::Deutschebank, digitalvirgo::Digitalvirgo, dlocal::Dlocal, dwolla::Dwolla, + ebanx::Ebanx, elavon::Elavon, facilitapay::Facilitapay, fiserv::Fiserv, fiservemea::Fiservemea, + fiuu::Fiuu, forte::Forte, getnet::Getnet, globalpay::Globalpay, globepay::Globepay, + gocardless::Gocardless, gpayments::Gpayments, helcim::Helcim, hipay::Hipay, + hyperswitch_vault::HyperswitchVault, iatapay::Iatapay, inespay::Inespay, itaubank::Itaubank, + jpmorgan::Jpmorgan, juspaythreedsserver::Juspaythreedsserver, klarna::Klarna, + mifinity::Mifinity, mollie::Mollie, moneris::Moneris, multisafepay::Multisafepay, + netcetera::Netcetera, nexinets::Nexinets, nexixpay::Nexixpay, nmi::Nmi, nomupay::Nomupay, + noon::Noon, nordea::Nordea, novalnet::Novalnet, nuvei::Nuvei, opayo::Opayo, opennode::Opennode, + paybox::Paybox, payeezy::Payeezy, payload::Payload, payme::Payme, payone::Payone, + paypal::Paypal, paystack::Paystack, payu::Payu, placetopay::Placetopay, plaid::Plaid, + powertranz::Powertranz, prophetpay::Prophetpay, rapyd::Rapyd, razorpay::Razorpay, + recurly::Recurly, redsys::Redsys, riskified::Riskified, santander::Santander, shift4::Shift4, + signifyd::Signifyd, square::Square, stax::Stax, stripe::Stripe, stripebilling::Stripebilling, + taxjar::Taxjar, threedsecureio::Threedsecureio, thunes::Thunes, tokenio::Tokenio, + trustpay::Trustpay, tsys::Tsys, unified_authentication_service::UnifiedAuthenticationService, + vgs::Vgs, volt::Volt, wellsfargo::Wellsfargo, wellsfargopayout::Wellsfargopayout, wise::Wise, + worldline::Worldline, worldpay::Worldpay, worldpayvantiv::Worldpayvantiv, + worldpayxml::Worldpayxml, xendit::Xendit, zen::Zen, zsl::Zsl, }; diff --git a/crates/hyperswitch_connectors/src/connectors/celero.rs b/crates/hyperswitch_connectors/src/connectors/celero.rs new file mode 100644 index 00000000000..5d37d737355 --- /dev/null +++ b/crates/hyperswitch_connectors/src/connectors/celero.rs @@ -0,0 +1,571 @@ +pub mod transformers; + +use common_utils::{ + errors::CustomResult, + ext_traits::BytesExt, + request::{Method, Request, RequestBuilder, RequestContent}, + types::{AmountConvertor, StringMinorUnit, StringMinorUnitForConnector}, +}; +use error_stack::{report, ResultExt}; +use hyperswitch_domain_models::{ + router_data::{AccessToken, ConnectorAuthType, ErrorResponse, RouterData}, + router_flow_types::{ + access_token_auth::AccessTokenAuth, + payments::{Authorize, Capture, PSync, PaymentMethodToken, Session, SetupMandate, Void}, + refunds::{Execute, RSync}, + }, + router_request_types::{ + AccessTokenRequestData, PaymentMethodTokenizationData, PaymentsAuthorizeData, + PaymentsCancelData, PaymentsCaptureData, PaymentsSessionData, PaymentsSyncData, + RefundsData, SetupMandateRequestData, + }, + router_response_types::{PaymentsResponseData, RefundsResponseData}, + types::{ + PaymentsAuthorizeRouterData, PaymentsCaptureRouterData, PaymentsSyncRouterData, + RefundSyncRouterData, RefundsRouterData, + }, +}; +use hyperswitch_interfaces::{ + api::{ + self, ConnectorCommon, ConnectorCommonExt, ConnectorIntegration, ConnectorSpecifications, + ConnectorValidation, + }, + configs::Connectors, + errors, + events::connector_api_logs::ConnectorEvent, + types::{self, Response}, + webhooks, +}; +use masking::{ExposeInterface, Mask}; +use transformers as celero; + +use crate::{constants::headers, types::ResponseRouterData, utils}; + +#[derive(Clone)] +pub struct Celero { + amount_converter: &'static (dyn AmountConvertor<Output = StringMinorUnit> + Sync), +} + +impl Celero { + pub fn new() -> &'static Self { + &Self { + amount_converter: &StringMinorUnitForConnector, + } + } +} + +impl api::Payment for Celero {} +impl api::PaymentSession for Celero {} +impl api::ConnectorAccessToken for Celero {} +impl api::MandateSetup for Celero {} +impl api::PaymentAuthorize for Celero {} +impl api::PaymentSync for Celero {} +impl api::PaymentCapture for Celero {} +impl api::PaymentVoid for Celero {} +impl api::Refund for Celero {} +impl api::RefundExecute for Celero {} +impl api::RefundSync for Celero {} +impl api::PaymentToken for Celero {} + +impl ConnectorIntegration<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData> + for Celero +{ + // Not Implemented (R) +} + +impl<Flow, Request, Response> ConnectorCommonExt<Flow, Request, Response> for Celero +where + Self: ConnectorIntegration<Flow, Request, Response>, +{ + fn build_headers( + &self, + req: &RouterData<Flow, Request, Response>, + _connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + let mut header = vec![( + headers::CONTENT_TYPE.to_string(), + self.get_content_type().to_string().into(), + )]; + let mut api_key = self.get_auth_header(&req.connector_auth_type)?; + header.append(&mut api_key); + Ok(header) + } +} + +impl ConnectorCommon for Celero { + fn id(&self) -> &'static str { + "celero" + } + + fn get_currency_unit(&self) -> api::CurrencyUnit { + api::CurrencyUnit::Base + // TODO! Check connector documentation, on which unit they are processing the currency. + // If the connector accepts amount in lower unit ( i.e cents for USD) then return api::CurrencyUnit::Minor, + // if connector accepts amount in base unit (i.e dollars for USD) then return api::CurrencyUnit::Base + } + + fn common_get_content_type(&self) -> &'static str { + "application/json" + } + + fn base_url<'a>(&self, connectors: &'a Connectors) -> &'a str { + connectors.celero.base_url.as_ref() + } + + fn get_auth_header( + &self, + auth_type: &ConnectorAuthType, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + let auth = celero::CeleroAuthType::try_from(auth_type) + .change_context(errors::ConnectorError::FailedToObtainAuthType)?; + Ok(vec![( + headers::AUTHORIZATION.to_string(), + auth.api_key.expose().into_masked(), + )]) + } + + fn build_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + let response: celero::CeleroErrorResponse = res + .response + .parse_struct("CeleroErrorResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + + Ok(ErrorResponse { + status_code: res.status_code, + code: response.code, + message: response.message, + reason: response.reason, + attempt_status: None, + connector_transaction_id: None, + network_decline_code: None, + network_advice_code: None, + network_error_message: None, + }) + } +} + +impl ConnectorValidation for Celero { + //TODO: implement functions when support enabled +} + +impl ConnectorIntegration<Session, PaymentsSessionData, PaymentsResponseData> for Celero { + //TODO: implement sessions flow +} + +impl ConnectorIntegration<AccessTokenAuth, AccessTokenRequestData, AccessToken> for Celero {} + +impl ConnectorIntegration<SetupMandate, SetupMandateRequestData, PaymentsResponseData> for Celero {} + +impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData> for Celero { + fn get_headers( + &self, + req: &PaymentsAuthorizeRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsAuthorizeRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn get_request_body( + &self, + req: &PaymentsAuthorizeRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let amount = utils::convert_amount( + self.amount_converter, + req.request.minor_amount, + req.request.currency, + )?; + + let connector_router_data = celero::CeleroRouterData::from((amount, req)); + let connector_req = celero::CeleroPaymentsRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &PaymentsAuthorizeRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::PaymentsAuthorizeType::get_url( + self, req, connectors, + )?) + .attach_default_headers() + .headers(types::PaymentsAuthorizeType::get_headers( + self, req, connectors, + )?) + .set_body(types::PaymentsAuthorizeType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsAuthorizeRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsAuthorizeRouterData, errors::ConnectorError> { + let response: celero::CeleroPaymentsResponse = res + .response + .parse_struct("Celero PaymentsAuthorizeResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<PSync, PaymentsSyncData, PaymentsResponseData> for Celero { + fn get_headers( + &self, + req: &PaymentsSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsSyncRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn build_request( + &self, + req: &PaymentsSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Get) + .url(&types::PaymentsSyncType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::PaymentsSyncType::get_headers(self, req, connectors)?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsSyncRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsSyncRouterData, errors::ConnectorError> { + let response: celero::CeleroPaymentsResponse = res + .response + .parse_struct("celero PaymentsSyncResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<Capture, PaymentsCaptureData, PaymentsResponseData> for Celero { + fn get_headers( + &self, + req: &PaymentsCaptureRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsCaptureRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn get_request_body( + &self, + _req: &PaymentsCaptureRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_request_body method".to_string()).into()) + } + + fn build_request( + &self, + req: &PaymentsCaptureRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::PaymentsCaptureType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::PaymentsCaptureType::get_headers( + self, req, connectors, + )?) + .set_body(types::PaymentsCaptureType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsCaptureRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsCaptureRouterData, errors::ConnectorError> { + let response: celero::CeleroPaymentsResponse = res + .response + .parse_struct("Celero PaymentsCaptureResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<Void, PaymentsCancelData, PaymentsResponseData> for Celero {} + +impl ConnectorIntegration<Execute, RefundsData, RefundsResponseData> for Celero { + fn get_headers( + &self, + req: &RefundsRouterData<Execute>, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &RefundsRouterData<Execute>, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn get_request_body( + &self, + req: &RefundsRouterData<Execute>, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let refund_amount = utils::convert_amount( + self.amount_converter, + req.request.minor_refund_amount, + req.request.currency, + )?; + + let connector_router_data = celero::CeleroRouterData::from((refund_amount, req)); + let connector_req = celero::CeleroRefundRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &RefundsRouterData<Execute>, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + let request = RequestBuilder::new() + .method(Method::Post) + .url(&types::RefundExecuteType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::RefundExecuteType::get_headers( + self, req, connectors, + )?) + .set_body(types::RefundExecuteType::get_request_body( + self, req, connectors, + )?) + .build(); + Ok(Some(request)) + } + + fn handle_response( + &self, + data: &RefundsRouterData<Execute>, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<RefundsRouterData<Execute>, errors::ConnectorError> { + let response: celero::RefundResponse = + res.response + .parse_struct("celero RefundResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<RSync, RefundsData, RefundsResponseData> for Celero { + fn get_headers( + &self, + req: &RefundSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &RefundSyncRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn build_request( + &self, + req: &RefundSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Get) + .url(&types::RefundSyncType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::RefundSyncType::get_headers(self, req, connectors)?) + .set_body(types::RefundSyncType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &RefundSyncRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<RefundSyncRouterData, errors::ConnectorError> { + let response: celero::RefundResponse = res + .response + .parse_struct("celero RefundSyncResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +#[async_trait::async_trait] +impl webhooks::IncomingWebhook for Celero { + fn get_webhook_object_reference_id( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<api_models::webhooks::ObjectReferenceId, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } + + fn get_webhook_event_type( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<api_models::webhooks::IncomingWebhookEvent, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } + + fn get_webhook_resource_object( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<Box<dyn masking::ErasedMaskSerialize>, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } +} + +impl ConnectorSpecifications for Celero {} diff --git a/crates/hyperswitch_connectors/src/connectors/celero/transformers.rs b/crates/hyperswitch_connectors/src/connectors/celero/transformers.rs new file mode 100644 index 00000000000..2579c81ae6b --- /dev/null +++ b/crates/hyperswitch_connectors/src/connectors/celero/transformers.rs @@ -0,0 +1,228 @@ +use common_enums::enums; +use common_utils::types::StringMinorUnit; +use hyperswitch_domain_models::{ + payment_method_data::PaymentMethodData, + router_data::{ConnectorAuthType, RouterData}, + router_flow_types::refunds::{Execute, RSync}, + router_request_types::ResponseId, + router_response_types::{PaymentsResponseData, RefundsResponseData}, + types::{PaymentsAuthorizeRouterData, RefundsRouterData}, +}; +use hyperswitch_interfaces::errors; +use masking::Secret; +use serde::{Deserialize, Serialize}; + +use crate::{ + types::{RefundsResponseRouterData, ResponseRouterData}, + utils::PaymentsAuthorizeRequestData, +}; + +//TODO: Fill the struct with respective fields +pub struct CeleroRouterData<T> { + pub amount: StringMinorUnit, // The type of amount that a connector accepts, for example, String, i64, f64, etc. + pub router_data: T, +} + +impl<T> From<(StringMinorUnit, T)> for CeleroRouterData<T> { + fn from((amount, item): (StringMinorUnit, T)) -> Self { + //Todo : use utils to convert the amount to the type of amount that a connector accepts + Self { + amount, + router_data: item, + } + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Serialize, PartialEq)] +pub struct CeleroPaymentsRequest { + amount: StringMinorUnit, + card: CeleroCard, +} + +#[derive(Default, Debug, Serialize, Eq, PartialEq)] +pub struct CeleroCard { + number: cards::CardNumber, + expiry_month: Secret<String>, + expiry_year: Secret<String>, + cvc: Secret<String>, + complete: bool, +} + +impl TryFrom<&CeleroRouterData<&PaymentsAuthorizeRouterData>> for CeleroPaymentsRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: &CeleroRouterData<&PaymentsAuthorizeRouterData>, + ) -> Result<Self, Self::Error> { + match item.router_data.request.payment_method_data.clone() { + PaymentMethodData::Card(req_card) => { + let card = CeleroCard { + number: req_card.card_number, + expiry_month: req_card.card_exp_month, + expiry_year: req_card.card_exp_year, + cvc: req_card.card_cvc, + complete: item.router_data.request.is_auto_capture()?, + }; + Ok(Self { + amount: item.amount.clone(), + card, + }) + } + _ => Err(errors::ConnectorError::NotImplemented("Payment method".to_string()).into()), + } + } +} + +//TODO: Fill the struct with respective fields +// Auth Struct +pub struct CeleroAuthType { + pub(super) api_key: Secret<String>, +} + +impl TryFrom<&ConnectorAuthType> for CeleroAuthType { + 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)] +#[serde(rename_all = "lowercase")] +pub enum CeleroPaymentStatus { + Succeeded, + Failed, + #[default] + Processing, +} + +impl From<CeleroPaymentStatus> for common_enums::AttemptStatus { + fn from(item: CeleroPaymentStatus) -> Self { + match item { + CeleroPaymentStatus::Succeeded => Self::Charged, + CeleroPaymentStatus::Failed => Self::Failure, + CeleroPaymentStatus::Processing => Self::Authorizing, + } + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] +pub struct CeleroPaymentsResponse { + status: CeleroPaymentStatus, + id: String, +} + +impl<F, T> TryFrom<ResponseRouterData<F, CeleroPaymentsResponse, T, PaymentsResponseData>> + for RouterData<F, T, PaymentsResponseData> +{ + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: ResponseRouterData<F, CeleroPaymentsResponse, T, PaymentsResponseData>, + ) -> Result<Self, Self::Error> { + Ok(Self { + status: common_enums::AttemptStatus::from(item.response.status), + response: Ok(PaymentsResponseData::TransactionResponse { + resource_id: ResponseId::ConnectorTransactionId(item.response.id), + redirection_data: Box::new(None), + mandate_reference: Box::new(None), + connector_metadata: None, + network_txn_id: None, + connector_response_reference_id: None, + incremental_authorization_allowed: None, + charges: None, + }), + ..item.data + }) + } +} + +//TODO: Fill the struct with respective fields +// REFUND : +// Type definition for RefundRequest +#[derive(Default, Debug, Serialize)] +pub struct CeleroRefundRequest { + pub amount: StringMinorUnit, +} + +impl<F> TryFrom<&CeleroRouterData<&RefundsRouterData<F>>> for CeleroRefundRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from(item: &CeleroRouterData<&RefundsRouterData<F>>) -> Result<Self, Self::Error> { + Ok(Self { + amount: item.amount.to_owned(), + }) + } +} + +// Type definition for Refund Response + +#[allow(dead_code)] +#[derive(Debug, Serialize, Default, Deserialize, Clone)] +pub enum RefundStatus { + Succeeded, + Failed, + #[default] + Processing, +} + +impl From<RefundStatus> for enums::RefundStatus { + fn from(item: RefundStatus) -> Self { + match item { + RefundStatus::Succeeded => Self::Success, + RefundStatus::Failed => Self::Failure, + RefundStatus::Processing => Self::Pending, + //TODO: Review mapping + } + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Clone, Serialize, Deserialize)] +pub struct RefundResponse { + id: String, + status: RefundStatus, +} + +impl TryFrom<RefundsResponseRouterData<Execute, RefundResponse>> for RefundsRouterData<Execute> { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: RefundsResponseRouterData<Execute, RefundResponse>, + ) -> Result<Self, Self::Error> { + Ok(Self { + response: Ok(RefundsResponseData { + connector_refund_id: item.response.id.to_string(), + refund_status: enums::RefundStatus::from(item.response.status), + }), + ..item.data + }) + } +} + +impl TryFrom<RefundsResponseRouterData<RSync, RefundResponse>> for RefundsRouterData<RSync> { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: RefundsResponseRouterData<RSync, RefundResponse>, + ) -> Result<Self, Self::Error> { + Ok(Self { + response: Ok(RefundsResponseData { + connector_refund_id: item.response.id.to_string(), + refund_status: enums::RefundStatus::from(item.response.status), + }), + ..item.data + }) + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Serialize, Deserialize, PartialEq)] +pub struct CeleroErrorResponse { + pub status_code: u16, + pub code: String, + pub message: String, + pub reason: Option<String>, +} diff --git a/crates/hyperswitch_connectors/src/default_implementations.rs b/crates/hyperswitch_connectors/src/default_implementations.rs index a338b96bc55..a2a5c163865 100644 --- a/crates/hyperswitch_connectors/src/default_implementations.rs +++ b/crates/hyperswitch_connectors/src/default_implementations.rs @@ -159,6 +159,7 @@ default_imp_for_authorize_session_token!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -283,6 +284,7 @@ default_imp_for_calculate_tax!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -408,6 +410,7 @@ default_imp_for_session_update!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -533,6 +536,7 @@ default_imp_for_post_session_tokens!( connectors::Boku, connectors::Billwerk, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -657,6 +661,7 @@ default_imp_for_create_order!( connectors::Boku, connectors::Billwerk, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -782,6 +787,7 @@ default_imp_for_update_metadata!( connectors::Boku, connectors::Billwerk, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -905,6 +911,7 @@ default_imp_for_complete_authorize!( connectors::Bitpay, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1015,6 +1022,7 @@ default_imp_for_incremental_authorization!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1140,6 +1148,7 @@ default_imp_for_create_customer!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1259,6 +1268,7 @@ default_imp_for_connector_redirect_response!( connectors::Barclaycard, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Coinbase, @@ -1367,6 +1377,7 @@ default_imp_for_pre_processing_steps!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1483,6 +1494,7 @@ default_imp_for_post_processing_steps!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1609,6 +1621,7 @@ default_imp_for_approve!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1736,6 +1749,7 @@ default_imp_for_reject!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1863,6 +1877,7 @@ default_imp_for_webhook_source_verification!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1989,6 +2004,7 @@ default_imp_for_accept_dispute!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Coinbase, @@ -2114,6 +2130,7 @@ default_imp_for_submit_evidence!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Coinbase, @@ -2238,6 +2255,7 @@ default_imp_for_defend_dispute!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Coinbase, @@ -2372,6 +2390,7 @@ default_imp_for_file_upload!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Coinbase, @@ -2488,6 +2507,7 @@ default_imp_for_payouts!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -2608,6 +2628,7 @@ default_imp_for_payouts_create!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -2732,6 +2753,7 @@ default_imp_for_payouts_retrieve!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -2858,6 +2880,7 @@ default_imp_for_payouts_eligibility!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -2982,6 +3005,7 @@ default_imp_for_payouts_fulfill!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -3103,6 +3127,7 @@ default_imp_for_payouts_cancel!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -3228,6 +3253,7 @@ default_imp_for_payouts_quote!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -3354,6 +3380,7 @@ default_imp_for_payouts_recipient!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -3479,6 +3506,7 @@ default_imp_for_payouts_recipient_account!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -3606,6 +3634,7 @@ default_imp_for_frm_sale!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -3733,6 +3762,7 @@ default_imp_for_frm_checkout!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -3860,6 +3890,7 @@ default_imp_for_frm_transaction!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -3987,6 +4018,7 @@ default_imp_for_frm_fulfillment!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -4114,6 +4146,7 @@ default_imp_for_frm_record_return!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -4237,6 +4270,7 @@ default_imp_for_revoking_mandates!( connectors::Bluesnap, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -4360,6 +4394,7 @@ default_imp_for_uas_pre_authentication!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -4484,6 +4519,7 @@ default_imp_for_uas_post_authentication!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -4609,6 +4645,7 @@ default_imp_for_uas_authentication_confirmation!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -4726,6 +4763,7 @@ default_imp_for_connector_request_id!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -4845,6 +4883,7 @@ default_imp_for_fraud_check!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -4994,6 +5033,7 @@ default_imp_for_connector_authentication!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -5116,6 +5156,7 @@ default_imp_for_uas_authentication!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -5233,6 +5274,7 @@ default_imp_for_revenue_recovery!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -5361,6 +5403,7 @@ default_imp_for_billing_connector_payment_sync!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -5488,6 +5531,7 @@ default_imp_for_revenue_recovery_record_back!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Checkbook, connectors::Checkout, connectors::Coinbase, @@ -5613,6 +5657,7 @@ default_imp_for_billing_connector_invoice_sync!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -5733,6 +5778,7 @@ default_imp_for_external_vault!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -5859,6 +5905,7 @@ default_imp_for_external_vault_insert!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -5985,6 +6032,7 @@ default_imp_for_external_vault_retrieve!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -6111,6 +6159,7 @@ default_imp_for_external_vault_delete!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -6237,6 +6286,7 @@ default_imp_for_external_vault_create!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, diff --git a/crates/hyperswitch_connectors/src/default_implementations_v2.rs b/crates/hyperswitch_connectors/src/default_implementations_v2.rs index 99685607c48..2c3e849d4c9 100644 --- a/crates/hyperswitch_connectors/src/default_implementations_v2.rs +++ b/crates/hyperswitch_connectors/src/default_implementations_v2.rs @@ -264,6 +264,7 @@ default_imp_for_new_connector_integration_payment!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -391,6 +392,7 @@ default_imp_for_new_connector_integration_refund!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -513,6 +515,7 @@ default_imp_for_new_connector_integration_connector_access_token!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -641,6 +644,7 @@ default_imp_for_new_connector_integration_accept_dispute!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -767,6 +771,7 @@ default_imp_for_new_connector_integration_submit_evidence!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -893,6 +898,7 @@ default_imp_for_new_connector_integration_defend_dispute!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1030,6 +1036,7 @@ default_imp_for_new_connector_integration_file_upload!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1159,6 +1166,7 @@ default_imp_for_new_connector_integration_payouts_create!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1288,6 +1296,7 @@ default_imp_for_new_connector_integration_payouts_eligibility!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1417,6 +1426,7 @@ default_imp_for_new_connector_integration_payouts_fulfill!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1546,6 +1556,7 @@ default_imp_for_new_connector_integration_payouts_cancel!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1675,6 +1686,7 @@ default_imp_for_new_connector_integration_payouts_quote!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1804,6 +1816,7 @@ default_imp_for_new_connector_integration_payouts_recipient!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1933,6 +1946,7 @@ default_imp_for_new_connector_integration_payouts_sync!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -2062,6 +2076,7 @@ default_imp_for_new_connector_integration_payouts_recipient_account!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -2189,6 +2204,7 @@ default_imp_for_new_connector_integration_webhook_source_verification!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -2318,6 +2334,7 @@ default_imp_for_new_connector_integration_frm_sale!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -2447,6 +2464,7 @@ default_imp_for_new_connector_integration_frm_checkout!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -2576,6 +2594,7 @@ default_imp_for_new_connector_integration_frm_transaction!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -2705,6 +2724,7 @@ default_imp_for_new_connector_integration_frm_fulfillment!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -2834,6 +2854,7 @@ default_imp_for_new_connector_integration_frm_record_return!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -2960,6 +2981,7 @@ default_imp_for_new_connector_integration_revoking_mandates!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -3074,6 +3096,7 @@ default_imp_for_new_connector_integration_frm!( connectors::Bluesnap, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Checkbook, connectors::Coinbase, connectors::Cryptopay, @@ -3200,6 +3223,7 @@ default_imp_for_new_connector_integration_connector_authentication!( connectors::Bluesnap, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Checkbook, connectors::Coinbase, connectors::Cryptopay, @@ -3315,6 +3339,7 @@ default_imp_for_new_connector_integration_revenue_recovery!( connectors::Bluesnap, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Checkbook, connectors::Coinbase, connectors::Cryptopay, @@ -3446,6 +3471,7 @@ default_imp_for_new_connector_integration_external_vault!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, diff --git a/crates/hyperswitch_domain_models/src/configs.rs b/crates/hyperswitch_domain_models/src/configs.rs index 16fbd3e1d31..89f8ddf673f 100644 --- a/crates/hyperswitch_domain_models/src/configs.rs +++ b/crates/hyperswitch_domain_models/src/configs.rs @@ -29,6 +29,7 @@ pub struct Connectors { pub boku: ConnectorParams, pub braintree: ConnectorParams, pub cashtocode: ConnectorParams, + pub celero: ConnectorParams, pub chargebee: ConnectorParams, pub checkbook: ConnectorParams, pub checkout: ConnectorParams, diff --git a/crates/router/src/connector.rs b/crates/router/src/connector.rs index 4b12c47118b..49aa7c61cd9 100644 --- a/crates/router/src/connector.rs +++ b/crates/router/src/connector.rs @@ -9,31 +9,32 @@ pub use hyperswitch_connectors::connectors::{ bamboraapac::Bamboraapac, bankofamerica, bankofamerica::Bankofamerica, barclaycard, barclaycard::Barclaycard, billwerk, billwerk::Billwerk, bitpay, bitpay::Bitpay, bluesnap, bluesnap::Bluesnap, boku, boku::Boku, braintree, braintree::Braintree, cashtocode, - cashtocode::Cashtocode, chargebee, chargebee::Chargebee, checkbook, checkbook::Checkbook, - checkout, checkout::Checkout, coinbase, coinbase::Coinbase, coingate, coingate::Coingate, - cryptopay, cryptopay::Cryptopay, ctp_mastercard, ctp_mastercard::CtpMastercard, cybersource, - cybersource::Cybersource, datatrans, datatrans::Datatrans, deutschebank, - deutschebank::Deutschebank, digitalvirgo, digitalvirgo::Digitalvirgo, dlocal, dlocal::Dlocal, - dwolla, dwolla::Dwolla, ebanx, ebanx::Ebanx, elavon, elavon::Elavon, facilitapay, - facilitapay::Facilitapay, fiserv, fiserv::Fiserv, fiservemea, fiservemea::Fiservemea, fiuu, - fiuu::Fiuu, forte, forte::Forte, getnet, getnet::Getnet, globalpay, globalpay::Globalpay, - globepay, globepay::Globepay, gocardless, gocardless::Gocardless, gpayments, - gpayments::Gpayments, helcim, helcim::Helcim, hipay, hipay::Hipay, hyperswitch_vault, - hyperswitch_vault::HyperswitchVault, iatapay, iatapay::Iatapay, inespay, inespay::Inespay, - itaubank, itaubank::Itaubank, jpmorgan, jpmorgan::Jpmorgan, juspaythreedsserver, - juspaythreedsserver::Juspaythreedsserver, klarna, klarna::Klarna, mifinity, mifinity::Mifinity, - mollie, mollie::Mollie, moneris, moneris::Moneris, multisafepay, multisafepay::Multisafepay, - netcetera, netcetera::Netcetera, nexinets, nexinets::Nexinets, nexixpay, nexixpay::Nexixpay, - nmi, nmi::Nmi, nomupay, nomupay::Nomupay, noon, noon::Noon, nordea, nordea::Nordea, novalnet, - novalnet::Novalnet, nuvei, nuvei::Nuvei, opayo, opayo::Opayo, opennode, opennode::Opennode, - paybox, paybox::Paybox, payeezy, payeezy::Payeezy, payload, payload::Payload, payme, - payme::Payme, payone, payone::Payone, paypal, paypal::Paypal, paystack, paystack::Paystack, - payu, payu::Payu, placetopay, placetopay::Placetopay, plaid, plaid::Plaid, powertranz, - powertranz::Powertranz, prophetpay, prophetpay::Prophetpay, rapyd, rapyd::Rapyd, razorpay, - razorpay::Razorpay, recurly, recurly::Recurly, redsys, redsys::Redsys, riskified, - riskified::Riskified, santander, santander::Santander, shift4, shift4::Shift4, signifyd, - signifyd::Signifyd, square, square::Square, stax, stax::Stax, stripe, stripe::Stripe, - stripebilling, stripebilling::Stripebilling, taxjar, taxjar::Taxjar, threedsecureio, + cashtocode::Cashtocode, celero, celero::Celero, chargebee, chargebee::Chargebee, checkbook, + checkbook::Checkbook, checkout, checkout::Checkout, coinbase, coinbase::Coinbase, coingate, + coingate::Coingate, cryptopay, cryptopay::Cryptopay, ctp_mastercard, + ctp_mastercard::CtpMastercard, cybersource, cybersource::Cybersource, datatrans, + datatrans::Datatrans, deutschebank, deutschebank::Deutschebank, digitalvirgo, + digitalvirgo::Digitalvirgo, dlocal, dlocal::Dlocal, dwolla, dwolla::Dwolla, ebanx, + ebanx::Ebanx, elavon, elavon::Elavon, facilitapay, facilitapay::Facilitapay, fiserv, + fiserv::Fiserv, fiservemea, fiservemea::Fiservemea, fiuu, fiuu::Fiuu, forte, forte::Forte, + getnet, getnet::Getnet, globalpay, globalpay::Globalpay, globepay, globepay::Globepay, + gocardless, gocardless::Gocardless, gpayments, gpayments::Gpayments, helcim, helcim::Helcim, + hipay, hipay::Hipay, hyperswitch_vault, hyperswitch_vault::HyperswitchVault, iatapay, + iatapay::Iatapay, inespay, inespay::Inespay, itaubank, itaubank::Itaubank, jpmorgan, + jpmorgan::Jpmorgan, juspaythreedsserver, juspaythreedsserver::Juspaythreedsserver, klarna, + klarna::Klarna, mifinity, mifinity::Mifinity, mollie, mollie::Mollie, moneris, + moneris::Moneris, multisafepay, multisafepay::Multisafepay, netcetera, netcetera::Netcetera, + nexinets, nexinets::Nexinets, nexixpay, nexixpay::Nexixpay, nmi, nmi::Nmi, nomupay, + nomupay::Nomupay, noon, noon::Noon, nordea, nordea::Nordea, novalnet, novalnet::Novalnet, + nuvei, nuvei::Nuvei, opayo, opayo::Opayo, opennode, opennode::Opennode, paybox, paybox::Paybox, + payeezy, payeezy::Payeezy, payload, payload::Payload, payme, payme::Payme, payone, + payone::Payone, paypal, paypal::Paypal, paystack, paystack::Paystack, payu, payu::Payu, + placetopay, placetopay::Placetopay, plaid, plaid::Plaid, powertranz, powertranz::Powertranz, + prophetpay, prophetpay::Prophetpay, rapyd, rapyd::Rapyd, razorpay, razorpay::Razorpay, recurly, + recurly::Recurly, redsys, redsys::Redsys, riskified, riskified::Riskified, santander, + santander::Santander, shift4, shift4::Shift4, signifyd, signifyd::Signifyd, square, + square::Square, stax, stax::Stax, stripe, stripe::Stripe, stripebilling, + stripebilling::Stripebilling, taxjar, taxjar::Taxjar, threedsecureio, threedsecureio::Threedsecureio, thunes, thunes::Thunes, tokenio, tokenio::Tokenio, trustpay, trustpay::Trustpay, tsys, tsys::Tsys, unified_authentication_service, unified_authentication_service::UnifiedAuthenticationService, vgs, vgs::Vgs, volt, volt::Volt, diff --git a/crates/router/src/core/connector_validation.rs b/crates/router/src/core/connector_validation.rs index d23a3a175f7..655636197d8 100644 --- a/crates/router/src/core/connector_validation.rs +++ b/crates/router/src/core/connector_validation.rs @@ -136,7 +136,10 @@ impl ConnectorAuthTypeAndMetadataValidation<'_> { } api_enums::Connector::Chargebee => { chargebee::transformers::ChargebeeAuthType::try_from(self.auth_type)?; - chargebee::transformers::ChargebeeMetadata::try_from(self.connector_meta_data)?; + Ok(()) + } + api_enums::Connector::Celero => { + celero::transformers::CeleroAuthType::try_from(self.auth_type)?; Ok(()) } // api_enums::Connector::Checkbook => { diff --git a/crates/router/src/types/api.rs b/crates/router/src/types/api.rs index 3fa8aebf2cf..45d6dd0d75e 100644 --- a/crates/router/src/types/api.rs +++ b/crates/router/src/types/api.rs @@ -372,6 +372,9 @@ impl ConnectorData { enums::Connector::Cashtocode => { Ok(ConnectorEnum::Old(Box::new(connector::Cashtocode::new()))) } + enums::Connector::Celero => { + Ok(ConnectorEnum::Old(Box::new(connector::Celero::new()))) + } enums::Connector::Chargebee => { Ok(ConnectorEnum::Old(Box::new(connector::Chargebee::new()))) } diff --git a/crates/router/src/types/transformers.rs b/crates/router/src/types/transformers.rs index 284a5243d05..713293568b3 100644 --- a/crates/router/src/types/transformers.rs +++ b/crates/router/src/types/transformers.rs @@ -223,6 +223,7 @@ impl ForeignTryFrom<api_enums::Connector> for common_enums::RoutableConnectors { api_enums::Connector::Boku => Self::Boku, api_enums::Connector::Braintree => Self::Braintree, api_enums::Connector::Cashtocode => Self::Cashtocode, + api_enums::Connector::Celero => Self::Celero, api_enums::Connector::Chargebee => Self::Chargebee, // api_enums::Connector::Checkbook => Self::Checkbook, api_enums::Connector::Checkout => Self::Checkout, diff --git a/crates/router/tests/connectors/celero.rs b/crates/router/tests/connectors/celero.rs new file mode 100644 index 00000000000..7d4e942471b --- /dev/null +++ b/crates/router/tests/connectors/celero.rs @@ -0,0 +1,420 @@ +use masking::Secret; +use router::types::{self, api, domain, storage::enums}; +use test_utils::connector_auth; + +use crate::utils::{self, ConnectorActions}; + +#[derive(Clone, Copy)] +struct CeleroTest; +impl ConnectorActions for CeleroTest {} +impl utils::Connector for CeleroTest { + fn get_data(&self) -> api::ConnectorData { + use router::connector::Celero; + utils::construct_connector_data_old( + Box::new(Celero::new()), + types::Connector::Celero, + api::GetToken::Connector, + None, + ) + } + + fn get_auth_token(&self) -> types::ConnectorAuthType { + utils::to_connector_auth_type( + connector_auth::ConnectorAuthentication::new() + .celero + .expect("Missing connector authentication configuration") + .into(), + ) + } + + fn get_name(&self) -> String { + "celero".to_string() + } +} + +static CONNECTOR: CeleroTest = CeleroTest {}; + +fn get_default_payment_info() -> Option<utils::PaymentInfo> { + None +} + +fn payment_method_details() -> Option<types::PaymentsAuthorizeData> { + None +} + +// Cards Positive Tests +// Creates a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_only_authorize_payment() { + let response = CONNECTOR + .authorize_payment(payment_method_details(), get_default_payment_info()) + .await + .expect("Authorize payment response"); + assert_eq!(response.status, enums::AttemptStatus::Authorized); +} + +// Captures a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_capture_authorized_payment() { + let response = CONNECTOR + .authorize_and_capture_payment(payment_method_details(), None, get_default_payment_info()) + .await + .expect("Capture payment response"); + assert_eq!(response.status, enums::AttemptStatus::Charged); +} + +// Partially captures a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_capture_authorized_payment() { + let response = CONNECTOR + .authorize_and_capture_payment( + payment_method_details(), + Some(types::PaymentsCaptureData { + amount_to_capture: 50, + ..utils::PaymentCaptureType::default().0 + }), + get_default_payment_info(), + ) + .await + .expect("Capture payment response"); + assert_eq!(response.status, enums::AttemptStatus::Charged); +} + +// Synchronizes a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_authorized_payment() { + let authorize_response = CONNECTOR + .authorize_payment(payment_method_details(), get_default_payment_info()) + .await + .expect("Authorize payment response"); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + let response = CONNECTOR + .psync_retry_till_status_matches( + enums::AttemptStatus::Authorized, + Some(types::PaymentsSyncData { + connector_transaction_id: types::ResponseId::ConnectorTransactionId( + txn_id.unwrap(), + ), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .expect("PSync response"); + assert_eq!(response.status, enums::AttemptStatus::Authorized,); +} + +// Voids a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_void_authorized_payment() { + let response = CONNECTOR + .authorize_and_void_payment( + payment_method_details(), + Some(types::PaymentsCancelData { + connector_transaction_id: String::from(""), + cancellation_reason: Some("requested_by_customer".to_string()), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .expect("Void payment response"); + assert_eq!(response.status, enums::AttemptStatus::Voided); +} + +// Refunds a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_manually_captured_payment() { + let response = CONNECTOR + .capture_payment_and_refund( + payment_method_details(), + None, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Partially refunds a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_refund_manually_captured_payment() { + let response = CONNECTOR + .capture_payment_and_refund( + payment_method_details(), + None, + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Synchronizes a refund using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_manually_captured_refund() { + let refund_response = CONNECTOR + .capture_payment_and_refund( + payment_method_details(), + None, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + let response = CONNECTOR + .rsync_retry_till_status_matches( + enums::RefundStatus::Success, + refund_response.response.unwrap().connector_refund_id, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Creates a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_make_payment() { + let authorize_response = CONNECTOR + .make_payment(payment_method_details(), get_default_payment_info()) + .await + .unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); +} + +// Synchronizes a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_auto_captured_payment() { + let authorize_response = CONNECTOR + .make_payment(payment_method_details(), get_default_payment_info()) + .await + .unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + assert_ne!(txn_id, None, "Empty connector transaction id"); + let response = CONNECTOR + .psync_retry_till_status_matches( + enums::AttemptStatus::Charged, + Some(types::PaymentsSyncData { + connector_transaction_id: types::ResponseId::ConnectorTransactionId( + txn_id.unwrap(), + ), + capture_method: Some(enums::CaptureMethod::Automatic), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!(response.status, enums::AttemptStatus::Charged,); +} + +// Refunds a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_auto_captured_payment() { + let response = CONNECTOR + .make_payment_and_refund(payment_method_details(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Partially refunds a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_refund_succeeded_payment() { + let refund_response = CONNECTOR + .make_payment_and_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + refund_response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Creates multiple refunds against a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_succeeded_payment_multiple_times() { + CONNECTOR + .make_payment_and_multiple_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await; +} + +// Synchronizes a refund using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_refund() { + let refund_response = CONNECTOR + .make_payment_and_refund(payment_method_details(), None, get_default_payment_info()) + .await + .unwrap(); + let response = CONNECTOR + .rsync_retry_till_status_matches( + enums::RefundStatus::Success, + refund_response.response.unwrap().connector_refund_id, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Cards Negative scenarios +// Creates a payment with incorrect CVC. +#[actix_web::test] +async fn should_fail_payment_for_incorrect_cvc() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: domain::PaymentMethodData::Card(domain::Card { + card_cvc: Secret::new("12345".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's security code is invalid.".to_string(), + ); +} + +// Creates a payment with incorrect expiry month. +#[actix_web::test] +async fn should_fail_payment_for_invalid_exp_month() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: domain::PaymentMethodData::Card(domain::Card { + card_exp_month: Secret::new("20".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's expiration month is invalid.".to_string(), + ); +} + +// Creates a payment with incorrect expiry year. +#[actix_web::test] +async fn should_fail_payment_for_incorrect_expiry_year() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: domain::PaymentMethodData::Card(domain::Card { + card_exp_year: Secret::new("2000".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's expiration year is invalid.".to_string(), + ); +} + +// Voids a payment using automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_fail_void_payment_for_auto_capture() { + let authorize_response = CONNECTOR + .make_payment(payment_method_details(), get_default_payment_info()) + .await + .unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + assert_ne!(txn_id, None, "Empty connector transaction id"); + let void_response = CONNECTOR + .void_payment(txn_id.unwrap(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + void_response.response.unwrap_err().message, + "You cannot cancel this PaymentIntent because it has a status of succeeded." + ); +} + +// Captures a payment using invalid connector payment id. +#[actix_web::test] +async fn should_fail_capture_for_invalid_payment() { + let capture_response = CONNECTOR + .capture_payment("123456789".to_string(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + capture_response.response.unwrap_err().message, + String::from("No such payment_intent: '123456789'") + ); +} + +// Refunds a payment with refund amount higher than payment amount. +#[actix_web::test] +async fn should_fail_for_refund_amount_higher_than_payment_amount() { + let response = CONNECTOR + .make_payment_and_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 150, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Refund amount (₹1.50) is greater than charge amount (₹1.00)", + ); +} + +// Connector dependent test cases goes here + +// [#478]: add unit tests for non 3DS, wallets & webhooks in connector tests diff --git a/crates/router/tests/connectors/main.rs b/crates/router/tests/connectors/main.rs index 90af2bd8d80..10707ba2f4e 100644 --- a/crates/router/tests/connectors/main.rs +++ b/crates/router/tests/connectors/main.rs @@ -23,6 +23,7 @@ mod bitpay; mod bluesnap; mod boku; mod cashtocode; +mod celero; mod chargebee; mod checkbook; mod checkout; diff --git a/crates/test_utils/src/connector_auth.rs b/crates/test_utils/src/connector_auth.rs index fd0f9180910..31141205523 100644 --- a/crates/test_utils/src/connector_auth.rs +++ b/crates/test_utils/src/connector_auth.rs @@ -29,6 +29,7 @@ pub struct ConnectorAuthentication { pub bluesnap: Option<BodyKey>, pub boku: Option<BodyKey>, pub cashtocode: Option<BodyKey>, + pub celero: Option<HeaderKey>, pub chargebee: Option<HeaderKey>, pub checkbook: Option<BodyKey>, pub checkout: Option<SignatureKey>, diff --git a/loadtest/config/development.toml b/loadtest/config/development.toml index 28e3e724c3a..d2c62a57796 100644 --- a/loadtest/config/development.toml +++ b/loadtest/config/development.toml @@ -95,6 +95,7 @@ bluesnap.secondary_base_url = "https://sandpay.bluesnap.com/" boku.base_url = "https://country-api4-stage.boku.com" braintree.base_url = "https://payments.sandbox.braintree-api.com/graphql" cashtocode.base_url = "https://cluster05.api-test.cashtocode.com" +celero.base_url = "https://sandbox.gotnpgateway.com" chargebee.base_url = "https://$.chargebee.com/api/" checkbook.base_url = "https://api.sandbox.checkbook.io" checkout.base_url = "https://api.sandbox.checkout.com/" @@ -225,6 +226,7 @@ cards = [ "bluesnap", "boku", "braintree", + "celero", "checkbook", "checkout", "coinbase", @@ -332,36 +334,36 @@ przelewy24 = { country = "PL", currency = "PLN,EUR" } mifinity = { country = "BR,CN,SG,MY,DE,CH,DK,GB,ES,AD,GI,FI,FR,GR,HR,IT,JP,MX,AR,CO,CL,PE,VE,UY,PY,BO,EC,GT,HN,SV,NI,CR,PA,DO,CU,PR,NL,NO,PL,PT,SE,RU,TR,TW,HK,MO,AX,AL,DZ,AS,AO,AI,AG,AM,AW,AU,AT,AZ,BS,BH,BD,BB,BE,BZ,BJ,BM,BT,BQ,BA,BW,IO,BN,BG,BF,BI,KH,CM,CA,CV,KY,CF,TD,CX,CC,KM,CG,CK,CI,CW,CY,CZ,DJ,DM,EG,GQ,ER,EE,ET,FK,FO,FJ,GF,PF,TF,GA,GM,GE,GH,GL,GD,GP,GU,GG,GN,GW,GY,HT,HM,VA,IS,IN,ID,IE,IM,IL,JE,JO,KZ,KE,KI,KW,KG,LA,LV,LB,LS,LI,LT,LU,MK,MG,MW,MV,ML,MT,MH,MQ,MR,MU,YT,FM,MD,MC,MN,ME,MS,MA,MZ,NA,NR,NP,NC,NZ,NE,NG,NU,NF,MP,OM,PK,PW,PS,PG,PH,PN,QA,RE,RO,RW,BL,SH,KN,LC,MF,PM,VC,WS,SM,ST,SA,SN,RS,SC,SL,SX,SK,SI,SB,SO,ZA,GS,KR,LK,SR,SJ,SZ,TH,TL,TG,TK,TO,TT,TN,TM,TC,TV,UG,UA,AE,UZ,VU,VN,VG,VI,WF,EH,ZM", currency = "AUD,CAD,CHF,CNY,CZK,DKK,EUR,GBP,INR,JPY,NOK,NZD,PLN,RUB,SEK,ZAR,USD,EGP,UYU,UZS" } [pm_filters.globepay] -ali_pay = { country = "GB",currency = "GBP,CNY" } -we_chat_pay = { country = "GB",currency = "GBP,CNY" } +ali_pay = { country = "GB", currency = "GBP,CNY" } +we_chat_pay = { country = "GB", currency = "GBP,CNY" } [pm_filters.itaubank] pix = { country = "BR", currency = "BRL" } [pm_filters.nexinets] -credit = { country = "DE",currency = "EUR" } -debit = { country = "DE",currency = "EUR" } -ideal = { country = "DE",currency = "EUR" } -giropay = { country = "DE",currency = "EUR" } -sofort = { country = "DE",currency = "EUR" } -eps = { country = "DE",currency = "EUR" } -apple_pay = { country = "DE",currency = "EUR" } -paypal = { country = "DE",currency = "EUR" } +credit = { country = "DE", currency = "EUR" } +debit = { country = "DE", currency = "EUR" } +ideal = { country = "DE", currency = "EUR" } +giropay = { country = "DE", currency = "EUR" } +sofort = { country = "DE", currency = "EUR" } +eps = { country = "DE", currency = "EUR" } +apple_pay = { country = "DE", currency = "EUR" } +paypal = { country = "DE", currency = "EUR" } [pm_filters.nuvei] -credit = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US",currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } -debit = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US",currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } -klarna = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US",currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } -afterpay_clearpay = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US",currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } -ideal = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US",currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } -giropay = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US",currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } -sofort = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US",currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } -eps = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US",currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } -apple_pay = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US",currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } -google_pay = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US",currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } -paypal = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US",currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } +credit = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US", currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } +debit = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US", currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } +klarna = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US", currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } +afterpay_clearpay = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US", currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } +ideal = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US", currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } +giropay = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US", currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } +sofort = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US", currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } +eps = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US", currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } +apple_pay = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US", currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } +google_pay = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US", currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } +paypal = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US", currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } [pm_filters.prophetpay] card_redirect = { country = "US", currency = "USD" } @@ -495,16 +497,16 @@ crypto_currency = { country = "US, CA, GB, AU, BR, MX, SG, PH, NZ, ZA, JP, AT, B klarna = { country = "AU,AT,BE,CA,CZ,DK,FI,FR,DE,GR,IE,IT,NL,NZ,NO,PL,PT,ES,SE,CH,GB,US", currency = "CHF,DKK,EUR,GBP,NOK,PLN,SEK,USD,AUD,NZD,CAD" } [pm_filters.bluesnap] -credit = { country = "AD,AE,AG,AL,AM,AO,AR,AT,AU,AZ,BA,BB,BD,BE,BG,BH,BI,BJ,BN,BO,BR,BS,BT,BW,BY,BZ,CA,CD,CF,CG,CH,CI,CL,CM,CN,CO,CR,CV,CY,CZ,DE,DK,DJ,DM,DO,DZ,EC,EE,EG,ER,ES,ET,FI,FJ,FM,FR,GA,GB,GD,GE,GG,GH,GM,GN,GQ,GR,GT,GW,GY,HN,HR,HT,HU,ID,IE,IL,IN,IS,IT,JM,JP,JO,KE,KG,KH,KI,KM,KN,KR,KW,KZ,LA,LB,LC,LI,LK,LR,LS,LT,LU,LV,MA,MC,MD,ME,MG,MH,MK,ML,MM,MN,MR,MT,MU,MV,MW,MX,MY,MZ,NA,NE,NG,NI,NL,NO,NP,NR,NZ,OM,PA,PE,PG,PH,PK,PL,PS,PT,PW,PY,QA,RO,RS,RW,SA,SB,SC,SE,SG,SI,SK,SL,SM,SN,SO,SR,SS,ST,SV,SZ,TD,TG,TH,TJ,TL,TM,TN,TO,TR,TT,TV,TZ,UA,UG,US,UY,UZ,VA,VC,VE,VN,VU,WS,ZA,ZM,ZW", currency = "AED,AFN,ALL,AMD,ANG,ARS,AUD,AWG,BAM,BBD,BGN,BHD,BMD,BND,BOB,BRL,BSD,BWP,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,FJD,GBP,GEL,GIP,GTQ,HKD,HUF,IDR,ILS,INR,ISK,JMD,JPY,KES,KHR,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MUR,MWK,MXN,MYR,NAD,NGN,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PLN,PKR,QAR,RON,RSD,RUB,SAR,SCR,SDG,SEK,SGD,THB,TND,TRY,TTD,TWD,TZS,UAH,USD,UYU,UZS,VND,XAF,XCD,XOF,ZAR"} -google_pay = { country = "AD,AE,AG,AL,AM,AO,AR,AT,AU,AZ,BA,BB,BD,BE,BG,BH,BI,BJ,BN,BO,BR,BS,BT,BW,BY,BZ,CA,CD,CF,CG,CH,CI,CL,CM,CN,CO,CR,CV,CY,CZ,DE,DK,DJ,DM,DO,DZ,EC,EE,EG,ER,ES,ET,FI,FJ,FM,FR,GA,GB,GD,GE,GG,GH,GM,GN,GQ,GR,GT,GW,GY,HN,HR,HT,HU,ID,IE,IL,IN,IS,IT,JM,JP,JO,KE,KG,KH,KI,KM,KN,KR,KW,KZ,LA,LB,LC,LI,LK,LR,LS,LT,LU,LV,MA,MC,MD,ME,MG,MH,MK,ML,MM,MN,MR,MT,MU,MV,MW,MX,MY,MZ,NA,NE,NG,NI,NL,NO,NP,NR,NZ,OM,PA,PE,PG,PH,PK,PL,PS,PT,PW,PY,QA,RO,RS,RW,SA,SB,SC,SE,SG,SI,SK,SL,SM,SN,SO,SR,SS,ST,SV,SZ,TD,TG,TH,TJ,TL,TM,TN,TO,TR,TT,TV,TZ,UA,UG,US,UY,UZ,VA,VC,VE,VN,VU,WS,ZA,ZM,ZW", currency = "AED,AFN,ALL,AMD,ANG,ARS,AUD,AWG,BAM,BBD,BGN,BHD,BMD,BND,BOB,BRL,BSD,BWP,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,FJD,GBP,GEL,GIP,GTQ,HKD,HUF,IDR,ILS,INR,ISK,JMD,JPY,KES,KHR,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MUR,MWK,MXN,MYR,NAD,NGN,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PLN,PKR,QAR,RON,RSD,RUB,SAR,SCR,SDG,SEK,SGD,THB,TND,TRY,TTD,TWD,TZS,UAH,USD,UYU,UZS,VND,XAF,XCD,XOF,ZAR"} -apple_pay = { country = "AD,AE,AG,AL,AM,AO,AR,AT,AU,AZ,BA,BB,BD,BE,BG,BH,BI,BJ,BN,BO,BR,BS,BT,BW,BY,BZ,CA,CD,CF,CG,CH,CI,CL,CM,CN,CO,CR,CV,CY,CZ,DE,DK,DJ,DM,DO,DZ,EC,EE,EG,ER,ES,ET,FI,FJ,FM,FR,GA,GB,GD,GE,GG,GH,GM,GN,GQ,GR,GT,GW,GY,HN,HR,HT,HU,ID,IE,IL,IN,IS,IT,JM,JP,JO,KE,KG,KH,KI,KM,KN,KR,KW,KZ,LA,LB,LC,LI,LK,LR,LS,LT,LU,LV,MA,MC,MD,ME,MG,MH,MK,ML,MM,MN,MR,MT,MU,MV,MW,MX,MY,MZ,NA,NE,NG,NI,NL,NO,NP,NR,NZ,OM,PA,PE,PG,PH,PK,PL,PS,PT,PW,PY,QA,RO,RS,RW,SA,SB,SC,SE,SG,SI,SK,SL,SM,SN,SO,SR,SS,ST,SV,SZ,TD,TG,TH,TJ,TL,TM,TN,TO,TR,TT,TV,TZ,UA,UG,US,UY,UZ,VA,VC,VE,VN,VU,WS,ZA,ZM,ZW", currency = "AED,AFN,ALL,AMD,ANG,ARS,AUD,AWG,BAM,BBD,BGN,BHD,BMD,BND,BOB,BRL,BSD,BWP,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,FJD,GBP,GEL,GIP,GTQ,HKD,HUF,IDR,ILS,INR,ISK,JMD,JPY,KES,KHR,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MUR,MWK,MXN,MYR,NAD,NGN,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PLN,PKR,QAR,RON,RSD,RUB,SAR,SCR,SDG,SEK,SGD,THB,TND,TRY,TTD,TWD,TZS,UAH,USD,UYU,UZS,VND,XAF,XCD,XOF,ZAR"} +credit = { country = "AD,AE,AG,AL,AM,AO,AR,AT,AU,AZ,BA,BB,BD,BE,BG,BH,BI,BJ,BN,BO,BR,BS,BT,BW,BY,BZ,CA,CD,CF,CG,CH,CI,CL,CM,CN,CO,CR,CV,CY,CZ,DE,DK,DJ,DM,DO,DZ,EC,EE,EG,ER,ES,ET,FI,FJ,FM,FR,GA,GB,GD,GE,GG,GH,GM,GN,GQ,GR,GT,GW,GY,HN,HR,HT,HU,ID,IE,IL,IN,IS,IT,JM,JP,JO,KE,KG,KH,KI,KM,KN,KR,KW,KZ,LA,LB,LC,LI,LK,LR,LS,LT,LU,LV,MA,MC,MD,ME,MG,MH,MK,ML,MM,MN,MR,MT,MU,MV,MW,MX,MY,MZ,NA,NE,NG,NI,NL,NO,NP,NR,NZ,OM,PA,PE,PG,PH,PK,PL,PS,PT,PW,PY,QA,RO,RS,RW,SA,SB,SC,SE,SG,SI,SK,SL,SM,SN,SO,SR,SS,ST,SV,SZ,TD,TG,TH,TJ,TL,TM,TN,TO,TR,TT,TV,TZ,UA,UG,US,UY,UZ,VA,VC,VE,VN,VU,WS,ZA,ZM,ZW", currency = "AED,AFN,ALL,AMD,ANG,ARS,AUD,AWG,BAM,BBD,BGN,BHD,BMD,BND,BOB,BRL,BSD,BWP,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,FJD,GBP,GEL,GIP,GTQ,HKD,HUF,IDR,ILS,INR,ISK,JMD,JPY,KES,KHR,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MUR,MWK,MXN,MYR,NAD,NGN,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PLN,PKR,QAR,RON,RSD,RUB,SAR,SCR,SDG,SEK,SGD,THB,TND,TRY,TTD,TWD,TZS,UAH,USD,UYU,UZS,VND,XAF,XCD,XOF,ZAR" } +google_pay = { country = "AD,AE,AG,AL,AM,AO,AR,AT,AU,AZ,BA,BB,BD,BE,BG,BH,BI,BJ,BN,BO,BR,BS,BT,BW,BY,BZ,CA,CD,CF,CG,CH,CI,CL,CM,CN,CO,CR,CV,CY,CZ,DE,DK,DJ,DM,DO,DZ,EC,EE,EG,ER,ES,ET,FI,FJ,FM,FR,GA,GB,GD,GE,GG,GH,GM,GN,GQ,GR,GT,GW,GY,HN,HR,HT,HU,ID,IE,IL,IN,IS,IT,JM,JP,JO,KE,KG,KH,KI,KM,KN,KR,KW,KZ,LA,LB,LC,LI,LK,LR,LS,LT,LU,LV,MA,MC,MD,ME,MG,MH,MK,ML,MM,MN,MR,MT,MU,MV,MW,MX,MY,MZ,NA,NE,NG,NI,NL,NO,NP,NR,NZ,OM,PA,PE,PG,PH,PK,PL,PS,PT,PW,PY,QA,RO,RS,RW,SA,SB,SC,SE,SG,SI,SK,SL,SM,SN,SO,SR,SS,ST,SV,SZ,TD,TG,TH,TJ,TL,TM,TN,TO,TR,TT,TV,TZ,UA,UG,US,UY,UZ,VA,VC,VE,VN,VU,WS,ZA,ZM,ZW", currency = "AED,AFN,ALL,AMD,ANG,ARS,AUD,AWG,BAM,BBD,BGN,BHD,BMD,BND,BOB,BRL,BSD,BWP,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,FJD,GBP,GEL,GIP,GTQ,HKD,HUF,IDR,ILS,INR,ISK,JMD,JPY,KES,KHR,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MUR,MWK,MXN,MYR,NAD,NGN,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PLN,PKR,QAR,RON,RSD,RUB,SAR,SCR,SDG,SEK,SGD,THB,TND,TRY,TTD,TWD,TZS,UAH,USD,UYU,UZS,VND,XAF,XCD,XOF,ZAR" } +apple_pay = { country = "AD,AE,AG,AL,AM,AO,AR,AT,AU,AZ,BA,BB,BD,BE,BG,BH,BI,BJ,BN,BO,BR,BS,BT,BW,BY,BZ,CA,CD,CF,CG,CH,CI,CL,CM,CN,CO,CR,CV,CY,CZ,DE,DK,DJ,DM,DO,DZ,EC,EE,EG,ER,ES,ET,FI,FJ,FM,FR,GA,GB,GD,GE,GG,GH,GM,GN,GQ,GR,GT,GW,GY,HN,HR,HT,HU,ID,IE,IL,IN,IS,IT,JM,JP,JO,KE,KG,KH,KI,KM,KN,KR,KW,KZ,LA,LB,LC,LI,LK,LR,LS,LT,LU,LV,MA,MC,MD,ME,MG,MH,MK,ML,MM,MN,MR,MT,MU,MV,MW,MX,MY,MZ,NA,NE,NG,NI,NL,NO,NP,NR,NZ,OM,PA,PE,PG,PH,PK,PL,PS,PT,PW,PY,QA,RO,RS,RW,SA,SB,SC,SE,SG,SI,SK,SL,SM,SN,SO,SR,SS,ST,SV,SZ,TD,TG,TH,TJ,TL,TM,TN,TO,TR,TT,TV,TZ,UA,UG,US,UY,UZ,VA,VC,VE,VN,VU,WS,ZA,ZM,ZW", currency = "AED,AFN,ALL,AMD,ANG,ARS,AUD,AWG,BAM,BBD,BGN,BHD,BMD,BND,BOB,BRL,BSD,BWP,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,FJD,GBP,GEL,GIP,GTQ,HKD,HUF,IDR,ILS,INR,ISK,JMD,JPY,KES,KHR,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MUR,MWK,MXN,MYR,NAD,NGN,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PLN,PKR,QAR,RON,RSD,RUB,SAR,SCR,SDG,SEK,SGD,THB,TND,TRY,TTD,TWD,TZS,UAH,USD,UYU,UZS,VND,XAF,XCD,XOF,ZAR" } [pm_filters.inespay] -sepa = { country = "ES", currency = "EUR"} +sepa = { country = "ES", currency = "EUR" } [pm_filters.fiserv] -credit = {country = "AU,NZ,CN,HK,IN,LK,KR,MY,SG,GB,BE,FR,DE,IT,ME,NL,PL,ES,ZA,AR,BR,CO,MX,PA,UY,US,CA", currency = "AFN,ALL,DZD,AOA,ARS,AMD,AWG,AUD,AZN,BSD,BHD,BDT,BBD,BYN,BZD,BMD,BTN,BOB,VES,BAM,BWP,BRL,BND,BGN,BIF,KHR,CAD,CVE,KYD,XAF,CLP,CNY,COP,KMF,CDF,CRC,HRK,CUP,CZK,DKK,DJF,DOP,XCD,EGP,ERN,ETB,EUR,FKP,FJD,XPF,GMD,GEL,GHS,GIP,GTQ,GNF,GYD,HTG,HNL,HKD,HUF,ISK,INR,IDR,IRR,IQD,ILS,JMD,JPY,JOD,KZT,KES,KGS,KWD,LAK,LBP,LSL,LRD,LYD,MOP,MKD,MGA,MWK,MYR,MVR,MRU,MUR,MXN,MDL,MNT,MAD,MZN,MMK,NAD,NPR,ANG,NZD,NIO,NGN,VUV,KPW,NOK,OMR,PKR,PAB,PGK,PYG,PEN,PHP,PLN,GBP,QAR,RON,RUB,RWF,SHP,SVC,WST,STN,SAR,RSD,SCR,SLL,SGD,SBD,SOS,ZAR,KRW,SSP,LKR,SDG,SRD,SZL,SEK,CHF,SYP,TWD,TJS,TZS,THB,TOP,TTD,TND,TRY,TMT,UGX,UAH,AED,USD,UYU,UZS,VND,XOF,YER,ZMW,ZWL"} -debit = {country = "AU,NZ,CN,HK,IN,LK,KR,MY,SG,GB,BE,FR,DE,IT,ME,NL,PL,ES,ZA,AR,BR,CO,MX,PA,UY,US,CA", currency = "AFN,ALL,DZD,AOA,ARS,AMD,AWG,AUD,AZN,BSD,BHD,BDT,BBD,BYN,BZD,BMD,BTN,BOB,VES,BAM,BWP,BRL,BND,BGN,BIF,KHR,CAD,CVE,KYD,XAF,CLP,CNY,COP,KMF,CDF,CRC,HRK,CUP,CZK,DKK,DJF,DOP,XCD,EGP,ERN,ETB,EUR,FKP,FJD,XPF,GMD,GEL,GHS,GIP,GTQ,GNF,GYD,HTG,HNL,HKD,HUF,ISK,INR,IDR,IRR,IQD,ILS,JMD,JPY,JOD,KZT,KES,KGS,KWD,LAK,LBP,LSL,LRD,LYD,MOP,MKD,MGA,MWK,MYR,MVR,MRU,MUR,MXN,MDL,MNT,MAD,MZN,MMK,NAD,NPR,ANG,NZD,NIO,NGN,VUV,KPW,NOK,OMR,PKR,PAB,PGK,PYG,PEN,PHP,PLN,GBP,QAR,RON,RUB,RWF,SHP,SVC,WST,STN,SAR,RSD,SCR,SLL,SGD,SBD,SOS,ZAR,KRW,SSP,LKR,SDG,SRD,SZL,SEK,CHF,SYP,TWD,TJS,TZS,THB,TOP,TTD,TND,TRY,TMT,UGX,UAH,AED,USD,UYU,UZS,VND,XOF,YER,ZMW,ZWL"} +credit = { country = "AU,NZ,CN,HK,IN,LK,KR,MY,SG,GB,BE,FR,DE,IT,ME,NL,PL,ES,ZA,AR,BR,CO,MX,PA,UY,US,CA", currency = "AFN,ALL,DZD,AOA,ARS,AMD,AWG,AUD,AZN,BSD,BHD,BDT,BBD,BYN,BZD,BMD,BTN,BOB,VES,BAM,BWP,BRL,BND,BGN,BIF,KHR,CAD,CVE,KYD,XAF,CLP,CNY,COP,KMF,CDF,CRC,HRK,CUP,CZK,DKK,DJF,DOP,XCD,EGP,ERN,ETB,EUR,FKP,FJD,XPF,GMD,GEL,GHS,GIP,GTQ,GNF,GYD,HTG,HNL,HKD,HUF,ISK,INR,IDR,IRR,IQD,ILS,JMD,JPY,JOD,KZT,KES,KGS,KWD,LAK,LBP,LSL,LRD,LYD,MOP,MKD,MGA,MWK,MYR,MVR,MRU,MUR,MXN,MDL,MNT,MAD,MZN,MMK,NAD,NPR,ANG,NZD,NIO,NGN,VUV,KPW,NOK,OMR,PKR,PAB,PGK,PYG,PEN,PHP,PLN,GBP,QAR,RON,RUB,RWF,SHP,SVC,WST,STN,SAR,RSD,SCR,SLL,SGD,SBD,SOS,ZAR,KRW,SSP,LKR,SDG,SRD,SZL,SEK,CHF,SYP,TWD,TJS,TZS,THB,TOP,TTD,TND,TRY,TMT,UGX,UAH,AED,USD,UYU,UZS,VND,XOF,YER,ZMW,ZWL" } +debit = { country = "AU,NZ,CN,HK,IN,LK,KR,MY,SG,GB,BE,FR,DE,IT,ME,NL,PL,ES,ZA,AR,BR,CO,MX,PA,UY,US,CA", currency = "AFN,ALL,DZD,AOA,ARS,AMD,AWG,AUD,AZN,BSD,BHD,BDT,BBD,BYN,BZD,BMD,BTN,BOB,VES,BAM,BWP,BRL,BND,BGN,BIF,KHR,CAD,CVE,KYD,XAF,CLP,CNY,COP,KMF,CDF,CRC,HRK,CUP,CZK,DKK,DJF,DOP,XCD,EGP,ERN,ETB,EUR,FKP,FJD,XPF,GMD,GEL,GHS,GIP,GTQ,GNF,GYD,HTG,HNL,HKD,HUF,ISK,INR,IDR,IRR,IQD,ILS,JMD,JPY,JOD,KZT,KES,KGS,KWD,LAK,LBP,LSL,LRD,LYD,MOP,MKD,MGA,MWK,MYR,MVR,MRU,MUR,MXN,MDL,MNT,MAD,MZN,MMK,NAD,NPR,ANG,NZD,NIO,NGN,VUV,KPW,NOK,OMR,PKR,PAB,PGK,PYG,PEN,PHP,PLN,GBP,QAR,RON,RUB,RWF,SHP,SVC,WST,STN,SAR,RSD,SCR,SLL,SGD,SBD,SOS,ZAR,KRW,SSP,LKR,SDG,SRD,SZL,SEK,CHF,SYP,TWD,TJS,TZS,THB,TOP,TTD,TND,TRY,TMT,UGX,UAH,AED,USD,UYU,UZS,VND,XOF,YER,ZMW,ZWL" } [pm_filters.stax] credit = { country = "US", currency = "USD" } @@ -512,8 +514,8 @@ debit = { country = "US", currency = "USD" } ach = { country = "US", currency = "USD" } [pm_filters.braintree] -credit = { country = "AD,AT,AU,BE,BG,CA,CH,CY,CZ,DE,DK,EE,ES,FI,FR,GB,GG,GI,GR,HK,HR,HU,IE,IM,IT,JE,LI,LT,LU,LV,MT,MC,MY,NL,NO,NZ,PL,PT,RO,SE,SG,SI,SK,SM,US", currency = "AED,AMD,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BIF,BMD,BND,BOB,BRL,BSD,BWP,BYN,BZD,CAD,CHF,CLP,CNY,COP,CRC,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,ISK,JMD,JPY,KES,KGS,KHR,KMF,KRW,KYD,KZT,LAK,LBP,LKR,LRD,LSL,MAD,MDL,MKD,MNT,MOP,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SEK,SGD,SHP,SLL,SOS,SRD,STD,SVC,SYP,SZL,THB,TJS,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VES,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL"} -debit = { country = "AD,AT,AU,BE,BG,CA,CH,CY,CZ,DE,DK,EE,ES,FI,FR,GB,GG,GI,GR,HK,HR,HU,IE,IM,IT,JE,LI,LT,LU,LV,MT,MC,MY,NL,NO,NZ,PL,PT,RO,SE,SG,SI,SK,SM,US", currency = "AED,AMD,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BIF,BMD,BND,BOB,BRL,BSD,BWP,BYN,BZD,CAD,CHF,CLP,CNY,COP,CRC,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,ISK,JMD,JPY,KES,KGS,KHR,KMF,KRW,KYD,KZT,LAK,LBP,LKR,LRD,LSL,MAD,MDL,MKD,MNT,MOP,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SEK,SGD,SHP,SLL,SOS,SRD,STD,SVC,SYP,SZL,THB,TJS,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VES,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL"} +credit = { country = "AD,AT,AU,BE,BG,CA,CH,CY,CZ,DE,DK,EE,ES,FI,FR,GB,GG,GI,GR,HK,HR,HU,IE,IM,IT,JE,LI,LT,LU,LV,MT,MC,MY,NL,NO,NZ,PL,PT,RO,SE,SG,SI,SK,SM,US", currency = "AED,AMD,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BIF,BMD,BND,BOB,BRL,BSD,BWP,BYN,BZD,CAD,CHF,CLP,CNY,COP,CRC,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,ISK,JMD,JPY,KES,KGS,KHR,KMF,KRW,KYD,KZT,LAK,LBP,LKR,LRD,LSL,MAD,MDL,MKD,MNT,MOP,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SEK,SGD,SHP,SLL,SOS,SRD,STD,SVC,SYP,SZL,THB,TJS,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VES,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL" } +debit = { country = "AD,AT,AU,BE,BG,CA,CH,CY,CZ,DE,DK,EE,ES,FI,FR,GB,GG,GI,GR,HK,HR,HU,IE,IM,IT,JE,LI,LT,LU,LV,MT,MC,MY,NL,NO,NZ,PL,PT,RO,SE,SG,SI,SK,SM,US", currency = "AED,AMD,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BIF,BMD,BND,BOB,BRL,BSD,BWP,BYN,BZD,CAD,CHF,CLP,CNY,COP,CRC,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,ISK,JMD,JPY,KES,KGS,KHR,KMF,KRW,KYD,KZT,LAK,LBP,LKR,LRD,LSL,MAD,MDL,MKD,MNT,MOP,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SEK,SGD,SHP,SLL,SOS,SRD,STD,SVC,SYP,SZL,THB,TJS,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VES,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL" } [pm_filters.aci] credit = { country = "AD,AE,AT,BE,BG,CH,CN,CO,CR,CY,CZ,DE,DK,DO,EE,EG,ES,ET,FI,FR,GB,GH,GI,GR,GT,HN,HK,HR,HU,ID,IE,IS,IT,JP,KH,LA,LI,LT,LU,LY,MK,MM,MX,MY,MZ,NG,NZ,OM,PA,PE,PK,PL,PT,QA,RO,SA,SN,SE,SI,SK,SV,TH,UA,US,UY,VN,ZM", currency = "AED,ALL,ARS,BGN,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,EGP,EUR,GBP,GHS,HKD,HNL,HRK,HUF,IDR,ILS,ISK,JPY,KHR,KPW,LAK,LKR,MAD,MKD,MMK,MXN,MYR,MZN,NGN,NOK,NZD,OMR,PAB,PEN,PHP,PKR,PLN,QAR,RON,RSD,SAR,SEK,SGD,THB,TRY,TWD,UAH,USD,UYU,VND,ZAR,ZMW" } @@ -523,22 +525,22 @@ ali_pay = { country = "CN", currency = "CNY" } eps = { country = "AT", currency = "EUR" } ideal = { country = "NL", currency = "EUR" } giropay = { country = "DE", currency = "EUR" } -sofort = { country = "AT,BE,CH,DE,ES,GB,IT,NL,PL", currency = "CHF,EUR,GBP,HUF,PLN"} -interac = { country = "CA", currency = "CAD,USD"} +sofort = { country = "AT,BE,CH,DE,ES,GB,IT,NL,PL", currency = "CHF,EUR,GBP,HUF,PLN" } +interac = { country = "CA", currency = "CAD,USD" } przelewy24 = { country = "PL", currency = "CZK,EUR,GBP,PLN" } trustly = { country = "ES,GB,SE,NO,AT,NL,DE,DK,FI,EE,LT,LV", currency = "CZK,DKK,EUR,GBP,NOK,SEK" } klarna = { country = "AU,AT,BE,CA,CZ,DK,FI,FR,DE,GR,IE,IT,NL,NZ,NO,PL,PT,ES,SE,CH,GB,US", currency = "CHF,DKK,EUR,GBP,NOK,PLN,SEK,USD,AUD,NZD,CAD" } [pm_filters.authorizedotnet] -credit = {currency = "CAD,USD"} -debit = {currency = "CAD,USD"} -google_pay = {currency = "CHF,DKK,EUR,GBP,NOK,PLN,SEK,USD,AUD,NZD,CAD"} -apple_pay = {currency = "EUR,GBP,ISK,USD,AUD,CAD,BRL,CLP,COP,CRC,CZK,DKK,EGP,GEL,GHS,GTQ,HNL,HKD,HUF,ILS,INR,JPY,KZT,KRW,KWD,MAD,MXN,MYR,NOK,NZD,PEN,PLN,PYG,QAR,RON,SAR,SEK,SGD,THB,TWD,UAH,AED,VND,ZAR"} -paypal = {currency = "AUD,BRL,CAD,CHF,CNY,CZK,DKK,EUR,GBP,HKD,HUF,ILS,JPY,MXN,MYR,NOK,NZD,PHP,PLN,SEK,SGD,THB,TWD,USD"} +credit = { currency = "CAD,USD" } +debit = { currency = "CAD,USD" } +google_pay = { currency = "CHF,DKK,EUR,GBP,NOK,PLN,SEK,USD,AUD,NZD,CAD" } +apple_pay = { currency = "EUR,GBP,ISK,USD,AUD,CAD,BRL,CLP,COP,CRC,CZK,DKK,EGP,GEL,GHS,GTQ,HNL,HKD,HUF,ILS,INR,JPY,KZT,KRW,KWD,MAD,MXN,MYR,NOK,NZD,PEN,PLN,PYG,QAR,RON,SAR,SEK,SGD,THB,TWD,UAH,AED,VND,ZAR" } +paypal = { currency = "AUD,BRL,CAD,CHF,CNY,CZK,DKK,EUR,GBP,HKD,HUF,ILS,JPY,MXN,MYR,NOK,NZD,PHP,PLN,SEK,SGD,THB,TWD,USD" } [pm_filters.forte] -credit = { country = "US, CA", currency = "CAD,USD"} -debit = { country = "US, CA", currency = "CAD,USD"} +credit = { country = "US, CA", currency = "CAD,USD" } +debit = { country = "US, CA", currency = "CAD,USD" } [pm_filters.fiuu] duit_now = { country = "MY", currency = "MYR" } @@ -549,8 +551,8 @@ credit = { country = "CN,HK,ID,MY,PH,SG,TH,TW,VN", currency = "CNY,HKD,IDR,MYR,P debit = { country = "CN,HK,ID,MY,PH,SG,TH,TW,VN", currency = "CNY,HKD,IDR,MYR,PHP,SGD,THB,TWD,VND" } [pm_filters.placetopay] -credit = { country = "BE,CH,CO,CR,EC,HN,MX,PA,PR,UY", currency = "CLP,COP,USD"} -debit = { country = "BE,CH,CO,CR,EC,HN,MX,PA,PR,UY", currency = "CLP,COP,USD"} +credit = { country = "BE,CH,CO,CR,EC,HN,MX,PA,PR,UY", currency = "CLP,COP,USD" } +debit = { country = "BE,CH,CO,CR,EC,HN,MX,PA,PR,UY", currency = "CLP,COP,USD" } [pm_filters.coingate] crypto_currency = { country = "AL, AD, AT, BE, BA, BG, HR, CZ, DK, EE, FI, FR, DE, GR, HU, IS, IE, IT, LV, LT, LU, MT, MD, NL, NO, PL, PT, RO, RS, SK, SI, ES, SE, CH, UA, GB, AR, BR, CL, CO, CR, DO, SV, GD, MX, PE, LC, AU, NZ, CY, HK, IN, IL, JP, KR, QA, SA, SG, EG", currency = "EUR, USD, GBP" } @@ -704,4 +706,4 @@ redsys = { payment_method = "card" } [billing_connectors_payment_sync] billing_connectors_which_require_payment_sync = "stripebilling, recurly" [billing_connectors_invoice_sync] -billing_connectors_which_requires_invoice_sync_call = "recurly" \ No newline at end of file +billing_connectors_which_requires_invoice_sync_call = "recurly" diff --git a/scripts/add_connector.sh b/scripts/add_connector.sh index 534c1614a5e..648d2e68993 100755 --- a/scripts/add_connector.sh +++ b/scripts/add_connector.sh @@ -6,7 +6,7 @@ function find_prev_connector() { git checkout $self cp $self $self.tmp # Add new connector to existing list and sort it - connectors=(aci adyen adyenplatform airwallex amazonpay applepay archipel authorizedotnet bambora bamboraapac bankofamerica barclaycard billwerk bitpay bluesnap boku braintree cashtocode chargebee checkbook checkout coinbase cryptopay ctp_visa cybersource datatrans deutschebank digitalvirgo dlocal dummyconnector dwolla ebanx elavon facilitapay fiserv fiservemea fiuu forte getnet globalpay globepay gocardless gpayments helcim hipay hyperswitch_vault iatapay inespay itaubank jpmorgan juspaythreedsserver klarna mifinity mollie moneris multisafepay netcetera nexinets nexixpay nomupay noon nordea novalnet nuvei opayo opennode paybox payeezy payload payme payone paypal paystack payu placetopay plaid powertranz prophetpay rapyd razorpay recurly redsys santander shift4 square stax stripe stripebilling taxjar threedsecureio thunes tokenio trustpay tsys unified_authentication_service vgs volt wellsfargo wellsfargopayout wise worldline worldpay worldpayvantiv worldpayxml xendit zsl "$1") + connectors=(aci adyen adyenplatform airwallex amazonpay applepay archipel authorizedotnet bambora bamboraapac bankofamerica barclaycard billwerk bitpay bluesnap boku braintree cashtocode celero chargebee checkbook checkout coinbase cryptopay ctp_visa cybersource datatrans deutschebank digitalvirgo dlocal dummyconnector dwolla ebanx elavon facilitapay fiserv fiservemea fiuu forte getnet globalpay globepay gocardless gpayments helcim hipay hyperswitch_vault iatapay inespay itaubank jpmorgan juspaythreedsserver klarna mifinity mollie moneris multisafepay netcetera nexinets nexixpay nomupay noon nordea novalnet nuvei opayo opennode paybox payeezy payload payme payone paypal paystack payu placetopay plaid powertranz prophetpay rapyd razorpay recurly redsys santander shift4 square stax stripe stripebilling taxjar threedsecureio thunes tokenio trustpay tsys unified_authentication_service vgs volt wellsfargo wellsfargopayout wise worldline worldpay worldpayvantiv worldpayxml xendit zsl "$1") IFS=$'\n' sorted=($(sort <<<"${connectors[]}")); unset IFS res="$(echo ${sorted[@]})" sed -i'' -e "s/^ connectors=./ connectors=($res \"\$1\")/" $self.tmp	2025-06-30T08:05:39Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [x] New feature - [ ] Enhancement - [x] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> Template new connection integration `celero` ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> No testing required as this is template ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [ ] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	9d7edb5cee030a13c8699a914a0d3600b058853d	9d7edb5cee030a13c8699a914a0d3600b058853d
juspay/hyperswitch	juspay__hyperswitch-8497	Bug: chore: address Rust 1.88.0 clippy lints Address the clippy lints occurring due to new rust version 1.88.0 See https://github.com/juspay/hyperswitch/issues/3391 for more information.	diff --git a/crates/router/src/core/payment_methods/vault.rs b/crates/router/src/core/payment_methods/vault.rs index c59a2f84c35..d5848c7f418 100644 --- a/crates/router/src/core/payment_methods/vault.rs +++ b/crates/router/src/core/payment_methods/vault.rs @@ -1555,10 +1555,7 @@ pub async fn insert_cvc_using_payment_token( .change_context(errors::ApiErrorResponse::InternalServerError) .attach_printable("Failed to get redis connection")?; - let key = format!( - "pm_token_{}_{}_hyperswitch_cvc", - payment_token, payment_method - ); + let key = format!("pm_token_{payment_token}_{payment_method}_hyperswitch_cvc"); let payload_to_be_encrypted = TemporaryVaultCvc { card_cvc }; @@ -1601,10 +1598,7 @@ pub async fn retrieve_and_delete_cvc_from_payment_token( .change_context(errors::ApiErrorResponse::InternalServerError) .attach_printable("Failed to get redis connection")?; - let key = format!( - "pm_token_{}_{}_hyperswitch_cvc", - payment_token, payment_method - ); + let key = format!("pm_token_{payment_token}_{payment_method}_hyperswitch_cvc"); let data = redis_conn .get_key::<bytes::Bytes>(&key.clone().into()) diff --git a/crates/router/src/core/unified_connector_service.rs b/crates/router/src/core/unified_connector_service.rs index d9c00fbadba..3cdcb28d4d8 100644 --- a/crates/router/src/core/unified_connector_service.rs +++ b/crates/router/src/core/unified_connector_service.rs @@ -101,8 +101,7 @@ pub fn build_unified_connector_service_payment_method( } _ => { return Err(UnifiedConnectorServiceError::NotImplemented(format!( - "Unimplemented card payment method type: {:?}", - payment_method_type + "Unimplemented card payment method type: {payment_method_type:?}" )) .into()); }	2025-07-10T13:43:08Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [ ] New feature - [ ] Enhancement - [x] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> This pull request includes a minor improvement to error message formatting in the `build_unified_connector_service_payment_method` function. * [`crates/router/src/core/unified_connector_service.rs`](diffhunk://#diff-b8e808846f58e455687a9e192c1c8d192598081aac942628640c42c1d397dfaeL104-R104): Updated the error message to use inline formatting for `payment_method_type`, improving readability and consistency. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	1b08de652f6b0f3c08374d0806c8999f4b73ec2f	1b08de652f6b0f3c08374d0806c8999f4b73ec2f
juspay/hyperswitch	juspay__hyperswitch-8467	Bug: [FEATURE] multisafepay : addpayment methods \| TRUSTLY \| WeChatpay \| Alipay ### Feature Description Integrate 1. Turstly 2. WeChatPay 3. Alipay ### Possible Implementation Integrate the redirection flows for the wallet ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? Yes, I am willing to submit a PR!	diff --git a/config/deployments/integration_test.toml b/config/deployments/integration_test.toml index 513cb587176..e04583cbfb5 100644 --- a/config/deployments/integration_test.toml +++ b/config/deployments/integration_test.toml @@ -541,6 +541,9 @@ paypal = { country = "AF,AX,AL,DZ,AS,AD,AO,AI,AQ,AG,AR,AM,AW,AU,AT,AZ,BS,BH,BD,B giropay = { country = "DE", currency = "EUR" } ideal = { country = "NL", currency = "EUR" } klarna = { country = "AT,BE,DK,FI,FR,DE,IT,NL,NO,PT,ES,SE,GB", currency = "DKK,EUR,GBP,NOK,SEK" } +trustly = { country = "AT,CZ,DK,EE,FI,DE,LV,LT,NL,NO,PL,PT,ES,SE,GB" , currency = "EUR,GBP,SEK"} +ali_pay = {currency = "EUR,USD"} +we_chat_pay = { currency = "EUR"} [pm_filters.cashtocode] classic = { country = "AF,AX,AL,DZ,AS,AD,AO,AI,AQ,AG,AR,AM,AW,AU,AT,AZ,BS,BH,BD,BB,BY,BE,BZ,BJ,BM,BT,BO,BQ,BA,BW,BV,BR,IO,BN,BG,BF,BI,KH,CM,CA,CV,KY,CF,TD,CL,CN,CX,CC,CO,KM,CG,CD,CK,CR,CI,HR,CU,CW,CY,CZ,DK,DJ,DM,DO,EC,EG,SV,GQ,ER,EE,ET,FK,FO,FJ,FI,FR,GF,PF,TF,GA,GM,GE,DE,GH,GI,GR,GL,GD,GP,GU,GT,GG,GN,GW,GY,HT,HM,VA,HN,HK,HU,IS,IN,ID,IR,IQ,IE,IM,IL,IT,JM,JP,JE,JO,KZ,KE,KI,KP,KR,KW,KG,LA,LV,LB,LS,LR,LY,LI,LT,LU,MO,MK,MG,MW,MY,MV,ML,MT,MH,MQ,MR,MU,YT,MX,FM,MD,MC,MN,ME,MS,MA,MZ,MM,NA,NR,NP,NL,NC,NZ,NI,NE,NG,NU,NF,MP,NO,OM,PK,PW,PS,PA,PG,PY,PE,PH,PN,PL,PT,PR,QA,RE,RO,RU,RW,BL,SH,KN,LC,MF,PM,VC,WS,SM,ST,SA,SN,RS,SC,SL,SG,SX,SK,SI,SB,SO,ZA,GS,SS,ES,LK,SD,SR,SJ,SZ,SE,CH,SY,TW,TJ,TZ,TH,TL,TG,TK,TO,TT,TN,TR,TM,TC,TV,UG,UA,AE,GB,UM,UY,UZ,VU,VE,VN,VG,VI,WF,EH,YE,ZM,ZW,US", currency = "AED,AFN,ALL,AMD,ANG,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BHD,BIF,BMD,BND,BOB,BRL,BSD,BTN,BWP,BYN,BZD,CAD,CDF,CHF,CLF,CLP,CNY,COP,CRC,CUC,CUP,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ERN,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,IQD,IRR,ISK,JMD,JOD,JPY,KES,KGS,KHR,KMF,KPW,KRW,KWD,KYD,KZT,LAK,LBP,LKR,LRD,LSL,LYD,MAD,MDL,MGA,MKD,MMK,MNT,MOP,MRU,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SDG,SEK,SGD,SHP,SLE,SLL,SOS,SRD,SSP,STD,STN,SVC,SYP,SZL,THB,TJS,TMT,TND,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VES,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL" } diff --git a/config/deployments/production.toml b/config/deployments/production.toml index 4b990ad0464..eba6e2334b7 100644 --- a/config/deployments/production.toml +++ b/config/deployments/production.toml @@ -524,6 +524,9 @@ paypal = { country = "AF,AX,AL,DZ,AS,AD,AO,AI,AQ,AG,AR,AM,AW,AU,AT,AZ,BS,BH,BD,B giropay = { country = "DE", currency = "EUR" } ideal = { country = "NL", currency = "EUR" } klarna = { country = "AT,BE,DK,FI,FR,DE,IT,NL,NO,PT,ES,SE,GB", currency = "DKK,EUR,GBP,NOK,SEK" } +trustly = { country = "AT,CZ,DK,EE,FI,DE,LV,LT,NL,NO,PL,PT,ES,SE,GB" , currency = "EUR,GBP,SEK"} +ali_pay = {currency = "EUR,USD"} +we_chat_pay = { currency = "EUR"} [pm_filters.cashtocode] classic = { country = "AF,AX,AL,DZ,AS,AD,AO,AI,AQ,AG,AR,AM,AW,AU,AT,AZ,BS,BH,BD,BB,BY,BE,BZ,BJ,BM,BT,BO,BQ,BA,BW,BV,BR,IO,BN,BG,BF,BI,KH,CM,CA,CV,KY,CF,TD,CL,CN,CX,CC,CO,KM,CG,CD,CK,CR,CI,HR,CU,CW,CY,CZ,DK,DJ,DM,DO,EC,EG,SV,GQ,ER,EE,ET,FK,FO,FJ,FI,FR,GF,PF,TF,GA,GM,GE,DE,GH,GI,GR,GL,GD,GP,GU,GT,GG,GN,GW,GY,HT,HM,VA,HN,HK,HU,IS,IN,ID,IR,IQ,IE,IM,IL,IT,JM,JP,JE,JO,KZ,KE,KI,KP,KR,KW,KG,LA,LV,LB,LS,LR,LY,LI,LT,LU,MO,MK,MG,MW,MY,MV,ML,MT,MH,MQ,MR,MU,YT,MX,FM,MD,MC,MN,ME,MS,MA,MZ,MM,NA,NR,NP,NL,NC,NZ,NI,NE,NG,NU,NF,MP,NO,OM,PK,PW,PS,PA,PG,PY,PE,PH,PN,PL,PT,PR,QA,RE,RO,RU,RW,BL,SH,KN,LC,MF,PM,VC,WS,SM,ST,SA,SN,RS,SC,SL,SG,SX,SK,SI,SB,SO,ZA,GS,SS,ES,LK,SD,SR,SJ,SZ,SE,CH,SY,TW,TJ,TZ,TH,TL,TG,TK,TO,TT,TN,TR,TM,TC,TV,UG,UA,AE,GB,UM,UY,UZ,VU,VE,VN,VG,VI,WF,EH,YE,ZM,ZW,US", currency = "AED,AFN,ALL,AMD,ANG,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BHD,BIF,BMD,BND,BOB,BRL,BSD,BTN,BWP,BYN,BZD,CAD,CDF,CHF,CLF,CLP,CNY,COP,CRC,CUC,CUP,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ERN,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,IQD,IRR,ISK,JMD,JOD,JPY,KES,KGS,KHR,KMF,KPW,KRW,KWD,KYD,KZT,LAK,LBP,LKR,LRD,LSL,LYD,MAD,MDL,MGA,MKD,MMK,MNT,MOP,MRU,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SDG,SEK,SGD,SHP,SLE,SLL,SOS,SRD,SSP,STD,STN,SVC,SYP,SZL,THB,TJS,TMT,TND,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VES,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL" } diff --git a/config/deployments/sandbox.toml b/config/deployments/sandbox.toml index d00b12c751f..ac5442fcdd6 100644 --- a/config/deployments/sandbox.toml +++ b/config/deployments/sandbox.toml @@ -532,6 +532,9 @@ google_pay = { country = "AF,AX,AL,DZ,AS,AD,AO,AI,AQ,AG,AR,AM,AW,AU,AT,AZ,BS,BH, paypal = { country = "AF,AX,AL,DZ,AS,AD,AO,AI,AQ,AG,AR,AM,AW,AU,AT,AZ,BS,BH,BD,BB,BY,BE,BZ,BJ,BM,BT,BO,BQ,BA,BW,BV,BR,IO,BN,BG,BF,BI,CV,KH,CM,CA,KY,CF,TD,CL,CN,CX,CC,CO,KM,CG,CD,CK,CR,CI,HR,CU,CW,CY,CZ,DK,DJ,DM,DO,EC,EG,SV,GQ,ER,EE,ET,FK,FO,FJ,FI,FR,GF,PF,TF,GA,GM,GE,DE,GH,GI,GR,GL,GD,GP,GU,GT,GG,GN,GW,GY,HT,HM,VA,HN,HK,HU,IS,IN,ID,IR,IQ,IE,IM,IL,IT,JM,JP,JE,JO,KZ,KE,KI,KP,KR,KW,KG,LA,LV,LB,LS,LR,LY,LI,LT,LU,MO,MK,MG,MW,MY,MV,ML,MT,MH,MQ,MR,MU,YT,MX,FM,MD,MC,MN,ME,MS,MA,MZ,MM,NA,NR,NP,NL,NC,NZ,NI,NE,NG,NU,NF,MP,NO,OM,PK,PW,PS,PA,PG,PY,PE,PH,PN,PL,PT,PR,QA,RE,RO,RU,RW,BL,SH,KN,LC,MF,PM,VC,WS,SM,ST,SA,SN,RS,SC,SL,SG,SX,SK,SI,SB,SO,ZA,GS,SS,ES,LK,SD,SR,SJ,SZ,SE,CH,SY,TW,TJ,TZ,TH,TL,TG,TK,TO,TT,TN,TR,TM,TC,TV,UG,UA,AE,GB,US,UM,UY,UZ,VU,VE,VN,VG,VI,WF,EH,YE,ZM,ZW", currency = "AUD,BRL,CAD,CHF,CZK,DKK,EUR,GBP,HKD,HRK,HUF,JPY,MXN,MYR,NOK,NZD,PHP,PLN,RUB,SEK,SGD,THB,TRY,TWD,USD" } ideal = { country = "NL", currency = "EUR" } klarna = { country = "AT,BE,DK,FI,FR,DE,IT,NL,NO,PT,ES,SE,GB", currency = "DKK,EUR,GBP,NOK,SEK" } +trustly = { country = "AT,CZ,DK,EE,FI,DE,LV,LT,NL,NO,PL,PT,ES,SE,GB" , currency = "EUR,GBP,SEK"} +ali_pay = {currency = "EUR,USD"} +we_chat_pay = { currency = "EUR"} [pm_filters.cashtocode] classic = { country = "AF,AX,AL,DZ,AS,AD,AO,AI,AQ,AG,AR,AM,AW,AU,AT,AZ,BS,BH,BD,BB,BY,BE,BZ,BJ,BM,BT,BO,BQ,BA,BW,BV,BR,IO,BN,BG,BF,BI,KH,CM,CA,CV,KY,CF,TD,CL,CN,CX,CC,CO,KM,CG,CD,CK,CR,CI,HR,CU,CW,CY,CZ,DK,DJ,DM,DO,EC,EG,SV,GQ,ER,EE,ET,FK,FO,FJ,FI,FR,GF,PF,TF,GA,GM,GE,DE,GH,GI,GR,GL,GD,GP,GU,GT,GG,GN,GW,GY,HT,HM,VA,HN,HK,HU,IS,IN,ID,IR,IQ,IE,IM,IL,IT,JM,JP,JE,JO,KZ,KE,KI,KP,KR,KW,KG,LA,LV,LB,LS,LR,LY,LI,LT,LU,MO,MK,MG,MW,MY,MV,ML,MT,MH,MQ,MR,MU,YT,MX,FM,MD,MC,MN,ME,MS,MA,MZ,MM,NA,NR,NP,NL,NC,NZ,NI,NE,NG,NU,NF,MP,NO,OM,PK,PW,PS,PA,PG,PY,PE,PH,PN,PL,PT,PR,QA,RE,RO,RU,RW,BL,SH,KN,LC,MF,PM,VC,WS,SM,ST,SA,SN,RS,SC,SL,SG,SX,SK,SI,SB,SO,ZA,GS,SS,ES,LK,SD,SR,SJ,SZ,SE,CH,SY,TW,TJ,TZ,TH,TL,TG,TK,TO,TT,TN,TR,TM,TC,TV,UG,UA,AE,GB,UM,UY,UZ,VU,VE,VN,VG,VI,WF,EH,YE,ZM,ZW,US", currency = "AED,AFN,ALL,AMD,ANG,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BHD,BIF,BMD,BND,BOB,BRL,BSD,BTN,BWP,BYN,BZD,CAD,CDF,CHF,CLF,CLP,CNY,COP,CRC,CUC,CUP,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ERN,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,IQD,IRR,ISK,JMD,JOD,JPY,KES,KGS,KHR,KMF,KPW,KRW,KWD,KYD,KZT,LAK,LBP,LKR,LRD,LSL,LYD,MAD,MDL,MGA,MKD,MMK,MNT,MOP,MRU,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SDG,SEK,SGD,SHP,SLE,SLL,SOS,SRD,SSP,STD,STN,SVC,SYP,SZL,THB,TJS,TMT,TND,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VES,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL" } diff --git a/config/development.toml b/config/development.toml index 95484d6b014..d85f36cef18 100644 --- a/config/development.toml +++ b/config/development.toml @@ -728,6 +728,9 @@ paypal = { country = "AF,AX,AL,DZ,AS,AD,AO,AI,AQ,AG,AR,AM,AW,AU,AT,AZ,BS,BH,BD,B giropay = { country = "DE", currency = "EUR" } ideal = { country = "NL", currency = "EUR" } klarna = { country = "AT,BE,DK,FI,FR,DE,IT,NL,NO,PT,ES,SE,GB", currency = "DKK,EUR,GBP,NOK,SEK" } +trustly = { country = "AT,CZ,DK,EE,FI,DE,LV,LT,NL,NO,PL,PT,ES,SE,GB" , currency = "EUR,GBP,SEK"} +ali_pay = { currency = "EUR,USD" } +we_chat_pay = { currency = "EUR"} [pm_filters.cashtocode] classic = { country = "AF,AX,AL,DZ,AS,AD,AO,AI,AQ,AG,AR,AM,AW,AU,AT,AZ,BS,BH,BD,BB,BY,BE,BZ,BJ,BM,BT,BO,BQ,BA,BW,BV,BR,IO,BN,BG,BF,BI,KH,CM,CA,CV,KY,CF,TD,CL,CN,CX,CC,CO,KM,CG,CD,CK,CR,CI,HR,CU,CW,CY,CZ,DK,DJ,DM,DO,EC,EG,SV,GQ,ER,EE,ET,FK,FO,FJ,FI,FR,GF,PF,TF,GA,GM,GE,DE,GH,GI,GR,GL,GD,GP,GU,GT,GG,GN,GW,GY,HT,HM,VA,HN,HK,HU,IS,IN,ID,IR,IQ,IE,IM,IL,IT,JM,JP,JE,JO,KZ,KE,KI,KP,KR,KW,KG,LA,LV,LB,LS,LR,LY,LI,LT,LU,MO,MK,MG,MW,MY,MV,ML,MT,MH,MQ,MR,MU,YT,MX,FM,MD,MC,MN,ME,MS,MA,MZ,MM,NA,NR,NP,NL,NC,NZ,NI,NE,NG,NU,NF,MP,NO,OM,PK,PW,PS,PA,PG,PY,PE,PH,PN,PL,PT,PR,QA,RE,RO,RU,RW,BL,SH,KN,LC,MF,PM,VC,WS,SM,ST,SA,SN,RS,SC,SL,SG,SX,SK,SI,SB,SO,ZA,GS,SS,ES,LK,SD,SR,SJ,SZ,SE,CH,SY,TW,TJ,TZ,TH,TL,TG,TK,TO,TT,TN,TR,TM,TC,TV,UG,UA,AE,GB,UM,UY,UZ,VU,VE,VN,VG,VI,WF,EH,YE,ZM,ZW,US", currency = "AED,AFN,ALL,AMD,ANG,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BHD,BIF,BMD,BND,BOB,BRL,BSD,BTN,BWP,BYN,BZD,CAD,CDF,CHF,CLF,CLP,CNY,COP,CRC,CUC,CUP,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ERN,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,IQD,IRR,ISK,JMD,JOD,JPY,KES,KGS,KHR,KMF,KPW,KRW,KWD,KYD,KZT,LAK,LBP,LKR,LRD,LSL,LYD,MAD,MDL,MGA,MKD,MMK,MNT,MOP,MRU,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SDG,SEK,SGD,SHP,SLE,SLL,SOS,SRD,SSP,STD,STN,SVC,SYP,SZL,THB,TJS,TMT,TND,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VES,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL" } diff --git a/crates/hyperswitch_connectors/src/connectors/multisafepay.rs b/crates/hyperswitch_connectors/src/connectors/multisafepay.rs index f2fc62d6cbf..08e76940237 100644 --- a/crates/hyperswitch_connectors/src/connectors/multisafepay.rs +++ b/crates/hyperswitch_connectors/src/connectors/multisafepay.rs @@ -634,6 +634,27 @@ static MULTISAFEPAY_SUPPORTED_PAYMENT_METHODS: LazyLock<SupportedPaymentMethods> }, ); + multisafepay_supported_payment_methods.add( + enums::PaymentMethod::Wallet, + enums::PaymentMethodType::AliPay, + PaymentMethodDetails { + mandates: enums::FeatureStatus::NotSupported, + refunds: enums::FeatureStatus::Supported, + supported_capture_methods: supported_capture_methods.clone(), + specific_features: None, + }, + ); + multisafepay_supported_payment_methods.add( + enums::PaymentMethod::Wallet, + enums::PaymentMethodType::WeChatPay, + PaymentMethodDetails { + mandates: enums::FeatureStatus::NotSupported, + refunds: enums::FeatureStatus::Supported, + supported_capture_methods: supported_capture_methods.clone(), + specific_features: None, + }, + ); + multisafepay_supported_payment_methods.add( enums::PaymentMethod::BankRedirect, enums::PaymentMethodType::Giropay, @@ -644,6 +665,16 @@ static MULTISAFEPAY_SUPPORTED_PAYMENT_METHODS: LazyLock<SupportedPaymentMethods> specific_features: None, }, ); + multisafepay_supported_payment_methods.add( + enums::PaymentMethod::BankRedirect, + enums::PaymentMethodType::Trustly, + PaymentMethodDetails { + mandates: enums::FeatureStatus::NotSupported, + refunds: enums::FeatureStatus::Supported, + supported_capture_methods: supported_capture_methods.clone(), + specific_features: None, + }, + ); multisafepay_supported_payment_methods.add( enums::PaymentMethod::BankRedirect, diff --git a/crates/hyperswitch_connectors/src/connectors/multisafepay/transformers.rs b/crates/hyperswitch_connectors/src/connectors/multisafepay/transformers.rs index c7cc7967c4c..bcdbd7e28e6 100644 --- a/crates/hyperswitch_connectors/src/connectors/multisafepay/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/multisafepay/transformers.rs @@ -66,6 +66,10 @@ pub enum Gateway { Paypal, Ideal, Giropay, + Trustly, + Alipay, + #[serde(rename = "WECHAT")] + WeChatPay, } #[serde_with::skip_serializing_none] @@ -183,14 +187,24 @@ pub enum GatewayInfo { #[serde(untagged)] pub enum WalletInfo { GooglePay(GpayInfo), + Alipay(AlipayInfo), + WeChatPay(WeChatPayInfo), } +#[derive(Debug, Clone, Serialize, Eq, PartialEq)] +pub struct WeChatPayInfo {} + +#[derive(Debug, Clone, Serialize, Eq, PartialEq)] +pub struct AlipayInfo {} + #[derive(Clone, Debug, Eq, PartialEq, Serialize)] #[serde(untagged)] pub enum BankRedirectInfo { Ideal(IdealInfo), + Trustly(TrustlyInfo), } - +#[derive(Debug, Clone, Serialize, Eq, PartialEq)] +pub struct TrustlyInfo {} #[derive(Debug, Clone, Serialize, Eq, PartialEq)] pub struct IdealInfo { pub issuer_id: MultisafepayBankNames, @@ -490,8 +504,9 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> PaymentMethodData::Wallet(ref wallet_data) => match wallet_data { WalletData::GooglePay(_) => Type::Direct, WalletData::PaypalRedirect(_) => Type::Redirect, + WalletData::AliPayRedirect(_) => Type::Redirect, + WalletData::WeChatPayRedirect(_) => Type::Redirect, WalletData::AliPayQr(_) - \| WalletData::AliPayRedirect(_) \| WalletData::AliPayHkRedirect(_) \| WalletData::AmazonPayRedirect(_) \| WalletData::MomoRedirect(_) @@ -512,7 +527,6 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> \| WalletData::TwintRedirect {} \| WalletData::VippsRedirect {} \| WalletData::TouchNGoRedirect(_) - \| WalletData::WeChatPayRedirect(_) \| WalletData::WeChatPayQr(_) \| WalletData::CashappQr(_) \| WalletData::SwishQr(_) @@ -524,6 +538,7 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> PaymentMethodData::BankRedirect(ref bank_data) => match bank_data { BankRedirectData::Giropay { .. } => Type::Redirect, BankRedirectData::Ideal { .. } => Type::Direct, + BankRedirectData::Trustly { .. } => Type::Redirect, BankRedirectData::BancontactCard { .. } \| BankRedirectData::Bizum { .. } \| BankRedirectData::Blik { .. } @@ -537,7 +552,6 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> \| BankRedirectData::OpenBankingUk { .. } \| BankRedirectData::Przelewy24 { .. } \| BankRedirectData::Sofort { .. } - \| BankRedirectData::Trustly { .. } \| BankRedirectData::OnlineBankingFpx { .. } \| BankRedirectData::OnlineBankingThailand { .. } \| BankRedirectData::LocalBankRedirect {} => { @@ -557,8 +571,9 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> PaymentMethodData::Wallet(ref wallet_data) => Some(match wallet_data { WalletData::GooglePay(_) => Gateway::Googlepay, WalletData::PaypalRedirect(_) => Gateway::Paypal, + WalletData::AliPayRedirect(_) => Gateway::Alipay, + WalletData::WeChatPayRedirect(_) => Gateway::WeChatPay, WalletData::AliPayQr(_) - \| WalletData::AliPayRedirect(_) \| WalletData::AliPayHkRedirect(_) \| WalletData::AmazonPayRedirect(_) \| WalletData::MomoRedirect(_) @@ -579,7 +594,6 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> \| WalletData::TwintRedirect {} \| WalletData::VippsRedirect {} \| WalletData::TouchNGoRedirect(_) - \| WalletData::WeChatPayRedirect(_) \| WalletData::WeChatPayQr(_) \| WalletData::CashappQr(_) \| WalletData::SwishQr(_) @@ -591,6 +605,7 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> PaymentMethodData::BankRedirect(ref bank_data) => Some(match bank_data { BankRedirectData::Giropay { .. } => Gateway::Giropay, BankRedirectData::Ideal { .. } => Gateway::Ideal, + BankRedirectData::Trustly { .. } => Gateway::Trustly, BankRedirectData::BancontactCard { .. } \| BankRedirectData::Bizum { .. } \| BankRedirectData::Blik { .. } @@ -604,7 +619,6 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> \| BankRedirectData::OpenBankingUk { .. } \| BankRedirectData::Przelewy24 { .. } \| BankRedirectData::Sofort { .. } - \| BankRedirectData::Trustly { .. } \| BankRedirectData::OnlineBankingFpx { .. } \| BankRedirectData::OnlineBankingThailand { .. } \| BankRedirectData::LocalBankRedirect {} => { @@ -718,9 +732,14 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> } }))) } + WalletData::AliPayRedirect(_) => { + Some(GatewayInfo::Wallet(WalletInfo::Alipay(AlipayInfo {}))) + } WalletData::PaypalRedirect(_) => None, + WalletData::WeChatPayRedirect(_) => { + Some(GatewayInfo::Wallet(WalletInfo::WeChatPay(WeChatPayInfo {}))) + } WalletData::AliPayQr(_) - \| WalletData::AliPayRedirect(_) \| WalletData::AliPayHkRedirect(_) \| WalletData::AmazonPayRedirect(_) \| WalletData::MomoRedirect(_) @@ -741,7 +760,6 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> \| WalletData::TwintRedirect {} \| WalletData::VippsRedirect {} \| WalletData::TouchNGoRedirect(_) - \| WalletData::WeChatPayRedirect(_) \| WalletData::WeChatPayQr(_) \| WalletData::CashappQr(_) \| WalletData::SwishQr(_) @@ -780,6 +798,9 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> )?)?, }), )), + BankRedirectData::Trustly { .. } => Some(GatewayInfo::BankRedirect( + BankRedirectInfo::Trustly(TrustlyInfo {}), + )), BankRedirectData::BancontactCard { .. } \| BankRedirectData::Bizum { .. } \| BankRedirectData::Blik { .. } @@ -794,7 +815,6 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> \| BankRedirectData::OpenBankingUk { .. } \| BankRedirectData::Przelewy24 { .. } \| BankRedirectData::Sofort { .. } - \| BankRedirectData::Trustly { .. } \| BankRedirectData::OnlineBankingFpx { .. } \| BankRedirectData::OnlineBankingThailand { .. } \| BankRedirectData::LocalBankRedirect {} => None,	2025-06-26T04:34:28Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description Add newer payment methods for `multisafepay` connector - Trustly - WeChatPay - Alipay ### MCA <details> <summary>Create Merchant Account</summary> ```json { "connector_type": "payment_processor", "connector_account_details": { "auth_type": "HeaderKey", "api_key": "**************" }, "connector_name": "multisafepay", "test_mode": false, "disabled": false, "payment_methods_enabled": [ { "payment_method": "wallet", "payment_method_types": [ { "payment_method_type": "we_chat_pay", "payment_experience": "redirect_to_url" } ] }, { "payment_method": "wallet", "payment_method_types": [ { "payment_method_type": "ali_pay", "payment_experience": "redirect_to_url" } ] }, { "payment_method": "wallet", "payment_method_types": [ { "payment_method_type": "amazon_pay", "payment_experience": "redirect_to_url" } ] }, { "payment_method": "bank_redirect", "payment_method_types": [ { "payment_method_type": "trustly" } ] }, { "payment_method": "card", "payment_method_types": [ { "payment_method_type": "credit", "card_networks": ["Visa", "Mastercard"], "minimum_amount": 1, "maximum_amount": 68607706, "recurring_enabled": true, "installment_payment_enabled": true }, { "payment_method_type": "debit", "card_networks": ["Visa", "Mastercard"], "minimum_amount": 1, "maximum_amount": 68607706, "recurring_enabled": true, "installment_payment_enabled": true } ] } ], "metadata": { "city": "NY", "unit": "245" }, "business_country": "US", "business_label": "default" } ``` </details> ## Trustly <details> <summary>Create payement</summary> ```json { "amount": 333, "currency": "EUR", "confirm": true, "capture_method": "automatic", "payment_method": "bank_redirect", "payment_method_type": "trustly", "description": "hellow world", "billing": { "address": { "zip": "560095", "first_name": "Sakil", "last_name": "Mostak", "line1": "Fasdf", "country": "AT", "line2": "Fasdf", "city": "Fasdf" } }, "payment_method_data": { "bank_redirect": { "trustly": { "country": "AT" } } } } ``` </details> <details> <summary> Response</summary> ```json { "payment_id": "pay_wRU9qZTZ8Q8VGd8Bry2i", "merchant_id": "merchant_1750676714", "status": "requires_customer_action", "amount": 333, "net_amount": 333, "shipping_cost": null, "amount_capturable": 333, "amount_received": null, "connector": "multisafepay", "client_secret": "pay_wRU9qZTZ8Q8VGd8Bry2i_secret_Cikbt0vSVNo1G9dXT8LR", "created": "2025-06-26T04:55:03.318Z", "currency": "EUR", "customer_id": null, "customer": null, "description": "hellow world", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "bank_redirect", "payment_method_data": { "bank_redirect": { "type": "BankRedirectResponse", "bank_name": null }, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": "Fasdf", "country": "AT", "line1": "Fasdf", "line2": "Fasdf", "line3": null, "zip": "560095", "state": null, "first_name": "Sakil", "last_name": "Mostak" }, "phone": null, "email": null }, "order_details": null, "email": null, "name": null, "phone": null, "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": { "type": "redirect_to_url", "redirect_to_url": "http://localhost:8080/payments/redirect/pay_wRU9qZTZ8Q8VGd8Bry2i/merchant_1750676714/pay_wRU9qZTZ8Q8VGd8Bry2i_1" }, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "trustly", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": null, "connector_transaction_id": "pay_wRU9qZTZ8Q8VGd8Bry2i_1", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_wRU9qZTZ8Q8VGd8Bry2i_1", "payment_link": null, "profile_id": "pro_7Pno0Wbshvrioh4kTJLM", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_aliGZhhX1SDuuEtkipSs", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-06-26T05:10:03.318Z", "fingerprint": null, "browser_info": null, "payment_method_id": null, "payment_method_status": null, "updated": "2025-06-26T04:55:05.045Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": null, "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` </details> <details> <summary>Confirm page</summary> <img width="1322" alt="Screenshot 2025-06-26 at 10 26 20 AM" src="https://github.com/user-attachments/assets/6a428b08-d3fb-4b6d-bf94-d6348025d208" /> </details> <details> <summary>Psync</summary> ```json { "payment_id": "pay_wRU9qZTZ8Q8VGd8Bry2i", "merchant_id": "merchant_1750676714", "status": "succeeded", "amount": 333, "net_amount": 333, "shipping_cost": null, "amount_capturable": 0, "amount_received": 333, "connector": "multisafepay", "client_secret": "pay_wRU9qZTZ8Q8VGd8Bry2i_secret_Cikbt0vSVNo1G9dXT8LR", "created": "2025-06-26T04:55:03.318Z", "currency": "EUR", "customer_id": null, "customer": null, "description": "hellow world", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "bank_redirect", "payment_method_data": { "bank_redirect": { "type": "BankRedirectResponse", "bank_name": null }, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": "Fasdf", "country": "AT", "line1": "Fasdf", "line2": "Fasdf", "line3": null, "zip": "560095", "state": null, "first_name": "Sakil", "last_name": "Mostak" }, "phone": null, "email": null }, "order_details": null, "email": null, "name": null, "phone": null, "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "trustly", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": false, "connector_transaction_id": "pay_wRU9qZTZ8Q8VGd8Bry2i_1", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_wRU9qZTZ8Q8VGd8Bry2i_1", "payment_link": null, "profile_id": "pro_7Pno0Wbshvrioh4kTJLM", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_aliGZhhX1SDuuEtkipSs", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-06-26T05:10:03.318Z", "fingerprint": null, "browser_info": null, "payment_method_id": null, "payment_method_status": null, "updated": "2025-06-26T04:56:22.878Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": null, "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` </details> ## Alipay <details> <summary> Payment create </summary> ```json { "amount": 333, "currency": "EUR", "confirm": true, "capture_method": "automatic", "payment_method": "wallet", "payment_method_type": "ali_pay", "authentication_type": "no_three_ds", "description": "hellow world", "billing": { "address": { "zip": "560095", "first_name": "Sakil", "last_name": "Mostak", "line1": "Fasdf", "country": "AT", "line2": "Fasdf", "city": "Fasdf" } }, "payment_method_data": { "wallet": { "ali_pay_redirect": {} } } } ``` </details> <details> <summary>Payment Response</summary> ```json { "payment_id": "pay_Ovu6Gi04d695EdCCEUlP", "merchant_id": "merchant_1750676714", "status": "requires_customer_action", "amount": 333, "net_amount": 333, "shipping_cost": null, "amount_capturable": 333, "amount_received": null, "connector": "multisafepay", "client_secret": "pay_Ovu6Gi04d695EdCCEUlP_secret_M57QtvAffR5Z5DEAkVko", "created": "2025-06-26T05:00:28.713Z", "currency": "EUR", "customer_id": null, "customer": null, "description": "hellow world", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "wallet", "payment_method_data": { "wallet": {}, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": "Fasdf", "country": "AT", "line1": "Fasdf", "line2": "Fasdf", "line3": null, "zip": "560095", "state": null, "first_name": "Sakil", "last_name": "Mostak" }, "phone": null, "email": null }, "order_details": null, "email": null, "name": null, "phone": null, "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": { "type": "redirect_to_url", "redirect_to_url": "http://localhost:8080/payments/redirect/pay_Ovu6Gi04d695EdCCEUlP/merchant_1750676714/pay_Ovu6Gi04d695EdCCEUlP_1" }, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "ali_pay", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": null, "connector_transaction_id": "pay_Ovu6Gi04d695EdCCEUlP_1", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_Ovu6Gi04d695EdCCEUlP_1", "payment_link": null, "profile_id": "pro_7Pno0Wbshvrioh4kTJLM", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_aliGZhhX1SDuuEtkipSs", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-06-26T05:15:28.713Z", "fingerprint": null, "browser_info": null, "payment_method_id": null, "payment_method_status": null, "updated": "2025-06-26T05:00:30.315Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": null, "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` </details> <details> <summary> Confirm page </summary> <img width="1188" alt="Screenshot 2025-06-26 at 10 44 33 AM" src="https://github.com/user-attachments/assets/86978961-b4c1-42e0-8ae0-a28f72ea44a4" /> </details> <details> <summary>Psync</summary> ```json { "payment_id": "pay_Ovu6Gi04d695EdCCEUlP", "merchant_id": "merchant_1750676714", "status": "succeeded", "amount": 333, "net_amount": 333, "shipping_cost": null, "amount_capturable": 0, "amount_received": 333, "connector": "multisafepay", "client_secret": "pay_Ovu6Gi04d695EdCCEUlP_secret_M57QtvAffR5Z5DEAkVko", "created": "2025-06-26T05:00:28.713Z", "currency": "EUR", "customer_id": null, "customer": null, "description": "hellow world", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "wallet", "payment_method_data": { "wallet": {}, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": "Fasdf", "country": "AT", "line1": "Fasdf", "line2": "Fasdf", "line3": null, "zip": "560095", "state": null, "first_name": "Sakil", "last_name": "Mostak" }, "phone": null, "email": null }, "order_details": null, "email": null, "name": null, "phone": null, "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "ali_pay", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": false, "connector_transaction_id": "pay_Ovu6Gi04d695EdCCEUlP_1", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_Ovu6Gi04d695EdCCEUlP_1", "payment_link": null, "profile_id": "pro_7Pno0Wbshvrioh4kTJLM", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_aliGZhhX1SDuuEtkipSs", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-06-26T05:15:28.713Z", "fingerprint": null, "browser_info": null, "payment_method_id": null, "payment_method_status": null, "updated": "2025-06-26T05:14:27.864Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": null, "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` </details> ## WeChat pay <details> <summary>Create payment </summary> ```json { "amount": 333, "currency": "EUR", "confirm": true, "capture_method": "automatic", "payment_method": "wallet", "payment_method_type": "we_chat_pay", "authentication_type": "no_three_ds", "description": "hellow world", "billing": { "address": { "zip": "560095", "first_name": "Sakil", "last_name": "Mostak", "line1": "Fasdf", "country": "CN", "line2": "Fasdf", "city": "Fasdf" } }, "payment_method_data": { "wallet": { "we_chat_pay_redirect": {} } } } ``` </details> <details> <summary>create payment response</summary> ```json { "payment_id": "pay_ly7Ihm9zEVRPGi4Q9rAY", "merchant_id": "merchant_1750676714", "status": "requires_customer_action", "amount": 333, "net_amount": 333, "shipping_cost": null, "amount_capturable": 333, "amount_received": null, "connector": "multisafepay", "client_secret": "pay_ly7Ihm9zEVRPGi4Q9rAY_secret_0QAA4w1LChiYL9nlsVW7", "created": "2025-06-26T05:22:38.368Z", "currency": "EUR", "customer_id": null, "customer": null, "description": "hellow world", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "wallet", "payment_method_data": { "wallet": {}, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": "Fasdf", "country": "CN", "line1": "Fasdf", "line2": "Fasdf", "line3": null, "zip": "560095", "state": null, "first_name": "Sakil", "last_name": "Mostak" }, "phone": null, "email": null }, "order_details": null, "email": null, "name": null, "phone": null, "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": { "type": "redirect_to_url", "redirect_to_url": "http://localhost:8080/payments/redirect/pay_ly7Ihm9zEVRPGi4Q9rAY/merchant_1750676714/pay_ly7Ihm9zEVRPGi4Q9rAY_1" }, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "we_chat_pay", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": null, "connector_transaction_id": "pay_ly7Ihm9zEVRPGi4Q9rAY_1", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_ly7Ihm9zEVRPGi4Q9rAY_1", "payment_link": null, "profile_id": "pro_7Pno0Wbshvrioh4kTJLM", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_aliGZhhX1SDuuEtkipSs", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-06-26T05:37:38.368Z", "fingerprint": null, "browser_info": null, "payment_method_id": null, "payment_method_status": null, "updated": "2025-06-26T05:22:39.622Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": null, "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` </details> <details> <summary>Confirm page</summary> ## You will get a qr page and it needs to be scanned normally and it will direct to confirm page (test mode) <img width="1105" alt="Screenshot 2025-06-26 at 10 53 31 AM" src="https://github.com/user-attachments/assets/e7385469-ae56-4849-a131-d3ff941445ba" /> </details> <details> <summary>Psync </summary> ```json { "payment_id": "pay_ly7Ihm9zEVRPGi4Q9rAY", "merchant_id": "merchant_1750676714", "status": "succeeded", "amount": 333, "net_amount": 333, "shipping_cost": null, "amount_capturable": 0, "amount_received": 333, "connector": "multisafepay", "client_secret": "pay_ly7Ihm9zEVRPGi4Q9rAY_secret_0QAA4w1LChiYL9nlsVW7", "created": "2025-06-26T05:22:38.368Z", "currency": "EUR", "customer_id": null, "customer": null, "description": "hellow world", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "wallet", "payment_method_data": { "wallet": {}, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": "Fasdf", "country": "CN", "line1": "Fasdf", "line2": "Fasdf", "line3": null, "zip": "560095", "state": null, "first_name": "Sakil", "last_name": "Mostak" }, "phone": null, "email": null }, "order_details": null, "email": null, "name": null, "phone": null, "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "we_chat_pay", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": false, "connector_transaction_id": "pay_ly7Ihm9zEVRPGi4Q9rAY_1", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_ly7Ihm9zEVRPGi4Q9rAY_1", "payment_link": null, "profile_id": "pro_7Pno0Wbshvrioh4kTJLM", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_aliGZhhX1SDuuEtkipSs", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-06-26T05:37:38.368Z", "fingerprint": null, "browser_info": null, "payment_method_id": null, "payment_method_status": null, "updated": "2025-06-26T05:23:57.958Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": null, "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` </details> ## Checklist - [x] I formatted the code `cargo +nightly fmt --all` - [ ] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.114.0	6d98d5721be41bbd2b9674ab0dbdeafe6c95b95f	6d98d5721be41bbd2b9674ab0dbdeafe6c95b95f
juspay/hyperswitch	juspay__hyperswitch-8516	Bug: [FEATURE] Add incremental authorization for Paypal, AuthorizeDotNet, Stripe ### Feature Description Add incremental authorization for Paypal, AuthorizeDotNet, Stripe ### Possible Implementation Add incremental authorization for Paypal, AuthorizeDotNet, Stripe ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? Yes, I am willing to submit a PR!	diff --git a/crates/hyperswitch_connectors/src/connectors/helcim.rs b/crates/hyperswitch_connectors/src/connectors/helcim.rs index 05165fbe91b..4845b2cbc7b 100644 --- a/crates/hyperswitch_connectors/src/connectors/helcim.rs +++ b/crates/hyperswitch_connectors/src/connectors/helcim.rs @@ -924,7 +924,7 @@ impl ConnectorTransactionId for Helcim { #[cfg(feature = "v1")] fn connector_transaction_id( &self, - payment_attempt: PaymentAttempt, + payment_attempt: &PaymentAttempt, ) -> Result<Option<String>, ApiErrorResponse> { if payment_attempt.get_connector_payment_id().is_none() { let metadata = @@ -940,7 +940,7 @@ impl ConnectorTransactionId for Helcim { #[cfg(feature = "v2")] fn connector_transaction_id( &self, - payment_attempt: PaymentAttempt, + payment_attempt: &PaymentAttempt, ) -> Result<Option<String>, ApiErrorResponse> { use hyperswitch_domain_models::errors::api_error_response::ApiErrorResponse; diff --git a/crates/hyperswitch_connectors/src/connectors/nexinets.rs b/crates/hyperswitch_connectors/src/connectors/nexinets.rs index 08084973c50..8733bede9c4 100644 --- a/crates/hyperswitch_connectors/src/connectors/nexinets.rs +++ b/crates/hyperswitch_connectors/src/connectors/nexinets.rs @@ -886,7 +886,7 @@ impl ConnectorTransactionId for Nexinets { #[cfg(feature = "v1")] fn connector_transaction_id( &self, - payment_attempt: PaymentAttempt, + payment_attempt: &PaymentAttempt, ) -> Result<Option<String>, ApiErrorResponse> { let metadata = Self::connector_transaction_id(self, payment_attempt.connector_metadata.as_ref()); @@ -896,7 +896,7 @@ impl ConnectorTransactionId for Nexinets { #[cfg(feature = "v2")] fn connector_transaction_id( &self, - payment_attempt: PaymentAttempt, + payment_attempt: &PaymentAttempt, ) -> Result<Option<String>, ApiErrorResponse> { use hyperswitch_domain_models::errors::api_error_response::ApiErrorResponse; diff --git a/crates/hyperswitch_connectors/src/connectors/paypal.rs b/crates/hyperswitch_connectors/src/connectors/paypal.rs index 578baba88b5..f90ac021fb2 100644 --- a/crates/hyperswitch_connectors/src/connectors/paypal.rs +++ b/crates/hyperswitch_connectors/src/connectors/paypal.rs @@ -20,8 +20,8 @@ use hyperswitch_domain_models::{ router_flow_types::{ access_token_auth::AccessTokenAuth, payments::{ - Authorize, Capture, PSync, PaymentMethodToken, PostSessionTokens, PreProcessing, - SdkSessionUpdate, Session, SetupMandate, Void, + Authorize, Capture, IncrementalAuthorization, PSync, PaymentMethodToken, + PostSessionTokens, PreProcessing, SdkSessionUpdate, Session, SetupMandate, Void, }, refunds::{Execute, RSync}, CompleteAuthorize, VerifyWebhookSource, @@ -29,19 +29,19 @@ use hyperswitch_domain_models::{ router_request_types::{ AccessTokenRequestData, CompleteAuthorizeData, PaymentMethodTokenizationData, PaymentsAuthorizeData, PaymentsCancelData, PaymentsCaptureData, - PaymentsPostSessionTokensData, PaymentsPreProcessingData, PaymentsSessionData, - PaymentsSyncData, RefundsData, ResponseId, SdkPaymentsSessionUpdateData, - SetupMandateRequestData, VerifyWebhookSourceRequestData, + PaymentsIncrementalAuthorizationData, PaymentsPostSessionTokensData, + PaymentsPreProcessingData, PaymentsSessionData, PaymentsSyncData, RefundsData, ResponseId, + SdkPaymentsSessionUpdateData, SetupMandateRequestData, VerifyWebhookSourceRequestData, }, router_response_types::{ PaymentsResponseData, RefundsResponseData, VerifyWebhookSourceResponseData, }, types::{ PaymentsAuthorizeRouterData, PaymentsCancelRouterData, PaymentsCaptureRouterData, - PaymentsCompleteAuthorizeRouterData, PaymentsPostSessionTokensRouterData, - PaymentsPreProcessingRouterData, PaymentsSyncRouterData, RefreshTokenRouterData, - RefundSyncRouterData, RefundsRouterData, SdkSessionUpdateRouterData, - SetupMandateRouterData, VerifyWebhookSourceRouterData, + PaymentsCompleteAuthorizeRouterData, PaymentsIncrementalAuthorizationRouterData, + PaymentsPostSessionTokensRouterData, PaymentsPreProcessingRouterData, + PaymentsSyncRouterData, RefreshTokenRouterData, RefundSyncRouterData, RefundsRouterData, + SdkSessionUpdateRouterData, SetupMandateRouterData, VerifyWebhookSourceRouterData, }, }; #[cfg(feature = "payouts")] @@ -55,17 +55,17 @@ use hyperswitch_interfaces::types::{PayoutFulfillType, PayoutSyncType}; use hyperswitch_interfaces::{ api::{ self, ConnectorCommon, ConnectorCommonExt, ConnectorIntegration, ConnectorRedirectResponse, - ConnectorSpecifications, ConnectorValidation, + ConnectorSpecifications, ConnectorValidation, PaymentIncrementalAuthorization, }, configs::Connectors, consts::{NO_ERROR_CODE, NO_ERROR_MESSAGE}, disputes, errors, events::connector_api_logs::ConnectorEvent, types::{ - PaymentsAuthorizeType, PaymentsCaptureType, PaymentsCompleteAuthorizeType, - PaymentsPostSessionTokensType, PaymentsPreProcessingType, PaymentsSyncType, - PaymentsVoidType, RefreshTokenType, RefundExecuteType, RefundSyncType, Response, - SdkSessionUpdateType, SetupMandateType, VerifyWebhookSourceType, + IncrementalAuthorizationType, PaymentsAuthorizeType, PaymentsCaptureType, + PaymentsCompleteAuthorizeType, PaymentsPostSessionTokensType, PaymentsPreProcessingType, + PaymentsSyncType, PaymentsVoidType, RefreshTokenType, RefundExecuteType, RefundSyncType, + Response, SdkSessionUpdateType, SetupMandateType, VerifyWebhookSourceType, }, webhooks::{IncomingWebhook, IncomingWebhookRequestDetails}, }; @@ -73,7 +73,8 @@ use masking::{ExposeInterface, Mask, Maskable, PeekInterface, Secret}; #[cfg(feature = "payouts")] use router_env::{instrument, tracing}; use transformers::{ - self as paypal, auth_headers, PaypalAuthResponse, PaypalMeta, PaypalWebhookEventType, + self as paypal, auth_headers, PaypalAuthResponse, PaypalIncrementalAuthResponse, PaypalMeta, + PaypalWebhookEventType, }; use crate::{ @@ -1105,6 +1106,123 @@ impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData } } +impl PaymentIncrementalAuthorization for Paypal {} + +impl + ConnectorIntegration< + IncrementalAuthorization, + PaymentsIncrementalAuthorizationData, + PaymentsResponseData, + > for Paypal +{ + fn get_headers( + &self, + req: &PaymentsIncrementalAuthorizationRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_http_method(&self) -> Method { + Method::Post + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + req: &PaymentsIncrementalAuthorizationRouterData, + connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + let paypal_meta: PaypalMeta = to_connector_meta(req.request.connector_meta.clone())?; + let incremental_authorization_id = paypal_meta.incremental_authorization_id.ok_or( + errors::ConnectorError::RequestEncodingFailedWithReason( + "Missing incremental authorization id".to_string(), + ), + )?; + Ok(format!( + "{}v2/payments/authorizations/{}/reauthorize", + self.base_url(connectors), + incremental_authorization_id + )) + } + + fn get_request_body( + &self, + req: &PaymentsIncrementalAuthorizationRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let amount = connector_utils::convert_amount( + self.amount_converter, + MinorUnit::new(req.request.total_amount), + req.request.currency, + )?; + let connector_router_data = + paypal::PaypalRouterData::try_from((amount, None, None, None, req))?; + let connector_req = paypal::PaypalIncrementalAuthRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &PaymentsIncrementalAuthorizationRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&IncrementalAuthorizationType::get_url( + self, req, connectors, + )?) + .attach_default_headers() + .headers(IncrementalAuthorizationType::get_headers( + self, req, connectors, + )?) + .set_body(IncrementalAuthorizationType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsIncrementalAuthorizationRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult< + RouterData< + IncrementalAuthorization, + PaymentsIncrementalAuthorizationData, + PaymentsResponseData, + >, + errors::ConnectorError, + > { + let response: PaypalIncrementalAuthResponse = res + .response + .parse_struct("Paypal IncrementalAuthResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + .change_context(errors::ConnectorError::ResponseHandlingFailed) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + impl api::PaymentsPreProcessing for Paypal {} impl ConnectorIntegration<PreProcessing, PaymentsPreProcessingData, PaymentsResponseData> diff --git a/crates/hyperswitch_connectors/src/connectors/paypal/transformers.rs b/crates/hyperswitch_connectors/src/connectors/paypal/transformers.rs index 8cabfcf4663..3814694b08b 100644 --- a/crates/hyperswitch_connectors/src/connectors/paypal/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/paypal/transformers.rs @@ -19,7 +19,8 @@ use hyperswitch_domain_models::{ VerifyWebhookSource, }, router_request_types::{ - PaymentsAuthorizeData, PaymentsPostSessionTokensData, PaymentsSyncData, ResponseId, + CompleteAuthorizeData, PaymentsAuthorizeData, PaymentsIncrementalAuthorizationData, + PaymentsPostSessionTokensData, PaymentsSyncData, ResponseId, VerifyWebhookSourceRequestData, }, router_response_types::{ @@ -28,8 +29,9 @@ use hyperswitch_domain_models::{ }, types::{ PaymentsAuthorizeRouterData, PaymentsCaptureRouterData, - PaymentsPostSessionTokensRouterData, RefreshTokenRouterData, RefundsRouterData, - SdkSessionUpdateRouterData, SetupMandateRouterData, VerifyWebhookSourceRouterData, + PaymentsIncrementalAuthorizationRouterData, PaymentsPostSessionTokensRouterData, + RefreshTokenRouterData, RefundsRouterData, SdkSessionUpdateRouterData, + SetupMandateRouterData, VerifyWebhookSourceRouterData, }, }; #[cfg(feature = "payouts")] @@ -55,6 +57,28 @@ use crate::{ }, }; +trait GetRequestIncrementalAuthorization { + fn get_request_incremental_authorization(&self) -> Option<bool>; +} + +impl GetRequestIncrementalAuthorization for PaymentsAuthorizeData { + fn get_request_incremental_authorization(&self) -> Option<bool> { + Some(self.request_incremental_authorization) + } +} + +impl GetRequestIncrementalAuthorization for CompleteAuthorizeData { + fn get_request_incremental_authorization(&self) -> Option<bool> { + None + } +} + +impl GetRequestIncrementalAuthorization for PaymentsSyncData { + fn get_request_incremental_authorization(&self) -> Option<bool> { + None + } +} + #[derive(Debug, Serialize)] pub struct PaypalRouterData<T> { pub amount: StringMajorUnit, @@ -237,7 +261,7 @@ pub struct PurchaseUnitRequest { items: Vec<ItemDetails>, } -#[derive(Default, Debug, Serialize, Eq, PartialEq)] +#[derive(Default, Debug, Deserialize, Serialize, Eq, PartialEq)] pub struct Payee { merchant_id: Secret<String>, } @@ -1425,6 +1449,119 @@ impl<F, T> TryFrom<ResponseRouterData<F, PaypalAuthUpdateResponse, T, AccessToke } } +#[derive(Debug, Serialize)] +pub struct PaypalIncrementalAuthRequest { + amount: OrderAmount, +} + +impl TryFrom<&PaypalRouterData<&PaymentsIncrementalAuthorizationRouterData>> + for PaypalIncrementalAuthRequest +{ + type Error = error_stack::Report<errors::ConnectorError>; + + fn try_from( + item: &PaypalRouterData<&PaymentsIncrementalAuthorizationRouterData>, + ) -> Result<Self, Self::Error> { + Ok(Self { + amount: OrderAmount { + currency_code: item.router_data.request.currency, + value: item.amount.clone(), + }, + }) + } +} + +#[derive(Debug, Deserialize, Serialize)] +pub struct PaypalIncrementalAuthResponse { + status: PaypalIncrementalStatus, + status_details: PaypalIncrementalAuthStatusDetails, + id: String, + invoice_id: String, + custom_id: String, + links: Vec<PaypalLinks>, + amount: OrderAmount, + network_transaction_reference: PaypalNetworkTransactionReference, + expiration_time: String, + create_time: String, + update_time: String, + supplementary_data: PaypalSupplementaryData, + payee: Payee, + name: Option<String>, + message: Option<String>, +} + +#[derive(Debug, Deserialize, Serialize)] +#[serde(rename_all = "SCREAMING_SNAKE_CASE")] +pub enum PaypalIncrementalStatus { + CREATED, + CAPTURED, + DENIED, + PARTIALLYCAPTURED, + VOIDED, + PENDING, +} + +#[derive(Debug, Deserialize, Serialize)] +pub struct PaypalNetworkTransactionReference { + id: String, +} + +#[derive(Debug, Deserialize, Serialize)] +pub struct PaypalIncrementalAuthStatusDetails { + reason: PaypalStatusPendingReason, +} + +#[derive(Debug, Deserialize, Serialize)] +#[serde(rename_all = "SCREAMING_SNAKE_CASE")] +pub enum PaypalStatusPendingReason { + PENDINGREVIEW, + DECLINEDBYRISKFRAUDFILTERS, +} + +impl From<PaypalIncrementalStatus> for common_enums::AuthorizationStatus { + fn from(item: PaypalIncrementalStatus) -> Self { + match item { + PaypalIncrementalStatus::CREATED + \| PaypalIncrementalStatus::CAPTURED + \| PaypalIncrementalStatus::PARTIALLYCAPTURED => Self::Success, + PaypalIncrementalStatus::PENDING => Self::Processing, + PaypalIncrementalStatus::DENIED \| PaypalIncrementalStatus::VOIDED => Self::Failure, + } + } +} + +impl<F> + TryFrom< + ResponseRouterData< + F, + PaypalIncrementalAuthResponse, + PaymentsIncrementalAuthorizationData, + PaymentsResponseData, + >, + > for RouterData<F, PaymentsIncrementalAuthorizationData, PaymentsResponseData> +{ + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: ResponseRouterData< + F, + PaypalIncrementalAuthResponse, + PaymentsIncrementalAuthorizationData, + PaymentsResponseData, + >, + ) -> Result<Self, Self::Error> { + let status = common_enums::AuthorizationStatus::from(item.response.status); + Ok(Self { + response: Ok(PaymentsResponseData::IncrementalAuthorizationResponse { + status, + error_code: None, + error_message: None, + connector_authorization_id: Some(item.response.id), + }), + ..item.data + }) + } +} + #[derive(Debug)] pub enum PaypalAuthType { TemporaryAuth, @@ -1747,6 +1884,7 @@ pub struct CardDetails { pub struct PaypalMeta { pub authorize_id: Option<String>, pub capture_id: Option<String>, + pub incremental_authorization_id: Option<String>, pub psync_flow: PaypalPaymentIntent, pub next_action: Option<api_models::payments::NextActionCall>, pub order_id: Option<String>, @@ -1782,12 +1920,25 @@ fn get_id_based_on_intent( .ok_or_else(\|\| errors::ConnectorError::MissingConnectorTransactionID.into()) } -impl<F, T> TryFrom<ResponseRouterData<F, PaypalOrdersResponse, T, PaymentsResponseData>> - for RouterData<F, T, PaymentsResponseData> +fn extract_incremental_authorization_id(response: &PaypalOrdersResponse) -> Option<String> { + for unit in &response.purchase_units { + if let Some(authorizations) = &unit.payments.authorizations { + if let Some(first_auth) = authorizations.first() { + return Some(first_auth.id.clone()); + } + } + } + None +} + +impl<F, Req> TryFrom<ResponseRouterData<F, PaypalOrdersResponse, Req, PaymentsResponseData>> + for RouterData<F, Req, PaymentsResponseData> +where + Req: GetRequestIncrementalAuthorization, { type Error = error_stack::Report<errors::ConnectorError>; fn try_from( - item: ResponseRouterData<F, PaypalOrdersResponse, T, PaymentsResponseData>, + item: ResponseRouterData<F, PaypalOrdersResponse, Req, PaymentsResponseData>, ) -> Result<Self, Self::Error> { let purchase_units = item .response @@ -1801,6 +1952,7 @@ impl<F, T> TryFrom<ResponseRouterData<F, PaypalOrdersResponse, T, PaymentsRespon serde_json::json!(PaypalMeta { authorize_id: None, capture_id: Some(id), + incremental_authorization_id: None, psync_flow: item.response.intent.clone(), next_action: None, order_id: None, @@ -1812,6 +1964,9 @@ impl<F, T> TryFrom<ResponseRouterData<F, PaypalOrdersResponse, T, PaymentsRespon serde_json::json!(PaypalMeta { authorize_id: Some(id), capture_id: None, + incremental_authorization_id: extract_incremental_authorization_id( + &item.response + ), psync_flow: item.response.intent.clone(), next_action: None, order_id: None, @@ -1872,7 +2027,10 @@ impl<F, T> TryFrom<ResponseRouterData<F, PaypalOrdersResponse, T, PaymentsRespon .invoice_id .clone() .or(Some(item.response.id)), - incremental_authorization_allowed: None, + incremental_authorization_allowed: item + .data + .request + .get_request_incremental_authorization(), charges: None, }), ..item.data @@ -1965,6 +2123,7 @@ impl<F, T> let connector_meta = serde_json::json!(PaypalMeta { authorize_id: None, capture_id: None, + incremental_authorization_id: None, psync_flow: item.response.intent, next_action, order_id: None, @@ -2017,6 +2176,7 @@ impl let connector_meta = serde_json::json!(PaypalMeta { authorize_id: None, capture_id: None, + incremental_authorization_id: None, psync_flow: item.response.intent, next_action: None, order_id: None, @@ -2072,6 +2232,7 @@ impl let connector_meta = serde_json::json!(PaypalMeta { authorize_id: None, capture_id: None, + incremental_authorization_id: None, psync_flow: item.response.intent, next_action, order_id: Some(item.response.id.clone()), @@ -2144,6 +2305,7 @@ impl<F> let connector_meta = serde_json::json!(PaypalMeta { authorize_id: None, capture_id: None, + incremental_authorization_id: None, psync_flow: PaypalPaymentIntent::Authenticate, // when there is no capture or auth id present next_action: None, order_id: None, @@ -2550,6 +2712,7 @@ impl TryFrom<PaymentsCaptureResponseRouterData<PaypalCaptureResponse>> connector_metadata: Some(serde_json::json!(PaypalMeta { authorize_id: connector_payment_id.authorize_id, capture_id: Some(item.response.id.clone()), + incremental_authorization_id: None, psync_flow: PaypalPaymentIntent::Capture, next_action: None, order_id: None, diff --git a/crates/hyperswitch_connectors/src/default_implementations.rs b/crates/hyperswitch_connectors/src/default_implementations.rs index 38e63124029..bdf3ee5604b 100644 --- a/crates/hyperswitch_connectors/src/default_implementations.rs +++ b/crates/hyperswitch_connectors/src/default_implementations.rs @@ -1086,7 +1086,6 @@ default_imp_for_incremental_authorization!( connectors::Payload, connectors::Payme, connectors::Payone, - connectors::Paypal, connectors::Paystack, connectors::Payu, connectors::Placetopay, diff --git a/crates/hyperswitch_domain_models/src/router_request_types.rs b/crates/hyperswitch_domain_models/src/router_request_types.rs index 31879b4cfe3..fd37b30f6f8 100644 --- a/crates/hyperswitch_domain_models/src/router_request_types.rs +++ b/crates/hyperswitch_domain_models/src/router_request_types.rs @@ -155,6 +155,7 @@ pub struct PaymentsIncrementalAuthorizationData { pub currency: storage_enums::Currency, pub reason: Option<String>, pub connector_transaction_id: String, + pub connector_meta: Option<serde_json::Value>, } #[derive(Debug, Clone, Default)] diff --git a/crates/hyperswitch_interfaces/src/api.rs b/crates/hyperswitch_interfaces/src/api.rs index 4162eb29094..70d1bc2c1b6 100644 --- a/crates/hyperswitch_interfaces/src/api.rs +++ b/crates/hyperswitch_interfaces/src/api.rs @@ -722,7 +722,7 @@ pub trait ConnectorTransactionId: ConnectorCommon + Sync { /// fn connector_transaction_id fn connector_transaction_id( &self, - payment_attempt: hyperswitch_domain_models::payments::payment_attempt::PaymentAttempt, + payment_attempt: &hyperswitch_domain_models::payments::payment_attempt::PaymentAttempt, ) -> Result<Option<String>, ApiErrorResponse> { Ok(payment_attempt .get_connector_payment_id() diff --git a/crates/hyperswitch_interfaces/src/connector_integration_interface.rs b/crates/hyperswitch_interfaces/src/connector_integration_interface.rs index 998df9ec61c..c40c65ac5f7 100644 --- a/crates/hyperswitch_interfaces/src/connector_integration_interface.rs +++ b/crates/hyperswitch_interfaces/src/connector_integration_interface.rs @@ -793,7 +793,7 @@ impl api::ConnectorTransactionId for ConnectorEnum { /// A `Result` containing an optional transaction ID or an ApiErrorResponse fn connector_transaction_id( &self, - payment_attempt: hyperswitch_domain_models::payments::payment_attempt::PaymentAttempt, + payment_attempt: &hyperswitch_domain_models::payments::payment_attempt::PaymentAttempt, ) -> Result<Option<String>, ApiErrorResponse> { match self { Self::Old(connector) => connector.connector_transaction_id(payment_attempt), diff --git a/crates/router/src/core/payments/transformers.rs b/crates/router/src/core/payments/transformers.rs index 2379dddb8fd..1cd67d61f68 100644 --- a/crates/router/src/core/payments/transformers.rs +++ b/crates/router/src/core/payments/transformers.rs @@ -478,7 +478,7 @@ pub async fn construct_payment_router_data_for_capture<'a>( currency: payment_data.payment_intent.amount_details.currency, connector_transaction_id: connector .connector - .connector_transaction_id(payment_data.payment_attempt.clone())? + .connector_transaction_id(&payment_data.payment_attempt)? .ok_or(errors::ApiErrorResponse::ResourceIdNotFound)?, payment_amount: amount.get_amount_as_i64(), // This should be removed once we start moving to connector module minor_payment_amount: amount, @@ -3756,6 +3756,7 @@ impl<F: Clone> TryFrom<PaymentAdditionalData<'_, F>> for types::PaymentsSyncData } } +#[cfg(feature = "v1")] impl<F: Clone> TryFrom<PaymentAdditionalData<'_, F>> for types::PaymentsIncrementalAuthorizationData { @@ -3763,39 +3764,68 @@ impl<F: Clone> TryFrom<PaymentAdditionalData<'_, F>> fn try_from(additional_data: PaymentAdditionalData<'_, F>) -> Result<Self, Self::Error> { let payment_data = additional_data.payment_data; + let payment_attempt = &payment_data.payment_attempt; let connector = api::ConnectorData::get_connector_by_name( &additional_data.state.conf.connectors, &additional_data.connector_name, api::GetToken::Connector, - payment_data.payment_attempt.merchant_connector_id.clone(), + payment_attempt.merchant_connector_id.clone(), )?; - let total_amount = payment_data + let incremental_details = payment_data .incremental_authorization_details - .clone() - .map(\|details\| details.total_amount) + .as_ref() .ok_or( report!(errors::ApiErrorResponse::InternalServerError) .attach_printable("missing incremental_authorization_details in payment_data"), )?; - let additional_amount = payment_data + Ok(Self { + total_amount: incremental_details.total_amount.get_amount_as_i64(), + additional_amount: incremental_details.additional_amount.get_amount_as_i64(), + reason: incremental_details.reason.clone(), + currency: payment_data.currency, + connector_transaction_id: connector + .connector + .connector_transaction_id(payment_attempt)? + .ok_or(errors::ApiErrorResponse::ResourceIdNotFound)?, + connector_meta: payment_attempt.connector_metadata.clone(), + }) + } +} + +#[cfg(feature = "v2")] +impl<F: Clone> TryFrom<PaymentAdditionalData<'_, F>> + for types::PaymentsIncrementalAuthorizationData +{ + type Error = error_stack::Report<errors::ApiErrorResponse>; + + fn try_from(additional_data: PaymentAdditionalData<'_, F>) -> Result<Self, Self::Error> { + let payment_data = additional_data.payment_data; + let connector = api::ConnectorData::get_connector_by_name( + &additional_data.state.conf.connectors, + &additional_data.connector_name, + api::GetToken::Connector, + payment_data.payment_attempt.merchant_connector_id.clone(), + )?; + let incremental_details = payment_data .incremental_authorization_details - .clone() - .map(\|details\| details.additional_amount) + .as_ref() .ok_or( report!(errors::ApiErrorResponse::InternalServerError) .attach_printable("missing incremental_authorization_details in payment_data"), )?; Ok(Self { - total_amount: total_amount.get_amount_as_i64(), - additional_amount: additional_amount.get_amount_as_i64(), - reason: payment_data - .incremental_authorization_details - .and_then(\|details\| details.reason), + total_amount: incremental_details.total_amount.get_amount_as_i64(), + additional_amount: incremental_details.additional_amount.get_amount_as_i64(), + reason: incremental_details.reason.clone(), currency: payment_data.currency, connector_transaction_id: connector .connector - .connector_transaction_id(payment_data.payment_attempt.clone())? + .connector_transaction_id(&payment_data.payment_attempt)? .ok_or(errors::ApiErrorResponse::ResourceIdNotFound)?, + connector_meta: payment_data + .payment_attempt + .connector_metadata + .map(\|secret\| secret.expose()), }) } } @@ -3828,7 +3858,7 @@ impl<F: Clone> TryFrom<PaymentAdditionalData<'_, F>> for types::PaymentsCaptureD currency: payment_data.currency, connector_transaction_id: connector .connector - .connector_transaction_id(payment_data.payment_attempt.clone())? + .connector_transaction_id(&payment_data.payment_attempt)? .ok_or(errors::ApiErrorResponse::ResourceIdNotFound)?, payment_amount: amount.get_amount_as_i64(), // This should be removed once we start moving to connector module minor_payment_amount: amount, @@ -3896,7 +3926,7 @@ impl<F: Clone> TryFrom<PaymentAdditionalData<'_, F>> for types::PaymentsCaptureD currency: payment_data.currency, connector_transaction_id: connector .connector - .connector_transaction_id(payment_data.payment_attempt.clone())? + .connector_transaction_id(&payment_data.payment_attempt)? .ok_or(errors::ApiErrorResponse::ResourceIdNotFound)?, payment_amount: amount.get_amount_as_i64(), // This should be removed once we start moving to connector module minor_payment_amount: amount, @@ -3973,7 +4003,7 @@ impl<F: Clone> TryFrom<PaymentAdditionalData<'_, F>> for types::PaymentsCancelDa currency: Some(payment_data.currency), connector_transaction_id: connector .connector - .connector_transaction_id(payment_data.payment_attempt.clone())? + .connector_transaction_id(&payment_data.payment_attempt)? .ok_or(errors::ApiErrorResponse::ResourceIdNotFound)?, cancellation_reason: payment_data.payment_attempt.cancellation_reason, connector_meta: payment_data.payment_attempt.connector_metadata, @@ -4127,7 +4157,7 @@ impl<F: Clone> TryFrom<PaymentAdditionalData<'_, F>> for types::PaymentsUpdateMe .attach_printable("payment_intent.metadata not found")?, connector_transaction_id: connector .connector - .connector_transaction_id(payment_data.payment_attempt.clone())? + .connector_transaction_id(&payment_data.payment_attempt)? .ok_or(errors::ApiErrorResponse::ResourceIdNotFound)?, }) }	2025-07-01T23:24:24Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD Closes this [issue](https://github.com/juspay/hyperswitch/issues/8516) ## Description <!-- Describe your changes in detail --> Added Incremental Authorization flow for Paypal ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> https://github.com/juspay/hyperswitch/issues/8516 ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> Postman Test Payments - Create: Request: ``` curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_1PzpFzUXX4ZALEpOUNRFMeXyRB2WCZHfhd6AXOKifb7fqVRfrUFQLiqS4DchmszP' \ --data-raw ' { "amount": 1000, "currency": "USD", "confirm": true, "capture_method": "manual", "capture_on": "2022-09-10T10:11:12Z", "amount_to_capture": 1000, "customer_id": "StripeCustomer", "email": "[email protected]", "name": "John Doe", "phone": "999999999", "phone_country_code": "+65", "description": "Its my first payment request", "authentication_type": "no_three_ds", "return_url": "https://duck.com", "billing": { "address": { "first_name": "John", "last_name": "Doe", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "AT" } }, "payment_method": "card", "payment_method_type": "credit", "payment_method_data": { "card": { "card_number": "4111111111111111", "card_exp_month": "11", "card_exp_year": "2030", "card_holder_name": "joseph Doe", "card_cvc": "276" } }, "browser_info": { "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8", "language": "nl-NL", "color_depth": 24, "screen_height": 723, "screen_width": 1536, "time_zone": 0, "java_enabled": true, "java_script_enabled": true, "ip_address": "127.0.0.1" }, "shipping": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "John", "last_name": "Doe" } }, "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "metadata": { "udf1": "value1", "new_customer": "true", "login_date": "2019-09-10T10:11:12Z" }, "request_incremental_authorization": true }' ``` Response: ``` { "payment_id": "pay_1agl8yqCWefEuD7cM9DK", "merchant_id": "merchant_1751411099", "status": "requires_capture", "amount": 1000, "net_amount": 1000, "shipping_cost": null, "amount_capturable": 1000, "amount_received": null, "connector": "paypal", "client_secret": "pay_1agl8yqCWefEuD7cM9DK_secret_iYISlExnoU9wZBlUbA0J", "created": "2025-07-01T23:05:08.941Z", "currency": "USD", "customer_id": "StripeCustomer", "customer": { "id": "StripeCustomer", "name": "John Doe", "email": "[email protected]", "phone": "999999999", "phone_country_code": "+65" }, "description": "Its my first payment request", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "manual", "payment_method": "card", "payment_method_data": { "card": { "last4": "1111", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "411111", "card_extended_bin": null, "card_exp_month": "11", "card_exp_year": "2030", "card_holder_name": "joseph Doe", "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "John", "last_name": "Doe" }, "phone": null, "email": null }, "billing": { "address": { "city": "San Fransico", "country": "AT", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "John", "last_name": "Doe" }, "phone": null, "email": null }, "order_details": null, "email": "[email protected]", "name": "John Doe", "phone": "999999999", "return_url": "https://duck.com/", "authentication_type": "no_three_ds", "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "credit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": { "customer_id": "StripeCustomer", "created_at": 1751411108, "expires": 1751414708, "secret": "epk_dc7e9d0a449a4c28816179c01355a423" }, "manual_retry_allowed": false, "connector_transaction_id": "120066274887", "frm_message": null, "metadata": { "udf1": "value1", "login_date": "2019-09-10T10:11:12Z", "new_customer": "true" }, "connector_metadata": null, "feature_metadata": null, "reference_id": "120066274887", "payment_link": null, "profile_id": "pro_ufQauYhoCJvm3iPPC8mG", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_6BJ52EkitWXtjk3xh9jx", "incremental_authorization_allowed": true, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-07-01T23:20:08.940Z", "fingerprint": null, "browser_info": { "language": "nl-NL", "time_zone": 0, "ip_address": "127.0.0.1", "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "color_depth": 24, "java_enabled": true, "screen_width": 1536, "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8", "screen_height": 723, "java_script_enabled": true }, "payment_method_id": null, "payment_method_status": null, "updated": "2025-07-01T23:05:11.094Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` Incremental Authorization: Request: ``` curl --location 'http://localhost:8080/payments/pay_1agl8yqCWefEuD7cM9DK/incremental_authorization' \ --header 'Content-Type: application/json' \ --header 'api-key: dev_1PzpFzUXX4ZALEpOUNRFMeXyRB2WCZHfhd6AXOKifb7fqVRfrUFQLiqS4DchmszP' \ --data '{ "amount": 6540, "reason": "customer gone overbudget" }' ``` NOTE: The response will return failure status if the payment authorization has not yet surpassed the 4-day threshold. As per Paypal's documentation, a payment becomes eligible for incremental authorization only after the initial authorization is older than 4 days. Response: ``` { "payment_id": "pay_KorlaZqtqUdTrpKtGhwj", "merchant_id": "merchant_1751412204", "status": "requires_capture", "amount": 1050, "net_amount": 1050, "shipping_cost": null, "amount_capturable": 1050, "amount_received": null, "connector": "paypal", "client_secret": "pay_KorlaZqtqUdTrpKtGhwj_secret_JvQWos0QgC06DTMUIUod", "created": "2025-07-01T23:23:32.564Z", "currency": "USD", "customer_id": null, "customer": { "id": null, "name": "John Doe", "email": "[email protected]", "phone": "999999999", "phone_country_code": "+65" }, "description": "Its my first payment request", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "manual", "payment_method": "card", "payment_method_data": { "card": { "last4": "1111", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "411111", "card_extended_bin": null, "card_exp_month": "11", "card_exp_year": "2030", "card_holder_name": "joseph Doe", "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": null, "billing": null, "order_details": null, "email": null, "name": null, "phone": null, "return_url": "https://duck.com/", "authentication_type": "no_three_ds", "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "credit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": false, "connector_transaction_id": "4657001324168371U", "frm_message": null, "metadata": { "udf1": "value1", "login_date": "2019-09-10T10:11:12Z", "new_customer": "true" }, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_KorlaZqtqUdTrpKtGhwj_1", "payment_link": null, "profile_id": "pro_K0AcXOIDkvcyvNd6AU0K", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_frPGdve129UARoghNL0x", "incremental_authorization_allowed": true, "authorization_count": 2, "incremental_authorizations": [ { "authorization_id": "auth_bdKFP2R2zflE7nGe7DSm_1", "amount": 6540, "status": "failure", "error_code": "REAUTHORIZATION_TOO_SOON", "error_message": "REAUTHORIZATION_TOO_SOON", "previously_authorized_amount": 1000 }, { "authorization_id": "auth_fkKGl3yaPor09wvHf7KmS_2", "amount": 1050, "status": "succeeded", "error_code": null, "error_message": null, "previously_authorized_amount": 1000 }, ], "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-07-01T23:38:32.564Z", "fingerprint": null, "browser_info": { "language": "nl-NL", "time_zone": 0, "ip_address": "127.0.0.1", "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "color_depth": 24, "java_enabled": true, "screen_width": 1536, "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8", "screen_height": 723, "java_script_enabled": true }, "payment_method_id": null, "payment_method_status": null, "updated": "2025-07-01T23:23:41.215Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` Cypress Screenshot for Incremental Authorization: <img width="627" height="416" alt="Screenshot 2025-07-14 at 1 34 28 PM" src="https://github.com/user-attachments/assets/b7917284-2f90-484e-b720-162ae28a1b32" /> ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	3c498714e76b400657fc0fc25b7559ca3dca1908	3c498714e76b400657fc0fc25b7559ca3dca1908
juspay/hyperswitch	juspay__hyperswitch-8520	Bug: add `debit_routing_savings` in analytics payment attempt We need to add debit_routing_savings to the payment analytics. This will provide the savings per card network, as well as the total savings for a profile.	diff --git a/crates/analytics/docs/clickhouse/scripts/payment_attempts.sql b/crates/analytics/docs/clickhouse/scripts/payment_attempts.sql index 6673b73fedb..16815e9a33d 100644 --- a/crates/analytics/docs/clickhouse/scripts/payment_attempts.sql +++ b/crates/analytics/docs/clickhouse/scripts/payment_attempts.sql @@ -44,6 +44,7 @@ CREATE TABLE payment_attempt_queue ( `profile_id` String, `card_network` Nullable(String), `routing_approach` LowCardinality(Nullable(String)), + `debit_routing_savings` Nullable(UInt32), `sign_flag` Int8 ) ENGINE = Kafka SETTINGS kafka_broker_list = 'kafka0:29092', kafka_topic_list = 'hyperswitch-payment-attempt-events', @@ -98,6 +99,7 @@ CREATE TABLE payment_attempts ( `profile_id` String, `card_network` Nullable(String), `routing_approach` LowCardinality(Nullable(String)), + `debit_routing_savings` Nullable(UInt32), `sign_flag` Int8, INDEX connectorIndex connector TYPE bloom_filter GRANULARITY 1, INDEX paymentMethodIndex payment_method TYPE bloom_filter GRANULARITY 1, @@ -155,6 +157,7 @@ CREATE MATERIALIZED VIEW payment_attempt_mv TO payment_attempts ( `profile_id` String, `card_network` Nullable(String), `routing_approach` LowCardinality(Nullable(String)), + `debit_routing_savings` Nullable(UInt32), `sign_flag` Int8 ) AS SELECT @@ -204,6 +207,7 @@ SELECT profile_id, card_network, routing_approach, + debit_routing_savings, sign_flag FROM payment_attempt_queue diff --git a/crates/analytics/src/payments/accumulator.rs b/crates/analytics/src/payments/accumulator.rs index 20ccc634068..6d7dca22a30 100644 --- a/crates/analytics/src/payments/accumulator.rs +++ b/crates/analytics/src/payments/accumulator.rs @@ -18,6 +18,7 @@ pub struct PaymentMetricsAccumulator { pub connector_success_rate: SuccessRateAccumulator, pub payments_distribution: PaymentsDistributionAccumulator, pub failure_reasons_distribution: FailureReasonsDistributionAccumulator, + pub debit_routing: DebitRoutingAccumulator, } #[derive(Debug, Default)] @@ -58,6 +59,12 @@ pub struct ProcessedAmountAccumulator { pub total_without_retries: Option<i64>, } +#[derive(Debug, Default)] +pub struct DebitRoutingAccumulator { + pub transaction_count: u64, + pub savings_amount: u64, +} + #[derive(Debug, Default)] pub struct AverageAccumulator { pub total: u32, @@ -183,6 +190,27 @@ impl PaymentMetricAccumulator for SuccessRateAccumulator { } } +impl PaymentMetricAccumulator for DebitRoutingAccumulator { + type MetricOutput = (Option<u64>, Option<u64>, Option<u64>); + + fn add_metrics_bucket(&mut self, metrics: &PaymentMetricRow) { + if let Some(count) = metrics.count { + self.transaction_count += u64::try_from(count).unwrap_or(0); + } + if let Some(total) = metrics.total.as_ref().and_then(ToPrimitive::to_u64) { + self.savings_amount += total; + } + } + + fn collect(self) -> Self::MetricOutput { + ( + Some(self.transaction_count), + Some(self.savings_amount), + Some(0), + ) + } +} + impl PaymentMetricAccumulator for PaymentsDistributionAccumulator { type MetricOutput = ( Option<f64>, @@ -440,6 +468,9 @@ impl PaymentMetricsAccumulator { ) = self.payments_distribution.collect(); let (failure_reason_count, failure_reason_count_without_smart_retries) = self.failure_reasons_distribution.collect(); + let (debit_routed_transaction_count, debit_routing_savings, debit_routing_savings_in_usd) = + self.debit_routing.collect(); + PaymentMetricsBucketValue { payment_success_rate: self.payment_success_rate.collect(), payment_count: self.payment_count.collect(), @@ -463,6 +494,9 @@ impl PaymentMetricsAccumulator { failure_reason_count_without_smart_retries, payment_processed_amount_in_usd, payment_processed_amount_without_smart_retries_usd, + debit_routed_transaction_count, + debit_routing_savings, + debit_routing_savings_in_usd, } } } diff --git a/crates/analytics/src/payments/core.rs b/crates/analytics/src/payments/core.rs index e55ba2726af..c1922ffe924 100644 --- a/crates/analytics/src/payments/core.rs +++ b/crates/analytics/src/payments/core.rs @@ -171,6 +171,9 @@ pub async fn get_metrics( .connector_success_rate .add_metrics_bucket(&value); } + PaymentMetrics::DebitRouting \| PaymentMetrics::SessionizedDebitRouting => { + metrics_builder.debit_routing.add_metrics_bucket(&value); + } PaymentMetrics::PaymentsDistribution => { metrics_builder .payments_distribution @@ -294,6 +297,33 @@ pub async fn get_metrics( if let Some(count) = collected_values.failure_reason_count_without_smart_retries { total_failure_reasons_count_without_smart_retries += count; } + if let Some(savings) = collected_values.debit_routing_savings { + let savings_in_usd = if let Some(ex_rates) = ex_rates { + id.currency + .and_then(\|currency\| { + i64::try_from(savings) + .inspect_err(\|e\| { + logger::error!( + "Debit Routing savings conversion error: {:?}", + e + ) + }) + .ok() + .and_then(\|savings_i64\| { + convert(ex_rates, currency, Currency::USD, savings_i64) + .inspect_err(\|e\| { + logger::error!("Currency conversion error: {:?}", e) + }) + .ok() + }) + }) + .map(\|savings\| (savings * rust_decimal::Decimal::new(100, 0)).to_u64()) + .unwrap_or_default() + } else { + None + }; + collected_values.debit_routing_savings_in_usd = savings_in_usd; + } MetricsBucketResponse { values: collected_values, dimensions: id, diff --git a/crates/analytics/src/payments/metrics.rs b/crates/analytics/src/payments/metrics.rs index 67dc50c5152..b19c661322d 100644 --- a/crates/analytics/src/payments/metrics.rs +++ b/crates/analytics/src/payments/metrics.rs @@ -15,6 +15,7 @@ use crate::{ mod avg_ticket_size; mod connector_success_rate; +mod debit_routing; mod payment_count; mod payment_processed_amount; mod payment_success_count; @@ -24,6 +25,7 @@ mod success_rate; use avg_ticket_size::AvgTicketSize; use connector_success_rate::ConnectorSuccessRate; +use debit_routing::DebitRouting; use payment_count::PaymentCount; use payment_processed_amount::PaymentProcessedAmount; use payment_success_count::PaymentSuccessCount; @@ -130,6 +132,11 @@ where .load_metrics(dimensions, auth, filters, granularity, time_range, pool) .await } + Self::DebitRouting => { + DebitRouting + .load_metrics(dimensions, auth, filters, granularity, time_range, pool) + .await + } Self::SessionizedPaymentSuccessRate => { sessionized_metrics::PaymentSuccessRate .load_metrics(dimensions, auth, filters, granularity, time_range, pool) @@ -175,6 +182,11 @@ where .load_metrics(dimensions, auth, filters, granularity, time_range, pool) .await } + Self::SessionizedDebitRouting => { + sessionized_metrics::DebitRouting + .load_metrics(dimensions, auth, filters, granularity, time_range, pool) + .await + } } } } diff --git a/crates/analytics/src/payments/metrics/debit_routing.rs b/crates/analytics/src/payments/metrics/debit_routing.rs new file mode 100644 index 00000000000..584221205cd --- /dev/null +++ b/crates/analytics/src/payments/metrics/debit_routing.rs @@ -0,0 +1,151 @@ +use std::collections::HashSet; + +use api_models::analytics::{ + payments::{PaymentDimensions, PaymentFilters, PaymentMetricsBucketIdentifier}, + Granularity, TimeRange, +}; +use common_utils::errors::ReportSwitchExt; +use diesel_models::enums as storage_enums; +use error_stack::ResultExt; +use time::PrimitiveDateTime; + +use super::PaymentMetricRow; +use crate::{ + enums::AuthInfo, + query::{Aggregate, GroupByClause, QueryBuilder, QueryFilter, SeriesBucket, ToSql, Window}, + types::{AnalyticsCollection, AnalyticsDataSource, MetricsError, MetricsResult}, +}; + +#[derive(Default)] +pub(super) struct DebitRouting; + +#[async_trait::async_trait] +impl<T> super::PaymentMetric<T> for DebitRouting +where + T: AnalyticsDataSource + super::PaymentMetricAnalytics, + PrimitiveDateTime: ToSql<T>, + AnalyticsCollection: ToSql<T>, + Granularity: GroupByClause<T>, + Aggregate<&'static str>: ToSql<T>, + Window<&'static str>: ToSql<T>, +{ + async fn load_metrics( + &self, + dimensions: &[PaymentDimensions], + auth: &AuthInfo, + filters: &PaymentFilters, + granularity: Option<Granularity>, + time_range: &TimeRange, + pool: &T, + ) -> MetricsResult<HashSet<(PaymentMetricsBucketIdentifier, PaymentMetricRow)>> { + let mut query_builder: QueryBuilder<T> = QueryBuilder::new(AnalyticsCollection::Payment); + + for dim in dimensions.iter() { + query_builder.add_select_column(dim).switch()?; + } + query_builder + .add_select_column(Aggregate::Count { + field: None, + alias: Some("count"), + }) + .switch()?; + query_builder + .add_select_column(Aggregate::Sum { + field: "debit_routing_savings", + alias: Some("total"), + }) + .switch()?; + query_builder.add_select_column("currency").switch()?; + query_builder + .add_select_column(Aggregate::Min { + field: "created_at", + alias: Some("start_bucket"), + }) + .switch()?; + query_builder + .add_select_column(Aggregate::Max { + field: "created_at", + alias: Some("end_bucket"), + }) + .switch()?; + + filters.set_filter_clause(&mut query_builder).switch()?; + + auth.set_filter_clause(&mut query_builder).switch()?; + + time_range + .set_filter_clause(&mut query_builder) + .attach_printable("Error filtering time range") + .switch()?; + + for dim in dimensions.iter() { + query_builder + .add_group_by_clause(dim) + .attach_printable("Error grouping by dimensions") + .switch()?; + } + + query_builder + .add_group_by_clause("currency") + .attach_printable("Error grouping by currency") + .switch()?; + + if let Some(granularity) = granularity { + granularity + .set_group_by_clause(&mut query_builder) + .attach_printable("Error adding granularity") + .switch()?; + } + + query_builder + .add_filter_clause( + PaymentDimensions::PaymentStatus, + storage_enums::AttemptStatus::Charged, + ) + .switch()?; + + query_builder + .execute_query::<PaymentMetricRow, _>(pool) + .await + .change_context(MetricsError::QueryBuildingError)? + .change_context(MetricsError::QueryExecutionFailure)? + .into_iter() + .map(\|i\| { + Ok(( + PaymentMetricsBucketIdentifier::new( + i.currency.as_ref().map(\|i\| i.0), + None, + i.connector.clone(), + i.authentication_type.as_ref().map(\|i\| i.0), + i.payment_method.clone(), + i.payment_method_type.clone(), + i.client_source.clone(), + i.client_version.clone(), + i.profile_id.clone(), + i.card_network.clone(), + i.merchant_id.clone(), + i.card_last_4.clone(), + i.card_issuer.clone(), + i.error_reason.clone(), + i.routing_approach.as_ref().map(\|i\| i.0), + TimeRange { + start_time: match (granularity, i.start_bucket) { + (Some(g), Some(st)) => g.clip_to_start(st)?, + _ => time_range.start_time, + }, + end_time: granularity.as_ref().map_or_else( + \|\| Ok(time_range.end_time), + \|g\| i.end_bucket.map(\|et\| g.clip_to_end(et)).transpose(), + )?, + }, + ), + i, + )) + }) + .collect::<error_stack::Result< + HashSet<(PaymentMetricsBucketIdentifier, PaymentMetricRow)>, + crate::query::PostProcessingError, + >>() + .change_context(MetricsError::PostProcessingFailure) + } +} diff --git a/crates/analytics/src/payments/metrics/sessionized_metrics.rs b/crates/analytics/src/payments/metrics/sessionized_metrics.rs index e3a5e370534..9d10c9db008 100644 --- a/crates/analytics/src/payments/metrics/sessionized_metrics.rs +++ b/crates/analytics/src/payments/metrics/sessionized_metrics.rs @@ -1,5 +1,6 @@ mod avg_ticket_size; mod connector_success_rate; +mod debit_routing; mod failure_reasons; mod payment_count; mod payment_processed_amount; @@ -9,6 +10,7 @@ mod retries_count; mod success_rate; pub(super) use avg_ticket_size::AvgTicketSize; pub(super) use connector_success_rate::ConnectorSuccessRate; +pub(super) use debit_routing::DebitRouting; pub(super) use failure_reasons::FailureReasons; pub(super) use payment_count::PaymentCount; pub(super) use payment_processed_amount::PaymentProcessedAmount; diff --git a/crates/analytics/src/payments/metrics/sessionized_metrics/debit_routing.rs b/crates/analytics/src/payments/metrics/sessionized_metrics/debit_routing.rs new file mode 100644 index 00000000000..f7c84e1b65c --- /dev/null +++ b/crates/analytics/src/payments/metrics/sessionized_metrics/debit_routing.rs @@ -0,0 +1,152 @@ +use std::collections::HashSet; + +use api_models::analytics::{ + payments::{PaymentDimensions, PaymentFilters, PaymentMetricsBucketIdentifier}, + Granularity, TimeRange, +}; +use common_utils::errors::ReportSwitchExt; +use diesel_models::enums as storage_enums; +use error_stack::ResultExt; +use time::PrimitiveDateTime; + +use super::PaymentMetricRow; +use crate::{ + enums::AuthInfo, + query::{Aggregate, GroupByClause, QueryBuilder, QueryFilter, SeriesBucket, ToSql, Window}, + types::{AnalyticsCollection, AnalyticsDataSource, MetricsError, MetricsResult}, +}; + +#[derive(Default)] +pub(crate) struct DebitRouting; + +#[async_trait::async_trait] +impl<T> super::PaymentMetric<T> for DebitRouting +where + T: AnalyticsDataSource + super::PaymentMetricAnalytics, + PrimitiveDateTime: ToSql<T>, + AnalyticsCollection: ToSql<T>, + Granularity: GroupByClause<T>, + Aggregate<&'static str>: ToSql<T>, + Window<&'static str>: ToSql<T>, +{ + async fn load_metrics( + &self, + dimensions: &[PaymentDimensions], + auth: &AuthInfo, + filters: &PaymentFilters, + granularity: Option<Granularity>, + time_range: &TimeRange, + pool: &T, + ) -> MetricsResult<HashSet<(PaymentMetricsBucketIdentifier, PaymentMetricRow)>> { + let mut query_builder: QueryBuilder<T> = + QueryBuilder::new(AnalyticsCollection::PaymentSessionized); + + for dim in dimensions.iter() { + query_builder.add_select_column(dim).switch()?; + } + query_builder + .add_select_column(Aggregate::Count { + field: None, + alias: Some("count"), + }) + .switch()?; + query_builder + .add_select_column(Aggregate::Sum { + field: "debit_routing_savings", + alias: Some("total"), + }) + .switch()?; + query_builder.add_select_column("currency").switch()?; + query_builder + .add_select_column(Aggregate::Min { + field: "created_at", + alias: Some("start_bucket"), + }) + .switch()?; + query_builder + .add_select_column(Aggregate::Max { + field: "created_at", + alias: Some("end_bucket"), + }) + .switch()?; + + filters.set_filter_clause(&mut query_builder).switch()?; + + auth.set_filter_clause(&mut query_builder).switch()?; + + time_range + .set_filter_clause(&mut query_builder) + .attach_printable("Error filtering time range") + .switch()?; + + for dim in dimensions.iter() { + query_builder + .add_group_by_clause(dim) + .attach_printable("Error grouping by dimensions") + .switch()?; + } + + query_builder + .add_group_by_clause("currency") + .attach_printable("Error grouping by currency") + .switch()?; + + if let Some(granularity) = granularity { + granularity + .set_group_by_clause(&mut query_builder) + .attach_printable("Error adding granularity") + .switch()?; + } + + query_builder + .add_filter_clause( + PaymentDimensions::PaymentStatus, + storage_enums::AttemptStatus::Charged, + ) + .switch()?; + + query_builder + .execute_query::<PaymentMetricRow, _>(pool) + .await + .change_context(MetricsError::QueryBuildingError)? + .change_context(MetricsError::QueryExecutionFailure)? + .into_iter() + .map(\|i\| { + Ok(( + PaymentMetricsBucketIdentifier::new( + i.currency.as_ref().map(\|i\| i.0), + None, + i.connector.clone(), + i.authentication_type.as_ref().map(\|i\| i.0), + i.payment_method.clone(), + i.payment_method_type.clone(), + i.client_source.clone(), + i.client_version.clone(), + i.profile_id.clone(), + i.card_network.clone(), + i.merchant_id.clone(), + i.card_last_4.clone(), + i.card_issuer.clone(), + i.error_reason.clone(), + i.routing_approach.as_ref().map(\|i\| i.0), + TimeRange { + start_time: match (granularity, i.start_bucket) { + (Some(g), Some(st)) => g.clip_to_start(st)?, + _ => time_range.start_time, + }, + end_time: granularity.as_ref().map_or_else( + \|\| Ok(time_range.end_time), + \|g\| i.end_bucket.map(\|et\| g.clip_to_end(et)).transpose(), + )?, + }, + ), + i, + )) + }) + .collect::<error_stack::Result< + HashSet<(PaymentMetricsBucketIdentifier, PaymentMetricRow)>, + crate::query::PostProcessingError, + >>() + .change_context(MetricsError::PostProcessingFailure) + } +} diff --git a/crates/api_models/src/analytics/payments.rs b/crates/api_models/src/analytics/payments.rs index 537d6df09d1..ec5719f1adb 100644 --- a/crates/api_models/src/analytics/payments.rs +++ b/crates/api_models/src/analytics/payments.rs @@ -111,6 +111,7 @@ pub enum PaymentMetrics { AvgTicketSize, RetriesCount, ConnectorSuccessRate, + DebitRouting, SessionizedPaymentSuccessRate, SessionizedPaymentCount, SessionizedPaymentSuccessCount, @@ -118,6 +119,7 @@ pub enum PaymentMetrics { SessionizedAvgTicketSize, SessionizedRetriesCount, SessionizedConnectorSuccessRate, + SessionizedDebitRouting, PaymentsDistribution, FailureReasons, } @@ -128,8 +130,10 @@ impl ForexMetric for PaymentMetrics { self, Self::PaymentProcessedAmount \| Self::AvgTicketSize + \| Self::DebitRouting \| Self::SessionizedPaymentProcessedAmount \| Self::SessionizedAvgTicketSize + \| Self::SessionizedDebitRouting, ) } } @@ -309,6 +313,9 @@ pub struct PaymentMetricsBucketValue { pub payments_failure_rate_distribution_with_only_retries: Option<f64>, pub failure_reason_count: Option<u64>, pub failure_reason_count_without_smart_retries: Option<u64>, + pub debit_routed_transaction_count: Option<u64>, + pub debit_routing_savings: Option<u64>, + pub debit_routing_savings_in_usd: Option<u64>, } #[derive(Debug, serde::Serialize)] diff --git a/crates/api_models/src/open_router.rs b/crates/api_models/src/open_router.rs index ba53f4c1f00..f5b80383bfb 100644 --- a/crates/api_models/src/open_router.rs +++ b/crates/api_models/src/open_router.rs @@ -67,7 +67,7 @@ pub struct DecidedGateway { #[derive(Debug, Serialize, Deserialize, PartialEq, Clone)] pub struct DebitRoutingOutput { - pub co_badged_card_networks_info: Vec<CoBadgedCardNetworksInfo>, + pub co_badged_card_networks_info: CoBadgedCardNetworks, pub issuer_country: common_enums::CountryAlpha2, pub is_regulated: bool, pub regulated_name: Option<common_enums::RegulatedName>, @@ -80,19 +80,19 @@ pub struct CoBadgedCardNetworksInfo { pub saving_percentage: f64, } -impl DebitRoutingOutput { - pub fn get_co_badged_card_networks(&self) -> Vec<common_enums::CardNetwork> { - self.co_badged_card_networks_info - .iter() - .map(\|data\| data.network.clone()) - .collect() +#[derive(Debug, Serialize, Deserialize, PartialEq, Clone)] +pub struct CoBadgedCardNetworks(pub Vec<CoBadgedCardNetworksInfo>); + +impl CoBadgedCardNetworks { + pub fn get_card_networks(&self) -> Vec<common_enums::CardNetwork> { + self.0.iter().map(\|info\| info.network.clone()).collect() } } impl From<&DebitRoutingOutput> for payment_methods::CoBadgedCardData { fn from(output: &DebitRoutingOutput) -> Self { Self { - co_badged_card_networks: output.get_co_badged_card_networks(), + co_badged_card_networks_info: output.co_badged_card_networks_info.clone(), issuer_country_code: output.issuer_country, is_regulated: output.is_regulated, regulated_name: output.regulated_name.clone(), @@ -111,7 +111,7 @@ impl TryFrom<(payment_methods::CoBadgedCardData, String)> for DebitRoutingReques })?; Ok(Self { - co_badged_card_networks_info: output.co_badged_card_networks, + co_badged_card_networks_info: output.co_badged_card_networks_info.get_card_networks(), issuer_country: output.issuer_country_code, is_regulated: output.is_regulated, regulated_name: output.regulated_name, diff --git a/crates/api_models/src/payment_methods.rs b/crates/api_models/src/payment_methods.rs index 6a8f61484dc..0745fade987 100644 --- a/crates/api_models/src/payment_methods.rs +++ b/crates/api_models/src/payment_methods.rs @@ -19,7 +19,7 @@ use utoipa::{schema, ToSchema}; #[cfg(feature = "payouts")] use crate::payouts; use crate::{ - admin, enums as api_enums, + admin, enums as api_enums, open_router, payments::{self, BankCodeResponse}, }; @@ -937,14 +937,14 @@ pub struct PaymentMethodResponse { pub network_token: Option<NetworkTokenResponse>, } -#[derive(Clone, Debug, Eq, PartialEq, serde::Deserialize, serde::Serialize)] +#[derive(Clone, Debug, PartialEq, serde::Deserialize, serde::Serialize)] pub enum PaymentMethodsData { Card(CardDetailsPaymentMethod), BankDetails(PaymentMethodDataBankCreds), WalletDetails(PaymentMethodDataWalletInfo), } -#[derive(Clone, Debug, Eq, PartialEq, serde::Deserialize, serde::Serialize)] +#[derive(Clone, Debug, PartialEq, serde::Deserialize, serde::Serialize)] pub struct CardDetailsPaymentMethod { pub last4_digits: Option<String>, pub issuer_country: Option<String>, @@ -958,12 +958,33 @@ pub struct CardDetailsPaymentMethod { pub card_type: Option<String>, #[serde(default = "saved_in_locker_default")] pub saved_to_locker: bool, - pub co_badged_card_data: Option<CoBadgedCardData>, + pub co_badged_card_data: Option<CoBadgedCardDataToBeSaved>, } -#[derive(Clone, Debug, Eq, PartialEq, serde::Deserialize, serde::Serialize)] +impl From<&CoBadgedCardData> for CoBadgedCardDataToBeSaved { + fn from(co_badged_card_data: &CoBadgedCardData) -> Self { + Self { + co_badged_card_networks: co_badged_card_data + .co_badged_card_networks_info + .get_card_networks(), + issuer_country_code: co_badged_card_data.issuer_country_code, + is_regulated: co_badged_card_data.is_regulated, + regulated_name: co_badged_card_data.regulated_name.clone(), + } + } +} + +#[derive(Clone, Debug, PartialEq, serde::Deserialize, serde::Serialize)] pub struct CoBadgedCardData { - pub co_badged_card_networks: Vec<api_enums::CardNetwork>, + pub co_badged_card_networks_info: open_router::CoBadgedCardNetworks, + pub issuer_country_code: common_enums::CountryAlpha2, + pub is_regulated: bool, + pub regulated_name: Option<common_enums::RegulatedName>, +} + +#[derive(Clone, Debug, PartialEq, serde::Deserialize, serde::Serialize)] +pub struct CoBadgedCardDataToBeSaved { + pub co_badged_card_networks: Vec<common_enums::CardNetwork>, pub issuer_country_code: common_enums::CountryAlpha2, pub is_regulated: bool, pub regulated_name: Option<common_enums::RegulatedName>, @@ -1325,7 +1346,7 @@ impl From<(CardDetailFromLocker, Option<&CoBadgedCardData>)> for CardDetailsPaym card_network: item.card_network, card_type: item.card_type, saved_to_locker: item.saved_to_locker, - co_badged_card_data: co_badged_card_data.cloned(), + co_badged_card_data: co_badged_card_data.map(CoBadgedCardDataToBeSaved::from), } } } diff --git a/crates/hyperswitch_domain_models/src/api.rs b/crates/hyperswitch_domain_models/src/api.rs index f6d93497627..723cc458e7b 100644 --- a/crates/hyperswitch_domain_models/src/api.rs +++ b/crates/hyperswitch_domain_models/src/api.rs @@ -7,7 +7,7 @@ use common_utils::{ use super::payment_method_data::PaymentMethodData; -#[derive(Debug, Eq, PartialEq)] +#[derive(Debug, PartialEq)] pub enum ApplicationResponse<R> { Json(R), StatusOk, @@ -54,7 +54,7 @@ impl<T: ApiEventMetric> ApiEventMetric for ApplicationResponse<T> { impl_api_event_type!(Miscellaneous, (PaymentLinkFormData, GenericLinkFormData)); -#[derive(Debug, Eq, PartialEq)] +#[derive(Debug, PartialEq)] pub struct RedirectionFormData { pub redirect_form: crate::router_response_types::RedirectForm, pub payment_method_data: Option<PaymentMethodData>, diff --git a/crates/hyperswitch_domain_models/src/payment_method_data.rs b/crates/hyperswitch_domain_models/src/payment_method_data.rs index 5433c486fbe..7a420010657 100644 --- a/crates/hyperswitch_domain_models/src/payment_method_data.rs +++ b/crates/hyperswitch_domain_models/src/payment_method_data.rs @@ -24,7 +24,7 @@ use time::Date; // We need to derive Serialize and Deserialize because some parts of payment method data are being // stored in the database as serde_json::Value -#[derive(Eq, PartialEq, Clone, Debug, Serialize, Deserialize)] +#[derive(PartialEq, Clone, Debug, Serialize, Deserialize)] pub enum PaymentMethodData { Card(Card), CardDetailsForNetworkTransactionId(CardDetailsForNetworkTransactionId), @@ -88,9 +88,21 @@ impl PaymentMethodData { None } } + + pub fn extract_debit_routing_saving_percentage( + &self, + network: &common_enums::CardNetwork, + ) -> Option<f64> { + self.get_co_badged_card_data()? + .co_badged_card_networks_info + .0 + .iter() + .find(\|info\| &info.network == network) + .map(\|info\| info.saving_percentage) + } } -#[derive(Eq, PartialEq, Clone, Debug, Serialize, Deserialize, Default)] +#[derive(PartialEq, Clone, Debug, Serialize, Deserialize, Default)] pub struct Card { pub card_number: cards::CardNumber, pub card_exp_month: Secret<String>, @@ -120,7 +132,7 @@ pub struct CardDetailsForNetworkTransactionId { pub card_holder_name: Option<Secret<String>>, } -#[derive(Eq, PartialEq, Clone, Debug, Serialize, Deserialize, Default)] +#[derive(PartialEq, Clone, Debug, Serialize, Deserialize, Default)] pub struct CardDetail { pub card_number: cards::CardNumber, pub card_exp_month: Secret<String>, @@ -1961,7 +1973,7 @@ impl From<GooglePayWalletData> for payment_methods::PaymentMethodDataWalletInfo } } -#[derive(Clone, Debug, Eq, PartialEq, serde::Deserialize, serde::Serialize)] +#[derive(Clone, Debug, PartialEq, serde::Deserialize, serde::Serialize)] pub enum PaymentMethodsData { Card(CardDetailsPaymentMethod), BankDetails(payment_methods::PaymentMethodDataBankCreds), //PaymentMethodDataBankCreds and its transformations should be moved to the domain models @@ -2005,7 +2017,7 @@ fn saved_in_locker_default() -> bool { } #[cfg(feature = "v1")] -#[derive(Clone, Debug, Eq, PartialEq, serde::Deserialize, serde::Serialize)] +#[derive(Clone, Debug, PartialEq, serde::Deserialize, serde::Serialize)] pub struct CardDetailsPaymentMethod { pub last4_digits: Option<String>, pub issuer_country: Option<String>, diff --git a/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs b/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs index 2b568b70af8..3baddfa98c5 100644 --- a/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs +++ b/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs @@ -9,14 +9,12 @@ use common_types::primitive_wrappers::{ }; #[cfg(feature = "v2")] use common_utils::{ - crypto::Encryptable, - encryption::Encryption, - ext_traits::{Encode, ValueExt}, + crypto::Encryptable, encryption::Encryption, ext_traits::Encode, types::keymanager::ToEncryptable, }; use common_utils::{ errors::{CustomResult, ValidationError}, - ext_traits::OptionExt, + ext_traits::{OptionExt, ValueExt}, id_type, pii, types::{ keymanager::{self, KeyManagerState}, @@ -906,6 +904,7 @@ pub struct PaymentAttempt { pub setup_future_usage_applied: Option<storage_enums::FutureUsage>, pub routing_approach: Option<storage_enums::RoutingApproach>, pub connector_request_reference_id: Option<String>, + pub debit_routing_savings: Option<MinorUnit>, } #[cfg(feature = "v1")] @@ -1063,6 +1062,10 @@ impl PaymentAttempt { pub fn get_total_surcharge_amount(&self) -> Option<MinorUnit> { self.amount_details.surcharge_amount } + + pub fn extract_card_network(&self) -> Option<common_enums::CardNetwork> { + todo!() + } } #[cfg(feature = "v1")] @@ -1074,6 +1077,25 @@ impl PaymentAttempt { pub fn get_total_surcharge_amount(&self) -> Option<MinorUnit> { self.net_amount.get_total_surcharge_amount() } + + pub fn set_debit_routing_savings(&mut self, debit_routing_savings: Option<&MinorUnit>) { + self.debit_routing_savings = debit_routing_savings.copied(); + } + + pub fn extract_card_network(&self) -> Option<common_enums::CardNetwork> { + self.payment_method_data + .as_ref() + .and_then(\|value\| { + value + .clone() + .parse_value::<api_models::payments::AdditionalPaymentData>( + "AdditionalPaymentData", + ) + .ok() + }) + .and_then(\|data\| data.get_additional_card_info()) + .and_then(\|card_info\| card_info.card_network) + } } #[derive(Clone, Debug, Eq, PartialEq)] @@ -1283,6 +1305,7 @@ pub enum PaymentAttemptUpdate { connector_mandate_detail: Option<ConnectorMandateReferenceId>, charges: Option<common_types::payments::ConnectorChargeResponseData>, setup_future_usage_applied: Option<storage_enums::FutureUsage>, + debit_routing_savings: Option<MinorUnit>, }, UnresolvedResponseUpdate { status: storage_enums::AttemptStatus, @@ -1566,6 +1589,7 @@ impl PaymentAttemptUpdate { connector_mandate_detail, charges, setup_future_usage_applied, + debit_routing_savings: _, } => DieselPaymentAttemptUpdate::ResponseUpdate { status, connector, @@ -1756,6 +1780,35 @@ impl PaymentAttemptUpdate { }, } } + + pub fn get_debit_routing_savings(&self) -> Option<&MinorUnit> { + match self { + Self::ResponseUpdate { + debit_routing_savings, + .. + } => debit_routing_savings.as_ref(), + Self::Update { .. } + \| Self::UpdateTrackers { .. } + \| Self::AuthenticationTypeUpdate { .. } + \| Self::ConfirmUpdate { .. } + \| Self::RejectUpdate { .. } + \| Self::BlocklistUpdate { .. } + \| Self::PaymentMethodDetailsUpdate { .. } + \| Self::ConnectorMandateDetailUpdate { .. } + \| Self::VoidUpdate { .. } + \| Self::UnresolvedResponseUpdate { .. } + \| Self::StatusUpdate { .. } + \| Self::ErrorUpdate { .. } + \| Self::CaptureUpdate { .. } + \| Self::AmountToCaptureUpdate { .. } + \| Self::PreprocessingUpdate { .. } + \| Self::ConnectorResponse { .. } + \| Self::IncrementalAuthorizationAmountUpdate { .. } + \| Self::AuthenticationUpdate { .. } + \| Self::ManualUpdate { .. } + \| Self::PostSessionTokensUpdate { .. } => None, + } + } } #[cfg(feature = "v2")] @@ -2033,6 +2086,7 @@ impl behaviour::Conversion for PaymentAttempt { setup_future_usage_applied: storage_model.setup_future_usage_applied, routing_approach: storage_model.routing_approach, connector_request_reference_id: storage_model.connector_request_reference_id, + debit_routing_savings: None, }) } .await diff --git a/crates/router/src/core/debit_routing.rs b/crates/router/src/core/debit_routing.rs index 4975ffc4bd1..d4f7c8bd753 100644 --- a/crates/router/src/core/debit_routing.rs +++ b/crates/router/src/core/debit_routing.rs @@ -281,7 +281,10 @@ where &profile_id, &key_store, vec![connector_data.clone()], - debit_routing_output.get_co_badged_card_networks(), + debit_routing_output + .co_badged_card_networks_info + .clone() + .get_card_networks(), ) .await .map_err(\|error\| { @@ -454,7 +457,10 @@ where &profile_id, &key_store, connector_data_list.clone(), - debit_routing_output.get_co_badged_card_networks(), + debit_routing_output + .co_badged_card_networks_info + .clone() + .get_card_networks(), ) .await .map_err(\|error\| { diff --git a/crates/router/src/core/payment_methods.rs b/crates/router/src/core/payment_methods.rs index 4b1cff09be2..e8e5b2040ed 100644 --- a/crates/router/src/core/payment_methods.rs +++ b/crates/router/src/core/payment_methods.rs @@ -865,12 +865,15 @@ fn get_card_network_with_us_local_debit_network_override( .map(\|network\| network.is_us_local_network()) { services::logger::debug!("Card network is a US local network, checking for global network in co-badged card data"); - co_badged_card_data.and_then(\|data\| { - data.co_badged_card_networks - .iter() - .find(\|network\| network.is_global_network()) - .cloned() - }) + let info: Option<api_models::open_router::CoBadgedCardNetworksInfo> = co_badged_card_data + .and_then(\|data\| { + data.co_badged_card_networks_info + .0 + .iter() + .find(\|info\| info.network.is_global_network()) + .cloned() + }); + info.map(\|data\| data.network) } else { card_network } diff --git a/crates/router/src/core/payment_methods/tokenize.rs b/crates/router/src/core/payment_methods/tokenize.rs index 3556673510c..f0eaea45d98 100644 --- a/crates/router/src/core/payment_methods/tokenize.rs +++ b/crates/router/src/core/payment_methods/tokenize.rs @@ -272,8 +272,12 @@ where card_network: card_details.card_network.clone(), card_type: card_details.card_type.clone(), saved_to_locker, - co_badged_card_data: card_details.co_badged_card_data.clone(), + co_badged_card_data: card_details + .co_badged_card_data + .as_ref() + .map(\|data\| data.into()), }); + create_encrypted_data(&self.state.into(), self.key_store, pm_data) .await .inspect_err(\|err\| logger::info!("Error encrypting payment method data: {:?}", err)) diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs index b12704aab1f..1d5e2a7b4af 100644 --- a/crates/router/src/core/payments.rs +++ b/crates/router/src/core/payments.rs @@ -471,7 +471,7 @@ where // To perform router related operation for PaymentResponse PaymentResponse: Operation<F, FData, Data = D>, - FData: Send + Sync + Clone, + FData: Send + Sync + Clone + router_types::Capturable, { let operation: BoxedOperation<'_, F, Req, D> = Box::new(operation); @@ -1844,7 +1844,7 @@ pub async fn payments_core<F, Res, Req, Op, FData, D>( ) -> RouterResponse<Res> where F: Send + Clone + Sync, - FData: Send + Sync + Clone, + FData: Send + Sync + Clone + router_types::Capturable, Op: Operation<F, Req, Data = D> + Send + Sync + Clone, Req: Debug + Authenticate + Clone, D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, diff --git a/crates/router/src/core/payments/helpers.rs b/crates/router/src/core/payments/helpers.rs index d855ca84e18..9065dcd2ce3 100644 --- a/crates/router/src/core/payments/helpers.rs +++ b/crates/router/src/core/payments/helpers.rs @@ -44,6 +44,7 @@ use hyperswitch_domain_models::{ use hyperswitch_interfaces::integrity::{CheckIntegrity, FlowIntegrity, GetIntegrityObject}; use josekit::jwe; use masking::{ExposeInterface, PeekInterface, SwitchStrategy}; +use num_traits::{FromPrimitive, ToPrimitive}; use openssl::{ derive::Deriver, pkey::PKey, @@ -52,6 +53,7 @@ use openssl::{ #[cfg(feature = "v2")] use redis_interface::errors::RedisError; use router_env::{instrument, logger, tracing}; +use rust_decimal::Decimal; use serde::{Deserialize, Serialize}; use uuid::Uuid; use x509_parser::parse_x509_certificate; @@ -5208,6 +5210,54 @@ pub fn get_applepay_metadata( }) } +pub fn calculate_debit_routing_savings(net_amount: i64, saving_percentage: f64) -> MinorUnit { + logger::debug!( + ?net_amount, + ?saving_percentage, + "Calculating debit routing saving amount" + ); + + let net_decimal = Decimal::from_i64(net_amount).unwrap_or_else(\|\| { + logger::warn!(?net_amount, "Invalid net_amount, using 0"); + Decimal::ZERO + }); + + let percentage_decimal = Decimal::from_f64(saving_percentage).unwrap_or_else(\|\| { + logger::warn!(?saving_percentage, "Invalid saving_percentage, using 0"); + Decimal::ZERO + }); + + let savings_decimal = net_decimal * percentage_decimal / Decimal::from(100); + let rounded_savings = savings_decimal.round(); + + let savings_int = rounded_savings.to_i64().unwrap_or_else(\|\| { + logger::warn!( + ?rounded_savings, + "Debit routing savings calculation overflowed when converting to i64" + ); + 0 + }); + + MinorUnit::new(savings_int) +} + +pub fn get_debit_routing_savings_amount( + payment_method_data: &domain::PaymentMethodData, + payment_attempt: &PaymentAttempt, +) -> Option<MinorUnit> { + let card_network = payment_attempt.extract_card_network()?; + + let saving_percentage = + payment_method_data.extract_debit_routing_saving_percentage(&card_network)?; + + let net_amount = payment_attempt.get_total_amount().get_amount_as_i64(); + + Some(calculate_debit_routing_savings( + net_amount, + saving_percentage, + )) +} + #[cfg(all(feature = "retry", feature = "v1"))] pub async fn get_apple_pay_retryable_connectors<F, D>( state: &SessionState, diff --git a/crates/router/src/core/payments/operations/payment_response.rs b/crates/router/src/core/payments/operations/payment_response.rs index 939679ef51f..e72555b2ede 100644 --- a/crates/router/src/core/payments/operations/payment_response.rs +++ b/crates/router/src/core/payments/operations/payment_response.rs @@ -1767,6 +1767,14 @@ async fn payment_response_update_tracker<F: Clone, T: types::Capturable>( let payment_method_id = payment_data.payment_attempt.payment_method_id.clone(); + let debit_routing_savings = + payment_data.payment_method_data.as_ref().and_then(\|data\| { + payments_helpers::get_debit_routing_savings_amount( + data, + &payment_data.payment_attempt, + ) + }); + utils::add_apple_pay_payment_status_metrics( router_data.status, router_data.apple_pay_flow.clone(), @@ -1857,6 +1865,7 @@ async fn payment_response_update_tracker<F: Clone, T: types::Capturable>( setup_future_usage_applied: payment_data .payment_attempt .setup_future_usage_applied, + debit_routing_savings, }), ), }; diff --git a/crates/router/src/core/payments/retry.rs b/crates/router/src/core/payments/retry.rs index 728396ef530..f7d8b3e888b 100644 --- a/crates/router/src/core/payments/retry.rs +++ b/crates/router/src/core/payments/retry.rs @@ -48,7 +48,7 @@ pub async fn do_gsm_actions<F, ApiRequest, FData, D>( ) -> RouterResult<types::RouterData<F, FData, types::PaymentsResponseData>> where F: Clone + Send + Sync, - FData: Send + Sync, + FData: Send + Sync + types::Capturable, payments::PaymentResponse: operations::Operation<F, FData>, D: payments::OperationSessionGetters<F> + payments::OperationSessionSetters<F> @@ -345,7 +345,7 @@ pub async fn do_retry<F, ApiRequest, FData, D>( ) -> RouterResult<types::RouterData<F, FData, types::PaymentsResponseData>> where F: Clone + Send + Sync, - FData: Send + Sync, + FData: Send + Sync + types::Capturable, payments::PaymentResponse: operations::Operation<F, FData>, D: payments::OperationSessionGetters<F> + payments::OperationSessionSetters<F> @@ -425,7 +425,7 @@ pub async fn modify_trackers<F, FData, D>( ) -> RouterResult<()> where F: Clone + Send, - FData: Send, + FData: Send + types::Capturable, D: payments::OperationSessionGetters<F> + payments::OperationSessionSetters<F> + Send + Sync, { let new_attempt_count = payment_data.get_payment_intent().attempt_count + 1; @@ -451,6 +451,13 @@ where .and_then(\|connector_response\| connector_response.additional_payment_method_data), )?; + let debit_routing_savings = payment_data.get_payment_method_data().and_then(\|data\| { + payments::helpers::get_debit_routing_savings_amount( + data, + payment_data.get_payment_attempt(), + ) + }); + match router_data.response { Ok(types::PaymentsResponseData::TransactionResponse { resource_id, @@ -506,6 +513,7 @@ where connector_mandate_detail: None, charges, setup_future_usage_applied: None, + debit_routing_savings, }; #[cfg(feature = "v1")] diff --git a/crates/router/src/core/routing/transformers.rs b/crates/router/src/core/routing/transformers.rs index 6560e6786c8..b13dee1bcb4 100644 --- a/crates/router/src/core/routing/transformers.rs +++ b/crates/router/src/core/routing/transformers.rs @@ -180,7 +180,7 @@ impl OpenRouterDecideGatewayRequestExt for OpenRouterDecideGatewayRequest { Self { payment_info: PaymentInfo { payment_id: attempt.payment_id.clone(), - amount: attempt.net_amount.get_order_amount(), + amount: attempt.net_amount.get_total_amount(), currency: attempt.currency.unwrap_or(storage_enums::Currency::USD), payment_type: "ORDER_PAYMENT".to_string(), card_isin: card_isin.map(\|value\| value.peek().clone()), diff --git a/crates/router/src/db/kafka_store.rs b/crates/router/src/db/kafka_store.rs index 7f24d2f5c99..68af56f2262 100644 --- a/crates/router/src/db/kafka_store.rs +++ b/crates/router/src/db/kafka_store.rs @@ -1520,11 +1520,18 @@ impl PaymentAttemptInterface for KafkaStore { payment_attempt: storage::PaymentAttemptUpdate, storage_scheme: MerchantStorageScheme, ) -> CustomResult<storage::PaymentAttempt, errors::StorageError> { - let attempt = self + let mut attempt = self .diesel_store - .update_payment_attempt_with_attempt_id(this.clone(), payment_attempt, storage_scheme) + .update_payment_attempt_with_attempt_id( + this.clone(), + payment_attempt.clone(), + storage_scheme, + ) .await?; + let debit_routing_savings = payment_attempt.get_debit_routing_savings(); + + attempt.set_debit_routing_savings(debit_routing_savings); if let Err(er) = self .kafka_producer .log_payment_attempt(&attempt, Some(this), self.tenant_id.clone()) diff --git a/crates/router/src/services/kafka/payment_attempt.rs b/crates/router/src/services/kafka/payment_attempt.rs index f51e5a12d29..e0dbc6ad213 100644 --- a/crates/router/src/services/kafka/payment_attempt.rs +++ b/crates/router/src/services/kafka/payment_attempt.rs @@ -70,6 +70,7 @@ pub struct KafkaPaymentAttempt<'a> { pub card_network: Option<String>, pub card_discovery: Option<String>, pub routing_approach: Option<storage_enums::RoutingApproach>, + pub debit_routing_savings: Option<MinorUnit>, } #[cfg(feature = "v1")] @@ -132,6 +133,7 @@ impl<'a> KafkaPaymentAttempt<'a> { .card_discovery .map(\|discovery\| discovery.to_string()), routing_approach: attempt.routing_approach, + debit_routing_savings: attempt.debit_routing_savings, } } } diff --git a/crates/router/src/services/kafka/payment_attempt_event.rs b/crates/router/src/services/kafka/payment_attempt_event.rs index e2a88e2c29d..a54ff3cc28a 100644 --- a/crates/router/src/services/kafka/payment_attempt_event.rs +++ b/crates/router/src/services/kafka/payment_attempt_event.rs @@ -71,6 +71,7 @@ pub struct KafkaPaymentAttemptEvent<'a> { pub card_network: Option<String>, pub card_discovery: Option<String>, pub routing_approach: Option<storage_enums::RoutingApproach>, + pub debit_routing_savings: Option<MinorUnit>, } #[cfg(feature = "v1")] @@ -133,6 +134,7 @@ impl<'a> KafkaPaymentAttemptEvent<'a> { .card_discovery .map(\|discovery\| discovery.to_string()), routing_approach: attempt.routing_approach, + debit_routing_savings: attempt.debit_routing_savings, } } } diff --git a/crates/storage_impl/src/mock_db/payment_attempt.rs b/crates/storage_impl/src/mock_db/payment_attempt.rs index 88ddc824b2f..ec27f9bed65 100644 --- a/crates/storage_impl/src/mock_db/payment_attempt.rs +++ b/crates/storage_impl/src/mock_db/payment_attempt.rs @@ -237,6 +237,7 @@ impl PaymentAttemptInterface for MockDb { setup_future_usage_applied: payment_attempt.setup_future_usage_applied, routing_approach: payment_attempt.routing_approach, connector_request_reference_id: payment_attempt.connector_request_reference_id, + debit_routing_savings: None, }; payment_attempts.push(payment_attempt.clone()); Ok(payment_attempt) diff --git a/crates/storage_impl/src/payments/payment_attempt.rs b/crates/storage_impl/src/payments/payment_attempt.rs index 2c69c0766ba..b3fccea353e 100644 --- a/crates/storage_impl/src/payments/payment_attempt.rs +++ b/crates/storage_impl/src/payments/payment_attempt.rs @@ -689,6 +689,7 @@ impl<T: DatabaseStore> PaymentAttemptInterface for KVRouterStore<T> { connector_request_reference_id: payment_attempt .connector_request_reference_id .clone(), + debit_routing_savings: None, }; let field = format!("pa_{}", created_attempt.attempt_id); @@ -1989,6 +1990,7 @@ impl DataModelExt for PaymentAttempt { setup_future_usage_applied: storage_model.setup_future_usage_applied, routing_approach: storage_model.routing_approach, connector_request_reference_id: storage_model.connector_request_reference_id, + debit_routing_savings: None, } } }	2025-07-02T07:21:14Z	<!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> This pull request introduces a new feature to track and analyze debit routing savings and integrates it across multiple components of the analytics system. It also refactors the handling of co-badged card networks to provide additional details, such as saving percentages. Below is a breakdown of the most important changes grouped by theme: ### Debit Routing Analytics Integration: * Added a new column `debit_routing_savings` to the `payment_attempt_queue`, `payment_attempts`, and `payment_attempt_mv` tables in ClickHouse for tracking debit routing savings. * Updated the `PaymentMetricsAccumulator` struct to include a new `DebitRoutingAccumulator`, which tracks transaction counts and savings amounts. Implemented the necessary methods for metric collection and aggregation. * Introduced a new `PaymentMetrics::DebitRouting` enum variant and its corresponding implementation to load metrics, process data, and convert savings to USD. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> -> Enable debit routing for a profile -> Configure adyen connector with local debit networks enabled -> Make some debit routing payments ``` { "amount": 1, "amount_to_capture": 1, "currency": "USD", "confirm": true, "capture_method": "automatic", "setup_future_usage": "on_session", "capture_on": "2022-09-10T10:11:12Z", "email": "[email protected]", "name": "John Doe", "phone": "999999999", "phone_country_code": "+1", "description": "Its my first payment request", "authentication_type": "no_three_ds", "customer_id": "cu_{{$timestamp}}", "return_url": "http://127.0.0.1:4040", "payment_method": "card", "payment_method_type": "debit", "payment_method_data": { "card": { "card_number": "4000 0330 0330 0335", "card_exp_month": "03", "card_exp_year": "2030", "card_holder_name": "joseph Doe", "card_cvc": "737" } }, "billing": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San", "state": "California", "zip": "94122", "country": "US", "first_name": "PiX", "last_name": "ss" }, "email": "[email protected]" }, "shipping": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "PiX" } }, "customer_acceptance": { "acceptance_type": "offline", "accepted_at": "1963-05-03T04:07:52.723Z", "online": { "ip_address": "in sit", "user_agent": "amet irure esse" } }, "browser_info": { "user_agent": "Mozilla\/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/70.0.3538.110 Safari\/537.36", "accept_header": "text\/html,application\/xhtml+xml,application\/xml;q=0.9,image\/webp,image\/apng,\/;q=0.8", "language": "nl-NL", "color_depth": 24, "screen_height": 723, "screen_width": 1536, "time_zone": 0, "java_enabled": true, "java_script_enabled": true, "ip_address": "125.0.0.1" }, "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "metadata": { "udf1": "value1", "new_customer": "true", "login_date": "2019-09-10T10:11:12Z" } } ``` ``` { "payment_id": "pay_xrXjk0rlKJG83LNngQ2B", "merchant_id": "merchant_1751293949", "status": "succeeded", "amount": 150000, "net_amount": 150000, "shipping_cost": null, "amount_capturable": 0, "amount_received": 150000, "connector": "adyen", "client_secret": "pay_xrXjk0rlKJG83LNngQ2B_secret_doz5GI9CEnlmcQoBpiNT", "created": "2025-06-30T15:09:44.649Z", "currency": "USD", "customer_id": "cu_1751296185", "customer": { "id": "cu_1751296185", "name": "John Doe", "email": "[email protected]", "phone": "999999999", "phone_country_code": "+1" }, "description": "Its my first payment request", "refunds": null, "disputes": null, "attempts": [ { "attempt_id": "pay_xrXjk0rlKJG83LNngQ2B_1", "status": "charged", "amount": 150000, "order_tax_amount": null, "currency": "USD", "connector": "adyen", "error_message": null, "payment_method": "card", "connector_transaction_id": "KGRXNH7KQZ9TPM75", "capture_method": "automatic", "authentication_type": "no_three_ds", "created_at": "2025-06-30T15:09:44.649Z", "modified_at": "2025-06-30T15:09:45.587Z", "cancellation_reason": null, "mandate_id": null, "error_code": null, "payment_token": null, "connector_metadata": null, "payment_experience": null, "payment_method_type": "debit", "reference_id": "pay_xrXjk0rlKJG83LNngQ2B_1", "unified_code": null, "unified_message": null, "client_source": null, "client_version": null } ], "mandate_id": null, "mandate_data": null, "setup_future_usage": "on_session", "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "card", "payment_method_data": { "card": { "last4": "0335", "card_type": null, "card_network": "Nyce", "card_issuer": null, "card_issuing_country": null, "card_isin": "400003", "card_extended_bin": null, "card_exp_month": "03", "card_exp_year": "2030", "card_holder_name": "joseph Doe", "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "PiX", "last_name": null }, "phone": null, "email": null }, "billing": { "address": { "city": "San", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "PiX", "last_name": "ss" }, "phone": null, "email": "[email protected]" }, "order_details": null, "email": "[email protected]", "name": "John Doe", "phone": "999999999", "return_url": "http://127.0.0.1:4040/", "authentication_type": "no_three_ds", "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "debit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": false, "connector_transaction_id": "KGRXNH7KQZ9TPM75", "frm_message": null, "metadata": { "udf1": "value1", "login_date": "2019-09-10T10:11:12Z", "new_customer": "true" }, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_xrXjk0rlKJG83LNngQ2B_1", "payment_link": null, "profile_id": "pro_0YmTwtjkst9iUDkg4R5D", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_d1x2St1F4pbgEFYNmxOV", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-06-30T15:24:44.649Z", "fingerprint": null, "browser_info": { "language": "nl-NL", "time_zone": 0, "ip_address": "125.0.0.1", "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "color_depth": 24, "java_enabled": true, "screen_width": 1536, "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8", "screen_height": 723, "java_script_enabled": true }, "payment_method_id": "pm_pRJ3v7spaJ1pfIsMlAqD", "payment_method_status": "active", "updated": "2025-06-30T15:09:45.566Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` -> Payment FIlters ``` curl --location 'http://localhost:8080/analytics/v1/org/filters/payments' \ --header 'Accept: /' \ --header 'Accept-Language: en-US,en;q=0.9' \ --header 'Connection: keep-alive' \ --header 'Content-Type: application/json' \ --header 'Origin: http://localhost:9000' \ --header 'Referer: http://localhost:9000/' \ --header 'Sec-Fetch-Dest: empty' \ --header 'Sec-Fetch-Mode: cors' \ --header 'Sec-Fetch-Site: same-site' \ --header 'User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/128.0.0.0 Safari/537.36' \ --header 'api-key: hyperswitch' \ --header 'authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiZTAxZDlhMzgtMDdlMi00ZmFiLTg3ZmYtZWU0NmE2YTU2MDlhIiwibWVyY2hhbnRfaWQiOiJtZXJjaGFudF8xNzUxMjkzOTQ5Iiwicm9sZV9pZCI6Im9yZ19hZG1pbiIsImV4cCI6MTc1MTQ2Njc1MSwib3JnX2lkIjoib3JnX2tOa2k3aXBKS1h4NFc3bGVJU3FQIiwicHJvZmlsZV9pZCI6InByb18wWW1Ud3Rqa3N0OWlVRGtnNFI1RCIsInRlbmFudF9pZCI6InB1YmxpYyJ9.jty5ccBH_Em-odSAlde-FQLMC34aoGdV_UYsJFoUN-w' \ --header 'sec-ch-ua: "Chromium";v="128", "Not;A=Brand";v="24", "Google Chrome";v="128"' \ --header 'sec-ch-ua-mobile: ?0' \ --header 'sec-ch-ua-platform: "macOS"' \ --data '{ "timeRange": { "startTime": "2024-09-03T18:30:00.000Z", "endTime": "2025-09-12T09:22:30.000Z" }, "groupByNames": [ "connector", "payment_method", "payment_method_type", "currency", "authentication_type", "status", "client_source", "client_version", "profile_id", "routing_approach" ], "source": "BATCH", "delta": true }' ``` ``` { "queryData": [ { "dimension": "connector", "values": [ "adyen" ] }, { "dimension": "payment_method", "values": [ "card" ] }, { "dimension": "payment_method_type", "values": [ "debit" ] }, { "dimension": "currency", "values": [ "USD" ] }, { "dimension": "authentication_type", "values": [ "no_three_ds" ] }, { "dimension": "status", "values": [ "charged" ] }, { "dimension": "client_source", "values": [] }, { "dimension": "client_version", "values": [] }, { "dimension": "profile_id", "values": [ "pro_0YmTwtjkst9iUDkg4R5D" ] }, { "dimension": "routing_approach", "values": [ "default_fallback", "debit_routing" ] } ] } ``` -> Payment metric that gives total debit routed txn and savings ``` curl --location 'http://localhost:8080/analytics/v1/org/metrics/payments' \ --header 'Accept: /' \ --header 'Accept-Language: en-US,en;q=0.9' \ --header 'Connection: keep-alive' \ --header 'Content-Type: application/json' \ --header 'Origin: http://localhost:9000' \ --header 'Referer: http://localhost:9000/' \ --header 'Sec-Fetch-Dest: empty' \ --header 'Sec-Fetch-Mode: cors' \ --header 'Sec-Fetch-Site: same-site' \ --header 'User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/128.0.0.0 Safari/537.36' \ --header 'sec-ch-ua: "Chromium";v="128", "Not;A=Brand";v="24", "Google Chrome";v="128"' \ --header 'sec-ch-ua-mobile: ?0' \ --header 'sec-ch-ua-platform: "macOS"' \ --header 'api-key: dev_cW7LmHwdGurYUqCHLMkUX8AfU9uYzKJc6sT0bsAB1wQJFe6lOP01lRO30Dj0WpcH' \ --header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiZTAxZDlhMzgtMDdlMi00ZmFiLTg3ZmYtZWU0NmE2YTU2MDlhIiwibWVyY2hhbnRfaWQiOiJtZXJjaGFudF8xNzUxMjkzOTQ5Iiwicm9sZV9pZCI6Im9yZ19hZG1pbiIsImV4cCI6MTc1MTQ2Njc1MSwib3JnX2lkIjoib3JnX2tOa2k3aXBKS1h4NFc3bGVJU3FQIiwicHJvZmlsZV9pZCI6InByb18wWW1Ud3Rqa3N0OWlVRGtnNFI1RCIsInRlbmFudF9pZCI6InB1YmxpYyJ9.jty5ccBH_Em-odSAlde-FQLMC34aoGdV_UYsJFoUN-w' \ --data '[ { "timeRange": { "startTime": "2025-03-01T18:30:00Z", "endTime": "2025-07-31T09:22:00Z" }, "filters": { "routing_approach": [ "debit_routing" ] }, "source": "BATCH", "metrics": [ "debit_routing" ], "timeSeries": { "granularity": "G_ONEDAY" }, "delta": true } ]' ``` ``` { "queryData": [ { "payment_success_rate": null, "payment_count": null, "payment_success_count": null, "payment_processed_amount": 0, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "debit_routed_transaction_count": 8, "debit_routing_savings": 369, "debit_routing_savings_in_usd": null, "currency": "USD", "status": null, "connector": null, "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": null, "time_range": { "start_time": "2025-06-30T00:00:00.000Z", "end_time": "2025-06-30T23:00:00.000Z" }, "time_bucket": "2025-06-30 00:00:00" } ], "metaData": [ { "total_payment_processed_amount": 0, "total_payment_processed_amount_in_usd": null, "total_payment_processed_amount_without_smart_retries": 0, "total_payment_processed_amount_without_smart_retries_usd": null, "total_payment_processed_count": 0, "total_payment_processed_count_without_smart_retries": 0, "total_failure_reasons_count": 0, "total_failure_reasons_count_without_smart_retries": 0 } ] } ``` -> Payment metrics that gives savings per txn ``` curl --location 'http://localhost:8080/analytics/v1/org/metrics/payments' \ --header 'Accept: /' \ --header 'Accept-Language: en-US,en;q=0.9' \ --header 'Connection: keep-alive' \ --header 'Content-Type: application/json' \ --header 'Origin: http://localhost:9000' \ --header 'Referer: http://localhost:9000/' \ --header 'Sec-Fetch-Dest: empty' \ --header 'Sec-Fetch-Mode: cors' \ --header 'Sec-Fetch-Site: same-site' \ --header 'User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/128.0.0.0 Safari/537.36' \ --header 'sec-ch-ua: "Chromium";v="128", "Not;A=Brand";v="24", "Google Chrome";v="128"' \ --header 'sec-ch-ua-mobile: ?0' \ --header 'sec-ch-ua-platform: "macOS"' \ --header 'api-key: dev_cW7LmHwdGurYUqCHLMkUX8AfU9uYzKJc6sT0bsAB1wQJFe6lOP01lRO30Dj0WpcH' \ --header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiZTAxZDlhMzgtMDdlMi00ZmFiLTg3ZmYtZWU0NmE2YTU2MDlhIiwibWVyY2hhbnRfaWQiOiJtZXJjaGFudF8xNzUxMjkzOTQ5Iiwicm9sZV9pZCI6Im9yZ19hZG1pbiIsImV4cCI6MTc1MTQ2Njc1MSwib3JnX2lkIjoib3JnX2tOa2k3aXBKS1h4NFc3bGVJU3FQIiwicHJvZmlsZV9pZCI6InByb18wWW1Ud3Rqa3N0OWlVRGtnNFI1RCIsInRlbmFudF9pZCI6InB1YmxpYyJ9.jty5ccBH_Em-odSAlde-FQLMC34aoGdV_UYsJFoUN-w' \ --data '[ { "timeRange": { "startTime": "2025-03-01T18:30:00Z", "endTime": "2025-07-31T09:22:00Z" }, "groupByNames": [ "card_network" ], "filters": { "routing_approach": [ "debit_routing" ] }, "source": "BATCH", "metrics": [ "debit_routing" ], "timeSeries": { "granularity": "G_ONEDAY" }, "delta": true } ]' ``` ``` { "queryData": [ { "payment_success_rate": null, "payment_count": null, "payment_success_count": null, "payment_processed_amount": 0, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "debit_routed_transaction_count": 2, "debit_routing_savings": 107, "debit_routing_savings_in_usd": null, "currency": "USD", "status": null, "connector": null, "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": "Star", "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": null, "time_range": { "start_time": "2025-06-30T00:00:00.000Z", "end_time": "2025-06-30T23:00:00.000Z" }, "time_bucket": "2025-06-30 00:00:00" }, { "payment_success_rate": null, "payment_count": null, "payment_success_count": null, "payment_processed_amount": 0, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "debit_routed_transaction_count": 2, "debit_routing_savings": 199, "debit_routing_savings_in_usd": null, "currency": "USD", "status": null, "connector": null, "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": "Nyce", "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": null, "time_range": { "start_time": "2025-06-30T00:00:00.000Z", "end_time": "2025-06-30T23:00:00.000Z" }, "time_bucket": "2025-06-30 00:00:00" }, { "payment_success_rate": null, "payment_count": null, "payment_success_count": null, "payment_processed_amount": 0, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "debit_routed_transaction_count": 3, "debit_routing_savings": 0, "debit_routing_savings_in_usd": null, "currency": "USD", "status": null, "connector": null, "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": "Visa", "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": null, "time_range": { "start_time": "2025-06-30T00:00:00.000Z", "end_time": "2025-06-30T23:00:00.000Z" }, "time_bucket": "2025-06-30 00:00:00" }, { "payment_success_rate": null, "payment_count": null, "payment_success_count": null, "payment_processed_amount": 0, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "debit_routed_transaction_count": 1, "debit_routing_savings": 63, "debit_routing_savings_in_usd": null, "currency": "USD", "status": null, "connector": null, "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": "Accel", "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": null, "time_range": { "start_time": "2025-06-30T00:00:00.000Z", "end_time": "2025-06-30T23:00:00.000Z" }, "time_bucket": "2025-06-30 00:00:00" } ], "metaData": [ { "total_payment_processed_amount": 0, "total_payment_processed_amount_in_usd": null, "total_payment_processed_amount_without_smart_retries": 0, "total_payment_processed_amount_without_smart_retries_usd": null, "total_payment_processed_count": 0, "total_payment_processed_count_without_smart_retries": 0, "total_failure_reasons_count": 0, "total_failure_reasons_count_without_smart_retries": 0 } ] } ``` ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	6678ee351748e5629a22e84677d58297cbac62a5	6678ee351748e5629a22e84677d58297cbac62a5
juspay/hyperswitch	juspay__hyperswitch-8507	Bug: [FEATURE] populate connector raw response and connector_response_reference_id in v2 populate connector raw response and connector_response_reference_id	diff --git a/api-reference/v2/openapi_spec_v2.json b/api-reference/v2/openapi_spec_v2.json index 8da8f56f709..76a35e926e2 100644 --- a/api-reference/v2/openapi_spec_v2.json +++ b/api-reference/v2/openapi_spec_v2.json @@ -17881,41 +17881,6 @@ "propertyName": "payment_processing_details_at" } }, - "PaymentRetrieveBody": { - "type": "object", - "properties": { - "merchant_id": { - "type": "string", - "description": "The identifier for the Merchant Account.", - "nullable": true - }, - "force_sync": { - "type": "boolean", - "description": "Decider to enable or disable the connector call for retrieve request", - "nullable": true - }, - "client_secret": { - "type": "string", - "description": "This is a token which expires after 15 minutes, used from the client to authenticate and create sessions from the SDK", - "nullable": true - }, - "expand_captures": { - "type": "boolean", - "description": "If enabled provides list of captures linked to latest attempt", - "nullable": true - }, - "expand_attempts": { - "type": "boolean", - "description": "If enabled provides list of attempts linked to payment intent", - "nullable": true - }, - "all_keys_required": { - "type": "boolean", - "description": "If enabled, provides whole connector response", - "nullable": true - } - } - }, "PaymentRevenueRecoveryMetadata": { "type": "object", "required": [ @@ -18128,6 +18093,11 @@ } ], "nullable": true + }, + "return_raw_connector_response": { + "type": "boolean", + "description": "If true, returns stringified connector raw response body", + "nullable": true } }, "additionalProperties": false @@ -19127,6 +19097,11 @@ } ], "nullable": true + }, + "return_raw_connector_response": { + "type": "boolean", + "description": "Stringified connector raw response body. Only returned if `return_raw_connector_response` is true", + "nullable": true } }, "additionalProperties": false @@ -19311,6 +19286,11 @@ "nullable": true, "maxLength": 30, "minLength": 30 + }, + "raw_connector_response": { + "type": "string", + "description": "Stringified connector raw response body. Only returned if `return_raw_connector_response` is true", + "nullable": true } } }, @@ -19331,9 +19311,9 @@ "description": "These are the query params that are sent in case of redirect response.\nThese can be ingested by the connector to take necessary actions.", "nullable": true }, - "all_keys_required": { + "return_raw_connector_response": { "type": "boolean", - "description": "If enabled, provides whole connector response", + "description": "If true, returns stringified connector raw response body", "nullable": true }, "merchant_connector_details": { @@ -19394,9 +19374,9 @@ "description": "These are the query params that are sent in case of redirect response.\nThese can be ingested by the connector to take necessary actions.", "nullable": true }, - "all_keys_required": { + "return_raw_connector_response": { "type": "boolean", - "description": "If enabled, provides whole connector response", + "description": "If true, returns stringified connector raw response body", "nullable": true } } diff --git a/crates/api_models/src/payments.rs b/crates/api_models/src/payments.rs index 2ff07472a0d..9150697aa19 100644 --- a/crates/api_models/src/payments.rs +++ b/crates/api_models/src/payments.rs @@ -5347,6 +5347,9 @@ pub struct PaymentsConfirmIntentRequest { /// Merchant connector details used to make payments. #[schema(value_type = Option<MerchantConnectorAuthDetails>)] pub merchant_connector_details: Option<common_types::domain::MerchantConnectorAuthDetails>, + + /// If true, returns stringified connector raw response body + pub return_raw_connector_response: Option<bool>, } #[cfg(feature = "v2")] @@ -5523,6 +5526,9 @@ pub struct PaymentsRequest { /// Merchant connector details used to make payments. #[schema(value_type = Option<MerchantConnectorAuthDetails>)] pub merchant_connector_details: Option<common_types::domain::MerchantConnectorAuthDetails>, + + /// Stringified connector raw response body. Only returned if `return_raw_connector_response` is true + pub return_raw_connector_response: Option<bool>, } #[cfg(feature = "v2")] @@ -5575,6 +5581,7 @@ impl From<&PaymentsRequest> for PaymentsConfirmIntentRequest { payment_method_id: request.payment_method_id.clone(), payment_token: None, merchant_connector_details: request.merchant_connector_details.clone(), + return_raw_connector_response: request.return_raw_connector_response, } } } @@ -5597,8 +5604,8 @@ pub struct PaymentsRetrieveRequest { /// These are the query params that are sent in case of redirect response. /// These can be ingested by the connector to take necessary actions. pub param: Option<String>, - /// If enabled, provides whole connector response - pub all_keys_required: Option<bool>, + /// If true, returns stringified connector raw response body + pub return_raw_connector_response: Option<bool>, /// Merchant connector details used to make payments. #[schema(value_type = Option<MerchantConnectorAuthDetails>)] pub merchant_connector_details: Option<common_types::domain::MerchantConnectorAuthDetails>, @@ -5619,8 +5626,8 @@ pub struct PaymentsStatusRequest { /// These are the query params that are sent in case of redirect response. /// These can be ingested by the connector to take necessary actions. pub param: Option<String>, - /// If enabled, provides whole connector response - pub all_keys_required: Option<bool>, + /// If true, returns stringified connector raw response body + pub return_raw_connector_response: Option<bool>, } /// Error details for the payment @@ -5776,6 +5783,9 @@ pub struct PaymentsResponse { example = "pay_mbabizu24mvu3mela5njyhpit4" )] pub merchant_reference_id: Option<id_type::PaymentReferenceId>, + + /// Stringified connector raw response body. Only returned if `return_raw_connector_response` is true + pub raw_connector_response: Option<String>, } #[cfg(feature = "v2")] @@ -7496,6 +7506,7 @@ pub struct PaymentsSessionResponse { pub vault_details: Option<VaultSessionDetails>, } +#[cfg(feature = "v1")] #[derive(Default, Debug, serde::Deserialize, serde::Serialize, Clone, ToSchema)] pub struct PaymentRetrieveBody { /// The identifier for the Merchant Account. @@ -7513,6 +7524,7 @@ pub struct PaymentRetrieveBody { pub all_keys_required: Option<bool>, } +#[cfg(feature = "v1")] #[derive(Default, Debug, serde::Deserialize, serde::Serialize, Clone, ToSchema)] pub struct PaymentRetrieveBodyWithCredentials { /// The identifier for payment. diff --git a/crates/common_types/src/domain.rs b/crates/common_types/src/domain.rs index f41f874cd06..66ffa6029d0 100644 --- a/crates/common_types/src/domain.rs +++ b/crates/common_types/src/domain.rs @@ -106,3 +106,11 @@ pub struct MerchantConnectorAuthDetails { }"#)] pub merchant_connector_creds: common_utils::pii::SecretSerdeValue, } + +/// Connector Response Data that are required to be populated in response +#[cfg(feature = "v2")] +#[derive(Clone, Debug)] +pub struct ConnectorResponseData { + /// Stringified connector raw response body + pub raw_connector_response: Option<String>, +} diff --git a/crates/diesel_models/src/payment_attempt.rs b/crates/diesel_models/src/payment_attempt.rs index eeda9e78877..95bb5a875d1 100644 --- a/crates/diesel_models/src/payment_attempt.rs +++ b/crates/diesel_models/src/payment_attempt.rs @@ -852,7 +852,7 @@ pub struct PaymentAttemptUpdateInternal { // payment_experience: Option<storage_enums::PaymentExperience>, // preprocessing_step_id: Option<String>, pub error_reason: Option<String>, - // connector_response_reference_id: Option<String>, + pub connector_response_reference_id: Option<String>, // multiple_capture_count: Option<i16>, // pub surcharge_amount: Option<MinorUnit>, // tax_on_surcharge: Option<MinorUnit>, @@ -910,6 +910,7 @@ impl PaymentAttemptUpdateInternal { network_error_message, payment_method_id, connector_request_reference_id, + connector_response_reference_id, } = self; PaymentAttempt { @@ -939,7 +940,8 @@ impl PaymentAttemptUpdateInternal { preprocessing_step_id: source.preprocessing_step_id, error_reason: error_reason.or(source.error_reason), multiple_capture_count: source.multiple_capture_count, - connector_response_reference_id: source.connector_response_reference_id, + connector_response_reference_id: connector_response_reference_id + .or(source.connector_response_reference_id), amount_capturable: amount_capturable.unwrap_or(source.amount_capturable), updated_by, merchant_connector_id: merchant_connector_id.or(source.merchant_connector_id), diff --git a/crates/hyperswitch_connectors/src/connectors/razorpay.rs b/crates/hyperswitch_connectors/src/connectors/razorpay.rs index 39b83c73e43..33cdc326987 100644 --- a/crates/hyperswitch_connectors/src/connectors/razorpay.rs +++ b/crates/hyperswitch_connectors/src/connectors/razorpay.rs @@ -316,7 +316,7 @@ impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData connectors: &Connectors, ) -> CustomResult<String, errors::ConnectorError> { Ok(format!( - "{}v1/payments/create/json", + "{}v1/payments/create/upi", self.base_url(connectors) )) } @@ -404,15 +404,15 @@ impl ConnectorIntegration<PSync, PaymentsSyncData, PaymentsResponseData> for Raz req: &PaymentsSyncRouterData, connectors: &Connectors, ) -> CustomResult<String, errors::ConnectorError> { - let connector_payment_id = req + let order_id = req .request - .connector_transaction_id - .get_connector_transaction_id() - .change_context(errors::ConnectorError::MissingConnectorTransactionID)?; + .connector_reference_id + .clone() + .ok_or(errors::ConnectorError::RequestEncodingFailed)?; Ok(format!( - "{}v1/payments/{}", + "{}v1/orders/{}/payments", self.base_url(connectors), - connector_payment_id, + order_id, )) } @@ -512,21 +512,11 @@ impl ConnectorIntegration<Capture, PaymentsCaptureData, PaymentsResponseData> fo fn handle_response( &self, - data: &PaymentsCaptureRouterData, - event_builder: Option<&mut ConnectorEvent>, - res: Response, + _data: &PaymentsCaptureRouterData, + _event_builder: Option<&mut ConnectorEvent>, + _res: Response, ) -> CustomResult<PaymentsCaptureRouterData, errors::ConnectorError> { - let response: razorpay::RazorpayPaymentsResponse = res - .response - .parse_struct("Razorpay PaymentsCaptureResponse") - .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; - event_builder.map(\|i\| i.set_response_body(&response)); - router_env::logger::info!(connector_response=?response); - RouterData::try_from(ResponseRouterData { - response, - data: data.clone(), - http_code: res.status_code, - }) + Err(errors::ConnectorError::NotImplemented("get_request_body method".to_string()).into()) } fn get_error_response( diff --git a/crates/hyperswitch_connectors/src/connectors/razorpay/transformers.rs b/crates/hyperswitch_connectors/src/connectors/razorpay/transformers.rs index 23aa8828291..0176ae47854 100644 --- a/crates/hyperswitch_connectors/src/connectors/razorpay/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/razorpay/transformers.rs @@ -11,7 +11,7 @@ use hyperswitch_domain_models::{ payment_method_data::{PaymentMethodData, UpiData}, router_data::{ConnectorAuthType, RouterData}, router_flow_types::refunds::{Execute, RSync}, - router_request_types::ResponseId, + router_request_types::{PaymentsAuthorizeData, ResponseId}, router_response_types::{PaymentsResponseData, RefundsResponseData}, types, }; @@ -227,18 +227,29 @@ pub struct NextAction { #[derive(Debug, Clone, Serialize, Deserialize)] pub struct RazorpayPaymentsResponse { pub razorpay_payment_id: String, - pub next: Option<Vec<NextAction>>, } -impl<F, T> TryFrom<ResponseRouterData<F, RazorpayPaymentsResponse, T, PaymentsResponseData>> - for RouterData<F, T, PaymentsResponseData> +impl<F> + TryFrom< + ResponseRouterData< + F, + RazorpayPaymentsResponse, + PaymentsAuthorizeData, + PaymentsResponseData, + >, + > for RouterData<F, PaymentsAuthorizeData, PaymentsResponseData> { type Error = error_stack::Report<errors::ConnectorError>; fn try_from( - item: ResponseRouterData<F, RazorpayPaymentsResponse, T, PaymentsResponseData>, + item: ResponseRouterData< + F, + RazorpayPaymentsResponse, + PaymentsAuthorizeData, + PaymentsResponseData, + >, ) -> Result<Self, Self::Error> { let connector_metadata = get_wait_screen_metadata()?; - + let order_id = item.data.request.get_order_id()?; Ok(Self { status: enums::AttemptStatus::AuthenticationPending, response: Ok(PaymentsResponseData::TransactionResponse { @@ -249,7 +260,7 @@ impl<F, T> TryFrom<ResponseRouterData<F, RazorpayPaymentsResponse, T, PaymentsRe mandate_reference: Box::new(None), connector_metadata, network_txn_id: None, - connector_response_reference_id: Some(item.response.razorpay_payment_id), + connector_response_reference_id: Some(order_id), incremental_authorization_allowed: None, charges: None, }), @@ -281,6 +292,12 @@ pub fn get_wait_screen_metadata() -> CustomResult<Option<serde_json::Value>, err #[derive(Debug, Clone, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct RazorpaySyncResponse { + items: Vec<RazorpaySyncItem>, +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct RazorpaySyncItem { id: String, status: RazorpayStatus, } @@ -311,8 +328,15 @@ impl<F, T> TryFrom<ResponseRouterData<F, RazorpaySyncResponse, T, PaymentsRespon fn try_from( item: ResponseRouterData<F, RazorpaySyncResponse, T, PaymentsResponseData>, ) -> Result<Self, Self::Error> { + let status = match item.response.items.last() { + Some(last_item) => { + let razorpay_status = last_item.status; + get_psync_razorpay_payment_status(razorpay_status) + } + None => item.data.status, + }; Ok(Self { - status: get_psync_razorpay_payment_status(item.response.status), + status, response: Ok(PaymentsResponseData::TransactionResponse { resource_id: ResponseId::NoResponseId, redirection_data: Box::new(None), diff --git a/crates/hyperswitch_connectors/src/utils.rs b/crates/hyperswitch_connectors/src/utils.rs index b346b40d970..1353d068190 100644 --- a/crates/hyperswitch_connectors/src/utils.rs +++ b/crates/hyperswitch_connectors/src/utils.rs @@ -6209,7 +6209,7 @@ pub(crate) fn convert_payment_authorize_router_response<F1, F2, T1, T2>( connector_mandate_request_reference_id: data.connector_mandate_request_reference_id.clone(), authentication_id: data.authentication_id.clone(), psd2_sca_exemption_type: data.psd2_sca_exemption_type, - whole_connector_response: data.whole_connector_response.clone(), + raw_connector_response: data.raw_connector_response.clone(), } } diff --git a/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs b/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs index d644c519ea9..9078f1d49df 100644 --- a/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs +++ b/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs @@ -1763,6 +1763,7 @@ pub struct ConfirmIntentResponseUpdate { pub connector_metadata: Option<pii::SecretSerdeValue>, pub amount_capturable: Option<MinorUnit>, pub connector_token_details: Option<diesel_models::ConnectorTokenDetails>, + pub connector_response_reference_id: Option<String>, } #[cfg(feature = "v2")] @@ -1776,6 +1777,7 @@ pub enum PaymentAttemptUpdate { merchant_connector_id: Option<id_type::MerchantConnectorAccountId>, authentication_type: storage_enums::AuthenticationType, connector_request_reference_id: Option<String>, + connector_response_reference_id: Option<String>, }, /// Update the payment attempt on confirming the intent, before calling the connector, when payment_method_id is present ConfirmIntentTokenized { @@ -2569,6 +2571,7 @@ impl From<PaymentAttemptUpdate> for diesel_models::PaymentAttemptUpdateInternal merchant_connector_id, authentication_type, connector_request_reference_id, + connector_response_reference_id, } => Self { status: Some(status), payment_method_id: None, @@ -2594,6 +2597,7 @@ impl From<PaymentAttemptUpdate> for diesel_models::PaymentAttemptUpdateInternal network_decline_code: None, network_error_message: None, connector_request_reference_id, + connector_response_reference_id, }, PaymentAttemptUpdate::ErrorUpdate { status, @@ -2626,6 +2630,7 @@ impl From<PaymentAttemptUpdate> for diesel_models::PaymentAttemptUpdateInternal network_decline_code: error.network_decline_code, network_error_message: error.network_error_message, connector_request_reference_id: None, + connector_response_reference_id: None, }, PaymentAttemptUpdate::ConfirmIntentResponse(confirm_intent_response_update) => { let ConfirmIntentResponseUpdate { @@ -2636,6 +2641,7 @@ impl From<PaymentAttemptUpdate> for diesel_models::PaymentAttemptUpdateInternal connector_metadata, amount_capturable, connector_token_details, + connector_response_reference_id, } = *confirm_intent_response_update; Self { status: Some(status), @@ -2663,6 +2669,7 @@ impl From<PaymentAttemptUpdate> for diesel_models::PaymentAttemptUpdateInternal network_decline_code: None, network_error_message: None, connector_request_reference_id: None, + connector_response_reference_id, } } PaymentAttemptUpdate::SyncUpdate { @@ -2694,6 +2701,7 @@ impl From<PaymentAttemptUpdate> for diesel_models::PaymentAttemptUpdateInternal network_decline_code: None, network_error_message: None, connector_request_reference_id: None, + connector_response_reference_id: None, }, PaymentAttemptUpdate::CaptureUpdate { status, @@ -2724,6 +2732,7 @@ impl From<PaymentAttemptUpdate> for diesel_models::PaymentAttemptUpdateInternal network_decline_code: None, network_error_message: None, connector_request_reference_id: None, + connector_response_reference_id: None, }, PaymentAttemptUpdate::PreCaptureUpdate { amount_to_capture, @@ -2753,6 +2762,7 @@ impl From<PaymentAttemptUpdate> for diesel_models::PaymentAttemptUpdateInternal network_decline_code: None, network_error_message: None, connector_request_reference_id: None, + connector_response_reference_id: None, }, PaymentAttemptUpdate::ConfirmIntentTokenized { status, @@ -2786,6 +2796,7 @@ impl From<PaymentAttemptUpdate> for diesel_models::PaymentAttemptUpdateInternal network_decline_code: None, network_error_message: None, connector_request_reference_id: None, + connector_response_reference_id: None, }, } } diff --git a/crates/hyperswitch_domain_models/src/router_data.rs b/crates/hyperswitch_domain_models/src/router_data.rs index dd1004c7018..851ac69a81c 100644 --- a/crates/hyperswitch_domain_models/src/router_data.rs +++ b/crates/hyperswitch_domain_models/src/router_data.rs @@ -103,8 +103,8 @@ pub struct RouterData<Flow, Request, Response> { /// Contains the type of sca exemption required for the transaction pub psd2_sca_exemption_type: Option<common_enums::ScaExemptionType>, - /// Contains whole connector response - pub whole_connector_response: Option<String>, + /// Contains stringified connector raw response body + pub raw_connector_response: Option<String>, } // Different patterns of authentication. @@ -567,6 +567,7 @@ impl resource_id, redirection_data, connector_metadata, + connector_response_reference_id, .. } => { let attempt_status = self.get_attempt_status_for_db_update(payment_data); @@ -595,6 +596,8 @@ impl token_details.get_connector_token_request_reference_id() }), ), + connector_response_reference_id: connector_response_reference_id + .clone(), }, )) } @@ -1253,6 +1256,7 @@ impl resource_id, redirection_data, connector_metadata, + connector_response_reference_id, .. } => { let attempt_status = self.get_attempt_status_for_db_update(payment_data); @@ -1281,6 +1285,9 @@ impl token_details.get_connector_token_request_reference_id() }), ), + + connector_response_reference_id: connector_response_reference_id + .clone(), }, )) } diff --git a/crates/hyperswitch_domain_models/src/router_request_types.rs b/crates/hyperswitch_domain_models/src/router_request_types.rs index c7987122ead..31879b4cfe3 100644 --- a/crates/hyperswitch_domain_models/src/router_request_types.rs +++ b/crates/hyperswitch_domain_models/src/router_request_types.rs @@ -508,6 +508,7 @@ pub struct PaymentsSyncData { pub split_payments: Option<common_types::payments::SplitPaymentsRequest>, pub amount: MinorUnit, pub integrity_object: Option<SyncIntegrityObject>, + pub connector_reference_id: Option<String>, } #[derive(Debug, Default, Clone)] diff --git a/crates/hyperswitch_interfaces/src/conversion_impls.rs b/crates/hyperswitch_interfaces/src/conversion_impls.rs index 252caed961e..ae5f071a209 100644 --- a/crates/hyperswitch_interfaces/src/conversion_impls.rs +++ b/crates/hyperswitch_interfaces/src/conversion_impls.rs @@ -84,7 +84,7 @@ fn get_default_router_data<F, Req, Resp>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, } } diff --git a/crates/openapi/src/openapi_v2.rs b/crates/openapi/src/openapi_v2.rs index 4a3c03d69fb..11dae0588ab 100644 --- a/crates/openapi/src/openapi_v2.rs +++ b/crates/openapi/src/openapi_v2.rs @@ -424,7 +424,6 @@ Never share your secret api keys. Keep them guarded and secure. api_models::payments::PaymentsRequest, api_models::payments::PaymentsResponse, api_models::payments::PaymentsListResponseItem, - api_models::payments::PaymentRetrieveBody, api_models::payments::PaymentsRetrieveRequest, api_models::payments::PaymentsStatusRequest, api_models::payments::PaymentsCaptureRequest, diff --git a/crates/router/src/core/authentication/transformers.rs b/crates/router/src/core/authentication/transformers.rs index e1cf04c20aa..91b7c23f053 100644 --- a/crates/router/src/core/authentication/transformers.rs +++ b/crates/router/src/core/authentication/transformers.rs @@ -206,7 +206,7 @@ pub fn construct_router_data<F: Clone, Req, Res>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type, - whole_connector_response: None, + raw_connector_response: None, }) } diff --git a/crates/router/src/core/fraud_check/flows/checkout_flow.rs b/crates/router/src/core/fraud_check/flows/checkout_flow.rs index 786192f8e98..a33dcc89a99 100644 --- a/crates/router/src/core/fraud_check/flows/checkout_flow.rs +++ b/crates/router/src/core/fraud_check/flows/checkout_flow.rs @@ -161,7 +161,7 @@ impl ConstructFlowSpecificData<frm_api::Checkout, FraudCheckCheckoutData, FraudC connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) diff --git a/crates/router/src/core/fraud_check/flows/fulfillment_flow.rs b/crates/router/src/core/fraud_check/flows/fulfillment_flow.rs index 421c255e117..08b3c789264 100644 --- a/crates/router/src/core/fraud_check/flows/fulfillment_flow.rs +++ b/crates/router/src/core/fraud_check/flows/fulfillment_flow.rs @@ -128,7 +128,7 @@ pub async fn construct_fulfillment_router_data<'a>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) } diff --git a/crates/router/src/core/fraud_check/flows/record_return.rs b/crates/router/src/core/fraud_check/flows/record_return.rs index ea34b8af172..d33cd51e574 100644 --- a/crates/router/src/core/fraud_check/flows/record_return.rs +++ b/crates/router/src/core/fraud_check/flows/record_return.rs @@ -129,7 +129,7 @@ impl ConstructFlowSpecificData<RecordReturn, FraudCheckRecordReturnData, FraudCh connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) diff --git a/crates/router/src/core/fraud_check/flows/sale_flow.rs b/crates/router/src/core/fraud_check/flows/sale_flow.rs index efdeeec7747..55d53f00964 100644 --- a/crates/router/src/core/fraud_check/flows/sale_flow.rs +++ b/crates/router/src/core/fraud_check/flows/sale_flow.rs @@ -137,7 +137,7 @@ impl ConstructFlowSpecificData<frm_api::Sale, FraudCheckSaleData, FraudCheckResp connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) diff --git a/crates/router/src/core/fraud_check/flows/transaction_flow.rs b/crates/router/src/core/fraud_check/flows/transaction_flow.rs index eae995be4b4..29013c70e92 100644 --- a/crates/router/src/core/fraud_check/flows/transaction_flow.rs +++ b/crates/router/src/core/fraud_check/flows/transaction_flow.rs @@ -146,7 +146,7 @@ impl connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) diff --git a/crates/router/src/core/mandate/utils.rs b/crates/router/src/core/mandate/utils.rs index 642a28c5671..1298162d412 100644 --- a/crates/router/src/core/mandate/utils.rs +++ b/crates/router/src/core/mandate/utils.rs @@ -85,7 +85,7 @@ pub async fn construct_mandate_revoke_router_data( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) diff --git a/crates/router/src/core/payment_methods.rs b/crates/router/src/core/payment_methods.rs index 6d36f7d4341..d04bf5b39ed 100644 --- a/crates/router/src/core/payment_methods.rs +++ b/crates/router/src/core/payment_methods.rs @@ -2922,6 +2922,7 @@ fn construct_zero_auth_payments_request( force_3ds_challenge: None, is_iframe_redirection_enabled: None, merchant_connector_details: None, + return_raw_connector_response: None, }) } @@ -3263,7 +3264,7 @@ async fn create_single_use_tokenization_flow( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; let payment_method_token_response = tokenization::add_token_for_payment_method( diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs index 66334148b09..7e5328763fd 100644 --- a/crates/router/src/core/payments.rs +++ b/crates/router/src/core/payments.rs @@ -148,7 +148,14 @@ pub async fn payments_operation_core<F, Req, Op, FData, D>( get_tracker_response: operations::GetTrackerResponse<D>, call_connector_action: CallConnectorAction, header_payload: HeaderPayload, -) -> RouterResult<(D, Req, Option<domain::Customer>, Option<u16>, Option<u128>)> +) -> RouterResult<( + D, + Req, + Option<domain::Customer>, + Option<u16>, + Option<u128>, + common_types::domain::ConnectorResponseData, +)> where F: Send + Clone + Sync, Req: Send + Sync + Authenticate, @@ -204,7 +211,7 @@ where .perform_routing(&merchant_context, profile, state, &mut payment_data) .await?; - let payment_data = match connector { + let (payment_data, connector_response_data) = match connector { ConnectorCallType::PreDetermined(connector_data) => { let router_data = call_connector_service( state, @@ -224,10 +231,14 @@ where profile, false, false, //should_retry_with_pan is set to false in case of PreDetermined ConnectorCallType - req.get_all_keys_required(), + req.should_return_raw_response(), ) .await?; + let connector_response_data = common_types::domain::ConnectorResponseData { + raw_connector_response: router_data.raw_connector_response.clone(), + }; + let payments_response_operation = Box::new(PaymentResponse); payments_response_operation @@ -241,7 +252,7 @@ where ) .await?; - payments_response_operation + let payment_data = payments_response_operation .to_post_update_tracker()? .update_tracker( state, @@ -250,7 +261,9 @@ where merchant_context.get_merchant_key_store(), merchant_context.get_merchant_account().storage_scheme, ) - .await? + .await?; + + (payment_data, connector_response_data) } ConnectorCallType::Retryable(connectors) => { let mut connectors = connectors.clone().into_iter(); @@ -273,10 +286,14 @@ where profile, false, false, //should_retry_with_pan is set to false in case of PreDetermined ConnectorCallType - req.get_all_keys_required(), + req.should_return_raw_response(), ) .await?; + let connector_response_data = common_types::domain::ConnectorResponseData { + raw_connector_response: router_data.raw_connector_response.clone(), + }; + let payments_response_operation = Box::new(PaymentResponse); payments_response_operation @@ -290,7 +307,7 @@ where ) .await?; - payments_response_operation + let payment_data = payments_response_operation .to_post_update_tracker()? .update_tracker( state, @@ -299,10 +316,17 @@ where merchant_context.get_merchant_key_store(), merchant_context.get_merchant_account().storage_scheme, ) - .await? + .await?; + + (payment_data, connector_response_data) } ConnectorCallType::SessionMultiple(vec) => todo!(), - ConnectorCallType::Skip => payment_data, + ConnectorCallType::Skip => ( + payment_data, + common_types::domain::ConnectorResponseData { + raw_connector_response: None, + }, + ), }; let payment_intent_status = payment_data.get_payment_intent().status; @@ -321,7 +345,14 @@ where }) .await; - Ok((payment_data, req, customer, None, None)) + Ok(( + payment_data, + req, + customer, + None, + None, + connector_response_data, + )) } #[cfg(feature = "v2")] @@ -337,7 +368,13 @@ pub async fn internal_payments_operation_core<F, Req, Op, FData, D>( get_tracker_response: operations::GetTrackerResponse<D>, call_connector_action: CallConnectorAction, header_payload: HeaderPayload, -) -> RouterResult<(D, Req, Option<u16>, Option<u128>)> +) -> RouterResult<( + D, + Req, + Option<u16>, + Option<u128>, + common_types::domain::ConnectorResponseData, +)> where F: Send + Clone + Sync, Req: Send + Sync + Authenticate, @@ -379,10 +416,14 @@ where call_connector_action.clone(), header_payload.clone(), profile, - req.get_all_keys_required(), + req.should_return_raw_response(), ) .await?; + let connector_response_data = common_types::domain::ConnectorResponseData { + raw_connector_response: router_data.raw_connector_response.clone(), + }; + let payments_response_operation = Box::new(PaymentResponse); let payment_data = payments_response_operation @@ -396,7 +437,7 @@ where ) .await?; - Ok((payment_data, req, None, None)) + Ok((payment_data, req, None, None, connector_response_data)) } #[cfg(feature = "v1")] @@ -686,7 +727,7 @@ where false, false, None, - <Req as Authenticate>::get_all_keys_required(&req), + <Req as Authenticate>::should_return_raw_response(&req), ) .await?; @@ -810,7 +851,7 @@ where false, false, routing_decision, - <Req as Authenticate>::get_all_keys_required(&req), + <Req as Authenticate>::should_return_raw_response(&req), ) .await?; @@ -941,7 +982,7 @@ where session_surcharge_details, &business_profile, header_payload.clone(), - <Req as Authenticate>::get_all_keys_required(&req), + <Req as Authenticate>::should_return_raw_response(&req), )) .await? } @@ -1070,7 +1111,7 @@ pub async fn proxy_for_payments_operation_core<F, Req, Op, FData, D>( call_connector_action: CallConnectorAction, auth_flow: services::AuthFlow, header_payload: HeaderPayload, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<(D, Req, Option<domain::Customer>, Option<u16>, Option<u128>)> where F: Send + Clone + Sync, @@ -1184,7 +1225,7 @@ where schedule_time, header_payload.clone(), &business_profile, - all_keys_required, + return_raw_connector_response, ) .await?; @@ -1270,7 +1311,7 @@ pub async fn proxy_for_payments_operation_core<F, Req, Op, FData, D>( get_tracker_response: operations::GetTrackerResponse<D>, call_connector_action: CallConnectorAction, header_payload: HeaderPayload, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<(D, Req, Option<u16>, Option<u128>)> where F: Send + Clone + Sync, @@ -1315,7 +1356,7 @@ where call_connector_action.clone(), header_payload.clone(), &profile, - all_keys_required, + return_raw_connector_response, ) .await?; @@ -1865,7 +1906,7 @@ pub async fn proxy_for_payments_core<F, Res, Req, Op, FData, D>( auth_flow: services::AuthFlow, call_connector_action: CallConnectorAction, header_payload: HeaderPayload, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResponse<Res> where F: Send + Clone + Sync, @@ -1896,7 +1937,7 @@ where call_connector_action, auth_flow, header_payload.clone(), - all_keys_required, + return_raw_connector_response, ) .await?; @@ -1925,7 +1966,7 @@ pub async fn proxy_for_payments_core<F, Res, Req, Op, FData, D>( payment_id: id_type::GlobalPaymentId, call_connector_action: CallConnectorAction, header_payload: HeaderPayload, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResponse<Res> where F: Send + Clone + Sync, @@ -1977,7 +2018,7 @@ where get_tracker_response, call_connector_action, header_payload.clone(), - all_keys_required, + return_raw_connector_response, ) .await?; @@ -1988,6 +2029,7 @@ where header_payload.x_hs_latency, &merchant_context, &profile, + None, ) } @@ -2065,7 +2107,7 @@ pub async fn record_attempt_core( force_sync: true, expand_attempts: false, param: None, - all_keys_required: None, + return_raw_connector_response: None, merchant_connector_details: None, }, operations::GetTrackerResponse { @@ -2125,6 +2167,7 @@ pub async fn record_attempt_core( header_payload.x_hs_latency, &merchant_context, &profile, + None, ) } @@ -2334,37 +2377,58 @@ where ) .await?; - let (payment_data, connector_http_status_code, external_latency) = + let (payment_data, connector_http_status_code, external_latency, connector_response_data) = if state.conf.merchant_id_auth.merchant_id_auth_enabled { - let (payment_data, _req, connector_http_status_code, external_latency) = - internal_payments_operation_core::<_, _, _, _, _>( - &state, - req_state, - merchant_context.clone(), - &profile, - operation.clone(), - req, - get_tracker_response, - call_connector_action, - header_payload.clone(), - ) - .await?; - (payment_data, connector_http_status_code, external_latency) + let ( + payment_data, + _req, + connector_http_status_code, + external_latency, + connector_response_data, + ) = internal_payments_operation_core::<_, _, _, _, _>( + &state, + req_state, + merchant_context.clone(), + &profile, + operation.clone(), + req, + get_tracker_response, + call_connector_action, + header_payload.clone(), + ) + .await?; + ( + payment_data, + connector_http_status_code, + external_latency, + connector_response_data, + ) } else { - let (payment_data, _req, _customer, connector_http_status_code, external_latency) = - payments_operation_core::<_, _, _, _, _>( - &state, - req_state, - merchant_context.clone(), - &profile, - operation.clone(), - req, - get_tracker_response, - call_connector_action, - header_payload.clone(), - ) - .await?; - (payment_data, connector_http_status_code, external_latency) + let ( + payment_data, + _req, + _customer, + connector_http_status_code, + external_latency, + connector_response_data, + ) = payments_operation_core::<_, _, _, _, _>( + &state, + req_state, + merchant_context.clone(), + &profile, + operation.clone(), + req, + get_tracker_response, + call_connector_action, + header_payload.clone(), + ) + .await?; + ( + payment_data, + connector_http_status_code, + external_latency, + connector_response_data, + ) }; payment_data.generate_response( @@ -2374,6 +2438,7 @@ where header_payload.x_hs_latency, &merchant_context, &profile, + Some(connector_response_data), ) } @@ -3000,7 +3065,7 @@ impl PaymentRedirectFlow for PaymentRedirectSync { param: Some(req.query_params.clone()), force_sync: true, expand_attempts: false, - all_keys_required: None, + return_raw_connector_response: None, merchant_connector_details: None, // TODO: Implement for connectors requiring 3DS or redirection-based authentication flows. }; @@ -3056,7 +3121,7 @@ impl PaymentRedirectFlow for PaymentRedirectSync { .change_context(errors::ApiErrorResponse::InternalServerError) .attach_printable("Failed to decide the response flow")?; - let (payment_data, _, _, _, _) = + let (payment_data, _, _, _, _, _) = Box::pin(payments_operation_core::<api::PSync, _, _, _, _>( state, req_state, @@ -3378,7 +3443,7 @@ pub async fn call_connector_service<F, RouterDReq, ApiRequest, D>( is_retry_payment: bool, should_retry_with_pan: bool, routing_decision: Option<routing_helpers::RoutingDecisionData>, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<( RouterData<F, RouterDReq, router_types::PaymentsResponseData>, helpers::MerchantConnectorAccountType, @@ -3539,16 +3604,28 @@ where router_data = router_data.add_session_token(state, &connector).await?; - let should_continue_further = access_token::update_router_data_with_access_token_result( + let mut should_continue_further = access_token::update_router_data_with_access_token_result( &add_access_token_result, &mut router_data, &call_connector_action, ); - let should_continue_further = router_data + let add_create_order_result = router_data .create_order_at_connector(state, &connector, should_continue_further) .await?; + if add_create_order_result.is_create_order_performed { + if let Ok(order_id_opt) = &add_create_order_result.create_order_result { + payment_data.set_connector_response_reference_id(order_id_opt.clone()); + } + should_continue_further = router_data + .update_router_data_with_create_order_result( + add_create_order_result, + should_continue_further, + ) + .await?; + } + let updated_customer = call_create_connector_customer_if_required( state, customer, @@ -3664,7 +3741,7 @@ where connector_request, business_profile, header_payload.clone(), - all_keys_required, + return_raw_connector_response, ) .await } else { @@ -3696,7 +3773,7 @@ pub async fn call_connector_service<F, RouterDReq, ApiRequest, D>( business_profile: &domain::Profile, is_retry_payment: bool, should_retry_with_pan: bool, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<RouterData<F, RouterDReq, router_types::PaymentsResponseData>> where F: Send + Clone + Sync, @@ -3765,16 +3842,28 @@ where router_data = router_data.add_session_token(state, &connector).await?; - let should_continue_further = access_token::update_router_data_with_access_token_result( + let mut should_continue_further = access_token::update_router_data_with_access_token_result( &add_access_token_result, &mut router_data, &call_connector_action, ); - let should_continue_further = router_data + let add_create_order_result = router_data .create_order_at_connector(state, &connector, should_continue_further) .await?; + if add_create_order_result.is_create_order_performed { + if let Ok(order_id_opt) = &add_create_order_result.create_order_result { + payment_data.set_connector_response_reference_id(order_id_opt.clone()); + } + should_continue_further = router_data + .update_router_data_with_create_order_result( + add_create_order_result, + should_continue_further, + ) + .await?; + } + // In case of authorize flow, pre-task and post-tasks are being called in build request // if we do not want to proceed further, then the function will return Ok(None, false) let (connector_request, should_continue_further) = if should_continue_further { @@ -3819,7 +3908,7 @@ where connector_request, business_profile, header_payload.clone(), - all_keys_required, + return_raw_connector_response, ) .await } else { @@ -3851,7 +3940,7 @@ pub async fn proxy_for_call_connector_service<F, RouterDReq, ApiRequest, D>( header_payload: HeaderPayload, business_profile: &domain::Profile, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<( RouterData<F, RouterDReq, router_types::PaymentsResponseData>, helpers::MerchantConnectorAccountType, @@ -3992,7 +4081,7 @@ where connector_request, business_profile, header_payload.clone(), - all_keys_required, + return_raw_connector_response, ) .await } else { @@ -4019,7 +4108,7 @@ pub async fn proxy_for_call_connector_service<F, RouterDReq, ApiRequest, D>( call_connector_action: CallConnectorAction, header_payload: HeaderPayload, business_profile: &domain::Profile, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<RouterData<F, RouterDReq, router_types::PaymentsResponseData>> where F: Send + Clone + Sync, @@ -4116,7 +4205,7 @@ where connector_request, business_profile, header_payload.clone(), - all_keys_required, + return_raw_connector_response, ) .await } else { @@ -4143,7 +4232,7 @@ pub async fn internal_call_connector_service<F, RouterDReq, ApiRequest, D>( call_connector_action: CallConnectorAction, header_payload: HeaderPayload, business_profile: &domain::Profile, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<RouterData<F, RouterDReq, router_types::PaymentsResponseData>> where F: Send + Clone + Sync, @@ -4211,10 +4300,22 @@ where &call_connector_action, ); - let should_continue_further = router_data + let add_create_order_result = router_data .create_order_at_connector(state, &connector, should_continue_further) .await?; + if add_create_order_result.is_create_order_performed { + if let Ok(order_id_opt) = &add_create_order_result.create_order_result { + payment_data.set_connector_response_reference_id(order_id_opt.clone()); + } + should_continue_further = router_data + .update_router_data_with_create_order_result( + add_create_order_result, + should_continue_further, + ) + .await?; + } + let (connector_request, should_continue_further) = if should_continue_further { router_data .build_flow_specific_connector_request(state, &connector, call_connector_action.clone()) @@ -4247,7 +4348,7 @@ where connector_request, business_profile, header_payload.clone(), - all_keys_required, + return_raw_connector_response, ) .await } else { @@ -4509,7 +4610,7 @@ pub async fn call_multiple_connectors_service<F, Op, Req, D>( _session_surcharge_details: Option<api::SessionSurchargeDetails>, business_profile: &domain::Profile, header_payload: HeaderPayload, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<D> where Op: Debug, @@ -4560,7 +4661,7 @@ where None, business_profile, header_payload.clone(), - all_keys_required, + return_raw_connector_response, ); join_handlers.push(res); @@ -4620,7 +4721,7 @@ pub async fn call_multiple_connectors_service<F, Op, Req, D>( session_surcharge_details: Option<api::SessionSurchargeDetails>, business_profile: &domain::Profile, header_payload: HeaderPayload, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<D> where Op: Debug, @@ -4682,7 +4783,7 @@ where None, business_profile, header_payload.clone(), - all_keys_required, + return_raw_connector_response, ); join_handlers.push(res); @@ -8894,6 +8995,7 @@ pub trait OperationSessionGetters<F> { fn get_token_data(&self) -> Option<&storage::PaymentTokenData>; fn get_mandate_connector(&self) -> Option<&MandateConnectorDetails>; fn get_force_sync(&self) -> Option<bool>; + #[cfg(feature = "v1")] fn get_all_keys_required(&self) -> Option<bool>; fn get_capture_method(&self) -> Option<enums::CaptureMethod>; fn get_merchant_connector_id_in_attempt(&self) -> Option<id_type::MerchantConnectorAccountId>; @@ -8903,6 +9005,8 @@ pub trait OperationSessionGetters<F> { ) -> Option<common_types::domain::MerchantConnectorAuthDetails>; fn get_connector_customer_id(&self) -> Option<String>; + + #[cfg(feature = "v1")] fn get_whole_connector_response(&self) -> Option<String>; #[cfg(feature = "v1")] @@ -8981,6 +9085,8 @@ pub trait OperationSessionSetters<F> { #[cfg(feature = "v2")] fn set_connector_request_reference_id(&mut self, reference_id: Option<String>); + fn set_connector_response_reference_id(&mut self, reference_id: Option<String>); + #[cfg(feature = "v2")] fn set_vault_session_details( &mut self, @@ -9293,6 +9399,10 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentData<F> { ) { self.payment_attempt.routing_approach = routing_approach; } + + fn set_connector_response_reference_id(&mut self, reference_id: Option<String>) { + self.payment_attempt.connector_response_reference_id = reference_id; + } } #[cfg(feature = "v2")] @@ -9447,14 +9557,6 @@ impl<F: Clone> OperationSessionGetters<F> for PaymentIntentData<F> { todo!(); } - fn get_all_keys_required(&self) -> Option<bool> { - todo!(); - } - - fn get_whole_connector_response(&self) -> Option<String> { - todo!(); - } - fn get_pre_routing_result( &self, ) -> Option<HashMap<enums::PaymentMethodType, domain::PreRoutingConnectorChoice>> { @@ -9573,6 +9675,10 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentIntentData<F> { todo!() } + fn set_connector_response_reference_id(&mut self, reference_id: Option<String>) { + todo!() + } + fn set_vault_session_details( &mut self, vault_session_details: Option<api::VaultSessionDetails>, @@ -9738,14 +9844,6 @@ impl<F: Clone> OperationSessionGetters<F> for PaymentConfirmData<F> { Some(&self.payment_attempt) } - fn get_all_keys_required(&self) -> Option<bool> { - todo!() - } - - fn get_whole_connector_response(&self) -> Option<String> { - todo!() - } - fn get_pre_routing_result( &self, ) -> Option<HashMap<enums::PaymentMethodType, domain::PreRoutingConnectorChoice>> { @@ -9869,6 +9967,10 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentConfirmData<F> { self.payment_attempt.connector_request_reference_id = reference_id; } + fn set_connector_response_reference_id(&mut self, reference_id: Option<String>) { + self.payment_attempt.connector_response_reference_id = reference_id; + } + fn set_vault_session_details( &mut self, external_vault_session_details: Option<api::VaultSessionDetails>, @@ -10034,14 +10136,6 @@ impl<F: Clone> OperationSessionGetters<F> for PaymentStatusData<F> { Some(&self.payment_attempt) } - fn get_all_keys_required(&self) -> Option<bool> { - todo!() - } - - fn get_whole_connector_response(&self) -> Option<String> { - todo!() - } - fn get_pre_routing_result( &self, ) -> Option<HashMap<enums::PaymentMethodType, domain::PreRoutingConnectorChoice>> { @@ -10161,6 +10255,10 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentStatusData<F> { todo!() } + fn set_connector_response_reference_id(&mut self, reference_id: Option<String>) { + todo!() + } + fn set_vault_session_details( &mut self, external_vault_session_details: Option<api::VaultSessionDetails>, @@ -10327,13 +10425,6 @@ impl<F: Clone> OperationSessionGetters<F> for PaymentCaptureData<F> { Some(&self.payment_attempt) } - fn get_all_keys_required(&self) -> Option<bool> { - todo!(); - } - - fn get_whole_connector_response(&self) -> Option<String> { - todo!(); - } fn get_pre_routing_result( &self, ) -> Option<HashMap<enums::PaymentMethodType, domain::PreRoutingConnectorChoice>> { @@ -10453,6 +10544,10 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentCaptureData<F> { todo!() } + fn set_connector_response_reference_id(&mut self, reference_id: Option<String>) { + todo!() + } + fn set_vault_session_details( &mut self, external_vault_session_details: Option<api::VaultSessionDetails>, @@ -10614,13 +10709,6 @@ impl<F: Clone> OperationSessionGetters<F> for PaymentAttemptListData<F> { todo!() } - fn get_all_keys_required(&self) -> Option<bool> { - todo!(); - } - - fn get_whole_connector_response(&self) -> Option<String> { - todo!(); - } fn get_pre_routing_result( &self, ) -> Option<HashMap<enums::PaymentMethodType, domain::PreRoutingConnectorChoice>> { diff --git a/crates/router/src/core/payments/flows.rs b/crates/router/src/core/payments/flows.rs index 2b681202743..5cc7cfa777e 100644 --- a/crates/router/src/core/payments/flows.rs +++ b/crates/router/src/core/payments/flows.rs @@ -78,7 +78,7 @@ pub trait Feature<F, T> { connector_request: Option<services::Request>, business_profile: &domain::Profile, header_payload: hyperswitch_domain_models::payments::HeaderPayload, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> where Self: Sized, @@ -182,6 +182,22 @@ pub trait Feature<F, T> { &mut self, _state: &SessionState, _connector: &api::ConnectorData, + _should_continue_payment: bool, + ) -> RouterResult<types::CreateOrderResult> + where + F: Clone, + Self: Sized, + dyn api::Connector: services::ConnectorIntegration<F, T, types::PaymentsResponseData>, + { + Ok(types::CreateOrderResult { + create_order_result: Ok(None), + is_create_order_performed: false, + }) + } + + async fn update_router_data_with_create_order_result( + &mut self, + _create_order_result: types::CreateOrderResult, should_continue_payment: bool, ) -> RouterResult<bool> where diff --git a/crates/router/src/core/payments/flows/approve_flow.rs b/crates/router/src/core/payments/flows/approve_flow.rs index 30b7b834f5a..e2f671d914b 100644 --- a/crates/router/src/core/payments/flows/approve_flow.rs +++ b/crates/router/src/core/payments/flows/approve_flow.rs @@ -80,7 +80,7 @@ impl Feature<api::Approve, types::PaymentsApproveData> _connector_request: Option<services::Request>, _business_profile: &domain::Profile, _header_payload: hyperswitch_domain_models::payments::HeaderPayload, - _all_keys_required: Option<bool>, + _return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { Err(ApiErrorResponse::NotImplemented { message: NotImplementedMessage::Reason("Flow not supported".to_string()), diff --git a/crates/router/src/core/payments/flows/authorize_flow.rs b/crates/router/src/core/payments/flows/authorize_flow.rs index ace3588c229..4df6ae9fe91 100644 --- a/crates/router/src/core/payments/flows/authorize_flow.rs +++ b/crates/router/src/core/payments/flows/authorize_flow.rs @@ -171,7 +171,7 @@ impl Feature<api::Authorize, types::PaymentsAuthorizeData> for types::PaymentsAu connector_request: Option<services::Request>, business_profile: &domain::Profile, header_payload: hyperswitch_domain_models::payments::HeaderPayload, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { let connector_integration: services::BoxedPaymentConnectorIntegrationInterface< api::Authorize, @@ -188,7 +188,7 @@ impl Feature<api::Authorize, types::PaymentsAuthorizeData> for types::PaymentsAu &self, call_connector_action.clone(), connector_request, - all_keys_required, + return_raw_connector_response, ) .await .to_payment_failed_response()?; @@ -422,17 +422,92 @@ impl Feature<api::Authorize, types::PaymentsAuthorizeData> for types::PaymentsAu state: &SessionState, connector: &api::ConnectorData, should_continue_payment: bool, - ) -> RouterResult<bool> { - let create_order_result = - create_order_at_connector(self, state, connector, should_continue_payment).await?; + ) -> RouterResult<types::CreateOrderResult> { + if connector + .connector_name + .requires_order_creation_before_payment(self.payment_method) + && should_continue_payment + { + let connector_integration: services::BoxedPaymentConnectorIntegrationInterface< + api::CreateOrder, + types::CreateOrderRequestData, + types::PaymentsResponseData, + > = connector.connector.get_connector_integration(); + + let request_data = types::CreateOrderRequestData::try_from(self.request.clone())?; + + let response_data: Result<types::PaymentsResponseData, types::ErrorResponse> = + Err(types::ErrorResponse::default()); + + let createorder_router_data = + helpers::router_data_type_conversion::<_, api::CreateOrder, _, _, _, _>( + self.clone(), + request_data, + response_data, + ); - let should_continue_payment = update_router_data_with_create_order_result( - create_order_result, - self, - should_continue_payment, - )?; + let resp = services::execute_connector_processing_step( + state, + connector_integration, + &createorder_router_data, + payments::CallConnectorAction::Trigger, + None, + None, + ) + .await + .to_payment_failed_response()?; + + let create_order_resp = match resp.response { + Ok(res) => { + if let types::PaymentsResponseData::PaymentsCreateOrderResponse { order_id } = + res + { + Ok(Some(order_id)) + } else { + Err(error_stack::report!(ApiErrorResponse::InternalServerError) + .attach_printable(format!( + "Unexpected response format from connector: {res:?}", + )))? + } + } + Err(error) => Err(error), + }; + + Ok(types::CreateOrderResult { + create_order_result: create_order_resp, + is_create_order_performed: true, + }) + } else { + Ok(types::CreateOrderResult { + create_order_result: Ok(None), + is_create_order_performed: false, + }) + } + } - Ok(should_continue_payment) + async fn update_router_data_with_create_order_result( + &mut self, + create_order_result: types::CreateOrderResult, + should_continue_further: bool, + ) -> RouterResult<bool> { + if create_order_result.is_create_order_performed { + match create_order_result.create_order_result { + Ok(Some(order_id)) => { + self.request.order_id = Some(order_id.clone()); + self.response = + Ok(types::PaymentsResponseData::PaymentsCreateOrderResponse { order_id }); + Ok(true) + } + Ok(None) => Err(error_stack::report!(ApiErrorResponse::InternalServerError) + .attach_printable("Order Id not found."))?, + Err(err) => { + self.response = Err(err.clone()); + Ok(false) + } + } + } else { + Ok(should_continue_further) + } } } @@ -719,102 +794,3 @@ async fn process_capture_flow( router_data.response = Ok(updated_response); Ok(router_data) } - -async fn create_order_at_connector<F: Clone>( - router_data: &mut types::RouterData< - F, - types::PaymentsAuthorizeData, - types::PaymentsResponseData, - >, - state: &SessionState, - connector: &api::ConnectorData, - should_continue_payment: bool, -) -> RouterResult<types::CreateOrderResult> { - if connector - .connector_name - .requires_order_creation_before_payment(router_data.payment_method) - && should_continue_payment - { - let connector_integration: services::BoxedPaymentConnectorIntegrationInterface< - api::CreateOrder, - types::CreateOrderRequestData, - types::PaymentsResponseData, - > = connector.connector.get_connector_integration(); - - let request_data = types::CreateOrderRequestData::try_from(router_data.request.clone())?; - - let response_data: Result<types::PaymentsResponseData, types::ErrorResponse> = - Err(types::ErrorResponse::default()); - - let createorder_router_data = - helpers::router_data_type_conversion::<_, api::CreateOrder, _, _, _, _>( - router_data.clone(), - request_data, - response_data, - ); - - let resp = services::execute_connector_processing_step( - state, - connector_integration, - &createorder_router_data, - payments::CallConnectorAction::Trigger, - None, - None, - ) - .await - .to_payment_failed_response()?; - - let create_order_resp = match resp.response { - Ok(res) => { - if let types::PaymentsResponseData::PaymentsCreateOrderResponse { order_id } = res { - Ok(Some(order_id)) - } else { - Err(error_stack::report!(ApiErrorResponse::InternalServerError) - .attach_printable(format!( - "Unexpected response format from connector: {res:?}", - )))? - } - } - Err(error) => Err(error), - }; - - Ok(types::CreateOrderResult { - create_order_result: create_order_resp, - is_create_order_performed: true, - }) - } else { - Ok(types::CreateOrderResult { - create_order_result: Ok(None), - is_create_order_performed: false, - }) - } -} - -fn update_router_data_with_create_order_result<F>( - create_order_result: types::CreateOrderResult, - router_data: &mut types::RouterData< - F, - types::PaymentsAuthorizeData, - types::PaymentsResponseData, - >, - should_continue_further: bool, -) -> RouterResult<bool> { - if create_order_result.is_create_order_performed { - match create_order_result.create_order_result { - Ok(Some(order_id)) => { - router_data.request.order_id = Some(order_id.clone()); - router_data.response = - Ok(types::PaymentsResponseData::PaymentsCreateOrderResponse { order_id }); - Ok(true) - } - Ok(None) => Err(error_stack::report!(ApiErrorResponse::InternalServerError) - .attach_printable("Order Id not found."))?, - Err(err) => { - router_data.response = Err(err.clone()); - Ok(false) - } - } - } else { - Ok(should_continue_further) - } -} diff --git a/crates/router/src/core/payments/flows/cancel_flow.rs b/crates/router/src/core/payments/flows/cancel_flow.rs index fc27a600421..046213dbe52 100644 --- a/crates/router/src/core/payments/flows/cancel_flow.rs +++ b/crates/router/src/core/payments/flows/cancel_flow.rs @@ -79,7 +79,7 @@ impl Feature<api::Void, types::PaymentsCancelData> connector_request: Option<services::Request>, _business_profile: &domain::Profile, _header_payload: hyperswitch_domain_models::payments::HeaderPayload, - _all_keys_required: Option<bool>, + _return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { metrics::PAYMENT_CANCEL_COUNT.add( 1, diff --git a/crates/router/src/core/payments/flows/capture_flow.rs b/crates/router/src/core/payments/flows/capture_flow.rs index 545b3fc2631..09d60db9a48 100644 --- a/crates/router/src/core/payments/flows/capture_flow.rs +++ b/crates/router/src/core/payments/flows/capture_flow.rs @@ -108,7 +108,7 @@ impl Feature<api::Capture, types::PaymentsCaptureData> connector_request: Option<services::Request>, _business_profile: &domain::Profile, _header_payload: hyperswitch_domain_models::payments::HeaderPayload, - _all_keys_required: Option<bool>, + _return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { let connector_integration: services::BoxedPaymentConnectorIntegrationInterface< api::Capture, diff --git a/crates/router/src/core/payments/flows/complete_authorize_flow.rs b/crates/router/src/core/payments/flows/complete_authorize_flow.rs index 4fb4e7574a4..d734f195cec 100644 --- a/crates/router/src/core/payments/flows/complete_authorize_flow.rs +++ b/crates/router/src/core/payments/flows/complete_authorize_flow.rs @@ -100,7 +100,7 @@ impl Feature<api::CompleteAuthorize, types::CompleteAuthorizeData> connector_request: Option<services::Request>, business_profile: &domain::Profile, header_payload: hyperswitch_domain_models::payments::HeaderPayload, - _all_keys_required: Option<bool>, + _return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { let connector_integration: services::BoxedPaymentConnectorIntegrationInterface< api::CompleteAuthorize, diff --git a/crates/router/src/core/payments/flows/incremental_authorization_flow.rs b/crates/router/src/core/payments/flows/incremental_authorization_flow.rs index 092be332191..c7dee2ad9e8 100644 --- a/crates/router/src/core/payments/flows/incremental_authorization_flow.rs +++ b/crates/router/src/core/payments/flows/incremental_authorization_flow.rs @@ -87,7 +87,7 @@ impl Feature<api::IncrementalAuthorization, types::PaymentsIncrementalAuthorizat connector_request: Option<services::Request>, _business_profile: &domain::Profile, _header_payload: hyperswitch_domain_models::payments::HeaderPayload, - _all_keys_required: Option<bool>, + _return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { let connector_integration: services::BoxedPaymentConnectorIntegrationInterface< api::IncrementalAuthorization, diff --git a/crates/router/src/core/payments/flows/post_session_tokens_flow.rs b/crates/router/src/core/payments/flows/post_session_tokens_flow.rs index e29739cf01b..118dd17a10a 100644 --- a/crates/router/src/core/payments/flows/post_session_tokens_flow.rs +++ b/crates/router/src/core/payments/flows/post_session_tokens_flow.rs @@ -87,7 +87,7 @@ impl Feature<api::PostSessionTokens, types::PaymentsPostSessionTokensData> connector_request: Option<services::Request>, _business_profile: &domain::Profile, _header_payload: hyperswitch_domain_models::payments::HeaderPayload, - _all_keys_required: Option<bool>, + _return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { let connector_integration: services::BoxedPaymentConnectorIntegrationInterface< api::PostSessionTokens, diff --git a/crates/router/src/core/payments/flows/psync_flow.rs b/crates/router/src/core/payments/flows/psync_flow.rs index 38fc08a1df1..87536525beb 100644 --- a/crates/router/src/core/payments/flows/psync_flow.rs +++ b/crates/router/src/core/payments/flows/psync_flow.rs @@ -111,7 +111,7 @@ impl Feature<api::PSync, types::PaymentsSyncData> connector_request: Option<services::Request>, _business_profile: &domain::Profile, _header_payload: hyperswitch_domain_models::payments::HeaderPayload, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { let connector_integration: services::BoxedPaymentConnectorIntegrationInterface< api::PSync, @@ -134,7 +134,7 @@ impl Feature<api::PSync, types::PaymentsSyncData> pending_connector_capture_id_list, call_connector_action, connector_integration, - all_keys_required, + return_raw_connector_response, ) .await?; // Initiating Integrity checks @@ -156,7 +156,7 @@ impl Feature<api::PSync, types::PaymentsSyncData> &self, call_connector_action, connector_request, - all_keys_required, + return_raw_connector_response, ) .await .to_payment_failed_response()?; @@ -241,7 +241,7 @@ where types::PaymentsSyncData, types::PaymentsResponseData, >, - _all_keys_required: Option<bool>, + _return_raw_connector_response: Option<bool>, ) -> RouterResult<Self>; } @@ -259,7 +259,7 @@ impl RouterDataPSync types::PaymentsSyncData, types::PaymentsResponseData, >, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { let mut capture_sync_response_map = HashMap::new(); if let payments::CallConnectorAction::HandleResponse(_) = call_connector_action { @@ -270,7 +270,7 @@ impl RouterDataPSync self, call_connector_action.clone(), None, - all_keys_required, + return_raw_connector_response, ) .await .to_payment_failed_response()?; @@ -289,7 +289,7 @@ impl RouterDataPSync &cloned_router_data, call_connector_action.clone(), None, - all_keys_required, + return_raw_connector_response, ) .await .to_payment_failed_response()?; diff --git a/crates/router/src/core/payments/flows/reject_flow.rs b/crates/router/src/core/payments/flows/reject_flow.rs index 852058dc377..efb34be54b3 100644 --- a/crates/router/src/core/payments/flows/reject_flow.rs +++ b/crates/router/src/core/payments/flows/reject_flow.rs @@ -79,7 +79,7 @@ impl Feature<api::Reject, types::PaymentsRejectData> _connector_request: Option<services::Request>, _business_profile: &domain::Profile, _header_payload: hyperswitch_domain_models::payments::HeaderPayload, - _all_keys_required: Option<bool>, + _return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { Err(ApiErrorResponse::NotImplemented { message: NotImplementedMessage::Reason("Flow not supported".to_string()), diff --git a/crates/router/src/core/payments/flows/session_flow.rs b/crates/router/src/core/payments/flows/session_flow.rs index a805f455b4b..ae0450f28f0 100644 --- a/crates/router/src/core/payments/flows/session_flow.rs +++ b/crates/router/src/core/payments/flows/session_flow.rs @@ -121,7 +121,7 @@ impl Feature<api::Session, types::PaymentsSessionData> for types::PaymentsSessio _connector_request: Option<services::Request>, business_profile: &domain::Profile, header_payload: hyperswitch_domain_models::payments::HeaderPayload, - _all_keys_required: Option<bool>, + _return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { metrics::SESSION_TOKEN_CREATED.add( 1, diff --git a/crates/router/src/core/payments/flows/session_update_flow.rs b/crates/router/src/core/payments/flows/session_update_flow.rs index e717ff50c26..cd42f855c11 100644 --- a/crates/router/src/core/payments/flows/session_update_flow.rs +++ b/crates/router/src/core/payments/flows/session_update_flow.rs @@ -87,7 +87,7 @@ impl Feature<api::SdkSessionUpdate, types::SdkPaymentsSessionUpdateData> connector_request: Option<services::Request>, _business_profile: &domain::Profile, _header_payload: hyperswitch_domain_models::payments::HeaderPayload, - _all_keys_required: Option<bool>, + _return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { let connector_integration: services::BoxedPaymentConnectorIntegrationInterface< api::SdkSessionUpdate, diff --git a/crates/router/src/core/payments/flows/setup_mandate_flow.rs b/crates/router/src/core/payments/flows/setup_mandate_flow.rs index a5bcdb4f55e..f99d13bd312 100644 --- a/crates/router/src/core/payments/flows/setup_mandate_flow.rs +++ b/crates/router/src/core/payments/flows/setup_mandate_flow.rs @@ -117,7 +117,7 @@ impl Feature<api::SetupMandate, types::SetupMandateRequestData> for types::Setup connector_request: Option<services::Request>, _business_profile: &domain::Profile, _header_payload: hyperswitch_domain_models::payments::HeaderPayload, - _all_keys_required: Option<bool>, + _return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { let connector_integration: services::BoxedPaymentConnectorIntegrationInterface< api::SetupMandate, diff --git a/crates/router/src/core/payments/flows/update_metadata_flow.rs b/crates/router/src/core/payments/flows/update_metadata_flow.rs index a6a35833255..f654b7ead13 100644 --- a/crates/router/src/core/payments/flows/update_metadata_flow.rs +++ b/crates/router/src/core/payments/flows/update_metadata_flow.rs @@ -86,7 +86,7 @@ impl Feature<api::UpdateMetadata, types::PaymentsUpdateMetadataData> connector_request: Option<services::Request>, _business_profile: &domain::Profile, _header_payload: hyperswitch_domain_models::payments::HeaderPayload, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { let connector_integration: services::BoxedPaymentConnectorIntegrationInterface< api::UpdateMetadata, @@ -100,7 +100,7 @@ impl Feature<api::UpdateMetadata, types::PaymentsUpdateMetadataData> &self, call_connector_action, connector_request, - all_keys_required, + return_raw_connector_response, ) .await .to_payment_failed_response()?; diff --git a/crates/router/src/core/payments/helpers.rs b/crates/router/src/core/payments/helpers.rs index 4b7791bb084..5eaee11c18a 100644 --- a/crates/router/src/core/payments/helpers.rs +++ b/crates/router/src/core/payments/helpers.rs @@ -4175,7 +4175,7 @@ pub fn router_data_type_conversion<F1, F2, Req1, Req2, Res1, Res2>( connector_mandate_request_reference_id: router_data.connector_mandate_request_reference_id, authentication_id: router_data.authentication_id, psd2_sca_exemption_type: router_data.psd2_sca_exemption_type, - whole_connector_response: router_data.whole_connector_response, + raw_connector_response: router_data.raw_connector_response, } } diff --git a/crates/router/src/core/payments/operations/payment_confirm_intent.rs b/crates/router/src/core/payments/operations/payment_confirm_intent.rs index dce33895fde..8ab7ddcfa28 100644 --- a/crates/router/src/core/payments/operations/payment_confirm_intent.rs +++ b/crates/router/src/core/payments/operations/payment_confirm_intent.rs @@ -588,6 +588,11 @@ impl<F: Clone + Sync> UpdateTracker<F, PaymentConfirmData<F>, PaymentsConfirmInt .connector_request_reference_id .clone(); + let connector_response_reference_id = payment_data + .payment_attempt + .connector_response_reference_id + .clone(); + let payment_attempt_update = match &payment_data.payment_method { // In the case of a tokenized payment method, we update the payment attempt with the tokenized payment method details. Some(payment_method) => { @@ -611,6 +616,7 @@ impl<F: Clone + Sync> UpdateTracker<F, PaymentConfirmData<F>, PaymentsConfirmInt merchant_connector_id, authentication_type, connector_request_reference_id, + connector_response_reference_id, } } }; diff --git a/crates/router/src/core/payments/operations/payment_response.rs b/crates/router/src/core/payments/operations/payment_response.rs index ff618a7b349..939679ef51f 100644 --- a/crates/router/src/core/payments/operations/payment_response.rs +++ b/crates/router/src/core/payments/operations/payment_response.rs @@ -1412,7 +1412,7 @@ async fn payment_response_update_tracker<F: Clone, T: types::Capturable>( .as_mut() .map(\|info\| info.status = status) }); - payment_data.whole_connector_response = router_data.whole_connector_response.clone(); + payment_data.whole_connector_response = router_data.raw_connector_response.clone(); // TODO: refactor of gsm_error_category with respective feature flag #[allow(unused_variables)] diff --git a/crates/router/src/core/payments/operations/proxy_payments_intent.rs b/crates/router/src/core/payments/operations/proxy_payments_intent.rs index a65f4cdd99e..30ea6913c6d 100644 --- a/crates/router/src/core/payments/operations/proxy_payments_intent.rs +++ b/crates/router/src/core/payments/operations/proxy_payments_intent.rs @@ -409,6 +409,11 @@ impl<F: Clone + Sync> UpdateTracker<F, PaymentConfirmData<F>, ProxyPaymentsReque .connector_request_reference_id .clone(); + let connector_response_reference_id = payment_data + .payment_attempt + .connector_response_reference_id + .clone(); + let payment_attempt_update = hyperswitch_domain_models::payments::payment_attempt::PaymentAttemptUpdate::ConfirmIntent { status: attempt_status, updated_by: storage_scheme.to_string(), @@ -416,6 +421,7 @@ impl<F: Clone + Sync> UpdateTracker<F, PaymentConfirmData<F>, ProxyPaymentsReque merchant_connector_id, authentication_type, connector_request_reference_id, + connector_response_reference_id, }; let updated_payment_intent = db diff --git a/crates/router/src/core/payments/transformers.rs b/crates/router/src/core/payments/transformers.rs index 636b1da0bbc..71ff92b0bb2 100644 --- a/crates/router/src/core/payments/transformers.rs +++ b/crates/router/src/core/payments/transformers.rs @@ -171,7 +171,7 @@ where connector_mandate_request_reference_id, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) } @@ -399,7 +399,7 @@ pub async fn construct_payment_router_data_for_authorize<'a>( connector_mandate_request_reference_id, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) @@ -563,7 +563,7 @@ pub async fn construct_payment_router_data_for_capture<'a>( connector_mandate_request_reference_id, psd2_sca_exemption_type: None, authentication_id: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) @@ -626,6 +626,7 @@ pub async fn construct_router_data_for_psync<'a>( // TODO: Get the charges object from feature metadata split_payments: None, payment_experience: None, + connector_reference_id: attempt.connector_response_reference_id.clone(), }; // TODO: evaluate the fields in router data, if they are required or not @@ -689,7 +690,7 @@ pub async fn construct_router_data_for_psync<'a>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) @@ -871,7 +872,7 @@ pub async fn construct_payment_router_data_for_sdk_session<'a>( connector_mandate_request_reference_id: None, psd2_sca_exemption_type: None, authentication_id: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) @@ -1088,7 +1089,7 @@ pub async fn construct_payment_router_data_for_setup_mandate<'a>( connector_mandate_request_reference_id, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) @@ -1287,7 +1288,7 @@ where connector_mandate_request_reference_id, authentication_id: None, psd2_sca_exemption_type: payment_data.payment_intent.psd2_sca_exemption_type, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) @@ -1477,7 +1478,7 @@ pub async fn construct_payment_router_data_for_update_metadata<'a>( connector_mandate_request_reference_id, authentication_id: None, psd2_sca_exemption_type: payment_data.payment_intent.psd2_sca_exemption_type, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) @@ -1524,6 +1525,7 @@ where Self: Sized, { #[cfg(feature = "v2")] + #[allow(clippy::too_many_arguments)] fn generate_response( self, state: &SessionState, @@ -1532,6 +1534,7 @@ where is_latency_header_enabled: Option<bool>, merchant_context: &domain::MerchantContext, profile: &domain::Profile, + connector_response_data: Option<common_types::domain::ConnectorResponseData>, ) -> RouterResponse<Response>; } @@ -1549,6 +1552,7 @@ where is_latency_header_enabled: Option<bool>, merchant_context: &domain::MerchantContext, profile: &domain::Profile, + _connector_response_data: Option<common_types::domain::ConnectorResponseData>, ) -> RouterResponse<api_models::payments::PaymentsCaptureResponse> { let payment_intent = &self.payment_intent; let payment_attempt = &self.payment_attempt; @@ -1872,6 +1876,7 @@ where is_latency_header_enabled: Option<bool>, merchant_context: &domain::MerchantContext, profile: &domain::Profile, + connector_response_data: Option<common_types::domain::ConnectorResponseData>, ) -> RouterResponse<api_models::payments::PaymentsResponse> { let payment_intent = self.payment_intent; let payment_attempt = self.payment_attempt; @@ -1897,6 +1902,9 @@ where let payment_address = self.payment_address; + let raw_connector_response = + connector_response_data.and_then(\|data\| data.raw_connector_response); + let payment_method_data = Some(api_models::payments::PaymentMethodDataResponseWithBilling { payment_method_data: None, @@ -1951,7 +1959,7 @@ where payment_method_subtype: Some(payment_attempt.payment_method_subtype), next_action, connector_transaction_id: payment_attempt.connector_payment_id.clone(), - connector_reference_id: None, + connector_reference_id: payment_attempt.connector_response_reference_id.clone(), connector_token_details, merchant_connector_id, browser_info: None, @@ -1965,6 +1973,7 @@ where shipping: None, //TODO: add this is_iframe_redirection_enabled: None, merchant_reference_id: payment_intent.merchant_reference_id.clone(), + raw_connector_response, }; Ok(services::ApplicationResponse::JsonWithHeaders(( @@ -1988,6 +1997,7 @@ where is_latency_header_enabled: Option<bool>, merchant_context: &domain::MerchantContext, profile: &domain::Profile, + connector_response_data: Option<common_types::domain::ConnectorResponseData>, ) -> RouterResponse<api_models::payments::PaymentsResponse> { let payment_intent = self.payment_intent; let payment_attempt = &self.payment_attempt; @@ -2022,6 +2032,9 @@ where .map(From::from), }); + let raw_connector_response = + connector_response_data.and_then(\|data\| data.raw_connector_response); + let connector_token_details = self .payment_attempt .connector_token_details @@ -2047,7 +2060,7 @@ where payment_method_type: Some(payment_attempt.payment_method_type), payment_method_subtype: Some(payment_attempt.payment_method_subtype), connector_transaction_id: payment_attempt.connector_payment_id.clone(), - connector_reference_id: None, + connector_reference_id: payment_attempt.connector_response_reference_id.clone(), merchant_connector_id, browser_info: None, connector_token_details, @@ -2060,6 +2073,7 @@ where return_url, is_iframe_redirection_enabled: payment_intent.is_iframe_redirection_enabled, merchant_reference_id: payment_intent.merchant_reference_id.clone(), + raw_connector_response, }; Ok(services::ApplicationResponse::JsonWithHeaders(( @@ -2083,6 +2097,7 @@ where _is_latency_header_enabled: Option<bool>, _merchant_context: &domain::MerchantContext, _profile: &domain::Profile, + _connector_response_data: Option<common_types::domain::ConnectorResponseData>, ) -> RouterResponse<api_models::payments::PaymentAttemptResponse> { let payment_attempt = self.payment_attempt; let response = api_models::payments::PaymentAttemptResponse::foreign_from(&payment_attempt); @@ -2107,6 +2122,7 @@ where _is_latency_header_enabled: Option<bool>, _merchant_context: &domain::MerchantContext, _profile: &domain::Profile, + _connector_response_data: Option<common_types::domain::ConnectorResponseData>, ) -> RouterResponse<api_models::payments::PaymentAttemptRecordResponse> { let payment_attempt = self.payment_attempt; let payment_intent = self.payment_intent; @@ -3718,6 +3734,10 @@ impl<F: Clone> TryFrom<PaymentAdditionalData<'_, F>> for types::PaymentsSyncData currency: payment_data.currency, split_payments: payment_data.payment_intent.split_payments, payment_experience: payment_data.payment_attempt.payment_experience, + connector_reference_id: payment_data + .payment_attempt + .connector_response_reference_id + .clone(), }) } } diff --git a/crates/router/src/core/relay/utils.rs b/crates/router/src/core/relay/utils.rs index effc2178ec3..1adacfbe949 100644 --- a/crates/router/src/core/relay/utils.rs +++ b/crates/router/src/core/relay/utils.rs @@ -143,7 +143,7 @@ pub async fn construct_relay_refund_router_data<F>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) diff --git a/crates/router/src/core/revenue_recovery/api.rs b/crates/router/src/core/revenue_recovery/api.rs index 3627d5062c6..052f4351c7e 100644 --- a/crates/router/src/core/revenue_recovery/api.rs +++ b/crates/router/src/core/revenue_recovery/api.rs @@ -31,7 +31,7 @@ pub async fn call_psync_api( force_sync: false, param: None, expand_attempts: true, - all_keys_required: None, + return_raw_connector_response: None, merchant_connector_details: None, }; let merchant_context_from_revenue_recovery_data = @@ -53,7 +53,7 @@ pub async fn call_psync_api( ) .await?; - let (payment_data, _req, _, _, _) = Box::pin(payments::payments_operation_core::< + let (payment_data, _req, _, _, _, _) = Box::pin(payments::payments_operation_core::< api_types::PSync, _, _, diff --git a/crates/router/src/core/unified_authentication_service/utils.rs b/crates/router/src/core/unified_authentication_service/utils.rs index 6c841a02d31..20ac12a9940 100644 --- a/crates/router/src/core/unified_authentication_service/utils.rs +++ b/crates/router/src/core/unified_authentication_service/utils.rs @@ -124,7 +124,7 @@ pub fn construct_uas_router_data<F: Clone, Req, Res>( connector_mandate_request_reference_id: None, authentication_id, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }) } diff --git a/crates/router/src/core/utils.rs b/crates/router/src/core/utils.rs index d1d298bd17b..c097b3fbfe6 100644 --- a/crates/router/src/core/utils.rs +++ b/crates/router/src/core/utils.rs @@ -234,7 +234,7 @@ pub async fn construct_payout_router_data<'a, F>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) @@ -401,7 +401,7 @@ pub async fn construct_refund_router_data<'a, F>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) @@ -604,7 +604,7 @@ pub async fn construct_refund_router_data<'a, F>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) @@ -1028,7 +1028,7 @@ pub async fn construct_accept_dispute_router_data<'a>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) } @@ -1126,7 +1126,7 @@ pub async fn construct_submit_evidence_router_data<'a>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) } @@ -1230,7 +1230,7 @@ pub async fn construct_upload_file_router_data<'a>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) } @@ -1353,7 +1353,7 @@ pub async fn construct_payments_dynamic_tax_calculation_router_data<F: Clone>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) } @@ -1454,7 +1454,7 @@ pub async fn construct_defend_dispute_router_data<'a>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) } @@ -1549,7 +1549,7 @@ pub async fn construct_retrieve_file_router_data<'a>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) } diff --git a/crates/router/src/core/webhooks/incoming_v2.rs b/crates/router/src/core/webhooks/incoming_v2.rs index 0cf8b2bfe7b..464781876cf 100644 --- a/crates/router/src/core/webhooks/incoming_v2.rs +++ b/crates/router/src/core/webhooks/incoming_v2.rs @@ -456,31 +456,37 @@ async fn payments_incoming_webhook_flow( ) .await?; - let (payment_data, _req, customer, connector_http_status_code, external_latency) = - Box::pin(payments::payments_operation_core::< - api::PSync, - _, - _, - _, - PaymentStatusData<api::PSync>, - >( - &state, - req_state, - merchant_context.clone(), - &profile, - payments::operations::PaymentGet, - api::PaymentsRetrieveRequest { - force_sync: true, - expand_attempts: false, - param: None, - all_keys_required: None, - merchant_connector_details: None, - }, - get_trackers_response, - consume_or_trigger_flow, - HeaderPayload::default(), - )) - .await?; + let ( + payment_data, + _req, + customer, + connector_http_status_code, + external_latency, + connector_response_data, + ) = Box::pin(payments::payments_operation_core::< + api::PSync, + _, + _, + _, + PaymentStatusData<api::PSync>, + >( + &state, + req_state, + merchant_context.clone(), + &profile, + payments::operations::PaymentGet, + api::PaymentsRetrieveRequest { + force_sync: true, + expand_attempts: false, + param: None, + return_raw_connector_response: None, + merchant_connector_details: None, + }, + get_trackers_response, + consume_or_trigger_flow, + HeaderPayload::default(), + )) + .await?; let response = payment_data.generate_response( &state, @@ -489,6 +495,7 @@ async fn payments_incoming_webhook_flow( None, &merchant_context, &profile, + Some(connector_response_data), ); lock_action diff --git a/crates/router/src/core/webhooks/utils.rs b/crates/router/src/core/webhooks/utils.rs index 4cf0d784a05..c0c362a9dd3 100644 --- a/crates/router/src/core/webhooks/utils.rs +++ b/crates/router/src/core/webhooks/utils.rs @@ -133,7 +133,7 @@ pub async fn construct_webhook_router_data( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) } diff --git a/crates/router/src/routes/payments.rs b/crates/router/src/routes/payments.rs index e2363633dad..163bc2dab2e 100644 --- a/crates/router/src/routes/payments.rs +++ b/crates/router/src/routes/payments.rs @@ -2953,7 +2953,7 @@ pub async fn payment_status( force_sync: payload.force_sync, expand_attempts: payload.expand_attempts, param: payload.param.clone(), - all_keys_required: payload.all_keys_required, + return_raw_connector_response: payload.return_raw_connector_response, merchant_connector_details: None, }; diff --git a/crates/router/src/services/api.rs b/crates/router/src/services/api.rs index 57bb8ec2427..fabfe3e38d2 100644 --- a/crates/router/src/services/api.rs +++ b/crates/router/src/services/api.rs @@ -142,7 +142,7 @@ pub async fn execute_connector_processing_step< req: &'b types::RouterData<T, Req, Resp>, call_connector_action: payments::CallConnectorAction, connector_request: Option<Request>, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> CustomResult<types::RouterData<T, Req, Resp>, errors::ConnectorError> where T: Clone + Debug + 'static, @@ -302,7 +302,7 @@ where val + external_latency }), ); - if all_keys_required == Some(true) { + if return_raw_connector_response == Some(true) { let mut decoded = String::from_utf8(body.response.as_ref().to_vec()) .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; if decoded.starts_with('\u{feff}') { @@ -310,7 +310,7 @@ where .trim_start_matches('\u{feff}') .to_string(); } - data.whole_connector_response = Some(decoded); + data.raw_connector_response = Some(decoded); } Ok(data) } @@ -1076,13 +1076,17 @@ pub trait Authenticate { None } - fn get_all_keys_required(&self) -> Option<bool> { + fn should_return_raw_response(&self) -> Option<bool> { None } } #[cfg(feature = "v2")] -impl Authenticate for api_models::payments::PaymentsConfirmIntentRequest {} +impl Authenticate for api_models::payments::PaymentsConfirmIntentRequest { + fn should_return_raw_response(&self) -> Option<bool> { + self.return_raw_connector_response + } +} #[cfg(feature = "v2")] impl Authenticate for api_models::payments::ProxyPaymentsRequest {} @@ -1092,7 +1096,9 @@ impl Authenticate for api_models::payments::PaymentsRequest { self.client_secret.as_ref() } - fn get_all_keys_required(&self) -> Option<bool> { + fn should_return_raw_response(&self) -> Option<bool> { + // In v1, this maps to `all_keys_required` to retain backward compatibility. + // The equivalent field in v2 is `return_raw_connector_response`. self.all_keys_required } } @@ -1123,7 +1129,15 @@ impl Authenticate for api_models::payments::PaymentsPostSessionTokensRequest { impl Authenticate for api_models::payments::PaymentsUpdateMetadataRequest {} impl Authenticate for api_models::payments::PaymentsRetrieveRequest { - fn get_all_keys_required(&self) -> Option<bool> { + #[cfg(feature = "v2")] + fn should_return_raw_response(&self) -> Option<bool> { + self.return_raw_connector_response + } + + #[cfg(feature = "v1")] + fn should_return_raw_response(&self) -> Option<bool> { + // In v1, this maps to `all_keys_required` to retain backward compatibility. + // The equivalent field in v2 is `return_raw_connector_response`. self.all_keys_required } } diff --git a/crates/router/src/types.rs b/crates/router/src/types.rs index 52e3f267c84..dd64c5b3703 100644 --- a/crates/router/src/types.rs +++ b/crates/router/src/types.rs @@ -1151,7 +1151,7 @@ impl<F1, F2, T1, T2> ForeignFrom<(&RouterData<F1, T1, PaymentsResponseData>, T2) .clone(), authentication_id: data.authentication_id.clone(), psd2_sca_exemption_type: data.psd2_sca_exemption_type, - whole_connector_response: data.whole_connector_response.clone(), + raw_connector_response: data.raw_connector_response.clone(), } } } @@ -1219,7 +1219,7 @@ impl<F1, F2> psd2_sca_exemption_type: None, additional_merchant_data: data.additional_merchant_data.clone(), connector_mandate_request_reference_id: None, - whole_connector_response: None, + raw_connector_response: None, } } } diff --git a/crates/router/src/types/api/payments.rs b/crates/router/src/types/api/payments.rs index 62738680b1b..02fad384f59 100644 --- a/crates/router/src/types/api/payments.rs +++ b/crates/router/src/types/api/payments.rs @@ -5,7 +5,8 @@ pub use api_models::payments::{ }; #[cfg(feature = "v1")] pub use api_models::payments::{ - PaymentListFilterConstraints, PaymentListResponse, PaymentListResponseV2, + PaymentListFilterConstraints, PaymentListResponse, PaymentListResponseV2, PaymentRetrieveBody, + PaymentRetrieveBodyWithCredentials, }; pub use api_models::{ feature_matrix::{ @@ -18,18 +19,17 @@ pub use api_models::{ MandateValidationFields, NextActionType, OpenBankingSessionToken, PayLaterData, PaymentIdType, PaymentListConstraints, PaymentListFilters, PaymentListFiltersV2, PaymentMethodData, PaymentMethodDataRequest, PaymentMethodDataResponse, PaymentOp, - PaymentRetrieveBody, PaymentRetrieveBodyWithCredentials, PaymentsAggregateResponse, - PaymentsApproveRequest, PaymentsCancelRequest, PaymentsCaptureRequest, - PaymentsCompleteAuthorizeRequest, PaymentsDynamicTaxCalculationRequest, - PaymentsDynamicTaxCalculationResponse, PaymentsExternalAuthenticationRequest, - PaymentsIncrementalAuthorizationRequest, PaymentsManualUpdateRequest, - PaymentsPostSessionTokensRequest, PaymentsPostSessionTokensResponse, - PaymentsRedirectRequest, PaymentsRedirectionResponse, PaymentsRejectRequest, - PaymentsRequest, PaymentsResponse, PaymentsResponseForm, PaymentsRetrieveRequest, - PaymentsSessionRequest, PaymentsSessionResponse, PaymentsStartRequest, - PaymentsUpdateMetadataRequest, PaymentsUpdateMetadataResponse, PgRedirectResponse, - PhoneDetails, RedirectionResponse, SessionToken, UrlDetails, VaultSessionDetails, - VerifyRequest, VerifyResponse, VgsSessionDetails, WalletData, + PaymentsAggregateResponse, PaymentsApproveRequest, PaymentsCancelRequest, + PaymentsCaptureRequest, PaymentsCompleteAuthorizeRequest, + PaymentsDynamicTaxCalculationRequest, PaymentsDynamicTaxCalculationResponse, + PaymentsExternalAuthenticationRequest, PaymentsIncrementalAuthorizationRequest, + PaymentsManualUpdateRequest, PaymentsPostSessionTokensRequest, + PaymentsPostSessionTokensResponse, PaymentsRedirectRequest, PaymentsRedirectionResponse, + PaymentsRejectRequest, PaymentsRequest, PaymentsResponse, PaymentsResponseForm, + PaymentsRetrieveRequest, PaymentsSessionRequest, PaymentsSessionResponse, + PaymentsStartRequest, PaymentsUpdateMetadataRequest, PaymentsUpdateMetadataResponse, + PgRedirectResponse, PhoneDetails, RedirectionResponse, SessionToken, UrlDetails, + VaultSessionDetails, VerifyRequest, VerifyResponse, VgsSessionDetails, WalletData, }, }; pub use common_types::payments::{AcceptanceType, CustomerAcceptance, OnlineMandate}; diff --git a/crates/router/src/types/api/verify_connector.rs b/crates/router/src/types/api/verify_connector.rs index c9be34037cb..8298be10aab 100644 --- a/crates/router/src/types/api/verify_connector.rs +++ b/crates/router/src/types/api/verify_connector.rs @@ -127,7 +127,7 @@ impl VerifyConnectorData { connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, } } } diff --git a/crates/router/tests/connectors/aci.rs b/crates/router/tests/connectors/aci.rs index 61272a05877..cf0889931d8 100644 --- a/crates/router/tests/connectors/aci.rs +++ b/crates/router/tests/connectors/aci.rs @@ -133,7 +133,7 @@ fn construct_payment_router_data() -> types::PaymentsAuthorizeRouterData { connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, } } @@ -206,7 +206,7 @@ fn construct_refund_router_data<F>() -> types::RefundsRouterData<F> { connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, } } diff --git a/crates/router/tests/connectors/utils.rs b/crates/router/tests/connectors/utils.rs index bf9bc355334..db3aeddfb8c 100644 --- a/crates/router/tests/connectors/utils.rs +++ b/crates/router/tests/connectors/utils.rs @@ -553,7 +553,7 @@ pub trait ConnectorActions: Connector { connector_mandate_request_reference_id: None, psd2_sca_exemption_type: None, authentication_id: None, - whole_connector_response: None, + raw_connector_response: None, } }	2025-06-30T11:36:23Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [ ] New feature - [ ] Enhancement - [x] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> This PR populates raw_connector_response for Payments when return_raw_connector_response is set to True. It also changes Payments Create and Psync endpoint for Razorpay connector. Additional Changes: - Introduces a struct ConnectorResponseData which sends raw_connector_response at core flows instead of it being in PaymentData (changed only in v2) - Rename `all_keys_required` as `return_raw_connector_response`, `get_all_keys_required()` as `should_return_raw_response()` , `whole_connector_response` as `raw_connector_response`. This rename is applied only on v2 Api and core flows to retain backward compatibility at v1. - `get_whole_connector_response()` and `get_all_keys_required()` at OperationSessionGetters are marked under v1 feature - `connector_response_reference_id` is updated in Payment_attempt at both update_trackers and post_update_trackers for v2. This is included in update_trackers in cases where Authorize flow is not performed at Connector End - Also marked this PaymentRetrieveBody, PaymentRetrieveBodyWithCredentials under v1 feature as it is not required in v2 flows ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> - Payments - Create ``` curl --location 'http://localhost:8080/v2/payments' \ --header 'Content-Type: application/json' \ --header 'x-profile-id: pro_L5WeuuGWl0EUYBhEEME1' \ --header 'Authorization: api-key=_' \ --data-raw '{ "amount_details": { "order_amount": 100, "currency": "INR" }, "capture_method":"automatic", "description": "Its my first payment request", "authentication_type": "no_three_ds", "return_url": "https://google.com", "payment_method_data": { "upi": { "upi_collect": { "vpa_id": "success@razorpay" } }, "billing": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "IN", "first_name": "Swangi", "last_name": "Kumari" }, "phone": { "number": "8056594427", "country_code": "+91" }, "email": "[email protected]" } }, "payment_method_subtype": "upi_collect", "payment_method_type": "upi", "return_raw_connector_response": true }' ``` Response ``` { "id": "12345_pay_0197c4e2b8087181963fdaae32be36b3", "status": "requires_customer_action", "amount": { "order_amount": 100, "currency": "INR", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null, "net_amount": 100, "amount_to_capture": null, "amount_capturable": 0, "amount_captured": null }, "customer_id": null, "connector": "razorpay", "created": "2025-07-01T07:28:02.057Z", "payment_method_data": { "billing": { "address": { "city": "San Fransico", "country": "IN", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "Swangi", "last_name": "Kumari" }, "phone": { "number": "8056594427", "country_code": "+91" }, "email": "[email protected]" } }, "payment_method_type": "upi", "payment_method_subtype": "upi_collect", "connector_transaction_id": "pay_Qnik5RSCB4oVjf", "connector_reference_id": "order_Qnik4SrNFCdv8H", "merchant_connector_id": "mca_GWx9LT38SlIQ1qNFfw1p", "browser_info": null, "error": null, "shipping": null, "billing": null, "attempts": null, "connector_token_details": null, "payment_method_id": null, "next_action": { "type": "wait_screen_information", "display_from_timestamp": 1751354885589516000, "display_to_timestamp": 1751355185589516000, "poll_config": { "delay_in_secs": 5, "frequency": 5 } }, "return_url": "https://google.com/", "authentication_type": "no_three_ds", "authentication_type_applied": "no_three_ds", "is_iframe_redirection_enabled": null, "merchant_reference_id": null, "raw_connector_response": "{\"razorpay_payment_id\":\"pay_Qnik5RSCB4oVjf\"}" } ``` - Payments - Retrieve ``` curl --location 'http://localhost:8080/v2/payments/12345_pay_0197c4e2b8087181963fdaae32be36b3?force_sync=true&return_raw_connector_response=true' \ --header 'x-profile-id: pro_L5WeuuGWl0EUYBhEEME1' \ --header 'Authorization: api-key=_' \ --data '' ``` Response ``` { "id": "12345_pay_0197c4e2b8087181963fdaae32be36b3", "status": "requires_capture", "amount": { "order_amount": 100, "currency": "INR", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null, "net_amount": 100, "amount_to_capture": null, "amount_capturable": 100, "amount_captured": 100 }, "customer_id": null, "connector": "razorpay", "created": "2025-07-01T07:36:11.733Z", "payment_method_data": { "billing": { "address": { "city": "San Fransico", "country": "IN", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "Swangi", "last_name": "Kumari" }, "phone": { "number": "8056594427", "country_code": "+91" }, "email": "[email protected]" } }, "payment_method_type": "upi", "payment_method_subtype": "upi_collect", "connector_transaction_id": "pay_Qnik5RSCB4oVjf", "connector_reference_id": "order_Qnik4SrNFCdv8H", "merchant_connector_id": "mca_GWx9LT38SlIQ1qNFfw1p", "browser_info": null, "error": null, "shipping": null, "billing": null, "attempts": null, "connector_token_details": null, "payment_method_id": null, "next_action": null, "return_url": "https://google.com/", "authentication_type": "no_three_ds", "authentication_type_applied": null, "is_iframe_redirection_enabled": null, "merchant_reference_id": null, "raw_connector_response": "{\"entity\":\"collection\",\"count\":1,\"items\":[{\"id\":\"pay_QnishOLxdHvKJ6\",\"entity\":\"payment\",\"amount\":100,\"currency\":\"INR\",\"status\":\"authorized\",\"order_id\":\"order_QnisgYZGQHtI92\",\"invoice_id\":null,\"international\":false,\"method\":\"upi\",\"amount_refunded\":0,\"refund_status\":null,\"captured\":false,\"description\":null,\"card_id\":null,\"bank\":null,\"wallet\":null,\"vpa\":\"success@razorpay\",\"email\":\"[email protected]\",\"contact\":\"+918056594427\",\"notes\":{\"optimizer_provider_name\":\"razorpay\"},\"fee\":null,\"tax\":null,\"error_code\":null,\"error_description\":null,\"error_source\":null,\"error_step\":null,\"error_reason\":null,\"acquirer_data\":{\"rrn\":\"216013077213\",\"upi_transaction_id\":\"614E93092FDA8E2A9FA28264CF769689\"},\"gateway_provider\":\"Razorpay\",\"created_at\":1751355374,\"upi\":{\"vpa\":\"success@razorpay\"}}]}" } ``` ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	c275e13caf22362173e77d2260b440159abcabb3	c275e13caf22362173e77d2260b440159abcabb3
juspay/hyperswitch	juspay__hyperswitch-8470	Bug: [FEATURE] allow a dummy connector to succeed for a failure card to show smart routing ### Feature Description Objective is to show user how smart retry works ### Possible Implementation stripe_test if the card number is 4000000000009995 previously it was failure with insufficient funds. But now we need to allow it to become success. ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? None	diff --git a/crates/router/src/routes/dummy_connector/utils.rs b/crates/router/src/routes/dummy_connector/utils.rs index 367c3bc63d4..0bec0398193 100644 --- a/crates/router/src/routes/dummy_connector/utils.rs +++ b/crates/router/src/routes/dummy_connector/utils.rs @@ -11,7 +11,10 @@ use super::{ consts, errors, types::{self, GetPaymentMethodDetails}, }; -use crate::{configs::settings, routes::SessionState}; +use crate::{ + configs::settings, + routes::{dummy_connector::types::DummyConnectors, SessionState}, +}; pub async fn tokio_mock_sleep(delay: u64, tolerance: u64) { let mut rng = rand::thread_rng(); @@ -219,7 +222,7 @@ impl ProcessPaymentAttempt for types::DummyConnectorCard { payment_attempt: types::DummyConnectorPaymentAttempt, redirect_url: String, ) -> types::DummyConnectorResult<types::DummyConnectorPaymentData> { - match self.get_flow_from_card_number()? { + match self.get_flow_from_card_number(payment_attempt.payment_request.connector.clone())? { types::DummyConnectorCardFlow::NoThreeDS(status, error) => { if let Some(error) = error { Err(error)?; @@ -291,6 +294,7 @@ impl types::DummyConnectorUpiCollect { impl types::DummyConnectorCard { pub fn get_flow_from_card_number( self, + connector: DummyConnectors, ) -> types::DummyConnectorResult<types::DummyConnectorCardFlow> { let card_number = self.number.peek(); match card_number.as_str() { @@ -309,12 +313,21 @@ impl types::DummyConnectorCard { }), )) } - "4000000000009995" => Ok(types::DummyConnectorCardFlow::NoThreeDS( - types::DummyConnectorStatus::Failed, - Some(errors::DummyConnectorErrors::PaymentDeclined { - message: "Insufficient funds", - }), - )), + "4000000000009995" => { + if connector == DummyConnectors::StripeTest { + Ok(types::DummyConnectorCardFlow::NoThreeDS( + types::DummyConnectorStatus::Succeeded, + None, + )) + } else { + Ok(types::DummyConnectorCardFlow::NoThreeDS( + types::DummyConnectorStatus::Failed, + Some(errors::DummyConnectorErrors::PaymentDeclined { + message: "Internal Server Error from Connector, Please try again later", + }), + )) + } + } "4000000000009987" => Ok(types::DummyConnectorCardFlow::NoThreeDS( types::DummyConnectorStatus::Failed, Some(errors::DummyConnectorErrors::PaymentDeclined {	2025-06-26T10:37:04Z	…rd payment ## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [ ] New feature - [x] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> For one connector alone to hard code success with a particular failure card ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> `stripe_test` if the card number is `4000000000009995` previously it was failure with insufficient funds. But now we need to allow it to become success. ## Motivation and Context Objective is to show user how smart retry works so a relevant error message will help ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> ## failure for other gateways <details> <summary>Request </summary> ```json { "amount": 333, "currency": "EUR", "confirm": true, "capture_method": "automatic", "payment_method": "card", "payment_method_type": "credit", "authentication_type": "no_three_ds", "description": "hellow world", "connector":["paypal_test"], "billing": { "address": { "zip": "560095", "country": "IN", "first_name": "Sakil", "last_name": "Mostak", "line1": "Fasdf", "line2": "Fasdf", "city": "Fasdf" } }, "payment_method_data": { "card": { "card_number": "4000000000009995", "card_exp_month": "01", "card_exp_year": "2026", "card_holder_name": "John Smith", "card_cvc": "100" } } } ``` </details> <details> <summary>Response</summary> ```json { "payment_id": "pay_04Vahgm5zSgQLH5y5o0S", "merchant_id": "merchant_1750933328", "status": "failed", "amount": 333, "net_amount": 333, "shipping_cost": null, "amount_capturable": 0, "amount_received": null, "connector": "paypal_test", "client_secret": "pay_04Vahgm5zSgQLH5y5o0S_secret_iKiVIRw76fiMFvPXCzU7", "created": "2025-06-26T10:32:26.951Z", "currency": "EUR", "customer_id": null, "customer": null, "description": "hellow world", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "card", "payment_method_data": { "card": { "last4": "9995", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "400000", "card_extended_bin": null, "card_exp_month": "01", "card_exp_year": "2026", "card_holder_name": "John Smith", "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": "Fasdf", "country": "IN", "line1": "Fasdf", "line2": "Fasdf", "line3": null, "zip": "560095", "state": null, "first_name": "Sakil", "last_name": "Mostak" }, "phone": null, "email": null }, "order_details": null, "email": null, "name": null, "phone": null, "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": null, "cancellation_reason": null, "error_code": "DC_08", "error_message": "Payment declined: Internal Server Error", "unified_code": "UE_9000", "unified_message": "Something went wrong", "payment_experience": null, "payment_method_type": "credit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": true, "connector_transaction_id": null, "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": null, "payment_link": null, "profile_id": "pro_tvhMochAzQxRKYmWKPgs", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_XioVM508jgIaVMwxgAsw", "incremental_authorization_allowed": false, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-06-26T10:47:26.951Z", "fingerprint": null, "browser_info": null, "payment_method_id": null, "payment_method_status": null, "updated": "2025-06-26T10:32:28.008Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` </details> ## success for `stripe_test` <details> <summary>Request</summary> ```json { "amount": 333, "currency": "EUR", "confirm": true, "capture_method": "automatic", "payment_method": "card", "payment_method_type": "credit", "authentication_type": "no_three_ds", "description": "hellow world", "connector":["stripe_test"], "billing": { "address": { "zip": "560095", "country": "IN", "first_name": "Sakil", "last_name": "Mostak", "line1": "Fasdf", "line2": "Fasdf", "city": "Fasdf" } }, "payment_method_data": { "card": { "card_number": "4000000000009995", "card_exp_month": "01", "card_exp_year": "2026", "card_holder_name": "John Smith", "card_cvc": "100" } } } ``` </details> <details> <summary>Response</summary> ```json { "payment_id": "pay_OqK97rLSs9s7NnwRvLV0", "merchant_id": "merchant_1750933328", "status": "succeeded", "amount": 333, "net_amount": 333, "shipping_cost": null, "amount_capturable": 0, "amount_received": 333, "connector": "stripe_test", "client_secret": "pay_OqK97rLSs9s7NnwRvLV0_secret_ZfXwEiZvzXjz0jiQFt7y", "created": "2025-06-26T10:39:21.936Z", "currency": "EUR", "customer_id": null, "customer": null, "description": "hellow world", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "card", "payment_method_data": { "card": { "last4": "9995", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "400000", "card_extended_bin": null, "card_exp_month": "01", "card_exp_year": "2026", "card_holder_name": "John Smith", "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": "Fasdf", "country": "IN", "line1": "Fasdf", "line2": "Fasdf", "line3": null, "zip": "560095", "state": null, "first_name": "Sakil", "last_name": "Mostak" }, "phone": null, "email": null }, "order_details": null, "email": null, "name": null, "phone": null, "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "credit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": false, "connector_transaction_id": "pay_LDgbgr5HUer6sqe8YSsq", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": null, "payment_link": null, "profile_id": "pro_tvhMochAzQxRKYmWKPgs", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_KNpkA14s7QSE6SE8SuUA", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-06-26T10:54:21.936Z", "fingerprint": null, "browser_info": null, "payment_method_id": null, "payment_method_status": null, "updated": "2025-06-26T10:39:22.945Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` </details> ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.114.0	ec6d0e4d62a530163ae1c806dcf40ccfd264b246	ec6d0e4d62a530163ae1c806dcf40ccfd264b246
juspay/hyperswitch	juspay__hyperswitch-8481	Bug: [BUG] GlobalPay throws 501 for mandates below function is the culprit: ```rs fn get_payment_method_data( item: &PaymentsAuthorizeRouterData, brand_reference: Option<String>, ) -> Result<PaymentMethodData, Error> { match &item.request.payment_method_data { payment_method_data::PaymentMethodData::Card(ccard) => { Ok(PaymentMethodData::Card(requests::Card { number: ccard.card_number.clone(), expiry_month: ccard.card_exp_month.clone(), expiry_year: ccard.get_card_expiry_year_2_digit()?, cvv: ccard.card_cvc.clone(), account_type: None, authcode: None, avs_address: None, avs_postal_code: None, brand_reference, chip_condition: None, funding: None, pin_block: None, tag: None, track: None, })) } payment_method_data::PaymentMethodData::Wallet(wallet_data) => get_wallet_data(wallet_data), payment_method_data::PaymentMethodData::BankRedirect(bank_redirect) => { PaymentMethodData::try_from(bank_redirect) } _ => Err(errors::ConnectorError::NotImplemented( "Payment methods".to_string(), ))?, } } ``` just because `MandatePayment` isn't covered, it falls back to the default case which throws `501`. relevant docs: - [Tokenization](https://developer.globalpay.com/api/payment-methods-tokenization#/Create/post-payment-method) - [MIT](https://developer.globalpay.com/docs/MIT) - [Recurring](https://developer.globalpay.com/docs/payments/recurring/credentials-on-file)	diff --git a/config/config.example.toml b/config/config.example.toml index 9454b3f0adc..c6ae6f75ec5 100644 --- a/config/config.example.toml +++ b/config/config.example.toml @@ -467,6 +467,7 @@ square = { long_lived_token = false, payment_method = "card" } braintree = { long_lived_token = false, payment_method = "card" } gocardless = { long_lived_token = true, payment_method = "bank_debit" } billwerk = { long_lived_token = false, payment_method = "card" } +globalpay = { long_lived_token = false, payment_method = "card", flow = "mandates" } [debit_routing_config] # Debit Routing configs supported_currencies = "USD" # Supported currencies for debit routing diff --git a/config/deployments/integration_test.toml b/config/deployments/integration_test.toml index ddff65fa9c0..426b3ba808a 100644 --- a/config/deployments/integration_test.toml +++ b/config/deployments/integration_test.toml @@ -748,6 +748,7 @@ square = { long_lived_token = false, payment_method = "card" } stax = { long_lived_token = true, payment_method = "card,bank_debit" } stripe = { long_lived_token = false, payment_method = "wallet", payment_method_type = { list = "google_pay", type = "disable_only" } } billwerk = {long_lived_token = false, payment_method = "card"} +globalpay = { long_lived_token = false, payment_method = "card", flow = "mandates" } [webhooks] outgoing_enabled = true diff --git a/config/deployments/production.toml b/config/deployments/production.toml index 11d96d6269f..7c5cc65f2ca 100644 --- a/config/deployments/production.toml +++ b/config/deployments/production.toml @@ -758,6 +758,7 @@ square = { long_lived_token = false, payment_method = "card" } stax = { long_lived_token = true, payment_method = "card,bank_debit" } stripe = { long_lived_token = false, payment_method = "wallet", payment_method_type = { list = "google_pay", type = "disable_only" } } billwerk = {long_lived_token = false, payment_method = "card"} +globalpay = { long_lived_token = false, payment_method = "card", flow = "mandates" } [webhooks] outgoing_enabled = true diff --git a/config/deployments/sandbox.toml b/config/deployments/sandbox.toml index a372c873c78..305210ecb64 100644 --- a/config/deployments/sandbox.toml +++ b/config/deployments/sandbox.toml @@ -764,6 +764,7 @@ square = { long_lived_token = false, payment_method = "card" } stax = { long_lived_token = true, payment_method = "card,bank_debit" } stripe = { long_lived_token = false, payment_method = "wallet", payment_method_type = { list = "google_pay", type = "disable_only" } } billwerk = {long_lived_token = false, payment_method = "card"} +globalpay = { long_lived_token = false, payment_method = "card", flow = "mandates" } [webhooks] outgoing_enabled = true diff --git a/config/development.toml b/config/development.toml index 173d9363f2a..a3078b05089 100644 --- a/config/development.toml +++ b/config/development.toml @@ -895,6 +895,7 @@ braintree = { long_lived_token = false, payment_method = "card" } payme = { long_lived_token = false, payment_method = "card" } gocardless = { long_lived_token = true, payment_method = "bank_debit" } billwerk = { long_lived_token = false, payment_method = "card" } +globalpay = { long_lived_token = false, payment_method = "card", flow = "mandates" } [temp_locker_enable_config] stripe = { payment_method = "bank_transfer" } diff --git a/config/docker_compose.toml b/config/docker_compose.toml index 01abf5e8137..621b437bd28 100644 --- a/config/docker_compose.toml +++ b/config/docker_compose.toml @@ -390,6 +390,7 @@ hipay = { long_lived_token = false, payment_method = "card" } braintree = { long_lived_token = false, payment_method = "card" } gocardless = { long_lived_token = true, payment_method = "bank_debit" } billwerk = { long_lived_token = false, payment_method = "card" } +globalpay = { long_lived_token = false, payment_method = "card", flow = "mandates" } [temp_locker_enable_config] stripe = { payment_method = "bank_transfer" } diff --git a/crates/hyperswitch_connectors/src/connectors/globalpay.rs b/crates/hyperswitch_connectors/src/connectors/globalpay.rs index 7e9ad1aa820..215c8322dff 100644 --- a/crates/hyperswitch_connectors/src/connectors/globalpay.rs +++ b/crates/hyperswitch_connectors/src/connectors/globalpay.rs @@ -34,7 +34,7 @@ use hyperswitch_domain_models::{ types::{ PaymentsAuthorizeRouterData, PaymentsCancelRouterData, PaymentsCaptureRouterData, PaymentsCompleteAuthorizeRouterData, PaymentsSyncRouterData, RefundSyncRouterData, - RefundsRouterData, + RefundsRouterData, TokenizationRouterData, }, }; use hyperswitch_interfaces::{ @@ -49,7 +49,7 @@ use hyperswitch_interfaces::{ types::{ PaymentsAuthorizeType, PaymentsCaptureType, PaymentsCompleteAuthorizeType, PaymentsSyncType, PaymentsVoidType, RefreshTokenType, RefundExecuteType, RefundSyncType, - Response, + Response, TokenizationType, }, webhooks::{IncomingWebhook, IncomingWebhookRequestDetails}, }; @@ -61,6 +61,7 @@ use response::{ use serde_json::Value; use crate::{ + connectors::globalpay::response::GlobalpayPaymentMethodsResponse, constants::headers, types::{RefreshTokenRouterData, ResponseRouterData}, utils::{ @@ -381,7 +382,79 @@ impl api::PaymentToken for Globalpay {} impl ConnectorIntegration<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData> for Globalpay { - // Not Implemented (R) + fn get_headers( + &self, + req: &TokenizationRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + fn get_url( + &self, + _req: &TokenizationRouterData, + connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Ok(format!("{}/payment-methods", self.base_url(connectors),)) + } + + fn build_request( + &self, + req: &TokenizationRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&TokenizationType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(TokenizationType::get_headers(self, req, connectors)?) + .set_body(TokenizationType::get_request_body(self, req, connectors)?) + .build(), + )) + } + + fn get_request_body( + &self, + req: &TokenizationRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let connector_req = requests::GlobalPayPaymentMethodsRequest::try_from(req)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn handle_response( + &self, + data: &TokenizationRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<TokenizationRouterData, errors::ConnectorError> { + let response: GlobalpayPaymentMethodsResponse = res + .response + .parse_struct("GlobalpayPaymentMethodsResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + .change_context(errors::ConnectorError::ResponseHandlingFailed) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } } impl api::MandateSetup for Globalpay {} diff --git a/crates/hyperswitch_connectors/src/connectors/globalpay/requests.rs b/crates/hyperswitch_connectors/src/connectors/globalpay/requests.rs index 45749332081..056e546db20 100644 --- a/crates/hyperswitch_connectors/src/connectors/globalpay/requests.rs +++ b/crates/hyperswitch_connectors/src/connectors/globalpay/requests.rs @@ -16,78 +16,17 @@ pub struct GlobalpayCancelRouterData<T> { #[derive(Debug, Serialize)] pub struct GlobalpayPaymentsRequest { - /// A meaningful label for the merchant account set by Global Payments. pub account_name: Secret<String>, - /// The amount to transfer between Payer and Merchant for a SALE or a REFUND. It is always - /// represented in the lowest denomiation of the related currency. pub amount: Option<StringMinorUnit>, - /// Indicates if the merchant would accept an authorization for an amount less than the - /// requested amount. This is available for CP channel - /// only where the balance not authorized can be processed again using a different card. - pub authorization_mode: Option<AuthorizationMode>, - /// Indicates whether the transaction is to be captured automatically, later or later using - /// more than 1 partial capture. + pub currency: String, + pub reference: String, + pub country: api_models::enums::CountryAlpha2, pub capture_mode: Option<CaptureMode>, - /// The amount of the transaction that relates to cashback.It is always represented in the - /// lowest denomiation of the related currency. - pub cashback_amount: Option<StringMinorUnit>, - /// Describes whether the transaction was processed in a face to face(CP) scenario or a - /// Customer Not Present (CNP) scenario. + pub notifications: Option<Notifications>, + pub payment_method: GlobalPayPaymentMethodData, pub channel: Channel, - /// The amount that reflects the charge the merchant applied to the transaction for availing - /// of a more convenient purchase.It is always represented in the lowest denomiation of the - /// related currency. - pub convenience_amount: Option<StringMinorUnit>, - /// The country in ISO-3166-1(alpha-2 code) format. - pub country: api_models::enums::CountryAlpha2, - /// The currency of the amount in ISO-4217(alpha-3) - pub currency: String, - - pub currency_conversion: Option<CurrencyConversion>, - /// Merchant defined field to describe the transaction. - pub description: Option<String>, - - pub device: Option<Device>, - /// The amount of the gratuity for a transaction.It is always represented in the lowest - /// denomiation of the related currency. - pub gratuity_amount: Option<StringMinorUnit>, - /// Indicates whether the Merchant or the Payer initiated the creation of a transaction. pub initiator: Option<Initiator>, - /// Indicates the source IP Address of the system used to create the transaction. - pub ip_address: Option<Secret<String, common_utils::pii::IpAddress>>, - /// Indicates the language the transaction was executed in. In the format ISO-639-1 (alpha-2) - /// or ISO-639-1 (alpha-2)_ISO-3166(alpha-2) - pub language: Option<Language>, - - pub lodging: Option<Lodging>, - /// Indicates to Global Payments where the merchant wants to receive notifications of certain - /// events that occur on the Global Payments system. - pub notifications: Option<Notifications>, - - pub order: Option<Order>, - /// The merchant's payer reference for the transaction - pub payer_reference: Option<String>, - pub payment_method: PaymentMethod, - /// Merchant defined field to reference the transaction. - pub reference: String, - /// A merchant defined reference for the location that created the transaction. - pub site_reference: Option<String>, - /// Stored data information used to create a transaction. pub stored_credential: Option<StoredCredential>, - /// The amount that reflects the additional charge the merchant applied to the transaction - /// for using a specific payment method.It is always represented in the lowest denomiation of - /// the related currency. - pub surcharge_amount: Option<StringMinorUnit>, - /// Indicates the total or expected total of captures that will executed against a - /// transaction flagged as being captured multiple times. - pub total_capture_count: Option<i64>, - /// Describes whether the transaction is a SALE, that moves funds from Payer to Merchant, or - /// a REFUND where funds move from Merchant to Payer. - #[serde(rename = "type")] - pub globalpay_payments_request_type: Option<GlobalpayPaymentsRequestType>, - /// The merchant's user reference for the transaction. This represents the person who - /// processed the transaction on the merchant's behalf like a clerk or cashier reference. - pub user_reference: Option<String>, } #[derive(Debug, Serialize)] @@ -98,256 +37,60 @@ pub struct GlobalpayRefreshTokenRequest { pub grant_type: String, } -#[derive(Debug, Serialize, Deserialize)] -pub struct CurrencyConversion { - /// A unique identifier generated by Global Payments to identify the currency conversion. It - /// can be used to reference a currency conversion when processing a sale or a refund - /// transaction. - pub id: Option<String>, -} - -#[derive(Debug, Serialize, Deserialize)] -pub struct Device { - pub capabilities: Option<Capabilities>, - - pub entry_modes: Option<Vec<Vec<DeviceEntryMode>>>, - /// Describes whether a device prompts a payer for a gratuity when the payer is entering - /// their payment method details to the device. - pub gratuity_prompt_mode: Option<GratuityPromptMode>, - /// Describes the receipts a device prints when processing a transaction. - pub print_receipt_mode: Option<PrintReceiptMode>, - /// The sequence number from the device used to align with processing platform. - pub sequence_number: Option<Secret<String>>, - /// A unique identifier for the physical device. This value persists with the device even if - /// it is repurposed. - pub serial_number: Option<Secret<String>>, - /// The time from the device in ISO8601 format - pub time: Option<String>, -} - -#[derive(Debug, Serialize, Deserialize)] -pub struct Capabilities { - pub authorization_modes: Option<Vec<AuthorizationMode>>, - /// The number of lines that can be used to display information on the device. - pub display_line_count: Option<f64>, - - pub enabled_response: Option<Vec<EnabledResponse>>, - - pub entry_modes: Option<Vec<CapabilitiesEntryMode>>, - - pub fraud: Option<Vec<AuthorizationMode>>, - - pub mobile: Option<Vec<Mobile>>, - - pub payer_verifications: Option<Vec<PayerVerification>>, -} - -#[derive(Debug, Serialize, Deserialize)] -pub struct Lodging { - /// A reference that identifies the booking reference for a lodging stay. - pub booking_reference: Option<String>, - /// The amount charged for one nights lodging. - pub daily_rate_amount: Option<StringMinorUnit>, - /// A reference that identifies the booking reference for a lodging stay. - pub date_checked_in: Option<String>, - /// The check out date for a lodging stay. - pub date_checked_out: Option<String>, - /// The total number of days of the lodging stay. - pub duration_days: Option<f64>, - #[serde(rename = "lodging.charge_items")] - pub lodging_charge_items: Option<Vec<LodgingChargeItem>>, -} - -#[derive(Debug, Serialize, Deserialize)] -pub struct LodgingChargeItem { - pub payment_method_program_codes: Option<Vec<PaymentMethodProgramCode>>, - /// A reference that identifies the charge item, such as a lodging folio number. - pub reference: Option<String>, - /// The total amount for the list of charge types for a charge item. - pub total_amount: Option<StringMinorUnit>, - - pub types: Option<Vec<TypeElement>>, -} - -/// Indicates to Global Payments where the merchant wants to receive notifications of certain -/// events that occur on the Global Payments system. #[derive(Debug, Serialize, Deserialize, Default)] pub struct Notifications { - /// The merchant URL that will receive the notification when the customer has completed the - /// authentication. - pub challenge_return_url: Option<String>, - /// The merchant URL that will receive the notification when the customer has completed the - /// authentication when the authentication is decoupled and separate to the purchase. - pub decoupled_challenge_return_url: Option<String>, - /// The merchant URL to return the payer to, once the payer has completed payment using the - /// payment method. This returns control of the payer's payment experience to the merchant. pub return_url: Option<String>, - /// The merchant URL to notify the merchant of the latest status of the transaction. pub status_url: Option<String>, - /// The merchant URL that will receive the notification when the 3DS ACS successfully gathers - /// de ice informatiSon and tonotification_configurations.cordingly. - pub three_ds_method_return_url: Option<String>, - /// The URL on merchant's website to which the customer should be redirected in the event of - /// the customer canceling the transaction. pub cancel_url: Option<String>, } -#[derive(Debug, Serialize, Deserialize)] -pub struct Order { - /// Merchant defined field common to all transactions that are part of the same order. - pub reference: Option<String>, -} - #[derive(Debug, Serialize, Deserialize)] #[serde(rename_all = "snake_case")] pub enum PaymentMethodData { Card(Card), Apm(Apm), - BankTransfer(BankTransfer), DigitalWallet(DigitalWallet), + Token(TokenizationData), } #[derive(Debug, Serialize, Deserialize)] -pub struct PaymentMethod { +pub struct CommonPaymentMethodData { #[serde(flatten)] pub payment_method_data: PaymentMethodData, - pub authentication: Option<Authentication>, - pub encryption: Option<Encryption>, - /// Indicates how the payment method information was obtained by the Merchant for this - /// transaction. pub entry_mode: PaymentMethodEntryMode, - /// Indicates whether to execute the fingerprint signature functionality. - pub fingerprint_mode: Option<FingerprintMode>, - /// Specify the first name of the owner of the payment method. - pub first_name: Option<Secret<String>>, - /// Unique Global Payments generated id used to reference a stored payment method on the - /// Global Payments system. Often referred to as the payment method token. This value can be - /// used instead of payment method details such as a card number and expiry date. - pub id: Option<Secret<String>>, - /// Specify the surname of the owner of the payment method. - pub last_name: Option<Secret<String>>, - /// The full name of the owner of the payment method. - pub name: Option<Secret<String>>, - /// Contains the value a merchant wishes to appear on the payer's payment method statement - /// for this transaction - pub narrative: Option<String>, - /// Indicates whether to store the card as part of a transaction. - pub storage_mode: Option<CardStorageMode>, -} - -#[derive(Debug, Serialize, Deserialize)] -pub struct Apm { - /// A string used to identify the payment method provider being used to execute this - /// transaction. - pub provider: Option<ApmProvider>, -} - -/// Information outlining the degree of authentication executed related to a transaction. -#[derive(Debug, Serialize, Deserialize)] -pub struct Authentication { - /// Information outlining the degree of 3D Secure authentication executed. - pub three_ds: Option<ThreeDs>, - /// A message authentication code that is used to confirm the security and integrity of the - /// messaging to Global Payments. - pub mac: Option<String>, } -/// Information outlining the degree of 3D Secure authentication executed. #[derive(Debug, Serialize, Deserialize)] -pub struct ThreeDs { - /// The reference created by the 3DSecure Directory Server to identify the specific - /// authentication attempt. - pub ds_trans_reference: Option<String>, - /// An indication of the degree of the authentication and liability shift obtained for this - /// transaction. It is determined during the 3D Secure process. 2 or 1 for Mastercard - /// indicates the merchant has a liability shift. 5 or 6 for Visa or Amex indicates the - /// merchant has a liability shift. However for Amex if the payer is not enrolled the eci may - /// still be 6 but liability shift has not bee achieved. - pub eci: Option<String>, - /// Indicates if any exemptions apply to this transaction. - pub exempt_status: Option<ExemptStatus>, - /// Indicates the version of 3DS - pub message_version: Option<String>, - /// The reference created by the 3DSecure provider to identify the specific authentication - /// attempt. - pub server_trans_reference: Option<String>, - /// The authentication value created as part of the 3D Secure process. - pub value: Option<String>, +pub struct MandatePaymentMethodData { + pub entry_mode: PaymentMethodEntryMode, + pub id: Option<String>, } #[derive(Debug, Serialize, Deserialize)] -pub struct BankTransfer { - /// The number or reference for the payer's bank account. - pub account_number: Option<Secret<String>>, - - pub bank: Option<Bank>, - /// The number or reference for the check - pub check_reference: Option<Secret<String>>, - /// The type of bank account associated with the payer's bank account. - pub number_type: Option<NumberType>, - /// Indicates how the transaction was authorized by the merchant. - pub sec_code: Option<SecCode>, -} -#[derive(Debug, Serialize, Deserialize)] -pub struct Bank { - pub address: Option<Address>, - /// The local identifier code for the bank. - pub code: Option<Secret<String>>, - /// The name of the bank. - pub name: Option<String>, +#[serde(untagged)] +pub enum GlobalPayPaymentMethodData { + Common(CommonPaymentMethodData), + Mandate(MandatePaymentMethodData), } #[derive(Debug, Serialize, Deserialize)] -pub struct Address { - /// Merchant defined field common to all transactions that are part of the same order. - pub city: Option<Secret<String>>, - /// The country in ISO-3166-1(alpha-2 code) format. - pub country: Option<String>, - /// First line of the address. - pub line_1: Option<Secret<String>>, - /// Second line of the address. - pub line_2: Option<Secret<String>>, - /// Third line of the address. - pub line_3: Option<Secret<String>>, - /// The city or town of the address. - pub postal_code: Option<Secret<String>>, - /// The state or region of the address. ISO 3166-2 minus the country code itself. For - /// example, US Illinois = IL, or in the case of GB counties Wiltshire = WI or Aberdeenshire - /// = ABD - pub state: Option<String>, +pub struct Apm { + /// A string used to identify the payment method provider being used to execute this + /// transaction. + pub provider: Option<ApmProvider>, } #[derive(Debug, Default, Serialize, Deserialize)] pub struct Card { - /// The card providers description of their card product. - pub account_type: Option<String>, - /// Code generated when the card is successfully authorized. - pub authcode: Option<Secret<String>>, - /// First line of the address associated with the card. - pub avs_address: Option<String>, - /// Postal code of the address associated with the card. - pub avs_postal_code: Option<String>, - /// The unique reference created by the brands/schemes to uniquely identify the transaction. - pub brand_reference: Option<String>, - /// Indicates if a fallback mechanism was used to obtain the card information when EMV/chip - /// did not work as expected. - pub chip_condition: Option<ChipCondition>, - /// The numeric value printed on the physical card. pub cvv: Secret<String>, - /// The 2 digit expiry date month of the card. pub expiry_month: Secret<String>, - /// The 2 digit expiry date year of the card. pub expiry_year: Secret<String>, - /// Indicates whether the card is a debit or credit card. - pub funding: Option<Funding>, - /// The card account number used to authorize the transaction. Also known as PAN. pub number: cards::CardNumber, - /// Contains the pin block info, relating to the pin code the Payer entered. - pub pin_block: Option<Secret<String>>, - /// The full card tag data for an EMV/chip card transaction. - pub tag: Option<Secret<String>>, - /// Data from magnetic stripe of a card - pub track: Option<Secret<String>>, +} + +#[derive(Debug, Default, Serialize, Deserialize)] +pub struct TokenizationData { + pub brand_reference: Option<String>, } #[derive(Debug, Serialize, Deserialize)] @@ -358,16 +101,6 @@ pub struct DigitalWallet { pub payment_token: Option<serde_json::Value>, } -#[derive(Debug, Serialize, Deserialize)] -pub struct Encryption { - /// The encryption info used when sending encrypted card data to Global Payments. - pub info: Option<Secret<String>>, - /// The encryption method used when sending encrypted card data to Global Payments. - pub method: Option<Method>, - /// The version of encryption being used. - pub version: Option<String>, -} - /// Stored data information used to create a transaction. #[derive(Debug, Serialize, Deserialize)] pub struct StoredCredential { @@ -379,22 +112,6 @@ pub struct StoredCredential { pub sequence: Option<Sequence>, } -/// Indicates if the merchant would accept an authorization for an amount less than the -/// requested amount. This is available for CP channel -/// only where the balance not authorized can be processed again using a different card. -/// -/// Describes the instruction a device can indicate to the clerk in the case of fraud. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum AuthorizationMode { - /// Indicates merchant would accept an authorization for an amount less than the - /// requested amount. - /// pub example: PARTIAL - /// - /// Describes whether the device can process partial authorizations. - Partial, -} - /// Indicates whether the transaction is to be captured automatically, later or later using /// more than 1 partial capture. #[derive(Debug, Serialize, Deserialize)] @@ -432,88 +149,6 @@ pub enum Channel { CustomerPresent, } -/// Describes the data the device can handle when it receives a response for a card -/// authorization. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum EnabledResponse { - Avs, - BrandReference, - Cvv, - MaskedNumberLast4, -} - -/// Describes the entry mode capabilities a device has. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum CapabilitiesEntryMode { - Chip, - Contactless, - ContactlessSwipe, - Manual, - Swipe, -} - -/// Describes the mobile features a device has -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum Mobile { - IntegratedCardReader, - SeparateCardReader, -} - -/// Describes the capabilities a device has to verify a payer. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum PayerVerification { - ContactlessSignature, - PayerDevice, - Pinpad, -} - -/// Describes the allowed entry modes to obtain payment method information from the payer as -/// part of a transaction request. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum DeviceEntryMode { - Chip, - Contactless, - Manual, - Swipe, -} - -/// Describes whether a device prompts a payer for a gratuity when the payer is entering -/// their payment method details to the device. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum GratuityPromptMode { - NotRequired, - Prompt, -} - -/// Describes the receipts a device prints when processing a transaction. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum PrintReceiptMode { - Both, - Merchant, - None, - Payer, -} - -/// Describes whether the transaction is a SALE, that moves funds from Payer to Merchant, or -/// a REFUND where funds move from Merchant to Payer. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum GlobalpayPaymentsRequestType { - /// indicates the movement, or the attempt to move, funds from merchant to the - /// payer. - Refund, - /// indicates the movement, or the attempt to move, funds from payer to a - /// merchant. - Sale, -} - /// Indicates whether the Merchant or the Payer initiated the creation of a transaction. #[derive(Debug, Serialize, Deserialize)] #[serde(rename_all = "SCREAMING_SNAKE_CASE")] @@ -525,45 +160,6 @@ pub enum Initiator { Payer, } -/// Indicates the language the transaction was executed in. In the format ISO-639-1 (alpha-2) -/// or ISO-639-1 (alpha-2)_ISO-3166(alpha-2) -#[derive(Debug, Serialize, Deserialize)] -pub enum Language { - #[serde(rename = "fr")] - Fr, - #[serde(rename = "fr_CA")] - FrCa, - #[serde(rename = "ISO-639(alpha-2)")] - Iso639Alpha2, - #[serde(rename = "ISO-639(alpha-2)_ISO-3166(alpha-2)")] - Iso639alpha2Iso3166alpha2, -} - -/// Describes the payment method programs, typically run by card brands such as Amex, Visa -/// and MC. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum PaymentMethodProgramCode { - AssuredReservation, - CardDeposit, - Other, - Purchase, -} - -/// Describes the types of charges associated with a transaction. This can be one or more -/// than more charge type. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum TypeElement { - GiftShop, - Laundry, - MiniBar, - NoShow, - Other, - Phone, - Restaurant, -} - /// A string used to identify the payment method provider being used to execute this /// transaction. #[derive(Debug, Serialize, Deserialize)] @@ -577,87 +173,6 @@ pub enum ApmProvider { Testpay, } -/// Indicates if any exemptions apply to this transaction. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum ExemptStatus { - LowValue, - ScaDelegation, - SecureCorporatePayment, - TransactionRiskAnalysis, - TrustedMerchant, -} - -/// The type of bank account associated with the payer's bank account. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum NumberType { - Checking, - Savings, -} - -/// Indicates how the transaction was authorized by the merchant. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum SecCode { - /// Cash Concentration or Disbursement - Can be either a credit or debit application - /// where funds are wither distributed or consolidated between corporate entities. - #[serde(rename = "CCD")] - CashConcentrationOrDisbursement, - - /// Point of Sale Entry - Point of sale debit applications non-shared (POS) - /// environment. These transactions are most often initiated by the consumer via a plastic - /// access card. This is only support for normal ACH transactions - #[serde(rename = "POP")] - PointOfSaleEntry, - /// Prearranged Payment and Deposits - used to credit or debit a consumer account. - /// Popularity used for payroll direct deposits and pre-authorized bill payments. - #[serde(rename = "PPD")] - PrearrangedPaymentAndDeposits, - /// Telephone-Initiated Entry - Used for the origination of a single entry debit - /// transaction to a consumer's account pursuant to a verbal authorization obtained from the - /// consumer via the telephone. - #[serde(rename = "TEL")] - TelephoneInitiatedEntry, - /// Internet (Web)-Initiated Entry - Used for the origination of debit entries - /// (either Single or Recurring Entry) to a consumer's account pursuant to a to an - /// authorization that is obtained from the Receiver via the Internet. - #[serde(rename = "WEB")] - WebInitiatedEntry, -} - -/// Indicates if a fallback mechanism was used to obtain the card information when EMV/chip -/// did not work as expected. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum ChipCondition { - /// indicates the previous transaction with this card failed. - PrevFailed, - /// indicates the previous transaction with this card was a success. - PrevSuccess, -} - -/// Indicates whether the card is a debit or credit card. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum Funding { - /// indicates the card is an, Electronic Benefits Transfer, for cash - /// benefits. - CashBenefits, - /// indicates the card is a credit card where the funds may be available on credit - /// to the payer to fulfill the transaction amount. - Credit, - /// indicates the card is a debit card where the funds may be present in an account - /// to fulfill the transaction amount. - Debit, - /// indicates the card is an, Electronic Benefits Transfer, for food stamps. - FoodStamp, - /// indicates the card is a prepaid card where the funds are loaded to the card - /// account to fulfill the transaction amount. Unlike a debit card, a prepaid is not linked - /// to a bank account. - Prepaid, -} - /// Identifies who provides the digital wallet for the Payer. #[derive(Debug, Serialize, Deserialize)] #[serde(rename_all = "SCREAMING_SNAKE_CASE")] @@ -666,27 +181,6 @@ pub enum DigitalWalletProvider { PayByGoogle, } -/// Indicates if the actual card number or a token is being used to process the -/// transaction. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum TokenFormat { - /// The value in the digital wallet token field is a real card number - /// (PAN) - CardNumber, - /// The value in the digital wallet token field is a temporary token in the - /// format of a card number (PAN) but is not a real card number. - CardToken, -} - -/// The encryption method used when sending encrypted card data to Global Payments. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum Method { - Ksn, - Ktb, -} - /// Indicates how the payment method information was obtained by the Merchant for this /// transaction. #[derive(Debug, Default, Serialize, Deserialize)] @@ -727,30 +221,6 @@ pub enum PaymentMethodEntryMode { Swipe, } -/// Indicates whether to execute the fingerprint signature functionality. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum FingerprintMode { - /// Always check and create the fingerprint value regardless of the result of the - /// card authorization. - Always, - /// Always check and create the fingerprint value when the card authorization - /// is successful. - OnSuccess, -} - -/// Indicates whether to store the card as part of a transaction. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum CardStorageMode { - /// /// The card information is always stored irrespective of whether the payment - /// method authorization was successful or not. - Always, - /// The card information is only stored if the payment method authorization was - /// successful. - OnSuccess, -} - /// Indicates the transaction processing model being executed when using stored /// credentials. #[derive(Debug, Serialize, Deserialize)] @@ -775,17 +245,6 @@ pub enum Model { Unscheduled, } -/// The reason stored credentials are being used to create a transaction. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum Reason { - Delayed, - Incremental, - NoShow, - Reauthorization, - Resubmission, -} - /// Indicates the order of this transaction in the sequence of a planned repeating /// transaction processing model. #[derive(Debug, Serialize, Deserialize)] @@ -812,3 +271,34 @@ pub struct GlobalpayCaptureRequest { pub struct GlobalpayCancelRequest { pub amount: Option<StringMinorUnit>, } + +#[derive(Default, Debug, Serialize, Deserialize)] +#[serde(rename_all = "SCREAMING_SNAKE_CASE")] +pub enum UsageMode { + /// This value must be used if using the Hosted Fields or the Drop-in UI integration types. + /// When creating the payment method token, this option ensures the payment method token is temporary and will be removed once a transaction is executed or after a short period of time. + #[default] + Single, + /// When creating the payment method token, this indicates it is permanent and can be used to create many transactions. + Multiple, + /// When using the payment method token to transaction process, this indicates to use the card number also known as the PAN or FPAN when both the card number and the network token are available. + UseCardNumber, + /// When using the payment method token to transaction process, this indicates to use the network token instead of the card number if both are available. + UseNetworkToken, +} + +#[derive(Default, Debug, Serialize, Deserialize)] +pub struct GlobalPayPayer { + /// Unique identifier for the Payer on the Global Payments system. + #[serde(rename = "id", skip_serializing_if = "Option::is_none")] + pub payer_id: Option<String>, +} + +#[derive(Default, Debug, Serialize)] +pub struct GlobalPayPaymentMethodsRequest { + pub reference: String, + #[serde(skip_serializing_if = "Option::is_none")] + pub usage_mode: Option<UsageMode>, + #[serde(skip_serializing_if = "Option::is_none")] + pub card: Option<Card>, +} diff --git a/crates/hyperswitch_connectors/src/connectors/globalpay/response.rs b/crates/hyperswitch_connectors/src/connectors/globalpay/response.rs index 11bd9e1a047..daa629641e6 100644 --- a/crates/hyperswitch_connectors/src/connectors/globalpay/response.rs +++ b/crates/hyperswitch_connectors/src/connectors/globalpay/response.rs @@ -3,75 +3,17 @@ use common_utils::types::StringMinorUnit; use masking::Secret; use serde::{Deserialize, Serialize}; -use super::requests; use crate::utils::deserialize_optional_currency; #[derive(Debug, Serialize, Deserialize)] pub struct GlobalpayPaymentsResponse { - /// A unique identifier for the merchant account set by Global Payments. - pub account_id: Option<Secret<String>>, - /// A meaningful label for the merchant account set by Global Payments. - pub account_name: Option<Secret<String>>, - /// Information about the Action executed. - pub action: Option<Action>, - /// The amount to transfer between Payer and Merchant for a SALE or a REFUND. It is always - /// represented in the lowest denomiation of the related currency. + pub status: GlobalpayPaymentStatus, + pub payment_method: Option<PaymentMethod>, + pub id: String, pub amount: Option<StringMinorUnit>, - /// Indicates if the merchant would accept an authorization for an amount less than the - /// requested amount. This is available for CP channel - /// only where the balance not authorized can be processed again using a different card. - pub authorization_mode: Option<requests::AuthorizationMode>, - /// A Global Payments created reference that uniquely identifies the batch. - pub batch_id: Option<String>, - /// Indicates whether the transaction is to be captured automatically, later or later using - /// more than 1 partial capture. - pub capture_mode: Option<requests::CaptureMode>, - /// Describes whether the transaction was processed in a face to face(CP) scenario or a - /// Customer Not Present (CNP) scenario. - pub channel: Option<requests::Channel>, - /// The country in ISO-3166-1(alpha-2 code) format. - pub country: Option<String>, - /// The currency of the amount in ISO-4217(alpha-3) #[serde(deserialize_with = "deserialize_optional_currency")] pub currency: Option<Currency>, - /// Information relating to a currency conversion. - pub currency_conversion: Option<requests::CurrencyConversion>, - /// A unique identifier generated by Global Payments to identify the transaction. - pub id: String, - /// A unique identifier for the merchant set by Global Payments. - pub merchant_id: Option<String>, - /// A meaningful label for the merchant set by Global Payments. - pub merchant_name: Option<Secret<String>>, - pub payment_method: Option<PaymentMethod>, - /// Merchant defined field to reference the transaction. pub reference: Option<String>, - /// Indicates where a transaction is in its lifecycle. - pub status: GlobalpayPaymentStatus, - /// Global Payments time indicating when the object was created in ISO-8601 format. - pub time_created: Option<String>, - /// Describes whether the transaction is a SALE, that moves funds from Payer to Merchant, or - /// a REFUND where funds move from Merchant to Payer. - #[serde(rename = "type")] - pub globalpay_payments_response_type: Option<requests::GlobalpayPaymentsRequestType>, -} - -/// Information about the Action executed. -#[derive(Debug, Serialize, Deserialize)] -pub struct Action { - /// The id of the app that was used to create the token. - pub app_id: Option<Secret<String>>, - /// The name of the app the user gave to the application. - pub app_name: Option<Secret<String>>, - /// A unique identifier for the object created by Global Payments. The first 3 characters - /// identifies the resource an id relates to. - pub id: Option<Secret<String>>, - /// The result of the action executed. - pub result_code: Option<ResultCode>, - /// Global Payments time indicating when the object was created in ISO-8601 format. - pub time_created: Option<String>, - /// Indicates the action taken. - #[serde(rename = "type")] - pub action_type: Option<ActionType>, } #[derive(Debug, Deserialize, Serialize)] @@ -86,230 +28,25 @@ pub struct GlobalpayRefreshTokenErrorResponse { pub detailed_error_description: String, } -/// Information relating to a currency conversion. -#[derive(Debug, Serialize, Deserialize)] -pub struct CurrencyConversion { - /// The percentage commission taken for providing the currency conversion. - pub commission_percentage: Option<String>, - /// The exchange rate used to convert one currency to another. - pub conversion_rate: Option<String>, - /// The source of the base exchange rate was obtained to execute the currency conversion. - pub exchange_rate_source: Option<String>, - /// The time the base exchange rate was obtained from the source. - pub exchange_source_time: Option<String>, - /// The exchange rate used to convert one currency to another. - pub margin_rate_percentage: Option<String>, - /// The amount that will affect the payer's account. - pub payer_amount: Option<StringMinorUnit>, - /// The currency of the amount that will affect the payer's account. - pub payer_currency: Option<String>, -} - #[derive(Debug, Serialize, Deserialize)] pub struct PaymentMethod { - /// Data associated with the response of an APM transaction. pub apm: Option<Apm>, - /// Information outlining the degree of authentication executed related to a transaction. - pub authentication: Option<Authentication>, - pub bank_transfer: Option<BankTransfer>, pub card: Option<Card>, - pub digital_wallet: Option<requests::DigitalWallet>, - /// Indicates how the payment method information was obtained by the Merchant for this - /// transaction. - pub entry_mode: Option<requests::PaymentMethodEntryMode>, - /// If enabled, this field contains the unique fingerprint signature for that payment method - /// for that merchant. If the payment method is seen again this same value is generated. For - /// cards the primary account number is checked only. The expiry date or the CVV is not used - /// for this check. - pub fingerprint: Option<Secret<String>>, - /// If enabled, this field indicates whether the payment method has been seen before or is - /// new. - /// * EXISTS - Indicates that the payment method was seen on the platform before by this - /// merchant. - /// * NEW - Indicates that the payment method was not seen on the platform before by this - /// merchant. - pub fingerprint_presence_indicator: Option<String>, - /// Unique Global Payments generated id used to reference a stored payment method on the - /// Global Payments system. Often referred to as the payment method token. This value can be - /// used instead of payment method details such as a card number and expiry date. pub id: Option<Secret<String>>, - /// Result message from the payment method provider corresponding to the result code. pub message: Option<String>, - /// Result code from the payment method provider. - /// If a card authorization declines, the payment_method result and message include more detail from the Issuer on why it was declined. - /// For example, 51 - INSUFFICIENT FUNDS. This is generated by the issuing bank, who will provide decline codes in the response back to the authorization platform. pub result: Option<String>, } /// Data associated with the response of an APM transaction. #[derive(Debug, Serialize, Deserialize)] pub struct Apm { - pub bank: Option<Bank>, - /// A string generated by the payment method that represents to what degree the merchant is - /// funded for the transaction. - #[serde(skip_deserializing)] - pub fund_status: Option<FundStatus>, - pub mandate: Option<Mandate>, - /// A string used to identify the payment method provider being used to execute this - /// transaction. - pub provider: Option<ApmProvider>, - /// A name of the payer from the payment method system. - pub provider_payer_name: Option<Secret<String>>, - /// The time the payment method provider created the transaction at on their system. - pub provider_time_created: Option<String>, - /// The reference the payment method provider created for the transaction. - pub provider_transaction_reference: Option<String>, - /// URL to redirect the payer from the merchant's system to the payment method's system. - //1)paypal sends redirect_url as provider_redirect_url for require_customer_action - //2)bankredirects sends redirect_url as redirect_url for require_customer_action - //3)after completeauthorize in paypal it doesn't send redirect_url - //4)after customer action in bankredirects it sends empty string in redirect_url #[serde(alias = "provider_redirect_url")] pub redirect_url: Option<String>, - /// A string generated by the payment method to represent the session created on the payment - /// method's platform to facilitate the creation of a transaction. - pub session_token: Option<Secret<String>>, - pub payment_description: Option<String>, -} - -#[derive(Debug, Serialize, Deserialize)] -pub struct Bank { - /// The local identifier of the bank account. - pub account_number: Option<Secret<String>>, - /// The local identifier of the bank. - pub code: Option<Secret<String>>, - /// The international identifier of the bank account. - pub iban: Option<Secret<String>>, - /// The international identifier code for the bank. - pub identifier_code: Option<Secret<String>>, - /// The name associated with the bank account - pub name: Option<Secret<String>>, -} - -#[derive(Debug, Serialize, Deserialize)] -pub struct Mandate { - /// The reference to identify the mandate. - pub code: Option<Secret<String>>, -} - -/// Information outlining the degree of authentication executed related to a transaction. -#[derive(Debug, Serialize, Deserialize)] -pub struct Authentication { - /// Information outlining the degree of 3D Secure authentication executed. - pub three_ds: Option<ThreeDs>, -} - -/// Information outlining the degree of 3D Secure authentication executed. -#[derive(Debug, Serialize, Deserialize)] -pub struct ThreeDs { - /// The result of the three_ds value validation by the brands or issuing bank. - pub value_result: Option<String>, -} - -#[derive(Debug, Serialize, Deserialize)] -pub struct BankTransfer { - /// The last 4 characters of the local reference for a bank account number. - pub masked_number_last4: Option<String>, - /// The name of the bank. - pub name: Option<Secret<String>>, - /// The type of bank account associated with the payer's bank account. - pub number_type: Option<NumberType>, } #[derive(Debug, Serialize, Deserialize)] pub struct Card { - /// Code generated when the card is successfully authorized. - pub authcode: Option<Secret<String>>, - /// The recommended AVS action to be taken by the agent processing the card transaction. - pub avs_action: Option<String>, - /// The result of the AVS address check. - pub avs_address_result: Option<String>, - /// The result of the AVS postal code check. - pub avs_postal_code_result: Option<String>, - /// Indicates the card brand that issued the card. - pub brand: Option<Brand>, - /// The unique reference created by the brands/schemes to uniquely identify the transaction. pub brand_reference: Option<Secret<String>>, - /// The time returned by the card brand indicating when the transaction was processed on - /// their system. - pub brand_time_reference: Option<String>, - /// The result of the CVV check. - pub cvv_result: Option<String>, - /// Masked card number with last 4 digits showing. - pub masked_number_last4: Option<String>, - /// The result codes directly from the card issuer. - pub provider: Option<ProviderClass>, - /// The card EMV tag response data from the card issuer for a contactless or chip card - /// transaction. - pub tag_response: Option<Secret<String>>, -} - -/// The result codes directly from the card issuer. -#[derive(Debug, Serialize, Deserialize)] -pub struct ProviderClass { - /// The result code of the AVS address check from the card issuer. - #[serde(rename = "card.provider.avs_address_result")] - pub card_provider_avs_address_result: Option<String>, - /// The result of the AVS postal code check from the card issuer.. - #[serde(rename = "card.provider.avs_postal_code_result")] - pub card_provider_avs_postal_code_result: Option<String>, - /// The result code of the AVS check from the card issuer. - #[serde(rename = "card.provider.avs_result")] - pub card_provider_avs_result: Option<String>, - /// The result code of the CVV check from the card issuer. - #[serde(rename = "card.provider.cvv_result")] - pub card_provider_cvv_result: Option<String>, - /// Result code from the card issuer. - #[serde(rename = "card.provider.result")] - pub card_provider_result: Option<String>, -} - -/// The result of the action executed. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum ResultCode { - Declined, - Success, - Pending, - Error, -} - -/// Indicates the specific action taken. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum ActionType { - Adjust, - Authorize, - Capture, - Confirm, - Force, - Increment, - Initiate, - MultipleCapture, - Preauthorize, - PreauthorizeMultipleCapturere, - Authorization, - RedirectFrom, - RedirectTo, - Refund, - Hold, - Release, - Reverse, - Split, - StatusNotification, - TransactionList, - TransactionSingle, -} - -/// A string generated by the payment method that represents to what degree the merchant is -/// funded for the transaction. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum FundStatus { - Missing, - NotExpected, - Received, - Waiting, } /// A string used to identify the payment method provider being used to execute this @@ -325,49 +62,6 @@ pub enum ApmProvider { Testpay, } -/// The type of bank account associated with the payer's bank account. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum NumberType { - Checking, - Savings, -} - -/// The recommended AVS action to be taken by the agent processing the card transaction. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum AvsAction { - Accept, - Decline, - Prompt, -} - -/// The result of the AVS address check. -/// -/// The result of the AVS postal code check. -/// -/// The result of the CVV check. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum GlobalPayResult { - Matched, - NotChecked, - NotMatched, -} - -/// Indicates the card brand that issued the card. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum Brand { - Amex, - Cup, - Diners, - Discover, - Jcb, - Mastercard, - Visa, -} - /// Indicates where a transaction is in its lifecycle. #[derive(Clone, Copy, Debug, Serialize, Deserialize)] #[serde(rename_all = "SCREAMING_SNAKE_CASE")] @@ -417,3 +111,22 @@ pub enum GlobalpayWebhookStatus { #[serde(other)] Unknown, } + +#[derive(Debug, Serialize, Deserialize)] +#[serde(rename_all = "SCREAMING_SNAKE_CASE")] +pub enum GlobalpayPaymentMethodStatus { + /// The entity is ACTIVE and can be used. + Active, + /// The entity is INACTIVE and cannot be used. + Inactive, + /// The status is DELETED. Once returned in an action response for a resource. + /// The resource has been removed from the platform. + Delete, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct GlobalpayPaymentMethodsResponse { + #[serde(rename = "id")] + pub payment_method_token_id: Option<Secret<String>>, + pub card: Card, +} diff --git a/crates/hyperswitch_connectors/src/connectors/globalpay/transformers.rs b/crates/hyperswitch_connectors/src/connectors/globalpay/transformers.rs index a7fd9abd2f8..e4239d28395 100644 --- a/crates/hyperswitch_connectors/src/connectors/globalpay/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/globalpay/transformers.rs @@ -8,7 +8,7 @@ use common_utils::{ use error_stack::ResultExt; use hyperswitch_domain_models::{ payment_method_data, - router_data::{AccessToken, ConnectorAuthType, ErrorResponse, RouterData}, + router_data::{AccessToken, ConnectorAuthType, ErrorResponse, PaymentMethodToken, RouterData}, router_flow_types::{Execute, RSync}, router_request_types::ResponseId, router_response_types::{ @@ -17,6 +17,7 @@ use hyperswitch_domain_models::{ types::{ PaymentsAuthorizeRouterData, PaymentsCancelRouterData, PaymentsCaptureRouterData, PaymentsSyncRouterData, RefreshTokenRouterData, RefundExecuteRouterData, RefundsRouterData, + TokenizationRouterData, }, }; use hyperswitch_interfaces::{ @@ -37,10 +38,14 @@ use super::{ response::{GlobalpayPaymentStatus, GlobalpayPaymentsResponse, GlobalpayRefreshTokenResponse}, }; use crate::{ + connectors::globalpay::{ + requests::CommonPaymentMethodData, response::GlobalpayPaymentMethodsResponse, + }, types::{PaymentsSyncResponseRouterData, RefundsResponseRouterData, ResponseRouterData}, utils::{ self, construct_captures_response_hashmap, CardData, ForeignTryFrom, - MultipleCaptureSyncResponse, PaymentsAuthorizeRequestData, RouterData as _, WalletData, + MultipleCaptureSyncResponse, PaymentMethodTokenizationRequestData, + PaymentsAuthorizeRequestData, RouterData as _, WalletData, }, }; @@ -82,65 +87,115 @@ impl TryFrom<&Option<pii::SecretSerdeValue>> for GlobalPayMeta { impl TryFrom<&GlobalPayRouterData<&PaymentsAuthorizeRouterData>> for GlobalpayPaymentsRequest { type Error = Error; + fn try_from( item: &GlobalPayRouterData<&PaymentsAuthorizeRouterData>, ) -> Result<Self, Self::Error> { + if item.router_data.is_three_ds() { + return Err(errors::ConnectorError::NotSupported { + message: "3DS flow".to_string(), + connector: "Globalpay", + } + .into()); + } + let metadata = GlobalPayMeta::try_from(&item.router_data.connector_meta_data)?; let account_name = metadata.account_name; - let (initiator, stored_credential, brand_reference) = - get_mandate_details(item.router_data)?; - let payment_method_data = get_payment_method_data(item.router_data, brand_reference)?; + + let (initiator, stored_credential, connector_mandate_id) = + if item.router_data.request.is_mandate_payment() { + let connector_mandate_id = + item.router_data + .request + .mandate_id + .as_ref() + .and_then(\|mandate_ids\| match &mandate_ids.mandate_reference_id { + Some(api_models::payments::MandateReferenceId::ConnectorMandateId( + connector_mandate_ids, + )) => connector_mandate_ids.get_connector_mandate_id(), + _ => None, + }); + + let initiator = Some(match item.router_data.request.off_session { + Some(true) => Initiator::Merchant, + _ => Initiator::Payer, + }); + + let stored_credential = Some(StoredCredential { + model: Some(if connector_mandate_id.is_some() { + requests::Model::Recurring + } else { + requests::Model::Unscheduled + }), + sequence: Some(if connector_mandate_id.is_some() { + Sequence::Subsequent + } else { + Sequence::First + }), + }); + + (initiator, stored_credential, connector_mandate_id) + } else { + (None, None, None) + }; + + let payment_method = match &item.router_data.request.payment_method_data { + payment_method_data::PaymentMethodData::Card(ccard) => { + requests::GlobalPayPaymentMethodData::Common(CommonPaymentMethodData { + payment_method_data: PaymentMethodData::Card(requests::Card { + number: ccard.card_number.clone(), + expiry_month: ccard.card_exp_month.clone(), + expiry_year: ccard.get_card_expiry_year_2_digit()?, + cvv: ccard.card_cvc.clone(), + }), + entry_mode: Default::default(), + }) + } + + payment_method_data::PaymentMethodData::Wallet(wallet_data) => { + requests::GlobalPayPaymentMethodData::Common(CommonPaymentMethodData { + payment_method_data: get_wallet_data(wallet_data)?, + entry_mode: Default::default(), + }) + } + + payment_method_data::PaymentMethodData::BankRedirect(bank_redirect) => { + requests::GlobalPayPaymentMethodData::Common(CommonPaymentMethodData { + payment_method_data: PaymentMethodData::try_from(bank_redirect)?, + entry_mode: Default::default(), + }) + } + + payment_method_data::PaymentMethodData::MandatePayment => { + requests::GlobalPayPaymentMethodData::Mandate(requests::MandatePaymentMethodData { + entry_mode: Default::default(), + id: connector_mandate_id, + }) + } + + _ => Err(errors::ConnectorError::NotImplemented( + "Payment methods".to_string(), + ))?, + }; + Ok(Self { account_name, amount: Some(item.amount.to_owned()), currency: item.router_data.request.currency.to_string(), - reference: item.router_data.connector_request_reference_id.to_string(), country: item.router_data.get_billing_country()?, capture_mode: Some(requests::CaptureMode::from( item.router_data.request.capture_method, )), - payment_method: requests::PaymentMethod { - payment_method_data, - authentication: None, - encryption: None, - entry_mode: Default::default(), - fingerprint_mode: None, - first_name: None, - id: None, - last_name: None, - name: None, - narrative: None, - storage_mode: None, - }, + payment_method, notifications: Some(requests::Notifications { return_url: get_return_url(item.router_data), - challenge_return_url: None, - decoupled_challenge_return_url: None, status_url: item.router_data.request.webhook_url.clone(), - three_ds_method_return_url: None, cancel_url: get_return_url(item.router_data), }), - authorization_mode: None, - cashback_amount: None, + stored_credential, channel: Default::default(), - convenience_amount: None, - currency_conversion: None, - description: None, - device: None, - gratuity_amount: None, initiator, - ip_address: None, - language: None, - lodging: None, - order: None, - payer_reference: None, - site_reference: None, - stored_credential, - surcharge_amount: None, - total_capture_count: None, - globalpay_payments_request_type: None, - user_reference: None, }) } } @@ -176,6 +231,32 @@ impl TryFrom<&GlobalPayRouterData<&PaymentsCaptureRouterData>> } } +impl TryFrom<&TokenizationRouterData> for requests::GlobalPayPaymentMethodsRequest { + type Error = Error; + fn try_from(item: &TokenizationRouterData) -> Result<Self, Self::Error> { + if !item.request.is_mandate_payment() { + return Err(errors::ConnectorError::FlowNotSupported { + flow: "Tokenization apart from Mandates".to_string(), + connector: "Globalpay".to_string(), + } + .into()); + } + Ok(Self { + reference: item.connector_request_reference_id.clone(), + usage_mode: Some(requests::UsageMode::Multiple), + card: match &item.request.payment_method_data { + payment_method_data::PaymentMethodData::Card(card_data) => Some(requests::Card { + number: card_data.card_number.clone(), + expiry_month: card_data.card_exp_month.clone(), + expiry_year: card_data.get_card_expiry_year_2_digit()?, + cvv: card_data.card_cvc.clone(), + }), + _ => None, + }, + }) + } +} + impl TryFrom<&GlobalpayCancelRouterData<&PaymentsCancelRouterData>> for requests::GlobalpayCancelRequest { @@ -278,73 +359,18 @@ impl From<Option<common_enums::CaptureMethod>> for requests::CaptureMode { } } -fn get_payment_response( - status: common_enums::AttemptStatus, - response: GlobalpayPaymentsResponse, - redirection_data: Option<RedirectForm>, - status_code: u16, -) -> Result<PaymentsResponseData, Box<ErrorResponse>> { - let mandate_reference = response.payment_method.as_ref().and_then(\|pm\| { - pm.card - .as_ref() - .and_then(\|card\| card.brand_reference.to_owned()) - .map(\|id\| MandateReference { - connector_mandate_id: Some(id.expose()), - payment_method_id: None, - mandate_metadata: None, - connector_mandate_request_reference_id: None, - }) - }); - match status { - common_enums::AttemptStatus::Failure => Err(Box::new(ErrorResponse { - message: response - .payment_method - .as_ref() - .and_then(\|payment_method\| payment_method.message.clone()) - .unwrap_or_else(\|\| NO_ERROR_MESSAGE.to_string()), - code: response - .payment_method - .as_ref() - .and_then(\|payment_method\| payment_method.result.clone()) - .unwrap_or_else(\|\| consts::NO_ERROR_CODE.to_string()), - reason: response - .payment_method - .as_ref() - .and_then(\|payment_method\| payment_method.message.clone()), - status_code, - attempt_status: Some(status), - connector_transaction_id: Some(response.id), - network_decline_code: response - .payment_method - .as_ref() - .and_then(\|payment_method\| payment_method.result.clone()), - network_advice_code: None, - network_error_message: response - .payment_method - .as_ref() - .and_then(\|payment_method\| payment_method.message.clone()), - })), - _ => Ok(PaymentsResponseData::TransactionResponse { - resource_id: ResponseId::ConnectorTransactionId(response.id.clone()), - redirection_data: Box::new(redirection_data), - mandate_reference: Box::new(mandate_reference), - connector_metadata: None, - network_txn_id: None, - connector_response_reference_id: response.reference, - incremental_authorization_allowed: None, - charges: None, - }), - } -} +// } impl<F, T> TryFrom<ResponseRouterData<F, GlobalpayPaymentsResponse, T, PaymentsResponseData>> for RouterData<F, T, PaymentsResponseData> { type Error = Error; + fn try_from( item: ResponseRouterData<F, GlobalpayPaymentsResponse, T, PaymentsResponseData>, ) -> Result<Self, Self::Error> { let status = common_enums::AttemptStatus::from(item.response.status); + let redirect_url = item .response .payment_method @@ -360,12 +386,92 @@ impl<F, T> TryFrom<ResponseRouterData<F, GlobalpayPaymentsResponse, T, PaymentsR Url::parse(url).change_context(errors::ConnectorError::FailedToObtainIntegrationUrl) }) .transpose()?; + let redirection_data = redirect_url.map(\|url\| RedirectForm::from((url, Method::Get))); + let payment_method_token = item.data.get_payment_method_token(); let status_code = item.http_code; + + let mandate_reference = payment_method_token.ok().and_then(\|token\| match token { + PaymentMethodToken::Token(token_string) => Some(MandateReference { + connector_mandate_id: Some(token_string.clone().expose()), + payment_method_id: None, + mandate_metadata: None, + connector_mandate_request_reference_id: None, + }), + _ => None, + }); + + let response = match status { + common_enums::AttemptStatus::Failure => Err(Box::new(ErrorResponse { + message: item + .response + .payment_method + .as_ref() + .and_then(\|payment_method\| payment_method.message.clone()) + .unwrap_or_else(\|\| NO_ERROR_MESSAGE.to_string()), + code: item + .response + .payment_method + .as_ref() + .and_then(\|payment_method\| payment_method.result.clone()) + .unwrap_or_else(\|\| consts::NO_ERROR_CODE.to_string()), + reason: item + .response + .payment_method + .as_ref() + .and_then(\|payment_method\| payment_method.message.clone()), + status_code, + attempt_status: Some(status), + connector_transaction_id: Some(item.response.id.clone()), + network_decline_code: item + .response + .payment_method + .as_ref() + .and_then(\|payment_method\| payment_method.result.clone()), + network_advice_code: None, + network_error_message: item + .response + .payment_method + .as_ref() + .and_then(\|payment_method\| payment_method.message.clone()), + })), + _ => Ok(PaymentsResponseData::TransactionResponse { + resource_id: ResponseId::ConnectorTransactionId(item.response.id.clone()), + redirection_data: Box::new(redirection_data), + mandate_reference: Box::new(mandate_reference), + connector_metadata: None, + network_txn_id: None, + connector_response_reference_id: item.response.reference.clone(), + incremental_authorization_allowed: None, + charges: None, + }), + }; + Ok(Self { status, - response: get_payment_response(status, item.response, redirection_data, status_code) - .map_err(\|err\| err), + response: response.map_err(\|err\| err), + ..item.data + }) + } +} + +impl<F, T> TryFrom<ResponseRouterData<F, GlobalpayPaymentMethodsResponse, T, PaymentsResponseData>> + for RouterData<F, T, PaymentsResponseData> +{ + type Error = Error; + fn try_from( + item: ResponseRouterData<F, GlobalpayPaymentMethodsResponse, T, PaymentsResponseData>, + ) -> Result<Self, Self::Error> { + let token = item + .response + .payment_method_token_id + .clone() + .unwrap_or_default(); + + Ok(Self { + response: Ok(PaymentsResponseData::TokenizationResponse { + token: token.expose(), + }), ..item.data }) } @@ -467,39 +573,6 @@ pub struct GlobalpayErrorResponse { pub detailed_error_description: String, } -fn get_payment_method_data( - item: &PaymentsAuthorizeRouterData, - brand_reference: Option<String>, -) -> Result<PaymentMethodData, Error> { - match &item.request.payment_method_data { - payment_method_data::PaymentMethodData::Card(ccard) => { - Ok(PaymentMethodData::Card(requests::Card { - number: ccard.card_number.clone(), - expiry_month: ccard.card_exp_month.clone(), - expiry_year: ccard.get_card_expiry_year_2_digit()?, - cvv: ccard.card_cvc.clone(), - account_type: None, - authcode: None, - avs_address: None, - avs_postal_code: None, - brand_reference, - chip_condition: None, - funding: None, - pin_block: None, - tag: None, - track: None, - })) - } - payment_method_data::PaymentMethodData::Wallet(wallet_data) => get_wallet_data(wallet_data), - payment_method_data::PaymentMethodData::BankRedirect(bank_redirect) => { - PaymentMethodData::try_from(bank_redirect) - } - _ => Err(errors::ConnectorError::NotImplemented( - "Payment methods".to_string(), - ))?, - } -} - fn get_return_url(item: &PaymentsAuthorizeRouterData) -> Option<String> { match item.request.payment_method_data.clone() { payment_method_data::PaymentMethodData::Wallet( @@ -516,36 +589,6 @@ fn get_return_url(item: &PaymentsAuthorizeRouterData) -> Option<String> { } } -type MandateDetails = (Option<Initiator>, Option<StoredCredential>, Option<String>); -fn get_mandate_details(item: &PaymentsAuthorizeRouterData) -> Result<MandateDetails, Error> { - Ok(if item.request.is_mandate_payment() { - let connector_mandate_id = item.request.mandate_id.as_ref().and_then(\|mandate_ids\| { - match mandate_ids.mandate_reference_id.clone() { - Some(api_models::payments::MandateReferenceId::ConnectorMandateId( - connector_mandate_ids, - )) => connector_mandate_ids.get_connector_mandate_id(), - _ => None, - } - }); - ( - Some(match item.request.off_session { - Some(true) => Initiator::Merchant, - _ => Initiator::Payer, - }), - Some(StoredCredential { - model: Some(requests::Model::Recurring), - sequence: Some(match connector_mandate_id.is_some() { - true => Sequence::Subsequent, - false => Sequence::First, - }), - }), - connector_mandate_id, - ) - } else { - (None, None, None) - }) -} - fn get_wallet_data( wallet_data: &payment_method_data::WalletData, ) -> Result<PaymentMethodData, Error> { diff --git a/crates/hyperswitch_connectors/src/utils.rs b/crates/hyperswitch_connectors/src/utils.rs index 143e7474dd3..09a56474c27 100644 --- a/crates/hyperswitch_connectors/src/utils.rs +++ b/crates/hyperswitch_connectors/src/utils.rs @@ -2190,6 +2190,7 @@ impl PaymentsSetupMandateRequestData for SetupMandateRequestData { pub trait PaymentMethodTokenizationRequestData { fn get_browser_info(&self) -> Result<BrowserInformation, Error>; + fn is_mandate_payment(&self) -> bool; } impl PaymentMethodTokenizationRequestData for PaymentMethodTokenizationData { @@ -2198,6 +2199,15 @@ impl PaymentMethodTokenizationRequestData for PaymentMethodTokenizationData { .clone() .ok_or_else(missing_field_err("browser_info")) } + fn is_mandate_payment(&self) -> bool { + ((self.customer_acceptance.is_some() \|\| self.setup_mandate_details.is_some()) + && (self.setup_future_usage == Some(FutureUsage::OffSession))) + \|\| self + .mandate_id + .as_ref() + .and_then(\|mandate_ids\| mandate_ids.mandate_reference_id.as_ref()) + .is_some() + } } pub trait PaymentsCompleteAuthorizeRequestData { diff --git a/crates/hyperswitch_domain_models/src/router_request_types.rs b/crates/hyperswitch_domain_models/src/router_request_types.rs index b9e2e4a74a6..e919538ea5e 100644 --- a/crates/hyperswitch_domain_models/src/router_request_types.rs +++ b/crates/hyperswitch_domain_models/src/router_request_types.rs @@ -254,6 +254,10 @@ pub struct PaymentMethodTokenizationData { pub currency: storage_enums::Currency, pub amount: Option<i64>, pub split_payments: Option<common_types::payments::SplitPaymentsRequest>, + pub customer_acceptance: Option<common_payments_types::CustomerAcceptance>, + pub setup_future_usage: Option<storage_enums::FutureUsage>, + pub setup_mandate_details: Option<mandates::MandateData>, + pub mandate_id: Option<api_models::payments::MandateIds>, } impl TryFrom<SetupMandateRequestData> for PaymentMethodTokenizationData { @@ -266,6 +270,10 @@ impl TryFrom<SetupMandateRequestData> for PaymentMethodTokenizationData { currency: data.currency, amount: data.amount, split_payments: None, + customer_acceptance: data.customer_acceptance, + setup_future_usage: data.setup_future_usage, + setup_mandate_details: data.setup_mandate_details, + mandate_id: data.mandate_id, }) } } @@ -281,6 +289,10 @@ impl<F> From<&RouterData<F, PaymentsAuthorizeData, response_types::PaymentsRespo currency: data.request.currency, amount: Some(data.request.amount), split_payments: data.request.split_payments.clone(), + customer_acceptance: data.request.customer_acceptance.clone(), + setup_future_usage: data.request.setup_future_usage, + setup_mandate_details: data.request.setup_mandate_details.clone(), + mandate_id: data.request.mandate_id.clone(), } } } @@ -295,6 +307,10 @@ impl TryFrom<PaymentsAuthorizeData> for PaymentMethodTokenizationData { currency: data.currency, amount: Some(data.amount), split_payments: data.split_payments.clone(), + customer_acceptance: data.customer_acceptance, + setup_future_usage: data.setup_future_usage, + setup_mandate_details: data.setup_mandate_details, + mandate_id: data.mandate_id, }) } } @@ -314,6 +330,10 @@ impl TryFrom<CompleteAuthorizeData> for PaymentMethodTokenizationData { currency: data.currency, amount: Some(data.amount), split_payments: None, + customer_acceptance: data.customer_acceptance, + setup_future_usage: data.setup_future_usage, + setup_mandate_details: data.setup_mandate_details, + mandate_id: data.mandate_id, }) } } diff --git a/crates/router/src/configs/settings.rs b/crates/router/src/configs/settings.rs index ae4c8a3cda0..f381712ddfc 100644 --- a/crates/router/src/configs/settings.rs +++ b/crates/router/src/configs/settings.rs @@ -620,6 +620,13 @@ pub struct PaymentMethodTokenFilter { pub payment_method_type: Option<PaymentMethodTypeTokenFilter>, pub long_lived_token: bool, pub apple_pay_pre_decrypt_flow: Option<ApplePayPreDecryptFlow>, + pub flow: Option<PaymentFlow>, +} + +#[derive(Debug, Deserialize, Clone, PartialEq)] +#[serde(deny_unknown_fields, rename_all = "snake_case")] +pub enum PaymentFlow { + Mandates, } #[derive(Debug, Deserialize, Clone, Default)] diff --git a/crates/router/src/core/payment_methods.rs b/crates/router/src/core/payment_methods.rs index 4a23f04cda6..b9d17129249 100644 --- a/crates/router/src/core/payment_methods.rs +++ b/crates/router/src/core/payment_methods.rs @@ -3249,6 +3249,10 @@ async fn create_single_use_tokenization_flow( currency: api_models::enums::Currency::default(), amount: None, split_payments: None, + mandate_id: None, + setup_future_usage: None, + customer_acceptance: None, + setup_mandate_details: None, }; let payment_method_session_address = types::PaymentAddress::new( @@ -3317,12 +3321,12 @@ async fn create_single_use_tokenization_flow( is_payment_id_from_merchant: None, }; - let payment_method_token_response = tokenization::add_token_for_payment_method( + let payment_method_token_response = Box::pin(tokenization::add_token_for_payment_method( &mut router_data, payment_method_data_request.clone(), state.clone(), &merchant_connector_account_details.clone(), - ) + )) .await?; let token_response = payment_method_token_response.token.map_err(\|err\| { diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs index cc6f3384a22..b5c04cfc927 100644 --- a/crates/router/src/core/payments.rs +++ b/crates/router/src/core/payments.rs @@ -106,7 +106,7 @@ use crate::core::routing::helpers as routing_helpers; #[cfg(all(feature = "v1", feature = "dynamic_routing"))] use crate::types::api::convert_connector_data_to_routable_connectors; use crate::{ - configs::settings::{ApplePayPreDecryptFlow, PaymentMethodTypeTokenFilter}, + configs::settings::{ApplePayPreDecryptFlow, PaymentFlow, PaymentMethodTypeTokenFilter}, consts, core::{ errors::{self, CustomResult, RouterResponse, RouterResult}, @@ -6153,6 +6153,7 @@ fn is_payment_method_tokenization_enabled_for_connector( payment_method: storage::enums::PaymentMethod, payment_method_type: Option<storage::enums::PaymentMethodType>, payment_method_token: Option<&PaymentMethodToken>, + mandate_flow_enabled: Option<storage_enums::FutureUsage>, ) -> RouterResult<bool> { let connector_tokenization_filter = state.conf.tokenization.0.get(connector_name); @@ -6171,10 +6172,29 @@ fn is_payment_method_tokenization_enabled_for_connector( payment_method_token, connector_filter.apple_pay_pre_decrypt_flow.clone(), ) + && is_payment_flow_allowed_for_connector( + mandate_flow_enabled, + connector_filter.flow.clone(), + ) }) .unwrap_or(false)) } +fn is_payment_flow_allowed_for_connector( + mandate_flow_enabled: Option<storage_enums::FutureUsage>, + payment_flow: Option<PaymentFlow>, +) -> bool { + if payment_flow.is_none() { + true + } else { + matches!(payment_flow, Some(PaymentFlow::Mandates)) + && matches!( + mandate_flow_enabled, + Some(storage_enums::FutureUsage::OffSession) + ) + } +} + fn is_apple_pay_pre_decrypt_type_connector_tokenization( payment_method_type: Option<storage::enums::PaymentMethodType>, payment_method_token: Option<&PaymentMethodToken>, @@ -6500,6 +6520,10 @@ where .get_required_value("payment_method")?; let payment_method_type = payment_data.get_payment_attempt().payment_method_type; + let mandate_flow_enabled = payment_data + .get_payment_attempt() + .setup_future_usage_applied; + let is_connector_tokenization_enabled = is_payment_method_tokenization_enabled_for_connector( state, @@ -6507,6 +6531,7 @@ where payment_method, payment_method_type, payment_data.get_payment_method_token(), + mandate_flow_enabled, )?; let payment_method_action = decide_payment_method_tokenize_action( @@ -8341,7 +8366,7 @@ where .change_context(errors::ApiErrorResponse::InternalServerError) .attach_printable("Failed to get the common mandate reference")?; - let connector_mandate_details = connector_common_mandate_details.payments; + let connector_mandate_details = connector_common_mandate_details.payments.clone(); let mut connector_choice = None; diff --git a/crates/router/src/core/payments/helpers.rs b/crates/router/src/core/payments/helpers.rs index 4a023f7d8c4..0b1758990ab 100644 --- a/crates/router/src/core/payments/helpers.rs +++ b/crates/router/src/core/payments/helpers.rs @@ -2039,8 +2039,7 @@ pub fn decide_payment_method_retrieval_action( pub async fn is_ucs_enabled(state: &SessionState, config_key: &str) -> bool { let db = state.store.as_ref(); - let is_enabled = db - .find_config_by_key_unwrap_or(config_key, Some("false".to_string())) + db.find_config_by_key_unwrap_or(config_key, Some("false".to_string())) .await .map_err(\|error\| { logger::error!( @@ -2053,9 +2052,7 @@ pub async fn is_ucs_enabled(state: &SessionState, config_key: &str) -> bool { logger::error!(?error, "Failed to parse `{config_key}` UCS enabled config"); }) }) - .unwrap_or(false); - - is_enabled + .unwrap_or(false) } pub async fn should_execute_based_on_rollout( diff --git a/crates/router/tests/connectors/square.rs b/crates/router/tests/connectors/square.rs index 81ea8112276..760e8ebdaea 100644 --- a/crates/router/tests/connectors/square.rs +++ b/crates/router/tests/connectors/square.rs @@ -68,6 +68,10 @@ fn token_details() -> Option<types::PaymentMethodTokenizationData> { amount: None, currency: enums::Currency::USD, split_payments: None, + mandate_id: None, + setup_future_usage: None, + customer_acceptance: None, + setup_mandate_details: None, }) } @@ -442,6 +446,10 @@ async fn should_fail_payment_for_incorrect_cvc() { amount: None, currency: enums::Currency::USD, split_payments: None, + mandate_id: None, + setup_future_usage: None, + customer_acceptance: None, + setup_mandate_details: None, }), get_default_payment_info(None), ) @@ -474,6 +482,10 @@ async fn should_fail_payment_for_invalid_exp_month() { amount: None, currency: enums::Currency::USD, split_payments: None, + mandate_id: None, + setup_future_usage: None, + customer_acceptance: None, + setup_mandate_details: None, }), get_default_payment_info(None), ) @@ -506,6 +518,10 @@ async fn should_fail_payment_for_incorrect_expiry_year() { amount: None, currency: enums::Currency::USD, split_payments: None, + mandate_id: None, + setup_future_usage: None, + customer_acceptance: None, + setup_mandate_details: None, }), get_default_payment_info(None), ) diff --git a/crates/router/tests/connectors/stax.rs b/crates/router/tests/connectors/stax.rs index 93c2394354b..89b1bc7f4b9 100644 --- a/crates/router/tests/connectors/stax.rs +++ b/crates/router/tests/connectors/stax.rs @@ -73,6 +73,10 @@ fn token_details() -> Option<types::PaymentMethodTokenizationData> { amount: None, currency: enums::Currency::USD, split_payments: None, + mandate_id: None, + setup_future_usage: None, + customer_acceptance: None, + setup_mandate_details: None, }) } @@ -484,6 +488,10 @@ async fn should_fail_payment_for_incorrect_cvc() { amount: None, currency: enums::Currency::USD, split_payments: None, + mandate_id: None, + setup_future_usage: None, + customer_acceptance: None, + setup_mandate_details: None, }), get_default_payment_info(connector_customer_id, None), ) @@ -523,6 +531,10 @@ async fn should_fail_payment_for_invalid_exp_month() { amount: None, currency: enums::Currency::USD, split_payments: None, + mandate_id: None, + setup_future_usage: None, + customer_acceptance: None, + setup_mandate_details: None, }), get_default_payment_info(connector_customer_id, None), ) @@ -562,6 +574,10 @@ async fn should_fail_payment_for_incorrect_expiry_year() { amount: None, currency: enums::Currency::USD, split_payments: None, + mandate_id: None, + setup_future_usage: None, + customer_acceptance: None, + setup_mandate_details: None, }), get_default_payment_info(connector_customer_id, None), ) diff --git a/crates/router/tests/connectors/utils.rs b/crates/router/tests/connectors/utils.rs index e3884894b33..a8676834040 100644 --- a/crates/router/tests/connectors/utils.rs +++ b/crates/router/tests/connectors/utils.rs @@ -1121,6 +1121,10 @@ impl Default for TokenType { amount: Some(100), currency: enums::Currency::USD, split_payments: None, + mandate_id: None, + setup_future_usage: None, + customer_acceptance: None, + setup_mandate_details: None, }; Self(data) } diff --git a/loadtest/config/development.toml b/loadtest/config/development.toml index b0bc2e9ee1c..0d1e27961d4 100644 --- a/loadtest/config/development.toml +++ b/loadtest/config/development.toml @@ -591,6 +591,7 @@ mollie = { long_lived_token = false, payment_method = "card" } braintree = { long_lived_token = false, payment_method = "card" } gocardless = { long_lived_token = true, payment_method = "bank_debit" } billwerk = { long_lived_token = false, payment_method = "card" } +globalpay = { long_lived_token = false, payment_method = "card", flow = "mandates" } [connector_customer] connector_list = "adyen,facilitapay,gocardless,hyperswitch_vault,stax,stripe"	2025-07-07T11:53:46Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> In One-off payments, we donot need to create the token. Just passing raw cards would be enough. In CITs, we need to create a token and store it in `connector_mandate_id` for future MITs but while executing the CIT, raw cards need to be passed. In MITs, we need to use that previously stored token in CIT and no more need to hit the tokenization endpoint at connector. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [x] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> 1. Payments Create - One-off cURL: ``` curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_v5jp7Ow9W5g6tgWaDHs4UR385iFfpg9dXQGYQkxxRXQdHlcvR70WmjJRPWJt7Xe7' \ --header 'Cookie: PHPSESSID=0b47db9d7de94c37b6b272087a9f2fa7' \ --data-raw '{ "currency":"USD", "amount": 300, "confirm": true, "amount_to_capture": 300, "capture_method": "automatic", "capture_on": "2022-09-10T10:11:12Z", "authentication_type": "no_three_ds", "return_url": "https://www.google.com", "email": "[email protected]", "name": "Joseph Doe", "phone": "999999999", "phone_country_code": "+65", "description": "Its my first payment request", "statement_descriptor_name": "Juspay", "statement_descriptor_suffix": "Router", "payment_method": "card", "payment_method_type": "credit", "payment_method_data": { "card": { "card_number": "4242424242424242", "card_exp_month": "03", "card_exp_year": "2030", "card_holder_name": "joseph Doe", "card_cvc": "737" } }, "billing": { "address": { "line1": "1467", "line2": "CA", "line3": "Harrison Street", "city": "San Fransico", "state": "CA", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" }, "phone": { "number": "8056594427", "country_code": "+91" } }, "browser_info": { "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8", "language": "nl-NL", "color_depth": 24, "screen_height": 723, "screen_width": 1536, "time_zone": 0, "java_enabled": true, "java_script_enabled": true, "ip_address": "109.71.40.0" }, "metadata": { "order_category": "applepay" }, "order_details": [ { "product_name": "Apple iphone 15", "quantity": 1, "amount": 300, "account_name": "transaction_processing" } ] }' ``` Response: ``` { "payment_id": "pay_j2mMaanCWkdCD2ytx5gg", "merchant_id": "merchant_1751871882", "status": "succeeded", "amount": 300, "net_amount": 300, "shipping_cost": null, "amount_capturable": 0, "amount_received": 300, "connector": "globalpay", "client_secret": "pay_j2mMaanCWkdCD2ytx5gg_secret_CqzsQEqF82ClZdEAoVF3", "created": "2025-07-07T11:03:44.204Z", "currency": "USD", "customer_id": null, "customer": { "id": null, "name": "Joseph Doe", "email": "[email protected]", "phone": "999999999", "phone_country_code": "+65" }, "description": "Its my first payment request", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "card", "payment_method_data": { "card": { "last4": "4242", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "424242", "card_extended_bin": null, "card_exp_month": "03", "card_exp_year": "2030", "card_holder_name": "joseph Doe", "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "CA", "line3": "Harrison Street", "zip": "94122", "state": "CA", "first_name": "joseph", "last_name": "Doe" }, "phone": { "number": "8056594427", "country_code": "+91" }, "email": null }, "order_details": [ { "brand": null, "amount": 300, "category": null, "quantity": 1, "tax_rate": null, "product_id": null, "product_name": "Apple iphone 15", "product_type": null, "sub_category": null, "product_img_link": null, "product_tax_code": null, "total_tax_amount": null, "requires_shipping": null } ], "email": null, "name": null, "phone": null, "return_url": "https://www.google.com/", "authentication_type": "no_three_ds", "statement_descriptor_name": "Juspay", "statement_descriptor_suffix": "Router", "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "credit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": false, "connector_transaction_id": "TRN_IORyBbPseO4Qiy0L2v8YpZpgWA9auN_dCD2ytx5gg_1", "frm_message": null, "metadata": { "order_category": "applepay" }, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_j2mMaanCWkdCD2ytx5gg_1", "payment_link": null, "profile_id": "pro_GIxd8tTl8PWNt9L2ynbr", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_ghTQYltef3iCpp4cdsVu", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-07-07T11:18:44.204Z", "fingerprint": null, "browser_info": { "language": "nl-NL", "time_zone": 0, "ip_address": "109.71.40.0", "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "color_depth": 24, "java_enabled": true, "screen_width": 1536, "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8", "screen_height": 723, "java_script_enabled": true }, "payment_method_id": null, "payment_method_status": null, "updated": "2025-07-07T11:03:46.731Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` 2. CIT using `mandate_id` Request: ``` curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_otcCi6DyRzeDWx38OH5BTLBjBK1WS7Jt1BbsMpPepSR2Rr5dIPgVgPMoeekaqoXL' \ --header 'Cookie: PHPSESSID=0b47db9d7de94c37b6b272087a9f2fa7' \ --data-raw '{ "amount": 6000, "all_keys_required": true, "currency": "USD", "confirm": true, "capture_method": "automatic", "capture_on": "2022-09-10T10:11:12Z", "customer_id": "cus_LI9DQMmb1tHRjnfnkjwknjfXtonFkU", "email": "[email protected]", "name": "John Doe", "phone": "999999999", "phone_country_code": "+65", "description": "Its my first payment request", "authentication_type": "no_three_ds", "return_url": "https://example.com", "payment_method": "card", "payment_method_type": "debit", "payment_method_data": { "card": { "card_number": "4111111111111111", "card_exp_month": "12", "card_exp_year": "2030", "card_holder_name": "joseph Doe", "card_cvc": "123" } }, "setup_future_usage": "off_session", "customer_acceptance": { "acceptance_type": "offline", "accepted_at": "1963-05-03T04:07:52.723Z", "online": { "ip_address": "in sit", "user_agent": "amet irure esse" } }, "mandate_data": { "customer_acceptance": { "acceptance_type": "offline", "accepted_at": "1963-05-03T04:07:52.723Z", "online": { "ip_address": "127.0.0.1", "user_agent": "amet irure esse" } }, "mandate_type": { "single_use": { "amount": 8000, "currency": "USD" } } }, "payment_type": "new_mandate", "billing": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "john", "last_name": "Doe" } }, "shipping": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "john", "last_name": "Doe" } }, "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "metadata": { "udf1": "value1", "new_customer": "true", "login_date": "2019-09-10T10:11:12Z" }, "browser_info": { "ip_address": "129.0.0.1", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36", "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8", "language": "en-US", "color_depth": 32, "screen_height": 1117, "screen_width": 1728, "time_zone": -330, "java_enabled": true, "java_script_enabled": true } }' ``` Response: ``` { "payment_id": "pay_pgbcY6mXYI4IYk2Zt5kc", "merchant_id": "merchant_1753277415", "status": "succeeded", "amount": 6000, "net_amount": 6000, "shipping_cost": null, "amount_capturable": 0, "amount_received": 6000, "connector": "globalpay", "client_secret": "pay_pgbcY6mXYI4IYk2Zt5kc_secret_H0sK1auIjNZsIcfjVE1d", "created": "2025-07-23T17:30:07.918Z", "currency": "USD", "customer_id": "cus_LI9DQMmb1tHRjnfnkjwknjfXtonFkU", "customer": { "id": "cus_LI9DQMmb1tHRjnfnkjwknjfXtonFkU", "name": "John Doe", "email": "[email protected]", "phone": "999999999", "phone_country_code": "+65" }, "description": "Its my first payment request", "refunds": null, "disputes": null, "mandate_id": "man_bRinPSQhGM8Pky90uBNb", "mandate_data": { "update_mandate_id": null, "customer_acceptance": { "acceptance_type": "offline", "accepted_at": "1963-05-03T04:07:52.723Z", "online": { "ip_address": "127.0.0.1", "user_agent": "amet irure esse" } }, "mandate_type": { "single_use": { "amount": 8000, "currency": "USD", "start_date": null, "end_date": null, "metadata": null } } }, "setup_future_usage": "off_session", "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "card", "payment_method_data": { "card": { "last4": "1111", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "411111", "card_extended_bin": null, "card_exp_month": "12", "card_exp_year": "2030", "card_holder_name": "joseph Doe", "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "john", "last_name": "Doe" }, "phone": null, "email": null }, "billing": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "john", "last_name": "Doe" }, "phone": null, "email": null }, "order_details": null, "email": "[email protected]", "name": "John Doe", "phone": "999999999", "return_url": "https://example.com/", "authentication_type": "no_three_ds", "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "debit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": { "customer_id": "cus_LI9DQMmb1tHRjnfnkjwknjfXtonFkU", "created_at": 1753291807, "expires": 1753295407, "secret": "epk_222a00737e6c47d181b899d8afc76813" }, "manual_retry_allowed": false, "connector_transaction_id": "TRN_gBpefdKHlBxfmgVgFSlfPuCQXj86TT_4IYk2Zt5kc_1", "frm_message": null, "metadata": { "udf1": "value1", "login_date": "2019-09-10T10:11:12Z", "new_customer": "true" }, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_pgbcY6mXYI4IYk2Zt5kc_1", "payment_link": null, "profile_id": "pro_roCz974ra9LQxsifUris", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_5Y545k7TI4upQYSbJJ9L", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-07-23T17:45:07.918Z", "fingerprint": null, "browser_info": { "language": "en-US", "time_zone": -330, "ip_address": "129.0.0.1", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36", "color_depth": 32, "java_enabled": true, "screen_width": 1728, "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8", "screen_height": 1117, "java_script_enabled": true }, "payment_method_id": "pm_uDtgQsunDERQMrEXxbcy", "payment_method_status": null, "updated": "2025-07-23T17:30:11.412Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": "{\"id\":\"TRN_gBpefdKHlBxfmgVgFSlfPuCQXj86TT_4IYk2Zt5kc_1\",\"time_created\":\"2025-07-23T17:30:11.323Z\",\"type\":\"SALE\",\"status\":\"CAPTURED\",\"channel\":\"CNP\",\"capture_mode\":\"AUTO\",\"amount\":\"6000\",\"currency\":\"USD\",\"country\":\"US\",\"merchant_id\":\"MER_7e3e2c7df34f42819b3edee31022ee3f\",\"merchant_name\":\"Sandbox_merchant_3\",\"account_id\":\"TRA_c9967ad7d8ec4b46b6dd44a61cde9a91\",\"account_name\":\"transaction_processing\",\"reference\":\"pay_pgbcY6mXYI4IYk2Zt5kc_1\",\"payment_method\":{\"result\":\"00\",\"message\":\"(00)[ test system ] Authorised\",\"entry_mode\":\"ECOM\",\"card\":{\"brand\":\"VISA\",\"masked_number_last4\":\"XXXXXXXXXXXX1111\",\"authcode\":\"123456\",\"brand_reference\":\"R0LEZpZE51h4fEcD\",\"brand_time_created\":\"\",\"cvv_result\":\"MATCHED\",\"provider\":{\"result\":\"00\",\"cvv_result\":\"M\",\"avs_address_result\":\"M\",\"avs_postal_code_result\":\"M\"}}},\"risk_assessment\":[{\"mode\":\"ACTIVE\",\"result\":\"ACCEPTED\",\"rules\":[{\"reference\":\"0c93a6c9-7649-4822-b5ea-1efa356337fd\",\"description\":\"Cardholder Name Rule\",\"mode\":\"ACTIVE\",\"result\":\"ACCEPTED\"},{\"reference\":\"a539d51a-abc1-4fff-a38e-b34e00ad0cc3\",\"description\":\"CardNumber block\",\"mode\":\"ACTIVE\",\"result\":\"ACCEPTED\"},{\"reference\":\"d023a19e-6985-4fda-bb9b-5d4e0dedbb1e\",\"description\":\"Amount test\",\"mode\":\"ACTIVE\",\"result\":\"ACCEPTED\"}]}],\"batch_id\":\"BAT_1558804\",\"action\":{\"id\":\"ACT_gBpefdKHlBxfmgVgFSlfPuCQXj86TT\",\"type\":\"AUTHORIZE\",\"time_created\":\"2025-07-23T17:30:11.323Z\",\"result_code\":\"SUCCESS\",\"app_id\":\"OXKlGGm6ecZLIqMyRgPHRfMxdUAiEcp8\",\"app_name\":\"rotate_again\"}}" } ``` 3. MIT using `mandate_id` Request: ``` curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_otcCi6DyRzeDWx38OH5BTLBjBK1WS7Jt1BbsMpPepSR2Rr5dIPgVgPMoeekaqoXL' \ --header 'Cookie: PHPSESSID=0b47db9d7de94c37b6b272087a9f2fa7' \ --data '{ "amount": 6000, "currency": "USD", "capture_method": "automatic", "off_session": true, "confirm": true, "description": "Initiated by merchant", "mandate_id": "man_bRinPSQhGM8Pky90uBNb", "customer_id": "cus_LI9DQMmb1tHRjnfnkjwknjfXtonFkU" }' ``` Response: ``` { "payment_id": "pay_RI5mPEtiRZOUPPBEckqZ", "merchant_id": "merchant_1753277415", "status": "succeeded", "amount": 6000, "net_amount": 6000, "shipping_cost": null, "amount_capturable": 0, "amount_received": 6000, "connector": "globalpay", "client_secret": "pay_RI5mPEtiRZOUPPBEckqZ_secret_Aj61vZbZEdJkamRrE2EK", "created": "2025-07-23T17:30:20.230Z", "currency": "USD", "customer_id": "cus_LI9DQMmb1tHRjnfnkjwknjfXtonFkU", "customer": { "id": "cus_LI9DQMmb1tHRjnfnkjwknjfXtonFkU", "name": "John Doe", "email": "[email protected]", "phone": "999999999", "phone_country_code": "+65" }, "description": "Initiated by merchant", "refunds": null, "disputes": null, "mandate_id": "man_bRinPSQhGM8Pky90uBNb", "mandate_data": null, "setup_future_usage": null, "off_session": true, "capture_on": null, "capture_method": "automatic", "payment_method": "card", "payment_method_data": { "card": { "last4": "1111", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "411111", "card_extended_bin": null, "card_exp_month": "12", "card_exp_year": "2030", "card_holder_name": "joseph Doe", "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": "23420a93-c0ad-435f-885f-2d57c30c14d9", "shipping": null, "billing": null, "order_details": null, "email": "[email protected]", "name": "John Doe", "phone": "999999999", "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "debit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": { "customer_id": "cus_LI9DQMmb1tHRjnfnkjwknjfXtonFkU", "created_at": 1753291820, "expires": 1753295420, "secret": "epk_ceed93e4ac414b0ea6c2f454b9187067" }, "manual_retry_allowed": false, "connector_transaction_id": "TRN_VlfWAjrCer1pEZaQ7BRJsxE9tqGHnn_OUPPBEckqZ_1", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_RI5mPEtiRZOUPPBEckqZ_1", "payment_link": null, "profile_id": "pro_roCz974ra9LQxsifUris", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_5Y545k7TI4upQYSbJJ9L", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-07-23T17:45:20.230Z", "fingerprint": null, "browser_info": null, "payment_method_id": "pm_uDtgQsunDERQMrEXxbcy", "payment_method_status": "active", "updated": "2025-07-23T17:30:23.884Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": "PMT_9fd7c105-65f1-4b54-9b3f-d3f34c35100d", "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` 4. CIT using `payment_method_id` cURL: ``` curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_otcCi6DyRzeDWx38OH5BTLBjBK1WS7Jt1BbsMpPepSR2Rr5dIPgVgPMoeekaqoXL' \ --header 'Cookie: PHPSESSID=0b47db9d7de94c37b6b272087a9f2fa7' \ --data-raw '{ "amount": 1650, "currency": "USD", "connector": ["globalpay"], "confirm": true, "customer_id": "customer123ffffa", "setup_future_usage": "off_session", "payment_method_type": "debit", "payment_method": "card", "payment_method_data": { "card": { "card_number": "4111111111111111", "card_exp_month": "03", "card_exp_year": "30", "card_holder_name": "joseph Doe", "card_cvc": "737" } }, "billing": { "address": { "first_name": "joseph", "last_name": "Doe", "country": "US" } }, "email": "[email protected]", "customer_acceptance": { "acceptance_type": "offline" } }' ``` Response: ``` { "payment_id": "pay_CNM35m7O7JfdmH9qYyFq", "merchant_id": "merchant_1753277415", "status": "succeeded", "amount": 1650, "net_amount": 1650, "shipping_cost": null, "amount_capturable": 0, "amount_received": 1650, "connector": "globalpay", "client_secret": "pay_CNM35m7O7JfdmH9qYyFq_secret_uz67njQIBT8dhkSR2jcr", "created": "2025-07-23T17:29:50.150Z", "currency": "USD", "customer_id": "customer123ffffa", "customer": { "id": "customer123ffffa", "name": null, "email": "[email protected]", "phone": null, "phone_country_code": null }, "description": null, "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": "off_session", "off_session": null, "capture_on": null, "capture_method": null, "payment_method": "card", "payment_method_data": { "card": { "last4": "1111", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "411111", "card_extended_bin": null, "card_exp_month": "03", "card_exp_year": "30", "card_holder_name": "joseph Doe", "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": null, "country": "US", "line1": null, "line2": null, "line3": null, "zip": null, "state": null, "first_name": "joseph", "last_name": "Doe" }, "phone": null, "email": null }, "order_details": null, "email": "[email protected]", "name": null, "phone": null, "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "debit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": { "customer_id": "customer123ffffa", "created_at": 1753291790, "expires": 1753295390, "secret": "epk_b79f5365965648aea900af73ee98fc51" }, "manual_retry_allowed": false, "connector_transaction_id": "TRN_hR9reO0fbf15HP7SDBznXeKNnhvb6u_fdmH9qYyFq_1", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_CNM35m7O7JfdmH9qYyFq_1", "payment_link": null, "profile_id": "pro_roCz974ra9LQxsifUris", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_5Y545k7TI4upQYSbJJ9L", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-07-23T17:44:50.150Z", "fingerprint": null, "browser_info": null, "payment_method_id": "pm_P66KYq7rG0B7f7RENNf2", "payment_method_status": "active", "updated": "2025-07-23T17:29:53.258Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": "PMT_d6001c7b-6150-404d-92f3-56b217fb8a3d", "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` 5. MIT using `payment_method_id` cURL: ``` curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_otcCi6DyRzeDWx38OH5BTLBjBK1WS7Jt1BbsMpPepSR2Rr5dIPgVgPMoeekaqoXL' \ --header 'Cookie: PHPSESSID=0b47db9d7de94c37b6b272087a9f2fa7' \ --data '{ "amount": 179, "currency": "USD", "confirm": true, "customer_id": "customer123ffffa", "recurring_details": { "type": "payment_method_id", "data": "pm_P66KYq7rG0B7f7RENNf2" }, "off_session": true }' ``` Response: ``` { "payment_id": "pay_6pONwGPfaI6X8zmyOPcS", "merchant_id": "merchant_1753277415", "status": "succeeded", "amount": 179, "net_amount": 179, "shipping_cost": null, "amount_capturable": 0, "amount_received": 179, "connector": "globalpay", "client_secret": "pay_6pONwGPfaI6X8zmyOPcS_secret_XRjvCntYf6esUICifOQg", "created": "2025-07-23T17:30:01.371Z", "currency": "USD", "customer_id": "customer123ffffa", "customer": { "id": "customer123ffffa", "name": null, "email": "[email protected]", "phone": null, "phone_country_code": null }, "description": null, "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": true, "capture_on": null, "capture_method": null, "payment_method": "card", "payment_method_data": { "card": { "last4": "1111", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "411111", "card_extended_bin": null, "card_exp_month": "03", "card_exp_year": "30", "card_holder_name": "joseph Doe", "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": null, "billing": null, "order_details": null, "email": "[email protected]", "name": null, "phone": null, "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "debit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": { "customer_id": "customer123ffffa", "created_at": 1753291801, "expires": 1753295401, "secret": "epk_66d9de3b79db4ee3b35e9dd6db9c18e4" }, "manual_retry_allowed": false, "connector_transaction_id": "TRN_xgxrFV1PkebYZKabeA2R4qN63rqTka_6X8zmyOPcS_1", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_6pONwGPfaI6X8zmyOPcS_1", "payment_link": null, "profile_id": "pro_roCz974ra9LQxsifUris", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_5Y545k7TI4upQYSbJJ9L", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-07-23T17:45:01.371Z", "fingerprint": null, "browser_info": null, "payment_method_id": "pm_P66KYq7rG0B7f7RENNf2", "payment_method_status": "active", "updated": "2025-07-23T17:30:05.264Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": "PMT_d6001c7b-6150-404d-92f3-56b217fb8a3d", "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` ## Cypress test <details> <summary> Globalpay </summary> <img width="490" height="1088" alt="Screenshot 2025-07-15 at 7 31 52 PM" src="https://github.com/user-attachments/assets/fc412951-43e1-4be9-bd07-28c7980db3a4" /> </details> ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	260df2836cea8f9aa7448888d3b61e942eda313b	260df2836cea8f9aa7448888d3b61e942eda313b
juspay/hyperswitch	juspay__hyperswitch-8493	Bug: [FEATURE] [CONNECTOR] Checkbook ### Feature Description Integrate a new connector : Checkbook API Ref: https://docs.checkbook.io/reference/ ### Possible Implementation Integrate a new connector : Checkbook API Ref: https://docs.checkbook.io/reference/ ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? Yes, I am willing to submit a PR!	diff --git a/config/config.example.toml b/config/config.example.toml index c781ec3705b..7d072f93e47 100644 --- a/config/config.example.toml +++ b/config/config.example.toml @@ -203,6 +203,7 @@ boku.base_url = "https://$-api4-stage.boku.com" braintree.base_url = "https://payments.sandbox.braintree-api.com/graphql" cashtocode.base_url = "https://cluster05.api-test.cashtocode.com" chargebee.base_url = "https://$.chargebee.com/api/" +checkbook.base_url = "https://api.sandbox.checkbook.io" checkout.base_url = "https://api.sandbox.checkout.com/" coinbase.base_url = "https://api.commerce.coinbase.com" coingate.base_url = "https://api-sandbox.coingate.com" @@ -344,6 +345,7 @@ cards = [ "coingate", "cryptopay", "braintree", + "checkbook", "checkout", "cybersource", "datatrans", diff --git a/config/deployments/integration_test.toml b/config/deployments/integration_test.toml index 898a84e7db0..2431f89a0ab 100644 --- a/config/deployments/integration_test.toml +++ b/config/deployments/integration_test.toml @@ -42,6 +42,7 @@ boku.base_url = "https://$-api4-stage.boku.com" braintree.base_url = "https://payments.sandbox.braintree-api.com/graphql" cashtocode.base_url = "https://cluster05.api-test.cashtocode.com" chargebee.base_url = "https://$.chargebee.com/api/" +checkbook.base_url = "https://api.sandbox.checkbook.io" checkout.base_url = "https://api.sandbox.checkout.com/" coinbase.base_url = "https://api.commerce.coinbase.com" coingate.base_url = "https://api-sandbox.coingate.com" diff --git a/config/deployments/production.toml b/config/deployments/production.toml index f08bb64136c..2f4e00d1137 100644 --- a/config/deployments/production.toml +++ b/config/deployments/production.toml @@ -46,6 +46,7 @@ boku.base_url = "https://country-api4-stage.boku.com" braintree.base_url = "https://payments.braintree-api.com/graphql" cashtocode.base_url = "https://cluster14.api.cashtocode.com" chargebee.base_url = "https://{{merchant_endpoint_prefix}}.chargebee.com/api/" +checkbook.base_url = "https://api.checkbook.io" checkout.base_url = "https://api.checkout.com/" coinbase.base_url = "https://api.commerce.coinbase.com" coingate.base_url = "https://api.coingate.com" diff --git a/config/deployments/sandbox.toml b/config/deployments/sandbox.toml index e48ddf3ff0b..b05d9d04a82 100644 --- a/config/deployments/sandbox.toml +++ b/config/deployments/sandbox.toml @@ -45,6 +45,7 @@ bluesnap.secondary_base_url = "https://sandpay.bluesnap.com/" boku.base_url = "https://$-api4-stage.boku.com" braintree.base_url = "https://payments.sandbox.braintree-api.com/graphql" cashtocode.base_url = "https://cluster05.api-test.cashtocode.com" +checkbook.base_url = "https://api.sandbox.checkbook.io" checkout.base_url = "https://api.sandbox.checkout.com/" chargebee.base_url = "https://$.chargebee.com/api/" coinbase.base_url = "https://api.commerce.coinbase.com" diff --git a/config/development.toml b/config/development.toml index d340abae6ef..84afa679d11 100644 --- a/config/development.toml +++ b/config/development.toml @@ -109,6 +109,7 @@ cards = [ "bluesnap", "boku", "braintree", + "checkbook", "checkout", "coinbase", "coingate", @@ -237,6 +238,7 @@ boku.base_url = "https://$-api4-stage.boku.com" braintree.base_url = "https://payments.sandbox.braintree-api.com/graphql" cashtocode.base_url = "https://cluster05.api-test.cashtocode.com" chargebee.base_url = "https://$.chargebee.com/api/" +checkbook.base_url = "https://api.sandbox.checkbook.io" checkout.base_url = "https://api.sandbox.checkout.com/" coinbase.base_url = "https://api.commerce.coinbase.com" coingate.base_url = "https://api-sandbox.coingate.com" diff --git a/config/docker_compose.toml b/config/docker_compose.toml index 31ecb58bb6f..80a672453ea 100644 --- a/config/docker_compose.toml +++ b/config/docker_compose.toml @@ -129,6 +129,7 @@ boku.base_url = "https://$-api4-stage.boku.com" braintree.base_url = "https://payments.sandbox.braintree-api.com/graphql" cashtocode.base_url = "https://cluster05.api-test.cashtocode.com" chargebee.base_url = "https://$.chargebee.com/api/" +checkbook.base_url = "https://api.sandbox.checkbook.io" checkout.base_url = "https://api.sandbox.checkout.com/" coinbase.base_url = "https://api.commerce.coinbase.com" coingate.base_url = "https://api-sandbox.coingate.com" @@ -258,6 +259,7 @@ cards = [ "boku", "braintree", "checkout", + "checkbook", "coinbase", "coingate", "cryptopay", diff --git a/crates/common_enums/src/connector_enums.rs b/crates/common_enums/src/connector_enums.rs index 58c627cca84..afe83a0f40f 100644 --- a/crates/common_enums/src/connector_enums.rs +++ b/crates/common_enums/src/connector_enums.rs @@ -75,6 +75,7 @@ pub enum RoutableConnectors { Braintree, Cashtocode, Chargebee, + // Checkbook, Checkout, Coinbase, Coingate, @@ -231,6 +232,7 @@ pub enum Connector { Braintree, Cashtocode, Chargebee, + // Checkbook, Checkout, Coinbase, Coingate, @@ -414,6 +416,7 @@ impl Connector { \| Self::Braintree \| Self::Cashtocode \| Self::Chargebee + // \| Self::Checkbook \| Self::Coinbase \| Self::Coingate \| Self::Cryptopay @@ -575,6 +578,7 @@ impl From<RoutableConnectors> for Connector { RoutableConnectors::Braintree => Self::Braintree, RoutableConnectors::Cashtocode => Self::Cashtocode, RoutableConnectors::Chargebee => Self::Chargebee, + // RoutableConnectors::Checkbook => Self::Checkbook, RoutableConnectors::Checkout => Self::Checkout, RoutableConnectors::Coinbase => Self::Coinbase, RoutableConnectors::Cryptopay => Self::Cryptopay, @@ -694,6 +698,7 @@ impl TryFrom<Connector> for RoutableConnectors { Connector::Braintree => Ok(Self::Braintree), Connector::Cashtocode => Ok(Self::Cashtocode), Connector::Chargebee => Ok(Self::Chargebee), + // Connector::Checkbook => Ok(Self::Checkbook), Connector::Checkout => Ok(Self::Checkout), Connector::Coinbase => Ok(Self::Coinbase), Connector::Coingate => Ok(Self::Coingate), diff --git a/crates/connector_configs/src/connector.rs b/crates/connector_configs/src/connector.rs index 62ad0993f03..abf73e20acc 100644 --- a/crates/connector_configs/src/connector.rs +++ b/crates/connector_configs/src/connector.rs @@ -191,6 +191,7 @@ pub struct ConnectorConfig { pub braintree: Option<ConnectorTomlConfig>, pub cashtocode: Option<ConnectorTomlConfig>, pub chargebee: Option<ConnectorTomlConfig>, + pub checkbook: Option<ConnectorTomlConfig>, pub checkout: Option<ConnectorTomlConfig>, pub coinbase: Option<ConnectorTomlConfig>, pub coingate: Option<ConnectorTomlConfig>, diff --git a/crates/hyperswitch_connectors/src/connectors.rs b/crates/hyperswitch_connectors/src/connectors.rs index 9f1355a1372..55f2047a59f 100644 --- a/crates/hyperswitch_connectors/src/connectors.rs +++ b/crates/hyperswitch_connectors/src/connectors.rs @@ -16,6 +16,7 @@ pub mod boku; pub mod braintree; pub mod cashtocode; pub mod chargebee; +pub mod checkbook; pub mod checkout; pub mod coinbase; pub mod coingate; @@ -114,8 +115,8 @@ pub use self::{ amazonpay::Amazonpay, archipel::Archipel, authorizedotnet::Authorizedotnet, bambora::Bambora, bamboraapac::Bamboraapac, bankofamerica::Bankofamerica, barclaycard::Barclaycard, billwerk::Billwerk, bitpay::Bitpay, bluesnap::Bluesnap, boku::Boku, braintree::Braintree, - cashtocode::Cashtocode, chargebee::Chargebee, checkout::Checkout, coinbase::Coinbase, - coingate::Coingate, cryptopay::Cryptopay, ctp_mastercard::CtpMastercard, + cashtocode::Cashtocode, chargebee::Chargebee, checkbook::Checkbook, checkout::Checkout, + coinbase::Coinbase, coingate::Coingate, cryptopay::Cryptopay, ctp_mastercard::CtpMastercard, cybersource::Cybersource, datatrans::Datatrans, deutschebank::Deutschebank, digitalvirgo::Digitalvirgo, dlocal::Dlocal, dwolla::Dwolla, ebanx::Ebanx, elavon::Elavon, facilitapay::Facilitapay, fiserv::Fiserv, fiservemea::Fiservemea, fiuu::Fiuu, forte::Forte, diff --git a/crates/hyperswitch_connectors/src/connectors/checkbook.rs b/crates/hyperswitch_connectors/src/connectors/checkbook.rs new file mode 100644 index 00000000000..e0f31ceb57f --- /dev/null +++ b/crates/hyperswitch_connectors/src/connectors/checkbook.rs @@ -0,0 +1,571 @@ +pub mod transformers; + +use common_utils::{ + errors::CustomResult, + ext_traits::BytesExt, + request::{Method, Request, RequestBuilder, RequestContent}, + types::{AmountConvertor, FloatMajorUnit, FloatMajorUnitForConnector}, +}; +use error_stack::{report, ResultExt}; +use hyperswitch_domain_models::{ + router_data::{AccessToken, ConnectorAuthType, ErrorResponse, RouterData}, + router_flow_types::{ + access_token_auth::AccessTokenAuth, + payments::{Authorize, Capture, PSync, PaymentMethodToken, Session, SetupMandate, Void}, + refunds::{Execute, RSync}, + }, + router_request_types::{ + AccessTokenRequestData, PaymentMethodTokenizationData, PaymentsAuthorizeData, + PaymentsCancelData, PaymentsCaptureData, PaymentsSessionData, PaymentsSyncData, + RefundsData, SetupMandateRequestData, + }, + router_response_types::{PaymentsResponseData, RefundsResponseData}, + types::{ + PaymentsAuthorizeRouterData, PaymentsCaptureRouterData, PaymentsSyncRouterData, + RefundSyncRouterData, RefundsRouterData, + }, +}; +use hyperswitch_interfaces::{ + api::{ + self, ConnectorCommon, ConnectorCommonExt, ConnectorIntegration, ConnectorSpecifications, + ConnectorValidation, + }, + configs::Connectors, + errors, + events::connector_api_logs::ConnectorEvent, + types::{self, Response}, + webhooks, +}; +use masking::{ExposeInterface, Mask}; +use transformers as checkbook; + +use crate::{constants::headers, types::ResponseRouterData, utils}; + +#[derive(Clone)] +pub struct Checkbook { + amount_converter: &'static (dyn AmountConvertor<Output = FloatMajorUnit> + Sync), +} + +impl Checkbook { + pub fn new() -> &'static Self { + &Self { + amount_converter: &FloatMajorUnitForConnector, + } + } +} + +impl api::Payment for Checkbook {} +impl api::PaymentSession for Checkbook {} +impl api::ConnectorAccessToken for Checkbook {} +impl api::MandateSetup for Checkbook {} +impl api::PaymentAuthorize for Checkbook {} +impl api::PaymentSync for Checkbook {} +impl api::PaymentCapture for Checkbook {} +impl api::PaymentVoid for Checkbook {} +impl api::Refund for Checkbook {} +impl api::RefundExecute for Checkbook {} +impl api::RefundSync for Checkbook {} +impl api::PaymentToken for Checkbook {} + +impl ConnectorIntegration<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData> + for Checkbook +{ + // Not Implemented (R) +} + +impl<Flow, Request, Response> ConnectorCommonExt<Flow, Request, Response> for Checkbook +where + Self: ConnectorIntegration<Flow, Request, Response>, +{ + fn build_headers( + &self, + req: &RouterData<Flow, Request, Response>, + _connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + let mut header = vec![( + headers::CONTENT_TYPE.to_string(), + self.get_content_type().to_string().into(), + )]; + let mut api_key = self.get_auth_header(&req.connector_auth_type)?; + header.append(&mut api_key); + Ok(header) + } +} + +impl ConnectorCommon for Checkbook { + fn id(&self) -> &'static str { + "checkbook" + } + + fn get_currency_unit(&self) -> api::CurrencyUnit { + api::CurrencyUnit::Base + } + + fn common_get_content_type(&self) -> &'static str { + "application/json" + } + + fn base_url<'a>(&self, connectors: &'a Connectors) -> &'a str { + connectors.checkbook.base_url.as_ref() + } + + fn get_auth_header( + &self, + auth_type: &ConnectorAuthType, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + let auth = checkbook::CheckbookAuthType::try_from(auth_type) + .change_context(errors::ConnectorError::FailedToObtainAuthType)?; + Ok(vec![( + headers::AUTHORIZATION.to_string(), + auth.api_key.expose().into_masked(), + )]) + } + + fn build_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + let response: checkbook::CheckbookErrorResponse = res + .response + .parse_struct("CheckbookErrorResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + + Ok(ErrorResponse { + status_code: res.status_code, + code: response.code, + message: response.message, + reason: response.reason, + attempt_status: None, + connector_transaction_id: None, + network_advice_code: None, + network_decline_code: None, + network_error_message: None, + }) + } +} + +impl ConnectorValidation for Checkbook { + //TODO: implement functions when support enabled +} + +impl ConnectorIntegration<Session, PaymentsSessionData, PaymentsResponseData> for Checkbook { + //TODO: implement sessions flow +} + +impl ConnectorIntegration<AccessTokenAuth, AccessTokenRequestData, AccessToken> for Checkbook {} + +impl ConnectorIntegration<SetupMandate, SetupMandateRequestData, PaymentsResponseData> + for Checkbook +{ +} + +impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData> for Checkbook { + fn get_headers( + &self, + req: &PaymentsAuthorizeRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsAuthorizeRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn get_request_body( + &self, + req: &PaymentsAuthorizeRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let amount = utils::convert_amount( + self.amount_converter, + req.request.minor_amount, + req.request.currency, + )?; + + let connector_router_data = checkbook::CheckbookRouterData::from((amount, req)); + let connector_req = checkbook::CheckbookPaymentsRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &PaymentsAuthorizeRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::PaymentsAuthorizeType::get_url( + self, req, connectors, + )?) + .attach_default_headers() + .headers(types::PaymentsAuthorizeType::get_headers( + self, req, connectors, + )?) + .set_body(types::PaymentsAuthorizeType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsAuthorizeRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsAuthorizeRouterData, errors::ConnectorError> { + let response: checkbook::CheckbookPaymentsResponse = res + .response + .parse_struct("Checkbook PaymentsAuthorizeResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<PSync, PaymentsSyncData, PaymentsResponseData> for Checkbook { + fn get_headers( + &self, + req: &PaymentsSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsSyncRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn build_request( + &self, + req: &PaymentsSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Get) + .url(&types::PaymentsSyncType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::PaymentsSyncType::get_headers(self, req, connectors)?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsSyncRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsSyncRouterData, errors::ConnectorError> { + let response: checkbook::CheckbookPaymentsResponse = res + .response + .parse_struct("checkbook PaymentsSyncResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<Capture, PaymentsCaptureData, PaymentsResponseData> for Checkbook { + fn get_headers( + &self, + req: &PaymentsCaptureRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsCaptureRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn get_request_body( + &self, + _req: &PaymentsCaptureRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_request_body method".to_string()).into()) + } + + fn build_request( + &self, + req: &PaymentsCaptureRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::PaymentsCaptureType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::PaymentsCaptureType::get_headers( + self, req, connectors, + )?) + .set_body(types::PaymentsCaptureType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsCaptureRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsCaptureRouterData, errors::ConnectorError> { + let response: checkbook::CheckbookPaymentsResponse = res + .response + .parse_struct("Checkbook PaymentsCaptureResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<Void, PaymentsCancelData, PaymentsResponseData> for Checkbook {} + +impl ConnectorIntegration<Execute, RefundsData, RefundsResponseData> for Checkbook { + fn get_headers( + &self, + req: &RefundsRouterData<Execute>, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &RefundsRouterData<Execute>, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn get_request_body( + &self, + req: &RefundsRouterData<Execute>, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let refund_amount = utils::convert_amount( + self.amount_converter, + req.request.minor_refund_amount, + req.request.currency, + )?; + + let connector_router_data = checkbook::CheckbookRouterData::from((refund_amount, req)); + let connector_req = checkbook::CheckbookRefundRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &RefundsRouterData<Execute>, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + let request = RequestBuilder::new() + .method(Method::Post) + .url(&types::RefundExecuteType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::RefundExecuteType::get_headers( + self, req, connectors, + )?) + .set_body(types::RefundExecuteType::get_request_body( + self, req, connectors, + )?) + .build(); + Ok(Some(request)) + } + + fn handle_response( + &self, + data: &RefundsRouterData<Execute>, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<RefundsRouterData<Execute>, errors::ConnectorError> { + let response: checkbook::RefundResponse = res + .response + .parse_struct("checkbook RefundResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<RSync, RefundsData, RefundsResponseData> for Checkbook { + fn get_headers( + &self, + req: &RefundSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &RefundSyncRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn build_request( + &self, + req: &RefundSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Get) + .url(&types::RefundSyncType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::RefundSyncType::get_headers(self, req, connectors)?) + .set_body(types::RefundSyncType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &RefundSyncRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<RefundSyncRouterData, errors::ConnectorError> { + let response: checkbook::RefundResponse = res + .response + .parse_struct("checkbook RefundSyncResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +#[async_trait::async_trait] +impl webhooks::IncomingWebhook for Checkbook { + fn get_webhook_object_reference_id( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<api_models::webhooks::ObjectReferenceId, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } + + fn get_webhook_event_type( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<api_models::webhooks::IncomingWebhookEvent, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } + + fn get_webhook_resource_object( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<Box<dyn masking::ErasedMaskSerialize>, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } +} + +impl ConnectorSpecifications for Checkbook {} diff --git a/crates/hyperswitch_connectors/src/connectors/checkbook/transformers.rs b/crates/hyperswitch_connectors/src/connectors/checkbook/transformers.rs new file mode 100644 index 00000000000..d9f009f78fe --- /dev/null +++ b/crates/hyperswitch_connectors/src/connectors/checkbook/transformers.rs @@ -0,0 +1,228 @@ +use common_enums::enums; +use common_utils::types::FloatMajorUnit; +use hyperswitch_domain_models::{ + payment_method_data::PaymentMethodData, + router_data::{ConnectorAuthType, RouterData}, + router_flow_types::refunds::{Execute, RSync}, + router_request_types::ResponseId, + router_response_types::{PaymentsResponseData, RefundsResponseData}, + types::{PaymentsAuthorizeRouterData, RefundsRouterData}, +}; +use hyperswitch_interfaces::errors; +use masking::Secret; +use serde::{Deserialize, Serialize}; + +use crate::{ + types::{RefundsResponseRouterData, ResponseRouterData}, + utils::PaymentsAuthorizeRequestData, +}; + +//TODO: Fill the struct with respective fields +pub struct CheckbookRouterData<T> { + pub amount: FloatMajorUnit, // The type of amount that a connector accepts, for example, String, i64, f64, etc. + pub router_data: T, +} + +impl<T> From<(FloatMajorUnit, T)> for CheckbookRouterData<T> { + fn from((amount, item): (FloatMajorUnit, T)) -> Self { + //Todo : use utils to convert the amount to the type of amount that a connector accepts + Self { + amount, + router_data: item, + } + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Serialize, PartialEq)] +pub struct CheckbookPaymentsRequest { + amount: FloatMajorUnit, + card: CheckbookCard, +} + +#[derive(Default, Debug, Serialize, Eq, PartialEq)] +pub struct CheckbookCard { + number: cards::CardNumber, + expiry_month: Secret<String>, + expiry_year: Secret<String>, + cvc: Secret<String>, + complete: bool, +} + +impl TryFrom<&CheckbookRouterData<&PaymentsAuthorizeRouterData>> for CheckbookPaymentsRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: &CheckbookRouterData<&PaymentsAuthorizeRouterData>, + ) -> Result<Self, Self::Error> { + match item.router_data.request.payment_method_data.clone() { + PaymentMethodData::Card(req_card) => { + let card = CheckbookCard { + number: req_card.card_number, + expiry_month: req_card.card_exp_month, + expiry_year: req_card.card_exp_year, + cvc: req_card.card_cvc, + complete: item.router_data.request.is_auto_capture()?, + }; + Ok(Self { + amount: item.amount, + card, + }) + } + _ => Err(errors::ConnectorError::NotImplemented("Payment method".to_string()).into()), + } + } +} + +//TODO: Fill the struct with respective fields +// Auth Struct +pub struct CheckbookAuthType { + pub(super) api_key: Secret<String>, +} + +impl TryFrom<&ConnectorAuthType> for CheckbookAuthType { + 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)] +#[serde(rename_all = "lowercase")] +pub enum CheckbookPaymentStatus { + Succeeded, + Failed, + #[default] + Processing, +} + +impl From<CheckbookPaymentStatus> for common_enums::AttemptStatus { + fn from(item: CheckbookPaymentStatus) -> Self { + match item { + CheckbookPaymentStatus::Succeeded => Self::Charged, + CheckbookPaymentStatus::Failed => Self::Failure, + CheckbookPaymentStatus::Processing => Self::Authorizing, + } + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] +pub struct CheckbookPaymentsResponse { + status: CheckbookPaymentStatus, + id: String, +} + +impl<F, T> TryFrom<ResponseRouterData<F, CheckbookPaymentsResponse, T, PaymentsResponseData>> + for RouterData<F, T, PaymentsResponseData> +{ + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: ResponseRouterData<F, CheckbookPaymentsResponse, T, PaymentsResponseData>, + ) -> Result<Self, Self::Error> { + Ok(Self { + status: common_enums::AttemptStatus::from(item.response.status), + response: Ok(PaymentsResponseData::TransactionResponse { + resource_id: ResponseId::ConnectorTransactionId(item.response.id), + redirection_data: Box::new(None), + mandate_reference: Box::new(None), + connector_metadata: None, + network_txn_id: None, + connector_response_reference_id: None, + incremental_authorization_allowed: None, + charges: None, + }), + ..item.data + }) + } +} + +//TODO: Fill the struct with respective fields +// REFUND : +// Type definition for RefundRequest +#[derive(Default, Debug, Serialize)] +pub struct CheckbookRefundRequest { + pub amount: FloatMajorUnit, +} + +impl<F> TryFrom<&CheckbookRouterData<&RefundsRouterData<F>>> for CheckbookRefundRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from(item: &CheckbookRouterData<&RefundsRouterData<F>>) -> Result<Self, Self::Error> { + Ok(Self { + amount: item.amount.to_owned(), + }) + } +} + +// Type definition for Refund Response + +#[allow(dead_code)] +#[derive(Debug, Serialize, Default, Deserialize, Clone)] +pub enum RefundStatus { + Succeeded, + Failed, + #[default] + Processing, +} + +impl From<RefundStatus> for enums::RefundStatus { + fn from(item: RefundStatus) -> Self { + match item { + RefundStatus::Succeeded => Self::Success, + RefundStatus::Failed => Self::Failure, + RefundStatus::Processing => Self::Pending, + //TODO: Review mapping + } + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Clone, Serialize, Deserialize)] +pub struct RefundResponse { + id: String, + status: RefundStatus, +} + +impl TryFrom<RefundsResponseRouterData<Execute, RefundResponse>> for RefundsRouterData<Execute> { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: RefundsResponseRouterData<Execute, RefundResponse>, + ) -> Result<Self, Self::Error> { + Ok(Self { + response: Ok(RefundsResponseData { + connector_refund_id: item.response.id.to_string(), + refund_status: enums::RefundStatus::from(item.response.status), + }), + ..item.data + }) + } +} + +impl TryFrom<RefundsResponseRouterData<RSync, RefundResponse>> for RefundsRouterData<RSync> { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: RefundsResponseRouterData<RSync, RefundResponse>, + ) -> Result<Self, Self::Error> { + Ok(Self { + response: Ok(RefundsResponseData { + connector_refund_id: item.response.id.to_string(), + refund_status: enums::RefundStatus::from(item.response.status), + }), + ..item.data + }) + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Serialize, Deserialize, PartialEq)] +pub struct CheckbookErrorResponse { + pub status_code: u16, + pub code: String, + pub message: String, + pub reason: Option<String>, +} diff --git a/crates/hyperswitch_connectors/src/default_implementations.rs b/crates/hyperswitch_connectors/src/default_implementations.rs index 6717a25d2ac..54c5d81edd9 100644 --- a/crates/hyperswitch_connectors/src/default_implementations.rs +++ b/crates/hyperswitch_connectors/src/default_implementations.rs @@ -160,6 +160,7 @@ default_imp_for_authorize_session_token!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -282,6 +283,7 @@ default_imp_for_calculate_tax!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -405,6 +407,7 @@ default_imp_for_session_update!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -528,6 +531,7 @@ default_imp_for_post_session_tokens!( connectors::Billwerk, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -650,6 +654,7 @@ default_imp_for_create_order!( connectors::Billwerk, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -773,6 +778,7 @@ default_imp_for_update_metadata!( connectors::Billwerk, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -894,6 +900,7 @@ default_imp_for_complete_authorize!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1002,6 +1009,7 @@ default_imp_for_incremental_authorization!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1125,6 +1133,7 @@ default_imp_for_create_customer!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1242,6 +1251,7 @@ default_imp_for_connector_redirect_response!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, @@ -1348,6 +1358,7 @@ default_imp_for_pre_processing_steps!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1462,6 +1473,7 @@ default_imp_for_post_processing_steps!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1586,6 +1598,7 @@ default_imp_for_approve!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1711,6 +1724,7 @@ default_imp_for_reject!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1836,6 +1850,7 @@ default_imp_for_webhook_source_verification!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1960,6 +1975,7 @@ default_imp_for_accept_dispute!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, @@ -2083,6 +2099,7 @@ default_imp_for_submit_evidence!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, @@ -2205,6 +2222,7 @@ default_imp_for_defend_dispute!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, @@ -2337,6 +2355,7 @@ default_imp_for_file_upload!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, @@ -2451,6 +2470,7 @@ default_imp_for_payouts!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Cryptopay, connectors::Datatrans, @@ -2569,6 +2589,7 @@ default_imp_for_payouts_create!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -2691,6 +2712,7 @@ default_imp_for_payouts_retrieve!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -2815,6 +2837,7 @@ default_imp_for_payouts_eligibility!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -2937,6 +2960,7 @@ default_imp_for_payouts_fulfill!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -3056,6 +3080,7 @@ default_imp_for_payouts_cancel!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -3179,6 +3204,7 @@ default_imp_for_payouts_quote!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -3303,6 +3329,7 @@ default_imp_for_payouts_recipient!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -3426,6 +3453,7 @@ default_imp_for_payouts_recipient_account!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -3551,6 +3579,7 @@ default_imp_for_frm_sale!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -3676,6 +3705,7 @@ default_imp_for_frm_checkout!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -3801,6 +3831,7 @@ default_imp_for_frm_transaction!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -3926,6 +3957,7 @@ default_imp_for_frm_fulfillment!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -4051,6 +4083,7 @@ default_imp_for_frm_record_return!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -4172,6 +4205,7 @@ default_imp_for_revoking_mandates!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -4293,6 +4327,7 @@ default_imp_for_uas_pre_authentication!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -4415,6 +4450,7 @@ default_imp_for_uas_post_authentication!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -4538,6 +4574,7 @@ default_imp_for_uas_authentication_confirmation!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -4653,6 +4690,7 @@ default_imp_for_connector_request_id!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -4770,6 +4808,7 @@ default_imp_for_fraud_check!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -4917,6 +4956,7 @@ default_imp_for_connector_authentication!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -5037,6 +5077,7 @@ default_imp_for_uas_authentication!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -5151,8 +5192,9 @@ default_imp_for_revenue_recovery!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, - connectors::Checkout, connectors::Chargebee, + connectors::Checkbook, + connectors::Checkout, connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, @@ -5278,6 +5320,7 @@ default_imp_for_billing_connector_payment_sync!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -5402,6 +5445,7 @@ default_imp_for_revenue_recovery_record_back!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -5526,6 +5570,7 @@ default_imp_for_billing_connector_invoice_sync!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -5644,6 +5689,7 @@ default_imp_for_external_vault!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -5768,6 +5814,7 @@ default_imp_for_external_vault_insert!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -5892,6 +5939,7 @@ default_imp_for_external_vault_retrieve!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -6016,6 +6064,7 @@ default_imp_for_external_vault_delete!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -6140,6 +6189,7 @@ default_imp_for_external_vault_create!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, diff --git a/crates/hyperswitch_connectors/src/default_implementations_v2.rs b/crates/hyperswitch_connectors/src/default_implementations_v2.rs index 0121aa1d951..27c13c9d6be 100644 --- a/crates/hyperswitch_connectors/src/default_implementations_v2.rs +++ b/crates/hyperswitch_connectors/src/default_implementations_v2.rs @@ -265,6 +265,7 @@ default_imp_for_new_connector_integration_payment!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -390,6 +391,7 @@ default_imp_for_new_connector_integration_refund!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -510,6 +512,7 @@ default_imp_for_new_connector_integration_connector_access_token!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -636,6 +639,7 @@ default_imp_for_new_connector_integration_accept_dispute!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -760,6 +764,7 @@ default_imp_for_new_connector_integration_submit_evidence!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -884,6 +889,7 @@ default_imp_for_new_connector_integration_defend_dispute!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1019,6 +1025,7 @@ default_imp_for_new_connector_integration_file_upload!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1146,6 +1153,7 @@ default_imp_for_new_connector_integration_payouts_create!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1273,6 +1281,7 @@ default_imp_for_new_connector_integration_payouts_eligibility!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1400,6 +1409,7 @@ default_imp_for_new_connector_integration_payouts_fulfill!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1527,6 +1537,7 @@ default_imp_for_new_connector_integration_payouts_cancel!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1654,6 +1665,7 @@ default_imp_for_new_connector_integration_payouts_quote!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1781,6 +1793,7 @@ default_imp_for_new_connector_integration_payouts_recipient!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1908,6 +1921,7 @@ default_imp_for_new_connector_integration_payouts_sync!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -2035,6 +2049,7 @@ default_imp_for_new_connector_integration_payouts_recipient_account!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -2160,6 +2175,7 @@ default_imp_for_new_connector_integration_webhook_source_verification!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -2287,6 +2303,7 @@ default_imp_for_new_connector_integration_frm_sale!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -2414,6 +2431,7 @@ default_imp_for_new_connector_integration_frm_checkout!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -2541,6 +2559,7 @@ default_imp_for_new_connector_integration_frm_transaction!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -2668,6 +2687,7 @@ default_imp_for_new_connector_integration_frm_fulfillment!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -2795,6 +2815,7 @@ default_imp_for_new_connector_integration_frm_record_return!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -2919,6 +2940,7 @@ default_imp_for_new_connector_integration_revoking_mandates!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -3030,6 +3052,7 @@ default_imp_for_new_connector_integration_frm!( connectors::Bluesnap, connectors::Boku, connectors::Cashtocode, + connectors::Checkbook, connectors::Coinbase, connectors::Cryptopay, connectors::CtpMastercard, @@ -3154,6 +3177,7 @@ default_imp_for_new_connector_integration_connector_authentication!( connectors::Bluesnap, connectors::Boku, connectors::Cashtocode, + connectors::Checkbook, connectors::Coinbase, connectors::Cryptopay, connectors::CtpMastercard, @@ -3267,6 +3291,7 @@ default_imp_for_new_connector_integration_revenue_recovery!( connectors::Bluesnap, connectors::Boku, connectors::Cashtocode, + connectors::Checkbook, connectors::Coinbase, connectors::Cryptopay, connectors::CtpMastercard, @@ -3397,6 +3422,7 @@ default_imp_for_new_connector_integration_external_vault!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, diff --git a/crates/hyperswitch_domain_models/src/configs.rs b/crates/hyperswitch_domain_models/src/configs.rs index ab84cf26aa4..f15ea290f56 100644 --- a/crates/hyperswitch_domain_models/src/configs.rs +++ b/crates/hyperswitch_domain_models/src/configs.rs @@ -30,6 +30,7 @@ pub struct Connectors { pub braintree: ConnectorParams, pub cashtocode: ConnectorParams, pub chargebee: ConnectorParams, + pub checkbook: ConnectorParams, pub checkout: ConnectorParams, pub coinbase: ConnectorParams, pub coingate: ConnectorParams, diff --git a/crates/router/src/connector.rs b/crates/router/src/connector.rs index de9eb4f3923..af2d9a52352 100644 --- a/crates/router/src/connector.rs +++ b/crates/router/src/connector.rs @@ -9,30 +9,31 @@ pub use hyperswitch_connectors::connectors::{ bamboraapac::Bamboraapac, bankofamerica, bankofamerica::Bankofamerica, barclaycard, barclaycard::Barclaycard, billwerk, billwerk::Billwerk, bitpay, bitpay::Bitpay, bluesnap, bluesnap::Bluesnap, boku, boku::Boku, braintree, braintree::Braintree, cashtocode, - cashtocode::Cashtocode, chargebee, chargebee::Chargebee, checkout, checkout::Checkout, - coinbase, coinbase::Coinbase, coingate, coingate::Coingate, cryptopay, cryptopay::Cryptopay, - ctp_mastercard, ctp_mastercard::CtpMastercard, cybersource, cybersource::Cybersource, - datatrans, datatrans::Datatrans, deutschebank, deutschebank::Deutschebank, digitalvirgo, - digitalvirgo::Digitalvirgo, dlocal, dlocal::Dlocal, dwolla, dwolla::Dwolla, ebanx, - ebanx::Ebanx, elavon, elavon::Elavon, facilitapay, facilitapay::Facilitapay, fiserv, - fiserv::Fiserv, fiservemea, fiservemea::Fiservemea, fiuu, fiuu::Fiuu, forte, forte::Forte, - getnet, getnet::Getnet, globalpay, globalpay::Globalpay, globepay, globepay::Globepay, - gocardless, gocardless::Gocardless, gpayments, gpayments::Gpayments, helcim, helcim::Helcim, - hipay, hipay::Hipay, hyperswitch_vault, hyperswitch_vault::HyperswitchVault, iatapay, - iatapay::Iatapay, inespay, inespay::Inespay, itaubank, itaubank::Itaubank, jpmorgan, - jpmorgan::Jpmorgan, juspaythreedsserver, juspaythreedsserver::Juspaythreedsserver, klarna, - klarna::Klarna, mifinity, mifinity::Mifinity, mollie, mollie::Mollie, moneris, - moneris::Moneris, multisafepay, multisafepay::Multisafepay, netcetera, netcetera::Netcetera, - nexinets, nexinets::Nexinets, nexixpay, nexixpay::Nexixpay, nmi, nmi::Nmi, nomupay, - nomupay::Nomupay, noon, noon::Noon, nordea, nordea::Nordea, novalnet, novalnet::Novalnet, - nuvei, nuvei::Nuvei, opayo, opayo::Opayo, opennode, opennode::Opennode, paybox, paybox::Paybox, - payeezy, payeezy::Payeezy, payme, payme::Payme, payone, payone::Payone, paypal, paypal::Paypal, - paystack, paystack::Paystack, payu, payu::Payu, placetopay, placetopay::Placetopay, plaid, - plaid::Plaid, powertranz, powertranz::Powertranz, prophetpay, prophetpay::Prophetpay, rapyd, - rapyd::Rapyd, razorpay, razorpay::Razorpay, recurly, recurly::Recurly, redsys, redsys::Redsys, - riskified, riskified::Riskified, santander, santander::Santander, shift4, shift4::Shift4, - signifyd, signifyd::Signifyd, square, square::Square, stax, stax::Stax, stripe, stripe::Stripe, - stripebilling, stripebilling::Stripebilling, taxjar, taxjar::Taxjar, threedsecureio, + cashtocode::Cashtocode, chargebee, chargebee::Chargebee, checkbook, checkbook::Checkbook, + checkout, checkout::Checkout, coinbase, coinbase::Coinbase, coingate, coingate::Coingate, + cryptopay, cryptopay::Cryptopay, ctp_mastercard, ctp_mastercard::CtpMastercard, cybersource, + cybersource::Cybersource, datatrans, datatrans::Datatrans, deutschebank, + deutschebank::Deutschebank, digitalvirgo, digitalvirgo::Digitalvirgo, dlocal, dlocal::Dlocal, + dwolla, dwolla::Dwolla, ebanx, ebanx::Ebanx, elavon, elavon::Elavon, facilitapay, + facilitapay::Facilitapay, fiserv, fiserv::Fiserv, fiservemea, fiservemea::Fiservemea, fiuu, + fiuu::Fiuu, forte, forte::Forte, getnet, getnet::Getnet, globalpay, globalpay::Globalpay, + globepay, globepay::Globepay, gocardless, gocardless::Gocardless, gpayments, + gpayments::Gpayments, helcim, helcim::Helcim, hipay, hipay::Hipay, hyperswitch_vault, + hyperswitch_vault::HyperswitchVault, iatapay, iatapay::Iatapay, inespay, inespay::Inespay, + itaubank, itaubank::Itaubank, jpmorgan, jpmorgan::Jpmorgan, juspaythreedsserver, + juspaythreedsserver::Juspaythreedsserver, klarna, klarna::Klarna, mifinity, mifinity::Mifinity, + mollie, mollie::Mollie, moneris, moneris::Moneris, multisafepay, multisafepay::Multisafepay, + netcetera, netcetera::Netcetera, nexinets, nexinets::Nexinets, nexixpay, nexixpay::Nexixpay, + nmi, nmi::Nmi, nomupay, nomupay::Nomupay, noon, noon::Noon, nordea, nordea::Nordea, novalnet, + novalnet::Novalnet, nuvei, nuvei::Nuvei, opayo, opayo::Opayo, opennode, opennode::Opennode, + paybox, paybox::Paybox, payeezy, payeezy::Payeezy, payme, payme::Payme, payone, payone::Payone, + paypal, paypal::Paypal, paystack, paystack::Paystack, payu, payu::Payu, placetopay, + placetopay::Placetopay, plaid, plaid::Plaid, powertranz, powertranz::Powertranz, prophetpay, + prophetpay::Prophetpay, rapyd, rapyd::Rapyd, razorpay, razorpay::Razorpay, recurly, + recurly::Recurly, redsys, redsys::Redsys, riskified, riskified::Riskified, santander, + santander::Santander, shift4, shift4::Shift4, signifyd, signifyd::Signifyd, square, + square::Square, stax, stax::Stax, stripe, stripe::Stripe, stripebilling, + stripebilling::Stripebilling, taxjar, taxjar::Taxjar, threedsecureio, threedsecureio::Threedsecureio, thunes, thunes::Thunes, tokenio, tokenio::Tokenio, trustpay, trustpay::Trustpay, tsys, tsys::Tsys, unified_authentication_service, unified_authentication_service::UnifiedAuthenticationService, vgs, vgs::Vgs, volt, volt::Volt, diff --git a/crates/router/src/core/admin.rs b/crates/router/src/core/admin.rs index eeb4557daf3..6763bd029b2 100644 --- a/crates/router/src/core/admin.rs +++ b/crates/router/src/core/admin.rs @@ -1456,6 +1456,10 @@ impl ConnectorAuthTypeAndMetadataValidation<'_> { chargebee::transformers::ChargebeeMetadata::try_from(self.connector_meta_data)?; Ok(()) } + // api_enums::Connector::Checkbook => { + // checkbook::transformers::CheckbookAuthType::try_from(self.auth_type)?; + // Ok(()) + // }, api_enums::Connector::Checkout => { checkout::transformers::CheckoutAuthType::try_from(self.auth_type)?; Ok(()) diff --git a/crates/router/src/types/api.rs b/crates/router/src/types/api.rs index e189a0f1a43..f40520a42e7 100644 --- a/crates/router/src/types/api.rs +++ b/crates/router/src/types/api.rs @@ -378,6 +378,9 @@ impl ConnectorData { enums::Connector::Chargebee => { Ok(ConnectorEnum::Old(Box::new(connector::Chargebee::new()))) } + // enums::Connector::Checkbook => { + // Ok(ConnectorEnum::Old(Box::new(connector::Checkbook))) + // } enums::Connector::Checkout => { Ok(ConnectorEnum::Old(Box::new(connector::Checkout::new()))) } diff --git a/crates/router/src/types/transformers.rs b/crates/router/src/types/transformers.rs index ad3d4de7f94..82ca2f7ae67 100644 --- a/crates/router/src/types/transformers.rs +++ b/crates/router/src/types/transformers.rs @@ -224,6 +224,7 @@ impl ForeignTryFrom<api_enums::Connector> for common_enums::RoutableConnectors { api_enums::Connector::Braintree => Self::Braintree, api_enums::Connector::Cashtocode => Self::Cashtocode, api_enums::Connector::Chargebee => Self::Chargebee, + // api_enums::Connector::Checkbook => Self::Checkbook, api_enums::Connector::Checkout => Self::Checkout, api_enums::Connector::Coinbase => Self::Coinbase, api_enums::Connector::Coingate => Self::Coingate, diff --git a/crates/router/tests/connectors/checkbook.rs b/crates/router/tests/connectors/checkbook.rs new file mode 100644 index 00000000000..b6b4252f852 --- /dev/null +++ b/crates/router/tests/connectors/checkbook.rs @@ -0,0 +1,420 @@ +use masking::Secret; +use router::types::{self, api, domain, storage::enums}; +use test_utils::connector_auth; + +use crate::utils::{self, ConnectorActions}; + +#[derive(Clone, Copy)] +struct CheckbookTest; +impl ConnectorActions for CheckbookTest {} +impl utils::Connector for CheckbookTest { + fn get_data(&self) -> api::ConnectorData { + use router::connector::Checkbook; + utils::construct_connector_data_old( + Box::new(Checkbook::new()), + types::Connector::DummyConnector1, + api::GetToken::Connector, + None, + ) + } + + fn get_auth_token(&self) -> types::ConnectorAuthType { + utils::to_connector_auth_type( + connector_auth::ConnectorAuthentication::new() + .checkbook + .expect("Missing connector authentication configuration") + .into(), + ) + } + + fn get_name(&self) -> String { + "checkbook".to_string() + } +} + +static CONNECTOR: CheckbookTest = CheckbookTest {}; + +fn get_default_payment_info() -> Option<utils::PaymentInfo> { + None +} + +fn payment_method_details() -> Option<types::PaymentsAuthorizeData> { + None +} + +// Cards Positive Tests +// Creates a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_only_authorize_payment() { + let response = CONNECTOR + .authorize_payment(payment_method_details(), get_default_payment_info()) + .await + .expect("Authorize payment response"); + assert_eq!(response.status, enums::AttemptStatus::Authorized); +} + +// Captures a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_capture_authorized_payment() { + let response = CONNECTOR + .authorize_and_capture_payment(payment_method_details(), None, get_default_payment_info()) + .await + .expect("Capture payment response"); + assert_eq!(response.status, enums::AttemptStatus::Charged); +} + +// Partially captures a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_capture_authorized_payment() { + let response = CONNECTOR + .authorize_and_capture_payment( + payment_method_details(), + Some(types::PaymentsCaptureData { + amount_to_capture: 50, + ..utils::PaymentCaptureType::default().0 + }), + get_default_payment_info(), + ) + .await + .expect("Capture payment response"); + assert_eq!(response.status, enums::AttemptStatus::Charged); +} + +// Synchronizes a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_authorized_payment() { + let authorize_response = CONNECTOR + .authorize_payment(payment_method_details(), get_default_payment_info()) + .await + .expect("Authorize payment response"); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + let response = CONNECTOR + .psync_retry_till_status_matches( + enums::AttemptStatus::Authorized, + Some(types::PaymentsSyncData { + connector_transaction_id: types::ResponseId::ConnectorTransactionId( + txn_id.unwrap(), + ), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .expect("PSync response"); + assert_eq!(response.status, enums::AttemptStatus::Authorized,); +} + +// Voids a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_void_authorized_payment() { + let response = CONNECTOR + .authorize_and_void_payment( + payment_method_details(), + Some(types::PaymentsCancelData { + connector_transaction_id: String::from(""), + cancellation_reason: Some("requested_by_customer".to_string()), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .expect("Void payment response"); + assert_eq!(response.status, enums::AttemptStatus::Voided); +} + +// Refunds a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_manually_captured_payment() { + let response = CONNECTOR + .capture_payment_and_refund( + payment_method_details(), + None, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Partially refunds a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_refund_manually_captured_payment() { + let response = CONNECTOR + .capture_payment_and_refund( + payment_method_details(), + None, + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Synchronizes a refund using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_manually_captured_refund() { + let refund_response = CONNECTOR + .capture_payment_and_refund( + payment_method_details(), + None, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + let response = CONNECTOR + .rsync_retry_till_status_matches( + enums::RefundStatus::Success, + refund_response.response.unwrap().connector_refund_id, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Creates a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_make_payment() { + let authorize_response = CONNECTOR + .make_payment(payment_method_details(), get_default_payment_info()) + .await + .unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); +} + +// Synchronizes a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_auto_captured_payment() { + let authorize_response = CONNECTOR + .make_payment(payment_method_details(), get_default_payment_info()) + .await + .unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + assert_ne!(txn_id, None, "Empty connector transaction id"); + let response = CONNECTOR + .psync_retry_till_status_matches( + enums::AttemptStatus::Charged, + Some(types::PaymentsSyncData { + connector_transaction_id: types::ResponseId::ConnectorTransactionId( + txn_id.unwrap(), + ), + capture_method: Some(enums::CaptureMethod::Automatic), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!(response.status, enums::AttemptStatus::Charged,); +} + +// Refunds a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_auto_captured_payment() { + let response = CONNECTOR + .make_payment_and_refund(payment_method_details(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Partially refunds a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_refund_succeeded_payment() { + let refund_response = CONNECTOR + .make_payment_and_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + refund_response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Creates multiple refunds against a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_succeeded_payment_multiple_times() { + CONNECTOR + .make_payment_and_multiple_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await; +} + +// Synchronizes a refund using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_refund() { + let refund_response = CONNECTOR + .make_payment_and_refund(payment_method_details(), None, get_default_payment_info()) + .await + .unwrap(); + let response = CONNECTOR + .rsync_retry_till_status_matches( + enums::RefundStatus::Success, + refund_response.response.unwrap().connector_refund_id, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Cards Negative scenarios +// Creates a payment with incorrect CVC. +#[actix_web::test] +async fn should_fail_payment_for_incorrect_cvc() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: domain::PaymentMethodData::Card(domain::Card { + card_cvc: Secret::new("12345".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's security code is invalid.".to_string(), + ); +} + +// Creates a payment with incorrect expiry month. +#[actix_web::test] +async fn should_fail_payment_for_invalid_exp_month() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: domain::PaymentMethodData::Card(domain::Card { + card_exp_month: Secret::new("20".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's expiration month is invalid.".to_string(), + ); +} + +// Creates a payment with incorrect expiry year. +#[actix_web::test] +async fn should_fail_payment_for_incorrect_expiry_year() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: domain::PaymentMethodData::Card(domain::Card { + card_exp_year: Secret::new("2000".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's expiration year is invalid.".to_string(), + ); +} + +// Voids a payment using automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_fail_void_payment_for_auto_capture() { + let authorize_response = CONNECTOR + .make_payment(payment_method_details(), get_default_payment_info()) + .await + .unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + assert_ne!(txn_id, None, "Empty connector transaction id"); + let void_response = CONNECTOR + .void_payment(txn_id.unwrap(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + void_response.response.unwrap_err().message, + "You cannot cancel this PaymentIntent because it has a status of succeeded." + ); +} + +// Captures a payment using invalid connector payment id. +#[actix_web::test] +async fn should_fail_capture_for_invalid_payment() { + let capture_response = CONNECTOR + .capture_payment("123456789".to_string(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + capture_response.response.unwrap_err().message, + String::from("No such payment_intent: '123456789'") + ); +} + +// Refunds a payment with refund amount higher than payment amount. +#[actix_web::test] +async fn should_fail_for_refund_amount_higher_than_payment_amount() { + let response = CONNECTOR + .make_payment_and_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 150, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Refund amount (₹1.50) is greater than charge amount (₹1.00)", + ); +} + +// Connector dependent test cases goes here + +// [#478]: add unit tests for non 3DS, wallets & webhooks in connector tests diff --git a/crates/router/tests/connectors/main.rs b/crates/router/tests/connectors/main.rs index fced1b6bff3..8005e84652b 100644 --- a/crates/router/tests/connectors/main.rs +++ b/crates/router/tests/connectors/main.rs @@ -24,6 +24,7 @@ mod bluesnap; mod boku; mod cashtocode; mod chargebee; +mod checkbook; mod checkout; mod coinbase; mod cryptopay; diff --git a/crates/router/tests/connectors/sample_auth.toml b/crates/router/tests/connectors/sample_auth.toml index 354959856bf..25c63908448 100644 --- a/crates/router/tests/connectors/sample_auth.toml +++ b/crates/router/tests/connectors/sample_auth.toml @@ -341,6 +341,10 @@ api_key = "MyApiKey" key1 = "Merchant id" api_secret = "Secret key" +[checkbook] +api_key="Client ID" +key1 ="Client Secret" + [santander] api_key="Client ID" key1 ="Client Secret" diff --git a/crates/test_utils/src/connector_auth.rs b/crates/test_utils/src/connector_auth.rs index 17d442315c6..c92d4aa8591 100644 --- a/crates/test_utils/src/connector_auth.rs +++ b/crates/test_utils/src/connector_auth.rs @@ -30,6 +30,7 @@ pub struct ConnectorAuthentication { pub boku: Option<BodyKey>, pub cashtocode: Option<BodyKey>, pub chargebee: Option<HeaderKey>, + pub checkbook: Option<BodyKey>, pub checkout: Option<SignatureKey>, pub coinbase: Option<HeaderKey>, pub coingate: Option<HeaderKey>, diff --git a/loadtest/config/development.toml b/loadtest/config/development.toml index 4fade351226..102daf94c6a 100644 --- a/loadtest/config/development.toml +++ b/loadtest/config/development.toml @@ -96,6 +96,7 @@ boku.base_url = "https://country-api4-stage.boku.com" braintree.base_url = "https://payments.sandbox.braintree-api.com/graphql" cashtocode.base_url = "https://cluster05.api-test.cashtocode.com" chargebee.base_url = "https://$.chargebee.com/api/" +checkbook.base_url = "https://api.sandbox.checkbook.io" checkout.base_url = "https://api.sandbox.checkout.com/" coinbase.base_url = "https://api.commerce.coinbase.com" coingate.base_url = "https://api-sandbox.coingate.com" @@ -223,6 +224,7 @@ cards = [ "bluesnap", "boku", "braintree", + "checkbook", "checkout", "coinbase", "coingate", diff --git a/scripts/add_connector.sh b/scripts/add_connector.sh index a8fbbb15af8..a76e9beacf9 100755 --- a/scripts/add_connector.sh +++ b/scripts/add_connector.sh @@ -6,7 +6,7 @@ function find_prev_connector() { git checkout $self cp $self $self.tmp # Add new connector to existing list and sort it - connectors=(aci adyen adyenplatform airwallex amazonpay applepay archipel authorizedotnet bambora bamboraapac bankofamerica barclaycard billwerk bitpay bluesnap boku braintree cashtocode chargebee checkout coinbase cryptopay ctp_visa cybersource datatrans deutschebank digitalvirgo dlocal dummyconnector dwolla ebanx elavon facilitapay fiserv fiservemea fiuu forte getnet globalpay globepay gocardless gpayments helcim hipay hyperswitch_vault iatapay inespay itaubank jpmorgan juspaythreedsserver klarna mifinity mollie moneris multisafepay netcetera nexinets nexixpay nomupay noon nordea novalnet nuvei opayo opennode paybox payeezy payme payone paypal paystack payu placetopay plaid powertranz prophetpay rapyd razorpay recurly redsys santander shift4 square stax stripe stripebilling taxjar threedsecureio thunes tokenio trustpay tsys unified_authentication_service vgs volt wellsfargo wellsfargopayout wise worldline worldpay worldpayvantiv worldpayxml xendit zsl "$1") + connectors=(aci adyen adyenplatform airwallex amazonpay applepay archipel authorizedotnet bambora bamboraapac bankofamerica barclaycard billwerk bitpay bluesnap boku braintree cashtocode chargebee checkbook checkout coinbase cryptopay ctp_visa cybersource datatrans deutschebank digitalvirgo dlocal dummyconnector dwolla ebanx elavon facilitapay fiserv fiservemea fiuu forte getnet globalpay globepay gocardless gpayments helcim hipay hyperswitch_vault iatapay inespay itaubank jpmorgan juspaythreedsserver klarna mifinity mollie moneris multisafepay netcetera nexinets nexixpay nomupay noon nordea novalnet nuvei opayo opennode paybox payeezy payme payone paypal paystack payu placetopay plaid powertranz prophetpay rapyd razorpay recurly redsys santander shift4 square stax stripe stripebilling taxjar threedsecureio thunes tokenio trustpay tsys unified_authentication_service vgs volt wellsfargo wellsfargopayout wise worldline worldpay worldpayvantiv worldpayxml xendit zsl "$1") IFS=$'\n' sorted=($(sort <<<"${connectors[]}")); unset IFS res="$(echo ${sorted[@]})" sed -i'' -e "s/^ connectors=./ connectors=($res \"\$1\")/" $self.tmp	2025-06-30T09:30:05Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD Closes this [issue](https://github.com/juspay/hyperswitch/issues/8493) ## Description <!-- Describe your changes in detail --> Added template code for [Checkbook](https://docs.checkbook.io/reference/) ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> No tests required ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.114.0	28d63575e63d87b1cba7c6215faee803f2fff7d8	28d63575e63d87b1cba7c6215faee803f2fff7d8
juspay/hyperswitch	juspay__hyperswitch-8462	Bug: chore: bump tonic version bumping tonic version from 0.12 to 0.13.1	diff --git a/Cargo.lock b/Cargo.lock index 42add100ade..b578a5ff88f 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1186,14 +1186,14 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "3a6c9af12842a67734c9a2e355436e5d03b22383ed60cf13cd0c18fbfe3dcbcf" dependencies = [ "async-trait", - "axum-core", + "axum-core 0.4.3", "bytes 1.10.1", "futures-util", "http 1.3.1", "http-body 1.0.1", "http-body-util", "itoa", - "matchit", + "matchit 0.7.3", "memchr", "mime", "percent-encoding", @@ -1201,7 +1201,33 @@ dependencies = [ "rustversion", "serde", "sync_wrapper 1.0.1", - "tower", + "tower 0.4.13", + "tower-layer", + "tower-service", +] + +[[package]] +name = "axum" +version = "0.8.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "021e862c184ae977658b36c4500f7feac3221ca5da43e3f25bd04ab6c79a29b5" +dependencies = [ + "axum-core 0.5.2", + "bytes 1.10.1", + "futures-util", + "http 1.3.1", + "http-body 1.0.1", + "http-body-util", + "itoa", + "matchit 0.8.4", + "memchr", + "mime", + "percent-encoding", + "pin-project-lite", + "rustversion", + "serde", + "sync_wrapper 1.0.1", + "tower 0.5.2", "tower-layer", "tower-service", ] @@ -1226,6 +1252,25 @@ dependencies = [ "tower-service", ] +[[package]] +name = "axum-core" +version = "0.5.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "68464cd0412f486726fb3373129ef5d2993f90c34bc2bc1c1e9943b2f4fc7ca6" +dependencies = [ + "bytes 1.10.1", + "futures-core", + "http 1.3.1", + "http-body 1.0.1", + "http-body-util", + "mime", + "pin-project-lite", + "rustversion", + "sync_wrapper 1.0.1", + "tower-layer", + "tower-service", +] + [[package]] name = "backtrace" version = "0.3.74" @@ -2969,7 +3014,7 @@ dependencies = [ "serde", "thiserror 1.0.69", "tokio 1.45.1", - "tonic", + "tonic 0.13.1", "tonic-build", "tonic-reflection", "tonic-types", @@ -4704,6 +4749,12 @@ version = "0.7.3" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "0e7465ac9959cc2b1404e8e2367b43684a6d13790fe23056cc8c6c5a6b7bcb94" +[[package]] +name = "matchit" +version = "0.8.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "47e1ffaa40ddd1f3ed91f717a33c8c0ee23fff369e3aa8772b9605cc1d22f4c3" + [[package]] name = "maud" version = "0.26.0" @@ -5337,7 +5388,7 @@ dependencies = [ "prost", "thiserror 1.0.69", "tokio 1.45.1", - "tonic", + "tonic 0.12.3", ] [[package]] @@ -5349,7 +5400,7 @@ dependencies = [ "opentelemetry", "opentelemetry_sdk", "prost", - "tonic", + "tonic 0.12.3", ] [[package]] @@ -5951,8 +6002,8 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "f8650aabb6c35b860610e9cff5dc1af886c9e25073b7b1712a68972af4281302" dependencies = [ "bytes 1.10.1", - "heck 0.4.1", - "itertools 0.10.5", + "heck 0.5.0", + "itertools 0.13.0", "log", "multimap", "once_cell", @@ -5972,7 +6023,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "acf0c195eebb4af52c752bec4f52f645da98b6e92077a04110c7f349477ae5ac" dependencies = [ "anyhow", - "itertools 0.10.5", + "itertools 0.13.0", "proc-macro2", "quote", "syn 2.0.101", @@ -8796,7 +8847,7 @@ checksum = "877c5b330756d856ffcc4553ab34a5684481ade925ecc54bcd1bf02b1d0d4d52" dependencies = [ "async-stream", "async-trait", - "axum", + "axum 0.7.5", "base64 0.22.1", "bytes 1.10.1", "h2 0.4.8", @@ -8812,7 +8863,36 @@ dependencies = [ "socket2", "tokio 1.45.1", "tokio-stream", - "tower", + "tower 0.4.13", + "tower-layer", + "tower-service", + "tracing", +] + +[[package]] +name = "tonic" +version = "0.13.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7e581ba15a835f4d9ea06c55ab1bd4dce26fc53752c69a04aac00703bfb49ba9" +dependencies = [ + "async-trait", + "axum 0.8.4", + "base64 0.22.1", + "bytes 1.10.1", + "h2 0.4.8", + "http 1.3.1", + "http-body 1.0.1", + "http-body-util", + "hyper 1.6.0", + "hyper-timeout", + "hyper-util", + "percent-encoding", + "pin-project", + "prost", + "socket2", + "tokio 1.45.1", + "tokio-stream", + "tower 0.5.2", "tower-layer", "tower-service", "tracing", @@ -8820,39 +8900,40 @@ dependencies = [ [[package]] name = "tonic-build" -version = "0.12.2" +version = "0.13.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "fe4ee8877250136bd7e3d2331632810a4df4ea5e004656990d8d66d2f5ee8a67" +checksum = "eac6f67be712d12f0b41328db3137e0d0757645d8904b4cb7d51cd9c2279e847" dependencies = [ "prettyplease", "proc-macro2", "prost-build", + "prost-types", "quote", "syn 2.0.101", ] [[package]] name = "tonic-reflection" -version = "0.12.3" +version = "0.13.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "878d81f52e7fcfd80026b7fdb6a9b578b3c3653ba987f87f0dce4b64043cba27" +checksum = "f9687bd5bfeafebdded2356950f278bba8226f0b32109537c4253406e09aafe1" dependencies = [ "prost", "prost-types", "tokio 1.45.1", "tokio-stream", - "tonic", + "tonic 0.13.1", ] [[package]] name = "tonic-types" -version = "0.12.3" +version = "0.13.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0081d8ee0847d01271392a5aebe960a4600f5d4da6c67648a6382a0940f8b367" +checksum = "07439468da24d5f211d3f3bd7b63665d8f45072804457e838a87414a478e2db8" dependencies = [ "prost", "prost-types", - "tonic", + "tonic 0.13.1", ] [[package]] @@ -8891,6 +8972,25 @@ dependencies = [ "tracing", ] +[[package]] +name = "tower" +version = "0.5.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d039ad9159c98b70ecfd540b2573b97f7f52c3e8d9f8ad57a24b916a536975f9" +dependencies = [ + "futures-core", + "futures-util", + "indexmap 2.9.0", + "pin-project-lite", + "slab", + "sync_wrapper 1.0.1", + "tokio 1.45.1", + "tokio-util", + "tower-layer", + "tower-service", + "tracing", +] + [[package]] name = "tower-layer" version = "0.3.3" @@ -9057,7 +9157,7 @@ version = "1.6.3" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "97fee6b57c6a41524a810daee9286c02d7752c4253064d0b05472833a438f675" dependencies = [ - "cfg-if 0.1.10", + "cfg-if 1.0.0", "static_assertions", ] @@ -9610,7 +9710,7 @@ version = "0.1.9" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "cf221c93e13a30d793f7645a0e7762c55d169dbb0a49671918a2319d289b10bb" dependencies = [ - "windows-sys 0.48.0", + "windows-sys 0.59.0", ] [[package]] diff --git a/crates/external_services/Cargo.toml b/crates/external_services/Cargo.toml index 34aca99f399..4002e117c62 100644 --- a/crates/external_services/Cargo.toml +++ b/crates/external_services/Cargo.toml @@ -48,9 +48,9 @@ thiserror = "1.0.69" vaultrs = { version = "0.7.4", optional = true } prost = { version = "0.13", optional = true } tokio = "1.45.1" -tonic = { version = "0.12.3", optional = true } -tonic-reflection = { version = "0.12.3", optional = true } -tonic-types = { version = "0.12.3", optional = true } +tonic = { version = "0.13.1", optional = true } +tonic-reflection = { version = "0.13.1", optional = true } +tonic-types = { version = "0.13.1", optional = true } hyper-util = { version = "0.1.12", optional = true } http-body-util = { version = "0.1.3", optional = true } reqwest = { version = "0.11.27", features = ["rustls-tls"] } @@ -71,7 +71,7 @@ api_models = { version = "0.1.0", path = "../api_models", optional = true } [build-dependencies] -tonic-build = { version = "0.12", optional = true } +tonic-build = { version = "0.13.1", optional = true } router_env = { version = "0.1.0", path = "../router_env", default-features = false, optional = true } [lints] diff --git a/crates/external_services/build.rs b/crates/external_services/build.rs index 8dba0bb3e98..c9d9017560b 100644 --- a/crates/external_services/build.rs +++ b/crates/external_services/build.rs @@ -14,7 +14,7 @@ fn main() -> Result<(), Box<dyn std::error::Error>> { // Compile the .proto file tonic_build::configure() .out_dir(out_dir) - .compile( + .compile_protos( &[ success_rate_proto_file, health_check_proto_file, diff --git a/crates/external_services/src/grpc_client.rs b/crates/external_services/src/grpc_client.rs index 7a627d3ab27..45b98c51154 100644 --- a/crates/external_services/src/grpc_client.rs +++ b/crates/external_services/src/grpc_client.rs @@ -13,20 +13,16 @@ use dynamic_routing::{DynamicRoutingClientConfig, RoutingStrategy}; #[cfg(feature = "dynamic_routing")] use health_check_client::HealthCheckClient; #[cfg(feature = "dynamic_routing")] -use http_body_util::combinators::UnsyncBoxBody; -#[cfg(feature = "dynamic_routing")] -use hyper::body::Bytes; -#[cfg(feature = "dynamic_routing")] use hyper_util::client::legacy::connect::HttpConnector; #[cfg(feature = "dynamic_routing")] use router_env::logger; use serde; #[cfg(feature = "dynamic_routing")] -use tonic::Status; +use tonic::body::Body; #[cfg(feature = "dynamic_routing")] /// Hyper based Client type for maintaining connection pool for all gRPC services -pub type Client = hyper_util::client::legacy::Client<HttpConnector, UnsyncBoxBody<Bytes, Status>>; +pub type Client = hyper_util::client::legacy::Client<HttpConnector, Body>; /// Struct contains all the gRPC Clients #[derive(Debug, Clone)]	2025-06-25T12:29:54Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description bumping tonic version from 0.12 to 0.13 ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> ## How did you test it? - The client connection was success <img width="1725" alt="Screenshot 2025-06-25 at 6 00 12 PM" src="https://github.com/user-attachments/assets/7981c4cc-041e-4426-a158-d66af2d1e2cd" /> - got response for the health check api ``` { "database": true, "redis": true, "analytics": true, "opensearch": false, "outgoing_request": true, "grpc_health_check": { "dynamic_routing_service": true }, "decision_engine": false } ``` ## Checklist <!-- Put an `x` in the boxes that apply --> - [ ] I formatted the code `cargo +nightly fmt --all` - [ ] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.114.0	0a06ad91252d76d0c937344d8c76c9a2bbbc84d7	0a06ad91252d76d0c937344d8c76c9a2bbbc84d7
juspay/hyperswitch	juspay__hyperswitch-8464	Bug: [FEATURE] allow data migration at profile level ### Feature Description The `migrate_payment_methods` API is used for migrating customer and payment method data. Currently, it operates at the merchant level, but since the `merchant_connector_id` is tied to a specific profile, migrations are limited to a single profile at a time. This feature aims to enhance the data migration process to support multiple profiles. The goal is to allow a single payment method to be migrated across several `merchant_connector_id`s, enabling data migration at the profile level. ### Implementation Plan Below are the the changes: Customer Data Migration: * Update `PaymentMethodRecord` to allow `merchant_connector_id` and `connector_customer_id` to accept comma-separated strings. * Update `PaymentMethodCustomerMigrate` to handle a list of connector customer details. * The `From` implementation for `PaymentMethodCustomerMigrate` will be updated to parse these new comma-separated strings. * Finally, update the `create_customer` function to handle the list of connector details, allowing a customer to be associated with multiple connector accounts. Payment Method Migration: * Update `PaymentMethodsMigrateForm` to accept a comma-separated string for `merchant_connector_id`. * The functions `get_payment_method_records` and `migrate_payment_methods` will be updated to handle this change. * The `TryFrom` implementation for `PaymentMethodMigrate` will be modified to create a `PaymentsMandateReference` for each `merchant_connector_id` in the comma-separated string. All changes will be backward-compatible. ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? Yes, I am willing to submit a PR!	diff --git a/crates/api_models/src/payment_methods.rs b/crates/api_models/src/payment_methods.rs index c681cf7edd0..b3e76e37291 100644 --- a/crates/api_models/src/payment_methods.rs +++ b/crates/api_models/src/payment_methods.rs @@ -19,7 +19,7 @@ use utoipa::{schema, ToSchema}; #[cfg(feature = "payouts")] use crate::payouts; use crate::{ - admin, customers, enums as api_enums, + admin, enums as api_enums, payments::{self, BankCodeResponse}, }; @@ -2517,6 +2517,7 @@ pub struct PaymentMethodRecord { pub billing_address_line3: Option<masking::Secret<String>>, pub raw_card_number: Option<masking::Secret<String>>, pub merchant_connector_id: Option<id_type::MerchantConnectorAccountId>, + pub merchant_connector_ids: Option<String>, pub original_transaction_amount: Option<i64>, pub original_transaction_currency: Option<common_enums::Currency>, pub line_number: Option<i64>, @@ -2526,18 +2527,6 @@ pub struct PaymentMethodRecord { pub network_token_requestor_ref_id: Option<String>, } -#[derive(Debug, Clone, serde::Deserialize, serde::Serialize)] -pub struct ConnectorCustomerDetails { - pub connector_customer_id: String, - pub merchant_connector_id: id_type::MerchantConnectorAccountId, -} - -#[derive(Debug, Clone, serde::Deserialize, serde::Serialize)] -pub struct PaymentMethodCustomerMigrate { - pub customer: customers::CustomerRequest, - pub connector_customer_details: Option<ConnectorCustomerDetails>, -} - #[derive(Debug, Default, serde::Serialize)] pub struct PaymentMethodMigrationResponse { pub line_number: Option<i64>, @@ -2654,47 +2643,56 @@ impl From<PaymentMethodMigrationResponseType> for PaymentMethodMigrationResponse impl TryFrom<( - PaymentMethodRecord, + &PaymentMethodRecord, id_type::MerchantId, - Option<id_type::MerchantConnectorAccountId>, + Option<&Vec<id_type::MerchantConnectorAccountId>>, )> for PaymentMethodMigrate { type Error = error_stack::Report<errors::ValidationError>; + fn try_from( item: ( - PaymentMethodRecord, + &PaymentMethodRecord, id_type::MerchantId, - Option<id_type::MerchantConnectorAccountId>, + Option<&Vec<id_type::MerchantConnectorAccountId>>, ), ) -> Result<Self, Self::Error> { - let (record, merchant_id, mca_id) = item; + let (record, merchant_id, mca_ids) = item; let billing = record.create_billing(); - - // if payment instrument id is present then only construct this - let connector_mandate_details = if record.payment_instrument_id.is_some() { - Some(PaymentsMandateReference(HashMap::from([( - mca_id.get_required_value("merchant_connector_id")?, - PaymentsMandateReferenceRecord { - connector_mandate_id: record - .payment_instrument_id - .get_required_value("payment_instrument_id")? - .peek() - .to_string(), - payment_method_type: record.payment_method_type, - original_payment_authorized_amount: record.original_transaction_amount, - original_payment_authorized_currency: record.original_transaction_currency, - }, - )]))) + let connector_mandate_details = if let Some(payment_instrument_id) = + &record.payment_instrument_id + { + let ids = mca_ids.get_required_value("mca_ids")?; + let mandate_map: HashMap<_, _> = ids + .iter() + .map(\|mca_id\| { + ( + mca_id.clone(), + PaymentsMandateReferenceRecord { + connector_mandate_id: payment_instrument_id.peek().to_string(), + payment_method_type: record.payment_method_type, + original_payment_authorized_amount: record.original_transaction_amount, + original_payment_authorized_currency: record + .original_transaction_currency, + }, + ) + }) + .collect(); + Some(PaymentsMandateReference(mandate_map)) } else { None }; + Ok(Self { merchant_id, - customer_id: Some(record.customer_id), + customer_id: Some(record.customer_id.clone()), card: Some(MigrateCardDetail { - card_number: record.raw_card_number.unwrap_or(record.card_number_masked), - card_exp_month: record.card_expiry_month, - card_exp_year: record.card_expiry_year, + card_number: record + .raw_card_number + .clone() + .unwrap_or_else(\|\| record.card_number_masked.clone()), + card_exp_month: record.card_expiry_month.clone(), + card_exp_year: record.card_expiry_year.clone(), card_holder_name: record.name.clone(), card_network: None, card_type: None, @@ -2704,10 +2702,16 @@ impl }), network_token: Some(MigrateNetworkTokenDetail { network_token_data: MigrateNetworkTokenData { - network_token_number: record.network_token_number.unwrap_or_default(), - network_token_exp_month: record.network_token_expiry_month.unwrap_or_default(), - network_token_exp_year: record.network_token_expiry_year.unwrap_or_default(), - card_holder_name: record.name, + network_token_number: record.network_token_number.clone().unwrap_or_default(), + network_token_exp_month: record + .network_token_expiry_month + .clone() + .unwrap_or_default(), + network_token_exp_year: record + .network_token_expiry_year + .clone() + .unwrap_or_default(), + card_holder_name: record.name.clone(), nick_name: record.nick_name.clone(), card_issuing_country: None, card_network: None, @@ -2716,6 +2720,7 @@ impl }, network_token_requestor_ref_id: record .network_token_requestor_ref_id + .clone() .unwrap_or_default(), }), payment_method: record.payment_method, @@ -2740,45 +2745,6 @@ impl } } -#[cfg(feature = "v1")] -impl From<(PaymentMethodRecord, id_type::MerchantId)> for PaymentMethodCustomerMigrate { - fn from(value: (PaymentMethodRecord, id_type::MerchantId)) -> Self { - let (record, merchant_id) = value; - Self { - customer: customers::CustomerRequest { - customer_id: Some(record.customer_id), - merchant_id, - name: record.name, - email: record.email, - phone: record.phone, - description: None, - phone_country_code: record.phone_country_code, - address: Some(payments::AddressDetails { - city: record.billing_address_city, - country: record.billing_address_country, - line1: record.billing_address_line1, - line2: record.billing_address_line2, - state: record.billing_address_state, - line3: record.billing_address_line3, - zip: record.billing_address_zip, - first_name: record.billing_address_first_name, - last_name: record.billing_address_last_name, - }), - metadata: None, - }, - connector_customer_details: record - .connector_customer_id - .zip(record.merchant_connector_id) - .map( - \|(connector_customer_id, merchant_connector_id)\| ConnectorCustomerDetails { - connector_customer_id, - merchant_connector_id, - }, - ), - } - } -} - #[derive(Debug, serde::Deserialize, serde::Serialize, ToSchema)] pub struct CardNetworkTokenizeRequest { /// Merchant ID associated with the tokenization request diff --git a/crates/hyperswitch_domain_models/src/lib.rs b/crates/hyperswitch_domain_models/src/lib.rs index 4ee8620e35e..35570036c20 100644 --- a/crates/hyperswitch_domain_models/src/lib.rs +++ b/crates/hyperswitch_domain_models/src/lib.rs @@ -36,6 +36,7 @@ pub mod router_response_types; pub mod routing; #[cfg(feature = "tokenization_v2")] pub mod tokenization; +pub mod transformers; pub mod type_encryption; pub mod types; pub mod vault; diff --git a/crates/hyperswitch_domain_models/src/payment_methods.rs b/crates/hyperswitch_domain_models/src/payment_methods.rs index 0f6d4d6f924..aa01465408e 100644 --- a/crates/hyperswitch_domain_models/src/payment_methods.rs +++ b/crates/hyperswitch_domain_models/src/payment_methods.rs @@ -1,5 +1,6 @@ #[cfg(feature = "v2")] use api_models::payment_methods::PaymentMethodsData; +use api_models::{customers, payment_methods, payments}; // specific imports because of using the macro use common_enums::enums::MerchantStorageScheme; #[cfg(feature = "v1")] @@ -27,11 +28,12 @@ use time::PrimitiveDateTime; #[cfg(feature = "v2")] use crate::address::Address; #[cfg(feature = "v1")] -use crate::{mandates, type_encryption::AsyncLift}; +use crate::type_encryption::AsyncLift; use crate::{ - mandates::CommonMandateReference, + mandates::{self, CommonMandateReference}, merchant_key_store::MerchantKeyStore, payment_method_data as domain_payment_method_data, + transformers::ForeignTryFrom, type_encryption::{crypto_operation, CryptoOperation}, }; @@ -87,7 +89,6 @@ pub struct PaymentMethod { pub network_token_locker_id: Option<String>, pub network_token_payment_method_data: OptionalEncryptableValue, } - #[cfg(feature = "v2")] #[derive(Clone, Debug, router_derive::ToEncryption)] pub struct PaymentMethod { @@ -915,6 +916,136 @@ pub struct PaymentMethodsSessionUpdateInternal { pub tokenization_data: Option<pii::SecretSerdeValue>, } +#[derive(Debug, Clone, serde::Deserialize, serde::Serialize)] +pub struct ConnectorCustomerDetails { + pub connector_customer_id: String, + pub merchant_connector_id: id_type::MerchantConnectorAccountId, +} + +#[derive(Debug, Clone, serde::Deserialize, serde::Serialize)] +pub struct PaymentMethodCustomerMigrate { + pub customer: customers::CustomerRequest, + pub connector_customer_details: Option<Vec<ConnectorCustomerDetails>>, +} + +#[cfg(feature = "v1")] +impl TryFrom<(payment_methods::PaymentMethodRecord, id_type::MerchantId)> + for PaymentMethodCustomerMigrate +{ + type Error = error_stack::Report<ValidationError>; + fn try_from( + value: (payment_methods::PaymentMethodRecord, id_type::MerchantId), + ) -> Result<Self, Self::Error> { + let (record, merchant_id) = value; + let connector_customer_details = record + .connector_customer_id + .and_then(\|connector_customer_id\| { + // Handle single merchant_connector_id + record + .merchant_connector_id + .as_ref() + .map(\|merchant_connector_id\| { + Ok(vec![ConnectorCustomerDetails { + connector_customer_id: connector_customer_id.clone(), + merchant_connector_id: merchant_connector_id.clone(), + }]) + }) + // Handle comma-separated merchant_connector_ids + .or_else(\|\| { + record + .merchant_connector_ids + .as_ref() + .map(\|merchant_connector_ids_str\| { + merchant_connector_ids_str + .split(',') + .map(\|id\| id.trim()) + .filter(\|id\| !id.is_empty()) + .map(\|merchant_connector_id\| { + id_type::MerchantConnectorAccountId::wrap( + merchant_connector_id.to_string(), + ) + .map_err(\|_\| { + error_stack::report!(ValidationError::InvalidValue { + message: format!( + "Invalid merchant_connector_account_id: {}", + merchant_connector_id + ), + }) + }) + .map( + \|merchant_connector_id\| ConnectorCustomerDetails { + connector_customer_id: connector_customer_id + .clone(), + merchant_connector_id, + }, + ) + }) + .collect::<Result<Vec<_>, _>>() + }) + }) + }) + .transpose()?; + + Ok(Self { + customer: customers::CustomerRequest { + customer_id: Some(record.customer_id), + merchant_id, + name: record.name, + email: record.email, + phone: record.phone, + description: None, + phone_country_code: record.phone_country_code, + address: Some(payments::AddressDetails { + city: record.billing_address_city, + country: record.billing_address_country, + line1: record.billing_address_line1, + line2: record.billing_address_line2, + state: record.billing_address_state, + line3: record.billing_address_line3, + zip: record.billing_address_zip, + first_name: record.billing_address_first_name, + last_name: record.billing_address_last_name, + }), + metadata: None, + }, + connector_customer_details, + }) + } +} + +#[cfg(feature = "v1")] +impl ForeignTryFrom<(&[payment_methods::PaymentMethodRecord], id_type::MerchantId)> + for Vec<PaymentMethodCustomerMigrate> +{ + type Error = error_stack::Report<ValidationError>; + + fn foreign_try_from( + (records, merchant_id): (&[payment_methods::PaymentMethodRecord], id_type::MerchantId), + ) -> Result<Self, Self::Error> { + let (customers_migration, migration_errors): (Self, Vec<_>) = records + .iter() + .map(\|record\| { + PaymentMethodCustomerMigrate::try_from((record.clone(), merchant_id.clone())) + }) + .fold((Self::new(), Vec::new()), \|mut acc, result\| { + match result { + Ok(customer) => acc.0.push(customer), + Err(e) => acc.1.push(e.to_string()), + } + acc + }); + + migration_errors + .is_empty() + .then_some(customers_migration) + .ok_or_else(\|\| { + error_stack::report!(ValidationError::InvalidValue { + message: migration_errors.join(", "), + }) + }) + } +} + #[cfg(feature = "v1")] #[cfg(test)] mod tests { diff --git a/crates/hyperswitch_domain_models/src/transformers.rs b/crates/hyperswitch_domain_models/src/transformers.rs new file mode 100644 index 00000000000..1208d80c323 --- /dev/null +++ b/crates/hyperswitch_domain_models/src/transformers.rs @@ -0,0 +1,9 @@ +pub trait ForeignFrom<F> { + fn foreign_from(from: F) -> Self; +} + +pub trait ForeignTryFrom<F>: Sized { + type Error; + + fn foreign_try_from(from: F) -> Result<Self, Self::Error>; +} diff --git a/crates/payment_methods/src/core/migration.rs b/crates/payment_methods/src/core/migration.rs index 8b2694cf6fe..6b7ce30b4c5 100644 --- a/crates/payment_methods/src/core/migration.rs +++ b/crates/payment_methods/src/core/migration.rs @@ -24,20 +24,22 @@ pub async fn migrate_payment_methods( payment_methods: Vec<pm_api::PaymentMethodRecord>, merchant_id: &common_utils::id_type::MerchantId, merchant_context: &merchant_context::MerchantContext, - mca_id: Option<common_utils::id_type::MerchantConnectorAccountId>, + mca_ids: Option<Vec<common_utils::id_type::MerchantConnectorAccountId>>, controller: &dyn pm::PaymentMethodsController, ) -> PmMigrationResult<Vec<pm_api::PaymentMethodMigrationResponse>> { - let mut result = Vec::new(); + let mut result = Vec::with_capacity(payment_methods.len()); + for record in payment_methods { let req = pm_api::PaymentMethodMigrate::try_from(( - record.clone(), + &record, merchant_id.clone(), - mca_id.clone(), + mca_ids.as_ref(), )) .map_err(\|err\| errors::ApiErrorResponse::InvalidRequestData { message: format!("error: {:?}", err), }) .attach_printable("record deserialization failed"); + let res = match req { Ok(migrate_request) => { let res = migrate_payment_method( @@ -56,6 +58,7 @@ pub async fn migrate_payment_methods( } Err(e) => Err(e.to_string()), }; + result.push(pm_api::PaymentMethodMigrationResponse::from((res, record))); } Ok(api::ApplicationResponse::Json(result)) @@ -69,7 +72,138 @@ pub struct PaymentMethodsMigrateForm { pub merchant_id: text::Text<common_utils::id_type::MerchantId>, pub merchant_connector_id: - text::Text<Option<common_utils::id_type::MerchantConnectorAccountId>>, + Option<text::Text<common_utils::id_type::MerchantConnectorAccountId>>, + + pub merchant_connector_ids: Option<text::Text<String>>, +} + +struct MerchantConnectorValidator; + +impl MerchantConnectorValidator { + fn parse_comma_separated_ids( + ids_string: &str, + ) -> Result<Vec<common_utils::id_type::MerchantConnectorAccountId>, errors::ApiErrorResponse> + { + // Estimate capacity based on comma count + let capacity = ids_string.matches(',').count() + 1; + let mut result = Vec::with_capacity(capacity); + + for id in ids_string.split(',') { + let trimmed_id = id.trim(); + if !trimmed_id.is_empty() { + let mca_id = + common_utils::id_type::MerchantConnectorAccountId::wrap(trimmed_id.to_string()) + .map_err(\|_\| errors::ApiErrorResponse::InvalidRequestData { + message: format!( + "Invalid merchant_connector_account_id: {}", + trimmed_id + ), + })?; + result.push(mca_id); + } + } + + Ok(result) + } + + fn validate_form_csv_conflicts( + records: &[pm_api::PaymentMethodRecord], + form_has_single_id: bool, + form_has_multiple_ids: bool, + ) -> Result<(), errors::ApiErrorResponse> { + if form_has_single_id { + // If form has merchant_connector_id, CSV records should not have merchant_connector_ids + for (index, record) in records.iter().enumerate() { + if record.merchant_connector_ids.is_some() { + return Err(errors::ApiErrorResponse::InvalidRequestData { + message: format!( + "Record at line {} has merchant_connector_ids but form has merchant_connector_id. Only one should be provided", + index + 1 + ), + }); + } + } + } + + if form_has_multiple_ids { + // If form has merchant_connector_ids, CSV records should not have merchant_connector_id + for (index, record) in records.iter().enumerate() { + if record.merchant_connector_id.is_some() { + return Err(errors::ApiErrorResponse::InvalidRequestData { + message: format!( + "Record at line {} has merchant_connector_id but form has merchant_connector_ids. Only one should be provided", + index + 1 + ), + }); + } + } + } + + Ok(()) + } +} + +type MigrationValidationResult = Result< + ( + common_utils::id_type::MerchantId, + Vec<pm_api::PaymentMethodRecord>, + Option<Vec<common_utils::id_type::MerchantConnectorAccountId>>, + ), + errors::ApiErrorResponse, +>; + +impl PaymentMethodsMigrateForm { + pub fn validate_and_get_payment_method_records(self) -> MigrationValidationResult { + // Step 1: Validate form-level conflicts + let form_has_single_id = self.merchant_connector_id.is_some(); + let form_has_multiple_ids = self.merchant_connector_ids.is_some(); + + if form_has_single_id && form_has_multiple_ids { + return Err(errors::ApiErrorResponse::InvalidRequestData { + message: "Both merchant_connector_id and merchant_connector_ids cannot be provided" + .to_string(), + }); + } + + // Ensure at least one is provided + if !form_has_single_id && !form_has_multiple_ids { + return Err(errors::ApiErrorResponse::InvalidRequestData { + message: "Either merchant_connector_id or merchant_connector_ids must be provided" + .to_string(), + }); + } + + // Step 2: Parse CSV + let records = parse_csv(self.file.data.to_bytes()).map_err(\|e\| { + errors::ApiErrorResponse::PreconditionFailed { + message: e.to_string(), + } + })?; + + // Step 3: Validate CSV vs Form conflicts + MerchantConnectorValidator::validate_form_csv_conflicts( + &records, + form_has_single_id, + form_has_multiple_ids, + )?; + + // Step 4: Prepare the merchant connector account IDs for return + let mca_ids = if let Some(ref single_id) = self.merchant_connector_id { + Some(vec![(**single_id).clone()]) + } else if let Some(ref ids_string) = self.merchant_connector_ids { + let parsed_ids = MerchantConnectorValidator::parse_comma_separated_ids(ids_string)?; + if parsed_ids.is_empty() { + None + } else { + Some(parsed_ids) + } + } else { + None + }; + + // Step 5: Return the updated structure + Ok((self.merchant_id.clone(), records, mca_ids)) + } } fn parse_csv(data: &[u8]) -> csv::Result<Vec<pm_api::PaymentMethodRecord>> { @@ -84,27 +218,6 @@ fn parse_csv(data: &[u8]) -> csv::Result<Vec<pm_api::PaymentMethodRecord>> { } Ok(records) } -pub fn get_payment_method_records( - form: PaymentMethodsMigrateForm, -) -> Result< - ( - common_utils::id_type::MerchantId, - Vec<pm_api::PaymentMethodRecord>, - Option<common_utils::id_type::MerchantConnectorAccountId>, - ), - errors::ApiErrorResponse, -> { - match parse_csv(form.file.data.to_bytes()) { - Ok(records) => { - let merchant_id = form.merchant_id.clone(); - let mca_id = form.merchant_connector_id.clone(); - Ok((merchant_id.clone(), records, mca_id)) - } - Err(e) => Err(errors::ApiErrorResponse::PreconditionFailed { - message: e.to_string(), - }), - } -} #[instrument(skip_all)] pub fn validate_card_expiry( diff --git a/crates/router/src/core/customers.rs b/crates/router/src/core/customers.rs index 2cad1d91eb8..43dbf28c0e0 100644 --- a/crates/router/src/core/customers.rs +++ b/crates/router/src/core/customers.rs @@ -9,6 +9,7 @@ use common_utils::{ }, }; use error_stack::{report, ResultExt}; +use hyperswitch_domain_models::payment_methods as payment_methods_domain; use masking::{ExposeInterface, Secret, SwitchStrategy}; use payment_methods::controller::PaymentMethodsController; use router_env::{instrument, tracing}; @@ -27,7 +28,7 @@ use crate::{ routes::{metrics, SessionState}, services, types::{ - api::{customers, payment_methods as payment_methods_api}, + api::customers, domain::{self, types}, storage::{self, enums}, transformers::ForeignFrom, @@ -41,7 +42,7 @@ pub async fn create_customer( state: SessionState, merchant_context: domain::MerchantContext, customer_data: customers::CustomerRequest, - connector_customer_details: Option<payment_methods_api::ConnectorCustomerDetails>, + connector_customer_details: Option<Vec<payment_methods_domain::ConnectorCustomerDetails>>, ) -> errors::CustomerResponse<customers::CustomerResponse> { let db: &dyn StorageInterface = state.store.as_ref(); let key_manager_state = &(&state).into(); @@ -96,7 +97,9 @@ pub async fn create_customer( trait CustomerCreateBridge { async fn create_domain_model_from_request<'a>( &'a self, - connector_customer_details: &'a Option<payment_methods_api::ConnectorCustomerDetails>, + connector_customer_details: &'a Option< + Vec<payment_methods_domain::ConnectorCustomerDetails>, + >, db: &'a dyn StorageInterface, merchant_reference_id: &'a Option<id_type::CustomerId>, merchant_context: &'a domain::MerchantContext, @@ -115,7 +118,9 @@ trait CustomerCreateBridge { impl CustomerCreateBridge for customers::CustomerRequest { async fn create_domain_model_from_request<'a>( &'a self, - connector_customer_details: &'a Option<payment_methods_api::ConnectorCustomerDetails>, + connector_customer_details: &'a Option< + Vec<payment_methods_domain::ConnectorCustomerDetails>, + >, db: &'a dyn StorageInterface, merchant_reference_id: &'a Option<id_type::CustomerId>, merchant_context: &'a domain::MerchantContext, @@ -175,13 +180,15 @@ impl CustomerCreateBridge for customers::CustomerRequest { domain::FromRequestEncryptableCustomer::from_encryptable(encrypted_data) .change_context(errors::CustomersErrorResponse::InternalServerError)?; - let connector_customer = connector_customer_details.as_ref().map(\|details\| { - let merchant_connector_id = details.merchant_connector_id.get_string_repr().to_string(); - let connector_customer_id = details.connector_customer_id.to_string(); - let object = serde_json::json!({ - merchant_connector_id: connector_customer_id - }); - pii::SecretSerdeValue::new(object) + let connector_customer = connector_customer_details.as_ref().map(\|details_vec\| { + let mut map = serde_json::Map::new(); + for details in details_vec { + let merchant_connector_id = + details.merchant_connector_id.get_string_repr().to_string(); + let connector_customer_id = details.connector_customer_id.clone(); + map.insert(merchant_connector_id, connector_customer_id.into()); + } + pii::SecretSerdeValue::new(serde_json::Value::Object(map)) }); Ok(domain::Customer { @@ -227,7 +234,9 @@ impl CustomerCreateBridge for customers::CustomerRequest { impl CustomerCreateBridge for customers::CustomerRequest { async fn create_domain_model_from_request<'a>( &'a self, - connector_customer_details: &'a Option<payment_methods_api::ConnectorCustomerDetails>, + connector_customer_details: &'a Option< + Vec<payment_methods_domain::ConnectorCustomerDetails>, + >, _db: &'a dyn StorageInterface, merchant_reference_id: &'a Option<id_type::CustomerId>, merchant_context: &'a domain::MerchantContext, @@ -297,12 +306,16 @@ impl CustomerCreateBridge for customers::CustomerRequest { domain::FromRequestEncryptableCustomer::from_encryptable(encrypted_data) .change_context(errors::CustomersErrorResponse::InternalServerError)?; - let connector_customer = connector_customer_details.as_ref().map(\|details\| { - let mut map = std::collections::HashMap::new(); - map.insert( - details.merchant_connector_id.clone(), - details.connector_customer_id.to_string(), - ); + let connector_customer = connector_customer_details.as_ref().map(\|details_vec\| { + let map: std::collections::HashMap<_, _> = details_vec + .iter() + .map(\|details\| { + ( + details.merchant_connector_id.clone(), + details.connector_customer_id.to_string(), + ) + }) + .collect(); common_types::customers::ConnectorCustomerMap::new(map) }); @@ -1060,7 +1073,9 @@ pub async fn update_customer( trait CustomerUpdateBridge { async fn create_domain_model_from_request<'a>( &'a self, - connector_customer_details: &'a Option<payment_methods_api::ConnectorCustomerDetails>, + connector_customer_details: &'a Option< + Vec<payment_methods_domain::ConnectorCustomerDetails>, + >, db: &'a dyn StorageInterface, merchant_context: &'a domain::MerchantContext, key_manager_state: &'a KeyManagerState, @@ -1232,7 +1247,9 @@ impl VerifyIdForUpdateCustomer<'_> { impl CustomerUpdateBridge for customers::CustomerUpdateRequest { async fn create_domain_model_from_request<'a>( &'a self, - _connector_customer_details: &'a Option<payment_methods_api::ConnectorCustomerDetails>, + _connector_customer_details: &'a Option< + Vec<payment_methods_domain::ConnectorCustomerDetails>, + >, db: &'a dyn StorageInterface, merchant_context: &'a domain::MerchantContext, key_manager_state: &'a KeyManagerState, @@ -1337,7 +1354,9 @@ impl CustomerUpdateBridge for customers::CustomerUpdateRequest { impl CustomerUpdateBridge for customers::CustomerUpdateRequest { async fn create_domain_model_from_request<'a>( &'a self, - connector_customer_details: &'a Option<payment_methods_api::ConnectorCustomerDetails>, + connector_customer_details: &'a Option< + Vec<payment_methods_domain::ConnectorCustomerDetails>, + >, db: &'a dyn StorageInterface, merchant_context: &'a domain::MerchantContext, key_manager_state: &'a KeyManagerState, @@ -1454,7 +1473,7 @@ impl CustomerUpdateBridge for customers::CustomerUpdateRequest { pub async fn migrate_customers( state: SessionState, - customers_migration: Vec<payment_methods_api::PaymentMethodCustomerMigrate>, + customers_migration: Vec<payment_methods_domain::PaymentMethodCustomerMigrate>, merchant_context: domain::MerchantContext, ) -> errors::CustomerResponse<()> { for customer_migration in customers_migration { diff --git a/crates/router/src/routes/payment_methods.rs b/crates/router/src/routes/payment_methods.rs index 20d0121ebde..31558c2d323 100644 --- a/crates/router/src/routes/payment_methods.rs +++ b/crates/router/src/routes/payment_methods.rs @@ -10,6 +10,7 @@ use diesel_models::enums::IntentStatus; use error_stack::ResultExt; use hyperswitch_domain_models::{ bulk_tokenization::CardNetworkTokenizeRequest, merchant_key_store::MerchantKeyStore, + payment_methods::PaymentMethodCustomerMigrate, transformers::ForeignTryFrom, }; use router_env::{instrument, logger, tracing, Flow}; @@ -331,10 +332,10 @@ pub async fn migrate_payment_methods( MultipartForm(form): MultipartForm<migration::PaymentMethodsMigrateForm>, ) -> HttpResponse { let flow = Flow::PaymentMethodsMigrate; - let (merchant_id, records, merchant_connector_id) = - match migration::get_payment_method_records(form) { - Ok((merchant_id, records, merchant_connector_id)) => { - (merchant_id, records, merchant_connector_id) + let (merchant_id, records, merchant_connector_ids) = + match form.validate_and_get_payment_method_records() { + Ok((merchant_id, records, merchant_connector_ids)) => { + (merchant_id, records, merchant_connector_ids) } Err(e) => return api::log_and_return_error_response(e.into()), }; @@ -345,7 +346,7 @@ pub async fn migrate_payment_methods( records, \|state, _, req, _\| { let merchant_id = merchant_id.clone(); - let merchant_connector_id = merchant_connector_id.clone(); + let merchant_connector_ids = merchant_connector_ids.clone(); async move { let (key_store, merchant_account) = get_merchant_account(&state, &merchant_id).await?; @@ -354,20 +355,43 @@ pub async fn migrate_payment_methods( domain::Context(merchant_account.clone(), key_store.clone()), )); - customers::migrate_customers( - state.clone(), - req.iter() - .map(\|e\| { - payment_methods::PaymentMethodCustomerMigrate::from(( - e.clone(), - merchant_id.clone(), - )) - }) - .collect(), - merchant_context.clone(), - ) - .await - .change_context(errors::ApiErrorResponse::InternalServerError)?; + let mut mca_cache = std::collections::HashMap::new(); + let customers = Vec::<PaymentMethodCustomerMigrate>::foreign_try_from(( + &req, + merchant_id.clone(), + )) + .map_err(\|e\| errors::ApiErrorResponse::InvalidRequestData { + message: e.to_string(), + })?; + + for record in &customers { + if let Some(connector_customer_details) = &record.connector_customer_details { + for connector_customer in connector_customer_details { + if !mca_cache.contains_key(&connector_customer.merchant_connector_id) { + let mca = state + .store + .find_by_merchant_connector_account_merchant_id_merchant_connector_id( + &(&state).into(), + &merchant_id, + &connector_customer.merchant_connector_id, + merchant_context.get_merchant_key_store(), + ) + .await + .to_not_found_response( + errors::ApiErrorResponse::MerchantConnectorAccountNotFound { + id: connector_customer.merchant_connector_id.get_string_repr().to_string(), + }, + )?; + mca_cache + .insert(connector_customer.merchant_connector_id.clone(), mca); + } + } + } + } + + customers::migrate_customers(state.clone(), customers, merchant_context.clone()) + .await + .change_context(errors::ApiErrorResponse::InternalServerError)?; let controller = cards::PmCards { state: &state, merchant_context: &merchant_context, @@ -377,7 +401,7 @@ pub async fn migrate_payment_methods( req, &merchant_id, &merchant_context, - merchant_connector_id, + merchant_connector_ids, &controller, )) .await diff --git a/crates/router/src/types/api/payment_methods.rs b/crates/router/src/types/api/payment_methods.rs index 0c29b58cbb6..4c094af5acc 100644 --- a/crates/router/src/types/api/payment_methods.rs +++ b/crates/router/src/types/api/payment_methods.rs @@ -1,32 +1,30 @@ #[cfg(feature = "v2")] pub use api_models::payment_methods::{ CardDetail, CardDetailFromLocker, CardDetailsPaymentMethod, CardNetworkTokenizeRequest, - CardNetworkTokenizeResponse, CardType, ConnectorCustomerDetails, - CustomerPaymentMethodResponseItem, DeleteTokenizeByTokenRequest, GetTokenizePayloadRequest, - GetTokenizePayloadResponse, ListCountriesCurrenciesRequest, MigrateCardDetail, - NetworkTokenDetailsPaymentMethod, NetworkTokenDetailsResponse, NetworkTokenResponse, - PaymentMethodCollectLinkRenderRequest, PaymentMethodCollectLinkRequest, PaymentMethodCreate, - PaymentMethodCreateData, PaymentMethodCustomerMigrate, PaymentMethodDeleteResponse, - PaymentMethodId, PaymentMethodIntentConfirm, PaymentMethodIntentCreate, PaymentMethodListData, - PaymentMethodListRequest, PaymentMethodListResponseForSession, PaymentMethodMigrate, - PaymentMethodMigrateResponse, PaymentMethodResponse, PaymentMethodResponseData, - PaymentMethodUpdate, PaymentMethodUpdateData, PaymentMethodsData, TokenDataResponse, - TokenDetailsResponse, TokenizePayloadEncrypted, TokenizePayloadRequest, TokenizedCardValue1, - TokenizedCardValue2, TokenizedWalletValue1, TokenizedWalletValue2, - TotalPaymentMethodCountResponse, + CardNetworkTokenizeResponse, CardType, CustomerPaymentMethodResponseItem, + DeleteTokenizeByTokenRequest, GetTokenizePayloadRequest, GetTokenizePayloadResponse, + ListCountriesCurrenciesRequest, MigrateCardDetail, NetworkTokenDetailsPaymentMethod, + NetworkTokenDetailsResponse, NetworkTokenResponse, PaymentMethodCollectLinkRenderRequest, + PaymentMethodCollectLinkRequest, PaymentMethodCreate, PaymentMethodCreateData, + PaymentMethodDeleteResponse, PaymentMethodId, PaymentMethodIntentConfirm, + PaymentMethodIntentCreate, PaymentMethodListData, PaymentMethodListRequest, + PaymentMethodListResponseForSession, PaymentMethodMigrate, PaymentMethodMigrateResponse, + PaymentMethodResponse, PaymentMethodResponseData, PaymentMethodUpdate, PaymentMethodUpdateData, + PaymentMethodsData, TokenDataResponse, TokenDetailsResponse, TokenizePayloadEncrypted, + TokenizePayloadRequest, TokenizedCardValue1, TokenizedCardValue2, TokenizedWalletValue1, + TokenizedWalletValue2, TotalPaymentMethodCountResponse, }; #[cfg(feature = "v1")] pub use api_models::payment_methods::{ CardDetail, CardDetailFromLocker, CardDetailsPaymentMethod, CardNetworkTokenizeRequest, - CardNetworkTokenizeResponse, ConnectorCustomerDetails, CustomerPaymentMethod, - CustomerPaymentMethodsListResponse, DefaultPaymentMethod, DeleteTokenizeByTokenRequest, - GetTokenizePayloadRequest, GetTokenizePayloadResponse, ListCountriesCurrenciesRequest, - MigrateCardDetail, PaymentMethodCollectLinkRenderRequest, PaymentMethodCollectLinkRequest, - PaymentMethodCreate, PaymentMethodCreateData, PaymentMethodCustomerMigrate, - PaymentMethodDeleteResponse, PaymentMethodId, PaymentMethodListRequest, - PaymentMethodListResponse, PaymentMethodMigrate, PaymentMethodMigrateResponse, - PaymentMethodResponse, PaymentMethodUpdate, PaymentMethodsData, TokenizeCardRequest, - TokenizeDataRequest, TokenizePayloadEncrypted, TokenizePayloadRequest, + CardNetworkTokenizeResponse, CustomerPaymentMethod, CustomerPaymentMethodsListResponse, + DefaultPaymentMethod, DeleteTokenizeByTokenRequest, GetTokenizePayloadRequest, + GetTokenizePayloadResponse, ListCountriesCurrenciesRequest, MigrateCardDetail, + PaymentMethodCollectLinkRenderRequest, PaymentMethodCollectLinkRequest, PaymentMethodCreate, + PaymentMethodCreateData, PaymentMethodDeleteResponse, PaymentMethodId, + PaymentMethodListRequest, PaymentMethodListResponse, PaymentMethodMigrate, + PaymentMethodMigrateResponse, PaymentMethodResponse, PaymentMethodUpdate, PaymentMethodsData, + TokenizeCardRequest, TokenizeDataRequest, TokenizePayloadEncrypted, TokenizePayloadRequest, TokenizePaymentMethodRequest, TokenizedCardValue1, TokenizedCardValue2, TokenizedWalletValue1, TokenizedWalletValue2, }; diff --git a/flake.nix b/flake.nix index e9bcb936d7b..35fa05b73a7 100644 --- a/flake.nix +++ b/flake.nix @@ -31,6 +31,7 @@ openssl pkg-config postgresql # for libpq + protobuf ]; # Minimal packages for running hyperswitch @@ -40,6 +41,7 @@ # Development packages devPackages = base ++ (with pkgs; [ + cargo-watch nixd rust-bin.stable.${rustDevVersion}.default swagger-cli	2025-06-26T18:47:13Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description This pull request enhances the data migration API to support migrating customer and payment method data across multiple business profiles in a single request. Specifically, the following changes have been made: 1. Customer Data Migration: * Updated `PaymentMethodRecord` to allow `merchant_connector_id` to accept comma-separated string values. * Modified `PaymentMethodCustomerMigrate` to use a `Vec` of connector-specific customer details. * The `TryFrom<PaymentMethodRecord>` implementation for `PaymentMethodCustomerMigrate` has been updated to parse this comma-separated string. 2. Payment Method Migration: * Updated `PaymentMethodsMigrateForm` to accept a comma-separated string for `merchant_connector_id`. * The `get_payment_method_records` and `migrate_payment_methods` functions are updated to process multiple `merchant_connector_id`s. * The `TryFrom` implementation for `PaymentMethodMigrate` is modified to create a `PaymentsMandateReference` for each `merchant_connector_id` provided. ### Additional Changes - [x] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context This allows migrating a payment method entity across multiple profiles (as `MerchantConnectorAccountId` is tied to a profile) during batch migration. ## How did you test it? <details> <summary>1. Batch migration for multiple profiles</summary> cURL curl --location --request POST 'http://localhost:8080/payment_methods/migrate-batch' \ --header 'api-key: test_admin' \ --form 'merchant_id="merchant_1751020165"' \ --form 'merchant_connector_ids="mca_lwpasOxD1FtFmG4SVdjX,mca_4tsKLvIinX1uVL8p9mhy"' \ --form 'file=@"migrate.csv"' Response [{"line_number":1,"payment_method_id":"pm_AO2rTJwFIH0I9yQiZ0zT","payment_method":"card","payment_method_type":"debit","customer_id":"45CC60D1F2283097BB1DE41A2636414445908518D50B8B4CDC57959CD7FB4539","migration_status":"Success","card_number_masked":"4360000 xxxx 0005","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":2,"payment_method_id":"pm_ZN9z4oKF439uxyBerwfL","payment_method":"card","payment_method_type":"credit","customer_id":"782BC898951D910C1A99DA69A4E4FAD6CEE53AB9311FA2C552028DA89428DB7F","migration_status":"Success","card_number_masked":"4111111 xxxx 1111","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null}] Things to verify in DB 1. `connector_mandate_details` for a given payment_method_id in response has connector_mandate_id for multiple MCAs <img width="421" alt="Screenshot 2025-06-28 at 3 09 18 PM" src="https://github.com/user-attachments/assets/8cfe8449-5ed1-441e-bd77-26540d5b6531" /> 2. `connector_customer` for a given customer_id in response has mappings for multiple MCAs <img width="748" alt="Screenshot 2025-06-28 at 3 09 41 PM" src="https://github.com/user-attachments/assets/dec23184-8014-4d8c-91b4-369ec6670e22" /> </details> <details> <summary>2. Batch migration for a single profile - For ensuring backwards compatibility</summary> cURL curl --location --request POST 'http://localhost:8080/payment_methods/migrate-batch' \ --header 'api-key: test_admin' \ --form 'merchant_id="merchant_1751020165"' \ --form 'merchant_connector_id="mca_lwpasOxD1FtFmG4SVdjX"' \ --form 'file=@"migrate.csv"' Response [{"line_number":1,"payment_method_id":"pm_ZGPPsRrU5f4IgVpMS9tj","payment_method":"card","payment_method_type":"debit","customer_id":"45CC60D1F2283097BB1DE41A2636414445908518D50B8B4CDC57959CD7FB4539","migration_status":"Success","card_number_masked":"4360000 xxxx 0005","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":2,"payment_method_id":"pm_Lf2vcheQkYIiZx8PIDHt","payment_method":"card","payment_method_type":"credit","customer_id":"782BC898951D910C1A99DA69A4E4FAD6CEE53AB9311FA2C552028DA89428DB7F","migration_status":"Success","card_number_masked":"4111111 xxxx 1111","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null}] Things to verify in DB - PM migration happens for a single MCA (connector_mandate_details) - Customer migration happens for a single MCA (connector_customer) </details> Sample migration data for multi profile migration [multi-migrate-sample.csv](https://github.com/user-attachments/files/20974125/multi-migrate-sample.csv) ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.114.0	6c66c36a66b6644c43761b7ac9c1326945a6a820	6c66c36a66b6644c43761b7ac9c1326945a6a820
juspay/hyperswitch	juspay__hyperswitch-8460	Bug: [BUG] DB constraints for events table ### Bug Description `idempotent_event_id` column is a combination of `payment_id` and the `event_type`. Length of this field in DB can be a maximum of 64 characters. However, since `payment_id` can also be 64 characters, the resulting `idempotent_event_id` can easily exceed 64 characters leading to inconsistent behavior in the flows. Currently, this is breaking outgoing webhooks flow. ### Expected Behavior Outgoing webhooks flow should succeed. ### Actual Behavior Outgoing webhooks flow breaks due to DB constraints. ``` { "message": "[INCOMING_WEBHOOKS_CORE - EVENT] Incoming webhook flow failed", "extra": { "error": "{\"error\":{\"type\":\"router_error\",\"code\":\"WE_03\",\"message\":\"There was some issue processing the webhook\"}}\\n├╴at crates/router/src/core/webhooks/outgoing.rs:196:18\\n├╴Failed to insert event in events table\\n├╴Incoming webhook flow for payments failed\\n│\\n╰─▶ DatabaseError: An unknown error occurred\\n ├╴at /router/crates/diesel_models/src/query/generics.rs:89:36\\n ├╴Error while inserting EventNew { event_id: \"evt_01979b2125017d93bb4d846d42979839\", event_type: PaymentAuthorized, event_class: Payments, is_webhook_notified: false, primary_object_id: \"AFR_202506237e491a4f-1bd8-4d97-a9a6-a2f86832bc79\", primary_object_type: PaymentDetails, created_at: 2025-06-23 4:52:10.113410262, merchant_id: Some(MerchantId(\"merchant_1741787326\")), business_profile_id: Some(ProfileId(\"pro_r3uCseg4NT35RBFpmUPA\")), primary_object_created_at: Some(2025-06-23 4:51:14.154239), idempotent_event_id: Some(\"AFR_202506237e491a4f-1bd8-4d97-a9a6-a2f86832bc79_payment_authorized\"), initial_attempt_id: Some(\"evt_01979b2125017d93bb4d846d42979839\"), request: Some(Encryption { inner: * Encrypted data of length 7223 bytes * }), response: None, delivery_attempt: Some(InitialAttempt), metadata: Some(Payment { payment_id: PaymentId(\"AFR_202506237e491a4f-1bd8-4d97-a9a6-a2f86832bc79\") }), is_overall_delivery_successful: Some(false) }\\n │\\n ╰─▶ value too long for type character varying(64)\\n ╰╴at /router/crates/diesel_models/src/query/generics.rs:89:22\\n ╰╴at crates/router/src/db/events.rs:129:30" } } ``` ### Steps To Reproduce -- ### Context For The Bug -- ### Environment -- ### Have you spent some time checking if this bug has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? None	diff --git a/crates/common_utils/src/consts.rs b/crates/common_utils/src/consts.rs index 59ec5377690..bbb65e1afc6 100644 --- a/crates/common_utils/src/consts.rs +++ b/crates/common_utils/src/consts.rs @@ -97,6 +97,11 @@ pub const BASE64_ENGINE: base64::engine::GeneralPurpose = base64::engine::genera /// URL Safe base64 engine pub const BASE64_ENGINE_URL_SAFE: base64::engine::GeneralPurpose = base64::engine::general_purpose::URL_SAFE; + +/// URL Safe base64 engine without padding +pub const BASE64_ENGINE_URL_SAFE_NO_PAD: base64::engine::GeneralPurpose = + base64::engine::general_purpose::URL_SAFE_NO_PAD; + /// Regex for matching a domain /// Eg - /// http://www.example.com diff --git a/crates/router/src/core/errors.rs b/crates/router/src/core/errors.rs index bf5330a9325..a980bb664ef 100644 --- a/crates/router/src/core/errors.rs +++ b/crates/router/src/core/errors.rs @@ -157,6 +157,8 @@ pub enum WebhooksFlowError { OutgoingWebhookRetrySchedulingFailed, #[error("Outgoing webhook response encoding failed")] OutgoingWebhookResponseEncodingFailed, + #[error("ID generation failed")] + IdGenerationFailed, } impl WebhooksFlowError { @@ -174,7 +176,8 @@ impl WebhooksFlowError { \| Self::DisputeWebhookValidationFailed \| Self::OutgoingWebhookEncodingFailed \| Self::OutgoingWebhookProcessTrackerTaskUpdateFailed - \| Self::OutgoingWebhookRetrySchedulingFailed => true, + \| Self::OutgoingWebhookRetrySchedulingFailed + \| Self::IdGenerationFailed => true, } } } diff --git a/crates/router/src/core/webhooks/outgoing.rs b/crates/router/src/core/webhooks/outgoing.rs index 34b49c2fc8a..adc54b09b94 100644 --- a/crates/router/src/core/webhooks/outgoing.rs +++ b/crates/router/src/core/webhooks/outgoing.rs @@ -60,7 +60,9 @@ pub(crate) async fn create_event_and_trigger_outgoing_webhook( ) -> CustomResult<(), errors::ApiErrorResponse> { let delivery_attempt = enums::WebhookDeliveryAttempt::InitialAttempt; let idempotent_event_id = - utils::get_idempotent_event_id(&primary_object_id, event_type, delivery_attempt); + utils::get_idempotent_event_id(&primary_object_id, event_type, delivery_attempt) + .change_context(errors::ApiErrorResponse::WebhookProcessingFailure) + .attach_printable("Failed to generate idempotent event ID")?; let webhook_url_result = get_webhook_url_from_business_profile(&business_profile); if !state.conf.webhooks.outgoing_enabled diff --git a/crates/router/src/core/webhooks/outgoing_v2.rs b/crates/router/src/core/webhooks/outgoing_v2.rs index 07758817e68..d0e0ecaa69a 100644 --- a/crates/router/src/core/webhooks/outgoing_v2.rs +++ b/crates/router/src/core/webhooks/outgoing_v2.rs @@ -48,7 +48,9 @@ pub(crate) async fn create_event_and_trigger_outgoing_webhook( ) -> CustomResult<(), errors::ApiErrorResponse> { let delivery_attempt = enums::WebhookDeliveryAttempt::InitialAttempt; let idempotent_event_id = - utils::get_idempotent_event_id(&primary_object_id, event_type, delivery_attempt); + utils::get_idempotent_event_id(&primary_object_id, event_type, delivery_attempt) + .change_context(errors::ApiErrorResponse::WebhookProcessingFailure) + .attach_printable("Failed to generate idempotent event ID")?; let webhook_url_result = business_profile .get_webhook_url_from_profile() .change_context(errors::WebhooksFlowError::MerchantWebhookUrlNotConfigured); diff --git a/crates/router/src/core/webhooks/utils.rs b/crates/router/src/core/webhooks/utils.rs index 45b6c24a2ed..0344d7d010e 100644 --- a/crates/router/src/core/webhooks/utils.rs +++ b/crates/router/src/core/webhooks/utils.rs @@ -1,6 +1,12 @@ use std::marker::PhantomData; -use common_utils::{errors::CustomResult, ext_traits::ValueExt}; +use base64::Engine; +use common_utils::{ + consts, + crypto::{self, GenerateDigest}, + errors::CustomResult, + ext_traits::ValueExt, +}; use error_stack::{Report, ResultExt}; use redis_interface as redis; use router_env::tracing; @@ -146,18 +152,28 @@ pub(crate) fn get_idempotent_event_id( primary_object_id: &str, event_type: types::storage::enums::EventType, delivery_attempt: types::storage::enums::WebhookDeliveryAttempt, -) -> String { +) -> Result<String, Report<errors::WebhooksFlowError>> { use crate::types::storage::enums::WebhookDeliveryAttempt; const EVENT_ID_SUFFIX_LENGTH: usize = 8; let common_prefix = format!("{primary_object_id}_{event_type}"); - match delivery_attempt { - WebhookDeliveryAttempt::InitialAttempt => common_prefix, + + // Hash the common prefix with SHA256 and encode with URL-safe base64 without padding + let digest = crypto::Sha256 + .generate_digest(common_prefix.as_bytes()) + .change_context(errors::WebhooksFlowError::IdGenerationFailed) + .attach_printable("Failed to generate idempotent event ID")?; + let base_encoded = consts::BASE64_ENGINE_URL_SAFE_NO_PAD.encode(digest); + + let result = match delivery_attempt { + WebhookDeliveryAttempt::InitialAttempt => base_encoded, WebhookDeliveryAttempt::AutomaticRetry \| WebhookDeliveryAttempt::ManualRetry => { - common_utils::generate_id(EVENT_ID_SUFFIX_LENGTH, &common_prefix) + common_utils::generate_id(EVENT_ID_SUFFIX_LENGTH, &base_encoded) } - } + }; + + Ok(result) } #[inline] diff --git a/crates/router/src/core/webhooks/webhook_events.rs b/crates/router/src/core/webhooks/webhook_events.rs index 44ce4fdd515..700295af0ec 100644 --- a/crates/router/src/core/webhooks/webhook_events.rs +++ b/crates/router/src/core/webhooks/webhook_events.rs @@ -287,7 +287,9 @@ pub async fn retry_delivery_attempt( &event_to_retry.primary_object_id, event_to_retry.event_type, delivery_attempt, - ); + ) + .change_context(errors::ApiErrorResponse::WebhookProcessingFailure) + .attach_printable("Failed to generate idempotent event ID")?; let now = common_utils::date_time::now(); let new_event = domain::Event { diff --git a/crates/router/src/workflows/outgoing_webhook_retry.rs b/crates/router/src/workflows/outgoing_webhook_retry.rs index 559f62b1a4a..d84f0b26dc7 100644 --- a/crates/router/src/workflows/outgoing_webhook_retry.rs +++ b/crates/router/src/workflows/outgoing_webhook_retry.rs @@ -72,7 +72,9 @@ impl ProcessTrackerWorkflow<SessionState> for OutgoingWebhookRetryWorkflow { &tracking_data.primary_object_id, tracking_data.event_type, delivery_attempt, - ); + ) + .change_context(errors::ApiErrorResponse::WebhookProcessingFailure) + .attach_printable("Failed to generate idempotent event ID")?; let initial_event = match &tracking_data.initial_attempt_id { Some(initial_attempt_id) => {	2025-09-16T13:24:24Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [x] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> This change updates the idempotent_event_id generation to first hash the base string with SHA256 and then encode it using URL-safe Base64 without padding. By doing this, the generated IDs are guaranteed to be short and deterministic, ensuring they always fit within the 64-character database column limit. This fix addresses the issue where long payment_ids combined with event types were exceeding the DB constraint and breaking the outgoing webhooks flow. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> The idempotent_event_id column is a combination of payment_id and event_type. The DB column length is limited to 64 characters. Since payment_id itself can be up to 64 characters long, appending event_type causes the field to exceed the limit, leading to database constraint violations. Currently, this breaks the outgoing webhooks flow. Additionally, during staggered deployments and rollback, the uniqueness of these IDs may cause dual webhook dispatches. closes #8460 ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> 1. Started the local Node.js Express webhook listener on port 3000 using the server.js script. <details> <summary>server.js script</summary> ``` mkdir -p /tmp/hs-webhooks && cd /tmp/hs-webhooks npm init -y >/dev/null npm i express >/dev/null cat > server.js <<'JS' const express = require('express'); const app = express(); app.use(express.json({ type: '/' })); app.post('/webhooks/hs', (req, res) => { console.log('---- Webhook received ----'); console.log('Headers:', req.headers); console.log('Body:', JSON.stringify(req.body, null, 2)); res.sendStatus(200); }); app.listen(3000, () => console.log('Webhook listener running on port 3000')); JS node server.js ``` </details> 2. Merchant Creation <details> <summary>Merchant creation Curl</summary> ```bash curl --location 'http://localhost:8080/accounts' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: test_admin' \ --data-raw '{ "merchant_id": "merchant_1758029612", "locker_id": "m0010", "merchant_name": "worldpay", "merchant_details": { "primary_contact_person": "John Test", "primary_email": "[email protected]", "primary_phone": "sunt laborum", "secondary_contact_person": "John Test2", "secondary_email": "[email protected]", "secondary_phone": "cillum do dolor id", "website": "https://www.example.com", "about_business": "Online Retail with a wide selection of organic products for North America", "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name":"john", "last_name":"Doe" } }, "return_url": "https://google.com/success", "webhook_details": { "webhook_version": "1.0.1", "webhook_username": "ekart_retail", "webhook_password": "password_ekart@123", "webhook_url":"http://localhost:3000/webhooks/hs", "payment_created_enabled": true, "payment_succeeded_enabled": true, "payment_failed_enabled": true }, "sub_merchants_enabled": false, "parent_merchant_id":"merchant_123", "metadata": { "city": "NY", "unit": "245", "merchant_name": "Acme Widgets LLC" }, "primary_business_details": [ { "country": "US", "business": "default" } ] }' ``` </details> After this when i created payment it created event with these idempotent_event_id. <img width="533" height="165" alt="image" src="https://github.com/user-attachments/assets/6610ede4-6ffe-4de1-bde3-664ac00abec4" /> <details> <summary>Manual Retry Curl</summary> ``` curl --location --request POST 'http://localhost:8080/events/merchant_1758190753/evt_01995ce5346575608391d7f8b825175d/retry' \ --header 'api-key: test_admin' ``` </details> <img width="559" height="252" alt="image" src="https://github.com/user-attachments/assets/cb652d7b-5749-48f0-b2f7-78726411e789" /> For primary object id greater than 64 chars still generated idempotent_event_id will always be less than 64 characters in length. <img width="831" height="33" alt="image" src="https://github.com/user-attachments/assets/3d7b838a-df61-401e-ac2c-fd7e5cd5b4c8" /> ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.117.0	f3ab3d63f69279af9254f15eba5654c0680a0747	f3ab3d63f69279af9254f15eba5654c0680a0747
juspay/hyperswitch	juspay__hyperswitch-8442	Bug: [FEATURE] Add x-mcp extension to OpenAPI schema Mintlify supports extracting API endpoints from openAPI json into MCP servers: https://mintlify.com/docs/mcp We need to add: ```json "x-mcp": { "enabled": true }, ``` at the top level of our OpenAPI schema to enable this functionality	diff --git a/README.md b/README.md index a46baab5244..35964d72bf5 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ <a href="https://x.com/hyperswitchio"> <img src="https://img.shields.io/badge/follow-%40hyperswitchio-white?logo=x&labelColor=grey"/> </a> - <a href="https://join.slack.com/t/hyperswitch-io/shared_invite/zt-2jqxmpsbm-WXUENx022HjNEy~Ark7Orw"> + <a href="https://inviter.co/hyperswitch-slack"> <img src="https://img.shields.io/badge/chat-on_slack-blue?logo=slack&labelColor=grey&color=%233f0e40"/> </a> </p> @@ -196,7 +196,7 @@ We welcome contributors from around the world to help build Hyperswitch. Whether Please read our [contributing guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) to get started. -Join the conversation on [Slack](https://join.slack.com/t/hyperswitch-io/shared_invite/zt-2jqxmpsbm-WXUENx022HjNEy~Ark7Orw) or explore open issues on [GitHub](https://github.com/juspay/hyperswitch/issues). +Join the conversation on [Slack](https://inviter.co/hyperswitch-slack) or explore open issues on [GitHub](https://github.com/juspay/hyperswitch/issues). <a href="#feature-requests"> <h2 id="feature-requests">Feature requests & Bugs</h2> diff --git a/api-reference/v1/openapi_spec_v1.json b/api-reference/v1/openapi_spec_v1.json index 6045147a050..c4601519965 100644 --- a/api-reference/v1/openapi_spec_v1.json +++ b/api-reference/v1/openapi_spec_v1.json @@ -1,5 +1,8 @@ { "openapi": "3.0.3", + "x-mcp": { + "enabled": true + }, "info": { "title": "Hyperswitch - API Documentation", "description": "\n## Get started\n\nHyperswitch provides a collection of APIs that enable you to process and manage payments.\nOur APIs accept and return JSON in the HTTP body, and return standard HTTP response codes.\n\nYou can consume the APIs directly using your favorite HTTP/REST library.\n\nWe have a testing environment referred to \"sandbox\", which you can setup to test API calls without\naffecting production data.\nCurrently, our sandbox environment is live while our production environment is under development\nand will be available soon.\nYou can sign up on our Dashboard to get API keys to access Hyperswitch API.\n\n### Environment\n\nUse the following base URLs when making requests to the APIs:\n\n\| Environment \| Base URL \|\n\|---------------\|------------------------------------\|\n\| Sandbox \| <https://sandbox.hyperswitch.io> \|\n\| Production \| <https://api.hyperswitch.io> \|\n\n## Authentication\n\nWhen you sign up on our [dashboard](https://app.hyperswitch.io) and create a merchant\naccount, you are given a secret key (also referred as api-key) and a publishable key.\nYou may authenticate all API requests with Hyperswitch server by providing the appropriate key in\nthe request Authorization header.\n\n\| Key \| Description \|\n\|-----------------\|-----------------------------------------------------------------------------------------------\|\n\| api-key \| Private key. Used to authenticate all API requests from your merchant server \|\n\| publishable key \| Unique identifier for your account. Used to authenticate API requests from your app's client \|\n\nNever share your secret api keys. Keep them guarded and secure.\n", diff --git a/api-reference/v1/payments/payment--flows.mdx b/api-reference/v1/payments/payment--flows.mdx index eff90a0dcb8..9338f835f38 100644 --- a/api-reference/v1/payments/payment--flows.mdx +++ b/api-reference/v1/payments/payment--flows.mdx @@ -226,7 +226,9 @@ sequenceDiagram Required Fields: - `off_session: true` -- `recurring_details: { payment_method_id: "<from_setup>" }` +- `recurring_details: { + "type": "payment_method_id", + "data": "<from_setup>"}` Use Case: Subscription charges, scheduled billing without customer interaction diff --git a/crates/openapi/src/main.rs b/crates/openapi/src/main.rs index cf8158cfb02..d25b24442df 100644 --- a/crates/openapi/src/main.rs +++ b/crates/openapi/src/main.rs @@ -29,13 +29,33 @@ fn main() { #[allow(clippy::expect_used)] #[cfg(any(feature = "v1", feature = "v2"))] std::fs::write( - file_path, + &file_path, openapi .to_pretty_json() .expect("Failed to serialize OpenAPI specification as JSON"), ) .expect("Failed to write OpenAPI specification to file"); + #[allow(clippy::expect_used)] + #[cfg(feature = "v1")] + { + // TODO: Do this using utoipa::extensions after we have upgraded to 5.x + let file_content = + std::fs::read_to_string(&file_path).expect("Failed to read OpenAPI specification file"); + + let mut lines: Vec<&str> = file_content.lines().collect(); + + // Insert the new text at line 3 (index 2) + if lines.len() > 2 { + let new_line = " \"x-mcp\": {\n \"enabled\": true\n },"; + lines.insert(2, new_line); + } + + let modified_content = lines.join("\n"); + std::fs::write(&file_path, modified_content) + .expect("Failed to write modified OpenAPI specification to file"); + } + #[cfg(any(feature = "v1", feature = "v2"))] println!("Successfully saved OpenAPI specification file at '{relative_file_path}'");	2025-06-24T09:35:51Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [x] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> Modified `openapi/src/main.rs` to append `x-mcp` extension to v1 OpenAPI schema ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> Closes #8442 ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> Verified using: `mintlify openapi-check api-reference/v1/openapi_spec_v1.json` Tested mintlify's mcp server generation functionality by deploying the updated OpenAPI spec file on a custom mintlify account. Used the generated mcp server to do payments - create in cursor. ![image](https://github.com/user-attachments/assets/1a6e37a3-a682-4b84-9cd7-1292f3ed1787) ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.114.0	bc767b9131e2637ce90997da9018085d2dadb80b	bc767b9131e2637ce90997da9018085d2dadb80b
juspay/hyperswitch	juspay__hyperswitch-8445	Bug: fix(recovery) : Populate connector request reference id in revenue recovery record attempt flow. Previously there was no restriction in confirmData to connector request reference id to be mandatory. Recovery internally uses proxy flow, which internally uses confirmData where connector request reference id was hardcoded to none.	diff --git a/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs b/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs index c35fbc3163e..86821bfe6ef 100644 --- a/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs +++ b/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs @@ -646,7 +646,6 @@ impl PaymentAttempt { let payment_method_type_data = payment_intent.get_payment_method_type(); let payment_method_subtype_data = payment_intent.get_payment_method_sub_type(); - let authentication_type = payment_intent.authentication_type.unwrap_or_default(); Ok(Self { payment_id: payment_intent.id.clone(), @@ -752,7 +751,10 @@ impl PaymentAttempt { .as_ref() .map(\|txn_id\| txn_id.get_id().clone()); let connector = request.connector.map(\|connector\| connector.to_string()); - + let connector_request_reference_id = payment_intent + .merchant_reference_id + .as_ref() + .map(\|id\| id.get_string_repr().to_owned()); Ok(Self { payment_id: payment_intent.id.clone(), merchant_id: payment_intent.merchant_id.clone(), @@ -804,7 +806,7 @@ impl PaymentAttempt { charges: None, processor_merchant_id: payment_intent.merchant_id.clone(), created_by: None, - connector_request_reference_id: None, + connector_request_reference_id, }) } diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs index 59de54f41fa..2f70a79ec87 100644 --- a/crates/router/src/core/payments.rs +++ b/crates/router/src/core/payments.rs @@ -4042,6 +4042,16 @@ where ) .await?, )); + operation + .to_domain()? + .populate_payment_data( + state, + payment_data, + merchant_context, + business_profile, + &connector, + ) + .await?; let mut router_data = payment_data .construct_router_data( diff --git a/crates/router/src/core/payments/operations/proxy_payments_intent.rs b/crates/router/src/core/payments/operations/proxy_payments_intent.rs index 838cbf9dedf..a65f4cdd99e 100644 --- a/crates/router/src/core/payments/operations/proxy_payments_intent.rs +++ b/crates/router/src/core/payments/operations/proxy_payments_intent.rs @@ -6,6 +6,7 @@ use error_stack::ResultExt; use hyperswitch_domain_models::{ payment_method_data::PaymentMethodData, payments::PaymentConfirmData, }; +use hyperswitch_interfaces::api::ConnectorSpecifications; use masking::PeekInterface; use router_env::{instrument, tracing}; @@ -15,7 +16,7 @@ use crate::{ errors::{self, CustomResult, RouterResult, StorageErrorExt}, payments::{ operations::{self, ValidateStatusForOperation}, - OperationSessionGetters, + OperationSessionGetters, OperationSessionSetters, }, }, routes::{app::ReqState, SessionState}, @@ -303,6 +304,24 @@ impl<F: Clone + Send + Sync> Domain<F, ProxyPaymentsRequest, PaymentConfirmData< )> { Ok((Box::new(self), None, None)) } + #[instrument(skip_all)] + async fn populate_payment_data<'a>( + &'a self, + _state: &SessionState, + payment_data: &mut PaymentConfirmData<F>, + _merchant_context: &domain::MerchantContext, + _business_profile: &domain::Profile, + connector_data: &api::ConnectorData, + ) -> CustomResult<(), errors::ApiErrorResponse> { + let connector_request_reference_id = connector_data + .connector + .generate_connector_request_reference_id( + &payment_data.payment_intent, + &payment_data.payment_attempt, + ); + payment_data.set_connector_request_reference_id(Some(connector_request_reference_id)); + Ok(()) + } async fn perform_routing<'a>( &'a self, diff --git a/crates/router/src/routes/payments.rs b/crates/router/src/routes/payments.rs index 020a1fbf713..e2363633dad 100644 --- a/crates/router/src/routes/payments.rs +++ b/crates/router/src/routes/payments.rs @@ -232,7 +232,7 @@ pub async fn payments_get_intent( header_payload.clone(), ) }, - auth::api_or_client_auth( + auth::api_or_client_or_jwt_auth( &auth::V2ApiKeyAuth { is_connected_allowed: false, is_platform_allowed: false, @@ -240,6 +240,9 @@ pub async fn payments_get_intent( &auth::V2ClientAuth(common_utils::types::authentication::ResourceId::Payment( global_payment_id.clone(), )), + &auth::JWTAuth { + permission: Permission::ProfileRevenueRecoveryRead, + }, req.headers(), ), api_locking::LockAction::NotApplicable, diff --git a/crates/router/src/services/authentication.rs b/crates/router/src/services/authentication.rs index 41b7bd3d87b..d16063939a1 100644 --- a/crates/router/src/services/authentication.rs +++ b/crates/router/src/services/authentication.rs @@ -2698,7 +2698,27 @@ where api_auth } } - +#[cfg(feature = "v2")] +pub fn api_or_client_or_jwt_auth<'a, T, A>( + api_auth: &'a dyn AuthenticateAndFetch<T, A>, + client_auth: &'a dyn AuthenticateAndFetch<T, A>, + jwt_auth: &'a dyn AuthenticateAndFetch<T, A>, + headers: &HeaderMap, +) -> &'a dyn AuthenticateAndFetch<T, A> +where +{ + if let Ok(val) = HeaderMapStruct::new(headers).get_auth_string_from_header() { + if val.trim().starts_with("api-key=") { + api_auth + } else if is_jwt_auth(headers) { + jwt_auth + } else { + client_auth + } + } else { + api_auth + } +} #[derive(Debug)] pub struct PublishableKeyAuth;	2025-06-23T13:31:41Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [x] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> Previously there was no restriction in confirmData to connector request reference id to be mandatory. Recovery internally uses proxy flow, which internally uses confirmData where connector request reference id was hardcoded to none. This Pr adds supports to generate connector request reference to merchant reference id. This Pr also has changes of adding support for jwt auth to payment get for dashboard use case. Previously payment sync was used in dashboard to retrieve payment details, but this would fail now in v2 because if there are no attempts created payment get would return 4xx since active attempt is mandotory. To solve this now dashboard is relying on payment get and payment get attempt list api's . ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> Test case 1 : step 1 : create a profile in hyperswitch and wait for 8 mins to move it from monitering to cascading , this would only get updated when webhooks are triggered . step 2 : create payment mca ``` curl --location 'http://localhost:8080/v2/connector-accounts' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'x-merchant-id: test_seller_AGZCJiHwUNV1seyoepOE' \ --header 'x-profile-id: pro_kYmv4lQjIZFbAqoOVY4M' \ --header 'Authorization: admin-api-key=test_admin' \ --data '{ "connector_type": "payment_processor", "connector_name": "stripe", "connector_account_details": { "auth_type": "HeaderKey", "api_key": "stripe-api-key" }, "profile_id": "pro_kYmv4lQjIZFbAqoOVY4M" }' ``` step 4 : configure stripe billing connector. ``` curl --location 'http://localhost:8080/v2/connector-accounts' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'x-merchant-id: test_seller_AGZCJiHwUNV1seyoepOE' \ --header 'x-profile-id: pro_kYmv4lQjIZFbAqoOVY4M' \ --header 'Authorization: admin-api-key=test_admin' \ --data '{ "connector_type": "billing_processor", "connector_name": "stripebilling", "connector_account_details": { "auth_type": "HeaderKey", "api_key": "{{stripe-api-key}}" }, "connector_webhook_details": { "merchant_secret": "{{stripe-webhook-key}}", "additional_secret": "password" }, "feature_metadata": { "revenue_recovery": { "max_retry_count": 7, "billing_connector_retry_threshold": 2, "billing_account_reference": { "{{payment_connector_mca_created_in_last_step}}": "stripebilling" } } }, "profile_id": "pro_kYmv4lQjIZFbAqoOVY4M" }' ``` step 5 : Trigger failed invoice from stripe billing by creating new subscription and move the test clock to 1 week. This would trigger few external payments. once it exhausts retry threshold it will create process tracker entry. Follwed by 2 mins it would create all retries by hyperswitch as shown below. <img width="935" alt="Screenshot 2025-06-23 at 7 00 57 PM" src="https://github.com/user-attachments/assets/d51d3d9e-82ff-4385-b318-dbb37230cee8" /> ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.114.0	6fd7626c99e006bb7dcac864c30299bb8ef1d742	6fd7626c99e006bb7dcac864c30299bb8ef1d742
juspay/hyperswitch	juspay__hyperswitch-8449	Bug: remove frm rule migration support as it is not supported in DE	diff --git a/crates/router/src/core/routing.rs b/crates/router/src/core/routing.rs index b52fc966721..0d34986c838 100644 --- a/crates/router/src/core/routing.rs +++ b/crates/router/src/core/routing.rs @@ -2483,11 +2483,6 @@ pub async fn migrate_rules_for_profile( .attach_printable("Failed to get payout routing algorithm")? .unwrap_or_default() .algorithm_id, - business_profile - .get_frm_routing_algorithm() - .attach_printable("Failed to get frm routing algorithm")? - .unwrap_or_default() - .algorithm_id, ]; #[cfg(feature = "v2")]	2025-06-24T10:58:00Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [X] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> As FRM routing is not supported in DE we can remove support for it from DE migration endpoint ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> Compilation and cypress is working as expected. ## Checklist <!-- Put an `x` in the boxes that apply --> - [ ] I formatted the code `cargo +nightly fmt --all` - [ ] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.114.0	bc767b9131e2637ce90997da9018085d2dadb80b	bc767b9131e2637ce90997da9018085d2dadb80b
juspay/hyperswitch	juspay__hyperswitch-8437	Bug: [REFACTOR] allow option for skipping billing details during batched data migration Problem Statement Currently, `/migrate-batch` API has below mandatory parameters ```rust { pub customer_id: id_type::CustomerId, pub nick_name: masking::Secret<String>, pub card_number_masked: masking::Secret<String>, pub card_expiry_month: masking::Secret<String>, pub card_expiry_year: masking::Secret<String>, pub billing_address_zip: masking::Secret<String>, pub billing_address_state: masking::Secret<String>, pub billing_address_first_name: masking::Secret<String>, pub billing_address_last_name: masking::Secret<String>, pub billing_address_city: String, pub billing_address_line1: masking::Secret<String>, } ``` Billing details are mandatory but there can be use cases when these details are not be required by the underlying connector during payments. For such cases, these details become a blocker for using the migrate API. These can be made optional. Proposed Solution Fields related to billing details can be made `Optional`	diff --git a/crates/api_models/src/payment_methods.rs b/crates/api_models/src/payment_methods.rs index 5ecd2f71ef7..25b583f5dc4 100644 --- a/crates/api_models/src/payment_methods.rs +++ b/crates/api_models/src/payment_methods.rs @@ -2481,7 +2481,7 @@ pub struct PaymentMethodRecord { pub merchant_id: Option<id_type::MerchantId>, pub payment_method: Option<api_enums::PaymentMethod>, pub payment_method_type: Option<api_enums::PaymentMethodType>, - pub nick_name: masking::Secret<String>, + pub nick_name: Option<masking::Secret<String>>, pub payment_instrument_id: Option<masking::Secret<String>>, pub connector_customer_id: Option<String>, pub card_number_masked: masking::Secret<String>, @@ -2489,13 +2489,13 @@ pub struct PaymentMethodRecord { pub card_expiry_year: masking::Secret<String>, pub card_scheme: Option<String>, pub original_transaction_id: Option<String>, - pub billing_address_zip: masking::Secret<String>, - pub billing_address_state: masking::Secret<String>, - pub billing_address_first_name: masking::Secret<String>, - pub billing_address_last_name: masking::Secret<String>, - pub billing_address_city: String, + pub billing_address_zip: Option<masking::Secret<String>>, + pub billing_address_state: Option<masking::Secret<String>>, + pub billing_address_first_name: Option<masking::Secret<String>>, + pub billing_address_last_name: Option<masking::Secret<String>>, + pub billing_address_city: Option<String>, pub billing_address_country: Option<api_enums::CountryAlpha2>, - pub billing_address_line1: masking::Secret<String>, + pub billing_address_line1: Option<masking::Secret<String>>, pub billing_address_line2: Option<masking::Secret<String>>, pub billing_address_line3: Option<masking::Secret<String>>, pub raw_card_number: Option<masking::Secret<String>>, @@ -2548,6 +2548,57 @@ pub enum MigrationStatus { Failed, } +impl PaymentMethodRecord { + fn create_address(&self) -> Option<payments::AddressDetails> { + if self.billing_address_first_name.is_some() + && self.billing_address_line1.is_some() + && self.billing_address_zip.is_some() + && self.billing_address_city.is_some() + && self.billing_address_country.is_some() + { + Some(payments::AddressDetails { + city: self.billing_address_city.clone(), + country: self.billing_address_country, + line1: self.billing_address_line1.clone(), + line2: self.billing_address_line2.clone(), + state: self.billing_address_state.clone(), + line3: self.billing_address_line3.clone(), + zip: self.billing_address_zip.clone(), + first_name: self.billing_address_first_name.clone(), + last_name: self.billing_address_last_name.clone(), + }) + } else { + None + } + } + + fn create_phone(&self) -> Option<payments::PhoneDetails> { + if self.phone.is_some() \|\| self.phone_country_code.is_some() { + Some(payments::PhoneDetails { + number: self.phone.clone(), + country_code: self.phone_country_code.clone(), + }) + } else { + None + } + } + + fn create_billing(&self) -> Option<payments::Address> { + let address = self.create_address(); + let phone = self.create_phone(); + + if address.is_some() \|\| phone.is_some() \|\| self.email.is_some() { + Some(payments::Address { + address, + phone, + email: self.email.clone(), + }) + } else { + None + } + } +} + #[cfg(feature = "v1")] type PaymentMethodMigrationResponseType = ( Result<PaymentMethodMigrateResponse, String>, @@ -2600,6 +2651,7 @@ impl ), ) -> Result<Self, Self::Error> { let (record, merchant_id, mca_id) = item; + let billing = record.create_billing(); // if payment instrument id is present then only construct this let connector_mandate_details = if record.payment_instrument_id.is_some() { @@ -2631,7 +2683,7 @@ impl card_type: None, card_issuer: None, card_issuing_country: None, - nick_name: Some(record.nick_name.clone()), + nick_name: record.nick_name.clone(), }), network_token: Some(MigrateNetworkTokenDetail { network_token_data: MigrateNetworkTokenData { @@ -2639,7 +2691,7 @@ impl network_token_exp_month: record.network_token_expiry_month.unwrap_or_default(), network_token_exp_year: record.network_token_expiry_year.unwrap_or_default(), card_holder_name: record.name, - nick_name: Some(record.nick_name.clone()), + nick_name: record.nick_name.clone(), card_issuing_country: None, card_network: None, card_issuer: None, @@ -2652,24 +2704,7 @@ impl payment_method: record.payment_method, payment_method_type: record.payment_method_type, payment_method_issuer: None, - billing: Some(payments::Address { - address: Some(payments::AddressDetails { - city: Some(record.billing_address_city), - country: record.billing_address_country, - line1: Some(record.billing_address_line1), - line2: record.billing_address_line2, - state: Some(record.billing_address_state), - line3: record.billing_address_line3, - zip: Some(record.billing_address_zip), - first_name: Some(record.billing_address_first_name), - last_name: Some(record.billing_address_last_name), - }), - phone: Some(payments::PhoneDetails { - number: record.phone, - country_code: record.phone_country_code, - }), - email: record.email, - }), + billing, connector_mandate_details: connector_mandate_details.map( \|payments_mandate_reference\| { CommonMandateReference::from(payments_mandate_reference) @@ -2683,7 +2718,7 @@ impl #[cfg(feature = "payouts")] wallet: None, payment_method_data: None, - network_transaction_id: record.original_transaction_id, + network_transaction_id: record.original_transaction_id.clone(), }) } } @@ -2702,15 +2737,15 @@ impl From<(PaymentMethodRecord, id_type::MerchantId)> for PaymentMethodCustomerM description: None, phone_country_code: record.phone_country_code, address: Some(payments::AddressDetails { - city: Some(record.billing_address_city), + city: record.billing_address_city, country: record.billing_address_country, - line1: Some(record.billing_address_line1), + line1: record.billing_address_line1, line2: record.billing_address_line2, - state: Some(record.billing_address_state), + state: record.billing_address_state, line3: record.billing_address_line3, - zip: Some(record.billing_address_zip), - first_name: Some(record.billing_address_first_name), - last_name: Some(record.billing_address_last_name), + zip: record.billing_address_zip, + first_name: record.billing_address_first_name, + last_name: record.billing_address_last_name, }), metadata: None, }, diff --git a/crates/payment_methods/src/core/migration/payment_methods.rs b/crates/payment_methods/src/core/migration/payment_methods.rs index 10808f08a25..5c30698f615 100644 --- a/crates/payment_methods/src/core/migration/payment_methods.rs +++ b/crates/payment_methods/src/core/migration/payment_methods.rs @@ -184,7 +184,7 @@ pub async fn populate_bin_details_for_masked_card( card_number.peek(), ) .change_context(errors::ApiErrorResponse::InvalidRequestData { - message: "Invalid card number".to_string(), + message: "Invalid masked card number".to_string(), })?; let card_bin_details = if card_details.card_issuer.is_some() @@ -223,7 +223,7 @@ impl let (card_isin, last4_digits) = get_card_bin_and_last4_digits_for_masked_card(card_details.card_number.peek()) .change_context(errors::ApiErrorResponse::InvalidRequestData { - message: "Invalid card number".to_string(), + message: "Invalid masked card number".to_string(), })?; if let Some(card_bin_info) = card_info { Ok(Self { @@ -298,7 +298,7 @@ impl let (card_isin, last4_digits) = get_card_bin_and_last4_digits_for_masked_card(card_details.card_number.peek()) .change_context(errors::ApiErrorResponse::InvalidRequestData { - message: "Invalid card number".to_string(), + message: "Invalid masked card number".to_string(), })?; if let Some(card_bin_info) = card_info { Ok(Self {	2025-06-23T19:23:01Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [ ] New feature - [ ] Enhancement - [x] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description This PR includes changes to make billing details related fields optional during batched operation of data migration. ### Additional Changes - [x] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context Allows merchants who use connectors which does not mandate address fields to be present during a payment txn to be able to migrate their data. Billing details will not be mandated during batched operation of data migration. ## How did you test it? 1. Create MCA <details> <summary>2. Run batch migration</summary> cURL curl --location --request POST 'http://localhost:8080/payment_methods/migrate-batch' \ --header 'api-key: test_admin' \ --form 'merchant_id="merchant_1750764063"' \ --form 'merchant_connector_id="mca_F0qqizsBSwbZ77gQYLRs"' \ --form 'file=@"sample.csv"' Response [{"line_number":1,"payment_method_id":"pm_wY7TUBMPZZISgu2Zf74M","payment_method":"card","payment_method_type":"debit","customer_id":"45CC60D1F2283097BB1DE41A2636414445908518D50B8B4CDC57959CD7FB4539","migration_status":"Success","card_number_masked":"4360000 xxxx 0005","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":2,"payment_method_id":"pm_gNTfSTNVhvlURJPnsiYQ","payment_method":"card","payment_method_type":"credit","customer_id":"782BC898951D910C1A99DA69A4E4FAD6CEE53AB9311FA2C552028DA89428DB7F","migration_status":"Success","card_number_masked":"4111111 xxxx 1111","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":3,"payment_method_id":"pm_EeJ2hgF3OmHgTFEfe58X","payment_method":"card","payment_method_type":"credit","customer_id":"C81CC958611A803D9CC3E2E7818A1691943E3143E6DF603A7F45E55BA7629938","migration_status":"Success","card_number_masked":"222300 xxxx 0010","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":4,"payment_method_id":"pm_p1ckEakoWB12EtHYtjtm","payment_method":"card","payment_method_type":"credit","customer_id":"9F4BB23B3ED615753F5A27CF6D75274713B30A67ACFEA7CE44B058F6AC044E33","migration_status":"Success","card_number_masked":"5555555 xxxx 4444","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":5,"payment_method_id":"pm_0HrpkOfnLuIPSJiU3fdZ","payment_method":"card","payment_method_type":"debit","customer_id":"B22BFDD8BB5840B5F6EE0026A430B72359C50E631C7A2D9D2BC014BDB1EB212C","migration_status":"Success","card_number_masked":"222300 xxxx 0010","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":6,"payment_method_id":"pm_iOtdYdcOErhUz4bXmZgX","payment_method":"card","payment_method_type":"credit","customer_id":"EECB88827D346EDCFB9AB7302B0C387C42FB5EBAD87EC0E4FA4301F6148BB22B","migration_status":"Success","card_number_masked":"557700 xxxx 0004","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":7,"payment_method_id":"pm_JnzwASYJStJUQ02LEcqf","payment_method":"card","payment_method_type":"credit","customer_id":"C81CC958611A803D9CC3E2E7818A1691943E3143E6DF603A7F45E55BA7629938","migration_status":"Success","card_number_masked":"222241 xxxx 0002","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":8,"payment_method_id":"pm_CJsKWoBsOqkRlikFMO2t","payment_method":"card","payment_method_type":"credit","customer_id":"66C96C852E423B701EF06C5109C40D72E77B4C7F4CDD108AD4FCC3DCCC38AB2F","migration_status":"Success","card_number_masked":"513029 xxxx 0009","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":9,"payment_method_id":"pm_z0jFnOfXn1andQp9qbXd","payment_method":"card","payment_method_type":"credit","customer_id":"C81CC958611A803D9CC3E2E7818A1691943E3143E6DF603A7F45E55BA7629938","migration_status":"Success","card_number_masked":"510322 xxxx 9245","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":10,"payment_method_id":"pm_4lJAPwuf8iepQCWKDub1","payment_method":"card","payment_method_type":"credit","customer_id":"C81CC958611A803D9CC3E2E7818A1691943E3143E6DF603A7F45E55BA7629938","migration_status":"Success","card_number_masked":"222241 xxxx 0002","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":11,"payment_method_id":"pm_J1ZMlj5lzHyf2P5Lid6S","payment_method":"card","payment_method_type":"credit","customer_id":"ADE2795AC3C88525528F0DB95677BE9DB27E792850B1A67CA654BFFAEB31AFE3","migration_status":"Success","card_number_masked":"222241 xxxx 0018","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":12,"payment_method_id":"pm_zySRb0JCNxcCMH2Ubocc","payment_method":"card","payment_method_type":"credit","customer_id":"ADE2795AC3C88525528F0DB95677BE9DB27E792850B1A67CA654BFFAEB31AFE3","migration_status":"Success","card_number_masked":"411111 xxxx 1111","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":13,"payment_method_id":"pm_M9wKyu4kEYNcHIjyrVfI","payment_method":"card","payment_method_type":"credit","customer_id":"D83D0437F8883C26C75C04756D95E21B90877020743EA1C1CC49883A90E8DF97","migration_status":"Success","card_number_masked":"411111 xxxx 1111","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":14,"payment_method_id":"pm_RDiPAalAZkCj1uOqKYSb","payment_method":"card","payment_method_type":"credit","customer_id":"ADE2795AC3C88525528F0DB95677BE9DB27E792850B1A67CA654BFFAEB31AFE3","migration_status":"Success","card_number_masked":"624303 xxxx 0001","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":15,"payment_method_id":"pm_0XTr9lrG6LGNl9d4iFPR","payment_method":"card","payment_method_type":"debit","customer_id":"ADE2795AC3C88525528F0DB95677BE9DB27E792850B1A67CA654BFFAEB31AFE3","migration_status":"Success","card_number_masked":"222241 xxxx 0002","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":16,"payment_method_id":"pm_aUtJIRDcCH7CIwJ2hQEk","payment_method":"card","payment_method_type":"credit","customer_id":"D83D0437F8883C26C75C04756D95E21B90877020743EA1C1CC49883A90E8DF97","migration_status":"Success","card_number_masked":"817199 xxxx 0000","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":17,"payment_method_id":"pm_THz5Ds8VHAgyJPPOA4GY","payment_method":"card","payment_method_type":"credit","customer_id":"D83D0437F8883C26C75C04756D95E21B90877020743EA1C1CC49883A90E8DF97","migration_status":"Success","card_number_masked":"464646 xxxx 4644","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":18,"payment_method_id":"pm_l82mYW4tMsRkJF4hq5fn","payment_method":"card","payment_method_type":"credit","customer_id":"ADE2795AC3C88525528F0DB95677BE9DB27E792850B1A67CA654BFFAEB31AFE3","migration_status":"Success","card_number_masked":"222240 xxxx 0007","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":19,"payment_method_id":"pm_E8fkAc9RHknoPmnYFBOa","payment_method":"card","payment_method_type":"debit","customer_id":"ADE2795AC3C88525528F0DB95677BE9DB27E792850B1A67CA654BFFAEB31AFE3","migration_status":"Success","card_number_masked":"400006 xxxx 0006","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":20,"payment_method_id":"pm_TEEJO7DdZTkl55PH8P1T","payment_method":"card","payment_method_type":"credit","customer_id":"D83D0437F8883C26C75C04756D95E21B90877020743EA1C1CC49883A90E8DF97","migration_status":"Success","card_number_masked":"497794 xxxx 9497","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":21,"payment_method_id":"pm_3gTcA4MJsTjasj2XlJs2","payment_method":"card","payment_method_type":"credit","customer_id":"C81CC958611A803D9CC3E2E7818A1691943E3143E6DF603A7F45E55BA7629938","migration_status":"Success","card_number_masked":"436000 xxxx 0005","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":22,"payment_method_id":"pm_GzUYGU3GpOXOIkWFRkM0","payment_method":"card","payment_method_type":"credit","customer_id":"C80162F403CCA7AF1CB6732291D6D53B88636BB6A9B82D2CD43AC30775925B4F","migration_status":"Success","card_number_masked":"222241 xxxx 0002","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null}] </details> ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.114.0	a3cc44c6e15ce69f39104b2ce205bed632e3971e	a3cc44c6e15ce69f39104b2ce205bed632e3971e
juspay/hyperswitch	juspay__hyperswitch-8435	Bug: [FEAT] Implement Refund for JPMorgan this connector lacks basic feature i.e., refunds. relevant docs: - https://developer.payments.jpmorgan.com/api/commerce/online-payments/overview - https://developer.payments.jpmorgan.com/api/commerce/online-payments/online-payments/online-payments#/operations/V2RefundPost	diff --git a/crates/hyperswitch_connectors/src/connectors/jpmorgan.rs b/crates/hyperswitch_connectors/src/connectors/jpmorgan.rs index 9783324c042..043f140a174 100644 --- a/crates/hyperswitch_connectors/src/connectors/jpmorgan.rs +++ b/crates/hyperswitch_connectors/src/connectors/jpmorgan.rs @@ -665,9 +665,9 @@ impl ConnectorIntegration<Execute, RefundsData, RefundsResponseData> for Jpmorga fn get_url( &self, _req: &RefundsRouterData<Execute>, - _connectors: &Connectors, + connectors: &Connectors, ) -> CustomResult<String, errors::ConnectorError> { - Err(errors::ConnectorError::NotImplemented("Refunds".to_string()).into()) + Ok(format!("{}/refunds", self.base_url(connectors))) } fn get_request_body( diff --git a/crates/hyperswitch_connectors/src/connectors/jpmorgan/transformers.rs b/crates/hyperswitch_connectors/src/connectors/jpmorgan/transformers.rs index 9f253c0ffb7..0c2f6110f30 100644 --- a/crates/hyperswitch_connectors/src/connectors/jpmorgan/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/jpmorgan/transformers.rs @@ -272,18 +272,10 @@ pub struct JpmorganPaymentsResponse { #[serde(rename_all = "camelCase")] pub struct Merchant { merchant_id: Option<String>, - merchant_software: MerchantSoftware, + merchant_software: JpmorganMerchantSoftware, merchant_category_code: Option<String>, } -#[derive(Default, Debug, Serialize, Deserialize)] -#[serde(rename_all = "camelCase")] -pub struct MerchantSoftware { - company_name: Secret<String>, - product_name: Secret<String>, - version: Option<Secret<String>>, -} - #[derive(Default, Debug, Deserialize, Serialize)] #[serde(rename_all = "camelCase")] pub struct PaymentMethodType { @@ -522,18 +514,31 @@ pub struct TransactionData { pub struct JpmorganRefundRequest { pub merchant: MerchantRefundReq, pub amount: MinorUnit, + pub currency: common_enums::Currency, } #[derive(Default, Debug, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct MerchantRefundReq { - pub merchant_software: MerchantSoftware, + pub merchant_software: JpmorganMerchantSoftware, } impl<F> TryFrom<&JpmorganRouterData<&RefundsRouterData<F>>> for JpmorganRefundRequest { type Error = error_stack::Report<errors::ConnectorError>; - fn try_from(_item: &JpmorganRouterData<&RefundsRouterData<F>>) -> Result<Self, Self::Error> { - Err(errors::ConnectorError::NotImplemented("Refunds".to_string()).into()) + fn try_from(item: &JpmorganRouterData<&RefundsRouterData<F>>) -> Result<Self, Self::Error> { + let merchant_software = JpmorganMerchantSoftware { + company_name: String::from("JPMC").into(), + product_name: String::from("Hyperswitch").into(), + }; + let merchant = MerchantRefundReq { merchant_software }; + let amount = item.amount; + let currency = item.router_data.request.currency; + + Ok(Self { + merchant, + amount, + currency, + }) } } @@ -552,7 +557,6 @@ pub struct JpmorganRefundResponse { pub remaining_refundable_amount: Option<i64>, } -#[allow(dead_code)] #[derive(Debug, Serialize, Default, Deserialize, Clone)] pub enum RefundStatus { Succeeded, @@ -571,24 +575,23 @@ impl From<RefundStatus> for common_enums::RefundStatus { } } -#[derive(Default, Debug, Clone, Serialize, Deserialize)] -pub struct RefundResponse { - id: String, - status: RefundStatus, -} - -pub fn refund_status_from_transaction_state( - transaction_state: JpmorganTransactionState, -) -> common_enums::RefundStatus { - match transaction_state { - JpmorganTransactionState::Voided \| JpmorganTransactionState::Closed => { - common_enums::RefundStatus::Success - } - JpmorganTransactionState::Declined \| JpmorganTransactionState::Error => { - common_enums::RefundStatus::Failure - } - JpmorganTransactionState::Pending \| JpmorganTransactionState::Authorized => { - common_enums::RefundStatus::Pending +impl From<(JpmorganResponseStatus, JpmorganTransactionState)> for RefundStatus { + fn from( + (response_status, transaction_state): (JpmorganResponseStatus, JpmorganTransactionState), + ) -> Self { + match response_status { + JpmorganResponseStatus::Success => match transaction_state { + JpmorganTransactionState::Voided \| JpmorganTransactionState::Closed => { + Self::Succeeded + } + JpmorganTransactionState::Declined \| JpmorganTransactionState::Error => { + Self::Failed + } + JpmorganTransactionState::Pending \| JpmorganTransactionState::Authorized => { + Self::Processing + } + }, + JpmorganResponseStatus::Denied \| JpmorganResponseStatus::Error => Self::Failed, } } } @@ -607,9 +610,11 @@ impl TryFrom<RefundsResponseRouterData<Execute, JpmorganRefundResponse>> .transaction_id .clone() .ok_or(errors::ConnectorError::ResponseHandlingFailed)?, - refund_status: refund_status_from_transaction_state( + refund_status: RefundStatus::from(( + item.response.response_status, item.response.transaction_state, - ), + )) + .into(), }), ..item.data }) @@ -638,9 +643,11 @@ impl TryFrom<RefundsResponseRouterData<RSync, JpmorganRefundSyncResponse>> Ok(Self { response: Ok(RefundsResponseData { connector_refund_id: item.response.transaction_id.clone(), - refund_status: refund_status_from_transaction_state( + refund_status: RefundStatus::from(( + item.response.response_status, item.response.transaction_state, - ), + )) + .into(), }), ..item.data })	2025-06-23T17:30:48Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [x] CI/CD ## Description <!-- Describe your changes in detail --> This PR implements refund flow for JPMorgan connector. Connector returns `Authorized` state (`Pending`). Post RSync call, the status gets updated to `Success`. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> The connector lacked this basic feature until now. Closes #8435 ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> Updated Cypress tests: <img width="558" alt="image" src="https://github.com/user-attachments/assets/cb18d34e-d6d2-4145-8e94-773ab6638389" /> There exist an issue from the connector where it returns same `transaction_id` (`connector_transaction_id`) every single time which we have no control. Because of this, refunds tend to exceed the maximum refundable amount resulting in 4xx as shown below: <img width="557" alt="image" src="https://github.com/user-attachments/assets/549c517b-cc54-4114-b034-5df64783bd68" /> <img width="477" alt="image" src="https://github.com/user-attachments/assets/47018470-5798-4a07-b480-1f0694540d68" /> ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `just clippy && jut clippy_v2` - [x] I reviewed the submitted code - [x] I added unit tests for my changes where possible <!-- @coderabbitai ignore -->	v1.114.0	786fe699c2abd1a3eb752121a1915acd2012d94a	786fe699c2abd1a3eb752121a1915acd2012d94a
juspay/hyperswitch	juspay__hyperswitch-8430	Bug: [BUG] adyen connector creates connector's customer reference on the fly ### Bug Description Connector's customer ID is a unique identifier for a customer's entity in the underlying connector for HyperSwitch for mapping a customer. This identifier is stored under `connector_customer` in `customers` table. However, for Adyen - this field is a combination of merchant ID and customer ID in HyperSwitch which is unique across different merchants and customers. This is a blocker for migrated customers whose `shopperReference` (customer ID in Adyen) can be in a different format. ### Expected Behavior Adyen should rely on the `connector_customer` field for customer and fallback to any default connector specific behavior. ### Actual Behavior Adyen uses a default behavior for generating `connector_customer_id` ### Steps To Reproduce -- ### Context For The Bug -- ### Environment -- ### Have you spent some time checking if this bug has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? None	diff --git a/config/config.example.toml b/config/config.example.toml index 040e027dcf9..08589cbcc65 100644 --- a/config/config.example.toml +++ b/config/config.example.toml @@ -827,7 +827,7 @@ credit = {country = "AU,NZ,CN,HK,IN,LK,KR,MY,SG,GB,BE,FR,DE,IT,ME,NL,PL,ES,ZA,AR debit = {country = "AU,NZ,CN,HK,IN,LK,KR,MY,SG,GB,BE,FR,DE,IT,ME,NL,PL,ES,ZA,AR,BR,CO,MX,PA,UY,US,CA", currency = "AFN,ALL,DZD,AOA,ARS,AMD,AWG,AUD,AZN,BSD,BHD,BDT,BBD,BYN,BZD,BMD,BTN,BOB,VES,BAM,BWP,BRL,BND,BGN,BIF,KHR,CAD,CVE,KYD,XAF,CLP,CNY,COP,KMF,CDF,CRC,HRK,CUP,CZK,DKK,DJF,DOP,XCD,EGP,ERN,ETB,EUR,FKP,FJD,XPF,GMD,GEL,GHS,GIP,GTQ,GNF,GYD,HTG,HNL,HKD,HUF,ISK,INR,IDR,IRR,IQD,ILS,JMD,JPY,JOD,KZT,KES,KGS,KWD,LAK,LBP,LSL,LRD,LYD,MOP,MKD,MGA,MWK,MYR,MVR,MRU,MUR,MXN,MDL,MNT,MAD,MZN,MMK,NAD,NPR,ANG,NZD,NIO,NGN,VUV,KPW,NOK,OMR,PKR,PAB,PGK,PYG,PEN,PHP,PLN,GBP,QAR,RON,RUB,RWF,SHP,SVC,WST,STN,SAR,RSD,SCR,SLL,SGD,SBD,SOS,ZAR,KRW,SSP,LKR,SDG,SRD,SZL,SEK,CHF,SYP,TWD,TJS,TZS,THB,TOP,TTD,TND,TRY,TMT,UGX,UAH,AED,USD,UYU,UZS,VND,XOF,YER,ZMW,ZWL"} [connector_customer] -connector_list = "gocardless,stax,stripe,facilitapay,hyperswitch_vault" +connector_list = "adyen,facilitapay,gocardless,hyperswitch_vault,stax,stripe" payout_connector_list = "nomupay,stripe,wise" [bank_config.online_banking_fpx] diff --git a/config/deployments/integration_test.toml b/config/deployments/integration_test.toml index 513cb587176..f4c3e3815d0 100644 --- a/config/deployments/integration_test.toml +++ b/config/deployments/integration_test.toml @@ -174,7 +174,7 @@ force_cookies = true enabled = true [connector_customer] -connector_list = "gocardless,stax,stripe,facilitapay,hyperswitch_vault" +connector_list = "adyen,facilitapay,gocardless,hyperswitch_vault,stax,stripe" payout_connector_list = "nomupay,stripe,wise" [delayed_session_response] diff --git a/config/deployments/production.toml b/config/deployments/production.toml index 4b990ad0464..23f5c72e3cd 100644 --- a/config/deployments/production.toml +++ b/config/deployments/production.toml @@ -15,7 +15,7 @@ open_banking_uk.adyen.banks = "aib,bank_of_scotland,danske_bank,first_direct,fir przelewy24.stripe.banks = "alior_bank,bank_millennium,bank_nowy_bfg_sa,bank_pekao_sa,banki_spbdzielcze,blik,bnp_paribas,boz,citi,credit_agricole,e_transfer_pocztowy24,getin_bank,idea_bank,inteligo,mbank_mtransfer,nest_przelew,noble_pay,pbac_z_ipko,plus_bank,santander_przelew24,toyota_bank,volkswagen_bank" [connector_customer] -connector_list = "stax,stripe,gocardless,facilitapay,hyperswitch_vault" +connector_list = "adyen,facilitapay,gocardless,hyperswitch_vault,stax,stripe" payout_connector_list = "nomupay,stripe,wise" # Connector configuration, provided attributes will be used to fulfill API requests. diff --git a/config/deployments/sandbox.toml b/config/deployments/sandbox.toml index d00b12c751f..e09aa5f88fd 100644 --- a/config/deployments/sandbox.toml +++ b/config/deployments/sandbox.toml @@ -15,7 +15,7 @@ open_banking_uk.adyen.banks = "aib,bank_of_scotland,danske_bank,first_direct,fir przelewy24.stripe.banks = "alior_bank,bank_millennium,bank_nowy_bfg_sa,bank_pekao_sa,banki_spbdzielcze,blik,bnp_paribas,boz,citi,credit_agricole,e_transfer_pocztowy24,getin_bank,idea_bank,inteligo,mbank_mtransfer,nest_przelew,noble_pay,pbac_z_ipko,plus_bank,santander_przelew24,toyota_bank,volkswagen_bank" [connector_customer] -connector_list = "stax,stripe,gocardless,facilitapay,hyperswitch_vault" +connector_list = "adyen,facilitapay,gocardless,hyperswitch_vault,stax,stripe" payout_connector_list = "nomupay,stripe,wise" # Connector configuration, provided attributes will be used to fulfill API requests. diff --git a/config/development.toml b/config/development.toml index 95484d6b014..8107dce3886 100644 --- a/config/development.toml +++ b/config/development.toml @@ -872,7 +872,7 @@ nexixpay = { payment_method = "card" } redsys = { payment_method = "card" } [connector_customer] -connector_list = "gocardless,stax,stripe,facilitapay,hyperswitch_vault" +connector_list = "adyen,facilitapay,gocardless,hyperswitch_vault,stax,stripe" payout_connector_list = "nomupay,stripe,wise" [dummy_connector] diff --git a/config/docker_compose.toml b/config/docker_compose.toml index b029fb9987f..484dd76097a 100644 --- a/config/docker_compose.toml +++ b/config/docker_compose.toml @@ -883,7 +883,7 @@ card.debit = { connector_list = "cybersource" } connector_list = "adyen,archipel,cybersource,novalnet,stripe,worldpay" [connector_customer] -connector_list = "gocardless,stax,stripe,facilitapay,hyperswitch_vault" +connector_list = "adyen,facilitapay,gocardless,hyperswitch_vault,stax,stripe" payout_connector_list = "nomupay,stripe,wise" diff --git a/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs b/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs index c78daba6c4e..504635fe070 100644 --- a/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs @@ -1765,29 +1765,31 @@ type RecurringDetails = (Option<AdyenRecurringModel>, Option<bool>, Option<Strin fn get_recurring_processing_model( item: &PaymentsAuthorizeRouterData, ) -> Result<RecurringDetails, Error> { - match (item.request.setup_future_usage, item.request.off_session) { - (Some(storage_enums::FutureUsage::OffSession), _) => { + let shopper_reference = match item.get_connector_customer_id() { + Ok(connector_customer_id) => Some(connector_customer_id), + Err(_) => { let customer_id = item.get_customer_id()?; - let shopper_reference = format!( + Some(format!( "{}_{}", item.merchant_id.get_string_repr(), customer_id.get_string_repr() - ); + )) + } + }; + + match (item.request.setup_future_usage, item.request.off_session) { + (Some(storage_enums::FutureUsage::OffSession), _) => { let store_payment_method = item.request.is_mandate_payment(); Ok(( Some(AdyenRecurringModel::UnscheduledCardOnFile), Some(store_payment_method), - Some(shopper_reference), + shopper_reference, )) } (_, Some(true)) => Ok(( Some(AdyenRecurringModel::UnscheduledCardOnFile), None, - Some(format!( - "{}_{}", - item.merchant_id.get_string_repr(), - item.get_customer_id()?.get_string_repr() - )), + shopper_reference, )), _ => Ok((None, None, None)), } @@ -1967,17 +1969,18 @@ fn get_social_security_number(voucher_data: &VoucherData) -> Option<Secret<Strin } } -fn build_shopper_reference( - customer_id: &Option<common_utils::id_type::CustomerId>, - merchant_id: common_utils::id_type::MerchantId, -) -> Option<String> { - customer_id.clone().map(\|c_id\| { - format!( - "{}_{}", - merchant_id.get_string_repr(), - c_id.get_string_repr() - ) - }) +fn build_shopper_reference(item: &PaymentsAuthorizeRouterData) -> Option<String> { + match item.get_connector_customer_id() { + Ok(connector_customer_id) => Some(connector_customer_id), + Err(_) => match item.get_customer_id() { + Ok(customer_id) => Some(format!( + "{}_{}", + item.merchant_id.get_string_repr(), + customer_id.get_string_repr() + )), + Err(_) => None, + }, + } } impl TryFrom<(&BankDebitData, &PaymentsAuthorizeRouterData)> for AdyenPaymentMethod<'_> { @@ -2898,10 +2901,7 @@ impl TryFrom<(&AdyenRouterData<&PaymentsAuthorizeRouterData>, &Card)> for AdyenP let amount = get_amount_data(item); let auth_type = AdyenAuthType::try_from(&item.router_data.connector_auth_type)?; let shopper_interaction = AdyenShopperInteraction::from(item.router_data); - let shopper_reference = build_shopper_reference( - &item.router_data.customer_id, - item.router_data.merchant_id.clone(), - ); + let shopper_reference = build_shopper_reference(item.router_data); let (recurring_processing_model, store_payment_method, _) = get_recurring_processing_model(item.router_data)?; let browser_info = get_browser_info(item.router_data)?; @@ -3506,10 +3506,7 @@ impl let additional_data = get_additional_data(item.router_data); let country_code = get_country_code(item.router_data.get_optional_billing()); let shopper_interaction = AdyenShopperInteraction::from(item.router_data); - let shopper_reference = build_shopper_reference( - &item.router_data.customer_id, - item.router_data.merchant_id.clone(), - ); + let shopper_reference = build_shopper_reference(item.router_data); let (recurring_processing_model, store_payment_method, _) = get_recurring_processing_model(item.router_data)?; let return_url = item.router_data.request.get_router_return_url()?; @@ -5822,10 +5819,7 @@ impl let amount = get_amount_data(item); let auth_type = AdyenAuthType::try_from(&item.router_data.connector_auth_type)?; let shopper_interaction = AdyenShopperInteraction::from(item.router_data); - let shopper_reference = build_shopper_reference( - &item.router_data.customer_id, - item.router_data.merchant_id.clone(), - ); + let shopper_reference = build_shopper_reference(item.router_data); let (recurring_processing_model, store_payment_method, _) = get_recurring_processing_model(item.router_data)?; let browser_info = get_browser_info(item.router_data)?; diff --git a/loadtest/config/development.toml b/loadtest/config/development.toml index 5a59523eeb3..b82746362d0 100644 --- a/loadtest/config/development.toml +++ b/loadtest/config/development.toml @@ -554,7 +554,7 @@ gocardless = { long_lived_token = true, payment_method = "bank_debit" } billwerk = { long_lived_token = false, payment_method = "card" } [connector_customer] -connector_list = "gocardless,stax,stripe,facilitapay,hyperswitch_vault" +connector_list = "adyen,facilitapay,gocardless,hyperswitch_vault,stax,stripe" payout_connector_list = "nomupay,wise" [dummy_connector]	2025-06-24T10:42:43Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> Adyen now uses `connector_customer_id` to form `shopper_reference` if the field is present, else falls to previous implementation. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> <img width="1081" alt="Screenshot 2025-06-24 at 4 01 08 PM" src="https://github.com/user-attachments/assets/08ad7563-b19a-41a5-8729-74aa3b5f6295" /> ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.114.0	bc767b9131e2637ce90997da9018085d2dadb80b	bc767b9131e2637ce90997da9018085d2dadb80b
juspay/hyperswitch	juspay__hyperswitch-8440	Bug: [FEATURE] Implement V2 UCS (Unified Connector Service) Integration for Authorization Flow ### Feature Description # [Feature Request] Implement V2 UCS (Unified Connector Service) Integration for Authorization Flow ## Issue Type - [x] Feature Request - [ ] Bug Report - [ ] Enhancement - [ ] Documentation ## Priority - [x] High - [ ] Medium - [ ] Low ## Labels `A-core` `C-feature` `payment-flows` `ucs-integration` `v2-api` ## Summary Implement V2 UCS (Unified Connector Service) integration for the authorization payment flow, upgrading from the existing V1 UCS integration to support the updated gRPC schema and enhanced V2 payment architecture. ## Background Currently, Hyperswitch has V1 UCS integration that works with the legacy gRPC schema. However, the UCS service has evolved to V2 with improved: - Enhanced gRPC schema with better type safety - Improved field structures for card details, addresses, and identifiers - Better error handling and response parsing - Enhanced payment method data transformation ## Problem Statement ### Current State - V1 UCS integration uses outdated `PaymentsAuthorizeRequest` schema - Limited support for V2 payment flow architecture - Outdated transformer implementations for V2 data structures - Monolithic UCS function structure affecting maintainability ### Pain Points 1. Schema Incompatibility: V1 gRPC schema doesn't support V2 enhanced data models 2. Limited Error Handling: V1 response parsing lacks V2 identifier structure support 3. Technical Debt: Monolithic UCS functions make debugging and enhancement difficult 4. Missing V2 Features: Cannot leverage V2 payment flow improvements through UCS ### Possible Implementation ## Proposed Solution ### High-Level Approach Implement V2 UCS integration that: 1. Updates gRPC Schema: Migrate to `PaymentServiceAuthorizeRequest` with V2 field structure 2. Enhances Architecture: Refactor payment flow with better separation of concerns 3. Improves Transformers: Update V2 transformers for new schema compatibility 4. Maintains Backward Compatibility: Preserve V1 integration with feature flag separation ### Technical Requirements #### 1. gRPC Schema Migration - [ ] Update `rust-grpc-client` dependency to latest version - [ ] Migrate from `PaymentsAuthorizeRequest` to `PaymentServiceAuthorizeRequest` - [ ] Update authentication headers and request metadata handling - [ ] Implement new identifier structure for response parsing #### 2. Payment Flow Architecture - [ ] Refactor `call_connector_service()` into separate prerequisite and decision functions - [ ] Implement `call_connector_service_prerequisites()` for V2 flow preparation - [ ] Create `decide_unified_connector_service_call()` for UCS routing logic - [ ] Maintain feature flag separation between V1 and V2 implementations #### 3. V2 Transformer Enhancements - [ ] Update card data transformation for new schema structure - [ ] Enhance address handling with improved field mapping - [ ] Implement customer ID support in V2 transformers #### 4. Error Handling & Response Parsing - [ ] Update response handlers for new identifier structure - [ ] Enhance error context and fallback mechanisms - [ ] Maintain automatic fallback to traditional connector flow #### 5. Testing & Validation - [ ] Create comprehensive test cases for V2 UCS flow - [ ] Test schema compatibility and field mapping - [ ] Validate fallback mechanisms and error handling ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? Yes, I am willing to submit a PR!	diff --git a/Cargo.lock b/Cargo.lock index 848ccc6648f..f3ab37bbb5b 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1651,6 +1651,20 @@ dependencies = [ "thiserror 1.0.69", ] +[[package]] +name = "cargo_metadata" +version = "0.19.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dd5eb614ed4c27c5d706420e4320fbe3216ab31fa1c33cd8246ac36dae4479ba" +dependencies = [ + "camino", + "cargo-platform", + "semver 1.0.26", + "serde", + "serde_json", + "thiserror 2.0.12", +] + [[package]] name = "cast" version = "0.3.0" @@ -3347,13 +3361,18 @@ dependencies = [ [[package]] name = "g2h" -version = "0.2.0" +version = "0.4.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "312ad594dd0e3c26f860a52c8b703ab509c546931920f277f1afa9b7127fd755" +checksum = "0aece561ff748cdd2a37c8ee938a47bbf9b2c03823b393a332110599b14ee827" dependencies = [ + "cargo_metadata 0.19.2", "heck 0.5.0", + "proc-macro2", + "prost", "prost-build", + "prost-types", "quote", + "thiserror 2.0.12", "tonic-build", ] @@ -3506,7 +3525,7 @@ dependencies = [ [[package]] name = "grpc-api-types" version = "0.1.0" -source = "git+https://github.com/juspay/connector-service?rev=afaef3427f815befe253da152e5f37d3858bbc9f#afaef3427f815befe253da152e5f37d3858bbc9f" +source = "git+https://github.com/juspay/connector-service?rev=4918efedd5ea6c33e4a1600b988b2cf4948bed10#4918efedd5ea6c33e4a1600b988b2cf4948bed10" dependencies = [ "axum 0.8.4", "error-stack 0.5.0", @@ -6827,7 +6846,7 @@ dependencies = [ name = "router_env" version = "0.1.0" dependencies = [ - "cargo_metadata", + "cargo_metadata 0.18.1", "config", "error-stack 0.4.1", "gethostname", @@ -6880,7 +6899,7 @@ dependencies = [ [[package]] name = "rust-grpc-client" version = "0.1.0" -source = "git+https://github.com/juspay/connector-service?rev=afaef3427f815befe253da152e5f37d3858bbc9f#afaef3427f815befe253da152e5f37d3858bbc9f" +source = "git+https://github.com/juspay/connector-service?rev=4918efedd5ea6c33e4a1600b988b2cf4948bed10#4918efedd5ea6c33e4a1600b988b2cf4948bed10" dependencies = [ "grpc-api-types", ] @@ -9501,7 +9520,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "2990d9ea5967266ea0ccf413a4aa5c42a93dbcfda9cb49a97de6931726b12566" dependencies = [ "anyhow", - "cargo_metadata", + "cargo_metadata 0.18.1", "cfg-if 1.0.0", "git2", "regex", diff --git a/crates/external_services/Cargo.toml b/crates/external_services/Cargo.toml index 906f8e9b596..30ee8ee5a2c 100644 --- a/crates/external_services/Cargo.toml +++ b/crates/external_services/Cargo.toml @@ -53,7 +53,7 @@ reqwest = { version = "0.11.27", features = ["rustls-tls"] } http = "0.2.12" url = { version = "2.5.4", features = ["serde"] } quick-xml = { version = "0.31.0", features = ["serialize"] } -unified-connector-service-client = { git = "https://github.com/juspay/connector-service", rev = "afaef3427f815befe253da152e5f37d3858bbc9f", package = "rust-grpc-client" } +unified-connector-service-client = { git = "https://github.com/juspay/connector-service", rev = "4918efedd5ea6c33e4a1600b988b2cf4948bed10", package = "rust-grpc-client" } # First party crates diff --git a/crates/external_services/src/grpc_client/unified_connector_service.rs b/crates/external_services/src/grpc_client/unified_connector_service.rs index 0ad9602985d..5a4a912b798 100644 --- a/crates/external_services/src/grpc_client/unified_connector_service.rs +++ b/crates/external_services/src/grpc_client/unified_connector_service.rs @@ -84,6 +84,10 @@ pub enum UnifiedConnectorServiceError { /// Failed to perform Payment Authorize from gRPC Server #[error("Failed to perform Payment Authorize from gRPC Server")] PaymentAuthorizeFailure, + + /// Failed to perform Payment Get from gRPC Server + #[error("Failed to perform Payment Get from gRPC Server")] + PaymentGetFailure, } /// Result type for Dynamic Routing @@ -191,6 +195,28 @@ impl UnifiedConnectorServiceClient { .change_context(UnifiedConnectorServiceError::PaymentAuthorizeFailure) .inspect_err(\|error\| logger::error!(?error)) } + + /// Performs Payment Sync/Get + pub async fn payment_get( + &self, + payment_get_request: payments_grpc::PaymentServiceGetRequest, + connector_auth_metadata: ConnectorAuthMetadata, + grpc_headers: GrpcHeaders, + ) -> UnifiedConnectorServiceResult<tonic::Response<payments_grpc::PaymentServiceGetResponse>> + { + let mut request = tonic::Request::new(payment_get_request); + + let metadata = + build_unified_connector_service_grpc_headers(connector_auth_metadata, grpc_headers)?; + request.metadata_mut() = metadata; + + self.client + .clone() + .get(request) + .await + .change_context(UnifiedConnectorServiceError::PaymentGetFailure) + .inspect_err(\|error\| logger::error!(?error)) + } } /// Build the gRPC Headers for Unified Connector Service Request diff --git a/crates/hyperswitch_domain_models/src/merchant_connector_account.rs b/crates/hyperswitch_domain_models/src/merchant_connector_account.rs index 92ec2f51de2..1e460ee7306 100644 --- a/crates/hyperswitch_domain_models/src/merchant_connector_account.rs +++ b/crates/hyperswitch_domain_models/src/merchant_connector_account.rs @@ -163,7 +163,9 @@ impl MerchantConnectorAccountTypeDetails { Self::MerchantConnectorAccount(merchant_connector_account) => { Some(merchant_connector_account.connector_name) } - Self::MerchantConnectorDetails(_) => None, + Self::MerchantConnectorDetails(merchant_connector_details) => { + Some(merchant_connector_details.connector_name) + } } } diff --git a/crates/router/Cargo.toml b/crates/router/Cargo.toml index 585c49ffe18..8b80d22dc2a 100644 --- a/crates/router/Cargo.toml +++ b/crates/router/Cargo.toml @@ -88,7 +88,7 @@ reqwest = { version = "0.11.27", features = ["json", "rustls-tls", "gzip", "mult ring = "0.17.14" rust_decimal = { version = "1.37.1", features = ["serde-with-float", "serde-with-str"] } rust-i18n = { git = "https://github.com/kashif-m/rust-i18n", rev = "f2d8096aaaff7a87a847c35a5394c269f75e077a" } -unified-connector-service-client = { git = "https://github.com/juspay/connector-service", rev = "afaef3427f815befe253da152e5f37d3858bbc9f", package = "rust-grpc-client" } +unified-connector-service-client = { git = "https://github.com/juspay/connector-service", rev = "4918efedd5ea6c33e4a1600b988b2cf4948bed10", package = "rust-grpc-client" } rustc-hash = "1.1.0" rustls = "0.22" rustls-pemfile = "2" diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs index 8a0058b79e4..5319e823614 100644 --- a/crates/router/src/core/payments.rs +++ b/crates/router/src/core/payments.rs @@ -216,7 +216,27 @@ where let (payment_data, connector_response_data) = match connector { ConnectorCallType::PreDetermined(connector_data) => { - let router_data = call_connector_service( + let (mca_type_details, updated_customer, router_data) = + call_connector_service_prerequisites( + state, + req_state.clone(), + &merchant_context, + connector_data.connector_data.clone(), + &operation, + &mut payment_data, + &customer, + call_connector_action.clone(), + None, + header_payload.clone(), + None, + profile, + false, + false, //should_retry_with_pan is set to false in case of PreDetermined ConnectorCallType + req.should_return_raw_response(), + ) + .await?; + + let router_data = decide_unified_connector_service_call( state, req_state.clone(), &merchant_context, @@ -225,16 +245,17 @@ where &mut payment_data, &customer, call_connector_action.clone(), - None, + None, // schedule_time is not used in PreDetermined ConnectorCallType header_payload.clone(), #[cfg(feature = "frm")] None, - #[cfg(not(feature = "frm"))] - None, profile, false, false, //should_retry_with_pan is set to false in case of PreDetermined ConnectorCallType req.should_return_raw_response(), + mca_type_details, + router_data, + updated_customer, ) .await?; @@ -271,7 +292,28 @@ where ConnectorCallType::Retryable(connectors) => { let mut connectors = connectors.clone().into_iter(); let connector_data = get_connector_data(&mut connectors)?; - let router_data = call_connector_service( + + let (mca_type_details, updated_customer, router_data) = + call_connector_service_prerequisites( + state, + req_state.clone(), + &merchant_context, + connector_data.connector_data.clone(), + &operation, + &mut payment_data, + &customer, + call_connector_action.clone(), + None, + header_payload.clone(), + None, + profile, + false, + false, //should_retry_with_pan is set to false in case of Retryable ConnectorCallType + req.should_return_raw_response(), + ) + .await?; + + let router_data = decide_unified_connector_service_call( state, req_state.clone(), &merchant_context, @@ -280,16 +322,17 @@ where &mut payment_data, &customer, call_connector_action.clone(), - None, + None, // schedule_time is not used in Retryable ConnectorCallType header_payload.clone(), #[cfg(feature = "frm")] None, - #[cfg(not(feature = "frm"))] - None, profile, - false, + true, false, //should_retry_with_pan is set to false in case of PreDetermined ConnectorCallType req.should_return_raw_response(), + mca_type_details, + router_data, + updated_customer, ) .await?; @@ -409,17 +452,37 @@ where .get_connector_from_request(state, &req, &mut payment_data) .await?; - let router_data = internal_call_connector_service( + let merchant_connector_account = payment_data + .get_merchant_connector_details() + .map(domain::MerchantConnectorAccountTypeDetails::MerchantConnectorDetails) + .ok_or_else(\|\| { + error_stack::report!(errors::ApiErrorResponse::InternalServerError) + .attach_printable("Merchant connector details not found in payment data") + })?; + + operation + .to_domain()? + .populate_payment_data( + state, + &mut payment_data, + &merchant_context, + profile, + &connector_data, + ) + .await?; + + let router_data = connector_service_decider( state, req_state.clone(), &merchant_context, - connector_data, + connector_data.clone(), &operation, &mut payment_data, call_connector_action.clone(), header_payload.clone(), profile, req.should_return_raw_response(), + merchant_connector_account, ) .await?; @@ -3508,27 +3571,29 @@ where router_data = router_data.add_session_token(state, &connector).await?; - let mut should_continue_further = access_token::update_router_data_with_access_token_result( + let should_continue_further = access_token::update_router_data_with_access_token_result( &add_access_token_result, &mut router_data, &call_connector_action, ); - let add_create_order_result = router_data + let should_continue_further = match router_data .create_order_at_connector(state, &connector, should_continue_further) - .await?; + .await? + { + Some(create_order_response) => { + if let Ok(order_id) = create_order_response.clone().create_order_result { + payment_data.set_connector_response_reference_id(Some(order_id.clone())) + } - if add_create_order_result.is_create_order_performed { - if let Ok(order_id_opt) = &add_create_order_result.create_order_result { - payment_data.set_connector_response_reference_id(order_id_opt.clone()); + // Set the response in routerdata response to carry forward + router_data + .update_router_data_with_create_order_response(create_order_response.clone()); + create_order_response.create_order_result.ok().is_some() } - should_continue_further = router_data - .update_router_data_with_create_order_result( - add_create_order_result, - should_continue_further, - ) - .await?; - } + // If create order is not required, then we can proceed with further processing + None => true, + }; let updated_customer = call_create_connector_customer_if_required( state, @@ -3948,6 +4013,9 @@ pub async fn call_connector_service<F, RouterDReq, ApiRequest, D>( is_retry_payment: bool, should_retry_with_pan: bool, return_raw_connector_response: Option<bool>, + merchant_connector_account_type_details: domain::MerchantConnectorAccountTypeDetails, + mut router_data: RouterData<F, RouterDReq, router_types::PaymentsResponseData>, + updated_customer: Option<storage::CustomerUpdate>, ) -> RouterResult<RouterData<F, RouterDReq, router_types::PaymentsResponseData>> where F: Send + Clone + Sync, @@ -3961,50 +4029,6 @@ where dyn api::Connector: services::api::ConnectorIntegration<F, RouterDReq, router_types::PaymentsResponseData>, { - let stime_connector = Instant::now(); - - let merchant_connector_account = - domain::MerchantConnectorAccountTypeDetails::MerchantConnectorAccount(Box::new( - helpers::get_merchant_connector_account_v2( - state, - merchant_context.get_merchant_key_store(), - connector.merchant_connector_id.as_ref(), - ) - .await?, - )); - - operation - .to_domain()? - .populate_payment_data( - state, - payment_data, - merchant_context, - business_profile, - &connector, - ) - .await?; - - let updated_customer = call_create_connector_customer_if_required( - state, - customer, - merchant_context, - &merchant_connector_account, - payment_data, - ) - .await?; - - let mut router_data = payment_data - .construct_router_data( - state, - connector.connector.id(), - merchant_context, - customer, - &merchant_connector_account, - None, - None, - ) - .await?; - let add_access_token_result = router_data .add_access_token( state, @@ -4016,37 +4040,43 @@ where router_data = router_data.add_session_token(state, &connector).await?; - let mut should_continue_further = access_token::update_router_data_with_access_token_result( + let should_continue_further = access_token::update_router_data_with_access_token_result( &add_access_token_result, &mut router_data, &call_connector_action, ); - let add_create_order_result = router_data + let should_continue = match router_data .create_order_at_connector(state, &connector, should_continue_further) - .await?; + .await? + { + Some(create_order_response) => { + if let Ok(order_id) = create_order_response.clone().create_order_result { + payment_data.set_connector_response_reference_id(Some(order_id)) + } - if add_create_order_result.is_create_order_performed { - if let Ok(order_id_opt) = &add_create_order_result.create_order_result { - payment_data.set_connector_response_reference_id(order_id_opt.clone()); + // Set the response in routerdata response to carry forward + router_data + .update_router_data_with_create_order_response(create_order_response.clone()); + create_order_response.create_order_result.ok().map(\|_\| ()) } - should_continue_further = router_data - .update_router_data_with_create_order_result( - add_create_order_result, - should_continue_further, - ) - .await?; - } + // If create order is not required, then we can proceed with further processing + None => Some(()), + }; // In case of authorize flow, pre-task and post-tasks are being called in build request // if we do not want to proceed further, then the function will return Ok(None, false) - let (connector_request, should_continue_further) = if should_continue_further { - // Check if the actual flow specific request can be built with available data - router_data - .build_flow_specific_connector_request(state, &connector, call_connector_action.clone()) - .await? - } else { - (None, false) + let (connector_request, should_continue_further) = match should_continue { + Some(_) => { + router_data + .build_flow_specific_connector_request( + state, + &connector, + call_connector_action.clone(), + ) + .await? + } + None => (None, false), }; // Update the payment trackers just before calling the connector @@ -4089,18 +4119,14 @@ where Ok(router_data) }?; - let etime_connector = Instant::now(); - let duration_connector = etime_connector.saturating_duration_since(stime_connector); - tracing::info!(duration = format!("Duration taken: {}", duration_connector.as_millis())); - Ok(router_data) } -#[cfg(feature = "v1")] -// This function does not perform the tokenization action, as the payment method is not saved in this flow. +#[cfg(feature = "v2")] #[allow(clippy::too_many_arguments)] +#[allow(clippy::type_complexity)] #[instrument(skip_all)] -pub async fn proxy_for_call_connector_service<F, RouterDReq, ApiRequest, D>( +pub async fn call_connector_service_prerequisites<F, RouterDReq, ApiRequest, D>( state: &SessionState, req_state: ReqState, merchant_context: &domain::MerchantContext, @@ -4109,15 +4135,17 @@ pub async fn proxy_for_call_connector_service<F, RouterDReq, ApiRequest, D>( payment_data: &mut D, customer: &Option<domain::Customer>, call_connector_action: CallConnectorAction, - validate_result: &operations::ValidateResult, schedule_time: Option<time::PrimitiveDateTime>, header_payload: HeaderPayload, - + frm_suggestion: Option<storage_enums::FrmSuggestion>, business_profile: &domain::Profile, - return_raw_connector_response: Option<bool>, + is_retry_payment: bool, + should_retry_with_pan: bool, + all_keys_required: Option<bool>, ) -> RouterResult<( + domain::MerchantConnectorAccountTypeDetails, + Option<storage::CustomerUpdate>, RouterData<F, RouterDReq, router_types::PaymentsResponseData>, - helpers::MerchantConnectorAccountType, )> where F: Send + Clone + Sync, @@ -4131,145 +4159,354 @@ where dyn api::Connector: services::api::ConnectorIntegration<F, RouterDReq, router_types::PaymentsResponseData>, { - let stime_connector = Instant::now(); + let merchant_connector_account_type_details = + domain::MerchantConnectorAccountTypeDetails::MerchantConnectorAccount(Box::new( + helpers::get_merchant_connector_account_v2( + state, + merchant_context.get_merchant_key_store(), + connector.merchant_connector_id.as_ref(), + ) + .await?, + )); - let merchant_connector_account = construct_profile_id_and_get_mca( + operation + .to_domain()? + .populate_payment_data( + state, + payment_data, + merchant_context, + business_profile, + &connector, + ) + .await?; + + let updated_customer = call_create_connector_customer_if_required( state, + customer, merchant_context, + &merchant_connector_account_type_details, payment_data, - &connector.connector_name.to_string(), - connector.merchant_connector_id.as_ref(), - false, ) .await?; - if payment_data - .get_payment_attempt() - .merchant_connector_id - .is_none() - { - payment_data.set_merchant_connector_id_in_attempt(merchant_connector_account.get_mca_id()); - } - - let merchant_recipient_data = None; - - let mut router_data = payment_data + let router_data = payment_data .construct_router_data( state, connector.connector.id(), merchant_context, customer, - &merchant_connector_account, - merchant_recipient_data, + &merchant_connector_account_type_details, + None, None, ) .await?; - let add_access_token_result = router_data - .add_access_token( + Ok(( + merchant_connector_account_type_details, + updated_customer, + router_data, + )) +} + +#[cfg(feature = "v2")] +#[instrument(skip_all)] +pub async fn internal_call_connector_service_prerequisites<F, RouterDReq, ApiRequest, D>( + state: &SessionState, + merchant_context: &domain::MerchantContext, + connector: api::ConnectorData, + operation: &BoxedOperation<'_, F, ApiRequest, D>, + payment_data: &mut D, + business_profile: &domain::Profile, +) -> RouterResult<( + domain::MerchantConnectorAccountTypeDetails, + RouterData<F, RouterDReq, router_types::PaymentsResponseData>, +)> +where + F: Send + Clone + Sync, + RouterDReq: Send + Sync, + + // To create connector flow specific interface data + D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, + D: ConstructFlowSpecificData<F, RouterDReq, router_types::PaymentsResponseData>, + RouterData<F, RouterDReq, router_types::PaymentsResponseData>: Feature<F, RouterDReq> + Send, + // To construct connector flow specific api + dyn api::Connector: + services::api::ConnectorIntegration<F, RouterDReq, router_types::PaymentsResponseData>, +{ + let merchant_connector_details = + payment_data + .get_merchant_connector_details() + .ok_or_else(\|\| { + error_stack::report!(errors::ApiErrorResponse::InternalServerError) + .attach_printable("Merchant connector details not found in payment data") + })?; + let merchant_connector_account = + domain::MerchantConnectorAccountTypeDetails::MerchantConnectorDetails( + merchant_connector_details, + ); + + operation + .to_domain()? + .populate_payment_data( state, - &connector, + payment_data, merchant_context, - payment_data.get_creds_identifier(), + business_profile, + &connector, ) .await?; - router_data = router_data.add_session_token(state, &connector).await?; + let router_data = payment_data + .construct_router_data( + state, + connector.connector.id(), + merchant_context, + &None, + &merchant_connector_account, + None, + None, + ) + .await?; - let mut should_continue_further = access_token::update_router_data_with_access_token_result( - &add_access_token_result, - &mut router_data, - &call_connector_action, - ); + Ok((merchant_connector_account, router_data)) +} - (router_data, should_continue_further) = complete_preprocessing_steps_if_required( - state, - &connector, - payment_data, - router_data, - operation, - should_continue_further, - ) - .await?; +#[cfg(feature = "v2")] +#[allow(clippy::too_many_arguments)] +#[instrument(skip_all)] +pub async fn connector_service_decider<F, RouterDReq, ApiRequest, D>( + state: &SessionState, + req_state: ReqState, + merchant_context: &domain::MerchantContext, + connector: api::ConnectorData, + operation: &BoxedOperation<'_, F, ApiRequest, D>, + payment_data: &mut D, + call_connector_action: CallConnectorAction, + header_payload: HeaderPayload, + business_profile: &domain::Profile, + return_raw_connector_response: Option<bool>, + merchant_connector_account_type_details: domain::MerchantConnectorAccountTypeDetails, +) -> RouterResult<RouterData<F, RouterDReq, router_types::PaymentsResponseData>> +where + F: Send + Clone + Sync, + RouterDReq: Send + Sync, - if let Ok(router_types::PaymentsResponseData::PreProcessingResponse { - session_token: Some(session_token), - .. - }) = router_data.response.to_owned() - { - payment_data.push_sessions_token(session_token); - }; + // To create connector flow specific interface data + D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, + D: ConstructFlowSpecificData<F, RouterDReq, router_types::PaymentsResponseData>, + RouterData<F, RouterDReq, router_types::PaymentsResponseData>: Feature<F, RouterDReq> + Send, + // To construct connector flow specific api + dyn api::Connector: + services::api::ConnectorIntegration<F, RouterDReq, router_types::PaymentsResponseData>, +{ + let mut router_data = payment_data + .construct_router_data( + state, + connector.connector.id(), + merchant_context, + &None, + &merchant_connector_account_type_details, + None, + None, + ) + .await?; - let (connector_request, should_continue_further) = if should_continue_further { - // Check if the actual flow specific request can be built with available data - router_data - .build_flow_specific_connector_request(state, &connector, call_connector_action.clone()) + // do order creation + let should_call_unified_connector_service = + should_call_unified_connector_service(state, merchant_context, &router_data).await?; + + let (connector_request, should_continue_further) = if !should_call_unified_connector_service { + let mut should_continue_further = true; + + let should_continue = match router_data + .create_order_at_connector(state, &connector, should_continue_further) .await? + { + Some(create_order_response) => { + if let Ok(order_id) = create_order_response.clone().create_order_result { + payment_data.set_connector_response_reference_id(Some(order_id)) + } + + // Set the response in routerdata response to carry forward + router_data + .update_router_data_with_create_order_response(create_order_response.clone()); + create_order_response.create_order_result.ok().map(\|_\| ()) + } + // If create order is not required, then we can proceed with further processing + None => Some(()), + }; + + let should_continue: (Option<common_utils::request::Request>, bool) = match should_continue + { + Some(_) => { + router_data + .build_flow_specific_connector_request( + state, + &connector, + call_connector_action.clone(), + ) + .await? + } + None => (None, false), + }; + should_continue } else { + // If unified connector service is called, these values are not used + // as the request is built in the unified connector service call (None, false) }; - if should_add_task_to_process_tracker(payment_data) { - operation - .to_domain()? - .add_task_to_process_tracker( - state, - payment_data.get_payment_attempt(), - validate_result.requeue, - schedule_time, - ) - .await - .map_err(\|error\| logger::error!(process_tracker_error=?error)) - .ok(); - } - - let updated_customer = None; - let frm_suggestion = None; - (_, payment_data) = operation .to_update_tracker()? .update_trackers( state, req_state, payment_data.clone(), - customer.clone(), + None, // customer is not used in internal flows merchant_context.get_merchant_account().storage_scheme, - updated_customer, + None, merchant_context.get_merchant_key_store(), - frm_suggestion, + None, // frm_suggestion is not used in internal flows header_payload.clone(), ) .await?; - let router_data = if should_continue_further { - // The status of payment_attempt and intent will be updated in the previous step - // update this in router_data. - // This is added because few connector integrations do not update the status, - // and rely on previous status set in router_data - router_data.status = payment_data.get_payment_attempt().status; - router_data - .decide_flows( + record_time_taken_with(\|\| async { + if should_call_unified_connector_service { + router_data + .call_unified_connector_service( + state, + merchant_connector_account_type_details.clone(), + merchant_context, + ) + .await?; + + Ok(router_data) + } else { + let router_data = if should_continue_further { + router_data + .decide_flows( + state, + &connector, + call_connector_action, + connector_request, + business_profile, + header_payload.clone(), + return_raw_connector_response, + ) + .await + } else { + Ok(router_data) + }?; + Ok(router_data) + } + }) + .await +} + +#[cfg(feature = "v2")] +#[allow(clippy::too_many_arguments)] +#[instrument(skip_all)] +pub async fn decide_unified_connector_service_call<F, RouterDReq, ApiRequest, D>( + state: &SessionState, + req_state: ReqState, + merchant_context: &domain::MerchantContext, + connector: api::ConnectorData, + operation: &BoxedOperation<'_, F, ApiRequest, D>, + payment_data: &mut D, + customer: &Option<domain::Customer>, + call_connector_action: CallConnectorAction, + schedule_time: Option<time::PrimitiveDateTime>, + header_payload: HeaderPayload, + frm_suggestion: Option<storage_enums::FrmSuggestion>, + business_profile: &domain::Profile, + is_retry_payment: bool, + should_retry_with_pan: bool, + return_raw_connector_response: Option<bool>, + merchant_connector_account_type_details: domain::MerchantConnectorAccountTypeDetails, + mut router_data: RouterData<F, RouterDReq, router_types::PaymentsResponseData>, + updated_customer: Option<storage::CustomerUpdate>, +) -> RouterResult<RouterData<F, RouterDReq, router_types::PaymentsResponseData>> +where + F: Send + Clone + Sync, + RouterDReq: Send + Sync, + + // To create connector flow specific interface data + D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, + D: ConstructFlowSpecificData<F, RouterDReq, router_types::PaymentsResponseData>, + RouterData<F, RouterDReq, router_types::PaymentsResponseData>: Feature<F, RouterDReq> + Send, + // To construct connector flow specific api + dyn api::Connector: + services::api::ConnectorIntegration<F, RouterDReq, router_types::PaymentsResponseData>, +{ + record_time_taken_with(\|\| async { + if should_call_unified_connector_service(state, merchant_context, &router_data).await? { + if should_add_task_to_process_tracker(payment_data) { + operation + .to_domain()? + .add_task_to_process_tracker( + state, + payment_data.get_payment_attempt(), + false, + schedule_time, + ) + .await + .map_err(\|error\| logger::error!(process_tracker_error=?error)) + .ok(); + } + + (_, payment_data) = operation + .to_update_tracker()? + .update_trackers( + state, + req_state, + payment_data.clone(), + customer.clone(), + merchant_context.get_merchant_account().storage_scheme, + None, + merchant_context.get_merchant_key_store(), + frm_suggestion, + header_payload.clone(), + ) + .await?; + + router_data + .call_unified_connector_service( + state, + merchant_connector_account_type_details.clone(), + merchant_context, + ) + .await?; + + Ok(router_data) + } else { + call_connector_service( state, - &connector, + req_state, + merchant_context, + connector, + operation, + payment_data, + customer, call_connector_action, - connector_request, + schedule_time, + header_payload, + frm_suggestion, business_profile, - header_payload.clone(), + is_retry_payment, + should_retry_with_pan, return_raw_connector_response, + merchant_connector_account_type_details, + router_data, + updated_customer, ) .await - } else { - Ok(router_data) - }?; - - let etime_connector = Instant::now(); - let duration_connector = etime_connector.saturating_duration_since(stime_connector); - tracing::info!(duration = format!("Duration taken: {}", duration_connector.as_millis())); - - Ok((router_data, merchant_connector_account)) + } + }) + .await } - -#[cfg(feature = "v2")] +#[cfg(feature = "v1")] +// This function does not perform the tokenization action, as the payment method is not saved in this flow. #[allow(clippy::too_many_arguments)] #[instrument(skip_all)] pub async fn proxy_for_call_connector_service<F, RouterDReq, ApiRequest, D>( @@ -4279,11 +4516,18 @@ pub async fn proxy_for_call_connector_service<F, RouterDReq, ApiRequest, D>( connector: api::ConnectorData, operation: &BoxedOperation<'_, F, ApiRequest, D>, payment_data: &mut D, + customer: &Option<domain::Customer>, call_connector_action: CallConnectorAction, + validate_result: &operations::ValidateResult, + schedule_time: Option<time::PrimitiveDateTime>, header_payload: HeaderPayload, + business_profile: &domain::Profile, return_raw_connector_response: Option<bool>, -) -> RouterResult<RouterData<F, RouterDReq, router_types::PaymentsResponseData>> +) -> RouterResult<( + RouterData<F, RouterDReq, router_types::PaymentsResponseData>, + helpers::MerchantConnectorAccountType, +)> where F: Send + Clone + Sync, RouterDReq: Send + Sync, @@ -4298,34 +4542,34 @@ where { let stime_connector = Instant::now(); - let merchant_connector_account = - domain::MerchantConnectorAccountTypeDetails::MerchantConnectorAccount(Box::new( - helpers::get_merchant_connector_account_v2( - state, - merchant_context.get_merchant_key_store(), - connector.merchant_connector_id.as_ref(), - ) - .await?, - )); - operation - .to_domain()? - .populate_payment_data( - state, - payment_data, - merchant_context, - business_profile, - &connector, - ) - .await?; + let merchant_connector_account = construct_profile_id_and_get_mca( + state, + merchant_context, + payment_data, + &connector.connector_name.to_string(), + connector.merchant_connector_id.as_ref(), + false, + ) + .await?; + + if payment_data + .get_payment_attempt() + .merchant_connector_id + .is_none() + { + payment_data.set_merchant_connector_id_in_attempt(merchant_connector_account.get_mca_id()); + } + + let merchant_recipient_data = None; let mut router_data = payment_data .construct_router_data( state, connector.connector.id(), merchant_context, - &None, + customer, &merchant_connector_account, - None, + merchant_recipient_data, None, ) .await?; @@ -4347,7 +4591,26 @@ where &call_connector_action, ); + (router_data, should_continue_further) = complete_preprocessing_steps_if_required( + state, + &connector, + payment_data, + router_data, + operation, + should_continue_further, + ) + .await?; + + if let Ok(router_types::PaymentsResponseData::PreProcessingResponse { + session_token: Some(session_token), + .. + }) = router_data.response.to_owned() + { + payment_data.push_sessions_token(session_token); + }; + let (connector_request, should_continue_further) = if should_continue_further { + // Check if the actual flow specific request can be built with available data router_data .build_flow_specific_connector_request(state, &connector, call_connector_action.clone()) .await? @@ -4355,22 +4618,44 @@ where (None, false) }; + if should_add_task_to_process_tracker(payment_data) { + operation + .to_domain()? + .add_task_to_process_tracker( + state, + payment_data.get_payment_attempt(), + validate_result.requeue, + schedule_time, + ) + .await + .map_err(\|error\| logger::error!(process_tracker_error=?error)) + .ok(); + } + + let updated_customer = None; + let frm_suggestion = None; + (_, payment_data) = operation .to_update_tracker()? .update_trackers( state, req_state, payment_data.clone(), - None, + customer.clone(), merchant_context.get_merchant_account().storage_scheme, - None, + updated_customer, merchant_context.get_merchant_key_store(), - None, + frm_suggestion, header_payload.clone(), ) .await?; let router_data = if should_continue_further { + // The status of payment_attempt and intent will be updated in the previous step + // update this in router_data. + // This is added because few connector integrations do not update the status, + // and rely on previous status set in router_data + router_data.status = payment_data.get_payment_attempt().status; router_data .decide_flows( state, @@ -4390,13 +4675,13 @@ where let duration_connector = etime_connector.saturating_duration_since(stime_connector); tracing::info!(duration = format!("Duration taken: {}", duration_connector.as_millis())); - Ok(router_data) + Ok((router_data, merchant_connector_account)) } #[cfg(feature = "v2")] #[allow(clippy::too_many_arguments)] #[instrument(skip_all)] -pub async fn internal_call_connector_service<F, RouterDReq, ApiRequest, D>( +pub async fn proxy_for_call_connector_service<F, RouterDReq, ApiRequest, D>( state: &SessionState, req_state: ReqState, merchant_context: &domain::MerchantContext, @@ -4422,18 +4707,15 @@ where { let stime_connector = Instant::now(); - let merchant_connector_details = - payment_data - .get_merchant_connector_details() - .ok_or_else(\|\| { - error_stack::report!(errors::ApiErrorResponse::InternalServerError) - .attach_printable("Merchant connector details not found in payment data") - })?; let merchant_connector_account = - domain::MerchantConnectorAccountTypeDetails::MerchantConnectorDetails( - merchant_connector_details, - ); - + domain::MerchantConnectorAccountTypeDetails::MerchantConnectorAccount(Box::new( + helpers::get_merchant_connector_account_v2( + state, + merchant_context.get_merchant_key_store(), + connector.merchant_connector_id.as_ref(), + ) + .await?, + )); operation .to_domain()? .populate_payment_data( @@ -4474,22 +4756,6 @@ where &call_connector_action, ); - let add_create_order_result = router_data - .create_order_at_connector(state, &connector, should_continue_further) - .await?; - - if add_create_order_result.is_create_order_performed { - if let Ok(order_id_opt) = &add_create_order_result.create_order_result { - payment_data.set_connector_response_reference_id(order_id_opt.clone()); - } - should_continue_further = router_data - .update_router_data_with_create_order_result( - add_create_order_result, - should_continue_further, - ) - .await?; - } - let (connector_request, should_continue_further) = if should_continue_further { router_data .build_flow_specific_connector_request(state, &connector, call_connector_action.clone()) diff --git a/crates/router/src/core/payments/flows.rs b/crates/router/src/core/payments/flows.rs index a93e2f391fe..2cae2f0600d 100644 --- a/crates/router/src/core/payments/flows.rs +++ b/crates/router/src/core/payments/flows.rs @@ -185,35 +185,27 @@ pub trait Feature<F, T> { _state: &SessionState, _connector: &api::ConnectorData, _should_continue_payment: bool, - ) -> RouterResult<types::CreateOrderResult> + ) -> RouterResult<Option<types::CreateOrderResult>> where F: Clone, Self: Sized, dyn api::Connector: services::ConnectorIntegration<F, T, types::PaymentsResponseData>, { - Ok(types::CreateOrderResult { - create_order_result: Ok(None), - is_create_order_performed: false, - }) + Ok(None) } - async fn update_router_data_with_create_order_result( + fn update_router_data_with_create_order_response( &mut self, _create_order_result: types::CreateOrderResult, - should_continue_payment: bool, - ) -> RouterResult<bool> - where - F: Clone, - Self: Sized, - dyn api::Connector: services::ConnectorIntegration<F, T, types::PaymentsResponseData>, - { - Ok(should_continue_payment) + ) { } async fn call_unified_connector_service<'a>( &mut self, _state: &SessionState, - _merchant_connector_account: helpers::MerchantConnectorAccountType, + #[cfg(feature = "v1")] _merchant_connector_account: helpers::MerchantConnectorAccountType, + #[cfg(feature = "v2")] + _merchant_connector_account: domain::MerchantConnectorAccountTypeDetails, _merchant_context: &domain::MerchantContext, ) -> RouterResult<()> where diff --git a/crates/router/src/core/payments/flows/authorize_flow.rs b/crates/router/src/core/payments/flows/authorize_flow.rs index 1532fffa3f9..f42efa0c1e4 100644 --- a/crates/router/src/core/payments/flows/authorize_flow.rs +++ b/crates/router/src/core/payments/flows/authorize_flow.rs @@ -431,7 +431,7 @@ impl Feature<api::Authorize, types::PaymentsAuthorizeData> for types::PaymentsAu state: &SessionState, connector: &api::ConnectorData, should_continue_payment: bool, - ) -> RouterResult<types::CreateOrderResult> { + ) -> RouterResult<Option<types::CreateOrderResult>> { if connector .connector_name .requires_order_creation_before_payment(self.payment_method) @@ -471,7 +471,7 @@ impl Feature<api::Authorize, types::PaymentsAuthorizeData> for types::PaymentsAu if let types::PaymentsResponseData::PaymentsCreateOrderResponse { order_id } = res { - Ok(Some(order_id)) + Ok(order_id) } else { Err(error_stack::report!(ApiErrorResponse::InternalServerError) .attach_printable(format!( @@ -482,47 +482,37 @@ impl Feature<api::Authorize, types::PaymentsAuthorizeData> for types::PaymentsAu Err(error) => Err(error), }; - Ok(types::CreateOrderResult { + Ok(Some(types::CreateOrderResult { create_order_result: create_order_resp, - is_create_order_performed: true, - }) + })) } else { - Ok(types::CreateOrderResult { - create_order_result: Ok(None), - is_create_order_performed: false, - }) + // If the connector does not require order creation, return None + Ok(None) } } - async fn update_router_data_with_create_order_result( + fn update_router_data_with_create_order_response( &mut self, create_order_result: types::CreateOrderResult, - should_continue_further: bool, - ) -> RouterResult<bool> { - if create_order_result.is_create_order_performed { - match create_order_result.create_order_result { - Ok(Some(order_id)) => { - self.request.order_id = Some(order_id.clone()); - self.response = - Ok(types::PaymentsResponseData::PaymentsCreateOrderResponse { order_id }); - Ok(true) - } - Ok(None) => Err(error_stack::report!(ApiErrorResponse::InternalServerError) - .attach_printable("Order Id not found."))?, - Err(err) => { - self.response = Err(err.clone()); - Ok(false) - } + ) { + match create_order_result.create_order_result { + Ok(order_id) => { + self.request.order_id = Some(order_id.clone()); // ? why this is assigned here and ucs also wants this to populate data + self.response = + Ok(types::PaymentsResponseData::PaymentsCreateOrderResponse { order_id }); + } + Err(err) => { + self.response = Err(err.clone()); } - } else { - Ok(should_continue_further) } } async fn call_unified_connector_service<'a>( &mut self, state: &SessionState, - merchant_connector_account: helpers::MerchantConnectorAccountType, + #[cfg(feature = "v1")] merchant_connector_account: helpers::MerchantConnectorAccountType, + #[cfg(feature = "v2")] + merchant_connector_account: domain::MerchantConnectorAccountTypeDetails, merchant_context: &domain::MerchantContext, ) -> RouterResult<()> { let client = state @@ -558,13 +548,14 @@ impl Feature<api::Authorize, types::PaymentsAuthorizeData> for types::PaymentsAu let (status, router_data_response) = handle_unified_connector_service_response_for_payment_authorize( - payment_authorize_response, + payment_authorize_response.clone(), ) .change_context(ApiErrorResponse::InternalServerError) .attach_printable("Failed to deserialize UCS response")?; self.status = status; self.response = router_data_response; + self.raw_connector_response = payment_authorize_response.raw_connector_response; Ok(()) } diff --git a/crates/router/src/core/payments/flows/psync_flow.rs b/crates/router/src/core/payments/flows/psync_flow.rs index f2ffbe24d11..e27c9974406 100644 --- a/crates/router/src/core/payments/flows/psync_flow.rs +++ b/crates/router/src/core/payments/flows/psync_flow.rs @@ -1,6 +1,8 @@ use std::collections::HashMap; use async_trait::async_trait; +use error_stack::ResultExt; +use unified_connector_service_client::payments as payments_grpc; use super::{ConstructFlowSpecificData, Feature}; use crate::{ @@ -8,10 +10,14 @@ use crate::{ core::{ errors::{ApiErrorResponse, ConnectorErrorExt, RouterResult}, payments::{self, access_token, helpers, transformers, PaymentData}, + unified_connector_service::{ + build_unified_connector_service_auth_metadata, + handle_unified_connector_service_response_for_payment_get, + }, }, routes::SessionState, services::{self, api::ConnectorValidation, logger}, - types::{self, api, domain}, + types::{self, api, domain, transformers::ForeignTryFrom}, }; #[cfg(feature = "v1")] @@ -204,6 +210,56 @@ impl Feature<api::PSync, types::PaymentsSyncData> Ok((request, true)) } + + async fn call_unified_connector_service<'a>( + &mut self, + state: &SessionState, + #[cfg(feature = "v1")] merchant_connector_account: helpers::MerchantConnectorAccountType, + #[cfg(feature = "v2")] + merchant_connector_account: domain::MerchantConnectorAccountTypeDetails, + merchant_context: &domain::MerchantContext, + ) -> RouterResult<()> { + let client = state + .grpc_client + .unified_connector_service_client + .clone() + .ok_or(ApiErrorResponse::InternalServerError) + .attach_printable("Failed to fetch Unified Connector Service client")?; + + let payment_get_request = payments_grpc::PaymentServiceGetRequest::foreign_try_from(self) + .change_context(ApiErrorResponse::InternalServerError) + .attach_printable("Failed to construct Payment Get Request")?; + + let connector_auth_metadata = build_unified_connector_service_auth_metadata( + merchant_connector_account, + merchant_context, + ) + .change_context(ApiErrorResponse::InternalServerError) + .attach_printable("Failed to construct request metadata")?; + + let response = client + .payment_get( + payment_get_request, + connector_auth_metadata, + state.get_grpc_headers(), + ) + .await + .change_context(ApiErrorResponse::InternalServerError) + .attach_printable("Failed to get payment")?; + + let payment_get_response = response.into_inner(); + + let (status, router_data_response) = + handle_unified_connector_service_response_for_payment_get(payment_get_response.clone()) + .change_context(ApiErrorResponse::InternalServerError) + .attach_printable("Failed to deserialize UCS response")?; + + self.status = status; + self.response = router_data_response; + self.raw_connector_response = payment_get_response.raw_connector_response; + + Ok(()) + } } #[async_trait] diff --git a/crates/router/src/core/payments/transformers.rs b/crates/router/src/core/payments/transformers.rs index 2379dddb8fd..59359429080 100644 --- a/crates/router/src/core/payments/transformers.rs +++ b/crates/router/src/core/payments/transformers.rs @@ -304,7 +304,7 @@ pub async fn construct_payment_router_data_for_authorize<'a>( router_return_url: Some(router_return_url), webhook_url, complete_authorize_url, - customer_id: None, + customer_id: customer_id.clone(), surcharge_details: None, request_extended_authorization: None, request_incremental_authorization: matches!( @@ -3466,8 +3466,126 @@ where impl<F: Clone> TryFrom<PaymentAdditionalData<'_, F>> for types::PaymentsAuthorizeData { type Error = error_stack::Report<errors::ApiErrorResponse>; - fn try_from(_additional_data: PaymentAdditionalData<'_, F>) -> Result<Self, Self::Error> { - todo!() + fn try_from(additional_data: PaymentAdditionalData<'_, F>) -> Result<Self, Self::Error> { + let payment_data = additional_data.payment_data.clone(); + let router_base_url = &additional_data.router_base_url; + let connector_name = &additional_data.connector_name; + let attempt = &payment_data.payment_attempt; + let browser_info: Option<types::BrowserInformation> = attempt + .browser_info + .clone() + .map(types::BrowserInformation::from); + + let complete_authorize_url = Some(helpers::create_complete_authorize_url( + router_base_url, + attempt, + connector_name, + payment_data.creds_identifier.as_deref(), + )); + + let merchant_connector_account_id_or_connector_name = payment_data + .payment_attempt + .merchant_connector_id + .as_ref() + .map(\|mca_id\| mca_id.get_string_repr()) + .unwrap_or(connector_name); + + let webhook_url = Some(helpers::create_webhook_url( + router_base_url, + &attempt.merchant_id, + merchant_connector_account_id_or_connector_name, + )); + let router_return_url = Some(helpers::create_redirect_url( + router_base_url, + attempt, + connector_name, + payment_data.creds_identifier.as_deref(), + )); + + let payment_method_data = payment_data.payment_method_data.or_else(\|\| { + if payment_data.mandate_id.is_some() { + Some(domain::PaymentMethodData::MandatePayment) + } else { + None + } + }); + + let amount = payment_data + .payment_attempt + .get_total_amount() + .get_amount_as_i64(); + + let customer_name = additional_data + .customer_data + .as_ref() + .and_then(\|customer_data\| { + customer_data + .name + .as_ref() + .map(\|customer\| customer.clone().into_inner()) + }); + + let customer_id = additional_data + .customer_data + .as_ref() + .and_then(\|data\| data.get_id().clone().try_into().ok()); + + let merchant_order_reference_id = payment_data + .payment_intent + .merchant_reference_id + .map(\|s\| s.get_string_repr().to_string()); + + let shipping_cost = payment_data.payment_intent.amount_details.shipping_cost; + + Ok(Self { + payment_method_data: payment_method_data + .unwrap_or(domain::PaymentMethodData::Card(domain::Card::default())), + amount, + order_tax_amount: None, // V2 doesn't currently support order tax amount + email: None, // V2 doesn't store email directly in payment_intent + customer_name, + currency: payment_data.currency, + confirm: true, + statement_descriptor_suffix: None, + statement_descriptor: None, + capture_method: Some(payment_data.payment_intent.capture_method), + router_return_url, + webhook_url, + complete_authorize_url, + setup_future_usage: Some(payment_data.payment_intent.setup_future_usage), + mandate_id: payment_data.mandate_id.clone(), + off_session: get_off_session(payment_data.mandate_id.as_ref(), None), + customer_acceptance: None, + setup_mandate_details: None, + browser_info, + order_details: None, + order_category: None, + session_token: None, + enrolled_for_3ds: false, + related_transaction_id: None, + payment_experience: None, + payment_method_type: Some(payment_data.payment_attempt.payment_method_subtype), + surcharge_details: None, + customer_id, + request_incremental_authorization: false, + metadata: payment_data + .payment_intent + .metadata + .clone() + .map(\|m\| m.expose()), + authentication_data: None, + request_extended_authorization: None, + split_payments: None, + minor_amount: payment_data.payment_attempt.get_total_amount(), + merchant_order_reference_id, + integrity_object: None, + shipping_cost, + additional_payment_method_data: None, + merchant_account_id: None, + merchant_config_currency: None, + connector_testing_data: None, + order_id: None, + }) } } diff --git a/crates/router/src/core/unified_connector_service.rs b/crates/router/src/core/unified_connector_service.rs index 3cdcb28d4d8..14836ff20c6 100644 --- a/crates/router/src/core/unified_connector_service.rs +++ b/crates/router/src/core/unified_connector_service.rs @@ -1,4 +1,3 @@ -use api_models::admin::ConnectorAuthType; use common_enums::{AttemptStatus, PaymentMethodType}; use common_utils::{errors::CustomResult, ext_traits::ValueExt}; use error_stack::ResultExt; @@ -6,9 +5,11 @@ use external_services::grpc_client::unified_connector_service::{ ConnectorAuthMetadata, UnifiedConnectorServiceError, }; use hyperswitch_connectors::utils::CardData; +#[cfg(feature = "v2")] +use hyperswitch_domain_models::merchant_connector_account::MerchantConnectorAccountTypeDetails; use hyperswitch_domain_models::{ merchant_context::MerchantContext, - router_data::{ErrorResponse, RouterData}, + router_data::{ConnectorAuthType, ErrorResponse, RouterData}, router_response_types::{PaymentsResponseData, RedirectForm}, }; use masking::{ExposeInterface, PeekInterface, Secret}; @@ -101,7 +102,7 @@ pub fn build_unified_connector_service_payment_method( } _ => { return Err(UnifiedConnectorServiceError::NotImplemented(format!( - "Unimplemented card payment method type: {payment_method_type:?}" + "Unimplemented payment method subtype: {payment_method_type:?}" )) .into()); } @@ -113,24 +114,52 @@ pub fn build_unified_connector_service_payment_method( })), }) } + hyperswitch_domain_models::payment_method_data::PaymentMethodData::Upi(upi_data) => { + let upi_type = match upi_data { + hyperswitch_domain_models::payment_method_data::UpiData::UpiCollect( + upi_collect_data, + ) => { + let vpa_id = upi_collect_data.vpa_id.map(\|vpa\| vpa.expose()); + let upi_details = payments_grpc::UpiCollect { vpa_id }; + PaymentMethod::UpiCollect(upi_details) + } + _ => { + return Err(UnifiedConnectorServiceError::NotImplemented(format!( + "Unimplemented payment method subtype: {payment_method_type:?}" + )) + .into()); + } + }; - _ => Err(UnifiedConnectorServiceError::NotImplemented( - "Unimplemented Payment Method".to_string(), - ) + Ok(payments_grpc::PaymentMethod { + payment_method: Some(upi_type), + }) + } + _ => Err(UnifiedConnectorServiceError::NotImplemented(format!( + "Unimplemented payment method: {payment_method_data:?}" + )) .into()), } } pub fn build_unified_connector_service_auth_metadata( - merchant_connector_account: MerchantConnectorAccountType, + #[cfg(feature = "v1")] merchant_connector_account: MerchantConnectorAccountType, + #[cfg(feature = "v2")] merchant_connector_account: MerchantConnectorAccountTypeDetails, merchant_context: &MerchantContext, ) -> CustomResult<ConnectorAuthMetadata, UnifiedConnectorServiceError> { + #[cfg(feature = "v1")] let auth_type: ConnectorAuthType = merchant_connector_account .get_connector_account_details() .parse_value("ConnectorAuthType") .change_context(UnifiedConnectorServiceError::FailedToObtainAuthType) .attach_printable("Failed while parsing value for ConnectorAuthType")?; + #[cfg(feature = "v2")] + let auth_type: ConnectorAuthType = merchant_connector_account + .get_connector_account_details() + .change_context(UnifiedConnectorServiceError::FailedToObtainAuthType) + .attach_printable("Failed to obtain ConnectorAuthType")?; + let connector_name = { #[cfg(feature = "v1")] { @@ -211,30 +240,126 @@ pub fn handle_unified_connector_service_response_for_payment_authorize( }) }); + let transaction_id = response.transaction_id.as_ref().and_then(\|id\| { + id.id_type.clone().and_then(\|id_type\| match id_type { + payments_grpc::identifier::IdType::Id(id) => Some(id), + payments_grpc::identifier::IdType::EncodedData(encoded_data) => Some(encoded_data), + payments_grpc::identifier::IdType::NoResponseIdMarker(_) => None, + }) + }); + let router_data_response = match status { AttemptStatus::Charged \| - AttemptStatus::Authorized \| - AttemptStatus::AuthenticationPending \| - AttemptStatus::DeviceDataCollectionPending => Ok(PaymentsResponseData::TransactionResponse { - resource_id: match connector_response_reference_id.as_ref() { + AttemptStatus::Authorized \| + AttemptStatus::AuthenticationPending \| + AttemptStatus::DeviceDataCollectionPending \| + AttemptStatus::Started \| + AttemptStatus::AuthenticationSuccessful \| + AttemptStatus::Authorizing \| + AttemptStatus::ConfirmationAwaited \| + AttemptStatus::Pending => Ok(PaymentsResponseData::TransactionResponse { + resource_id: match transaction_id.as_ref() { + Some(transaction_id) => hyperswitch_domain_models::router_request_types::ResponseId::ConnectorTransactionId(transaction_id.clone()), + None => hyperswitch_domain_models::router_request_types::ResponseId::NoResponseId, + }, + redirection_data: Box::new( + response + .redirection_data + .clone() + .map(RedirectForm::foreign_try_from) + .transpose()? + ), + mandate_reference: Box::new(None), + connector_metadata: None, + network_txn_id: response.network_txn_id.clone(), + connector_response_reference_id, + incremental_authorization_allowed: response.incremental_authorization_allowed, + charges: None, + }), + AttemptStatus::AuthenticationFailed + \| AttemptStatus::AuthorizationFailed + \| AttemptStatus::Unresolved + \| AttemptStatus::Failure => Err(ErrorResponse { + code: response.error_code().to_owned(), + message: response.error_message().to_owned(), + reason: Some(response.error_message().to_owned()), + status_code: 500, + attempt_status: Some(status), + connector_transaction_id: connector_response_reference_id, + network_decline_code: None, + network_advice_code: None, + network_error_message: None, + }), + AttemptStatus::RouterDeclined \| + AttemptStatus::CodInitiated \| + AttemptStatus::Voided \| + AttemptStatus::VoidInitiated \| + AttemptStatus::CaptureInitiated \| + AttemptStatus::VoidFailed \| + AttemptStatus::AutoRefunded \| + AttemptStatus::PartialCharged \| + AttemptStatus::PartialChargedAndChargeable \| + AttemptStatus::PaymentMethodAwaited \| + AttemptStatus::CaptureFailed \| + AttemptStatus::IntegrityFailure => return Err(UnifiedConnectorServiceError::NotImplemented(format!( + "AttemptStatus {status:?} is not implemented for Unified Connector Service" + )).into()), + }; + + Ok((status, router_data_response)) +} + +pub fn handle_unified_connector_service_response_for_payment_get( + response: payments_grpc::PaymentServiceGetResponse, +) -> CustomResult< + (AttemptStatus, Result<PaymentsResponseData, ErrorResponse>), + UnifiedConnectorServiceError, +> { + let status = AttemptStatus::foreign_try_from(response.status())?; + + let connector_response_reference_id = + response.response_ref_id.as_ref().and_then(\|identifier\| { + identifier + .id_type + .clone() + .and_then(\|id_type\| match id_type { + payments_grpc::identifier::IdType::Id(id) => Some(id), + payments_grpc::identifier::IdType::EncodedData(encoded_data) => { + Some(encoded_data) + } + payments_grpc::identifier::IdType::NoResponseIdMarker(_) => None, + }) + }); + + let router_data_response = match status { + AttemptStatus::Charged \| + AttemptStatus::Authorized \| + AttemptStatus::AuthenticationPending \| + AttemptStatus::DeviceDataCollectionPending \| + AttemptStatus::Started \| + AttemptStatus::AuthenticationSuccessful \| + AttemptStatus::Authorizing \| + AttemptStatus::ConfirmationAwaited \| + AttemptStatus::Pending => Ok( + PaymentsResponseData::TransactionResponse { + resource_id: match connector_response_reference_id.as_ref() { Some(connector_response_reference_id) => hyperswitch_domain_models::router_request_types::ResponseId::ConnectorTransactionId(connector_response_reference_id.clone()), None => hyperswitch_domain_models::router_request_types::ResponseId::NoResponseId, }, - redirection_data: Box::new( - response - .redirection_data - .clone() - .map(RedirectForm::foreign_try_from) - .transpose()? - ), - mandate_reference: Box::new(None), - connector_metadata: None, - network_txn_id: response.network_txn_id.clone(), - connector_response_reference_id, - incremental_authorization_allowed: response.incremental_authorization_allowed, - charges: None, - }), - _ => Err(ErrorResponse { + redirection_data: Box::new( + None + ), + mandate_reference: Box::new(None), + connector_metadata: None, + network_txn_id: response.network_txn_id.clone(), + connector_response_reference_id, + incremental_authorization_allowed: None, + charges: None, + } + ), + AttemptStatus::AuthenticationFailed + \| AttemptStatus::AuthorizationFailed + \| AttemptStatus::Failure => Err(ErrorResponse { code: response.error_code().to_owned(), message: response.error_message().to_owned(), reason: Some(response.error_message().to_owned()), @@ -244,7 +369,22 @@ pub fn handle_unified_connector_service_response_for_payment_authorize( network_decline_code: None, network_advice_code: None, network_error_message: None, - }) + }), + AttemptStatus::RouterDeclined \| + AttemptStatus::CodInitiated \| + AttemptStatus::Voided \| + AttemptStatus::VoidInitiated \| + AttemptStatus::CaptureInitiated \| + AttemptStatus::VoidFailed \| + AttemptStatus::AutoRefunded \| + AttemptStatus::PartialCharged \| + AttemptStatus::PartialChargedAndChargeable \| + AttemptStatus::Unresolved \| + AttemptStatus::PaymentMethodAwaited \| + AttemptStatus::CaptureFailed \| + AttemptStatus::IntegrityFailure => return Err(UnifiedConnectorServiceError::NotImplemented(format!( + "AttemptStatus {status:?} is not implemented for Unified Connector Service" + )).into()), }; Ok((status, router_data_response)) diff --git a/crates/router/src/core/unified_connector_service/transformers.rs b/crates/router/src/core/unified_connector_service/transformers.rs index 0e2ae6fd343..e937a7e7d2d 100644 --- a/crates/router/src/core/unified_connector_service/transformers.rs +++ b/crates/router/src/core/unified_connector_service/transformers.rs @@ -7,8 +7,8 @@ use error_stack::ResultExt; use external_services::grpc_client::unified_connector_service::UnifiedConnectorServiceError; use hyperswitch_domain_models::{ router_data::RouterData, - router_flow_types::payments::Authorize, - router_request_types::{AuthenticationData, PaymentsAuthorizeData}, + router_flow_types::payments::{Authorize, PSync}, + router_request_types::{AuthenticationData, PaymentsAuthorizeData, PaymentsSyncData}, router_response_types::{PaymentsResponseData, RedirectForm}, }; use masking::{ExposeInterface, PeekInterface}; @@ -18,6 +18,37 @@ use crate::{ core::unified_connector_service::build_unified_connector_service_payment_method, types::transformers::ForeignTryFrom, }; +impl ForeignTryFrom<&RouterData<PSync, PaymentsSyncData, PaymentsResponseData>> + for payments_grpc::PaymentServiceGetRequest +{ + type Error = error_stack::Report<UnifiedConnectorServiceError>; + + fn foreign_try_from( + router_data: &RouterData<PSync, PaymentsSyncData, PaymentsResponseData>, + ) -> Result<Self, Self::Error> { + let connector_transaction_id = router_data + .request + .connector_transaction_id + .get_connector_transaction_id() + .map(\|id\| Identifier { + id_type: Some(payments_grpc::identifier::IdType::Id(id)), + }) + .ok(); + + let connector_ref_id = router_data + .request + .connector_reference_id + .clone() + .map(\|id\| Identifier { + id_type: Some(payments_grpc::identifier::IdType::Id(id)), + }); + + Ok(Self { + transaction_id: connector_transaction_id, + request_ref_id: connector_ref_id, + }) + } +} impl ForeignTryFrom<&RouterData<Authorize, PaymentsAuthorizeData, PaymentsResponseData>> for payments_grpc::PaymentServiceAuthorizeRequest @@ -113,7 +144,7 @@ impl ForeignTryFrom<&RouterData<Authorize, PaymentsAuthorizeData, PaymentsRespon .map(\|shipping_cost\| shipping_cost.get_amount_as_i64()), request_ref_id: Some(Identifier { id_type: Some(payments_grpc::identifier::IdType::Id( - router_data.payment_id.clone(), + router_data.connector_request_reference_id.clone(), )), }), connector_customer_id: router_data @@ -181,89 +212,115 @@ impl ForeignTryFrom<hyperswitch_domain_models::payment_address::PaymentAddress> fn foreign_try_from( payment_address: hyperswitch_domain_models::payment_address::PaymentAddress, ) -> Result<Self, Self::Error> { - let shipping = payment_address.get_shipping().and_then(\|address\| { - let details = address.address.as_ref()?; + let shipping = payment_address.get_shipping().map(\|address\| { + let details = address.address.as_ref(); let get_str = \|opt: &Option<masking::Secret<String>>\| opt.as_ref().map(\|s\| s.peek().to_owned()); let get_plain = \|opt: &Option<String>\| opt.clone(); - let country = details - .country - .as_ref() - .and_then(\|c\| payments_grpc::CountryAlpha2::from_str_name(&c.to_string())) - .ok_or_else(\|\| { - UnifiedConnectorServiceError::RequestEncodingFailedWithReason( - "Invalid country code".to_string(), - ) - }) - .attach_printable("Invalid country code") - .ok()? // Return None if invalid - .into(); - - Some(payments_grpc::Address { - first_name: get_str(&details.first_name), - last_name: get_str(&details.last_name), - line1: get_str(&details.line1), - line2: get_str(&details.line2), - line3: get_str(&details.line3), - city: get_plain(&details.city), - state: get_str(&details.state), - zip_code: get_str(&details.zip), - country_alpha2_code: Some(country), + let country = details.and_then(\|details\| { + details + .country + .as_ref() + .and_then(\|c\| payments_grpc::CountryAlpha2::from_str_name(&c.to_string())) + .map(\|country\| country.into()) + }); + + payments_grpc::Address { + first_name: get_str(&details.and_then(\|d\| d.first_name.clone())), + last_name: get_str(&details.and_then(\|d\| d.last_name.clone())), + line1: get_str(&details.and_then(\|d\| d.line1.clone())), + line2: get_str(&details.and_then(\|d\| d.line2.clone())), + line3: get_str(&details.and_then(\|d\| d.line3.clone())), + city: get_plain(&details.and_then(\|d\| d.city.clone())), + state: get_str(&details.and_then(\|d\| d.state.clone())), + zip_code: get_str(&details.and_then(\|d\| d.zip.clone())), + country_alpha2_code: country, email: address.email.as_ref().map(\|e\| e.peek().to_string()), phone_number: address .phone .as_ref() .and_then(\|phone\| phone.number.as_ref().map(\|n\| n.peek().to_string())), phone_country_code: address.phone.as_ref().and_then(\|p\| p.country_code.clone()), - }) + } }); - let billing = payment_address.get_payment_billing().and_then(\|address\| { - let details = address.address.as_ref()?; + let billing = payment_address.get_payment_billing().map(\|address\| { + let details = address.address.as_ref(); let get_str = \|opt: &Option<masking::Secret<String>>\| opt.as_ref().map(\|s\| s.peek().to_owned()); let get_plain = \|opt: &Option<String>\| opt.clone(); - let country = details - .country - .as_ref() - .and_then(\|c\| payments_grpc::CountryAlpha2::from_str_name(&c.to_string())) - .ok_or_else(\|\| { - UnifiedConnectorServiceError::RequestEncodingFailedWithReason( - "Invalid country code".to_string(), - ) - }) - .attach_printable("Invalid country code") - .ok()? // Return None if invalid - .into(); - - Some(payments_grpc::Address { - first_name: get_str(&details.first_name), - last_name: get_str(&details.last_name), - line1: get_str(&details.line1), - line2: get_str(&details.line2), - line3: get_str(&details.line3), - city: get_plain(&details.city), - state: get_str(&details.state), - zip_code: get_str(&details.zip), - country_alpha2_code: Some(country), + let country = details.and_then(\|details\| { + details + .country + .as_ref() + .and_then(\|c\| payments_grpc::CountryAlpha2::from_str_name(&c.to_string())) + .map(\|country\| country.into()) + }); + + payments_grpc::Address { + first_name: get_str(&details.and_then(\|d\| d.first_name.clone())), + last_name: get_str(&details.and_then(\|d\| d.last_name.clone())), + line1: get_str(&details.and_then(\|d\| d.line1.clone())), + line2: get_str(&details.and_then(\|d\| d.line2.clone())), + line3: get_str(&details.and_then(\|d\| d.line3.clone())), + city: get_plain(&details.and_then(\|d\| d.city.clone())), + state: get_str(&details.and_then(\|d\| d.state.clone())), + zip_code: get_str(&details.and_then(\|d\| d.zip.clone())), + country_alpha2_code: country, email: address.email.as_ref().map(\|e\| e.peek().to_string()), phone_number: address .phone .as_ref() .and_then(\|phone\| phone.number.as_ref().map(\|n\| n.peek().to_string())), phone_country_code: address.phone.as_ref().and_then(\|p\| p.country_code.clone()), - }) + } }); + let unified_payment_method_billing = + payment_address.get_payment_method_billing().map(\|address\| { + let details = address.address.as_ref(); + + let get_str = \|opt: &Option<masking::Secret<String>>\| { + opt.as_ref().map(\|s\| s.peek().to_owned()) + }; + + let get_plain = \|opt: &Option<String>\| opt.clone(); + + let country = details.and_then(\|details\| { + details + .country + .as_ref() + .and_then(\|c\| payments_grpc::CountryAlpha2::from_str_name(&c.to_string())) + .map(\|country\| country.into()) + }); + + payments_grpc::Address { + first_name: get_str(&details.and_then(\|d\| d.first_name.clone())), + last_name: get_str(&details.and_then(\|d\| d.last_name.clone())), + line1: get_str(&details.and_then(\|d\| d.line1.clone())), + line2: get_str(&details.and_then(\|d\| d.line2.clone())), + line3: get_str(&details.and_then(\|d\| d.line3.clone())), + city: get_plain(&details.and_then(\|d\| d.city.clone())), + state: get_str(&details.and_then(\|d\| d.state.clone())), + zip_code: get_str(&details.and_then(\|d\| d.zip.clone())), + country_alpha2_code: country, + email: address.email.as_ref().map(\|e\| e.peek().to_string()), + phone_number: address + .phone + .as_ref() + .and_then(\|phone\| phone.number.as_ref().map(\|n\| n.peek().to_string())), + phone_country_code: address.phone.as_ref().and_then(\|p\| p.country_code.clone()), + } + }); Ok(Self { - shipping_address: shipping, - billing_address: billing, + shipping_address: shipping.or(unified_payment_method_billing.clone()), + billing_address: billing.or(unified_payment_method_billing), }) } } @@ -391,6 +448,12 @@ impl ForeignTryFrom<payments_grpc::RedirectForm> for RedirectForm { Some(payments_grpc::redirect_form::FormType::Html(html)) => Ok(Self::Html { html_data: html.html_data, }), + Some(payments_grpc::redirect_form::FormType::Uri(_)) => Err( + UnifiedConnectorServiceError::RequestEncodingFailedWithReason( + "URI form type is not implemented".to_string(), + ) + .into(), + ), None => Err( UnifiedConnectorServiceError::RequestEncodingFailedWithReason( "Missing form type".to_string(), diff --git a/crates/router/src/types.rs b/crates/router/src/types.rs index a5740561c7f..57043bbcc05 100644 --- a/crates/router/src/types.rs +++ b/crates/router/src/types.rs @@ -514,9 +514,9 @@ pub struct PaymentMethodTokenResult { pub connector_response: Option<ConnectorResponseData>, } +#[derive(Clone)] pub struct CreateOrderResult { - pub create_order_result: Result<Option<String>, ErrorResponse>, - pub is_create_order_performed: bool, + pub create_order_result: Result<String, ErrorResponse>, } pub struct PspTokenResult {	2025-06-24T06:16:40Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ### Fixes #8440 ## Description <!-- Describe your changes in detail --> This PR implements V2 UCS (Unified Connector Service) Integration for authorization and synchronization flows, building upon the existing V1 UCS integration (PR#[8280](https://github.com/juspay/hyperswitch/pull/8280)), with enhanced V2 schema support according to updated gRPC contract. Key Features Implemented: 1. Authorization Flow (Payments): Full V2 schema support for payment authorization 2. PSync Flow: Payment status synchronization through UCS V2 3. UPI Payment Method: Support for UPI Collect payment method 4. Enhanced Response Handling: Improved status mapping and error handling 5. Address Transformation Fix: Better handling of optional address fields Key Changes from V1 to V2: 1. Updated gRPC Schema: - Migrated from `PaymentsAuthorizeRequest` to `PaymentServiceAuthorizeRequest` - Added `PaymentServiceGetRequest` for PSync flow - Enhanced field structure for better type safety 2. New Payment Methods: - Added UPI Collect payment method support - Proper VPA ID extraction and handling 3. Enhanced Transformers: - Updated transformers for authorization and sync flows - Improved card details, address structure, and payment method handling - Fixed address transformation to handle None values gracefully 4. V2 Flow Architecture: - Refactored payment flow to separate UCS prerequisites and decision logic - Added PSync flow integration through UCS - Feature flag protection for clean V1/V2 separation 5. Improved Response Handling: - Enhanced response parsing with new identifier structure - Added support for more payment states (Started, AuthenticationSuccessful, Authorizing, etc.) - Better error handling and status mapping V2 Architecture Flow: V2 Payment Request → call_connector_service_prerequisites() → decide_unified_connector_service_call() → ├── UCS Available → V2 Transformers → gRPC Call → V2 Response Handling └── UCS Unavailable → Traditional Connector Flow (Fallback) V2 PSync Request → call_unified_connector_service() → ├── UCS Available → V2 PSync Transformer → gRPC Get Call → Status Response └── UCS Unavailable → Traditional Connector Sync Flow Key Technical Improvements: - Refactored Payment Functions: Split `call_connector_service()` into `call_connector_service_prerequisites()` and `decide_unified_connector_service_call()` for better separation of concerns - Enhanced V2 Transformers: Updated card data transformation, address structure, and authentication data handling - PSync Flow Integration: Added complete payment synchronization support through UCS - UPI Payment Support: Added UPI Collect payment method with VPA ID handling - Improved Error Handling: Better response parsing with new identifier structure - Customer ID Support: Added customer ID mapping in V2 transformer implementation - Enhanced Authentication: Added tenant_id and merchant_id to ConnectorAuthMetadata Files Modified: - `crates/router/Cargo.toml` - Updated rust-grpc-client dependency to main branch - `crates/router/src/core/payments.rs` - Refactored UCS integration with V2 prerequisite and decision functions - `crates/router/src/core/payments/flows/authorize_flow.rs` - Updated to use `PaymentServiceAuthorizeRequest` - `crates/router/src/core/payments/flows/psync_flow.rs` - Added UCS V2 support for payment synchronization - `crates/router/src/core/payments/transformers.rs` - Added V2 PaymentsAuthorizeData transformer implementation and customer_id support - `crates/router/src/core/unified_connector_service/` - Updated transformers and response handlers for V2 schema - `crates/router/src/core/unified_connector_service.rs` - Added UPI payment method support and enhanced response handling - `crates/router/src/core/unified_connector_service/transformers.rs` - Major updates for V2 gRPC schema compatibility - `crates/external_services/src/grpc_client/unified_connector_service.rs` - Added payment get operations support ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> V2 UCS Integration Evolution: This change builds upon the existing V1 UCS integration to support the updated V2 gRPC schema and enhanced payment flow architecture. Key motivations: Schema Evolution: - Updated gRPC Contracts: V2 introduces improved field structures for better type safety and extensibility - Enhanced Data Models: New card details structure, improved address handling, and better identifier management - Backward Compatibility: V2 implementation maintains compatibility while leveraging new schema features Feature Additions: - PSync Flow Support: Enables payment status synchronization through UCS, reducing direct connector calls - UPI Payment Method: Adds support for popular Indian payment method through unified interface - Enhanced Status Handling: More granular payment states for better payment lifecycle tracking Architectural Improvements: - Separation of Concerns: Split monolithic UCS functions into prerequisite preparation and decision logic phases - Better Feature Flag Management: Clean V1/V2 separation using `#[cfg(feature = "v2")]` prevents conflicts - Enhanced Error Handling: Improved response parsing and identifier handling for better reliability - Maintainability: Cleaner code structure for easier debugging and future enhancements Business Value: - Future-Proofing: V2 schema supports upcoming UCS enhancements and new payment flows - Improved Reliability: Better error handling and response parsing reduces failure rates - Enhanced Developer Experience: Cleaner API interfaces and better type safety - Operational Excellence: Maintains existing rollout controls while improving monitoring capabilities - Broader Payment Support: UPI integration opens up access to Indian market payment preferences ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> ### Manual Testing (HAPPY CASE) #### V2 Payment Intent Creation (Adyen via UCS) Request: ```bash curl --location 'http://localhost:8080/v2/payments/create-intent' \ --header 'api-key: dev_ymXSN8By3WESknjGnFyLVwDE4tK9v8ZjnkMZsKb2cM7KgjlzLfU1SOnJ63LsIrfR' \ --header 'Content-Type: application/json' \ --header 'x-profile-id: pro_2MBjeGslBsr2Lr7AoLvr' \ --header 'Authorization: api-key=dev_ymXSN8By3WESknjGnFyLVwDE4tK9v8ZjnkMZsKb2cM7KgjlzLfU1SOnJ63LsIrfR' \ --data '{ "amount_details": { "order_amount": 100, "currency": "USD" }, "capture_method": "automatic", "authentication_type": "no_three_ds", "customer_id": "12345_cus_0197abe38df57a408b928b4111ff5038", "billing": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" } }, "shipping": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" } } }' ``` Response: ```json { "id": "12345_pay_0197ac4f440c73c0b34c7050d248e483", "status": "requires_payment_method", "amount_details": { "order_amount": 100, "currency": "USD", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null }, "client_secret": "cs_0197ac4f4421744094d3abffdeae634c", "profile_id": "pro_2MBjeGslBsr2Lr7AoLvr", "merchant_reference_id": null, "routing_algorithm_id": null, "capture_method": "automatic", "authentication_type": "no_three_ds", "billing": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "joseph", "last_name": "Doe" }, "phone": null, "email": null }, "shipping": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "joseph", "last_name": "Doe" }, "phone": null, "email": null }, "customer_id": "12345_cus_0197abe38df57a408b928b4111ff5038", "customer_present": "present", "description": null, "return_url": null, "setup_future_usage": "on_session", "apply_mit_exemption": "Skip", "statement_descriptor": null, "order_details": null, "allowed_payment_method_types": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "payment_link_enabled": "Skip", "payment_link_config": null, "request_incremental_authorization": "default", "expires_on": "2025-06-26T13:11:05.403Z", "frm_metadata": null, "request_external_three_ds_authentication": "Skip" } ``` #### V2 Payment Confirmation (Adyen via UCS) Request: ```bash curl --location 'http://localhost:8080/v2/payments/12345_pay_0197ac4f440c73c0b34c7050d248e483/confirm-intent' \ --header 'x-client-secret: cs_0197ac4f4421744094d3abffdeae634c' \ --header 'x-profile-id: pro_2MBjeGslBsr2Lr7AoLvr' \ --header 'x-connected-merchant-id: cloth_seller_2_X5u3WjKKaUMMtPMYCNQM' \ --header 'Authorization: publishable-key=pk_dev_b78d41b686d54407842e55c1be492fce,client-secret=cs_0197ac4f4421744094d3abffdeae634c' \ --header 'Content-Type: application/json' \ --header 'api-key: pk_dev_b78d41b686d54407842e55c1be492fce' \ --data '{ "payment_method_type": "card", "payment_method_subtype": "credit", "payment_method_data": { "card": { "card_number": "4111111111111111", "card_exp_month": "03", "card_exp_year": "30", "card_holder_name": "Joseph Doe", "card_cvc": "737" } }, "browser_info": { "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8", "language": "nl-NL", "color_depth": 24, "screen_height": 723, "screen_width": 1536, "time_zone": 0, "java_enabled": true, "java_script_enabled": true } }' ``` Response: ```json { "id": "12345_pay_0197ac4f440c73c0b34c7050d248e483", "status": "succeeded", "amount": { "order_amount": 100, "currency": "USD", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null, "net_amount": 100, "amount_to_capture": null, "amount_capturable": 0, "amount_captured": 100 }, "customer_id": "12345_cus_0197abe38df57a408b928b4111ff5038", "connector": "adyen", "created": "2025-06-26T12:56:05.403Z", "payment_method_data": { "billing": null }, "payment_method_type": "card", "payment_method_subtype": "credit", "connector_transaction_id": "12345_pay_0197ac4f440c73c0b34c7050d248e483", "connector_reference_id": null, "merchant_connector_id": "mca_YUhrsoeHfh0EQJE6Zqut", "browser_info": null, "error": null, "shipping": null, "billing": null, "attempts": null, "connector_token_details": null, "payment_method_id": null, "next_action": null, "return_url": "https://google.com/success", "authentication_type": "no_three_ds", "authentication_type_applied": "no_three_ds", "is_iframe_redirection_enabled": null, "merchant_reference_id": null } ``` #### V2 Payment Intent Creation (Adyen via Traditional Connector Flow) Request: ```bash curl --location 'http://localhost:8080/v2/payments/create-intent' \ --header 'api-key: dev_ymXSN8By3WESknjGnFyLVwDE4tK9v8ZjnkMZsKb2cM7KgjlzLfU1SOnJ63LsIrfR' \ --header 'Content-Type: application/json' \ --header 'x-profile-id: pro_2MBjeGslBsr2Lr7AoLvr' \ --header 'Authorization: api-key=dev_ymXSN8By3WESknjGnFyLVwDE4tK9v8ZjnkMZsKb2cM7KgjlzLfU1SOnJ63LsIrfR' \ --data '{ "amount_details": { "order_amount": 100, "currency": "USD" }, "capture_method": "automatic", "authentication_type": "no_three_ds", "customer_id": "12345_cus_0197abe38df57a408b928b4111ff5038", "billing": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" } }, "shipping": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" } } }' ``` Response: ```json { "id": "12345_pay_0197ac4c67657d81a796bc358b364d04", "status": "requires_payment_method", "amount_details": { "order_amount": 100, "currency": "USD", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null }, "client_secret": "cs_0197ac4c67ac7731907d52f9dac88996", "profile_id": "pro_2MBjeGslBsr2Lr7AoLvr", "merchant_reference_id": null, "routing_algorithm_id": null, "capture_method": "automatic", "authentication_type": "no_three_ds", "billing": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "joseph", "last_name": "Doe" }, "phone": null, "email": null }, "shipping": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "joseph", "last_name": "Doe" }, "phone": null, "email": null }, "customer_id": "12345_cus_0197abe38df57a408b928b4111ff5038", "customer_present": "present", "description": null, "return_url": null, "setup_future_usage": "on_session", "apply_mit_exemption": "Skip", "statement_descriptor": null, "order_details": null, "allowed_payment_method_types": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "payment_link_enabled": "Skip", "payment_link_config": null, "request_incremental_authorization": "default", "expires_on": "2025-06-26T13:07:57.887Z", "frm_metadata": null, "request_external_three_ds_authentication": "Skip" } ``` #### V2 Payment Confirmation (Adyen via Traditional Connector Flow) Request: ```bash curl --location 'http://localhost:8080/v2/payments/12345_pay_0197ac4c67657d81a796bc358b364d04/confirm-intent' \ --header 'x-client-secret: cs_0197ac4c67ac7731907d52f9dac88996' \ --header 'x-profile-id: pro_2MBjeGslBsr2Lr7AoLvr' \ --header 'x-connected-merchant-id: cloth_seller_2_X5u3WjKKaUMMtPMYCNQM' \ --header 'Authorization: publishable-key=pk_dev_b78d41b686d54407842e55c1be492fce,client-secret=cs_0197ac4c67ac7731907d52f9dac88996' \ --header 'Content-Type: application/json' \ --header 'api-key: pk_dev_b78d41b686d54407842e55c1be492fce' \ --data '{ "payment_method_type": "card", "payment_method_subtype": "credit", "payment_method_data": { "card": { "card_number": "4111111111111111", "card_exp_month": "03", "card_exp_year": "30", "card_holder_name": "Joseph Doe", "card_cvc": "737" } }, "browser_info": { "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8", "language": "nl-NL", "color_depth": 24, "screen_height": 723, "screen_width": 1536, "time_zone": 0, "java_enabled": true, "java_script_enabled": true } }' ``` Response: ```json { "id": "12345_pay_0197ac4c67657d81a796bc358b364d04", "status": "succeeded", "amount": { "order_amount": 100, "currency": "USD", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null, "net_amount": 100, "amount_to_capture": null, "amount_capturable": 0, "amount_captured": 100 }, "customer_id": "12345_cus_0197abe38df57a408b928b4111ff5038", "connector": "adyen", "created": "2025-06-26T12:52:57.887Z", "payment_method_data": { "billing": null }, "payment_method_type": "card", "payment_method_subtype": "credit", "connector_transaction_id": "K2LGMPJFQZ9TPM75", "connector_reference_id": null, "merchant_connector_id": "mca_YUhrsoeHfh0EQJE6Zqut", "browser_info": null, "error": null, "shipping": null, "billing": null, "attempts": null, "connector_token_details": null, "payment_method_id": null, "next_action": null, "return_url": "https://google.com/success", "authentication_type": "no_three_ds", "authentication_type_applied": "no_three_ds", "is_iframe_redirection_enabled": null, "merchant_reference_id": null } ``` ### Manual Testing (FAILURE CASE) #### V2 Payment Intent Creation (Adyen via UCS) Request: ```bash curl --location 'http://localhost:8080/v2/payments/create-intent' \ --header 'api-key: dev_ymXSN8By3WESknjGnFyLVwDE4tK9v8ZjnkMZsKb2cM7KgjlzLfU1SOnJ63LsIrfR' \ --header 'Content-Type: application/json' \ --header 'x-profile-id: pro_2MBjeGslBsr2Lr7AoLvr' \ --header 'Authorization: api-key=dev_ymXSN8By3WESknjGnFyLVwDE4tK9v8ZjnkMZsKb2cM7KgjlzLfU1SOnJ63LsIrfR' \ --data '{ "amount_details": { "order_amount": 100, "currency": "USD" }, "capture_method": "automatic", "authentication_type": "no_three_ds", "customer_id": "12345_cus_0197abe38df57a408b928b4111ff5038", "billing": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" } }, "shipping": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" } } }' ``` Response: ```json { "id": "12345_pay_0197ac52cee5796099a0ae352092a707", "status": "requires_payment_method", "amount_details": { "order_amount": 100, "currency": "USD", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null }, "client_secret": "cs_0197ac52cefb77e2be6097f5d54b1152", "profile_id": "pro_2MBjeGslBsr2Lr7AoLvr", "merchant_reference_id": null, "routing_algorithm_id": null, "capture_method": "automatic", "authentication_type": "no_three_ds", "billing": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "joseph", "last_name": "Doe" }, "phone": null, "email": null }, "shipping": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "joseph", "last_name": "Doe" }, "phone": null, "email": null }, "customer_id": "12345_cus_0197abe38df57a408b928b4111ff5038", "customer_present": "present", "description": null, "return_url": null, "setup_future_usage": "on_session", "apply_mit_exemption": "Skip", "statement_descriptor": null, "order_details": null, "allowed_payment_method_types": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "payment_link_enabled": "Skip", "payment_link_config": null, "request_incremental_authorization": "default", "expires_on": "2025-06-26T13:14:57.559Z", "frm_metadata": null, "request_external_three_ds_authentication": "Skip" } ``` #### V2 Payment Confirmation (Adyen via UCS) Request: ```bash curl --location 'http://localhost:8080/v2/payments/12345_pay_0197ac52cee5796099a0ae352092a707/confirm-intent' \ --header 'x-client-secret: cs_0197ac52cefb77e2be6097f5d54b1152' \ --header 'x-profile-id: pro_2MBjeGslBsr2Lr7AoLvr' \ --header 'x-connected-merchant-id: cloth_seller_2_X5u3WjKKaUMMtPMYCNQM' \ --header 'Authorization: publishable-key=pk_dev_b78d41b686d54407842e55c1be492fce,client-secret=cs_0197ac52cefb77e2be6097f5d54b1152' \ --header 'Content-Type: application/json' \ --header 'api-key: pk_dev_b78d41b686d54407842e55c1be492fce' \ --data '{ "payment_method_type": "card", "payment_method_subtype": "credit", "payment_method_data": { "card": { "card_number": "4111111111111111", "card_exp_month": "03", "card_exp_year": "30", "card_holder_name": "Joseph Doe", "card_cvc": "730" } }, "browser_info": { "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8", "language": "nl-NL", "color_depth": 24, "screen_height": 723, "screen_width": 1536, "time_zone": 0, "java_enabled": true, "java_script_enabled": true } }' ``` Response: ```json { "id": "12345_pay_0197ac52cee5796099a0ae352092a707", "status": "failed", "amount": { "order_amount": 100, "currency": "USD", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null, "net_amount": 100, "amount_to_capture": null, "amount_capturable": 0, "amount_captured": 0 }, "customer_id": "12345_cus_0197abe38df57a408b928b4111ff5038", "connector": "adyen", "created": "2025-06-26T12:59:57.559Z", "payment_method_data": { "billing": null }, "payment_method_type": "card", "payment_method_subtype": "credit", "connector_transaction_id": "G4QT66CH8WCFHJ75", "connector_reference_id": null, "merchant_connector_id": "mca_YUhrsoeHfh0EQJE6Zqut", "browser_info": null, "error": { "code": "24", "message": "CVC Declined", "unified_code": null, "unified_message": null, "network_advice_code": null, "network_decline_code": null, "network_error_message": null }, "shipping": null, "billing": null, "attempts": null, "connector_token_details": null, "payment_method_id": null, "next_action": null, "return_url": "https://google.com/success", "authentication_type": "no_three_ds", "authentication_type_applied": "no_three_ds", "is_iframe_redirection_enabled": null, "merchant_reference_id": null } ``` #### V2 Payment Intent Creation (Adyen via Traditional Connector Flow) Request: ```bash curl --location 'http://localhost:8080/v2/payments/create-intent' \ --header 'api-key: dev_ymXSN8By3WESknjGnFyLVwDE4tK9v8ZjnkMZsKb2cM7KgjlzLfU1SOnJ63LsIrfR' \ --header 'Content-Type: application/json' \ --header 'x-profile-id: pro_2MBjeGslBsr2Lr7AoLvr' \ --header 'Authorization: api-key=dev_ymXSN8By3WESknjGnFyLVwDE4tK9v8ZjnkMZsKb2cM7KgjlzLfU1SOnJ63LsIrfR' \ --data '{ "amount_details": { "order_amount": 100, "currency": "USD" }, "capture_method": "automatic", "authentication_type": "no_three_ds", "customer_id": "12345_cus_0197abe38df57a408b928b4111ff5038", "billing": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" } }, "shipping": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" } } }' ``` Response: ```json { "id": "12345_pay_0197ac5574b37982b150606298590cfb", "status": "requires_payment_method", "amount_details": { "order_amount": 100, "currency": "USD", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null }, "client_secret": "cs_0197ac5574c57c50b773a7230ffffe69", "profile_id": "pro_2MBjeGslBsr2Lr7AoLvr", "merchant_reference_id": null, "routing_algorithm_id": null, "capture_method": "automatic", "authentication_type": "no_three_ds", "billing": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "joseph", "last_name": "Doe" }, "phone": null, "email": null }, "shipping": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "joseph", "last_name": "Doe" }, "phone": null, "email": null }, "customer_id": "12345_cus_0197abe38df57a408b928b4111ff5038", "customer_present": "present", "description": null, "return_url": null, "setup_future_usage": "on_session", "apply_mit_exemption": "Skip", "statement_descriptor": null, "order_details": null, "allowed_payment_method_types": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "payment_link_enabled": "Skip", "payment_link_config": null, "request_incremental_authorization": "default", "expires_on": "2025-06-26T13:17:51.072Z", "frm_metadata": null, "request_external_three_ds_authentication": "Skip" } ``` #### V2 Payment Confirmation (Adyen via Traditional Connector Flow) Request: ```bash curl --location 'http://localhost:8080/v2/payments/12345_pay_0197ac5574b37982b150606298590cfb/confirm-intent' \ --header 'x-client-secret: cs_0197ac5574c57c50b773a7230ffffe69' \ --header 'x-profile-id: pro_2MBjeGslBsr2Lr7AoLvr' \ --header 'x-connected-merchant-id: cloth_seller_2_X5u3WjKKaUMMtPMYCNQM' \ --header 'Authorization: publishable-key=pk_dev_b78d41b686d54407842e55c1be492fce,client-secret=cs_0197ac5574c57c50b773a7230ffffe69' \ --header 'Content-Type: application/json' \ --header 'api-key: pk_dev_b78d41b686d54407842e55c1be492fce' \ --data '{ "payment_method_type": "card", "payment_method_subtype": "credit", "payment_method_data": { "card": { "card_number": "4111111111111111", "card_exp_month": "03", "card_exp_year": "30", "card_holder_name": "Joseph Doe", "card_cvc": "730" } }, "browser_info": { "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8", "language": "nl-NL", "color_depth": 24, "screen_height": 723, "screen_width": 1536, "time_zone": 0, "java_enabled": true, "java_script_enabled": true } }' ``` Response: ```json { "id": "12345_pay_0197ac5574b37982b150606298590cfb", "status": "failed", "amount": { "order_amount": 100, "currency": "USD", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null, "net_amount": 100, "amount_to_capture": null, "amount_capturable": 0, "amount_captured": 0 }, "customer_id": "12345_cus_0197abe38df57a408b928b4111ff5038", "connector": "adyen", "created": "2025-06-26T13:02:51.072Z", "payment_method_data": { "billing": null }, "payment_method_type": "card", "payment_method_subtype": "credit", "connector_transaction_id": "DXZQPDL34QGTPM75", "connector_reference_id": null, "merchant_connector_id": "mca_YUhrsoeHfh0EQJE6Zqut", "browser_info": null, "error": { "code": "24", "message": "CVC Declined", "unified_code": null, "unified_message": null, "network_advice_code": null, "network_decline_code": null, "network_error_message": "DECLINED CVC Incorrect" }, "shipping": null, "billing": null, "attempts": null, "connector_token_details": null, "payment_method_id": null, "next_action": null, "return_url": "https://google.com/success", "authentication_type": "no_three_ds", "authentication_type_applied": "no_three_ds", "is_iframe_redirection_enabled": null, "merchant_reference_id": null } ``` ###UPI Collect payment through UCS Request ```bash curl --location 'http://localhost:8080/v2/payments' \ --header 'x-profile-id: pro_2MBjeGslBsr2Lr7AoLvr' \ --header 'x-merchant-id: cloth_seller_2_H3Oh1h4iu0wg8BWGvMzu' \ --header 'x-tenant-id: public' \ --header 'Content-Type: application/json' \ --header 'api-key: dev_ymXSN8By3WESknjGnFyLVwDE4tK9v8ZjnkMZsKb2cM7KgjlzLfU1SOnJ63LsIrfR' \ --data-raw '{ "amount_details": { "currency": "INR", "order_amount": 1000 }, "merchant_connector_details": { "connector_name": "razorpay", "merchant_connector_creds": { "auth_type": "SignatureKey", "key1": "***********************", "api_key": "****************", "api_secret": "****************" } }, "merchant_reference_id": "12345_pay_01970c787911751013554", "payment_method_data": { "upi": { "upi_collect": { "vpa_id": "failure@razorpay" } }, "billing": { "phone": { "number": "8800574493", "country_code": "+91" }, "email": "[email protected]" } }, "payment_method_subtype": "upi_collect", "payment_method_type": "upi" }' ``` Response* ```json { "id": "12345_pay_0197ceee564473609731b2ab35827cc7", "status": "processing", "amount": { "order_amount": 1000, "currency": "INR", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null, "net_amount": 1000, "amount_to_capture": null, "amount_capturable": 0, "amount_captured": null }, "customer_id": null, "connector": "razorpay", "created": "2025-07-03T06:16:55.621Z", "payment_method_data": { "billing": { "address": null, "phone": { "number": "8800574493", "country_code": "+91" }, "email": "[email protected]" } }, "payment_method_type": "upi", "payment_method_subtype": "upi_collect", "connector_transaction_id": "pay_QoUbCBtcPCfaWY", "connector_reference_id": "order_QoUbBDL6PKnuZY", "merchant_connector_id": null, "browser_info": null, "error": null, "shipping": null, "billing": null, "attempts": null, "connector_token_details": null, "payment_method_id": null, "next_action": null, "return_url": "https://google.com/success", "authentication_type": null, "authentication_type_applied": "no_three_ds", "is_iframe_redirection_enabled": null, "merchant_reference_id": "12345_pay_01970c787911751013554", "whole_connector_response": null } ``` ### PSync through UCS Request ```bash curl --location 'http://localhost:8080/v2/payments/12345_pay_0197ceee564473609731b2ab35827cc7' \ --header 'x-profile-id: pro_2MBjeGslBsr2Lr7AoLvr' \ --header 'x-merchant-id: cloth_seller_2_H3Oh1h4iu0wg8BWGvMzu' \ --header 'x-tenant-id: public' \ --header 'Content-Type: application/json' \ --header 'api-key: dev_ymXSN8By3WESknjGnFyLVwDE4tK9v8ZjnkMZsKb2cM7KgjlzLfU1SOnJ63LsIrfR' \ --data '{ "merchant_connector_details": { "connector_name": "razorpay", "merchant_connector_creds": { "auth_type": "SignatureKey", "key1": "************", "api_key": "****************", "api_secret": "***************" } }, "force_sync": true }'``` Response* ```json { "id": "12345_pay_0197ceee564473609731b2ab35827cc7", "status": "failed", "amount": { "order_amount": 1000, "currency": "INR", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null, "net_amount": 1000, "amount_to_capture": null, "amount_capturable": 0, "amount_captured": 0 }, "customer_id": null, "connector": "razorpay", "created": "2025-07-03T06:16:55.621Z", "payment_method_data": { "billing": { "address": null, "phone": { "number": "8800574493", "country_code": "+91" }, "email": "[email protected]" } }, "payment_method_type": "upi", "payment_method_subtype": "upi_collect", "connector_transaction_id": "pay_QoUbCBtcPCfaWY", "connector_reference_id": "order_QoUbBDL6PKnuZY", "merchant_connector_id": null, "browser_info": null, "error": { "code": "", "message": "", "unified_code": null, "unified_message": null, "network_advice_code": null, "network_decline_code": null, "network_error_message": null }, "shipping": null, "billing": null, "attempts": null, "connector_token_details": null, "payment_method_id": null, "next_action": null, "return_url": "https://google.com/success", "authentication_type": null, "authentication_type_applied": null, "is_iframe_redirection_enabled": null, "merchant_reference_id": "12345_pay_01970c787911751013554", "whole_connector_response": null } ``` V2 Schema Testing: - V2 gRPC schema compatibility verification - `PaymentServiceAuthorizeRequest` field mapping validation - Enhanced card details and address structure testing - Response identifier parsing with new structure Fallback Testing: - UCS service unavailable → Automatic fallback to traditional connector flow - Invalid authentication → Fallback with error logging - V2 transformer errors → Graceful degradation to V1 flow - Rollout percentage = 0% → Traditional flow used - Rollout percentage = 100% → UCS V2 flow used ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	b1c9be1600dbd897c32adcc2d8b98e77ec67c516	b1c9be1600dbd897c32adcc2d8b98e77ec67c516
juspay/hyperswitch	juspay__hyperswitch-8406	Bug: Fix payment redirects for v2 Fix payment redirects for v2	diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs index 59de54f41fa..e3fdf6e1cac 100644 --- a/crates/router/src/core/payments.rs +++ b/crates/router/src/core/payments.rs @@ -2996,7 +2996,7 @@ impl PaymentRedirectFlow for PaymentRedirectSync { force_sync: true, expand_attempts: false, all_keys_required: None, - merchant_connector_details: todo!(), // TODO: Implement for connectors requiring 3DS or redirection-based authentication flows. + merchant_connector_details: None, // TODO: Implement for connectors requiring 3DS or redirection-based authentication flows. }; let operation = operations::PaymentGet;	2025-06-20T11:02:47Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [x] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> This PR fixes payment redirects in v2. This was due to the field merchant_connector_details set as todo!() ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> - Make 3DS payment ``` curl --location 'http://localhost:8080/v2/payments' \ --header 'Content-Type: application/json' \ --header 'x-profile-id: pro_295oknnkIU8LhiO6RTCy' \ --header 'Authorization: api-key=dev_8OKnwsVtu4ZIxxgqDfVQwnQrUfdORX3Ivo9i8Yxp0rB3mEZxiv9UZchQimjPgNnx' \ --data-raw '{ "amount_details": { "currency": "USD", "order_amount": 6540 }, "authentication_type": "three_ds", "payment_method_data": { "card": { "card_cvc": "123", "card_exp_month": "10", "card_exp_year": "25", "card_holder_name": "joseph Doe", "card_number": "4242424242424242" } }, "payment_method_subtype": "credit", "payment_method_type": "card" }' ``` Response ``` { "id": "12345_pay_01978cfda5fa7c12b1ba298cca0470c2", "status": "requires_customer_action", "amount": { "order_amount": 6540, "currency": "USD", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null, "net_amount": 6540, "amount_to_capture": null, "amount_capturable": 0, "amount_captured": null }, "customer_id": null, "connector": "stripe", "created": "2025-06-20T10:58:42.813Z", "payment_method_data": { "billing": null }, "payment_method_type": "card", "payment_method_subtype": "credit", "connector_transaction_id": "pi_3Rc2edD5R7gDAGff01vwkClL", "connector_reference_id": null, "merchant_connector_id": "mca_0GI0dABwex0qdnwlUelt", "browser_info": null, "error": null, "shipping": null, "billing": null, "attempts": null, "connector_token_details": { "token": "pm_1Rc2edD5R7gDAGffEOosatGV", "connector_token_request_reference_id": "eDuVwDClp0zQPbbkLZ" }, "payment_method_id": null, "next_action": { "type": "redirect_to_url", "redirect_to_url": "http://localhost:8080/v2/payments/12345_pay_01978cfda5fa7c12b1ba298cca0470c2/start-redirection?publishable_key=pk_dev_4499ca4660714d6b83b379218164187a&profile_id=pro_295oknnkIU8LhiO6RTCy" }, "return_url": "https://google.com/success", "authentication_type": "three_ds", "authentication_type_applied": "three_ds", "is_iframe_redirection_enabled": null, "merchant_reference_id": null } ``` Redirect to URL - Payments Sync ``` curl --location 'http://localhost:8080/v2/payments/12345_pay_01978cfda5fa7c12b1ba298cca0470c2?force_sync=true' \ --header 'x-profile-id: pro_295oknnkIU8LhiO6RTCy' \ --header 'Authorization: api-key=dev_8OKnwsVtu4ZIxxgqDfVQwnQrUfdORX3Ivo9i8Yxp0rB3mEZxiv9UZchQimjPgNnx' \ --data '' ``` Response ``` { "id": "12345_pay_01978cfda5fa7c12b1ba298cca0470c2", "status": "succeeded", "amount": { "order_amount": 6540, "currency": "USD", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null, "net_amount": 6540, "amount_to_capture": null, "amount_capturable": 0, "amount_captured": 6540 }, "customer_id": null, "connector": "stripe", "created": "2025-06-20T10:58:42.813Z", "payment_method_data": { "billing": null }, "payment_method_type": "card", "payment_method_subtype": "credit", "connector_transaction_id": "pi_3Rc2edD5R7gDAGff01vwkClL", "connector_reference_id": null, "merchant_connector_id": "mca_0GI0dABwex0qdnwlUelt", "browser_info": null, "error": null, "shipping": null, "billing": null, "attempts": null, "connector_token_details": { "token": "pm_1Rc2edD5R7gDAGffEOosatGV", "connector_token_request_reference_id": "eDuVwDClp0zQPbbkLZ" }, "payment_method_id": null, "next_action": null, "return_url": "https://google.com/success", "authentication_type": "three_ds", "authentication_type_applied": null, "is_iframe_redirection_enabled": null, "merchant_reference_id": null } ``` ## Checklist <!-- Put an `x` in the boxes that apply --> - [ ] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.114.0	c99ec73885e0c64552f01826b20a1af7a934a65c	c99ec73885e0c64552f01826b20a1af7a934a65c
juspay/hyperswitch	juspay__hyperswitch-8392	Bug: [FEATURE] allow payout_id to be configurable ### Feature Description `payout_id` is an unique identifier for payout resource which is auto generated during payout creation. This field needs to be configurable during payout creation by accepting in the API. Along with this, a `merchant_order_reference_id` needs to be added which is an unique identifier for the consumer of the API. ### Possible Implementation Below changes are needed in payout flow across different components - - Add `payout_id` to API models - Add `PayoutId` domain type - Add `merchant_order_reference_id` to API and diesel models - Add DB queries for fetching orders using `merchant_order_reference_id` - Add `merchant_order_reference_id` as a filter for OLAP APIs - Use uuidv4 for payout ID creation for Wise ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? None	diff --git a/api-reference/v1/openapi_spec_v1.json b/api-reference/v1/openapi_spec_v1.json index fe57a935d16..85223163b29 100644 --- a/api-reference/v1/openapi_spec_v1.json +++ b/api-reference/v1/openapi_spec_v1.json @@ -24303,6 +24303,13 @@ "client_secret" ], "properties": { + "merchant_order_reference_id": { + "type": "string", + "description": "Your unique identifier for this payout or order. This ID helps you reconcile payouts on your system. If provided, it is passed to the connector if supported.", + "example": "merchant_order_ref_123", + "nullable": true, + "maxLength": 255 + }, "amount": { "type": "integer", "format": "int64", @@ -24609,6 +24616,13 @@ "example": "merchant_1668273825", "maxLength": 255 }, + "merchant_order_reference_id": { + "type": "string", + "description": "Your unique identifier for this payout or order. This ID helps you reconcile payouts on your system. If provided, it is passed to the connector if supported.", + "example": "merchant_order_ref_123", + "nullable": true, + "maxLength": 255 + }, "amount": { "type": "integer", "format": "int64", @@ -24902,13 +24916,13 @@ "starting_after": { "type": "string", "description": "A cursor for use in pagination, fetch the next list after some object", - "example": "pay_fafa124123", + "example": "payout_fafa124123", "nullable": true }, "ending_before": { "type": "string", "description": "A cursor for use in pagination, fetch the previous list before some object", - "example": "pay_fafa124123", + "example": "payout_fafa124123", "nullable": true }, "limit": { @@ -24955,6 +24969,13 @@ "maxLength": 30, "minLength": 30 }, + "merchant_order_reference_id": { + "type": "string", + "description": "The merchant order reference ID for payout", + "example": "merchant_order_ref_123", + "nullable": true, + "maxLength": 255 + }, "profile_id": { "type": "string", "description": "The identifier for business profile", @@ -25249,6 +25270,13 @@ "PayoutUpdateRequest": { "type": "object", "properties": { + "merchant_order_reference_id": { + "type": "string", + "description": "Your unique identifier for this payout or order. This ID helps you reconcile payouts on your system. If provided, it is passed to the connector if supported.", + "example": "merchant_order_ref_123", + "nullable": true, + "maxLength": 255 + }, "amount": { "type": "integer", "format": "int64", @@ -25479,6 +25507,13 @@ "currency" ], "properties": { + "merchant_order_reference_id": { + "type": "string", + "description": "Your unique identifier for this payout or order. This ID helps you reconcile payouts on your system. If provided, it is passed to the connector if supported.", + "example": "merchant_order_ref_123", + "nullable": true, + "maxLength": 255 + }, "amount": { "type": "integer", "format": "int64", diff --git a/api-reference/v2/openapi_spec_v2.json b/api-reference/v2/openapi_spec_v2.json index 5ceb5f032f5..0bd642c8be8 100644 --- a/api-reference/v2/openapi_spec_v2.json +++ b/api-reference/v2/openapi_spec_v2.json @@ -19579,7 +19579,19 @@ "additionalProperties": false }, "PayoutActionRequest": { - "type": "object" + "type": "object", + "required": [ + "payout_id" + ], + "properties": { + "payout_id": { + "type": "string", + "description": "Unique identifier for the payout. This ensures idempotency for multiple payouts\nthat have been done by a single merchant. This field is auto generated and is returned in the API response.", + "example": "187282ab-40ef-47a9-9206-5099ba31e432", + "maxLength": 30, + "minLength": 30 + } + } }, "PayoutAttemptResponse": { "type": "object", @@ -19746,6 +19758,13 @@ "nullable": true, "maxLength": 255 }, + "merchant_order_reference_id": { + "type": "string", + "description": "Your unique identifier for this payout or order. This ID helps you reconcile payouts on your system. If provided, it is passed to the connector if supported.", + "example": "merchant_order_ref_123", + "nullable": true, + "maxLength": 255 + }, "amount": { "type": "integer", "format": "int64", @@ -20001,6 +20020,13 @@ "example": "merchant_1668273825", "maxLength": 255 }, + "merchant_order_reference_id": { + "type": "string", + "description": "Your unique identifier for this payout or order. This ID helps you reconcile payouts on your system. If provided, it is passed to the connector if supported.", + "example": "merchant_order_ref_123", + "nullable": true, + "maxLength": 255 + }, "amount": { "type": "integer", "format": "int64", @@ -20279,13 +20305,13 @@ "starting_after": { "type": "string", "description": "A cursor for use in pagination, fetch the next list after some object", - "example": "pay_fafa124123", + "example": "payout_fafa124123", "nullable": true }, "ending_before": { "type": "string", "description": "A cursor for use in pagination, fetch the previous list before some object", - "example": "pay_fafa124123", + "example": "payout_fafa124123", "nullable": true }, "limit": { @@ -20332,6 +20358,13 @@ "maxLength": 30, "minLength": 30 }, + "merchant_order_reference_id": { + "type": "string", + "description": "The merchant order reference ID for payout", + "example": "merchant_order_ref_123", + "nullable": true, + "maxLength": 255 + }, "profile_id": { "type": "string", "description": "The identifier for business profile", diff --git a/crates/api_models/src/events/payouts.rs b/crates/api_models/src/events/payouts.rs index a08f3ed94a8..b7eded681a3 100644 --- a/crates/api_models/src/events/payouts.rs +++ b/crates/api_models/src/events/payouts.rs @@ -9,7 +9,7 @@ use crate::payouts::{ impl ApiEventMetric for PayoutRetrieveRequest { fn get_api_event_type(&self) -> Option<ApiEventsType> { Some(ApiEventsType::Payout { - payout_id: self.payout_id.clone(), + payout_id: self.payout_id.to_owned(), }) } } @@ -17,7 +17,7 @@ impl ApiEventMetric for PayoutRetrieveRequest { impl ApiEventMetric for PayoutCreateRequest { fn get_api_event_type(&self) -> Option<ApiEventsType> { self.payout_id.as_ref().map(\|id\| ApiEventsType::Payout { - payout_id: id.clone(), + payout_id: id.to_owned(), }) } } @@ -25,7 +25,7 @@ impl ApiEventMetric for PayoutCreateRequest { impl ApiEventMetric for PayoutCreateResponse { fn get_api_event_type(&self) -> Option<ApiEventsType> { Some(ApiEventsType::Payout { - payout_id: self.payout_id.clone(), + payout_id: self.payout_id.to_owned(), }) } } @@ -33,7 +33,7 @@ impl ApiEventMetric for PayoutCreateResponse { impl ApiEventMetric for PayoutActionRequest { fn get_api_event_type(&self) -> Option<ApiEventsType> { Some(ApiEventsType::Payout { - payout_id: self.payout_id.clone(), + payout_id: self.payout_id.to_owned(), }) } } @@ -65,7 +65,7 @@ impl ApiEventMetric for PayoutListFilters { impl ApiEventMetric for PayoutLinkInitiateRequest { fn get_api_event_type(&self) -> Option<ApiEventsType> { Some(ApiEventsType::Payout { - payout_id: self.payout_id.clone(), + payout_id: self.payout_id.to_owned(), }) } } diff --git a/crates/api_models/src/payouts.rs b/crates/api_models/src/payouts.rs index cf07fd9e109..a6fdaa2b6e5 100644 --- a/crates/api_models/src/payouts.rs +++ b/crates/api_models/src/payouts.rs @@ -16,7 +16,7 @@ use utoipa::ToSchema; use crate::{enums as api_enums, payment_methods::RequiredFieldInfo, payments}; -#[derive(Debug, Deserialize, Serialize, Clone, ToSchema)] +#[derive(Debug, Serialize, Clone, ToSchema)] pub enum PayoutRequest { PayoutActionRequest(PayoutActionRequest), PayoutCreateRequest(Box<PayoutCreateRequest>), @@ -37,13 +37,17 @@ pub struct PayoutCreateRequest { example = "187282ab-40ef-47a9-9206-5099ba31e432" )] #[remove_in(PayoutsCreateRequest, PayoutUpdateRequest, PayoutConfirmRequest)] - pub payout_id: Option<String>, // TODO: #1321 https://github.com/juspay/hyperswitch/issues/1321 + pub payout_id: Option<id_type::PayoutId>, /// This is an identifier for the merchant account. This is inferred from the API key provided during the request, not required to be included in the Payout Create/Update Request. #[schema(max_length = 255, value_type = Option<String>, example = "merchant_1668273825")] #[remove_in(PayoutsCreateRequest, PayoutUpdateRequest, PayoutConfirmRequest)] pub merchant_id: Option<id_type::MerchantId>, + /// Your unique identifier for this payout or order. This ID helps you reconcile payouts on your system. If provided, it is passed to the connector if supported. + #[schema(value_type = Option<String>, max_length = 255, example = "merchant_order_ref_123")] + pub merchant_order_reference_id: Option<String>, + /// The payout amount. Amount for the payout in lowest denomination of the currency. (i.e) in cents for USD denomination, in paisa for INR denomination etc., #[schema(value_type = Option<u64>, example = 1000)] #[mandatory_in(PayoutsCreateRequest = u64)] @@ -399,13 +403,17 @@ pub struct PayoutCreateResponse { max_length = 30, example = "187282ab-40ef-47a9-9206-5099ba31e432" )] - pub payout_id: String, // TODO: Update this to PayoutIdType similar to PaymentIdType + pub payout_id: id_type::PayoutId, /// This is an identifier for the merchant account. This is inferred from the API key /// provided during the request #[schema(max_length = 255, value_type = String, example = "merchant_1668273825")] pub merchant_id: id_type::MerchantId, + /// Your unique identifier for this payout or order. This ID helps you reconcile payouts on your system. If provided, it is passed to the connector if supported. + #[schema(value_type = Option<String>, max_length = 255, example = "merchant_order_ref_123")] + pub merchant_order_reference_id: Option<String>, + /// The payout amount. Amount for the payout in lowest denomination of the currency. (i.e) in cents for USD denomination, in paisa for INR denomination etc., #[schema(value_type = i64, example = 1000)] pub amount: common_utils::types::MinorUnit, @@ -638,7 +646,7 @@ pub struct PayoutRetrieveBody { pub merchant_id: Option<id_type::MerchantId>, } -#[derive(Default, Debug, Serialize, ToSchema, Clone, Deserialize)] +#[derive(Debug, Serialize, ToSchema, Clone, Deserialize)] pub struct PayoutRetrieveRequest { /// Unique identifier for the payout. This ensures idempotency for multiple payouts /// that have been done by a single merchant. This field is auto generated and is returned in the API response. @@ -648,7 +656,7 @@ pub struct PayoutRetrieveRequest { max_length = 30, example = "187282ab-40ef-47a9-9206-5099ba31e432" )] - pub payout_id: String, + pub payout_id: id_type::PayoutId, /// `force_sync` with the connector to get payout details /// (defaults to false) @@ -660,9 +668,7 @@ pub struct PayoutRetrieveRequest { pub merchant_id: Option<id_type::MerchantId>, } -#[derive( - Default, Debug, Deserialize, Serialize, Clone, ToSchema, router_derive::PolymorphicSchema, -)] +#[derive(Debug, Serialize, Clone, ToSchema, router_derive::PolymorphicSchema)] #[generate_schemas(PayoutCancelRequest, PayoutFulfillRequest)] pub struct PayoutActionRequest { /// Unique identifier for the payout. This ensures idempotency for multiple payouts @@ -673,8 +679,7 @@ pub struct PayoutActionRequest { max_length = 30, example = "187282ab-40ef-47a9-9206-5099ba31e432" )] - #[serde(skip_deserializing)] - pub payout_id: String, + pub payout_id: id_type::PayoutId, } #[derive(Default, Debug, ToSchema, Clone, Deserialize)] @@ -722,12 +727,12 @@ pub struct PayoutListConstraints { pub customer_id: Option<id_type::CustomerId>, /// A cursor for use in pagination, fetch the next list after some object - #[schema(example = "pay_fafa124123")] - pub starting_after: Option<String>, + #[schema(example = "payout_fafa124123", value_type = Option<String>,)] + pub starting_after: Option<id_type::PayoutId>, /// A cursor for use in pagination, fetch the previous list before some object - #[schema(example = "pay_fafa124123")] - pub ending_before: Option<String>, + #[schema(example = "payout_fafa124123", value_type = Option<String>,)] + pub ending_before: Option<id_type::PayoutId>, /// limit on the number of objects to return #[schema(default = 10, maximum = 100)] @@ -755,7 +760,10 @@ pub struct PayoutListFilterConstraints { max_length = 30, example = "187282ab-40ef-47a9-9206-5099ba31e432" )] - pub payout_id: Option<String>, + pub payout_id: Option<id_type::PayoutId>, + /// The merchant order reference ID for payout + #[schema(value_type = Option<String>, max_length = 255, example = "merchant_order_ref_123")] + pub merchant_order_reference_id: Option<String>, /// The identifier for business profile #[schema(value_type = Option<String>)] pub profile_id: Option<id_type::ProfileId>, @@ -826,7 +834,8 @@ pub struct PayoutLinkResponse { pub struct PayoutLinkInitiateRequest { #[schema(value_type = String)] pub merchant_id: id_type::MerchantId, - pub payout_id: String, + #[schema(value_type = String)] + pub payout_id: id_type::PayoutId, } #[derive(Clone, Debug, serde::Serialize)] @@ -834,7 +843,7 @@ pub struct PayoutLinkDetails { pub publishable_key: Secret<String>, pub client_secret: Secret<String>, pub payout_link_id: String, - pub payout_id: String, + pub payout_id: id_type::PayoutId, pub customer_id: id_type::CustomerId, #[serde(with = "common_utils::custom_serde::iso8601")] pub session_expiry: PrimitiveDateTime, @@ -870,7 +879,7 @@ pub struct RequiredFieldsOverrideRequest { #[derive(Clone, Debug, serde::Serialize)] pub struct PayoutLinkStatusDetails { pub payout_link_id: String, - pub payout_id: String, + pub payout_id: id_type::PayoutId, pub customer_id: id_type::CustomerId, #[serde(with = "common_utils::custom_serde::iso8601")] pub session_expiry: PrimitiveDateTime, diff --git a/crates/api_models/src/webhooks.rs b/crates/api_models/src/webhooks.rs index 4667866073b..177310de18f 100644 --- a/crates/api_models/src/webhooks.rs +++ b/crates/api_models/src/webhooks.rs @@ -98,7 +98,7 @@ pub enum WebhookResponseTracker { }, #[cfg(feature = "payouts")] Payout { - payout_id: String, + payout_id: common_utils::id_type::PayoutId, status: common_enums::PayoutStatus, }, #[cfg(feature = "v1")] diff --git a/crates/common_utils/src/events.rs b/crates/common_utils/src/events.rs index 376b57fbb47..e1964296755 100644 --- a/crates/common_utils/src/events.rs +++ b/crates/common_utils/src/events.rs @@ -12,7 +12,7 @@ pub trait ApiEventMetric { #[serde(tag = "flow_type", rename_all = "snake_case")] pub enum ApiEventsType { Payout { - payout_id: String, + payout_id: id_type::PayoutId, }, #[cfg(feature = "v1")] Payment { diff --git a/crates/common_utils/src/id_type.rs b/crates/common_utils/src/id_type.rs index d9daa5caf9d..6d73a90eab2 100644 --- a/crates/common_utils/src/id_type.rs +++ b/crates/common_utils/src/id_type.rs @@ -11,6 +11,7 @@ mod merchant; mod merchant_connector_account; mod organization; mod payment; +mod payout; mod profile; mod profile_acquirer; mod refunds; @@ -27,6 +28,7 @@ use diesel::{ serialize::{Output, ToSql}, sql_types, }; +pub use payout::PayoutId; use serde::{Deserialize, Serialize}; use thiserror::Error; diff --git a/crates/common_utils/src/id_type/payout.rs b/crates/common_utils/src/id_type/payout.rs new file mode 100644 index 00000000000..8faa661d363 --- /dev/null +++ b/crates/common_utils/src/id_type/payout.rs @@ -0,0 +1,10 @@ +crate::id_type!( + PayoutId, + "A domain type for payout_id that can be used for payout ids" +); +crate::impl_id_type_methods!(PayoutId, "payout_id"); +crate::impl_debug_id_type!(PayoutId); +crate::impl_try_from_cow_str_id_type!(PayoutId, "payout_id"); +crate::impl_generate_id_id_type!(PayoutId, "payout"); +crate::impl_queryable_id_type!(PayoutId); +crate::impl_to_sql_from_sql_id_type!(PayoutId); diff --git a/crates/common_utils/src/link_utils.rs b/crates/common_utils/src/link_utils.rs index 2201000d062..89a52f44792 100644 --- a/crates/common_utils/src/link_utils.rs +++ b/crates/common_utils/src/link_utils.rs @@ -149,7 +149,7 @@ pub struct PayoutLinkData { /// Identifier for the customer pub customer_id: id_type::CustomerId, /// Identifier for the payouts resource - pub payout_id: String, + pub payout_id: id_type::PayoutId, /// Link to render the payout link pub link: url::Url, /// Client secret generated for authenticating frontend APIs diff --git a/crates/diesel_models/src/events.rs b/crates/diesel_models/src/events.rs index cbc39340dcf..bc9f0788113 100644 --- a/crates/diesel_models/src/events.rs +++ b/crates/diesel_models/src/events.rs @@ -74,7 +74,7 @@ pub enum EventMetadata { payment_id: common_utils::id_type::GlobalPaymentId, }, Payout { - payout_id: String, + payout_id: common_utils::id_type::PayoutId, }, #[cfg(feature = "v1")] Refund { diff --git a/crates/diesel_models/src/generic_link.rs b/crates/diesel_models/src/generic_link.rs index 28402692480..d6071268eae 100644 --- a/crates/diesel_models/src/generic_link.rs +++ b/crates/diesel_models/src/generic_link.rs @@ -156,7 +156,7 @@ pub struct PaymentMethodCollectLinkData { #[diesel(primary_key(link_id))] pub struct PayoutLink { pub link_id: String, - pub primary_reference: String, + pub primary_reference: common_utils::id_type::PayoutId, pub merchant_id: common_utils::id_type::MerchantId, #[serde(with = "common_utils::custom_serde::iso8601")] pub created_at: PrimitiveDateTime, diff --git a/crates/diesel_models/src/payout_attempt.rs b/crates/diesel_models/src/payout_attempt.rs index 0e12a9ed801..a908ef7bdf5 100644 --- a/crates/diesel_models/src/payout_attempt.rs +++ b/crates/diesel_models/src/payout_attempt.rs @@ -14,7 +14,7 @@ use crate::{enums as storage_enums, schema::payout_attempt}; #[diesel(table_name = payout_attempt, primary_key(payout_attempt_id), check_for_backend(diesel::pg::Pg))] pub struct PayoutAttempt { pub payout_attempt_id: String, - pub payout_id: String, + pub payout_id: common_utils::id_type::PayoutId, pub customer_id: Option<common_utils::id_type::CustomerId>, pub merchant_id: common_utils::id_type::MerchantId, pub address_id: Option<String>, @@ -37,6 +37,7 @@ pub struct PayoutAttempt { pub unified_code: Option<UnifiedCode>, pub unified_message: Option<UnifiedMessage>, pub additional_payout_method_data: Option<payout_method_utils::AdditionalPayoutMethodData>, + pub merchant_order_reference_id: Option<String>, } #[derive( @@ -53,7 +54,7 @@ pub struct PayoutAttempt { #[diesel(table_name = payout_attempt)] pub struct PayoutAttemptNew { pub payout_attempt_id: String, - pub payout_id: String, + pub payout_id: common_utils::id_type::PayoutId, pub customer_id: Option<common_utils::id_type::CustomerId>, pub merchant_id: common_utils::id_type::MerchantId, pub address_id: Option<String>, @@ -76,6 +77,7 @@ pub struct PayoutAttemptNew { pub unified_code: Option<UnifiedCode>, pub unified_message: Option<UnifiedMessage>, pub additional_payout_method_data: Option<payout_method_utils::AdditionalPayoutMethodData>, + pub merchant_order_reference_id: Option<String>, } #[derive(Debug, Clone, Serialize, Deserialize)] @@ -128,6 +130,7 @@ pub struct PayoutAttemptUpdateInternal { pub unified_code: Option<UnifiedCode>, pub unified_message: Option<UnifiedMessage>, pub additional_payout_method_data: Option<payout_method_utils::AdditionalPayoutMethodData>, + pub merchant_order_reference_id: Option<String>, } impl Default for PayoutAttemptUpdateInternal { @@ -150,6 +153,7 @@ impl Default for PayoutAttemptUpdateInternal { unified_code: None, unified_message: None, additional_payout_method_data: None, + merchant_order_reference_id: None, } } } @@ -231,6 +235,7 @@ impl PayoutAttemptUpdate { unified_code, unified_message, additional_payout_method_data, + merchant_order_reference_id, } = self.into(); PayoutAttempt { payout_token: payout_token.or(source.payout_token), @@ -251,6 +256,8 @@ impl PayoutAttemptUpdate { unified_message: unified_message.or(source.unified_message), additional_payout_method_data: additional_payout_method_data .or(source.additional_payout_method_data), + merchant_order_reference_id: merchant_order_reference_id + .or(source.merchant_order_reference_id), ..source } } diff --git a/crates/diesel_models/src/payouts.rs b/crates/diesel_models/src/payouts.rs index 8acdc4a0a5a..881875494ab 100644 --- a/crates/diesel_models/src/payouts.rs +++ b/crates/diesel_models/src/payouts.rs @@ -11,7 +11,7 @@ use crate::{enums as storage_enums, schema::payouts}; )] #[diesel(table_name = payouts, primary_key(payout_id), check_for_backend(diesel::pg::Pg))] pub struct Payouts { - pub payout_id: String, + pub payout_id: common_utils::id_type::PayoutId, pub merchant_id: common_utils::id_type::MerchantId, pub customer_id: Option<common_utils::id_type::CustomerId>, pub address_id: Option<String>, @@ -52,7 +52,7 @@ pub struct Payouts { )] #[diesel(table_name = payouts)] pub struct PayoutsNew { - pub payout_id: String, + pub payout_id: common_utils::id_type::PayoutId, pub merchant_id: common_utils::id_type::MerchantId, pub customer_id: Option<common_utils::id_type::CustomerId>, pub address_id: Option<String>, diff --git a/crates/diesel_models/src/query/generic_link.rs b/crates/diesel_models/src/query/generic_link.rs index 75f1fc8ded8..96966e14547 100644 --- a/crates/diesel_models/src/query/generic_link.rs +++ b/crates/diesel_models/src/query/generic_link.rs @@ -224,7 +224,11 @@ impl TryFrom<GenericLink> for PayoutLink { Ok(Self { link_id: db_val.link_id, - primary_reference: db_val.primary_reference, + primary_reference: common_utils::id_type::PayoutId::try_from(std::borrow::Cow::Owned( + db_val.primary_reference, + )) + .change_context(errors::ParsingError::UnknownError) + .attach_printable("Failed to parse PayoutId from primary_reference string")?, merchant_id: db_val.merchant_id, created_at: db_val.created_at, last_modified_at: db_val.last_modified_at, diff --git a/crates/diesel_models/src/query/payout_attempt.rs b/crates/diesel_models/src/query/payout_attempt.rs index 939336a223a..300b6fdb647 100644 --- a/crates/diesel_models/src/query/payout_attempt.rs +++ b/crates/diesel_models/src/query/payout_attempt.rs @@ -56,7 +56,7 @@ impl PayoutAttempt { pub async fn find_by_merchant_id_payout_id( conn: &PgPooledConn, merchant_id: &common_utils::id_type::MerchantId, - payout_id: &str, + payout_id: &common_utils::id_type::PayoutId, ) -> StorageResult<Self> { generics::generic_find_one::<<Self as HasTable>::Table, _, _>( conn, @@ -95,10 +95,24 @@ impl PayoutAttempt { .await } + pub async fn find_by_merchant_id_merchant_order_reference_id( + conn: &PgPooledConn, + merchant_id_input: &common_utils::id_type::MerchantId, + merchant_order_reference_id_input: &str, + ) -> StorageResult<Self> { + generics::generic_find_one::<<Self as HasTable>::Table, _, _>( + conn, + dsl::merchant_id.eq(merchant_id_input.to_owned()).and( + dsl::merchant_order_reference_id.eq(merchant_order_reference_id_input.to_owned()), + ), + ) + .await + } + pub async fn update_by_merchant_id_payout_id( conn: &PgPooledConn, merchant_id: &common_utils::id_type::MerchantId, - payout_id: &str, + payout_id: &common_utils::id_type::PayoutId, payout: PayoutAttemptUpdate, ) -> StorageResult<Self> { generics::generic_update_with_results::<<Self as HasTable>::Table, _, _, _>( @@ -152,7 +166,7 @@ impl PayoutAttempt { .map(\|payout\| { format!( "{}_{}", - payout.payout_id.clone(), + payout.payout_id.get_string_repr(), payout.attempt_count.clone() ) }) @@ -160,8 +174,8 @@ impl PayoutAttempt { let active_payout_ids = payouts .iter() - .map(\|payout\| payout.payout_id.clone()) - .collect::<Vec<String>>(); + .map(\|payout\| payout.payout_id.to_owned()) + .collect::<Vec<common_utils::id_type::PayoutId>>(); let filter = <Self as HasTable>::table() .filter(dsl::merchant_id.eq(merchant_id.to_owned())) diff --git a/crates/diesel_models/src/query/payouts.rs b/crates/diesel_models/src/query/payouts.rs index 25c7bfc4f7e..e7d06d05ffe 100644 --- a/crates/diesel_models/src/query/payouts.rs +++ b/crates/diesel_models/src/query/payouts.rs @@ -47,7 +47,7 @@ impl Payouts { pub async fn find_by_merchant_id_payout_id( conn: &PgPooledConn, merchant_id: &common_utils::id_type::MerchantId, - payout_id: &str, + payout_id: &common_utils::id_type::PayoutId, ) -> StorageResult<Self> { generics::generic_find_one::<<Self as HasTable>::Table, _, _>( conn, @@ -61,7 +61,7 @@ impl Payouts { pub async fn update_by_merchant_id_payout_id( conn: &PgPooledConn, merchant_id: &common_utils::id_type::MerchantId, - payout_id: &str, + payout_id: &common_utils::id_type::PayoutId, payout: PayoutsUpdate, ) -> StorageResult<Self> { generics::generic_update_with_results::<<Self as HasTable>::Table, _, _, _>( @@ -82,7 +82,7 @@ impl Payouts { pub async fn find_optional_by_merchant_id_payout_id( conn: &PgPooledConn, merchant_id: &common_utils::id_type::MerchantId, - payout_id: &str, + payout_id: &common_utils::id_type::PayoutId, ) -> StorageResult<Option<Self>> { generics::generic_find_one_optional::<<Self as HasTable>::Table, _, _>( conn, @@ -96,7 +96,7 @@ impl Payouts { pub async fn get_total_count_of_payouts( conn: &PgPooledConn, merchant_id: &common_utils::id_type::MerchantId, - active_payout_ids: &[String], + active_payout_ids: &[common_utils::id_type::PayoutId], connector: Option<Vec<String>>, currency: Option<Vec<enums::Currency>>, status: Option<Vec<enums::PayoutStatus>>, @@ -106,7 +106,7 @@ impl Payouts { .inner_join(payout_attempt::table.on(payout_attempt::dsl::payout_id.eq(dsl::payout_id))) .count() .filter(dsl::merchant_id.eq(merchant_id.to_owned())) - .filter(dsl::payout_id.eq_any(active_payout_ids.to_owned())) + .filter(dsl::payout_id.eq_any(active_payout_ids.to_vec())) .into_boxed(); if let Some(connector) = connector { diff --git a/crates/diesel_models/src/schema.rs b/crates/diesel_models/src/schema.rs index e303dfc553f..1629780458c 100644 --- a/crates/diesel_models/src/schema.rs +++ b/crates/diesel_models/src/schema.rs @@ -1151,7 +1151,7 @@ diesel::table! { use diesel::sql_types::; use crate::enums::diesel_exports::; - payout_attempt (payout_attempt_id) { + payout_attempt (merchant_id, payout_attempt_id) { #[max_length = 64] payout_attempt_id -> Varchar, #[max_length = 64] @@ -1188,6 +1188,8 @@ diesel::table! { #[max_length = 1024] unified_message -> Nullable<Varchar>, additional_payout_method_data -> Nullable<Jsonb>, + #[max_length = 255] + merchant_order_reference_id -> Nullable<Varchar>, } } @@ -1195,7 +1197,7 @@ diesel::table! { use diesel::sql_types::; use crate::enums::diesel_exports::; - payouts (payout_id) { + payouts (merchant_id, payout_id) { #[max_length = 64] payout_id -> Varchar, #[max_length = 64] diff --git a/crates/diesel_models/src/schema_v2.rs b/crates/diesel_models/src/schema_v2.rs index 9ba5cdfaff6..c931cec977a 100644 --- a/crates/diesel_models/src/schema_v2.rs +++ b/crates/diesel_models/src/schema_v2.rs @@ -1090,7 +1090,7 @@ diesel::table! { use diesel::sql_types::; use crate::enums::diesel_exports::; - payout_attempt (payout_attempt_id) { + payout_attempt (merchant_id, payout_attempt_id) { #[max_length = 64] payout_attempt_id -> Varchar, #[max_length = 64] @@ -1127,6 +1127,8 @@ diesel::table! { #[max_length = 1024] unified_message -> Nullable<Varchar>, additional_payout_method_data -> Nullable<Jsonb>, + #[max_length = 255] + merchant_order_reference_id -> Nullable<Varchar>, } } @@ -1134,7 +1136,7 @@ diesel::table! { use diesel::sql_types::; use crate::enums::diesel_exports::; - payouts (payout_id) { + payouts (merchant_id, payout_id) { #[max_length = 64] payout_id -> Varchar, #[max_length = 64] diff --git a/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs b/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs index 8eec0abb9fc..8f4d667711b 100644 --- a/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs @@ -5351,7 +5351,7 @@ impl<F> TryFrom<&AdyenRouterData<&PayoutsRouterData<F>>> for AdyenPayoutCreateRe }, merchant_account, payment_data: PayoutPaymentMethodData::PayoutWalletData(payout_wallet), - reference: item.router_data.request.payout_id.to_owned(), + reference: item.router_data.connector_request_reference_id.clone(), shopper_reference: item.router_data.merchant_id.get_string_repr().to_owned(), shopper_email: customer_email, shopper_name: ShopperName { diff --git a/crates/hyperswitch_connectors/src/connectors/adyenplatform/transformers/payouts.rs b/crates/hyperswitch_connectors/src/connectors/adyenplatform/transformers/payouts.rs index 7262ec9f3ff..82c9afadeed 100644 --- a/crates/hyperswitch_connectors/src/connectors/adyenplatform/transformers/payouts.rs +++ b/crates/hyperswitch_connectors/src/connectors/adyenplatform/transformers/payouts.rs @@ -361,7 +361,7 @@ impl<F> TryFrom<&AdyenPlatformRouterData<&types::PayoutsRouterData<F>>> for Adye counterparty, priority, reference: item.router_data.connector_request_reference_id.clone(), - reference_for_beneficiary: request.payout_id.clone(), + reference_for_beneficiary: item.router_data.connector_request_reference_id.clone(), description: item.router_data.description.clone(), }) } diff --git a/crates/hyperswitch_connectors/src/connectors/cybersource/transformers.rs b/crates/hyperswitch_connectors/src/connectors/cybersource/transformers.rs index 6b4101a15d2..09b468c3caf 100644 --- a/crates/hyperswitch_connectors/src/connectors/cybersource/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/cybersource/transformers.rs @@ -3958,7 +3958,7 @@ impl TryFrom<&CybersourceRouterData<&PayoutsRouterData<PoFulfill>>> match payout_type { enums::PayoutType::Card => { let client_reference_information = ClientReferenceInformation { - code: Some(item.router_data.request.payout_id.clone()), + code: Some(item.router_data.connector_request_reference_id.clone()), }; let order_information = OrderInformation { @@ -3974,7 +3974,7 @@ impl TryFrom<&CybersourceRouterData<&PayoutsRouterData<PoFulfill>>> CybersourceRecipientInfo::try_from((billing_address, phone_address))?; let sender_information = CybersourceSenderInfo { - reference_number: item.router_data.request.payout_id.clone(), + reference_number: item.router_data.connector_request_reference_id.clone(), account: CybersourceAccountInfo { funds_source: CybersourcePayoutFundSourceType::Disbursement, }, diff --git a/crates/hyperswitch_connectors/src/connectors/nomupay/transformers.rs b/crates/hyperswitch_connectors/src/connectors/nomupay/transformers.rs index 9a1a50e8642..3eab923ff16 100644 --- a/crates/hyperswitch_connectors/src/connectors/nomupay/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/nomupay/transformers.rs @@ -385,7 +385,7 @@ impl<F> TryFrom<&PayoutsRouterData<F>> for OnboardSubAccountRequest { match payout_type { Some(common_enums::PayoutType::Bank) => Ok(Self { account_id: nomupay_auth_type.eid, - client_sub_account_id: Secret::new(request.payout_id), + client_sub_account_id: Secret::new(item.connector_request_reference_id.clone()), profile, }), _ => Err(errors::ConnectorError::NotImplemented( @@ -498,7 +498,7 @@ impl<F> TryFrom<(&PayoutsRouterData<F>, FloatMajorUnit)> for NomupayPaymentReque Ok(Self { source_id: nomupay_auth_type.eid, destination_id: Secret::new(destination), - payment_reference: item.request.clone().payout_id, + payment_reference: item.connector_request_reference_id.clone(), amount, currency_code: item.request.destination_currency, purpose: PURPOSE_OF_PAYMENT_IS_OTHER.to_string(), diff --git a/crates/hyperswitch_connectors/src/connectors/paypal/transformers.rs b/crates/hyperswitch_connectors/src/connectors/paypal/transformers.rs index 6b56ccea208..18c7ac02e71 100644 --- a/crates/hyperswitch_connectors/src/connectors/paypal/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/paypal/transformers.rs @@ -2309,7 +2309,7 @@ impl TryFrom<&PaypalRouterData<&PayoutsRouterData<PoFulfill>>> for PaypalFulfill let item_data = PaypalPayoutItem::try_from(item)?; Ok(Self { sender_batch_header: PayoutBatchHeader { - sender_batch_id: item.router_data.request.payout_id.to_owned(), + sender_batch_id: item.router_data.connector_request_reference_id.to_owned(), }, items: vec![item_data], }) diff --git a/crates/hyperswitch_connectors/src/connectors/stripe/transformers/connect.rs b/crates/hyperswitch_connectors/src/connectors/stripe/transformers/connect.rs index bb8d4509dac..321aad76551 100644 --- a/crates/hyperswitch_connectors/src/connectors/stripe/transformers/connect.rs +++ b/crates/hyperswitch_connectors/src/connectors/stripe/transformers/connect.rs @@ -216,7 +216,7 @@ impl<F> TryFrom<&PayoutsRouterData<F>> for StripeConnectPayoutCreateRequest { amount: request.amount, currency: request.destination_currency, destination: connector_customer_id, - transfer_group: request.payout_id, + transfer_group: item.connector_request_reference_id.clone(), }) } } diff --git a/crates/hyperswitch_connectors/src/connectors/wise/transformers.rs b/crates/hyperswitch_connectors/src/connectors/wise/transformers.rs index 1a9ff7bf89f..f844e15a488 100644 --- a/crates/hyperswitch_connectors/src/connectors/wise/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/wise/transformers.rs @@ -510,7 +510,7 @@ impl<F> TryFrom<&PayoutsRouterData<F>> for WisePayoutCreateRequest { Ok(Self { target_account, quote_uuid, - customer_transaction_id: request.payout_id, + customer_transaction_id: request.payout_id.get_string_repr().to_string(), details: wise_transfer_details, }) } diff --git a/crates/hyperswitch_domain_models/src/errors/api_error_response.rs b/crates/hyperswitch_domain_models/src/errors/api_error_response.rs index 21accfa22c5..2924093da3a 100644 --- a/crates/hyperswitch_domain_models/src/errors/api_error_response.rs +++ b/crates/hyperswitch_domain_models/src/errors/api_error_response.rs @@ -79,8 +79,10 @@ pub enum ApiErrorResponse { DuplicatePayment { payment_id: common_utils::id_type::PaymentId, }, - #[error(error_type = ErrorType::DuplicateRequest, code = "HE_01", message = "The payout with the specified payout_id '{payout_id}' already exists in our records")] - DuplicatePayout { payout_id: String }, + #[error(error_type = ErrorType::DuplicateRequest, code = "HE_01", message = "The payout with the specified payout_id '{payout_id:?}' already exists in our records")] + DuplicatePayout { + payout_id: common_utils::id_type::PayoutId, + }, #[error(error_type = ErrorType::DuplicateRequest, code = "HE_01", message = "The config with the specified key already exists in our records")] DuplicateConfig, #[error(error_type = ErrorType::ObjectNotFound, code = "HE_02", message = "Refund does not exist in our records")] @@ -403,7 +405,7 @@ impl ErrorSwitch<api_models::errors::types::ApiErrorResponse> for ApiErrorRespon AER::BadRequest(ApiError::new("HE", 1, "The payment with the specified payment_id already exists in our records", Some(Extra {reason: Some(format!("{payment_id:?} already exists")), ..Default::default()}))) } Self::DuplicatePayout { payout_id } => { - AER::BadRequest(ApiError::new("HE", 1, format!("The payout with the specified payout_id '{payout_id}' already exists in our records"), None)) + AER::BadRequest(ApiError::new("HE", 1, format!("The payout with the specified payout_id '{payout_id:?}' already exists in our records"), None)) } Self::DuplicateConfig => { AER::BadRequest(ApiError::new("HE", 1, "The config with the specified key already exists in our records", None)) diff --git a/crates/hyperswitch_domain_models/src/payouts.rs b/crates/hyperswitch_domain_models/src/payouts.rs index 8c6d751ebec..9a40dc119c0 100644 --- a/crates/hyperswitch_domain_models/src/payouts.rs +++ b/crates/hyperswitch_domain_models/src/payouts.rs @@ -7,7 +7,7 @@ use common_utils::{consts, id_type}; use time::PrimitiveDateTime; pub enum PayoutFetchConstraints { - Single { payout_id: String }, + Single { payout_id: id_type::PayoutId }, List(Box<PayoutListParams>), } @@ -21,10 +21,11 @@ pub struct PayoutListParams { pub payout_method: Option<Vec<common_enums::PayoutType>>, pub profile_id: Option<id_type::ProfileId>, pub customer_id: Option<id_type::CustomerId>, - pub starting_after_id: Option<String>, - pub ending_before_id: Option<String>, + pub starting_after_id: Option<id_type::PayoutId>, + pub ending_before_id: Option<id_type::PayoutId>, pub entity_type: Option<common_enums::PayoutEntityType>, pub limit: Option<u32>, + pub merchant_order_reference_id: Option<String>, } impl From<api_models::payouts::PayoutListConstraints> for PayoutFetchConstraints { @@ -44,6 +45,7 @@ impl From<api_models::payouts::PayoutListConstraints> for PayoutFetchConstraints starting_after_id: value.starting_after, ending_before_id: value.ending_before, entity_type: None, + merchant_order_reference_id: None, limit: Some(std::cmp::min( value.limit, consts::PAYOUTS_LIST_MAX_LIMIT_GET, @@ -67,6 +69,7 @@ impl From<common_utils::types::TimeRange> for PayoutFetchConstraints { starting_after_id: None, ending_before_id: None, entity_type: None, + merchant_order_reference_id: None, limit: None, })) } @@ -90,6 +93,7 @@ impl From<api_models::payouts::PayoutListFilterConstraints> for PayoutFetchConst starting_after_id: None, ending_before_id: None, entity_type: value.entity_type, + merchant_order_reference_id: value.merchant_order_reference_id, limit: Some(std::cmp::min( value.limit, consts::PAYOUTS_LIST_MAX_LIMIT_POST, diff --git a/crates/hyperswitch_domain_models/src/payouts/payout_attempt.rs b/crates/hyperswitch_domain_models/src/payouts/payout_attempt.rs index dcb61bddc97..b6293faa841 100644 --- a/crates/hyperswitch_domain_models/src/payouts/payout_attempt.rs +++ b/crates/hyperswitch_domain_models/src/payouts/payout_attempt.rs @@ -42,6 +42,13 @@ pub trait PayoutAttemptInterface { _storage_scheme: MerchantStorageScheme, ) -> error_stack::Result<PayoutAttempt, Self::Error>; + async fn find_payout_attempt_by_merchant_id_merchant_order_reference_id( + &self, + _merchant_id: &id_type::MerchantId, + _merchant_order_reference_id: &str, + _storage_scheme: MerchantStorageScheme, + ) -> error_stack::Result<PayoutAttempt, Self::Error>; + async fn get_filters_for_payouts( &self, _payout: &[Payouts], @@ -61,7 +68,7 @@ pub struct PayoutListFilters { #[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)] pub struct PayoutAttempt { pub payout_attempt_id: String, - pub payout_id: String, + pub payout_id: id_type::PayoutId, pub customer_id: Option<id_type::CustomerId>, pub merchant_id: id_type::MerchantId, pub address_id: Option<String>, @@ -84,12 +91,13 @@ pub struct PayoutAttempt { pub unified_code: Option<UnifiedCode>, pub unified_message: Option<UnifiedMessage>, pub additional_payout_method_data: Option<payout_method_utils::AdditionalPayoutMethodData>, + pub merchant_order_reference_id: Option<String>, } #[derive(Clone, Debug, PartialEq)] pub struct PayoutAttemptNew { pub payout_attempt_id: String, - pub payout_id: String, + pub payout_id: id_type::PayoutId, pub customer_id: Option<id_type::CustomerId>, pub merchant_id: id_type::MerchantId, pub address_id: Option<String>, @@ -110,6 +118,7 @@ pub struct PayoutAttemptNew { pub unified_code: Option<UnifiedCode>, pub unified_message: Option<UnifiedMessage>, pub additional_payout_method_data: Option<payout_method_utils::AdditionalPayoutMethodData>, + pub merchant_order_reference_id: Option<String>, } #[derive(Debug, Clone)] diff --git a/crates/hyperswitch_domain_models/src/payouts/payouts.rs b/crates/hyperswitch_domain_models/src/payouts/payouts.rs index 7c34b3c26df..1d41a5f9a32 100644 --- a/crates/hyperswitch_domain_models/src/payouts/payouts.rs +++ b/crates/hyperswitch_domain_models/src/payouts/payouts.rs @@ -20,7 +20,7 @@ pub trait PayoutsInterface { async fn find_payout_by_merchant_id_payout_id( &self, _merchant_id: &id_type::MerchantId, - _payout_id: &str, + _payout_id: &id_type::PayoutId, _storage_scheme: MerchantStorageScheme, ) -> error_stack::Result<Payouts, Self::Error>; @@ -35,7 +35,7 @@ pub trait PayoutsInterface { async fn find_optional_payout_by_merchant_id_payout_id( &self, _merchant_id: &id_type::MerchantId, - _payout_id: &str, + _payout_id: &id_type::PayoutId, _storage_scheme: MerchantStorageScheme, ) -> error_stack::Result<Option<Payouts>, Self::Error>; @@ -76,7 +76,7 @@ pub trait PayoutsInterface { async fn get_total_count_of_filtered_payouts( &self, _merchant_id: &id_type::MerchantId, - _active_payout_ids: &[String], + _active_payout_ids: &[id_type::PayoutId], _connector: Option<Vec<api_models::enums::PayoutConnectors>>, _currency: Option<Vec<storage_enums::Currency>>, _status: Option<Vec<storage_enums::PayoutStatus>>, @@ -88,12 +88,12 @@ pub trait PayoutsInterface { &self, _merchant_id: &id_type::MerchantId, _constraints: &PayoutFetchConstraints, - ) -> error_stack::Result<Vec<String>, Self::Error>; + ) -> error_stack::Result<Vec<id_type::PayoutId>, Self::Error>; } #[derive(Clone, Debug, Eq, PartialEq)] pub struct Payouts { - pub payout_id: String, + pub payout_id: id_type::PayoutId, pub merchant_id: id_type::MerchantId, pub customer_id: Option<id_type::CustomerId>, pub address_id: Option<String>, @@ -121,7 +121,7 @@ pub struct Payouts { #[derive(Clone, Debug, Eq, PartialEq)] pub struct PayoutsNew { - pub payout_id: String, + pub payout_id: id_type::PayoutId, pub merchant_id: id_type::MerchantId, pub customer_id: Option<id_type::CustomerId>, pub address_id: Option<String>, diff --git a/crates/hyperswitch_domain_models/src/router_request_types.rs b/crates/hyperswitch_domain_models/src/router_request_types.rs index e811b872c8c..c7987122ead 100644 --- a/crates/hyperswitch_domain_models/src/router_request_types.rs +++ b/crates/hyperswitch_domain_models/src/router_request_types.rs @@ -890,7 +890,7 @@ pub struct UploadFileRequestData { #[cfg(feature = "payouts")] #[derive(Debug, Clone)] pub struct PayoutsData { - pub payout_id: String, + pub payout_id: id_type::PayoutId, pub amount: i64, pub connector_payout_id: Option<String>, pub destination_currency: storage_enums::Currency, diff --git a/crates/router/src/compatibility/stripe/errors.rs b/crates/router/src/compatibility/stripe/errors.rs index 58f707b2db6..83f7fe69053 100644 --- a/crates/router/src/compatibility/stripe/errors.rs +++ b/crates/router/src/compatibility/stripe/errors.rs @@ -1,4 +1,4 @@ -use common_utils::errors::ErrorSwitch; +use common_utils::{errors::ErrorSwitch, id_type}; use hyperswitch_domain_models::errors::api_error_response as errors; use crate::core::errors::CustomersErrorResponse; @@ -133,7 +133,7 @@ pub enum StripeErrorCode { EventNotFound, #[error(error_type = StripeErrorType::InvalidRequestError, code = "token_already_used", message = "Duplicate payout request")] - DuplicatePayout { payout_id: String }, + DuplicatePayout { payout_id: id_type::PayoutId }, #[error(error_type = StripeErrorType::InvalidRequestError, code = "parameter_missing", message = "Return url is not available")] ReturnUrlUnavailable, @@ -209,9 +209,7 @@ pub enum StripeErrorCode { PaymentIntentMandateInvalid { message: String }, #[error(error_type = StripeErrorType::InvalidRequestError, code = "", message = "The payment with the specified payment_id already exists in our records.")] - DuplicatePayment { - payment_id: common_utils::id_type::PaymentId, - }, + DuplicatePayment { payment_id: id_type::PaymentId }, #[error(error_type = StripeErrorType::ConnectorError, code = "", message = "{code}: {message}")] ExternalConnectorError { diff --git a/crates/router/src/compatibility/stripe/webhooks.rs b/crates/router/src/compatibility/stripe/webhooks.rs index f5dde401b35..3bd0f83b7db 100644 --- a/crates/router/src/compatibility/stripe/webhooks.rs +++ b/crates/router/src/compatibility/stripe/webhooks.rs @@ -4,9 +4,12 @@ use api_models::{ enums::{Currency, DisputeStatus, MandateStatus}, webhooks::{self as api}, }; -#[cfg(feature = "payouts")] -use common_utils::pii::{self, Email}; use common_utils::{crypto::SignMessage, date_time, ext_traits::Encode}; +#[cfg(feature = "payouts")] +use common_utils::{ + id_type, + pii::{self, Email}, +}; use error_stack::ResultExt; use router_env::logger; use serde::Serialize; @@ -94,7 +97,7 @@ pub struct StripeDisputeResponse { pub id: String, pub amount: String, pub currency: Currency, - pub payment_intent: common_utils::id_type::PaymentId, + pub payment_intent: id_type::PaymentId, pub reason: Option<String>, pub status: StripeDisputeStatus, } @@ -110,7 +113,7 @@ pub struct StripeMandateResponse { #[cfg(feature = "payouts")] #[derive(Clone, Serialize, Debug)] pub struct StripePayoutResponse { - pub id: String, + pub id: id_type::PayoutId, pub amount: i64, pub currency: String, pub payout_type: Option<common_enums::PayoutType>, diff --git a/crates/router/src/core/payments/routing.rs b/crates/router/src/core/payments/routing.rs index 4cc667bdc8a..7126ed9617e 100644 --- a/crates/router/src/core/payments/routing.rs +++ b/crates/router/src/core/payments/routing.rs @@ -483,9 +483,11 @@ pub async fn perform_static_routing_v1( .get_string_repr() .to_string(), #[cfg(feature = "payouts")] - routing::TransactionData::Payout(payout_data) => { - payout_data.payout_attempt.payout_id.clone() - } + routing::TransactionData::Payout(payout_data) => payout_data + .payout_attempt + .payout_id + .get_string_repr() + .to_string(), }; let routing_events_wrapper = utils::RoutingEventsWrapper::new( diff --git a/crates/router/src/core/payout_link.rs b/crates/router/src/core/payout_link.rs index 8c234889630..1d224ffbd79 100644 --- a/crates/router/src/core/payout_link.rs +++ b/crates/router/src/core/payout_link.rs @@ -22,6 +22,7 @@ use crate::{ routes::{app::StorageInterface, SessionState}, services, types::{api, domain, transformers::ForeignFrom}, + utils::get_payout_attempt_id, }; #[cfg(feature = "v2")] @@ -56,7 +57,7 @@ pub async fn initiate_payout_link( let payout_attempt = db .find_payout_attempt_by_merchant_id_payout_attempt_id( merchant_id, - &format!("{}_{}", payout.payout_id, payout.attempt_count), + &get_payout_attempt_id(payout.payout_id.get_string_repr(), payout.attempt_count), merchant_context.get_merchant_account().storage_scheme, ) .await @@ -146,13 +147,11 @@ pub async fn initiate_payout_link( .await .change_context(errors::ApiErrorResponse::InvalidRequestData { message: format!( - "Customer [{}] not found for link_id - {}", - payout_link.primary_reference, payout_link.link_id + "Customer [{:?}] not found for link_id - {}", + customer_id, payout_link.link_id ), }) - .attach_printable_lazy(\|\| { - format!("customer [{}] not found", payout_link.primary_reference) - })?; + .attach_printable_lazy(\|\| format!("customer [{:?}] not found", customer_id))?; let address = payout .address_id .as_ref() @@ -169,7 +168,7 @@ pub async fn initiate_payout_link( .change_context(errors::ApiErrorResponse::InternalServerError) .attach_printable_lazy(\|\| { format!( - "Failed while fetching address [id - {:?}] for payout [id - {}]", + "Failed while fetching address [id - {:?}] for payout [id - {:?}]", payout.address_id, payout.payout_id ) })?; @@ -227,7 +226,7 @@ pub async fn initiate_payout_link( ), client_secret: link_data.client_secret.clone(), payout_link_id: payout_link.link_id, - payout_id: payout_link.primary_reference, + payout_id: payout_link.primary_reference.clone(), customer_id: customer.customer_id, session_expiry: payout_link.expiry, return_url: payout_link @@ -284,7 +283,7 @@ pub async fn initiate_payout_link( .await?; let js_data = payouts::PayoutLinkStatusDetails { payout_link_id: payout_link.link_id, - payout_id: payout_link.primary_reference, + payout_id: payout_link.primary_reference.clone(), customer_id: link_data.customer_id, session_expiry: payout_link.expiry, return_url: payout_link diff --git a/crates/router/src/core/payouts.rs b/crates/router/src/core/payouts.rs index 495bea84eac..3cc996bd9a6 100644 --- a/crates/router/src/core/payouts.rs +++ b/crates/router/src/core/payouts.rs @@ -17,7 +17,7 @@ use common_enums::PayoutRetryType; use common_utils::{ consts, ext_traits::{AsyncExt, ValueExt}, - id_type::CustomerId, + id_type::{self, GenerateId}, link_utils::{GenericLinkStatus, GenericLinkUiConfig, PayoutLinkData, PayoutLinkStatus}, types::{MinorUnit, UnifiedCode, UnifiedMessage}, }; @@ -73,7 +73,7 @@ pub struct PayoutData { pub payouts: storage::Payouts, pub payout_attempt: storage::PayoutAttempt, pub payout_method_data: Option<payouts::PayoutMethodData>, - pub profile_id: common_utils::id_type::ProfileId, + pub profile_id: id_type::ProfileId, pub should_terminate: bool, pub payout_link: Option<PayoutLink>, pub current_locale: String, @@ -451,7 +451,7 @@ pub async fn payouts_update_core( if helpers::is_payout_terminal_state(status) \|\| helpers::is_payout_initiated(status) { return Err(report!(errors::ApiErrorResponse::InvalidRequestData { message: format!( - "Payout {} cannot be updated for status {}", + "Payout {:?} cannot be updated for status {}", payout_id, status ), })); @@ -506,7 +506,7 @@ pub async fn payouts_update_core( pub async fn payouts_retrieve_core( state: SessionState, merchant_context: domain::MerchantContext, - profile_id: Option<common_utils::id_type::ProfileId>, + profile_id: Option<id_type::ProfileId>, req: payouts::PayoutRetrieveRequest, ) -> RouterResponse<payouts::PayoutCreateResponse> { let mut payout_data = Box::pin(make_payout_data( @@ -568,7 +568,7 @@ pub async fn payouts_cancel_core( if helpers::is_payout_terminal_state(status) { return Err(report!(errors::ApiErrorResponse::InvalidRequestData { message: format!( - "Payout {} cannot be cancelled for status {}", + "Payout {:?} cannot be cancelled for status {}", payout_attempt.payout_id, status ), })); @@ -663,7 +663,7 @@ pub async fn payouts_fulfill_core( { return Err(report!(errors::ApiErrorResponse::InvalidRequestData { message: format!( - "Payout {} cannot be fulfilled for status {}", + "Payout {:?} cannot be fulfilled for status {}", payout_attempt.payout_id, status ), })); @@ -733,7 +733,7 @@ pub async fn payouts_fulfill_core( pub async fn payouts_list_core( _state: SessionState, _merchant_context: domain::MerchantContext, - _profile_id_list: Option<Vec<common_utils::id_type::ProfileId>>, + _profile_id_list: Option<Vec<id_type::ProfileId>>, _constraints: payouts::PayoutListConstraints, ) -> RouterResponse<payouts::PayoutListResponse> { todo!() @@ -743,7 +743,7 @@ pub async fn payouts_list_core( pub async fn payouts_list_core( state: SessionState, merchant_context: domain::MerchantContext, - profile_id_list: Option<Vec<common_utils::id_type::ProfileId>>, + profile_id_list: Option<Vec<id_type::ProfileId>>, constraints: payouts::PayoutListConstraints, ) -> RouterResponse<payouts::PayoutListResponse> { validator::validate_payout_list_request(&constraints)?; @@ -765,7 +765,10 @@ pub async fn payouts_list_core( match db .find_payout_attempt_by_merchant_id_payout_attempt_id( merchant_id, - &utils::get_payout_attempt_id(payout.payout_id.clone(), payout.attempt_count), + &utils::get_payout_attempt_id( + payout.payout_id.get_string_repr(), + payout.attempt_count, + ), storage_enums::MerchantStorageScheme::PostgresOnly, ) .await @@ -795,7 +798,7 @@ pub async fn payouts_list_core( }; let payout_id_as_payment_id_type = - common_utils::id_type::PaymentId::wrap(payout.payout_id.clone()) + id_type::PaymentId::wrap(payout.payout_id.get_string_repr().to_string()) .change_context(errors::ApiErrorResponse::InvalidRequestData { message: "payout_id contains invalid data".to_string(), }) @@ -862,7 +865,7 @@ pub async fn payouts_list_core( pub async fn payouts_filtered_list_core( state: SessionState, merchant_context: domain::MerchantContext, - profile_id_list: Option<Vec<common_utils::id_type::ProfileId>>, + profile_id_list: Option<Vec<id_type::ProfileId>>, filters: payouts::PayoutListFilterConstraints, ) -> RouterResponse<payouts::PayoutListResponse> { let limit = &filters.limit; @@ -976,7 +979,7 @@ pub async fn payouts_filtered_list_core( pub async fn payouts_list_available_filters_core( state: SessionState, merchant_context: domain::MerchantContext, - profile_id_list: Option<Vec<common_utils::id_type::ProfileId>>, + profile_id_list: Option<Vec<id_type::ProfileId>>, time_range: common_utils::types::TimeRange, ) -> RouterResponse<api::PayoutListFilters> { let db = state.store.as_ref(); @@ -2540,6 +2543,7 @@ pub async fn response_handler( let response = api::PayoutCreateResponse { payout_id: payouts.payout_id.to_owned(), merchant_id: merchant_context.get_merchant_account().get_id().to_owned(), + merchant_order_reference_id: payout_attempt.merchant_order_reference_id.clone(), amount: payouts.amount, currency: payouts.destination_currency.to_owned(), connector: payout_attempt.connector, @@ -2615,8 +2619,8 @@ pub async fn payout_create_db_entries( state: &SessionState, merchant_context: &domain::MerchantContext, req: &payouts::PayoutCreateRequest, - payout_id: &String, - profile_id: &common_utils::id_type::ProfileId, + payout_id: &id_type::PayoutId, + profile_id: &id_type::ProfileId, stored_payout_method_data: Option<&payouts::PayoutMethodData>, locale: &str, customer: Option<&domain::Customer>, @@ -2655,12 +2659,13 @@ pub async fn payout_create_db_entries( // We have to do this because the function that is being used to create / get address is from payments // which expects a payment_id - let payout_id_as_payment_id_type = - common_utils::id_type::PaymentId::try_from(std::borrow::Cow::Owned(payout_id.to_string())) - .change_context(errors::ApiErrorResponse::InvalidRequestData { - message: "payout_id contains invalid data".to_string(), - }) - .attach_printable("Error converting payout_id to PaymentId type")?; + let payout_id_as_payment_id_type = id_type::PaymentId::try_from(std::borrow::Cow::Owned( + payout_id.get_string_repr().to_string(), + )) + .change_context(errors::ApiErrorResponse::InvalidRequestData { + message: "payout_id contains invalid data".to_string(), + }) + .attach_printable("Error converting payout_id to PaymentId type")?; // Get or create address let billing_address = payment_helpers::create_or_find_address_for_payment_by_request( @@ -2696,7 +2701,7 @@ pub async fn payout_create_db_entries( let client_secret = utils::generate_id( consts::ID_LENGTH, - format!("payout_{payout_id}_secret").as_str(), + format!("payout_{payout_id:?}_secret").as_str(), ); let amount = MinorUnit::from(req.amount.unwrap_or(api::Amount::Zero)); let status = if req.payout_method_data.is_some() @@ -2712,7 +2717,7 @@ pub async fn payout_create_db_entries( }; let payouts_req = storage::PayoutsNew { - payout_id: payout_id.to_string(), + payout_id: payout_id.clone(), merchant_id: merchant_id.to_owned(), customer_id: customer_id.to_owned(), address_id: address_id.to_owned(), @@ -2746,11 +2751,11 @@ pub async fn payout_create_db_entries( ) .await .to_duplicate_response(errors::ApiErrorResponse::DuplicatePayout { - payout_id: payout_id.to_owned(), + payout_id: payout_id.clone(), }) .attach_printable("Error inserting payouts in db")?; // Make payout_attempt entry - let payout_attempt_id = utils::get_payout_attempt_id(payout_id, 1); + let payout_attempt_id = utils::get_payout_attempt_id(payout_id.get_string_repr(), 1); let additional_pm_data_value = req .payout_method_data @@ -2764,9 +2769,10 @@ pub async fn payout_create_db_entries( let payout_attempt_req = storage::PayoutAttemptNew { payout_attempt_id: payout_attempt_id.to_string(), - payout_id: payout_id.to_owned(), + payout_id: payout_id.clone(), additional_payout_method_data: additional_pm_data_value, merchant_id: merchant_id.to_owned(), + merchant_order_reference_id: req.merchant_order_reference_id.clone(), status, business_country: req.business_country.to_owned(), business_label: req.business_label.to_owned(), @@ -2794,7 +2800,7 @@ pub async fn payout_create_db_entries( ) .await .to_duplicate_response(errors::ApiErrorResponse::DuplicatePayout { - payout_id: payout_id.to_owned(), + payout_id: payout_id.clone(), }) .attach_printable("Error inserting payout_attempt in db")?; @@ -2823,7 +2829,7 @@ pub async fn payout_create_db_entries( pub async fn make_payout_data( _state: &SessionState, _merchant_context: &domain::MerchantContext, - _auth_profile_id: Option<common_utils::id_type::ProfileId>, + _auth_profile_id: Option<id_type::ProfileId>, _req: &payouts::PayoutRequest, locale: &str, ) -> RouterResult<PayoutData> { @@ -2834,7 +2840,7 @@ pub async fn make_payout_data( pub async fn make_payout_data( state: &SessionState, merchant_context: &domain::MerchantContext, - auth_profile_id: Option<common_utils::id_type::ProfileId>, + auth_profile_id: Option<id_type::ProfileId>, req: &payouts::PayoutRequest, locale: &str, ) -> RouterResult<PayoutData> { @@ -2842,7 +2848,9 @@ pub async fn make_payout_data( let merchant_id = merchant_context.get_merchant_account().get_id(); let payout_id = match req { payouts::PayoutRequest::PayoutActionRequest(r) => r.payout_id.clone(), - payouts::PayoutRequest::PayoutCreateRequest(r) => r.payout_id.clone().unwrap_or_default(), + payouts::PayoutRequest::PayoutCreateRequest(r) => { + r.payout_id.clone().unwrap_or(id_type::PayoutId::generate()) + } payouts::PayoutRequest::PayoutRetrieveRequest(r) => r.payout_id.clone(), }; @@ -2856,7 +2864,8 @@ pub async fn make_payout_data( .to_not_found_response(errors::ApiErrorResponse::PayoutNotFound)?; core_utils::validate_profile_id_from_auth_layer(auth_profile_id, &payouts)?; - let payout_attempt_id = utils::get_payout_attempt_id(payout_id, payouts.attempt_count); + let payout_attempt_id = + utils::get_payout_attempt_id(payouts.payout_id.get_string_repr(), payouts.attempt_count); let mut payout_attempt = db .find_payout_attempt_by_merchant_id_payout_attempt_id( @@ -2871,9 +2880,9 @@ pub async fn make_payout_data( // We have to do this because the function that is being used to create / get address is from payments // which expects a payment_id - let payout_id_as_payment_id_type = common_utils::id_type::PaymentId::try_from( - std::borrow::Cow::Owned(payouts.payout_id.clone()), - ) + let payout_id_as_payment_id_type = id_type::PaymentId::try_from(std::borrow::Cow::Owned( + payouts.payout_id.get_string_repr().to_string(), + )) .change_context(errors::ApiErrorResponse::InvalidRequestData { message: "payout_id contains invalid data".to_string(), }) @@ -2906,7 +2915,7 @@ pub async fn make_payout_data( .map_err(\|err\| err.change_context(errors::ApiErrorResponse::InternalServerError)) .attach_printable_lazy(\|\| { format!( - "Failed while fetching optional customer [id - {:?}] for payout [id - {}]", + "Failed while fetching optional customer [id - {:?}] for payout [id - {:?}]", customer_id, payout_id ) }) @@ -3079,8 +3088,8 @@ pub async fn add_external_account_addition_task( async fn validate_and_get_business_profile( state: &SessionState, merchant_key_store: &domain::MerchantKeyStore, - profile_id: &common_utils::id_type::ProfileId, - merchant_id: &common_utils::id_type::MerchantId, + profile_id: &id_type::ProfileId, + merchant_id: &id_type::MerchantId, ) -> RouterResult<domain::Profile> { let db = &state.store; let key_manager_state = &state.into(); @@ -3108,10 +3117,10 @@ async fn validate_and_get_business_profile( pub async fn create_payout_link( state: &SessionState, business_profile: &domain::Profile, - customer_id: &CustomerId, - merchant_id: &common_utils::id_type::MerchantId, + customer_id: &id_type::CustomerId, + merchant_id: &id_type::MerchantId, req: &payouts::PayoutCreateRequest, - payout_id: &str, + payout_id: &id_type::PayoutId, locale: &str, ) -> RouterResult<PayoutLink> { let payout_link_config_req = req.payout_link_config.to_owned(); @@ -3175,7 +3184,7 @@ pub async fn create_payout_link( .as_ref() .map_or(default_config.expiry, \|expiry\| expiry); let url = format!( - "{base_url}/payout_link/{}/{payout_id}?locale={}", + "{base_url}/payout_link/{}/{payout_id:?}?locale={}", merchant_id.get_string_repr(), locale ); @@ -3214,7 +3223,7 @@ pub async fn create_payout_link( let data = PayoutLinkData { payout_link_id: payout_link_id.clone(), customer_id: customer_id.clone(), - payout_id: payout_id.to_string(), + payout_id: payout_id.clone(), link, client_secret: Secret::new(client_secret), session_expiry, @@ -3232,7 +3241,7 @@ pub async fn create_payout_link( pub async fn create_payout_link_db_entry( state: &SessionState, - merchant_id: &common_utils::id_type::MerchantId, + merchant_id: &id_type::MerchantId, payout_link_data: &PayoutLinkData, return_url: Option<String>, ) -> RouterResult<PayoutLink> { @@ -3244,7 +3253,7 @@ pub async fn create_payout_link_db_entry( let payout_link = GenericLinkNew { link_id: payout_link_data.payout_link_id.to_string(), - primary_reference: payout_link_data.payout_id.to_string(), + primary_reference: payout_link_data.payout_id.get_string_repr().to_string(), merchant_id: merchant_id.to_owned(), link_type: common_enums::GenericLinkType::PayoutLink, link_status: GenericLinkStatus::PayoutLink(PayoutLinkStatus::Initiated), @@ -3267,9 +3276,9 @@ pub async fn create_payout_link_db_entry( pub async fn get_mca_from_profile_id( state: &SessionState, merchant_context: &domain::MerchantContext, - profile_id: &common_utils::id_type::ProfileId, + profile_id: &id_type::ProfileId, connector_name: &str, - merchant_connector_id: Option<&common_utils::id_type::MerchantConnectorAccountId>, + merchant_connector_id: Option<&id_type::MerchantConnectorAccountId>, ) -> RouterResult<payment_helpers::MerchantConnectorAccountType> { let merchant_connector_account = payment_helpers::get_merchant_connector_account( state, diff --git a/crates/router/src/core/payouts/helpers.rs b/crates/router/src/core/payouts/helpers.rs index 1003ee699f2..9e006ed9ce4 100644 --- a/crates/router/src/core/payouts/helpers.rs +++ b/crates/router/src/core/payouts/helpers.rs @@ -1201,7 +1201,8 @@ pub async fn update_payouts_and_payout_attempt( return Err(report!(errors::ApiErrorResponse::InvalidRequestData { message: format!( "Payout {} cannot be updated for status {}", - payout_id, status + payout_id.get_string_repr(), + status ), })); } @@ -1226,12 +1227,13 @@ pub async fn update_payouts_and_payout_attempt( // We have to do this because the function that is being used to create / get address is from payments // which expects a payment_id - let payout_id_as_payment_id_type = - id_type::PaymentId::try_from(std::borrow::Cow::Owned(payout_id.clone())) - .change_context(errors::ApiErrorResponse::InvalidRequestData { - message: "payout_id contains invalid data".to_string(), - }) - .attach_printable("Error converting payout_id to PaymentId type")?; + let payout_id_as_payment_id_type = id_type::PaymentId::try_from(std::borrow::Cow::Owned( + payout_id.get_string_repr().to_string(), + )) + .change_context(errors::ApiErrorResponse::InvalidRequestData { + message: "payout_id contains invalid data for PaymentId conversion".to_string(), + }) + .attach_printable("Error converting payout_id to PaymentId type")?; // Fetch address details from request and create new or else use existing address that was attached let billing_address = payment_helpers::create_or_find_address_for_payment_by_request( diff --git a/crates/router/src/core/payouts/retry.rs b/crates/router/src/core/payouts/retry.rs index 3b5e93eaf11..30100a580d4 100644 --- a/crates/router/src/core/payouts/retry.rs +++ b/crates/router/src/core/payouts/retry.rs @@ -269,12 +269,18 @@ pub async fn modify_trackers( .change_context(errors::ApiErrorResponse::InternalServerError) .attach_printable("Error updating payouts")?; - let payout_attempt_id = - utils::get_payout_attempt_id(payout_id.to_owned(), payout_data.payouts.attempt_count); + let payout_attempt_id = utils::get_payout_attempt_id( + payout_id.get_string_repr(), + payout_data.payouts.attempt_count, + ); let payout_attempt_req = storage::PayoutAttemptNew { payout_attempt_id: payout_attempt_id.to_string(), payout_id: payout_id.to_owned(), + merchant_order_reference_id: payout_data + .payout_attempt + .merchant_order_reference_id + .clone(), customer_id: payout_data.payout_attempt.customer_id.to_owned(), connector: Some(connector.connector_name.to_string()), merchant_id: payout_data.payout_attempt.merchant_id.to_owned(), diff --git a/crates/router/src/core/payouts/transformers.rs b/crates/router/src/core/payouts/transformers.rs index a1c92ec3b29..7040559d9f4 100644 --- a/crates/router/src/core/payouts/transformers.rs +++ b/crates/router/src/core/payouts/transformers.rs @@ -69,6 +69,7 @@ impl payout_id: payout.payout_id, merchant_id: payout.merchant_id, merchant_connector_id: payout_attempt.merchant_connector_id, + merchant_order_reference_id: payout_attempt.merchant_order_reference_id.clone(), amount: payout.amount, currency: payout.destination_currency, connector: payout_attempt.connector, diff --git a/crates/router/src/core/payouts/validator.rs b/crates/router/src/core/payouts/validator.rs index 35c4599dbc2..1af3f4d2cb5 100644 --- a/crates/router/src/core/payouts/validator.rs +++ b/crates/router/src/core/payouts/validator.rs @@ -3,7 +3,10 @@ use std::collections::HashSet; use actix_web::http::header; #[cfg(feature = "olap")] use common_utils::errors::CustomResult; -use common_utils::validation::validate_domain_against_allowed_domains; +use common_utils::{ + id_type::{self, GenerateId}, + validation::validate_domain_against_allowed_domains, +}; use diesel_models::generic_link::PayoutLink; use error_stack::{report, ResultExt}; use hyperswitch_domain_models::payment_methods::PaymentMethod; @@ -29,8 +32,8 @@ use crate::{ #[instrument(skip(db))] pub async fn validate_uniqueness_of_payout_id_against_merchant_id( db: &dyn StorageInterface, - payout_id: &str, - merchant_id: &common_utils::id_type::MerchantId, + payout_id: &id_type::PayoutId, + merchant_id: &id_type::MerchantId, storage_scheme: storage::enums::MerchantStorageScheme, ) -> RouterResult<Option<storage::Payouts>> { let maybe_payouts = db @@ -75,9 +78,9 @@ pub async fn validate_create_request( merchant_context: &domain::MerchantContext, req: &payouts::PayoutCreateRequest, ) -> RouterResult<( - String, + id_type::PayoutId, Option<payouts::PayoutMethodData>, - common_utils::id_type::ProfileId, + id_type::ProfileId, Option<domain::Customer>, Option<PaymentMethod>, )> { @@ -101,7 +104,11 @@ pub async fn validate_create_request( // Payout ID let db: &dyn StorageInterface = &state.store; - let payout_id = core_utils::get_or_generate_uuid("payout_id", req.payout_id.as_ref())?; + let payout_id = match req.payout_id.as_ref() { + Some(provided_payout_id) => provided_payout_id.clone(), + None => id_type::PayoutId::generate(), + }; + match validate_uniqueness_of_payout_id_against_merchant_id( db, &payout_id, @@ -111,13 +118,12 @@ pub async fn validate_create_request( .await .attach_printable_lazy(\|\| { format!( - "Unique violation while checking payout_id: {} against merchant_id: {:?}", - payout_id.to_owned(), - merchant_id + "Unique violation while checking payout_id: {:?} against merchant_id: {:?}", + payout_id, merchant_id ) })? { Some(_) => Err(report!(errors::ApiErrorResponse::DuplicatePayout { - payout_id: payout_id.to_owned() + payout_id: payout_id.clone() })), None => Ok(()), }?; diff --git a/crates/router/src/core/utils.rs b/crates/router/src/core/utils.rs index 17ac3f9abd0..d0a27406eb5 100644 --- a/crates/router/src/core/utils.rs +++ b/crates/router/src/core/utils.rs @@ -34,7 +34,6 @@ use masking::{ExposeInterface, PeekInterface}; use maud::{html, PreEscaped}; use regex::Regex; use router_env::{instrument, tracing}; -use uuid::Uuid; use super::payments::helpers; #[cfg(feature = "payouts")] @@ -57,7 +56,7 @@ use crate::{ storage::{self, enums}, PollConfig, }, - utils::{generate_id, generate_uuid, OptionExt, ValueExt}, + utils::{generate_id, OptionExt, ValueExt}, }; pub const IRRELEVANT_CONNECTOR_REQUEST_REFERENCE_ID_IN_DISPUTE_FLOW: &str = @@ -188,7 +187,7 @@ pub async fn construct_payout_router_data<'a, F>( minor_amount_captured: None, payment_method_status: None, request: types::PayoutsData { - payout_id: payouts.payout_id.to_owned(), + payout_id: payouts.payout_id.clone(), amount: payouts.amount.get_amount_as_i64(), minor_amount: payouts.amount, connector_payout_id: payout_attempt.connector_payout_id.clone(), @@ -622,16 +621,6 @@ pub fn get_or_generate_id( .map_or(Ok(generate_id(consts::ID_LENGTH, prefix)), validate_id) } -pub fn get_or_generate_uuid( - key: &str, - provided_id: Option<&String>, -) -> Result<String, errors::ApiErrorResponse> { - let validate_id = \|id: String\| validate_uuid(id, key); - provided_id - .cloned() - .map_or(Ok(generate_uuid()), validate_id) -} - fn invalid_id_format_error(key: &str) -> errors::ApiErrorResponse { errors::ApiErrorResponse::InvalidDataFormat { field_name: key.to_string(), @@ -650,13 +639,6 @@ pub fn validate_id(id: String, key: &str) -> Result<String, errors::ApiErrorResp } } -pub fn validate_uuid(uuid: String, key: &str) -> Result<String, errors::ApiErrorResponse> { - match (Uuid::parse_str(&uuid), uuid.len() > consts::MAX_ID_LENGTH) { - (Ok(_), false) => Ok(uuid), - (_, _) => Err(invalid_id_format_error(key)), - } -} - #[cfg(feature = "v1")] pub fn get_split_refunds( split_refund_input: refunds_transformers::SplitRefundInput, diff --git a/crates/router/src/core/webhooks/incoming.rs b/crates/router/src/core/webhooks/incoming.rs index 5fef952532f..cc1dc7bc506 100644 --- a/crates/router/src/core/webhooks/incoming.rs +++ b/crates/router/src/core/webhooks/incoming.rs @@ -997,7 +997,10 @@ async fn payouts_incoming_webhook_flow( business_profile, outgoing_event_type, enums::EventClass::Payouts, - updated_payout_attempt.payout_id.clone(), + updated_payout_attempt + .payout_id + .get_string_repr() + .to_string(), enums::EventObjectType::PayoutDetails, api::OutgoingWebhookContent::PayoutDetails(Box::new(payout_create_response)), Some(updated_payout_attempt.created_at), diff --git a/crates/router/src/db/kafka_store.rs b/crates/router/src/db/kafka_store.rs index 48d0d582abb..7f24d2f5c99 100644 --- a/crates/router/src/db/kafka_store.rs +++ b/crates/router/src/db/kafka_store.rs @@ -2325,6 +2325,22 @@ impl PayoutAttemptInterface for KafkaStore {} #[async_trait::async_trait] impl PayoutAttemptInterface for KafkaStore { type Error = errors::StorageError; + + async fn find_payout_attempt_by_merchant_id_merchant_order_reference_id( + &self, + merchant_id: &id_type::MerchantId, + merchant_order_reference_id: &str, + storage_scheme: MerchantStorageScheme, + ) -> CustomResult<storage::PayoutAttempt, errors::StorageError> { + self.diesel_store + .find_payout_attempt_by_merchant_id_merchant_order_reference_id( + merchant_id, + merchant_order_reference_id, + storage_scheme, + ) + .await + } + async fn find_payout_attempt_by_merchant_id_payout_attempt_id( &self, merchant_id: &id_type::MerchantId, @@ -2431,7 +2447,7 @@ impl PayoutsInterface for KafkaStore { async fn find_payout_by_merchant_id_payout_id( &self, merchant_id: &id_type::MerchantId, - payout_id: &str, + payout_id: &id_type::PayoutId, storage_scheme: MerchantStorageScheme, ) -> CustomResult<storage::Payouts, errors::StorageError> { self.diesel_store @@ -2477,7 +2493,7 @@ impl PayoutsInterface for KafkaStore { async fn find_optional_payout_by_merchant_id_payout_id( &self, merchant_id: &id_type::MerchantId, - payout_id: &str, + payout_id: &id_type::PayoutId, storage_scheme: MerchantStorageScheme, ) -> CustomResult<Option<storage::Payouts>, errors::StorageError> { self.diesel_store @@ -2533,7 +2549,7 @@ impl PayoutsInterface for KafkaStore { async fn get_total_count_of_filtered_payouts( &self, merchant_id: &id_type::MerchantId, - active_payout_ids: &[String], + active_payout_ids: &[id_type::PayoutId], connector: Option<Vec<api_models::enums::PayoutConnectors>>, currency: Option<Vec<enums::Currency>>, status: Option<Vec<enums::PayoutStatus>>, @@ -2556,7 +2572,7 @@ impl PayoutsInterface for KafkaStore { &self, merchant_id: &id_type::MerchantId, constraints: &hyperswitch_domain_models::payouts::PayoutFetchConstraints, - ) -> CustomResult<Vec<String>, errors::StorageError> { + ) -> CustomResult<Vec<id_type::PayoutId>, errors::StorageError> { self.diesel_store .filter_active_payout_ids_by_constraints(merchant_id, constraints) .await diff --git a/crates/router/src/events/outgoing_webhook_logs.rs b/crates/router/src/events/outgoing_webhook_logs.rs index 7574332f778..43f2ae54be4 100644 --- a/crates/router/src/events/outgoing_webhook_logs.rs +++ b/crates/router/src/events/outgoing_webhook_logs.rs @@ -38,7 +38,7 @@ pub enum OutgoingWebhookEventContent { content: Value, }, Payout { - payout_id: String, + payout_id: common_utils::id_type::PayoutId, content: Value, }, #[cfg(feature = "v1")] diff --git a/crates/router/src/routes/payout_link.rs b/crates/router/src/routes/payout_link.rs index 0727890bb32..71e3439d337 100644 --- a/crates/router/src/routes/payout_link.rs +++ b/crates/router/src/routes/payout_link.rs @@ -15,7 +15,10 @@ use crate::{ pub async fn render_payout_link( state: web::Data<AppState>, req: actix_web::HttpRequest, - path: web::Path<(common_utils::id_type::MerchantId, String)>, + path: web::Path<( + common_utils::id_type::MerchantId, + common_utils::id_type::PayoutId, + )>, ) -> impl Responder { let flow = Flow::PayoutLinkInitiate; let (merchant_id, payout_id) = path.into_inner(); diff --git a/crates/router/src/routes/payouts.rs b/crates/router/src/routes/payouts.rs index be0aa027d70..5bccdd06668 100644 --- a/crates/router/src/routes/payouts.rs +++ b/crates/router/src/routes/payouts.rs @@ -2,6 +2,7 @@ use actix_web::{ body::{BoxBody, MessageBody}, web, HttpRequest, HttpResponse, Responder, }; +use common_utils::id_type; use router_env::{instrument, tracing, Flow}; use super::app::AppState; @@ -50,7 +51,7 @@ pub async fn payouts_create( pub async fn payouts_retrieve( state: web::Data<AppState>, req: HttpRequest, - path: web::Path<String>, + path: web::Path<id_type::PayoutId>, query_params: web::Query<payout_types::PayoutRetrieveBody>, ) -> HttpResponse { let payout_retrieve_request = payout_types::PayoutRetrieveRequest { @@ -90,7 +91,7 @@ pub async fn payouts_retrieve( pub async fn payouts_update( state: web::Data<AppState>, req: HttpRequest, - path: web::Path<String>, + path: web::Path<id_type::PayoutId>, json_payload: web::Json<payout_types::PayoutCreateRequest>, ) -> HttpResponse { let flow = Flow::PayoutsUpdate; @@ -122,12 +123,12 @@ pub async fn payouts_confirm( state: web::Data<AppState>, req: HttpRequest, json_payload: web::Json<payout_types::PayoutCreateRequest>, - path: web::Path<String>, + path: web::Path<id_type::PayoutId>, ) -> HttpResponse { let flow = Flow::PayoutsConfirm; let mut payload = json_payload.into_inner(); let payout_id = path.into_inner(); - tracing::Span::current().record("payout_id", &payout_id); + tracing::Span::current().record("payout_id", payout_id.get_string_repr()); payload.payout_id = Some(payout_id); payload.confirm = Some(true); let api_auth = auth::ApiKeyAuth::default(); @@ -160,12 +161,12 @@ pub async fn payouts_confirm( pub async fn payouts_cancel( state: web::Data<AppState>, req: HttpRequest, - json_payload: web::Json<payout_types::PayoutActionRequest>, - path: web::Path<String>, + path: web::Path<id_type::PayoutId>, ) -> HttpResponse { let flow = Flow::PayoutsCancel; - let mut payload = json_payload.into_inner(); - payload.payout_id = path.into_inner(); + let payload = payout_types::PayoutActionRequest { + payout_id: path.into_inner(), + }; Box::pin(api::server_wrap( flow, @@ -191,12 +192,12 @@ pub async fn payouts_cancel( pub async fn payouts_fulfill( state: web::Data<AppState>, req: HttpRequest, - json_payload: web::Json<payout_types::PayoutActionRequest>, - path: web::Path<String>, + path: web::Path<id_type::PayoutId>, ) -> HttpResponse { let flow = Flow::PayoutsFulfill; - let mut payload = json_payload.into_inner(); - payload.payout_id = path.into_inner(); + let payload = payout_types::PayoutActionRequest { + payout_id: path.into_inner(), + }; Box::pin(api::server_wrap( flow, diff --git a/crates/router/src/services/kafka/payout.rs b/crates/router/src/services/kafka/payout.rs index babf7c1c568..e27009b3989 100644 --- a/crates/router/src/services/kafka/payout.rs +++ b/crates/router/src/services/kafka/payout.rs @@ -5,7 +5,7 @@ use time::OffsetDateTime; #[derive(serde::Serialize, Debug)] pub struct KafkaPayout<'a> { - pub payout_id: &'a String, + pub payout_id: &'a id_type::PayoutId, pub payout_attempt_id: &'a String, pub merchant_id: &'a id_type::MerchantId, pub customer_id: Option<&'a id_type::CustomerId>, diff --git a/crates/router/src/utils.rs b/crates/router/src/utils.rs index f89dbbec70a..a733de87656 100644 --- a/crates/router/src/utils.rs +++ b/crates/router/src/utils.rs @@ -41,7 +41,6 @@ use nanoid::nanoid; use serde::de::DeserializeOwned; use serde_json::Value; use tracing_futures::Instrument; -use uuid::Uuid; pub use self::ext_traits::{OptionExt, ValidateCall}; use crate::{ @@ -115,11 +114,6 @@ pub fn generate_id(length: usize, prefix: &str) -> String { format!("{}_{}", prefix, nanoid!(length, &consts::ALPHABETS)) } -#[inline] -pub fn generate_uuid() -> String { - Uuid::new_v4().to_string() -} - pub trait ConnectorResponseExt: Sized { fn get_response(self) -> RouterResult<types::Response>; fn get_error_response(self) -> RouterResult<types::Response>; @@ -164,7 +158,7 @@ impl<E> ConnectorResponseExt } #[inline] -pub fn get_payout_attempt_id(payout_id: impl std::fmt::Display, attempt_count: i16) -> String { +pub fn get_payout_attempt_id(payout_id: &str, attempt_count: i16) -> String { format!("{payout_id}_{attempt_count}") } @@ -1356,7 +1350,7 @@ pub async fn trigger_payouts_webhook( business_profile, event_type, diesel_models::enums::EventClass::Payouts, - cloned_response.payout_id.clone(), + cloned_response.payout_id.get_string_repr().to_owned(), diesel_models::enums::EventObjectType::PayoutDetails, webhooks::OutgoingWebhookContent::PayoutDetails(Box::new(cloned_response)), primary_object_created_at, diff --git a/crates/router/src/workflows/outgoing_webhook_retry.rs b/crates/router/src/workflows/outgoing_webhook_retry.rs index 8a04094f31d..243c7382023 100644 --- a/crates/router/src/workflows/outgoing_webhook_retry.rs +++ b/crates/router/src/workflows/outgoing_webhook_retry.rs @@ -8,6 +8,7 @@ use api_models::{ use common_utils::{ consts::DEFAULT_LOCALE, ext_traits::{StringExt, ValueExt}, + id_type, }; use diesel_models::process_tracker::business_status; use error_stack::ResultExt; @@ -283,7 +284,7 @@ impl ProcessTrackerWorkflow<SessionState> for OutgoingWebhookRetryWorkflow { #[instrument(skip_all)] pub(crate) async fn get_webhook_delivery_retry_schedule_time( db: &dyn StorageInterface, - merchant_id: &common_utils::id_type::MerchantId, + merchant_id: &id_type::MerchantId, retry_count: i32, ) -> Option<time::PrimitiveDateTime> { let key = "pt_mapping_outgoing_webhooks"; @@ -329,7 +330,7 @@ pub(crate) async fn get_webhook_delivery_retry_schedule_time( #[instrument(skip_all)] pub(crate) async fn retry_webhook_delivery_task( db: &dyn StorageInterface, - merchant_id: &common_utils::id_type::MerchantId, + merchant_id: &id_type::MerchantId, process: storage::ProcessTracker, ) -> errors::CustomResult<(), errors::StorageError> { let schedule_time = @@ -385,15 +386,14 @@ async fn get_outgoing_webhook_content_and_event_type( match tracking_data.event_class { diesel_models::enums::EventClass::Payments => { let payment_id = tracking_data.primary_object_id.clone(); - let payment_id = - common_utils::id_type::PaymentId::try_from(std::borrow::Cow::Owned(payment_id)) - .map_err(\|payment_id_parsing_error\| { - logger::error!( - ?payment_id_parsing_error, - "Failed to parse payment ID from tracking data" - ); - errors::ProcessTrackerError::DeserializationFailed - })?; + let payment_id = id_type::PaymentId::try_from(std::borrow::Cow::Owned(payment_id)) + .map_err(\|payment_id_parsing_error\| { + logger::error!( + ?payment_id_parsing_error, + "Failed to parse payment ID from tracking data" + ); + errors::ProcessTrackerError::DeserializationFailed + })?; let request = PaymentsRetrieveRequest { resource_id: PaymentIdType::PaymentIntentId(payment_id), merchant_id: Some(tracking_data.merchant_id.clone()), @@ -539,7 +539,9 @@ async fn get_outgoing_webhook_content_and_event_type( diesel_models::enums::EventClass::Payouts => { let payout_id = tracking_data.primary_object_id.clone(); let request = payout_models::PayoutRequest::PayoutActionRequest( - payout_models::PayoutActionRequest { payout_id }, + payout_models::PayoutActionRequest { + payout_id: id_type::PayoutId::try_from(std::borrow::Cow::Owned(payout_id))?, + }, ); let payout_data = Box::pin(payouts::make_payout_data( diff --git a/crates/router/tests/connectors/utils.rs b/crates/router/tests/connectors/utils.rs index 4bc234cca24..bf9bc355334 100644 --- a/crates/router/tests/connectors/utils.rs +++ b/crates/router/tests/connectors/utils.rs @@ -1,11 +1,9 @@ use std::{fmt::Debug, marker::PhantomData, str::FromStr, sync::Arc, time::Duration}; use async_trait::async_trait; -use common_utils::pii::Email; +use common_utils::{id_type::GenerateId, pii::Email}; use error_stack::Report; use masking::Secret; -#[cfg(feature = "payouts")] -use router::core::utils as core_utils; use router::{ configs::settings::Settings, core::{errors::ConnectorError, payments}, @@ -454,8 +452,7 @@ pub trait ConnectorActions: Connector { ) -> RouterData<Flow, types::PayoutsData, Res> { self.generate_data( types::PayoutsData { - payout_id: core_utils::get_or_generate_uuid("payout_id", None) - .map_or("payout_3154763247".to_string(), \|p\| p), + payout_id: common_utils::id_type::PayoutId::generate(), amount: 1, minor_amount: MinorUnit::new(1), connector_payout_id, diff --git a/crates/storage_impl/src/lib.rs b/crates/storage_impl/src/lib.rs index 156ebee2dea..b2a2dba5779 100644 --- a/crates/storage_impl/src/lib.rs +++ b/crates/storage_impl/src/lib.rs @@ -427,7 +427,7 @@ impl UniqueConstraints for diesel_models::Payouts { vec![format!( "po_{}_{}", self.merchant_id.get_string_repr(), - self.payout_id + self.payout_id.get_string_repr() )] } fn table_name(&self) -> &str { diff --git a/crates/storage_impl/src/mock_db/payout_attempt.rs b/crates/storage_impl/src/mock_db/payout_attempt.rs index 1fd2058e95a..008e9f921b0 100644 --- a/crates/storage_impl/src/mock_db/payout_attempt.rs +++ b/crates/storage_impl/src/mock_db/payout_attempt.rs @@ -65,4 +65,13 @@ impl PayoutAttemptInterface for MockDb { > { Err(StorageError::MockDbError)? } + + async fn find_payout_attempt_by_merchant_id_merchant_order_reference_id( + &self, + _merchant_id: &common_utils::id_type::MerchantId, + _merchant_order_reference_id: &str, + _storage_scheme: storage_enums::MerchantStorageScheme, + ) -> CustomResult<PayoutAttempt, StorageError> { + Err(StorageError::MockDbError)? + } } diff --git a/crates/storage_impl/src/mock_db/payouts.rs b/crates/storage_impl/src/mock_db/payouts.rs index ecba8f88df6..648e09bd5c6 100644 --- a/crates/storage_impl/src/mock_db/payouts.rs +++ b/crates/storage_impl/src/mock_db/payouts.rs @@ -13,7 +13,7 @@ impl PayoutsInterface for MockDb { async fn find_payout_by_merchant_id_payout_id( &self, _merchant_id: &common_utils::id_type::MerchantId, - _payout_id: &str, + _payout_id: &common_utils::id_type::PayoutId, _storage_scheme: storage_enums::MerchantStorageScheme, ) -> CustomResult<Payouts, StorageError> { // TODO: Implement function for `MockDb` @@ -43,7 +43,7 @@ impl PayoutsInterface for MockDb { async fn find_optional_payout_by_merchant_id_payout_id( &self, _merchant_id: &common_utils::id_type::MerchantId, - _payout_id: &str, + _payout_id: &common_utils::id_type::PayoutId, _storage_scheme: storage_enums::MerchantStorageScheme, ) -> CustomResult<Option<Payouts>, StorageError> { // TODO: Implement function for `MockDb` @@ -95,7 +95,7 @@ impl PayoutsInterface for MockDb { async fn get_total_count_of_filtered_payouts( &self, _merchant_id: &common_utils::id_type::MerchantId, - _active_payout_ids: &[String], + _active_payout_ids: &[common_utils::id_type::PayoutId], _connector: Option<Vec<api_models::enums::PayoutConnectors>>, _currency: Option<Vec<storage_enums::Currency>>, _status: Option<Vec<storage_enums::PayoutStatus>>, @@ -110,7 +110,7 @@ impl PayoutsInterface for MockDb { &self, _merchant_id: &common_utils::id_type::MerchantId, _constraints: &hyperswitch_domain_models::payouts::PayoutFetchConstraints, - ) -> CustomResult<Vec<String>, StorageError> { + ) -> CustomResult<Vec<common_utils::id_type::PayoutId>, StorageError> { // TODO: Implement function for `MockDb` Err(StorageError::MockDbError)? } diff --git a/crates/storage_impl/src/payouts/payout_attempt.rs b/crates/storage_impl/src/payouts/payout_attempt.rs index e1706fad124..35939c11323 100644 --- a/crates/storage_impl/src/payouts/payout_attempt.rs +++ b/crates/storage_impl/src/payouts/payout_attempt.rs @@ -60,7 +60,7 @@ impl<T: DatabaseStore> PayoutAttemptInterface for KVRouterStore<T> { let payout_attempt_id = new_payout_attempt.payout_id.clone(); let key = PartitionKey::MerchantIdPayoutAttemptId { merchant_id: &merchant_id, - payout_attempt_id: &payout_attempt_id, + payout_attempt_id: payout_attempt_id.get_string_repr(), }; let key_str = key.to_string(); let created_attempt = PayoutAttempt { @@ -88,6 +88,9 @@ impl<T: DatabaseStore> PayoutAttemptInterface for KVRouterStore<T> { routing_info: new_payout_attempt.routing_info.clone(), unified_code: new_payout_attempt.unified_code.clone(), unified_message: new_payout_attempt.unified_message.clone(), + merchant_order_reference_id: new_payout_attempt + .merchant_order_reference_id + .clone(), }; let redis_entry = kv::TypedSql { @@ -149,7 +152,7 @@ impl<T: DatabaseStore> PayoutAttemptInterface for KVRouterStore<T> { ) -> error_stack::Result<PayoutAttempt, errors::StorageError> { let key = PartitionKey::MerchantIdPayoutAttemptId { merchant_id: &this.merchant_id, - payout_attempt_id: &this.payout_id, + payout_attempt_id: this.payout_id.get_string_repr(), }; let field = format!("poa_{}", this.payout_attempt_id); let storage_scheme = Box::pin(decide_storage_scheme::<_, DieselPayoutAttempt>( @@ -378,6 +381,22 @@ impl<T: DatabaseStore> PayoutAttemptInterface for KVRouterStore<T> { .get_filters_for_payouts(payouts, merchant_id, storage_scheme) .await } + + #[instrument(skip_all)] + async fn find_payout_attempt_by_merchant_id_merchant_order_reference_id( + &self, + merchant_id: &common_utils::id_type::MerchantId, + merchant_order_reference_id: &str, + storage_scheme: MerchantStorageScheme, + ) -> error_stack::Result<PayoutAttempt, errors::StorageError> { + self.router_store + .find_payout_attempt_by_merchant_id_merchant_order_reference_id( + merchant_id, + merchant_order_reference_id, + storage_scheme, + ) + .await + } } #[async_trait::async_trait] @@ -504,6 +523,27 @@ impl<T: DatabaseStore> PayoutAttemptInterface for crate::RouterStore<T> { }, ) } + + #[instrument(skip_all)] + async fn find_payout_attempt_by_merchant_id_merchant_order_reference_id( + &self, + merchant_id: &common_utils::id_type::MerchantId, + merchant_order_reference_id: &str, + _storage_scheme: MerchantStorageScheme, + ) -> error_stack::Result<PayoutAttempt, errors::StorageError> { + let conn = pg_connection_read(self).await?; + DieselPayoutAttempt::find_by_merchant_id_merchant_order_reference_id( + &conn, + merchant_id, + merchant_order_reference_id, + ) + .await + .map(PayoutAttempt::from_storage_model) + .map_err(\|er\| { + let new_err = diesel_error_to_data_error(er.current_context()); + er.change_context(new_err) + }) + } } impl DataModelExt for PayoutAttempt { @@ -533,6 +573,7 @@ impl DataModelExt for PayoutAttempt { unified_code: self.unified_code, unified_message: self.unified_message, additional_payout_method_data: self.additional_payout_method_data, + merchant_order_reference_id: self.merchant_order_reference_id, } } @@ -560,6 +601,7 @@ impl DataModelExt for PayoutAttempt { unified_code: storage_model.unified_code, unified_message: storage_model.unified_message, additional_payout_method_data: storage_model.additional_payout_method_data, + merchant_order_reference_id: storage_model.merchant_order_reference_id, } } } @@ -590,6 +632,7 @@ impl DataModelExt for PayoutAttemptNew { unified_code: self.unified_code, unified_message: self.unified_message, additional_payout_method_data: self.additional_payout_method_data, + merchant_order_reference_id: self.merchant_order_reference_id, } } @@ -617,6 +660,7 @@ impl DataModelExt for PayoutAttemptNew { unified_code: storage_model.unified_code, unified_message: storage_model.unified_message, additional_payout_method_data: storage_model.additional_payout_method_data, + merchant_order_reference_id: storage_model.merchant_order_reference_id, } } } diff --git a/crates/storage_impl/src/payouts/payouts.rs b/crates/storage_impl/src/payouts/payouts.rs index 484328aabab..c9d16b7d8a2 100644 --- a/crates/storage_impl/src/payouts/payouts.rs +++ b/crates/storage_impl/src/payouts/payouts.rs @@ -80,7 +80,7 @@ impl<T: DatabaseStore> PayoutsInterface for KVRouterStore<T> { payout_id: &payout_id, }; let key_str = key.to_string(); - let field = format!("po_{}", new.payout_id); + let field = format!("po_{}", new.payout_id.get_string_repr()); let created_payout = Payouts { payout_id: new.payout_id.clone(), merchant_id: new.merchant_id.clone(), @@ -151,7 +151,7 @@ impl<T: DatabaseStore> PayoutsInterface for KVRouterStore<T> { merchant_id: &this.merchant_id, payout_id: &this.payout_id, }; - let field = format!("po_{}", this.payout_id); + let field = format!("po_{}", this.payout_id.get_string_repr()); let storage_scheme = Box::pin(decide_storage_scheme::<_, DieselPayouts>( self, storage_scheme, @@ -207,7 +207,7 @@ impl<T: DatabaseStore> PayoutsInterface for KVRouterStore<T> { async fn find_payout_by_merchant_id_payout_id( &self, merchant_id: &common_utils::id_type::MerchantId, - payout_id: &str, + payout_id: &common_utils::id_type::PayoutId, storage_scheme: MerchantStorageScheme, ) -> error_stack::Result<Payouts, StorageError> { let database_call = \|\| async { @@ -232,7 +232,7 @@ impl<T: DatabaseStore> PayoutsInterface for KVRouterStore<T> { merchant_id, payout_id, }; - let field = format!("po_{payout_id}"); + let field = format!("po_{}", payout_id.get_string_repr()); Box::pin(utils::try_redis_get_else_try_database_get( async { Box::pin(kv_wrapper::<DieselPayouts, _, _>( @@ -255,7 +255,7 @@ impl<T: DatabaseStore> PayoutsInterface for KVRouterStore<T> { async fn find_optional_payout_by_merchant_id_payout_id( &self, merchant_id: &common_utils::id_type::MerchantId, - payout_id: &str, + payout_id: &common_utils::id_type::PayoutId, storage_scheme: MerchantStorageScheme, ) -> error_stack::Result<Option<Payouts>, StorageError> { let database_call = \|\| async { @@ -276,20 +276,14 @@ impl<T: DatabaseStore> PayoutsInterface for KVRouterStore<T> { match storage_scheme { MerchantStorageScheme::PostgresOnly => { let maybe_payouts = database_call().await?; - Ok(maybe_payouts.and_then(\|payout\| { - if payout.payout_id == payout_id { - Some(payout) - } else { - None - } - })) + Ok(maybe_payouts.filter(\|payout\| &payout.payout_id == payout_id)) } MerchantStorageScheme::RedisKv => { let key = PartitionKey::MerchantIdPayoutId { merchant_id, payout_id, }; - let field = format!("po_{payout_id}"); + let field = format!("po_{}", payout_id.get_string_repr()); Box::pin(utils::try_redis_get_else_try_database_get( async { Box::pin(kv_wrapper::<DieselPayouts, _, _>( @@ -360,7 +354,7 @@ impl<T: DatabaseStore> PayoutsInterface for KVRouterStore<T> { async fn get_total_count_of_filtered_payouts( &self, merchant_id: &common_utils::id_type::MerchantId, - active_payout_ids: &[String], + active_payout_ids: &[common_utils::id_type::PayoutId], connector: Option<Vec<PayoutConnectors>>, currency: Option<Vec<storage_enums::Currency>>, status: Option<Vec<storage_enums::PayoutStatus>>, @@ -383,7 +377,7 @@ impl<T: DatabaseStore> PayoutsInterface for KVRouterStore<T> { &self, merchant_id: &common_utils::id_type::MerchantId, constraints: &PayoutFetchConstraints, - ) -> error_stack::Result<Vec<String>, StorageError> { + ) -> error_stack::Result<Vec<common_utils::id_type::PayoutId>, StorageError> { self.router_store .filter_active_payout_ids_by_constraints(merchant_id, constraints) .await @@ -434,7 +428,7 @@ impl<T: DatabaseStore> PayoutsInterface for crate::RouterStore<T> { async fn find_payout_by_merchant_id_payout_id( &self, merchant_id: &common_utils::id_type::MerchantId, - payout_id: &str, + payout_id: &common_utils::id_type::PayoutId, _storage_scheme: MerchantStorageScheme, ) -> error_stack::Result<Payouts, StorageError> { let conn = pg_connection_read(self).await?; @@ -451,7 +445,7 @@ impl<T: DatabaseStore> PayoutsInterface for crate::RouterStore<T> { async fn find_optional_payout_by_merchant_id_payout_id( &self, merchant_id: &common_utils::id_type::MerchantId, - payout_id: &str, + payout_id: &common_utils::id_type::PayoutId, _storage_scheme: MerchantStorageScheme, ) -> error_stack::Result<Option<Payouts>, StorageError> { let conn = pg_connection_read(self).await?; @@ -498,7 +492,7 @@ impl<T: DatabaseStore> PayoutsInterface for crate::RouterStore<T> { query = query.filter(po_dsl::profile_id.eq(profile_id.clone())); } - query = match (params.starting_at, &params.starting_after_id) { + query = match (params.starting_at, params.starting_after_id.as_ref()) { (Some(starting_at), _) => query.filter(po_dsl::created_at.ge(starting_at)), (None, Some(starting_after_id)) => { // TODO: Fetch partial columns for this query since we only need some columns @@ -515,7 +509,7 @@ impl<T: DatabaseStore> PayoutsInterface for crate::RouterStore<T> { (None, None) => query, }; - query = match (params.ending_at, &params.ending_before_id) { + query = match (params.ending_at, params.ending_before_id.as_ref()) { (Some(ending_at), _) => query.filter(po_dsl::created_at.le(ending_at)), (None, Some(ending_before_id)) => { // TODO: Fetch partial columns for this query since we only need some columns @@ -619,10 +613,18 @@ impl<T: DatabaseStore> PayoutsInterface for crate::RouterStore<T> { query = query.filter(po_dsl::profile_id.eq(profile_id.clone())); } - query = match (params.starting_at, &params.starting_after_id) { + if let Some(merchant_order_reference_id_filter) = + &params.merchant_order_reference_id + { + query = query.filter( + poa_dsl::merchant_order_reference_id + .eq(merchant_order_reference_id_filter.clone()), + ); + } + + query = match (params.starting_at, params.starting_after_id.as_ref()) { (Some(starting_at), _) => query.filter(po_dsl::created_at.ge(starting_at)), (None, Some(starting_after_id)) => { - // TODO: Fetch partial columns for this query since we only need some columns let starting_at = self .find_payout_by_merchant_id_payout_id( merchant_id, @@ -636,10 +638,9 @@ impl<T: DatabaseStore> PayoutsInterface for crate::RouterStore<T> { (None, None) => query, }; - query = match (params.ending_at, &params.ending_before_id) { + query = match (params.ending_at, params.ending_before_id.as_ref()) { (Some(ending_at), _) => query.filter(po_dsl::created_at.le(ending_at)), (None, Some(ending_before_id)) => { - // TODO: Fetch partial columns for this query since we only need some columns let ending_at = self .find_payout_by_merchant_id_payout_id( merchant_id, @@ -665,20 +666,24 @@ impl<T: DatabaseStore> PayoutsInterface for crate::RouterStore<T> { .map(\|c\| c.iter().map(\|c\| c.to_string()).collect::<Vec<String>>()); query = match connectors { - Some(connectors) => query.filter(poa_dsl::connector.eq_any(connectors)), - None => query, + Some(conn_filters) if !conn_filters.is_empty() => { + query.filter(poa_dsl::connector.eq_any(conn_filters)) + } + _ => query, }; query = match &params.status { - Some(status) => query.filter(po_dsl::status.eq_any(status.clone())), - None => query, + Some(status_filters) if !status_filters.is_empty() => { + query.filter(po_dsl::status.eq_any(status_filters.clone())) + } + _ => query, }; query = match &params.payout_method { - Some(payout_method) => { + Some(payout_method) if !payout_method.is_empty() => { query.filter(po_dsl::payout_type.eq_any(payout_method.clone())) } - None => query, + _ => query, }; query @@ -760,7 +765,7 @@ impl<T: DatabaseStore> PayoutsInterface for crate::RouterStore<T> { async fn get_total_count_of_filtered_payouts( &self, merchant_id: &common_utils::id_type::MerchantId, - active_payout_ids: &[String], + active_payout_ids: &[common_utils::id_type::PayoutId], connector: Option<Vec<PayoutConnectors>>, currency: Option<Vec<storage_enums::Currency>>, status: Option<Vec<storage_enums::PayoutStatus>>, @@ -800,7 +805,7 @@ impl<T: DatabaseStore> PayoutsInterface for crate::RouterStore<T> { &self, merchant_id: &common_utils::id_type::MerchantId, constraints: &PayoutFetchConstraints, - ) -> error_stack::Result<Vec<String>, StorageError> { + ) -> error_stack::Result<Vec<common_utils::id_type::PayoutId>, StorageError> { let conn = connection::pg_connection_read(self).await?; let conn = async_bb8_diesel::Connection::as_async_conn(&conn); let mut query = DieselPayouts::table() @@ -868,8 +873,14 @@ impl<T: DatabaseStore> PayoutsInterface for crate::RouterStore<T> { error_stack::report!(diesel_models::errors::DatabaseError::from(er)) .attach_printable("Error filtering payout records"), ) - .into() + })? + .into_iter() + .map(\|s\| { + common_utils::id_type::PayoutId::try_from(std::borrow::Cow::Owned(s)) + .change_context(StorageError::DeserializationFailed) + .attach_printable("Failed to deserialize PayoutId from database string") }) + .collect::<error_stack::Result<Vec<_>, _>>() } #[cfg(all(feature = "olap", feature = "v2"))] @@ -878,7 +889,7 @@ impl<T: DatabaseStore> PayoutsInterface for crate::RouterStore<T> { &self, _merchant_id: &common_utils::id_type::MerchantId, _constraints: &PayoutFetchConstraints, - ) -> error_stack::Result<Vec<String>, StorageError> { + ) -> error_stack::Result<Vec<common_utils::id_type::PayoutId>, StorageError> { todo!() } } diff --git a/crates/storage_impl/src/redis/kv_store.rs b/crates/storage_impl/src/redis/kv_store.rs index fd583f500ed..e7c47c58996 100644 --- a/crates/storage_impl/src/redis/kv_store.rs +++ b/crates/storage_impl/src/redis/kv_store.rs @@ -41,7 +41,7 @@ pub enum PartitionKey<'a> { }, MerchantIdPayoutId { merchant_id: &'a common_utils::id_type::MerchantId, - payout_id: &'a str, + payout_id: &'a common_utils::id_type::PayoutId, }, MerchantIdPayoutAttemptId { merchant_id: &'a common_utils::id_type::MerchantId, @@ -93,8 +93,9 @@ impl std::fmt::Display for PartitionKey<'_> { merchant_id, payout_id, } => f.write_str(&format!( - "mid_{}_po_{payout_id}", - merchant_id.get_string_repr() + "mid_{}_po_{}", + merchant_id.get_string_repr(), + payout_id.get_string_repr() )), PartitionKey::MerchantIdPayoutAttemptId { merchant_id, diff --git a/flake.nix b/flake.nix index 35fa05b73a7..05058a75d9e 100644 --- a/flake.nix +++ b/flake.nix @@ -43,6 +43,7 @@ devPackages = base ++ (with pkgs; [ cargo-watch nixd + protobuf rust-bin.stable.${rustDevVersion}.default swagger-cli ]); diff --git a/migrations/2025-06-19-170656_alter_payout_primary_key/down.sql b/migrations/2025-06-19-170656_alter_payout_primary_key/down.sql new file mode 100644 index 00000000000..e8ff6e1c5a1 --- /dev/null +++ b/migrations/2025-06-19-170656_alter_payout_primary_key/down.sql @@ -0,0 +1,7 @@ +ALTER TABLE payout_attempt DROP COLUMN merchant_order_reference_id; + +ALTER TABLE payout_attempt DROP CONSTRAINT payout_attempt_pkey; +ALTER TABLE payout_attempt ADD PRIMARY KEY (payout_attempt_id); + +ALTER TABLE payouts DROP CONSTRAINT payouts_pkey; +ALTER TABLE payouts ADD PRIMARY KEY (payout_id); diff --git a/migrations/2025-06-19-170656_alter_payout_primary_key/up.sql b/migrations/2025-06-19-170656_alter_payout_primary_key/up.sql new file mode 100644 index 00000000000..d65c931719f --- /dev/null +++ b/migrations/2025-06-19-170656_alter_payout_primary_key/up.sql @@ -0,0 +1,7 @@ +ALTER TABLE payout_attempt DROP CONSTRAINT payout_attempt_pkey; +ALTER TABLE payout_attempt ADD PRIMARY KEY (merchant_id, payout_attempt_id); + +ALTER TABLE payouts DROP CONSTRAINT payouts_pkey; +ALTER TABLE payouts ADD PRIMARY KEY (merchant_id, payout_id); + +ALTER TABLE payout_attempt ADD COLUMN merchant_order_reference_id VARCHAR(255) NULL;	2025-06-20T04:35:56Z	feat(payouts): allow payout_id to be configurable in API request feat(payouts): add merchant_order_reference_id for referencing payouts ## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [x] New feature - [ ] Enhancement - [x] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description This pull request introduces two main features for payouts: 1. Configurable `payout_id` in API Requests: * The `payout_id` field in payout creation API requests can now be optionally provided by the merchant. If provided, this ID will be used for the payout. If not provided, the system will generate one. * Internally, the usage of `payout_id` has been standardized to use the strongly-typed `common_utils::id_type::PayoutId` instead of `String`. This change has been propagated throughout relevant structs and functionalities like `PayoutsData`, data handling logic in `crates/router/src/core/utils.rs`, test utilities and DB queries. 2. `merchant_order_reference_id` for Payout Referencing: * The `merchant_order_reference_id` field has been added/updated in payout API models (e.g., `PayoutListFilterConstraints` in `crates/api_models/src/payouts.rs`). This allows merchants to use their own unique identifier to reference payouts. Refactoring and Connector Updates: * To support the `id_type::PayoutId` change and ensure correct data flow, connector integrations (Adyen, Adyenplatform, Cybersource, Nomupay) have been refactored. * Connectors now consistently use `RouterData.connector_request_reference_id` (which typically holds the `payout_attempt_id` as a `String`) when a string-based reference is required by the external service, rather than converting the internal `PayoutsData.payout_id`. This ensures that connectors receive the appropriate string identifier (e.g., `payout_attempt_id`) they expect. ### Additional Changes - [x] This PR modifies the API contract. - [x] This PR modifies the database schema. - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context These changes address the need for greater flexibility and type safety in payout processing, as outlined in GitHub issues #8392 and #1321. * Configurable `payout_id`: Allows merchants more control over their payout identifiers within the Hyperswitch. * `merchant_order_reference_id`: Provides a dedicated field for merchants to use their internal order or reference IDs. * `PayoutId` Type Standardization: Using `common_utils::id_type::PayoutId` enhances code robustness and maintainability by leveraging Rust's type system to prevent errors related to ID handling. * Connector Refactoring: Ensures that connectors use the correct string-based identifiers (like `payout_attempt_id` via `connector_request_reference_id`) required by external payout processors, maintaining correctness of integrations. Links to issues: * https://github.com/juspay/hyperswitch/issues/8392 * https://github.com/juspay/hyperswitch/issues/1321 ## How did you test it? <details> <summary>1. Card payouts via API</summary> cURL curl --location --request POST 'http://localhost:8080/payouts/create' \ --header 'Content-Type: application/json' \ --header 'api-key: dev_lAISInmiO4UNrMmvkJogzRVKEGKlBKQbRCBFOkLJTXmq6nsD5G1H65BjOd4H72H8' \ --data '{"amount":100,"currency":"EUR","profile_id":"pro_vVSlzCG7M1GSX9SyssY8","customer_id":"cus_WULwykbL8laUbxDUeGEB","connector":["adyenplatform"],"description":"Its my first payout request","payout_type":"card","payout_method_data":{"card":{"card_number":"4111111111111111","expiry_month":"03","expiry_year":"2030"}},"billing":{"address":{"line1":"1467","line2":"Harrison Street","line3":"Harrison Street","city":"San Fransico","state":"CA","zip":"94122","country":"FR","first_name":"John","last_name":"Doe"}},"entity_type":"Individual","recurring":true,"metadata":{"ref":"123"},"confirm":true,"auto_fulfill":true}' Response {"payout_id":"ff21b89d-3cfd-4f0f-b3ff-c468d90d7074","merchant_id":"merchant_1751292662","amount":100,"currency":"EUR","connector":"adyenplatform","payout_type":"card","payout_method_data":{"card":{"card_issuer":null,"card_network":null,"card_type":null,"card_issuing_country":null,"bank_code":null,"last4":"1111","card_isin":"411111","card_extended_bin":null,"card_exp_month":"03","card_exp_year":"2030","card_holder_name":null}},"billing":{"address":{"city":"San Fransico","country":"FR","line1":"1467","line2":"Harrison Street","line3":"Harrison Street","zip":"94122","state":"CA","first_name":"John","last_name":"Doe"},"phone":null,"email":null},"auto_fulfill":true,"customer_id":"cus_WULwykbL8laUbxDUeGEB","customer":{"id":"cus_WULwykbL8laUbxDUeGEB","name":"John Nether","email":null,"phone":"6168205362","phone_country_code":"+1"},"client_secret":"payout_ff21b89d-3cfd-4f0f-b3ff-c468d90d7074_secret_qzFALtOg6ZhYAOAUr2qY","return_url":null,"business_country":null,"business_label":null,"description":"Its my first payout request","entity_type":"Individual","recurring":true,"metadata":{"ref":"123"},"merchant_connector_id":"mca_SfssFvg5RBT2k7iKRRsS","status":"initiated","error_message":null,"error_code":null,"profile_id":"pro_vVSlzCG7M1GSX9SyssY8","created":"2025-06-30T14:12:47.886Z","connector_transaction_id":"38EBIX67HBSYZ30V","priority":null,"payout_link":null,"email":null,"name":"John Nether","phone":"6168205362","phone_country_code":"+1","unified_code":null,"unified_message":null,"payout_method_id":"pm_wScFhCfxELZ7gN13Nbxz"} </details> <details> <summary>2. Card payouts via Payout Links</summary> cURL curl --location --request POST 'http://localhost:8080/payouts/create' \ --header 'Content-Type: application/json' \ --header 'api-key: dev_lAISInmiO4UNrMmvkJogzRVKEGKlBKQbRCBFOkLJTXmq6nsD5G1H65BjOd4H72H8' \ --data '{"amount":1,"currency":"EUR","customer_id":"cus_WULwykbL8laUbxDUeGEB","description":"Its my first payout request","entity_type":"Individual","confirm":false,"auto_fulfill":true,"session_expiry":1000000,"profile_id":"pro_vVSlzCG7M1GSX9SyssY8","payout_link":true,"return_url":"https://www.google.com","payout_link_config":{"form_layout":"journey","theme":"#0066ff","logo":"https://hyperswitch.io/favicon.ico","merchant_name":"HyperSwitch Inc.","test_mode":true}}' Response {"payout_id":"2371746b-df3d-41da-8fa2-455faf921ea9","merchant_id":"merchant_1751292662","amount":1,"currency":"EUR","connector":null,"payout_type":null,"payout_method_data":null,"billing":null,"auto_fulfill":true,"customer_id":"cus_WULwykbL8laUbxDUeGEB","customer":{"id":"cus_WULwykbL8laUbxDUeGEB","name":"John Nether","email":null,"phone":"6168205362","phone_country_code":"+1"},"client_secret":"payout_2371746b-df3d-41da-8fa2-455faf921ea9_secret_VwDeIScMTLFzG7Iz1DZU","return_url":"https://www.google.com","business_country":null,"business_label":null,"description":"Its my first payout request","entity_type":"Individual","recurring":false,"metadata":{},"merchant_connector_id":null,"status":"requires_payout_method_data","error_message":null,"error_code":null,"profile_id":"pro_vVSlzCG7M1GSX9SyssY8","created":"2025-06-30T14:14:48.897Z","connector_transaction_id":null,"priority":null,"payout_link":{"payout_link_id":"payout_link_vITmtOWGkaUfeXopruRs","link":"http://localhost:8080/payout_link/merchant_1751292662/2371746b-df3d-41da-8fa2-455faf921ea9?locale=en"},"email":null,"name":"John Nether","phone":"6168205362","phone_country_code":"+1","unified_code":null,"unified_message":null,"payout_method_id":null} <img width="1719" alt="Screenshot 2025-06-30 at 7 45 32 PM" src="https://github.com/user-attachments/assets/e1ace815-74b5-411a-83be-badb2c04bf7d" /> <img width="1721" alt="Screenshot 2025-06-30 at 7 45 48 PM" src="https://github.com/user-attachments/assets/a8233053-9c1e-402d-87af-e59783fefc9d" /> <img width="913" alt="Screenshot 2025-06-30 at 7 45 54 PM" src="https://github.com/user-attachments/assets/586d1aa9-0116-46f3-b597-91b1f46ba5d2" /> </details> ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.114.0	0c649158a8ee491e2ff6ff37e922266d5b64b22d	0c649158a8ee491e2ff6ff37e922266d5b64b22d
juspay/hyperswitch	juspay__hyperswitch-8394	Bug: feat(revenue_recovery): Invoke attempt list instead of payment get in recovery webhooks flow Previously we were using payment get to find whether attempt is present in db or not, but for the first invoice webhook there won't be any attempt present in db and recently we added a validation to use payment get only in case of attempt is present. Also for stripe billing / stripe connector_transaction_id remains same instead charge id keeps changing , so we need to add support for this by checking if charge id is present we compare charge id if not we check for connector transaction id.	diff --git a/api-reference/README.md b/api-reference/README.md index b0343f44e62..ef3537d6b73 100644 --- a/api-reference/README.md +++ b/api-reference/README.md @@ -45,4 +45,4 @@ npx @mintlify/scraping@latest openapi-file v1/openapi_spec_v1.json -o v1 This will generate files in [api-reference](api-reference) folder. These routes should be added to the [mint.json](mint.json) file under navigation, under respective group. -NOTE: For working with V2 API reference, replace every occurence of `v1` with `v2` in above commands \ No newline at end of file +NOTE: For working with V2 API reference, replace every occurrence of `v1` with `v2` in above commands \ No newline at end of file diff --git a/api-reference/v2/openapi_spec_v2.json b/api-reference/v2/openapi_spec_v2.json index b213d96accd..853b0c3c5b5 100644 --- a/api-reference/v2/openapi_spec_v2.json +++ b/api-reference/v2/openapi_spec_v2.json @@ -15711,6 +15711,11 @@ } ], "nullable": true + }, + "charge_id": { + "type": "string", + "example": "ch_123abc456def789ghi012klmn", + "nullable": true } } }, diff --git a/crates/api_models/src/payments.rs b/crates/api_models/src/payments.rs index cb5480ed1f4..25e85c3f90c 100644 --- a/crates/api_models/src/payments.rs +++ b/crates/api_models/src/payments.rs @@ -1668,6 +1668,9 @@ pub struct PaymentAttemptRevenueRecoveryData { /// Flag to find out whether an attempt was created by external or internal system. #[schema(value_type = Option<TriggeredBy>, example = "internal")] pub attempt_triggered_by: common_enums::TriggeredBy, + // stripe specific field used to identify duplicate attempts. + #[schema(value_type = Option<String>, example = "ch_123abc456def789ghi012klmn")] + pub charge_id: Option<String>, } #[derive( @@ -5812,22 +5815,34 @@ pub struct PaymentsResponse { } #[cfg(feature = "v2")] -impl PaymentsResponse { +impl PaymentAttemptListResponse { pub fn find_attempt_in_attempts_list_using_connector_transaction_id( - self, + &self, connector_transaction_id: &common_utils::types::ConnectorTransactionId, ) -> Option<PaymentAttemptResponse> { - self.attempts - .as_ref() - .and_then(\|attempts\| { - attempts.iter().find(\|attempt\| { - attempt - .connector_payment_id + self.payment_attempt_list.iter().find_map(\|attempt\| { + attempt + .connector_payment_id + .as_ref() + .filter(\|txn_id\| txn_id == connector_transaction_id) + .map(\|_\| attempt.clone()) + }) + } + pub fn find_attempt_in_attempts_list_using_charge_id( + &self, + charge_id: String, + ) -> Option<PaymentAttemptResponse> { + self.payment_attempt_list.iter().find_map(\|attempt\| { + attempt.feature_metadata.as_ref().and_then(\|metadata\| { + metadata.revenue_recovery.as_ref().and_then(\|recovery\| { + recovery + .charge_id .as_ref() - .is_some_and(\|txn_id\| txn_id == connector_transaction_id) + .filter(\|id\| *id == charge_id) + .map(\|_\| attempt.clone()) }) }) - .cloned() + }) } } diff --git a/crates/diesel_models/src/payment_attempt.rs b/crates/diesel_models/src/payment_attempt.rs index fa373d2305b..473502ad746 100644 --- a/crates/diesel_models/src/payment_attempt.rs +++ b/crates/diesel_models/src/payment_attempt.rs @@ -3708,6 +3708,8 @@ pub struct PaymentAttemptFeatureMetadata { #[diesel(sql_type = diesel::pg::sql_types::Jsonb)] pub struct PaymentAttemptRecoveryData { pub attempt_triggered_by: common_enums::TriggeredBy, + // stripe specific field used to identify duplicate attempts. + pub charge_id: Option<String>, } #[cfg(feature = "v2")] common_utils::impl_to_sql_from_sql_json!(PaymentAttemptFeatureMetadata); diff --git a/crates/hyperswitch_connectors/src/connectors/chargebee/transformers.rs b/crates/hyperswitch_connectors/src/connectors/chargebee/transformers.rs index 6436cd952e7..e0c84b4b459 100644 --- a/crates/hyperswitch_connectors/src/connectors/chargebee/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/chargebee/transformers.rs @@ -509,6 +509,8 @@ impl TryFrom<ChargebeeWebhookBody> for revenue_recovery::RevenueRecoveryAttemptD invoice_next_billing_time, card_network: Some(payment_method_details.card.brand), card_isin: Some(payment_method_details.card.iin), + // This field is none because it is specific to stripebilling. + charge_id: None, }) } } diff --git a/crates/hyperswitch_connectors/src/connectors/recurly/transformers.rs b/crates/hyperswitch_connectors/src/connectors/recurly/transformers.rs index 9ffd900dc45..70edb327ded 100644 --- a/crates/hyperswitch_connectors/src/connectors/recurly/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/recurly/transformers.rs @@ -208,6 +208,8 @@ impl ), card_network: Some(item.response.payment_method.card_type), card_isin: Some(item.response.payment_method.first_six), + // This none because this field is specific to stripebilling. + charge_id: None, }, ), ..item.data diff --git a/crates/hyperswitch_connectors/src/connectors/stripebilling/transformers.rs b/crates/hyperswitch_connectors/src/connectors/stripebilling/transformers.rs index 1352b874c8a..ca0875ba4ce 100644 --- a/crates/hyperswitch_connectors/src/connectors/stripebilling/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/stripebilling/transformers.rs @@ -561,6 +561,7 @@ impl )), // Todo: Fetch Card issuer details. Generally in the other billing connector we are getting card_issuer using the card bin info. But stripe dosent provide any such details. We should find a way for stripe billing case card_isin: None, + charge_id: Some(charge_details.charge_id.clone()), }, ), ..item.data diff --git a/crates/hyperswitch_domain_models/src/payments.rs b/crates/hyperswitch_domain_models/src/payments.rs index 99ce4ca17f3..25e194ca391 100644 --- a/crates/hyperswitch_domain_models/src/payments.rs +++ b/crates/hyperswitch_domain_models/src/payments.rs @@ -746,6 +746,8 @@ impl PaymentIntent { invoice_next_billing_time: None, card_isin: None, card_network: None, + // No charge id is present here since it is an internal payment and we didn't call connector yet. + charge_id: None, }) } diff --git a/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs b/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs index 56e0942431c..c35fbc3163e 100644 --- a/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs +++ b/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs @@ -726,6 +726,12 @@ impl PaymentAttempt { revenue_recovery: Some({ PaymentAttemptRevenueRecoveryData { attempt_triggered_by: request.triggered_by, + charge_id: request.feature_metadata.as_ref().and_then(\|metadata\| { + metadata + .revenue_recovery + .as_ref() + .and_then(\|data\| data.charge_id.clone()) + }), } }), }; @@ -2781,6 +2787,8 @@ pub struct PaymentAttemptFeatureMetadata { #[derive(Debug, Clone, serde::Serialize, PartialEq)] pub struct PaymentAttemptRevenueRecoveryData { pub attempt_triggered_by: common_enums::TriggeredBy, + // stripe specific field used to identify duplicate attempts. + pub charge_id: Option<String>, } #[cfg(feature = "v2")] @@ -2791,6 +2799,7 @@ impl From<&PaymentAttemptFeatureMetadata> for DieselPaymentAttemptFeatureMetadat .as_ref() .map(\|recovery_data\| DieselPassiveChurnRecoveryData { attempt_triggered_by: recovery_data.attempt_triggered_by, + charge_id: recovery_data.charge_id.clone(), }); Self { revenue_recovery } } @@ -2803,6 +2812,7 @@ impl From<DieselPaymentAttemptFeatureMetadata> for PaymentAttemptFeatureMetadata item.revenue_recovery .map(\|recovery_data\| PaymentAttemptRevenueRecoveryData { attempt_triggered_by: recovery_data.attempt_triggered_by, + charge_id: recovery_data.charge_id, }); Self { revenue_recovery } } diff --git a/crates/hyperswitch_domain_models/src/revenue_recovery.rs b/crates/hyperswitch_domain_models/src/revenue_recovery.rs index 837d5d90839..0485644628a 100644 --- a/crates/hyperswitch_domain_models/src/revenue_recovery.rs +++ b/crates/hyperswitch_domain_models/src/revenue_recovery.rs @@ -52,6 +52,8 @@ pub struct RevenueRecoveryAttemptData { pub card_network: Option<common_enums::CardNetwork>, /// card isin pub card_isin: Option<String>, + /// stripe specific id used to validate duplicate attempts in revenue recovery flow + pub charge_id: Option<String>, } /// This is unified struct for Revenue Recovery Invoice Data and it is constructed from billing connectors @@ -278,6 +280,7 @@ impl invoice_next_billing_time: invoice_details.next_billing_at, card_network: billing_connector_payment_details.card_network.clone(), card_isin: billing_connector_payment_details.card_isin.clone(), + charge_id: billing_connector_payment_details.charge_id.clone(), } } } diff --git a/crates/hyperswitch_domain_models/src/router_response_types/revenue_recovery.rs b/crates/hyperswitch_domain_models/src/router_response_types/revenue_recovery.rs index 8dd6aa2e74c..3df81e6b66d 100644 --- a/crates/hyperswitch_domain_models/src/router_response_types/revenue_recovery.rs +++ b/crates/hyperswitch_domain_models/src/router_response_types/revenue_recovery.rs @@ -32,6 +32,8 @@ pub struct BillingConnectorPaymentsSyncResponse { pub card_network: Option<common_enums::CardNetwork>, /// card isin pub card_isin: Option<String>, + /// stripe specific id used to validate duplicate attempts. + pub charge_id: Option<String>, } #[derive(Debug, Clone)] diff --git a/crates/router/src/core/payments/transformers.rs b/crates/router/src/core/payments/transformers.rs index 5d40a603cbb..65f526af2e3 100644 --- a/crates/router/src/core/payments/transformers.rs +++ b/crates/router/src/core/payments/transformers.rs @@ -4989,6 +4989,7 @@ impl let revenue_recovery = feature_metadata.revenue_recovery.as_ref().map(\|recovery\| { api_models::payments::PaymentAttemptRevenueRecoveryData { attempt_triggered_by: recovery.attempt_triggered_by, + charge_id: recovery.charge_id.clone(), } }); Self { revenue_recovery } diff --git a/crates/router/src/core/routing/helpers.rs b/crates/router/src/core/routing/helpers.rs index 1dd965a71ce..666d0020260 100644 --- a/crates/router/src/core/routing/helpers.rs +++ b/crates/router/src/core/routing/helpers.rs @@ -1539,7 +1539,7 @@ pub async fn push_metrics_with_update_window_for_contract_based_routing( routing_events::RoutingEngine::IntelligentRouter, routing_events::ApiMethod::Grpc) .change_context(errors::ApiErrorResponse::InternalServerError) - .attach_printable("ContractRouting-Intelligent-Router: Failed to contruct RoutingEventsBuilder")? + .attach_printable("ContractRouting-Intelligent-Router: Failed to construct RoutingEventsBuilder")? .trigger_event(state, closure) .await .change_context(errors::ApiErrorResponse::InternalServerError) diff --git a/crates/router/src/core/webhooks/recovery_incoming.rs b/crates/router/src/core/webhooks/recovery_incoming.rs index cc4e08861ac..f13caeefb76 100644 --- a/crates/router/src/core/webhooks/recovery_incoming.rs +++ b/crates/router/src/core/webhooks/recovery_incoming.rs @@ -467,45 +467,49 @@ impl RevenueRecoveryAttempt { )>, errors::RevenueRecoveryError, > { - let attempt_response = Box::pin(payments::payments_core::< - router_flow_types::payments::PSync, - api_payments::PaymentsResponse, - _, - _, - _, - hyperswitch_domain_models::payments::PaymentStatusData< - router_flow_types::payments::PSync, - >, - >( - state.clone(), - req_state.clone(), - merchant_context.clone(), - profile.clone(), - payments::operations::PaymentGet, - api_payments::PaymentsRetrieveRequest { - force_sync: false, - expand_attempts: true, - param: None, - all_keys_required: None, - merchant_connector_details: None, - }, - payment_intent.payment_id.clone(), - payments::CallConnectorAction::Avoid, - hyperswitch_domain_models::payments::HeaderPayload::default(), - )) - .await; + let attempt_response = + Box::pin(payments::payments_list_attempts_using_payment_intent_id::< + payments::operations::PaymentGetListAttempts, + api_payments::PaymentAttemptListResponse, + _, + payments::operations::payment_attempt_list::PaymentGetListAttempts, + hyperswitch_domain_models::payments::PaymentAttemptListData< + payments::operations::PaymentGetListAttempts, + >, + >( + state.clone(), + req_state.clone(), + merchant_context.clone(), + profile.clone(), + payments::operations::PaymentGetListAttempts, + api_payments::PaymentAttemptListRequest { + payment_intent_id: payment_intent.payment_id.clone(), + }, + payment_intent.payment_id.clone(), + hyperswitch_domain_models::payments::HeaderPayload::default(), + )) + .await; let response = match attempt_response { Ok(services::ApplicationResponse::JsonWithHeaders((payments_response, _))) => { - let final_attempt = - self.0 - .connector_transaction_id - .as_ref() - .and_then(\|transaction_id\| { - payments_response - .find_attempt_in_attempts_list_using_connector_transaction_id( - transaction_id, - ) - }); + let final_attempt = self + .0 + .charge_id + .as_ref() + .map(\|charge_id\| { + payments_response + .find_attempt_in_attempts_list_using_charge_id(charge_id.clone()) + }) + .unwrap_or_else(\|\| { + self.0 + .connector_transaction_id + .as_ref() + .and_then(\|transaction_id\| { + payments_response + .find_attempt_in_attempts_list_using_connector_transaction_id( + transaction_id, + ) + }) + }); let payment_attempt = final_attempt.map(\|attempt_res\| revenue_recovery::RecoveryPaymentAttempt { attempt_id: attempt_res.id.to_owned(), @@ -613,6 +617,7 @@ impl RevenueRecoveryAttempt { revenue_recovery: Some(api_payments::PaymentAttemptRevenueRecoveryData { // Since we are recording the external paymenmt attempt, this is hardcoded to External attempt_triggered_by: triggered_by, + charge_id: self.0.charge_id.clone(), }), };	2025-06-19T17:51:05Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [x] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> Previously we were using payment get to find whether attempt is present in db or not, but for the first invoice webhook there won't be any attempt present in db and recently we added a validation to use payment get only in case of attempt is present. This PR solves this issue by invoking payment get attempt list instead of payment get. Also for stripe billing / stripe connector_transaction_id remains same instead charge id keeps changing , so we added a support for this by checking if charge id is present we compare charge id if not we check for connector transaction id. ### Additional Changes - [x] This PR modifies the API contract - [x] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> Tested complete revenue recovery flow with stripebilling 1) Set up merchant and mca for billing and payment connector for stripebilling and stripe 2) Make sure merchant have retry_algorithm_type to cascading in business profile 3) Trigger payment invoice from stripe, after threshold external attempts , pt entry should be done in and start triggering internal payments. ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.114.0	7943fb4bfb156e22d5329d45a580f90e02283604	7943fb4bfb156e22d5329d45a580f90e02283604
juspay/hyperswitch	juspay__hyperswitch-8407	Bug: ci(connector): [ARCHIPEL] configure test cases Automate CI Checks by Fixing, Adding and Configuring Test Cases over:- - [Postman](https://github.com/juspay/hyperswitch/pull/8360) - [Cypress](https://github.com/juspay/hyperswitch/pull/8189)		2025-05-30T16:25:08Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [ ] New feature - [x] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [x] CI/CD ## Description <!-- Describe your changes in detail --> Enhancements for `archipel` Cypress Tests. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> `archipel` Cypress Tests were failing. ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> <!-- img width="720" alt="image" src="https://github.com/user-attachments/assets/23559711-59e2-41d7-8fb4-1572e524fc49" /--> <img width="726" height="962" alt="image" src="https://github.com/user-attachments/assets/ee72bc01-69a1-4afb-ac76-8c3edec1c124" /> _PS: There is an issue with Incremental Auth, not anything related to the configs, but the spec itself, addressing it in another PR because that would affect 1 other connector as well, and after it is fixed, it would affect 3 connectors in total._ ## Checklist <!-- Put an `x` in the boxes that apply --> - [ ] I formatted the code `cargo +nightly fmt --all` - [ ] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	8ccaac7c10e9366772e43d34f271d946cc4b3baa	8ccaac7c10e9366772e43d34f271d946cc4b3baa
juspay/hyperswitch	juspay__hyperswitch-8381	Bug: fix(openapi): Fix broken pages in mintlify (v2) v2 mintlify docs have several broken pages and some endpoints are missing.	diff --git a/api-reference/docs.json b/api-reference/docs.json index ecdf944452c..9688afc3241 100644 --- a/api-reference/docs.json +++ b/api-reference/docs.json @@ -265,11 +265,11 @@ "pages": [ "v2/payment-methods/payment-method--create", "v2/payment-methods/payment-method--create-intent", - "v2/payment-methods/payment-method--payment-methods-list", "v2/payment-methods/payment-method--confirm-intent", "v2/payment-methods/payment-method--update", "v2/payment-methods/payment-method--retrieve", "v2/payment-methods/payment-method--delete", + "v2/payment-methods/payment-method--list-customer-saved-payment-methods", "v2/payment-methods/list-saved-payment-methods-for-a-customer" ] }, @@ -291,13 +291,17 @@ "v2/customers/customers--retrieve", "v2/customers/customers--update", "v2/customers/customers--delete", - "v2/customers/customers--list", - "v2/customers/customers--list-saved-payment-methods" + "v2/customers/customers--list" ] }, { "group": "Refunds", - "pages": ["v2/refunds/refunds--create"] + "pages": [ + "v2/refunds/refunds--create", + "v2/refunds/refunds--metadata-update", + "v2/refunds/refunds--retrieve", + "v2/refunds/refunds--list" + ] } ] }, @@ -373,6 +377,10 @@ { "group": "Tokenization", "pages": ["v2/tokenization/tokenization--create"] + }, + { + "group": "Revenue Recovery", + "pages": ["v2/revenue-recovery/revenue-recovery--retrieve"] } ] } diff --git a/api-reference/v2/customers/customers--update.mdx b/api-reference/v2/customers/customers--update.mdx index 8d4bed86c97..c3e10b62564 100644 --- a/api-reference/v2/customers/customers--update.mdx +++ b/api-reference/v2/customers/customers--update.mdx @@ -1,3 +1,3 @@ --- -openapi: put /v2/customers/{id} +openapi: post /v2/customers/{id} --- diff --git a/api-reference/v2/openapi_spec_v2.json b/api-reference/v2/openapi_spec_v2.json index 0304eaf3b0c..783b7326766 100644 --- a/api-reference/v2/openapi_spec_v2.json +++ b/api-reference/v2/openapi_spec_v2.json @@ -1958,18 +1958,6 @@ "type": "string" }, "example": "pro_abcdefghijklmnop" - }, - { - "name": "X-Client-Secret", - "in": "header", - "description": "Client Secret Associated with the payment intent", - "required": true, - "schema": { - "type": "string" - }, - "example": { - "X-Client-Secret": "12345_pay_0193e41106e07e518940f8b51b9c8121_secret_0193e41107027a928d61d292e6a5dba9" - } } ], "requestBody": { @@ -2222,18 +2210,6 @@ "type": "string" }, "example": "pro_abcdefghijklmnop" - }, - { - "name": "X-Client-Secret", - "in": "header", - "description": "Client Secret Associated with the payment intent", - "required": true, - "schema": { - "type": "string" - }, - "example": { - "X-Client-Secret": "12345_pay_0193e41106e07e518940f8b51b9c8121_secret_0193e41107027a928d61d292e6a5dba9" - } } ], "responses": { @@ -3538,6 +3514,8 @@ "tags": [ "Tokenization" ], + "summary": "Tokenization - Create", + "description": "Create a token with customer_id", "operationId": "create_token_vault_api", "requestBody": { "content": { diff --git a/api-reference/v2/payment-method-session/payment-method-session--confirm-a-payment-method-session.mdx b/api-reference/v2/payment-method-session/payment-method-session--confirm-a-payment-method-session.mdx index d115fc72370..ed9cec389da 100644 --- a/api-reference/v2/payment-method-session/payment-method-session--confirm-a-payment-method-session.mdx +++ b/api-reference/v2/payment-method-session/payment-method-session--confirm-a-payment-method-session.mdx @@ -1,3 +1,3 @@ --- -openapi: post /v2/payment-method-session/:id/confirm +openapi: post /v2/payment-method-session/{id}/confirm --- \ No newline at end of file diff --git a/api-reference/v2/payment-method-session/payment-method-session--delete-a-saved-payment-method.mdx b/api-reference/v2/payment-method-session/payment-method-session--delete-a-saved-payment-method.mdx index 2f9e800ebe8..a4bcd483c6b 100644 --- a/api-reference/v2/payment-method-session/payment-method-session--delete-a-saved-payment-method.mdx +++ b/api-reference/v2/payment-method-session/payment-method-session--delete-a-saved-payment-method.mdx @@ -1,3 +1,3 @@ --- -openapi: delete /v2/payment-method-session/:id +openapi: delete /v2/payment-method-session/{id} --- diff --git a/api-reference/v2/payment-method-session/payment-method-session--list-payment-methods.mdx b/api-reference/v2/payment-method-session/payment-method-session--list-payment-methods.mdx index bbbaf01c297..1dc6cc5eb34 100644 --- a/api-reference/v2/payment-method-session/payment-method-session--list-payment-methods.mdx +++ b/api-reference/v2/payment-method-session/payment-method-session--list-payment-methods.mdx @@ -1,3 +1,3 @@ --- -openapi: get /v2/payment-method-session/:id/list-payment-methods +openapi: get /v2/payment-method-session/{id}/list-payment-methods --- \ No newline at end of file diff --git a/api-reference/v2/payment-method-session/payment-method-session--retrieve.mdx b/api-reference/v2/payment-method-session/payment-method-session--retrieve.mdx index 3f0ab4a7461..4e504390a45 100644 --- a/api-reference/v2/payment-method-session/payment-method-session--retrieve.mdx +++ b/api-reference/v2/payment-method-session/payment-method-session--retrieve.mdx @@ -1,3 +1,3 @@ --- -openapi: get /v2/payment-method-session/:id +openapi: get /v2/payment-method-session/{id} --- \ No newline at end of file diff --git a/api-reference/v2/payment-method-session/payment-method-session--update-a-saved-payment-method.mdx b/api-reference/v2/payment-method-session/payment-method-session--update-a-saved-payment-method.mdx index fab85e2a419..f7e887dbb96 100644 --- a/api-reference/v2/payment-method-session/payment-method-session--update-a-saved-payment-method.mdx +++ b/api-reference/v2/payment-method-session/payment-method-session--update-a-saved-payment-method.mdx @@ -1,3 +1,3 @@ --- -openapi: put /v2/payment-method-session/:id/update-saved-payment-method +openapi: put /v2/payment-method-session/{id}/update-saved-payment-method --- diff --git a/api-reference/v2/payment-methods/list-customer-saved-payment-methods-for-a-payment.mdx b/api-reference/v2/payment-methods/list-customer-saved-payment-methods-for-a-payment.mdx deleted file mode 100644 index 7809830b820..00000000000 --- a/api-reference/v2/payment-methods/list-customer-saved-payment-methods-for-a-payment.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: get /v2/payments/{id}/saved-payment-methods ---- \ No newline at end of file diff --git a/api-reference/v2/payment-methods/list-payment-methods-for-a-customer.mdx b/api-reference/v2/payment-methods/list-payment-methods-for-a-customer.mdx deleted file mode 100644 index ef5a27f9604..00000000000 --- a/api-reference/v2/payment-methods/list-payment-methods-for-a-customer.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: get /v2/customers/{id}/saved-payment-methods ---- \ No newline at end of file diff --git a/api-reference/v2/payment-methods/list-saved-payment-methods-for-a-customer.mdx b/api-reference/v2/payment-methods/list-saved-payment-methods-for-a-customer.mdx deleted file mode 100644 index ef5a27f9604..00000000000 --- a/api-reference/v2/payment-methods/list-saved-payment-methods-for-a-customer.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: get /v2/customers/{id}/saved-payment-methods ---- \ No newline at end of file diff --git a/api-reference/v2/customers/customers--list-saved-payment-methods.mdx b/api-reference/v2/payment-methods/payment-method--list-customer-saved-payment-methods.mdx similarity index 100% rename from api-reference/v2/customers/customers--list-saved-payment-methods.mdx rename to api-reference/v2/payment-methods/payment-method--list-customer-saved-payment-methods.mdx diff --git a/api-reference/v2/refunds/refunds--list.mdx b/api-reference/v2/refunds/refunds--list.mdx new file mode 100644 index 00000000000..18167989707 --- /dev/null +++ b/api-reference/v2/refunds/refunds--list.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /v2/refunds/list +--- \ No newline at end of file diff --git a/api-reference/v2/refunds/refunds--metadata-update.mdx b/api-reference/v2/refunds/refunds--metadata-update.mdx new file mode 100644 index 00000000000..52695bf10fb --- /dev/null +++ b/api-reference/v2/refunds/refunds--metadata-update.mdx @@ -0,0 +1,3 @@ +--- +openapi: put /v2/refunds/{id}/update_metadata +--- \ No newline at end of file diff --git a/api-reference/v2/refunds/refunds--retrieve.mdx b/api-reference/v2/refunds/refunds--retrieve.mdx new file mode 100644 index 00000000000..bd73db1a72e --- /dev/null +++ b/api-reference/v2/refunds/refunds--retrieve.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /v2/refunds/{id} +--- \ No newline at end of file diff --git a/api-reference/v2/revenue-recovery/revenue-recovery--retrieve.mdx b/api-reference/v2/revenue-recovery/revenue-recovery--retrieve.mdx new file mode 100644 index 00000000000..119f750a7ac --- /dev/null +++ b/api-reference/v2/revenue-recovery/revenue-recovery--retrieve.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /v2/process_tracker/revenue_recovery_workflow/{revenue_recovery_id} +--- \ No newline at end of file diff --git a/crates/openapi/src/routes/payments.rs b/crates/openapi/src/routes/payments.rs index 6160b68b44b..2d25ca4f77f 100644 --- a/crates/openapi/src/routes/payments.rs +++ b/crates/openapi/src/routes/payments.rs @@ -923,12 +923,7 @@ pub fn payments_update_intent() {} "X-Profile-Id" = String, Header, description = "Profile ID associated to the payment intent", example = "pro_abcdefghijklmnop" - ), - ( - "X-Client-Secret" = String, Header, - description = "Client Secret Associated with the payment intent", - example = json!({"X-Client-Secret": "12345_pay_0193e41106e07e518940f8b51b9c8121_secret_0193e41107027a928d61d292e6a5dba9"}) - ), + ) ), request_body( content = PaymentsConfirmIntentRequest, @@ -1058,11 +1053,6 @@ pub(crate) enum ForceSync { description = "Profile ID associated to the payment intent", example = "pro_abcdefghijklmnop" ), - ( - "X-Client-Secret" = String, Header, - description = "Client Secret Associated with the payment intent", - example = json!({"X-Client-Secret": "12345_pay_0193e41106e07e518940f8b51b9c8121_secret_0193e41107027a928d61d292e6a5dba9"}) - ), ), responses( (status = 200, description = "Get the payment methods", body = PaymentMethodListResponseForPayments), diff --git a/crates/openapi/src/routes/tokenization.rs b/crates/openapi/src/routes/tokenization.rs index 22f1227a9c0..d69008911ce 100644 --- a/crates/openapi/src/routes/tokenization.rs +++ b/crates/openapi/src/routes/tokenization.rs @@ -1,6 +1,9 @@ use serde_json::json; use utoipa::OpenApi; +/// Tokenization - Create +/// +/// Create a token with customer_id #[cfg(feature = "v2")] #[utoipa::path( post,	2025-06-18T18:02:28Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [x] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [x] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> Fixed the following mintlify pages: - `v2/customers/customers--update.mdx` - `payment-method-session--confirm-a-payment-method-session.mdx` - `payment-method-session--delete-a-saved-payment-method.mdx` - `payment-method-session--list-payment-methods.mdx` - `payment-method-session--retrieve.mdx` - `payment-method-session--update-a-saved-payment-method.mdx` Added the following missing pages: - `payment-method--list-customer-saved-payment-methods.mdx` - `refunds--list.mdx` - `refunds--metadata-update.mdx` - `refunds--retrieve.mdx` - `revenue-recovery--retrieve.mdx` ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> Closes #8381 ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> Verified with `mint dev` ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.114.0	17c30b6105d9086585edac0c89432b1f4568c3de	17c30b6105d9086585edac0c89432b1f4568c3de
juspay/hyperswitch	juspay__hyperswitch-8386	Bug: Api contract changes to accept `saving_percentage` in the decision engine response Api contract changes to accept `saving_percentage` in the decision engine response	diff --git a/crates/api_models/src/open_router.rs b/crates/api_models/src/open_router.rs index af91ece3f12..5d5f8f016c0 100644 --- a/crates/api_models/src/open_router.rs +++ b/crates/api_models/src/open_router.rs @@ -67,17 +67,32 @@ pub struct DecidedGateway { #[derive(Debug, Serialize, Deserialize, PartialEq, Clone)] pub struct DebitRoutingOutput { - pub co_badged_card_networks: Vec<common_enums::CardNetwork>, + pub co_badged_card_networks_info: Vec<CoBadgedCardNetworksInfo>, pub issuer_country: common_enums::CountryAlpha2, pub is_regulated: bool, pub regulated_name: Option<common_enums::RegulatedName>, pub card_type: common_enums::CardType, } +#[derive(Debug, Serialize, Deserialize, PartialEq, Clone)] +pub struct CoBadgedCardNetworksInfo { + pub network: common_enums::CardNetwork, + pub saving_percentage: f64, +} + +impl DebitRoutingOutput { + pub fn get_co_badged_card_networks(&self) -> Vec<common_enums::CardNetwork> { + self.co_badged_card_networks_info + .iter() + .map(\|data\| data.network.clone()) + .collect() + } +} + impl From<&DebitRoutingOutput> for payment_methods::CoBadgedCardData { fn from(output: &DebitRoutingOutput) -> Self { Self { - co_badged_card_networks: output.co_badged_card_networks.clone(), + co_badged_card_networks: output.get_co_badged_card_networks(), issuer_country_code: output.issuer_country, is_regulated: output.is_regulated, regulated_name: output.regulated_name.clone(), @@ -96,7 +111,7 @@ impl TryFrom<(payment_methods::CoBadgedCardData, String)> for DebitRoutingReques })?; Ok(Self { - co_badged_card_networks: output.co_badged_card_networks, + co_badged_card_networks_info: output.co_badged_card_networks, issuer_country: output.issuer_country_code, is_regulated: output.is_regulated, regulated_name: output.regulated_name, @@ -114,7 +129,7 @@ pub struct CoBadgedCardRequest { #[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] pub struct DebitRoutingRequestData { - pub co_badged_card_networks: Vec<common_enums::CardNetwork>, + pub co_badged_card_networks_info: Vec<common_enums::CardNetwork>, pub issuer_country: common_enums::CountryAlpha2, pub is_regulated: bool, pub regulated_name: Option<common_enums::RegulatedName>, diff --git a/crates/router/src/core/debit_routing.rs b/crates/router/src/core/debit_routing.rs index c7de440bbf6..ca03f5d2532 100644 --- a/crates/router/src/core/debit_routing.rs +++ b/crates/router/src/core/debit_routing.rs @@ -256,8 +256,8 @@ where get_debit_routing_output::<F, D>(state, payment_data, acquirer_country).await?; logger::debug!( - "Sorted co-badged networks: {:?}", - debit_routing_output.co_badged_card_networks + "Sorted co-badged networks info: {:?}", + debit_routing_output.co_badged_card_networks_info ); let key_store = db @@ -281,7 +281,7 @@ where &profile_id, &key_store, vec![connector_data.clone()], - debit_routing_output.co_badged_card_networks.clone(), + debit_routing_output.get_co_badged_card_networks(), ) .await .map_err(\|error\| { @@ -455,7 +455,7 @@ where &profile_id, &key_store, connector_data_list.clone(), - debit_routing_output.co_badged_card_networks.clone(), + debit_routing_output.get_co_badged_card_networks(), ) .await .map_err(\|error\| {	2025-06-19T08:01:15Z	<!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [ ] New feature - [ ] Enhancement - [x] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> This pull request refactors the `DebitRoutingOutput` structure to introduce a new `CoBadgedCardNetworksInfo` type, enhancing the representation of co-badged card networks by including additional metadata such as saving percentages. It also updates related methods and structures to align with this change. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> -> Enable debit routing for a profile and configure adyen connector -> Make a payment ``` curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'x-feature: router-custom' \ --header 'x-tenant-id: hyperswitch' \ --header 'api-key: ' \ --data-raw '{ "amount": 10000, "amount_to_capture": 10000, "currency": "USD", "confirm": true, "capture_method": "automatic", "setup_future_usage": "on_session", "capture_on": "2022-09-10T10:11:12Z", "email": "[email protected]", "name": "John Doe", "phone": "999999999", "phone_country_code": "+1", "description": "Its my first payment request", "authentication_type": "no_three_ds", "customer_id": "cu_1750319776", "return_url": "http://127.0.0.1:4040", "payment_method": "card", "payment_method_type": "debit", "payment_method_data": { "card": { "card_number": "4400 0020 0000 0004", "card_exp_month": "03", "card_exp_year": "2030", "card_holder_name": "joseph Doe", "card_cvc": "737" } }, "billing": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San", "state": "California", "zip": "94122", "country": "US", "first_name": "PiX", "last_name": "ss" }, "email": "[email protected]" }, "shipping": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "PiX" } }, "customer_acceptance": { "acceptance_type": "offline", "accepted_at": "1963-05-03T04:07:52.723Z", "online": { "ip_address": "in sit", "user_agent": "amet irure esse" } }, "browser_info": { "user_agent": "Mozilla\/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/70.0.3538.110 Safari\/537.36", "accept_header": "text\/html,application\/xhtml+xml,application\/xml;q=0.9,image\/webp,image\/apng,\/;q=0.8", "language": "nl-NL", "color_depth": 24, "screen_height": 723, "screen_width": 1536, "time_zone": 0, "java_enabled": true, "java_script_enabled": true, "ip_address": "125.0.0.1" }, "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "metadata": { "udf1": "value1", "new_customer": "true", "login_date": "2019-09-10T10:11:12Z" } }' ``` ``` { "payment_id": "pay_7aTZkTRH72iemhbxOqvc", "merchant_id": "merchant_1750232289", "status": "succeeded", "amount": 10000, "net_amount": 10000, "shipping_cost": null, "amount_capturable": 0, "amount_received": 10000, "connector": "adyen", "client_secret": "pay_7aTZkTRH72iemhbxOqvc_secret_2v6ATAqLFQsKVhms16hF", "created": "2025-06-18T07:40:06.149Z", "currency": "USD", "customer_id": "cu_1750232406", "customer": { "id": "cu_1750232406", "name": "John Doe", "email": "[email protected]", "phone": "999999999", "phone_country_code": "+1" }, "description": "Its my first payment request", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": "on_session", "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "card", "payment_method_data": { "card": { "last4": "0004", "card_type": null, "card_network": "Accel", "card_issuer": null, "card_issuing_country": null, "card_isin": "440000", "card_extended_bin": null, "card_exp_month": "03", "card_exp_year": "2030", "card_holder_name": "joseph Doe", "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "PiX", "last_name": null }, "phone": null, "email": null }, "billing": { "address": { "city": "San", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "PiX", "last_name": "ss" }, "phone": null, "email": "[email protected]" }, "order_details": null, "email": "[email protected]", "name": "John Doe", "phone": "999999999", "return_url": "http://127.0.0.1:4040/", "authentication_type": "no_three_ds", "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "debit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": { "customer_id": "cu_1750232406", "created_at": 1750232406, "expires": 1750236006, "secret": "epk_1a8a73a55db941eb89b3c5a54b42bc3d" }, "manual_retry_allowed": false, "connector_transaction_id": "JKCHRB6V9DDHL975", "frm_message": null, "metadata": { "udf1": "value1", "login_date": "2019-09-10T10:11:12Z", "new_customer": "true" }, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_7aTZkTRH72iemhbxOqvc_1", "payment_link": null, "profile_id": "pro_n23wrYOtUyaiFMM71SEq", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_xC22XUKnNCBkg5vHm1W0", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-06-18T07:55:06.149Z", "fingerprint": null, "browser_info": { "language": "nl-NL", "time_zone": 0, "ip_address": "125.0.0.1", "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "color_depth": 24, "java_enabled": true, "screen_width": 1536, "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8", "screen_height": 723, "java_script_enabled": true }, "payment_method_id": null, "payment_method_status": null, "updated": "2025-06-18T07:40:07.133Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` Once the payment is done the api events should have the `saving_percentage` in the decision engine response ``` { "decided_gateway": "ADYEN", "gateway_priority_map": null, "filter_wise_gateways": null, "priority_logic_tag": null, "routing_approach": "NONE", "gateway_before_evaluation": null, "priority_logic_output": null, "debit_routing_output": { "co_badged_card_networks_info": [ { "network": "ACCEL", "saving_percentage": 0.14 }, { "network": "STAR", "saving_percentage": 0.04 }, { "network": "VISA", "saving_percentage": 0.0 } ], "issuer_country": "US", "is_regulated": true, "regulated_name": "GOVERNMENT EXEMPT INTERCHANGE FEE", "card_type": "debit" }, "reset_approach": "NO_RESET", "routing_dimension": null, "routing_dimension_level": null, "is_scheduled_outage": false, "is_dynamic_mga_enabled": false, "gateway_mga_id_map": null } ``` ## Checklist <!-- Put an `x` in the boxes that apply --> - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.114.0	305ca9bda9d3c5bf3cc97458b7ed07b79e894154	305ca9bda9d3c5bf3cc97458b7ed07b79e894154
juspay/hyperswitch	juspay__hyperswitch-8409	Bug: [FEATURE] Add routing metrics endpoint ### Feature Description Need to add an endpoint for routing metrics. Also add routing approach as a filter in payment analytics ### Possible Implementation Need to add an endpoint for routing metrics. Also add routing approach as a filter in payment analytics ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? Yes, I am willing to submit a PR!	diff --git a/crates/analytics/docs/clickhouse/scripts/payment_attempts.sql b/crates/analytics/docs/clickhouse/scripts/payment_attempts.sql index f5d0ca51fd7..6673b73fedb 100644 --- a/crates/analytics/docs/clickhouse/scripts/payment_attempts.sql +++ b/crates/analytics/docs/clickhouse/scripts/payment_attempts.sql @@ -43,6 +43,7 @@ CREATE TABLE payment_attempt_queue ( `organization_id` String, `profile_id` String, `card_network` Nullable(String), + `routing_approach` LowCardinality(Nullable(String)), `sign_flag` Int8 ) ENGINE = Kafka SETTINGS kafka_broker_list = 'kafka0:29092', kafka_topic_list = 'hyperswitch-payment-attempt-events', @@ -96,6 +97,7 @@ CREATE TABLE payment_attempts ( `organization_id` String, `profile_id` String, `card_network` Nullable(String), + `routing_approach` LowCardinality(Nullable(String)), `sign_flag` Int8, INDEX connectorIndex connector TYPE bloom_filter GRANULARITY 1, INDEX paymentMethodIndex payment_method TYPE bloom_filter GRANULARITY 1, @@ -152,6 +154,7 @@ CREATE MATERIALIZED VIEW payment_attempt_mv TO payment_attempts ( `organization_id` String, `profile_id` String, `card_network` Nullable(String), + `routing_approach` LowCardinality(Nullable(String)), `sign_flag` Int8 ) AS SELECT @@ -200,6 +203,7 @@ SELECT organization_id, profile_id, card_network, + routing_approach, sign_flag FROM payment_attempt_queue diff --git a/crates/analytics/src/core.rs b/crates/analytics/src/core.rs index 980e17bc90a..f3dd8e8eb8c 100644 --- a/crates/analytics/src/core.rs +++ b/crates/analytics/src/core.rs @@ -46,6 +46,11 @@ pub async fn get_domain_info( download_dimensions: None, dimensions: utils::get_dispute_dimensions(), }, + AnalyticsDomain::Routing => GetInfoResponse { + metrics: utils::get_payment_metrics_info(), + download_dimensions: None, + dimensions: utils::get_payment_dimensions(), + }, }; Ok(info) } diff --git a/crates/analytics/src/payments/core.rs b/crates/analytics/src/payments/core.rs index 7291d2f1fcc..e55ba2726af 100644 --- a/crates/analytics/src/payments/core.rs +++ b/crates/analytics/src/payments/core.rs @@ -410,6 +410,7 @@ pub async fn get_filters( PaymentDimensions::CardLast4 => fil.card_last_4, PaymentDimensions::CardIssuer => fil.card_issuer, PaymentDimensions::ErrorReason => fil.error_reason, + PaymentDimensions::RoutingApproach => fil.routing_approach.map(\|i\| i.as_ref().to_string()), }) .collect::<Vec<String>>(); res.query_data.push(FilterValue { diff --git a/crates/analytics/src/payments/distribution.rs b/crates/analytics/src/payments/distribution.rs index 86a2f06c5f5..ab82e48f407 100644 --- a/crates/analytics/src/payments/distribution.rs +++ b/crates/analytics/src/payments/distribution.rs @@ -37,6 +37,7 @@ pub struct PaymentDistributionRow { pub total: Option<bigdecimal::BigDecimal>, pub count: Option<i64>, pub error_message: Option<String>, + pub routing_approach: Option<DBEnumWrapper<storage_enums::RoutingApproach>>, #[serde(with = "common_utils::custom_serde::iso8601::option")] pub start_bucket: Option<PrimitiveDateTime>, #[serde(with = "common_utils::custom_serde::iso8601::option")] diff --git a/crates/analytics/src/payments/distribution/payment_error_message.rs b/crates/analytics/src/payments/distribution/payment_error_message.rs index 0a92cfbe470..d5fa0569452 100644 --- a/crates/analytics/src/payments/distribution/payment_error_message.rs +++ b/crates/analytics/src/payments/distribution/payment_error_message.rs @@ -160,6 +160,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(\|i\| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/filters.rs b/crates/analytics/src/payments/filters.rs index 668bdaa6c8b..b6ebf094e81 100644 --- a/crates/analytics/src/payments/filters.rs +++ b/crates/analytics/src/payments/filters.rs @@ -1,6 +1,6 @@ use api_models::analytics::{payments::PaymentDimensions, Granularity, TimeRange}; use common_utils::errors::ReportSwitchExt; -use diesel_models::enums::{AttemptStatus, AuthenticationType, Currency}; +use diesel_models::enums::{AttemptStatus, AuthenticationType, Currency, RoutingApproach}; use error_stack::ResultExt; use time::PrimitiveDateTime; @@ -65,4 +65,5 @@ pub struct PaymentFilterRow { pub card_issuer: Option<String>, pub error_reason: Option<String>, pub first_attempt: Option<bool>, + pub routing_approach: Option<DBEnumWrapper<RoutingApproach>>, } diff --git a/crates/analytics/src/payments/metrics.rs b/crates/analytics/src/payments/metrics.rs index 71d2e57d7fa..67dc50c5152 100644 --- a/crates/analytics/src/payments/metrics.rs +++ b/crates/analytics/src/payments/metrics.rs @@ -50,6 +50,7 @@ pub struct PaymentMetricRow { pub first_attempt: Option<bool>, pub total: Option<bigdecimal::BigDecimal>, pub count: Option<i64>, + pub routing_approach: Option<DBEnumWrapper<storage_enums::RoutingApproach>>, #[serde(with = "common_utils::custom_serde::iso8601::option")] pub start_bucket: Option<PrimitiveDateTime>, #[serde(with = "common_utils::custom_serde::iso8601::option")] diff --git a/crates/analytics/src/payments/metrics/avg_ticket_size.rs b/crates/analytics/src/payments/metrics/avg_ticket_size.rs index 10f350e30ce..8ec175cf8da 100644 --- a/crates/analytics/src/payments/metrics/avg_ticket_size.rs +++ b/crates/analytics/src/payments/metrics/avg_ticket_size.rs @@ -122,6 +122,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(\|i\| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/connector_success_rate.rs b/crates/analytics/src/payments/metrics/connector_success_rate.rs index 9e6bf31fbfb..eb4518f6d23 100644 --- a/crates/analytics/src/payments/metrics/connector_success_rate.rs +++ b/crates/analytics/src/payments/metrics/connector_success_rate.rs @@ -117,6 +117,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(\|i\| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/payment_count.rs b/crates/analytics/src/payments/metrics/payment_count.rs index 297aef4fec5..ed23a400fb7 100644 --- a/crates/analytics/src/payments/metrics/payment_count.rs +++ b/crates/analytics/src/payments/metrics/payment_count.rs @@ -108,6 +108,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(\|i\| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/payment_processed_amount.rs b/crates/analytics/src/payments/metrics/payment_processed_amount.rs index 95846924665..302acf097ed 100644 --- a/crates/analytics/src/payments/metrics/payment_processed_amount.rs +++ b/crates/analytics/src/payments/metrics/payment_processed_amount.rs @@ -122,6 +122,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(\|i\| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/payment_success_count.rs b/crates/analytics/src/payments/metrics/payment_success_count.rs index 843e2858977..d1f437d812d 100644 --- a/crates/analytics/src/payments/metrics/payment_success_count.rs +++ b/crates/analytics/src/payments/metrics/payment_success_count.rs @@ -115,6 +115,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(\|i\| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/retries_count.rs b/crates/analytics/src/payments/metrics/retries_count.rs index ced845651cf..63ebfaefca6 100644 --- a/crates/analytics/src/payments/metrics/retries_count.rs +++ b/crates/analytics/src/payments/metrics/retries_count.rs @@ -112,6 +112,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(\|i\| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/sessionized_metrics/avg_ticket_size.rs b/crates/analytics/src/payments/metrics/sessionized_metrics/avg_ticket_size.rs index e29c19bda88..a5138777361 100644 --- a/crates/analytics/src/payments/metrics/sessionized_metrics/avg_ticket_size.rs +++ b/crates/analytics/src/payments/metrics/sessionized_metrics/avg_ticket_size.rs @@ -123,6 +123,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(\|i\| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/sessionized_metrics/connector_success_rate.rs b/crates/analytics/src/payments/metrics/sessionized_metrics/connector_success_rate.rs index d8ee7fcb473..626f11aa229 100644 --- a/crates/analytics/src/payments/metrics/sessionized_metrics/connector_success_rate.rs +++ b/crates/analytics/src/payments/metrics/sessionized_metrics/connector_success_rate.rs @@ -118,6 +118,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(\|i\| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/sessionized_metrics/failure_reasons.rs b/crates/analytics/src/payments/metrics/sessionized_metrics/failure_reasons.rs index d6944d8d0bd..f19185b345e 100644 --- a/crates/analytics/src/payments/metrics/sessionized_metrics/failure_reasons.rs +++ b/crates/analytics/src/payments/metrics/sessionized_metrics/failure_reasons.rs @@ -183,6 +183,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(\|i\| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/sessionized_metrics/payment_count.rs b/crates/analytics/src/payments/metrics/sessionized_metrics/payment_count.rs index 98735b9383a..79d57477e13 100644 --- a/crates/analytics/src/payments/metrics/sessionized_metrics/payment_count.rs +++ b/crates/analytics/src/payments/metrics/sessionized_metrics/payment_count.rs @@ -109,6 +109,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(\|i\| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/sessionized_metrics/payment_processed_amount.rs b/crates/analytics/src/payments/metrics/sessionized_metrics/payment_processed_amount.rs index 453f988d229..0a2ab1f8a23 100644 --- a/crates/analytics/src/payments/metrics/sessionized_metrics/payment_processed_amount.rs +++ b/crates/analytics/src/payments/metrics/sessionized_metrics/payment_processed_amount.rs @@ -140,6 +140,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(\|i\| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/sessionized_metrics/payment_success_count.rs b/crates/analytics/src/payments/metrics/sessionized_metrics/payment_success_count.rs index 14391588b48..e59402933aa 100644 --- a/crates/analytics/src/payments/metrics/sessionized_metrics/payment_success_count.rs +++ b/crates/analytics/src/payments/metrics/sessionized_metrics/payment_success_count.rs @@ -116,6 +116,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(\|i\| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/sessionized_metrics/payments_distribution.rs b/crates/analytics/src/payments/metrics/sessionized_metrics/payments_distribution.rs index 5c6a8c6adec..d7305cd0792 100644 --- a/crates/analytics/src/payments/metrics/sessionized_metrics/payments_distribution.rs +++ b/crates/analytics/src/payments/metrics/sessionized_metrics/payments_distribution.rs @@ -119,6 +119,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(\|i\| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/sessionized_metrics/retries_count.rs b/crates/analytics/src/payments/metrics/sessionized_metrics/retries_count.rs index 7d81c48274b..83307d75f7a 100644 --- a/crates/analytics/src/payments/metrics/sessionized_metrics/retries_count.rs +++ b/crates/analytics/src/payments/metrics/sessionized_metrics/retries_count.rs @@ -112,6 +112,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(\|i\| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/sessionized_metrics/success_rate.rs b/crates/analytics/src/payments/metrics/sessionized_metrics/success_rate.rs index f20308ed3b1..8159a615ba8 100644 --- a/crates/analytics/src/payments/metrics/sessionized_metrics/success_rate.rs +++ b/crates/analytics/src/payments/metrics/sessionized_metrics/success_rate.rs @@ -112,6 +112,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(\|i\| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/success_rate.rs b/crates/analytics/src/payments/metrics/success_rate.rs index 6698fe8ce65..032f3219a68 100644 --- a/crates/analytics/src/payments/metrics/success_rate.rs +++ b/crates/analytics/src/payments/metrics/success_rate.rs @@ -111,6 +111,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(\|i\| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/types.rs b/crates/analytics/src/payments/types.rs index b9af3cd0610..7bb23d7af78 100644 --- a/crates/analytics/src/payments/types.rs +++ b/crates/analytics/src/payments/types.rs @@ -109,6 +109,16 @@ where .add_filter_in_range_clause("first_attempt", &self.first_attempt) .attach_printable("Error adding first attempt filter")?; } + + if !self.routing_approach.is_empty() { + builder + .add_filter_in_range_clause( + PaymentDimensions::RoutingApproach, + &self.routing_approach, + ) + .attach_printable("Error adding routing approach filter")?; + } + Ok(()) } } diff --git a/crates/analytics/src/query.rs b/crates/analytics/src/query.rs index 5effd9e70a7..50d16c68e6f 100644 --- a/crates/analytics/src/query.rs +++ b/crates/analytics/src/query.rs @@ -15,7 +15,7 @@ use api_models::{ }, enums::{ AttemptStatus, AuthenticationType, Connector, Currency, DisputeStage, IntentStatus, - PaymentMethod, PaymentMethodType, + PaymentMethod, PaymentMethodType, RoutingApproach, }, refunds::RefundStatus, }; @@ -514,7 +514,8 @@ impl_to_sql_for_to_string!( &bool, &u64, u64, - Order + Order, + RoutingApproach ); impl_to_sql_for_to_string!( diff --git a/crates/analytics/src/sqlx.rs b/crates/analytics/src/sqlx.rs index 028a1ddc143..53b9cc10e10 100644 --- a/crates/analytics/src/sqlx.rs +++ b/crates/analytics/src/sqlx.rs @@ -13,7 +13,7 @@ use common_utils::{ }; use diesel_models::enums::{ AttemptStatus, AuthenticationType, Currency, FraudCheckStatus, IntentStatus, PaymentMethod, - RefundStatus, + RefundStatus, RoutingApproach, }; use error_stack::ResultExt; use sqlx::{ @@ -103,6 +103,7 @@ db_type!(AuthenticationStatus); db_type!(TransactionStatus); db_type!(AuthenticationConnectors); db_type!(DecoupledAuthenticationType); +db_type!(RoutingApproach); impl<'q, Type> Encode<'q, Postgres> for DBEnumWrapper<Type> where @@ -730,6 +731,11 @@ impl<'a> FromRow<'a, PgRow> for super::payments::metrics::PaymentMetricRow { ColumnNotFound(_) => Ok(Default::default()), e => Err(e), })?; + let routing_approach: Option<DBEnumWrapper<RoutingApproach>> = + row.try_get("routing_approach").or_else(\|e\| match e { + ColumnNotFound(_) => Ok(Default::default()), + e => Err(e), + })?; let total: Option<bigdecimal::BigDecimal> = row.try_get("total").or_else(\|e\| match e { ColumnNotFound(_) => Ok(Default::default()), e => Err(e), @@ -761,6 +767,7 @@ impl<'a> FromRow<'a, PgRow> for super::payments::metrics::PaymentMetricRow { card_issuer, error_reason, first_attempt, + routing_approach, total, count, start_bucket, @@ -833,6 +840,11 @@ impl<'a> FromRow<'a, PgRow> for super::payments::distribution::PaymentDistributi ColumnNotFound(_) => Ok(Default::default()), e => Err(e), })?; + let routing_approach: Option<DBEnumWrapper<RoutingApproach>> = + row.try_get("routing_approach").or_else(\|e\| match e { + ColumnNotFound(_) => Ok(Default::default()), + e => Err(e), + })?; let total: Option<bigdecimal::BigDecimal> = row.try_get("total").or_else(\|e\| match e { ColumnNotFound(_) => Ok(Default::default()), e => Err(e), @@ -875,6 +887,7 @@ impl<'a> FromRow<'a, PgRow> for super::payments::distribution::PaymentDistributi total, count, error_message, + routing_approach, start_bucket, end_bucket, }) @@ -949,6 +962,11 @@ impl<'a> FromRow<'a, PgRow> for super::payments::filters::PaymentFilterRow { ColumnNotFound(_) => Ok(Default::default()), e => Err(e), })?; + let routing_approach: Option<DBEnumWrapper<RoutingApproach>> = + row.try_get("routing_approach").or_else(\|e\| match e { + ColumnNotFound(_) => Ok(Default::default()), + e => Err(e), + })?; Ok(Self { currency, status, @@ -965,6 +983,7 @@ impl<'a> FromRow<'a, PgRow> for super::payments::filters::PaymentFilterRow { card_issuer, error_reason, first_attempt, + routing_approach, }) } } diff --git a/crates/analytics/src/types.rs b/crates/analytics/src/types.rs index 28ff2cec8bd..4f9a7655ede 100644 --- a/crates/analytics/src/types.rs +++ b/crates/analytics/src/types.rs @@ -21,6 +21,7 @@ pub enum AnalyticsDomain { SdkEvents, ApiEvents, Dispute, + Routing, } #[derive(Debug, strum::AsRefStr, strum::Display, Clone, Copy)] diff --git a/crates/analytics/src/utils.rs b/crates/analytics/src/utils.rs index 06cc998f3da..36121e56ebb 100644 --- a/crates/analytics/src/utils.rs +++ b/crates/analytics/src/utils.rs @@ -24,6 +24,7 @@ pub fn get_payment_dimensions() -> Vec<NameDescription> { PaymentDimensions::ProfileId, PaymentDimensions::CardNetwork, PaymentDimensions::MerchantId, + PaymentDimensions::RoutingApproach, ] .into_iter() .map(Into::into) diff --git a/crates/api_models/src/analytics/payments.rs b/crates/api_models/src/analytics/payments.rs index 691e827043f..537d6df09d1 100644 --- a/crates/api_models/src/analytics/payments.rs +++ b/crates/api_models/src/analytics/payments.rs @@ -8,7 +8,7 @@ use common_utils::id_type; use super::{ForexMetric, NameDescription, TimeRange}; use crate::enums::{ AttemptStatus, AuthenticationType, CardNetwork, Connector, Currency, PaymentMethod, - PaymentMethodType, + PaymentMethodType, RoutingApproach, }; #[derive(Clone, Debug, Default, serde::Deserialize, serde::Serialize)] @@ -43,6 +43,8 @@ pub struct PaymentFilters { pub error_reason: Vec<String>, #[serde(default)] pub first_attempt: Vec<bool>, + #[serde(default)] + pub routing_approach: Vec<RoutingApproach>, } #[derive( @@ -84,6 +86,7 @@ pub enum PaymentDimensions { CardLast4, CardIssuer, ErrorReason, + RoutingApproach, } #[derive( @@ -200,6 +203,7 @@ pub struct PaymentMetricsBucketIdentifier { pub card_last_4: Option<String>, pub card_issuer: Option<String>, pub error_reason: Option<String>, + pub routing_approach: Option<RoutingApproach>, #[serde(rename = "time_range")] pub time_bucket: TimeRange, // Coz FE sucks @@ -225,6 +229,7 @@ impl PaymentMetricsBucketIdentifier { card_last_4: Option<String>, card_issuer: Option<String>, error_reason: Option<String>, + routing_approach: Option<RoutingApproach>, normalized_time_range: TimeRange, ) -> Self { Self { @@ -242,6 +247,7 @@ impl PaymentMetricsBucketIdentifier { card_last_4, card_issuer, error_reason, + routing_approach, time_bucket: normalized_time_range, start_time: normalized_time_range.start_time, } @@ -264,6 +270,7 @@ impl Hash for PaymentMetricsBucketIdentifier { self.card_last_4.hash(state); self.card_issuer.hash(state); self.error_reason.hash(state); + self.routing_approach.map(\|i\| i.to_string()).hash(state); self.time_bucket.hash(state); } } diff --git a/crates/common_enums/src/enums.rs b/crates/common_enums/src/enums.rs index 641dc83291c..d7f4a1b2a20 100644 --- a/crates/common_enums/src/enums.rs +++ b/crates/common_enums/src/enums.rs @@ -29,7 +29,7 @@ pub mod diesel_exports { DbPaymentType as PaymentType, DbProcessTrackerStatus as ProcessTrackerStatus, DbRefundStatus as RefundStatus, DbRequestIncrementalAuthorization as RequestIncrementalAuthorization, - DbScaExemptionType as ScaExemptionType, + DbRoutingApproach as RoutingApproach, DbScaExemptionType as ScaExemptionType, DbSuccessBasedRoutingConclusiveState as SuccessBasedRoutingConclusiveState, DbTokenizationFlag as TokenizationFlag, DbWebhookDeliveryAttempt as WebhookDeliveryAttempt, }; @@ -8494,3 +8494,44 @@ pub enum TokenDataType { /// Fetch network token for the given payment method NetworkToken, } + +#[derive( + Clone, + Copy, + Debug, + Default, + Eq, + Hash, + PartialEq, + serde::Deserialize, + serde::Serialize, + strum::Display, + strum::VariantNames, + strum::EnumIter, + strum::EnumString, + ToSchema, +)] +#[router_derive::diesel_enum(storage_type = "db_enum")] +#[serde(rename_all = "snake_case")] +#[strum(serialize_all = "snake_case")] +pub enum RoutingApproach { + SuccessRateExploitation, + SuccessRateExploration, + ContractBasedRouting, + DebitRouting, + RuleBasedRouting, + VolumeBasedRouting, + #[default] + DefaultFallback, +} + +impl RoutingApproach { + pub fn from_decision_engine_approach(approach: &str) -> Self { + match approach { + "SR_SELECTION_V3_ROUTING" => Self::SuccessRateExploitation, + "SR_V3_HEDGING" => Self::SuccessRateExploration, + "NTW_BASED_ROUTING" => Self::DebitRouting, + _ => Self::DefaultFallback, + } + } +} diff --git a/crates/diesel_models/src/enums.rs b/crates/diesel_models/src/enums.rs index fc9417342e1..f7c84368b42 100644 --- a/crates/diesel_models/src/enums.rs +++ b/crates/diesel_models/src/enums.rs @@ -21,7 +21,8 @@ pub mod diesel_exports { DbRelayType as RelayType, DbRequestIncrementalAuthorization as RequestIncrementalAuthorization, DbRevenueRecoveryAlgorithmType as RevenueRecoveryAlgorithmType, DbRoleScope as RoleScope, - DbRoutingAlgorithmKind as RoutingAlgorithmKind, DbScaExemptionType as ScaExemptionType, + DbRoutingAlgorithmKind as RoutingAlgorithmKind, DbRoutingApproach as RoutingApproach, + DbScaExemptionType as ScaExemptionType, DbSuccessBasedRoutingConclusiveState as SuccessBasedRoutingConclusiveState, DbTokenizationFlag as TokenizationFlag, DbTotpStatus as TotpStatus, DbTransactionType as TransactionType, DbUserRoleVersion as UserRoleVersion, diff --git a/crates/diesel_models/src/payment_attempt.rs b/crates/diesel_models/src/payment_attempt.rs index 473502ad746..d438b093513 100644 --- a/crates/diesel_models/src/payment_attempt.rs +++ b/crates/diesel_models/src/payment_attempt.rs @@ -203,6 +203,7 @@ pub struct PaymentAttempt { pub processor_merchant_id: Option<id_type::MerchantId>, pub created_by: Option<String>, pub setup_future_usage_applied: Option<storage_enums::FutureUsage>, + pub routing_approach: Option<storage_enums::RoutingApproach>, } #[cfg(feature = "v1")] @@ -422,6 +423,7 @@ pub struct PaymentAttemptNew { pub processor_merchant_id: Option<id_type::MerchantId>, pub created_by: Option<String>, pub setup_future_usage_applied: Option<storage_enums::FutureUsage>, + pub routing_approach: Option<storage_enums::RoutingApproach>, } #[cfg(feature = "v1")] @@ -495,6 +497,7 @@ pub enum PaymentAttemptUpdate { order_tax_amount: Option<MinorUnit>, connector_mandate_detail: Option<ConnectorMandateReferenceId>, card_discovery: Option<storage_enums::CardDiscovery>, + routing_approach: Option<storage_enums::RoutingApproach>, }, VoidUpdate { status: storage_enums::AttemptStatus, @@ -937,6 +940,7 @@ pub struct PaymentAttemptUpdateInternal { pub issuer_error_code: Option<String>, pub issuer_error_message: Option<String>, pub setup_future_usage_applied: Option<storage_enums::FutureUsage>, + pub routing_approach: Option<storage_enums::RoutingApproach>, } #[cfg(feature = "v1")] @@ -1126,6 +1130,7 @@ impl PaymentAttemptUpdate { issuer_error_code, issuer_error_message, setup_future_usage_applied, + routing_approach, } = PaymentAttemptUpdateInternal::from(self).populate_derived_fields(&source); PaymentAttempt { amount: amount.unwrap_or(source.amount), @@ -1192,6 +1197,7 @@ impl PaymentAttemptUpdate { issuer_error_message: issuer_error_message.or(source.issuer_error_message), setup_future_usage_applied: setup_future_usage_applied .or(source.setup_future_usage_applied), + routing_approach: routing_approach.or(source.routing_approach), ..source } } @@ -2250,6 +2256,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::AuthenticationTypeUpdate { authentication_type, @@ -2312,6 +2319,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::ConfirmUpdate { amount, @@ -2348,6 +2356,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { order_tax_amount, connector_mandate_detail, card_discovery, + routing_approach, } => Self { amount: Some(amount), currency: Some(currency), @@ -2406,6 +2415,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach, }, PaymentAttemptUpdate::VoidUpdate { status, @@ -2469,6 +2479,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::RejectUpdate { status, @@ -2533,6 +2544,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::BlocklistUpdate { status, @@ -2597,6 +2609,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::ConnectorMandateDetailUpdate { connector_mandate_detail, @@ -2659,6 +2672,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::PaymentMethodDetailsUpdate { payment_method_id, @@ -2721,6 +2735,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::ResponseUpdate { status, @@ -2811,6 +2826,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied, + routing_approach: None, } } PaymentAttemptUpdate::ErrorUpdate { @@ -2892,6 +2908,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { card_discovery: None, charges: None, setup_future_usage_applied: None, + routing_approach: None, } } PaymentAttemptUpdate::StatusUpdate { status, updated_by } => Self { @@ -2952,6 +2969,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::UpdateTrackers { payment_token, @@ -3020,6 +3038,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::UnresolvedResponseUpdate { status, @@ -3095,6 +3114,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, } } PaymentAttemptUpdate::PreprocessingUpdate { @@ -3169,6 +3189,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, } } PaymentAttemptUpdate::CaptureUpdate { @@ -3233,6 +3254,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::AmountToCaptureUpdate { status, @@ -3296,6 +3318,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::ConnectorResponse { authentication_data, @@ -3368,6 +3391,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, } } PaymentAttemptUpdate::IncrementalAuthorizationAmountUpdate { @@ -3431,6 +3455,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::AuthenticationUpdate { status, @@ -3496,6 +3521,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::ManualUpdate { status, @@ -3570,6 +3596,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, } } PaymentAttemptUpdate::PostSessionTokensUpdate { @@ -3633,6 +3660,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, } } diff --git a/crates/diesel_models/src/schema.rs b/crates/diesel_models/src/schema.rs index 522ad271be9..cb690e3f602 100644 --- a/crates/diesel_models/src/schema.rs +++ b/crates/diesel_models/src/schema.rs @@ -950,6 +950,7 @@ diesel::table! { #[max_length = 255] created_by -> Nullable<Varchar>, setup_future_usage_applied -> Nullable<FutureUsage>, + routing_approach -> Nullable<RoutingApproach>, } } diff --git a/crates/diesel_models/src/user/sample_data.rs b/crates/diesel_models/src/user/sample_data.rs index 3e445bb5020..2a21bb7c404 100644 --- a/crates/diesel_models/src/user/sample_data.rs +++ b/crates/diesel_models/src/user/sample_data.rs @@ -216,6 +216,7 @@ pub struct PaymentAttemptBatchNew { pub processor_merchant_id: Option<common_utils::id_type::MerchantId>, pub created_by: Option<String>, pub setup_future_usage_applied: Option<common_enums::FutureUsage>, + pub routing_approach: Option<common_enums::RoutingApproach>, } #[cfg(feature = "v1")] @@ -301,6 +302,7 @@ impl PaymentAttemptBatchNew { processor_merchant_id: self.processor_merchant_id, created_by: self.created_by, setup_future_usage_applied: self.setup_future_usage_applied, + routing_approach: self.routing_approach, } } } diff --git a/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs b/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs index c35fbc3163e..6369c2168fe 100644 --- a/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs +++ b/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs @@ -902,6 +902,7 @@ pub struct PaymentAttempt { /// merchantwho invoked the resource based api (identifier) and through what source (Api, Jwt(Dashboard)) pub created_by: Option<CreatedBy>, pub setup_future_usage_applied: Option<storage_enums::FutureUsage>, + pub routing_approach: Option<storage_enums::RoutingApproach>, } #[cfg(feature = "v1")] @@ -1156,6 +1157,7 @@ pub struct PaymentAttemptNew { /// merchantwho invoked the resource based api (identifier) and through what source (Api, Jwt(Dashboard)) pub created_by: Option<CreatedBy>, pub setup_future_usage_applied: Option<storage_enums::FutureUsage>, + pub routing_approach: Option<storage_enums::RoutingApproach>, } #[cfg(feature = "v1")] @@ -1223,6 +1225,7 @@ pub enum PaymentAttemptUpdate { customer_acceptance: Option<pii::SecretSerdeValue>, connector_mandate_detail: Option<ConnectorMandateReferenceId>, card_discovery: Option<common_enums::CardDiscovery>, + routing_approach: Option<storage_enums::RoutingApproach>, // where all to add this one }, RejectUpdate { status: storage_enums::AttemptStatus, @@ -1481,6 +1484,7 @@ impl PaymentAttemptUpdate { customer_acceptance, connector_mandate_detail, card_discovery, + routing_approach, } => DieselPaymentAttemptUpdate::ConfirmUpdate { amount: net_amount.get_order_amount(), currency, @@ -1516,6 +1520,7 @@ impl PaymentAttemptUpdate { order_tax_amount: net_amount.get_order_tax_amount(), connector_mandate_detail, card_discovery, + routing_approach, }, Self::VoidUpdate { status, @@ -1917,6 +1922,7 @@ impl behaviour::Conversion for PaymentAttempt { connector_transaction_data: None, processor_merchant_id: Some(self.processor_merchant_id), created_by: self.created_by.map(\|cb\| cb.to_string()), + routing_approach: self.routing_approach, }) } @@ -2012,6 +2018,7 @@ impl behaviour::Conversion for PaymentAttempt { .created_by .and_then(\|created_by\| created_by.parse::<CreatedBy>().ok()), setup_future_usage_applied: storage_model.setup_future_usage_applied, + routing_approach: storage_model.routing_approach, }) } .await @@ -2100,6 +2107,7 @@ impl behaviour::Conversion for PaymentAttempt { processor_merchant_id: Some(self.processor_merchant_id), created_by: self.created_by.map(\|cb\| cb.to_string()), setup_future_usage_applied: self.setup_future_usage_applied, + routing_approach: self.routing_approach, }) } } diff --git a/crates/router/src/analytics.rs b/crates/router/src/analytics.rs index ffac49e7a8e..e40bce12339 100644 --- a/crates/router/src/analytics.rs +++ b/crates/router/src/analytics.rs @@ -62,6 +62,10 @@ pub mod routes { web::resource("metrics/payments") .route(web::post().to(get_merchant_payment_metrics)), ) + .service( + web::resource("metrics/routing") + .route(web::post().to(get_merchant_payment_metrics)), + ) .service( web::resource("metrics/refunds") .route(web::post().to(get_merchant_refund_metrics)), @@ -70,6 +74,10 @@ pub mod routes { web::resource("filters/payments") .route(web::post().to(get_merchant_payment_filters)), ) + .service( + web::resource("filters/routing") + .route(web::post().to(get_merchant_payment_filters)), + ) .service( web::resource("filters/frm").route(web::post().to(get_frm_filters)), ) @@ -175,6 +183,10 @@ pub mod routes { web::resource("metrics/payments") .route(web::post().to(get_merchant_payment_metrics)), ) + .service( + web::resource("metrics/routing") + .route(web::post().to(get_merchant_payment_metrics)), + ) .service( web::resource("metrics/refunds") .route(web::post().to(get_merchant_refund_metrics)), @@ -183,6 +195,10 @@ pub mod routes { web::resource("filters/payments") .route(web::post().to(get_merchant_payment_filters)), ) + .service( + web::resource("filters/routing") + .route(web::post().to(get_merchant_payment_filters)), + ) .service( web::resource("filters/refunds") .route(web::post().to(get_merchant_refund_filters)), @@ -241,6 +257,14 @@ pub mod routes { web::resource("filters/payments") .route(web::post().to(get_org_payment_filters)), ) + .service( + web::resource("metrics/routing") + .route(web::post().to(get_org_payment_metrics)), + ) + .service( + web::resource("filters/routing") + .route(web::post().to(get_org_payment_filters)), + ) .service( web::resource("metrics/refunds") .route(web::post().to(get_org_refund_metrics)), @@ -291,6 +315,14 @@ pub mod routes { web::resource("filters/payments") .route(web::post().to(get_profile_payment_filters)), ) + .service( + web::resource("metrics/routing") + .route(web::post().to(get_profile_payment_metrics)), + ) + .service( + web::resource("filters/routing") + .route(web::post().to(get_profile_payment_filters)), + ) .service( web::resource("metrics/refunds") .route(web::post().to(get_profile_refund_metrics)), diff --git a/crates/router/src/core/debit_routing.rs b/crates/router/src/core/debit_routing.rs index ca03f5d2532..4975ffc4bd1 100644 --- a/crates/router/src/core/debit_routing.rs +++ b/crates/router/src/core/debit_routing.rs @@ -306,15 +306,14 @@ where } pub async fn get_debit_routing_output< - F: Clone, - D: OperationSessionGetters<F> + OperationSessionSetters<F>, + F: Clone + Send, + D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, >( state: &SessionState, payment_data: &mut D, acquirer_country: enums::CountryAlpha2, ) -> Option<open_router::DebitRoutingOutput> { logger::debug!("Fetching sorted card networks"); - let payment_attempt = payment_data.get_payment_attempt(); let (saved_co_badged_card_data, saved_card_type, card_isin) = extract_saved_card_info(payment_data); @@ -355,9 +354,9 @@ pub async fn get_debit_routing_output< routing::perform_open_routing_for_debit_routing( state, - payment_attempt, co_badged_card_request, card_isin, + payment_data, ) .await .map_err(\|error\| { diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs index 59de54f41fa..f361be5a76c 100644 --- a/crates/router/src/core/payments.rs +++ b/crates/router/src/core/payments.rs @@ -7996,7 +7996,7 @@ pub async fn route_connector_v2_for_payments( .as_ref() .or(business_profile.routing_algorithm_id.as_ref()); - let connectors = routing::perform_static_routing_v1( + let (connectors, _) = routing::perform_static_routing_v1( state, merchant_context.get_merchant_account().get_id(), routing_algorithm_id, @@ -8063,7 +8063,7 @@ where algorithm_ref.algorithm_id }; - let connectors = routing::perform_static_routing_v1( + let (connectors, routing_approach) = routing::perform_static_routing_v1( state, merchant_context.get_merchant_account().get_id(), routing_algorithm_id.as_ref(), @@ -8073,6 +8073,8 @@ where .await .change_context(errors::ApiErrorResponse::InternalServerError)?; + payment_data.set_routing_approach_in_attempt(routing_approach); + #[cfg(all(feature = "v1", feature = "dynamic_routing"))] let payment_attempt = transaction_data.payment_attempt.clone(); @@ -8121,6 +8123,7 @@ where connectors.clone(), business_profile, payment_attempt, + payment_data, ) .await .map_err(\|e\| logger::error!(open_routing_error=?e)) @@ -8163,7 +8166,7 @@ where connectors.clone(), business_profile, dynamic_routing_config_params_interpolator, - payment_data.get_payment_attempt(), + payment_data, ) .await .map_err(\|e\| logger::error!(dynamic_routing_error=?e)) @@ -8240,7 +8243,7 @@ pub async fn route_connector_v1_for_payouts( algorithm_ref.algorithm_id }; - let connectors = routing::perform_static_routing_v1( + let (connectors, _) = routing::perform_static_routing_v1( state, merchant_context.get_merchant_account().get_id(), routing_algorithm_id.as_ref(), @@ -8965,6 +8968,7 @@ pub trait OperationSessionSetters<F> { &mut self, external_vault_session_details: Option<api::VaultSessionDetails>, ); + fn set_routing_approach_in_attempt(&mut self, routing_approach: Option<enums::RoutingApproach>); } #[cfg(feature = "v1")] @@ -9264,6 +9268,13 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentData<F> { fn set_vault_operation(&mut self, vault_operation: domain_payments::VaultOperation) { self.vault_operation = Some(vault_operation); } + + fn set_routing_approach_in_attempt( + &mut self, + routing_approach: Option<enums::RoutingApproach>, + ) { + self.payment_attempt.routing_approach = routing_approach; + } } #[cfg(feature = "v2")] @@ -9550,6 +9561,13 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentIntentData<F> { ) { self.vault_session_details = vault_session_details; } + + fn set_routing_approach_in_attempt( + &mut self, + routing_approach: Option<enums::RoutingApproach>, + ) { + todo!() + } } #[cfg(feature = "v2")] @@ -9839,6 +9857,13 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentConfirmData<F> { ) { todo!() } + + fn set_routing_approach_in_attempt( + &mut self, + routing_approach: Option<enums::RoutingApproach>, + ) { + todo!() + } } #[cfg(feature = "v2")] @@ -10124,6 +10149,12 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentStatusData<F> { ) { todo!() } + fn set_routing_approach_in_attempt( + &mut self, + routing_approach: Option<enums::RoutingApproach>, + ) { + todo!() + } } #[cfg(feature = "v2")] @@ -10410,6 +10441,13 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentCaptureData<F> { ) { todo!() } + + fn set_routing_approach_in_attempt( + &mut self, + routing_approach: Option<enums::RoutingApproach>, + ) { + todo!() + } } #[cfg(feature = "v2")] diff --git a/crates/router/src/core/payments/helpers.rs b/crates/router/src/core/payments/helpers.rs index 9f6e317531a..a34a169d38a 100644 --- a/crates/router/src/core/payments/helpers.rs +++ b/crates/router/src/core/payments/helpers.rs @@ -4399,6 +4399,7 @@ impl AttemptType { processor_merchant_id: old_payment_attempt.processor_merchant_id, created_by: old_payment_attempt.created_by, setup_future_usage_applied: None, + routing_approach: old_payment_attempt.routing_approach, } } diff --git a/crates/router/src/core/payments/operations/payment_confirm.rs b/crates/router/src/core/payments/operations/payment_confirm.rs index 944f2852b18..866449c74dd 100644 --- a/crates/router/src/core/payments/operations/payment_confirm.rs +++ b/crates/router/src/core/payments/operations/payment_confirm.rs @@ -1794,6 +1794,7 @@ impl<F: Clone + Sync> UpdateTracker<F, PaymentData<F>, api::PaymentsRequest> for .payment_attempt .connector_mandate_detail, card_discovery, + routing_approach: payment_data.payment_attempt.routing_approach, }, storage_scheme, ) diff --git a/crates/router/src/core/payments/operations/payment_create.rs b/crates/router/src/core/payments/operations/payment_create.rs index 68f1b9d9c15..43e9c39c566 100644 --- a/crates/router/src/core/payments/operations/payment_create.rs +++ b/crates/router/src/core/payments/operations/payment_create.rs @@ -1362,6 +1362,7 @@ impl PaymentCreate { processor_merchant_id: merchant_id.to_owned(), created_by: None, setup_future_usage_applied: request.setup_future_usage, + routing_approach: Some(common_enums::RoutingApproach::default()) }, additional_pm_data, diff --git a/crates/router/src/core/payments/retry.rs b/crates/router/src/core/payments/retry.rs index a4d1cc51518..1cc886be828 100644 --- a/crates/router/src/core/payments/retry.rs +++ b/crates/router/src/core/payments/retry.rs @@ -702,6 +702,7 @@ pub fn make_new_payment_attempt( processor_merchant_id: old_payment_attempt.processor_merchant_id, created_by: old_payment_attempt.created_by, setup_future_usage_applied: setup_future_usage_intent, // setup future usage is picked from intent for new payment attempt + routing_approach: old_payment_attempt.routing_approach, } } diff --git a/crates/router/src/core/payments/routing.rs b/crates/router/src/core/payments/routing.rs index 2ab004cccd1..ef7d1d46f53 100644 --- a/crates/router/src/core/payments/routing.rs +++ b/crates/router/src/core/payments/routing.rs @@ -59,7 +59,12 @@ use crate::core::routing::transformers::OpenRouterDecideGatewayRequestExt; use crate::routes::app::SessionStateInfo; use crate::{ core::{ - errors, errors as oss_errors, payments::routing::utils::DecisionEngineApiHandler, routing, + errors, errors as oss_errors, + payments::{ + routing::utils::DecisionEngineApiHandler, OperationSessionGetters, + OperationSessionSetters, + }, + routing, }, logger, services, types::{ @@ -432,7 +437,10 @@ pub async fn perform_static_routing_v1( algorithm_id: Option<&common_utils::id_type::RoutingId>, business_profile: &domain::Profile, transaction_data: &routing::TransactionData<'_>, -) -> RoutingResult<Vec<routing_types::RoutableConnectorChoice>> { +) -> RoutingResult<( + Vec<routing_types::RoutableConnectorChoice>, + Option<common_enums::RoutingApproach>, +)> { let algorithm_id = if let Some(id) = algorithm_id { id } else { @@ -449,7 +457,7 @@ pub async fn perform_static_routing_v1( .get_default_fallback_list_of_connector_under_profile() .change_context(errors::RoutingError::FallbackConfigFetchFailed)?; - return Ok(fallback_config); + return Ok((fallback_config, None)); }; let cached_algorithm = ensure_algorithm_cached_v1( state, @@ -503,14 +511,18 @@ pub async fn perform_static_routing_v1( logger::error!(decision_engine_euclid_evaluate_error=?e, "decision_engine_euclid: error in evaluation of rule") ).unwrap_or_default(); - let routable_connectors = match cached_algorithm.as_ref() { - CachedAlgorithm::Single(conn) => vec![(conn).clone()], - CachedAlgorithm::Priority(plist) => plist.clone(), - CachedAlgorithm::VolumeSplit(splits) => perform_volume_split(splits.to_vec()) - .change_context(errors::RoutingError::ConnectorSelectionFailed)?, - CachedAlgorithm::Advanced(interpreter) => { - execute_dsl_and_get_connector_v1(backend_input, interpreter)? - } + let (routable_connectors, routing_approach) = match cached_algorithm.as_ref() { + CachedAlgorithm::Single(conn) => (vec![(conn).clone()], None), + CachedAlgorithm::Priority(plist) => (plist.clone(), None), + CachedAlgorithm::VolumeSplit(splits) => ( + perform_volume_split(splits.to_vec()) + .change_context(errors::RoutingError::ConnectorSelectionFailed)?, + Some(common_enums::RoutingApproach::VolumeBasedRouting), + ), + CachedAlgorithm::Advanced(interpreter) => ( + execute_dsl_and_get_connector_v1(backend_input, interpreter)?, + Some(common_enums::RoutingApproach::RuleBasedRouting), + ), }; utils::compare_and_log_result( @@ -519,13 +531,16 @@ pub async fn perform_static_routing_v1( "evaluate_routing".to_string(), ); - Ok(utils::select_routing_result( - state, - business_profile, - routable_connectors, - de_euclid_connectors, - ) - .await) + Ok(( + utils::select_routing_result( + state, + business_profile, + routable_connectors, + de_euclid_connectors, + ) + .await, + routing_approach, + )) } async fn ensure_algorithm_cached_v1( @@ -1573,12 +1588,17 @@ pub fn make_dsl_input_for_surcharge( } #[cfg(all(feature = "v1", feature = "dynamic_routing"))] -pub async fn perform_dynamic_routing_with_open_router( +pub async fn perform_dynamic_routing_with_open_router<F, D>( state: &SessionState, routable_connectors: Vec<api_routing::RoutableConnectorChoice>, profile: &domain::Profile, payment_data: oss_storage::PaymentAttempt, -) -> RoutingResult<Vec<api_routing::RoutableConnectorChoice>> { + old_payment_data: &mut D, +) -> RoutingResult<Vec<api_routing::RoutableConnectorChoice>> +where + F: Send + Clone, + D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, +{ let dynamic_routing_algo_ref: api_routing::DynamicRoutingAlgorithmRef = profile .dynamic_routing_algorithm .clone() @@ -1610,6 +1630,7 @@ pub async fn perform_dynamic_routing_with_open_router( profile.get_id(), &payment_data, is_elimination_enabled, + old_payment_data, ) .await?; @@ -1642,12 +1663,18 @@ pub async fn perform_dynamic_routing_with_open_router( } #[cfg(feature = "v1")] -pub async fn perform_open_routing_for_debit_routing( +pub async fn perform_open_routing_for_debit_routing<F, D>( state: &SessionState, - payment_attempt: &oss_storage::PaymentAttempt, co_badged_card_request: or_types::CoBadgedCardRequest, card_isin: Option<Secret<String>>, -) -> RoutingResult<or_types::DebitRoutingOutput> { + old_payment_data: &mut D, +) -> RoutingResult<or_types::DebitRoutingOutput> +where + F: Send + Clone, + D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, +{ + let payment_attempt = old_payment_data.get_payment_attempt().clone(); + logger::debug!( "performing debit routing with open_router for profile {}", payment_attempt.profile_id.get_string_repr() @@ -1661,7 +1688,7 @@ pub async fn perform_open_routing_for_debit_routing( ); let open_router_req_body = OpenRouterDecideGatewayRequest::construct_debit_request( - payment_attempt, + &payment_attempt, metadata, card_isin, Some(or_types::RankingAlgorithm::NtwBasedRouting), @@ -1692,11 +1719,14 @@ pub async fn perform_open_routing_for_debit_routing( let output = match response { Ok(events_response) => { - let debit_routing_output = events_response - .response - .ok_or(errors::RoutingError::OpenRouterError( - "Response from decision engine API is empty".to_string(), - ))? + let response = + events_response + .response + .ok_or(errors::RoutingError::OpenRouterError( + "Response from decision engine API is empty".to_string(), + ))?; + + let debit_routing_output = response .debit_routing_output .get_required_value("debit_routing_output") .change_context(errors::RoutingError::OpenRouterError( @@ -1704,6 +1734,12 @@ pub async fn perform_open_routing_for_debit_routing( )) .attach_printable("debit_routing_output is missing in the open routing response")?; + old_payment_data.set_routing_approach_in_attempt(Some( + common_enums::RoutingApproach::from_decision_engine_approach( + &response.routing_approach, + ), + )); + Ok(debit_routing_output) } Err(error_response) => { @@ -1718,13 +1754,17 @@ pub async fn perform_open_routing_for_debit_routing( } #[cfg(all(feature = "v1", feature = "dynamic_routing"))] -pub async fn perform_dynamic_routing_with_intelligent_router( +pub async fn perform_dynamic_routing_with_intelligent_router<F, D>( state: &SessionState, routable_connectors: Vec<api_routing::RoutableConnectorChoice>, profile: &domain::Profile, dynamic_routing_config_params_interpolator: routing::helpers::DynamicRoutingConfigParamsInterpolator, - payment_attempt: &oss_storage::PaymentAttempt, -) -> RoutingResult<Vec<api_routing::RoutableConnectorChoice>> { + payment_data: &mut D, +) -> RoutingResult<Vec<api_routing::RoutableConnectorChoice>> +where + F: Send + Clone, + D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, +{ let dynamic_routing_algo_ref: api_routing::DynamicRoutingAlgorithmRef = profile .dynamic_routing_algorithm .clone() @@ -1744,6 +1784,8 @@ pub async fn perform_dynamic_routing_with_intelligent_router( profile.get_id().get_string_repr() ); + let payment_attempt = payment_data.get_payment_attempt().clone(); + let mut connector_list = match dynamic_routing_algo_ref .success_based_algorithm .as_ref() @@ -1756,6 +1798,7 @@ pub async fn perform_dynamic_routing_with_intelligent_router( &payment_attempt.payment_id, dynamic_routing_config_params_interpolator.clone(), algorithm.clone(), + payment_data, ) }) .await @@ -1779,6 +1822,7 @@ pub async fn perform_dynamic_routing_with_intelligent_router( &payment_attempt.payment_id, dynamic_routing_config_params_interpolator.clone(), algorithm.clone(), + payment_data, ) }) .await @@ -1816,13 +1860,18 @@ pub async fn perform_dynamic_routing_with_intelligent_router( #[cfg(all(feature = "v1", feature = "dynamic_routing"))] #[instrument(skip_all)] -pub async fn perform_decide_gateway_call_with_open_router( +pub async fn perform_decide_gateway_call_with_open_router<F, D>( state: &SessionState, mut routable_connectors: Vec<api_routing::RoutableConnectorChoice>, profile_id: &common_utils::id_type::ProfileId, payment_attempt: &oss_storage::PaymentAttempt, is_elimination_enabled: bool, -) -> RoutingResult<Vec<api_routing::RoutableConnectorChoice>> { + old_payment_data: &mut D, +) -> RoutingResult<Vec<api_routing::RoutableConnectorChoice>> +where + F: Send + Clone, + D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, +{ logger::debug!( "performing decide_gateway call with open_router for profile {}", profile_id.get_string_repr() @@ -1879,6 +1928,12 @@ pub async fn perform_decide_gateway_call_with_open_router( .to_string(), ); + old_payment_data.set_routing_approach_in_attempt(Some( + common_enums::RoutingApproach::from_decision_engine_approach( + &decided_gateway.routing_approach, + ), + )); + if let Some(gateway_priority_map) = decided_gateway.gateway_priority_map { logger::debug!(gateway_priority_map=?gateway_priority_map, routing_approach=decided_gateway.routing_approach, "open_router decide_gateway call response"); routable_connectors.sort_by(\|connector_choice_a, connector_choice_b\| { @@ -1992,7 +2047,8 @@ pub async fn update_gateway_score_with_open_router( /// success based dynamic routing #[cfg(all(feature = "v1", feature = "dynamic_routing"))] #[instrument(skip_all)] -pub async fn perform_success_based_routing( +#[allow(clippy::too_many_arguments)] +pub async fn perform_success_based_routing<F, D>( state: &SessionState, routable_connectors: Vec<api_routing::RoutableConnectorChoice>, profile_id: &common_utils::id_type::ProfileId, @@ -2000,7 +2056,12 @@ pub async fn perform_success_based_routing( payment_id: &common_utils::id_type::PaymentId, success_based_routing_config_params_interpolator: routing::helpers::DynamicRoutingConfigParamsInterpolator, success_based_algo_ref: api_routing::SuccessBasedAlgorithm, -) -> RoutingResult<Vec<api_routing::RoutableConnectorChoice>> { + payment_data: &mut D, +) -> RoutingResult<Vec<api_routing::RoutableConnectorChoice>> +where + F: Send + Clone, + D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, +{ if success_based_algo_ref.enabled_feature == api_routing::DynamicRoutingFeatures::DynamicConnectorSelection { @@ -2131,6 +2192,9 @@ pub async fn perform_success_based_routing( })?; routing_event.set_routing_approach(success_based_connectors.routing_approach.to_string()); + payment_data.set_routing_approach_in_attempt(Some(common_enums::RoutingApproach::from( + success_based_connectors.routing_approach, + ))); let mut connectors = Vec::with_capacity(success_based_connectors.labels_with_score.len()); for label_with_score in success_based_connectors.labels_with_score { @@ -2367,7 +2431,8 @@ pub async fn perform_elimination_routing( } #[cfg(all(feature = "v1", feature = "dynamic_routing"))] -pub async fn perform_contract_based_routing( +#[allow(clippy::too_many_arguments)] +pub async fn perform_contract_based_routing<F, D>( state: &SessionState, routable_connectors: Vec<api_routing::RoutableConnectorChoice>, profile_id: &common_utils::id_type::ProfileId, @@ -2375,7 +2440,12 @@ pub async fn perform_contract_based_routing( payment_id: &common_utils::id_type::PaymentId, _dynamic_routing_config_params_interpolator: routing::helpers::DynamicRoutingConfigParamsInterpolator, contract_based_algo_ref: api_routing::ContractRoutingAlgorithm, -) -> RoutingResult<Vec<api_routing::RoutableConnectorChoice>> { + payment_data: &mut D, +) -> RoutingResult<Vec<api_routing::RoutableConnectorChoice>> +where + F: Send + Clone, + D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, +{ if contract_based_algo_ref.enabled_feature == api_routing::DynamicRoutingFeatures::DynamicConnectorSelection { @@ -2528,6 +2598,10 @@ pub async fn perform_contract_based_routing( status_code: 500, })?; + payment_data.set_routing_approach_in_attempt(Some( + common_enums::RoutingApproach::ContractBasedRouting, + )); + let mut connectors = Vec::with_capacity(contract_based_connectors.labels_with_score.len()); for label_with_score in contract_based_connectors.labels_with_score { @@ -2565,6 +2639,7 @@ pub async fn perform_contract_based_routing( routing_event.set_status_code(200); routing_event.set_routable_connectors(connectors.clone()); + routing_event.set_routing_approach(api_routing::RoutingApproach::ContractBased.to_string()); state.event_handler().log_event(&routing_event); Ok(connectors) } else { diff --git a/crates/router/src/core/payments/routing/utils.rs b/crates/router/src/core/payments/routing/utils.rs index 4296fea819f..0b74273419b 100644 --- a/crates/router/src/core/payments/routing/utils.rs +++ b/crates/router/src/core/payments/routing/utils.rs @@ -1522,6 +1522,18 @@ impl RoutingApproach { } } +impl From<RoutingApproach> for common_enums::RoutingApproach { + fn from(approach: RoutingApproach) -> Self { + match approach { + RoutingApproach::Exploitation => Self::SuccessRateExploitation, + RoutingApproach::Exploration => Self::SuccessRateExploration, + RoutingApproach::ContractBased => Self::ContractBasedRouting, + RoutingApproach::StaticRouting => Self::RuleBasedRouting, + _ => Self::DefaultFallback, + } + } +} + impl std::fmt::Display for RoutingApproach { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { match self { diff --git a/crates/router/src/core/routing/helpers.rs b/crates/router/src/core/routing/helpers.rs index e73c9c5bc75..6d263eece26 100644 --- a/crates/router/src/core/routing/helpers.rs +++ b/crates/router/src/core/routing/helpers.rs @@ -54,7 +54,10 @@ use crate::{ }; #[cfg(feature = "v1")] use crate::{ - core::payments::routing::utils::{self as routing_utils, DecisionEngineApiHandler}, + core::payments::{ + routing::utils::{self as routing_utils, DecisionEngineApiHandler}, + OperationSessionGetters, OperationSessionSetters, + }, services, }; #[cfg(all(feature = "dynamic_routing", feature = "v1"))] @@ -338,11 +341,7 @@ impl RoutingDecisionData { pub fn apply_routing_decision<F, D>(&self, payment_data: &mut D) where F: Send + Clone, - D: crate::core::payments::OperationSessionGetters<F> - + crate::core::payments::OperationSessionSetters<F> - + Send - + Sync - + Clone, + D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, { match self { Self::DebitRouting(data) => data.apply_debit_routing_decision(payment_data), @@ -364,11 +363,7 @@ impl DebitRoutingDecisionData { pub fn apply_debit_routing_decision<F, D>(&self, payment_data: &mut D) where F: Send + Clone, - D: crate::core::payments::OperationSessionGetters<F> - + crate::core::payments::OperationSessionSetters<F> - + Send - + Sync - + Clone, + D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, { payment_data.set_card_network(self.card_network.clone()); self.debit_routing_result diff --git a/crates/router/src/services/kafka/payment_attempt.rs b/crates/router/src/services/kafka/payment_attempt.rs index f2c18ae9302..68f1d013517 100644 --- a/crates/router/src/services/kafka/payment_attempt.rs +++ b/crates/router/src/services/kafka/payment_attempt.rs @@ -69,6 +69,7 @@ pub struct KafkaPaymentAttempt<'a> { pub organization_id: &'a id_type::OrganizationId, pub card_network: Option<String>, pub card_discovery: Option<String>, + pub routing_approach: Option<storage_enums::RoutingApproach>, } #[cfg(feature = "v1")] @@ -130,6 +131,7 @@ impl<'a> KafkaPaymentAttempt<'a> { card_discovery: attempt .card_discovery .map(\|discovery\| discovery.to_string()), + routing_approach: attempt.routing_approach, } } } diff --git a/crates/router/src/services/kafka/payment_attempt_event.rs b/crates/router/src/services/kafka/payment_attempt_event.rs index e06f4e014dd..9bfc6f8c31d 100644 --- a/crates/router/src/services/kafka/payment_attempt_event.rs +++ b/crates/router/src/services/kafka/payment_attempt_event.rs @@ -70,6 +70,7 @@ pub struct KafkaPaymentAttemptEvent<'a> { pub organization_id: &'a id_type::OrganizationId, pub card_network: Option<String>, pub card_discovery: Option<String>, + pub routing_approach: Option<storage_enums::RoutingApproach>, } #[cfg(feature = "v1")] @@ -131,6 +132,7 @@ impl<'a> KafkaPaymentAttemptEvent<'a> { card_discovery: attempt .card_discovery .map(\|discovery\| discovery.to_string()), + routing_approach: attempt.routing_approach, } } } diff --git a/crates/router/src/types/storage/payment_attempt.rs b/crates/router/src/types/storage/payment_attempt.rs index 3a942f70e32..5289ed02af9 100644 --- a/crates/router/src/types/storage/payment_attempt.rs +++ b/crates/router/src/types/storage/payment_attempt.rs @@ -225,6 +225,7 @@ mod tests { processor_merchant_id: Default::default(), created_by: None, setup_future_usage_applied: Default::default(), + routing_approach: Default::default(), }; let store = state @@ -315,6 +316,7 @@ mod tests { processor_merchant_id: Default::default(), created_by: None, setup_future_usage_applied: Default::default(), + routing_approach: Default::default(), }; let store = state .stores @@ -418,6 +420,7 @@ mod tests { processor_merchant_id: Default::default(), created_by: None, setup_future_usage_applied: Default::default(), + routing_approach: Default::default(), }; let store = state .stores diff --git a/crates/router/src/utils/user/sample_data.rs b/crates/router/src/utils/user/sample_data.rs index 989e7db3c0c..52c3d29482e 100644 --- a/crates/router/src/utils/user/sample_data.rs +++ b/crates/router/src/utils/user/sample_data.rs @@ -381,6 +381,7 @@ pub async fn generate_sample_data( processor_merchant_id: Some(merchant_id.clone()), created_by: None, setup_future_usage_applied: None, + routing_approach: None, }; let refund = if refunds_count < number_of_refunds && !is_failed_payment { diff --git a/crates/storage_impl/src/mock_db/payment_attempt.rs b/crates/storage_impl/src/mock_db/payment_attempt.rs index feec3a1f3a9..0de343b94ea 100644 --- a/crates/storage_impl/src/mock_db/payment_attempt.rs +++ b/crates/storage_impl/src/mock_db/payment_attempt.rs @@ -235,6 +235,7 @@ impl PaymentAttemptInterface for MockDb { processor_merchant_id: payment_attempt.processor_merchant_id, created_by: payment_attempt.created_by, setup_future_usage_applied: payment_attempt.setup_future_usage_applied, + routing_approach: payment_attempt.routing_approach, }; payment_attempts.push(payment_attempt.clone()); Ok(payment_attempt) diff --git a/crates/storage_impl/src/payments/payment_attempt.rs b/crates/storage_impl/src/payments/payment_attempt.rs index db3400c5fa4..ea1552248b9 100644 --- a/crates/storage_impl/src/payments/payment_attempt.rs +++ b/crates/storage_impl/src/payments/payment_attempt.rs @@ -680,6 +680,7 @@ impl<T: DatabaseStore> PaymentAttemptInterface for KVRouterStore<T> { processor_merchant_id: payment_attempt.processor_merchant_id.clone(), created_by: payment_attempt.created_by.clone(), setup_future_usage_applied: payment_attempt.setup_future_usage_applied, + routing_approach: payment_attempt.routing_approach, }; let field = format!("pa_{}", created_attempt.attempt_id); @@ -1704,6 +1705,7 @@ impl DataModelExt for PaymentAttempt { issuer_error_code: self.issuer_error_code, issuer_error_message: self.issuer_error_message, setup_future_usage_applied: self.setup_future_usage_applied, + routing_approach: self.routing_approach, // Below fields are deprecated. Please add any new fields above this line. connector_transaction_data: None, processor_merchant_id: Some(self.processor_merchant_id), @@ -1798,6 +1800,7 @@ impl DataModelExt for PaymentAttempt { .created_by .and_then(\|created_by\| created_by.parse::<CreatedBy>().ok()), setup_future_usage_applied: storage_model.setup_future_usage_applied, + routing_approach: storage_model.routing_approach, } } } @@ -1887,6 +1890,7 @@ impl DataModelExt for PaymentAttemptNew { processor_merchant_id: Some(self.processor_merchant_id), created_by: self.created_by.map(\|created_by\| created_by.to_string()), setup_future_usage_applied: self.setup_future_usage_applied, + routing_approach: self.routing_approach, } } @@ -1969,6 +1973,7 @@ impl DataModelExt for PaymentAttemptNew { .created_by .and_then(\|created_by\| created_by.parse::<CreatedBy>().ok()), setup_future_usage_applied: storage_model.setup_future_usage_applied, + routing_approach: storage_model.routing_approach, } } } diff --git a/migrations/2025-06-19-124558_add_routing_approach_to_attempt/down.sql b/migrations/2025-06-19-124558_add_routing_approach_to_attempt/down.sql new file mode 100644 index 00000000000..0c6fce15b58 --- /dev/null +++ b/migrations/2025-06-19-124558_add_routing_approach_to_attempt/down.sql @@ -0,0 +1,6 @@ +-- This file should undo anything in `up.sql` + +ALTER TABLE payment_attempt +DROP COLUMN IF EXISTS routing_approach; + +DROP TYPE "RoutingApproach"; diff --git a/migrations/2025-06-19-124558_add_routing_approach_to_attempt/up.sql b/migrations/2025-06-19-124558_add_routing_approach_to_attempt/up.sql new file mode 100644 index 00000000000..f5ec97a93f3 --- /dev/null +++ b/migrations/2025-06-19-124558_add_routing_approach_to_attempt/up.sql @@ -0,0 +1,15 @@ +-- Your SQL goes here +CREATE TYPE "RoutingApproach" AS ENUM ( + 'success_rate_exploitation', + 'success_rate_exploration', + 'contract_based_routing', + 'debit_routing', + 'rule_based_routing', + 'volume_based_routing', + 'default_fallback' +); + + +ALTER TABLE payment_attempt +ADD COLUMN IF NOT EXISTS routing_approach "RoutingApproach"; + diff --git a/v2_migrations/2025-01-13-081847_drop_v1_columns/up.sql b/v2_migrations/2025-01-13-081847_drop_v1_columns/up.sql index 7913af26d66..8eac6ae97ac 100644 --- a/v2_migrations/2025-01-13-081847_drop_v1_columns/up.sql +++ b/v2_migrations/2025-01-13-081847_drop_v1_columns/up.sql @@ -93,7 +93,8 @@ ALTER TABLE payment_attempt DROP COLUMN attempt_id, DROP COLUMN charge_id, DROP COLUMN issuer_error_code, DROP COLUMN issuer_error_message, - DROP COLUMN setup_future_usage_applied; + DROP COLUMN setup_future_usage_applied, + DROP COLUMN routing_approach; ALTER TABLE payment_methods	2025-06-20T18:09:08Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description <!-- Describe your changes in detail --> - Added RoutingApproach column in Payment attempt - Added RoutingApproach as a filter and dimension in payment analytics - Added routing metric endpoints DB queries - ```sql CREATE TYPE "RoutingApproach" AS ENUM ( 'success_rate_exploitation', 'success_rate_exploration', 'contract_based_routing', 'debit_routing', 'rule_based_routing', 'volume_based_routing', 'default_fallback' ); ALTER TABLE payment_attempt ADD COLUMN IF NOT EXISTS routing_approach "RoutingApproach"; ``` ### Additional Changes - [x] This PR modifies the API contract - [x] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> ## How did you test it? <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> ```bash curl -X GET 'http://localhost:8080/analytics/v1/org/routing/info' \ -H 'Accept: /' \ -H 'Accept-Language: en-GB,en-US;q=0.9,en;q=0.8' \ -H 'Connection: keep-alive' \ -H 'Content-Type: application/json' \ -H 'Origin: http://localhost:9000' \ -H 'Referer: http://localhost:9000/' \ -H 'Sec-Fetch-Dest: empty' \ -H 'Sec-Fetch-Mode: cors' \ -H 'Sec-Fetch-Site: same-site' \ -H 'User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/136.0.0.0 Safari/537.36' \ -H 'X-Merchant-Id: merchant_1750414514' \ -H 'X-Profile-Id: pro_8QBK8uJG8ZHGwiZfWcAr' \ -H 'api-key: hyperswitch' \ -H 'authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiOGMzNzEwZmMtNDU3NS00NDlmLWFhNzItNWFjOWUyYmJlODViIiwibWVyY2hhbnRfaWQiOiJtZXJjaGFudF8xNzUwNDE0NTE0Iiwicm9sZV9pZCI6Im9yZ19hZG1pbiIsImV4cCI6MTc1MDg1MDY3MCwib3JnX2lkIjoib3JnX2EycGVlblVCaVNqY2dmVzNMQ2xXIiwicHJvZmlsZV9pZCI6InByb184UUJLOHVKRzhaSEd3aVpmV2NBciIsInRlbmFudF9pZCI6InB1YmxpYyJ9.wutHNAmKapYOM4kcOF0t-Lrrx-ZVFKelyFCXk_Xk8JA' \ -H 'sec-ch-ua: "Chromium";v="136", "Google Chrome";v="136", "Not.A/Brand";v="99"' \ -H 'sec-ch-ua-mobile: ?0' \ -H 'sec-ch-ua-platform: "macOS"' ``` response - ```json { "metrics": [ { "name": "payment_success_rate", "desc": "" }, { "name": "payment_count", "desc": "" }, { "name": "payment_success_count", "desc": "" }, { "name": "payment_processed_amount", "desc": "" }, { "name": "avg_ticket_size", "desc": "" }, { "name": "retries_count", "desc": "" }, { "name": "connector_success_rate", "desc": "" }, { "name": "sessionized_payment_success_rate", "desc": "" }, { "name": "sessionized_payment_count", "desc": "" }, { "name": "sessionized_payment_success_count", "desc": "" }, { "name": "sessionized_payment_processed_amount", "desc": "" }, { "name": "sessionized_avg_ticket_size", "desc": "" }, { "name": "sessionized_retries_count", "desc": "" }, { "name": "sessionized_connector_success_rate", "desc": "" }, { "name": "payments_distribution", "desc": "" }, { "name": "failure_reasons", "desc": "" } ], "downloadDimensions": null, "dimensions": [ { "name": "connector", "desc": "" }, { "name": "payment_method", "desc": "" }, { "name": "payment_method_type", "desc": "" }, { "name": "currency", "desc": "" }, { "name": "authentication_type", "desc": "" }, { "name": "status", "desc": "" }, { "name": "client_source", "desc": "" }, { "name": "client_version", "desc": "" }, { "name": "profile_id", "desc": "" }, { "name": "card_network", "desc": "" }, { "name": "merchant_id", "desc": "" }, { "name": "routing_approach", "desc": "" } ] } ``` ```bash curl -X POST http://localhost:8080/analytics/v1/org/filters/routing \ -H "Content-Type: application/json" \ -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiOGMzNzEwZmMtNDU3NS00NDlmLWFhNzItNWFjOWUyYmJlODViIiwibWVyY2hhbnRfaWQiOiJtZXJjaGFudF8xNzUwNDE0NTE0Iiwicm9sZV9pZCI6Im9yZ19hZG1pbiIsImV4cCI6MTc1MDU4NzUzMCwib3JnX2lkIjoib3JnX2EycGVlblVCaVNqY2dmVzNMQ2xXIiwicHJvZmlsZV9pZCI6InByb184UUJLOHVKRzhaSEd3aVpmV2NBciIsInRlbmFudF9pZCI6InB1YmxpYyJ9.4PuaaBWunN6wnLnm6Pxj08r9rXuuMrZ6GfYewQX9IFE" \ -d '{ "timeRange": { "startTime": "2025-06-11T18:30:00.000Z", "endTime": "2025-06-20T11:10:32.000Z" }, "groupByNames": [ "connector", "payment_method", "payment_method_type", "currency", "authentication_type", "status", "client_source", "client_version", "profile_id", "card_network", "merchant_id", "routing_approach" ], "source": "BATCH", "delta": true }' ``` ```bash curl 'http://localhost:8080/analytics/v1/org/metrics/routing' \ -H 'Accept: /' \ -H 'Accept-Language: en-GB,en-US;q=0.9,en;q=0.8' \ -H 'Connection: keep-alive' \ -H 'Content-Type: application/json' \ -H 'Origin: http://localhost:9000' \ -H 'Referer: http://localhost:9000/' \ -H 'Sec-Fetch-Dest: empty' \ -H 'Sec-Fetch-Mode: cors' \ -H 'Sec-Fetch-Site: same-site' \ -H 'User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/136.0.0.0 Safari/537.36' \ -H 'X-Merchant-Id: merchant_1750414514' \ -H 'X-Profile-Id: pro_8QBK8uJG8ZHGwiZfWcAr' \ -H 'api-key: hyperswitch' \ -H 'authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiOGMzNzEwZmMtNDU3NS00NDlmLWFhNzItNWFjOWUyYmJlODViIiwibWVyY2hhbnRfaWQiOiJtZXJjaGFudF8xNzUwNDE0NTE0Iiwicm9sZV9pZCI6Im9yZ19hZG1pbiIsImV4cCI6MTc1MDg1MDY3MCwib3JnX2lkIjoib3JnX2EycGVlblVCaVNqY2dmVzNMQ2xXIiwicHJvZmlsZV9pZCI6InByb184UUJLOHVKRzhaSEd3aVpmV2NBciIsInRlbmFudF9pZCI6InB1YmxpYyJ9.wutHNAmKapYOM4kcOF0t-Lrrx-ZVFKelyFCXk_Xk8JA' \ -H 'sec-ch-ua: "Chromium";v="136", "Google Chrome";v="136", "Not.A/Brand";v="99"' \ -H 'sec-ch-ua-mobile: ?0' \ -H 'sec-ch-ua-platform: "macOS"' \ --data-raw '[{"timeRange":{"startTime":"2025-06-12T18:30:00Z","endTime":"2025-06-23T18:23:53Z"},"groupByNames":["routing_approach","connector"],"source":"BATCH","metrics":[ "payment_count","payment_success_rate", "payment_processed_amount"],"delta":true}]' ``` Response ```json { "queryData": [ { "payment_success_rate": null, "payment_count": null, "payment_success_count": null, "payment_processed_amount": 20400, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "currency": "USD", "status": null, "connector": "stripe", "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": "rule_based_routing", "time_range": { "start_time": "2025-06-12T18:30:00.000Z", "end_time": "2025-06-23T18:23:53.000Z" }, "time_bucket": "2025-06-12 18:30:00" }, { "payment_success_rate": null, "payment_count": null, "payment_success_count": null, "payment_processed_amount": 20300, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "currency": "USD", "status": null, "connector": "pretendpay", "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": null, "time_range": { "start_time": "2025-06-12T18:30:00.000Z", "end_time": "2025-06-23T18:23:53.000Z" }, "time_bucket": "2025-06-12 18:30:00" }, { "payment_success_rate": 100.0, "payment_count": 2, "payment_success_count": null, "payment_processed_amount": 0, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "currency": null, "status": null, "connector": "stripe", "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": "volume_based_routing", "time_range": { "start_time": "2025-06-12T18:30:00.000Z", "end_time": "2025-06-23T18:23:53.000Z" }, "time_bucket": "2025-06-12 18:30:00" }, { "payment_success_rate": 100.0, "payment_count": 2, "payment_success_count": null, "payment_processed_amount": 0, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "currency": null, "status": null, "connector": "stripe", "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": "rule_based_routing", "time_range": { "start_time": "2025-06-12T18:30:00.000Z", "end_time": "2025-06-23T18:23:53.000Z" }, "time_bucket": "2025-06-12 18:30:00" }, { "payment_success_rate": null, "payment_count": null, "payment_success_count": null, "payment_processed_amount": 10200, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "currency": "USD", "status": null, "connector": "stripe", "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": "default_fallback", "time_range": { "start_time": "2025-06-12T18:30:00.000Z", "end_time": "2025-06-23T18:23:53.000Z" }, "time_bucket": "2025-06-12 18:30:00" }, { "payment_success_rate": 100.0, "payment_count": 4, "payment_success_count": null, "payment_processed_amount": 0, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "currency": null, "status": null, "connector": "stripe", "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": null, "time_range": { "start_time": "2025-06-12T18:30:00.000Z", "end_time": "2025-06-23T18:23:53.000Z" }, "time_bucket": "2025-06-12 18:30:00" }, { "payment_success_rate": 0.0, "payment_count": 12, "payment_success_count": null, "payment_processed_amount": 0, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "currency": null, "status": null, "connector": null, "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": null, "time_range": { "start_time": "2025-06-12T18:30:00.000Z", "end_time": "2025-06-23T18:23:53.000Z" }, "time_bucket": "2025-06-12 18:30:00" }, { "payment_success_rate": 0.0, "payment_count": 6, "payment_success_count": null, "payment_processed_amount": 0, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "currency": null, "status": null, "connector": null, "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": "rule_based_routing", "time_range": { "start_time": "2025-06-12T18:30:00.000Z", "end_time": "2025-06-23T18:23:53.000Z" }, "time_bucket": "2025-06-12 18:30:00" }, { "payment_success_rate": null, "payment_count": null, "payment_success_count": null, "payment_processed_amount": 20000, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "currency": "USD", "status": null, "connector": "stripe", "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": "volume_based_routing", "time_range": { "start_time": "2025-06-12T18:30:00.000Z", "end_time": "2025-06-23T18:23:53.000Z" }, "time_bucket": "2025-06-12 18:30:00" }, { "payment_success_rate": null, "payment_count": null, "payment_success_count": null, "payment_processed_amount": 40000, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "currency": "USD", "status": null, "connector": "stripe", "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": null, "time_range": { "start_time": "2025-06-12T18:30:00.000Z", "end_time": "2025-06-23T18:23:53.000Z" }, "time_bucket": "2025-06-12 18:30:00" }, { "payment_success_rate": 100.0, "payment_count": 2, "payment_success_count": null, "payment_processed_amount": 0, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "currency": null, "status": null, "connector": "pretendpay", "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": null, "time_range": { "start_time": "2025-06-12T18:30:00.000Z", "end_time": "2025-06-23T18:23:53.000Z" }, "time_bucket": "2025-06-12 18:30:00" }, { "payment_success_rate": 100.0, "payment_count": 1, "payment_success_count": null, "payment_processed_amount": 0, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "currency": null, "status": null, "connector": "stripe", "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": "default_fallback", "time_range": { "start_time": "2025-06-12T18:30:00.000Z", "end_time": "2025-06-23T18:23:53.000Z" }, "time_bucket": "2025-06-12 18:30:00" } ], "metaData": [ { "total_payment_processed_amount": 110900, "total_payment_processed_amount_in_usd": null, "total_payment_processed_amount_without_smart_retries": 0, "total_payment_processed_amount_without_smart_retries_usd": null, "total_payment_processed_count": 0, "total_payment_processed_count_without_smart_retries": 0, "total_failure_reasons_count": 0, "total_failure_reasons_count_without_smart_retries": 0 } ] } ``` ## Checklist <!-- Put an `x` in the boxes that apply --> - [ ] I formatted the code `cargo +nightly fmt --all` - [ ] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.114.0	0851c6ece574ce961830c14d91e6e2040cb3b286	0851c6ece574ce961830c14d91e6e2040cb3b286
juspay/hyperswitch	juspay__hyperswitch-8398	Bug: [FEATURE] [AUTHIPAY] Integrate cards non-3ds payments ### Feature Description cards non-3ds payments needs to be integrated for authipay ### Possible Implementation cards non-3ds payments needs to be integrated for authipay ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? None	diff --git a/api-reference/v1/openapi_spec_v1.json b/api-reference/v1/openapi_spec_v1.json index 940922743ca..d748f65261a 100644 --- a/api-reference/v1/openapi_spec_v1.json +++ b/api-reference/v1/openapi_spec_v1.json @@ -10916,6 +10916,7 @@ "Connector": { "type": "string", "enum": [ + "authipay", "adyenplatform", "stripe_billing_test", "phonypay", @@ -27926,6 +27927,7 @@ "type": "string", "description": "RoutableConnectors are the subset of Connectors that are eligible for payments routing", "enum": [ + "authipay", "adyenplatform", "stripe_billing_test", "phonypay", diff --git a/api-reference/v2/openapi_spec_v2.json b/api-reference/v2/openapi_spec_v2.json index 12340ea5dcb..53bbace7dfb 100644 --- a/api-reference/v2/openapi_spec_v2.json +++ b/api-reference/v2/openapi_spec_v2.json @@ -8123,6 +8123,7 @@ "Connector": { "type": "string", "enum": [ + "authipay", "adyenplatform", "stripe_billing_test", "phonypay", @@ -22643,6 +22644,7 @@ "type": "string", "description": "RoutableConnectors are the subset of Connectors that are eligible for payments routing", "enum": [ + "authipay", "adyenplatform", "stripe_billing_test", "phonypay", diff --git a/config/config.example.toml b/config/config.example.toml index 10f796128f7..2b1916d41c2 100644 --- a/config/config.example.toml +++ b/config/config.example.toml @@ -189,6 +189,7 @@ airwallex.base_url = "https://api-demo.airwallex.com/" amazonpay.base_url = "https://pay-api.amazon.com/v2" applepay.base_url = "https://apple-pay-gateway.apple.com/" archipel.base_url = "https://{{merchant_endpoint_prefix}}/ArchiPEL/Transaction/v1" +authipay.base_url = "https://prod.emea.api.fiservapps.com/sandbox/ipp/payments-gateway/v2" authorizedotnet.base_url = "https://apitest.authorize.net/xml/v1/request.api" bambora.base_url = "https://api.na.bambora.com" bamboraapac.base_url = "https://demo.ippayments.com.au/interface/api" @@ -343,6 +344,7 @@ cards = [ "adyen", "adyenplatform", "archipel", + "authipay", "authorizedotnet", "celero", "coinbase", diff --git a/config/deployments/integration_test.toml b/config/deployments/integration_test.toml index 803047dca2e..f839aabbf60 100644 --- a/config/deployments/integration_test.toml +++ b/config/deployments/integration_test.toml @@ -28,6 +28,7 @@ airwallex.base_url = "https://api-demo.airwallex.com/" amazonpay.base_url = "https://pay-api.amazon.com/v2" applepay.base_url = "https://apple-pay-gateway.apple.com/" archipel.base_url = "https://{{merchant_endpoint_prefix}}/ArchiPEL/Transaction/v1" +authipay.base_url = "https://prod.emea.api.fiservapps.com/sandbox/ipp/payments-gateway/v2/" authorizedotnet.base_url = "https://apitest.authorize.net/xml/v1/request.api" bambora.base_url = "https://api.na.bambora.com" bamboraapac.base_url = "https://demo.ippayments.com.au/interface/api" diff --git a/config/deployments/production.toml b/config/deployments/production.toml index 94d8f18d44d..36f80248f9b 100644 --- a/config/deployments/production.toml +++ b/config/deployments/production.toml @@ -32,6 +32,7 @@ airwallex.base_url = "https://api.airwallex.com/" amazonpay.base_url = "https://pay-api.amazon.com/v2" applepay.base_url = "https://apple-pay-gateway.apple.com/" archipel.base_url = "https://{{merchant_endpoint_prefix}}/ArchiPEL/Transaction/v1" +authipay.base_url = "https://prod.emea.api.fiservapps.com/ipp/payments-gateway/v2/" authorizedotnet.base_url = "https://api.authorize.net/xml/v1/request.api" bambora.base_url = "https://api.na.bambora.com" bamboraapac.base_url = "https://www.bambora.co.nz/interface/api/dts.asmx" diff --git a/config/deployments/sandbox.toml b/config/deployments/sandbox.toml index 99daaab178d..3018fb176d0 100644 --- a/config/deployments/sandbox.toml +++ b/config/deployments/sandbox.toml @@ -32,6 +32,7 @@ airwallex.base_url = "https://api-demo.airwallex.com/" amazonpay.base_url = "https://pay-api.amazon.com/v2" applepay.base_url = "https://apple-pay-gateway.apple.com/" archipel.base_url = "https://{{merchant_endpoint_prefix}}/ArchiPEL/Transaction/v1" +authipay.base_url = "https://prod.emea.api.fiservapps.com/sandbox/ipp/payments-gateway/v2" authorizedotnet.base_url = "https://apitest.authorize.net/xml/v1/request.api" bambora.base_url = "https://api.na.bambora.com" bamboraapac.base_url = "https://demo.ippayments.com.au/interface/api" diff --git a/config/development.toml b/config/development.toml index b72f7bcbaee..8808aabb0ef 100644 --- a/config/development.toml +++ b/config/development.toml @@ -99,6 +99,7 @@ cards = [ "airwallex", "amazonpay", "archipel", + "authipay", "authorizedotnet", "bambora", "bamboraapac", @@ -227,6 +228,7 @@ airwallex.base_url = "https://api-demo.airwallex.com/" amazonpay.base_url = "https://pay-api.amazon.com/v2" applepay.base_url = "https://apple-pay-gateway.apple.com/" archipel.base_url = "https://{{merchant_endpoint_prefix}}/ArchiPEL/Transaction/v1" +authipay.base_url = "https://prod.emea.api.fiservapps.com/sandbox/ipp/payments-gateway/v2/" authorizedotnet.base_url = "https://apitest.authorize.net/xml/v1/request.api" bambora.base_url = "https://api.na.bambora.com" bamboraapac.base_url = "https://demo.ippayments.com.au/interface/api" diff --git a/config/docker_compose.toml b/config/docker_compose.toml index ef3ad0b1b05..b232636421f 100644 --- a/config/docker_compose.toml +++ b/config/docker_compose.toml @@ -115,6 +115,7 @@ airwallex.base_url = "https://api-demo.airwallex.com/" amazonpay.base_url = "https://pay-api.amazon.com/v2" applepay.base_url = "https://apple-pay-gateway.apple.com/" archipel.base_url = "https://{{merchant_endpoint_prefix}}/ArchiPEL/Transaction/v1" +authipay.base_url = "https://prod.emea.api.fiservapps.com/sandbox/ipp/payments-gateway/v2/" authorizedotnet.base_url = "https://apitest.authorize.net/xml/v1/request.api" bambora.base_url = "https://api.na.bambora.com" bamboraapac.base_url = "https://demo.ippayments.com.au/interface/api" @@ -251,6 +252,7 @@ cards = [ "airwallex", "amazonpay", "archipel", + "authipay", "authorizedotnet", "bambora", "bamboraapac", diff --git a/config/payment_required_fields_v2.toml b/config/payment_required_fields_v2.toml index cc9ffee29e2..fe1e6e050d2 100644 --- a/config/payment_required_fields_v2.toml +++ b/config/payment_required_fields_v2.toml @@ -47,6 +47,14 @@ common = [ { required_field = "payment_method_data.billing.address.last_name", display_name = "card_holder_name", field_type = "user_full_name" } ] +[required_fields.Card.Debit.fields.Authipay] +common = [ + { required_field = "payment_method_data.card.card_number", display_name = "card_number", field_type = "user_card_number" }, + { required_field = "payment_method_data.card.card_exp_month", display_name = "card_exp_month", field_type = "user_card_expiry_month" }, + { required_field = "payment_method_data.card.card_exp_year", display_name = "card_exp_year", field_type = "user_card_expiry_year" }, + { required_field = "payment_method_data.card.card_cvc", display_name = "card_cvc", field_type = "user_card_cvc" } +] + [required_fields.Card.Debit.fields.Bambora] non_mandate = [ { required_field = "payment_method_data.card.card_number", display_name = "card_number", field_type = "user_card_number" }, @@ -546,6 +554,14 @@ common = [ { required_field = "payment_method_data.card.card_cvc", display_name = "card_cvc", field_type = "user_card_cvc" } ] +[required_fields.Card.Credit.fields.Authipay] +common = [ + { required_field = "payment_method_data.card.card_number", display_name = "card_number", field_type = "user_card_number" }, + { required_field = "payment_method_data.card.card_exp_month", display_name = "card_exp_month", field_type = "user_card_expiry_month" }, + { required_field = "payment_method_data.card.card_exp_year", display_name = "card_exp_year", field_type = "user_card_expiry_year" }, + { required_field = "payment_method_data.card.card_cvc", display_name = "card_cvc", field_type = "user_card_cvc" } +] + [required_fields.Card.Credit.fields.Bambora] non_mandate = [ { required_field = "payment_method_data.card.card_number", display_name = "card_number", field_type = "user_card_number" }, @@ -2341,4 +2357,4 @@ non_mandate = [ [required_fields.card_redirect.momo_atm.fields.Adyen] common = [] mandate = [] -non_mandate = [] \ No newline at end of file +non_mandate = [] diff --git a/crates/common_enums/src/connector_enums.rs b/crates/common_enums/src/connector_enums.rs index 5251b9b3177..41563d56f27 100644 --- a/crates/common_enums/src/connector_enums.rs +++ b/crates/common_enums/src/connector_enums.rs @@ -25,6 +25,7 @@ pub use crate::PaymentMethodType; #[strum(serialize_all = "snake_case")] /// RoutableConnectors are the subset of Connectors that are eligible for payments routing pub enum RoutableConnectors { + Authipay, Adyenplatform, #[cfg(feature = "dummy_connector")] #[serde(rename = "stripe_billing_test")] @@ -184,6 +185,7 @@ pub enum RoutableConnectors { #[serde(rename_all = "snake_case")] #[strum(serialize_all = "snake_case")] pub enum Connector { + Authipay, Adyenplatform, #[cfg(feature = "dummy_connector")] #[serde(rename = "stripe_billing_test")] @@ -404,6 +406,7 @@ impl Connector { \| Self::DummyConnector7 => false, Self::Aci // Add Separate authentication support for connectors + \| Self::Authipay \| Self::Adyen \| Self::Adyenplatform \| Self::Airwallex @@ -551,6 +554,7 @@ impl Connector { impl From<RoutableConnectors> for Connector { fn from(routable_connector: RoutableConnectors) -> Self { match routable_connector { + RoutableConnectors::Authipay => Self::Authipay, RoutableConnectors::Adyenplatform => Self::Adyenplatform, #[cfg(feature = "dummy_connector")] RoutableConnectors::DummyBillingConnector => Self::DummyBillingConnector, @@ -673,6 +677,7 @@ impl TryFrom<Connector> for RoutableConnectors { fn try_from(connector: Connector) -> Result<Self, Self::Error> { match connector { + Connector::Authipay => Ok(Self::Authipay), Connector::Adyenplatform => Ok(Self::Adyenplatform), #[cfg(feature = "dummy_connector")] Connector::DummyBillingConnector => Ok(Self::DummyBillingConnector), diff --git a/crates/connector_configs/src/connector.rs b/crates/connector_configs/src/connector.rs index f092b543f8c..67e340fa155 100644 --- a/crates/connector_configs/src/connector.rs +++ b/crates/connector_configs/src/connector.rs @@ -171,6 +171,7 @@ pub struct ConnectorTomlConfig { #[serde_with::skip_serializing_none] #[derive(Debug, Deserialize, serde::Serialize, Clone)] pub struct ConnectorConfig { + pub authipay: Option<ConnectorTomlConfig>, pub juspaythreedsserver: Option<ConnectorTomlConfig>, pub aci: Option<ConnectorTomlConfig>, pub adyen: Option<ConnectorTomlConfig>, @@ -369,6 +370,7 @@ impl ConnectorConfig { let connector_data = Self::new()?; match connector { Connector::Aci => Ok(connector_data.aci), + Connector::Authipay => Ok(connector_data.authipay), Connector::Adyen => Ok(connector_data.adyen), Connector::Adyenplatform => Err("Use get_payout_connector_config".to_string()), Connector::Airwallex => Ok(connector_data.airwallex), diff --git a/crates/connector_configs/toml/development.toml b/crates/connector_configs/toml/development.toml index f8919cba957..a8a0baa2661 100644 --- a/crates/connector_configs/toml/development.toml +++ b/crates/connector_configs/toml/development.toml @@ -502,7 +502,21 @@ required=true type="MultiSelect" options=["PAN_ONLY", "CRYPTOGRAM_3DS"] - +[authipay] +[[authipay.credit]] + payment_method_type = "Mastercard" +[[authipay.credit]] + payment_method_type = "Visa" +[[authipay.debit]] + payment_method_type = "Mastercard" +[[authipay.debit]] + payment_method_type = "Visa" +[authipay.connector_auth.SignatureKey] +api_key="API Key" +api_secret="API Secret" +key1="Merchant ID" +[authipay.connector_webhook_details] +merchant_secret="Source verification key" [authorizedotnet] [[authorizedotnet.credit]] diff --git a/crates/connector_configs/toml/production.toml b/crates/connector_configs/toml/production.toml index 667c5028c95..a22b50a9b4f 100644 --- a/crates/connector_configs/toml/production.toml +++ b/crates/connector_configs/toml/production.toml @@ -305,6 +305,22 @@ key1="Client ID" [airwallex.connector_webhook_details] merchant_secret="Source verification key" +[authipay] +[[authipay.credit]] + payment_method_type = "Mastercard" +[[authipay.credit]] + payment_method_type = "Visa" +[[authipay.debit]] + payment_method_type = "Mastercard" +[[authipay.debit]] + payment_method_type = "Visa" +[authipay.connector_auth.SignatureKey] +api_key="API Key" +api_secret="API Secret" +key1="Merchant ID" +[authipay.connector_webhook_details] +merchant_secret="Source verification key" + [authorizedotnet] [[authorizedotnet.credit]] payment_method_type = "Mastercard" diff --git a/crates/connector_configs/toml/sandbox.toml b/crates/connector_configs/toml/sandbox.toml index 20b7cdf09bf..d7026129699 100644 --- a/crates/connector_configs/toml/sandbox.toml +++ b/crates/connector_configs/toml/sandbox.toml @@ -503,7 +503,21 @@ required=true type="MultiSelect" options=["PAN_ONLY", "CRYPTOGRAM_3DS"] - +[authipay] +[[authipay.credit]] + payment_method_type = "Mastercard" +[[authipay.credit]] + payment_method_type = "Visa" +[[authipay.debit]] + payment_method_type = "Mastercard" +[[authipay.debit]] + payment_method_type = "Visa" +[authipay.connector_auth.SignatureKey] +api_key="API Key" +api_secret="API Secret" +key1="Merchant ID" +[authipay.connector_webhook_details] +merchant_secret="Source verification key" [authorizedotnet] [[authorizedotnet.credit]] diff --git a/crates/hyperswitch_connectors/src/connectors.rs b/crates/hyperswitch_connectors/src/connectors.rs index 6583e2ce5b9..84b53c97143 100644 --- a/crates/hyperswitch_connectors/src/connectors.rs +++ b/crates/hyperswitch_connectors/src/connectors.rs @@ -4,6 +4,7 @@ pub mod adyenplatform; pub mod airwallex; pub mod amazonpay; pub mod archipel; +pub mod authipay; pub mod authorizedotnet; pub mod bambora; pub mod bamboraapac; @@ -115,16 +116,16 @@ pub mod zsl; pub use self::dummyconnector::DummyConnector; pub use self::{ aci::Aci, adyen::Adyen, adyenplatform::Adyenplatform, airwallex::Airwallex, - amazonpay::Amazonpay, archipel::Archipel, authorizedotnet::Authorizedotnet, bambora::Bambora, - bamboraapac::Bamboraapac, bankofamerica::Bankofamerica, barclaycard::Barclaycard, - billwerk::Billwerk, bitpay::Bitpay, bluesnap::Bluesnap, boku::Boku, braintree::Braintree, - cashtocode::Cashtocode, celero::Celero, chargebee::Chargebee, checkbook::Checkbook, - checkout::Checkout, coinbase::Coinbase, coingate::Coingate, cryptopay::Cryptopay, - ctp_mastercard::CtpMastercard, cybersource::Cybersource, datatrans::Datatrans, - deutschebank::Deutschebank, digitalvirgo::Digitalvirgo, dlocal::Dlocal, dwolla::Dwolla, - ebanx::Ebanx, elavon::Elavon, facilitapay::Facilitapay, fiserv::Fiserv, fiservemea::Fiservemea, - fiuu::Fiuu, forte::Forte, getnet::Getnet, globalpay::Globalpay, globepay::Globepay, - gocardless::Gocardless, gpayments::Gpayments, helcim::Helcim, hipay::Hipay, + amazonpay::Amazonpay, archipel::Archipel, authipay::Authipay, authorizedotnet::Authorizedotnet, + bambora::Bambora, bamboraapac::Bamboraapac, bankofamerica::Bankofamerica, + barclaycard::Barclaycard, billwerk::Billwerk, bitpay::Bitpay, bluesnap::Bluesnap, boku::Boku, + braintree::Braintree, cashtocode::Cashtocode, celero::Celero, chargebee::Chargebee, + checkbook::Checkbook, checkout::Checkout, coinbase::Coinbase, coingate::Coingate, + cryptopay::Cryptopay, ctp_mastercard::CtpMastercard, cybersource::Cybersource, + datatrans::Datatrans, deutschebank::Deutschebank, digitalvirgo::Digitalvirgo, dlocal::Dlocal, + dwolla::Dwolla, ebanx::Ebanx, elavon::Elavon, facilitapay::Facilitapay, fiserv::Fiserv, + fiservemea::Fiservemea, fiuu::Fiuu, forte::Forte, getnet::Getnet, globalpay::Globalpay, + globepay::Globepay, gocardless::Gocardless, gpayments::Gpayments, helcim::Helcim, hipay::Hipay, hyperswitch_vault::HyperswitchVault, iatapay::Iatapay, inespay::Inespay, itaubank::Itaubank, jpmorgan::Jpmorgan, juspaythreedsserver::Juspaythreedsserver, klarna::Klarna, mifinity::Mifinity, mollie::Mollie, moneris::Moneris, multisafepay::Multisafepay, diff --git a/crates/hyperswitch_connectors/src/connectors/authipay.rs b/crates/hyperswitch_connectors/src/connectors/authipay.rs new file mode 100644 index 00000000000..5a5179ef5f1 --- /dev/null +++ b/crates/hyperswitch_connectors/src/connectors/authipay.rs @@ -0,0 +1,849 @@ +pub mod transformers; + +use std::sync::LazyLock; + +use base64::Engine; +use common_enums::enums; +use common_utils::{ + errors::CustomResult, + ext_traits::BytesExt, + request::{Method, Request, RequestBuilder, RequestContent}, + types::{AmountConvertor, FloatMajorUnit, FloatMajorUnitForConnector}, +}; +use error_stack::{report, ResultExt}; +use hyperswitch_domain_models::{ + router_data::{AccessToken, ConnectorAuthType, ErrorResponse, RouterData}, + router_flow_types::{ + access_token_auth::AccessTokenAuth, + payments::{Authorize, Capture, PSync, PaymentMethodToken, Session, SetupMandate, Void}, + refunds::{Execute, RSync}, + }, + router_request_types::{ + AccessTokenRequestData, PaymentMethodTokenizationData, PaymentsAuthorizeData, + PaymentsCancelData, PaymentsCaptureData, PaymentsSessionData, PaymentsSyncData, + RefundsData, SetupMandateRequestData, + }, + router_response_types::{ + ConnectorInfo, PaymentMethodDetails, PaymentsResponseData, RefundsResponseData, + SupportedPaymentMethods, SupportedPaymentMethodsExt, + }, + types::{ + PaymentsAuthorizeRouterData, PaymentsCancelRouterData, PaymentsCaptureRouterData, + PaymentsSyncRouterData, RefundSyncRouterData, RefundsRouterData, + }, +}; +use hyperswitch_interfaces::{ + api::{ + self, ConnectorCommon, ConnectorCommonExt, ConnectorIntegration, ConnectorSpecifications, + ConnectorValidation, + }, + configs::Connectors, + errors, + events::connector_api_logs::ConnectorEvent, + types::{self, Response}, + webhooks, +}; +use masking::{ExposeInterface, Mask, PeekInterface}; +use transformers as authipay; + +use crate::{constants::headers, types::ResponseRouterData, utils}; + +#[derive(Clone)] +pub struct Authipay { + amount_converter: &'static (dyn AmountConvertor<Output = FloatMajorUnit> + Sync), +} + +impl Authipay { + pub fn new() -> &'static Self { + &Self { + amount_converter: &FloatMajorUnitForConnector, + } + } + + pub fn generate_authorization_signature( + &self, + auth: authipay::AuthipayAuthType, + request_id: &str, + payload: &str, + timestamp: i128, + ) -> CustomResult<String, errors::ConnectorError> { + let authipay::AuthipayAuthType { + api_key, + api_secret, + } = auth; + let raw_signature = format!("{}{request_id}{timestamp}{payload}", api_key.peek()); + + let key = ring::hmac::Key::new(ring::hmac::HMAC_SHA256, api_secret.expose().as_bytes()); + let signature_value = common_utils::consts::BASE64_ENGINE + .encode(ring::hmac::sign(&key, raw_signature.as_bytes()).as_ref()); + Ok(signature_value) + } +} + +impl api::Payment for Authipay {} +impl api::PaymentSession for Authipay {} +impl api::ConnectorAccessToken for Authipay {} +impl api::MandateSetup for Authipay {} +impl api::PaymentAuthorize for Authipay {} +impl api::PaymentSync for Authipay {} +impl api::PaymentCapture for Authipay {} +impl api::PaymentVoid for Authipay {} +impl api::Refund for Authipay {} +impl api::RefundExecute for Authipay {} +impl api::RefundSync for Authipay {} +impl api::PaymentToken for Authipay {} + +impl ConnectorIntegration<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData> + for Authipay +{ + // Not Implemented (R) +} + +impl<Flow, Request, Response> ConnectorCommonExt<Flow, Request, Response> for Authipay +where + Self: ConnectorIntegration<Flow, Request, Response>, +{ + fn build_headers( + &self, + req: &RouterData<Flow, Request, Response>, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + let timestamp = time::OffsetDateTime::now_utc().unix_timestamp_nanos() / 1_000_000; + let auth: authipay::AuthipayAuthType = + authipay::AuthipayAuthType::try_from(&req.connector_auth_type)?; + let mut auth_header = self.get_auth_header(&req.connector_auth_type)?; + + let authipay_req = self.get_request_body(req, connectors)?; + + let client_request_id = uuid::Uuid::new_v4().to_string(); + let hmac = self + .generate_authorization_signature( + auth, + &client_request_id, + authipay_req.get_inner_value().peek(), + timestamp, + ) + .change_context(errors::ConnectorError::RequestEncodingFailed)?; + let mut headers = vec![ + ( + headers::CONTENT_TYPE.to_string(), + types::PaymentsAuthorizeType::get_content_type(self) + .to_string() + .into(), + ), + ("Client-Request-Id".to_string(), client_request_id.into()), + ("Auth-Token-Type".to_string(), "HMAC".to_string().into()), + (headers::TIMESTAMP.to_string(), timestamp.to_string().into()), + ("Message-Signature".to_string(), hmac.into_masked()), + ]; + headers.append(&mut auth_header); + Ok(headers) + } +} + +impl ConnectorCommon for Authipay { + fn id(&self) -> &'static str { + "authipay" + } + + fn get_currency_unit(&self) -> api::CurrencyUnit { + api::CurrencyUnit::Base + } + + fn common_get_content_type(&self) -> &'static str { + "application/json" + } + + fn base_url<'a>(&self, connectors: &'a Connectors) -> &'a str { + connectors.authipay.base_url.as_ref() + } + + fn get_auth_header( + &self, + auth_type: &ConnectorAuthType, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + let auth = authipay::AuthipayAuthType::try_from(auth_type) + .change_context(errors::ConnectorError::FailedToObtainAuthType)?; + Ok(vec![( + headers::API_KEY.to_string(), + auth.api_key.into_masked(), + )]) + } + + fn build_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + let response: authipay::AuthipayErrorResponse = res + .response + .parse_struct("AuthipayErrorResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + + event_builder.map(\|i\| i.set_error_response_body(&response)); + + let mut error_response = ErrorResponse::from(&response); + + // Set status code from the response, or 400 if error code is a "404" + if let Some(error_code) = &response.error.code { + if error_code == "404" { + error_response.status_code = 404; + } else { + error_response.status_code = res.status_code; + } + } else { + error_response.status_code = res.status_code; + } + + Ok(error_response) + } +} + +impl ConnectorValidation for Authipay { + fn validate_connector_against_payment_request( + &self, + capture_method: Option<enums::CaptureMethod>, + _payment_method: enums::PaymentMethod, + _pmt: Option<enums::PaymentMethodType>, + ) -> CustomResult<(), errors::ConnectorError> { + let capture_method = capture_method.unwrap_or_default(); + match capture_method { + enums::CaptureMethod::Automatic + \| enums::CaptureMethod::Manual + \| enums::CaptureMethod::SequentialAutomatic => Ok(()), + enums::CaptureMethod::Scheduled \| enums::CaptureMethod::ManualMultiple => Err( + utils::construct_not_implemented_error_report(capture_method, self.id()), + ), + } + } +} + +impl ConnectorIntegration<Session, PaymentsSessionData, PaymentsResponseData> for Authipay { + //TODO: implement sessions flow +} + +impl ConnectorIntegration<AccessTokenAuth, AccessTokenRequestData, AccessToken> for Authipay {} + +impl ConnectorIntegration<SetupMandate, SetupMandateRequestData, PaymentsResponseData> + for Authipay +{ +} + +impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData> for Authipay { + fn get_headers( + &self, + req: &PaymentsAuthorizeRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsAuthorizeRouterData, + connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Ok(format!("{}payments", self.base_url(connectors))) + } + + fn get_request_body( + &self, + req: &PaymentsAuthorizeRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let amount = utils::convert_amount( + self.amount_converter, + req.request.minor_amount, + req.request.currency, + )?; + + let connector_router_data = authipay::AuthipayRouterData::from((amount, req)); + let connector_req = authipay::AuthipayPaymentsRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &PaymentsAuthorizeRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::PaymentsAuthorizeType::get_url( + self, req, connectors, + )?) + .attach_default_headers() + .headers(types::PaymentsAuthorizeType::get_headers( + self, req, connectors, + )?) + .set_body(types::PaymentsAuthorizeType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsAuthorizeRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsAuthorizeRouterData, errors::ConnectorError> { + let response: authipay::AuthipayPaymentsResponse = res + .response + .parse_struct("Authipay PaymentsAuthorizeResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<PSync, PaymentsSyncData, PaymentsResponseData> for Authipay { + fn get_headers( + &self, + req: &PaymentsSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + req: &PaymentsSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + let connector_transaction_id = req + .request + .connector_transaction_id + .get_connector_transaction_id() + .change_context(errors::ConnectorError::RequestEncodingFailed)?; + Ok(format!( + "{}payments/{}", + self.base_url(connectors), + connector_transaction_id + )) + } + + fn get_request_body( + &self, + _req: &PaymentsSyncRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + Ok(RequestContent::RawBytes(Vec::new())) + } + + fn build_request( + &self, + req: &PaymentsSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Get) + .url(&types::PaymentsSyncType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::PaymentsSyncType::get_headers(self, req, connectors)?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsSyncRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsSyncRouterData, errors::ConnectorError> { + let response: authipay::AuthipayPaymentsResponse = res + .response + .parse_struct("authipay PaymentsSyncResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<Capture, PaymentsCaptureData, PaymentsResponseData> for Authipay { + fn get_headers( + &self, + req: &PaymentsCaptureRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + req: &PaymentsCaptureRouterData, + connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + let connector_transaction_id = req.request.connector_transaction_id.clone(); + Ok(format!( + "{}payments/{}", + self.base_url(connectors), + connector_transaction_id + )) + } + + fn get_request_body( + &self, + req: &PaymentsCaptureRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let amount = utils::convert_amount( + self.amount_converter, + req.request.minor_amount_to_capture, + req.request.currency, + )?; + + let connector_router_data = authipay::AuthipayRouterData::from((amount, req)); + let connector_req = authipay::AuthipayCaptureRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &PaymentsCaptureRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::PaymentsCaptureType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::PaymentsCaptureType::get_headers( + self, req, connectors, + )?) + .set_body(types::PaymentsCaptureType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsCaptureRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsCaptureRouterData, errors::ConnectorError> { + let response: authipay::AuthipayPaymentsResponse = res + .response + .parse_struct("Authipay PaymentsCaptureResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<Void, PaymentsCancelData, PaymentsResponseData> for Authipay { + fn get_headers( + &self, + req: &PaymentsCancelRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + req: &PaymentsCancelRouterData, + connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + // For void operations, Authipay requires using the /orders/{orderId} endpoint + // The orderId should be stored in connector_meta from the authorization response + let order_id = req + .request + .connector_meta + .as_ref() + .and_then(\|meta\| meta.get("order_id")) + .and_then(\|v\| v.as_str()) + .ok_or(errors::ConnectorError::RequestEncodingFailed)?; + + Ok(format!("{}orders/{}", self.base_url(connectors), order_id)) + } + + fn get_request_body( + &self, + req: &PaymentsCancelRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + // For void, we don't need amount conversion since it's always full amount + let connector_router_data = + authipay::AuthipayRouterData::from((FloatMajorUnit::zero(), req)); + let connector_req = authipay::AuthipayVoidRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &PaymentsCancelRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::PaymentsVoidType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::PaymentsVoidType::get_headers(self, req, connectors)?) + .set_body(types::PaymentsVoidType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsCancelRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsCancelRouterData, errors::ConnectorError> { + let response: authipay::AuthipayPaymentsResponse = res + .response + .parse_struct("Authipay PaymentsVoidResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<Execute, RefundsData, RefundsResponseData> for Authipay { + fn get_headers( + &self, + req: &RefundsRouterData<Execute>, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + req: &RefundsRouterData<Execute>, + connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + let connector_payment_id = req.request.connector_transaction_id.clone(); + Ok(format!( + "{}payments/{}", + self.base_url(connectors), + connector_payment_id + )) + } + + fn get_request_body( + &self, + req: &RefundsRouterData<Execute>, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let refund_amount = utils::convert_amount( + self.amount_converter, + req.request.minor_refund_amount, + req.request.currency, + )?; + + let connector_router_data = authipay::AuthipayRouterData::from((refund_amount, req)); + let connector_req = authipay::AuthipayRefundRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &RefundsRouterData<Execute>, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + let request = RequestBuilder::new() + .method(Method::Post) + .url(&types::RefundExecuteType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::RefundExecuteType::get_headers( + self, req, connectors, + )?) + .set_body(types::RefundExecuteType::get_request_body( + self, req, connectors, + )?) + .build(); + Ok(Some(request)) + } + + fn handle_response( + &self, + data: &RefundsRouterData<Execute>, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<RefundsRouterData<Execute>, errors::ConnectorError> { + let response: authipay::RefundResponse = res + .response + .parse_struct("authipay RefundResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<RSync, RefundsData, RefundsResponseData> for Authipay { + fn get_headers( + &self, + req: &RefundSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + req: &RefundSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + let refund_id = req + .request + .connector_refund_id + .clone() + .ok_or(errors::ConnectorError::RequestEncodingFailed)?; + Ok(format!( + "{}payments/{}", + self.base_url(connectors), + refund_id + )) + } + + fn get_request_body( + &self, + _req: &RefundSyncRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + Ok(RequestContent::RawBytes(Vec::new())) + } + + fn build_request( + &self, + req: &RefundSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Get) + .url(&types::RefundSyncType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::RefundSyncType::get_headers(self, req, connectors)?) + .build(), + )) + } + + fn handle_response( + &self, + data: &RefundSyncRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<RefundSyncRouterData, errors::ConnectorError> { + let response: authipay::RefundResponse = res + .response + .parse_struct("authipay RefundSyncResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(\|i\| i.set_response_body(&response)); + + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +#[async_trait::async_trait] +impl webhooks::IncomingWebhook for Authipay { + fn get_webhook_object_reference_id( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<api_models::webhooks::ObjectReferenceId, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } + + fn get_webhook_event_type( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<api_models::webhooks::IncomingWebhookEvent, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } + + fn get_webhook_resource_object( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<Box<dyn masking::ErasedMaskSerialize>, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } +} + +static AUTHIPAY_SUPPORTED_PAYMENT_METHODS: LazyLock<SupportedPaymentMethods> = + LazyLock::new(\|\| { + let supported_capture_methods = vec![ + enums::CaptureMethod::Automatic, + enums::CaptureMethod::SequentialAutomatic, + enums::CaptureMethod::Manual, + ]; + + let supported_card_network = vec![ + common_enums::CardNetwork::Visa, + common_enums::CardNetwork::Mastercard, + ]; + + let mut authipay_supported_payment_methods = SupportedPaymentMethods::new(); + + authipay_supported_payment_methods.add( + enums::PaymentMethod::Card, + enums::PaymentMethodType::Credit, + PaymentMethodDetails { + mandates: enums::FeatureStatus::NotSupported, + refunds: enums::FeatureStatus::Supported, + supported_capture_methods: supported_capture_methods.clone(), + specific_features: Some( + api_models::feature_matrix::PaymentMethodSpecificFeatures::Card({ + api_models::feature_matrix::CardSpecificFeatures { + three_ds: common_enums::FeatureStatus::NotSupported, + no_three_ds: common_enums::FeatureStatus::Supported, + supported_card_networks: supported_card_network.clone(), + } + }), + ), + }, + ); + + authipay_supported_payment_methods.add( + enums::PaymentMethod::Card, + enums::PaymentMethodType::Debit, + PaymentMethodDetails { + mandates: enums::FeatureStatus::NotSupported, + refunds: enums::FeatureStatus::Supported, + supported_capture_methods: supported_capture_methods.clone(), + specific_features: Some( + api_models::feature_matrix::PaymentMethodSpecificFeatures::Card({ + api_models::feature_matrix::CardSpecificFeatures { + three_ds: common_enums::FeatureStatus::NotSupported, + no_three_ds: common_enums::FeatureStatus::Supported, + supported_card_networks: supported_card_network.clone(), + } + }), + ), + }, + ); + + authipay_supported_payment_methods + }); + +static AUTHIPAY_CONNECTOR_INFO: ConnectorInfo = ConnectorInfo { + display_name: "Authipay", + description: "Authipay is a Fiserv-powered payment gateway for the EMEA region supporting Visa and Mastercard transactions. Features include flexible capture methods (automatic, manual, sequential), partial captures/refunds, payment tokenization, and secure HMAC SHA256 authentication.", + connector_type: enums::PaymentConnectorCategory::PaymentGateway, +}; + +static AUTHIPAY_SUPPORTED_WEBHOOK_FLOWS: [enums::EventClass; 0] = []; + +impl ConnectorSpecifications for Authipay { + fn get_connector_about(&self) -> Option<&'static ConnectorInfo> { + Some(&AUTHIPAY_CONNECTOR_INFO) + } + + fn get_supported_payment_methods(&self) -> Option<&'static SupportedPaymentMethods> { + Some(&AUTHIPAY_SUPPORTED_PAYMENT_METHODS) + } + + fn get_supported_webhook_flows(&self) -> Option<&'static [enums::EventClass]> { + Some(&AUTHIPAY_SUPPORTED_WEBHOOK_FLOWS) + } +} diff --git a/crates/hyperswitch_connectors/src/connectors/authipay/transformers.rs b/crates/hyperswitch_connectors/src/connectors/authipay/transformers.rs new file mode 100644 index 00000000000..c7c21404752 --- /dev/null +++ b/crates/hyperswitch_connectors/src/connectors/authipay/transformers.rs @@ -0,0 +1,624 @@ +use cards; +use common_enums::enums; +use common_utils::types::FloatMajorUnit; +use hyperswitch_domain_models::{ + payment_method_data::PaymentMethodData, + router_data::{ConnectorAuthType, ErrorResponse, RouterData}, + router_flow_types::refunds::{Execute, RSync}, + router_request_types::ResponseId, + router_response_types::{PaymentsResponseData, RefundsResponseData}, + types::{ + PaymentsAuthorizeRouterData, PaymentsCancelRouterData, PaymentsCaptureRouterData, + RefundsRouterData, + }, +}; +use hyperswitch_interfaces::errors; +use masking::Secret; +use serde::{Deserialize, Serialize}; + +use crate::{ + types::{RefundsResponseRouterData, ResponseRouterData}, + utils, +}; + +// Type definition for router data with amount +pub struct AuthipayRouterData<T> { + pub amount: FloatMajorUnit, // Amount in major units (e.g., dollars instead of cents) + pub router_data: T, +} + +impl<T> From<(FloatMajorUnit, T)> for AuthipayRouterData<T> { + fn from((amount, item): (FloatMajorUnit, T)) -> Self { + Self { + amount, + router_data: item, + } + } +} + +// Basic request/response structs used across multiple operations + +#[derive(Default, Debug, Serialize, Deserialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct Amount { + total: FloatMajorUnit, + currency: String, + #[serde(skip_serializing_if = "Option::is_none")] + components: Option<AmountComponents>, +} + +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct AmountComponents { + subtotal: FloatMajorUnit, +} + +#[derive(Default, Debug, Serialize, Deserialize, Clone, Eq, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct ExpiryDate { + month: Secret<String>, + year: Secret<String>, +} + +#[derive(Default, Debug, Serialize, Eq, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct Card { + number: cards::CardNumber, + security_code: Secret<String>, + expiry_date: ExpiryDate, +} + +#[derive(Default, Debug, Serialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct PaymentMethod { + payment_card: Card, +} + +#[derive(Default, Debug, Serialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct SplitShipment { + total_count: i32, + final_shipment: bool, +} + +#[derive(Debug, Serialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct AuthipayPaymentsRequest { + request_type: &'static str, + transaction_amount: Amount, + payment_method: PaymentMethod, + // split_shipment: Option<SplitShipment>, + // incremental_flag: Option<bool>, +} + +impl TryFrom<&AuthipayRouterData<&PaymentsAuthorizeRouterData>> for AuthipayPaymentsRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: &AuthipayRouterData<&PaymentsAuthorizeRouterData>, + ) -> Result<Self, Self::Error> { + // Check if 3DS is being requested - Authipay doesn't support 3DS + if matches!( + item.router_data.auth_type, + enums::AuthenticationType::ThreeDs + ) { + return Err(errors::ConnectorError::NotImplemented( + utils::get_unimplemented_payment_method_error_message("authipay"), + ) + .into()); + } + + match item.router_data.request.payment_method_data.clone() { + PaymentMethodData::Card(req_card) => { + let expiry_date = ExpiryDate { + month: req_card.card_exp_month.clone(), + year: req_card.card_exp_year.clone(), + }; + + let card = Card { + number: req_card.card_number.clone(), + security_code: req_card.card_cvc.clone(), + expiry_date, + }; + + let payment_method = PaymentMethod { payment_card: card }; + + let transaction_amount = Amount { + total: item.amount, + currency: item.router_data.request.currency.to_string(), + components: None, + }; + + // Determine request type based on capture method + let request_type = match item.router_data.request.capture_method { + Some(enums::CaptureMethod::Manual) => "PaymentCardPreAuthTransaction", + Some(enums::CaptureMethod::Automatic) => "PaymentCardSaleTransaction", + Some(enums::CaptureMethod::SequentialAutomatic) => "PaymentCardSaleTransaction", + Some(enums::CaptureMethod::ManualMultiple) + \| Some(enums::CaptureMethod::Scheduled) => { + return Err(errors::ConnectorError::NotSupported { + message: "Capture method not supported by Authipay".to_string(), + connector: "Authipay", + } + .into()); + } + None => "PaymentCardSaleTransaction", // Default when not specified + }; + + let request = Self { + request_type, + transaction_amount, + payment_method, + }; + + Ok(request) + } + _ => Err(errors::ConnectorError::NotImplemented( + utils::get_unimplemented_payment_method_error_message("authipay"), + ) + .into()), + } + } +} + +//TODO: Fill the struct with respective fields +// Auth Struct +pub struct AuthipayAuthType { + pub(super) api_key: Secret<String>, + pub(super) api_secret: Secret<String>, +} + +impl TryFrom<&ConnectorAuthType> for AuthipayAuthType { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from(auth_type: &ConnectorAuthType) -> Result<Self, Self::Error> { + match auth_type { + ConnectorAuthType::SignatureKey { + api_key, + api_secret, + .. + } => Ok(Self { + api_key: api_key.to_owned(), + api_secret: api_secret.to_owned(), + }), + _ => Err(errors::ConnectorError::FailedToObtainAuthType.into()), + } + } +} +// Transaction Status enum (like Fiserv's FiservPaymentStatus) +#[derive(Debug, Clone, Default, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "UPPERCASE")] +pub enum AuthipayTransactionStatus { + Authorized, + Captured, + Voided, + Declined, + Failed, + #[default] + Processing, +} + +impl From<AuthipayTransactionStatus> for enums::AttemptStatus { + fn from(item: AuthipayTransactionStatus) -> Self { + match item { + AuthipayTransactionStatus::Captured => Self::Charged, + AuthipayTransactionStatus::Declined \| AuthipayTransactionStatus::Failed => { + Self::Failure + } + AuthipayTransactionStatus::Processing => Self::Pending, + AuthipayTransactionStatus::Authorized => Self::Authorized, + AuthipayTransactionStatus::Voided => Self::Voided, + } + } +} + +// Transaction Processing Details (like Fiserv's TransactionProcessingDetails) +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct AuthipayTransactionProcessingDetails { + pub order_id: String, + pub transaction_id: String, +} + +// Gateway Response (like Fiserv's GatewayResponse) +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct AuthipayGatewayResponse { + pub transaction_state: AuthipayTransactionStatus, + pub transaction_processing_details: AuthipayTransactionProcessingDetails, +} + +// Payment Receipt (like Fiserv's PaymentReceipt) +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct AuthipayPaymentReceipt { + pub approved_amount: Amount, + pub processor_response_details: Option<Processor>, +} + +// Main Response (like Fiserv's FiservPaymentsResponse) - but flat for JSON deserialization +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct AuthipayPaymentsResponse { + #[serde(rename = "type")] + response_type: Option<String>, + client_request_id: String, + api_trace_id: String, + ipg_transaction_id: String, + order_id: String, + transaction_type: String, + payment_token: Option<PaymentToken>, + transaction_origin: Option<String>, + payment_method_details: Option<PaymentMethodDetails>, + country: Option<String>, + terminal_id: Option<String>, + merchant_id: Option<String>, + transaction_time: i64, + approved_amount: Amount, + transaction_amount: Amount, + // For payment transactions (SALE) + transaction_status: Option<String>, + // For refund transactions (RETURN) + transaction_result: Option<String>, + transaction_state: Option<String>, + approval_code: String, + scheme_transaction_id: Option<String>, + processor: Processor, +} + +impl AuthipayPaymentsResponse { + /// Get gateway response (like Fiserv's gateway_response) + pub fn gateway_response(&self) -> AuthipayGatewayResponse { + AuthipayGatewayResponse { + transaction_state: self.get_transaction_status(), + transaction_processing_details: AuthipayTransactionProcessingDetails { + order_id: self.order_id.clone(), + transaction_id: self.ipg_transaction_id.clone(), + }, + } + } + + /// Get payment receipt (like Fiserv's payment_receipt) + pub fn payment_receipt(&self) -> AuthipayPaymentReceipt { + AuthipayPaymentReceipt { + approved_amount: self.approved_amount.clone(), + processor_response_details: Some(self.processor.clone()), + } + } + + /// Determine the transaction status based on transaction type and various status fields (like Fiserv) + fn get_transaction_status(&self) -> AuthipayTransactionStatus { + match self.transaction_type.as_str() { + "RETURN" => { + // Refund transaction - use transaction_result + match self.transaction_result.as_deref() { + Some("APPROVED") => AuthipayTransactionStatus::Captured, + Some("DECLINED") \| Some("FAILED") => AuthipayTransactionStatus::Failed, + _ => AuthipayTransactionStatus::Processing, + } + } + "VOID" => { + // Void transaction - use transaction_result, fallback to transaction_state + match self.transaction_result.as_deref() { + Some("APPROVED") => AuthipayTransactionStatus::Voided, + Some("DECLINED") \| Some("FAILED") => AuthipayTransactionStatus::Failed, + Some("PENDING") \| Some("PROCESSING") => AuthipayTransactionStatus::Processing, + _ => { + // Fallback to transaction_state for void operations + match self.transaction_state.as_deref() { + Some("VOIDED") => AuthipayTransactionStatus::Voided, + Some("FAILED") \| Some("DECLINED") => AuthipayTransactionStatus::Failed, + _ => AuthipayTransactionStatus::Voided, // Default assumption for void requests + } + } + } + } + _ => { + // Payment transaction - prioritize transaction_state over transaction_status + match self.transaction_state.as_deref() { + Some("AUTHORIZED") => AuthipayTransactionStatus::Authorized, + Some("CAPTURED") => AuthipayTransactionStatus::Captured, + Some("VOIDED") => AuthipayTransactionStatus::Voided, + Some("DECLINED") \| Some("FAILED") => AuthipayTransactionStatus::Failed, + _ => { + // Fallback to transaction_status with transaction_type context + match ( + self.transaction_type.as_str(), + self.transaction_status.as_deref(), + ) { + // For PREAUTH transactions, "APPROVED" means authorized and awaiting capture + ("PREAUTH", Some("APPROVED")) => AuthipayTransactionStatus::Authorized, + // For POSTAUTH transactions, "APPROVED" means successfully captured + ("POSTAUTH", Some("APPROVED")) => AuthipayTransactionStatus::Captured, + // For SALE transactions, "APPROVED" means completed payment + ("SALE", Some("APPROVED")) => AuthipayTransactionStatus::Captured, + // For VOID transactions, "APPROVED" means successfully voided + ("VOID", Some("APPROVED")) => AuthipayTransactionStatus::Voided, + // Generic status mappings for other cases + (_, Some("APPROVED")) => AuthipayTransactionStatus::Captured, + (_, Some("AUTHORIZED")) => AuthipayTransactionStatus::Authorized, + (_, Some("DECLINED") \| Some("FAILED")) => { + AuthipayTransactionStatus::Failed + } + _ => AuthipayTransactionStatus::Processing, + } + } + } + } + } + } +} + +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct PaymentToken { + reusable: Option<bool>, + decline_duplicates: Option<bool>, + brand: Option<String>, + #[serde(rename = "type")] + token_type: Option<String>, +} + +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct PaymentMethodDetails { + payment_card: Option<PaymentCardDetails>, + payment_method_type: Option<String>, + payment_method_brand: Option<String>, +} + +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct PaymentCardDetails { + expiry_date: ExpiryDate, + bin: String, + last4: String, + brand: String, +} + +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct Processor { + reference_number: Option<String>, + authorization_code: Option<String>, + response_code: String, + response_message: String, + avs_response: Option<AvsResponse>, + security_code_response: Option<String>, + tax_refund_data: Option<serde_json::Value>, +} + +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct AvsResponse { + street_match: Option<String>, + postal_code_match: Option<String>, +} + +impl<F, T> TryFrom<ResponseRouterData<F, AuthipayPaymentsResponse, T, PaymentsResponseData>> + for RouterData<F, T, PaymentsResponseData> +{ + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: ResponseRouterData<F, AuthipayPaymentsResponse, T, PaymentsResponseData>, + ) -> Result<Self, Self::Error> { + // Get gateway response (like Fiserv pattern) + let gateway_resp = item.response.gateway_response(); + + // Store order_id in connector_metadata for void operations (like Fiserv) + let mut metadata = std::collections::HashMap::new(); + metadata.insert( + "order_id".to_string(), + serde_json::Value::String(gateway_resp.transaction_processing_details.order_id.clone()), + ); + let connector_metadata = Some(serde_json::Value::Object(serde_json::Map::from_iter( + metadata, + ))); + + Ok(Self { + status: enums::AttemptStatus::from(gateway_resp.transaction_state.clone()), + response: Ok(PaymentsResponseData::TransactionResponse { + resource_id: ResponseId::ConnectorTransactionId( + gateway_resp + .transaction_processing_details + .transaction_id + .clone(), + ), + redirection_data: Box::new(None), + mandate_reference: Box::new(None), + connector_metadata, + network_txn_id: None, + connector_response_reference_id: Some( + gateway_resp.transaction_processing_details.order_id.clone(), + ), + incremental_authorization_allowed: None, + charges: None, + }), + ..item.data + }) + } +} + +// Type definition for CaptureRequest +#[derive(Debug, Serialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct AuthipayCaptureRequest { + request_type: &'static str, + transaction_amount: Amount, +} + +impl TryFrom<&AuthipayRouterData<&PaymentsCaptureRouterData>> for AuthipayCaptureRequest { + type Error = error_stack::Report<errors::ConnectorError>; + + fn try_from( + item: &AuthipayRouterData<&PaymentsCaptureRouterData>, + ) -> Result<Self, Self::Error> { + Ok(Self { + request_type: "PostAuthTransaction", + transaction_amount: Amount { + total: item.amount, + currency: item.router_data.request.currency.to_string(), + components: None, + }, + }) + } +} + +// Type definition for VoidRequest +#[derive(Debug, Serialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct AuthipayVoidRequest { + request_type: &'static str, +} + +impl TryFrom<&AuthipayRouterData<&PaymentsCancelRouterData>> for AuthipayVoidRequest { + type Error = error_stack::Report<errors::ConnectorError>; + + fn try_from( + _item: &AuthipayRouterData<&PaymentsCancelRouterData>, + ) -> Result<Self, Self::Error> { + Ok(Self { + request_type: "VoidTransaction", + }) + } +} + +// Type definition for RefundRequest +#[derive(Default, Debug, Serialize)] +#[serde(rename_all = "camelCase")] +pub struct AuthipayRefundRequest { + request_type: &'static str, + transaction_amount: Amount, +} + +impl<F> TryFrom<&AuthipayRouterData<&RefundsRouterData<F>>> for AuthipayRefundRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from(item: &AuthipayRouterData<&RefundsRouterData<F>>) -> Result<Self, Self::Error> { + Ok(Self { + request_type: "ReturnTransaction", + transaction_amount: Amount { + total: item.amount.to_owned(), + currency: item.router_data.request.currency.to_string(), + components: None, + }, + }) + } +} + +// Type definition for Refund Response + +#[allow(dead_code)] +#[derive(Debug, Serialize, Default, Deserialize, Clone)] +pub enum RefundStatus { + Succeeded, + Failed, + #[default] + Processing, +} + +impl From<RefundStatus> for enums::RefundStatus { + fn from(item: RefundStatus) -> Self { + match item { + RefundStatus::Succeeded => Self::Success, + RefundStatus::Failed => Self::Failure, + RefundStatus::Processing => Self::Pending, + //TODO: Review mapping + } + } +} + +// Reusing the payments response structure for refunds +// because Authipay uses the same endpoint and response format +pub type RefundResponse = AuthipayPaymentsResponse; + +impl TryFrom<RefundsResponseRouterData<Execute, RefundResponse>> for RefundsRouterData<Execute> { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: RefundsResponseRouterData<Execute, RefundResponse>, + ) -> Result<Self, Self::Error> { + let refund_status = if item.response.transaction_type == "RETURN" { + match item.response.transaction_result.as_deref() { + Some("APPROVED") => RefundStatus::Succeeded, + Some("DECLINED") \| Some("FAILED") => RefundStatus::Failed, + _ => RefundStatus::Processing, + } + } else { + RefundStatus::Processing + }; + + Ok(Self { + response: Ok(RefundsResponseData { + connector_refund_id: item.response.ipg_transaction_id.to_string(), + refund_status: enums::RefundStatus::from(refund_status), + }), + ..item.data + }) + } +} + +impl TryFrom<RefundsResponseRouterData<RSync, RefundResponse>> for RefundsRouterData<RSync> { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: RefundsResponseRouterData<RSync, RefundResponse>, + ) -> Result<Self, Self::Error> { + let refund_status = if item.response.transaction_type == "RETURN" { + match item.response.transaction_result.as_deref() { + Some("APPROVED") => RefundStatus::Succeeded, + Some("DECLINED") \| Some("FAILED") => RefundStatus::Failed, + _ => RefundStatus::Processing, + } + } else { + RefundStatus::Processing + }; + + Ok(Self { + response: Ok(RefundsResponseData { + connector_refund_id: item.response.ipg_transaction_id.to_string(), + refund_status: enums::RefundStatus::from(refund_status), + }), + ..item.data + }) + } +} + +// Error Response structs +#[derive(Default, Debug, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ErrorDetailItem { + pub field: String, + pub message: String, +} + +#[derive(Default, Debug, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ErrorDetails { + pub code: Option<String>, + pub message: String, + pub details: Option<Vec<ErrorDetailItem>>, +} + +#[derive(Default, Debug, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct AuthipayErrorResponse { + pub client_request_id: Option<String>, + pub api_trace_id: Option<String>, + pub response_type: Option<String>, + #[serde(rename = "type")] + pub response_object_type: Option<String>, + pub error: ErrorDetails, + pub decline_reason_code: Option<String>, +} + +impl From<&AuthipayErrorResponse> for ErrorResponse { + fn from(item: &AuthipayErrorResponse) -> Self { + Self { + status_code: 500, // Default to Internal Server Error, will be overridden by actual HTTP status + code: item.error.code.clone().unwrap_or_default(), + message: item.error.message.clone(), + reason: None, + attempt_status: None, + connector_transaction_id: None, + network_decline_code: None, + network_advice_code: None, + network_error_message: None, + } + } +} diff --git a/crates/hyperswitch_connectors/src/default_implementations.rs b/crates/hyperswitch_connectors/src/default_implementations.rs index 9cc798d57cd..38e63124029 100644 --- a/crates/hyperswitch_connectors/src/default_implementations.rs +++ b/crates/hyperswitch_connectors/src/default_implementations.rs @@ -148,6 +148,7 @@ default_imp_for_authorize_session_token!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -274,6 +275,7 @@ default_imp_for_calculate_tax!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -401,6 +403,7 @@ default_imp_for_session_update!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -528,6 +531,7 @@ default_imp_for_post_session_tokens!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -654,6 +658,7 @@ default_imp_for_create_order!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -781,6 +786,7 @@ default_imp_for_update_metadata!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -911,6 +917,7 @@ default_imp_for_complete_authorize!( connectors::Adyenplatform, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Bamboraapac, connectors::Bankofamerica, connectors::Barclaycard, @@ -1018,6 +1025,7 @@ default_imp_for_incremental_authorization!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1145,6 +1153,7 @@ default_imp_for_create_customer!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1270,6 +1279,7 @@ default_imp_for_connector_redirect_response!( connectors::Adyenplatform, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Billwerk, connectors::Bitpay, connectors::Bamboraapac, @@ -1377,6 +1387,7 @@ default_imp_for_pre_processing_steps!( connectors::Adyenplatform, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1494,6 +1505,7 @@ default_imp_for_post_processing_steps!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1622,6 +1634,7 @@ default_imp_for_approve!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1751,6 +1764,7 @@ default_imp_for_reject!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1880,6 +1894,7 @@ default_imp_for_webhook_source_verification!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2008,6 +2023,7 @@ default_imp_for_accept_dispute!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2135,6 +2151,7 @@ default_imp_for_submit_evidence!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2261,6 +2278,7 @@ default_imp_for_defend_dispute!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2397,6 +2415,7 @@ default_imp_for_file_upload!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2515,6 +2534,7 @@ default_imp_for_payouts!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2637,6 +2657,7 @@ default_imp_for_payouts_create!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2763,6 +2784,7 @@ default_imp_for_payouts_retrieve!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2891,6 +2913,7 @@ default_imp_for_payouts_eligibility!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -3017,6 +3040,7 @@ default_imp_for_payouts_fulfill!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -3140,6 +3164,7 @@ default_imp_for_payouts_cancel!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -3267,6 +3292,7 @@ default_imp_for_payouts_quote!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -3395,6 +3421,7 @@ default_imp_for_payouts_recipient!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -3522,6 +3549,7 @@ default_imp_for_payouts_recipient_account!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -3651,6 +3679,7 @@ default_imp_for_frm_sale!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -3780,6 +3809,7 @@ default_imp_for_frm_checkout!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -3909,6 +3939,7 @@ default_imp_for_frm_transaction!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -4038,6 +4069,7 @@ default_imp_for_frm_fulfillment!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -4167,6 +4199,7 @@ default_imp_for_frm_record_return!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -4293,6 +4326,7 @@ default_imp_for_revoking_mandates!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -4417,6 +4451,7 @@ default_imp_for_uas_pre_authentication!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -4543,6 +4578,7 @@ default_imp_for_uas_post_authentication!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -4670,6 +4706,7 @@ default_imp_for_uas_authentication_confirmation!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -4788,6 +4825,7 @@ default_imp_for_connector_request_id!( connectors::Adyenplatform, connectors::Airwallex, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Amazonpay, connectors::Bambora, @@ -4910,6 +4948,7 @@ default_imp_for_fraud_check!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -5061,6 +5100,7 @@ default_imp_for_connector_authentication!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -5185,6 +5225,7 @@ default_imp_for_uas_authentication!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -5304,6 +5345,7 @@ default_imp_for_revenue_recovery!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -5434,6 +5476,7 @@ default_imp_for_billing_connector_payment_sync!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -5563,6 +5606,7 @@ default_imp_for_revenue_recovery_record_back!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -5690,6 +5734,7 @@ default_imp_for_billing_connector_invoice_sync!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -5812,6 +5857,7 @@ default_imp_for_external_vault!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Barclaycard, connectors::Bambora, @@ -5940,6 +5986,7 @@ default_imp_for_external_vault_insert!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Barclaycard, connectors::Bambora, @@ -6068,6 +6115,7 @@ default_imp_for_external_vault_retrieve!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Barclaycard, connectors::Bambora, @@ -6196,6 +6244,7 @@ default_imp_for_external_vault_delete!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Barclaycard, connectors::Bambora, @@ -6324,6 +6373,7 @@ default_imp_for_external_vault_create!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Barclaycard, connectors::Bambora, diff --git a/crates/hyperswitch_connectors/src/default_implementations_v2.rs b/crates/hyperswitch_connectors/src/default_implementations_v2.rs index 7bc66a1e6cf..89a7b3de2ac 100644 --- a/crates/hyperswitch_connectors/src/default_implementations_v2.rs +++ b/crates/hyperswitch_connectors/src/default_implementations_v2.rs @@ -253,6 +253,7 @@ default_imp_for_new_connector_integration_payment!( connectors::Airwallex, connectors::Amazonpay, connectors::Adyenplatform, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -382,6 +383,7 @@ default_imp_for_new_connector_integration_refund!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -506,6 +508,7 @@ default_imp_for_new_connector_integration_connector_access_token!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -636,6 +639,7 @@ default_imp_for_new_connector_integration_accept_dispute!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -764,6 +768,7 @@ default_imp_for_new_connector_integration_submit_evidence!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -892,6 +897,7 @@ default_imp_for_new_connector_integration_defend_dispute!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1031,6 +1037,7 @@ default_imp_for_new_connector_integration_file_upload!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1162,6 +1169,7 @@ default_imp_for_new_connector_integration_payouts_create!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1293,6 +1301,7 @@ default_imp_for_new_connector_integration_payouts_eligibility!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1424,6 +1433,7 @@ default_imp_for_new_connector_integration_payouts_fulfill!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1555,6 +1565,7 @@ default_imp_for_new_connector_integration_payouts_cancel!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1686,6 +1697,7 @@ default_imp_for_new_connector_integration_payouts_quote!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1817,6 +1829,7 @@ default_imp_for_new_connector_integration_payouts_recipient!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1948,6 +1961,7 @@ default_imp_for_new_connector_integration_payouts_sync!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2079,6 +2093,7 @@ default_imp_for_new_connector_integration_payouts_recipient_account!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2208,6 +2223,7 @@ default_imp_for_new_connector_integration_webhook_source_verification!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2339,6 +2355,7 @@ default_imp_for_new_connector_integration_frm_sale!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2470,6 +2487,7 @@ default_imp_for_new_connector_integration_frm_checkout!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2601,6 +2619,7 @@ default_imp_for_new_connector_integration_frm_transaction!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2732,6 +2751,7 @@ default_imp_for_new_connector_integration_frm_fulfillment!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2863,6 +2883,7 @@ default_imp_for_new_connector_integration_frm_record_return!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2991,6 +3012,7 @@ default_imp_for_new_connector_integration_revoking_mandates!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -3110,6 +3132,7 @@ default_imp_for_new_connector_integration_frm!( connectors::Vgs, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Bambora, connectors::Bamboraapac, connectors::Barclaycard, @@ -3238,6 +3261,7 @@ default_imp_for_new_connector_integration_connector_authentication!( connectors::Vgs, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Bambora, connectors::Bamboraapac, connectors::Barclaycard, @@ -3355,6 +3379,7 @@ default_imp_for_new_connector_integration_revenue_recovery!( connectors::Vgs, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Bambora, connectors::Bamboraapac, connectors::Barclaycard, @@ -3485,6 +3510,7 @@ default_imp_for_new_connector_integration_external_vault!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Barclaycard, connectors::Bambora, diff --git a/crates/hyperswitch_domain_models/src/configs.rs b/crates/hyperswitch_domain_models/src/configs.rs index 9e64262f78f..9e4b94f9465 100644 --- a/crates/hyperswitch_domain_models/src/configs.rs +++ b/crates/hyperswitch_domain_models/src/configs.rs @@ -12,6 +12,7 @@ use crate::errors::api_error_response; #[serde(default)] pub struct Connectors { pub aci: ConnectorParams, + pub authipay: ConnectorParams, pub adyen: AdyenParamsWithThreeBaseUrls, pub adyenplatform: ConnectorParams, pub airwallex: ConnectorParams, diff --git a/crates/payment_methods/src/configs/payment_connector_required_fields.rs b/crates/payment_methods/src/configs/payment_connector_required_fields.rs index 08baca7e35f..ec3ea46ccd2 100644 --- a/crates/payment_methods/src/configs/payment_connector_required_fields.rs +++ b/crates/payment_methods/src/configs/payment_connector_required_fields.rs @@ -1195,6 +1195,7 @@ impl Default for RequiredFields { fn get_cards_required_fields() -> HashMap<Connector, RequiredFieldFinal> { HashMap::from([ (Connector::Aci, fields(vec![], vec![], card_with_name())), + (Connector::Authipay, fields(vec![], vec![], card_basic())), (Connector::Adyen, fields(vec![], vec![], card_with_name())), (Connector::Airwallex, fields(vec![], card_basic(), vec![])), ( diff --git a/crates/router/src/connector.rs b/crates/router/src/connector.rs index 619608a95de..d50086f5481 100644 --- a/crates/router/src/connector.rs +++ b/crates/router/src/connector.rs @@ -4,16 +4,16 @@ pub mod utils; pub use hyperswitch_connectors::connectors::DummyConnector; pub use hyperswitch_connectors::connectors::{ aci, aci::Aci, adyen, adyen::Adyen, adyenplatform, adyenplatform::Adyenplatform, airwallex, - airwallex::Airwallex, amazonpay, amazonpay::Amazonpay, archipel, archipel::Archipel, - authorizedotnet, authorizedotnet::Authorizedotnet, bambora, bambora::Bambora, bamboraapac, - bamboraapac::Bamboraapac, bankofamerica, bankofamerica::Bankofamerica, barclaycard, - barclaycard::Barclaycard, billwerk, billwerk::Billwerk, bitpay, bitpay::Bitpay, bluesnap, - bluesnap::Bluesnap, boku, boku::Boku, braintree, braintree::Braintree, cashtocode, - cashtocode::Cashtocode, celero, celero::Celero, chargebee, chargebee::Chargebee, checkbook, - checkbook::Checkbook, checkout, checkout::Checkout, coinbase, coinbase::Coinbase, coingate, - coingate::Coingate, cryptopay, cryptopay::Cryptopay, ctp_mastercard, - ctp_mastercard::CtpMastercard, cybersource, cybersource::Cybersource, datatrans, - datatrans::Datatrans, deutschebank, deutschebank::Deutschebank, digitalvirgo, + airwallex::Airwallex, amazonpay, amazonpay::Amazonpay, archipel, archipel::Archipel, authipay, + authipay::Authipay, authorizedotnet, authorizedotnet::Authorizedotnet, bambora, + bambora::Bambora, bamboraapac, bamboraapac::Bamboraapac, bankofamerica, + bankofamerica::Bankofamerica, barclaycard, barclaycard::Barclaycard, billwerk, + billwerk::Billwerk, bitpay, bitpay::Bitpay, bluesnap, bluesnap::Bluesnap, boku, boku::Boku, + braintree, braintree::Braintree, cashtocode, cashtocode::Cashtocode, celero, celero::Celero, + chargebee, chargebee::Chargebee, checkbook, checkbook::Checkbook, checkout, checkout::Checkout, + coinbase, coinbase::Coinbase, coingate, coingate::Coingate, cryptopay, cryptopay::Cryptopay, + ctp_mastercard, ctp_mastercard::CtpMastercard, cybersource, cybersource::Cybersource, + datatrans, datatrans::Datatrans, deutschebank, deutschebank::Deutschebank, digitalvirgo, digitalvirgo::Digitalvirgo, dlocal, dlocal::Dlocal, dwolla, dwolla::Dwolla, ebanx, ebanx::Ebanx, elavon, elavon::Elavon, facilitapay, facilitapay::Facilitapay, fiserv, fiserv::Fiserv, fiservemea, fiservemea::Fiservemea, fiuu, fiuu::Fiuu, forte, forte::Forte, diff --git a/crates/router/src/core/connector_validation.rs b/crates/router/src/core/connector_validation.rs index 655636197d8..6fb5a340ba2 100644 --- a/crates/router/src/core/connector_validation.rs +++ b/crates/router/src/core/connector_validation.rs @@ -89,6 +89,10 @@ impl ConnectorAuthTypeAndMetadataValidation<'_> { archipel::transformers::ArchipelConfigData::try_from(self.connector_meta_data)?; Ok(()) } + api_enums::Connector::Authipay => { + authipay::transformers::AuthipayAuthType::try_from(self.auth_type)?; + Ok(()) + } api_enums::Connector::Authorizedotnet => { authorizedotnet::transformers::AuthorizedotnetAuthType::try_from(self.auth_type)?; Ok(()) diff --git a/crates/router/src/types/api.rs b/crates/router/src/types/api.rs index 45d6dd0d75e..eab04a9f0cc 100644 --- a/crates/router/src/types/api.rs +++ b/crates/router/src/types/api.rs @@ -328,6 +328,10 @@ impl ConnectorData { match enums::Connector::from_str(connector_name) { Ok(name) => match name { enums::Connector::Aci => Ok(ConnectorEnum::Old(Box::new(connector::Aci::new()))), + + enums::Connector::Authipay => { + Ok(ConnectorEnum::Old(Box::new(connector::Authipay::new()))) + } enums::Connector::Adyen => { Ok(ConnectorEnum::Old(Box::new(connector::Adyen::new()))) } diff --git a/crates/router/src/types/transformers.rs b/crates/router/src/types/transformers.rs index 713293568b3..35ba30da6a7 100644 --- a/crates/router/src/types/transformers.rs +++ b/crates/router/src/types/transformers.rs @@ -207,6 +207,7 @@ impl ForeignTryFrom<api_enums::Connector> for common_enums::RoutableConnectors { fn foreign_try_from(from: api_enums::Connector) -> Result<Self, Self::Error> { Ok(match from { api_enums::Connector::Aci => Self::Aci, + api_enums::Connector::Authipay => Self::Authipay, api_enums::Connector::Adyen => Self::Adyen, api_enums::Connector::Adyenplatform => Self::Adyenplatform, api_enums::Connector::Airwallex => Self::Airwallex, diff --git a/crates/router/tests/connectors/authipay.rs b/crates/router/tests/connectors/authipay.rs new file mode 100644 index 00000000000..aa362166fdf --- /dev/null +++ b/crates/router/tests/connectors/authipay.rs @@ -0,0 +1,454 @@ +use std::str::FromStr; +use masking::Secret; +use router::{ + types::{self, api, storage::enums}, + core::errors, +}; +use cards; + +use crate::utils::{self, ConnectorActions}; +use test_utils::connector_auth; + +#[derive(Clone, Copy)] +struct AuthipayTest; +impl ConnectorActions for AuthipayTest {} +impl utils::Connector for AuthipayTest { + fn get_data(&self) -> api::ConnectorData { + use router::connector::Authipay; + api::ConnectorData { + connector: Box::new(Authipay::new()), + connector_name: types::Connector::Authipay, + get_token: types::api::GetToken::Connector, + merchant_connector_id: None, + } + } + + fn get_auth_token(&self) -> types::ConnectorAuthType { + utils::to_connector_auth_type( + connector_auth::ConnectorAuthentication::new() + .authipay + .expect("Missing connector authentication configuration").into(), + ) + } + + fn get_name(&self) -> String { + "authipay".to_string() + } +} + +static CONNECTOR: AuthipayTest = AuthipayTest {}; + +fn get_default_payment_info() -> Option<utils::PaymentInfo> { + Some(utils::PaymentInfo { + payment_id: utils::get_payment_id(), + payment_method: enums::PaymentMethod::Card, + payment_method_type: Some(enums::PaymentMethodType::Credit), + amount: 100, // $1.00 + currency: enums::Currency::USD, + capture_method: Some(enums::CaptureMethod::Manual), + mandate_id: None, + setup_future_usage: None, + off_session: None, + merchant_connector_id: None, + browser_info: None, + recurring_mandate_payment: None, + router_return_url: None, + connector_meta: None, + allowed_payment_method_types: None, + pm_token: None, + payment_experience: None, + webhook_url: None, + customer_id: None, + surcharge_details: None, + connector_request_reference_id: None, + request_incremental_authorization: None, + metadata: None, + payment_type: None, + session_token: None, + terminal_id: None, + card_network: None, + capture_on: None, + incremental_authorization_allowed: None, + }) +} + +fn payment_method_details() -> Option<types::PaymentsAuthorizeData> { + Some(types::PaymentsAuthorizeData { + payment_method_data: api::PaymentMethodData::Card(api::Card { + card_number: cards::CardNumber::from_str("4035874000424977").unwrap(), // Visa test card from Authipay specs + card_exp_month: Secret::new("12".to_string()), + card_exp_year: Secret::new("2024".to_string()), + card_cvc: Secret::new("123".to_string()), + card_holder_name: Secret::new("John Doe".to_string()), + card_issuer: None, + card_network: None, + card_type: None, + card_issuing_country: None, + bank_code: None, + nick_name: Some("Default Card".to_string()), + }), + currency: enums::Currency::USD, + amount: 100, // $1.00 + router_return_url: String::from("http://localhost:8080/"), + payment_method_type: Some(enums::PaymentMethodType::Credit), + ..utils::PaymentAuthorizeType::default().0 + }) +} + +// Cards Positive Tests +// Creates a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_only_authorize_payment() { + let response = CONNECTOR + .authorize_payment(payment_method_details(), get_default_payment_info()) + .await + .expect("Authorize payment response"); + assert_eq!(response.status, enums::AttemptStatus::Authorized); +} + +// Captures a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_capture_authorized_payment() { + let response = CONNECTOR + .authorize_and_capture_payment(payment_method_details(), None, get_default_payment_info()) + .await + .expect("Capture payment response"); + assert_eq!(response.status, enums::AttemptStatus::Charged); +} + +// Partially captures a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_capture_authorized_payment() { + let response = CONNECTOR + .authorize_and_capture_payment( + payment_method_details(), + Some(types::PaymentsCaptureData { + amount_to_capture: 50, + ..utils::PaymentCaptureType::default().0 + }), + get_default_payment_info(), + ) + .await + .expect("Capture payment response"); + assert_eq!(response.status, enums::AttemptStatus::Charged); +} + +// Synchronizes a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_authorized_payment() { + let authorize_response = CONNECTOR + .authorize_payment(payment_method_details(), get_default_payment_info()) + .await + .expect("Authorize payment response"); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + let response = CONNECTOR + .psync_retry_till_status_matches( + enums::AttemptStatus::Authorized, + Some(types::PaymentsSyncData { + connector_transaction_id: types::ResponseId::ConnectorTransactionId( + txn_id.unwrap(), + ), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .expect("PSync response"); + assert_eq!(response.status, enums::AttemptStatus::Authorized,); +} + +// Voids a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_void_authorized_payment() { + let response = CONNECTOR + .authorize_and_void_payment( + payment_method_details(), + Some(types::PaymentsCancelData { + connector_transaction_id: String::from(""), + cancellation_reason: Some("requested_by_customer".to_string()), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .expect("Void payment response"); + assert_eq!(response.status, enums::AttemptStatus::Voided); +} + +// Refunds a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_manually_captured_payment() { + let response = CONNECTOR + .capture_payment_and_refund(payment_method_details(), None, None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Partially refunds a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_refund_manually_captured_payment() { + let response = CONNECTOR + .capture_payment_and_refund( + payment_method_details(), + None, + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Synchronizes a refund using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_manually_captured_refund() { + let refund_response = CONNECTOR + .capture_payment_and_refund(payment_method_details(), None, None, get_default_payment_info()) + .await + .unwrap(); + let response = CONNECTOR + .rsync_retry_till_status_matches( + enums::RefundStatus::Success, + refund_response.response.unwrap().connector_refund_id, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Creates a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_make_payment() { + let authorize_response = CONNECTOR.make_payment(payment_method_details(), get_default_payment_info()).await.unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); +} + +// Synchronizes a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_auto_captured_payment() { + let authorize_response = CONNECTOR.make_payment(payment_method_details(), get_default_payment_info()).await.unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + assert_ne!(txn_id, None, "Empty connector transaction id"); + let response = CONNECTOR + .psync_retry_till_status_matches( + enums::AttemptStatus::Charged, + Some(types::PaymentsSyncData { + connector_transaction_id: types::ResponseId::ConnectorTransactionId( + txn_id.unwrap(), + ), + capture_method: Some(enums::CaptureMethod::Automatic), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!(response.status, enums::AttemptStatus::Charged,); +} + +// Refunds a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_auto_captured_payment() { + let response = CONNECTOR + .make_payment_and_refund(payment_method_details(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Partially refunds a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_refund_succeeded_payment() { + let refund_response = CONNECTOR + .make_payment_and_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + refund_response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Creates multiple refunds against a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_succeeded_payment_multiple_times() { + CONNECTOR + .make_payment_and_multiple_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await; +} + +// Synchronizes a refund using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_refund() { + let refund_response = CONNECTOR + .make_payment_and_refund(payment_method_details(), None, get_default_payment_info()) + .await + .unwrap(); + let response = CONNECTOR + .rsync_retry_till_status_matches( + enums::RefundStatus::Success, + refund_response.response.unwrap().connector_refund_id, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Cards Negative scenarios +// Creates a payment with incorrect CVC. +#[actix_web::test] +async fn should_fail_payment_for_incorrect_cvc() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: types::api::PaymentMethodData::Card(api::Card { + card_cvc: Secret::new("12345".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's security code is invalid.".to_string(), + ); +} + +// Creates a payment with incorrect expiry month. +#[actix_web::test] +async fn should_fail_payment_for_invalid_exp_month() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: api::PaymentMethodData::Card(api::Card { + card_exp_month: Secret::new("20".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's expiration month is invalid.".to_string(), + ); +} + +// Creates a payment with incorrect expiry year. +#[actix_web::test] +async fn should_fail_payment_for_incorrect_expiry_year() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: api::PaymentMethodData::Card(api::Card { + card_exp_year: Secret::new("2000".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's expiration year is invalid.".to_string(), + ); +} + +// Voids a payment using automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_fail_void_payment_for_auto_capture() { + let authorize_response = CONNECTOR.make_payment(payment_method_details(), get_default_payment_info()).await.unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + assert_ne!(txn_id, None, "Empty connector transaction id"); + let void_response = CONNECTOR + .void_payment(txn_id.unwrap(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + void_response.response.unwrap_err().message, + "You cannot cancel this PaymentIntent because it has a status of succeeded." + ); +} + +// Captures a payment using invalid connector payment id. +#[actix_web::test] +async fn should_fail_capture_for_invalid_payment() { + let capture_response = CONNECTOR + .capture_payment("123456789".to_string(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + capture_response.response.unwrap_err().message, + String::from("No such payment_intent: '123456789'") + ); +} + +// Refunds a payment with refund amount higher than payment amount. +#[actix_web::test] +async fn should_fail_for_refund_amount_higher_than_payment_amount() { + let response = CONNECTOR + .make_payment_and_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 150, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Refund amount (₹1.50) is greater than charge amount (₹1.00)", + ); +} + +// Connector dependent test cases goes here + +// [#478]: add unit tests for non 3DS, wallets & webhooks in connector tests diff --git a/crates/router/tests/connectors/sample_auth.toml b/crates/router/tests/connectors/sample_auth.toml index 7d5a742aaf5..a7f18afcb78 100644 --- a/crates/router/tests/connectors/sample_auth.toml +++ b/crates/router/tests/connectors/sample_auth.toml @@ -341,10 +341,16 @@ api_key = "MyApiKey" key1 = "Merchant id" api_secret = "Secret key" + +[authipay] +api_key = "MyApiKey" +api_secret = "MySecretKey" + [checkbook] api_key="Client ID" key1 ="Client Secret" + [santander] api_key="Client ID" key1 ="Client Secret" @@ -354,4 +360,5 @@ api_key="Client ID" key1="Client Secret" [payload] -api_key="API Key" \ No newline at end of file +api_key="API Key" + diff --git a/crates/test_utils/src/connector_auth.rs b/crates/test_utils/src/connector_auth.rs index 25fffd09b0f..14e08be1623 100644 --- a/crates/test_utils/src/connector_auth.rs +++ b/crates/test_utils/src/connector_auth.rs @@ -19,6 +19,7 @@ pub struct ConnectorAuthentication { pub airwallex: Option<BodyKey>, pub amazonpay: Option<HeaderKey>, pub archipel: Option<NoKey>, + pub authipay: Option<SignatureKey>, pub authorizedotnet: Option<BodyKey>, pub bambora: Option<BodyKey>, pub bamboraapac: Option<HeaderKey>, diff --git a/loadtest/config/development.toml b/loadtest/config/development.toml index b1c7a7581c4..4711699bdf9 100644 --- a/loadtest/config/development.toml +++ b/loadtest/config/development.toml @@ -82,6 +82,7 @@ airwallex.base_url = "https://api-demo.airwallex.com/" amazonpay.base_url = "https://pay-api.amazon.com/v2" applepay.base_url = "https://apple-pay-gateway.apple.com/" archipel.base_url = "https://{{merchant_endpoint_prefix}}/ArchiPEL/Transaction/v1" +authipay.base_url = "https://prod.emea.api.fiservapps.com/sandbox/ipp/payments-gateway/v2/" authorizedotnet.base_url = "https://apitest.authorize.net/xml/v1/request.api" bambora.base_url = "https://api.na.bambora.com" bamboraapac.base_url = "https://demo.ippayments.com.au/interface/api" @@ -217,6 +218,7 @@ cards = [ "airwallex", "amazonpay", "archipel", + "authipay", "authorizedotnet", "bambora", "bamboraapac", diff --git a/scripts/add_connector.sh b/scripts/add_connector.sh index 90424011957..98490f12324 100755 --- a/scripts/add_connector.sh +++ b/scripts/add_connector.sh @@ -6,7 +6,7 @@ function find_prev_connector() { git checkout $self cp $self $self.tmp # Add new connector to existing list and sort it - connectors=(aci adyen adyenplatform airwallex amazonpay applepay archipel authorizedotnet bambora bamboraapac bankofamerica barclaycard billwerk bitpay bluesnap boku braintree cashtocode celero chargebee checkbook checkout coinbase cryptopay ctp_visa cybersource datatrans deutschebank digitalvirgo dlocal dummyconnector dwolla ebanx elavon facilitapay fiserv fiservemea fiuu forte getnet globalpay globepay gocardless gpayments helcim hipay hyperswitch_vault iatapay inespay itaubank jpmorgan juspaythreedsserver klarna mifinity mollie moneris multisafepay netcetera nexinets nexixpay nomupay noon nordea novalnet nuvei opayo opennode paybox payeezy payload payme payone paypal paystack payu placetopay plaid powertranz prophetpay rapyd razorpay recurly redsys santander shift4 silverflow square stax stripe stripebilling taxjar threedsecureio thunes tokenio trustpay tsys unified_authentication_service vgs volt wellsfargo wellsfargopayout wise worldline worldpay worldpayvantiv worldpayxml xendit zsl "$1") + connectors=(aci adyen adyenplatform airwallex amazonpay applepay archipel authipay authorizedotnet bambora bamboraapac bankofamerica barclaycard billwerk bitpay bluesnap boku braintree cashtocode celero chargebee checkbook checkout coinbase cryptopay ctp_visa cybersource datatrans deutschebank digitalvirgo dlocal dummyconnector dwolla ebanx elavon facilitapay fiserv fiservemea fiuu forte getnet globalpay globepay gocardless gpayments helcim hipay hyperswitch_vault iatapay inespay itaubank jpmorgan juspaythreedsserver klarna mifinity mollie moneris multisafepay netcetera nexinets nexixpay nomupay noon nordea novalnet nuvei opayo opennode paybox payeezy payload payme payone paypal paystack payu placetopay plaid powertranz prophetpay rapyd razorpay recurly redsys santander shift4 silverflow square stax stripe stripebilling taxjar threedsecureio thunes tokenio trustpay tsys unified_authentication_service vgs volt wellsfargo wellsfargopayout wise worldline worldpay worldpayvantiv worldpayxml xendit zsl "$1") IFS=$'\n' sorted=($(sort <<<"${connectors[]}")); unset IFS res="$(echo ${sorted[@]})"	2025-06-05T09:43:43Z	## Type of Change <!-- Put an `x` in the boxes that apply --> - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description Cards Non-3DS payments added for authipay https://docs.fiserv.dev/public/reference/payments-intro ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables <!-- Provide links to the files with corresponding changes. Following are the paths where you can find config files: 1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` --> ## Motivation and Context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. If you don't have an issue, we'd recommend starting with one first so the PR can focus on the implementation (unless it is an obvious bug or documentation fix that will have little conversation). --> https://github.com/juspay/hyperswitch/issues/8398 ## How did you test it? Tested using cargo build and cypress test <img width="738" alt="Screenshot 2025-07-04 at 11 49 02 AM" src="https://github.com/user-attachments/assets/d4927935-5af6-4b14-88c4-dc1c9f723886" /> <!-- Did you write an integration/unit/API test to verify the code changes? Or did you test this change manually (provide relevant screenshots)? --> ## Checklist <!-- Put an `x` in the boxes that apply --> - [`x`] I formatted the code `cargo +nightly fmt --all` - [`x`] I addressed lints thrown by `cargo clippy` - [`x`] I reviewed the submitted code - [ ] I added unit tests for my changes where possible	v1.115.0	c322eb9cabb2ca7a8ad0c3ed57192dde9bf7eaa4	c322eb9cabb2ca7a8ad0c3ed57192dde9bf7eaa4

juspay/hyperswitch

juspay__hyperswitch-8698

Bug: [BUG] FEATURE_MATRIX shows JPMorgan does not support Refunds I added support for refunds 3 weeks ago in #8436. Feature matrix needs to be updated.

diff --git a/crates/hyperswitch_connectors/src/connectors/jpmorgan.rs b/crates/hyperswitch_connectors/src/connectors/jpmorgan.rs index 80e3d61278f..7577154f6b1 100644 --- a/crates/hyperswitch_connectors/src/connectors/jpmorgan.rs +++ b/crates/hyperswitch_connectors/src/connectors/jpmorgan.rs @@ -847,7 +847,7 @@ static JPMORGAN_SUPPORTED_PAYMENT_METHODS: LazyLock<SupportedPaymentMethods> = enums::PaymentMethodType::Debit, PaymentMethodDetails { mandates: enums::FeatureStatus::NotSupported, - refunds: enums::FeatureStatus::NotSupported, + refunds: enums::FeatureStatus::Supported, supported_capture_methods: supported_capture_methods.clone(), specific_features: Some( api_models::feature_matrix::PaymentMethodSpecificFeatures::Card({ @@ -866,7 +866,7 @@ static JPMORGAN_SUPPORTED_PAYMENT_METHODS: LazyLock<SupportedPaymentMethods> = enums::PaymentMethodType::Credit, PaymentMethodDetails { mandates: enums::FeatureStatus::NotSupported, - refunds: enums::FeatureStatus::NotSupported, + refunds: enums::FeatureStatus::Supported, supported_capture_methods: supported_capture_methods.clone(), specific_features: Some( api_models::feature_matrix::PaymentMethodSpecificFeatures::Card({

2025-07-19T18:06:43Z

## Type of Change  - [x] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  This PR marks refunds as supported by JPMorgan connector. Although this does not affect refund flow, the feature matrix marking is wrong. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  I added refunds support 3 weeks ago in #8436 and this was missed. closes #8698 ## How did you test it?  Hit feature matrix endpoint: ```sh curl --location 'http://localhost:8080/feature_matrix' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' ``` ```json { ... "supported_payment_methods": [ { "payment_method": "card", "payment_method_type": "credit", "payment_method_type_display_name": "Credit Card", "mandates": "not_supported", "refunds": "supported", "supported_capture_methods": [ "automatic", "manual" ], "three_ds": "not_supported", "no_three_ds": "supported", "supported_card_networks": [ "AmericanExpress", "DinersClub", "Discover", "JCB", "Mastercard", ... }, { "payment_method": "card", "payment_method_type": "debit", "payment_method_type_display_name": "Debit Card", "mandates": "not_supported", "refunds": "supported", "supported_capture_methods": [ "automatic", "manual" ], "three_ds": "not_supported", "no_three_ds": "supported", "supported_card_networks": [ "AmericanExpress", "DinersClub", "Discover", "JCB", "Mastercard", "UnionPay", "Visa" ], "supported_countries": [ "FRA", "BEL", ... } ``` ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `just clippy && just clippy_v2` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

d42fad73f502933ecf50215503f0bea41813662c

juspay/hyperswitch

juspay__hyperswitch-8703

Bug: [REFACTOR] facilitapay destination bank account number should be merchant facing destination bank account number should be added by merchant, not customer. this is a design flaw that needs to be fixed.

diff --git a/api-reference/v1/openapi_spec_v1.json b/api-reference/v1/openapi_spec_v1.json index ccd6d2e11b7..41af730ea71 100644 --- a/api-reference/v1/openapi_spec_v1.json +++ b/api-reference/v1/openapi_spec_v1.json @@ -9645,13 +9645,14 @@ "source_bank_account_id": { "type": "string", "description": "Source bank account number", - "example": "8b2812f0-d6c8-4073-97bb-9fa964d08bc5", + "example": "8b******-****-****-****-*******08bc5", "nullable": true }, "destination_bank_account_id": { "type": "string", - "description": "Destination bank account number", - "example": "9b95f84e-de61-460b-a14b-f23b4e71c97b", + "description": "Partially masked destination bank account number _Deprecated: Will be removed in next stable release._", + "deprecated": true, + "example": "********-****-460b-****-f23b4e71c97b", "nullable": true }, "expiry_date": { @@ -26293,7 +26294,8 @@ }, "destination_bank_account_id": { "type": "string", - "description": "Partially masked destination bank account number", + "description": "Partially masked destination bank account number _Deprecated: Will be removed in next stable release._", + "deprecated": true, "example": "********-****-460b-****-f23b4e71c97b", "nullable": true }, diff --git a/api-reference/v2/openapi_spec_v2.json b/api-reference/v2/openapi_spec_v2.json index 5550c859ca9..ddd13547f3d 100644 --- a/api-reference/v2/openapi_spec_v2.json +++ b/api-reference/v2/openapi_spec_v2.json @@ -6577,13 +6577,14 @@ "source_bank_account_id": { "type": "string", "description": "Source bank account number", - "example": "8b2812f0-d6c8-4073-97bb-9fa964d08bc5", + "example": "8b******-****-****-****-*******08bc5", "nullable": true }, "destination_bank_account_id": { "type": "string", - "description": "Destination bank account number", - "example": "9b95f84e-de61-460b-a14b-f23b4e71c97b", + "description": "Partially masked destination bank account number _Deprecated: Will be removed in next stable release._", + "deprecated": true, + "example": "********-****-460b-****-f23b4e71c97b", "nullable": true }, "expiry_date": { @@ -20983,7 +20984,8 @@ }, "destination_bank_account_id": { "type": "string", - "description": "Partially masked destination bank account number", + "description": "Partially masked destination bank account number _Deprecated: Will be removed in next stable release._", + "deprecated": true, "example": "********-****-460b-****-f23b4e71c97b", "nullable": true }, diff --git a/crates/api_models/src/payments.rs b/crates/api_models/src/payments.rs index 59c609a294d..e62126f9102 100644 --- a/crates/api_models/src/payments.rs +++ b/crates/api_models/src/payments.rs @@ -3433,15 +3433,12 @@ pub enum BankTransferData { /// CNPJ is a Brazilian company tax identification number #[schema(value_type = Option<String>, example = "74469027417312")] cnpj: Option<Secret<String>>, - /// Source bank account number - #[schema(value_type = Option<String>, example = "8b2812f0-d6c8-4073-97bb-9fa964d08bc5")] + #[schema(value_type = Option<String>, example = "8b******-****-****-****-*******08bc5")] source_bank_account_id: Option<MaskedBankAccount>, - - /// Destination bank account number - #[schema(value_type = Option<String>, example = "9b95f84e-de61-460b-a14b-f23b4e71c97b")] + /// Partially masked destination bank account number _Deprecated: Will be removed in next stable release._ + #[schema(value_type = Option<String>, example = "********-****-460b-****-f23b4e71c97b", deprecated)] destination_bank_account_id: Option<MaskedBankAccount>, - /// The expiration date and time for the Pix QR code in ISO 8601 format #[schema(value_type = Option<String>, example = "2025-09-10T10:11:12Z")] #[serde(default, with = "common_utils::custom_serde::iso8601::option")] diff --git a/crates/api_models/src/payments/additional_info.rs b/crates/api_models/src/payments/additional_info.rs index 099e055980a..96b4209ac41 100644 --- a/crates/api_models/src/payments/additional_info.rs +++ b/crates/api_models/src/payments/additional_info.rs @@ -174,8 +174,8 @@ pub struct PixBankTransferAdditionalData { #[schema(value_type = Option<String>, example = "********-****-4073-****-9fa964d08bc5")] pub source_bank_account_id: Option<MaskedBankAccount>, - /// Partially masked destination bank account number - #[schema(value_type = Option<String>, example = "********-****-460b-****-f23b4e71c97b")] + /// Partially masked destination bank account number _Deprecated: Will be removed in next stable release._ + #[schema(value_type = Option<String>, example = "********-****-460b-****-f23b4e71c97b", deprecated)] pub destination_bank_account_id: Option<MaskedBankAccount>, /// The expiration date and time for the Pix QR code in ISO 8601 format diff --git a/crates/connector_configs/toml/development.toml b/crates/connector_configs/toml/development.toml index 9e493eb6a54..0aa70982492 100644 --- a/crates/connector_configs/toml/development.toml +++ b/crates/connector_configs/toml/development.toml @@ -6071,7 +6071,12 @@ api_secret="Secret Key" [facilitapay.connector_auth.BodyKey] api_key="Password" key1="Username" - +[facilitapay.metadata.destination_account_number] + name="destination_account_number" + label="Destination Account Number" + placeholder="Enter Destination Account Number" + required=true + type="Text" [archipel] [archipel.connector_auth.HeaderKey] diff --git a/crates/connector_configs/toml/production.toml b/crates/connector_configs/toml/production.toml index e81c3f6aac9..9a4663d3696 100644 --- a/crates/connector_configs/toml/production.toml +++ b/crates/connector_configs/toml/production.toml @@ -4637,6 +4637,13 @@ payment_method_type = "pix" api_key = "Password" key1 = "Username" +[facilitapay.metadata.destination_account_number] +name="destination_account_number" +label="Destination Account Number" +placeholder="Enter Destination Account Number" +required=true +type="Text" + [archipel] [archipel.connector_auth.HeaderKey] api_key = "Enter CA Certificate PEM" diff --git a/crates/connector_configs/toml/sandbox.toml b/crates/connector_configs/toml/sandbox.toml index bdd9cde57f0..c497c9aca29 100644 --- a/crates/connector_configs/toml/sandbox.toml +++ b/crates/connector_configs/toml/sandbox.toml @@ -6053,6 +6053,13 @@ payment_method_type = "pix" api_key = "Password" key1 = "Username" +[facilitapay.metadata.destination_account_number] +name="destination_account_number" +label="Destination Account Number" +placeholder="Enter Destination Account Number" +required=true +type="Text" + [archipel] [archipel.connector_auth.HeaderKey] api_key = "Enter CA Certificate PEM" diff --git a/crates/hyperswitch_connectors/src/connectors/facilitapay/transformers.rs b/crates/hyperswitch_connectors/src/connectors/facilitapay/transformers.rs index 9e7d4a06a2f..9de5b7454c3 100644 --- a/crates/hyperswitch_connectors/src/connectors/facilitapay/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/facilitapay/transformers.rs @@ -3,6 +3,8 @@ use common_enums::{enums, PaymentMethod}; use common_utils::{ errors::CustomResult, ext_traits::{BytesExt, Encode}, + new_type::MaskedBankAccount, + pii, types::StringMajorUnit, }; use error_stack::ResultExt; @@ -18,6 +20,7 @@ use hyperswitch_interfaces::{ consts, errors, events::connector_api_logs::ConnectorEvent, types::Response, }; use masking::{ExposeInterface, Secret}; +use serde::{Deserialize, Serialize}; use time::PrimitiveDateTime; use url::Url; @@ -34,7 +37,7 @@ use super::{ }; use crate::{ types::{RefreshTokenRouterData, RefundsResponseRouterData, ResponseRouterData}, - utils::{is_payment_failure, missing_field_err, QrImage, RouterData as OtherRouterData}, + utils::{self, is_payment_failure, missing_field_err, QrImage, RouterData as OtherRouterData}, }; type Error = error_stack::Report<errors::ConnectorError>; @@ -47,6 +50,65 @@ impl<T> From<(StringMajorUnit, T)> for FacilitapayRouterData<T> { } } +// Auth Struct +#[derive(Debug, Clone)] +pub struct FacilitapayAuthType { + pub(super) username: Secret<String>, + pub(super) password: Secret<String>, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct FacilitapayConnectorMetadataObject { + // pub destination_account_number: Secret<String>, + pub destination_account_number: MaskedBankAccount, +} + +// Helper to build the request from Hyperswitch Auth Type +impl FacilitapayAuthRequest { + fn from_auth_type(auth: &FacilitapayAuthType) -> Self { + Self { + user: FacilitapayCredentials { + username: auth.username.clone(), + password: auth.password.clone(), + }, + } + } +} + +impl TryFrom<&ConnectorAuthType> for FacilitapayAuthType { + type Error = Error; + fn try_from(auth_type: &ConnectorAuthType) -> Result<Self, Self::Error> { + match auth_type { + ConnectorAuthType::BodyKey { api_key, key1 } => Ok(Self { + username: key1.to_owned(), + password: api_key.to_owned(), + }), + _ => Err(errors::ConnectorError::FailedToObtainAuthType.into()), + } + } +} + +impl TryFrom<&RefreshTokenRouterData> for FacilitapayAuthRequest { + type Error = Error; + fn try_from(item: &RefreshTokenRouterData) -> Result<Self, Self::Error> { + let auth_type = FacilitapayAuthType::try_from(&item.connector_auth_type)?; + Ok(Self::from_auth_type(&auth_type)) + } +} + +impl TryFrom<&Option<pii::SecretSerdeValue>> for FacilitapayConnectorMetadataObject { + type Error = Error; + + fn try_from(meta_data: &Option<pii::SecretSerdeValue>) -> Result<Self, Self::Error> { + let metadata: Self = utils::to_connector_meta_from_secret(meta_data.clone()) + .change_context(errors::ConnectorError::InvalidConnectorConfig { + config: "merchant_connector_account.metadata", + })?; + + Ok(metadata) + } +} + impl TryFrom<&FacilitapayRouterData<&types::PaymentsAuthorizeRouterData>> for FacilitapayPaymentsRequest { @@ -54,11 +116,13 @@ impl TryFrom<&FacilitapayRouterData<&types::PaymentsAuthorizeRouterData>> fn try_from( item: &FacilitapayRouterData<&types::PaymentsAuthorizeRouterData>, ) -> Result<Self, Self::Error> { + let metadata = + FacilitapayConnectorMetadataObject::try_from(&item.router_data.connector_meta_data)?; + match item.router_data.request.payment_method_data.clone() { PaymentMethodData::BankTransfer(bank_transfer_data) => match *bank_transfer_data { BankTransferData::Pix { source_bank_account_id, - destination_bank_account_id, .. } => { // Set expiry time to 15 minutes from now @@ -80,11 +144,7 @@ impl TryFrom<&FacilitapayRouterData<&types::PaymentsAuthorizeRouterData>> }, )?, - to_bank_account_id: destination_bank_account_id.clone().ok_or( - errors::ConnectorError::MissingRequiredField { - field_name: "destination bank account id", - }, - )?, + to_bank_account_id: metadata.destination_account_number, currency: item.router_data.request.currency, exchange_currency: item.router_data.request.currency, value: item.amount.clone(), @@ -146,46 +206,6 @@ impl TryFrom<&FacilitapayRouterData<&types::PaymentsAuthorizeRouterData>> } } -// Helper to build the request from Hyperswitch Auth Type -impl FacilitapayAuthRequest { - fn from_auth_type(auth: &FacilitapayAuthType) -> Self { - Self { - user: FacilitapayCredentials { - username: auth.username.clone(), - password: auth.password.clone(), - }, - } - } -} - -// Auth Struct -#[derive(Debug, Clone)] -pub struct FacilitapayAuthType { - pub(super) username: Secret<String>, - pub(super) password: Secret<String>, -} - -impl TryFrom<&ConnectorAuthType> for FacilitapayAuthType { - type Error = Error; - fn try_from(auth_type: &ConnectorAuthType) -> Result<Self, Self::Error> { - match auth_type { - ConnectorAuthType::BodyKey { api_key, key1 } => Ok(Self { - username: key1.to_owned(), - password: api_key.to_owned(), - }), - _ => Err(errors::ConnectorError::FailedToObtainAuthType.into()), - } - } -} - -impl TryFrom<&RefreshTokenRouterData> for FacilitapayAuthRequest { - type Error = Error; - fn try_from(item: &RefreshTokenRouterData) -> Result<Self, Self::Error> { - let auth_type = FacilitapayAuthType::try_from(&item.connector_auth_type)?; - Ok(Self::from_auth_type(&auth_type)) - } -} - fn convert_to_document_type(document_type: &str) -> Result<DocumentType, errors::ConnectorError> { match document_type.to_lowercase().as_str() { "cc" => Ok(DocumentType::CedulaDeCiudadania), @@ -394,7 +414,13 @@ impl<F, T> TryFrom<ResponseRouterData<F, FacilitapayPaymentsResponse, T, Payment let status = if item.data.payment_method == PaymentMethod::BankTransfer && item.response.data.status == FacilitapayPaymentStatus::Identified { - common_enums::AttemptStatus::AuthenticationPending + if item.response.data.currency != item.response.data.exchange_currency { + // Cross-currency: Identified is not terminal + common_enums::AttemptStatus::Pending + } else { + // Local currency: Identified is terminal + common_enums::AttemptStatus::Charged + } } else { common_enums::AttemptStatus::from(item.response.data.status.clone()) }; diff --git a/crates/payment_methods/src/configs/payment_connector_required_fields.rs b/crates/payment_methods/src/configs/payment_connector_required_fields.rs index 2dd291d16f5..a57d3002caf 100644 --- a/crates/payment_methods/src/configs/payment_connector_required_fields.rs +++ b/crates/payment_methods/src/configs/payment_connector_required_fields.rs @@ -193,7 +193,6 @@ enum RequiredField { PixCnpj, PixCpf, PixSourceBankAccountId, - PixDestinationBankAccountId, GiftCardNumber, GiftCardCvc, DcbMsisdn, @@ -808,17 +807,6 @@ impl RequiredField { value: None, }, ), - Self::PixDestinationBankAccountId => ( - "payment_method_data.bank_transfer.pix.destination_bank_account_id".to_string(), - RequiredFieldInfo { - required_field: - "payment_method_data.bank_transfer.pix.destination_bank_account_id" - .to_string(), - display_name: "destination_bank_account_id".to_string(), - field_type: FieldType::UserDestinationBankAccountId, - value: None, - }, - ), Self::GiftCardNumber => ( "payment_method_data.gift_card.number".to_string(), RequiredFieldInfo { @@ -3232,7 +3220,6 @@ fn get_bank_transfer_required_fields() -> HashMap<enums::PaymentMethodType, Conn non_mandate: HashMap::new(), common: HashMap::from([ RequiredField::PixSourceBankAccountId.to_tuple(), - RequiredField::PixDestinationBankAccountId.to_tuple(), RequiredField::BillingAddressCountries(vec!["BR"]).to_tuple(), RequiredField::BillingUserFirstName.to_tuple(), RequiredField::BillingUserLastName.to_tuple(), diff --git a/crates/router/src/core/connector_validation.rs b/crates/router/src/core/connector_validation.rs index f04edb139f2..8f0bce516cb 100644 --- a/crates/router/src/core/connector_validation.rs +++ b/crates/router/src/core/connector_validation.rs @@ -210,6 +210,9 @@ impl ConnectorAuthTypeAndMetadataValidation<'_> { } api_enums::Connector::Facilitapay => { facilitapay::transformers::FacilitapayAuthType::try_from(self.auth_type)?; + facilitapay::transformers::FacilitapayConnectorMetadataObject::try_from( + self.connector_meta_data, + )?; Ok(()) } api_enums::Connector::Fiserv => {

2025-07-21T08:33:27Z

## Type of Change  - [ ] Bugfix - [ ] New feature - [ ] Enhancement - [x] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  Destination bank account id should be merchant facing, not customer. This PR removes any references to destination bank account id and moves it to connector metadata instead. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [x] This PR modifies application configuration/environment variables  /crates/connector_configs/toml/development.toml /crates/connector_configs/toml/sandbox.toml /crates/connector_configs/toml/production.toml ## Motivation and Context  Customer should not enter merchant's bank details. It should be merchant facing instead. Closes #8703. ## How did you test it?  Create MCA: ```curl curl --location 'http://localhost:8080/account/postman_merchant_GHAction_1753083253/connectors' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_Dyq5nDoX7lVK7WTywFMzt7RKqlI86c6FFg7kun0keGiZpByVLgo8y4dhdbAqYIm8' \ --data-raw '{ "connector_type": "payment_processor", "connector_name": "facilitapay", "business_country": "US", "business_label": "default", "connector_account_details": { "auth_type": "BodyKey", "api_key": "api_key", "key1": "key1" }, "test_mode": false, "disabled": false, "metadata": { "destination_account_number": "<UUID>" }, "payment_methods_enabled": [ { "payment_method": "bank_transfer", "payment_method_types": [ { "payment_method_type": "pix", "minimum_amount": 1, "maximum_amount": 68607706, "recurring_enabled": true, "installment_payment_enabled": true } ] }, ] }' ``` ```json { "connector_type": "payment_processor", "connector_name": "facilitapay", "connector_label": "facilitapay_US_default", "merchant_connector_id": "mca_rMIEEmHi0UapY2hNpT3H", "profile_id": "pro_0ebkZdbr9FTvQ7UwInzm", "connector_account_details": { "auth_type": "BodyKey", "api_key": "api_key", "key1": "key1" }, "payment_methods_enabled": [ { "payment_method": "bank_transfer", "payment_method_types": [ { "payment_method_type": "pix", "payment_experience": null, "card_networks": null, "accepted_currencies": null, "accepted_countries": null, "minimum_amount": 1, "maximum_amount": 68607706, "recurring_enabled": true, "installment_payment_enabled": true } ] }, ], "connector_webhook_details": null, "metadata": { "destination_account_number": "UUID" }, "test_mode": false, "disabled": false, "frm_configs": null, "business_country": "US", "business_label": "default", "business_sub_label": null, "applepay_verified_domains": null, "pm_auth_config": null, "status": "active", "additional_merchant_data": null, "connector_wallets_details": null } ``` Not passing connector metadata during MCA create call should result in a 4xx like below: ```json { "error": { "type": "invalid_request", "message": "The merchant_connector_account.metadata is invalid", "code": "IR_06" } } ``` <img width="729" height="981" alt="image" src="https://github.com/user-attachments/assets/42100bec-8635-41d5-a71c-d861de229385" /> <img width="642" height="1038" alt="image" src="https://github.com/user-attachments/assets/d0a146e4-f021-49a7-97b5-4b49556bf638" /> I'll fix the 1 failure in next PR. We throw `501`, commons expects a `2xx` ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `just clippy && just clippy_v2` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

be03dd2ae9a4df9b592aa3fc482e5356843a7163

juspay/hyperswitch

juspay__hyperswitch-8693

Bug: update open api spec for create platform api

diff --git a/api-reference/README.md b/api-reference/README.md index ef3537d6b73..d8de73895da 100644 --- a/api-reference/README.md +++ b/api-reference/README.md @@ -44,5 +44,4 @@ npx @mintlify/scraping@latest openapi-file v1/openapi_spec_v1.json -o v1 This will generate files in [api-reference](api-reference) folder. These routes should be added to the [mint.json](mint.json) file under navigation, under respective group. - -NOTE: For working with V2 API reference, replace every occurrence of `v1` with `v2` in above commands \ No newline at end of file +NOTE: For working with V2 API reference, replace every occurrence of `v1` with `v2` in above commands diff --git a/api-reference/docs.json b/api-reference/docs.json index 9688afc3241..ea1ab01bfcb 100644 --- a/api-reference/docs.json +++ b/api-reference/docs.json @@ -146,6 +146,12 @@ "v1/business-profile/business-profile--list" ] }, + { + "group": "Platform Account", + "pages": [ + "v1/platform/platform--create" + ] + }, { "group": "API Key", "pages": [ diff --git a/api-reference/v1/openapi_spec_v1.json b/api-reference/v1/openapi_spec_v1.json index ccd6d2e11b7..75e5fbea6df 100644 --- a/api-reference/v1/openapi_spec_v1.json +++ b/api-reference/v1/openapi_spec_v1.json @@ -6481,6 +6481,53 @@ } ] } + }, + "/create_platform": { + "post": { + "tags": [ + "Platform" + ], + "summary": "Platform - Create", + "description": "Create a new platform account", + "operationId": "Create a Platform Account", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PlatformAccountCreateRequest" + }, + "examples": { + "Create a platform account with organization_name": { + "value": { + "organization_name": "organization_abc" + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Platform Account Created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PlatformAccountCreateResponse" + } + } + } + }, + "400": { + "description": "Invalid data" + } + }, + "security": [ + { + "jwt_key": [] + } + ] + } } }, "components": { @@ -26305,6 +26352,51 @@ } } }, + "PlatformAccountCreateRequest": { + "type": "object", + "required": [ + "organization_name" + ], + "properties": { + "organization_name": { + "type": "string", + "example": "organization_abc", + "maxLength": 64 + } + } + }, + "PlatformAccountCreateResponse": { + "type": "object", + "required": [ + "org_id", + "org_type", + "merchant_id", + "merchant_account_type" + ], + "properties": { + "org_id": { + "type": "string", + "example": "org_abc", + "maxLength": 64, + "minLength": 1 + }, + "org_name": { + "type": "string", + "example": "organization_abc", + "nullable": true + }, + "org_type": { + "$ref": "#/components/schemas/OrganizationType" + }, + "merchant_id": { + "type": "string", + "example": "merchant_abc" + }, + "merchant_account_type": { + "$ref": "#/components/schemas/MerchantAccountType" + } + } + }, "PollConfig": { "type": "object", "required": [ diff --git a/api-reference/v1/platform/platform--create.mdx b/api-reference/v1/platform/platform--create.mdx new file mode 100644 index 00000000000..61a12fdc6d8 --- /dev/null +++ b/api-reference/v1/platform/platform--create.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /create_platform +--- \ No newline at end of file diff --git a/crates/api_models/src/user.rs b/crates/api_models/src/user.rs index 47608532b54..82d10a16215 100644 --- a/crates/api_models/src/user.rs +++ b/crates/api_models/src/user.rs @@ -3,6 +3,7 @@ use std::fmt::Debug; use common_enums::{EntityType, TokenPurpose}; use common_utils::{crypto::OptionalEncryptableName, id_type, pii}; use masking::Secret; +use utoipa::ToSchema; use crate::user_role::UserStatus; pub mod dashboard_metadata; @@ -150,17 +151,24 @@ pub struct UserOrgMerchantCreateRequest { pub merchant_name: Secret<String>, } -#[derive(Debug, serde::Deserialize, serde::Serialize, Clone)] +#[derive(Debug, serde::Deserialize, serde::Serialize, Clone, ToSchema)] pub struct PlatformAccountCreateRequest { + #[schema(max_length = 64, value_type = String, example = "organization_abc")] pub organization_name: Secret<String>, } -#[derive(Debug, serde::Deserialize, serde::Serialize)] +#[derive(Debug, serde::Deserialize, serde::Serialize, ToSchema)] pub struct PlatformAccountCreateResponse { + #[schema(value_type = String, max_length = 64, min_length = 1, example = "org_abc")] pub org_id: id_type::OrganizationId, + #[schema(value_type = Option<String>, example = "organization_abc")] pub org_name: Option<String>, + + #[schema(value_type = OrganizationType, example = "standard")] pub org_type: common_enums::OrganizationType, + #[schema(value_type = String, example = "merchant_abc")] pub merchant_id: id_type::MerchantId, + #[schema(value_type = MerchantAccountType, example = "standard")] pub merchant_account_type: common_enums::MerchantAccountType, } diff --git a/crates/openapi/src/openapi.rs b/crates/openapi/src/openapi.rs index 54b004e32ba..a5e0a6d95c6 100644 --- a/crates/openapi/src/openapi.rs +++ b/crates/openapi/src/openapi.rs @@ -213,6 +213,9 @@ Never share your secret api keys. Keep them guarded and secure. // Routes for authentication routes::authentication::authentication_create, + + // Routes for platform account + routes::platform::create_platform_account, ), components(schemas( common_utils::types::MinorUnit, @@ -362,8 +365,8 @@ Never share your secret api keys. Keep them guarded and secure. api_models::enums::MerchantProductType, api_models::enums::CtpServiceProvider, api_models::enums::PaymentLinkSdkLabelType, - api_models::enums::PaymentLinkShowSdkTerms, api_models::enums::OrganizationType, + api_models::enums::PaymentLinkShowSdkTerms, api_models::admin::MerchantConnectorCreate, api_models::admin::AdditionalMerchantData, api_models::admin::ConnectorWalletDetails, @@ -806,6 +809,8 @@ Never share your secret api keys. Keep them guarded and secure. api_models::authentication::ThreeDsData, api_models::authentication::AuthenticationEligibilityRequest, api_models::authentication::AuthenticationEligibilityResponse, + api_models::user::PlatformAccountCreateRequest, + api_models::user::PlatformAccountCreateResponse, )), modifiers(&SecurityAddon) )] diff --git a/crates/openapi/src/routes.rs b/crates/openapi/src/routes.rs index 50c7db98ab3..7dcdf60571f 100644 --- a/crates/openapi/src/routes.rs +++ b/crates/openapi/src/routes.rs @@ -14,6 +14,7 @@ pub mod payment_link; pub mod payment_method; pub mod payments; pub mod payouts; +pub mod platform; pub mod poll; pub mod profile; pub mod profile_acquirer; diff --git a/crates/openapi/src/routes/platform.rs b/crates/openapi/src/routes/platform.rs new file mode 100644 index 00000000000..6dc04076e51 --- /dev/null +++ b/crates/openapi/src/routes/platform.rs @@ -0,0 +1,26 @@ +#[cfg(feature = "v1")] +/// Platform - Create +/// +/// Create a new platform account +#[utoipa::path( + post, + path = "/create_platform", + request_body( + content = PlatformAccountCreateRequest, + examples( + ( + "Create a platform account with organization_name" = ( + value = json!({"organization_name": "organization_abc"}) + ) + ), + ) + ), + responses( + (status = 200, description = "Platform Account Created", body = PlatformAccountCreateResponse), + (status = 400, description = "Invalid data") + ), + tag = "Platform", + operation_id = "Create a Platform Account", + security(("jwt_key" = [])) +)] +pub async fn create_platform_account() {}

2025-07-18T12:14:55Z

## Type of Change  - [ ] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [x] Documentation - [ ] CI/CD ## Description - generated open api spec for create platform api <img width="3182" height="2040" alt="image" src="https://github.com/user-attachments/assets/1373cff4-640d-4a4f-8b21-2fdb50a340e4" /> ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  ## How did you test it? - I run the `mint dev` command to check if the platform create api is reflecting in the api reference docs after these changes - Refer the attached screenshot ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

6214aca5f0f5c617a68f65ef5bcfd700060acccf

juspay/hyperswitch

juspay__hyperswitch-8706

Bug: [FEATURE] [TRUSTPAYMENTS] Integrate cards non-3ds payments ### Feature Description cards non-3ds payments needs to be integrated for trustpayments ### Possible Implementation cards non-3ds payments needs to be integrated for trustpayments ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? None

diff --git a/api-reference/v1/openapi_spec_v1.json b/api-reference/v1/openapi_spec_v1.json index 34cd0c51473..29fb70620b2 100644 --- a/api-reference/v1/openapi_spec_v1.json +++ b/api-reference/v1/openapi_spec_v1.json @@ -12131,6 +12131,7 @@ "threedsecureio", "tokenio", "trustpay", + "trustpayments", "tsys", "vgs", "volt", @@ -30238,6 +30239,7 @@ "stripe", "stripebilling", "trustpay", + "trustpayments", "tokenio", "tsys", "volt", diff --git a/api-reference/v2/openapi_spec_v2.json b/api-reference/v2/openapi_spec_v2.json index 1559dce9183..fe0836bbc9c 100644 --- a/api-reference/v2/openapi_spec_v2.json +++ b/api-reference/v2/openapi_spec_v2.json @@ -8675,6 +8675,7 @@ "threedsecureio", "tokenio", "trustpay", + "trustpayments", "tsys", "vgs", "volt", @@ -23867,6 +23868,7 @@ "stripe", "stripebilling", "trustpay", + "trustpayments", "tokenio", "tsys", "volt", diff --git a/crates/common_enums/src/connector_enums.rs b/crates/common_enums/src/connector_enums.rs index 3a7d2f535cc..6621440b13d 100644 --- a/crates/common_enums/src/connector_enums.rs +++ b/crates/common_enums/src/connector_enums.rs @@ -156,6 +156,7 @@ pub enum RoutableConnectors { Stripebilling, // Taxjar, Trustpay, + Trustpayments, // Thunes Tokenio, // Tsys, @@ -336,6 +337,7 @@ pub enum Connector { //Thunes, Tokenio, Trustpay, + Trustpayments, Tsys, // UnifiedAuthenticationService, Vgs, @@ -519,6 +521,7 @@ impl Connector { | Self::Taxjar // | Self::Thunes | Self::Trustpay + | Self::Trustpayments // | Self::Tokenio | Self::Tsys // | Self::UnifiedAuthenticationService @@ -702,6 +705,7 @@ impl From<RoutableConnectors> for Connector { RoutableConnectors::Stripebilling => Self::Stripebilling, RoutableConnectors::Tokenio => Self::Tokenio, RoutableConnectors::Trustpay => Self::Trustpay, + RoutableConnectors::Trustpayments => Self::Trustpayments, // RoutableConnectors::Tokenio => Self::Tokenio, RoutableConnectors::Tsys => Self::Tsys, RoutableConnectors::Volt => Self::Volt, @@ -835,6 +839,7 @@ impl TryFrom<Connector> for RoutableConnectors { Connector::Stripebilling => Ok(Self::Stripebilling), Connector::Tokenio => Ok(Self::Tokenio), Connector::Trustpay => Ok(Self::Trustpay), + Connector::Trustpayments => Ok(Self::Trustpayments), Connector::Tsys => Ok(Self::Tsys), Connector::Volt => Ok(Self::Volt), Connector::Wellsfargo => Ok(Self::Wellsfargo), diff --git a/crates/connector_configs/src/connector.rs b/crates/connector_configs/src/connector.rs index 0a521f7a864..2c89a48aed7 100644 --- a/crates/connector_configs/src/connector.rs +++ b/crates/connector_configs/src/connector.rs @@ -518,6 +518,7 @@ impl ConnectorConfig { Connector::Stripebilling => Ok(connector_data.stripebilling), Connector::Tokenio => Ok(connector_data.tokenio), Connector::Trustpay => Ok(connector_data.trustpay), + Connector::Trustpayments => Ok(connector_data.trustpayments), Connector::Threedsecureio => Ok(connector_data.threedsecureio), Connector::Taxjar => Ok(connector_data.taxjar), Connector::Tsys => Ok(connector_data.tsys), diff --git a/crates/connector_configs/toml/development.toml b/crates/connector_configs/toml/development.toml index 0f9fa995409..838be6e3524 100644 --- a/crates/connector_configs/toml/development.toml +++ b/crates/connector_configs/toml/development.toml @@ -6722,8 +6722,19 @@ api_key = "API Key" key1 = "API Secret" [trustpayments] +[[trustpayments.credit]] + payment_method_type = "Mastercard" +[[trustpayments.credit]] + payment_method_type = "Visa" +[[trustpayments.debit]] + payment_method_type = "Mastercard" +[[trustpayments.debit]] + payment_method_type = "Visa" [trustpayments.connector_auth.HeaderKey] api_key = "API Key" +[trustpayments.connector_webhook_details] +merchant_secret = "Source verification key" + [breadpay] [breadpay.connector_auth.BodyKey] diff --git a/crates/connector_configs/toml/production.toml b/crates/connector_configs/toml/production.toml index 96d473a386c..8a163f6b66d 100644 --- a/crates/connector_configs/toml/production.toml +++ b/crates/connector_configs/toml/production.toml @@ -5374,9 +5374,20 @@ merchant_secret="Source verification key" api_key = "API Key" key1 = "API Secret" + [trustpayments] +[[trustpayments.credit]] +payment_method_type = "Mastercard" +[[trustpayments.credit]] +payment_method_type = "Visa" +[[trustpayments.debit]] +payment_method_type = "Mastercard" +[[trustpayments.debit]] +payment_method_type = "Visa" [trustpayments.connector_auth.HeaderKey] api_key = "API Key" +[trustpayments.connector_webhook_details] +merchant_secret = "Source verification key" [flexiti] diff --git a/crates/connector_configs/toml/sandbox.toml b/crates/connector_configs/toml/sandbox.toml index 45da96d5344..801f18a927b 100644 --- a/crates/connector_configs/toml/sandbox.toml +++ b/crates/connector_configs/toml/sandbox.toml @@ -6703,11 +6703,19 @@ merchant_secret="Source verification key" api_key = "API Key" key1 = "API Secret" + [trustpayments] +[[trustpayments.credit]] +payment_method_type = "Mastercard" +[[trustpayments.credit]] +payment_method_type = "Visa" +[[trustpayments.debit]] +payment_method_type = "Mastercard" +[[trustpayments.debit]] +payment_method_type = "Visa" [trustpayments.connector_auth.HeaderKey] api_key = "API Key" - [breadpay] [breadpay.connector_auth.BodyKey] api_key = "API Key" diff --git a/crates/hyperswitch_connectors/src/connectors/trustpayments.rs b/crates/hyperswitch_connectors/src/connectors/trustpayments.rs index 4b92c5aef60..a5bbb802ea3 100644 --- a/crates/hyperswitch_connectors/src/connectors/trustpayments.rs +++ b/crates/hyperswitch_connectors/src/connectors/trustpayments.rs @@ -24,11 +24,12 @@ use hyperswitch_domain_models::{ RefundsData, SetupMandateRequestData, }, router_response_types::{ - ConnectorInfo, PaymentsResponseData, RefundsResponseData, SupportedPaymentMethods, + ConnectorInfo, PaymentMethodDetails, PaymentsResponseData, RefundsResponseData, + SupportedPaymentMethods, SupportedPaymentMethodsExt, }, types::{ - PaymentsAuthorizeRouterData, PaymentsCaptureRouterData, PaymentsSyncRouterData, - RefundSyncRouterData, RefundsRouterData, + PaymentsAuthorizeRouterData, PaymentsCancelRouterData, PaymentsCaptureRouterData, + PaymentsSyncRouterData, RefundSyncRouterData, RefundsRouterData, }, }; use hyperswitch_interfaces::{ @@ -42,7 +43,7 @@ use hyperswitch_interfaces::{ types::{self, Response}, webhooks, }; -use masking::{ExposeInterface, Mask}; +use masking::Mask; use transformers as trustpayments; use crate::{constants::headers, types::ResponseRouterData, utils}; @@ -76,7 +77,82 @@ impl api::PaymentToken for Trustpayments {} impl ConnectorIntegration<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData> for Trustpayments { - // Not Implemented (R) + fn get_headers( + &self, + req: &RouterData<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData>, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &RouterData<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData>, + connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Ok(format!("{}/json/", self.base_url(connectors))) + } + + fn get_request_body( + &self, + req: &RouterData<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData>, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let connector_req = trustpayments::TrustpaymentsTokenizationRequest::try_from(req)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &RouterData<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData>, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::TokenizationType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::TokenizationType::get_headers(self, req, connectors)?) + .set_body(types::TokenizationType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &RouterData<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData>, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult< + RouterData<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData>, + errors::ConnectorError, + > { + let response: trustpayments::TrustpaymentsTokenizationResponse = res + .response + .parse_struct("Trustpayments TokenizationResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } } impl<Flow, Request, Response> ConnectorCommonExt<Flow, Request, Response> for Trustpayments @@ -104,12 +180,7 @@ impl ConnectorCommon for Trustpayments { } fn get_currency_unit(&self) -> api::CurrencyUnit { - // todo!() api::CurrencyUnit::Minor - - // TODO! Check connector documentation, on which unit they are processing the currency. - // If the connector accepts amount in lower unit ( i.e cents for USD) then return api::CurrencyUnit::Minor, - // if connector accepts amount in base unit (i.e dollars for USD) then return api::CurrencyUnit::Base } fn common_get_content_type(&self) -> &'static str { @@ -128,7 +199,7 @@ impl ConnectorCommon for Trustpayments { .change_context(errors::ConnectorError::FailedToObtainAuthType)?; Ok(vec![( headers::AUTHORIZATION.to_string(), - auth.api_key.expose().into_masked(), + auth.get_basic_auth_header().into_masked(), )]) } @@ -186,9 +257,7 @@ impl ConnectorValidation for Trustpayments { } } -impl ConnectorIntegration<Session, PaymentsSessionData, PaymentsResponseData> for Trustpayments { - //TODO: implement sessions flow -} +impl ConnectorIntegration<Session, PaymentsSessionData, PaymentsResponseData> for Trustpayments {} impl ConnectorIntegration<AccessTokenAuth, AccessTokenRequestData, AccessToken> for Trustpayments {} @@ -215,9 +284,9 @@ impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData fn get_url( &self, _req: &PaymentsAuthorizeRouterData, - _connectors: &Connectors, + connectors: &Connectors, ) -> CustomResult<String, errors::ConnectorError> { - Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + Ok(format!("{}/json/", self.base_url(connectors))) } fn get_request_body( @@ -303,9 +372,18 @@ impl ConnectorIntegration<PSync, PaymentsSyncData, PaymentsResponseData> for Tru fn get_url( &self, _req: &PaymentsSyncRouterData, - _connectors: &Connectors, + connectors: &Connectors, ) -> CustomResult<String, errors::ConnectorError> { - Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + Ok(format!("{}/json/", self.base_url(connectors))) + } + + fn get_request_body( + &self, + req: &PaymentsSyncRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let connector_req = trustpayments::TrustpaymentsSyncRequest::try_from(req)?; + Ok(RequestContent::Json(Box::new(connector_req))) } fn build_request( @@ -315,10 +393,13 @@ impl ConnectorIntegration<PSync, PaymentsSyncData, PaymentsResponseData> for Tru ) -> CustomResult<Option<Request>, errors::ConnectorError> { Ok(Some( RequestBuilder::new() - .method(Method::Get) + .method(Method::Post) .url(&types::PaymentsSyncType::get_url(self, req, connectors)?) .attach_default_headers() .headers(types::PaymentsSyncType::get_headers(self, req, connectors)?) + .set_body(types::PaymentsSyncType::get_request_body( + self, req, connectors, + )?) .build(), )) } @@ -367,17 +448,26 @@ impl ConnectorIntegration<Capture, PaymentsCaptureData, PaymentsResponseData> fo fn get_url( &self, _req: &PaymentsCaptureRouterData, - _connectors: &Connectors, + connectors: &Connectors, ) -> CustomResult<String, errors::ConnectorError> { - Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + Ok(format!("{}/json/", self.base_url(connectors))) } fn get_request_body( &self, - _req: &PaymentsCaptureRouterData, + req: &PaymentsCaptureRouterData, _connectors: &Connectors, ) -> CustomResult<RequestContent, errors::ConnectorError> { - Err(errors::ConnectorError::NotImplemented("get_request_body method".to_string()).into()) + let amount = utils::convert_amount( + self.amount_converter, + req.request.minor_amount_to_capture, + req.request.currency, + )?; + + let connector_router_data = trustpayments::TrustpaymentsRouterData::from((amount, req)); + let connector_req = + trustpayments::TrustpaymentsCaptureRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) } fn build_request( @@ -428,7 +518,81 @@ impl ConnectorIntegration<Capture, PaymentsCaptureData, PaymentsResponseData> fo } } -impl ConnectorIntegration<Void, PaymentsCancelData, PaymentsResponseData> for Trustpayments {} +impl ConnectorIntegration<Void, PaymentsCancelData, PaymentsResponseData> for Trustpayments { + fn get_headers( + &self, + req: &PaymentsCancelRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsCancelRouterData, + connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Ok(format!("{}/json/", self.base_url(connectors))) + } + + fn get_request_body( + &self, + req: &PaymentsCancelRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let connector_req = trustpayments::TrustpaymentsVoidRequest::try_from(req)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &PaymentsCancelRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::PaymentsVoidType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::PaymentsVoidType::get_headers(self, req, connectors)?) + .set_body(types::PaymentsVoidType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsCancelRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsCancelRouterData, errors::ConnectorError> { + let response: trustpayments::TrustpaymentsPaymentsResponse = res + .response + .parse_struct("Trustpayments PaymentsVoidResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} impl ConnectorIntegration<Execute, RefundsData, RefundsResponseData> for Trustpayments { fn get_headers( @@ -446,9 +610,9 @@ impl ConnectorIntegration<Execute, RefundsData, RefundsResponseData> for Trustpa fn get_url( &self, _req: &RefundsRouterData<Execute>, - _connectors: &Connectors, + connectors: &Connectors, ) -> CustomResult<String, errors::ConnectorError> { - Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + Ok(format!("{}/json/", self.base_url(connectors))) } fn get_request_body( @@ -532,9 +696,18 @@ impl ConnectorIntegration<RSync, RefundsData, RefundsResponseData> for Trustpaym fn get_url( &self, _req: &RefundSyncRouterData, - _connectors: &Connectors, + connectors: &Connectors, ) -> CustomResult<String, errors::ConnectorError> { - Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + Ok(format!("{}/json/", self.base_url(connectors))) + } + + fn get_request_body( + &self, + req: &RefundSyncRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let connector_req = trustpayments::TrustpaymentsRefundSyncRequest::try_from(req)?; + Ok(RequestContent::Json(Box::new(connector_req))) } fn build_request( @@ -544,7 +717,7 @@ impl ConnectorIntegration<RSync, RefundsData, RefundsResponseData> for Trustpaym ) -> CustomResult<Option<Request>, errors::ConnectorError> { Ok(Some( RequestBuilder::new() - .method(Method::Get) + .method(Method::Post) .url(&types::RefundSyncType::get_url(self, req, connectors)?) .attach_default_headers() .headers(types::RefundSyncType::get_headers(self, req, connectors)?) @@ -608,7 +781,61 @@ impl webhooks::IncomingWebhook for Trustpayments { } static TRUSTPAYMENTS_SUPPORTED_PAYMENT_METHODS: LazyLock<SupportedPaymentMethods> = - LazyLock::new(SupportedPaymentMethods::new); + LazyLock::new(|| { + let supported_capture_methods = vec![ + enums::CaptureMethod::Automatic, + enums::CaptureMethod::Manual, + ]; + + let mut trustpayments_supported_payment_methods = SupportedPaymentMethods::new(); + + trustpayments_supported_payment_methods.add( + enums::PaymentMethod::Card, + enums::PaymentMethodType::Credit, + PaymentMethodDetails { + mandates: enums::FeatureStatus::NotSupported, + refunds: enums::FeatureStatus::Supported, + supported_capture_methods: supported_capture_methods.clone(), + specific_features: Some( + api_models::feature_matrix::PaymentMethodSpecificFeatures::Card({ + api_models::feature_matrix::CardSpecificFeatures { + three_ds: enums::FeatureStatus::NotSupported, + no_three_ds: enums::FeatureStatus::Supported, + supported_card_networks: vec![ + enums::CardNetwork::Visa, + enums::CardNetwork::Mastercard, + enums::CardNetwork::AmericanExpress, + ], + } + }), + ), + }, + ); + + trustpayments_supported_payment_methods.add( + enums::PaymentMethod::Card, + enums::PaymentMethodType::Debit, + PaymentMethodDetails { + mandates: enums::FeatureStatus::NotSupported, + refunds: enums::FeatureStatus::Supported, + supported_capture_methods: supported_capture_methods.clone(), + specific_features: Some( + api_models::feature_matrix::PaymentMethodSpecificFeatures::Card({ + api_models::feature_matrix::CardSpecificFeatures { + three_ds: enums::FeatureStatus::NotSupported, + no_three_ds: enums::FeatureStatus::Supported, + supported_card_networks: vec![ + enums::CardNetwork::Visa, + enums::CardNetwork::Mastercard, + ], + } + }), + ), + }, + ); + + trustpayments_supported_payment_methods + }); static TRUSTPAYMENTS_CONNECTOR_INFO: ConnectorInfo = ConnectorInfo { display_name: "Trustpayments", diff --git a/crates/hyperswitch_connectors/src/connectors/trustpayments/transformers.rs b/crates/hyperswitch_connectors/src/connectors/trustpayments/transformers.rs index debeca6b63a..befb9625536 100644 --- a/crates/hyperswitch_connectors/src/connectors/trustpayments/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/trustpayments/transformers.rs @@ -1,28 +1,300 @@ +use cards; use common_enums::enums; use common_utils::types::StringMinorUnit; +use error_stack::ResultExt; use hyperswitch_domain_models::{ payment_method_data::PaymentMethodData, router_data::{ConnectorAuthType, RouterData}, router_flow_types::refunds::{Execute, RSync}, router_request_types::ResponseId, router_response_types::{PaymentsResponseData, RefundsResponseData}, - types::{PaymentsAuthorizeRouterData, RefundsRouterData}, + types::{ + PaymentsAuthorizeRouterData, PaymentsCancelRouterData, PaymentsCaptureRouterData, + PaymentsSyncRouterData, RefundSyncRouterData, RefundsRouterData, + }, }; use hyperswitch_interfaces::errors; -use masking::Secret; +use masking::{ExposeInterface, Secret}; use serde::{Deserialize, Serialize}; -use crate::types::{RefundsResponseRouterData, ResponseRouterData}; +use crate::{ + types::{RefundsResponseRouterData, ResponseRouterData}, + utils::{self, CardData, RefundsRequestData, RouterData as RouterDataExt}, +}; + +const TRUSTPAYMENTS_API_VERSION: &str = "1.00"; + +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)] +pub enum TrustpaymentsSettleStatus { + #[serde(rename = "0")] + PendingSettlement, + #[serde(rename = "1")] + Settled, + #[serde(rename = "2")] + ManualCapture, + #[serde(rename = "3")] + Voided, +} + +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)] +pub enum TrustpaymentsCredentialsOnFile { + #[serde(rename = "0")] + NoStoredCredentials, + #[serde(rename = "1")] + CardholderInitiatedTransaction, + #[serde(rename = "2")] + MerchantInitiatedTransaction, +} + +impl TrustpaymentsCredentialsOnFile { + pub fn as_str(&self) -> &'static str { + match self { + Self::NoStoredCredentials => "0", + Self::CardholderInitiatedTransaction => "1", + Self::MerchantInitiatedTransaction => "2", + } + } +} + +impl std::fmt::Display for TrustpaymentsCredentialsOnFile { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + write!(f, "{}", self.as_str()) + } +} + +impl TrustpaymentsSettleStatus { + pub fn as_str(&self) -> &'static str { + match self { + Self::PendingSettlement => "0", + Self::Settled => "1", + Self::ManualCapture => "2", + Self::Voided => "3", + } + } +} + +impl std::fmt::Display for TrustpaymentsSettleStatus { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + write!(f, "{}", self.as_str()) + } +} + +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)] +pub enum TrustpaymentsErrorCode { + #[serde(rename = "0")] + Success, + + #[serde(rename = "30000")] + InvalidCredentials, + #[serde(rename = "30001")] + AuthenticationFailed, + #[serde(rename = "30002")] + InvalidSiteReference, + #[serde(rename = "30003")] + AccessDenied, + #[serde(rename = "30004")] + InvalidUsernameOrPassword, + #[serde(rename = "30005")] + AccountSuspended, + #[serde(rename = "50000")] + MissingRequiredField, + #[serde(rename = "50001")] + InvalidFieldFormat, + #[serde(rename = "50002")] + InvalidFieldValue, + #[serde(rename = "50003")] + FieldTooLong, + #[serde(rename = "50004")] + FieldTooShort, + #[serde(rename = "50005")] + InvalidCurrency, + #[serde(rename = "50006")] + InvalidAmount, + #[serde(rename = "60000")] + GeneralProcessingError, + #[serde(rename = "60001")] + SystemError, + #[serde(rename = "60002")] + CommunicationError, + #[serde(rename = "60003")] + Timeout, + #[serde(rename = "60004")] + Processing, + #[serde(rename = "60005")] + InvalidRequest, + #[serde(rename = "60019")] + NoSearchableFilter, + #[serde(rename = "70000")] + InvalidCardNumber, + #[serde(rename = "70001")] + InvalidExpiryDate, + #[serde(rename = "70002")] + InvalidSecurityCode, + #[serde(rename = "70003")] + InvalidCardType, + #[serde(rename = "70004")] + CardExpired, + #[serde(rename = "70005")] + InsufficientFunds, + #[serde(rename = "70006")] + CardDeclined, + #[serde(rename = "70007")] + CardRestricted, + #[serde(rename = "70008")] + InvalidMerchant, + #[serde(rename = "70009")] + TransactionNotPermitted, + #[serde(rename = "70010")] + ExceedsWithdrawalLimit, + #[serde(rename = "70011")] + SecurityViolation, + #[serde(rename = "70012")] + LostOrStolenCard, + #[serde(rename = "70013")] + SuspectedFraud, + #[serde(rename = "70014")] + ContactCardIssuer, + #[serde(rename = "70015")] + InvalidAmountValue, + #[serde(untagged)] + Unknown(String), +} + +impl TrustpaymentsErrorCode { + pub fn as_str(&self) -> &str { + match self { + Self::Success => "0", + Self::InvalidCredentials => "30000", + Self::AuthenticationFailed => "30001", + Self::InvalidSiteReference => "30002", + Self::AccessDenied => "30003", + Self::InvalidUsernameOrPassword => "30004", + Self::AccountSuspended => "30005", + Self::MissingRequiredField => "50000", + Self::InvalidFieldFormat => "50001", + Self::InvalidFieldValue => "50002", + Self::FieldTooLong => "50003", + Self::FieldTooShort => "50004", + Self::InvalidCurrency => "50005", + Self::InvalidAmount => "50006", + Self::GeneralProcessingError => "60000", + Self::SystemError => "60001", + Self::CommunicationError => "60002", + Self::Timeout => "60003", + Self::Processing => "60004", + Self::InvalidRequest => "60005", + Self::NoSearchableFilter => "60019", + Self::InvalidCardNumber => "70000", + Self::InvalidExpiryDate => "70001", + Self::InvalidSecurityCode => "70002", + Self::InvalidCardType => "70003", + Self::CardExpired => "70004", + Self::InsufficientFunds => "70005", + Self::CardDeclined => "70006", + Self::CardRestricted => "70007", + Self::InvalidMerchant => "70008", + Self::TransactionNotPermitted => "70009", + Self::ExceedsWithdrawalLimit => "70010", + Self::SecurityViolation => "70011", + Self::LostOrStolenCard => "70012", + Self::SuspectedFraud => "70013", + Self::ContactCardIssuer => "70014", + Self::InvalidAmountValue => "70015", + Self::Unknown(code) => code, + } + } + + pub fn is_success(&self) -> bool { + matches!(self, Self::Success) + } + + pub fn get_attempt_status(&self) -> common_enums::AttemptStatus { + match self { + // Success cases should be handled by get_payment_status() with settlestatus logic + Self::Success => common_enums::AttemptStatus::Authorized, + // Authentication and configuration errors + Self::InvalidCredentials + | Self::AuthenticationFailed + | Self::InvalidSiteReference + | Self::AccessDenied + | Self::InvalidUsernameOrPassword + | Self::AccountSuspended => common_enums::AttemptStatus::Failure, + // Card-related and payment errors that should be treated as failures + Self::InvalidCardNumber + | Self::InvalidExpiryDate + | Self::InvalidSecurityCode + | Self::InvalidCardType + | Self::CardExpired + | Self::InsufficientFunds + | Self::CardDeclined + | Self::CardRestricted + | Self::TransactionNotPermitted + | Self::ExceedsWithdrawalLimit + | Self::InvalidAmountValue => common_enums::AttemptStatus::Failure, + // Processing states that should remain pending + Self::Processing => common_enums::AttemptStatus::Pending, + // Default fallback for unknown errors + _ => common_enums::AttemptStatus::Pending, + } + } + + pub fn get_description(&self) -> &'static str { + match self { + Self::Success => "Success", + Self::InvalidCredentials => "Invalid credentials", + Self::AuthenticationFailed => "Authentication failed", + Self::InvalidSiteReference => "Invalid site reference", + Self::AccessDenied => "Access denied", + Self::InvalidUsernameOrPassword => "Invalid username or password", + Self::AccountSuspended => "Account suspended", + Self::MissingRequiredField => "Missing required field", + Self::InvalidFieldFormat => "Invalid field format", + Self::InvalidFieldValue => "Invalid field value", + Self::FieldTooLong => "Field value too long", + Self::FieldTooShort => "Field value too short", + Self::InvalidCurrency => "Invalid currency code", + Self::InvalidAmount => "Invalid amount format", + Self::GeneralProcessingError => "General processing error", + Self::SystemError => "System error", + Self::CommunicationError => "Communication error", + Self::Timeout => "Request timeout", + Self::Processing => "Transaction processing", + Self::InvalidRequest => "Invalid request format", + Self::NoSearchableFilter => "No searchable filter specified", + Self::InvalidCardNumber => "Invalid card number", + Self::InvalidExpiryDate => "Invalid expiry date", + Self::InvalidSecurityCode => "Invalid security code", + Self::InvalidCardType => "Invalid card type", + Self::CardExpired => "Card expired", + Self::InsufficientFunds => "Insufficient funds", + Self::CardDeclined => "Card declined by issuer", + Self::CardRestricted => "Card restricted", + Self::InvalidMerchant => "Invalid merchant", + Self::TransactionNotPermitted => "Transaction not permitted", + Self::ExceedsWithdrawalLimit => "Exceeds withdrawal limit", + Self::SecurityViolation => "Security violation", + Self::LostOrStolenCard => "Lost or stolen card", + Self::SuspectedFraud => "Suspected fraud", + Self::ContactCardIssuer => "Contact card issuer", + Self::InvalidAmountValue => "Invalid amount", + Self::Unknown(_) => "Unknown error", + } + } +} + +impl std::fmt::Display for TrustpaymentsErrorCode { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + write!(f, "{}", self.as_str()) + } +} -//TODO: Fill the struct with respective fields pub struct TrustpaymentsRouterData<T> { - pub amount: StringMinorUnit, // The type of amount that a connector accepts, for example, String, i64, f64, etc. + pub amount: StringMinorUnit, pub router_data: T, } impl<T> From<(StringMinorUnit, T)> for TrustpaymentsRouterData<T> { fn from((amount, item): (StringMinorUnit, T)) -> Self { - //Todo : use utils to convert the amount to the type of amount that a connector accepts Self { amount, router_data: item, @@ -30,20 +302,28 @@ impl<T> From<(StringMinorUnit, T)> for TrustpaymentsRouterData<T> { } } -//TODO: Fill the struct with respective fields -#[derive(Default, Debug, Serialize, PartialEq)] +#[derive(Debug, Serialize, PartialEq)] pub struct TrustpaymentsPaymentsRequest { - amount: StringMinorUnit, - card: TrustpaymentsCard, + pub alias: String, + pub version: String, + pub request: Vec<TrustpaymentsPaymentRequestData>, } -#[derive(Default, Debug, Serialize, Eq, PartialEq)] -pub struct TrustpaymentsCard { - number: cards::CardNumber, - expiry_month: Secret<String>, - expiry_year: Secret<String>, - cvc: Secret<String>, - complete: bool, +#[derive(Debug, Serialize, PartialEq)] +pub struct TrustpaymentsPaymentRequestData { + pub accounttypedescription: String, + pub baseamount: StringMinorUnit, + pub billingfirstname: Option<String>, + pub billinglastname: Option<String>, + pub currencyiso3a: String, + pub expirydate: Secret<String>, + pub orderreference: String, + pub pan: cards::CardNumber, + pub requesttypedescriptions: Vec<String>, + pub securitycode: Secret<String>, + pub sitereference: String, + pub credentialsonfile: String, + pub settlestatus: String, } impl TryFrom<&TrustpaymentsRouterData<&PaymentsAuthorizeRouterData>> @@ -53,77 +333,508 @@ impl TryFrom<&TrustpaymentsRouterData<&PaymentsAuthorizeRouterData>> fn try_from( item: &TrustpaymentsRouterData<&PaymentsAuthorizeRouterData>, ) -> Result<Self, Self::Error> { + let auth = TrustpaymentsAuthType::try_from(&item.router_data.connector_auth_type)?; + + if matches!( + item.router_data.auth_type, + enums::AuthenticationType::ThreeDs + ) { + return Err(errors::ConnectorError::NotImplemented( + utils::get_unimplemented_payment_method_error_message("trustpayments"), + ) + .into()); + } + match item.router_data.request.payment_method_data.clone() { - PaymentMethodData::Card(_) => Err(errors::ConnectorError::NotImplemented( - "Card payment method not implemented".to_string(), + PaymentMethodData::Card(req_card) => { + let card = req_card.clone(); + + let request_types = match item.router_data.request.capture_method { + Some(common_enums::CaptureMethod::Automatic) | None => vec!["AUTH".to_string()], + Some(common_enums::CaptureMethod::Manual) => vec!["AUTH".to_string()], + Some(common_enums::CaptureMethod::ManualMultiple) + | Some(common_enums::CaptureMethod::Scheduled) + | Some(common_enums::CaptureMethod::SequentialAutomatic) => { + return Err(errors::ConnectorError::NotSupported { + message: "Capture method not supported by TrustPayments".to_string(), + connector: "TrustPayments", + } + .into()); + } + }; + + Ok(Self { + alias: auth.username.expose(), + version: TRUSTPAYMENTS_API_VERSION.to_string(), + request: vec![TrustpaymentsPaymentRequestData { + accounttypedescription: "ECOM".to_string(), + baseamount: item.amount.clone(), + billingfirstname: item + .router_data + .get_optional_billing_first_name() + .map(|name| name.expose()), + billinglastname: item + .router_data + .get_optional_billing_last_name() + .map(|name| name.expose()), + currencyiso3a: item.router_data.request.currency.to_string(), + expirydate: card + .get_card_expiry_month_year_2_digit_with_delimiter("/".to_string())?, + orderreference: item.router_data.connector_request_reference_id.clone(), + pan: card.card_number.clone(), + requesttypedescriptions: request_types, + securitycode: card.card_cvc.clone(), + sitereference: auth.site_reference.expose(), + credentialsonfile: + TrustpaymentsCredentialsOnFile::CardholderInitiatedTransaction + .to_string(), + settlestatus: match item.router_data.request.capture_method { + Some(common_enums::CaptureMethod::Manual) => { + TrustpaymentsSettleStatus::ManualCapture + .as_str() + .to_string() + } + Some(common_enums::CaptureMethod::Automatic) | None => { + TrustpaymentsSettleStatus::PendingSettlement + .as_str() + .to_string() + } + _ => TrustpaymentsSettleStatus::PendingSettlement + .as_str() + .to_string(), + }, + }], + }) + } + _ => Err(errors::ConnectorError::NotImplemented( + "Payment method not supported".to_string(), ) .into()), - _ => Err(errors::ConnectorError::NotImplemented("Payment method".to_string()).into()), } } } -//TODO: Fill the struct with respective fields -// Auth Struct pub struct TrustpaymentsAuthType { - pub(super) api_key: Secret<String>, + pub(super) username: Secret<String>, + pub(super) password: Secret<String>, + pub(super) site_reference: Secret<String>, +} + +impl TrustpaymentsAuthType { + pub fn get_basic_auth_header(&self) -> String { + use base64::Engine; + let credentials = format!( + "{}:{}", + self.username.clone().expose(), + self.password.clone().expose() + ); + let encoded = base64::engine::general_purpose::STANDARD.encode(credentials.as_bytes()); + format!("Basic {encoded}") + } } impl TryFrom<&ConnectorAuthType> for TrustpaymentsAuthType { 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(), + ConnectorAuthType::SignatureKey { + api_key, + key1, + api_secret, + } => Ok(Self { + username: api_key.to_owned(), + password: key1.to_owned(), + site_reference: api_secret.to_owned(), }), _ => Err(errors::ConnectorError::FailedToObtainAuthType.into()), } } } -// PaymentsResponse -//TODO: Append the remaining status flags -#[derive(Debug, Clone, Copy, Default, Serialize, Deserialize, PartialEq)] -#[serde(rename_all = "lowercase")] -pub enum TrustpaymentsPaymentStatus { - Succeeded, - Failed, - #[default] - Processing, +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +pub struct TrustpaymentsPaymentsResponse { + #[serde(alias = "response")] + pub responses: Vec<TrustpaymentsPaymentResponseData>, +} + +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +pub struct TrustpaymentsPaymentResponseData { + pub errorcode: TrustpaymentsErrorCode, + pub errormessage: String, + pub authcode: Option<String>, + pub baseamount: Option<StringMinorUnit>, + pub currencyiso3a: Option<String>, + pub transactionreference: Option<String>, + pub settlestatus: Option<TrustpaymentsSettleStatus>, + pub requesttypedescription: String, + pub securityresponsesecuritycode: Option<String>, } -impl From<TrustpaymentsPaymentStatus> for common_enums::AttemptStatus { - fn from(item: TrustpaymentsPaymentStatus) -> Self { - match item { - TrustpaymentsPaymentStatus::Succeeded => Self::Charged, - TrustpaymentsPaymentStatus::Failed => Self::Failure, - TrustpaymentsPaymentStatus::Processing => Self::Authorizing, +impl TrustpaymentsPaymentResponseData { + pub fn get_payment_status(&self) -> common_enums::AttemptStatus { + match self.errorcode { + TrustpaymentsErrorCode::Success => { + if self.authcode.is_some() { + match &self.settlestatus { + Some(TrustpaymentsSettleStatus::PendingSettlement) => { + // settlestatus "0" = automatic capture, scheduled to settle + common_enums::AttemptStatus::Charged + } + Some(TrustpaymentsSettleStatus::Settled) => { + // settlestatus "1" or "100" = transaction has been settled + common_enums::AttemptStatus::Charged + } + Some(TrustpaymentsSettleStatus::ManualCapture) => { + // settlestatus "2" = suspended, manual capture needed + common_enums::AttemptStatus::Authorized + } + Some(TrustpaymentsSettleStatus::Voided) => { + // settlestatus "3" = transaction has been cancelled + common_enums::AttemptStatus::Voided + } + None => common_enums::AttemptStatus::Authorized, + } + } else { + common_enums::AttemptStatus::Failure + } + } + _ => self.errorcode.get_attempt_status(), + } + } + + pub fn get_payment_status_for_sync(&self) -> common_enums::AttemptStatus { + match self.errorcode { + TrustpaymentsErrorCode::Success => { + if self.requesttypedescription == "TRANSACTIONQUERY" + && self.authcode.is_none() + && self.settlestatus.is_none() + && self.transactionreference.is_none() + { + common_enums::AttemptStatus::Authorized + } else if self.authcode.is_some() { + match &self.settlestatus { + Some(TrustpaymentsSettleStatus::PendingSettlement) => { + common_enums::AttemptStatus::Authorized + } + Some(TrustpaymentsSettleStatus::Settled) => { + common_enums::AttemptStatus::Charged + } + Some(TrustpaymentsSettleStatus::ManualCapture) => { + common_enums::AttemptStatus::Authorized + } + Some(TrustpaymentsSettleStatus::Voided) => { + common_enums::AttemptStatus::Voided + } + None => common_enums::AttemptStatus::Authorized, + } + } else { + common_enums::AttemptStatus::Pending + } + } + _ => self.errorcode.get_attempt_status(), + } + } + + pub fn get_error_message(&self) -> String { + if self.errorcode.is_success() { + "Success".to_string() + } else { + format!("Error {}: {}", self.errorcode, self.errormessage) + } + } + + pub fn get_error_reason(&self) -> Option<String> { + if !self.errorcode.is_success() { + Some(self.errorcode.get_description().to_string()) + } else { + None } } } -//TODO: Fill the struct with respective fields -#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] -pub struct TrustpaymentsPaymentsResponse { - status: TrustpaymentsPaymentStatus, - id: String, +impl + TryFrom< + ResponseRouterData< + hyperswitch_domain_models::router_flow_types::payments::Authorize, + TrustpaymentsPaymentsResponse, + hyperswitch_domain_models::router_request_types::PaymentsAuthorizeData, + PaymentsResponseData, + >, + > + for RouterData< + hyperswitch_domain_models::router_flow_types::payments::Authorize, + hyperswitch_domain_models::router_request_types::PaymentsAuthorizeData, + PaymentsResponseData, + > +{ + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: ResponseRouterData< + hyperswitch_domain_models::router_flow_types::payments::Authorize, + TrustpaymentsPaymentsResponse, + hyperswitch_domain_models::router_request_types::PaymentsAuthorizeData, + PaymentsResponseData, + >, + ) -> Result<Self, Self::Error> { + let response_data = item + .response + .responses + .first() + .ok_or(errors::ConnectorError::ResponseDeserializationFailed)?; + + let status = response_data.get_payment_status(); + let transaction_id = response_data + .transactionreference + .clone() + .unwrap_or_else(|| "unknown".to_string()); + + if !response_data.errorcode.is_success() { + let _error_response = TrustpaymentsErrorResponse::from(response_data.clone()); + return Ok(Self { + status, + response: Err(hyperswitch_domain_models::router_data::ErrorResponse { + code: response_data.errorcode.to_string(), + message: response_data.errormessage.clone(), + reason: response_data.get_error_reason(), + status_code: item.http_code, + attempt_status: Some(status), + connector_transaction_id: response_data.transactionreference.clone(), + network_advice_code: None, + network_decline_code: None, + network_error_message: None, + connector_metadata: None, + }), + ..item.data + }); + } + + Ok(Self { + status, + response: Ok(PaymentsResponseData::TransactionResponse { + resource_id: ResponseId::ConnectorTransactionId(transaction_id.clone()), + redirection_data: Box::new(None), + mandate_reference: Box::new(None), + connector_metadata: None, + network_txn_id: None, + connector_response_reference_id: Some(transaction_id), + incremental_authorization_allowed: None, + charges: None, + }), + ..item.data + }) + } +} + +impl + TryFrom< + ResponseRouterData< + hyperswitch_domain_models::router_flow_types::payments::PSync, + TrustpaymentsPaymentsResponse, + hyperswitch_domain_models::router_request_types::PaymentsSyncData, + PaymentsResponseData, + >, + > + for RouterData< + hyperswitch_domain_models::router_flow_types::payments::PSync, + hyperswitch_domain_models::router_request_types::PaymentsSyncData, + PaymentsResponseData, + > +{ + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: ResponseRouterData< + hyperswitch_domain_models::router_flow_types::payments::PSync, + TrustpaymentsPaymentsResponse, + hyperswitch_domain_models::router_request_types::PaymentsSyncData, + PaymentsResponseData, + >, + ) -> Result<Self, Self::Error> { + let response_data = item + .response + .responses + .first() + .ok_or(errors::ConnectorError::ResponseDeserializationFailed)?; + let status = response_data.get_payment_status_for_sync(); + let transaction_id = item + .data + .request + .connector_transaction_id + .get_connector_transaction_id() + .change_context(errors::ConnectorError::MissingConnectorTransactionID)?; + + if !response_data.errorcode.is_success() { + return Ok(Self { + status, + response: Err(hyperswitch_domain_models::router_data::ErrorResponse { + code: response_data.errorcode.to_string(), + message: response_data.errormessage.clone(), + reason: response_data.get_error_reason(), + status_code: item.http_code, + attempt_status: Some(status), + connector_transaction_id: Some(transaction_id.clone()), + network_advice_code: None, + network_decline_code: None, + network_error_message: None, + connector_metadata: None, + }), + ..item.data + }); + } + + Ok(Self { + status, + response: Ok(PaymentsResponseData::TransactionResponse { + resource_id: ResponseId::ConnectorTransactionId(transaction_id.clone()), + redirection_data: Box::new(None), + mandate_reference: Box::new(None), + connector_metadata: None, + network_txn_id: None, + connector_response_reference_id: Some(transaction_id), + incremental_authorization_allowed: None, + charges: None, + }), + ..item.data + }) + } +} + +impl + TryFrom< + ResponseRouterData< + hyperswitch_domain_models::router_flow_types::payments::Capture, + TrustpaymentsPaymentsResponse, + hyperswitch_domain_models::router_request_types::PaymentsCaptureData, + PaymentsResponseData, + >, + > + for RouterData< + hyperswitch_domain_models::router_flow_types::payments::Capture, + hyperswitch_domain_models::router_request_types::PaymentsCaptureData, + PaymentsResponseData, + > +{ + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: ResponseRouterData< + hyperswitch_domain_models::router_flow_types::payments::Capture, + TrustpaymentsPaymentsResponse, + hyperswitch_domain_models::router_request_types::PaymentsCaptureData, + PaymentsResponseData, + >, + ) -> Result<Self, Self::Error> { + let response_data = item + .response + .responses + .first() + .ok_or(errors::ConnectorError::ResponseDeserializationFailed)?; + + let transaction_id = item.data.request.connector_transaction_id.clone(); + let status = if response_data.errorcode.is_success() { + common_enums::AttemptStatus::Charged + } else { + response_data.get_payment_status() + }; + + if !response_data.errorcode.is_success() { + return Ok(Self { + status, + response: Err(hyperswitch_domain_models::router_data::ErrorResponse { + code: response_data.errorcode.to_string(), + message: response_data.errormessage.clone(), + reason: response_data.get_error_reason(), + status_code: item.http_code, + attempt_status: Some(status), + connector_transaction_id: Some(transaction_id.clone()), + network_advice_code: None, + network_decline_code: None, + network_error_message: None, + connector_metadata: None, + }), + ..item.data + }); + } + + Ok(Self { + status, + response: Ok(PaymentsResponseData::TransactionResponse { + resource_id: ResponseId::ConnectorTransactionId(transaction_id.clone()), + redirection_data: Box::new(None), + mandate_reference: Box::new(None), + connector_metadata: None, + network_txn_id: None, + connector_response_reference_id: Some(transaction_id), + incremental_authorization_allowed: None, + charges: None, + }), + ..item.data + }) + } } -impl<F, T> TryFrom<ResponseRouterData<F, TrustpaymentsPaymentsResponse, T, PaymentsResponseData>> - for RouterData<F, T, PaymentsResponseData> +impl + TryFrom< + ResponseRouterData< + hyperswitch_domain_models::router_flow_types::payments::Void, + TrustpaymentsPaymentsResponse, + hyperswitch_domain_models::router_request_types::PaymentsCancelData, + PaymentsResponseData, + >, + > + for RouterData< + hyperswitch_domain_models::router_flow_types::payments::Void, + hyperswitch_domain_models::router_request_types::PaymentsCancelData, + PaymentsResponseData, + > { type Error = error_stack::Report<errors::ConnectorError>; fn try_from( - item: ResponseRouterData<F, TrustpaymentsPaymentsResponse, T, PaymentsResponseData>, + item: ResponseRouterData< + hyperswitch_domain_models::router_flow_types::payments::Void, + TrustpaymentsPaymentsResponse, + hyperswitch_domain_models::router_request_types::PaymentsCancelData, + PaymentsResponseData, + >, ) -> Result<Self, Self::Error> { + let response_data = item + .response + .responses + .first() + .ok_or(errors::ConnectorError::ResponseDeserializationFailed)?; + + let transaction_id = item.data.request.connector_transaction_id.clone(); + let status = if response_data.errorcode.is_success() { + common_enums::AttemptStatus::Voided + } else { + response_data.get_payment_status() + }; + + if !response_data.errorcode.is_success() { + return Ok(Self { + status, + response: Err(hyperswitch_domain_models::router_data::ErrorResponse { + code: response_data.errorcode.to_string(), + message: response_data.errormessage.clone(), + reason: response_data.get_error_reason(), + status_code: item.http_code, + attempt_status: Some(status), + connector_transaction_id: Some(transaction_id.clone()), + network_advice_code: None, + network_decline_code: None, + network_error_message: None, + connector_metadata: None, + }), + ..item.data + }); + } + Ok(Self { - status: common_enums::AttemptStatus::from(item.response.status), + status, response: Ok(PaymentsResponseData::TransactionResponse { - resource_id: ResponseId::ConnectorTransactionId(item.response.id), + resource_id: ResponseId::ConnectorTransactionId(transaction_id.clone()), redirection_data: Box::new(None), mandate_reference: Box::new(None), connector_metadata: None, network_txn_id: None, - connector_response_reference_id: None, + connector_response_reference_id: Some(transaction_id), incremental_authorization_allowed: None, charges: None, }), @@ -132,12 +843,116 @@ impl<F, T> TryFrom<ResponseRouterData<F, TrustpaymentsPaymentsResponse, T, Payme } } -//TODO: Fill the struct with respective fields -// REFUND : -// Type definition for RefundRequest -#[derive(Default, Debug, Serialize)] +#[derive(Debug, Serialize, PartialEq)] +pub struct TrustpaymentsCaptureRequest { + pub alias: String, + pub version: String, + pub request: Vec<TrustpaymentsCaptureRequestData>, +} + +#[derive(Debug, Serialize, PartialEq)] +pub struct TrustpaymentsCaptureRequestData { + pub requesttypedescriptions: Vec<String>, + pub filter: TrustpaymentsFilter, + pub updates: TrustpaymentsCaptureUpdates, +} + +#[derive(Debug, Serialize, PartialEq)] +pub struct TrustpaymentsCaptureUpdates { + pub settlestatus: TrustpaymentsSettleStatus, +} + +impl TryFrom<&TrustpaymentsRouterData<&PaymentsCaptureRouterData>> for TrustpaymentsCaptureRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: &TrustpaymentsRouterData<&PaymentsCaptureRouterData>, + ) -> Result<Self, Self::Error> { + let auth = TrustpaymentsAuthType::try_from(&item.router_data.connector_auth_type)?; + + let transaction_reference = item.router_data.request.connector_transaction_id.clone(); + + Ok(Self { + alias: auth.username.expose(), + version: TRUSTPAYMENTS_API_VERSION.to_string(), + request: vec![TrustpaymentsCaptureRequestData { + requesttypedescriptions: vec!["TRANSACTIONUPDATE".to_string()], + filter: TrustpaymentsFilter { + sitereference: vec![TrustpaymentsFilterValue { + value: auth.site_reference.expose(), + }], + transactionreference: vec![TrustpaymentsFilterValue { + value: transaction_reference, + }], + }, + updates: TrustpaymentsCaptureUpdates { + settlestatus: TrustpaymentsSettleStatus::PendingSettlement, + }, + }], + }) + } +} + +#[derive(Debug, Serialize, PartialEq)] +pub struct TrustpaymentsVoidRequest { + pub alias: String, + pub version: String, + pub request: Vec<TrustpaymentsVoidRequestData>, +} + +#[derive(Debug, Serialize, PartialEq)] +pub struct TrustpaymentsVoidRequestData { + pub requesttypedescriptions: Vec<String>, + pub filter: TrustpaymentsFilter, + pub updates: TrustpaymentsVoidUpdates, +} + +#[derive(Debug, Serialize, PartialEq)] +pub struct TrustpaymentsVoidUpdates { + pub settlestatus: TrustpaymentsSettleStatus, +} + +impl TryFrom<&PaymentsCancelRouterData> for TrustpaymentsVoidRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from(item: &PaymentsCancelRouterData) -> Result<Self, Self::Error> { + let auth = TrustpaymentsAuthType::try_from(&item.connector_auth_type)?; + + let transaction_reference = item.request.connector_transaction_id.clone(); + + Ok(Self { + alias: auth.username.expose(), + version: TRUSTPAYMENTS_API_VERSION.to_string(), + request: vec![TrustpaymentsVoidRequestData { + requesttypedescriptions: vec!["TRANSACTIONUPDATE".to_string()], + filter: TrustpaymentsFilter { + sitereference: vec![TrustpaymentsFilterValue { + value: auth.site_reference.expose(), + }], + transactionreference: vec![TrustpaymentsFilterValue { + value: transaction_reference, + }], + }, + updates: TrustpaymentsVoidUpdates { + settlestatus: TrustpaymentsSettleStatus::Voided, + }, + }], + }) + } +} + +#[derive(Debug, Serialize, PartialEq)] pub struct TrustpaymentsRefundRequest { - pub amount: StringMinorUnit, + pub alias: String, + pub version: String, + pub request: Vec<TrustpaymentsRefundRequestData>, +} + +#[derive(Debug, Serialize, PartialEq)] +pub struct TrustpaymentsRefundRequestData { + pub requesttypedescriptions: Vec<String>, + pub sitereference: String, + pub parenttransactionreference: String, + pub baseamount: StringMinorUnit, + pub currencyiso3a: String, } impl<F> TryFrom<&TrustpaymentsRouterData<&RefundsRouterData<F>>> for TrustpaymentsRefundRequest { @@ -145,50 +960,132 @@ impl<F> TryFrom<&TrustpaymentsRouterData<&RefundsRouterData<F>>> for Trustpaymen fn try_from( item: &TrustpaymentsRouterData<&RefundsRouterData<F>>, ) -> Result<Self, Self::Error> { + let auth = TrustpaymentsAuthType::try_from(&item.router_data.connector_auth_type)?; + + let parent_transaction_reference = + item.router_data.request.connector_transaction_id.clone(); + Ok(Self { - amount: item.amount.to_owned(), + alias: auth.username.expose(), + version: TRUSTPAYMENTS_API_VERSION.to_string(), + request: vec![TrustpaymentsRefundRequestData { + requesttypedescriptions: vec!["REFUND".to_string()], + sitereference: auth.site_reference.expose(), + parenttransactionreference: parent_transaction_reference, + baseamount: item.amount.clone(), + currencyiso3a: item.router_data.request.currency.to_string(), + }], }) } } -// Type definition for Refund Response +#[derive(Debug, Serialize, PartialEq)] +pub struct TrustpaymentsSyncRequest { + pub alias: String, + pub version: String, + pub request: Vec<TrustpaymentsSyncRequestData>, +} -#[allow(dead_code)] -#[derive(Debug, Copy, Serialize, Default, Deserialize, Clone)] -pub enum RefundStatus { - Succeeded, - Failed, - #[default] - Processing, +#[derive(Debug, Serialize, PartialEq)] +pub struct TrustpaymentsSyncRequestData { + pub requesttypedescriptions: Vec<String>, + pub filter: TrustpaymentsFilter, } -impl From<RefundStatus> for enums::RefundStatus { - fn from(item: RefundStatus) -> Self { - match item { - RefundStatus::Succeeded => Self::Success, - RefundStatus::Failed => Self::Failure, - RefundStatus::Processing => Self::Pending, - //TODO: Review mapping - } +#[derive(Debug, Serialize, PartialEq)] +pub struct TrustpaymentsFilter { + pub sitereference: Vec<TrustpaymentsFilterValue>, + pub transactionreference: Vec<TrustpaymentsFilterValue>, +} + +#[derive(Debug, Serialize, PartialEq)] +pub struct TrustpaymentsFilterValue { + pub value: String, +} + +impl TryFrom<&PaymentsSyncRouterData> for TrustpaymentsSyncRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from(item: &PaymentsSyncRouterData) -> Result<Self, Self::Error> { + let auth = TrustpaymentsAuthType::try_from(&item.connector_auth_type)?; + + let transaction_reference = item + .request + .connector_transaction_id + .get_connector_transaction_id() + .change_context(errors::ConnectorError::MissingConnectorTransactionID)?; + + Ok(Self { + alias: auth.username.expose(), + version: TRUSTPAYMENTS_API_VERSION.to_string(), + request: vec![TrustpaymentsSyncRequestData { + requesttypedescriptions: vec!["TRANSACTIONQUERY".to_string()], + filter: TrustpaymentsFilter { + sitereference: vec![TrustpaymentsFilterValue { + value: auth.site_reference.expose(), + }], + transactionreference: vec![TrustpaymentsFilterValue { + value: transaction_reference, + }], + }, + }], + }) } } -//TODO: Fill the struct with respective fields -#[derive(Default, Debug, Clone, Serialize, Deserialize)] -pub struct RefundResponse { - id: String, - status: RefundStatus, +pub type TrustpaymentsRefundSyncRequest = TrustpaymentsSyncRequest; + +impl TryFrom<&RefundSyncRouterData> for TrustpaymentsRefundSyncRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from(item: &RefundSyncRouterData) -> Result<Self, Self::Error> { + let auth = TrustpaymentsAuthType::try_from(&item.connector_auth_type)?; + + let refund_transaction_reference = item + .request + .get_connector_refund_id() + .change_context(errors::ConnectorError::MissingConnectorRefundID)?; + + Ok(Self { + alias: auth.username.expose(), + version: TRUSTPAYMENTS_API_VERSION.to_string(), + request: vec![TrustpaymentsSyncRequestData { + requesttypedescriptions: vec!["TRANSACTIONQUERY".to_string()], + filter: TrustpaymentsFilter { + sitereference: vec![TrustpaymentsFilterValue { + value: auth.site_reference.expose(), + }], + transactionreference: vec![TrustpaymentsFilterValue { + value: refund_transaction_reference, + }], + }, + }], + }) + } } +pub type RefundResponse = TrustpaymentsPaymentsResponse; + impl TryFrom<RefundsResponseRouterData<Execute, RefundResponse>> for RefundsRouterData<Execute> { type Error = error_stack::Report<errors::ConnectorError>; fn try_from( item: RefundsResponseRouterData<Execute, RefundResponse>, ) -> Result<Self, Self::Error> { + let response_data = item + .response + .responses + .first() + .ok_or(errors::ConnectorError::ResponseDeserializationFailed)?; + + let refund_id = response_data + .transactionreference + .clone() + .unwrap_or_else(|| "unknown".to_string()); + + let refund_status = response_data.get_refund_status(); + Ok(Self { response: Ok(RefundsResponseData { - connector_refund_id: item.response.id.to_string(), - refund_status: enums::RefundStatus::from(item.response.status), + connector_refund_id: refund_id, + refund_status, }), ..item.data }) @@ -200,17 +1097,136 @@ impl TryFrom<RefundsResponseRouterData<RSync, RefundResponse>> for RefundsRouter fn try_from( item: RefundsResponseRouterData<RSync, RefundResponse>, ) -> Result<Self, Self::Error> { + let response_data = item + .response + .responses + .first() + .ok_or(errors::ConnectorError::ResponseDeserializationFailed)?; + + let refund_id = response_data + .transactionreference + .clone() + .unwrap_or_else(|| "unknown".to_string()); + + let refund_status = response_data.get_refund_status(); + Ok(Self { response: Ok(RefundsResponseData { - connector_refund_id: item.response.id.to_string(), - refund_status: enums::RefundStatus::from(item.response.status), + connector_refund_id: refund_id, + refund_status, + }), + ..item.data + }) + } +} + +#[derive(Debug, Serialize, PartialEq)] +pub struct TrustpaymentsTokenizationRequest { + pub alias: String, + pub version: String, + pub request: Vec<TrustpaymentsTokenizationRequestData>, +} + +#[derive(Debug, Serialize, PartialEq)] +pub struct TrustpaymentsTokenizationRequestData { + pub accounttypedescription: String, + pub requesttypedescriptions: Vec<String>, + pub sitereference: String, + pub pan: cards::CardNumber, + pub expirydate: Secret<String>, + pub securitycode: Secret<String>, + pub credentialsonfile: String, +} + +impl + TryFrom< + &RouterData< + hyperswitch_domain_models::router_flow_types::payments::PaymentMethodToken, + hyperswitch_domain_models::router_request_types::PaymentMethodTokenizationData, + PaymentsResponseData, + >, + > for TrustpaymentsTokenizationRequest +{ + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: &RouterData< + hyperswitch_domain_models::router_flow_types::payments::PaymentMethodToken, + hyperswitch_domain_models::router_request_types::PaymentMethodTokenizationData, + PaymentsResponseData, + >, + ) -> Result<Self, Self::Error> { + let auth = TrustpaymentsAuthType::try_from(&item.connector_auth_type)?; + + match &item.request.payment_method_data { + PaymentMethodData::Card(card_data) => Ok(Self { + alias: auth.username.expose(), + version: TRUSTPAYMENTS_API_VERSION.to_string(), + request: vec![TrustpaymentsTokenizationRequestData { + accounttypedescription: "ECOM".to_string(), + requesttypedescriptions: vec!["ACCOUNTCHECK".to_string()], + sitereference: auth.site_reference.expose(), + pan: card_data.card_number.clone(), + expirydate: card_data + .get_card_expiry_month_year_2_digit_with_delimiter("/".to_string())?, + securitycode: card_data.card_cvc.clone(), + credentialsonfile: + TrustpaymentsCredentialsOnFile::CardholderInitiatedTransaction.to_string(), + }], }), + _ => Err(errors::ConnectorError::NotImplemented( + "Payment method not supported for tokenization".to_string(), + ) + .into()), + } + } +} + +pub type TrustpaymentsTokenizationResponse = TrustpaymentsPaymentsResponse; + +impl + TryFrom< + ResponseRouterData< + hyperswitch_domain_models::router_flow_types::payments::PaymentMethodToken, + TrustpaymentsTokenizationResponse, + hyperswitch_domain_models::router_request_types::PaymentMethodTokenizationData, + PaymentsResponseData, + >, + > + for RouterData< + hyperswitch_domain_models::router_flow_types::payments::PaymentMethodToken, + hyperswitch_domain_models::router_request_types::PaymentMethodTokenizationData, + PaymentsResponseData, + > +{ + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: ResponseRouterData< + hyperswitch_domain_models::router_flow_types::payments::PaymentMethodToken, + TrustpaymentsTokenizationResponse, + hyperswitch_domain_models::router_request_types::PaymentMethodTokenizationData, + PaymentsResponseData, + >, + ) -> Result<Self, Self::Error> { + let response_data = item + .response + .responses + .first() + .ok_or(errors::ConnectorError::ResponseDeserializationFailed)?; + + let status = response_data.get_payment_status(); + let token = response_data + .transactionreference + .clone() + .unwrap_or_else(|| "unknown".to_string()); + + Ok(Self { + status, + response: Ok(PaymentsResponseData::TokenizationResponse { token }), ..item.data }) } } -//TODO: Fill the struct with respective fields #[derive(Default, Debug, Serialize, Deserialize, PartialEq)] pub struct TrustpaymentsErrorResponse { pub status_code: u16, @@ -221,3 +1237,112 @@ pub struct TrustpaymentsErrorResponse { pub network_decline_code: Option<String>, pub network_error_message: Option<String>, } + +impl TrustpaymentsErrorResponse { + pub fn get_connector_error_type(&self) -> errors::ConnectorError { + let error_code: TrustpaymentsErrorCode = + serde_json::from_str(&format!("\"{}\"", self.code)) + .unwrap_or(TrustpaymentsErrorCode::Unknown(self.code.clone())); + + match error_code { + TrustpaymentsErrorCode::InvalidCredentials + | TrustpaymentsErrorCode::AuthenticationFailed + | TrustpaymentsErrorCode::InvalidSiteReference + | TrustpaymentsErrorCode::AccessDenied + | TrustpaymentsErrorCode::InvalidUsernameOrPassword + | TrustpaymentsErrorCode::AccountSuspended => { + errors::ConnectorError::InvalidConnectorConfig { + config: "authentication", + } + } + TrustpaymentsErrorCode::InvalidCardNumber + | TrustpaymentsErrorCode::InvalidExpiryDate + | TrustpaymentsErrorCode::InvalidSecurityCode + | TrustpaymentsErrorCode::InvalidCardType + | TrustpaymentsErrorCode::CardExpired + | TrustpaymentsErrorCode::InvalidAmountValue => { + errors::ConnectorError::InvalidDataFormat { + field_name: "payment_method_data", + } + } + TrustpaymentsErrorCode::InsufficientFunds + | TrustpaymentsErrorCode::CardDeclined + | TrustpaymentsErrorCode::CardRestricted + | TrustpaymentsErrorCode::InvalidMerchant + | TrustpaymentsErrorCode::TransactionNotPermitted + | TrustpaymentsErrorCode::ExceedsWithdrawalLimit + | TrustpaymentsErrorCode::SecurityViolation + | TrustpaymentsErrorCode::LostOrStolenCard + | TrustpaymentsErrorCode::SuspectedFraud + | TrustpaymentsErrorCode::ContactCardIssuer => { + errors::ConnectorError::FailedAtConnector { + message: self.message.clone(), + code: self.code.clone(), + } + } + TrustpaymentsErrorCode::GeneralProcessingError + | TrustpaymentsErrorCode::SystemError + | TrustpaymentsErrorCode::CommunicationError + | TrustpaymentsErrorCode::Timeout + | TrustpaymentsErrorCode::InvalidRequest => { + errors::ConnectorError::ProcessingStepFailed(None) + } + TrustpaymentsErrorCode::Processing => errors::ConnectorError::ProcessingStepFailed( + Some(bytes::Bytes::from("Transaction is being processed")), + ), + TrustpaymentsErrorCode::MissingRequiredField + | TrustpaymentsErrorCode::InvalidFieldFormat + | TrustpaymentsErrorCode::InvalidFieldValue + | TrustpaymentsErrorCode::FieldTooLong + | TrustpaymentsErrorCode::FieldTooShort + | TrustpaymentsErrorCode::InvalidCurrency + | TrustpaymentsErrorCode::InvalidAmount + | TrustpaymentsErrorCode::NoSearchableFilter => { + errors::ConnectorError::MissingRequiredField { + field_name: "request_data", + } + } + TrustpaymentsErrorCode::Success => errors::ConnectorError::ProcessingStepFailed(Some( + bytes::Bytes::from("Unexpected success code in error response"), + )), + TrustpaymentsErrorCode::Unknown(_) => errors::ConnectorError::ProcessingStepFailed( + Some(bytes::Bytes::from(self.message.clone())), + ), + } + } +} + +impl From<TrustpaymentsPaymentResponseData> for TrustpaymentsErrorResponse { + fn from(response: TrustpaymentsPaymentResponseData) -> Self { + let error_reason = response.get_error_reason(); + Self { + status_code: if response.errorcode.is_success() { + 200 + } else { + 400 + }, + code: response.errorcode.to_string(), + message: response.errormessage, + reason: error_reason, + network_advice_code: None, + network_decline_code: None, + network_error_message: None, + } + } +} + +impl TrustpaymentsPaymentResponseData { + pub fn get_refund_status(&self) -> enums::RefundStatus { + match self.errorcode { + TrustpaymentsErrorCode::Success => match &self.settlestatus { + Some(TrustpaymentsSettleStatus::Settled) => enums::RefundStatus::Success, + Some(TrustpaymentsSettleStatus::PendingSettlement) => enums::RefundStatus::Pending, + Some(TrustpaymentsSettleStatus::ManualCapture) => enums::RefundStatus::Failure, + Some(TrustpaymentsSettleStatus::Voided) => enums::RefundStatus::Failure, + None => enums::RefundStatus::Success, + }, + TrustpaymentsErrorCode::Processing => enums::RefundStatus::Pending, + _ => enums::RefundStatus::Failure, + } + } +} diff --git a/crates/hyperswitch_connectors/src/default_implementations_v2.rs b/crates/hyperswitch_connectors/src/default_implementations_v2.rs index 836ad796a05..16331cd579b 100644 --- a/crates/hyperswitch_connectors/src/default_implementations_v2.rs +++ b/crates/hyperswitch_connectors/src/default_implementations_v2.rs @@ -3897,11 +3897,8 @@ macro_rules! default_imp_for_new_connector_integration_frm { #[cfg(feature = "frm")] default_imp_for_new_connector_integration_frm!( - connectors::Paysafe, - connectors::Trustpayments, connectors::Affirm, connectors::Paytm, - connectors::Vgs, connectors::Airwallex, connectors::Amazonpay, connectors::Authipay, @@ -3936,10 +3933,10 @@ default_imp_for_new_connector_integration_frm!( connectors::Flexiti, connectors::Forte, connectors::Globepay, - connectors::Hipay, connectors::Gocardless, connectors::Gpayments, connectors::Helcim, + connectors::Hipay, connectors::HyperswitchVault, connectors::Hyperwallet, connectors::Inespay, @@ -3947,17 +3944,20 @@ default_imp_for_new_connector_integration_frm!( connectors::Juspaythreedsserver, connectors::Katapult, connectors::Mpgs, - connectors::Nomupay, - connectors::Nordea, - connectors::Novalnet, + connectors::Mollie, + connectors::Multisafepay, connectors::Netcetera, connectors::Nexinets, connectors::Nexixpay, connectors::Nmi, - connectors::Payone, + connectors::Nomupay, + connectors::Nordea, + connectors::Novalnet, connectors::Paybox, connectors::Payeezy, connectors::Payload, + connectors::Payone, + connectors::Paysafe, connectors::Payu, connectors::Peachpayments, connectors::Phonepe, @@ -3965,8 +3965,6 @@ default_imp_for_new_connector_integration_frm!( connectors::Plaid, connectors::Powertranz, connectors::Prophetpay, - connectors::Mollie, - connectors::Multisafepay, connectors::Rapyd, connectors::Razorpay, connectors::Recurly, @@ -3984,11 +3982,13 @@ default_imp_for_new_connector_integration_frm!( connectors::Threedsecureio, connectors::Thunes, connectors::Tokenio, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, + connectors::Vgs, + connectors::Volt, connectors::Wise, connectors::Worldline, - connectors::Volt, connectors::Worldpay, connectors::Worldpayvantiv, connectors::Worldpayxml, @@ -4041,11 +4041,8 @@ macro_rules! default_imp_for_new_connector_integration_connector_authentication } default_imp_for_new_connector_integration_connector_authentication!( - connectors::Paysafe, - connectors::Trustpayments, connectors::Affirm, connectors::Paytm, - connectors::Vgs, connectors::Airwallex, connectors::Amazonpay, connectors::Authipay, @@ -4091,15 +4088,18 @@ default_imp_for_new_connector_integration_connector_authentication!( connectors::Juspaythreedsserver, connectors::Katapult, connectors::Mpgs, - connectors::Nomupay, - connectors::Nordea, - connectors::Novalnet, + connectors::Mollie, + connectors::Multisafepay, connectors::Netcetera, connectors::Nexinets, connectors::Nexixpay, + connectors::Nomupay, + connectors::Nordea, + connectors::Novalnet, connectors::Paybox, connectors::Payeezy, connectors::Payload, + connectors::Paysafe, connectors::Payu, connectors::Peachpayments, connectors::Phonepe, @@ -4107,13 +4107,11 @@ default_imp_for_new_connector_integration_connector_authentication!( connectors::Plaid, connectors::Powertranz, connectors::Prophetpay, - connectors::Mollie, - connectors::Multisafepay, connectors::Rapyd, connectors::Razorpay, + connectors::Recurly, connectors::Redsys, connectors::Riskified, - connectors::Recurly, connectors::Santander, connectors::Shift4, connectors::Sift, @@ -4126,11 +4124,13 @@ default_imp_for_new_connector_integration_connector_authentication!( connectors::Threedsecureio, connectors::Thunes, connectors::Tokenio, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, + connectors::Vgs, + connectors::Volt, connectors::Wise, connectors::Worldline, - connectors::Volt, connectors::Worldpay, connectors::Worldpayvantiv, connectors::Worldpayxml, @@ -4174,11 +4174,8 @@ macro_rules! default_imp_for_new_connector_integration_revenue_recovery { } default_imp_for_new_connector_integration_revenue_recovery!( - connectors::Paysafe, - connectors::Trustpayments, connectors::Affirm, connectors::Paytm, - connectors::Vgs, connectors::Airwallex, connectors::Amazonpay, connectors::Authipay, @@ -4204,8 +4201,8 @@ default_imp_for_new_connector_integration_revenue_recovery!( connectors::Digitalvirgo, connectors::Dlocal, connectors::Dwolla, - connectors::Elavon, connectors::Ebanx, + connectors::Elavon, connectors::Facilitapay, connectors::Fiserv, connectors::Fiservemea, @@ -4224,17 +4221,20 @@ default_imp_for_new_connector_integration_revenue_recovery!( connectors::Juspaythreedsserver, connectors::Katapult, connectors::Mpgs, - connectors::Nomupay, - connectors::Nordea, - connectors::Novalnet, + connectors::Mollie, + connectors::Multisafepay, connectors::Netcetera, connectors::Nexinets, connectors::Nexixpay, connectors::Nmi, - connectors::Payone, + connectors::Nomupay, + connectors::Nordea, + connectors::Novalnet, connectors::Paybox, connectors::Payeezy, connectors::Payload, + connectors::Payone, + connectors::Paysafe, connectors::Payu, connectors::Peachpayments, connectors::Phonepe, @@ -4242,8 +4242,6 @@ default_imp_for_new_connector_integration_revenue_recovery!( connectors::Plaid, connectors::Powertranz, connectors::Prophetpay, - connectors::Mollie, - connectors::Multisafepay, connectors::Rapyd, connectors::Razorpay, connectors::Redsys, @@ -4260,11 +4258,13 @@ default_imp_for_new_connector_integration_revenue_recovery!( connectors::Threedsecureio, connectors::Thunes, connectors::Tokenio, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, + connectors::Vgs, + connectors::Volt, connectors::Wise, connectors::Worldline, - connectors::Volt, connectors::Worldpay, connectors::Worldpayvantiv, connectors::Worldpayxml, diff --git a/crates/payment_methods/src/configs/payment_connector_required_fields.rs b/crates/payment_methods/src/configs/payment_connector_required_fields.rs index 32a1c175ea0..1de18b2bff0 100644 --- a/crates/payment_methods/src/configs/payment_connector_required_fields.rs +++ b/crates/payment_methods/src/configs/payment_connector_required_fields.rs @@ -1566,6 +1566,10 @@ fn get_cards_required_fields() -> HashMap<Connector, RequiredFieldFinal> { vec![], ), ), + ( + Connector::Trustpayments, + fields(vec![], vec![], card_basic()), + ), (Connector::Tsys, fields(vec![], card_basic(), vec![])), ( Connector::Wellsfargo, diff --git a/crates/router/src/core/connector_validation.rs b/crates/router/src/core/connector_validation.rs index 5ff6937754b..1c689f4eeff 100644 --- a/crates/router/src/core/connector_validation.rs +++ b/crates/router/src/core/connector_validation.rs @@ -487,6 +487,10 @@ impl ConnectorAuthTypeAndMetadataValidation<'_> { trustpay::transformers::TrustpayAuthType::try_from(self.auth_type)?; Ok(()) } + api_enums::Connector::Trustpayments => { + trustpayments::transformers::TrustpaymentsAuthType::try_from(self.auth_type)?; + Ok(()) + } api_enums::Connector::Tokenio => { tokenio::transformers::TokenioAuthType::try_from(self.auth_type)?; Ok(()) diff --git a/crates/router/src/types/api/connector_mapping.rs b/crates/router/src/types/api/connector_mapping.rs index 2333f1c8bc1..400a13407e6 100644 --- a/crates/router/src/types/api/connector_mapping.rs +++ b/crates/router/src/types/api/connector_mapping.rs @@ -440,6 +440,9 @@ impl ConnectorData { enums::Connector::Trustpay => { Ok(ConnectorEnum::Old(Box::new(connector::Trustpay::new()))) } + enums::Connector::Trustpayments => Ok(ConnectorEnum::Old(Box::new( + connector::Trustpayments::new(), + ))), enums::Connector::Tsys => Ok(ConnectorEnum::Old(Box::new(connector::Tsys::new()))), // enums::Connector::UnifiedAuthenticationService => Ok(ConnectorEnum::Old(Box::new( // connector::UnifiedAuthenticationService, diff --git a/crates/router/src/types/api/feature_matrix.rs b/crates/router/src/types/api/feature_matrix.rs index d5480ab2c26..7290acb121d 100644 --- a/crates/router/src/types/api/feature_matrix.rs +++ b/crates/router/src/types/api/feature_matrix.rs @@ -359,6 +359,9 @@ impl FeatureMatrixConnectorData { enums::Connector::Trustpay => { Ok(ConnectorEnum::Old(Box::new(connector::Trustpay::new()))) } + enums::Connector::Trustpayments => Ok(ConnectorEnum::Old(Box::new( + connector::Trustpayments::new(), + ))), enums::Connector::Tsys => Ok(ConnectorEnum::Old(Box::new(connector::Tsys::new()))), // enums::Connector::UnifiedAuthenticationService => Ok(ConnectorEnum::Old(Box::new( // connector::UnifiedAuthenticationService, diff --git a/crates/router/src/types/connector_transformers.rs b/crates/router/src/types/connector_transformers.rs index 6bcec0681d4..f931e1a0a8f 100644 --- a/crates/router/src/types/connector_transformers.rs +++ b/crates/router/src/types/connector_transformers.rs @@ -142,6 +142,7 @@ impl ForeignTryFrom<api_enums::Connector> for common_enums::RoutableConnectors { // api_enums::Connector::Thunes => Self::Thunes, api_enums::Connector::Tokenio => Self::Tokenio, api_enums::Connector::Trustpay => Self::Trustpay, + api_enums::Connector::Trustpayments => Self::Trustpayments, api_enums::Connector::Tsys => Self::Tsys, // api_enums::Connector::UnifiedAuthenticationService => { // Self::UnifiedAuthenticationService diff --git a/crates/router/tests/connectors/trustpayments.rs b/crates/router/tests/connectors/trustpayments.rs index 7d07b825aac..3fc6239f1db 100644 --- a/crates/router/tests/connectors/trustpayments.rs +++ b/crates/router/tests/connectors/trustpayments.rs @@ -1,6 +1,7 @@ -use hyperswitch_domain_models::payment_method_data::{Card, PaymentMethodData}; +use std::str::FromStr; + use masking::Secret; -use router::types::{self, api, storage::enums}; +use router::types::{self, api, domain, storage::enums}; use test_utils::connector_auth; use crate::utils::{self, ConnectorActions}; @@ -13,7 +14,7 @@ impl utils::Connector for TrustpaymentsTest { use router::connector::Trustpayments; utils::construct_connector_data_old( Box::new(Trustpayments::new()), - types::Connector::Plaid, + types::Connector::Trustpayments, api::GetToken::Connector, None, ) @@ -36,11 +37,58 @@ impl utils::Connector for TrustpaymentsTest { static CONNECTOR: TrustpaymentsTest = TrustpaymentsTest {}; fn get_default_payment_info() -> Option<utils::PaymentInfo> { - None + Some(utils::PaymentInfo { + address: Some(types::PaymentAddress::new( + None, + None, + Some(hyperswitch_domain_models::address::Address { + address: Some(hyperswitch_domain_models::address::AddressDetails { + country: Some(common_enums::CountryAlpha2::US), + city: Some("New York".to_string()), + zip: Some(Secret::new("10001".to_string())), + line1: Some(Secret::new("123 Main St".to_string())), + line2: None, + line3: None, + state: Some(Secret::new("NY".to_string())), + first_name: Some(Secret::new("John".to_string())), + last_name: Some(Secret::new("Doe".to_string())), + origin_zip: None, + }), + phone: Some(hyperswitch_domain_models::address::PhoneDetails { + number: Some(Secret::new("1234567890".to_string())), + country_code: Some("+1".to_string()), + }), + email: None, + }), + None, + )), + ..Default::default() + }) } fn payment_method_details() -> Option<types::PaymentsAuthorizeData> { - None + Some(types::PaymentsAuthorizeData { + payment_method_data: domain::PaymentMethodData::Card(domain::Card { + card_number: cards::CardNumber::from_str("4111111111111111").unwrap(), + card_exp_month: Secret::new("12".to_string()), + card_exp_year: Secret::new("2025".to_string()), + card_cvc: Secret::new("123".to_string()), + card_issuer: None, + card_network: None, + card_type: None, + card_issuing_country: None, + bank_code: None, + nick_name: None, + card_holder_name: Some(Secret::new("John Doe".to_string())), + co_badged_card_data: None, + }), + confirm: true, + amount: 100, + minor_amount: common_utils::types::MinorUnit::new(100), + currency: enums::Currency::USD, + capture_method: Some(enums::CaptureMethod::Manual), + ..utils::PaymentAuthorizeType::default().0 + }) } // Cards Positive Tests @@ -303,7 +351,7 @@ async fn should_fail_payment_for_incorrect_cvc() { let response = CONNECTOR .make_payment( Some(types::PaymentsAuthorizeData { - payment_method_data: PaymentMethodData::Card(Card { + payment_method_data: domain::PaymentMethodData::Card(domain::Card { card_cvc: Secret::new("12345".to_string()), ..utils::CCardType::default().0 }), @@ -325,7 +373,7 @@ async fn should_fail_payment_for_invalid_exp_month() { let response = CONNECTOR .make_payment( Some(types::PaymentsAuthorizeData { - payment_method_data: PaymentMethodData::Card(Card { + payment_method_data: domain::PaymentMethodData::Card(domain::Card { card_exp_month: Secret::new("20".to_string()), ..utils::CCardType::default().0 }), @@ -347,7 +395,7 @@ async fn should_fail_payment_for_incorrect_expiry_year() { let response = CONNECTOR .make_payment( Some(types::PaymentsAuthorizeData { - payment_method_data: PaymentMethodData::Card(Card { + payment_method_data: domain::PaymentMethodData::Card(domain::Card { card_exp_year: Secret::new("2000".to_string()), ..utils::CCardType::default().0 }),

2025-07-21T10:13:40Z

## Type of Change  - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  Cards Non-3DS payments added for Trustpayments ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  ## How did you test it?  Tested using cargo build and cypress test <img width="800" height="990" alt="image" src="https://github.com/user-attachments/assets/c8c11da3-737f-4518-b696-1a1a4ae07dca" /> ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [x] I added unit tests for my changes where possible

v1.117.0

f3ab3d63f69279af9254f15eba5654c0680a0747

juspay/hyperswitch

juspay__hyperswitch-8679

Bug: Propage request id to chat service Send request id to chat service in headers.

diff --git a/crates/common_utils/src/consts.rs b/crates/common_utils/src/consts.rs index 3ef0ef555e6..28508749f35 100644 --- a/crates/common_utils/src/consts.rs +++ b/crates/common_utils/src/consts.rs @@ -152,6 +152,9 @@ pub const APPLEPAY_VALIDATION_URL: &str = /// Request ID pub const X_REQUEST_ID: &str = "x-request-id"; +/// Chat Session ID +pub const X_CHAT_SESSION_ID: &str = "x-chat-session-id"; + /// Merchant ID Header pub const X_MERCHANT_ID: &str = "x-merchant-id"; diff --git a/crates/router/src/core/chat.rs b/crates/router/src/core/chat.rs index c30e27f0482..837a259bed4 100644 --- a/crates/router/src/core/chat.rs +++ b/crates/router/src/core/chat.rs @@ -11,18 +11,19 @@ use router_env::{instrument, logger, tracing}; use crate::{ db::errors::chat::ChatErrors, - routes::SessionState, + routes::{app::SessionStateInfo, SessionState}, services::{authentication as auth, ApplicationResponse}, }; -#[instrument(skip_all)] +#[instrument(skip_all, fields(?session_id))] pub async fn get_data_from_hyperswitch_ai_workflow( state: SessionState, user_from_token: auth::UserFromToken, req: chat_api::ChatRequest, + session_id: Option<&str>, ) -> CustomResult<ApplicationResponse<chat_api::ChatResponse>, ChatErrors> { let url = format!("{}/webhook", state.conf.chat.hyperswitch_ai_host); - + let request_id = state.get_request_id(); let request_body = chat_domain::HyperswitchAiDataRequest { query: chat_domain::GetDataMessage { message: req.message, @@ -33,12 +34,20 @@ pub async fn get_data_from_hyperswitch_ai_workflow( }; logger::info!("Request for AI service: {:?}", request_body); - let request = RequestBuilder::new() + let mut request_builder = RequestBuilder::new() .method(Method::Post) .url(&url) .attach_default_headers() - .set_body(RequestContent::Json(Box::new(request_body.clone()))) - .build(); + .set_body(RequestContent::Json(Box::new(request_body.clone()))); + + if let Some(request_id) = request_id { + request_builder = request_builder.header(consts::X_REQUEST_ID, &request_id); + } + if let Some(session_id) = session_id { + request_builder = request_builder.header(consts::X_CHAT_SESSION_ID, session_id); + } + + let request = request_builder.build(); let response = http_client::send_request( &state.conf.proxy, diff --git a/crates/router/src/routes/chat.rs b/crates/router/src/routes/chat.rs index 555bf007d23..e3970cc6a4c 100644 --- a/crates/router/src/routes/chat.rs +++ b/crates/router/src/routes/chat.rs @@ -6,6 +6,7 @@ use router_env::{instrument, tracing, Flow}; use super::AppState; use crate::{ core::{api_locking, chat as chat_core}, + routes::metrics, services::{ api, authentication::{self as auth}, @@ -20,13 +21,21 @@ pub async fn get_data_from_hyperswitch_ai_workflow( payload: web::Json<chat_api::ChatRequest>, ) -> HttpResponse { let flow = Flow::GetDataFromHyperswitchAiFlow; + let session_id = http_req + .headers() + .get(common_utils::consts::X_CHAT_SESSION_ID) + .and_then(|header_value| header_value.to_str().ok()); Box::pin(api::server_wrap( flow.clone(), state, &http_req, payload.into_inner(), |state, user: auth::UserFromToken, payload, _| { - chat_core::get_data_from_hyperswitch_ai_workflow(state, user, payload) + metrics::CHAT_REQUEST_COUNT.add( + 1, + router_env::metric_attributes!(("merchant_id", user.merchant_id.clone())), + ); + chat_core::get_data_from_hyperswitch_ai_workflow(state, user, payload, session_id) }, // At present, the AI service retrieves data scoped to the merchant level &auth::JWTAuth { diff --git a/crates/router/src/routes/metrics.rs b/crates/router/src/routes/metrics.rs index e8aeef3e406..defb73fa138 100644 --- a/crates/router/src/routes/metrics.rs +++ b/crates/router/src/routes/metrics.rs @@ -140,3 +140,6 @@ histogram_metric_f64!(CHECK_NETWORK_TOKEN_STATUS_TIME, GLOBAL_METER); // A counter to indicate allowed payment method types mismatch counter_metric!(PAYMENT_METHOD_TYPES_MISCONFIGURATION_METRIC, GLOBAL_METER); + +// AI chat metric to track number of chat request +counter_metric!(CHAT_REQUEST_COUNT, GLOBAL_METER);

2025-07-17T12:23:04Z

## Type of Change  - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description Propagation request-id to chat service for consistency. Propagate chat session id as well in request Add count metric for chat api ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context Closes #8679 ## How did you test it? Tested locally, x-request-id is getting populated correctly ``` curl --location 'http://localhost:8080/chat/ai/data' \ --header 'x-feature: integ-custom' \ --header 'x-chat-session-id: chat-ssdfasdsf' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer JWT' \ --data '{ "message": "success rate" }' ``` <img width="1316" height="855" alt="image" src="https://github.com/user-attachments/assets/4b99e80c-5906-472d-a017-d9c5c8257d7a" /> AI service logs <img width="1110" height="398" alt="image" src="https://github.com/user-attachments/assets/427f41be-ee48-4e94-b5b8-d6141b6f6400" /> <img width="1092" height="249" alt="image" src="https://github.com/user-attachments/assets/da479ff3-65db-4cec-8af7-a947ab807954" /> ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

260df2836cea8f9aa7448888d3b61e942eda313b

juspay/hyperswitch

juspay__hyperswitch-8687

Bug: [BUG] refused payment responses missing error codes and messages for Access Worldpay ### Bug Description Worldpay refused payment responses are not populating error codes and error messages due to incorrect deserialization. The `WorldpayPaymentResponseFields` enum incorrectly deserializes refused responses as `AuthorizedResponse` instead of `RefusedResponse`, causing `refusalCode` and `refusalDescription` fields to be silently ignored. ### Expected Behavior Refused payment responses should deserialize as `RefusedResponse` and populate error details in the final response. ### Actual Behavior Refused payment responses deserialize as `AuthorizedResponse`, causing error codes and messages to be missing from the client response. ### Steps To Reproduce 1. Process a Worldpay payment that will be refused (e.g., insufficient funds) 2. Check the deserialized response structure in logs 3. Observe that it matches `AuthorizedResponse` instead of `RefusedResponse` 4. Note that `refusalDescription` and `refusalCode` are missing from the final response ### Context For The Bug **Root Cause:** Enum variant ordering in `WorldpayPaymentResponseFields` causes `#[serde(untagged)]` to match `AuthorizedResponse` first since both response types share common fields. **Sample Worldpay Response:** ```json { "outcome": "refused", "refusalDescription": "Insufficient funds", "refusalCode": "51", "paymentInstrument": {...}, "riskFactors": [...] } ``` **Current Enum Order:** ```rust pub enum WorldpayPaymentResponseFields { AuthorizedResponse(Box<AuthorizedResponse>), // Matches first DDCResponse(DDCResponse), FraudHighRisk(FraudHighRiskResponse), RefusedResponse(RefusedResponse), // Never reached ThreeDsChallenged(ThreeDsChallengedResponse), } ``` **Fix:** Reorder enum variants to put `RefusedResponse` first and add `#[serde(deny_unknown_fields)]` to `AuthorizedResponse`. ### Environment Are you using hyperswitch hosted version? Yes ### Have you spent some time checking if this bug has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? Yes, I am willing to submit a PR!

diff --git a/crates/hyperswitch_connectors/src/connectors/worldpay/response.rs b/crates/hyperswitch_connectors/src/connectors/worldpay/response.rs index e7fa40c7114..b1a3a86a04f 100644 --- a/crates/hyperswitch_connectors/src/connectors/worldpay/response.rs +++ b/crates/hyperswitch_connectors/src/connectors/worldpay/response.rs @@ -18,11 +18,11 @@ pub struct WorldpayPaymentsResponse { #[derive(Clone, Debug, PartialEq, Serialize, Deserialize)] #[serde(untagged)] pub enum WorldpayPaymentResponseFields { - AuthorizedResponse(Box<AuthorizedResponse>), - DDCResponse(DDCResponse), - FraudHighRisk(FraudHighRiskResponse), RefusedResponse(RefusedResponse), + DDCResponse(DDCResponse), ThreeDsChallenged(ThreeDsChallengedResponse), + FraudHighRisk(FraudHighRiskResponse), + AuthorizedResponse(Box<AuthorizedResponse>), } #[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]

2025-07-18T09:30:09Z

## Type of Change  - [x] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  Fixes Worldpay refused payment responses not populating error codes and messages. **Changes in this PR** - Reorder `WorldpayPaymentResponseFields` enum variants to prioritize `RefusedResponse` over `AuthorizedResponse` ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables ## Motivation and Context  Fixes enum deserialization issue where refused responses were incorrectly matched as `AuthorizedResponse` due to variant ordering, causing `refusalCode` and `refusalDescription` fields to be silently ignored. ## How did you test it?  Things to be verified - Failed transactions - Successfull transactions - Across 3DS and Non3DS payments Acceptance criteria - Failed transactions should ALWAYS have error code and error message - Existing behavior should not be impacted <details> <summary>1. Create a refused 3DS payment</summary> cURL curl --location --request POST 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_OcigA2cQZxBX9COYGBfHgAWOZUukSoY32EnWQfuFtRPpW5lmWhJSsxtQxmvFOr3K' \ --data-raw '{"amount":4500,"currency":"EUR","confirm":true,"profile_id":"pro_lIwQy04ZJdIxAZHNj6cf","capture_method":"automatic","authentication_type":"three_ds","setup_future_usage":"off_session","customer_id":"cus_HMf1El4VyvUOTQcyPabO","email":"[email protected]","return_url":"https://google.com","payment_method":"card","payment_method_data":{"card":{"card_number":"4000000000002503","card_exp_month":"12","card_exp_year":"49","card_holder_name":"SOFT_DECLINED","card_cvc":"123"}},"billing":{"address":{"line1":"1467","line2":"Harrison Street","line3":"Harrison Street","city":"San Fransico","zip":"94122","country":"SG","first_name":"joseph","last_name":"Doe"},"phone":{"number":"8056594427","country_code":"+91"},"email":"[email protected]"},"metadata":{"udf1":"value1","new_customer":"true","login_date":"2019-09-10T10:11:12Z"},"browser_info":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36","accept_header":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8","language":"en-US","color_depth":32,"screen_height":1117,"screen_width":1728,"time_zone":-330,"java_enabled":true,"java_script_enabled":true,"ip_address":"127.0.0.1"},"customer_acceptance":{"acceptance_type":"online","accepted_at":"1963-05-03T04:07:52.723Z","online":{"ip_address":"127.0.0.1","user_agent":"amet irure esse"}},"session_expiry":60}' Response {"payment_id":"pay_nf1wozrQrzByP9V4yeoD","merchant_id":"merchant_1752829595","status":"requires_customer_action","amount":4500,"net_amount":4500,"shipping_cost":null,"amount_capturable":4500,"amount_received":null,"connector":"worldpay","client_secret":"pay_nf1wozrQrzByP9V4yeoD_secret_oPWhpyOQDgJxMryKsRGw","created":"2025-07-18T09:23:30.740Z","currency":"EUR","customer_id":"cus_HMf1El4VyvUOTQcyPabO","customer":{"id":"cus_HMf1El4VyvUOTQcyPabO","name":"John Nether","email":"[email protected]","phone":"6168205362","phone_country_code":"+1"},"description":null,"refunds":null,"disputes":null,"mandate_id":null,"mandate_data":null,"setup_future_usage":"on_session","off_session":null,"capture_on":null,"capture_method":"automatic","payment_method":"card","payment_method_data":{"card":{"last4":"2503","card_type":null,"card_network":null,"card_issuer":null,"card_issuing_country":null,"card_isin":"400000","card_extended_bin":null,"card_exp_month":"12","card_exp_year":"49","card_holder_name":"SOFT_DECLINED","payment_checks":null,"authentication_data":null},"billing":null},"payment_token":null,"shipping":null,"billing":{"address":{"city":"San Fransico","country":"SG","line1":"1467","line2":"Harrison Street","line3":"Harrison Street","zip":"94122","state":null,"first_name":"joseph","last_name":"Doe"},"phone":{"number":"8056594427","country_code":"+91"},"email":"[email protected]"},"order_details":null,"email":"[email protected]","name":"John Nether","phone":"6168205362","return_url":"https://google.com/","authentication_type":"three_ds","statement_descriptor_name":null,"statement_descriptor_suffix":null,"next_action":{"type":"redirect_to_url","redirect_to_url":"http://localhost:8080/payments/redirect/pay_nf1wozrQrzByP9V4yeoD/merchant_1752829595/pay_nf1wozrQrzByP9V4yeoD_1"},"cancellation_reason":null,"error_code":null,"error_message":null,"unified_code":null,"unified_message":null,"payment_experience":null,"payment_method_type":null,"connector_label":null,"business_country":null,"business_label":"default","business_sub_label":null,"allowed_payment_method_types":null,"ephemeral_key":{"customer_id":"cus_HMf1El4VyvUOTQcyPabO","created_at":1752830610,"expires":1752834210,"secret":"epk_94ed61cae43c47cfa3812753e04b645a"},"manual_retry_allowed":null,"connector_transaction_id":"eyJrIjoxLCJkIjoiNWwwQkpkeFd4UXA2dUw0b2dHRWlaVzlUUzh0aEhIL0F2WVFJN2ROYnZWNGl3V1R3UXYwb0tLYTdJQm1hY3hQdiJ9_2","frm_message":null,"metadata":{"udf1":"value1","login_date":"2019-09-10T10:11:12Z","new_customer":"true"},"connector_metadata":null,"feature_metadata":null,"reference_id":"06ecb837-d1ff-4baa-b608-18d2e56074f0","payment_link":null,"profile_id":"pro_lIwQy04ZJdIxAZHNj6cf","surcharge_details":null,"attempt_count":1,"merchant_decision":null,"merchant_connector_id":"mca_21oWs6dvHalGcN2EkEzx","incremental_authorization_allowed":null,"authorization_count":null,"incremental_authorizations":null,"external_authentication_details":null,"external_3ds_authentication_attempted":false,"expires_on":"2025-07-18T09:24:30.740Z","fingerprint":null,"browser_info":{"language":"en-US","time_zone":-330,"ip_address":"127.0.0.1","user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36","color_depth":32,"java_enabled":true,"screen_width":1728,"accept_header":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8","screen_height":1117,"java_script_enabled":true},"payment_method_id":null,"payment_method_status":null,"updated":"2025-07-18T09:23:32.148Z","split_payments":null,"frm_metadata":null,"extended_authorization_applied":null,"capture_before":null,"merchant_order_reference_id":null,"order_tax_amount":null,"connector_mandate_id":null,"card_discovery":"manual","force_3ds_challenge":false,"force_3ds_challenge_trigger":false,"issuer_error_code":null,"issuer_error_message":null,"is_iframe_redirection_enabled":null,"whole_connector_response":null} Open and complete the payment Fetch payment cURL curl --location --request GET 'http://localhost:8080/payments/pay_nf1wozrQrzByP9V4yeoD?force_sync=true' \ --header 'Accept: application/json' \ --header 'api-key: dev_OcigA2cQZxBX9COYGBfHgAWOZUukSoY32EnWQfuFtRPpW5lmWhJSsxtQxmvFOr3K' Response {"payment_id":"pay_nf1wozrQrzByP9V4yeoD","merchant_id":"merchant_1752829595","status":"failed","amount":4500,"net_amount":4500,"shipping_cost":null,"amount_capturable":0,"amount_received":null,"connector":"worldpay","client_secret":"pay_nf1wozrQrzByP9V4yeoD_secret_oPWhpyOQDgJxMryKsRGw","created":"2025-07-18T09:23:30.740Z","currency":"EUR","customer_id":"cus_HMf1El4VyvUOTQcyPabO","customer":{"id":"cus_HMf1El4VyvUOTQcyPabO","name":"John Nether","email":"[email protected]","phone":"6168205362","phone_country_code":"+1"},"description":null,"refunds":null,"disputes":null,"mandate_id":null,"mandate_data":null,"setup_future_usage":"on_session","off_session":null,"capture_on":null,"capture_method":"automatic","payment_method":"card","payment_method_data":{"card":{"last4":"2503","card_type":null,"card_network":null,"card_issuer":null,"card_issuing_country":null,"card_isin":"400000","card_extended_bin":null,"card_exp_month":"12","card_exp_year":"49","card_holder_name":"SOFT_DECLINED","payment_checks":null,"authentication_data":null},"billing":null},"payment_token":null,"shipping":null,"billing":{"address":{"city":"San Fransico","country":"SG","line1":"1467","line2":"Harrison Street","line3":"Harrison Street","zip":"94122","state":null,"first_name":"joseph","last_name":"Doe"},"phone":{"number":"8056594427","country_code":"+91"},"email":"[email protected]"},"order_details":null,"email":"[email protected]","name":"John Nether","phone":"6168205362","return_url":"https://google.com/","authentication_type":"three_ds","statement_descriptor_name":null,"statement_descriptor_suffix":null,"next_action":null,"cancellation_reason":null,"error_code":"65","error_message":"Authentication requested","unified_code":"UE_9000","unified_message":"Something went wrong","payment_experience":null,"payment_method_type":null,"connector_label":null,"business_country":null,"business_label":"default","business_sub_label":null,"allowed_payment_method_types":null,"ephemeral_key":null,"manual_retry_allowed":true,"connector_transaction_id":"5d0040f1-bb19-4ac5-8baa-9f083ce53cb0","frm_message":null,"metadata":{"udf1":"value1","login_date":"2019-09-10T10:11:12Z","new_customer":"true"},"connector_metadata":null,"feature_metadata":null,"reference_id":"62043e75-b414-4d8e-aa4d-5970a990152b","payment_link":null,"profile_id":"pro_lIwQy04ZJdIxAZHNj6cf","surcharge_details":null,"attempt_count":1,"merchant_decision":null,"merchant_connector_id":"mca_21oWs6dvHalGcN2EkEzx","incremental_authorization_allowed":false,"authorization_count":null,"incremental_authorizations":null,"external_authentication_details":null,"external_3ds_authentication_attempted":false,"expires_on":"2025-07-18T09:24:30.740Z","fingerprint":null,"browser_info":{"language":"en-US","time_zone":-330,"ip_address":"127.0.0.1","user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36","color_depth":32,"java_enabled":true,"screen_width":1728,"accept_header":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8","screen_height":1117,"java_script_enabled":true},"payment_method_id":"pm_us4PtNRsIDqN5ABOVj7J","payment_method_status":"inactive","updated":"2025-07-18T09:24:31.424Z","split_payments":null,"frm_metadata":null,"extended_authorization_applied":null,"capture_before":null,"merchant_order_reference_id":null,"order_tax_amount":null,"connector_mandate_id":null,"card_discovery":"manual","force_3ds_challenge":false,"force_3ds_challenge_trigger":false,"issuer_error_code":"65","issuer_error_message":"Authentication requested","is_iframe_redirection_enabled":null,"whole_connector_response":null} </details> <details> <summary>2. Create a refused Non3DS payment</summary> cURL curl --location --request POST 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_OcigA2cQZxBX9COYGBfHgAWOZUukSoY32EnWQfuFtRPpW5lmWhJSsxtQxmvFOr3K' \ --data-raw '{"amount":4500,"currency":"EUR","confirm":true,"profile_id":"pro_lIwQy04ZJdIxAZHNj6cf","capture_method":"automatic","authentication_type":"no_three_ds","setup_future_usage":"off_session","customer_id":"cus_HMf1El4VyvUOTQcyPabO","email":"[email protected]","return_url":"https://google.com","payment_method":"card","payment_method_data":{"card":{"card_number":"4000000000002503","card_exp_month":"12","card_exp_year":"49","card_holder_name":"SOFT_DECLINED","card_cvc":"123"}},"billing":{"address":{"line1":"1467","line2":"Harrison Street","line3":"Harrison Street","city":"San Fransico","zip":"94122","country":"SG","first_name":"joseph","last_name":"Doe"},"phone":{"number":"8056594427","country_code":"+91"},"email":"[email protected]"},"metadata":{"udf1":"value1","new_customer":"true","login_date":"2019-09-10T10:11:12Z"},"browser_info":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36","accept_header":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8","language":"en-US","color_depth":32,"screen_height":1117,"screen_width":1728,"time_zone":-330,"java_enabled":true,"java_script_enabled":true,"ip_address":"127.0.0.1"},"customer_acceptance":{"acceptance_type":"online","accepted_at":"1963-05-03T04:07:52.723Z","online":{"ip_address":"127.0.0.1","user_agent":"amet irure esse"}},"session_expiry":60}' Response {"payment_id":"pay_7xBftAitD04sY2GZJ8Z2","merchant_id":"merchant_1752829595","status":"failed","amount":4500,"net_amount":4500,"shipping_cost":null,"amount_capturable":0,"amount_received":null,"connector":"worldpay","client_secret":"pay_7xBftAitD04sY2GZJ8Z2_secret_hKtavE5ciTrVajUHJjZc","created":"2025-07-18T09:25:11.617Z","currency":"EUR","customer_id":"cus_HMf1El4VyvUOTQcyPabO","customer":{"id":"cus_HMf1El4VyvUOTQcyPabO","name":"John Nether","email":"[email protected]","phone":"6168205362","phone_country_code":"+1"},"description":null,"refunds":null,"disputes":null,"mandate_id":null,"mandate_data":null,"setup_future_usage":"off_session","off_session":null,"capture_on":null,"capture_method":"automatic","payment_method":"card","payment_method_data":{"card":{"last4":"2503","card_type":null,"card_network":null,"card_issuer":null,"card_issuing_country":null,"card_isin":"400000","card_extended_bin":null,"card_exp_month":"12","card_exp_year":"49","card_holder_name":"SOFT_DECLINED","payment_checks":null,"authentication_data":null},"billing":null},"payment_token":null,"shipping":null,"billing":{"address":{"city":"San Fransico","country":"SG","line1":"1467","line2":"Harrison Street","line3":"Harrison Street","zip":"94122","state":null,"first_name":"joseph","last_name":"Doe"},"phone":{"number":"8056594427","country_code":"+91"},"email":"[email protected]"},"order_details":null,"email":"[email protected]","name":"John Nether","phone":"6168205362","return_url":"https://google.com/","authentication_type":"no_three_ds","statement_descriptor_name":null,"statement_descriptor_suffix":null,"next_action":null,"cancellation_reason":null,"error_code":"65","error_message":"Authentication requested","unified_code":"UE_9000","unified_message":"Something went wrong","payment_experience":null,"payment_method_type":null,"connector_label":null,"business_country":null,"business_label":"default","business_sub_label":null,"allowed_payment_method_types":null,"ephemeral_key":{"customer_id":"cus_HMf1El4VyvUOTQcyPabO","created_at":1752830711,"expires":1752834311,"secret":"epk_89925864b5a44ace803a9c3bfd9d3a5a"},"manual_retry_allowed":true,"connector_transaction_id":"6ec4e6b4-b2cc-4816-b8de-d682c3799560","frm_message":null,"metadata":{"udf1":"value1","login_date":"2019-09-10T10:11:12Z","new_customer":"true"},"connector_metadata":null,"feature_metadata":null,"reference_id":null,"payment_link":null,"profile_id":"pro_lIwQy04ZJdIxAZHNj6cf","surcharge_details":null,"attempt_count":1,"merchant_decision":null,"merchant_connector_id":"mca_21oWs6dvHalGcN2EkEzx","incremental_authorization_allowed":false,"authorization_count":null,"incremental_authorizations":null,"external_authentication_details":null,"external_3ds_authentication_attempted":false,"expires_on":"2025-07-18T09:26:11.617Z","fingerprint":null,"browser_info":{"language":"en-US","time_zone":-330,"ip_address":"127.0.0.1","user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36","color_depth":32,"java_enabled":true,"screen_width":1728,"accept_header":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8","screen_height":1117,"java_script_enabled":true},"payment_method_id":null,"payment_method_status":null,"updated":"2025-07-18T09:25:12.302Z","split_payments":null,"frm_metadata":null,"extended_authorization_applied":null,"capture_before":null,"merchant_order_reference_id":null,"order_tax_amount":null,"connector_mandate_id":null,"card_discovery":"manual","force_3ds_challenge":false,"force_3ds_challenge_trigger":false,"issuer_error_code":"65","issuer_error_message":"Authentication requested","is_iframe_redirection_enabled":null,"whole_connector_response":null} </details> <details> <summary>3. Create a successful Non3DS payment</summary> cURL curl --location --request POST 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_OcigA2cQZxBX9COYGBfHgAWOZUukSoY32EnWQfuFtRPpW5lmWhJSsxtQxmvFOr3K' \ --data-raw '{"amount":4500,"currency":"EUR","confirm":true,"profile_id":"pro_lIwQy04ZJdIxAZHNj6cf","capture_method":"automatic","authentication_type":"no_three_ds","setup_future_usage":"off_session","customer_id":"cus_HMf1El4VyvUOTQcyPabO","email":"[email protected]","return_url":"https://google.com","payment_method":"card","payment_method_data":{"card":{"card_number":"4000000000002503","card_exp_month":"12","card_exp_year":"49","card_cvc":"123"}},"billing":{"address":{"line1":"1467","line2":"Harrison Street","line3":"Harrison Street","city":"San Fransico","zip":"94122","country":"SG","first_name":"joseph","last_name":"Doe"},"phone":{"number":"8056594427","country_code":"+91"},"email":"[email protected]"},"metadata":{"udf1":"value1","new_customer":"true","login_date":"2019-09-10T10:11:12Z"},"browser_info":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36","accept_header":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8","language":"en-US","color_depth":32,"screen_height":1117,"screen_width":1728,"time_zone":-330,"java_enabled":true,"java_script_enabled":true,"ip_address":"127.0.0.1"},"customer_acceptance":{"acceptance_type":"online","accepted_at":"1963-05-03T04:07:52.723Z","online":{"ip_address":"127.0.0.1","user_agent":"amet irure esse"}},"session_expiry":60}' Response {"payment_id":"pay_fvSgG7vbmiancVdM7egW","merchant_id":"merchant_1752829595","status":"succeeded","amount":4500,"net_amount":4500,"shipping_cost":null,"amount_capturable":0,"amount_received":4500,"connector":"worldpay","client_secret":"pay_fvSgG7vbmiancVdM7egW_secret_Tf1f2y1DQin8y7nQHp7y","created":"2025-07-18T09:27:05.084Z","currency":"EUR","customer_id":"cus_HMf1El4VyvUOTQcyPabO","customer":{"id":"cus_HMf1El4VyvUOTQcyPabO","name":"John Nether","email":"[email protected]","phone":"6168205362","phone_country_code":"+1"},"description":null,"refunds":null,"disputes":null,"mandate_id":null,"mandate_data":null,"setup_future_usage":"on_session","off_session":null,"capture_on":null,"capture_method":"automatic","payment_method":"card","payment_method_data":{"card":{"last4":"2503","card_type":null,"card_network":null,"card_issuer":null,"card_issuing_country":null,"card_isin":"400000","card_extended_bin":null,"card_exp_month":"12","card_exp_year":"49","card_holder_name":null,"payment_checks":null,"authentication_data":null},"billing":null},"payment_token":null,"shipping":null,"billing":{"address":{"city":"San Fransico","country":"SG","line1":"1467","line2":"Harrison Street","line3":"Harrison Street","zip":"94122","state":null,"first_name":"joseph","last_name":"Doe"},"phone":{"number":"8056594427","country_code":"+91"},"email":"[email protected]"},"order_details":null,"email":"[email protected]","name":"John Nether","phone":"6168205362","return_url":"https://google.com/","authentication_type":"no_three_ds","statement_descriptor_name":null,"statement_descriptor_suffix":null,"next_action":null,"cancellation_reason":null,"error_code":null,"error_message":null,"unified_code":null,"unified_message":null,"payment_experience":null,"payment_method_type":null,"connector_label":null,"business_country":null,"business_label":"default","business_sub_label":null,"allowed_payment_method_types":null,"ephemeral_key":{"customer_id":"cus_HMf1El4VyvUOTQcyPabO","created_at":1752830825,"expires":1752834425,"secret":"epk_cb4c1f4042ab432fa0cc74d74ad1bf7f"},"manual_retry_allowed":false,"connector_transaction_id":"eyJrIjoiazNhYjYzMiIsImxpbmtWZXJzaW9uIjoiNi4wLjAifQ==.sN:g8wd64bwkbrp0md+bPxcanBnk2zLdsIqSa1pR99HBj426bdlJXCgTskLhNY5Ml0rXtEPNSyl2cbsnj4b2DZwiqL3HuQDxN:neVn+zbpclW4Z+fnZKMutoUGX3m1:mly6gHHs10vDfRKiqHMymO64+yqY47+sAF1kkNrL23Bs3QiAabaRzXyjYDjJ+U38V81VQ0:KjdVX14V+Q12mM8Z5iKyQs9iW3YxEeAqFJXOYrW66yFNGsWi87tzkRENLR8ix3NBfHPU2KlzlyTrmR0mwasA4zRNlfY:bG7Aaa:GaUgn8jvCNhmdUlN6uDEfAu3+Gpx8cadeYO0VLI6Wl9IlMW1jd8Xy+vVmj3Q+75eENcq03E2danxlr+Vv+81CEF","frm_message":null,"metadata":{"udf1":"value1","login_date":"2019-09-10T10:11:12Z","new_customer":"true"},"connector_metadata":null,"feature_metadata":null,"reference_id":"0d52ed33-52a5-4180-a8c0-a594dfce4250","payment_link":null,"profile_id":"pro_lIwQy04ZJdIxAZHNj6cf","surcharge_details":null,"attempt_count":1,"merchant_decision":null,"merchant_connector_id":"mca_21oWs6dvHalGcN2EkEzx","incremental_authorization_allowed":null,"authorization_count":null,"incremental_authorizations":null,"external_authentication_details":null,"external_3ds_authentication_attempted":false,"expires_on":"2025-07-18T09:28:05.084Z","fingerprint":null,"browser_info":{"language":"en-US","time_zone":-330,"ip_address":"127.0.0.1","user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36","color_depth":32,"java_enabled":true,"screen_width":1728,"accept_header":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8","screen_height":1117,"java_script_enabled":true},"payment_method_id":null,"payment_method_status":null,"updated":"2025-07-18T09:27:07.450Z","split_payments":null,"frm_metadata":null,"extended_authorization_applied":null,"capture_before":null,"merchant_order_reference_id":null,"order_tax_amount":null,"connector_mandate_id":null,"card_discovery":"manual","force_3ds_challenge":false,"force_3ds_challenge_trigger":false,"issuer_error_code":null,"issuer_error_message":null,"is_iframe_redirection_enabled":null,"whole_connector_response":null} </details> <details> <summary>4. Create a successful 3DS payment</summary> cURL curl --location --request POST 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_OcigA2cQZxBX9COYGBfHgAWOZUukSoY32EnWQfuFtRPpW5lmWhJSsxtQxmvFOr3K' \ --data-raw '{"amount":4500,"currency":"EUR","confirm":true,"profile_id":"pro_lIwQy04ZJdIxAZHNj6cf","capture_method":"automatic","authentication_type":"three_ds","setup_future_usage":"off_session","customer_id":"cus_HMf1El4VyvUOTQcyPabO","email":"[email protected]","return_url":"https://google.com","payment_method":"card","payment_method_data":{"card":{"card_number":"4000000000002503","card_exp_month":"12","card_exp_year":"49","card_cvc":"123"}},"billing":{"address":{"line1":"1467","line2":"Harrison Street","line3":"Harrison Street","city":"San Fransico","zip":"94122","country":"SG","first_name":"joseph","last_name":"Doe"},"phone":{"number":"8056594427","country_code":"+91"},"email":"[email protected]"},"metadata":{"udf1":"value1","new_customer":"true","login_date":"2019-09-10T10:11:12Z"},"browser_info":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36","accept_header":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8","language":"en-US","color_depth":32,"screen_height":1117,"screen_width":1728,"time_zone":-330,"java_enabled":true,"java_script_enabled":true,"ip_address":"127.0.0.1"},"customer_acceptance":{"acceptance_type":"online","accepted_at":"1963-05-03T04:07:52.723Z","online":{"ip_address":"127.0.0.1","user_agent":"amet irure esse"}},"session_expiry":60}' Response {"payment_id":"pay_B0btcvBLNpPhJ1s7NEGc","merchant_id":"merchant_1752829595","status":"requires_customer_action","amount":4500,"net_amount":4500,"shipping_cost":null,"amount_capturable":4500,"amount_received":null,"connector":"worldpay","client_secret":"pay_B0btcvBLNpPhJ1s7NEGc_secret_FoMuFj3e5H5vxBtXLOJ6","created":"2025-07-18T09:27:55.106Z","currency":"EUR","customer_id":"cus_HMf1El4VyvUOTQcyPabO","customer":{"id":"cus_HMf1El4VyvUOTQcyPabO","name":"John Nether","email":"[email protected]","phone":"6168205362","phone_country_code":"+1"},"description":null,"refunds":null,"disputes":null,"mandate_id":null,"mandate_data":null,"setup_future_usage":"on_session","off_session":null,"capture_on":null,"capture_method":"automatic","payment_method":"card","payment_method_data":{"card":{"last4":"2503","card_type":null,"card_network":null,"card_issuer":null,"card_issuing_country":null,"card_isin":"400000","card_extended_bin":null,"card_exp_month":"12","card_exp_year":"49","card_holder_name":null,"payment_checks":null,"authentication_data":null},"billing":null},"payment_token":null,"shipping":null,"billing":{"address":{"city":"San Fransico","country":"SG","line1":"1467","line2":"Harrison Street","line3":"Harrison Street","zip":"94122","state":null,"first_name":"joseph","last_name":"Doe"},"phone":{"number":"8056594427","country_code":"+91"},"email":"[email protected]"},"order_details":null,"email":"[email protected]","name":"John Nether","phone":"6168205362","return_url":"https://google.com/","authentication_type":"three_ds","statement_descriptor_name":null,"statement_descriptor_suffix":null,"next_action":{"type":"redirect_to_url","redirect_to_url":"http://localhost:8080/payments/redirect/pay_B0btcvBLNpPhJ1s7NEGc/merchant_1752829595/pay_B0btcvBLNpPhJ1s7NEGc_1"},"cancellation_reason":null,"error_code":null,"error_message":null,"unified_code":null,"unified_message":null,"payment_experience":null,"payment_method_type":null,"connector_label":null,"business_country":null,"business_label":"default","business_sub_label":null,"allowed_payment_method_types":null,"ephemeral_key":{"customer_id":"cus_HMf1El4VyvUOTQcyPabO","created_at":1752830875,"expires":1752834475,"secret":"epk_0ca1d0b0a4324a30b287522647a4e1e7"},"manual_retry_allowed":null,"connector_transaction_id":"eyJrIjoxLCJkIjoiMjVnYzlzNUVaWU94M1hPaFYvbXUwT21hRmZjMFNmZWQvR0pnRGxaWU5vc2l3V1R3UXYwb0tLYTdJQm1hY3hQdiJ9_2","frm_message":null,"metadata":{"udf1":"value1","login_date":"2019-09-10T10:11:12Z","new_customer":"true"},"connector_metadata":null,"feature_metadata":null,"reference_id":"187b8a5d-10e8-4711-8f61-321d497174c5","payment_link":null,"profile_id":"pro_lIwQy04ZJdIxAZHNj6cf","surcharge_details":null,"attempt_count":1,"merchant_decision":null,"merchant_connector_id":"mca_21oWs6dvHalGcN2EkEzx","incremental_authorization_allowed":null,"authorization_count":null,"incremental_authorizations":null,"external_authentication_details":null,"external_3ds_authentication_attempted":false,"expires_on":"2025-07-18T09:28:55.106Z","fingerprint":null,"browser_info":{"language":"en-US","time_zone":-330,"ip_address":"127.0.0.1","user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36","color_depth":32,"java_enabled":true,"screen_width":1728,"accept_header":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8","screen_height":1117,"java_script_enabled":true},"payment_method_id":null,"payment_method_status":null,"updated":"2025-07-18T09:27:55.619Z","split_payments":null,"frm_metadata":null,"extended_authorization_applied":null,"capture_before":null,"merchant_order_reference_id":null,"order_tax_amount":null,"connector_mandate_id":null,"card_discovery":"manual","force_3ds_challenge":false,"force_3ds_challenge_trigger":false,"issuer_error_code":null,"issuer_error_message":null,"is_iframe_redirection_enabled":null,"whole_connector_response":null} Open and complete payment Fetch payment cURL curl --location --request GET 'http://localhost:8080/payments/pay_B0btcvBLNpPhJ1s7NEGc?force_sync=true' \ --header 'Accept: application/json' \ --header 'api-key: dev_OcigA2cQZxBX9COYGBfHgAWOZUukSoY32EnWQfuFtRPpW5lmWhJSsxtQxmvFOr3K' Response {"payment_id":"pay_B0btcvBLNpPhJ1s7NEGc","merchant_id":"merchant_1752829595","status":"succeeded","amount":4500,"net_amount":4500,"shipping_cost":null,"amount_capturable":0,"amount_received":4500,"connector":"worldpay","client_secret":"pay_B0btcvBLNpPhJ1s7NEGc_secret_FoMuFj3e5H5vxBtXLOJ6","created":"2025-07-18T09:27:55.106Z","currency":"EUR","customer_id":"cus_HMf1El4VyvUOTQcyPabO","customer":{"id":"cus_HMf1El4VyvUOTQcyPabO","name":"John Nether","email":"[email protected]","phone":"6168205362","phone_country_code":"+1"},"description":null,"refunds":null,"disputes":null,"mandate_id":null,"mandate_data":null,"setup_future_usage":"on_session","off_session":null,"capture_on":null,"capture_method":"automatic","payment_method":"card","payment_method_data":{"card":{"last4":"2503","card_type":null,"card_network":null,"card_issuer":null,"card_issuing_country":null,"card_isin":"400000","card_extended_bin":null,"card_exp_month":"12","card_exp_year":"49","card_holder_name":null,"payment_checks":null,"authentication_data":null},"billing":null},"payment_token":null,"shipping":null,"billing":{"address":{"city":"San Fransico","country":"SG","line1":"1467","line2":"Harrison Street","line3":"Harrison Street","zip":"94122","state":null,"first_name":"joseph","last_name":"Doe"},"phone":{"number":"8056594427","country_code":"+91"},"email":"[email protected]"},"order_details":null,"email":"[email protected]","name":"John Nether","phone":"6168205362","return_url":"https://google.com/","authentication_type":"three_ds","statement_descriptor_name":null,"statement_descriptor_suffix":null,"next_action":null,"cancellation_reason":null,"error_code":null,"error_message":null,"unified_code":null,"unified_message":null,"payment_experience":null,"payment_method_type":null,"connector_label":null,"business_country":null,"business_label":"default","business_sub_label":null,"allowed_payment_method_types":null,"ephemeral_key":null,"manual_retry_allowed":false,"connector_transaction_id":"3749d357-0130-498e-8c74-6a8e2069fa55","frm_message":null,"metadata":{"udf1":"value1","login_date":"2019-09-10T10:11:12Z","new_customer":"true"},"connector_metadata":null,"feature_metadata":null,"reference_id":"3749d357-0130-498e-8c74-6a8e2069fa55","payment_link":null,"profile_id":"pro_lIwQy04ZJdIxAZHNj6cf","surcharge_details":null,"attempt_count":1,"merchant_decision":null,"merchant_connector_id":"mca_21oWs6dvHalGcN2EkEzx","incremental_authorization_allowed":null,"authorization_count":null,"incremental_authorizations":null,"external_authentication_details":null,"external_3ds_authentication_attempted":false,"expires_on":"2025-07-18T09:28:55.106Z","fingerprint":null,"browser_info":{"language":"en-US","time_zone":-330,"ip_address":"127.0.0.1","user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36","color_depth":32,"java_enabled":true,"screen_width":1728,"accept_header":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8","screen_height":1117,"java_script_enabled":true},"payment_method_id":"pm_fu8PQqH8zNwUxq5cyixG","payment_method_status":"active","updated":"2025-07-18T09:28:08.906Z","split_payments":null,"frm_metadata":null,"extended_authorization_applied":null,"capture_before":null,"merchant_order_reference_id":null,"order_tax_amount":null,"connector_mandate_id":null,"card_discovery":"manual","force_3ds_challenge":false,"force_3ds_challenge_trigger":false,"issuer_error_code":null,"issuer_error_message":null,"is_iframe_redirection_enabled":null,"whole_connector_response":null} </details> ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

126018e217bfbd8bdd44043ace8a815046193818

juspay/hyperswitch

juspay__hyperswitch-8682

Bug: refactor(payments): Fetch payment method details n PaymentListAttempt api Need to fetch payment method information for attempts in attempt list api

diff --git a/api-reference/v1/openapi_spec_v1.json b/api-reference/v1/openapi_spec_v1.json index de49d53ada8..36a2896008b 100644 --- a/api-reference/v1/openapi_spec_v1.json +++ b/api-reference/v1/openapi_spec_v1.json @@ -11089,6 +11089,7 @@ "checkout", "coinbase", "coingate", + "custombilling", "cryptopay", "ctp_mastercard", "ctp_visa", @@ -28183,6 +28184,7 @@ "cashtocode", "celero", "chargebee", + "custombilling", "checkout", "coinbase", "coingate", diff --git a/api-reference/v2/openapi_spec_v2.json b/api-reference/v2/openapi_spec_v2.json index 266aa6cec95..671658dc29b 100644 --- a/api-reference/v2/openapi_spec_v2.json +++ b/api-reference/v2/openapi_spec_v2.json @@ -8153,6 +8153,7 @@ "checkout", "coinbase", "coingate", + "custombilling", "cryptopay", "ctp_mastercard", "ctp_visa", @@ -15740,6 +15741,14 @@ } ], "nullable": true + }, + "payment_method_data": { + "allOf": [ + { + "$ref": "#/components/schemas/PaymentMethodDataResponseWithBilling" + } + ], + "nullable": true } } }, @@ -22738,6 +22747,7 @@ "cashtocode", "celero", "chargebee", + "custombilling", "checkout", "coinbase", "coingate", diff --git a/config/docker_compose.toml b/config/docker_compose.toml index 2e37da5728d..faf1d25e3c7 100644 --- a/config/docker_compose.toml +++ b/config/docker_compose.toml @@ -272,6 +272,7 @@ cards = [ "coingate", "cryptopay", "ctp_visa", + "custombilling", "cybersource", "datatrans", "deutschebank", diff --git a/crates/api_models/src/enums.rs b/crates/api_models/src/enums.rs index cad510b26de..ac0cd707350 100644 --- a/crates/api_models/src/enums.rs +++ b/crates/api_models/src/enums.rs @@ -166,6 +166,7 @@ pub enum BillingConnectors { Chargebee, Recurly, Stripebilling, + Custombilling, #[cfg(feature = "dummy_connector")] DummyBillingConnector, } diff --git a/crates/api_models/src/payments.rs b/crates/api_models/src/payments.rs index d1e04037527..3d91e73406c 100644 --- a/crates/api_models/src/payments.rs +++ b/crates/api_models/src/payments.rs @@ -1629,6 +1629,9 @@ pub struct PaymentAttemptResponse { /// Additional data that might be required by hyperswitch, to enable some specific features. pub feature_metadata: Option<PaymentAttemptFeatureMetadata>, + + /// The payment method information for the payment attempt + pub payment_method_data: Option<PaymentMethodDataResponseWithBilling>, } #[cfg(feature = "v2")] diff --git a/crates/common_enums/src/connector_enums.rs b/crates/common_enums/src/connector_enums.rs index 41563d56f27..cb5195925c5 100644 --- a/crates/common_enums/src/connector_enums.rs +++ b/crates/common_enums/src/connector_enums.rs @@ -77,6 +77,7 @@ pub enum RoutableConnectors { Cashtocode, Celero, Chargebee, + Custombilling, // Checkbook, Checkout, Coinbase, @@ -241,6 +242,7 @@ pub enum Connector { Checkout, Coinbase, Coingate, + Custombilling, Cryptopay, CtpMastercard, CtpVisa, @@ -428,6 +430,7 @@ impl Connector { | Self::Coinbase | Self::Coingate | Self::Cryptopay + | Self::Custombilling | Self::Deutschebank | Self::Digitalvirgo | Self::Dlocal @@ -589,6 +592,7 @@ impl From<RoutableConnectors> for Connector { RoutableConnectors::Cashtocode => Self::Cashtocode, RoutableConnectors::Celero => Self::Celero, RoutableConnectors::Chargebee => Self::Chargebee, + RoutableConnectors::Custombilling => Self::Custombilling, // RoutableConnectors::Checkbook => Self::Checkbook, RoutableConnectors::Checkout => Self::Checkout, RoutableConnectors::Coinbase => Self::Coinbase, @@ -717,6 +721,7 @@ impl TryFrom<Connector> for RoutableConnectors { Connector::Coinbase => Ok(Self::Coinbase), Connector::Coingate => Ok(Self::Coingate), Connector::Cryptopay => Ok(Self::Cryptopay), + Connector::Custombilling => Ok(Self::Custombilling), Connector::Cybersource => Ok(Self::Cybersource), Connector::Datatrans => Ok(Self::Datatrans), Connector::Deutschebank => Ok(Self::Deutschebank), diff --git a/crates/connector_configs/src/connector.rs b/crates/connector_configs/src/connector.rs index f69efb673bc..fdc85a1fbc7 100644 --- a/crates/connector_configs/src/connector.rs +++ b/crates/connector_configs/src/connector.rs @@ -194,6 +194,7 @@ pub struct ConnectorConfig { pub cashtocode: Option<ConnectorTomlConfig>, pub celero: Option<ConnectorTomlConfig>, pub chargebee: Option<ConnectorTomlConfig>, + pub custombilling: Option<ConnectorTomlConfig>, pub checkbook: Option<ConnectorTomlConfig>, pub checkout: Option<ConnectorTomlConfig>, pub coinbase: Option<ConnectorTomlConfig>, @@ -393,6 +394,7 @@ impl ConnectorConfig { Connector::Coingate => Ok(connector_data.coingate), Connector::Cryptopay => Ok(connector_data.cryptopay), Connector::CtpVisa => Ok(connector_data.ctp_visa), + Connector::Custombilling => Ok(connector_data.custombilling), Connector::Cybersource => Ok(connector_data.cybersource), #[cfg(feature = "dummy_connector")] Connector::DummyBillingConnector => Ok(connector_data.dummy_connector), diff --git a/crates/hyperswitch_connectors/src/connectors.rs b/crates/hyperswitch_connectors/src/connectors.rs index f560a84cd8d..6815f288d0c 100644 --- a/crates/hyperswitch_connectors/src/connectors.rs +++ b/crates/hyperswitch_connectors/src/connectors.rs @@ -26,6 +26,7 @@ pub mod coinbase; pub mod coingate; pub mod cryptopay; pub mod ctp_mastercard; +pub mod custombilling; pub mod cybersource; pub mod datatrans; pub mod deutschebank; @@ -124,11 +125,11 @@ pub use self::{ blackhawknetwork::Blackhawknetwork, bluesnap::Bluesnap, boku::Boku, braintree::Braintree, cashtocode::Cashtocode, celero::Celero, chargebee::Chargebee, checkbook::Checkbook, checkout::Checkout, coinbase::Coinbase, coingate::Coingate, cryptopay::Cryptopay, - ctp_mastercard::CtpMastercard, cybersource::Cybersource, datatrans::Datatrans, - deutschebank::Deutschebank, digitalvirgo::Digitalvirgo, dlocal::Dlocal, dwolla::Dwolla, - ebanx::Ebanx, elavon::Elavon, facilitapay::Facilitapay, fiserv::Fiserv, fiservemea::Fiservemea, - fiuu::Fiuu, forte::Forte, getnet::Getnet, globalpay::Globalpay, globepay::Globepay, - gocardless::Gocardless, gpayments::Gpayments, helcim::Helcim, hipay::Hipay, + ctp_mastercard::CtpMastercard, custombilling::Custombilling, cybersource::Cybersource, + datatrans::Datatrans, deutschebank::Deutschebank, digitalvirgo::Digitalvirgo, dlocal::Dlocal, + dwolla::Dwolla, ebanx::Ebanx, elavon::Elavon, facilitapay::Facilitapay, fiserv::Fiserv, + fiservemea::Fiservemea, fiuu::Fiuu, forte::Forte, getnet::Getnet, globalpay::Globalpay, + globepay::Globepay, gocardless::Gocardless, gpayments::Gpayments, helcim::Helcim, hipay::Hipay, hyperswitch_vault::HyperswitchVault, iatapay::Iatapay, inespay::Inespay, itaubank::Itaubank, jpmorgan::Jpmorgan, juspaythreedsserver::Juspaythreedsserver, klarna::Klarna, mifinity::Mifinity, mollie::Mollie, moneris::Moneris, multisafepay::Multisafepay, diff --git a/crates/hyperswitch_connectors/src/connectors/custombilling.rs b/crates/hyperswitch_connectors/src/connectors/custombilling.rs new file mode 100644 index 00000000000..85904369e50 --- /dev/null +++ b/crates/hyperswitch_connectors/src/connectors/custombilling.rs @@ -0,0 +1,579 @@ +pub mod transformers; + +use common_utils::{ + errors::CustomResult, + ext_traits::BytesExt, + request::{Method, Request, RequestBuilder, RequestContent}, + types::{AmountConvertor, StringMinorUnit, StringMinorUnitForConnector}, +}; +use error_stack::{report, ResultExt}; +use hyperswitch_domain_models::{ + router_data::{AccessToken, ConnectorAuthType, ErrorResponse, RouterData}, + router_flow_types::{ + access_token_auth::AccessTokenAuth, + payments::{Authorize, Capture, PSync, PaymentMethodToken, Session, SetupMandate, Void}, + refunds::{Execute, RSync}, + }, + router_request_types::{ + AccessTokenRequestData, PaymentMethodTokenizationData, PaymentsAuthorizeData, + PaymentsCancelData, PaymentsCaptureData, PaymentsSessionData, PaymentsSyncData, + RefundsData, SetupMandateRequestData, + }, + router_response_types::{PaymentsResponseData, RefundsResponseData}, + types::{ + PaymentsAuthorizeRouterData, PaymentsCaptureRouterData, PaymentsSyncRouterData, + RefundSyncRouterData, RefundsRouterData, + }, +}; +use hyperswitch_interfaces::{ + api::{ + self, ConnectorCommon, ConnectorCommonExt, ConnectorIntegration, ConnectorSpecifications, + ConnectorValidation, + }, + configs::Connectors, + errors, + events::connector_api_logs::ConnectorEvent, + types::{self, Response}, + webhooks, +}; +use masking::{ExposeInterface, Mask}; +use transformers as custombilling; + +use crate::{constants::headers, types::ResponseRouterData, utils}; + +#[derive(Clone)] +pub struct Custombilling { + amount_converter: &'static (dyn AmountConvertor<Output = StringMinorUnit> + Sync), +} + +impl Custombilling { + pub fn new() -> &'static Self { + &Self { + amount_converter: &StringMinorUnitForConnector, + } + } +} + +impl api::Payment for Custombilling {} +impl api::PaymentSession for Custombilling {} +impl api::ConnectorAccessToken for Custombilling {} +impl api::MandateSetup for Custombilling {} +impl api::PaymentAuthorize for Custombilling {} +impl api::PaymentSync for Custombilling {} +impl api::PaymentCapture for Custombilling {} +impl api::PaymentVoid for Custombilling {} +impl api::Refund for Custombilling {} +impl api::RefundExecute for Custombilling {} +impl api::RefundSync for Custombilling {} +impl api::PaymentToken for Custombilling {} + +impl ConnectorIntegration<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData> + for Custombilling +{ + // Not Implemented (R) +} + +impl<Flow, Request, Response> ConnectorCommonExt<Flow, Request, Response> for Custombilling +where + Self: ConnectorIntegration<Flow, Request, Response>, +{ + fn build_headers( + &self, + req: &RouterData<Flow, Request, Response>, + _connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + let mut header = vec![( + headers::CONTENT_TYPE.to_string(), + self.get_content_type().to_string().into(), + )]; + let mut api_key = self.get_auth_header(&req.connector_auth_type)?; + header.append(&mut api_key); + Ok(header) + } +} + +impl ConnectorCommon for Custombilling { + fn id(&self) -> &'static str { + "custombilling" + } + + fn get_currency_unit(&self) -> api::CurrencyUnit { + api::CurrencyUnit::Minor + // TODO! Check connector documentation, on which unit they are processing the currency. + // If the connector accepts amount in lower unit ( i.e cents for USD) then return api::CurrencyUnit::Minor, + // if connector accepts amount in base unit (i.e dollars for USD) then return api::CurrencyUnit::Base + } + + fn common_get_content_type(&self) -> &'static str { + "application/json" + } + + fn base_url<'a>(&self, _connectors: &'a Connectors) -> &'a str { + "" + } + + fn get_auth_header( + &self, + 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(), + )]) + } + + fn build_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + let response: custombilling::CustombillingErrorResponse = res + .response + .parse_struct("CustombillingErrorResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + + Ok(ErrorResponse { + status_code: res.status_code, + code: response.code, + message: response.message, + reason: response.reason, + attempt_status: None, + connector_transaction_id: None, + network_advice_code: None, + network_decline_code: None, + network_error_message: None, + }) + } +} + +impl ConnectorValidation for Custombilling { + //TODO: implement functions when support enabled +} + +impl ConnectorIntegration<Session, PaymentsSessionData, PaymentsResponseData> for Custombilling { + //TODO: implement sessions flow +} + +impl ConnectorIntegration<AccessTokenAuth, AccessTokenRequestData, AccessToken> for Custombilling {} + +impl ConnectorIntegration<SetupMandate, SetupMandateRequestData, PaymentsResponseData> + for Custombilling +{ +} + +impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData> + for Custombilling +{ + fn get_headers( + &self, + req: &PaymentsAuthorizeRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsAuthorizeRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn get_request_body( + &self, + req: &PaymentsAuthorizeRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let amount = utils::convert_amount( + self.amount_converter, + req.request.minor_amount, + req.request.currency, + )?; + + let connector_router_data = custombilling::CustombillingRouterData::from((amount, req)); + let connector_req = + custombilling::CustombillingPaymentsRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &PaymentsAuthorizeRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::PaymentsAuthorizeType::get_url( + self, req, connectors, + )?) + .attach_default_headers() + .headers(types::PaymentsAuthorizeType::get_headers( + self, req, connectors, + )?) + .set_body(types::PaymentsAuthorizeType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsAuthorizeRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsAuthorizeRouterData, errors::ConnectorError> { + let response: custombilling::CustombillingPaymentsResponse = res + .response + .parse_struct("Custombilling PaymentsAuthorizeResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<PSync, PaymentsSyncData, PaymentsResponseData> for Custombilling { + fn get_headers( + &self, + req: &PaymentsSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsSyncRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn build_request( + &self, + req: &PaymentsSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Get) + .url(&types::PaymentsSyncType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::PaymentsSyncType::get_headers(self, req, connectors)?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsSyncRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsSyncRouterData, errors::ConnectorError> { + let response: custombilling::CustombillingPaymentsResponse = res + .response + .parse_struct("custombilling PaymentsSyncResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<Capture, PaymentsCaptureData, PaymentsResponseData> for Custombilling { + fn get_headers( + &self, + req: &PaymentsCaptureRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsCaptureRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn get_request_body( + &self, + _req: &PaymentsCaptureRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_request_body method".to_string()).into()) + } + + fn build_request( + &self, + req: &PaymentsCaptureRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::PaymentsCaptureType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::PaymentsCaptureType::get_headers( + self, req, connectors, + )?) + .set_body(types::PaymentsCaptureType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsCaptureRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsCaptureRouterData, errors::ConnectorError> { + let response: custombilling::CustombillingPaymentsResponse = res + .response + .parse_struct("Custombilling PaymentsCaptureResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<Void, PaymentsCancelData, PaymentsResponseData> for Custombilling {} + +impl ConnectorIntegration<Execute, RefundsData, RefundsResponseData> for Custombilling { + fn get_headers( + &self, + req: &RefundsRouterData<Execute>, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &RefundsRouterData<Execute>, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn get_request_body( + &self, + req: &RefundsRouterData<Execute>, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let refund_amount = utils::convert_amount( + self.amount_converter, + req.request.minor_refund_amount, + req.request.currency, + )?; + + let connector_router_data = + custombilling::CustombillingRouterData::from((refund_amount, req)); + let connector_req = + custombilling::CustombillingRefundRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &RefundsRouterData<Execute>, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + let request = RequestBuilder::new() + .method(Method::Post) + .url(&types::RefundExecuteType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::RefundExecuteType::get_headers( + self, req, connectors, + )?) + .set_body(types::RefundExecuteType::get_request_body( + self, req, connectors, + )?) + .build(); + Ok(Some(request)) + } + + fn handle_response( + &self, + data: &RefundsRouterData<Execute>, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<RefundsRouterData<Execute>, errors::ConnectorError> { + let response: custombilling::RefundResponse = res + .response + .parse_struct("custombilling RefundResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<RSync, RefundsData, RefundsResponseData> for Custombilling { + fn get_headers( + &self, + req: &RefundSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &RefundSyncRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn build_request( + &self, + req: &RefundSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Get) + .url(&types::RefundSyncType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::RefundSyncType::get_headers(self, req, connectors)?) + .set_body(types::RefundSyncType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &RefundSyncRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<RefundSyncRouterData, errors::ConnectorError> { + let response: custombilling::RefundResponse = res + .response + .parse_struct("custombilling RefundSyncResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +#[async_trait::async_trait] +impl webhooks::IncomingWebhook for Custombilling { + fn get_webhook_object_reference_id( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<api_models::webhooks::ObjectReferenceId, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } + + fn get_webhook_event_type( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<api_models::webhooks::IncomingWebhookEvent, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } + + fn get_webhook_resource_object( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<Box<dyn masking::ErasedMaskSerialize>, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } +} + +impl ConnectorSpecifications for Custombilling {} diff --git a/crates/hyperswitch_connectors/src/connectors/custombilling/transformers.rs b/crates/hyperswitch_connectors/src/connectors/custombilling/transformers.rs new file mode 100644 index 00000000000..bb8e8f83e38 --- /dev/null +++ b/crates/hyperswitch_connectors/src/connectors/custombilling/transformers.rs @@ -0,0 +1,232 @@ +use common_enums::enums; +use common_utils::types::StringMinorUnit; +use hyperswitch_domain_models::{ + payment_method_data::PaymentMethodData, + router_data::{ConnectorAuthType, RouterData}, + router_flow_types::refunds::{Execute, RSync}, + router_request_types::ResponseId, + router_response_types::{PaymentsResponseData, RefundsResponseData}, + types::{PaymentsAuthorizeRouterData, RefundsRouterData}, +}; +use hyperswitch_interfaces::errors; +use masking::Secret; +use serde::{Deserialize, Serialize}; + +use crate::{ + types::{RefundsResponseRouterData, ResponseRouterData}, + utils::PaymentsAuthorizeRequestData, +}; + +//TODO: Fill the struct with respective fields +pub struct CustombillingRouterData<T> { + pub amount: StringMinorUnit, // The type of amount that a connector accepts, for example, String, i64, f64, etc. + pub router_data: T, +} + +impl<T> From<(StringMinorUnit, T)> for CustombillingRouterData<T> { + fn from((amount, item): (StringMinorUnit, T)) -> Self { + //Todo : use utils to convert the amount to the type of amount that a connector accepts + Self { + amount, + router_data: item, + } + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Serialize, PartialEq)] +pub struct CustombillingPaymentsRequest { + amount: StringMinorUnit, + card: CustombillingCard, +} + +#[derive(Default, Debug, Serialize, Eq, PartialEq)] +pub struct CustombillingCard { + number: cards::CardNumber, + expiry_month: Secret<String>, + expiry_year: Secret<String>, + cvc: Secret<String>, + complete: bool, +} + +impl TryFrom<&CustombillingRouterData<&PaymentsAuthorizeRouterData>> + for CustombillingPaymentsRequest +{ + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: &CustombillingRouterData<&PaymentsAuthorizeRouterData>, + ) -> Result<Self, Self::Error> { + match item.router_data.request.payment_method_data.clone() { + PaymentMethodData::Card(req_card) => { + let card = CustombillingCard { + number: req_card.card_number, + expiry_month: req_card.card_exp_month, + expiry_year: req_card.card_exp_year, + cvc: req_card.card_cvc, + complete: item.router_data.request.is_auto_capture()?, + }; + Ok(Self { + amount: item.amount.clone(), + card, + }) + } + _ => Err(errors::ConnectorError::NotImplemented("Payment method".to_string()).into()), + } + } +} + +//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)] +#[serde(rename_all = "lowercase")] +pub enum CustombillingPaymentStatus { + Succeeded, + Failed, + #[default] + Processing, +} + +impl From<CustombillingPaymentStatus> for common_enums::AttemptStatus { + fn from(item: CustombillingPaymentStatus) -> Self { + match item { + CustombillingPaymentStatus::Succeeded => Self::Charged, + CustombillingPaymentStatus::Failed => Self::Failure, + CustombillingPaymentStatus::Processing => Self::Authorizing, + } + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] +pub struct CustombillingPaymentsResponse { + status: CustombillingPaymentStatus, + id: String, +} + +impl<F, T> TryFrom<ResponseRouterData<F, CustombillingPaymentsResponse, T, PaymentsResponseData>> + for RouterData<F, T, PaymentsResponseData> +{ + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: ResponseRouterData<F, CustombillingPaymentsResponse, T, PaymentsResponseData>, + ) -> Result<Self, Self::Error> { + Ok(Self { + status: common_enums::AttemptStatus::from(item.response.status), + response: Ok(PaymentsResponseData::TransactionResponse { + resource_id: ResponseId::ConnectorTransactionId(item.response.id), + redirection_data: Box::new(None), + mandate_reference: Box::new(None), + connector_metadata: None, + network_txn_id: None, + connector_response_reference_id: None, + incremental_authorization_allowed: None, + charges: None, + }), + ..item.data + }) + } +} + +//TODO: Fill the struct with respective fields +// REFUND : +// Type definition for RefundRequest +#[derive(Default, Debug, Serialize)] +pub struct CustombillingRefundRequest { + pub amount: StringMinorUnit, +} + +impl<F> TryFrom<&CustombillingRouterData<&RefundsRouterData<F>>> for CustombillingRefundRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: &CustombillingRouterData<&RefundsRouterData<F>>, + ) -> Result<Self, Self::Error> { + Ok(Self { + amount: item.amount.to_owned(), + }) + } +} + +// Type definition for Refund Response + +#[allow(dead_code)] +#[derive(Debug, Serialize, Default, Deserialize, Clone)] +pub enum RefundStatus { + Succeeded, + Failed, + #[default] + Processing, +} + +impl From<RefundStatus> for enums::RefundStatus { + fn from(item: RefundStatus) -> Self { + match item { + RefundStatus::Succeeded => Self::Success, + RefundStatus::Failed => Self::Failure, + RefundStatus::Processing => Self::Pending, + //TODO: Review mapping + } + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Clone, Serialize, Deserialize)] +pub struct RefundResponse { + id: String, + status: RefundStatus, +} + +impl TryFrom<RefundsResponseRouterData<Execute, RefundResponse>> for RefundsRouterData<Execute> { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: RefundsResponseRouterData<Execute, RefundResponse>, + ) -> Result<Self, Self::Error> { + Ok(Self { + response: Ok(RefundsResponseData { + connector_refund_id: item.response.id.to_string(), + refund_status: enums::RefundStatus::from(item.response.status), + }), + ..item.data + }) + } +} + +impl TryFrom<RefundsResponseRouterData<RSync, RefundResponse>> for RefundsRouterData<RSync> { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: RefundsResponseRouterData<RSync, RefundResponse>, + ) -> Result<Self, Self::Error> { + Ok(Self { + response: Ok(RefundsResponseData { + connector_refund_id: item.response.id.to_string(), + refund_status: enums::RefundStatus::from(item.response.status), + }), + ..item.data + }) + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Serialize, Deserialize, PartialEq)] +pub struct CustombillingErrorResponse { + pub status_code: u16, + pub code: String, + pub message: String, + pub reason: Option<String>, +} diff --git a/crates/hyperswitch_connectors/src/default_implementations.rs b/crates/hyperswitch_connectors/src/default_implementations.rs index 2e585b1c09b..16bb27e06b7 100644 --- a/crates/hyperswitch_connectors/src/default_implementations.rs +++ b/crates/hyperswitch_connectors/src/default_implementations.rs @@ -169,6 +169,7 @@ default_imp_for_authorize_session_token!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -298,6 +299,7 @@ default_imp_for_calculate_tax!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -428,6 +430,7 @@ default_imp_for_session_update!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Digitalvirgo, @@ -558,6 +561,7 @@ default_imp_for_post_session_tokens!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Digitalvirgo, @@ -687,6 +691,7 @@ default_imp_for_create_order!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Digitalvirgo, @@ -817,6 +822,7 @@ default_imp_for_update_metadata!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Digitalvirgo, @@ -946,6 +952,7 @@ default_imp_for_complete_authorize!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Datatrans, connectors::Dlocal, connectors::Dwolla, @@ -1060,6 +1067,7 @@ default_imp_for_incremental_authorization!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Datatrans, connectors::Deutschebank, connectors::Digitalvirgo, @@ -1189,6 +1197,7 @@ default_imp_for_create_customer!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -1312,6 +1321,7 @@ default_imp_for_connector_redirect_response!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -1427,6 +1437,7 @@ default_imp_for_pre_processing_steps!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Datatrans, connectors::Deutschebank, connectors::Digitalvirgo, @@ -1547,6 +1558,7 @@ default_imp_for_post_processing_steps!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -1678,6 +1690,7 @@ default_imp_for_approve!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -1810,6 +1823,7 @@ default_imp_for_reject!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -1942,6 +1956,7 @@ default_imp_for_webhook_source_verification!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -2072,6 +2087,7 @@ default_imp_for_accept_dispute!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -2202,6 +2218,7 @@ default_imp_for_submit_evidence!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -2331,6 +2348,7 @@ default_imp_for_defend_dispute!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -2470,6 +2488,7 @@ default_imp_for_file_upload!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -2593,6 +2612,7 @@ default_imp_for_payouts!( connectors::Datatrans, connectors::Coinbase, connectors::Coingate, + connectors::Custombilling, connectors::Deutschebank, connectors::Digitalvirgo, connectors::Dlocal, @@ -2717,6 +2737,7 @@ default_imp_for_payouts_create!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -2846,6 +2867,7 @@ default_imp_for_payouts_retrieve!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -2977,6 +2999,7 @@ default_imp_for_payouts_eligibility!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -3106,6 +3129,7 @@ default_imp_for_payouts_fulfill!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Datatrans, connectors::Deutschebank, connectors::Digitalvirgo, @@ -3232,6 +3256,7 @@ default_imp_for_payouts_cancel!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -3362,6 +3387,7 @@ default_imp_for_payouts_quote!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -3493,6 +3519,7 @@ default_imp_for_payouts_recipient!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -3623,6 +3650,7 @@ default_imp_for_payouts_recipient_account!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -3755,6 +3783,7 @@ default_imp_for_frm_sale!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -3887,6 +3916,7 @@ default_imp_for_frm_checkout!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -4019,6 +4049,7 @@ default_imp_for_frm_transaction!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -4151,6 +4182,7 @@ default_imp_for_frm_fulfillment!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -4283,6 +4315,7 @@ default_imp_for_frm_record_return!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -4411,6 +4444,7 @@ default_imp_for_revoking_mandates!( connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, + connectors::Custombilling, connectors::Datatrans, connectors::Deutschebank, connectors::Digitalvirgo, @@ -4540,6 +4574,7 @@ default_imp_for_uas_pre_authentication!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -4669,6 +4704,7 @@ default_imp_for_uas_post_authentication!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -4799,6 +4835,7 @@ default_imp_for_uas_authentication_confirmation!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -4921,6 +4958,7 @@ default_imp_for_connector_request_id!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -5045,6 +5083,7 @@ default_imp_for_fraud_check!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -5199,6 +5238,7 @@ default_imp_for_connector_authentication!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -5326,6 +5366,7 @@ default_imp_for_uas_authentication!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -5448,6 +5489,7 @@ default_imp_for_revenue_recovery!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -5581,6 +5623,7 @@ default_imp_for_billing_connector_payment_sync!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -5712,6 +5755,7 @@ default_imp_for_revenue_recovery_record_back!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -5843,6 +5887,7 @@ default_imp_for_billing_connector_invoice_sync!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -5968,6 +6013,7 @@ default_imp_for_external_vault!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -6099,6 +6145,7 @@ default_imp_for_external_vault_insert!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -6230,6 +6277,7 @@ default_imp_for_external_vault_retrieve!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -6361,6 +6409,7 @@ default_imp_for_external_vault_delete!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -6492,6 +6541,7 @@ default_imp_for_external_vault_create!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, diff --git a/crates/hyperswitch_connectors/src/default_implementations_v2.rs b/crates/hyperswitch_connectors/src/default_implementations_v2.rs index 7e8ddbee352..42a500b8e96 100644 --- a/crates/hyperswitch_connectors/src/default_implementations_v2.rs +++ b/crates/hyperswitch_connectors/src/default_implementations_v2.rs @@ -275,6 +275,7 @@ default_imp_for_new_connector_integration_payment!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -407,6 +408,7 @@ default_imp_for_new_connector_integration_refund!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -534,6 +536,7 @@ default_imp_for_new_connector_integration_connector_access_token!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -667,6 +670,7 @@ default_imp_for_new_connector_integration_accept_dispute!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Datatrans, connectors::Deutschebank, connectors::Digitalvirgo, @@ -798,6 +802,7 @@ default_imp_for_new_connector_integration_submit_evidence!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Datatrans, connectors::Deutschebank, connectors::Digitalvirgo, @@ -929,6 +934,7 @@ default_imp_for_new_connector_integration_defend_dispute!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -1071,6 +1077,7 @@ default_imp_for_new_connector_integration_file_upload!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -1205,6 +1212,7 @@ default_imp_for_new_connector_integration_payouts_create!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -1339,6 +1347,7 @@ default_imp_for_new_connector_integration_payouts_eligibility!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -1473,6 +1482,7 @@ default_imp_for_new_connector_integration_payouts_fulfill!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -1607,6 +1617,7 @@ default_imp_for_new_connector_integration_payouts_cancel!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -1741,6 +1752,7 @@ default_imp_for_new_connector_integration_payouts_quote!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -1875,6 +1887,7 @@ default_imp_for_new_connector_integration_payouts_recipient!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -2009,6 +2022,7 @@ default_imp_for_new_connector_integration_payouts_sync!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -2143,6 +2157,7 @@ default_imp_for_new_connector_integration_payouts_recipient_account!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -2275,6 +2290,7 @@ default_imp_for_new_connector_integration_webhook_source_verification!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -2409,6 +2425,7 @@ default_imp_for_new_connector_integration_frm_sale!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -2543,6 +2560,7 @@ default_imp_for_new_connector_integration_frm_checkout!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -2677,6 +2695,7 @@ default_imp_for_new_connector_integration_frm_transaction!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -2811,6 +2830,7 @@ default_imp_for_new_connector_integration_frm_fulfillment!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -2945,6 +2965,7 @@ default_imp_for_new_connector_integration_frm_record_return!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -3076,6 +3097,7 @@ default_imp_for_new_connector_integration_revoking_mandates!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, @@ -3192,6 +3214,7 @@ default_imp_for_new_connector_integration_frm!( connectors::Coinbase, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Datatrans, connectors::Deutschebank, connectors::Digitalvirgo, @@ -3323,6 +3346,7 @@ default_imp_for_new_connector_integration_connector_authentication!( connectors::Coinbase, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Datatrans, connectors::Deutschebank, connectors::Digitalvirgo, @@ -3443,6 +3467,7 @@ default_imp_for_new_connector_integration_revenue_recovery!( connectors::Coinbase, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Datatrans, connectors::Deutschebank, connectors::Digitalvirgo, @@ -3582,6 +3607,7 @@ default_imp_for_new_connector_integration_external_vault!( connectors::Coingate, connectors::Cryptopay, connectors::CtpMastercard, + connectors::Custombilling, connectors::Cybersource, connectors::Datatrans, connectors::Deutschebank, diff --git a/crates/hyperswitch_domain_models/src/connector_endpoints.rs b/crates/hyperswitch_domain_models/src/connector_endpoints.rs index 6d2b63bf9b0..63c00ed2e35 100644 --- a/crates/hyperswitch_domain_models/src/connector_endpoints.rs +++ b/crates/hyperswitch_domain_models/src/connector_endpoints.rs @@ -41,6 +41,7 @@ pub struct Connectors { pub cryptopay: ConnectorParams, pub ctp_mastercard: NoParams, pub ctp_visa: NoParams, + pub custombilling: NoParams, pub cybersource: ConnectorParams, pub datatrans: ConnectorParamsWithSecondaryBaseUrl, pub deutschebank: ConnectorParams, diff --git a/crates/router/src/connector.rs b/crates/router/src/connector.rs index 581ba5fb69f..189108d2cb8 100644 --- a/crates/router/src/connector.rs +++ b/crates/router/src/connector.rs @@ -13,34 +13,35 @@ pub use hyperswitch_connectors::connectors::{ boku::Boku, braintree, braintree::Braintree, cashtocode, cashtocode::Cashtocode, celero, celero::Celero, chargebee, chargebee::Chargebee, checkbook, checkbook::Checkbook, checkout, checkout::Checkout, coinbase, coinbase::Coinbase, coingate, coingate::Coingate, cryptopay, - cryptopay::Cryptopay, ctp_mastercard, ctp_mastercard::CtpMastercard, cybersource, - cybersource::Cybersource, datatrans, datatrans::Datatrans, deutschebank, - deutschebank::Deutschebank, digitalvirgo, digitalvirgo::Digitalvirgo, dlocal, dlocal::Dlocal, - dwolla, dwolla::Dwolla, ebanx, ebanx::Ebanx, elavon, elavon::Elavon, facilitapay, - facilitapay::Facilitapay, fiserv, fiserv::Fiserv, fiservemea, fiservemea::Fiservemea, fiuu, - fiuu::Fiuu, forte, forte::Forte, getnet, getnet::Getnet, globalpay, globalpay::Globalpay, - globepay, globepay::Globepay, gocardless, gocardless::Gocardless, gpayments, - gpayments::Gpayments, helcim, helcim::Helcim, hipay, hipay::Hipay, hyperswitch_vault, - hyperswitch_vault::HyperswitchVault, iatapay, iatapay::Iatapay, inespay, inespay::Inespay, - itaubank, itaubank::Itaubank, jpmorgan, jpmorgan::Jpmorgan, juspaythreedsserver, - juspaythreedsserver::Juspaythreedsserver, klarna, klarna::Klarna, mifinity, mifinity::Mifinity, - mollie, mollie::Mollie, moneris, moneris::Moneris, multisafepay, multisafepay::Multisafepay, - netcetera, netcetera::Netcetera, nexinets, nexinets::Nexinets, nexixpay, nexixpay::Nexixpay, - nmi, nmi::Nmi, nomupay, nomupay::Nomupay, noon, noon::Noon, nordea, nordea::Nordea, novalnet, - novalnet::Novalnet, nuvei, nuvei::Nuvei, opayo, opayo::Opayo, opennode, opennode::Opennode, - paybox, paybox::Paybox, payeezy, payeezy::Payeezy, payload, payload::Payload, payme, - payme::Payme, payone, payone::Payone, paypal, paypal::Paypal, paystack, paystack::Paystack, - payu, payu::Payu, placetopay, placetopay::Placetopay, plaid, plaid::Plaid, powertranz, - powertranz::Powertranz, prophetpay, prophetpay::Prophetpay, rapyd, rapyd::Rapyd, razorpay, - razorpay::Razorpay, recurly, recurly::Recurly, redsys, redsys::Redsys, riskified, - riskified::Riskified, santander, santander::Santander, shift4, shift4::Shift4, signifyd, - signifyd::Signifyd, silverflow, silverflow::Silverflow, square, square::Square, stax, - stax::Stax, stripe, stripe::Stripe, stripebilling, stripebilling::Stripebilling, taxjar, - taxjar::Taxjar, threedsecureio, threedsecureio::Threedsecureio, thunes, thunes::Thunes, - tokenio, tokenio::Tokenio, trustpay, trustpay::Trustpay, tsys, tsys::Tsys, - unified_authentication_service, unified_authentication_service::UnifiedAuthenticationService, - vgs, vgs::Vgs, volt, volt::Volt, wellsfargo, wellsfargo::Wellsfargo, wellsfargopayout, - wellsfargopayout::Wellsfargopayout, wise, wise::Wise, worldline, worldline::Worldline, - worldpay, worldpay::Worldpay, worldpayvantiv, worldpayvantiv::Worldpayvantiv, worldpayxml, - worldpayxml::Worldpayxml, xendit, xendit::Xendit, zen, zen::Zen, zsl, zsl::Zsl, + cryptopay::Cryptopay, ctp_mastercard, ctp_mastercard::CtpMastercard, custombilling, + custombilling::Custombilling, cybersource, cybersource::Cybersource, datatrans, + datatrans::Datatrans, deutschebank, deutschebank::Deutschebank, digitalvirgo, + digitalvirgo::Digitalvirgo, dlocal, dlocal::Dlocal, dwolla, dwolla::Dwolla, ebanx, + ebanx::Ebanx, elavon, elavon::Elavon, facilitapay, facilitapay::Facilitapay, fiserv, + fiserv::Fiserv, fiservemea, fiservemea::Fiservemea, fiuu, fiuu::Fiuu, forte, forte::Forte, + getnet, getnet::Getnet, globalpay, globalpay::Globalpay, globepay, globepay::Globepay, + gocardless, gocardless::Gocardless, gpayments, gpayments::Gpayments, helcim, helcim::Helcim, + hipay, hipay::Hipay, hyperswitch_vault, hyperswitch_vault::HyperswitchVault, iatapay, + iatapay::Iatapay, inespay, inespay::Inespay, itaubank, itaubank::Itaubank, jpmorgan, + jpmorgan::Jpmorgan, juspaythreedsserver, juspaythreedsserver::Juspaythreedsserver, klarna, + klarna::Klarna, mifinity, mifinity::Mifinity, mollie, mollie::Mollie, moneris, + moneris::Moneris, multisafepay, multisafepay::Multisafepay, netcetera, netcetera::Netcetera, + nexinets, nexinets::Nexinets, nexixpay, nexixpay::Nexixpay, nmi, nmi::Nmi, nomupay, + nomupay::Nomupay, noon, noon::Noon, nordea, nordea::Nordea, novalnet, novalnet::Novalnet, + nuvei, nuvei::Nuvei, opayo, opayo::Opayo, opennode, opennode::Opennode, paybox, paybox::Paybox, + payeezy, payeezy::Payeezy, payload, payload::Payload, payme, payme::Payme, payone, + payone::Payone, paypal, paypal::Paypal, paystack, paystack::Paystack, payu, payu::Payu, + placetopay, placetopay::Placetopay, plaid, plaid::Plaid, powertranz, powertranz::Powertranz, + prophetpay, prophetpay::Prophetpay, rapyd, rapyd::Rapyd, razorpay, razorpay::Razorpay, recurly, + recurly::Recurly, redsys, redsys::Redsys, riskified, riskified::Riskified, santander, + santander::Santander, shift4, shift4::Shift4, signifyd, signifyd::Signifyd, silverflow, + silverflow::Silverflow, square, square::Square, stax, stax::Stax, stripe, stripe::Stripe, + stripebilling, stripebilling::Stripebilling, taxjar, taxjar::Taxjar, threedsecureio, + threedsecureio::Threedsecureio, thunes, thunes::Thunes, tokenio, tokenio::Tokenio, trustpay, + trustpay::Trustpay, tsys, tsys::Tsys, unified_authentication_service, + unified_authentication_service::UnifiedAuthenticationService, vgs, vgs::Vgs, volt, volt::Volt, + wellsfargo, wellsfargo::Wellsfargo, wellsfargopayout, wellsfargopayout::Wellsfargopayout, wise, + wise::Wise, worldline, worldline::Worldline, worldpay, worldpay::Worldpay, worldpayvantiv, + worldpayvantiv::Worldpayvantiv, worldpayxml, worldpayxml::Worldpayxml, xendit, xendit::Xendit, + zen, zen::Zen, zsl, zsl::Zsl, }; diff --git a/crates/router/src/core/connector_validation.rs b/crates/router/src/core/connector_validation.rs index 6fb5a340ba2..f04edb139f2 100644 --- a/crates/router/src/core/connector_validation.rs +++ b/crates/router/src/core/connector_validation.rs @@ -171,6 +171,7 @@ impl ConnectorAuthTypeAndMetadataValidation<'_> { Ok(()) } api_enums::Connector::CtpMastercard => Ok(()), + api_enums::Connector::Custombilling => Ok(()), api_enums::Connector::CtpVisa => Ok(()), api_enums::Connector::Cybersource => { cybersource::transformers::CybersourceAuthType::try_from(self.auth_type)?; diff --git a/crates/router/src/core/payments/transformers.rs b/crates/router/src/core/payments/transformers.rs index 6785e429984..1974fd3e428 100644 --- a/crates/router/src/core/payments/transformers.rs +++ b/crates/router/src/core/payments/transformers.rs @@ -5047,6 +5047,12 @@ impl ForeignFrom<&hyperswitch_domain_models::payments::payment_attempt::PaymentA fn foreign_from( attempt: &hyperswitch_domain_models::payments::payment_attempt::PaymentAttempt, ) -> Self { + let payment_method_data: Option< + api_models::payments::PaymentMethodDataResponseWithBilling, + > = attempt + .payment_method_data + .clone() + .and_then(|data| serde_json::from_value(data.expose().clone()).ok()); Self { id: attempt.get_id().to_owned(), status: attempt.status, @@ -5078,6 +5084,7 @@ impl ForeignFrom<&hyperswitch_domain_models::payments::payment_attempt::PaymentA .feature_metadata .as_ref() .map(api_models::payments::PaymentAttemptFeatureMetadata::foreign_from), + payment_method_data, } } } diff --git a/crates/router/src/types/api/connector_mapping.rs b/crates/router/src/types/api/connector_mapping.rs index 3dbb241622b..e80d75a7ec1 100644 --- a/crates/router/src/types/api/connector_mapping.rs +++ b/crates/router/src/types/api/connector_mapping.rs @@ -175,6 +175,9 @@ impl ConnectorData { enums::Connector::CtpMastercard => { Ok(ConnectorEnum::Old(Box::new(&connector::CtpMastercard))) } + enums::Connector::Custombilling => Ok(ConnectorEnum::Old(Box::new( + connector::Custombilling::new(), + ))), enums::Connector::CtpVisa => Ok(ConnectorEnum::Old(Box::new( connector::UnifiedAuthenticationService::new(), ))), diff --git a/crates/router/src/types/connector_transformers.rs b/crates/router/src/types/connector_transformers.rs index 75b32b3ec11..47cdf592aa1 100644 --- a/crates/router/src/types/connector_transformers.rs +++ b/crates/router/src/types/connector_transformers.rs @@ -32,6 +32,7 @@ impl ForeignTryFrom<api_enums::Connector> for common_enums::RoutableConnectors { api_enums::Connector::Coinbase => Self::Coinbase, api_enums::Connector::Coingate => Self::Coingate, api_enums::Connector::Cryptopay => Self::Cryptopay, + api_enums::Connector::Custombilling => Self::Custombilling, api_enums::Connector::CtpVisa => { Err(common_utils::errors::ValidationError::InvalidValue { message: "ctp visa is not a routable connector".to_string(), diff --git a/crates/router/tests/connectors/custombilling.rs b/crates/router/tests/connectors/custombilling.rs new file mode 100644 index 00000000000..f92552ab14f --- /dev/null +++ b/crates/router/tests/connectors/custombilling.rs @@ -0,0 +1,402 @@ +use masking::Secret; +use router::{ + types::{self, api, storage::enums, +}}; + +use crate::utils::{self, ConnectorActions}; +use test_utils::connector_auth; + +#[derive(Clone, Copy)] +struct CustombillingTest; +impl ConnectorActions for CustombillingTest {} +impl utils::Connector for CustombillingTest { + fn get_data(&self) -> api::ConnectorData { + use router::connector::Custombilling; + api::ConnectorData { + connector: Box::new(Custombilling::new()), + connector_name: types::Connector::Custombilling, + get_token: types::api::GetToken::Connector, + merchant_connector_id: None, + } + } + + fn get_auth_token(&self) -> types::ConnectorAuthType { + utils::to_connector_auth_type( + connector_auth::ConnectorAuthentication::new() + .custombilling + .expect("Missing connector authentication configuration").into(), + ) + } + + fn get_name(&self) -> String { + "custombilling".to_string() + } +} + +static CONNECTOR: CustombillingTest = CustombillingTest {}; + +fn get_default_payment_info() -> Option<utils::PaymentInfo> { + None +} + +fn payment_method_details() -> Option<types::PaymentsAuthorizeData> { + None +} + +// Cards Positive Tests +// Creates a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_only_authorize_payment() { + let response = CONNECTOR + .authorize_payment(payment_method_details(), get_default_payment_info()) + .await + .expect("Authorize payment response"); + assert_eq!(response.status, enums::AttemptStatus::Authorized); +} + +// Captures a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_capture_authorized_payment() { + let response = CONNECTOR + .authorize_and_capture_payment(payment_method_details(), None, get_default_payment_info()) + .await + .expect("Capture payment response"); + assert_eq!(response.status, enums::AttemptStatus::Charged); +} + +// Partially captures a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_capture_authorized_payment() { + let response = CONNECTOR + .authorize_and_capture_payment( + payment_method_details(), + Some(types::PaymentsCaptureData { + amount_to_capture: 50, + ..utils::PaymentCaptureType::default().0 + }), + get_default_payment_info(), + ) + .await + .expect("Capture payment response"); + assert_eq!(response.status, enums::AttemptStatus::Charged); +} + +// Synchronizes a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_authorized_payment() { + let authorize_response = CONNECTOR + .authorize_payment(payment_method_details(), get_default_payment_info()) + .await + .expect("Authorize payment response"); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + let response = CONNECTOR + .psync_retry_till_status_matches( + enums::AttemptStatus::Authorized, + Some(types::PaymentsSyncData { + connector_transaction_id: types::ResponseId::ConnectorTransactionId( + txn_id.unwrap(), + ), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .expect("PSync response"); + assert_eq!(response.status, enums::AttemptStatus::Authorized,); +} + +// Voids a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_void_authorized_payment() { + let response = CONNECTOR + .authorize_and_void_payment( + payment_method_details(), + Some(types::PaymentsCancelData { + connector_transaction_id: String::from(""), + cancellation_reason: Some("requested_by_customer".to_string()), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .expect("Void payment response"); + assert_eq!(response.status, enums::AttemptStatus::Voided); +} + +// Refunds a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_manually_captured_payment() { + let response = CONNECTOR + .capture_payment_and_refund(payment_method_details(), None, None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Partially refunds a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_refund_manually_captured_payment() { + let response = CONNECTOR + .capture_payment_and_refund( + payment_method_details(), + None, + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Synchronizes a refund using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_manually_captured_refund() { + let refund_response = CONNECTOR + .capture_payment_and_refund(payment_method_details(), None, None, get_default_payment_info()) + .await + .unwrap(); + let response = CONNECTOR + .rsync_retry_till_status_matches( + enums::RefundStatus::Success, + refund_response.response.unwrap().connector_refund_id, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Creates a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_make_payment() { + let authorize_response = CONNECTOR.make_payment(payment_method_details(), get_default_payment_info()).await.unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); +} + +// Synchronizes a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_auto_captured_payment() { + let authorize_response = CONNECTOR.make_payment(payment_method_details(), get_default_payment_info()).await.unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + assert_ne!(txn_id, None, "Empty connector transaction id"); + let response = CONNECTOR + .psync_retry_till_status_matches( + enums::AttemptStatus::Charged, + Some(types::PaymentsSyncData { + connector_transaction_id: types::ResponseId::ConnectorTransactionId( + txn_id.unwrap(), + ), + capture_method: Some(enums::CaptureMethod::Automatic), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!(response.status, enums::AttemptStatus::Charged,); +} + +// Refunds a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_auto_captured_payment() { + let response = CONNECTOR + .make_payment_and_refund(payment_method_details(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Partially refunds a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_refund_succeeded_payment() { + let refund_response = CONNECTOR + .make_payment_and_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + refund_response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Creates multiple refunds against a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_succeeded_payment_multiple_times() { + CONNECTOR + .make_payment_and_multiple_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await; +} + +// Synchronizes a refund using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_refund() { + let refund_response = CONNECTOR + .make_payment_and_refund(payment_method_details(), None, get_default_payment_info()) + .await + .unwrap(); + let response = CONNECTOR + .rsync_retry_till_status_matches( + enums::RefundStatus::Success, + refund_response.response.unwrap().connector_refund_id, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Cards Negative scenarios +// Creates a payment with incorrect CVC. +#[actix_web::test] +async fn should_fail_payment_for_incorrect_cvc() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: types::api::PaymentMethodData::Card(api::Card { + card_cvc: Secret::new("12345".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's security code is invalid.".to_string(), + ); +} + +// Creates a payment with incorrect expiry month. +#[actix_web::test] +async fn should_fail_payment_for_invalid_exp_month() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: api::PaymentMethodData::Card(api::Card { + card_exp_month: Secret::new("20".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's expiration month is invalid.".to_string(), + ); +} + +// Creates a payment with incorrect expiry year. +#[actix_web::test] +async fn should_fail_payment_for_incorrect_expiry_year() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: api::PaymentMethodData::Card(api::Card { + card_exp_year: Secret::new("2000".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's expiration year is invalid.".to_string(), + ); +} + +// Voids a payment using automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_fail_void_payment_for_auto_capture() { + let authorize_response = CONNECTOR.make_payment(payment_method_details(), get_default_payment_info()).await.unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + assert_ne!(txn_id, None, "Empty connector transaction id"); + let void_response = CONNECTOR + .void_payment(txn_id.unwrap(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + void_response.response.unwrap_err().message, + "You cannot cancel this PaymentIntent because it has a status of succeeded." + ); +} + +// Captures a payment using invalid connector payment id. +#[actix_web::test] +async fn should_fail_capture_for_invalid_payment() { + let capture_response = CONNECTOR + .capture_payment("123456789".to_string(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + capture_response.response.unwrap_err().message, + String::from("No such payment_intent: '123456789'") + ); +} + +// Refunds a payment with refund amount higher than payment amount. +#[actix_web::test] +async fn should_fail_for_refund_amount_higher_than_payment_amount() { + let response = CONNECTOR + .make_payment_and_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 150, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Refund amount (₹1.50) is greater than charge amount (₹1.00)", + ); +} + +// Connector dependent test cases goes here + +// [#478]: add unit tests for non 3DS, wallets & webhooks in connector tests diff --git a/loadtest/config/development.toml b/loadtest/config/development.toml index 0a64bdbba0f..857d43091bc 100644 --- a/loadtest/config/development.toml +++ b/loadtest/config/development.toml @@ -238,6 +238,7 @@ cards = [ "coingate", "cryptopay", "ctp_visa", + "custombilling", "cybersource", "datatrans", "deutschebank", diff --git a/scripts/add_connector.sh b/scripts/add_connector.sh index fffc5800f67..685175b79ad 100755 --- a/scripts/add_connector.sh +++ b/scripts/add_connector.sh @@ -6,7 +6,7 @@ function find_prev_connector() { git checkout $self cp $self $self.tmp # Add new connector to existing list and sort it - connectors=(aci adyen adyenplatform affirm airwallex amazonpay applepay archipel authipay authorizedotnet bambora bamboraapac bankofamerica barclaycard billwerk bitpay blackhawknetwork bluesnap boku braintree cashtocode celero chargebee checkbook checkout coinbase cryptopay ctp_visa cybersource datatrans deutschebank digitalvirgo dlocal dummyconnector dwolla ebanx elavon facilitapay fiserv fiservemea fiuu forte getnet globalpay globepay gocardless gpayments helcim hipay hyperswitch_vault iatapay inespay itaubank jpmorgan juspaythreedsserver klarna mifinity mollie moneris multisafepay netcetera nexinets nexixpay nomupay noon nordea novalnet nuvei opayo opennode paybox payeezy payload payme payone paypal paystack payu placetopay plaid powertranz prophetpay rapyd razorpay recurly redsys santander shift4 silverflow square stax stripe stripebilling taxjar threedsecureio thunes tokenio trustpay tsys unified_authentication_service vgs volt wellsfargo wellsfargopayout wise worldline worldpay worldpayvantiv worldpayxml xendit zsl "$1") + connectors=(aci adyen adyenplatform affirm airwallex amazonpay applepay archipel authipay authorizedotnet bambora bamboraapac bankofamerica barclaycard billwerk bitpay blackhawknetwork bluesnap boku braintree cashtocode celero chargebee checkbook checkout coinbase cryptopay ctp_visa custombilling cybersource datatrans deutschebank digitalvirgo dlocal dummyconnector dwolla ebanx elavon facilitapay fiserv fiservemea fiuu forte getnet globalpay globepay gocardless gpayments helcim hipay hyperswitch_vault iatapay inespay itaubank jpmorgan juspaythreedsserver klarna mifinity mollie moneris multisafepay netcetera nexinets nexixpay nomupay noon nordea novalnet nuvei opayo opennode paybox payeezy payload payme payone paypal paystack payu placetopay plaid powertranz prophetpay rapyd razorpay recurly redsys santander shift4 silverflow square stax stripe stripebilling taxjar threedsecureio thunes tokenio trustpay tsys unified_authentication_service vgs volt wellsfargo wellsfargopayout wise worldline worldpay worldpayvantiv worldpayxml xendit zsl "$1") IFS=$'\n' sorted=($(sort <<<"${connectors[*]}")); unset IFS res="$(echo ${sorted[@]})"

2025-07-17T14:01:37Z

## Type of Change  - [ ] Bugfix - [ ] New feature - [x] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description This pr adds fetches payment method data in payment attempt list v2 api. ### Additional Changes - [x] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  ## How did you test it?  Request: ``` curl --location 'http://localhost:8080/v2/payments/12345_pay_0198179b2de5751292df2b555eaa3cf2/list_attempts' \ --header 'Content-Type: application/json' \ --header 'x-profile-id: pro_2Kk2ddRcJttgm6ONh0zm' \ --header 'api-key: dev_g5HfT4ijuVQs3QLUPf3xAT6M26ebVgHHTivreiSljKPdRvEsqBNSKxHJrhLboLsT' \ --header 'Authorization: api-key=dev_g5HfT4ijuVQs3QLUPf3xAT6M26ebVgHHTivreiSljKPdRvEsqBNSKxHJrhLboLsT' ``` Response ``` { "payment_attempt_list": [ { "id": "12345_att_0198179b2e167703a070a6ec12d40213", "status": "voided", "amount": { "net_amount": 10000, "amount_to_capture": null, "surcharge_amount": null, "tax_on_surcharge": null, "amount_capturable": 0, "shipping_cost": null, "order_tax_amount": null }, "connector": "stripe", "error": { "code": "card_declined", "message": "Your card was declined.", "unified_code": null, "unified_message": null, "network_advice_code": null, "network_decline_code": null, "network_error_message": null }, "authentication_type": "no_three_ds", "created_at": "2025-07-16T12:18:21.000Z", "modified_at": "2025-07-17T08:58:23.034Z", "cancellation_reason": null, "payment_token": null, "connector_metadata": null, "payment_experience": null, "payment_method_type": "card", "connector_reference_id": null, "payment_method_subtype": "credit", "connector_payment_id": { "TxnId": "pi_3RlUHlCZJlEh6syL1TxJJCst" }, "payment_method_id": null, "client_source": null, "client_version": null, "feature_metadata": { "revenue_recovery": { "attempt_triggered_by": "external", "charge_id": "ch_3RlUHlCZJlEh6syL1gLXCiDC" } }, "payment_method_data": { "card": { "last4": "0008", "card_type": null, "card_network": null, "card_issuer": "Chase", "card_issuing_country": null, "card_isin": null, "card_extended_bin": null, "card_exp_month": "06", "card_exp_year": "50", "card_holder_name": null, "payment_checks": null, "authentication_data": null }, "billing": null } } ] } ``` ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

db14764671d18fbbd8d699f0c7c97a327bc1d0db

juspay/hyperswitch

juspay__hyperswitch-8677

Bug: [BUG]: Success Rate rule being created/listed twice for a new profile When creating an SR rule for a new profile, 2 rules with different algorithm ids are being listed in the get call for listing rules. This is happening only upon creating a new SR rule for a new profile (with no rules existing previously), and not in case of creating an SR rule when other rules already exist. <img width="1728" height="1002" alt="Image" src="https://github.com/user-attachments/assets/eeb0c631-57d2-4e97-8c96-929d705aa4ad" />

diff --git a/crates/api_models/src/events/routing.rs b/crates/api_models/src/events/routing.rs index 9f09bac8274..b1129f96afb 100644 --- a/crates/api_models/src/events/routing.rs +++ b/crates/api_models/src/events/routing.rs @@ -2,7 +2,7 @@ use common_utils::events::{ApiEventMetric, ApiEventsType}; use crate::routing::{ ContractBasedRoutingPayloadWrapper, ContractBasedRoutingSetupPayloadWrapper, - DynamicRoutingUpdateConfigQuery, EliminationRoutingPayloadWrapper, + CreateDynamicRoutingWrapper, DynamicRoutingUpdateConfigQuery, EliminationRoutingPayloadWrapper, LinkedRoutingConfigRetrieveResponse, MerchantRoutingAlgorithm, ProfileDefaultRoutingConfig, RoutingAlgorithmId, RoutingConfigRequest, RoutingDictionaryRecord, RoutingKind, RoutingLinkWrapper, RoutingPayloadWrapper, RoutingRetrieveLinkQuery, @@ -125,6 +125,12 @@ impl ApiEventMetric for ToggleDynamicRoutingWrapper { } } +impl ApiEventMetric for CreateDynamicRoutingWrapper { + fn get_api_event_type(&self) -> Option<ApiEventsType> { + Some(ApiEventsType::Routing) + } +} + impl ApiEventMetric for DynamicRoutingUpdateConfigQuery { fn get_api_event_type(&self) -> Option<ApiEventsType> { Some(ApiEventsType::Routing) diff --git a/crates/api_models/src/routing.rs b/crates/api_models/src/routing.rs index ef5a9422e20..8216f58d4ec 100644 --- a/crates/api_models/src/routing.rs +++ b/crates/api_models/src/routing.rs @@ -836,6 +836,33 @@ impl DynamicRoutingAlgorithmRef { }; } + pub fn update_feature( + &mut self, + enabled_feature: DynamicRoutingFeatures, + dynamic_routing_type: DynamicRoutingType, + ) { + match dynamic_routing_type { + DynamicRoutingType::SuccessRateBasedRouting => { + self.success_based_algorithm = Some(SuccessBasedAlgorithm { + algorithm_id_with_timestamp: DynamicAlgorithmWithTimestamp::new(None), + enabled_feature, + }) + } + DynamicRoutingType::EliminationRouting => { + self.elimination_routing_algorithm = Some(EliminationRoutingAlgorithm { + algorithm_id_with_timestamp: DynamicAlgorithmWithTimestamp::new(None), + enabled_feature, + }) + } + DynamicRoutingType::ContractBasedRouting => { + self.contract_based_routing = Some(ContractRoutingAlgorithm { + algorithm_id_with_timestamp: DynamicAlgorithmWithTimestamp::new(None), + enabled_feature, + }) + } + }; + } + pub fn disable_algorithm_id(&mut self, dynamic_routing_type: DynamicRoutingType) { match dynamic_routing_type { DynamicRoutingType::SuccessRateBasedRouting => { @@ -871,6 +898,11 @@ pub struct ToggleDynamicRoutingQuery { pub enable: DynamicRoutingFeatures, } +#[derive(Debug, Clone, serde::Serialize, serde::Deserialize, ToSchema)] +pub struct CreateDynamicRoutingQuery { + pub enable: DynamicRoutingFeatures, +} + #[derive(Debug, Clone, Copy, serde::Serialize, serde::Deserialize, ToSchema)] pub struct DynamicRoutingVolumeSplitQuery { pub split: u8, @@ -907,6 +939,20 @@ pub struct ToggleDynamicRoutingPath { pub profile_id: common_utils::id_type::ProfileId, } +#[derive(Clone, Debug, serde::Deserialize, serde::Serialize)] +pub struct CreateDynamicRoutingWrapper { + pub profile_id: common_utils::id_type::ProfileId, + pub feature_to_enable: DynamicRoutingFeatures, + pub payload: DynamicRoutingPayload, +} + +#[derive(Debug, Clone, serde::Serialize, serde::Deserialize, ToSchema)] +#[serde(tag = "type", content = "data", rename_all = "snake_case")] +pub enum DynamicRoutingPayload { + SuccessBasedRoutingPayload(SuccessBasedRoutingConfig), + EliminationRoutingPayload(EliminationRoutingConfig), +} + #[derive(Clone, Debug, serde::Deserialize, serde::Serialize, ToSchema)] pub struct RoutingVolumeSplitResponse { pub split: u8, diff --git a/crates/router/src/core/routing.rs b/crates/router/src/core/routing.rs index 2e6f8b09775..6094c9826a1 100644 --- a/crates/router/src/core/routing.rs +++ b/crates/router/src/core/routing.rs @@ -1598,6 +1598,7 @@ pub async fn update_default_routing_config_for_profile( // Toggle the specific routing type as well as add the default configs in RoutingAlgorithm table // and update the same in business profile table. + #[cfg(all(feature = "v1", feature = "dynamic_routing"))] pub async fn toggle_specific_dynamic_routing( state: SessionState, @@ -1647,16 +1648,88 @@ pub async fn toggle_specific_dynamic_routing( // 1. If present with same feature then return response as already enabled // 2. Else update the feature and persist the same on db // 3. If not present in db then create a new default entry - helpers::enable_dynamic_routing_algorithm( + Box::pin(helpers::enable_dynamic_routing_algorithm( &state, merchant_context.get_merchant_key_store().clone(), business_profile, feature_to_enable, dynamic_routing_algo_ref, dynamic_routing_type, + None, + )) + .await + } + routing::DynamicRoutingFeatures::None => { + // disable specific dynamic routing for the requested profile + helpers::disable_dynamic_routing_algorithm( + &state, + merchant_context.get_merchant_key_store().clone(), + business_profile, + dynamic_routing_algo_ref, + dynamic_routing_type, ) .await } + } +} + +#[cfg(all(feature = "v1", feature = "dynamic_routing"))] +pub async fn create_specific_dynamic_routing( + state: SessionState, + merchant_context: domain::MerchantContext, + feature_to_enable: routing::DynamicRoutingFeatures, + profile_id: common_utils::id_type::ProfileId, + dynamic_routing_type: routing::DynamicRoutingType, + payload: routing_types::DynamicRoutingPayload, +) -> RouterResponse<routing_types::RoutingDictionaryRecord> { + metrics::ROUTING_CREATE_REQUEST_RECEIVED.add( + 1, + router_env::metric_attributes!( + ("profile_id", profile_id.clone()), + ("algorithm_type", dynamic_routing_type.to_string()) + ), + ); + let db = state.store.as_ref(); + let key_manager_state = &(&state).into(); + + let business_profile: domain::Profile = core_utils::validate_and_get_business_profile( + db, + key_manager_state, + merchant_context.get_merchant_key_store(), + Some(&profile_id), + merchant_context.get_merchant_account().get_id(), + ) + .await? + .get_required_value("Profile") + .change_context(errors::ApiErrorResponse::ProfileNotFound { + id: profile_id.get_string_repr().to_owned(), + })?; + + let dynamic_routing_algo_ref: routing_types::DynamicRoutingAlgorithmRef = business_profile + .dynamic_routing_algorithm + .clone() + .map(|val| val.parse_value("DynamicRoutingAlgorithmRef")) + .transpose() + .change_context(errors::ApiErrorResponse::InternalServerError) + .attach_printable( + "unable to deserialize dynamic routing algorithm ref from business profile", + )? + .unwrap_or_default(); + + match feature_to_enable { + routing::DynamicRoutingFeatures::Metrics + | routing::DynamicRoutingFeatures::DynamicConnectorSelection => { + Box::pin(helpers::enable_dynamic_routing_algorithm( + &state, + merchant_context.get_merchant_key_store().clone(), + business_profile, + feature_to_enable, + dynamic_routing_algo_ref, + dynamic_routing_type, + Some(payload), + )) + .await + } routing::DynamicRoutingFeatures::None => { // disable specific dynamic routing for the requested profile helpers::disable_dynamic_routing_algorithm( diff --git a/crates/router/src/core/routing/helpers.rs b/crates/router/src/core/routing/helpers.rs index b04df149228..290feb9e306 100644 --- a/crates/router/src/core/routing/helpers.rs +++ b/crates/router/src/core/routing/helpers.rs @@ -1979,6 +1979,7 @@ pub async fn enable_dynamic_routing_algorithm( feature_to_enable: routing_types::DynamicRoutingFeatures, dynamic_routing_algo_ref: routing_types::DynamicRoutingAlgorithmRef, dynamic_routing_type: routing_types::DynamicRoutingType, + payload: Option<routing_types::DynamicRoutingPayload>, ) -> RouterResult<ApplicationResponse<routing_types::RoutingDictionaryRecord>> { let mut dynamic_routing = dynamic_routing_algo_ref.clone(); match dynamic_routing_type { @@ -1994,6 +1995,7 @@ pub async fn enable_dynamic_routing_algorithm( dynamic_routing.clone(), dynamic_routing_type, dynamic_routing.success_based_algorithm, + payload, ) .await } @@ -2006,6 +2008,7 @@ pub async fn enable_dynamic_routing_algorithm( dynamic_routing.clone(), dynamic_routing_type, dynamic_routing.elimination_routing_algorithm, + payload, ) .await } @@ -2018,6 +2021,7 @@ pub async fn enable_dynamic_routing_algorithm( } } +#[allow(clippy::too_many_arguments)] #[cfg(all(feature = "v1", feature = "dynamic_routing"))] pub async fn enable_specific_routing_algorithm<A>( state: &SessionState, @@ -2027,10 +2031,24 @@ pub async fn enable_specific_routing_algorithm<A>( mut dynamic_routing_algo_ref: routing_types::DynamicRoutingAlgorithmRef, dynamic_routing_type: routing_types::DynamicRoutingType, algo_type: Option<A>, + payload: Option<routing_types::DynamicRoutingPayload>, ) -> RouterResult<ApplicationResponse<routing_types::RoutingDictionaryRecord>> where A: routing_types::DynamicRoutingAlgoAccessor + Clone + Debug, { + //Check for payload + if let Some(payload) = payload { + return create_specific_dynamic_routing_setup( + state, + key_store, + business_profile, + feature_to_enable, + dynamic_routing_algo_ref, + dynamic_routing_type, + payload, + ) + .await; + } // Algorithm wasn't created yet let Some(mut algo_type) = algo_type else { return default_specific_dynamic_routing_setup( @@ -2112,6 +2130,7 @@ pub async fn default_specific_dynamic_routing_setup( let merchant_id = business_profile.merchant_id.clone(); let algorithm_id = common_utils::generate_routing_id_of_default_length(); let timestamp = common_utils::date_time::now(); + let algo = match dynamic_routing_type { routing_types::DynamicRoutingType::SuccessRateBasedRouting => { let default_success_based_routing_config = @@ -2142,6 +2161,7 @@ pub async fn default_specific_dynamic_routing_setup( } else { routing_types::EliminationRoutingConfig::default() }; + routing_algorithm::RoutingAlgorithm { algorithm_id: algorithm_id.clone(), profile_id: profile_id.clone(), @@ -2173,6 +2193,7 @@ pub async fn default_specific_dynamic_routing_setup( business_profile.get_id(), dynamic_routing_type, &mut dynamic_routing_algo_ref, + None, ) .await .change_context(errors::ApiErrorResponse::InternalServerError) @@ -2208,6 +2229,122 @@ pub async fn default_specific_dynamic_routing_setup( Ok(ApplicationResponse::Json(new_record)) } +#[cfg(all(feature = "dynamic_routing", feature = "v1"))] +#[instrument(skip_all)] +pub async fn create_specific_dynamic_routing_setup( + state: &SessionState, + key_store: domain::MerchantKeyStore, + business_profile: domain::Profile, + feature_to_enable: routing_types::DynamicRoutingFeatures, + mut dynamic_routing_algo_ref: routing_types::DynamicRoutingAlgorithmRef, + dynamic_routing_type: routing_types::DynamicRoutingType, + payload: routing_types::DynamicRoutingPayload, +) -> RouterResult<ApplicationResponse<routing_types::RoutingDictionaryRecord>> { + let db = state.store.as_ref(); + let key_manager_state = &state.into(); + let profile_id = business_profile.get_id().clone(); + let merchant_id = business_profile.merchant_id.clone(); + let algorithm_id = common_utils::generate_routing_id_of_default_length(); + let timestamp = common_utils::date_time::now(); + + let algo = match dynamic_routing_type { + routing_types::DynamicRoutingType::SuccessRateBasedRouting => { + let success_config = match &payload { + routing_types::DynamicRoutingPayload::SuccessBasedRoutingPayload(config) => config, + _ => { + return Err((errors::ApiErrorResponse::InvalidRequestData { + message: "Invalid payload type for Success Rate Based Routing".to_string(), + }) + .into()) + } + }; + + routing_algorithm::RoutingAlgorithm { + algorithm_id: algorithm_id.clone(), + profile_id: profile_id.clone(), + merchant_id, + name: SUCCESS_BASED_DYNAMIC_ROUTING_ALGORITHM.to_string(), + description: None, + kind: diesel_models::enums::RoutingAlgorithmKind::Dynamic, + algorithm_data: serde_json::json!(success_config), + created_at: timestamp, + modified_at: timestamp, + algorithm_for: common_enums::TransactionType::Payment, + decision_engine_routing_id: None, + } + } + routing_types::DynamicRoutingType::EliminationRouting => { + let elimination_config = match &payload { + routing_types::DynamicRoutingPayload::EliminationRoutingPayload(config) => config, + _ => { + return Err((errors::ApiErrorResponse::InvalidRequestData { + message: "Invalid payload type for Elimination Routing".to_string(), + }) + .into()) + } + }; + + routing_algorithm::RoutingAlgorithm { + algorithm_id: algorithm_id.clone(), + profile_id: profile_id.clone(), + merchant_id, + name: ELIMINATION_BASED_DYNAMIC_ROUTING_ALGORITHM.to_string(), + description: None, + kind: diesel_models::enums::RoutingAlgorithmKind::Dynamic, + algorithm_data: serde_json::json!(elimination_config), + created_at: timestamp, + modified_at: timestamp, + algorithm_for: common_enums::TransactionType::Payment, + decision_engine_routing_id: None, + } + } + + routing_types::DynamicRoutingType::ContractBasedRouting => { + return Err((errors::ApiErrorResponse::InvalidRequestData { + message: "Contract routing cannot be set as default".to_string(), + }) + .into()) + } + }; + + if state.conf.open_router.dynamic_routing_enabled { + enable_decision_engine_dynamic_routing_setup( + state, + business_profile.get_id(), + dynamic_routing_type, + &mut dynamic_routing_algo_ref, + Some(payload), + ) + .await + .change_context(errors::ApiErrorResponse::InternalServerError) + .attach_printable("Unable to setup decision engine dynamic routing")?; + } + + let record = db + .insert_routing_algorithm(algo) + .await + .change_context(errors::ApiErrorResponse::InternalServerError) + .attach_printable("Unable to insert record in routing algorithm table")?; + + dynamic_routing_algo_ref.update_feature(feature_to_enable, dynamic_routing_type); + update_business_profile_active_dynamic_algorithm_ref( + db, + key_manager_state, + &key_store, + business_profile, + dynamic_routing_algo_ref, + ) + .await?; + + let new_record = record.foreign_into(); + + core_metrics::ROUTING_CREATE_SUCCESS_RESPONSE.add( + 1, + router_env::metric_attributes!(("profile_id", profile_id.clone())), + ); + Ok(ApplicationResponse::Json(new_record)) +} + #[derive(Debug, Clone)] pub struct DynamicRoutingConfigParamsInterpolator { pub payment_method: Option<common_enums::PaymentMethod>, @@ -2289,20 +2426,30 @@ pub async fn enable_decision_engine_dynamic_routing_setup( profile_id: &id_type::ProfileId, dynamic_routing_type: routing_types::DynamicRoutingType, dynamic_routing_algo_ref: &mut routing_types::DynamicRoutingAlgorithmRef, + payload: Option<routing_types::DynamicRoutingPayload>, ) -> RouterResult<()> { logger::debug!( "performing call with open_router for profile {}", profile_id.get_string_repr() ); - let default_engine_config_request = match dynamic_routing_type { + let decision_engine_config_request = match dynamic_routing_type { routing_types::DynamicRoutingType::SuccessRateBasedRouting => { - let default_success_based_routing_config = - routing_types::SuccessBasedRoutingConfig::open_router_config_default(); + let success_based_routing_config = payload + .and_then(|p| match p { + routing_types::DynamicRoutingPayload::SuccessBasedRoutingPayload(config) => { + Some(config) + } + _ => None, + }) + .unwrap_or_else( + routing_types::SuccessBasedRoutingConfig::open_router_config_default, + ); + open_router::DecisionEngineConfigSetupRequest { merchant_id: profile_id.get_string_repr().to_string(), config: open_router::DecisionEngineConfigVariant::SuccessRate( - default_success_based_routing_config + success_based_routing_config .get_decision_engine_configs() .change_context(errors::ApiErrorResponse::GenericNotFoundError { message: "Decision engine config not found".to_string(), @@ -2312,12 +2459,21 @@ pub async fn enable_decision_engine_dynamic_routing_setup( } } routing_types::DynamicRoutingType::EliminationRouting => { - let default_elimination_based_routing_config = - routing_types::EliminationRoutingConfig::open_router_config_default(); + let elimination_based_routing_config = payload + .and_then(|p| match p { + routing_types::DynamicRoutingPayload::EliminationRoutingPayload(config) => { + Some(config) + } + _ => None, + }) + .unwrap_or_else( + routing_types::EliminationRoutingConfig::open_router_config_default, + ); + open_router::DecisionEngineConfigSetupRequest { merchant_id: profile_id.get_string_repr().to_string(), config: open_router::DecisionEngineConfigVariant::Elimination( - default_elimination_based_routing_config + elimination_based_routing_config .get_decision_engine_configs() .change_context(errors::ApiErrorResponse::GenericNotFoundError { message: "Decision engine config not found".to_string(), @@ -2342,7 +2498,7 @@ pub async fn enable_decision_engine_dynamic_routing_setup( state, services::Method::Post, DECISION_ENGINE_RULE_CREATE_ENDPOINT, - Some(default_engine_config_request), + Some(decision_engine_config_request), None, None, ) diff --git a/crates/router/src/routes/app.rs b/crates/router/src/routes/app.rs index 01455e9e17b..62260dc49cc 100644 --- a/crates/router/src/routes/app.rs +++ b/crates/router/src/routes/app.rs @@ -2189,6 +2189,10 @@ impl Profile { web::resource("/toggle") .route(web::post().to(routing::toggle_success_based_routing)), ) + .service( + web::resource("/create") + .route(web::post().to(routing::create_success_based_routing)), + ) .service(web::resource("/config/{algorithm_id}").route( web::patch().to(|state, req, path, payload| { routing::success_based_routing_update_configs( @@ -2211,6 +2215,10 @@ impl Profile { web::resource("/toggle") .route(web::post().to(routing::toggle_elimination_routing)), ) + .service( + web::resource("/create") + .route(web::post().to(routing::create_elimination_routing)), + ) .service(web::resource("config/{algorithm_id}").route( web::patch().to(|state, req, path, payload| { routing::elimination_routing_update_configs( diff --git a/crates/router/src/routes/lock_utils.rs b/crates/router/src/routes/lock_utils.rs index 62d65211053..dcc5cf0752d 100644 --- a/crates/router/src/routes/lock_utils.rs +++ b/crates/router/src/routes/lock_utils.rs @@ -79,6 +79,7 @@ impl From<Flow> for ApiIdentifier { | Flow::DecisionManagerDeleteConfig | Flow::DecisionManagerRetrieveConfig | Flow::ToggleDynamicRouting + | Flow::CreateDynamicRoutingConfig | Flow::UpdateDynamicRoutingConfigs | Flow::DecisionManagerUpsertConfig | Flow::RoutingEvaluateRule diff --git a/crates/router/src/routes/routing.rs b/crates/router/src/routes/routing.rs index 53f6a75c5c1..ec118bea8da 100644 --- a/crates/router/src/routes/routing.rs +++ b/crates/router/src/routes/routing.rs @@ -1240,6 +1240,60 @@ pub async fn toggle_success_based_routing( .await } +#[cfg(all(feature = "olap", feature = "v1", feature = "dynamic_routing"))] +#[instrument(skip_all)] +pub async fn create_success_based_routing( + state: web::Data<AppState>, + req: HttpRequest, + query: web::Query<api_models::routing::CreateDynamicRoutingQuery>, + path: web::Path<routing_types::ToggleDynamicRoutingPath>, + success_based_config: web::Json<routing_types::SuccessBasedRoutingConfig>, +) -> impl Responder { + let flow = Flow::CreateDynamicRoutingConfig; + let wrapper = routing_types::CreateDynamicRoutingWrapper { + feature_to_enable: query.into_inner().enable, + profile_id: path.into_inner().profile_id, + payload: api_models::routing::DynamicRoutingPayload::SuccessBasedRoutingPayload( + success_based_config.into_inner(), + ), + }; + Box::pin(oss_api::server_wrap( + flow, + state, + &req, + wrapper.clone(), + |state, + auth: auth::AuthenticationData, + wrapper: routing_types::CreateDynamicRoutingWrapper, + _| { + let merchant_context = domain::MerchantContext::NormalMerchant(Box::new( + domain::Context(auth.merchant_account, auth.key_store), + )); + routing::create_specific_dynamic_routing( + state, + merchant_context, + wrapper.feature_to_enable, + wrapper.profile_id, + api_models::routing::DynamicRoutingType::SuccessRateBasedRouting, + wrapper.payload, + ) + }, + auth::auth_type( + &auth::HeaderAuth(auth::ApiKeyAuth { + is_connected_allowed: false, + is_platform_allowed: false, + }), + &auth::JWTAuthProfileFromRoute { + profile_id: wrapper.profile_id, + required_permission: Permission::ProfileRoutingWrite, + }, + req.headers(), + ), + api_locking::LockAction::NotApplicable, + )) + .await +} + #[cfg(all(feature = "olap", feature = "v1", feature = "dynamic_routing"))] #[instrument(skip_all)] pub async fn success_based_routing_update_configs( @@ -1480,6 +1534,60 @@ pub async fn toggle_elimination_routing( .await } +#[cfg(all(feature = "olap", feature = "v1", feature = "dynamic_routing"))] +#[instrument(skip_all)] +pub async fn create_elimination_routing( + state: web::Data<AppState>, + req: HttpRequest, + query: web::Query<api_models::routing::CreateDynamicRoutingQuery>, + path: web::Path<routing_types::ToggleDynamicRoutingPath>, + elimination_config: web::Json<routing_types::EliminationRoutingConfig>, +) -> impl Responder { + let flow = Flow::CreateDynamicRoutingConfig; + let wrapper = routing_types::CreateDynamicRoutingWrapper { + feature_to_enable: query.into_inner().enable, + profile_id: path.into_inner().profile_id, + payload: api_models::routing::DynamicRoutingPayload::EliminationRoutingPayload( + elimination_config.into_inner(), + ), + }; + Box::pin(oss_api::server_wrap( + flow, + state, + &req, + wrapper.clone(), + |state, + auth: auth::AuthenticationData, + wrapper: routing_types::CreateDynamicRoutingWrapper, + _| { + let merchant_context = domain::MerchantContext::NormalMerchant(Box::new( + domain::Context(auth.merchant_account, auth.key_store), + )); + routing::create_specific_dynamic_routing( + state, + merchant_context, + wrapper.feature_to_enable, + wrapper.profile_id, + api_models::routing::DynamicRoutingType::EliminationRouting, + wrapper.payload, + ) + }, + auth::auth_type( + &auth::HeaderAuth(auth::ApiKeyAuth { + is_connected_allowed: false, + is_platform_allowed: false, + }), + &auth::JWTAuthProfileFromRoute { + profile_id: wrapper.profile_id, + required_permission: Permission::ProfileRoutingWrite, + }, + req.headers(), + ), + api_locking::LockAction::NotApplicable, + )) + .await +} + #[cfg(all(feature = "olap", feature = "v1"))] #[instrument(skip_all)] pub async fn set_dynamic_routing_volume_split( diff --git a/crates/router_env/src/logger/types.rs b/crates/router_env/src/logger/types.rs index e6651c3c520..722d9bde9aa 100644 --- a/crates/router_env/src/logger/types.rs +++ b/crates/router_env/src/logger/types.rs @@ -261,6 +261,8 @@ pub enum Flow { RoutingUpdateDefaultConfig, /// Routing delete config RoutingDeleteConfig, + /// Create dynamic routing + CreateDynamicRoutingConfig, /// Toggle dynamic routing ToggleDynamicRouting, /// Update dynamic routing config

2025-07-24T13:08:02Z

### **Summary** This PR introduces the **`/create`** endpoints for dynamic routing algorithm types (Success-Based and Elimination), allowing merchants to initialize and register dynamic routing logic via a new payload-capable flow. The implementation includes support for optional configuration payloads and integration with the existing routing setup framework. --- ### **Key Changes** **New Features** * **New endpoint**: * `POST /{profile_id}/dynamic_routing/success_based/create` * `POST /{profile_id}/dynamic_routing/elimination/create` * **Payload Support**: Optional payloads for `SuccessBasedRoutingConfig` and `EliminationRoutingConfig` can now be passed to configure algorithms during creation. * **`CreateDynamicRoutingWrapper`** added to handle request data (profile ID, feature flag, optional payload). * **`DynamicRoutingPayload` enum** introduced with tagged serialization for extensibility. **Core Logic Additions** * **`create_specific_dynamic_routing`** method introduced to encapsulate algorithm creation logic based on feature + payload. * **`enable_dynamic_routing_algorithm`** and **`enable_specific_routing_algorithm`** now accept optional payloads to use custom configs during setup. * **New helper**: `create_specific_dynamic_routing_setup()` handles inserting the provided configuration payload into the DB, avoiding fallback to defaults. **Flow and API Updates** * `Flow::CreateDynamicRouting` added for observability and authorization context. * `ApiEventMetric` trait implemented for `CreateDynamicRoutingWrapper`. --- **Curls and Responses** 1. Flow for success_based (i)Request : Success Based ``` curl --location 'http://localhost:8080/account/merchant_1755085769/business_profile/pro_W03vsc3viNBMsEb2BAGF/dynamic_routing/success_based/create?enable=dynamic_connector_selection' \ --header 'Content-Type: application/json' \ --header 'api-key: dev_bhW5F52tburClYJFA3MhY5QHVD0EjpDPHoROKdB1NLfap0tBhRrH2QiQ5NQfIpHB' \ --data '{ "decision_engine_configs": { "defaultLatencyThreshold": 90, "defaultBucketSize": 200, "defaultHedgingPercent": 5, "subLevelInputConfig": [ { "paymentMethodType": "card", "paymentMethod": "credit", "bucketSize": 250, "hedgingPercent": 1 } ] } }' ``` Response: ``` { "id": "routing_STHAfh9Dyiy3BPLIUQAS", "profile_id": "pro_W03vsc3viNBMsEb2BAGF", "name": "Success rate based dynamic routing algorithm", "kind": "dynamic", "description": "", "created_at": 1755086316, "modified_at": 1755086316, "algorithm_for": "payment", "decision_engine_routing_id": null } ``` (ii)Request : Activate ``` curl --location 'http://localhost:8080/routing/routing_STHAfh9Dyiy3BPLIUQAS/activate' \ --header 'Content-Type: application/json' \ --header 'api-key: dev_bhW5F52tburClYJFA3MhY5QHVD0EjpDPHoROKdB1NLfap0tBhRrH2QiQ5NQfIpHB' \ --data '{}' ``` Response: ``` { "id": "routing_STHAfh9Dyiy3BPLIUQAS", "profile_id": "pro_W03vsc3viNBMsEb2BAGF", "name": "Success rate based dynamic routing algorithm", "kind": "dynamic", "description": "", "created_at": 1755086316, "modified_at": 1755086316, "algorithm_for": "payment", "decision_engine_routing_id": null } ``` (iii)Request: volume_split ``` curl --location --request POST 'http://localhost:8080/account/merchant_1755085769/business_profile/pro_W03vsc3viNBMsEb2BAGF/dynamic_routing/set_volume_split?split=100' \ --header 'api-key: dev_bhW5F52tburClYJFA3MhY5QH*****DPHoROKdB1NLfap0tBhRrH2QiQ5NQfIpHB' ``` Response: ``` { "routing_type": "dynamic", "split": 100 } ``` (iv)Request: Payment ``` curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_bhW5F52tburClYJFA3MhY5QHVD0EjpDPHoROKdB1NLfap0tBhRrH2QiQ5NQfIpHB' \ --data-raw '{ "amount": 6540, "currency": "USD", "amount_to_capture": 6540, "confirm": true, "profile_id": "pro_W03vsc3viNBMsEb2BAGF", "capture_method": "automatic", "capture_on": "2022-09-10T10:11:12Z", "authentication_type": "no_three_ds", "setup_future_usage": "on_session", "customer": { "id": "customer123", "name": "John Doe", "email": "[email protected]", "phone": "9999999999", "phone_country_code": "+1" }, "customer_id": "customer123", "phone_country_code": "+1", "description": "Its my first payment request", "return_url": "https://google.com", "payment_method": "card", "payment_method_type": "credit", "payment_method_data": { "card": { "card_number": "4242424242424242", "card_exp_month": "10", "card_exp_year": "25", "card_holder_name": "joseph Doe", "card_cvc": "123" } }, "billing": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" }, "phone": { "number": "8056594427", "country_code": "+91" }, "email": "[email protected]" }, "shipping": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" }, "phone": { "number": "8056594427", "country_code": "+91" }, "email": "[email protected]" }, "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "order_details": [ { "product_name": "Apple iphone 15", "quantity": 1, "amount": 6540, "account_name": "transaction_processing" } ], "metadata": { "udf1": "value1", "new_customer": "true", "login_date": "2019-09-10T10:11:12Z" }, "browser_info": { "user_agent": "Mozilla\/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/70.0.3538.110 Safari\/537.36", "accept_header": "text\/html,application\/xhtml+xml,application\/xml;q=0.9,image\/webp,image\/apng,*\/*;q=0.8", "language": "nl-NL", "color_depth": 24, "screen_height": 723, "screen_width": 1536, "time_zone": 0, "java_enabled": true, "java_script_enabled": true, "ip_address": "128.0.0.1" }, "customer_acceptance": { "acceptance_type": "offline", "accepted_at": "1963-05-03T04:07:52.723Z", "online": { "ip_address": "125.0.0.1", "user_agent": "amet irure esse" } }, "connector_metadata": { "noon": { "order_category": "pay" } }, "payment_link": false, "payment_link_config": { "theme": "", "logo": "", "seller_name": "", "sdk_layout": "", "display_sdk_only": false, "enabled_saved_payment_method": false }, "payment_type": "normal", "request_incremental_authorization": false, "merchant_order_reference_id": "test_ord", "session_expiry": 900 }' ``` 2. Flow of elimination Resquest : Elimination ``` curl --location 'http://localhost:8080/account/merchant_1755085769/business_profile/pro_W03vsc3viNBMsEb2BAGF/dynamic_routing/elimination/create?enable=dynamic_connector_selection' \ --header 'Content-Type: application/json' \ --header 'api-key: dev_bhW5F52tburClYJFA3MhY5QHVD0EjpDPHoROKdB1NLfap0tBhRrH2QiQ5NQfIpHB' \ --data '{ "decision_engine_configs": { "threshold": 0.35 } }' ``` Response: ``` { "id": "routing_TNPpQ8FtYXyVmBx408it", "profile_id": "pro_W03vsc3viNBMsEb2BAGF", "name": "Elimination based dynamic routing algorithm", "kind": "dynamic", "description": "", "created_at": 1755086640, "modified_at": 1755086640, "algorithm_for": "payment", "decision_engine_routing_id": null } ``` Request : activate ``` curl --location 'http://localhost:8080/routing/routing_TNPpQ8FtYXyVmBx408it/activate' \ --header 'Content-Type: application/json' \ --header 'api-key: dev_bhW5F52tburClYJFA3MhY5QHVD0EjpDPHoROKdB1NLfap0tBhRrH2QiQ5NQfIpHB' \ --data '{}' ``` Response: ``` { "id": "routing_TNPpQ8FtYXyVmBx408it", "profile_id": "pro_W03vsc3viNBMsEb2BAGF", "name": "Elimination based dynamic routing algorithm", "kind": "dynamic", "description": "", "created_at": 1755086640, "modified_at": 1755086640, "algorithm_for": "payment", "decision_engine_routing_id": null } ``` Request: volume_split ``` curl --location --request POST 'http://localhost:8080/account/merchant_1755085769/business_profile/pro_W03vsc3viNBMsEb2BAGF/dynamic_routing/set_volume_split?split=100' \ --header 'api-key: dev_bhW5F52tburClYJFA3MhY5QHVD0EjpDPHoROKd*****p0tBhRrH2QiQ5NQfIpHB' ``` Response: ``` { "routing_type": "dynamic", "split": 100 } ``` (iv) Request: Payment

v1.116.0

8bb8b2062e84e8d7116a9ca0e76c8ebd71b2b3ec

juspay/hyperswitch

juspay__hyperswitch-8678

Bug: Add debit routing support for apple pay In the Apple Pay decryption flow, if debit routing is enabled by the merchant and the card type is debit, a call will be made to the decision engine to retrieve the supported card networks and the potential debit routing savings. Among these networks, the lowest-cost network will be selected to process the Apple Pay payment.

diff --git a/crates/common_enums/src/enums.rs b/crates/common_enums/src/enums.rs index 49f6d15a6da..687e42728f2 100644 --- a/crates/common_enums/src/enums.rs +++ b/crates/common_enums/src/enums.rs @@ -190,6 +190,30 @@ impl AttemptStatus { } } +#[derive( + Clone, + Copy, + Debug, + Hash, + Eq, + PartialEq, + serde::Deserialize, + serde::Serialize, + strum::Display, + strum::EnumString, + strum::EnumIter, + ToSchema, +)] +#[router_derive::diesel_enum(storage_type = "db_enum")] +#[serde(rename_all = "snake_case")] +#[strum(serialize_all = "snake_case")] +pub enum ApplePayPaymentMethodType { + Debit, + Credit, + Prepaid, + Store, +} + /// Indicates the method by which a card is discovered during a payment #[derive( Clone, diff --git a/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs b/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs index bafbc7920af..d972c958b71 100644 --- a/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs @@ -2218,7 +2218,7 @@ impl TryFrom<(&WalletData, &PaymentsAuthorizeRouterData)> for AdyenPaymentMethod number: apple_pay_decrypte.application_primary_account_number, expiry_month: exp_month, expiry_year: expiry_year_4_digit, - brand: "applepay".to_string(), + brand: data.payment_method.network.clone(), payment_type: PaymentType::Scheme, }; Ok(AdyenPaymentMethod::ApplePayDecrypt(Box::new( diff --git a/crates/hyperswitch_domain_models/src/payment_method_data.rs b/crates/hyperswitch_domain_models/src/payment_method_data.rs index 0a5ca7705b8..f2f86479362 100644 --- a/crates/hyperswitch_domain_models/src/payment_method_data.rs +++ b/crates/hyperswitch_domain_models/src/payment_method_data.rs @@ -10,6 +10,7 @@ use common_enums::enums as api_enums; #[cfg(feature = "v2")] use common_utils::ext_traits::OptionExt; use common_utils::{ + ext_traits::StringExt, id_type, new_type::{ MaskedBankAccount, MaskedIban, MaskedRoutingNumber, MaskedSortCode, MaskedUpiVpaId, @@ -75,6 +76,14 @@ impl PaymentMethodData { } } + pub fn get_wallet_data(&self) -> Option<&WalletData> { + if let Self::Wallet(wallet_data) = self { + Some(wallet_data) + } else { + None + } + } + pub fn is_network_token_payment_method_data(&self) -> bool { matches!(self, Self::NetworkToken(_)) } @@ -263,6 +272,32 @@ pub enum WalletData { RevolutPay(RevolutPayData), } +impl WalletData { + pub fn get_paze_wallet_data(&self) -> Option<&PazeWalletData> { + if let Self::Paze(paze_wallet_data) = self { + Some(paze_wallet_data) + } else { + None + } + } + + pub fn get_apple_pay_wallet_data(&self) -> Option<&ApplePayWalletData> { + if let Self::ApplePay(apple_pay_wallet_data) = self { + Some(apple_pay_wallet_data) + } else { + None + } + } + + pub fn get_google_pay_wallet_data(&self) -> Option<&GooglePayWalletData> { + if let Self::GooglePay(google_pay_wallet_data) = self { + Some(google_pay_wallet_data) + } else { + None + } + } +} + #[derive(Eq, PartialEq, Clone, Debug, serde::Deserialize, serde::Serialize)] pub struct MifinityData { pub date_of_birth: Secret<Date>, @@ -432,6 +467,26 @@ pub struct ApplePayWalletData { pub transaction_identifier: String, } +impl ApplePayWalletData { + pub fn get_payment_method_type(&self) -> Option<api_enums::PaymentMethodType> { + self.payment_method + .pm_type + .clone() + .parse_enum("ApplePayPaymentMethodType") + .ok() + .and_then(|payment_type| match payment_type { + common_enums::ApplePayPaymentMethodType::Debit => { + Some(api_enums::PaymentMethodType::Debit) + } + common_enums::ApplePayPaymentMethodType::Credit => { + Some(api_enums::PaymentMethodType::Credit) + } + common_enums::ApplePayPaymentMethodType::Prepaid + | common_enums::ApplePayPaymentMethodType::Store => None, + }) + } +} + #[derive(Eq, PartialEq, Clone, Debug, serde::Deserialize, serde::Serialize)] pub struct ApplepayPaymentMethod { pub display_name: String, diff --git a/crates/router/src/core/debit_routing.rs b/crates/router/src/core/debit_routing.rs index 651f1ea04c3..0aeb2b9777b 100644 --- a/crates/router/src/core/debit_routing.rs +++ b/crates/router/src/core/debit_routing.rs @@ -6,7 +6,7 @@ use common_utils::{ errors::CustomResult, ext_traits::ValueExt, id_type, types::keymanager::KeyManagerState, }; use error_stack::ResultExt; -use masking::Secret; +use masking::{PeekInterface, Secret}; use super::{ payments::{OperationSessionGetters, OperationSessionSetters}, @@ -157,33 +157,76 @@ where match format!("{operation:?}").as_str() { "PaymentConfirm" => { logger::info!("Checking if debit routing is required"); - let payment_intent = payment_data.get_payment_intent(); - let payment_attempt = payment_data.get_payment_attempt(); - request_validation(payment_intent, payment_attempt, debit_routing_config) + request_validation(payment_data, debit_routing_config) } _ => false, } } -pub fn request_validation( - payment_intent: &hyperswitch_domain_models::payments::PaymentIntent, - payment_attempt: &hyperswitch_domain_models::payments::payment_attempt::PaymentAttempt, +fn request_validation<F: Clone, D>( + payment_data: &D, debit_routing_config: &settings::DebitRoutingConfig, -) -> bool { - logger::debug!("Validating request for debit routing"); - let is_currency_supported = payment_intent.currency.map(|currency| { - debit_routing_config - .supported_currencies - .contains(&currency) - }); +) -> bool +where + D: OperationSessionGetters<F> + Send + Sync + Clone, +{ + let payment_intent = payment_data.get_payment_intent(); + let payment_attempt = payment_data.get_payment_attempt(); + + let is_currency_supported = is_currency_supported(payment_intent, debit_routing_config); + + let is_valid_payment_method = validate_payment_method_for_debit_routing(payment_data); payment_intent.setup_future_usage != Some(enums::FutureUsage::OffSession) && payment_intent.amount.is_greater_than(0) - && is_currency_supported == Some(true) - && payment_attempt.authentication_type != Some(enums::AuthenticationType::ThreeDs) - && payment_attempt.payment_method == Some(enums::PaymentMethod::Card) - && payment_attempt.payment_method_type == Some(enums::PaymentMethodType::Debit) + && is_currency_supported + && payment_attempt.authentication_type == Some(enums::AuthenticationType::NoThreeDs) + && is_valid_payment_method +} + +fn is_currency_supported( + payment_intent: &hyperswitch_domain_models::payments::PaymentIntent, + debit_routing_config: &settings::DebitRoutingConfig, +) -> bool { + payment_intent + .currency + .map(|currency| { + debit_routing_config + .supported_currencies + .contains(&currency) + }) + .unwrap_or(false) +} + +fn validate_payment_method_for_debit_routing<F: Clone, D>(payment_data: &D) -> bool +where + D: OperationSessionGetters<F> + Send + Sync + Clone, +{ + let payment_attempt = payment_data.get_payment_attempt(); + match payment_attempt.payment_method { + Some(enums::PaymentMethod::Card) => { + payment_attempt.payment_method_type == Some(enums::PaymentMethodType::Debit) + } + Some(enums::PaymentMethod::Wallet) => { + payment_attempt.payment_method_type == Some(enums::PaymentMethodType::ApplePay) + && payment_data + .get_payment_method_data() + .and_then(|data| data.get_wallet_data()) + .and_then(|data| data.get_apple_pay_wallet_data()) + .and_then(|data| data.get_payment_method_type()) + == Some(enums::PaymentMethodType::Debit) + && matches!( + payment_data.get_payment_method_token().cloned(), + Some( + hyperswitch_domain_models::router_data::PaymentMethodToken::ApplePayDecrypt( + _ + ) + ) + ) + } + _ => false, + } } pub async fn check_for_debit_routing_connector_in_profile< @@ -318,8 +361,11 @@ pub async fn get_debit_routing_output< ) -> Option<open_router::DebitRoutingOutput> { logger::debug!("Fetching sorted card networks"); - let (saved_co_badged_card_data, saved_card_type, card_isin) = - extract_saved_card_info(payment_data); + let card_info = extract_card_info(payment_data); + + let saved_co_badged_card_data = card_info.co_badged_card_data; + let saved_card_type = card_info.card_type; + let card_isin = card_info.card_isin; match ( saved_co_badged_card_data @@ -370,48 +416,133 @@ pub async fn get_debit_routing_output< } } -fn extract_saved_card_info<F, D>( - payment_data: &D, -) -> ( - Option<api_models::payment_methods::CoBadgedCardData>, - Option<String>, - Option<Secret<String>>, -) +#[derive(Debug, Clone)] +struct ExtractedCardInfo { + co_badged_card_data: Option<api_models::payment_methods::CoBadgedCardData>, + card_type: Option<String>, + card_isin: Option<Secret<String>>, +} + +impl ExtractedCardInfo { + fn new( + co_badged_card_data: Option<api_models::payment_methods::CoBadgedCardData>, + card_type: Option<String>, + card_isin: Option<Secret<String>>, + ) -> Self { + Self { + co_badged_card_data, + card_type, + card_isin, + } + } + + fn empty() -> Self { + Self::new(None, None, None) + } +} + +fn extract_card_info<F, D>(payment_data: &D) -> ExtractedCardInfo +where + D: OperationSessionGetters<F>, +{ + extract_from_saved_payment_method(payment_data) + .unwrap_or_else(|| extract_from_payment_method_data(payment_data)) +} + +fn extract_from_saved_payment_method<F, D>(payment_data: &D) -> Option<ExtractedCardInfo> where D: OperationSessionGetters<F>, { - let payment_method_data_optional = payment_data.get_payment_method_data(); - match payment_data - .get_payment_method_info() - .and_then(|info| info.get_payment_methods_data()) + let payment_methods_data = payment_data + .get_payment_method_info()? + .get_payment_methods_data()?; + + if let hyperswitch_domain_models::payment_method_data::PaymentMethodsData::Card(card) = + payment_methods_data { - Some(hyperswitch_domain_models::payment_method_data::PaymentMethodsData::Card(card)) => { - match (&card.co_badged_card_data, &card.card_isin) { - (Some(co_badged), _) => { - logger::debug!("Co-badged card data found in saved payment method"); - (Some(co_badged.clone()), card.card_type, None) - } - (None, Some(card_isin)) => { - logger::debug!("No co-badged data; using saved card ISIN"); - (None, None, Some(Secret::new(card_isin.clone()))) - } - _ => (None, None, None), - } + return Some(extract_card_info_from_saved_card(&card)); + } + + None +} + +fn extract_card_info_from_saved_card( + card: &hyperswitch_domain_models::payment_method_data::CardDetailsPaymentMethod, +) -> ExtractedCardInfo { + match (&card.co_badged_card_data, &card.card_isin) { + (Some(co_badged), _) => { + logger::debug!("Co-badged card data found in saved payment method"); + ExtractedCardInfo::new(Some(co_badged.clone()), card.card_type.clone(), None) } - _ => match payment_method_data_optional { - Some(hyperswitch_domain_models::payment_method_data::PaymentMethodData::Card(card)) => { - logger::debug!("Using card data from payment request"); - ( - None, - None, - Some(Secret::new(card.card_number.get_card_isin())), - ) - } - _ => (None, None, None), - }, + (None, Some(card_isin)) => { + logger::debug!("No co-badged data; using saved card ISIN"); + ExtractedCardInfo::new(None, None, Some(Secret::new(card_isin.clone()))) + } + _ => ExtractedCardInfo::empty(), + } +} + +fn extract_from_payment_method_data<F, D>(payment_data: &D) -> ExtractedCardInfo +where + D: OperationSessionGetters<F>, +{ + match payment_data.get_payment_method_data() { + Some(hyperswitch_domain_models::payment_method_data::PaymentMethodData::Card(card)) => { + logger::debug!("Using card data from payment request"); + ExtractedCardInfo::new( + None, + None, + Some(Secret::new(card.card_number.get_extended_card_bin())), + ) + } + Some(hyperswitch_domain_models::payment_method_data::PaymentMethodData::Wallet( + wallet_data, + )) => extract_from_wallet_data(wallet_data, payment_data), + _ => ExtractedCardInfo::empty(), + } +} + +fn extract_from_wallet_data<F, D>( + wallet_data: &hyperswitch_domain_models::payment_method_data::WalletData, + payment_data: &D, +) -> ExtractedCardInfo +where + D: OperationSessionGetters<F>, +{ + match wallet_data { + hyperswitch_domain_models::payment_method_data::WalletData::ApplePay(_) => { + logger::debug!("Using Apple Pay data from payment request"); + let apple_pay_isin = extract_apple_pay_isin(payment_data); + ExtractedCardInfo::new(None, None, apple_pay_isin) + } + _ => ExtractedCardInfo::empty(), } } +fn extract_apple_pay_isin<F, D>(payment_data: &D) -> Option<Secret<String>> +where + D: OperationSessionGetters<F>, +{ + payment_data.get_payment_method_token().and_then(|token| { + if let hyperswitch_domain_models::router_data::PaymentMethodToken::ApplePayDecrypt( + apple_pay_decrypt_data, + ) = token + { + logger::debug!("Using Apple Pay decrypt data from payment method token"); + Some(Secret::new( + apple_pay_decrypt_data + .application_primary_account_number + .peek() + .chars() + .take(8) + .collect::<String>(), + )) + } else { + None + } + }) +} + async fn handle_retryable_connector<F, D>( state: &SessionState, debit_routing_supported_connectors: HashSet<api_enums::Connector>, diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs index cf45d15a5a1..a8f718e2391 100644 --- a/crates/router/src/core/payments.rs +++ b/crates/router/src/core/payments.rs @@ -613,6 +613,17 @@ where ) .await?; + let payment_method_token = get_decrypted_wallet_payment_method_token( + &operation, + state, + merchant_context, + &mut payment_data, + connector.as_ref(), + ) + .await?; + + payment_method_token.map(|token| payment_data.set_payment_method_token(Some(token))); + let (connector, debit_routing_output) = debit_routing::perform_debit_routing( &operation, state, @@ -3522,6 +3533,101 @@ impl PaymentRedirectFlow for PaymentAuthenticateCompleteAuthorize { } } +#[cfg(feature = "v1")] +pub async fn get_decrypted_wallet_payment_method_token<F, Req, D>( + operation: &BoxedOperation<'_, F, Req, D>, + state: &SessionState, + merchant_context: &domain::MerchantContext, + payment_data: &mut D, + connector_call_type_optional: Option<&ConnectorCallType>, +) -> CustomResult<Option<PaymentMethodToken>, errors::ApiErrorResponse> +where + F: Send + Clone + Sync, + D: OperationSessionGetters<F> + Send + Sync + Clone, +{ + if is_operation_confirm(operation) { + let wallet_type = payment_data + .get_payment_attempt() + .payment_method_type + .get_required_value("payment_method_type")?; + + let wallet: Box<dyn WalletFlow<F, D>> = match wallet_type { + storage_enums::PaymentMethodType::ApplePay => Box::new(ApplePayWallet), + storage_enums::PaymentMethodType::Paze => Box::new(PazeWallet), + storage_enums::PaymentMethodType::GooglePay => Box::new(GooglePayWallet), + _ => return Ok(None), + }; + + let merchant_connector_account = + get_merchant_connector_account_for_wallet_decryption_flow::<F, D>( + state, + merchant_context, + payment_data, + connector_call_type_optional, + ) + .await?; + + let decide_wallet_flow = &wallet + .decide_wallet_flow(state, payment_data, &merchant_connector_account) + .attach_printable("Failed to decide wallet flow")? + .async_map(|payment_proce_data| async move { + wallet + .decrypt_wallet_token(&payment_proce_data, payment_data) + .await + }) + .await + .transpose() + .attach_printable("Failed to decrypt Wallet token")?; + Ok(decide_wallet_flow.clone()) + } else { + Ok(None) + } +} + +#[cfg(feature = "v1")] +pub async fn get_merchant_connector_account_for_wallet_decryption_flow<F, D>( + state: &SessionState, + merchant_context: &domain::MerchantContext, + payment_data: &mut D, + connector_call_type_optional: Option<&ConnectorCallType>, +) -> RouterResult<helpers::MerchantConnectorAccountType> +where + F: Send + Clone + Sync, + D: OperationSessionGetters<F> + Send + Sync + Clone, +{ + let connector_call_type = connector_call_type_optional + .get_required_value("connector_call_type") + .change_context(errors::ApiErrorResponse::InternalServerError)?; + let connector_routing_data = match connector_call_type { + ConnectorCallType::PreDetermined(connector_routing_data) => connector_routing_data, + ConnectorCallType::Retryable(connector_routing_datas) => connector_routing_datas + .first() + .ok_or(errors::ApiErrorResponse::InternalServerError) + .attach_printable("Found no connector routing data in retryable call")?, + ConnectorCallType::SessionMultiple(_session_connector_datas) => { + return Err(errors::ApiErrorResponse::InternalServerError).attach_printable( + "SessionMultiple connector call type is invalid in confirm calls", + ); + } + }; + + construct_profile_id_and_get_mca( + state, + merchant_context, + payment_data, + &connector_routing_data + .connector_data + .connector_name + .to_string(), + connector_routing_data + .connector_data + .merchant_connector_id + .as_ref(), + false, + ) + .await +} + #[cfg(feature = "v1")] #[allow(clippy::too_many_arguments)] #[instrument(skip_all)] @@ -3610,13 +3716,7 @@ where router_data.connector_customer = Some(connector_customer_id); } - router_data.payment_method_token = if let Some(decrypted_token) = - add_decrypted_payment_method_token(tokenization_action.clone(), payment_data).await? - { - Some(decrypted_token) - } else { - router_data.payment_method_token - }; + router_data.payment_method_token = payment_data.get_payment_method_token().cloned(); let payment_method_token_response = router_data .add_payment_method_token( @@ -3832,7 +3932,6 @@ where operation, payment_data, validate_result, - &merchant_connector_account, merchant_context.get_merchant_key_store(), customer, business_profile, @@ -4801,134 +4900,273 @@ where Ok(router_data) } +struct ApplePayWallet; +struct PazeWallet; +struct GooglePayWallet; -pub async fn add_decrypted_payment_method_token<F, D>( - tokenization_action: TokenizationAction, - payment_data: &D, -) -> CustomResult<Option<PaymentMethodToken>, errors::ApiErrorResponse> +#[async_trait::async_trait] +pub trait WalletFlow<F, D>: Send + Sync where - F: Send + Clone + Sync, + F: Send + Clone, D: OperationSessionGetters<F> + Send + Sync + Clone, { - // Tokenization Action will be DecryptApplePayToken, only when payment method type is Apple Pay - // and the connector supports Apple Pay predecrypt - match &tokenization_action { - TokenizationAction::DecryptApplePayToken(payment_processing_details) - | TokenizationAction::TokenizeInConnectorAndApplepayPreDecrypt( - payment_processing_details, - ) => { - let apple_pay_data = match payment_data.get_payment_method_data() { - Some(domain::PaymentMethodData::Wallet(domain::WalletData::ApplePay( - wallet_data, - ))) => Some( - ApplePayData::token_json(domain::WalletData::ApplePay(wallet_data.clone())) - .change_context(errors::ApiErrorResponse::InternalServerError) - .attach_printable("failed to parse apple pay token to json")? - .decrypt( - &payment_processing_details.payment_processing_certificate, - &payment_processing_details.payment_processing_certificate_key, - ) - .await - .change_context(errors::ApiErrorResponse::InternalServerError) - .attach_printable("failed to decrypt apple pay token")?, - ), - _ => None, - }; + fn decide_wallet_flow( + &self, + state: &SessionState, + payment_data: &D, + merchant_connector_account: &helpers::MerchantConnectorAccountType, + ) -> CustomResult<Option<DecideWalletFlow>, errors::ApiErrorResponse>; - let apple_pay_predecrypt = apple_pay_data - .parse_value::<hyperswitch_domain_models::router_data::ApplePayPredecryptData>( - "ApplePayPredecryptData", - ) - .change_context(errors::ApiErrorResponse::InternalServerError) - .attach_printable( - "failed to parse decrypted apple pay response to ApplePayPredecryptData", + async fn decrypt_wallet_token( + &self, + wallet_flow: &DecideWalletFlow, + payment_data: &D, + ) -> CustomResult<PaymentMethodToken, errors::ApiErrorResponse>; +} + +#[async_trait::async_trait] +impl<F, D> WalletFlow<F, D> for PazeWallet +where + F: Send + Clone, + D: OperationSessionGetters<F> + Send + Sync + Clone, +{ + fn decide_wallet_flow( + &self, + state: &SessionState, + _payment_data: &D, + _merchant_connector_account: &helpers::MerchantConnectorAccountType, + ) -> CustomResult<Option<DecideWalletFlow>, errors::ApiErrorResponse> { + let paze_keys = state + .conf + .paze_decrypt_keys + .as_ref() + .get_required_value("Paze decrypt keys") + .attach_printable("Paze decrypt keys not found in the configuration")?; + + let wallet_flow = DecideWalletFlow::PazeDecrypt(PazePaymentProcessingDetails { + paze_private_key: paze_keys.get_inner().paze_private_key.clone(), + paze_private_key_passphrase: paze_keys.get_inner().paze_private_key_passphrase.clone(), + }); + Ok(Some(wallet_flow)) + } + + async fn decrypt_wallet_token( + &self, + wallet_flow: &DecideWalletFlow, + payment_data: &D, + ) -> CustomResult<PaymentMethodToken, errors::ApiErrorResponse> { + let paze_payment_processing_details = wallet_flow + .get_paze_payment_processing_details() + .get_required_value("Paze payment processing details") + .attach_printable( + "Paze payment processing details not found in Paze decryption flow", + )?; + + let paze_wallet_data = payment_data + .get_payment_method_data() + .and_then(|payment_method_data| payment_method_data.get_wallet_data()) + .and_then(|wallet_data| wallet_data.get_paze_wallet_data()) + .get_required_value("Paze wallet token").attach_printable( + "Paze wallet data not found in the payment method data during the Paze decryption flow", )?; - Ok(Some(PaymentMethodToken::ApplePayDecrypt(Box::new( - apple_pay_predecrypt, - )))) - } - TokenizationAction::DecryptPazeToken(payment_processing_details) => { - let paze_data = match payment_data.get_payment_method_data() { - Some(domain::PaymentMethodData::Wallet(domain::WalletData::Paze(wallet_data))) => { - Some( - decrypt_paze_token( - wallet_data.clone(), - payment_processing_details.paze_private_key.clone(), - payment_processing_details - .paze_private_key_passphrase - .clone(), - ) - .change_context(errors::ApiErrorResponse::InternalServerError) - .attach_printable("failed to decrypt paze token")?, - ) - } - _ => None, - }; - let paze_decrypted_data = paze_data - .parse_value::<hyperswitch_domain_models::router_data::PazeDecryptedData>( - "PazeDecryptedData", + let paze_data = decrypt_paze_token( + paze_wallet_data.clone(), + paze_payment_processing_details.paze_private_key.clone(), + paze_payment_processing_details + .paze_private_key_passphrase + .clone(), + ) + .change_context(errors::ApiErrorResponse::InternalServerError) + .attach_printable("failed to decrypt paze token")?; + + let paze_decrypted_data = paze_data + .parse_value::<hyperswitch_domain_models::router_data::PazeDecryptedData>( + "PazeDecryptedData", + ) + .change_context(errors::ApiErrorResponse::InternalServerError) + .attach_printable("failed to parse PazeDecryptedData")?; + Ok(PaymentMethodToken::PazeDecrypt(Box::new( + paze_decrypted_data, + ))) + } +} + +#[async_trait::async_trait] +impl<F, D> WalletFlow<F, D> for ApplePayWallet +where + F: Send + Clone, + D: OperationSessionGetters<F> + Send + Sync + Clone, +{ + fn decide_wallet_flow( + &self, + state: &SessionState, + payment_data: &D, + merchant_connector_account: &helpers::MerchantConnectorAccountType, + ) -> CustomResult<Option<DecideWalletFlow>, errors::ApiErrorResponse> { + let apple_pay_metadata = check_apple_pay_metadata(state, Some(merchant_connector_account)); + + add_apple_pay_flow_metrics( + &apple_pay_metadata, + payment_data.get_payment_attempt().connector.clone(), + payment_data.get_payment_attempt().merchant_id.clone(), + ); + + let wallet_flow = match apple_pay_metadata { + Some(domain::ApplePayFlow::Simplified(payment_processing_details)) => Some( + DecideWalletFlow::ApplePayDecrypt(payment_processing_details), + ), + Some(domain::ApplePayFlow::Manual) | None => None, + }; + Ok(wallet_flow) + } + + async fn decrypt_wallet_token( + &self, + wallet_flow: &DecideWalletFlow, + payment_data: &D, + ) -> CustomResult<PaymentMethodToken, errors::ApiErrorResponse> { + let apple_pay_payment_processing_details = wallet_flow + .get_apple_pay_payment_processing_details() + .get_required_value("Apple Pay payment processing details") + .attach_printable( + "Apple Pay payment processing details not found in Apple Pay decryption flow", + )?; + let apple_pay_wallet_data = payment_data + .get_payment_method_data() + .and_then(|payment_method_data| payment_method_data.get_wallet_data()) + .and_then(|wallet_data| wallet_data.get_apple_pay_wallet_data()) + .get_required_value("Paze wallet token").attach_printable( + "Apple Pay wallet data not found in the payment method data during the Apple Pay decryption flow", + )?; + let apple_pay_data = + ApplePayData::token_json(domain::WalletData::ApplePay(apple_pay_wallet_data.clone())) + .change_context(errors::ApiErrorResponse::InternalServerError) + .attach_printable("failed to parse apple pay token to json")? + .decrypt( + &apple_pay_payment_processing_details.payment_processing_certificate, + &apple_pay_payment_processing_details.payment_processing_certificate_key, ) + .await .change_context(errors::ApiErrorResponse::InternalServerError) - .attach_printable("failed to parse PazeDecryptedData")?; - Ok(Some(PaymentMethodToken::PazeDecrypt(Box::new( - paze_decrypted_data, - )))) - } - TokenizationAction::DecryptGooglePayToken(payment_processing_details) => { - let google_pay_data = match payment_data.get_payment_method_data() { - Some(domain::PaymentMethodData::Wallet(domain::WalletData::GooglePay( - wallet_data, - ))) => { - let decryptor = helpers::GooglePayTokenDecryptor::new( - payment_processing_details - .google_pay_root_signing_keys - .clone(), - payment_processing_details.google_pay_recipient_id.clone(), - payment_processing_details.google_pay_private_key.clone(), - ) - .change_context(errors::ApiErrorResponse::InternalServerError) - .attach_printable("failed to create google pay token decryptor")?; + .attach_printable("failed to decrypt apple pay token")?; - // should_verify_token is set to false to disable verification of token - Some( - decryptor - .decrypt_token(wallet_data.tokenization_data.token.clone(), false) - .change_context(errors::ApiErrorResponse::InternalServerError) - .attach_printable("failed to decrypt google pay token")?, - ) - } - Some(payment_method_data) => { - logger::info!( - "Invalid payment_method_data found for Google Pay Decrypt Flow: {:?}", - payment_method_data.get_payment_method() - ); - None - } - None => { - logger::info!("No payment_method_data found for Google Pay Decrypt Flow"); - None - } - }; + let apple_pay_predecrypt = apple_pay_data + .parse_value::<hyperswitch_domain_models::router_data::ApplePayPredecryptData>( + "ApplePayPredecryptData", + ) + .change_context(errors::ApiErrorResponse::InternalServerError) + .attach_printable( + "failed to parse decrypted apple pay response to ApplePayPredecryptData", + )?; - let google_pay_predecrypt = google_pay_data - .ok_or(errors::ApiErrorResponse::InternalServerError) - .attach_printable("failed to get GooglePayDecryptedData in response")?; + Ok(PaymentMethodToken::ApplePayDecrypt(Box::new( + apple_pay_predecrypt, + ))) + } +} + +#[async_trait::async_trait] +impl<F, D> WalletFlow<F, D> for GooglePayWallet +where + F: Send + Clone, + D: OperationSessionGetters<F> + Send + Sync + Clone, +{ + fn decide_wallet_flow( + &self, + state: &SessionState, + _payment_data: &D, + merchant_connector_account: &helpers::MerchantConnectorAccountType, + ) -> CustomResult<Option<DecideWalletFlow>, errors::ApiErrorResponse> { + Ok( + get_google_pay_connector_wallet_details(state, merchant_connector_account) + .map(DecideWalletFlow::GooglePayDecrypt), + ) + } + + async fn decrypt_wallet_token( + &self, + wallet_flow: &DecideWalletFlow, + payment_data: &D, + ) -> CustomResult<PaymentMethodToken, errors::ApiErrorResponse> { + let google_pay_payment_processing_details = wallet_flow + .get_google_pay_payment_processing_details() + .get_required_value("Google Pay payment processing details") + .attach_printable( + "Google Pay payment processing details not found in Google Pay decryption flow", + )?; + + let google_pay_wallet_data = payment_data + .get_payment_method_data() + .and_then(|payment_method_data| payment_method_data.get_wallet_data()) + .and_then(|wallet_data| wallet_data.get_google_pay_wallet_data()) + .get_required_value("Paze wallet token").attach_printable( + "Google Pay wallet data not found in the payment method data during the Google Pay decryption flow", + )?; + + let decryptor = helpers::GooglePayTokenDecryptor::new( + google_pay_payment_processing_details + .google_pay_root_signing_keys + .clone(), + google_pay_payment_processing_details + .google_pay_recipient_id + .clone(), + google_pay_payment_processing_details + .google_pay_private_key + .clone(), + ) + .change_context(errors::ApiErrorResponse::InternalServerError) + .attach_printable("failed to create google pay token decryptor")?; + + // should_verify_token is set to false to disable verification of token + let google_pay_data = decryptor + .decrypt_token( + google_pay_wallet_data.tokenization_data.token.clone(), + false, + ) + .change_context(errors::ApiErrorResponse::InternalServerError) + .attach_printable("failed to decrypt google pay token")?; + + Ok(PaymentMethodToken::GooglePayDecrypt(Box::new( + google_pay_data, + ))) + } +} - Ok(Some(PaymentMethodToken::GooglePayDecrypt(Box::new( - google_pay_predecrypt, - )))) +#[derive(Debug, Clone)] +pub enum DecideWalletFlow { + ApplePayDecrypt(payments_api::PaymentProcessingDetails), + PazeDecrypt(PazePaymentProcessingDetails), + GooglePayDecrypt(GooglePayPaymentProcessingDetails), + SkipDecryption, +} + +impl DecideWalletFlow { + fn get_paze_payment_processing_details(&self) -> Option<&PazePaymentProcessingDetails> { + if let Self::PazeDecrypt(details) = self { + Some(details) + } else { + None } - TokenizationAction::ConnectorToken(_) => { - logger::info!("Invalid tokenization action found for decryption flow: ConnectorToken"); - Ok(None) + } + + fn get_apple_pay_payment_processing_details( + &self, + ) -> Option<&payments_api::PaymentProcessingDetails> { + if let Self::ApplePayDecrypt(details) = self { + Some(details) + } else { + None } - token_action => { - logger::info!( - "Invalid tokenization action found for decryption flow: {:?}", - token_action - ); - Ok(None) + } + + fn get_google_pay_payment_processing_details( + &self, + ) -> Option<&GooglePayPaymentProcessingDetails> { + if let Self::GooglePayDecrypt(details) = self { + Some(details) + } else { + None } } } @@ -5926,7 +6164,7 @@ fn is_payment_method_tokenization_enabled_for_connector( connector_name: &str, payment_method: storage::enums::PaymentMethod, payment_method_type: Option<storage::enums::PaymentMethodType>, - apple_pay_flow: &Option<domain::ApplePayFlow>, + payment_method_token: Option<&PaymentMethodToken>, ) -> RouterResult<bool> { let connector_tokenization_filter = state.conf.tokenization.0.get(connector_name); @@ -5942,7 +6180,7 @@ fn is_payment_method_tokenization_enabled_for_connector( ) && is_apple_pay_pre_decrypt_type_connector_tokenization( payment_method_type, - apple_pay_flow, + payment_method_token, connector_filter.apple_pay_pre_decrypt_flow.clone(), ) }) @@ -5951,13 +6189,13 @@ fn is_payment_method_tokenization_enabled_for_connector( fn is_apple_pay_pre_decrypt_type_connector_tokenization( payment_method_type: Option<storage::enums::PaymentMethodType>, - apple_pay_flow: &Option<domain::ApplePayFlow>, + payment_method_token: Option<&PaymentMethodToken>, apple_pay_pre_decrypt_flow_filter: Option<ApplePayPreDecryptFlow>, ) -> bool { - match (payment_method_type, apple_pay_flow) { + match (payment_method_type, payment_method_token) { ( Some(storage::enums::PaymentMethodType::ApplePay), - Some(domain::ApplePayFlow::Simplified(_)), + Some(PaymentMethodToken::ApplePayDecrypt(..)), ) => !matches!( apple_pay_pre_decrypt_flow_filter, Some(ApplePayPreDecryptFlow::NetworkTokenization) @@ -6142,58 +6380,20 @@ async fn decide_payment_method_tokenize_action( payment_intent_data: payments::PaymentIntent, pm_parent_token: Option<&str>, is_connector_tokenization_enabled: bool, - apple_pay_flow: Option<domain::ApplePayFlow>, - payment_method_type: Option<storage_enums::PaymentMethodType>, - merchant_connector_account: &helpers::MerchantConnectorAccountType, ) -> RouterResult<TokenizationAction> { - if let Some(storage_enums::PaymentMethodType::Paze) = payment_method_type { - // Paze generates a one time use network token which should not be tokenized in the connector or router. - match &state.conf.paze_decrypt_keys { - Some(paze_keys) => Ok(TokenizationAction::DecryptPazeToken( - PazePaymentProcessingDetails { - paze_private_key: paze_keys.get_inner().paze_private_key.clone(), - paze_private_key_passphrase: paze_keys - .get_inner() - .paze_private_key_passphrase - .clone(), - }, - )), - None => Err(errors::ApiErrorResponse::InternalServerError) - .attach_printable("Failed to fetch Paze configs"), - } - } else if let Some(storage_enums::PaymentMethodType::GooglePay) = payment_method_type { - let google_pay_details = - get_google_pay_connector_wallet_details(state, merchant_connector_account); - - match google_pay_details { - Some(wallet_details) => Ok(TokenizationAction::DecryptGooglePayToken(wallet_details)), - None => { - if is_connector_tokenization_enabled { - Ok(TokenizationAction::TokenizeInConnectorAndRouter) - } else { - Ok(TokenizationAction::TokenizeInRouter) - } - } - } - } else if matches!( + if matches!( payment_intent_data.split_payments, Some(common_types::payments::SplitPaymentsRequest::StripeSplitPayment(_)) ) { Ok(TokenizationAction::TokenizeInConnector) } else { match pm_parent_token { - None => Ok(match (is_connector_tokenization_enabled, apple_pay_flow) { - (true, Some(domain::ApplePayFlow::Simplified(payment_processing_details))) => { - TokenizationAction::TokenizeInConnectorAndApplepayPreDecrypt( - payment_processing_details, - ) - } - (true, _) => TokenizationAction::TokenizeInConnectorAndRouter, - (false, Some(domain::ApplePayFlow::Simplified(payment_processing_details))) => { - TokenizationAction::DecryptApplePayToken(payment_processing_details) - } - (false, _) => TokenizationAction::TokenizeInRouter, + None => Ok(if is_connector_tokenization_enabled { + TokenizationAction::TokenizeInConnectorAndRouter + } else { + TokenizationAction::TokenizeInRouter }), + Some(token) => { let redis_conn = state .store @@ -6218,19 +6418,10 @@ async fn decide_payment_method_tokenize_action( Some(connector_token) => { Ok(TokenizationAction::ConnectorToken(connector_token)) } - None => Ok(match (is_connector_tokenization_enabled, apple_pay_flow) { - ( - true, - Some(domain::ApplePayFlow::Simplified(payment_processing_details)), - ) => TokenizationAction::TokenizeInConnectorAndApplepayPreDecrypt( - payment_processing_details, - ), - (true, _) => TokenizationAction::TokenizeInConnectorAndRouter, - ( - false, - Some(domain::ApplePayFlow::Simplified(payment_processing_details)), - ) => TokenizationAction::DecryptApplePayToken(payment_processing_details), - (false, _) => TokenizationAction::TokenizeInRouter, + None => Ok(if is_connector_tokenization_enabled { + TokenizationAction::TokenizeInConnectorAndRouter + } else { + TokenizationAction::TokenizeInRouter }), } } @@ -6258,10 +6449,6 @@ pub enum TokenizationAction { TokenizeInConnectorAndRouter, ConnectorToken(String), SkipConnectorTokenization, - DecryptApplePayToken(payments_api::PaymentProcessingDetails), - TokenizeInConnectorAndApplepayPreDecrypt(payments_api::PaymentProcessingDetails), - DecryptPazeToken(PazePaymentProcessingDetails), - DecryptGooglePayToken(GooglePayPaymentProcessingDetails), } #[cfg(feature = "v2")] @@ -6271,7 +6458,6 @@ pub async fn get_connector_tokenization_action_when_confirm_true<F, Req, D>( _operation: &BoxedOperation<'_, F, Req, D>, payment_data: &mut D, _validate_result: &operations::ValidateResult, - _merchant_connector_account: &helpers::MerchantConnectorAccountType, _merchant_key_store: &domain::MerchantKeyStore, _customer: &Option<domain::Customer>, _business_profile: &domain::Profile, @@ -6292,7 +6478,6 @@ pub async fn get_connector_tokenization_action_when_confirm_true<F, Req, D>( operation: &BoxedOperation<'_, F, Req, D>, payment_data: &mut D, validate_result: &operations::ValidateResult, - merchant_connector_account: &helpers::MerchantConnectorAccountType, merchant_key_store: &domain::MerchantKeyStore, customer: &Option<domain::Customer>, business_profile: &domain::Profile, @@ -6327,24 +6512,15 @@ where .get_required_value("payment_method")?; let payment_method_type = payment_data.get_payment_attempt().payment_method_type; - let apple_pay_flow = - decide_apple_pay_flow(state, payment_method_type, Some(merchant_connector_account)); - let is_connector_tokenization_enabled = is_payment_method_tokenization_enabled_for_connector( state, &connector, payment_method, payment_method_type, - &apple_pay_flow, + payment_data.get_payment_method_token(), )?; - add_apple_pay_flow_metrics( - &apple_pay_flow, - payment_data.get_payment_attempt().connector.clone(), - payment_data.get_payment_attempt().merchant_id.clone(), - ); - let payment_method_action = decide_payment_method_tokenize_action( state, &connector, @@ -6352,9 +6528,6 @@ where payment_data.get_payment_intent().clone(), payment_data.get_token(), is_connector_tokenization_enabled, - apple_pay_flow, - payment_method_type, - merchant_connector_account, ) .await?; @@ -6377,7 +6550,6 @@ where TokenizationAction::SkipConnectorTokenization } - TokenizationAction::TokenizeInConnector => TokenizationAction::TokenizeInConnector, TokenizationAction::TokenizeInConnectorAndRouter => { let (_operation, payment_method_data, pm_id) = operation @@ -6404,22 +6576,6 @@ where TokenizationAction::SkipConnectorTokenization => { TokenizationAction::SkipConnectorTokenization } - TokenizationAction::DecryptApplePayToken(payment_processing_details) => { - TokenizationAction::DecryptApplePayToken(payment_processing_details) - } - TokenizationAction::TokenizeInConnectorAndApplepayPreDecrypt( - payment_processing_details, - ) => TokenizationAction::TokenizeInConnectorAndApplepayPreDecrypt( - payment_processing_details, - ), - TokenizationAction::DecryptPazeToken(paze_payment_processing_details) => { - TokenizationAction::DecryptPazeToken(paze_payment_processing_details) - } - TokenizationAction::DecryptGooglePayToken( - google_pay_payment_processing_details, - ) => { - TokenizationAction::DecryptGooglePayToken(google_pay_payment_processing_details) - } }; (payment_data.to_owned(), connector_tokenization_action) } @@ -6520,6 +6676,7 @@ where pub force_sync: Option<bool>, pub all_keys_required: Option<bool>, pub payment_method_data: Option<domain::PaymentMethodData>, + pub payment_method_token: Option<PaymentMethodToken>, pub payment_method_info: Option<domain::PaymentMethod>, pub refunds: Vec<diesel_refund::Refund>, pub disputes: Vec<storage::Dispute>, @@ -9405,6 +9562,7 @@ pub trait OperationSessionGetters<F> { #[cfg(feature = "v2")] fn get_client_secret(&self) -> &Option<Secret<String>>; fn get_payment_method_info(&self) -> Option<&domain::PaymentMethod>; + fn get_payment_method_token(&self) -> Option<&PaymentMethodToken>; fn get_mandate_id(&self) -> Option<&payments_api::MandateIds>; fn get_address(&self) -> &PaymentAddress; fn get_creds_identifier(&self) -> Option<&str>; @@ -9470,6 +9628,7 @@ pub trait OperationSessionSetters<F> { fn set_client_secret(&mut self, client_secret: Option<Secret<String>>); fn set_payment_attempt(&mut self, payment_attempt: storage::PaymentAttempt); fn set_payment_method_data(&mut self, payment_method_data: Option<domain::PaymentMethodData>); + fn set_payment_method_token(&mut self, payment_method_token: Option<PaymentMethodToken>); fn set_email_if_not_present(&mut self, email: pii::Email); fn set_payment_method_id_in_attempt(&mut self, payment_method_id: Option<String>); fn set_pm_token(&mut self, token: String); @@ -9553,6 +9712,10 @@ impl<F: Clone> OperationSessionGetters<F> for PaymentData<F> { self.payment_method_info.as_ref() } + fn get_payment_method_token(&self) -> Option<&PaymentMethodToken> { + self.payment_method_token.as_ref() + } + fn get_mandate_id(&self) -> Option<&payments_api::MandateIds> { self.mandate_id.as_ref() } @@ -9717,6 +9880,10 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentData<F> { self.payment_method_data = payment_method_data; } + fn set_payment_method_token(&mut self, payment_method_token: Option<PaymentMethodToken>) { + self.payment_method_token = payment_method_token; + } + fn set_payment_method_id_in_attempt(&mut self, payment_method_id: Option<String>) { self.payment_attempt.payment_method_id = payment_method_id; } @@ -9749,10 +9916,24 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentData<F> { } fn set_card_network(&mut self, card_network: enums::CardNetwork) { - if let Some(domain::PaymentMethodData::Card(card)) = &mut self.payment_method_data { - logger::debug!("set card network {:?}", card_network.clone()); - card.card_network = Some(card_network); - }; + match &mut self.payment_method_data { + Some(domain::PaymentMethodData::Card(card)) => { + logger::debug!("Setting card network: {:?}", card_network); + card.card_network = Some(card_network); + } + Some(domain::PaymentMethodData::Wallet(wallet_data)) => match wallet_data { + hyperswitch_domain_models::payment_method_data::WalletData::ApplePay(wallet) => { + logger::debug!("Setting Apple Pay card network: {:?}", card_network); + wallet.payment_method.network = card_network.to_string(); + } + _ => { + logger::debug!("Wallet type does not support setting card network."); + } + }, + _ => { + logger::warn!("Payment method data does not support setting card network."); + } + } } fn set_co_badged_card_data( @@ -9878,6 +10059,10 @@ impl<F: Clone> OperationSessionGetters<F> for PaymentIntentData<F> { todo!() } + fn get_payment_method_token(&self) -> Option<&PaymentMethodToken> { + todo!() + } + fn get_mandate_id(&self) -> Option<&payments_api::MandateIds> { todo!() } @@ -10042,6 +10227,10 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentIntentData<F> { todo!() } + fn set_payment_method_token(&mut self, _payment_method_token: Option<PaymentMethodToken>) { + todo!() + } + fn set_payment_method_id_in_attempt(&mut self, _payment_method_id: Option<String>) { todo!() } @@ -10179,6 +10368,10 @@ impl<F: Clone> OperationSessionGetters<F> for PaymentConfirmData<F> { todo!() } + fn get_payment_method_token(&self) -> Option<&PaymentMethodToken> { + todo!() + } + fn get_mandate_id(&self) -> Option<&payments_api::MandateIds> { todo!() } @@ -10340,6 +10533,10 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentConfirmData<F> { todo!() } + fn set_payment_method_token(&mut self, _payment_method_token: Option<PaymentMethodToken>) { + todo!() + } + fn set_payment_method_id_in_attempt(&mut self, _payment_method_id: Option<String>) { todo!() } @@ -10478,6 +10675,10 @@ impl<F: Clone> OperationSessionGetters<F> for PaymentStatusData<F> { todo!() } + fn get_payment_method_token(&self) -> Option<&PaymentMethodToken> { + todo!() + } + fn get_mandate_id(&self) -> Option<&payments_api::MandateIds> { todo!() } @@ -10635,6 +10836,10 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentStatusData<F> { todo!() } + fn set_payment_method_token(&mut self, _payment_method_token: Option<PaymentMethodToken>) { + todo!() + } + fn set_payment_method_id_in_attempt(&mut self, _payment_method_id: Option<String>) { todo!() } @@ -10772,6 +10977,10 @@ impl<F: Clone> OperationSessionGetters<F> for PaymentCaptureData<F> { todo!() } + fn get_payment_method_token(&self) -> Option<&PaymentMethodToken> { + todo!() + } + fn get_mandate_id(&self) -> Option<&payments_api::MandateIds> { todo!() } @@ -10931,6 +11140,10 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentCaptureData<F> { todo!() } + fn set_payment_method_token(&mut self, _payment_method_token: Option<PaymentMethodToken>) { + todo!() + } + fn set_payment_method_id_in_attempt(&mut self, _payment_method_id: Option<String>) { todo!() } @@ -11063,6 +11276,10 @@ impl<F: Clone> OperationSessionGetters<F> for PaymentAttemptListData<F> { todo!() } + fn get_payment_method_token(&self) -> Option<&PaymentMethodToken> { + todo!() + } + fn get_mandate_id(&self) -> Option<&payments_api::MandateIds> { todo!() } diff --git a/crates/router/src/core/payments/operations/payment_approve.rs b/crates/router/src/core/payments/operations/payment_approve.rs index a16c2cd433f..8beac4097a9 100644 --- a/crates/router/src/core/payments/operations/payment_approve.rs +++ b/crates/router/src/core/payments/operations/payment_approve.rs @@ -173,6 +173,7 @@ impl<F: Send + Clone + Sync> GetTracker<F, PaymentData<F>, api::PaymentsCaptureR ), confirm: None, payment_method_data: None, + payment_method_token: None, payment_method_info: None, force_sync: None, all_keys_required: None, diff --git a/crates/router/src/core/payments/operations/payment_cancel.rs b/crates/router/src/core/payments/operations/payment_cancel.rs index 343c1f98a9d..dfe3657b0f7 100644 --- a/crates/router/src/core/payments/operations/payment_cancel.rs +++ b/crates/router/src/core/payments/operations/payment_cancel.rs @@ -184,6 +184,7 @@ impl<F: Send + Clone + Sync> GetTracker<F, PaymentData<F>, api::PaymentsCancelRe ), confirm: None, payment_method_data: None, + payment_method_token: None, payment_method_info: None, force_sync: None, all_keys_required: None, diff --git a/crates/router/src/core/payments/operations/payment_capture.rs b/crates/router/src/core/payments/operations/payment_capture.rs index 8e3a765b8ad..6108ed3658f 100644 --- a/crates/router/src/core/payments/operations/payment_capture.rs +++ b/crates/router/src/core/payments/operations/payment_capture.rs @@ -235,6 +235,7 @@ impl<F: Send + Clone + Sync> GetTracker<F, payments::PaymentData<F>, api::Paymen ), confirm: None, payment_method_data: None, + payment_method_token: None, payment_method_info: None, refunds: vec![], disputes: vec![], diff --git a/crates/router/src/core/payments/operations/payment_complete_authorize.rs b/crates/router/src/core/payments/operations/payment_complete_authorize.rs index 3ce888e6574..38a189e50fd 100644 --- a/crates/router/src/core/payments/operations/payment_complete_authorize.rs +++ b/crates/router/src/core/payments/operations/payment_complete_authorize.rs @@ -332,6 +332,7 @@ impl<F: Send + Clone + Sync> GetTracker<F, PaymentData<F>, api::PaymentsRequest> .payment_method_data .as_ref() .and_then(|pmd| pmd.payment_method_data.clone().map(Into::into)), + payment_method_token: None, payment_method_info, force_sync: None, all_keys_required: None, diff --git a/crates/router/src/core/payments/operations/payment_confirm.rs b/crates/router/src/core/payments/operations/payment_confirm.rs index 2aa1a72e73f..abbdc1f5c75 100644 --- a/crates/router/src/core/payments/operations/payment_confirm.rs +++ b/crates/router/src/core/payments/operations/payment_confirm.rs @@ -795,6 +795,7 @@ impl<F: Send + Clone + Sync> GetTracker<F, PaymentData<F>, api::PaymentsRequest> token_data, confirm: request.confirm, payment_method_data: payment_method_data_after_card_bin_call.map(Into::into), + payment_method_token: None, payment_method_info, force_sync: None, all_keys_required: None, diff --git a/crates/router/src/core/payments/operations/payment_create.rs b/crates/router/src/core/payments/operations/payment_create.rs index a73796075a5..1c3a8a0be9a 100644 --- a/crates/router/src/core/payments/operations/payment_create.rs +++ b/crates/router/src/core/payments/operations/payment_create.rs @@ -598,6 +598,7 @@ impl<F: Send + Clone + Sync> GetTracker<F, PaymentData<F>, api::PaymentsRequest> token_data: None, confirm: request.confirm, payment_method_data: payment_method_data_after_card_bin_call.map(Into::into), + payment_method_token: None, payment_method_info, refunds: vec![], disputes: vec![], diff --git a/crates/router/src/core/payments/operations/payment_post_session_tokens.rs b/crates/router/src/core/payments/operations/payment_post_session_tokens.rs index 3df1da1827e..b1543be1544 100644 --- a/crates/router/src/core/payments/operations/payment_post_session_tokens.rs +++ b/crates/router/src/core/payments/operations/payment_post_session_tokens.rs @@ -145,6 +145,7 @@ impl<F: Send + Clone + Sync> GetTracker<F, PaymentData<F>, api::PaymentsPostSess ), confirm: None, payment_method_data: None, + payment_method_token: None, payment_method_info: None, force_sync: None, all_keys_required: None, diff --git a/crates/router/src/core/payments/operations/payment_reject.rs b/crates/router/src/core/payments/operations/payment_reject.rs index 33ec9a0d592..f963baa87c1 100644 --- a/crates/router/src/core/payments/operations/payment_reject.rs +++ b/crates/router/src/core/payments/operations/payment_reject.rs @@ -171,6 +171,7 @@ impl<F: Send + Clone + Sync> GetTracker<F, PaymentData<F>, PaymentsCancelRequest token_data: None, confirm: None, payment_method_data: None, + payment_method_token: None, payment_method_info: None, force_sync: None, all_keys_required: None, diff --git a/crates/router/src/core/payments/operations/payment_session.rs b/crates/router/src/core/payments/operations/payment_session.rs index b0a5f2fc133..8a7c22376a0 100644 --- a/crates/router/src/core/payments/operations/payment_session.rs +++ b/crates/router/src/core/payments/operations/payment_session.rs @@ -193,6 +193,7 @@ impl<F: Send + Clone + Sync> GetTracker<F, PaymentData<F>, api::PaymentsSessionR ), confirm: None, payment_method_data: None, + payment_method_token: None, payment_method_info: None, force_sync: None, all_keys_required: None, diff --git a/crates/router/src/core/payments/operations/payment_start.rs b/crates/router/src/core/payments/operations/payment_start.rs index e702ba1ef50..9727fb399d2 100644 --- a/crates/router/src/core/payments/operations/payment_start.rs +++ b/crates/router/src/core/payments/operations/payment_start.rs @@ -181,6 +181,7 @@ impl<F: Send + Clone + Sync> GetTracker<F, PaymentData<F>, api::PaymentsStartReq confirm: Some(payment_attempt.confirm), payment_attempt, payment_method_data: None, + payment_method_token: None, payment_method_info: None, force_sync: None, all_keys_required: None, diff --git a/crates/router/src/core/payments/operations/payment_status.rs b/crates/router/src/core/payments/operations/payment_status.rs index ac2a7b923fd..c6488bdb75c 100644 --- a/crates/router/src/core/payments/operations/payment_status.rs +++ b/crates/router/src/core/payments/operations/payment_status.rs @@ -517,6 +517,7 @@ async fn get_tracker_for_sync< token_data: None, confirm: Some(request.force_sync), payment_method_data: None, + payment_method_token: None, payment_method_info, force_sync: Some( request.force_sync diff --git a/crates/router/src/core/payments/operations/payment_update.rs b/crates/router/src/core/payments/operations/payment_update.rs index 2299acbe304..0b77e5c31c4 100644 --- a/crates/router/src/core/payments/operations/payment_update.rs +++ b/crates/router/src/core/payments/operations/payment_update.rs @@ -475,6 +475,7 @@ impl<F: Send + Clone + Sync> GetTracker<F, PaymentData<F>, api::PaymentsRequest> .payment_method_data .as_ref() .and_then(|pmd| pmd.payment_method_data.clone().map(Into::into)), + payment_method_token: None, payment_method_info, force_sync: None, all_keys_required: None, diff --git a/crates/router/src/core/payments/operations/payment_update_metadata.rs b/crates/router/src/core/payments/operations/payment_update_metadata.rs index 2c6841c44a4..23a300c3c8b 100644 --- a/crates/router/src/core/payments/operations/payment_update_metadata.rs +++ b/crates/router/src/core/payments/operations/payment_update_metadata.rs @@ -131,6 +131,7 @@ impl<F: Send + Clone + Sync> GetTracker<F, PaymentData<F>, api::PaymentsUpdateMe address: payments::PaymentAddress::new(None, None, None, None), confirm: None, payment_method_data: None, + payment_method_token: None, payment_method_info: None, force_sync: None, all_keys_required: None, diff --git a/crates/router/src/core/payments/operations/payments_incremental_authorization.rs b/crates/router/src/core/payments/operations/payments_incremental_authorization.rs index e5262d092c1..a32f89ef4d3 100644 --- a/crates/router/src/core/payments/operations/payments_incremental_authorization.rs +++ b/crates/router/src/core/payments/operations/payments_incremental_authorization.rs @@ -145,6 +145,7 @@ impl<F: Send + Clone + Sync> address: PaymentAddress::new(None, None, None, None), confirm: None, payment_method_data: None, + payment_method_token: None, payment_method_info: None, force_sync: None, all_keys_required: None, diff --git a/crates/router/src/core/payments/operations/tax_calculation.rs b/crates/router/src/core/payments/operations/tax_calculation.rs index 85ad5fb1cb6..9f0863e6767 100644 --- a/crates/router/src/core/payments/operations/tax_calculation.rs +++ b/crates/router/src/core/payments/operations/tax_calculation.rs @@ -160,6 +160,7 @@ impl<F: Send + Clone + Sync> ), confirm: None, payment_method_data: None, + payment_method_token: None, payment_method_info: None, force_sync: None, all_keys_required: None, diff --git a/crates/router/src/core/payments/tokenization.rs b/crates/router/src/core/payments/tokenization.rs index f4389bc1738..d6578ad36c7 100644 --- a/crates/router/src/core/payments/tokenization.rs +++ b/crates/router/src/core/payments/tokenization.rs @@ -1253,8 +1253,7 @@ pub async fn add_payment_method_token<F: Clone, T: types::Tokenizable + Clone>( ) -> RouterResult<types::PaymentMethodTokenResult> { if should_continue_payment { match tokenization_action { - payments::TokenizationAction::TokenizeInConnector - | payments::TokenizationAction::TokenizeInConnectorAndApplepayPreDecrypt(_) => { + payments::TokenizationAction::TokenizeInConnector => { let connector_integration: services::BoxedPaymentConnectorIntegrationInterface< api::PaymentMethodToken, types::PaymentMethodTokenizationData,

2025-07-17T07:05:49Z

## Type of Change  - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  This pull request adds debit routing support for Apple Pay. In the Apple Pay decryption flow, if debit routing is enabled by the merchant and the card type is debit, a call will be made to the decision engine to retrieve the supported card networks and the potential debit routing savings. Among these networks, the lowest-cost network will be selected to process the Apple Pay payment. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  ## How did you test it?  -> enable debit routing and make a apple pay payment ``` curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_tT5kUVUp7uaQHR2Z824Iy7393nL5sEWLxAvJblCxxmttLizAkJbWtsdgoIjdGQE2' \ --data-raw '{ "amount": 650, "currency": "USD", "confirm": true, "business_country": "US", "business_label": "default", "amount_to_capture": 650, "customer_id": "cu_1752747625", "capture_method": "automatic", "capture_on": "2022-09-10T10:11:12Z", "setup_future_usage": "on_session", "authentication_type": "no_three_ds", "return_url": "https://google.com", "email": "[email protected]", "name": "Joseph Doe", "phone": "999999999", "phone_country_code": "+65", "description": "Its my first payment request", "statement_descriptor_name": "Juspay", "statement_descriptor_suffix": "Router", "payment_method": "wallet", "payment_method_type": "apple_pay", "billing": { "address": { "line1": "1467", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" }, "phone": { "number": "8056594427", "country_code": "+91" } }, "customer_acceptance": { "acceptance_type": "offline", "accepted_at": "1963-05-03T04:07:52.723Z", "online": { "ip_address": "in sit", "user_agent": "amet irure esse" } } , "payment_method_data": { "wallet": { "apple_pay": { "payment_data": "==", "payment_method": { "display_name": "Discover 9319", "network": "Discover", "type": "debit" }, "transaction_identifier": "c635c5b3af900d7bd81fecd7028f1262f9d030754ee65ec7afd988a678194751" } } } }' ``` ``` { "payment_id": "pay_O0EoroDslloH3cVj5Xc5", "merchant_id": "merchant_1752747413", "status": "succeeded", "amount": 650, "net_amount": 650, "shipping_cost": null, "amount_capturable": 0, "amount_received": 650, "connector": "adyen", "client_secret": "pay_O0EoroDslloH3cVj5Xc5_secret_mEciQ25Sjl46cuShfITO", "created": "2025-07-17T10:18:35.495Z", "currency": "USD", "customer_id": "cu_1752747515", "customer": { "id": "cu_1752747515", "name": "Joseph Doe", "email": "[email protected]", "phone": "999999999", "phone_country_code": "+65" }, "description": "Its my first payment request", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": "on_session", "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "wallet", "payment_method_data": { "wallet": { "apple_pay": { "last4": "9319", "card_network": "Accel", "type": "debit" } }, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": null, "line3": null, "zip": "94122", "state": "California", "first_name": "joseph", "last_name": "Doe" }, "phone": { "number": "8056594427", "country_code": "+91" }, "email": null }, "order_details": null, "email": "[email protected]", "name": "Joseph Doe", "phone": "999999999", "return_url": "https://google.com/", "authentication_type": "no_three_ds", "statement_descriptor_name": "Juspay", "statement_descriptor_suffix": "Router", "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "apple_pay", "connector_label": "adyen_US_default", "business_country": "US", "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": { "customer_id": "cu_1752747515", "created_at": 1752747515, "expires": 1752751115, "secret": "epk_e7dc207a6f124b47a191ba2daf803e6b" }, "manual_retry_allowed": false, "connector_transaction_id": "P3TQQMQMMQ6M5375", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_O0EoroDslloH3cVj5Xc5_1", "payment_link": null, "profile_id": "pro_0BT05CUisTpwMzBcK4wf", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_dITrhiR4JCNaaJFsaPGH", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-07-17T10:33:35.495Z", "fingerprint": null, "browser_info": null, "payment_method_id": null, "payment_method_status": null, "updated": "2025-07-17T10:18:40.793Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": null, "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` -> Decision engine lookup using 8 digits bin with padded 0s for lookup <img width="1382" height="303" alt="image" src="https://github.com/user-attachments/assets/84305a47-c56c-46e5-bb4e-685e51d7e736" /> ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

bf8dc4959eab4e2a2ca8120055ff80900418fe0b

juspay/hyperswitch

juspay__hyperswitch-8668

Bug: [REFACTOR] : Add feature metadata in payments response Currently we are adding feature metadata in the Payment Response. We'll incrementally populate the fields

diff --git a/api-reference/v2/openapi_spec_v2.json b/api-reference/v2/openapi_spec_v2.json index 285a21ba04c..7b4f04a2292 100644 --- a/api-reference/v2/openapi_spec_v2.json +++ b/api-reference/v2/openapi_spec_v2.json @@ -10838,7 +10838,7 @@ ], "nullable": true }, - "payment_revenue_recovery_metadata": { + "revenue_recovery": { "allOf": [ { "$ref": "#/components/schemas/PaymentRevenueRecoveryMetadata" @@ -19319,6 +19319,14 @@ "type": "string", "description": "Stringified connector raw response body. Only returned if `return_raw_connector_response` is true", "nullable": true + }, + "feature_metadata": { + "allOf": [ + { + "$ref": "#/components/schemas/FeatureMetadata" + } + ], + "nullable": true } } }, diff --git a/crates/api_models/src/payments.rs b/crates/api_models/src/payments.rs index f3d7d9b675c..cef094a98d5 100644 --- a/crates/api_models/src/payments.rs +++ b/crates/api_models/src/payments.rs @@ -5808,6 +5808,9 @@ pub struct PaymentsResponse { /// Stringified connector raw response body. Only returned if `return_raw_connector_response` is true #[schema(value_type = Option<String>)] pub raw_connector_response: Option<Secret<String>>, + + /// Additional data that might be required by hyperswitch based on the additional features. + pub feature_metadata: Option<FeatureMetadata>, } #[cfg(feature = "v2")] @@ -7823,13 +7826,13 @@ pub struct FeatureMetadata { /// Recurring payment details required for apple pay Merchant Token pub apple_pay_recurring_details: Option<ApplePayRecurringDetails>, /// revenue recovery data for payment intent - pub payment_revenue_recovery_metadata: Option<PaymentRevenueRecoveryMetadata>, + pub revenue_recovery: Option<PaymentRevenueRecoveryMetadata>, } #[cfg(feature = "v2")] impl FeatureMetadata { pub fn get_retry_count(&self) -> Option<u16> { - self.payment_revenue_recovery_metadata + self.revenue_recovery .as_ref() .map(|metadata| metadata.total_retry_count) } @@ -7842,7 +7845,7 @@ impl FeatureMetadata { redirect_response: self.redirect_response, search_tags: self.search_tags, apple_pay_recurring_details: self.apple_pay_recurring_details, - payment_revenue_recovery_metadata: Some(payment_revenue_recovery_metadata), + revenue_recovery: Some(payment_revenue_recovery_metadata), } } } diff --git a/crates/hyperswitch_domain_models/src/lib.rs b/crates/hyperswitch_domain_models/src/lib.rs index 35f619334c3..fd24c3d9f4b 100644 --- a/crates/hyperswitch_domain_models/src/lib.rs +++ b/crates/hyperswitch_domain_models/src/lib.rs @@ -145,7 +145,7 @@ impl ApiModelToDieselModelConvertor<ApiFeatureMetadata> for FeatureMetadata { redirect_response, search_tags, apple_pay_recurring_details, - payment_revenue_recovery_metadata, + revenue_recovery: payment_revenue_recovery_metadata, } = from; Self { @@ -172,8 +172,7 @@ impl ApiModelToDieselModelConvertor<ApiFeatureMetadata> for FeatureMetadata { search_tags, apple_pay_recurring_details: apple_pay_recurring_details .map(|value| value.convert_back()), - payment_revenue_recovery_metadata: payment_revenue_recovery_metadata - .map(|value| value.convert_back()), + revenue_recovery: payment_revenue_recovery_metadata.map(|value| value.convert_back()), } } } diff --git a/crates/router/src/core/payments/transformers.rs b/crates/router/src/core/payments/transformers.rs index 1df3b6ef293..6785e429984 100644 --- a/crates/router/src/core/payments/transformers.rs +++ b/crates/router/src/core/payments/transformers.rs @@ -1989,6 +1989,7 @@ where is_iframe_redirection_enabled: None, merchant_reference_id: payment_intent.merchant_reference_id.clone(), raw_connector_response, + feature_metadata: None, }; Ok(services::ApplicationResponse::JsonWithHeaders(( @@ -2089,6 +2090,7 @@ where is_iframe_redirection_enabled: payment_intent.is_iframe_redirection_enabled, merchant_reference_id: payment_intent.merchant_reference_id.clone(), raw_connector_response, + feature_metadata: None, }; Ok(services::ApplicationResponse::JsonWithHeaders(( @@ -5215,7 +5217,7 @@ impl ForeignFrom<&diesel_models::types::FeatureMetadata> for api_models::payment .clone() .map(api_models::payments::RedirectResponse::foreign_from); Self { - payment_revenue_recovery_metadata: revenue_recovery, + revenue_recovery, apple_pay_recurring_details: apple_pay_details, redirect_response: redirect_res, search_tags: feature_metadata.search_tags.clone(),

2025-07-16T14:37:24Z

## Type of Change  - [ ] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description Add feature_metadata in the payments response for revenue recovery in v2. Also added it in the open api spec ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  ## How did you test it? - Create a Org and MA and MCA in v2 - Create a payment in v2 ``` curl --location 'http://localhost:8080/v2/payments/create-intent' \ --header 'api-key: dev_RvJ0UsrpfypkXccsGyytfee97LjWGSymDBIoR2K1zpxmUvaDScyXr9e4QH5cSUKc' \ --header 'Content-Type: application/json' \ --header 'x-profile-id: pro_xwf1Kn6sgcq34ih9HHPa' \ --header 'Authorization: api-key=dev_RvJ0UsrpfypkXccsGyytfee97LjWGSymDBIoR2K1zpxmUvaDScyXr9e4QH5cSUKc' \ --data-raw '{ "amount_details": { "order_amount": 100, "currency": "USD" }, "capture_method": "manual", "authentication_type": "no_three_ds", "billing": { "address": { "first_name": "John", "last_name": "Dough" }, "email": "[email protected]" }, "shipping": { "address": { "first_name": "John", "last_name": "Dough", "city": "Karwar", "zip": "581301", "state": "Karnataka" }, "email": "[email protected]" } }' ``` - Confirm the payment ``` Request curl --location 'http://localhost:8080/v2/payments/12345_pay_019813ec28f073d38d5fe2d117a0a660/confirm-intent' \ --header 'x-client-secret: cs_019813ec291571039181693bb212e6dd' \ --header 'x-profile-id: pro_xwf1Kn6sgcq34ih9HHPa' \ --header 'Authorization: api-key=dev_RvJ0UsrpfypkXccsGyytfee97LjWGSymDBIoR2K1zpxmUvaDScyXr9e4QH5cSUKc' \ --header 'Content-Type: application/json' \ --header 'api-key: dev_RvJ0UsrpfypkXccsGyytfee97LjWGSymDBIoR2K1zpxmUvaDScyXr9e4QH5cSUKc' \ --data '{ "payment_method_data": { "card": { "card_number": "4242424242424242", "card_exp_month": "01", "card_exp_year": "25", "card_holder_name": "John Doe", "card_cvc": "100" } }, "payment_method_type": "card", "payment_method_subtype": "credit" }' ``` - Feature Metadata would be present ``` Response { "id": "12345_pay_019813ec28f073d38d5fe2d117a0a660", "status": "failed", "amount": { "order_amount": 100, "currency": "USD", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null, "net_amount": 100, "amount_to_capture": null, "amount_capturable": 0, "amount_captured": null }, "customer_id": null, "connector": "stripe", "created": "2025-07-16T15:48:20.872Z", "payment_method_data": { "billing": null }, "payment_method_type": "card", "payment_method_subtype": "credit", "connector_transaction_id": null, "connector_reference_id": null, "merchant_connector_id": "mca_to621nCh9AUHtzEEgQWp", "browser_info": null, "error": { "code": "No error code", "message": "No error message", "unified_code": null, "unified_message": null, "network_advice_code": null, "network_decline_code": null, "network_error_message": null }, "shipping": null, "billing": null, "attempts": null, "connector_token_details": null, "payment_method_id": null, "next_action": null, "return_url": "https://google.com/success", "authentication_type": "no_three_ds", "authentication_type_applied": "no_three_ds", "is_iframe_redirection_enabled": null, "merchant_reference_id": null, "raw_connector_response": null, "feature_metadata": null } ``` ## Checklist  - [ ] I formatted the code `cargo +nightly fmt --all` - [ ] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

9bc02516d6ca4ce1a998f0a7c800ca1eaa078ad7

juspay/hyperswitch

juspay__hyperswitch-8674

Bug: [FEATURE] TRUSTPAYMENTS Template Code ### Feature Description TRUSTPAYMENTS Template Code ### Possible Implementation [FEATURE] TRUSTPAYMENTS Template Code ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? None

diff --git a/config/config.example.toml b/config/config.example.toml index 9454b3f0adc..cf514a273d6 100644 --- a/config/config.example.toml +++ b/config/config.example.toml @@ -297,6 +297,7 @@ thunes.base_url = "https://api.limonetikqualif.com/" tokenio.base_url = "https://api.sandbox.token.io" stripe.base_url_file_upload = "https://files.stripe.com/" trustpay.base_url = "https://test-tpgw.trustpay.eu/" +trustpayments.base_url = "https://webservices.securetrading.net/" trustpay.base_url_bank_redirects = "https://aapi.trustpay.eu/" tsys.base_url = "https://stagegw.transnox.com/" unified_authentication_service.base_url = "http://localhost:8000" diff --git a/config/deployments/integration_test.toml b/config/deployments/integration_test.toml index ddff65fa9c0..d9194dfa9c7 100644 --- a/config/deployments/integration_test.toml +++ b/config/deployments/integration_test.toml @@ -133,6 +133,7 @@ taxjar.base_url = "https://api.sandbox.taxjar.com/v2/" thunes.base_url = "https://api.limonetikqualif.com/" tokenio.base_url = "https://api.sandbox.token.io" trustpay.base_url = "https://test-tpgw.trustpay.eu/" +trustpayments.base_url = "https://webservices.securetrading.net/" trustpay.base_url_bank_redirects = "https://aapi.trustpay.eu/" tsys.base_url = "https://stagegw.transnox.com/" vgs.base_url = "https://sandbox.vault-api.verygoodvault.com" diff --git a/config/deployments/production.toml b/config/deployments/production.toml index 11d96d6269f..ca52d4d39f3 100644 --- a/config/deployments/production.toml +++ b/config/deployments/production.toml @@ -137,6 +137,7 @@ taxjar.base_url = "https://api.taxjar.com/v2/" thunes.base_url = "https://api.limonetik.com/" tokenio.base_url = "https://api.token.io" trustpay.base_url = "https://tpgw.trustpay.eu/" +trustpayments.base_url = "https://webservices.securetrading.net/" trustpay.base_url_bank_redirects = "https://aapi.trustpay.eu/" tsys.base_url = "https://gateway.transit-pass.com/" vgs.base_url = "https://sandbox.vault-api.verygoodvault.com" diff --git a/config/deployments/sandbox.toml b/config/deployments/sandbox.toml index a372c873c78..c7f3949075d 100644 --- a/config/deployments/sandbox.toml +++ b/config/deployments/sandbox.toml @@ -137,6 +137,7 @@ taxjar.base_url = "https://api.sandbox.taxjar.com/v2/" thunes.base_url = "https://api.limonetikqualif.com/" tokenio.base_url = "https://api.sandbox.token.io" trustpay.base_url = "https://test-tpgw.trustpay.eu/" +trustpayments.base_url = "https://webservices.securetrading.net/" trustpay.base_url_bank_redirects = "https://aapi.trustpay.eu/" tsys.base_url = "https://stagegw.transnox.com/" vgs.base_url = "https://sandbox.vault-api.verygoodvault.com" diff --git a/config/development.toml b/config/development.toml index 173d9363f2a..ab5029f80be 100644 --- a/config/development.toml +++ b/config/development.toml @@ -343,6 +343,7 @@ worldpayvantiv.secondary_base_url = "https://onlinessr.vantivprelive.com" worldpayxml.base_url = "https://secure-test.worldpay.com/jsp/merchant/xml/paymentService.jsp" xendit.base_url = "https://api.xendit.co" trustpay.base_url = "https://test-tpgw.trustpay.eu/" +trustpayments.base_url = "https://webservices.securetrading.net/" tsys.base_url = "https://stagegw.transnox.com/" unified_authentication_service.base_url = "http://localhost:8000/" vgs.base_url = "https://sandbox.vault-api.verygoodvault.com" diff --git a/config/docker_compose.toml b/config/docker_compose.toml index 01abf5e8137..3ef11162a4b 100644 --- a/config/docker_compose.toml +++ b/config/docker_compose.toml @@ -223,6 +223,7 @@ thunes.base_url = "https://api.limonetikqualif.com/" tokenio.base_url = "https://api.sandbox.token.io" stripe.base_url_file_upload = "https://files.stripe.com/" trustpay.base_url = "https://test-tpgw.trustpay.eu/" +trustpayments.base_url = "https://webservices.securetrading.net/" trustpay.base_url_bank_redirects = "https://aapi.trustpay.eu/" tsys.base_url = "https://stagegw.transnox.com/" unified_authentication_service.base_url = "http://localhost:8000" diff --git a/crates/connector_configs/src/connector.rs b/crates/connector_configs/src/connector.rs index 61736a42edf..b6f992db1b5 100644 --- a/crates/connector_configs/src/connector.rs +++ b/crates/connector_configs/src/connector.rs @@ -273,6 +273,7 @@ pub struct ConnectorConfig { pub signifyd: Option<ConnectorTomlConfig>, pub tokenio: Option<ConnectorTomlConfig>, pub trustpay: Option<ConnectorTomlConfig>, + pub trustpayments: Option<ConnectorTomlConfig>, pub threedsecureio: Option<ConnectorTomlConfig>, pub netcetera: Option<ConnectorTomlConfig>, pub tsys: Option<ConnectorTomlConfig>, diff --git a/crates/connector_configs/toml/development.toml b/crates/connector_configs/toml/development.toml index 9e493eb6a54..9e77383604d 100644 --- a/crates/connector_configs/toml/development.toml +++ b/crates/connector_configs/toml/development.toml @@ -6342,6 +6342,10 @@ api_key = "API Key" [blackhawknetwork.connector_auth.HeaderKey] api_key = "API Key" +[trustpayments] +[trustpayments.connector_auth.HeaderKey] +api_key = "API Key" + [breadpay] [breadpay.connector_auth.HeaderKey] api_key = "API Key" diff --git a/crates/connector_configs/toml/production.toml b/crates/connector_configs/toml/production.toml index e81c3f6aac9..84ff257594b 100644 --- a/crates/connector_configs/toml/production.toml +++ b/crates/connector_configs/toml/production.toml @@ -4947,6 +4947,10 @@ key1 = "Secret Key" [affirm.connector_auth.HeaderKey] api_key = "API Key" +[trustpayments] +[trustpayments.connector_auth.HeaderKey] +api_key = "API Key" + [blackhawknetwork] [blackhawknetwork.connector_auth.HeaderKey] api_key = "API Key" diff --git a/crates/connector_configs/toml/sandbox.toml b/crates/connector_configs/toml/sandbox.toml index bdd9cde57f0..5492de4ff48 100644 --- a/crates/connector_configs/toml/sandbox.toml +++ b/crates/connector_configs/toml/sandbox.toml @@ -6317,6 +6317,10 @@ key1 = "Secret Key" [affirm.connector_auth.HeaderKey] api_key = "API Key" +[trustpayments] +[trustpayments.connector_auth.HeaderKey] +api_key = "API Key" + [blackhawknetwork] [blackhawknetwork.connector_auth.HeaderKey] api_key = "API Key" diff --git a/crates/hyperswitch_connectors/src/connectors.rs b/crates/hyperswitch_connectors/src/connectors.rs index bc2313fb0fb..61210b10f01 100644 --- a/crates/hyperswitch_connectors/src/connectors.rs +++ b/crates/hyperswitch_connectors/src/connectors.rs @@ -102,6 +102,7 @@ pub mod threedsecureio; pub mod thunes; pub mod tokenio; pub mod trustpay; +pub mod trustpayments; pub mod tsys; pub mod unified_authentication_service; pub mod vgs; @@ -143,7 +144,8 @@ pub use self::{ santander::Santander, shift4::Shift4, signifyd::Signifyd, silverflow::Silverflow, square::Square, stax::Stax, stripe::Stripe, stripebilling::Stripebilling, taxjar::Taxjar, threedsecureio::Threedsecureio, thunes::Thunes, tokenio::Tokenio, trustpay::Trustpay, - tsys::Tsys, unified_authentication_service::UnifiedAuthenticationService, vgs::Vgs, volt::Volt, + trustpayments::Trustpayments, tsys::Tsys, + unified_authentication_service::UnifiedAuthenticationService, vgs::Vgs, volt::Volt, wellsfargo::Wellsfargo, wellsfargopayout::Wellsfargopayout, wise::Wise, worldline::Worldline, worldpay::Worldpay, worldpayvantiv::Worldpayvantiv, worldpayxml::Worldpayxml, xendit::Xendit, zen::Zen, zsl::Zsl, diff --git a/crates/hyperswitch_connectors/src/connectors/trustpayments.rs b/crates/hyperswitch_connectors/src/connectors/trustpayments.rs new file mode 100644 index 00000000000..0b4ad2b1b1f --- /dev/null +++ b/crates/hyperswitch_connectors/src/connectors/trustpayments.rs @@ -0,0 +1,632 @@ +pub mod transformers; + +use std::sync::LazyLock; + +use common_enums::enums; +use common_utils::{ + errors::CustomResult, + ext_traits::BytesExt, + request::{Method, Request, RequestBuilder, RequestContent}, + types::{AmountConvertor, StringMinorUnit, StringMinorUnitForConnector}, +}; +use error_stack::{report, ResultExt}; +use hyperswitch_domain_models::{ + payment_method_data::PaymentMethodData, + router_data::{AccessToken, ConnectorAuthType, ErrorResponse, RouterData}, + router_flow_types::{ + access_token_auth::AccessTokenAuth, + payments::{Authorize, Capture, PSync, PaymentMethodToken, Session, SetupMandate, Void}, + refunds::{Execute, RSync}, + }, + router_request_types::{ + AccessTokenRequestData, PaymentMethodTokenizationData, PaymentsAuthorizeData, + PaymentsCancelData, PaymentsCaptureData, PaymentsSessionData, PaymentsSyncData, + RefundsData, SetupMandateRequestData, + }, + router_response_types::{ + ConnectorInfo, PaymentsResponseData, RefundsResponseData, SupportedPaymentMethods, + }, + types::{ + PaymentsAuthorizeRouterData, PaymentsCaptureRouterData, PaymentsSyncRouterData, + RefundSyncRouterData, RefundsRouterData, + }, +}; +use hyperswitch_interfaces::{ + api::{ + self, ConnectorCommon, ConnectorCommonExt, ConnectorIntegration, ConnectorSpecifications, + ConnectorValidation, + }, + configs::Connectors, + errors, + events::connector_api_logs::ConnectorEvent, + types::{self, Response}, + webhooks, +}; +use masking::{ExposeInterface, Mask}; +use transformers as trustpayments; + +use crate::{constants::headers, types::ResponseRouterData, utils}; + +#[derive(Clone)] +pub struct Trustpayments { + amount_converter: &'static (dyn AmountConvertor<Output = StringMinorUnit> + Sync), +} + +impl Trustpayments { + pub fn new() -> &'static Self { + &Self { + amount_converter: &StringMinorUnitForConnector, + } + } +} + +impl api::Payment for Trustpayments {} +impl api::PaymentSession for Trustpayments {} +impl api::ConnectorAccessToken for Trustpayments {} +impl api::MandateSetup for Trustpayments {} +impl api::PaymentAuthorize for Trustpayments {} +impl api::PaymentSync for Trustpayments {} +impl api::PaymentCapture for Trustpayments {} +impl api::PaymentVoid for Trustpayments {} +impl api::Refund for Trustpayments {} +impl api::RefundExecute for Trustpayments {} +impl api::RefundSync for Trustpayments {} +impl api::PaymentToken for Trustpayments {} + +impl ConnectorIntegration<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData> + for Trustpayments +{ + // Not Implemented (R) +} + +impl<Flow, Request, Response> ConnectorCommonExt<Flow, Request, Response> for Trustpayments +where + Self: ConnectorIntegration<Flow, Request, Response>, +{ + fn build_headers( + &self, + req: &RouterData<Flow, Request, Response>, + _connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + let mut header = vec![( + headers::CONTENT_TYPE.to_string(), + self.get_content_type().to_string().into(), + )]; + let mut api_key = self.get_auth_header(&req.connector_auth_type)?; + header.append(&mut api_key); + Ok(header) + } +} + +impl ConnectorCommon for Trustpayments { + fn id(&self) -> &'static str { + "trustpayments" + } + + fn get_currency_unit(&self) -> api::CurrencyUnit { + // todo!() + api::CurrencyUnit::Minor + + // TODO! Check connector documentation, on which unit they are processing the currency. + // If the connector accepts amount in lower unit ( i.e cents for USD) then return api::CurrencyUnit::Minor, + // if connector accepts amount in base unit (i.e dollars for USD) then return api::CurrencyUnit::Base + } + + fn common_get_content_type(&self) -> &'static str { + "application/json" + } + + fn base_url<'a>(&self, connectors: &'a Connectors) -> &'a str { + connectors.trustpayments.base_url.as_ref() + } + + fn get_auth_header( + &self, + auth_type: &ConnectorAuthType, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + let auth = trustpayments::TrustpaymentsAuthType::try_from(auth_type) + .change_context(errors::ConnectorError::FailedToObtainAuthType)?; + Ok(vec![( + headers::AUTHORIZATION.to_string(), + auth.api_key.expose().into_masked(), + )]) + } + + fn build_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + let response: trustpayments::TrustpaymentsErrorResponse = res + .response + .parse_struct("TrustpaymentsErrorResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + + Ok(ErrorResponse { + status_code: res.status_code, + code: response.code, + message: response.message, + reason: response.reason, + attempt_status: None, + connector_transaction_id: None, + network_advice_code: None, + network_decline_code: None, + network_error_message: None, + }) + } +} + +impl ConnectorValidation for Trustpayments { + fn validate_mandate_payment( + &self, + _pm_type: Option<enums::PaymentMethodType>, + pm_data: PaymentMethodData, + ) -> CustomResult<(), errors::ConnectorError> { + match pm_data { + PaymentMethodData::Card(_) => Err(errors::ConnectorError::NotImplemented( + "validate_mandate_payment does not support cards".to_string(), + ) + .into()), + _ => Ok(()), + } + } + + fn validate_psync_reference_id( + &self, + _data: &PaymentsSyncData, + _is_three_ds: bool, + _status: enums::AttemptStatus, + _connector_meta_data: Option<common_utils::pii::SecretSerdeValue>, + ) -> CustomResult<(), errors::ConnectorError> { + Ok(()) + } +} + +impl ConnectorIntegration<Session, PaymentsSessionData, PaymentsResponseData> for Trustpayments { + //TODO: implement sessions flow +} + +impl ConnectorIntegration<AccessTokenAuth, AccessTokenRequestData, AccessToken> for Trustpayments {} + +impl ConnectorIntegration<SetupMandate, SetupMandateRequestData, PaymentsResponseData> + for Trustpayments +{ +} + +impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData> + for Trustpayments +{ + fn get_headers( + &self, + req: &PaymentsAuthorizeRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsAuthorizeRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn get_request_body( + &self, + req: &PaymentsAuthorizeRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let amount = utils::convert_amount( + self.amount_converter, + req.request.minor_amount, + req.request.currency, + )?; + + let connector_router_data = trustpayments::TrustpaymentsRouterData::from((amount, req)); + let connector_req = + trustpayments::TrustpaymentsPaymentsRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &PaymentsAuthorizeRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::PaymentsAuthorizeType::get_url( + self, req, connectors, + )?) + .attach_default_headers() + .headers(types::PaymentsAuthorizeType::get_headers( + self, req, connectors, + )?) + .set_body(types::PaymentsAuthorizeType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsAuthorizeRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsAuthorizeRouterData, errors::ConnectorError> { + let response: trustpayments::TrustpaymentsPaymentsResponse = res + .response + .parse_struct("Trustpayments PaymentsAuthorizeResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<PSync, PaymentsSyncData, PaymentsResponseData> for Trustpayments { + fn get_headers( + &self, + req: &PaymentsSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsSyncRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn build_request( + &self, + req: &PaymentsSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Get) + .url(&types::PaymentsSyncType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::PaymentsSyncType::get_headers(self, req, connectors)?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsSyncRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsSyncRouterData, errors::ConnectorError> { + let response: trustpayments::TrustpaymentsPaymentsResponse = res + .response + .parse_struct("trustpayments PaymentsSyncResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<Capture, PaymentsCaptureData, PaymentsResponseData> for Trustpayments { + fn get_headers( + &self, + req: &PaymentsCaptureRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsCaptureRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn get_request_body( + &self, + _req: &PaymentsCaptureRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_request_body method".to_string()).into()) + } + + fn build_request( + &self, + req: &PaymentsCaptureRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::PaymentsCaptureType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::PaymentsCaptureType::get_headers( + self, req, connectors, + )?) + .set_body(types::PaymentsCaptureType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsCaptureRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsCaptureRouterData, errors::ConnectorError> { + let response: trustpayments::TrustpaymentsPaymentsResponse = res + .response + .parse_struct("Trustpayments PaymentsCaptureResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<Void, PaymentsCancelData, PaymentsResponseData> for Trustpayments {} + +impl ConnectorIntegration<Execute, RefundsData, RefundsResponseData> for Trustpayments { + fn get_headers( + &self, + req: &RefundsRouterData<Execute>, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &RefundsRouterData<Execute>, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn get_request_body( + &self, + req: &RefundsRouterData<Execute>, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let refund_amount = utils::convert_amount( + self.amount_converter, + req.request.minor_refund_amount, + req.request.currency, + )?; + + let connector_router_data = + trustpayments::TrustpaymentsRouterData::from((refund_amount, req)); + let connector_req = + trustpayments::TrustpaymentsRefundRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &RefundsRouterData<Execute>, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + let request = RequestBuilder::new() + .method(Method::Post) + .url(&types::RefundExecuteType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::RefundExecuteType::get_headers( + self, req, connectors, + )?) + .set_body(types::RefundExecuteType::get_request_body( + self, req, connectors, + )?) + .build(); + Ok(Some(request)) + } + + fn handle_response( + &self, + data: &RefundsRouterData<Execute>, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<RefundsRouterData<Execute>, errors::ConnectorError> { + let response: trustpayments::RefundResponse = res + .response + .parse_struct("trustpayments RefundResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<RSync, RefundsData, RefundsResponseData> for Trustpayments { + fn get_headers( + &self, + req: &RefundSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &RefundSyncRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn build_request( + &self, + req: &RefundSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Get) + .url(&types::RefundSyncType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::RefundSyncType::get_headers(self, req, connectors)?) + .set_body(types::RefundSyncType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &RefundSyncRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<RefundSyncRouterData, errors::ConnectorError> { + let response: trustpayments::RefundResponse = res + .response + .parse_struct("trustpayments RefundSyncResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +#[async_trait::async_trait] +impl webhooks::IncomingWebhook for Trustpayments { + fn get_webhook_object_reference_id( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<api_models::webhooks::ObjectReferenceId, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } + + fn get_webhook_event_type( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<api_models::webhooks::IncomingWebhookEvent, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } + + fn get_webhook_resource_object( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<Box<dyn masking::ErasedMaskSerialize>, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } +} + +static TRUSTPAYMENTS_SUPPORTED_PAYMENT_METHODS: LazyLock<SupportedPaymentMethods> = + LazyLock::new(SupportedPaymentMethods::new); + +static TRUSTPAYMENTS_CONNECTOR_INFO: ConnectorInfo = ConnectorInfo { + display_name: "Trustpayments", + description: "Trustpayments connector", + connector_type: enums::PaymentConnectorCategory::PaymentGateway, +}; + +static TRUSTPAYMENTS_SUPPORTED_WEBHOOK_FLOWS: [enums::EventClass; 0] = []; + +impl ConnectorSpecifications for Trustpayments { + fn get_connector_about(&self) -> Option<&'static ConnectorInfo> { + Some(&TRUSTPAYMENTS_CONNECTOR_INFO) + } + + fn get_supported_payment_methods(&self) -> Option<&'static SupportedPaymentMethods> { + Some(&*TRUSTPAYMENTS_SUPPORTED_PAYMENT_METHODS) + } + + fn get_supported_webhook_flows(&self) -> Option<&'static [enums::EventClass]> { + Some(&TRUSTPAYMENTS_SUPPORTED_WEBHOOK_FLOWS) + } +} diff --git a/crates/hyperswitch_connectors/src/connectors/trustpayments/transformers.rs b/crates/hyperswitch_connectors/src/connectors/trustpayments/transformers.rs new file mode 100644 index 00000000000..debeca6b63a --- /dev/null +++ b/crates/hyperswitch_connectors/src/connectors/trustpayments/transformers.rs @@ -0,0 +1,223 @@ +use common_enums::enums; +use common_utils::types::StringMinorUnit; +use hyperswitch_domain_models::{ + payment_method_data::PaymentMethodData, + router_data::{ConnectorAuthType, RouterData}, + router_flow_types::refunds::{Execute, RSync}, + router_request_types::ResponseId, + router_response_types::{PaymentsResponseData, RefundsResponseData}, + types::{PaymentsAuthorizeRouterData, RefundsRouterData}, +}; +use hyperswitch_interfaces::errors; +use masking::Secret; +use serde::{Deserialize, Serialize}; + +use crate::types::{RefundsResponseRouterData, ResponseRouterData}; + +//TODO: Fill the struct with respective fields +pub struct TrustpaymentsRouterData<T> { + pub amount: StringMinorUnit, // The type of amount that a connector accepts, for example, String, i64, f64, etc. + pub router_data: T, +} + +impl<T> From<(StringMinorUnit, T)> for TrustpaymentsRouterData<T> { + fn from((amount, item): (StringMinorUnit, T)) -> Self { + //Todo : use utils to convert the amount to the type of amount that a connector accepts + Self { + amount, + router_data: item, + } + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Serialize, PartialEq)] +pub struct TrustpaymentsPaymentsRequest { + amount: StringMinorUnit, + card: TrustpaymentsCard, +} + +#[derive(Default, Debug, Serialize, Eq, PartialEq)] +pub struct TrustpaymentsCard { + number: cards::CardNumber, + expiry_month: Secret<String>, + expiry_year: Secret<String>, + cvc: Secret<String>, + complete: bool, +} + +impl TryFrom<&TrustpaymentsRouterData<&PaymentsAuthorizeRouterData>> + for TrustpaymentsPaymentsRequest +{ + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: &TrustpaymentsRouterData<&PaymentsAuthorizeRouterData>, + ) -> Result<Self, Self::Error> { + match item.router_data.request.payment_method_data.clone() { + PaymentMethodData::Card(_) => Err(errors::ConnectorError::NotImplemented( + "Card payment method not implemented".to_string(), + ) + .into()), + _ => Err(errors::ConnectorError::NotImplemented("Payment method".to_string()).into()), + } + } +} + +//TODO: Fill the struct with respective fields +// Auth Struct +pub struct TrustpaymentsAuthType { + pub(super) api_key: Secret<String>, +} + +impl TryFrom<&ConnectorAuthType> for TrustpaymentsAuthType { + 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, Copy, Default, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "lowercase")] +pub enum TrustpaymentsPaymentStatus { + Succeeded, + Failed, + #[default] + Processing, +} + +impl From<TrustpaymentsPaymentStatus> for common_enums::AttemptStatus { + fn from(item: TrustpaymentsPaymentStatus) -> Self { + match item { + TrustpaymentsPaymentStatus::Succeeded => Self::Charged, + TrustpaymentsPaymentStatus::Failed => Self::Failure, + TrustpaymentsPaymentStatus::Processing => Self::Authorizing, + } + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] +pub struct TrustpaymentsPaymentsResponse { + status: TrustpaymentsPaymentStatus, + id: String, +} + +impl<F, T> TryFrom<ResponseRouterData<F, TrustpaymentsPaymentsResponse, T, PaymentsResponseData>> + for RouterData<F, T, PaymentsResponseData> +{ + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: ResponseRouterData<F, TrustpaymentsPaymentsResponse, T, PaymentsResponseData>, + ) -> Result<Self, Self::Error> { + Ok(Self { + status: common_enums::AttemptStatus::from(item.response.status), + response: Ok(PaymentsResponseData::TransactionResponse { + resource_id: ResponseId::ConnectorTransactionId(item.response.id), + redirection_data: Box::new(None), + mandate_reference: Box::new(None), + connector_metadata: None, + network_txn_id: None, + connector_response_reference_id: None, + incremental_authorization_allowed: None, + charges: None, + }), + ..item.data + }) + } +} + +//TODO: Fill the struct with respective fields +// REFUND : +// Type definition for RefundRequest +#[derive(Default, Debug, Serialize)] +pub struct TrustpaymentsRefundRequest { + pub amount: StringMinorUnit, +} + +impl<F> TryFrom<&TrustpaymentsRouterData<&RefundsRouterData<F>>> for TrustpaymentsRefundRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: &TrustpaymentsRouterData<&RefundsRouterData<F>>, + ) -> Result<Self, Self::Error> { + Ok(Self { + amount: item.amount.to_owned(), + }) + } +} + +// Type definition for Refund Response + +#[allow(dead_code)] +#[derive(Debug, Copy, Serialize, Default, Deserialize, Clone)] +pub enum RefundStatus { + Succeeded, + Failed, + #[default] + Processing, +} + +impl From<RefundStatus> for enums::RefundStatus { + fn from(item: RefundStatus) -> Self { + match item { + RefundStatus::Succeeded => Self::Success, + RefundStatus::Failed => Self::Failure, + RefundStatus::Processing => Self::Pending, + //TODO: Review mapping + } + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Clone, Serialize, Deserialize)] +pub struct RefundResponse { + id: String, + status: RefundStatus, +} + +impl TryFrom<RefundsResponseRouterData<Execute, RefundResponse>> for RefundsRouterData<Execute> { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: RefundsResponseRouterData<Execute, RefundResponse>, + ) -> Result<Self, Self::Error> { + Ok(Self { + response: Ok(RefundsResponseData { + connector_refund_id: item.response.id.to_string(), + refund_status: enums::RefundStatus::from(item.response.status), + }), + ..item.data + }) + } +} + +impl TryFrom<RefundsResponseRouterData<RSync, RefundResponse>> for RefundsRouterData<RSync> { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: RefundsResponseRouterData<RSync, RefundResponse>, + ) -> Result<Self, Self::Error> { + Ok(Self { + response: Ok(RefundsResponseData { + connector_refund_id: item.response.id.to_string(), + refund_status: enums::RefundStatus::from(item.response.status), + }), + ..item.data + }) + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Serialize, Deserialize, PartialEq)] +pub struct TrustpaymentsErrorResponse { + pub status_code: u16, + pub code: String, + pub message: String, + pub reason: Option<String>, + pub network_advice_code: Option<String>, + pub network_decline_code: Option<String>, + pub network_error_message: Option<String>, +} diff --git a/crates/hyperswitch_connectors/src/default_implementations.rs b/crates/hyperswitch_connectors/src/default_implementations.rs index d015acc6b86..c43658a0c19 100644 --- a/crates/hyperswitch_connectors/src/default_implementations.rs +++ b/crates/hyperswitch_connectors/src/default_implementations.rs @@ -243,6 +243,7 @@ default_imp_for_authorize_session_token!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::Wise, connectors::Worldline, @@ -373,6 +374,7 @@ default_imp_for_calculate_tax!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Volt, @@ -515,6 +517,7 @@ default_imp_for_session_update!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::Deutschebank, connectors::Volt, @@ -644,6 +647,7 @@ default_imp_for_post_session_tokens!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Deutschebank, @@ -775,6 +779,7 @@ default_imp_for_create_order!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Deutschebank, @@ -907,6 +912,7 @@ default_imp_for_update_metadata!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Deutschebank, @@ -1016,6 +1022,7 @@ default_imp_for_complete_authorize!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -1146,6 +1153,7 @@ default_imp_for_incremental_authorization!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wellsfargopayout, @@ -1274,6 +1282,7 @@ default_imp_for_create_customer!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -1308,6 +1317,7 @@ macro_rules! default_imp_for_connector_redirect_response { } default_imp_for_connector_redirect_response!( + connectors::Trustpayments, connectors::Vgs, connectors::Aci, connectors::Adyen, @@ -1420,6 +1430,7 @@ macro_rules! default_imp_for_pre_processing_steps{ } default_imp_for_pre_processing_steps!( + connectors::Trustpayments, connectors::Silverflow, connectors::Vgs, connectors::Aci, @@ -1642,6 +1653,7 @@ default_imp_for_post_processing_steps!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -1776,6 +1788,7 @@ default_imp_for_approve!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -1910,6 +1923,7 @@ default_imp_for_reject!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -2043,6 +2057,7 @@ default_imp_for_webhook_source_verification!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -2176,6 +2191,7 @@ default_imp_for_accept_dispute!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -2307,6 +2323,7 @@ default_imp_for_submit_evidence!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -2439,6 +2456,7 @@ default_imp_for_defend_dispute!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -2579,6 +2597,7 @@ default_imp_for_file_upload!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -2697,6 +2716,7 @@ default_imp_for_payouts!( connectors::Threedsecureio, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Volt, @@ -2827,6 +2847,7 @@ default_imp_for_payouts_create!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Worldline, @@ -2960,6 +2981,7 @@ default_imp_for_payouts_retrieve!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -3093,6 +3115,7 @@ default_imp_for_payouts_eligibility!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Worldline, @@ -3220,6 +3243,7 @@ default_imp_for_payouts_fulfill!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Worldline, @@ -3351,6 +3375,7 @@ default_imp_for_payouts_cancel!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Worldline, @@ -3484,6 +3509,7 @@ default_imp_for_payouts_quote!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Worldline, @@ -3616,6 +3642,7 @@ default_imp_for_payouts_recipient!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Worldline, @@ -3749,6 +3776,7 @@ default_imp_for_payouts_recipient_account!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -3883,6 +3911,7 @@ default_imp_for_frm_sale!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -4017,6 +4046,7 @@ default_imp_for_frm_checkout!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -4151,6 +4181,7 @@ default_imp_for_frm_transaction!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -4285,6 +4316,7 @@ default_imp_for_frm_fulfillment!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -4419,6 +4451,7 @@ default_imp_for_frm_record_return!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -4549,6 +4582,7 @@ default_imp_for_revoking_mandates!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -4681,6 +4715,7 @@ default_imp_for_uas_pre_authentication!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::Wise, connectors::Worldline, @@ -4812,6 +4847,7 @@ default_imp_for_uas_post_authentication!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::Wise, connectors::Worldline, @@ -4944,6 +4980,7 @@ default_imp_for_uas_authentication_confirmation!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::Wise, connectors::Worldline, @@ -5067,6 +5104,7 @@ default_imp_for_connector_request_id!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -5193,6 +5231,7 @@ default_imp_for_fraud_check!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -5348,6 +5387,7 @@ default_imp_for_connector_authentication!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -5479,6 +5519,7 @@ default_imp_for_uas_authentication!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::Wise, connectors::Wellsfargo, @@ -5604,6 +5645,7 @@ default_imp_for_revenue_recovery!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -5738,6 +5780,7 @@ default_imp_for_billing_connector_payment_sync!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -5871,6 +5914,7 @@ default_imp_for_revenue_recovery_record_back!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -6005,6 +6049,7 @@ default_imp_for_billing_connector_invoice_sync!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -6132,6 +6177,7 @@ default_imp_for_external_vault!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -6265,6 +6311,7 @@ default_imp_for_external_vault_insert!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -6398,6 +6445,7 @@ default_imp_for_external_vault_retrieve!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -6531,6 +6579,7 @@ default_imp_for_external_vault_delete!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -6663,6 +6712,7 @@ default_imp_for_external_vault_create!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, diff --git a/crates/hyperswitch_connectors/src/default_implementations_v2.rs b/crates/hyperswitch_connectors/src/default_implementations_v2.rs index 1978e47c0ab..11e56101bd3 100644 --- a/crates/hyperswitch_connectors/src/default_implementations_v2.rs +++ b/crates/hyperswitch_connectors/src/default_implementations_v2.rs @@ -349,6 +349,7 @@ default_imp_for_new_connector_integration_payment!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -483,6 +484,7 @@ default_imp_for_new_connector_integration_refund!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wellsfargo, @@ -612,6 +614,7 @@ default_imp_for_new_connector_integration_connector_access_token!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -746,6 +749,7 @@ default_imp_for_new_connector_integration_accept_dispute!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -879,6 +883,7 @@ default_imp_for_new_connector_integration_submit_evidence!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -1013,6 +1018,7 @@ default_imp_for_new_connector_integration_defend_dispute!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -1157,6 +1163,7 @@ default_imp_for_new_connector_integration_file_upload!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -1293,6 +1300,7 @@ default_imp_for_new_connector_integration_payouts_create!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -1429,6 +1437,7 @@ default_imp_for_new_connector_integration_payouts_eligibility!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -1565,6 +1574,7 @@ default_imp_for_new_connector_integration_payouts_fulfill!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -1701,6 +1711,7 @@ default_imp_for_new_connector_integration_payouts_cancel!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -1837,6 +1848,7 @@ default_imp_for_new_connector_integration_payouts_quote!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -1973,6 +1985,7 @@ default_imp_for_new_connector_integration_payouts_recipient!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -2109,6 +2122,7 @@ default_imp_for_new_connector_integration_payouts_sync!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -2245,6 +2259,7 @@ default_imp_for_new_connector_integration_payouts_recipient_account!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -2379,6 +2394,7 @@ default_imp_for_new_connector_integration_webhook_source_verification!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -2515,6 +2531,7 @@ default_imp_for_new_connector_integration_frm_sale!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -2651,6 +2668,7 @@ default_imp_for_new_connector_integration_frm_checkout!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -2787,6 +2805,7 @@ default_imp_for_new_connector_integration_frm_transaction!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -2923,6 +2942,7 @@ default_imp_for_new_connector_integration_frm_fulfillment!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -3059,6 +3079,7 @@ default_imp_for_new_connector_integration_frm_record_return!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -3191,6 +3212,7 @@ default_imp_for_new_connector_integration_revoking_mandates!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Wise, @@ -3217,6 +3239,7 @@ macro_rules! default_imp_for_new_connector_integration_frm { #[cfg(feature = "frm")] default_imp_for_new_connector_integration_frm!( + connectors::Trustpayments, connectors::Affirm, connectors::Vgs, connectors::Airwallex, @@ -3350,6 +3373,7 @@ macro_rules! default_imp_for_new_connector_integration_connector_authentication } default_imp_for_new_connector_integration_connector_authentication!( + connectors::Trustpayments, connectors::Affirm, connectors::Vgs, connectors::Airwallex, @@ -3472,6 +3496,7 @@ macro_rules! default_imp_for_new_connector_integration_revenue_recovery { } default_imp_for_new_connector_integration_revenue_recovery!( + connectors::Trustpayments, connectors::Affirm, connectors::Vgs, connectors::Airwallex, @@ -3706,6 +3731,7 @@ default_imp_for_new_connector_integration_external_vault!( connectors::Thunes, connectors::Tokenio, connectors::Trustpay, + connectors::Trustpayments, connectors::Tsys, connectors::UnifiedAuthenticationService, connectors::Vgs, diff --git a/crates/hyperswitch_domain_models/src/connector_endpoints.rs b/crates/hyperswitch_domain_models/src/connector_endpoints.rs index 00f4b9d1e53..ca3c6479dd3 100644 --- a/crates/hyperswitch_domain_models/src/connector_endpoints.rs +++ b/crates/hyperswitch_domain_models/src/connector_endpoints.rs @@ -117,6 +117,7 @@ pub struct Connectors { pub thunes: ConnectorParams, pub tokenio: ConnectorParams, pub trustpay: ConnectorParamsWithMoreUrls, + pub trustpayments: ConnectorParams, pub tsys: ConnectorParams, pub unified_authentication_service: ConnectorParams, pub vgs: ConnectorParams, diff --git a/crates/router/src/connector.rs b/crates/router/src/connector.rs index 5252df7f921..2d7cdbaa21f 100644 --- a/crates/router/src/connector.rs +++ b/crates/router/src/connector.rs @@ -38,10 +38,11 @@ pub use hyperswitch_connectors::connectors::{ signifyd::Signifyd, silverflow, silverflow::Silverflow, square, square::Square, stax, stax::Stax, stripe, stripe::Stripe, stripebilling, stripebilling::Stripebilling, taxjar, taxjar::Taxjar, threedsecureio, threedsecureio::Threedsecureio, thunes, thunes::Thunes, - tokenio, tokenio::Tokenio, trustpay, trustpay::Trustpay, tsys, tsys::Tsys, - unified_authentication_service, unified_authentication_service::UnifiedAuthenticationService, - vgs, vgs::Vgs, volt, volt::Volt, wellsfargo, wellsfargo::Wellsfargo, wellsfargopayout, - wellsfargopayout::Wellsfargopayout, wise, wise::Wise, worldline, worldline::Worldline, - worldpay, worldpay::Worldpay, worldpayvantiv, worldpayvantiv::Worldpayvantiv, worldpayxml, - worldpayxml::Worldpayxml, xendit, xendit::Xendit, zen, zen::Zen, zsl, zsl::Zsl, + tokenio, tokenio::Tokenio, trustpay, trustpay::Trustpay, trustpayments, + trustpayments::Trustpayments, tsys, tsys::Tsys, unified_authentication_service, + unified_authentication_service::UnifiedAuthenticationService, vgs, vgs::Vgs, volt, volt::Volt, + wellsfargo, wellsfargo::Wellsfargo, wellsfargopayout, wellsfargopayout::Wellsfargopayout, wise, + wise::Wise, worldline, worldline::Worldline, worldpay, worldpay::Worldpay, worldpayvantiv, + worldpayvantiv::Worldpayvantiv, worldpayxml, worldpayxml::Worldpayxml, xendit, xendit::Xendit, + zen, zen::Zen, zsl, zsl::Zsl, }; diff --git a/crates/router/tests/connectors/main.rs b/crates/router/tests/connectors/main.rs index c448950eeca..babb7284c76 100644 --- a/crates/router/tests/connectors/main.rs +++ b/crates/router/tests/connectors/main.rs @@ -102,6 +102,7 @@ mod stripebilling; mod taxjar; mod tokenio; mod trustpay; +mod trustpayments; mod tsys; mod unified_authentication_service; mod utils; diff --git a/crates/router/tests/connectors/trustpayments.rs b/crates/router/tests/connectors/trustpayments.rs new file mode 100644 index 00000000000..7d07b825aac --- /dev/null +++ b/crates/router/tests/connectors/trustpayments.rs @@ -0,0 +1,421 @@ +use hyperswitch_domain_models::payment_method_data::{Card, PaymentMethodData}; +use masking::Secret; +use router::types::{self, api, storage::enums}; +use test_utils::connector_auth; + +use crate::utils::{self, ConnectorActions}; + +#[derive(Clone, Copy)] +struct TrustpaymentsTest; +impl ConnectorActions for TrustpaymentsTest {} +impl utils::Connector for TrustpaymentsTest { + fn get_data(&self) -> api::ConnectorData { + use router::connector::Trustpayments; + utils::construct_connector_data_old( + Box::new(Trustpayments::new()), + types::Connector::Plaid, + api::GetToken::Connector, + None, + ) + } + + fn get_auth_token(&self) -> types::ConnectorAuthType { + utils::to_connector_auth_type( + connector_auth::ConnectorAuthentication::new() + .trustpayments + .expect("Missing connector authentication configuration") + .into(), + ) + } + + fn get_name(&self) -> String { + "trustpayments".to_string() + } +} + +static CONNECTOR: TrustpaymentsTest = TrustpaymentsTest {}; + +fn get_default_payment_info() -> Option<utils::PaymentInfo> { + None +} + +fn payment_method_details() -> Option<types::PaymentsAuthorizeData> { + None +} + +// Cards Positive Tests +// Creates a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_only_authorize_payment() { + let response = CONNECTOR + .authorize_payment(payment_method_details(), get_default_payment_info()) + .await + .expect("Authorize payment response"); + assert_eq!(response.status, enums::AttemptStatus::Authorized); +} + +// Captures a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_capture_authorized_payment() { + let response = CONNECTOR + .authorize_and_capture_payment(payment_method_details(), None, get_default_payment_info()) + .await + .expect("Capture payment response"); + assert_eq!(response.status, enums::AttemptStatus::Charged); +} + +// Partially captures a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_capture_authorized_payment() { + let response = CONNECTOR + .authorize_and_capture_payment( + payment_method_details(), + Some(types::PaymentsCaptureData { + amount_to_capture: 50, + ..utils::PaymentCaptureType::default().0 + }), + get_default_payment_info(), + ) + .await + .expect("Capture payment response"); + assert_eq!(response.status, enums::AttemptStatus::Charged); +} + +// Synchronizes a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_authorized_payment() { + let authorize_response = CONNECTOR + .authorize_payment(payment_method_details(), get_default_payment_info()) + .await + .expect("Authorize payment response"); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + let response = CONNECTOR + .psync_retry_till_status_matches( + enums::AttemptStatus::Authorized, + Some(types::PaymentsSyncData { + connector_transaction_id: types::ResponseId::ConnectorTransactionId( + txn_id.unwrap(), + ), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .expect("PSync response"); + assert_eq!(response.status, enums::AttemptStatus::Authorized,); +} + +// Voids a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_void_authorized_payment() { + let response = CONNECTOR + .authorize_and_void_payment( + payment_method_details(), + Some(types::PaymentsCancelData { + connector_transaction_id: String::from(""), + cancellation_reason: Some("requested_by_customer".to_string()), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .expect("Void payment response"); + assert_eq!(response.status, enums::AttemptStatus::Voided); +} + +// Refunds a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_manually_captured_payment() { + let response = CONNECTOR + .capture_payment_and_refund( + payment_method_details(), + None, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Partially refunds a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_refund_manually_captured_payment() { + let response = CONNECTOR + .capture_payment_and_refund( + payment_method_details(), + None, + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Synchronizes a refund using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_manually_captured_refund() { + let refund_response = CONNECTOR + .capture_payment_and_refund( + payment_method_details(), + None, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + let response = CONNECTOR + .rsync_retry_till_status_matches( + enums::RefundStatus::Success, + refund_response.response.unwrap().connector_refund_id, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Creates a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_make_payment() { + let authorize_response = CONNECTOR + .make_payment(payment_method_details(), get_default_payment_info()) + .await + .unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); +} + +// Synchronizes a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_auto_captured_payment() { + let authorize_response = CONNECTOR + .make_payment(payment_method_details(), get_default_payment_info()) + .await + .unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + assert_ne!(txn_id, None, "Empty connector transaction id"); + let response = CONNECTOR + .psync_retry_till_status_matches( + enums::AttemptStatus::Charged, + Some(types::PaymentsSyncData { + connector_transaction_id: types::ResponseId::ConnectorTransactionId( + txn_id.unwrap(), + ), + capture_method: Some(enums::CaptureMethod::Automatic), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!(response.status, enums::AttemptStatus::Charged,); +} + +// Refunds a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_auto_captured_payment() { + let response = CONNECTOR + .make_payment_and_refund(payment_method_details(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Partially refunds a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_refund_succeeded_payment() { + let refund_response = CONNECTOR + .make_payment_and_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + refund_response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Creates multiple refunds against a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_succeeded_payment_multiple_times() { + CONNECTOR + .make_payment_and_multiple_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await; +} + +// Synchronizes a refund using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_refund() { + let refund_response = CONNECTOR + .make_payment_and_refund(payment_method_details(), None, get_default_payment_info()) + .await + .unwrap(); + let response = CONNECTOR + .rsync_retry_till_status_matches( + enums::RefundStatus::Success, + refund_response.response.unwrap().connector_refund_id, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Cards Negative scenarios +// Creates a payment with incorrect CVC. +#[actix_web::test] +async fn should_fail_payment_for_incorrect_cvc() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: PaymentMethodData::Card(Card { + card_cvc: Secret::new("12345".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's security code is invalid.".to_string(), + ); +} + +// Creates a payment with incorrect expiry month. +#[actix_web::test] +async fn should_fail_payment_for_invalid_exp_month() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: PaymentMethodData::Card(Card { + card_exp_month: Secret::new("20".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's expiration month is invalid.".to_string(), + ); +} + +// Creates a payment with incorrect expiry year. +#[actix_web::test] +async fn should_fail_payment_for_incorrect_expiry_year() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: PaymentMethodData::Card(Card { + card_exp_year: Secret::new("2000".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's expiration year is invalid.".to_string(), + ); +} + +// Voids a payment using automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_fail_void_payment_for_auto_capture() { + let authorize_response = CONNECTOR + .make_payment(payment_method_details(), get_default_payment_info()) + .await + .unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + assert_ne!(txn_id, None, "Empty connector transaction id"); + let void_response = CONNECTOR + .void_payment(txn_id.unwrap(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + void_response.response.unwrap_err().message, + "You cannot cancel this PaymentIntent because it has a status of succeeded." + ); +} + +// Captures a payment using invalid connector payment id. +#[actix_web::test] +async fn should_fail_capture_for_invalid_payment() { + let capture_response = CONNECTOR + .capture_payment("123456789".to_string(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + capture_response.response.unwrap_err().message, + String::from("No such payment_intent: '123456789'") + ); +} + +// Refunds a payment with refund amount higher than payment amount. +#[actix_web::test] +async fn should_fail_for_refund_amount_higher_than_payment_amount() { + let response = CONNECTOR + .make_payment_and_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 150, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Refund amount (₹1.50) is greater than charge amount (₹1.00)", + ); +} + +// Connector dependent test cases goes here + +// [#478]: add unit tests for non 3DS, wallets & webhooks in connector tests diff --git a/crates/test_utils/src/connector_auth.rs b/crates/test_utils/src/connector_auth.rs index 1d45f8fb6ff..e2323031d25 100644 --- a/crates/test_utils/src/connector_auth.rs +++ b/crates/test_utils/src/connector_auth.rs @@ -113,6 +113,7 @@ pub struct ConnectorAuthentication { pub stripe_au: Option<HeaderKey>, pub stripe_uk: Option<HeaderKey>, pub trustpay: Option<SignatureKey>, + pub trustpayments: Option<HeaderKey>, pub tsys: Option<SignatureKey>, pub unified_authentication_service: Option<HeaderKey>, pub vgs: Option<SignatureKey>, diff --git a/loadtest/config/development.toml b/loadtest/config/development.toml index b0bc2e9ee1c..174bc900e5c 100644 --- a/loadtest/config/development.toml +++ b/loadtest/config/development.toml @@ -190,6 +190,7 @@ thunes.base_url = "https://api.limonetikqualif.com/" tokenio.base_url = "https://api.sandbox.token.io" stripe.base_url_file_upload = "https://files.stripe.com/" trustpay.base_url = "https://test-tpgw.trustpay.eu/" +trustpayments.base_url = "https://webservices.securetrading.net/" trustpay.base_url_bank_redirects = "https://aapi.trustpay.eu/" tsys.base_url = "https://stagegw.transnox.com/" unified_authentication_service.base_url = "http://localhost:8000" diff --git a/scripts/add_connector.sh b/scripts/add_connector.sh index 5462fdbbb01..25ffac2bb7a 100755 --- a/scripts/add_connector.sh +++ b/scripts/add_connector.sh @@ -6,7 +6,7 @@ function find_prev_connector() { git checkout $self cp $self $self.tmp # Add new connector to existing list and sort it - connectors=(aci adyen adyenplatform affirm airwallex amazonpay applepay archipel authipay authorizedotnet bambora bamboraapac bankofamerica barclaycard billwerk bitpay blackhawknetwork bluesnap boku braintree breadpay cashtocode celero chargebee checkbook checkout coinbase cryptopay ctp_visa custombilling cybersource datatrans deutschebank digitalvirgo dlocal dummyconnector dwolla ebanx elavon facilitapay fiserv fiservemea fiuu forte getnet globalpay globepay gocardless gpayments helcim hipay hyperswitch_vault iatapay inespay itaubank jpmorgan juspaythreedsserver klarna mifinity mollie moneris multisafepay netcetera nexinets nexixpay nomupay noon nordea novalnet nuvei opayo opennode paybox payeezy payload payme payone paypal paystack payu placetopay plaid powertranz prophetpay rapyd razorpay recurly redsys santander shift4 silverflow square stax stripe stripebilling taxjar threedsecureio thunes tokenio trustpay tsys unified_authentication_service vgs volt wellsfargo wellsfargopayout wise worldline worldpay worldpayvantiv worldpayxml xendit zsl "$1") + connectors=(aci adyen adyenplatform affirm airwallex amazonpay applepay archipel authipay authorizedotnet bambora bamboraapac bankofamerica barclaycard billwerk bitpay blackhawknetwork bluesnap boku braintree breadpay cashtocode celero chargebee checkbook checkout coinbase cryptopay ctp_visa custombilling cybersource datatrans deutschebank digitalvirgo dlocal dummyconnector dwolla ebanx elavon facilitapay fiserv fiservemea fiuu forte getnet globalpay globepay gocardless gpayments helcim hipay hyperswitch_vault iatapay inespay itaubank jpmorgan juspaythreedsserver klarna mifinity mollie moneris multisafepay netcetera nexinets nexixpay nomupay noon nordea novalnet nuvei opayo opennode paybox payeezy payload payme payone paypal paystack payu placetopay plaid powertranz prophetpay rapyd razorpay recurly redsys santander shift4 silverflow square stax stripe stripebilling taxjar threedsecureio thunes tokenio trustpay trustpayments tsys unified_authentication_service vgs volt wellsfargo wellsfargopayout wise worldline worldpay worldpayvantiv worldpayxml xendit zsl "$1") IFS=$'\n' sorted=($(sort <<<"${connectors[*]}")); unset IFS res="$(echo ${sorted[@]})"

2025-07-17T07:04:50Z

## Type of Change  - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description TRUSTPAYMENTS Added Template Code ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  https://github.com/juspay/hyperswitch/pull/8672 ## How did you test it? Only template code added hence no testing required ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

6214aca5f0f5c617a68f65ef5bcfd700060acccf

juspay/hyperswitch

juspay__hyperswitch-8644

Bug: feat(core): Add kill switch for Unified Connector Service (UCS) # feat(core): Add kill switch for Unified Connector Service (UCS) ## Feature Description We need to implement a kill switch mechanism for the Unified Connector Service (UCS) integration that allows operators to disable UCS immediately without requiring code changes or deployments. ## Problem Statement Currently, if UCS experiences issues or needs to be disabled for operational reasons, there's no quick way to fall back to traditional connector flows without modifying code and deploying. This poses operational risks during incidents. ## Proposed Solution Implement a database-driven kill switch that: - Can be toggled via a configuration entry in the database - Takes effect immediately without requiring service restart - Integrates seamlessly with the existing UCS decision flow - Provides clear logging when the kill switch is active ## Technical Approach 1. Add a new configuration key `UCS_KILL_SWITCH_ACTIVE` that can be stored in the database 2. Implement a helper function to check the kill switch status 3. Integrate the kill switch check into the UCS decision flow before rollout percentage checks 4. Ensure proper error handling when UCS is disabled via kill switch ## Benefits - **Operational Control**: Immediate ability to disable UCS during incidents - **Risk Mitigation**: Quick fallback mechanism without deployment delays - **Debugging**: Easier troubleshooting by toggling UCS on/off - **Gradual Rollout**: Additional safety layer on top of percentage-based rollout ## Implementation Details The kill switch will be checked in the `should_call_unified_connector_service` function before any other conditions, ensuring it has the highest priority in the decision flow. ## Acceptance Criteria - [ ] Kill switch configuration can be set in the database - [ ] When kill switch is active, UCS is bypassed completely - [ ] Changes take effect immediately without service restart - [ ] Proper logging indicates when kill switch is active - [ ] Traditional connector flow continues to work when UCS is disabled

diff --git a/crates/router/src/consts.rs b/crates/router/src/consts.rs index f9d6daa53eb..a6c0954f8f0 100644 --- a/crates/router/src/consts.rs +++ b/crates/router/src/consts.rs @@ -309,7 +309,10 @@ pub const PSD2_COUNTRIES: [Country; 27] = [ ]; // Rollout percentage config prefix -pub const UCS_ROLLOUT_PERCENT_CONFIG_PREFIX: &str = "UCS_ROLLOUT_CONFIG"; +pub const UCS_ROLLOUT_PERCENT_CONFIG_PREFIX: &str = "ucs_rollout_config"; + +// UCS feature enabled config +pub const UCS_ENABLED: &str = "ucs_enabled"; /// Header value indicating that signature-key-based authentication is used. pub const UCS_AUTH_SIGNATURE_KEY: &str = "signature-key"; diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs index 5319e823614..8a1cf212e15 100644 --- a/crates/router/src/core/payments.rs +++ b/crates/router/src/core/payments.rs @@ -4383,22 +4383,10 @@ where Ok(router_data) } else { - let router_data = if should_continue_further { - router_data - .decide_flows( - state, - &connector, - call_connector_action, - connector_request, - business_profile, - header_payload.clone(), - return_raw_connector_response, - ) - .await - } else { - Ok(router_data) - }?; - Ok(router_data) + Err( + errors::ApiErrorResponse::InternalServerError + ) + .attach_printable("Unified connector service is down and traditional connector service fallback is not implemented") } }) .await diff --git a/crates/router/src/core/payments/helpers.rs b/crates/router/src/core/payments/helpers.rs index d6ce5858299..4a023f7d8c4 100644 --- a/crates/router/src/core/payments/helpers.rs +++ b/crates/router/src/core/payments/helpers.rs @@ -2037,6 +2037,27 @@ pub fn decide_payment_method_retrieval_action( } } +pub async fn is_ucs_enabled(state: &SessionState, config_key: &str) -> bool { + let db = state.store.as_ref(); + let is_enabled = db + .find_config_by_key_unwrap_or(config_key, Some("false".to_string())) + .await + .map_err(|error| { + logger::error!( + ?error, + "Failed to fetch `{config_key}` UCS enabled config from DB" + ); + }) + .and_then(|config| { + config.config.parse::<bool>().map_err(|error| { + logger::error!(?error, "Failed to parse `{config_key}` UCS enabled config"); + }) + }) + .unwrap_or(false); + + is_enabled +} + pub async fn should_execute_based_on_rollout( state: &SessionState, config_key: &str, diff --git a/crates/router/src/core/unified_connector_service.rs b/crates/router/src/core/unified_connector_service.rs index 14836ff20c6..8c246facaf8 100644 --- a/crates/router/src/core/unified_connector_service.rs +++ b/crates/router/src/core/unified_connector_service.rs @@ -22,7 +22,9 @@ use crate::{ consts, core::{ errors::RouterResult, - payments::helpers::{should_execute_based_on_rollout, MerchantConnectorAccountType}, + payments::helpers::{ + is_ucs_enabled, should_execute_based_on_rollout, MerchantConnectorAccountType, + }, utils::get_flow_name, }, routes::SessionState, @@ -36,6 +38,16 @@ pub async fn should_call_unified_connector_service<F: Clone, T>( merchant_context: &MerchantContext, router_data: &RouterData<F, T, PaymentsResponseData>, ) -> RouterResult<bool> { + if state.grpc_client.unified_connector_service_client.is_none() { + return Ok(false); + } + + let ucs_config_key = consts::UCS_ENABLED; + + if !is_ucs_enabled(state, ucs_config_key).await { + return Ok(false); + } + let merchant_id = merchant_context .get_merchant_account() .get_id() @@ -55,7 +67,7 @@ pub async fn should_call_unified_connector_service<F: Clone, T>( ); let should_execute = should_execute_based_on_rollout(state, &config_key).await?; - Ok(should_execute && state.grpc_client.unified_connector_service_client.is_some()) + Ok(should_execute) } pub fn build_unified_connector_service_payment_method(

2025-07-15T11:06:22Z

# feat(core): Implement UCS enable/disable configuration for operational control ## Type of Change  - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ### Fixes #8644 ## Description  This PR implements a **database-driven enable/disable configuration** for the Unified Connector Service (UCS) integration, providing operators with immediate control to enable or disable UCS without requiring code changes or deployments. **Key Features Implemented:** 1. **Database Configuration**: UCS enabled state stored as `UCS_ENABLED` config 2. **Priority Check**: UCS enabled check happens before rollout percentage evaluation 3. **Immediate Effect**: Changes take effect without service restart 4. **Clear Error Handling**: Returns appropriate error when UCS is disabled **Architecture:** ``` Payment Request → should_call_unified_connector_service() → ├── Check if UCS client exists ├── Check if UCS is enabled (NEW) ├── Check rollout percentage └── Return decision (true/false) ``` **Key Technical Improvements:** - **Added Enable Check**: `is_ucs_enabled()` function queries database config - **Early Return Logic**: UCS enabled state evaluated before any other UCS conditions - **Logging Support**: Errors logged when UCS enabled config fetch fails - **Consistent Decision Flow**: UCS enabled config affects both regular and internal payment operations **Files Modified:** - `crates/router/src/consts.rs` - Added `UCS_ENABLED` constant - `crates/router/src/core/payments/helpers.rs` - Added `is_ucs_enabled()` helper function - `crates/router/src/core/unified_connector_service.rs` - Integrated UCS enabled check in decision flow - `crates/router/src/core/payments.rs` - Updated fallback behavior for internal operations **Important Caveat:** - **Regular Payment Operations (`payments_operation_core`)**: When UCS is disabled, `should_call_unified_connector_service()` returns false and traditional connector flow is used - **Internal Payment Operations (`internal_payments_operation_core`)**: Fallback to traditional connector flow has been removed - system now returns error when UCS is unavailable - This ensures that internal operations have explicit failure handling rather than silent fallback ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  **Operational Safety Requirements:** This change addresses critical operational needs for managing the UCS integration in production environments: **Incident Response:** - **Immediate Control**: During UCS outages, operators can disable it instantly - **No Deployment Required**: Enable/disable via database update - **Reduced MTTR**: Faster incident resolution without code changes **Risk Management:** - **Additional Safety Layer**: Complements existing percentage-based rollout - **Granular Control**: Can disable UCS while keeping rollout config intact - **Debugging Support**: Easily isolate UCS-related issues **Implementation Benefits:** - **Zero Downtime**: Configuration change without service restart - **Audit Trail**: Database config changes are trackable - **Simple Toggle**: Enable/disable UCS by changing config value - **Testing Flexibility**: Easy A/B testing in production **Use Cases:** 1. **Emergency Response**: Disable UCS during critical incidents 2. **Maintenance Windows**: Temporarily disable during UCS updates 3. **Performance Issues**: Quick disable if UCS causes latency 4. **Debugging**: Isolate issues to UCS vs traditional flow ## How did you test it?  ### Manual Testing #### **Test Scenario: UCS Enable/Disable Toggle Behavior** **1. Default Behavior (UCS Not Configured/Disabled)** - Make a payment request - Verify traditional connector flow is used when config is not set - Check logs confirm UCS integration is inactive **2. Enable UCS** ```bash curl --location 'http://localhost:8080/configs/UCS_ENABLED' \ --header 'Content-Type: application/json' \ --header 'api-key: test_admin' \ --header 'x-tenant-id: public' \ --data '{ "key": "UCS_ENABLED", "value": "true" }' ``` **3. Test with UCS Enabled** - Make payment request and verify UCS is called based on rollout percentage - Check logs for UCS activation based on rollout logic *Sample Payment Request:* ```bash curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'api-key: dev_test_key' \ --data '{ "amount": 2000, "currency": "USD", "confirm": true, "capture_method": "automatic", "payment_method": "card", "payment_method_data": { "card": { "card_number": "4242424242424242", "card_exp_month": "10", "card_exp_year": "25", "card_holder_name": "John Doe", "card_cvc": "737" } }, "billing": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Francisco", "state": "California", "zip": "94122", "country": "US", "first_name": "John", "last_name": "Doe" } } }' ``` **4. Disable UCS** ```bash curl --location 'http://localhost:8080/configs/UCS_ENABLED' \ --header 'Content-Type: application/json' \ --header 'api-key: test_admin' \ --header 'x-tenant-id: public' \ --data '{ "key": "UCS_ENABLED", "value": "false" }' ``` **5. Verify UCS is Disabled** - Make another payment request (use same curl command from step 3) - **Regular Payment Operations**: Verify traditional connector flow is used - **Internal Payment Operations**: Verify operations return error (no fallback) - Confirm system behavior with UCS disabled **Additional Test Cases:** **Test Invalid Config Value:** ```bash curl --location 'http://localhost:8080/configs/UCS_ENABLED' \ --header 'Content-Type: application/json' \ --header 'api-key: test_admin' \ --header 'x-tenant-id: public' \ --data '{ "key": "UCS_ENABLED", "value": "invalid_value" }' ``` - Verify system defaults to UCS disabled - Check error logs for parsing failure **Retrieve Current UCS Status:** ```bash curl --location 'http://localhost:8080/configs/UCS_ENABLED' \ --header 'api-key: test_admin' \ --header 'x-tenant-id: public' ``` - Verify response shows current UCS enabled state **Expected Results:** - UCS enable/disable takes immediate effect without service restart - When disabled (`false`), `should_call_unified_connector_service()` returns false - When enabled (`true`), normal UCS rollout logic applies - Regular payment operations use traditional connector flow when UCS disabled - Internal payment operations return error when UCS disabled (no fallback) - Invalid/missing config defaults to UCS disabled for safety ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

064113a4c96c77d83e1e0230a56678863dd8f7db

juspay/hyperswitch

juspay__hyperswitch-8653

Bug: Recurring on NMI ### Discussed in https://github.com/juspay/hyperswitch/discussions/8291 <div type='discussions-op-text'> <sup>Originally posted by **jschrecurly** June 9, 2025</sup> Add recurring payment support for NMI.</div>

diff --git a/crates/hyperswitch_connectors/src/connectors/nmi.rs b/crates/hyperswitch_connectors/src/connectors/nmi.rs index b2037c45256..7ae21664e73 100644 --- a/crates/hyperswitch_connectors/src/connectors/nmi.rs +++ b/crates/hyperswitch_connectors/src/connectors/nmi.rs @@ -38,7 +38,7 @@ use hyperswitch_interfaces::{ types::{ PaymentsAuthorizeType, PaymentsCaptureType, PaymentsCompleteAuthorizeType, PaymentsPreProcessingType, PaymentsSyncType, PaymentsVoidType, RefundExecuteType, - RefundSyncType, Response, + RefundSyncType, Response, SetupMandateType, }, webhooks::{IncomingWebhook, IncomingWebhookRequestDetails}, }; @@ -48,7 +48,7 @@ use transformers as nmi; use crate::{ types::ResponseRouterData, - utils::{construct_not_supported_error_report, convert_amount, get_header_key_value}, + utils::{self, construct_not_supported_error_report, convert_amount, get_header_key_value}, }; #[derive(Clone)] @@ -161,6 +161,16 @@ impl ConnectorValidation for Nmi { // in case we dont have transaction id, we can make psync using attempt id Ok(()) } + + fn validate_mandate_payment( + &self, + pm_type: Option<enums::PaymentMethodType>, + pm_data: hyperswitch_domain_models::payment_method_data::PaymentMethodData, + ) -> CustomResult<(), ConnectorError> { + let mandate_supported_pmd = + std::collections::HashSet::from([utils::PaymentMethodDataType::Card]); + utils::is_mandate_supported(pm_data, pm_type, mandate_supported_pmd, self.id()) + } } impl ConnectorIntegration<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData> @@ -194,27 +204,23 @@ impl ConnectorIntegration<SetupMandate, SetupMandateRequestData, PaymentsRespons req: &SetupMandateRouterData, _connectors: &Connectors, ) -> CustomResult<RequestContent, ConnectorError> { - let connector_req = nmi::NmiPaymentsRequest::try_from(req)?; + let connector_req = nmi::NmiValidateRequest::try_from(req)?; Ok(RequestContent::FormUrlEncoded(Box::new(connector_req))) } fn build_request( &self, - _req: &SetupMandateRouterData, - _connectors: &Connectors, + req: &SetupMandateRouterData, + connectors: &Connectors, ) -> CustomResult<Option<Request>, ConnectorError> { - Err(ConnectorError::NotImplemented("Setup Mandate flow for Nmi".to_string()).into()) - - // Ok(Some( - // RequestBuilder::new() - // .method(Method::Post) - // .url(&SetupMandateType::get_url(self, req, connectors)?) - // .headers(SetupMandateType::get_headers(self, req, connectors)?) - // .set_body(SetupMandateType::get_request_body( - // self, req, connectors, - // )?) - // .build(), - // )) + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&SetupMandateType::get_url(self, req, connectors)?) + .headers(SetupMandateType::get_headers(self, req, connectors)?) + .set_body(SetupMandateType::get_request_body(self, req, connectors)?) + .build(), + )) } fn handle_response( diff --git a/crates/hyperswitch_connectors/src/connectors/nmi/transformers.rs b/crates/hyperswitch_connectors/src/connectors/nmi/transformers.rs index ec5ce3b2e65..32436f307af 100644 --- a/crates/hyperswitch_connectors/src/connectors/nmi/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/nmi/transformers.rs @@ -1,8 +1,6 @@ use api_models::webhooks::IncomingWebhookEvent; use cards::CardNumber; -use common_enums::{ - AttemptStatus, AuthenticationType, CaptureMethod, CountryAlpha2, Currency, RefundStatus, -}; +use common_enums::{AttemptStatus, AuthenticationType, CountryAlpha2, Currency, RefundStatus}; use common_utils::{errors::CustomResult, ext_traits::XmlExt, pii::Email, types::FloatMajorUnit}; use error_stack::{report, Report, ResultExt}; use hyperswitch_domain_models::{ @@ -351,6 +349,7 @@ pub struct NmiCompleteResponse { pub cvvresponse: Option<String>, pub orderid: String, pub response_code: String, + customer_vault_id: Option<Secret<String>>, } impl @@ -377,17 +376,27 @@ impl Ok(PaymentsResponseData::TransactionResponse { resource_id: ResponseId::ConnectorTransactionId(item.response.transactionid), redirection_data: Box::new(None), - mandate_reference: Box::new(None), + mandate_reference: match item.response.customer_vault_id { + Some(vault_id) => Box::new(Some( + hyperswitch_domain_models::router_response_types::MandateReference { + connector_mandate_id: Some(vault_id.expose()), + payment_method_id: None, + mandate_metadata: None, + connector_mandate_request_reference_id: None, + }, + )), + None => Box::new(None), + }, connector_metadata: None, network_txn_id: None, connector_response_reference_id: Some(item.response.orderid), incremental_authorization_allowed: None, charges: None, }), - if let Some(CaptureMethod::Automatic) = item.data.request.capture_method { - AttemptStatus::CaptureInitiated + if item.data.request.is_auto_capture()? { + AttemptStatus::Charged } else { - AttemptStatus::Authorizing + AttemptStatus::Authorized }, ), Response::Declined | Response::Error => ( @@ -417,6 +426,18 @@ fn get_nmi_error_response(response: NmiCompleteResponse, http_code: u16) -> Erro } } +#[derive(Debug, Serialize)] +pub struct NmiValidateRequest { + #[serde(rename = "type")] + transaction_type: TransactionType, + security_key: Secret<String>, + ccnumber: CardNumber, + ccexp: Secret<String>, + cvv: Secret<String>, + orderid: String, + customer_vault: CustomerAction, +} + #[derive(Debug, Serialize)] pub struct NmiPaymentsRequest { #[serde(rename = "type")] @@ -429,6 +450,8 @@ pub struct NmiPaymentsRequest { #[serde(flatten)] merchant_defined_field: Option<NmiMerchantDefinedField>, orderid: String, + #[serde(skip_serializing_if = "Option::is_none")] + customer_vault: Option<CustomerAction>, } #[derive(Debug, Serialize)] @@ -462,6 +485,12 @@ pub enum PaymentMethod { CardThreeDs(Box<CardThreeDsData>), GPay(Box<GooglePayData>), ApplePay(Box<ApplePayData>), + MandatePayment(Box<MandatePayment>), +} + +#[derive(Debug, Serialize)] +pub struct MandatePayment { + customer_vault_id: Secret<String>, } #[derive(Debug, Serialize)] @@ -503,25 +532,70 @@ impl TryFrom<&NmiRouterData<&PaymentsAuthorizeRouterData>> for NmiPaymentsReques }; let auth_type: NmiAuthType = (&item.router_data.connector_auth_type).try_into()?; let amount = item.amount; - let payment_method = PaymentMethod::try_from(( - &item.router_data.request.payment_method_data, - Some(item.router_data), - ))?; - Ok(Self { - transaction_type, - security_key: auth_type.api_key, - amount, - currency: item.router_data.request.currency, - payment_method, - merchant_defined_field: item - .router_data - .request - .metadata - .as_ref() - .map(NmiMerchantDefinedField::new), - orderid: item.router_data.connector_request_reference_id.clone(), - }) + match item + .router_data + .request + .mandate_id + .clone() + .and_then(|mandate_ids| mandate_ids.mandate_reference_id) + { + Some(api_models::payments::MandateReferenceId::ConnectorMandateId( + connector_mandate_id, + )) => Ok(Self { + transaction_type, + security_key: auth_type.api_key, + amount, + currency: item.router_data.request.currency, + payment_method: PaymentMethod::MandatePayment(Box::new(MandatePayment { + customer_vault_id: Secret::new( + connector_mandate_id + .get_connector_mandate_id() + .ok_or(ConnectorError::MissingConnectorMandateID)?, + ), + })), + merchant_defined_field: item + .router_data + .request + .metadata + .as_ref() + .map(NmiMerchantDefinedField::new), + orderid: item.router_data.connector_request_reference_id.clone(), + customer_vault: None, + }), + Some(api_models::payments::MandateReferenceId::NetworkMandateId(_)) + | Some(api_models::payments::MandateReferenceId::NetworkTokenWithNTI(_)) => { + Err(ConnectorError::NotImplemented( + get_unimplemented_payment_method_error_message("nmi"), + ))? + } + None => { + let payment_method = PaymentMethod::try_from(( + &item.router_data.request.payment_method_data, + Some(item.router_data), + ))?; + + Ok(Self { + transaction_type, + security_key: auth_type.api_key, + amount, + currency: item.router_data.request.currency, + payment_method, + merchant_defined_field: item + .router_data + .request + .metadata + .as_ref() + .map(NmiMerchantDefinedField::new), + orderid: item.router_data.connector_request_reference_id.clone(), + customer_vault: item + .router_data + .request + .is_mandate_payment() + .then_some(CustomerAction::AddCustomer), + }) + } + } } } @@ -662,20 +736,36 @@ impl From<&ApplePayWalletData> for PaymentMethod { } } -impl TryFrom<&SetupMandateRouterData> for NmiPaymentsRequest { +impl TryFrom<&SetupMandateRouterData> for NmiValidateRequest { type Error = Error; fn try_from(item: &SetupMandateRouterData) -> Result<Self, Self::Error> { - let auth_type: NmiAuthType = (&item.connector_auth_type).try_into()?; - let payment_method = PaymentMethod::try_from((&item.request.payment_method_data, None))?; - Ok(Self { - transaction_type: TransactionType::Validate, - security_key: auth_type.api_key, - amount: FloatMajorUnit::zero(), - currency: item.request.currency, - payment_method, - merchant_defined_field: None, - orderid: item.connector_request_reference_id.clone(), - }) + match item.request.amount { + Some(amount) if amount > 0 => Err(ConnectorError::FlowNotSupported { + flow: "Setup Mandate with non zero amount".to_string(), + connector: "NMI".to_string(), + } + .into()), + _ => { + if let PaymentMethodData::Card(card_details) = &item.request.payment_method_data { + let auth_type: NmiAuthType = (&item.connector_auth_type).try_into()?; + Ok(Self { + transaction_type: TransactionType::Validate, + security_key: auth_type.api_key, + ccnumber: card_details.card_number.clone(), + ccexp: card_details + .get_card_expiry_month_year_2_digit_with_delimiter("".to_string())?, + cvv: card_details.card_cvc.clone(), + orderid: item.connector_request_reference_id.clone(), + customer_vault: CustomerAction::AddCustomer, + }) + } else { + Err(ConnectorError::NotImplemented( + get_unimplemented_payment_method_error_message("Nmi"), + ) + .into()) + } + } + } } } @@ -746,7 +836,7 @@ impl incremental_authorization_allowed: None, charges: None, }), - AttemptStatus::CaptureInitiated, + AttemptStatus::Charged, ), Response::Declined | Response::Error => ( Err(get_standard_error_response(item.response, item.http_code)), @@ -827,6 +917,7 @@ pub struct StandardResponse { pub cvvresponse: Option<String>, pub orderid: String, pub response_code: String, + pub customer_vault_id: Option<Secret<String>>, } impl<T> TryFrom<ResponseRouterData<SetupMandate, StandardResponse, T, PaymentsResponseData>> @@ -843,7 +934,17 @@ impl<T> TryFrom<ResponseRouterData<SetupMandate, StandardResponse, T, PaymentsRe item.response.transactionid.clone(), ), redirection_data: Box::new(None), - mandate_reference: Box::new(None), + mandate_reference: match item.response.customer_vault_id { + Some(vault_id) => Box::new(Some( + hyperswitch_domain_models::router_response_types::MandateReference { + connector_mandate_id: Some(vault_id.expose()), + payment_method_id: None, + mandate_metadata: None, + connector_mandate_request_reference_id: None, + }, + )), + None => Box::new(None), + }, connector_metadata: None, network_txn_id: None, connector_response_reference_id: Some(item.response.orderid), @@ -897,15 +998,25 @@ impl TryFrom<PaymentsResponseRouterData<StandardResponse>> item.response.transactionid.clone(), ), redirection_data: Box::new(None), - mandate_reference: Box::new(None), + mandate_reference: match item.response.customer_vault_id { + Some(vault_id) => Box::new(Some( + hyperswitch_domain_models::router_response_types::MandateReference { + connector_mandate_id: Some(vault_id.expose()), + payment_method_id: None, + mandate_metadata: None, + connector_mandate_request_reference_id: None, + }, + )), + None => Box::new(None), + }, connector_metadata: None, network_txn_id: None, connector_response_reference_id: Some(item.response.orderid), incremental_authorization_allowed: None, charges: None, }), - if let Some(CaptureMethod::Automatic) = item.data.request.capture_method { - AttemptStatus::CaptureInitiated + if item.data.request.is_auto_capture()? { + AttemptStatus::Charged } else { AttemptStatus::Authorized }, @@ -1094,7 +1205,7 @@ impl TryFrom<RefundsResponseRouterData<Capture, StandardResponse>> for RefundsRo impl From<Response> for RefundStatus { fn from(item: Response) -> Self { match item { - Response::Approved => Self::Pending, + Response::Approved => Self::Success, Response::Declined | Response::Error => Self::Failure, } }

2025-07-15T11:32:51Z

## Type of Change  - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  Mandate payments support has been added to NMI. https://support.nmi.com/hc/en-gb/articles/13923047779729-Using-the-Customer-Vault ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  https://github.com/juspay/hyperswitch/discussions/8291 https://github.com/juspay/hyperswitch/issues/8653 ## How did you test it?  Tested and added relevant cypress tests. CIT: Request: ``` curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_6Qh8tlhJxGnzCnYSgZLYUcZg3se94a12xetjLpMLCE3srm2F6E3szTR3vJ8IRzxA' \ --data-raw '{ "amount": 1122, "currency": "USD", "confirm": true, "profile_id": "pro_prQtzjS2YNKFt8NTnPhS", "authentication_type": "no_three_ds", "email": "[email protected]", "customer_id": "vaily", "return_url": "https://google.com", "payment_method": "card", "payment_method_type": "credit", "payment_method_data": { "card": { "card_number": "4532111111111112", "card_exp_month": "10", "card_exp_year": "25", "card_cvc": "123" } }, "setup_future_usage": "off_session", "customer_acceptance": { "acceptance_type": "online" } }' ``` Response: ``` { "payment_id": "pay_VosL2oOd5lEpfI5PFdAF", "merchant_id": "merchant_1754040245", "status": "succeeded", "amount": 1122, "net_amount": 1122, "shipping_cost": null, "amount_capturable": 0, "amount_received": 1122, "connector": "nmi", "client_secret": "pay_VosL2oOd5lEpfI5PFdAF_secret_pwdKA6SfrJQA90LvmvQD", "created": "2025-08-01T10:36:17.871Z", "currency": "USD", "customer_id": "vaily", "customer": { "id": "vaily", "name": null, "email": "[email protected]", "phone": null, "phone_country_code": null }, "description": null, "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": "off_session", "off_session": null, "capture_on": null, "capture_method": null, "payment_method": "card", "payment_method_data": { "card": { "last4": "1112", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "453211", "card_extended_bin": null, "card_exp_month": "10", "card_exp_year": "25", "card_holder_name": null, "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": "token_4z27khJu7gCT1bLHEHse", "shipping": null, "billing": null, "order_details": null, "email": "[email protected]", "name": null, "phone": null, "return_url": "https://google.com/", "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "credit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": { "customer_id": "vaily", "created_at": 1754044577, "expires": 1754048177, "secret": "epk_554d3664984344ca9fe39c48ff4ff5ef" }, "manual_retry_allowed": false, "connector_transaction_id": "10979926051", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_VosL2oOd5lEpfI5PFdAF_1", "payment_link": null, "profile_id": "pro_prQtzjS2YNKFt8NTnPhS", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_PbTIQbItUvYnnqZyRRrC", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-08-01T10:51:17.871Z", "fingerprint": null, "browser_info": null, "payment_method_id": "pm_MFTGiuZQ7jQOCCsyzy8p", "payment_method_status": "active", "updated": "2025-08-01T10:36:20.930Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": "212727464", "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` MIT: Request: ``` curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_6Qh8tlhJxGnzCnYSgZLYUcZg3se94a12xetjLpMLCE3srm2F6E3szTR3vJ8IRzxA' \ --data '{ "amount": 1212, "currency": "USD", "confirm": true, "capture_method": "manual", "customer_id": "vaily2", "recurring_details": { "type": "payment_method_id", "data": "pm_A6hbrqOFGArsNKgjkC9g" }, "off_session": true }' ``` Response: ``` { "payment_id": "pay_vi4nShu5q4lHUEMgOnr3", "merchant_id": "merchant_1754040245", "status": "requires_capture", "amount": 1212, "net_amount": 1212, "shipping_cost": null, "amount_capturable": 1212, "amount_received": null, "connector": "nmi", "client_secret": "pay_vi4nShu5q4lHUEMgOnr3_secret_j3hvcXvZE1amCwsXIEqZ", "created": "2025-08-01T11:40:10.511Z", "currency": "USD", "customer_id": "vaily2", "customer": { "id": "vaily2", "name": null, "email": "[email protected]", "phone": null, "phone_country_code": null }, "description": null, "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": true, "capture_on": null, "capture_method": "manual", "payment_method": "card", "payment_method_data": { "card": { "last4": "1112", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "453211", "card_extended_bin": null, "card_exp_month": "10", "card_exp_year": "25", "card_holder_name": null, "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": null, "billing": null, "order_details": null, "email": "[email protected]", "name": null, "phone": null, "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "credit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": { "customer_id": "vaily2", "created_at": 1754048410, "expires": 1754052010, "secret": "epk_a9715d624aea41ec9f9428eaaaf8a6a6" }, "manual_retry_allowed": false, "connector_transaction_id": "10980179170", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_vi4nShu5q4lHUEMgOnr3_1", "payment_link": null, "profile_id": "pro_prQtzjS2YNKFt8NTnPhS", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_PbTIQbItUvYnnqZyRRrC", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-08-01T11:55:10.511Z", "fingerprint": null, "browser_info": null, "payment_method_id": "pm_A6hbrqOFGArsNKgjkC9g", "payment_method_status": "active", "updated": "2025-08-01T11:40:13.459Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": "1452310032", "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` Zero Dollar CIT: Request: ``` curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_uOYRh8w3a91uu4wD3LFPEXGKB1TqAk6Vi1weDW4da6jde8CnAIK9pjlmixcwDqmk' \ --data-raw '{ "amount": 0, "currency": "USD", "confirm": true, "profile_id": "null", "authentication_type": "no_three_ds", "email": "[email protected]", "customer_id": "email", "payment_method": "card", "payment_method_type": "credit", "payment_method_data": { "card": { "card_number": "4532111111111112", "card_exp_month": "10", "card_exp_year": "25", "card_cvc": "123" } }, "setup_future_usage": "off_session", "customer_acceptance": { "acceptance_type": "online" }, "payment_type": "setup_mandate" }' ``` Response: ``` { "payment_id": "pay_ZMLElkI1TmhSqv7gIOO5", "merchant_id": "merchant_1754412298", "status": "succeeded", "amount": 0, "net_amount": 0, "shipping_cost": null, "amount_capturable": 0, "amount_received": null, "connector": "nmi", "client_secret": "pay_ZMLElkI1TmhSqv7gIOO5_secret_u5yYt4m3R8cDkutUIEV5", "created": "2025-08-05T16:46:39.306Z", "currency": "USD", "customer_id": "email", "customer": { "id": "email", "name": null, "email": "[email protected]", "phone": null, "phone_country_code": null }, "description": null, "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": "off_session", "off_session": null, "capture_on": null, "capture_method": null, "payment_method": "card", "payment_method_data": { "card": { "last4": "1112", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "453211", "card_extended_bin": null, "card_exp_month": "10", "card_exp_year": "25", "card_holder_name": null, "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": "token_QK0QtaO95lHS7dKGUTDd", "shipping": null, "billing": null, "order_details": null, "email": "[email protected]", "name": null, "phone": null, "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "credit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": { "customer_id": "email", "created_at": 1754412399, "expires": 1754415999, "secret": "epk_3d19001aea854585ac6ac597d4c31854" }, "manual_retry_allowed": false, "connector_transaction_id": "10996495844", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_ZMLElkI1TmhSqv7gIOO5_1", "payment_link": null, "profile_id": "pro_IR3qBTXCy9Mf2JnwgGx9", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_a2TxMLhdzJcO8xG0qDSD", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-08-05T17:01:39.305Z", "fingerprint": null, "browser_info": null, "payment_channel": null, "payment_method_id": "pm_w2iyEnG6GTv00S35UfKn", "network_transaction_id": null, "payment_method_status": "active", "updated": "2025-08-05T16:46:42.940Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": "231615292", "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` Cypress Tests: <img width="561" height="861" alt="image" src="https://github.com/user-attachments/assets/16711370-5966-47aa-8f55-f553edbc5370" /> <img width="342" height="674" alt="image" src="https://github.com/user-attachments/assets/268e8139-4d0c-4ab3-be4d-beadcae15835" /> ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

cf5737f48261905997571f2cd64feea7608ee825

juspay/hyperswitch

juspay__hyperswitch-8639

Bug: [REFACTOR] payment link's flow An expected high level payment link's lifecycle is mentioned below - Create payment link - Render payment link - Confirm via payment widget - If 3DS [always perform top redirection] - Redirect to external page - Once actions are performed, submit on page - External page redirects back to HS - HS redirects back to merchant's `return_url` - If No3DS - Redirect to status page (current window) - Wait for 5 seconds - Redirect to merchant's `return_url` [always perform top redirection] Current behavior is similar expect for the last step in No3DS - instead of redirecting to merchant's page in top, it performs a redirection in current window. This needs to be updated to perform a top redirection.

diff --git a/crates/router/src/core/payment_link/payment_link_status/status.js b/crates/router/src/core/payment_link/payment_link_status/status.js index 371fdf1d2df..863c4239757 100644 --- a/crates/router/src/core/payment_link/payment_link_status/status.js +++ b/crates/router/src/core/payment_link/payment_link_status/status.js @@ -360,7 +360,7 @@ function renderStatusDetails(paymentDetails) { url.search = params.toString(); setTimeout(function () { // Finally redirect - window.location.href = url.toString(); + window.top.location.href = url.toString(); }, 1000); } }, i * 1000);

2025-07-15T08:42:49Z

## Type of Change  - [ ] Bugfix - [ ] New feature - [ ] Enhancement - [x] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description This PR updates the behavior of final redirection to use top redirection when payment link's status page is present in the flow as well. Explained in https://github.com/juspay/hyperswitch/issues/8639 ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context Helps keep the behavior of payment links consistent. ## How did you test it? <details> <summary>1. Create a default payment link</summary> cURL curl --location --request POST 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_l9cbI5mKxdcSM5xnj2wiPTQGwO0lXCXDnHBeiCL9v9mbgQfYPdNcxSyEO8EHhaQN' \ --data '{"payment_id":"25c03e52-2ed0-4ca9-9841-5554f1857d8b","authentication_type":"three_ds","customer_id":"cus_UWxTZBStM3s2FzdDGGun","profile_id":"pro_gSujWAfJukk8ammz6aft","customer_acceptance":{"acceptance_type":"online","accepted_at":"1963-05-03T04:07:52.723Z","online":{"ip_address":"127.0.0.1","user_agent":"amet irure esse"}},"setup_future_usage":"off_session","amount":1,"currency":"EUR","confirm":false,"payment_link":true,"session_expiry":2629800,"payment_link_config":{},"return_url":"https://www.example.com"}' Response {"payment_id":"fdb4c32a-c9ff-4742-a3f4-0cdc03d04f52","merchant_id":"merchant_1752567879","status":"requires_payment_method","amount":1,"net_amount":1,"shipping_cost":null,"amount_capturable":0,"amount_received":null,"connector":null,"client_secret":"fdb4c32a-c9ff-4742-a3f4-0cdc03d04f52_secret_YM3fNu32vNuM3v8lrJzR","created":"2025-07-15T08:28:36.362Z","currency":"EUR","customer_id":"cus_UWxTZBStM3s2FzdDGGun","customer":{"id":"cus_UWxTZBStM3s2FzdDGGun","name":null,"email":null,"phone":null,"phone_country_code":null},"description":null,"refunds":null,"disputes":null,"mandate_id":null,"mandate_data":null,"setup_future_usage":"off_session","off_session":null,"capture_on":null,"capture_method":null,"payment_method":null,"payment_method_data":null,"payment_token":null,"shipping":null,"billing":null,"order_details":null,"email":null,"name":null,"phone":null,"return_url":"https://www.example.com/","authentication_type":"three_ds","statement_descriptor_name":null,"statement_descriptor_suffix":null,"next_action":null,"cancellation_reason":null,"error_code":null,"error_message":null,"unified_code":null,"unified_message":null,"payment_experience":null,"payment_method_type":null,"connector_label":null,"business_country":null,"business_label":"default","business_sub_label":null,"allowed_payment_method_types":null,"ephemeral_key":{"customer_id":"cus_UWxTZBStM3s2FzdDGGun","created_at":1752568116,"expires":1752571716,"secret":"epk_06cd3c6510724493aee541a72cb1a5c2"},"manual_retry_allowed":null,"connector_transaction_id":null,"frm_message":null,"metadata":null,"connector_metadata":null,"feature_metadata":null,"reference_id":null,"payment_link":{"link":"http://localhost:8080/payment_link/merchant_1752567879/fdb4c32a-c9ff-4742-a3f4-0cdc03d04f52?locale=en","secure_link":null,"payment_link_id":"plink_NkEB0uKH4Tg5baxkU7NF"},"profile_id":"pro_gSujWAfJukk8ammz6aft","surcharge_details":null,"attempt_count":1,"merchant_decision":null,"merchant_connector_id":null,"incremental_authorization_allowed":null,"authorization_count":null,"incremental_authorizations":null,"external_authentication_details":null,"external_3ds_authentication_attempted":false,"expires_on":"2025-08-14T18:58:36.361Z","fingerprint":null,"browser_info":null,"payment_method_id":null,"payment_method_status":null,"updated":"2025-07-15T08:28:36.369Z","split_payments":null,"frm_metadata":null,"extended_authorization_applied":null,"capture_before":null,"merchant_order_reference_id":null,"order_tax_amount":null,"connector_mandate_id":null,"card_discovery":null,"force_3ds_challenge":false,"force_3ds_challenge_trigger":false,"issuer_error_code":null,"issuer_error_message":null,"is_iframe_redirection_enabled":null,"whole_connector_response":null} </details> <details> <summary>2. Open payment link inside an and process using a non 3DS card</summary> Iframe template <html lang="en"> <head> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Document</title> <style> html, body { margin: 0; display: flex; align-items: center; justify-content: center; background-color: black; height: 100vh; width: 100vw; } iframe { border-radius: 4px; height: 90vh; width: 90vw; background-color: white; } </style> </head> <body> <iframe allow="payment" src="http://localhost:8080/payment_link/merchant_1752567879/12883fad-a7ce-4535-a327-7eccabb1258c?locale=en" frameborder="0" ></iframe> </body>  </html> Test cards https://docs.adyen.com/development-resources/testing/test-card-numbers/#visa Behavior - Redirection to status page happens inside an iframe - Redirection to return_url happens in top <img width="949" height="938" alt="Screenshot 2025-07-15 at 2 08 07 PM" src="https://github.com/user-attachments/assets/66846803-9dba-48e8-a843-a3ddcfdaac20" /> <img width="947" height="939" alt="Screenshot 2025-07-15 at 2 08 11 PM" src="https://github.com/user-attachments/assets/7c5435f0-ac8f-4b49-8a12-34c8032f2269" /> </details> <details> <summary>3. Create a payment link skipping the status screen</summary> cURL curl --location --request POST 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_l9cbI5mKxdcSM5xnj2wiPTQGwO0lXCXDnHBeiCL9v9mbgQfYPdNcxSyEO8EHhaQN' \ --data '{"payment_id":"d60872e7-104d-493d-a88b-1030ccde869d","authentication_type":"three_ds","customer_id":"cus_UWxTZBStM3s2FzdDGGun","profile_id":"pro_gSujWAfJukk8ammz6aft","customer_acceptance":{"acceptance_type":"online","accepted_at":"1963-05-03T04:07:52.723Z","online":{"ip_address":"127.0.0.1","user_agent":"amet irure esse"}},"setup_future_usage":"off_session","amount":1,"currency":"EUR","confirm":false,"payment_link":true,"session_expiry":2629800,"payment_link_config":{"skip_status_screen":true},"return_url":"https://www.example.com"}' Response {"payment_id":"d69f0158-a3bc-44ac-80d7-931f60eb102e","merchant_id":"merchant_1752567879","status":"requires_payment_method","amount":1,"net_amount":1,"shipping_cost":null,"amount_capturable":0,"amount_received":null,"connector":null,"client_secret":"d69f0158-a3bc-44ac-80d7-931f60eb102e_secret_sj4ENrQbMcZM87VvlwSg","created":"2025-07-15T08:34:22.075Z","currency":"EUR","customer_id":"cus_UWxTZBStM3s2FzdDGGun","customer":{"id":"cus_UWxTZBStM3s2FzdDGGun","name":null,"email":null,"phone":null,"phone_country_code":null},"description":null,"refunds":null,"disputes":null,"mandate_id":null,"mandate_data":null,"setup_future_usage":"off_session","off_session":null,"capture_on":null,"capture_method":null,"payment_method":null,"payment_method_data":null,"payment_token":null,"shipping":null,"billing":null,"order_details":null,"email":null,"name":null,"phone":null,"return_url":"https://www.example.com/","authentication_type":"three_ds","statement_descriptor_name":null,"statement_descriptor_suffix":null,"next_action":null,"cancellation_reason":null,"error_code":null,"error_message":null,"unified_code":null,"unified_message":null,"payment_experience":null,"payment_method_type":null,"connector_label":null,"business_country":null,"business_label":"default","business_sub_label":null,"allowed_payment_method_types":null,"ephemeral_key":{"customer_id":"cus_UWxTZBStM3s2FzdDGGun","created_at":1752568462,"expires":1752572062,"secret":"epk_c474ec1928d4487799a10fdec281d647"},"manual_retry_allowed":null,"connector_transaction_id":null,"frm_message":null,"metadata":null,"connector_metadata":null,"feature_metadata":null,"reference_id":null,"payment_link":{"link":"http://localhost:8080/payment_link/merchant_1752567879/d69f0158-a3bc-44ac-80d7-931f60eb102e?locale=en","secure_link":null,"payment_link_id":"plink_AG81wLnXtkzSLv1D499u"},"profile_id":"pro_gSujWAfJukk8ammz6aft","surcharge_details":null,"attempt_count":1,"merchant_decision":null,"merchant_connector_id":null,"incremental_authorization_allowed":null,"authorization_count":null,"incremental_authorizations":null,"external_authentication_details":null,"external_3ds_authentication_attempted":false,"expires_on":"2025-08-14T19:04:22.073Z","fingerprint":null,"browser_info":null,"payment_method_id":null,"payment_method_status":null,"updated":"2025-07-15T08:34:22.081Z","split_payments":null,"frm_metadata":null,"extended_authorization_applied":null,"capture_before":null,"merchant_order_reference_id":null,"order_tax_amount":null,"connector_mandate_id":null,"card_discovery":null,"force_3ds_challenge":false,"force_3ds_challenge_trigger":false,"issuer_error_code":null,"issuer_error_message":null,"is_iframe_redirection_enabled":null,"whole_connector_response":null} </details> <details> <summary>4. Open payment link inside an and process using a non 3DS card</summary> Iframe template <html lang="en"> <head> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Document</title> <style> html, body { margin: 0; display: flex; align-items: center; justify-content: center; background-color: black; height: 100vh; width: 100vw; } iframe { border-radius: 4px; height: 90vh; width: 90vw; background-color: white; } </style> </head> <body> <iframe allow="payment" src="http://localhost:8080/payment_link/merchant_1752567879/12883fad-a7ce-4535-a327-7eccabb1258c?locale=en" frameborder="0" ></iframe> </body>  </html> Test cards https://docs.adyen.com/development-resources/testing/test-card-numbers/#visa Behavior - Status screen is skipped - Redirection to return_url happens in top <img width="946" height="936" alt="Screenshot 2025-07-15 at 2 04 05 PM" src="https://github.com/user-attachments/assets/16291a93-a167-4195-9e5c-93f709050578" /> <img width="949" height="943" alt="Screenshot 2025-07-15 at 2 04 16 PM" src="https://github.com/user-attachments/assets/1f50ee1f-ca71-41f6-9db7-806dbdb5cf8a" /> </details> ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

871c08249d8006b54fe46d78f835452a39242ba8

juspay/hyperswitch

juspay__hyperswitch-8666

Bug: Update get organization details api response to contain organization type This is a part of the vsaas changes required. The updated response of retrieve organization`GET` api should also contain the organization type.

diff --git a/api-reference/v1/openapi_spec_v1.json b/api-reference/v1/openapi_spec_v1.json index 9239142f57b..96b8f60def3 100644 --- a/api-reference/v1/openapi_spec_v1.json +++ b/api-reference/v1/openapi_spec_v1.json @@ -18423,9 +18423,24 @@ "created_at": { "type": "string", "format": "date-time" + }, + "organization_type": { + "allOf": [ + { + "$ref": "#/components/schemas/OrganizationType" + } + ], + "nullable": true } } }, + "OrganizationType": { + "type": "string", + "enum": [ + "standard", + "platform" + ] + }, "OrganizationUpdateRequest": { "type": "object", "required": [ diff --git a/api-reference/v2/openapi_spec_v2.json b/api-reference/v2/openapi_spec_v2.json index 285a21ba04c..63057b3a9dd 100644 --- a/api-reference/v2/openapi_spec_v2.json +++ b/api-reference/v2/openapi_spec_v2.json @@ -14971,9 +14971,24 @@ "created_at": { "type": "string", "format": "date-time" + }, + "organization_type": { + "allOf": [ + { + "$ref": "#/components/schemas/OrganizationType" + } + ], + "nullable": true } } }, + "OrganizationType": { + "type": "string", + "enum": [ + "standard", + "platform" + ] + }, "OrganizationUpdateRequest": { "type": "object", "required": [ diff --git a/crates/api_models/src/organization.rs b/crates/api_models/src/organization.rs index 50632e66be7..e12b21c143f 100644 --- a/crates/api_models/src/organization.rs +++ b/crates/api_models/src/organization.rs @@ -74,6 +74,10 @@ pub struct OrganizationResponse { pub metadata: Option<pii::SecretSerdeValue>, pub modified_at: time::PrimitiveDateTime, pub created_at: time::PrimitiveDateTime, + + /// Organization Type of the organization + #[schema(value_type = Option<OrganizationType>, example = "standard")] + pub organization_type: Option<OrganizationType>, } #[cfg(feature = "v2")] @@ -95,4 +99,8 @@ pub struct OrganizationResponse { pub metadata: Option<pii::SecretSerdeValue>, pub modified_at: time::PrimitiveDateTime, pub created_at: time::PrimitiveDateTime, + + /// Organization Type of the organization + #[schema(value_type = Option<OrganizationType>, example = "standard")] + pub organization_type: Option<OrganizationType>, } diff --git a/crates/common_enums/src/enums/accounts.rs b/crates/common_enums/src/enums/accounts.rs index 2d575f4d83a..844ef398248 100644 --- a/crates/common_enums/src/enums/accounts.rs +++ b/crates/common_enums/src/enums/accounts.rs @@ -61,6 +61,7 @@ pub enum MerchantAccountType { serde::Serialize, strum::Display, strum::EnumString, + ToSchema, )] #[router_derive::diesel_enum(storage_type = "text")] #[strum(serialize_all = "snake_case")] diff --git a/crates/openapi/src/openapi.rs b/crates/openapi/src/openapi.rs index 766c69c494f..387be8ec75f 100644 --- a/crates/openapi/src/openapi.rs +++ b/crates/openapi/src/openapi.rs @@ -363,6 +363,7 @@ Never share your secret api keys. Keep them guarded and secure. api_models::enums::CtpServiceProvider, api_models::enums::PaymentLinkSdkLabelType, api_models::enums::PaymentLinkShowSdkTerms, + api_models::enums::OrganizationType, api_models::admin::MerchantConnectorCreate, api_models::admin::AdditionalMerchantData, api_models::admin::ConnectorWalletDetails, diff --git a/crates/openapi/src/openapi_v2.rs b/crates/openapi/src/openapi_v2.rs index ba447a4e457..e1cda388a38 100644 --- a/crates/openapi/src/openapi_v2.rs +++ b/crates/openapi/src/openapi_v2.rs @@ -319,6 +319,7 @@ Never share your secret api keys. Keep them guarded and secure. api_models::enums::CtpServiceProvider, api_models::enums::PaymentLinkSdkLabelType, api_models::enums::PaymentLinkShowSdkTerms, + api_models::enums::OrganizationType, api_models::admin::MerchantConnectorCreate, api_models::admin::AdditionalMerchantData, api_models::admin::CardTestingGuardConfig, diff --git a/crates/router/src/types/api/admin.rs b/crates/router/src/types/api/admin.rs index dea8cc0d770..1b478cee4c6 100644 --- a/crates/router/src/types/api/admin.rs +++ b/crates/router/src/types/api/admin.rs @@ -75,6 +75,7 @@ impl ForeignFrom<diesel_models::organization::Organization> for OrganizationResp metadata: org.metadata, modified_at: org.modified_at, created_at: org.created_at, + organization_type: org.organization_type, } } }

2025-07-16T07:14:24Z

## Type of Change  - [ ] Bugfix - [ ] New feature - [x] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description Updated `organization_retrieve` api response to contain `organization_type` for v1 and v2 api ### Additional Changes - [x] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  ## How did you test it? Curl for Organization Retrieve ``` curl --location 'http://localhost:8080/organization/org_nib3yNnE0BcUJJ8ptlh2' \ --header 'api-key: test_admin' \ --header 'Content-Type: application/json' ``` Current response ``` { "organization_id": "org_nib3yNnE0BcUJJ8ptlh2", "organization_name": "org_local", "organization_details": null, "metadata": null, "modified_at": "2025-07-15 15:47:00.992814", "created_at": "2025-07-15 15:47:00.992762", } ``` Updated response ``` { "organization_id": "org_nib3yNnE0BcUJJ8ptlh2", "organization_name": "org_local", "organization_details": null, "metadata": null, "modified_at": "2025-07-15 15:47:00.992814", "created_at": "2025-07-15 15:47:00.992762", "organization_type": "standard" } ``` ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

cb83bf8c2f4486fee99f88bc85bd6e6cb4430e13

juspay/hyperswitch

juspay__hyperswitch-8637

Bug: [FEATURE] expiration for Pix payments ### Feature Description Pix is a payment method in Brazil where customers can scan a QR and pay. This QR code generation usually has an expiry which can be specified during payment intent creation with the underlying payment processors. Currently, there isn't a way to create a Pix QR code specifying the expiry date using HS payments. This needs to be accepted in the `/payments` create API for Pix payment method data and consumed in the connector integration during integration. Flows to keep in mind - ✅ S2S API integrations - `expiry_date` will be specified explicitly - ✅ Payment links - `expiry_date` will depend on the `session_expiry` which dictates the expiration of the payment links ### Possible Implementation For S2S API integrations - accept a new field in Pix bank transfer for specifying the expiration date (`expiry_date`). ToDos - Accept a new optional field in PixBankTransfer - Consume in Adyen integration - https://docs.adyen.com/payment-methods/pix/api-only/#make-payment ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? None

diff --git a/api-reference/v1/openapi_spec_v1.json b/api-reference/v1/openapi_spec_v1.json index 96b8f60def3..11de67e7744 100644 --- a/api-reference/v1/openapi_spec_v1.json +++ b/api-reference/v1/openapi_spec_v1.json @@ -9413,6 +9413,12 @@ "description": "Destination bank account number", "example": "9b95f84e-de61-460b-a14b-f23b4e71c97b", "nullable": true + }, + "expiry_date": { + "type": "string", + "description": "The expiration date and time for the Pix QR code in ISO 8601 format", + "example": "2025-09-10T10:11:12Z", + "nullable": true } } } @@ -25986,6 +25992,12 @@ "description": "Partially masked destination bank account number", "example": "********-****-460b-****-f23b4e71c97b", "nullable": true + }, + "expiry_date": { + "type": "string", + "description": "The expiration date and time for the Pix QR code in ISO 8601 format", + "example": "2025-09-10T10:11:12Z", + "nullable": true } } }, diff --git a/api-reference/v2/openapi_spec_v2.json b/api-reference/v2/openapi_spec_v2.json index 1bce9a47e29..f08a481e54e 100644 --- a/api-reference/v2/openapi_spec_v2.json +++ b/api-reference/v2/openapi_spec_v2.json @@ -6543,6 +6543,12 @@ "description": "Destination bank account number", "example": "9b95f84e-de61-460b-a14b-f23b4e71c97b", "nullable": true + }, + "expiry_date": { + "type": "string", + "description": "The expiration date and time for the Pix QR code in ISO 8601 format", + "example": "2025-09-10T10:11:12Z", + "nullable": true } } } @@ -20907,6 +20913,12 @@ "description": "Partially masked destination bank account number", "example": "********-****-460b-****-f23b4e71c97b", "nullable": true + }, + "expiry_date": { + "type": "string", + "description": "The expiration date and time for the Pix QR code in ISO 8601 format", + "example": "2025-09-10T10:11:12Z", + "nullable": true } } }, diff --git a/crates/api_models/src/payments.rs b/crates/api_models/src/payments.rs index cef094a98d5..f7d8a808a71 100644 --- a/crates/api_models/src/payments.rs +++ b/crates/api_models/src/payments.rs @@ -3438,6 +3438,11 @@ pub enum BankTransferData { /// Destination bank account number #[schema(value_type = Option<String>, example = "9b95f84e-de61-460b-a14b-f23b4e71c97b")] destination_bank_account_id: Option<MaskedBankAccount>, + + /// The expiration date and time for the Pix QR code in ISO 8601 format + #[schema(value_type = Option<String>, example = "2025-09-10T10:11:12Z")] + #[serde(default, with = "common_utils::custom_serde::iso8601::option")] + expiry_date: Option<PrimitiveDateTime>, }, Pse {}, LocalBankTransfer { diff --git a/crates/api_models/src/payments/additional_info.rs b/crates/api_models/src/payments/additional_info.rs index ab143975ea4..099e055980a 100644 --- a/crates/api_models/src/payments/additional_info.rs +++ b/crates/api_models/src/payments/additional_info.rs @@ -177,6 +177,11 @@ pub struct PixBankTransferAdditionalData { /// Partially masked destination bank account number #[schema(value_type = Option<String>, example = "********-****-460b-****-f23b4e71c97b")] pub destination_bank_account_id: Option<MaskedBankAccount>, + + /// The expiration date and time for the Pix QR code in ISO 8601 format + #[schema(value_type = Option<String>, example = "2025-09-10T10:11:12Z")] + #[serde(default, with = "common_utils::custom_serde::iso8601::option")] + pub expiry_date: Option<time::PrimitiveDateTime>, } #[derive(Eq, PartialEq, Clone, Debug, serde::Deserialize, serde::Serialize, ToSchema)] diff --git a/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs b/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs index d972c958b71..5a47dec7cdd 100644 --- a/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs @@ -291,6 +291,8 @@ pub struct AdyenPaymentRequest<'a> { splits: Option<Vec<AdyenSplitData>>, store: Option<String>, device_fingerprint: Option<Secret<String>>, + #[serde(with = "common_utils::custom_serde::iso8601::option")] + session_validity: Option<PrimitiveDateTime>, } #[derive(Debug, Clone, Serialize, Deserialize)] @@ -2922,6 +2924,7 @@ impl store, splits, device_fingerprint, + session_validity: None, }) } } @@ -3005,6 +3008,7 @@ impl TryFrom<(&AdyenRouterData<&PaymentsAuthorizeRouterData>, &Card)> for AdyenP store, splits, device_fingerprint, + session_validity: None, }) } } @@ -3092,6 +3096,7 @@ impl store, splits, device_fingerprint, + session_validity: None, }; Ok(request) } @@ -3167,6 +3172,7 @@ impl TryFrom<(&AdyenRouterData<&PaymentsAuthorizeRouterData>, &VoucherData)> store, splits, device_fingerprint, + session_validity: None, }; Ok(request) } @@ -3213,6 +3219,46 @@ impl let delivery_address = get_address_info(item.router_data.get_optional_shipping()).and_then(Result::ok); let telephone_number = item.router_data.get_optional_billing_phone_number(); + let (session_validity, social_security_number) = match bank_transfer_data { + BankTransferData::Pix { + cpf, + cnpj, + expiry_date, + .. + } => { + // Validate expiry_date doesn't exceed 5 days from now + if let Some(expiry) = expiry_date { + let now = OffsetDateTime::now_utc(); + let max_expiry = now + Duration::days(5); + let max_expiry_primitive = + PrimitiveDateTime::new(max_expiry.date(), max_expiry.time()); + + if *expiry > max_expiry_primitive { + return Err(report!(errors::ConnectorError::InvalidDataFormat { + field_name: "expiry_date cannot be more than 5 days from now", + })); + } + } + + (*expiry_date, cpf.as_ref().or(cnpj.as_ref()).cloned()) + } + BankTransferData::LocalBankTransfer { .. } => (None, None), + BankTransferData::AchBankTransfer {} + | BankTransferData::SepaBankTransfer {} + | BankTransferData::BacsBankTransfer {} + | BankTransferData::MultibancoBankTransfer {} + | BankTransferData::PermataBankTransfer {} + | BankTransferData::BcaBankTransfer {} + | BankTransferData::BniVaBankTransfer {} + | BankTransferData::BriVaBankTransfer {} + | BankTransferData::CimbVaBankTransfer {} + | BankTransferData::DanamonVaBankTransfer {} + | BankTransferData::MandiriVaBankTransfer {} + | BankTransferData::Pse {} + | BankTransferData::InstantBankTransfer {} + | BankTransferData::InstantBankTransferFinland {} + | BankTransferData::InstantBankTransferPoland {} => (None, None), + }; let request = AdyenPaymentRequest { amount, @@ -3228,7 +3274,7 @@ impl shopper_name: None, shopper_locale: None, shopper_email: item.router_data.get_optional_billing_email(), - social_security_number: None, + social_security_number, telephone_number, billing_address, delivery_address, @@ -3243,6 +3289,7 @@ impl store, splits, device_fingerprint, + session_validity, }; Ok(request) } @@ -3319,6 +3366,7 @@ impl store, splits, device_fingerprint, + session_validity: None, }; Ok(request) } @@ -3399,6 +3447,7 @@ impl store, splits, device_fingerprint, + session_validity: None, }) } } @@ -3529,6 +3578,7 @@ impl TryFrom<(&AdyenRouterData<&PaymentsAuthorizeRouterData>, &WalletData)> store, splits, device_fingerprint, + session_validity: None, }) } } @@ -3618,6 +3668,7 @@ impl store, splits, device_fingerprint, + session_validity: None, }) } } @@ -3699,6 +3750,7 @@ impl store, splits, device_fingerprint, + session_validity: None, }) } } @@ -5945,6 +5997,7 @@ impl store, splits, device_fingerprint, + session_validity: None, }) } } diff --git a/crates/hyperswitch_domain_models/src/payment_method_data.rs b/crates/hyperswitch_domain_models/src/payment_method_data.rs index f2f86479362..b273ec4569c 100644 --- a/crates/hyperswitch_domain_models/src/payment_method_data.rs +++ b/crates/hyperswitch_domain_models/src/payment_method_data.rs @@ -710,6 +710,8 @@ pub enum BankTransferData { source_bank_account_id: Option<MaskedBankAccount>, /// Destination bank account UUID. destination_bank_account_id: Option<MaskedBankAccount>, + /// The expiration date and time for the Pix QR code + expiry_date: Option<time::PrimitiveDateTime>, }, Pse {}, LocalBankTransfer { @@ -1618,12 +1620,14 @@ impl From<api_models::payments::BankTransferData> for BankTransferData { cnpj, source_bank_account_id, destination_bank_account_id, + expiry_date, } => Self::Pix { pix_key, cpf, cnpj, source_bank_account_id, destination_bank_account_id, + expiry_date, }, api_models::payments::BankTransferData::Pse {} => Self::Pse {}, api_models::payments::BankTransferData::LocalBankTransfer { bank_code } => { @@ -1662,6 +1666,7 @@ impl From<BankTransferData> for api_models::payments::additional_info::BankTrans cnpj, source_bank_account_id, destination_bank_account_id, + expiry_date, } => Self::Pix(Box::new( api_models::payments::additional_info::PixBankTransferAdditionalData { pix_key: pix_key.map(MaskedBankAccount::from), @@ -1669,6 +1674,7 @@ impl From<BankTransferData> for api_models::payments::additional_info::BankTrans cnpj: cnpj.map(MaskedBankAccount::from), source_bank_account_id, destination_bank_account_id, + expiry_date, }, )), BankTransferData::Pse {} => Self::Pse {},

2025-07-21T07:08:40Z

## Type of Change  - [ ] Bugfix - [x] New feature - [x] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  Enhanced Pix payment support for Adyen connector with two changes: 1. **Expiry Date Support**: Added `expiry_date` field to `BankTransferData::Pix` variant in API and domain models and mapped it to Adyen's `sessionValidity` 2. **CPF/CNPJ Mapping**: Map CPF or CNPJ from Pix payment data to Adyen's `socialSecurityNumber` field ### Additional Changes - [x] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables ## Motivation and Context  Enables merchants to specify expiry dates for Pix QR codes and ensures proper customer identification through CPF/CNPJ mapping as per Adyen's Pix API requirements. ## How did you test it?  <details> <summary>1. Create a Pix payment using custom SSN and expiry date</summary> cURL curl --location --request POST 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_uXENxlgLNNVyGVRpR0D4S1om0k65a6X3nyc5WfAXjwUlVWmBSl3ZPGJHhywazTN6' \ --data-raw '{"amount":4500,"currency":"BRL","confirm":true,"profile_id":"pro_U1KoDSmwFwzKn649yraI","capture_on":"2022-09-10T10:11:12Z","connector":["adyen"],"customer_id":"cus_6vLys2IeaGT4xVbFj2U9","email":"[email protected]","return_url":"https://google.com","payment_method":"bank_transfer","payment_method_type":"pix","payment_method_data":{"bank_transfer":{"pix":{"pix_key":"test","cpf":"test","cnpj":"test","expiry_date":"2025-07-23T10:11:12Z"}}},"billing":{"address":{"line1":"1467","line2":"Harrison Street","line3":"Harrison Street","city":"San Fransico","state":"California","zip":"94122","country":"BR","first_name":"joseph","last_name":"Doe"},"phone":{"number":"8056594427","country_code":"+91"},"email":"[email protected]"},"metadata":{"Force-PSP":"Adyen","udf1":"value1","new_customer":"true","login_date":"2019-09-10T10:11:12Z"},"browser_info":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36","accept_header":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8","language":"en-US","color_depth":32,"screen_height":1117,"screen_width":1728,"time_zone":-330,"java_enabled":true,"java_script_enabled":true,"ip_address":"127.0.0.1"},"customer_acceptance":{"acceptance_type":"online","accepted_at":"1963-05-03T04:07:52.723Z","online":{"ip_address":"127.0.0.1","user_agent":"amet irure esse"}},"session_expiry":60}' Response {"payment_id":"pay_iB7uN0kUtp51wVHpLhQF","merchant_id":"merchant_1753076715","status":"requires_customer_action","amount":4500,"net_amount":4500,"shipping_cost":null,"amount_capturable":4500,"amount_received":null,"connector":"adyen","client_secret":"pay_iB7uN0kUtp51wVHpLhQF_secret_6kerLIBddt2ShUGKwXcP","created":"2025-07-21T08:12:53.420Z","currency":"BRL","customer_id":"cus_6vLys2IeaGT4xVbFj2U9","customer":{"id":"cus_6vLys2IeaGT4xVbFj2U9","name":"John Nether","email":"[email protected]","phone":"6168205362","phone_country_code":"+1"},"description":null,"refunds":null,"disputes":null,"mandate_id":null,"mandate_data":null,"setup_future_usage":null,"off_session":null,"capture_on":null,"capture_method":null,"payment_method":"bank_transfer","payment_method_data":{"bank_transfer":{"pix":{"pix_key":"test","cpf":"test","cnpj":"test","source_bank_account_id":null,"destination_bank_account_id":null,"expiry_date":"2025-07-23T10:11:12.000Z"}},"billing":null},"payment_token":null,"shipping":null,"billing":{"address":{"city":"San Fransico","country":"BR","line1":"1467","line2":"Harrison Street","line3":"Harrison Street","zip":"94122","state":"California","first_name":"joseph","last_name":"Doe"},"phone":{"number":"8056594427","country_code":"+91"},"email":"[email protected]"},"order_details":null,"email":"[email protected]","name":"John Nether","phone":"6168205362","return_url":"https://google.com/","authentication_type":"no_three_ds","statement_descriptor_name":null,"statement_descriptor_suffix":null,"next_action":{"type":"qr_code_information","image_data_url":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAQgAAAEICAAAAACGnTUjAAAGJElEQVR4Ae3gAZAkSZIkSRKLqpm7R0REZmZmVlVVVVV3d3d3d/fMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMdHd3d3dXV1VVVVVmZkZGRIS7m5kKz0xmV3d1d3dPz8zMzMxMYjVXAVSuAqByFQCVqwCoXAVA5SoAKlcBULkKgMpVAFSuAqByFQCVqwCoXAVA5SoAKlcBULkKgMpVAFSuAqByFQCVqwCoXAVA5SoAKlcBULkKgMpVAFSuAqByFQCVqwCoXAVA5SoAKlcBULkKgMq/QPzbmCvEFeY5iedkrhDPn7lC/NuYF4rKVQBUrgKgchUAlasAqFwFQOUqACpXAVB5EZkXjXhO5gpxhXnhzHMSz5950YgXCZWrAKhcBUDlKgAqVwFQuQqAylUAVK4CoPKvJJ4/88KZK8QV5grx/IkrzAsnnj/zr0LlKgAqVwFQuQqAylUAVK4CoHIVAJWrAKj8JxPPn7jCvHDiCvOfispVAFSuAqByFQCVqwCoXAVA5SoAKlcBUPkvZq4Qz5/4b0HlKgAqVwFQuQqAylUAVK4CoHIVAJWrAKj8K5l/H/GcxBXmCvOcxAtn/kNQuQqAylUAVK4CoHIVAJWrAKhcBUDlKgAqLyLx72OuEFeYK8RzEleYF078h6JyFQCVqwCoXAVA5SoAKlcBULkKgMpVAFT+Bea/hrjCvHDmPwWVqwCoXAVA5SoAKlcBULkKgMpVAFSuAqDyLxBXmOdPXGGuEM+fuMK8aMQV5grxojHPSVxhXigqVwFQuQqAylUAVK4CoHIVAJWrAKhcBYDMv494TuYK8fyZK8S/jnn+xBXmOYkrzIuEylUAVK4CoHIVAJWrAKhcBUDlKgAqVwFQ+VcSz5+5QlxhrhAvGvOcxBXmhTPPn/lXoXIVAJWrAKhcBUDlKgAqVwFQuQqAylUAVP4F4oUzV4grzPNnXjTiCvPCiSvMcxJXmH8VKlcBULkKgMpVAFSuAqByFQCVqwCoXAWAzAsnrjBXiBeNeU7iOZnnJJ4/c4V4/swV4oUzLxSVqwCoXAVA5SoAKlcBULkKgMpVAFSuAqDyIhJXmOdPXGGuEFeYF05cYZ6TuEJcYa4QV5grxHMy/yZUrgKgchUAlasAqFwFQOUqACpXAVC5CgCZfxtxhXlO4grznMQV5grxr2Oek3jhzL8KlasAqFwFQOUqACpXAVC5CoDKVQBUrgKg8m9krhDPyTwncYV5/swV4gpzhbjCvGjMFeIKcYV5kVC5CoDKVQBUrgKgchUAlasAqFwFQOUqAGReOPH8medPPCfznMQV5grxnMxzEv865grxnMwLReUqACpXAVC5CoDKVQBUrgKgchUAlasAkPnPJa4wL5x44czzJ64wz0k8J/NCUbkKgMpVAFSuAqByFQCVqwCoXAVA5SoAKv8C8W9j/nXMcxLPn7jCPH/iCvOvQuUqACpXAVC5CoDKVQBUrgKgchUAlasAqLyIzItGPCdzhbjCPCdxhblCXGGuEM/JvGjEczIvFJWrAKhcBUDlKgAqVwFQuQqAylUAVK4CoPKvJJ4/8/yJK8wV4jmZK8QLJ144cYV5TuJFQuUqACpXAVC5CoDKVQBUrgKgchUAlasAqPwnM1eI52SuEFeYfxvz/Il/FSpXAVC5CoDKVQBUrgKgchUAlasAqFwFQOW/iXhO4jmZ589cIZ6TuMI8J/MioXIVAJWrAKhcBUDlKgAqVwFQuQqAylUAVP6VzL+NeU7iCnOFuMI8f+YK8ZzEFeYK8W9C5SoAKlcBULkKgMpVAFSuAqByFQCVqwCovIjEv424wlwhrjBXiOdPXGGuEC8ac4W4QlxhXigqVwFQuQqAylUAVK4CoHIVAJWrAKhcBYDMVQCVqwCoXAVA5SoAKlcBULkKgMpVAFSuAqByFQCVqwCoXAVA5SoAKlcBULkKgMpVAFSuAqByFQCVqwCoXAVA5SoAKlcBULkKgMpVAFSuAqByFQCVqwCoXAVA5SoAKlcBULkKgMpVAFSuAuAfAfHRhAhvVmeEAAAAAElFTkSuQmCC","display_to_timestamp":1753265472000,"qr_code_url":"https://test.adyen.com/hpp/generateQRCodeImage.shtml?url=TestQRCodeEMVToken","display_text":null,"border_color":null},"cancellation_reason":null,"error_code":null,"error_message":null,"unified_code":null,"unified_message":null,"payment_experience":null,"payment_method_type":"pix","connector_label":null,"business_country":null,"business_label":"default","business_sub_label":null,"allowed_payment_method_types":null,"ephemeral_key":{"customer_id":"cus_6vLys2IeaGT4xVbFj2U9","created_at":1753085573,"expires":1753089173,"secret":"epk_e1db82c9ea524cfba83011c631f34bf9"},"manual_retry_allowed":null,"connector_transaction_id":"DVB7NMC4DVHVLD75","frm_message":null,"metadata":{"udf1":"value1","Force-PSP":"Adyen","login_date":"2019-09-10T10:11:12Z","new_customer":"true"},"connector_metadata":null,"feature_metadata":null,"reference_id":"DVB7NMC4DVHVLD75","payment_link":null,"profile_id":"pro_U1KoDSmwFwzKn649yraI","surcharge_details":null,"attempt_count":1,"merchant_decision":null,"merchant_connector_id":"mca_lBjLVbnnprul6b7CLyQE","incremental_authorization_allowed":null,"authorization_count":null,"incremental_authorizations":null,"external_authentication_details":null,"external_3ds_authentication_attempted":false,"expires_on":"2025-07-21T08:13:53.420Z","fingerprint":null,"browser_info":{"language":"en-US","time_zone":-330,"ip_address":"127.0.0.1","user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36","color_depth":32,"java_enabled":true,"screen_width":1728,"accept_header":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8","screen_height":1117,"java_script_enabled":true},"payment_method_id":null,"payment_method_status":null,"updated":"2025-07-21T08:12:53.932Z","split_payments":null,"frm_metadata":null,"extended_authorization_applied":null,"capture_before":null,"merchant_order_reference_id":null,"order_tax_amount":null,"connector_mandate_id":null,"card_discovery":null,"force_3ds_challenge":false,"force_3ds_challenge_trigger":false,"issuer_error_code":null,"issuer_error_message":null,"is_iframe_redirection_enabled":null,"whole_connector_response":null} Things to verify 1. Expiry time in response (display_to_timestamp) - should be same as the one sent in request 2. Social security number must be sent to Adyen <img width="1223" height="618" alt="Screenshot 2025-07-21 at 1 53 44 PM" src="https://github.com/user-attachments/assets/643fb36c-0b60-44fa-91ff-4702114747f6" /> </details> <details> <summary>2. Create a Pix payment using a expiry date > 5 days in future from now</summary> cURL curl --location --request POST 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_uXENxlgLNNVyGVRpR0D4S1om0k65a6X3nyc5WfAXjwUlVWmBSl3ZPGJHhywazTN6' \ --data-raw '{"amount":4500,"currency":"BRL","confirm":true,"profile_id":"pro_U1KoDSmwFwzKn649yraI","capture_on":"2022-09-10T10:11:12Z","connector":["adyen"],"customer_id":"cus_6vLys2IeaGT4xVbFj2U9","email":"[email protected]","return_url":"https://google.com","payment_method":"bank_transfer","payment_method_type":"pix","payment_method_data":{"bank_transfer":{"pix":{"pix_key":"test","cpf":"test","cnpj":"test","expiry_date":"2025-08-23T10:11:12Z"}}},"billing":{"address":{"line1":"1467","line2":"Harrison Street","line3":"Harrison Street","city":"San Fransico","state":"California","zip":"94122","country":"BR","first_name":"joseph","last_name":"Doe"},"phone":{"number":"8056594427","country_code":"+91"},"email":"[email protected]"},"metadata":{"Force-PSP":"Adyen","udf1":"value1","new_customer":"true","login_date":"2019-09-10T10:11:12Z"},"browser_info":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36","accept_header":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8","language":"en-US","color_depth":32,"screen_height":1117,"screen_width":1728,"time_zone":-330,"java_enabled":true,"java_script_enabled":true,"ip_address":"127.0.0.1"},"customer_acceptance":{"acceptance_type":"online","accepted_at":"1963-05-03T04:07:52.723Z","online":{"ip_address":"127.0.0.1","user_agent":"amet irure esse"}},"session_expiry":60}' Response { "error": { "type": "invalid_request", "message": "Invalid value provided: expiry_date cannot be more than 5 days from now", "code": "IR_07" } } </details> ## Checklist  - [ ] I formatted the code `cargo +nightly fmt --all` - [ ] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

2b6f6c46a690514b9b10958433d89e95cd7e0c2e

juspay/hyperswitch

juspay__hyperswitch-8636

Bug: [BUG] card payouts using payout_method_id ### Bug Description Payout method data for card is not being fetched in payouts flow. This bug was introduced in https://github.com/juspay/hyperswitch/pull/7786/files where `get_pm_list_context` was refactored to return back only the additional details by removing the call to card vault. ### Expected Behavior `payout_method_data` should be fetched from card vault in payouts flow. ### Actual Behavior `payout_method_data` is not being fetched in payouts flow. ### Steps To Reproduce 1. Create a card payout with `recurring: true` 2. Obtain the `payout_method_id` 3. Create a payout using this `payout_method_id` - throws an error saying card details not found ### Have you spent some time checking if this bug has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? Yes, I am willing to submit a PR!

diff --git a/crates/payment_methods/src/controller.rs b/crates/payment_methods/src/controller.rs index bd5a9f316ef..095788fa368 100644 --- a/crates/payment_methods/src/controller.rs +++ b/crates/payment_methods/src/controller.rs @@ -229,6 +229,12 @@ pub trait PaymentMethodsController { merchant_id: &id_type::MerchantId, card_network: Option<common_enums::CardNetwork>, ) -> errors::PmResult<()>; + + #[cfg(feature = "v1")] + async fn get_card_details_from_locker( + &self, + pm: &payment_methods::PaymentMethod, + ) -> errors::PmResult<api::CardDetailFromLocker>; } pub async fn create_encrypted_data<T>( diff --git a/crates/router/src/core/payment_methods/cards.rs b/crates/router/src/core/payment_methods/cards.rs index 8f29e05e154..7ba707316c5 100644 --- a/crates/router/src/core/payment_methods/cards.rs +++ b/crates/router/src/core/payment_methods/cards.rs @@ -890,6 +890,14 @@ impl PaymentMethodsController for PmCards<'_> { .await } + #[cfg(feature = "v1")] + async fn get_card_details_from_locker( + &self, + pm: &domain::PaymentMethod, + ) -> errors::RouterResult<api::CardDetailFromLocker> { + get_card_details_from_locker(self.state, pm).await + } + #[cfg(feature = "v1")] #[instrument(skip_all)] async fn retrieve_payment_method( @@ -4205,6 +4213,7 @@ pub async fn list_customer_payment_method( &pm, Some(parent_payment_method_token.clone()), true, + false, &merchant_context, ) .await?; @@ -4349,6 +4358,7 @@ pub async fn list_customer_payment_method( } #[cfg(feature = "v1")] +#[allow(clippy::too_many_arguments)] pub async fn get_pm_list_context( state: &routes::SessionState, payment_method: &enums::PaymentMethod, @@ -4358,6 +4368,7 @@ pub async fn get_pm_list_context( #[cfg(feature = "payouts")] parent_payment_method_token: Option<String>, #[cfg(not(feature = "payouts"))] _parent_payment_method_token: Option<String>, is_payment_associated: bool, + force_fetch_card_from_vault: bool, merchant_context: &domain::MerchantContext, ) -> Result<Option<PaymentMethodListContext>, error_stack::Report<errors::ApiErrorResponse>> { let cards = PmCards { @@ -4366,7 +4377,11 @@ pub async fn get_pm_list_context( }; let payment_method_retrieval_context = match payment_method { enums::PaymentMethod::Card => { - let card_details = cards.get_card_details_with_locker_fallback(pm).await?; + let card_details = if force_fetch_card_from_vault { + Some(cards.get_card_details_from_locker(pm).await?) + } else { + cards.get_card_details_with_locker_fallback(pm).await? + }; card_details.as_ref().map(|card| PaymentMethodListContext { card_details: Some(card.clone()), diff --git a/crates/router/src/core/payouts/validator.rs b/crates/router/src/core/payouts/validator.rs index 3d58d1f367e..198caa4b893 100644 --- a/crates/router/src/core/payouts/validator.rs +++ b/crates/router/src/core/payouts/validator.rs @@ -233,6 +233,7 @@ pub async fn validate_create_request( payment_method, None, false, + true, merchant_context, ) .await? @@ -243,7 +244,7 @@ pub async fn validate_create_request( card_number: card.card_number.get_required_value("card_number")?, card_holder_name: card.card_holder_name, expiry_month: card.expiry_month.get_required_value("expiry_month")?, - expiry_year: card.expiry_year.get_required_value("expiry_month")?, + expiry_year: card.expiry_year.get_required_value("expiry_year")?, }, ))), (_, Some(bank)) => Ok(Some(payouts::PayoutMethodData::Bank(bank))),

2025-07-23T09:59:21Z

## Type of Change - [x] Bugfix ## Description Fixed payout method data not being fetched from card vault when using `payout_method_id` in payouts flow. **Changes:** - Added `force_fetch_card_from_vault` parameter to `get_pm_list_context` to enable card vault lookup for payouts - Added `get_card_details_from_locker` method to PaymentMethodsController trait - Set `force_fetch_card_from_vault=true` in payouts validator to ensure card details are retrieved from vault - Fixed typo in error message for `expiry_year` field ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables ## Motivation and Context Fixes regression introduced in [PR #7786](https://github.com/juspay/hyperswitch/pull/7786) where card vault lookup was removed from `get_pm_list_context`. This broke recurring payouts functionality where `payout_method_id` should retrieve stored card details from vault. ## How did you test it? <details> <summary>1. Create a recurring card payout</summary> cURL curl --location --request POST 'http://localhost:8080/payouts/create' \ --header 'Content-Type: application/json' \ --header 'api-key: dev_ydIiVWyEGA60P3uQa2IHCKACVSRVHceIJEPrmSsb1TFfpJHfBmYRaMoqrrOiSab1' \ --data '{"amount":100,"currency":"EUR","profile_id":"pro_pkpPuJzb8FHi5TYDj6ew","customer_id":"cus_UWxTZBStM3s2FzdDGGun","connector":["adyenplatform"],"description":"Its my first payout request","payout_type":"card","payout_method_data":{"card":{"card_number":"4111111111111111","expiry_month":"03","expiry_year":"2030"}},"billing":{"address":{"line1":"1467","line2":"Harrison Street","line3":"Harrison Street","city":"San Fransico","state":"CA","zip":"94122","country":"FR","first_name":"John","last_name":"Doe"}},"entity_type":"Individual","recurring":true,"metadata":{"ref":"123"},"confirm":true,"auto_fulfill":true}' Response {"payout_id":"payout_s9nuyxhtsta0qQSKSaYC","merchant_id":"merchant_1752554602","merchant_order_reference_id":null,"amount":100,"currency":"EUR","connector":"adyenplatform","payout_type":"card","payout_method_data":{"card":{"card_issuer":null,"card_network":null,"card_type":null,"card_issuing_country":null,"bank_code":null,"last4":"1111","card_isin":"411111","card_extended_bin":null,"card_exp_month":"03","card_exp_year":"2030","card_holder_name":null}},"billing":{"address":{"city":"San Fransico","country":"FR","line1":"1467","line2":"Harrison Street","line3":"Harrison Street","zip":"94122","state":"CA","first_name":"John","last_name":"Doe"},"phone":null,"email":null},"auto_fulfill":true,"customer_id":"cus_UWxTZBStM3s2FzdDGGun","customer":{"id":"cus_UWxTZBStM3s2FzdDGGun","name":"John Nether","email":null,"phone":"6168205362","phone_country_code":"+1"},"client_secret":"payout_payout_s9nuyxhtsta0qQSKSaYC_secret_OxIBwSwo8HWWeZat8yYk","return_url":null,"business_country":null,"business_label":null,"description":"Its my first payout request","entity_type":"Individual","recurring":true,"metadata":{"ref":"123"},"merchant_connector_id":"mca_pjCOTcjEbqMrGm7rRLte","status":"initiated","error_message":null,"error_code":null,"profile_id":"pro_pkpPuJzb8FHi5TYDj6ew","created":"2025-07-15T04:44:24.793Z","connector_transaction_id":"38EBID67N4HZE5UD","priority":null,"payout_link":null,"email":null,"name":"John Nether","phone":"6168205362","phone_country_code":"+1","unified_code":null,"unified_message":null,"payout_method_id":"pm_G5g1xumF3AXWDPY8yl30"} Note down payout method ID </details> <details> <summary>2. Create payout using payout_method_id</summary> cURL curl --location --request POST 'http://localhost:8080/payouts/create' \ --header 'Content-Type: application/json' \ --header 'api-key: dev_ydIiVWyEGA60P3uQa2IHCKACVSRVHceIJEPrmSsb1TFfpJHfBmYRaMoqrrOiSab1' \ --data-raw '{"payout_method_id":"pm_G5g1xumF3AXWDPY8yl30","amount":1,"currency":"EUR","customer_id":"cus_UWxTZBStM3s2FzdDGGun","email":"[email protected]","name":"John Doe","phone":"999999999","phone_country_code":"+65","description":"Its my first payout request","connector":["adyenplatform"],"billing":{"address":{"line1":"1467","line2":"Harrison Street","line3":"Harrison Street","city":"San Fransico","state":"CA","zip":"94122","country":"US","first_name":"John","last_name":"Doe"},"phone":{"number":"8056594427","country_code":"+91"}},"entity_type":"Individual","recurring":true,"metadata":{"ref":"123"},"confirm":true,"auto_fulfill":true}' Response {"payout_id":"payout_QfSUC79LP4YDXjKwvn66","merchant_id":"merchant_1752554602","merchant_order_reference_id":null,"amount":1,"currency":"EUR","connector":"adyenplatform","payout_type":"card","payout_method_data":{"card":{"card_issuer":null,"card_network":null,"card_type":null,"card_issuing_country":null,"bank_code":null,"last4":"1111","card_isin":"411111","card_extended_bin":null,"card_exp_month":"03","card_exp_year":"2030","card_holder_name":null}},"billing":{"address":{"city":"San Fransico","country":"US","line1":"1467","line2":"Harrison Street","line3":"Harrison Street","zip":"94122","state":"CA","first_name":"John","last_name":"Doe"},"phone":{"number":"8056594427","country_code":"+91"},"email":null},"auto_fulfill":true,"customer_id":"cus_UWxTZBStM3s2FzdDGGun","customer":{"id":"cus_UWxTZBStM3s2FzdDGGun","name":"John Nether","email":null,"phone":"6168205362","phone_country_code":"+1"},"client_secret":"payout_payout_QfSUC79LP4YDXjKwvn66_secret_ArtMRkkTVFHDFsrTHMbE","return_url":null,"business_country":null,"business_label":null,"description":"Its my first payout request","entity_type":"Individual","recurring":true,"metadata":{"ref":"123"},"merchant_connector_id":"mca_pjCOTcjEbqMrGm7rRLte","status":"initiated","error_message":null,"error_code":null,"profile_id":"pro_pkpPuJzb8FHi5TYDj6ew","created":"2025-07-15T04:45:13.051Z","connector_transaction_id":"38EBHI67N4I9P28N","priority":null,"payout_link":null,"email":null,"name":"John Nether","phone":"6168205362","phone_country_code":"+1","unified_code":null,"unified_message":null,"payout_method_id":"pm_G5g1xumF3AXWDPY8yl30"} </details> ## Checklist - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

6214aca5f0f5c617a68f65ef5bcfd700060acccf

juspay/hyperswitch

juspay__hyperswitch-8638

Bug: [FEATURE] add payment_expired outgoing webhook ### Feature Description Payment methods related to QR code which generally has an expiration time / date associated comes to end of its lifecycle if they're not fulfilled. For such payments, underlying connector can send an incoming webhook when they expire. HS needs to provision a status (or if `Cancelled` can be reused?) and a variant for `EventType` which specifies they type of outgoing webhook event being generated. These are needed to be consumed for the supported connectors (Adyen for now) and also send an outgoing webhook once they expire. ### Possible Implementation - Integrate OFFER_CLOSED from Adyen as a part of incoming webhooks - https://docs.adyen.com/development-resources/webhooks/webhook-types/#non-default-event-codes - ** Map it to `cancelled` in `IntentStatus` (map to `voided` in `AttemptStatus`)

diff --git a/api-reference/v1/openapi_spec_v1.json b/api-reference/v1/openapi_spec_v1.json index 835adefad89..e8aab746356 100644 --- a/api-reference/v1/openapi_spec_v1.json +++ b/api-reference/v1/openapi_spec_v1.json @@ -7623,7 +7623,8 @@ "payment_method_awaited", "confirmation_awaited", "device_data_collection_pending", - "integrity_failure" + "integrity_failure", + "expired" ] }, "AuthenticationConnectorDetails": { @@ -14108,6 +14109,7 @@ "payment_cancelled", "payment_authorized", "payment_captured", + "payment_expired", "action_required", "refund_succeeded", "refund_failed", @@ -15894,7 +15896,8 @@ "requires_capture", "partially_captured", "partially_captured_and_capturable", - "conflicted" + "conflicted", + "expired" ] }, "IssuerData": { diff --git a/api-reference/v2/openapi_spec_v2.json b/api-reference/v2/openapi_spec_v2.json index 80bef996758..a8bacd04ad3 100644 --- a/api-reference/v2/openapi_spec_v2.json +++ b/api-reference/v2/openapi_spec_v2.json @@ -4847,7 +4847,8 @@ "payment_method_awaited", "confirmation_awaited", "device_data_collection_pending", - "integrity_failure" + "integrity_failure", + "expired" ] }, "AuthenticationConnectorDetails": { @@ -10682,6 +10683,7 @@ "payment_cancelled", "payment_authorized", "payment_captured", + "payment_expired", "action_required", "refund_succeeded", "refund_failed", @@ -12580,7 +12582,8 @@ "requires_capture", "partially_captured", "partially_captured_and_capturable", - "conflicted" + "conflicted", + "expired" ] }, "JCSVoucherData": { diff --git a/crates/api_models/src/webhooks.rs b/crates/api_models/src/webhooks.rs index 75af0b19cf2..fcab9461a00 100644 --- a/crates/api_models/src/webhooks.rs +++ b/crates/api_models/src/webhooks.rs @@ -22,6 +22,7 @@ pub enum IncomingWebhookEvent { PaymentIntentAuthorizationFailure, PaymentIntentCaptureSuccess, PaymentIntentCaptureFailure, + PaymentIntentExpired, PaymentActionRequired, EventNotSupported, SourceChargeable, @@ -199,7 +200,8 @@ impl From<IncomingWebhookEvent> for WebhookFlow { | IncomingWebhookEvent::PaymentIntentAuthorizationSuccess | IncomingWebhookEvent::PaymentIntentAuthorizationFailure | IncomingWebhookEvent::PaymentIntentCaptureSuccess - | IncomingWebhookEvent::PaymentIntentCaptureFailure => Self::Payment, + | IncomingWebhookEvent::PaymentIntentCaptureFailure + | IncomingWebhookEvent::PaymentIntentExpired => Self::Payment, IncomingWebhookEvent::EventNotSupported => Self::ReturnResponse, IncomingWebhookEvent::RefundSuccess | IncomingWebhookEvent::RefundFailure => { Self::Refund diff --git a/crates/common_enums/src/enums.rs b/crates/common_enums/src/enums.rs index 12f1fe5581f..a2912e73c45 100644 --- a/crates/common_enums/src/enums.rs +++ b/crates/common_enums/src/enums.rs @@ -156,6 +156,7 @@ pub enum AttemptStatus { ConfirmationAwaited, DeviceDataCollectionPending, IntegrityFailure, + Expired, } impl AttemptStatus { @@ -168,7 +169,8 @@ impl AttemptStatus { | Self::VoidFailed | Self::CaptureFailed | Self::Failure - | Self::PartialCharged => true, + | Self::PartialCharged + | Self::Expired => true, Self::Started | Self::AuthenticationFailed | Self::AuthenticationPending @@ -1461,6 +1463,7 @@ impl EventClass { EventType::PaymentCancelled, EventType::PaymentAuthorized, EventType::PaymentCaptured, + EventType::PaymentExpired, EventType::ActionRequired, ]), Self::Refunds => HashSet::from([EventType::RefundSucceeded, EventType::RefundFailed]), @@ -1514,6 +1517,7 @@ pub enum EventType { PaymentCancelled, PaymentAuthorized, PaymentCaptured, + PaymentExpired, ActionRequired, RefundSucceeded, RefundFailed, @@ -1635,13 +1639,19 @@ pub enum IntentStatus { PartiallyCapturedAndCapturable, /// There has been a discrepancy between the amount/currency sent in the request and the amount/currency received by the processor Conflicted, + /// The payment expired before it could be captured. + Expired, } impl IntentStatus { /// Indicates whether the payment intent is in terminal state or not pub fn is_in_terminal_state(self) -> bool { match self { - Self::Succeeded | Self::Failed | Self::Cancelled | Self::PartiallyCaptured => true, + Self::Succeeded + | Self::Failed + | Self::Cancelled + | Self::PartiallyCaptured + | Self::Expired => true, Self::Processing | Self::RequiresCustomerAction | Self::RequiresMerchantAction @@ -1664,7 +1674,7 @@ impl IntentStatus { | Self::Failed | Self::Cancelled | Self::PartiallyCaptured - | Self::RequiresCapture | Self::Conflicted => false, + | Self::RequiresCapture | Self::Conflicted | Self::Expired=> false, Self::Processing | Self::RequiresCustomerAction | Self::RequiresMerchantAction @@ -1796,7 +1806,8 @@ impl From<AttemptStatus> for PaymentMethodStatus { | AttemptStatus::PartialChargedAndChargeable | AttemptStatus::ConfirmationAwaited | AttemptStatus::DeviceDataCollectionPending - | AttemptStatus::IntegrityFailure => Self::Inactive, + | AttemptStatus::IntegrityFailure + | AttemptStatus::Expired => Self::Inactive, AttemptStatus::Charged | AttemptStatus::Authorized => Self::Active, } } diff --git a/crates/common_enums/src/transformers.rs b/crates/common_enums/src/transformers.rs index 0dcef36ac97..549be0e0dc6 100644 --- a/crates/common_enums/src/transformers.rs +++ b/crates/common_enums/src/transformers.rs @@ -2121,6 +2121,7 @@ impl From<AttemptStatus> for IntentStatus { | AttemptStatus::CaptureFailed | AttemptStatus::Failure => Self::Failed, AttemptStatus::Voided => Self::Cancelled, + AttemptStatus::Expired => Self::Expired, } } } @@ -2135,6 +2136,7 @@ impl From<IntentStatus> for Option<EventType> { | IntentStatus::RequiresCustomerAction | IntentStatus::Conflicted => Some(EventType::ActionRequired), IntentStatus::Cancelled => Some(EventType::PaymentCancelled), + IntentStatus::Expired => Some(EventType::PaymentExpired), IntentStatus::PartiallyCaptured | IntentStatus::PartiallyCapturedAndCapturable => { Some(EventType::PaymentCaptured) } diff --git a/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs b/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs index 6a0cc9c4610..5b424ec5d4d 100644 --- a/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs @@ -428,6 +428,7 @@ impl ForeignTryFrom<(bool, AdyenWebhookStatus)> for storage_enums::AttemptStatus AdyenWebhookStatus::CancelFailed => Ok(Self::VoidFailed), AdyenWebhookStatus::Captured => Ok(Self::Charged), AdyenWebhookStatus::CaptureFailed => Ok(Self::CaptureFailed), + AdyenWebhookStatus::Expired => Ok(Self::Expired), //If Unexpected Event is received, need to understand how it reached this point //Webhooks with Payment Events only should try to conume this resource object. AdyenWebhookStatus::UnexpectedEvent | AdyenWebhookStatus::Reversed => { @@ -513,6 +514,7 @@ pub enum AdyenWebhookStatus { CaptureFailed, Reversed, UnexpectedEvent, + Expired, } //Creating custom struct which can be consumed in Psync Handler triggered from Webhooks @@ -4798,6 +4800,7 @@ pub enum WebhookEventCode { SecondChargeback, PrearbitrationWon, PrearbitrationLost, + OfferClosed, #[cfg(feature = "payouts")] PayoutThirdparty, #[cfg(feature = "payouts")] @@ -4811,7 +4814,10 @@ pub enum WebhookEventCode { } pub fn is_transaction_event(event_code: &WebhookEventCode) -> bool { - matches!(event_code, WebhookEventCode::Authorisation) + matches!( + event_code, + WebhookEventCode::Authorisation | WebhookEventCode::OfferClosed + ) } pub fn is_capture_or_cancel_event(event_code: &WebhookEventCode) -> bool { @@ -4928,6 +4934,9 @@ pub(crate) fn get_adyen_webhook_event( WebhookEventCode::CaptureFailed => { api_models::webhooks::IncomingWebhookEvent::PaymentIntentCaptureFailure } + WebhookEventCode::OfferClosed => { + api_models::webhooks::IncomingWebhookEvent::PaymentIntentExpired + } #[cfg(feature = "payouts")] WebhookEventCode::PayoutThirdparty => { api_models::webhooks::IncomingWebhookEvent::PayoutCreated @@ -5015,6 +5024,7 @@ impl From<AdyenNotificationRequestItemWH> for AdyenWebhookResponse { AdyenWebhookStatus::CancelFailed } } + WebhookEventCode::OfferClosed => AdyenWebhookStatus::Expired, WebhookEventCode::Capture => { if is_success_scenario(notif.success) { AdyenWebhookStatus::Captured diff --git a/crates/hyperswitch_connectors/src/connectors/chargebee/transformers.rs b/crates/hyperswitch_connectors/src/connectors/chargebee/transformers.rs index 5a3ec2f96f9..6bb4cf345f7 100644 --- a/crates/hyperswitch_connectors/src/connectors/chargebee/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/chargebee/transformers.rs @@ -706,7 +706,8 @@ impl TryFrom<enums::AttemptStatus> for ChargebeeRecordStatus { | enums::AttemptStatus::PaymentMethodAwaited | enums::AttemptStatus::ConfirmationAwaited | enums::AttemptStatus::DeviceDataCollectionPending - | enums::AttemptStatus::IntegrityFailure => Err(errors::ConnectorError::NotSupported { + | enums::AttemptStatus::IntegrityFailure + | enums::AttemptStatus::Expired => Err(errors::ConnectorError::NotSupported { message: "Record back flow is only supported for terminal status".to_string(), connector: "chargebee", } diff --git a/crates/hyperswitch_connectors/src/connectors/paypal/transformers.rs b/crates/hyperswitch_connectors/src/connectors/paypal/transformers.rs index 289fee48d99..9ffc5a0c13a 100644 --- a/crates/hyperswitch_connectors/src/connectors/paypal/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/paypal/transformers.rs @@ -2701,7 +2701,8 @@ impl TryFrom<PaymentsCaptureResponseRouterData<PaypalCaptureResponse>> | storage_enums::AttemptStatus::PaymentMethodAwaited | storage_enums::AttemptStatus::ConfirmationAwaited | storage_enums::AttemptStatus::DeviceDataCollectionPending - | storage_enums::AttemptStatus::Voided => 0, + | storage_enums::AttemptStatus::Voided + | storage_enums::AttemptStatus::Expired => 0, storage_enums::AttemptStatus::Charged | storage_enums::AttemptStatus::PartialCharged | storage_enums::AttemptStatus::PartialChargedAndChargeable diff --git a/crates/hyperswitch_connectors/src/connectors/recurly/transformers.rs b/crates/hyperswitch_connectors/src/connectors/recurly/transformers.rs index b7f7d3d39da..4aef739b979 100644 --- a/crates/hyperswitch_connectors/src/connectors/recurly/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/recurly/transformers.rs @@ -278,7 +278,8 @@ impl TryFrom<enums::AttemptStatus> for RecurlyRecordStatus { | enums::AttemptStatus::PaymentMethodAwaited | enums::AttemptStatus::ConfirmationAwaited | enums::AttemptStatus::DeviceDataCollectionPending - | enums::AttemptStatus::IntegrityFailure => Err(errors::ConnectorError::NotSupported { + | enums::AttemptStatus::IntegrityFailure + | enums::AttemptStatus::Expired => Err(errors::ConnectorError::NotSupported { message: "Record back flow is only supported for terminal status".to_string(), connector: "recurly", } diff --git a/crates/hyperswitch_connectors/src/utils.rs b/crates/hyperswitch_connectors/src/utils.rs index 90a650a2b1f..7b9b314ce5a 100644 --- a/crates/hyperswitch_connectors/src/utils.rs +++ b/crates/hyperswitch_connectors/src/utils.rs @@ -425,7 +425,8 @@ pub(crate) fn is_payment_failure(status: AttemptStatus) -> bool { | AttemptStatus::AuthorizationFailed | AttemptStatus::CaptureFailed | AttemptStatus::VoidFailed - | AttemptStatus::Failure => true, + | AttemptStatus::Failure + | AttemptStatus::Expired => true, AttemptStatus::Started | AttemptStatus::RouterDeclined | AttemptStatus::AuthenticationPending @@ -6295,7 +6296,8 @@ impl FrmTransactionRouterDataRequest for FrmTransactionRouterData { | AttemptStatus::Voided | AttemptStatus::CaptureFailed | AttemptStatus::Failure - | AttemptStatus::AutoRefunded => Some(false), + | AttemptStatus::AutoRefunded + | AttemptStatus::Expired => Some(false), AttemptStatus::AuthenticationSuccessful | AttemptStatus::PartialChargedAndChargeable diff --git a/crates/hyperswitch_domain_models/src/revenue_recovery.rs b/crates/hyperswitch_domain_models/src/revenue_recovery.rs index 6481a81d536..f9506e2ed3d 100644 --- a/crates/hyperswitch_domain_models/src/revenue_recovery.rs +++ b/crates/hyperswitch_domain_models/src/revenue_recovery.rs @@ -150,6 +150,7 @@ impl RecoveryAction { | webhooks::IncomingWebhookEvent::PaymentIntentAuthorizationFailure | webhooks::IncomingWebhookEvent::PaymentIntentCaptureSuccess | webhooks::IncomingWebhookEvent::PaymentIntentCaptureFailure + | webhooks::IncomingWebhookEvent::PaymentIntentExpired | webhooks::IncomingWebhookEvent::PaymentActionRequired | webhooks::IncomingWebhookEvent::EventNotSupported | webhooks::IncomingWebhookEvent::SourceChargeable diff --git a/crates/hyperswitch_domain_models/src/router_data.rs b/crates/hyperswitch_domain_models/src/router_data.rs index 259f280d49b..8cdcfe7e456 100644 --- a/crates/hyperswitch_domain_models/src/router_data.rs +++ b/crates/hyperswitch_domain_models/src/router_data.rs @@ -702,7 +702,8 @@ impl common_enums::IntentStatus::Succeeded | common_enums::IntentStatus::Failed | common_enums::IntentStatus::Cancelled - | common_enums::IntentStatus::Conflicted => Some(MinorUnit::zero()), + | common_enums::IntentStatus::Conflicted + | common_enums::IntentStatus::Expired => Some(MinorUnit::zero()), // For these statuses, update the capturable amount when it reaches terminal / capturable state common_enums::IntentStatus::RequiresCustomerAction | common_enums::IntentStatus::RequiresMerchantAction @@ -737,9 +738,9 @@ impl Some(total_amount) } // No amount is captured - common_enums::IntentStatus::Cancelled | common_enums::IntentStatus::Failed => { - Some(MinorUnit::zero()) - } + common_enums::IntentStatus::Cancelled + | common_enums::IntentStatus::Failed + | common_enums::IntentStatus::Expired => Some(MinorUnit::zero()), // For these statuses, update the amount captured when it reaches terminal state common_enums::IntentStatus::RequiresCustomerAction | common_enums::IntentStatus::RequiresMerchantAction @@ -913,7 +914,8 @@ impl common_enums::IntentStatus::Succeeded | common_enums::IntentStatus::Failed | common_enums::IntentStatus::Cancelled - | common_enums::IntentStatus::Conflicted => Some(MinorUnit::zero()), + | common_enums::IntentStatus::Conflicted + | common_enums::IntentStatus::Expired => Some(MinorUnit::zero()), // For these statuses, update the capturable amount when it reaches terminal / capturable state common_enums::IntentStatus::RequiresCustomerAction | common_enums::IntentStatus::RequiresMerchantAction @@ -951,9 +953,9 @@ impl Some(amount_captured) } // No amount is captured - common_enums::IntentStatus::Cancelled | common_enums::IntentStatus::Failed => { - Some(MinorUnit::zero()) - } + common_enums::IntentStatus::Cancelled + | common_enums::IntentStatus::Failed + | common_enums::IntentStatus::Expired => Some(MinorUnit::zero()), common_enums::IntentStatus::RequiresCapture => { let total_amount = payment_data.payment_attempt.amount_details.get_net_amount(); Some(total_amount) @@ -1149,7 +1151,8 @@ impl common_enums::IntentStatus::Succeeded | common_enums::IntentStatus::Failed | common_enums::IntentStatus::Cancelled - | common_enums::IntentStatus::Conflicted => Some(MinorUnit::zero()), + | common_enums::IntentStatus::Conflicted + | common_enums::IntentStatus::Expired => Some(MinorUnit::zero()), // For these statuses, update the capturable amount when it reaches terminal / capturable state common_enums::IntentStatus::RequiresCustomerAction | common_enums::IntentStatus::RequiresMerchantAction @@ -1186,9 +1189,9 @@ impl Some(amount_captured) } // No amount is captured - common_enums::IntentStatus::Cancelled | common_enums::IntentStatus::Failed => { - Some(MinorUnit::zero()) - } + common_enums::IntentStatus::Cancelled + | common_enums::IntentStatus::Failed + | common_enums::IntentStatus::Expired => Some(MinorUnit::zero()), // For these statuses, update the amount captured when it reaches terminal state common_enums::IntentStatus::RequiresCustomerAction | common_enums::IntentStatus::RequiresMerchantAction @@ -1382,7 +1385,8 @@ impl common_enums::IntentStatus::Succeeded | common_enums::IntentStatus::Failed | common_enums::IntentStatus::Cancelled - | common_enums::IntentStatus::Conflicted => Some(MinorUnit::zero()), + | common_enums::IntentStatus::Conflicted + | common_enums::IntentStatus::Expired => Some(MinorUnit::zero()), // For these statuses, update the capturable amount when it reaches terminal / capturable state common_enums::IntentStatus::RequiresCustomerAction | common_enums::IntentStatus::RequiresMerchantAction @@ -1417,9 +1421,9 @@ impl Some(total_amount) } // No amount is captured - common_enums::IntentStatus::Cancelled | common_enums::IntentStatus::Failed => { - Some(MinorUnit::zero()) - } + common_enums::IntentStatus::Cancelled + | common_enums::IntentStatus::Failed + | common_enums::IntentStatus::Expired => Some(MinorUnit::zero()), // For these statuses, update the amount captured when it reaches terminal state common_enums::IntentStatus::RequiresCustomerAction | common_enums::IntentStatus::RequiresMerchantAction diff --git a/crates/router/src/compatibility/stripe/payment_intents/types.rs b/crates/router/src/compatibility/stripe/payment_intents/types.rs index e8813fad688..acf2f5e03ab 100644 --- a/crates/router/src/compatibility/stripe/payment_intents/types.rs +++ b/crates/router/src/compatibility/stripe/payment_intents/types.rs @@ -421,7 +421,7 @@ impl From<api_enums::IntentStatus> for StripePaymentStatus { api_enums::IntentStatus::Succeeded | api_enums::IntentStatus::PartiallyCaptured => { Self::Succeeded } - api_enums::IntentStatus::Failed => Self::Canceled, + api_enums::IntentStatus::Failed | api_enums::IntentStatus::Expired => Self::Canceled, api_enums::IntentStatus::Processing => Self::Processing, api_enums::IntentStatus::RequiresCustomerAction | api_enums::IntentStatus::RequiresMerchantAction diff --git a/crates/router/src/compatibility/stripe/setup_intents/types.rs b/crates/router/src/compatibility/stripe/setup_intents/types.rs index 3cf996685ce..90df416ec76 100644 --- a/crates/router/src/compatibility/stripe/setup_intents/types.rs +++ b/crates/router/src/compatibility/stripe/setup_intents/types.rs @@ -312,7 +312,7 @@ impl From<api_enums::IntentStatus> for StripeSetupStatus { api_enums::IntentStatus::Succeeded | api_enums::IntentStatus::PartiallyCaptured => { Self::Succeeded } - api_enums::IntentStatus::Failed => Self::Canceled, + api_enums::IntentStatus::Failed | api_enums::IntentStatus::Expired => Self::Canceled, api_enums::IntentStatus::Processing => Self::Processing, api_enums::IntentStatus::RequiresCustomerAction => Self::RequiresAction, api_enums::IntentStatus::RequiresMerchantAction diff --git a/crates/router/src/compatibility/stripe/webhooks.rs b/crates/router/src/compatibility/stripe/webhooks.rs index 3bd0f83b7db..5dad60120ec 100644 --- a/crates/router/src/compatibility/stripe/webhooks.rs +++ b/crates/router/src/compatibility/stripe/webhooks.rs @@ -270,7 +270,8 @@ fn get_stripe_event_type(event_type: api_models::enums::EventType) -> &'static s api_models::enums::EventType::PaymentSucceeded => "payment_intent.succeeded", api_models::enums::EventType::PaymentFailed => "payment_intent.payment_failed", api_models::enums::EventType::PaymentProcessing => "payment_intent.processing", - api_models::enums::EventType::PaymentCancelled => "payment_intent.canceled", + api_models::enums::EventType::PaymentCancelled + | api_models::enums::EventType::PaymentExpired => "payment_intent.canceled", // the below are not really stripe compatible because stripe doesn't provide this api_models::enums::EventType::ActionRequired => "action.required", diff --git a/crates/router/src/connector/utils.rs b/crates/router/src/connector/utils.rs index 525a9d678ae..02839ee8d78 100644 --- a/crates/router/src/connector/utils.rs +++ b/crates/router/src/connector/utils.rs @@ -2195,7 +2195,8 @@ impl FrmTransactionRouterDataRequest for fraud_check::FrmTransactionRouterData { | storage_enums::AttemptStatus::Voided | storage_enums::AttemptStatus::CaptureFailed | storage_enums::AttemptStatus::Failure - | storage_enums::AttemptStatus::AutoRefunded => Some(false), + | storage_enums::AttemptStatus::AutoRefunded + | storage_enums::AttemptStatus::Expired => Some(false), storage_enums::AttemptStatus::AuthenticationSuccessful | storage_enums::AttemptStatus::PartialChargedAndChargeable @@ -2226,7 +2227,8 @@ pub fn is_payment_failure(status: enums::AttemptStatus) -> bool { | common_enums::AttemptStatus::AuthorizationFailed | common_enums::AttemptStatus::CaptureFailed | common_enums::AttemptStatus::VoidFailed - | common_enums::AttemptStatus::Failure => true, + | common_enums::AttemptStatus::Failure + | common_enums::AttemptStatus::Expired => true, common_enums::AttemptStatus::Started | common_enums::AttemptStatus::RouterDeclined | common_enums::AttemptStatus::AuthenticationPending diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs index fd8615ff8af..5651dae946d 100644 --- a/crates/router/src/core/payments.rs +++ b/crates/router/src/core/payments.rs @@ -3143,7 +3143,8 @@ impl ValidateStatusForOperation for &PaymentRedirectSync { | common_enums::IntentStatus::RequiresCapture | common_enums::IntentStatus::PartiallyCaptured | common_enums::IntentStatus::RequiresConfirmation - | common_enums::IntentStatus::PartiallyCapturedAndCapturable => { + | common_enums::IntentStatus::PartiallyCapturedAndCapturable + | common_enums::IntentStatus::Expired => { Err(errors::ApiErrorResponse::PaymentUnexpectedState { current_flow: format!("{self:?}"), field_name: "status".to_string(), diff --git a/crates/router/src/core/payments/helpers.rs b/crates/router/src/core/payments/helpers.rs index 39eeba8223a..9c9d1d69053 100644 --- a/crates/router/src/core/payments/helpers.rs +++ b/crates/router/src/core/payments/helpers.rs @@ -4276,7 +4276,8 @@ pub fn get_attempt_type( | enums::AttemptStatus::AutoRefunded | enums::AttemptStatus::PaymentMethodAwaited | enums::AttemptStatus::DeviceDataCollectionPending - | enums::AttemptStatus::IntegrityFailure => { + | enums::AttemptStatus::IntegrityFailure + | enums::AttemptStatus::Expired => { metrics::MANUAL_RETRY_VALIDATION_FAILED.add( 1, router_env::metric_attributes!(( @@ -4332,7 +4333,8 @@ pub fn get_attempt_type( | enums::IntentStatus::PartiallyCapturedAndCapturable | enums::IntentStatus::Processing | enums::IntentStatus::Succeeded - | enums::IntentStatus::Conflicted => { + | enums::IntentStatus::Conflicted + | enums::IntentStatus::Expired => { Err(report!(errors::ApiErrorResponse::PreconditionFailed { message: format!( "You cannot {action} this payment because it has status {}", @@ -4579,18 +4581,19 @@ pub fn is_manual_retry_allowed( | enums::AttemptStatus::AutoRefunded | enums::AttemptStatus::PaymentMethodAwaited | enums::AttemptStatus::DeviceDataCollectionPending - | storage_enums::AttemptStatus::IntegrityFailure => { + | enums::AttemptStatus::IntegrityFailure + | enums::AttemptStatus::Expired => { logger::error!("Payment Attempt should not be in this state because Attempt to Intent status mapping doesn't allow it"); None } - storage_enums::AttemptStatus::VoidFailed - | storage_enums::AttemptStatus::RouterDeclined - | storage_enums::AttemptStatus::CaptureFailed => Some(false), + enums::AttemptStatus::VoidFailed + | enums::AttemptStatus::RouterDeclined + | enums::AttemptStatus::CaptureFailed => Some(false), - storage_enums::AttemptStatus::AuthenticationFailed - | storage_enums::AttemptStatus::AuthorizationFailed - | storage_enums::AttemptStatus::Failure => Some(true), + enums::AttemptStatus::AuthenticationFailed + | enums::AttemptStatus::AuthorizationFailed + | enums::AttemptStatus::Failure => Some(true), }, enums::IntentStatus::Cancelled | enums::IntentStatus::RequiresCapture @@ -4598,7 +4601,8 @@ pub fn is_manual_retry_allowed( | enums::IntentStatus::PartiallyCapturedAndCapturable | enums::IntentStatus::Processing | enums::IntentStatus::Succeeded - | enums::IntentStatus::Conflicted => Some(false), + | enums::IntentStatus::Conflicted + | enums::IntentStatus::Expired => Some(false), enums::IntentStatus::RequiresCustomerAction | enums::IntentStatus::RequiresMerchantAction diff --git a/crates/router/src/core/payments/operations/payment_attempt_record.rs b/crates/router/src/core/payments/operations/payment_attempt_record.rs index b2834f0bfad..3c5259b6bf1 100644 --- a/crates/router/src/core/payments/operations/payment_attempt_record.rs +++ b/crates/router/src/core/payments/operations/payment_attempt_record.rs @@ -87,7 +87,8 @@ impl ValidateStatusForOperation for PaymentAttemptRecord { | common_enums::IntentStatus::RequiresCapture | common_enums::IntentStatus::PartiallyCaptured | common_enums::IntentStatus::RequiresConfirmation - | common_enums::IntentStatus::PartiallyCapturedAndCapturable => { + | common_enums::IntentStatus::PartiallyCapturedAndCapturable + | common_enums::IntentStatus::Expired => { Err(errors::ApiErrorResponse::PaymentUnexpectedState { current_flow: format!("{self:?}"), field_name: "status".to_string(), diff --git a/crates/router/src/core/payments/operations/payment_capture_v2.rs b/crates/router/src/core/payments/operations/payment_capture_v2.rs index 1b46cb85d4a..13100e7762f 100644 --- a/crates/router/src/core/payments/operations/payment_capture_v2.rs +++ b/crates/router/src/core/payments/operations/payment_capture_v2.rs @@ -43,7 +43,8 @@ impl ValidateStatusForOperation for PaymentsCapture { | common_enums::IntentStatus::RequiresMerchantAction | common_enums::IntentStatus::RequiresPaymentMethod | common_enums::IntentStatus::PartiallyCaptured - | common_enums::IntentStatus::RequiresConfirmation => { + | common_enums::IntentStatus::RequiresConfirmation + | common_enums::IntentStatus::Expired => { Err(errors::ApiErrorResponse::PaymentUnexpectedState { current_flow: format!("{self:?}"), field_name: "status".to_string(), diff --git a/crates/router/src/core/payments/operations/payment_confirm_intent.rs b/crates/router/src/core/payments/operations/payment_confirm_intent.rs index 143d6f7d342..a3b81afb4f8 100644 --- a/crates/router/src/core/payments/operations/payment_confirm_intent.rs +++ b/crates/router/src/core/payments/operations/payment_confirm_intent.rs @@ -53,7 +53,8 @@ impl ValidateStatusForOperation for PaymentIntentConfirm { | common_enums::IntentStatus::RequiresCapture | common_enums::IntentStatus::PartiallyCaptured | common_enums::IntentStatus::RequiresConfirmation - | common_enums::IntentStatus::PartiallyCapturedAndCapturable => { + | common_enums::IntentStatus::PartiallyCapturedAndCapturable + | common_enums::IntentStatus::Expired => { Err(errors::ApiErrorResponse::PaymentUnexpectedState { current_flow: format!("{self:?}"), field_name: "status".to_string(), diff --git a/crates/router/src/core/payments/operations/payment_get.rs b/crates/router/src/core/payments/operations/payment_get.rs index 402c11e2f86..621a6e71a70 100644 --- a/crates/router/src/core/payments/operations/payment_get.rs +++ b/crates/router/src/core/payments/operations/payment_get.rs @@ -42,7 +42,8 @@ impl ValidateStatusForOperation for PaymentGet { | common_enums::IntentStatus::PartiallyCapturedAndCapturable | common_enums::IntentStatus::PartiallyCaptured | common_enums::IntentStatus::Cancelled - | common_enums::IntentStatus::Conflicted => Ok(()), + | common_enums::IntentStatus::Conflicted + | common_enums::IntentStatus::Expired => Ok(()), // These statuses are not valid for this operation common_enums::IntentStatus::RequiresConfirmation | common_enums::IntentStatus::RequiresPaymentMethod => { diff --git a/crates/router/src/core/payments/operations/payment_response.rs b/crates/router/src/core/payments/operations/payment_response.rs index 7fa8a4858f8..425173d4441 100644 --- a/crates/router/src/core/payments/operations/payment_response.rs +++ b/crates/router/src/core/payments/operations/payment_response.rs @@ -2565,7 +2565,8 @@ impl<F: Clone> PostUpdateTracker<F, PaymentConfirmData<F>, types::PaymentsAuthor | common_enums::AttemptStatus::AutoRefunded | common_enums::AttemptStatus::Unresolved | common_enums::AttemptStatus::Pending - | common_enums::AttemptStatus::Failure => (), + | common_enums::AttemptStatus::Failure + | common_enums::AttemptStatus::Expired => (), common_enums::AttemptStatus::Started | common_enums::AttemptStatus::AuthenticationPending diff --git a/crates/router/src/core/payments/operations/payment_session_intent.rs b/crates/router/src/core/payments/operations/payment_session_intent.rs index 8ae5d2cd19d..d713c5175b2 100644 --- a/crates/router/src/core/payments/operations/payment_session_intent.rs +++ b/crates/router/src/core/payments/operations/payment_session_intent.rs @@ -41,7 +41,7 @@ impl ValidateStatusForOperation for PaymentSessionIntent { | common_enums::IntentStatus::RequiresConfirmation | common_enums::IntentStatus::PartiallyCapturedAndCapturable | common_enums::IntentStatus::Succeeded - | common_enums::IntentStatus::Failed | common_enums::IntentStatus::Conflicted => { + | common_enums::IntentStatus::Failed | common_enums::IntentStatus::Conflicted | common_enums::IntentStatus::Expired => { Err(errors::ApiErrorResponse::PreconditionFailed { message: format!( "You cannot create session token for this payment because it has status {intent_status}. Expected status is requires_payment_method.", diff --git a/crates/router/src/core/payments/operations/payment_update_intent.rs b/crates/router/src/core/payments/operations/payment_update_intent.rs index 2c7b2ea4e8b..6e500e3eb0b 100644 --- a/crates/router/src/core/payments/operations/payment_update_intent.rs +++ b/crates/router/src/core/payments/operations/payment_update_intent.rs @@ -59,7 +59,8 @@ impl ValidateStatusForOperation for PaymentUpdateIntent { | common_enums::IntentStatus::RequiresCapture | common_enums::IntentStatus::PartiallyCaptured | common_enums::IntentStatus::RequiresConfirmation - | common_enums::IntentStatus::PartiallyCapturedAndCapturable => { + | common_enums::IntentStatus::PartiallyCapturedAndCapturable + | common_enums::IntentStatus::Expired => { Err(errors::ApiErrorResponse::PaymentUnexpectedState { current_flow: format!("{self:?}"), field_name: "status".to_string(), diff --git a/crates/router/src/core/payments/operations/proxy_payments_intent.rs b/crates/router/src/core/payments/operations/proxy_payments_intent.rs index 30ea6913c6d..3994fd8ef05 100644 --- a/crates/router/src/core/payments/operations/proxy_payments_intent.rs +++ b/crates/router/src/core/payments/operations/proxy_payments_intent.rs @@ -54,7 +54,8 @@ impl ValidateStatusForOperation for PaymentProxyIntent { | common_enums::IntentStatus::RequiresCapture | common_enums::IntentStatus::PartiallyCaptured | common_enums::IntentStatus::RequiresConfirmation - | common_enums::IntentStatus::PartiallyCapturedAndCapturable => { + | common_enums::IntentStatus::PartiallyCapturedAndCapturable + | common_enums::IntentStatus::Expired => { Err(errors::ApiErrorResponse::PaymentUnexpectedState { current_flow: format!("{self:?}"), field_name: "status".to_string(), diff --git a/crates/router/src/core/payments/payment_methods.rs b/crates/router/src/core/payments/payment_methods.rs index e21b3b96105..9bf9d3cc921 100644 --- a/crates/router/src/core/payments/payment_methods.rs +++ b/crates/router/src/core/payments/payment_methods.rs @@ -370,7 +370,8 @@ fn validate_payment_status_for_payment_method_list( | common_enums::IntentStatus::RequiresCapture | common_enums::IntentStatus::PartiallyCaptured | common_enums::IntentStatus::RequiresConfirmation - | common_enums::IntentStatus::PartiallyCapturedAndCapturable => { + | common_enums::IntentStatus::PartiallyCapturedAndCapturable + | common_enums::IntentStatus::Expired => { Err(errors::ApiErrorResponse::PaymentUnexpectedState { current_flow: "list_payment_methods".to_string(), field_name: "status".to_string(), diff --git a/crates/router/src/core/payments/retry.rs b/crates/router/src/core/payments/retry.rs index 8fe9c565e08..aafe25aea67 100644 --- a/crates/router/src/core/payments/retry.rs +++ b/crates/router/src/core/payments/retry.rs @@ -808,7 +808,8 @@ impl<F: Send + Clone + Sync, FData: Send + Sync> | storage_enums::AttemptStatus::ConfirmationAwaited | storage_enums::AttemptStatus::Unresolved | storage_enums::AttemptStatus::DeviceDataCollectionPending - | storage_enums::AttemptStatus::IntegrityFailure => false, + | storage_enums::AttemptStatus::IntegrityFailure + | storage_enums::AttemptStatus::Expired => false, storage_enums::AttemptStatus::AuthenticationFailed | storage_enums::AttemptStatus::AuthorizationFailed diff --git a/crates/router/src/core/payments/transformers.rs b/crates/router/src/core/payments/transformers.rs index 6f5689ed1cb..0cb84fc75cf 100644 --- a/crates/router/src/core/payments/transformers.rs +++ b/crates/router/src/core/payments/transformers.rs @@ -1943,17 +1943,21 @@ where let next_action_containing_wait_screen = wait_screen_next_steps_check(payment_attempt.clone())?; - let next_action = payment_attempt - .redirection_data - .as_ref() - .map(|_| api_models::payments::NextActionData::RedirectToUrl { redirect_to_url }) - .or(next_action_containing_wait_screen.map(|wait_screen_data| { - api_models::payments::NextActionData::WaitScreenInformation { - display_from_timestamp: wait_screen_data.display_from_timestamp, - display_to_timestamp: wait_screen_data.display_to_timestamp, - poll_config: wait_screen_data.poll_config, - } - })); + let next_action = if payment_intent.status.is_in_terminal_state() { + None + } else { + payment_attempt + .redirection_data + .as_ref() + .map(|_| api_models::payments::NextActionData::RedirectToUrl { redirect_to_url }) + .or(next_action_containing_wait_screen.map(|wait_screen_data| { + api_models::payments::NextActionData::WaitScreenInformation { + display_from_timestamp: wait_screen_data.display_from_timestamp, + display_to_timestamp: wait_screen_data.display_to_timestamp, + poll_config: wait_screen_data.poll_config, + } + })) + }; let connector_token_details = payment_attempt .connector_token_details @@ -2641,136 +2645,142 @@ where } else { let mut next_action_response = None; - let bank_transfer_next_steps = bank_transfer_next_steps_check(payment_attempt.clone())?; + // Early exit for terminal payment statuses - don't evaluate next_action at all + if payment_intent.status.is_in_terminal_state() { + next_action_response = None; + } else { + let bank_transfer_next_steps = bank_transfer_next_steps_check(payment_attempt.clone())?; - let next_action_voucher = voucher_next_steps_check(payment_attempt.clone())?; + let next_action_voucher = voucher_next_steps_check(payment_attempt.clone())?; - let next_action_mobile_payment = mobile_payment_next_steps_check(&payment_attempt)?; + let next_action_mobile_payment = mobile_payment_next_steps_check(&payment_attempt)?; - let next_action_containing_qr_code_url = qr_code_next_steps_check(payment_attempt.clone())?; + let next_action_containing_qr_code_url = + qr_code_next_steps_check(payment_attempt.clone())?; - let papal_sdk_next_action = paypal_sdk_next_steps_check(payment_attempt.clone())?; + let papal_sdk_next_action = paypal_sdk_next_steps_check(payment_attempt.clone())?; - let next_action_containing_fetch_qr_code_url = - fetch_qr_code_url_next_steps_check(payment_attempt.clone())?; + let next_action_containing_fetch_qr_code_url = + fetch_qr_code_url_next_steps_check(payment_attempt.clone())?; - let next_action_containing_wait_screen = - wait_screen_next_steps_check(payment_attempt.clone())?; + let next_action_containing_wait_screen = + wait_screen_next_steps_check(payment_attempt.clone())?; - let next_action_invoke_hidden_frame = next_action_invoke_hidden_frame(&payment_attempt)?; + let next_action_invoke_hidden_frame = + next_action_invoke_hidden_frame(&payment_attempt)?; - if payment_intent.status == enums::IntentStatus::RequiresCustomerAction - || bank_transfer_next_steps.is_some() - || next_action_voucher.is_some() - || next_action_containing_qr_code_url.is_some() - || next_action_containing_wait_screen.is_some() - || papal_sdk_next_action.is_some() - || next_action_containing_fetch_qr_code_url.is_some() - || payment_data.get_authentication().is_some() - { - next_action_response = bank_transfer_next_steps - .map(|bank_transfer| { - api_models::payments::NextActionData::DisplayBankTransferInformation { - bank_transfer_steps_and_charges_details: bank_transfer, - } - }) - .or(next_action_voucher.map(|voucher_data| { - api_models::payments::NextActionData::DisplayVoucherInformation { - voucher_details: voucher_data, - } - })) - .or(next_action_mobile_payment.map(|mobile_payment_data| { - api_models::payments::NextActionData::CollectOtp { - consent_data_required: mobile_payment_data.consent_data_required, - } - })) - .or(next_action_containing_qr_code_url.map(|qr_code_data| { - api_models::payments::NextActionData::foreign_from(qr_code_data) - })) - .or(next_action_containing_fetch_qr_code_url.map(|fetch_qr_code_data| { - api_models::payments::NextActionData::FetchQrCodeInformation { - qr_code_fetch_url: fetch_qr_code_data.qr_code_fetch_url - } - })) - .or(papal_sdk_next_action.map(|paypal_next_action_data| { - api_models::payments::NextActionData::InvokeSdkClient{ - next_action_data: paypal_next_action_data - } - })) - .or(next_action_containing_wait_screen.map(|wait_screen_data| { - api_models::payments::NextActionData::WaitScreenInformation { - display_from_timestamp: wait_screen_data.display_from_timestamp, - display_to_timestamp: wait_screen_data.display_to_timestamp, - poll_config: wait_screen_data.poll_config, - } - })) - .or(payment_attempt.authentication_data.as_ref().map(|_| { - // Check if iframe redirection is enabled in the business profile - let redirect_url = helpers::create_startpay_url( - base_url, - &payment_attempt, - &payment_intent, - ); - // Check if redirection inside popup is enabled in the payment intent - if payment_intent.is_iframe_redirection_enabled.unwrap_or(false) { - api_models::payments::NextActionData::RedirectInsidePopup { - popup_url: redirect_url, - redirect_response_url:router_return_url + if payment_intent.status == enums::IntentStatus::RequiresCustomerAction + || bank_transfer_next_steps.is_some() + || next_action_voucher.is_some() + || next_action_containing_qr_code_url.is_some() + || next_action_containing_wait_screen.is_some() + || papal_sdk_next_action.is_some() + || next_action_containing_fetch_qr_code_url.is_some() + || payment_data.get_authentication().is_some() + { + next_action_response = bank_transfer_next_steps + .map(|bank_transfer| { + api_models::payments::NextActionData::DisplayBankTransferInformation { + bank_transfer_steps_and_charges_details: bank_transfer, } - } else { - api_models::payments::NextActionData::RedirectToUrl { - redirect_to_url: redirect_url, + }) + .or(next_action_voucher.map(|voucher_data| { + api_models::payments::NextActionData::DisplayVoucherInformation { + voucher_details: voucher_data, } - } - })) - .or(match payment_data.get_authentication(){ - Some(authentication_store) => { - let authentication = &authentication_store.authentication; - if payment_intent.status == common_enums::IntentStatus::RequiresCustomerAction && authentication_store.cavv.is_none() && authentication.is_separate_authn_required(){ - // if preAuthn and separate authentication needed. - let poll_config = payment_data.get_poll_config().unwrap_or_default(); - let request_poll_id = core_utils::get_external_authentication_request_poll_id(&payment_intent.payment_id); - let payment_connector_name = payment_attempt.connector - .as_ref() - .get_required_value("connector")?; - Some(api_models::payments::NextActionData::ThreeDsInvoke { - three_ds_data: api_models::payments::ThreeDsData { - three_ds_authentication_url: helpers::create_authentication_url(base_url, &payment_attempt), - three_ds_authorize_url: helpers::create_authorize_url( - base_url, - &payment_attempt, - payment_connector_name, - ), - three_ds_method_details: authentication.three_ds_method_url.as_ref().zip(authentication.three_ds_method_data.as_ref()).map(|(three_ds_method_url,three_ds_method_data )|{ - api_models::payments::ThreeDsMethodData::AcsThreeDsMethodData { - three_ds_method_data_submission: true, - three_ds_method_data: Some(three_ds_method_data.clone()), - three_ds_method_url: Some(three_ds_method_url.to_owned()), - } - }).unwrap_or(api_models::payments::ThreeDsMethodData::AcsThreeDsMethodData { - three_ds_method_data_submission: false, - three_ds_method_data: None, - three_ds_method_url: None, - }), - poll_config: api_models::payments::PollConfigResponse {poll_id: request_poll_id, delay_in_secs: poll_config.delay_in_secs, frequency: poll_config.frequency}, - message_version: authentication.message_version.as_ref() - .map(|version| version.to_string()), - directory_server_id: authentication.directory_server_id.clone(), - }, - }) - }else{ - None + })) + .or(next_action_mobile_payment.map(|mobile_payment_data| { + api_models::payments::NextActionData::CollectOtp { + consent_data_required: mobile_payment_data.consent_data_required, } - }, - None => None - }) - .or(match next_action_invoke_hidden_frame{ - Some(threeds_invoke_data) => Some(construct_connector_invoke_hidden_frame( - threeds_invoke_data, - )?), - None => None - - }); + })) + .or(next_action_containing_qr_code_url.map(|qr_code_data| { + api_models::payments::NextActionData::foreign_from(qr_code_data) + })) + .or(next_action_containing_fetch_qr_code_url.map(|fetch_qr_code_data| { + api_models::payments::NextActionData::FetchQrCodeInformation { + qr_code_fetch_url: fetch_qr_code_data.qr_code_fetch_url + } + })) + .or(papal_sdk_next_action.map(|paypal_next_action_data| { + api_models::payments::NextActionData::InvokeSdkClient{ + next_action_data: paypal_next_action_data + } + })) + .or(next_action_containing_wait_screen.map(|wait_screen_data| { + api_models::payments::NextActionData::WaitScreenInformation { + display_from_timestamp: wait_screen_data.display_from_timestamp, + display_to_timestamp: wait_screen_data.display_to_timestamp, + poll_config: wait_screen_data.poll_config, + } + })) + .or(payment_attempt.authentication_data.as_ref().map(|_| { + // Check if iframe redirection is enabled in the business profile + let redirect_url = helpers::create_startpay_url( + base_url, + &payment_attempt, + &payment_intent, + ); + // Check if redirection inside popup is enabled in the payment intent + if payment_intent.is_iframe_redirection_enabled.unwrap_or(false) { + api_models::payments::NextActionData::RedirectInsidePopup { + popup_url: redirect_url, + redirect_response_url:router_return_url + } + } else { + api_models::payments::NextActionData::RedirectToUrl { + redirect_to_url: redirect_url, + } + } + })) + .or(match payment_data.get_authentication(){ + Some(authentication_store) => { + let authentication = &authentication_store.authentication; + if payment_intent.status == common_enums::IntentStatus::RequiresCustomerAction && authentication_store.cavv.is_none() && authentication.is_separate_authn_required(){ + // if preAuthn and separate authentication needed. + let poll_config = payment_data.get_poll_config().unwrap_or_default(); + let request_poll_id = core_utils::get_external_authentication_request_poll_id(&payment_intent.payment_id); + let payment_connector_name = payment_attempt.connector + .as_ref() + .get_required_value("connector")?; + Some(api_models::payments::NextActionData::ThreeDsInvoke { + three_ds_data: api_models::payments::ThreeDsData { + three_ds_authentication_url: helpers::create_authentication_url(base_url, &payment_attempt), + three_ds_authorize_url: helpers::create_authorize_url( + base_url, + &payment_attempt, + payment_connector_name, + ), + three_ds_method_details: authentication.three_ds_method_url.as_ref().zip(authentication.three_ds_method_data.as_ref()).map(|(three_ds_method_url,three_ds_method_data )|{ + api_models::payments::ThreeDsMethodData::AcsThreeDsMethodData { + three_ds_method_data_submission: true, + three_ds_method_data: Some(three_ds_method_data.clone()), + three_ds_method_url: Some(three_ds_method_url.to_owned()), + } + }).unwrap_or(api_models::payments::ThreeDsMethodData::AcsThreeDsMethodData { + three_ds_method_data_submission: false, + three_ds_method_data: None, + three_ds_method_url: None, + }), + poll_config: api_models::payments::PollConfigResponse {poll_id: request_poll_id, delay_in_secs: poll_config.delay_in_secs, frequency: poll_config.frequency}, + message_version: authentication.message_version.as_ref() + .map(|version| version.to_string()), + directory_server_id: authentication.directory_server_id.clone(), + }, + }) + }else{ + None + } + }, + None => None + }) + .or(match next_action_invoke_hidden_frame{ + Some(threeds_invoke_data) => Some(construct_connector_invoke_hidden_frame( + threeds_invoke_data, + )?), + None => None + }); + } }; // next action check for third party sdk session (for ex: Apple pay through trustpay has third party sdk session response) diff --git a/crates/router/src/core/revenue_recovery/transformers.rs b/crates/router/src/core/revenue_recovery/transformers.rs index a4e40c69b72..76f987673da 100644 --- a/crates/router/src/core/revenue_recovery/transformers.rs +++ b/crates/router/src/core/revenue_recovery/transformers.rs @@ -35,7 +35,8 @@ impl ForeignFrom<AttemptStatus> for RevenueRecoveryPaymentsAttemptStatus { | AttemptStatus::AuthenticationPending | AttemptStatus::DeviceDataCollectionPending | AttemptStatus::Unresolved - | AttemptStatus::IntegrityFailure => Self::InvalidStatus(s.to_string()), + | AttemptStatus::IntegrityFailure + | AttemptStatus::Expired => Self::InvalidStatus(s.to_string()), } } } diff --git a/crates/router/src/core/routing/helpers.rs b/crates/router/src/core/routing/helpers.rs index 32a7b560566..5d5a16912e2 100644 --- a/crates/router/src/core/routing/helpers.rs +++ b/crates/router/src/core/routing/helpers.rs @@ -1714,9 +1714,8 @@ fn get_desired_payment_status_for_dynamic_routing_metrics( | common_enums::AttemptStatus::IntegrityFailure | common_enums::AttemptStatus::PaymentMethodAwaited | common_enums::AttemptStatus::ConfirmationAwaited - | common_enums::AttemptStatus::DeviceDataCollectionPending => { - common_enums::AttemptStatus::Pending - } + | common_enums::AttemptStatus::DeviceDataCollectionPending + | common_enums::AttemptStatus::Expired => common_enums::AttemptStatus::Pending, } } @@ -1734,7 +1733,9 @@ impl ForeignFrom<common_enums::AttemptStatus> for open_router::TxnStatus { common_enums::AttemptStatus::Charged => Self::Charged, common_enums::AttemptStatus::Authorizing => Self::Authorizing, common_enums::AttemptStatus::CodInitiated => Self::CODInitiated, - common_enums::AttemptStatus::Voided => Self::Voided, + common_enums::AttemptStatus::Voided | common_enums::AttemptStatus::Expired => { + Self::Voided + } common_enums::AttemptStatus::VoidInitiated => Self::VoidInitiated, common_enums::AttemptStatus::CaptureInitiated => Self::CaptureInitiated, common_enums::AttemptStatus::CaptureFailed => Self::CaptureFailed, diff --git a/crates/router/src/types.rs b/crates/router/src/types.rs index 717140cc0ed..4887a80f31a 100644 --- a/crates/router/src/types.rs +++ b/crates/router/src/types.rs @@ -296,12 +296,15 @@ impl Capturable for PaymentsAuthorizeData { { match payment_data.get_capture_method().unwrap_or_default() { - common_enums::CaptureMethod::Automatic|common_enums::CaptureMethod::SequentialAutomatic => { + common_enums::CaptureMethod::Automatic + | common_enums::CaptureMethod::SequentialAutomatic => { let intent_status = common_enums::IntentStatus::foreign_from(attempt_status); match intent_status { common_enums::IntentStatus::Succeeded | common_enums::IntentStatus::Failed - | common_enums::IntentStatus::Processing | common_enums::IntentStatus::Conflicted => Some(0), + | common_enums::IntentStatus::Processing + | common_enums::IntentStatus::Conflicted + | common_enums::IntentStatus::Expired => Some(0), common_enums::IntentStatus::Cancelled | common_enums::IntentStatus::PartiallyCaptured | common_enums::IntentStatus::RequiresCustomerAction @@ -341,7 +344,8 @@ impl Capturable for PaymentsCaptureData { match intent_status { common_enums::IntentStatus::Succeeded | common_enums::IntentStatus::PartiallyCaptured - | common_enums::IntentStatus::Conflicted => Some(0), + | common_enums::IntentStatus::Conflicted + | common_enums::IntentStatus::Expired => Some(0), common_enums::IntentStatus::Processing | common_enums::IntentStatus::Cancelled | common_enums::IntentStatus::Failed @@ -383,9 +387,11 @@ impl Capturable for CompleteAuthorizeData { common_enums::CaptureMethod::Automatic | common_enums::CaptureMethod::SequentialAutomatic => { let intent_status = common_enums::IntentStatus::foreign_from(attempt_status); match intent_status { - common_enums::IntentStatus::Succeeded| - common_enums::IntentStatus::Failed| - common_enums::IntentStatus::Processing | common_enums::IntentStatus::Conflicted => Some(0), + common_enums::IntentStatus::Succeeded + | common_enums::IntentStatus::Failed + | common_enums::IntentStatus::Processing + | common_enums::IntentStatus::Conflicted + | common_enums::IntentStatus::Expired => Some(0), common_enums::IntentStatus::Cancelled | common_enums::IntentStatus::PartiallyCaptured | common_enums::IntentStatus::RequiresCustomerAction | common_enums::IntentStatus::RequiresMerchantAction @@ -433,7 +439,8 @@ impl Capturable for PaymentsCancelData { common_enums::IntentStatus::Cancelled | common_enums::IntentStatus::Processing | common_enums::IntentStatus::PartiallyCaptured - | common_enums::IntentStatus::Conflicted => Some(0), + | common_enums::IntentStatus::Conflicted + | common_enums::IntentStatus::Expired => Some(0), common_enums::IntentStatus::Succeeded | common_enums::IntentStatus::Failed | common_enums::IntentStatus::RequiresCustomerAction diff --git a/crates/router/src/types/transformers.rs b/crates/router/src/types/transformers.rs index 5cd1c3d3bd1..daf630e6894 100644 --- a/crates/router/src/types/transformers.rs +++ b/crates/router/src/types/transformers.rs @@ -168,7 +168,7 @@ impl ForeignTryFrom<storage_enums::AttemptStatus> for storage_enums::CaptureStat | storage_enums::AttemptStatus::PaymentMethodAwaited | storage_enums::AttemptStatus::ConfirmationAwaited | storage_enums::AttemptStatus::DeviceDataCollectionPending - | storage_enums::AttemptStatus::PartialChargedAndChargeable => { + | storage_enums::AttemptStatus::PartialChargedAndChargeable | storage_enums::AttemptStatus::Expired => { Err(errors::ApiErrorResponse::PreconditionFailed { message: "AttemptStatus must be one of these for multiple partial captures [Charged, PartialCharged, Pending, CaptureInitiated, Failure, CaptureFailed]".into(), }.into()) diff --git a/migrations/2025-07-24-214849_add_expired_to_intent_and_attempt_status_and_event/down.sql b/migrations/2025-07-24-214849_add_expired_to_intent_and_attempt_status_and_event/down.sql new file mode 100644 index 00000000000..e0ac49d1ecf --- /dev/null +++ b/migrations/2025-07-24-214849_add_expired_to_intent_and_attempt_status_and_event/down.sql @@ -0,0 +1 @@ +SELECT 1; diff --git a/migrations/2025-07-24-214849_add_expired_to_intent_and_attempt_status_and_event/up.sql b/migrations/2025-07-24-214849_add_expired_to_intent_and_attempt_status_and_event/up.sql new file mode 100644 index 00000000000..ae322e833e4 --- /dev/null +++ b/migrations/2025-07-24-214849_add_expired_to_intent_and_attempt_status_and_event/up.sql @@ -0,0 +1,5 @@ +ALTER TYPE "IntentStatus" ADD VALUE IF NOT EXISTS 'expired'; + +ALTER TYPE "AttemptStatus" ADD VALUE IF NOT EXISTS 'expired'; + +ALTER TYPE "EventType" ADD VALUE IF NOT EXISTS 'payment_expired'; \ No newline at end of file

2025-07-22T15:19:21Z

## Type of Change - [x] New feature ## Description This PR implements payment expiration handling for QR code-based payments through Adyen's OFFER_CLOSED webhook and fixes next_action display for terminal payment states. ### Changes: 1. Adyen `OFFER_CLOSED` webhook: - Added `OfferClosed` to `WebhookEventCode` enum - Handle `OfferClosed` events as `Expired` status in AttemptStatus - Maps `OFFER_CLOSED` events to `PaymentIntentExpired` webhook 2. Added `Expired` status support: - Added to both `AttemptStatus` and `IntentStatus` enums - Database migration for new enum values - Add `PaymentExpired` event type for outgoing webhooks 3. Fixed next_action for terminal payments - Prevents showing QR codes/redirects data for terminal payments ## Motivation and Context QR code payments (like PIX) have expiration times. When they expire, Adyen sends OFFER_CLOSED webhooks, but Hyperswitch wasn't handling these properly. Additionally, cancelled payments were still showing actionable `next_action` content. ## How did you test it? <details> <summary>1. Create a Pix Payment (with expiry)</summary> cURL curl --location --request POST 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_W8rGDzCct9xjU2Rqd8xxZubP9rRJ4u1Y42J1im7qplUxjOgWmJS4ZPq9lRfvOCnd' \ --data-raw '{"amount":4500,"currency":"BRL","confirm":true,"profile_id":"pro_HvmsPUKxoCtI58mtCUhg","capture_on":"2022-09-10T10:11:12Z","connector":["adyen"],"customer_id":"cus_HXi1vEcMXQ74qsaNq57p","email":"[email protected]","return_url":"https://google.com","payment_method":"bank_transfer","payment_method_type":"pix","payment_method_data":{"bank_transfer":{"pix":{"pix_key":"test","cpf":"test","cnpj":"test","expiry_date":"2025-07-22T14:58:00Z"}}},"billing":{"address":{"line1":"1467","line2":"Harrison Street","line3":"Harrison Street","city":"San Fransico","state":"California","zip":"94122","country":"BR","first_name":"joseph","last_name":"Doe"},"phone":{"number":"8056594427","country_code":"+91"},"email":"[email protected]"},"metadata":{"Force-PSP":"Adyen","udf1":"value1","new_customer":"true","login_date":"2019-09-10T10:11:12Z"},"browser_info":{"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36","accept_header":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8","language":"en-US","color_depth":32,"screen_height":1117,"screen_width":1728,"time_zone":-330,"java_enabled":true,"java_script_enabled":true,"ip_address":"127.0.0.1"},"customer_acceptance":{"acceptance_type":"online","accepted_at":"1963-05-03T04:07:52.723Z","online":{"ip_address":"127.0.0.1","user_agent":"amet irure esse"}},"session_expiry":60}' Response {"payment_id":"pay_8P2b5MuSkplj8d3U06Nj","merchant_id":"merchant_1753193103","status":"requires_customer_action","amount":4500,"net_amount":4500,"shipping_cost":null,"amount_capturable":4500,"amount_received":null,"connector":"adyen","client_secret":"pay_8P2b5MuSkplj8d3U06Nj_secret_px8ZGtda34okt5ngtFdb","created":"2025-07-22T14:57:52.108Z","currency":"BRL","customer_id":"cus_HXi1vEcMXQ74qsaNq57p","customer":{"id":"cus_HXi1vEcMXQ74qsaNq57p","name":"John Nether","email":"[email protected]","phone":"6168205362","phone_country_code":"+1"},"description":null,"refunds":null,"disputes":null,"mandate_id":null,"mandate_data":null,"setup_future_usage":null,"off_session":null,"capture_on":null,"capture_method":null,"payment_method":"bank_transfer","payment_method_data":{"bank_transfer":{"pix":{"pix_key":"test","cpf":"test","cnpj":"test","source_bank_account_id":null,"destination_bank_account_id":null,"expiry_date":"2025-07-22T14:58:00.000Z"}},"billing":null},"payment_token":null,"shipping":null,"billing":{"address":{"city":"San Fransico","country":"BR","line1":"1467","line2":"Harrison Street","line3":"Harrison Street","zip":"94122","state":"California","first_name":"joseph","last_name":"Doe"},"phone":{"number":"8056594427","country_code":"+91"},"email":"[email protected]"},"order_details":null,"email":"[email protected]","name":"John Nether","phone":"6168205362","return_url":"https://google.com/","authentication_type":"no_three_ds","statement_descriptor_name":null,"statement_descriptor_suffix":null,"next_action":{"type":"qr_code_information","image_data_url":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAQgAAAEICAAAAACGnTUjAAAGJElEQVR4Ae3gAZAkSZIkSRKLqpm7R0REZmZmVlVVVVV3d3d3d/fMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMdHd3d3dXV1VVVVVmZkZGRIS7m5kKz0xmV3d1d3dPz8zMzMxMYjVXAVSuAqByFQCVqwCoXAVA5SoAKlcBULkKgMpVAFSuAqByFQCVqwCoXAVA5SoAKlcBULkKgMpVAFSuAqByFQCVqwCoXAVA5SoAKlcBULkKgMpVAFSuAqByFQCVqwCoXAVA5SoAKlcBULkKgMq/QPzbmCvEFeY5iedkrhDPn7lC/NuYF4rKVQBUrgKgchUAlasAqFwFQOUqACpXAVB5EZkXjXhO5gpxhXnhzHMSz5950YgXCZWrAKhcBUDlKgAqVwFQuQqAylUAVK4CoPKvJJ4/88KZK8QV5grx/IkrzAsnnj/zr0LlKgAqVwFQuQqAylUAVK4CoHIVAJWrAKj8JxPPn7jCvHDiCvOfispVAFSuAqByFQCVqwCoXAVA5SoAKlcBUPkvZq4Qz5/4b0HlKgAqVwFQuQqAylUAVK4CoHIVAJWrAKj8K5l/H/GcxBXmCvOcxAtn/kNQuQqAylUAVK4CoHIVAJWrAKhcBUDlKgAqLyLx72OuEFeYK8RzEleYF078h6JyFQCVqwCoXAVA5SoAKlcBULkKgMpVAFT+Bea/hrjCvHDmPwWVqwCoXAVA5SoAKlcBULkKgMpVAFSuAqDyLxBXmOdPXGGuEM+fuMK8aMQV5grxojHPSVxhXigqVwFQuQqAylUAVK4CoHIVAJWrAKhcBYDMv494TuYK8fyZK8S/jnn+xBXmOYkrzIuEylUAVK4CoHIVAJWrAKhcBUDlKgAqVwFQ+VcSz5+5QlxhrhAvGvOcxBXmhTPPn/lXoXIVAJWrAKhcBUDlKgAqVwFQuQqAylUAVP4F4oUzV4grzPNnXjTiCvPCiSvMcxJXmH8VKlcBULkKgMpVAFSuAqByFQCVqwCoXAWAzAsnrjBXiBeNeU7iOZnnJJ4/c4V4/swV4oUzLxSVqwCoXAVA5SoAKlcBULkKgMpVAFSuAqDyIhJXmOdPXGGuEFeYF05cYZ6TuEJcYa4QV5grxHMy/yZUrgKgchUAlasAqFwFQOUqACpXAVC5CgCZfxtxhXlO4grznMQV5grxr2Oek3jhzL8KlasAqFwFQOUqACpXAVC5CoDKVQBUrgKg8m9krhDPyTwncYV5/swV4gpzhbjCvGjMFeIKcYV5kVC5CoDKVQBUrgKgchUAlasAqFwFQOUqAGReOPH8medPPCfznMQV5grxnMxzEv865grxnMwLReUqACpXAVC5CoDKVQBUrgKgchUAlasAkPnPJa4wL5x44czzJ64wz0k8J/NCUbkKgMpVAFSuAqByFQCVqwCoXAVA5SoAKv8C8W9j/nXMcxLPn7jCPH/iCvOvQuUqACpXAVC5CoDKVQBUrgKgchUAlasAqLyIzItGPCdzhbjCPCdxhblCXGGuEM/JvGjEczIvFJWrAKhcBUDlKgAqVwFQuQqAylUAVK4CoPKvJJ4/8/yJK8wV4jmZK8QLJ144cYV5TuJFQuUqACpXAVC5CoDKVQBUrgKgchUAlasAqPwnM1eI52SuEFeYfxvz/Il/FSpXAVC5CoDKVQBUrgKgchUAlasAqFwFQOW/iXhO4jmZ589cIZ6TuMI8J/MioXIVAJWrAKhcBUDlKgAqVwFQuQqAylUAVP6VzL+NeU7iCnOFuMI8f+YK8ZzEFeYK8W9C5SoAKlcBULkKgMpVAFSuAqByFQCVqwCovIjEv424wlwhrjBXiOdPXGGuEC8ac4W4QlxhXigqVwFQuQqAylUAVK4CoHIVAJWrAKhcBYDMVQCVqwCoXAVA5SoAKlcBULkKgMpVAFSuAqByFQCVqwCoXAVA5SoAKlcBULkKgMpVAFSuAqByFQCVqwCoXAVA5SoAKlcBULkKgMpVAFSuAqByFQCVqwCoXAVA5SoAKlcBULkKgMpVAFSuAuAfAfHRhAhvVmeEAAAAAElFTkSuQmCC","display_to_timestamp":1753196280000,"qr_code_url":"https://test.adyen.com/hpp/generateQRCodeImage.shtml?url=TestQRCodeEMVToken","display_text":null,"border_color":null},"cancellation_reason":null,"error_code":null,"error_message":null,"unified_code":null,"unified_message":null,"payment_experience":null,"payment_method_type":"pix","connector_label":null,"business_country":null,"business_label":"default","business_sub_label":null,"allowed_payment_method_types":null,"ephemeral_key":{"customer_id":"cus_HXi1vEcMXQ74qsaNq57p","created_at":1753196272,"expires":1753199872,"secret":"epk_7b539192a86b4d3baf83c0dcc93da9a6"},"manual_retry_allowed":null,"connector_transaction_id":"BGC4GRDTH5V3NDV5","frm_message":null,"metadata":{"udf1":"value1","Force-PSP":"Adyen","login_date":"2019-09-10T10:11:12Z","new_customer":"true"},"connector_metadata":null,"feature_metadata":null,"reference_id":"BGC4GRDTH5V3NDV5","payment_link":null,"profile_id":"pro_HvmsPUKxoCtI58mtCUhg","surcharge_details":null,"attempt_count":1,"merchant_decision":null,"merchant_connector_id":"mca_c5mj7ZUwHtsNKo5EfexQ","incremental_authorization_allowed":null,"authorization_count":null,"incremental_authorizations":null,"external_authentication_details":null,"external_3ds_authentication_attempted":false,"expires_on":"2025-07-22T14:58:52.108Z","fingerprint":null,"browser_info":{"language":"en-US","time_zone":-330,"ip_address":"127.0.0.1","user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36","color_depth":32,"java_enabled":true,"screen_width":1728,"accept_header":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8","screen_height":1117,"java_script_enabled":true},"payment_method_id":null,"payment_method_status":null,"updated":"2025-07-22T14:57:53.084Z","split_payments":null,"frm_metadata":null,"extended_authorization_applied":null,"capture_before":null,"merchant_order_reference_id":null,"order_tax_amount":null,"connector_mandate_id":null,"card_discovery":null,"force_3ds_challenge":false,"force_3ds_challenge_trigger":false,"issuer_error_code":null,"issuer_error_message":null,"is_iframe_redirection_enabled":null,"whole_connector_response":null} Wait for it to expire Receive incoming webhooks for OFFER_CLOSED </details> <details> <summary>2. Verify outgoing webhook</summary> {"merchant_id":"merchant_1753397156","event_id":"evt_019841219a907f8084065fb9d9e2842e","event_type":"payment_expired","content":{"type":"payment_details","object":{"payment_id":"pay_GE6MyVzON0EXIcyOFh5p","merchant_id":"merchant_1753397156","status":"expired","amount":4500,"net_amount":4500,"shipping_cost":null,"amount_capturable":0,"amount_received":null,"connector":"adyen","client_secret":"pay_GE6MyVzON0EXIcyOFh5p_secret_44s26p5R8wAp9cXOQ3Qt","created":"2025-07-25T10:26:23.600Z","currency":"BRL","customer_id":"cus_J2NWO1RbnwNdiEO6KdIt","customer":{"id":"cus_J2NWO1RbnwNdiEO6KdIt","name":null,"email":"[email protected]","phone":null,"phone_country_code":null},"description":null,"refunds":null,"disputes":null,"mandate_id":null,"mandate_data":null,"setup_future_usage":null,"off_session":null,"capture_on":null,"capture_method":null,"payment_method":"bank_transfer","payment_method_data":{"bank_transfer":{"pix":{"pix_key":"test","cpf":"test","cnpj":"test","source_bank_account_id":null,"destination_bank_account_id":null,"expiry_date":"2025-07-25T10:28:00.000Z"}},"billing":null},"payment_token":null,"shipping":null,"billing":{"address":{"city":"San Fransico","country":"BR","line1":"1467","line2":"Harrison Street","line3":"Harrison Street","zip":"94122","state":"California","first_name":"joseph","last_name":"Doe"},"phone":{"number":"8056594427","country_code":"+91"},"email":"[email protected]"},"order_details":null,"email":"[email protected]","name":null,"phone":null,"return_url":"https://google.com/","authentication_type":"no_three_ds","statement_descriptor_name":null,"statement_descriptor_suffix":null,"next_action":null,"cancellation_reason":null,"error_code":null,"error_message":null,"unified_code":null,"unified_message":null,"payment_experience":null,"payment_method_type":"pix","connector_label":null,"business_country":null,"business_label":"default","business_sub_label":null,"allowed_payment_method_types":null,"ephemeral_key":null,"manual_retry_allowed":false,"connector_transaction_id":"BXSX5X9VLW5PB2V5","frm_message":null,"metadata":{"udf1":"value1","Force-PSP":"Adyen","login_date":"2019-09-10T10:11:12Z","new_customer":"true"},"connector_metadata":null,"feature_metadata":null,"reference_id":"pay_GE6MyVzON0EXIcyOFh5p_1","payment_link":null,"profile_id":"pro_zJpGj6xSodQqoBYltbzl","surcharge_details":null,"attempt_count":1,"merchant_decision":null,"merchant_connector_id":"mca_PTFqfuKnofhHIFDFLBsu","incremental_authorization_allowed":null,"authorization_count":null,"incremental_authorizations":null,"external_authentication_details":null,"external_3ds_authentication_attempted":false,"expires_on":"2025-07-25T10:27:23.600Z","fingerprint":null,"browser_info":{"language":"en-US","time_zone":-330,"ip_address":"127.0.0.1","user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36","color_depth":32,"java_enabled":true,"screen_width":1728,"accept_header":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8","screen_height":1117,"java_script_enabled":true},"payment_method_id":"pm_uHViByM1aRfvzf4cCKYH","payment_method_status":"inactive","updated":"2025-07-25T10:29:38.062Z","split_payments":null,"frm_metadata":null,"extended_authorization_applied":null,"capture_before":null,"merchant_order_reference_id":null,"order_tax_amount":null,"connector_mandate_id":null,"card_discovery":null,"force_3ds_challenge":false,"force_3ds_challenge_trigger":false,"issuer_error_code":null,"issuer_error_message":null,"is_iframe_redirection_enabled":null,"whole_connector_response":null}},"timestamp":"2025-07-25T10:29:38.064Z"} It should have - event_type as payment_expired - status as expired - `next_action` should be null </details> <details> <summary>3. Verify payments retrieve</summary> cURL curl --location --request GET 'http://localhost:8080/payments/pay_8P2b5MuSkplj8d3U06Nj?force_sync=true' \ --header 'Accept: application/json' \ --header 'api-key: dev_W8rGDzCct9xjU2Rqd8xxZubP9rRJ4u1Y42J1im7qplUxjOgWmJS4ZPq9lRfvOCnd' Response {"payment_id":"pay_cqxjoA0Drk0NBgmCpbQf","merchant_id":"merchant_1753397156","status":"expired","amount":4500,"net_amount":4500,"shipping_cost":null,"amount_capturable":0,"amount_received":null,"connector":"adyen","client_secret":"pay_cqxjoA0Drk0NBgmCpbQf_secret_S3VytS4Ym1KOhpKRQvtV","created":"2025-07-24T22:51:17.081Z","currency":"BRL","customer_id":"cus_J2NWO1RbnwNdiEO6KdIt","customer":{"id":"cus_J2NWO1RbnwNdiEO6KdIt","name":null,"email":"[email protected]","phone":null,"phone_country_code":null},"description":null,"refunds":null,"disputes":null,"mandate_id":null,"mandate_data":null,"setup_future_usage":null,"off_session":null,"capture_on":null,"capture_method":null,"payment_method":"bank_transfer","payment_method_data":{"bank_transfer":{"pix":{"pix_key":"test","cpf":"test","cnpj":"test","source_bank_account_id":null,"destination_bank_account_id":null,"expiry_date":"2025-07-24T22:54:00.000Z"}},"billing":null},"payment_token":null,"shipping":null,"billing":{"address":{"city":"San Fransico","country":"BR","line1":"1467","line2":"Harrison Street","line3":"Harrison Street","zip":"94122","state":"California","first_name":"joseph","last_name":"Doe"},"phone":{"number":"8056594427","country_code":"+91"},"email":"[email protected]"},"order_details":null,"email":"[email protected]","name":null,"phone":null,"return_url":"https://google.com/","authentication_type":"no_three_ds","statement_descriptor_name":null,"statement_descriptor_suffix":null,"next_action":null,"cancellation_reason":null,"error_code":null,"error_message":null,"unified_code":null,"unified_message":null,"payment_experience":null,"payment_method_type":"pix","connector_label":null,"business_country":null,"business_label":"default","business_sub_label":null,"allowed_payment_method_types":null,"ephemeral_key":null,"manual_retry_allowed":false,"connector_transaction_id":"BD7QBLW3MDSQNS65","frm_message":null,"metadata":{"udf1":"value1","Force-PSP":"Adyen","login_date":"2019-09-10T10:11:12Z","new_customer":"true"},"connector_metadata":null,"feature_metadata":null,"reference_id":"pay_cqxjoA0Drk0NBgmCpbQf_1","payment_link":null,"profile_id":"pro_zJpGj6xSodQqoBYltbzl","surcharge_details":null,"attempt_count":1,"merchant_decision":null,"merchant_connector_id":"mca_PTFqfuKnofhHIFDFLBsu","incremental_authorization_allowed":null,"authorization_count":null,"incremental_authorizations":null,"external_authentication_details":null,"external_3ds_authentication_attempted":false,"expires_on":"2025-07-24T22:52:17.081Z","fingerprint":null,"browser_info":{"language":"en-US","time_zone":-330,"ip_address":"127.0.0.1","user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36","color_depth":32,"java_enabled":true,"screen_width":1728,"accept_header":"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8","screen_height":1117,"java_script_enabled":true},"payment_method_id":"pm_EN1YZr7i5sD4qHXH2uV5","payment_method_status":"inactive","updated":"2025-07-24T22:55:13.196Z","split_payments":null,"frm_metadata":null,"extended_authorization_applied":null,"capture_before":null,"merchant_order_reference_id":null,"order_tax_amount":null,"connector_mandate_id":null,"card_discovery":null,"force_3ds_challenge":false,"force_3ds_challenge_trigger":false,"issuer_error_code":null,"issuer_error_message":null,"is_iframe_redirection_enabled":null,"whole_connector_response":null} </details> ## Checklist - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code

v1.115.0

f94f39ef0cae800a8ecde21e8d4a95b14c074f88

juspay/hyperswitch

juspay__hyperswitch-8634

Bug: [FEATURE] add profile acquirer module ### Feature Description add profile acquirer create API, which allows us to create profile acquirer with the following fields - profile_id - acquirer_assigned_merchant_id - merchant_name - merchant_country_code - network - acquirer_bin - acquirer_ica - acquirer_fraud_rate Acquirer details are stored in profile as a array of JSON object, and then to retrieve list of profile acquirers we can retrieve Business Profile ### Possible Implementation add profile acquirer create api - POST `{{BASE_URL}}/profile_acquirer`, which accepts the acquirer details and stores it in profile table as JSONB (List of acquirers can be a added to a profile). retrieve business profile can be used to get the list of available profile acquirers. ProfileAcquirerId id_type can be used as unique identifier for each of the created record.

diff --git a/api-reference/openapi_spec.json b/api-reference/openapi_spec.json index 525f65ea72c..743ddf82541 100644 --- a/api-reference/openapi_spec.json +++ b/api-reference/openapi_spec.json @@ -5957,6 +5957,46 @@ ] } }, + "/profile_acquirers": { + "post": { + "tags": [ + "Profile Acquirer" + ], + "summary": "Profile Acquirer - Create", + "description": "Create a new Profile Acquirer for accessing our APIs from your servers.", + "operationId": "Create a Profile Acquirer", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProfileAcquirerCreate" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Profile Acquirer created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProfileAcquirerResponse" + } + } + } + }, + "400": { + "description": "Invalid data" + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, "/three_ds_decision/execute": { "post": { "tags": [ @@ -6307,6 +6347,63 @@ } } }, + "AcquirerConfig": { + "type": "object", + "description": "Acquirer configuration", + "required": [ + "acquirer_assigned_merchant_id", + "merchant_name", + "merchant_country_code", + "network", + "acquirer_bin", + "acquirer_fraud_rate" + ], + "properties": { + "acquirer_assigned_merchant_id": { + "type": "string", + "description": "The merchant id assigned by the acquirer", + "example": "M123456789" + }, + "merchant_name": { + "type": "string", + "description": "merchant name", + "example": "NewAge Retailer" + }, + "merchant_country_code": { + "type": "string", + "description": "Merchant country code assigned by acquirer", + "example": "US" + }, + "network": { + "type": "string", + "description": "Network provider", + "example": "VISA" + }, + "acquirer_bin": { + "type": "string", + "description": "Acquirer bin", + "example": "456789" + }, + "acquirer_ica": { + "type": "string", + "description": "Acquirer ica provided by acquirer", + "example": "401288", + "nullable": true + }, + "acquirer_fraud_rate": { + "type": "string", + "description": "Fraud rate for the particular acquirer configuration", + "example": "0.01" + } + } + }, + "AcquirerConfigMap": { + "type": "object", + "description": "Acquirer configs", + "additionalProperties": { + "$ref": "#/components/schemas/AcquirerConfig" + } + }, "AcquirerData": { "type": "object", "description": "Represents data about the acquirer used in the 3DS decision rule.", @@ -25296,6 +25393,124 @@ "accommodation" ] }, + "ProfileAcquirerCreate": { + "type": "object", + "required": [ + "acquirer_assigned_merchant_id", + "merchant_name", + "merchant_country_code", + "network", + "acquirer_bin", + "acquirer_fraud_rate", + "profile_id" + ], + "properties": { + "acquirer_assigned_merchant_id": { + "type": "string", + "description": "The merchant id assigned by the acquirer", + "example": "M123456789" + }, + "merchant_name": { + "type": "string", + "description": "merchant name", + "example": "NewAge Retailer" + }, + "merchant_country_code": { + "type": "string", + "description": "Merchant country code assigned by acquirer", + "example": "US" + }, + "network": { + "type": "string", + "description": "Network provider", + "example": "VISA" + }, + "acquirer_bin": { + "type": "string", + "description": "Acquirer bin", + "example": "456789" + }, + "acquirer_ica": { + "type": "string", + "description": "Acquirer ica provided by acquirer", + "example": "401288", + "nullable": true + }, + "acquirer_fraud_rate": { + "type": "number", + "format": "double", + "description": "Fraud rate for the particular acquirer configuration", + "example": 0.01 + }, + "profile_id": { + "type": "string", + "description": "Parent profile id to link the acquirer account with", + "example": "pro_ky0yNyOXXlA5hF8JzE5q" + } + } + }, + "ProfileAcquirerResponse": { + "type": "object", + "required": [ + "profile_acquirer_id", + "acquirer_assigned_merchant_id", + "merchant_name", + "merchant_country_code", + "network", + "acquirer_bin", + "acquirer_fraud_rate", + "profile_id" + ], + "properties": { + "profile_acquirer_id": { + "type": "string", + "description": "The unique identifier of the profile acquirer", + "example": "pro_acq_LCRdERuylQvNQ4qh3QE0" + }, + "acquirer_assigned_merchant_id": { + "type": "string", + "description": "The merchant id assigned by the acquirer", + "example": "M123456789" + }, + "merchant_name": { + "type": "string", + "description": "Merchant name", + "example": "NewAge Retailer" + }, + "merchant_country_code": { + "type": "string", + "description": "Merchant country code assigned by acquirer", + "example": "US" + }, + "network": { + "type": "string", + "description": "Network provider", + "example": "VISA" + }, + "acquirer_bin": { + "type": "string", + "description": "Acquirer bin", + "example": "456789" + }, + "acquirer_ica": { + "type": "string", + "description": "Acquirer ica provided by acquirer", + "example": "401288", + "nullable": true + }, + "acquirer_fraud_rate": { + "type": "number", + "format": "double", + "description": "Fraud rate for the particular acquirer configuration", + "example": 0.01 + }, + "profile_id": { + "type": "string", + "description": "Parent profile id to link the acquirer account with", + "example": "pro_ky0yNyOXXlA5hF8JzE5q" + } + } + }, "ProfileCreate": { "type": "object", "properties": { @@ -25818,6 +26033,14 @@ "default": false, "example": false }, + "acquirer_configs": { + "allOf": [ + { + "$ref": "#/components/schemas/AcquirerConfigMap" + } + ], + "nullable": true + }, "is_iframe_redirection_enabled": { "type": "boolean", "description": "Indicates if the redirection has to open in the iframe", diff --git a/crates/api_models/src/admin.rs b/crates/api_models/src/admin.rs index 5ab7eae75f0..07f3e2431fa 100644 --- a/crates/api_models/src/admin.rs +++ b/crates/api_models/src/admin.rs @@ -2427,6 +2427,10 @@ pub struct ProfileResponse { #[schema(default = false, example = false)] pub is_pre_network_tokenization_enabled: bool, + /// Acquirer configs + #[schema(value_type = Option<AcquirerConfigMap>)] + pub acquirer_configs: Option<common_types::domain::AcquirerConfigMap>, + /// Indicates if the redirection has to open in the iframe #[schema(example = false)] pub is_iframe_redirection_enabled: Option<bool>, diff --git a/crates/api_models/src/lib.rs b/crates/api_models/src/lib.rs index a2258e4bd5c..5fdb56e6966 100644 --- a/crates/api_models/src/lib.rs +++ b/crates/api_models/src/lib.rs @@ -32,6 +32,7 @@ pub mod payouts; pub mod pm_auth; pub mod poll; pub mod process_tracker; +pub mod profile_acquirer; #[cfg(all(feature = "v2", feature = "payment_methods_v2"))] pub mod proxy; #[cfg(feature = "recon")] diff --git a/crates/api_models/src/profile_acquirer.rs b/crates/api_models/src/profile_acquirer.rs new file mode 100644 index 00000000000..86f36db104a --- /dev/null +++ b/crates/api_models/src/profile_acquirer.rs @@ -0,0 +1,66 @@ +use serde::{Deserialize, Serialize}; +use utoipa::ToSchema; + +use crate::enums; + +#[derive(Debug, Serialize, Deserialize, ToSchema)] +pub struct ProfileAcquirerCreate { + /// The merchant id assigned by the acquirer + #[schema(value_type= String,example = "M123456789")] + pub acquirer_assigned_merchant_id: String, + /// merchant name + #[schema(value_type= String,example = "NewAge Retailer")] + pub merchant_name: String, + /// Merchant country code assigned by acquirer + #[schema(value_type= String,example = "US")] + pub merchant_country_code: enums::CountryAlpha2, + /// Network provider + #[schema(value_type= String,example = "VISA")] + pub network: common_enums::enums::CardNetwork, + /// Acquirer bin + #[schema(value_type= String,example = "456789")] + pub acquirer_bin: String, + /// Acquirer ica provided by acquirer + #[schema(value_type= Option<String>,example = "401288")] + pub acquirer_ica: Option<String>, + /// Fraud rate for the particular acquirer configuration + #[schema(value_type= f64,example = 0.01)] + pub acquirer_fraud_rate: f64, + /// Parent profile id to link the acquirer account with + #[schema(value_type= String,example = "pro_ky0yNyOXXlA5hF8JzE5q")] + pub profile_id: common_utils::id_type::ProfileId, +} + +#[derive(Debug, Serialize, Deserialize, ToSchema)] +pub struct ProfileAcquirerResponse { + /// The unique identifier of the profile acquirer + #[schema(value_type= String,example = "pro_acq_LCRdERuylQvNQ4qh3QE0")] + pub profile_acquirer_id: common_utils::id_type::ProfileAcquirerId, + /// The merchant id assigned by the acquirer + #[schema(value_type= String,example = "M123456789")] + pub acquirer_assigned_merchant_id: String, + /// Merchant name + #[schema(value_type= String,example = "NewAge Retailer")] + pub merchant_name: String, + /// Merchant country code assigned by acquirer + #[schema(value_type= String,example = "US")] + pub merchant_country_code: enums::CountryAlpha2, + /// Network provider + #[schema(value_type= String,example = "VISA")] + pub network: common_enums::enums::CardNetwork, + /// Acquirer bin + #[schema(value_type= String,example = "456789")] + pub acquirer_bin: String, + /// Acquirer ica provided by acquirer + #[schema(value_type= Option<String>,example = "401288")] + pub acquirer_ica: Option<String>, + /// Fraud rate for the particular acquirer configuration + #[schema(value_type= f64,example = 0.01)] + pub acquirer_fraud_rate: f64, + /// Parent profile id to link the acquirer account with + #[schema(value_type= String,example = "pro_ky0yNyOXXlA5hF8JzE5q")] + pub profile_id: common_utils::id_type::ProfileId, +} + +impl common_utils::events::ApiEventMetric for ProfileAcquirerCreate {} +impl common_utils::events::ApiEventMetric for ProfileAcquirerResponse {} diff --git a/crates/common_types/src/domain.rs b/crates/common_types/src/domain.rs index 0361f5b0e46..ca6a59abd6a 100644 --- a/crates/common_types/src/domain.rs +++ b/crates/common_types/src/domain.rs @@ -1,5 +1,7 @@ //! Common types +use std::collections::HashMap; + use common_enums::enums; use common_utils::{impl_to_sql_from_sql_json, types::MinorUnit}; use diesel::{sql_types::Jsonb, AsExpression, FromSqlRow}; @@ -53,3 +55,36 @@ pub struct XenditSplitSubMerchantData { pub for_user_id: String, } impl_to_sql_from_sql_json!(XenditSplitSubMerchantData); + +/// Acquirer configuration +#[derive(Clone, Debug, Deserialize, ToSchema, Serialize, PartialEq)] +pub struct AcquirerConfig { + /// The merchant id assigned by the acquirer + #[schema(value_type= String,example = "M123456789")] + pub acquirer_assigned_merchant_id: String, + /// merchant name + #[schema(value_type= String,example = "NewAge Retailer")] + pub merchant_name: String, + /// Merchant country code assigned by acquirer + #[schema(value_type= String,example = "US")] + pub merchant_country_code: common_enums::CountryAlpha2, + /// Network provider + #[schema(value_type= String,example = "VISA")] + pub network: common_enums::CardNetwork, + /// Acquirer bin + #[schema(value_type= String,example = "456789")] + pub acquirer_bin: String, + /// Acquirer ica provided by acquirer + #[schema(value_type= Option<String>,example = "401288")] + pub acquirer_ica: Option<String>, + /// Fraud rate for the particular acquirer configuration + #[schema(value_type= String,example = "0.01")] + pub acquirer_fraud_rate: f64, +} + +#[derive(Serialize, Deserialize, Debug, Clone, FromSqlRow, AsExpression, ToSchema)] +#[diesel(sql_type = Jsonb)] +/// Acquirer configs +pub struct AcquirerConfigMap(pub HashMap<common_utils::id_type::ProfileAcquirerId, AcquirerConfig>); + +impl_to_sql_from_sql_json!(AcquirerConfigMap); diff --git a/crates/common_utils/src/events.rs b/crates/common_utils/src/events.rs index 39a1694a7c1..b06fea4e1ea 100644 --- a/crates/common_utils/src/events.rs +++ b/crates/common_utils/src/events.rs @@ -126,6 +126,9 @@ pub enum ApiEventsType { token_id: Option<id_type::GlobalTokenId>, }, ProcessTracker, + ProfileAcquirer { + profile_acquirer_id: id_type::ProfileAcquirerId, + }, ThreeDsDecisionRule, } diff --git a/crates/common_utils/src/id_type.rs b/crates/common_utils/src/id_type.rs index 34a3844e76b..45b65c9a448 100644 --- a/crates/common_utils/src/id_type.rs +++ b/crates/common_utils/src/id_type.rs @@ -11,6 +11,7 @@ mod merchant_connector_account; mod organization; mod payment; mod profile; +mod profile_acquirer; mod refunds; mod relay; mod routing; @@ -46,6 +47,7 @@ pub use self::{ organization::OrganizationId, payment::{PaymentId, PaymentReferenceId}, profile::ProfileId, + profile_acquirer::ProfileAcquirerId, refunds::RefundReferenceId, relay::RelayId, routing::RoutingId, diff --git a/crates/common_utils/src/id_type/profile_acquirer.rs b/crates/common_utils/src/id_type/profile_acquirer.rs new file mode 100644 index 00000000000..ac5f09646bc --- /dev/null +++ b/crates/common_utils/src/id_type/profile_acquirer.rs @@ -0,0 +1,41 @@ +use std::str::FromStr; + +crate::id_type!( + ProfileAcquirerId, + "A type for profile_acquirer_id that can be used for profile acquirer ids" +); +crate::impl_id_type_methods!(ProfileAcquirerId, "profile_acquirer_id"); + +// This is to display the `ProfileAcquirerId` as ProfileAcquirerId(abcd) +crate::impl_debug_id_type!(ProfileAcquirerId); +crate::impl_try_from_cow_str_id_type!(ProfileAcquirerId, "profile_acquirer_id"); + +crate::impl_generate_id_id_type!(ProfileAcquirerId, "pro_acq"); +crate::impl_serializable_secret_id_type!(ProfileAcquirerId); +crate::impl_queryable_id_type!(ProfileAcquirerId); +crate::impl_to_sql_from_sql_id_type!(ProfileAcquirerId); + +impl crate::events::ApiEventMetric for ProfileAcquirerId { + fn get_api_event_type(&self) -> Option<crate::events::ApiEventsType> { + Some(crate::events::ApiEventsType::ProfileAcquirer { + profile_acquirer_id: self.clone(), + }) + } +} + +impl FromStr for ProfileAcquirerId { + type Err = error_stack::Report<crate::errors::ValidationError>; + + fn from_str(s: &str) -> Result<Self, Self::Err> { + let cow_string = std::borrow::Cow::Owned(s.to_string()); + Self::try_from(cow_string) + } +} + +// This is implemented so that we can use profile acquirer id directly as attribute in metrics +#[cfg(feature = "metrics")] +impl From<ProfileAcquirerId> for router_env::opentelemetry::Value { + fn from(val: ProfileAcquirerId) -> Self { + Self::from(val.0 .0 .0) + } +} diff --git a/crates/common_utils/src/lib.rs b/crates/common_utils/src/lib.rs index 759329ba327..3f491d3e9a6 100644 --- a/crates/common_utils/src/lib.rs +++ b/crates/common_utils/src/lib.rs @@ -253,6 +253,13 @@ pub fn generate_merchant_connector_account_id_of_default_length( id_type::MerchantConnectorAccountId::generate() } +/// Generate a profile_acquirer id with default length, with prefix as `mer_acq` +pub fn generate_profile_acquirer_id_of_default_length() -> id_type::ProfileAcquirerId { + use id_type::GenerateId; + + id_type::ProfileAcquirerId::generate() +} + /// Generate a nanoid with the given prefix and a default length #[inline] pub fn generate_id_with_default_len(prefix: &str) -> String { diff --git a/crates/diesel_models/src/business_profile.rs b/crates/diesel_models/src/business_profile.rs index 848f673f502..a93bab30a49 100644 --- a/crates/diesel_models/src/business_profile.rs +++ b/crates/diesel_models/src/business_profile.rs @@ -74,6 +74,7 @@ pub struct Profile { pub is_iframe_redirection_enabled: Option<bool>, pub is_pre_network_tokenization_enabled: Option<bool>, pub three_ds_decision_rule_algorithm: Option<serde_json::Value>, + pub acquirer_config_map: Option<common_types::domain::AcquirerConfigMap>, } #[cfg(feature = "v1")] @@ -183,6 +184,7 @@ pub struct ProfileUpdateInternal { pub is_iframe_redirection_enabled: Option<bool>, pub is_pre_network_tokenization_enabled: Option<bool>, pub three_ds_decision_rule_algorithm: Option<serde_json::Value>, + pub acquirer_config_map: Option<common_types::domain::AcquirerConfigMap>, } #[cfg(feature = "v1")] @@ -234,6 +236,7 @@ impl ProfileUpdateInternal { is_iframe_redirection_enabled, is_pre_network_tokenization_enabled, three_ds_decision_rule_algorithm, + acquirer_config_map, } = self; Profile { profile_id: source.profile_id, @@ -316,6 +319,7 @@ impl ProfileUpdateInternal { .or(source.is_pre_network_tokenization_enabled), three_ds_decision_rule_algorithm: three_ds_decision_rule_algorithm .or(source.three_ds_decision_rule_algorithm), + acquirer_config_map: acquirer_config_map.or(source.acquirer_config_map), } } } @@ -376,6 +380,7 @@ pub struct Profile { pub id: common_utils::id_type::ProfileId, pub is_iframe_redirection_enabled: Option<bool>, pub three_ds_decision_rule_algorithm: Option<serde_json::Value>, + pub acquirer_config_map: Option<common_types::domain::AcquirerConfigMap>, pub routing_algorithm_id: Option<common_utils::id_type::RoutingId>, pub order_fulfillment_time: Option<i64>, pub order_fulfillment_time_origin: Option<common_enums::OrderFulfillmentTimeOrigin>, @@ -665,6 +670,7 @@ impl ProfileUpdateInternal { external_vault_connector_details: external_vault_connector_details .or(source.external_vault_connector_details), three_ds_decision_rule_algorithm: None, + acquirer_config_map: None, } } } diff --git a/crates/diesel_models/src/schema.rs b/crates/diesel_models/src/schema.rs index 388fcc23759..4e93ecab944 100644 --- a/crates/diesel_models/src/schema.rs +++ b/crates/diesel_models/src/schema.rs @@ -228,6 +228,7 @@ diesel::table! { is_iframe_redirection_enabled -> Nullable<Bool>, is_pre_network_tokenization_enabled -> Nullable<Bool>, three_ds_decision_rule_algorithm -> Nullable<Jsonb>, + acquirer_config_map -> Nullable<Jsonb>, } } diff --git a/crates/diesel_models/src/schema_v2.rs b/crates/diesel_models/src/schema_v2.rs index 5b1201027b7..0c6bdadac84 100644 --- a/crates/diesel_models/src/schema_v2.rs +++ b/crates/diesel_models/src/schema_v2.rs @@ -223,6 +223,7 @@ diesel::table! { id -> Varchar, is_iframe_redirection_enabled -> Nullable<Bool>, three_ds_decision_rule_algorithm -> Nullable<Jsonb>, + acquirer_config_map -> Nullable<Jsonb>, #[max_length = 64] routing_algorithm_id -> Nullable<Varchar>, order_fulfillment_time -> Nullable<Int8>, diff --git a/crates/hyperswitch_domain_models/src/business_profile.rs b/crates/hyperswitch_domain_models/src/business_profile.rs index 80070aa9e50..6c95af4f149 100644 --- a/crates/hyperswitch_domain_models/src/business_profile.rs +++ b/crates/hyperswitch_domain_models/src/business_profile.rs @@ -76,6 +76,7 @@ pub struct Profile { pub is_iframe_redirection_enabled: Option<bool>, pub is_pre_network_tokenization_enabled: bool, pub three_ds_decision_rule_algorithm: Option<serde_json::Value>, + pub acquirer_config_map: Option<common_types::domain::AcquirerConfigMap>, } #[cfg(feature = "v1")] @@ -188,6 +189,7 @@ impl From<ProfileSetter> for Profile { is_iframe_redirection_enabled: value.is_iframe_redirection_enabled, is_pre_network_tokenization_enabled: value.is_pre_network_tokenization_enabled, three_ds_decision_rule_algorithm: None, // three_ds_decision_rule_algorithm is not yet created during profile creation + acquirer_config_map: None, } } } @@ -274,6 +276,9 @@ pub enum ProfileUpdate { CardTestingSecretKeyUpdate { card_testing_secret_key: OptionalEncryptableName, }, + AcquirerConfigMapUpdate { + acquirer_config_map: Option<common_types::domain::AcquirerConfigMap>, + }, } #[cfg(feature = "v1")] @@ -373,6 +378,7 @@ impl From<ProfileUpdate> for ProfileUpdateInternal { is_iframe_redirection_enabled, is_pre_network_tokenization_enabled, three_ds_decision_rule_algorithm: None, + acquirer_config_map: None, } } ProfileUpdate::RoutingAlgorithmUpdate { @@ -425,6 +431,7 @@ impl From<ProfileUpdate> for ProfileUpdateInternal { is_iframe_redirection_enabled: None, is_pre_network_tokenization_enabled: None, three_ds_decision_rule_algorithm, + acquirer_config_map: None, }, ProfileUpdate::DynamicRoutingAlgorithmUpdate { dynamic_routing_algorithm, @@ -474,6 +481,7 @@ impl From<ProfileUpdate> for ProfileUpdateInternal { is_iframe_redirection_enabled: None, is_pre_network_tokenization_enabled: None, three_ds_decision_rule_algorithm: None, + acquirer_config_map: None, }, ProfileUpdate::ExtendedCardInfoUpdate { is_extended_card_info_enabled, @@ -523,6 +531,7 @@ impl From<ProfileUpdate> for ProfileUpdateInternal { is_iframe_redirection_enabled: None, is_pre_network_tokenization_enabled: None, three_ds_decision_rule_algorithm: None, + acquirer_config_map: None, }, ProfileUpdate::ConnectorAgnosticMitUpdate { is_connector_agnostic_mit_enabled, @@ -572,6 +581,7 @@ impl From<ProfileUpdate> for ProfileUpdateInternal { is_iframe_redirection_enabled: None, is_pre_network_tokenization_enabled: None, three_ds_decision_rule_algorithm: None, + acquirer_config_map: None, }, ProfileUpdate::NetworkTokenizationUpdate { is_network_tokenization_enabled, @@ -621,6 +631,7 @@ impl From<ProfileUpdate> for ProfileUpdateInternal { is_iframe_redirection_enabled: None, is_pre_network_tokenization_enabled: None, three_ds_decision_rule_algorithm: None, + acquirer_config_map: None, }, ProfileUpdate::CardTestingSecretKeyUpdate { card_testing_secret_key, @@ -670,6 +681,57 @@ impl From<ProfileUpdate> for ProfileUpdateInternal { is_iframe_redirection_enabled: None, is_pre_network_tokenization_enabled: None, three_ds_decision_rule_algorithm: None, + acquirer_config_map: None, + }, + ProfileUpdate::AcquirerConfigMapUpdate { + acquirer_config_map, + } => Self { + profile_name: None, + modified_at: now, + return_url: None, + enable_payment_response_hash: None, + payment_response_hash_key: None, + redirect_to_merchant_with_http_post: None, + webhook_details: None, + metadata: None, + routing_algorithm: None, + intent_fulfillment_time: None, + frm_routing_algorithm: None, + payout_routing_algorithm: None, + is_recon_enabled: None, + applepay_verified_domains: None, + payment_link_config: None, + session_expiry: None, + authentication_connector_details: None, + payout_link_config: None, + is_extended_card_info_enabled: None, + extended_card_info_config: None, + is_connector_agnostic_mit_enabled: None, + use_billing_as_payment_method_billing: None, + collect_shipping_details_from_wallet_connector: None, + collect_billing_details_from_wallet_connector: None, + outgoing_webhook_custom_http_headers: None, + always_collect_billing_details_from_wallet_connector: None, + always_collect_shipping_details_from_wallet_connector: None, + tax_connector_id: None, + is_tax_connector_enabled: None, + dynamic_routing_algorithm: None, + is_network_tokenization_enabled: None, + is_auto_retries_enabled: None, + max_auto_retries_enabled: None, + always_request_extended_authorization: None, + is_click_to_pay_enabled: None, + authentication_product_ids: None, + card_testing_guard_config: None, + card_testing_secret_key: None, + is_clear_pan_retries_enabled: None, + force_3ds_challenge: None, + is_debit_routing_enabled: None, + merchant_business_country: None, + is_iframe_redirection_enabled: None, + is_pre_network_tokenization_enabled: None, + three_ds_decision_rule_algorithm: None, + acquirer_config_map, }, } } @@ -739,6 +801,7 @@ impl super::behaviour::Conversion for Profile { is_iframe_redirection_enabled: self.is_iframe_redirection_enabled, is_pre_network_tokenization_enabled: Some(self.is_pre_network_tokenization_enabled), three_ds_decision_rule_algorithm: self.three_ds_decision_rule_algorithm, + acquirer_config_map: self.acquirer_config_map, }) } @@ -834,6 +897,7 @@ impl super::behaviour::Conversion for Profile { .is_pre_network_tokenization_enabled .unwrap_or(false), three_ds_decision_rule_algorithm: item.three_ds_decision_rule_algorithm, + acquirer_config_map: item.acquirer_config_map, }) } .await @@ -1825,6 +1889,7 @@ impl super::behaviour::Conversion for Profile { is_external_vault_enabled: self.is_external_vault_enabled, external_vault_connector_details: self.external_vault_connector_details, three_ds_decision_rule_algorithm: None, + acquirer_config_map: None, }) } diff --git a/crates/openapi/src/openapi.rs b/crates/openapi/src/openapi.rs index d0585fd98cc..4f8b96d5fbe 100644 --- a/crates/openapi/src/openapi.rs +++ b/crates/openapi/src/openapi.rs @@ -203,6 +203,9 @@ Never share your secret api keys. Keep them guarded and secure. // Routes for poll apis routes::poll::retrieve_poll_status, + // Routes for profile acquirer account + routes::profile_acquirer::profile_acquirer_create, + // Routes for 3DS Decision Rule routes::three_ds_decision_rule::three_ds_decision_rule_execute, ), @@ -274,6 +277,8 @@ Never share your secret api keys. Keep them guarded and secure. api_models::payment_methods::PaymentMethodResponse, api_models::payment_methods::CustomerPaymentMethod, common_types::three_ds_decision_rule_engine::ThreeDSDecisionRule, + common_types::domain::AcquirerConfigMap, + common_types::domain::AcquirerConfig, api_models::payment_methods::PaymentMethodListResponse, api_models::payment_methods::ResponsePaymentMethodsEnabled, api_models::payment_methods::ResponsePaymentMethodTypes, @@ -773,6 +778,8 @@ Never share your secret api keys. Keep them guarded and secure. api_models::open_router::DecisionEngineGatewayWiseExtraScore, api_models::open_router::DecisionEngineSRSubLevelInputConfig, api_models::open_router::DecisionEngineEliminationData, + api_models::profile_acquirer::ProfileAcquirerCreate, + api_models::profile_acquirer::ProfileAcquirerResponse, euclid::frontend::dir::enums::CustomerDevicePlatform, euclid::frontend::dir::enums::CustomerDeviceType, euclid::frontend::dir::enums::CustomerDeviceDisplaySize, diff --git a/crates/openapi/src/routes.rs b/crates/openapi/src/routes.rs index 23d9a79a4de..c91dd74f0fe 100644 --- a/crates/openapi/src/routes.rs +++ b/crates/openapi/src/routes.rs @@ -15,6 +15,7 @@ pub mod payments; pub mod payouts; pub mod poll; pub mod profile; +pub mod profile_acquirer; pub mod proxy; pub mod refunds; pub mod relay; diff --git a/crates/openapi/src/routes/profile_acquirer.rs b/crates/openapi/src/routes/profile_acquirer.rs new file mode 100644 index 00000000000..2c3467aeb63 --- /dev/null +++ b/crates/openapi/src/routes/profile_acquirer.rs @@ -0,0 +1,18 @@ +#[cfg(feature = "v1")] +/// Profile Acquirer - Create +/// +/// Create a new Profile Acquirer for accessing our APIs from your servers. +#[utoipa::path( + post, + path = "/profile_acquirers", + request_body = ProfileAcquirerCreate, + responses( + (status = 200, description = "Profile Acquirer created", body = ProfileAcquirerResponse), + (status = 400, description = "Invalid data") + ), + tag = "Profile Acquirer", + operation_id = "Create a Profile Acquirer", + security(("api_key" = [])) +)] +pub async fn profile_acquirer_create() { /* … */ +} diff --git a/crates/router/src/core.rs b/crates/router/src/core.rs index e5e97b5dc0b..a46f9742798 100644 --- a/crates/router/src/core.rs +++ b/crates/router/src/core.rs @@ -61,6 +61,7 @@ pub mod verification; pub mod verify_connector; pub mod webhooks; +pub mod profile_acquirer; pub mod unified_authentication_service; #[cfg(all(feature = "v2", feature = "payment_methods_v2"))] diff --git a/crates/router/src/core/payouts.rs b/crates/router/src/core/payouts.rs index ebc462d286d..04b3e05d1e9 100644 --- a/crates/router/src/core/payouts.rs +++ b/crates/router/src/core/payouts.rs @@ -372,13 +372,13 @@ pub async fn payouts_confirm_core( merchant_context: domain::MerchantContext, req: payouts::PayoutCreateRequest, ) -> RouterResponse<payouts::PayoutCreateResponse> { - let mut payout_data = make_payout_data( + let mut payout_data = Box::pin(make_payout_data( &state, &merchant_context, None, &payouts::PayoutRequest::PayoutCreateRequest(Box::new(req.to_owned())), &state.locale, - ) + )) .await?; let payout_attempt = payout_data.payout_attempt.to_owned(); let status = payout_attempt.status; @@ -435,13 +435,13 @@ pub async fn payouts_update_core( req: payouts::PayoutCreateRequest, ) -> RouterResponse<payouts::PayoutCreateResponse> { let payout_id = req.payout_id.clone().get_required_value("payout_id")?; - let mut payout_data = make_payout_data( + let mut payout_data = Box::pin(make_payout_data( &state, &merchant_context, None, &payouts::PayoutRequest::PayoutCreateRequest(Box::new(req.to_owned())), &state.locale, - ) + )) .await?; let payout_attempt = payout_data.payout_attempt.to_owned(); @@ -509,13 +509,13 @@ pub async fn payouts_retrieve_core( profile_id: Option<common_utils::id_type::ProfileId>, req: payouts::PayoutRetrieveRequest, ) -> RouterResponse<payouts::PayoutCreateResponse> { - let mut payout_data = make_payout_data( + let mut payout_data = Box::pin(make_payout_data( &state, &merchant_context, profile_id, &payouts::PayoutRequest::PayoutRetrieveRequest(req.to_owned()), &state.locale, - ) + )) .await?; let payout_attempt = payout_data.payout_attempt.to_owned(); let status = payout_attempt.status; @@ -550,13 +550,13 @@ pub async fn payouts_cancel_core( merchant_context: domain::MerchantContext, req: payouts::PayoutActionRequest, ) -> RouterResponse<payouts::PayoutCreateResponse> { - let mut payout_data = make_payout_data( + let mut payout_data = Box::pin(make_payout_data( &state, &merchant_context, None, &payouts::PayoutRequest::PayoutActionRequest(req.to_owned()), &state.locale, - ) + )) .await?; let payout_attempt = payout_data.payout_attempt.to_owned(); @@ -641,13 +641,13 @@ pub async fn payouts_fulfill_core( merchant_context: domain::MerchantContext, req: payouts::PayoutActionRequest, ) -> RouterResponse<payouts::PayoutCreateResponse> { - let mut payout_data = make_payout_data( + let mut payout_data = Box::pin(make_payout_data( &state, &merchant_context, None, &payouts::PayoutRequest::PayoutActionRequest(req.to_owned()), &state.locale, - ) + )) .await?; let payout_attempt = payout_data.payout_attempt.to_owned(); diff --git a/crates/router/src/core/profile_acquirer.rs b/crates/router/src/core/profile_acquirer.rs new file mode 100644 index 00000000000..747059e540e --- /dev/null +++ b/crates/router/src/core/profile_acquirer.rs @@ -0,0 +1,114 @@ +use api_models::profile_acquirer; +use common_utils::types::keymanager::KeyManagerState; +use error_stack::ResultExt; + +use crate::{ + core::errors::{self, utils::StorageErrorExt, RouterResponse}, + services::api, + types::domain, + SessionState, +}; + +#[cfg(all(feature = "olap", feature = "v1"))] +pub async fn create_profile_acquirer( + state: SessionState, + request: profile_acquirer::ProfileAcquirerCreate, + merchant_context: domain::MerchantContext, +) -> RouterResponse<profile_acquirer::ProfileAcquirerResponse> { + let db = state.store.as_ref(); + let profile_acquirer_id = common_utils::generate_profile_acquirer_id_of_default_length(); + let key_manager_state: KeyManagerState = (&state).into(); + let merchant_key_store = merchant_context.get_merchant_key_store(); + + let mut business_profile = db + .find_business_profile_by_profile_id( + &key_manager_state, + merchant_key_store, + &request.profile_id, + ) + .await + .to_not_found_response(errors::ApiErrorResponse::ProfileNotFound { + id: request.profile_id.get_string_repr().to_owned(), + })?; + + let incoming_acquirer_config = common_types::domain::AcquirerConfig { + acquirer_assigned_merchant_id: request.acquirer_assigned_merchant_id.clone(), + merchant_name: request.merchant_name.clone(), + merchant_country_code: request.merchant_country_code, + network: request.network.clone(), + acquirer_bin: request.acquirer_bin.clone(), + acquirer_ica: request.acquirer_ica.clone(), + acquirer_fraud_rate: request.acquirer_fraud_rate, + }; + + // Check for duplicates before proceeding + + business_profile + .acquirer_config_map + .as_ref() + .map_or(Ok(()), |configs_wrapper| { + match configs_wrapper.0.values().any(|existing_config| existing_config == &incoming_acquirer_config) { + true => Err(error_stack::report!( + errors::ApiErrorResponse::GenericDuplicateError { + message: format!( + "Duplicate acquirer configuration found for profile_id: {}. Conflicting configuration: {:?}", + request.profile_id.get_string_repr(), + incoming_acquirer_config + ), + } + )), + false => Ok(()), + } + })?; + + // Get a mutable reference to the HashMap inside AcquirerConfigMap, + // initializing if it's None or the inner HashMap is not present. + let configs_map = &mut business_profile + .acquirer_config_map + .get_or_insert_with(|| { + common_types::domain::AcquirerConfigMap(std::collections::HashMap::new()) + }) + .0; + + configs_map.insert( + profile_acquirer_id.clone(), + incoming_acquirer_config.clone(), + ); + + let profile_update = domain::ProfileUpdate::AcquirerConfigMapUpdate { + acquirer_config_map: business_profile.acquirer_config_map.clone(), + }; + let updated_business_profile = db + .update_profile_by_profile_id( + &key_manager_state, + merchant_key_store, + business_profile, + profile_update, + ) + .await + .change_context(errors::ApiErrorResponse::InternalServerError) + .attach_printable("Failed to update business profile with new acquirer config")?; + + let updated_acquire_details = updated_business_profile + .acquirer_config_map + .as_ref() + .and_then(|acquirer_configs_wrapper| acquirer_configs_wrapper.0.get(&profile_acquirer_id)) + .ok_or(errors::ApiErrorResponse::InternalServerError) + .attach_printable("Failed to get updated acquirer config")?; + + let response = profile_acquirer::ProfileAcquirerResponse { + profile_acquirer_id, + profile_id: request.profile_id.clone(), + acquirer_assigned_merchant_id: updated_acquire_details + .acquirer_assigned_merchant_id + .clone(), + merchant_name: updated_acquire_details.merchant_name.clone(), + merchant_country_code: updated_acquire_details.merchant_country_code, + network: updated_acquire_details.network.clone(), + acquirer_bin: updated_acquire_details.acquirer_bin.clone(), + acquirer_ica: updated_acquire_details.acquirer_ica.clone(), + acquirer_fraud_rate: updated_acquire_details.acquirer_fraud_rate, + }; + + Ok(api::ApplicationResponse::Json(response)) +} diff --git a/crates/router/src/core/webhooks/incoming.rs b/crates/router/src/core/webhooks/incoming.rs index a7a0c76e2f0..3f95d61bfb7 100644 --- a/crates/router/src/core/webhooks/incoming.rs +++ b/crates/router/src/core/webhooks/incoming.rs @@ -822,13 +822,13 @@ async fn payouts_incoming_webhook_flow( payout_id: payouts.payout_id.clone(), }); - let payout_data = payouts::make_payout_data( + let payout_data = Box::pin(payouts::make_payout_data( &state, &merchant_context, None, &action_req, common_utils::consts::DEFAULT_LOCALE, - ) + )) .await?; let updated_payout_attempt = db diff --git a/crates/router/src/db/kafka_store.rs b/crates/router/src/db/kafka_store.rs index e34fad3a2b1..e7136919cee 100644 --- a/crates/router/src/db/kafka_store.rs +++ b/crates/router/src/db/kafka_store.rs @@ -10,8 +10,7 @@ use common_utils::{ #[cfg(feature = "v2")] use diesel_models::ephemeral_key::{ClientSecretType, ClientSecretTypeNew}; use diesel_models::{ - enums, - enums::ProcessTrackerStatus, + enums::{self, ProcessTrackerStatus}, ephemeral_key::{EphemeralKey, EphemeralKeyNew}, reverse_lookup::{ReverseLookup, ReverseLookupNew}, user_role as user_storage, diff --git a/crates/router/src/lib.rs b/crates/router/src/lib.rs index f37b404de41..6a048c59b00 100644 --- a/crates/router/src/lib.rs +++ b/crates/router/src/lib.rs @@ -132,7 +132,8 @@ pub fn mk_app( { server_app = server_app .service(routes::ProfileNew::server(state.clone())) - .service(routes::Forex::server(state.clone())); + .service(routes::Forex::server(state.clone())) + .service(routes::ProfileAcquirer::server(state.clone())); } server_app = server_app.service(routes::Profile::server(state.clone())); diff --git a/crates/router/src/routes.rs b/crates/router/src/routes.rs index 7002a725b79..35221104ae3 100644 --- a/crates/router/src/routes.rs +++ b/crates/router/src/routes.rs @@ -41,6 +41,8 @@ pub mod payouts; pub mod pm_auth; pub mod poll; #[cfg(feature = "olap")] +pub mod profile_acquirer; +#[cfg(feature = "olap")] pub mod profiles; #[cfg(feature = "recon")] pub mod recon; @@ -86,8 +88,8 @@ pub use self::app::{ ApiKeys, AppState, ApplePayCertificatesMigration, Cache, Cards, Configs, ConnectorOnboarding, Customers, Disputes, EphemeralKey, FeatureMatrix, Files, Forex, Gsm, Health, Hypersense, Mandates, MerchantAccount, MerchantConnectorAccount, PaymentLink, PaymentMethods, Payments, - Poll, ProcessTracker, Profile, ProfileNew, Refunds, Relay, RelayWebhooks, SessionState, - ThreeDsDecisionRule, User, Webhooks, + Poll, ProcessTracker, Profile, ProfileAcquirer, ProfileNew, Refunds, Relay, RelayWebhooks, + SessionState, ThreeDsDecisionRule, User, Webhooks, }; #[cfg(feature = "olap")] pub use self::app::{Blocklist, Organization, Routing, Verify, WebhookEvents}; diff --git a/crates/router/src/routes/app.rs b/crates/router/src/routes/app.rs index 82c3e10105e..3d2a6e91700 100644 --- a/crates/router/src/routes/app.rs +++ b/crates/router/src/routes/app.rs @@ -85,6 +85,8 @@ use crate::routes::cards_info::{ use crate::routes::feature_matrix; #[cfg(all(feature = "frm", feature = "oltp"))] use crate::routes::fraud_check as frm_routes; +#[cfg(all(feature = "olap", feature = "v1"))] +use crate::routes::profile_acquirer; #[cfg(all(feature = "recon", feature = "olap"))] use crate::routes::recon as recon_routes; pub use crate::{ @@ -2645,3 +2647,17 @@ impl ProcessTracker { ) } } + +#[cfg(feature = "olap")] +pub struct ProfileAcquirer; + +#[cfg(all(feature = "olap", feature = "v1"))] +impl ProfileAcquirer { + pub fn server(state: AppState) -> Scope { + web::scope("/profile_acquirer") + .app_data(web::Data::new(state)) + .service( + web::resource("").route(web::post().to(profile_acquirer::create_profile_acquirer)), + ) + } +} diff --git a/crates/router/src/routes/lock_utils.rs b/crates/router/src/routes/lock_utils.rs index 91225fa39ab..9f64e31dcff 100644 --- a/crates/router/src/routes/lock_utils.rs +++ b/crates/router/src/routes/lock_utils.rs @@ -44,6 +44,7 @@ pub enum ApiIdentifier { PaymentMethodSession, ProcessTracker, Proxy, + ProfileAcquirer, ThreeDsDecisionRule, GenericTokenization, } @@ -345,6 +346,7 @@ impl From<Flow> for ApiIdentifier { Flow::RevenueRecoveryRetrieve => Self::ProcessTracker, Flow::Proxy => Self::Proxy, + Flow::ProfileAcquirerCreate => Self::ProfileAcquirer, Flow::ThreeDsDecisionRuleExecute => Self::ThreeDsDecisionRule, Flow::TokenizationCreate | Flow::TokenizationRetrieve => Self::GenericTokenization, } diff --git a/crates/router/src/routes/profile_acquirer.rs b/crates/router/src/routes/profile_acquirer.rs new file mode 100644 index 00000000000..4e8a5eeffaf --- /dev/null +++ b/crates/router/src/routes/profile_acquirer.rs @@ -0,0 +1,50 @@ +use actix_web::{web, HttpRequest, HttpResponse}; +use api_models::profile_acquirer::ProfileAcquirerCreate; +use router_env::{instrument, tracing, Flow}; + +use super::app::AppState; +use crate::{ + core::api_locking, + services::{api, authentication as auth, authorization::permissions::Permission}, + types::domain, +}; + +#[cfg(all(feature = "olap", feature = "v1"))] +#[instrument(skip_all, fields(flow = ?Flow::ProfileAcquirerCreate))] +pub async fn create_profile_acquirer( + state: web::Data<AppState>, + req: HttpRequest, + json_payload: web::Json<ProfileAcquirerCreate>, +) -> HttpResponse { + let flow = Flow::ProfileAcquirerCreate; + let payload = json_payload.into_inner(); + + Box::pin(api::server_wrap( + flow, + state, + &req, + payload, + |state: super::SessionState, auth_data, req, _| { + let merchant_context = domain::MerchantContext::NormalMerchant(Box::new( + domain::Context(auth_data.merchant_account, auth_data.key_store), + )); + crate::core::profile_acquirer::create_profile_acquirer( + state, + req, + merchant_context.clone(), + ) + }, + auth::auth_type( + &auth::HeaderAuth(auth::ApiKeyAuth { + is_connected_allowed: false, + is_platform_allowed: true, + }), + &auth::JWTAuth { + permission: Permission::ProfileAccountWrite, + }, + req.headers(), + ), + api_locking::LockAction::NotApplicable, + )) + .await +} diff --git a/crates/router/src/types/api/admin.rs b/crates/router/src/types/api/admin.rs index cbca021f1c9..41069a784b8 100644 --- a/crates/router/src/types/api/admin.rs +++ b/crates/router/src/types/api/admin.rs @@ -197,6 +197,7 @@ impl ForeignTryFrom<domain::Profile> for ProfileResponse { is_debit_routing_enabled: Some(item.is_debit_routing_enabled), merchant_business_country: item.merchant_business_country, is_pre_network_tokenization_enabled: item.is_pre_network_tokenization_enabled, + acquirer_configs: item.acquirer_config_map, is_iframe_redirection_enabled: item.is_iframe_redirection_enabled, }) } diff --git a/crates/router/src/workflows/attach_payout_account_workflow.rs b/crates/router/src/workflows/attach_payout_account_workflow.rs index 910afe3166c..9704ce06d3d 100644 --- a/crates/router/src/workflows/attach_payout_account_workflow.rs +++ b/crates/router/src/workflows/attach_payout_account_workflow.rs @@ -53,9 +53,14 @@ impl ProcessTrackerWorkflow<SessionState> for AttachPayoutAccountWorkflow { merchant_account.clone(), key_store.clone(), ))); - let mut payout_data = - payouts::make_payout_data(state, &merchant_context, None, &request, DEFAULT_LOCALE) - .await?; + let mut payout_data = Box::pin(payouts::make_payout_data( + state, + &merchant_context, + None, + &request, + DEFAULT_LOCALE, + )) + .await?; payouts::payouts_core(state, &merchant_context, &mut payout_data, None, None).await?; diff --git a/crates/router/src/workflows/outgoing_webhook_retry.rs b/crates/router/src/workflows/outgoing_webhook_retry.rs index 56265c788f7..d525763529e 100644 --- a/crates/router/src/workflows/outgoing_webhook_retry.rs +++ b/crates/router/src/workflows/outgoing_webhook_retry.rs @@ -542,13 +542,13 @@ async fn get_outgoing_webhook_content_and_event_type( payout_models::PayoutActionRequest { payout_id }, ); - let payout_data = payouts::make_payout_data( + let payout_data = Box::pin(payouts::make_payout_data( &state, &merchant_context, None, &request, DEFAULT_LOCALE, - ) + )) .await?; let router_response = diff --git a/crates/router_env/src/logger/types.rs b/crates/router_env/src/logger/types.rs index 12fd6108b62..27ab6dd7c10 100644 --- a/crates/router_env/src/logger/types.rs +++ b/crates/router_env/src/logger/types.rs @@ -594,6 +594,7 @@ pub enum Flow { CloneConnector, ///Proxy Flow Proxy, + ProfileAcquirerCreate, /// ThreeDs Decision Rule Execute flow ThreeDsDecisionRuleExecute, } diff --git a/migrations/2025-06-05-122346_add-acquirer-config-in-business-profile/down.sql b/migrations/2025-06-05-122346_add-acquirer-config-in-business-profile/down.sql new file mode 100644 index 00000000000..01490869cff --- /dev/null +++ b/migrations/2025-06-05-122346_add-acquirer-config-in-business-profile/down.sql @@ -0,0 +1,2 @@ +-- This file should undo anything in `up.sql` +ALTER TABLE business_profile DROP COLUMN IF EXISTS acquirer_config_map; \ No newline at end of file diff --git a/migrations/2025-06-05-122346_add-acquirer-config-in-business-profile/up.sql b/migrations/2025-06-05-122346_add-acquirer-config-in-business-profile/up.sql new file mode 100644 index 00000000000..ac326b3ca4f --- /dev/null +++ b/migrations/2025-06-05-122346_add-acquirer-config-in-business-profile/up.sql @@ -0,0 +1,2 @@ +-- Your SQL goes here +ALTER TABLE business_profile ADD COLUMN IF NOT EXISTS acquirer_config_map JSONB; \ No newline at end of file

2025-05-27T11:08:05Z

## Type of Change  - [x] New feature ## Description  added merchant acquirer create and list module ### Additional Changes - [ ] This PR modifies the API contract - [x] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables Add new field merchant_acquirer_ids in business_profile This pull request introduces support for managing acquirer configurations and profile acquirer entities, including updates to the OpenAPI specification, the Rust codebase, and database schema. The changes enable the creation, storage, and retrieval of acquirer configuration data and profile acquirer entities, which are essential for linking merchant profiles to acquirer accounts. ### API Enhancements: * Added a new endpoint `/profile_acquirers` for creating profile acquirers in `api-reference/openapi_spec.json`. Includes request and response schemas (`ProfileAcquirerCreate` and `ProfileAcquirerResponse`). [[1]](diffhunk://#diff-120d5ba664a56f45b6d881ccac78000f991d22e2909b5e45c83602c7dfab27cdR5960-R5999) [[2]](diffhunk://#diff-120d5ba664a56f45b6d881ccac78000f991d22e2909b5e45c83602c7dfab27cdR25396-R25513) * Defined schemas for `AcquirerConfig` and `AcquirerConfigMap` to describe acquirer configurations. [[1]](diffhunk://#diff-120d5ba664a56f45b6d881ccac78000f991d22e2909b5e45c83602c7dfab27cdR6350-R6406) [[2]](diffhunk://#diff-120d5ba664a56f45b6d881ccac78000f991d22e2909b5e45c83602c7dfab27cdR26036-R26043) ### Rust Codebase Updates: * Introduced `ProfileAcquirerCreate` and `ProfileAcquirerResponse` structs in the new `crates/api_models/src/profile_acquirer.rs` file for handling profile acquirer data. * Added `AcquirerConfig` and `AcquirerConfigMap` structs in `crates/common_types/src/domain.rs` to represent acquirer configuration data. * Implemented `ProfileAcquirerId` type in `crates/common_utils/src/id_type/profile_acquirer.rs` for unique identification of profile acquirers. ### Database Schema Changes: * Updated `business_profile` table to include a new column `acquirer_config_map` for storing acquirer configuration data in JSON format. [[1]](diffhunk://#diff-b3de56db64ac930fe24b6b0acb45282191598a506d20732f70ef00192b4b18d5R231) [[2]](diffhunk://#diff-22fdeee3005db31c44a9d40cd43c5a244e77a74e17d2e227d4c0b376f133f37eR226) * Modified `Profile` and `ProfileUpdateInternal` structs in `crates/diesel_models/src/business_profile.rs` to include `acquirer_config_map`. [[1]](diffhunk://#diff-9580ab8a5056970f087fa2af0a8de98dae6bf038ade612e3c996b88b23ae6e11R77) [[2]](diffhunk://#diff-9580ab8a5056970f087fa2af0a8de98dae6bf038ade612e3c996b88b23ae6e11R187) [[3]](diffhunk://#diff-9580ab8a5056970f087fa2af0a8de98dae6bf038ade612e3c996b88b23ae6e11R239) ### Event and Utility Enhancements: * Added `ProfileAcquirer` as a new event type in `crates/common_utils/src/events.rs`. * Implemented utility functions for generating and handling `ProfileAcquirerId`. [[1]](diffhunk://#diff-9bbc934a55fcf5282e0b0ba208a3722e9691ee71709d15a5c0d0958759280fa0R256-R262) [[2]](diffhunk://#diff-42f2c04d1e7d6eaf0534968a602f64eb00017fc3799f3426816fd59abae0145cR1-R41) ## Motivation and Context  Currently we donot have a table to store merchant acquirer information, have build an api to insert data for merchant acquirer into business profile table ## How did you test it?  Create a merchant account Once done create merchant_acquirer Request ```shell curl --location 'localhost:8080/profile_acquirer' \ --header 'Content-Type: application/json' \ --header 'api-key: dev_rDKEInoZiJlNIfJPYNuqBMC2EOJjegGylLbzRMDw6kmSxV0FztdYfLcSoWZD6ZsT' \ --data '{ "acquirer_assigned_merchant_id": "ACQ1xwjnd23456", "merchant_name": "Demo Merchant", "merchant_country_code": "IN", "network": "Visa", "acquirer_bin": "400000", "acquirer_ica": "ICA98765", "acquirer_fraud_rate": 0.02, "profile_id": "pro_AFTXNDSW2mZadl5tEmqd" }' ``` Response: ```shell { "profile_acquirer_id": "pro_acq_ZlIC3dqlERLvrvLfXCUX", "acquirer_assigned_merchant_id": "ACQ1xwjnd23456", "merchant_name": "Demo Merchant", "merchant_country_code": "IN", "network": "Visa", "acquirer_bin": "400000", "acquirer_ica": "ICA98765", "acquirer_fraud_rate": 0.02, "profile_id": "pro_B9IE9uHjgRVKXHp9MSqG", "created_at": "2025-05-27T11:43:15.477Z" } ``` try hitting the api with same sample set Response:shell ``` { "error": { "type": "invalid_request", "message": "Profile acquirer configuration with id pro_acq_vhDNwqBvqM6BqbCZ8FJa already exists.", "code": "IR_38" } } ``` Business profile schema details ```shell Table "public.business_profile" Column | Type | Collation | Nullable | Default -------------------------------------------------------+-----------------------------+-----------+----------+------------------------- profile_id | character varying(64) | | not null | merchant_id | character varying(64) | | not null | profile_name | character varying(64) | | not null | created_at | timestamp without time zone | | not null | modified_at | timestamp without time zone | | not null | return_url | text | | | enable_payment_response_hash | boolean | | not null | true payment_response_hash_key | character varying(255) | | | NULL::character varying redirect_to_merchant_with_http_post | boolean | | not null | false webhook_details | json | | | metadata | json | | | routing_algorithm | json | | | intent_fulfillment_time | bigint | | | frm_routing_algorithm | jsonb | | | payout_routing_algorithm | jsonb | | | is_recon_enabled | boolean | | not null | false applepay_verified_domains | text[] | | | payment_link_config | jsonb | | | session_expiry | bigint | | | authentication_connector_details | jsonb | | | payout_link_config | jsonb | | | is_extended_card_info_enabled | boolean | | | false extended_card_info_config | jsonb | | | is_connector_agnostic_mit_enabled | boolean | | | false use_billing_as_payment_method_billing | boolean | | | true collect_shipping_details_from_wallet_connector | boolean | | | false collect_billing_details_from_wallet_connector | boolean | | | false outgoing_webhook_custom_http_headers | bytea | | | always_collect_billing_details_from_wallet_connector | boolean | | | false always_collect_shipping_details_from_wallet_connector | boolean | | | false tax_connector_id | character varying(64) | | | is_tax_connector_enabled | boolean | | | version | "ApiVersion" | | not null | 'v1'::"ApiVersion" dynamic_routing_algorithm | json | | | is_network_tokenization_enabled | boolean | | not null | false is_auto_retries_enabled | boolean | | | max_auto_retries_enabled | smallint | | | always_request_extended_authorization | boolean | | | is_click_to_pay_enabled | boolean | | not null | false authentication_product_ids | jsonb | | | card_testing_guard_config | jsonb | | | card_testing_secret_key | bytea | | | is_clear_pan_retries_enabled | boolean | | not null | false force_3ds_challenge | boolean | | | false is_debit_routing_enabled | boolean | | not null | false merchant_business_country | "CountryAlpha2" | | | id | character varying(64) | | | is_iframe_redirection_enabled | boolean | | | is_pre_network_tokenization_enabled | boolean | | | three_ds_decision_rule_algorithm | jsonb | | | acquirer_config_map | jsonb | | | Indexes: "business_profile_pkey" PRIMARY KEY, btree (profile_id) ``` List profile acquirer account -- do business profile retrieve ```shell curl --location 'localhost:8080/account/sahkal/business_profile/pro_RUyg7qT8yMzgfQpTqqm8' \ --header 'api-key: dev_dzO6ovCaZazaULNtb0AJxDIfCX67yQUQGYP190ZKX8KCd9WYoFhFIFRxVB8B5w6Q' ``` Response ```shell { "merchant_id": "sahkal", "profile_id": "pro_RUyg7qT8yMzgfQpTqqm8", "profile_name": "US_default", "return_url": "https://google.com/success", "enable_payment_response_hash": true, "payment_response_hash_key": "U9qcRdTlSXQc4cnsaEXMEpuiPVgw4RmekxfLjNznZjUt83u2tav6e6XYIdFZA9dw", "redirect_to_merchant_with_http_post": false, "webhook_details": { "webhook_version": "1.0.1", "webhook_username": "ekart_retail", "webhook_password": "password_ekart@123", "webhook_url": null, "payment_created_enabled": true, "payment_succeeded_enabled": true, "payment_failed_enabled": true }, "metadata": null, "routing_algorithm": null, "intent_fulfillment_time": 900, "frm_routing_algorithm": null, "payout_routing_algorithm": null, "applepay_verified_domains": null, "session_expiry": 900, "payment_link_config": null, "authentication_connector_details": null, "use_billing_as_payment_method_billing": true, "extended_card_info_config": null, "collect_shipping_details_from_wallet_connector": false, "collect_billing_details_from_wallet_connector": false, "always_collect_shipping_details_from_wallet_connector": false, "always_collect_billing_details_from_wallet_connector": false, "is_connector_agnostic_mit_enabled": false, "payout_link_config": null, "outgoing_webhook_custom_http_headers": null, "tax_connector_id": null, "is_tax_connector_enabled": false, "is_network_tokenization_enabled": false, "is_auto_retries_enabled": false, "max_auto_retries_enabled": null, "always_request_extended_authorization": null, "is_click_to_pay_enabled": false, "authentication_product_ids": null, "card_testing_guard_config": { "card_ip_blocking_status": "disabled", "card_ip_blocking_threshold": 3, "guest_user_card_blocking_status": "disabled", "guest_user_card_blocking_threshold": 10, "customer_id_blocking_status": "disabled", "customer_id_blocking_threshold": 5, "card_testing_guard_expiry": 3600 }, "is_clear_pan_retries_enabled": false, "force_3ds_challenge": false, "is_debit_routing_enabled": false, "merchant_business_country": null, "is_pre_network_tokenization_enabled": false, "acquirer_configs": { "pro_acq_jkn6Di8kIqBVrmICSEYU": { "acquirer_assigned_merchant_id": "fqwcqsqqwacccwwwec", "merchant_name": "Demo Merchant", "merchant_country_code": "US", "network": "Visa", "acquirer_bin": "400000", "acquirer_ica": null, "acquirer_fraud_rate": 0.06 }, "pro_acq_bbNCgQibI8K1Xr6Cv3fu": { "acquirer_assigned_merchant_id": "fqwcqsqqwacdqwdwqdccwwwec", "merchant_name": "Demo Merchant", "merchant_country_code": "US", "network": "Visa", "acquirer_bin": "400000", "acquirer_ica": null, "acquirer_fraud_rate": 0.06 } } } ``` ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible  ## Summary by CodeRabbit - **New Features** - Added a new API endpoint to create Profile Acquirers linked to business profiles. - Enabled profiles to store multiple acquirer configurations with detailed attributes like merchant ID, country code, network, BIN, ICA, and fraud rate. - **Database** - Introduced a new JSONB column to store acquirer configuration maps within business profiles. - **API Documentation** - Updated OpenAPI specs to document new Profile Acquirer endpoints and related schemas.

v1.114.0

5ce2ab2d059d48a0f8305d65f45c7960c6939803

juspay/hyperswitch

juspay__hyperswitch-8633

Bug: [FEATURE] Add Incremental Authorization Flow for Stripe ### Feature Description Add Incremental Authorization Flow for Stripe ### Possible Implementation Add Incremental Authorization Flow for Stripe ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? Yes, I am willing to submit a PR!

diff --git a/api-reference/v2/openapi_spec_v2.json b/api-reference/v2/openapi_spec_v2.json index dc3578ef61c..99ffce36d28 100644 --- a/api-reference/v2/openapi_spec_v2.json +++ b/api-reference/v2/openapi_spec_v2.json @@ -22491,8 +22491,7 @@ "type": "string", "enum": [ "true", - "false", - "default" + "false" ] }, "RequestPaymentMethodTypes": { diff --git a/crates/common_enums/src/enums.rs b/crates/common_enums/src/enums.rs index 99b8c2e600e..f14695a7c74 100644 --- a/crates/common_enums/src/enums.rs +++ b/crates/common_enums/src/enums.rs @@ -2802,9 +2802,8 @@ pub enum CountryAlpha2 { #[strum(serialize_all = "snake_case")] pub enum RequestIncrementalAuthorization { True, - False, #[default] - Default, + False, } #[derive(Clone, Copy, Eq, Hash, PartialEq, Debug, Serialize, Deserialize, strum::Display, ToSchema,)] diff --git a/crates/hyperswitch_connectors/src/connectors/stripe.rs b/crates/hyperswitch_connectors/src/connectors/stripe.rs index a7146fab9cc..ee9e3f86f62 100644 --- a/crates/hyperswitch_connectors/src/connectors/stripe.rs +++ b/crates/hyperswitch_connectors/src/connectors/stripe.rs @@ -22,15 +22,16 @@ use hyperswitch_domain_models::{ payment_method_data::PaymentMethodData, router_data::{AccessToken, ConnectorAuthType, ErrorResponse, RouterData}, router_flow_types::{ - AccessTokenAuth, Authorize, Capture, CreateConnectorCustomer, Evidence, Execute, PSync, - PaymentMethodToken, RSync, Retrieve, Session, SetupMandate, UpdateMetadata, Upload, Void, + AccessTokenAuth, Authorize, Capture, CreateConnectorCustomer, Evidence, Execute, + IncrementalAuthorization, PSync, PaymentMethodToken, RSync, Retrieve, Session, + SetupMandate, UpdateMetadata, Upload, Void, }, router_request_types::{ AccessTokenRequestData, ConnectorCustomerData, PaymentMethodTokenizationData, - PaymentsAuthorizeData, PaymentsCancelData, PaymentsCaptureData, PaymentsSessionData, - PaymentsSyncData, PaymentsUpdateMetadataData, RefundsData, RetrieveFileRequestData, - SetupMandateRequestData, SplitRefundsRequest, SubmitEvidenceRequestData, - UploadFileRequestData, + PaymentsAuthorizeData, PaymentsCancelData, PaymentsCaptureData, + PaymentsIncrementalAuthorizationData, PaymentsSessionData, PaymentsSyncData, + PaymentsUpdateMetadataData, RefundsData, RetrieveFileRequestData, SetupMandateRequestData, + SplitRefundsRequest, SubmitEvidenceRequestData, UploadFileRequestData, }, router_response_types::{ PaymentsResponseData, RefundsResponseData, RetrieveFileResponse, SubmitEvidenceResponse, @@ -38,8 +39,9 @@ use hyperswitch_domain_models::{ }, types::{ ConnectorCustomerRouterData, PaymentsAuthorizeRouterData, PaymentsCancelRouterData, - PaymentsCaptureRouterData, PaymentsSyncRouterData, PaymentsUpdateMetadataRouterData, - RefundsRouterData, TokenizationRouterData, + PaymentsCaptureRouterData, PaymentsIncrementalAuthorizationRouterData, + PaymentsSyncRouterData, PaymentsUpdateMetadataRouterData, RefundsRouterData, + TokenizationRouterData, }, }; #[cfg(feature = "payouts")] @@ -58,7 +60,7 @@ use hyperswitch_interfaces::{ disputes::SubmitEvidence, files::{FilePurpose, FileUpload, RetrieveFile, UploadFile}, ConnectorCommon, ConnectorCommonExt, ConnectorIntegration, ConnectorRedirectResponse, - ConnectorSpecifications, ConnectorValidation, + ConnectorSpecifications, ConnectorValidation, PaymentIncrementalAuthorization, }, configs::Connectors, consts::{NO_ERROR_CODE, NO_ERROR_MESSAGE}, @@ -66,9 +68,10 @@ use hyperswitch_interfaces::{ errors::ConnectorError, events::connector_api_logs::ConnectorEvent, types::{ - ConnectorCustomerType, PaymentsAuthorizeType, PaymentsCaptureType, PaymentsSyncType, - PaymentsUpdateMetadataType, PaymentsVoidType, RefundExecuteType, RefundSyncType, Response, - RetrieveFileType, SubmitEvidenceType, TokenizationType, UploadFileType, + ConnectorCustomerType, IncrementalAuthorizationType, PaymentsAuthorizeType, + PaymentsCaptureType, PaymentsSyncType, PaymentsUpdateMetadataType, PaymentsVoidType, + RefundExecuteType, RefundSyncType, Response, RetrieveFileType, SubmitEvidenceType, + TokenizationType, UploadFileType, }, webhooks::{IncomingWebhook, IncomingWebhookRequestDetails}, }; @@ -1030,6 +1033,150 @@ impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData } } +impl PaymentIncrementalAuthorization for Stripe {} + +impl + ConnectorIntegration< + IncrementalAuthorization, + PaymentsIncrementalAuthorizationData, + PaymentsResponseData, + > for Stripe +{ + fn get_headers( + &self, + req: &PaymentsIncrementalAuthorizationRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, Maskable<String>)>, ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_http_method(&self) -> Method { + Method::Post + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + req: &PaymentsIncrementalAuthorizationRouterData, + connectors: &Connectors, + ) -> CustomResult<String, ConnectorError> { + Ok(format!( + "{}v1/payment_intents/{}/increment_authorization", + self.base_url(connectors), + req.request.connector_transaction_id, + )) + } + + fn get_request_body( + &self, + req: &PaymentsIncrementalAuthorizationRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, ConnectorError> { + let amount = utils::convert_amount( + self.amount_converter, + MinorUnit::new(req.request.total_amount), + req.request.currency, + )?; + let connector_req = stripe::StripeIncrementalAuthRequest { amount }; + + Ok(RequestContent::FormUrlEncoded(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &PaymentsIncrementalAuthorizationRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&IncrementalAuthorizationType::get_url( + self, req, connectors, + )?) + .attach_default_headers() + .headers(IncrementalAuthorizationType::get_headers( + self, req, connectors, + )?) + .set_body(IncrementalAuthorizationType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsIncrementalAuthorizationRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult< + RouterData< + IncrementalAuthorization, + PaymentsIncrementalAuthorizationData, + PaymentsResponseData, + >, + ConnectorError, + > { + let response: stripe::PaymentIntentResponse = res + .response + .parse_struct("PaymentIntentResponse") + .change_context(ConnectorError::ResponseDeserializationFailed)?; + + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + .change_context(ConnectorError::ResponseHandlingFailed) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, ConnectorError> { + let response: stripe::ErrorResponse = res + .response + .parse_struct("ErrorResponse") + .change_context(ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_error_response_body(&response)); + router_env::logger::info!(connector_response=?response); + Ok(ErrorResponse { + status_code: res.status_code, + code: response + .error + .code + .clone() + .unwrap_or_else(|| NO_ERROR_CODE.to_string()), + message: response + .error + .code + .unwrap_or_else(|| NO_ERROR_MESSAGE.to_string()), + reason: response.error.message.map(|message| { + response + .error + .decline_code + .clone() + .map(|decline_code| { + format!("message - {message}, decline_code - {decline_code}") + }) + .unwrap_or(message) + }), + attempt_status: None, + connector_transaction_id: response.error.payment_intent.map(|pi| pi.id), + network_advice_code: response.error.network_advice_code, + network_decline_code: response.error.network_decline_code, + network_error_message: response.error.decline_code.or(response.error.advice_code), + }) + } +} + impl ConnectorIntegration<UpdateMetadata, PaymentsUpdateMetadataData, PaymentsResponseData> for Stripe { diff --git a/crates/hyperswitch_connectors/src/connectors/stripe/transformers.rs b/crates/hyperswitch_connectors/src/connectors/stripe/transformers.rs index 3cd7aa033d7..e9e5913d593 100644 --- a/crates/hyperswitch_connectors/src/connectors/stripe/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/stripe/transformers.rs @@ -24,7 +24,8 @@ use hyperswitch_domain_models::{ router_flow_types::{Execute, RSync}, router_request_types::{ BrowserInformation, ChargeRefundsOptions, DestinationChargeRefund, DirectChargeRefund, - ResponseId, SplitRefundsRequest, + PaymentsAuthorizeData, PaymentsCancelData, PaymentsCaptureData, + PaymentsIncrementalAuthorizationData, ResponseId, SplitRefundsRequest, }, router_response_types::{ MandateReference, PaymentsResponseData, PreprocessingResponseId, RedirectForm, @@ -66,6 +67,28 @@ pub mod auth_headers { pub const STRIPE_VERSION: &str = "2022-11-15"; } +trait GetRequestIncrementalAuthorization { + fn get_request_incremental_authorization(&self) -> Option<bool>; +} + +impl GetRequestIncrementalAuthorization for PaymentsAuthorizeData { + fn get_request_incremental_authorization(&self) -> Option<bool> { + Some(self.request_incremental_authorization) + } +} + +impl GetRequestIncrementalAuthorization for PaymentsCaptureData { + fn get_request_incremental_authorization(&self) -> Option<bool> { + None + } +} + +impl GetRequestIncrementalAuthorization for PaymentsCancelData { + fn get_request_incremental_authorization(&self) -> Option<bool> { + None + } +} + pub struct StripeAuthType { pub(super) api_key: Secret<String>, } @@ -257,7 +280,18 @@ pub struct StripeCardData { pub payment_method_auth_type: Option<Auth3ds>, #[serde(rename = "payment_method_options[card][network]")] pub payment_method_data_card_preferred_network: Option<StripeCardNetwork>, + #[serde(skip_serializing_if = "Option::is_none")] + #[serde(rename = "payment_method_options[card][request_incremental_authorization]")] + pub request_incremental_authorization: Option<StripeRequestIncrementalAuthorization>, } + +#[derive(Debug, Eq, PartialEq, Serialize)] +#[serde(rename_all = "snake_case")] +pub enum StripeRequestIncrementalAuthorization { + IfAvailable, + Never, +} + #[derive(Debug, Eq, PartialEq, Serialize)] pub struct StripePayLaterData { #[serde(rename = "payment_method_data[type]")] @@ -1219,6 +1253,7 @@ fn create_stripe_payment_method( payment_method_token: Option<PaymentMethodToken>, is_customer_initiated_mandate_payment: Option<bool>, billing_address: StripeBillingAddress, + request_incremental_authorization: bool, ) -> Result< ( StripePaymentMethodData, @@ -1234,7 +1269,11 @@ fn create_stripe_payment_method( enums::AuthenticationType::NoThreeDs => Auth3ds::Automatic, }; Ok(( - StripePaymentMethodData::try_from((card_details, payment_method_auth_type))?, + StripePaymentMethodData::try_from(( + card_details, + payment_method_auth_type, + request_incremental_authorization, + ))?, Some(StripePaymentMethodType::Card), billing_address, )) @@ -1452,9 +1491,11 @@ fn get_stripe_card_network(card_network: common_enums::CardNetwork) -> Option<St } } -impl TryFrom<(&Card, Auth3ds)> for StripePaymentMethodData { +impl TryFrom<(&Card, Auth3ds, bool)> for StripePaymentMethodData { type Error = ConnectorError; - fn try_from((card, payment_method_auth_type): (&Card, Auth3ds)) -> Result<Self, Self::Error> { + fn try_from( + (card, payment_method_auth_type, request_incremental_authorization): (&Card, Auth3ds, bool), + ) -> Result<Self, Self::Error> { Ok(Self::Card(StripeCardData { payment_method_data_type: StripePaymentMethodType::Card, payment_method_data_card_number: card.card_number.clone(), @@ -1466,6 +1507,11 @@ impl TryFrom<(&Card, Auth3ds)> for StripePaymentMethodData { .card_network .clone() .and_then(get_stripe_card_network), + request_incremental_authorization: if request_incremental_authorization { + Some(StripeRequestIncrementalAuthorization::IfAvailable) + } else { + None + }, })) } } @@ -1813,6 +1859,7 @@ impl TryFrom<(&PaymentsAuthorizeRouterData, MinorUnit)> for PaymentIntentRequest .card_network .clone() .and_then(get_stripe_card_network), + request_incremental_authorization: None, }), PaymentMethodData::CardRedirect(_) | PaymentMethodData::Wallet(_) @@ -1861,6 +1908,7 @@ impl TryFrom<(&PaymentsAuthorizeRouterData, MinorUnit)> for PaymentIntentRequest field_name: "billing_address", } })?, + item.request.request_incremental_authorization, )?; validate_shipping_address_against_payment_method( @@ -2186,6 +2234,7 @@ impl TryFrom<&TokenizationRouterData> for TokenRequest { item.payment_method_token.clone(), None, StripeBillingAddress::default(), + false, )? .0 } @@ -2299,6 +2348,11 @@ impl TryFrom<&PaymentsAuthorizeRouterData> for StripeSplitPaymentRequest { } } +#[derive(Debug, Serialize)] +pub struct StripeIncrementalAuthRequest { + pub amount: MinorUnit, +} + #[derive(Clone, Default, Debug, Eq, PartialEq, Deserialize, Serialize)] #[serde(rename_all = "snake_case")] pub enum StripePaymentStatus { @@ -2660,7 +2714,7 @@ fn extract_payment_method_connector_response_from_latest_attempt( impl<F, T> TryFrom<ResponseRouterData<F, PaymentIntentResponse, T, PaymentsResponseData>> for RouterData<F, T, PaymentsResponseData> where - T: SplitPaymentData, + T: SplitPaymentData + GetRequestIncrementalAuthorization, { type Error = error_stack::Report<ConnectorError>; fn try_from( @@ -2742,7 +2796,10 @@ where connector_metadata, network_txn_id, connector_response_reference_id: Some(item.response.id), - incremental_authorization_allowed: None, + incremental_authorization_allowed: item + .data + .request + .get_request_incremental_authorization(), charges, }) }; @@ -2771,6 +2828,55 @@ where } } +impl From<StripePaymentStatus> for common_enums::AuthorizationStatus { + fn from(item: StripePaymentStatus) -> Self { + match item { + StripePaymentStatus::Succeeded + | StripePaymentStatus::RequiresCapture + | StripePaymentStatus::Chargeable + | StripePaymentStatus::RequiresCustomerAction + | StripePaymentStatus::RequiresConfirmation + | StripePaymentStatus::Consumed => Self::Success, + StripePaymentStatus::Processing | StripePaymentStatus::Pending => Self::Processing, + StripePaymentStatus::Failed + | StripePaymentStatus::Canceled + | StripePaymentStatus::RequiresPaymentMethod => Self::Failure, + } + } +} + +impl<F> + TryFrom< + ResponseRouterData< + F, + PaymentIntentResponse, + PaymentsIncrementalAuthorizationData, + PaymentsResponseData, + >, + > for RouterData<F, PaymentsIncrementalAuthorizationData, PaymentsResponseData> +{ + type Error = error_stack::Report<ConnectorError>; + fn try_from( + item: ResponseRouterData< + F, + PaymentIntentResponse, + PaymentsIncrementalAuthorizationData, + PaymentsResponseData, + >, + ) -> Result<Self, Self::Error> { + let status = common_enums::AuthorizationStatus::from(item.response.status); + Ok(Self { + response: Ok(PaymentsResponseData::IncrementalAuthorizationResponse { + status, + error_code: None, + error_message: None, + connector_authorization_id: Some(item.response.id), + }), + ..item.data + }) + } +} + pub fn get_connector_metadata( next_action: Option<&StripeNextActionResponse>, amount: MinorUnit, @@ -4040,7 +4146,11 @@ impl enums::AuthenticationType::ThreeDs => Auth3ds::Any, enums::AuthenticationType::NoThreeDs => Auth3ds::Automatic, }; - Ok(Self::try_from((ccard, payment_method_auth_type))?) + Ok(Self::try_from(( + ccard, + payment_method_auth_type, + item.request.request_incremental_authorization, + ))?) } PaymentMethodData::PayLater(_) => Ok(Self::PayLater(StripePayLaterData { payment_method_data_type: pm_type, diff --git a/crates/hyperswitch_connectors/src/default_implementations.rs b/crates/hyperswitch_connectors/src/default_implementations.rs index 67821e66d72..c2c15cf5308 100644 --- a/crates/hyperswitch_connectors/src/default_implementations.rs +++ b/crates/hyperswitch_connectors/src/default_implementations.rs @@ -1193,7 +1193,6 @@ default_imp_for_incremental_authorization!( connectors::Signifyd, connectors::Stax, connectors::Square, - connectors::Stripe, connectors::Stripebilling, connectors::Taxjar, connectors::Threedsecureio, diff --git a/crates/router/src/core/payments/transformers.rs b/crates/router/src/core/payments/transformers.rs index dd9b41ee9d2..21dd7833b76 100644 --- a/crates/router/src/core/payments/transformers.rs +++ b/crates/router/src/core/payments/transformers.rs @@ -312,7 +312,7 @@ pub async fn construct_payment_router_data_for_authorize<'a>( payment_data .payment_intent .request_incremental_authorization, - RequestIncrementalAuthorization::True | RequestIncrementalAuthorization::Default + RequestIncrementalAuthorization::True ), metadata: payment_data.payment_intent.metadata.expose_option(), authentication_data: None, @@ -1014,7 +1014,7 @@ pub async fn construct_payment_router_data_for_setup_mandate<'a>( payment_data .payment_intent .request_incremental_authorization, - RequestIncrementalAuthorization::True | RequestIncrementalAuthorization::Default + RequestIncrementalAuthorization::True ), metadata: payment_data.payment_intent.metadata, minor_amount: Some(payment_data.payment_attempt.amount_details.get_net_amount()), @@ -3822,7 +3822,6 @@ impl<F: Clone> TryFrom<PaymentAdditionalData<'_, F>> for types::PaymentsAuthoriz .payment_intent .request_incremental_authorization, Some(RequestIncrementalAuthorization::True) - | Some(RequestIncrementalAuthorization::Default) ), metadata: additional_data.payment_data.payment_intent.metadata, authentication_data: payment_data @@ -4694,7 +4693,6 @@ impl<F: Clone> TryFrom<PaymentAdditionalData<'_, F>> for types::SetupMandateRequ .payment_intent .request_incremental_authorization, Some(RequestIncrementalAuthorization::True) - | Some(RequestIncrementalAuthorization::Default) ), metadata: payment_data.payment_intent.metadata.clone().map(Into::into), shipping_cost: payment_data.payment_intent.shipping_cost,

2025-07-07T14:33:36Z

## Type of Change  - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD Closes this [issue](https://github.com/juspay/hyperswitch/issues/8633) ## Description  Added Incremental Authorization Flow in Stripe. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  [8633](https://github.com/juspay/hyperswitch/issues/8633) ## How did you test it?  Postman Tests 1. Payments - Create Request: ``` curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_GO27IMaWkZPcdQp7NA8uYvMJowN0WzpbyqEGtW7L3fxAtXZzCzy60mIZTzOjGon1' \ --data-raw ' { "amount": 1000, "currency": "USD", "confirm": true, "capture_method": "manual", "capture_on": "2022-09-10T10:11:12Z", "amount_to_capture": 1000, "customer_id": "StripeCustomer", "email": "[email protected]", "name": "John Doe", "phone": "999999999", "phone_country_code": "+65", "description": "Its my first payment request", "authentication_type": "no_three_ds", "return_url": "https://duck.com", "billing": { "address": { "first_name": "John", "last_name": "Doe", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "AT" } }, "payment_method": "card", "payment_method_type": "credit", "payment_method_data": { "card": { "card_number": "4242424242424242", "card_exp_month": "12", "card_exp_year": "2026", "card_holder_name": "joseph Doe", "card_cvc": "123" } }, "browser_info": { "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8", "language": "nl-NL", "color_depth": 24, "screen_height": 723, "screen_width": 1536, "time_zone": 0, "java_enabled": true, "java_script_enabled": true, "ip_address": "127.0.0.1" }, "shipping": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "John", "last_name": "Doe" } }, "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "metadata": { "udf1": "value1", "new_customer": "true", "login_date": "2019-09-10T10:11:12Z" }, "request_incremental_authorization": true }' ``` Response: ``` { "payment_id": "pay_jQwvRdxooT7YhHSEvann", "merchant_id": "merchant_1751975048", "status": "requires_capture", "amount": 1000, "net_amount": 1000, "shipping_cost": null, "amount_capturable": 1000, "amount_received": 0, "connector": "stripe", "client_secret": "pay_jQwvRdxooT7YhHSEvann_secret_tjC9HRIfeD3ku1ILRS8Y", "created": "2025-07-08T11:44:25.513Z", "currency": "USD", "customer_id": "StripeCustomer", "customer": { "id": "StripeCustomer", "name": "John Doe", "email": "[email protected]", "phone": "999999999", "phone_country_code": "+65" }, "description": "Its my first payment request", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "manual", "payment_method": "card", "payment_method_data": { "card": { "last4": "4242", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "424242", "card_extended_bin": null, "card_exp_month": "12", "card_exp_year": "2026", "card_holder_name": "joseph Doe", "payment_checks": { "cvc_check": "pass", "address_line1_check": "pass", "address_postal_code_check": "pass" }, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "John", "last_name": "Doe" }, "phone": null, "email": null }, "billing": { "address": { "city": "San Fransico", "country": "AT", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "John", "last_name": "Doe" }, "phone": null, "email": null }, "order_details": null, "email": "[email protected]", "name": "John Doe", "phone": "999999999", "return_url": "https://duck.com/", "authentication_type": "no_three_ds", "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "credit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": { "customer_id": "StripeCustomer", "created_at": 1751975065, "expires": 1751978665, "secret": "epk_4ce25909189e412389f732e1cd91ce49" }, "manual_retry_allowed": false, "connector_transaction_id": "pi_3RiZwnE9cSvqiivY0jq3K45T", "frm_message": null, "metadata": { "udf1": "value1", "login_date": "2019-09-10T10:11:12Z", "new_customer": "true" }, "connector_metadata": null, "feature_metadata": null, "reference_id": "pi_3RiZwnE9cSvqiivY0jq3K45T", "payment_link": null, "profile_id": "pro_fql6hf5I69zMoOLyp0gP", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_qTfdo4iBwxJFmMDXJwLD", "incremental_authorization_allowed": true, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-07-08T11:59:25.513Z", "fingerprint": null, "browser_info": { "language": "nl-NL", "time_zone": 0, "ip_address": "127.0.0.1", "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "color_depth": 24, "java_enabled": true, "screen_width": 1536, "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8", "screen_height": 723, "java_script_enabled": true }, "payment_method_id": null, "payment_method_status": null, "updated": "2025-07-08T11:44:30.290Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` 2. Incremental Authorization Request: ``` curl --location 'http://localhost:8080/payments/pay_jQwvRdxooT7YhHSEvann/incremental_authorization' \ --header 'Content-Type: application/json' \ --header 'api-key: dev_GO27IMaWkZPcdQp7NA8uYvMJowN0WzpbyqEGtW7L3fxAtXZzCzy60mIZTzOjGon1' \ --data '{ "amount": 6540, "reason": "customer bought new products" }' ``` Response: ``` { "payment_id": "pay_jQwvRdxooT7YhHSEvann", "merchant_id": "merchant_1751975048", "status": "requires_capture", "amount": 6540, "net_amount": 6540, "shipping_cost": null, "amount_capturable": 6540, "amount_received": 0, "connector": "stripe", "client_secret": "pay_jQwvRdxooT7YhHSEvann_secret_tjC9HRIfeD3ku1ILRS8Y", "created": "2025-07-08T11:44:25.513Z", "currency": "USD", "customer_id": null, "customer": { "id": null, "name": "John Doe", "email": "[email protected]", "phone": "999999999", "phone_country_code": "+65" }, "description": "Its my first payment request", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "manual", "payment_method": "card", "payment_method_data": { "card": { "last4": "4242", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "424242", "card_extended_bin": null, "card_exp_month": "12", "card_exp_year": "2026", "card_holder_name": "joseph Doe", "payment_checks": { "cvc_check": "pass", "address_line1_check": "pass", "address_postal_code_check": "pass" }, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": null, "billing": null, "order_details": null, "email": null, "name": null, "phone": null, "return_url": "https://duck.com/", "authentication_type": "no_three_ds", "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "credit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": false, "connector_transaction_id": "pi_3RiZwnE9cSvqiivY0jq3K45T", "frm_message": null, "metadata": { "udf1": "value1", "login_date": "2019-09-10T10:11:12Z", "new_customer": "true" }, "connector_metadata": null, "feature_metadata": null, "reference_id": "pi_3RiZwnE9cSvqiivY0jq3K45T", "payment_link": null, "profile_id": "pro_fql6hf5I69zMoOLyp0gP", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_qTfdo4iBwxJFmMDXJwLD", "incremental_authorization_allowed": true, "authorization_count": 1, "incremental_authorizations": [ { "authorization_id": "auth_qIHwnbG3etLwlil1piKr_1", "amount": 6540, "status": "success", "error_code": null, "error_message": null, "previously_authorized_amount": 1000 } ], "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-07-08T11:59:25.513Z", "fingerprint": null, "browser_info": { "language": "nl-NL", "time_zone": 0, "ip_address": "127.0.0.1", "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "color_depth": 24, "java_enabled": true, "screen_width": 1536, "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8", "screen_height": 723, "java_script_enabled": true }, "payment_method_id": null, "payment_method_status": null, "updated": "2025-07-08T11:44:36.093Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` Cypress test screenshot: <img width="598" height="399" alt="Screenshot 2025-07-28 at 3 42 50 PM" src="https://github.com/user-attachments/assets/41928a7b-7f92-4165-a8a9-d2829e59b1cf" /> ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.116.0

00b792d8d1027e2997f5e7df7d11d3e072b81aa0

juspay/hyperswitch

juspay__hyperswitch-8629

Bug: [FIX]: Make v2 endpoints follow standard API conventions There are a lot of minor inconsistencies in v2 endpoints. Fix them in accordance with https://google.aip.dev/general

diff --git a/api-reference/v2/openapi_spec_v2.json b/api-reference/v2/openapi_spec_v2.json index 1bce9a47e29..266aa6cec95 100644 --- a/api-reference/v2/openapi_spec_v2.json +++ b/api-reference/v2/openapi_spec_v2.json @@ -20,7 +20,7 @@ } ], "paths": { - "/v2/organization": { + "/v2/organizations": { "post": { "tags": [ "Organization" @@ -67,7 +67,7 @@ ] } }, - "/v2/organization/{id}": { + "/v2/organizations/{id}": { "get": { "tags": [ "Organization" @@ -164,7 +164,7 @@ ] } }, - "/v2/organization/{id}/merchant-accounts": { + "/v2/organizations/{id}/merchant-accounts": { "get": { "tags": [ "Organization" @@ -1220,7 +1220,7 @@ ] } }, - "/v2/routing-algorithm": { + "/v2/routing-algorithms": { "post": { "tags": [ "Routing" @@ -1275,7 +1275,7 @@ ] } }, - "/v2/routing-algorithm/{id}": { + "/v2/routing-algorithms/{id}": { "get": { "tags": [ "Routing" @@ -2850,7 +2850,7 @@ ] } }, - "/v2/payment-method-session": { + "/v2/payment-method-sessions": { "post": { "tags": [ "Payment Method Session" @@ -2897,7 +2897,7 @@ ] } }, - "/v2/payment-method-session/{id}": { + "/v2/payment-method-sessions/{id}": { "get": { "tags": [ "Payment Method Session" @@ -2994,7 +2994,7 @@ ] } }, - "/v2/payment-method-session/{id}/list-payment-methods": { + "/v2/payment-method-sessions/{id}/list-payment-methods": { "get": { "tags": [ "Payment Method Session" @@ -3035,7 +3035,7 @@ ] } }, - "/v2/payment-method-session/{id}/update-saved-payment-method": { + "/v2/payment-method-sessions/{id}/update-saved-payment-method": { "put": { "tags": [ "Payment Method Session" @@ -3098,7 +3098,7 @@ ] } }, - "/v2/payment-method-session/{id}/confirm": { + "/v2/payment-method-sessions/{id}/confirm": { "post": { "tags": [ "Payment Method Session" @@ -3241,7 +3241,7 @@ ] } }, - "/v2/refunds/{id}/update_metadata": { + "/v2/refunds/{id}/update-metadata": { "put": { "tags": [ "Refunds" @@ -3377,7 +3377,7 @@ ] } }, - "/v2/process_tracker/revenue_recovery_workflow/{revenue_recovery_id}": { + "/v2/process-trackers/revenue-recovery-workflow/{revenue_recovery_id}": { "get": { "tags": [ "Revenue Recovery" diff --git a/api-reference/v2/organization/organization--create.mdx b/api-reference/v2/organization/organization--create.mdx index 07f4e13222b..4ccc77f2b4b 100644 --- a/api-reference/v2/organization/organization--create.mdx +++ b/api-reference/v2/organization/organization--create.mdx @@ -1,3 +1,3 @@ --- -openapi: post /v2/organization +openapi: post /v2/organizations --- \ No newline at end of file diff --git a/api-reference/v2/organization/organization--merchant-account--list.mdx b/api-reference/v2/organization/organization--merchant-account--list.mdx index 9a03e8713d1..594cc72b13b 100644 --- a/api-reference/v2/organization/organization--merchant-account--list.mdx +++ b/api-reference/v2/organization/organization--merchant-account--list.mdx @@ -1,3 +1,3 @@ --- -openapi: get /v2/organization/{id}/merchant-accounts +openapi: get /v2/organizations/{id}/merchant-accounts --- \ No newline at end of file diff --git a/api-reference/v2/organization/organization--retrieve.mdx b/api-reference/v2/organization/organization--retrieve.mdx index ba06f4cfb66..d49e4db37aa 100644 --- a/api-reference/v2/organization/organization--retrieve.mdx +++ b/api-reference/v2/organization/organization--retrieve.mdx @@ -1,3 +1,3 @@ --- -openapi: get /v2/organization/{id} +openapi: get /v2/organizations/{id} --- \ No newline at end of file diff --git a/api-reference/v2/organization/organization--update.mdx b/api-reference/v2/organization/organization--update.mdx index c365eb093f7..1fd238c28f8 100644 --- a/api-reference/v2/organization/organization--update.mdx +++ b/api-reference/v2/organization/organization--update.mdx @@ -1,3 +1,3 @@ --- -openapi: put /v2/organization/{id} +openapi: put /v2/organizations/{id} --- \ No newline at end of file diff --git a/api-reference/v2/payment-method-session/payment-method-session--confirm-a-payment-method-session.mdx b/api-reference/v2/payment-method-session/payment-method-session--confirm-a-payment-method-session.mdx index ed9cec389da..06094779532 100644 --- a/api-reference/v2/payment-method-session/payment-method-session--confirm-a-payment-method-session.mdx +++ b/api-reference/v2/payment-method-session/payment-method-session--confirm-a-payment-method-session.mdx @@ -1,3 +1,3 @@ --- -openapi: post /v2/payment-method-session/{id}/confirm +openapi: post /v2/payment-method-sessions/{id}/confirm --- \ No newline at end of file diff --git a/api-reference/v2/payment-method-session/payment-method-session--create.mdx b/api-reference/v2/payment-method-session/payment-method-session--create.mdx index b75390a47d1..ad6de7041ae 100644 --- a/api-reference/v2/payment-method-session/payment-method-session--create.mdx +++ b/api-reference/v2/payment-method-session/payment-method-session--create.mdx @@ -1,3 +1,3 @@ --- -openapi: post /v2/payment-method-session +openapi: post /v2/payment-method-sessions --- diff --git a/api-reference/v2/payment-method-session/payment-method-session--delete-a-saved-payment-method.mdx b/api-reference/v2/payment-method-session/payment-method-session--delete-a-saved-payment-method.mdx index a4bcd483c6b..cb438fe1b4f 100644 --- a/api-reference/v2/payment-method-session/payment-method-session--delete-a-saved-payment-method.mdx +++ b/api-reference/v2/payment-method-session/payment-method-session--delete-a-saved-payment-method.mdx @@ -1,3 +1,3 @@ --- -openapi: delete /v2/payment-method-session/{id} +openapi: delete /v2/payment-method-sessions/{id} --- diff --git a/api-reference/v2/payment-method-session/payment-method-session--list-payment-methods.mdx b/api-reference/v2/payment-method-session/payment-method-session--list-payment-methods.mdx index 1dc6cc5eb34..c0077283180 100644 --- a/api-reference/v2/payment-method-session/payment-method-session--list-payment-methods.mdx +++ b/api-reference/v2/payment-method-session/payment-method-session--list-payment-methods.mdx @@ -1,3 +1,3 @@ --- -openapi: get /v2/payment-method-session/{id}/list-payment-methods +openapi: get /v2/payment-method-sessions/{id}/list-payment-methods --- \ No newline at end of file diff --git a/api-reference/v2/payment-method-session/payment-method-session--retrieve.mdx b/api-reference/v2/payment-method-session/payment-method-session--retrieve.mdx index 4e504390a45..a6f77047a74 100644 --- a/api-reference/v2/payment-method-session/payment-method-session--retrieve.mdx +++ b/api-reference/v2/payment-method-session/payment-method-session--retrieve.mdx @@ -1,3 +1,3 @@ --- -openapi: get /v2/payment-method-session/{id} +openapi: get /v2/payment-method-sessions/{id} --- \ No newline at end of file diff --git a/api-reference/v2/payment-method-session/payment-method-session--update-a-saved-payment-method.mdx b/api-reference/v2/payment-method-session/payment-method-session--update-a-saved-payment-method.mdx index f7e887dbb96..8d42dac66b2 100644 --- a/api-reference/v2/payment-method-session/payment-method-session--update-a-saved-payment-method.mdx +++ b/api-reference/v2/payment-method-session/payment-method-session--update-a-saved-payment-method.mdx @@ -1,3 +1,3 @@ --- -openapi: put /v2/payment-method-session/{id}/update-saved-payment-method +openapi: put /v2/payment-method-sessions/{id}/update-saved-payment-method --- diff --git a/api-reference/v2/revenue-recovery/revenue-recovery--retrieve.mdx b/api-reference/v2/revenue-recovery/revenue-recovery--retrieve.mdx index 119f750a7ac..aed5332391c 100644 --- a/api-reference/v2/revenue-recovery/revenue-recovery--retrieve.mdx +++ b/api-reference/v2/revenue-recovery/revenue-recovery--retrieve.mdx @@ -1,3 +1,3 @@ --- -openapi: get /v2/process_tracker/revenue_recovery_workflow/{revenue_recovery_id} +openapi: get /v2/process-trackers/revenue-recovery-workflow/{revenue_recovery_id} --- \ No newline at end of file diff --git a/api-reference/v2/routing/routing--create.mdx b/api-reference/v2/routing/routing--create.mdx index 438abd8e231..74a59ae3971 100644 --- a/api-reference/v2/routing/routing--create.mdx +++ b/api-reference/v2/routing/routing--create.mdx @@ -1,3 +1,3 @@ --- -openapi: post /v2/routing-algorithm +openapi: post /v2/routing-algorithms --- \ No newline at end of file diff --git a/api-reference/v2/routing/routing--retrieve.mdx b/api-reference/v2/routing/routing--retrieve.mdx index 10db0200e18..85efd57b9c8 100644 --- a/api-reference/v2/routing/routing--retrieve.mdx +++ b/api-reference/v2/routing/routing--retrieve.mdx @@ -1,3 +1,3 @@ --- -openapi: get /v2/routing-algorithm/{id} +openapi: get /v2/routing-algorithms/{id} --- \ No newline at end of file diff --git a/crates/hyperswitch_connectors/src/connectors/hyperswitch_vault.rs b/crates/hyperswitch_connectors/src/connectors/hyperswitch_vault.rs index d7e0e93c592..e6007d1e249 100644 --- a/crates/hyperswitch_connectors/src/connectors/hyperswitch_vault.rs +++ b/crates/hyperswitch_connectors/src/connectors/hyperswitch_vault.rs @@ -85,7 +85,7 @@ impl ConnectorIntegration<ExternalVaultCreateFlow, VaultRequestData, VaultRespon connectors: &Connectors, ) -> CustomResult<String, errors::ConnectorError> { Ok(format!( - "{}/v2/payment-methods-session", + "{}/v2/payment-method-sessions", self.base_url(connectors) )) } diff --git a/crates/openapi/src/routes/organization.rs b/crates/openapi/src/routes/organization.rs index d677131d5db..832b203729d 100644 --- a/crates/openapi/src/routes/organization.rs +++ b/crates/openapi/src/routes/organization.rs @@ -77,7 +77,7 @@ pub async fn organization_update() {} /// Create a new organization #[utoipa::path( post, - path = "/v2/organization", + path = "/v2/organizations", request_body( content = OrganizationCreateRequest, examples( @@ -104,7 +104,7 @@ pub async fn organization_create() {} /// Retrieve an existing organization #[utoipa::path( get, - path = "/v2/organization/{id}", + path = "/v2/organizations/{id}", params (("id" = String, Path, description = "The unique identifier for the Organization")), responses( (status = 200, description = "Organization Created", body =OrganizationResponse), @@ -122,7 +122,7 @@ pub async fn organization_retrieve() {} /// Create a new organization for . #[utoipa::path( put, - path = "/v2/organization/{id}", + path = "/v2/organizations/{id}", request_body( content = OrganizationUpdateRequest, examples( @@ -150,7 +150,7 @@ pub async fn organization_update() {} /// List merchant accounts for an Organization #[utoipa::path( get, - path = "/v2/organization/{id}/merchant-accounts", + path = "/v2/organizations/{id}/merchant-accounts", params (("id" = String, Path, description = "The unique identifier for the Organization")), responses( (status = 200, description = "Merchant Account list retrieved successfully", body = Vec<MerchantAccountResponse>), diff --git a/crates/openapi/src/routes/payment_method.rs b/crates/openapi/src/routes/payment_method.rs index 0cfcde2cb7e..3f0ed7d799e 100644 --- a/crates/openapi/src/routes/payment_method.rs +++ b/crates/openapi/src/routes/payment_method.rs @@ -353,7 +353,7 @@ pub async fn list_customer_payment_method_api() {} #[cfg(feature = "v2")] #[utoipa::path( post, - path = "/v2/payment-method-session", + path = "/v2/payment-method-sessions", request_body( content = PaymentMethodSessionRequest, examples (( "Create a payment method session with customer_id" = ( @@ -378,7 +378,7 @@ pub fn payment_method_session_create() {} #[cfg(feature = "v2")] #[utoipa::path( get, - path = "/v2/payment-method-session/{id}", + path = "/v2/payment-method-sessions/{id}", params ( ("id" = String, Path, description = "The unique identifier for the Payment Method Session"), ), @@ -399,7 +399,7 @@ pub fn payment_method_session_retrieve() {} #[cfg(feature = "v2")] #[utoipa::path( get, - path = "/v2/payment-method-session/{id}/list-payment-methods", + path = "/v2/payment-method-sessions/{id}/list-payment-methods", params ( ("id" = String, Path, description = "The unique identifier for the Payment Method Session"), ), @@ -419,7 +419,7 @@ pub fn payment_method_session_list_payment_methods() {} #[cfg(feature = "v2")] #[utoipa::path( put, - path = "/v2/payment-method-session/{id}/update-saved-payment-method", + path = "/v2/payment-method-sessions/{id}/update-saved-payment-method", params ( ("id" = String, Path, description = "The unique identifier for the Payment Method Session"), ), @@ -453,7 +453,7 @@ pub fn payment_method_session_update_saved_payment_method() {} #[cfg(feature = "v2")] #[utoipa::path( delete, - path = "/v2/payment-method-session/{id}", + path = "/v2/payment-method-sessions/{id}", params ( ("id" = String, Path, description = "The unique identifier for the Payment Method Session"), ), @@ -520,7 +520,7 @@ pub async fn tokenize_card_using_pm_api() {} /// **Confirms a payment method session object with the payment method data** #[utoipa::path( post, - path = "/v2/payment-method-session/{id}/confirm", + path = "/v2/payment-method-sessions/{id}/confirm", params (("id" = String, Path, description = "The unique identifier for the Payment Method Session"), ( "X-Profile-Id" = String, Header, diff --git a/crates/openapi/src/routes/refunds.rs b/crates/openapi/src/routes/refunds.rs index f33369d3888..be8c63e4696 100644 --- a/crates/openapi/src/routes/refunds.rs +++ b/crates/openapi/src/routes/refunds.rs @@ -221,7 +221,7 @@ pub async fn refunds_create() {} /// Updates the properties of a Refund object. This API can be used to attach a reason for the refund or metadata fields #[utoipa::path( put, - path = "/v2/refunds/{id}/update_metadata", + path = "/v2/refunds/{id}/update-metadata", params( ("id" = String, Path, description = "The identifier for refund") ), diff --git a/crates/openapi/src/routes/revenue_recovery.rs b/crates/openapi/src/routes/revenue_recovery.rs index 8e3b2aaf412..0f22b340bd5 100644 --- a/crates/openapi/src/routes/revenue_recovery.rs +++ b/crates/openapi/src/routes/revenue_recovery.rs @@ -4,7 +4,7 @@ /// Retrieve the Revenue Recovery Payment Info #[utoipa::path( get, - path = "/v2/process_tracker/revenue_recovery_workflow/{revenue_recovery_id}", + path = "/v2/process-trackers/revenue-recovery-workflow/{revenue_recovery_id}", params( ("recovery_recovery_id" = String, Path, description = "The payment intent id"), ), diff --git a/crates/openapi/src/routes/routing.rs b/crates/openapi/src/routes/routing.rs index f657915e6a5..78f4c8b187c 100644 --- a/crates/openapi/src/routes/routing.rs +++ b/crates/openapi/src/routes/routing.rs @@ -26,7 +26,7 @@ pub async fn routing_create_config() {} /// Create a routing algorithm #[utoipa::path( post, - path = "/v2/routing-algorithm", + path = "/v2/routing-algorithms", request_body = RoutingConfigRequest, responses( (status = 200, description = "Routing Algorithm created", body = RoutingDictionaryRecord), @@ -92,7 +92,7 @@ pub async fn routing_retrieve_config() {} /// Retrieve a routing algorithm with its algorithm id #[utoipa::path( get, - path = "/v2/routing-algorithm/{id}", + path = "/v2/routing-algorithms/{id}", params( ("id" = String, Path, description = "The unique identifier for a routing algorithm"), ), diff --git a/crates/router/src/lib.rs b/crates/router/src/lib.rs index e002f7fd050..01676a11d49 100644 --- a/crates/router/src/lib.rs +++ b/crates/router/src/lib.rs @@ -210,7 +210,10 @@ pub fn mk_app( #[cfg(feature = "v2")] { - server_app = server_app.service(routes::ProcessTracker::server(state.clone())); + server_app = server_app + .service(routes::UserDeprecated::server(state.clone())) + .service(routes::ProcessTrackerDeprecated::server(state.clone())) + .service(routes::ProcessTracker::server(state.clone())); } } diff --git a/crates/router/src/routes.rs b/crates/router/src/routes.rs index fcf7270fa8a..b8fde79e2a1 100644 --- a/crates/router/src/routes.rs +++ b/crates/router/src/routes.rs @@ -91,8 +91,9 @@ pub use self::app::{ ApiKeys, AppState, ApplePayCertificatesMigration, Authentication, Cache, Cards, Chat, Configs, ConnectorOnboarding, Customers, Disputes, EphemeralKey, FeatureMatrix, Files, Forex, Gsm, Health, Hypersense, Mandates, MerchantAccount, MerchantConnectorAccount, PaymentLink, - PaymentMethods, Payments, Poll, ProcessTracker, Profile, ProfileAcquirer, ProfileNew, Refunds, - Relay, RelayWebhooks, SessionState, ThreeDsDecisionRule, User, Webhooks, + PaymentMethods, Payments, Poll, ProcessTracker, ProcessTrackerDeprecated, Profile, + ProfileAcquirer, ProfileNew, Refunds, Relay, RelayWebhooks, SessionState, ThreeDsDecisionRule, + User, UserDeprecated, Webhooks, }; #[cfg(feature = "olap")] pub use self::app::{Blocklist, Organization, Routing, Verify, WebhookEvents}; diff --git a/crates/router/src/routes/app.rs b/crates/router/src/routes/app.rs index cd132f0da63..d6d10dfe195 100644 --- a/crates/router/src/routes/app.rs +++ b/crates/router/src/routes/app.rs @@ -657,10 +657,15 @@ impl Payments { web::resource("/confirm-intent") .route(web::post().to(payments::payment_confirm_intent)), ) + // TODO: Deprecated. Remove this in favour of /list-attempts .service( web::resource("/list_attempts") .route(web::get().to(payments::list_payment_attempts)), ) + .service( + web::resource("/list-attempts") + .route(web::get().to(payments::list_payment_attempts)), + ) .service( web::resource("/proxy-confirm-intent") .route(web::post().to(payments::proxy_confirm_intent)), @@ -882,7 +887,7 @@ pub struct Routing; #[cfg(all(feature = "olap", feature = "v2"))] impl Routing { pub fn server(state: AppState) -> Scope { - web::scope("/v2/routing-algorithm") + web::scope("/v2/routing-algorithms") .app_data(web::Data::new(state.clone())) .service( web::resource("").route(web::post().to(|state, req, payload| { @@ -1242,7 +1247,7 @@ impl Refunds { .route(web::post().to(refunds::refunds_retrieve_with_gateway_creds)), ) .service( - web::resource("/{id}/update_metadata") + web::resource("/{id}/update-metadata") .route(web::put().to(refunds::refunds_metadata_update)), ); } @@ -1412,7 +1417,7 @@ pub struct PaymentMethodSession; #[cfg(all(feature = "v2", feature = "oltp"))] impl PaymentMethodSession { pub fn server(state: AppState) -> Scope { - let mut route = web::scope("/v2/payment-methods-session").app_data(web::Data::new(state)); + let mut route = web::scope("/v2/payment-method-sessions").app_data(web::Data::new(state)); route = route.service( web::resource("") .route(web::post().to(payment_methods::payment_methods_session_create)), @@ -1545,7 +1550,7 @@ impl Organization { #[cfg(all(feature = "v2", feature = "olap"))] impl Organization { pub fn server(state: AppState) -> Scope { - web::scope("/v2/organization") + web::scope("/v2/organizations") .app_data(web::Data::new(state)) .service(web::resource("").route(web::post().to(admin::organization_create))) .service( @@ -2269,11 +2274,12 @@ impl Verify { } } -pub struct User; +pub struct UserDeprecated; #[cfg(all(feature = "olap", feature = "v2"))] -impl User { +impl UserDeprecated { pub fn server(state: AppState) -> Scope { + // TODO: Deprecated. Remove this in favour of /v2/users let mut route = web::scope("/v2/user").app_data(web::Data::new(state)); route = route.service( @@ -2314,6 +2320,51 @@ impl User { } } +pub struct User; + +#[cfg(all(feature = "olap", feature = "v2"))] +impl User { + pub fn server(state: AppState) -> Scope { + let mut route = web::scope("/v2/users").app_data(web::Data::new(state)); + + route = route.service( + web::resource("/create-merchant") + .route(web::post().to(user::user_merchant_account_create)), + ); + route = route.service( + web::scope("/list") + .service( + web::resource("/merchant") + .route(web::get().to(user::list_merchants_for_user_in_org)), + ) + .service( + web::resource("/profile") + .route(web::get().to(user::list_profiles_for_user_in_org_and_merchant)), + ), + ); + + route = route.service( + web::scope("/switch") + .service( + web::resource("/merchant") + .route(web::post().to(user::switch_merchant_for_user_in_org)), + ) + .service( + web::resource("/profile") + .route(web::post().to(user::switch_profile_for_user_in_org_and_merchant)), + ), + ); + + route = route.service( + web::resource("/data") + .route(web::get().to(user::get_multiple_dashboard_metadata)) + .route(web::post().to(user::set_dashboard_metadata)), + ); + + route + } +} + #[cfg(all(feature = "olap", feature = "v1"))] impl User { pub fn server(state: AppState) -> Scope { @@ -2683,6 +2734,23 @@ impl FeatureMatrix { } } +#[cfg(feature = "olap")] +pub struct ProcessTrackerDeprecated; + +#[cfg(all(feature = "olap", feature = "v2"))] +impl ProcessTrackerDeprecated { + pub fn server(state: AppState) -> Scope { + use super::process_tracker::revenue_recovery; + // TODO: Deprecated. Remove this in favour of /v2/process-trackers + web::scope("/v2/process_tracker/revenue_recovery_workflow") + .app_data(web::Data::new(state.clone())) + .service( + web::resource("/{revenue_recovery_id}") + .route(web::get().to(revenue_recovery::revenue_recovery_pt_retrieve_api)), + ) + } +} + #[cfg(feature = "olap")] pub struct ProcessTracker; @@ -2690,7 +2758,7 @@ pub struct ProcessTracker; impl ProcessTracker { pub fn server(state: AppState) -> Scope { use super::process_tracker::revenue_recovery; - web::scope("/v2/process_tracker/revenue_recovery_workflow") + web::scope("/v2/process-trackers/revenue-recovery-workflow") .app_data(web::Data::new(state.clone())) .service( web::resource("/{revenue_recovery_id}") diff --git a/cypress-tests-v2/cypress/support/commands.js b/cypress-tests-v2/cypress/support/commands.js index 54e52495d67..e77a0f65143 100644 --- a/cypress-tests-v2/cypress/support/commands.js +++ b/cypress-tests-v2/cypress/support/commands.js @@ -45,7 +45,7 @@ Cypress.Commands.add( // Define the necessary variables and constants const api_key = globalState.get("adminApiKey"); const base_url = globalState.get("baseUrl"); - const url = `${base_url}/v2/organization`; + const url = `${base_url}/v2/organizations`; // Update request body organizationCreateBody.organization_name += " " + nanoid(); @@ -84,7 +84,7 @@ Cypress.Commands.add("organizationRetrieveCall", (globalState) => { const api_key = globalState.get("adminApiKey"); const base_url = globalState.get("baseUrl"); const organization_id = globalState.get("organizationId"); - const url = `${base_url}/v2/organization/${organization_id}`; + const url = `${base_url}/v2/organizations/${organization_id}`; cy.request({ method: "GET", @@ -125,7 +125,7 @@ Cypress.Commands.add( const api_key = globalState.get("adminApiKey"); const base_url = globalState.get("baseUrl"); const organization_id = globalState.get("organizationId"); - const url = `${base_url}/v2/organization/${organization_id}`; + const url = `${base_url}/v2/organizations/${organization_id}`; // Update request body organizationUpdateBody.organization_name += " " + nanoid(); @@ -805,7 +805,7 @@ Cypress.Commands.add( const api_key = globalState.get("userInfoToken"); const base_url = globalState.get("baseUrl"); const profile_id = globalState.get("profileId"); - const url = `${base_url}/v2/routing-algorithm`; + const url = `${base_url}/v2/routing-algorithms`; // Update request body routingSetupBody.algorithm.data = payload.data; @@ -961,7 +961,7 @@ Cypress.Commands.add("routingRetrieveCall", (globalState) => { const base_url = globalState.get("baseUrl"); const profile_id = globalState.get("profileId"); const routing_algorithm_id = globalState.get("routingAlgorithmId"); - const url = `${base_url}/v2/routing-algorithm/${routing_algorithm_id}`; + const url = `${base_url}/v2/routing-algorithms/${routing_algorithm_id}`; cy.request({ method: "GET", @@ -1170,7 +1170,7 @@ Cypress.Commands.add("merchantAccountsListCall", (globalState) => { const key_id_type = "publishable_key"; const key_id = validateEnv(base_url, key_id_type); const organization_id = globalState.get("organizationId"); - const url = `${base_url}/v2/organization/${organization_id}/merchant-accounts`; + const url = `${base_url}/v2/organizations/${organization_id}/merchant-accounts`; cy.request({ method: "GET",

2025-07-13T22:11:59Z

## Type of Change  - [ ] Bugfix - [ ] New feature - [x] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  - Consistently use kebab case in endpoint URLs - Use plural form of resources in URLs, i.e. instead of `/v2/organization`, use `/v2/organizations` Renamed (current version removed) endpoints: `/v2/organization` -> `/v2/organizations` `/v2/routing-algorithm` -> `/v2/routing-algorithms` `/v2/payment-methods-session` -> `/v2/payment-method-sessions` (refunds) `/update_metadata` -> `update-metadata` Duplicated (current version not removed) endpoints: `/v2/user` -> `/v2/users` `/create_merchant` -> `/create-merchant` `/v2/process_tracker/revenue_recovery_workflow` -> `/v2/process-trackers/revenue-recovery-workflow` `/list_attempts` -> `/list-attempts` ### Additional Changes - [x] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  Closes #8629 ## How did you test it?  1. Organization Request: ``` curl --location 'http://localhost:8080/v2/organizations' \ --header 'Authorization: admin-api-key=test_admin' \ --header 'Content-Type: application/json' \ --data '{ "organization_name": "v2_org_1752571446" }' ``` Response: ```json { "id": "org_4YoqpRWuOelFCr7Lbh2l", "organization_name": "v2_org_1752571419", "organization_details": null, "metadata": null, "modified_at": "2025-07-15 09:23:39.045598", "created_at": "2025-07-15 09:23:39.045496" } ``` 2. Payment Method Sessions: Request: ``` curl --location 'http://localhost:8080/v2/payment-method-sessions' \ --header 'x-profile-id: pro_k5m9OvIbAwRr29ZJrZFN' \ --header 'Authorization: api-key=dev_e0A7pdYme3jeCbLscKnTIXBci4IcuiixFCwaN0H3usrmeVSkKcn5r701nisZsvZc' \ --header 'Content-Type: application/json' \ --header 'api-key: dev_e0A7pdYme3jeCbLscKnTIXBci4IcuiixFCwaN0H3usrmeVSkKcn5r701nisZsvZc' \ --data-raw '{ "customer_id": "12345_cus_01980d66d85c78f28c2f25980c48a60b", "billing": { "address": { "first_name": "John", "last_name": "Dough" }, "email": "[email protected]" } }' ``` Response: ```json { "id": "12345_pms_01980d66e6ab715093173e3078818fc5", "customer_id": "12345_cus_01980d66d85c78f28c2f25980c48a60b", "billing": { "address": { "city": null, "country": null, "line1": null, "line2": null, "line3": null, "zip": null, "state": null, "first_name": "John", "last_name": "Dough" }, "phone": null, "email": "[email protected]" }, "psp_tokenization": null, "network_tokenization": null, "tokenization_data": null, "expires_at": "2025-07-15T09:40:04.299Z", "client_secret": "cs_01980d66e6ab715093173e43f85db63a", "return_url": null, "next_action": null, "authentication_details": null, "associated_payment_methods": null, "associated_token_id": null } ``` ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

53e7e7fa819183eaad1e8321f7e2b89b22867163

juspay/hyperswitch

juspay__hyperswitch-8623

Bug: [BUG] For trust pay in session token card brand is coming as empty so click to pay page is not loading ### Bug Description For trust pay in session token card brand is coming as empty so click to pay page is not loading ### Expected Behavior For trust pay in session token card brand should not come as empty so that click to pay page will load ### Actual Behavior For trust pay in session token card brand is coming as empty so click to pay page is not loading ### Steps To Reproduce Provide an unambiguous set of steps to reproduce this bug. Include code or configuration to reproduce, if relevant. 1. Go to '...' 2. Click on '....' 3. Scroll down to '....' ### Context For The Bug _No response_ ### Environment Are you using hyperswitch hosted version? Yes/No If yes, please provide the value of the `x-request-id` response header to help us debug your issue. If not (or if building/running locally), please provide the following details: 1. Operating System or Linux distribution: 2. Rust version (output of `rustc --version`): `` 3. App version (output of `cargo r --features vergen -- --version`): `` ### Have you spent some time checking if this bug has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? Yes, I am willing to submit a PR!

diff --git a/config/deployments/integration_test.toml b/config/deployments/integration_test.toml index 77775f87bf0..9c85481a235 100644 --- a/config/deployments/integration_test.toml +++ b/config/deployments/integration_test.toml @@ -786,4 +786,4 @@ monitoring_threshold_in_seconds = 2592000 retry_algorithm_type = "cascading" [authentication_providers] -click_to_pay = {connector_list = "adyen, cybersource"} \ No newline at end of file +click_to_pay = {connector_list = "adyen, cybersource, trustpay"} \ No newline at end of file diff --git a/config/deployments/production.toml b/config/deployments/production.toml index 7b0b29e007b..220da03461d 100644 --- a/config/deployments/production.toml +++ b/config/deployments/production.toml @@ -791,7 +791,7 @@ billing_connectors_which_require_payment_sync = "stripebilling, recurly" billing_connectors_which_requires_invoice_sync_call = "recurly" [authentication_providers] -click_to_pay = {connector_list = "adyen, cybersource"} +click_to_pay = {connector_list = "adyen, cybersource, trustpay"} [revenue_recovery] diff --git a/config/deployments/sandbox.toml b/config/deployments/sandbox.toml index 12816d57bf4..efaff9947c1 100644 --- a/config/deployments/sandbox.toml +++ b/config/deployments/sandbox.toml @@ -797,7 +797,7 @@ billing_connectors_which_require_payment_sync = "stripebilling, recurly" billing_connectors_which_requires_invoice_sync_call = "recurly" [authentication_providers] -click_to_pay = {connector_list = "adyen, cybersource"} +click_to_pay = {connector_list = "adyen, cybersource, trustpay"} [revenue_recovery] monitoring_threshold_in_seconds = 2592000 diff --git a/config/development.toml b/config/development.toml index ccc9d7af32d..605873bbe8f 100644 --- a/config/development.toml +++ b/config/development.toml @@ -1204,7 +1204,7 @@ enabled = true allow_connected_merchants = true [authentication_providers] -click_to_pay = {connector_list = "adyen, cybersource"} +click_to_pay = {connector_list = "adyen, cybersource, trustpay"} [open_router] dynamic_routing_enabled = false diff --git a/config/docker_compose.toml b/config/docker_compose.toml index faf1d25e3c7..a972609d592 100644 --- a/config/docker_compose.toml +++ b/config/docker_compose.toml @@ -1116,7 +1116,7 @@ enabled = false hyperswitch_ai_host = "http://0.0.0.0:8000" [authentication_providers] -click_to_pay = {connector_list = "adyen, cybersource"} +click_to_pay = {connector_list = "adyen, cybersource, trustpay"} [revenue_recovery] monitoring_threshold_in_seconds = 2592000 # threshold for monitoring the retry system

2025-07-13T08:29:09Z

## Type of Change  - [x] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD Closes this [issue](https://github.com/juspay/hyperswitch/issues/8623) ## Description  Added trustpay in authentication providers config ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  ## How did you test it?  Steps for testing is given in this [PR](https://github.com/juspay/hyperswitch/pull/8304) Screenshot that is showing `card_brands` in Session Call for Trustpay: <img width="653" height="542" alt="Screenshot 2025-07-13 at 2 07 31 PM" src="https://github.com/user-attachments/assets/4249444b-9558-49b3-a257-cabc9219ca19" /> Cypress Screenshot: <img width="1442" height="1932" alt="image (6)" src="https://github.com/user-attachments/assets/e72b900c-a90a-40aa-8230-a6766c75249e" /> ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

8ccaac7c10e9366772e43d34f271d946cc4b3baa

juspay/hyperswitch

juspay__hyperswitch-8612

Bug: Add support to pass fallback_configs for PL routing in the /routing/evaulate request from hyperswitch

diff --git a/crates/router/src/core/payments/routing.rs b/crates/router/src/core/payments/routing.rs index 7feea3286ca..4bbffcde633 100644 --- a/crates/router/src/core/payments/routing.rs +++ b/crates/router/src/core/payments/routing.rs @@ -442,22 +442,24 @@ pub async fn perform_static_routing_v1( Vec<routing_types::RoutableConnectorChoice>, Option<common_enums::RoutingApproach>, )> { - let algorithm_id = if let Some(id) = algorithm_id { - id - } else { + let get_merchant_fallback_config = || async { #[cfg(feature = "v1")] - let fallback_config = routing::helpers::get_merchant_default_config( + return routing::helpers::get_merchant_default_config( &*state.clone().store, business_profile.get_id().get_string_repr(), &api_enums::TransactionType::from(transaction_data), ) .await - .change_context(errors::RoutingError::FallbackConfigFetchFailed)?; + .change_context(errors::RoutingError::FallbackConfigFetchFailed); #[cfg(feature = "v2")] - let fallback_config = admin::ProfileWrapper::new(business_profile.clone()) + return admin::ProfileWrapper::new(business_profile.clone()) .get_default_fallback_list_of_connector_under_profile() - .change_context(errors::RoutingError::FallbackConfigFetchFailed)?; - + .change_context(errors::RoutingError::FallbackConfigFetchFailed); + }; + let algorithm_id = if let Some(id) = algorithm_id { + id + } else { + let fallback_config = get_merchant_fallback_config().await?; return Ok((fallback_config, None)); }; let cached_algorithm = ensure_algorithm_cached_v1( @@ -507,7 +509,8 @@ pub async fn perform_static_routing_v1( state, backend_input.clone(), business_profile.get_id().get_string_repr().to_string(), - routing_events_wrapper + routing_events_wrapper, + get_merchant_fallback_config().await?, ) .await .map_err(|e| diff --git a/crates/router/src/core/payments/routing/utils.rs b/crates/router/src/core/payments/routing/utils.rs index d2167f88498..d217cc04360 100644 --- a/crates/router/src/core/payments/routing/utils.rs +++ b/crates/router/src/core/payments/routing/utils.rs @@ -298,12 +298,21 @@ pub async fn perform_decision_euclid_routing( input: BackendInput, created_by: String, events_wrapper: RoutingEventsWrapper<RoutingEvaluateRequest>, + fallback_output: Vec<RoutableConnectorChoice>, ) -> RoutingResult<Vec<RoutableConnectorChoice>> { logger::debug!("decision_engine_euclid: evaluate api call for euclid routing evaluation"); let mut events_wrapper = events_wrapper; + let fallback_output = fallback_output + .into_iter() + .map(|c| DeRoutableConnectorChoice { + gateway_name: c.connector, + gateway_id: c.merchant_connector_id, + }) + .collect::<Vec<_>>(); - let routing_request = convert_backend_input_to_routing_eval(created_by, input)?; + let routing_request = + convert_backend_input_to_routing_eval(created_by, input, fallback_output)?; events_wrapper.set_request_body(routing_request.clone()); let event_response = EuclidApiClient::send_decision_engine_request( @@ -515,6 +524,7 @@ pub struct ListRountingAlgorithmsRequest { pub fn convert_backend_input_to_routing_eval( created_by: String, input: BackendInput, + fallback_output: Vec<DeRoutableConnectorChoice>, ) -> RoutingResult<RoutingEvaluateRequest> { let mut params: HashMap<String, Option<ValueType>> = HashMap::new(); @@ -631,6 +641,7 @@ pub fn convert_backend_input_to_routing_eval( Ok(RoutingEvaluateRequest { created_by, parameters: params, + fallback_output, }) } @@ -677,6 +688,7 @@ impl DecisionEngineErrorsInterface for or_types::ErrorResponse { pub struct RoutingEvaluateRequest { pub created_by: String, pub parameters: HashMap<String, Option<ValueType>>, + pub fallback_output: Vec<DeRoutableConnectorChoice>, } #[derive(Debug, serde::Serialize, serde::Deserialize, Clone)] @@ -690,7 +702,7 @@ pub struct RoutingEvaluateResponse { } /// Routable Connector chosen for a payment -#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)] +#[derive(Debug, Clone, PartialEq, serde::Serialize, serde::Deserialize)] pub struct DeRoutableConnectorChoice { pub gateway_name: common_enums::RoutableConnectors, pub gateway_id: Option<id_type::MerchantConnectorAccountId>,

2025-07-11T11:51:03Z

## Type of Change  - [ ] Bugfix - [ ] New feature - [X] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  Decision engine does not have the concept of fallback connectors, so we recently added support to handle the default connectors by allowing them to be passed in the evaluate request. As part of this PR we are making the necessary changes to pass fallback connectors to decision engine ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  ## How did you test it?  On making a payment from hyperswitch, with the routing rules defined and activated already. We will be passing the fallback_output to the decision engine <img width="1038" height="379" alt="Screenshot 2025-07-14 at 6 51 45 PM" src="https://github.com/user-attachments/assets/59540f64-00e6-475f-b528-a19ea0f71411" /> ## Checklist  - [ ] I formatted the code `cargo +nightly fmt --all` - [ ] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

8a7590cf60a0610863e7b6ef8a3c4b780ba03a85

juspay/hyperswitch

juspay__hyperswitch-8620

Bug: [REFACTOR] Create and use a domain type for profile ID ### Feature Description Create a domain type for business profile ID and use the domain type throughout the codebase. The expected result at the end of this change is that profile IDs are never used as strings directly anywhere in the codebase. - Introduce a trait `GenerateId` for generating IDs - Set the max_length attribute of profile_id in the API models to 64 ### Possible Implementation Introduce the profile_id id_type, and use it throughout the codebase ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? None

diff --git a/Cargo.lock b/Cargo.lock index d2c3baf9fba..65d75aa4d81 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -2094,6 +2094,7 @@ name = "connector_configs" version = "0.1.0" dependencies = [ "api_models", + "common_utils", "serde", "serde_with", "toml 0.8.12", diff --git a/api-reference-v2/openapi_spec.json b/api-reference-v2/openapi_spec.json index af1186ac9ed..9c946eb1654 100644 --- a/api-reference-v2/openapi_spec.json +++ b/api-reference-v2/openapi_spec.json @@ -7529,7 +7529,8 @@ }, "profile_id": { "type": "string", - "description": "Identifier for the business profile, if not provided default will be chosen from merchant account" + "description": "Identifier for the business profile, if not provided default will be chosen from merchant account", + "maxLength": 64 }, "connector_account_details": { "allOf": [ diff --git a/api-reference/openapi_spec.json b/api-reference/openapi_spec.json index 83a505746ef..bf0f2c5c446 100644 --- a/api-reference/openapi_spec.json +++ b/api-reference/openapi_spec.json @@ -7366,7 +7366,7 @@ }, "profile_id": { "type": "string", - "description": "The default business profile that must be used for creating merchant accounts and payments", + "description": "The identifier for business profile. This must be used for creating merchant accounts, payments and payouts", "example": "pro_abcdefghijklmnopqrstuvwxyz", "maxLength": 64 }, @@ -12004,7 +12004,7 @@ }, "default_profile": { "type": "string", - "description": "The default business profile that must be used for creating merchant accounts and payments\nTo unset this field, pass an empty string", + "description": "The default business profile that must be used for creating merchant accounts and payments", "nullable": true, "maxLength": 64 }, @@ -12042,7 +12042,8 @@ "profile_id": { "type": "string", "description": "Identifier for the business profile, if not provided default will be chosen from merchant account", - "nullable": true + "nullable": true, + "maxLength": 64 }, "connector_account_details": { "allOf": [ diff --git a/crates/api_models/src/admin.rs b/crates/api_models/src/admin.rs index 18ad5dbf844..a23b891f65e 100644 --- a/crates/api_models/src/admin.rs +++ b/crates/api_models/src/admin.rs @@ -330,9 +330,8 @@ pub struct MerchantAccountUpdate { pub frm_routing_algorithm: Option<serde_json::Value>, /// The default business profile that must be used for creating merchant accounts and payments - /// To unset this field, pass an empty string - #[schema(max_length = 64)] - pub default_profile: Option<String>, + #[schema(max_length = 64, value_type = Option<String>)] + pub default_profile: Option<id_type::ProfileId>, /// Default payment method collect link config #[schema(value_type = Option<BusinessCollectLinkConfig>)] @@ -526,8 +525,8 @@ pub struct MerchantAccountResponse { pub is_recon_enabled: bool, /// The default business profile that must be used for creating merchant accounts and payments - #[schema(max_length = 64)] - pub default_profile: Option<String>, + #[schema(max_length = 64, value_type = Option<String>)] + pub default_profile: Option<id_type::ProfileId>, /// Used to indicate the status of the recon module for a merchant account #[schema(value_type = ReconStatus, example = "not_requested")] @@ -699,7 +698,8 @@ pub struct MerchantConnectorCreate { pub connector_label: Option<String>, /// Identifier for the business profile, if not provided default will be chosen from merchant account - pub profile_id: String, + #[schema(max_length = 64, value_type = String)] + pub profile_id: id_type::ProfileId, /// An object containing the required details/credentials for a Connector account. #[schema(value_type = Option<MerchantConnectorDetails>,example = json!({ "auth_type": "HeaderKey","api_key": "Basic MyVerySecretApiKey" }))] @@ -829,7 +829,8 @@ pub struct MerchantConnectorCreate { pub connector_label: Option<String>, /// Identifier for the business profile, if not provided default will be chosen from merchant account - pub profile_id: Option<String>, + #[schema(max_length = 64, value_type = Option<String>)] + pub profile_id: Option<id_type::ProfileId>, /// An object containing the required details/credentials for a Connector account. #[schema(value_type = Option<MerchantConnectorDetails>,example = json!({ "auth_type": "HeaderKey","api_key": "Basic MyVerySecretApiKey" }))] @@ -1063,8 +1064,8 @@ pub struct MerchantConnectorResponse { pub id: String, /// Identifier for the business profile, if not provided default will be chosen from merchant account - #[schema(max_length = 64)] - pub profile_id: String, + #[schema(max_length = 64, value_type = String)] + pub profile_id: id_type::ProfileId, /// An object containing the required details/credentials for a Connector account. #[schema(value_type = Option<MerchantConnectorDetails>,example = json!({ "auth_type": "HeaderKey","api_key": "Basic MyVerySecretApiKey" }))] @@ -1170,8 +1171,8 @@ pub struct MerchantConnectorResponse { pub merchant_connector_id: String, /// Identifier for the business profile, if not provided default will be chosen from merchant account - #[schema(max_length = 64)] - pub profile_id: String, + #[schema(max_length = 64, value_type = String)] + pub profile_id: id_type::ProfileId, /// An object containing the required details/credentials for a Connector account. #[schema(value_type = Option<MerchantConnectorDetails>,example = json!({ "auth_type": "HeaderKey","api_key": "Basic MyVerySecretApiKey" }))] @@ -1294,8 +1295,8 @@ pub struct MerchantConnectorListResponse { pub merchant_connector_id: String, /// Identifier for the business profile, if not provided default will be chosen from merchant account - #[schema(max_length = 64)] - pub profile_id: String, + #[schema(max_length = 64, value_type = String)] + pub profile_id: id_type::ProfileId, /// An object containing the details about the payment methods that need to be enabled under this merchant connector account #[schema(example = json!([ @@ -1403,8 +1404,8 @@ pub struct MerchantConnectorListResponse { pub id: String, /// Identifier for the business profile, if not provided default will be chosen from merchant account - #[schema(max_length = 64)] - pub profile_id: String, + #[schema(max_length = 64, value_type = String)] + pub profile_id: id_type::ProfileId, /// An object containing the details about the payment methods that need to be enabled under this merchant connector account #[schema(example = json!([ @@ -2076,9 +2077,9 @@ pub struct BusinessProfileResponse { #[schema(max_length = 64, example = "y3oqhf46pyzuxjbcn2giaqnb44", value_type = String)] pub merchant_id: id_type::MerchantId, - /// The default business profile that must be used for creating merchant accounts and payments - #[schema(max_length = 64, example = "pro_abcdefghijklmnopqrstuvwxyz")] - pub profile_id: String, + /// The identifier for business profile. This must be used for creating merchant accounts, payments and payouts + #[schema(max_length = 64, value_type = String, example = "pro_abcdefghijklmnopqrstuvwxyz")] + pub profile_id: id_type::ProfileId, /// Name of the business profile #[schema(max_length = 64)] @@ -2193,8 +2194,8 @@ pub struct BusinessProfileResponse { pub merchant_id: id_type::MerchantId, /// The identifier for business profile. This must be used for creating merchant accounts, payments and payouts - #[schema(max_length = 64, example = "pro_abcdefghijklmnopqrstuvwxyz")] - pub id: String, + #[schema(max_length = 64, value_type = String, example = "pro_abcdefghijklmnopqrstuvwxyz")] + pub id: id_type::ProfileId, /// Name of the business profile #[schema(max_length = 64)] diff --git a/crates/api_models/src/connector_onboarding.rs b/crates/api_models/src/connector_onboarding.rs index 1ed18392dcb..de4b8843dfc 100644 --- a/crates/api_models/src/connector_onboarding.rs +++ b/crates/api_models/src/connector_onboarding.rs @@ -15,7 +15,7 @@ pub enum ActionUrlResponse { #[derive(serde::Deserialize, serde::Serialize, Debug, Clone)] pub struct OnboardingSyncRequest { - pub profile_id: String, + pub profile_id: common_utils::id_type::ProfileId, pub connector_id: String, pub connector: enums::Connector, } diff --git a/crates/api_models/src/disputes.rs b/crates/api_models/src/disputes.rs index e4c38cef860..5e9db4cdfd1 100644 --- a/crates/api_models/src/disputes.rs +++ b/crates/api_models/src/disputes.rs @@ -44,7 +44,8 @@ pub struct DisputeResponse { #[serde(with = "common_utils::custom_serde::iso8601")] pub created_at: PrimitiveDateTime, /// The `profile_id` associated with the dispute - pub profile_id: Option<String>, + #[schema(value_type = Option<String>)] + pub profile_id: Option<common_utils::id_type::ProfileId>, /// The `merchant_connector_id` of the connector / processor through which the dispute was processed pub merchant_connector_id: Option<String>, } @@ -109,7 +110,8 @@ pub struct DisputeListConstraints { /// limit on the number of objects to return pub limit: Option<i64>, /// The identifier for business profile - pub profile_id: Option<String>, + #[schema(value_type = Option<String>)] + pub profile_id: Option<common_utils::id_type::ProfileId>, /// status of the dispute pub dispute_status: Option<DisputeStatus>, /// stage of the dispute diff --git a/crates/api_models/src/payments.rs b/crates/api_models/src/payments.rs index 5ccde3e6d74..9f782841f1d 100644 --- a/crates/api_models/src/payments.rs +++ b/crates/api_models/src/payments.rs @@ -480,7 +480,8 @@ pub struct PaymentsRequest { /// The business profile to be used for this payment, if not passed the default business profile associated with the merchant account will be used. It is mandatory in case multiple business profiles have been set up. #[remove_in(PaymentsUpdateRequest, PaymentsConfirmRequest)] - pub profile_id: Option<String>, + #[schema(value_type = Option<String>)] + pub profile_id: Option<id_type::ProfileId>, #[remove_in(PaymentsConfirmRequest)] #[schema(value_type = Option<RequestSurchargeDetails>)] @@ -3808,7 +3809,8 @@ pub struct PaymentsResponse { /// Details for Payment link pub payment_link: Option<PaymentLinkResponse>, /// The business profile that is associated with this payment - pub profile_id: Option<String>, + #[schema(value_type = Option<String>)] + pub profile_id: Option<id_type::ProfileId>, /// Details of surcharge applied on this payment pub surcharge_details: Option<RequestSurchargeDetails>, @@ -4024,7 +4026,7 @@ pub struct PaymentListFilterConstraints { /// The identifier for payment pub payment_id: Option<String>, /// The identifier for business profile - pub profile_id: Option<String>, + pub profile_id: Option<id_type::ProfileId>, /// The identifier for customer pub customer_id: Option<id_type::CustomerId>, /// The limit on the number of objects. The default limit is 10 and max limit is 20 diff --git a/crates/api_models/src/payouts.rs b/crates/api_models/src/payouts.rs index 0010c2988e1..b755a07d7ff 100644 --- a/crates/api_models/src/payouts.rs +++ b/crates/api_models/src/payouts.rs @@ -144,7 +144,8 @@ pub struct PayoutCreateRequest { pub payout_token: Option<String>, /// The business profile to use for this payout, especially if there are multiple business profiles associated with the account, otherwise default business profile associated with the merchant account will be used. - pub profile_id: Option<String>, + #[schema(value_type = Option<String>)] + pub profile_id: Option<id_type::ProfileId>, /// The send method which will be required for processing payouts, check options for better understanding. #[schema(value_type = Option<PayoutSendPriority>, example = "instant")] @@ -481,7 +482,8 @@ pub struct PayoutCreateResponse { pub error_code: Option<String>, /// The business profile that is associated with this payout - pub profile_id: String, + #[schema(value_type = String)] + pub profile_id: id_type::ProfileId, /// Time when the payout was created #[schema(example = "2022-09-10T10:11:12Z")] @@ -685,7 +687,8 @@ pub struct PayoutListFilterConstraints { )] pub payout_id: Option<String>, /// The identifier for business profile - pub profile_id: Option<String>, + #[schema(value_type = Option<String>)] + pub profile_id: Option<id_type::ProfileId>, /// The identifier for customer #[schema(value_type = Option<String>,example = "cus_y3oqhf46pyzuxjbcn2giaqnb44")] pub customer_id: Option<id_type::CustomerId>, diff --git a/crates/api_models/src/refunds.rs b/crates/api_models/src/refunds.rs index dd6f1a22503..656416dce96 100644 --- a/crates/api_models/src/refunds.rs +++ b/crates/api_models/src/refunds.rs @@ -156,7 +156,8 @@ pub struct RefundResponse { #[schema(example = "stripe")] pub connector: String, /// The id of business profile for this refund - pub profile_id: Option<String>, + #[schema(value_type = Option<String>)] + pub profile_id: Option<common_utils::id_type::ProfileId>, /// The merchant_connector_id of the processor through which this payment went through pub merchant_connector_id: Option<String>, /// Charge specific fields for controlling the revert of funds from either platform or connected account @@ -171,7 +172,8 @@ pub struct RefundListRequest { /// The identifier for the refund pub refund_id: Option<String>, /// The identifier for business profile - pub profile_id: Option<String>, + #[schema(value_type = Option<String>)] + pub profile_id: Option<common_utils::id_type::ProfileId>, /// Limit on the number of objects to return pub limit: Option<i64>, /// The starting point within a list of objects diff --git a/crates/api_models/src/routing.rs b/crates/api_models/src/routing.rs index 04ca1fd4429..373319333cb 100644 --- a/crates/api_models/src/routing.rs +++ b/crates/api_models/src/routing.rs @@ -36,7 +36,8 @@ pub struct RoutingConfigRequest { pub name: String, pub description: String, pub algorithm: RoutingAlgorithm, - pub profile_id: String, + #[schema(value_type = String)] + pub profile_id: common_utils::id_type::ProfileId, } #[cfg(all(any(feature = "v1", feature = "v2"), not(feature = "routing_v2")))] @@ -45,12 +46,14 @@ pub struct RoutingConfigRequest { pub name: Option<String>, pub description: Option<String>, pub algorithm: Option<RoutingAlgorithm>, - pub profile_id: Option<String>, + #[schema(value_type = Option<String>)] + pub profile_id: Option<common_utils::id_type::ProfileId>, } #[derive(Debug, serde::Serialize, ToSchema)] pub struct ProfileDefaultRoutingConfig { - pub profile_id: String, + #[schema(value_type = String)] + pub profile_id: common_utils::id_type::ProfileId, pub connectors: Vec<RoutableConnectorChoice>, } @@ -62,13 +65,13 @@ pub struct RoutingRetrieveQuery { #[derive(Debug, serde::Deserialize, serde::Serialize)] pub struct RoutingRetrieveLinkQuery { - pub profile_id: Option<String>, + pub profile_id: Option<common_utils::id_type::ProfileId>, } #[derive(Debug, serde::Deserialize, serde::Serialize)] pub struct RoutingRetrieveLinkQueryWrapper { pub routing_query: RoutingRetrieveQuery, - pub profile_id: String, + pub profile_id: common_utils::id_type::ProfileId, } #[derive(Debug, Clone, serde::Serialize, serde::Deserialize, ToSchema)] /// Response of the retrieved routing configs for a merchant account @@ -87,7 +90,8 @@ pub enum LinkedRoutingConfigRetrieveResponse { /// Routing Algorithm specific to merchants pub struct MerchantRoutingAlgorithm { pub id: String, - pub profile_id: String, + #[schema(value_type = String)] + pub profile_id: common_utils::id_type::ProfileId, pub name: String, pub description: String, pub algorithm: RoutingAlgorithm, @@ -257,10 +261,9 @@ pub enum RoutingAlgorithmKind { } #[derive(Debug, Clone, serde::Serialize, serde::Deserialize)] - pub struct RoutingPayloadWrapper { pub updated_config: Vec<RoutableConnectorChoice>, - pub profile_id: String, + pub profile_id: common_utils::id_type::ProfileId, } #[derive(Debug, Clone, serde::Serialize, serde::Deserialize, ToSchema)] @@ -453,8 +456,8 @@ impl RoutingAlgorithmRef { pub struct RoutingDictionaryRecord { pub id: String, - - pub profile_id: String, + #[schema(value_type = String)] + pub profile_id: common_utils::id_type::ProfileId, pub name: String, pub kind: RoutingAlgorithmKind, pub description: String, @@ -485,6 +488,6 @@ pub struct RoutingAlgorithmId(pub String); #[derive(Debug, Clone, serde::Serialize, serde::Deserialize)] pub struct RoutingLinkWrapper { - pub profile_id: String, + pub profile_id: common_utils::id_type::ProfileId, pub algorithm_id: RoutingAlgorithmId, } diff --git a/crates/api_models/src/user.rs b/crates/api_models/src/user.rs index 9867aba7b39..1fdf47425e2 100644 --- a/crates/api_models/src/user.rs +++ b/crates/api_models/src/user.rs @@ -405,6 +405,6 @@ pub struct ListMerchantsForUserInOrgResponse { #[derive(Debug, serde::Serialize)] pub struct ListProfilesForUserInOrgAndMerchantAccountResponse { - pub profile_id: String, + pub profile_id: id_type::ProfileId, pub profile_name: String, } diff --git a/crates/api_models/src/user/sample_data.rs b/crates/api_models/src/user/sample_data.rs index 6d20b20f369..dc95de913fa 100644 --- a/crates/api_models/src/user/sample_data.rs +++ b/crates/api_models/src/user/sample_data.rs @@ -19,5 +19,5 @@ pub struct SampleDataRequest { pub auth_type: Option<Vec<AuthenticationType>>, pub business_country: Option<CountryAlpha2>, pub business_label: Option<String>, - pub profile_id: Option<String>, + pub profile_id: Option<common_utils::id_type::ProfileId>, } diff --git a/crates/api_models/src/webhook_events.rs b/crates/api_models/src/webhook_events.rs index fa61cc0f253..f9741147cd0 100644 --- a/crates/api_models/src/webhook_events.rs +++ b/crates/api_models/src/webhook_events.rs @@ -26,7 +26,8 @@ pub struct EventListConstraints { pub object_id: Option<String>, /// Filter all events associated with the specified business profile ID. - pub profile_id: Option<String>, + #[schema(value_type = Option<String>)] + pub profile_id: Option<common_utils::id_type::ProfileId>, } #[derive(Debug)] @@ -54,8 +55,8 @@ pub struct EventListItemResponse { pub merchant_id: common_utils::id_type::MerchantId, /// The identifier for the Business Profile. - #[schema(max_length = 64, example = "SqB0zwDGR5wHppWf0bx7GKr1f2")] - pub profile_id: String, + #[schema(max_length = 64, value_type = String, example = "SqB0zwDGR5wHppWf0bx7GKr1f2")] + pub profile_id: common_utils::id_type::ProfileId, /// The identifier for the object (Payment Intent ID, Refund ID, etc.) #[schema(max_length = 64, example = "QHrfd5LUDdZaKtAjdJmMu0dMa1")] diff --git a/crates/common_utils/src/events.rs b/crates/common_utils/src/events.rs index 43777143968..48b2e9d98c0 100644 --- a/crates/common_utils/src/events.rs +++ b/crates/common_utils/src/events.rs @@ -35,6 +35,9 @@ pub enum ApiEventsType { Customer { customer_id: id_type::CustomerId, }, + BusinessProfile { + profile_id: id_type::ProfileId, + }, User { user_id: String, }, diff --git a/crates/common_utils/src/id_type.rs b/crates/common_utils/src/id_type.rs index 55e2e3ffb18..cc4c56d6abb 100644 --- a/crates/common_utils/src/id_type.rs +++ b/crates/common_utils/src/id_type.rs @@ -6,6 +6,7 @@ use std::{borrow::Cow, fmt::Debug}; mod customer; mod merchant; mod organization; +mod profile; mod global_id; @@ -19,6 +20,7 @@ use diesel::{ }; pub use merchant::MerchantId; pub use organization::OrganizationId; +pub use profile::ProfileId; use serde::{Deserialize, Serialize}; use thiserror::Error; @@ -198,6 +200,12 @@ where } } +/// An interface to generate object identifiers. +pub trait GenerateId { + /// Generates a random object identifier. + fn generate() -> Self; +} + #[cfg(test)] mod alphanumeric_id_tests { #![allow(clippy::unwrap_used)] diff --git a/crates/common_utils/src/id_type/customer.rs b/crates/common_utils/src/id_type/customer.rs index 65049125960..9d02f201383 100644 --- a/crates/common_utils/src/id_type/customer.rs +++ b/crates/common_utils/src/id_type/customer.rs @@ -9,6 +9,7 @@ crate::impl_debug_id_type!(CustomerId); crate::impl_default_id_type!(CustomerId, "cus"); crate::impl_try_from_cow_str_id_type!(CustomerId, "customer_id"); +crate::impl_generate_id_id_type!(CustomerId, "cus"); crate::impl_serializable_secret_id_type!(CustomerId); crate::impl_queryable_id_type!(CustomerId); crate::impl_to_sql_from_sql_id_type!(CustomerId); diff --git a/crates/common_utils/src/id_type/merchant.rs b/crates/common_utils/src/id_type/merchant.rs index 8358f39051e..08b80249ae3 100644 --- a/crates/common_utils/src/id_type/merchant.rs +++ b/crates/common_utils/src/id_type/merchant.rs @@ -25,6 +25,7 @@ crate::impl_debug_id_type!(MerchantId); crate::impl_default_id_type!(MerchantId, "mer"); crate::impl_try_from_cow_str_id_type!(MerchantId, "merchant_id"); +crate::impl_generate_id_id_type!(MerchantId, "mer"); crate::impl_serializable_secret_id_type!(MerchantId); crate::impl_queryable_id_type!(MerchantId); crate::impl_to_sql_from_sql_id_type!(MerchantId); diff --git a/crates/common_utils/src/id_type/organization.rs b/crates/common_utils/src/id_type/organization.rs index 336442e6057..f88a62daa1d 100644 --- a/crates/common_utils/src/id_type/organization.rs +++ b/crates/common_utils/src/id_type/organization.rs @@ -9,6 +9,7 @@ crate::impl_debug_id_type!(OrganizationId); crate::impl_default_id_type!(OrganizationId, "org"); crate::impl_try_from_cow_str_id_type!(OrganizationId, "organization_id"); +crate::impl_generate_id_id_type!(OrganizationId, "org"); crate::impl_serializable_secret_id_type!(OrganizationId); crate::impl_queryable_id_type!(OrganizationId); crate::impl_to_sql_from_sql_id_type!(OrganizationId); diff --git a/crates/common_utils/src/id_type/profile.rs b/crates/common_utils/src/id_type/profile.rs new file mode 100644 index 00000000000..e9d90e7bba1 --- /dev/null +++ b/crates/common_utils/src/id_type/profile.rs @@ -0,0 +1,22 @@ +crate::id_type!( + ProfileId, + "A type for profile_id that can be used for business profile ids" +); +crate::impl_id_type_methods!(ProfileId, "profile_id"); + +// This is to display the `ProfileId` as ProfileId(abcd) +crate::impl_debug_id_type!(ProfileId); +crate::impl_try_from_cow_str_id_type!(ProfileId, "profile_id"); + +crate::impl_generate_id_id_type!(ProfileId, "pro"); +crate::impl_serializable_secret_id_type!(ProfileId); +crate::impl_queryable_id_type!(ProfileId); +crate::impl_to_sql_from_sql_id_type!(ProfileId); + +impl crate::events::ApiEventMetric for ProfileId { + fn get_api_event_type(&self) -> Option<crate::events::ApiEventsType> { + Some(crate::events::ApiEventsType::BusinessProfile { + profile_id: self.clone(), + }) + } +} diff --git a/crates/common_utils/src/lib.rs b/crates/common_utils/src/lib.rs index 400da349983..67a67bee5c3 100644 --- a/crates/common_utils/src/lib.rs +++ b/crates/common_utils/src/lib.rs @@ -214,12 +214,23 @@ fn generate_ref_id_with_default_length<const MAX_LENGTH: u8, const MIN_LENGTH: u /// Generate a customer id with default length, with prefix as `cus` pub fn generate_customer_id_of_default_length() -> id_type::CustomerId { - id_type::CustomerId::default() + use id_type::GenerateId; + + id_type::CustomerId::generate() } /// Generate a organization id with default length, with prefix as `org` pub fn generate_organization_id_of_default_length() -> id_type::OrganizationId { - id_type::OrganizationId::default() + use id_type::GenerateId; + + id_type::OrganizationId::generate() +} + +/// Generate a profile id with default length, with prefix as `pro` +pub fn generate_profile_id_of_default_length() -> id_type::ProfileId { + use id_type::GenerateId; + + id_type::ProfileId::generate() } /// Generate a nanoid with the given prefix and a default length diff --git a/crates/common_utils/src/macros.rs b/crates/common_utils/src/macros.rs index 06554ee9b51..94d8074c301 100644 --- a/crates/common_utils/src/macros.rs +++ b/crates/common_utils/src/macros.rs @@ -233,6 +233,18 @@ mod id_type { }; } + /// Implements the `GenerateId` trait on the specified ID type. + #[macro_export] + macro_rules! impl_generate_id_id_type { + ($type:ty, $prefix:literal) => { + impl $crate::id_type::GenerateId for $type { + fn generate() -> Self { + Self($crate::generate_ref_id_with_default_length($prefix)) + } + } + }; + } + /// Implements the `SerializableSecret` trait on the specified ID type. #[macro_export] macro_rules! impl_serializable_secret_id_type { diff --git a/crates/connector_configs/Cargo.toml b/crates/connector_configs/Cargo.toml index 1541a0864cc..1809d755834 100644 --- a/crates/connector_configs/Cargo.toml +++ b/crates/connector_configs/Cargo.toml @@ -17,6 +17,7 @@ payouts = ["api_models/payouts"] [dependencies] # First party crates api_models = { version = "0.1.0", path = "../api_models", package = "api_models" } +common_utils = { version = "0.1.0", path = "../common_utils" } # Third party crates serde = { version = "1.0.197", features = ["derive"] } diff --git a/crates/connector_configs/src/common_config.rs b/crates/connector_configs/src/common_config.rs index 88b8165853d..d0becb80468 100644 --- a/crates/connector_configs/src/common_config.rs +++ b/crates/connector_configs/src/common_config.rs @@ -161,7 +161,7 @@ pub struct Provider { #[serde(rename_all = "snake_case")] pub struct ConnectorApiIntegrationPayload { pub connector_type: String, - pub profile_id: String, + pub profile_id: common_utils::id_type::ProfileId, pub connector_name: api_models::enums::Connector, #[serde(skip_deserializing)] #[schema(example = "stripe_US_travel")] diff --git a/crates/diesel_models/src/authentication.rs b/crates/diesel_models/src/authentication.rs index cb518805ebf..606644255bc 100644 --- a/crates/diesel_models/src/authentication.rs +++ b/crates/diesel_models/src/authentication.rs @@ -41,7 +41,7 @@ pub struct Authentication { pub acs_reference_number: Option<String>, pub acs_trans_id: Option<String>, pub acs_signed_content: Option<String>, - pub profile_id: String, + pub profile_id: common_utils::id_type::ProfileId, pub payment_id: Option<String>, pub merchant_connector_id: String, pub ds_trans_id: Option<String>, @@ -88,7 +88,7 @@ pub struct AuthenticationNew { pub acs_reference_number: Option<String>, pub acs_trans_id: Option<String>, pub acs_signed_content: Option<String>, - pub profile_id: String, + pub profile_id: common_utils::id_type::ProfileId, pub payment_id: Option<String>, pub merchant_connector_id: String, pub ds_trans_id: Option<String>, diff --git a/crates/diesel_models/src/business_profile.rs b/crates/diesel_models/src/business_profile.rs index cab1aec410f..20add83bd2c 100644 --- a/crates/diesel_models/src/business_profile.rs +++ b/crates/diesel_models/src/business_profile.rs @@ -25,7 +25,7 @@ use crate::schema_v2::business_profile; #[derive(Clone, Debug, Identifiable, Queryable, Selectable, router_derive::DebugAsDisplay)] #[diesel(table_name = business_profile, primary_key(profile_id), check_for_backend(diesel::pg::Pg))] pub struct BusinessProfile { - pub profile_id: String, + pub profile_id: common_utils::id_type::ProfileId, pub merchant_id: common_utils::id_type::MerchantId, pub profile_name: String, pub created_at: time::PrimitiveDateTime, @@ -67,7 +67,7 @@ pub struct BusinessProfile { #[derive(Clone, Debug, Insertable, router_derive::DebugAsDisplay)] #[diesel(table_name = business_profile, primary_key(profile_id))] pub struct BusinessProfileNew { - pub profile_id: String, + pub profile_id: common_utils::id_type::ProfileId, pub merchant_id: common_utils::id_type::MerchantId, pub profile_name: String, pub created_at: time::PrimitiveDateTime, @@ -242,7 +242,7 @@ impl BusinessProfileUpdateInternal { #[derive(Clone, Debug, Identifiable, Queryable, Selectable, router_derive::DebugAsDisplay)] #[diesel(table_name = business_profile, primary_key(profile_id), check_for_backend(diesel::pg::Pg))] pub struct BusinessProfile { - pub profile_id: String, + pub profile_id: common_utils::id_type::ProfileId, pub merchant_id: common_utils::id_type::MerchantId, pub profile_name: String, pub created_at: time::PrimitiveDateTime, @@ -283,7 +283,7 @@ pub struct BusinessProfile { #[derive(Clone, Debug, Insertable, router_derive::DebugAsDisplay)] #[diesel(table_name = business_profile, primary_key(profile_id))] pub struct BusinessProfileNew { - pub profile_id: String, + pub profile_id: common_utils::id_type::ProfileId, pub merchant_id: common_utils::id_type::MerchantId, pub profile_name: String, pub created_at: time::PrimitiveDateTime, diff --git a/crates/diesel_models/src/dispute.rs b/crates/diesel_models/src/dispute.rs index 704b1781e2a..14fe16c9826 100644 --- a/crates/diesel_models/src/dispute.rs +++ b/crates/diesel_models/src/dispute.rs @@ -27,7 +27,7 @@ pub struct DisputeNew { pub connector_updated_at: Option<PrimitiveDateTime>, pub connector: String, pub evidence: Option<Secret<serde_json::Value>>, - pub profile_id: Option<String>, + pub profile_id: Option<common_utils::id_type::ProfileId>, pub merchant_connector_id: Option<String>, pub dispute_amount: i64, } @@ -56,7 +56,7 @@ pub struct Dispute { pub modified_at: PrimitiveDateTime, pub connector: String, pub evidence: Secret<serde_json::Value>, - pub profile_id: Option<String>, + pub profile_id: Option<common_utils::id_type::ProfileId>, pub merchant_connector_id: Option<String>, pub dispute_amount: i64, } diff --git a/crates/diesel_models/src/events.rs b/crates/diesel_models/src/events.rs index 20c811654a7..2cc2bfff3b2 100644 --- a/crates/diesel_models/src/events.rs +++ b/crates/diesel_models/src/events.rs @@ -22,7 +22,7 @@ pub struct EventNew { pub primary_object_type: storage_enums::EventObjectType, pub created_at: PrimitiveDateTime, pub merchant_id: Option<common_utils::id_type::MerchantId>, - pub business_profile_id: Option<String>, + pub business_profile_id: Option<common_utils::id_type::ProfileId>, pub primary_object_created_at: Option<PrimitiveDateTime>, pub idempotent_event_id: Option<String>, pub initial_attempt_id: Option<String>, @@ -51,7 +51,7 @@ pub struct Event { #[serde(with = "custom_serde::iso8601")] pub created_at: PrimitiveDateTime, pub merchant_id: Option<common_utils::id_type::MerchantId>, - pub business_profile_id: Option<String>, + pub business_profile_id: Option<common_utils::id_type::ProfileId>, // This column can be used to partition the database table, so that all events related to a // single object would reside in the same partition pub primary_object_created_at: Option<PrimitiveDateTime>, diff --git a/crates/diesel_models/src/file.rs b/crates/diesel_models/src/file.rs index e5ad3568d70..523bb1f26ef 100644 --- a/crates/diesel_models/src/file.rs +++ b/crates/diesel_models/src/file.rs @@ -17,7 +17,7 @@ pub struct FileMetadataNew { pub file_upload_provider: Option<common_enums::FileUploadProvider>, pub available: bool, pub connector_label: Option<String>, - pub profile_id: Option<String>, + pub profile_id: Option<common_utils::id_type::ProfileId>, pub merchant_connector_id: Option<String>, } @@ -36,7 +36,7 @@ pub struct FileMetadata { #[serde(with = "custom_serde::iso8601")] pub created_at: time::PrimitiveDateTime, pub connector_label: Option<String>, - pub profile_id: Option<String>, + pub profile_id: Option<common_utils::id_type::ProfileId>, pub merchant_connector_id: Option<String>, } @@ -46,7 +46,7 @@ pub enum FileMetadataUpdate { provider_file_id: Option<String>, file_upload_provider: Option<common_enums::FileUploadProvider>, available: bool, - profile_id: Option<String>, + profile_id: Option<common_utils::id_type::ProfileId>, merchant_connector_id: Option<String>, }, } @@ -57,7 +57,7 @@ pub struct FileMetadataUpdateInternal { provider_file_id: Option<String>, file_upload_provider: Option<common_enums::FileUploadProvider>, available: bool, - profile_id: Option<String>, + profile_id: Option<common_utils::id_type::ProfileId>, merchant_connector_id: Option<String>, } diff --git a/crates/diesel_models/src/merchant_account.rs b/crates/diesel_models/src/merchant_account.rs index b3ef64b3e3d..ac7635e88c5 100644 --- a/crates/diesel_models/src/merchant_account.rs +++ b/crates/diesel_models/src/merchant_account.rs @@ -52,7 +52,7 @@ pub struct MerchantAccount { pub payout_routing_algorithm: Option<serde_json::Value>, pub organization_id: common_utils::id_type::OrganizationId, pub is_recon_enabled: bool, - pub default_profile: Option<String>, + pub default_profile: Option<common_utils::id_type::ProfileId>, pub recon_status: storage_enums::ReconStatus, pub payment_link_config: Option<serde_json::Value>, pub pm_collect_link_config: Option<serde_json::Value>, @@ -87,7 +87,7 @@ pub struct MerchantAccountSetter { pub payout_routing_algorithm: Option<serde_json::Value>, pub organization_id: common_utils::id_type::OrganizationId, pub is_recon_enabled: bool, - pub default_profile: Option<String>, + pub default_profile: Option<common_utils::id_type::ProfileId>, pub recon_status: storage_enums::ReconStatus, pub payment_link_config: Option<serde_json::Value>, pub pm_collect_link_config: Option<serde_json::Value>, @@ -241,7 +241,7 @@ pub struct MerchantAccountNew { pub payout_routing_algorithm: Option<serde_json::Value>, pub organization_id: common_utils::id_type::OrganizationId, pub is_recon_enabled: bool, - pub default_profile: Option<String>, + pub default_profile: Option<common_utils::id_type::ProfileId>, pub recon_status: storage_enums::ReconStatus, pub payment_link_config: Option<serde_json::Value>, pub pm_collect_link_config: Option<serde_json::Value>, @@ -306,7 +306,7 @@ pub struct MerchantAccountUpdateInternal { pub payout_routing_algorithm: Option<serde_json::Value>, pub organization_id: Option<common_utils::id_type::OrganizationId>, pub is_recon_enabled: Option<bool>, - pub default_profile: Option<Option<String>>, + pub default_profile: Option<Option<common_utils::id_type::ProfileId>>, pub recon_status: Option<storage_enums::ReconStatus>, pub payment_link_config: Option<serde_json::Value>, pub pm_collect_link_config: Option<serde_json::Value>, diff --git a/crates/diesel_models/src/merchant_connector_account.rs b/crates/diesel_models/src/merchant_connector_account.rs index 876240f44a3..61f2af238ed 100644 --- a/crates/diesel_models/src/merchant_connector_account.rs +++ b/crates/diesel_models/src/merchant_connector_account.rs @@ -48,7 +48,7 @@ pub struct MerchantConnectorAccount { pub connector_webhook_details: Option<pii::SecretSerdeValue>, #[diesel(deserialize_as = super::OptionalDieselArray<pii::SecretSerdeValue>)] pub frm_config: Option<Vec<pii::SecretSerdeValue>>, - pub profile_id: Option<String>, + pub profile_id: Option<id_type::ProfileId>, #[diesel(deserialize_as = super::OptionalDieselArray<String>)] pub applepay_verified_domains: Option<Vec<String>>, pub pm_auth_config: Option<pii::SecretSerdeValue>, @@ -95,7 +95,7 @@ pub struct MerchantConnectorAccount { pub connector_webhook_details: Option<pii::SecretSerdeValue>, #[diesel(deserialize_as = super::OptionalDieselArray<pii::SecretSerdeValue>)] pub frm_config: Option<Vec<pii::SecretSerdeValue>>, - pub profile_id: String, + pub profile_id: id_type::ProfileId, #[diesel(deserialize_as = super::OptionalDieselArray<String>)] pub applepay_verified_domains: Option<Vec<String>>, pub pm_auth_config: Option<pii::SecretSerdeValue>, @@ -139,7 +139,7 @@ pub struct MerchantConnectorAccountNew { pub connector_webhook_details: Option<pii::SecretSerdeValue>, #[diesel(deserialize_as = super::OptionalDieselArray<pii::SecretSerdeValue>)] pub frm_config: Option<Vec<pii::SecretSerdeValue>>, - pub profile_id: Option<String>, + pub profile_id: Option<id_type::ProfileId>, #[diesel(deserialize_as = super::OptionalDieselArray<String>)] pub applepay_verified_domains: Option<Vec<String>>, pub pm_auth_config: Option<pii::SecretSerdeValue>, @@ -166,7 +166,7 @@ pub struct MerchantConnectorAccountNew { pub connector_webhook_details: Option<pii::SecretSerdeValue>, #[diesel(deserialize_as = super::OptionalDieselArray<pii::SecretSerdeValue>)] pub frm_config: Option<Vec<pii::SecretSerdeValue>>, - pub profile_id: String, + pub profile_id: id_type::ProfileId, #[diesel(deserialize_as = super::OptionalDieselArray<String>)] pub applepay_verified_domains: Option<Vec<String>>, pub pm_auth_config: Option<pii::SecretSerdeValue>, diff --git a/crates/diesel_models/src/payment_intent.rs b/crates/diesel_models/src/payment_intent.rs index bdea1fe52a7..7bd1652ab56 100644 --- a/crates/diesel_models/src/payment_intent.rs +++ b/crates/diesel_models/src/payment_intent.rs @@ -47,7 +47,7 @@ pub struct PaymentIntent { pub connector_metadata: Option<serde_json::Value>, pub feature_metadata: Option<serde_json::Value>, pub attempt_count: i16, - pub profile_id: Option<String>, + pub profile_id: Option<common_utils::id_type::ProfileId>, // Denotes the action(approve or reject) taken by merchant in case of manual review. // Manual review can occur when the transaction is marked as risky by the frm_processor, payment processor or when there is underpayment/over payment incase of crypto payment pub merchant_decision: Option<String>, @@ -108,7 +108,7 @@ pub struct PaymentIntent { pub connector_metadata: Option<serde_json::Value>, pub feature_metadata: Option<serde_json::Value>, pub attempt_count: i16, - pub profile_id: Option<String>, + pub profile_id: Option<common_utils::id_type::ProfileId>, // Denotes the action(approve or reject) taken by merchant in case of manual review. // Manual review can occur when the transaction is marked as risky by the frm_processor, payment processor or when there is underpayment/over payment incase of crypto payment pub merchant_decision: Option<String>, @@ -170,7 +170,7 @@ pub struct PaymentIntentNew { pub connector_metadata: Option<serde_json::Value>, pub feature_metadata: Option<serde_json::Value>, pub attempt_count: i16, - pub profile_id: Option<String>, + pub profile_id: Option<common_utils::id_type::ProfileId>, pub merchant_decision: Option<String>, pub payment_link_id: Option<String>, pub payment_confirm_source: Option<storage_enums::PaymentSource>, diff --git a/crates/diesel_models/src/payment_link.rs b/crates/diesel_models/src/payment_link.rs index 347a730eb68..51e3b89d605 100644 --- a/crates/diesel_models/src/payment_link.rs +++ b/crates/diesel_models/src/payment_link.rs @@ -23,7 +23,7 @@ pub struct PaymentLink { pub custom_merchant_name: Option<String>, pub payment_link_config: Option<serde_json::Value>, pub description: Option<String>, - pub profile_id: Option<String>, + pub profile_id: Option<common_utils::id_type::ProfileId>, pub secure_link: Option<String>, } @@ -54,6 +54,6 @@ pub struct PaymentLinkNew { pub custom_merchant_name: Option<String>, pub payment_link_config: Option<serde_json::Value>, pub description: Option<String>, - pub profile_id: Option<String>, + pub profile_id: Option<common_utils::id_type::ProfileId>, pub secure_link: Option<String>, } diff --git a/crates/diesel_models/src/payout_attempt.rs b/crates/diesel_models/src/payout_attempt.rs index 17600e0cd78..7e9b2ec4e1c 100644 --- a/crates/diesel_models/src/payout_attempt.rs +++ b/crates/diesel_models/src/payout_attempt.rs @@ -27,7 +27,7 @@ pub struct PayoutAttempt { pub created_at: PrimitiveDateTime, #[serde(with = "common_utils::custom_serde::iso8601")] pub last_modified_at: PrimitiveDateTime, - pub profile_id: String, + pub profile_id: common_utils::id_type::ProfileId, pub merchant_connector_id: Option<String>, pub routing_info: Option<serde_json::Value>, } @@ -59,11 +59,11 @@ pub struct PayoutAttemptNew { pub error_code: Option<String>, pub business_country: Option<storage_enums::CountryAlpha2>, pub business_label: Option<String>, - #[serde(default, with = "common_utils::custom_serde::iso8601::option")] - pub created_at: Option<PrimitiveDateTime>, - #[serde(default, with = "common_utils::custom_serde::iso8601::option")] - pub last_modified_at: Option<PrimitiveDateTime>, - pub profile_id: String, + #[serde(with = "common_utils::custom_serde::iso8601")] + pub created_at: PrimitiveDateTime, + #[serde(with = "common_utils::custom_serde::iso8601")] + pub last_modified_at: PrimitiveDateTime, + pub profile_id: common_utils::id_type::ProfileId, pub merchant_connector_id: Option<String>, pub routing_info: Option<serde_json::Value>, } diff --git a/crates/diesel_models/src/payouts.rs b/crates/diesel_models/src/payouts.rs index cb8f6f9a884..8acdc4a0a5a 100644 --- a/crates/diesel_models/src/payouts.rs +++ b/crates/diesel_models/src/payouts.rs @@ -31,7 +31,7 @@ pub struct Payouts { #[serde(with = "common_utils::custom_serde::iso8601")] pub last_modified_at: PrimitiveDateTime, pub attempt_count: i16, - pub profile_id: String, + pub profile_id: common_utils::id_type::ProfileId, pub status: storage_enums::PayoutStatus, pub confirm: Option<bool>, pub payout_link_id: Option<String>, @@ -72,7 +72,7 @@ pub struct PayoutsNew { #[serde(with = "common_utils::custom_serde::iso8601")] pub last_modified_at: PrimitiveDateTime, pub attempt_count: i16, - pub profile_id: String, + pub profile_id: common_utils::id_type::ProfileId, pub status: storage_enums::PayoutStatus, pub confirm: Option<bool>, pub payout_link_id: Option<String>, @@ -92,7 +92,7 @@ pub enum PayoutsUpdate { return_url: Option<String>, entity_type: storage_enums::PayoutEntityType, metadata: Option<pii::SecretSerdeValue>, - profile_id: Option<String>, + profile_id: Option<common_utils::id_type::ProfileId>, status: Option<storage_enums::PayoutStatus>, confirm: Option<bool>, payout_type: Option<storage_enums::PayoutType>, @@ -126,7 +126,7 @@ pub struct PayoutsUpdateInternal { pub entity_type: Option<storage_enums::PayoutEntityType>, pub metadata: Option<pii::SecretSerdeValue>, pub payout_method_id: Option<String>, - pub profile_id: Option<String>, + pub profile_id: Option<common_utils::id_type::ProfileId>, pub status: Option<storage_enums::PayoutStatus>, pub last_modified_at: PrimitiveDateTime, pub attempt_count: Option<i16>, diff --git a/crates/diesel_models/src/query/business_profile.rs b/crates/diesel_models/src/query/business_profile.rs index fb80449cdc6..807648b5dce 100644 --- a/crates/diesel_models/src/query/business_profile.rs +++ b/crates/diesel_models/src/query/business_profile.rs @@ -40,7 +40,10 @@ impl BusinessProfile { } } - pub async fn find_by_profile_id(conn: &PgPooledConn, profile_id: &str) -> StorageResult<Self> { + pub async fn find_by_profile_id( + conn: &PgPooledConn, + profile_id: &common_utils::id_type::ProfileId, + ) -> StorageResult<Self> { generics::generic_find_one::<<Self as HasTable>::Table, _, _>( conn, dsl::profile_id.eq(profile_id.to_owned()), @@ -51,7 +54,7 @@ impl BusinessProfile { pub async fn find_by_merchant_id_profile_id( conn: &PgPooledConn, merchant_id: &common_utils::id_type::MerchantId, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, ) -> StorageResult<Self> { generics::generic_find_one::<<Self as HasTable>::Table, _, _>( conn, @@ -97,7 +100,7 @@ impl BusinessProfile { pub async fn delete_by_profile_id_merchant_id( conn: &PgPooledConn, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, merchant_id: &common_utils::id_type::MerchantId, ) -> StorageResult<bool> { generics::generic_delete::<<Self as HasTable>::Table, _>( diff --git a/crates/diesel_models/src/query/events.rs b/crates/diesel_models/src/query/events.rs index 8b2a1a001f8..34222e6e7d8 100644 --- a/crates/diesel_models/src/query/events.rs +++ b/crates/diesel_models/src/query/events.rs @@ -118,7 +118,7 @@ impl Event { pub async fn list_initial_attempts_by_profile_id_primary_object_id( conn: &PgPooledConn, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, primary_object_id: &str, ) -> StorageResult<Vec<Self>> { generics::generic_filter::<<Self as HasTable>::Table, _, _, _>( @@ -137,7 +137,7 @@ impl Event { pub async fn list_initial_attempts_by_profile_id_constraints( conn: &PgPooledConn, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, created_after: Option<time::PrimitiveDateTime>, created_before: Option<time::PrimitiveDateTime>, limit: Option<i64>, @@ -187,7 +187,7 @@ impl Event { pub async fn list_by_profile_id_initial_attempt_id( conn: &PgPooledConn, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, initial_attempt_id: &str, ) -> StorageResult<Vec<Self>> { generics::generic_filter::<<Self as HasTable>::Table, _, _, _>( diff --git a/crates/diesel_models/src/query/merchant_connector_account.rs b/crates/diesel_models/src/query/merchant_connector_account.rs index e4dcdba5975..7eeddd5d592 100644 --- a/crates/diesel_models/src/query/merchant_connector_account.rs +++ b/crates/diesel_models/src/query/merchant_connector_account.rs @@ -78,7 +78,7 @@ impl MerchantConnectorAccount { pub async fn find_by_profile_id_connector_name( conn: &PgPooledConn, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, connector_name: &str, ) -> StorageResult<Self> { generics::generic_find_one::<<Self as HasTable>::Table, _, _>( diff --git a/crates/diesel_models/src/query/routing_algorithm.rs b/crates/diesel_models/src/query/routing_algorithm.rs index 0f3b709d264..f0fc75430e8 100644 --- a/crates/diesel_models/src/query/routing_algorithm.rs +++ b/crates/diesel_models/src/query/routing_algorithm.rs @@ -34,7 +34,7 @@ impl RoutingAlgorithm { pub async fn find_by_algorithm_id_profile_id( conn: &PgPooledConn, algorithm_id: &str, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, ) -> StorageResult<Self> { generics::generic_find_one::<<Self as HasTable>::Table, _, _>( conn, @@ -48,7 +48,7 @@ impl RoutingAlgorithm { pub async fn find_metadata_by_algorithm_id_profile_id( conn: &PgPooledConn, algorithm_id: &str, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, ) -> StorageResult<RoutingProfileMetadata> { Self::table() .select(( @@ -68,7 +68,7 @@ impl RoutingAlgorithm { ) .limit(1) .load_async::<( - String, + common_utils::id_type::ProfileId, String, String, Option<String>, @@ -109,7 +109,7 @@ impl RoutingAlgorithm { pub async fn list_metadata_by_profile_id( conn: &PgPooledConn, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, limit: i64, offset: i64, ) -> StorageResult<Vec<RoutingProfileMetadata>> { @@ -129,7 +129,7 @@ impl RoutingAlgorithm { .offset(offset) .load_async::<( String, - String, + common_utils::id_type::ProfileId, String, Option<String>, enums::RoutingAlgorithmKind, @@ -188,7 +188,7 @@ impl RoutingAlgorithm { .offset(offset) .order(dsl::modified_at.desc()) .load_async::<( - String, + common_utils::id_type::ProfileId, String, String, Option<String>, @@ -250,7 +250,7 @@ impl RoutingAlgorithm { .offset(offset) .order(dsl::modified_at.desc()) .load_async::<( - String, + common_utils::id_type::ProfileId, String, String, Option<String>, diff --git a/crates/diesel_models/src/query/user_role.rs b/crates/diesel_models/src/query/user_role.rs index b4789b3c169..7904d3c2645 100644 --- a/crates/diesel_models/src/query/user_role.rs +++ b/crates/diesel_models/src/query/user_role.rs @@ -83,7 +83,7 @@ impl UserRole { user_id: String, org_id: id_type::OrganizationId, merchant_id: id_type::MerchantId, - profile_id: Option<String>, + profile_id: Option<id_type::ProfileId>, version: UserRoleVersion, ) -> StorageResult<Self> { // Checking in user roles, for a user in token hierarchy, only one of the relation will be true, either org level, merchant level or profile level @@ -116,7 +116,7 @@ impl UserRole { user_id: String, org_id: id_type::OrganizationId, merchant_id: id_type::MerchantId, - profile_id: Option<String>, + profile_id: Option<id_type::ProfileId>, update: UserRoleUpdate, version: UserRoleVersion, ) -> StorageResult<Self> { @@ -156,7 +156,7 @@ impl UserRole { user_id: String, org_id: id_type::OrganizationId, merchant_id: id_type::MerchantId, - profile_id: Option<String>, + profile_id: Option<id_type::ProfileId>, version: UserRoleVersion, ) -> StorageResult<Self> { // Checking in user roles, for a user in token hierarchy, only one of the relation will be true, either org level, merchant level or profile level @@ -190,7 +190,7 @@ impl UserRole { user_id: String, org_id: Option<id_type::OrganizationId>, merchant_id: Option<id_type::MerchantId>, - profile_id: Option<String>, + profile_id: Option<id_type::ProfileId>, entity_id: Option<String>, version: Option<UserRoleVersion>, ) -> StorageResult<Vec<Self>> { diff --git a/crates/diesel_models/src/refund.rs b/crates/diesel_models/src/refund.rs index e4a74a6d66e..3b73a603677 100644 --- a/crates/diesel_models/src/refund.rs +++ b/crates/diesel_models/src/refund.rs @@ -46,7 +46,7 @@ pub struct Refund { pub attempt_id: String, pub refund_reason: Option<String>, pub refund_error_code: Option<String>, - pub profile_id: Option<String>, + pub profile_id: Option<common_utils::id_type::ProfileId>, pub updated_by: String, pub merchant_connector_id: Option<String>, pub charges: Option<ChargeRefunds>, @@ -88,7 +88,7 @@ pub struct RefundNew { pub description: Option<String>, pub attempt_id: String, pub refund_reason: Option<String>, - pub profile_id: Option<String>, + pub profile_id: Option<common_utils::id_type::ProfileId>, pub updated_by: String, pub merchant_connector_id: Option<String>, pub charges: Option<ChargeRefunds>, diff --git a/crates/diesel_models/src/routing_algorithm.rs b/crates/diesel_models/src/routing_algorithm.rs index e2566783e9b..6be0be3d5e4 100644 --- a/crates/diesel_models/src/routing_algorithm.rs +++ b/crates/diesel_models/src/routing_algorithm.rs @@ -7,7 +7,7 @@ use crate::{enums, schema::routing_algorithm}; #[diesel(table_name = routing_algorithm, primary_key(algorithm_id), check_for_backend(diesel::pg::Pg))] pub struct RoutingAlgorithm { pub algorithm_id: String, - pub profile_id: String, + pub profile_id: common_utils::id_type::ProfileId, pub merchant_id: common_utils::id_type::MerchantId, pub name: String, pub description: Option<String>, @@ -29,7 +29,7 @@ pub struct RoutingAlgorithmMetadata { } pub struct RoutingProfileMetadata { - pub profile_id: String, + pub profile_id: common_utils::id_type::ProfileId, pub algorithm_id: String, pub name: String, pub description: Option<String>, diff --git a/crates/diesel_models/src/user_role.rs b/crates/diesel_models/src/user_role.rs index 1a006f2a4ad..b508c86211b 100644 --- a/crates/diesel_models/src/user_role.rs +++ b/crates/diesel_models/src/user_role.rs @@ -18,7 +18,7 @@ pub struct UserRole { pub last_modified_by: String, pub created_at: PrimitiveDateTime, pub last_modified: PrimitiveDateTime, - pub profile_id: Option<String>, + pub profile_id: Option<id_type::ProfileId>, pub entity_id: Option<String>, pub entity_type: Option<EntityType>, pub version: enums::UserRoleVersion, @@ -36,7 +36,7 @@ pub struct UserRoleNew { pub last_modified_by: String, pub created_at: PrimitiveDateTime, pub last_modified: PrimitiveDateTime, - pub profile_id: Option<String>, + pub profile_id: Option<id_type::ProfileId>, pub entity_id: Option<String>, pub entity_type: Option<EntityType>, pub version: enums::UserRoleVersion, diff --git a/crates/hyperswitch_domain_models/src/business_profile.rs b/crates/hyperswitch_domain_models/src/business_profile.rs index ec072521d99..9a6edc50e73 100644 --- a/crates/hyperswitch_domain_models/src/business_profile.rs +++ b/crates/hyperswitch_domain_models/src/business_profile.rs @@ -23,7 +23,7 @@ use crate::type_encryption::{crypto_operation, AsyncLift, CryptoOperation}; ))] #[derive(Clone, Debug)] pub struct BusinessProfile { - pub profile_id: String, + pub profile_id: common_utils::id_type::ProfileId, pub merchant_id: common_utils::id_type::MerchantId, pub profile_name: String, pub created_at: time::PrimitiveDateTime, @@ -453,7 +453,7 @@ impl super::behaviour::Conversion for BusinessProfile { #[cfg(all(feature = "v2", feature = "business_profile_v2"))] #[derive(Clone, Debug)] pub struct BusinessProfile { - pub profile_id: String, + pub profile_id: common_utils::id_type::ProfileId, pub merchant_id: common_utils::id_type::MerchantId, pub profile_name: String, pub created_at: time::PrimitiveDateTime, diff --git a/crates/hyperswitch_domain_models/src/merchant_account.rs b/crates/hyperswitch_domain_models/src/merchant_account.rs index c86dff60eaa..50b1effd27f 100644 --- a/crates/hyperswitch_domain_models/src/merchant_account.rs +++ b/crates/hyperswitch_domain_models/src/merchant_account.rs @@ -45,7 +45,7 @@ pub struct MerchantAccount { pub payout_routing_algorithm: Option<serde_json::Value>, pub organization_id: common_utils::id_type::OrganizationId, pub is_recon_enabled: bool, - pub default_profile: Option<String>, + pub default_profile: Option<common_utils::id_type::ProfileId>, pub recon_status: diesel_models::enums::ReconStatus, pub payment_link_config: Option<serde_json::Value>, pub pm_collect_link_config: Option<serde_json::Value>, @@ -82,7 +82,7 @@ pub struct MerchantAccountSetter { pub payout_routing_algorithm: Option<serde_json::Value>, pub organization_id: common_utils::id_type::OrganizationId, pub is_recon_enabled: bool, - pub default_profile: Option<String>, + pub default_profile: Option<common_utils::id_type::ProfileId>, pub recon_status: diesel_models::enums::ReconStatus, pub payment_link_config: Option<serde_json::Value>, pub pm_collect_link_config: Option<serde_json::Value>, @@ -231,7 +231,7 @@ pub enum MerchantAccountUpdate { intent_fulfillment_time: Option<i64>, frm_routing_algorithm: Option<serde_json::Value>, payout_routing_algorithm: Option<serde_json::Value>, - default_profile: Option<Option<String>>, + default_profile: Option<Option<common_utils::id_type::ProfileId>>, payment_link_config: Option<serde_json::Value>, pm_collect_link_config: Option<serde_json::Value>, }, diff --git a/crates/hyperswitch_domain_models/src/merchant_connector_account.rs b/crates/hyperswitch_domain_models/src/merchant_connector_account.rs index 9e2f6918b43..76b7cd4a85a 100644 --- a/crates/hyperswitch_domain_models/src/merchant_connector_account.rs +++ b/crates/hyperswitch_domain_models/src/merchant_connector_account.rs @@ -36,7 +36,7 @@ pub struct MerchantConnectorAccount { pub created_at: time::PrimitiveDateTime, pub modified_at: time::PrimitiveDateTime, pub connector_webhook_details: Option<pii::SecretSerdeValue>, - pub profile_id: String, + pub profile_id: common_utils::id_type::ProfileId, pub applepay_verified_domains: Option<Vec<String>>, pub pm_auth_config: Option<pii::SecretSerdeValue>, pub status: enums::ConnectorStatus, @@ -71,7 +71,7 @@ pub struct MerchantConnectorAccount { pub created_at: time::PrimitiveDateTime, pub modified_at: time::PrimitiveDateTime, pub connector_webhook_details: Option<pii::SecretSerdeValue>, - pub profile_id: String, + pub profile_id: common_utils::id_type::ProfileId, pub applepay_verified_domains: Option<Vec<String>>, pub pm_auth_config: Option<pii::SecretSerdeValue>, pub status: enums::ConnectorStatus, diff --git a/crates/hyperswitch_domain_models/src/payments.rs b/crates/hyperswitch_domain_models/src/payments.rs index 3f7cfde2f78..11a2c3c3164 100644 --- a/crates/hyperswitch_domain_models/src/payments.rs +++ b/crates/hyperswitch_domain_models/src/payments.rs @@ -44,7 +44,7 @@ pub struct PaymentIntent { pub connector_metadata: Option<serde_json::Value>, pub feature_metadata: Option<serde_json::Value>, pub attempt_count: i16, - pub profile_id: Option<String>, + pub profile_id: Option<id_type::ProfileId>, pub payment_link_id: Option<String>, // Denotes the action(approve or reject) taken by merchant in case of manual review. // Manual review can occur when the transaction is marked as risky by the frm_processor, payment processor or when there is underpayment/over payment incase of crypto payment diff --git a/crates/hyperswitch_domain_models/src/payments/payment_intent.rs b/crates/hyperswitch_domain_models/src/payments/payment_intent.rs index c129e83d556..4c59a90ba15 100644 --- a/crates/hyperswitch_domain_models/src/payments/payment_intent.rs +++ b/crates/hyperswitch_domain_models/src/payments/payment_intent.rs @@ -133,7 +133,7 @@ pub struct PaymentIntentNew { pub connector_metadata: Option<serde_json::Value>, pub feature_metadata: Option<serde_json::Value>, pub attempt_count: i16, - pub profile_id: Option<String>, + pub profile_id: Option<id_type::ProfileId>, pub merchant_decision: Option<String>, pub payment_link_id: Option<String>, pub payment_confirm_source: Option<storage_enums::PaymentSource>, @@ -746,7 +746,7 @@ pub struct PaymentIntentListParams { pub payment_method_type: Option<Vec<storage_enums::PaymentMethodType>>, pub authentication_type: Option<Vec<storage_enums::AuthenticationType>>, pub merchant_connector_id: Option<Vec<String>>, - pub profile_id: Option<String>, + pub profile_id: Option<id_type::ProfileId>, pub customer_id: Option<id_type::CustomerId>, pub starting_after_id: Option<String>, pub ending_before_id: Option<String>, diff --git a/crates/hyperswitch_domain_models/src/payouts.rs b/crates/hyperswitch_domain_models/src/payouts.rs index bb636d2dc48..952028fab30 100644 --- a/crates/hyperswitch_domain_models/src/payouts.rs +++ b/crates/hyperswitch_domain_models/src/payouts.rs @@ -19,7 +19,7 @@ pub struct PayoutListParams { pub currency: Option<Vec<storage_enums::Currency>>, pub status: Option<Vec<storage_enums::PayoutStatus>>, pub payout_method: Option<Vec<common_enums::PayoutType>>, - pub profile_id: Option<String>, + pub profile_id: Option<id_type::ProfileId>, pub customer_id: Option<id_type::CustomerId>, pub starting_after_id: Option<String>, pub ending_before_id: Option<String>, diff --git a/crates/hyperswitch_domain_models/src/payouts/payout_attempt.rs b/crates/hyperswitch_domain_models/src/payouts/payout_attempt.rs index a1f08610f9c..8182ed35bab 100644 --- a/crates/hyperswitch_domain_models/src/payouts/payout_attempt.rs +++ b/crates/hyperswitch_domain_models/src/payouts/payout_attempt.rs @@ -75,7 +75,7 @@ pub struct PayoutAttempt { pub created_at: PrimitiveDateTime, #[serde(with = "common_utils::custom_serde::iso8601")] pub last_modified_at: PrimitiveDateTime, - pub profile_id: String, + pub profile_id: id_type::ProfileId, pub merchant_connector_id: Option<String>, pub routing_info: Option<serde_json::Value>, } @@ -96,41 +96,13 @@ pub struct PayoutAttemptNew { pub error_code: Option<String>, pub business_country: Option<storage_enums::CountryAlpha2>, pub business_label: Option<String>, - pub created_at: Option<PrimitiveDateTime>, - pub last_modified_at: Option<PrimitiveDateTime>, - pub profile_id: String, + pub created_at: PrimitiveDateTime, + pub last_modified_at: PrimitiveDateTime, + pub profile_id: id_type::ProfileId, pub merchant_connector_id: Option<String>, pub routing_info: Option<serde_json::Value>, } -impl Default for PayoutAttemptNew { - fn default() -> Self { - let now = common_utils::date_time::now(); - - Self { - payout_attempt_id: String::default(), - payout_id: String::default(), - customer_id: None, - merchant_id: id_type::MerchantId::default(), - address_id: None, - connector: None, - connector_payout_id: None, - payout_token: None, - status: storage_enums::PayoutStatus::default(), - is_eligible: None, - error_message: None, - error_code: None, - business_country: None, - business_label: None, - created_at: Some(now), - last_modified_at: Some(now), - profile_id: String::default(), - merchant_connector_id: None, - routing_info: None, - } - } -} - #[derive(Debug, Clone)] pub enum PayoutAttemptUpdate { StatusUpdate { diff --git a/crates/hyperswitch_domain_models/src/payouts/payouts.rs b/crates/hyperswitch_domain_models/src/payouts/payouts.rs index 834b6bb3f76..e514dbfb4c3 100644 --- a/crates/hyperswitch_domain_models/src/payouts/payouts.rs +++ b/crates/hyperswitch_domain_models/src/payouts/payouts.rs @@ -106,7 +106,7 @@ pub struct Payouts { pub created_at: PrimitiveDateTime, pub last_modified_at: PrimitiveDateTime, pub attempt_count: i16, - pub profile_id: String, + pub profile_id: id_type::ProfileId, pub status: storage_enums::PayoutStatus, pub confirm: Option<bool>, pub payout_link_id: Option<String>, @@ -131,10 +131,10 @@ pub struct PayoutsNew { pub return_url: Option<String>, pub entity_type: storage_enums::PayoutEntityType, pub metadata: Option<pii::SecretSerdeValue>, - pub created_at: Option<PrimitiveDateTime>, - pub last_modified_at: Option<PrimitiveDateTime>, + pub created_at: PrimitiveDateTime, + pub last_modified_at: PrimitiveDateTime, pub attempt_count: i16, - pub profile_id: String, + pub profile_id: id_type::ProfileId, pub status: storage_enums::PayoutStatus, pub confirm: Option<bool>, pub payout_link_id: Option<String>, @@ -142,39 +142,6 @@ pub struct PayoutsNew { pub priority: Option<storage_enums::PayoutSendPriority>, } -impl Default for PayoutsNew { - fn default() -> Self { - let now = common_utils::date_time::now(); - - Self { - payout_id: String::default(), - merchant_id: id_type::MerchantId::default(), - customer_id: None, - address_id: None, - payout_type: None, - payout_method_id: None, - amount: MinorUnit::new(i64::default()), - destination_currency: storage_enums::Currency::default(), - source_currency: storage_enums::Currency::default(), - description: None, - recurring: bool::default(), - auto_fulfill: bool::default(), - return_url: None, - entity_type: storage_enums::PayoutEntityType::default(), - metadata: None, - created_at: Some(now), - last_modified_at: Some(now), - attempt_count: 1, - profile_id: String::default(), - status: storage_enums::PayoutStatus::default(), - confirm: None, - payout_link_id: None, - client_secret: None, - priority: None, - } - } -} - #[derive(Debug, Serialize, Deserialize)] pub enum PayoutsUpdate { Update { @@ -187,7 +154,7 @@ pub enum PayoutsUpdate { return_url: Option<String>, entity_type: storage_enums::PayoutEntityType, metadata: Option<pii::SecretSerdeValue>, - profile_id: Option<String>, + profile_id: Option<id_type::ProfileId>, status: Option<storage_enums::PayoutStatus>, confirm: Option<bool>, payout_type: Option<storage_enums::PayoutType>, @@ -220,7 +187,7 @@ pub struct PayoutsUpdateInternal { pub entity_type: Option<storage_enums::PayoutEntityType>, pub metadata: Option<pii::SecretSerdeValue>, pub payout_method_id: Option<String>, - pub profile_id: Option<String>, + pub profile_id: Option<id_type::ProfileId>, pub status: Option<storage_enums::PayoutStatus>, pub attempt_count: Option<i16>, pub confirm: Option<bool>, diff --git a/crates/kgraph_utils/benches/evaluation.rs b/crates/kgraph_utils/benches/evaluation.rs index ab2e8c80ca4..5a078de1d79 100644 --- a/crates/kgraph_utils/benches/evaluation.rs +++ b/crates/kgraph_utils/benches/evaluation.rs @@ -52,6 +52,8 @@ fn build_test_data( }); } + let profile_id = common_utils::generate_profile_id_of_default_length(); + #[cfg(all(feature = "v2", feature = "merchant_connector_account_v2"))] let stripe_account = MerchantConnectorResponse { connector_type: api_enums::ConnectorType::FizOperations, @@ -64,7 +66,7 @@ fn build_test_data( connector_label: Some("something".to_string()), frm_configs: None, connector_webhook_details: None, - profile_id: "profile_id".to_string(), + profile_id, applepay_verified_domains: None, pm_auth_config: None, status: api_enums::ConnectorStatus::Inactive, @@ -90,7 +92,7 @@ fn build_test_data( business_sub_label: Some("something".to_string()), frm_configs: None, connector_webhook_details: None, - profile_id: "profile_id".to_string(), + profile_id, applepay_verified_domains: None, pm_auth_config: None, status: api_enums::ConnectorStatus::Inactive, diff --git a/crates/kgraph_utils/src/mca.rs b/crates/kgraph_utils/src/mca.rs index d4e04669714..1e099589b00 100644 --- a/crates/kgraph_utils/src/mca.rs +++ b/crates/kgraph_utils/src/mca.rs @@ -704,6 +704,8 @@ mod tests { fn build_test_data() -> ConstraintGraph<dir::DirValue> { use api_models::{admin::*, payment_methods::*}; + let profile_id = common_utils::generate_profile_id_of_default_length(); + #[cfg(all(feature = "v2", feature = "merchant_connector_account_v2"))] let stripe_account = MerchantConnectorResponse { connector_type: api_enums::ConnectorType::FizOperations, @@ -752,7 +754,7 @@ mod tests { }]), frm_configs: None, connector_webhook_details: None, - profile_id: "profile_id".to_string(), + profile_id, applepay_verified_domains: None, pm_auth_config: None, status: api_enums::ConnectorStatus::Inactive, @@ -813,7 +815,7 @@ mod tests { }]), frm_configs: None, connector_webhook_details: None, - profile_id: "profile_id".to_string(), + profile_id, applepay_verified_domains: None, pm_auth_config: None, status: api_enums::ConnectorStatus::Inactive, diff --git a/crates/router/src/core/admin.rs b/crates/router/src/core/admin.rs index e90924a593a..f78d5dca2e0 100644 --- a/crates/router/src/core/admin.rs +++ b/crates/router/src/core/admin.rs @@ -721,7 +721,7 @@ pub async fn list_merchant_account( pub async fn get_merchant_account( state: SessionState, req: api::MerchantId, - _profile_id: Option<String>, + _profile_id: Option<id_type::ProfileId>, ) -> RouterResponse<api::MerchantAccountResponse> { let db = state.store.as_ref(); let key_manager_state = &(&state).into(); @@ -842,8 +842,6 @@ impl MerchantAccountUpdateBridge for api::MerchantAccountUpdate { merchant_id: &id_type::MerchantId, key_store: &domain::MerchantKeyStore, ) -> RouterResult<storage::MerchantAccountUpdate> { - use common_utils::ext_traits::ConfigExt; - let key_manager_state = &state.into(); let key = key_store.key.get_inner().peek(); @@ -885,21 +883,16 @@ impl MerchantAccountUpdateBridge for api::MerchantAccountUpdate { // This supports changing the business profile by passing in the profile_id let business_profile_id_update = if let Some(ref profile_id) = self.default_profile { - if !profile_id.is_empty_after_trim() { - // Validate whether profile_id passed in request is valid and is linked to the merchant - core_utils::validate_and_get_business_profile( - state.store.as_ref(), - key_manager_state, - key_store, - Some(profile_id), - merchant_id, - ) - .await? - .map(|business_profile| Some(business_profile.profile_id)) - } else { - // If empty, Update profile_id to None in the database - Some(None) - } + // Validate whether profile_id passed in request is valid and is linked to the merchant + core_utils::validate_and_get_business_profile( + state.store.as_ref(), + key_manager_state, + key_store, + Some(profile_id), + merchant_id, + ) + .await? + .map(|business_profile| Some(business_profile.profile_id)) } else { None }; @@ -1047,7 +1040,7 @@ impl MerchantAccountUpdateBridge for api::MerchantAccountUpdate { pub async fn merchant_account_update( state: SessionState, merchant_id: &id_type::MerchantId, - _profile_id: Option<String>, + _profile_id: Option<id_type::ProfileId>, req: api::MerchantAccountUpdate, ) -> RouterResponse<api::MerchantAccountResponse> { let db = state.store.as_ref(); @@ -1765,7 +1758,7 @@ struct PMAuthConfigValidation<'a> { pm_auth_config: &'a Option<pii::SecretSerdeValue>, db: &'a dyn StorageInterface, merchant_id: &'a id_type::MerchantId, - profile_id: &'a String, + profile_id: &'a id_type::ProfileId, key_store: &'a domain::MerchantKeyStore, key_manager_state: &'a KeyManagerState, } @@ -1877,7 +1870,7 @@ struct MerchantDefaultConfigUpdate<'a> { merchant_connector_id: &'a String, store: &'a dyn StorageInterface, merchant_id: &'a id_type::MerchantId, - profile_id: &'a String, + profile_id: &'a id_type::ProfileId, transaction_type: &'a api_enums::TransactionType, } #[cfg(all( @@ -1897,7 +1890,7 @@ impl<'a> MerchantDefaultConfigUpdate<'a> { let mut default_routing_config_for_profile = routing::helpers::get_merchant_default_config( self.store, - self.profile_id, + self.profile_id.get_string_repr(), self.transaction_type, ) .await?; @@ -1922,7 +1915,7 @@ impl<'a> MerchantDefaultConfigUpdate<'a> { default_routing_config_for_profile.push(choice); routing::helpers::update_merchant_default_config( self.store, - self.profile_id, + self.profile_id.get_string_repr(), default_routing_config_for_profile.clone(), self.transaction_type, ) @@ -1969,7 +1962,7 @@ impl<'a> DefaultFallbackRoutingConfigUpdate<'a> { profile_wrapper .update_default_fallback_routing_of_connectors_under_profile( self.store, - &default_routing_config_for_profile, + default_routing_config_for_profile, self.key_manager_state, &self.key_store, ) @@ -2438,7 +2431,9 @@ impl MerchantConnectorAccountCreateBridge for api::MerchantConnectorCreate { ) .await? .get_required_value("BusinessProfile") - .change_context(errors::ApiErrorResponse::BusinessProfileNotFound { id: profile_id })?; + .change_context(errors::ApiErrorResponse::BusinessProfileNotFound { + id: profile_id.get_string_repr().to_owned(), + })?; Ok(business_profile) } @@ -2614,7 +2609,9 @@ impl MerchantConnectorAccountCreateBridge for api::MerchantConnectorCreate { .await? .get_required_value("BusinessProfile") .change_context( - errors::ApiErrorResponse::BusinessProfileNotFound { id: profile_id }, + errors::ApiErrorResponse::BusinessProfileNotFound { + id: profile_id.get_string_repr().to_owned(), + }, )?; Ok(business_profile) @@ -2746,7 +2743,7 @@ pub async fn create_connector( .await .to_duplicate_response( errors::ApiErrorResponse::DuplicateMerchantConnectorAccount { - profile_id: business_profile.profile_id.clone(), + profile_id: business_profile.profile_id.get_string_repr().to_owned(), connector_label: merchant_connector_account .connector_label .unwrap_or_default(), @@ -2809,7 +2806,7 @@ async fn validate_pm_auth( merchant_id: &id_type::MerchantId, key_store: &domain::MerchantKeyStore, merchant_account: domain::MerchantAccount, - profile_id: &String, + profile_id: &id_type::ProfileId, ) -> RouterResponse<()> { let config = serde_json::from_value::<api_models::pm_auth::PaymentMethodAuthConfig>(val.expose()) @@ -2858,7 +2855,7 @@ async fn validate_pm_auth( pub async fn retrieve_connector( state: SessionState, merchant_id: id_type::MerchantId, - profile_id: Option<String>, + profile_id: Option<id_type::ProfileId>, merchant_connector_id: String, ) -> RouterResponse<api_models::admin::MerchantConnectorResponse> { let store = state.store.as_ref(); @@ -2939,7 +2936,7 @@ pub async fn retrieve_connector( pub async fn list_payment_connectors( state: SessionState, merchant_id: id_type::MerchantId, - profile_id_list: Option<Vec<String>>, + profile_id_list: Option<Vec<id_type::ProfileId>>, ) -> RouterResponse<Vec<api_models::admin::MerchantConnectorListResponse>> { let store = state.store.as_ref(); let key_manager_state = &(&state).into(); @@ -2984,7 +2981,7 @@ pub async fn list_payment_connectors( pub async fn update_connector( state: SessionState, merchant_id: &id_type::MerchantId, - profile_id: Option<String>, + profile_id: Option<id_type::ProfileId>, merchant_connector_id: &str, req: api_models::admin::MerchantConnectorUpdate, ) -> RouterResponse<api_models::admin::MerchantConnectorResponse> { @@ -3042,7 +3039,7 @@ pub async fn update_connector( .await .change_context( errors::ApiErrorResponse::DuplicateMerchantConnectorAccount { - profile_id, + profile_id: profile_id.get_string_repr().to_owned(), connector_label: request_connector_label.unwrap_or_default(), }, ) @@ -3409,7 +3406,7 @@ impl BusinessProfileCreateBridge for api::BusinessProfileCreate { } // Generate a unique profile id - let profile_id = common_utils::generate_id_with_default_len("pro"); + let profile_id = common_utils::generate_profile_id_of_default_length(); let profile_name = self.profile_name.unwrap_or("default".to_string()); let current_time = date_time::now(); @@ -3523,7 +3520,7 @@ impl BusinessProfileCreateBridge for api::BusinessProfileCreate { // Generate a unique profile id // TODO: the profile_id should be generated from the profile_name - let profile_id = common_utils::generate_id_with_default_len("pro"); + let profile_id = common_utils::generate_profile_id_of_default_length(); let profile_name = self.profile_name; let current_time = date_time::now(); @@ -3656,7 +3653,10 @@ pub async fn create_business_profile( .insert_business_profile(key_manager_state, &key_store, business_profile) .await .to_duplicate_response(errors::ApiErrorResponse::GenericDuplicateError { - message: format!("Business Profile with the profile_id {profile_id} already exists"), + message: format!( + "Business Profile with the profile_id {} already exists", + profile_id.get_string_repr() + ), }) .attach_printable("Failed to insert Business profile because of duplication error")?; @@ -3715,7 +3715,7 @@ pub async fn list_business_profile( pub async fn retrieve_business_profile( state: SessionState, - profile_id: String, + profile_id: id_type::ProfileId, merchant_id: id_type::MerchantId, ) -> RouterResponse<api_models::admin::BusinessProfileResponse> { let db = state.store.as_ref(); @@ -3731,7 +3731,7 @@ pub async fn retrieve_business_profile( .find_business_profile_by_profile_id(&(&state).into(), &key_store, &profile_id) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id, + id: profile_id.get_string_repr().to_owned(), })?; Ok(service_api::ApplicationResponse::Json( @@ -3743,7 +3743,7 @@ pub async fn retrieve_business_profile( pub async fn delete_business_profile( state: SessionState, - profile_id: String, + profile_id: id_type::ProfileId, merchant_id: &id_type::MerchantId, ) -> RouterResponse<bool> { let db = state.store.as_ref(); @@ -3751,7 +3751,7 @@ pub async fn delete_business_profile( .delete_business_profile_by_profile_id_merchant_id(&profile_id, merchant_id) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id, + id: profile_id.get_string_repr().to_owned(), })?; Ok(service_api::ApplicationResponse::Json(delete_result)) @@ -3977,7 +3977,7 @@ impl BusinessProfileUpdateBridge for api::BusinessProfileUpdate { #[cfg(feature = "olap")] pub async fn update_business_profile( state: SessionState, - profile_id: &str, + profile_id: &id_type::ProfileId, merchant_id: &id_type::MerchantId, request: api::BusinessProfileUpdate, ) -> RouterResponse<api::BusinessProfileResponse> { @@ -3997,12 +3997,12 @@ pub async fn update_business_profile( .find_business_profile_by_profile_id(key_manager_state, &key_store, profile_id) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_owned(), + id: profile_id.get_string_repr().to_owned(), })?; if business_profile.merchant_id != *merchant_id { Err(errors::ApiErrorResponse::AccessForbidden { - resource: profile_id.to_string(), + resource: profile_id.get_string_repr().to_owned(), })? } @@ -4019,7 +4019,7 @@ pub async fn update_business_profile( ) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_owned(), + id: profile_id.get_string_repr().to_owned(), })?; Ok(service_api::ApplicationResponse::Json( @@ -4055,8 +4055,9 @@ impl BusinessProfileWrapper { storage_impl::redis::cache::CacheKind::Routing( format!( - "routing_config_{}_{profile_id}", - merchant_id.get_string_repr() + "routing_config_{}_{}", + merchant_id.get_string_repr(), + profile_id.get_string_repr() ) .into(), ) @@ -4177,7 +4178,7 @@ impl BusinessProfileWrapper { pub async fn extended_card_info_toggle( state: SessionState, merchant_id: &id_type::MerchantId, - profile_id: &str, + profile_id: &id_type::ProfileId, ext_card_info_choice: admin_types::ExtendedCardInfoChoice, ) -> RouterResponse<admin_types::ExtendedCardInfoChoice> { let db = state.store.as_ref(); @@ -4197,7 +4198,7 @@ pub async fn extended_card_info_toggle( .find_business_profile_by_profile_id(key_manager_state, &key_store, profile_id) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_string(), + id: profile_id.get_string_repr().to_owned(), })?; if business_profile.is_extended_card_info_enabled.is_none() @@ -4217,7 +4218,7 @@ pub async fn extended_card_info_toggle( ) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_owned(), + id: profile_id.get_string_repr().to_owned(), })?; } @@ -4227,7 +4228,7 @@ pub async fn extended_card_info_toggle( pub async fn connector_agnostic_mit_toggle( state: SessionState, merchant_id: &id_type::MerchantId, - profile_id: &str, + profile_id: &id_type::ProfileId, connector_agnostic_mit_choice: admin_types::ConnectorAgnosticMitChoice, ) -> RouterResponse<admin_types::ConnectorAgnosticMitChoice> { let db = state.store.as_ref(); @@ -4247,12 +4248,12 @@ pub async fn connector_agnostic_mit_toggle( .find_business_profile_by_profile_id(key_manager_state, &key_store, profile_id) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_string(), + id: profile_id.get_string_repr().to_owned(), })?; if business_profile.merchant_id != *merchant_id { Err(errors::ApiErrorResponse::AccessForbidden { - resource: profile_id.to_string(), + resource: profile_id.get_string_repr().to_owned(), })? } @@ -4271,7 +4272,7 @@ pub async fn connector_agnostic_mit_toggle( ) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_owned(), + id: profile_id.get_string_repr().to_owned(), })?; } diff --git a/crates/router/src/core/authentication/utils.rs b/crates/router/src/core/authentication/utils.rs index 87235582c09..58862d18906 100644 --- a/crates/router/src/core/authentication/utils.rs +++ b/crates/router/src/core/authentication/utils.rs @@ -178,7 +178,7 @@ pub async fn create_new_authentication( merchant_id: common_utils::id_type::MerchantId, authentication_connector: String, token: String, - profile_id: String, + profile_id: common_utils::id_type::ProfileId, payment_id: Option<String>, merchant_connector_id: String, ) -> RouterResult<storage::Authentication> { @@ -285,7 +285,7 @@ pub async fn get_authentication_connector_data( .ok_or(errors::ApiErrorResponse::UnprocessableEntity { message: format!( "No authentication_connector found for profile_id {}", - business_profile.profile_id + business_profile.profile_id.get_string_repr() ), }) .attach_printable( diff --git a/crates/router/src/core/customers.rs b/crates/router/src/core/customers.rs index 4e45e48cfaa..9d77626ac51 100644 --- a/crates/router/src/core/customers.rs +++ b/crates/router/src/core/customers.rs @@ -433,7 +433,7 @@ impl<'a> MerchantReferenceIdForCustomer<'a> { pub async fn retrieve_customer( state: SessionState, merchant_account: domain::MerchantAccount, - _profile_id: Option<String>, + _profile_id: Option<id_type::ProfileId>, key_store: domain::MerchantKeyStore, req: customers::CustomerId, ) -> errors::CustomerResponse<customers::CustomerResponse> { @@ -495,7 +495,7 @@ pub async fn retrieve_customer( pub async fn list_customers( state: SessionState, merchant_id: id_type::MerchantId, - _profile_id_list: Option<Vec<String>>, + _profile_id_list: Option<Vec<id_type::ProfileId>>, key_store: domain::MerchantKeyStore, ) -> errors::CustomerResponse<Vec<customers::CustomerResponse>> { let db = state.store.as_ref(); diff --git a/crates/router/src/core/disputes.rs b/crates/router/src/core/disputes.rs index 73215959305..24c6c0f8be8 100644 --- a/crates/router/src/core/disputes.rs +++ b/crates/router/src/core/disputes.rs @@ -26,7 +26,7 @@ use crate::{ pub async fn retrieve_dispute( state: SessionState, merchant_account: domain::MerchantAccount, - profile_id: Option<String>, + profile_id: Option<common_utils::id_type::ProfileId>, req: disputes::DisputeId, ) -> RouterResponse<api_models::disputes::DisputeResponse> { let dispute = state @@ -45,7 +45,7 @@ pub async fn retrieve_dispute( pub async fn retrieve_disputes_list( state: SessionState, merchant_account: domain::MerchantAccount, - _profile_id_list: Option<Vec<String>>, + _profile_id_list: Option<Vec<common_utils::id_type::ProfileId>>, constraints: api_models::disputes::DisputeListConstraints, ) -> RouterResponse<Vec<api_models::disputes::DisputeResponse>> { let disputes = state @@ -65,7 +65,7 @@ pub async fn retrieve_disputes_list( pub async fn accept_dispute( state: SessionState, merchant_account: domain::MerchantAccount, - profile_id: Option<String>, + profile_id: Option<common_utils::id_type::ProfileId>, key_store: domain::MerchantKeyStore, req: disputes::DisputeId, ) -> RouterResponse<dispute_models::DisputeResponse> { @@ -169,7 +169,7 @@ pub async fn accept_dispute( pub async fn submit_evidence( state: SessionState, merchant_account: domain::MerchantAccount, - profile_id: Option<String>, + profile_id: Option<common_utils::id_type::ProfileId>, key_store: domain::MerchantKeyStore, req: dispute_models::SubmitEvidenceRequest, ) -> RouterResponse<dispute_models::DisputeResponse> { @@ -336,7 +336,7 @@ pub async fn submit_evidence( pub async fn attach_evidence( state: SessionState, merchant_account: domain::MerchantAccount, - profile_id: Option<String>, + profile_id: Option<common_utils::id_type::ProfileId>, key_store: domain::MerchantKeyStore, attach_evidence_request: api::AttachEvidenceRequest, ) -> RouterResponse<files_api_models::CreateFileResponse> { @@ -415,7 +415,7 @@ pub async fn attach_evidence( pub async fn retrieve_dispute_evidence( state: SessionState, merchant_account: domain::MerchantAccount, - profile_id: Option<String>, + profile_id: Option<common_utils::id_type::ProfileId>, req: disputes::DisputeId, ) -> RouterResponse<Vec<api_models::disputes::DisputeEvidenceBlock>> { let dispute = state diff --git a/crates/router/src/core/files/helpers.rs b/crates/router/src/core/files/helpers.rs index b479d131564..14e404e88a0 100644 --- a/crates/router/src/core/files/helpers.rs +++ b/crates/router/src/core/files/helpers.rs @@ -245,7 +245,7 @@ pub async fn upload_and_get_provider_provider_file_id_profile_id( ( String, api_models::enums::FileUploadProvider, - Option<String>, + Option<common_utils::id_type::ProfileId>, Option<String>, ), errors::ApiErrorResponse, diff --git a/crates/router/src/core/fraud_check.rs b/crates/router/src/core/fraud_check.rs index a5d78377a8f..d185e3545b4 100644 --- a/crates/router/src/core/fraud_check.rs +++ b/crates/router/src/core/fraud_check.rs @@ -128,7 +128,7 @@ pub async fn should_call_frm<F: Send + Clone>( ) -> RouterResult<( bool, Option<FrmRoutingAlgorithm>, - Option<String>, + Option<common_utils::id_type::ProfileId>, Option<FrmConfigsObject>, )> { // Frm routing algorithm is not present in the merchant account @@ -145,7 +145,7 @@ pub async fn should_call_frm<F: Send + Clone>( ) -> RouterResult<( bool, Option<FrmRoutingAlgorithm>, - Option<String>, + Option<common_utils::id_type::ProfileId>, Option<FrmConfigsObject>, )> { use common_utils::ext_traits::OptionExt; @@ -327,7 +327,7 @@ pub async fn should_call_frm<F: Send + Clone>( Ok(( is_frm_enabled, Some(frm_routing_algorithm_struct), - Some(profile_id.to_string()), + Some(profile_id), Some(frm_configs_object), )) } @@ -354,7 +354,7 @@ pub async fn make_frm_data_and_fraud_check_operation<'a, F>( merchant_account: &domain::MerchantAccount, payment_data: payments::PaymentData<F>, frm_routing_algorithm: FrmRoutingAlgorithm, - profile_id: String, + profile_id: common_utils::id_type::ProfileId, frm_configs: FrmConfigsObject, _customer: &Option<domain::Customer>, ) -> RouterResult<FrmInfo<F>> diff --git a/crates/router/src/core/fraud_check/types.rs b/crates/router/src/core/fraud_check/types.rs index d35e3227e6d..7f9d21216bc 100644 --- a/crates/router/src/core/fraud_check/types.rs +++ b/crates/router/src/core/fraud_check/types.rs @@ -69,7 +69,7 @@ pub struct FrmInfo<F> { #[derive(Clone, Debug)] pub struct ConnectorDetailsCore { pub connector_name: String, - pub profile_id: String, + pub profile_id: common_utils::id_type::ProfileId, } #[derive(Clone)] pub struct PaymentToFrmData { diff --git a/crates/router/src/core/mandate/helpers.rs b/crates/router/src/core/mandate/helpers.rs index 9899d85fc73..e5fa762aeb0 100644 --- a/crates/router/src/core/mandate/helpers.rs +++ b/crates/router/src/core/mandate/helpers.rs @@ -16,7 +16,7 @@ pub async fn get_profile_id_for_mandate( merchant_account: &domain::MerchantAccount, key_store: &domain::MerchantKeyStore, mandate: Mandate, -) -> CustomResult<String, errors::ApiErrorResponse> { +) -> CustomResult<common_utils::id_type::ProfileId, errors::ApiErrorResponse> { let profile_id = if let Some(ref payment_id) = mandate.original_payment_id { let pi = state .store @@ -35,6 +35,7 @@ pub async fn get_profile_id_for_mandate( .ok_or(errors::ApiErrorResponse::BusinessProfileNotFound { id: pi .profile_id + .map(|profile_id| profile_id.get_string_repr().to_owned()) .unwrap_or_else(|| "Profile id is Null".to_string()), })?; Ok(profile_id) diff --git a/crates/router/src/core/payment_link.rs b/crates/router/src/core/payment_link.rs index e7f21ae0fdb..bb39bede2d6 100644 --- a/crates/router/src/core/payment_link.rs +++ b/crates/router/src/core/payment_link.rs @@ -129,7 +129,7 @@ pub async fn form_payment_link_data( .find_business_profile_by_profile_id(key_manager_state, &key_store, &profile_id) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_string(), + id: profile_id.get_string_repr().to_owned(), })?; let return_url = if let Some(payment_create_return_url) = payment_intent.return_url.clone() { @@ -754,7 +754,7 @@ pub async fn get_payment_link_status( .find_business_profile_by_profile_id(key_manager_state, &key_store, &profile_id) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_string(), + id: profile_id.get_string_repr().to_owned(), })?; let return_url = if let Some(payment_create_return_url) = payment_intent.return_url.clone() { diff --git a/crates/router/src/core/payment_methods/cards.rs b/crates/router/src/core/payment_methods/cards.rs index 274ef3c0966..586e93a0fe6 100644 --- a/crates/router/src/core/payment_methods/cards.rs +++ b/crates/router/src/core/payment_methods/cards.rs @@ -2734,7 +2734,7 @@ pub async fn list_payment_methods( format!( "pm_filters_cgraph_{}_{}", merchant_account.get_id().get_string_repr(), - profile_id + profile_id.get_string_repr() ) }; @@ -4909,7 +4909,7 @@ async fn generate_saved_pm_response( pub async fn get_mca_status( state: &routes::SessionState, key_store: &domain::MerchantKeyStore, - profile_id: Option<String>, + profile_id: Option<id_type::ProfileId>, merchant_id: &id_type::MerchantId, is_connector_agnostic_mit_enabled: bool, connector_mandate_details: Option<storage::PaymentsMandateReference>, @@ -5789,7 +5789,7 @@ where pub async fn list_countries_currencies_for_connector_payment_method( state: routes::SessionState, req: ListCountriesCurrenciesRequest, - _profile_id: Option<String>, + _profile_id: Option<id_type::ProfileId>, ) -> errors::RouterResponse<ListCountriesCurrenciesResponse> { Ok(services::ApplicationResponse::Json( list_countries_currencies_for_connector_payment_method_util( diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs index 6938d3c407b..72a188a47ec 100644 --- a/crates/router/src/core/payments.rs +++ b/crates/router/src/core/payments.rs @@ -106,7 +106,7 @@ pub async fn payments_operation_core<F, Req, Op, FData>( state: &SessionState, req_state: ReqState, merchant_account: domain::MerchantAccount, - profile_id_from_auth_layer: Option<String>, + profile_id_from_auth_layer: Option<id_type::ProfileId>, key_store: domain::MerchantKeyStore, operation: Op, req: Req, @@ -828,7 +828,7 @@ pub async fn payments_core<F, Res, Req, Op, FData>( state: SessionState, req_state: ReqState, merchant_account: domain::MerchantAccount, - profile_id: Option<String>, + profile_id: Option<id_type::ProfileId>, key_store: domain::MerchantKeyStore, operation: Op, req: Req, @@ -1067,7 +1067,7 @@ impl PaymentRedirectFlow for PaymentRedirectCompleteAuthorize { .find_business_profile_by_profile_id(key_manager_state, &merchant_key_store, profile_id) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_string(), + id: profile_id.get_string_repr().to_owned(), })?; Ok(router_types::RedirectPaymentFlowResponse { payments_response, @@ -1201,7 +1201,7 @@ impl PaymentRedirectFlow for PaymentRedirectSync { .find_business_profile_by_profile_id(key_manager_state, &merchant_key_store, profile_id) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_string(), + id: profile_id.get_string_repr().to_owned(), })?; Ok(router_types::RedirectPaymentFlowResponse { payments_response, @@ -1432,7 +1432,7 @@ impl PaymentRedirectFlow for PaymentAuthenticateCompleteAuthorize { .find_business_profile_by_profile_id(key_manager_state, &merchant_key_store, profile_id) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_string(), + id: profile_id.get_string_repr().to_owned(), })?; Ok(router_types::AuthenticatePaymentFlowResponse { payments_response, @@ -2019,10 +2019,9 @@ where .as_ref() .get_required_value("profile_id") .change_context(errors::ApiErrorResponse::InternalServerError) - .attach_printable("profile_id is not set in payment_intent")? - .clone(); + .attach_printable("profile_id is not set in payment_intent")?; - format!("{connector_name}_{profile_id}") + format!("{connector_name}_{}", profile_id.get_string_repr()) }; let (should_call_connector, existing_connector_customer_id) = @@ -2912,7 +2911,7 @@ pub fn is_operation_complete_authorize<Op: Debug>(operation: &Op) -> bool { pub async fn list_payments( state: SessionState, merchant: domain::MerchantAccount, - profile_id_list: Option<Vec<String>>, + profile_id_list: Option<Vec<id_type::ProfileId>>, key_store: domain::MerchantKeyStore, constraints: api::PaymentListConstraints, ) -> RouterResponse<api::PaymentListResponse> { @@ -2987,7 +2986,7 @@ pub async fn list_payments( pub async fn apply_filters_on_payments( state: SessionState, merchant: domain::MerchantAccount, - profile_id_list: Option<Vec<String>>, + profile_id_list: Option<Vec<id_type::ProfileId>>, merchant_key_store: domain::MerchantKeyStore, constraints: api::PaymentListFilterConstraints, ) -> RouterResponse<api::PaymentListResponseV2> { @@ -3085,7 +3084,7 @@ pub async fn get_filters_for_payments( pub async fn get_payment_filters( state: SessionState, merchant: domain::MerchantAccount, - profile_id_list: Option<Vec<String>>, + profile_id_list: Option<Vec<id_type::ProfileId>>, ) -> RouterResponse<api::PaymentListFiltersV2> { let merchant_connector_accounts = if let services::ApplicationResponse::Json(data) = super::admin::list_payment_connectors(state, merchant.get_id().to_owned(), profile_id_list) @@ -4329,7 +4328,7 @@ pub async fn payment_external_authentication( .find_business_profile_by_profile_id(key_manager_state, &key_store, profile_id) .await .change_context(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_string(), + id: profile_id.get_string_repr().to_owned(), })?; let authentication_details = business_profile diff --git a/crates/router/src/core/payments/helpers.rs b/crates/router/src/core/payments/helpers.rs index a1b65fa2682..417e655d3b1 100644 --- a/crates/router/src/core/payments/helpers.rs +++ b/crates/router/src/core/payments/helpers.rs @@ -130,7 +130,7 @@ pub fn create_certificate( pub fn filter_mca_based_on_profile_and_connector_type( merchant_connector_accounts: Vec<domain::MerchantConnectorAccount>, - profile_id: &String, + profile_id: &id_type::ProfileId, connector_type: ConnectorType, ) -> Vec<domain::MerchantConnectorAccount> { merchant_connector_accounts @@ -3266,7 +3266,7 @@ pub async fn get_merchant_connector_account( merchant_id: &id_type::MerchantId, creds_identifier: Option<String>, key_store: &domain::MerchantKeyStore, - profile_id: &String, + profile_id: &id_type::ProfileId, connector_name: &str, merchant_connector_id: Option<&String>, ) -> RouterResult<MerchantConnectorAccountType> { @@ -3391,7 +3391,8 @@ pub async fn get_merchant_connector_account( .to_not_found_response( errors::ApiErrorResponse::MerchantConnectorAccountNotFound { id: format!( - "profile id {profile_id} and connector name {connector_name}" + "profile id {} and connector name {connector_name}", + profile_id.get_string_repr() ), }, ) @@ -3832,7 +3833,7 @@ mod test { pub async fn get_additional_payment_data( pm_data: &domain::PaymentMethodData, db: &dyn StorageInterface, - profile_id: &str, + profile_id: &id_type::ProfileId, ) -> Option<api_models::payments::AdditionalPaymentData> { match pm_data { domain::PaymentMethodData::Card(card_data) => { @@ -3840,7 +3841,7 @@ pub async fn get_additional_payment_data( let card_isin = Some(card_data.card_number.get_card_isin()); let enable_extended_bin =db .find_config_by_key_unwrap_or( - format!("{}_enable_extended_card_bin", profile_id).as_str(), + format!("{}_enable_extended_card_bin", profile_id.get_string_repr()).as_str(), Some("false".to_string())) .await.map_err(|err| services::logger::error!(message="Failed to fetch the config", extended_card_bin_error=?err)).ok(); @@ -4282,7 +4283,7 @@ where ))] let fallback_connetors_list = crate::core::routing::helpers::get_merchant_default_config( &*state.clone().store, - profile_id, + profile_id.get_string_repr(), &api_enums::TransactionType::Payment, ) .await diff --git a/crates/router/src/core/payments/operations/payment_approve.rs b/crates/router/src/core/payments/operations/payment_approve.rs index 401e1c2c7a1..7034cfab2f7 100644 --- a/crates/router/src/core/payments/operations/payment_approve.rs +++ b/crates/router/src/core/payments/operations/payment_approve.rs @@ -81,7 +81,7 @@ impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsCaptureRequest> .find_business_profile_by_profile_id(key_manager_state, key_store, profile_id) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_string(), + id: profile_id.get_string_repr().to_owned(), })?; let attempt_id = payment_intent.active_attempt.get_id().clone(); diff --git a/crates/router/src/core/payments/operations/payment_cancel.rs b/crates/router/src/core/payments/operations/payment_cancel.rs index 84eaf97bfaa..4a26e533443 100644 --- a/crates/router/src/core/payments/operations/payment_cancel.rs +++ b/crates/router/src/core/payments/operations/payment_cancel.rs @@ -150,7 +150,7 @@ impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsCancelRequest> .find_business_profile_by_profile_id(key_manager_state, key_store, profile_id) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_string(), + id: profile_id.get_string_repr().to_owned(), })?; let payment_data = PaymentData { diff --git a/crates/router/src/core/payments/operations/payment_capture.rs b/crates/router/src/core/payments/operations/payment_capture.rs index 0d096e1d3ae..de7ee996195 100644 --- a/crates/router/src/core/payments/operations/payment_capture.rs +++ b/crates/router/src/core/payments/operations/payment_capture.rs @@ -196,7 +196,7 @@ impl<F: Send + Clone> GetTracker<F, payments::PaymentData<F>, api::PaymentsCaptu .find_business_profile_by_profile_id(key_manager_state, key_store, profile_id) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_string(), + id: profile_id.get_string_repr().to_owned(), })?; let payment_data = payments::PaymentData { diff --git a/crates/router/src/core/payments/operations/payment_complete_authorize.rs b/crates/router/src/core/payments/operations/payment_complete_authorize.rs index 8d4e6f7a5f2..c7a2686724f 100644 --- a/crates/router/src/core/payments/operations/payment_complete_authorize.rs +++ b/crates/router/src/core/payments/operations/payment_complete_authorize.rs @@ -290,7 +290,7 @@ impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsRequest> for Co .find_business_profile_by_profile_id(key_manager_state, key_store, profile_id) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_string(), + id: profile_id.get_string_repr().to_owned(), })?; let payment_data = PaymentData { diff --git a/crates/router/src/core/payments/operations/payment_confirm.rs b/crates/router/src/core/payments/operations/payment_confirm.rs index 2e7131edce2..273773a80bb 100644 --- a/crates/router/src/core/payments/operations/payment_confirm.rs +++ b/crates/router/src/core/payments/operations/payment_confirm.rs @@ -164,7 +164,7 @@ impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsRequest> for Pa .map(|business_profile_result| { business_profile_result.to_not_found_response( errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_string(), + id: profile_id.get_string_repr().to_owned(), }, ) }) @@ -476,7 +476,7 @@ impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsRequest> for Pa helpers::get_additional_payment_data( &payment_method_data.into(), store.as_ref(), - profile_id.as_ref(), + &profile_id, ) .await }) diff --git a/crates/router/src/core/payments/operations/payment_create.rs b/crates/router/src/core/payments/operations/payment_create.rs index 2b80598adfb..a455f1d4c59 100644 --- a/crates/router/src/core/payments/operations/payment_create.rs +++ b/crates/router/src/core/payments/operations/payment_create.rs @@ -140,7 +140,7 @@ impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsRequest> for Pa .await .to_not_found_response( errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_string(), + id: profile_id.get_string_repr().to_owned(), }, )? }; @@ -883,7 +883,7 @@ impl PaymentCreate { payment_method_billing_address_id: Option<String>, payment_method_info: &Option<PaymentMethod>, key_store: &domain::MerchantKeyStore, - profile_id: String, + profile_id: common_utils::id_type::ProfileId, customer_acceptance: &Option<payments::CustomerAcceptance>, ) -> RouterResult<( storage::PaymentAttemptNew, @@ -1083,7 +1083,7 @@ impl PaymentCreate { payment_link_data: Option<api_models::payments::PaymentLinkResponse>, billing_address_id: Option<String>, active_attempt_id: String, - profile_id: String, + profile_id: common_utils::id_type::ProfileId, session_expiry: PrimitiveDateTime, ) -> RouterResult<storage::PaymentIntent> { let created_at @ modified_at @ last_synced = common_utils::date_time::now(); @@ -1293,7 +1293,7 @@ async fn create_payment_link( db: &dyn StorageInterface, amount: api::Amount, description: Option<String>, - profile_id: String, + profile_id: common_utils::id_type::ProfileId, domain_name: String, session_expiry: PrimitiveDateTime, locale: Option<String>, diff --git a/crates/router/src/core/payments/operations/payment_reject.rs b/crates/router/src/core/payments/operations/payment_reject.rs index a5d0b95a672..b148d5bbccc 100644 --- a/crates/router/src/core/payments/operations/payment_reject.rs +++ b/crates/router/src/core/payments/operations/payment_reject.rs @@ -134,7 +134,7 @@ impl<F: Send + Clone> GetTracker<F, PaymentData<F>, PaymentsCancelRequest> for P .find_business_profile_by_profile_id(key_manager_state, key_store, profile_id) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_string(), + id: profile_id.get_string_repr().to_owned(), })?; let payment_data = PaymentData { diff --git a/crates/router/src/core/payments/operations/payment_session.rs b/crates/router/src/core/payments/operations/payment_session.rs index af5f234e2ce..6b101b6bd1b 100644 --- a/crates/router/src/core/payments/operations/payment_session.rs +++ b/crates/router/src/core/payments/operations/payment_session.rs @@ -159,7 +159,7 @@ impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsSessionRequest> .find_business_profile_by_profile_id(key_manager_state, key_store, profile_id) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_string(), + id: profile_id.get_string_repr().to_owned(), })?; let payment_data = PaymentData { diff --git a/crates/router/src/core/payments/operations/payment_start.rs b/crates/router/src/core/payments/operations/payment_start.rs index ae9397aa8ec..9a29b36b55a 100644 --- a/crates/router/src/core/payments/operations/payment_start.rs +++ b/crates/router/src/core/payments/operations/payment_start.rs @@ -144,7 +144,7 @@ impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsStartRequest> f .find_business_profile_by_profile_id(key_manager_state, key_store, profile_id) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_string(), + id: profile_id.get_string_repr().to_owned(), })?; let payment_data = PaymentData { diff --git a/crates/router/src/core/payments/operations/payment_status.rs b/crates/router/src/core/payments/operations/payment_status.rs index 587bdc8ef00..f2453e52c86 100644 --- a/crates/router/src/core/payments/operations/payment_status.rs +++ b/crates/router/src/core/payments/operations/payment_status.rs @@ -376,7 +376,7 @@ async fn get_tracker_for_sync< .find_business_profile_by_profile_id(key_manager_state, key_store, profile_id) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_string(), + id: profile_id.get_string_repr().to_owned(), })?; let payment_method_info = diff --git a/crates/router/src/core/payments/operations/payment_update.rs b/crates/router/src/core/payments/operations/payment_update.rs index e7045116f23..32d7b32059b 100644 --- a/crates/router/src/core/payments/operations/payment_update.rs +++ b/crates/router/src/core/payments/operations/payment_update.rs @@ -419,7 +419,7 @@ impl<F: Send + Clone> GetTracker<F, PaymentData<F>, api::PaymentsRequest> for Pa .find_business_profile_by_profile_id(key_manager_state, key_store, profile_id) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_string(), + id: profile_id.get_string_repr().to_owned(), })?; let surcharge_details = request.surcharge_details.map(|request_surcharge_details| { diff --git a/crates/router/src/core/payments/operations/payments_incremental_authorization.rs b/crates/router/src/core/payments/operations/payments_incremental_authorization.rs index 31883042eca..e3e3bf4260e 100644 --- a/crates/router/src/core/payments/operations/payments_incremental_authorization.rs +++ b/crates/router/src/core/payments/operations/payments_incremental_authorization.rs @@ -112,7 +112,7 @@ impl<F: Send + Clone> .find_business_profile_by_profile_id(key_manager_state, key_store, profile_id) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_string(), + id: profile_id.get_string_repr().to_owned(), })?; let payment_data = payments::PaymentData { diff --git a/crates/router/src/core/payments/routing.rs b/crates/router/src/core/payments/routing.rs index 30c1edb6e04..692a5924a06 100644 --- a/crates/router/src/core/payments/routing.rs +++ b/crates/router/src/core/payments/routing.rs @@ -81,7 +81,7 @@ pub struct SessionRoutingPmTypeInput<'a> { routing_algorithm: &'a MerchantAccountRoutingAlgorithm, backend_input: dsl_inputs::BackendInput, allowed_connectors: FxHashMap<String, api::GetToken>, - profile_id: String, + profile_id: common_utils::id_type::ProfileId, } type RoutingResult<O> = oss_errors::CustomResult<O, errors::RoutingError>; @@ -291,7 +291,7 @@ pub async fn perform_static_routing_v1<F: Clone>( ))] let fallback_config = routing::helpers::get_merchant_default_config( &*state.clone().store, - &business_profile.profile_id, + business_profile.profile_id.get_string_repr(), &api_enums::TransactionType::from(transaction_data), ) .await @@ -342,22 +342,24 @@ async fn ensure_algorithm_cached_v1( state: &SessionState, merchant_id: &common_utils::id_type::MerchantId, algorithm_id: &str, - profile_id: String, + profile_id: common_utils::id_type::ProfileId, transaction_type: &api_enums::TransactionType, ) -> RoutingResult<Arc<CachedAlgorithm>> { let key = { match transaction_type { common_enums::TransactionType::Payment => { format!( - "routing_config_{}_{profile_id}", - merchant_id.get_string_repr() + "routing_config_{}_{}", + merchant_id.get_string_repr(), + profile_id.get_string_repr(), ) } #[cfg(feature = "payouts")] common_enums::TransactionType::Payout => { format!( - "routing_config_po_{}_{profile_id}", - merchant_id.get_string_repr() + "routing_config_po_{}_{}", + merchant_id.get_string_repr(), + profile_id.get_string_repr() ) } } @@ -425,7 +427,7 @@ pub async fn refresh_routing_cache_v1( state: &SessionState, key: String, algorithm_id: &str, - profile_id: String, + profile_id: common_utils::id_type::ProfileId, ) -> RoutingResult<Arc<CachedAlgorithm>> { let algorithm = { let algorithm = state @@ -507,7 +509,7 @@ pub fn perform_volume_split( pub async fn get_merchant_cgraph<'a>( state: &SessionState, key_store: &domain::MerchantKeyStore, - profile_id: String, + profile_id: common_utils::id_type::ProfileId, transaction_type: &api_enums::TransactionType, ) -> RoutingResult<Arc<hyperswitch_constraint_graph::ConstraintGraph<euclid_dir::DirValue>>> { let merchant_id = &key_store.merchant_id; @@ -515,11 +517,19 @@ pub async fn get_merchant_cgraph<'a>( let key = { match transaction_type { api_enums::TransactionType::Payment => { - format!("cgraph_{}_{}", merchant_id.get_string_repr(), profile_id) + format!( + "cgraph_{}_{}", + merchant_id.get_string_repr(), + profile_id.get_string_repr() + ) } #[cfg(feature = "payouts")] api_enums::TransactionType::Payout => { - format!("cgraph_po_{}_{}", merchant_id.get_string_repr(), profile_id) + format!( + "cgraph_po_{}_{}", + merchant_id.get_string_repr(), + profile_id.get_string_repr() + ) } } }; @@ -546,7 +556,7 @@ pub async fn refresh_cgraph_cache<'a>( state: &SessionState, key_store: &domain::MerchantKeyStore, key: String, - profile_id: String, + profile_id: common_utils::id_type::ProfileId, transaction_type: &api_enums::TransactionType, ) -> RoutingResult<Arc<hyperswitch_constraint_graph::ConstraintGraph<euclid_dir::DirValue>>> { let mut merchant_connector_accounts = state @@ -645,7 +655,7 @@ async fn perform_cgraph_filtering( chosen: Vec<routing_types::RoutableConnectorChoice>, backend_input: dsl_inputs::BackendInput, eligible_connectors: Option<&Vec<api_enums::RoutableConnectors>>, - profile_id: String, + profile_id: common_utils::id_type::ProfileId, transaction_type: &api_enums::TransactionType, ) -> RoutingResult<Vec<routing_types::RoutableConnectorChoice>> { let context = euclid_graph::AnalysisContext::from_dir_values( @@ -689,7 +699,7 @@ pub async fn perform_eligibility_analysis<F: Clone>( chosen: Vec<routing_types::RoutableConnectorChoice>, transaction_data: &routing::TransactionData<'_, F>, eligible_connectors: Option<&Vec<api_enums::RoutableConnectors>>, - profile_id: String, + profile_id: common_utils::id_type::ProfileId, ) -> RoutingResult<Vec<routing_types::RoutableConnectorChoice>> { let backend_input = match transaction_data { routing::TransactionData::Payment(payment_data) => make_dsl_input(payment_data)?, @@ -728,9 +738,12 @@ pub async fn perform_fallback_routing<F: Clone>( .profile_id .as_ref() .get_required_value("profile_id") - .change_context(errors::RoutingError::ProfileIdMissing)?, + .change_context(errors::RoutingError::ProfileIdMissing)? + .get_string_repr(), #[cfg(feature = "payouts")] - routing::TransactionData::Payout(payout_data) => &payout_data.payout_attempt.profile_id, + routing::TransactionData::Payout(payout_data) => { + payout_data.payout_attempt.profile_id.get_string_repr() + } }, &api_enums::TransactionType::from(transaction_data), ) @@ -1015,7 +1028,7 @@ async fn perform_session_routing_for_pm_type( } else { routing::helpers::get_merchant_default_config( &*session_pm_input.state.clone().store, - &session_pm_input.profile_id, + session_pm_input.profile_id.get_string_repr(), transaction_type, ) .await @@ -1036,7 +1049,7 @@ async fn perform_session_routing_for_pm_type( if final_selection.is_empty() { let fallback = routing::helpers::get_merchant_default_config( &*session_pm_input.state.clone().store, - &session_pm_input.profile_id, + session_pm_input.profile_id.get_string_repr(), transaction_type, ) .await diff --git a/crates/router/src/core/payouts.rs b/crates/router/src/core/payouts.rs index a54f00d6aa0..e439a052a4c 100644 --- a/crates/router/src/core/payouts.rs +++ b/crates/router/src/core/payouts.rs @@ -66,7 +66,7 @@ pub struct PayoutData { pub payouts: storage::Payouts, pub payout_attempt: storage::PayoutAttempt, pub payout_method_data: Option<payouts::PayoutMethodData>, - pub profile_id: String, + pub profile_id: common_utils::id_type::ProfileId, pub should_terminate: bool, pub payout_link: Option<PayoutLink>, } @@ -514,7 +514,7 @@ pub async fn payouts_update_core( pub async fn payouts_retrieve_core( state: SessionState, merchant_account: domain::MerchantAccount, - profile_id: Option<String>, + profile_id: Option<common_utils::id_type::ProfileId>, key_store: domain::MerchantKeyStore, req: payouts::PayoutRetrieveRequest, ) -> RouterResponse<payouts::PayoutCreateResponse> { @@ -740,7 +740,7 @@ pub async fn payouts_fulfill_core( pub async fn payouts_list_core( _state: SessionState, _merchant_account: domain::MerchantAccount, - _profile_id_list: Option<Vec<String>>, + _profile_id_list: Option<Vec<common_utils::id_type::ProfileId>>, _key_store: domain::MerchantKeyStore, _constraints: payouts::PayoutListConstraints, ) -> RouterResponse<payouts::PayoutListResponse> { @@ -755,7 +755,7 @@ pub async fn payouts_list_core( pub async fn payouts_list_core( state: SessionState, merchant_account: domain::MerchantAccount, - profile_id_list: Option<Vec<String>>, + profile_id_list: Option<Vec<common_utils::id_type::ProfileId>>, key_store: domain::MerchantKeyStore, constraints: payouts::PayoutListConstraints, ) -> RouterResponse<payouts::PayoutListResponse> { @@ -864,7 +864,7 @@ pub async fn payouts_list_core( pub async fn payouts_filtered_list_core( state: SessionState, merchant_account: domain::MerchantAccount, - profile_id_list: Option<Vec<String>>, + profile_id_list: Option<Vec<common_utils::id_type::ProfileId>>, key_store: domain::MerchantKeyStore, filters: payouts::PayoutListFilterConstraints, ) -> RouterResponse<payouts::PayoutListResponse> { @@ -1143,7 +1143,11 @@ pub async fn create_recipient( let connector_name = connector_data.connector_name.to_string(); // Create the connector label using {profile_id}_{connector_name} - let connector_label = format!("{}_{}", payout_data.profile_id, connector_name); + let connector_label = format!( + "{}_{}", + payout_data.profile_id.get_string_repr(), + connector_name + ); let (should_call_connector, _connector_customer_id) = helpers::should_call_payout_connector_create_customer( state, @@ -2217,7 +2221,7 @@ pub async fn payout_create_db_entries( key_store: &domain::MerchantKeyStore, req: &payouts::PayoutCreateRequest, payout_id: &String, - profile_id: &String, + profile_id: &common_utils::id_type::ProfileId, stored_payout_method_data: Option<&payouts::PayoutMethodData>, locale: &String, customer: Option<&domain::Customer>, @@ -2291,7 +2295,7 @@ pub async fn payout_create_db_entries( let payouts_req = storage::PayoutsNew { payout_id: payout_id.to_string(), merchant_id: merchant_id.to_owned(), - customer_id, + customer_id: customer_id.to_owned(), address_id: address_id.to_owned(), payout_type, amount, @@ -2303,7 +2307,7 @@ pub async fn payout_create_db_entries( return_url: req.return_url.to_owned(), entity_type: req.entity_type.unwrap_or_default(), payout_method_id, - profile_id: profile_id.to_string(), + profile_id: profile_id.to_owned(), attempt_count: 1, metadata: req.metadata.clone(), confirm: req.confirm, @@ -2313,7 +2317,8 @@ pub async fn payout_create_db_entries( client_secret: Some(client_secret), priority: req.priority, status, - ..Default::default() + created_at: common_utils::date_time::now(), + last_modified_at: common_utils::date_time::now(), }; let payouts = db .insert_payout(payouts_req, merchant_account.storage_scheme) @@ -2333,8 +2338,18 @@ pub async fn payout_create_db_entries( business_country: req.business_country.to_owned(), business_label: req.business_label.to_owned(), payout_token: req.payout_token.to_owned(), - profile_id: profile_id.to_string(), - ..Default::default() + profile_id: profile_id.to_owned(), + customer_id, + address_id, + connector: None, + connector_payout_id: None, + is_eligible: None, + error_message: None, + error_code: None, + created_at: common_utils::date_time::now(), + last_modified_at: common_utils::date_time::now(), + merchant_connector_id: None, + routing_info: None, }; let payout_attempt = db .insert_payout_attempt( @@ -2371,7 +2386,7 @@ pub async fn payout_create_db_entries( pub async fn make_payout_data( _state: &SessionState, _merchant_account: &domain::MerchantAccount, - _auth_profile_id: Option<String>, + _auth_profile_id: Option<common_utils::id_type::ProfileId>, _key_store: &domain::MerchantKeyStore, _req: &payouts::PayoutRequest, ) -> RouterResult<PayoutData> { @@ -2382,7 +2397,7 @@ pub async fn make_payout_data( pub async fn make_payout_data( state: &SessionState, merchant_account: &domain::MerchantAccount, - auth_profile_id: Option<String>, + auth_profile_id: Option<common_utils::id_type::ProfileId>, key_store: &domain::MerchantKeyStore, req: &payouts::PayoutRequest, ) -> RouterResult<PayoutData> { @@ -2568,7 +2583,7 @@ pub async fn add_external_account_addition_task( async fn validate_and_get_business_profile( state: &SessionState, merchant_key_store: &domain::MerchantKeyStore, - profile_id: &String, + profile_id: &common_utils::id_type::ProfileId, merchant_id: &common_utils::id_type::MerchantId, ) -> RouterResult<domain::BusinessProfile> { let db = &*state.store; @@ -2588,7 +2603,7 @@ async fn validate_and_get_business_profile( db.find_business_profile_by_profile_id(key_manager_state, merchant_key_store, profile_id) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_string(), + id: profile_id.get_string_repr().to_owned(), }) } } @@ -2727,7 +2742,7 @@ pub async fn create_payout_link_db_entry( pub async fn get_mca_from_profile_id( state: &SessionState, merchant_account: &domain::MerchantAccount, - profile_id: &String, + profile_id: &common_utils::id_type::ProfileId, connector_name: &str, merchant_connector_id: Option<&String>, key_store: &domain::MerchantKeyStore, diff --git a/crates/router/src/core/payouts/retry.rs b/crates/router/src/core/payouts/retry.rs index 284f81a1702..08fef69988c 100644 --- a/crates/router/src/core/payouts/retry.rs +++ b/crates/router/src/core/payouts/retry.rs @@ -285,8 +285,16 @@ pub async fn modify_trackers( business_country: payout_data.payout_attempt.business_country.to_owned(), business_label: payout_data.payout_attempt.business_label.to_owned(), payout_token: payout_data.payout_attempt.payout_token.to_owned(), - profile_id: payout_data.payout_attempt.profile_id.to_string(), - ..Default::default() + profile_id: payout_data.payout_attempt.profile_id.to_owned(), + connector_payout_id: None, + status: common_enums::PayoutStatus::default(), + is_eligible: None, + error_message: None, + error_code: None, + created_at: common_utils::date_time::now(), + last_modified_at: common_utils::date_time::now(), + merchant_connector_id: None, + routing_info: None, }; payout_data.payout_attempt = db .insert_payout_attempt( diff --git a/crates/router/src/core/payouts/validator.rs b/crates/router/src/core/payouts/validator.rs index d425725645b..bde753a90e0 100644 --- a/crates/router/src/core/payouts/validator.rs +++ b/crates/router/src/core/payouts/validator.rs @@ -56,7 +56,7 @@ pub async fn validate_create_request( ) -> RouterResult<( String, Option<payouts::PayoutMethodData>, - String, + common_utils::id_type::ProfileId, Option<domain::Customer>, )> { let merchant_id = merchant_account.get_id(); diff --git a/crates/router/src/core/refunds.rs b/crates/router/src/core/refunds.rs index 878ec241854..89450347404 100644 --- a/crates/router/src/core/refunds.rs +++ b/crates/router/src/core/refunds.rs @@ -47,7 +47,7 @@ use crate::{ pub async fn refund_create_core( state: SessionState, merchant_account: domain::MerchantAccount, - _profile_id: Option<String>, + _profile_id: Option<common_utils::id_type::ProfileId>, key_store: domain::MerchantKeyStore, req: refunds::RefundRequest, ) -> RouterResponse<refunds::RefundResponse> { @@ -374,7 +374,7 @@ where pub async fn refund_response_wrapper<'a, F, Fut, T, Req>( state: SessionState, merchant_account: domain::MerchantAccount, - profile_id: Option<String>, + profile_id: Option<common_utils::id_type::ProfileId>, key_store: domain::MerchantKeyStore, request: Req, f: F, @@ -383,7 +383,7 @@ where F: Fn( SessionState, domain::MerchantAccount, - Option<String>, + Option<common_utils::id_type::ProfileId>, domain::MerchantKeyStore, Req, ) -> Fut, @@ -401,7 +401,7 @@ where pub async fn refund_retrieve_core( state: SessionState, merchant_account: domain::MerchantAccount, - profile_id: Option<String>, + profile_id: Option<common_utils::id_type::ProfileId>, key_store: domain::MerchantKeyStore, request: refunds::RefundsRetrieveRequest, ) -> RouterResult<storage::Refund> { @@ -865,7 +865,7 @@ pub async fn validate_and_create_refund( pub async fn refund_list( state: SessionState, merchant_account: domain::MerchantAccount, - _profile_id_list: Option<Vec<String>>, + _profile_id_list: Option<Vec<common_utils::id_type::ProfileId>>, req: api_models::refunds::RefundListRequest, ) -> RouterResponse<api_models::refunds::RefundListResponse> { let db = state.store; @@ -987,7 +987,7 @@ pub async fn refund_manual_update( pub async fn get_filters_for_refunds( state: SessionState, merchant_account: domain::MerchantAccount, - profile_id_list: Option<Vec<String>>, + profile_id_list: Option<Vec<common_utils::id_type::ProfileId>>, ) -> RouterResponse<api_models::refunds::RefundListFilters> { let merchant_connector_accounts = if let services::ApplicationResponse::Json(data) = super::admin::list_payment_connectors( diff --git a/crates/router/src/core/routing.rs b/crates/router/src/core/routing.rs index 2b7f2d18306..cdc22bc64d2 100644 --- a/crates/router/src/core/routing.rs +++ b/crates/router/src/core/routing.rs @@ -50,7 +50,7 @@ impl RoutingAlgorithmUpdate { pub fn create_new_routing_algorithm( request: &routing_types::RoutingConfigRequest, merchant_id: &common_utils::id_type::MerchantId, - profile_id: String, + profile_id: common_utils::id_type::ProfileId, transaction_type: &enums::TransactionType, ) -> Self { let algorithm_id = common_utils::generate_id( @@ -279,7 +279,7 @@ pub async fn link_routing_config_under_profile( state: SessionState, merchant_account: domain::MerchantAccount, key_store: domain::MerchantKeyStore, - profile_id: String, + profile_id: common_utils::id_type::ProfileId, algorithm_id: String, transaction_type: &enums::TransactionType, ) -> RouterResponse<routing_types::RoutingDictionaryRecord> { @@ -377,7 +377,7 @@ pub async fn link_routing_config( .await? .get_required_value("BusinessProfile") .change_context(errors::ApiErrorResponse::BusinessProfileNotFound { - id: routing_algorithm.profile_id.clone(), + id: routing_algorithm.profile_id.get_string_repr().to_owned(), })?; let mut routing_ref: routing_types::RoutingAlgorithmRef = business_profile @@ -503,7 +503,7 @@ pub async fn unlink_routing_config_under_profile( state: SessionState, merchant_account: domain::MerchantAccount, key_store: domain::MerchantKeyStore, - profile_id: String, + profile_id: common_utils::id_type::ProfileId, transaction_type: &enums::TransactionType, ) -> RouterResponse<routing_types::RoutingDictionaryRecord> { metrics::ROUTING_UNLINK_CONFIG.add(&metrics::CONTEXT, 1, &[]); @@ -649,7 +649,7 @@ pub async fn update_default_fallback_routing( state: SessionState, merchant_account: domain::MerchantAccount, key_store: domain::MerchantKeyStore, - profile_id: String, + profile_id: common_utils::id_type::ProfileId, updated_list_of_connectors: Vec<routing_types::RoutableConnectorChoice>, ) -> RouterResponse<Vec<routing_types::RoutableConnectorChoice>> { metrics::ROUTING_UPDATE_CONFIG.add(&metrics::CONTEXT, 1, &[]); @@ -785,7 +785,7 @@ pub async fn retrieve_default_fallback_algorithm_for_profile( state: SessionState, merchant_account: domain::MerchantAccount, key_store: domain::MerchantKeyStore, - profile_id: String, + profile_id: common_utils::id_type::ProfileId, ) -> RouterResponse<Vec<routing_types::RoutableConnectorChoice>> { metrics::ROUTING_RETRIEVE_DEFAULT_CONFIG.add(&metrics::CONTEXT, 1, &[]); let db = state.store.as_ref(); @@ -841,7 +841,7 @@ pub async fn retrieve_routing_config_under_profile( merchant_account: domain::MerchantAccount, key_store: domain::MerchantKeyStore, query_params: RoutingRetrieveQuery, - profile_id: String, + profile_id: common_utils::id_type::ProfileId, transaction_type: &enums::TransactionType, ) -> RouterResponse<routing_types::LinkedRoutingConfigRetrieveResponse> { metrics::ROUTING_RETRIEVE_LINK_CONFIG.add(&metrics::CONTEXT, 1, &[]); @@ -905,7 +905,9 @@ pub async fn retrieve_linked_routing_config( .await? .map(|profile| vec![profile]) .get_required_value("BusinessProfile") - .change_context(errors::ApiErrorResponse::BusinessProfileNotFound { id: profile_id })? + .change_context(errors::ApiErrorResponse::BusinessProfileNotFound { + id: profile_id.get_string_repr().to_owned(), + })? } else { db.list_business_profile_by_merchant_id( key_manager_state, @@ -972,7 +974,13 @@ pub async fn retrieve_default_routing_config_for_profiles( let retrieve_config_futures = all_profiles .iter() - .map(|prof| helpers::get_merchant_default_config(db, &prof.profile_id, transaction_type)) + .map(|prof| { + helpers::get_merchant_default_config( + db, + prof.profile_id.get_string_repr(), + transaction_type, + ) + }) .collect::<Vec<_>>(); let configs = futures::future::join_all(retrieve_config_futures) @@ -1000,7 +1008,7 @@ pub async fn update_default_routing_config_for_profile( merchant_account: domain::MerchantAccount, key_store: domain::MerchantKeyStore, updated_config: Vec<routing_types::RoutableConnectorChoice>, - profile_id: String, + profile_id: common_utils::id_type::ProfileId, transaction_type: &enums::TransactionType, ) -> RouterResponse<routing_types::ProfileDefaultRoutingConfig> { metrics::ROUTING_UPDATE_CONFIG_FOR_PROFILE.add(&metrics::CONTEXT, 1, &[]); @@ -1016,10 +1024,15 @@ pub async fn update_default_routing_config_for_profile( ) .await? .get_required_value("BusinessProfile") - .change_context(errors::ApiErrorResponse::BusinessProfileNotFound { id: profile_id })?; - let default_config = - helpers::get_merchant_default_config(db, &business_profile.profile_id, transaction_type) - .await?; + .change_context(errors::ApiErrorResponse::BusinessProfileNotFound { + id: profile_id.get_string_repr().to_owned(), + })?; + let default_config = helpers::get_merchant_default_config( + db, + business_profile.profile_id.get_string_repr(), + transaction_type, + ) + .await?; utils::when(default_config.len() != updated_config.len(), || { Err(errors::ApiErrorResponse::PreconditionFailed { @@ -1058,7 +1071,7 @@ pub async fn update_default_routing_config_for_profile( helpers::update_merchant_default_config( db, - &business_profile.profile_id, + business_profile.profile_id.get_string_repr(), updated_config.clone(), transaction_type, ) diff --git a/crates/router/src/core/routing/helpers.rs b/crates/router/src/core/routing/helpers.rs index 43da2bb2bd0..5cbb1e9fdf6 100644 --- a/crates/router/src/core/routing/helpers.rs +++ b/crates/router/src/core/routing/helpers.rs @@ -207,8 +207,9 @@ pub async fn update_business_profile_active_algorithm_ref( let routing_cache_key = cache::CacheKind::Routing( format!( - "routing_config_{}_{profile_id}", - merchant_id.get_string_repr() + "routing_config_{}_{}", + merchant_id.get_string_repr(), + profile_id.get_string_repr(), ) .into(), ); @@ -300,13 +301,13 @@ impl MerchantConnectorAccounts { pub fn filter_by_profile<'a, T>( &'a self, - profile_id: &'a str, + profile_id: &'a common_utils::id_type::ProfileId, func: impl Fn(&'a MerchantConnectorAccount) -> T, ) -> FxHashSet<T> where T: std::hash::Hash + Eq, { - self.filter_and_map(|mca| mca.profile_id == profile_id, func) + self.filter_and_map(|mca| mca.profile_id == *profile_id, func) } } @@ -396,7 +397,7 @@ pub async fn validate_connectors_in_routing_config( state: &SessionState, key_store: &domain::MerchantKeyStore, merchant_id: &common_utils::id_type::MerchantId, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, routing_algorithm: &routing_types::RoutingAlgorithm, ) -> RouterResult<()> { let all_mcas = &*state @@ -413,13 +414,13 @@ pub async fn validate_connectors_in_routing_config( })?; let name_mca_id_set = all_mcas .iter() - .filter(|mca| mca.profile_id == profile_id) + .filter(|mca| mca.profile_id == *profile_id) .map(|mca| (&mca.connector_name, mca.get_id())) .collect::<FxHashSet<_>>(); let name_set = all_mcas .iter() - .filter(|mca| mca.profile_id == profile_id) + .filter(|mca| mca.profile_id == *profile_id) .map(|mca| &mca.connector_name) .collect::<FxHashSet<_>>(); diff --git a/crates/router/src/core/utils.rs b/crates/router/src/core/utils.rs index 02a10252cd3..c46fac1322c 100644 --- a/crates/router/src/core/utils.rs +++ b/crates/router/src/core/utils.rs @@ -94,7 +94,11 @@ pub async fn construct_payout_router_data<'a, F>( let payouts = &payout_data.payouts; let payout_attempt = &payout_data.payout_attempt; let customer_details = &payout_data.customer_details; - let connector_label = format!("{}_{}", payout_data.profile_id, connector_name); + let connector_label = format!( + "{}_{}", + payout_data.profile_id.get_string_repr(), + connector_name + ); let connector_customer_id = customer_details .as_ref() .and_then(|c| c.connector_customer.as_ref()) @@ -394,6 +398,7 @@ pub fn validate_uuid(uuid: String, key: &str) -> Result<String, errors::ApiError #[cfg(test)] mod tests { + #![allow(clippy::expect_used)] use super::*; #[test] @@ -425,23 +430,33 @@ mod tests { fn test_filter_objects_based_on_profile_id_list() { #[derive(PartialEq, Debug, Clone)] struct Object { - profile_id: Option<String>, + profile_id: Option<common_utils::id_type::ProfileId>, } impl Object { - pub fn new(profile_id: &str) -> Self { + pub fn new(profile_id: &'static str) -> Self { Self { - profile_id: Some(profile_id.to_string()), + profile_id: Some( + common_utils::id_type::ProfileId::try_from(std::borrow::Cow::from( + profile_id, + )) + .expect("invalid profile ID"), + ), } } } impl GetProfileId for Object { - fn get_profile_id(&self) -> Option<&String> { + fn get_profile_id(&self) -> Option<&common_utils::id_type::ProfileId> { self.profile_id.as_ref() } } + fn new_profile_id(profile_id: &'static str) -> common_utils::id_type::ProfileId { + common_utils::id_type::ProfileId::try_from(std::borrow::Cow::from(profile_id)) + .expect("invalid profile ID") + } + // non empty object_list and profile_id_list let object_list = vec![ Object::new("p1"), @@ -450,7 +465,11 @@ mod tests { Object::new("p4"), Object::new("p5"), ]; - let profile_id_list = vec!["p1".to_string(), "p2".to_string(), "p3".to_string()]; + let profile_id_list = vec![ + new_profile_id("p1"), + new_profile_id("p2"), + new_profile_id("p3"), + ]; let filtered_list = filter_objects_based_on_profile_id_list(Some(profile_id_list), object_list.clone()); let expected_result = vec![Object::new("p1"), Object::new("p2"), Object::new("p2")]; @@ -1040,7 +1059,7 @@ pub async fn validate_and_get_business_profile( db: &dyn StorageInterface, key_manager_state: &common_utils::types::keymanager::KeyManagerState, merchant_key_store: &domain::MerchantKeyStore, - profile_id: Option<&String>, + profile_id: Option<&common_utils::id_type::ProfileId>, merchant_id: &common_utils::id_type::MerchantId, ) -> RouterResult<Option<domain::BusinessProfile>> { profile_id @@ -1052,7 +1071,7 @@ pub async fn validate_and_get_business_profile( ) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_owned(), + id: profile_id.get_string_repr().to_owned(), }) }) .await @@ -1061,7 +1080,7 @@ pub async fn validate_and_get_business_profile( // Check if the merchant_id of business profile is same as the current merchant_id if business_profile.merchant_id.ne(merchant_id) { Err(errors::ApiErrorResponse::AccessForbidden { - resource: business_profile.profile_id, + resource: business_profile.profile_id.get_string_repr().to_owned(), } .into()) } else { @@ -1123,10 +1142,10 @@ pub async fn get_profile_id_from_business_details( business_country: Option<api_models::enums::CountryAlpha2>, business_label: Option<&String>, merchant_account: &domain::MerchantAccount, - request_profile_id: Option<&String>, + request_profile_id: Option<&common_utils::id_type::ProfileId>, db: &dyn StorageInterface, should_validate: bool, -) -> RouterResult<String> { +) -> RouterResult<common_utils::id_type::ProfileId> { match request_profile_id.or(merchant_account.default_profile.as_ref()) { Some(profile_id) => { // Check whether this business profile belongs to the merchant @@ -1297,55 +1316,55 @@ pub fn get_incremental_authorization_allowed_value( } pub(super) trait GetProfileId { - fn get_profile_id(&self) -> Option<&String>; + fn get_profile_id(&self) -> Option<&common_utils::id_type::ProfileId>; } impl GetProfileId for MerchantConnectorAccount { - fn get_profile_id(&self) -> Option<&String> { + fn get_profile_id(&self) -> Option<&common_utils::id_type::ProfileId> { Some(&self.profile_id) } } impl GetProfileId for storage::PaymentIntent { - fn get_profile_id(&self) -> Option<&String> { + fn get_profile_id(&self) -> Option<&common_utils::id_type::ProfileId> { self.profile_id.as_ref() } } impl<A> GetProfileId for (storage::PaymentIntent, A) { - fn get_profile_id(&self) -> Option<&String> { + fn get_profile_id(&self) -> Option<&common_utils::id_type::ProfileId> { self.0.get_profile_id() } } impl GetProfileId for diesel_models::Dispute { - fn get_profile_id(&self) -> Option<&String> { + fn get_profile_id(&self) -> Option<&common_utils::id_type::ProfileId> { self.profile_id.as_ref() } } impl GetProfileId for diesel_models::Refund { - fn get_profile_id(&self) -> Option<&String> { + fn get_profile_id(&self) -> Option<&common_utils::id_type::ProfileId> { self.profile_id.as_ref() } } #[cfg(feature = "payouts")] impl GetProfileId for storage::Payouts { - fn get_profile_id(&self) -> Option<&String> { + fn get_profile_id(&self) -> Option<&common_utils::id_type::ProfileId> { Some(&self.profile_id) } } #[cfg(feature = "payouts")] impl<T, F> GetProfileId for (storage::Payouts, T, F) { - fn get_profile_id(&self) -> Option<&String> { + fn get_profile_id(&self) -> Option<&common_utils::id_type::ProfileId> { self.0.get_profile_id() } } /// Filter Objects based on profile ids pub(super) fn filter_objects_based_on_profile_id_list<T: GetProfileId>( - profile_id_list_auth_layer: Option<Vec<String>>, + profile_id_list_auth_layer: Option<Vec<common_utils::id_type::ProfileId>>, object_list: Vec<T>, ) -> Vec<T> { if let Some(profile_id_list) = profile_id_list_auth_layer { @@ -1369,7 +1388,7 @@ pub(super) fn filter_objects_based_on_profile_id_list<T: GetProfileId>( } pub(super) fn validate_profile_id_from_auth_layer<T: GetProfileId + std::fmt::Debug>( - profile_id_auth_layer: Option<String>, + profile_id_auth_layer: Option<common_utils::id_type::ProfileId>, object: &T, ) -> RouterResult<()> { match (profile_id_auth_layer, object.get_profile_id()) { diff --git a/crates/router/src/core/verification.rs b/crates/router/src/core/verification.rs index 795e188c8aa..44bb67d0baf 100644 --- a/crates/router/src/core/verification.rs +++ b/crates/router/src/core/verification.rs @@ -12,7 +12,7 @@ pub async fn verify_merchant_creds_for_applepay( state: SessionState, body: verifications::ApplepayMerchantVerificationRequest, merchant_id: common_utils::id_type::MerchantId, - profile_id: Option<String>, + profile_id: Option<common_utils::id_type::ProfileId>, ) -> CustomResult<services::ApplicationResponse<ApplepayMerchantResponse>, errors::ApiErrorResponse> { let applepay_merchant_configs = state.conf.applepay_merchant_configs.get_inner(); diff --git a/crates/router/src/core/verification/utils.rs b/crates/router/src/core/verification/utils.rs index dd0aa3edef4..4b8e0ac0748 100644 --- a/crates/router/src/core/verification/utils.rs +++ b/crates/router/src/core/verification/utils.rs @@ -15,7 +15,7 @@ use crate::{ pub async fn check_existence_and_add_domain_to_db( state: &SessionState, merchant_id: common_utils::id_type::MerchantId, - profile_id_from_auth_layer: Option<String>, + profile_id_from_auth_layer: Option<common_utils::id_type::ProfileId>, merchant_connector_id: String, domain_from_req: Vec<String>, ) -> CustomResult<Vec<String>, errors::ApiErrorResponse> { diff --git a/crates/router/src/core/verify_connector.rs b/crates/router/src/core/verify_connector.rs index b6f03c27ab0..f7fa06dee5f 100644 --- a/crates/router/src/core/verify_connector.rs +++ b/crates/router/src/core/verify_connector.rs @@ -19,7 +19,7 @@ use crate::{ pub async fn verify_connector_credentials( state: SessionState, req: VerifyConnectorRequest, - _profile_id: Option<String>, + _profile_id: Option<common_utils::id_type::ProfileId>, ) -> errors::RouterResponse<()> { let boxed_connector = api::ConnectorData::get_connector_by_name( &state.conf.connectors, diff --git a/crates/router/src/core/webhooks/incoming.rs b/crates/router/src/core/webhooks/incoming.rs index d3e5873e9e9..01a1046be36 100644 --- a/crates/router/src/core/webhooks/incoming.rs +++ b/crates/router/src/core/webhooks/incoming.rs @@ -347,14 +347,14 @@ async fn incoming_webhooks_core<W: types::OutgoingWebhookType>( )?, }; - let profile_id = merchant_connector_account.profile_id.as_ref(); + let profile_id = &merchant_connector_account.profile_id; let business_profile = state .store .find_business_profile_by_profile_id(key_manager_state, &key_store, profile_id) .await .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_string(), + id: profile_id.get_string_repr().to_owned(), })?; match flow_type { diff --git a/crates/router/src/core/webhooks/outgoing.rs b/crates/router/src/core/webhooks/outgoing.rs index b075b15e7f8..276d296a4cb 100644 --- a/crates/router/src/core/webhooks/outgoing.rs +++ b/crates/router/src/core/webhooks/outgoing.rs @@ -71,7 +71,7 @@ pub(crate) async fn create_event_and_trigger_outgoing_webhook( || webhook_url_result.as_ref().is_ok_and(String::is_empty) { logger::debug!( - business_profile_id=%business_profile.profile_id, + business_profile_id=?business_profile.profile_id, %idempotent_event_id, "Outgoing webhooks are disabled in application configuration, or merchant webhook URL \ could not be obtained; skipping outgoing webhooks for event" diff --git a/crates/router/src/core/webhooks/types.rs b/crates/router/src/core/webhooks/types.rs index d9eed529e88..d9094bff001 100644 --- a/crates/router/src/core/webhooks/types.rs +++ b/crates/router/src/core/webhooks/types.rs @@ -59,7 +59,7 @@ impl OutgoingWebhookType for webhooks::OutgoingWebhook { #[derive(Debug, serde::Serialize, serde::Deserialize)] pub(crate) struct OutgoingWebhookTrackingData { pub(crate) merchant_id: common_utils::id_type::MerchantId, - pub(crate) business_profile_id: String, + pub(crate) business_profile_id: common_utils::id_type::ProfileId, pub(crate) event_type: enums::EventType, pub(crate) event_class: enums::EventClass, pub(crate) primary_object_id: String, diff --git a/crates/router/src/core/webhooks/webhook_events.rs b/crates/router/src/core/webhooks/webhook_events.rs index cf4a8d87263..13f1e95fc2a 100644 --- a/crates/router/src/core/webhooks/webhook_events.rs +++ b/crates/router/src/core/webhooks/webhook_events.rs @@ -265,7 +265,7 @@ pub async fn retry_delivery_attempt( async fn get_account_and_key_store( state: SessionState, merchant_id: common_utils::id_type::MerchantId, - profile_id: Option<String>, + profile_id: Option<common_utils::id_type::ProfileId>, ) -> errors::RouterResult<(MerchantAccountOrBusinessProfile, domain::MerchantKeyStore)> { let store = state.store.as_ref(); let key_manager_state = &(&state).into(); @@ -292,13 +292,13 @@ async fn get_account_and_key_store( .await .attach_printable_lazy(|| { format!( - "Failed to find business profile by merchant_id `{merchant_id:?}` and profile_id `{profile_id}`. \ - The merchant_id associated with the business profile `{profile_id}` may be \ + "Failed to find business profile by merchant_id `{merchant_id:?}` and profile_id `{profile_id:?}`. \ + The merchant_id associated with the business profile `{profile_id:?}` may be \ different than the merchant_id specified (`{merchant_id:?}`)." ) }) .to_not_found_response(errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id, + id: profile_id.get_string_repr().to_owned(), })?; Ok(( diff --git a/crates/router/src/db/business_profile.rs b/crates/router/src/db/business_profile.rs index ed178f275fd..8c81b0c3df1 100644 --- a/crates/router/src/db/business_profile.rs +++ b/crates/router/src/db/business_profile.rs @@ -33,7 +33,7 @@ where &self, key_manager_state: &KeyManagerState, merchant_key_store: &domain::MerchantKeyStore, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, ) -> CustomResult<domain::BusinessProfile, errors::StorageError>; async fn find_business_profile_by_merchant_id_profile_id( @@ -41,7 +41,7 @@ where key_manager_state: &KeyManagerState, merchant_key_store: &domain::MerchantKeyStore, merchant_id: &common_utils::id_type::MerchantId, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, ) -> CustomResult<domain::BusinessProfile, errors::StorageError>; async fn find_business_profile_by_profile_name_merchant_id( @@ -62,7 +62,7 @@ where async fn delete_business_profile_by_profile_id_merchant_id( &self, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, merchant_id: &common_utils::id_type::MerchantId, ) -> CustomResult<bool, errors::StorageError>; @@ -105,7 +105,7 @@ impl BusinessProfileInterface for Store { &self, key_manager_state: &KeyManagerState, merchant_key_store: &domain::MerchantKeyStore, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, ) -> CustomResult<domain::BusinessProfile, errors::StorageError> { let conn = connection::pg_connection_read(self).await?; storage::BusinessProfile::find_by_profile_id(&conn, profile_id) @@ -125,7 +125,7 @@ impl BusinessProfileInterface for Store { key_manager_state: &KeyManagerState, merchant_key_store: &domain::MerchantKeyStore, merchant_id: &common_utils::id_type::MerchantId, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, ) -> CustomResult<domain::BusinessProfile, errors::StorageError> { let conn = connection::pg_connection_read(self).await?; storage::BusinessProfile::find_by_merchant_id_profile_id(&conn, merchant_id, profile_id) @@ -191,7 +191,7 @@ impl BusinessProfileInterface for Store { #[instrument(skip_all)] async fn delete_business_profile_by_profile_id_merchant_id( &self, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, merchant_id: &common_utils::id_type::MerchantId, ) -> CustomResult<bool, errors::StorageError> { let conn = connection::pg_connection_write(self).await?; @@ -262,13 +262,13 @@ impl BusinessProfileInterface for MockDb { &self, key_manager_state: &KeyManagerState, merchant_key_store: &domain::MerchantKeyStore, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, ) -> CustomResult<domain::BusinessProfile, errors::StorageError> { self.business_profiles .lock() .await .iter() - .find(|business_profile| business_profile.profile_id == profile_id) + .find(|business_profile| business_profile.profile_id == *profile_id) .cloned() .async_map(|business_profile| async { business_profile @@ -284,7 +284,7 @@ impl BusinessProfileInterface for MockDb { .transpose()? .ok_or( errors::StorageError::ValueNotFound(format!( - "No business profile found for profile_id = {profile_id}" + "No business profile found for profile_id = {profile_id:?}" )) .into(), ) @@ -295,7 +295,7 @@ impl BusinessProfileInterface for MockDb { key_manager_state: &KeyManagerState, merchant_key_store: &domain::MerchantKeyStore, merchant_id: &common_utils::id_type::MerchantId, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, ) -> CustomResult<domain::BusinessProfile, errors::StorageError> { self.business_profiles .lock() @@ -303,7 +303,7 @@ impl BusinessProfileInterface for MockDb { .iter() .find(|business_profile| { business_profile.merchant_id == *merchant_id - && business_profile.profile_id == profile_id + && business_profile.profile_id == *profile_id }) .cloned() .async_map(|business_profile| async { @@ -320,7 +320,7 @@ impl BusinessProfileInterface for MockDb { .transpose()? .ok_or( errors::StorageError::ValueNotFound(format!( - "No business profile found for merchant_id = {merchant_id:?} and profile_id = {profile_id}" + "No business profile found for merchant_id = {merchant_id:?} and profile_id = {profile_id:?}" )) .into(), ) @@ -362,7 +362,7 @@ impl BusinessProfileInterface for MockDb { .transpose()? .ok_or( errors::StorageError::ValueNotFound(format!( - "No business profile found for profile_id = {profile_id}" + "No business profile found for profile_id = {profile_id:?}" )) .into(), ) @@ -370,18 +370,18 @@ impl BusinessProfileInterface for MockDb { async fn delete_business_profile_by_profile_id_merchant_id( &self, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, merchant_id: &common_utils::id_type::MerchantId, ) -> CustomResult<bool, errors::StorageError> { let mut business_profiles = self.business_profiles.lock().await; let index = business_profiles .iter() .position(|business_profile| { - business_profile.profile_id == profile_id + business_profile.profile_id == *profile_id && business_profile.merchant_id == *merchant_id }) .ok_or::<errors::StorageError>(errors::StorageError::ValueNotFound(format!( - "No business profile found for profile_id = {profile_id} and merchant_id = {merchant_id:?}" + "No business profile found for profile_id = {profile_id:?} and merchant_id = {merchant_id:?}" )))?; business_profiles.remove(index); Ok(true) diff --git a/crates/router/src/db/events.rs b/crates/router/src/db/events.rs index edd1eecff95..6aae49f1bde 100644 --- a/crates/router/src/db/events.rs +++ b/crates/router/src/db/events.rs @@ -67,7 +67,7 @@ where async fn list_initial_events_by_profile_id_primary_object_id( &self, state: &KeyManagerState, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, primary_object_id: &str, merchant_key_store: &domain::MerchantKeyStore, ) -> CustomResult<Vec<domain::Event>, errors::StorageError>; @@ -76,7 +76,7 @@ where async fn list_initial_events_by_profile_id_constraints( &self, state: &KeyManagerState, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, created_after: Option<time::PrimitiveDateTime>, created_before: Option<time::PrimitiveDateTime>, limit: Option<i64>, @@ -256,7 +256,7 @@ impl EventInterface for Store { async fn list_initial_events_by_profile_id_primary_object_id( &self, state: &KeyManagerState, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, primary_object_id: &str, merchant_key_store: &domain::MerchantKeyStore, ) -> CustomResult<Vec<domain::Event>, errors::StorageError> { @@ -291,7 +291,7 @@ impl EventInterface for Store { async fn list_initial_events_by_profile_id_constraints( &self, state: &KeyManagerState, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, created_after: Option<time::PrimitiveDateTime>, created_before: Option<time::PrimitiveDateTime>, limit: Option<i64>, @@ -554,7 +554,7 @@ impl EventInterface for MockDb { async fn list_initial_events_by_profile_id_primary_object_id( &self, state: &KeyManagerState, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, primary_object_id: &str, merchant_key_store: &domain::MerchantKeyStore, ) -> CustomResult<Vec<domain::Event>, errors::StorageError> { @@ -589,7 +589,7 @@ impl EventInterface for MockDb { async fn list_initial_events_by_profile_id_constraints( &self, state: &KeyManagerState, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, created_after: Option<time::PrimitiveDateTime>, created_before: Option<time::PrimitiveDateTime>, limit: Option<i64>, @@ -737,7 +737,8 @@ mod tests { let merchant_id = common_utils::id_type::MerchantId::try_from(std::borrow::Cow::from("merchant_1")) .unwrap(); - let business_profile_id = "profile1"; + let business_profile_id = + common_utils::id_type::ProfileId::try_from(std::borrow::Cow::from("profile1")).unwrap(); let payment_id = "test_payment_id"; let key_manager_state = &state.into(); let master_key = mockdb.get_master_key(); diff --git a/crates/router/src/db/kafka_store.rs b/crates/router/src/db/kafka_store.rs index cb3f6db144e..5cbcd2668eb 100644 --- a/crates/router/src/db/kafka_store.rs +++ b/crates/router/src/db/kafka_store.rs @@ -715,7 +715,7 @@ impl EventInterface for KafkaStore { async fn list_initial_events_by_profile_id_primary_object_id( &self, state: &KeyManagerState, - profile_id: &str, + profile_id: &id_type::ProfileId, primary_object_id: &str, merchant_key_store: &domain::MerchantKeyStore, ) -> CustomResult<Vec<domain::Event>, errors::StorageError> { @@ -732,7 +732,7 @@ impl EventInterface for KafkaStore { async fn list_initial_events_by_profile_id_constraints( &self, state: &KeyManagerState, - profile_id: &str, + profile_id: &id_type::ProfileId, created_after: Option<PrimitiveDateTime>, created_before: Option<PrimitiveDateTime>, limit: Option<i64>, @@ -1130,7 +1130,7 @@ impl MerchantConnectorAccountInterface for KafkaStore { async fn find_merchant_connector_account_by_profile_id_connector_name( &self, state: &KeyManagerState, - profile_id: &str, + profile_id: &id_type::ProfileId, connector_name: &str, key_store: &domain::MerchantKeyStore, ) -> CustomResult<domain::MerchantConnectorAccount, errors::StorageError> { @@ -2374,7 +2374,7 @@ impl BusinessProfileInterface for KafkaStore { &self, key_manager_state: &KeyManagerState, merchant_key_store: &domain::MerchantKeyStore, - profile_id: &str, + profile_id: &id_type::ProfileId, ) -> CustomResult<domain::BusinessProfile, errors::StorageError> { self.diesel_store .find_business_profile_by_profile_id(key_manager_state, merchant_key_store, profile_id) @@ -2386,7 +2386,7 @@ impl BusinessProfileInterface for KafkaStore { key_manager_state: &KeyManagerState, merchant_key_store: &domain::MerchantKeyStore, merchant_id: &id_type::MerchantId, - profile_id: &str, + profile_id: &id_type::ProfileId, ) -> CustomResult<domain::BusinessProfile, errors::StorageError> { self.diesel_store .find_business_profile_by_merchant_id_profile_id( @@ -2417,7 +2417,7 @@ impl BusinessProfileInterface for KafkaStore { async fn delete_business_profile_by_profile_id_merchant_id( &self, - profile_id: &str, + profile_id: &id_type::ProfileId, merchant_id: &id_type::MerchantId, ) -> CustomResult<bool, errors::StorageError> { self.diesel_store @@ -2494,7 +2494,7 @@ impl RoutingAlgorithmInterface for KafkaStore { async fn find_routing_algorithm_by_profile_id_algorithm_id( &self, - profile_id: &str, + profile_id: &id_type::ProfileId, algorithm_id: &str, ) -> CustomResult<storage::RoutingAlgorithm, errors::StorageError> { self.diesel_store @@ -2515,7 +2515,7 @@ impl RoutingAlgorithmInterface for KafkaStore { async fn find_routing_algorithm_metadata_by_algorithm_id_profile_id( &self, algorithm_id: &str, - profile_id: &str, + profile_id: &id_type::ProfileId, ) -> CustomResult<storage::RoutingProfileMetadata, errors::StorageError> { self.diesel_store .find_routing_algorithm_metadata_by_algorithm_id_profile_id(algorithm_id, profile_id) @@ -2524,7 +2524,7 @@ impl RoutingAlgorithmInterface for KafkaStore { async fn list_routing_algorithm_metadata_by_profile_id( &self, - profile_id: &str, + profile_id: &id_type::ProfileId, limit: i64, offset: i64, ) -> CustomResult<Vec<storage::RoutingProfileMetadata>, errors::StorageError> { @@ -2808,7 +2808,7 @@ impl UserRoleInterface for KafkaStore { user_id: &str, org_id: &id_type::OrganizationId, merchant_id: &id_type::MerchantId, - profile_id: Option<&String>, + profile_id: Option<&id_type::ProfileId>, version: enums::UserRoleVersion, ) -> CustomResult<storage::UserRole, errors::StorageError> { self.diesel_store @@ -2827,7 +2827,7 @@ impl UserRoleInterface for KafkaStore { user_id: &str, org_id: &id_type::OrganizationId, merchant_id: &id_type::MerchantId, - profile_id: Option<&String>, + profile_id: Option<&id_type::ProfileId>, update: user_storage::UserRoleUpdate, version: enums::UserRoleVersion, ) -> CustomResult<storage::UserRole, errors::StorageError> { @@ -2848,7 +2848,7 @@ impl UserRoleInterface for KafkaStore { user_id: &str, org_id: &id_type::OrganizationId, merchant_id: &id_type::MerchantId, - profile_id: Option<&String>, + profile_id: Option<&id_type::ProfileId>, version: enums::UserRoleVersion, ) -> CustomResult<storage::UserRole, errors::StorageError> { self.diesel_store @@ -2877,7 +2877,7 @@ impl UserRoleInterface for KafkaStore { user_id: &str, org_id: Option<&id_type::OrganizationId>, merchant_id: Option<&id_type::MerchantId>, - profile_id: Option<&String>, + profile_id: Option<&id_type::ProfileId>, entity_id: Option<&String>, version: Option<enums::UserRoleVersion>, ) -> CustomResult<Vec<storage::UserRole>, errors::StorageError> { diff --git a/crates/router/src/db/merchant_account.rs b/crates/router/src/db/merchant_account.rs index 5a828ebb0cd..8aa013ab08f 100644 --- a/crates/router/src/db/merchant_account.rs +++ b/crates/router/src/db/merchant_account.rs @@ -589,7 +589,7 @@ async fn publish_and_redact_merchant_account_cache( format!( "cgraph_{}_{}", merchant_account.get_id().get_string_repr(), - profile_id, + profile_id.get_string_repr(), ) .into(), ) diff --git a/crates/router/src/db/merchant_connector_account.rs b/crates/router/src/db/merchant_connector_account.rs index f039728de46..1908e01e94f 100644 --- a/crates/router/src/db/merchant_connector_account.rs +++ b/crates/router/src/db/merchant_connector_account.rs @@ -141,7 +141,7 @@ where async fn find_merchant_connector_account_by_profile_id_connector_name( &self, state: &KeyManagerState, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, connector_name: &str, key_store: &domain::MerchantKeyStore, ) -> CustomResult<domain::MerchantConnectorAccount, errors::StorageError>; @@ -290,7 +290,7 @@ impl MerchantConnectorAccountInterface for Store { async fn find_merchant_connector_account_by_profile_id_connector_name( &self, state: &KeyManagerState, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, connector_name: &str, key_store: &domain::MerchantKeyStore, ) -> CustomResult<domain::MerchantConnectorAccount, errors::StorageError> { @@ -322,7 +322,7 @@ impl MerchantConnectorAccountInterface for Store { { cache::get_or_populate_in_memory( self, - &format!("{}_{}", profile_id, connector_name), + &format!("{}_{}", profile_id.get_string_repr(), connector_name), find_call, &cache::ACCOUNTS_CACHE, ) @@ -587,7 +587,7 @@ impl MerchantConnectorAccountInterface for Store { self, [ cache::CacheKind::Accounts( - format!("{}_{}", _profile_id, _connector_name).into(), + format!("{}_{}", _profile_id.get_string_repr(), _connector_name).into(), ), cache::CacheKind::Accounts( format!( @@ -598,8 +598,12 @@ impl MerchantConnectorAccountInterface for Store { .into(), ), cache::CacheKind::CGraph( - format!("cgraph_{}_{_profile_id}", _merchant_id.get_string_repr()) - .into(), + format!( + "cgraph_{}_{}", + _merchant_id.get_string_repr(), + _profile_id.get_string_repr() + ) + .into(), ), ], || update, @@ -683,7 +687,7 @@ impl MerchantConnectorAccountInterface for Store { self, [ cache::CacheKind::Accounts( - format!("{}_{}", _profile_id, _connector_name).into(), + format!("{}_{}", _profile_id.get_string_repr(), _connector_name).into(), ), cache::CacheKind::Accounts( format!( @@ -694,12 +698,18 @@ impl MerchantConnectorAccountInterface for Store { .into(), ), cache::CacheKind::CGraph( - format!("cgraph_{}_{_profile_id}", _merchant_id.get_string_repr()).into(), + format!( + "cgraph_{}_{}", + _merchant_id.get_string_repr(), + _profile_id.get_string_repr() + ) + .into(), ), cache::CacheKind::PmFiltersCGraph( format!( - "pm_filters_cgraph_{}_{_profile_id}", - _merchant_id.get_string_repr() + "pm_filters_cgraph_{}_{}", + _merchant_id.get_string_repr(), + _profile_id.get_string_repr(), ) .into(), ), @@ -759,7 +769,7 @@ impl MerchantConnectorAccountInterface for Store { self, [ cache::CacheKind::Accounts( - format!("{}_{}", _profile_id, _connector_name).into(), + format!("{}_{}", _profile_id.get_string_repr(), _connector_name).into(), ), cache::CacheKind::Accounts( format!( @@ -770,12 +780,18 @@ impl MerchantConnectorAccountInterface for Store { .into(), ), cache::CacheKind::CGraph( - format!("cgraph_{}_{_profile_id}", _merchant_id.get_string_repr()).into(), + format!( + "cgraph_{}_{}", + _merchant_id.get_string_repr(), + _profile_id.get_string_repr() + ) + .into(), ), cache::CacheKind::PmFiltersCGraph( format!( - "pm_filters_cgraph_{}_{_profile_id}", - _merchant_id.get_string_repr() + "pm_filters_cgraph_{}_{}", + _merchant_id.get_string_repr(), + _profile_id.get_string_repr() ) .into(), ), @@ -835,16 +851,26 @@ impl MerchantConnectorAccountInterface for Store { self, [ cache::CacheKind::Accounts( - format!("{}_{}", mca.merchant_id.get_string_repr(), _profile_id).into(), + format!( + "{}_{}", + mca.merchant_id.get_string_repr(), + _profile_id.get_string_repr() + ) + .into(), ), cache::CacheKind::CGraph( - format!("cgraph_{}_{_profile_id}", mca.merchant_id.get_string_repr()) - .into(), + format!( + "cgraph_{}_{}", + mca.merchant_id.get_string_repr(), + _profile_id.get_string_repr() + ) + .into(), ), cache::CacheKind::PmFiltersCGraph( format!( - "pm_filters_cgraph_{}_{_profile_id}", - mca.merchant_id.get_string_repr() + "pm_filters_cgraph_{}_{}", + mca.merchant_id.get_string_repr(), + _profile_id.get_string_repr() ) .into(), ), @@ -890,16 +916,26 @@ impl MerchantConnectorAccountInterface for Store { self, [ cache::CacheKind::Accounts( - format!("{}_{}", mca.merchant_id.get_string_repr(), _profile_id).into(), + format!( + "{}_{}", + mca.merchant_id.get_string_repr(), + _profile_id.get_string_repr() + ) + .into(), ), cache::CacheKind::CGraph( - format!("cgraph_{}_{_profile_id}", mca.merchant_id.get_string_repr()) - .into(), + format!( + "cgraph_{}_{}", + mca.merchant_id.get_string_repr(), + _profile_id.get_string_repr() + ) + .into(), ), cache::CacheKind::PmFiltersCGraph( format!( - "pm_filters_cgraph_{}_{_profile_id}", - mca.merchant_id.get_string_repr() + "pm_filters_cgraph_{}_{}", + mca.merchant_id.get_string_repr(), + _profile_id.get_string_repr() ) .into(), ), @@ -1016,7 +1052,7 @@ impl MerchantConnectorAccountInterface for MockDb { async fn find_merchant_connector_account_by_profile_id_connector_name( &self, state: &KeyManagerState, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, connector_name: &str, key_store: &domain::MerchantKeyStore, ) -> CustomResult<domain::MerchantConnectorAccount, errors::StorageError> { @@ -1475,7 +1511,9 @@ mod merchant_connector_account_cache_tests { let connector_label = "stripe_USA"; let merchant_connector_id = "simple_merchant_connector_id"; - let profile_id = "pro_max_ultra"; + let profile_id = + common_utils::id_type::ProfileId::try_from(std::borrow::Cow::from("pro_max_ultra")) + .unwrap(); let key_manager_state = &state.into(); db.insert_merchant_key_store( key_manager_state, @@ -1536,7 +1574,7 @@ mod merchant_connector_account_cache_tests { created_at: date_time::now(), modified_at: date_time::now(), connector_webhook_details: None, - profile_id: profile_id.to_string(), + profile_id: profile_id.to_owned(), applepay_verified_domains: None, pm_auth_config: None, status: common_enums::ConnectorStatus::Inactive, @@ -1564,7 +1602,7 @@ mod merchant_connector_account_cache_tests { Conversion::convert( db.find_merchant_connector_account_by_profile_id_connector_name( key_manager_state, - profile_id, + &profile_id, &mca.connector_name, &merchant_key, ) @@ -1576,7 +1614,11 @@ mod merchant_connector_account_cache_tests { }; let _: storage::MerchantConnectorAccount = cache::get_or_populate_in_memory( &db, - &format!("{}_{}", merchant_id.get_string_repr(), profile_id), + &format!( + "{}_{}", + merchant_id.get_string_repr(), + profile_id.get_string_repr(), + ), find_call, &ACCOUNTS_CACHE, ) @@ -1644,7 +1686,9 @@ mod merchant_connector_account_cache_tests { .unwrap(); let connector_label = "stripe_USA"; let id = "simple_id"; - let profile_id = "pro_max_ultra"; + let profile_id = + common_utils::id_type::ProfileId::try_from(std::borrow::Cow::from("pro_max_ultra")) + .unwrap(); let key_manager_state = &state.into(); db.insert_merchant_key_store( key_manager_state, @@ -1701,7 +1745,7 @@ mod merchant_connector_account_cache_tests { created_at: date_time::now(), modified_at: date_time::now(), connector_webhook_details: None, - profile_id: profile_id.to_string(), + profile_id: profile_id.to_owned(), applepay_verified_domains: None, pm_auth_config: None, status: common_enums::ConnectorStatus::Inactive, @@ -1748,7 +1792,11 @@ mod merchant_connector_account_cache_tests { let _: storage::MerchantConnectorAccount = cache::get_or_populate_in_memory( &db, - &format!("{}_{}", merchant_id.clone().get_string_repr(), profile_id), + &format!( + "{}_{}", + merchant_id.clone().get_string_repr(), + profile_id.get_string_repr() + ), find_call, &ACCOUNTS_CACHE, ) diff --git a/crates/router/src/db/routing_algorithm.rs b/crates/router/src/db/routing_algorithm.rs index ad4b3bd9192..5672777bfa2 100644 --- a/crates/router/src/db/routing_algorithm.rs +++ b/crates/router/src/db/routing_algorithm.rs @@ -20,7 +20,7 @@ pub trait RoutingAlgorithmInterface { async fn find_routing_algorithm_by_profile_id_algorithm_id( &self, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, algorithm_id: &str, ) -> StorageResult<routing_storage::RoutingAlgorithm>; @@ -33,12 +33,12 @@ pub trait RoutingAlgorithmInterface { async fn find_routing_algorithm_metadata_by_algorithm_id_profile_id( &self, algorithm_id: &str, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, ) -> StorageResult<routing_storage::RoutingProfileMetadata>; async fn list_routing_algorithm_metadata_by_profile_id( &self, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, limit: i64, offset: i64, ) -> StorageResult<Vec<routing_storage::RoutingProfileMetadata>>; @@ -76,7 +76,7 @@ impl RoutingAlgorithmInterface for Store { #[instrument(skip_all)] async fn find_routing_algorithm_by_profile_id_algorithm_id( &self, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, algorithm_id: &str, ) -> StorageResult<routing_storage::RoutingAlgorithm> { let conn = connection::pg_connection_write(self).await?; @@ -109,7 +109,7 @@ impl RoutingAlgorithmInterface for Store { async fn find_routing_algorithm_metadata_by_algorithm_id_profile_id( &self, algorithm_id: &str, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, ) -> StorageResult<routing_storage::RoutingProfileMetadata> { let conn = connection::pg_connection_write(self).await?; routing_storage::RoutingAlgorithm::find_metadata_by_algorithm_id_profile_id( @@ -124,7 +124,7 @@ impl RoutingAlgorithmInterface for Store { #[instrument(skip_all)] async fn list_routing_algorithm_metadata_by_profile_id( &self, - profile_id: &str, + profile_id: &common_utils::id_type::ProfileId, limit: i64, offset: i64, ) -> StorageResult<Vec<routing_storage::RoutingProfileMetadata>> { @@ -185,7 +185,7 @@ impl RoutingAlgorithmInterface for MockDb { async fn find_routing_algorithm_by_profile_id_algorithm_id( &self, - _profile_id: &str, + _profile_id: &common_utils::id_type::ProfileId, _algorithm_id: &str, ) -> StorageResult<routing_storage::RoutingAlgorithm> { Err(errors::StorageError::MockDbError)? @@ -202,14 +202,14 @@ impl RoutingAlgorithmInterface for MockDb { async fn find_routing_algorithm_metadata_by_algorithm_id_profile_id( &self, _algorithm_id: &str, - _profile_id: &str, + _profile_id: &common_utils::id_type::ProfileId, ) -> StorageResult<routing_storage::RoutingProfileMetadata> { Err(errors::StorageError::MockDbError)? } async fn list_routing_algorithm_metadata_by_profile_id( &self, - _profile_id: &str, + _profile_id: &common_utils::id_type::ProfileId, _limit: i64, _offset: i64, ) -> StorageResult<Vec<routing_storage::RoutingProfileMetadata>> { diff --git a/crates/router/src/db/user_role.rs b/crates/router/src/db/user_role.rs index f028437b346..524eaaaab79 100644 --- a/crates/router/src/db/user_role.rs +++ b/crates/router/src/db/user_role.rs @@ -47,7 +47,7 @@ pub trait UserRoleInterface { user_id: &str, org_id: &id_type::OrganizationId, merchant_id: &id_type::MerchantId, - profile_id: Option<&String>, + profile_id: Option<&id_type::ProfileId>, version: enums::UserRoleVersion, ) -> CustomResult<storage::UserRole, errors::StorageError>; @@ -56,7 +56,7 @@ pub trait UserRoleInterface { user_id: &str, org_id: &id_type::OrganizationId, merchant_id: &id_type::MerchantId, - profile_id: Option<&String>, + profile_id: Option<&id_type::ProfileId>, update: storage::UserRoleUpdate, version: enums::UserRoleVersion, ) -> CustomResult<storage::UserRole, errors::StorageError>; @@ -66,7 +66,7 @@ pub trait UserRoleInterface { user_id: &str, org_id: &id_type::OrganizationId, merchant_id: &id_type::MerchantId, - profile_id: Option<&String>, + profile_id: Option<&id_type::ProfileId>, version: enums::UserRoleVersion, ) -> CustomResult<storage::UserRole, errors::StorageError>; @@ -75,7 +75,7 @@ pub trait UserRoleInterface { user_id: &str, org_id: Option<&id_type::OrganizationId>, merchant_id: Option<&id_type::MerchantId>, - profile_id: Option<&String>, + profile_id: Option<&id_type::ProfileId>, entity_id: Option<&String>, version: Option<enums::UserRoleVersion>, ) -> CustomResult<Vec<storage::UserRole>, errors::StorageError>; @@ -155,7 +155,7 @@ impl UserRoleInterface for Store { user_id: &str, org_id: &id_type::OrganizationId, merchant_id: &id_type::MerchantId, - profile_id: Option<&String>, + profile_id: Option<&id_type::ProfileId>, version: enums::UserRoleVersion, ) -> CustomResult<storage::UserRole, errors::StorageError> { let conn = connection::pg_connection_write(self).await?; @@ -177,7 +177,7 @@ impl UserRoleInterface for Store { user_id: &str, org_id: &id_type::OrganizationId, merchant_id: &id_type::MerchantId, - profile_id: Option<&String>, + profile_id: Option<&id_type::ProfileId>, update: storage::UserRoleUpdate, version: enums::UserRoleVersion, ) -> CustomResult<storage::UserRole, errors::StorageError> { @@ -201,7 +201,7 @@ impl UserRoleInterface for Store { user_id: &str, org_id: &id_type::OrganizationId, merchant_id: &id_type::MerchantId, - profile_id: Option<&String>, + profile_id: Option<&id_type::ProfileId>, version: enums::UserRoleVersion, ) -> CustomResult<storage::UserRole, errors::StorageError> { let conn = connection::pg_connection_write(self).await?; @@ -222,7 +222,7 @@ impl UserRoleInterface for Store { user_id: &str, org_id: Option<&id_type::OrganizationId>, merchant_id: Option<&id_type::MerchantId>, - profile_id: Option<&String>, + profile_id: Option<&id_type::ProfileId>, entity_id: Option<&String>, version: Option<enums::UserRoleVersion>, ) -> CustomResult<Vec<storage::UserRole>, errors::StorageError> { @@ -377,7 +377,7 @@ impl UserRoleInterface for MockDb { user_id: &str, org_id: &id_type::OrganizationId, merchant_id: &id_type::MerchantId, - profile_id: Option<&String>, + profile_id: Option<&id_type::ProfileId>, version: enums::UserRoleVersion, ) -> CustomResult<storage::UserRole, errors::StorageError> { let user_roles = self.user_roles.lock().await; @@ -416,7 +416,7 @@ impl UserRoleInterface for MockDb { user_id: &str, org_id: &id_type::OrganizationId, merchant_id: &id_type::MerchantId, - profile_id: Option<&String>, + profile_id: Option<&id_type::ProfileId>, update: storage::UserRoleUpdate, version: enums::UserRoleVersion, ) -> CustomResult<storage::UserRole, errors::StorageError> { @@ -470,7 +470,7 @@ impl UserRoleInterface for MockDb { user_id: &str, org_id: &id_type::OrganizationId, merchant_id: &id_type::MerchantId, - profile_id: Option<&String>, + profile_id: Option<&id_type::ProfileId>, version: enums::UserRoleVersion, ) -> CustomResult<storage::UserRole, errors::StorageError> { let mut user_roles = self.user_roles.lock().await; @@ -510,7 +510,7 @@ impl UserRoleInterface for MockDb { user_id: &str, org_id: Option<&id_type::OrganizationId>, merchant_id: Option<&id_type::MerchantId>, - profile_id: Option<&String>, + profile_id: Option<&id_type::ProfileId>, entity_id: Option<&String>, version: Option<enums::UserRoleVersion>, ) -> CustomResult<Vec<storage::UserRole>, errors::StorageError> { diff --git a/crates/router/src/routes/admin.rs b/crates/router/src/routes/admin.rs index 80ee0494847..343246e31a0 100644 --- a/crates/router/src/routes/admin.rs +++ b/crates/router/src/routes/admin.rs @@ -946,7 +946,10 @@ pub async fn business_profile_create( pub async fn business_profile_retrieve( state: web::Data<AppState>, req: HttpRequest, - path: web::Path<(common_utils::id_type::MerchantId, String)>, + path: web::Path<( + common_utils::id_type::MerchantId, + common_utils::id_type::ProfileId, + )>, ) -> HttpResponse { let flow = Flow::BusinessProfileRetrieve; let (merchant_id, profile_id) = path.into_inner(); @@ -975,7 +978,7 @@ pub async fn business_profile_retrieve( pub async fn business_profile_retrieve( state: web::Data<AppState>, req: HttpRequest, - path: web::Path<String>, + path: web::Path<common_utils::id_type::ProfileId>, ) -> HttpResponse { let flow = Flow::BusinessProfileRetrieve; let profile_id = path.into_inner(); @@ -1015,7 +1018,10 @@ pub async fn business_profile_retrieve( pub async fn business_profile_update( state: web::Data<AppState>, req: HttpRequest, - path: web::Path<(common_utils::id_type::MerchantId, String)>, + path: web::Path<( + common_utils::id_type::MerchantId, + common_utils::id_type::ProfileId, + )>, json_payload: web::Json<api_models::admin::BusinessProfileUpdate>, ) -> HttpResponse { let flow = Flow::BusinessProfileUpdate; @@ -1045,7 +1051,7 @@ pub async fn business_profile_update( pub async fn business_profile_update( state: web::Data<AppState>, req: HttpRequest, - path: web::Path<String>, + path: web::Path<common_utils::id_type::ProfileId>, json_payload: web::Json<api_models::admin::BusinessProfileUpdate>, ) -> HttpResponse { let flow = Flow::BusinessProfileUpdate; @@ -1081,7 +1087,10 @@ pub async fn business_profile_update( pub async fn business_profile_delete( state: web::Data<AppState>, req: HttpRequest, - path: web::Path<(common_utils::id_type::MerchantId, String)>, + path: web::Path<( + common_utils::id_type::MerchantId, + common_utils::id_type::ProfileId, + )>, ) -> HttpResponse { let flow = Flow::BusinessProfileDelete; let (merchant_id, profile_id) = path.into_inner(); @@ -1129,7 +1138,10 @@ pub async fn business_profiles_list( pub async fn toggle_connector_agnostic_mit( state: web::Data<AppState>, req: HttpRequest, - path: web::Path<(common_utils::id_type::MerchantId, String)>, + path: web::Path<( + common_utils::id_type::MerchantId, + common_utils::id_type::ProfileId, + )>, json_payload: web::Json<api_models::admin::ConnectorAgnosticMitChoice>, ) -> HttpResponse { let flow = Flow::ToggleConnectorAgnosticMit; @@ -1200,7 +1212,10 @@ pub async fn merchant_account_transfer_keys( pub async fn toggle_extended_card_info( state: web::Data<AppState>, req: HttpRequest, - path: web::Path<(common_utils::id_type::MerchantId, String)>, + path: web::Path<( + common_utils::id_type::MerchantId, + common_utils::id_type::ProfileId, + )>, json_payload: web::Json<api_models::admin::ExtendedCardInfoChoice>, ) -> HttpResponse { let flow = Flow::ToggleExtendedCardInfo; diff --git a/crates/router/src/routes/payments.rs b/crates/router/src/routes/payments.rs index 11cdf4eb7e9..63c40580e53 100644 --- a/crates/router/src/routes/payments.rs +++ b/crates/router/src/routes/payments.rs @@ -1327,7 +1327,7 @@ async fn authorize_verify_select<Op>( state: app::SessionState, req_state: ReqState, merchant_account: domain::MerchantAccount, - profile_id: Option<String>, + profile_id: Option<common_utils::id_type::ProfileId>, key_store: domain::MerchantKeyStore, header_payload: HeaderPayload, req: api_models::payments::PaymentsRequest, diff --git a/crates/router/src/routes/routing.rs b/crates/router/src/routes/routing.rs index 30edfc187b8..93fb2fc0d2d 100644 --- a/crates/router/src/routes/routing.rs +++ b/crates/router/src/routes/routing.rs @@ -96,7 +96,7 @@ pub async fn routing_link_config( pub async fn routing_link_config( state: web::Data<AppState>, req: HttpRequest, - path: web::Path<String>, + path: web::Path<common_utils::id_type::ProfileId>, json_payload: web::Json<routing_types::RoutingAlgorithmId>, transaction_type: &enums::TransactionType, ) -> impl Responder { @@ -209,7 +209,7 @@ pub async fn list_routing_configs( pub async fn routing_unlink_config( state: web::Data<AppState>, req: HttpRequest, - path: web::Path<String>, + path: web::Path<common_utils::id_type::ProfileId>, transaction_type: &enums::TransactionType, ) -> impl Responder { let flow = Flow::RoutingUnlinkConfig; @@ -290,7 +290,7 @@ pub async fn routing_unlink_config( pub async fn routing_update_default_config( state: web::Data<AppState>, req: HttpRequest, - path: web::Path<String>, + path: web::Path<common_utils::id_type::ProfileId>, json_payload: web::Json<Vec<routing_types::RoutableConnectorChoice>>, ) -> impl Responder { let wrapper = routing_types::ProfileDefaultRoutingConfig { @@ -372,7 +372,7 @@ pub async fn routing_update_default_config( pub async fn routing_retrieve_default_config( state: web::Data<AppState>, req: HttpRequest, - path: web::Path<String>, + path: web::Path<common_utils::id_type::ProfileId>, ) -> impl Responder { Box::pin(oss_api::server_wrap( Flow::RoutingRetrieveDefaultConfig, @@ -674,7 +674,7 @@ pub async fn routing_retrieve_linked_config( state: web::Data<AppState>, req: HttpRequest, query: web::Query<RoutingRetrieveQuery>, - path: web::Path<String>, + path: web::Path<common_utils::id_type::ProfileId>, transaction_type: &enums::TransactionType, ) -> impl Responder { use crate::services::authentication::AuthenticationData; @@ -753,7 +753,7 @@ pub async fn routing_retrieve_default_config_for_profiles( pub async fn routing_update_default_config_for_profile( state: web::Data<AppState>, req: HttpRequest, - path: web::Path<String>, + path: web::Path<common_utils::id_type::ProfileId>, json_payload: web::Json<Vec<routing_types::RoutableConnectorChoice>>, transaction_type: &enums::TransactionType, ) -> impl Responder { diff --git a/crates/router/src/services/authentication.rs b/crates/router/src/services/authentication.rs index 9ab2e2e3b07..f1de5528224 100644 --- a/crates/router/src/services/authentication.rs +++ b/crates/router/src/services/authentication.rs @@ -59,14 +59,14 @@ mod detached; pub struct AuthenticationData { pub merchant_account: domain::MerchantAccount, pub key_store: domain::MerchantKeyStore, - pub profile_id: Option<String>, + pub profile_id: Option<id_type::ProfileId>, } #[derive(Clone, Debug)] pub struct AuthenticationDataWithMultipleProfiles { pub merchant_account: domain::MerchantAccount, pub key_store: domain::MerchantKeyStore, - pub profile_id_list: Option<Vec<String>>, + pub profile_id_list: Option<Vec<id_type::ProfileId>>, } #[derive(Clone, Debug, Eq, PartialEq, Serialize)] @@ -195,7 +195,7 @@ pub struct AuthToken { pub role_id: String, pub exp: u64, pub org_id: id_type::OrganizationId, - pub profile_id: Option<String>, + pub profile_id: Option<id_type::ProfileId>, } #[cfg(feature = "olap")] @@ -206,7 +206,7 @@ impl AuthToken { role_id: String, settings: &Settings, org_id: id_type::OrganizationId, - profile_id: Option<String>, + profile_id: Option<id_type::ProfileId>, ) -> UserResult<String> { let exp_duration = std::time::Duration::from_secs(consts::JWT_TOKEN_TIME_IN_SECS); let exp = jwt::generate_exp(exp_duration)?.as_secs(); @@ -228,7 +228,7 @@ pub struct UserFromToken { pub merchant_id: id_type::MerchantId, pub role_id: String, pub org_id: id_type::OrganizationId, - pub profile_id: Option<String>, + pub profile_id: Option<id_type::ProfileId>, } pub struct UserIdFromAuth { diff --git a/crates/router/src/services/kafka/authentication.rs b/crates/router/src/services/kafka/authentication.rs index be3e0933342..42079525d8a 100644 --- a/crates/router/src/services/kafka/authentication.rs +++ b/crates/router/src/services/kafka/authentication.rs @@ -35,7 +35,7 @@ pub struct KafkaAuthentication<'a> { pub acs_reference_number: Option<&'a String>, pub acs_trans_id: Option<&'a String>, pub acs_signed_content: Option<&'a String>, - pub profile_id: &'a String, + pub profile_id: &'a common_utils::id_type::ProfileId, pub payment_id: Option<&'a String>, pub merchant_connector_id: &'a String, pub ds_trans_id: Option<&'a String>, diff --git a/crates/router/src/services/kafka/authentication_event.rs b/crates/router/src/services/kafka/authentication_event.rs index 3f10c7596ac..6213488a6d3 100644 --- a/crates/router/src/services/kafka/authentication_event.rs +++ b/crates/router/src/services/kafka/authentication_event.rs @@ -36,7 +36,7 @@ pub struct KafkaAuthenticationEvent<'a> { pub acs_reference_number: Option<&'a String>, pub acs_trans_id: Option<&'a String>, pub acs_signed_content: Option<&'a String>, - pub profile_id: &'a String, + pub profile_id: &'a common_utils::id_type::ProfileId, pub payment_id: Option<&'a String>, pub merchant_connector_id: &'a String, pub ds_trans_id: Option<&'a String>, diff --git a/crates/router/src/services/kafka/dispute.rs b/crates/router/src/services/kafka/dispute.rs index b4b493a79df..6f789cbe94e 100644 --- a/crates/router/src/services/kafka/dispute.rs +++ b/crates/router/src/services/kafka/dispute.rs @@ -30,7 +30,7 @@ pub struct KafkaDispute<'a> { pub modified_at: OffsetDateTime, pub connector: &'a String, pub evidence: &'a Secret<serde_json::Value>, - pub profile_id: Option<&'a String>, + pub profile_id: Option<&'a common_utils::id_type::ProfileId>, pub merchant_connector_id: Option<&'a String>, } diff --git a/crates/router/src/services/kafka/dispute_event.rs b/crates/router/src/services/kafka/dispute_event.rs index d6cb5d58491..e4254912597 100644 --- a/crates/router/src/services/kafka/dispute_event.rs +++ b/crates/router/src/services/kafka/dispute_event.rs @@ -31,7 +31,7 @@ pub struct KafkaDisputeEvent<'a> { pub modified_at: OffsetDateTime, pub connector: &'a String, pub evidence: &'a Secret<serde_json::Value>, - pub profile_id: Option<&'a String>, + pub profile_id: Option<&'a common_utils::id_type::ProfileId>, pub merchant_connector_id: Option<&'a String>, } diff --git a/crates/router/src/services/kafka/payment_intent.rs b/crates/router/src/services/kafka/payment_intent.rs index 3296956797b..29aa5632837 100644 --- a/crates/router/src/services/kafka/payment_intent.rs +++ b/crates/router/src/services/kafka/payment_intent.rs @@ -33,7 +33,7 @@ pub struct KafkaPaymentIntent<'a> { pub business_country: Option<storage_enums::CountryAlpha2>, pub business_label: Option<&'a String>, pub attempt_count: i16, - pub profile_id: Option<&'a String>, + pub profile_id: Option<&'a id_type::ProfileId>, pub payment_confirm_source: Option<storage_enums::PaymentSource>, pub billing_details: Option<Encryptable<Secret<Value>>>, pub shipping_details: Option<Encryptable<Secret<Value>>>, diff --git a/crates/router/src/services/kafka/payment_intent_event.rs b/crates/router/src/services/kafka/payment_intent_event.rs index f5186a0b2bb..50d2c48a4bd 100644 --- a/crates/router/src/services/kafka/payment_intent_event.rs +++ b/crates/router/src/services/kafka/payment_intent_event.rs @@ -34,7 +34,7 @@ pub struct KafkaPaymentIntentEvent<'a> { pub business_country: Option<storage_enums::CountryAlpha2>, pub business_label: Option<&'a String>, pub attempt_count: i16, - pub profile_id: Option<&'a String>, + pub profile_id: Option<&'a id_type::ProfileId>, pub payment_confirm_source: Option<storage_enums::PaymentSource>, pub billing_details: Option<Encryptable<Secret<Value>>>, pub shipping_details: Option<Encryptable<Secret<Value>>>, diff --git a/crates/router/src/services/kafka/payout.rs b/crates/router/src/services/kafka/payout.rs index ca89a34f18d..08733c46008 100644 --- a/crates/router/src/services/kafka/payout.rs +++ b/crates/router/src/services/kafka/payout.rs @@ -10,7 +10,7 @@ pub struct KafkaPayout<'a> { pub merchant_id: &'a id_type::MerchantId, pub customer_id: Option<&'a id_type::CustomerId>, pub address_id: Option<&'a String>, - pub profile_id: &'a String, + pub profile_id: &'a id_type::ProfileId, pub payout_method_id: Option<&'a String>, pub payout_type: Option<storage_enums::PayoutType>, pub amount: MinorUnit, diff --git a/crates/router/src/types/api/admin.rs b/crates/router/src/types/api/admin.rs index 912cc1c1fad..c959c59badc 100644 --- a/crates/router/src/types/api/admin.rs +++ b/crates/router/src/types/api/admin.rs @@ -250,7 +250,7 @@ pub async fn create_business_profile_from_merchant_account( use crate::core; // Generate a unique profile id - let profile_id = common_utils::generate_id_with_default_len("pro"); + let profile_id = common_utils::generate_profile_id_of_default_length(); let merchant_id = merchant_account.get_id().to_owned(); let current_time = common_utils::date_time::now(); diff --git a/crates/router/src/types/domain/event.rs b/crates/router/src/types/domain/event.rs index 872eb303901..badbb9df7b4 100644 --- a/crates/router/src/types/domain/event.rs +++ b/crates/router/src/types/domain/event.rs @@ -26,7 +26,7 @@ pub struct Event { pub primary_object_type: EventObjectType, pub created_at: time::PrimitiveDateTime, pub merchant_id: Option<common_utils::id_type::MerchantId>, - pub business_profile_id: Option<String>, + pub business_profile_id: Option<common_utils::id_type::ProfileId>, pub primary_object_created_at: Option<time::PrimitiveDateTime>, pub idempotent_event_id: Option<String>, pub initial_attempt_id: Option<String>, diff --git a/crates/router/src/utils.rs b/crates/router/src/utils.rs index ef07ab6a846..7e5f8571340 100644 --- a/crates/router/src/utils.rs +++ b/crates/router/src/utils.rs @@ -467,7 +467,10 @@ pub async fn get_mca_from_payment_intent( .await .to_not_found_response( errors::ApiErrorResponse::MerchantConnectorAccountNotFound { - id: format!("profile_id {profile_id} and connector_name {connector_name}"), + id: format!( + "profile_id {} and connector_name {connector_name}", + profile_id.get_string_repr() + ), }, ) } @@ -556,7 +559,8 @@ pub async fn get_mca_from_payout_attempt( errors::ApiErrorResponse::MerchantConnectorAccountNotFound { id: format!( "profile_id {} and connector_name {}", - payout.profile_id, connector_name + payout.profile_id.get_string_repr(), + connector_name ), }, ) @@ -603,7 +607,10 @@ pub async fn get_mca_from_object_reference_id( .await .to_not_found_response( errors::ApiErrorResponse::MerchantConnectorAccountNotFound { - id: format!("profile_id {profile_id} and connector_name {connector_name}"), + id: format!( + "profile_id {} and connector_name {connector_name}", + profile_id.get_string_repr() + ), }, ) } diff --git a/crates/router/src/utils/user.rs b/crates/router/src/utils/user.rs index 1de45b74360..30a0e1ca788 100644 --- a/crates/router/src/utils/user.rs +++ b/crates/router/src/utils/user.rs @@ -114,7 +114,7 @@ pub async fn generate_jwt_auth_token_with_custom_role_attributes( merchant_id: id_type::MerchantId, org_id: id_type::OrganizationId, role_id: String, - profile_id: Option<String>, + profile_id: Option<id_type::ProfileId>, ) -> UserResult<Secret<String>> { let token = AuthToken::new_token( user.get_user_id().to_string(), diff --git a/crates/router/src/utils/user_role.rs b/crates/router/src/utils/user_role.rs index 7aebbe1bbcf..792a79c91eb 100644 --- a/crates/router/src/utils/user_role.rs +++ b/crates/router/src/utils/user_role.rs @@ -182,7 +182,7 @@ pub async fn update_v1_and_v2_user_roles_in_db( user_id: &str, org_id: &id_type::OrganizationId, merchant_id: &id_type::MerchantId, - profile_id: Option<&String>, + profile_id: Option<&id_type::ProfileId>, update: UserRoleUpdate, ) -> ( Result<UserRole, Report<StorageError>>, diff --git a/crates/router/src/workflows/payment_sync.rs b/crates/router/src/workflows/payment_sync.rs index c536ec7e4e9..207af2ea4bf 100644 --- a/crates/router/src/workflows/payment_sync.rs +++ b/crates/router/src/workflows/payment_sync.rs @@ -177,7 +177,7 @@ impl ProcessTrackerWorkflow<SessionState> for PaymentsSyncWorkflow { .await .to_not_found_response( errors::ApiErrorResponse::BusinessProfileNotFound { - id: profile_id.to_string(), + id: profile_id.get_string_repr().to_owned(), }, )?; diff --git a/crates/storage_impl/src/payouts/payout_attempt.rs b/crates/storage_impl/src/payouts/payout_attempt.rs index aba6f2016ba..08843a060a7 100644 --- a/crates/storage_impl/src/payouts/payout_attempt.rs +++ b/crates/storage_impl/src/payouts/payout_attempt.rs @@ -60,7 +60,6 @@ impl<T: DatabaseStore> PayoutAttemptInterface for KVRouterStore<T> { payout_attempt_id: &payout_attempt_id, }; let key_str = key.to_string(); - let now = common_utils::date_time::now(); let created_attempt = PayoutAttempt { payout_attempt_id: new_payout_attempt.payout_attempt_id.clone(), payout_id: new_payout_attempt.payout_id.clone(), @@ -76,8 +75,8 @@ impl<T: DatabaseStore> PayoutAttemptInterface for KVRouterStore<T> { error_code: new_payout_attempt.error_code.clone(), business_country: new_payout_attempt.business_country, business_label: new_payout_attempt.business_label.clone(), - created_at: new_payout_attempt.created_at.unwrap_or(now), - last_modified_at: new_payout_attempt.last_modified_at.unwrap_or(now), + created_at: new_payout_attempt.created_at, + last_modified_at: new_payout_attempt.last_modified_at, profile_id: new_payout_attempt.profile_id.clone(), merchant_connector_id: new_payout_attempt.merchant_connector_id.clone(), routing_info: new_payout_attempt.routing_info.clone(), diff --git a/crates/storage_impl/src/payouts/payouts.rs b/crates/storage_impl/src/payouts/payouts.rs index 680d535a652..45227092b48 100644 --- a/crates/storage_impl/src/payouts/payouts.rs +++ b/crates/storage_impl/src/payouts/payouts.rs @@ -87,7 +87,6 @@ impl<T: DatabaseStore> PayoutsInterface for KVRouterStore<T> { }; let key_str = key.to_string(); let field = format!("po_{}", new.payout_id); - let now = common_utils::date_time::now(); let created_payout = Payouts { payout_id: new.payout_id.clone(), merchant_id: new.merchant_id.clone(), @@ -104,8 +103,8 @@ impl<T: DatabaseStore> PayoutsInterface for KVRouterStore<T> { return_url: new.return_url.clone(), entity_type: new.entity_type, metadata: new.metadata.clone(), - created_at: new.created_at.unwrap_or(now), - last_modified_at: new.last_modified_at.unwrap_or(now), + created_at: new.created_at, + last_modified_at: new.last_modified_at, profile_id: new.profile_id.clone(), status: new.status, attempt_count: new.attempt_count, @@ -932,10 +931,8 @@ impl DataModelExt for PayoutsNew { return_url: self.return_url, entity_type: self.entity_type, metadata: self.metadata, - created_at: self.created_at.unwrap_or_else(common_utils::date_time::now), - last_modified_at: self - .last_modified_at - .unwrap_or_else(common_utils::date_time::now), + created_at: self.created_at, + last_modified_at: self.last_modified_at, profile_id: self.profile_id, status: self.status, attempt_count: self.attempt_count, @@ -963,8 +960,8 @@ impl DataModelExt for PayoutsNew { return_url: storage_model.return_url, entity_type: storage_model.entity_type, metadata: storage_model.metadata, - created_at: Some(storage_model.created_at), - last_modified_at: Some(storage_model.last_modified_at), + created_at: storage_model.created_at, + last_modified_at: storage_model.last_modified_at, profile_id: storage_model.profile_id, status: storage_model.status, attempt_count: storage_model.attempt_count, diff --git a/scripts/ci-checks-v2.sh b/scripts/ci-checks-v2.sh index 151e5a382d0..93bd2921a38 100755 --- a/scripts/ci-checks-v2.sh +++ b/scripts/ci-checks-v2.sh @@ -1,8 +1,7 @@ #!/usr/bin/env bash set -euo pipefail -crates_to_check=\ -'api_models +crates_to_check='api_models diesel_models hyperswitch_domain_models storage_impl' @@ -38,7 +37,7 @@ if [[ "${GITHUB_EVENT_NAME:-}" == 'pull_request' ]]; then # A package must be checked if it has been modified if grep --quiet --extended-regexp "^crates/${package_name}" <<< "${files_modified}"; then if [[ "${package_name}" == "storage_impl" ]]; then - all_commands+=("cargo hack clippy --features 'v2,payment_v2,customer_v2,payment_methods_v2' -p storage_impl") + all_commands+=("cargo hack clippy --features 'v2,payment_v2,customer_v2' -p storage_impl") else valid_features="$(features_to_run "$package_name")" all_commands+=("cargo hack clippy --feature-powerset --depth 2 --ignore-unknown-features --at-least-one-of 'v2 ' --include-features '${valid_features}' --package '${package_name}'") @@ -54,7 +53,7 @@ if [[ "${GITHUB_EVENT_NAME:-}" == 'pull_request' ]]; then else # If we are doing this locally or on merge queue, then check for all the V2 crates - all_commands+=("cargo hack clippy --features 'v2,payment_v2' -p storage_impl") + all_commands+=("cargo hack clippy --features 'v2,payment_v2,customer_v2' -p storage_impl") common_command="cargo hack clippy --feature-powerset --depth 2 --ignore-unknown-features --at-least-one-of 'v2 '" while IFS= read -r crate; do if [[ "${crate}" != "storage_impl" ]]; then

2024-08-25T11:36:59Z

## Type of Change  - [ ] Bugfix - [ ] New feature - [ ] Enhancement - [x] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  This PR introduces a domain type for profile ID and refactors the existing code to use the domain type in place of strings being used today. In addition, this PR has the following changes: - Introduces a trait `GenerateId` for generating IDs. - Removes the `Default` implementation on `PayoutsNew` and `PayoutAttemptNew` types defined in the `hyperswitch_domain_models` crate, since the `ProfileId` type does not implement `Default`. ### Additional Changes - [x] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  This PR has no new contract changes, this PR only updates the merchant connector account create request in the OpenAPI documentation to include the maximum character length restriction placed on the `profile_id` field. ## Motivation and Context  Using a domain type should help better enforce restrictions like minimum and maximum character restrictions, and should help prevent from incorrect values being passed around (to some extent). ## How did you test it?  Sanity testing with Postman.  ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.111.0

963a2547e87fc7a4e8ed55627d3e7b9da2022f21

juspay/hyperswitch

juspay__hyperswitch-8614

Bug: Add support to call decision engine PL Routing from hyperswitch after API key authentication

diff --git a/crates/router/src/core/payments/routing/utils.rs b/crates/router/src/core/payments/routing/utils.rs index d217cc04360..d373b4188b1 100644 --- a/crates/router/src/core/payments/routing/utils.rs +++ b/crates/router/src/core/payments/routing/utils.rs @@ -690,6 +690,7 @@ pub struct RoutingEvaluateRequest { pub parameters: HashMap<String, Option<ValueType>>, pub fallback_output: Vec<DeRoutableConnectorChoice>, } +impl common_utils::events::ApiEventMetric for RoutingEvaluateRequest {} #[derive(Debug, serde::Serialize, serde::Deserialize, Clone)] pub struct RoutingEvaluateResponse { @@ -700,7 +701,7 @@ pub struct RoutingEvaluateResponse { #[serde(deserialize_with = "deserialize_connector_choices")] pub eligible_connectors: Vec<RoutableConnectorChoice>, } - +impl common_utils::events::ApiEventMetric for RoutingEvaluateResponse {} /// Routable Connector chosen for a payment #[derive(Debug, Clone, PartialEq, serde::Serialize, serde::Deserialize)] pub struct DeRoutableConnectorChoice { diff --git a/crates/router/src/routes/app.rs b/crates/router/src/routes/app.rs index 9935ab5fd9f..e3070077e94 100644 --- a/crates/router/src/routes/app.rs +++ b/crates/router/src/routes/app.rs @@ -1093,6 +1093,10 @@ impl Routing { routing::routing_link_config(state, req, path, payload, None) }, )), + ) + .service( + web::resource("/rule/evaluate") + .route(web::post().to(routing::evaluate_routing_rule)), ); route } diff --git a/crates/router/src/routes/lock_utils.rs b/crates/router/src/routes/lock_utils.rs index fa616a3da3e..8fb15df6fab 100644 --- a/crates/router/src/routes/lock_utils.rs +++ b/crates/router/src/routes/lock_utils.rs @@ -80,6 +80,7 @@ impl From<Flow> for ApiIdentifier { | Flow::ToggleDynamicRouting | Flow::UpdateDynamicRoutingConfigs | Flow::DecisionManagerUpsertConfig + | Flow::RoutingEvaluateRule | Flow::DecisionEngineRuleMigration | Flow::VolumeSplitOnRoutingType => Self::Routing, diff --git a/crates/router/src/routes/routing.rs b/crates/router/src/routes/routing.rs index d247a8af6ea..024d4c0cfbe 100644 --- a/crates/router/src/routes/routing.rs +++ b/crates/router/src/routes/routing.rs @@ -8,6 +8,7 @@ use api_models::{ enums, routing::{self as routing_types, RoutingRetrieveQuery}, }; +use error_stack::ResultExt; use hyperswitch_domain_models::merchant_context::MerchantKeyStore; use payment_methods::core::errors::ApiErrorResponse; use router_env::{ @@ -16,9 +17,17 @@ use router_env::{ }; use crate::{ - core::{api_locking, conditional_config, routing, surcharge_decision_config}, + core::{ + api_locking, conditional_config, + payments::routing::utils::{ + DecisionEngineApiHandler, EuclidApiClient, RoutingEvaluateRequest, + RoutingEvaluateResponse, + }, + routing, surcharge_decision_config, + }, db::errors::StorageErrorExt, routes::AppState, + services, services::{api as oss_api, authentication as auth, authorization::permissions::Permission}, types::domain, }; @@ -1564,6 +1573,47 @@ pub async fn get_dynamic_routing_volume_split( )) .await } +const EUCLID_API_TIMEOUT: u64 = 5; +#[cfg(all(feature = "olap", feature = "v1"))] +#[instrument(skip_all)] +pub async fn evaluate_routing_rule( + state: web::Data<AppState>, + req: HttpRequest, + json_payload: web::Json<RoutingEvaluateRequest>, +) -> impl Responder { + let json_payload = json_payload.into_inner(); + let flow = Flow::RoutingEvaluateRule; + Box::pin(oss_api::server_wrap( + flow, + state, + &req, + json_payload.clone(), + |state, _auth: auth::AuthenticationData, payload, _| async move { + let euclid_response: RoutingEvaluateResponse = + EuclidApiClient::send_decision_engine_request( + &state, + services::Method::Post, + "routing/evaluate", + Some(payload), + Some(EUCLID_API_TIMEOUT), + None, + ) + .await + .change_context(ApiErrorResponse::InternalServerError)? + .response + .ok_or(ApiErrorResponse::InternalServerError) + .attach_printable("Failed to evaluate routing rule")?; + + Ok(services::ApplicationResponse::Json(euclid_response)) + }, + &auth::ApiKeyAuth { + is_connected_allowed: false, + is_platform_allowed: false, + }, + api_locking::LockAction::NotApplicable, + )) + .await +} use actix_web::HttpResponse; #[instrument(skip_all, fields(flow = ?Flow::DecisionEngineRuleMigration))] @@ -1591,7 +1641,7 @@ pub async fn migrate_routing_rules_for_profile( query_params, )) .await?; - Ok(crate::services::ApplicationResponse::Json(res)) + Ok(services::ApplicationResponse::Json(res)) }, &auth::AdminApiAuth, api_locking::LockAction::NotApplicable, diff --git a/crates/router_env/src/logger/types.rs b/crates/router_env/src/logger/types.rs index d395cd1f6da..20ae48484d5 100644 --- a/crates/router_env/src/logger/types.rs +++ b/crates/router_env/src/logger/types.rs @@ -550,6 +550,8 @@ pub enum Flow { PaymentStartRedirection, /// Volume split on the routing type VolumeSplitOnRoutingType, + /// Routing evaluate rule flow + RoutingEvaluateRule, /// Relay flow Relay, /// Relay retrieve flow

2025-07-15T12:45:54Z

## Type of Change  - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  This PR adds the routing rule evaluation endpoint to Hyperswitch, which calls the decision engine Added `evaluate_routing_rule` function, which calls `send_decision_engine_request` with `ApiKeyAuth` auth ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  ## How did you test it?  Curl ``` curl --location 'http://localhost:8080/routing/rule/evaluate' \ --header 'Content-Type: application/json' \ --header 'api-key: dev_Zgz3AVVEqf4l1IZtWu******tLXfe0CcbUmdQ3Ol91gfvt0aytHG5C2FXmCxc' \ --data '{ "created_by":"merchant_1752591820", "parameters": { "payment_method": { "type": "enum_variant", "value": "upi"}, "amount": { "type": "number","value": 100} }, "fallback_output": [ { "gateway_name": "cybersource", "gateway_id": "mca_51nE*****0cuknbQRaWz" } ] }' ``` Response ``` { "status": "default_selection", "output": { "type": "priority", "connectors": [ { "gateway_name": "stripe", "gateway_id": "mca_111" }, { "gateway_name": "adyen", "gateway_id": "mca_112" }, { "gateway_name": "checkout", "gateway_id": "mca_113" } ] }, "evaluated_output": [ { "gateway_name": "stripe", "gateway_id": "mca_111" } ], "eligible_connectors": [] } ``` **Logs at Decision-engine** <img width="1944" height="838" alt="image" src="https://github.com/user-attachments/assets/e9347077-916a-4dc7-9a9e-a0765067f2b4" /> **Logs at Hyperswitch** <img width="1789" height="791" alt="image" src="https://github.com/user-attachments/assets/1fdab0fe-36ab-4ef8-be16-d2b2c261b864" /> ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

a6f4d7267f9d324096c112d824ba79fcaaa9648b

juspay/hyperswitch

juspay__hyperswitch-8613

Bug: Add support to call decision engine Dynamic Routing from hyperswitch after API key authentication

diff --git a/crates/api_models/src/events/routing.rs b/crates/api_models/src/events/routing.rs index 62bc49dbe1b..9f09bac8274 100644 --- a/crates/api_models/src/events/routing.rs +++ b/crates/api_models/src/events/routing.rs @@ -178,3 +178,27 @@ impl ApiEventMetric for RuleMigrationError { Some(ApiEventsType::Routing) } } + +impl ApiEventMetric for crate::open_router::DecideGatewayResponse { + fn get_api_event_type(&self) -> Option<ApiEventsType> { + Some(ApiEventsType::Routing) + } +} + +impl ApiEventMetric for crate::open_router::OpenRouterDecideGatewayRequest { + fn get_api_event_type(&self) -> Option<ApiEventsType> { + Some(ApiEventsType::Routing) + } +} + +impl ApiEventMetric for crate::open_router::UpdateScorePayload { + fn get_api_event_type(&self) -> Option<ApiEventsType> { + Some(ApiEventsType::Routing) + } +} + +impl ApiEventMetric for crate::open_router::UpdateScoreResponse { + fn get_api_event_type(&self) -> Option<ApiEventsType> { + Some(ApiEventsType::Routing) + } +} diff --git a/crates/api_models/src/open_router.rs b/crates/api_models/src/open_router.rs index f5b80383bfb..aefbd3eb211 100644 --- a/crates/api_models/src/open_router.rs +++ b/crates/api_models/src/open_router.rs @@ -26,6 +26,41 @@ pub struct OpenRouterDecideGatewayRequest { pub elimination_enabled: Option<bool>, } +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct DecideGatewayResponse { + pub decided_gateway: Option<String>, + pub gateway_priority_map: Option<serde_json::Value>, + pub filter_wise_gateways: Option<serde_json::Value>, + pub priority_logic_tag: Option<String>, + pub routing_approach: Option<String>, + pub gateway_before_evaluation: Option<String>, + pub priority_logic_output: Option<PriorityLogicOutput>, + pub reset_approach: Option<String>, + pub routing_dimension: Option<String>, + pub routing_dimension_level: Option<String>, + pub is_scheduled_outage: Option<bool>, + pub is_dynamic_mga_enabled: Option<bool>, + pub gateway_mga_id_map: Option<serde_json::Value>, +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct PriorityLogicOutput { + pub is_enforcement: Option<bool>, + pub gws: Option<Vec<String>>, + pub priority_logic_tag: Option<String>, + pub gateway_reference_ids: Option<HashMap<String, String>>, + pub primary_logic: Option<PriorityLogicData>, + pub fallback_logic: Option<PriorityLogicData>, +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct PriorityLogicData { + pub name: Option<String>, + pub status: Option<String>, + pub failure_reason: Option<String>, +} + #[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] #[serde(rename_all = "SCREAMING_SNAKE_CASE")] pub enum RankingAlgorithm { diff --git a/crates/router/src/core/payments/routing/utils.rs b/crates/router/src/core/payments/routing/utils.rs index d373b4188b1..5eb929a92d0 100644 --- a/crates/router/src/core/payments/routing/utils.rs +++ b/crates/router/src/core/payments/routing/utils.rs @@ -1232,7 +1232,7 @@ where String(String), } -#[derive(Debug)] +#[derive(Debug, Serialize)] pub struct RoutingEventsResponse<Res> where Res: Serialize + serde::de::DeserializeOwned + Clone, diff --git a/crates/router/src/core/routing.rs b/crates/router/src/core/routing.rs index 806a01235f3..2e6f8b09775 100644 --- a/crates/router/src/core/routing.rs +++ b/crates/router/src/core/routing.rs @@ -5,7 +5,12 @@ use std::collections::HashSet; #[cfg(all(feature = "v1", feature = "dynamic_routing"))] use api_models::routing::DynamicRoutingAlgoAccessor; use api_models::{ - enums, mandates as mandates_api, routing, + enums, mandates as mandates_api, + open_router::{ + DecideGatewayResponse, OpenRouterDecideGatewayRequest, UpdateScorePayload, + UpdateScoreResponse, + }, + routing, routing::{ self as routing_types, RoutingRetrieveQuery, RuleMigrationError, RuleMigrationResponse, }, @@ -13,6 +18,7 @@ use api_models::{ use async_trait::async_trait; #[cfg(all(feature = "v1", feature = "dynamic_routing"))] use common_utils::ext_traits::AsyncExt; +use common_utils::request::Method; use diesel_models::routing_algorithm::RoutingAlgorithm; use error_stack::ResultExt; #[cfg(all(feature = "v1", feature = "dynamic_routing"))] @@ -2621,3 +2627,59 @@ pub async fn migrate_rules_for_profile( errors: error_list, }) } + +pub async fn decide_gateway_open_router( + state: SessionState, + req_body: OpenRouterDecideGatewayRequest, +) -> RouterResponse<DecideGatewayResponse> { + let response = if state.conf.open_router.dynamic_routing_enabled { + SRApiClient::send_decision_engine_request( + &state, + Method::Post, + "decide-gateway", + Some(req_body), + None, + None, + ) + .await + .change_context(errors::ApiErrorResponse::InternalServerError)? + .response + .ok_or(errors::ApiErrorResponse::InternalServerError) + .attach_printable("Failed to perform decide gateway call with open router")? + } else { + Err(errors::ApiErrorResponse::InternalServerError) + .attach_printable("Dynamic routing is not enabled")? + }; + + Ok(hyperswitch_domain_models::api::ApplicationResponse::Json( + response, + )) +} + +pub async fn update_gateway_score_open_router( + state: SessionState, + req_body: UpdateScorePayload, +) -> RouterResponse<UpdateScoreResponse> { + let response = if state.conf.open_router.dynamic_routing_enabled { + SRApiClient::send_decision_engine_request( + &state, + Method::Post, + "update-gateway-score", + Some(req_body), + None, + None, + ) + .await + .change_context(errors::ApiErrorResponse::InternalServerError)? + .response + .ok_or(errors::ApiErrorResponse::InternalServerError) + .attach_printable("Failed to perform update gateway score call with open router")? + } else { + Err(errors::ApiErrorResponse::InternalServerError) + .attach_printable("Dynamic routing is not enabled")? + }; + + Ok(hyperswitch_domain_models::api::ApplicationResponse::Json( + response, + )) +} diff --git a/crates/router/src/routes/app.rs b/crates/router/src/routes/app.rs index cd132f0da63..e7127f43e87 100644 --- a/crates/router/src/routes/app.rs +++ b/crates/router/src/routes/app.rs @@ -973,6 +973,19 @@ impl Routing { })), ); + #[cfg(feature = "dynamic_routing")] + { + route = route + .service( + web::resource("/evaluate") + .route(web::post().to(routing::call_decide_gateway_open_router)), + ) + .service( + web::resource("/feedback") + .route(web::post().to(routing::call_update_gateway_score_open_router)), + ) + } + #[cfg(feature = "payouts")] { route = route diff --git a/crates/router/src/routes/lock_utils.rs b/crates/router/src/routes/lock_utils.rs index fda52ad9b0d..ab1e7bb1030 100644 --- a/crates/router/src/routes/lock_utils.rs +++ b/crates/router/src/routes/lock_utils.rs @@ -83,7 +83,9 @@ impl From<Flow> for ApiIdentifier { | Flow::DecisionManagerUpsertConfig | Flow::RoutingEvaluateRule | Flow::DecisionEngineRuleMigration - | Flow::VolumeSplitOnRoutingType => Self::Routing, + | Flow::VolumeSplitOnRoutingType + | Flow::DecisionEngineDecideGatewayCall + | Flow::DecisionEngineGatewayFeedbackCall => Self::Routing, Flow::RetrieveForexFlow => Self::Forex, diff --git a/crates/router/src/routes/routing.rs b/crates/router/src/routes/routing.rs index 024d4c0cfbe..ffd5c265db0 100644 --- a/crates/router/src/routes/routing.rs +++ b/crates/router/src/routes/routing.rs @@ -1672,3 +1672,51 @@ async fn get_merchant_account( .to_not_found_response(ApiErrorResponse::MerchantAccountNotFound)?; Ok((key_store, merchant_account)) } + +#[cfg(all(feature = "olap", feature = "v1", feature = "dynamic_routing"))] +#[instrument(skip_all)] +pub async fn call_decide_gateway_open_router( + state: web::Data<AppState>, + req: HttpRequest, + payload: web::Json<api_models::open_router::OpenRouterDecideGatewayRequest>, +) -> impl Responder { + let flow = Flow::DecisionEngineDecideGatewayCall; + Box::pin(oss_api::server_wrap( + flow, + state, + &req, + payload.clone(), + |state, _auth, payload, _| routing::decide_gateway_open_router(state.clone(), payload), + &auth::ApiKeyAuth { + is_connected_allowed: false, + is_platform_allowed: false, + }, + api_locking::LockAction::NotApplicable, + )) + .await +} + +#[cfg(all(feature = "olap", feature = "v1", feature = "dynamic_routing"))] +#[instrument(skip_all)] +pub async fn call_update_gateway_score_open_router( + state: web::Data<AppState>, + req: HttpRequest, + payload: web::Json<api_models::open_router::UpdateScorePayload>, +) -> impl Responder { + let flow = Flow::DecisionEngineGatewayFeedbackCall; + Box::pin(oss_api::server_wrap( + flow, + state, + &req, + payload.clone(), + |state, _auth, payload, _| { + routing::update_gateway_score_open_router(state.clone(), payload) + }, + &auth::ApiKeyAuth { + is_connected_allowed: false, + is_platform_allowed: false, + }, + api_locking::LockAction::NotApplicable, + )) + .await +} diff --git a/crates/router_env/src/logger/types.rs b/crates/router_env/src/logger/types.rs index 155c5223375..d00d0f4e622 100644 --- a/crates/router_env/src/logger/types.rs +++ b/crates/router_env/src/logger/types.rs @@ -612,6 +612,10 @@ pub enum Flow { ThreeDsDecisionRuleExecute, /// Incoming Network Token Webhook Receive IncomingNetworkTokenWebhookReceive, + /// Decision Engine Decide Gateway Call + DecisionEngineDecideGatewayCall, + /// Decision Engine Gateway Feedback Call + DecisionEngineGatewayFeedbackCall, } /// Trait for providing generic behaviour to flow metric

2025-07-15T08:27:49Z

## Type of Change  - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  This PR adds API key auth to the decision engine endpoints for the decide gateway call and the update gateway score call. ### Additional Changes - [x] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  Closes #8613 ## How did you test it?  <details> <summary>decide-gateway</summary> curl --location 'http://localhost:8080/routing/evaluate' \ --header 'Content-Type: application/json' \ --header 'api-key: dev_UnrorzUwWmt9GUkRTalEmIjrWu3JwKNh8TkSZmMJ2Fsm***** \ --data '{ "merchantId": "pro_VTQjooFPAyPOBC0aj9Jk", "eligibleGatewayList": ["GatewayA", "GatewayB", "GatewayC"], "rankingAlgorithm": "SR_BASED_ROUTING", "eliminationEnabled": true, "paymentInfo": { "paymentId": "PAY12359", "amount": 100, "currency": "USD", "customerId": "CUST12345", "udfs": null, "preferredGateway": null, "paymentType": "ORDER_PAYMENT", "metadata": null, "internalMetadata": null, "isEmi": false, "emiBank": null, "emiTenure": null, "paymentMethodType": "credit", "paymentMethod": "card", "paymentSource": null, "authType": null, "cardIssuerBankName": null, "cardIsin": null, "cardType": null, "cardSwitchProvider": null } }' </details> <details> <summary>response</summary> { "decided_gateway": "GatewayA", "gateway_priority_map": { "GatewayA": 1.0, "GatewayB": 1.0, "GatewayC": 1.0 }, "filter_wise_gateways": null, "priority_logic_tag": null, "routing_approach": "SR_SELECTION_V3_ROUTING", "gateway_before_evaluation": "GatewayC", "priority_logic_output": { "isEnforcement": false, "gws": [ "GatewayA", "GatewayB", "GatewayC" ], "priorityLogicTag": null, "gatewayReferenceIds": {}, "primaryLogic": null, "fallbackLogic": null }, "reset_approach": "NO_RESET", "routing_dimension": "ORDER_PAYMENT, CREDIT, card", "routing_dimension_level": "PM_LEVEL", "is_scheduled_outage": false, "is_dynamic_mga_enabled": false, "gateway_mga_id_map": null } </details> --- <details> <summary>update-gateway-score</summary> curl --location 'http://localhost:8080/routing/feedback' \ --header 'Content-Type: application/json' \ --header 'api-key: dev_UnrorzUwWmt9GUkRTalEmIjrWu3JwKNh8TkSZmMJ2Fs******' \ --data '{ "merchantId" : "pro_VTQjooFPAyPOBC0aj9Jk", "gateway": "GatewayC", "gatewayReferenceId": null, "status": "FAILURE", "paymentId": "PAY12359", "enforceDynamicRoutingFailure" : null }' </details> <details> <summary>response</summary> { "message": "Success" } </details> ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

126018e217bfbd8bdd44043ace8a815046193818

juspay/hyperswitch

juspay__hyperswitch-8601

Bug: Deleting a user role and again assigning a role to user is not updating its previous role to new role Role id is not getting updated in the invited user account in case the role is deleted and assigned again to invited user. This is happening due to the lineage context stored in db not updating the role id in case that role id does not exist any more. Steps to duplicate this edge case: 1. Invite a user with any user role 2. Accept the invitation and login to invited user account 3. Delete the user role from the account who invited the user 4. Assign a user role, then try to login to the invited account 5. Invited account still operates on the previous user role because of the lineage context getting stored in db

diff --git a/crates/router/src/types/domain/user/decision_manager.rs b/crates/router/src/types/domain/user/decision_manager.rs index 7bc11383da0..15d5463ecff 100644 --- a/crates/router/src/types/domain/user/decision_manager.rs +++ b/crates/router/src/types/domain/user/decision_manager.rs @@ -158,7 +158,11 @@ impl JWTFlow { UserRoleVersion::V2, ) .await - .is_ok(); + .inspect_err(|e| { + logger::error!("Failed to validate V2 role: {e:?}"); + }) + .map(|role| role.role_id == ctx.role_id) + .unwrap_or_default(); if user_role_match_v2 { ctx @@ -174,7 +178,11 @@ impl JWTFlow { UserRoleVersion::V1, ) .await - .is_ok(); + .inspect_err(|e| { + logger::error!("Failed to validate V1 role: {e:?}"); + }) + .map(|role| role.role_id == ctx.role_id) + .unwrap_or_default(); if user_role_match_v1 { ctx

2025-07-09T15:17:58Z

## Type of Change  - [x] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  This PR fixes an issue where a stale `role_id` from the cached `lineage_context` was being used to generate the JWT token during sign-in, even if the actual user role was modified (e.g., role deleted and recreated with a different `role_id` but same lineage). Previously, we only validated if a user role existed for the lineage (`user_id`, `tenant_id`, `org_id`, `merchant_id`, `profile_id`), but **did not verify that the `role_id` matched** the current assigned role. This led to JWTs being issued with outdated `role_id` values. ### Changes Made - During sign-in, added a strict match check for `role_id` in the fetched user role. - If the `role_id` from cached `lineage_context` does not match the current role fetched from DB (v2 fallback to v1), we now **resolve the lineage afresh from the current `user_role` object**. - Logged errors for failed role fetch attempts for better traceability. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  In systems where roles can be modified dynamically (e.g., deleted and recreated), relying on cached `lineage_context.role_id` without validating it introduces a silent inconsistency. This can lead to: - Unexpected authorization behavior - Hard-to-debug permission issues - Stale tokens being issued This fix ensures that JWTs are always generated using valid and current `role_id` information associated with the user role. ## How did you test it?  #### Scenario: Validate fallback when `role_id` has changed 1. **Initial Setup** - Log in as an `org_admin` of **Org A**. - Invite **User X** to **Org A** with the role `org_admin`. - Ensure **User X** is also part of another organization (**Org B**) and has a valid user role there. 2. **Initial Sign-In** - Sign in as **User X** to **Org A**, selecting a specific merchant and profile. - This populates and stores the `lineage_context` based on the selected values. 3. **Modify Role Assignment** - Log back in as the original `org_admin` of **Org A**. - Delete the current user role (`org_admin`) of **User X** in **Org A**. - Create a new role in **Org A** named `profile_admin` using the **same merchant and profile** from the stored `lineage_context`. - Re-invite **User X** to **Org A** with this new `profile_admin` role. 4. **Re-Sign-In Validation** - Now sign in again as **User X**. - Since the original role (`org_admin`) no longer exists, the cached lineage context will fail validation. - The system should fall back to the default sign-in flow and pick a valid user role for JWT construction. 5. **Verify Correct Role Assignment** - If sign-in occurs into a **different organization**, it's acceptable. - If signed into **Org A**, validate the `role_id`: - Check the response from `/user` API. - OR decode the JWT token. - The `role_id` should now correctly reflect `profile_admin`. ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [x] I added unit tests for my changes where possible

v1.115.0

99885b699d7524e87697f78608e6f2b36c9d8a8e

juspay/hyperswitch

juspay__hyperswitch-8604

Bug: add apple pay decrypt support for Adyen add apple pay decrypt support for Adyen

diff --git a/crates/connector_configs/toml/development.toml b/crates/connector_configs/toml/development.toml index cdf94d6e439..77fb8141c0f 100644 --- a/crates/connector_configs/toml/development.toml +++ b/crates/connector_configs/toml/development.toml @@ -286,7 +286,7 @@ label="Payment Processing Details At" placeholder="Enter Payment Processing Details At" required=true type="Radio" -options=["Connector"] +options=["Connector", "Hyperswitch"] [[adyen.metadata.google_pay]] name="merchant_name" diff --git a/crates/connector_configs/toml/production.toml b/crates/connector_configs/toml/production.toml index b9a98f5aedd..cf9c19fcaba 100644 --- a/crates/connector_configs/toml/production.toml +++ b/crates/connector_configs/toml/production.toml @@ -192,7 +192,7 @@ label="Payment Processing Details At" placeholder="Enter Payment Processing Details At" required=true type="Radio" -options=["Connector"] +options=["Connector", "Hyperswitch"] [[adyen.metadata.google_pay]] name="merchant_name" diff --git a/crates/connector_configs/toml/sandbox.toml b/crates/connector_configs/toml/sandbox.toml index 21801d380b5..28aca80b17b 100644 --- a/crates/connector_configs/toml/sandbox.toml +++ b/crates/connector_configs/toml/sandbox.toml @@ -284,7 +284,7 @@ label="Payment Processing Details At" placeholder="Enter Payment Processing Details At" required=true type="Radio" -options=["Connector"] +options=["Connector", "Hyperswitch"] [[adyen.metadata.google_pay]] name="merchant_name" diff --git a/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs b/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs index 8f4d667711b..f435338f22f 100644 --- a/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs @@ -57,9 +57,10 @@ use crate::{ SubmitEvidenceRouterData, }, utils::{ - self, is_manual_capture, missing_field_err, AddressDetailsData, BrowserInformationData, - CardData, ForeignTryFrom, NetworkTokenData as UtilsNetworkTokenData, - PaymentsAuthorizeRequestData, PhoneDetailsData, RouterData as OtherRouterData, + self, is_manual_capture, missing_field_err, AddressDetailsData, ApplePayDecrypt, + BrowserInformationData, CardData, ForeignTryFrom, + NetworkTokenData as UtilsNetworkTokenData, PaymentsAuthorizeRequestData, PhoneDetailsData, + RouterData as OtherRouterData, }, }; @@ -309,7 +310,8 @@ struct AdyenSplitData { struct AdyenMpiData { directory_response: String, authentication_response: String, - token_authentication_verification_value: Secret<String>, + cavv: Option<Secret<String>>, + token_authentication_verification_value: Option<Secret<String>>, eci: Option<String>, } @@ -675,6 +677,7 @@ pub enum AdyenPaymentMethod<'a> { #[serde(rename = "alipay_hk")] AliPayHk, ApplePay(Box<AdyenApplePay>), + ApplePayDecrypt(Box<AdyenApplePayDecryptData>), Atome, #[serde(rename = "scheme")] BancontactCard(Box<AdyenCard>), @@ -1253,6 +1256,18 @@ pub struct AdyenPazeData { network_payment_reference: Option<Secret<String>>, } +#[serde_with::skip_serializing_none] +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct AdyenApplePayDecryptData { + number: Secret<String>, + expiry_month: Secret<String>, + expiry_year: Secret<String>, + brand: String, + #[serde(rename = "type")] + payment_type: PaymentType, +} + #[derive(Debug, Clone, Serialize, Deserialize)] #[serde(rename_all = "lowercase")] pub enum CardBrand { @@ -2194,11 +2209,27 @@ impl TryFrom<(&WalletData, &PaymentsAuthorizeRouterData)> for AdyenPaymentMethod Ok(AdyenPaymentMethod::Gpay(Box::new(gpay_data))) } WalletData::ApplePay(data) => { - let apple_pay_data = AdyenApplePay { - apple_pay_token: Secret::new(data.payment_data.to_string()), - }; - - Ok(AdyenPaymentMethod::ApplePay(Box::new(apple_pay_data))) + if let Some(PaymentMethodToken::ApplePayDecrypt(apple_pay_decrypte)) = + item.payment_method_token.clone() + { + let expiry_year_4_digit = apple_pay_decrypte.get_four_digit_expiry_year()?; + let exp_month = apple_pay_decrypte.get_expiry_month()?; + let apple_pay_decrypted_data = AdyenApplePayDecryptData { + number: apple_pay_decrypte.application_primary_account_number, + expiry_month: exp_month, + expiry_year: expiry_year_4_digit, + brand: "applepay".to_string(), + payment_type: PaymentType::Scheme, + }; + Ok(AdyenPaymentMethod::ApplePayDecrypt(Box::new( + apple_pay_decrypted_data, + ))) + } else { + let apple_pay_data = AdyenApplePay { + apple_pay_token: Secret::new(data.payment_data.to_string()), + }; + Ok(AdyenPaymentMethod::ApplePay(Box::new(apple_pay_data))) + } } WalletData::PaypalRedirect(_) => Ok(AdyenPaymentMethod::AdyenPaypal), WalletData::AliPayRedirect(_) => Ok(AdyenPaymentMethod::AliPay), @@ -3426,15 +3457,23 @@ impl TryFrom<(&AdyenRouterData<&PaymentsAuthorizeRouterData>, &WalletData)> let shopper_email = get_shopper_email(item.router_data, store_payment_method.is_some())?; let billing_address = get_address_info(item.router_data.get_optional_billing()).and_then(Result::ok); - let mpi_data = if let WalletData::Paze(_) = wallet_data { + let mpi_data = if matches!(wallet_data, WalletData::Paze(_) | WalletData::ApplePay(_)) { match item.router_data.payment_method_token.clone() { - Some(PaymentMethodToken::PazeDecrypt(paze_decrypted_data)) => Some(AdyenMpiData { + Some(PaymentMethodToken::PazeDecrypt(paze_data)) => Some(AdyenMpiData { directory_response: "Y".to_string(), authentication_response: "Y".to_string(), - token_authentication_verification_value: paze_decrypted_data - .token - .payment_account_reference, - eci: paze_decrypted_data.eci, + cavv: None, + token_authentication_verification_value: Some( + paze_data.token.payment_account_reference, + ), + eci: paze_data.eci, + }), + Some(PaymentMethodToken::ApplePayDecrypt(apple_data)) => Some(AdyenMpiData { + directory_response: "Y".to_string(), + authentication_response: "Y".to_string(), + cavv: Some(apple_data.payment_data.online_payment_cryptogram), + token_authentication_verification_value: None, + eci: apple_data.payment_data.eci_indicator, }), _ => None, } @@ -5852,10 +5891,10 @@ impl let mpi_data = AdyenMpiData { directory_response: "Y".to_string(), authentication_response: "Y".to_string(), - token_authentication_verification_value: token_data - .get_cryptogram() - .clone() - .unwrap_or_default(), + cavv: None, + token_authentication_verification_value: Some( + token_data.get_cryptogram().clone().unwrap_or_default(), + ), eci: Some("02".to_string()), }; let (store, splits) = match item.router_data.request.split_payments.as_ref() {

2025-07-10T11:41:04Z

## Type of Change  - [ ] Bugfix - [x] feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  This pull request introduces support for decrypting Apple Pay payment data in the Adyen connector. It includes updates to the `AdyenPaymentMethod` enum, new structures for handling decrypted Apple Pay data, and modifications to existing logic for processing payment tokens. The changes enhance functionality and improve flexibility in handling payment methods. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  ## How did you test it?  -> Create a merchant connector account for adyen and enable apple pay ``` "apple_pay_combined": { "manual": { "session_token_data": { "initiative": "web", "certificate": "", "display_name": "apple pay", "certificate_keys": "", "initiative_context": "debuglab.basilisk-char.ts.net", "merchant_identifier": "", "merchant_business_country": "AU", "payment_processing_details_at": "", "payment_processing_certificate": "", "payment_processing_certificate_key": "" }, "payment_request_data": { "label": "applepay", "supported_networks": [ "visa", "masterCard", "amex", "discover" ], "merchant_capabilities": [ "supports3DS" ] } } }, ``` -> Make a apple pay payment ``` curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: api-key' \ --data-raw '{ "amount": 650, "currency": "USD", "confirm": true, "business_country": "US", "business_label": "default", "amount_to_capture": 650, "customer_id": "cu_1752147534", "capture_method": "automatic", "capture_on": "2022-09-10T10:11:12Z", "setup_future_usage": "off_session", "authentication_type": "no_three_ds", "return_url": "https://google.com", "email": "[email protected]", "name": "Joseph Doe", "phone": "999999999", "phone_country_code": "+65", "description": "Its my first payment request", "statement_descriptor_name": "Juspay", "statement_descriptor_suffix": "Router", "payment_method": "wallet", "payment_method_type": "apple_pay", "billing": { "address": { "line1": "1467", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" }, "phone": { "number": "8056594427", "country_code": "+91" } }, "customer_acceptance": { "acceptance_type": "offline", "accepted_at": "1963-05-03T04:07:52.723Z", "online": { "ip_address": "in sit", "user_agent": "amet irure esse" } }, "payment_method_data": { "wallet": { "apple_pay": { "payment_data": "==", "payment_method": { "display_name": "Discover 9319", "network": "Discover", "type": "credit" }, "transaction_identifier": "c635c5b3af900d7bd81fecd7028f1262f9d030754ee65ec7afd988a678194751" } } } }' ``` ``` { "payment_id": "pay_dJrJVGuuuMcTx3ZMr3sn", "merchant_id": "merchant_1752143545", "status": "succeeded", "amount": 650, "net_amount": 650, "shipping_cost": null, "amount_capturable": 0, "amount_received": 650, "connector": "adyen", "client_secret": "pay_dJrJVGuuuMcTx3ZMr3sn_secret_uJD9kz6I3hUvC0333wj0", "created": "2025-07-10T11:38:51.845Z", "currency": "USD", "customer_id": "cu_1752147532", "customer": { "id": "cu_1752147532", "name": "Joseph Doe", "email": "[email protected]", "phone": "999999999", "phone_country_code": "+65" }, "description": "Its my first payment request", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": "off_session", "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "wallet", "payment_method_data": { "wallet": { "apple_pay": { "last4": "9319", "card_network": "Discover", "type": "credit" } }, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": null, "line3": null, "zip": "94122", "state": "California", "first_name": "joseph", "last_name": "Doe" }, "phone": { "number": "8056594427", "country_code": "+91" }, "email": null }, "order_details": null, "email": "[email protected]", "name": "Joseph Doe", "phone": "999999999", "return_url": "https://google.com/", "authentication_type": "no_three_ds", "statement_descriptor_name": "Juspay", "statement_descriptor_suffix": "Router", "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "apple_pay", "connector_label": "adyen_US_default", "business_country": "US", "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": { "customer_id": "cu_1752147532", "created_at": 1752147531, "expires": 1752151131, "secret": "epk_29209a3a0b8744e78745fc53120e2606" }, "manual_retry_allowed": false, "connector_transaction_id": "FFRWLKGL9GMTT475", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_dJrJVGuuuMcTx3ZMr3sn_1", "payment_link": null, "profile_id": "pro_J2FnaaW4M2zfdqhM1pGa", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_r2IwjAwwrKATInMfX2Ga", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-07-10T11:53:51.845Z", "fingerprint": null, "browser_info": null, "payment_method_id": "pm_GNhWI2uXCdrKCcNiZ9Cg", "payment_method_status": "active", "updated": "2025-07-10T11:38:53.596Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": "QSJDL57GX6C68775", "card_discovery": null, "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` -> connector request ``` { "amount": { "currency": "USD", "value": 650 }, "merchantAccount": "*** alloc::string::String ***", "paymentMethod": { "type": "scheme", "number": "*** alloc::string::String ***", "expiryMonth": "*** alloc::string::String ***", "expiryYear": "*** alloc::string::String ***", "brand": "applepay" }, "mpiData": { "directoryResponse": "Y", "authenticationResponse": "Y", "cavv": "*** alloc::string::String ***", "eci": "7" }, "reference": "pay_dJrJVGuuuMcTx3ZMr3sn_1", "returnUrl": "http://localhost:8080/payments/pay_dJrJVGuuuMcTx3ZMr3sn/merchant_1752143545/redirect/response/adyen", "shopperInteraction": "Ecommerce", "recurringProcessingModel": "UnscheduledCardOnFile", "shopperReference": "merchant_1752143545_cu_1752147532", "storePaymentMethod": true, "shopperStatement": "Juspay", "telephoneNumber": "*** alloc::string::String ***", "billingAddress": { "city": "San Fransico", "country": "US", "houseNumberOrName": "*** alloc::string::String ***", "postalCode": "*** alloc::string::String ***", "stateOrProvince": "*** alloc::string::String ***" } } ``` <img width="1426" height="973" alt="image" src="https://github.com/user-attachments/assets/544ca966-7267-46ae-869a-d6e5cdbe96b1" /> ### testing existing connector decryption flow ``` { "amount": 1, "currency": "EUR", "confirm": true, "business_country": "US", "business_label": "default", "amount_to_capture": 1, "customer_id": "cu_{{$timestamp}}", "capture_method": "automatic", "capture_on": "2022-09-10T10:11:12Z", "setup_future_usage": "off_session", "authentication_type": "no_three_ds", "return_url": "https://google.com", "email": "[email protected]", "name": "Joseph Doe", "phone": "999999999", "phone_country_code": "+65", "description": "Its my first payment request", "statement_descriptor_name": "Juspay", "statement_descriptor_suffix": "Router", "payment_method": "wallet", "payment_method_type": "apple_pay", "billing": { "address": { "line1": "1467", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" }, "phone": { "number": "8056594427", "country_code": "+91" } }, "customer_acceptance": { "acceptance_type": "offline", "accepted_at": "1963-05-03T04:07:52.723Z", "online": { "ip_address": "in sit", "user_agent": "amet irure esse" } }, "payment_method_data": { "wallet": { "apple_pay": { "payment_data": "eyJkYXRhIjoiK3NLL0trRWMvRXlFb203N2FJenFYMkNyNG1ldFlranRla1h3eEIyQTJYRzA4ekMwMFJwdFowU0xlSExabnRvZTZpeVNnbzFNVmUyWWVCRVk2b2VteUpwU053TE5PQVU0K3M2eU9zSXNJQ0VITTlMa3FjZGoyc0IwU2RzUHAyUklHVGp3TWozVGtsTFhQV295NlJ0NlZyVVFQemxldlRobE9OZ3piR2psd0I1OVlxN3J0VHFHN0h5eFd3WTJLaDBzcytySWpDbHdnQkRzSzNXMVJ2bzB2NVlDVEdFYWhHRUQxMlN1RTYxbzVOU1NmUjBGUHlDbWtEaTBBYm1XbXBHN0ZmSGMxTkY2MDRkMUtTcmlMclpUU2hYYnhxZVFGdjlxZXpibUVOck1CZXpsLzdFU2NvMU5GMFpyZ1h1Z29oa3JkQkpPeXlJc0I4Qmw5QTl1emFJL2RoU3dpYTFMWGw0Zml0Q3p6U1diUDhBUDV2UkN3TEhMT3M5eTFKNmpYMDJJamtDSlBybU5KYmVTeUE9PSIsInNpZ25hdHVyZSI6Ik1JQUdDU3FHU0liM0RRRUhBcUNBTUlBQ0FRRXhEVEFMQmdsZ2hrZ0JaUU1FQWdFd2dBWUpLb1pJaHZjTkFRY0JBQUNnZ0RDQ0ErUXdnZ09Mb0FNQ0FRSUNDRm5Zb2J5cTlPUE5NQW9HQ0NxR1NNNDlCQU1DTUhveExqQXNCZ05WQkFNTUpVRndjR3hsSUVGd2NHeHBZMkYwYVc5dUlFbHVkR1ZuY21GMGFXOXVJRU5CSUMwZ1J6TXhKakFrQmdOVkJBc01IVUZ3Y0d4bElFTmxjblJwWm1sallYUnBiMjRnUVhWMGFHOXlhWFI1TVJNd0VRWURWUVFLREFwQmNIQnNaU0JKYm1NdU1Rc3dDUVlEVlFRR0V3SlZVekFlRncweU1UQTBNakF4T1RNM01EQmFGdzB5TmpBME1Ua3hPVE0yTlRsYU1HSXhLREFtQmdOVkJBTU1IMlZqWXkxemJYQXRZbkp2YTJWeUxYTnBaMjVmVlVNMExWTkJUa1JDVDFneEZEQVNCZ05WQkFzTUMybFBVeUJUZVhOMFpXMXpNUk13RVFZRFZRUUtEQXBCY0hCc1pTQkpibU11TVFzd0NRWURWUVFHRXdKVlV6QlpNQk1HQnlxR1NNNDlBZ0VHQ0NxR1NNNDlBd0VIQTBJQUJJSXcvYXZEblBkZUlDeFEyWnRGRXVZMzRxa0IzV3l6NExITlMxSm5tUGpQVHIzb0dpV293aDVNTTkzT2ppcVd3dmF2b1pNRFJjVG9la1FtenBVYkVwV2pnZ0lSTUlJQ0RUQU1CZ05WSFJNQkFmOEVBakFBTUI4R0ExVWRJd1FZTUJhQUZDUHlTY1JQaytUdkorYkU5aWhzUDZLNy9TNUxNRVVHQ0NzR0FRVUZCd0VCQkRrd056QTFCZ2dyQmdFRkJRY3dBWVlwYUhSMGNEb3ZMMjlqYzNBdVlYQndiR1V1WTI5dEwyOWpjM0F3TkMxaGNIQnNaV0ZwWTJFek1ESXdnZ0VkQmdOVkhTQUVnZ0VVTUlJQkVEQ0NBUXdHQ1NxR1NJYjNZMlFGQVRDQi9qQ0J3d1lJS3dZQkJRVUhBZ0l3Z2JZTWdiTlNaV3hwWVc1alpTQnZiaUIwYUdseklHTmxjblJwWm1sallYUmxJR0o1SUdGdWVTQndZWEowZVNCaGMzTjFiV1Z6SUdGalkyVndkR0Z1WTJVZ2IyWWdkR2hsSUhSb1pXNGdZWEJ3YkdsallXSnNaU0J6ZEdGdVpHRnlaQ0IwWlhKdGN5QmhibVFnWTI5dVpHbDBhVzl1Y3lCdlppQjFjMlVzSUdObGNuUnBabWxqWVhSbElIQnZiR2xqZVNCaGJtUWdZMlZ5ZEdsbWFXTmhkR2x2YmlCd2NtRmpkR2xqWlNCemRHRjBaVzFsYm5SekxqQTJCZ2dyQmdFRkJRY0NBUllxYUhSMGNEb3ZMM2QzZHk1aGNIQnNaUzVqYjIwdlkyVnlkR2xtYVdOaGRHVmhkWFJvYjNKcGRIa3ZNRFFHQTFVZEh3UXRNQ3N3S2FBbm9DV0dJMmgwZEhBNkx5OWpjbXd1WVhCd2JHVXVZMjl0TDJGd2NHeGxZV2xqWVRNdVkzSnNNQjBHQTFVZERnUVdCQlFDSkRBTG11N3RSakdYcEtaYUtaNUNjWUljUlRBT0JnTlZIUThCQWY4RUJBTUNCNEF3RHdZSktvWklodmRqWkFZZEJBSUZBREFLQmdncWhrak9QUVFEQWdOSEFEQkVBaUIwb2JNazIwSkpRdzNUSjB4UWRNU0FqWm9mU0E0NmhjWEJOaVZtTWwrOG93SWdhVGFRVTZ2MUMxcFMrZllBVGNXS3JXeFFwOVlJYURlUTRLYzYwQjVLMllFd2dnTHVNSUlDZGFBREFnRUNBZ2hKYlMrL09wamFsekFLQmdncWhrak9QUVFEQWpCbk1Sc3dHUVlEVlFRRERCSkJjSEJzWlNCU2IyOTBJRU5CSUMwZ1J6TXhKakFrQmdOVkJBc01IVUZ3Y0d4bElFTmxjblJwWm1sallYUnBiMjRnUVhWMGFHOXlhWFI1TVJNd0VRWURWUVFLREFwQmNIQnNaU0JKYm1NdU1Rc3dDUVlEVlFRR0V3SlZVekFlRncweE5EQTFNRFl5TXpRMk16QmFGdzB5T1RBMU1EWXlNelEyTXpCYU1Ib3hMakFzQmdOVkJBTU1KVUZ3Y0d4bElFRndjR3hwWTJGMGFXOXVJRWx1ZEdWbmNtRjBhVzl1SUVOQklDMGdSek14SmpBa0JnTlZCQXNNSFVGd2NHeGxJRU5sY25ScFptbGpZWFJwYjI0Z1FYVjBhRzl5YVhSNU1STXdFUVlEVlFRS0RBcEJjSEJzWlNCSmJtTXVNUXN3Q1FZRFZRUUdFd0pWVXpCWk1CTUdCeXFHU000OUFnRUdDQ3FHU000OUF3RUhBMElBQlBBWEVZUVoxMlNGMVJwZUpZRUhkdWlBb3UvZWU2NU40STM4UzVQaE0xYlZabHMxcmlMUWwzWU5JazU3dWdqOWRoZk9pTXQydTJad3Zzam9LWVQvVkVXamdmY3dnZlF3UmdZSUt3WUJCUVVIQVFFRU9qQTRNRFlHQ0NzR0FRVUZCekFCaGlwb2RIUndPaTh2YjJOemNDNWhjSEJzWlM1amIyMHZiMk56Y0RBMExXRndjR3hsY205dmRHTmhaek13SFFZRFZSME9CQllFRkNQeVNjUlBrK1R2SitiRTlpaHNQNks3L1M1TE1BOEdBMVVkRXdFQi93UUZNQU1CQWY4d0h3WURWUjBqQkJnd0ZvQVV1N0Rlb1ZnemlKcWtpcG5ldnIzcnI5ckxKS3N3TndZRFZSMGZCREF3TGpBc29DcWdLSVltYUhSMGNEb3ZMMk55YkM1aGNIQnNaUzVqYjIwdllYQndiR1Z5YjI5MFkyRm5NeTVqY213d0RnWURWUjBQQVFIL0JBUURBZ0VHTUJBR0NpcUdTSWIzWTJRR0FnNEVBZ1VBTUFvR0NDcUdTTTQ5QkFNQ0EyY0FNR1FDTURyUGNvTlJGcG14aHZzMXcxYktZci8wRiszWkQzVk5vbzYrOFp5QlhrSzNpZmlZOTV0Wm41alZRUTJQbmVuQy9nSXdNaTNWUkNHd293VjNiRjN6T0R1UVovMFhmQ3doYlpaUHhuSnBnaEp2VlBoNmZSdVp5NXNKaVNGaEJwa1BDWklkQUFBeGdnR0hNSUlCZ3dJQkFUQ0JoakI2TVM0d0xBWURWUVFERENWQmNIQnNaU0JCY0hCc2FXTmhkR2x2YmlCSmJuUmxaM0poZEdsdmJpQkRRU0F0SUVjek1TWXdKQVlEVlFRTERCMUJjSEJzWlNCRFpYSjBhV1pwWTJGMGFXOXVJRUYxZEdodmNtbDBlVEVUTUJFR0ExVUVDZ3dLUVhCd2JHVWdTVzVqTGpFTE1Ba0dBMVVFQmhNQ1ZWTUNDRm5Zb2J5cTlPUE5NQXNHQ1dDR1NBRmxBd1FDQWFDQmt6QVlCZ2txaGtpRzl3MEJDUU14Q3dZSktvWklodmNOQVFjQk1Cd0dDU3FHU0liM0RRRUpCVEVQRncweU5UQTNNVFV3TXpNMU16UmFNQ2dHQ1NxR1NJYjNEUUVKTkRFYk1Ca3dDd1lKWUlaSUFXVURCQUlCb1FvR0NDcUdTTTQ5QkFNQ01DOEdDU3FHU0liM0RRRUpCREVpQkNBZ0VKd0VMWm1LQ3Y4SFUraEhQVVAwdnNNdFB6UjI4UzJVNzFvVEdRMURvakFLQmdncWhrak9QUVFEQWdSR01FUUNJRE5JZnNod1lQYWFXd1prYWtmSWZtcVJNZVc5eE96S1RCZmY4MDIrVWF1MkFpQVltb2FnbVJMSFNzUjk0Z1IxMHlvKzBrL1ZRVlFvNUhRRllEUjEyWkg2d0FBQUFBQUFBQT09IiwiaGVhZGVyIjp7InB1YmxpY0tleUhhc2giOiJFYzRPbEFveXRpNFpyZ1lCclRMZzZMQ1NVSzdCdHBQekozblpQeC9Sd3RBPSIsImVwaGVtZXJhbFB1YmxpY0tleSI6Ik1Ga3dFd1lIS29aSXpqMENBUVlJS29aSXpqMERBUWNEUWdBRXZ0QlVudThhS244alBNQzM4SFdnQ00zeVRTT3ZiaDFsakRtWFVsZzJUUExtYWhwTS9RcEtqRkdYeVEyY2JKWW5aeU1HVjRzR2w1T0NWcFR2eld0cjBBPT0iLCJ0cmFuc2FjdGlvbklkIjoiNzI5NWY3NTc4ZGM4ODI2OWE5ZGY0MWU0YzgxZjQ2ODE2NWYzMmE3NjFjMTA5MGIzNDhlMjAxYzk1YmI0ZmUxMyJ9LCJ2ZXJzaW9uIjoiRUNfdjEifQ==", "payment_method": { "display_name": "Discover 9319", "network": "Discover", "type": "credit" }, "transaction_identifier": "c635c5b3af900d7bd81fecd7028f1262f9d030754ee65ec7afd988a678194751" } } } } ``` ``` { "payment_id": "pay_kM6NBnxuHTlzY5ybGLqx", "merchant_id": "merchant_1752565724", "status": "succeeded", "amount": 1, "net_amount": 1, "shipping_cost": null, "amount_capturable": 0, "amount_received": 1, "connector": "adyen", "client_secret": "pay_kM6NBnxuHTlzY5ybGLqx_secret_5mV0RX2Rs2mOQ4X67Yjs", "created": "2025-07-15T07:53:29.564Z", "currency": "EUR", "customer_id": "cu_1752566010", "customer": { "id": "cu_1752566010", "name": "Joseph Doe", "email": "[email protected]", "phone": "999999999", "phone_country_code": "+65" }, "description": "Its my first payment request", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": "off_session", "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "wallet", "payment_method_data": { "wallet": { "apple_pay": { "last4": "9319", "card_network": "Discover", "type": "credit" } }, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": null, "line3": null, "zip": "94122", "state": "California", "first_name": "joseph", "last_name": "Doe" }, "phone": { "number": "8056594427", "country_code": "+91" }, "email": null }, "order_details": null, "email": "[email protected]", "name": "Joseph Doe", "phone": "999999999", "return_url": "https://google.com/", "authentication_type": "no_three_ds", "statement_descriptor_name": "Juspay", "statement_descriptor_suffix": "Router", "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "apple_pay", "connector_label": "adyen_US_default", "business_country": "US", "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": { "customer_id": "cu_1752566010", "created_at": 1752566009, "expires": 1752569609, "secret": "epk_dd5dd4d6b20d4c18a9db60922145f7b6" }, "manual_retry_allowed": false, "connector_transaction_id": "SHKNSMTDM6STT475", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_kM6NBnxuHTlzY5ybGLqx_1", "payment_link": null, "profile_id": "pro_BECixFE1QlimjLqJalgs", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_7SBGsmaaqWT9TrbNL747", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-07-15T08:08:29.564Z", "fingerprint": null, "browser_info": null, "payment_method_id": "pm_oGV7tOINPnAnIWUo0w9U", "payment_method_status": "active", "updated": "2025-07-15T07:53:31.250Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": "SQGB2PFPQLSMC375", "card_discovery": null, "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

cb055134603478c5fb68e882fad65f25649e8cb4

juspay/hyperswitch

juspay__hyperswitch-8595

Bug: fix(cypress): cypress tests for incremental auth getting skipped for all connectors ### 📌 Problem The Cypress test suite `00029-IncrementalAuth.cy.js` is currently being entirely, even though it should work for `cybersource` . <img width="930" height="320" alt="Image" src="https://github.com/user-attachments/assets/26e4a754-025e-4c9c-8bfc-618bf423362d" />

2025-07-09T17:08:39Z

## Type of Change  - [x] Bugfix - [ ] New feature - [x] Enhancement - [x] Refactoring - [ ] Dependency updates - [ ] Documentation - [x] CI/CD ## Description  This PR introduces a set of improvements and refactors in the Cypress test suite specifically for **Incremental Authorization** test cases. --- ### ✅ Key Changes: 1. **Connector Inclusion List for Incremental Auth** * Introduced a new list `INCREMENTAL_AUTH` in `Utils.js` under `CONNECTOR_LISTS.INCLUDE`. * This inclusion list determines which connectors support Incremental Authorization and should execute related tests. 2. **Dynamic Skipping of Tests Based on Connector Support** * Refactored the test flow to dynamically `skip()` test blocks at runtime if the connector isn't included in `INCREMENTAL_AUTH`. * Prevents false negatives and unwanted test runs on unsupported connectors (like CyberSource with known `MULTIPLE_CONNECTORS` issues). 3. **Refactored `before` and `after` Hooks** * Replaced arrow functions with regular functions in `before()` hooks to correctly utilize `this.skip()`. * Ensured proper state flushing with `afterEach` instead of `after`. 4. **Improved Capture Test for Incremental Auth** * Modified the capture test logic to simulate an **incremented capture amount**. * Prevents test result from falling into `partially_captured` due to stale `previously_authorized_amount`. 5. **Enhanced Assertions for Incremental Auth Response** * Added deep assertions for `previously_authorized_amount` from `incremental_authorizations` to validate correctness of incremental logic. * Ensures the captured amount matches the expected post-incremented value. ### 🧪 Test Impact: * Only **connectors in `INCREMENTAL_AUTH` list** will now run Incremental Authorization tests. * Currently includes: `cybersource` (commented out due to known issue), `paypal`, and `archipel` (handled in related PR #8189). * Other connectors will auto-skip these tests, improving CI stability and relevance. ### 💡 Reference Followed the pattern used in working test files like `00020-MandatesUsingNTIDProxy.cy.js`, which implement `this.skip()` with proper connector inclusion checks. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  The test suite for Incremental Auth (`00029-IncrementalAuth.cy.js`) was being entirely skipped due to usage of `describe.skip` and context handling. ## How did you test it?  | Cybersource (Skipped) | ArchiPEL | |----|----| | <img height="300" alt="image" src="https://github.com/user-attachments/assets/343f556a-26e8-43dc-b714-9b74446d4e35" /> | <img width="300" alt="image" src="https://github.com/user-attachments/assets/8fa0bf09-0cea-4b23-b656-5d0f3c236ab9" /> | ### Sanity | Stripe | Adyen | Bluesnap | Bank of America | |----|----|----|----| | <img width="300" alt="image" src="https://github.com/user-attachments/assets/8b567f21-fbde-4ad3-88e1-2a8cca70084f" /> | <img width="300" alt="image" src="https://github.com/user-attachments/assets/8b567f21-fbde-4ad3-88e1-2a8cca70084f" /> | <img width="300" alt="image" src="https://github.com/user-attachments/assets/8b567f21-fbde-4ad3-88e1-2a8cca70084f" /> | <img width="300" alt="image" src="https://github.com/user-attachments/assets/8b567f21-fbde-4ad3-88e1-2a8cca70084f" /> | ## Checklist  - [ ] I formatted the code `cargo +nightly fmt --all` - [ ] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

1991e38457f713daeb280e22b2dd19c2944840b6

juspay/hyperswitch

juspay__hyperswitch-8592

Bug: [FEATURE] [CONNECTOR : SILVERFLOW] Cards No 3ds Alpha integration ### Feature Description Cards Non-3DS payments added for silverflow (Alpha Integration). ### Possible Implementation Cards Non-3DS payments added for silverflow (Alpha Integration). ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? None

diff --git a/crates/connector_configs/toml/development.toml b/crates/connector_configs/toml/development.toml index 9e493eb6a54..2737d7a2323 100644 --- a/crates/connector_configs/toml/development.toml +++ b/crates/connector_configs/toml/development.toml @@ -6330,9 +6330,20 @@ type="Text" api_key="API Key" [silverflow] -[silverflow.connector_auth.BodyKey] +[[silverflow.credit]] + payment_method_type = "Mastercard" +[[silverflow.credit]] + payment_method_type = "Visa" +[[silverflow.debit]] + payment_method_type = "Mastercard" +[[silverflow.debit]] + payment_method_type = "Visa" +[silverflow.connector_auth.SignatureKey] api_key="API Key" -key1="Secret Key" +api_secret="API Secret" +key1="Merchant Acceptor Key" +[silverflow.connector_webhook_details] +merchant_secret="Source verification key" [affirm] [affirm.connector_auth.HeaderKey] @@ -6345,3 +6356,4 @@ api_key = "API Key" [breadpay] [breadpay.connector_auth.HeaderKey] api_key = "API Key" + diff --git a/crates/connector_configs/toml/production.toml b/crates/connector_configs/toml/production.toml index e81c3f6aac9..8bd08758dd5 100644 --- a/crates/connector_configs/toml/production.toml +++ b/crates/connector_configs/toml/production.toml @@ -4939,9 +4939,20 @@ payment_method_type = "Visa" api_key = "API Key" [silverflow] -[silverflow.connector_auth.BodyKey] -api_key = "API Key" -key1 = "Secret Key" +[[silverflow.credit]] + payment_method_type = "Mastercard" +[[silverflow.credit]] + payment_method_type = "Visa" +[[silverflow.debit]] + payment_method_type = "Mastercard" +[[silverflow.debit]] + payment_method_type = "Visa" +[silverflow.connector_auth.SignatureKey] +api_key="API Key" +api_secret="API Secret" +key1="Merchant Acceptor Key" +[silverflow.connector_webhook_details] +merchant_secret="Source verification key" [affirm] [affirm.connector_auth.HeaderKey] @@ -4954,3 +4965,4 @@ api_key = "API Key" [breadpay] [breadpay.connector_auth.HeaderKey] api_key = "API Key" + diff --git a/crates/connector_configs/toml/sandbox.toml b/crates/connector_configs/toml/sandbox.toml index bdd9cde57f0..e8b9894696e 100644 --- a/crates/connector_configs/toml/sandbox.toml +++ b/crates/connector_configs/toml/sandbox.toml @@ -6309,9 +6309,20 @@ payment_method_type = "Visa" api_key = "API Key" [silverflow] -[silverflow.connector_auth.BodyKey] -api_key = "API Key" -key1 = "Secret Key" +[[silverflow.credit]] + payment_method_type = "Mastercard" +[[silverflow.credit]] + payment_method_type = "Visa" +[[silverflow.debit]] + payment_method_type = "Mastercard" +[[silverflow.debit]] + payment_method_type = "Visa" +[silverflow.connector_auth.SignatureKey] +api_key="API Key" +api_secret="API Secret" +key1="Merchant Acceptor Key" +[silverflow.connector_webhook_details] +merchant_secret="Source verification key" [affirm] [affirm.connector_auth.HeaderKey] @@ -6324,3 +6335,4 @@ api_key = "API Key" [breadpay] [breadpay.connector_auth.HeaderKey] api_key = "API Key" + diff --git a/crates/hyperswitch_connectors/src/connectors/silverflow.rs b/crates/hyperswitch_connectors/src/connectors/silverflow.rs index 7042380d9e0..ac1db77b4db 100644 --- a/crates/hyperswitch_connectors/src/connectors/silverflow.rs +++ b/crates/hyperswitch_connectors/src/connectors/silverflow.rs @@ -2,16 +2,16 @@ pub mod transformers; use std::sync::LazyLock; -use common_enums::enums; +use base64::Engine; +use common_enums::{enums, CardNetwork}; use common_utils::{ + crypto, errors::CustomResult, - ext_traits::BytesExt, + ext_traits::{BytesExt, StringExt}, request::{Method, Request, RequestBuilder, RequestContent}, - types::{AmountConvertor, StringMinorUnit, StringMinorUnitForConnector}, }; -use error_stack::{report, ResultExt}; +use error_stack::ResultExt; use hyperswitch_domain_models::{ - payment_method_data::PaymentMethodData, router_data::{AccessToken, ConnectorAuthType, ErrorResponse, RouterData}, router_flow_types::{ access_token_auth::AccessTokenAuth, @@ -24,7 +24,8 @@ use hyperswitch_domain_models::{ RefundsData, SetupMandateRequestData, }, router_response_types::{ - ConnectorInfo, PaymentsResponseData, RefundsResponseData, SupportedPaymentMethods, + ConnectorInfo, PaymentMethodDetails, PaymentsResponseData, RefundsResponseData, + SupportedPaymentMethods, SupportedPaymentMethodsExt, }, types::{ PaymentsAuthorizeRouterData, PaymentsCaptureRouterData, PaymentsSyncRouterData, @@ -48,15 +49,11 @@ use transformers as silverflow; use crate::{constants::headers, types::ResponseRouterData, utils}; #[derive(Clone)] -pub struct Silverflow { - amount_converter: &'static (dyn AmountConvertor<Output = StringMinorUnit> + Sync), -} +pub struct Silverflow; impl Silverflow { pub fn new() -> &'static Self { - &Self { - amount_converter: &StringMinorUnitForConnector, - } + &Self } } @@ -76,7 +73,83 @@ impl api::PaymentToken for Silverflow {} impl ConnectorIntegration<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData> for Silverflow { - // Not Implemented (R) + fn get_headers( + &self, + req: &RouterData<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData>, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &RouterData<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData>, + connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Ok(format!("{}/processorTokens", self.base_url(connectors))) + } + + fn get_request_body( + &self, + req: &RouterData<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData>, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + // Create a simplified tokenization request directly from the tokenization data + let connector_req = silverflow::SilverflowTokenizationRequest::try_from(req)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &RouterData<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData>, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::TokenizationType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::TokenizationType::get_headers(self, req, connectors)?) + .set_body(types::TokenizationType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &RouterData<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData>, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult< + RouterData<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData>, + errors::ConnectorError, + > { + let response: silverflow::SilverflowTokenizationResponse = res + .response + .parse_struct("Silverflow TokenizationResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } } impl<Flow, Request, Response> ConnectorCommonExt<Flow, Request, Response> for Silverflow @@ -88,10 +161,31 @@ where req: &RouterData<Flow, Request, Response>, _connectors: &Connectors, ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { - let mut header = vec![( - headers::CONTENT_TYPE.to_string(), - self.get_content_type().to_string().into(), - )]; + let mut header = vec![ + ( + headers::CONTENT_TYPE.to_string(), + self.get_content_type().to_string().into(), + ), + ( + headers::ACCEPT.to_string(), + "application/json".to_string().into(), + ), + ]; + + // Add Idempotency-Key for POST requests (Authorize, Capture, Execute, PaymentMethodToken, Void) + let flow_type = std::any::type_name::<Flow>(); + if flow_type.contains("Authorize") + || flow_type.contains("Capture") + || flow_type.contains("Execute") + || flow_type.contains("PaymentMethodToken") + || flow_type.contains("Void") + { + header.push(( + "Idempotency-Key".to_string(), + format!("hs_{}", req.payment_id).into(), + )); + } + let mut api_key = self.get_auth_header(&req.connector_auth_type)?; header.append(&mut api_key); Ok(header) @@ -104,11 +198,8 @@ impl ConnectorCommon for Silverflow { } fn get_currency_unit(&self) -> api::CurrencyUnit { - // todo!() + // Silverflow processes amounts in minor units (cents) api::CurrencyUnit::Minor - // TODO! Check connector documentation, on which unit they are processing the currency. - // If the connector accepts amount in lower unit ( i.e cents for USD) then return api::CurrencyUnit::Minor, - // if connector accepts amount in base unit (i.e dollars for USD) then return api::CurrencyUnit::Base } fn common_get_content_type(&self) -> &'static str { @@ -125,9 +216,11 @@ impl ConnectorCommon for Silverflow { ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { let auth = silverflow::SilverflowAuthType::try_from(auth_type) .change_context(errors::ConnectorError::FailedToObtainAuthType)?; + let auth_string = format!("{}:{}", auth.api_key.expose(), auth.api_secret.expose()); + let encoded = common_utils::consts::BASE64_ENGINE.encode(auth_string.as_bytes()); Ok(vec![( headers::AUTHORIZATION.to_string(), - auth.api_key.expose().into_masked(), + format!("Basic {encoded}").into_masked(), )]) } @@ -146,42 +239,39 @@ impl ConnectorCommon for Silverflow { Ok(ErrorResponse { status_code: res.status_code, - code: response.code, - message: response.message, - reason: response.reason, + code: response.error.code, + message: response.error.message, + reason: response + .error + .details + .map(|d| format!("Field: {}, Issue: {}", d.field, d.issue)), attempt_status: None, connector_transaction_id: None, - network_advice_code: None, network_decline_code: None, + network_advice_code: None, network_error_message: None, }) } } impl ConnectorValidation for Silverflow { - fn validate_mandate_payment( + fn validate_connector_against_payment_request( &self, - _pm_type: Option<enums::PaymentMethodType>, - pm_data: PaymentMethodData, + capture_method: Option<enums::CaptureMethod>, + _payment_method: enums::PaymentMethod, + _pmt: Option<enums::PaymentMethodType>, ) -> CustomResult<(), errors::ConnectorError> { - match pm_data { - PaymentMethodData::Card(_) => Err(errors::ConnectorError::NotImplemented( - "validate_mandate_payment does not support cards".to_string(), - ) - .into()), - _ => Ok(()), + let capture_method = capture_method.unwrap_or_default(); + match capture_method { + enums::CaptureMethod::Automatic | enums::CaptureMethod::Manual => Ok(()), + enums::CaptureMethod::ManualMultiple | enums::CaptureMethod::Scheduled => Err( + utils::construct_not_implemented_error_report(capture_method, self.id()), + ), + enums::CaptureMethod::SequentialAutomatic => Err( + utils::construct_not_implemented_error_report(capture_method, self.id()), + ), } } - - fn validate_psync_reference_id( - &self, - _data: &PaymentsSyncData, - _is_three_ds: bool, - _status: enums::AttemptStatus, - _connector_meta_data: Option<common_utils::pii::SecretSerdeValue>, - ) -> CustomResult<(), errors::ConnectorError> { - Ok(()) - } } impl ConnectorIntegration<Session, PaymentsSessionData, PaymentsResponseData> for Silverflow { @@ -211,9 +301,9 @@ impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData fn get_url( &self, _req: &PaymentsAuthorizeRouterData, - _connectors: &Connectors, + connectors: &Connectors, ) -> CustomResult<String, errors::ConnectorError> { - Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + Ok(format!("{}/charges", self.base_url(connectors))) } fn get_request_body( @@ -221,13 +311,8 @@ impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData req: &PaymentsAuthorizeRouterData, _connectors: &Connectors, ) -> CustomResult<RequestContent, errors::ConnectorError> { - let amount = utils::convert_amount( - self.amount_converter, - req.request.minor_amount, - req.request.currency, - )?; - - let connector_router_data = silverflow::SilverflowRouterData::from((amount, req)); + let connector_router_data = + silverflow::SilverflowRouterData::from((req.request.minor_amount, req)); let connector_req = silverflow::SilverflowPaymentsRequest::try_from(&connector_router_data)?; Ok(RequestContent::Json(Box::new(connector_req))) @@ -298,10 +383,21 @@ impl ConnectorIntegration<PSync, PaymentsSyncData, PaymentsResponseData> for Sil fn get_url( &self, - _req: &PaymentsSyncRouterData, - _connectors: &Connectors, + req: &PaymentsSyncRouterData, + connectors: &Connectors, ) -> CustomResult<String, errors::ConnectorError> { - Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + let connector_payment_id = req + .request + .connector_transaction_id + .get_connector_transaction_id() + .change_context(errors::ConnectorError::MissingRequiredField { + field_name: "connector_transaction_id for payment sync", + })?; + Ok(format!( + "{}/charges/{}", + self.base_url(connectors), + connector_payment_id + )) } fn build_request( @@ -362,18 +458,24 @@ impl ConnectorIntegration<Capture, PaymentsCaptureData, PaymentsResponseData> fo fn get_url( &self, - _req: &PaymentsCaptureRouterData, - _connectors: &Connectors, + req: &PaymentsCaptureRouterData, + connectors: &Connectors, ) -> CustomResult<String, errors::ConnectorError> { - Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + let connector_payment_id = &req.request.connector_transaction_id; + Ok(format!( + "{}/charges/{}/clear", + self.base_url(connectors), + connector_payment_id + )) } fn get_request_body( &self, - _req: &PaymentsCaptureRouterData, + req: &PaymentsCaptureRouterData, _connectors: &Connectors, ) -> CustomResult<RequestContent, errors::ConnectorError> { - Err(errors::ConnectorError::NotImplemented("get_request_body method".to_string()).into()) + let connector_req = silverflow::SilverflowCaptureRequest::try_from(req)?; + Ok(RequestContent::Json(Box::new(connector_req))) } fn build_request( @@ -402,7 +504,7 @@ impl ConnectorIntegration<Capture, PaymentsCaptureData, PaymentsResponseData> fo event_builder: Option<&mut ConnectorEvent>, res: Response, ) -> CustomResult<PaymentsCaptureRouterData, errors::ConnectorError> { - let response: silverflow::SilverflowPaymentsResponse = res + let response: silverflow::SilverflowCaptureResponse = res .response .parse_struct("Silverflow PaymentsCaptureResponse") .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; @@ -424,7 +526,89 @@ impl ConnectorIntegration<Capture, PaymentsCaptureData, PaymentsResponseData> fo } } -impl ConnectorIntegration<Void, PaymentsCancelData, PaymentsResponseData> for Silverflow {} +impl ConnectorIntegration<Void, PaymentsCancelData, PaymentsResponseData> for Silverflow { + fn get_headers( + &self, + req: &RouterData<Void, PaymentsCancelData, PaymentsResponseData>, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + req: &RouterData<Void, PaymentsCancelData, PaymentsResponseData>, + connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + let connector_payment_id = &req.request.connector_transaction_id; + Ok(format!( + "{}/charges/{}/reverse", + self.base_url(connectors), + connector_payment_id + )) + } + + fn get_request_body( + &self, + req: &RouterData<Void, PaymentsCancelData, PaymentsResponseData>, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let connector_req = silverflow::SilverflowVoidRequest::try_from(req)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &RouterData<Void, PaymentsCancelData, PaymentsResponseData>, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::PaymentsVoidType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::PaymentsVoidType::get_headers(self, req, connectors)?) + .set_body(types::PaymentsVoidType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &RouterData<Void, PaymentsCancelData, PaymentsResponseData>, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult< + RouterData<Void, PaymentsCancelData, PaymentsResponseData>, + errors::ConnectorError, + > { + let response: silverflow::SilverflowVoidResponse = res + .response + .parse_struct("Silverflow PaymentsVoidResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} impl ConnectorIntegration<Execute, RefundsData, RefundsResponseData> for Silverflow { fn get_headers( @@ -441,10 +625,15 @@ impl ConnectorIntegration<Execute, RefundsData, RefundsResponseData> for Silverf fn get_url( &self, - _req: &RefundsRouterData<Execute>, - _connectors: &Connectors, + req: &RefundsRouterData<Execute>, + connectors: &Connectors, ) -> CustomResult<String, errors::ConnectorError> { - Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + let connector_payment_id = &req.request.connector_transaction_id; + Ok(format!( + "{}/charges/{}/refund", + self.base_url(connectors), + connector_payment_id + )) } fn get_request_body( @@ -452,13 +641,8 @@ impl ConnectorIntegration<Execute, RefundsData, RefundsResponseData> for Silverf req: &RefundsRouterData<Execute>, _connectors: &Connectors, ) -> CustomResult<RequestContent, errors::ConnectorError> { - let refund_amount = utils::convert_amount( - self.amount_converter, - req.request.minor_refund_amount, - req.request.currency, - )?; - - let connector_router_data = silverflow::SilverflowRouterData::from((refund_amount, req)); + let connector_router_data = + silverflow::SilverflowRouterData::from((req.request.minor_refund_amount, req)); let connector_req = silverflow::SilverflowRefundRequest::try_from(&connector_router_data)?; Ok(RequestContent::Json(Box::new(connector_req))) } @@ -525,10 +709,19 @@ impl ConnectorIntegration<RSync, RefundsData, RefundsResponseData> for Silverflo fn get_url( &self, - _req: &RefundSyncRouterData, - _connectors: &Connectors, + req: &RefundSyncRouterData, + connectors: &Connectors, ) -> CustomResult<String, errors::ConnectorError> { - Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + // According to Silverflow API documentation, refunds are actions on charges + // Endpoint: GET /charges/{chargeKey}/actions/{actionKey} + let charge_key = &req.request.connector_transaction_id; + let action_key = &req.request.refund_id; + Ok(format!( + "{}/charges/{}/actions/{}", + self.base_url(connectors), + charge_key, + action_key + )) } fn build_request( @@ -581,36 +774,195 @@ impl ConnectorIntegration<RSync, RefundsData, RefundsResponseData> for Silverflo impl webhooks::IncomingWebhook for Silverflow { fn get_webhook_object_reference_id( &self, - _request: &webhooks::IncomingWebhookRequestDetails<'_>, + request: &webhooks::IncomingWebhookRequestDetails<'_>, ) -> CustomResult<api_models::webhooks::ObjectReferenceId, errors::ConnectorError> { - Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + let webhook_body = String::from_utf8(request.body.to_vec()) + .change_context(errors::ConnectorError::WebhookReferenceIdNotFound)?; + + let webhook_event: silverflow::SilverflowWebhookEvent = webhook_body + .parse_struct("SilverflowWebhookEvent") + .change_context(errors::ConnectorError::WebhookReferenceIdNotFound)?; + + // For payments, use charge_key; for refunds, use refund_key + if let Some(charge_key) = webhook_event.event_data.charge_key { + Ok(api_models::webhooks::ObjectReferenceId::PaymentId( + api_models::payments::PaymentIdType::ConnectorTransactionId(charge_key), + )) + } else if let Some(refund_key) = webhook_event.event_data.refund_key { + Ok(api_models::webhooks::ObjectReferenceId::RefundId( + api_models::webhooks::RefundIdType::ConnectorRefundId(refund_key), + )) + } else { + Err(errors::ConnectorError::WebhookReferenceIdNotFound.into()) + } } fn get_webhook_event_type( &self, - _request: &webhooks::IncomingWebhookRequestDetails<'_>, + request: &webhooks::IncomingWebhookRequestDetails<'_>, ) -> CustomResult<api_models::webhooks::IncomingWebhookEvent, errors::ConnectorError> { - Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + let webhook_body = String::from_utf8(request.body.to_vec()) + .change_context(errors::ConnectorError::WebhookEventTypeNotFound)?; + + let webhook_event: silverflow::SilverflowWebhookEvent = webhook_body + .parse_struct("SilverflowWebhookEvent") + .change_context(errors::ConnectorError::WebhookEventTypeNotFound)?; + + match webhook_event.event_type.as_str() { + "charge.authorization.succeeded" => { + // Handle manual capture flow: check if clearing is still pending + if let Some(status) = webhook_event.event_data.status { + match (&status.authorization, &status.clearing) { + ( + silverflow::SilverflowAuthorizationStatus::Approved, + silverflow::SilverflowClearingStatus::Pending, + ) => { + // Manual capture: authorization succeeded, but clearing is pending + Ok(api_models::webhooks::IncomingWebhookEvent::PaymentIntentAuthorizationSuccess) + } + ( + silverflow::SilverflowAuthorizationStatus::Approved, + silverflow::SilverflowClearingStatus::Cleared, + ) => { + // Automatic capture: authorization and clearing both completed + Ok(api_models::webhooks::IncomingWebhookEvent::PaymentIntentSuccess) + } + _ => { + // Fallback for other authorization states + Ok(api_models::webhooks::IncomingWebhookEvent::PaymentIntentAuthorizationSuccess) + } + } + } else { + // Fallback when status is not available + Ok(api_models::webhooks::IncomingWebhookEvent::PaymentIntentAuthorizationSuccess) + } + } + "charge.authorization.failed" => { + Ok(api_models::webhooks::IncomingWebhookEvent::PaymentIntentFailure) + } + "charge.clearing.succeeded" => { + Ok(api_models::webhooks::IncomingWebhookEvent::PaymentIntentSuccess) + } + "charge.clearing.failed" => { + Ok(api_models::webhooks::IncomingWebhookEvent::PaymentIntentFailure) + } + "refund.succeeded" => Ok(api_models::webhooks::IncomingWebhookEvent::RefundSuccess), + "refund.failed" => Ok(api_models::webhooks::IncomingWebhookEvent::RefundFailure), + _ => Ok(api_models::webhooks::IncomingWebhookEvent::EventNotSupported), + } } fn get_webhook_resource_object( &self, - _request: &webhooks::IncomingWebhookRequestDetails<'_>, + request: &webhooks::IncomingWebhookRequestDetails<'_>, ) -> CustomResult<Box<dyn masking::ErasedMaskSerialize>, errors::ConnectorError> { - Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + let webhook_body = String::from_utf8(request.body.to_vec()) + .change_context(errors::ConnectorError::WebhookResourceObjectNotFound)?; + + let webhook_event: silverflow::SilverflowWebhookEvent = webhook_body + .parse_struct("SilverflowWebhookEvent") + .change_context(errors::ConnectorError::WebhookResourceObjectNotFound)?; + + Ok(Box::new(webhook_event)) + } + + fn get_webhook_source_verification_algorithm( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<Box<dyn crypto::VerifySignature + Send>, errors::ConnectorError> { + Ok(Box::new(crypto::HmacSha256)) + } + + fn get_webhook_source_verification_signature( + &self, + request: &webhooks::IncomingWebhookRequestDetails<'_>, + _connector_webhook_secrets: &api_models::webhooks::ConnectorWebhookSecrets, + ) -> CustomResult<Vec<u8>, errors::ConnectorError> { + let signature = request + .headers + .get("X-Silverflow-Signature") + .ok_or(errors::ConnectorError::WebhookSignatureNotFound)? + .to_str() + .change_context(errors::ConnectorError::WebhookSignatureNotFound)?; + + hex::decode(signature).change_context(errors::ConnectorError::WebhookSignatureNotFound) + } + + fn get_webhook_source_verification_message( + &self, + request: &webhooks::IncomingWebhookRequestDetails<'_>, + _merchant_id: &common_utils::id_type::MerchantId, + _connector_webhook_secrets: &api_models::webhooks::ConnectorWebhookSecrets, + ) -> CustomResult<Vec<u8>, errors::ConnectorError> { + Ok(request.body.to_vec()) } } static SILVERFLOW_SUPPORTED_PAYMENT_METHODS: LazyLock<SupportedPaymentMethods> = - LazyLock::new(SupportedPaymentMethods::new); + LazyLock::new(|| { + let supported_capture_methods = vec![ + enums::CaptureMethod::Automatic, + enums::CaptureMethod::Manual, + ]; + + let supported_card_networks = vec![ + CardNetwork::Visa, + CardNetwork::Mastercard, + CardNetwork::AmericanExpress, + CardNetwork::Discover, + ]; + + let mut silverflow_supported_payment_methods = SupportedPaymentMethods::new(); + + silverflow_supported_payment_methods.add( + enums::PaymentMethod::Card, + enums::PaymentMethodType::Credit, + PaymentMethodDetails { + mandates: enums::FeatureStatus::NotSupported, + refunds: enums::FeatureStatus::Supported, + supported_capture_methods: supported_capture_methods.clone(), + specific_features: Some( + api_models::feature_matrix::PaymentMethodSpecificFeatures::Card({ + api_models::feature_matrix::CardSpecificFeatures { + three_ds: common_enums::FeatureStatus::NotSupported, + no_three_ds: common_enums::FeatureStatus::Supported, + supported_card_networks: supported_card_networks.clone(), + } + }), + ), + }, + ); + + silverflow_supported_payment_methods.add( + enums::PaymentMethod::Card, + enums::PaymentMethodType::Debit, + PaymentMethodDetails { + mandates: enums::FeatureStatus::NotSupported, + refunds: enums::FeatureStatus::Supported, + supported_capture_methods: supported_capture_methods.clone(), + specific_features: Some( + api_models::feature_matrix::PaymentMethodSpecificFeatures::Card({ + api_models::feature_matrix::CardSpecificFeatures { + three_ds: common_enums::FeatureStatus::NotSupported, + no_three_ds: common_enums::FeatureStatus::Supported, + supported_card_networks: supported_card_networks.clone(), + } + }), + ), + }, + ); + + silverflow_supported_payment_methods + }); static SILVERFLOW_CONNECTOR_INFO: ConnectorInfo = ConnectorInfo { display_name: "Silverflow", - description: "Silverflow connector", + description: "Silverflow is a global payment processor that provides secure and reliable payment processing services with support for multiple capture methods and 3DS authentication.", connector_type: enums::PaymentConnectorCategory::PaymentGateway, }; -static SILVERFLOW_SUPPORTED_WEBHOOK_FLOWS: [enums::EventClass; 0] = []; +static SILVERFLOW_SUPPORTED_WEBHOOK_FLOWS: [enums::EventClass; 2] = + [enums::EventClass::Payments, enums::EventClass::Refunds]; impl ConnectorSpecifications for Silverflow { fn get_connector_about(&self) -> Option<&'static ConnectorInfo> { diff --git a/crates/hyperswitch_connectors/src/connectors/silverflow/transformers.rs b/crates/hyperswitch_connectors/src/connectors/silverflow/transformers.rs index 8a1bb52a5bb..87a99417dd6 100644 --- a/crates/hyperswitch_connectors/src/connectors/silverflow/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/silverflow/transformers.rs @@ -1,27 +1,33 @@ use common_enums::enums; -use common_utils::types::StringMinorUnit; +use common_utils::types::MinorUnit; use hyperswitch_domain_models::{ payment_method_data::PaymentMethodData, router_data::{ConnectorAuthType, RouterData}, - router_flow_types::refunds::{Execute, RSync}, - router_request_types::ResponseId, + router_flow_types::{ + payments::Void, + refunds::{Execute, RSync}, + }, + router_request_types::{PaymentsCancelData, ResponseId}, router_response_types::{PaymentsResponseData, RefundsResponseData}, - types::{PaymentsAuthorizeRouterData, RefundsRouterData}, + types::{PaymentsAuthorizeRouterData, PaymentsCaptureRouterData, RefundsRouterData}, }; use hyperswitch_interfaces::errors; -use masking::Secret; +use masking::{ExposeInterface, PeekInterface, Secret}; use serde::{Deserialize, Serialize}; -use crate::types::{RefundsResponseRouterData, ResponseRouterData}; +use crate::{ + types::{RefundsResponseRouterData, ResponseRouterData}, + utils::CardData, +}; //TODO: Fill the struct with respective fields pub struct SilverflowRouterData<T> { - pub amount: StringMinorUnit, // The type of amount that a connector accepts, for example, String, i64, f64, etc. + pub amount: MinorUnit, // The type of amount that a connector accepts, for example, String, i64, f64, etc. pub router_data: T, } -impl<T> From<(StringMinorUnit, T)> for SilverflowRouterData<T> { - fn from((amount, item): (StringMinorUnit, T)) -> Self { +impl<T> From<(MinorUnit, T)> for SilverflowRouterData<T> { + fn from((amount, item): (MinorUnit, T)) -> Self { //Todo : use utils to convert the amount to the type of amount that a connector accepts Self { amount, @@ -30,20 +36,45 @@ impl<T> From<(StringMinorUnit, T)> for SilverflowRouterData<T> { } } -//TODO: Fill the struct with respective fields -#[derive(Default, Debug, Serialize, PartialEq)] -pub struct SilverflowPaymentsRequest { - amount: StringMinorUnit, - card: SilverflowCard, +// Basic structures for Silverflow API +#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] +pub struct Amount { + value: MinorUnit, + currency: String, } -#[derive(Default, Debug, Serialize, Eq, PartialEq)] -pub struct SilverflowCard { +#[derive(Default, Debug, Serialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct Card { number: cards::CardNumber, expiry_month: Secret<String>, expiry_year: Secret<String>, cvc: Secret<String>, - complete: bool, + holder_name: Option<Secret<String>>, +} + +#[derive(Default, Debug, Serialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct MerchantAcceptorResolver { + merchant_acceptor_key: String, +} + +#[derive(Default, Debug, Serialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct SilverflowPaymentsRequest { + merchant_acceptor_resolver: MerchantAcceptorResolver, + card: Card, + amount: Amount, + #[serde(rename = "type")] + payment_type: PaymentType, +} + +#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct PaymentType { + intent: String, + card_entry: String, + order: String, } impl TryFrom<&SilverflowRouterData<&PaymentsAuthorizeRouterData>> for SilverflowPaymentsRequest { @@ -52,58 +83,184 @@ impl TryFrom<&SilverflowRouterData<&PaymentsAuthorizeRouterData>> for Silverflow item: &SilverflowRouterData<&PaymentsAuthorizeRouterData>, ) -> Result<Self, Self::Error> { match item.router_data.request.payment_method_data.clone() { - PaymentMethodData::Card(_) => Err(errors::ConnectorError::NotImplemented( - "Card payment method not implemented".to_string(), - ) - .into()), + PaymentMethodData::Card(req_card) => { + // Extract merchant acceptor key from connector auth + let auth = SilverflowAuthType::try_from(&item.router_data.connector_auth_type)?; + + let card = Card { + number: req_card.card_number.clone(), + expiry_month: req_card.card_exp_month.clone(), + expiry_year: req_card.card_exp_year.clone(), + cvc: req_card.card_cvc.clone(), + holder_name: req_card.get_cardholder_name().ok(), + }; + + Ok(Self { + merchant_acceptor_resolver: MerchantAcceptorResolver { + merchant_acceptor_key: auth.merchant_acceptor_key.expose(), + }, + card, + amount: Amount { + value: item.amount, + currency: item.router_data.request.currency.to_string(), + }, + payment_type: PaymentType { + intent: "purchase".to_string(), + card_entry: "e-commerce".to_string(), + order: "checkout".to_string(), + }, + }) + } _ => Err(errors::ConnectorError::NotImplemented("Payment method".to_string()).into()), } } } -//TODO: Fill the struct with respective fields -// Auth Struct +// Auth Struct for HTTP Basic Authentication pub struct SilverflowAuthType { pub(super) api_key: Secret<String>, + pub(super) api_secret: Secret<String>, + pub(super) merchant_acceptor_key: Secret<String>, } impl TryFrom<&ConnectorAuthType> for SilverflowAuthType { 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(), + ConnectorAuthType::SignatureKey { + api_key, + key1, + api_secret, + } => Ok(Self { + api_key: api_key.clone(), + api_secret: api_secret.clone(), + merchant_acceptor_key: key1.clone(), }), _ => Err(errors::ConnectorError::FailedToObtainAuthType.into()), } } } -// PaymentsResponse -//TODO: Append the remaining status flags -#[derive(Debug, Clone, Copy, Default, Serialize, Deserialize, PartialEq)] +// Enum for Silverflow payment authorization status +#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] #[serde(rename_all = "lowercase")] -pub enum SilverflowPaymentStatus { - Succeeded, +pub enum SilverflowAuthorizationStatus { + Approved, + Declined, Failed, #[default] - Processing, + Pending, } -impl From<SilverflowPaymentStatus> for common_enums::AttemptStatus { - fn from(item: SilverflowPaymentStatus) -> Self { - match item { - SilverflowPaymentStatus::Succeeded => Self::Charged, - SilverflowPaymentStatus::Failed => Self::Failure, - SilverflowPaymentStatus::Processing => Self::Authorizing, - } - } +// Enum for Silverflow payment clearing status +#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "lowercase")] +pub enum SilverflowClearingStatus { + Cleared, + #[default] + Pending, + Failed, +} + +// Payment Authorization Response Structures +#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] +pub struct PaymentStatus { + pub authentication: String, + pub authorization: SilverflowAuthorizationStatus, + pub clearing: SilverflowClearingStatus, +} + +#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] +pub struct MerchantAcceptorRef { + pub key: String, + pub version: i32, +} + +#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct CardResponse { + pub masked_number: String, +} + +#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] +pub struct Authentication { + pub sca: SCA, + pub cvc: Secret<String>, + pub avs: String, } -//TODO: Fill the struct with respective fields #[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct SCA { + pub compliance: String, + pub compliance_reason: String, + pub method: String, + #[serde(skip_serializing_if = "Option::is_none")] + pub result: Option<SCAResult>, +} + +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct SCAResult { + pub version: String, + pub directory_server_trans_id: String, +} + +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct AuthorizationIsoFields { + pub response_code: String, + pub response_code_description: String, + pub authorization_code: String, + pub network_code: String, + pub system_trace_audit_number: Secret<String>, + pub retrieval_reference_number: String, + pub eci: String, + pub network_specific_fields: NetworkSpecificFields, +} + +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct NetworkSpecificFields { + pub transaction_identifier: String, + pub cvv2_result_code: String, +} + +#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] pub struct SilverflowPaymentsResponse { - status: SilverflowPaymentStatus, - id: String, + pub key: String, + pub merchant_acceptor_ref: MerchantAcceptorRef, + pub card: CardResponse, + pub amount: Amount, + #[serde(rename = "type")] + pub payment_type: PaymentType, + pub clearing_mode: String, + pub status: PaymentStatus, + pub authentication: Authentication, + pub local_transaction_date_time: String, + pub fraud_liability: String, + pub authorization_iso_fields: Option<AuthorizationIsoFields>, + pub created: String, + pub version: i32, +} + +impl From<&PaymentStatus> for common_enums::AttemptStatus { + fn from(status: &PaymentStatus) -> Self { + match (&status.authorization, &status.clearing) { + (SilverflowAuthorizationStatus::Approved, SilverflowClearingStatus::Cleared) => { + Self::Charged + } + (SilverflowAuthorizationStatus::Approved, SilverflowClearingStatus::Pending) => { + Self::Authorized + } + (SilverflowAuthorizationStatus::Approved, SilverflowClearingStatus::Failed) => { + Self::Failure + } + (SilverflowAuthorizationStatus::Declined, _) => Self::Failure, + (SilverflowAuthorizationStatus::Failed, _) => Self::Failure, + (SilverflowAuthorizationStatus::Pending, _) => Self::Pending, + } + } } impl<F, T> TryFrom<ResponseRouterData<F, SilverflowPaymentsResponse, T, PaymentsResponseData>> @@ -114,15 +271,207 @@ impl<F, T> TryFrom<ResponseRouterData<F, SilverflowPaymentsResponse, T, Payments item: ResponseRouterData<F, SilverflowPaymentsResponse, T, PaymentsResponseData>, ) -> Result<Self, Self::Error> { Ok(Self { - status: common_enums::AttemptStatus::from(item.response.status), + status: common_enums::AttemptStatus::from(&item.response.status), response: Ok(PaymentsResponseData::TransactionResponse { - resource_id: ResponseId::ConnectorTransactionId(item.response.id), + resource_id: ResponseId::ConnectorTransactionId(item.response.key.clone()), + redirection_data: Box::new(None), + mandate_reference: Box::new(None), + connector_metadata: None, + network_txn_id: item + .response + .authorization_iso_fields + .as_ref() + .map(|fields| { + fields + .network_specific_fields + .transaction_identifier + .clone() + }), + connector_response_reference_id: Some(item.response.key.clone()), + incremental_authorization_allowed: Some(false), + charges: None, + }), + ..item.data + }) + } +} + +// CAPTURE: +// Type definition for CaptureRequest based on Silverflow API documentation +#[derive(Default, Debug, Serialize)] +#[serde(rename_all = "camelCase")] +pub struct SilverflowCaptureRequest { + #[serde(skip_serializing_if = "Option::is_none")] + pub amount: Option<i64>, + #[serde(skip_serializing_if = "Option::is_none")] + pub close_charge: Option<bool>, + #[serde(skip_serializing_if = "Option::is_none")] + pub reference: Option<String>, +} + +impl TryFrom<&PaymentsCaptureRouterData> for SilverflowCaptureRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from(item: &PaymentsCaptureRouterData) -> Result<Self, Self::Error> { + // amount_to_capture is directly an i64, representing the amount in minor units + let amount_to_capture = Some(item.request.amount_to_capture); + + Ok(Self { + amount: amount_to_capture, + close_charge: Some(true), // Default to closing charge after capture + reference: Some(format!("capture-{}", item.payment_id)), + }) + } +} + +// Enum for Silverflow capture status +#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "lowercase")] +pub enum SilverflowCaptureStatus { + Completed, + #[default] + Pending, + Failed, +} + +// Type definition for CaptureResponse based on Silverflow clearing action response +#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct SilverflowCaptureResponse { + #[serde(rename = "type")] + pub action_type: String, + pub key: String, + pub charge_key: String, + pub status: SilverflowCaptureStatus, + #[serde(skip_serializing_if = "Option::is_none")] + pub reference: Option<String>, + pub amount: Amount, + pub created: String, + pub last_modified: String, + pub version: i32, +} + +impl From<&SilverflowCaptureResponse> for common_enums::AttemptStatus { + fn from(response: &SilverflowCaptureResponse) -> Self { + match response.status { + SilverflowCaptureStatus::Completed => Self::Charged, + SilverflowCaptureStatus::Pending => Self::Pending, + SilverflowCaptureStatus::Failed => Self::Failure, + } + } +} + +impl<F, T> TryFrom<ResponseRouterData<F, SilverflowCaptureResponse, T, PaymentsResponseData>> + for RouterData<F, T, PaymentsResponseData> +{ + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: ResponseRouterData<F, SilverflowCaptureResponse, T, PaymentsResponseData>, + ) -> Result<Self, Self::Error> { + Ok(Self { + status: common_enums::AttemptStatus::from(&item.response), + response: Ok(PaymentsResponseData::TransactionResponse { + resource_id: ResponseId::ConnectorTransactionId(item.response.charge_key.clone()), redirection_data: Box::new(None), mandate_reference: Box::new(None), connector_metadata: None, network_txn_id: None, - connector_response_reference_id: None, - incremental_authorization_allowed: None, + connector_response_reference_id: Some(item.response.key.clone()), + incremental_authorization_allowed: Some(false), + charges: None, + }), + ..item.data + }) + } +} + +// VOID/REVERSE: +// Type definition for Reverse Charge Request based on Silverflow API documentation +#[derive(Default, Debug, Serialize)] +#[serde(rename_all = "camelCase")] +pub struct SilverflowVoidRequest { + #[serde(skip_serializing_if = "Option::is_none")] + pub replacement_amount: Option<i64>, + #[serde(skip_serializing_if = "Option::is_none")] + pub reference: Option<String>, +} + +impl TryFrom<&RouterData<Void, PaymentsCancelData, PaymentsResponseData>> + for SilverflowVoidRequest +{ + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: &RouterData<Void, PaymentsCancelData, PaymentsResponseData>, + ) -> Result<Self, Self::Error> { + Ok(Self { + replacement_amount: Some(0), // Default to 0 for full reversal + reference: Some(format!("void-{}", item.payment_id)), + }) + } +} + +// Enum for Silverflow void authorization status +#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "lowercase")] +pub enum SilverflowVoidAuthorizationStatus { + Approved, + Declined, + Failed, + #[default] + Pending, +} + +// Type definition for Void Status (only authorization, no clearing) +#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] +pub struct VoidStatus { + pub authorization: SilverflowVoidAuthorizationStatus, +} + +// Type definition for Reverse Charge Response based on Silverflow API documentation +#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct SilverflowVoidResponse { + #[serde(rename = "type")] + pub action_type: String, + pub key: String, + pub charge_key: String, + #[serde(skip_serializing_if = "Option::is_none")] + pub reference: Option<String>, + pub replacement_amount: Amount, + pub status: VoidStatus, + pub authorization_response: Option<AuthorizationResponse>, + pub created: String, + pub last_modified: String, + pub version: i32, +} + +impl From<&SilverflowVoidResponse> for common_enums::AttemptStatus { + fn from(response: &SilverflowVoidResponse) -> Self { + match response.status.authorization { + SilverflowVoidAuthorizationStatus::Approved => Self::Voided, + SilverflowVoidAuthorizationStatus::Declined + | SilverflowVoidAuthorizationStatus::Failed => Self::VoidFailed, + SilverflowVoidAuthorizationStatus::Pending => Self::Pending, + } + } +} + +impl<F, T> TryFrom<ResponseRouterData<F, SilverflowVoidResponse, T, PaymentsResponseData>> + for RouterData<F, T, PaymentsResponseData> +{ + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: ResponseRouterData<F, SilverflowVoidResponse, T, PaymentsResponseData>, + ) -> Result<Self, Self::Error> { + Ok(Self { + status: common_enums::AttemptStatus::from(&item.response), + response: Ok(PaymentsResponseData::TransactionResponse { + resource_id: ResponseId::ConnectorTransactionId(item.response.charge_key.clone()), + redirection_data: Box::new(None), + mandate_reference: Box::new(None), + connector_metadata: None, + network_txn_id: None, + connector_response_reference_id: Some(item.response.key.clone()), + incremental_authorization_allowed: Some(false), charges: None, }), ..item.data @@ -130,50 +479,90 @@ impl<F, T> TryFrom<ResponseRouterData<F, SilverflowPaymentsResponse, T, Payments } } -//TODO: Fill the struct with respective fields // REFUND : +// Type definition for DynamicDescriptor +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct DynamicDescriptor { + pub merchant_name: String, + pub merchant_city: String, +} + // Type definition for RefundRequest #[derive(Default, Debug, Serialize)] pub struct SilverflowRefundRequest { - pub amount: StringMinorUnit, + #[serde(rename = "refundAmount")] + pub refund_amount: MinorUnit, + pub reference: String, } impl<F> TryFrom<&SilverflowRouterData<&RefundsRouterData<F>>> for SilverflowRefundRequest { type Error = error_stack::Report<errors::ConnectorError>; fn try_from(item: &SilverflowRouterData<&RefundsRouterData<F>>) -> Result<Self, Self::Error> { Ok(Self { - amount: item.amount.to_owned(), + refund_amount: item.amount, + reference: format!("refund-{}", item.router_data.request.refund_id), }) } } -// Type definition for Refund Response +// Type definition for Authorization Response +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct AuthorizationResponse { + pub network: String, + + pub response_code: String, + + pub response_code_description: String, +} -#[allow(dead_code)] -#[derive(Debug, Copy, Serialize, Default, Deserialize, Clone)] -pub enum RefundStatus { - Succeeded, +// Enum for Silverflow refund authorization status +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "lowercase")] +pub enum SilverflowRefundAuthorizationStatus { + Approved, + Declined, Failed, + Pending, +} + +// Enum for Silverflow refund status +#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "lowercase")] +pub enum SilverflowRefundStatus { + Success, + Failure, #[default] - Processing, + Pending, } -impl From<RefundStatus> for enums::RefundStatus { - fn from(item: RefundStatus) -> Self { +impl From<&SilverflowRefundStatus> for enums::RefundStatus { + fn from(item: &SilverflowRefundStatus) -> Self { match item { - RefundStatus::Succeeded => Self::Success, - RefundStatus::Failed => Self::Failure, - RefundStatus::Processing => Self::Pending, - //TODO: Review mapping + SilverflowRefundStatus::Success => Self::Success, + SilverflowRefundStatus::Failure => Self::Failure, + SilverflowRefundStatus::Pending => Self::Pending, } } } -//TODO: Fill the struct with respective fields -#[derive(Default, Debug, Clone, Serialize, Deserialize)] +// Type definition for Refund Response +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] pub struct RefundResponse { - id: String, - status: RefundStatus, + #[serde(rename = "type")] + pub action_type: String, + pub key: String, + pub charge_key: String, + pub reference: String, + pub amount: Amount, + pub status: SilverflowRefundStatus, + pub clear_after: Option<String>, + pub authorization_response: Option<AuthorizationResponse>, + pub created: String, + pub last_modified: String, + pub version: i32, } impl TryFrom<RefundsResponseRouterData<Execute, RefundResponse>> for RefundsRouterData<Execute> { @@ -183,8 +572,8 @@ impl TryFrom<RefundsResponseRouterData<Execute, RefundResponse>> for RefundsRout ) -> Result<Self, Self::Error> { Ok(Self { response: Ok(RefundsResponseData { - connector_refund_id: item.response.id.to_string(), - refund_status: enums::RefundStatus::from(item.response.status), + connector_refund_id: item.response.key.clone(), + refund_status: enums::RefundStatus::from(&item.response.status), }), ..item.data }) @@ -198,22 +587,189 @@ impl TryFrom<RefundsResponseRouterData<RSync, RefundResponse>> for RefundsRouter ) -> Result<Self, Self::Error> { Ok(Self { response: Ok(RefundsResponseData { - connector_refund_id: item.response.id.to_string(), - refund_status: enums::RefundStatus::from(item.response.status), + connector_refund_id: item.response.key.clone(), + refund_status: enums::RefundStatus::from(&item.response.status), }), ..item.data }) } } -//TODO: Fill the struct with respective fields +// TOKENIZATION: +// Type definition for TokenizationRequest +#[derive(Default, Debug, Serialize)] +#[serde(rename_all = "camelCase")] +pub struct SilverflowTokenizationRequest { + pub reference: String, + + pub card_data: SilverflowCardData, +} + +#[derive(Default, Debug, Serialize)] +#[serde(rename_all = "camelCase")] +pub struct SilverflowCardData { + pub number: String, + pub expiry_month: Secret<String>, + pub expiry_year: Secret<String>, + pub cvc: String, + pub holder_name: String, +} + +impl TryFrom<&PaymentsAuthorizeRouterData> for SilverflowTokenizationRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from(item: &PaymentsAuthorizeRouterData) -> Result<Self, Self::Error> { + match item.request.payment_method_data.clone() { + PaymentMethodData::Card(req_card) => { + let card_data = SilverflowCardData { + number: req_card.card_number.peek().to_string(), + expiry_month: req_card.card_exp_month.clone(), + expiry_year: req_card.card_exp_year.clone(), + cvc: req_card.card_cvc.clone().expose(), + holder_name: req_card + .get_cardholder_name() + .unwrap_or(Secret::new("".to_string())) + .expose(), + }; + + Ok(Self { + reference: format!("CUSTOMER_ID_{}", item.payment_id), + card_data, + }) + } + _ => Err(errors::ConnectorError::NotImplemented("Payment method".to_string()).into()), + } + } +} + +// Add TryFrom implementation for direct tokenization router data +impl + TryFrom< + &RouterData< + hyperswitch_domain_models::router_flow_types::payments::PaymentMethodToken, + hyperswitch_domain_models::router_request_types::PaymentMethodTokenizationData, + PaymentsResponseData, + >, + > for SilverflowTokenizationRequest +{ + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: &RouterData< + hyperswitch_domain_models::router_flow_types::payments::PaymentMethodToken, + hyperswitch_domain_models::router_request_types::PaymentMethodTokenizationData, + PaymentsResponseData, + >, + ) -> Result<Self, Self::Error> { + match item.request.payment_method_data.clone() { + PaymentMethodData::Card(req_card) => { + let card_data = SilverflowCardData { + number: req_card.card_number.peek().to_string(), + expiry_month: req_card.card_exp_month.clone(), + expiry_year: req_card.card_exp_year.clone(), + cvc: req_card.card_cvc.clone().expose(), + holder_name: req_card + .get_cardholder_name() + .unwrap_or(Secret::new("".to_string())) + .expose(), + }; + + Ok(Self { + reference: format!("CUSTOMER_ID_{}", item.payment_id), + card_data, + }) + } + _ => Err(errors::ConnectorError::NotImplemented("Payment method".to_string()).into()), + } + } +} + +// Type definition for TokenizationResponse +#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] +pub struct SilverflowTokenizationResponse { + pub key: String, + #[serde(rename = "agentKey")] + pub agent_key: String, + pub last4: String, + pub status: String, + pub reference: String, + #[serde(rename = "cardInfo")] + pub card_info: Vec<CardInfo>, + pub created: String, + #[serde(rename = "cvcPresent")] + pub cvc_present: bool, + pub version: i32, +} + +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +pub struct CardInfo { + #[serde(rename = "infoSource")] + pub info_source: String, + pub network: String, + #[serde(rename = "primaryNetwork")] + pub primary_network: bool, +} + +impl<F, T> TryFrom<ResponseRouterData<F, SilverflowTokenizationResponse, T, PaymentsResponseData>> + for RouterData<F, T, PaymentsResponseData> +{ + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: ResponseRouterData<F, SilverflowTokenizationResponse, T, PaymentsResponseData>, + ) -> Result<Self, Self::Error> { + Ok(Self { + response: Ok(PaymentsResponseData::TokenizationResponse { + token: item.response.key, + }), + ..item.data + }) + } +} + +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct TokenizedCardDetails { + pub masked_card_number: String, + pub expiry_month: Secret<String>, + pub expiry_year: Secret<String>, + pub card_brand: String, +} + +// WEBHOOKS: +// Type definition for Webhook Event structures +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct SilverflowWebhookEvent { + pub event_type: String, + pub event_data: SilverflowWebhookEventData, + pub event_id: String, + pub created: String, + pub version: i32, +} + +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct SilverflowWebhookEventData { + pub charge_key: Option<String>, + pub refund_key: Option<String>, + pub status: Option<PaymentStatus>, + pub amount: Option<Amount>, + pub transaction_reference: Option<String>, +} + +// Error Response Structures based on Silverflow API format +#[derive(Debug, Serialize, Deserialize, PartialEq)] +pub struct ErrorDetails { + pub field: String, + pub issue: String, +} + #[derive(Default, Debug, Serialize, Deserialize, PartialEq)] pub struct SilverflowErrorResponse { - pub status_code: u16, + pub error: SilverflowError, +} + +#[derive(Default, Debug, Serialize, Deserialize, PartialEq)] +pub struct SilverflowError { pub code: String, pub message: String, - pub reason: Option<String>, - pub network_advice_code: Option<String>, - pub network_decline_code: Option<String>, - pub network_error_message: Option<String>, + pub details: Option<ErrorDetails>, } diff --git a/crates/test_utils/src/connector_auth.rs b/crates/test_utils/src/connector_auth.rs index 1d45f8fb6ff..605be655816 100644 --- a/crates/test_utils/src/connector_auth.rs +++ b/crates/test_utils/src/connector_auth.rs @@ -101,7 +101,7 @@ pub struct ConnectorAuthentication { pub redsys: Option<HeaderKey>, pub santander: Option<BodyKey>, pub shift4: Option<HeaderKey>, - pub silverflow: Option<BodyKey>, + pub silverflow: Option<SignatureKey>, pub square: Option<BodyKey>, pub stax: Option<HeaderKey>, pub stripe: Option<HeaderKey>,

2025-07-09T14:05:09Z

## Type of Change  - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description Cards Non-3DS payments added for silverflow (Alpha Integration). Ref: https://www.silverflow.com/ ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  https://github.com/juspay/hyperswitch/issues/8592 ## How did you test it? Compilation and Clippy checks by cargo build and cargo clippy No cypress due to Alpha integration. ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

6214aca5f0f5c617a68f65ef5bcfd700060acccf

juspay/hyperswitch

juspay__hyperswitch-8588

Bug: refactor(dynamic_routing): make the dynamo configs optional

diff --git a/crates/external_services/src/grpc_client.rs b/crates/external_services/src/grpc_client.rs index 5a9bd6143da..1b93ac6bd89 100644 --- a/crates/external_services/src/grpc_client.rs +++ b/crates/external_services/src/grpc_client.rs @@ -35,7 +35,7 @@ pub type Client = hyper_util::client::legacy::Client<HttpConnector, Body>; pub struct GrpcClients { /// The routing client #[cfg(feature = "dynamic_routing")] - pub dynamic_routing: RoutingStrategy, + pub dynamic_routing: Option<RoutingStrategy>, /// Health Check client for all gRPC services #[cfg(feature = "dynamic_routing")] pub health_client: HealthCheckClient, @@ -47,7 +47,7 @@ pub struct GrpcClients { pub struct GrpcClientSettings { #[cfg(feature = "dynamic_routing")] /// Configs for Dynamic Routing Client - pub dynamic_routing_client: DynamicRoutingClientConfig, + pub dynamic_routing_client: Option<DynamicRoutingClientConfig>, /// Configs for Unified Connector Service client pub unified_connector_service: Option<UnifiedConnectorServiceClientConfig>, } @@ -69,9 +69,10 @@ impl GrpcClientSettings { let dynamic_routing_connection = self .dynamic_routing_client .clone() - .get_dynamic_routing_connection(client.clone()) - .await - .expect("Failed to establish a connection with the Dynamic Routing Server"); + .map(|config| config.get_dynamic_routing_connection(client.clone())) + .transpose() + .expect("Failed to establish a connection with the Dynamic Routing Server") + .flatten(); #[cfg(feature = "dynamic_routing")] let health_client = HealthCheckClient::build_connections(self, client) diff --git a/crates/external_services/src/grpc_client/dynamic_routing.rs b/crates/external_services/src/grpc_client/dynamic_routing.rs index a9ee7852d31..f4aeec76551 100644 --- a/crates/external_services/src/grpc_client/dynamic_routing.rs +++ b/crates/external_services/src/grpc_client/dynamic_routing.rs @@ -47,11 +47,11 @@ pub enum DynamicRoutingError { #[derive(Debug, Clone)] pub struct RoutingStrategy { /// success rate service for Dynamic Routing - pub success_rate_client: Option<SuccessRateCalculatorClient<Client>>, + pub success_rate_client: SuccessRateCalculatorClient<Client>, /// contract based routing service for Dynamic Routing - pub contract_based_client: Option<ContractScoreCalculatorClient<Client>>, + pub contract_based_client: ContractScoreCalculatorClient<Client>, /// elimination service for Dynamic Routing - pub elimination_based_client: Option<EliminationAnalyserClient<Client>>, + pub elimination_based_client: EliminationAnalyserClient<Client>, } /// Contains the Dynamic Routing Client Config @@ -74,32 +74,28 @@ pub enum DynamicRoutingClientConfig { impl DynamicRoutingClientConfig { /// establish connection with the server - pub async fn get_dynamic_routing_connection( + pub fn get_dynamic_routing_connection( self, client: Client, - ) -> Result<RoutingStrategy, Box<dyn std::error::Error>> { - let (success_rate_client, contract_based_client, elimination_based_client) = match self { + ) -> Result<Option<RoutingStrategy>, Box<dyn std::error::Error>> { + match self { Self::Enabled { host, port, .. } => { let uri = format!("http://{host}:{port}").parse::<tonic::transport::Uri>()?; logger::info!("Connection established with dynamic routing gRPC Server"); - ( - Some(SuccessRateCalculatorClient::with_origin( - client.clone(), - uri.clone(), - )), - Some(ContractScoreCalculatorClient::with_origin( - client.clone(), - uri.clone(), - )), - Some(EliminationAnalyserClient::with_origin(client, uri)), - ) + + let (success_rate_client, contract_based_client, elimination_based_client) = ( + SuccessRateCalculatorClient::with_origin(client.clone(), uri.clone()), + ContractScoreCalculatorClient::with_origin(client.clone(), uri.clone()), + EliminationAnalyserClient::with_origin(client, uri), + ); + + Ok(Some(RoutingStrategy { + success_rate_client, + contract_based_client, + elimination_based_client, + })) } - Self::Disabled => (None, None, None), - }; - Ok(RoutingStrategy { - success_rate_client, - contract_based_client, - elimination_based_client, - }) + Self::Disabled => Ok(None), + } } } diff --git a/crates/external_services/src/grpc_client/health_check_client.rs b/crates/external_services/src/grpc_client/health_check_client.rs index 94d78df7955..e0dac3a8fb9 100644 --- a/crates/external_services/src/grpc_client/health_check_client.rs +++ b/crates/external_services/src/grpc_client/health_check_client.rs @@ -53,11 +53,11 @@ impl HealthCheckClient { ) -> Result<Self, Box<dyn std::error::Error>> { let dynamic_routing_config = &config.dynamic_routing_client; let connection = match dynamic_routing_config { - DynamicRoutingClientConfig::Enabled { + Some(DynamicRoutingClientConfig::Enabled { host, port, service, - } => Some((host.clone(), *port, service.clone())), + }) => Some((host.clone(), *port, service.clone())), _ => None, }; @@ -81,11 +81,11 @@ impl HealthCheckClient { ) -> HealthCheckResult<HealthCheckMap> { let dynamic_routing_config = &config.dynamic_routing_client; let connection = match dynamic_routing_config { - DynamicRoutingClientConfig::Enabled { + Some(DynamicRoutingClientConfig::Enabled { host, port, service, - } => Some((host.clone(), *port, service.clone())), + }) => Some((host.clone(), *port, service.clone())), _ => None, }; diff --git a/crates/router/src/core/payments/routing.rs b/crates/router/src/core/payments/routing.rs index 7feea3286ca..87ed5ff40a8 100644 --- a/crates/router/src/core/payments/routing.rs +++ b/crates/router/src/core/payments/routing.rs @@ -2100,13 +2100,13 @@ where "performing success_based_routing for profile {}", profile_id.get_string_repr() ); - let client = state + let client = &state .grpc_client .dynamic_routing - .success_rate_client .as_ref() .ok_or(errors::RoutingError::SuccessRateClientInitializationError) - .attach_printable("success_rate gRPC client not found")?; + .attach_printable("dynamic routing gRPC client not found")? + .success_rate_client; let success_based_routing_configs = routing::helpers::fetch_dynamic_routing_configs::< api_routing::SuccessBasedRoutingConfig, @@ -2284,13 +2284,13 @@ pub async fn perform_elimination_routing( "performing elimination_routing for profile {}", profile_id.get_string_repr() ); - let client = state + let client = &state .grpc_client .dynamic_routing - .elimination_based_client .as_ref() .ok_or(errors::RoutingError::EliminationClientInitializationError) - .attach_printable("elimination routing's gRPC client not found")?; + .attach_printable("dynamic routing gRPC client not found")? + .elimination_based_client; let elimination_routing_config = routing::helpers::fetch_dynamic_routing_configs::< api_routing::EliminationRoutingConfig, @@ -2484,13 +2484,13 @@ where "performing contract_based_routing for profile {}", profile_id.get_string_repr() ); - let client = state + let client = &state .grpc_client .dynamic_routing - .contract_based_client .as_ref() .ok_or(errors::RoutingError::ContractRoutingClientInitializationError) - .attach_printable("contract routing gRPC client not found")?; + .attach_printable("dynamic routing gRPC client not found")? + .contract_based_client; let contract_based_routing_configs = routing::helpers::fetch_dynamic_routing_configs::< api_routing::ContractBasedRoutingConfig, diff --git a/crates/router/src/core/routing.rs b/crates/router/src/core/routing.rs index 52a3b4f1a7b..806a01235f3 100644 --- a/crates/router/src/core/routing.rs +++ b/crates/router/src/core/routing.rs @@ -1848,10 +1848,10 @@ pub async fn success_based_routing_update_configs( state .grpc_client .dynamic_routing - .success_rate_client .as_ref() - .async_map(|sr_client| async { - sr_client + .async_map(|dr_client| async { + dr_client + .success_rate_client .invalidate_success_rate_routing_keys( profile_id.get_string_repr().into(), state.get_grpc_headers(), @@ -1952,10 +1952,10 @@ pub async fn elimination_routing_update_configs( state .grpc_client .dynamic_routing - .elimination_based_client .as_ref() - .async_map(|er_client| async { - er_client + .async_map(|dr_client| async { + dr_client + .elimination_based_client .invalidate_elimination_bucket( profile_id.get_string_repr().into(), state.get_grpc_headers(), @@ -2287,12 +2287,11 @@ pub async fn contract_based_routing_update_configs( state .grpc_client - .clone() .dynamic_routing - .contract_based_client - .clone() - .async_map(|ct_client| async move { - ct_client + .as_ref() + .async_map(|dr_client| async { + dr_client + .contract_based_client .invalidate_contracts( profile_id.get_string_repr().into(), state.get_grpc_headers(), diff --git a/crates/router/src/core/routing/helpers.rs b/crates/router/src/core/routing/helpers.rs index 8b4c747d13f..32a7b560566 100644 --- a/crates/router/src/core/routing/helpers.rs +++ b/crates/router/src/core/routing/helpers.rs @@ -845,14 +845,14 @@ pub async fn push_metrics_with_update_window_for_success_based_routing( ) -> RouterResult<()> { if let Some(success_based_algo_ref) = dynamic_routing_algo_ref.success_based_algorithm { if success_based_algo_ref.enabled_feature != routing_types::DynamicRoutingFeatures::None { - let client = state + let client = &state .grpc_client .dynamic_routing - .success_rate_client .as_ref() .ok_or(errors::ApiErrorResponse::GenericNotFoundError { - message: "success_rate gRPC client not found".to_string(), - })?; + message: "dynamic routing gRPC client not found".to_string(), + })? + .success_rate_client; let payment_connector = &payment_attempt.connector.clone().ok_or( errors::ApiErrorResponse::GenericNotFoundError { @@ -1214,14 +1214,14 @@ pub async fn update_window_for_elimination_routing( ) -> RouterResult<()> { if let Some(elimination_algo_ref) = dynamic_algo_ref.elimination_routing_algorithm { if elimination_algo_ref.enabled_feature != routing_types::DynamicRoutingFeatures::None { - let client = state + let client = &state .grpc_client .dynamic_routing - .elimination_based_client .as_ref() .ok_or(errors::ApiErrorResponse::GenericNotFoundError { - message: "elimination_rate gRPC client not found".to_string(), - })?; + message: "dynamic routing gRPC client not found".to_string(), + })? + .elimination_based_client; let elimination_routing_config = fetch_dynamic_routing_configs::< routing_types::EliminationRoutingConfig, @@ -1394,14 +1394,14 @@ pub async fn push_metrics_with_update_window_for_contract_based_routing( if let Some(contract_routing_algo_ref) = dynamic_routing_algo_ref.contract_based_routing { if contract_routing_algo_ref.enabled_feature != routing_types::DynamicRoutingFeatures::None { - let client = state + let client = &state .grpc_client .dynamic_routing - .contract_based_client - .clone() + .as_ref() .ok_or(errors::ApiErrorResponse::GenericNotFoundError { - message: "contract_routing gRPC client not found".to_string(), - })?; + message: "dynamic routing gRPC client not found".to_string(), + })? + .contract_based_client; let payment_connector = &payment_attempt.connector.clone().ok_or( errors::ApiErrorResponse::GenericNotFoundError {

2025-07-09T11:09:09Z

## Type of Change  - [ ] Bugfix - [ ] New feature - [ ] Enhancement - [x] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  This pull request introduces changes to improve the handling of optional configurations for dynamic routing in the gRPC client module. The updates include modifying the `GrpcClientSettings` structure to use `Option` types, enhancing error handling, and simplifying connection establishment logic. Additionally, default implementations are added to certain structs to streamline initialization. ### Enhancements to dynamic routing configuration: * [`crates/external_services/src/grpc_client.rs`](diffhunk://#diff-0129f28e4a26fac6ce00609c3a3542c380baabb72d04d977daa28f364ab319beL50-R51): Changed `dynamic_routing_client` in `GrpcClientSettings` to use `Option<DynamicRoutingClientConfig>` instead of a direct type, allowing for better handling of cases where the configuration might be absent. * [`crates/external_services/src/grpc_client.rs`](diffhunk://#diff-0129f28e4a26fac6ce00609c3a3542c380baabb72d04d977daa28f364ab319beL72-R77): Updated connection establishment logic to use `async_map` for optional configurations, added error handling with `transpose`, and provided a default value when no connection is established. ### Improvements to struct initialization: * [`crates/external_services/src/grpc_client/dynamic_routing.rs`](diffhunk://#diff-7b95c78b2ff78bd774ff3483d1565e28529f49d7cd3e819944cd6e14471e89f4L47-R47): Added a `Default` implementation to the `RoutingStrategy` struct, simplifying initialization when certain fields are optional. ### Simplification of dynamic routing checks: * [`crates/external_services/src/grpc_client/health_check_client.rs`](diffhunk://#diff-66f886eb2cc6f5e4e295e28e98bd77c97d1769cf82c54dd2c440156cdd9b16f0L56-R60): Refactored logic to handle `DynamicRoutingClientConfig` as an `Option` type, simplifying pattern matching and reducing code duplication. [[1]](diffhunk://#diff-66f886eb2cc6f5e4e295e28e98bd77c97d1769cf82c54dd2c440156cdd9b16f0L56-R60) [[2]](diffhunk://#diff-66f886eb2cc6f5e4e295e28e98bd77c97d1769cf82c54dd2c440156cdd9b16f0L84-R88) ### Added utility for asynchronous operations: * [`crates/external_services/src/grpc_client.rs`](diffhunk://#diff-0129f28e4a26fac6ce00609c3a3542c380baabb72d04d977daa28f364ab319beR13): Imported `AsyncExt` from `common_utils::ext_traits` to leverage its utilities for asynchronous operations like `async_map`. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  ## How did you test it?  This is a configuration level changes making the dynamo configs optional. CI checks should suffice ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

b1c9be1600dbd897c32adcc2d8b98e77ec67c516

juspay/hyperswitch

juspay__hyperswitch-8582

Bug: feat(router): refactor PML response Remove duplicate responses and return bank_names

diff --git a/api-reference/v2/openapi_spec_v2.json b/api-reference/v2/openapi_spec_v2.json index 53bbace7dfb..bd1cee6d8ef 100644 --- a/api-reference/v2/openapi_spec_v2.json +++ b/api-reference/v2/openapi_spec_v2.json @@ -17619,10 +17619,7 @@ ], "properties": { "bank_names": { - "type": "array", - "items": { - "$ref": "#/components/schemas/BankCodeResponse" - } + "$ref": "#/components/schemas/BankNames" } } } @@ -22329,11 +22326,11 @@ "$ref": "#/components/schemas/PaymentMethodType" }, "payment_experience": { - "allOf": [ - { - "$ref": "#/components/schemas/PaymentExperience" - } - ], + "type": "array", + "items": { + "$ref": "#/components/schemas/PaymentExperience" + }, + "description": "The payment experience for the payment method", "nullable": true }, "required_fields": { diff --git a/crates/api_models/src/payment_methods.rs b/crates/api_models/src/payment_methods.rs index 4cdfe9dcfe8..a70dceb962d 100644 --- a/crates/api_models/src/payment_methods.rs +++ b/crates/api_models/src/payment_methods.rs @@ -16,12 +16,11 @@ use masking::PeekInterface; use serde::de; use utoipa::{schema, ToSchema}; +#[cfg(feature = "v1")] +use crate::payments::BankCodeResponse; #[cfg(feature = "payouts")] use crate::payouts; -use crate::{ - admin, enums as api_enums, open_router, - payments::{self, BankCodeResponse}, -}; +use crate::{admin, enums as api_enums, open_router, payments}; #[cfg(feature = "v1")] #[derive(Debug, serde::Deserialize, serde::Serialize, Clone, ToSchema)] @@ -1471,7 +1470,10 @@ pub enum PaymentMethodSubtypeSpecificData { card_networks: Vec<CardNetworkTypes>, }, #[schema(title = "bank")] - Bank { bank_names: Vec<BankCodeResponse> }, + Bank { + #[schema(value_type = BankNames)] + bank_names: Vec<common_enums::BankNames>, + }, } #[cfg(feature = "v2")] diff --git a/crates/api_models/src/payments.rs b/crates/api_models/src/payments.rs index 90792e9633a..3697c555e7e 100644 --- a/crates/api_models/src/payments.rs +++ b/crates/api_models/src/payments.rs @@ -7727,8 +7727,8 @@ pub struct ResponsePaymentMethodTypesForPayments { pub payment_method_subtype: common_enums::PaymentMethodType, /// The payment experience for the payment method - #[schema(value_type = Option<PaymentExperience>)] - pub payment_experience: Option<common_enums::PaymentExperience>, + #[schema(value_type = Option<Vec<PaymentExperience>>)] + pub payment_experience: Option<Vec<common_enums::PaymentExperience>>, /// payment method subtype specific information #[serde(flatten)] diff --git a/crates/common_enums/src/enums.rs b/crates/common_enums/src/enums.rs index 1d00a451708..893473cfbc4 100644 --- a/crates/common_enums/src/enums.rs +++ b/crates/common_enums/src/enums.rs @@ -1832,7 +1832,9 @@ pub enum SamsungPayCardBrand { Copy, Debug, Eq, + Ord, Hash, + PartialOrd, PartialEq, serde::Deserialize, serde::Serialize, @@ -2081,6 +2083,8 @@ impl masking::SerializableSecret for PaymentMethodType {} Debug, Default, Eq, + PartialOrd, + Ord, Hash, PartialEq, serde::Deserialize, diff --git a/crates/router/src/core/payment_methods/vault.rs b/crates/router/src/core/payment_methods/vault.rs index d5848c7f418..ca2d5d1015b 100644 --- a/crates/router/src/core/payment_methods/vault.rs +++ b/crates/router/src/core/payment_methods/vault.rs @@ -1598,7 +1598,7 @@ pub async fn retrieve_and_delete_cvc_from_payment_token( .change_context(errors::ApiErrorResponse::InternalServerError) .attach_printable("Failed to get redis connection")?; - let key = format!("pm_token_{payment_token}_{payment_method}_hyperswitch_cvc"); + let key = format!("pm_token_{payment_token}_{payment_method}_hyperswitch_cvc",); let data = redis_conn .get_key::<bytes::Bytes>(&key.clone().into()) diff --git a/crates/router/src/core/payments/payment_methods.rs b/crates/router/src/core/payments/payment_methods.rs index 1cf17289a24..e21b3b96105 100644 --- a/crates/router/src/core/payments/payment_methods.rs +++ b/crates/router/src/core/payments/payment_methods.rs @@ -1,11 +1,15 @@ //! Contains functions of payment methods that are used in payments //! one of such functions is `list_payment_methods` +use std::collections::{BTreeMap, HashSet}; + use common_utils::{ext_traits::OptionExt, id_type}; use error_stack::ResultExt; use super::errors; -use crate::{core::payment_methods, db::errors::StorageErrorExt, routes, types::domain}; +use crate::{ + core::payment_methods, db::errors::StorageErrorExt, logger, routes, settings, types::domain, +}; #[cfg(feature = "v2")] pub async fn list_payment_methods( @@ -55,10 +59,12 @@ pub async fn list_payment_methods( }; let response = - hyperswitch_domain_models::merchant_connector_account::FlattenedPaymentMethodsEnabled::from_payment_connectors_list(payment_connector_accounts) + FlattenedPaymentMethodsEnabled(hyperswitch_domain_models::merchant_connector_account::FlattenedPaymentMethodsEnabled::from_payment_connectors_list(payment_connector_accounts)) .perform_filtering() + .merge_and_transform() .get_required_fields(RequiredFieldsInput::new()) .perform_surcharge_calculation() + .populate_pm_subtype_specific_data(&state.conf.bank_config) .generate_response(customer_payment_methods); Ok(hyperswitch_domain_models::api::ApplicationResponse::Json( @@ -75,12 +81,79 @@ impl RequiredFieldsInput { } } +struct FlattenedPaymentMethodsEnabled( + hyperswitch_domain_models::merchant_connector_account::FlattenedPaymentMethodsEnabled, +); + +impl FlattenedPaymentMethodsEnabled { + fn perform_filtering(self) -> FilteredPaymentMethodsEnabled { + FilteredPaymentMethodsEnabled(self.0.payment_methods_enabled) + } +} + /// Container for the filtered payment methods struct FilteredPaymentMethodsEnabled( Vec<hyperswitch_domain_models::merchant_connector_account::PaymentMethodsEnabledForConnector>, ); impl FilteredPaymentMethodsEnabled { + fn merge_and_transform(self) -> MergedEnabledPaymentMethodTypes { + let values = self + .0 + .into_iter() + // BTreeMap used to ensure soretd response, otherwise the response is arbitrarily ordered + .fold(BTreeMap::new(), |mut acc, item| { + let key = ( + item.payment_method, + item.payment_methods_enabled.payment_method_subtype, + ); + let (experiences, connectors) = acc + .entry(key) + // HashSet used to ensure payment_experience does not have duplicates, due to multiple connectors for a pm_subtype + .or_insert_with(|| (HashSet::new(), Vec::new())); + + if let Some(experience) = item.payment_methods_enabled.payment_experience { + experiences.insert(experience); + } + connectors.push(item.connector); + + acc + }) + .into_iter() + .map( + |( + (payment_method_type, payment_method_subtype), + (payment_experience, connectors), + )| { + MergedEnabledPaymentMethod { + payment_method_type, + payment_method_subtype, + payment_experience: if payment_experience.is_empty() { + None + } else { + Some(payment_experience.into_iter().collect()) + }, + connectors, + } + }, + ) + .collect(); + MergedEnabledPaymentMethodTypes(values) + } +} + +/// Element container to hold the filtered payment methods with payment_experience and connectors merged for a pm_subtype +struct MergedEnabledPaymentMethod { + payment_method_subtype: common_enums::PaymentMethodType, + payment_method_type: common_enums::PaymentMethod, + payment_experience: Option<Vec<common_enums::PaymentExperience>>, + connectors: Vec<api_models::enums::Connector>, +} + +/// Container to hold the filtered payment methods with payment_experience and connectors merged for a pm_subtype +struct MergedEnabledPaymentMethodTypes(Vec<MergedEnabledPaymentMethod>); + +impl MergedEnabledPaymentMethodTypes { fn get_required_fields( self, _input: RequiredFieldsInput, @@ -91,13 +164,10 @@ impl FilteredPaymentMethodsEnabled { .map( |payment_methods_enabled| RequiredFieldsForEnabledPaymentMethod { required_field: None, - payment_method_type: payment_methods_enabled.payment_method, - payment_method_subtype: payment_methods_enabled - .payment_methods_enabled - .payment_method_subtype, - payment_experience: payment_methods_enabled - .payment_methods_enabled - .payment_experience, + payment_method_type: payment_methods_enabled.payment_method_type, + payment_method_subtype: payment_methods_enabled.payment_method_subtype, + payment_experience: payment_methods_enabled.payment_experience, + connectors: payment_methods_enabled.connectors, }, ) .collect(); @@ -111,18 +181,44 @@ struct RequiredFieldsForEnabledPaymentMethod { required_field: Option<Vec<api_models::payment_methods::RequiredFieldInfo>>, payment_method_subtype: common_enums::PaymentMethodType, payment_method_type: common_enums::PaymentMethod, - payment_experience: Option<common_enums::PaymentExperience>, + payment_experience: Option<Vec<common_enums::PaymentExperience>>, + connectors: Vec<api_models::enums::Connector>, } /// Container to hold the filtered payment methods enabled with required fields struct RequiredFieldsForEnabledPaymentMethodTypes(Vec<RequiredFieldsForEnabledPaymentMethod>); +impl RequiredFieldsForEnabledPaymentMethodTypes { + fn perform_surcharge_calculation( + self, + ) -> RequiredFieldsAndSurchargeForEnabledPaymentMethodTypes { + // TODO: Perform surcharge calculation + let details_with_surcharge = self + .0 + .into_iter() + .map( + |payment_methods_enabled| RequiredFieldsAndSurchargeForEnabledPaymentMethodType { + payment_method_type: payment_methods_enabled.payment_method_type, + required_field: payment_methods_enabled.required_field, + payment_method_subtype: payment_methods_enabled.payment_method_subtype, + payment_experience: payment_methods_enabled.payment_experience, + surcharge: None, + connectors: payment_methods_enabled.connectors, + }, + ) + .collect(); + + RequiredFieldsAndSurchargeForEnabledPaymentMethodTypes(details_with_surcharge) + } +} + /// Element Container to hold the filtered payment methods enabled with required fields and surcharge struct RequiredFieldsAndSurchargeForEnabledPaymentMethodType { required_field: Option<Vec<api_models::payment_methods::RequiredFieldInfo>>, payment_method_subtype: common_enums::PaymentMethodType, payment_method_type: common_enums::PaymentMethod, - payment_experience: Option<common_enums::PaymentExperience>, + payment_experience: Option<Vec<common_enums::PaymentExperience>>, + connectors: Vec<api_models::enums::Connector>, surcharge: Option<api_models::payment_methods::SurchargeDetailsResponse>, } @@ -131,7 +227,105 @@ struct RequiredFieldsAndSurchargeForEnabledPaymentMethodTypes( Vec<RequiredFieldsAndSurchargeForEnabledPaymentMethodType>, ); +fn get_pm_subtype_specific_data( + bank_config: &settings::BankRedirectConfig, + payment_method_type: common_enums::enums::PaymentMethod, + payment_method_subtype: common_enums::enums::PaymentMethodType, + connectors: &[api_models::enums::Connector], +) -> Option<api_models::payment_methods::PaymentMethodSubtypeSpecificData> { + match payment_method_type { + // TODO: Return card_networks + common_enums::PaymentMethod::Card | common_enums::PaymentMethod::CardRedirect => None, + + common_enums::PaymentMethod::BankRedirect + | common_enums::PaymentMethod::BankTransfer + | common_enums::PaymentMethod::BankDebit + | common_enums::PaymentMethod::OpenBanking => { + if let Some(connector_bank_names) = bank_config.0.get(&payment_method_subtype) { + let bank_names = connectors + .iter() + .filter_map(|connector| { + connector_bank_names.0.get(&connector.to_string()) + .map(|connector_hash_set| { + connector_hash_set.banks.clone() + }) + .or_else(|| { + logger::debug!("Could not find any configured connectors for payment_method -> {payment_method_subtype} for connector -> {connector}"); + None + }) + }) + .flatten() + .collect(); + Some( + api_models::payment_methods::PaymentMethodSubtypeSpecificData::Bank { + bank_names, + }, + ) + } else { + logger::debug!("Could not find any configured banks for payment_method -> {payment_method_subtype}"); + None + } + } + + common_enums::PaymentMethod::PayLater + | common_enums::PaymentMethod::Wallet + | common_enums::PaymentMethod::Crypto + | common_enums::PaymentMethod::Reward + | common_enums::PaymentMethod::RealTimePayment + | common_enums::PaymentMethod::Upi + | common_enums::PaymentMethod::Voucher + | common_enums::PaymentMethod::GiftCard + | common_enums::PaymentMethod::MobilePayment => None, + } +} + impl RequiredFieldsAndSurchargeForEnabledPaymentMethodTypes { + fn populate_pm_subtype_specific_data( + self, + bank_config: &settings::BankRedirectConfig, + ) -> RequiredFieldsAndSurchargeWithExtraInfoForEnabledPaymentMethodTypes { + let response_payment_methods = self + .0 + .into_iter() + .map(|payment_methods_enabled| { + RequiredFieldsAndSurchargeWithExtraInfoForEnabledPaymentMethodType { + payment_method_type: payment_methods_enabled.payment_method_type, + payment_method_subtype: payment_methods_enabled.payment_method_subtype, + payment_experience: payment_methods_enabled.payment_experience, + required_field: payment_methods_enabled.required_field, + surcharge: payment_methods_enabled.surcharge, + pm_subtype_specific_data: get_pm_subtype_specific_data( + bank_config, + payment_methods_enabled.payment_method_type, + payment_methods_enabled.payment_method_subtype, + &payment_methods_enabled.connectors, + ), + } + }) + .collect(); + + RequiredFieldsAndSurchargeWithExtraInfoForEnabledPaymentMethodTypes( + response_payment_methods, + ) + } +} + +/// Element Container to hold the filtered payment methods enabled with required fields, surcharge and subtype specific data +struct RequiredFieldsAndSurchargeWithExtraInfoForEnabledPaymentMethodType { + required_field: Option<Vec<api_models::payment_methods::RequiredFieldInfo>>, + payment_method_subtype: common_enums::PaymentMethodType, + payment_method_type: common_enums::PaymentMethod, + payment_experience: Option<Vec<common_enums::PaymentExperience>>, + surcharge: Option<api_models::payment_methods::SurchargeDetailsResponse>, + pm_subtype_specific_data: Option<api_models::payment_methods::PaymentMethodSubtypeSpecificData>, +} + +/// Container to hold the filtered payment methods enabled with required fields, surcharge and subtype specific data +struct RequiredFieldsAndSurchargeWithExtraInfoForEnabledPaymentMethodTypes( + Vec<RequiredFieldsAndSurchargeWithExtraInfoForEnabledPaymentMethodType>, +); + +impl RequiredFieldsAndSurchargeWithExtraInfoForEnabledPaymentMethodTypes { fn generate_response( self, customer_payment_methods: Option< @@ -148,7 +342,7 @@ impl RequiredFieldsAndSurchargeForEnabledPaymentMethodTypes { payment_experience: payment_methods_enabled.payment_experience, required_fields: payment_methods_enabled.required_field, surcharge_details: payment_methods_enabled.surcharge, - extra_information: None, + extra_information: payment_methods_enabled.pm_subtype_specific_data, } }) .collect(); @@ -160,40 +354,6 @@ impl RequiredFieldsAndSurchargeForEnabledPaymentMethodTypes { } } -impl RequiredFieldsForEnabledPaymentMethodTypes { - fn perform_surcharge_calculation( - self, - ) -> RequiredFieldsAndSurchargeForEnabledPaymentMethodTypes { - let details_with_surcharge = self - .0 - .into_iter() - .map( - |payment_methods_enabled| RequiredFieldsAndSurchargeForEnabledPaymentMethodType { - payment_method_type: payment_methods_enabled.payment_method_type, - required_field: payment_methods_enabled.required_field, - payment_method_subtype: payment_methods_enabled.payment_method_subtype, - payment_experience: payment_methods_enabled.payment_experience, - surcharge: None, - }, - ) - .collect(); - - RequiredFieldsAndSurchargeForEnabledPaymentMethodTypes(details_with_surcharge) - } -} - -trait PerformFilteringOnPaymentMethodsEnabled { - fn perform_filtering(self) -> FilteredPaymentMethodsEnabled; -} - -impl PerformFilteringOnPaymentMethodsEnabled - for hyperswitch_domain_models::merchant_connector_account::FlattenedPaymentMethodsEnabled -{ - fn perform_filtering(self) -> FilteredPaymentMethodsEnabled { - FilteredPaymentMethodsEnabled(self.payment_methods_enabled) - } -} - /// Validate if payment methods list can be performed on the current status of payment intent fn validate_payment_status_for_payment_method_list( intent_status: common_enums::IntentStatus,

2025-07-09T08:23:18Z

## Type of Change  - [ ] Bugfix - [ ] New feature - [x] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  - Merge `payment_experience` for a pm_type, subtype into an array - Return `bank_names` ### Additional Changes - [x] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  Closes #8582 ## How did you test it?  Request: ``` curl --location 'http://localhost:8080/v2/payments/12345_pay_0197ee3c52887d51b074cecb88687a33/payment-methods' \ --header 'Content-Type: application/json' \ --header 'Authorization: publishable-key=pk_dev_bef28bbe20d64d52bf4658ad5f7bc91e,client-secret=cs_0197ee3c52bd71a38bf7932a4484b345' \ --header 'X-Profile-Id: pro_eW12tyr48EHRHFF9MfLa' \ --header 'api-key: pk_dev_bef28bbe20d64d52bf4658ad5f7bc91e' ``` Response: ```json { "payment_methods_enabled": [ { "payment_method_type": "card", "payment_method_subtype": "card", "payment_experience": null, "required_fields": null, "surcharge_details": null }, { "payment_method_type": "card_redirect", "payment_method_subtype": "card_redirect", "payment_experience": [ "redirect_to_url" ], "required_fields": null, "surcharge_details": null }, { "payment_method_type": "pay_later", "payment_method_subtype": "klarna", "payment_experience": [ "redirect_to_url", "invoke_sdk_client" ], "required_fields": null, "surcharge_details": null }, { "payment_method_type": "wallet", "payment_method_subtype": "google_pay", "payment_experience": null, "required_fields": null, "surcharge_details": null }, { "payment_method_type": "wallet", "payment_method_subtype": "paypal", "payment_experience": null, "required_fields": null, "surcharge_details": null }, { "payment_method_type": "bank_redirect", "payment_method_subtype": "eps", "payment_experience": [ "redirect_to_url" ], "bank_names": [ "posojilnica_bank_e_gen", "schoellerbank_ag", "volksbank_gruppe", "hypo_tirol_bank_ag", "volkskreditbank_ag", "bawag_psk_ag", "easybank_ag", "raiffeisen_bankengruppe_osterreich", "sparda_bank_wien", "dolomitenbank", "erste_bank_und_sparkassen", "bank_austria" ], "required_fields": null, "surcharge_details": null }, { "payment_method_type": "bank_redirect", "payment_method_subtype": "ideal", "payment_experience": [ "redirect_to_url" ], "bank_names": [ "n26", "knab", "nationale_nederlanden", "ing", "rabobank", "sns_bank", "asn_bank", "bunq", "revolut", "triodos_bank", "regiobank", "abn_amro", "van_lanschot", "yoursafe" ], "required_fields": null, "surcharge_details": null }, { "payment_method_type": "bank_debit", "payment_method_subtype": "sepa", "payment_experience": null, "bank_names": [], "required_fields": null, "surcharge_details": null } ], "customer_payment_methods": [] } ``` ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

0f70fc512c90e4d5603af7b965c137465999b73c

juspay/hyperswitch

juspay__hyperswitch-8584

Bug: Add endpoints to support ai chat interactions - Add endpoints to talk to different ai services. - Add config for URLS - make feature flag for ai chat service that will help to manage feature across different environments.

diff --git a/config/config.example.toml b/config/config.example.toml index 2c35b1778cf..22ad2d6c666 100644 --- a/config/config.example.toml +++ b/config/config.example.toml @@ -1132,4 +1132,8 @@ version = "HOSTNAME" # value of HOSTNAME from deployment which tells its [platform] enabled = true # Enable or disable platform features -allow_connected_merchants = false # Enable or disable connected merchant account features \ No newline at end of file +allow_connected_merchants = false # Enable or disable connected merchant account features + +[chat] +enabled = false # Enable or disable chat features +hyperswitch_ai_host = "http://0.0.0.0:8000" # Hyperswitch ai workflow host \ No newline at end of file diff --git a/config/deployments/env_specific.toml b/config/deployments/env_specific.toml index cab8777aa97..4428b508017 100644 --- a/config/deployments/env_specific.toml +++ b/config/deployments/env_specific.toml @@ -380,4 +380,8 @@ connector_names = "connector_names" # Comma-separated list of allowed connec [grpc_client.unified_connector_service] host = "localhost" # Unified Connector Service Client Host port = 8000 # Unified Connector Service Client Port -connection_timeout = 10 # Connection Timeout Duration in Seconds \ No newline at end of file +connection_timeout = 10 # Connection Timeout Duration in Seconds + +[chat] +enabled = false # Enable or disable chat features +hyperswitch_ai_host = "http://0.0.0.0:8000" # Hyperswitch ai workflow host diff --git a/config/development.toml b/config/development.toml index 5a03b7a4b20..8c9a20362d1 100644 --- a/config/development.toml +++ b/config/development.toml @@ -1225,3 +1225,7 @@ connector_names = "stripe, adyen" # Comma-separated list of allowe [infra_values] cluster = "CLUSTER" version = "HOSTNAME" + +[chat] +enabled = false +hyperswitch_ai_host = "http://0.0.0.0:8000" \ No newline at end of file diff --git a/config/docker_compose.toml b/config/docker_compose.toml index 448fa0390f0..299644a8632 100644 --- a/config/docker_compose.toml +++ b/config/docker_compose.toml @@ -1108,6 +1108,10 @@ background_color = "#FFFFFF" enabled = true allow_connected_merchants = true +[chat] +enabled = false +hyperswitch_ai_host = "http://0.0.0.0:8000" + [authentication_providers] click_to_pay = {connector_list = "adyen, cybersource"} diff --git a/crates/api_models/src/chat.rs b/crates/api_models/src/chat.rs new file mode 100644 index 00000000000..c66b42cc4f4 --- /dev/null +++ b/crates/api_models/src/chat.rs @@ -0,0 +1,18 @@ +use common_utils::id_type; +use masking::Secret; + +#[derive(Debug, serde::Deserialize, serde::Serialize, Clone)] +pub struct ChatRequest { + pub message: Secret<String>, +} + +#[derive(Debug, serde::Deserialize, serde::Serialize)] +pub struct ChatResponse { + pub response: Secret<serde_json::Value>, + pub merchant_id: id_type::MerchantId, + pub status: String, + #[serde(skip_serializing)] + pub query_executed: Option<Secret<String>>, + #[serde(skip_serializing)] + pub row_count: Option<i32>, +} diff --git a/crates/api_models/src/events.rs b/crates/api_models/src/events.rs index 768aed75a7a..dd54cd63222 100644 --- a/crates/api_models/src/events.rs +++ b/crates/api_models/src/events.rs @@ -1,4 +1,5 @@ pub mod apple_pay_certificates_migration; +pub mod chat; pub mod connector_onboarding; pub mod customer; pub mod dispute; diff --git a/crates/api_models/src/events/chat.rs b/crates/api_models/src/events/chat.rs new file mode 100644 index 00000000000..42fefe487e9 --- /dev/null +++ b/crates/api_models/src/events/chat.rs @@ -0,0 +1,5 @@ +use common_utils::events::{ApiEventMetric, ApiEventsType}; + +use crate::chat::{ChatRequest, ChatResponse}; + +common_utils::impl_api_event_type!(Chat, (ChatRequest, ChatResponse)); diff --git a/crates/api_models/src/lib.rs b/crates/api_models/src/lib.rs index cbc50ed7ff2..3b343459e9e 100644 --- a/crates/api_models/src/lib.rs +++ b/crates/api_models/src/lib.rs @@ -5,6 +5,7 @@ pub mod apple_pay_certificates_migration; pub mod authentication; pub mod blocklist; pub mod cards_info; +pub mod chat; pub mod conditional_configs; pub mod connector_enums; pub mod connector_onboarding; diff --git a/crates/common_utils/src/consts.rs b/crates/common_utils/src/consts.rs index c8cf1e8c579..3ef0ef555e6 100644 --- a/crates/common_utils/src/consts.rs +++ b/crates/common_utils/src/consts.rs @@ -191,3 +191,6 @@ pub const METRICS_HOST_TAG_NAME: &str = "host"; /// API client request timeout (in seconds) pub const REQUEST_TIME_OUT: u64 = 30; + +/// API client request timeout for ai service (in seconds) +pub const REQUEST_TIME_OUT_FOR_AI_SERVICE: u64 = 120; diff --git a/crates/common_utils/src/events.rs b/crates/common_utils/src/events.rs index e1964296755..49be22fc931 100644 --- a/crates/common_utils/src/events.rs +++ b/crates/common_utils/src/events.rs @@ -137,6 +137,7 @@ pub enum ApiEventsType { profile_acquirer_id: id_type::ProfileAcquirerId, }, ThreeDsDecisionRule, + Chat, } impl ApiEventMetric for serde_json::Value {} diff --git a/crates/hyperswitch_domain_models/src/chat.rs b/crates/hyperswitch_domain_models/src/chat.rs new file mode 100644 index 00000000000..31b9f806db7 --- /dev/null +++ b/crates/hyperswitch_domain_models/src/chat.rs @@ -0,0 +1,15 @@ +use common_utils::id_type; +use masking::Secret; + +#[derive(Debug, serde::Deserialize, serde::Serialize, Clone)] +pub struct GetDataMessage { + pub message: Secret<String>, +} + +#[derive(Debug, serde::Deserialize, serde::Serialize, Clone)] +pub struct HyperswitchAiDataRequest { + pub merchant_id: id_type::MerchantId, + pub profile_id: id_type::ProfileId, + pub org_id: id_type::OrganizationId, + pub query: GetDataMessage, +} diff --git a/crates/hyperswitch_domain_models/src/lib.rs b/crates/hyperswitch_domain_models/src/lib.rs index 35f619334c3..b89613c5413 100644 --- a/crates/hyperswitch_domain_models/src/lib.rs +++ b/crates/hyperswitch_domain_models/src/lib.rs @@ -6,6 +6,7 @@ pub mod business_profile; pub mod callback_mapper; pub mod card_testing_guard_data; pub mod cards_info; +pub mod chat; pub mod connector_endpoints; pub mod consts; pub mod customer; diff --git a/crates/router/src/configs/secrets_transformers.rs b/crates/router/src/configs/secrets_transformers.rs index 9129a9a78f6..d4eb34838d6 100644 --- a/crates/router/src/configs/secrets_transformers.rs +++ b/crates/router/src/configs/secrets_transformers.rs @@ -452,6 +452,7 @@ pub(crate) async fn fetch_raw_secrets( Settings { server: conf.server, + chat: conf.chat, master_database, redis: conf.redis, log: conf.log, diff --git a/crates/router/src/configs/settings.rs b/crates/router/src/configs/settings.rs index 6157a4fab20..ae4c8a3cda0 100644 --- a/crates/router/src/configs/settings.rs +++ b/crates/router/src/configs/settings.rs @@ -70,6 +70,7 @@ pub struct Settings<S: SecretState> { pub server: Server, pub proxy: Proxy, pub env: Env, + pub chat: ChatSettings, pub master_database: SecretStateContainer<Database, S>, #[cfg(feature = "olap")] pub replica_database: SecretStateContainer<Database, S>, @@ -195,6 +196,13 @@ pub struct Platform { pub allow_connected_merchants: bool, } +#[derive(Debug, Deserialize, Clone, Default)] +#[serde(default)] +pub struct ChatSettings { + pub enabled: bool, + pub hyperswitch_ai_host: String, +} + #[derive(Debug, Clone, Default, Deserialize)] pub struct Multitenancy { pub tenants: TenantConfig, @@ -1016,6 +1024,7 @@ impl Settings<SecuredSecret> { self.secrets.get_inner().validate()?; self.locker.validate()?; self.connectors.validate("connectors")?; + self.chat.validate()?; self.cors.validate()?; diff --git a/crates/router/src/configs/validations.rs b/crates/router/src/configs/validations.rs index 4fc254760a0..023b9ee5bec 100644 --- a/crates/router/src/configs/validations.rs +++ b/crates/router/src/configs/validations.rs @@ -343,3 +343,15 @@ impl super::settings::OpenRouter { ) } } + +impl super::settings::ChatSettings { + pub fn validate(&self) -> Result<(), ApplicationError> { + use common_utils::fp_utils::when; + + when(self.enabled && self.hyperswitch_ai_host.is_empty(), || { + Err(ApplicationError::InvalidConfigurationValueError( + "hyperswitch ai host must be set if chat is enabled".into(), + )) + }) + } +} diff --git a/crates/router/src/core.rs b/crates/router/src/core.rs index 2334eddfd64..0fe3e57f872 100644 --- a/crates/router/src/core.rs +++ b/crates/router/src/core.rs @@ -72,4 +72,5 @@ pub mod relay; #[cfg(feature = "v2")] pub mod revenue_recovery; +pub mod chat; pub mod tokenization; diff --git a/crates/router/src/core/chat.rs b/crates/router/src/core/chat.rs new file mode 100644 index 00000000000..c30e27f0482 --- /dev/null +++ b/crates/router/src/core/chat.rs @@ -0,0 +1,57 @@ +use api_models::chat as chat_api; +use common_utils::{ + consts, + errors::CustomResult, + request::{Method, RequestBuilder, RequestContent}, +}; +use error_stack::ResultExt; +use external_services::http_client; +use hyperswitch_domain_models::chat as chat_domain; +use router_env::{instrument, logger, tracing}; + +use crate::{ + db::errors::chat::ChatErrors, + routes::SessionState, + services::{authentication as auth, ApplicationResponse}, +}; + +#[instrument(skip_all)] +pub async fn get_data_from_hyperswitch_ai_workflow( + state: SessionState, + user_from_token: auth::UserFromToken, + req: chat_api::ChatRequest, +) -> CustomResult<ApplicationResponse<chat_api::ChatResponse>, ChatErrors> { + let url = format!("{}/webhook", state.conf.chat.hyperswitch_ai_host); + + let request_body = chat_domain::HyperswitchAiDataRequest { + query: chat_domain::GetDataMessage { + message: req.message, + }, + org_id: user_from_token.org_id, + merchant_id: user_from_token.merchant_id, + profile_id: user_from_token.profile_id, + }; + logger::info!("Request for AI service: {:?}", request_body); + + let request = RequestBuilder::new() + .method(Method::Post) + .url(&url) + .attach_default_headers() + .set_body(RequestContent::Json(Box::new(request_body.clone()))) + .build(); + + let response = http_client::send_request( + &state.conf.proxy, + request, + Some(consts::REQUEST_TIME_OUT_FOR_AI_SERVICE), + ) + .await + .change_context(ChatErrors::InternalServerError) + .attach_printable("Error when sending request to AI service")? + .json::<_>() + .await + .change_context(ChatErrors::InternalServerError) + .attach_printable("Error when deserializing response from AI service")?; + + Ok(ApplicationResponse::Json(response)) +} diff --git a/crates/router/src/core/errors.rs b/crates/router/src/core/errors.rs index 93d4414a5b4..c8e7cb4e6f4 100644 --- a/crates/router/src/core/errors.rs +++ b/crates/router/src/core/errors.rs @@ -1,3 +1,4 @@ +pub mod chat; pub mod customers_error_response; pub mod error_handlers; pub mod transformers; diff --git a/crates/router/src/core/errors/chat.rs b/crates/router/src/core/errors/chat.rs new file mode 100644 index 00000000000..a96afa67de8 --- /dev/null +++ b/crates/router/src/core/errors/chat.rs @@ -0,0 +1,37 @@ +#[derive(Debug, thiserror::Error)] +pub enum ChatErrors { + #[error("User InternalServerError")] + InternalServerError, + #[error("Missing Config error")] + MissingConfigError, + #[error("Chat response deserialization failed")] + ChatResponseDeserializationFailed, +} + +impl common_utils::errors::ErrorSwitch<api_models::errors::types::ApiErrorResponse> for ChatErrors { + fn switch(&self) -> api_models::errors::types::ApiErrorResponse { + use api_models::errors::types::{ApiError, ApiErrorResponse as AER}; + let sub_code = "AI"; + match self { + Self::InternalServerError => { + AER::InternalServerError(ApiError::new("HE", 0, self.get_error_message(), None)) + } + Self::MissingConfigError => { + AER::InternalServerError(ApiError::new(sub_code, 1, self.get_error_message(), None)) + } + Self::ChatResponseDeserializationFailed => { + AER::BadRequest(ApiError::new(sub_code, 2, self.get_error_message(), None)) + } + } + } +} + +impl ChatErrors { + pub fn get_error_message(&self) -> String { + match self { + Self::InternalServerError => "Something went wrong".to_string(), + Self::MissingConfigError => "Missing webhook url".to_string(), + Self::ChatResponseDeserializationFailed => "Failed to parse chat response".to_string(), + } + } +} diff --git a/crates/router/src/lib.rs b/crates/router/src/lib.rs index 6bcb17ad1a5..e002f7fd050 100644 --- a/crates/router/src/lib.rs +++ b/crates/router/src/lib.rs @@ -189,7 +189,8 @@ pub fn mk_app( .service(routes::MerchantAccount::server(state.clone())) .service(routes::User::server(state.clone())) .service(routes::ApiKeys::server(state.clone())) - .service(routes::Routing::server(state.clone())); + .service(routes::Routing::server(state.clone())) + .service(routes::Chat::server(state.clone())); #[cfg(feature = "v1")] { diff --git a/crates/router/src/routes.rs b/crates/router/src/routes.rs index f639ee06ab0..fcf7270fa8a 100644 --- a/crates/router/src/routes.rs +++ b/crates/router/src/routes.rs @@ -75,6 +75,8 @@ pub mod process_tracker; #[cfg(feature = "v2")] pub mod proxy; +pub mod chat; + #[cfg(feature = "dummy_connector")] pub use self::app::DummyConnector; #[cfg(feature = "v2")] @@ -86,7 +88,7 @@ pub use self::app::Recon; #[cfg(feature = "v2")] pub use self::app::Tokenization; pub use self::app::{ - ApiKeys, AppState, ApplePayCertificatesMigration, Authentication, Cache, Cards, Configs, + ApiKeys, AppState, ApplePayCertificatesMigration, Authentication, Cache, Cards, Chat, Configs, ConnectorOnboarding, Customers, Disputes, EphemeralKey, FeatureMatrix, Files, Forex, Gsm, Health, Hypersense, Mandates, MerchantAccount, MerchantConnectorAccount, PaymentLink, PaymentMethods, Payments, Poll, ProcessTracker, Profile, ProfileAcquirer, ProfileNew, Refunds, diff --git a/crates/router/src/routes/app.rs b/crates/router/src/routes/app.rs index 9935ab5fd9f..3cbf532b951 100644 --- a/crates/router/src/routes/app.rs +++ b/crates/router/src/routes/app.rs @@ -59,8 +59,8 @@ use super::verification::{apple_pay_merchant_registration, retrieve_apple_pay_ve #[cfg(feature = "oltp")] use super::webhooks::*; use super::{ - admin, api_keys, cache::*, connector_onboarding, disputes, files, gsm, health::*, profiles, - relay, user, user_role, + admin, api_keys, cache::*, chat, connector_onboarding, disputes, files, gsm, health::*, + profiles, relay, user, user_role, }; #[cfg(feature = "v1")] use super::{apple_pay_certificates_migration, blocklist, payment_link, webhook_events}; @@ -2215,6 +2215,23 @@ impl Gsm { } } +pub struct Chat; + +#[cfg(feature = "olap")] +impl Chat { + pub fn server(state: AppState) -> Scope { + let mut route = web::scope("/chat").app_data(web::Data::new(state.clone())); + if state.conf.chat.enabled { + route = route.service( + web::scope("/ai").service( + web::resource("/data") + .route(web::post().to(chat::get_data_from_hyperswitch_ai_workflow)), + ), + ); + } + route + } +} pub struct ThreeDsDecisionRule; #[cfg(feature = "oltp")] diff --git a/crates/router/src/routes/chat.rs b/crates/router/src/routes/chat.rs new file mode 100644 index 00000000000..555bf007d23 --- /dev/null +++ b/crates/router/src/routes/chat.rs @@ -0,0 +1,38 @@ +use actix_web::{web, HttpRequest, HttpResponse}; +#[cfg(feature = "olap")] +use api_models::chat as chat_api; +use router_env::{instrument, tracing, Flow}; + +use super::AppState; +use crate::{ + core::{api_locking, chat as chat_core}, + services::{ + api, + authentication::{self as auth}, + authorization::permissions::Permission, + }, +}; + +#[instrument(skip_all)] +pub async fn get_data_from_hyperswitch_ai_workflow( + state: web::Data<AppState>, + http_req: HttpRequest, + payload: web::Json<chat_api::ChatRequest>, +) -> HttpResponse { + let flow = Flow::GetDataFromHyperswitchAiFlow; + Box::pin(api::server_wrap( + flow.clone(), + state, + &http_req, + payload.into_inner(), + |state, user: auth::UserFromToken, payload, _| { + chat_core::get_data_from_hyperswitch_ai_workflow(state, user, payload) + }, + // At present, the AI service retrieves data scoped to the merchant level + &auth::JWTAuth { + permission: Permission::MerchantPaymentRead, + }, + api_locking::LockAction::NotApplicable, + )) + .await +} diff --git a/crates/router/src/routes/lock_utils.rs b/crates/router/src/routes/lock_utils.rs index fa616a3da3e..365d54fc84a 100644 --- a/crates/router/src/routes/lock_utils.rs +++ b/crates/router/src/routes/lock_utils.rs @@ -35,6 +35,7 @@ pub enum ApiIdentifier { UserRole, ConnectorOnboarding, Recon, + AiWorkflow, Poll, ApplePayCertificatesMigration, Relay, @@ -300,6 +301,8 @@ impl From<Flow> for ApiIdentifier { | Flow::DeleteTheme | Flow::CloneConnector => Self::User, + Flow::GetDataFromHyperswitchAiFlow => Self::AiWorkflow, + Flow::ListRolesV2 | Flow::ListInvitableRolesAtEntityLevel | Flow::ListUpdatableRolesAtEntityLevel diff --git a/crates/router_env/src/logger/types.rs b/crates/router_env/src/logger/types.rs index d395cd1f6da..0eafefd112f 100644 --- a/crates/router_env/src/logger/types.rs +++ b/crates/router_env/src/logger/types.rs @@ -349,6 +349,8 @@ pub enum Flow { ApplePayCertificatesMigration, /// Gsm Rule Delete flow GsmRuleDelete, + /// Get data from embedded flow + GetDataFromHyperswitchAiFlow, /// User Sign Up UserSignUp, /// User Sign Up diff --git a/loadtest/config/development.toml b/loadtest/config/development.toml index 8b19ee9c1fa..7e0a123f8d7 100644 --- a/loadtest/config/development.toml +++ b/loadtest/config/development.toml @@ -723,3 +723,7 @@ redsys = { payment_method = "card" } billing_connectors_which_require_payment_sync = "stripebilling, recurly" [billing_connectors_invoice_sync] billing_connectors_which_requires_invoice_sync_call = "recurly" + +[chat] +enabled = false +hyperswitch_ai_host = "http://0.0.0.0:8000" \ No newline at end of file

2025-07-09T09:19:51Z

## Type of Change  - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description The PR does the following actions - Adds endpoints to talk to ai services, particularly to n8n flow and embedded flow - Introduces a feature flag to manage chat features across different envs ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context Closes #8584 ## How did you test it? curl to test this ``` curl --location 'http://localhost:8080/chat/ai/data' \ --header 'x-feature: integ-custom' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer JWT' \ --data '{ "message": "get count of failed payments" }' ``` <img width="1340" height="674" alt="image" src="https://github.com/user-attachments/assets/bd7722d8-a6c0-4494-ab44-d2fb821e5146" /> ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

064113a4c96c77d83e1e0230a56678863dd8f7db

juspay/hyperswitch

juspay__hyperswitch-8581

Bug: chore(stripe:EPS): enable bank_name as required field for eps stripe. bank_name should be mandatory for stripe/EPS for sdk changes

diff --git a/api-reference/v1/openapi_spec_v1.json b/api-reference/v1/openapi_spec_v1.json index d748f65261a..5656a7f8874 100644 --- a/api-reference/v1/openapi_spec_v1.json +++ b/api-reference/v1/openapi_spec_v1.json @@ -14281,6 +14281,28 @@ "user_bank" ] }, + { + "type": "object", + "required": [ + "user_bank_options" + ], + "properties": { + "user_bank_options": { + "type": "object", + "required": [ + "options" + ], + "properties": { + "options": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, { "type": "string", "enum": [ diff --git a/api-reference/v2/openapi_spec_v2.json b/api-reference/v2/openapi_spec_v2.json index 53bbace7dfb..ecd899a3728 100644 --- a/api-reference/v2/openapi_spec_v2.json +++ b/api-reference/v2/openapi_spec_v2.json @@ -11096,6 +11096,28 @@ "user_bank" ] }, + { + "type": "object", + "required": [ + "user_bank_options" + ], + "properties": { + "user_bank_options": { + "type": "object", + "required": [ + "options" + ], + "properties": { + "options": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, { "type": "string", "enum": [ diff --git a/crates/api_models/src/enums.rs b/crates/api_models/src/enums.rs index df1827053a2..cad510b26de 100644 --- a/crates/api_models/src/enums.rs +++ b/crates/api_models/src/enums.rs @@ -257,6 +257,7 @@ pub enum FieldType { UserSocialSecurityNumber, UserBlikCode, UserBank, + UserBankOptions { options: Vec<String> }, UserBankAccountNumber, UserSourceBankAccountId, UserDestinationBankAccountId, diff --git a/crates/payment_methods/src/configs/payment_connector_required_fields.rs b/crates/payment_methods/src/configs/payment_connector_required_fields.rs index ec3ea46ccd2..2dd291d16f5 100644 --- a/crates/payment_methods/src/configs/payment_connector_required_fields.rs +++ b/crates/payment_methods/src/configs/payment_connector_required_fields.rs @@ -173,6 +173,7 @@ enum RequiredField { BanContactCardExpYear, IdealBankName, EpsBankName, + EpsBankOptions(HashSet<enums::BankNames>), BlikCode, MifinityDateOfBirth, MifinityLanguagePreference(Vec<&'static str>), @@ -610,6 +611,17 @@ impl RequiredField { value: None, }, ), + Self::EpsBankOptions(bank) => ( + "payment_method_data.bank_redirect.eps.bank_name".to_string(), + RequiredFieldInfo { + required_field: "payment_method_data.bank_redirect.eps.bank_name".to_string(), + display_name: "bank_name".to_string(), + field_type: FieldType::UserBankOptions { + options: bank.iter().map(|bank| bank.to_string()).collect(), + }, + value: None, + }, + ), Self::BlikCode => ( "payment_method_data.bank_redirect.blik.blik_code".to_string(), RequiredFieldInfo { @@ -2015,6 +2027,71 @@ fn get_bank_redirect_required_fields() -> HashMap<enums::PaymentMethodType, Conn "billing_name", FieldType::UserFullName, ), + RequiredField::EpsBankOptions( + vec![ + enums::BankNames::AbnAmro, + enums::BankNames::ArzteUndApothekerBank, + enums::BankNames::AsnBank, + enums::BankNames::AustrianAnadiBankAg, + enums::BankNames::BankAustria, + enums::BankNames::BankhausCarlSpangler, + enums::BankNames::BankhausSchelhammerUndSchatteraAg, + enums::BankNames::BawagPskAg, + enums::BankNames::BksBankAg, + enums::BankNames::BrullKallmusBankAg, + enums::BankNames::BtvVierLanderBank, + enums::BankNames::Bunq, + enums::BankNames::CapitalBankGraweGruppeAg, + enums::BankNames::Citi, + enums::BankNames::Dolomitenbank, + enums::BankNames::EasybankAg, + enums::BankNames::ErsteBankUndSparkassen, + enums::BankNames::Handelsbanken, + enums::BankNames::HypoAlpeadriabankInternationalAg, + enums::BankNames::HypoNoeLbFurNiederosterreichUWien, + enums::BankNames::HypoOberosterreichSalzburgSteiermark, + enums::BankNames::HypoTirolBankAg, + enums::BankNames::HypoVorarlbergBankAg, + enums::BankNames::HypoBankBurgenlandAktiengesellschaft, + enums::BankNames::Ing, + enums::BankNames::Knab, + enums::BankNames::MarchfelderBank, + enums::BankNames::OberbankAg, + enums::BankNames::RaiffeisenBankengruppeOsterreich, + enums::BankNames::Rabobank, + enums::BankNames::Regiobank, + enums::BankNames::Revolut, + enums::BankNames::SnsBank, + enums::BankNames::TriodosBank, + enums::BankNames::VanLanschot, + enums::BankNames::Moneyou, + enums::BankNames::SchoellerbankAg, + enums::BankNames::SpardaBankWien, + enums::BankNames::VolksbankGruppe, + enums::BankNames::VolkskreditbankAg, + enums::BankNames::VrBankBraunau, + enums::BankNames::PlusBank, + enums::BankNames::EtransferPocztowy24, + enums::BankNames::BankiSpbdzielcze, + enums::BankNames::BankNowyBfgSa, + enums::BankNames::GetinBank, + enums::BankNames::Blik, + enums::BankNames::NoblePay, + enums::BankNames::IdeaBank, + enums::BankNames::EnveloBank, + enums::BankNames::NestPrzelew, + enums::BankNames::MbankMtransfer, + enums::BankNames::Inteligo, + enums::BankNames::PbacZIpko, + enums::BankNames::BnpParibas, + enums::BankNames::BankPekaoSa, + enums::BankNames::VolkswagenBank, + enums::BankNames::AliorBank, + enums::BankNames::Boz, + ] + .into_iter() + .collect(), + ), RequiredField::BillingLastName("billing_name", FieldType::UserFullName), ], vec![],

2025-07-08T11:26:24Z

## Type of Change  - [x] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  Make bank_name field for EPS in stripe mandatore ### Additional Changes - [x] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  ## How did you test it?  <details> <summary>Payment Request</summary> ```json { "payment_id": "pay_6W7NAlavGWBsNle4fjCm", "merchant_id": "merchant_1751973151", "status": "requires_payment_method", "amount": 6500, "net_amount": 6500, "amount_capturable": 0, "client_secret": "pay_6W7NAlavGWBsNle4fjCm_secret_cGp7blq0k5NBezW6gCmH", "created": "2025-07-08T11:49:13.894Z", "currency": "EUR", "customer_id": "hyperswitch_sdk_demo_id", "customer": { "id": "hyperswitch_sdk_demo_id", "email": "[email protected]" }, "description": "Hello this is description", "setup_future_usage": "on_session", "capture_method": "automatic", "shipping": { "address": { "city": "Banglore", "country": "AT", "line1": "sdsdfsdf", "line2": "hsgdbhd", "line3": "alsksoe", "zip": "571201", "state": "California", "first_name": "John", "last_name": "Doe" }, "phone": { "number": "123456789", "country_code": "+1" } }, "billing": { "address": { "city": "San Fransico", "country": "AT", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "joseph", "last_name": "Doe" }, "phone": { "number": "8056594427", "country_code": "+91" } }, "order_details": [ { "amount": 6500, "quantity": 1, "product_name": "Apple iphone 15" } ], "email": "[email protected]", "business_label": "default", "ephemeral_key": { "customer_id": "hyperswitch_sdk_demo_id", "created_at": 1751975353, "expires": 1751978953, "secret": "epk_78740ac9b3a7426e9ed57c14c801fb4f" }, "metadata": { "udf1": "value1", "login_date": "2019-09-10T10:11:12Z", "new_customer": "true" }, "connector_metadata": { "noon": { "order_category": "applepay" } }, "profile_id": "pro_2UxGWjdVxvRMEw6zBI2V", "attempt_count": 1, "external_3ds_authentication_attempted": false, "expires_on": "2025-07-08T12:04:13.894Z", "updated": "2025-07-08T11:49:13.908Z", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false } ``` </details> <details> <summary> Supported payment methods has bank_name mandatory </summary> ```json { "redirect_url": "https://google.com/success", "currency": "EUR", "payment_methods": [ { "payment_method": "bank_redirect", "payment_method_types": [ { "payment_method_type": "eps", "bank_names": [ { "bank_name": [ "easybank_ag", "bank_austria", "hypo_tirol_bank_ag", "hypo_alpeadriabank_international_ag", "sparda_bank_wien", "bankhaus_schelhammer_und_schattera_ag", "erste_bank_und_sparkassen", "vr_bank_braunau", "raiffeisen_bankengruppe_osterreich", "volksbank_gruppe", "bankhaus_carl_spangler", "bawag_psk_ag", "hypo_noe_lb_fur_niederosterreich_u_wien", "hypo_bank_burgenland_aktiengesellschaft", "hypo_vorarlberg_bank_ag", "dolomitenbank", "marchfelder_bank", "oberbank_ag", "bks_bank_ag", "arzte_und_apotheker_bank", "btv_vier_lander_bank", "hypo_oberosterreich_salzburg_steiermark", "volkskreditbank_ag", "austrian_anadi_bank_ag", "brull_kallmus_bank_ag", "capital_bank_grawe_gruppe_ag", "schoellerbank_ag" ], "eligible_connectors": ["stripe"] } ], "required_fields": { "billing.address.first_name": { "required_field": "payment_method_data.billing.address.first_name", "display_name": "billing_name", "field_type": "user_full_name", "value": "joseph" }, "payment_method_data.bank_redirect.eps.bank_name": { "required_field": "payment_method_data.bank_redirect.eps.bank_name", "display_name": "bank_name", "field_type": { "user_bank_options": { "options": [ "triodos_bank", "austrian_anadi_bank_ag", "boz", "brull_kallmus_bank_ag", "pbac_z_ipko", "schoellerbank_ag", "hypo_oberosterreich_salzburg_steiermark", "bank_pekao_sa", "bnp_paribas", "asn_bank", "hypo_alpeadriabank_international_ag", "plus_bank", "volkswagen_bank", "sparda_bank_wien", "sns_bank", "hypo_tirol_bank_ag", "knab", "citi", "bunq", "bks_bank_ag", "mbank_mtransfer", "dolomitenbank", "idea_bank", "rabobank", "getin_bank", "raiffeisen_bankengruppe_osterreich", "bankhaus_carl_spangler", "van_lanschot", "envelo_bank", "volkskreditbank_ag", "banki_spbdzielcze", "etransfer_pocztowy24", "btv_vier_lander_bank", "easybank_ag", "bawag_psk_ag", "noble_pay", "capital_bank_grawe_gruppe_ag", "moneyou", "blik", "regiobank", "arzte_und_apotheker_bank", "abn_amro", "marchfelder_bank", "handelsbanken", "erste_bank_und_sparkassen", "volksbank_gruppe", "ing", "bankhaus_schelhammer_und_schattera_ag", "revolut", "bank_austria", "hypo_vorarlberg_bank_ag", "hypo_bank_burgenland_aktiengesellschaft", "vr_bank_braunau", "bank_nowy_bfg_sa", "nest_przelew", "alior_bank", "hypo_noe_lb_fur_niederosterreich_u_wien", "inteligo", "oberbank_ag" ] } } }, "billing.address.last_name": { "required_field": "payment_method_data.billing.address.last_name", "display_name": "billing_name", "field_type": "user_full_name", "value": "Doe" } } } ] } ], "merchant_name": "NewAge Retailer", "show_surcharge_breakup_screen": false, "payment_type": "normal", "request_external_three_ds_authentication": false, "collect_shipping_details_from_wallets": false, "collect_billing_details_from_wallets": false, "is_tax_calculation_enabled": false } ``` </details> <img width="1728" alt="Screenshot 2025-07-09 at 4 49 05 PM" src="https://github.com/user-attachments/assets/8a6cef3f-df11-411e-89d1-41ad5d1618ac" /> ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

99885b699d7524e87697f78608e6f2b36c9d8a8e

juspay/hyperswitch

juspay__hyperswitch-8566

Bug: [REFACTOR] raw_connector_response as secret refactor raw_connector_response as secret

diff --git a/crates/api_models/src/payments.rs b/crates/api_models/src/payments.rs index 13cd8fa472f..f3d7d9b675c 100644 --- a/crates/api_models/src/payments.rs +++ b/crates/api_models/src/payments.rs @@ -5186,7 +5186,8 @@ pub struct PaymentsResponse { pub is_iframe_redirection_enabled: Option<bool>, /// Contains whole connector response - pub whole_connector_response: Option<String>, + #[schema(value_type = Option<String>)] + pub whole_connector_response: Option<Secret<String>>, } #[cfg(feature = "v2")] @@ -5805,7 +5806,8 @@ pub struct PaymentsResponse { pub merchant_reference_id: Option<id_type::PaymentReferenceId>, /// Stringified connector raw response body. Only returned if `return_raw_connector_response` is true - pub raw_connector_response: Option<String>, + #[schema(value_type = Option<String>)] + pub raw_connector_response: Option<Secret<String>>, } #[cfg(feature = "v2")] diff --git a/crates/common_types/src/domain.rs b/crates/common_types/src/domain.rs index 6b5d1cf835d..e800cb9cb61 100644 --- a/crates/common_types/src/domain.rs +++ b/crates/common_types/src/domain.rs @@ -5,6 +5,8 @@ use std::collections::HashMap; use common_enums::enums; use common_utils::{impl_to_sql_from_sql_json, types::MinorUnit}; use diesel::{sql_types::Jsonb, AsExpression, FromSqlRow}; +#[cfg(feature = "v2")] +use masking::Secret; use serde::{Deserialize, Serialize}; use utoipa::ToSchema; @@ -104,10 +106,10 @@ pub struct MerchantConnectorAuthDetails { pub merchant_connector_creds: common_utils::pii::SecretSerdeValue, } -/// Connector Response Data that are required to be populated in response +/// Connector Response Data that are required to be populated in response, but not persisted in DB. #[cfg(feature = "v2")] #[derive(Clone, Debug)] pub struct ConnectorResponseData { /// Stringified connector raw response body - pub raw_connector_response: Option<String>, + pub raw_connector_response: Option<Secret<String>>, } diff --git a/crates/hyperswitch_connectors/src/connectors/razorpay.rs b/crates/hyperswitch_connectors/src/connectors/razorpay.rs index 33cdc326987..cdb636aab58 100644 --- a/crates/hyperswitch_connectors/src/connectors/razorpay.rs +++ b/crates/hyperswitch_connectors/src/connectors/razorpay.rs @@ -10,6 +10,7 @@ use common_utils::{ }; use error_stack::{report, Report, ResultExt}; use hyperswitch_domain_models::{ + payment_method_data::PaymentMethodData, router_data::{AccessToken, ConnectorAuthType, ErrorResponse, RouterData}, router_flow_types::{ access_token_auth::AccessTokenAuth, @@ -315,10 +316,16 @@ impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData _req: &PaymentsAuthorizeRouterData, connectors: &Connectors, ) -> CustomResult<String, errors::ConnectorError> { - Ok(format!( - "{}v1/payments/create/upi", - self.base_url(connectors) - )) + match _req.request.payment_method_data { + PaymentMethodData::Upi(_) => Ok(format!( + "{}v1/payments/create/upi", + self.base_url(connectors) + )), + _ => Err(errors::ConnectorError::NotImplemented( + "Payment method not implemented for Razorpay".to_string(), + ) + .into()), + } } fn get_request_body( diff --git a/crates/hyperswitch_domain_models/src/router_data.rs b/crates/hyperswitch_domain_models/src/router_data.rs index a18f9e5dc6e..259f280d49b 100644 --- a/crates/hyperswitch_domain_models/src/router_data.rs +++ b/crates/hyperswitch_domain_models/src/router_data.rs @@ -104,7 +104,7 @@ pub struct RouterData<Flow, Request, Response> { pub psd2_sca_exemption_type: Option<common_enums::ScaExemptionType>, /// Contains stringified connector raw response body - pub raw_connector_response: Option<String>, + pub raw_connector_response: Option<Secret<String>>, /// Indicates whether the payment ID was provided by the merchant (true), /// or generated internally by Hyperswitch (false) @@ -1260,7 +1260,6 @@ impl resource_id, redirection_data, connector_metadata, - connector_response_reference_id, .. } => { let attempt_status = self.get_attempt_status_for_db_update(payment_data); @@ -1289,9 +1288,7 @@ impl token_details.get_connector_token_request_reference_id() }), ), - - connector_response_reference_id: connector_response_reference_id - .clone(), + connector_response_reference_id: None, }, )) } diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs index 5319e823614..cf45d15a5a1 100644 --- a/crates/router/src/core/payments.rs +++ b/crates/router/src/core/payments.rs @@ -6549,7 +6549,7 @@ where Option<hyperswitch_domain_models::card_testing_guard_data::CardTestingGuardData>, pub vault_operation: Option<domain_payments::VaultOperation>, pub threeds_method_comp_ind: Option<api_models::payments::ThreeDsCompletionIndicator>, - pub whole_connector_response: Option<String>, + pub whole_connector_response: Option<Secret<String>>, } #[derive(Clone, serde::Serialize, Debug)] @@ -9446,7 +9446,7 @@ pub trait OperationSessionGetters<F> { fn get_connector_customer_id(&self) -> Option<String>; #[cfg(feature = "v1")] - fn get_whole_connector_response(&self) -> Option<String>; + fn get_whole_connector_response(&self) -> Option<Secret<String>>; #[cfg(feature = "v1")] fn get_vault_operation(&self) -> Option<&domain_payments::VaultOperation>; @@ -9673,7 +9673,7 @@ impl<F: Clone> OperationSessionGetters<F> for PaymentData<F> { self.all_keys_required } - fn get_whole_connector_response(&self) -> Option<String> { + fn get_whole_connector_response(&self) -> Option<Secret<String>> { self.whole_connector_response.clone() } diff --git a/crates/router/src/core/payments/flows/authorize_flow.rs b/crates/router/src/core/payments/flows/authorize_flow.rs index f42efa0c1e4..21215ea7235 100644 --- a/crates/router/src/core/payments/flows/authorize_flow.rs +++ b/crates/router/src/core/payments/flows/authorize_flow.rs @@ -5,7 +5,7 @@ use error_stack::ResultExt; use hyperswitch_domain_models::errors::api_error_response::ApiErrorResponse; #[cfg(feature = "v2")] use hyperswitch_domain_models::payments::PaymentConfirmData; -use masking::ExposeInterface; +use masking::{ExposeInterface, Secret}; use unified_connector_service_client::payments as payments_grpc; // use router_env::tracing::Instrument; @@ -555,7 +555,9 @@ impl Feature<api::Authorize, types::PaymentsAuthorizeData> for types::PaymentsAu self.status = status; self.response = router_data_response; - self.raw_connector_response = payment_authorize_response.raw_connector_response; + self.raw_connector_response = payment_authorize_response + .raw_connector_response + .map(Secret::new); Ok(()) } diff --git a/crates/router/src/core/payments/flows/psync_flow.rs b/crates/router/src/core/payments/flows/psync_flow.rs index e27c9974406..84752f16520 100644 --- a/crates/router/src/core/payments/flows/psync_flow.rs +++ b/crates/router/src/core/payments/flows/psync_flow.rs @@ -2,6 +2,7 @@ use std::collections::HashMap; use async_trait::async_trait; use error_stack::ResultExt; +use masking::Secret; use unified_connector_service_client::payments as payments_grpc; use super::{ConstructFlowSpecificData, Feature}; @@ -256,7 +257,7 @@ impl Feature<api::PSync, types::PaymentsSyncData> self.status = status; self.response = router_data_response; - self.raw_connector_response = payment_get_response.raw_connector_response; + self.raw_connector_response = payment_get_response.raw_connector_response.map(Secret::new); Ok(()) } diff --git a/crates/router/src/core/payments/operations/payment_confirm_intent.rs b/crates/router/src/core/payments/operations/payment_confirm_intent.rs index 5de3b754083..143d6f7d342 100644 --- a/crates/router/src/core/payments/operations/payment_confirm_intent.rs +++ b/crates/router/src/core/payments/operations/payment_confirm_intent.rs @@ -597,6 +597,7 @@ impl<F: Clone + Sync> UpdateTracker<F, PaymentConfirmData<F>, PaymentsConfirmInt .connector_request_reference_id .clone(); + // Updates payment_attempt for cases where authorize flow is not performed. let connector_response_reference_id = payment_data .payment_attempt .connector_response_reference_id diff --git a/crates/router/src/services/api.rs b/crates/router/src/services/api.rs index fabfe3e38d2..9b6c091a577 100644 --- a/crates/router/src/services/api.rs +++ b/crates/router/src/services/api.rs @@ -45,7 +45,7 @@ pub use hyperswitch_interfaces::{ BoxedConnectorIntegrationV2, ConnectorIntegrationAnyV2, ConnectorIntegrationV2, }, }; -use masking::{Maskable, PeekInterface}; +use masking::{Maskable, PeekInterface, Secret}; use router_env::{instrument, tracing, tracing_actix_web::RequestId, Tag}; use serde::Serialize; use serde_json::json; @@ -310,7 +310,8 @@ where .trim_start_matches('\u{feff}') .to_string(); } - data.raw_connector_response = Some(decoded); + data.raw_connector_response = + Some(Secret::new(decoded)); } Ok(data) }

2025-07-07T08:27:00Z

## Type of Change  - [ ] Bugfix - [ ] New feature - [ ] Enhancement - [x] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  This PR makes raw_connector_response as a Secret and it also addresses unresolved comments of https://github.com/juspay/hyperswitch/pull/8499 ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  ## How did you test it?  Payments - Create ``` curl --location 'http://localhost:8080/v2/payments' \ --header 'Content-Type: application/json' \ --header 'x-profile-id: pro_2Epn3j4dw4PTTcAeiYCq' \ --header 'Authorization: api-key=dev_rVjIA9bnmFxbtjq0nZeACzzLz9mqAMLNNRBG26wWmCMnkUb3kAs2MaPXR0Nlxzkx' \ --data-raw '{ "amount_details": { "currency": "USD", "order_amount": 6540 }, "payment_method_data": { "card": { "card_cvc": "123", "card_exp_month": "10", "card_exp_year": "25", "card_holder_name": "joseph Doe", "card_number": "4242424242424242" }, "billing": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "IN", "first_name": "Swangi", "last_name": "Kumari" }, "phone": { "number": "8056594427", "country_code": "+91" }, "email": "[email protected]" } }, "payment_method_subtype": "credit", "payment_method_type": "card", "return_raw_connector_response": true }' ``` Response ``` { "id": "12345_pay_0197ede6d02c77d1a499530bf675e725", "status": "succeeded", "amount": { "order_amount": 6540, "currency": "USD", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null, "net_amount": 6540, "amount_to_capture": null, "amount_capturable": 0, "amount_captured": 6540 }, "customer_id": null, "connector": "stripe", "created": "2025-07-09T06:36:56.236Z", "payment_method_data": { "billing": { "address": { "city": "San Fransico", "country": "IN", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "Swangi", "last_name": "Kumari" }, "phone": { "number": "8056594427", "country_code": "+91" }, "email": "[email protected]" } }, "payment_method_type": "card", "payment_method_subtype": "credit", "connector_transaction_id": "pi_3RirciD5R7gDAGff0JSMZ9vN", "connector_reference_id": "pi_3RirciD5R7gDAGff0JSMZ9vN", "merchant_connector_id": "mca_afJBIsuaoPHhNuVG2CCo", "browser_info": null, "error": null, "shipping": null, "billing": null, "attempts": null, "connector_token_details": { "token": "pm_1RirciD5R7gDAGff9P1tYKQk", "connector_token_request_reference_id": "cRhwNEwZyiEAeSeCCv" }, "payment_method_id": null, "next_action": null, "return_url": "https://google.com/success", "authentication_type": null, "authentication_type_applied": "no_three_ds", "is_iframe_redirection_enabled": null, "merchant_reference_id": null, "raw_connector_response": "{\n \"id\": \"pi_3RirciD5R7gDAGff0JSMZ9vN\",\n \"object\": \"payment_intent\",\n \"amount\": 6540,\n \"amount_capturable\": 0,\n \"amount_details\": {\n \"tip\": {}\n },\n \"amount_received\": 6540,\n \"application\": null,\n \"application_fee_amount\": null,\n \"automatic_payment_methods\": null,\n \"canceled_at\": null,\n \"cancellation_reason\": null,\n \"capture_method\": \"automatic\",\n \"client_secret\": \"pi_3RirciD5R7gDAGff0JSMZ9vN_secret_UW4tYLvjQrDi7NHt8Scv7Bade\",\n \"confirmation_method\": \"automatic\",\n \"created\": 1752043016,\n \"currency\": \"usd\",\n \"customer\": null,\n \"description\": null,\n \"invoice\": null,\n \"last_payment_error\": null,\n \"latest_charge\": {\n \"id\": \"ch_3RirciD5R7gDAGff0T483Brp\",\n \"object\": \"charge\",\n \"amount\": 6540,\n \"amount_captured\": 6540,\n \"amount_refunded\": 0,\n \"amount_updates\": [],\n \"application\": null,\n \"application_fee\": null,\n \"application_fee_amount\": null,\n \"balance_transaction\": \"txn_3RirciD5R7gDAGff0YvvPlkn\",\n \"billing_details\": {\n \"address\": {\n \"city\": \"San Fransico\",\n \"country\": \"IN\",\n \"line1\": \"1467\",\n \"line2\": \"Harrison Street\",\n \"postal_code\": \"94122\",\n \"state\": \"California\"\n },\n \"email\": \"[email protected]\",\n \"name\": \"Swangi Kumari\",\n \"phone\": \"8056594427\",\n \"tax_id\": null\n },\n \"calculated_statement_descriptor\": \"D2CSTORE0\",\n \"captured\": true,\n \"created\": 1752043017,\n \"currency\": \"usd\",\n \"customer\": null,\n \"description\": null,\n \"destination\": null,\n \"dispute\": null,\n \"disputed\": false,\n \"failure_balance_transaction\": null,\n \"failure_code\": null,\n \"failure_message\": null,\n \"fraud_details\": {},\n \"invoice\": null,\n \"livemode\": false,\n \"metadata\": {\n \"order_id\": \"12345_att_0197ede6d0497bc3b00553f0bd9bf01c\"\n },\n \"on_behalf_of\": null,\n \"order\": null,\n \"outcome\": {\n \"advice_code\": null,\n \"network_advice_code\": null,\n \"network_decline_code\": null,\n \"network_status\": \"approved_by_network\",\n \"reason\": null,\n \"risk_level\": \"normal\",\n \"risk_score\": 4,\n \"rule\": \"allow_if_in_allowlist\",\n \"seller_message\": \"Payment complete.\",\n \"type\": \"authorized\"\n },\n \"paid\": true,\n \"payment_intent\": \"pi_3RirciD5R7gDAGff0JSMZ9vN\",\n \"payment_method\": \"pm_1RirciD5R7gDAGff9P1tYKQk\",\n \"payment_method_details\": {\n \"card\": {\n \"amount_authorized\": 6540,\n \"authorization_code\": \"667270\",\n \"brand\": \"visa\",\n \"checks\": {\n \"address_line1_check\": \"pass\",\n \"address_postal_code_check\": \"pass\",\n \"cvc_check\": \"pass\"\n },\n \"country\": \"US\",\n \"exp_month\": 10,\n \"exp_year\": 2025,\n \"extended_authorization\": {\n \"status\": \"disabled\"\n },\n \"fingerprint\": \"h7L3P7Ht9VtwZ6yb\",\n \"funding\": \"credit\",\n \"incremental_authorization\": {\n \"status\": \"unavailable\"\n },\n \"installments\": null,\n \"last4\": \"4242\",\n \"mandate\": null,\n \"multicapture\": {\n \"status\": \"unavailable\"\n },\n \"network\": \"visa\",\n \"network_token\": {\n \"used\": false\n },\n \"network_transaction_id\": \"104557651805572\",\n \"overcapture\": {\n \"maximum_amount_capturable\": 6540,\n \"status\": \"unavailable\"\n },\n \"regulated_status\": \"unregulated\",\n \"three_d_secure\": null,\n \"wallet\": null\n },\n \"type\": \"card\"\n },\n \"radar_options\": {},\n \"receipt_email\": null,\n \"receipt_number\": null,\n \"receipt_url\": \"https://pay.stripe.com/receipts/payment/CAcaFwoVYWNjdF8xTTdmVGFENVI3Z0RBR2ZmKImcuMMGMgZ0E_VSu6k6LBYDbs4wzaE7cYX2DHDMygwy6f_E0Q1SGSjyRrHheoBChPHBQVxXj4zo7kwE\",\n \"refunded\": false,\n \"review\": null,\n \"shipping\": null,\n \"source\": null,\n \"source_transfer\": null,\n \"statement_descriptor\": null,\n \"statement_descriptor_suffix\": null,\n \"status\": \"succeeded\",\n \"transfer_data\": null,\n \"transfer_group\": null\n },\n \"livemode\": false,\n \"metadata\": {\n \"order_id\": \"12345_att_0197ede6d0497bc3b00553f0bd9bf01c\"\n },\n \"next_action\": null,\n \"on_behalf_of\": null,\n \"payment_method\": \"pm_1RirciD5R7gDAGff9P1tYKQk\",\n \"payment_method_configuration_details\": null,\n \"payment_method_options\": {\n \"card\": {\n \"installments\": null,\n \"mandate_options\": null,\n \"network\": null,\n \"request_three_d_secure\": \"automatic\"\n }\n },\n \"payment_method_types\": [\n \"card\"\n ],\n \"processing\": null,\n \"receipt_email\": null,\n \"review\": null,\n \"setup_future_usage\": \"on_session\",\n \"shipping\": null,\n \"source\": null,\n \"statement_descriptor\": null,\n \"statement_descriptor_suffix\": null,\n \"status\": \"succeeded\",\n \"transfer_data\": null,\n \"transfer_group\": null\n}" } ``` The raw_connector_response was a JSON in logs, now it is a Secret ![image](https://github.com/user-attachments/assets/ce19a048-0bca-43e6-b293-7940b0cedd4f) ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

cb83bf8c2f4486fee99f88bc85bd6e6cb4430e13

juspay/hyperswitch

juspay__hyperswitch-8564

Bug: chore: Conditoinal config for invoking DE routing There should be a conditional check for Decision Engine (DE) Euclid API integration within the static routing flow. Right now, the system always attempted to perform Euclid-based routing regardless of configuration. With this change, the Euclid routing flow is invoked only if the OpenRouter URL is configured.

diff --git a/config/config.example.toml b/config/config.example.toml index 3c6da56b240..02224da9024 100644 --- a/config/config.example.toml +++ b/config/config.example.toml @@ -1094,7 +1094,8 @@ background_color = "#FFFFFF" billing_connectors_which_require_payment_sync = "stripebilling, recurly" # List of billing connectors which has payment sync api call [open_router] -enabled = true # Enable or disable Open Router +dynamic_routing_enabled = true # Enable or disable Open Router for dynamic routing +static_routing_enabled = true # Enable or disable Open Router for static routing url = "http://localhost:8080" # Open Router URL [grpc_client.unified_connector_service] diff --git a/config/development.toml b/config/development.toml index ab885503c85..ece582a388f 100644 --- a/config/development.toml +++ b/config/development.toml @@ -1189,7 +1189,8 @@ allow_connected_merchants = true click_to_pay = {connector_list = "adyen, cybersource"} [open_router] -enabled = false +dynamic_routing_enabled = false +static_routing_enabled = false url = "http://localhost:8080" [grpc_client.unified_connector_service] diff --git a/crates/router/src/configs/settings.rs b/crates/router/src/configs/settings.rs index ee7b3ed820e..6157a4fab20 100644 --- a/crates/router/src/configs/settings.rs +++ b/crates/router/src/configs/settings.rs @@ -175,7 +175,8 @@ pub struct DebitRoutingConfig { #[derive(Debug, Deserialize, Clone, Default)] pub struct OpenRouter { - pub enabled: bool, + pub dynamic_routing_enabled: bool, + pub static_routing_enabled: bool, pub url: String, } @@ -1080,6 +1081,8 @@ impl Settings<SecuredSecret> { self.platform.validate()?; + self.open_router.validate()?; + Ok(()) } } diff --git a/crates/router/src/configs/validations.rs b/crates/router/src/configs/validations.rs index ab5f2af4160..4fc254760a0 100644 --- a/crates/router/src/configs/validations.rs +++ b/crates/router/src/configs/validations.rs @@ -327,3 +327,19 @@ impl super::settings::Platform { }) } } + +impl super::settings::OpenRouter { + pub fn validate(&self) -> Result<(), ApplicationError> { + use common_utils::fp_utils::when; + + when( + (self.dynamic_routing_enabled || self.static_routing_enabled) + && self.url.is_default_or_empty(), + || { + Err(ApplicationError::InvalidConfigurationValueError( + "OpenRouter base URL must not be empty when it is enabled".into(), + )) + }, + ) + } +} diff --git a/crates/router/src/core/admin.rs b/crates/router/src/core/admin.rs index f362d413d3e..18772bd7100 100644 --- a/crates/router/src/core/admin.rs +++ b/crates/router/src/core/admin.rs @@ -1230,7 +1230,7 @@ pub async fn merchant_account_delete( // Call to DE here #[cfg(all(feature = "dynamic_routing", feature = "v1"))] { - if state.conf.open_router.enabled && is_deleted { + if state.conf.open_router.dynamic_routing_enabled && is_deleted { merchant_account .default_profile .as_ref() diff --git a/crates/router/src/core/debit_routing.rs b/crates/router/src/core/debit_routing.rs index d4f7c8bd753..651f1ea04c3 100644 --- a/crates/router/src/core/debit_routing.rs +++ b/crates/router/src/core/debit_routing.rs @@ -123,7 +123,7 @@ where F: Send + Clone, D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, { - if business_profile.is_debit_routing_enabled && state.conf.open_router.enabled { + if business_profile.is_debit_routing_enabled && state.conf.open_router.dynamic_routing_enabled { logger::info!("Debit routing is enabled for the profile"); let debit_routing_config = &state.conf.debit_routing_config; diff --git a/crates/router/src/core/health_check.rs b/crates/router/src/core/health_check.rs index 49138d3bda0..7bc65e4d0e4 100644 --- a/crates/router/src/core/health_check.rs +++ b/crates/router/src/core/health_check.rs @@ -194,7 +194,7 @@ impl HealthCheckInterface for app::SessionState { async fn health_check_decision_engine( &self, ) -> CustomResult<HealthState, errors::HealthCheckDecisionEngineError> { - if self.conf.open_router.enabled { + if self.conf.open_router.dynamic_routing_enabled { let url = format!("{}/{}", &self.conf.open_router.url, "health"); let request = services::Request::new(services::Method::Get, &url); let _ = services::call_connector_api(self, request, "health_check_for_decision_engine") diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs index 32b6aa1bfbd..8a0058b79e4 100644 --- a/crates/router/src/core/payments.rs +++ b/crates/router/src/core/payments.rs @@ -8409,7 +8409,7 @@ where .attach_printable("failed to perform volume split on routing type")?; if routing_choice.routing_type.is_dynamic_routing() { - if state.conf.open_router.enabled { + if state.conf.open_router.dynamic_routing_enabled { routing::perform_dynamic_routing_with_open_router( state, connectors.clone(), diff --git a/crates/router/src/core/payments/operations/payment_response.rs b/crates/router/src/core/payments/operations/payment_response.rs index e72555b2ede..7fa8a4858f8 100644 --- a/crates/router/src/core/payments/operations/payment_response.rs +++ b/crates/router/src/core/payments/operations/payment_response.rs @@ -2167,7 +2167,8 @@ async fn payment_response_update_tracker<F: Clone, T: types::Capturable>( ); tokio::spawn( async move { - let should_route_to_open_router = state.conf.open_router.enabled; + let should_route_to_open_router = + state.conf.open_router.dynamic_routing_enabled; if should_route_to_open_router { routing_helpers::update_gateway_score_helper_with_open_router( diff --git a/crates/router/src/core/payments/routing.rs b/crates/router/src/core/payments/routing.rs index c3823aa2f30..7feea3286ca 100644 --- a/crates/router/src/core/payments/routing.rs +++ b/crates/router/src/core/payments/routing.rs @@ -490,29 +490,33 @@ pub async fn perform_static_routing_v1( .to_string(), }; - let routing_events_wrapper = utils::RoutingEventsWrapper::new( - state.tenant.tenant_id.clone(), - state.request_id, - payment_id, - business_profile.get_id().to_owned(), - business_profile.merchant_id.to_owned(), - "DecisionEngine: Euclid Static Routing".to_string(), - None, - true, - false, - ); + let de_euclid_connectors = if state.conf.open_router.static_routing_enabled { + let routing_events_wrapper = utils::RoutingEventsWrapper::new( + state.tenant.tenant_id.clone(), + state.request_id, + payment_id, + business_profile.get_id().to_owned(), + business_profile.merchant_id.to_owned(), + "DecisionEngine: Euclid Static Routing".to_string(), + None, + true, + false, + ); - let de_euclid_connectors = perform_decision_euclid_routing( - state, - backend_input.clone(), - business_profile.get_id().get_string_repr().to_string(), - routing_events_wrapper - ) - .await - .map_err(|e| - // errors are ignored as this is just for diff checking as of now (optional flow). - logger::error!(decision_engine_euclid_evaluate_error=?e, "decision_engine_euclid: error in evaluation of rule") - ).unwrap_or_default(); + perform_decision_euclid_routing( + state, + backend_input.clone(), + business_profile.get_id().get_string_repr().to_string(), + routing_events_wrapper + ) + .await + .map_err(|e| + // errors are ignored as this is just for diff checking as of now (optional flow). + logger::error!(decision_engine_euclid_evaluate_error=?e, "decision_engine_euclid: error in evaluation of rule") + ).unwrap_or_default() + } else { + Vec::default() + }; let (routable_connectors, routing_approach) = match cached_algorithm.as_ref() { CachedAlgorithm::Single(conn) => ( diff --git a/crates/router/src/core/payments/routing/utils.rs b/crates/router/src/core/payments/routing/utils.rs index bef71d5fc66..d2167f88498 100644 --- a/crates/router/src/core/payments/routing/utils.rs +++ b/crates/router/src/core/payments/routing/utils.rs @@ -335,8 +335,6 @@ pub async fn perform_decision_euclid_routing( routing_event.set_routable_connectors(euclid_response.evaluated_output.clone()); state.event_handler.log_event(&routing_event); - // Need to log euclid response event here - logger::debug!(decision_engine_euclid_response=?euclid_response,"decision_engine_euclid"); logger::debug!(decision_engine_euclid_selected_connector=?euclid_response.evaluated_output,"decision_engine_euclid"); diff --git a/crates/router/src/core/routing.rs b/crates/router/src/core/routing.rs index ffd5f60e79d..52a3b4f1a7b 100644 --- a/crates/router/src/core/routing.rs +++ b/crates/router/src/core/routing.rs @@ -687,7 +687,7 @@ pub async fn link_routing_config( // Call to DE here to update SR configs #[cfg(all(feature = "dynamic_routing", feature = "v1"))] { - if state.conf.open_router.enabled { + if state.conf.open_router.dynamic_routing_enabled { update_decision_engine_dynamic_routing_setup( &state, business_profile.get_id(), @@ -718,7 +718,7 @@ pub async fn link_routing_config( ); #[cfg(all(feature = "dynamic_routing", feature = "v1"))] { - if state.conf.open_router.enabled { + if state.conf.open_router.dynamic_routing_enabled { update_decision_engine_dynamic_routing_setup( &state, business_profile.get_id(), @@ -1844,7 +1844,7 @@ pub async fn success_based_routing_update_configs( router_env::metric_attributes!(("profile_id", profile_id.clone())), ); - if !state.conf.open_router.enabled { + if !state.conf.open_router.dynamic_routing_enabled { state .grpc_client .dynamic_routing @@ -1948,7 +1948,7 @@ pub async fn elimination_routing_update_configs( router_env::metric_attributes!(("profile_id", profile_id.clone())), ); - if !state.conf.open_router.enabled { + if !state.conf.open_router.dynamic_routing_enabled { state .grpc_client .dynamic_routing diff --git a/crates/router/src/core/routing/helpers.rs b/crates/router/src/core/routing/helpers.rs index df9c11efe45..8b4c747d13f 100644 --- a/crates/router/src/core/routing/helpers.rs +++ b/crates/router/src/core/routing/helpers.rs @@ -1923,7 +1923,7 @@ pub async fn disable_dynamic_routing_algorithm( }; // Call to DE here - if state.conf.open_router.enabled { + if state.conf.open_router.dynamic_routing_enabled { disable_decision_engine_dynamic_routing_setup( state, business_profile.get_id(), @@ -2111,11 +2111,12 @@ pub async fn default_specific_dynamic_routing_setup( let timestamp = common_utils::date_time::now(); let algo = match dynamic_routing_type { routing_types::DynamicRoutingType::SuccessRateBasedRouting => { - let default_success_based_routing_config = if state.conf.open_router.enabled { - routing_types::SuccessBasedRoutingConfig::open_router_config_default() - } else { - routing_types::SuccessBasedRoutingConfig::default() - }; + let default_success_based_routing_config = + if state.conf.open_router.dynamic_routing_enabled { + routing_types::SuccessBasedRoutingConfig::open_router_config_default() + } else { + routing_types::SuccessBasedRoutingConfig::default() + }; routing_algorithm::RoutingAlgorithm { algorithm_id: algorithm_id.clone(), @@ -2132,11 +2133,12 @@ pub async fn default_specific_dynamic_routing_setup( } } routing_types::DynamicRoutingType::EliminationRouting => { - let default_elimination_routing_config = if state.conf.open_router.enabled { - routing_types::EliminationRoutingConfig::open_router_config_default() - } else { - routing_types::EliminationRoutingConfig::default() - }; + let default_elimination_routing_config = + if state.conf.open_router.dynamic_routing_enabled { + routing_types::EliminationRoutingConfig::open_router_config_default() + } else { + routing_types::EliminationRoutingConfig::default() + }; routing_algorithm::RoutingAlgorithm { algorithm_id: algorithm_id.clone(), profile_id: profile_id.clone(), @@ -2162,7 +2164,7 @@ pub async fn default_specific_dynamic_routing_setup( // Call to DE here // Need to map out the cases if this call should always be made or not - if state.conf.open_router.enabled { + if state.conf.open_router.dynamic_routing_enabled { enable_decision_engine_dynamic_routing_setup( state, business_profile.get_id(),

2025-07-06T15:12:12Z

## Type of Change  - [x] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description This PR introduces a conditional check for Decision Engine (DE) Euclid API integration within the static routing flow. Previously, the system always attempted to perform Euclid-based routing regardless of configuration. With this change, the Euclid routing flow is invoked only if the OpenRouter URL is configured. Additionally, some unused or redundant code around logging and comments has been cleaned up in `utils.rs`. ## Outcomes - Prevents unnecessary calls to the Euclid API when the OpenRouter URL is not configured, reducing overhead and potential timeouts. - Ensures cleaner and more consistent logs by removing redundant debug statements and placeholders. - Improves maintainability by scoping the Euclid integration behind a clear configuration flag. ## Diff Hunk Explanation ### `crates/router/src/core/payments/routing.rs` - Wrapped the `perform_decision_euclid_routing` call with a check for `state.conf.open_router.url`. - Added a fallback to return an empty connector list if OpenRouter is not configured. ### `crates/router/src/core/payments/routing/utils.rs` - Removed a redundant placeholder comment about logging Euclid response events. - Streamlined debug logs for Euclid responses. This PR addresses an integration improvement for Euclid static routing checks in the decision engine. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [x] This PR modifies application configuration/environment variables  ## Motivation and Context  ## How did you test it?  Can be tested directly in prod as that is the only environment where this env in missing. ## Checklist  - [ ] I formatted the code `cargo +nightly fmt --all` - [ ] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

eb94cfe7e558348e8da3aeaaa01224a1ea2dbbe2

juspay/hyperswitch

juspay__hyperswitch-8557

Bug: [FEATURE] [CONNECTOR: PAYLOAD] Add Webhook support connector does not support signature verification. - https://docs.payload.com/apis/webhooks/ - https://docs.payload.com/apis/webhooks/triggers/ - https://docs.payload.com/apis/webhooks/oauth/ - https://docs.payload.com/apis/object-reference/webhook/ - https://docs.payload.com/apis/object-reference/webhook-logs/ - https://docs.payload.com/apis/authentication/ - https://docs.payload.com/apis/api-design/

diff --git a/crates/api_models/src/webhooks.rs b/crates/api_models/src/webhooks.rs index 177310de18f..75af0b19cf2 100644 --- a/crates/api_models/src/webhooks.rs +++ b/crates/api_models/src/webhooks.rs @@ -10,9 +10,9 @@ use crate::{disputes, enums as api_enums, mandates, payments, refunds}; #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize, Copy)] #[serde(rename_all = "snake_case")] pub enum IncomingWebhookEvent { - /// Authorization + Capture success - PaymentIntentFailure, /// Authorization + Capture failure + PaymentIntentFailure, + /// Authorization + Capture success PaymentIntentSuccess, PaymentIntentProcessing, PaymentIntentPartiallyFunded, diff --git a/crates/connector_configs/toml/development.toml b/crates/connector_configs/toml/development.toml index a8a0baa2661..cdf94d6e439 100644 --- a/crates/connector_configs/toml/development.toml +++ b/crates/connector_configs/toml/development.toml @@ -6328,8 +6328,7 @@ type="Text" payment_method_type = "Visa" [payload.connector_auth.HeaderKey] api_key="API Key" -[payload.connector_webhook_details] -merchant_secret="Source verification key" + [silverflow] [silverflow.connector_auth.BodyKey] api_key="API Key" diff --git a/crates/connector_configs/toml/production.toml b/crates/connector_configs/toml/production.toml index a22b50a9b4f..b9a98f5aedd 100644 --- a/crates/connector_configs/toml/production.toml +++ b/crates/connector_configs/toml/production.toml @@ -4935,10 +4935,8 @@ type="Text" payment_method_type = "Visa" [payload.connector_auth.HeaderKey] api_key="API Key" -[payload.connector_webhook_details] -merchant_secret="Source verification key" [silverflow] [silverflow.connector_auth.BodyKey] api_key="API Key" -key1="Secret Key" \ No newline at end of file +key1="Secret Key" diff --git a/crates/connector_configs/toml/sandbox.toml b/crates/connector_configs/toml/sandbox.toml index d7026129699..21801d380b5 100644 --- a/crates/connector_configs/toml/sandbox.toml +++ b/crates/connector_configs/toml/sandbox.toml @@ -6302,8 +6302,7 @@ type="Text" payment_method_type = "Visa" [payload.connector_auth.HeaderKey] api_key="API Key" -[payload.connector_webhook_details] -merchant_secret="Source verification key" + [silverflow] [silverflow.connector_auth.BodyKey] api_key="API Key" diff --git a/crates/hyperswitch_connectors/src/connectors/payload.rs b/crates/hyperswitch_connectors/src/connectors/payload.rs index c1f1516e63b..03c41d367aa 100644 --- a/crates/hyperswitch_connectors/src/connectors/payload.rs +++ b/crates/hyperswitch_connectors/src/connectors/payload.rs @@ -8,12 +8,12 @@ use base64::Engine; use common_enums::enums; use common_utils::{ consts::BASE64_ENGINE, - errors::CustomResult, - ext_traits::BytesExt, + errors::{CustomResult, ReportSwitchExt}, + ext_traits::{ByteSliceExt, BytesExt}, request::{Method, Request, RequestBuilder, RequestContent}, types::{AmountConvertor, StringMajorUnit, StringMajorUnitForConnector}, }; -use error_stack::{report, ResultExt}; +use error_stack::ResultExt; use hyperswitch_domain_models::{ payment_method_data::PaymentMethodData, router_data::{AccessToken, ConnectorAuthType, ErrorResponse, RouterData}, @@ -47,7 +47,7 @@ use hyperswitch_interfaces::{ types::{self, PaymentsVoidType, Response}, webhooks, }; -use masking::{ExposeInterface, Mask}; +use masking::{ExposeInterface, Mask, Secret}; use transformers as payload; use crate::{constants::headers, types::ResponseRouterData, utils}; @@ -195,7 +195,18 @@ impl ConnectorIntegration<Session, PaymentsSessionData, PaymentsResponseData> fo impl ConnectorIntegration<AccessTokenAuth, AccessTokenRequestData, AccessToken> for Payload {} -impl ConnectorIntegration<SetupMandate, SetupMandateRequestData, PaymentsResponseData> for Payload {} +impl ConnectorIntegration<SetupMandate, SetupMandateRequestData, PaymentsResponseData> for Payload { + fn build_request( + &self, + _req: &RouterData<SetupMandate, SetupMandateRequestData, PaymentsResponseData>, + _connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Err( + errors::ConnectorError::NotImplemented("Setup Mandate flow for Payload".to_string()) + .into(), + ) + } +} impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData> for Payload { fn get_headers( @@ -701,25 +712,95 @@ impl ConnectorIntegration<RSync, RefundsData, RefundsResponseData> for Payload { #[async_trait::async_trait] impl webhooks::IncomingWebhook for Payload { - fn get_webhook_object_reference_id( + async fn verify_webhook_source( &self, _request: &webhooks::IncomingWebhookRequestDetails<'_>, + _merchant_id: &common_utils::id_type::MerchantId, + _connector_webhook_details: Option<common_utils::pii::SecretSerdeValue>, + _connector_account_details: common_utils::crypto::Encryptable<Secret<serde_json::Value>>, + _connector_label: &str, + ) -> CustomResult<bool, errors::ConnectorError> { + // Payload does not support source verification + // It does, but the client id and client secret generation is not possible at present + // It requires OAuth connect which falls under Access Token flow and it also requires multiple calls to be made + // We return false just so that a PSync call is triggered internally + Ok(false) + } + + fn get_webhook_object_reference_id( + &self, + request: &webhooks::IncomingWebhookRequestDetails<'_>, ) -> CustomResult<api_models::webhooks::ObjectReferenceId, errors::ConnectorError> { - Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + let webhook_body: responses::PayloadWebhookEvent = request + .body + .parse_struct("PayloadWebhookEvent") + .change_context(errors::ConnectorError::WebhookBodyDecodingFailed)?; + + let reference_id = match webhook_body.trigger { + responses::PayloadWebhooksTrigger::Payment + | responses::PayloadWebhooksTrigger::Processed + | responses::PayloadWebhooksTrigger::Authorized + | responses::PayloadWebhooksTrigger::Credit + | responses::PayloadWebhooksTrigger::Reversal + | responses::PayloadWebhooksTrigger::Void + | responses::PayloadWebhooksTrigger::AutomaticPayment + | responses::PayloadWebhooksTrigger::Decline + | responses::PayloadWebhooksTrigger::Deposit + | responses::PayloadWebhooksTrigger::Reject + | responses::PayloadWebhooksTrigger::PaymentActivationStatus + | responses::PayloadWebhooksTrigger::PaymentLinkStatus + | responses::PayloadWebhooksTrigger::ProcessingStatus + | responses::PayloadWebhooksTrigger::BankAccountReject + | responses::PayloadWebhooksTrigger::Chargeback + | responses::PayloadWebhooksTrigger::ChargebackReversal + | responses::PayloadWebhooksTrigger::TransactionOperation + | responses::PayloadWebhooksTrigger::TransactionOperationClear => { + api_models::webhooks::ObjectReferenceId::PaymentId( + api_models::payments::PaymentIdType::ConnectorTransactionId( + webhook_body + .triggered_on + .transaction_id + .ok_or(errors::ConnectorError::WebhookReferenceIdNotFound)?, + ), + ) + } + + responses::PayloadWebhooksTrigger::Refund => { + api_models::webhooks::ObjectReferenceId::RefundId( + api_models::webhooks::RefundIdType::ConnectorRefundId( + webhook_body + .triggered_on + .transaction_id + .ok_or(errors::ConnectorError::WebhookReferenceIdNotFound)?, + ), + ) + } + }; + + Ok(reference_id) } fn get_webhook_event_type( &self, - _request: &webhooks::IncomingWebhookRequestDetails<'_>, + request: &webhooks::IncomingWebhookRequestDetails<'_>, ) -> CustomResult<api_models::webhooks::IncomingWebhookEvent, errors::ConnectorError> { - Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + let webhook_body: responses::PayloadWebhookEvent = + request.body.parse_struct("PayloadWebhookEvent").switch()?; + + Ok(api_models::webhooks::IncomingWebhookEvent::from( + webhook_body.trigger, + )) } fn get_webhook_resource_object( &self, - _request: &webhooks::IncomingWebhookRequestDetails<'_>, + request: &webhooks::IncomingWebhookRequestDetails<'_>, ) -> CustomResult<Box<dyn masking::ErasedMaskSerialize>, errors::ConnectorError> { - Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + let webhook_body: responses::PayloadWebhookEvent = request + .body + .parse_struct("PayloadWebhookEvent") + .change_context(errors::ConnectorError::WebhookReferenceIdNotFound)?; + Ok(Box::new(webhook_body)) } } @@ -782,7 +863,11 @@ static PAYLOAD_CONNECTOR_INFO: ConnectorInfo = ConnectorInfo { connector_type: enums::PaymentConnectorCategory::PaymentGateway, }; -static PAYLOAD_SUPPORTED_WEBHOOK_FLOWS: [enums::EventClass; 0] = []; +static PAYLOAD_SUPPORTED_WEBHOOK_FLOWS: [enums::EventClass; 3] = [ + enums::EventClass::Disputes, + enums::EventClass::Payments, + enums::EventClass::Refunds, +]; impl ConnectorSpecifications for Payload { fn get_connector_about(&self) -> Option<&'static ConnectorInfo> { diff --git a/crates/hyperswitch_connectors/src/connectors/payload/responses.rs b/crates/hyperswitch_connectors/src/connectors/payload/responses.rs index 63699d09810..444e794e6bd 100644 --- a/crates/hyperswitch_connectors/src/connectors/payload/responses.rs +++ b/crates/hyperswitch_connectors/src/connectors/payload/responses.rs @@ -38,6 +38,7 @@ pub struct PayloadCardsResponseData { #[serde(rename = "id")] pub transaction_id: String, pub payment_method_id: Option<Secret<String>>, + // Connector customer id pub processing_id: Option<String>, pub processing_method_id: Option<String>, pub ref_number: Option<String>, @@ -84,6 +85,7 @@ pub struct PayloadRefundResponse { pub transaction_id: String, pub ledger: Vec<RefundsLedger>, pub payment_method_id: Option<Secret<String>>, + // Connector customer id pub processing_id: Option<String>, pub ref_number: Option<String>, pub status: RefundStatus, @@ -99,3 +101,51 @@ pub struct PayloadErrorResponse { /// Payload returns arbitrary details in JSON format pub details: Option<serde_json::Value>, } + +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "snake_case")] +pub enum PayloadWebhooksTrigger { + Payment, + Processed, + Authorized, + Credit, + Refund, + Reversal, + Void, + AutomaticPayment, + Decline, + Deposit, + Reject, + #[serde(rename = "payment_activation:status")] + PaymentActivationStatus, + #[serde(rename = "payment_link:status")] + PaymentLinkStatus, + ProcessingStatus, + BankAccountReject, + Chargeback, + ChargebackReversal, + #[serde(rename = "transaction:operation")] + TransactionOperation, + #[serde(rename = "transaction:operation:clear")] + TransactionOperationClear, +} + +// Webhook response structures +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct PayloadWebhookEvent { + pub object: String, // Added to match actual webhook structure + pub trigger: PayloadWebhooksTrigger, + pub webhook_id: String, + pub triggered_at: String, // Added to match actual webhook structure + // Webhooks Payload + pub triggered_on: PayloadEventDetails, + pub url: String, +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct PayloadEventDetails { + #[serde(rename = "id")] + pub transaction_id: Option<String>, + pub object: String, + pub value: Option<serde_json::Value>, // Changed to handle any value type including null +} diff --git a/crates/hyperswitch_connectors/src/connectors/payload/transformers.rs b/crates/hyperswitch_connectors/src/connectors/payload/transformers.rs index 994b4a7cfce..707a8db9366 100644 --- a/crates/hyperswitch_connectors/src/connectors/payload/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/payload/transformers.rs @@ -1,20 +1,24 @@ +use api_models::webhooks::IncomingWebhookEvent; use common_enums::enums; use common_utils::types::StringMajorUnit; use hyperswitch_domain_models::{ payment_method_data::PaymentMethodData, - router_data::{ConnectorAuthType, RouterData}, + router_data::{ConnectorAuthType, ErrorResponse, RouterData}, router_flow_types::refunds::{Execute, RSync}, router_request_types::ResponseId, router_response_types::{PaymentsResponseData, RefundsResponseData}, types::{PaymentsAuthorizeRouterData, PaymentsCaptureRouterData, RefundsRouterData}, }; -use hyperswitch_interfaces::errors; +use hyperswitch_interfaces::{ + consts::{NO_ERROR_CODE, NO_ERROR_MESSAGE}, + errors, +}; use masking::Secret; use super::{requests, responses}; use crate::{ types::{RefundsResponseRouterData, ResponseRouterData}, - utils::{is_manual_capture, CardData, RouterData as OtherRouterData}, + utils::{is_manual_capture, AddressDetailsData, CardData, RouterData as OtherRouterData}, }; //TODO: Fill the struct with respective fields @@ -56,12 +60,20 @@ impl TryFrom<&PayloadRouterData<&PaymentsAuthorizeRouterData>> cvc: req_card.card_cvc, }; let address = item.router_data.get_billing_address()?; + + // Check for required fields and fail if they're missing + let city = address.get_city()?.to_owned(); + let country = address.get_country()?.to_owned(); + let postal_code = address.get_zip()?.to_owned(); + let state_province = address.get_state()?.to_owned(); + let street_address = address.get_line1()?.to_owned(); + let billing_address = requests::BillingAddress { - city: address.city.clone().unwrap_or_default(), - country: address.country.unwrap_or_default(), - postal_code: address.zip.clone().unwrap_or_default(), - state_province: address.state.clone().unwrap_or_default(), - street_address: address.line1.clone().unwrap_or_default(), + city, + country, + postal_code, + state_province, + street_address, }; // For manual capture, set status to "authorized" @@ -127,13 +139,29 @@ impl<F, T> ) -> Result<Self, Self::Error> { match item.response.clone() { responses::PayloadPaymentsResponse::PayloadCardsResponse(response) => { - let payment_status = response.status; - let transaction_id = response.transaction_id; - - Ok(Self { - status: common_enums::AttemptStatus::from(payment_status), - response: Ok(PaymentsResponseData::TransactionResponse { - resource_id: ResponseId::ConnectorTransactionId(transaction_id), + let status = enums::AttemptStatus::from(response.status); + let connector_customer = response.processing_id.clone(); + let response_result = if status == enums::AttemptStatus::Failure { + Err(ErrorResponse { + attempt_status: None, + code: response + .status_code + .clone() + .unwrap_or_else(|| NO_ERROR_CODE.to_string()), + message: response + .status_message + .clone() + .unwrap_or_else(|| NO_ERROR_MESSAGE.to_string()), + reason: response.status_message, + status_code: item.http_code, + connector_transaction_id: Some(response.transaction_id.clone()), + network_decline_code: None, + network_advice_code: None, + network_error_message: None, + }) + } else { + Ok(PaymentsResponseData::TransactionResponse { + resource_id: ResponseId::ConnectorTransactionId(response.transaction_id), redirection_data: Box::new(None), mandate_reference: Box::new(None), connector_metadata: None, @@ -141,7 +169,12 @@ impl<F, T> connector_response_reference_id: response.ref_number, incremental_authorization_allowed: None, charges: None, - }), + }) + }; + Ok(Self { + status, + response: response_result, + connector_customer, ..item.data }) } @@ -225,3 +258,41 @@ impl TryFrom<RefundsResponseRouterData<RSync, responses::PayloadRefundResponse>> }) } } + +// Webhook transformations +impl From<responses::PayloadWebhooksTrigger> for IncomingWebhookEvent { + fn from(trigger: responses::PayloadWebhooksTrigger) -> Self { + match trigger { + // Payment Success Events + responses::PayloadWebhooksTrigger::Processed => Self::PaymentIntentSuccess, + responses::PayloadWebhooksTrigger::Authorized => { + Self::PaymentIntentAuthorizationSuccess + } + // Payment Processing Events + responses::PayloadWebhooksTrigger::Payment + | responses::PayloadWebhooksTrigger::AutomaticPayment => Self::PaymentIntentProcessing, + // Payment Failure Events + responses::PayloadWebhooksTrigger::Decline + | responses::PayloadWebhooksTrigger::Reject + | responses::PayloadWebhooksTrigger::BankAccountReject => Self::PaymentIntentFailure, + responses::PayloadWebhooksTrigger::Void + | responses::PayloadWebhooksTrigger::Reversal => Self::PaymentIntentCancelled, + // Refund Events + responses::PayloadWebhooksTrigger::Refund => Self::RefundSuccess, + // Dispute Events + responses::PayloadWebhooksTrigger::Chargeback => Self::DisputeOpened, + responses::PayloadWebhooksTrigger::ChargebackReversal => Self::DisputeWon, + // Other payment-related events + // Events not supported by our standard flows + responses::PayloadWebhooksTrigger::PaymentActivationStatus + | responses::PayloadWebhooksTrigger::Credit + | responses::PayloadWebhooksTrigger::Deposit + | responses::PayloadWebhooksTrigger::PaymentLinkStatus + | responses::PayloadWebhooksTrigger::ProcessingStatus + | responses::PayloadWebhooksTrigger::TransactionOperation + | responses::PayloadWebhooksTrigger::TransactionOperationClear => { + Self::EventNotSupported + } + } + } +}

2025-07-06T10:29:15Z

## Type of Change  - [x] Bugfix - [x] New feature - [ ] Enhancement - [x] Refactoring - [ ] Dependency updates - [ ] Documentation - [x] CI/CD ## Description  This PR: - Adds support for webhooks to Payload connector. The connector does not support source verification. - Address Cypress comments that was asked in #8545. - Fixes setup mandate not throwing `501` ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [x] This PR modifies application configuration/environment variables  1. crates/connector_configs/toml/development.toml 2. crates/connector_configs/toml/production.toml 3. crates/connector_configs/toml/sandbox.toml ## Motivation and Context  Closes #8557 ## How did you test it?  <details> <summary>Setup Webhooks in Merchant Account</summary> ```curl curl --location 'https://pix-mbp.orthrus-monster.ts.net/accounts' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: test_admin' \ --data-raw '{ "merchant_id": "postman_merchant_GHAction_1751796781", "locker_id": "m0010", "merchant_name": "NewAge Retailer", "merchant_details": { "primary_contact_person": "John Test", "primary_email": "[email protected]", "primary_phone": "sunt laborum", "secondary_contact_person": "John Test2", "secondary_email": "[email protected]", "secondary_phone": "cillum do dolor id", "website": "www.example.com", "about_business": "Online Retail with a wide selection of organic products for North America" , "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US" } }, "return_url": "https://duck.com", "webhook_details": { "webhook_url": "https://webhook.site/02225e46-1016-4c2c-a492-efaaa5d41cf3", "webhook_version": "1.0.1", "webhook_username": "ekart_retail", "webhook_password": "password_ekart@123" }, "sub_merchants_enabled": false, "metadata": { "city": "NY", "unit": "245" }, "primary_business_details": [ { "country": "US", "business": "default" } ] }' ``` ```json { "merchant_id": "postman_merchant_GHAction_1751738744", "merchant_name": "NewAge Retailer", "return_url": "https://duck.com/", "enable_payment_response_hash": true, "payment_response_hash_key": "wsJ8BLD1TuNdKjCCMpoonWCJduaS9CT1EperKUJVLOQftECdAK7d4a7otMdv2EMq", "redirect_to_merchant_with_http_post": false, "merchant_details": { "primary_contact_person": "John Test", "primary_phone": "sunt laborum", "primary_email": "[email protected]", "secondary_contact_person": "John Test2", "secondary_phone": "cillum do dolor id", "secondary_email": "[email protected]", "website": "www.example.com", "about_business": "Online Retail with a wide selection of organic products for North America", "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": null, "last_name": null } }, "webhook_details": { "webhook_version": "1.0.1", "webhook_username": "ekart_retail", "webhook_password": "password_ekart@123", "webhook_url": "https://webhook.site/02225e46-1016-4c2c-a492-efaaa5d41cf3", "payment_created_enabled": null, "payment_succeeded_enabled": null, "payment_failed_enabled": null, "payment_statuses_enabled": null, "refund_statuses_enabled": null, "payout_statuses_enabled": null }, "payout_routing_algorithm": null, "sub_merchants_enabled": false, "parent_merchant_id": null, "publishable_key": "pk_dev_4ab91f8e35424d11acdd8c639a974f0c", "metadata": { "city": "NY", "unit": "245", "compatible_connector": null }, "locker_id": "m0010", "primary_business_details": [ { "country": "US", "business": "default" } ], "frm_routing_algorithm": null, "organization_id": "org_oZUZY7YEM9gts3EC4kbC", "is_recon_enabled": false, "default_profile": "pro_ZVgp4CWyKZKnx99AD7BL", "recon_status": "not_requested", "pm_collect_link_config": null, "product_type": "orchestration", "merchant_account_type": "standard" } ``` </details> <details> <summary>Setup Webhooks at Connector's end below commands by referring to the [trigger docs](https://docs.payload.com/apis/webhooks/triggers/)</summary> ```curl curl --location 'https://api.payload.com/webhooks/' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: api_key' \ --data-urlencode 'trigger=processed' \ --data-urlencode 'url=<base_url>/webhooks/<merchant_id>/<mca_id/connector_name>' ``` ```json { "attrs": null, "created_at": "Sun, 06 Jul 2025 07:24:29 GMT", "id": "<webhook_id>", "modified_at": "Sun, 06 Jul 2025 07:24:29 GMT", "oauth_params": null, "object": "webhook", "retries": 0, "trigger": "processed", "url": "<base_url>/webhooks/<merchant_id>/<mca_id/connector_name>" } ``` </details> <details> <summary>Make Payment</summary> ```curl curl --location 'https://pix-mbp.orthrus-monster.ts.net/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'Accept-Language: ja' \ --header 'api-key: dev_PCJYsjpYCN6C9ECuYT5g9LR1epAx5Jeqc7WpsXzoxpTbCcHqSqJ5CdUPnxdEh29y' \ --data-raw '{ "amount": 40, "currency": "USD", "confirm": true, "capture_method": "automatic", "capture_on": "2022-09-10T10:11:12Z", "amount_to_capture": 40, "customer_id": "customer", "email": "[email protected]", "phone": "999999999", "phone_country_code": "+1", "description": "Its my first payment request", "authentication_type": "no_three_ds", "return_url": "https://duck.com", "payment_method": "card", "payment_method_data": { "card": { "card_number": "4111111111111111", "card_exp_month": "10", "card_exp_year": "25", "card_holder_name": "Joseph Doe", "card_cvc": "123" } }, "billing": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US" , "first_name": "PiX" , "last_name": "THE" } }, "shipping": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "PiX" } }, "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "metadata": { "udf1": "value1", "new_customer": "true", "login_date": "2019-09-10T10:11:12Z" }, "browser_info": { "color_depth": 24, "java_enabled": true, "java_script_enabled": true, "language": "en-GB", "screen_height": 720, "screen_width": 1280, "time_zone": -330, "ip_address": "208.127.127.193", "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8", "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36 Edg/126.0.0.0" } }' ``` ```json { "payment_id": "pay_IMknbnvAK8MSCd1WXmrI", "merchant_id": "postman_merchant_GHAction_1751797139", "status": "succeeded", "amount": 40, "net_amount": 40, "shipping_cost": null, "amount_capturable": 0, "amount_received": 40, "connector": "payload", "client_secret": "pay_IMknbnvAK8MSCd1WXmrI_secret_Gj1Vtt77ai6KPzJ5AGHC", "created": "2025-07-06T10:20:56.697Z", "currency": "USD", "customer_id": "customer", "customer": { "id": "customer", "name": null, "email": "[email protected]", "phone": "999999999", "phone_country_code": "+1" }, "description": "Its my first payment request", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "card", "payment_method_data": { "card": { "last4": "1111", "card_type": "CREDIT", "card_network": "Visa", "card_issuer": "JP Morgan", "card_issuing_country": "INDIA", "card_isin": "411111", "card_extended_bin": null, "card_exp_month": "10", "card_exp_year": "25", "card_holder_name": "Joseph Doe", "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "PiX", "last_name": null }, "phone": null, "email": null }, "billing": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "PiX", "last_name": "THE" }, "phone": null, "email": null }, "order_details": null, "email": "[email protected]", "name": null, "phone": "999999999", "return_url": "https://duck.com/", "authentication_type": "no_three_ds", "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "credit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": { "customer_id": "customer", "created_at": 1751797256, "expires": 1751800856, "secret": "epk_d97417b2937b49a98be4f3bab68e34b1" }, "manual_retry_allowed": false, "connector_transaction_id": "txn_3ephQ2TpDLsQSnekEK1a8", "frm_message": null, "metadata": { "udf1": "value1", "login_date": "2019-09-10T10:11:12Z", "new_customer": "true" }, "connector_metadata": null, "feature_metadata": null, "reference_id": "PL-M3P-9HY-9T7", "payment_link": null, "profile_id": "pro_VaPL7y7qI4IY0F9cvRU2", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_KOpDieOFRmWvh26OJ9OH", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-07-06T10:35:56.697Z", "fingerprint": null, "browser_info": { "language": "en-GB", "time_zone": -330, "ip_address": "208.127.127.193", "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36 Edg/126.0.0.0", "color_depth": 24, "java_enabled": true, "screen_width": 1280, "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8", "screen_height": 720, "java_script_enabled": true }, "payment_method_id": null, "payment_method_status": null, "updated": "2025-07-06T10:20:57.632Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` </details> <details> <summary>Check website for outgoing webhooks</summary> <img width="1695" alt="image" src="https://github.com/user-attachments/assets/5a6890aa-85de-4b31-9337-d001e61b5236" /> </details> <details> <summary>Check logs for incoming webhooks</summary> <img width="1286" alt="image" src="https://github.com/user-attachments/assets/0963fdfc-d21f-4acf-b795-b9d829409a75" /> <img width="1291" alt="image" src="https://github.com/user-attachments/assets/b12582e5-b732-427b-abf3-f31582fa1b92" /> </details> <details> <summary>Cypress</summary> `19` failures is because the connector marked them as duplicate even with 15 seconds timeout. <img width="553" alt="image" src="https://github.com/user-attachments/assets/b217d420-a5ce-4a68-b0cc-89cd920049ba" /> </details> ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `just clippy && just clippy_v2` - [x] I reviewed the submitted code - [x] I added unit tests for my changes where possible

v1.115.0

99885b699d7524e87697f78608e6f2b36c9d8a8e

juspay/hyperswitch

juspay__hyperswitch-8575

Bug: [FEATURE] Cellero commerce integration ### Feature Description Integrate celero commerce Connector ### Possible Implementation Celero commerce integration ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? Yes, I am willing to submit a PR!

diff --git a/crates/connector_configs/toml/development.toml b/crates/connector_configs/toml/development.toml index 83544e40cc1..160a29aa1a3 100644 --- a/crates/connector_configs/toml/development.toml +++ b/crates/connector_configs/toml/development.toml @@ -1446,6 +1446,35 @@ merchant_id_evoucher="MerchantId Evoucher" [cashtocode.connector_webhook_details] merchant_secret="Source verification key" +[celero] +[[celero.credit]] + payment_method_type = "AmericanExpress" +[[celero.credit]] + payment_method_type = "Discover" +[[celero.credit]] + payment_method_type = "DinersClub" +[[celero.credit]] + payment_method_type = "JCB" +[[celero.credit]] + payment_method_type = "Mastercard" +[[celero.credit]] + payment_method_type = "Visa" +[[celero.debit]] + payment_method_type = "AmericanExpress" +[[celero.debit]] + payment_method_type = "Discover" +[[celero.debit]] + payment_method_type = "DinersClub" +[[celero.debit]] + payment_method_type = "JCB" +[[celero.debit]] + payment_method_type = "Mastercard" +[[celero.debit]] + payment_method_type = "Visa" +[celero.connector_auth.HeaderKey] +api_key="Celero API Key" + + [checkbook] [[checkbook.bank_transfer]] payment_method_type = "ach" diff --git a/crates/connector_configs/toml/production.toml b/crates/connector_configs/toml/production.toml index 019d842b8d1..47aff66d845 100644 --- a/crates/connector_configs/toml/production.toml +++ b/crates/connector_configs/toml/production.toml @@ -1212,6 +1212,34 @@ key1 = "Secret Key" [cryptopay.connector_webhook_details] merchant_secret = "Source verification key" +[celero] +[[celero.credit]] + payment_method_type = "AmericanExpress" +[[celero.credit]] + payment_method_type = "Discover" +[[celero.credit]] + payment_method_type = "DinersClub" +[[celero.credit]] + payment_method_type = "JCB" +[[celero.credit]] + payment_method_type = "Mastercard" +[[celero.credit]] + payment_method_type = "Visa" +[[celero.debit]] + payment_method_type = "AmericanExpress" +[[celero.debit]] + payment_method_type = "Discover" +[[celero.debit]] + payment_method_type = "DinersClub" +[[celero.debit]] + payment_method_type = "JCB" +[[celero.debit]] + payment_method_type = "Mastercard" +[[celero.debit]] + payment_method_type = "Visa" +[celero.connector_auth.HeaderKey] +api_key="Celero API Key" + [checkbook] [[checkbook.bank_transfer]] payment_method_type = "ach" diff --git a/crates/connector_configs/toml/sandbox.toml b/crates/connector_configs/toml/sandbox.toml index 8571315082e..d1ea6ba609f 100644 --- a/crates/connector_configs/toml/sandbox.toml +++ b/crates/connector_configs/toml/sandbox.toml @@ -1445,6 +1445,35 @@ merchant_id_evoucher = "MerchantId Evoucher" [cashtocode.connector_webhook_details] merchant_secret = "Source verification key" +[celero] +[[celero.credit]] + payment_method_type = "AmericanExpress" +[[celero.credit]] + payment_method_type = "Discover" +[[celero.credit]] + payment_method_type = "DinersClub" +[[celero.credit]] + payment_method_type = "JCB" +[[celero.credit]] + payment_method_type = "Mastercard" +[[celero.credit]] + payment_method_type = "Visa" +[[celero.debit]] + payment_method_type = "AmericanExpress" +[[celero.debit]] + payment_method_type = "Discover" +[[celero.debit]] + payment_method_type = "DinersClub" +[[celero.debit]] + payment_method_type = "JCB" +[[celero.debit]] + payment_method_type = "Mastercard" +[[celero.debit]] + payment_method_type = "Visa" +[celero.connector_auth.HeaderKey] +api_key="Celero API Key" + + [checkbook] [[checkbook.bank_transfer]] payment_method_type = "ach" diff --git a/crates/hyperswitch_connectors/src/connectors/celero.rs b/crates/hyperswitch_connectors/src/connectors/celero.rs index 9db111a10e4..726791a72eb 100644 --- a/crates/hyperswitch_connectors/src/connectors/celero.rs +++ b/crates/hyperswitch_connectors/src/connectors/celero.rs @@ -1,10 +1,13 @@ pub mod transformers; +use std::sync::LazyLock; + +use common_enums::enums; use common_utils::{ errors::CustomResult, ext_traits::BytesExt, request::{Method, Request, RequestBuilder, RequestContent}, - types::{AmountConvertor, StringMinorUnit, StringMinorUnitForConnector}, + types::{AmountConvertor, MinorUnit, MinorUnitForConnector}, }; use error_stack::{report, ResultExt}; use hyperswitch_domain_models::{ @@ -19,7 +22,10 @@ use hyperswitch_domain_models::{ PaymentsCancelData, PaymentsCaptureData, PaymentsSessionData, PaymentsSyncData, RefundsData, SetupMandateRequestData, }, - router_response_types::{PaymentsResponseData, RefundsResponseData}, + router_response_types::{ + ConnectorInfo, PaymentMethodDetails, PaymentsResponseData, RefundsResponseData, + SupportedPaymentMethods, SupportedPaymentMethodsExt, + }, types::{ PaymentsAuthorizeRouterData, PaymentsCaptureRouterData, PaymentsSyncRouterData, RefundSyncRouterData, RefundsRouterData, @@ -43,13 +49,13 @@ use crate::{constants::headers, types::ResponseRouterData, utils}; #[derive(Clone)] pub struct Celero { - amount_converter: &'static (dyn AmountConvertor<Output = StringMinorUnit> + Sync), + amount_converter: &'static (dyn AmountConvertor<Output = MinorUnit> + Sync), } impl Celero { pub fn new() -> &'static Self { &Self { - amount_converter: &StringMinorUnitForConnector, + amount_converter: &MinorUnitForConnector, } } } @@ -98,10 +104,7 @@ impl ConnectorCommon for Celero { } fn get_currency_unit(&self) -> api::CurrencyUnit { - api::CurrencyUnit::Base - // TODO! Check connector documentation, on which unit they are processing the currency. - // If the connector accepts amount in lower unit ( i.e cents for USD) then return api::CurrencyUnit::Minor, - // if connector accepts amount in base unit (i.e dollars for USD) then return api::CurrencyUnit::Base + api::CurrencyUnit::Minor } fn common_get_content_type(&self) -> &'static str { @@ -137,23 +140,53 @@ impl ConnectorCommon for Celero { event_builder.map(|i| i.set_response_body(&response)); router_env::logger::info!(connector_response=?response); + // Extract error details from the response + let error_details = celero::CeleroErrorDetails::from(response); + Ok(ErrorResponse { status_code: res.status_code, - code: response.code, - message: response.message, - reason: response.reason, + code: error_details + .error_code + .unwrap_or_else(|| "UNKNOWN_ERROR".to_string()), + message: error_details.error_message, + reason: error_details.decline_reason, attempt_status: None, connector_transaction_id: None, - network_decline_code: None, + network_decline_code: error_details.processor_response_code.clone(), network_advice_code: None, - network_error_message: None, + network_error_message: error_details.processor_response_code, connector_metadata: None, }) } } impl ConnectorValidation for Celero { - //TODO: implement functions when support enabled + fn validate_connector_against_payment_request( + &self, + capture_method: Option<enums::CaptureMethod>, + _payment_method: enums::PaymentMethod, + _pmt: Option<enums::PaymentMethodType>, + ) -> CustomResult<(), errors::ConnectorError> { + let capture_method = capture_method.unwrap_or_default(); + + // CeleroCommerce supports both automatic (sale) and manual (authorize + capture) flows + let is_capture_method_supported = matches!( + capture_method, + enums::CaptureMethod::Automatic + | enums::CaptureMethod::Manual + | enums::CaptureMethod::SequentialAutomatic + ); + + if is_capture_method_supported { + Ok(()) + } else { + Err(errors::ConnectorError::NotSupported { + message: capture_method.to_string(), + connector: self.id(), + } + .into()) + } + } } impl ConnectorIntegration<Session, PaymentsSessionData, PaymentsResponseData> for Celero { @@ -180,9 +213,9 @@ impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData fn get_url( &self, _req: &PaymentsAuthorizeRouterData, - _connectors: &Connectors, + connectors: &Connectors, ) -> CustomResult<String, errors::ConnectorError> { - Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + Ok(format!("{}/api/transaction", self.base_url(connectors))) } fn get_request_body( @@ -196,7 +229,7 @@ impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData req.request.currency, )?; - let connector_router_data = celero::CeleroRouterData::from((amount, req)); + let connector_router_data = celero::CeleroRouterData::try_from((amount, req))?; let connector_req = celero::CeleroPaymentsRequest::try_from(&connector_router_data)?; Ok(RequestContent::Json(Box::new(connector_req))) } @@ -267,9 +300,22 @@ impl ConnectorIntegration<PSync, PaymentsSyncData, PaymentsResponseData> for Cel fn get_url( &self, _req: &PaymentsSyncRouterData, - _connectors: &Connectors, + connectors: &Connectors, ) -> CustomResult<String, errors::ConnectorError> { - Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + // CeleroCommerce uses search API for payment sync + Ok(format!( + "{}/api/transaction/search", + self.base_url(connectors) + )) + } + + fn get_request_body( + &self, + req: &PaymentsSyncRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let connector_req = celero::CeleroSearchRequest::try_from(req)?; + Ok(RequestContent::Json(Box::new(connector_req))) } fn build_request( @@ -279,10 +325,13 @@ impl ConnectorIntegration<PSync, PaymentsSyncData, PaymentsResponseData> for Cel ) -> CustomResult<Option<Request>, errors::ConnectorError> { Ok(Some( RequestBuilder::new() - .method(Method::Get) + .method(Method::Post) .url(&types::PaymentsSyncType::get_url(self, req, connectors)?) .attach_default_headers() .headers(types::PaymentsSyncType::get_headers(self, req, connectors)?) + .set_body(types::PaymentsSyncType::get_request_body( + self, req, connectors, + )?) .build(), )) } @@ -330,18 +379,31 @@ impl ConnectorIntegration<Capture, PaymentsCaptureData, PaymentsResponseData> fo fn get_url( &self, - _req: &PaymentsCaptureRouterData, - _connectors: &Connectors, + req: &PaymentsCaptureRouterData, + connectors: &Connectors, ) -> CustomResult<String, errors::ConnectorError> { - Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + let connector_payment_id = req.request.connector_transaction_id.clone(); + Ok(format!( + "{}/api/transaction/{}/capture", + self.base_url(connectors), + connector_payment_id + )) } fn get_request_body( &self, - _req: &PaymentsCaptureRouterData, + req: &PaymentsCaptureRouterData, _connectors: &Connectors, ) -> CustomResult<RequestContent, errors::ConnectorError> { - Err(errors::ConnectorError::NotImplemented("get_request_body method".to_string()).into()) + let amount = utils::convert_amount( + self.amount_converter, + req.request.minor_amount_to_capture, + req.request.currency, + )?; + + let connector_router_data = celero::CeleroRouterData::try_from((amount, req))?; + let connector_req = celero::CeleroCaptureRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) } fn build_request( @@ -370,7 +432,7 @@ impl ConnectorIntegration<Capture, PaymentsCaptureData, PaymentsResponseData> fo event_builder: Option<&mut ConnectorEvent>, res: Response, ) -> CustomResult<PaymentsCaptureRouterData, errors::ConnectorError> { - let response: celero::CeleroPaymentsResponse = res + let response: celero::CeleroCaptureResponse = res .response .parse_struct("Celero PaymentsCaptureResponse") .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; @@ -392,7 +454,77 @@ impl ConnectorIntegration<Capture, PaymentsCaptureData, PaymentsResponseData> fo } } -impl ConnectorIntegration<Void, PaymentsCancelData, PaymentsResponseData> for Celero {} +impl ConnectorIntegration<Void, PaymentsCancelData, PaymentsResponseData> for Celero { + fn get_headers( + &self, + req: &RouterData<Void, PaymentsCancelData, PaymentsResponseData>, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + req: &RouterData<Void, PaymentsCancelData, PaymentsResponseData>, + connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + let connector_payment_id = req.request.connector_transaction_id.clone(); + Ok(format!( + "{}/api/transaction/{}/void", + self.base_url(connectors), + connector_payment_id + )) + } + + fn build_request( + &self, + req: &RouterData<Void, PaymentsCancelData, PaymentsResponseData>, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::PaymentsVoidType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::PaymentsVoidType::get_headers(self, req, connectors)?) + .build(), + )) + } + + fn handle_response( + &self, + data: &RouterData<Void, PaymentsCancelData, PaymentsResponseData>, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult< + RouterData<Void, PaymentsCancelData, PaymentsResponseData>, + errors::ConnectorError, + > { + let response: celero::CeleroVoidResponse = res + .response + .parse_struct("Celero PaymentsVoidResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} impl ConnectorIntegration<Execute, RefundsData, RefundsResponseData> for Celero { fn get_headers( @@ -409,10 +541,15 @@ impl ConnectorIntegration<Execute, RefundsData, RefundsResponseData> for Celero fn get_url( &self, - _req: &RefundsRouterData<Execute>, - _connectors: &Connectors, + req: &RefundsRouterData<Execute>, + connectors: &Connectors, ) -> CustomResult<String, errors::ConnectorError> { - Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + let connector_payment_id = req.request.connector_transaction_id.clone(); + Ok(format!( + "{}/api/transaction/{}/refund", + self.base_url(connectors), + connector_payment_id + )) } fn get_request_body( @@ -426,7 +563,7 @@ impl ConnectorIntegration<Execute, RefundsData, RefundsResponseData> for Celero req.request.currency, )?; - let connector_router_data = celero::CeleroRouterData::from((refund_amount, req)); + let connector_router_data = celero::CeleroRouterData::try_from((refund_amount, req))?; let connector_req = celero::CeleroRefundRequest::try_from(&connector_router_data)?; Ok(RequestContent::Json(Box::new(connector_req))) } @@ -456,10 +593,10 @@ impl ConnectorIntegration<Execute, RefundsData, RefundsResponseData> for Celero event_builder: Option<&mut ConnectorEvent>, res: Response, ) -> CustomResult<RefundsRouterData<Execute>, errors::ConnectorError> { - let response: celero::RefundResponse = - res.response - .parse_struct("celero RefundResponse") - .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + let response: celero::CeleroRefundResponse = res + .response + .parse_struct("celero RefundResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; event_builder.map(|i| i.set_response_body(&response)); router_env::logger::info!(connector_response=?response); RouterData::try_from(ResponseRouterData { @@ -494,9 +631,22 @@ impl ConnectorIntegration<RSync, RefundsData, RefundsResponseData> for Celero { fn get_url( &self, _req: &RefundSyncRouterData, - _connectors: &Connectors, + connectors: &Connectors, ) -> CustomResult<String, errors::ConnectorError> { - Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + // CeleroCommerce uses search API for refund sync + Ok(format!( + "{}/api/transaction/search", + self.base_url(connectors) + )) + } + + fn get_request_body( + &self, + req: &RefundSyncRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let connector_req = celero::CeleroSearchRequest::try_from(req)?; + Ok(RequestContent::Json(Box::new(connector_req))) } fn build_request( @@ -506,7 +656,7 @@ impl ConnectorIntegration<RSync, RefundsData, RefundsResponseData> for Celero { ) -> CustomResult<Option<Request>, errors::ConnectorError> { Ok(Some( RequestBuilder::new() - .method(Method::Get) + .method(Method::Post) .url(&types::RefundSyncType::get_url(self, req, connectors)?) .attach_default_headers() .headers(types::RefundSyncType::get_headers(self, req, connectors)?) @@ -523,7 +673,7 @@ impl ConnectorIntegration<RSync, RefundsData, RefundsResponseData> for Celero { event_builder: Option<&mut ConnectorEvent>, res: Response, ) -> CustomResult<RefundSyncRouterData, errors::ConnectorError> { - let response: celero::RefundResponse = res + let response: celero::CeleroRefundResponse = res .response .parse_struct("celero RefundSyncResponse") .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; @@ -569,4 +719,80 @@ impl webhooks::IncomingWebhook for Celero { } } -impl ConnectorSpecifications for Celero {} +static CELERO_SUPPORTED_PAYMENT_METHODS: LazyLock<SupportedPaymentMethods> = LazyLock::new(|| { + let supported_capture_methods = vec![ + enums::CaptureMethod::Automatic, + enums::CaptureMethod::Manual, + enums::CaptureMethod::SequentialAutomatic, + ]; + let supported_card_network = vec![ + common_enums::CardNetwork::AmericanExpress, + common_enums::CardNetwork::Discover, + common_enums::CardNetwork::DinersClub, + common_enums::CardNetwork::JCB, + common_enums::CardNetwork::Mastercard, + common_enums::CardNetwork::Visa, + ]; + + let mut celero_supported_payment_methods = SupportedPaymentMethods::new(); + + celero_supported_payment_methods.add( + enums::PaymentMethod::Card, + enums::PaymentMethodType::Credit, + PaymentMethodDetails { + mandates: enums::FeatureStatus::NotSupported, + refunds: enums::FeatureStatus::Supported, + supported_capture_methods: supported_capture_methods.clone(), + specific_features: Some( + api_models::feature_matrix::PaymentMethodSpecificFeatures::Card({ + api_models::feature_matrix::CardSpecificFeatures { + three_ds: common_enums::FeatureStatus::NotSupported, + no_three_ds: common_enums::FeatureStatus::Supported, + supported_card_networks: supported_card_network.clone(), + } + }), + ), + }, + ); + + celero_supported_payment_methods.add( + enums::PaymentMethod::Card, + enums::PaymentMethodType::Debit, + PaymentMethodDetails { + mandates: enums::FeatureStatus::NotSupported, + refunds: enums::FeatureStatus::Supported, + supported_capture_methods: supported_capture_methods.clone(), + specific_features: Some( + api_models::feature_matrix::PaymentMethodSpecificFeatures::Card({ + api_models::feature_matrix::CardSpecificFeatures { + three_ds: common_enums::FeatureStatus::NotSupported, + no_three_ds: common_enums::FeatureStatus::Supported, + supported_card_networks: supported_card_network.clone(), + } + }), + ), + }, + ); + + celero_supported_payment_methods +}); + +static CELERO_CONNECTOR_INFO: ConnectorInfo = ConnectorInfo { + display_name: "Celero", + description: "Celero is your trusted provider for payment processing technology and solutions, with a commitment to helping small to mid-sized businesses thrive", + connector_type: enums::PaymentConnectorCategory::PaymentGateway, +}; + +impl ConnectorSpecifications for Celero { + fn get_connector_about(&self) -> Option<&'static ConnectorInfo> { + Some(&CELERO_CONNECTOR_INFO) + } + + fn get_supported_payment_methods(&self) -> Option<&'static SupportedPaymentMethods> { + Some(&*CELERO_SUPPORTED_PAYMENT_METHODS) + } + + fn get_supported_webhook_flows(&self) -> Option<&'static [enums::EventClass]> { + None + } +} diff --git a/crates/hyperswitch_connectors/src/connectors/celero/transformers.rs b/crates/hyperswitch_connectors/src/connectors/celero/transformers.rs index 2579c81ae6b..76990260923 100644 --- a/crates/hyperswitch_connectors/src/connectors/celero/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/celero/transformers.rs @@ -1,80 +1,260 @@ -use common_enums::enums; -use common_utils::types::StringMinorUnit; +use common_enums::{enums, Currency}; +use common_utils::{pii::Email, types::MinorUnit}; use hyperswitch_domain_models::{ + address::Address as DomainAddress, payment_method_data::PaymentMethodData, - router_data::{ConnectorAuthType, RouterData}, - router_flow_types::refunds::{Execute, RSync}, - router_request_types::ResponseId, + router_data::{ + AdditionalPaymentMethodConnectorResponse, ConnectorAuthType, ConnectorResponseData, + RouterData, + }, + router_flow_types::{ + payments::Capture, + refunds::{Execute, RSync}, + }, + router_request_types::{PaymentsCaptureData, ResponseId}, router_response_types::{PaymentsResponseData, RefundsResponseData}, - types::{PaymentsAuthorizeRouterData, RefundsRouterData}, + types::{ + PaymentsAuthorizeRouterData, PaymentsCaptureRouterData, PaymentsSyncRouterData, + RefundSyncRouterData, RefundsRouterData, + }, }; -use hyperswitch_interfaces::errors; -use masking::Secret; +use hyperswitch_interfaces::{consts, errors}; +use masking::{PeekInterface, Secret}; use serde::{Deserialize, Serialize}; use crate::{ types::{RefundsResponseRouterData, ResponseRouterData}, - utils::PaymentsAuthorizeRequestData, + utils::{ + AddressDetailsData, PaymentsAuthorizeRequestData, RefundsRequestData, RouterData as _, + }, }; //TODO: Fill the struct with respective fields pub struct CeleroRouterData<T> { - pub amount: StringMinorUnit, // The type of amount that a connector accepts, for example, String, i64, f64, etc. + pub amount: MinorUnit, // CeleroCommerce expects integer cents pub router_data: T, } -impl<T> From<(StringMinorUnit, T)> for CeleroRouterData<T> { - fn from((amount, item): (StringMinorUnit, T)) -> Self { - //Todo : use utils to convert the amount to the type of amount that a connector accepts - Self { +impl<T> TryFrom<(MinorUnit, T)> for CeleroRouterData<T> { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from((amount, item): (MinorUnit, T)) -> Result<Self, Self::Error> { + Ok(Self { amount, router_data: item, - } + }) } } +// CeleroCommerce Search Request for sync operations - POST /api/transaction/search +#[derive(Debug, Serialize, PartialEq)] +pub struct CeleroSearchRequest { + transaction_id: String, +} -//TODO: Fill the struct with respective fields -#[derive(Default, Debug, Serialize, PartialEq)] +impl TryFrom<&PaymentsSyncRouterData> for CeleroSearchRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from(item: &PaymentsSyncRouterData) -> Result<Self, Self::Error> { + let transaction_id = match &item.request.connector_transaction_id { + ResponseId::ConnectorTransactionId(id) => id.clone(), + _ => { + return Err(errors::ConnectorError::MissingConnectorTransactionID.into()); + } + }; + Ok(Self { transaction_id }) + } +} + +impl TryFrom<&RefundSyncRouterData> for CeleroSearchRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from(item: &RefundSyncRouterData) -> Result<Self, Self::Error> { + Ok(Self { + transaction_id: item.request.get_connector_refund_id()?, + }) + } +} + +// CeleroCommerce Payment Request according to API specs +#[derive(Debug, Serialize, PartialEq)] pub struct CeleroPaymentsRequest { - amount: StringMinorUnit, - card: CeleroCard, + idempotency_key: String, + #[serde(rename = "type")] + transaction_type: TransactionType, + amount: MinorUnit, // CeleroCommerce expects integer cents + currency: Currency, + payment_method: CeleroPaymentMethod, + #[serde(skip_serializing_if = "Option::is_none")] + billing_address: Option<CeleroAddress>, + #[serde(skip_serializing_if = "Option::is_none")] + shipping_address: Option<CeleroAddress>, + #[serde(skip_serializing_if = "Option::is_none")] + create_vault_record: Option<bool>, +} + +#[derive(Debug, Serialize, PartialEq)] +pub struct CeleroAddress { + first_name: Option<Secret<String>>, + last_name: Option<Secret<String>>, + address_line_1: Option<Secret<String>>, + address_line_2: Option<Secret<String>>, + city: Option<String>, + state: Option<Secret<String>>, + postal_code: Option<Secret<String>>, + country: Option<common_enums::CountryAlpha2>, + phone: Option<Secret<String>>, + email: Option<Email>, } -#[derive(Default, Debug, Serialize, Eq, PartialEq)] +impl TryFrom<&DomainAddress> for CeleroAddress { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from(address: &DomainAddress) -> Result<Self, Self::Error> { + let address_details = address.address.as_ref(); + match address_details { + Some(address_details) => Ok(Self { + first_name: address_details.get_optional_first_name(), + last_name: address_details.get_optional_last_name(), + address_line_1: address_details.get_optional_line1(), + address_line_2: address_details.get_optional_line2(), + city: address_details.get_optional_city(), + state: address_details.get_optional_state(), + postal_code: address_details.get_optional_zip(), + country: address_details.get_optional_country(), + phone: address + .phone + .as_ref() + .and_then(|phone| phone.number.clone()), + email: address.email.clone(), + }), + None => Err(errors::ConnectorError::MissingRequiredField { + field_name: "address_details", + } + .into()), + } + } +} + +#[derive(Debug, Serialize, PartialEq)] +#[serde(rename_all = "lowercase")] +pub enum CeleroPaymentMethod { + Card(CeleroCard), +} + +#[derive(Debug, Serialize, PartialEq, Clone, Copy)] +#[serde(rename_all = "lowercase")] +pub enum CeleroEntryType { + Keyed, +} + +#[derive(Debug, Serialize, PartialEq)] pub struct CeleroCard { + entry_type: CeleroEntryType, number: cards::CardNumber, - expiry_month: Secret<String>, - expiry_year: Secret<String>, + expiration_date: Secret<String>, cvc: Secret<String>, - complete: bool, } -impl TryFrom<&CeleroRouterData<&PaymentsAuthorizeRouterData>> for CeleroPaymentsRequest { +impl TryFrom<&PaymentMethodData> for CeleroPaymentMethod { type Error = error_stack::Report<errors::ConnectorError>; - fn try_from( - item: &CeleroRouterData<&PaymentsAuthorizeRouterData>, - ) -> Result<Self, Self::Error> { - match item.router_data.request.payment_method_data.clone() { + fn try_from(item: &PaymentMethodData) -> Result<Self, Self::Error> { + match item { PaymentMethodData::Card(req_card) => { let card = CeleroCard { - number: req_card.card_number, - expiry_month: req_card.card_exp_month, - expiry_year: req_card.card_exp_year, - cvc: req_card.card_cvc, - complete: item.router_data.request.is_auto_capture()?, + entry_type: CeleroEntryType::Keyed, + number: req_card.card_number.clone(), + expiration_date: Secret::new(format!( + "{}/{}", + req_card.card_exp_month.peek(), + req_card.card_exp_year.peek() + )), + cvc: req_card.card_cvc.clone(), }; - Ok(Self { - amount: item.amount.clone(), - card, - }) + Ok(Self::Card(card)) } - _ => Err(errors::ConnectorError::NotImplemented("Payment method".to_string()).into()), + PaymentMethodData::CardDetailsForNetworkTransactionId(_) + | PaymentMethodData::CardRedirect(_) + | PaymentMethodData::Wallet(_) + | PaymentMethodData::PayLater(_) + | PaymentMethodData::BankRedirect(_) + | PaymentMethodData::BankDebit(_) + | PaymentMethodData::BankTransfer(_) + | PaymentMethodData::Crypto(_) + | PaymentMethodData::MandatePayment + | PaymentMethodData::Reward + | PaymentMethodData::RealTimePayment(_) + | PaymentMethodData::Upi(_) + | PaymentMethodData::Voucher(_) + | PaymentMethodData::GiftCard(_) + | PaymentMethodData::CardToken(_) + | PaymentMethodData::OpenBanking(_) + | PaymentMethodData::NetworkToken(_) + | PaymentMethodData::MobilePayment(_) => Err(errors::ConnectorError::NotImplemented( + "Selected payment method through celero".to_string(), + ) + .into()), } } } -//TODO: Fill the struct with respective fields -// Auth Struct +// Implementation for handling 3DS specifically +impl TryFrom<(&PaymentMethodData, bool)> for CeleroPaymentMethod { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from((item, is_three_ds): (&PaymentMethodData, bool)) -> Result<Self, Self::Error> { + // If 3DS is requested, return an error + if is_three_ds { + return Err(errors::ConnectorError::NotSupported { + message: "Cards 3DS".to_string(), + connector: "celero", + } + .into()); + } + + // Otherwise, delegate to the standard implementation + Self::try_from(item) + } +} + +impl TryFrom<&CeleroRouterData<&PaymentsAuthorizeRouterData>> for CeleroPaymentsRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: &CeleroRouterData<&PaymentsAuthorizeRouterData>, + ) -> Result<Self, Self::Error> { + let is_auto_capture = item.router_data.request.is_auto_capture()?; + let transaction_type = if is_auto_capture { + TransactionType::Sale + } else { + TransactionType::Authorize + }; + + let billing_address: Option<CeleroAddress> = item + .router_data + .get_optional_billing() + .and_then(|address| address.try_into().ok()); + + let shipping_address: Option<CeleroAddress> = item + .router_data + .get_optional_shipping() + .and_then(|address| address.try_into().ok()); + + // Check if 3DS is requested + let is_three_ds = item.router_data.is_three_ds(); + + let request = Self { + idempotency_key: item.router_data.connector_request_reference_id.clone(), + transaction_type, + amount: item.amount, + currency: item.router_data.request.currency, + payment_method: CeleroPaymentMethod::try_from(( + &item.router_data.request.payment_method_data, + is_three_ds, + ))?, + billing_address, + shipping_address, + create_vault_record: Some(false), + }; + + Ok(request) + } +} + +// Auth Struct for CeleroCommerce API key authentication pub struct CeleroAuthType { pub(super) api_key: Secret<String>, } @@ -84,38 +264,100 @@ impl TryFrom<&ConnectorAuthType> for CeleroAuthType { 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(), + api_key: api_key.clone(), }), _ => Err(errors::ConnectorError::FailedToObtainAuthType.into()), } } } -// PaymentsResponse -//TODO: Append the remaining status flags -#[derive(Debug, Clone, Default, Serialize, Deserialize, PartialEq)] -#[serde(rename_all = "lowercase")] -pub enum CeleroPaymentStatus { - Succeeded, - Failed, - #[default] - Processing, +// CeleroCommerce API Response Structures +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +pub enum CeleroResponseStatus { + #[serde(alias = "success", alias = "Success", alias = "SUCCESS")] + Success, + #[serde(alias = "error", alias = "Error", alias = "ERROR")] + Error, } -impl From<CeleroPaymentStatus> for common_enums::AttemptStatus { - fn from(item: CeleroPaymentStatus) -> Self { +#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "snake_case")] +pub enum CeleroTransactionStatus { + Approved, + Declined, + Error, + Pending, + PendingSettlement, + Settled, + Voided, + Reversed, +} + +impl From<CeleroTransactionStatus> for common_enums::AttemptStatus { + fn from(item: CeleroTransactionStatus) -> Self { match item { - CeleroPaymentStatus::Succeeded => Self::Charged, - CeleroPaymentStatus::Failed => Self::Failure, - CeleroPaymentStatus::Processing => Self::Authorizing, + CeleroTransactionStatus::Approved => Self::Authorized, + CeleroTransactionStatus::Settled => Self::Charged, + CeleroTransactionStatus::Declined | CeleroTransactionStatus::Error => Self::Failure, + CeleroTransactionStatus::Pending | CeleroTransactionStatus::PendingSettlement => { + Self::Pending + } + CeleroTransactionStatus::Voided | CeleroTransactionStatus::Reversed => Self::Voided, } } } +#[serde_with::skip_serializing_none] +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +pub struct CeleroCardResponse { + pub status: CeleroTransactionStatus, + pub auth_code: Option<String>, + pub processor_response_code: Option<String>, + pub avs_response_code: Option<String>, +} -//TODO: Fill the struct with respective fields -#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "lowercase")] +pub enum CeleroPaymentMethodResponse { + Card(CeleroCardResponse), +} + +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "lowercase")] +pub enum TransactionType { + Sale, + Authorize, +} +#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)] +#[serde_with::skip_serializing_none] +pub struct CeleroTransactionResponseData { + pub id: String, + #[serde(rename = "type")] + pub transaction_type: TransactionType, + pub amount: i64, + pub currency: String, + pub response: CeleroPaymentMethodResponse, + pub billing_address: Option<CeleroAddressResponse>, + pub shipping_address: Option<CeleroAddressResponse>, +} + +#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)] +pub struct CeleroAddressResponse { + first_name: Option<Secret<String>>, + last_name: Option<Secret<String>>, + address_line_1: Option<Secret<String>>, + address_line_2: Option<Secret<String>>, + city: Option<String>, + state: Option<Secret<String>>, + postal_code: Option<Secret<String>>, + country: Option<common_enums::CountryAlpha2>, + phone: Option<Secret<String>>, + email: Option<Secret<String>>, +} + +#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)] pub struct CeleroPaymentsResponse { - status: CeleroPaymentStatus, - id: String, + pub status: CeleroResponseStatus, + pub msg: String, + pub data: Option<CeleroTransactionResponseData>, } impl<F, T> TryFrom<ResponseRouterData<F, CeleroPaymentsResponse, T, PaymentsResponseData>> @@ -125,104 +367,508 @@ impl<F, T> TryFrom<ResponseRouterData<F, CeleroPaymentsResponse, T, PaymentsResp fn try_from( item: ResponseRouterData<F, CeleroPaymentsResponse, T, PaymentsResponseData>, ) -> Result<Self, Self::Error> { - Ok(Self { - status: common_enums::AttemptStatus::from(item.response.status), - response: Ok(PaymentsResponseData::TransactionResponse { - resource_id: ResponseId::ConnectorTransactionId(item.response.id), - redirection_data: Box::new(None), - mandate_reference: Box::new(None), - connector_metadata: None, - network_txn_id: None, - connector_response_reference_id: None, - incremental_authorization_allowed: None, - charges: None, - }), - ..item.data - }) + match item.response.status { + CeleroResponseStatus::Success => { + if let Some(data) = item.response.data { + let CeleroPaymentMethodResponse::Card(response) = &data.response; + // Check if transaction itself failed despite successful API call + match response.status { + CeleroTransactionStatus::Declined | CeleroTransactionStatus::Error => { + // Transaction failed - create error response with transaction details + let error_details = CeleroErrorDetails::from_transaction_response( + response, + item.response.msg, + ); + + Ok(Self { + status: common_enums::AttemptStatus::Failure, + response: Err( + hyperswitch_domain_models::router_data::ErrorResponse { + code: error_details + .error_code + .unwrap_or_else(|| "TRANSACTION_FAILED".to_string()), + message: error_details.error_message, + reason: error_details.decline_reason, + status_code: item.http_code, + attempt_status: None, + connector_transaction_id: Some(data.id), + network_decline_code: None, + network_advice_code: None, + network_error_message: None, + connector_metadata: None, + }, + ), + ..item.data + }) + } + _ => { + let connector_response_data = + convert_to_additional_payment_method_connector_response( + response.avs_response_code.clone(), + ) + .map(ConnectorResponseData::with_additional_payment_method_data); + let final_status: enums::AttemptStatus = response.status.into(); + Ok(Self { + status: final_status, + response: Ok(PaymentsResponseData::TransactionResponse { + resource_id: ResponseId::ConnectorTransactionId(data.id), + redirection_data: Box::new(None), + mandate_reference: Box::new(None), + connector_metadata: None, + network_txn_id: None, + connector_response_reference_id: response.auth_code.clone(), + incremental_authorization_allowed: None, + charges: None, + }), + connector_response: connector_response_data, + ..item.data + }) + } + } + } else { + // No transaction data in successful response + Ok(Self { + status: common_enums::AttemptStatus::Failure, + response: Err(hyperswitch_domain_models::router_data::ErrorResponse { + code: "MISSING_DATA".to_string(), + message: "No transaction data in response".to_string(), + reason: Some(item.response.msg), + status_code: item.http_code, + attempt_status: None, + connector_transaction_id: None, + network_decline_code: None, + network_advice_code: None, + network_error_message: None, + connector_metadata: None, + }), + ..item.data + }) + } + } + CeleroResponseStatus::Error => { + // Top-level API error + let error_details = + CeleroErrorDetails::from_top_level_error(item.response.msg.clone()); + + Ok(Self { + status: common_enums::AttemptStatus::Failure, + response: Err(hyperswitch_domain_models::router_data::ErrorResponse { + code: error_details + .error_code + .unwrap_or_else(|| "API_ERROR".to_string()), + message: error_details.error_message, + reason: error_details.decline_reason, + status_code: item.http_code, + attempt_status: None, + connector_transaction_id: None, + network_decline_code: None, + network_advice_code: None, + network_error_message: None, + connector_metadata: None, + }), + ..item.data + }) + } + } } } -//TODO: Fill the struct with respective fields -// REFUND : -// Type definition for RefundRequest +// CAPTURE: +// Type definition for CaptureRequest #[derive(Default, Debug, Serialize)] -pub struct CeleroRefundRequest { - pub amount: StringMinorUnit, +pub struct CeleroCaptureRequest { + pub amount: MinorUnit, + #[serde(skip_serializing_if = "Option::is_none")] + pub order_id: Option<String>, } -impl<F> TryFrom<&CeleroRouterData<&RefundsRouterData<F>>> for CeleroRefundRequest { +impl TryFrom<&CeleroRouterData<&PaymentsCaptureRouterData>> for CeleroCaptureRequest { type Error = error_stack::Report<errors::ConnectorError>; - fn try_from(item: &CeleroRouterData<&RefundsRouterData<F>>) -> Result<Self, Self::Error> { + fn try_from(item: &CeleroRouterData<&PaymentsCaptureRouterData>) -> Result<Self, Self::Error> { Ok(Self { - amount: item.amount.to_owned(), + amount: item.amount, + order_id: Some(item.router_data.payment_id.clone()), }) } } -// Type definition for Refund Response - -#[allow(dead_code)] -#[derive(Debug, Serialize, Default, Deserialize, Clone)] -pub enum RefundStatus { - Succeeded, - Failed, - #[default] - Processing, +// CeleroCommerce Capture Response +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +pub struct CeleroCaptureResponse { + pub status: CeleroResponseStatus, + pub msg: Option<String>, + pub data: Option<serde_json::Value>, // Usually null for capture responses } -impl From<RefundStatus> for enums::RefundStatus { - fn from(item: RefundStatus) -> Self { - match item { - RefundStatus::Succeeded => Self::Success, - RefundStatus::Failed => Self::Failure, - RefundStatus::Processing => Self::Pending, - //TODO: Review mapping +impl + TryFrom< + ResponseRouterData< + Capture, + CeleroCaptureResponse, + PaymentsCaptureData, + PaymentsResponseData, + >, + > for RouterData<Capture, PaymentsCaptureData, PaymentsResponseData> +{ + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: ResponseRouterData< + Capture, + CeleroCaptureResponse, + PaymentsCaptureData, + PaymentsResponseData, + >, + ) -> Result<Self, Self::Error> { + match item.response.status { + CeleroResponseStatus::Success => Ok(Self { + status: common_enums::AttemptStatus::Charged, + response: Ok(PaymentsResponseData::TransactionResponse { + resource_id: ResponseId::ConnectorTransactionId( + item.data.request.connector_transaction_id.clone(), + ), + redirection_data: Box::new(None), + mandate_reference: Box::new(None), + connector_metadata: None, + network_txn_id: None, + connector_response_reference_id: None, + incremental_authorization_allowed: None, + charges: None, + }), + ..item.data + }), + CeleroResponseStatus::Error => Ok(Self { + status: common_enums::AttemptStatus::Failure, + response: Err(hyperswitch_domain_models::router_data::ErrorResponse { + code: "CAPTURE_FAILED".to_string(), + message: item + .response + .msg + .clone() + .unwrap_or(consts::NO_ERROR_MESSAGE.to_string()), + reason: None, + status_code: item.http_code, + attempt_status: None, + connector_transaction_id: Some( + item.data.request.connector_transaction_id.clone(), + ), + network_decline_code: None, + network_advice_code: None, + network_error_message: None, + connector_metadata: None, + }), + ..item.data + }), } } } -//TODO: Fill the struct with respective fields -#[derive(Default, Debug, Clone, Serialize, Deserialize)] -pub struct RefundResponse { - id: String, - status: RefundStatus, +// CeleroCommerce Void Response - matches API spec format +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +pub struct CeleroVoidResponse { + pub status: CeleroResponseStatus, + pub msg: String, + pub data: Option<serde_json::Value>, // Usually null for void responses } -impl TryFrom<RefundsResponseRouterData<Execute, RefundResponse>> for RefundsRouterData<Execute> { +impl + TryFrom< + ResponseRouterData< + hyperswitch_domain_models::router_flow_types::payments::Void, + CeleroVoidResponse, + hyperswitch_domain_models::router_request_types::PaymentsCancelData, + PaymentsResponseData, + >, + > + for RouterData< + hyperswitch_domain_models::router_flow_types::payments::Void, + hyperswitch_domain_models::router_request_types::PaymentsCancelData, + PaymentsResponseData, + > +{ type Error = error_stack::Report<errors::ConnectorError>; fn try_from( - item: RefundsResponseRouterData<Execute, RefundResponse>, + item: ResponseRouterData< + hyperswitch_domain_models::router_flow_types::payments::Void, + CeleroVoidResponse, + hyperswitch_domain_models::router_request_types::PaymentsCancelData, + PaymentsResponseData, + >, ) -> Result<Self, Self::Error> { - Ok(Self { - response: Ok(RefundsResponseData { - connector_refund_id: item.response.id.to_string(), - refund_status: enums::RefundStatus::from(item.response.status), + match item.response.status { + CeleroResponseStatus::Success => Ok(Self { + status: common_enums::AttemptStatus::Voided, + response: Ok(PaymentsResponseData::TransactionResponse { + resource_id: ResponseId::ConnectorTransactionId( + item.data.request.connector_transaction_id.clone(), + ), + redirection_data: Box::new(None), + mandate_reference: Box::new(None), + connector_metadata: None, + network_txn_id: None, + connector_response_reference_id: None, + incremental_authorization_allowed: None, + charges: None, + }), + ..item.data + }), + CeleroResponseStatus::Error => Ok(Self { + status: common_enums::AttemptStatus::Failure, + response: Err(hyperswitch_domain_models::router_data::ErrorResponse { + code: "VOID_FAILED".to_string(), + message: item.response.msg.clone(), + reason: Some(item.response.msg), + status_code: item.http_code, + attempt_status: None, + connector_transaction_id: Some( + item.data.request.connector_transaction_id.clone(), + ), + network_decline_code: None, + network_advice_code: None, + network_error_message: None, + connector_metadata: None, + }), + ..item.data }), - ..item.data + } + } +} +#[derive(Default, Debug, Serialize)] +pub struct CeleroRefundRequest { + pub amount: MinorUnit, + pub surcharge: MinorUnit, // Required field as per API specification +} + +impl<F> TryFrom<&CeleroRouterData<&RefundsRouterData<F>>> for CeleroRefundRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from(item: &CeleroRouterData<&RefundsRouterData<F>>) -> Result<Self, Self::Error> { + Ok(Self { + amount: item.amount, + surcharge: MinorUnit::zero(), // Default to 0 as per API specification }) } } -impl TryFrom<RefundsResponseRouterData<RSync, RefundResponse>> for RefundsRouterData<RSync> { +// CeleroCommerce Refund Response - matches API spec format +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +pub struct CeleroRefundResponse { + pub status: CeleroResponseStatus, + pub msg: String, + pub data: Option<serde_json::Value>, // Usually null for refund responses +} + +impl TryFrom<RefundsResponseRouterData<Execute, CeleroRefundResponse>> + for RefundsRouterData<Execute> +{ type Error = error_stack::Report<errors::ConnectorError>; fn try_from( - item: RefundsResponseRouterData<RSync, RefundResponse>, + item: RefundsResponseRouterData<Execute, CeleroRefundResponse>, ) -> Result<Self, Self::Error> { - Ok(Self { - response: Ok(RefundsResponseData { - connector_refund_id: item.response.id.to_string(), - refund_status: enums::RefundStatus::from(item.response.status), + match item.response.status { + CeleroResponseStatus::Success => Ok(Self { + response: Ok(RefundsResponseData { + connector_refund_id: item.data.request.refund_id.clone(), + refund_status: enums::RefundStatus::Success, + }), + ..item.data }), - ..item.data - }) + CeleroResponseStatus::Error => Ok(Self { + response: Err(hyperswitch_domain_models::router_data::ErrorResponse { + code: "REFUND_FAILED".to_string(), + message: item.response.msg.clone(), + reason: Some(item.response.msg), + status_code: item.http_code, + attempt_status: None, + connector_transaction_id: Some( + item.data.request.connector_transaction_id.clone(), + ), + network_decline_code: None, + network_advice_code: None, + network_error_message: None, + connector_metadata: None, + }), + ..item.data + }), + } } } -//TODO: Fill the struct with respective fields -#[derive(Default, Debug, Serialize, Deserialize, PartialEq)] +impl TryFrom<RefundsResponseRouterData<RSync, CeleroRefundResponse>> for RefundsRouterData<RSync> { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: RefundsResponseRouterData<RSync, CeleroRefundResponse>, + ) -> Result<Self, Self::Error> { + match item.response.status { + CeleroResponseStatus::Success => Ok(Self { + response: Ok(RefundsResponseData { + connector_refund_id: item.data.request.refund_id.clone(), + refund_status: enums::RefundStatus::Success, + }), + ..item.data + }), + CeleroResponseStatus::Error => Ok(Self { + response: Err(hyperswitch_domain_models::router_data::ErrorResponse { + code: "REFUND_SYNC_FAILED".to_string(), + message: item.response.msg.clone(), + reason: Some(item.response.msg), + status_code: item.http_code, + attempt_status: None, + connector_transaction_id: Some( + item.data.request.connector_transaction_id.clone(), + ), + network_decline_code: None, + network_advice_code: None, + network_error_message: None, + connector_metadata: None, + }), + ..item.data + }), + } + } +} + +// CeleroCommerce Error Response Structures + +// Main error response structure - matches API spec format +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] pub struct CeleroErrorResponse { - pub status_code: u16, - pub code: String, - pub message: String, - pub reason: Option<String>, + pub status: CeleroResponseStatus, + pub msg: String, + #[serde(skip_serializing_if = "Option::is_none")] + pub data: Option<serde_json::Value>, +} + +// Error details that can be extracted from various response fields +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +pub struct CeleroErrorDetails { + pub error_code: Option<String>, + pub error_message: String, + pub processor_response_code: Option<String>, + pub decline_reason: Option<String>, +} + +impl From<CeleroErrorResponse> for CeleroErrorDetails { + fn from(error_response: CeleroErrorResponse) -> Self { + Self { + error_code: Some("API_ERROR".to_string()), + error_message: error_response.msg, + processor_response_code: None, + decline_reason: None, + } + } +} + +// Function to extract error details from transaction response data +impl CeleroErrorDetails { + pub fn from_transaction_response(response: &CeleroCardResponse, msg: String) -> Self { + // Map specific error codes based on common response patterns + let decline_reason = Self::map_processor_error(&response.processor_response_code, &msg); + + Self { + error_code: None, + error_message: msg, + processor_response_code: response.processor_response_code.clone(), + decline_reason, + } + } + + pub fn from_top_level_error(msg: String) -> Self { + // Map specific error codes from top-level API errors + + Self { + error_code: None, + error_message: msg, + processor_response_code: None, + decline_reason: None, + } + } + + /// Map processor response codes and messages to specific Hyperswitch error codes + fn map_processor_error(processor_code: &Option<String>, message: &str) -> Option<String> { + let message_lower = message.to_lowercase(); + // Check processor response codes if available + if let Some(code) = processor_code { + match code.as_str() { + "05" => Some("TRANSACTION_DECLINED".to_string()), + "14" => Some("INVALID_CARD_DATA".to_string()), + "51" => Some("INSUFFICIENT_FUNDS".to_string()), + "54" => Some("EXPIRED_CARD".to_string()), + "55" => Some("INCORRECT_CVC".to_string()), + "61" => Some("Exceeds withdrawal amount limit".to_string()), + "62" => Some("TRANSACTION_DECLINED".to_string()), + "65" => Some("Exceeds withdrawal frequency limit".to_string()), + "78" => Some("INVALID_CARD_DATA".to_string()), + "91" => Some("PROCESSING_ERROR".to_string()), + "96" => Some("PROCESSING_ERROR".to_string()), + _ => { + router_env::logger::info!( + "Celero response error code ({:?}) is not mapped to any error state ", + code + ); + Some("Transaction failed".to_string()) + } + } + } else { + Some(message_lower) + } + } +} + +pub fn get_avs_definition(code: &str) -> Option<&'static str> { + match code { + "0" => Some("AVS Not Available"), + "A" => Some("Address match only"), + "B" => Some("Address matches, ZIP not verified"), + "C" => Some("Incompatible format"), + "D" => Some("Exact match"), + "F" => Some("Exact match, UK-issued cards"), + "G" => Some("Non-U.S. Issuer does not participate"), + "I" => Some("Not verified"), + "M" => Some("Exact match"), + "N" => Some("No address or ZIP match"), + "P" => Some("Postal Code match"), + "R" => Some("Issuer system unavailable"), + "S" => Some("Service not supported"), + "U" => Some("Address unavailable"), + "W" => Some("9-character numeric ZIP match only"), + "X" => Some("Exact match, 9-character numeric ZIP"), + "Y" => Some("Exact match, 5-character numeric ZIP"), + "Z" => Some("5-character ZIP match only"), + "L" => Some("Partial match, Name and billing postal code match"), + "1" => Some("Cardholder name and ZIP match"), + "2" => Some("Cardholder name, address and ZIP match"), + "3" => Some("Cardholder name and address match"), + "4" => Some("Cardholder name matches"), + "5" => Some("Cardholder name incorrect, ZIP matches"), + "6" => Some("Cardholder name incorrect, address and zip match"), + "7" => Some("Cardholder name incorrect, address matches"), + "8" => Some("Cardholder name, address, and ZIP do not match"), + _ => { + router_env::logger::info!( + "Celero avs response code ({:?}) is not mapped to any defination.", + code + ); + + None + } // No definition found for the given code + } +} +fn convert_to_additional_payment_method_connector_response( + response_code: Option<String>, +) -> Option<AdditionalPaymentMethodConnectorResponse> { + match response_code { + None => None, + Some(code) => { + let description = get_avs_definition(&code); + let payment_checks = serde_json::json!({ + "avs_result_code": code, + "description": description + }); + Some(AdditionalPaymentMethodConnectorResponse::Card { + authentication_data: None, + payment_checks: Some(payment_checks), + card_network: None, + domestic_network: None, + }) + } + } } diff --git a/crates/payment_methods/src/configs/payment_connector_required_fields.rs b/crates/payment_methods/src/configs/payment_connector_required_fields.rs index 5ce306c5976..15a4ef90a95 100644 --- a/crates/payment_methods/src/configs/payment_connector_required_fields.rs +++ b/crates/payment_methods/src/configs/payment_connector_required_fields.rs @@ -1305,6 +1305,7 @@ fn get_cards_required_fields() -> HashMap<Connector, RequiredFieldFinal> { ), (Connector::Boku, fields(vec![], vec![], card_basic())), (Connector::Braintree, fields(vec![], vec![], card_basic())), + (Connector::Celero, fields(vec![], vec![], card_basic())), (Connector::Checkout, fields(vec![], card_basic(), vec![])), ( Connector::Coinbase,

2025-07-08T05:02:05Z

## Type of Change  - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  Integrate celero commerce connector Doc : https://sandbox.gotnpgateway.com/docs/api/transactions [x] Cards [x] Avs ### Additional Changes - [x] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  MOCK SERVER results <img width="803" height="920" alt="Screenshot 2025-08-05 at 11 37 29 AM" src="https://github.com/user-attachments/assets/19bee0c6-f0e4-4123-b423-b959c229899b" /> <img width="560" height="926" alt="Screenshot 2025-08-05 at 11 37 38 AM" src="https://github.com/user-attachments/assets/2e9c08e7-aba4-4799-b3b5-4a0f3df9360e" /> <img width="930" height="1001" alt="Screenshot 2025-08-05 at 11 37 54 AM" src="https://github.com/user-attachments/assets/e8b202e1-a5a0-4afe-8574-93944b61d816" /> ![Uploading Screenshot 2025-08-06 at 3.00.16 PM.png…]() ## Motivation and Context  https://github.com/juspay/hyperswitch/issues/8575 ## How did you test it?  No creds for testing ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [x] I added unit tests for my changes where possible

v1.116.0

a56d78a46a3ee80cdb2b48f9abfd2cd7b297e328

juspay/hyperswitch

juspay__hyperswitch-8556

Bug: [FEATURE] Add auto retries configs in profile CRUD apis ### Feature Description Add auto retries configs in profile CRUD apis 1. is_auto_retries_enabled - Boolean (denotes whether auto retries should be performed for a profile) 2. max_auto_retries_enabled - Int (i16) (maximum auto retries to be performed) ### Possible Implementation Create two new fields in Profile Create, Update APIs and then send them back in the Profile Response

diff --git a/api-reference/openapi_spec.json b/api-reference/openapi_spec.json index dfcaf157c21..50278f2b00f 100644 --- a/api-reference/openapi_spec.json +++ b/api-reference/openapi_spec.json @@ -20944,6 +20944,18 @@ "is_network_tokenization_enabled": { "type": "boolean", "description": "Indicates if is_network_tokenization_enabled is enabled or not.\nIf set to `true` is_network_tokenization_enabled will be checked." + }, + "is_auto_retries_enabled": { + "type": "boolean", + "description": "Indicates if is_auto_retries_enabled is enabled or not.", + "nullable": true + }, + "max_auto_retries_enabled": { + "type": "integer", + "format": "int32", + "description": "Maximum number of auto retries allowed for a payment", + "nullable": true, + "minimum": 0 } }, "additionalProperties": false @@ -20975,7 +20987,8 @@ "enable_payment_response_hash", "redirect_to_merchant_with_http_post", "is_tax_connector_enabled", - "is_network_tokenization_enabled" + "is_network_tokenization_enabled", + "is_auto_retries_enabled" ], "properties": { "merchant_id": { @@ -21160,6 +21173,18 @@ "description": "Indicates if is_network_tokenization_enabled is enabled or not.\nIf set to `true` is_network_tokenization_enabled will be checked.", "default": false, "example": false + }, + "is_auto_retries_enabled": { + "type": "boolean", + "description": "Indicates if is_auto_retries_enabled is enabled or not.", + "default": false, + "example": false + }, + "max_auto_retries_enabled": { + "type": "integer", + "format": "int32", + "description": "Maximum number of auto retries allowed for a payment", + "nullable": true } } }, diff --git a/crates/api_models/src/admin.rs b/crates/api_models/src/admin.rs index 6f656339569..6e7f4f29d03 100644 --- a/crates/api_models/src/admin.rs +++ b/crates/api_models/src/admin.rs @@ -1971,6 +1971,12 @@ pub struct ProfileCreate { /// If set to `true` is_network_tokenization_enabled will be checked. #[serde(default)] pub is_network_tokenization_enabled: bool, + + /// Indicates if is_auto_retries_enabled is enabled or not. + pub is_auto_retries_enabled: Option<bool>, + + /// Maximum number of auto retries allowed for a payment + pub max_auto_retries_enabled: Option<u8>, } #[nutype::nutype( @@ -2202,6 +2208,13 @@ pub struct ProfileResponse { /// If set to `true` is_network_tokenization_enabled will be checked. #[schema(default = false, example = false)] pub is_network_tokenization_enabled: bool, + + /// Indicates if is_auto_retries_enabled is enabled or not. + #[schema(default = false, example = false)] + pub is_auto_retries_enabled: bool, + + /// Maximum number of auto retries allowed for a payment + pub max_auto_retries_enabled: Option<i16>, } #[cfg(feature = "v2")] @@ -2431,6 +2444,12 @@ pub struct ProfileUpdate { /// Indicates if is_network_tokenization_enabled is enabled or not. pub is_network_tokenization_enabled: Option<bool>, + + /// Indicates if is_auto_retries_enabled is enabled or not. + pub is_auto_retries_enabled: Option<bool>, + + /// Maximum number of auto retries allowed for a payment + pub max_auto_retries_enabled: Option<u8>, } #[cfg(feature = "v2")] diff --git a/crates/diesel_models/src/business_profile.rs b/crates/diesel_models/src/business_profile.rs index 4edc2ba2432..fd0abc16614 100644 --- a/crates/diesel_models/src/business_profile.rs +++ b/crates/diesel_models/src/business_profile.rs @@ -55,6 +55,8 @@ pub struct Profile { pub version: common_enums::ApiVersion, pub dynamic_routing_algorithm: Option<serde_json::Value>, pub is_network_tokenization_enabled: bool, + pub is_auto_retries_enabled: Option<bool>, + pub max_auto_retries_enabled: Option<i16>, } #[cfg(feature = "v1")] @@ -96,6 +98,8 @@ pub struct ProfileNew { pub is_tax_connector_enabled: Option<bool>, pub version: common_enums::ApiVersion, pub is_network_tokenization_enabled: bool, + pub is_auto_retries_enabled: Option<bool>, + pub max_auto_retries_enabled: Option<i16>, } #[cfg(feature = "v1")] @@ -134,6 +138,8 @@ pub struct ProfileUpdateInternal { pub is_tax_connector_enabled: Option<bool>, pub dynamic_routing_algorithm: Option<serde_json::Value>, pub is_network_tokenization_enabled: Option<bool>, + pub is_auto_retries_enabled: Option<bool>, + pub max_auto_retries_enabled: Option<i16>, } #[cfg(feature = "v1")] @@ -171,6 +177,8 @@ impl ProfileUpdateInternal { is_tax_connector_enabled, dynamic_routing_algorithm, is_network_tokenization_enabled, + is_auto_retries_enabled, + max_auto_retries_enabled, } = self; Profile { profile_id: source.profile_id, @@ -228,6 +236,8 @@ impl ProfileUpdateInternal { .or(source.dynamic_routing_algorithm), is_network_tokenization_enabled: is_network_tokenization_enabled .unwrap_or(source.is_network_tokenization_enabled), + is_auto_retries_enabled: is_auto_retries_enabled.or(source.is_auto_retries_enabled), + max_auto_retries_enabled: max_auto_retries_enabled.or(source.max_auto_retries_enabled), } } } @@ -279,6 +289,8 @@ pub struct Profile { pub version: common_enums::ApiVersion, pub dynamic_routing_algorithm: Option<serde_json::Value>, pub is_network_tokenization_enabled: bool, + pub is_auto_retries_enabled: Option<bool>, + pub max_auto_retries_enabled: Option<i16>, } impl Profile { @@ -334,6 +346,8 @@ pub struct ProfileNew { pub id: common_utils::id_type::ProfileId, pub version: common_enums::ApiVersion, pub is_network_tokenization_enabled: bool, + pub is_auto_retries_enabled: Option<bool>, + pub max_auto_retries_enabled: Option<i16>, } #[cfg(feature = "v2")] @@ -373,6 +387,8 @@ pub struct ProfileUpdateInternal { pub payout_routing_algorithm_id: Option<common_utils::id_type::RoutingId>, pub default_fallback_routing: Option<pii::SecretSerdeValue>, pub is_network_tokenization_enabled: Option<bool>, + pub is_auto_retries_enabled: Option<bool>, + pub max_auto_retries_enabled: Option<i16>, } #[cfg(feature = "v2")] @@ -411,6 +427,8 @@ impl ProfileUpdateInternal { payout_routing_algorithm_id, default_fallback_routing, is_network_tokenization_enabled, + is_auto_retries_enabled, + max_auto_retries_enabled, } = self; Profile { id: source.id, @@ -471,6 +489,8 @@ impl ProfileUpdateInternal { dynamic_routing_algorithm: None, is_network_tokenization_enabled: is_network_tokenization_enabled .unwrap_or(source.is_network_tokenization_enabled), + is_auto_retries_enabled: is_auto_retries_enabled.or(source.is_auto_retries_enabled), + max_auto_retries_enabled: max_auto_retries_enabled.or(source.max_auto_retries_enabled), } } } diff --git a/crates/diesel_models/src/schema.rs b/crates/diesel_models/src/schema.rs index 9ff7c958df1..fe22dcd87a3 100644 --- a/crates/diesel_models/src/schema.rs +++ b/crates/diesel_models/src/schema.rs @@ -211,6 +211,8 @@ diesel::table! { version -> ApiVersion, dynamic_routing_algorithm -> Nullable<Json>, is_network_tokenization_enabled -> Bool, + is_auto_retries_enabled -> Nullable<Bool>, + max_auto_retries_enabled -> Nullable<Int2>, } } diff --git a/crates/diesel_models/src/schema_v2.rs b/crates/diesel_models/src/schema_v2.rs index a66286e02db..674123fbaae 100644 --- a/crates/diesel_models/src/schema_v2.rs +++ b/crates/diesel_models/src/schema_v2.rs @@ -218,6 +218,8 @@ diesel::table! { version -> ApiVersion, dynamic_routing_algorithm -> Nullable<Json>, is_network_tokenization_enabled -> Bool, + is_auto_retries_enabled -> Nullable<Bool>, + max_auto_retries_enabled -> Nullable<Int2>, } } diff --git a/crates/hyperswitch_domain_models/src/business_profile.rs b/crates/hyperswitch_domain_models/src/business_profile.rs index 156ca4d2feb..75cdd40024f 100644 --- a/crates/hyperswitch_domain_models/src/business_profile.rs +++ b/crates/hyperswitch_domain_models/src/business_profile.rs @@ -56,6 +56,8 @@ pub struct Profile { pub version: common_enums::ApiVersion, pub dynamic_routing_algorithm: Option<serde_json::Value>, pub is_network_tokenization_enabled: bool, + pub is_auto_retries_enabled: bool, + pub max_auto_retries_enabled: Option<i16>, } #[cfg(feature = "v1")] @@ -94,6 +96,8 @@ pub struct ProfileSetter { pub is_tax_connector_enabled: bool, pub dynamic_routing_algorithm: Option<serde_json::Value>, pub is_network_tokenization_enabled: bool, + pub is_auto_retries_enabled: bool, + pub max_auto_retries_enabled: Option<i16>, } #[cfg(feature = "v1")] @@ -139,6 +143,8 @@ impl From<ProfileSetter> for Profile { version: consts::API_VERSION, dynamic_routing_algorithm: value.dynamic_routing_algorithm, is_network_tokenization_enabled: value.is_network_tokenization_enabled, + is_auto_retries_enabled: value.is_auto_retries_enabled, + max_auto_retries_enabled: value.max_auto_retries_enabled, } } } @@ -186,6 +192,8 @@ pub struct ProfileGeneralUpdate { pub is_tax_connector_enabled: Option<bool>, pub dynamic_routing_algorithm: Option<serde_json::Value>, pub is_network_tokenization_enabled: Option<bool>, + pub is_auto_retries_enabled: Option<bool>, + pub max_auto_retries_enabled: Option<i16>, } #[cfg(feature = "v1")] @@ -246,6 +254,8 @@ impl From<ProfileUpdate> for ProfileUpdateInternal { is_tax_connector_enabled, dynamic_routing_algorithm, is_network_tokenization_enabled, + is_auto_retries_enabled, + max_auto_retries_enabled, } = *update; Self { @@ -281,6 +291,8 @@ impl From<ProfileUpdate> for ProfileUpdateInternal { is_tax_connector_enabled, dynamic_routing_algorithm, is_network_tokenization_enabled, + is_auto_retries_enabled, + max_auto_retries_enabled, } } ProfileUpdate::RoutingAlgorithmUpdate { @@ -318,6 +330,8 @@ impl From<ProfileUpdate> for ProfileUpdateInternal { is_tax_connector_enabled: None, dynamic_routing_algorithm: None, is_network_tokenization_enabled: None, + is_auto_retries_enabled: None, + max_auto_retries_enabled: None, }, ProfileUpdate::DynamicRoutingAlgorithmUpdate { dynamic_routing_algorithm, @@ -353,6 +367,8 @@ impl From<ProfileUpdate> for ProfileUpdateInternal { is_tax_connector_enabled: None, dynamic_routing_algorithm, is_network_tokenization_enabled: None, + is_auto_retries_enabled: None, + max_auto_retries_enabled: None, }, ProfileUpdate::ExtendedCardInfoUpdate { is_extended_card_info_enabled, @@ -388,6 +404,8 @@ impl From<ProfileUpdate> for ProfileUpdateInternal { is_tax_connector_enabled: None, dynamic_routing_algorithm: None, is_network_tokenization_enabled: None, + is_auto_retries_enabled: None, + max_auto_retries_enabled: None, }, ProfileUpdate::ConnectorAgnosticMitUpdate { is_connector_agnostic_mit_enabled, @@ -423,6 +441,8 @@ impl From<ProfileUpdate> for ProfileUpdateInternal { is_tax_connector_enabled: None, dynamic_routing_algorithm: None, is_network_tokenization_enabled: None, + is_auto_retries_enabled: None, + max_auto_retries_enabled: None, }, ProfileUpdate::NetworkTokenizationUpdate { is_network_tokenization_enabled, @@ -458,6 +478,8 @@ impl From<ProfileUpdate> for ProfileUpdateInternal { is_tax_connector_enabled: None, dynamic_routing_algorithm: None, is_network_tokenization_enabled, + is_auto_retries_enabled: None, + max_auto_retries_enabled: None, }, } } @@ -512,6 +534,8 @@ impl super::behaviour::Conversion for Profile { version: self.version, dynamic_routing_algorithm: self.dynamic_routing_algorithm, is_network_tokenization_enabled: self.is_network_tokenization_enabled, + is_auto_retries_enabled: Some(self.is_auto_retries_enabled), + max_auto_retries_enabled: self.max_auto_retries_enabled, }) } @@ -578,6 +602,8 @@ impl super::behaviour::Conversion for Profile { version: item.version, dynamic_routing_algorithm: item.dynamic_routing_algorithm, is_network_tokenization_enabled: item.is_network_tokenization_enabled, + is_auto_retries_enabled: item.is_auto_retries_enabled.unwrap_or(false), + max_auto_retries_enabled: item.max_auto_retries_enabled, }) } .await @@ -628,6 +654,8 @@ impl super::behaviour::Conversion for Profile { is_tax_connector_enabled: Some(self.is_tax_connector_enabled), version: self.version, is_network_tokenization_enabled: self.is_network_tokenization_enabled, + is_auto_retries_enabled: Some(self.is_auto_retries_enabled), + max_auto_retries_enabled: self.max_auto_retries_enabled, }) } } @@ -896,6 +924,8 @@ impl From<ProfileUpdate> for ProfileUpdateInternal { tax_connector_id: None, is_tax_connector_enabled: None, is_network_tokenization_enabled, + is_auto_retries_enabled: None, + max_auto_retries_enabled: None, } } ProfileUpdate::RoutingAlgorithmUpdate { @@ -934,6 +964,8 @@ impl From<ProfileUpdate> for ProfileUpdateInternal { tax_connector_id: None, is_tax_connector_enabled: None, is_network_tokenization_enabled: None, + is_auto_retries_enabled: None, + max_auto_retries_enabled: None, }, ProfileUpdate::ExtendedCardInfoUpdate { is_extended_card_info_enabled, @@ -970,6 +1002,8 @@ impl From<ProfileUpdate> for ProfileUpdateInternal { tax_connector_id: None, is_tax_connector_enabled: None, is_network_tokenization_enabled: None, + is_auto_retries_enabled: None, + max_auto_retries_enabled: None, }, ProfileUpdate::ConnectorAgnosticMitUpdate { is_connector_agnostic_mit_enabled, @@ -1006,6 +1040,8 @@ impl From<ProfileUpdate> for ProfileUpdateInternal { tax_connector_id: None, is_tax_connector_enabled: None, is_network_tokenization_enabled: None, + is_auto_retries_enabled: None, + max_auto_retries_enabled: None, }, ProfileUpdate::DefaultRoutingFallbackUpdate { default_fallback_routing, @@ -1042,6 +1078,8 @@ impl From<ProfileUpdate> for ProfileUpdateInternal { tax_connector_id: None, is_tax_connector_enabled: None, is_network_tokenization_enabled: None, + is_auto_retries_enabled: None, + max_auto_retries_enabled: None, }, ProfileUpdate::NetworkTokenizationUpdate { is_network_tokenization_enabled, @@ -1078,6 +1116,8 @@ impl From<ProfileUpdate> for ProfileUpdateInternal { tax_connector_id: None, is_tax_connector_enabled: None, is_network_tokenization_enabled, + is_auto_retries_enabled: None, + max_auto_retries_enabled: None, }, } } @@ -1134,6 +1174,8 @@ impl super::behaviour::Conversion for Profile { version: self.version, dynamic_routing_algorithm: None, is_network_tokenization_enabled: self.is_network_tokenization_enabled, + is_auto_retries_enabled: None, + max_auto_retries_enabled: None, }) } @@ -1253,6 +1295,8 @@ impl super::behaviour::Conversion for Profile { is_tax_connector_enabled: Some(self.is_tax_connector_enabled), version: self.version, is_network_tokenization_enabled: self.is_network_tokenization_enabled, + is_auto_retries_enabled: None, + max_auto_retries_enabled: None, }) } } diff --git a/crates/router/src/core/admin.rs b/crates/router/src/core/admin.rs index ad9925a241f..d27b6b82fd4 100644 --- a/crates/router/src/core/admin.rs +++ b/crates/router/src/core/admin.rs @@ -3537,6 +3537,8 @@ impl ProfileCreateBridge for api::ProfileCreate { .always_collect_shipping_details_from_wallet_connector, dynamic_routing_algorithm: None, is_network_tokenization_enabled: self.is_network_tokenization_enabled, + is_auto_retries_enabled: self.is_auto_retries_enabled.unwrap_or_default(), + max_auto_retries_enabled: self.max_auto_retries_enabled.map(i16::from), })) } @@ -3884,6 +3886,8 @@ impl ProfileUpdateBridge for api::ProfileUpdate { is_tax_connector_enabled: self.is_tax_connector_enabled, dynamic_routing_algorithm: self.dynamic_routing_algorithm, is_network_tokenization_enabled: self.is_network_tokenization_enabled, + is_auto_retries_enabled: self.is_auto_retries_enabled, + max_auto_retries_enabled: self.max_auto_retries_enabled.map(i16::from), }, ))) } diff --git a/crates/router/src/types/api/admin.rs b/crates/router/src/types/api/admin.rs index c7b76d1780a..8d52e5dc11a 100644 --- a/crates/router/src/types/api/admin.rs +++ b/crates/router/src/types/api/admin.rs @@ -168,6 +168,8 @@ impl ForeignTryFrom<domain::Profile> for ProfileResponse { tax_connector_id: item.tax_connector_id, is_tax_connector_enabled: item.is_tax_connector_enabled, is_network_tokenization_enabled: item.is_network_tokenization_enabled, + is_auto_retries_enabled: item.is_auto_retries_enabled, + max_auto_retries_enabled: item.max_auto_retries_enabled, }) } } @@ -353,5 +355,7 @@ pub async fn create_profile_from_merchant_account( is_tax_connector_enabled: request.is_tax_connector_enabled, dynamic_routing_algorithm: None, is_network_tokenization_enabled: request.is_network_tokenization_enabled, + is_auto_retries_enabled: request.is_auto_retries_enabled.unwrap_or_default(), + max_auto_retries_enabled: request.max_auto_retries_enabled.map(i16::from), })) } diff --git a/migrations/2024-09-26-113912_add-auto-retries-configs-in-profile/down.sql b/migrations/2024-09-26-113912_add-auto-retries-configs-in-profile/down.sql new file mode 100644 index 00000000000..3751f25da4b --- /dev/null +++ b/migrations/2024-09-26-113912_add-auto-retries-configs-in-profile/down.sql @@ -0,0 +1,6 @@ +-- This file should undo anything in `up.sql` +-- Drop is_auto_retries_enabled column from business_profile table +ALTER TABLE business_profile DROP COLUMN IF EXISTS is_auto_retries_enabled; + +-- Drop max_auto_retries_enabled column from business_profile table +ALTER TABLE business_profile DROP COLUMN IF EXISTS max_auto_retries_enabled; diff --git a/migrations/2024-09-26-113912_add-auto-retries-configs-in-profile/up.sql b/migrations/2024-09-26-113912_add-auto-retries-configs-in-profile/up.sql new file mode 100644 index 00000000000..05b6a114a31 --- /dev/null +++ b/migrations/2024-09-26-113912_add-auto-retries-configs-in-profile/up.sql @@ -0,0 +1,6 @@ +-- Your SQL goes here +-- Add is_auto_retries_enabled column in business_profile table +ALTER TABLE business_profile ADD COLUMN IF NOT EXISTS is_auto_retries_enabled BOOLEAN; + +-- Add max_auto_retries_enabled column in business_profile table +ALTER TABLE business_profile ADD COLUMN IF NOT EXISTS max_auto_retries_enabled SMALLINT;

2024-09-26T17:43:50Z

## Type of Change  - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  add auto retries configs in profile CRUD apis 1. is_auto_retries_enabled - Boolean (denotes whether auto retries should be performed for a profile) 2. max_auto_retries_enabled - Int (maximum auto retries to be performed) closes - https://github.com/juspay/hyperswitch/issues/8556 ### Additional Changes - [x] This PR modifies the API contract - [x] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  ## How did you test it?  Tested Manually 1. Profile Create ``` curl --location '{{BASE_URL}}/account/{{MERCHANT_ID}}/business_profile' \ --header 'Content-Type: application/json' \ --header 'api-key: {{ADMIN_API_KEY}}' \ --data '{ "is_auto_retries_enabled": true, "max_auto_retries_enabled": 1 }' ``` Response `{ "merchant_id": "merchant_1727371477", "profile_id": "pro_jIc12oz9zLreWO4gJqXZ", "profile_name": "default", "return_url": "https://example.com/success", "enable_payment_response_hash": true, "payment_response_hash_key": "uskD31l0vpyRXItGriQ2FZvyhgNJvY5eo3rpy7mnJ0iqm0ExGMgenVstuaVaTxtI", "redirect_to_merchant_with_http_post": false, "webhook_details": { "webhook_version": "1.0.1", "webhook_username": "ekart_retail", "webhook_password": "password_ekart@123", "webhook_url": "https://eop67yav2axa2pv.m.pipedream.net/", "payment_created_enabled": true, "payment_succeeded_enabled": true, "payment_failed_enabled": true }, "metadata": null, "routing_algorithm": null, "intent_fulfillment_time": 900, "frm_routing_algorithm": null, "payout_routing_algorithm": null, "applepay_verified_domains": null, "session_expiry": 900, "payment_link_config": null, "authentication_connector_details": null, "use_billing_as_payment_method_billing": true, "extended_card_info_config": null, "collect_shipping_details_from_wallet_connector": false, "collect_billing_details_from_wallet_connector": false, "always_collect_shipping_details_from_wallet_connector": false, "always_collect_billing_details_from_wallet_connector": false, "is_connector_agnostic_mit_enabled": false, "payout_link_config": null, "outgoing_webhook_custom_http_headers": null, "tax_connector_id": null, "is_tax_connector_enabled": false, "is_network_tokenization_enabled": false, "is_auto_retries_enabled": true, "max_auto_retries_enabled": 1 }` 2. Profile Update ``` curl --location '{{BASE_URL}}/account/{{MERCHANT_ID}}/business_profile/{{PROFILE_ID}}' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: {{ADMIN_API_KEY}}' \ --data '{ "is_auto_retries_enabled": false, "max_auto_retries_enabled": 2 }' ``` Response: `{ "merchant_id": "merchant_1727371477", "profile_id": "pro_jIc12oz9zLreWO4gJqXZ", "profile_name": "default", "return_url": "https://example.com/success", "enable_payment_response_hash": true, "payment_response_hash_key": "uskD31l0vpyRXItGriQ2FZvyhgNJvY5eo3rpy7mnJ0iqm0ExGMgenVstuaVaTxtI", "redirect_to_merchant_with_http_post": false, "webhook_details": { "webhook_version": "1.0.1", "webhook_username": "ekart_retail", "webhook_password": "password_ekart@123", "webhook_url": "https://eop67yav2axa2pv.m.pipedream.net/", "payment_created_enabled": true, "payment_succeeded_enabled": true, "payment_failed_enabled": true }, "metadata": null, "routing_algorithm": null, "intent_fulfillment_time": 900, "frm_routing_algorithm": null, "payout_routing_algorithm": null, "applepay_verified_domains": null, "session_expiry": 900, "payment_link_config": null, "authentication_connector_details": null, "use_billing_as_payment_method_billing": true, "extended_card_info_config": null, "collect_shipping_details_from_wallet_connector": false, "collect_billing_details_from_wallet_connector": false, "always_collect_shipping_details_from_wallet_connector": false, "always_collect_billing_details_from_wallet_connector": false, "is_connector_agnostic_mit_enabled": false, "payout_link_config": null, "outgoing_webhook_custom_http_headers": null, "tax_connector_id": null, "is_tax_connector_enabled": false, "is_network_tokenization_enabled": false, "is_auto_retries_enabled": false, "max_auto_retries_enabled": 2 }` ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.111.0

5912936f9f2178f002c96e25636b25f532b1ecb2

juspay/hyperswitch

juspay__hyperswitch-8537

Bug: [FEATURE] Multisafe pay : EPS | MBWAY | SOFORT ### Feature Description Integrate EPS | MBWAY | SOFORT for multisafepay ### Possible Implementation integrate payments menthods ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? None

diff --git a/config/deployments/integration_test.toml b/config/deployments/integration_test.toml index 6d5cfb6585a..fcf7f12ec3d 100644 --- a/config/deployments/integration_test.toml +++ b/config/deployments/integration_test.toml @@ -229,12 +229,12 @@ wallet.twint.connector_list = "adyen" wallet.vipps.connector_list = "adyen" bank_redirect.ideal.connector_list = "stripe,adyen,globalpay,multisafepay,nexinets,aci" -bank_redirect.sofort.connector_list = "globalpay,aci" +bank_redirect.sofort.connector_list = "globalpay,aci,multisafepay" bank_redirect.giropay.connector_list = "globalpay,multisafepay,nexinets,aci" bank_redirect.bancontact_card.connector_list="adyen,stripe" bank_redirect.trustly.connector_list="adyen,aci" bank_redirect.open_banking_uk.connector_list="adyen" -bank_redirect.eps.connector_list="globalpay,nexinets,aci" +bank_redirect.eps.connector_list="globalpay,nexinets,aci,multisafepay" [mandates.update_mandate_supported] card.credit = { connector_list = "cybersource" } # Update Mandate supported payment method type and connector for card @@ -548,6 +548,9 @@ klarna = { country = "AT,BE,DK,FI,FR,DE,IT,NL,NO,PT,ES,SE,GB", currency = "DKK,E trustly = { country = "AT,CZ,DK,EE,FI,DE,LV,LT,NL,NO,PL,PT,ES,SE,GB" , currency = "EUR,GBP,SEK"} ali_pay = {currency = "EUR,USD"} we_chat_pay = { currency = "EUR"} +eps = { country = "AT" , currency = "EUR" } +mb_way = { country = "PT" , currency = "EUR" } +sofort = { country = "AT,BE,FR,DE,IT,PL,ES,CH,GB" , currency = "EUR"} [pm_filters.cashtocode] classic = { country = "AF,AX,AL,DZ,AS,AD,AO,AI,AQ,AG,AR,AM,AW,AU,AT,AZ,BS,BH,BD,BB,BY,BE,BZ,BJ,BM,BT,BO,BQ,BA,BW,BV,BR,IO,BN,BG,BF,BI,KH,CM,CA,CV,KY,CF,TD,CL,CN,CX,CC,CO,KM,CG,CD,CK,CR,CI,HR,CU,CW,CY,CZ,DK,DJ,DM,DO,EC,EG,SV,GQ,ER,EE,ET,FK,FO,FJ,FI,FR,GF,PF,TF,GA,GM,GE,DE,GH,GI,GR,GL,GD,GP,GU,GT,GG,GN,GW,GY,HT,HM,VA,HN,HK,HU,IS,IN,ID,IR,IQ,IE,IM,IL,IT,JM,JP,JE,JO,KZ,KE,KI,KP,KR,KW,KG,LA,LV,LB,LS,LR,LY,LI,LT,LU,MO,MK,MG,MW,MY,MV,ML,MT,MH,MQ,MR,MU,YT,MX,FM,MD,MC,MN,ME,MS,MA,MZ,MM,NA,NR,NP,NL,NC,NZ,NI,NE,NG,NU,NF,MP,NO,OM,PK,PW,PS,PA,PG,PY,PE,PH,PN,PL,PT,PR,QA,RE,RO,RU,RW,BL,SH,KN,LC,MF,PM,VC,WS,SM,ST,SA,SN,RS,SC,SL,SG,SX,SK,SI,SB,SO,ZA,GS,SS,ES,LK,SD,SR,SJ,SZ,SE,CH,SY,TW,TJ,TZ,TH,TL,TG,TK,TO,TT,TN,TR,TM,TC,TV,UG,UA,AE,GB,UM,UY,UZ,VU,VE,VN,VG,VI,WF,EH,YE,ZM,ZW,US", currency = "AED,AFN,ALL,AMD,ANG,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BHD,BIF,BMD,BND,BOB,BRL,BSD,BTN,BWP,BYN,BZD,CAD,CDF,CHF,CLF,CLP,CNY,COP,CRC,CUC,CUP,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ERN,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,IQD,IRR,ISK,JMD,JOD,JPY,KES,KGS,KHR,KMF,KPW,KRW,KWD,KYD,KZT,LAK,LBP,LKR,LRD,LSL,LYD,MAD,MDL,MGA,MKD,MMK,MNT,MOP,MRU,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SDG,SEK,SGD,SHP,SLE,SLL,SOS,SRD,SSP,STD,STN,SVC,SYP,SZL,THB,TJS,TMT,TND,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VES,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL" } diff --git a/config/deployments/production.toml b/config/deployments/production.toml index 4e68cadd284..a6b1d1c3f64 100644 --- a/config/deployments/production.toml +++ b/config/deployments/production.toml @@ -229,12 +229,12 @@ wallet.twint.connector_list = "adyen" wallet.vipps.connector_list = "adyen" bank_redirect.ideal.connector_list = "stripe,adyen,globalpay,multisafepay,nexinets,aci" -bank_redirect.sofort.connector_list = "globalpay,aci" +bank_redirect.sofort.connector_list = "globalpay,aci,multisafepay" bank_redirect.giropay.connector_list = "globalpay,multisafepay,nexinets,aci" bank_redirect.bancontact_card.connector_list="adyen,stripe" bank_redirect.trustly.connector_list="adyen,aci" bank_redirect.open_banking_uk.connector_list="adyen" -bank_redirect.eps.connector_list="globalpay,nexinets,aci" +bank_redirect.eps.connector_list="globalpay,nexinets,aci,multisafepay" [mandates.update_mandate_supported] card.credit = { connector_list = "cybersource" } # Update Mandate supported payment method type and connector for card @@ -531,6 +531,9 @@ klarna = { country = "AT,BE,DK,FI,FR,DE,IT,NL,NO,PT,ES,SE,GB", currency = "DKK,E trustly = { country = "AT,CZ,DK,EE,FI,DE,LV,LT,NL,NO,PL,PT,ES,SE,GB" , currency = "EUR,GBP,SEK"} ali_pay = {currency = "EUR,USD"} we_chat_pay = { currency = "EUR"} +eps = { country = "AT" , currency = "EUR" } +mb_way = { country = "PT" , currency = "EUR" } +sofort = { country = "AT,BE,FR,DE,IT,PL,ES,CH,GB" , currency = "EUR"} [pm_filters.cashtocode] classic = { country = "AF,AX,AL,DZ,AS,AD,AO,AI,AQ,AG,AR,AM,AW,AU,AT,AZ,BS,BH,BD,BB,BY,BE,BZ,BJ,BM,BT,BO,BQ,BA,BW,BV,BR,IO,BN,BG,BF,BI,KH,CM,CA,CV,KY,CF,TD,CL,CN,CX,CC,CO,KM,CG,CD,CK,CR,CI,HR,CU,CW,CY,CZ,DK,DJ,DM,DO,EC,EG,SV,GQ,ER,EE,ET,FK,FO,FJ,FI,FR,GF,PF,TF,GA,GM,GE,DE,GH,GI,GR,GL,GD,GP,GU,GT,GG,GN,GW,GY,HT,HM,VA,HN,HK,HU,IS,IN,ID,IR,IQ,IE,IM,IL,IT,JM,JP,JE,JO,KZ,KE,KI,KP,KR,KW,KG,LA,LV,LB,LS,LR,LY,LI,LT,LU,MO,MK,MG,MW,MY,MV,ML,MT,MH,MQ,MR,MU,YT,MX,FM,MD,MC,MN,ME,MS,MA,MZ,MM,NA,NR,NP,NL,NC,NZ,NI,NE,NG,NU,NF,MP,NO,OM,PK,PW,PS,PA,PG,PY,PE,PH,PN,PL,PT,PR,QA,RE,RO,RU,RW,BL,SH,KN,LC,MF,PM,VC,WS,SM,ST,SA,SN,RS,SC,SL,SG,SX,SK,SI,SB,SO,ZA,GS,SS,ES,LK,SD,SR,SJ,SZ,SE,CH,SY,TW,TJ,TZ,TH,TL,TG,TK,TO,TT,TN,TR,TM,TC,TV,UG,UA,AE,GB,UM,UY,UZ,VU,VE,VN,VG,VI,WF,EH,YE,ZM,ZW,US", currency = "AED,AFN,ALL,AMD,ANG,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BHD,BIF,BMD,BND,BOB,BRL,BSD,BTN,BWP,BYN,BZD,CAD,CDF,CHF,CLF,CLP,CNY,COP,CRC,CUC,CUP,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ERN,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,IQD,IRR,ISK,JMD,JOD,JPY,KES,KGS,KHR,KMF,KPW,KRW,KWD,KYD,KZT,LAK,LBP,LKR,LRD,LSL,LYD,MAD,MDL,MGA,MKD,MMK,MNT,MOP,MRU,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SDG,SEK,SGD,SHP,SLE,SLL,SOS,SRD,SSP,STD,STN,SVC,SYP,SZL,THB,TJS,TMT,TND,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VES,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL" } diff --git a/config/deployments/sandbox.toml b/config/deployments/sandbox.toml index 699f24e76ca..528f855647b 100644 --- a/config/deployments/sandbox.toml +++ b/config/deployments/sandbox.toml @@ -236,12 +236,12 @@ wallet.twint.connector_list = "adyen" wallet.vipps.connector_list = "adyen" bank_redirect.ideal.connector_list = "stripe,adyen,globalpay,multisafepay,nexinets,aci" -bank_redirect.sofort.connector_list = "globalpay,aci" +bank_redirect.sofort.connector_list = "globalpay,aci,multisafepay" bank_redirect.giropay.connector_list = "globalpay,multisafepay,nexinets,aci" bank_redirect.bancontact_card.connector_list="adyen,stripe" bank_redirect.trustly.connector_list="adyen,aci" bank_redirect.open_banking_uk.connector_list="adyen" -bank_redirect.eps.connector_list="globalpay,nexinets,aci" +bank_redirect.eps.connector_list="globalpay,nexinets,aci,multisafepay" [mandates.update_mandate_supported] card.credit = { connector_list = "cybersource" } # Update Mandate supported payment method type and connector for card @@ -539,6 +539,9 @@ klarna = { country = "AT,BE,DK,FI,FR,DE,IT,NL,NO,PT,ES,SE,GB", currency = "DKK,E trustly = { country = "AT,CZ,DK,EE,FI,DE,LV,LT,NL,NO,PL,PT,ES,SE,GB" , currency = "EUR,GBP,SEK"} ali_pay = {currency = "EUR,USD"} we_chat_pay = { currency = "EUR"} +eps = { country = "AT" , currency = "EUR" } +mb_way = { country = "PT" , currency = "EUR" } +sofort = { country = "AT,BE,FR,DE,IT,PL,ES,CH,GB" , currency = "EUR"} [pm_filters.cashtocode] classic = { country = "AF,AX,AL,DZ,AS,AD,AO,AI,AQ,AG,AR,AM,AW,AU,AT,AZ,BS,BH,BD,BB,BY,BE,BZ,BJ,BM,BT,BO,BQ,BA,BW,BV,BR,IO,BN,BG,BF,BI,KH,CM,CA,CV,KY,CF,TD,CL,CN,CX,CC,CO,KM,CG,CD,CK,CR,CI,HR,CU,CW,CY,CZ,DK,DJ,DM,DO,EC,EG,SV,GQ,ER,EE,ET,FK,FO,FJ,FI,FR,GF,PF,TF,GA,GM,GE,DE,GH,GI,GR,GL,GD,GP,GU,GT,GG,GN,GW,GY,HT,HM,VA,HN,HK,HU,IS,IN,ID,IR,IQ,IE,IM,IL,IT,JM,JP,JE,JO,KZ,KE,KI,KP,KR,KW,KG,LA,LV,LB,LS,LR,LY,LI,LT,LU,MO,MK,MG,MW,MY,MV,ML,MT,MH,MQ,MR,MU,YT,MX,FM,MD,MC,MN,ME,MS,MA,MZ,MM,NA,NR,NP,NL,NC,NZ,NI,NE,NG,NU,NF,MP,NO,OM,PK,PW,PS,PA,PG,PY,PE,PH,PN,PL,PT,PR,QA,RE,RO,RU,RW,BL,SH,KN,LC,MF,PM,VC,WS,SM,ST,SA,SN,RS,SC,SL,SG,SX,SK,SI,SB,SO,ZA,GS,SS,ES,LK,SD,SR,SJ,SZ,SE,CH,SY,TW,TJ,TZ,TH,TL,TG,TK,TO,TT,TN,TR,TM,TC,TV,UG,UA,AE,GB,UM,UY,UZ,VU,VE,VN,VG,VI,WF,EH,YE,ZM,ZW,US", currency = "AED,AFN,ALL,AMD,ANG,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BHD,BIF,BMD,BND,BOB,BRL,BSD,BTN,BWP,BYN,BZD,CAD,CDF,CHF,CLF,CLP,CNY,COP,CRC,CUC,CUP,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ERN,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,IQD,IRR,ISK,JMD,JOD,JPY,KES,KGS,KHR,KMF,KPW,KRW,KWD,KYD,KZT,LAK,LBP,LKR,LRD,LSL,LYD,MAD,MDL,MGA,MKD,MMK,MNT,MOP,MRU,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SDG,SEK,SGD,SHP,SLE,SLL,SOS,SRD,SSP,STD,STN,SVC,SYP,SZL,THB,TJS,TMT,TND,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VES,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL" } diff --git a/config/development.toml b/config/development.toml index b4cb8fa259b..d2088f04a7a 100644 --- a/config/development.toml +++ b/config/development.toml @@ -738,6 +738,9 @@ klarna = { country = "AT,BE,DK,FI,FR,DE,IT,NL,NO,PT,ES,SE,GB", currency = "DKK,E trustly = { country = "AT,CZ,DK,EE,FI,DE,LV,LT,NL,NO,PL,PT,ES,SE,GB" , currency = "EUR,GBP,SEK"} ali_pay = { currency = "EUR,USD" } we_chat_pay = { currency = "EUR"} +eps = { country = "AT" , currency = "EUR" } +mb_way = { country = "PT" , currency = "EUR" } +sofort = { country = "AT,BE,FR,DE,IT,PL,ES,CH,GB" , currency = "EUR"} [pm_filters.cashtocode] classic = { country = "AF,AX,AL,DZ,AS,AD,AO,AI,AQ,AG,AR,AM,AW,AU,AT,AZ,BS,BH,BD,BB,BY,BE,BZ,BJ,BM,BT,BO,BQ,BA,BW,BV,BR,IO,BN,BG,BF,BI,KH,CM,CA,CV,KY,CF,TD,CL,CN,CX,CC,CO,KM,CG,CD,CK,CR,CI,HR,CU,CW,CY,CZ,DK,DJ,DM,DO,EC,EG,SV,GQ,ER,EE,ET,FK,FO,FJ,FI,FR,GF,PF,TF,GA,GM,GE,DE,GH,GI,GR,GL,GD,GP,GU,GT,GG,GN,GW,GY,HT,HM,VA,HN,HK,HU,IS,IN,ID,IR,IQ,IE,IM,IL,IT,JM,JP,JE,JO,KZ,KE,KI,KP,KR,KW,KG,LA,LV,LB,LS,LR,LY,LI,LT,LU,MO,MK,MG,MW,MY,MV,ML,MT,MH,MQ,MR,MU,YT,MX,FM,MD,MC,MN,ME,MS,MA,MZ,MM,NA,NR,NP,NL,NC,NZ,NI,NE,NG,NU,NF,MP,NO,OM,PK,PW,PS,PA,PG,PY,PE,PH,PN,PL,PT,PR,QA,RE,RO,RU,RW,BL,SH,KN,LC,MF,PM,VC,WS,SM,ST,SA,SN,RS,SC,SL,SG,SX,SK,SI,SB,SO,ZA,GS,SS,ES,LK,SD,SR,SJ,SZ,SE,CH,SY,TW,TJ,TZ,TH,TL,TG,TK,TO,TT,TN,TR,TM,TC,TV,UG,UA,AE,GB,UM,UY,UZ,VU,VE,VN,VG,VI,WF,EH,YE,ZM,ZW,US", currency = "AED,AFN,ALL,AMD,ANG,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BHD,BIF,BMD,BND,BOB,BRL,BSD,BTN,BWP,BYN,BZD,CAD,CDF,CHF,CLF,CLP,CNY,COP,CRC,CUC,CUP,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ERN,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,IQD,IRR,ISK,JMD,JOD,JPY,KES,KGS,KHR,KMF,KPW,KRW,KWD,KYD,KZT,LAK,LBP,LKR,LRD,LSL,LYD,MAD,MDL,MGA,MKD,MMK,MNT,MOP,MRU,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SDG,SEK,SGD,SHP,SLE,SLL,SOS,SRD,SSP,STD,STN,SVC,SYP,SZL,THB,TJS,TMT,TND,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VES,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL" } @@ -970,12 +973,12 @@ wallet.twint.connector_list = "adyen" wallet.vipps.connector_list = "adyen" bank_redirect.ideal.connector_list = "stripe,adyen,globalpay,multisafepay,nexinets,aci" -bank_redirect.sofort.connector_list = "stripe,globalpay,aci" +bank_redirect.sofort.connector_list = "stripe,globalpay,aci,multisafepay" bank_redirect.giropay.connector_list = "globalpay,multisafepay,nexinets,aci" bank_redirect.bancontact_card.connector_list = "adyen,stripe" bank_redirect.trustly.connector_list = "adyen,aci" bank_redirect.open_banking_uk.connector_list = "adyen" -bank_redirect.eps.connector_list = "globalpay,nexinets,aci" +bank_redirect.eps.connector_list = "globalpay,nexinets,aci,multisafepay" [mandates.update_mandate_supported] card.credit = { connector_list = "cybersource" } diff --git a/crates/hyperswitch_connectors/src/connectors/multisafepay.rs b/crates/hyperswitch_connectors/src/connectors/multisafepay.rs index 08e76940237..0213f59cfd7 100644 --- a/crates/hyperswitch_connectors/src/connectors/multisafepay.rs +++ b/crates/hyperswitch_connectors/src/connectors/multisafepay.rs @@ -698,6 +698,38 @@ static MULTISAFEPAY_SUPPORTED_PAYMENT_METHODS: LazyLock<SupportedPaymentMethods> }, ); + multisafepay_supported_payment_methods.add( + enums::PaymentMethod::BankRedirect, + enums::PaymentMethodType::Eps, + PaymentMethodDetails { + mandates: enums::FeatureStatus::NotSupported, + refunds: enums::FeatureStatus::Supported, + supported_capture_methods: supported_capture_methods.clone(), + specific_features: None, + }, + ); + + multisafepay_supported_payment_methods.add( + enums::PaymentMethod::BankRedirect, + enums::PaymentMethodType::Sofort, + PaymentMethodDetails { + mandates: enums::FeatureStatus::NotSupported, + refunds: enums::FeatureStatus::Supported, + supported_capture_methods: supported_capture_methods.clone(), + specific_features: None, + }, + ); + + multisafepay_supported_payment_methods.add( + enums::PaymentMethod::Wallet, + enums::PaymentMethodType::MbWay, + PaymentMethodDetails { + mandates: enums::FeatureStatus::NotSupported, + refunds: enums::FeatureStatus::Supported, + supported_capture_methods: supported_capture_methods.clone(), + specific_features: None, + }, + ); multisafepay_supported_payment_methods }); diff --git a/crates/hyperswitch_connectors/src/connectors/multisafepay/transformers.rs b/crates/hyperswitch_connectors/src/connectors/multisafepay/transformers.rs index bcdbd7e28e6..212c4d11eee 100644 --- a/crates/hyperswitch_connectors/src/connectors/multisafepay/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/multisafepay/transformers.rs @@ -70,6 +70,10 @@ pub enum Gateway { Alipay, #[serde(rename = "WECHAT")] WeChatPay, + Eps, + MbWay, + #[serde(rename = "DIRECTBANK")] + Sofort, } #[serde_with::skip_serializing_none] @@ -189,11 +193,14 @@ pub enum WalletInfo { GooglePay(GpayInfo), Alipay(AlipayInfo), WeChatPay(WeChatPayInfo), + MbWay(MbWayInfo), } #[derive(Debug, Clone, Serialize, Eq, PartialEq)] -pub struct WeChatPayInfo {} +pub struct MbWayInfo {} +#[derive(Debug, Clone, Serialize, Eq, PartialEq)] +pub struct WeChatPayInfo {} #[derive(Debug, Clone, Serialize, Eq, PartialEq)] pub struct AlipayInfo {} @@ -202,7 +209,15 @@ pub struct AlipayInfo {} pub enum BankRedirectInfo { Ideal(IdealInfo), Trustly(TrustlyInfo), + Eps(EpsInfo), + Sofort(SofortInfo), } + +#[derive(Debug, Clone, Serialize, Eq, PartialEq)] +pub struct SofortInfo {} + +#[derive(Debug, Clone, Serialize, Eq, PartialEq)] +pub struct EpsInfo {} #[derive(Debug, Clone, Serialize, Eq, PartialEq)] pub struct TrustlyInfo {} #[derive(Debug, Clone, Serialize, Eq, PartialEq)] @@ -506,6 +521,7 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> WalletData::PaypalRedirect(_) => Type::Redirect, WalletData::AliPayRedirect(_) => Type::Redirect, WalletData::WeChatPayRedirect(_) => Type::Redirect, + WalletData::MbWayRedirect(_) => Type::Redirect, WalletData::AliPayQr(_) | WalletData::AliPayHkRedirect(_) | WalletData::AmazonPayRedirect(_) @@ -519,7 +535,6 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> | WalletData::DanaRedirect {} | WalletData::GooglePayRedirect(_) | WalletData::GooglePayThirdPartySdk(_) - | WalletData::MbWayRedirect(_) | WalletData::MobilePayRedirect(_) | WalletData::PaypalSdk(_) | WalletData::Paze(_) @@ -539,11 +554,12 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> BankRedirectData::Giropay { .. } => Type::Redirect, BankRedirectData::Ideal { .. } => Type::Direct, BankRedirectData::Trustly { .. } => Type::Redirect, + BankRedirectData::Eps { .. } => Type::Redirect, + BankRedirectData::Sofort { .. } => Type::Redirect, BankRedirectData::BancontactCard { .. } | BankRedirectData::Bizum { .. } | BankRedirectData::Blik { .. } | BankRedirectData::Eft { .. } - | BankRedirectData::Eps { .. } | BankRedirectData::Interac { .. } | BankRedirectData::OnlineBankingCzechRepublic { .. } | BankRedirectData::OnlineBankingFinland { .. } @@ -551,7 +567,6 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> | BankRedirectData::OnlineBankingSlovakia { .. } | BankRedirectData::OpenBankingUk { .. } | BankRedirectData::Przelewy24 { .. } - | BankRedirectData::Sofort { .. } | BankRedirectData::OnlineBankingFpx { .. } | BankRedirectData::OnlineBankingThailand { .. } | BankRedirectData::LocalBankRedirect {} => { @@ -573,6 +588,7 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> WalletData::PaypalRedirect(_) => Gateway::Paypal, WalletData::AliPayRedirect(_) => Gateway::Alipay, WalletData::WeChatPayRedirect(_) => Gateway::WeChatPay, + WalletData::MbWayRedirect(_) => Gateway::MbWay, WalletData::AliPayQr(_) | WalletData::AliPayHkRedirect(_) | WalletData::AmazonPayRedirect(_) @@ -586,7 +602,6 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> | WalletData::DanaRedirect {} | WalletData::GooglePayRedirect(_) | WalletData::GooglePayThirdPartySdk(_) - | WalletData::MbWayRedirect(_) | WalletData::MobilePayRedirect(_) | WalletData::PaypalSdk(_) | WalletData::Paze(_) @@ -606,11 +621,12 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> BankRedirectData::Giropay { .. } => Gateway::Giropay, BankRedirectData::Ideal { .. } => Gateway::Ideal, BankRedirectData::Trustly { .. } => Gateway::Trustly, + BankRedirectData::Eps { .. } => Gateway::Eps, + BankRedirectData::Sofort { .. } => Gateway::Sofort, BankRedirectData::BancontactCard { .. } | BankRedirectData::Bizum { .. } | BankRedirectData::Blik { .. } | BankRedirectData::Eft { .. } - | BankRedirectData::Eps { .. } | BankRedirectData::Interac { .. } | BankRedirectData::OnlineBankingCzechRepublic { .. } | BankRedirectData::OnlineBankingFinland { .. } @@ -618,7 +634,6 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> | BankRedirectData::OnlineBankingSlovakia { .. } | BankRedirectData::OpenBankingUk { .. } | BankRedirectData::Przelewy24 { .. } - | BankRedirectData::Sofort { .. } | BankRedirectData::OnlineBankingFpx { .. } | BankRedirectData::OnlineBankingThailand { .. } | BankRedirectData::LocalBankRedirect {} => { @@ -739,6 +754,9 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> WalletData::WeChatPayRedirect(_) => { Some(GatewayInfo::Wallet(WalletInfo::WeChatPay(WeChatPayInfo {}))) } + WalletData::MbWayRedirect(_) => { + Some(GatewayInfo::Wallet(WalletInfo::MbWay(MbWayInfo {}))) + } WalletData::AliPayQr(_) | WalletData::AliPayHkRedirect(_) | WalletData::AmazonPayRedirect(_) @@ -752,7 +770,6 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> | WalletData::DanaRedirect {} | WalletData::GooglePayRedirect(_) | WalletData::GooglePayThirdPartySdk(_) - | WalletData::MbWayRedirect(_) | WalletData::MobilePayRedirect(_) | WalletData::PaypalSdk(_) | WalletData::Paze(_) @@ -801,11 +818,16 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> BankRedirectData::Trustly { .. } => Some(GatewayInfo::BankRedirect( BankRedirectInfo::Trustly(TrustlyInfo {}), )), + BankRedirectData::Eps { .. } => { + Some(GatewayInfo::BankRedirect(BankRedirectInfo::Eps(EpsInfo {}))) + } + BankRedirectData::Sofort { .. } => Some(GatewayInfo::BankRedirect( + BankRedirectInfo::Sofort(SofortInfo {}), + )), BankRedirectData::BancontactCard { .. } | BankRedirectData::Bizum { .. } | BankRedirectData::Blik { .. } | BankRedirectData::Eft { .. } - | BankRedirectData::Eps { .. } | BankRedirectData::Giropay { .. } | BankRedirectData::Interac { .. } | BankRedirectData::OnlineBankingCzechRepublic { .. } @@ -814,7 +836,6 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> | BankRedirectData::OnlineBankingSlovakia { .. } | BankRedirectData::OpenBankingUk { .. } | BankRedirectData::Przelewy24 { .. } - | BankRedirectData::Sofort { .. } | BankRedirectData::OnlineBankingFpx { .. } | BankRedirectData::OnlineBankingThailand { .. } | BankRedirectData::LocalBankRedirect {} => None,

2025-07-01T05:58:27Z

## Type of Change  - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  ADD new pm for multisafepay - EPS - SOFORT - MBWAY ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  ## How did you test it?  <details> <summary>MCA</summary> ```json { "connector_type": "payment_processor", "connector_account_details": { "auth_type": "HeaderKey", "api_key": "****" }, "connector_name": "multisafepay", "test_mode": false, "disabled": false, "payment_methods_enabled": [ { "payment_method": "wallet", "payment_method_types": [ { "payment_method_type": "paypal", "payment_experience": "redirect_to_url" } ] }, { "payment_method": "wallet", "payment_method_types": [ { "payment_method_type": "we_chat_pay", "payment_experience": "redirect_to_url" } ] }, { "payment_method": "wallet", "payment_method_types": [ { "payment_method_type": "ali_pay", "payment_experience": "redirect_to_url" } ] }, { "payment_method": "wallet", "payment_method_types": [ { "payment_method_type": "amazon_pay", "payment_experience": "redirect_to_url" } ] }, { "payment_method": "bank_redirect", "payment_method_types": [ { "payment_method_type": "trustly" } ] }, { "payment_method": "bank_redirect", "payment_method_types": [ { "payment_method_type": "eps", "payment_experience": "redirect_to_url" } ] }, { "payment_method": "bank_redirect", "payment_method_types": [ { "payment_method_type": "mb_way", "payment_experience": "redirect_to_url" } ] }, { "payment_method": "bank_redirect", "payment_method_types": [ { "payment_method_type": "sofort", "payment_experience": "redirect_to_url" } ] }, { "payment_method": "card", "payment_method_types": [ { "payment_method_type": "credit", "card_networks": [ "Visa", "Mastercard" ], "minimum_amount": 1, "maximum_amount": 68607706, "recurring_enabled": true, "installment_payment_enabled": true }, { "payment_method_type": "debit", "card_networks": [ "Visa", "Mastercard" ], "minimum_amount": 1, "maximum_amount": 68607706, "recurring_enabled": true, "installment_payment_enabled": true } ] } ], "metadata": { "city": "NY", "unit": "245" }, "business_country": "US", "business_label": "default" } ``` </details> ## SOFORT <details> <summary>Payment Request</summary> ```json { "amount": 333, "currency": "EUR", "confirm": true, "capture_method": "automatic", "payment_method": "bank_redirect", "payment_method_type": "sofort", "authentication_type": "no_three_ds", "description": "hellow world", "billing": { "address": { "zip": "560095", "first_name": "Sakil", "last_name": "Mostak", "line1": "Fasdf", "country": "CN", "line2": "Fasdf", "city": "Fasdf" } }, "payment_method_data": { "bank_redirect": { "sofort": {} } } } ``` </details> <details> <summary>Confirm page</summary> <img width="1356" alt="Screenshot 2025-07-01 at 11 20 05 AM" src="https://github.com/user-attachments/assets/13699a4f-db05-4e44-ab48-f19948c2645f" /> </details> <details> <summary>Psync Response</summary> ```json { "payment_id": "pay_2VuZLa8gqY25CfYd0j9g", "merchant_id": "merchant_1751348844", "status": "succeeded", "amount": 333, "net_amount": 333, "shipping_cost": null, "amount_capturable": 0, "amount_received": 333, "connector": "multisafepay", "client_secret": "pay_2VuZLa8gqY25CfYd0j9g_secret_uJ6cIqUaMlLLZjxdduEB", "created": "2025-07-01T05:49:46.290Z", "currency": "EUR", "customer_id": null, "customer": null, "description": "hellow world", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "bank_redirect", "payment_method_data": { "bank_redirect": { "type": "BankRedirectResponse", "bank_name": null }, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": "Fasdf", "country": "CN", "line1": "Fasdf", "line2": "Fasdf", "line3": null, "zip": "560095", "state": null, "first_name": "Sakil", "last_name": "Mostak" }, "phone": null, "email": null }, "order_details": null, "email": null, "name": null, "phone": null, "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "sofort", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": false, "connector_transaction_id": "pay_2VuZLa8gqY25CfYd0j9g_1", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_2VuZLa8gqY25CfYd0j9g_1", "payment_link": null, "profile_id": "pro_3OEvbwtJss77rpYRZpK9", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_lpvLYRnYLwlFl8HyiR3C", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-07-01T06:04:46.290Z", "fingerprint": null, "browser_info": null, "payment_method_id": null, "payment_method_status": null, "updated": "2025-07-01T05:50:08.187Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": null, "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` </details> ## EPS <details> <summary>Payment request</summary> ```json { "amount": 333, "currency": "EUR", "confirm": true, "capture_method": "automatic", "payment_method": "bank_redirect", "payment_method_type": "eps", "authentication_type": "no_three_ds", "description": "hellow world", "billing": { "address": { "zip": "560095", "first_name": "Sakil", "last_name": "Mostak", "line1": "Fasdf", "country": "AT", "line2": "Fasdf", "city": "Fasdf" } }, "payment_method_data": { "bank_redirect": { "eps": {} } } } ``` </details> <details> <summary>Payment page</summary> ``` NOTE there is a bug in confirm page by multisafe page where it shows gyropay instead eps. But after success the payment is regestered under eps only in the merchant page ``` <img width="1324" alt="Screenshot 2025-07-01 at 11 34 03 AM" src="https://github.com/user-attachments/assets/b768ba16-a351-40aa-bfa3-5ae8356593d0" /> </details> <details> <summary>Psync response</summary> ```json { "payment_id": "pay_5wcVD9r07H9USnvnkmj8", "merchant_id": "merchant_1751348844", "status": "succeeded", "amount": 333, "net_amount": 333, "shipping_cost": null, "amount_capturable": 0, "amount_received": 333, "connector": "multisafepay", "client_secret": "pay_5wcVD9r07H9USnvnkmj8_secret_gszuW3VnyepDNGQycnkG", "created": "2025-07-01T06:03:45.907Z", "currency": "EUR", "customer_id": null, "customer": null, "description": "hellow world", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "bank_redirect", "payment_method_data": { "bank_redirect": { "type": "BankRedirectResponse", "bank_name": null }, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": "Fasdf", "country": "AT", "line1": "Fasdf", "line2": "Fasdf", "line3": null, "zip": "560095", "state": null, "first_name": "Sakil", "last_name": "Mostak" }, "phone": null, "email": null }, "order_details": null, "email": null, "name": null, "phone": null, "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "eps", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": false, "connector_transaction_id": "pay_5wcVD9r07H9USnvnkmj8_1", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_5wcVD9r07H9USnvnkmj8_1", "payment_link": null, "profile_id": "pro_3OEvbwtJss77rpYRZpK9", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_lpvLYRnYLwlFl8HyiR3C", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-07-01T06:18:45.907Z", "fingerprint": null, "browser_info": null, "payment_method_id": null, "payment_method_status": null, "updated": "2025-07-01T06:04:06.199Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": null, "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` </details> ## MB WAY <details> <summary>Payment</summary> ```json { "amount": 333, "currency": "EUR", "confirm": true, "capture_method": "automatic", "payment_method": "wallet", "payment_method_type": "mb_way", "authentication_type": "no_three_ds", "description": "hellow world", "billing": { "address": { "zip": "560095", "first_name": "Sakil", "last_name": "Mostak", "line1": "Fasdf", "country": "PT", "line2": "Fasdf", "city": "Fasdf" } }, "payment_method_data": { "wallet": { "mb_way_redirect": {} } } } ``` </details> <details> <summary>Payment Response </summary> ```json { "payment_id": "pay_5FG8mrPdW4jnQERhOSSW", "merchant_id": "merchant_1751348844", "status": "requires_customer_action", "amount": 333, "net_amount": 333, "shipping_cost": null, "amount_capturable": 333, "amount_received": null, "connector": "multisafepay", "client_secret": "pay_5FG8mrPdW4jnQERhOSSW_secret_OZ8fONDt6UUY4YyCHZRh", "created": "2025-07-01T06:10:53.544Z", "currency": "EUR", "customer_id": null, "customer": null, "description": "hellow world", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "wallet", "payment_method_data": { "wallet": {}, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": "Fasdf", "country": "PT", "line1": "Fasdf", "line2": "Fasdf", "line3": null, "zip": "560095", "state": null, "first_name": "Sakil", "last_name": "Mostak" }, "phone": null, "email": null }, "order_details": null, "email": null, "name": null, "phone": null, "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": { "type": "redirect_to_url", "redirect_to_url": "http://localhost:8080/payments/redirect/pay_5FG8mrPdW4jnQERhOSSW/merchant_1751348844/pay_5FG8mrPdW4jnQERhOSSW_1" }, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "mb_way", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": null, "connector_transaction_id": "pay_5FG8mrPdW4jnQERhOSSW_1", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_5FG8mrPdW4jnQERhOSSW_1", "payment_link": null, "profile_id": "pro_3OEvbwtJss77rpYRZpK9", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_NafK7LHPOhPMyNsUBOfH", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-07-01T06:25:53.544Z", "fingerprint": null, "browser_info": null, "payment_method_id": null, "payment_method_status": null, "updated": "2025-07-01T06:10:55.158Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": null, "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` </details> <details> <summary>Confirm page</summary> <img width="1356" alt="Screenshot 2025-07-01 at 11 20 05 AM" src="https://github.com/user-attachments/assets/96558e15-dc30-4b36-a1a1-2b3de10f3262" /> <img width="1324" alt="Screenshot 2025-07-01 at 11 34 03 AM" src="https://github.com/user-attachments/assets/60ce6a5f-4c57-42aa-9175-69a47c1ec20e" /> SOME PROBLEM WITH CONFIRMATION </details> <details> <summary>Psync</summary> ``` UNABLE TO VERIFY due to issue from multisafepay . Needs alpha testing ``` </details> ### cypress test - UNABLE TO TEST REDIRECTION VIA CYPRESS DUE TO CSRF BLOCKING <img width="696" alt="Screenshot 2025-07-09 at 4 18 29 PM" src="https://github.com/user-attachments/assets/d875b5a0-6ef7-4475-a615-5cacf6c4e8bc" /> ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [x] I added unit tests for my changes where possible

v1.115.0

7f5ec7439b3469df7d77b8151ae3f4218847641a

juspay/hyperswitch

juspay__hyperswitch-8554

Bug: [FEATURE] [CONNECTOR] Silverflow ### Feature Description Integrate a new connector Silverflow in alpha integration ref: https://www.silverflow.com/ ### Possible Implementation Integrate a new connector Silverflow in alpha integration ref: https://www.silverflow.com/ ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? None

diff --git a/config/config.example.toml b/config/config.example.toml index 0bb5cb13007..10f796128f7 100644 --- a/config/config.example.toml +++ b/config/config.example.toml @@ -280,6 +280,7 @@ redsys.base_url = "https://sis-t.redsys.es:25443" riskified.base_url = "https://sandbox.riskified.com/api" santander.base_url = "https://pix.santander.com.br/api/v1/sandbox/" shift4.base_url = "https://api.shift4.com/" +silverflow.base_url = "https://api-sbx.silverflow.co/v1" signifyd.base_url = "https://api.signifyd.com/" square.base_url = "https://connect.squareupsandbox.com/" square.secondary_base_url = "https://pci-connect.squareupsandbox.com/" diff --git a/config/deployments/integration_test.toml b/config/deployments/integration_test.toml index c92570aaeef..803047dca2e 100644 --- a/config/deployments/integration_test.toml +++ b/config/deployments/integration_test.toml @@ -116,6 +116,7 @@ recurly.base_url = "https://v3.recurly.com" redsys.base_url = "https://sis-t.redsys.es:25443" santander.base_url = "https://pix.santander.com.br/api/v1/sandbox/" shift4.base_url = "https://api.shift4.com/" +silverflow.base_url = "https://api-sbx.silverflow.co/v1" signifyd.base_url = "https://api.signifyd.com/" riskified.base_url = "https://sandbox.riskified.com/api" square.base_url = "https://connect.squareupsandbox.com/" diff --git a/config/deployments/production.toml b/config/deployments/production.toml index 8e7fd10702c..94d8f18d44d 100644 --- a/config/deployments/production.toml +++ b/config/deployments/production.toml @@ -121,6 +121,7 @@ redsys.base_url = "https://sis.redsys.es" riskified.base_url = "https://wh.riskified.com/api/" santander.base_url = "https://trust-pix.santander.com.br/" shift4.base_url = "https://api.shift4.com/" +silverflow.base_url = "https://api.silverflow.co/v1" signifyd.base_url = "https://api.signifyd.com/" square.base_url = "https://connect.squareup.com/" square.secondary_base_url = "https://pci-connect.squareup.com/" diff --git a/config/deployments/sandbox.toml b/config/deployments/sandbox.toml index 2011b50b756..99daaab178d 100644 --- a/config/deployments/sandbox.toml +++ b/config/deployments/sandbox.toml @@ -121,6 +121,7 @@ redsys.base_url = "https://sis-t.redsys.es:25443" riskified.base_url = "https://sandbox.riskified.com/api" santander.base_url = "https://pix.santander.com.br/api/v1/sandbox/" shift4.base_url = "https://api.shift4.com/" +silverflow.base_url = "https://api-sbx.silverflow.co/v1" signifyd.base_url = "https://api.signifyd.com/" square.base_url = "https://connect.squareupsandbox.com/" square.secondary_base_url = "https://pci-connect.squareupsandbox.com/" diff --git a/config/development.toml b/config/development.toml index 49e5bb8a52e..b72f7bcbaee 100644 --- a/config/development.toml +++ b/config/development.toml @@ -171,6 +171,7 @@ cards = [ "redsys", "santander", "shift4", + "silverflow", "square", "stax", "stripe", @@ -317,6 +318,7 @@ redsys.base_url = "https://sis-t.redsys.es:25443" riskified.base_url = "https://sandbox.riskified.com/api" santander.base_url = "https://pix.santander.com.br/api/v1/sandbox/" shift4.base_url = "https://api.shift4.com/" +silverflow.base_url = "https://api-sbx.silverflow.co/v1" signifyd.base_url = "https://api.signifyd.com/" square.base_url = "https://connect.squareupsandbox.com/" square.secondary_base_url = "https://pci-connect.squareupsandbox.com/" diff --git a/config/docker_compose.toml b/config/docker_compose.toml index 329c3743d39..ef3ad0b1b05 100644 --- a/config/docker_compose.toml +++ b/config/docker_compose.toml @@ -206,6 +206,7 @@ redsys.base_url = "https://sis-t.redsys.es:25443" riskified.base_url = "https://sandbox.riskified.com/api" santander.base_url = "https://pix.santander.com.br/api/v1/sandbox/" shift4.base_url = "https://api.shift4.com/" +silverflow.base_url = "https://api-sbx.silverflow.co/v1" signifyd.base_url = "https://api.signifyd.com/" square.base_url = "https://connect.squareupsandbox.com/" square.secondary_base_url = "https://pci-connect.squareupsandbox.com/" @@ -322,6 +323,7 @@ cards = [ "redsys", "santander", "shift4", + "silverflow", "square", "stax", "stripe", diff --git a/crates/connector_configs/src/connector.rs b/crates/connector_configs/src/connector.rs index 3e36dc023b9..f092b543f8c 100644 --- a/crates/connector_configs/src/connector.rs +++ b/crates/connector_configs/src/connector.rs @@ -261,6 +261,7 @@ pub struct ConnectorConfig { pub redsys: Option<ConnectorTomlConfig>, pub santander: Option<ConnectorTomlConfig>, pub shift4: Option<ConnectorTomlConfig>, + pub silverflow: Option<ConnectorTomlConfig>, pub stripe: Option<ConnectorTomlConfig>, #[cfg(feature = "payouts")] pub stripe_payout: Option<ConnectorTomlConfig>, diff --git a/crates/connector_configs/toml/development.toml b/crates/connector_configs/toml/development.toml index 99663984715..f8919cba957 100644 --- a/crates/connector_configs/toml/development.toml +++ b/crates/connector_configs/toml/development.toml @@ -6315,4 +6315,8 @@ type="Text" [payload.connector_auth.HeaderKey] api_key="API Key" [payload.connector_webhook_details] -merchant_secret="Source verification key" \ No newline at end of file +merchant_secret="Source verification key" +[silverflow] +[silverflow.connector_auth.BodyKey] +api_key="API Key" +key1="Secret Key" diff --git a/crates/connector_configs/toml/production.toml b/crates/connector_configs/toml/production.toml index a7d81b2c22d..667c5028c95 100644 --- a/crates/connector_configs/toml/production.toml +++ b/crates/connector_configs/toml/production.toml @@ -4921,3 +4921,8 @@ type="Text" api_key="API Key" [payload.connector_webhook_details] merchant_secret="Source verification key" + +[silverflow] +[silverflow.connector_auth.BodyKey] +api_key="API Key" +key1="Secret Key" \ No newline at end of file diff --git a/crates/connector_configs/toml/sandbox.toml b/crates/connector_configs/toml/sandbox.toml index 2660bd1a365..20b7cdf09bf 100644 --- a/crates/connector_configs/toml/sandbox.toml +++ b/crates/connector_configs/toml/sandbox.toml @@ -6289,4 +6289,8 @@ type="Text" [payload.connector_auth.HeaderKey] api_key="API Key" [payload.connector_webhook_details] -merchant_secret="Source verification key" \ No newline at end of file +merchant_secret="Source verification key" +[silverflow] +[silverflow.connector_auth.BodyKey] +api_key="API Key" +key1="Secret Key" diff --git a/crates/hyperswitch_connectors/src/connectors.rs b/crates/hyperswitch_connectors/src/connectors.rs index 0861bbb4610..6583e2ce5b9 100644 --- a/crates/hyperswitch_connectors/src/connectors.rs +++ b/crates/hyperswitch_connectors/src/connectors.rs @@ -87,6 +87,7 @@ pub mod riskified; pub mod santander; pub mod shift4; pub mod signifyd; +pub mod silverflow; pub mod square; pub mod stax; pub mod stripe; @@ -133,10 +134,11 @@ pub use self::{ paypal::Paypal, paystack::Paystack, payu::Payu, placetopay::Placetopay, plaid::Plaid, powertranz::Powertranz, prophetpay::Prophetpay, rapyd::Rapyd, razorpay::Razorpay, recurly::Recurly, redsys::Redsys, riskified::Riskified, santander::Santander, shift4::Shift4, - signifyd::Signifyd, square::Square, stax::Stax, stripe::Stripe, stripebilling::Stripebilling, - taxjar::Taxjar, threedsecureio::Threedsecureio, thunes::Thunes, tokenio::Tokenio, - trustpay::Trustpay, tsys::Tsys, unified_authentication_service::UnifiedAuthenticationService, - vgs::Vgs, volt::Volt, wellsfargo::Wellsfargo, wellsfargopayout::Wellsfargopayout, wise::Wise, - worldline::Worldline, worldpay::Worldpay, worldpayvantiv::Worldpayvantiv, - worldpayxml::Worldpayxml, xendit::Xendit, zen::Zen, zsl::Zsl, + signifyd::Signifyd, silverflow::Silverflow, square::Square, stax::Stax, stripe::Stripe, + stripebilling::Stripebilling, taxjar::Taxjar, threedsecureio::Threedsecureio, thunes::Thunes, + tokenio::Tokenio, trustpay::Trustpay, tsys::Tsys, + unified_authentication_service::UnifiedAuthenticationService, vgs::Vgs, volt::Volt, + wellsfargo::Wellsfargo, wellsfargopayout::Wellsfargopayout, wise::Wise, worldline::Worldline, + worldpay::Worldpay, worldpayvantiv::Worldpayvantiv, worldpayxml::Worldpayxml, xendit::Xendit, + zen::Zen, zsl::Zsl, }; diff --git a/crates/hyperswitch_connectors/src/connectors/silverflow.rs b/crates/hyperswitch_connectors/src/connectors/silverflow.rs new file mode 100644 index 00000000000..7042380d9e0 --- /dev/null +++ b/crates/hyperswitch_connectors/src/connectors/silverflow.rs @@ -0,0 +1,627 @@ +pub mod transformers; + +use std::sync::LazyLock; + +use common_enums::enums; +use common_utils::{ + errors::CustomResult, + ext_traits::BytesExt, + request::{Method, Request, RequestBuilder, RequestContent}, + types::{AmountConvertor, StringMinorUnit, StringMinorUnitForConnector}, +}; +use error_stack::{report, ResultExt}; +use hyperswitch_domain_models::{ + payment_method_data::PaymentMethodData, + router_data::{AccessToken, ConnectorAuthType, ErrorResponse, RouterData}, + router_flow_types::{ + access_token_auth::AccessTokenAuth, + payments::{Authorize, Capture, PSync, PaymentMethodToken, Session, SetupMandate, Void}, + refunds::{Execute, RSync}, + }, + router_request_types::{ + AccessTokenRequestData, PaymentMethodTokenizationData, PaymentsAuthorizeData, + PaymentsCancelData, PaymentsCaptureData, PaymentsSessionData, PaymentsSyncData, + RefundsData, SetupMandateRequestData, + }, + router_response_types::{ + ConnectorInfo, PaymentsResponseData, RefundsResponseData, SupportedPaymentMethods, + }, + types::{ + PaymentsAuthorizeRouterData, PaymentsCaptureRouterData, PaymentsSyncRouterData, + RefundSyncRouterData, RefundsRouterData, + }, +}; +use hyperswitch_interfaces::{ + api::{ + self, ConnectorCommon, ConnectorCommonExt, ConnectorIntegration, ConnectorSpecifications, + ConnectorValidation, + }, + configs::Connectors, + errors, + events::connector_api_logs::ConnectorEvent, + types::{self, Response}, + webhooks, +}; +use masking::{ExposeInterface, Mask}; +use transformers as silverflow; + +use crate::{constants::headers, types::ResponseRouterData, utils}; + +#[derive(Clone)] +pub struct Silverflow { + amount_converter: &'static (dyn AmountConvertor<Output = StringMinorUnit> + Sync), +} + +impl Silverflow { + pub fn new() -> &'static Self { + &Self { + amount_converter: &StringMinorUnitForConnector, + } + } +} + +impl api::Payment for Silverflow {} +impl api::PaymentSession for Silverflow {} +impl api::ConnectorAccessToken for Silverflow {} +impl api::MandateSetup for Silverflow {} +impl api::PaymentAuthorize for Silverflow {} +impl api::PaymentSync for Silverflow {} +impl api::PaymentCapture for Silverflow {} +impl api::PaymentVoid for Silverflow {} +impl api::Refund for Silverflow {} +impl api::RefundExecute for Silverflow {} +impl api::RefundSync for Silverflow {} +impl api::PaymentToken for Silverflow {} + +impl ConnectorIntegration<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData> + for Silverflow +{ + // Not Implemented (R) +} + +impl<Flow, Request, Response> ConnectorCommonExt<Flow, Request, Response> for Silverflow +where + Self: ConnectorIntegration<Flow, Request, Response>, +{ + fn build_headers( + &self, + req: &RouterData<Flow, Request, Response>, + _connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + let mut header = vec![( + headers::CONTENT_TYPE.to_string(), + self.get_content_type().to_string().into(), + )]; + let mut api_key = self.get_auth_header(&req.connector_auth_type)?; + header.append(&mut api_key); + Ok(header) + } +} + +impl ConnectorCommon for Silverflow { + fn id(&self) -> &'static str { + "silverflow" + } + + fn get_currency_unit(&self) -> api::CurrencyUnit { + // todo!() + api::CurrencyUnit::Minor + // TODO! Check connector documentation, on which unit they are processing the currency. + // If the connector accepts amount in lower unit ( i.e cents for USD) then return api::CurrencyUnit::Minor, + // if connector accepts amount in base unit (i.e dollars for USD) then return api::CurrencyUnit::Base + } + + fn common_get_content_type(&self) -> &'static str { + "application/json" + } + + fn base_url<'a>(&self, connectors: &'a Connectors) -> &'a str { + connectors.silverflow.base_url.as_ref() + } + + fn get_auth_header( + &self, + auth_type: &ConnectorAuthType, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + let auth = silverflow::SilverflowAuthType::try_from(auth_type) + .change_context(errors::ConnectorError::FailedToObtainAuthType)?; + Ok(vec![( + headers::AUTHORIZATION.to_string(), + auth.api_key.expose().into_masked(), + )]) + } + + fn build_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + let response: silverflow::SilverflowErrorResponse = res + .response + .parse_struct("SilverflowErrorResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + + Ok(ErrorResponse { + status_code: res.status_code, + code: response.code, + message: response.message, + reason: response.reason, + attempt_status: None, + connector_transaction_id: None, + network_advice_code: None, + network_decline_code: None, + network_error_message: None, + }) + } +} + +impl ConnectorValidation for Silverflow { + fn validate_mandate_payment( + &self, + _pm_type: Option<enums::PaymentMethodType>, + pm_data: PaymentMethodData, + ) -> CustomResult<(), errors::ConnectorError> { + match pm_data { + PaymentMethodData::Card(_) => Err(errors::ConnectorError::NotImplemented( + "validate_mandate_payment does not support cards".to_string(), + ) + .into()), + _ => Ok(()), + } + } + + fn validate_psync_reference_id( + &self, + _data: &PaymentsSyncData, + _is_three_ds: bool, + _status: enums::AttemptStatus, + _connector_meta_data: Option<common_utils::pii::SecretSerdeValue>, + ) -> CustomResult<(), errors::ConnectorError> { + Ok(()) + } +} + +impl ConnectorIntegration<Session, PaymentsSessionData, PaymentsResponseData> for Silverflow { + //TODO: implement sessions flow +} + +impl ConnectorIntegration<AccessTokenAuth, AccessTokenRequestData, AccessToken> for Silverflow {} + +impl ConnectorIntegration<SetupMandate, SetupMandateRequestData, PaymentsResponseData> + for Silverflow +{ +} + +impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData> for Silverflow { + fn get_headers( + &self, + req: &PaymentsAuthorizeRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsAuthorizeRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn get_request_body( + &self, + req: &PaymentsAuthorizeRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let amount = utils::convert_amount( + self.amount_converter, + req.request.minor_amount, + req.request.currency, + )?; + + let connector_router_data = silverflow::SilverflowRouterData::from((amount, req)); + let connector_req = + silverflow::SilverflowPaymentsRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &PaymentsAuthorizeRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::PaymentsAuthorizeType::get_url( + self, req, connectors, + )?) + .attach_default_headers() + .headers(types::PaymentsAuthorizeType::get_headers( + self, req, connectors, + )?) + .set_body(types::PaymentsAuthorizeType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsAuthorizeRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsAuthorizeRouterData, errors::ConnectorError> { + let response: silverflow::SilverflowPaymentsResponse = res + .response + .parse_struct("Silverflow PaymentsAuthorizeResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<PSync, PaymentsSyncData, PaymentsResponseData> for Silverflow { + fn get_headers( + &self, + req: &PaymentsSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsSyncRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn build_request( + &self, + req: &PaymentsSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Get) + .url(&types::PaymentsSyncType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::PaymentsSyncType::get_headers(self, req, connectors)?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsSyncRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsSyncRouterData, errors::ConnectorError> { + let response: silverflow::SilverflowPaymentsResponse = res + .response + .parse_struct("silverflow PaymentsSyncResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<Capture, PaymentsCaptureData, PaymentsResponseData> for Silverflow { + fn get_headers( + &self, + req: &PaymentsCaptureRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsCaptureRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn get_request_body( + &self, + _req: &PaymentsCaptureRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_request_body method".to_string()).into()) + } + + fn build_request( + &self, + req: &PaymentsCaptureRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::PaymentsCaptureType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::PaymentsCaptureType::get_headers( + self, req, connectors, + )?) + .set_body(types::PaymentsCaptureType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsCaptureRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsCaptureRouterData, errors::ConnectorError> { + let response: silverflow::SilverflowPaymentsResponse = res + .response + .parse_struct("Silverflow PaymentsCaptureResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<Void, PaymentsCancelData, PaymentsResponseData> for Silverflow {} + +impl ConnectorIntegration<Execute, RefundsData, RefundsResponseData> for Silverflow { + fn get_headers( + &self, + req: &RefundsRouterData<Execute>, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &RefundsRouterData<Execute>, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn get_request_body( + &self, + req: &RefundsRouterData<Execute>, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let refund_amount = utils::convert_amount( + self.amount_converter, + req.request.minor_refund_amount, + req.request.currency, + )?; + + let connector_router_data = silverflow::SilverflowRouterData::from((refund_amount, req)); + let connector_req = silverflow::SilverflowRefundRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &RefundsRouterData<Execute>, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + let request = RequestBuilder::new() + .method(Method::Post) + .url(&types::RefundExecuteType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::RefundExecuteType::get_headers( + self, req, connectors, + )?) + .set_body(types::RefundExecuteType::get_request_body( + self, req, connectors, + )?) + .build(); + Ok(Some(request)) + } + + fn handle_response( + &self, + data: &RefundsRouterData<Execute>, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<RefundsRouterData<Execute>, errors::ConnectorError> { + let response: silverflow::RefundResponse = res + .response + .parse_struct("silverflow RefundResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<RSync, RefundsData, RefundsResponseData> for Silverflow { + fn get_headers( + &self, + req: &RefundSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &RefundSyncRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn build_request( + &self, + req: &RefundSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Get) + .url(&types::RefundSyncType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::RefundSyncType::get_headers(self, req, connectors)?) + .set_body(types::RefundSyncType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &RefundSyncRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<RefundSyncRouterData, errors::ConnectorError> { + let response: silverflow::RefundResponse = res + .response + .parse_struct("silverflow RefundSyncResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +#[async_trait::async_trait] +impl webhooks::IncomingWebhook for Silverflow { + fn get_webhook_object_reference_id( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<api_models::webhooks::ObjectReferenceId, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } + + fn get_webhook_event_type( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<api_models::webhooks::IncomingWebhookEvent, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } + + fn get_webhook_resource_object( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<Box<dyn masking::ErasedMaskSerialize>, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } +} + +static SILVERFLOW_SUPPORTED_PAYMENT_METHODS: LazyLock<SupportedPaymentMethods> = + LazyLock::new(SupportedPaymentMethods::new); + +static SILVERFLOW_CONNECTOR_INFO: ConnectorInfo = ConnectorInfo { + display_name: "Silverflow", + description: "Silverflow connector", + connector_type: enums::PaymentConnectorCategory::PaymentGateway, +}; + +static SILVERFLOW_SUPPORTED_WEBHOOK_FLOWS: [enums::EventClass; 0] = []; + +impl ConnectorSpecifications for Silverflow { + fn get_connector_about(&self) -> Option<&'static ConnectorInfo> { + Some(&SILVERFLOW_CONNECTOR_INFO) + } + + fn get_supported_payment_methods(&self) -> Option<&'static SupportedPaymentMethods> { + Some(&*SILVERFLOW_SUPPORTED_PAYMENT_METHODS) + } + + fn get_supported_webhook_flows(&self) -> Option<&'static [enums::EventClass]> { + Some(&SILVERFLOW_SUPPORTED_WEBHOOK_FLOWS) + } +} diff --git a/crates/hyperswitch_connectors/src/connectors/silverflow/transformers.rs b/crates/hyperswitch_connectors/src/connectors/silverflow/transformers.rs new file mode 100644 index 00000000000..8a1bb52a5bb --- /dev/null +++ b/crates/hyperswitch_connectors/src/connectors/silverflow/transformers.rs @@ -0,0 +1,219 @@ +use common_enums::enums; +use common_utils::types::StringMinorUnit; +use hyperswitch_domain_models::{ + payment_method_data::PaymentMethodData, + router_data::{ConnectorAuthType, RouterData}, + router_flow_types::refunds::{Execute, RSync}, + router_request_types::ResponseId, + router_response_types::{PaymentsResponseData, RefundsResponseData}, + types::{PaymentsAuthorizeRouterData, RefundsRouterData}, +}; +use hyperswitch_interfaces::errors; +use masking::Secret; +use serde::{Deserialize, Serialize}; + +use crate::types::{RefundsResponseRouterData, ResponseRouterData}; + +//TODO: Fill the struct with respective fields +pub struct SilverflowRouterData<T> { + pub amount: StringMinorUnit, // The type of amount that a connector accepts, for example, String, i64, f64, etc. + pub router_data: T, +} + +impl<T> From<(StringMinorUnit, T)> for SilverflowRouterData<T> { + fn from((amount, item): (StringMinorUnit, T)) -> Self { + //Todo : use utils to convert the amount to the type of amount that a connector accepts + Self { + amount, + router_data: item, + } + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Serialize, PartialEq)] +pub struct SilverflowPaymentsRequest { + amount: StringMinorUnit, + card: SilverflowCard, +} + +#[derive(Default, Debug, Serialize, Eq, PartialEq)] +pub struct SilverflowCard { + number: cards::CardNumber, + expiry_month: Secret<String>, + expiry_year: Secret<String>, + cvc: Secret<String>, + complete: bool, +} + +impl TryFrom<&SilverflowRouterData<&PaymentsAuthorizeRouterData>> for SilverflowPaymentsRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: &SilverflowRouterData<&PaymentsAuthorizeRouterData>, + ) -> Result<Self, Self::Error> { + match item.router_data.request.payment_method_data.clone() { + PaymentMethodData::Card(_) => Err(errors::ConnectorError::NotImplemented( + "Card payment method not implemented".to_string(), + ) + .into()), + _ => Err(errors::ConnectorError::NotImplemented("Payment method".to_string()).into()), + } + } +} + +//TODO: Fill the struct with respective fields +// Auth Struct +pub struct SilverflowAuthType { + pub(super) api_key: Secret<String>, +} + +impl TryFrom<&ConnectorAuthType> for SilverflowAuthType { + 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, Copy, Default, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "lowercase")] +pub enum SilverflowPaymentStatus { + Succeeded, + Failed, + #[default] + Processing, +} + +impl From<SilverflowPaymentStatus> for common_enums::AttemptStatus { + fn from(item: SilverflowPaymentStatus) -> Self { + match item { + SilverflowPaymentStatus::Succeeded => Self::Charged, + SilverflowPaymentStatus::Failed => Self::Failure, + SilverflowPaymentStatus::Processing => Self::Authorizing, + } + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] +pub struct SilverflowPaymentsResponse { + status: SilverflowPaymentStatus, + id: String, +} + +impl<F, T> TryFrom<ResponseRouterData<F, SilverflowPaymentsResponse, T, PaymentsResponseData>> + for RouterData<F, T, PaymentsResponseData> +{ + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: ResponseRouterData<F, SilverflowPaymentsResponse, T, PaymentsResponseData>, + ) -> Result<Self, Self::Error> { + Ok(Self { + status: common_enums::AttemptStatus::from(item.response.status), + response: Ok(PaymentsResponseData::TransactionResponse { + resource_id: ResponseId::ConnectorTransactionId(item.response.id), + redirection_data: Box::new(None), + mandate_reference: Box::new(None), + connector_metadata: None, + network_txn_id: None, + connector_response_reference_id: None, + incremental_authorization_allowed: None, + charges: None, + }), + ..item.data + }) + } +} + +//TODO: Fill the struct with respective fields +// REFUND : +// Type definition for RefundRequest +#[derive(Default, Debug, Serialize)] +pub struct SilverflowRefundRequest { + pub amount: StringMinorUnit, +} + +impl<F> TryFrom<&SilverflowRouterData<&RefundsRouterData<F>>> for SilverflowRefundRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from(item: &SilverflowRouterData<&RefundsRouterData<F>>) -> Result<Self, Self::Error> { + Ok(Self { + amount: item.amount.to_owned(), + }) + } +} + +// Type definition for Refund Response + +#[allow(dead_code)] +#[derive(Debug, Copy, Serialize, Default, Deserialize, Clone)] +pub enum RefundStatus { + Succeeded, + Failed, + #[default] + Processing, +} + +impl From<RefundStatus> for enums::RefundStatus { + fn from(item: RefundStatus) -> Self { + match item { + RefundStatus::Succeeded => Self::Success, + RefundStatus::Failed => Self::Failure, + RefundStatus::Processing => Self::Pending, + //TODO: Review mapping + } + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Clone, Serialize, Deserialize)] +pub struct RefundResponse { + id: String, + status: RefundStatus, +} + +impl TryFrom<RefundsResponseRouterData<Execute, RefundResponse>> for RefundsRouterData<Execute> { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: RefundsResponseRouterData<Execute, RefundResponse>, + ) -> Result<Self, Self::Error> { + Ok(Self { + response: Ok(RefundsResponseData { + connector_refund_id: item.response.id.to_string(), + refund_status: enums::RefundStatus::from(item.response.status), + }), + ..item.data + }) + } +} + +impl TryFrom<RefundsResponseRouterData<RSync, RefundResponse>> for RefundsRouterData<RSync> { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: RefundsResponseRouterData<RSync, RefundResponse>, + ) -> Result<Self, Self::Error> { + Ok(Self { + response: Ok(RefundsResponseData { + connector_refund_id: item.response.id.to_string(), + refund_status: enums::RefundStatus::from(item.response.status), + }), + ..item.data + }) + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Serialize, Deserialize, PartialEq)] +pub struct SilverflowErrorResponse { + pub status_code: u16, + pub code: String, + pub message: String, + pub reason: Option<String>, + pub network_advice_code: Option<String>, + pub network_decline_code: Option<String>, + pub network_error_message: Option<String>, +} diff --git a/crates/hyperswitch_connectors/src/default_implementations.rs b/crates/hyperswitch_connectors/src/default_implementations.rs index a2a5c163865..9cc798d57cd 100644 --- a/crates/hyperswitch_connectors/src/default_implementations.rs +++ b/crates/hyperswitch_connectors/src/default_implementations.rs @@ -226,6 +226,7 @@ default_imp_for_authorize_session_token!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -352,6 +353,7 @@ default_imp_for_calculate_tax!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Square, @@ -444,6 +446,7 @@ default_imp_for_session_update!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stripe, connectors::Stax, @@ -570,6 +573,7 @@ default_imp_for_post_session_tokens!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Square, connectors::Stax, @@ -694,6 +698,7 @@ default_imp_for_create_order!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Square, connectors::Stax, @@ -821,6 +826,7 @@ default_imp_for_update_metadata!( connectors::Redsys, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Square, connectors::Stax, @@ -898,6 +904,7 @@ macro_rules! default_imp_for_complete_authorize { } default_imp_for_complete_authorize!( + connectors::Silverflow, connectors::Vgs, connectors::Aci, connectors::Adyen, @@ -1089,6 +1096,7 @@ default_imp_for_incremental_authorization!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Square, @@ -1213,6 +1221,7 @@ default_imp_for_create_customer!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Square, connectors::Stripebilling, @@ -1324,6 +1333,7 @@ default_imp_for_connector_redirect_response!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Square, @@ -1361,6 +1371,7 @@ macro_rules! default_imp_for_pre_processing_steps{ } default_imp_for_pre_processing_steps!( + connectors::Silverflow, connectors::Vgs, connectors::Aci, connectors::Adyenplatform, @@ -1561,6 +1572,7 @@ default_imp_for_post_processing_steps!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Square, @@ -1689,6 +1701,7 @@ default_imp_for_approve!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Square, @@ -1817,6 +1830,7 @@ default_imp_for_reject!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Square, @@ -1944,6 +1958,7 @@ default_imp_for_webhook_source_verification!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Square, @@ -2071,6 +2086,7 @@ default_imp_for_accept_dispute!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Square, @@ -2197,6 +2213,7 @@ default_imp_for_submit_evidence!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Square, @@ -2322,6 +2339,7 @@ default_imp_for_defend_dispute!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Square, @@ -2457,6 +2475,7 @@ default_imp_for_file_upload!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Square, @@ -2570,6 +2589,7 @@ default_imp_for_payouts!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Square, connectors::Stax, @@ -2693,6 +2713,7 @@ default_imp_for_payouts_create!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Square, @@ -2819,6 +2840,7 @@ default_imp_for_payouts_retrieve!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Square, @@ -2946,6 +2968,7 @@ default_imp_for_payouts_eligibility!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Square, @@ -3068,6 +3091,7 @@ default_imp_for_payouts_fulfill!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Square, @@ -3193,6 +3217,7 @@ default_imp_for_payouts_cancel!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Square, @@ -3319,6 +3344,7 @@ default_imp_for_payouts_quote!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Square, @@ -3446,6 +3472,7 @@ default_imp_for_payouts_recipient!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Square, @@ -3573,6 +3600,7 @@ default_imp_for_payouts_recipient_account!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Square, @@ -3701,6 +3729,7 @@ default_imp_for_frm_sale!( connectors::Redsys, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Stax, connectors::Square, connectors::Stripe, @@ -3829,6 +3858,7 @@ default_imp_for_frm_checkout!( connectors::Redsys, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Stax, connectors::Square, connectors::Stripe, @@ -3957,6 +3987,7 @@ default_imp_for_frm_transaction!( connectors::Redsys, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Stax, connectors::Square, connectors::Stripe, @@ -4085,6 +4116,7 @@ default_imp_for_frm_fulfillment!( connectors::Redsys, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Stax, connectors::Square, connectors::Stripe, @@ -4213,6 +4245,7 @@ default_imp_for_frm_record_return!( connectors::Redsys, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Stripe, connectors::Stax, connectors::Square, @@ -4336,6 +4369,7 @@ default_imp_for_revoking_mandates!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Square, @@ -4462,6 +4496,7 @@ default_imp_for_uas_pre_authentication!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stripe, connectors::Stax, @@ -4587,6 +4622,7 @@ default_imp_for_uas_post_authentication!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stripe, connectors::Stax, @@ -4713,6 +4749,7 @@ default_imp_for_uas_authentication_confirmation!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Square, @@ -4830,6 +4867,7 @@ default_imp_for_connector_request_id!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Square, @@ -4951,6 +4989,7 @@ default_imp_for_fraud_check!( connectors::Redsys, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Stax, connectors::Square, connectors::Stripe, @@ -5100,6 +5139,7 @@ default_imp_for_connector_authentication!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Square, @@ -5224,6 +5264,7 @@ default_imp_for_uas_authentication!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Square, @@ -5343,6 +5384,7 @@ default_imp_for_revenue_recovery!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -5472,6 +5514,7 @@ default_imp_for_billing_connector_payment_sync!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stripe, connectors::Stax, @@ -5599,6 +5642,7 @@ default_imp_for_revenue_recovery_record_back!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stripe, connectors::Stax, @@ -5727,6 +5771,7 @@ default_imp_for_billing_connector_invoice_sync!( connectors::Santander, connectors::Signifyd, connectors::Shift4, + connectors::Silverflow, connectors::Stax, connectors::Square, connectors::Stripe, @@ -5848,6 +5893,7 @@ default_imp_for_external_vault!( connectors::Santander, connectors::Signifyd, connectors::Shift4, + connectors::Silverflow, connectors::Stax, connectors::Stripe, connectors::Stripebilling, @@ -5975,6 +6021,7 @@ default_imp_for_external_vault_insert!( connectors::Santander, connectors::Signifyd, connectors::Shift4, + connectors::Silverflow, connectors::Stax, connectors::Stripe, connectors::Stripebilling, @@ -6102,6 +6149,7 @@ default_imp_for_external_vault_retrieve!( connectors::Santander, connectors::Signifyd, connectors::Shift4, + connectors::Silverflow, connectors::Stax, connectors::Stripe, connectors::Stripebilling, @@ -6229,6 +6277,7 @@ default_imp_for_external_vault_delete!( connectors::Santander, connectors::Signifyd, connectors::Shift4, + connectors::Silverflow, connectors::Stax, connectors::Stripe, connectors::Stripebilling, @@ -6355,6 +6404,7 @@ default_imp_for_external_vault_create!( connectors::Santander, connectors::Signifyd, connectors::Shift4, + connectors::Silverflow, connectors::Stax, connectors::Stripe, connectors::Stripebilling, diff --git a/crates/hyperswitch_connectors/src/default_implementations_v2.rs b/crates/hyperswitch_connectors/src/default_implementations_v2.rs index 2c3e849d4c9..7bc66a1e6cf 100644 --- a/crates/hyperswitch_connectors/src/default_implementations_v2.rs +++ b/crates/hyperswitch_connectors/src/default_implementations_v2.rs @@ -333,6 +333,7 @@ default_imp_for_new_connector_integration_payment!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -461,6 +462,7 @@ default_imp_for_new_connector_integration_refund!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -584,6 +586,7 @@ default_imp_for_new_connector_integration_connector_access_token!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -712,6 +715,7 @@ default_imp_for_new_connector_integration_accept_dispute!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -839,6 +843,7 @@ default_imp_for_new_connector_integration_submit_evidence!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -967,6 +972,7 @@ default_imp_for_new_connector_integration_defend_dispute!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -1105,6 +1111,7 @@ default_imp_for_new_connector_integration_file_upload!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -1235,6 +1242,7 @@ default_imp_for_new_connector_integration_payouts_create!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -1365,6 +1373,7 @@ default_imp_for_new_connector_integration_payouts_eligibility!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -1495,6 +1504,7 @@ default_imp_for_new_connector_integration_payouts_fulfill!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -1625,6 +1635,7 @@ default_imp_for_new_connector_integration_payouts_cancel!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -1755,6 +1766,7 @@ default_imp_for_new_connector_integration_payouts_quote!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -1885,6 +1897,7 @@ default_imp_for_new_connector_integration_payouts_recipient!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -2015,6 +2028,7 @@ default_imp_for_new_connector_integration_payouts_sync!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -2145,6 +2159,7 @@ default_imp_for_new_connector_integration_payouts_recipient_account!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -2273,6 +2288,7 @@ default_imp_for_new_connector_integration_webhook_source_verification!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -2403,6 +2419,7 @@ default_imp_for_new_connector_integration_frm_sale!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -2533,6 +2550,7 @@ default_imp_for_new_connector_integration_frm_checkout!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -2663,6 +2681,7 @@ default_imp_for_new_connector_integration_frm_transaction!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -2793,6 +2812,7 @@ default_imp_for_new_connector_integration_frm_fulfillment!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -2923,6 +2943,7 @@ default_imp_for_new_connector_integration_frm_record_return!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -3049,6 +3070,7 @@ default_imp_for_new_connector_integration_revoking_mandates!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -3147,6 +3169,7 @@ default_imp_for_new_connector_integration_frm!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -3272,6 +3295,7 @@ default_imp_for_new_connector_integration_connector_authentication!( connectors::Recurly, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -3389,6 +3413,7 @@ default_imp_for_new_connector_integration_revenue_recovery!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Stripe, @@ -3540,6 +3565,7 @@ default_imp_for_new_connector_integration_external_vault!( connectors::Riskified, connectors::Santander, connectors::Shift4, + connectors::Silverflow, connectors::Signifyd, connectors::Stax, connectors::Square, diff --git a/crates/hyperswitch_domain_models/src/configs.rs b/crates/hyperswitch_domain_models/src/configs.rs index 89f8ddf673f..9e64262f78f 100644 --- a/crates/hyperswitch_domain_models/src/configs.rs +++ b/crates/hyperswitch_domain_models/src/configs.rs @@ -101,6 +101,7 @@ pub struct Connectors { pub riskified: ConnectorParams, pub santander: ConnectorParams, pub shift4: ConnectorParams, + pub silverflow: ConnectorParams, pub signifyd: ConnectorParams, pub square: ConnectorParams, pub stax: ConnectorParams, diff --git a/crates/router/src/connector.rs b/crates/router/src/connector.rs index 49aa7c61cd9..619608a95de 100644 --- a/crates/router/src/connector.rs +++ b/crates/router/src/connector.rs @@ -32,9 +32,9 @@ pub use hyperswitch_connectors::connectors::{ placetopay, placetopay::Placetopay, plaid, plaid::Plaid, powertranz, powertranz::Powertranz, prophetpay, prophetpay::Prophetpay, rapyd, rapyd::Rapyd, razorpay, razorpay::Razorpay, recurly, recurly::Recurly, redsys, redsys::Redsys, riskified, riskified::Riskified, santander, - santander::Santander, shift4, shift4::Shift4, signifyd, signifyd::Signifyd, square, - square::Square, stax, stax::Stax, stripe, stripe::Stripe, stripebilling, - stripebilling::Stripebilling, taxjar, taxjar::Taxjar, threedsecureio, + santander::Santander, shift4, shift4::Shift4, signifyd, signifyd::Signifyd, silverflow, + silverflow::Silverflow, square, square::Square, stax, stax::Stax, stripe, stripe::Stripe, + stripebilling, stripebilling::Stripebilling, taxjar, taxjar::Taxjar, threedsecureio, threedsecureio::Threedsecureio, thunes, thunes::Thunes, tokenio, tokenio::Tokenio, trustpay, trustpay::Trustpay, tsys, tsys::Tsys, unified_authentication_service, unified_authentication_service::UnifiedAuthenticationService, vgs, vgs::Vgs, volt, volt::Volt, diff --git a/crates/router/tests/connectors/main.rs b/crates/router/tests/connectors/main.rs index 10707ba2f4e..62066918099 100644 --- a/crates/router/tests/connectors/main.rs +++ b/crates/router/tests/connectors/main.rs @@ -91,6 +91,7 @@ mod razorpay; mod redsys; mod santander; mod shift4; +mod silverflow; mod square; mod stax; mod stripe; diff --git a/crates/router/tests/connectors/silverflow.rs b/crates/router/tests/connectors/silverflow.rs new file mode 100644 index 00000000000..5d4f48943da --- /dev/null +++ b/crates/router/tests/connectors/silverflow.rs @@ -0,0 +1,421 @@ +use hyperswitch_domain_models::payment_method_data::{Card, PaymentMethodData}; +use masking::Secret; +use router::types::{self, api, storage::enums}; +use test_utils::connector_auth; + +use crate::utils::{self, ConnectorActions}; + +#[derive(Clone, Copy)] +struct SilverflowTest; +impl ConnectorActions for SilverflowTest {} +impl utils::Connector for SilverflowTest { + fn get_data(&self) -> api::ConnectorData { + use router::connector::Silverflow; + utils::construct_connector_data_old( + Box::new(Silverflow::new()), + types::Connector::Plaid, + api::GetToken::Connector, + None, + ) + } + + fn get_auth_token(&self) -> types::ConnectorAuthType { + utils::to_connector_auth_type( + connector_auth::ConnectorAuthentication::new() + .silverflow + .expect("Missing connector authentication configuration") + .into(), + ) + } + + fn get_name(&self) -> String { + "silverflow".to_string() + } +} + +static CONNECTOR: SilverflowTest = SilverflowTest {}; + +fn get_default_payment_info() -> Option<utils::PaymentInfo> { + None +} + +fn payment_method_details() -> Option<types::PaymentsAuthorizeData> { + None +} + +// Cards Positive Tests +// Creates a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_only_authorize_payment() { + let response = CONNECTOR + .authorize_payment(payment_method_details(), get_default_payment_info()) + .await + .expect("Authorize payment response"); + assert_eq!(response.status, enums::AttemptStatus::Authorized); +} + +// Captures a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_capture_authorized_payment() { + let response = CONNECTOR + .authorize_and_capture_payment(payment_method_details(), None, get_default_payment_info()) + .await + .expect("Capture payment response"); + assert_eq!(response.status, enums::AttemptStatus::Charged); +} + +// Partially captures a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_capture_authorized_payment() { + let response = CONNECTOR + .authorize_and_capture_payment( + payment_method_details(), + Some(types::PaymentsCaptureData { + amount_to_capture: 50, + ..utils::PaymentCaptureType::default().0 + }), + get_default_payment_info(), + ) + .await + .expect("Capture payment response"); + assert_eq!(response.status, enums::AttemptStatus::Charged); +} + +// Synchronizes a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_authorized_payment() { + let authorize_response = CONNECTOR + .authorize_payment(payment_method_details(), get_default_payment_info()) + .await + .expect("Authorize payment response"); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + let response = CONNECTOR + .psync_retry_till_status_matches( + enums::AttemptStatus::Authorized, + Some(types::PaymentsSyncData { + connector_transaction_id: types::ResponseId::ConnectorTransactionId( + txn_id.unwrap(), + ), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .expect("PSync response"); + assert_eq!(response.status, enums::AttemptStatus::Authorized,); +} + +// Voids a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_void_authorized_payment() { + let response = CONNECTOR + .authorize_and_void_payment( + payment_method_details(), + Some(types::PaymentsCancelData { + connector_transaction_id: String::from(""), + cancellation_reason: Some("requested_by_customer".to_string()), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .expect("Void payment response"); + assert_eq!(response.status, enums::AttemptStatus::Voided); +} + +// Refunds a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_manually_captured_payment() { + let response = CONNECTOR + .capture_payment_and_refund( + payment_method_details(), + None, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Partially refunds a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_refund_manually_captured_payment() { + let response = CONNECTOR + .capture_payment_and_refund( + payment_method_details(), + None, + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Synchronizes a refund using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_manually_captured_refund() { + let refund_response = CONNECTOR + .capture_payment_and_refund( + payment_method_details(), + None, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + let response = CONNECTOR + .rsync_retry_till_status_matches( + enums::RefundStatus::Success, + refund_response.response.unwrap().connector_refund_id, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Creates a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_make_payment() { + let authorize_response = CONNECTOR + .make_payment(payment_method_details(), get_default_payment_info()) + .await + .unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); +} + +// Synchronizes a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_auto_captured_payment() { + let authorize_response = CONNECTOR + .make_payment(payment_method_details(), get_default_payment_info()) + .await + .unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + assert_ne!(txn_id, None, "Empty connector transaction id"); + let response = CONNECTOR + .psync_retry_till_status_matches( + enums::AttemptStatus::Charged, + Some(types::PaymentsSyncData { + connector_transaction_id: types::ResponseId::ConnectorTransactionId( + txn_id.unwrap(), + ), + capture_method: Some(enums::CaptureMethod::Automatic), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!(response.status, enums::AttemptStatus::Charged,); +} + +// Refunds a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_auto_captured_payment() { + let response = CONNECTOR + .make_payment_and_refund(payment_method_details(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Partially refunds a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_refund_succeeded_payment() { + let refund_response = CONNECTOR + .make_payment_and_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + refund_response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Creates multiple refunds against a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_succeeded_payment_multiple_times() { + CONNECTOR + .make_payment_and_multiple_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await; +} + +// Synchronizes a refund using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_refund() { + let refund_response = CONNECTOR + .make_payment_and_refund(payment_method_details(), None, get_default_payment_info()) + .await + .unwrap(); + let response = CONNECTOR + .rsync_retry_till_status_matches( + enums::RefundStatus::Success, + refund_response.response.unwrap().connector_refund_id, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Cards Negative scenarios +// Creates a payment with incorrect CVC. +#[actix_web::test] +async fn should_fail_payment_for_incorrect_cvc() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: PaymentMethodData::Card(Card { + card_cvc: Secret::new("12345".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's security code is invalid.".to_string(), + ); +} + +// Creates a payment with incorrect expiry month. +#[actix_web::test] +async fn should_fail_payment_for_invalid_exp_month() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: PaymentMethodData::Card(Card { + card_exp_month: Secret::new("20".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's expiration month is invalid.".to_string(), + ); +} + +// Creates a payment with incorrect expiry year. +#[actix_web::test] +async fn should_fail_payment_for_incorrect_expiry_year() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: PaymentMethodData::Card(Card { + card_exp_year: Secret::new("2000".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's expiration year is invalid.".to_string(), + ); +} + +// Voids a payment using automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_fail_void_payment_for_auto_capture() { + let authorize_response = CONNECTOR + .make_payment(payment_method_details(), get_default_payment_info()) + .await + .unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + assert_ne!(txn_id, None, "Empty connector transaction id"); + let void_response = CONNECTOR + .void_payment(txn_id.unwrap(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + void_response.response.unwrap_err().message, + "You cannot cancel this PaymentIntent because it has a status of succeeded." + ); +} + +// Captures a payment using invalid connector payment id. +#[actix_web::test] +async fn should_fail_capture_for_invalid_payment() { + let capture_response = CONNECTOR + .capture_payment("123456789".to_string(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + capture_response.response.unwrap_err().message, + String::from("No such payment_intent: '123456789'") + ); +} + +// Refunds a payment with refund amount higher than payment amount. +#[actix_web::test] +async fn should_fail_for_refund_amount_higher_than_payment_amount() { + let response = CONNECTOR + .make_payment_and_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 150, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Refund amount (₹1.50) is greater than charge amount (₹1.00)", + ); +} + +// Connector dependent test cases goes here + +// [#478]: add unit tests for non 3DS, wallets & webhooks in connector tests diff --git a/crates/test_utils/src/connector_auth.rs b/crates/test_utils/src/connector_auth.rs index 31141205523..25fffd09b0f 100644 --- a/crates/test_utils/src/connector_auth.rs +++ b/crates/test_utils/src/connector_auth.rs @@ -97,6 +97,7 @@ pub struct ConnectorAuthentication { pub redsys: Option<HeaderKey>, pub santander: Option<BodyKey>, pub shift4: Option<HeaderKey>, + pub silverflow: Option<BodyKey>, pub square: Option<BodyKey>, pub stax: Option<HeaderKey>, pub stripe: Option<HeaderKey>, diff --git a/loadtest/config/development.toml b/loadtest/config/development.toml index d2c62a57796..b1c7a7581c4 100644 --- a/loadtest/config/development.toml +++ b/loadtest/config/development.toml @@ -173,6 +173,7 @@ redsys.base_url = "https://sis-t.redsys.es:25443" riskified.base_url = "https://sandbox.riskified.com/api" santander.base_url = "https://pix.santander.com.br/api/v1/sandbox/" shift4.base_url = "https://api.shift4.com/" +silverflow.base_url = "https://api-sbx.silverflow.co/v1" signifyd.base_url = "https://api.signifyd.com/" square.base_url = "https://connect.squareupsandbox.com/" square.secondary_base_url = "https://pci-connect.squareupsandbox.com/" @@ -288,6 +289,7 @@ cards = [ "redsys", "santander", "shift4", + "silverflow", "square", "stax", "stripe", diff --git a/scripts/add_connector.sh b/scripts/add_connector.sh index 648d2e68993..90424011957 100755 --- a/scripts/add_connector.sh +++ b/scripts/add_connector.sh @@ -6,7 +6,8 @@ function find_prev_connector() { git checkout $self cp $self $self.tmp # Add new connector to existing list and sort it - connectors=(aci adyen adyenplatform airwallex amazonpay applepay archipel authorizedotnet bambora bamboraapac bankofamerica barclaycard billwerk bitpay bluesnap boku braintree cashtocode celero chargebee checkbook checkout coinbase cryptopay ctp_visa cybersource datatrans deutschebank digitalvirgo dlocal dummyconnector dwolla ebanx elavon facilitapay fiserv fiservemea fiuu forte getnet globalpay globepay gocardless gpayments helcim hipay hyperswitch_vault iatapay inespay itaubank jpmorgan juspaythreedsserver klarna mifinity mollie moneris multisafepay netcetera nexinets nexixpay nomupay noon nordea novalnet nuvei opayo opennode paybox payeezy payload payme payone paypal paystack payu placetopay plaid powertranz prophetpay rapyd razorpay recurly redsys santander shift4 square stax stripe stripebilling taxjar threedsecureio thunes tokenio trustpay tsys unified_authentication_service vgs volt wellsfargo wellsfargopayout wise worldline worldpay worldpayvantiv worldpayxml xendit zsl "$1") + connectors=(aci adyen adyenplatform airwallex amazonpay applepay archipel authorizedotnet bambora bamboraapac bankofamerica barclaycard billwerk bitpay bluesnap boku braintree cashtocode celero chargebee checkbook checkout coinbase cryptopay ctp_visa cybersource datatrans deutschebank digitalvirgo dlocal dummyconnector dwolla ebanx elavon facilitapay fiserv fiservemea fiuu forte getnet globalpay globepay gocardless gpayments helcim hipay hyperswitch_vault iatapay inespay itaubank jpmorgan juspaythreedsserver klarna mifinity mollie moneris multisafepay netcetera nexinets nexixpay nomupay noon nordea novalnet nuvei opayo opennode paybox payeezy payload payme payone paypal paystack payu placetopay plaid powertranz prophetpay rapyd razorpay recurly redsys santander shift4 silverflow square stax stripe stripebilling taxjar threedsecureio thunes tokenio trustpay tsys unified_authentication_service vgs volt wellsfargo wellsfargopayout wise worldline worldpay worldpayvantiv worldpayxml xendit zsl "$1") + IFS=$'\n' sorted=($(sort <<<"${connectors[*]}")); unset IFS res="$(echo ${sorted[@]})" sed -i'' -e "s/^ connectors=.*/ connectors=($res \"\$1\")/" $self.tmp

2025-07-04T14:25:37Z

## Type of Change  - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description Connector template code for new connector silverflow. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  ## How did you test it? This is a template PR for Silverflow, just checked for compilation. Nothing else to test. ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

6197df2e35a292238a9b393d7a1848f0d50ec09b

juspay/hyperswitch

juspay__hyperswitch-8538

Bug: Migrate from cargo2nix to rust-flake Migrate the Nix build/shell system from cargo2nix to rust-flake. **Parent Issue:** #57 **Related PR:** #8503 ## Acceptance Criteria - [x] Migrate from cargo2nix to rust-flake - [x] Verify nix CI/CD compatibility

diff --git a/.gitignore b/.gitignore index 01f1f2e9007..1f31c3c1525 100644 --- a/.gitignore +++ b/.gitignore @@ -270,3 +270,4 @@ creds.json # Nix services data /data +.pre-commit-config.yaml diff --git a/flake.lock b/flake.lock index 36c888e7db1..9b65a841327 100644 --- a/flake.lock +++ b/flake.lock @@ -1,102 +1,113 @@ { "nodes": { - "cargo2nix": { + "crane": { + "locked": { + "lastModified": 1750266157, + "narHash": "sha256-tL42YoNg9y30u7zAqtoGDNdTyXTi8EALDeCB13FtbQA=", + "owner": "ipetkov", + "repo": "crane", + "rev": "e37c943371b73ed87faf33f7583860f81f1d5a48", + "type": "github" + }, + "original": { + "owner": "ipetkov", + "repo": "crane", + "type": "github" + } + }, + "flake-parts": { "inputs": { - "flake-compat": "flake-compat", - "flake-utils": "flake-utils", - "nixpkgs": "nixpkgs", - "rust-overlay": "rust-overlay" + "nixpkgs-lib": "nixpkgs-lib" }, "locked": { - "lastModified": 1742755793, - "narHash": "sha256-nz3zSO5a/cB/XPcP4c3cddUceKH9V3LNMuNpfV3TDeE=", - "owner": "cargo2nix", - "repo": "cargo2nix", - "rev": "f7b2c744b1e6ee39c7b4528ea34f06db598266a6", + "lastModified": 1751413152, + "narHash": "sha256-Tyw1RjYEsp5scoigs1384gIg6e0GoBVjms4aXFfRssQ=", + "owner": "hercules-ci", + "repo": "flake-parts", + "rev": "77826244401ea9de6e3bac47c2db46005e1f30b5", "type": "github" }, "original": { - "owner": "cargo2nix", - "ref": "release-0.11.0", - "repo": "cargo2nix", + "owner": "hercules-ci", + "repo": "flake-parts", "type": "github" } }, - "flake-compat": { + "git-hooks": { "flake": false, "locked": { - "lastModified": 1696426674, - "narHash": "sha256-kvjfFW7WAETZlt09AgDn1MrtKzP7t90Vf7vypd3OL1U=", - "owner": "edolstra", - "repo": "flake-compat", - "rev": "0f9255e01c2351cc7d116c072cb317785dd33b33", + "lastModified": 1750779888, + "narHash": "sha256-wibppH3g/E2lxU43ZQHC5yA/7kIKLGxVEnsnVK1BtRg=", + "owner": "cachix", + "repo": "git-hooks.nix", + "rev": "16ec914f6fb6f599ce988427d9d94efddf25fe6d", "type": "github" }, "original": { - "owner": "edolstra", - "repo": "flake-compat", + "owner": "cachix", + "repo": "git-hooks.nix", "type": "github" } }, - "flake-parts": { + "globset": { "inputs": { - "nixpkgs-lib": "nixpkgs-lib" + "nixpkgs-lib": [ + "rust-flake", + "nixpkgs" + ] }, "locked": { - "lastModified": 1749398372, - "narHash": "sha256-tYBdgS56eXYaWVW3fsnPQ/nFlgWi/Z2Ymhyu21zVM98=", - "owner": "hercules-ci", - "repo": "flake-parts", - "rev": "9305fe4e5c2a6fcf5ba6a3ff155720fbe4076569", + "lastModified": 1744379919, + "narHash": "sha256-ieaQegt7LdMDFweeHhRaUQFYyF0U3pWD/XiCvq5L5U8=", + "owner": "pdtpartners", + "repo": "globset", + "rev": "4e21c96ab1259b8cd864272f96a8891b589c8eda", "type": "github" }, "original": { - "owner": "hercules-ci", - "repo": "flake-parts", + "owner": "pdtpartners", + "repo": "globset", "type": "github" } }, - "flake-utils": { - "inputs": { - "systems": "systems" - }, + "nixos-unified": { "locked": { - "lastModified": 1694529238, - "narHash": "sha256-zsNZZGTGnMOf9YpHKJqMSsa0dXbfmxeoJ7xHlrt+xmY=", - "owner": "numtide", - "repo": "flake-utils", - "rev": "ff7b65b44d01cf9ba6a71320833626af21126384", + "lastModified": 1751174231, + "narHash": "sha256-OLPo3ZI/gKH0C6P6l2W9RYm1ow/Jl4qBrasQ3rjAA0E=", + "owner": "srid", + "repo": "nixos-unified", + "rev": "05eb3d59d3b48460ea01c419702d4fc0c3210805", "type": "github" }, "original": { - "owner": "numtide", - "repo": "flake-utils", + "owner": "srid", + "repo": "nixos-unified", "type": "github" } }, "nixpkgs": { "locked": { - "lastModified": 1705099185, - "narHash": "sha256-SxJenKtvcrKJd0TyJQMO3p6VA7PEp+vmMnmlKFzWMNs=", - "owner": "nixos", + "lastModified": 1751271578, + "narHash": "sha256-P/SQmKDu06x8yv7i0s8bvnnuJYkxVGBWLWHaU+tt4YY=", + "owner": "NixOS", "repo": "nixpkgs", - "rev": "2bce5ccff0ad7abda23e8bb56434b6877a446694", + "rev": "3016b4b15d13f3089db8a41ef937b13a9e33a8df", "type": "github" }, "original": { - "owner": "nixos", - "ref": "release-23.11", + "owner": "NixOS", + "ref": "nixos-unstable", "repo": "nixpkgs", "type": "github" } }, "nixpkgs-lib": { "locked": { - "lastModified": 1748740939, - "narHash": "sha256-rQaysilft1aVMwF14xIdGS3sj1yHlI6oKQNBRTF40cc=", + "lastModified": 1751159883, + "narHash": "sha256-urW/Ylk9FIfvXfliA1ywh75yszAbiTEVgpPeinFyVZo=", "owner": "nix-community", "repo": "nixpkgs.lib", - "rev": "656a64127e9d791a334452c6b6606d17539476e2", + "rev": "14a40a1d7fb9afa4739275ac642ed7301a9ba1ab", "type": "github" }, "original": { @@ -107,36 +118,20 @@ }, "nixpkgs_2": { "locked": { - "lastModified": 1749285348, - "narHash": "sha256-frdhQvPbmDYaScPFiCnfdh3B/Vh81Uuoo0w5TkWmmjU=", - "owner": "NixOS", + "lastModified": 1751271578, + "narHash": "sha256-P/SQmKDu06x8yv7i0s8bvnnuJYkxVGBWLWHaU+tt4YY=", + "owner": "nixos", "repo": "nixpkgs", - "rev": "3e3afe5174c561dee0df6f2c2b2236990146329f", + "rev": "3016b4b15d13f3089db8a41ef937b13a9e33a8df", "type": "github" }, "original": { - "owner": "NixOS", + "owner": "nixos", "ref": "nixos-unstable", "repo": "nixpkgs", "type": "github" } }, - "nixpkgs_3": { - "locked": { - "lastModified": 1744536153, - "narHash": "sha256-awS2zRgF4uTwrOKwwiJcByDzDOdo3Q1rPZbiHQg/N38=", - "owner": "NixOS", - "repo": "nixpkgs", - "rev": "18dd725c29603f582cf1900e0d25f9f1063dbf11", - "type": "github" - }, - "original": { - "owner": "NixOS", - "ref": "nixpkgs-unstable", - "repo": "nixpkgs", - "type": "github" - } - }, "process-compose-flake": { "locked": { "lastModified": 1749418557, @@ -154,49 +149,49 @@ }, "root": { "inputs": { - "cargo2nix": "cargo2nix", "flake-parts": "flake-parts", - "nixpkgs": "nixpkgs_2", + "git-hooks": "git-hooks", + "nixos-unified": "nixos-unified", + "nixpkgs": "nixpkgs", "process-compose-flake": "process-compose-flake", - "rust-overlay": "rust-overlay_2", + "rust-flake": "rust-flake", "services-flake": "services-flake" } }, - "rust-overlay": { + "rust-flake": { "inputs": { - "flake-utils": [ - "cargo2nix", - "flake-utils" - ], - "nixpkgs": [ - "cargo2nix", - "nixpkgs" - ] + "crane": "crane", + "globset": "globset", + "nixpkgs": "nixpkgs_2", + "rust-overlay": "rust-overlay" }, "locked": { - "lastModified": 1705112162, - "narHash": "sha256-IAM0+Uijh/fwlfoeDrOwau9MxcZW3zeDoUHc6Z3xfqM=", - "owner": "oxalica", - "repo": "rust-overlay", - "rev": "9e0af26ffe52bf955ad5575888f093e41fba0104", + "lastModified": 1751562414, + "narHash": "sha256-0ohW9/OWtkRHFteFdbhWJPGNHD00UWHjVA/qOTeuNfM=", + "owner": "juspay", + "repo": "rust-flake", + "rev": "a1c9995285b1288b3249a6ee1ac19443535bbb94", "type": "github" }, "original": { - "owner": "oxalica", - "repo": "rust-overlay", + "owner": "juspay", + "repo": "rust-flake", "type": "github" } }, - "rust-overlay_2": { + "rust-overlay": { "inputs": { - "nixpkgs": "nixpkgs_3" + "nixpkgs": [ + "rust-flake", + "nixpkgs" + ] }, "locked": { - "lastModified": 1749695868, - "narHash": "sha256-debjTLOyqqsYOUuUGQsAHskFXH5+Kx2t3dOo/FCoNRA=", + "lastModified": 1751510438, + "narHash": "sha256-m8PjOoyyCR4nhqtHEBP1tB/jF+gJYYguSZmUmVTEAQE=", "owner": "oxalica", "repo": "rust-overlay", - "rev": "55f914d5228b5c8120e9e0f9698ed5b7214d09cd", + "rev": "7f415261f298656f8164bd636c0dc05af4e95b6b", "type": "github" }, "original": { @@ -207,11 +202,11 @@ }, "services-flake": { "locked": { - "lastModified": 1749343305, - "narHash": "sha256-K4bK5OOJJlSWbJB7TbVzZQzJ694Qm7iGxOr0BpbqRpc=", + "lastModified": 1751536468, + "narHash": "sha256-lgzxvPlpx2uxkMznGBB0ID0byZBlMvcSadotcfnKIbM=", "owner": "juspay", "repo": "services-flake", - "rev": "62ef1d7436e7f07667a9b979c95ac2f706fdf3bb", + "rev": "a4c8b34362dc86a2d417aff1d0b87fbfef17a3c7", "type": "github" }, "original": { @@ -219,21 +214,6 @@ "repo": "services-flake", "type": "github" } - }, - "systems": { - "locked": { - "lastModified": 1681028828, - "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=", - "owner": "nix-systems", - "repo": "default", - "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e", - "type": "github" - }, - "original": { - "owner": "nix-systems", - "repo": "default", - "type": "github" - } } }, "root": "root", diff --git a/flake.nix b/flake.nix index 05058a75d9e..a9b99a93d19 100644 --- a/flake.nix +++ b/flake.nix @@ -5,110 +5,18 @@ nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable"; flake-parts.url = "github:hercules-ci/flake-parts"; - # TODO: Move away from these to https://github.com/juspay/rust-flake - cargo2nix.url = "github:cargo2nix/cargo2nix/release-0.11.0"; - rust-overlay.url = "github:oxalica/rust-overlay"; + rust-flake.url = "github:juspay/rust-flake"; + + nixos-unified.url = "github:srid/nixos-unified"; + + git-hooks.url = "github:cachix/git-hooks.nix"; + git-hooks.flake = false; process-compose-flake.url = "github:Platonic-Systems/process-compose-flake"; services-flake.url = "github:juspay/services-flake"; }; outputs = inputs: - inputs.flake-parts.lib.mkFlake { inherit inputs; } { - imports = [ inputs.process-compose-flake.flakeModule ]; - systems = inputs.nixpkgs.lib.systems.flakeExposed; - perSystem = { self', pkgs, lib, system, ... }: - let - cargoToml = lib.importTOML ./Cargo.toml; - rustDevVersion = "1.87.0"; - rustMsrv = cargoToml.workspace.package.rust-version; - - # Common packages - base = with pkgs; [ - diesel-cli - just - jq - openssl - pkg-config - postgresql # for libpq - protobuf - ]; - - # Minimal packages for running hyperswitch - runPackages = base ++ (with pkgs; [ - rust-bin.stable.${rustMsrv}.default - ]); - - # Development packages - devPackages = base ++ (with pkgs; [ - cargo-watch - nixd - protobuf - rust-bin.stable.${rustDevVersion}.default - swagger-cli - ]); - - # QA packages - qaPackages = devPackages ++ (with pkgs; [ - cypress - nodejs - parallel - ]); - - in - { - _module.args.pkgs = import inputs.nixpkgs { - inherit system; - overlays = [ inputs.cargo2nix.overlays.default (import inputs.rust-overlay) ]; - }; - - # Minimal shell - devShells.default = pkgs.mkShell { - name = "hyperswitch-shell"; - packages = base; - }; - - # Development shell - devShells.dev = pkgs.mkShell { - name = "hyperswitch-dev-shell"; - packages = devPackages; - }; - - # QA development shell - devShells.qa = pkgs.mkShell { - name = "hyperswitch-qa-shell"; - packages = qaPackages; - }; - - /* For running external services - - Redis - - Postgres - */ - process-compose."ext-services" = - let - developmentToml = lib.importTOML ./config/development.toml; - databaseName = developmentToml.master_database.dbname; - databaseUser = developmentToml.master_database.username; - databasePass = developmentToml.master_database.password; - in - { - imports = [ inputs.services-flake.processComposeModules.default ]; - services.redis."r1".enable = true; - /* Postgres - - Create an user and grant all privileges - - Create a database - */ - services.postgres."p1" = { - enable = true; - initialScript = { - before = "CREATE USER ${databaseUser} WITH PASSWORD '${databasePass}' SUPERUSER CREATEDB CREATEROLE INHERIT LOGIN;"; - after = "GRANT ALL PRIVILEGES ON DATABASE ${databaseName} to ${databaseUser};"; - }; - initialDatabases = [ - { name = databaseName; } - ]; - }; - }; - }; - }; + inputs.nixos-unified.lib.mkFlake + { inherit inputs; root = ./.; }; } diff --git a/nix/modules/flake/devshell.nix b/nix/modules/flake/devshell.nix new file mode 100644 index 00000000000..6df0f5951f1 --- /dev/null +++ b/nix/modules/flake/devshell.nix @@ -0,0 +1,52 @@ +{ + debug = true; + perSystem = { config, pkgs, self', ... }: + let + rustMsrv = config.rust-project.cargoToml.workspace.package.rust-version; + rustDevVersion = config.rust-project.toolchain.version; + in + { + devShells = { + default = + pkgs.mkShell { + name = "hyperswitch-shell"; + meta.description = "Environment for Hyperswitch development"; + inputsFrom = [ config.pre-commit.devShell ]; + packages = with pkgs; [ + diesel-cli + just + jq + openssl + pkg-config + postgresql # for libpq + protobuf + ]; + }; + dev = pkgs.mkShell { + name = "hyperswitch-dev-shell"; + meta.description = "Environment for Hyperswitch development with additional tools"; + inputsFrom = [ self'.devShells.default ]; + packages = with pkgs; [ + cargo-watch + nixd + rust-bin.stable.${rustDevVersion}.default + swagger-cli + ]; + shellHook = '' + echo 1>&2 "Ready to work on hyperswitch!" + rustc --version + ''; + }; + qa = pkgs.mkShell { + name = "hyperswitch-qa-shell"; + meta.description = "Environment for Hyperswitch QA"; + inputsFrom = [ self'.devShells.dev ]; + packages = with pkgs; [ + cypress + nodejs + parallel + ]; + }; + }; + }; +} diff --git a/nix/modules/flake/git-hooks.nix b/nix/modules/flake/git-hooks.nix new file mode 100644 index 00000000000..0f658711219 --- /dev/null +++ b/nix/modules/flake/git-hooks.nix @@ -0,0 +1,11 @@ +{ inputs, ... }: +{ + imports = [ + (inputs.git-hooks + /flake-module.nix) + ]; + perSystem = { ... }: { + pre-commit.settings.hooks = { + nixpkgs-fmt.enable = true; + }; + }; +} diff --git a/nix/modules/flake/rust.nix b/nix/modules/flake/rust.nix new file mode 100644 index 00000000000..2d71ade0332 --- /dev/null +++ b/nix/modules/flake/rust.nix @@ -0,0 +1,12 @@ +{ inputs, ... }: +{ + imports = [ + inputs.rust-flake.flakeModules.default + inputs.rust-flake.flakeModules.nixpkgs + ]; + perSystem = { pkgs, ... }: { + rust-project.toolchain = pkgs.rust-bin.fromRustupToolchain { + channel = "1.88.0"; + }; + }; +} diff --git a/nix/modules/flake/services.nix b/nix/modules/flake/services.nix new file mode 100644 index 00000000000..39154183af8 --- /dev/null +++ b/nix/modules/flake/services.nix @@ -0,0 +1,38 @@ +{ inputs, lib, ... }: +{ + imports = [ + inputs.process-compose-flake.flakeModule + ]; + perSystem = { ... }: { + /* For running external services + - Redis + - Postgres + */ + process-compose."ext-services" = + let + developmentToml = lib.importTOML (inputs.self + /config/development.toml); + databaseName = developmentToml.master_database.dbname; + databaseUser = developmentToml.master_database.username; + databasePass = developmentToml.master_database.password; + in + { + imports = [ inputs.services-flake.processComposeModules.default ]; + services.redis."r1".enable = true; + + /* Postgres + - Create an user and grant all privileges + - Create a database + */ + services.postgres."p1" = { + enable = true; + initialScript = { + before = "CREATE USER ${databaseUser} WITH PASSWORD '${databasePass}' SUPERUSER CREATEDB CREATEROLE INHERIT LOGIN;"; + after = "GRANT ALL PRIVILEGES ON DATABASE ${databaseName} to ${databaseUser};"; + }; + initialDatabases = [ + { name = databaseName; } + ]; + }; + }; + }; +}

2025-06-30T14:11:32Z

# Migrate Nix Configuration to rust-flake This PR refactors the existing Nix setup by migrating from `cargo2nix` to `rust-flake`. Resolves: #8538 ## TODO: - [x] **Initial port** - Port current `flake.nix` functionality using rust-flake - [x] @kashif-m The current [`flake.nix`](https://github.com/juspay/hyperswitch/blob/d305fad2e6c403fde11b9eea785fddefbf3477df/flake.nix#L63-L78) has `default`, `dev`, and `qa` shells. Are all three required? Typically we use `default` for development and additional shells for specific purposes. Currently the PR has `default` as development shell and `qa` for QA work. https://github.com/juspay/hyperswitch/blob/d305fad2e6c403fde11b9eea785fddefbf3477df/flake.nix#L63-L78 - [x] **Configuration review** - @kashif-m This ports the existing flake.nix structure, but we should discuss additional features needed and fix any broken functionality - [x] The [`flake.nix`](https://github.com/juspay/hyperswitch/blob/d305fad2e6c403fde11b9eea785fddefbf3477df/flake.nix#L23-L24) defines two rust versions: `rustDevVersion` and `rustMsrv`. The `rustMsrv` is [defined but unused](https://github.com/juspay/hyperswitch/blob/d305fad2e6c403fde11b9eea785fddefbf3477df/flake.nix#L37-L39). Is `rustDevVersion` supposed to be different from the version in `Cargo.toml`? https://github.com/juspay/hyperswitch/blob/d305fad2e6c403fde11b9eea785fddefbf3477df/flake.nix#L23-L24 - [ ] ~~Nixify Docker images using [`nix2container`](https://github.com/nlewo/nix2container)~~ (To be addressed in different PR) - [ ] ~~Additional nix integration items (to be discussed)~~ (To be addressed in different PR) - [x] **Testing** - Ensure nothing breaks and everything works as expected - [x] **Approval** - Get approval from @srid and @kashif-m ## Benefits - Reproducible builds across environments - Consistent development setup - Simplified dependency management

v1.115.0

8a7590cf60a0610863e7b6ef8a3c4b780ba03a85

juspay/hyperswitch

juspay__hyperswitch-8549

Bug: fix(revenue_recovery) : Skip record-back for failed invoices on auto-voiding billing connectors ## Description  This PR addresses two issues : #### Unnecessary record-back for certain billing processors billing processors (like Stripebilling, Recurly) automatically void invoices after 30 days and cancel the associated subscription. Because of this, we don't need to call a record-back flow for failed invoices on our end. #### PSync flow fetching incorrect transaction In the billing connector PSync flow, we were fetching invoice and transaction details using the invoice ID. However, the logic always selected the last transaction from the list, regardless of its status or relevance. This caused the retry count to not be updated correctly.

diff --git a/crates/hyperswitch_connectors/src/connectors/stripebilling.rs b/crates/hyperswitch_connectors/src/connectors/stripebilling.rs index a15ce5f1561..9d731621b77 100644 --- a/crates/hyperswitch_connectors/src/connectors/stripebilling.rs +++ b/crates/hyperswitch_connectors/src/connectors/stripebilling.rs @@ -597,7 +597,7 @@ impl connectors: &Connectors, ) -> CustomResult<String, errors::ConnectorError> { Ok(format!( - "{}v1/payment_intents/{}?expand[0]=latest_charge", + "{}v1/charges/{}", self.base_url(connectors), req.request.billing_connector_psync_id )) @@ -630,10 +630,10 @@ impl recovery_router_data_types::BillingConnectorPaymentsSyncRouterData, errors::ConnectorError, > { - let response: stripebilling::StripebillingBillingConnectorPaymentSyncResponseData = res + let response: stripebilling::StripebillingRecoveryDetailsData = res .response - .parse_struct::<stripebilling::StripebillingBillingConnectorPaymentSyncResponseData>( - "StripebillingBillingConnectorPaymentSyncResponseData", + .parse_struct::<stripebilling::StripebillingRecoveryDetailsData>( + "StripebillingRecoveryDetailsData", ) .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; @@ -805,9 +805,7 @@ impl webhooks::IncomingWebhook for Stripebilling { stripebilling::StripebillingWebhookBody::get_webhook_object_from_body(request.body) .change_context(errors::ConnectorError::WebhookReferenceIdNotFound)?; Ok(api_models::webhooks::ObjectReferenceId::PaymentId( - api_models::payments::PaymentIdType::ConnectorTransactionId( - webhook.data.object.payment_intent, - ), + api_models::payments::PaymentIdType::ConnectorTransactionId(webhook.data.object.charge), )) } diff --git a/crates/hyperswitch_connectors/src/connectors/stripebilling/transformers.rs b/crates/hyperswitch_connectors/src/connectors/stripebilling/transformers.rs index ae80cb48ea1..4cf4d2b542f 100644 --- a/crates/hyperswitch_connectors/src/connectors/stripebilling/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/stripebilling/transformers.rs @@ -426,12 +426,7 @@ impl TryFrom<StripebillingInvoiceBody> for revenue_recovery::RevenueRecoveryInvo } #[derive(Serialize, Deserialize, Debug, Clone)] -pub struct StripebillingBillingConnectorPaymentSyncResponseData { - pub latest_charge: StripebillingLatestChargeData, -} - -#[derive(Serialize, Deserialize, Debug, Clone)] -pub struct StripebillingLatestChargeData { +pub struct StripebillingRecoveryDetailsData { #[serde(rename = "id")] pub charge_id: String, pub status: StripebillingChargeStatus, @@ -517,7 +512,7 @@ impl TryFrom< ResponseRouterData< recovery_router_flows::BillingConnectorPaymentsSync, - StripebillingBillingConnectorPaymentSyncResponseData, + StripebillingRecoveryDetailsData, recovery_request_types::BillingConnectorPaymentsSyncRequest, recovery_response_types::BillingConnectorPaymentsSyncResponse, >, @@ -527,12 +522,12 @@ impl fn try_from( item: ResponseRouterData< recovery_router_flows::BillingConnectorPaymentsSync, - StripebillingBillingConnectorPaymentSyncResponseData, + StripebillingRecoveryDetailsData, recovery_request_types::BillingConnectorPaymentsSyncRequest, recovery_response_types::BillingConnectorPaymentsSyncResponse, >, ) -> Result<Self, Self::Error> { - let charge_details = item.response.latest_charge; + let charge_details = item.response; let merchant_reference_id = id_type::PaymentReferenceId::from_str(charge_details.invoice_id.as_str()) .change_context(errors::ConnectorError::MissingRequiredField { diff --git a/crates/router/src/core/revenue_recovery/types.rs b/crates/router/src/core/revenue_recovery/types.rs index c043641dabd..1e533751f0e 100644 --- a/crates/router/src/core/revenue_recovery/types.rs +++ b/crates/router/src/core/revenue_recovery/types.rs @@ -192,18 +192,6 @@ impl RevenueRecoveryPaymentsAttemptStatus { db.as_scheduler() .retry_process(process_tracker.clone(), schedule_time) .await?; - } else { - // Record a failure transaction back to Billing Connector - // TODO: Add support for retrying failed outgoing recordback webhooks - record_back_to_billing_connector( - state, - &payment_attempt, - payment_intent, - &revenue_recovery_payment_data.billing_mca, - ) - .await - .change_context(errors::RecoveryError::RecordBackToBillingConnectorFailed) - .attach_printable("Failed to record back the billing connector")?; } } Self::Processing => { @@ -504,17 +492,8 @@ impl Action { .await .change_context(errors::RecoveryError::ProcessTrackerFailure) .attach_printable("Failed to update the process tracker")?; - // Record back to billing connector for terminal status // TODO: Add support for retrying failed outgoing recordback webhooks - record_back_to_billing_connector( - state, - payment_attempt, - payment_intent, - &revenue_recovery_payment_data.billing_mca, - ) - .await - .change_context(errors::RecoveryError::RecordBackToBillingConnectorFailed) - .attach_printable("Failed to record back the billing connector")?; + Ok(()) } Self::SuccessfulPayment(payment_attempt) => { @@ -702,18 +681,7 @@ impl Action { } Self::TerminalFailure(payment_attempt) => { - // Record a failure transaction back to Billing Connector // TODO: Add support for retrying failed outgoing recordback webhooks - record_back_to_billing_connector( - state, - payment_attempt, - payment_intent, - &revenue_recovery_payment_data.billing_mca, - ) - .await - .change_context(errors::RecoveryError::RecordBackToBillingConnectorFailed) - .attach_printable("Failed to record back the billing connector")?; - // finish the current psync task db.as_scheduler() .finish_process_with_business_status(

2025-07-04T11:18:12Z

## Type of Change  - [x] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  This PR addresses two issues : #### Unnecessary record-back for certain billing processors billing processors (like Stripebilling, Recurly) automatically void invoices after 30 days and cancel the associated subscription. Because of this, we don't need to call a record-back flow for failed invoices on our end. #### PSync flow fetching incorrect transaction In the billing connector PSync flow, we were fetching invoice and transaction details using the invoice ID. However, the logic always selected the last transaction from the list, regardless of its status or relevance. This caused the retry count to not be updated correctly. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [x] This PR modifies application configuration/environment variables  ## Motivation and Context  ## How did you test it?  #### Create a mca ``` curl --location 'http://localhost:8080/v2/connector-accounts' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'x-merchant-id: cloth_seller_UtjuUuRAKVfLLLoRfZgg' \ --header 'x-profile-id: pro_oCx1cn5sCSpSnwZaw63U' \ --header 'Authorization: admin-api-key=test_admin' \ --data '{ "connector_type": "payment_processor", "connector_name": "stripe", "connector_account_details": { "auth_type": "HeaderKey", "api_key": "" }, "payment_methods_enabled": [ { "payment_method_type": "card", "payment_method_subtypes": [ { "payment_method_subtype": "credit", "payment_experience": null, "card_networks": [ "Visa", "Mastercard" ], "accepted_currencies": null, "accepted_countries": null, "minimum_amount": -1, "maximum_amount": 68607706, "recurring_enabled": true, "installment_payment_enabled": true }, { "payment_method_subtype": "debit", "payment_experience": null, "card_networks": [ "Visa", "Mastercard" ], "accepted_currencies": null, "accepted_countries": null, "minimum_amount": -1, "maximum_amount": 68607706, "recurring_enabled": true, "installment_payment_enabled": true } ] } ], "metadata": { "status_url": "https://2753-2401-4900-1cb8-2ff9-24dd-1ccf-ed12-b464.in.ngrok.io/webhooks/merchant_1678699058/globalpay", "account_name": "transaction_processing", "pricing_type": "fixed_price", "acquirer_bin": "438309", "acquirer_merchant_id": "00002000000" }, "frm_configs": null, "connector_webhook_details": { "merchant_secret": "" }, "profile_id": "" }' ``` #### Create billing processor ``` curl --location 'http://localhost:8080/v2/connector-accounts' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'x-merchant-id: cloth_seller_UtjuUuRAKVfLLLoRfZgg' \ --header 'x-profile-id: pro_oCx1cn5sCSpSnwZaw63U' \ --header 'Authorization: admin-api-key=test_admin' \ --data '{ "connector_type": "billing_processor", "connector_name": "stripebilling", "connector_account_details": { "auth_type": "HeaderKey", "api_key": "" }, "connector_webhook_details": { "merchant_secret": "secret_needed", "additional_secret": "password" }, "feature_metadata": { "revenue_recovery": { "max_retry_count": 7, "billing_connector_retry_threshold": 2, "billing_account_reference": { "mca_id": "stripebilling" } } }, "profile_id": "" }' ``` ### Webhook ``` curl --location 'http://localhost:8080/v2/webhooks/cloth_seller_UtjuUuRAKVfLLLoRfZgg/pro_oCx1cn5sCSpSnwZaw63U/mca_BRNBJA0Q8sBoqhgNrqKc' \ --header 'stripe-signature: t=1751527430,v1=d0436759f119bd0d4c32d9601b0fb7a1b0c614a41fa8774189d82f143ceb0d54,v0=d718933a2ded633f9dae5b23d642d9c819cc618dca8b055b61810e25e961b1dc' \ --header 'accept: */*; q=0.5, application/json' \ --header 'user-agent: Stripe/1.0 (+https://stripe.com/docs/webhooks)' \ --header 'cache-control: no-cache' \ --header 'content-type: application/json; charset=utf-8' \ --data '{ "id": "evt_1RghUoCZJlEh6syL2Rj25wzT", "object": "event", "api_version": "2025-02-24.acacia", "created": 1751527427, "data": { "object": { "id": "in_1RghUdCZJlEh6syL1Mn3uN6W", "object": "invoice", "account_country": "US", "account_name": "nishanth2", "account_tax_ids": null, "amount_due": 10000, "amount_overpaid": 0, "amount_paid": 0, "amount_remaining": 10000, "amount_shipping": 0, "application": null, "application_fee_amount": null, "attempt_count": 1, "attempted": true, "auto_advance": true, "automatic_tax": { "disabled_reason": null, "enabled": false, "liability": null, "provider": null, "status": null }, "automatically_finalizes_at": null, "billing_reason": "subscription_cycle", "charge": "ch_3RghUiCZJlEh6syL1A8rC285", "collection_method": "charge_automatically", "created": 1751567400, "currency": "usd", "custom_fields": null, "customer": "cus_SbvK4XDxQhrfp2", "customer_address": null, "customer_email": null, "customer_name": "Anikwet", "customer_phone": null, "customer_shipping": null, "customer_tax_exempt": "none", "customer_tax_ids": [], "default_payment_method": null, "default_source": null, "default_tax_rates": [], "description": null, "discount": null, "discounts": [], "due_date": null, "effective_at": 1751571000, "ending_balance": 0, "footer": null, "from_invoice": null, "hosted_invoice_url": "https://invoice.stripe.com/i/acct_1R156rCZJlEh6syL/test_YWNjdF8xUjE1NnJDWkpsRWg2c3lMLF9TYnZMZkJVZWxLc21ka3NnanVpcFRBaUZpdnlvdE8wLDE0MjA2ODIzMA0200ziIDipdc?s=ap", "invoice_pdf": "https://pay.stripe.com/invoice/acct_1R156rCZJlEh6syL/test_YWNjdF8xUjE1NnJDWkpsRWg2c3lMLF9TYnZMZkJVZWxLc21ka3NnanVpcFRBaUZpdnlvdE8wLDE0MjA2ODIzMA0200ziIDipdc/pdf?s=ap", "issuer": { "type": "self" }, "last_finalization_error": null, "latest_revision": null, "lines": { "object": "list", "data": [ { "id": "il_1RgrtUCZJlEh6syLIS3D3MBo", "object": "line_item", "amount": 10000, "amount_excluding_tax": 10000, "currency": "usd", "description": "1 × bhfhbwfh (at $100.00 / month)", "discount_amounts": [], "discountable": true, "discounts": [], "invoice": "in_1RghUdCZJlEh6syL1Mn3uN6W", "livemode": false, "metadata": {}, "parent": { "invoice_item_details": null, "subscription_item_details": { "invoice_item": null, "proration": false, "proration_details": { "credited_items": null }, "subscription": "sub_1RghUJCZJlEh6syLYSoCZ5DF", "subscription_item": "si_SbvKW8KTf722nZ" }, "type": "subscription_item_details" }, "period": { "end": 1754245800, "start": 1751567400 }, "plan": { "id": "price_1RNvrDCZJlEh6syLxM0yTOmJ", "object": "plan", "active": true, "aggregate_usage": null, "amount": 10000, "amount_decimal": "10000", "billing_scheme": "per_unit", "created": 1747054403, "currency": "usd", "interval": "month", "interval_count": 1, "livemode": false, "metadata": {}, "meter": null, "nickname": null, "product": "prod_SIWvOH70HUE0k4", "tiers_mode": null, "transform_usage": null, "trial_period_days": null, "usage_type": "licensed" }, "pretax_credit_amounts": [], "price": { "id": "price_1RNvrDCZJlEh6syLxM0yTOmJ", "object": "price", "active": true, "billing_scheme": "per_unit", "created": 1747054403, "currency": "usd", "custom_unit_amount": null, "livemode": false, "lookup_key": null, "metadata": {}, "nickname": null, "product": "prod_SIWvOH70HUE0k4", "recurring": { "aggregate_usage": null, "interval": "month", "interval_count": 1, "meter": null, "trial_period_days": null, "usage_type": "licensed" }, "tax_behavior": "unspecified", "tiers_mode": null, "transform_quantity": null, "type": "recurring", "unit_amount": 10000, "unit_amount_decimal": "10000" }, "pricing": { "price_details": { "price": "price_1RNvrDCZJlEh6syLxM0yTOmJ", "product": "prod_SIWvOH70HUE0k4" }, "type": "price_details", "unit_amount_decimal": "10000" }, "proration": false, "proration_details": { "credited_items": null }, "quantity": 1, "subscription": "sub_1RghUJCZJlEh6syLYSoCZ5DF", "subscription_item": "si_SbvKW8KTf722nZ", "tax_amounts": [], "tax_rates": [], "taxes": [], "type": "subscription", "unit_amount_excluding_tax": "10000" } ], "has_more": false, "total_count": 1, "url": "/v1/invoices/in_1RghUdCZJlEh6syL1Mn3uN6W/lines" }, "livemode": false, "metadata": {}, "next_payment_attempt": 1751728637, "number": "5AY2AUB1-0001", "on_behalf_of": null, "paid": false, "paid_out_of_band": false, "parent": { "quote_details": null, "subscription_details": { "metadata": {}, "subscription": "sub_1RghUJCZJlEh6syLYSoCZ5DF" }, "type": "subscription_details" }, "payment_intent": "pi_3RghUiCZJlEh6syL1nf1DJjU", "payment_settings": { "default_mandate": null, "payment_method_options": null, "payment_method_types": null }, "period_end": 1751567400, "period_start": 1751527399, "post_payment_credit_notes_amount": 0, "pre_payment_credit_notes_amount": 0, "quote": null, "receipt_number": null, "rendering": null, "shipping_cost": null, "shipping_details": null, "starting_balance": 0, "statement_descriptor": null, "status": "open", "status_transitions": { "finalized_at": 1751571000, "marked_uncollectible_at": null, "paid_at": null, "voided_at": null }, "subscription": "sub_1RghUJCZJlEh6syLYSoCZ5DF", "subscription_details": { "metadata": {} }, "subtotal": 10000, "subtotal_excluding_tax": 10000, "tax": null, "test_clock": "clock_1RghUYCZJlEh6syL7rjupJQi", "total": 10000, "total_discount_amounts": [], "total_excluding_tax": 10000, "total_pretax_credit_amounts": [], "total_tax_amounts": [], "total_taxes": [], "transfer_data": null, "webhooks_delivered_at": 1751567400 } }, "livemode": false, "pending_webhooks": 1, "request": { "id": null, "idempotency_key": null }, "type": "invoice.payment_failed" }' ``` #### Webhook 2 ``` curl --location 'http://localhost:8080/v2/webhooks/cloth_seller_UtjuUuRAKVfLLLoRfZgg/pro_oCx1cn5sCSpSnwZaw63U/mca_BRNBJA0Q8sBoqhgNrqKc' \ --header 'stripe-signature: t=1751528782,v1=3949ccd6d2cf800faabbae0d9444831d1b00b75c098e0b4a5c5be2fcfcc99c68,v0=97e97facf998e448ee86130da153924e8905ac8fc94b5fb4bd48e6382b26caac' \ --header 'accept: */*; q=0.5, application/json' \ --header 'user-agent: Stripe/1.0 (+https://stripe.com/docs/webhooks)' \ --header 'cache-control: no-cache' \ --header 'content-type: application/json; charset=utf-8' \ --header 'api-key;' \ --data '{ "id": "evt_1RghqcCZJlEh6syLWc3NGaNJ", "object": "event", "api_version": "2025-02-24.acacia", "created": 1751528781, "data": { "object": { "id": "in_1RghUdCZJlEh6syL1Mn3uN6W", "object": "invoice", "account_country": "US", "account_name": "nishanth2", "account_tax_ids": null, "amount_due": 10000, "amount_overpaid": 0, "amount_paid": 0, "amount_remaining": 10000, "amount_shipping": 0, "application": null, "application_fee_amount": null, "attempt_count": 1, "attempted": true, "auto_advance": true, "automatic_tax": { "disabled_reason": null, "enabled": false, "liability": null, "provider": null, "status": null }, "automatically_finalizes_at": null, "billing_reason": "subscription_cycle", "charge": "ch_3RghUiCZJlEh6syL17CszxuH", "collection_method": "charge_automatically", "created": 1751567400, "currency": "usd", "custom_fields": null, "customer": "cus_SbvK4XDxQhrfp2", "customer_address": null, "customer_email": null, "customer_name": "Anikwet", "customer_phone": null, "customer_shipping": null, "customer_tax_exempt": "none", "customer_tax_ids": [], "default_payment_method": null, "default_source": null, "default_tax_rates": [], "description": null, "discount": null, "discounts": [], "due_date": null, "effective_at": 1751571000, "ending_balance": 0, "footer": null, "from_invoice": null, "hosted_invoice_url": "https://invoice.stripe.com/i/acct_1R156rCZJlEh6syL/test_YWNjdF8xUjE1NnJDWkpsRWg2c3lMLF9TYnZMZkJVZWxLc21ka3NnanVpcFRBaUZpdnlvdE8wLDE0MjA2OTU4Mg0200bHHKOjrD?s=ap", "invoice_pdf": "https://pay.stripe.com/invoice/acct_1R156rCZJlEh6syL/test_YWNjdF8xUjE1NnJDWkpsRWg2c3lMLF9TYnZMZkJVZWxLc21ka3NnanVpcFRBaUZpdnlvdE8wLDE0MjA2OTU4Mg0200bHHKOjrD/pdf?s=ap", "issuer": { "type": "self" }, "last_finalization_error": null, "latest_revision": null, "lines": { "object": "list", "data": [ { "id": "il_1RgrtUCZJlEh6syLIS3D3MBo", "object": "line_item", "amount": 10000, "amount_excluding_tax": 10000, "currency": "usd", "description": "1 × bhfhbwfh (at $100.00 / month)", "discount_amounts": [], "discountable": true, "discounts": [], "invoice": "in_1RghUdCZJlEh6syL1Mn3uN6W", "livemode": false, "metadata": {}, "parent": { "invoice_item_details": null, "subscription_item_details": { "invoice_item": null, "proration": false, "proration_details": { "credited_items": null }, "subscription": "sub_1RghUJCZJlEh6syLYSoCZ5DF", "subscription_item": "si_SbvKW8KTf722nZ" }, "type": "subscription_item_details" }, "period": { "end": 1754245800, "start": 1751567400 }, "plan": { "id": "price_1RNvrDCZJlEh6syLxM0yTOmJ", "object": "plan", "active": true, "aggregate_usage": null, "amount": 10000, "amount_decimal": "10000", "billing_scheme": "per_unit", "created": 1747054403, "currency": "usd", "interval": "month", "interval_count": 1, "livemode": false, "metadata": {}, "meter": null, "nickname": null, "product": "prod_SIWvOH70HUE0k4", "tiers_mode": null, "transform_usage": null, "trial_period_days": null, "usage_type": "licensed" }, "pretax_credit_amounts": [], "price": { "id": "price_1RNvrDCZJlEh6syLxM0yTOmJ", "object": "price", "active": true, "billing_scheme": "per_unit", "created": 1747054403, "currency": "usd", "custom_unit_amount": null, "livemode": false, "lookup_key": null, "metadata": {}, "nickname": null, "product": "prod_SIWvOH70HUE0k4", "recurring": { "aggregate_usage": null, "interval": "month", "interval_count": 1, "meter": null, "trial_period_days": null, "usage_type": "licensed" }, "tax_behavior": "unspecified", "tiers_mode": null, "transform_quantity": null, "type": "recurring", "unit_amount": 10000, "unit_amount_decimal": "10000" }, "pricing": { "price_details": { "price": "price_1RNvrDCZJlEh6syLxM0yTOmJ", "product": "prod_SIWvOH70HUE0k4" }, "type": "price_details", "unit_amount_decimal": "10000" }, "proration": false, "proration_details": { "credited_items": null }, "quantity": 1, "subscription": "sub_1RghUJCZJlEh6syLYSoCZ5DF", "subscription_item": "si_SbvKW8KTf722nZ", "tax_amounts": [], "tax_rates": [], "taxes": [], "type": "subscription", "unit_amount_excluding_tax": "10000" } ], "has_more": false, "total_count": 1, "url": "/v1/invoices/in_1RghUdCZJlEh6syL1Mn3uN6W/lines" }, "livemode": false, "metadata": {}, "next_payment_attempt": 1751728637, "number": "5AY2AUB1-0001", "on_behalf_of": null, "paid": false, "paid_out_of_band": false, "parent": { "quote_details": null, "subscription_details": { "metadata": {}, "subscription": "sub_1RghUJCZJlEh6syLYSoCZ5DF" }, "type": "subscription_details" }, "payment_intent": "pi_3RghUiCZJlEh6syL1nf1DJjU", "payment_settings": { "default_mandate": null, "payment_method_options": null, "payment_method_types": null }, "period_end": 1751567400, "period_start": 1751527399, "post_payment_credit_notes_amount": 0, "pre_payment_credit_notes_amount": 0, "quote": null, "receipt_number": null, "rendering": null, "shipping_cost": null, "shipping_details": null, "starting_balance": 0, "statement_descriptor": null, "status": "open", "status_transitions": { "finalized_at": 1751571000, "marked_uncollectible_at": null, "paid_at": null, "voided_at": null }, "subscription": "sub_1RghUJCZJlEh6syLYSoCZ5DF", "subscription_details": { "metadata": {} }, "subtotal": 10000, "subtotal_excluding_tax": 10000, "tax": null, "test_clock": "clock_1RghUYCZJlEh6syL7rjupJQi", "total": 10000, "total_discount_amounts": [], "total_excluding_tax": 10000, "total_pretax_credit_amounts": [], "total_tax_amounts": [], "total_taxes": [], "transfer_data": null, "webhooks_delivered_at": 1751567400 } }, "livemode": false, "pending_webhooks": 1, "request": { "id": "req_3YsUGkNRBqgJ2c", "idempotency_key": "072f9dde-db1d-45bd-9a64-483cc341b70a" }, "type": "invoice.payment_failed" }' ``` #### Webhook 3 ``` curl --location 'http://localhost:8080/v2/webhooks/cloth_seller_UtjuUuRAKVfLLLoRfZgg/pro_oCx1cn5sCSpSnwZaw63U/mca_BRNBJA0Q8sBoqhgNrqKc' \ --header 'stripe-signature: t=1751528824,v1=4fd343c36f9b1c61a77b2f430b525ce3b435e4cbf6e58a8946752418aedf10d3,v0=b122d260854d5ad2b8f86f3bc78e09e8a19f1914e5bdf399e6a52a4da2c7190a' \ --header 'accept: */*; q=0.5, application/json' \ --header 'user-agent: Stripe/1.0 (+https://stripe.com/docs/webhooks)' \ --header 'cache-control: no-cache' \ --header 'content-type: application/json; charset=utf-8' \ --header 'api-key;' \ --data '{ "id": "evt_1RghrICZJlEh6syL9K2XJoSP", "object": "event", "api_version": "2025-02-24.acacia", "created": 1751528823, "data": { "object": { "id": "in_1RghUdCZJlEh6syL1Mn3uN6W", "object": "invoice", "account_country": "US", "account_name": "nishanth2", "account_tax_ids": null, "amount_due": 10000, "amount_overpaid": 0, "amount_paid": 0, "amount_remaining": 10000, "amount_shipping": 0, "application": null, "application_fee_amount": null, "attempt_count": 1, "attempted": true, "auto_advance": true, "automatic_tax": { "disabled_reason": null, "enabled": false, "liability": null, "provider": null, "status": null }, "automatically_finalizes_at": null, "billing_reason": "subscription_cycle", "charge": "ch_3RghUiCZJlEh6syL1aUfCKJ9", "collection_method": "charge_automatically", "created": 1751567400, "currency": "usd", "custom_fields": null, "customer": "cus_SbvK4XDxQhrfp2", "customer_address": null, "customer_email": null, "customer_name": "Anikwet", "customer_phone": null, "customer_shipping": null, "customer_tax_exempt": "none", "customer_tax_ids": [], "default_payment_method": null, "default_source": null, "default_tax_rates": [], "description": null, "discount": null, "discounts": [], "due_date": null, "effective_at": 1751571000, "ending_balance": 0, "footer": null, "from_invoice": null, "hosted_invoice_url": "https://invoice.stripe.com/i/acct_1R156rCZJlEh6syL/test_YWNjdF8xUjE1NnJDWkpsRWg2c3lMLF9TYnZMZkJVZWxLc21ka3NnanVpcFRBaUZpdnlvdE8wLDE0MjA2OTYyNA0200i196xMb2?s=ap", "invoice_pdf": "https://pay.stripe.com/invoice/acct_1R156rCZJlEh6syL/test_YWNjdF8xUjE1NnJDWkpsRWg2c3lMLF9TYnZMZkJVZWxLc21ka3NnanVpcFRBaUZpdnlvdE8wLDE0MjA2OTYyNA0200i196xMb2/pdf?s=ap", "issuer": { "type": "self" }, "last_finalization_error": null, "latest_revision": null, "lines": { "object": "list", "data": [ { "id": "il_1RgrtUCZJlEh6syLIS3D3MBo", "object": "line_item", "amount": 10000, "amount_excluding_tax": 10000, "currency": "usd", "description": "1 × bhfhbwfh (at $100.00 / month)", "discount_amounts": [], "discountable": true, "discounts": [], "invoice": "in_1RghUdCZJlEh6syL1Mn3uN6W", "livemode": false, "metadata": {}, "parent": { "invoice_item_details": null, "subscription_item_details": { "invoice_item": null, "proration": false, "proration_details": { "credited_items": null }, "subscription": "sub_1RghUJCZJlEh6syLYSoCZ5DF", "subscription_item": "si_SbvKW8KTf722nZ" }, "type": "subscription_item_details" }, "period": { "end": 1754245800, "start": 1751567400 }, "plan": { "id": "price_1RNvrDCZJlEh6syLxM0yTOmJ", "object": "plan", "active": true, "aggregate_usage": null, "amount": 10000, "amount_decimal": "10000", "billing_scheme": "per_unit", "created": 1747054403, "currency": "usd", "interval": "month", "interval_count": 1, "livemode": false, "metadata": {}, "meter": null, "nickname": null, "product": "prod_SIWvOH70HUE0k4", "tiers_mode": null, "transform_usage": null, "trial_period_days": null, "usage_type": "licensed" }, "pretax_credit_amounts": [], "price": { "id": "price_1RNvrDCZJlEh6syLxM0yTOmJ", "object": "price", "active": true, "billing_scheme": "per_unit", "created": 1747054403, "currency": "usd", "custom_unit_amount": null, "livemode": false, "lookup_key": null, "metadata": {}, "nickname": null, "product": "prod_SIWvOH70HUE0k4", "recurring": { "aggregate_usage": null, "interval": "month", "interval_count": 1, "meter": null, "trial_period_days": null, "usage_type": "licensed" }, "tax_behavior": "unspecified", "tiers_mode": null, "transform_quantity": null, "type": "recurring", "unit_amount": 10000, "unit_amount_decimal": "10000" }, "pricing": { "price_details": { "price": "price_1RNvrDCZJlEh6syLxM0yTOmJ", "product": "prod_SIWvOH70HUE0k4" }, "type": "price_details", "unit_amount_decimal": "10000" }, "proration": false, "proration_details": { "credited_items": null }, "quantity": 1, "subscription": "sub_1RghUJCZJlEh6syLYSoCZ5DF", "subscription_item": "si_SbvKW8KTf722nZ", "tax_amounts": [], "tax_rates": [], "taxes": [], "type": "subscription", "unit_amount_excluding_tax": "10000" } ], "has_more": false, "total_count": 1, "url": "/v1/invoices/in_1RghUdCZJlEh6syL1Mn3uN6W/lines" }, "livemode": false, "metadata": {}, "next_payment_attempt": 1751728637, "number": "5AY2AUB1-0001", "on_behalf_of": null, "paid": false, "paid_out_of_band": false, "parent": { "quote_details": null, "subscription_details": { "metadata": {}, "subscription": "sub_1RghUJCZJlEh6syLYSoCZ5DF" }, "type": "subscription_details" }, "payment_intent": "pi_3RghUiCZJlEh6syL1nf1DJjU", "payment_settings": { "default_mandate": null, "payment_method_options": null, "payment_method_types": null }, "period_end": 1751567400, "period_start": 1751527399, "post_payment_credit_notes_amount": 0, "pre_payment_credit_notes_amount": 0, "quote": null, "receipt_number": null, "rendering": null, "shipping_cost": null, "shipping_details": null, "starting_balance": 0, "statement_descriptor": null, "status": "open", "status_transitions": { "finalized_at": 1751571000, "marked_uncollectible_at": null, "paid_at": null, "voided_at": null }, "subscription": "sub_1RghUJCZJlEh6syLYSoCZ5DF", "subscription_details": { "metadata": {} }, "subtotal": 10000, "subtotal_excluding_tax": 10000, "tax": null, "test_clock": "clock_1RghUYCZJlEh6syL7rjupJQi", "total": 10000, "total_discount_amounts": [], "total_excluding_tax": 10000, "total_pretax_credit_amounts": [], "total_tax_amounts": [], "total_taxes": [], "transfer_data": null, "webhooks_delivered_at": 1751567400 } }, "livemode": false, "pending_webhooks": 1, "request": { "id": "req_mRsFYF3quUnlh5", "idempotency_key": "53d702db-6ee1-4964-a2bc-a6e34fe4f834" }, "type": "invoice.payment_failed" }' ``` PASSIVE_RECOVERY_WORKFLOW_EXECUTE_WORKFLOW was executed and on failure the invoice was not voided. <img width="1140" alt="Screenshot 2025-07-04 at 4 47 45 PM" src="https://github.com/user-attachments/assets/62d5a3bd-da78-46a3-bd65-e1560357e7ad" /> ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

1e6a088c04b40c7fdd5bc65c1973056bf58de764

juspay/hyperswitch

juspay__hyperswitch-8520

Bug: add `debit_routing_savings` in analytics payment attempt We need to add debit_routing_savings to the payment analytics. This will provide the savings per card network, as well as the total savings for a profile.

diff --git a/crates/analytics/docs/clickhouse/scripts/payment_attempts.sql b/crates/analytics/docs/clickhouse/scripts/payment_attempts.sql index 6673b73fedb..16815e9a33d 100644 --- a/crates/analytics/docs/clickhouse/scripts/payment_attempts.sql +++ b/crates/analytics/docs/clickhouse/scripts/payment_attempts.sql @@ -44,6 +44,7 @@ CREATE TABLE payment_attempt_queue ( `profile_id` String, `card_network` Nullable(String), `routing_approach` LowCardinality(Nullable(String)), + `debit_routing_savings` Nullable(UInt32), `sign_flag` Int8 ) ENGINE = Kafka SETTINGS kafka_broker_list = 'kafka0:29092', kafka_topic_list = 'hyperswitch-payment-attempt-events', @@ -98,6 +99,7 @@ CREATE TABLE payment_attempts ( `profile_id` String, `card_network` Nullable(String), `routing_approach` LowCardinality(Nullable(String)), + `debit_routing_savings` Nullable(UInt32), `sign_flag` Int8, INDEX connectorIndex connector TYPE bloom_filter GRANULARITY 1, INDEX paymentMethodIndex payment_method TYPE bloom_filter GRANULARITY 1, @@ -155,6 +157,7 @@ CREATE MATERIALIZED VIEW payment_attempt_mv TO payment_attempts ( `profile_id` String, `card_network` Nullable(String), `routing_approach` LowCardinality(Nullable(String)), + `debit_routing_savings` Nullable(UInt32), `sign_flag` Int8 ) AS SELECT @@ -204,6 +207,7 @@ SELECT profile_id, card_network, routing_approach, + debit_routing_savings, sign_flag FROM payment_attempt_queue diff --git a/crates/analytics/src/payments/accumulator.rs b/crates/analytics/src/payments/accumulator.rs index 20ccc634068..6d7dca22a30 100644 --- a/crates/analytics/src/payments/accumulator.rs +++ b/crates/analytics/src/payments/accumulator.rs @@ -18,6 +18,7 @@ pub struct PaymentMetricsAccumulator { pub connector_success_rate: SuccessRateAccumulator, pub payments_distribution: PaymentsDistributionAccumulator, pub failure_reasons_distribution: FailureReasonsDistributionAccumulator, + pub debit_routing: DebitRoutingAccumulator, } #[derive(Debug, Default)] @@ -58,6 +59,12 @@ pub struct ProcessedAmountAccumulator { pub total_without_retries: Option<i64>, } +#[derive(Debug, Default)] +pub struct DebitRoutingAccumulator { + pub transaction_count: u64, + pub savings_amount: u64, +} + #[derive(Debug, Default)] pub struct AverageAccumulator { pub total: u32, @@ -183,6 +190,27 @@ impl PaymentMetricAccumulator for SuccessRateAccumulator { } } +impl PaymentMetricAccumulator for DebitRoutingAccumulator { + type MetricOutput = (Option<u64>, Option<u64>, Option<u64>); + + fn add_metrics_bucket(&mut self, metrics: &PaymentMetricRow) { + if let Some(count) = metrics.count { + self.transaction_count += u64::try_from(count).unwrap_or(0); + } + if let Some(total) = metrics.total.as_ref().and_then(ToPrimitive::to_u64) { + self.savings_amount += total; + } + } + + fn collect(self) -> Self::MetricOutput { + ( + Some(self.transaction_count), + Some(self.savings_amount), + Some(0), + ) + } +} + impl PaymentMetricAccumulator for PaymentsDistributionAccumulator { type MetricOutput = ( Option<f64>, @@ -440,6 +468,9 @@ impl PaymentMetricsAccumulator { ) = self.payments_distribution.collect(); let (failure_reason_count, failure_reason_count_without_smart_retries) = self.failure_reasons_distribution.collect(); + let (debit_routed_transaction_count, debit_routing_savings, debit_routing_savings_in_usd) = + self.debit_routing.collect(); + PaymentMetricsBucketValue { payment_success_rate: self.payment_success_rate.collect(), payment_count: self.payment_count.collect(), @@ -463,6 +494,9 @@ impl PaymentMetricsAccumulator { failure_reason_count_without_smart_retries, payment_processed_amount_in_usd, payment_processed_amount_without_smart_retries_usd, + debit_routed_transaction_count, + debit_routing_savings, + debit_routing_savings_in_usd, } } } diff --git a/crates/analytics/src/payments/core.rs b/crates/analytics/src/payments/core.rs index e55ba2726af..c1922ffe924 100644 --- a/crates/analytics/src/payments/core.rs +++ b/crates/analytics/src/payments/core.rs @@ -171,6 +171,9 @@ pub async fn get_metrics( .connector_success_rate .add_metrics_bucket(&value); } + PaymentMetrics::DebitRouting | PaymentMetrics::SessionizedDebitRouting => { + metrics_builder.debit_routing.add_metrics_bucket(&value); + } PaymentMetrics::PaymentsDistribution => { metrics_builder .payments_distribution @@ -294,6 +297,33 @@ pub async fn get_metrics( if let Some(count) = collected_values.failure_reason_count_without_smart_retries { total_failure_reasons_count_without_smart_retries += count; } + if let Some(savings) = collected_values.debit_routing_savings { + let savings_in_usd = if let Some(ex_rates) = ex_rates { + id.currency + .and_then(|currency| { + i64::try_from(savings) + .inspect_err(|e| { + logger::error!( + "Debit Routing savings conversion error: {:?}", + e + ) + }) + .ok() + .and_then(|savings_i64| { + convert(ex_rates, currency, Currency::USD, savings_i64) + .inspect_err(|e| { + logger::error!("Currency conversion error: {:?}", e) + }) + .ok() + }) + }) + .map(|savings| (savings * rust_decimal::Decimal::new(100, 0)).to_u64()) + .unwrap_or_default() + } else { + None + }; + collected_values.debit_routing_savings_in_usd = savings_in_usd; + } MetricsBucketResponse { values: collected_values, dimensions: id, diff --git a/crates/analytics/src/payments/metrics.rs b/crates/analytics/src/payments/metrics.rs index 67dc50c5152..b19c661322d 100644 --- a/crates/analytics/src/payments/metrics.rs +++ b/crates/analytics/src/payments/metrics.rs @@ -15,6 +15,7 @@ use crate::{ mod avg_ticket_size; mod connector_success_rate; +mod debit_routing; mod payment_count; mod payment_processed_amount; mod payment_success_count; @@ -24,6 +25,7 @@ mod success_rate; use avg_ticket_size::AvgTicketSize; use connector_success_rate::ConnectorSuccessRate; +use debit_routing::DebitRouting; use payment_count::PaymentCount; use payment_processed_amount::PaymentProcessedAmount; use payment_success_count::PaymentSuccessCount; @@ -130,6 +132,11 @@ where .load_metrics(dimensions, auth, filters, granularity, time_range, pool) .await } + Self::DebitRouting => { + DebitRouting + .load_metrics(dimensions, auth, filters, granularity, time_range, pool) + .await + } Self::SessionizedPaymentSuccessRate => { sessionized_metrics::PaymentSuccessRate .load_metrics(dimensions, auth, filters, granularity, time_range, pool) @@ -175,6 +182,11 @@ where .load_metrics(dimensions, auth, filters, granularity, time_range, pool) .await } + Self::SessionizedDebitRouting => { + sessionized_metrics::DebitRouting + .load_metrics(dimensions, auth, filters, granularity, time_range, pool) + .await + } } } } diff --git a/crates/analytics/src/payments/metrics/debit_routing.rs b/crates/analytics/src/payments/metrics/debit_routing.rs new file mode 100644 index 00000000000..584221205cd --- /dev/null +++ b/crates/analytics/src/payments/metrics/debit_routing.rs @@ -0,0 +1,151 @@ +use std::collections::HashSet; + +use api_models::analytics::{ + payments::{PaymentDimensions, PaymentFilters, PaymentMetricsBucketIdentifier}, + Granularity, TimeRange, +}; +use common_utils::errors::ReportSwitchExt; +use diesel_models::enums as storage_enums; +use error_stack::ResultExt; +use time::PrimitiveDateTime; + +use super::PaymentMetricRow; +use crate::{ + enums::AuthInfo, + query::{Aggregate, GroupByClause, QueryBuilder, QueryFilter, SeriesBucket, ToSql, Window}, + types::{AnalyticsCollection, AnalyticsDataSource, MetricsError, MetricsResult}, +}; + +#[derive(Default)] +pub(super) struct DebitRouting; + +#[async_trait::async_trait] +impl<T> super::PaymentMetric<T> for DebitRouting +where + T: AnalyticsDataSource + super::PaymentMetricAnalytics, + PrimitiveDateTime: ToSql<T>, + AnalyticsCollection: ToSql<T>, + Granularity: GroupByClause<T>, + Aggregate<&'static str>: ToSql<T>, + Window<&'static str>: ToSql<T>, +{ + async fn load_metrics( + &self, + dimensions: &[PaymentDimensions], + auth: &AuthInfo, + filters: &PaymentFilters, + granularity: Option<Granularity>, + time_range: &TimeRange, + pool: &T, + ) -> MetricsResult<HashSet<(PaymentMetricsBucketIdentifier, PaymentMetricRow)>> { + let mut query_builder: QueryBuilder<T> = QueryBuilder::new(AnalyticsCollection::Payment); + + for dim in dimensions.iter() { + query_builder.add_select_column(dim).switch()?; + } + query_builder + .add_select_column(Aggregate::Count { + field: None, + alias: Some("count"), + }) + .switch()?; + query_builder + .add_select_column(Aggregate::Sum { + field: "debit_routing_savings", + alias: Some("total"), + }) + .switch()?; + query_builder.add_select_column("currency").switch()?; + query_builder + .add_select_column(Aggregate::Min { + field: "created_at", + alias: Some("start_bucket"), + }) + .switch()?; + query_builder + .add_select_column(Aggregate::Max { + field: "created_at", + alias: Some("end_bucket"), + }) + .switch()?; + + filters.set_filter_clause(&mut query_builder).switch()?; + + auth.set_filter_clause(&mut query_builder).switch()?; + + time_range + .set_filter_clause(&mut query_builder) + .attach_printable("Error filtering time range") + .switch()?; + + for dim in dimensions.iter() { + query_builder + .add_group_by_clause(dim) + .attach_printable("Error grouping by dimensions") + .switch()?; + } + + query_builder + .add_group_by_clause("currency") + .attach_printable("Error grouping by currency") + .switch()?; + + if let Some(granularity) = granularity { + granularity + .set_group_by_clause(&mut query_builder) + .attach_printable("Error adding granularity") + .switch()?; + } + + query_builder + .add_filter_clause( + PaymentDimensions::PaymentStatus, + storage_enums::AttemptStatus::Charged, + ) + .switch()?; + + query_builder + .execute_query::<PaymentMetricRow, _>(pool) + .await + .change_context(MetricsError::QueryBuildingError)? + .change_context(MetricsError::QueryExecutionFailure)? + .into_iter() + .map(|i| { + Ok(( + PaymentMetricsBucketIdentifier::new( + i.currency.as_ref().map(|i| i.0), + None, + i.connector.clone(), + i.authentication_type.as_ref().map(|i| i.0), + i.payment_method.clone(), + i.payment_method_type.clone(), + i.client_source.clone(), + i.client_version.clone(), + i.profile_id.clone(), + i.card_network.clone(), + i.merchant_id.clone(), + i.card_last_4.clone(), + i.card_issuer.clone(), + i.error_reason.clone(), + i.routing_approach.as_ref().map(|i| i.0), + TimeRange { + start_time: match (granularity, i.start_bucket) { + (Some(g), Some(st)) => g.clip_to_start(st)?, + _ => time_range.start_time, + }, + end_time: granularity.as_ref().map_or_else( + || Ok(time_range.end_time), + |g| i.end_bucket.map(|et| g.clip_to_end(et)).transpose(), + )?, + }, + ), + i, + )) + }) + .collect::<error_stack::Result< + HashSet<(PaymentMetricsBucketIdentifier, PaymentMetricRow)>, + crate::query::PostProcessingError, + >>() + .change_context(MetricsError::PostProcessingFailure) + } +} diff --git a/crates/analytics/src/payments/metrics/sessionized_metrics.rs b/crates/analytics/src/payments/metrics/sessionized_metrics.rs index e3a5e370534..9d10c9db008 100644 --- a/crates/analytics/src/payments/metrics/sessionized_metrics.rs +++ b/crates/analytics/src/payments/metrics/sessionized_metrics.rs @@ -1,5 +1,6 @@ mod avg_ticket_size; mod connector_success_rate; +mod debit_routing; mod failure_reasons; mod payment_count; mod payment_processed_amount; @@ -9,6 +10,7 @@ mod retries_count; mod success_rate; pub(super) use avg_ticket_size::AvgTicketSize; pub(super) use connector_success_rate::ConnectorSuccessRate; +pub(super) use debit_routing::DebitRouting; pub(super) use failure_reasons::FailureReasons; pub(super) use payment_count::PaymentCount; pub(super) use payment_processed_amount::PaymentProcessedAmount; diff --git a/crates/analytics/src/payments/metrics/sessionized_metrics/debit_routing.rs b/crates/analytics/src/payments/metrics/sessionized_metrics/debit_routing.rs new file mode 100644 index 00000000000..f7c84e1b65c --- /dev/null +++ b/crates/analytics/src/payments/metrics/sessionized_metrics/debit_routing.rs @@ -0,0 +1,152 @@ +use std::collections::HashSet; + +use api_models::analytics::{ + payments::{PaymentDimensions, PaymentFilters, PaymentMetricsBucketIdentifier}, + Granularity, TimeRange, +}; +use common_utils::errors::ReportSwitchExt; +use diesel_models::enums as storage_enums; +use error_stack::ResultExt; +use time::PrimitiveDateTime; + +use super::PaymentMetricRow; +use crate::{ + enums::AuthInfo, + query::{Aggregate, GroupByClause, QueryBuilder, QueryFilter, SeriesBucket, ToSql, Window}, + types::{AnalyticsCollection, AnalyticsDataSource, MetricsError, MetricsResult}, +}; + +#[derive(Default)] +pub(crate) struct DebitRouting; + +#[async_trait::async_trait] +impl<T> super::PaymentMetric<T> for DebitRouting +where + T: AnalyticsDataSource + super::PaymentMetricAnalytics, + PrimitiveDateTime: ToSql<T>, + AnalyticsCollection: ToSql<T>, + Granularity: GroupByClause<T>, + Aggregate<&'static str>: ToSql<T>, + Window<&'static str>: ToSql<T>, +{ + async fn load_metrics( + &self, + dimensions: &[PaymentDimensions], + auth: &AuthInfo, + filters: &PaymentFilters, + granularity: Option<Granularity>, + time_range: &TimeRange, + pool: &T, + ) -> MetricsResult<HashSet<(PaymentMetricsBucketIdentifier, PaymentMetricRow)>> { + let mut query_builder: QueryBuilder<T> = + QueryBuilder::new(AnalyticsCollection::PaymentSessionized); + + for dim in dimensions.iter() { + query_builder.add_select_column(dim).switch()?; + } + query_builder + .add_select_column(Aggregate::Count { + field: None, + alias: Some("count"), + }) + .switch()?; + query_builder + .add_select_column(Aggregate::Sum { + field: "debit_routing_savings", + alias: Some("total"), + }) + .switch()?; + query_builder.add_select_column("currency").switch()?; + query_builder + .add_select_column(Aggregate::Min { + field: "created_at", + alias: Some("start_bucket"), + }) + .switch()?; + query_builder + .add_select_column(Aggregate::Max { + field: "created_at", + alias: Some("end_bucket"), + }) + .switch()?; + + filters.set_filter_clause(&mut query_builder).switch()?; + + auth.set_filter_clause(&mut query_builder).switch()?; + + time_range + .set_filter_clause(&mut query_builder) + .attach_printable("Error filtering time range") + .switch()?; + + for dim in dimensions.iter() { + query_builder + .add_group_by_clause(dim) + .attach_printable("Error grouping by dimensions") + .switch()?; + } + + query_builder + .add_group_by_clause("currency") + .attach_printable("Error grouping by currency") + .switch()?; + + if let Some(granularity) = granularity { + granularity + .set_group_by_clause(&mut query_builder) + .attach_printable("Error adding granularity") + .switch()?; + } + + query_builder + .add_filter_clause( + PaymentDimensions::PaymentStatus, + storage_enums::AttemptStatus::Charged, + ) + .switch()?; + + query_builder + .execute_query::<PaymentMetricRow, _>(pool) + .await + .change_context(MetricsError::QueryBuildingError)? + .change_context(MetricsError::QueryExecutionFailure)? + .into_iter() + .map(|i| { + Ok(( + PaymentMetricsBucketIdentifier::new( + i.currency.as_ref().map(|i| i.0), + None, + i.connector.clone(), + i.authentication_type.as_ref().map(|i| i.0), + i.payment_method.clone(), + i.payment_method_type.clone(), + i.client_source.clone(), + i.client_version.clone(), + i.profile_id.clone(), + i.card_network.clone(), + i.merchant_id.clone(), + i.card_last_4.clone(), + i.card_issuer.clone(), + i.error_reason.clone(), + i.routing_approach.as_ref().map(|i| i.0), + TimeRange { + start_time: match (granularity, i.start_bucket) { + (Some(g), Some(st)) => g.clip_to_start(st)?, + _ => time_range.start_time, + }, + end_time: granularity.as_ref().map_or_else( + || Ok(time_range.end_time), + |g| i.end_bucket.map(|et| g.clip_to_end(et)).transpose(), + )?, + }, + ), + i, + )) + }) + .collect::<error_stack::Result< + HashSet<(PaymentMetricsBucketIdentifier, PaymentMetricRow)>, + crate::query::PostProcessingError, + >>() + .change_context(MetricsError::PostProcessingFailure) + } +} diff --git a/crates/api_models/src/analytics/payments.rs b/crates/api_models/src/analytics/payments.rs index 537d6df09d1..ec5719f1adb 100644 --- a/crates/api_models/src/analytics/payments.rs +++ b/crates/api_models/src/analytics/payments.rs @@ -111,6 +111,7 @@ pub enum PaymentMetrics { AvgTicketSize, RetriesCount, ConnectorSuccessRate, + DebitRouting, SessionizedPaymentSuccessRate, SessionizedPaymentCount, SessionizedPaymentSuccessCount, @@ -118,6 +119,7 @@ pub enum PaymentMetrics { SessionizedAvgTicketSize, SessionizedRetriesCount, SessionizedConnectorSuccessRate, + SessionizedDebitRouting, PaymentsDistribution, FailureReasons, } @@ -128,8 +130,10 @@ impl ForexMetric for PaymentMetrics { self, Self::PaymentProcessedAmount | Self::AvgTicketSize + | Self::DebitRouting | Self::SessionizedPaymentProcessedAmount | Self::SessionizedAvgTicketSize + | Self::SessionizedDebitRouting, ) } } @@ -309,6 +313,9 @@ pub struct PaymentMetricsBucketValue { pub payments_failure_rate_distribution_with_only_retries: Option<f64>, pub failure_reason_count: Option<u64>, pub failure_reason_count_without_smart_retries: Option<u64>, + pub debit_routed_transaction_count: Option<u64>, + pub debit_routing_savings: Option<u64>, + pub debit_routing_savings_in_usd: Option<u64>, } #[derive(Debug, serde::Serialize)] diff --git a/crates/api_models/src/open_router.rs b/crates/api_models/src/open_router.rs index ba53f4c1f00..f5b80383bfb 100644 --- a/crates/api_models/src/open_router.rs +++ b/crates/api_models/src/open_router.rs @@ -67,7 +67,7 @@ pub struct DecidedGateway { #[derive(Debug, Serialize, Deserialize, PartialEq, Clone)] pub struct DebitRoutingOutput { - pub co_badged_card_networks_info: Vec<CoBadgedCardNetworksInfo>, + pub co_badged_card_networks_info: CoBadgedCardNetworks, pub issuer_country: common_enums::CountryAlpha2, pub is_regulated: bool, pub regulated_name: Option<common_enums::RegulatedName>, @@ -80,19 +80,19 @@ pub struct CoBadgedCardNetworksInfo { pub saving_percentage: f64, } -impl DebitRoutingOutput { - pub fn get_co_badged_card_networks(&self) -> Vec<common_enums::CardNetwork> { - self.co_badged_card_networks_info - .iter() - .map(|data| data.network.clone()) - .collect() +#[derive(Debug, Serialize, Deserialize, PartialEq, Clone)] +pub struct CoBadgedCardNetworks(pub Vec<CoBadgedCardNetworksInfo>); + +impl CoBadgedCardNetworks { + pub fn get_card_networks(&self) -> Vec<common_enums::CardNetwork> { + self.0.iter().map(|info| info.network.clone()).collect() } } impl From<&DebitRoutingOutput> for payment_methods::CoBadgedCardData { fn from(output: &DebitRoutingOutput) -> Self { Self { - co_badged_card_networks: output.get_co_badged_card_networks(), + co_badged_card_networks_info: output.co_badged_card_networks_info.clone(), issuer_country_code: output.issuer_country, is_regulated: output.is_regulated, regulated_name: output.regulated_name.clone(), @@ -111,7 +111,7 @@ impl TryFrom<(payment_methods::CoBadgedCardData, String)> for DebitRoutingReques })?; Ok(Self { - co_badged_card_networks_info: output.co_badged_card_networks, + co_badged_card_networks_info: output.co_badged_card_networks_info.get_card_networks(), issuer_country: output.issuer_country_code, is_regulated: output.is_regulated, regulated_name: output.regulated_name, diff --git a/crates/api_models/src/payment_methods.rs b/crates/api_models/src/payment_methods.rs index 6a8f61484dc..0745fade987 100644 --- a/crates/api_models/src/payment_methods.rs +++ b/crates/api_models/src/payment_methods.rs @@ -19,7 +19,7 @@ use utoipa::{schema, ToSchema}; #[cfg(feature = "payouts")] use crate::payouts; use crate::{ - admin, enums as api_enums, + admin, enums as api_enums, open_router, payments::{self, BankCodeResponse}, }; @@ -937,14 +937,14 @@ pub struct PaymentMethodResponse { pub network_token: Option<NetworkTokenResponse>, } -#[derive(Clone, Debug, Eq, PartialEq, serde::Deserialize, serde::Serialize)] +#[derive(Clone, Debug, PartialEq, serde::Deserialize, serde::Serialize)] pub enum PaymentMethodsData { Card(CardDetailsPaymentMethod), BankDetails(PaymentMethodDataBankCreds), WalletDetails(PaymentMethodDataWalletInfo), } -#[derive(Clone, Debug, Eq, PartialEq, serde::Deserialize, serde::Serialize)] +#[derive(Clone, Debug, PartialEq, serde::Deserialize, serde::Serialize)] pub struct CardDetailsPaymentMethod { pub last4_digits: Option<String>, pub issuer_country: Option<String>, @@ -958,12 +958,33 @@ pub struct CardDetailsPaymentMethod { pub card_type: Option<String>, #[serde(default = "saved_in_locker_default")] pub saved_to_locker: bool, - pub co_badged_card_data: Option<CoBadgedCardData>, + pub co_badged_card_data: Option<CoBadgedCardDataToBeSaved>, } -#[derive(Clone, Debug, Eq, PartialEq, serde::Deserialize, serde::Serialize)] +impl From<&CoBadgedCardData> for CoBadgedCardDataToBeSaved { + fn from(co_badged_card_data: &CoBadgedCardData) -> Self { + Self { + co_badged_card_networks: co_badged_card_data + .co_badged_card_networks_info + .get_card_networks(), + issuer_country_code: co_badged_card_data.issuer_country_code, + is_regulated: co_badged_card_data.is_regulated, + regulated_name: co_badged_card_data.regulated_name.clone(), + } + } +} + +#[derive(Clone, Debug, PartialEq, serde::Deserialize, serde::Serialize)] pub struct CoBadgedCardData { - pub co_badged_card_networks: Vec<api_enums::CardNetwork>, + pub co_badged_card_networks_info: open_router::CoBadgedCardNetworks, + pub issuer_country_code: common_enums::CountryAlpha2, + pub is_regulated: bool, + pub regulated_name: Option<common_enums::RegulatedName>, +} + +#[derive(Clone, Debug, PartialEq, serde::Deserialize, serde::Serialize)] +pub struct CoBadgedCardDataToBeSaved { + pub co_badged_card_networks: Vec<common_enums::CardNetwork>, pub issuer_country_code: common_enums::CountryAlpha2, pub is_regulated: bool, pub regulated_name: Option<common_enums::RegulatedName>, @@ -1325,7 +1346,7 @@ impl From<(CardDetailFromLocker, Option<&CoBadgedCardData>)> for CardDetailsPaym card_network: item.card_network, card_type: item.card_type, saved_to_locker: item.saved_to_locker, - co_badged_card_data: co_badged_card_data.cloned(), + co_badged_card_data: co_badged_card_data.map(CoBadgedCardDataToBeSaved::from), } } } diff --git a/crates/hyperswitch_domain_models/src/api.rs b/crates/hyperswitch_domain_models/src/api.rs index f6d93497627..723cc458e7b 100644 --- a/crates/hyperswitch_domain_models/src/api.rs +++ b/crates/hyperswitch_domain_models/src/api.rs @@ -7,7 +7,7 @@ use common_utils::{ use super::payment_method_data::PaymentMethodData; -#[derive(Debug, Eq, PartialEq)] +#[derive(Debug, PartialEq)] pub enum ApplicationResponse<R> { Json(R), StatusOk, @@ -54,7 +54,7 @@ impl<T: ApiEventMetric> ApiEventMetric for ApplicationResponse<T> { impl_api_event_type!(Miscellaneous, (PaymentLinkFormData, GenericLinkFormData)); -#[derive(Debug, Eq, PartialEq)] +#[derive(Debug, PartialEq)] pub struct RedirectionFormData { pub redirect_form: crate::router_response_types::RedirectForm, pub payment_method_data: Option<PaymentMethodData>, diff --git a/crates/hyperswitch_domain_models/src/payment_method_data.rs b/crates/hyperswitch_domain_models/src/payment_method_data.rs index 5433c486fbe..7a420010657 100644 --- a/crates/hyperswitch_domain_models/src/payment_method_data.rs +++ b/crates/hyperswitch_domain_models/src/payment_method_data.rs @@ -24,7 +24,7 @@ use time::Date; // We need to derive Serialize and Deserialize because some parts of payment method data are being // stored in the database as serde_json::Value -#[derive(Eq, PartialEq, Clone, Debug, Serialize, Deserialize)] +#[derive(PartialEq, Clone, Debug, Serialize, Deserialize)] pub enum PaymentMethodData { Card(Card), CardDetailsForNetworkTransactionId(CardDetailsForNetworkTransactionId), @@ -88,9 +88,21 @@ impl PaymentMethodData { None } } + + pub fn extract_debit_routing_saving_percentage( + &self, + network: &common_enums::CardNetwork, + ) -> Option<f64> { + self.get_co_badged_card_data()? + .co_badged_card_networks_info + .0 + .iter() + .find(|info| &info.network == network) + .map(|info| info.saving_percentage) + } } -#[derive(Eq, PartialEq, Clone, Debug, Serialize, Deserialize, Default)] +#[derive(PartialEq, Clone, Debug, Serialize, Deserialize, Default)] pub struct Card { pub card_number: cards::CardNumber, pub card_exp_month: Secret<String>, @@ -120,7 +132,7 @@ pub struct CardDetailsForNetworkTransactionId { pub card_holder_name: Option<Secret<String>>, } -#[derive(Eq, PartialEq, Clone, Debug, Serialize, Deserialize, Default)] +#[derive(PartialEq, Clone, Debug, Serialize, Deserialize, Default)] pub struct CardDetail { pub card_number: cards::CardNumber, pub card_exp_month: Secret<String>, @@ -1961,7 +1973,7 @@ impl From<GooglePayWalletData> for payment_methods::PaymentMethodDataWalletInfo } } -#[derive(Clone, Debug, Eq, PartialEq, serde::Deserialize, serde::Serialize)] +#[derive(Clone, Debug, PartialEq, serde::Deserialize, serde::Serialize)] pub enum PaymentMethodsData { Card(CardDetailsPaymentMethod), BankDetails(payment_methods::PaymentMethodDataBankCreds), //PaymentMethodDataBankCreds and its transformations should be moved to the domain models @@ -2005,7 +2017,7 @@ fn saved_in_locker_default() -> bool { } #[cfg(feature = "v1")] -#[derive(Clone, Debug, Eq, PartialEq, serde::Deserialize, serde::Serialize)] +#[derive(Clone, Debug, PartialEq, serde::Deserialize, serde::Serialize)] pub struct CardDetailsPaymentMethod { pub last4_digits: Option<String>, pub issuer_country: Option<String>, diff --git a/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs b/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs index 2b568b70af8..3baddfa98c5 100644 --- a/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs +++ b/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs @@ -9,14 +9,12 @@ use common_types::primitive_wrappers::{ }; #[cfg(feature = "v2")] use common_utils::{ - crypto::Encryptable, - encryption::Encryption, - ext_traits::{Encode, ValueExt}, + crypto::Encryptable, encryption::Encryption, ext_traits::Encode, types::keymanager::ToEncryptable, }; use common_utils::{ errors::{CustomResult, ValidationError}, - ext_traits::OptionExt, + ext_traits::{OptionExt, ValueExt}, id_type, pii, types::{ keymanager::{self, KeyManagerState}, @@ -906,6 +904,7 @@ pub struct PaymentAttempt { pub setup_future_usage_applied: Option<storage_enums::FutureUsage>, pub routing_approach: Option<storage_enums::RoutingApproach>, pub connector_request_reference_id: Option<String>, + pub debit_routing_savings: Option<MinorUnit>, } #[cfg(feature = "v1")] @@ -1063,6 +1062,10 @@ impl PaymentAttempt { pub fn get_total_surcharge_amount(&self) -> Option<MinorUnit> { self.amount_details.surcharge_amount } + + pub fn extract_card_network(&self) -> Option<common_enums::CardNetwork> { + todo!() + } } #[cfg(feature = "v1")] @@ -1074,6 +1077,25 @@ impl PaymentAttempt { pub fn get_total_surcharge_amount(&self) -> Option<MinorUnit> { self.net_amount.get_total_surcharge_amount() } + + pub fn set_debit_routing_savings(&mut self, debit_routing_savings: Option<&MinorUnit>) { + self.debit_routing_savings = debit_routing_savings.copied(); + } + + pub fn extract_card_network(&self) -> Option<common_enums::CardNetwork> { + self.payment_method_data + .as_ref() + .and_then(|value| { + value + .clone() + .parse_value::<api_models::payments::AdditionalPaymentData>( + "AdditionalPaymentData", + ) + .ok() + }) + .and_then(|data| data.get_additional_card_info()) + .and_then(|card_info| card_info.card_network) + } } #[derive(Clone, Debug, Eq, PartialEq)] @@ -1283,6 +1305,7 @@ pub enum PaymentAttemptUpdate { connector_mandate_detail: Option<ConnectorMandateReferenceId>, charges: Option<common_types::payments::ConnectorChargeResponseData>, setup_future_usage_applied: Option<storage_enums::FutureUsage>, + debit_routing_savings: Option<MinorUnit>, }, UnresolvedResponseUpdate { status: storage_enums::AttemptStatus, @@ -1566,6 +1589,7 @@ impl PaymentAttemptUpdate { connector_mandate_detail, charges, setup_future_usage_applied, + debit_routing_savings: _, } => DieselPaymentAttemptUpdate::ResponseUpdate { status, connector, @@ -1756,6 +1780,35 @@ impl PaymentAttemptUpdate { }, } } + + pub fn get_debit_routing_savings(&self) -> Option<&MinorUnit> { + match self { + Self::ResponseUpdate { + debit_routing_savings, + .. + } => debit_routing_savings.as_ref(), + Self::Update { .. } + | Self::UpdateTrackers { .. } + | Self::AuthenticationTypeUpdate { .. } + | Self::ConfirmUpdate { .. } + | Self::RejectUpdate { .. } + | Self::BlocklistUpdate { .. } + | Self::PaymentMethodDetailsUpdate { .. } + | Self::ConnectorMandateDetailUpdate { .. } + | Self::VoidUpdate { .. } + | Self::UnresolvedResponseUpdate { .. } + | Self::StatusUpdate { .. } + | Self::ErrorUpdate { .. } + | Self::CaptureUpdate { .. } + | Self::AmountToCaptureUpdate { .. } + | Self::PreprocessingUpdate { .. } + | Self::ConnectorResponse { .. } + | Self::IncrementalAuthorizationAmountUpdate { .. } + | Self::AuthenticationUpdate { .. } + | Self::ManualUpdate { .. } + | Self::PostSessionTokensUpdate { .. } => None, + } + } } #[cfg(feature = "v2")] @@ -2033,6 +2086,7 @@ impl behaviour::Conversion for PaymentAttempt { setup_future_usage_applied: storage_model.setup_future_usage_applied, routing_approach: storage_model.routing_approach, connector_request_reference_id: storage_model.connector_request_reference_id, + debit_routing_savings: None, }) } .await diff --git a/crates/router/src/core/debit_routing.rs b/crates/router/src/core/debit_routing.rs index 4975ffc4bd1..d4f7c8bd753 100644 --- a/crates/router/src/core/debit_routing.rs +++ b/crates/router/src/core/debit_routing.rs @@ -281,7 +281,10 @@ where &profile_id, &key_store, vec![connector_data.clone()], - debit_routing_output.get_co_badged_card_networks(), + debit_routing_output + .co_badged_card_networks_info + .clone() + .get_card_networks(), ) .await .map_err(|error| { @@ -454,7 +457,10 @@ where &profile_id, &key_store, connector_data_list.clone(), - debit_routing_output.get_co_badged_card_networks(), + debit_routing_output + .co_badged_card_networks_info + .clone() + .get_card_networks(), ) .await .map_err(|error| { diff --git a/crates/router/src/core/payment_methods.rs b/crates/router/src/core/payment_methods.rs index 4b1cff09be2..e8e5b2040ed 100644 --- a/crates/router/src/core/payment_methods.rs +++ b/crates/router/src/core/payment_methods.rs @@ -865,12 +865,15 @@ fn get_card_network_with_us_local_debit_network_override( .map(|network| network.is_us_local_network()) { services::logger::debug!("Card network is a US local network, checking for global network in co-badged card data"); - co_badged_card_data.and_then(|data| { - data.co_badged_card_networks - .iter() - .find(|network| network.is_global_network()) - .cloned() - }) + let info: Option<api_models::open_router::CoBadgedCardNetworksInfo> = co_badged_card_data + .and_then(|data| { + data.co_badged_card_networks_info + .0 + .iter() + .find(|info| info.network.is_global_network()) + .cloned() + }); + info.map(|data| data.network) } else { card_network } diff --git a/crates/router/src/core/payment_methods/tokenize.rs b/crates/router/src/core/payment_methods/tokenize.rs index 3556673510c..f0eaea45d98 100644 --- a/crates/router/src/core/payment_methods/tokenize.rs +++ b/crates/router/src/core/payment_methods/tokenize.rs @@ -272,8 +272,12 @@ where card_network: card_details.card_network.clone(), card_type: card_details.card_type.clone(), saved_to_locker, - co_badged_card_data: card_details.co_badged_card_data.clone(), + co_badged_card_data: card_details + .co_badged_card_data + .as_ref() + .map(|data| data.into()), }); + create_encrypted_data(&self.state.into(), self.key_store, pm_data) .await .inspect_err(|err| logger::info!("Error encrypting payment method data: {:?}", err)) diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs index b12704aab1f..1d5e2a7b4af 100644 --- a/crates/router/src/core/payments.rs +++ b/crates/router/src/core/payments.rs @@ -471,7 +471,7 @@ where // To perform router related operation for PaymentResponse PaymentResponse: Operation<F, FData, Data = D>, - FData: Send + Sync + Clone, + FData: Send + Sync + Clone + router_types::Capturable, { let operation: BoxedOperation<'_, F, Req, D> = Box::new(operation); @@ -1844,7 +1844,7 @@ pub async fn payments_core<F, Res, Req, Op, FData, D>( ) -> RouterResponse<Res> where F: Send + Clone + Sync, - FData: Send + Sync + Clone, + FData: Send + Sync + Clone + router_types::Capturable, Op: Operation<F, Req, Data = D> + Send + Sync + Clone, Req: Debug + Authenticate + Clone, D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, diff --git a/crates/router/src/core/payments/helpers.rs b/crates/router/src/core/payments/helpers.rs index d855ca84e18..9065dcd2ce3 100644 --- a/crates/router/src/core/payments/helpers.rs +++ b/crates/router/src/core/payments/helpers.rs @@ -44,6 +44,7 @@ use hyperswitch_domain_models::{ use hyperswitch_interfaces::integrity::{CheckIntegrity, FlowIntegrity, GetIntegrityObject}; use josekit::jwe; use masking::{ExposeInterface, PeekInterface, SwitchStrategy}; +use num_traits::{FromPrimitive, ToPrimitive}; use openssl::{ derive::Deriver, pkey::PKey, @@ -52,6 +53,7 @@ use openssl::{ #[cfg(feature = "v2")] use redis_interface::errors::RedisError; use router_env::{instrument, logger, tracing}; +use rust_decimal::Decimal; use serde::{Deserialize, Serialize}; use uuid::Uuid; use x509_parser::parse_x509_certificate; @@ -5208,6 +5210,54 @@ pub fn get_applepay_metadata( }) } +pub fn calculate_debit_routing_savings(net_amount: i64, saving_percentage: f64) -> MinorUnit { + logger::debug!( + ?net_amount, + ?saving_percentage, + "Calculating debit routing saving amount" + ); + + let net_decimal = Decimal::from_i64(net_amount).unwrap_or_else(|| { + logger::warn!(?net_amount, "Invalid net_amount, using 0"); + Decimal::ZERO + }); + + let percentage_decimal = Decimal::from_f64(saving_percentage).unwrap_or_else(|| { + logger::warn!(?saving_percentage, "Invalid saving_percentage, using 0"); + Decimal::ZERO + }); + + let savings_decimal = net_decimal * percentage_decimal / Decimal::from(100); + let rounded_savings = savings_decimal.round(); + + let savings_int = rounded_savings.to_i64().unwrap_or_else(|| { + logger::warn!( + ?rounded_savings, + "Debit routing savings calculation overflowed when converting to i64" + ); + 0 + }); + + MinorUnit::new(savings_int) +} + +pub fn get_debit_routing_savings_amount( + payment_method_data: &domain::PaymentMethodData, + payment_attempt: &PaymentAttempt, +) -> Option<MinorUnit> { + let card_network = payment_attempt.extract_card_network()?; + + let saving_percentage = + payment_method_data.extract_debit_routing_saving_percentage(&card_network)?; + + let net_amount = payment_attempt.get_total_amount().get_amount_as_i64(); + + Some(calculate_debit_routing_savings( + net_amount, + saving_percentage, + )) +} + #[cfg(all(feature = "retry", feature = "v1"))] pub async fn get_apple_pay_retryable_connectors<F, D>( state: &SessionState, diff --git a/crates/router/src/core/payments/operations/payment_response.rs b/crates/router/src/core/payments/operations/payment_response.rs index 939679ef51f..e72555b2ede 100644 --- a/crates/router/src/core/payments/operations/payment_response.rs +++ b/crates/router/src/core/payments/operations/payment_response.rs @@ -1767,6 +1767,14 @@ async fn payment_response_update_tracker<F: Clone, T: types::Capturable>( let payment_method_id = payment_data.payment_attempt.payment_method_id.clone(); + let debit_routing_savings = + payment_data.payment_method_data.as_ref().and_then(|data| { + payments_helpers::get_debit_routing_savings_amount( + data, + &payment_data.payment_attempt, + ) + }); + utils::add_apple_pay_payment_status_metrics( router_data.status, router_data.apple_pay_flow.clone(), @@ -1857,6 +1865,7 @@ async fn payment_response_update_tracker<F: Clone, T: types::Capturable>( setup_future_usage_applied: payment_data .payment_attempt .setup_future_usage_applied, + debit_routing_savings, }), ), }; diff --git a/crates/router/src/core/payments/retry.rs b/crates/router/src/core/payments/retry.rs index 728396ef530..f7d8b3e888b 100644 --- a/crates/router/src/core/payments/retry.rs +++ b/crates/router/src/core/payments/retry.rs @@ -48,7 +48,7 @@ pub async fn do_gsm_actions<F, ApiRequest, FData, D>( ) -> RouterResult<types::RouterData<F, FData, types::PaymentsResponseData>> where F: Clone + Send + Sync, - FData: Send + Sync, + FData: Send + Sync + types::Capturable, payments::PaymentResponse: operations::Operation<F, FData>, D: payments::OperationSessionGetters<F> + payments::OperationSessionSetters<F> @@ -345,7 +345,7 @@ pub async fn do_retry<F, ApiRequest, FData, D>( ) -> RouterResult<types::RouterData<F, FData, types::PaymentsResponseData>> where F: Clone + Send + Sync, - FData: Send + Sync, + FData: Send + Sync + types::Capturable, payments::PaymentResponse: operations::Operation<F, FData>, D: payments::OperationSessionGetters<F> + payments::OperationSessionSetters<F> @@ -425,7 +425,7 @@ pub async fn modify_trackers<F, FData, D>( ) -> RouterResult<()> where F: Clone + Send, - FData: Send, + FData: Send + types::Capturable, D: payments::OperationSessionGetters<F> + payments::OperationSessionSetters<F> + Send + Sync, { let new_attempt_count = payment_data.get_payment_intent().attempt_count + 1; @@ -451,6 +451,13 @@ where .and_then(|connector_response| connector_response.additional_payment_method_data), )?; + let debit_routing_savings = payment_data.get_payment_method_data().and_then(|data| { + payments::helpers::get_debit_routing_savings_amount( + data, + payment_data.get_payment_attempt(), + ) + }); + match router_data.response { Ok(types::PaymentsResponseData::TransactionResponse { resource_id, @@ -506,6 +513,7 @@ where connector_mandate_detail: None, charges, setup_future_usage_applied: None, + debit_routing_savings, }; #[cfg(feature = "v1")] diff --git a/crates/router/src/core/routing/transformers.rs b/crates/router/src/core/routing/transformers.rs index 6560e6786c8..b13dee1bcb4 100644 --- a/crates/router/src/core/routing/transformers.rs +++ b/crates/router/src/core/routing/transformers.rs @@ -180,7 +180,7 @@ impl OpenRouterDecideGatewayRequestExt for OpenRouterDecideGatewayRequest { Self { payment_info: PaymentInfo { payment_id: attempt.payment_id.clone(), - amount: attempt.net_amount.get_order_amount(), + amount: attempt.net_amount.get_total_amount(), currency: attempt.currency.unwrap_or(storage_enums::Currency::USD), payment_type: "ORDER_PAYMENT".to_string(), card_isin: card_isin.map(|value| value.peek().clone()), diff --git a/crates/router/src/db/kafka_store.rs b/crates/router/src/db/kafka_store.rs index 7f24d2f5c99..68af56f2262 100644 --- a/crates/router/src/db/kafka_store.rs +++ b/crates/router/src/db/kafka_store.rs @@ -1520,11 +1520,18 @@ impl PaymentAttemptInterface for KafkaStore { payment_attempt: storage::PaymentAttemptUpdate, storage_scheme: MerchantStorageScheme, ) -> CustomResult<storage::PaymentAttempt, errors::StorageError> { - let attempt = self + let mut attempt = self .diesel_store - .update_payment_attempt_with_attempt_id(this.clone(), payment_attempt, storage_scheme) + .update_payment_attempt_with_attempt_id( + this.clone(), + payment_attempt.clone(), + storage_scheme, + ) .await?; + let debit_routing_savings = payment_attempt.get_debit_routing_savings(); + + attempt.set_debit_routing_savings(debit_routing_savings); if let Err(er) = self .kafka_producer .log_payment_attempt(&attempt, Some(this), self.tenant_id.clone()) diff --git a/crates/router/src/services/kafka/payment_attempt.rs b/crates/router/src/services/kafka/payment_attempt.rs index f51e5a12d29..e0dbc6ad213 100644 --- a/crates/router/src/services/kafka/payment_attempt.rs +++ b/crates/router/src/services/kafka/payment_attempt.rs @@ -70,6 +70,7 @@ pub struct KafkaPaymentAttempt<'a> { pub card_network: Option<String>, pub card_discovery: Option<String>, pub routing_approach: Option<storage_enums::RoutingApproach>, + pub debit_routing_savings: Option<MinorUnit>, } #[cfg(feature = "v1")] @@ -132,6 +133,7 @@ impl<'a> KafkaPaymentAttempt<'a> { .card_discovery .map(|discovery| discovery.to_string()), routing_approach: attempt.routing_approach, + debit_routing_savings: attempt.debit_routing_savings, } } } diff --git a/crates/router/src/services/kafka/payment_attempt_event.rs b/crates/router/src/services/kafka/payment_attempt_event.rs index e2a88e2c29d..a54ff3cc28a 100644 --- a/crates/router/src/services/kafka/payment_attempt_event.rs +++ b/crates/router/src/services/kafka/payment_attempt_event.rs @@ -71,6 +71,7 @@ pub struct KafkaPaymentAttemptEvent<'a> { pub card_network: Option<String>, pub card_discovery: Option<String>, pub routing_approach: Option<storage_enums::RoutingApproach>, + pub debit_routing_savings: Option<MinorUnit>, } #[cfg(feature = "v1")] @@ -133,6 +134,7 @@ impl<'a> KafkaPaymentAttemptEvent<'a> { .card_discovery .map(|discovery| discovery.to_string()), routing_approach: attempt.routing_approach, + debit_routing_savings: attempt.debit_routing_savings, } } } diff --git a/crates/storage_impl/src/mock_db/payment_attempt.rs b/crates/storage_impl/src/mock_db/payment_attempt.rs index 88ddc824b2f..ec27f9bed65 100644 --- a/crates/storage_impl/src/mock_db/payment_attempt.rs +++ b/crates/storage_impl/src/mock_db/payment_attempt.rs @@ -237,6 +237,7 @@ impl PaymentAttemptInterface for MockDb { setup_future_usage_applied: payment_attempt.setup_future_usage_applied, routing_approach: payment_attempt.routing_approach, connector_request_reference_id: payment_attempt.connector_request_reference_id, + debit_routing_savings: None, }; payment_attempts.push(payment_attempt.clone()); Ok(payment_attempt) diff --git a/crates/storage_impl/src/payments/payment_attempt.rs b/crates/storage_impl/src/payments/payment_attempt.rs index 2c69c0766ba..b3fccea353e 100644 --- a/crates/storage_impl/src/payments/payment_attempt.rs +++ b/crates/storage_impl/src/payments/payment_attempt.rs @@ -689,6 +689,7 @@ impl<T: DatabaseStore> PaymentAttemptInterface for KVRouterStore<T> { connector_request_reference_id: payment_attempt .connector_request_reference_id .clone(), + debit_routing_savings: None, }; let field = format!("pa_{}", created_attempt.attempt_id); @@ -1989,6 +1990,7 @@ impl DataModelExt for PaymentAttempt { setup_future_usage_applied: storage_model.setup_future_usage_applied, routing_approach: storage_model.routing_approach, connector_request_reference_id: storage_model.connector_request_reference_id, + debit_routing_savings: None, } } }

2025-07-02T07:21:14Z

- [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  This pull request introduces a new feature to track and analyze debit routing savings and integrates it across multiple components of the analytics system. It also refactors the handling of co-badged card networks to provide additional details, such as saving percentages. Below is a breakdown of the most important changes grouped by theme: ### Debit Routing Analytics Integration: * Added a new column `debit_routing_savings` to the `payment_attempt_queue`, `payment_attempts`, and `payment_attempt_mv` tables in ClickHouse for tracking debit routing savings. * Updated the `PaymentMetricsAccumulator` struct to include a new `DebitRoutingAccumulator`, which tracks transaction counts and savings amounts. Implemented the necessary methods for metric collection and aggregation. * Introduced a new `PaymentMetrics::DebitRouting` enum variant and its corresponding implementation to load metrics, process data, and convert savings to USD. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  ## How did you test it?  -> Enable debit routing for a profile -> Configure adyen connector with local debit networks enabled -> Make some debit routing payments ``` { "amount": 1, "amount_to_capture": 1, "currency": "USD", "confirm": true, "capture_method": "automatic", "setup_future_usage": "on_session", "capture_on": "2022-09-10T10:11:12Z", "email": "[email protected]", "name": "John Doe", "phone": "999999999", "phone_country_code": "+1", "description": "Its my first payment request", "authentication_type": "no_three_ds", "customer_id": "cu_{{$timestamp}}", "return_url": "http://127.0.0.1:4040", "payment_method": "card", "payment_method_type": "debit", "payment_method_data": { "card": { "card_number": "4000 0330 0330 0335", "card_exp_month": "03", "card_exp_year": "2030", "card_holder_name": "joseph Doe", "card_cvc": "737" } }, "billing": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San", "state": "California", "zip": "94122", "country": "US", "first_name": "PiX", "last_name": "ss" }, "email": "[email protected]" }, "shipping": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "PiX" } }, "customer_acceptance": { "acceptance_type": "offline", "accepted_at": "1963-05-03T04:07:52.723Z", "online": { "ip_address": "in sit", "user_agent": "amet irure esse" } }, "browser_info": { "user_agent": "Mozilla\/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/70.0.3538.110 Safari\/537.36", "accept_header": "text\/html,application\/xhtml+xml,application\/xml;q=0.9,image\/webp,image\/apng,*\/*;q=0.8", "language": "nl-NL", "color_depth": 24, "screen_height": 723, "screen_width": 1536, "time_zone": 0, "java_enabled": true, "java_script_enabled": true, "ip_address": "125.0.0.1" }, "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "metadata": { "udf1": "value1", "new_customer": "true", "login_date": "2019-09-10T10:11:12Z" } } ``` ``` { "payment_id": "pay_xrXjk0rlKJG83LNngQ2B", "merchant_id": "merchant_1751293949", "status": "succeeded", "amount": 150000, "net_amount": 150000, "shipping_cost": null, "amount_capturable": 0, "amount_received": 150000, "connector": "adyen", "client_secret": "pay_xrXjk0rlKJG83LNngQ2B_secret_doz5GI9CEnlmcQoBpiNT", "created": "2025-06-30T15:09:44.649Z", "currency": "USD", "customer_id": "cu_1751296185", "customer": { "id": "cu_1751296185", "name": "John Doe", "email": "[email protected]", "phone": "999999999", "phone_country_code": "+1" }, "description": "Its my first payment request", "refunds": null, "disputes": null, "attempts": [ { "attempt_id": "pay_xrXjk0rlKJG83LNngQ2B_1", "status": "charged", "amount": 150000, "order_tax_amount": null, "currency": "USD", "connector": "adyen", "error_message": null, "payment_method": "card", "connector_transaction_id": "KGRXNH7KQZ9TPM75", "capture_method": "automatic", "authentication_type": "no_three_ds", "created_at": "2025-06-30T15:09:44.649Z", "modified_at": "2025-06-30T15:09:45.587Z", "cancellation_reason": null, "mandate_id": null, "error_code": null, "payment_token": null, "connector_metadata": null, "payment_experience": null, "payment_method_type": "debit", "reference_id": "pay_xrXjk0rlKJG83LNngQ2B_1", "unified_code": null, "unified_message": null, "client_source": null, "client_version": null } ], "mandate_id": null, "mandate_data": null, "setup_future_usage": "on_session", "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "card", "payment_method_data": { "card": { "last4": "0335", "card_type": null, "card_network": "Nyce", "card_issuer": null, "card_issuing_country": null, "card_isin": "400003", "card_extended_bin": null, "card_exp_month": "03", "card_exp_year": "2030", "card_holder_name": "joseph Doe", "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "PiX", "last_name": null }, "phone": null, "email": null }, "billing": { "address": { "city": "San", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "PiX", "last_name": "ss" }, "phone": null, "email": "[email protected]" }, "order_details": null, "email": "[email protected]", "name": "John Doe", "phone": "999999999", "return_url": "http://127.0.0.1:4040/", "authentication_type": "no_three_ds", "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "debit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": false, "connector_transaction_id": "KGRXNH7KQZ9TPM75", "frm_message": null, "metadata": { "udf1": "value1", "login_date": "2019-09-10T10:11:12Z", "new_customer": "true" }, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_xrXjk0rlKJG83LNngQ2B_1", "payment_link": null, "profile_id": "pro_0YmTwtjkst9iUDkg4R5D", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_d1x2St1F4pbgEFYNmxOV", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-06-30T15:24:44.649Z", "fingerprint": null, "browser_info": { "language": "nl-NL", "time_zone": 0, "ip_address": "125.0.0.1", "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "color_depth": 24, "java_enabled": true, "screen_width": 1536, "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8", "screen_height": 723, "java_script_enabled": true }, "payment_method_id": "pm_pRJ3v7spaJ1pfIsMlAqD", "payment_method_status": "active", "updated": "2025-06-30T15:09:45.566Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` -> Payment FIlters ``` curl --location 'http://localhost:8080/analytics/v1/org/filters/payments' \ --header 'Accept: */*' \ --header 'Accept-Language: en-US,en;q=0.9' \ --header 'Connection: keep-alive' \ --header 'Content-Type: application/json' \ --header 'Origin: http://localhost:9000' \ --header 'Referer: http://localhost:9000/' \ --header 'Sec-Fetch-Dest: empty' \ --header 'Sec-Fetch-Mode: cors' \ --header 'Sec-Fetch-Site: same-site' \ --header 'User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/128.0.0.0 Safari/537.36' \ --header 'api-key: hyperswitch' \ --header 'authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiZTAxZDlhMzgtMDdlMi00ZmFiLTg3ZmYtZWU0NmE2YTU2MDlhIiwibWVyY2hhbnRfaWQiOiJtZXJjaGFudF8xNzUxMjkzOTQ5Iiwicm9sZV9pZCI6Im9yZ19hZG1pbiIsImV4cCI6MTc1MTQ2Njc1MSwib3JnX2lkIjoib3JnX2tOa2k3aXBKS1h4NFc3bGVJU3FQIiwicHJvZmlsZV9pZCI6InByb18wWW1Ud3Rqa3N0OWlVRGtnNFI1RCIsInRlbmFudF9pZCI6InB1YmxpYyJ9.jty5ccBH_Em-odSAlde-FQLMC34aoGdV_UYsJFoUN-w' \ --header 'sec-ch-ua: "Chromium";v="128", "Not;A=Brand";v="24", "Google Chrome";v="128"' \ --header 'sec-ch-ua-mobile: ?0' \ --header 'sec-ch-ua-platform: "macOS"' \ --data '{ "timeRange": { "startTime": "2024-09-03T18:30:00.000Z", "endTime": "2025-09-12T09:22:30.000Z" }, "groupByNames": [ "connector", "payment_method", "payment_method_type", "currency", "authentication_type", "status", "client_source", "client_version", "profile_id", "routing_approach" ], "source": "BATCH", "delta": true }' ``` ``` { "queryData": [ { "dimension": "connector", "values": [ "adyen" ] }, { "dimension": "payment_method", "values": [ "card" ] }, { "dimension": "payment_method_type", "values": [ "debit" ] }, { "dimension": "currency", "values": [ "USD" ] }, { "dimension": "authentication_type", "values": [ "no_three_ds" ] }, { "dimension": "status", "values": [ "charged" ] }, { "dimension": "client_source", "values": [] }, { "dimension": "client_version", "values": [] }, { "dimension": "profile_id", "values": [ "pro_0YmTwtjkst9iUDkg4R5D" ] }, { "dimension": "routing_approach", "values": [ "default_fallback", "debit_routing" ] } ] } ``` -> Payment metric that gives total debit routed txn and savings ``` curl --location 'http://localhost:8080/analytics/v1/org/metrics/payments' \ --header 'Accept: */*' \ --header 'Accept-Language: en-US,en;q=0.9' \ --header 'Connection: keep-alive' \ --header 'Content-Type: application/json' \ --header 'Origin: http://localhost:9000' \ --header 'Referer: http://localhost:9000/' \ --header 'Sec-Fetch-Dest: empty' \ --header 'Sec-Fetch-Mode: cors' \ --header 'Sec-Fetch-Site: same-site' \ --header 'User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/128.0.0.0 Safari/537.36' \ --header 'sec-ch-ua: "Chromium";v="128", "Not;A=Brand";v="24", "Google Chrome";v="128"' \ --header 'sec-ch-ua-mobile: ?0' \ --header 'sec-ch-ua-platform: "macOS"' \ --header 'api-key: dev_cW7LmHwdGurYUqCHLMkUX8AfU9uYzKJc6sT0bsAB1wQJFe6lOP01lRO30Dj0WpcH' \ --header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiZTAxZDlhMzgtMDdlMi00ZmFiLTg3ZmYtZWU0NmE2YTU2MDlhIiwibWVyY2hhbnRfaWQiOiJtZXJjaGFudF8xNzUxMjkzOTQ5Iiwicm9sZV9pZCI6Im9yZ19hZG1pbiIsImV4cCI6MTc1MTQ2Njc1MSwib3JnX2lkIjoib3JnX2tOa2k3aXBKS1h4NFc3bGVJU3FQIiwicHJvZmlsZV9pZCI6InByb18wWW1Ud3Rqa3N0OWlVRGtnNFI1RCIsInRlbmFudF9pZCI6InB1YmxpYyJ9.jty5ccBH_Em-odSAlde-FQLMC34aoGdV_UYsJFoUN-w' \ --data '[ { "timeRange": { "startTime": "2025-03-01T18:30:00Z", "endTime": "2025-07-31T09:22:00Z" }, "filters": { "routing_approach": [ "debit_routing" ] }, "source": "BATCH", "metrics": [ "debit_routing" ], "timeSeries": { "granularity": "G_ONEDAY" }, "delta": true } ]' ``` ``` { "queryData": [ { "payment_success_rate": null, "payment_count": null, "payment_success_count": null, "payment_processed_amount": 0, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "debit_routed_transaction_count": 8, "debit_routing_savings": 369, "debit_routing_savings_in_usd": null, "currency": "USD", "status": null, "connector": null, "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": null, "time_range": { "start_time": "2025-06-30T00:00:00.000Z", "end_time": "2025-06-30T23:00:00.000Z" }, "time_bucket": "2025-06-30 00:00:00" } ], "metaData": [ { "total_payment_processed_amount": 0, "total_payment_processed_amount_in_usd": null, "total_payment_processed_amount_without_smart_retries": 0, "total_payment_processed_amount_without_smart_retries_usd": null, "total_payment_processed_count": 0, "total_payment_processed_count_without_smart_retries": 0, "total_failure_reasons_count": 0, "total_failure_reasons_count_without_smart_retries": 0 } ] } ``` -> Payment metrics that gives savings per txn ``` curl --location 'http://localhost:8080/analytics/v1/org/metrics/payments' \ --header 'Accept: */*' \ --header 'Accept-Language: en-US,en;q=0.9' \ --header 'Connection: keep-alive' \ --header 'Content-Type: application/json' \ --header 'Origin: http://localhost:9000' \ --header 'Referer: http://localhost:9000/' \ --header 'Sec-Fetch-Dest: empty' \ --header 'Sec-Fetch-Mode: cors' \ --header 'Sec-Fetch-Site: same-site' \ --header 'User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/128.0.0.0 Safari/537.36' \ --header 'sec-ch-ua: "Chromium";v="128", "Not;A=Brand";v="24", "Google Chrome";v="128"' \ --header 'sec-ch-ua-mobile: ?0' \ --header 'sec-ch-ua-platform: "macOS"' \ --header 'api-key: dev_cW7LmHwdGurYUqCHLMkUX8AfU9uYzKJc6sT0bsAB1wQJFe6lOP01lRO30Dj0WpcH' \ --header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiZTAxZDlhMzgtMDdlMi00ZmFiLTg3ZmYtZWU0NmE2YTU2MDlhIiwibWVyY2hhbnRfaWQiOiJtZXJjaGFudF8xNzUxMjkzOTQ5Iiwicm9sZV9pZCI6Im9yZ19hZG1pbiIsImV4cCI6MTc1MTQ2Njc1MSwib3JnX2lkIjoib3JnX2tOa2k3aXBKS1h4NFc3bGVJU3FQIiwicHJvZmlsZV9pZCI6InByb18wWW1Ud3Rqa3N0OWlVRGtnNFI1RCIsInRlbmFudF9pZCI6InB1YmxpYyJ9.jty5ccBH_Em-odSAlde-FQLMC34aoGdV_UYsJFoUN-w' \ --data '[ { "timeRange": { "startTime": "2025-03-01T18:30:00Z", "endTime": "2025-07-31T09:22:00Z" }, "groupByNames": [ "card_network" ], "filters": { "routing_approach": [ "debit_routing" ] }, "source": "BATCH", "metrics": [ "debit_routing" ], "timeSeries": { "granularity": "G_ONEDAY" }, "delta": true } ]' ``` ``` { "queryData": [ { "payment_success_rate": null, "payment_count": null, "payment_success_count": null, "payment_processed_amount": 0, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "debit_routed_transaction_count": 2, "debit_routing_savings": 107, "debit_routing_savings_in_usd": null, "currency": "USD", "status": null, "connector": null, "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": "Star", "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": null, "time_range": { "start_time": "2025-06-30T00:00:00.000Z", "end_time": "2025-06-30T23:00:00.000Z" }, "time_bucket": "2025-06-30 00:00:00" }, { "payment_success_rate": null, "payment_count": null, "payment_success_count": null, "payment_processed_amount": 0, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "debit_routed_transaction_count": 2, "debit_routing_savings": 199, "debit_routing_savings_in_usd": null, "currency": "USD", "status": null, "connector": null, "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": "Nyce", "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": null, "time_range": { "start_time": "2025-06-30T00:00:00.000Z", "end_time": "2025-06-30T23:00:00.000Z" }, "time_bucket": "2025-06-30 00:00:00" }, { "payment_success_rate": null, "payment_count": null, "payment_success_count": null, "payment_processed_amount": 0, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "debit_routed_transaction_count": 3, "debit_routing_savings": 0, "debit_routing_savings_in_usd": null, "currency": "USD", "status": null, "connector": null, "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": "Visa", "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": null, "time_range": { "start_time": "2025-06-30T00:00:00.000Z", "end_time": "2025-06-30T23:00:00.000Z" }, "time_bucket": "2025-06-30 00:00:00" }, { "payment_success_rate": null, "payment_count": null, "payment_success_count": null, "payment_processed_amount": 0, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "debit_routed_transaction_count": 1, "debit_routing_savings": 63, "debit_routing_savings_in_usd": null, "currency": "USD", "status": null, "connector": null, "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": "Accel", "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": null, "time_range": { "start_time": "2025-06-30T00:00:00.000Z", "end_time": "2025-06-30T23:00:00.000Z" }, "time_bucket": "2025-06-30 00:00:00" } ], "metaData": [ { "total_payment_processed_amount": 0, "total_payment_processed_amount_in_usd": null, "total_payment_processed_amount_without_smart_retries": 0, "total_payment_processed_amount_without_smart_retries_usd": null, "total_payment_processed_count": 0, "total_payment_processed_count_without_smart_retries": 0, "total_failure_reasons_count": 0, "total_failure_reasons_count_without_smart_retries": 0 } ] } ``` ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

6678ee351748e5629a22e84677d58297cbac62a5

juspay/hyperswitch

juspay__hyperswitch-8527

Bug: [FEATURE] [CONNECTOR] Payload Integrate a new connector Payload. Developer Docs: https://docs.payload.com Login Dashboard: https://app.payload.com

diff --git a/config/config.example.toml b/config/config.example.toml index 7d072f93e47..54d3fa43be4 100644 --- a/config/config.example.toml +++ b/config/config.example.toml @@ -262,6 +262,7 @@ opennode.base_url = "https://dev-api.opennode.com" paybox.base_url = "https://preprod-ppps.paybox.com/PPPS.php" paybox.secondary_base_url="https://preprod-tpeweb.paybox.com/" payeezy.base_url = "https://api-cert.payeezy.com/" +payload.base_url = "https://api.payload.com" payme.base_url = "https://sandbox.payme.io/" payone.base_url = "https://payment.preprod.payone.com/" paypal.base_url = "https://api-m.sandbox.paypal.com/" diff --git a/config/deployments/integration_test.toml b/config/deployments/integration_test.toml index 568509b8442..b99958aaa13 100644 --- a/config/deployments/integration_test.toml +++ b/config/deployments/integration_test.toml @@ -99,6 +99,7 @@ opennode.base_url = "https://dev-api.opennode.com" paybox.base_url = "https://preprod-ppps.paybox.com/PPPS.php" paybox.secondary_base_url="https://preprod-tpeweb.paybox.com/" payeezy.base_url = "https://api-cert.payeezy.com/" +payload.base_url = "https://api.payload.com" payme.base_url = "https://sandbox.payme.io/" payone.base_url = "https://payment.preprod.payone.com/" paypal.base_url = "https://api-m.sandbox.paypal.com/" diff --git a/config/deployments/production.toml b/config/deployments/production.toml index 499b98fe16c..06e5c94eecb 100644 --- a/config/deployments/production.toml +++ b/config/deployments/production.toml @@ -103,6 +103,7 @@ opennode.base_url = "https://api.opennode.com" paybox.base_url = "https://ppps.paybox.com/PPPS.php" paybox.secondary_base_url="https://tpeweb.paybox.com/" payeezy.base_url = "https://api.payeezy.com/" +payload.base_url = "https://api.payload.com" payme.base_url = "https://live.payme.io/" payone.base_url = "https://payment.payone.com/" paypal.base_url = "https://api-m.paypal.com/" diff --git a/config/deployments/sandbox.toml b/config/deployments/sandbox.toml index 4ca4c787981..93ac9d14c67 100644 --- a/config/deployments/sandbox.toml +++ b/config/deployments/sandbox.toml @@ -103,6 +103,7 @@ opennode.base_url = "https://dev-api.opennode.com" paybox.base_url = "https://preprod-ppps.paybox.com/PPPS.php" paybox.secondary_base_url="https://preprod-tpeweb.paybox.com/" payeezy.base_url = "https://api-cert.payeezy.com/" +payload.base_url = "https://api.payload.com" payme.base_url = "https://sandbox.payme.io/" payone.base_url = "https://payment.preprod.payone.com/" paypal.base_url = "https://api-m.sandbox.paypal.com/" diff --git a/config/development.toml b/config/development.toml index 11d4d8ae7ab..210e7fe22a6 100644 --- a/config/development.toml +++ b/config/development.toml @@ -157,6 +157,7 @@ cards = [ "opennode", "paybox", "payeezy", + "payload", "payme", "payone", "paypal", @@ -297,6 +298,7 @@ opennode.base_url = "https://dev-api.opennode.com" paybox.base_url = "https://preprod-ppps.paybox.com/PPPS.php" paybox.secondary_base_url = "https://preprod-tpeweb.paybox.com/" payeezy.base_url = "https://api-cert.payeezy.com/" +payload.base_url = "https://api.payload.com" payme.base_url = "https://sandbox.payme.io/" payone.base_url = "https://payment.preprod.payone.com/" paypal.base_url = "https://api-m.sandbox.paypal.com/" diff --git a/config/docker_compose.toml b/config/docker_compose.toml index 80a672453ea..e35b85bb18e 100644 --- a/config/docker_compose.toml +++ b/config/docker_compose.toml @@ -188,6 +188,7 @@ opennode.base_url = "https://dev-api.opennode.com" paybox.base_url = "https://preprod-ppps.paybox.com/PPPS.php" paybox.secondary_base_url="https://preprod-tpeweb.paybox.com/" payeezy.base_url = "https://api-cert.payeezy.com/" +payload.base_url = "https://api.payload.com" payme.base_url = "https://sandbox.payme.io/" payone.base_url = "https://payment.preprod.payone.com/" paypal.base_url = "https://api-m.sandbox.paypal.com/" @@ -306,6 +307,7 @@ cards = [ "opennode", "paybox", "payeezy", + "payload", "payme", "payone", "paypal", diff --git a/connector-template/mod.rs b/connector-template/mod.rs index 09ccdf9544e..56b2b5bc18d 100644 --- a/connector-template/mod.rs +++ b/connector-template/mod.rs @@ -593,9 +593,7 @@ impl webhooks::IncomingWebhook for {{project-name | downcase | pascal_case}} { } static {{project-name | upcase}}_SUPPORTED_PAYMENT_METHODS: LazyLock<SupportedPaymentMethods> = - LazyLock::new(|| { - SupportedPaymentMethods::new() - }); + LazyLock::new(SupportedPaymentMethods::new); static {{project-name | upcase}}_CONNECTOR_INFO: ConnectorInfo = ConnectorInfo { display_name: "{{project-name | downcase | pascal_case}}", diff --git a/crates/common_enums/src/connector_enums.rs b/crates/common_enums/src/connector_enums.rs index afe83a0f40f..fd145d61488 100644 --- a/crates/common_enums/src/connector_enums.rs +++ b/crates/common_enums/src/connector_enums.rs @@ -121,6 +121,7 @@ pub enum RoutableConnectors { // Payeezy, As psync and rsync are not supported by this connector, it is added as template code for future usage Paybox, Payme, + // Payload, Payone, Paypal, Paystack, @@ -283,6 +284,7 @@ pub enum Connector { Opennode, Paybox, // Payeezy, As psync and rsync are not supported by this connector, it is added as template code for future usage + // Payload, Payme, Payone, Paypal, @@ -457,6 +459,7 @@ impl Connector { | Self::Nuvei | Self::Opennode | Self::Paybox + // | Self::Payload | Self::Payme | Self::Payone | Self::Paypal @@ -618,6 +621,7 @@ impl From<RoutableConnectors> for Connector { RoutableConnectors::Nuvei => Self::Nuvei, RoutableConnectors::Opennode => Self::Opennode, RoutableConnectors::Paybox => Self::Paybox, + // RoutableConnectors::Paybox => Self::Payload, RoutableConnectors::Payme => Self::Payme, RoutableConnectors::Payone => Self::Payone, RoutableConnectors::Paypal => Self::Paypal, @@ -738,6 +742,7 @@ impl TryFrom<Connector> for RoutableConnectors { Connector::Nuvei => Ok(Self::Nuvei), Connector::Opennode => Ok(Self::Opennode), Connector::Paybox => Ok(Self::Paybox), + // Connector::Paybox => Ok(Self::Payload), Connector::Payme => Ok(Self::Payme), Connector::Payone => Ok(Self::Payone), Connector::Paypal => Ok(Self::Paypal), diff --git a/crates/connector_configs/src/connector.rs b/crates/connector_configs/src/connector.rs index abf73e20acc..f82ceecb052 100644 --- a/crates/connector_configs/src/connector.rs +++ b/crates/connector_configs/src/connector.rs @@ -240,6 +240,7 @@ pub struct ConnectorConfig { pub novalnet: Option<ConnectorTomlConfig>, pub nuvei: Option<ConnectorTomlConfig>, pub paybox: Option<ConnectorTomlConfig>, + pub payload: Option<ConnectorTomlConfig>, pub payme: Option<ConnectorTomlConfig>, #[cfg(feature = "payouts")] pub payone_payout: Option<ConnectorTomlConfig>, @@ -429,6 +430,7 @@ impl ConnectorConfig { Connector::Noon => Ok(connector_data.noon), Connector::Nuvei => Ok(connector_data.nuvei), Connector::Paybox => Ok(connector_data.paybox), + // Connector::Payload => Ok(connector_data.payload), Connector::Payme => Ok(connector_data.payme), Connector::Payone => Err("Use get_payout_connector_config".to_string()), Connector::Paypal => Ok(connector_data.paypal), diff --git a/crates/connector_configs/toml/development.toml b/crates/connector_configs/toml/development.toml index 7d304066f91..a5a448fb0a5 100644 --- a/crates/connector_configs/toml/development.toml +++ b/crates/connector_configs/toml/development.toml @@ -6285,4 +6285,26 @@ name="merchant_name" label="Merchant Name" placeholder="Enter the merchant name" required=true -type="Text" \ No newline at end of file +type="Text" + +[payload] +[[payload.credit]] + payment_method_type = "AmericanExpress" +[[payload.credit]] + payment_method_type = "Discover" +[[payload.credit]] + payment_method_type = "Mastercard" +[[payload.credit]] + payment_method_type = "Visa" +[[payload.debit]] + payment_method_type = "AmericanExpress" +[[payload.debit]] + payment_method_type = "Discover" +[[payload.debit]] + payment_method_type = "Mastercard" +[[payload.debit]] + payment_method_type = "Visa" +[payload.connector_auth.HeaderKey] +api_key="API Key" +[payload.connector_webhook_details] +merchant_secret="Source verification key" \ No newline at end of file diff --git a/crates/connector_configs/toml/production.toml b/crates/connector_configs/toml/production.toml index aba744d778c..09f94adbcd2 100644 --- a/crates/connector_configs/toml/production.toml +++ b/crates/connector_configs/toml/production.toml @@ -4890,4 +4890,26 @@ name="merchant_name" label="Merchant Name" placeholder="Enter the merchant name" required=true -type="Text" \ No newline at end of file +type="Text" + +[payload] +[[payload.credit]] + payment_method_type = "AmericanExpress" +[[payload.credit]] + payment_method_type = "Discover" +[[payload.credit]] + payment_method_type = "Mastercard" +[[payload.credit]] + payment_method_type = "Visa" +[[payload.debit]] + payment_method_type = "AmericanExpress" +[[payload.debit]] + payment_method_type = "Discover" +[[payload.debit]] + payment_method_type = "Mastercard" +[[payload.debit]] + payment_method_type = "Visa" +[payload.connector_auth.HeaderKey] +api_key="API Key" +[payload.connector_webhook_details] +merchant_secret="Source verification key" diff --git a/crates/connector_configs/toml/sandbox.toml b/crates/connector_configs/toml/sandbox.toml index b027876614b..bb02a3197fa 100644 --- a/crates/connector_configs/toml/sandbox.toml +++ b/crates/connector_configs/toml/sandbox.toml @@ -6259,4 +6259,26 @@ name="merchant_name" label="Merchant Name" placeholder="Enter the merchant name" required=true -type="Text" \ No newline at end of file +type="Text" + +[payload] +[[payload.credit]] + payment_method_type = "AmericanExpress" +[[payload.credit]] + payment_method_type = "Discover" +[[payload.credit]] + payment_method_type = "Mastercard" +[[payload.credit]] + payment_method_type = "Visa" +[[payload.debit]] + payment_method_type = "AmericanExpress" +[[payload.debit]] + payment_method_type = "Discover" +[[payload.debit]] + payment_method_type = "Mastercard" +[[payload.debit]] + payment_method_type = "Visa" +[payload.connector_auth.HeaderKey] +api_key="API Key" +[payload.connector_webhook_details] +merchant_secret="Source verification key" \ No newline at end of file diff --git a/crates/hyperswitch_connectors/src/connectors.rs b/crates/hyperswitch_connectors/src/connectors.rs index 55f2047a59f..16b56bed6fc 100644 --- a/crates/hyperswitch_connectors/src/connectors.rs +++ b/crates/hyperswitch_connectors/src/connectors.rs @@ -68,6 +68,7 @@ pub mod opayo; pub mod opennode; pub mod paybox; pub mod payeezy; +pub mod payload; pub mod payme; pub mod payone; pub mod paypal; @@ -126,14 +127,15 @@ pub use self::{ juspaythreedsserver::Juspaythreedsserver, klarna::Klarna, mifinity::Mifinity, mollie::Mollie, moneris::Moneris, multisafepay::Multisafepay, netcetera::Netcetera, nexinets::Nexinets, nexixpay::Nexixpay, nmi::Nmi, nomupay::Nomupay, noon::Noon, nordea::Nordea, novalnet::Novalnet, - nuvei::Nuvei, opayo::Opayo, opennode::Opennode, paybox::Paybox, payeezy::Payeezy, payme::Payme, - payone::Payone, paypal::Paypal, paystack::Paystack, payu::Payu, placetopay::Placetopay, - plaid::Plaid, powertranz::Powertranz, prophetpay::Prophetpay, rapyd::Rapyd, razorpay::Razorpay, - recurly::Recurly, redsys::Redsys, riskified::Riskified, santander::Santander, shift4::Shift4, - signifyd::Signifyd, square::Square, stax::Stax, stripe::Stripe, stripebilling::Stripebilling, - taxjar::Taxjar, threedsecureio::Threedsecureio, thunes::Thunes, tokenio::Tokenio, - trustpay::Trustpay, tsys::Tsys, unified_authentication_service::UnifiedAuthenticationService, - vgs::Vgs, volt::Volt, wellsfargo::Wellsfargo, wellsfargopayout::Wellsfargopayout, wise::Wise, - worldline::Worldline, worldpay::Worldpay, worldpayvantiv::Worldpayvantiv, - worldpayxml::Worldpayxml, xendit::Xendit, zen::Zen, zsl::Zsl, + nuvei::Nuvei, opayo::Opayo, opennode::Opennode, paybox::Paybox, payeezy::Payeezy, + payload::Payload, payme::Payme, payone::Payone, paypal::Paypal, paystack::Paystack, payu::Payu, + placetopay::Placetopay, plaid::Plaid, powertranz::Powertranz, prophetpay::Prophetpay, + rapyd::Rapyd, razorpay::Razorpay, recurly::Recurly, redsys::Redsys, riskified::Riskified, + santander::Santander, shift4::Shift4, signifyd::Signifyd, square::Square, stax::Stax, + stripe::Stripe, stripebilling::Stripebilling, taxjar::Taxjar, threedsecureio::Threedsecureio, + thunes::Thunes, tokenio::Tokenio, trustpay::Trustpay, tsys::Tsys, + unified_authentication_service::UnifiedAuthenticationService, vgs::Vgs, volt::Volt, + wellsfargo::Wellsfargo, wellsfargopayout::Wellsfargopayout, wise::Wise, worldline::Worldline, + worldpay::Worldpay, worldpayvantiv::Worldpayvantiv, worldpayxml::Worldpayxml, xendit::Xendit, + zen::Zen, zsl::Zsl, }; diff --git a/crates/hyperswitch_connectors/src/connectors/payload.rs b/crates/hyperswitch_connectors/src/connectors/payload.rs new file mode 100644 index 00000000000..b4d930bf03f --- /dev/null +++ b/crates/hyperswitch_connectors/src/connectors/payload.rs @@ -0,0 +1,619 @@ +pub mod transformers; + +use std::sync::LazyLock; + +use common_enums::enums; +use common_utils::{ + errors::CustomResult, + ext_traits::BytesExt, + request::{Method, Request, RequestBuilder, RequestContent}, + types::{AmountConvertor, StringMinorUnit, StringMinorUnitForConnector}, +}; +use error_stack::{report, ResultExt}; +use hyperswitch_domain_models::{ + payment_method_data::PaymentMethodData, + router_data::{AccessToken, ConnectorAuthType, ErrorResponse, RouterData}, + router_flow_types::{ + access_token_auth::AccessTokenAuth, + payments::{Authorize, Capture, PSync, PaymentMethodToken, Session, SetupMandate, Void}, + refunds::{Execute, RSync}, + }, + router_request_types::{ + AccessTokenRequestData, PaymentMethodTokenizationData, PaymentsAuthorizeData, + PaymentsCancelData, PaymentsCaptureData, PaymentsSessionData, PaymentsSyncData, + RefundsData, SetupMandateRequestData, + }, + router_response_types::{ + ConnectorInfo, PaymentsResponseData, RefundsResponseData, SupportedPaymentMethods, + }, + types::{ + PaymentsAuthorizeRouterData, PaymentsCaptureRouterData, PaymentsSyncRouterData, + RefundSyncRouterData, RefundsRouterData, + }, +}; +use hyperswitch_interfaces::{ + api::{ + self, ConnectorCommon, ConnectorCommonExt, ConnectorIntegration, ConnectorSpecifications, + ConnectorValidation, + }, + configs::Connectors, + errors, + events::connector_api_logs::ConnectorEvent, + types::{self, Response}, + webhooks, +}; +use masking::{ExposeInterface, Mask}; +use transformers as payload; + +use crate::{constants::headers, types::ResponseRouterData, utils}; + +#[derive(Clone)] +pub struct Payload { + amount_converter: &'static (dyn AmountConvertor<Output = StringMinorUnit> + Sync), +} + +impl Payload { + pub fn new() -> &'static Self { + &Self { + amount_converter: &StringMinorUnitForConnector, + } + } +} + +impl api::Payment for Payload {} +impl api::PaymentSession for Payload {} +impl api::ConnectorAccessToken for Payload {} +impl api::MandateSetup for Payload {} +impl api::PaymentAuthorize for Payload {} +impl api::PaymentSync for Payload {} +impl api::PaymentCapture for Payload {} +impl api::PaymentVoid for Payload {} +impl api::Refund for Payload {} +impl api::RefundExecute for Payload {} +impl api::RefundSync for Payload {} +impl api::PaymentToken for Payload {} + +impl ConnectorIntegration<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData> + for Payload +{ + // Not Implemented (R) +} + +impl<Flow, Request, Response> ConnectorCommonExt<Flow, Request, Response> for Payload +where + Self: ConnectorIntegration<Flow, Request, Response>, +{ + fn build_headers( + &self, + req: &RouterData<Flow, Request, Response>, + _connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + let mut header = vec![( + headers::CONTENT_TYPE.to_string(), + self.get_content_type().to_string().into(), + )]; + let mut api_key = self.get_auth_header(&req.connector_auth_type)?; + header.append(&mut api_key); + Ok(header) + } +} + +impl ConnectorCommon for Payload { + fn id(&self) -> &'static str { + "payload" + } + + fn get_currency_unit(&self) -> api::CurrencyUnit { + api::CurrencyUnit::Base + } + + fn common_get_content_type(&self) -> &'static str { + "application/json" + } + + fn base_url<'a>(&self, connectors: &'a Connectors) -> &'a str { + connectors.payload.base_url.as_ref() + } + + fn get_auth_header( + &self, + auth_type: &ConnectorAuthType, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + let auth = payload::PayloadAuthType::try_from(auth_type) + .change_context(errors::ConnectorError::FailedToObtainAuthType)?; + Ok(vec![( + headers::AUTHORIZATION.to_string(), + auth.api_key.expose().into_masked(), + )]) + } + + fn build_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + let response: payload::PayloadErrorResponse = res + .response + .parse_struct("PayloadErrorResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + + Ok(ErrorResponse { + status_code: res.status_code, + code: response.code, + message: response.message, + reason: response.reason, + attempt_status: None, + connector_transaction_id: None, + network_advice_code: None, + network_decline_code: None, + network_error_message: None, + }) + } +} + +impl ConnectorValidation for Payload { + fn validate_mandate_payment( + &self, + _pm_type: Option<enums::PaymentMethodType>, + pm_data: PaymentMethodData, + ) -> CustomResult<(), errors::ConnectorError> { + match pm_data { + PaymentMethodData::Card(_) => Err(errors::ConnectorError::NotImplemented( + "validate_mandate_payment does not support cards".to_string(), + ) + .into()), + _ => Ok(()), + } + } + + fn validate_psync_reference_id( + &self, + _data: &PaymentsSyncData, + _is_three_ds: bool, + _status: enums::AttemptStatus, + _connector_meta_data: Option<common_utils::pii::SecretSerdeValue>, + ) -> CustomResult<(), errors::ConnectorError> { + Ok(()) + } +} + +impl ConnectorIntegration<Session, PaymentsSessionData, PaymentsResponseData> for Payload { + //TODO: implement sessions flow +} + +impl ConnectorIntegration<AccessTokenAuth, AccessTokenRequestData, AccessToken> for Payload {} + +impl ConnectorIntegration<SetupMandate, SetupMandateRequestData, PaymentsResponseData> for Payload {} + +impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData> for Payload { + fn get_headers( + &self, + req: &PaymentsAuthorizeRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsAuthorizeRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn get_request_body( + &self, + req: &PaymentsAuthorizeRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let amount = utils::convert_amount( + self.amount_converter, + req.request.minor_amount, + req.request.currency, + )?; + + let connector_router_data = payload::PayloadRouterData::from((amount, req)); + let connector_req = payload::PayloadPaymentsRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &PaymentsAuthorizeRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::PaymentsAuthorizeType::get_url( + self, req, connectors, + )?) + .attach_default_headers() + .headers(types::PaymentsAuthorizeType::get_headers( + self, req, connectors, + )?) + .set_body(types::PaymentsAuthorizeType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsAuthorizeRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsAuthorizeRouterData, errors::ConnectorError> { + let response: payload::PayloadPaymentsResponse = res + .response + .parse_struct("Payload PaymentsAuthorizeResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<PSync, PaymentsSyncData, PaymentsResponseData> for Payload { + fn get_headers( + &self, + req: &PaymentsSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsSyncRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn build_request( + &self, + req: &PaymentsSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Get) + .url(&types::PaymentsSyncType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::PaymentsSyncType::get_headers(self, req, connectors)?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsSyncRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsSyncRouterData, errors::ConnectorError> { + let response: payload::PayloadPaymentsResponse = res + .response + .parse_struct("payload PaymentsSyncResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<Capture, PaymentsCaptureData, PaymentsResponseData> for Payload { + fn get_headers( + &self, + req: &PaymentsCaptureRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsCaptureRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn get_request_body( + &self, + _req: &PaymentsCaptureRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_request_body method".to_string()).into()) + } + + fn build_request( + &self, + req: &PaymentsCaptureRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::PaymentsCaptureType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::PaymentsCaptureType::get_headers( + self, req, connectors, + )?) + .set_body(types::PaymentsCaptureType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsCaptureRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsCaptureRouterData, errors::ConnectorError> { + let response: payload::PayloadPaymentsResponse = res + .response + .parse_struct("Payload PaymentsCaptureResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<Void, PaymentsCancelData, PaymentsResponseData> for Payload {} + +impl ConnectorIntegration<Execute, RefundsData, RefundsResponseData> for Payload { + fn get_headers( + &self, + req: &RefundsRouterData<Execute>, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &RefundsRouterData<Execute>, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn get_request_body( + &self, + req: &RefundsRouterData<Execute>, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let refund_amount = utils::convert_amount( + self.amount_converter, + req.request.minor_refund_amount, + req.request.currency, + )?; + + let connector_router_data = payload::PayloadRouterData::from((refund_amount, req)); + let connector_req = payload::PayloadRefundRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &RefundsRouterData<Execute>, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + let request = RequestBuilder::new() + .method(Method::Post) + .url(&types::RefundExecuteType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::RefundExecuteType::get_headers( + self, req, connectors, + )?) + .set_body(types::RefundExecuteType::get_request_body( + self, req, connectors, + )?) + .build(); + Ok(Some(request)) + } + + fn handle_response( + &self, + data: &RefundsRouterData<Execute>, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<RefundsRouterData<Execute>, errors::ConnectorError> { + let response: payload::RefundResponse = res + .response + .parse_struct("payload RefundResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<RSync, RefundsData, RefundsResponseData> for Payload { + fn get_headers( + &self, + req: &RefundSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &RefundSyncRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn build_request( + &self, + req: &RefundSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Get) + .url(&types::RefundSyncType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::RefundSyncType::get_headers(self, req, connectors)?) + .set_body(types::RefundSyncType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &RefundSyncRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<RefundSyncRouterData, errors::ConnectorError> { + let response: payload::RefundResponse = res + .response + .parse_struct("payload RefundSyncResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +#[async_trait::async_trait] +impl webhooks::IncomingWebhook for Payload { + fn get_webhook_object_reference_id( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<api_models::webhooks::ObjectReferenceId, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } + + fn get_webhook_event_type( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<api_models::webhooks::IncomingWebhookEvent, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } + + fn get_webhook_resource_object( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<Box<dyn masking::ErasedMaskSerialize>, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } +} + +static PAYLOAD_SUPPORTED_PAYMENT_METHODS: LazyLock<SupportedPaymentMethods> = + LazyLock::new(SupportedPaymentMethods::new); + +static PAYLOAD_CONNECTOR_INFO: ConnectorInfo = ConnectorInfo { + display_name: "Payload", + description: "Payload connector", + connector_type: enums::PaymentConnectorCategory::PaymentGateway, +}; + +static PAYLOAD_SUPPORTED_WEBHOOK_FLOWS: [enums::EventClass; 0] = []; + +impl ConnectorSpecifications for Payload { + fn get_connector_about(&self) -> Option<&'static ConnectorInfo> { + Some(&PAYLOAD_CONNECTOR_INFO) + } + + fn get_supported_payment_methods(&self) -> Option<&'static SupportedPaymentMethods> { + Some(&*PAYLOAD_SUPPORTED_PAYMENT_METHODS) + } + + fn get_supported_webhook_flows(&self) -> Option<&'static [enums::EventClass]> { + Some(&PAYLOAD_SUPPORTED_WEBHOOK_FLOWS) + } +} diff --git a/crates/hyperswitch_connectors/src/connectors/payload/transformers.rs b/crates/hyperswitch_connectors/src/connectors/payload/transformers.rs new file mode 100644 index 00000000000..9275cd1a15c --- /dev/null +++ b/crates/hyperswitch_connectors/src/connectors/payload/transformers.rs @@ -0,0 +1,231 @@ +use common_enums::enums; +use common_utils::types::StringMinorUnit; +use hyperswitch_domain_models::{ + payment_method_data::PaymentMethodData, + router_data::{ConnectorAuthType, RouterData}, + router_flow_types::refunds::{Execute, RSync}, + router_request_types::ResponseId, + router_response_types::{PaymentsResponseData, RefundsResponseData}, + types::{PaymentsAuthorizeRouterData, RefundsRouterData}, +}; +use hyperswitch_interfaces::errors; +use masking::Secret; +use serde::{Deserialize, Serialize}; + +use crate::{ + types::{RefundsResponseRouterData, ResponseRouterData}, + utils::PaymentsAuthorizeRequestData, +}; + +//TODO: Fill the struct with respective fields +pub struct PayloadRouterData<T> { + pub amount: StringMinorUnit, // The type of amount that a connector accepts, for example, String, i64, f64, etc. + pub router_data: T, +} + +impl<T> From<(StringMinorUnit, T)> for PayloadRouterData<T> { + fn from((amount, item): (StringMinorUnit, T)) -> Self { + //Todo : use utils to convert the amount to the type of amount that a connector accepts + Self { + amount, + router_data: item, + } + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Serialize, PartialEq)] +pub struct PayloadPaymentsRequest { + amount: StringMinorUnit, + card: PayloadCard, +} + +#[derive(Default, Debug, Serialize, Eq, PartialEq)] +pub struct PayloadCard { + number: cards::CardNumber, + expiry_month: Secret<String>, + expiry_year: Secret<String>, + cvc: Secret<String>, + complete: bool, +} + +impl TryFrom<&PayloadRouterData<&PaymentsAuthorizeRouterData>> for PayloadPaymentsRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: &PayloadRouterData<&PaymentsAuthorizeRouterData>, + ) -> Result<Self, Self::Error> { + match item.router_data.request.payment_method_data.clone() { + PaymentMethodData::Card(req_card) => { + let card = PayloadCard { + number: req_card.card_number, + expiry_month: req_card.card_exp_month, + expiry_year: req_card.card_exp_year, + cvc: req_card.card_cvc, + complete: item.router_data.request.is_auto_capture()?, + }; + Ok(Self { + amount: item.amount.clone(), + card, + }) + } + _ => Err(errors::ConnectorError::NotImplemented("Payment method".to_string()).into()), + } + } +} + +//TODO: Fill the struct with respective fields +// Auth Struct +pub struct PayloadAuthType { + pub(super) api_key: Secret<String>, +} + +impl TryFrom<&ConnectorAuthType> for PayloadAuthType { + 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, Copy, Default, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "lowercase")] +pub enum PayloadPaymentStatus { + Succeeded, + Failed, + #[default] + Processing, +} + +impl From<PayloadPaymentStatus> for common_enums::AttemptStatus { + fn from(item: PayloadPaymentStatus) -> Self { + match item { + PayloadPaymentStatus::Succeeded => Self::Charged, + PayloadPaymentStatus::Failed => Self::Failure, + PayloadPaymentStatus::Processing => Self::Authorizing, + } + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] +pub struct PayloadPaymentsResponse { + status: PayloadPaymentStatus, + id: String, +} + +impl<F, T> TryFrom<ResponseRouterData<F, PayloadPaymentsResponse, T, PaymentsResponseData>> + for RouterData<F, T, PaymentsResponseData> +{ + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: ResponseRouterData<F, PayloadPaymentsResponse, T, PaymentsResponseData>, + ) -> Result<Self, Self::Error> { + Ok(Self { + status: common_enums::AttemptStatus::from(item.response.status), + response: Ok(PaymentsResponseData::TransactionResponse { + resource_id: ResponseId::ConnectorTransactionId(item.response.id), + redirection_data: Box::new(None), + mandate_reference: Box::new(None), + connector_metadata: None, + network_txn_id: None, + connector_response_reference_id: None, + incremental_authorization_allowed: None, + charges: None, + }), + ..item.data + }) + } +} + +//TODO: Fill the struct with respective fields +// REFUND : +// Type definition for RefundRequest +#[derive(Default, Debug, Serialize)] +pub struct PayloadRefundRequest { + pub amount: StringMinorUnit, +} + +impl<F> TryFrom<&PayloadRouterData<&RefundsRouterData<F>>> for PayloadRefundRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from(item: &PayloadRouterData<&RefundsRouterData<F>>) -> Result<Self, Self::Error> { + Ok(Self { + amount: item.amount.to_owned(), + }) + } +} + +// Type definition for Refund Response + +#[allow(dead_code)] +#[derive(Debug, Copy, Serialize, Default, Deserialize, Clone)] +pub enum RefundStatus { + Succeeded, + Failed, + #[default] + Processing, +} + +impl From<RefundStatus> for enums::RefundStatus { + fn from(item: RefundStatus) -> Self { + match item { + RefundStatus::Succeeded => Self::Success, + RefundStatus::Failed => Self::Failure, + RefundStatus::Processing => Self::Pending, + //TODO: Review mapping + } + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Clone, Serialize, Deserialize)] +pub struct RefundResponse { + id: String, + status: RefundStatus, +} + +impl TryFrom<RefundsResponseRouterData<Execute, RefundResponse>> for RefundsRouterData<Execute> { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: RefundsResponseRouterData<Execute, RefundResponse>, + ) -> Result<Self, Self::Error> { + Ok(Self { + response: Ok(RefundsResponseData { + connector_refund_id: item.response.id.to_string(), + refund_status: enums::RefundStatus::from(item.response.status), + }), + ..item.data + }) + } +} + +impl TryFrom<RefundsResponseRouterData<RSync, RefundResponse>> for RefundsRouterData<RSync> { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: RefundsResponseRouterData<RSync, RefundResponse>, + ) -> Result<Self, Self::Error> { + Ok(Self { + response: Ok(RefundsResponseData { + connector_refund_id: item.response.id.to_string(), + refund_status: enums::RefundStatus::from(item.response.status), + }), + ..item.data + }) + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Serialize, Deserialize, PartialEq)] +pub struct PayloadErrorResponse { + pub status_code: u16, + pub code: String, + pub message: String, + pub reason: Option<String>, + pub network_advice_code: Option<String>, + pub network_decline_code: Option<String>, + pub network_error_message: Option<String>, +} diff --git a/crates/hyperswitch_connectors/src/default_implementations.rs b/crates/hyperswitch_connectors/src/default_implementations.rs index 54c5d81edd9..a338b96bc55 100644 --- a/crates/hyperswitch_connectors/src/default_implementations.rs +++ b/crates/hyperswitch_connectors/src/default_implementations.rs @@ -204,6 +204,7 @@ default_imp_for_authorize_session_token!( connectors::Opennode, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Payone, connectors::Paypal, @@ -332,6 +333,7 @@ default_imp_for_calculate_tax!( connectors::Novalnet, connectors::Nuvei, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Payone, connectors::Paypal, @@ -462,6 +464,7 @@ default_imp_for_session_update!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Payone, connectors::Paystack, @@ -586,6 +589,7 @@ default_imp_for_post_session_tokens!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Payone, connectors::Paystack, @@ -708,6 +712,7 @@ default_imp_for_create_order!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Payone, connectors::Paypal, @@ -832,6 +837,7 @@ default_imp_for_update_metadata!( connectors::Nmi, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paystack, connectors::Payu, @@ -940,6 +946,7 @@ default_imp_for_complete_authorize!( connectors::Opayo, connectors::Opennode, connectors::Payeezy, + connectors::Payload, connectors::Payone, connectors::Paystack, connectors::Payu, @@ -1053,6 +1060,7 @@ default_imp_for_incremental_authorization!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Payone, connectors::Paypal, @@ -1179,6 +1187,7 @@ default_imp_for_create_customer!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Payone, connectors::Paypal, @@ -1290,6 +1299,7 @@ default_imp_for_connector_redirect_response!( connectors::Opayo, connectors::Opennode, connectors::Payeezy, + connectors::Payload, connectors::Paystack, connectors::Payone, connectors::Payu, @@ -1398,6 +1408,7 @@ default_imp_for_pre_processing_steps!( connectors::Opennode, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Paystack, connectors::Payone, connectors::Payu, @@ -1518,6 +1529,7 @@ default_imp_for_post_processing_steps!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Payone, connectors::Paypal, @@ -1643,6 +1655,7 @@ default_imp_for_approve!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, @@ -1769,6 +1782,7 @@ default_imp_for_reject!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payone, connectors::Payme, connectors::Paypal, @@ -1896,6 +1910,7 @@ default_imp_for_webhook_source_verification!( connectors::Payone, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paystack, connectors::Payu, @@ -2019,6 +2034,7 @@ default_imp_for_accept_dispute!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Payone, connectors::Paypal, @@ -2143,6 +2159,7 @@ default_imp_for_submit_evidence!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Payone, @@ -2266,6 +2283,7 @@ default_imp_for_defend_dispute!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Payone, connectors::Paypal, @@ -2399,6 +2417,7 @@ default_imp_for_file_upload!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Payone, connectors::Paypal, @@ -2516,6 +2535,7 @@ default_imp_for_payouts!( connectors::Novalnet, connectors::Nuvei, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paystack, connectors::Payu, @@ -2632,6 +2652,7 @@ default_imp_for_payouts_create!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Payone, connectors::Paystack, @@ -2756,6 +2777,7 @@ default_imp_for_payouts_retrieve!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paystack, connectors::Payu, @@ -2880,6 +2902,7 @@ default_imp_for_payouts_eligibility!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, @@ -3002,6 +3025,7 @@ default_imp_for_payouts_fulfill!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paystack, connectors::Payu, @@ -3123,6 +3147,7 @@ default_imp_for_payouts_cancel!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, @@ -3247,6 +3272,7 @@ default_imp_for_payouts_quote!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payone, connectors::Payme, connectors::Paypal, @@ -3372,6 +3398,7 @@ default_imp_for_payouts_recipient!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Payone, connectors::Paypal, @@ -3497,6 +3524,7 @@ default_imp_for_payouts_recipient_account!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Payone, connectors::Paypal, @@ -3624,6 +3652,7 @@ default_imp_for_frm_sale!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Payone, connectors::Paypal, @@ -3750,6 +3779,7 @@ default_imp_for_frm_checkout!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Payone, connectors::Paypal, @@ -3876,6 +3906,7 @@ default_imp_for_frm_transaction!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Payone, connectors::Paypal, @@ -4003,6 +4034,7 @@ default_imp_for_frm_fulfillment!( connectors::Payone, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, @@ -4128,6 +4160,7 @@ default_imp_for_frm_record_return!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Payone, connectors::Paypal, @@ -4248,6 +4281,7 @@ default_imp_for_revoking_mandates!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Payone, connectors::Paypal, @@ -4371,6 +4405,7 @@ default_imp_for_uas_pre_authentication!( connectors::Opennode, connectors::Nuvei, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Payone, connectors::Paypal, @@ -4494,6 +4529,7 @@ default_imp_for_uas_post_authentication!( connectors::Opennode, connectors::Nuvei, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Payone, connectors::Paypal, @@ -4618,6 +4654,7 @@ default_imp_for_uas_authentication_confirmation!( connectors::Opennode, connectors::Nuvei, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Payone, connectors::Paystack, @@ -4733,6 +4770,7 @@ default_imp_for_connector_request_id!( connectors::Opayo, connectors::Opennode, connectors::Payeezy, + connectors::Payload, connectors::Paystack, connectors::Payu, connectors::Payme, @@ -4852,6 +4890,7 @@ default_imp_for_fraud_check!( connectors::Nuvei, connectors::Opayo, connectors::Payeezy, + connectors::Payload, connectors::Paystack, connectors::Paypal, connectors::Payu, @@ -4999,6 +5038,7 @@ default_imp_for_connector_authentication!( connectors::Opayo, connectors::Opennode, connectors::Payeezy, + connectors::Payload, connectors::Paystack, connectors::Payu, connectors::Payone, @@ -5118,6 +5158,7 @@ default_imp_for_uas_authentication!( connectors::Nexixpay, connectors::Nuvei, connectors::Payeezy, + connectors::Payload, connectors::Paypal, connectors::Paystack, connectors::Payu, @@ -5238,6 +5279,7 @@ default_imp_for_revenue_recovery!( connectors::Opayo, connectors::Opennode, connectors::Payeezy, + connectors::Payload, connectors::Paystack, connectors::Payu, connectors::Paypal, @@ -5365,6 +5407,7 @@ default_imp_for_billing_connector_payment_sync!( connectors::Opayo, connectors::Opennode, connectors::Payeezy, + connectors::Payload, connectors::Paystack, connectors::Payu, connectors::Paypal, @@ -5490,6 +5533,7 @@ default_imp_for_revenue_recovery_record_back!( connectors::Opayo, connectors::Opennode, connectors::Payeezy, + connectors::Payload, connectors::Paystack, connectors::Payu, connectors::Paypal, @@ -5615,6 +5659,7 @@ default_imp_for_billing_connector_invoice_sync!( connectors::Opayo, connectors::Opennode, connectors::Payeezy, + connectors::Payload, connectors::Paystack, connectors::Payu, connectors::Paypal, @@ -5734,6 +5779,7 @@ default_imp_for_external_vault!( connectors::Opayo, connectors::Opennode, connectors::Payeezy, + connectors::Payload, connectors::Paystack, connectors::Payu, connectors::Paypal, @@ -5859,6 +5905,7 @@ default_imp_for_external_vault_insert!( connectors::Opayo, connectors::Opennode, connectors::Payeezy, + connectors::Payload, connectors::Paystack, connectors::Payu, connectors::Paypal, @@ -5984,6 +6031,7 @@ default_imp_for_external_vault_retrieve!( connectors::Opayo, connectors::Opennode, connectors::Payeezy, + connectors::Payload, connectors::Paystack, connectors::Payu, connectors::Paypal, @@ -6109,6 +6157,7 @@ default_imp_for_external_vault_delete!( connectors::Opayo, connectors::Opennode, connectors::Payeezy, + connectors::Payload, connectors::Paystack, connectors::Payu, connectors::Paypal, @@ -6233,6 +6282,7 @@ default_imp_for_external_vault_create!( connectors::Opayo, connectors::Opennode, connectors::Payeezy, + connectors::Payload, connectors::Paystack, connectors::Payu, connectors::Paypal, diff --git a/crates/hyperswitch_connectors/src/default_implementations_v2.rs b/crates/hyperswitch_connectors/src/default_implementations_v2.rs index 27c13c9d6be..99685607c48 100644 --- a/crates/hyperswitch_connectors/src/default_implementations_v2.rs +++ b/crates/hyperswitch_connectors/src/default_implementations_v2.rs @@ -312,6 +312,7 @@ default_imp_for_new_connector_integration_payment!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, @@ -438,6 +439,7 @@ default_imp_for_new_connector_integration_refund!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, @@ -559,6 +561,7 @@ default_imp_for_new_connector_integration_connector_access_token!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, @@ -685,6 +688,7 @@ default_imp_for_new_connector_integration_accept_dispute!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, @@ -810,6 +814,7 @@ default_imp_for_new_connector_integration_submit_evidence!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, @@ -936,6 +941,7 @@ default_imp_for_new_connector_integration_defend_dispute!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, @@ -1072,6 +1078,7 @@ default_imp_for_new_connector_integration_file_upload!( connectors::Payone, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, @@ -1200,6 +1207,7 @@ default_imp_for_new_connector_integration_payouts_create!( connectors::Payone, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, @@ -1328,6 +1336,7 @@ default_imp_for_new_connector_integration_payouts_eligibility!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, @@ -1456,6 +1465,7 @@ default_imp_for_new_connector_integration_payouts_fulfill!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, @@ -1584,6 +1594,7 @@ default_imp_for_new_connector_integration_payouts_cancel!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, @@ -1712,6 +1723,7 @@ default_imp_for_new_connector_integration_payouts_quote!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, @@ -1840,6 +1852,7 @@ default_imp_for_new_connector_integration_payouts_recipient!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, @@ -1968,6 +1981,7 @@ default_imp_for_new_connector_integration_payouts_sync!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, @@ -2096,6 +2110,7 @@ default_imp_for_new_connector_integration_payouts_recipient_account!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, @@ -2222,6 +2237,7 @@ default_imp_for_new_connector_integration_webhook_source_verification!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, @@ -2350,6 +2366,7 @@ default_imp_for_new_connector_integration_frm_sale!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, @@ -2478,6 +2495,7 @@ default_imp_for_new_connector_integration_frm_checkout!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, @@ -2606,6 +2624,7 @@ default_imp_for_new_connector_integration_frm_transaction!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, @@ -2734,6 +2753,7 @@ default_imp_for_new_connector_integration_frm_fulfillment!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, @@ -2862,6 +2882,7 @@ default_imp_for_new_connector_integration_frm_record_return!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, @@ -2987,6 +3008,7 @@ default_imp_for_new_connector_integration_revoking_mandates!( connectors::Nuvei, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paystack, connectors::Payu, @@ -3087,6 +3109,7 @@ default_imp_for_new_connector_integration_frm!( connectors::Payone, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payu, connectors::Placetopay, connectors::Plaid, @@ -3210,6 +3233,7 @@ default_imp_for_new_connector_integration_connector_authentication!( connectors::Nexixpay, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payu, connectors::Placetopay, connectors::Plaid, @@ -3326,6 +3350,7 @@ default_imp_for_new_connector_integration_revenue_recovery!( connectors::Payone, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payu, connectors::Placetopay, connectors::Plaid, @@ -3469,6 +3494,7 @@ default_imp_for_new_connector_integration_external_vault!( connectors::Payone, connectors::Paybox, connectors::Payeezy, + connectors::Payload, connectors::Payme, connectors::Paypal, connectors::Paystack, diff --git a/crates/hyperswitch_domain_models/src/configs.rs b/crates/hyperswitch_domain_models/src/configs.rs index f15ea290f56..16fbd3e1d31 100644 --- a/crates/hyperswitch_domain_models/src/configs.rs +++ b/crates/hyperswitch_domain_models/src/configs.rs @@ -83,6 +83,7 @@ pub struct Connectors { pub opennode: ConnectorParams, pub paybox: ConnectorParamsWithSecondaryBaseUrl, pub payeezy: ConnectorParams, + pub payload: ConnectorParams, pub payme: ConnectorParams, pub payone: ConnectorParams, pub paypal: ConnectorParams, diff --git a/crates/router/src/connector.rs b/crates/router/src/connector.rs index af2d9a52352..4b12c47118b 100644 --- a/crates/router/src/connector.rs +++ b/crates/router/src/connector.rs @@ -26,14 +26,14 @@ pub use hyperswitch_connectors::connectors::{ netcetera, netcetera::Netcetera, nexinets, nexinets::Nexinets, nexixpay, nexixpay::Nexixpay, nmi, nmi::Nmi, nomupay, nomupay::Nomupay, noon, noon::Noon, nordea, nordea::Nordea, novalnet, novalnet::Novalnet, nuvei, nuvei::Nuvei, opayo, opayo::Opayo, opennode, opennode::Opennode, - paybox, paybox::Paybox, payeezy, payeezy::Payeezy, payme, payme::Payme, payone, payone::Payone, - paypal, paypal::Paypal, paystack, paystack::Paystack, payu, payu::Payu, placetopay, - placetopay::Placetopay, plaid, plaid::Plaid, powertranz, powertranz::Powertranz, prophetpay, - prophetpay::Prophetpay, rapyd, rapyd::Rapyd, razorpay, razorpay::Razorpay, recurly, - recurly::Recurly, redsys, redsys::Redsys, riskified, riskified::Riskified, santander, - santander::Santander, shift4, shift4::Shift4, signifyd, signifyd::Signifyd, square, - square::Square, stax, stax::Stax, stripe, stripe::Stripe, stripebilling, - stripebilling::Stripebilling, taxjar, taxjar::Taxjar, threedsecureio, + paybox, paybox::Paybox, payeezy, payeezy::Payeezy, payload, payload::Payload, payme, + payme::Payme, payone, payone::Payone, paypal, paypal::Paypal, paystack, paystack::Paystack, + payu, payu::Payu, placetopay, placetopay::Placetopay, plaid, plaid::Plaid, powertranz, + powertranz::Powertranz, prophetpay, prophetpay::Prophetpay, rapyd, rapyd::Rapyd, razorpay, + razorpay::Razorpay, recurly, recurly::Recurly, redsys, redsys::Redsys, riskified, + riskified::Riskified, santander, santander::Santander, shift4, shift4::Shift4, signifyd, + signifyd::Signifyd, square, square::Square, stax, stax::Stax, stripe, stripe::Stripe, + stripebilling, stripebilling::Stripebilling, taxjar, taxjar::Taxjar, threedsecureio, threedsecureio::Threedsecureio, thunes, thunes::Thunes, tokenio, tokenio::Tokenio, trustpay, trustpay::Trustpay, tsys, tsys::Tsys, unified_authentication_service, unified_authentication_service::UnifiedAuthenticationService, vgs, vgs::Vgs, volt, volt::Volt, diff --git a/crates/router/src/core/admin.rs b/crates/router/src/core/admin.rs index 87b51c5ebb9..bf42028cbeb 100644 --- a/crates/router/src/core/admin.rs +++ b/crates/router/src/core/admin.rs @@ -1662,6 +1662,10 @@ impl ConnectorAuthTypeAndMetadataValidation<'_> { paybox::transformers::PayboxAuthType::try_from(self.auth_type)?; Ok(()) } + // api_enums::Connector::Payload => { + // paybox::transformers::PayloadAuthType::try_from(self.auth_type)?; + // Ok(()) + // } api_enums::Connector::Payme => { payme::transformers::PaymeAuthType::try_from(self.auth_type)?; Ok(()) diff --git a/crates/router/src/types/api.rs b/crates/router/src/types/api.rs index f26f8e7ae8d..e48c0268e82 100644 --- a/crates/router/src/types/api.rs +++ b/crates/router/src/types/api.rs @@ -529,6 +529,9 @@ impl ConnectorData { Ok(ConnectorEnum::Old(Box::new(connector::Paybox::new()))) } // "payeezy" => Ok(ConnectorIntegrationEnum::Old(Box::new(&connector::Payeezy)), As psync and rsync are not supported by this connector, it is added as template code for future usage + // enums::Connector::Payload => { + // Ok(ConnectorEnum::Old(Box::new(connector::Paybload::new()))) + // } enums::Connector::Payme => { Ok(ConnectorEnum::Old(Box::new(connector::Payme::new()))) } diff --git a/crates/router/src/types/transformers.rs b/crates/router/src/types/transformers.rs index 82ca2f7ae67..895e1764ad0 100644 --- a/crates/router/src/types/transformers.rs +++ b/crates/router/src/types/transformers.rs @@ -297,6 +297,7 @@ impl ForeignTryFrom<api_enums::Connector> for common_enums::RoutableConnectors { api_enums::Connector::Nuvei => Self::Nuvei, api_enums::Connector::Opennode => Self::Opennode, api_enums::Connector::Paybox => Self::Paybox, + // api_enums::Connector::Payload => Self::Payload, api_enums::Connector::Payme => Self::Payme, api_enums::Connector::Payone => Self::Payone, api_enums::Connector::Paypal => Self::Paypal, diff --git a/crates/router/tests/connectors/main.rs b/crates/router/tests/connectors/main.rs index 8005e84652b..90af2bd8d80 100644 --- a/crates/router/tests/connectors/main.rs +++ b/crates/router/tests/connectors/main.rs @@ -74,6 +74,7 @@ mod opennode; mod paybox; #[cfg(feature = "dummy_connector")] mod payeezy; +mod payload; mod payme; mod payone; mod paypal; diff --git a/crates/router/tests/connectors/payload.rs b/crates/router/tests/connectors/payload.rs new file mode 100644 index 00000000000..fcbff7090eb --- /dev/null +++ b/crates/router/tests/connectors/payload.rs @@ -0,0 +1,420 @@ +use masking::Secret; +use router::types::{self, api, domain, storage::enums}; +use test_utils::connector_auth; + +use crate::utils::{self, ConnectorActions}; + +#[derive(Clone, Copy)] +struct PayloadTest; +impl ConnectorActions for PayloadTest {} +impl utils::Connector for PayloadTest { + fn get_data(&self) -> api::ConnectorData { + use router::connector::Payload; + utils::construct_connector_data_old( + Box::new(Payload::new()), + types::Connector::DummyConnector1, + api::GetToken::Connector, + None, + ) + } + + fn get_auth_token(&self) -> types::ConnectorAuthType { + utils::to_connector_auth_type( + connector_auth::ConnectorAuthentication::new() + .payload + .expect("Missing connector authentication configuration") + .into(), + ) + } + + fn get_name(&self) -> String { + "payload".to_string() + } +} + +static CONNECTOR: PayloadTest = PayloadTest {}; + +fn get_default_payment_info() -> Option<utils::PaymentInfo> { + None +} + +fn payment_method_details() -> Option<types::PaymentsAuthorizeData> { + None +} + +// Cards Positive Tests +// Creates a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_only_authorize_payment() { + let response = CONNECTOR + .authorize_payment(payment_method_details(), get_default_payment_info()) + .await + .expect("Authorize payment response"); + assert_eq!(response.status, enums::AttemptStatus::Authorized); +} + +// Captures a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_capture_authorized_payment() { + let response = CONNECTOR + .authorize_and_capture_payment(payment_method_details(), None, get_default_payment_info()) + .await + .expect("Capture payment response"); + assert_eq!(response.status, enums::AttemptStatus::Charged); +} + +// Partially captures a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_capture_authorized_payment() { + let response = CONNECTOR + .authorize_and_capture_payment( + payment_method_details(), + Some(types::PaymentsCaptureData { + amount_to_capture: 50, + ..utils::PaymentCaptureType::default().0 + }), + get_default_payment_info(), + ) + .await + .expect("Capture payment response"); + assert_eq!(response.status, enums::AttemptStatus::Charged); +} + +// Synchronizes a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_authorized_payment() { + let authorize_response = CONNECTOR + .authorize_payment(payment_method_details(), get_default_payment_info()) + .await + .expect("Authorize payment response"); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + let response = CONNECTOR + .psync_retry_till_status_matches( + enums::AttemptStatus::Authorized, + Some(types::PaymentsSyncData { + connector_transaction_id: types::ResponseId::ConnectorTransactionId( + txn_id.unwrap(), + ), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .expect("PSync response"); + assert_eq!(response.status, enums::AttemptStatus::Authorized,); +} + +// Voids a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_void_authorized_payment() { + let response = CONNECTOR + .authorize_and_void_payment( + payment_method_details(), + Some(types::PaymentsCancelData { + connector_transaction_id: String::from(""), + cancellation_reason: Some("requested_by_customer".to_string()), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .expect("Void payment response"); + assert_eq!(response.status, enums::AttemptStatus::Voided); +} + +// Refunds a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_manually_captured_payment() { + let response = CONNECTOR + .capture_payment_and_refund( + payment_method_details(), + None, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Partially refunds a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_refund_manually_captured_payment() { + let response = CONNECTOR + .capture_payment_and_refund( + payment_method_details(), + None, + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Synchronizes a refund using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_manually_captured_refund() { + let refund_response = CONNECTOR + .capture_payment_and_refund( + payment_method_details(), + None, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + let response = CONNECTOR + .rsync_retry_till_status_matches( + enums::RefundStatus::Success, + refund_response.response.unwrap().connector_refund_id, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Creates a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_make_payment() { + let authorize_response = CONNECTOR + .make_payment(payment_method_details(), get_default_payment_info()) + .await + .unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); +} + +// Synchronizes a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_auto_captured_payment() { + let authorize_response = CONNECTOR + .make_payment(payment_method_details(), get_default_payment_info()) + .await + .unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + assert_ne!(txn_id, None, "Empty connector transaction id"); + let response = CONNECTOR + .psync_retry_till_status_matches( + enums::AttemptStatus::Charged, + Some(types::PaymentsSyncData { + connector_transaction_id: types::ResponseId::ConnectorTransactionId( + txn_id.unwrap(), + ), + capture_method: Some(enums::CaptureMethod::Automatic), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!(response.status, enums::AttemptStatus::Charged,); +} + +// Refunds a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_auto_captured_payment() { + let response = CONNECTOR + .make_payment_and_refund(payment_method_details(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Partially refunds a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_refund_succeeded_payment() { + let refund_response = CONNECTOR + .make_payment_and_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + refund_response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Creates multiple refunds against a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_succeeded_payment_multiple_times() { + CONNECTOR + .make_payment_and_multiple_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await; +} + +// Synchronizes a refund using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_refund() { + let refund_response = CONNECTOR + .make_payment_and_refund(payment_method_details(), None, get_default_payment_info()) + .await + .unwrap(); + let response = CONNECTOR + .rsync_retry_till_status_matches( + enums::RefundStatus::Success, + refund_response.response.unwrap().connector_refund_id, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Cards Negative scenarios +// Creates a payment with incorrect CVC. +#[actix_web::test] +async fn should_fail_payment_for_incorrect_cvc() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: domain::PaymentMethodData::Card(domain::Card { + card_cvc: Secret::new("12345".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's security code is invalid.".to_string(), + ); +} + +// Creates a payment with incorrect expiry month. +#[actix_web::test] +async fn should_fail_payment_for_invalid_exp_month() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: domain::PaymentMethodData::Card(domain::Card { + card_exp_month: Secret::new("20".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's expiration month is invalid.".to_string(), + ); +} + +// Creates a payment with incorrect expiry year. +#[actix_web::test] +async fn should_fail_payment_for_incorrect_expiry_year() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: domain::PaymentMethodData::Card(domain::Card { + card_exp_year: Secret::new("2000".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's expiration year is invalid.".to_string(), + ); +} + +// Voids a payment using automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_fail_void_payment_for_auto_capture() { + let authorize_response = CONNECTOR + .make_payment(payment_method_details(), get_default_payment_info()) + .await + .unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + assert_ne!(txn_id, None, "Empty connector transaction id"); + let void_response = CONNECTOR + .void_payment(txn_id.unwrap(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + void_response.response.unwrap_err().message, + "You cannot cancel this PaymentIntent because it has a status of succeeded." + ); +} + +// Captures a payment using invalid connector payment id. +#[actix_web::test] +async fn should_fail_capture_for_invalid_payment() { + let capture_response = CONNECTOR + .capture_payment("123456789".to_string(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + capture_response.response.unwrap_err().message, + String::from("No such payment_intent: '123456789'") + ); +} + +// Refunds a payment with refund amount higher than payment amount. +#[actix_web::test] +async fn should_fail_for_refund_amount_higher_than_payment_amount() { + let response = CONNECTOR + .make_payment_and_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 150, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Refund amount (₹1.50) is greater than charge amount (₹1.00)", + ); +} + +// Connector dependent test cases goes here + +// [#478]: add unit tests for non 3DS, wallets & webhooks in connector tests diff --git a/crates/router/tests/connectors/sample_auth.toml b/crates/router/tests/connectors/sample_auth.toml index 25c63908448..7d5a742aaf5 100644 --- a/crates/router/tests/connectors/sample_auth.toml +++ b/crates/router/tests/connectors/sample_auth.toml @@ -351,4 +351,7 @@ key1 ="Client Secret" [dwolla] api_key="Client ID" -key1="Client Secret" \ No newline at end of file +key1="Client Secret" + +[payload] +api_key="API Key" \ No newline at end of file diff --git a/crates/test_utils/src/connector_auth.rs b/crates/test_utils/src/connector_auth.rs index c92d4aa8591..fd0f9180910 100644 --- a/crates/test_utils/src/connector_auth.rs +++ b/crates/test_utils/src/connector_auth.rs @@ -80,6 +80,7 @@ pub struct ConnectorAuthentication { pub opennode: Option<HeaderKey>, pub paybox: Option<HeaderKey>, pub payeezy: Option<SignatureKey>, + pub payload: Option<HeaderKey>, pub payme: Option<BodyKey>, pub payone: Option<HeaderKey>, pub paypal: Option<BodyKey>, diff --git a/loadtest/config/development.toml b/loadtest/config/development.toml index 102daf94c6a..02298b9cc44 100644 --- a/loadtest/config/development.toml +++ b/loadtest/config/development.toml @@ -155,6 +155,7 @@ opennode.base_url = "https://dev-api.opennode.com" paybox.base_url = "https://preprod-ppps.paybox.com/PPPS.php" paybox.secondary_base_url = "https://preprod-tpeweb.paybox.com/" payeezy.base_url = "https://api-cert.payeezy.com/" +payload.base_url = "https://api.payload.com" payme.base_url = "https://sandbox.payme.io/" payone.base_url = "https://payment.preprod.payone.com/" paypal.base_url = "https://api-m.sandbox.paypal.com/" @@ -272,6 +273,7 @@ cards = [ "opennode", "paybox", "payeezy", + "payload", "payme", "payone", "paypal", diff --git a/scripts/add_connector.sh b/scripts/add_connector.sh index a76e9beacf9..534c1614a5e 100755 --- a/scripts/add_connector.sh +++ b/scripts/add_connector.sh @@ -6,7 +6,7 @@ function find_prev_connector() { git checkout $self cp $self $self.tmp # Add new connector to existing list and sort it - connectors=(aci adyen adyenplatform airwallex amazonpay applepay archipel authorizedotnet bambora bamboraapac bankofamerica barclaycard billwerk bitpay bluesnap boku braintree cashtocode chargebee checkbook checkout coinbase cryptopay ctp_visa cybersource datatrans deutschebank digitalvirgo dlocal dummyconnector dwolla ebanx elavon facilitapay fiserv fiservemea fiuu forte getnet globalpay globepay gocardless gpayments helcim hipay hyperswitch_vault iatapay inespay itaubank jpmorgan juspaythreedsserver klarna mifinity mollie moneris multisafepay netcetera nexinets nexixpay nomupay noon nordea novalnet nuvei opayo opennode paybox payeezy payme payone paypal paystack payu placetopay plaid powertranz prophetpay rapyd razorpay recurly redsys santander shift4 square stax stripe stripebilling taxjar threedsecureio thunes tokenio trustpay tsys unified_authentication_service vgs volt wellsfargo wellsfargopayout wise worldline worldpay worldpayvantiv worldpayxml xendit zsl "$1") + connectors=(aci adyen adyenplatform airwallex amazonpay applepay archipel authorizedotnet bambora bamboraapac bankofamerica barclaycard billwerk bitpay bluesnap boku braintree cashtocode chargebee checkbook checkout coinbase cryptopay ctp_visa cybersource datatrans deutschebank digitalvirgo dlocal dummyconnector dwolla ebanx elavon facilitapay fiserv fiservemea fiuu forte getnet globalpay globepay gocardless gpayments helcim hipay hyperswitch_vault iatapay inespay itaubank jpmorgan juspaythreedsserver klarna mifinity mollie moneris multisafepay netcetera nexinets nexixpay nomupay noon nordea novalnet nuvei opayo opennode paybox payeezy payload payme payone paypal paystack payu placetopay plaid powertranz prophetpay rapyd razorpay recurly redsys santander shift4 square stax stripe stripebilling taxjar threedsecureio thunes tokenio trustpay tsys unified_authentication_service vgs volt wellsfargo wellsfargopayout wise worldline worldpay worldpayvantiv worldpayxml xendit zsl "$1") IFS=$'\n' sorted=($(sort <<<"${connectors[*]}")); unset IFS res="$(echo ${sorted[@]})" sed -i'' -e "s/^ connectors=.*/ connectors=($res \"\$1\")/" $self.tmp @@ -210,4 +210,4 @@ echo "${GREEN}Successfully created connector. Running the tests of $payment_gate # Runs tests for the new connector cargo test --package router --test connectors -- $payment_gateway -echo "${ORANGE}Update your credentials for $payment_gateway connector in crates/router/tests/connectors/sample_auth.toml" \ No newline at end of file +echo "${ORANGE}Update your credentials for $payment_gateway connector in crates/router/tests/connectors/sample_auth.toml"

2025-07-02T07:58:09Z

## Type of Change  - [ ] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  Connector template code for new connector `Payload`. Check the attached issue for documentation and dashboard. Ref: https://github.com/juspay/hyperswitch/pull/8500 ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  1. `config` 2. `crates/router/src/configs` 3. `loadtest/config` ## Motivation and Context  Closes https://github.com/juspay/hyperswitch/issues/8527 ## How did you test it?  This is a template PR for Payload, just checked for compilation. Nothing else to test. ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `just clippy && just clippy_v2` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

f6aab3de0dbb57a7ac44a90e345dd5f00ea998c1

juspay/hyperswitch

juspay__hyperswitch-8516

Bug: [FEATURE] Add incremental authorization for Paypal, AuthorizeDotNet, Stripe ### Feature Description Add incremental authorization for Paypal, AuthorizeDotNet, Stripe ### Possible Implementation Add incremental authorization for Paypal, AuthorizeDotNet, Stripe ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? Yes, I am willing to submit a PR!

diff --git a/crates/hyperswitch_connectors/src/connectors/helcim.rs b/crates/hyperswitch_connectors/src/connectors/helcim.rs index 05165fbe91b..4845b2cbc7b 100644 --- a/crates/hyperswitch_connectors/src/connectors/helcim.rs +++ b/crates/hyperswitch_connectors/src/connectors/helcim.rs @@ -924,7 +924,7 @@ impl ConnectorTransactionId for Helcim { #[cfg(feature = "v1")] fn connector_transaction_id( &self, - payment_attempt: PaymentAttempt, + payment_attempt: &PaymentAttempt, ) -> Result<Option<String>, ApiErrorResponse> { if payment_attempt.get_connector_payment_id().is_none() { let metadata = @@ -940,7 +940,7 @@ impl ConnectorTransactionId for Helcim { #[cfg(feature = "v2")] fn connector_transaction_id( &self, - payment_attempt: PaymentAttempt, + payment_attempt: &PaymentAttempt, ) -> Result<Option<String>, ApiErrorResponse> { use hyperswitch_domain_models::errors::api_error_response::ApiErrorResponse; diff --git a/crates/hyperswitch_connectors/src/connectors/nexinets.rs b/crates/hyperswitch_connectors/src/connectors/nexinets.rs index 08084973c50..8733bede9c4 100644 --- a/crates/hyperswitch_connectors/src/connectors/nexinets.rs +++ b/crates/hyperswitch_connectors/src/connectors/nexinets.rs @@ -886,7 +886,7 @@ impl ConnectorTransactionId for Nexinets { #[cfg(feature = "v1")] fn connector_transaction_id( &self, - payment_attempt: PaymentAttempt, + payment_attempt: &PaymentAttempt, ) -> Result<Option<String>, ApiErrorResponse> { let metadata = Self::connector_transaction_id(self, payment_attempt.connector_metadata.as_ref()); @@ -896,7 +896,7 @@ impl ConnectorTransactionId for Nexinets { #[cfg(feature = "v2")] fn connector_transaction_id( &self, - payment_attempt: PaymentAttempt, + payment_attempt: &PaymentAttempt, ) -> Result<Option<String>, ApiErrorResponse> { use hyperswitch_domain_models::errors::api_error_response::ApiErrorResponse; diff --git a/crates/hyperswitch_connectors/src/connectors/paypal.rs b/crates/hyperswitch_connectors/src/connectors/paypal.rs index 578baba88b5..f90ac021fb2 100644 --- a/crates/hyperswitch_connectors/src/connectors/paypal.rs +++ b/crates/hyperswitch_connectors/src/connectors/paypal.rs @@ -20,8 +20,8 @@ use hyperswitch_domain_models::{ router_flow_types::{ access_token_auth::AccessTokenAuth, payments::{ - Authorize, Capture, PSync, PaymentMethodToken, PostSessionTokens, PreProcessing, - SdkSessionUpdate, Session, SetupMandate, Void, + Authorize, Capture, IncrementalAuthorization, PSync, PaymentMethodToken, + PostSessionTokens, PreProcessing, SdkSessionUpdate, Session, SetupMandate, Void, }, refunds::{Execute, RSync}, CompleteAuthorize, VerifyWebhookSource, @@ -29,19 +29,19 @@ use hyperswitch_domain_models::{ router_request_types::{ AccessTokenRequestData, CompleteAuthorizeData, PaymentMethodTokenizationData, PaymentsAuthorizeData, PaymentsCancelData, PaymentsCaptureData, - PaymentsPostSessionTokensData, PaymentsPreProcessingData, PaymentsSessionData, - PaymentsSyncData, RefundsData, ResponseId, SdkPaymentsSessionUpdateData, - SetupMandateRequestData, VerifyWebhookSourceRequestData, + PaymentsIncrementalAuthorizationData, PaymentsPostSessionTokensData, + PaymentsPreProcessingData, PaymentsSessionData, PaymentsSyncData, RefundsData, ResponseId, + SdkPaymentsSessionUpdateData, SetupMandateRequestData, VerifyWebhookSourceRequestData, }, router_response_types::{ PaymentsResponseData, RefundsResponseData, VerifyWebhookSourceResponseData, }, types::{ PaymentsAuthorizeRouterData, PaymentsCancelRouterData, PaymentsCaptureRouterData, - PaymentsCompleteAuthorizeRouterData, PaymentsPostSessionTokensRouterData, - PaymentsPreProcessingRouterData, PaymentsSyncRouterData, RefreshTokenRouterData, - RefundSyncRouterData, RefundsRouterData, SdkSessionUpdateRouterData, - SetupMandateRouterData, VerifyWebhookSourceRouterData, + PaymentsCompleteAuthorizeRouterData, PaymentsIncrementalAuthorizationRouterData, + PaymentsPostSessionTokensRouterData, PaymentsPreProcessingRouterData, + PaymentsSyncRouterData, RefreshTokenRouterData, RefundSyncRouterData, RefundsRouterData, + SdkSessionUpdateRouterData, SetupMandateRouterData, VerifyWebhookSourceRouterData, }, }; #[cfg(feature = "payouts")] @@ -55,17 +55,17 @@ use hyperswitch_interfaces::types::{PayoutFulfillType, PayoutSyncType}; use hyperswitch_interfaces::{ api::{ self, ConnectorCommon, ConnectorCommonExt, ConnectorIntegration, ConnectorRedirectResponse, - ConnectorSpecifications, ConnectorValidation, + ConnectorSpecifications, ConnectorValidation, PaymentIncrementalAuthorization, }, configs::Connectors, consts::{NO_ERROR_CODE, NO_ERROR_MESSAGE}, disputes, errors, events::connector_api_logs::ConnectorEvent, types::{ - PaymentsAuthorizeType, PaymentsCaptureType, PaymentsCompleteAuthorizeType, - PaymentsPostSessionTokensType, PaymentsPreProcessingType, PaymentsSyncType, - PaymentsVoidType, RefreshTokenType, RefundExecuteType, RefundSyncType, Response, - SdkSessionUpdateType, SetupMandateType, VerifyWebhookSourceType, + IncrementalAuthorizationType, PaymentsAuthorizeType, PaymentsCaptureType, + PaymentsCompleteAuthorizeType, PaymentsPostSessionTokensType, PaymentsPreProcessingType, + PaymentsSyncType, PaymentsVoidType, RefreshTokenType, RefundExecuteType, RefundSyncType, + Response, SdkSessionUpdateType, SetupMandateType, VerifyWebhookSourceType, }, webhooks::{IncomingWebhook, IncomingWebhookRequestDetails}, }; @@ -73,7 +73,8 @@ use masking::{ExposeInterface, Mask, Maskable, PeekInterface, Secret}; #[cfg(feature = "payouts")] use router_env::{instrument, tracing}; use transformers::{ - self as paypal, auth_headers, PaypalAuthResponse, PaypalMeta, PaypalWebhookEventType, + self as paypal, auth_headers, PaypalAuthResponse, PaypalIncrementalAuthResponse, PaypalMeta, + PaypalWebhookEventType, }; use crate::{ @@ -1105,6 +1106,123 @@ impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData } } +impl PaymentIncrementalAuthorization for Paypal {} + +impl + ConnectorIntegration< + IncrementalAuthorization, + PaymentsIncrementalAuthorizationData, + PaymentsResponseData, + > for Paypal +{ + fn get_headers( + &self, + req: &PaymentsIncrementalAuthorizationRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_http_method(&self) -> Method { + Method::Post + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + req: &PaymentsIncrementalAuthorizationRouterData, + connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + let paypal_meta: PaypalMeta = to_connector_meta(req.request.connector_meta.clone())?; + let incremental_authorization_id = paypal_meta.incremental_authorization_id.ok_or( + errors::ConnectorError::RequestEncodingFailedWithReason( + "Missing incremental authorization id".to_string(), + ), + )?; + Ok(format!( + "{}v2/payments/authorizations/{}/reauthorize", + self.base_url(connectors), + incremental_authorization_id + )) + } + + fn get_request_body( + &self, + req: &PaymentsIncrementalAuthorizationRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let amount = connector_utils::convert_amount( + self.amount_converter, + MinorUnit::new(req.request.total_amount), + req.request.currency, + )?; + let connector_router_data = + paypal::PaypalRouterData::try_from((amount, None, None, None, req))?; + let connector_req = paypal::PaypalIncrementalAuthRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &PaymentsIncrementalAuthorizationRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&IncrementalAuthorizationType::get_url( + self, req, connectors, + )?) + .attach_default_headers() + .headers(IncrementalAuthorizationType::get_headers( + self, req, connectors, + )?) + .set_body(IncrementalAuthorizationType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsIncrementalAuthorizationRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult< + RouterData< + IncrementalAuthorization, + PaymentsIncrementalAuthorizationData, + PaymentsResponseData, + >, + errors::ConnectorError, + > { + let response: PaypalIncrementalAuthResponse = res + .response + .parse_struct("Paypal IncrementalAuthResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + .change_context(errors::ConnectorError::ResponseHandlingFailed) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + impl api::PaymentsPreProcessing for Paypal {} impl ConnectorIntegration<PreProcessing, PaymentsPreProcessingData, PaymentsResponseData> diff --git a/crates/hyperswitch_connectors/src/connectors/paypal/transformers.rs b/crates/hyperswitch_connectors/src/connectors/paypal/transformers.rs index 8cabfcf4663..3814694b08b 100644 --- a/crates/hyperswitch_connectors/src/connectors/paypal/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/paypal/transformers.rs @@ -19,7 +19,8 @@ use hyperswitch_domain_models::{ VerifyWebhookSource, }, router_request_types::{ - PaymentsAuthorizeData, PaymentsPostSessionTokensData, PaymentsSyncData, ResponseId, + CompleteAuthorizeData, PaymentsAuthorizeData, PaymentsIncrementalAuthorizationData, + PaymentsPostSessionTokensData, PaymentsSyncData, ResponseId, VerifyWebhookSourceRequestData, }, router_response_types::{ @@ -28,8 +29,9 @@ use hyperswitch_domain_models::{ }, types::{ PaymentsAuthorizeRouterData, PaymentsCaptureRouterData, - PaymentsPostSessionTokensRouterData, RefreshTokenRouterData, RefundsRouterData, - SdkSessionUpdateRouterData, SetupMandateRouterData, VerifyWebhookSourceRouterData, + PaymentsIncrementalAuthorizationRouterData, PaymentsPostSessionTokensRouterData, + RefreshTokenRouterData, RefundsRouterData, SdkSessionUpdateRouterData, + SetupMandateRouterData, VerifyWebhookSourceRouterData, }, }; #[cfg(feature = "payouts")] @@ -55,6 +57,28 @@ use crate::{ }, }; +trait GetRequestIncrementalAuthorization { + fn get_request_incremental_authorization(&self) -> Option<bool>; +} + +impl GetRequestIncrementalAuthorization for PaymentsAuthorizeData { + fn get_request_incremental_authorization(&self) -> Option<bool> { + Some(self.request_incremental_authorization) + } +} + +impl GetRequestIncrementalAuthorization for CompleteAuthorizeData { + fn get_request_incremental_authorization(&self) -> Option<bool> { + None + } +} + +impl GetRequestIncrementalAuthorization for PaymentsSyncData { + fn get_request_incremental_authorization(&self) -> Option<bool> { + None + } +} + #[derive(Debug, Serialize)] pub struct PaypalRouterData<T> { pub amount: StringMajorUnit, @@ -237,7 +261,7 @@ pub struct PurchaseUnitRequest { items: Vec<ItemDetails>, } -#[derive(Default, Debug, Serialize, Eq, PartialEq)] +#[derive(Default, Debug, Deserialize, Serialize, Eq, PartialEq)] pub struct Payee { merchant_id: Secret<String>, } @@ -1425,6 +1449,119 @@ impl<F, T> TryFrom<ResponseRouterData<F, PaypalAuthUpdateResponse, T, AccessToke } } +#[derive(Debug, Serialize)] +pub struct PaypalIncrementalAuthRequest { + amount: OrderAmount, +} + +impl TryFrom<&PaypalRouterData<&PaymentsIncrementalAuthorizationRouterData>> + for PaypalIncrementalAuthRequest +{ + type Error = error_stack::Report<errors::ConnectorError>; + + fn try_from( + item: &PaypalRouterData<&PaymentsIncrementalAuthorizationRouterData>, + ) -> Result<Self, Self::Error> { + Ok(Self { + amount: OrderAmount { + currency_code: item.router_data.request.currency, + value: item.amount.clone(), + }, + }) + } +} + +#[derive(Debug, Deserialize, Serialize)] +pub struct PaypalIncrementalAuthResponse { + status: PaypalIncrementalStatus, + status_details: PaypalIncrementalAuthStatusDetails, + id: String, + invoice_id: String, + custom_id: String, + links: Vec<PaypalLinks>, + amount: OrderAmount, + network_transaction_reference: PaypalNetworkTransactionReference, + expiration_time: String, + create_time: String, + update_time: String, + supplementary_data: PaypalSupplementaryData, + payee: Payee, + name: Option<String>, + message: Option<String>, +} + +#[derive(Debug, Deserialize, Serialize)] +#[serde(rename_all = "SCREAMING_SNAKE_CASE")] +pub enum PaypalIncrementalStatus { + CREATED, + CAPTURED, + DENIED, + PARTIALLYCAPTURED, + VOIDED, + PENDING, +} + +#[derive(Debug, Deserialize, Serialize)] +pub struct PaypalNetworkTransactionReference { + id: String, +} + +#[derive(Debug, Deserialize, Serialize)] +pub struct PaypalIncrementalAuthStatusDetails { + reason: PaypalStatusPendingReason, +} + +#[derive(Debug, Deserialize, Serialize)] +#[serde(rename_all = "SCREAMING_SNAKE_CASE")] +pub enum PaypalStatusPendingReason { + PENDINGREVIEW, + DECLINEDBYRISKFRAUDFILTERS, +} + +impl From<PaypalIncrementalStatus> for common_enums::AuthorizationStatus { + fn from(item: PaypalIncrementalStatus) -> Self { + match item { + PaypalIncrementalStatus::CREATED + | PaypalIncrementalStatus::CAPTURED + | PaypalIncrementalStatus::PARTIALLYCAPTURED => Self::Success, + PaypalIncrementalStatus::PENDING => Self::Processing, + PaypalIncrementalStatus::DENIED | PaypalIncrementalStatus::VOIDED => Self::Failure, + } + } +} + +impl<F> + TryFrom< + ResponseRouterData< + F, + PaypalIncrementalAuthResponse, + PaymentsIncrementalAuthorizationData, + PaymentsResponseData, + >, + > for RouterData<F, PaymentsIncrementalAuthorizationData, PaymentsResponseData> +{ + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: ResponseRouterData< + F, + PaypalIncrementalAuthResponse, + PaymentsIncrementalAuthorizationData, + PaymentsResponseData, + >, + ) -> Result<Self, Self::Error> { + let status = common_enums::AuthorizationStatus::from(item.response.status); + Ok(Self { + response: Ok(PaymentsResponseData::IncrementalAuthorizationResponse { + status, + error_code: None, + error_message: None, + connector_authorization_id: Some(item.response.id), + }), + ..item.data + }) + } +} + #[derive(Debug)] pub enum PaypalAuthType { TemporaryAuth, @@ -1747,6 +1884,7 @@ pub struct CardDetails { pub struct PaypalMeta { pub authorize_id: Option<String>, pub capture_id: Option<String>, + pub incremental_authorization_id: Option<String>, pub psync_flow: PaypalPaymentIntent, pub next_action: Option<api_models::payments::NextActionCall>, pub order_id: Option<String>, @@ -1782,12 +1920,25 @@ fn get_id_based_on_intent( .ok_or_else(|| errors::ConnectorError::MissingConnectorTransactionID.into()) } -impl<F, T> TryFrom<ResponseRouterData<F, PaypalOrdersResponse, T, PaymentsResponseData>> - for RouterData<F, T, PaymentsResponseData> +fn extract_incremental_authorization_id(response: &PaypalOrdersResponse) -> Option<String> { + for unit in &response.purchase_units { + if let Some(authorizations) = &unit.payments.authorizations { + if let Some(first_auth) = authorizations.first() { + return Some(first_auth.id.clone()); + } + } + } + None +} + +impl<F, Req> TryFrom<ResponseRouterData<F, PaypalOrdersResponse, Req, PaymentsResponseData>> + for RouterData<F, Req, PaymentsResponseData> +where + Req: GetRequestIncrementalAuthorization, { type Error = error_stack::Report<errors::ConnectorError>; fn try_from( - item: ResponseRouterData<F, PaypalOrdersResponse, T, PaymentsResponseData>, + item: ResponseRouterData<F, PaypalOrdersResponse, Req, PaymentsResponseData>, ) -> Result<Self, Self::Error> { let purchase_units = item .response @@ -1801,6 +1952,7 @@ impl<F, T> TryFrom<ResponseRouterData<F, PaypalOrdersResponse, T, PaymentsRespon serde_json::json!(PaypalMeta { authorize_id: None, capture_id: Some(id), + incremental_authorization_id: None, psync_flow: item.response.intent.clone(), next_action: None, order_id: None, @@ -1812,6 +1964,9 @@ impl<F, T> TryFrom<ResponseRouterData<F, PaypalOrdersResponse, T, PaymentsRespon serde_json::json!(PaypalMeta { authorize_id: Some(id), capture_id: None, + incremental_authorization_id: extract_incremental_authorization_id( + &item.response + ), psync_flow: item.response.intent.clone(), next_action: None, order_id: None, @@ -1872,7 +2027,10 @@ impl<F, T> TryFrom<ResponseRouterData<F, PaypalOrdersResponse, T, PaymentsRespon .invoice_id .clone() .or(Some(item.response.id)), - incremental_authorization_allowed: None, + incremental_authorization_allowed: item + .data + .request + .get_request_incremental_authorization(), charges: None, }), ..item.data @@ -1965,6 +2123,7 @@ impl<F, T> let connector_meta = serde_json::json!(PaypalMeta { authorize_id: None, capture_id: None, + incremental_authorization_id: None, psync_flow: item.response.intent, next_action, order_id: None, @@ -2017,6 +2176,7 @@ impl let connector_meta = serde_json::json!(PaypalMeta { authorize_id: None, capture_id: None, + incremental_authorization_id: None, psync_flow: item.response.intent, next_action: None, order_id: None, @@ -2072,6 +2232,7 @@ impl let connector_meta = serde_json::json!(PaypalMeta { authorize_id: None, capture_id: None, + incremental_authorization_id: None, psync_flow: item.response.intent, next_action, order_id: Some(item.response.id.clone()), @@ -2144,6 +2305,7 @@ impl<F> let connector_meta = serde_json::json!(PaypalMeta { authorize_id: None, capture_id: None, + incremental_authorization_id: None, psync_flow: PaypalPaymentIntent::Authenticate, // when there is no capture or auth id present next_action: None, order_id: None, @@ -2550,6 +2712,7 @@ impl TryFrom<PaymentsCaptureResponseRouterData<PaypalCaptureResponse>> connector_metadata: Some(serde_json::json!(PaypalMeta { authorize_id: connector_payment_id.authorize_id, capture_id: Some(item.response.id.clone()), + incremental_authorization_id: None, psync_flow: PaypalPaymentIntent::Capture, next_action: None, order_id: None, diff --git a/crates/hyperswitch_connectors/src/default_implementations.rs b/crates/hyperswitch_connectors/src/default_implementations.rs index 38e63124029..bdf3ee5604b 100644 --- a/crates/hyperswitch_connectors/src/default_implementations.rs +++ b/crates/hyperswitch_connectors/src/default_implementations.rs @@ -1086,7 +1086,6 @@ default_imp_for_incremental_authorization!( connectors::Payload, connectors::Payme, connectors::Payone, - connectors::Paypal, connectors::Paystack, connectors::Payu, connectors::Placetopay, diff --git a/crates/hyperswitch_domain_models/src/router_request_types.rs b/crates/hyperswitch_domain_models/src/router_request_types.rs index 31879b4cfe3..fd37b30f6f8 100644 --- a/crates/hyperswitch_domain_models/src/router_request_types.rs +++ b/crates/hyperswitch_domain_models/src/router_request_types.rs @@ -155,6 +155,7 @@ pub struct PaymentsIncrementalAuthorizationData { pub currency: storage_enums::Currency, pub reason: Option<String>, pub connector_transaction_id: String, + pub connector_meta: Option<serde_json::Value>, } #[derive(Debug, Clone, Default)] diff --git a/crates/hyperswitch_interfaces/src/api.rs b/crates/hyperswitch_interfaces/src/api.rs index 4162eb29094..70d1bc2c1b6 100644 --- a/crates/hyperswitch_interfaces/src/api.rs +++ b/crates/hyperswitch_interfaces/src/api.rs @@ -722,7 +722,7 @@ pub trait ConnectorTransactionId: ConnectorCommon + Sync { /// fn connector_transaction_id fn connector_transaction_id( &self, - payment_attempt: hyperswitch_domain_models::payments::payment_attempt::PaymentAttempt, + payment_attempt: &hyperswitch_domain_models::payments::payment_attempt::PaymentAttempt, ) -> Result<Option<String>, ApiErrorResponse> { Ok(payment_attempt .get_connector_payment_id() diff --git a/crates/hyperswitch_interfaces/src/connector_integration_interface.rs b/crates/hyperswitch_interfaces/src/connector_integration_interface.rs index 998df9ec61c..c40c65ac5f7 100644 --- a/crates/hyperswitch_interfaces/src/connector_integration_interface.rs +++ b/crates/hyperswitch_interfaces/src/connector_integration_interface.rs @@ -793,7 +793,7 @@ impl api::ConnectorTransactionId for ConnectorEnum { /// A `Result` containing an optional transaction ID or an ApiErrorResponse fn connector_transaction_id( &self, - payment_attempt: hyperswitch_domain_models::payments::payment_attempt::PaymentAttempt, + payment_attempt: &hyperswitch_domain_models::payments::payment_attempt::PaymentAttempt, ) -> Result<Option<String>, ApiErrorResponse> { match self { Self::Old(connector) => connector.connector_transaction_id(payment_attempt), diff --git a/crates/router/src/core/payments/transformers.rs b/crates/router/src/core/payments/transformers.rs index 2379dddb8fd..1cd67d61f68 100644 --- a/crates/router/src/core/payments/transformers.rs +++ b/crates/router/src/core/payments/transformers.rs @@ -478,7 +478,7 @@ pub async fn construct_payment_router_data_for_capture<'a>( currency: payment_data.payment_intent.amount_details.currency, connector_transaction_id: connector .connector - .connector_transaction_id(payment_data.payment_attempt.clone())? + .connector_transaction_id(&payment_data.payment_attempt)? .ok_or(errors::ApiErrorResponse::ResourceIdNotFound)?, payment_amount: amount.get_amount_as_i64(), // This should be removed once we start moving to connector module minor_payment_amount: amount, @@ -3756,6 +3756,7 @@ impl<F: Clone> TryFrom<PaymentAdditionalData<'_, F>> for types::PaymentsSyncData } } +#[cfg(feature = "v1")] impl<F: Clone> TryFrom<PaymentAdditionalData<'_, F>> for types::PaymentsIncrementalAuthorizationData { @@ -3763,39 +3764,68 @@ impl<F: Clone> TryFrom<PaymentAdditionalData<'_, F>> fn try_from(additional_data: PaymentAdditionalData<'_, F>) -> Result<Self, Self::Error> { let payment_data = additional_data.payment_data; + let payment_attempt = &payment_data.payment_attempt; let connector = api::ConnectorData::get_connector_by_name( &additional_data.state.conf.connectors, &additional_data.connector_name, api::GetToken::Connector, - payment_data.payment_attempt.merchant_connector_id.clone(), + payment_attempt.merchant_connector_id.clone(), )?; - let total_amount = payment_data + let incremental_details = payment_data .incremental_authorization_details - .clone() - .map(|details| details.total_amount) + .as_ref() .ok_or( report!(errors::ApiErrorResponse::InternalServerError) .attach_printable("missing incremental_authorization_details in payment_data"), )?; - let additional_amount = payment_data + Ok(Self { + total_amount: incremental_details.total_amount.get_amount_as_i64(), + additional_amount: incremental_details.additional_amount.get_amount_as_i64(), + reason: incremental_details.reason.clone(), + currency: payment_data.currency, + connector_transaction_id: connector + .connector + .connector_transaction_id(payment_attempt)? + .ok_or(errors::ApiErrorResponse::ResourceIdNotFound)?, + connector_meta: payment_attempt.connector_metadata.clone(), + }) + } +} + +#[cfg(feature = "v2")] +impl<F: Clone> TryFrom<PaymentAdditionalData<'_, F>> + for types::PaymentsIncrementalAuthorizationData +{ + type Error = error_stack::Report<errors::ApiErrorResponse>; + + fn try_from(additional_data: PaymentAdditionalData<'_, F>) -> Result<Self, Self::Error> { + let payment_data = additional_data.payment_data; + let connector = api::ConnectorData::get_connector_by_name( + &additional_data.state.conf.connectors, + &additional_data.connector_name, + api::GetToken::Connector, + payment_data.payment_attempt.merchant_connector_id.clone(), + )?; + let incremental_details = payment_data .incremental_authorization_details - .clone() - .map(|details| details.additional_amount) + .as_ref() .ok_or( report!(errors::ApiErrorResponse::InternalServerError) .attach_printable("missing incremental_authorization_details in payment_data"), )?; Ok(Self { - total_amount: total_amount.get_amount_as_i64(), - additional_amount: additional_amount.get_amount_as_i64(), - reason: payment_data - .incremental_authorization_details - .and_then(|details| details.reason), + total_amount: incremental_details.total_amount.get_amount_as_i64(), + additional_amount: incremental_details.additional_amount.get_amount_as_i64(), + reason: incremental_details.reason.clone(), currency: payment_data.currency, connector_transaction_id: connector .connector - .connector_transaction_id(payment_data.payment_attempt.clone())? + .connector_transaction_id(&payment_data.payment_attempt)? .ok_or(errors::ApiErrorResponse::ResourceIdNotFound)?, + connector_meta: payment_data + .payment_attempt + .connector_metadata + .map(|secret| secret.expose()), }) } } @@ -3828,7 +3858,7 @@ impl<F: Clone> TryFrom<PaymentAdditionalData<'_, F>> for types::PaymentsCaptureD currency: payment_data.currency, connector_transaction_id: connector .connector - .connector_transaction_id(payment_data.payment_attempt.clone())? + .connector_transaction_id(&payment_data.payment_attempt)? .ok_or(errors::ApiErrorResponse::ResourceIdNotFound)?, payment_amount: amount.get_amount_as_i64(), // This should be removed once we start moving to connector module minor_payment_amount: amount, @@ -3896,7 +3926,7 @@ impl<F: Clone> TryFrom<PaymentAdditionalData<'_, F>> for types::PaymentsCaptureD currency: payment_data.currency, connector_transaction_id: connector .connector - .connector_transaction_id(payment_data.payment_attempt.clone())? + .connector_transaction_id(&payment_data.payment_attempt)? .ok_or(errors::ApiErrorResponse::ResourceIdNotFound)?, payment_amount: amount.get_amount_as_i64(), // This should be removed once we start moving to connector module minor_payment_amount: amount, @@ -3973,7 +4003,7 @@ impl<F: Clone> TryFrom<PaymentAdditionalData<'_, F>> for types::PaymentsCancelDa currency: Some(payment_data.currency), connector_transaction_id: connector .connector - .connector_transaction_id(payment_data.payment_attempt.clone())? + .connector_transaction_id(&payment_data.payment_attempt)? .ok_or(errors::ApiErrorResponse::ResourceIdNotFound)?, cancellation_reason: payment_data.payment_attempt.cancellation_reason, connector_meta: payment_data.payment_attempt.connector_metadata, @@ -4127,7 +4157,7 @@ impl<F: Clone> TryFrom<PaymentAdditionalData<'_, F>> for types::PaymentsUpdateMe .attach_printable("payment_intent.metadata not found")?, connector_transaction_id: connector .connector - .connector_transaction_id(payment_data.payment_attempt.clone())? + .connector_transaction_id(&payment_data.payment_attempt)? .ok_or(errors::ApiErrorResponse::ResourceIdNotFound)?, }) }

2025-07-01T23:24:24Z

## Type of Change  - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD Closes this [issue](https://github.com/juspay/hyperswitch/issues/8516) ## Description  Added Incremental Authorization flow for Paypal ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  https://github.com/juspay/hyperswitch/issues/8516 ## How did you test it?  Postman Test Payments - Create: Request: ``` curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_1PzpFzUXX4ZALEpOUNRFMeXyRB2WCZHfhd6AXOKifb7fqVRfrUFQLiqS4DchmszP' \ --data-raw ' { "amount": 1000, "currency": "USD", "confirm": true, "capture_method": "manual", "capture_on": "2022-09-10T10:11:12Z", "amount_to_capture": 1000, "customer_id": "StripeCustomer", "email": "[email protected]", "name": "John Doe", "phone": "999999999", "phone_country_code": "+65", "description": "Its my first payment request", "authentication_type": "no_three_ds", "return_url": "https://duck.com", "billing": { "address": { "first_name": "John", "last_name": "Doe", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "AT" } }, "payment_method": "card", "payment_method_type": "credit", "payment_method_data": { "card": { "card_number": "4111111111111111", "card_exp_month": "11", "card_exp_year": "2030", "card_holder_name": "joseph Doe", "card_cvc": "276" } }, "browser_info": { "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8", "language": "nl-NL", "color_depth": 24, "screen_height": 723, "screen_width": 1536, "time_zone": 0, "java_enabled": true, "java_script_enabled": true, "ip_address": "127.0.0.1" }, "shipping": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "John", "last_name": "Doe" } }, "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "metadata": { "udf1": "value1", "new_customer": "true", "login_date": "2019-09-10T10:11:12Z" }, "request_incremental_authorization": true }' ``` Response: ``` { "payment_id": "pay_1agl8yqCWefEuD7cM9DK", "merchant_id": "merchant_1751411099", "status": "requires_capture", "amount": 1000, "net_amount": 1000, "shipping_cost": null, "amount_capturable": 1000, "amount_received": null, "connector": "paypal", "client_secret": "pay_1agl8yqCWefEuD7cM9DK_secret_iYISlExnoU9wZBlUbA0J", "created": "2025-07-01T23:05:08.941Z", "currency": "USD", "customer_id": "StripeCustomer", "customer": { "id": "StripeCustomer", "name": "John Doe", "email": "[email protected]", "phone": "999999999", "phone_country_code": "+65" }, "description": "Its my first payment request", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "manual", "payment_method": "card", "payment_method_data": { "card": { "last4": "1111", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "411111", "card_extended_bin": null, "card_exp_month": "11", "card_exp_year": "2030", "card_holder_name": "joseph Doe", "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "John", "last_name": "Doe" }, "phone": null, "email": null }, "billing": { "address": { "city": "San Fransico", "country": "AT", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "John", "last_name": "Doe" }, "phone": null, "email": null }, "order_details": null, "email": "[email protected]", "name": "John Doe", "phone": "999999999", "return_url": "https://duck.com/", "authentication_type": "no_three_ds", "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "credit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": { "customer_id": "StripeCustomer", "created_at": 1751411108, "expires": 1751414708, "secret": "epk_dc7e9d0a449a4c28816179c01355a423" }, "manual_retry_allowed": false, "connector_transaction_id": "120066274887", "frm_message": null, "metadata": { "udf1": "value1", "login_date": "2019-09-10T10:11:12Z", "new_customer": "true" }, "connector_metadata": null, "feature_metadata": null, "reference_id": "120066274887", "payment_link": null, "profile_id": "pro_ufQauYhoCJvm3iPPC8mG", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_6BJ52EkitWXtjk3xh9jx", "incremental_authorization_allowed": true, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-07-01T23:20:08.940Z", "fingerprint": null, "browser_info": { "language": "nl-NL", "time_zone": 0, "ip_address": "127.0.0.1", "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "color_depth": 24, "java_enabled": true, "screen_width": 1536, "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8", "screen_height": 723, "java_script_enabled": true }, "payment_method_id": null, "payment_method_status": null, "updated": "2025-07-01T23:05:11.094Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` Incremental Authorization: Request: ``` curl --location 'http://localhost:8080/payments/pay_1agl8yqCWefEuD7cM9DK/incremental_authorization' \ --header 'Content-Type: application/json' \ --header 'api-key: dev_1PzpFzUXX4ZALEpOUNRFMeXyRB2WCZHfhd6AXOKifb7fqVRfrUFQLiqS4DchmszP' \ --data '{ "amount": 6540, "reason": "customer gone overbudget" }' ``` **NOTE**: The response will return failure status if the payment authorization has not yet surpassed the 4-day threshold. As per Paypal's documentation, a payment becomes eligible for incremental authorization only after the initial authorization is older than 4 days. Response: ``` { "payment_id": "pay_KorlaZqtqUdTrpKtGhwj", "merchant_id": "merchant_1751412204", "status": "requires_capture", "amount": 1050, "net_amount": 1050, "shipping_cost": null, "amount_capturable": 1050, "amount_received": null, "connector": "paypal", "client_secret": "pay_KorlaZqtqUdTrpKtGhwj_secret_JvQWos0QgC06DTMUIUod", "created": "2025-07-01T23:23:32.564Z", "currency": "USD", "customer_id": null, "customer": { "id": null, "name": "John Doe", "email": "[email protected]", "phone": "999999999", "phone_country_code": "+65" }, "description": "Its my first payment request", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "manual", "payment_method": "card", "payment_method_data": { "card": { "last4": "1111", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "411111", "card_extended_bin": null, "card_exp_month": "11", "card_exp_year": "2030", "card_holder_name": "joseph Doe", "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": null, "billing": null, "order_details": null, "email": null, "name": null, "phone": null, "return_url": "https://duck.com/", "authentication_type": "no_three_ds", "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "credit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": false, "connector_transaction_id": "4657001324168371U", "frm_message": null, "metadata": { "udf1": "value1", "login_date": "2019-09-10T10:11:12Z", "new_customer": "true" }, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_KorlaZqtqUdTrpKtGhwj_1", "payment_link": null, "profile_id": "pro_K0AcXOIDkvcyvNd6AU0K", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_frPGdve129UARoghNL0x", "incremental_authorization_allowed": true, "authorization_count": 2, "incremental_authorizations": [ { "authorization_id": "auth_bdKFP2R2zflE7nGe7DSm_1", "amount": 6540, "status": "failure", "error_code": "REAUTHORIZATION_TOO_SOON", "error_message": "REAUTHORIZATION_TOO_SOON", "previously_authorized_amount": 1000 }, { "authorization_id": "auth_fkKGl3yaPor09wvHf7KmS_2", "amount": 1050, "status": "succeeded", "error_code": null, "error_message": null, "previously_authorized_amount": 1000 }, ], "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-07-01T23:38:32.564Z", "fingerprint": null, "browser_info": { "language": "nl-NL", "time_zone": 0, "ip_address": "127.0.0.1", "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "color_depth": 24, "java_enabled": true, "screen_width": 1536, "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8", "screen_height": 723, "java_script_enabled": true }, "payment_method_id": null, "payment_method_status": null, "updated": "2025-07-01T23:23:41.215Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` Cypress Screenshot for Incremental Authorization: <img width="627" height="416" alt="Screenshot 2025-07-14 at 1 34 28 PM" src="https://github.com/user-attachments/assets/b7917284-2f90-484e-b720-162ae28a1b32" /> ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

3c498714e76b400657fc0fc25b7559ca3dca1908

juspay/hyperswitch

juspay__hyperswitch-8493

Bug: [FEATURE] [CONNECTOR] Checkbook ### Feature Description Integrate a new connector : Checkbook API Ref: https://docs.checkbook.io/reference/ ### Possible Implementation Integrate a new connector : Checkbook API Ref: https://docs.checkbook.io/reference/ ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? Yes, I am willing to submit a PR!

diff --git a/config/config.example.toml b/config/config.example.toml index c781ec3705b..7d072f93e47 100644 --- a/config/config.example.toml +++ b/config/config.example.toml @@ -203,6 +203,7 @@ boku.base_url = "https://$-api4-stage.boku.com" braintree.base_url = "https://payments.sandbox.braintree-api.com/graphql" cashtocode.base_url = "https://cluster05.api-test.cashtocode.com" chargebee.base_url = "https://$.chargebee.com/api/" +checkbook.base_url = "https://api.sandbox.checkbook.io" checkout.base_url = "https://api.sandbox.checkout.com/" coinbase.base_url = "https://api.commerce.coinbase.com" coingate.base_url = "https://api-sandbox.coingate.com" @@ -344,6 +345,7 @@ cards = [ "coingate", "cryptopay", "braintree", + "checkbook", "checkout", "cybersource", "datatrans", diff --git a/config/deployments/integration_test.toml b/config/deployments/integration_test.toml index 898a84e7db0..2431f89a0ab 100644 --- a/config/deployments/integration_test.toml +++ b/config/deployments/integration_test.toml @@ -42,6 +42,7 @@ boku.base_url = "https://$-api4-stage.boku.com" braintree.base_url = "https://payments.sandbox.braintree-api.com/graphql" cashtocode.base_url = "https://cluster05.api-test.cashtocode.com" chargebee.base_url = "https://$.chargebee.com/api/" +checkbook.base_url = "https://api.sandbox.checkbook.io" checkout.base_url = "https://api.sandbox.checkout.com/" coinbase.base_url = "https://api.commerce.coinbase.com" coingate.base_url = "https://api-sandbox.coingate.com" diff --git a/config/deployments/production.toml b/config/deployments/production.toml index f08bb64136c..2f4e00d1137 100644 --- a/config/deployments/production.toml +++ b/config/deployments/production.toml @@ -46,6 +46,7 @@ boku.base_url = "https://country-api4-stage.boku.com" braintree.base_url = "https://payments.braintree-api.com/graphql" cashtocode.base_url = "https://cluster14.api.cashtocode.com" chargebee.base_url = "https://{{merchant_endpoint_prefix}}.chargebee.com/api/" +checkbook.base_url = "https://api.checkbook.io" checkout.base_url = "https://api.checkout.com/" coinbase.base_url = "https://api.commerce.coinbase.com" coingate.base_url = "https://api.coingate.com" diff --git a/config/deployments/sandbox.toml b/config/deployments/sandbox.toml index e48ddf3ff0b..b05d9d04a82 100644 --- a/config/deployments/sandbox.toml +++ b/config/deployments/sandbox.toml @@ -45,6 +45,7 @@ bluesnap.secondary_base_url = "https://sandpay.bluesnap.com/" boku.base_url = "https://$-api4-stage.boku.com" braintree.base_url = "https://payments.sandbox.braintree-api.com/graphql" cashtocode.base_url = "https://cluster05.api-test.cashtocode.com" +checkbook.base_url = "https://api.sandbox.checkbook.io" checkout.base_url = "https://api.sandbox.checkout.com/" chargebee.base_url = "https://$.chargebee.com/api/" coinbase.base_url = "https://api.commerce.coinbase.com" diff --git a/config/development.toml b/config/development.toml index d340abae6ef..84afa679d11 100644 --- a/config/development.toml +++ b/config/development.toml @@ -109,6 +109,7 @@ cards = [ "bluesnap", "boku", "braintree", + "checkbook", "checkout", "coinbase", "coingate", @@ -237,6 +238,7 @@ boku.base_url = "https://$-api4-stage.boku.com" braintree.base_url = "https://payments.sandbox.braintree-api.com/graphql" cashtocode.base_url = "https://cluster05.api-test.cashtocode.com" chargebee.base_url = "https://$.chargebee.com/api/" +checkbook.base_url = "https://api.sandbox.checkbook.io" checkout.base_url = "https://api.sandbox.checkout.com/" coinbase.base_url = "https://api.commerce.coinbase.com" coingate.base_url = "https://api-sandbox.coingate.com" diff --git a/config/docker_compose.toml b/config/docker_compose.toml index 31ecb58bb6f..80a672453ea 100644 --- a/config/docker_compose.toml +++ b/config/docker_compose.toml @@ -129,6 +129,7 @@ boku.base_url = "https://$-api4-stage.boku.com" braintree.base_url = "https://payments.sandbox.braintree-api.com/graphql" cashtocode.base_url = "https://cluster05.api-test.cashtocode.com" chargebee.base_url = "https://$.chargebee.com/api/" +checkbook.base_url = "https://api.sandbox.checkbook.io" checkout.base_url = "https://api.sandbox.checkout.com/" coinbase.base_url = "https://api.commerce.coinbase.com" coingate.base_url = "https://api-sandbox.coingate.com" @@ -258,6 +259,7 @@ cards = [ "boku", "braintree", "checkout", + "checkbook", "coinbase", "coingate", "cryptopay", diff --git a/crates/common_enums/src/connector_enums.rs b/crates/common_enums/src/connector_enums.rs index 58c627cca84..afe83a0f40f 100644 --- a/crates/common_enums/src/connector_enums.rs +++ b/crates/common_enums/src/connector_enums.rs @@ -75,6 +75,7 @@ pub enum RoutableConnectors { Braintree, Cashtocode, Chargebee, + // Checkbook, Checkout, Coinbase, Coingate, @@ -231,6 +232,7 @@ pub enum Connector { Braintree, Cashtocode, Chargebee, + // Checkbook, Checkout, Coinbase, Coingate, @@ -414,6 +416,7 @@ impl Connector { | Self::Braintree | Self::Cashtocode | Self::Chargebee + // | Self::Checkbook | Self::Coinbase | Self::Coingate | Self::Cryptopay @@ -575,6 +578,7 @@ impl From<RoutableConnectors> for Connector { RoutableConnectors::Braintree => Self::Braintree, RoutableConnectors::Cashtocode => Self::Cashtocode, RoutableConnectors::Chargebee => Self::Chargebee, + // RoutableConnectors::Checkbook => Self::Checkbook, RoutableConnectors::Checkout => Self::Checkout, RoutableConnectors::Coinbase => Self::Coinbase, RoutableConnectors::Cryptopay => Self::Cryptopay, @@ -694,6 +698,7 @@ impl TryFrom<Connector> for RoutableConnectors { Connector::Braintree => Ok(Self::Braintree), Connector::Cashtocode => Ok(Self::Cashtocode), Connector::Chargebee => Ok(Self::Chargebee), + // Connector::Checkbook => Ok(Self::Checkbook), Connector::Checkout => Ok(Self::Checkout), Connector::Coinbase => Ok(Self::Coinbase), Connector::Coingate => Ok(Self::Coingate), diff --git a/crates/connector_configs/src/connector.rs b/crates/connector_configs/src/connector.rs index 62ad0993f03..abf73e20acc 100644 --- a/crates/connector_configs/src/connector.rs +++ b/crates/connector_configs/src/connector.rs @@ -191,6 +191,7 @@ pub struct ConnectorConfig { pub braintree: Option<ConnectorTomlConfig>, pub cashtocode: Option<ConnectorTomlConfig>, pub chargebee: Option<ConnectorTomlConfig>, + pub checkbook: Option<ConnectorTomlConfig>, pub checkout: Option<ConnectorTomlConfig>, pub coinbase: Option<ConnectorTomlConfig>, pub coingate: Option<ConnectorTomlConfig>, diff --git a/crates/hyperswitch_connectors/src/connectors.rs b/crates/hyperswitch_connectors/src/connectors.rs index 9f1355a1372..55f2047a59f 100644 --- a/crates/hyperswitch_connectors/src/connectors.rs +++ b/crates/hyperswitch_connectors/src/connectors.rs @@ -16,6 +16,7 @@ pub mod boku; pub mod braintree; pub mod cashtocode; pub mod chargebee; +pub mod checkbook; pub mod checkout; pub mod coinbase; pub mod coingate; @@ -114,8 +115,8 @@ pub use self::{ amazonpay::Amazonpay, archipel::Archipel, authorizedotnet::Authorizedotnet, bambora::Bambora, bamboraapac::Bamboraapac, bankofamerica::Bankofamerica, barclaycard::Barclaycard, billwerk::Billwerk, bitpay::Bitpay, bluesnap::Bluesnap, boku::Boku, braintree::Braintree, - cashtocode::Cashtocode, chargebee::Chargebee, checkout::Checkout, coinbase::Coinbase, - coingate::Coingate, cryptopay::Cryptopay, ctp_mastercard::CtpMastercard, + cashtocode::Cashtocode, chargebee::Chargebee, checkbook::Checkbook, checkout::Checkout, + coinbase::Coinbase, coingate::Coingate, cryptopay::Cryptopay, ctp_mastercard::CtpMastercard, cybersource::Cybersource, datatrans::Datatrans, deutschebank::Deutschebank, digitalvirgo::Digitalvirgo, dlocal::Dlocal, dwolla::Dwolla, ebanx::Ebanx, elavon::Elavon, facilitapay::Facilitapay, fiserv::Fiserv, fiservemea::Fiservemea, fiuu::Fiuu, forte::Forte, diff --git a/crates/hyperswitch_connectors/src/connectors/checkbook.rs b/crates/hyperswitch_connectors/src/connectors/checkbook.rs new file mode 100644 index 00000000000..e0f31ceb57f --- /dev/null +++ b/crates/hyperswitch_connectors/src/connectors/checkbook.rs @@ -0,0 +1,571 @@ +pub mod transformers; + +use common_utils::{ + errors::CustomResult, + ext_traits::BytesExt, + request::{Method, Request, RequestBuilder, RequestContent}, + types::{AmountConvertor, FloatMajorUnit, FloatMajorUnitForConnector}, +}; +use error_stack::{report, ResultExt}; +use hyperswitch_domain_models::{ + router_data::{AccessToken, ConnectorAuthType, ErrorResponse, RouterData}, + router_flow_types::{ + access_token_auth::AccessTokenAuth, + payments::{Authorize, Capture, PSync, PaymentMethodToken, Session, SetupMandate, Void}, + refunds::{Execute, RSync}, + }, + router_request_types::{ + AccessTokenRequestData, PaymentMethodTokenizationData, PaymentsAuthorizeData, + PaymentsCancelData, PaymentsCaptureData, PaymentsSessionData, PaymentsSyncData, + RefundsData, SetupMandateRequestData, + }, + router_response_types::{PaymentsResponseData, RefundsResponseData}, + types::{ + PaymentsAuthorizeRouterData, PaymentsCaptureRouterData, PaymentsSyncRouterData, + RefundSyncRouterData, RefundsRouterData, + }, +}; +use hyperswitch_interfaces::{ + api::{ + self, ConnectorCommon, ConnectorCommonExt, ConnectorIntegration, ConnectorSpecifications, + ConnectorValidation, + }, + configs::Connectors, + errors, + events::connector_api_logs::ConnectorEvent, + types::{self, Response}, + webhooks, +}; +use masking::{ExposeInterface, Mask}; +use transformers as checkbook; + +use crate::{constants::headers, types::ResponseRouterData, utils}; + +#[derive(Clone)] +pub struct Checkbook { + amount_converter: &'static (dyn AmountConvertor<Output = FloatMajorUnit> + Sync), +} + +impl Checkbook { + pub fn new() -> &'static Self { + &Self { + amount_converter: &FloatMajorUnitForConnector, + } + } +} + +impl api::Payment for Checkbook {} +impl api::PaymentSession for Checkbook {} +impl api::ConnectorAccessToken for Checkbook {} +impl api::MandateSetup for Checkbook {} +impl api::PaymentAuthorize for Checkbook {} +impl api::PaymentSync for Checkbook {} +impl api::PaymentCapture for Checkbook {} +impl api::PaymentVoid for Checkbook {} +impl api::Refund for Checkbook {} +impl api::RefundExecute for Checkbook {} +impl api::RefundSync for Checkbook {} +impl api::PaymentToken for Checkbook {} + +impl ConnectorIntegration<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData> + for Checkbook +{ + // Not Implemented (R) +} + +impl<Flow, Request, Response> ConnectorCommonExt<Flow, Request, Response> for Checkbook +where + Self: ConnectorIntegration<Flow, Request, Response>, +{ + fn build_headers( + &self, + req: &RouterData<Flow, Request, Response>, + _connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + let mut header = vec![( + headers::CONTENT_TYPE.to_string(), + self.get_content_type().to_string().into(), + )]; + let mut api_key = self.get_auth_header(&req.connector_auth_type)?; + header.append(&mut api_key); + Ok(header) + } +} + +impl ConnectorCommon for Checkbook { + fn id(&self) -> &'static str { + "checkbook" + } + + fn get_currency_unit(&self) -> api::CurrencyUnit { + api::CurrencyUnit::Base + } + + fn common_get_content_type(&self) -> &'static str { + "application/json" + } + + fn base_url<'a>(&self, connectors: &'a Connectors) -> &'a str { + connectors.checkbook.base_url.as_ref() + } + + fn get_auth_header( + &self, + auth_type: &ConnectorAuthType, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + let auth = checkbook::CheckbookAuthType::try_from(auth_type) + .change_context(errors::ConnectorError::FailedToObtainAuthType)?; + Ok(vec![( + headers::AUTHORIZATION.to_string(), + auth.api_key.expose().into_masked(), + )]) + } + + fn build_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + let response: checkbook::CheckbookErrorResponse = res + .response + .parse_struct("CheckbookErrorResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + + Ok(ErrorResponse { + status_code: res.status_code, + code: response.code, + message: response.message, + reason: response.reason, + attempt_status: None, + connector_transaction_id: None, + network_advice_code: None, + network_decline_code: None, + network_error_message: None, + }) + } +} + +impl ConnectorValidation for Checkbook { + //TODO: implement functions when support enabled +} + +impl ConnectorIntegration<Session, PaymentsSessionData, PaymentsResponseData> for Checkbook { + //TODO: implement sessions flow +} + +impl ConnectorIntegration<AccessTokenAuth, AccessTokenRequestData, AccessToken> for Checkbook {} + +impl ConnectorIntegration<SetupMandate, SetupMandateRequestData, PaymentsResponseData> + for Checkbook +{ +} + +impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData> for Checkbook { + fn get_headers( + &self, + req: &PaymentsAuthorizeRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsAuthorizeRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn get_request_body( + &self, + req: &PaymentsAuthorizeRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let amount = utils::convert_amount( + self.amount_converter, + req.request.minor_amount, + req.request.currency, + )?; + + let connector_router_data = checkbook::CheckbookRouterData::from((amount, req)); + let connector_req = checkbook::CheckbookPaymentsRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &PaymentsAuthorizeRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::PaymentsAuthorizeType::get_url( + self, req, connectors, + )?) + .attach_default_headers() + .headers(types::PaymentsAuthorizeType::get_headers( + self, req, connectors, + )?) + .set_body(types::PaymentsAuthorizeType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsAuthorizeRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsAuthorizeRouterData, errors::ConnectorError> { + let response: checkbook::CheckbookPaymentsResponse = res + .response + .parse_struct("Checkbook PaymentsAuthorizeResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<PSync, PaymentsSyncData, PaymentsResponseData> for Checkbook { + fn get_headers( + &self, + req: &PaymentsSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsSyncRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn build_request( + &self, + req: &PaymentsSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Get) + .url(&types::PaymentsSyncType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::PaymentsSyncType::get_headers(self, req, connectors)?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsSyncRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsSyncRouterData, errors::ConnectorError> { + let response: checkbook::CheckbookPaymentsResponse = res + .response + .parse_struct("checkbook PaymentsSyncResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<Capture, PaymentsCaptureData, PaymentsResponseData> for Checkbook { + fn get_headers( + &self, + req: &PaymentsCaptureRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsCaptureRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn get_request_body( + &self, + _req: &PaymentsCaptureRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_request_body method".to_string()).into()) + } + + fn build_request( + &self, + req: &PaymentsCaptureRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::PaymentsCaptureType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::PaymentsCaptureType::get_headers( + self, req, connectors, + )?) + .set_body(types::PaymentsCaptureType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsCaptureRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsCaptureRouterData, errors::ConnectorError> { + let response: checkbook::CheckbookPaymentsResponse = res + .response + .parse_struct("Checkbook PaymentsCaptureResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<Void, PaymentsCancelData, PaymentsResponseData> for Checkbook {} + +impl ConnectorIntegration<Execute, RefundsData, RefundsResponseData> for Checkbook { + fn get_headers( + &self, + req: &RefundsRouterData<Execute>, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &RefundsRouterData<Execute>, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn get_request_body( + &self, + req: &RefundsRouterData<Execute>, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let refund_amount = utils::convert_amount( + self.amount_converter, + req.request.minor_refund_amount, + req.request.currency, + )?; + + let connector_router_data = checkbook::CheckbookRouterData::from((refund_amount, req)); + let connector_req = checkbook::CheckbookRefundRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &RefundsRouterData<Execute>, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + let request = RequestBuilder::new() + .method(Method::Post) + .url(&types::RefundExecuteType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::RefundExecuteType::get_headers( + self, req, connectors, + )?) + .set_body(types::RefundExecuteType::get_request_body( + self, req, connectors, + )?) + .build(); + Ok(Some(request)) + } + + fn handle_response( + &self, + data: &RefundsRouterData<Execute>, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<RefundsRouterData<Execute>, errors::ConnectorError> { + let response: checkbook::RefundResponse = res + .response + .parse_struct("checkbook RefundResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<RSync, RefundsData, RefundsResponseData> for Checkbook { + fn get_headers( + &self, + req: &RefundSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &RefundSyncRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn build_request( + &self, + req: &RefundSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Get) + .url(&types::RefundSyncType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::RefundSyncType::get_headers(self, req, connectors)?) + .set_body(types::RefundSyncType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &RefundSyncRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<RefundSyncRouterData, errors::ConnectorError> { + let response: checkbook::RefundResponse = res + .response + .parse_struct("checkbook RefundSyncResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +#[async_trait::async_trait] +impl webhooks::IncomingWebhook for Checkbook { + fn get_webhook_object_reference_id( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<api_models::webhooks::ObjectReferenceId, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } + + fn get_webhook_event_type( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<api_models::webhooks::IncomingWebhookEvent, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } + + fn get_webhook_resource_object( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<Box<dyn masking::ErasedMaskSerialize>, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } +} + +impl ConnectorSpecifications for Checkbook {} diff --git a/crates/hyperswitch_connectors/src/connectors/checkbook/transformers.rs b/crates/hyperswitch_connectors/src/connectors/checkbook/transformers.rs new file mode 100644 index 00000000000..d9f009f78fe --- /dev/null +++ b/crates/hyperswitch_connectors/src/connectors/checkbook/transformers.rs @@ -0,0 +1,228 @@ +use common_enums::enums; +use common_utils::types::FloatMajorUnit; +use hyperswitch_domain_models::{ + payment_method_data::PaymentMethodData, + router_data::{ConnectorAuthType, RouterData}, + router_flow_types::refunds::{Execute, RSync}, + router_request_types::ResponseId, + router_response_types::{PaymentsResponseData, RefundsResponseData}, + types::{PaymentsAuthorizeRouterData, RefundsRouterData}, +}; +use hyperswitch_interfaces::errors; +use masking::Secret; +use serde::{Deserialize, Serialize}; + +use crate::{ + types::{RefundsResponseRouterData, ResponseRouterData}, + utils::PaymentsAuthorizeRequestData, +}; + +//TODO: Fill the struct with respective fields +pub struct CheckbookRouterData<T> { + pub amount: FloatMajorUnit, // The type of amount that a connector accepts, for example, String, i64, f64, etc. + pub router_data: T, +} + +impl<T> From<(FloatMajorUnit, T)> for CheckbookRouterData<T> { + fn from((amount, item): (FloatMajorUnit, T)) -> Self { + //Todo : use utils to convert the amount to the type of amount that a connector accepts + Self { + amount, + router_data: item, + } + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Serialize, PartialEq)] +pub struct CheckbookPaymentsRequest { + amount: FloatMajorUnit, + card: CheckbookCard, +} + +#[derive(Default, Debug, Serialize, Eq, PartialEq)] +pub struct CheckbookCard { + number: cards::CardNumber, + expiry_month: Secret<String>, + expiry_year: Secret<String>, + cvc: Secret<String>, + complete: bool, +} + +impl TryFrom<&CheckbookRouterData<&PaymentsAuthorizeRouterData>> for CheckbookPaymentsRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: &CheckbookRouterData<&PaymentsAuthorizeRouterData>, + ) -> Result<Self, Self::Error> { + match item.router_data.request.payment_method_data.clone() { + PaymentMethodData::Card(req_card) => { + let card = CheckbookCard { + number: req_card.card_number, + expiry_month: req_card.card_exp_month, + expiry_year: req_card.card_exp_year, + cvc: req_card.card_cvc, + complete: item.router_data.request.is_auto_capture()?, + }; + Ok(Self { + amount: item.amount, + card, + }) + } + _ => Err(errors::ConnectorError::NotImplemented("Payment method".to_string()).into()), + } + } +} + +//TODO: Fill the struct with respective fields +// Auth Struct +pub struct CheckbookAuthType { + pub(super) api_key: Secret<String>, +} + +impl TryFrom<&ConnectorAuthType> for CheckbookAuthType { + 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)] +#[serde(rename_all = "lowercase")] +pub enum CheckbookPaymentStatus { + Succeeded, + Failed, + #[default] + Processing, +} + +impl From<CheckbookPaymentStatus> for common_enums::AttemptStatus { + fn from(item: CheckbookPaymentStatus) -> Self { + match item { + CheckbookPaymentStatus::Succeeded => Self::Charged, + CheckbookPaymentStatus::Failed => Self::Failure, + CheckbookPaymentStatus::Processing => Self::Authorizing, + } + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] +pub struct CheckbookPaymentsResponse { + status: CheckbookPaymentStatus, + id: String, +} + +impl<F, T> TryFrom<ResponseRouterData<F, CheckbookPaymentsResponse, T, PaymentsResponseData>> + for RouterData<F, T, PaymentsResponseData> +{ + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: ResponseRouterData<F, CheckbookPaymentsResponse, T, PaymentsResponseData>, + ) -> Result<Self, Self::Error> { + Ok(Self { + status: common_enums::AttemptStatus::from(item.response.status), + response: Ok(PaymentsResponseData::TransactionResponse { + resource_id: ResponseId::ConnectorTransactionId(item.response.id), + redirection_data: Box::new(None), + mandate_reference: Box::new(None), + connector_metadata: None, + network_txn_id: None, + connector_response_reference_id: None, + incremental_authorization_allowed: None, + charges: None, + }), + ..item.data + }) + } +} + +//TODO: Fill the struct with respective fields +// REFUND : +// Type definition for RefundRequest +#[derive(Default, Debug, Serialize)] +pub struct CheckbookRefundRequest { + pub amount: FloatMajorUnit, +} + +impl<F> TryFrom<&CheckbookRouterData<&RefundsRouterData<F>>> for CheckbookRefundRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from(item: &CheckbookRouterData<&RefundsRouterData<F>>) -> Result<Self, Self::Error> { + Ok(Self { + amount: item.amount.to_owned(), + }) + } +} + +// Type definition for Refund Response + +#[allow(dead_code)] +#[derive(Debug, Serialize, Default, Deserialize, Clone)] +pub enum RefundStatus { + Succeeded, + Failed, + #[default] + Processing, +} + +impl From<RefundStatus> for enums::RefundStatus { + fn from(item: RefundStatus) -> Self { + match item { + RefundStatus::Succeeded => Self::Success, + RefundStatus::Failed => Self::Failure, + RefundStatus::Processing => Self::Pending, + //TODO: Review mapping + } + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Clone, Serialize, Deserialize)] +pub struct RefundResponse { + id: String, + status: RefundStatus, +} + +impl TryFrom<RefundsResponseRouterData<Execute, RefundResponse>> for RefundsRouterData<Execute> { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: RefundsResponseRouterData<Execute, RefundResponse>, + ) -> Result<Self, Self::Error> { + Ok(Self { + response: Ok(RefundsResponseData { + connector_refund_id: item.response.id.to_string(), + refund_status: enums::RefundStatus::from(item.response.status), + }), + ..item.data + }) + } +} + +impl TryFrom<RefundsResponseRouterData<RSync, RefundResponse>> for RefundsRouterData<RSync> { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: RefundsResponseRouterData<RSync, RefundResponse>, + ) -> Result<Self, Self::Error> { + Ok(Self { + response: Ok(RefundsResponseData { + connector_refund_id: item.response.id.to_string(), + refund_status: enums::RefundStatus::from(item.response.status), + }), + ..item.data + }) + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Serialize, Deserialize, PartialEq)] +pub struct CheckbookErrorResponse { + pub status_code: u16, + pub code: String, + pub message: String, + pub reason: Option<String>, +} diff --git a/crates/hyperswitch_connectors/src/default_implementations.rs b/crates/hyperswitch_connectors/src/default_implementations.rs index 6717a25d2ac..54c5d81edd9 100644 --- a/crates/hyperswitch_connectors/src/default_implementations.rs +++ b/crates/hyperswitch_connectors/src/default_implementations.rs @@ -160,6 +160,7 @@ default_imp_for_authorize_session_token!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -282,6 +283,7 @@ default_imp_for_calculate_tax!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -405,6 +407,7 @@ default_imp_for_session_update!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -528,6 +531,7 @@ default_imp_for_post_session_tokens!( connectors::Billwerk, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -650,6 +654,7 @@ default_imp_for_create_order!( connectors::Billwerk, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -773,6 +778,7 @@ default_imp_for_update_metadata!( connectors::Billwerk, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -894,6 +900,7 @@ default_imp_for_complete_authorize!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1002,6 +1009,7 @@ default_imp_for_incremental_authorization!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1125,6 +1133,7 @@ default_imp_for_create_customer!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1242,6 +1251,7 @@ default_imp_for_connector_redirect_response!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, @@ -1348,6 +1358,7 @@ default_imp_for_pre_processing_steps!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1462,6 +1473,7 @@ default_imp_for_post_processing_steps!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1586,6 +1598,7 @@ default_imp_for_approve!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1711,6 +1724,7 @@ default_imp_for_reject!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1836,6 +1850,7 @@ default_imp_for_webhook_source_verification!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1960,6 +1975,7 @@ default_imp_for_accept_dispute!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, @@ -2083,6 +2099,7 @@ default_imp_for_submit_evidence!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, @@ -2205,6 +2222,7 @@ default_imp_for_defend_dispute!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, @@ -2337,6 +2355,7 @@ default_imp_for_file_upload!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, @@ -2451,6 +2470,7 @@ default_imp_for_payouts!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Cryptopay, connectors::Datatrans, @@ -2569,6 +2589,7 @@ default_imp_for_payouts_create!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -2691,6 +2712,7 @@ default_imp_for_payouts_retrieve!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -2815,6 +2837,7 @@ default_imp_for_payouts_eligibility!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -2937,6 +2960,7 @@ default_imp_for_payouts_fulfill!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -3056,6 +3080,7 @@ default_imp_for_payouts_cancel!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -3179,6 +3204,7 @@ default_imp_for_payouts_quote!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -3303,6 +3329,7 @@ default_imp_for_payouts_recipient!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -3426,6 +3453,7 @@ default_imp_for_payouts_recipient_account!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -3551,6 +3579,7 @@ default_imp_for_frm_sale!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -3676,6 +3705,7 @@ default_imp_for_frm_checkout!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -3801,6 +3831,7 @@ default_imp_for_frm_transaction!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -3926,6 +3957,7 @@ default_imp_for_frm_fulfillment!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -4051,6 +4083,7 @@ default_imp_for_frm_record_return!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -4172,6 +4205,7 @@ default_imp_for_revoking_mandates!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -4293,6 +4327,7 @@ default_imp_for_uas_pre_authentication!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -4415,6 +4450,7 @@ default_imp_for_uas_post_authentication!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -4538,6 +4574,7 @@ default_imp_for_uas_authentication_confirmation!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -4653,6 +4690,7 @@ default_imp_for_connector_request_id!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -4770,6 +4808,7 @@ default_imp_for_fraud_check!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -4917,6 +4956,7 @@ default_imp_for_connector_authentication!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -5037,6 +5077,7 @@ default_imp_for_uas_authentication!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -5151,8 +5192,9 @@ default_imp_for_revenue_recovery!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, - connectors::Checkout, connectors::Chargebee, + connectors::Checkbook, + connectors::Checkout, connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, @@ -5278,6 +5320,7 @@ default_imp_for_billing_connector_payment_sync!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -5402,6 +5445,7 @@ default_imp_for_revenue_recovery_record_back!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -5526,6 +5570,7 @@ default_imp_for_billing_connector_invoice_sync!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -5644,6 +5689,7 @@ default_imp_for_external_vault!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -5768,6 +5814,7 @@ default_imp_for_external_vault_insert!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -5892,6 +5939,7 @@ default_imp_for_external_vault_retrieve!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -6016,6 +6064,7 @@ default_imp_for_external_vault_delete!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -6140,6 +6189,7 @@ default_imp_for_external_vault_create!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, diff --git a/crates/hyperswitch_connectors/src/default_implementations_v2.rs b/crates/hyperswitch_connectors/src/default_implementations_v2.rs index 0121aa1d951..27c13c9d6be 100644 --- a/crates/hyperswitch_connectors/src/default_implementations_v2.rs +++ b/crates/hyperswitch_connectors/src/default_implementations_v2.rs @@ -265,6 +265,7 @@ default_imp_for_new_connector_integration_payment!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -390,6 +391,7 @@ default_imp_for_new_connector_integration_refund!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -510,6 +512,7 @@ default_imp_for_new_connector_integration_connector_access_token!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -636,6 +639,7 @@ default_imp_for_new_connector_integration_accept_dispute!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -760,6 +764,7 @@ default_imp_for_new_connector_integration_submit_evidence!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -884,6 +889,7 @@ default_imp_for_new_connector_integration_defend_dispute!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1019,6 +1025,7 @@ default_imp_for_new_connector_integration_file_upload!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1146,6 +1153,7 @@ default_imp_for_new_connector_integration_payouts_create!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1273,6 +1281,7 @@ default_imp_for_new_connector_integration_payouts_eligibility!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1400,6 +1409,7 @@ default_imp_for_new_connector_integration_payouts_fulfill!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1527,6 +1537,7 @@ default_imp_for_new_connector_integration_payouts_cancel!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1654,6 +1665,7 @@ default_imp_for_new_connector_integration_payouts_quote!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1781,6 +1793,7 @@ default_imp_for_new_connector_integration_payouts_recipient!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1908,6 +1921,7 @@ default_imp_for_new_connector_integration_payouts_sync!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -2035,6 +2049,7 @@ default_imp_for_new_connector_integration_payouts_recipient_account!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -2160,6 +2175,7 @@ default_imp_for_new_connector_integration_webhook_source_verification!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -2287,6 +2303,7 @@ default_imp_for_new_connector_integration_frm_sale!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -2414,6 +2431,7 @@ default_imp_for_new_connector_integration_frm_checkout!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -2541,6 +2559,7 @@ default_imp_for_new_connector_integration_frm_transaction!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -2668,6 +2687,7 @@ default_imp_for_new_connector_integration_frm_fulfillment!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -2795,6 +2815,7 @@ default_imp_for_new_connector_integration_frm_record_return!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -2919,6 +2940,7 @@ default_imp_for_new_connector_integration_revoking_mandates!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -3030,6 +3052,7 @@ default_imp_for_new_connector_integration_frm!( connectors::Bluesnap, connectors::Boku, connectors::Cashtocode, + connectors::Checkbook, connectors::Coinbase, connectors::Cryptopay, connectors::CtpMastercard, @@ -3154,6 +3177,7 @@ default_imp_for_new_connector_integration_connector_authentication!( connectors::Bluesnap, connectors::Boku, connectors::Cashtocode, + connectors::Checkbook, connectors::Coinbase, connectors::Cryptopay, connectors::CtpMastercard, @@ -3267,6 +3291,7 @@ default_imp_for_new_connector_integration_revenue_recovery!( connectors::Bluesnap, connectors::Boku, connectors::Cashtocode, + connectors::Checkbook, connectors::Coinbase, connectors::Cryptopay, connectors::CtpMastercard, @@ -3397,6 +3422,7 @@ default_imp_for_new_connector_integration_external_vault!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, diff --git a/crates/hyperswitch_domain_models/src/configs.rs b/crates/hyperswitch_domain_models/src/configs.rs index ab84cf26aa4..f15ea290f56 100644 --- a/crates/hyperswitch_domain_models/src/configs.rs +++ b/crates/hyperswitch_domain_models/src/configs.rs @@ -30,6 +30,7 @@ pub struct Connectors { pub braintree: ConnectorParams, pub cashtocode: ConnectorParams, pub chargebee: ConnectorParams, + pub checkbook: ConnectorParams, pub checkout: ConnectorParams, pub coinbase: ConnectorParams, pub coingate: ConnectorParams, diff --git a/crates/router/src/connector.rs b/crates/router/src/connector.rs index de9eb4f3923..af2d9a52352 100644 --- a/crates/router/src/connector.rs +++ b/crates/router/src/connector.rs @@ -9,30 +9,31 @@ pub use hyperswitch_connectors::connectors::{ bamboraapac::Bamboraapac, bankofamerica, bankofamerica::Bankofamerica, barclaycard, barclaycard::Barclaycard, billwerk, billwerk::Billwerk, bitpay, bitpay::Bitpay, bluesnap, bluesnap::Bluesnap, boku, boku::Boku, braintree, braintree::Braintree, cashtocode, - cashtocode::Cashtocode, chargebee, chargebee::Chargebee, checkout, checkout::Checkout, - coinbase, coinbase::Coinbase, coingate, coingate::Coingate, cryptopay, cryptopay::Cryptopay, - ctp_mastercard, ctp_mastercard::CtpMastercard, cybersource, cybersource::Cybersource, - datatrans, datatrans::Datatrans, deutschebank, deutschebank::Deutschebank, digitalvirgo, - digitalvirgo::Digitalvirgo, dlocal, dlocal::Dlocal, dwolla, dwolla::Dwolla, ebanx, - ebanx::Ebanx, elavon, elavon::Elavon, facilitapay, facilitapay::Facilitapay, fiserv, - fiserv::Fiserv, fiservemea, fiservemea::Fiservemea, fiuu, fiuu::Fiuu, forte, forte::Forte, - getnet, getnet::Getnet, globalpay, globalpay::Globalpay, globepay, globepay::Globepay, - gocardless, gocardless::Gocardless, gpayments, gpayments::Gpayments, helcim, helcim::Helcim, - hipay, hipay::Hipay, hyperswitch_vault, hyperswitch_vault::HyperswitchVault, iatapay, - iatapay::Iatapay, inespay, inespay::Inespay, itaubank, itaubank::Itaubank, jpmorgan, - jpmorgan::Jpmorgan, juspaythreedsserver, juspaythreedsserver::Juspaythreedsserver, klarna, - klarna::Klarna, mifinity, mifinity::Mifinity, mollie, mollie::Mollie, moneris, - moneris::Moneris, multisafepay, multisafepay::Multisafepay, netcetera, netcetera::Netcetera, - nexinets, nexinets::Nexinets, nexixpay, nexixpay::Nexixpay, nmi, nmi::Nmi, nomupay, - nomupay::Nomupay, noon, noon::Noon, nordea, nordea::Nordea, novalnet, novalnet::Novalnet, - nuvei, nuvei::Nuvei, opayo, opayo::Opayo, opennode, opennode::Opennode, paybox, paybox::Paybox, - payeezy, payeezy::Payeezy, payme, payme::Payme, payone, payone::Payone, paypal, paypal::Paypal, - paystack, paystack::Paystack, payu, payu::Payu, placetopay, placetopay::Placetopay, plaid, - plaid::Plaid, powertranz, powertranz::Powertranz, prophetpay, prophetpay::Prophetpay, rapyd, - rapyd::Rapyd, razorpay, razorpay::Razorpay, recurly, recurly::Recurly, redsys, redsys::Redsys, - riskified, riskified::Riskified, santander, santander::Santander, shift4, shift4::Shift4, - signifyd, signifyd::Signifyd, square, square::Square, stax, stax::Stax, stripe, stripe::Stripe, - stripebilling, stripebilling::Stripebilling, taxjar, taxjar::Taxjar, threedsecureio, + cashtocode::Cashtocode, chargebee, chargebee::Chargebee, checkbook, checkbook::Checkbook, + checkout, checkout::Checkout, coinbase, coinbase::Coinbase, coingate, coingate::Coingate, + cryptopay, cryptopay::Cryptopay, ctp_mastercard, ctp_mastercard::CtpMastercard, cybersource, + cybersource::Cybersource, datatrans, datatrans::Datatrans, deutschebank, + deutschebank::Deutschebank, digitalvirgo, digitalvirgo::Digitalvirgo, dlocal, dlocal::Dlocal, + dwolla, dwolla::Dwolla, ebanx, ebanx::Ebanx, elavon, elavon::Elavon, facilitapay, + facilitapay::Facilitapay, fiserv, fiserv::Fiserv, fiservemea, fiservemea::Fiservemea, fiuu, + fiuu::Fiuu, forte, forte::Forte, getnet, getnet::Getnet, globalpay, globalpay::Globalpay, + globepay, globepay::Globepay, gocardless, gocardless::Gocardless, gpayments, + gpayments::Gpayments, helcim, helcim::Helcim, hipay, hipay::Hipay, hyperswitch_vault, + hyperswitch_vault::HyperswitchVault, iatapay, iatapay::Iatapay, inespay, inespay::Inespay, + itaubank, itaubank::Itaubank, jpmorgan, jpmorgan::Jpmorgan, juspaythreedsserver, + juspaythreedsserver::Juspaythreedsserver, klarna, klarna::Klarna, mifinity, mifinity::Mifinity, + mollie, mollie::Mollie, moneris, moneris::Moneris, multisafepay, multisafepay::Multisafepay, + netcetera, netcetera::Netcetera, nexinets, nexinets::Nexinets, nexixpay, nexixpay::Nexixpay, + nmi, nmi::Nmi, nomupay, nomupay::Nomupay, noon, noon::Noon, nordea, nordea::Nordea, novalnet, + novalnet::Novalnet, nuvei, nuvei::Nuvei, opayo, opayo::Opayo, opennode, opennode::Opennode, + paybox, paybox::Paybox, payeezy, payeezy::Payeezy, payme, payme::Payme, payone, payone::Payone, + paypal, paypal::Paypal, paystack, paystack::Paystack, payu, payu::Payu, placetopay, + placetopay::Placetopay, plaid, plaid::Plaid, powertranz, powertranz::Powertranz, prophetpay, + prophetpay::Prophetpay, rapyd, rapyd::Rapyd, razorpay, razorpay::Razorpay, recurly, + recurly::Recurly, redsys, redsys::Redsys, riskified, riskified::Riskified, santander, + santander::Santander, shift4, shift4::Shift4, signifyd, signifyd::Signifyd, square, + square::Square, stax, stax::Stax, stripe, stripe::Stripe, stripebilling, + stripebilling::Stripebilling, taxjar, taxjar::Taxjar, threedsecureio, threedsecureio::Threedsecureio, thunes, thunes::Thunes, tokenio, tokenio::Tokenio, trustpay, trustpay::Trustpay, tsys, tsys::Tsys, unified_authentication_service, unified_authentication_service::UnifiedAuthenticationService, vgs, vgs::Vgs, volt, volt::Volt, diff --git a/crates/router/src/core/admin.rs b/crates/router/src/core/admin.rs index eeb4557daf3..6763bd029b2 100644 --- a/crates/router/src/core/admin.rs +++ b/crates/router/src/core/admin.rs @@ -1456,6 +1456,10 @@ impl ConnectorAuthTypeAndMetadataValidation<'_> { chargebee::transformers::ChargebeeMetadata::try_from(self.connector_meta_data)?; Ok(()) } + // api_enums::Connector::Checkbook => { + // checkbook::transformers::CheckbookAuthType::try_from(self.auth_type)?; + // Ok(()) + // }, api_enums::Connector::Checkout => { checkout::transformers::CheckoutAuthType::try_from(self.auth_type)?; Ok(()) diff --git a/crates/router/src/types/api.rs b/crates/router/src/types/api.rs index e189a0f1a43..f40520a42e7 100644 --- a/crates/router/src/types/api.rs +++ b/crates/router/src/types/api.rs @@ -378,6 +378,9 @@ impl ConnectorData { enums::Connector::Chargebee => { Ok(ConnectorEnum::Old(Box::new(connector::Chargebee::new()))) } + // enums::Connector::Checkbook => { + // Ok(ConnectorEnum::Old(Box::new(connector::Checkbook))) + // } enums::Connector::Checkout => { Ok(ConnectorEnum::Old(Box::new(connector::Checkout::new()))) } diff --git a/crates/router/src/types/transformers.rs b/crates/router/src/types/transformers.rs index ad3d4de7f94..82ca2f7ae67 100644 --- a/crates/router/src/types/transformers.rs +++ b/crates/router/src/types/transformers.rs @@ -224,6 +224,7 @@ impl ForeignTryFrom<api_enums::Connector> for common_enums::RoutableConnectors { api_enums::Connector::Braintree => Self::Braintree, api_enums::Connector::Cashtocode => Self::Cashtocode, api_enums::Connector::Chargebee => Self::Chargebee, + // api_enums::Connector::Checkbook => Self::Checkbook, api_enums::Connector::Checkout => Self::Checkout, api_enums::Connector::Coinbase => Self::Coinbase, api_enums::Connector::Coingate => Self::Coingate, diff --git a/crates/router/tests/connectors/checkbook.rs b/crates/router/tests/connectors/checkbook.rs new file mode 100644 index 00000000000..b6b4252f852 --- /dev/null +++ b/crates/router/tests/connectors/checkbook.rs @@ -0,0 +1,420 @@ +use masking::Secret; +use router::types::{self, api, domain, storage::enums}; +use test_utils::connector_auth; + +use crate::utils::{self, ConnectorActions}; + +#[derive(Clone, Copy)] +struct CheckbookTest; +impl ConnectorActions for CheckbookTest {} +impl utils::Connector for CheckbookTest { + fn get_data(&self) -> api::ConnectorData { + use router::connector::Checkbook; + utils::construct_connector_data_old( + Box::new(Checkbook::new()), + types::Connector::DummyConnector1, + api::GetToken::Connector, + None, + ) + } + + fn get_auth_token(&self) -> types::ConnectorAuthType { + utils::to_connector_auth_type( + connector_auth::ConnectorAuthentication::new() + .checkbook + .expect("Missing connector authentication configuration") + .into(), + ) + } + + fn get_name(&self) -> String { + "checkbook".to_string() + } +} + +static CONNECTOR: CheckbookTest = CheckbookTest {}; + +fn get_default_payment_info() -> Option<utils::PaymentInfo> { + None +} + +fn payment_method_details() -> Option<types::PaymentsAuthorizeData> { + None +} + +// Cards Positive Tests +// Creates a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_only_authorize_payment() { + let response = CONNECTOR + .authorize_payment(payment_method_details(), get_default_payment_info()) + .await + .expect("Authorize payment response"); + assert_eq!(response.status, enums::AttemptStatus::Authorized); +} + +// Captures a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_capture_authorized_payment() { + let response = CONNECTOR + .authorize_and_capture_payment(payment_method_details(), None, get_default_payment_info()) + .await + .expect("Capture payment response"); + assert_eq!(response.status, enums::AttemptStatus::Charged); +} + +// Partially captures a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_capture_authorized_payment() { + let response = CONNECTOR + .authorize_and_capture_payment( + payment_method_details(), + Some(types::PaymentsCaptureData { + amount_to_capture: 50, + ..utils::PaymentCaptureType::default().0 + }), + get_default_payment_info(), + ) + .await + .expect("Capture payment response"); + assert_eq!(response.status, enums::AttemptStatus::Charged); +} + +// Synchronizes a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_authorized_payment() { + let authorize_response = CONNECTOR + .authorize_payment(payment_method_details(), get_default_payment_info()) + .await + .expect("Authorize payment response"); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + let response = CONNECTOR + .psync_retry_till_status_matches( + enums::AttemptStatus::Authorized, + Some(types::PaymentsSyncData { + connector_transaction_id: types::ResponseId::ConnectorTransactionId( + txn_id.unwrap(), + ), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .expect("PSync response"); + assert_eq!(response.status, enums::AttemptStatus::Authorized,); +} + +// Voids a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_void_authorized_payment() { + let response = CONNECTOR + .authorize_and_void_payment( + payment_method_details(), + Some(types::PaymentsCancelData { + connector_transaction_id: String::from(""), + cancellation_reason: Some("requested_by_customer".to_string()), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .expect("Void payment response"); + assert_eq!(response.status, enums::AttemptStatus::Voided); +} + +// Refunds a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_manually_captured_payment() { + let response = CONNECTOR + .capture_payment_and_refund( + payment_method_details(), + None, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Partially refunds a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_refund_manually_captured_payment() { + let response = CONNECTOR + .capture_payment_and_refund( + payment_method_details(), + None, + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Synchronizes a refund using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_manually_captured_refund() { + let refund_response = CONNECTOR + .capture_payment_and_refund( + payment_method_details(), + None, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + let response = CONNECTOR + .rsync_retry_till_status_matches( + enums::RefundStatus::Success, + refund_response.response.unwrap().connector_refund_id, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Creates a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_make_payment() { + let authorize_response = CONNECTOR + .make_payment(payment_method_details(), get_default_payment_info()) + .await + .unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); +} + +// Synchronizes a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_auto_captured_payment() { + let authorize_response = CONNECTOR + .make_payment(payment_method_details(), get_default_payment_info()) + .await + .unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + assert_ne!(txn_id, None, "Empty connector transaction id"); + let response = CONNECTOR + .psync_retry_till_status_matches( + enums::AttemptStatus::Charged, + Some(types::PaymentsSyncData { + connector_transaction_id: types::ResponseId::ConnectorTransactionId( + txn_id.unwrap(), + ), + capture_method: Some(enums::CaptureMethod::Automatic), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!(response.status, enums::AttemptStatus::Charged,); +} + +// Refunds a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_auto_captured_payment() { + let response = CONNECTOR + .make_payment_and_refund(payment_method_details(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Partially refunds a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_refund_succeeded_payment() { + let refund_response = CONNECTOR + .make_payment_and_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + refund_response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Creates multiple refunds against a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_succeeded_payment_multiple_times() { + CONNECTOR + .make_payment_and_multiple_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await; +} + +// Synchronizes a refund using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_refund() { + let refund_response = CONNECTOR + .make_payment_and_refund(payment_method_details(), None, get_default_payment_info()) + .await + .unwrap(); + let response = CONNECTOR + .rsync_retry_till_status_matches( + enums::RefundStatus::Success, + refund_response.response.unwrap().connector_refund_id, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Cards Negative scenarios +// Creates a payment with incorrect CVC. +#[actix_web::test] +async fn should_fail_payment_for_incorrect_cvc() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: domain::PaymentMethodData::Card(domain::Card { + card_cvc: Secret::new("12345".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's security code is invalid.".to_string(), + ); +} + +// Creates a payment with incorrect expiry month. +#[actix_web::test] +async fn should_fail_payment_for_invalid_exp_month() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: domain::PaymentMethodData::Card(domain::Card { + card_exp_month: Secret::new("20".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's expiration month is invalid.".to_string(), + ); +} + +// Creates a payment with incorrect expiry year. +#[actix_web::test] +async fn should_fail_payment_for_incorrect_expiry_year() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: domain::PaymentMethodData::Card(domain::Card { + card_exp_year: Secret::new("2000".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's expiration year is invalid.".to_string(), + ); +} + +// Voids a payment using automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_fail_void_payment_for_auto_capture() { + let authorize_response = CONNECTOR + .make_payment(payment_method_details(), get_default_payment_info()) + .await + .unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + assert_ne!(txn_id, None, "Empty connector transaction id"); + let void_response = CONNECTOR + .void_payment(txn_id.unwrap(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + void_response.response.unwrap_err().message, + "You cannot cancel this PaymentIntent because it has a status of succeeded." + ); +} + +// Captures a payment using invalid connector payment id. +#[actix_web::test] +async fn should_fail_capture_for_invalid_payment() { + let capture_response = CONNECTOR + .capture_payment("123456789".to_string(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + capture_response.response.unwrap_err().message, + String::from("No such payment_intent: '123456789'") + ); +} + +// Refunds a payment with refund amount higher than payment amount. +#[actix_web::test] +async fn should_fail_for_refund_amount_higher_than_payment_amount() { + let response = CONNECTOR + .make_payment_and_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 150, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Refund amount (₹1.50) is greater than charge amount (₹1.00)", + ); +} + +// Connector dependent test cases goes here + +// [#478]: add unit tests for non 3DS, wallets & webhooks in connector tests diff --git a/crates/router/tests/connectors/main.rs b/crates/router/tests/connectors/main.rs index fced1b6bff3..8005e84652b 100644 --- a/crates/router/tests/connectors/main.rs +++ b/crates/router/tests/connectors/main.rs @@ -24,6 +24,7 @@ mod bluesnap; mod boku; mod cashtocode; mod chargebee; +mod checkbook; mod checkout; mod coinbase; mod cryptopay; diff --git a/crates/router/tests/connectors/sample_auth.toml b/crates/router/tests/connectors/sample_auth.toml index 354959856bf..25c63908448 100644 --- a/crates/router/tests/connectors/sample_auth.toml +++ b/crates/router/tests/connectors/sample_auth.toml @@ -341,6 +341,10 @@ api_key = "MyApiKey" key1 = "Merchant id" api_secret = "Secret key" +[checkbook] +api_key="Client ID" +key1 ="Client Secret" + [santander] api_key="Client ID" key1 ="Client Secret" diff --git a/crates/test_utils/src/connector_auth.rs b/crates/test_utils/src/connector_auth.rs index 17d442315c6..c92d4aa8591 100644 --- a/crates/test_utils/src/connector_auth.rs +++ b/crates/test_utils/src/connector_auth.rs @@ -30,6 +30,7 @@ pub struct ConnectorAuthentication { pub boku: Option<BodyKey>, pub cashtocode: Option<BodyKey>, pub chargebee: Option<HeaderKey>, + pub checkbook: Option<BodyKey>, pub checkout: Option<SignatureKey>, pub coinbase: Option<HeaderKey>, pub coingate: Option<HeaderKey>, diff --git a/loadtest/config/development.toml b/loadtest/config/development.toml index 4fade351226..102daf94c6a 100644 --- a/loadtest/config/development.toml +++ b/loadtest/config/development.toml @@ -96,6 +96,7 @@ boku.base_url = "https://country-api4-stage.boku.com" braintree.base_url = "https://payments.sandbox.braintree-api.com/graphql" cashtocode.base_url = "https://cluster05.api-test.cashtocode.com" chargebee.base_url = "https://$.chargebee.com/api/" +checkbook.base_url = "https://api.sandbox.checkbook.io" checkout.base_url = "https://api.sandbox.checkout.com/" coinbase.base_url = "https://api.commerce.coinbase.com" coingate.base_url = "https://api-sandbox.coingate.com" @@ -223,6 +224,7 @@ cards = [ "bluesnap", "boku", "braintree", + "checkbook", "checkout", "coinbase", "coingate", diff --git a/scripts/add_connector.sh b/scripts/add_connector.sh index a8fbbb15af8..a76e9beacf9 100755 --- a/scripts/add_connector.sh +++ b/scripts/add_connector.sh @@ -6,7 +6,7 @@ function find_prev_connector() { git checkout $self cp $self $self.tmp # Add new connector to existing list and sort it - connectors=(aci adyen adyenplatform airwallex amazonpay applepay archipel authorizedotnet bambora bamboraapac bankofamerica barclaycard billwerk bitpay bluesnap boku braintree cashtocode chargebee checkout coinbase cryptopay ctp_visa cybersource datatrans deutschebank digitalvirgo dlocal dummyconnector dwolla ebanx elavon facilitapay fiserv fiservemea fiuu forte getnet globalpay globepay gocardless gpayments helcim hipay hyperswitch_vault iatapay inespay itaubank jpmorgan juspaythreedsserver klarna mifinity mollie moneris multisafepay netcetera nexinets nexixpay nomupay noon nordea novalnet nuvei opayo opennode paybox payeezy payme payone paypal paystack payu placetopay plaid powertranz prophetpay rapyd razorpay recurly redsys santander shift4 square stax stripe stripebilling taxjar threedsecureio thunes tokenio trustpay tsys unified_authentication_service vgs volt wellsfargo wellsfargopayout wise worldline worldpay worldpayvantiv worldpayxml xendit zsl "$1") + connectors=(aci adyen adyenplatform airwallex amazonpay applepay archipel authorizedotnet bambora bamboraapac bankofamerica barclaycard billwerk bitpay bluesnap boku braintree cashtocode chargebee checkbook checkout coinbase cryptopay ctp_visa cybersource datatrans deutschebank digitalvirgo dlocal dummyconnector dwolla ebanx elavon facilitapay fiserv fiservemea fiuu forte getnet globalpay globepay gocardless gpayments helcim hipay hyperswitch_vault iatapay inespay itaubank jpmorgan juspaythreedsserver klarna mifinity mollie moneris multisafepay netcetera nexinets nexixpay nomupay noon nordea novalnet nuvei opayo opennode paybox payeezy payme payone paypal paystack payu placetopay plaid powertranz prophetpay rapyd razorpay recurly redsys santander shift4 square stax stripe stripebilling taxjar threedsecureio thunes tokenio trustpay tsys unified_authentication_service vgs volt wellsfargo wellsfargopayout wise worldline worldpay worldpayvantiv worldpayxml xendit zsl "$1") IFS=$'\n' sorted=($(sort <<<"${connectors[*]}")); unset IFS res="$(echo ${sorted[@]})" sed -i'' -e "s/^ connectors=.*/ connectors=($res \"\$1\")/" $self.tmp

2025-06-30T09:30:05Z

## Type of Change  - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD Closes this [issue](https://github.com/juspay/hyperswitch/issues/8493) ## Description  Added template code for [Checkbook](https://docs.checkbook.io/reference/) ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  ## How did you test it?  No tests required ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.114.0

28d63575e63d87b1cba7c6215faee803f2fff7d8

juspay/hyperswitch

juspay__hyperswitch-8507

Bug: [FEATURE] populate connector raw response and connector_response_reference_id in v2 populate connector raw response and connector_response_reference_id

diff --git a/api-reference/v2/openapi_spec_v2.json b/api-reference/v2/openapi_spec_v2.json index 8da8f56f709..76a35e926e2 100644 --- a/api-reference/v2/openapi_spec_v2.json +++ b/api-reference/v2/openapi_spec_v2.json @@ -17881,41 +17881,6 @@ "propertyName": "payment_processing_details_at" } }, - "PaymentRetrieveBody": { - "type": "object", - "properties": { - "merchant_id": { - "type": "string", - "description": "The identifier for the Merchant Account.", - "nullable": true - }, - "force_sync": { - "type": "boolean", - "description": "Decider to enable or disable the connector call for retrieve request", - "nullable": true - }, - "client_secret": { - "type": "string", - "description": "This is a token which expires after 15 minutes, used from the client to authenticate and create sessions from the SDK", - "nullable": true - }, - "expand_captures": { - "type": "boolean", - "description": "If enabled provides list of captures linked to latest attempt", - "nullable": true - }, - "expand_attempts": { - "type": "boolean", - "description": "If enabled provides list of attempts linked to payment intent", - "nullable": true - }, - "all_keys_required": { - "type": "boolean", - "description": "If enabled, provides whole connector response", - "nullable": true - } - } - }, "PaymentRevenueRecoveryMetadata": { "type": "object", "required": [ @@ -18128,6 +18093,11 @@ } ], "nullable": true + }, + "return_raw_connector_response": { + "type": "boolean", + "description": "If true, returns stringified connector raw response body", + "nullable": true } }, "additionalProperties": false @@ -19127,6 +19097,11 @@ } ], "nullable": true + }, + "return_raw_connector_response": { + "type": "boolean", + "description": "Stringified connector raw response body. Only returned if `return_raw_connector_response` is true", + "nullable": true } }, "additionalProperties": false @@ -19311,6 +19286,11 @@ "nullable": true, "maxLength": 30, "minLength": 30 + }, + "raw_connector_response": { + "type": "string", + "description": "Stringified connector raw response body. Only returned if `return_raw_connector_response` is true", + "nullable": true } } }, @@ -19331,9 +19311,9 @@ "description": "These are the query params that are sent in case of redirect response.\nThese can be ingested by the connector to take necessary actions.", "nullable": true }, - "all_keys_required": { + "return_raw_connector_response": { "type": "boolean", - "description": "If enabled, provides whole connector response", + "description": "If true, returns stringified connector raw response body", "nullable": true }, "merchant_connector_details": { @@ -19394,9 +19374,9 @@ "description": "These are the query params that are sent in case of redirect response.\nThese can be ingested by the connector to take necessary actions.", "nullable": true }, - "all_keys_required": { + "return_raw_connector_response": { "type": "boolean", - "description": "If enabled, provides whole connector response", + "description": "If true, returns stringified connector raw response body", "nullable": true } } diff --git a/crates/api_models/src/payments.rs b/crates/api_models/src/payments.rs index 2ff07472a0d..9150697aa19 100644 --- a/crates/api_models/src/payments.rs +++ b/crates/api_models/src/payments.rs @@ -5347,6 +5347,9 @@ pub struct PaymentsConfirmIntentRequest { /// Merchant connector details used to make payments. #[schema(value_type = Option<MerchantConnectorAuthDetails>)] pub merchant_connector_details: Option<common_types::domain::MerchantConnectorAuthDetails>, + + /// If true, returns stringified connector raw response body + pub return_raw_connector_response: Option<bool>, } #[cfg(feature = "v2")] @@ -5523,6 +5526,9 @@ pub struct PaymentsRequest { /// Merchant connector details used to make payments. #[schema(value_type = Option<MerchantConnectorAuthDetails>)] pub merchant_connector_details: Option<common_types::domain::MerchantConnectorAuthDetails>, + + /// Stringified connector raw response body. Only returned if `return_raw_connector_response` is true + pub return_raw_connector_response: Option<bool>, } #[cfg(feature = "v2")] @@ -5575,6 +5581,7 @@ impl From<&PaymentsRequest> for PaymentsConfirmIntentRequest { payment_method_id: request.payment_method_id.clone(), payment_token: None, merchant_connector_details: request.merchant_connector_details.clone(), + return_raw_connector_response: request.return_raw_connector_response, } } } @@ -5597,8 +5604,8 @@ pub struct PaymentsRetrieveRequest { /// These are the query params that are sent in case of redirect response. /// These can be ingested by the connector to take necessary actions. pub param: Option<String>, - /// If enabled, provides whole connector response - pub all_keys_required: Option<bool>, + /// If true, returns stringified connector raw response body + pub return_raw_connector_response: Option<bool>, /// Merchant connector details used to make payments. #[schema(value_type = Option<MerchantConnectorAuthDetails>)] pub merchant_connector_details: Option<common_types::domain::MerchantConnectorAuthDetails>, @@ -5619,8 +5626,8 @@ pub struct PaymentsStatusRequest { /// These are the query params that are sent in case of redirect response. /// These can be ingested by the connector to take necessary actions. pub param: Option<String>, - /// If enabled, provides whole connector response - pub all_keys_required: Option<bool>, + /// If true, returns stringified connector raw response body + pub return_raw_connector_response: Option<bool>, } /// Error details for the payment @@ -5776,6 +5783,9 @@ pub struct PaymentsResponse { example = "pay_mbabizu24mvu3mela5njyhpit4" )] pub merchant_reference_id: Option<id_type::PaymentReferenceId>, + + /// Stringified connector raw response body. Only returned if `return_raw_connector_response` is true + pub raw_connector_response: Option<String>, } #[cfg(feature = "v2")] @@ -7496,6 +7506,7 @@ pub struct PaymentsSessionResponse { pub vault_details: Option<VaultSessionDetails>, } +#[cfg(feature = "v1")] #[derive(Default, Debug, serde::Deserialize, serde::Serialize, Clone, ToSchema)] pub struct PaymentRetrieveBody { /// The identifier for the Merchant Account. @@ -7513,6 +7524,7 @@ pub struct PaymentRetrieveBody { pub all_keys_required: Option<bool>, } +#[cfg(feature = "v1")] #[derive(Default, Debug, serde::Deserialize, serde::Serialize, Clone, ToSchema)] pub struct PaymentRetrieveBodyWithCredentials { /// The identifier for payment. diff --git a/crates/common_types/src/domain.rs b/crates/common_types/src/domain.rs index f41f874cd06..66ffa6029d0 100644 --- a/crates/common_types/src/domain.rs +++ b/crates/common_types/src/domain.rs @@ -106,3 +106,11 @@ pub struct MerchantConnectorAuthDetails { }"#)] pub merchant_connector_creds: common_utils::pii::SecretSerdeValue, } + +/// Connector Response Data that are required to be populated in response +#[cfg(feature = "v2")] +#[derive(Clone, Debug)] +pub struct ConnectorResponseData { + /// Stringified connector raw response body + pub raw_connector_response: Option<String>, +} diff --git a/crates/diesel_models/src/payment_attempt.rs b/crates/diesel_models/src/payment_attempt.rs index eeda9e78877..95bb5a875d1 100644 --- a/crates/diesel_models/src/payment_attempt.rs +++ b/crates/diesel_models/src/payment_attempt.rs @@ -852,7 +852,7 @@ pub struct PaymentAttemptUpdateInternal { // payment_experience: Option<storage_enums::PaymentExperience>, // preprocessing_step_id: Option<String>, pub error_reason: Option<String>, - // connector_response_reference_id: Option<String>, + pub connector_response_reference_id: Option<String>, // multiple_capture_count: Option<i16>, // pub surcharge_amount: Option<MinorUnit>, // tax_on_surcharge: Option<MinorUnit>, @@ -910,6 +910,7 @@ impl PaymentAttemptUpdateInternal { network_error_message, payment_method_id, connector_request_reference_id, + connector_response_reference_id, } = self; PaymentAttempt { @@ -939,7 +940,8 @@ impl PaymentAttemptUpdateInternal { preprocessing_step_id: source.preprocessing_step_id, error_reason: error_reason.or(source.error_reason), multiple_capture_count: source.multiple_capture_count, - connector_response_reference_id: source.connector_response_reference_id, + connector_response_reference_id: connector_response_reference_id + .or(source.connector_response_reference_id), amount_capturable: amount_capturable.unwrap_or(source.amount_capturable), updated_by, merchant_connector_id: merchant_connector_id.or(source.merchant_connector_id), diff --git a/crates/hyperswitch_connectors/src/connectors/razorpay.rs b/crates/hyperswitch_connectors/src/connectors/razorpay.rs index 39b83c73e43..33cdc326987 100644 --- a/crates/hyperswitch_connectors/src/connectors/razorpay.rs +++ b/crates/hyperswitch_connectors/src/connectors/razorpay.rs @@ -316,7 +316,7 @@ impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData connectors: &Connectors, ) -> CustomResult<String, errors::ConnectorError> { Ok(format!( - "{}v1/payments/create/json", + "{}v1/payments/create/upi", self.base_url(connectors) )) } @@ -404,15 +404,15 @@ impl ConnectorIntegration<PSync, PaymentsSyncData, PaymentsResponseData> for Raz req: &PaymentsSyncRouterData, connectors: &Connectors, ) -> CustomResult<String, errors::ConnectorError> { - let connector_payment_id = req + let order_id = req .request - .connector_transaction_id - .get_connector_transaction_id() - .change_context(errors::ConnectorError::MissingConnectorTransactionID)?; + .connector_reference_id + .clone() + .ok_or(errors::ConnectorError::RequestEncodingFailed)?; Ok(format!( - "{}v1/payments/{}", + "{}v1/orders/{}/payments", self.base_url(connectors), - connector_payment_id, + order_id, )) } @@ -512,21 +512,11 @@ impl ConnectorIntegration<Capture, PaymentsCaptureData, PaymentsResponseData> fo fn handle_response( &self, - data: &PaymentsCaptureRouterData, - event_builder: Option<&mut ConnectorEvent>, - res: Response, + _data: &PaymentsCaptureRouterData, + _event_builder: Option<&mut ConnectorEvent>, + _res: Response, ) -> CustomResult<PaymentsCaptureRouterData, errors::ConnectorError> { - let response: razorpay::RazorpayPaymentsResponse = res - .response - .parse_struct("Razorpay PaymentsCaptureResponse") - .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; - event_builder.map(|i| i.set_response_body(&response)); - router_env::logger::info!(connector_response=?response); - RouterData::try_from(ResponseRouterData { - response, - data: data.clone(), - http_code: res.status_code, - }) + Err(errors::ConnectorError::NotImplemented("get_request_body method".to_string()).into()) } fn get_error_response( diff --git a/crates/hyperswitch_connectors/src/connectors/razorpay/transformers.rs b/crates/hyperswitch_connectors/src/connectors/razorpay/transformers.rs index 23aa8828291..0176ae47854 100644 --- a/crates/hyperswitch_connectors/src/connectors/razorpay/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/razorpay/transformers.rs @@ -11,7 +11,7 @@ use hyperswitch_domain_models::{ payment_method_data::{PaymentMethodData, UpiData}, router_data::{ConnectorAuthType, RouterData}, router_flow_types::refunds::{Execute, RSync}, - router_request_types::ResponseId, + router_request_types::{PaymentsAuthorizeData, ResponseId}, router_response_types::{PaymentsResponseData, RefundsResponseData}, types, }; @@ -227,18 +227,29 @@ pub struct NextAction { #[derive(Debug, Clone, Serialize, Deserialize)] pub struct RazorpayPaymentsResponse { pub razorpay_payment_id: String, - pub next: Option<Vec<NextAction>>, } -impl<F, T> TryFrom<ResponseRouterData<F, RazorpayPaymentsResponse, T, PaymentsResponseData>> - for RouterData<F, T, PaymentsResponseData> +impl<F> + TryFrom< + ResponseRouterData< + F, + RazorpayPaymentsResponse, + PaymentsAuthorizeData, + PaymentsResponseData, + >, + > for RouterData<F, PaymentsAuthorizeData, PaymentsResponseData> { type Error = error_stack::Report<errors::ConnectorError>; fn try_from( - item: ResponseRouterData<F, RazorpayPaymentsResponse, T, PaymentsResponseData>, + item: ResponseRouterData< + F, + RazorpayPaymentsResponse, + PaymentsAuthorizeData, + PaymentsResponseData, + >, ) -> Result<Self, Self::Error> { let connector_metadata = get_wait_screen_metadata()?; - + let order_id = item.data.request.get_order_id()?; Ok(Self { status: enums::AttemptStatus::AuthenticationPending, response: Ok(PaymentsResponseData::TransactionResponse { @@ -249,7 +260,7 @@ impl<F, T> TryFrom<ResponseRouterData<F, RazorpayPaymentsResponse, T, PaymentsRe mandate_reference: Box::new(None), connector_metadata, network_txn_id: None, - connector_response_reference_id: Some(item.response.razorpay_payment_id), + connector_response_reference_id: Some(order_id), incremental_authorization_allowed: None, charges: None, }), @@ -281,6 +292,12 @@ pub fn get_wait_screen_metadata() -> CustomResult<Option<serde_json::Value>, err #[derive(Debug, Clone, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct RazorpaySyncResponse { + items: Vec<RazorpaySyncItem>, +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct RazorpaySyncItem { id: String, status: RazorpayStatus, } @@ -311,8 +328,15 @@ impl<F, T> TryFrom<ResponseRouterData<F, RazorpaySyncResponse, T, PaymentsRespon fn try_from( item: ResponseRouterData<F, RazorpaySyncResponse, T, PaymentsResponseData>, ) -> Result<Self, Self::Error> { + let status = match item.response.items.last() { + Some(last_item) => { + let razorpay_status = last_item.status; + get_psync_razorpay_payment_status(razorpay_status) + } + None => item.data.status, + }; Ok(Self { - status: get_psync_razorpay_payment_status(item.response.status), + status, response: Ok(PaymentsResponseData::TransactionResponse { resource_id: ResponseId::NoResponseId, redirection_data: Box::new(None), diff --git a/crates/hyperswitch_connectors/src/utils.rs b/crates/hyperswitch_connectors/src/utils.rs index b346b40d970..1353d068190 100644 --- a/crates/hyperswitch_connectors/src/utils.rs +++ b/crates/hyperswitch_connectors/src/utils.rs @@ -6209,7 +6209,7 @@ pub(crate) fn convert_payment_authorize_router_response<F1, F2, T1, T2>( connector_mandate_request_reference_id: data.connector_mandate_request_reference_id.clone(), authentication_id: data.authentication_id.clone(), psd2_sca_exemption_type: data.psd2_sca_exemption_type, - whole_connector_response: data.whole_connector_response.clone(), + raw_connector_response: data.raw_connector_response.clone(), } } diff --git a/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs b/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs index d644c519ea9..9078f1d49df 100644 --- a/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs +++ b/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs @@ -1763,6 +1763,7 @@ pub struct ConfirmIntentResponseUpdate { pub connector_metadata: Option<pii::SecretSerdeValue>, pub amount_capturable: Option<MinorUnit>, pub connector_token_details: Option<diesel_models::ConnectorTokenDetails>, + pub connector_response_reference_id: Option<String>, } #[cfg(feature = "v2")] @@ -1776,6 +1777,7 @@ pub enum PaymentAttemptUpdate { merchant_connector_id: Option<id_type::MerchantConnectorAccountId>, authentication_type: storage_enums::AuthenticationType, connector_request_reference_id: Option<String>, + connector_response_reference_id: Option<String>, }, /// Update the payment attempt on confirming the intent, before calling the connector, when payment_method_id is present ConfirmIntentTokenized { @@ -2569,6 +2571,7 @@ impl From<PaymentAttemptUpdate> for diesel_models::PaymentAttemptUpdateInternal merchant_connector_id, authentication_type, connector_request_reference_id, + connector_response_reference_id, } => Self { status: Some(status), payment_method_id: None, @@ -2594,6 +2597,7 @@ impl From<PaymentAttemptUpdate> for diesel_models::PaymentAttemptUpdateInternal network_decline_code: None, network_error_message: None, connector_request_reference_id, + connector_response_reference_id, }, PaymentAttemptUpdate::ErrorUpdate { status, @@ -2626,6 +2630,7 @@ impl From<PaymentAttemptUpdate> for diesel_models::PaymentAttemptUpdateInternal network_decline_code: error.network_decline_code, network_error_message: error.network_error_message, connector_request_reference_id: None, + connector_response_reference_id: None, }, PaymentAttemptUpdate::ConfirmIntentResponse(confirm_intent_response_update) => { let ConfirmIntentResponseUpdate { @@ -2636,6 +2641,7 @@ impl From<PaymentAttemptUpdate> for diesel_models::PaymentAttemptUpdateInternal connector_metadata, amount_capturable, connector_token_details, + connector_response_reference_id, } = *confirm_intent_response_update; Self { status: Some(status), @@ -2663,6 +2669,7 @@ impl From<PaymentAttemptUpdate> for diesel_models::PaymentAttemptUpdateInternal network_decline_code: None, network_error_message: None, connector_request_reference_id: None, + connector_response_reference_id, } } PaymentAttemptUpdate::SyncUpdate { @@ -2694,6 +2701,7 @@ impl From<PaymentAttemptUpdate> for diesel_models::PaymentAttemptUpdateInternal network_decline_code: None, network_error_message: None, connector_request_reference_id: None, + connector_response_reference_id: None, }, PaymentAttemptUpdate::CaptureUpdate { status, @@ -2724,6 +2732,7 @@ impl From<PaymentAttemptUpdate> for diesel_models::PaymentAttemptUpdateInternal network_decline_code: None, network_error_message: None, connector_request_reference_id: None, + connector_response_reference_id: None, }, PaymentAttemptUpdate::PreCaptureUpdate { amount_to_capture, @@ -2753,6 +2762,7 @@ impl From<PaymentAttemptUpdate> for diesel_models::PaymentAttemptUpdateInternal network_decline_code: None, network_error_message: None, connector_request_reference_id: None, + connector_response_reference_id: None, }, PaymentAttemptUpdate::ConfirmIntentTokenized { status, @@ -2786,6 +2796,7 @@ impl From<PaymentAttemptUpdate> for diesel_models::PaymentAttemptUpdateInternal network_decline_code: None, network_error_message: None, connector_request_reference_id: None, + connector_response_reference_id: None, }, } } diff --git a/crates/hyperswitch_domain_models/src/router_data.rs b/crates/hyperswitch_domain_models/src/router_data.rs index dd1004c7018..851ac69a81c 100644 --- a/crates/hyperswitch_domain_models/src/router_data.rs +++ b/crates/hyperswitch_domain_models/src/router_data.rs @@ -103,8 +103,8 @@ pub struct RouterData<Flow, Request, Response> { /// Contains the type of sca exemption required for the transaction pub psd2_sca_exemption_type: Option<common_enums::ScaExemptionType>, - /// Contains whole connector response - pub whole_connector_response: Option<String>, + /// Contains stringified connector raw response body + pub raw_connector_response: Option<String>, } // Different patterns of authentication. @@ -567,6 +567,7 @@ impl resource_id, redirection_data, connector_metadata, + connector_response_reference_id, .. } => { let attempt_status = self.get_attempt_status_for_db_update(payment_data); @@ -595,6 +596,8 @@ impl token_details.get_connector_token_request_reference_id() }), ), + connector_response_reference_id: connector_response_reference_id + .clone(), }, )) } @@ -1253,6 +1256,7 @@ impl resource_id, redirection_data, connector_metadata, + connector_response_reference_id, .. } => { let attempt_status = self.get_attempt_status_for_db_update(payment_data); @@ -1281,6 +1285,9 @@ impl token_details.get_connector_token_request_reference_id() }), ), + + connector_response_reference_id: connector_response_reference_id + .clone(), }, )) } diff --git a/crates/hyperswitch_domain_models/src/router_request_types.rs b/crates/hyperswitch_domain_models/src/router_request_types.rs index c7987122ead..31879b4cfe3 100644 --- a/crates/hyperswitch_domain_models/src/router_request_types.rs +++ b/crates/hyperswitch_domain_models/src/router_request_types.rs @@ -508,6 +508,7 @@ pub struct PaymentsSyncData { pub split_payments: Option<common_types::payments::SplitPaymentsRequest>, pub amount: MinorUnit, pub integrity_object: Option<SyncIntegrityObject>, + pub connector_reference_id: Option<String>, } #[derive(Debug, Default, Clone)] diff --git a/crates/hyperswitch_interfaces/src/conversion_impls.rs b/crates/hyperswitch_interfaces/src/conversion_impls.rs index 252caed961e..ae5f071a209 100644 --- a/crates/hyperswitch_interfaces/src/conversion_impls.rs +++ b/crates/hyperswitch_interfaces/src/conversion_impls.rs @@ -84,7 +84,7 @@ fn get_default_router_data<F, Req, Resp>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, } } diff --git a/crates/openapi/src/openapi_v2.rs b/crates/openapi/src/openapi_v2.rs index 4a3c03d69fb..11dae0588ab 100644 --- a/crates/openapi/src/openapi_v2.rs +++ b/crates/openapi/src/openapi_v2.rs @@ -424,7 +424,6 @@ Never share your secret api keys. Keep them guarded and secure. api_models::payments::PaymentsRequest, api_models::payments::PaymentsResponse, api_models::payments::PaymentsListResponseItem, - api_models::payments::PaymentRetrieveBody, api_models::payments::PaymentsRetrieveRequest, api_models::payments::PaymentsStatusRequest, api_models::payments::PaymentsCaptureRequest, diff --git a/crates/router/src/core/authentication/transformers.rs b/crates/router/src/core/authentication/transformers.rs index e1cf04c20aa..91b7c23f053 100644 --- a/crates/router/src/core/authentication/transformers.rs +++ b/crates/router/src/core/authentication/transformers.rs @@ -206,7 +206,7 @@ pub fn construct_router_data<F: Clone, Req, Res>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type, - whole_connector_response: None, + raw_connector_response: None, }) } diff --git a/crates/router/src/core/fraud_check/flows/checkout_flow.rs b/crates/router/src/core/fraud_check/flows/checkout_flow.rs index 786192f8e98..a33dcc89a99 100644 --- a/crates/router/src/core/fraud_check/flows/checkout_flow.rs +++ b/crates/router/src/core/fraud_check/flows/checkout_flow.rs @@ -161,7 +161,7 @@ impl ConstructFlowSpecificData<frm_api::Checkout, FraudCheckCheckoutData, FraudC connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) diff --git a/crates/router/src/core/fraud_check/flows/fulfillment_flow.rs b/crates/router/src/core/fraud_check/flows/fulfillment_flow.rs index 421c255e117..08b3c789264 100644 --- a/crates/router/src/core/fraud_check/flows/fulfillment_flow.rs +++ b/crates/router/src/core/fraud_check/flows/fulfillment_flow.rs @@ -128,7 +128,7 @@ pub async fn construct_fulfillment_router_data<'a>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) } diff --git a/crates/router/src/core/fraud_check/flows/record_return.rs b/crates/router/src/core/fraud_check/flows/record_return.rs index ea34b8af172..d33cd51e574 100644 --- a/crates/router/src/core/fraud_check/flows/record_return.rs +++ b/crates/router/src/core/fraud_check/flows/record_return.rs @@ -129,7 +129,7 @@ impl ConstructFlowSpecificData<RecordReturn, FraudCheckRecordReturnData, FraudCh connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) diff --git a/crates/router/src/core/fraud_check/flows/sale_flow.rs b/crates/router/src/core/fraud_check/flows/sale_flow.rs index efdeeec7747..55d53f00964 100644 --- a/crates/router/src/core/fraud_check/flows/sale_flow.rs +++ b/crates/router/src/core/fraud_check/flows/sale_flow.rs @@ -137,7 +137,7 @@ impl ConstructFlowSpecificData<frm_api::Sale, FraudCheckSaleData, FraudCheckResp connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) diff --git a/crates/router/src/core/fraud_check/flows/transaction_flow.rs b/crates/router/src/core/fraud_check/flows/transaction_flow.rs index eae995be4b4..29013c70e92 100644 --- a/crates/router/src/core/fraud_check/flows/transaction_flow.rs +++ b/crates/router/src/core/fraud_check/flows/transaction_flow.rs @@ -146,7 +146,7 @@ impl connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) diff --git a/crates/router/src/core/mandate/utils.rs b/crates/router/src/core/mandate/utils.rs index 642a28c5671..1298162d412 100644 --- a/crates/router/src/core/mandate/utils.rs +++ b/crates/router/src/core/mandate/utils.rs @@ -85,7 +85,7 @@ pub async fn construct_mandate_revoke_router_data( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) diff --git a/crates/router/src/core/payment_methods.rs b/crates/router/src/core/payment_methods.rs index 6d36f7d4341..d04bf5b39ed 100644 --- a/crates/router/src/core/payment_methods.rs +++ b/crates/router/src/core/payment_methods.rs @@ -2922,6 +2922,7 @@ fn construct_zero_auth_payments_request( force_3ds_challenge: None, is_iframe_redirection_enabled: None, merchant_connector_details: None, + return_raw_connector_response: None, }) } @@ -3263,7 +3264,7 @@ async fn create_single_use_tokenization_flow( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; let payment_method_token_response = tokenization::add_token_for_payment_method( diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs index 66334148b09..7e5328763fd 100644 --- a/crates/router/src/core/payments.rs +++ b/crates/router/src/core/payments.rs @@ -148,7 +148,14 @@ pub async fn payments_operation_core<F, Req, Op, FData, D>( get_tracker_response: operations::GetTrackerResponse<D>, call_connector_action: CallConnectorAction, header_payload: HeaderPayload, -) -> RouterResult<(D, Req, Option<domain::Customer>, Option<u16>, Option<u128>)> +) -> RouterResult<( + D, + Req, + Option<domain::Customer>, + Option<u16>, + Option<u128>, + common_types::domain::ConnectorResponseData, +)> where F: Send + Clone + Sync, Req: Send + Sync + Authenticate, @@ -204,7 +211,7 @@ where .perform_routing(&merchant_context, profile, state, &mut payment_data) .await?; - let payment_data = match connector { + let (payment_data, connector_response_data) = match connector { ConnectorCallType::PreDetermined(connector_data) => { let router_data = call_connector_service( state, @@ -224,10 +231,14 @@ where profile, false, false, //should_retry_with_pan is set to false in case of PreDetermined ConnectorCallType - req.get_all_keys_required(), + req.should_return_raw_response(), ) .await?; + let connector_response_data = common_types::domain::ConnectorResponseData { + raw_connector_response: router_data.raw_connector_response.clone(), + }; + let payments_response_operation = Box::new(PaymentResponse); payments_response_operation @@ -241,7 +252,7 @@ where ) .await?; - payments_response_operation + let payment_data = payments_response_operation .to_post_update_tracker()? .update_tracker( state, @@ -250,7 +261,9 @@ where merchant_context.get_merchant_key_store(), merchant_context.get_merchant_account().storage_scheme, ) - .await? + .await?; + + (payment_data, connector_response_data) } ConnectorCallType::Retryable(connectors) => { let mut connectors = connectors.clone().into_iter(); @@ -273,10 +286,14 @@ where profile, false, false, //should_retry_with_pan is set to false in case of PreDetermined ConnectorCallType - req.get_all_keys_required(), + req.should_return_raw_response(), ) .await?; + let connector_response_data = common_types::domain::ConnectorResponseData { + raw_connector_response: router_data.raw_connector_response.clone(), + }; + let payments_response_operation = Box::new(PaymentResponse); payments_response_operation @@ -290,7 +307,7 @@ where ) .await?; - payments_response_operation + let payment_data = payments_response_operation .to_post_update_tracker()? .update_tracker( state, @@ -299,10 +316,17 @@ where merchant_context.get_merchant_key_store(), merchant_context.get_merchant_account().storage_scheme, ) - .await? + .await?; + + (payment_data, connector_response_data) } ConnectorCallType::SessionMultiple(vec) => todo!(), - ConnectorCallType::Skip => payment_data, + ConnectorCallType::Skip => ( + payment_data, + common_types::domain::ConnectorResponseData { + raw_connector_response: None, + }, + ), }; let payment_intent_status = payment_data.get_payment_intent().status; @@ -321,7 +345,14 @@ where }) .await; - Ok((payment_data, req, customer, None, None)) + Ok(( + payment_data, + req, + customer, + None, + None, + connector_response_data, + )) } #[cfg(feature = "v2")] @@ -337,7 +368,13 @@ pub async fn internal_payments_operation_core<F, Req, Op, FData, D>( get_tracker_response: operations::GetTrackerResponse<D>, call_connector_action: CallConnectorAction, header_payload: HeaderPayload, -) -> RouterResult<(D, Req, Option<u16>, Option<u128>)> +) -> RouterResult<( + D, + Req, + Option<u16>, + Option<u128>, + common_types::domain::ConnectorResponseData, +)> where F: Send + Clone + Sync, Req: Send + Sync + Authenticate, @@ -379,10 +416,14 @@ where call_connector_action.clone(), header_payload.clone(), profile, - req.get_all_keys_required(), + req.should_return_raw_response(), ) .await?; + let connector_response_data = common_types::domain::ConnectorResponseData { + raw_connector_response: router_data.raw_connector_response.clone(), + }; + let payments_response_operation = Box::new(PaymentResponse); let payment_data = payments_response_operation @@ -396,7 +437,7 @@ where ) .await?; - Ok((payment_data, req, None, None)) + Ok((payment_data, req, None, None, connector_response_data)) } #[cfg(feature = "v1")] @@ -686,7 +727,7 @@ where false, false, None, - <Req as Authenticate>::get_all_keys_required(&req), + <Req as Authenticate>::should_return_raw_response(&req), ) .await?; @@ -810,7 +851,7 @@ where false, false, routing_decision, - <Req as Authenticate>::get_all_keys_required(&req), + <Req as Authenticate>::should_return_raw_response(&req), ) .await?; @@ -941,7 +982,7 @@ where session_surcharge_details, &business_profile, header_payload.clone(), - <Req as Authenticate>::get_all_keys_required(&req), + <Req as Authenticate>::should_return_raw_response(&req), )) .await? } @@ -1070,7 +1111,7 @@ pub async fn proxy_for_payments_operation_core<F, Req, Op, FData, D>( call_connector_action: CallConnectorAction, auth_flow: services::AuthFlow, header_payload: HeaderPayload, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<(D, Req, Option<domain::Customer>, Option<u16>, Option<u128>)> where F: Send + Clone + Sync, @@ -1184,7 +1225,7 @@ where schedule_time, header_payload.clone(), &business_profile, - all_keys_required, + return_raw_connector_response, ) .await?; @@ -1270,7 +1311,7 @@ pub async fn proxy_for_payments_operation_core<F, Req, Op, FData, D>( get_tracker_response: operations::GetTrackerResponse<D>, call_connector_action: CallConnectorAction, header_payload: HeaderPayload, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<(D, Req, Option<u16>, Option<u128>)> where F: Send + Clone + Sync, @@ -1315,7 +1356,7 @@ where call_connector_action.clone(), header_payload.clone(), &profile, - all_keys_required, + return_raw_connector_response, ) .await?; @@ -1865,7 +1906,7 @@ pub async fn proxy_for_payments_core<F, Res, Req, Op, FData, D>( auth_flow: services::AuthFlow, call_connector_action: CallConnectorAction, header_payload: HeaderPayload, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResponse<Res> where F: Send + Clone + Sync, @@ -1896,7 +1937,7 @@ where call_connector_action, auth_flow, header_payload.clone(), - all_keys_required, + return_raw_connector_response, ) .await?; @@ -1925,7 +1966,7 @@ pub async fn proxy_for_payments_core<F, Res, Req, Op, FData, D>( payment_id: id_type::GlobalPaymentId, call_connector_action: CallConnectorAction, header_payload: HeaderPayload, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResponse<Res> where F: Send + Clone + Sync, @@ -1977,7 +2018,7 @@ where get_tracker_response, call_connector_action, header_payload.clone(), - all_keys_required, + return_raw_connector_response, ) .await?; @@ -1988,6 +2029,7 @@ where header_payload.x_hs_latency, &merchant_context, &profile, + None, ) } @@ -2065,7 +2107,7 @@ pub async fn record_attempt_core( force_sync: true, expand_attempts: false, param: None, - all_keys_required: None, + return_raw_connector_response: None, merchant_connector_details: None, }, operations::GetTrackerResponse { @@ -2125,6 +2167,7 @@ pub async fn record_attempt_core( header_payload.x_hs_latency, &merchant_context, &profile, + None, ) } @@ -2334,37 +2377,58 @@ where ) .await?; - let (payment_data, connector_http_status_code, external_latency) = + let (payment_data, connector_http_status_code, external_latency, connector_response_data) = if state.conf.merchant_id_auth.merchant_id_auth_enabled { - let (payment_data, _req, connector_http_status_code, external_latency) = - internal_payments_operation_core::<_, _, _, _, _>( - &state, - req_state, - merchant_context.clone(), - &profile, - operation.clone(), - req, - get_tracker_response, - call_connector_action, - header_payload.clone(), - ) - .await?; - (payment_data, connector_http_status_code, external_latency) + let ( + payment_data, + _req, + connector_http_status_code, + external_latency, + connector_response_data, + ) = internal_payments_operation_core::<_, _, _, _, _>( + &state, + req_state, + merchant_context.clone(), + &profile, + operation.clone(), + req, + get_tracker_response, + call_connector_action, + header_payload.clone(), + ) + .await?; + ( + payment_data, + connector_http_status_code, + external_latency, + connector_response_data, + ) } else { - let (payment_data, _req, _customer, connector_http_status_code, external_latency) = - payments_operation_core::<_, _, _, _, _>( - &state, - req_state, - merchant_context.clone(), - &profile, - operation.clone(), - req, - get_tracker_response, - call_connector_action, - header_payload.clone(), - ) - .await?; - (payment_data, connector_http_status_code, external_latency) + let ( + payment_data, + _req, + _customer, + connector_http_status_code, + external_latency, + connector_response_data, + ) = payments_operation_core::<_, _, _, _, _>( + &state, + req_state, + merchant_context.clone(), + &profile, + operation.clone(), + req, + get_tracker_response, + call_connector_action, + header_payload.clone(), + ) + .await?; + ( + payment_data, + connector_http_status_code, + external_latency, + connector_response_data, + ) }; payment_data.generate_response( @@ -2374,6 +2438,7 @@ where header_payload.x_hs_latency, &merchant_context, &profile, + Some(connector_response_data), ) } @@ -3000,7 +3065,7 @@ impl PaymentRedirectFlow for PaymentRedirectSync { param: Some(req.query_params.clone()), force_sync: true, expand_attempts: false, - all_keys_required: None, + return_raw_connector_response: None, merchant_connector_details: None, // TODO: Implement for connectors requiring 3DS or redirection-based authentication flows. }; @@ -3056,7 +3121,7 @@ impl PaymentRedirectFlow for PaymentRedirectSync { .change_context(errors::ApiErrorResponse::InternalServerError) .attach_printable("Failed to decide the response flow")?; - let (payment_data, _, _, _, _) = + let (payment_data, _, _, _, _, _) = Box::pin(payments_operation_core::<api::PSync, _, _, _, _>( state, req_state, @@ -3378,7 +3443,7 @@ pub async fn call_connector_service<F, RouterDReq, ApiRequest, D>( is_retry_payment: bool, should_retry_with_pan: bool, routing_decision: Option<routing_helpers::RoutingDecisionData>, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<( RouterData<F, RouterDReq, router_types::PaymentsResponseData>, helpers::MerchantConnectorAccountType, @@ -3539,16 +3604,28 @@ where router_data = router_data.add_session_token(state, &connector).await?; - let should_continue_further = access_token::update_router_data_with_access_token_result( + let mut should_continue_further = access_token::update_router_data_with_access_token_result( &add_access_token_result, &mut router_data, &call_connector_action, ); - let should_continue_further = router_data + let add_create_order_result = router_data .create_order_at_connector(state, &connector, should_continue_further) .await?; + if add_create_order_result.is_create_order_performed { + if let Ok(order_id_opt) = &add_create_order_result.create_order_result { + payment_data.set_connector_response_reference_id(order_id_opt.clone()); + } + should_continue_further = router_data + .update_router_data_with_create_order_result( + add_create_order_result, + should_continue_further, + ) + .await?; + } + let updated_customer = call_create_connector_customer_if_required( state, customer, @@ -3664,7 +3741,7 @@ where connector_request, business_profile, header_payload.clone(), - all_keys_required, + return_raw_connector_response, ) .await } else { @@ -3696,7 +3773,7 @@ pub async fn call_connector_service<F, RouterDReq, ApiRequest, D>( business_profile: &domain::Profile, is_retry_payment: bool, should_retry_with_pan: bool, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<RouterData<F, RouterDReq, router_types::PaymentsResponseData>> where F: Send + Clone + Sync, @@ -3765,16 +3842,28 @@ where router_data = router_data.add_session_token(state, &connector).await?; - let should_continue_further = access_token::update_router_data_with_access_token_result( + let mut should_continue_further = access_token::update_router_data_with_access_token_result( &add_access_token_result, &mut router_data, &call_connector_action, ); - let should_continue_further = router_data + let add_create_order_result = router_data .create_order_at_connector(state, &connector, should_continue_further) .await?; + if add_create_order_result.is_create_order_performed { + if let Ok(order_id_opt) = &add_create_order_result.create_order_result { + payment_data.set_connector_response_reference_id(order_id_opt.clone()); + } + should_continue_further = router_data + .update_router_data_with_create_order_result( + add_create_order_result, + should_continue_further, + ) + .await?; + } + // In case of authorize flow, pre-task and post-tasks are being called in build request // if we do not want to proceed further, then the function will return Ok(None, false) let (connector_request, should_continue_further) = if should_continue_further { @@ -3819,7 +3908,7 @@ where connector_request, business_profile, header_payload.clone(), - all_keys_required, + return_raw_connector_response, ) .await } else { @@ -3851,7 +3940,7 @@ pub async fn proxy_for_call_connector_service<F, RouterDReq, ApiRequest, D>( header_payload: HeaderPayload, business_profile: &domain::Profile, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<( RouterData<F, RouterDReq, router_types::PaymentsResponseData>, helpers::MerchantConnectorAccountType, @@ -3992,7 +4081,7 @@ where connector_request, business_profile, header_payload.clone(), - all_keys_required, + return_raw_connector_response, ) .await } else { @@ -4019,7 +4108,7 @@ pub async fn proxy_for_call_connector_service<F, RouterDReq, ApiRequest, D>( call_connector_action: CallConnectorAction, header_payload: HeaderPayload, business_profile: &domain::Profile, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<RouterData<F, RouterDReq, router_types::PaymentsResponseData>> where F: Send + Clone + Sync, @@ -4116,7 +4205,7 @@ where connector_request, business_profile, header_payload.clone(), - all_keys_required, + return_raw_connector_response, ) .await } else { @@ -4143,7 +4232,7 @@ pub async fn internal_call_connector_service<F, RouterDReq, ApiRequest, D>( call_connector_action: CallConnectorAction, header_payload: HeaderPayload, business_profile: &domain::Profile, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<RouterData<F, RouterDReq, router_types::PaymentsResponseData>> where F: Send + Clone + Sync, @@ -4211,10 +4300,22 @@ where &call_connector_action, ); - let should_continue_further = router_data + let add_create_order_result = router_data .create_order_at_connector(state, &connector, should_continue_further) .await?; + if add_create_order_result.is_create_order_performed { + if let Ok(order_id_opt) = &add_create_order_result.create_order_result { + payment_data.set_connector_response_reference_id(order_id_opt.clone()); + } + should_continue_further = router_data + .update_router_data_with_create_order_result( + add_create_order_result, + should_continue_further, + ) + .await?; + } + let (connector_request, should_continue_further) = if should_continue_further { router_data .build_flow_specific_connector_request(state, &connector, call_connector_action.clone()) @@ -4247,7 +4348,7 @@ where connector_request, business_profile, header_payload.clone(), - all_keys_required, + return_raw_connector_response, ) .await } else { @@ -4509,7 +4610,7 @@ pub async fn call_multiple_connectors_service<F, Op, Req, D>( _session_surcharge_details: Option<api::SessionSurchargeDetails>, business_profile: &domain::Profile, header_payload: HeaderPayload, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<D> where Op: Debug, @@ -4560,7 +4661,7 @@ where None, business_profile, header_payload.clone(), - all_keys_required, + return_raw_connector_response, ); join_handlers.push(res); @@ -4620,7 +4721,7 @@ pub async fn call_multiple_connectors_service<F, Op, Req, D>( session_surcharge_details: Option<api::SessionSurchargeDetails>, business_profile: &domain::Profile, header_payload: HeaderPayload, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<D> where Op: Debug, @@ -4682,7 +4783,7 @@ where None, business_profile, header_payload.clone(), - all_keys_required, + return_raw_connector_response, ); join_handlers.push(res); @@ -8894,6 +8995,7 @@ pub trait OperationSessionGetters<F> { fn get_token_data(&self) -> Option<&storage::PaymentTokenData>; fn get_mandate_connector(&self) -> Option<&MandateConnectorDetails>; fn get_force_sync(&self) -> Option<bool>; + #[cfg(feature = "v1")] fn get_all_keys_required(&self) -> Option<bool>; fn get_capture_method(&self) -> Option<enums::CaptureMethod>; fn get_merchant_connector_id_in_attempt(&self) -> Option<id_type::MerchantConnectorAccountId>; @@ -8903,6 +9005,8 @@ pub trait OperationSessionGetters<F> { ) -> Option<common_types::domain::MerchantConnectorAuthDetails>; fn get_connector_customer_id(&self) -> Option<String>; + + #[cfg(feature = "v1")] fn get_whole_connector_response(&self) -> Option<String>; #[cfg(feature = "v1")] @@ -8981,6 +9085,8 @@ pub trait OperationSessionSetters<F> { #[cfg(feature = "v2")] fn set_connector_request_reference_id(&mut self, reference_id: Option<String>); + fn set_connector_response_reference_id(&mut self, reference_id: Option<String>); + #[cfg(feature = "v2")] fn set_vault_session_details( &mut self, @@ -9293,6 +9399,10 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentData<F> { ) { self.payment_attempt.routing_approach = routing_approach; } + + fn set_connector_response_reference_id(&mut self, reference_id: Option<String>) { + self.payment_attempt.connector_response_reference_id = reference_id; + } } #[cfg(feature = "v2")] @@ -9447,14 +9557,6 @@ impl<F: Clone> OperationSessionGetters<F> for PaymentIntentData<F> { todo!(); } - fn get_all_keys_required(&self) -> Option<bool> { - todo!(); - } - - fn get_whole_connector_response(&self) -> Option<String> { - todo!(); - } - fn get_pre_routing_result( &self, ) -> Option<HashMap<enums::PaymentMethodType, domain::PreRoutingConnectorChoice>> { @@ -9573,6 +9675,10 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentIntentData<F> { todo!() } + fn set_connector_response_reference_id(&mut self, reference_id: Option<String>) { + todo!() + } + fn set_vault_session_details( &mut self, vault_session_details: Option<api::VaultSessionDetails>, @@ -9738,14 +9844,6 @@ impl<F: Clone> OperationSessionGetters<F> for PaymentConfirmData<F> { Some(&self.payment_attempt) } - fn get_all_keys_required(&self) -> Option<bool> { - todo!() - } - - fn get_whole_connector_response(&self) -> Option<String> { - todo!() - } - fn get_pre_routing_result( &self, ) -> Option<HashMap<enums::PaymentMethodType, domain::PreRoutingConnectorChoice>> { @@ -9869,6 +9967,10 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentConfirmData<F> { self.payment_attempt.connector_request_reference_id = reference_id; } + fn set_connector_response_reference_id(&mut self, reference_id: Option<String>) { + self.payment_attempt.connector_response_reference_id = reference_id; + } + fn set_vault_session_details( &mut self, external_vault_session_details: Option<api::VaultSessionDetails>, @@ -10034,14 +10136,6 @@ impl<F: Clone> OperationSessionGetters<F> for PaymentStatusData<F> { Some(&self.payment_attempt) } - fn get_all_keys_required(&self) -> Option<bool> { - todo!() - } - - fn get_whole_connector_response(&self) -> Option<String> { - todo!() - } - fn get_pre_routing_result( &self, ) -> Option<HashMap<enums::PaymentMethodType, domain::PreRoutingConnectorChoice>> { @@ -10161,6 +10255,10 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentStatusData<F> { todo!() } + fn set_connector_response_reference_id(&mut self, reference_id: Option<String>) { + todo!() + } + fn set_vault_session_details( &mut self, external_vault_session_details: Option<api::VaultSessionDetails>, @@ -10327,13 +10425,6 @@ impl<F: Clone> OperationSessionGetters<F> for PaymentCaptureData<F> { Some(&self.payment_attempt) } - fn get_all_keys_required(&self) -> Option<bool> { - todo!(); - } - - fn get_whole_connector_response(&self) -> Option<String> { - todo!(); - } fn get_pre_routing_result( &self, ) -> Option<HashMap<enums::PaymentMethodType, domain::PreRoutingConnectorChoice>> { @@ -10453,6 +10544,10 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentCaptureData<F> { todo!() } + fn set_connector_response_reference_id(&mut self, reference_id: Option<String>) { + todo!() + } + fn set_vault_session_details( &mut self, external_vault_session_details: Option<api::VaultSessionDetails>, @@ -10614,13 +10709,6 @@ impl<F: Clone> OperationSessionGetters<F> for PaymentAttemptListData<F> { todo!() } - fn get_all_keys_required(&self) -> Option<bool> { - todo!(); - } - - fn get_whole_connector_response(&self) -> Option<String> { - todo!(); - } fn get_pre_routing_result( &self, ) -> Option<HashMap<enums::PaymentMethodType, domain::PreRoutingConnectorChoice>> { diff --git a/crates/router/src/core/payments/flows.rs b/crates/router/src/core/payments/flows.rs index 2b681202743..5cc7cfa777e 100644 --- a/crates/router/src/core/payments/flows.rs +++ b/crates/router/src/core/payments/flows.rs @@ -78,7 +78,7 @@ pub trait Feature<F, T> { connector_request: Option<services::Request>, business_profile: &domain::Profile, header_payload: hyperswitch_domain_models::payments::HeaderPayload, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> where Self: Sized, @@ -182,6 +182,22 @@ pub trait Feature<F, T> { &mut self, _state: &SessionState, _connector: &api::ConnectorData, + _should_continue_payment: bool, + ) -> RouterResult<types::CreateOrderResult> + where + F: Clone, + Self: Sized, + dyn api::Connector: services::ConnectorIntegration<F, T, types::PaymentsResponseData>, + { + Ok(types::CreateOrderResult { + create_order_result: Ok(None), + is_create_order_performed: false, + }) + } + + async fn update_router_data_with_create_order_result( + &mut self, + _create_order_result: types::CreateOrderResult, should_continue_payment: bool, ) -> RouterResult<bool> where diff --git a/crates/router/src/core/payments/flows/approve_flow.rs b/crates/router/src/core/payments/flows/approve_flow.rs index 30b7b834f5a..e2f671d914b 100644 --- a/crates/router/src/core/payments/flows/approve_flow.rs +++ b/crates/router/src/core/payments/flows/approve_flow.rs @@ -80,7 +80,7 @@ impl Feature<api::Approve, types::PaymentsApproveData> _connector_request: Option<services::Request>, _business_profile: &domain::Profile, _header_payload: hyperswitch_domain_models::payments::HeaderPayload, - _all_keys_required: Option<bool>, + _return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { Err(ApiErrorResponse::NotImplemented { message: NotImplementedMessage::Reason("Flow not supported".to_string()), diff --git a/crates/router/src/core/payments/flows/authorize_flow.rs b/crates/router/src/core/payments/flows/authorize_flow.rs index ace3588c229..4df6ae9fe91 100644 --- a/crates/router/src/core/payments/flows/authorize_flow.rs +++ b/crates/router/src/core/payments/flows/authorize_flow.rs @@ -171,7 +171,7 @@ impl Feature<api::Authorize, types::PaymentsAuthorizeData> for types::PaymentsAu connector_request: Option<services::Request>, business_profile: &domain::Profile, header_payload: hyperswitch_domain_models::payments::HeaderPayload, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { let connector_integration: services::BoxedPaymentConnectorIntegrationInterface< api::Authorize, @@ -188,7 +188,7 @@ impl Feature<api::Authorize, types::PaymentsAuthorizeData> for types::PaymentsAu &self, call_connector_action.clone(), connector_request, - all_keys_required, + return_raw_connector_response, ) .await .to_payment_failed_response()?; @@ -422,17 +422,92 @@ impl Feature<api::Authorize, types::PaymentsAuthorizeData> for types::PaymentsAu state: &SessionState, connector: &api::ConnectorData, should_continue_payment: bool, - ) -> RouterResult<bool> { - let create_order_result = - create_order_at_connector(self, state, connector, should_continue_payment).await?; + ) -> RouterResult<types::CreateOrderResult> { + if connector + .connector_name + .requires_order_creation_before_payment(self.payment_method) + && should_continue_payment + { + let connector_integration: services::BoxedPaymentConnectorIntegrationInterface< + api::CreateOrder, + types::CreateOrderRequestData, + types::PaymentsResponseData, + > = connector.connector.get_connector_integration(); + + let request_data = types::CreateOrderRequestData::try_from(self.request.clone())?; + + let response_data: Result<types::PaymentsResponseData, types::ErrorResponse> = + Err(types::ErrorResponse::default()); + + let createorder_router_data = + helpers::router_data_type_conversion::<_, api::CreateOrder, _, _, _, _>( + self.clone(), + request_data, + response_data, + ); - let should_continue_payment = update_router_data_with_create_order_result( - create_order_result, - self, - should_continue_payment, - )?; + let resp = services::execute_connector_processing_step( + state, + connector_integration, + &createorder_router_data, + payments::CallConnectorAction::Trigger, + None, + None, + ) + .await + .to_payment_failed_response()?; + + let create_order_resp = match resp.response { + Ok(res) => { + if let types::PaymentsResponseData::PaymentsCreateOrderResponse { order_id } = + res + { + Ok(Some(order_id)) + } else { + Err(error_stack::report!(ApiErrorResponse::InternalServerError) + .attach_printable(format!( + "Unexpected response format from connector: {res:?}", + )))? + } + } + Err(error) => Err(error), + }; + + Ok(types::CreateOrderResult { + create_order_result: create_order_resp, + is_create_order_performed: true, + }) + } else { + Ok(types::CreateOrderResult { + create_order_result: Ok(None), + is_create_order_performed: false, + }) + } + } - Ok(should_continue_payment) + async fn update_router_data_with_create_order_result( + &mut self, + create_order_result: types::CreateOrderResult, + should_continue_further: bool, + ) -> RouterResult<bool> { + if create_order_result.is_create_order_performed { + match create_order_result.create_order_result { + Ok(Some(order_id)) => { + self.request.order_id = Some(order_id.clone()); + self.response = + Ok(types::PaymentsResponseData::PaymentsCreateOrderResponse { order_id }); + Ok(true) + } + Ok(None) => Err(error_stack::report!(ApiErrorResponse::InternalServerError) + .attach_printable("Order Id not found."))?, + Err(err) => { + self.response = Err(err.clone()); + Ok(false) + } + } + } else { + Ok(should_continue_further) + } } } @@ -719,102 +794,3 @@ async fn process_capture_flow( router_data.response = Ok(updated_response); Ok(router_data) } - -async fn create_order_at_connector<F: Clone>( - router_data: &mut types::RouterData< - F, - types::PaymentsAuthorizeData, - types::PaymentsResponseData, - >, - state: &SessionState, - connector: &api::ConnectorData, - should_continue_payment: bool, -) -> RouterResult<types::CreateOrderResult> { - if connector - .connector_name - .requires_order_creation_before_payment(router_data.payment_method) - && should_continue_payment - { - let connector_integration: services::BoxedPaymentConnectorIntegrationInterface< - api::CreateOrder, - types::CreateOrderRequestData, - types::PaymentsResponseData, - > = connector.connector.get_connector_integration(); - - let request_data = types::CreateOrderRequestData::try_from(router_data.request.clone())?; - - let response_data: Result<types::PaymentsResponseData, types::ErrorResponse> = - Err(types::ErrorResponse::default()); - - let createorder_router_data = - helpers::router_data_type_conversion::<_, api::CreateOrder, _, _, _, _>( - router_data.clone(), - request_data, - response_data, - ); - - let resp = services::execute_connector_processing_step( - state, - connector_integration, - &createorder_router_data, - payments::CallConnectorAction::Trigger, - None, - None, - ) - .await - .to_payment_failed_response()?; - - let create_order_resp = match resp.response { - Ok(res) => { - if let types::PaymentsResponseData::PaymentsCreateOrderResponse { order_id } = res { - Ok(Some(order_id)) - } else { - Err(error_stack::report!(ApiErrorResponse::InternalServerError) - .attach_printable(format!( - "Unexpected response format from connector: {res:?}", - )))? - } - } - Err(error) => Err(error), - }; - - Ok(types::CreateOrderResult { - create_order_result: create_order_resp, - is_create_order_performed: true, - }) - } else { - Ok(types::CreateOrderResult { - create_order_result: Ok(None), - is_create_order_performed: false, - }) - } -} - -fn update_router_data_with_create_order_result<F>( - create_order_result: types::CreateOrderResult, - router_data: &mut types::RouterData< - F, - types::PaymentsAuthorizeData, - types::PaymentsResponseData, - >, - should_continue_further: bool, -) -> RouterResult<bool> { - if create_order_result.is_create_order_performed { - match create_order_result.create_order_result { - Ok(Some(order_id)) => { - router_data.request.order_id = Some(order_id.clone()); - router_data.response = - Ok(types::PaymentsResponseData::PaymentsCreateOrderResponse { order_id }); - Ok(true) - } - Ok(None) => Err(error_stack::report!(ApiErrorResponse::InternalServerError) - .attach_printable("Order Id not found."))?, - Err(err) => { - router_data.response = Err(err.clone()); - Ok(false) - } - } - } else { - Ok(should_continue_further) - } -} diff --git a/crates/router/src/core/payments/flows/cancel_flow.rs b/crates/router/src/core/payments/flows/cancel_flow.rs index fc27a600421..046213dbe52 100644 --- a/crates/router/src/core/payments/flows/cancel_flow.rs +++ b/crates/router/src/core/payments/flows/cancel_flow.rs @@ -79,7 +79,7 @@ impl Feature<api::Void, types::PaymentsCancelData> connector_request: Option<services::Request>, _business_profile: &domain::Profile, _header_payload: hyperswitch_domain_models::payments::HeaderPayload, - _all_keys_required: Option<bool>, + _return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { metrics::PAYMENT_CANCEL_COUNT.add( 1, diff --git a/crates/router/src/core/payments/flows/capture_flow.rs b/crates/router/src/core/payments/flows/capture_flow.rs index 545b3fc2631..09d60db9a48 100644 --- a/crates/router/src/core/payments/flows/capture_flow.rs +++ b/crates/router/src/core/payments/flows/capture_flow.rs @@ -108,7 +108,7 @@ impl Feature<api::Capture, types::PaymentsCaptureData> connector_request: Option<services::Request>, _business_profile: &domain::Profile, _header_payload: hyperswitch_domain_models::payments::HeaderPayload, - _all_keys_required: Option<bool>, + _return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { let connector_integration: services::BoxedPaymentConnectorIntegrationInterface< api::Capture, diff --git a/crates/router/src/core/payments/flows/complete_authorize_flow.rs b/crates/router/src/core/payments/flows/complete_authorize_flow.rs index 4fb4e7574a4..d734f195cec 100644 --- a/crates/router/src/core/payments/flows/complete_authorize_flow.rs +++ b/crates/router/src/core/payments/flows/complete_authorize_flow.rs @@ -100,7 +100,7 @@ impl Feature<api::CompleteAuthorize, types::CompleteAuthorizeData> connector_request: Option<services::Request>, business_profile: &domain::Profile, header_payload: hyperswitch_domain_models::payments::HeaderPayload, - _all_keys_required: Option<bool>, + _return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { let connector_integration: services::BoxedPaymentConnectorIntegrationInterface< api::CompleteAuthorize, diff --git a/crates/router/src/core/payments/flows/incremental_authorization_flow.rs b/crates/router/src/core/payments/flows/incremental_authorization_flow.rs index 092be332191..c7dee2ad9e8 100644 --- a/crates/router/src/core/payments/flows/incremental_authorization_flow.rs +++ b/crates/router/src/core/payments/flows/incremental_authorization_flow.rs @@ -87,7 +87,7 @@ impl Feature<api::IncrementalAuthorization, types::PaymentsIncrementalAuthorizat connector_request: Option<services::Request>, _business_profile: &domain::Profile, _header_payload: hyperswitch_domain_models::payments::HeaderPayload, - _all_keys_required: Option<bool>, + _return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { let connector_integration: services::BoxedPaymentConnectorIntegrationInterface< api::IncrementalAuthorization, diff --git a/crates/router/src/core/payments/flows/post_session_tokens_flow.rs b/crates/router/src/core/payments/flows/post_session_tokens_flow.rs index e29739cf01b..118dd17a10a 100644 --- a/crates/router/src/core/payments/flows/post_session_tokens_flow.rs +++ b/crates/router/src/core/payments/flows/post_session_tokens_flow.rs @@ -87,7 +87,7 @@ impl Feature<api::PostSessionTokens, types::PaymentsPostSessionTokensData> connector_request: Option<services::Request>, _business_profile: &domain::Profile, _header_payload: hyperswitch_domain_models::payments::HeaderPayload, - _all_keys_required: Option<bool>, + _return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { let connector_integration: services::BoxedPaymentConnectorIntegrationInterface< api::PostSessionTokens, diff --git a/crates/router/src/core/payments/flows/psync_flow.rs b/crates/router/src/core/payments/flows/psync_flow.rs index 38fc08a1df1..87536525beb 100644 --- a/crates/router/src/core/payments/flows/psync_flow.rs +++ b/crates/router/src/core/payments/flows/psync_flow.rs @@ -111,7 +111,7 @@ impl Feature<api::PSync, types::PaymentsSyncData> connector_request: Option<services::Request>, _business_profile: &domain::Profile, _header_payload: hyperswitch_domain_models::payments::HeaderPayload, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { let connector_integration: services::BoxedPaymentConnectorIntegrationInterface< api::PSync, @@ -134,7 +134,7 @@ impl Feature<api::PSync, types::PaymentsSyncData> pending_connector_capture_id_list, call_connector_action, connector_integration, - all_keys_required, + return_raw_connector_response, ) .await?; // Initiating Integrity checks @@ -156,7 +156,7 @@ impl Feature<api::PSync, types::PaymentsSyncData> &self, call_connector_action, connector_request, - all_keys_required, + return_raw_connector_response, ) .await .to_payment_failed_response()?; @@ -241,7 +241,7 @@ where types::PaymentsSyncData, types::PaymentsResponseData, >, - _all_keys_required: Option<bool>, + _return_raw_connector_response: Option<bool>, ) -> RouterResult<Self>; } @@ -259,7 +259,7 @@ impl RouterDataPSync types::PaymentsSyncData, types::PaymentsResponseData, >, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { let mut capture_sync_response_map = HashMap::new(); if let payments::CallConnectorAction::HandleResponse(_) = call_connector_action { @@ -270,7 +270,7 @@ impl RouterDataPSync self, call_connector_action.clone(), None, - all_keys_required, + return_raw_connector_response, ) .await .to_payment_failed_response()?; @@ -289,7 +289,7 @@ impl RouterDataPSync &cloned_router_data, call_connector_action.clone(), None, - all_keys_required, + return_raw_connector_response, ) .await .to_payment_failed_response()?; diff --git a/crates/router/src/core/payments/flows/reject_flow.rs b/crates/router/src/core/payments/flows/reject_flow.rs index 852058dc377..efb34be54b3 100644 --- a/crates/router/src/core/payments/flows/reject_flow.rs +++ b/crates/router/src/core/payments/flows/reject_flow.rs @@ -79,7 +79,7 @@ impl Feature<api::Reject, types::PaymentsRejectData> _connector_request: Option<services::Request>, _business_profile: &domain::Profile, _header_payload: hyperswitch_domain_models::payments::HeaderPayload, - _all_keys_required: Option<bool>, + _return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { Err(ApiErrorResponse::NotImplemented { message: NotImplementedMessage::Reason("Flow not supported".to_string()), diff --git a/crates/router/src/core/payments/flows/session_flow.rs b/crates/router/src/core/payments/flows/session_flow.rs index a805f455b4b..ae0450f28f0 100644 --- a/crates/router/src/core/payments/flows/session_flow.rs +++ b/crates/router/src/core/payments/flows/session_flow.rs @@ -121,7 +121,7 @@ impl Feature<api::Session, types::PaymentsSessionData> for types::PaymentsSessio _connector_request: Option<services::Request>, business_profile: &domain::Profile, header_payload: hyperswitch_domain_models::payments::HeaderPayload, - _all_keys_required: Option<bool>, + _return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { metrics::SESSION_TOKEN_CREATED.add( 1, diff --git a/crates/router/src/core/payments/flows/session_update_flow.rs b/crates/router/src/core/payments/flows/session_update_flow.rs index e717ff50c26..cd42f855c11 100644 --- a/crates/router/src/core/payments/flows/session_update_flow.rs +++ b/crates/router/src/core/payments/flows/session_update_flow.rs @@ -87,7 +87,7 @@ impl Feature<api::SdkSessionUpdate, types::SdkPaymentsSessionUpdateData> connector_request: Option<services::Request>, _business_profile: &domain::Profile, _header_payload: hyperswitch_domain_models::payments::HeaderPayload, - _all_keys_required: Option<bool>, + _return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { let connector_integration: services::BoxedPaymentConnectorIntegrationInterface< api::SdkSessionUpdate, diff --git a/crates/router/src/core/payments/flows/setup_mandate_flow.rs b/crates/router/src/core/payments/flows/setup_mandate_flow.rs index a5bcdb4f55e..f99d13bd312 100644 --- a/crates/router/src/core/payments/flows/setup_mandate_flow.rs +++ b/crates/router/src/core/payments/flows/setup_mandate_flow.rs @@ -117,7 +117,7 @@ impl Feature<api::SetupMandate, types::SetupMandateRequestData> for types::Setup connector_request: Option<services::Request>, _business_profile: &domain::Profile, _header_payload: hyperswitch_domain_models::payments::HeaderPayload, - _all_keys_required: Option<bool>, + _return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { let connector_integration: services::BoxedPaymentConnectorIntegrationInterface< api::SetupMandate, diff --git a/crates/router/src/core/payments/flows/update_metadata_flow.rs b/crates/router/src/core/payments/flows/update_metadata_flow.rs index a6a35833255..f654b7ead13 100644 --- a/crates/router/src/core/payments/flows/update_metadata_flow.rs +++ b/crates/router/src/core/payments/flows/update_metadata_flow.rs @@ -86,7 +86,7 @@ impl Feature<api::UpdateMetadata, types::PaymentsUpdateMetadataData> connector_request: Option<services::Request>, _business_profile: &domain::Profile, _header_payload: hyperswitch_domain_models::payments::HeaderPayload, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { let connector_integration: services::BoxedPaymentConnectorIntegrationInterface< api::UpdateMetadata, @@ -100,7 +100,7 @@ impl Feature<api::UpdateMetadata, types::PaymentsUpdateMetadataData> &self, call_connector_action, connector_request, - all_keys_required, + return_raw_connector_response, ) .await .to_payment_failed_response()?; diff --git a/crates/router/src/core/payments/helpers.rs b/crates/router/src/core/payments/helpers.rs index 4b7791bb084..5eaee11c18a 100644 --- a/crates/router/src/core/payments/helpers.rs +++ b/crates/router/src/core/payments/helpers.rs @@ -4175,7 +4175,7 @@ pub fn router_data_type_conversion<F1, F2, Req1, Req2, Res1, Res2>( connector_mandate_request_reference_id: router_data.connector_mandate_request_reference_id, authentication_id: router_data.authentication_id, psd2_sca_exemption_type: router_data.psd2_sca_exemption_type, - whole_connector_response: router_data.whole_connector_response, + raw_connector_response: router_data.raw_connector_response, } } diff --git a/crates/router/src/core/payments/operations/payment_confirm_intent.rs b/crates/router/src/core/payments/operations/payment_confirm_intent.rs index dce33895fde..8ab7ddcfa28 100644 --- a/crates/router/src/core/payments/operations/payment_confirm_intent.rs +++ b/crates/router/src/core/payments/operations/payment_confirm_intent.rs @@ -588,6 +588,11 @@ impl<F: Clone + Sync> UpdateTracker<F, PaymentConfirmData<F>, PaymentsConfirmInt .connector_request_reference_id .clone(); + let connector_response_reference_id = payment_data + .payment_attempt + .connector_response_reference_id + .clone(); + let payment_attempt_update = match &payment_data.payment_method { // In the case of a tokenized payment method, we update the payment attempt with the tokenized payment method details. Some(payment_method) => { @@ -611,6 +616,7 @@ impl<F: Clone + Sync> UpdateTracker<F, PaymentConfirmData<F>, PaymentsConfirmInt merchant_connector_id, authentication_type, connector_request_reference_id, + connector_response_reference_id, } } }; diff --git a/crates/router/src/core/payments/operations/payment_response.rs b/crates/router/src/core/payments/operations/payment_response.rs index ff618a7b349..939679ef51f 100644 --- a/crates/router/src/core/payments/operations/payment_response.rs +++ b/crates/router/src/core/payments/operations/payment_response.rs @@ -1412,7 +1412,7 @@ async fn payment_response_update_tracker<F: Clone, T: types::Capturable>( .as_mut() .map(|info| info.status = status) }); - payment_data.whole_connector_response = router_data.whole_connector_response.clone(); + payment_data.whole_connector_response = router_data.raw_connector_response.clone(); // TODO: refactor of gsm_error_category with respective feature flag #[allow(unused_variables)] diff --git a/crates/router/src/core/payments/operations/proxy_payments_intent.rs b/crates/router/src/core/payments/operations/proxy_payments_intent.rs index a65f4cdd99e..30ea6913c6d 100644 --- a/crates/router/src/core/payments/operations/proxy_payments_intent.rs +++ b/crates/router/src/core/payments/operations/proxy_payments_intent.rs @@ -409,6 +409,11 @@ impl<F: Clone + Sync> UpdateTracker<F, PaymentConfirmData<F>, ProxyPaymentsReque .connector_request_reference_id .clone(); + let connector_response_reference_id = payment_data + .payment_attempt + .connector_response_reference_id + .clone(); + let payment_attempt_update = hyperswitch_domain_models::payments::payment_attempt::PaymentAttemptUpdate::ConfirmIntent { status: attempt_status, updated_by: storage_scheme.to_string(), @@ -416,6 +421,7 @@ impl<F: Clone + Sync> UpdateTracker<F, PaymentConfirmData<F>, ProxyPaymentsReque merchant_connector_id, authentication_type, connector_request_reference_id, + connector_response_reference_id, }; let updated_payment_intent = db diff --git a/crates/router/src/core/payments/transformers.rs b/crates/router/src/core/payments/transformers.rs index 636b1da0bbc..71ff92b0bb2 100644 --- a/crates/router/src/core/payments/transformers.rs +++ b/crates/router/src/core/payments/transformers.rs @@ -171,7 +171,7 @@ where connector_mandate_request_reference_id, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) } @@ -399,7 +399,7 @@ pub async fn construct_payment_router_data_for_authorize<'a>( connector_mandate_request_reference_id, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) @@ -563,7 +563,7 @@ pub async fn construct_payment_router_data_for_capture<'a>( connector_mandate_request_reference_id, psd2_sca_exemption_type: None, authentication_id: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) @@ -626,6 +626,7 @@ pub async fn construct_router_data_for_psync<'a>( // TODO: Get the charges object from feature metadata split_payments: None, payment_experience: None, + connector_reference_id: attempt.connector_response_reference_id.clone(), }; // TODO: evaluate the fields in router data, if they are required or not @@ -689,7 +690,7 @@ pub async fn construct_router_data_for_psync<'a>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) @@ -871,7 +872,7 @@ pub async fn construct_payment_router_data_for_sdk_session<'a>( connector_mandate_request_reference_id: None, psd2_sca_exemption_type: None, authentication_id: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) @@ -1088,7 +1089,7 @@ pub async fn construct_payment_router_data_for_setup_mandate<'a>( connector_mandate_request_reference_id, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) @@ -1287,7 +1288,7 @@ where connector_mandate_request_reference_id, authentication_id: None, psd2_sca_exemption_type: payment_data.payment_intent.psd2_sca_exemption_type, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) @@ -1477,7 +1478,7 @@ pub async fn construct_payment_router_data_for_update_metadata<'a>( connector_mandate_request_reference_id, authentication_id: None, psd2_sca_exemption_type: payment_data.payment_intent.psd2_sca_exemption_type, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) @@ -1524,6 +1525,7 @@ where Self: Sized, { #[cfg(feature = "v2")] + #[allow(clippy::too_many_arguments)] fn generate_response( self, state: &SessionState, @@ -1532,6 +1534,7 @@ where is_latency_header_enabled: Option<bool>, merchant_context: &domain::MerchantContext, profile: &domain::Profile, + connector_response_data: Option<common_types::domain::ConnectorResponseData>, ) -> RouterResponse<Response>; } @@ -1549,6 +1552,7 @@ where is_latency_header_enabled: Option<bool>, merchant_context: &domain::MerchantContext, profile: &domain::Profile, + _connector_response_data: Option<common_types::domain::ConnectorResponseData>, ) -> RouterResponse<api_models::payments::PaymentsCaptureResponse> { let payment_intent = &self.payment_intent; let payment_attempt = &self.payment_attempt; @@ -1872,6 +1876,7 @@ where is_latency_header_enabled: Option<bool>, merchant_context: &domain::MerchantContext, profile: &domain::Profile, + connector_response_data: Option<common_types::domain::ConnectorResponseData>, ) -> RouterResponse<api_models::payments::PaymentsResponse> { let payment_intent = self.payment_intent; let payment_attempt = self.payment_attempt; @@ -1897,6 +1902,9 @@ where let payment_address = self.payment_address; + let raw_connector_response = + connector_response_data.and_then(|data| data.raw_connector_response); + let payment_method_data = Some(api_models::payments::PaymentMethodDataResponseWithBilling { payment_method_data: None, @@ -1951,7 +1959,7 @@ where payment_method_subtype: Some(payment_attempt.payment_method_subtype), next_action, connector_transaction_id: payment_attempt.connector_payment_id.clone(), - connector_reference_id: None, + connector_reference_id: payment_attempt.connector_response_reference_id.clone(), connector_token_details, merchant_connector_id, browser_info: None, @@ -1965,6 +1973,7 @@ where shipping: None, //TODO: add this is_iframe_redirection_enabled: None, merchant_reference_id: payment_intent.merchant_reference_id.clone(), + raw_connector_response, }; Ok(services::ApplicationResponse::JsonWithHeaders(( @@ -1988,6 +1997,7 @@ where is_latency_header_enabled: Option<bool>, merchant_context: &domain::MerchantContext, profile: &domain::Profile, + connector_response_data: Option<common_types::domain::ConnectorResponseData>, ) -> RouterResponse<api_models::payments::PaymentsResponse> { let payment_intent = self.payment_intent; let payment_attempt = &self.payment_attempt; @@ -2022,6 +2032,9 @@ where .map(From::from), }); + let raw_connector_response = + connector_response_data.and_then(|data| data.raw_connector_response); + let connector_token_details = self .payment_attempt .connector_token_details @@ -2047,7 +2060,7 @@ where payment_method_type: Some(payment_attempt.payment_method_type), payment_method_subtype: Some(payment_attempt.payment_method_subtype), connector_transaction_id: payment_attempt.connector_payment_id.clone(), - connector_reference_id: None, + connector_reference_id: payment_attempt.connector_response_reference_id.clone(), merchant_connector_id, browser_info: None, connector_token_details, @@ -2060,6 +2073,7 @@ where return_url, is_iframe_redirection_enabled: payment_intent.is_iframe_redirection_enabled, merchant_reference_id: payment_intent.merchant_reference_id.clone(), + raw_connector_response, }; Ok(services::ApplicationResponse::JsonWithHeaders(( @@ -2083,6 +2097,7 @@ where _is_latency_header_enabled: Option<bool>, _merchant_context: &domain::MerchantContext, _profile: &domain::Profile, + _connector_response_data: Option<common_types::domain::ConnectorResponseData>, ) -> RouterResponse<api_models::payments::PaymentAttemptResponse> { let payment_attempt = self.payment_attempt; let response = api_models::payments::PaymentAttemptResponse::foreign_from(&payment_attempt); @@ -2107,6 +2122,7 @@ where _is_latency_header_enabled: Option<bool>, _merchant_context: &domain::MerchantContext, _profile: &domain::Profile, + _connector_response_data: Option<common_types::domain::ConnectorResponseData>, ) -> RouterResponse<api_models::payments::PaymentAttemptRecordResponse> { let payment_attempt = self.payment_attempt; let payment_intent = self.payment_intent; @@ -3718,6 +3734,10 @@ impl<F: Clone> TryFrom<PaymentAdditionalData<'_, F>> for types::PaymentsSyncData currency: payment_data.currency, split_payments: payment_data.payment_intent.split_payments, payment_experience: payment_data.payment_attempt.payment_experience, + connector_reference_id: payment_data + .payment_attempt + .connector_response_reference_id + .clone(), }) } } diff --git a/crates/router/src/core/relay/utils.rs b/crates/router/src/core/relay/utils.rs index effc2178ec3..1adacfbe949 100644 --- a/crates/router/src/core/relay/utils.rs +++ b/crates/router/src/core/relay/utils.rs @@ -143,7 +143,7 @@ pub async fn construct_relay_refund_router_data<F>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) diff --git a/crates/router/src/core/revenue_recovery/api.rs b/crates/router/src/core/revenue_recovery/api.rs index 3627d5062c6..052f4351c7e 100644 --- a/crates/router/src/core/revenue_recovery/api.rs +++ b/crates/router/src/core/revenue_recovery/api.rs @@ -31,7 +31,7 @@ pub async fn call_psync_api( force_sync: false, param: None, expand_attempts: true, - all_keys_required: None, + return_raw_connector_response: None, merchant_connector_details: None, }; let merchant_context_from_revenue_recovery_data = @@ -53,7 +53,7 @@ pub async fn call_psync_api( ) .await?; - let (payment_data, _req, _, _, _) = Box::pin(payments::payments_operation_core::< + let (payment_data, _req, _, _, _, _) = Box::pin(payments::payments_operation_core::< api_types::PSync, _, _, diff --git a/crates/router/src/core/unified_authentication_service/utils.rs b/crates/router/src/core/unified_authentication_service/utils.rs index 6c841a02d31..20ac12a9940 100644 --- a/crates/router/src/core/unified_authentication_service/utils.rs +++ b/crates/router/src/core/unified_authentication_service/utils.rs @@ -124,7 +124,7 @@ pub fn construct_uas_router_data<F: Clone, Req, Res>( connector_mandate_request_reference_id: None, authentication_id, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }) } diff --git a/crates/router/src/core/utils.rs b/crates/router/src/core/utils.rs index d1d298bd17b..c097b3fbfe6 100644 --- a/crates/router/src/core/utils.rs +++ b/crates/router/src/core/utils.rs @@ -234,7 +234,7 @@ pub async fn construct_payout_router_data<'a, F>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) @@ -401,7 +401,7 @@ pub async fn construct_refund_router_data<'a, F>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) @@ -604,7 +604,7 @@ pub async fn construct_refund_router_data<'a, F>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) @@ -1028,7 +1028,7 @@ pub async fn construct_accept_dispute_router_data<'a>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) } @@ -1126,7 +1126,7 @@ pub async fn construct_submit_evidence_router_data<'a>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) } @@ -1230,7 +1230,7 @@ pub async fn construct_upload_file_router_data<'a>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) } @@ -1353,7 +1353,7 @@ pub async fn construct_payments_dynamic_tax_calculation_router_data<F: Clone>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) } @@ -1454,7 +1454,7 @@ pub async fn construct_defend_dispute_router_data<'a>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) } @@ -1549,7 +1549,7 @@ pub async fn construct_retrieve_file_router_data<'a>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) } diff --git a/crates/router/src/core/webhooks/incoming_v2.rs b/crates/router/src/core/webhooks/incoming_v2.rs index 0cf8b2bfe7b..464781876cf 100644 --- a/crates/router/src/core/webhooks/incoming_v2.rs +++ b/crates/router/src/core/webhooks/incoming_v2.rs @@ -456,31 +456,37 @@ async fn payments_incoming_webhook_flow( ) .await?; - let (payment_data, _req, customer, connector_http_status_code, external_latency) = - Box::pin(payments::payments_operation_core::< - api::PSync, - _, - _, - _, - PaymentStatusData<api::PSync>, - >( - &state, - req_state, - merchant_context.clone(), - &profile, - payments::operations::PaymentGet, - api::PaymentsRetrieveRequest { - force_sync: true, - expand_attempts: false, - param: None, - all_keys_required: None, - merchant_connector_details: None, - }, - get_trackers_response, - consume_or_trigger_flow, - HeaderPayload::default(), - )) - .await?; + let ( + payment_data, + _req, + customer, + connector_http_status_code, + external_latency, + connector_response_data, + ) = Box::pin(payments::payments_operation_core::< + api::PSync, + _, + _, + _, + PaymentStatusData<api::PSync>, + >( + &state, + req_state, + merchant_context.clone(), + &profile, + payments::operations::PaymentGet, + api::PaymentsRetrieveRequest { + force_sync: true, + expand_attempts: false, + param: None, + return_raw_connector_response: None, + merchant_connector_details: None, + }, + get_trackers_response, + consume_or_trigger_flow, + HeaderPayload::default(), + )) + .await?; let response = payment_data.generate_response( &state, @@ -489,6 +495,7 @@ async fn payments_incoming_webhook_flow( None, &merchant_context, &profile, + Some(connector_response_data), ); lock_action diff --git a/crates/router/src/core/webhooks/utils.rs b/crates/router/src/core/webhooks/utils.rs index 4cf0d784a05..c0c362a9dd3 100644 --- a/crates/router/src/core/webhooks/utils.rs +++ b/crates/router/src/core/webhooks/utils.rs @@ -133,7 +133,7 @@ pub async fn construct_webhook_router_data( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) } diff --git a/crates/router/src/routes/payments.rs b/crates/router/src/routes/payments.rs index e2363633dad..163bc2dab2e 100644 --- a/crates/router/src/routes/payments.rs +++ b/crates/router/src/routes/payments.rs @@ -2953,7 +2953,7 @@ pub async fn payment_status( force_sync: payload.force_sync, expand_attempts: payload.expand_attempts, param: payload.param.clone(), - all_keys_required: payload.all_keys_required, + return_raw_connector_response: payload.return_raw_connector_response, merchant_connector_details: None, }; diff --git a/crates/router/src/services/api.rs b/crates/router/src/services/api.rs index 57bb8ec2427..fabfe3e38d2 100644 --- a/crates/router/src/services/api.rs +++ b/crates/router/src/services/api.rs @@ -142,7 +142,7 @@ pub async fn execute_connector_processing_step< req: &'b types::RouterData<T, Req, Resp>, call_connector_action: payments::CallConnectorAction, connector_request: Option<Request>, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> CustomResult<types::RouterData<T, Req, Resp>, errors::ConnectorError> where T: Clone + Debug + 'static, @@ -302,7 +302,7 @@ where val + external_latency }), ); - if all_keys_required == Some(true) { + if return_raw_connector_response == Some(true) { let mut decoded = String::from_utf8(body.response.as_ref().to_vec()) .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; if decoded.starts_with('\u{feff}') { @@ -310,7 +310,7 @@ where .trim_start_matches('\u{feff}') .to_string(); } - data.whole_connector_response = Some(decoded); + data.raw_connector_response = Some(decoded); } Ok(data) } @@ -1076,13 +1076,17 @@ pub trait Authenticate { None } - fn get_all_keys_required(&self) -> Option<bool> { + fn should_return_raw_response(&self) -> Option<bool> { None } } #[cfg(feature = "v2")] -impl Authenticate for api_models::payments::PaymentsConfirmIntentRequest {} +impl Authenticate for api_models::payments::PaymentsConfirmIntentRequest { + fn should_return_raw_response(&self) -> Option<bool> { + self.return_raw_connector_response + } +} #[cfg(feature = "v2")] impl Authenticate for api_models::payments::ProxyPaymentsRequest {} @@ -1092,7 +1096,9 @@ impl Authenticate for api_models::payments::PaymentsRequest { self.client_secret.as_ref() } - fn get_all_keys_required(&self) -> Option<bool> { + fn should_return_raw_response(&self) -> Option<bool> { + // In v1, this maps to `all_keys_required` to retain backward compatibility. + // The equivalent field in v2 is `return_raw_connector_response`. self.all_keys_required } } @@ -1123,7 +1129,15 @@ impl Authenticate for api_models::payments::PaymentsPostSessionTokensRequest { impl Authenticate for api_models::payments::PaymentsUpdateMetadataRequest {} impl Authenticate for api_models::payments::PaymentsRetrieveRequest { - fn get_all_keys_required(&self) -> Option<bool> { + #[cfg(feature = "v2")] + fn should_return_raw_response(&self) -> Option<bool> { + self.return_raw_connector_response + } + + #[cfg(feature = "v1")] + fn should_return_raw_response(&self) -> Option<bool> { + // In v1, this maps to `all_keys_required` to retain backward compatibility. + // The equivalent field in v2 is `return_raw_connector_response`. self.all_keys_required } } diff --git a/crates/router/src/types.rs b/crates/router/src/types.rs index 52e3f267c84..dd64c5b3703 100644 --- a/crates/router/src/types.rs +++ b/crates/router/src/types.rs @@ -1151,7 +1151,7 @@ impl<F1, F2, T1, T2> ForeignFrom<(&RouterData<F1, T1, PaymentsResponseData>, T2) .clone(), authentication_id: data.authentication_id.clone(), psd2_sca_exemption_type: data.psd2_sca_exemption_type, - whole_connector_response: data.whole_connector_response.clone(), + raw_connector_response: data.raw_connector_response.clone(), } } } @@ -1219,7 +1219,7 @@ impl<F1, F2> psd2_sca_exemption_type: None, additional_merchant_data: data.additional_merchant_data.clone(), connector_mandate_request_reference_id: None, - whole_connector_response: None, + raw_connector_response: None, } } } diff --git a/crates/router/src/types/api/payments.rs b/crates/router/src/types/api/payments.rs index 62738680b1b..02fad384f59 100644 --- a/crates/router/src/types/api/payments.rs +++ b/crates/router/src/types/api/payments.rs @@ -5,7 +5,8 @@ pub use api_models::payments::{ }; #[cfg(feature = "v1")] pub use api_models::payments::{ - PaymentListFilterConstraints, PaymentListResponse, PaymentListResponseV2, + PaymentListFilterConstraints, PaymentListResponse, PaymentListResponseV2, PaymentRetrieveBody, + PaymentRetrieveBodyWithCredentials, }; pub use api_models::{ feature_matrix::{ @@ -18,18 +19,17 @@ pub use api_models::{ MandateValidationFields, NextActionType, OpenBankingSessionToken, PayLaterData, PaymentIdType, PaymentListConstraints, PaymentListFilters, PaymentListFiltersV2, PaymentMethodData, PaymentMethodDataRequest, PaymentMethodDataResponse, PaymentOp, - PaymentRetrieveBody, PaymentRetrieveBodyWithCredentials, PaymentsAggregateResponse, - PaymentsApproveRequest, PaymentsCancelRequest, PaymentsCaptureRequest, - PaymentsCompleteAuthorizeRequest, PaymentsDynamicTaxCalculationRequest, - PaymentsDynamicTaxCalculationResponse, PaymentsExternalAuthenticationRequest, - PaymentsIncrementalAuthorizationRequest, PaymentsManualUpdateRequest, - PaymentsPostSessionTokensRequest, PaymentsPostSessionTokensResponse, - PaymentsRedirectRequest, PaymentsRedirectionResponse, PaymentsRejectRequest, - PaymentsRequest, PaymentsResponse, PaymentsResponseForm, PaymentsRetrieveRequest, - PaymentsSessionRequest, PaymentsSessionResponse, PaymentsStartRequest, - PaymentsUpdateMetadataRequest, PaymentsUpdateMetadataResponse, PgRedirectResponse, - PhoneDetails, RedirectionResponse, SessionToken, UrlDetails, VaultSessionDetails, - VerifyRequest, VerifyResponse, VgsSessionDetails, WalletData, + PaymentsAggregateResponse, PaymentsApproveRequest, PaymentsCancelRequest, + PaymentsCaptureRequest, PaymentsCompleteAuthorizeRequest, + PaymentsDynamicTaxCalculationRequest, PaymentsDynamicTaxCalculationResponse, + PaymentsExternalAuthenticationRequest, PaymentsIncrementalAuthorizationRequest, + PaymentsManualUpdateRequest, PaymentsPostSessionTokensRequest, + PaymentsPostSessionTokensResponse, PaymentsRedirectRequest, PaymentsRedirectionResponse, + PaymentsRejectRequest, PaymentsRequest, PaymentsResponse, PaymentsResponseForm, + PaymentsRetrieveRequest, PaymentsSessionRequest, PaymentsSessionResponse, + PaymentsStartRequest, PaymentsUpdateMetadataRequest, PaymentsUpdateMetadataResponse, + PgRedirectResponse, PhoneDetails, RedirectionResponse, SessionToken, UrlDetails, + VaultSessionDetails, VerifyRequest, VerifyResponse, VgsSessionDetails, WalletData, }, }; pub use common_types::payments::{AcceptanceType, CustomerAcceptance, OnlineMandate}; diff --git a/crates/router/src/types/api/verify_connector.rs b/crates/router/src/types/api/verify_connector.rs index c9be34037cb..8298be10aab 100644 --- a/crates/router/src/types/api/verify_connector.rs +++ b/crates/router/src/types/api/verify_connector.rs @@ -127,7 +127,7 @@ impl VerifyConnectorData { connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, } } } diff --git a/crates/router/tests/connectors/aci.rs b/crates/router/tests/connectors/aci.rs index 61272a05877..cf0889931d8 100644 --- a/crates/router/tests/connectors/aci.rs +++ b/crates/router/tests/connectors/aci.rs @@ -133,7 +133,7 @@ fn construct_payment_router_data() -> types::PaymentsAuthorizeRouterData { connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, } } @@ -206,7 +206,7 @@ fn construct_refund_router_data<F>() -> types::RefundsRouterData<F> { connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, } } diff --git a/crates/router/tests/connectors/utils.rs b/crates/router/tests/connectors/utils.rs index bf9bc355334..db3aeddfb8c 100644 --- a/crates/router/tests/connectors/utils.rs +++ b/crates/router/tests/connectors/utils.rs @@ -553,7 +553,7 @@ pub trait ConnectorActions: Connector { connector_mandate_request_reference_id: None, psd2_sca_exemption_type: None, authentication_id: None, - whole_connector_response: None, + raw_connector_response: None, } }

2025-06-30T11:36:23Z

## Type of Change  - [ ] Bugfix - [ ] New feature - [ ] Enhancement - [x] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  This PR populates raw_connector_response for Payments when return_raw_connector_response is set to True. It also changes Payments Create and Psync endpoint for Razorpay connector. Additional Changes: - Introduces a struct ConnectorResponseData which sends raw_connector_response at core flows instead of it being in PaymentData (changed only in v2) - Rename `all_keys_required` as `return_raw_connector_response`, `get_all_keys_required()` as `should_return_raw_response()` , `whole_connector_response` as `raw_connector_response`. This rename is applied only on v2 Api and core flows to retain backward compatibility at v1. - `get_whole_connector_response()` and `get_all_keys_required()` at OperationSessionGetters are marked under v1 feature - `connector_response_reference_id` is updated in Payment_attempt at both update_trackers and post_update_trackers for v2. This is included in update_trackers in cases where Authorize flow is not performed at Connector End - Also marked this PaymentRetrieveBody, PaymentRetrieveBodyWithCredentials under v1 feature as it is not required in v2 flows ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  ## How did you test it?  - Payments - Create ``` curl --location 'http://localhost:8080/v2/payments' \ --header 'Content-Type: application/json' \ --header 'x-profile-id: pro_L5WeuuGWl0EUYBhEEME1' \ --header 'Authorization: api-key=_' \ --data-raw '{ "amount_details": { "order_amount": 100, "currency": "INR" }, "capture_method":"automatic", "description": "Its my first payment request", "authentication_type": "no_three_ds", "return_url": "https://google.com", "payment_method_data": { "upi": { "upi_collect": { "vpa_id": "success@razorpay" } }, "billing": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "IN", "first_name": "Swangi", "last_name": "Kumari" }, "phone": { "number": "8056594427", "country_code": "+91" }, "email": "[email protected]" } }, "payment_method_subtype": "upi_collect", "payment_method_type": "upi", "return_raw_connector_response": true }' ``` Response ``` { "id": "12345_pay_0197c4e2b8087181963fdaae32be36b3", "status": "requires_customer_action", "amount": { "order_amount": 100, "currency": "INR", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null, "net_amount": 100, "amount_to_capture": null, "amount_capturable": 0, "amount_captured": null }, "customer_id": null, "connector": "razorpay", "created": "2025-07-01T07:28:02.057Z", "payment_method_data": { "billing": { "address": { "city": "San Fransico", "country": "IN", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "Swangi", "last_name": "Kumari" }, "phone": { "number": "8056594427", "country_code": "+91" }, "email": "[email protected]" } }, "payment_method_type": "upi", "payment_method_subtype": "upi_collect", "connector_transaction_id": "pay_Qnik5RSCB4oVjf", "connector_reference_id": "order_Qnik4SrNFCdv8H", "merchant_connector_id": "mca_GWx9LT38SlIQ1qNFfw1p", "browser_info": null, "error": null, "shipping": null, "billing": null, "attempts": null, "connector_token_details": null, "payment_method_id": null, "next_action": { "type": "wait_screen_information", "display_from_timestamp": 1751354885589516000, "display_to_timestamp": 1751355185589516000, "poll_config": { "delay_in_secs": 5, "frequency": 5 } }, "return_url": "https://google.com/", "authentication_type": "no_three_ds", "authentication_type_applied": "no_three_ds", "is_iframe_redirection_enabled": null, "merchant_reference_id": null, "raw_connector_response": "{\"razorpay_payment_id\":\"pay_Qnik5RSCB4oVjf\"}" } ``` - Payments - Retrieve ``` curl --location 'http://localhost:8080/v2/payments/12345_pay_0197c4e2b8087181963fdaae32be36b3?force_sync=true&return_raw_connector_response=true' \ --header 'x-profile-id: pro_L5WeuuGWl0EUYBhEEME1' \ --header 'Authorization: api-key=_' \ --data '' ``` Response ``` { "id": "12345_pay_0197c4e2b8087181963fdaae32be36b3", "status": "requires_capture", "amount": { "order_amount": 100, "currency": "INR", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null, "net_amount": 100, "amount_to_capture": null, "amount_capturable": 100, "amount_captured": 100 }, "customer_id": null, "connector": "razorpay", "created": "2025-07-01T07:36:11.733Z", "payment_method_data": { "billing": { "address": { "city": "San Fransico", "country": "IN", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "Swangi", "last_name": "Kumari" }, "phone": { "number": "8056594427", "country_code": "+91" }, "email": "[email protected]" } }, "payment_method_type": "upi", "payment_method_subtype": "upi_collect", "connector_transaction_id": "pay_Qnik5RSCB4oVjf", "connector_reference_id": "order_Qnik4SrNFCdv8H", "merchant_connector_id": "mca_GWx9LT38SlIQ1qNFfw1p", "browser_info": null, "error": null, "shipping": null, "billing": null, "attempts": null, "connector_token_details": null, "payment_method_id": null, "next_action": null, "return_url": "https://google.com/", "authentication_type": "no_three_ds", "authentication_type_applied": null, "is_iframe_redirection_enabled": null, "merchant_reference_id": null, "raw_connector_response": "{\"entity\":\"collection\",\"count\":1,\"items\":[{\"id\":\"pay_QnishOLxdHvKJ6\",\"entity\":\"payment\",\"amount\":100,\"currency\":\"INR\",\"status\":\"authorized\",\"order_id\":\"order_QnisgYZGQHtI92\",\"invoice_id\":null,\"international\":false,\"method\":\"upi\",\"amount_refunded\":0,\"refund_status\":null,\"captured\":false,\"description\":null,\"card_id\":null,\"bank\":null,\"wallet\":null,\"vpa\":\"success@razorpay\",\"email\":\"[email protected]\",\"contact\":\"+918056594427\",\"notes\":{\"optimizer_provider_name\":\"razorpay\"},\"fee\":null,\"tax\":null,\"error_code\":null,\"error_description\":null,\"error_source\":null,\"error_step\":null,\"error_reason\":null,\"acquirer_data\":{\"rrn\":\"216013077213\",\"upi_transaction_id\":\"614E93092FDA8E2A9FA28264CF769689\"},\"gateway_provider\":\"Razorpay\",\"created_at\":1751355374,\"upi\":{\"vpa\":\"success@razorpay\"}}]}" } ``` ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

c275e13caf22362173e77d2260b440159abcabb3

juspay/hyperswitch

juspay__hyperswitch-8497

Bug: chore: address Rust 1.88.0 clippy lints Address the clippy lints occurring due to new rust version 1.88.0 See https://github.com/juspay/hyperswitch/issues/3391 for more information.

diff --git a/crates/router/src/core/payment_methods/vault.rs b/crates/router/src/core/payment_methods/vault.rs index c59a2f84c35..d5848c7f418 100644 --- a/crates/router/src/core/payment_methods/vault.rs +++ b/crates/router/src/core/payment_methods/vault.rs @@ -1555,10 +1555,7 @@ pub async fn insert_cvc_using_payment_token( .change_context(errors::ApiErrorResponse::InternalServerError) .attach_printable("Failed to get redis connection")?; - let key = format!( - "pm_token_{}_{}_hyperswitch_cvc", - payment_token, payment_method - ); + let key = format!("pm_token_{payment_token}_{payment_method}_hyperswitch_cvc"); let payload_to_be_encrypted = TemporaryVaultCvc { card_cvc }; @@ -1601,10 +1598,7 @@ pub async fn retrieve_and_delete_cvc_from_payment_token( .change_context(errors::ApiErrorResponse::InternalServerError) .attach_printable("Failed to get redis connection")?; - let key = format!( - "pm_token_{}_{}_hyperswitch_cvc", - payment_token, payment_method - ); + let key = format!("pm_token_{payment_token}_{payment_method}_hyperswitch_cvc"); let data = redis_conn .get_key::<bytes::Bytes>(&key.clone().into()) diff --git a/crates/router/src/core/unified_connector_service.rs b/crates/router/src/core/unified_connector_service.rs index d9c00fbadba..3cdcb28d4d8 100644 --- a/crates/router/src/core/unified_connector_service.rs +++ b/crates/router/src/core/unified_connector_service.rs @@ -101,8 +101,7 @@ pub fn build_unified_connector_service_payment_method( } _ => { return Err(UnifiedConnectorServiceError::NotImplemented(format!( - "Unimplemented card payment method type: {:?}", - payment_method_type + "Unimplemented card payment method type: {payment_method_type:?}" )) .into()); }

2025-07-10T13:43:08Z

## Type of Change  - [ ] Bugfix - [ ] New feature - [ ] Enhancement - [x] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  This pull request includes a minor improvement to error message formatting in the `build_unified_connector_service_payment_method` function. * [`crates/router/src/core/unified_connector_service.rs`](diffhunk://#diff-b8e808846f58e455687a9e192c1c8d192598081aac942628640c42c1d397dfaeL104-R104): Updated the error message to use inline formatting for `payment_method_type`, improving readability and consistency. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  ## How did you test it?  ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

1b08de652f6b0f3c08374d0806c8999f4b73ec2f

juspay/hyperswitch

juspay__hyperswitch-8470

Bug: [FEATURE] allow a dummy connector to succeed for a failure card to show smart routing ### Feature Description Objective is to show user how smart retry works ### Possible Implementation stripe_test if the card number is 4000000000009995 previously it was failure with insufficient funds. But now we need to allow it to become success. ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? None

diff --git a/crates/router/src/routes/dummy_connector/utils.rs b/crates/router/src/routes/dummy_connector/utils.rs index 367c3bc63d4..0bec0398193 100644 --- a/crates/router/src/routes/dummy_connector/utils.rs +++ b/crates/router/src/routes/dummy_connector/utils.rs @@ -11,7 +11,10 @@ use super::{ consts, errors, types::{self, GetPaymentMethodDetails}, }; -use crate::{configs::settings, routes::SessionState}; +use crate::{ + configs::settings, + routes::{dummy_connector::types::DummyConnectors, SessionState}, +}; pub async fn tokio_mock_sleep(delay: u64, tolerance: u64) { let mut rng = rand::thread_rng(); @@ -219,7 +222,7 @@ impl ProcessPaymentAttempt for types::DummyConnectorCard { payment_attempt: types::DummyConnectorPaymentAttempt, redirect_url: String, ) -> types::DummyConnectorResult<types::DummyConnectorPaymentData> { - match self.get_flow_from_card_number()? { + match self.get_flow_from_card_number(payment_attempt.payment_request.connector.clone())? { types::DummyConnectorCardFlow::NoThreeDS(status, error) => { if let Some(error) = error { Err(error)?; @@ -291,6 +294,7 @@ impl types::DummyConnectorUpiCollect { impl types::DummyConnectorCard { pub fn get_flow_from_card_number( self, + connector: DummyConnectors, ) -> types::DummyConnectorResult<types::DummyConnectorCardFlow> { let card_number = self.number.peek(); match card_number.as_str() { @@ -309,12 +313,21 @@ impl types::DummyConnectorCard { }), )) } - "4000000000009995" => Ok(types::DummyConnectorCardFlow::NoThreeDS( - types::DummyConnectorStatus::Failed, - Some(errors::DummyConnectorErrors::PaymentDeclined { - message: "Insufficient funds", - }), - )), + "4000000000009995" => { + if connector == DummyConnectors::StripeTest { + Ok(types::DummyConnectorCardFlow::NoThreeDS( + types::DummyConnectorStatus::Succeeded, + None, + )) + } else { + Ok(types::DummyConnectorCardFlow::NoThreeDS( + types::DummyConnectorStatus::Failed, + Some(errors::DummyConnectorErrors::PaymentDeclined { + message: "Internal Server Error from Connector, Please try again later", + }), + )) + } + } "4000000000009987" => Ok(types::DummyConnectorCardFlow::NoThreeDS( types::DummyConnectorStatus::Failed, Some(errors::DummyConnectorErrors::PaymentDeclined {

2025-06-26T10:37:04Z

…rd payment ## Type of Change  - [ ] Bugfix - [ ] New feature - [x] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  For one connector alone to hard code success with a particular failure card ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  `stripe_test` if the card number is `4000000000009995` previously it was failure with insufficient funds. But now we need to allow it to become success. ## Motivation and Context Objective is to show user how smart retry works so a relevant error message will help ## How did you test it?  ## failure for other gateways <details> <summary>Request </summary> ```json { "amount": 333, "currency": "EUR", "confirm": true, "capture_method": "automatic", "payment_method": "card", "payment_method_type": "credit", "authentication_type": "no_three_ds", "description": "hellow world", "connector":["paypal_test"], "billing": { "address": { "zip": "560095", "country": "IN", "first_name": "Sakil", "last_name": "Mostak", "line1": "Fasdf", "line2": "Fasdf", "city": "Fasdf" } }, "payment_method_data": { "card": { "card_number": "4000000000009995", "card_exp_month": "01", "card_exp_year": "2026", "card_holder_name": "John Smith", "card_cvc": "100" } } } ``` </details> <details> <summary>Response</summary> ```json { "payment_id": "pay_04Vahgm5zSgQLH5y5o0S", "merchant_id": "merchant_1750933328", "status": "failed", "amount": 333, "net_amount": 333, "shipping_cost": null, "amount_capturable": 0, "amount_received": null, "connector": "paypal_test", "client_secret": "pay_04Vahgm5zSgQLH5y5o0S_secret_iKiVIRw76fiMFvPXCzU7", "created": "2025-06-26T10:32:26.951Z", "currency": "EUR", "customer_id": null, "customer": null, "description": "hellow world", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "card", "payment_method_data": { "card": { "last4": "9995", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "400000", "card_extended_bin": null, "card_exp_month": "01", "card_exp_year": "2026", "card_holder_name": "John Smith", "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": "Fasdf", "country": "IN", "line1": "Fasdf", "line2": "Fasdf", "line3": null, "zip": "560095", "state": null, "first_name": "Sakil", "last_name": "Mostak" }, "phone": null, "email": null }, "order_details": null, "email": null, "name": null, "phone": null, "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": null, "cancellation_reason": null, "error_code": "DC_08", "error_message": "Payment declined: Internal Server Error", "unified_code": "UE_9000", "unified_message": "Something went wrong", "payment_experience": null, "payment_method_type": "credit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": true, "connector_transaction_id": null, "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": null, "payment_link": null, "profile_id": "pro_tvhMochAzQxRKYmWKPgs", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_XioVM508jgIaVMwxgAsw", "incremental_authorization_allowed": false, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-06-26T10:47:26.951Z", "fingerprint": null, "browser_info": null, "payment_method_id": null, "payment_method_status": null, "updated": "2025-06-26T10:32:28.008Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` </details> ## success for `stripe_test` <details> <summary>Request</summary> ```json { "amount": 333, "currency": "EUR", "confirm": true, "capture_method": "automatic", "payment_method": "card", "payment_method_type": "credit", "authentication_type": "no_three_ds", "description": "hellow world", "connector":["stripe_test"], "billing": { "address": { "zip": "560095", "country": "IN", "first_name": "Sakil", "last_name": "Mostak", "line1": "Fasdf", "line2": "Fasdf", "city": "Fasdf" } }, "payment_method_data": { "card": { "card_number": "4000000000009995", "card_exp_month": "01", "card_exp_year": "2026", "card_holder_name": "John Smith", "card_cvc": "100" } } } ``` </details> <details> <summary>Response</summary> ```json { "payment_id": "pay_OqK97rLSs9s7NnwRvLV0", "merchant_id": "merchant_1750933328", "status": "succeeded", "amount": 333, "net_amount": 333, "shipping_cost": null, "amount_capturable": 0, "amount_received": 333, "connector": "stripe_test", "client_secret": "pay_OqK97rLSs9s7NnwRvLV0_secret_ZfXwEiZvzXjz0jiQFt7y", "created": "2025-06-26T10:39:21.936Z", "currency": "EUR", "customer_id": null, "customer": null, "description": "hellow world", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "card", "payment_method_data": { "card": { "last4": "9995", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "400000", "card_extended_bin": null, "card_exp_month": "01", "card_exp_year": "2026", "card_holder_name": "John Smith", "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": "Fasdf", "country": "IN", "line1": "Fasdf", "line2": "Fasdf", "line3": null, "zip": "560095", "state": null, "first_name": "Sakil", "last_name": "Mostak" }, "phone": null, "email": null }, "order_details": null, "email": null, "name": null, "phone": null, "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "credit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": false, "connector_transaction_id": "pay_LDgbgr5HUer6sqe8YSsq", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": null, "payment_link": null, "profile_id": "pro_tvhMochAzQxRKYmWKPgs", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_KNpkA14s7QSE6SE8SuUA", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-06-26T10:54:21.936Z", "fingerprint": null, "browser_info": null, "payment_method_id": null, "payment_method_status": null, "updated": "2025-06-26T10:39:22.945Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` </details> ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.114.0

ec6d0e4d62a530163ae1c806dcf40ccfd264b246

juspay/hyperswitch

juspay__hyperswitch-8492

Bug: [FIX] Fix routing approach update in wallet flow ### Feature Description Fix routing approach update in wallet flow ### Possible Implementation Fix routing approach update in wallet flow ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? Yes, I am willing to submit a PR!

diff --git a/crates/common_enums/src/enums.rs b/crates/common_enums/src/enums.rs index 29cf75ac504..1d00a451708 100644 --- a/crates/common_enums/src/enums.rs +++ b/crates/common_enums/src/enums.rs @@ -8523,6 +8523,7 @@ pub enum RoutingApproach { DebitRouting, RuleBasedRouting, VolumeBasedRouting, + StraightThroughRouting, #[default] DefaultFallback, } @@ -8533,6 +8534,7 @@ impl RoutingApproach { "SR_SELECTION_V3_ROUTING" => Self::SuccessRateExploitation, "SR_V3_HEDGING" => Self::SuccessRateExploration, "NTW_BASED_ROUTING" => Self::DebitRouting, + "DEFAULT" => Self::StraightThroughRouting, _ => Self::DefaultFallback, } } diff --git a/crates/diesel_models/src/payment_attempt.rs b/crates/diesel_models/src/payment_attempt.rs index 0afea0574a7..eeda9e78877 100644 --- a/crates/diesel_models/src/payment_attempt.rs +++ b/crates/diesel_models/src/payment_attempt.rs @@ -459,6 +459,7 @@ pub enum PaymentAttemptUpdate { tax_amount: Option<MinorUnit>, updated_by: String, merchant_connector_id: Option<id_type::MerchantConnectorAccountId>, + routing_approach: Option<storage_enums::RoutingApproach>, }, AuthenticationTypeUpdate { authentication_type: storage_enums::AuthenticationType, @@ -3088,6 +3089,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { tax_amount, updated_by, merchant_connector_id, + routing_approach, } => Self { payment_token, modified_at: common_utils::date_time::now(), @@ -3146,7 +3148,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, - routing_approach: None, + routing_approach, }, PaymentAttemptUpdate::UnresolvedResponseUpdate { status, diff --git a/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs b/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs index 3a2692e5830..d644c519ea9 100644 --- a/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs +++ b/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs @@ -1191,6 +1191,7 @@ pub enum PaymentAttemptUpdate { tax_amount: Option<MinorUnit>, updated_by: String, merchant_connector_id: Option<id_type::MerchantConnectorAccountId>, + routing_approach: Option<storage_enums::RoutingApproach>, }, AuthenticationTypeUpdate { authentication_type: storage_enums::AuthenticationType, @@ -1227,7 +1228,7 @@ pub enum PaymentAttemptUpdate { customer_acceptance: Option<pii::SecretSerdeValue>, connector_mandate_detail: Option<ConnectorMandateReferenceId>, card_discovery: Option<common_enums::CardDiscovery>, - routing_approach: Option<storage_enums::RoutingApproach>, // where all to add this one + routing_approach: Option<storage_enums::RoutingApproach>, }, RejectUpdate { status: storage_enums::AttemptStatus, @@ -1413,6 +1414,7 @@ impl PaymentAttemptUpdate { surcharge_amount, tax_amount, merchant_connector_id, + routing_approach, } => DieselPaymentAttemptUpdate::UpdateTrackers { payment_token, connector, @@ -1422,6 +1424,7 @@ impl PaymentAttemptUpdate { tax_amount, updated_by, merchant_connector_id, + routing_approach, }, Self::AuthenticationTypeUpdate { authentication_type, diff --git a/crates/router/src/core/payment_methods/cards.rs b/crates/router/src/core/payment_methods/cards.rs index 11b1489b5cf..c42b05bd424 100644 --- a/crates/router/src/core/payment_methods/cards.rs +++ b/crates/router/src/core/payment_methods/cards.rs @@ -2845,7 +2845,7 @@ pub async fn list_payment_methods( payment_intent, chosen, }; - let result = routing::perform_session_flow_routing( + let (result, routing_approach) = routing::perform_session_flow_routing( sfr, &business_profile, &enums::TransactionType::Payment, @@ -3027,6 +3027,7 @@ pub async fn list_payment_methods( merchant_connector_id: None, surcharge_amount: None, tax_amount: None, + routing_approach, }; state diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs index 83176881ead..83ff156ea95 100644 --- a/crates/router/src/core/payments.rs +++ b/crates/router/src/core/payments.rs @@ -7331,6 +7331,10 @@ where .change_context(errors::ApiErrorResponse::InternalServerError) .attach_printable("Failed execution of straight through routing")?; + payment_data.set_routing_approach_in_attempt(Some( + common_enums::RoutingApproach::StraightThroughRouting, + )); + if check_eligibility { let transaction_data = core_routing::PaymentsDslInput::new( payment_data.get_setup_mandate(), @@ -7911,12 +7915,12 @@ pub async fn perform_session_token_routing<F, D>( state: SessionState, merchant_context: &domain::MerchantContext, business_profile: &domain::Profile, - payment_data: &D, + payment_data: &mut D, connectors: api::SessionConnectorDatas, ) -> RouterResult<api::SessionConnectorDatas> where F: Clone, - D: OperationSessionGetters<F>, + D: OperationSessionGetters<F> + OperationSessionSetters<F>, { let chosen = connectors.apply_filter_for_session_routing(); let sfr = SessionFlowRoutingInput { @@ -7932,7 +7936,7 @@ where payment_intent: payment_data.get_payment_intent(), chosen, }; - let result = self_routing::perform_session_flow_routing( + let (result, routing_approach) = self_routing::perform_session_flow_routing( sfr, business_profile, &enums::TransactionType::Payment, @@ -7941,6 +7945,8 @@ where .change_context(errors::ApiErrorResponse::InternalServerError) .attach_printable("error performing session flow routing")?; + payment_data.set_routing_approach_in_attempt(routing_approach); + let final_list = connectors.filter_and_validate_for_session_flow(&result)?; Ok(final_list) diff --git a/crates/router/src/core/payments/operations/payment_create.rs b/crates/router/src/core/payments/operations/payment_create.rs index 4c463c74ed7..413aa121a9c 100644 --- a/crates/router/src/core/payments/operations/payment_create.rs +++ b/crates/router/src/core/payments/operations/payment_create.rs @@ -880,6 +880,8 @@ impl<F: Clone + Sync> UpdateTracker<F, PaymentData<F>, api::PaymentsRequest> for .as_ref() .map(|surcharge_details| surcharge_details.tax_on_surcharge_amount); + let routing_approach = payment_data.payment_attempt.routing_approach; + payment_data.payment_attempt = state .store .update_payment_attempt_with_attempt_id( @@ -896,6 +898,7 @@ impl<F: Clone + Sync> UpdateTracker<F, PaymentData<F>, api::PaymentsRequest> for tax_amount, updated_by: storage_scheme.to_string(), merchant_connector_id, + routing_approach, }, storage_scheme, ) diff --git a/crates/router/src/core/payments/routing.rs b/crates/router/src/core/payments/routing.rs index 7126ed9617e..c3823aa2f30 100644 --- a/crates/router/src/core/payments/routing.rs +++ b/crates/router/src/core/payments/routing.rs @@ -515,7 +515,10 @@ pub async fn perform_static_routing_v1( ).unwrap_or_default(); let (routable_connectors, routing_approach) = match cached_algorithm.as_ref() { - CachedAlgorithm::Single(conn) => (vec![(**conn).clone()], None), + CachedAlgorithm::Single(conn) => ( + vec![(**conn).clone()], + Some(common_enums::RoutingApproach::StraightThroughRouting), + ), CachedAlgorithm::Priority(plist) => (plist.clone(), None), CachedAlgorithm::VolumeSplit(splits) => ( perform_volume_split(splits.to_vec()) @@ -1208,8 +1211,10 @@ pub async fn perform_session_flow_routing( session_input: SessionFlowRoutingInput<'_>, business_profile: &domain::Profile, transaction_type: &api_enums::TransactionType, -) -> RoutingResult<FxHashMap<api_enums::PaymentMethodType, Vec<routing_types::SessionRoutingChoice>>> -{ +) -> RoutingResult<( + FxHashMap<api_enums::PaymentMethodType, Vec<routing_types::SessionRoutingChoice>>, + Option<common_enums::RoutingApproach>, +)> { let mut pm_type_map: FxHashMap<api_enums::PaymentMethodType, FxHashMap<String, api::GetToken>> = FxHashMap::default(); @@ -1297,6 +1302,7 @@ pub async fn perform_session_flow_routing( api_enums::PaymentMethodType, Vec<routing_types::SessionRoutingChoice>, > = FxHashMap::default(); + let mut final_routing_approach = None; for (pm_type, allowed_connectors) in pm_type_map { let euclid_pmt: euclid_enums::PaymentMethodType = pm_type; @@ -1315,12 +1321,15 @@ pub async fn perform_session_flow_routing( profile_id: &profile_id, }; - let routable_connector_choice_option = perform_session_routing_for_pm_type( - &session_pm_input, - transaction_type, - business_profile, - ) - .await?; + let (routable_connector_choice_option, routing_approach) = + perform_session_routing_for_pm_type( + &session_pm_input, + transaction_type, + business_profile, + ) + .await?; + + final_routing_approach = routing_approach; if let Some(routable_connector_choice) = routable_connector_choice_option { let mut session_routing_choice: Vec<routing_types::SessionRoutingChoice> = Vec::new(); @@ -1348,7 +1357,7 @@ pub async fn perform_session_flow_routing( } } - Ok(result) + Ok((result, final_routing_approach)) } #[cfg(feature = "v1")] @@ -1356,14 +1365,17 @@ async fn perform_session_routing_for_pm_type( session_pm_input: &SessionRoutingPmTypeInput<'_>, transaction_type: &api_enums::TransactionType, _business_profile: &domain::Profile, -) -> RoutingResult<Option<Vec<api_models::routing::RoutableConnectorChoice>>> { +) -> RoutingResult<( + Option<Vec<api_models::routing::RoutableConnectorChoice>>, + Option<common_enums::RoutingApproach>, +)> { let merchant_id = &session_pm_input.key_store.merchant_id; let algorithm_id = match session_pm_input.routing_algorithm { MerchantAccountRoutingAlgorithm::V1(algorithm_ref) => &algorithm_ref.algorithm_id, }; - let chosen_connectors = if let Some(ref algorithm_id) = algorithm_id { + let (chosen_connectors, routing_approach) = if let Some(ref algorithm_id) = algorithm_id { let cached_algorithm = ensure_algorithm_cached_v1( &session_pm_input.state.clone(), merchant_id, @@ -1374,23 +1386,35 @@ async fn perform_session_routing_for_pm_type( .await?; match cached_algorithm.as_ref() { - CachedAlgorithm::Single(conn) => vec![(**conn).clone()], - CachedAlgorithm::Priority(plist) => plist.clone(), - CachedAlgorithm::VolumeSplit(splits) => perform_volume_split(splits.to_vec()) - .change_context(errors::RoutingError::ConnectorSelectionFailed)?, - CachedAlgorithm::Advanced(interpreter) => execute_dsl_and_get_connector_v1( - session_pm_input.backend_input.clone(), - interpreter, - )?, + CachedAlgorithm::Single(conn) => ( + vec![(**conn).clone()], + Some(common_enums::RoutingApproach::StraightThroughRouting), + ), + CachedAlgorithm::Priority(plist) => (plist.clone(), None), + CachedAlgorithm::VolumeSplit(splits) => ( + perform_volume_split(splits.to_vec()) + .change_context(errors::RoutingError::ConnectorSelectionFailed)?, + Some(common_enums::RoutingApproach::VolumeBasedRouting), + ), + CachedAlgorithm::Advanced(interpreter) => ( + execute_dsl_and_get_connector_v1( + session_pm_input.backend_input.clone(), + interpreter, + )?, + Some(common_enums::RoutingApproach::RuleBasedRouting), + ), } } else { - routing::helpers::get_merchant_default_config( - &*session_pm_input.state.clone().store, - session_pm_input.profile_id.get_string_repr(), - transaction_type, + ( + routing::helpers::get_merchant_default_config( + &*session_pm_input.state.clone().store, + session_pm_input.profile_id.get_string_repr(), + transaction_type, + ) + .await + .change_context(errors::RoutingError::FallbackConfigFetchFailed)?, + None, ) - .await - .change_context(errors::RoutingError::FallbackConfigFetchFailed)? }; let mut final_selection = perform_cgraph_filtering( @@ -1426,9 +1450,9 @@ async fn perform_session_routing_for_pm_type( } if final_selection.is_empty() { - Ok(None) + Ok((None, routing_approach)) } else { - Ok(Some(final_selection)) + Ok((Some(final_selection), routing_approach)) } } diff --git a/migrations/2025-06-27-120507_update_routing_approach/down.sql b/migrations/2025-06-27-120507_update_routing_approach/down.sql new file mode 100644 index 00000000000..c7c9cbeb401 --- /dev/null +++ b/migrations/2025-06-27-120507_update_routing_approach/down.sql @@ -0,0 +1,2 @@ +-- This file should undo anything in `up.sql` +SELECT 1; \ No newline at end of file diff --git a/migrations/2025-06-27-120507_update_routing_approach/up.sql b/migrations/2025-06-27-120507_update_routing_approach/up.sql new file mode 100644 index 00000000000..c7f75cb5235 --- /dev/null +++ b/migrations/2025-06-27-120507_update_routing_approach/up.sql @@ -0,0 +1,3 @@ +-- Your SQL goes here +ALTER TYPE "RoutingApproach" +ADD VALUE 'straight_through_routing';

2025-06-30T08:06:48Z

## Type of Change  - [x] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  Fixes routing approach updation for wallets flow ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  ## How did you test it?  1. make wallet payment and check for `routing_approach` column in payment_attempt ApplePay payment create - ``` curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_BNOaWRzwyZ3hMAbhRNtp9t6Mx7ZSVyK5gPvd1bavl0FWehvrHlre1eMifYA244TE' \ --data-raw '{ "amount": 650, "currency": "USD", "confirm": false, "business_country": "US", "business_label": "default", "amount_to_capture": 650, "customer_id": "cu_1751271429", "capture_method": "automatic", "capture_on": "2022-09-10T10:11:12Z", "setup_future_usage": "off_session", "authentication_type": "no_three_ds", "return_url": "https://google.com", "email": "[email protected]", "name": "Joseph Doe", "phone": "999999999", "phone_country_code": "+65", "description": "Its my first payment request", "statement_descriptor_name": "Juspay", "statement_descriptor_suffix": "Router", "payment_method": "wallet", "payment_method_type": "apple_pay", "billing": { "address": { "line1": "1467", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" }, "phone": { "number": "8056594427", "country_code": "+91" } }, "customer_acceptance": { "acceptance_type": "offline", "accepted_at": "1963-05-03T04:07:52.723Z", "online": { "ip_address": "in sit", "user_agent": "amet irure esse" } }, "payment_method_data": { "wallet": { "apple_pay": { "payment_data": "eyJkYXRhIjogInR1OHlCcFY3MHJ5WFpSTUJqaEt3T2VtTGhrbHlPREIzNVVLdnpNUDVFRk50eW9OMUdtK2pRRkZnaTF1T0t3WmJQZUUwdmxVUnJIeU5vQkhLOUZSY1pmYzJVL2cydytHbExweWxVcEQwc2VXdU9rRTZYb1E1SHFsZ085bFZRclZacHZsNmFndHdVYU5Cc2pqWTB0Q1F1SHRMRHQzQWI4c2pJdWhpL1g1cFNYakM0ak5PdUoxRkdJKy9CS016OHBNdUZGMkUvbmJWenhNQjhoT1lDWjlUVGdFZlN3Z3VwbE9SaFY5dFV1by9VVFhFUG40cGljNVpPYUR6WnB6Z1BuK0d1V2JVVExuL0h5Rk9MQW5xc3pNZzFkdklHcjd3c0pWRE1LUzJIdHZ5VzA2QXUzNGVSZGxkaEVWbFhnYWNDcWFualVwZlJBcVhod2VtQjNwd2p4bFBUMkxrcUE3VzJwWnNLNkF1Z0lwUi9tMTUwazFRRjl3d1AwVTF6YkpBbGc5bE9VL1IyRlVZR1BKRUZ4ay92SWowL3ZiYnkvcE96L0RBY1ZRd3NGek9UbUk9IiwKICAgICAgInNpZ25hdHVyZSI6ICJNSUFHQ1NxR1NJYjNEUUVIQXFDQU1JQUNBUUV4RFRBTEJnbGdoa2dCWlFNRUFnRXdnQVlKS29aSWh2Y05BUWNCQUFDZ2dEQ0NBK1F3Z2dPTG9BTUNBUUlDQ0ZuWW9ieXE5T1BOTUFvR0NDcUdTTTQ5QkFNQ01Ib3hMakFzQmdOVkJBTU1KVUZ3Y0d4bElFRndjR3hwWTJGMGFXOXVJRWx1ZEdWbmNtRjBhVzl1SUVOQklDMGdSek14SmpBa0JnTlZCQXNNSFVGd2NHeGxJRU5sY25ScFptbGpZWFJwYjI0Z1FYVjBhRzl5YVhSNU1STXdFUVlEVlFRS0RBcEJjSEJzWlNCSmJtTXVNUXN3Q1FZRFZRUUdFd0pWVXpBZUZ3MHlNVEEwTWpBeE9UTTNNREJhRncweU5qQTBNVGt4T1RNMk5UbGFNR0l4S0RBbUJnTlZCQU1NSDJWall5MXpiWEF0WW5KdmEyVnlMWE5wWjI1ZlZVTTBMVk5CVGtSQ1QxZ3hGREFTQmdOVkJBc01DMmxQVXlCVGVYTjBaVzF6TVJNd0VRWURWUVFLREFwQmNIQnNaU0JKYm1NdU1Rc3dDUVlEVlFRR0V3SlZVekJaTUJNR0J5cUdTTTQ5QWdFR0NDcUdTTTQ5QXdFSEEwSUFCSUl3L2F2RG5QZGVJQ3hRMlp0RkV1WTM0cWtCM1d5ejRMSE5TMUpubVBqUFRyM29HaVdvd2g1TU05M09qaXFXd3Zhdm9aTURSY1RvZWtRbXpwVWJFcFdqZ2dJUk1JSUNEVEFNQmdOVkhSTUJBZjhFQWpBQU1COEdBMVVkSXdRWU1CYUFGQ1B5U2NSUGsrVHZKK2JFOWloc1A2SzcvUzVMTUVVR0NDc0dBUVVGQndFQkJEa3dOekExQmdnckJnRUZCUWN3QVlZcGFIUjBjRG92TDI5amMzQXVZWEJ3YkdVdVkyOXRMMjlqYzNBd05DMWhjSEJzWldGcFkyRXpNREl3Z2dFZEJnTlZIU0FFZ2dFVU1JSUJFRENDQVF3R0NTcUdTSWIzWTJRRkFUQ0IvakNCd3dZSUt3WUJCUVVIQWdJd2diWU1nYk5TWld4cFlXNWpaU0J2YmlCMGFHbHpJR05sY25ScFptbGpZWFJsSUdKNUlHRnVlU0J3WVhKMGVTQmhjM04xYldWeklHRmpZMlZ3ZEdGdVkyVWdiMllnZEdobElIUm9aVzRnWVhCd2JHbGpZV0pzWlNCemRHRnVaR0Z5WkNCMFpYSnRjeUJoYm1RZ1kyOXVaR2wwYVc5dWN5QnZaaUIxYzJVc0lHTmxjblJwWm1sallYUmxJSEJ2YkdsamVTQmhibVFnWTJWeWRHbG1hV05oZEdsdmJpQndjbUZqZEdsalpTQnpkR0YwWlcxbGJuUnpMakEyQmdnckJnRUZCUWNDQVJZcWFIUjBjRG92TDNkM2R5NWhjSEJzWlM1amIyMHZZMlZ5ZEdsbWFXTmhkR1ZoZFhSb2IzSnBkSGt2TURRR0ExVWRId1F0TUNzd0thQW5vQ1dHSTJoMGRIQTZMeTlqY213dVlYQndiR1V1WTI5dEwyRndjR3hsWVdsallUTXVZM0pzTUIwR0ExVWREZ1FXQkJRQ0pEQUxtdTd0UmpHWHBLWmFLWjVDY1lJY1JUQU9CZ05WSFE4QkFmOEVCQU1DQjRBd0R3WUpLb1pJaHZkalpBWWRCQUlGQURBS0JnZ3Foa2pPUFFRREFnTkhBREJFQWlCMG9iTWsyMEpKUXczVEoweFFkTVNBalpvZlNBNDZoY1hCTmlWbU1sKzhvd0lnYVRhUVU2djFDMXBTK2ZZQVRjV0tyV3hRcDlZSWFEZVE0S2M2MEI1SzJZRXdnZ0x1TUlJQ2RhQURBZ0VDQWdoSmJTKy9PcGphbHpBS0JnZ3Foa2pPUFFRREFqQm5NUnN3R1FZRFZRUUREQkpCY0hCc1pTQlNiMjkwSUVOQklDMGdSek14SmpBa0JnTlZCQXNNSFVGd2NHeGxJRU5sY25ScFptbGpZWFJwYjI0Z1FYVjBhRzl5YVhSNU1STXdFUVlEVlFRS0RBcEJjSEJzWlNCSmJtTXVNUXN3Q1FZRFZRUUdFd0pWVXpBZUZ3MHhOREExTURZeU16UTJNekJhRncweU9UQTFNRFl5TXpRMk16QmFNSG94TGpBc0JnTlZCQU1NSlVGd2NHeGxJRUZ3Y0d4cFkyRjBhVzl1SUVsdWRHVm5jbUYwYVc5dUlFTkJJQzBnUnpNeEpqQWtCZ05WQkFzTUhVRndjR3hsSUVObGNuUnBabWxqWVhScGIyNGdRWFYwYUc5eWFYUjVNUk13RVFZRFZRUUtEQXBCY0hCc1pTQkpibU11TVFzd0NRWURWUVFHRXdKVlV6QlpNQk1HQnlxR1NNNDlBZ0VHQ0NxR1NNNDlBd0VIQTBJQUJQQVhFWVFaMTJTRjFScGVKWUVIZHVpQW91L2VlNjVONEkzOFM1UGhNMWJWWmxzMXJpTFFsM1lOSWs1N3VnajlkaGZPaU10MnUyWnd2c2pvS1lUL1ZFV2pnZmN3Z2ZRd1JnWUlLd1lCQlFVSEFRRUVPakE0TURZR0NDc0dBUVVGQnpBQmhpcG9kSFJ3T2k4dmIyTnpjQzVoY0hCc1pTNWpiMjB2YjJOemNEQTBMV0Z3Y0d4bGNtOXZkR05oWnpNd0hRWURWUjBPQkJZRUZDUHlTY1JQaytUdkorYkU5aWhzUDZLNy9TNUxNQThHQTFVZEV3RUIvd1FGTUFNQkFmOHdId1lEVlIwakJCZ3dGb0FVdTdEZW9WZ3ppSnFraXBuZXZyM3JyOXJMSktzd053WURWUjBmQkRBd0xqQXNvQ3FnS0lZbWFIUjBjRG92TDJOeWJDNWhjSEJzWlM1amIyMHZZWEJ3YkdWeWIyOTBZMkZuTXk1amNtd3dEZ1lEVlIwUEFRSC9CQVFEQWdFR01CQUdDaXFHU0liM1kyUUdBZzRFQWdVQU1Bb0dDQ3FHU000OUJBTUNBMmNBTUdRQ01EclBjb05SRnBteGh2czF3MWJLWXIvMEYrM1pEM1ZOb282KzhaeUJYa0szaWZpWTk1dFpuNWpWUVEyUG5lbkMvZ0l3TWkzVlJDR3dvd1YzYkYzek9EdVFaLzBYZkN3aGJaWlB4bkpwZ2hKdlZQaDZmUnVaeTVzSmlTRmhCcGtQQ1pJZEFBQXhnZ0dITUlJQmd3SUJBVENCaGpCNk1TNHdMQVlEVlFRRERDVkJjSEJzWlNCQmNIQnNhV05oZEdsdmJpQkpiblJsWjNKaGRHbHZiaUJEUVNBdElFY3pNU1l3SkFZRFZRUUxEQjFCY0hCc1pTQkRaWEowYVdacFkyRjBhVzl1SUVGMWRHaHZjbWwwZVRFVE1CRUdBMVVFQ2d3S1FYQndiR1VnU1c1akxqRUxNQWtHQTFVRUJoTUNWVk1DQ0ZuWW9ieXE5T1BOTUFzR0NXQ0dTQUZsQXdRQ0FhQ0JrekFZQmdrcWhraUc5dzBCQ1FNeEN3WUpLb1pJaHZjTkFRY0JNQndHQ1NxR1NJYjNEUUVKQlRFUEZ3MHlOREV5TVRJd09ESTFNalphTUNnR0NTcUdTSWIzRFFFSk5ERWJNQmt3Q3dZSllJWklBV1VEQkFJQm9Rb0dDQ3FHU000OUJBTUNNQzhHQ1NxR1NJYjNEUUVKQkRFaUJDQmZHSHBFQ2RnOWQ0YWl0VTlDRndSTGVEYXNZSDRMdUNuQjIvZHd2VFE2SWpBS0JnZ3Foa2pPUFFRREFnUkdNRVFDSUhnK3dKd25RdlJuZEdIN1UrL1hVb094c21VRVI2a2RqQ0RQNStTajF4eXpBaUJydEdIUGtWUXB1VEFHeDQ5SllEUFl5MzdhUDhoeGxtK1VjRThzVWFFa0V3QUFBQUFBQUE9PSIsCiAgICAgICJoZWFkZXIiOiB7CiAgICAgICAgInB1YmxpY0tleUhhc2giOiAiMkNnWTU3TERJVFVEMHFSN0R3eUhsdVRtMTIyQnowOXNhczJCVVorRUU5VT0iLAogICAgICAgICJlcGhlbWVyYWxQdWJsaWNLZXkiOiAiTUZrd0V3WUhLb1pJemowQ0FRWUlLb1pJemowREFRY0RRZ0FFQmN1VGNHRGl0V1B3UVE5SFZ0d1dEZmRkZDlhelJ3VFJlL00zVUNSb3NHaEhhUklQUnNoZWp2ZWpaL0Z4MlFiamVYRmNRSnVra0creUdYUmlnTDR2MUE9PSIsCiAgICAgICAgInRyYW5zYWN0aW9uSWQiOiAiNzAwOTVhMWFjMTZkNGQ4NzAyODQ0ZDdjZDJhZGVkZWMxZmQyMzA0YTFkNmU3OTBhZWVmOWJjYzA5MmZkYjk2MSIKICAgICAgfSwKICAgICAgInZlcnNpb24iOiAiRUNfdjEifQ==", "payment_method": { "display_name": "Discover 9319", "network": "Discover", "type": "credit" }, "transaction_identifier": "c635c5b3af900d7bd81fecd7028f1262f9d030754ee65ec7afd988a678194751" } } } }' ``` Payment method list - ``` curl --location 'http://localhost:8080/account/payment_methods?client_secret=pay_mgPMJsvP0EXSt7fDSmIF_secret_TbYn03eKtktMmmjUMTKe' \ --header 'Accept: application/json' \ --header 'api-key: pk_dev_bc5af669d7594cb7aaf277fc6b6c60dc' ``` Routing approach after this - <img width="850" alt="image" src="https://github.com/user-attachments/assets/4d637044-03e0-4c34-ab7c-abbe60a700fc" /> test straight_through routing - ``` curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_BNOaWRzwyZ3hMAbhRNtp9t6Mx7ZSVyK5gPvd1bavl0FWehvrHlre1eMifYA244TE' \ --data-raw '{ "amount": 6540, "currency": "USD", "confirm": true, "capture_method": "automatic", "capture_on": "2022-09-10T10:11:12Z", "amount_to_capture": 6540, "customer_id": "StripeCustomer", "profile_id": "pro_EfD8EtQQSPZxXStG6B7x", "email": "[email protected]", "name": "John Doe", "phone": "999999999", "phone_country_code": "+1", "description": "Its my first payment request", "authentication_type": "no_three_ds", "return_url": "https://google.com", "payment_method": "card", "routing": { "type": "single", "data": {"connector": "stripe", "merchant_connector_id": "mca_SdftCCtpClu32qA6oijC"} }, "payment_method_type": "credit", "payment_method_data": { "card": { "card_number": "4242424242424242", "card_exp_month": "03", "card_exp_year": "30", "card_holder_name": "joseph Doe", "card_cvc": "737" } }, "billing": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "NL", "first_name": "joseph", "last_name": "Doe" }, "phone": { "number": "8056594427", "country_code": "+91" } }, "shipping": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" }, "phone": { "number": "8056594427", "country_code": "+91" } }, "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "metadata": { "udf1": "value1", "new_customer": "true", "login_date": "2019-09-10T10:11:12Z" }, "browser_info": { "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8", "language": "nl-NL", "color_depth": 24, "screen_height": 723, "screen_width": 1536, "time_zone": 0, "java_enabled": true, "java_script_enabled": true, "ip_address": "127.0.0.1" } }' ``` DB - <img width="852" alt="image" src="https://github.com/user-attachments/assets/6fa08603-19af-485b-bce2-9266b3419749" /> ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [ ] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

1c3811773ded20da19fac6f1dc679e337384f1cb

juspay/hyperswitch

juspay__hyperswitch-8481

Bug: [BUG] GlobalPay throws 501 for mandates below function is the culprit: ```rs fn get_payment_method_data( item: &PaymentsAuthorizeRouterData, brand_reference: Option<String>, ) -> Result<PaymentMethodData, Error> { match &item.request.payment_method_data { payment_method_data::PaymentMethodData::Card(ccard) => { Ok(PaymentMethodData::Card(requests::Card { number: ccard.card_number.clone(), expiry_month: ccard.card_exp_month.clone(), expiry_year: ccard.get_card_expiry_year_2_digit()?, cvv: ccard.card_cvc.clone(), account_type: None, authcode: None, avs_address: None, avs_postal_code: None, brand_reference, chip_condition: None, funding: None, pin_block: None, tag: None, track: None, })) } payment_method_data::PaymentMethodData::Wallet(wallet_data) => get_wallet_data(wallet_data), payment_method_data::PaymentMethodData::BankRedirect(bank_redirect) => { PaymentMethodData::try_from(bank_redirect) } _ => Err(errors::ConnectorError::NotImplemented( "Payment methods".to_string(), ))?, } } ``` just because `MandatePayment` isn't covered, it falls back to the default case which throws `501`. relevant docs: - [Tokenization](https://developer.globalpay.com/api/payment-methods-tokenization#/Create/post-payment-method) - [MIT](https://developer.globalpay.com/docs/MIT) - [Recurring](https://developer.globalpay.com/docs/payments/recurring/credentials-on-file)

diff --git a/config/config.example.toml b/config/config.example.toml index 9454b3f0adc..c6ae6f75ec5 100644 --- a/config/config.example.toml +++ b/config/config.example.toml @@ -467,6 +467,7 @@ square = { long_lived_token = false, payment_method = "card" } braintree = { long_lived_token = false, payment_method = "card" } gocardless = { long_lived_token = true, payment_method = "bank_debit" } billwerk = { long_lived_token = false, payment_method = "card" } +globalpay = { long_lived_token = false, payment_method = "card", flow = "mandates" } [debit_routing_config] # Debit Routing configs supported_currencies = "USD" # Supported currencies for debit routing diff --git a/config/deployments/integration_test.toml b/config/deployments/integration_test.toml index ddff65fa9c0..426b3ba808a 100644 --- a/config/deployments/integration_test.toml +++ b/config/deployments/integration_test.toml @@ -748,6 +748,7 @@ square = { long_lived_token = false, payment_method = "card" } stax = { long_lived_token = true, payment_method = "card,bank_debit" } stripe = { long_lived_token = false, payment_method = "wallet", payment_method_type = { list = "google_pay", type = "disable_only" } } billwerk = {long_lived_token = false, payment_method = "card"} +globalpay = { long_lived_token = false, payment_method = "card", flow = "mandates" } [webhooks] outgoing_enabled = true diff --git a/config/deployments/production.toml b/config/deployments/production.toml index 11d96d6269f..7c5cc65f2ca 100644 --- a/config/deployments/production.toml +++ b/config/deployments/production.toml @@ -758,6 +758,7 @@ square = { long_lived_token = false, payment_method = "card" } stax = { long_lived_token = true, payment_method = "card,bank_debit" } stripe = { long_lived_token = false, payment_method = "wallet", payment_method_type = { list = "google_pay", type = "disable_only" } } billwerk = {long_lived_token = false, payment_method = "card"} +globalpay = { long_lived_token = false, payment_method = "card", flow = "mandates" } [webhooks] outgoing_enabled = true diff --git a/config/deployments/sandbox.toml b/config/deployments/sandbox.toml index a372c873c78..305210ecb64 100644 --- a/config/deployments/sandbox.toml +++ b/config/deployments/sandbox.toml @@ -764,6 +764,7 @@ square = { long_lived_token = false, payment_method = "card" } stax = { long_lived_token = true, payment_method = "card,bank_debit" } stripe = { long_lived_token = false, payment_method = "wallet", payment_method_type = { list = "google_pay", type = "disable_only" } } billwerk = {long_lived_token = false, payment_method = "card"} +globalpay = { long_lived_token = false, payment_method = "card", flow = "mandates" } [webhooks] outgoing_enabled = true diff --git a/config/development.toml b/config/development.toml index 173d9363f2a..a3078b05089 100644 --- a/config/development.toml +++ b/config/development.toml @@ -895,6 +895,7 @@ braintree = { long_lived_token = false, payment_method = "card" } payme = { long_lived_token = false, payment_method = "card" } gocardless = { long_lived_token = true, payment_method = "bank_debit" } billwerk = { long_lived_token = false, payment_method = "card" } +globalpay = { long_lived_token = false, payment_method = "card", flow = "mandates" } [temp_locker_enable_config] stripe = { payment_method = "bank_transfer" } diff --git a/config/docker_compose.toml b/config/docker_compose.toml index 01abf5e8137..621b437bd28 100644 --- a/config/docker_compose.toml +++ b/config/docker_compose.toml @@ -390,6 +390,7 @@ hipay = { long_lived_token = false, payment_method = "card" } braintree = { long_lived_token = false, payment_method = "card" } gocardless = { long_lived_token = true, payment_method = "bank_debit" } billwerk = { long_lived_token = false, payment_method = "card" } +globalpay = { long_lived_token = false, payment_method = "card", flow = "mandates" } [temp_locker_enable_config] stripe = { payment_method = "bank_transfer" } diff --git a/crates/hyperswitch_connectors/src/connectors/globalpay.rs b/crates/hyperswitch_connectors/src/connectors/globalpay.rs index 7e9ad1aa820..215c8322dff 100644 --- a/crates/hyperswitch_connectors/src/connectors/globalpay.rs +++ b/crates/hyperswitch_connectors/src/connectors/globalpay.rs @@ -34,7 +34,7 @@ use hyperswitch_domain_models::{ types::{ PaymentsAuthorizeRouterData, PaymentsCancelRouterData, PaymentsCaptureRouterData, PaymentsCompleteAuthorizeRouterData, PaymentsSyncRouterData, RefundSyncRouterData, - RefundsRouterData, + RefundsRouterData, TokenizationRouterData, }, }; use hyperswitch_interfaces::{ @@ -49,7 +49,7 @@ use hyperswitch_interfaces::{ types::{ PaymentsAuthorizeType, PaymentsCaptureType, PaymentsCompleteAuthorizeType, PaymentsSyncType, PaymentsVoidType, RefreshTokenType, RefundExecuteType, RefundSyncType, - Response, + Response, TokenizationType, }, webhooks::{IncomingWebhook, IncomingWebhookRequestDetails}, }; @@ -61,6 +61,7 @@ use response::{ use serde_json::Value; use crate::{ + connectors::globalpay::response::GlobalpayPaymentMethodsResponse, constants::headers, types::{RefreshTokenRouterData, ResponseRouterData}, utils::{ @@ -381,7 +382,79 @@ impl api::PaymentToken for Globalpay {} impl ConnectorIntegration<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData> for Globalpay { - // Not Implemented (R) + fn get_headers( + &self, + req: &TokenizationRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + fn get_url( + &self, + _req: &TokenizationRouterData, + connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Ok(format!("{}/payment-methods", self.base_url(connectors),)) + } + + fn build_request( + &self, + req: &TokenizationRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&TokenizationType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(TokenizationType::get_headers(self, req, connectors)?) + .set_body(TokenizationType::get_request_body(self, req, connectors)?) + .build(), + )) + } + + fn get_request_body( + &self, + req: &TokenizationRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let connector_req = requests::GlobalPayPaymentMethodsRequest::try_from(req)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn handle_response( + &self, + data: &TokenizationRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<TokenizationRouterData, errors::ConnectorError> { + let response: GlobalpayPaymentMethodsResponse = res + .response + .parse_struct("GlobalpayPaymentMethodsResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + .change_context(errors::ConnectorError::ResponseHandlingFailed) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } } impl api::MandateSetup for Globalpay {} diff --git a/crates/hyperswitch_connectors/src/connectors/globalpay/requests.rs b/crates/hyperswitch_connectors/src/connectors/globalpay/requests.rs index 45749332081..056e546db20 100644 --- a/crates/hyperswitch_connectors/src/connectors/globalpay/requests.rs +++ b/crates/hyperswitch_connectors/src/connectors/globalpay/requests.rs @@ -16,78 +16,17 @@ pub struct GlobalpayCancelRouterData<T> { #[derive(Debug, Serialize)] pub struct GlobalpayPaymentsRequest { - /// A meaningful label for the merchant account set by Global Payments. pub account_name: Secret<String>, - /// The amount to transfer between Payer and Merchant for a SALE or a REFUND. It is always - /// represented in the lowest denomiation of the related currency. pub amount: Option<StringMinorUnit>, - /// Indicates if the merchant would accept an authorization for an amount less than the - /// requested amount. This is available for CP channel - /// only where the balance not authorized can be processed again using a different card. - pub authorization_mode: Option<AuthorizationMode>, - /// Indicates whether the transaction is to be captured automatically, later or later using - /// more than 1 partial capture. + pub currency: String, + pub reference: String, + pub country: api_models::enums::CountryAlpha2, pub capture_mode: Option<CaptureMode>, - /// The amount of the transaction that relates to cashback.It is always represented in the - /// lowest denomiation of the related currency. - pub cashback_amount: Option<StringMinorUnit>, - /// Describes whether the transaction was processed in a face to face(CP) scenario or a - /// Customer Not Present (CNP) scenario. + pub notifications: Option<Notifications>, + pub payment_method: GlobalPayPaymentMethodData, pub channel: Channel, - /// The amount that reflects the charge the merchant applied to the transaction for availing - /// of a more convenient purchase.It is always represented in the lowest denomiation of the - /// related currency. - pub convenience_amount: Option<StringMinorUnit>, - /// The country in ISO-3166-1(alpha-2 code) format. - pub country: api_models::enums::CountryAlpha2, - /// The currency of the amount in ISO-4217(alpha-3) - pub currency: String, - - pub currency_conversion: Option<CurrencyConversion>, - /// Merchant defined field to describe the transaction. - pub description: Option<String>, - - pub device: Option<Device>, - /// The amount of the gratuity for a transaction.It is always represented in the lowest - /// denomiation of the related currency. - pub gratuity_amount: Option<StringMinorUnit>, - /// Indicates whether the Merchant or the Payer initiated the creation of a transaction. pub initiator: Option<Initiator>, - /// Indicates the source IP Address of the system used to create the transaction. - pub ip_address: Option<Secret<String, common_utils::pii::IpAddress>>, - /// Indicates the language the transaction was executed in. In the format ISO-639-1 (alpha-2) - /// or ISO-639-1 (alpha-2)_ISO-3166(alpha-2) - pub language: Option<Language>, - - pub lodging: Option<Lodging>, - /// Indicates to Global Payments where the merchant wants to receive notifications of certain - /// events that occur on the Global Payments system. - pub notifications: Option<Notifications>, - - pub order: Option<Order>, - /// The merchant's payer reference for the transaction - pub payer_reference: Option<String>, - pub payment_method: PaymentMethod, - /// Merchant defined field to reference the transaction. - pub reference: String, - /// A merchant defined reference for the location that created the transaction. - pub site_reference: Option<String>, - /// Stored data information used to create a transaction. pub stored_credential: Option<StoredCredential>, - /// The amount that reflects the additional charge the merchant applied to the transaction - /// for using a specific payment method.It is always represented in the lowest denomiation of - /// the related currency. - pub surcharge_amount: Option<StringMinorUnit>, - /// Indicates the total or expected total of captures that will executed against a - /// transaction flagged as being captured multiple times. - pub total_capture_count: Option<i64>, - /// Describes whether the transaction is a SALE, that moves funds from Payer to Merchant, or - /// a REFUND where funds move from Merchant to Payer. - #[serde(rename = "type")] - pub globalpay_payments_request_type: Option<GlobalpayPaymentsRequestType>, - /// The merchant's user reference for the transaction. This represents the person who - /// processed the transaction on the merchant's behalf like a clerk or cashier reference. - pub user_reference: Option<String>, } #[derive(Debug, Serialize)] @@ -98,256 +37,60 @@ pub struct GlobalpayRefreshTokenRequest { pub grant_type: String, } -#[derive(Debug, Serialize, Deserialize)] -pub struct CurrencyConversion { - /// A unique identifier generated by Global Payments to identify the currency conversion. It - /// can be used to reference a currency conversion when processing a sale or a refund - /// transaction. - pub id: Option<String>, -} - -#[derive(Debug, Serialize, Deserialize)] -pub struct Device { - pub capabilities: Option<Capabilities>, - - pub entry_modes: Option<Vec<Vec<DeviceEntryMode>>>, - /// Describes whether a device prompts a payer for a gratuity when the payer is entering - /// their payment method details to the device. - pub gratuity_prompt_mode: Option<GratuityPromptMode>, - /// Describes the receipts a device prints when processing a transaction. - pub print_receipt_mode: Option<PrintReceiptMode>, - /// The sequence number from the device used to align with processing platform. - pub sequence_number: Option<Secret<String>>, - /// A unique identifier for the physical device. This value persists with the device even if - /// it is repurposed. - pub serial_number: Option<Secret<String>>, - /// The time from the device in ISO8601 format - pub time: Option<String>, -} - -#[derive(Debug, Serialize, Deserialize)] -pub struct Capabilities { - pub authorization_modes: Option<Vec<AuthorizationMode>>, - /// The number of lines that can be used to display information on the device. - pub display_line_count: Option<f64>, - - pub enabled_response: Option<Vec<EnabledResponse>>, - - pub entry_modes: Option<Vec<CapabilitiesEntryMode>>, - - pub fraud: Option<Vec<AuthorizationMode>>, - - pub mobile: Option<Vec<Mobile>>, - - pub payer_verifications: Option<Vec<PayerVerification>>, -} - -#[derive(Debug, Serialize, Deserialize)] -pub struct Lodging { - /// A reference that identifies the booking reference for a lodging stay. - pub booking_reference: Option<String>, - /// The amount charged for one nights lodging. - pub daily_rate_amount: Option<StringMinorUnit>, - /// A reference that identifies the booking reference for a lodging stay. - pub date_checked_in: Option<String>, - /// The check out date for a lodging stay. - pub date_checked_out: Option<String>, - /// The total number of days of the lodging stay. - pub duration_days: Option<f64>, - #[serde(rename = "lodging.charge_items")] - pub lodging_charge_items: Option<Vec<LodgingChargeItem>>, -} - -#[derive(Debug, Serialize, Deserialize)] -pub struct LodgingChargeItem { - pub payment_method_program_codes: Option<Vec<PaymentMethodProgramCode>>, - /// A reference that identifies the charge item, such as a lodging folio number. - pub reference: Option<String>, - /// The total amount for the list of charge types for a charge item. - pub total_amount: Option<StringMinorUnit>, - - pub types: Option<Vec<TypeElement>>, -} - -/// Indicates to Global Payments where the merchant wants to receive notifications of certain -/// events that occur on the Global Payments system. #[derive(Debug, Serialize, Deserialize, Default)] pub struct Notifications { - /// The merchant URL that will receive the notification when the customer has completed the - /// authentication. - pub challenge_return_url: Option<String>, - /// The merchant URL that will receive the notification when the customer has completed the - /// authentication when the authentication is decoupled and separate to the purchase. - pub decoupled_challenge_return_url: Option<String>, - /// The merchant URL to return the payer to, once the payer has completed payment using the - /// payment method. This returns control of the payer's payment experience to the merchant. pub return_url: Option<String>, - /// The merchant URL to notify the merchant of the latest status of the transaction. pub status_url: Option<String>, - /// The merchant URL that will receive the notification when the 3DS ACS successfully gathers - /// de ice informatiSon and tonotification_configurations.cordingly. - pub three_ds_method_return_url: Option<String>, - /// The URL on merchant's website to which the customer should be redirected in the event of - /// the customer canceling the transaction. pub cancel_url: Option<String>, } -#[derive(Debug, Serialize, Deserialize)] -pub struct Order { - /// Merchant defined field common to all transactions that are part of the same order. - pub reference: Option<String>, -} - #[derive(Debug, Serialize, Deserialize)] #[serde(rename_all = "snake_case")] pub enum PaymentMethodData { Card(Card), Apm(Apm), - BankTransfer(BankTransfer), DigitalWallet(DigitalWallet), + Token(TokenizationData), } #[derive(Debug, Serialize, Deserialize)] -pub struct PaymentMethod { +pub struct CommonPaymentMethodData { #[serde(flatten)] pub payment_method_data: PaymentMethodData, - pub authentication: Option<Authentication>, - pub encryption: Option<Encryption>, - /// Indicates how the payment method information was obtained by the Merchant for this - /// transaction. pub entry_mode: PaymentMethodEntryMode, - /// Indicates whether to execute the fingerprint signature functionality. - pub fingerprint_mode: Option<FingerprintMode>, - /// Specify the first name of the owner of the payment method. - pub first_name: Option<Secret<String>>, - /// Unique Global Payments generated id used to reference a stored payment method on the - /// Global Payments system. Often referred to as the payment method token. This value can be - /// used instead of payment method details such as a card number and expiry date. - pub id: Option<Secret<String>>, - /// Specify the surname of the owner of the payment method. - pub last_name: Option<Secret<String>>, - /// The full name of the owner of the payment method. - pub name: Option<Secret<String>>, - /// Contains the value a merchant wishes to appear on the payer's payment method statement - /// for this transaction - pub narrative: Option<String>, - /// Indicates whether to store the card as part of a transaction. - pub storage_mode: Option<CardStorageMode>, -} - -#[derive(Debug, Serialize, Deserialize)] -pub struct Apm { - /// A string used to identify the payment method provider being used to execute this - /// transaction. - pub provider: Option<ApmProvider>, -} - -/// Information outlining the degree of authentication executed related to a transaction. -#[derive(Debug, Serialize, Deserialize)] -pub struct Authentication { - /// Information outlining the degree of 3D Secure authentication executed. - pub three_ds: Option<ThreeDs>, - /// A message authentication code that is used to confirm the security and integrity of the - /// messaging to Global Payments. - pub mac: Option<String>, } -/// Information outlining the degree of 3D Secure authentication executed. #[derive(Debug, Serialize, Deserialize)] -pub struct ThreeDs { - /// The reference created by the 3DSecure Directory Server to identify the specific - /// authentication attempt. - pub ds_trans_reference: Option<String>, - /// An indication of the degree of the authentication and liability shift obtained for this - /// transaction. It is determined during the 3D Secure process. 2 or 1 for Mastercard - /// indicates the merchant has a liability shift. 5 or 6 for Visa or Amex indicates the - /// merchant has a liability shift. However for Amex if the payer is not enrolled the eci may - /// still be 6 but liability shift has not bee achieved. - pub eci: Option<String>, - /// Indicates if any exemptions apply to this transaction. - pub exempt_status: Option<ExemptStatus>, - /// Indicates the version of 3DS - pub message_version: Option<String>, - /// The reference created by the 3DSecure provider to identify the specific authentication - /// attempt. - pub server_trans_reference: Option<String>, - /// The authentication value created as part of the 3D Secure process. - pub value: Option<String>, +pub struct MandatePaymentMethodData { + pub entry_mode: PaymentMethodEntryMode, + pub id: Option<String>, } #[derive(Debug, Serialize, Deserialize)] -pub struct BankTransfer { - /// The number or reference for the payer's bank account. - pub account_number: Option<Secret<String>>, - - pub bank: Option<Bank>, - /// The number or reference for the check - pub check_reference: Option<Secret<String>>, - /// The type of bank account associated with the payer's bank account. - pub number_type: Option<NumberType>, - /// Indicates how the transaction was authorized by the merchant. - pub sec_code: Option<SecCode>, -} -#[derive(Debug, Serialize, Deserialize)] -pub struct Bank { - pub address: Option<Address>, - /// The local identifier code for the bank. - pub code: Option<Secret<String>>, - /// The name of the bank. - pub name: Option<String>, +#[serde(untagged)] +pub enum GlobalPayPaymentMethodData { + Common(CommonPaymentMethodData), + Mandate(MandatePaymentMethodData), } #[derive(Debug, Serialize, Deserialize)] -pub struct Address { - /// Merchant defined field common to all transactions that are part of the same order. - pub city: Option<Secret<String>>, - /// The country in ISO-3166-1(alpha-2 code) format. - pub country: Option<String>, - /// First line of the address. - pub line_1: Option<Secret<String>>, - /// Second line of the address. - pub line_2: Option<Secret<String>>, - /// Third line of the address. - pub line_3: Option<Secret<String>>, - /// The city or town of the address. - pub postal_code: Option<Secret<String>>, - /// The state or region of the address. ISO 3166-2 minus the country code itself. For - /// example, US Illinois = IL, or in the case of GB counties Wiltshire = WI or Aberdeenshire - /// = ABD - pub state: Option<String>, +pub struct Apm { + /// A string used to identify the payment method provider being used to execute this + /// transaction. + pub provider: Option<ApmProvider>, } #[derive(Debug, Default, Serialize, Deserialize)] pub struct Card { - /// The card providers description of their card product. - pub account_type: Option<String>, - /// Code generated when the card is successfully authorized. - pub authcode: Option<Secret<String>>, - /// First line of the address associated with the card. - pub avs_address: Option<String>, - /// Postal code of the address associated with the card. - pub avs_postal_code: Option<String>, - /// The unique reference created by the brands/schemes to uniquely identify the transaction. - pub brand_reference: Option<String>, - /// Indicates if a fallback mechanism was used to obtain the card information when EMV/chip - /// did not work as expected. - pub chip_condition: Option<ChipCondition>, - /// The numeric value printed on the physical card. pub cvv: Secret<String>, - /// The 2 digit expiry date month of the card. pub expiry_month: Secret<String>, - /// The 2 digit expiry date year of the card. pub expiry_year: Secret<String>, - /// Indicates whether the card is a debit or credit card. - pub funding: Option<Funding>, - /// The card account number used to authorize the transaction. Also known as PAN. pub number: cards::CardNumber, - /// Contains the pin block info, relating to the pin code the Payer entered. - pub pin_block: Option<Secret<String>>, - /// The full card tag data for an EMV/chip card transaction. - pub tag: Option<Secret<String>>, - /// Data from magnetic stripe of a card - pub track: Option<Secret<String>>, +} + +#[derive(Debug, Default, Serialize, Deserialize)] +pub struct TokenizationData { + pub brand_reference: Option<String>, } #[derive(Debug, Serialize, Deserialize)] @@ -358,16 +101,6 @@ pub struct DigitalWallet { pub payment_token: Option<serde_json::Value>, } -#[derive(Debug, Serialize, Deserialize)] -pub struct Encryption { - /// The encryption info used when sending encrypted card data to Global Payments. - pub info: Option<Secret<String>>, - /// The encryption method used when sending encrypted card data to Global Payments. - pub method: Option<Method>, - /// The version of encryption being used. - pub version: Option<String>, -} - /// Stored data information used to create a transaction. #[derive(Debug, Serialize, Deserialize)] pub struct StoredCredential { @@ -379,22 +112,6 @@ pub struct StoredCredential { pub sequence: Option<Sequence>, } -/// Indicates if the merchant would accept an authorization for an amount less than the -/// requested amount. This is available for CP channel -/// only where the balance not authorized can be processed again using a different card. -/// -/// Describes the instruction a device can indicate to the clerk in the case of fraud. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum AuthorizationMode { - /// Indicates merchant would accept an authorization for an amount less than the - /// requested amount. - /// pub example: PARTIAL - /// - /// Describes whether the device can process partial authorizations. - Partial, -} - /// Indicates whether the transaction is to be captured automatically, later or later using /// more than 1 partial capture. #[derive(Debug, Serialize, Deserialize)] @@ -432,88 +149,6 @@ pub enum Channel { CustomerPresent, } -/// Describes the data the device can handle when it receives a response for a card -/// authorization. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum EnabledResponse { - Avs, - BrandReference, - Cvv, - MaskedNumberLast4, -} - -/// Describes the entry mode capabilities a device has. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum CapabilitiesEntryMode { - Chip, - Contactless, - ContactlessSwipe, - Manual, - Swipe, -} - -/// Describes the mobile features a device has -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum Mobile { - IntegratedCardReader, - SeparateCardReader, -} - -/// Describes the capabilities a device has to verify a payer. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum PayerVerification { - ContactlessSignature, - PayerDevice, - Pinpad, -} - -/// Describes the allowed entry modes to obtain payment method information from the payer as -/// part of a transaction request. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum DeviceEntryMode { - Chip, - Contactless, - Manual, - Swipe, -} - -/// Describes whether a device prompts a payer for a gratuity when the payer is entering -/// their payment method details to the device. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum GratuityPromptMode { - NotRequired, - Prompt, -} - -/// Describes the receipts a device prints when processing a transaction. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum PrintReceiptMode { - Both, - Merchant, - None, - Payer, -} - -/// Describes whether the transaction is a SALE, that moves funds from Payer to Merchant, or -/// a REFUND where funds move from Merchant to Payer. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum GlobalpayPaymentsRequestType { - /// indicates the movement, or the attempt to move, funds from merchant to the - /// payer. - Refund, - /// indicates the movement, or the attempt to move, funds from payer to a - /// merchant. - Sale, -} - /// Indicates whether the Merchant or the Payer initiated the creation of a transaction. #[derive(Debug, Serialize, Deserialize)] #[serde(rename_all = "SCREAMING_SNAKE_CASE")] @@ -525,45 +160,6 @@ pub enum Initiator { Payer, } -/// Indicates the language the transaction was executed in. In the format ISO-639-1 (alpha-2) -/// or ISO-639-1 (alpha-2)_ISO-3166(alpha-2) -#[derive(Debug, Serialize, Deserialize)] -pub enum Language { - #[serde(rename = "fr")] - Fr, - #[serde(rename = "fr_CA")] - FrCa, - #[serde(rename = "ISO-639(alpha-2)")] - Iso639Alpha2, - #[serde(rename = "ISO-639(alpha-2)_ISO-3166(alpha-2)")] - Iso639alpha2Iso3166alpha2, -} - -/// Describes the payment method programs, typically run by card brands such as Amex, Visa -/// and MC. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum PaymentMethodProgramCode { - AssuredReservation, - CardDeposit, - Other, - Purchase, -} - -/// Describes the types of charges associated with a transaction. This can be one or more -/// than more charge type. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum TypeElement { - GiftShop, - Laundry, - MiniBar, - NoShow, - Other, - Phone, - Restaurant, -} - /// A string used to identify the payment method provider being used to execute this /// transaction. #[derive(Debug, Serialize, Deserialize)] @@ -577,87 +173,6 @@ pub enum ApmProvider { Testpay, } -/// Indicates if any exemptions apply to this transaction. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum ExemptStatus { - LowValue, - ScaDelegation, - SecureCorporatePayment, - TransactionRiskAnalysis, - TrustedMerchant, -} - -/// The type of bank account associated with the payer's bank account. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum NumberType { - Checking, - Savings, -} - -/// Indicates how the transaction was authorized by the merchant. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum SecCode { - /// Cash Concentration or Disbursement - Can be either a credit or debit application - /// where funds are wither distributed or consolidated between corporate entities. - #[serde(rename = "CCD")] - CashConcentrationOrDisbursement, - - /// Point of Sale Entry - Point of sale debit applications non-shared (POS) - /// environment. These transactions are most often initiated by the consumer via a plastic - /// access card. This is only support for normal ACH transactions - #[serde(rename = "POP")] - PointOfSaleEntry, - /// Prearranged Payment and Deposits - used to credit or debit a consumer account. - /// Popularity used for payroll direct deposits and pre-authorized bill payments. - #[serde(rename = "PPD")] - PrearrangedPaymentAndDeposits, - /// Telephone-Initiated Entry - Used for the origination of a single entry debit - /// transaction to a consumer's account pursuant to a verbal authorization obtained from the - /// consumer via the telephone. - #[serde(rename = "TEL")] - TelephoneInitiatedEntry, - /// Internet (Web)-Initiated Entry - Used for the origination of debit entries - /// (either Single or Recurring Entry) to a consumer's account pursuant to a to an - /// authorization that is obtained from the Receiver via the Internet. - #[serde(rename = "WEB")] - WebInitiatedEntry, -} - -/// Indicates if a fallback mechanism was used to obtain the card information when EMV/chip -/// did not work as expected. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum ChipCondition { - /// indicates the previous transaction with this card failed. - PrevFailed, - /// indicates the previous transaction with this card was a success. - PrevSuccess, -} - -/// Indicates whether the card is a debit or credit card. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum Funding { - /// indicates the card is an, Electronic Benefits Transfer, for cash - /// benefits. - CashBenefits, - /// indicates the card is a credit card where the funds may be available on credit - /// to the payer to fulfill the transaction amount. - Credit, - /// indicates the card is a debit card where the funds may be present in an account - /// to fulfill the transaction amount. - Debit, - /// indicates the card is an, Electronic Benefits Transfer, for food stamps. - FoodStamp, - /// indicates the card is a prepaid card where the funds are loaded to the card - /// account to fulfill the transaction amount. Unlike a debit card, a prepaid is not linked - /// to a bank account. - Prepaid, -} - /// Identifies who provides the digital wallet for the Payer. #[derive(Debug, Serialize, Deserialize)] #[serde(rename_all = "SCREAMING_SNAKE_CASE")] @@ -666,27 +181,6 @@ pub enum DigitalWalletProvider { PayByGoogle, } -/// Indicates if the actual card number or a token is being used to process the -/// transaction. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum TokenFormat { - /// The value in the digital wallet token field is a real card number - /// (PAN) - CardNumber, - /// The value in the digital wallet token field is a temporary token in the - /// format of a card number (PAN) but is not a real card number. - CardToken, -} - -/// The encryption method used when sending encrypted card data to Global Payments. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum Method { - Ksn, - Ktb, -} - /// Indicates how the payment method information was obtained by the Merchant for this /// transaction. #[derive(Debug, Default, Serialize, Deserialize)] @@ -727,30 +221,6 @@ pub enum PaymentMethodEntryMode { Swipe, } -/// Indicates whether to execute the fingerprint signature functionality. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum FingerprintMode { - /// Always check and create the fingerprint value regardless of the result of the - /// card authorization. - Always, - /// Always check and create the fingerprint value when the card authorization - /// is successful. - OnSuccess, -} - -/// Indicates whether to store the card as part of a transaction. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum CardStorageMode { - /// /// The card information is always stored irrespective of whether the payment - /// method authorization was successful or not. - Always, - /// The card information is only stored if the payment method authorization was - /// successful. - OnSuccess, -} - /// Indicates the transaction processing model being executed when using stored /// credentials. #[derive(Debug, Serialize, Deserialize)] @@ -775,17 +245,6 @@ pub enum Model { Unscheduled, } -/// The reason stored credentials are being used to create a transaction. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum Reason { - Delayed, - Incremental, - NoShow, - Reauthorization, - Resubmission, -} - /// Indicates the order of this transaction in the sequence of a planned repeating /// transaction processing model. #[derive(Debug, Serialize, Deserialize)] @@ -812,3 +271,34 @@ pub struct GlobalpayCaptureRequest { pub struct GlobalpayCancelRequest { pub amount: Option<StringMinorUnit>, } + +#[derive(Default, Debug, Serialize, Deserialize)] +#[serde(rename_all = "SCREAMING_SNAKE_CASE")] +pub enum UsageMode { + /// This value must be used if using the Hosted Fields or the Drop-in UI integration types. + /// When creating the payment method token, this option ensures the payment method token is temporary and will be removed once a transaction is executed or after a short period of time. + #[default] + Single, + /// When creating the payment method token, this indicates it is permanent and can be used to create many transactions. + Multiple, + /// When using the payment method token to transaction process, this indicates to use the card number also known as the PAN or FPAN when both the card number and the network token are available. + UseCardNumber, + /// When using the payment method token to transaction process, this indicates to use the network token instead of the card number if both are available. + UseNetworkToken, +} + +#[derive(Default, Debug, Serialize, Deserialize)] +pub struct GlobalPayPayer { + /// Unique identifier for the Payer on the Global Payments system. + #[serde(rename = "id", skip_serializing_if = "Option::is_none")] + pub payer_id: Option<String>, +} + +#[derive(Default, Debug, Serialize)] +pub struct GlobalPayPaymentMethodsRequest { + pub reference: String, + #[serde(skip_serializing_if = "Option::is_none")] + pub usage_mode: Option<UsageMode>, + #[serde(skip_serializing_if = "Option::is_none")] + pub card: Option<Card>, +} diff --git a/crates/hyperswitch_connectors/src/connectors/globalpay/response.rs b/crates/hyperswitch_connectors/src/connectors/globalpay/response.rs index 11bd9e1a047..daa629641e6 100644 --- a/crates/hyperswitch_connectors/src/connectors/globalpay/response.rs +++ b/crates/hyperswitch_connectors/src/connectors/globalpay/response.rs @@ -3,75 +3,17 @@ use common_utils::types::StringMinorUnit; use masking::Secret; use serde::{Deserialize, Serialize}; -use super::requests; use crate::utils::deserialize_optional_currency; #[derive(Debug, Serialize, Deserialize)] pub struct GlobalpayPaymentsResponse { - /// A unique identifier for the merchant account set by Global Payments. - pub account_id: Option<Secret<String>>, - /// A meaningful label for the merchant account set by Global Payments. - pub account_name: Option<Secret<String>>, - /// Information about the Action executed. - pub action: Option<Action>, - /// The amount to transfer between Payer and Merchant for a SALE or a REFUND. It is always - /// represented in the lowest denomiation of the related currency. + pub status: GlobalpayPaymentStatus, + pub payment_method: Option<PaymentMethod>, + pub id: String, pub amount: Option<StringMinorUnit>, - /// Indicates if the merchant would accept an authorization for an amount less than the - /// requested amount. This is available for CP channel - /// only where the balance not authorized can be processed again using a different card. - pub authorization_mode: Option<requests::AuthorizationMode>, - /// A Global Payments created reference that uniquely identifies the batch. - pub batch_id: Option<String>, - /// Indicates whether the transaction is to be captured automatically, later or later using - /// more than 1 partial capture. - pub capture_mode: Option<requests::CaptureMode>, - /// Describes whether the transaction was processed in a face to face(CP) scenario or a - /// Customer Not Present (CNP) scenario. - pub channel: Option<requests::Channel>, - /// The country in ISO-3166-1(alpha-2 code) format. - pub country: Option<String>, - /// The currency of the amount in ISO-4217(alpha-3) #[serde(deserialize_with = "deserialize_optional_currency")] pub currency: Option<Currency>, - /// Information relating to a currency conversion. - pub currency_conversion: Option<requests::CurrencyConversion>, - /// A unique identifier generated by Global Payments to identify the transaction. - pub id: String, - /// A unique identifier for the merchant set by Global Payments. - pub merchant_id: Option<String>, - /// A meaningful label for the merchant set by Global Payments. - pub merchant_name: Option<Secret<String>>, - pub payment_method: Option<PaymentMethod>, - /// Merchant defined field to reference the transaction. pub reference: Option<String>, - /// Indicates where a transaction is in its lifecycle. - pub status: GlobalpayPaymentStatus, - /// Global Payments time indicating when the object was created in ISO-8601 format. - pub time_created: Option<String>, - /// Describes whether the transaction is a SALE, that moves funds from Payer to Merchant, or - /// a REFUND where funds move from Merchant to Payer. - #[serde(rename = "type")] - pub globalpay_payments_response_type: Option<requests::GlobalpayPaymentsRequestType>, -} - -/// Information about the Action executed. -#[derive(Debug, Serialize, Deserialize)] -pub struct Action { - /// The id of the app that was used to create the token. - pub app_id: Option<Secret<String>>, - /// The name of the app the user gave to the application. - pub app_name: Option<Secret<String>>, - /// A unique identifier for the object created by Global Payments. The first 3 characters - /// identifies the resource an id relates to. - pub id: Option<Secret<String>>, - /// The result of the action executed. - pub result_code: Option<ResultCode>, - /// Global Payments time indicating when the object was created in ISO-8601 format. - pub time_created: Option<String>, - /// Indicates the action taken. - #[serde(rename = "type")] - pub action_type: Option<ActionType>, } #[derive(Debug, Deserialize, Serialize)] @@ -86,230 +28,25 @@ pub struct GlobalpayRefreshTokenErrorResponse { pub detailed_error_description: String, } -/// Information relating to a currency conversion. -#[derive(Debug, Serialize, Deserialize)] -pub struct CurrencyConversion { - /// The percentage commission taken for providing the currency conversion. - pub commission_percentage: Option<String>, - /// The exchange rate used to convert one currency to another. - pub conversion_rate: Option<String>, - /// The source of the base exchange rate was obtained to execute the currency conversion. - pub exchange_rate_source: Option<String>, - /// The time the base exchange rate was obtained from the source. - pub exchange_source_time: Option<String>, - /// The exchange rate used to convert one currency to another. - pub margin_rate_percentage: Option<String>, - /// The amount that will affect the payer's account. - pub payer_amount: Option<StringMinorUnit>, - /// The currency of the amount that will affect the payer's account. - pub payer_currency: Option<String>, -} - #[derive(Debug, Serialize, Deserialize)] pub struct PaymentMethod { - /// Data associated with the response of an APM transaction. pub apm: Option<Apm>, - /// Information outlining the degree of authentication executed related to a transaction. - pub authentication: Option<Authentication>, - pub bank_transfer: Option<BankTransfer>, pub card: Option<Card>, - pub digital_wallet: Option<requests::DigitalWallet>, - /// Indicates how the payment method information was obtained by the Merchant for this - /// transaction. - pub entry_mode: Option<requests::PaymentMethodEntryMode>, - /// If enabled, this field contains the unique fingerprint signature for that payment method - /// for that merchant. If the payment method is seen again this same value is generated. For - /// cards the primary account number is checked only. The expiry date or the CVV is not used - /// for this check. - pub fingerprint: Option<Secret<String>>, - /// If enabled, this field indicates whether the payment method has been seen before or is - /// new. - /// * EXISTS - Indicates that the payment method was seen on the platform before by this - /// merchant. - /// * NEW - Indicates that the payment method was not seen on the platform before by this - /// merchant. - pub fingerprint_presence_indicator: Option<String>, - /// Unique Global Payments generated id used to reference a stored payment method on the - /// Global Payments system. Often referred to as the payment method token. This value can be - /// used instead of payment method details such as a card number and expiry date. pub id: Option<Secret<String>>, - /// Result message from the payment method provider corresponding to the result code. pub message: Option<String>, - /// Result code from the payment method provider. - /// If a card authorization declines, the payment_method result and message include more detail from the Issuer on why it was declined. - /// For example, 51 - INSUFFICIENT FUNDS. This is generated by the issuing bank, who will provide decline codes in the response back to the authorization platform. pub result: Option<String>, } /// Data associated with the response of an APM transaction. #[derive(Debug, Serialize, Deserialize)] pub struct Apm { - pub bank: Option<Bank>, - /// A string generated by the payment method that represents to what degree the merchant is - /// funded for the transaction. - #[serde(skip_deserializing)] - pub fund_status: Option<FundStatus>, - pub mandate: Option<Mandate>, - /// A string used to identify the payment method provider being used to execute this - /// transaction. - pub provider: Option<ApmProvider>, - /// A name of the payer from the payment method system. - pub provider_payer_name: Option<Secret<String>>, - /// The time the payment method provider created the transaction at on their system. - pub provider_time_created: Option<String>, - /// The reference the payment method provider created for the transaction. - pub provider_transaction_reference: Option<String>, - /// URL to redirect the payer from the merchant's system to the payment method's system. - //1)paypal sends redirect_url as provider_redirect_url for require_customer_action - //2)bankredirects sends redirect_url as redirect_url for require_customer_action - //3)after completeauthorize in paypal it doesn't send redirect_url - //4)after customer action in bankredirects it sends empty string in redirect_url #[serde(alias = "provider_redirect_url")] pub redirect_url: Option<String>, - /// A string generated by the payment method to represent the session created on the payment - /// method's platform to facilitate the creation of a transaction. - pub session_token: Option<Secret<String>>, - pub payment_description: Option<String>, -} - -#[derive(Debug, Serialize, Deserialize)] -pub struct Bank { - /// The local identifier of the bank account. - pub account_number: Option<Secret<String>>, - /// The local identifier of the bank. - pub code: Option<Secret<String>>, - /// The international identifier of the bank account. - pub iban: Option<Secret<String>>, - /// The international identifier code for the bank. - pub identifier_code: Option<Secret<String>>, - /// The name associated with the bank account - pub name: Option<Secret<String>>, -} - -#[derive(Debug, Serialize, Deserialize)] -pub struct Mandate { - /// The reference to identify the mandate. - pub code: Option<Secret<String>>, -} - -/// Information outlining the degree of authentication executed related to a transaction. -#[derive(Debug, Serialize, Deserialize)] -pub struct Authentication { - /// Information outlining the degree of 3D Secure authentication executed. - pub three_ds: Option<ThreeDs>, -} - -/// Information outlining the degree of 3D Secure authentication executed. -#[derive(Debug, Serialize, Deserialize)] -pub struct ThreeDs { - /// The result of the three_ds value validation by the brands or issuing bank. - pub value_result: Option<String>, -} - -#[derive(Debug, Serialize, Deserialize)] -pub struct BankTransfer { - /// The last 4 characters of the local reference for a bank account number. - pub masked_number_last4: Option<String>, - /// The name of the bank. - pub name: Option<Secret<String>>, - /// The type of bank account associated with the payer's bank account. - pub number_type: Option<NumberType>, } #[derive(Debug, Serialize, Deserialize)] pub struct Card { - /// Code generated when the card is successfully authorized. - pub authcode: Option<Secret<String>>, - /// The recommended AVS action to be taken by the agent processing the card transaction. - pub avs_action: Option<String>, - /// The result of the AVS address check. - pub avs_address_result: Option<String>, - /// The result of the AVS postal code check. - pub avs_postal_code_result: Option<String>, - /// Indicates the card brand that issued the card. - pub brand: Option<Brand>, - /// The unique reference created by the brands/schemes to uniquely identify the transaction. pub brand_reference: Option<Secret<String>>, - /// The time returned by the card brand indicating when the transaction was processed on - /// their system. - pub brand_time_reference: Option<String>, - /// The result of the CVV check. - pub cvv_result: Option<String>, - /// Masked card number with last 4 digits showing. - pub masked_number_last4: Option<String>, - /// The result codes directly from the card issuer. - pub provider: Option<ProviderClass>, - /// The card EMV tag response data from the card issuer for a contactless or chip card - /// transaction. - pub tag_response: Option<Secret<String>>, -} - -/// The result codes directly from the card issuer. -#[derive(Debug, Serialize, Deserialize)] -pub struct ProviderClass { - /// The result code of the AVS address check from the card issuer. - #[serde(rename = "card.provider.avs_address_result")] - pub card_provider_avs_address_result: Option<String>, - /// The result of the AVS postal code check from the card issuer.. - #[serde(rename = "card.provider.avs_postal_code_result")] - pub card_provider_avs_postal_code_result: Option<String>, - /// The result code of the AVS check from the card issuer. - #[serde(rename = "card.provider.avs_result")] - pub card_provider_avs_result: Option<String>, - /// The result code of the CVV check from the card issuer. - #[serde(rename = "card.provider.cvv_result")] - pub card_provider_cvv_result: Option<String>, - /// Result code from the card issuer. - #[serde(rename = "card.provider.result")] - pub card_provider_result: Option<String>, -} - -/// The result of the action executed. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum ResultCode { - Declined, - Success, - Pending, - Error, -} - -/// Indicates the specific action taken. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum ActionType { - Adjust, - Authorize, - Capture, - Confirm, - Force, - Increment, - Initiate, - MultipleCapture, - Preauthorize, - PreauthorizeMultipleCapturere, - Authorization, - RedirectFrom, - RedirectTo, - Refund, - Hold, - Release, - Reverse, - Split, - StatusNotification, - TransactionList, - TransactionSingle, -} - -/// A string generated by the payment method that represents to what degree the merchant is -/// funded for the transaction. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum FundStatus { - Missing, - NotExpected, - Received, - Waiting, } /// A string used to identify the payment method provider being used to execute this @@ -325,49 +62,6 @@ pub enum ApmProvider { Testpay, } -/// The type of bank account associated with the payer's bank account. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum NumberType { - Checking, - Savings, -} - -/// The recommended AVS action to be taken by the agent processing the card transaction. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum AvsAction { - Accept, - Decline, - Prompt, -} - -/// The result of the AVS address check. -/// -/// The result of the AVS postal code check. -/// -/// The result of the CVV check. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum GlobalPayResult { - Matched, - NotChecked, - NotMatched, -} - -/// Indicates the card brand that issued the card. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum Brand { - Amex, - Cup, - Diners, - Discover, - Jcb, - Mastercard, - Visa, -} - /// Indicates where a transaction is in its lifecycle. #[derive(Clone, Copy, Debug, Serialize, Deserialize)] #[serde(rename_all = "SCREAMING_SNAKE_CASE")] @@ -417,3 +111,22 @@ pub enum GlobalpayWebhookStatus { #[serde(other)] Unknown, } + +#[derive(Debug, Serialize, Deserialize)] +#[serde(rename_all = "SCREAMING_SNAKE_CASE")] +pub enum GlobalpayPaymentMethodStatus { + /// The entity is ACTIVE and can be used. + Active, + /// The entity is INACTIVE and cannot be used. + Inactive, + /// The status is DELETED. Once returned in an action response for a resource. + /// The resource has been removed from the platform. + Delete, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct GlobalpayPaymentMethodsResponse { + #[serde(rename = "id")] + pub payment_method_token_id: Option<Secret<String>>, + pub card: Card, +} diff --git a/crates/hyperswitch_connectors/src/connectors/globalpay/transformers.rs b/crates/hyperswitch_connectors/src/connectors/globalpay/transformers.rs index a7fd9abd2f8..e4239d28395 100644 --- a/crates/hyperswitch_connectors/src/connectors/globalpay/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/globalpay/transformers.rs @@ -8,7 +8,7 @@ use common_utils::{ use error_stack::ResultExt; use hyperswitch_domain_models::{ payment_method_data, - router_data::{AccessToken, ConnectorAuthType, ErrorResponse, RouterData}, + router_data::{AccessToken, ConnectorAuthType, ErrorResponse, PaymentMethodToken, RouterData}, router_flow_types::{Execute, RSync}, router_request_types::ResponseId, router_response_types::{ @@ -17,6 +17,7 @@ use hyperswitch_domain_models::{ types::{ PaymentsAuthorizeRouterData, PaymentsCancelRouterData, PaymentsCaptureRouterData, PaymentsSyncRouterData, RefreshTokenRouterData, RefundExecuteRouterData, RefundsRouterData, + TokenizationRouterData, }, }; use hyperswitch_interfaces::{ @@ -37,10 +38,14 @@ use super::{ response::{GlobalpayPaymentStatus, GlobalpayPaymentsResponse, GlobalpayRefreshTokenResponse}, }; use crate::{ + connectors::globalpay::{ + requests::CommonPaymentMethodData, response::GlobalpayPaymentMethodsResponse, + }, types::{PaymentsSyncResponseRouterData, RefundsResponseRouterData, ResponseRouterData}, utils::{ self, construct_captures_response_hashmap, CardData, ForeignTryFrom, - MultipleCaptureSyncResponse, PaymentsAuthorizeRequestData, RouterData as _, WalletData, + MultipleCaptureSyncResponse, PaymentMethodTokenizationRequestData, + PaymentsAuthorizeRequestData, RouterData as _, WalletData, }, }; @@ -82,65 +87,115 @@ impl TryFrom<&Option<pii::SecretSerdeValue>> for GlobalPayMeta { impl TryFrom<&GlobalPayRouterData<&PaymentsAuthorizeRouterData>> for GlobalpayPaymentsRequest { type Error = Error; + fn try_from( item: &GlobalPayRouterData<&PaymentsAuthorizeRouterData>, ) -> Result<Self, Self::Error> { + if item.router_data.is_three_ds() { + return Err(errors::ConnectorError::NotSupported { + message: "3DS flow".to_string(), + connector: "Globalpay", + } + .into()); + } + let metadata = GlobalPayMeta::try_from(&item.router_data.connector_meta_data)?; let account_name = metadata.account_name; - let (initiator, stored_credential, brand_reference) = - get_mandate_details(item.router_data)?; - let payment_method_data = get_payment_method_data(item.router_data, brand_reference)?; + + let (initiator, stored_credential, connector_mandate_id) = + if item.router_data.request.is_mandate_payment() { + let connector_mandate_id = + item.router_data + .request + .mandate_id + .as_ref() + .and_then(|mandate_ids| match &mandate_ids.mandate_reference_id { + Some(api_models::payments::MandateReferenceId::ConnectorMandateId( + connector_mandate_ids, + )) => connector_mandate_ids.get_connector_mandate_id(), + _ => None, + }); + + let initiator = Some(match item.router_data.request.off_session { + Some(true) => Initiator::Merchant, + _ => Initiator::Payer, + }); + + let stored_credential = Some(StoredCredential { + model: Some(if connector_mandate_id.is_some() { + requests::Model::Recurring + } else { + requests::Model::Unscheduled + }), + sequence: Some(if connector_mandate_id.is_some() { + Sequence::Subsequent + } else { + Sequence::First + }), + }); + + (initiator, stored_credential, connector_mandate_id) + } else { + (None, None, None) + }; + + let payment_method = match &item.router_data.request.payment_method_data { + payment_method_data::PaymentMethodData::Card(ccard) => { + requests::GlobalPayPaymentMethodData::Common(CommonPaymentMethodData { + payment_method_data: PaymentMethodData::Card(requests::Card { + number: ccard.card_number.clone(), + expiry_month: ccard.card_exp_month.clone(), + expiry_year: ccard.get_card_expiry_year_2_digit()?, + cvv: ccard.card_cvc.clone(), + }), + entry_mode: Default::default(), + }) + } + + payment_method_data::PaymentMethodData::Wallet(wallet_data) => { + requests::GlobalPayPaymentMethodData::Common(CommonPaymentMethodData { + payment_method_data: get_wallet_data(wallet_data)?, + entry_mode: Default::default(), + }) + } + + payment_method_data::PaymentMethodData::BankRedirect(bank_redirect) => { + requests::GlobalPayPaymentMethodData::Common(CommonPaymentMethodData { + payment_method_data: PaymentMethodData::try_from(bank_redirect)?, + entry_mode: Default::default(), + }) + } + + payment_method_data::PaymentMethodData::MandatePayment => { + requests::GlobalPayPaymentMethodData::Mandate(requests::MandatePaymentMethodData { + entry_mode: Default::default(), + id: connector_mandate_id, + }) + } + + _ => Err(errors::ConnectorError::NotImplemented( + "Payment methods".to_string(), + ))?, + }; + Ok(Self { account_name, amount: Some(item.amount.to_owned()), currency: item.router_data.request.currency.to_string(), - reference: item.router_data.connector_request_reference_id.to_string(), country: item.router_data.get_billing_country()?, capture_mode: Some(requests::CaptureMode::from( item.router_data.request.capture_method, )), - payment_method: requests::PaymentMethod { - payment_method_data, - authentication: None, - encryption: None, - entry_mode: Default::default(), - fingerprint_mode: None, - first_name: None, - id: None, - last_name: None, - name: None, - narrative: None, - storage_mode: None, - }, + payment_method, notifications: Some(requests::Notifications { return_url: get_return_url(item.router_data), - challenge_return_url: None, - decoupled_challenge_return_url: None, status_url: item.router_data.request.webhook_url.clone(), - three_ds_method_return_url: None, cancel_url: get_return_url(item.router_data), }), - authorization_mode: None, - cashback_amount: None, + stored_credential, channel: Default::default(), - convenience_amount: None, - currency_conversion: None, - description: None, - device: None, - gratuity_amount: None, initiator, - ip_address: None, - language: None, - lodging: None, - order: None, - payer_reference: None, - site_reference: None, - stored_credential, - surcharge_amount: None, - total_capture_count: None, - globalpay_payments_request_type: None, - user_reference: None, }) } } @@ -176,6 +231,32 @@ impl TryFrom<&GlobalPayRouterData<&PaymentsCaptureRouterData>> } } +impl TryFrom<&TokenizationRouterData> for requests::GlobalPayPaymentMethodsRequest { + type Error = Error; + fn try_from(item: &TokenizationRouterData) -> Result<Self, Self::Error> { + if !item.request.is_mandate_payment() { + return Err(errors::ConnectorError::FlowNotSupported { + flow: "Tokenization apart from Mandates".to_string(), + connector: "Globalpay".to_string(), + } + .into()); + } + Ok(Self { + reference: item.connector_request_reference_id.clone(), + usage_mode: Some(requests::UsageMode::Multiple), + card: match &item.request.payment_method_data { + payment_method_data::PaymentMethodData::Card(card_data) => Some(requests::Card { + number: card_data.card_number.clone(), + expiry_month: card_data.card_exp_month.clone(), + expiry_year: card_data.get_card_expiry_year_2_digit()?, + cvv: card_data.card_cvc.clone(), + }), + _ => None, + }, + }) + } +} + impl TryFrom<&GlobalpayCancelRouterData<&PaymentsCancelRouterData>> for requests::GlobalpayCancelRequest { @@ -278,73 +359,18 @@ impl From<Option<common_enums::CaptureMethod>> for requests::CaptureMode { } } -fn get_payment_response( - status: common_enums::AttemptStatus, - response: GlobalpayPaymentsResponse, - redirection_data: Option<RedirectForm>, - status_code: u16, -) -> Result<PaymentsResponseData, Box<ErrorResponse>> { - let mandate_reference = response.payment_method.as_ref().and_then(|pm| { - pm.card - .as_ref() - .and_then(|card| card.brand_reference.to_owned()) - .map(|id| MandateReference { - connector_mandate_id: Some(id.expose()), - payment_method_id: None, - mandate_metadata: None, - connector_mandate_request_reference_id: None, - }) - }); - match status { - common_enums::AttemptStatus::Failure => Err(Box::new(ErrorResponse { - message: response - .payment_method - .as_ref() - .and_then(|payment_method| payment_method.message.clone()) - .unwrap_or_else(|| NO_ERROR_MESSAGE.to_string()), - code: response - .payment_method - .as_ref() - .and_then(|payment_method| payment_method.result.clone()) - .unwrap_or_else(|| consts::NO_ERROR_CODE.to_string()), - reason: response - .payment_method - .as_ref() - .and_then(|payment_method| payment_method.message.clone()), - status_code, - attempt_status: Some(status), - connector_transaction_id: Some(response.id), - network_decline_code: response - .payment_method - .as_ref() - .and_then(|payment_method| payment_method.result.clone()), - network_advice_code: None, - network_error_message: response - .payment_method - .as_ref() - .and_then(|payment_method| payment_method.message.clone()), - })), - _ => Ok(PaymentsResponseData::TransactionResponse { - resource_id: ResponseId::ConnectorTransactionId(response.id.clone()), - redirection_data: Box::new(redirection_data), - mandate_reference: Box::new(mandate_reference), - connector_metadata: None, - network_txn_id: None, - connector_response_reference_id: response.reference, - incremental_authorization_allowed: None, - charges: None, - }), - } -} +// } impl<F, T> TryFrom<ResponseRouterData<F, GlobalpayPaymentsResponse, T, PaymentsResponseData>> for RouterData<F, T, PaymentsResponseData> { type Error = Error; + fn try_from( item: ResponseRouterData<F, GlobalpayPaymentsResponse, T, PaymentsResponseData>, ) -> Result<Self, Self::Error> { let status = common_enums::AttemptStatus::from(item.response.status); + let redirect_url = item .response .payment_method @@ -360,12 +386,92 @@ impl<F, T> TryFrom<ResponseRouterData<F, GlobalpayPaymentsResponse, T, PaymentsR Url::parse(url).change_context(errors::ConnectorError::FailedToObtainIntegrationUrl) }) .transpose()?; + let redirection_data = redirect_url.map(|url| RedirectForm::from((url, Method::Get))); + let payment_method_token = item.data.get_payment_method_token(); let status_code = item.http_code; + + let mandate_reference = payment_method_token.ok().and_then(|token| match token { + PaymentMethodToken::Token(token_string) => Some(MandateReference { + connector_mandate_id: Some(token_string.clone().expose()), + payment_method_id: None, + mandate_metadata: None, + connector_mandate_request_reference_id: None, + }), + _ => None, + }); + + let response = match status { + common_enums::AttemptStatus::Failure => Err(Box::new(ErrorResponse { + message: item + .response + .payment_method + .as_ref() + .and_then(|payment_method| payment_method.message.clone()) + .unwrap_or_else(|| NO_ERROR_MESSAGE.to_string()), + code: item + .response + .payment_method + .as_ref() + .and_then(|payment_method| payment_method.result.clone()) + .unwrap_or_else(|| consts::NO_ERROR_CODE.to_string()), + reason: item + .response + .payment_method + .as_ref() + .and_then(|payment_method| payment_method.message.clone()), + status_code, + attempt_status: Some(status), + connector_transaction_id: Some(item.response.id.clone()), + network_decline_code: item + .response + .payment_method + .as_ref() + .and_then(|payment_method| payment_method.result.clone()), + network_advice_code: None, + network_error_message: item + .response + .payment_method + .as_ref() + .and_then(|payment_method| payment_method.message.clone()), + })), + _ => Ok(PaymentsResponseData::TransactionResponse { + resource_id: ResponseId::ConnectorTransactionId(item.response.id.clone()), + redirection_data: Box::new(redirection_data), + mandate_reference: Box::new(mandate_reference), + connector_metadata: None, + network_txn_id: None, + connector_response_reference_id: item.response.reference.clone(), + incremental_authorization_allowed: None, + charges: None, + }), + }; + Ok(Self { status, - response: get_payment_response(status, item.response, redirection_data, status_code) - .map_err(|err| *err), + response: response.map_err(|err| *err), + ..item.data + }) + } +} + +impl<F, T> TryFrom<ResponseRouterData<F, GlobalpayPaymentMethodsResponse, T, PaymentsResponseData>> + for RouterData<F, T, PaymentsResponseData> +{ + type Error = Error; + fn try_from( + item: ResponseRouterData<F, GlobalpayPaymentMethodsResponse, T, PaymentsResponseData>, + ) -> Result<Self, Self::Error> { + let token = item + .response + .payment_method_token_id + .clone() + .unwrap_or_default(); + + Ok(Self { + response: Ok(PaymentsResponseData::TokenizationResponse { + token: token.expose(), + }), ..item.data }) } @@ -467,39 +573,6 @@ pub struct GlobalpayErrorResponse { pub detailed_error_description: String, } -fn get_payment_method_data( - item: &PaymentsAuthorizeRouterData, - brand_reference: Option<String>, -) -> Result<PaymentMethodData, Error> { - match &item.request.payment_method_data { - payment_method_data::PaymentMethodData::Card(ccard) => { - Ok(PaymentMethodData::Card(requests::Card { - number: ccard.card_number.clone(), - expiry_month: ccard.card_exp_month.clone(), - expiry_year: ccard.get_card_expiry_year_2_digit()?, - cvv: ccard.card_cvc.clone(), - account_type: None, - authcode: None, - avs_address: None, - avs_postal_code: None, - brand_reference, - chip_condition: None, - funding: None, - pin_block: None, - tag: None, - track: None, - })) - } - payment_method_data::PaymentMethodData::Wallet(wallet_data) => get_wallet_data(wallet_data), - payment_method_data::PaymentMethodData::BankRedirect(bank_redirect) => { - PaymentMethodData::try_from(bank_redirect) - } - _ => Err(errors::ConnectorError::NotImplemented( - "Payment methods".to_string(), - ))?, - } -} - fn get_return_url(item: &PaymentsAuthorizeRouterData) -> Option<String> { match item.request.payment_method_data.clone() { payment_method_data::PaymentMethodData::Wallet( @@ -516,36 +589,6 @@ fn get_return_url(item: &PaymentsAuthorizeRouterData) -> Option<String> { } } -type MandateDetails = (Option<Initiator>, Option<StoredCredential>, Option<String>); -fn get_mandate_details(item: &PaymentsAuthorizeRouterData) -> Result<MandateDetails, Error> { - Ok(if item.request.is_mandate_payment() { - let connector_mandate_id = item.request.mandate_id.as_ref().and_then(|mandate_ids| { - match mandate_ids.mandate_reference_id.clone() { - Some(api_models::payments::MandateReferenceId::ConnectorMandateId( - connector_mandate_ids, - )) => connector_mandate_ids.get_connector_mandate_id(), - _ => None, - } - }); - ( - Some(match item.request.off_session { - Some(true) => Initiator::Merchant, - _ => Initiator::Payer, - }), - Some(StoredCredential { - model: Some(requests::Model::Recurring), - sequence: Some(match connector_mandate_id.is_some() { - true => Sequence::Subsequent, - false => Sequence::First, - }), - }), - connector_mandate_id, - ) - } else { - (None, None, None) - }) -} - fn get_wallet_data( wallet_data: &payment_method_data::WalletData, ) -> Result<PaymentMethodData, Error> { diff --git a/crates/hyperswitch_connectors/src/utils.rs b/crates/hyperswitch_connectors/src/utils.rs index 143e7474dd3..09a56474c27 100644 --- a/crates/hyperswitch_connectors/src/utils.rs +++ b/crates/hyperswitch_connectors/src/utils.rs @@ -2190,6 +2190,7 @@ impl PaymentsSetupMandateRequestData for SetupMandateRequestData { pub trait PaymentMethodTokenizationRequestData { fn get_browser_info(&self) -> Result<BrowserInformation, Error>; + fn is_mandate_payment(&self) -> bool; } impl PaymentMethodTokenizationRequestData for PaymentMethodTokenizationData { @@ -2198,6 +2199,15 @@ impl PaymentMethodTokenizationRequestData for PaymentMethodTokenizationData { .clone() .ok_or_else(missing_field_err("browser_info")) } + fn is_mandate_payment(&self) -> bool { + ((self.customer_acceptance.is_some() || self.setup_mandate_details.is_some()) + && (self.setup_future_usage == Some(FutureUsage::OffSession))) + || self + .mandate_id + .as_ref() + .and_then(|mandate_ids| mandate_ids.mandate_reference_id.as_ref()) + .is_some() + } } pub trait PaymentsCompleteAuthorizeRequestData { diff --git a/crates/hyperswitch_domain_models/src/router_request_types.rs b/crates/hyperswitch_domain_models/src/router_request_types.rs index b9e2e4a74a6..e919538ea5e 100644 --- a/crates/hyperswitch_domain_models/src/router_request_types.rs +++ b/crates/hyperswitch_domain_models/src/router_request_types.rs @@ -254,6 +254,10 @@ pub struct PaymentMethodTokenizationData { pub currency: storage_enums::Currency, pub amount: Option<i64>, pub split_payments: Option<common_types::payments::SplitPaymentsRequest>, + pub customer_acceptance: Option<common_payments_types::CustomerAcceptance>, + pub setup_future_usage: Option<storage_enums::FutureUsage>, + pub setup_mandate_details: Option<mandates::MandateData>, + pub mandate_id: Option<api_models::payments::MandateIds>, } impl TryFrom<SetupMandateRequestData> for PaymentMethodTokenizationData { @@ -266,6 +270,10 @@ impl TryFrom<SetupMandateRequestData> for PaymentMethodTokenizationData { currency: data.currency, amount: data.amount, split_payments: None, + customer_acceptance: data.customer_acceptance, + setup_future_usage: data.setup_future_usage, + setup_mandate_details: data.setup_mandate_details, + mandate_id: data.mandate_id, }) } } @@ -281,6 +289,10 @@ impl<F> From<&RouterData<F, PaymentsAuthorizeData, response_types::PaymentsRespo currency: data.request.currency, amount: Some(data.request.amount), split_payments: data.request.split_payments.clone(), + customer_acceptance: data.request.customer_acceptance.clone(), + setup_future_usage: data.request.setup_future_usage, + setup_mandate_details: data.request.setup_mandate_details.clone(), + mandate_id: data.request.mandate_id.clone(), } } } @@ -295,6 +307,10 @@ impl TryFrom<PaymentsAuthorizeData> for PaymentMethodTokenizationData { currency: data.currency, amount: Some(data.amount), split_payments: data.split_payments.clone(), + customer_acceptance: data.customer_acceptance, + setup_future_usage: data.setup_future_usage, + setup_mandate_details: data.setup_mandate_details, + mandate_id: data.mandate_id, }) } } @@ -314,6 +330,10 @@ impl TryFrom<CompleteAuthorizeData> for PaymentMethodTokenizationData { currency: data.currency, amount: Some(data.amount), split_payments: None, + customer_acceptance: data.customer_acceptance, + setup_future_usage: data.setup_future_usage, + setup_mandate_details: data.setup_mandate_details, + mandate_id: data.mandate_id, }) } } diff --git a/crates/router/src/configs/settings.rs b/crates/router/src/configs/settings.rs index ae4c8a3cda0..f381712ddfc 100644 --- a/crates/router/src/configs/settings.rs +++ b/crates/router/src/configs/settings.rs @@ -620,6 +620,13 @@ pub struct PaymentMethodTokenFilter { pub payment_method_type: Option<PaymentMethodTypeTokenFilter>, pub long_lived_token: bool, pub apple_pay_pre_decrypt_flow: Option<ApplePayPreDecryptFlow>, + pub flow: Option<PaymentFlow>, +} + +#[derive(Debug, Deserialize, Clone, PartialEq)] +#[serde(deny_unknown_fields, rename_all = "snake_case")] +pub enum PaymentFlow { + Mandates, } #[derive(Debug, Deserialize, Clone, Default)] diff --git a/crates/router/src/core/payment_methods.rs b/crates/router/src/core/payment_methods.rs index 4a23f04cda6..b9d17129249 100644 --- a/crates/router/src/core/payment_methods.rs +++ b/crates/router/src/core/payment_methods.rs @@ -3249,6 +3249,10 @@ async fn create_single_use_tokenization_flow( currency: api_models::enums::Currency::default(), amount: None, split_payments: None, + mandate_id: None, + setup_future_usage: None, + customer_acceptance: None, + setup_mandate_details: None, }; let payment_method_session_address = types::PaymentAddress::new( @@ -3317,12 +3321,12 @@ async fn create_single_use_tokenization_flow( is_payment_id_from_merchant: None, }; - let payment_method_token_response = tokenization::add_token_for_payment_method( + let payment_method_token_response = Box::pin(tokenization::add_token_for_payment_method( &mut router_data, payment_method_data_request.clone(), state.clone(), &merchant_connector_account_details.clone(), - ) + )) .await?; let token_response = payment_method_token_response.token.map_err(|err| { diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs index cc6f3384a22..b5c04cfc927 100644 --- a/crates/router/src/core/payments.rs +++ b/crates/router/src/core/payments.rs @@ -106,7 +106,7 @@ use crate::core::routing::helpers as routing_helpers; #[cfg(all(feature = "v1", feature = "dynamic_routing"))] use crate::types::api::convert_connector_data_to_routable_connectors; use crate::{ - configs::settings::{ApplePayPreDecryptFlow, PaymentMethodTypeTokenFilter}, + configs::settings::{ApplePayPreDecryptFlow, PaymentFlow, PaymentMethodTypeTokenFilter}, consts, core::{ errors::{self, CustomResult, RouterResponse, RouterResult}, @@ -6153,6 +6153,7 @@ fn is_payment_method_tokenization_enabled_for_connector( payment_method: storage::enums::PaymentMethod, payment_method_type: Option<storage::enums::PaymentMethodType>, payment_method_token: Option<&PaymentMethodToken>, + mandate_flow_enabled: Option<storage_enums::FutureUsage>, ) -> RouterResult<bool> { let connector_tokenization_filter = state.conf.tokenization.0.get(connector_name); @@ -6171,10 +6172,29 @@ fn is_payment_method_tokenization_enabled_for_connector( payment_method_token, connector_filter.apple_pay_pre_decrypt_flow.clone(), ) + && is_payment_flow_allowed_for_connector( + mandate_flow_enabled, + connector_filter.flow.clone(), + ) }) .unwrap_or(false)) } +fn is_payment_flow_allowed_for_connector( + mandate_flow_enabled: Option<storage_enums::FutureUsage>, + payment_flow: Option<PaymentFlow>, +) -> bool { + if payment_flow.is_none() { + true + } else { + matches!(payment_flow, Some(PaymentFlow::Mandates)) + && matches!( + mandate_flow_enabled, + Some(storage_enums::FutureUsage::OffSession) + ) + } +} + fn is_apple_pay_pre_decrypt_type_connector_tokenization( payment_method_type: Option<storage::enums::PaymentMethodType>, payment_method_token: Option<&PaymentMethodToken>, @@ -6500,6 +6520,10 @@ where .get_required_value("payment_method")?; let payment_method_type = payment_data.get_payment_attempt().payment_method_type; + let mandate_flow_enabled = payment_data + .get_payment_attempt() + .setup_future_usage_applied; + let is_connector_tokenization_enabled = is_payment_method_tokenization_enabled_for_connector( state, @@ -6507,6 +6531,7 @@ where payment_method, payment_method_type, payment_data.get_payment_method_token(), + mandate_flow_enabled, )?; let payment_method_action = decide_payment_method_tokenize_action( @@ -8341,7 +8366,7 @@ where .change_context(errors::ApiErrorResponse::InternalServerError) .attach_printable("Failed to get the common mandate reference")?; - let connector_mandate_details = connector_common_mandate_details.payments; + let connector_mandate_details = connector_common_mandate_details.payments.clone(); let mut connector_choice = None; diff --git a/crates/router/src/core/payments/helpers.rs b/crates/router/src/core/payments/helpers.rs index 4a023f7d8c4..0b1758990ab 100644 --- a/crates/router/src/core/payments/helpers.rs +++ b/crates/router/src/core/payments/helpers.rs @@ -2039,8 +2039,7 @@ pub fn decide_payment_method_retrieval_action( pub async fn is_ucs_enabled(state: &SessionState, config_key: &str) -> bool { let db = state.store.as_ref(); - let is_enabled = db - .find_config_by_key_unwrap_or(config_key, Some("false".to_string())) + db.find_config_by_key_unwrap_or(config_key, Some("false".to_string())) .await .map_err(|error| { logger::error!( @@ -2053,9 +2052,7 @@ pub async fn is_ucs_enabled(state: &SessionState, config_key: &str) -> bool { logger::error!(?error, "Failed to parse `{config_key}` UCS enabled config"); }) }) - .unwrap_or(false); - - is_enabled + .unwrap_or(false) } pub async fn should_execute_based_on_rollout( diff --git a/crates/router/tests/connectors/square.rs b/crates/router/tests/connectors/square.rs index 81ea8112276..760e8ebdaea 100644 --- a/crates/router/tests/connectors/square.rs +++ b/crates/router/tests/connectors/square.rs @@ -68,6 +68,10 @@ fn token_details() -> Option<types::PaymentMethodTokenizationData> { amount: None, currency: enums::Currency::USD, split_payments: None, + mandate_id: None, + setup_future_usage: None, + customer_acceptance: None, + setup_mandate_details: None, }) } @@ -442,6 +446,10 @@ async fn should_fail_payment_for_incorrect_cvc() { amount: None, currency: enums::Currency::USD, split_payments: None, + mandate_id: None, + setup_future_usage: None, + customer_acceptance: None, + setup_mandate_details: None, }), get_default_payment_info(None), ) @@ -474,6 +482,10 @@ async fn should_fail_payment_for_invalid_exp_month() { amount: None, currency: enums::Currency::USD, split_payments: None, + mandate_id: None, + setup_future_usage: None, + customer_acceptance: None, + setup_mandate_details: None, }), get_default_payment_info(None), ) @@ -506,6 +518,10 @@ async fn should_fail_payment_for_incorrect_expiry_year() { amount: None, currency: enums::Currency::USD, split_payments: None, + mandate_id: None, + setup_future_usage: None, + customer_acceptance: None, + setup_mandate_details: None, }), get_default_payment_info(None), ) diff --git a/crates/router/tests/connectors/stax.rs b/crates/router/tests/connectors/stax.rs index 93c2394354b..89b1bc7f4b9 100644 --- a/crates/router/tests/connectors/stax.rs +++ b/crates/router/tests/connectors/stax.rs @@ -73,6 +73,10 @@ fn token_details() -> Option<types::PaymentMethodTokenizationData> { amount: None, currency: enums::Currency::USD, split_payments: None, + mandate_id: None, + setup_future_usage: None, + customer_acceptance: None, + setup_mandate_details: None, }) } @@ -484,6 +488,10 @@ async fn should_fail_payment_for_incorrect_cvc() { amount: None, currency: enums::Currency::USD, split_payments: None, + mandate_id: None, + setup_future_usage: None, + customer_acceptance: None, + setup_mandate_details: None, }), get_default_payment_info(connector_customer_id, None), ) @@ -523,6 +531,10 @@ async fn should_fail_payment_for_invalid_exp_month() { amount: None, currency: enums::Currency::USD, split_payments: None, + mandate_id: None, + setup_future_usage: None, + customer_acceptance: None, + setup_mandate_details: None, }), get_default_payment_info(connector_customer_id, None), ) @@ -562,6 +574,10 @@ async fn should_fail_payment_for_incorrect_expiry_year() { amount: None, currency: enums::Currency::USD, split_payments: None, + mandate_id: None, + setup_future_usage: None, + customer_acceptance: None, + setup_mandate_details: None, }), get_default_payment_info(connector_customer_id, None), ) diff --git a/crates/router/tests/connectors/utils.rs b/crates/router/tests/connectors/utils.rs index e3884894b33..a8676834040 100644 --- a/crates/router/tests/connectors/utils.rs +++ b/crates/router/tests/connectors/utils.rs @@ -1121,6 +1121,10 @@ impl Default for TokenType { amount: Some(100), currency: enums::Currency::USD, split_payments: None, + mandate_id: None, + setup_future_usage: None, + customer_acceptance: None, + setup_mandate_details: None, }; Self(data) } diff --git a/loadtest/config/development.toml b/loadtest/config/development.toml index b0bc2e9ee1c..0d1e27961d4 100644 --- a/loadtest/config/development.toml +++ b/loadtest/config/development.toml @@ -591,6 +591,7 @@ mollie = { long_lived_token = false, payment_method = "card" } braintree = { long_lived_token = false, payment_method = "card" } gocardless = { long_lived_token = true, payment_method = "bank_debit" } billwerk = { long_lived_token = false, payment_method = "card" } +globalpay = { long_lived_token = false, payment_method = "card", flow = "mandates" } [connector_customer] connector_list = "adyen,facilitapay,gocardless,hyperswitch_vault,stax,stripe"

2025-07-07T11:53:46Z

## Type of Change  - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  In One-off payments, we donot need to create the token. Just passing raw cards would be enough. In CITs, we need to create a token and store it in `connector_mandate_id` for future MITs but while executing the CIT, raw cards need to be passed. In MITs, we need to use that previously stored token in CIT and no more need to hit the tokenization endpoint at connector. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [x] This PR modifies application configuration/environment variables  ## Motivation and Context  ## How did you test it?  1. Payments Create - One-off cURL: ``` curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_v5jp7Ow9W5g6tgWaDHs4UR385iFfpg9dXQGYQkxxRXQdHlcvR70WmjJRPWJt7Xe7' \ --header 'Cookie: PHPSESSID=0b47db9d7de94c37b6b272087a9f2fa7' \ --data-raw '{ "currency":"USD", "amount": 300, "confirm": true, "amount_to_capture": 300, "capture_method": "automatic", "capture_on": "2022-09-10T10:11:12Z", "authentication_type": "no_three_ds", "return_url": "https://www.google.com", "email": "[email protected]", "name": "Joseph Doe", "phone": "999999999", "phone_country_code": "+65", "description": "Its my first payment request", "statement_descriptor_name": "Juspay", "statement_descriptor_suffix": "Router", "payment_method": "card", "payment_method_type": "credit", "payment_method_data": { "card": { "card_number": "4242424242424242", "card_exp_month": "03", "card_exp_year": "2030", "card_holder_name": "joseph Doe", "card_cvc": "737" } }, "billing": { "address": { "line1": "1467", "line2": "CA", "line3": "Harrison Street", "city": "San Fransico", "state": "CA", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" }, "phone": { "number": "8056594427", "country_code": "+91" } }, "browser_info": { "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8", "language": "nl-NL", "color_depth": 24, "screen_height": 723, "screen_width": 1536, "time_zone": 0, "java_enabled": true, "java_script_enabled": true, "ip_address": "109.71.40.0" }, "metadata": { "order_category": "applepay" }, "order_details": [ { "product_name": "Apple iphone 15", "quantity": 1, "amount": 300, "account_name": "transaction_processing" } ] }' ``` Response: ``` { "payment_id": "pay_j2mMaanCWkdCD2ytx5gg", "merchant_id": "merchant_1751871882", "status": "succeeded", "amount": 300, "net_amount": 300, "shipping_cost": null, "amount_capturable": 0, "amount_received": 300, "connector": "globalpay", "client_secret": "pay_j2mMaanCWkdCD2ytx5gg_secret_CqzsQEqF82ClZdEAoVF3", "created": "2025-07-07T11:03:44.204Z", "currency": "USD", "customer_id": null, "customer": { "id": null, "name": "Joseph Doe", "email": "[email protected]", "phone": "999999999", "phone_country_code": "+65" }, "description": "Its my first payment request", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "card", "payment_method_data": { "card": { "last4": "4242", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "424242", "card_extended_bin": null, "card_exp_month": "03", "card_exp_year": "2030", "card_holder_name": "joseph Doe", "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "CA", "line3": "Harrison Street", "zip": "94122", "state": "CA", "first_name": "joseph", "last_name": "Doe" }, "phone": { "number": "8056594427", "country_code": "+91" }, "email": null }, "order_details": [ { "brand": null, "amount": 300, "category": null, "quantity": 1, "tax_rate": null, "product_id": null, "product_name": "Apple iphone 15", "product_type": null, "sub_category": null, "product_img_link": null, "product_tax_code": null, "total_tax_amount": null, "requires_shipping": null } ], "email": null, "name": null, "phone": null, "return_url": "https://www.google.com/", "authentication_type": "no_three_ds", "statement_descriptor_name": "Juspay", "statement_descriptor_suffix": "Router", "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "credit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": false, "connector_transaction_id": "TRN_IORyBbPseO4Qiy0L2v8YpZpgWA9auN_dCD2ytx5gg_1", "frm_message": null, "metadata": { "order_category": "applepay" }, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_j2mMaanCWkdCD2ytx5gg_1", "payment_link": null, "profile_id": "pro_GIxd8tTl8PWNt9L2ynbr", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_ghTQYltef3iCpp4cdsVu", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-07-07T11:18:44.204Z", "fingerprint": null, "browser_info": { "language": "nl-NL", "time_zone": 0, "ip_address": "109.71.40.0", "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "color_depth": 24, "java_enabled": true, "screen_width": 1536, "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8", "screen_height": 723, "java_script_enabled": true }, "payment_method_id": null, "payment_method_status": null, "updated": "2025-07-07T11:03:46.731Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` 2. CIT using `mandate_id` Request: ``` curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_otcCi6DyRzeDWx38OH5BTLBjBK1WS7Jt1BbsMpPepSR2Rr5dIPgVgPMoeekaqoXL' \ --header 'Cookie: PHPSESSID=0b47db9d7de94c37b6b272087a9f2fa7' \ --data-raw '{ "amount": 6000, "all_keys_required": true, "currency": "USD", "confirm": true, "capture_method": "automatic", "capture_on": "2022-09-10T10:11:12Z", "customer_id": "cus_LI9DQMmb1tHRjnfnkjwknjfXtonFkU", "email": "[email protected]", "name": "John Doe", "phone": "999999999", "phone_country_code": "+65", "description": "Its my first payment request", "authentication_type": "no_three_ds", "return_url": "https://example.com", "payment_method": "card", "payment_method_type": "debit", "payment_method_data": { "card": { "card_number": "4111111111111111", "card_exp_month": "12", "card_exp_year": "2030", "card_holder_name": "joseph Doe", "card_cvc": "123" } }, "setup_future_usage": "off_session", "customer_acceptance": { "acceptance_type": "offline", "accepted_at": "1963-05-03T04:07:52.723Z", "online": { "ip_address": "in sit", "user_agent": "amet irure esse" } }, "mandate_data": { "customer_acceptance": { "acceptance_type": "offline", "accepted_at": "1963-05-03T04:07:52.723Z", "online": { "ip_address": "127.0.0.1", "user_agent": "amet irure esse" } }, "mandate_type": { "single_use": { "amount": 8000, "currency": "USD" } } }, "payment_type": "new_mandate", "billing": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "john", "last_name": "Doe" } }, "shipping": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "john", "last_name": "Doe" } }, "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "metadata": { "udf1": "value1", "new_customer": "true", "login_date": "2019-09-10T10:11:12Z" }, "browser_info": { "ip_address": "129.0.0.1", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36", "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8", "language": "en-US", "color_depth": 32, "screen_height": 1117, "screen_width": 1728, "time_zone": -330, "java_enabled": true, "java_script_enabled": true } }' ``` Response: ``` { "payment_id": "pay_pgbcY6mXYI4IYk2Zt5kc", "merchant_id": "merchant_1753277415", "status": "succeeded", "amount": 6000, "net_amount": 6000, "shipping_cost": null, "amount_capturable": 0, "amount_received": 6000, "connector": "globalpay", "client_secret": "pay_pgbcY6mXYI4IYk2Zt5kc_secret_H0sK1auIjNZsIcfjVE1d", "created": "2025-07-23T17:30:07.918Z", "currency": "USD", "customer_id": "cus_LI9DQMmb1tHRjnfnkjwknjfXtonFkU", "customer": { "id": "cus_LI9DQMmb1tHRjnfnkjwknjfXtonFkU", "name": "John Doe", "email": "[email protected]", "phone": "999999999", "phone_country_code": "+65" }, "description": "Its my first payment request", "refunds": null, "disputes": null, "mandate_id": "man_bRinPSQhGM8Pky90uBNb", "mandate_data": { "update_mandate_id": null, "customer_acceptance": { "acceptance_type": "offline", "accepted_at": "1963-05-03T04:07:52.723Z", "online": { "ip_address": "127.0.0.1", "user_agent": "amet irure esse" } }, "mandate_type": { "single_use": { "amount": 8000, "currency": "USD", "start_date": null, "end_date": null, "metadata": null } } }, "setup_future_usage": "off_session", "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "card", "payment_method_data": { "card": { "last4": "1111", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "411111", "card_extended_bin": null, "card_exp_month": "12", "card_exp_year": "2030", "card_holder_name": "joseph Doe", "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "john", "last_name": "Doe" }, "phone": null, "email": null }, "billing": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "john", "last_name": "Doe" }, "phone": null, "email": null }, "order_details": null, "email": "[email protected]", "name": "John Doe", "phone": "999999999", "return_url": "https://example.com/", "authentication_type": "no_three_ds", "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "debit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": { "customer_id": "cus_LI9DQMmb1tHRjnfnkjwknjfXtonFkU", "created_at": 1753291807, "expires": 1753295407, "secret": "epk_222a00737e6c47d181b899d8afc76813" }, "manual_retry_allowed": false, "connector_transaction_id": "TRN_gBpefdKHlBxfmgVgFSlfPuCQXj86TT_4IYk2Zt5kc_1", "frm_message": null, "metadata": { "udf1": "value1", "login_date": "2019-09-10T10:11:12Z", "new_customer": "true" }, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_pgbcY6mXYI4IYk2Zt5kc_1", "payment_link": null, "profile_id": "pro_roCz974ra9LQxsifUris", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_5Y545k7TI4upQYSbJJ9L", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-07-23T17:45:07.918Z", "fingerprint": null, "browser_info": { "language": "en-US", "time_zone": -330, "ip_address": "129.0.0.1", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36", "color_depth": 32, "java_enabled": true, "screen_width": 1728, "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8", "screen_height": 1117, "java_script_enabled": true }, "payment_method_id": "pm_uDtgQsunDERQMrEXxbcy", "payment_method_status": null, "updated": "2025-07-23T17:30:11.412Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": "{\"id\":\"TRN_gBpefdKHlBxfmgVgFSlfPuCQXj86TT_4IYk2Zt5kc_1\",\"time_created\":\"2025-07-23T17:30:11.323Z\",\"type\":\"SALE\",\"status\":\"CAPTURED\",\"channel\":\"CNP\",\"capture_mode\":\"AUTO\",\"amount\":\"6000\",\"currency\":\"USD\",\"country\":\"US\",\"merchant_id\":\"MER_7e3e2c7df34f42819b3edee31022ee3f\",\"merchant_name\":\"Sandbox_merchant_3\",\"account_id\":\"TRA_c9967ad7d8ec4b46b6dd44a61cde9a91\",\"account_name\":\"transaction_processing\",\"reference\":\"pay_pgbcY6mXYI4IYk2Zt5kc_1\",\"payment_method\":{\"result\":\"00\",\"message\":\"(00)[ test system ] Authorised\",\"entry_mode\":\"ECOM\",\"card\":{\"brand\":\"VISA\",\"masked_number_last4\":\"XXXXXXXXXXXX1111\",\"authcode\":\"123456\",\"brand_reference\":\"R0LEZpZE51h4fEcD\",\"brand_time_created\":\"\",\"cvv_result\":\"MATCHED\",\"provider\":{\"result\":\"00\",\"cvv_result\":\"M\",\"avs_address_result\":\"M\",\"avs_postal_code_result\":\"M\"}}},\"risk_assessment\":[{\"mode\":\"ACTIVE\",\"result\":\"ACCEPTED\",\"rules\":[{\"reference\":\"0c93a6c9-7649-4822-b5ea-1efa356337fd\",\"description\":\"Cardholder Name Rule\",\"mode\":\"ACTIVE\",\"result\":\"ACCEPTED\"},{\"reference\":\"a539d51a-abc1-4fff-a38e-b34e00ad0cc3\",\"description\":\"CardNumber block\",\"mode\":\"ACTIVE\",\"result\":\"ACCEPTED\"},{\"reference\":\"d023a19e-6985-4fda-bb9b-5d4e0dedbb1e\",\"description\":\"Amount test\",\"mode\":\"ACTIVE\",\"result\":\"ACCEPTED\"}]}],\"batch_id\":\"BAT_1558804\",\"action\":{\"id\":\"ACT_gBpefdKHlBxfmgVgFSlfPuCQXj86TT\",\"type\":\"AUTHORIZE\",\"time_created\":\"2025-07-23T17:30:11.323Z\",\"result_code\":\"SUCCESS\",\"app_id\":\"OXKlGGm6ecZLIqMyRgPHRfMxdUAiEcp8\",\"app_name\":\"rotate_again\"}}" } ``` 3. MIT using `mandate_id` Request: ``` curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_otcCi6DyRzeDWx38OH5BTLBjBK1WS7Jt1BbsMpPepSR2Rr5dIPgVgPMoeekaqoXL' \ --header 'Cookie: PHPSESSID=0b47db9d7de94c37b6b272087a9f2fa7' \ --data '{ "amount": 6000, "currency": "USD", "capture_method": "automatic", "off_session": true, "confirm": true, "description": "Initiated by merchant", "mandate_id": "man_bRinPSQhGM8Pky90uBNb", "customer_id": "cus_LI9DQMmb1tHRjnfnkjwknjfXtonFkU" }' ``` Response: ``` { "payment_id": "pay_RI5mPEtiRZOUPPBEckqZ", "merchant_id": "merchant_1753277415", "status": "succeeded", "amount": 6000, "net_amount": 6000, "shipping_cost": null, "amount_capturable": 0, "amount_received": 6000, "connector": "globalpay", "client_secret": "pay_RI5mPEtiRZOUPPBEckqZ_secret_Aj61vZbZEdJkamRrE2EK", "created": "2025-07-23T17:30:20.230Z", "currency": "USD", "customer_id": "cus_LI9DQMmb1tHRjnfnkjwknjfXtonFkU", "customer": { "id": "cus_LI9DQMmb1tHRjnfnkjwknjfXtonFkU", "name": "John Doe", "email": "[email protected]", "phone": "999999999", "phone_country_code": "+65" }, "description": "Initiated by merchant", "refunds": null, "disputes": null, "mandate_id": "man_bRinPSQhGM8Pky90uBNb", "mandate_data": null, "setup_future_usage": null, "off_session": true, "capture_on": null, "capture_method": "automatic", "payment_method": "card", "payment_method_data": { "card": { "last4": "1111", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "411111", "card_extended_bin": null, "card_exp_month": "12", "card_exp_year": "2030", "card_holder_name": "joseph Doe", "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": "23420a93-c0ad-435f-885f-2d57c30c14d9", "shipping": null, "billing": null, "order_details": null, "email": "[email protected]", "name": "John Doe", "phone": "999999999", "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "debit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": { "customer_id": "cus_LI9DQMmb1tHRjnfnkjwknjfXtonFkU", "created_at": 1753291820, "expires": 1753295420, "secret": "epk_ceed93e4ac414b0ea6c2f454b9187067" }, "manual_retry_allowed": false, "connector_transaction_id": "TRN_VlfWAjrCer1pEZaQ7BRJsxE9tqGHnn_OUPPBEckqZ_1", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_RI5mPEtiRZOUPPBEckqZ_1", "payment_link": null, "profile_id": "pro_roCz974ra9LQxsifUris", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_5Y545k7TI4upQYSbJJ9L", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-07-23T17:45:20.230Z", "fingerprint": null, "browser_info": null, "payment_method_id": "pm_uDtgQsunDERQMrEXxbcy", "payment_method_status": "active", "updated": "2025-07-23T17:30:23.884Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": "PMT_9fd7c105-65f1-4b54-9b3f-d3f34c35100d", "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` 4. CIT using `payment_method_id` cURL: ``` curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_otcCi6DyRzeDWx38OH5BTLBjBK1WS7Jt1BbsMpPepSR2Rr5dIPgVgPMoeekaqoXL' \ --header 'Cookie: PHPSESSID=0b47db9d7de94c37b6b272087a9f2fa7' \ --data-raw '{ "amount": 1650, "currency": "USD", "connector": ["globalpay"], "confirm": true, "customer_id": "customer123ffffa", "setup_future_usage": "off_session", "payment_method_type": "debit", "payment_method": "card", "payment_method_data": { "card": { "card_number": "4111111111111111", "card_exp_month": "03", "card_exp_year": "30", "card_holder_name": "joseph Doe", "card_cvc": "737" } }, "billing": { "address": { "first_name": "joseph", "last_name": "Doe", "country": "US" } }, "email": "[email protected]", "customer_acceptance": { "acceptance_type": "offline" } }' ``` Response: ``` { "payment_id": "pay_CNM35m7O7JfdmH9qYyFq", "merchant_id": "merchant_1753277415", "status": "succeeded", "amount": 1650, "net_amount": 1650, "shipping_cost": null, "amount_capturable": 0, "amount_received": 1650, "connector": "globalpay", "client_secret": "pay_CNM35m7O7JfdmH9qYyFq_secret_uz67njQIBT8dhkSR2jcr", "created": "2025-07-23T17:29:50.150Z", "currency": "USD", "customer_id": "customer123ffffa", "customer": { "id": "customer123ffffa", "name": null, "email": "[email protected]", "phone": null, "phone_country_code": null }, "description": null, "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": "off_session", "off_session": null, "capture_on": null, "capture_method": null, "payment_method": "card", "payment_method_data": { "card": { "last4": "1111", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "411111", "card_extended_bin": null, "card_exp_month": "03", "card_exp_year": "30", "card_holder_name": "joseph Doe", "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": null, "country": "US", "line1": null, "line2": null, "line3": null, "zip": null, "state": null, "first_name": "joseph", "last_name": "Doe" }, "phone": null, "email": null }, "order_details": null, "email": "[email protected]", "name": null, "phone": null, "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "debit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": { "customer_id": "customer123ffffa", "created_at": 1753291790, "expires": 1753295390, "secret": "epk_b79f5365965648aea900af73ee98fc51" }, "manual_retry_allowed": false, "connector_transaction_id": "TRN_hR9reO0fbf15HP7SDBznXeKNnhvb6u_fdmH9qYyFq_1", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_CNM35m7O7JfdmH9qYyFq_1", "payment_link": null, "profile_id": "pro_roCz974ra9LQxsifUris", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_5Y545k7TI4upQYSbJJ9L", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-07-23T17:44:50.150Z", "fingerprint": null, "browser_info": null, "payment_method_id": "pm_P66KYq7rG0B7f7RENNf2", "payment_method_status": "active", "updated": "2025-07-23T17:29:53.258Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": "PMT_d6001c7b-6150-404d-92f3-56b217fb8a3d", "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` 5. MIT using `payment_method_id` cURL: ``` curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_otcCi6DyRzeDWx38OH5BTLBjBK1WS7Jt1BbsMpPepSR2Rr5dIPgVgPMoeekaqoXL' \ --header 'Cookie: PHPSESSID=0b47db9d7de94c37b6b272087a9f2fa7' \ --data '{ "amount": 179, "currency": "USD", "confirm": true, "customer_id": "customer123ffffa", "recurring_details": { "type": "payment_method_id", "data": "pm_P66KYq7rG0B7f7RENNf2" }, "off_session": true }' ``` Response: ``` { "payment_id": "pay_6pONwGPfaI6X8zmyOPcS", "merchant_id": "merchant_1753277415", "status": "succeeded", "amount": 179, "net_amount": 179, "shipping_cost": null, "amount_capturable": 0, "amount_received": 179, "connector": "globalpay", "client_secret": "pay_6pONwGPfaI6X8zmyOPcS_secret_XRjvCntYf6esUICifOQg", "created": "2025-07-23T17:30:01.371Z", "currency": "USD", "customer_id": "customer123ffffa", "customer": { "id": "customer123ffffa", "name": null, "email": "[email protected]", "phone": null, "phone_country_code": null }, "description": null, "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": true, "capture_on": null, "capture_method": null, "payment_method": "card", "payment_method_data": { "card": { "last4": "1111", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "411111", "card_extended_bin": null, "card_exp_month": "03", "card_exp_year": "30", "card_holder_name": "joseph Doe", "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": null, "billing": null, "order_details": null, "email": "[email protected]", "name": null, "phone": null, "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "debit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": { "customer_id": "customer123ffffa", "created_at": 1753291801, "expires": 1753295401, "secret": "epk_66d9de3b79db4ee3b35e9dd6db9c18e4" }, "manual_retry_allowed": false, "connector_transaction_id": "TRN_xgxrFV1PkebYZKabeA2R4qN63rqTka_6X8zmyOPcS_1", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_6pONwGPfaI6X8zmyOPcS_1", "payment_link": null, "profile_id": "pro_roCz974ra9LQxsifUris", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_5Y545k7TI4upQYSbJJ9L", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-07-23T17:45:01.371Z", "fingerprint": null, "browser_info": null, "payment_method_id": "pm_P66KYq7rG0B7f7RENNf2", "payment_method_status": "active", "updated": "2025-07-23T17:30:05.264Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": "PMT_d6001c7b-6150-404d-92f3-56b217fb8a3d", "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` ## Cypress test <details> <summary> Globalpay </summary> <img width="490" height="1088" alt="Screenshot 2025-07-15 at 7 31 52 PM" src="https://github.com/user-attachments/assets/fc412951-43e1-4be9-bd07-28c7980db3a4" /> </details> ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

260df2836cea8f9aa7448888d3b61e942eda313b

juspay/hyperswitch

juspay__hyperswitch-8467

Bug: [FEATURE] multisafepay : addpayment methods | TRUSTLY | WeChatpay | Alipay ### Feature Description Integrate 1. Turstly 2. WeChatPay 3. Alipay ### Possible Implementation Integrate the redirection flows for the wallet ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? Yes, I am willing to submit a PR!

diff --git a/config/deployments/integration_test.toml b/config/deployments/integration_test.toml index 513cb587176..e04583cbfb5 100644 --- a/config/deployments/integration_test.toml +++ b/config/deployments/integration_test.toml @@ -541,6 +541,9 @@ paypal = { country = "AF,AX,AL,DZ,AS,AD,AO,AI,AQ,AG,AR,AM,AW,AU,AT,AZ,BS,BH,BD,B giropay = { country = "DE", currency = "EUR" } ideal = { country = "NL", currency = "EUR" } klarna = { country = "AT,BE,DK,FI,FR,DE,IT,NL,NO,PT,ES,SE,GB", currency = "DKK,EUR,GBP,NOK,SEK" } +trustly = { country = "AT,CZ,DK,EE,FI,DE,LV,LT,NL,NO,PL,PT,ES,SE,GB" , currency = "EUR,GBP,SEK"} +ali_pay = {currency = "EUR,USD"} +we_chat_pay = { currency = "EUR"} [pm_filters.cashtocode] classic = { country = "AF,AX,AL,DZ,AS,AD,AO,AI,AQ,AG,AR,AM,AW,AU,AT,AZ,BS,BH,BD,BB,BY,BE,BZ,BJ,BM,BT,BO,BQ,BA,BW,BV,BR,IO,BN,BG,BF,BI,KH,CM,CA,CV,KY,CF,TD,CL,CN,CX,CC,CO,KM,CG,CD,CK,CR,CI,HR,CU,CW,CY,CZ,DK,DJ,DM,DO,EC,EG,SV,GQ,ER,EE,ET,FK,FO,FJ,FI,FR,GF,PF,TF,GA,GM,GE,DE,GH,GI,GR,GL,GD,GP,GU,GT,GG,GN,GW,GY,HT,HM,VA,HN,HK,HU,IS,IN,ID,IR,IQ,IE,IM,IL,IT,JM,JP,JE,JO,KZ,KE,KI,KP,KR,KW,KG,LA,LV,LB,LS,LR,LY,LI,LT,LU,MO,MK,MG,MW,MY,MV,ML,MT,MH,MQ,MR,MU,YT,MX,FM,MD,MC,MN,ME,MS,MA,MZ,MM,NA,NR,NP,NL,NC,NZ,NI,NE,NG,NU,NF,MP,NO,OM,PK,PW,PS,PA,PG,PY,PE,PH,PN,PL,PT,PR,QA,RE,RO,RU,RW,BL,SH,KN,LC,MF,PM,VC,WS,SM,ST,SA,SN,RS,SC,SL,SG,SX,SK,SI,SB,SO,ZA,GS,SS,ES,LK,SD,SR,SJ,SZ,SE,CH,SY,TW,TJ,TZ,TH,TL,TG,TK,TO,TT,TN,TR,TM,TC,TV,UG,UA,AE,GB,UM,UY,UZ,VU,VE,VN,VG,VI,WF,EH,YE,ZM,ZW,US", currency = "AED,AFN,ALL,AMD,ANG,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BHD,BIF,BMD,BND,BOB,BRL,BSD,BTN,BWP,BYN,BZD,CAD,CDF,CHF,CLF,CLP,CNY,COP,CRC,CUC,CUP,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ERN,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,IQD,IRR,ISK,JMD,JOD,JPY,KES,KGS,KHR,KMF,KPW,KRW,KWD,KYD,KZT,LAK,LBP,LKR,LRD,LSL,LYD,MAD,MDL,MGA,MKD,MMK,MNT,MOP,MRU,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SDG,SEK,SGD,SHP,SLE,SLL,SOS,SRD,SSP,STD,STN,SVC,SYP,SZL,THB,TJS,TMT,TND,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VES,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL" } diff --git a/config/deployments/production.toml b/config/deployments/production.toml index 4b990ad0464..eba6e2334b7 100644 --- a/config/deployments/production.toml +++ b/config/deployments/production.toml @@ -524,6 +524,9 @@ paypal = { country = "AF,AX,AL,DZ,AS,AD,AO,AI,AQ,AG,AR,AM,AW,AU,AT,AZ,BS,BH,BD,B giropay = { country = "DE", currency = "EUR" } ideal = { country = "NL", currency = "EUR" } klarna = { country = "AT,BE,DK,FI,FR,DE,IT,NL,NO,PT,ES,SE,GB", currency = "DKK,EUR,GBP,NOK,SEK" } +trustly = { country = "AT,CZ,DK,EE,FI,DE,LV,LT,NL,NO,PL,PT,ES,SE,GB" , currency = "EUR,GBP,SEK"} +ali_pay = {currency = "EUR,USD"} +we_chat_pay = { currency = "EUR"} [pm_filters.cashtocode] classic = { country = "AF,AX,AL,DZ,AS,AD,AO,AI,AQ,AG,AR,AM,AW,AU,AT,AZ,BS,BH,BD,BB,BY,BE,BZ,BJ,BM,BT,BO,BQ,BA,BW,BV,BR,IO,BN,BG,BF,BI,KH,CM,CA,CV,KY,CF,TD,CL,CN,CX,CC,CO,KM,CG,CD,CK,CR,CI,HR,CU,CW,CY,CZ,DK,DJ,DM,DO,EC,EG,SV,GQ,ER,EE,ET,FK,FO,FJ,FI,FR,GF,PF,TF,GA,GM,GE,DE,GH,GI,GR,GL,GD,GP,GU,GT,GG,GN,GW,GY,HT,HM,VA,HN,HK,HU,IS,IN,ID,IR,IQ,IE,IM,IL,IT,JM,JP,JE,JO,KZ,KE,KI,KP,KR,KW,KG,LA,LV,LB,LS,LR,LY,LI,LT,LU,MO,MK,MG,MW,MY,MV,ML,MT,MH,MQ,MR,MU,YT,MX,FM,MD,MC,MN,ME,MS,MA,MZ,MM,NA,NR,NP,NL,NC,NZ,NI,NE,NG,NU,NF,MP,NO,OM,PK,PW,PS,PA,PG,PY,PE,PH,PN,PL,PT,PR,QA,RE,RO,RU,RW,BL,SH,KN,LC,MF,PM,VC,WS,SM,ST,SA,SN,RS,SC,SL,SG,SX,SK,SI,SB,SO,ZA,GS,SS,ES,LK,SD,SR,SJ,SZ,SE,CH,SY,TW,TJ,TZ,TH,TL,TG,TK,TO,TT,TN,TR,TM,TC,TV,UG,UA,AE,GB,UM,UY,UZ,VU,VE,VN,VG,VI,WF,EH,YE,ZM,ZW,US", currency = "AED,AFN,ALL,AMD,ANG,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BHD,BIF,BMD,BND,BOB,BRL,BSD,BTN,BWP,BYN,BZD,CAD,CDF,CHF,CLF,CLP,CNY,COP,CRC,CUC,CUP,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ERN,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,IQD,IRR,ISK,JMD,JOD,JPY,KES,KGS,KHR,KMF,KPW,KRW,KWD,KYD,KZT,LAK,LBP,LKR,LRD,LSL,LYD,MAD,MDL,MGA,MKD,MMK,MNT,MOP,MRU,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SDG,SEK,SGD,SHP,SLE,SLL,SOS,SRD,SSP,STD,STN,SVC,SYP,SZL,THB,TJS,TMT,TND,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VES,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL" } diff --git a/config/deployments/sandbox.toml b/config/deployments/sandbox.toml index d00b12c751f..ac5442fcdd6 100644 --- a/config/deployments/sandbox.toml +++ b/config/deployments/sandbox.toml @@ -532,6 +532,9 @@ google_pay = { country = "AF,AX,AL,DZ,AS,AD,AO,AI,AQ,AG,AR,AM,AW,AU,AT,AZ,BS,BH, paypal = { country = "AF,AX,AL,DZ,AS,AD,AO,AI,AQ,AG,AR,AM,AW,AU,AT,AZ,BS,BH,BD,BB,BY,BE,BZ,BJ,BM,BT,BO,BQ,BA,BW,BV,BR,IO,BN,BG,BF,BI,CV,KH,CM,CA,KY,CF,TD,CL,CN,CX,CC,CO,KM,CG,CD,CK,CR,CI,HR,CU,CW,CY,CZ,DK,DJ,DM,DO,EC,EG,SV,GQ,ER,EE,ET,FK,FO,FJ,FI,FR,GF,PF,TF,GA,GM,GE,DE,GH,GI,GR,GL,GD,GP,GU,GT,GG,GN,GW,GY,HT,HM,VA,HN,HK,HU,IS,IN,ID,IR,IQ,IE,IM,IL,IT,JM,JP,JE,JO,KZ,KE,KI,KP,KR,KW,KG,LA,LV,LB,LS,LR,LY,LI,LT,LU,MO,MK,MG,MW,MY,MV,ML,MT,MH,MQ,MR,MU,YT,MX,FM,MD,MC,MN,ME,MS,MA,MZ,MM,NA,NR,NP,NL,NC,NZ,NI,NE,NG,NU,NF,MP,NO,OM,PK,PW,PS,PA,PG,PY,PE,PH,PN,PL,PT,PR,QA,RE,RO,RU,RW,BL,SH,KN,LC,MF,PM,VC,WS,SM,ST,SA,SN,RS,SC,SL,SG,SX,SK,SI,SB,SO,ZA,GS,SS,ES,LK,SD,SR,SJ,SZ,SE,CH,SY,TW,TJ,TZ,TH,TL,TG,TK,TO,TT,TN,TR,TM,TC,TV,UG,UA,AE,GB,US,UM,UY,UZ,VU,VE,VN,VG,VI,WF,EH,YE,ZM,ZW", currency = "AUD,BRL,CAD,CHF,CZK,DKK,EUR,GBP,HKD,HRK,HUF,JPY,MXN,MYR,NOK,NZD,PHP,PLN,RUB,SEK,SGD,THB,TRY,TWD,USD" } ideal = { country = "NL", currency = "EUR" } klarna = { country = "AT,BE,DK,FI,FR,DE,IT,NL,NO,PT,ES,SE,GB", currency = "DKK,EUR,GBP,NOK,SEK" } +trustly = { country = "AT,CZ,DK,EE,FI,DE,LV,LT,NL,NO,PL,PT,ES,SE,GB" , currency = "EUR,GBP,SEK"} +ali_pay = {currency = "EUR,USD"} +we_chat_pay = { currency = "EUR"} [pm_filters.cashtocode] classic = { country = "AF,AX,AL,DZ,AS,AD,AO,AI,AQ,AG,AR,AM,AW,AU,AT,AZ,BS,BH,BD,BB,BY,BE,BZ,BJ,BM,BT,BO,BQ,BA,BW,BV,BR,IO,BN,BG,BF,BI,KH,CM,CA,CV,KY,CF,TD,CL,CN,CX,CC,CO,KM,CG,CD,CK,CR,CI,HR,CU,CW,CY,CZ,DK,DJ,DM,DO,EC,EG,SV,GQ,ER,EE,ET,FK,FO,FJ,FI,FR,GF,PF,TF,GA,GM,GE,DE,GH,GI,GR,GL,GD,GP,GU,GT,GG,GN,GW,GY,HT,HM,VA,HN,HK,HU,IS,IN,ID,IR,IQ,IE,IM,IL,IT,JM,JP,JE,JO,KZ,KE,KI,KP,KR,KW,KG,LA,LV,LB,LS,LR,LY,LI,LT,LU,MO,MK,MG,MW,MY,MV,ML,MT,MH,MQ,MR,MU,YT,MX,FM,MD,MC,MN,ME,MS,MA,MZ,MM,NA,NR,NP,NL,NC,NZ,NI,NE,NG,NU,NF,MP,NO,OM,PK,PW,PS,PA,PG,PY,PE,PH,PN,PL,PT,PR,QA,RE,RO,RU,RW,BL,SH,KN,LC,MF,PM,VC,WS,SM,ST,SA,SN,RS,SC,SL,SG,SX,SK,SI,SB,SO,ZA,GS,SS,ES,LK,SD,SR,SJ,SZ,SE,CH,SY,TW,TJ,TZ,TH,TL,TG,TK,TO,TT,TN,TR,TM,TC,TV,UG,UA,AE,GB,UM,UY,UZ,VU,VE,VN,VG,VI,WF,EH,YE,ZM,ZW,US", currency = "AED,AFN,ALL,AMD,ANG,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BHD,BIF,BMD,BND,BOB,BRL,BSD,BTN,BWP,BYN,BZD,CAD,CDF,CHF,CLF,CLP,CNY,COP,CRC,CUC,CUP,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ERN,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,IQD,IRR,ISK,JMD,JOD,JPY,KES,KGS,KHR,KMF,KPW,KRW,KWD,KYD,KZT,LAK,LBP,LKR,LRD,LSL,LYD,MAD,MDL,MGA,MKD,MMK,MNT,MOP,MRU,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SDG,SEK,SGD,SHP,SLE,SLL,SOS,SRD,SSP,STD,STN,SVC,SYP,SZL,THB,TJS,TMT,TND,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VES,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL" } diff --git a/config/development.toml b/config/development.toml index 95484d6b014..d85f36cef18 100644 --- a/config/development.toml +++ b/config/development.toml @@ -728,6 +728,9 @@ paypal = { country = "AF,AX,AL,DZ,AS,AD,AO,AI,AQ,AG,AR,AM,AW,AU,AT,AZ,BS,BH,BD,B giropay = { country = "DE", currency = "EUR" } ideal = { country = "NL", currency = "EUR" } klarna = { country = "AT,BE,DK,FI,FR,DE,IT,NL,NO,PT,ES,SE,GB", currency = "DKK,EUR,GBP,NOK,SEK" } +trustly = { country = "AT,CZ,DK,EE,FI,DE,LV,LT,NL,NO,PL,PT,ES,SE,GB" , currency = "EUR,GBP,SEK"} +ali_pay = { currency = "EUR,USD" } +we_chat_pay = { currency = "EUR"} [pm_filters.cashtocode] classic = { country = "AF,AX,AL,DZ,AS,AD,AO,AI,AQ,AG,AR,AM,AW,AU,AT,AZ,BS,BH,BD,BB,BY,BE,BZ,BJ,BM,BT,BO,BQ,BA,BW,BV,BR,IO,BN,BG,BF,BI,KH,CM,CA,CV,KY,CF,TD,CL,CN,CX,CC,CO,KM,CG,CD,CK,CR,CI,HR,CU,CW,CY,CZ,DK,DJ,DM,DO,EC,EG,SV,GQ,ER,EE,ET,FK,FO,FJ,FI,FR,GF,PF,TF,GA,GM,GE,DE,GH,GI,GR,GL,GD,GP,GU,GT,GG,GN,GW,GY,HT,HM,VA,HN,HK,HU,IS,IN,ID,IR,IQ,IE,IM,IL,IT,JM,JP,JE,JO,KZ,KE,KI,KP,KR,KW,KG,LA,LV,LB,LS,LR,LY,LI,LT,LU,MO,MK,MG,MW,MY,MV,ML,MT,MH,MQ,MR,MU,YT,MX,FM,MD,MC,MN,ME,MS,MA,MZ,MM,NA,NR,NP,NL,NC,NZ,NI,NE,NG,NU,NF,MP,NO,OM,PK,PW,PS,PA,PG,PY,PE,PH,PN,PL,PT,PR,QA,RE,RO,RU,RW,BL,SH,KN,LC,MF,PM,VC,WS,SM,ST,SA,SN,RS,SC,SL,SG,SX,SK,SI,SB,SO,ZA,GS,SS,ES,LK,SD,SR,SJ,SZ,SE,CH,SY,TW,TJ,TZ,TH,TL,TG,TK,TO,TT,TN,TR,TM,TC,TV,UG,UA,AE,GB,UM,UY,UZ,VU,VE,VN,VG,VI,WF,EH,YE,ZM,ZW,US", currency = "AED,AFN,ALL,AMD,ANG,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BHD,BIF,BMD,BND,BOB,BRL,BSD,BTN,BWP,BYN,BZD,CAD,CDF,CHF,CLF,CLP,CNY,COP,CRC,CUC,CUP,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ERN,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,IQD,IRR,ISK,JMD,JOD,JPY,KES,KGS,KHR,KMF,KPW,KRW,KWD,KYD,KZT,LAK,LBP,LKR,LRD,LSL,LYD,MAD,MDL,MGA,MKD,MMK,MNT,MOP,MRU,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SDG,SEK,SGD,SHP,SLE,SLL,SOS,SRD,SSP,STD,STN,SVC,SYP,SZL,THB,TJS,TMT,TND,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VES,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL" } diff --git a/crates/hyperswitch_connectors/src/connectors/multisafepay.rs b/crates/hyperswitch_connectors/src/connectors/multisafepay.rs index f2fc62d6cbf..08e76940237 100644 --- a/crates/hyperswitch_connectors/src/connectors/multisafepay.rs +++ b/crates/hyperswitch_connectors/src/connectors/multisafepay.rs @@ -634,6 +634,27 @@ static MULTISAFEPAY_SUPPORTED_PAYMENT_METHODS: LazyLock<SupportedPaymentMethods> }, ); + multisafepay_supported_payment_methods.add( + enums::PaymentMethod::Wallet, + enums::PaymentMethodType::AliPay, + PaymentMethodDetails { + mandates: enums::FeatureStatus::NotSupported, + refunds: enums::FeatureStatus::Supported, + supported_capture_methods: supported_capture_methods.clone(), + specific_features: None, + }, + ); + multisafepay_supported_payment_methods.add( + enums::PaymentMethod::Wallet, + enums::PaymentMethodType::WeChatPay, + PaymentMethodDetails { + mandates: enums::FeatureStatus::NotSupported, + refunds: enums::FeatureStatus::Supported, + supported_capture_methods: supported_capture_methods.clone(), + specific_features: None, + }, + ); + multisafepay_supported_payment_methods.add( enums::PaymentMethod::BankRedirect, enums::PaymentMethodType::Giropay, @@ -644,6 +665,16 @@ static MULTISAFEPAY_SUPPORTED_PAYMENT_METHODS: LazyLock<SupportedPaymentMethods> specific_features: None, }, ); + multisafepay_supported_payment_methods.add( + enums::PaymentMethod::BankRedirect, + enums::PaymentMethodType::Trustly, + PaymentMethodDetails { + mandates: enums::FeatureStatus::NotSupported, + refunds: enums::FeatureStatus::Supported, + supported_capture_methods: supported_capture_methods.clone(), + specific_features: None, + }, + ); multisafepay_supported_payment_methods.add( enums::PaymentMethod::BankRedirect, diff --git a/crates/hyperswitch_connectors/src/connectors/multisafepay/transformers.rs b/crates/hyperswitch_connectors/src/connectors/multisafepay/transformers.rs index c7cc7967c4c..bcdbd7e28e6 100644 --- a/crates/hyperswitch_connectors/src/connectors/multisafepay/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/multisafepay/transformers.rs @@ -66,6 +66,10 @@ pub enum Gateway { Paypal, Ideal, Giropay, + Trustly, + Alipay, + #[serde(rename = "WECHAT")] + WeChatPay, } #[serde_with::skip_serializing_none] @@ -183,14 +187,24 @@ pub enum GatewayInfo { #[serde(untagged)] pub enum WalletInfo { GooglePay(GpayInfo), + Alipay(AlipayInfo), + WeChatPay(WeChatPayInfo), } +#[derive(Debug, Clone, Serialize, Eq, PartialEq)] +pub struct WeChatPayInfo {} + +#[derive(Debug, Clone, Serialize, Eq, PartialEq)] +pub struct AlipayInfo {} + #[derive(Clone, Debug, Eq, PartialEq, Serialize)] #[serde(untagged)] pub enum BankRedirectInfo { Ideal(IdealInfo), + Trustly(TrustlyInfo), } - +#[derive(Debug, Clone, Serialize, Eq, PartialEq)] +pub struct TrustlyInfo {} #[derive(Debug, Clone, Serialize, Eq, PartialEq)] pub struct IdealInfo { pub issuer_id: MultisafepayBankNames, @@ -490,8 +504,9 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> PaymentMethodData::Wallet(ref wallet_data) => match wallet_data { WalletData::GooglePay(_) => Type::Direct, WalletData::PaypalRedirect(_) => Type::Redirect, + WalletData::AliPayRedirect(_) => Type::Redirect, + WalletData::WeChatPayRedirect(_) => Type::Redirect, WalletData::AliPayQr(_) - | WalletData::AliPayRedirect(_) | WalletData::AliPayHkRedirect(_) | WalletData::AmazonPayRedirect(_) | WalletData::MomoRedirect(_) @@ -512,7 +527,6 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> | WalletData::TwintRedirect {} | WalletData::VippsRedirect {} | WalletData::TouchNGoRedirect(_) - | WalletData::WeChatPayRedirect(_) | WalletData::WeChatPayQr(_) | WalletData::CashappQr(_) | WalletData::SwishQr(_) @@ -524,6 +538,7 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> PaymentMethodData::BankRedirect(ref bank_data) => match bank_data { BankRedirectData::Giropay { .. } => Type::Redirect, BankRedirectData::Ideal { .. } => Type::Direct, + BankRedirectData::Trustly { .. } => Type::Redirect, BankRedirectData::BancontactCard { .. } | BankRedirectData::Bizum { .. } | BankRedirectData::Blik { .. } @@ -537,7 +552,6 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> | BankRedirectData::OpenBankingUk { .. } | BankRedirectData::Przelewy24 { .. } | BankRedirectData::Sofort { .. } - | BankRedirectData::Trustly { .. } | BankRedirectData::OnlineBankingFpx { .. } | BankRedirectData::OnlineBankingThailand { .. } | BankRedirectData::LocalBankRedirect {} => { @@ -557,8 +571,9 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> PaymentMethodData::Wallet(ref wallet_data) => Some(match wallet_data { WalletData::GooglePay(_) => Gateway::Googlepay, WalletData::PaypalRedirect(_) => Gateway::Paypal, + WalletData::AliPayRedirect(_) => Gateway::Alipay, + WalletData::WeChatPayRedirect(_) => Gateway::WeChatPay, WalletData::AliPayQr(_) - | WalletData::AliPayRedirect(_) | WalletData::AliPayHkRedirect(_) | WalletData::AmazonPayRedirect(_) | WalletData::MomoRedirect(_) @@ -579,7 +594,6 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> | WalletData::TwintRedirect {} | WalletData::VippsRedirect {} | WalletData::TouchNGoRedirect(_) - | WalletData::WeChatPayRedirect(_) | WalletData::WeChatPayQr(_) | WalletData::CashappQr(_) | WalletData::SwishQr(_) @@ -591,6 +605,7 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> PaymentMethodData::BankRedirect(ref bank_data) => Some(match bank_data { BankRedirectData::Giropay { .. } => Gateway::Giropay, BankRedirectData::Ideal { .. } => Gateway::Ideal, + BankRedirectData::Trustly { .. } => Gateway::Trustly, BankRedirectData::BancontactCard { .. } | BankRedirectData::Bizum { .. } | BankRedirectData::Blik { .. } @@ -604,7 +619,6 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> | BankRedirectData::OpenBankingUk { .. } | BankRedirectData::Przelewy24 { .. } | BankRedirectData::Sofort { .. } - | BankRedirectData::Trustly { .. } | BankRedirectData::OnlineBankingFpx { .. } | BankRedirectData::OnlineBankingThailand { .. } | BankRedirectData::LocalBankRedirect {} => { @@ -718,9 +732,14 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> } }))) } + WalletData::AliPayRedirect(_) => { + Some(GatewayInfo::Wallet(WalletInfo::Alipay(AlipayInfo {}))) + } WalletData::PaypalRedirect(_) => None, + WalletData::WeChatPayRedirect(_) => { + Some(GatewayInfo::Wallet(WalletInfo::WeChatPay(WeChatPayInfo {}))) + } WalletData::AliPayQr(_) - | WalletData::AliPayRedirect(_) | WalletData::AliPayHkRedirect(_) | WalletData::AmazonPayRedirect(_) | WalletData::MomoRedirect(_) @@ -741,7 +760,6 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> | WalletData::TwintRedirect {} | WalletData::VippsRedirect {} | WalletData::TouchNGoRedirect(_) - | WalletData::WeChatPayRedirect(_) | WalletData::WeChatPayQr(_) | WalletData::CashappQr(_) | WalletData::SwishQr(_) @@ -780,6 +798,9 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> )?)?, }), )), + BankRedirectData::Trustly { .. } => Some(GatewayInfo::BankRedirect( + BankRedirectInfo::Trustly(TrustlyInfo {}), + )), BankRedirectData::BancontactCard { .. } | BankRedirectData::Bizum { .. } | BankRedirectData::Blik { .. } @@ -794,7 +815,6 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> | BankRedirectData::OpenBankingUk { .. } | BankRedirectData::Przelewy24 { .. } | BankRedirectData::Sofort { .. } - | BankRedirectData::Trustly { .. } | BankRedirectData::OnlineBankingFpx { .. } | BankRedirectData::OnlineBankingThailand { .. } | BankRedirectData::LocalBankRedirect {} => None,

2025-06-26T04:34:28Z

## Type of Change  - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description Add newer payment methods for `multisafepay` connector - Trustly - WeChatPay - Alipay ### MCA <details> <summary>Create Merchant Account</summary> ```json { "connector_type": "payment_processor", "connector_account_details": { "auth_type": "HeaderKey", "api_key": "**************" }, "connector_name": "multisafepay", "test_mode": false, "disabled": false, "payment_methods_enabled": [ { "payment_method": "wallet", "payment_method_types": [ { "payment_method_type": "we_chat_pay", "payment_experience": "redirect_to_url" } ] }, { "payment_method": "wallet", "payment_method_types": [ { "payment_method_type": "ali_pay", "payment_experience": "redirect_to_url" } ] }, { "payment_method": "wallet", "payment_method_types": [ { "payment_method_type": "amazon_pay", "payment_experience": "redirect_to_url" } ] }, { "payment_method": "bank_redirect", "payment_method_types": [ { "payment_method_type": "trustly" } ] }, { "payment_method": "card", "payment_method_types": [ { "payment_method_type": "credit", "card_networks": ["Visa", "Mastercard"], "minimum_amount": 1, "maximum_amount": 68607706, "recurring_enabled": true, "installment_payment_enabled": true }, { "payment_method_type": "debit", "card_networks": ["Visa", "Mastercard"], "minimum_amount": 1, "maximum_amount": 68607706, "recurring_enabled": true, "installment_payment_enabled": true } ] } ], "metadata": { "city": "NY", "unit": "245" }, "business_country": "US", "business_label": "default" } ``` </details> ## Trustly <details> <summary>Create payement</summary> ```json { "amount": 333, "currency": "EUR", "confirm": true, "capture_method": "automatic", "payment_method": "bank_redirect", "payment_method_type": "trustly", "description": "hellow world", "billing": { "address": { "zip": "560095", "first_name": "Sakil", "last_name": "Mostak", "line1": "Fasdf", "country": "AT", "line2": "Fasdf", "city": "Fasdf" } }, "payment_method_data": { "bank_redirect": { "trustly": { "country": "AT" } } } } ``` </details> <details> <summary> Response</summary> ```json { "payment_id": "pay_wRU9qZTZ8Q8VGd8Bry2i", "merchant_id": "merchant_1750676714", "status": "requires_customer_action", "amount": 333, "net_amount": 333, "shipping_cost": null, "amount_capturable": 333, "amount_received": null, "connector": "multisafepay", "client_secret": "pay_wRU9qZTZ8Q8VGd8Bry2i_secret_Cikbt0vSVNo1G9dXT8LR", "created": "2025-06-26T04:55:03.318Z", "currency": "EUR", "customer_id": null, "customer": null, "description": "hellow world", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "bank_redirect", "payment_method_data": { "bank_redirect": { "type": "BankRedirectResponse", "bank_name": null }, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": "Fasdf", "country": "AT", "line1": "Fasdf", "line2": "Fasdf", "line3": null, "zip": "560095", "state": null, "first_name": "Sakil", "last_name": "Mostak" }, "phone": null, "email": null }, "order_details": null, "email": null, "name": null, "phone": null, "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": { "type": "redirect_to_url", "redirect_to_url": "http://localhost:8080/payments/redirect/pay_wRU9qZTZ8Q8VGd8Bry2i/merchant_1750676714/pay_wRU9qZTZ8Q8VGd8Bry2i_1" }, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "trustly", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": null, "connector_transaction_id": "pay_wRU9qZTZ8Q8VGd8Bry2i_1", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_wRU9qZTZ8Q8VGd8Bry2i_1", "payment_link": null, "profile_id": "pro_7Pno0Wbshvrioh4kTJLM", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_aliGZhhX1SDuuEtkipSs", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-06-26T05:10:03.318Z", "fingerprint": null, "browser_info": null, "payment_method_id": null, "payment_method_status": null, "updated": "2025-06-26T04:55:05.045Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": null, "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` </details> <details> <summary>Confirm page</summary> <img width="1322" alt="Screenshot 2025-06-26 at 10 26 20 AM" src="https://github.com/user-attachments/assets/6a428b08-d3fb-4b6d-bf94-d6348025d208" /> </details> <details> <summary>Psync</summary> ```json { "payment_id": "pay_wRU9qZTZ8Q8VGd8Bry2i", "merchant_id": "merchant_1750676714", "status": "succeeded", "amount": 333, "net_amount": 333, "shipping_cost": null, "amount_capturable": 0, "amount_received": 333, "connector": "multisafepay", "client_secret": "pay_wRU9qZTZ8Q8VGd8Bry2i_secret_Cikbt0vSVNo1G9dXT8LR", "created": "2025-06-26T04:55:03.318Z", "currency": "EUR", "customer_id": null, "customer": null, "description": "hellow world", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "bank_redirect", "payment_method_data": { "bank_redirect": { "type": "BankRedirectResponse", "bank_name": null }, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": "Fasdf", "country": "AT", "line1": "Fasdf", "line2": "Fasdf", "line3": null, "zip": "560095", "state": null, "first_name": "Sakil", "last_name": "Mostak" }, "phone": null, "email": null }, "order_details": null, "email": null, "name": null, "phone": null, "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "trustly", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": false, "connector_transaction_id": "pay_wRU9qZTZ8Q8VGd8Bry2i_1", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_wRU9qZTZ8Q8VGd8Bry2i_1", "payment_link": null, "profile_id": "pro_7Pno0Wbshvrioh4kTJLM", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_aliGZhhX1SDuuEtkipSs", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-06-26T05:10:03.318Z", "fingerprint": null, "browser_info": null, "payment_method_id": null, "payment_method_status": null, "updated": "2025-06-26T04:56:22.878Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": null, "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` </details> ## Alipay <details> <summary> Payment create </summary> ```json { "amount": 333, "currency": "EUR", "confirm": true, "capture_method": "automatic", "payment_method": "wallet", "payment_method_type": "ali_pay", "authentication_type": "no_three_ds", "description": "hellow world", "billing": { "address": { "zip": "560095", "first_name": "Sakil", "last_name": "Mostak", "line1": "Fasdf", "country": "AT", "line2": "Fasdf", "city": "Fasdf" } }, "payment_method_data": { "wallet": { "ali_pay_redirect": {} } } } ``` </details> <details> <summary>Payment Response</summary> ```json { "payment_id": "pay_Ovu6Gi04d695EdCCEUlP", "merchant_id": "merchant_1750676714", "status": "requires_customer_action", "amount": 333, "net_amount": 333, "shipping_cost": null, "amount_capturable": 333, "amount_received": null, "connector": "multisafepay", "client_secret": "pay_Ovu6Gi04d695EdCCEUlP_secret_M57QtvAffR5Z5DEAkVko", "created": "2025-06-26T05:00:28.713Z", "currency": "EUR", "customer_id": null, "customer": null, "description": "hellow world", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "wallet", "payment_method_data": { "wallet": {}, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": "Fasdf", "country": "AT", "line1": "Fasdf", "line2": "Fasdf", "line3": null, "zip": "560095", "state": null, "first_name": "Sakil", "last_name": "Mostak" }, "phone": null, "email": null }, "order_details": null, "email": null, "name": null, "phone": null, "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": { "type": "redirect_to_url", "redirect_to_url": "http://localhost:8080/payments/redirect/pay_Ovu6Gi04d695EdCCEUlP/merchant_1750676714/pay_Ovu6Gi04d695EdCCEUlP_1" }, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "ali_pay", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": null, "connector_transaction_id": "pay_Ovu6Gi04d695EdCCEUlP_1", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_Ovu6Gi04d695EdCCEUlP_1", "payment_link": null, "profile_id": "pro_7Pno0Wbshvrioh4kTJLM", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_aliGZhhX1SDuuEtkipSs", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-06-26T05:15:28.713Z", "fingerprint": null, "browser_info": null, "payment_method_id": null, "payment_method_status": null, "updated": "2025-06-26T05:00:30.315Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": null, "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` </details> <details> <summary> Confirm page </summary> <img width="1188" alt="Screenshot 2025-06-26 at 10 44 33 AM" src="https://github.com/user-attachments/assets/86978961-b4c1-42e0-8ae0-a28f72ea44a4" /> </details> <details> <summary>Psync</summary> ```json { "payment_id": "pay_Ovu6Gi04d695EdCCEUlP", "merchant_id": "merchant_1750676714", "status": "succeeded", "amount": 333, "net_amount": 333, "shipping_cost": null, "amount_capturable": 0, "amount_received": 333, "connector": "multisafepay", "client_secret": "pay_Ovu6Gi04d695EdCCEUlP_secret_M57QtvAffR5Z5DEAkVko", "created": "2025-06-26T05:00:28.713Z", "currency": "EUR", "customer_id": null, "customer": null, "description": "hellow world", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "wallet", "payment_method_data": { "wallet": {}, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": "Fasdf", "country": "AT", "line1": "Fasdf", "line2": "Fasdf", "line3": null, "zip": "560095", "state": null, "first_name": "Sakil", "last_name": "Mostak" }, "phone": null, "email": null }, "order_details": null, "email": null, "name": null, "phone": null, "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "ali_pay", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": false, "connector_transaction_id": "pay_Ovu6Gi04d695EdCCEUlP_1", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_Ovu6Gi04d695EdCCEUlP_1", "payment_link": null, "profile_id": "pro_7Pno0Wbshvrioh4kTJLM", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_aliGZhhX1SDuuEtkipSs", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-06-26T05:15:28.713Z", "fingerprint": null, "browser_info": null, "payment_method_id": null, "payment_method_status": null, "updated": "2025-06-26T05:14:27.864Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": null, "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` </details> ## WeChat pay <details> <summary>Create payment </summary> ```json { "amount": 333, "currency": "EUR", "confirm": true, "capture_method": "automatic", "payment_method": "wallet", "payment_method_type": "we_chat_pay", "authentication_type": "no_three_ds", "description": "hellow world", "billing": { "address": { "zip": "560095", "first_name": "Sakil", "last_name": "Mostak", "line1": "Fasdf", "country": "CN", "line2": "Fasdf", "city": "Fasdf" } }, "payment_method_data": { "wallet": { "we_chat_pay_redirect": {} } } } ``` </details> <details> <summary>create payment response</summary> ```json { "payment_id": "pay_ly7Ihm9zEVRPGi4Q9rAY", "merchant_id": "merchant_1750676714", "status": "requires_customer_action", "amount": 333, "net_amount": 333, "shipping_cost": null, "amount_capturable": 333, "amount_received": null, "connector": "multisafepay", "client_secret": "pay_ly7Ihm9zEVRPGi4Q9rAY_secret_0QAA4w1LChiYL9nlsVW7", "created": "2025-06-26T05:22:38.368Z", "currency": "EUR", "customer_id": null, "customer": null, "description": "hellow world", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "wallet", "payment_method_data": { "wallet": {}, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": "Fasdf", "country": "CN", "line1": "Fasdf", "line2": "Fasdf", "line3": null, "zip": "560095", "state": null, "first_name": "Sakil", "last_name": "Mostak" }, "phone": null, "email": null }, "order_details": null, "email": null, "name": null, "phone": null, "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": { "type": "redirect_to_url", "redirect_to_url": "http://localhost:8080/payments/redirect/pay_ly7Ihm9zEVRPGi4Q9rAY/merchant_1750676714/pay_ly7Ihm9zEVRPGi4Q9rAY_1" }, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "we_chat_pay", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": null, "connector_transaction_id": "pay_ly7Ihm9zEVRPGi4Q9rAY_1", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_ly7Ihm9zEVRPGi4Q9rAY_1", "payment_link": null, "profile_id": "pro_7Pno0Wbshvrioh4kTJLM", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_aliGZhhX1SDuuEtkipSs", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-06-26T05:37:38.368Z", "fingerprint": null, "browser_info": null, "payment_method_id": null, "payment_method_status": null, "updated": "2025-06-26T05:22:39.622Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": null, "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` </details> <details> <summary>Confirm page</summary> ## You will get a qr page and it needs to be scanned normally and it will direct to confirm page (test mode) <img width="1105" alt="Screenshot 2025-06-26 at 10 53 31 AM" src="https://github.com/user-attachments/assets/e7385469-ae56-4849-a131-d3ff941445ba" /> </details> <details> <summary>Psync </summary> ```json { "payment_id": "pay_ly7Ihm9zEVRPGi4Q9rAY", "merchant_id": "merchant_1750676714", "status": "succeeded", "amount": 333, "net_amount": 333, "shipping_cost": null, "amount_capturable": 0, "amount_received": 333, "connector": "multisafepay", "client_secret": "pay_ly7Ihm9zEVRPGi4Q9rAY_secret_0QAA4w1LChiYL9nlsVW7", "created": "2025-06-26T05:22:38.368Z", "currency": "EUR", "customer_id": null, "customer": null, "description": "hellow world", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "wallet", "payment_method_data": { "wallet": {}, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": "Fasdf", "country": "CN", "line1": "Fasdf", "line2": "Fasdf", "line3": null, "zip": "560095", "state": null, "first_name": "Sakil", "last_name": "Mostak" }, "phone": null, "email": null }, "order_details": null, "email": null, "name": null, "phone": null, "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "we_chat_pay", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": false, "connector_transaction_id": "pay_ly7Ihm9zEVRPGi4Q9rAY_1", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_ly7Ihm9zEVRPGi4Q9rAY_1", "payment_link": null, "profile_id": "pro_7Pno0Wbshvrioh4kTJLM", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_aliGZhhX1SDuuEtkipSs", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-06-26T05:37:38.368Z", "fingerprint": null, "browser_info": null, "payment_method_id": null, "payment_method_status": null, "updated": "2025-06-26T05:23:57.958Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": null, "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` </details> ## Checklist - [x] I formatted the code `cargo +nightly fmt --all` - [ ] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.114.0

6d98d5721be41bbd2b9674ab0dbdeafe6c95b95f

juspay/hyperswitch

juspay__hyperswitch-8491

Bug: [FEATURE] celero connector template ### Feature Description Create connector template ### Possible Implementation https://celerocommerce.com/developers/ ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? None

diff --git a/api-reference/v1/openapi_spec_v1.json b/api-reference/v1/openapi_spec_v1.json index 84cfe8e6199..940922743ca 100644 --- a/api-reference/v1/openapi_spec_v1.json +++ b/api-reference/v1/openapi_spec_v1.json @@ -10940,6 +10940,7 @@ "boku", "braintree", "cashtocode", + "celero", "chargebee", "checkout", "coinbase", @@ -27949,6 +27950,7 @@ "boku", "braintree", "cashtocode", + "celero", "chargebee", "checkout", "coinbase", diff --git a/api-reference/v2/openapi_spec_v2.json b/api-reference/v2/openapi_spec_v2.json index 63a25bf4fc2..12340ea5dcb 100644 --- a/api-reference/v2/openapi_spec_v2.json +++ b/api-reference/v2/openapi_spec_v2.json @@ -8147,6 +8147,7 @@ "boku", "braintree", "cashtocode", + "celero", "chargebee", "checkout", "coinbase", @@ -22666,6 +22667,7 @@ "boku", "braintree", "cashtocode", + "celero", "chargebee", "checkout", "coinbase", diff --git a/config/config.example.toml b/config/config.example.toml index 3c6da56b240..0bb5cb13007 100644 --- a/config/config.example.toml +++ b/config/config.example.toml @@ -202,6 +202,7 @@ bluesnap.secondary_base_url = "https://sandpay.bluesnap.com/" boku.base_url = "https://$-api4-stage.boku.com" braintree.base_url = "https://payments.sandbox.braintree-api.com/graphql" cashtocode.base_url = "https://cluster05.api-test.cashtocode.com" +celero.base_url = "https://sandbox.gotnpgateway.com" chargebee.base_url = "https://$.chargebee.com/api/" checkbook.base_url = "https://api.sandbox.checkbook.io" checkout.base_url = "https://api.sandbox.checkout.com/" @@ -342,6 +343,7 @@ cards = [ "adyenplatform", "archipel", "authorizedotnet", + "celero", "coinbase", "coingate", "cryptopay", diff --git a/config/deployments/integration_test.toml b/config/deployments/integration_test.toml index 495847bd896..c92570aaeef 100644 --- a/config/deployments/integration_test.toml +++ b/config/deployments/integration_test.toml @@ -41,6 +41,7 @@ bluesnap.secondary_base_url = "https://sandpay.bluesnap.com/" boku.base_url = "https://$-api4-stage.boku.com" braintree.base_url = "https://payments.sandbox.braintree-api.com/graphql" cashtocode.base_url = "https://cluster05.api-test.cashtocode.com" +celero.base_url = "https://sandbox.gotnpgateway.com" chargebee.base_url = "https://$.chargebee.com/api/" checkbook.base_url = "https://api.sandbox.checkbook.io" checkout.base_url = "https://api.sandbox.checkout.com/" diff --git a/config/deployments/production.toml b/config/deployments/production.toml index 335d7f5acea..8e7fd10702c 100644 --- a/config/deployments/production.toml +++ b/config/deployments/production.toml @@ -45,6 +45,7 @@ bluesnap.secondary_base_url = "https://pay.bluesnap.com/" boku.base_url = "https://country-api4-stage.boku.com" braintree.base_url = "https://payments.braintree-api.com/graphql" cashtocode.base_url = "https://cluster14.api.cashtocode.com" +celero.base_url = "https://app.gotnpgateway.com" chargebee.base_url = "https://{{merchant_endpoint_prefix}}.chargebee.com/api/" checkbook.base_url = "https://api.checkbook.io" checkout.base_url = "https://api.checkout.com/" diff --git a/config/deployments/sandbox.toml b/config/deployments/sandbox.toml index 721e32b9b8e..2011b50b756 100644 --- a/config/deployments/sandbox.toml +++ b/config/deployments/sandbox.toml @@ -45,6 +45,7 @@ bluesnap.secondary_base_url = "https://sandpay.bluesnap.com/" boku.base_url = "https://$-api4-stage.boku.com" braintree.base_url = "https://payments.sandbox.braintree-api.com/graphql" cashtocode.base_url = "https://cluster05.api-test.cashtocode.com" +celero.base_url = "https://sandbox.gotnpgateway.com" checkbook.base_url = "https://api.sandbox.checkbook.io" checkout.base_url = "https://api.sandbox.checkout.com/" chargebee.base_url = "https://$.chargebee.com/api/" diff --git a/config/development.toml b/config/development.toml index ab885503c85..49e5bb8a52e 100644 --- a/config/development.toml +++ b/config/development.toml @@ -109,6 +109,7 @@ cards = [ "bluesnap", "boku", "braintree", + "celero", "checkbook", "checkout", "coinbase", @@ -238,6 +239,7 @@ bluesnap.secondary_base_url = "https://sandpay.bluesnap.com/" boku.base_url = "https://$-api4-stage.boku.com" braintree.base_url = "https://payments.sandbox.braintree-api.com/graphql" cashtocode.base_url = "https://cluster05.api-test.cashtocode.com" +celero.base_url = "https://sandbox.gotnpgateway.com" chargebee.base_url = "https://$.chargebee.com/api/" checkbook.base_url = "https://api.sandbox.checkbook.io" checkout.base_url = "https://api.sandbox.checkout.com/" diff --git a/config/docker_compose.toml b/config/docker_compose.toml index dbfeccf7cd0..329c3743d39 100644 --- a/config/docker_compose.toml +++ b/config/docker_compose.toml @@ -128,6 +128,7 @@ bluesnap.secondary_base_url = "https://sandpay.bluesnap.com/" boku.base_url = "https://$-api4-stage.boku.com" braintree.base_url = "https://payments.sandbox.braintree-api.com/graphql" cashtocode.base_url = "https://cluster05.api-test.cashtocode.com" +celero.base_url = "https://sandbox.gotnpgateway.com" chargebee.base_url = "https://$.chargebee.com/api/" checkbook.base_url = "https://api.sandbox.checkbook.io" checkout.base_url = "https://api.sandbox.checkout.com/" @@ -259,6 +260,7 @@ cards = [ "bluesnap", "boku", "braintree", + "celero", "checkout", "checkbook", "coinbase", diff --git a/crates/common_enums/src/connector_enums.rs b/crates/common_enums/src/connector_enums.rs index e975dc8bcbd..5251b9b3177 100644 --- a/crates/common_enums/src/connector_enums.rs +++ b/crates/common_enums/src/connector_enums.rs @@ -74,6 +74,7 @@ pub enum RoutableConnectors { Boku, Braintree, Cashtocode, + Celero, Chargebee, // Checkbook, Checkout, @@ -232,6 +233,7 @@ pub enum Connector { Boku, Braintree, Cashtocode, + Celero, Chargebee, // Checkbook, Checkout, @@ -417,6 +419,7 @@ impl Connector { | Self::Boku | Self::Braintree | Self::Cashtocode + | Self::Celero | Self::Chargebee // | Self::Checkbook | Self::Coinbase @@ -580,6 +583,7 @@ impl From<RoutableConnectors> for Connector { RoutableConnectors::Boku => Self::Boku, RoutableConnectors::Braintree => Self::Braintree, RoutableConnectors::Cashtocode => Self::Cashtocode, + RoutableConnectors::Celero => Self::Celero, RoutableConnectors::Chargebee => Self::Chargebee, // RoutableConnectors::Checkbook => Self::Checkbook, RoutableConnectors::Checkout => Self::Checkout, @@ -701,6 +705,7 @@ impl TryFrom<Connector> for RoutableConnectors { Connector::Boku => Ok(Self::Boku), Connector::Braintree => Ok(Self::Braintree), Connector::Cashtocode => Ok(Self::Cashtocode), + Connector::Celero => Ok(Self::Celero), Connector::Chargebee => Ok(Self::Chargebee), // Connector::Checkbook => Ok(Self::Checkbook), Connector::Checkout => Ok(Self::Checkout), diff --git a/crates/connector_configs/src/connector.rs b/crates/connector_configs/src/connector.rs index 6ec11e8ca78..3e36dc023b9 100644 --- a/crates/connector_configs/src/connector.rs +++ b/crates/connector_configs/src/connector.rs @@ -190,6 +190,7 @@ pub struct ConnectorConfig { pub boku: Option<ConnectorTomlConfig>, pub braintree: Option<ConnectorTomlConfig>, pub cashtocode: Option<ConnectorTomlConfig>, + pub celero: Option<ConnectorTomlConfig>, pub chargebee: Option<ConnectorTomlConfig>, pub checkbook: Option<ConnectorTomlConfig>, pub checkout: Option<ConnectorTomlConfig>, @@ -381,6 +382,7 @@ impl ConnectorConfig { Connector::Boku => Ok(connector_data.boku), Connector::Braintree => Ok(connector_data.braintree), Connector::Cashtocode => Ok(connector_data.cashtocode), + Connector::Celero => Ok(connector_data.celero), Connector::Chargebee => Ok(connector_data.chargebee), Connector::Checkout => Ok(connector_data.checkout), Connector::Coinbase => Ok(connector_data.coinbase), diff --git a/crates/hyperswitch_connectors/src/connectors.rs b/crates/hyperswitch_connectors/src/connectors.rs index 16b56bed6fc..0861bbb4610 100644 --- a/crates/hyperswitch_connectors/src/connectors.rs +++ b/crates/hyperswitch_connectors/src/connectors.rs @@ -15,6 +15,7 @@ pub mod bluesnap; pub mod boku; pub mod braintree; pub mod cashtocode; +pub mod celero; pub mod chargebee; pub mod checkbook; pub mod checkout; @@ -116,26 +117,26 @@ pub use self::{ amazonpay::Amazonpay, archipel::Archipel, authorizedotnet::Authorizedotnet, bambora::Bambora, bamboraapac::Bamboraapac, bankofamerica::Bankofamerica, barclaycard::Barclaycard, billwerk::Billwerk, bitpay::Bitpay, bluesnap::Bluesnap, boku::Boku, braintree::Braintree, - cashtocode::Cashtocode, chargebee::Chargebee, checkbook::Checkbook, checkout::Checkout, - coinbase::Coinbase, coingate::Coingate, cryptopay::Cryptopay, ctp_mastercard::CtpMastercard, - cybersource::Cybersource, datatrans::Datatrans, deutschebank::Deutschebank, - digitalvirgo::Digitalvirgo, dlocal::Dlocal, dwolla::Dwolla, ebanx::Ebanx, elavon::Elavon, - facilitapay::Facilitapay, fiserv::Fiserv, fiservemea::Fiservemea, fiuu::Fiuu, forte::Forte, - getnet::Getnet, globalpay::Globalpay, globepay::Globepay, gocardless::Gocardless, - gpayments::Gpayments, helcim::Helcim, hipay::Hipay, hyperswitch_vault::HyperswitchVault, - iatapay::Iatapay, inespay::Inespay, itaubank::Itaubank, jpmorgan::Jpmorgan, - juspaythreedsserver::Juspaythreedsserver, klarna::Klarna, mifinity::Mifinity, mollie::Mollie, - moneris::Moneris, multisafepay::Multisafepay, netcetera::Netcetera, nexinets::Nexinets, - nexixpay::Nexixpay, nmi::Nmi, nomupay::Nomupay, noon::Noon, nordea::Nordea, novalnet::Novalnet, - nuvei::Nuvei, opayo::Opayo, opennode::Opennode, paybox::Paybox, payeezy::Payeezy, - payload::Payload, payme::Payme, payone::Payone, paypal::Paypal, paystack::Paystack, payu::Payu, - placetopay::Placetopay, plaid::Plaid, powertranz::Powertranz, prophetpay::Prophetpay, - rapyd::Rapyd, razorpay::Razorpay, recurly::Recurly, redsys::Redsys, riskified::Riskified, - santander::Santander, shift4::Shift4, signifyd::Signifyd, square::Square, stax::Stax, - stripe::Stripe, stripebilling::Stripebilling, taxjar::Taxjar, threedsecureio::Threedsecureio, - thunes::Thunes, tokenio::Tokenio, trustpay::Trustpay, tsys::Tsys, - unified_authentication_service::UnifiedAuthenticationService, vgs::Vgs, volt::Volt, - wellsfargo::Wellsfargo, wellsfargopayout::Wellsfargopayout, wise::Wise, worldline::Worldline, - worldpay::Worldpay, worldpayvantiv::Worldpayvantiv, worldpayxml::Worldpayxml, xendit::Xendit, - zen::Zen, zsl::Zsl, + cashtocode::Cashtocode, celero::Celero, chargebee::Chargebee, checkbook::Checkbook, + checkout::Checkout, coinbase::Coinbase, coingate::Coingate, cryptopay::Cryptopay, + ctp_mastercard::CtpMastercard, cybersource::Cybersource, datatrans::Datatrans, + deutschebank::Deutschebank, digitalvirgo::Digitalvirgo, dlocal::Dlocal, dwolla::Dwolla, + ebanx::Ebanx, elavon::Elavon, facilitapay::Facilitapay, fiserv::Fiserv, fiservemea::Fiservemea, + fiuu::Fiuu, forte::Forte, getnet::Getnet, globalpay::Globalpay, globepay::Globepay, + gocardless::Gocardless, gpayments::Gpayments, helcim::Helcim, hipay::Hipay, + hyperswitch_vault::HyperswitchVault, iatapay::Iatapay, inespay::Inespay, itaubank::Itaubank, + jpmorgan::Jpmorgan, juspaythreedsserver::Juspaythreedsserver, klarna::Klarna, + mifinity::Mifinity, mollie::Mollie, moneris::Moneris, multisafepay::Multisafepay, + netcetera::Netcetera, nexinets::Nexinets, nexixpay::Nexixpay, nmi::Nmi, nomupay::Nomupay, + noon::Noon, nordea::Nordea, novalnet::Novalnet, nuvei::Nuvei, opayo::Opayo, opennode::Opennode, + paybox::Paybox, payeezy::Payeezy, payload::Payload, payme::Payme, payone::Payone, + paypal::Paypal, paystack::Paystack, payu::Payu, placetopay::Placetopay, plaid::Plaid, + powertranz::Powertranz, prophetpay::Prophetpay, rapyd::Rapyd, razorpay::Razorpay, + recurly::Recurly, redsys::Redsys, riskified::Riskified, santander::Santander, shift4::Shift4, + signifyd::Signifyd, square::Square, stax::Stax, stripe::Stripe, stripebilling::Stripebilling, + taxjar::Taxjar, threedsecureio::Threedsecureio, thunes::Thunes, tokenio::Tokenio, + trustpay::Trustpay, tsys::Tsys, unified_authentication_service::UnifiedAuthenticationService, + vgs::Vgs, volt::Volt, wellsfargo::Wellsfargo, wellsfargopayout::Wellsfargopayout, wise::Wise, + worldline::Worldline, worldpay::Worldpay, worldpayvantiv::Worldpayvantiv, + worldpayxml::Worldpayxml, xendit::Xendit, zen::Zen, zsl::Zsl, }; diff --git a/crates/hyperswitch_connectors/src/connectors/celero.rs b/crates/hyperswitch_connectors/src/connectors/celero.rs new file mode 100644 index 00000000000..5d37d737355 --- /dev/null +++ b/crates/hyperswitch_connectors/src/connectors/celero.rs @@ -0,0 +1,571 @@ +pub mod transformers; + +use common_utils::{ + errors::CustomResult, + ext_traits::BytesExt, + request::{Method, Request, RequestBuilder, RequestContent}, + types::{AmountConvertor, StringMinorUnit, StringMinorUnitForConnector}, +}; +use error_stack::{report, ResultExt}; +use hyperswitch_domain_models::{ + router_data::{AccessToken, ConnectorAuthType, ErrorResponse, RouterData}, + router_flow_types::{ + access_token_auth::AccessTokenAuth, + payments::{Authorize, Capture, PSync, PaymentMethodToken, Session, SetupMandate, Void}, + refunds::{Execute, RSync}, + }, + router_request_types::{ + AccessTokenRequestData, PaymentMethodTokenizationData, PaymentsAuthorizeData, + PaymentsCancelData, PaymentsCaptureData, PaymentsSessionData, PaymentsSyncData, + RefundsData, SetupMandateRequestData, + }, + router_response_types::{PaymentsResponseData, RefundsResponseData}, + types::{ + PaymentsAuthorizeRouterData, PaymentsCaptureRouterData, PaymentsSyncRouterData, + RefundSyncRouterData, RefundsRouterData, + }, +}; +use hyperswitch_interfaces::{ + api::{ + self, ConnectorCommon, ConnectorCommonExt, ConnectorIntegration, ConnectorSpecifications, + ConnectorValidation, + }, + configs::Connectors, + errors, + events::connector_api_logs::ConnectorEvent, + types::{self, Response}, + webhooks, +}; +use masking::{ExposeInterface, Mask}; +use transformers as celero; + +use crate::{constants::headers, types::ResponseRouterData, utils}; + +#[derive(Clone)] +pub struct Celero { + amount_converter: &'static (dyn AmountConvertor<Output = StringMinorUnit> + Sync), +} + +impl Celero { + pub fn new() -> &'static Self { + &Self { + amount_converter: &StringMinorUnitForConnector, + } + } +} + +impl api::Payment for Celero {} +impl api::PaymentSession for Celero {} +impl api::ConnectorAccessToken for Celero {} +impl api::MandateSetup for Celero {} +impl api::PaymentAuthorize for Celero {} +impl api::PaymentSync for Celero {} +impl api::PaymentCapture for Celero {} +impl api::PaymentVoid for Celero {} +impl api::Refund for Celero {} +impl api::RefundExecute for Celero {} +impl api::RefundSync for Celero {} +impl api::PaymentToken for Celero {} + +impl ConnectorIntegration<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData> + for Celero +{ + // Not Implemented (R) +} + +impl<Flow, Request, Response> ConnectorCommonExt<Flow, Request, Response> for Celero +where + Self: ConnectorIntegration<Flow, Request, Response>, +{ + fn build_headers( + &self, + req: &RouterData<Flow, Request, Response>, + _connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + let mut header = vec![( + headers::CONTENT_TYPE.to_string(), + self.get_content_type().to_string().into(), + )]; + let mut api_key = self.get_auth_header(&req.connector_auth_type)?; + header.append(&mut api_key); + Ok(header) + } +} + +impl ConnectorCommon for Celero { + fn id(&self) -> &'static str { + "celero" + } + + fn get_currency_unit(&self) -> api::CurrencyUnit { + api::CurrencyUnit::Base + // TODO! Check connector documentation, on which unit they are processing the currency. + // If the connector accepts amount in lower unit ( i.e cents for USD) then return api::CurrencyUnit::Minor, + // if connector accepts amount in base unit (i.e dollars for USD) then return api::CurrencyUnit::Base + } + + fn common_get_content_type(&self) -> &'static str { + "application/json" + } + + fn base_url<'a>(&self, connectors: &'a Connectors) -> &'a str { + connectors.celero.base_url.as_ref() + } + + fn get_auth_header( + &self, + auth_type: &ConnectorAuthType, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + let auth = celero::CeleroAuthType::try_from(auth_type) + .change_context(errors::ConnectorError::FailedToObtainAuthType)?; + Ok(vec![( + headers::AUTHORIZATION.to_string(), + auth.api_key.expose().into_masked(), + )]) + } + + fn build_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + let response: celero::CeleroErrorResponse = res + .response + .parse_struct("CeleroErrorResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + + Ok(ErrorResponse { + status_code: res.status_code, + code: response.code, + message: response.message, + reason: response.reason, + attempt_status: None, + connector_transaction_id: None, + network_decline_code: None, + network_advice_code: None, + network_error_message: None, + }) + } +} + +impl ConnectorValidation for Celero { + //TODO: implement functions when support enabled +} + +impl ConnectorIntegration<Session, PaymentsSessionData, PaymentsResponseData> for Celero { + //TODO: implement sessions flow +} + +impl ConnectorIntegration<AccessTokenAuth, AccessTokenRequestData, AccessToken> for Celero {} + +impl ConnectorIntegration<SetupMandate, SetupMandateRequestData, PaymentsResponseData> for Celero {} + +impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData> for Celero { + fn get_headers( + &self, + req: &PaymentsAuthorizeRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsAuthorizeRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn get_request_body( + &self, + req: &PaymentsAuthorizeRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let amount = utils::convert_amount( + self.amount_converter, + req.request.minor_amount, + req.request.currency, + )?; + + let connector_router_data = celero::CeleroRouterData::from((amount, req)); + let connector_req = celero::CeleroPaymentsRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &PaymentsAuthorizeRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::PaymentsAuthorizeType::get_url( + self, req, connectors, + )?) + .attach_default_headers() + .headers(types::PaymentsAuthorizeType::get_headers( + self, req, connectors, + )?) + .set_body(types::PaymentsAuthorizeType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsAuthorizeRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsAuthorizeRouterData, errors::ConnectorError> { + let response: celero::CeleroPaymentsResponse = res + .response + .parse_struct("Celero PaymentsAuthorizeResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<PSync, PaymentsSyncData, PaymentsResponseData> for Celero { + fn get_headers( + &self, + req: &PaymentsSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsSyncRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn build_request( + &self, + req: &PaymentsSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Get) + .url(&types::PaymentsSyncType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::PaymentsSyncType::get_headers(self, req, connectors)?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsSyncRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsSyncRouterData, errors::ConnectorError> { + let response: celero::CeleroPaymentsResponse = res + .response + .parse_struct("celero PaymentsSyncResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<Capture, PaymentsCaptureData, PaymentsResponseData> for Celero { + fn get_headers( + &self, + req: &PaymentsCaptureRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsCaptureRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn get_request_body( + &self, + _req: &PaymentsCaptureRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_request_body method".to_string()).into()) + } + + fn build_request( + &self, + req: &PaymentsCaptureRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::PaymentsCaptureType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::PaymentsCaptureType::get_headers( + self, req, connectors, + )?) + .set_body(types::PaymentsCaptureType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsCaptureRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsCaptureRouterData, errors::ConnectorError> { + let response: celero::CeleroPaymentsResponse = res + .response + .parse_struct("Celero PaymentsCaptureResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<Void, PaymentsCancelData, PaymentsResponseData> for Celero {} + +impl ConnectorIntegration<Execute, RefundsData, RefundsResponseData> for Celero { + fn get_headers( + &self, + req: &RefundsRouterData<Execute>, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &RefundsRouterData<Execute>, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn get_request_body( + &self, + req: &RefundsRouterData<Execute>, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let refund_amount = utils::convert_amount( + self.amount_converter, + req.request.minor_refund_amount, + req.request.currency, + )?; + + let connector_router_data = celero::CeleroRouterData::from((refund_amount, req)); + let connector_req = celero::CeleroRefundRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &RefundsRouterData<Execute>, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + let request = RequestBuilder::new() + .method(Method::Post) + .url(&types::RefundExecuteType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::RefundExecuteType::get_headers( + self, req, connectors, + )?) + .set_body(types::RefundExecuteType::get_request_body( + self, req, connectors, + )?) + .build(); + Ok(Some(request)) + } + + fn handle_response( + &self, + data: &RefundsRouterData<Execute>, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<RefundsRouterData<Execute>, errors::ConnectorError> { + let response: celero::RefundResponse = + res.response + .parse_struct("celero RefundResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<RSync, RefundsData, RefundsResponseData> for Celero { + fn get_headers( + &self, + req: &RefundSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &RefundSyncRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn build_request( + &self, + req: &RefundSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Get) + .url(&types::RefundSyncType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::RefundSyncType::get_headers(self, req, connectors)?) + .set_body(types::RefundSyncType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &RefundSyncRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<RefundSyncRouterData, errors::ConnectorError> { + let response: celero::RefundResponse = res + .response + .parse_struct("celero RefundSyncResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +#[async_trait::async_trait] +impl webhooks::IncomingWebhook for Celero { + fn get_webhook_object_reference_id( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<api_models::webhooks::ObjectReferenceId, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } + + fn get_webhook_event_type( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<api_models::webhooks::IncomingWebhookEvent, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } + + fn get_webhook_resource_object( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<Box<dyn masking::ErasedMaskSerialize>, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } +} + +impl ConnectorSpecifications for Celero {} diff --git a/crates/hyperswitch_connectors/src/connectors/celero/transformers.rs b/crates/hyperswitch_connectors/src/connectors/celero/transformers.rs new file mode 100644 index 00000000000..2579c81ae6b --- /dev/null +++ b/crates/hyperswitch_connectors/src/connectors/celero/transformers.rs @@ -0,0 +1,228 @@ +use common_enums::enums; +use common_utils::types::StringMinorUnit; +use hyperswitch_domain_models::{ + payment_method_data::PaymentMethodData, + router_data::{ConnectorAuthType, RouterData}, + router_flow_types::refunds::{Execute, RSync}, + router_request_types::ResponseId, + router_response_types::{PaymentsResponseData, RefundsResponseData}, + types::{PaymentsAuthorizeRouterData, RefundsRouterData}, +}; +use hyperswitch_interfaces::errors; +use masking::Secret; +use serde::{Deserialize, Serialize}; + +use crate::{ + types::{RefundsResponseRouterData, ResponseRouterData}, + utils::PaymentsAuthorizeRequestData, +}; + +//TODO: Fill the struct with respective fields +pub struct CeleroRouterData<T> { + pub amount: StringMinorUnit, // The type of amount that a connector accepts, for example, String, i64, f64, etc. + pub router_data: T, +} + +impl<T> From<(StringMinorUnit, T)> for CeleroRouterData<T> { + fn from((amount, item): (StringMinorUnit, T)) -> Self { + //Todo : use utils to convert the amount to the type of amount that a connector accepts + Self { + amount, + router_data: item, + } + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Serialize, PartialEq)] +pub struct CeleroPaymentsRequest { + amount: StringMinorUnit, + card: CeleroCard, +} + +#[derive(Default, Debug, Serialize, Eq, PartialEq)] +pub struct CeleroCard { + number: cards::CardNumber, + expiry_month: Secret<String>, + expiry_year: Secret<String>, + cvc: Secret<String>, + complete: bool, +} + +impl TryFrom<&CeleroRouterData<&PaymentsAuthorizeRouterData>> for CeleroPaymentsRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: &CeleroRouterData<&PaymentsAuthorizeRouterData>, + ) -> Result<Self, Self::Error> { + match item.router_data.request.payment_method_data.clone() { + PaymentMethodData::Card(req_card) => { + let card = CeleroCard { + number: req_card.card_number, + expiry_month: req_card.card_exp_month, + expiry_year: req_card.card_exp_year, + cvc: req_card.card_cvc, + complete: item.router_data.request.is_auto_capture()?, + }; + Ok(Self { + amount: item.amount.clone(), + card, + }) + } + _ => Err(errors::ConnectorError::NotImplemented("Payment method".to_string()).into()), + } + } +} + +//TODO: Fill the struct with respective fields +// Auth Struct +pub struct CeleroAuthType { + pub(super) api_key: Secret<String>, +} + +impl TryFrom<&ConnectorAuthType> for CeleroAuthType { + 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)] +#[serde(rename_all = "lowercase")] +pub enum CeleroPaymentStatus { + Succeeded, + Failed, + #[default] + Processing, +} + +impl From<CeleroPaymentStatus> for common_enums::AttemptStatus { + fn from(item: CeleroPaymentStatus) -> Self { + match item { + CeleroPaymentStatus::Succeeded => Self::Charged, + CeleroPaymentStatus::Failed => Self::Failure, + CeleroPaymentStatus::Processing => Self::Authorizing, + } + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] +pub struct CeleroPaymentsResponse { + status: CeleroPaymentStatus, + id: String, +} + +impl<F, T> TryFrom<ResponseRouterData<F, CeleroPaymentsResponse, T, PaymentsResponseData>> + for RouterData<F, T, PaymentsResponseData> +{ + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: ResponseRouterData<F, CeleroPaymentsResponse, T, PaymentsResponseData>, + ) -> Result<Self, Self::Error> { + Ok(Self { + status: common_enums::AttemptStatus::from(item.response.status), + response: Ok(PaymentsResponseData::TransactionResponse { + resource_id: ResponseId::ConnectorTransactionId(item.response.id), + redirection_data: Box::new(None), + mandate_reference: Box::new(None), + connector_metadata: None, + network_txn_id: None, + connector_response_reference_id: None, + incremental_authorization_allowed: None, + charges: None, + }), + ..item.data + }) + } +} + +//TODO: Fill the struct with respective fields +// REFUND : +// Type definition for RefundRequest +#[derive(Default, Debug, Serialize)] +pub struct CeleroRefundRequest { + pub amount: StringMinorUnit, +} + +impl<F> TryFrom<&CeleroRouterData<&RefundsRouterData<F>>> for CeleroRefundRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from(item: &CeleroRouterData<&RefundsRouterData<F>>) -> Result<Self, Self::Error> { + Ok(Self { + amount: item.amount.to_owned(), + }) + } +} + +// Type definition for Refund Response + +#[allow(dead_code)] +#[derive(Debug, Serialize, Default, Deserialize, Clone)] +pub enum RefundStatus { + Succeeded, + Failed, + #[default] + Processing, +} + +impl From<RefundStatus> for enums::RefundStatus { + fn from(item: RefundStatus) -> Self { + match item { + RefundStatus::Succeeded => Self::Success, + RefundStatus::Failed => Self::Failure, + RefundStatus::Processing => Self::Pending, + //TODO: Review mapping + } + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Clone, Serialize, Deserialize)] +pub struct RefundResponse { + id: String, + status: RefundStatus, +} + +impl TryFrom<RefundsResponseRouterData<Execute, RefundResponse>> for RefundsRouterData<Execute> { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: RefundsResponseRouterData<Execute, RefundResponse>, + ) -> Result<Self, Self::Error> { + Ok(Self { + response: Ok(RefundsResponseData { + connector_refund_id: item.response.id.to_string(), + refund_status: enums::RefundStatus::from(item.response.status), + }), + ..item.data + }) + } +} + +impl TryFrom<RefundsResponseRouterData<RSync, RefundResponse>> for RefundsRouterData<RSync> { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: RefundsResponseRouterData<RSync, RefundResponse>, + ) -> Result<Self, Self::Error> { + Ok(Self { + response: Ok(RefundsResponseData { + connector_refund_id: item.response.id.to_string(), + refund_status: enums::RefundStatus::from(item.response.status), + }), + ..item.data + }) + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Serialize, Deserialize, PartialEq)] +pub struct CeleroErrorResponse { + pub status_code: u16, + pub code: String, + pub message: String, + pub reason: Option<String>, +} diff --git a/crates/hyperswitch_connectors/src/default_implementations.rs b/crates/hyperswitch_connectors/src/default_implementations.rs index a338b96bc55..a2a5c163865 100644 --- a/crates/hyperswitch_connectors/src/default_implementations.rs +++ b/crates/hyperswitch_connectors/src/default_implementations.rs @@ -159,6 +159,7 @@ default_imp_for_authorize_session_token!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -283,6 +284,7 @@ default_imp_for_calculate_tax!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -408,6 +410,7 @@ default_imp_for_session_update!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -533,6 +536,7 @@ default_imp_for_post_session_tokens!( connectors::Boku, connectors::Billwerk, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -657,6 +661,7 @@ default_imp_for_create_order!( connectors::Boku, connectors::Billwerk, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -782,6 +787,7 @@ default_imp_for_update_metadata!( connectors::Boku, connectors::Billwerk, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -905,6 +911,7 @@ default_imp_for_complete_authorize!( connectors::Bitpay, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1015,6 +1022,7 @@ default_imp_for_incremental_authorization!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1140,6 +1148,7 @@ default_imp_for_create_customer!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1259,6 +1268,7 @@ default_imp_for_connector_redirect_response!( connectors::Barclaycard, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Coinbase, @@ -1367,6 +1377,7 @@ default_imp_for_pre_processing_steps!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1483,6 +1494,7 @@ default_imp_for_post_processing_steps!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1609,6 +1621,7 @@ default_imp_for_approve!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1736,6 +1749,7 @@ default_imp_for_reject!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1863,6 +1877,7 @@ default_imp_for_webhook_source_verification!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1989,6 +2004,7 @@ default_imp_for_accept_dispute!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Coinbase, @@ -2114,6 +2130,7 @@ default_imp_for_submit_evidence!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Coinbase, @@ -2238,6 +2255,7 @@ default_imp_for_defend_dispute!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Coinbase, @@ -2372,6 +2390,7 @@ default_imp_for_file_upload!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Coinbase, @@ -2488,6 +2507,7 @@ default_imp_for_payouts!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -2608,6 +2628,7 @@ default_imp_for_payouts_create!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -2732,6 +2753,7 @@ default_imp_for_payouts_retrieve!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -2858,6 +2880,7 @@ default_imp_for_payouts_eligibility!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -2982,6 +3005,7 @@ default_imp_for_payouts_fulfill!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -3103,6 +3127,7 @@ default_imp_for_payouts_cancel!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -3228,6 +3253,7 @@ default_imp_for_payouts_quote!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -3354,6 +3380,7 @@ default_imp_for_payouts_recipient!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -3479,6 +3506,7 @@ default_imp_for_payouts_recipient_account!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -3606,6 +3634,7 @@ default_imp_for_frm_sale!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -3733,6 +3762,7 @@ default_imp_for_frm_checkout!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -3860,6 +3890,7 @@ default_imp_for_frm_transaction!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -3987,6 +4018,7 @@ default_imp_for_frm_fulfillment!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -4114,6 +4146,7 @@ default_imp_for_frm_record_return!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -4237,6 +4270,7 @@ default_imp_for_revoking_mandates!( connectors::Bluesnap, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -4360,6 +4394,7 @@ default_imp_for_uas_pre_authentication!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -4484,6 +4519,7 @@ default_imp_for_uas_post_authentication!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -4609,6 +4645,7 @@ default_imp_for_uas_authentication_confirmation!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -4726,6 +4763,7 @@ default_imp_for_connector_request_id!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -4845,6 +4883,7 @@ default_imp_for_fraud_check!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -4994,6 +5033,7 @@ default_imp_for_connector_authentication!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -5116,6 +5156,7 @@ default_imp_for_uas_authentication!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -5233,6 +5274,7 @@ default_imp_for_revenue_recovery!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -5361,6 +5403,7 @@ default_imp_for_billing_connector_payment_sync!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -5488,6 +5531,7 @@ default_imp_for_revenue_recovery_record_back!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Checkbook, connectors::Checkout, connectors::Coinbase, @@ -5613,6 +5657,7 @@ default_imp_for_billing_connector_invoice_sync!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -5733,6 +5778,7 @@ default_imp_for_external_vault!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -5859,6 +5905,7 @@ default_imp_for_external_vault_insert!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -5985,6 +6032,7 @@ default_imp_for_external_vault_retrieve!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -6111,6 +6159,7 @@ default_imp_for_external_vault_delete!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -6237,6 +6286,7 @@ default_imp_for_external_vault_create!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, diff --git a/crates/hyperswitch_connectors/src/default_implementations_v2.rs b/crates/hyperswitch_connectors/src/default_implementations_v2.rs index 99685607c48..2c3e849d4c9 100644 --- a/crates/hyperswitch_connectors/src/default_implementations_v2.rs +++ b/crates/hyperswitch_connectors/src/default_implementations_v2.rs @@ -264,6 +264,7 @@ default_imp_for_new_connector_integration_payment!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -391,6 +392,7 @@ default_imp_for_new_connector_integration_refund!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -513,6 +515,7 @@ default_imp_for_new_connector_integration_connector_access_token!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -641,6 +644,7 @@ default_imp_for_new_connector_integration_accept_dispute!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -767,6 +771,7 @@ default_imp_for_new_connector_integration_submit_evidence!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -893,6 +898,7 @@ default_imp_for_new_connector_integration_defend_dispute!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1030,6 +1036,7 @@ default_imp_for_new_connector_integration_file_upload!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1159,6 +1166,7 @@ default_imp_for_new_connector_integration_payouts_create!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1288,6 +1296,7 @@ default_imp_for_new_connector_integration_payouts_eligibility!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1417,6 +1426,7 @@ default_imp_for_new_connector_integration_payouts_fulfill!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1546,6 +1556,7 @@ default_imp_for_new_connector_integration_payouts_cancel!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1675,6 +1686,7 @@ default_imp_for_new_connector_integration_payouts_quote!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1804,6 +1816,7 @@ default_imp_for_new_connector_integration_payouts_recipient!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1933,6 +1946,7 @@ default_imp_for_new_connector_integration_payouts_sync!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -2062,6 +2076,7 @@ default_imp_for_new_connector_integration_payouts_recipient_account!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -2189,6 +2204,7 @@ default_imp_for_new_connector_integration_webhook_source_verification!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -2318,6 +2334,7 @@ default_imp_for_new_connector_integration_frm_sale!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -2447,6 +2464,7 @@ default_imp_for_new_connector_integration_frm_checkout!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -2576,6 +2594,7 @@ default_imp_for_new_connector_integration_frm_transaction!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -2705,6 +2724,7 @@ default_imp_for_new_connector_integration_frm_fulfillment!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -2834,6 +2854,7 @@ default_imp_for_new_connector_integration_frm_record_return!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -2960,6 +2981,7 @@ default_imp_for_new_connector_integration_revoking_mandates!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -3074,6 +3096,7 @@ default_imp_for_new_connector_integration_frm!( connectors::Bluesnap, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Checkbook, connectors::Coinbase, connectors::Cryptopay, @@ -3200,6 +3223,7 @@ default_imp_for_new_connector_integration_connector_authentication!( connectors::Bluesnap, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Checkbook, connectors::Coinbase, connectors::Cryptopay, @@ -3315,6 +3339,7 @@ default_imp_for_new_connector_integration_revenue_recovery!( connectors::Bluesnap, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Checkbook, connectors::Coinbase, connectors::Cryptopay, @@ -3446,6 +3471,7 @@ default_imp_for_new_connector_integration_external_vault!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, diff --git a/crates/hyperswitch_domain_models/src/configs.rs b/crates/hyperswitch_domain_models/src/configs.rs index 16fbd3e1d31..89f8ddf673f 100644 --- a/crates/hyperswitch_domain_models/src/configs.rs +++ b/crates/hyperswitch_domain_models/src/configs.rs @@ -29,6 +29,7 @@ pub struct Connectors { pub boku: ConnectorParams, pub braintree: ConnectorParams, pub cashtocode: ConnectorParams, + pub celero: ConnectorParams, pub chargebee: ConnectorParams, pub checkbook: ConnectorParams, pub checkout: ConnectorParams, diff --git a/crates/router/src/connector.rs b/crates/router/src/connector.rs index 4b12c47118b..49aa7c61cd9 100644 --- a/crates/router/src/connector.rs +++ b/crates/router/src/connector.rs @@ -9,31 +9,32 @@ pub use hyperswitch_connectors::connectors::{ bamboraapac::Bamboraapac, bankofamerica, bankofamerica::Bankofamerica, barclaycard, barclaycard::Barclaycard, billwerk, billwerk::Billwerk, bitpay, bitpay::Bitpay, bluesnap, bluesnap::Bluesnap, boku, boku::Boku, braintree, braintree::Braintree, cashtocode, - cashtocode::Cashtocode, chargebee, chargebee::Chargebee, checkbook, checkbook::Checkbook, - checkout, checkout::Checkout, coinbase, coinbase::Coinbase, coingate, coingate::Coingate, - cryptopay, cryptopay::Cryptopay, ctp_mastercard, ctp_mastercard::CtpMastercard, cybersource, - cybersource::Cybersource, datatrans, datatrans::Datatrans, deutschebank, - deutschebank::Deutschebank, digitalvirgo, digitalvirgo::Digitalvirgo, dlocal, dlocal::Dlocal, - dwolla, dwolla::Dwolla, ebanx, ebanx::Ebanx, elavon, elavon::Elavon, facilitapay, - facilitapay::Facilitapay, fiserv, fiserv::Fiserv, fiservemea, fiservemea::Fiservemea, fiuu, - fiuu::Fiuu, forte, forte::Forte, getnet, getnet::Getnet, globalpay, globalpay::Globalpay, - globepay, globepay::Globepay, gocardless, gocardless::Gocardless, gpayments, - gpayments::Gpayments, helcim, helcim::Helcim, hipay, hipay::Hipay, hyperswitch_vault, - hyperswitch_vault::HyperswitchVault, iatapay, iatapay::Iatapay, inespay, inespay::Inespay, - itaubank, itaubank::Itaubank, jpmorgan, jpmorgan::Jpmorgan, juspaythreedsserver, - juspaythreedsserver::Juspaythreedsserver, klarna, klarna::Klarna, mifinity, mifinity::Mifinity, - mollie, mollie::Mollie, moneris, moneris::Moneris, multisafepay, multisafepay::Multisafepay, - netcetera, netcetera::Netcetera, nexinets, nexinets::Nexinets, nexixpay, nexixpay::Nexixpay, - nmi, nmi::Nmi, nomupay, nomupay::Nomupay, noon, noon::Noon, nordea, nordea::Nordea, novalnet, - novalnet::Novalnet, nuvei, nuvei::Nuvei, opayo, opayo::Opayo, opennode, opennode::Opennode, - paybox, paybox::Paybox, payeezy, payeezy::Payeezy, payload, payload::Payload, payme, - payme::Payme, payone, payone::Payone, paypal, paypal::Paypal, paystack, paystack::Paystack, - payu, payu::Payu, placetopay, placetopay::Placetopay, plaid, plaid::Plaid, powertranz, - powertranz::Powertranz, prophetpay, prophetpay::Prophetpay, rapyd, rapyd::Rapyd, razorpay, - razorpay::Razorpay, recurly, recurly::Recurly, redsys, redsys::Redsys, riskified, - riskified::Riskified, santander, santander::Santander, shift4, shift4::Shift4, signifyd, - signifyd::Signifyd, square, square::Square, stax, stax::Stax, stripe, stripe::Stripe, - stripebilling, stripebilling::Stripebilling, taxjar, taxjar::Taxjar, threedsecureio, + cashtocode::Cashtocode, celero, celero::Celero, chargebee, chargebee::Chargebee, checkbook, + checkbook::Checkbook, checkout, checkout::Checkout, coinbase, coinbase::Coinbase, coingate, + coingate::Coingate, cryptopay, cryptopay::Cryptopay, ctp_mastercard, + ctp_mastercard::CtpMastercard, cybersource, cybersource::Cybersource, datatrans, + datatrans::Datatrans, deutschebank, deutschebank::Deutschebank, digitalvirgo, + digitalvirgo::Digitalvirgo, dlocal, dlocal::Dlocal, dwolla, dwolla::Dwolla, ebanx, + ebanx::Ebanx, elavon, elavon::Elavon, facilitapay, facilitapay::Facilitapay, fiserv, + fiserv::Fiserv, fiservemea, fiservemea::Fiservemea, fiuu, fiuu::Fiuu, forte, forte::Forte, + getnet, getnet::Getnet, globalpay, globalpay::Globalpay, globepay, globepay::Globepay, + gocardless, gocardless::Gocardless, gpayments, gpayments::Gpayments, helcim, helcim::Helcim, + hipay, hipay::Hipay, hyperswitch_vault, hyperswitch_vault::HyperswitchVault, iatapay, + iatapay::Iatapay, inespay, inespay::Inespay, itaubank, itaubank::Itaubank, jpmorgan, + jpmorgan::Jpmorgan, juspaythreedsserver, juspaythreedsserver::Juspaythreedsserver, klarna, + klarna::Klarna, mifinity, mifinity::Mifinity, mollie, mollie::Mollie, moneris, + moneris::Moneris, multisafepay, multisafepay::Multisafepay, netcetera, netcetera::Netcetera, + nexinets, nexinets::Nexinets, nexixpay, nexixpay::Nexixpay, nmi, nmi::Nmi, nomupay, + nomupay::Nomupay, noon, noon::Noon, nordea, nordea::Nordea, novalnet, novalnet::Novalnet, + nuvei, nuvei::Nuvei, opayo, opayo::Opayo, opennode, opennode::Opennode, paybox, paybox::Paybox, + payeezy, payeezy::Payeezy, payload, payload::Payload, payme, payme::Payme, payone, + payone::Payone, paypal, paypal::Paypal, paystack, paystack::Paystack, payu, payu::Payu, + placetopay, placetopay::Placetopay, plaid, plaid::Plaid, powertranz, powertranz::Powertranz, + prophetpay, prophetpay::Prophetpay, rapyd, rapyd::Rapyd, razorpay, razorpay::Razorpay, recurly, + recurly::Recurly, redsys, redsys::Redsys, riskified, riskified::Riskified, santander, + santander::Santander, shift4, shift4::Shift4, signifyd, signifyd::Signifyd, square, + square::Square, stax, stax::Stax, stripe, stripe::Stripe, stripebilling, + stripebilling::Stripebilling, taxjar, taxjar::Taxjar, threedsecureio, threedsecureio::Threedsecureio, thunes, thunes::Thunes, tokenio, tokenio::Tokenio, trustpay, trustpay::Trustpay, tsys, tsys::Tsys, unified_authentication_service, unified_authentication_service::UnifiedAuthenticationService, vgs, vgs::Vgs, volt, volt::Volt, diff --git a/crates/router/src/core/connector_validation.rs b/crates/router/src/core/connector_validation.rs index d23a3a175f7..655636197d8 100644 --- a/crates/router/src/core/connector_validation.rs +++ b/crates/router/src/core/connector_validation.rs @@ -136,7 +136,10 @@ impl ConnectorAuthTypeAndMetadataValidation<'_> { } api_enums::Connector::Chargebee => { chargebee::transformers::ChargebeeAuthType::try_from(self.auth_type)?; - chargebee::transformers::ChargebeeMetadata::try_from(self.connector_meta_data)?; + Ok(()) + } + api_enums::Connector::Celero => { + celero::transformers::CeleroAuthType::try_from(self.auth_type)?; Ok(()) } // api_enums::Connector::Checkbook => { diff --git a/crates/router/src/types/api.rs b/crates/router/src/types/api.rs index 3fa8aebf2cf..45d6dd0d75e 100644 --- a/crates/router/src/types/api.rs +++ b/crates/router/src/types/api.rs @@ -372,6 +372,9 @@ impl ConnectorData { enums::Connector::Cashtocode => { Ok(ConnectorEnum::Old(Box::new(connector::Cashtocode::new()))) } + enums::Connector::Celero => { + Ok(ConnectorEnum::Old(Box::new(connector::Celero::new()))) + } enums::Connector::Chargebee => { Ok(ConnectorEnum::Old(Box::new(connector::Chargebee::new()))) } diff --git a/crates/router/src/types/transformers.rs b/crates/router/src/types/transformers.rs index 284a5243d05..713293568b3 100644 --- a/crates/router/src/types/transformers.rs +++ b/crates/router/src/types/transformers.rs @@ -223,6 +223,7 @@ impl ForeignTryFrom<api_enums::Connector> for common_enums::RoutableConnectors { api_enums::Connector::Boku => Self::Boku, api_enums::Connector::Braintree => Self::Braintree, api_enums::Connector::Cashtocode => Self::Cashtocode, + api_enums::Connector::Celero => Self::Celero, api_enums::Connector::Chargebee => Self::Chargebee, // api_enums::Connector::Checkbook => Self::Checkbook, api_enums::Connector::Checkout => Self::Checkout, diff --git a/crates/router/tests/connectors/celero.rs b/crates/router/tests/connectors/celero.rs new file mode 100644 index 00000000000..7d4e942471b --- /dev/null +++ b/crates/router/tests/connectors/celero.rs @@ -0,0 +1,420 @@ +use masking::Secret; +use router::types::{self, api, domain, storage::enums}; +use test_utils::connector_auth; + +use crate::utils::{self, ConnectorActions}; + +#[derive(Clone, Copy)] +struct CeleroTest; +impl ConnectorActions for CeleroTest {} +impl utils::Connector for CeleroTest { + fn get_data(&self) -> api::ConnectorData { + use router::connector::Celero; + utils::construct_connector_data_old( + Box::new(Celero::new()), + types::Connector::Celero, + api::GetToken::Connector, + None, + ) + } + + fn get_auth_token(&self) -> types::ConnectorAuthType { + utils::to_connector_auth_type( + connector_auth::ConnectorAuthentication::new() + .celero + .expect("Missing connector authentication configuration") + .into(), + ) + } + + fn get_name(&self) -> String { + "celero".to_string() + } +} + +static CONNECTOR: CeleroTest = CeleroTest {}; + +fn get_default_payment_info() -> Option<utils::PaymentInfo> { + None +} + +fn payment_method_details() -> Option<types::PaymentsAuthorizeData> { + None +} + +// Cards Positive Tests +// Creates a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_only_authorize_payment() { + let response = CONNECTOR + .authorize_payment(payment_method_details(), get_default_payment_info()) + .await + .expect("Authorize payment response"); + assert_eq!(response.status, enums::AttemptStatus::Authorized); +} + +// Captures a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_capture_authorized_payment() { + let response = CONNECTOR + .authorize_and_capture_payment(payment_method_details(), None, get_default_payment_info()) + .await + .expect("Capture payment response"); + assert_eq!(response.status, enums::AttemptStatus::Charged); +} + +// Partially captures a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_capture_authorized_payment() { + let response = CONNECTOR + .authorize_and_capture_payment( + payment_method_details(), + Some(types::PaymentsCaptureData { + amount_to_capture: 50, + ..utils::PaymentCaptureType::default().0 + }), + get_default_payment_info(), + ) + .await + .expect("Capture payment response"); + assert_eq!(response.status, enums::AttemptStatus::Charged); +} + +// Synchronizes a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_authorized_payment() { + let authorize_response = CONNECTOR + .authorize_payment(payment_method_details(), get_default_payment_info()) + .await + .expect("Authorize payment response"); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + let response = CONNECTOR + .psync_retry_till_status_matches( + enums::AttemptStatus::Authorized, + Some(types::PaymentsSyncData { + connector_transaction_id: types::ResponseId::ConnectorTransactionId( + txn_id.unwrap(), + ), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .expect("PSync response"); + assert_eq!(response.status, enums::AttemptStatus::Authorized,); +} + +// Voids a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_void_authorized_payment() { + let response = CONNECTOR + .authorize_and_void_payment( + payment_method_details(), + Some(types::PaymentsCancelData { + connector_transaction_id: String::from(""), + cancellation_reason: Some("requested_by_customer".to_string()), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .expect("Void payment response"); + assert_eq!(response.status, enums::AttemptStatus::Voided); +} + +// Refunds a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_manually_captured_payment() { + let response = CONNECTOR + .capture_payment_and_refund( + payment_method_details(), + None, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Partially refunds a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_refund_manually_captured_payment() { + let response = CONNECTOR + .capture_payment_and_refund( + payment_method_details(), + None, + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Synchronizes a refund using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_manually_captured_refund() { + let refund_response = CONNECTOR + .capture_payment_and_refund( + payment_method_details(), + None, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + let response = CONNECTOR + .rsync_retry_till_status_matches( + enums::RefundStatus::Success, + refund_response.response.unwrap().connector_refund_id, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Creates a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_make_payment() { + let authorize_response = CONNECTOR + .make_payment(payment_method_details(), get_default_payment_info()) + .await + .unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); +} + +// Synchronizes a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_auto_captured_payment() { + let authorize_response = CONNECTOR + .make_payment(payment_method_details(), get_default_payment_info()) + .await + .unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + assert_ne!(txn_id, None, "Empty connector transaction id"); + let response = CONNECTOR + .psync_retry_till_status_matches( + enums::AttemptStatus::Charged, + Some(types::PaymentsSyncData { + connector_transaction_id: types::ResponseId::ConnectorTransactionId( + txn_id.unwrap(), + ), + capture_method: Some(enums::CaptureMethod::Automatic), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!(response.status, enums::AttemptStatus::Charged,); +} + +// Refunds a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_auto_captured_payment() { + let response = CONNECTOR + .make_payment_and_refund(payment_method_details(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Partially refunds a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_refund_succeeded_payment() { + let refund_response = CONNECTOR + .make_payment_and_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + refund_response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Creates multiple refunds against a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_succeeded_payment_multiple_times() { + CONNECTOR + .make_payment_and_multiple_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await; +} + +// Synchronizes a refund using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_refund() { + let refund_response = CONNECTOR + .make_payment_and_refund(payment_method_details(), None, get_default_payment_info()) + .await + .unwrap(); + let response = CONNECTOR + .rsync_retry_till_status_matches( + enums::RefundStatus::Success, + refund_response.response.unwrap().connector_refund_id, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Cards Negative scenarios +// Creates a payment with incorrect CVC. +#[actix_web::test] +async fn should_fail_payment_for_incorrect_cvc() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: domain::PaymentMethodData::Card(domain::Card { + card_cvc: Secret::new("12345".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's security code is invalid.".to_string(), + ); +} + +// Creates a payment with incorrect expiry month. +#[actix_web::test] +async fn should_fail_payment_for_invalid_exp_month() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: domain::PaymentMethodData::Card(domain::Card { + card_exp_month: Secret::new("20".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's expiration month is invalid.".to_string(), + ); +} + +// Creates a payment with incorrect expiry year. +#[actix_web::test] +async fn should_fail_payment_for_incorrect_expiry_year() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: domain::PaymentMethodData::Card(domain::Card { + card_exp_year: Secret::new("2000".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's expiration year is invalid.".to_string(), + ); +} + +// Voids a payment using automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_fail_void_payment_for_auto_capture() { + let authorize_response = CONNECTOR + .make_payment(payment_method_details(), get_default_payment_info()) + .await + .unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + assert_ne!(txn_id, None, "Empty connector transaction id"); + let void_response = CONNECTOR + .void_payment(txn_id.unwrap(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + void_response.response.unwrap_err().message, + "You cannot cancel this PaymentIntent because it has a status of succeeded." + ); +} + +// Captures a payment using invalid connector payment id. +#[actix_web::test] +async fn should_fail_capture_for_invalid_payment() { + let capture_response = CONNECTOR + .capture_payment("123456789".to_string(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + capture_response.response.unwrap_err().message, + String::from("No such payment_intent: '123456789'") + ); +} + +// Refunds a payment with refund amount higher than payment amount. +#[actix_web::test] +async fn should_fail_for_refund_amount_higher_than_payment_amount() { + let response = CONNECTOR + .make_payment_and_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 150, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Refund amount (₹1.50) is greater than charge amount (₹1.00)", + ); +} + +// Connector dependent test cases goes here + +// [#478]: add unit tests for non 3DS, wallets & webhooks in connector tests diff --git a/crates/router/tests/connectors/main.rs b/crates/router/tests/connectors/main.rs index 90af2bd8d80..10707ba2f4e 100644 --- a/crates/router/tests/connectors/main.rs +++ b/crates/router/tests/connectors/main.rs @@ -23,6 +23,7 @@ mod bitpay; mod bluesnap; mod boku; mod cashtocode; +mod celero; mod chargebee; mod checkbook; mod checkout; diff --git a/crates/test_utils/src/connector_auth.rs b/crates/test_utils/src/connector_auth.rs index fd0f9180910..31141205523 100644 --- a/crates/test_utils/src/connector_auth.rs +++ b/crates/test_utils/src/connector_auth.rs @@ -29,6 +29,7 @@ pub struct ConnectorAuthentication { pub bluesnap: Option<BodyKey>, pub boku: Option<BodyKey>, pub cashtocode: Option<BodyKey>, + pub celero: Option<HeaderKey>, pub chargebee: Option<HeaderKey>, pub checkbook: Option<BodyKey>, pub checkout: Option<SignatureKey>, diff --git a/loadtest/config/development.toml b/loadtest/config/development.toml index 28e3e724c3a..d2c62a57796 100644 --- a/loadtest/config/development.toml +++ b/loadtest/config/development.toml @@ -95,6 +95,7 @@ bluesnap.secondary_base_url = "https://sandpay.bluesnap.com/" boku.base_url = "https://country-api4-stage.boku.com" braintree.base_url = "https://payments.sandbox.braintree-api.com/graphql" cashtocode.base_url = "https://cluster05.api-test.cashtocode.com" +celero.base_url = "https://sandbox.gotnpgateway.com" chargebee.base_url = "https://$.chargebee.com/api/" checkbook.base_url = "https://api.sandbox.checkbook.io" checkout.base_url = "https://api.sandbox.checkout.com/" @@ -225,6 +226,7 @@ cards = [ "bluesnap", "boku", "braintree", + "celero", "checkbook", "checkout", "coinbase", @@ -332,36 +334,36 @@ przelewy24 = { country = "PL", currency = "PLN,EUR" } mifinity = { country = "BR,CN,SG,MY,DE,CH,DK,GB,ES,AD,GI,FI,FR,GR,HR,IT,JP,MX,AR,CO,CL,PE,VE,UY,PY,BO,EC,GT,HN,SV,NI,CR,PA,DO,CU,PR,NL,NO,PL,PT,SE,RU,TR,TW,HK,MO,AX,AL,DZ,AS,AO,AI,AG,AM,AW,AU,AT,AZ,BS,BH,BD,BB,BE,BZ,BJ,BM,BT,BQ,BA,BW,IO,BN,BG,BF,BI,KH,CM,CA,CV,KY,CF,TD,CX,CC,KM,CG,CK,CI,CW,CY,CZ,DJ,DM,EG,GQ,ER,EE,ET,FK,FO,FJ,GF,PF,TF,GA,GM,GE,GH,GL,GD,GP,GU,GG,GN,GW,GY,HT,HM,VA,IS,IN,ID,IE,IM,IL,JE,JO,KZ,KE,KI,KW,KG,LA,LV,LB,LS,LI,LT,LU,MK,MG,MW,MV,ML,MT,MH,MQ,MR,MU,YT,FM,MD,MC,MN,ME,MS,MA,MZ,NA,NR,NP,NC,NZ,NE,NG,NU,NF,MP,OM,PK,PW,PS,PG,PH,PN,QA,RE,RO,RW,BL,SH,KN,LC,MF,PM,VC,WS,SM,ST,SA,SN,RS,SC,SL,SX,SK,SI,SB,SO,ZA,GS,KR,LK,SR,SJ,SZ,TH,TL,TG,TK,TO,TT,TN,TM,TC,TV,UG,UA,AE,UZ,VU,VN,VG,VI,WF,EH,ZM", currency = "AUD,CAD,CHF,CNY,CZK,DKK,EUR,GBP,INR,JPY,NOK,NZD,PLN,RUB,SEK,ZAR,USD,EGP,UYU,UZS" } [pm_filters.globepay] -ali_pay = { country = "GB",currency = "GBP,CNY" } -we_chat_pay = { country = "GB",currency = "GBP,CNY" } +ali_pay = { country = "GB", currency = "GBP,CNY" } +we_chat_pay = { country = "GB", currency = "GBP,CNY" } [pm_filters.itaubank] pix = { country = "BR", currency = "BRL" } [pm_filters.nexinets] -credit = { country = "DE",currency = "EUR" } -debit = { country = "DE",currency = "EUR" } -ideal = { country = "DE",currency = "EUR" } -giropay = { country = "DE",currency = "EUR" } -sofort = { country = "DE",currency = "EUR" } -eps = { country = "DE",currency = "EUR" } -apple_pay = { country = "DE",currency = "EUR" } -paypal = { country = "DE",currency = "EUR" } +credit = { country = "DE", currency = "EUR" } +debit = { country = "DE", currency = "EUR" } +ideal = { country = "DE", currency = "EUR" } +giropay = { country = "DE", currency = "EUR" } +sofort = { country = "DE", currency = "EUR" } +eps = { country = "DE", currency = "EUR" } +apple_pay = { country = "DE", currency = "EUR" } +paypal = { country = "DE", currency = "EUR" } [pm_filters.nuvei] -credit = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US",currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } -debit = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US",currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } -klarna = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US",currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } -afterpay_clearpay = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US",currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } -ideal = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US",currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } -giropay = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US",currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } -sofort = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US",currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } -eps = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US",currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } -apple_pay = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US",currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } -google_pay = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US",currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } -paypal = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US",currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } +credit = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US", currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } +debit = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US", currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } +klarna = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US", currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } +afterpay_clearpay = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US", currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } +ideal = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US", currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } +giropay = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US", currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } +sofort = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US", currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } +eps = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US", currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } +apple_pay = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US", currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } +google_pay = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US", currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } +paypal = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US", currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } [pm_filters.prophetpay] card_redirect = { country = "US", currency = "USD" } @@ -495,16 +497,16 @@ crypto_currency = { country = "US, CA, GB, AU, BR, MX, SG, PH, NZ, ZA, JP, AT, B klarna = { country = "AU,AT,BE,CA,CZ,DK,FI,FR,DE,GR,IE,IT,NL,NZ,NO,PL,PT,ES,SE,CH,GB,US", currency = "CHF,DKK,EUR,GBP,NOK,PLN,SEK,USD,AUD,NZD,CAD" } [pm_filters.bluesnap] -credit = { country = "AD,AE,AG,AL,AM,AO,AR,AT,AU,AZ,BA,BB,BD,BE,BG,BH,BI,BJ,BN,BO,BR,BS,BT,BW,BY,BZ,CA,CD,CF,CG,CH,CI,CL,CM,CN,CO,CR,CV,CY,CZ,DE,DK,DJ,DM,DO,DZ,EC,EE,EG,ER,ES,ET,FI,FJ,FM,FR,GA,GB,GD,GE,GG,GH,GM,GN,GQ,GR,GT,GW,GY,HN,HR,HT,HU,ID,IE,IL,IN,IS,IT,JM,JP,JO,KE,KG,KH,KI,KM,KN,KR,KW,KZ,LA,LB,LC,LI,LK,LR,LS,LT,LU,LV,MA,MC,MD,ME,MG,MH,MK,ML,MM,MN,MR,MT,MU,MV,MW,MX,MY,MZ,NA,NE,NG,NI,NL,NO,NP,NR,NZ,OM,PA,PE,PG,PH,PK,PL,PS,PT,PW,PY,QA,RO,RS,RW,SA,SB,SC,SE,SG,SI,SK,SL,SM,SN,SO,SR,SS,ST,SV,SZ,TD,TG,TH,TJ,TL,TM,TN,TO,TR,TT,TV,TZ,UA,UG,US,UY,UZ,VA,VC,VE,VN,VU,WS,ZA,ZM,ZW", currency = "AED,AFN,ALL,AMD,ANG,ARS,AUD,AWG,BAM,BBD,BGN,BHD,BMD,BND,BOB,BRL,BSD,BWP,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,FJD,GBP,GEL,GIP,GTQ,HKD,HUF,IDR,ILS,INR,ISK,JMD,JPY,KES,KHR,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MUR,MWK,MXN,MYR,NAD,NGN,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PLN,PKR,QAR,RON,RSD,RUB,SAR,SCR,SDG,SEK,SGD,THB,TND,TRY,TTD,TWD,TZS,UAH,USD,UYU,UZS,VND,XAF,XCD,XOF,ZAR"} -google_pay = { country = "AD,AE,AG,AL,AM,AO,AR,AT,AU,AZ,BA,BB,BD,BE,BG,BH,BI,BJ,BN,BO,BR,BS,BT,BW,BY,BZ,CA,CD,CF,CG,CH,CI,CL,CM,CN,CO,CR,CV,CY,CZ,DE,DK,DJ,DM,DO,DZ,EC,EE,EG,ER,ES,ET,FI,FJ,FM,FR,GA,GB,GD,GE,GG,GH,GM,GN,GQ,GR,GT,GW,GY,HN,HR,HT,HU,ID,IE,IL,IN,IS,IT,JM,JP,JO,KE,KG,KH,KI,KM,KN,KR,KW,KZ,LA,LB,LC,LI,LK,LR,LS,LT,LU,LV,MA,MC,MD,ME,MG,MH,MK,ML,MM,MN,MR,MT,MU,MV,MW,MX,MY,MZ,NA,NE,NG,NI,NL,NO,NP,NR,NZ,OM,PA,PE,PG,PH,PK,PL,PS,PT,PW,PY,QA,RO,RS,RW,SA,SB,SC,SE,SG,SI,SK,SL,SM,SN,SO,SR,SS,ST,SV,SZ,TD,TG,TH,TJ,TL,TM,TN,TO,TR,TT,TV,TZ,UA,UG,US,UY,UZ,VA,VC,VE,VN,VU,WS,ZA,ZM,ZW", currency = "AED,AFN,ALL,AMD,ANG,ARS,AUD,AWG,BAM,BBD,BGN,BHD,BMD,BND,BOB,BRL,BSD,BWP,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,FJD,GBP,GEL,GIP,GTQ,HKD,HUF,IDR,ILS,INR,ISK,JMD,JPY,KES,KHR,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MUR,MWK,MXN,MYR,NAD,NGN,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PLN,PKR,QAR,RON,RSD,RUB,SAR,SCR,SDG,SEK,SGD,THB,TND,TRY,TTD,TWD,TZS,UAH,USD,UYU,UZS,VND,XAF,XCD,XOF,ZAR"} -apple_pay = { country = "AD,AE,AG,AL,AM,AO,AR,AT,AU,AZ,BA,BB,BD,BE,BG,BH,BI,BJ,BN,BO,BR,BS,BT,BW,BY,BZ,CA,CD,CF,CG,CH,CI,CL,CM,CN,CO,CR,CV,CY,CZ,DE,DK,DJ,DM,DO,DZ,EC,EE,EG,ER,ES,ET,FI,FJ,FM,FR,GA,GB,GD,GE,GG,GH,GM,GN,GQ,GR,GT,GW,GY,HN,HR,HT,HU,ID,IE,IL,IN,IS,IT,JM,JP,JO,KE,KG,KH,KI,KM,KN,KR,KW,KZ,LA,LB,LC,LI,LK,LR,LS,LT,LU,LV,MA,MC,MD,ME,MG,MH,MK,ML,MM,MN,MR,MT,MU,MV,MW,MX,MY,MZ,NA,NE,NG,NI,NL,NO,NP,NR,NZ,OM,PA,PE,PG,PH,PK,PL,PS,PT,PW,PY,QA,RO,RS,RW,SA,SB,SC,SE,SG,SI,SK,SL,SM,SN,SO,SR,SS,ST,SV,SZ,TD,TG,TH,TJ,TL,TM,TN,TO,TR,TT,TV,TZ,UA,UG,US,UY,UZ,VA,VC,VE,VN,VU,WS,ZA,ZM,ZW", currency = "AED,AFN,ALL,AMD,ANG,ARS,AUD,AWG,BAM,BBD,BGN,BHD,BMD,BND,BOB,BRL,BSD,BWP,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,FJD,GBP,GEL,GIP,GTQ,HKD,HUF,IDR,ILS,INR,ISK,JMD,JPY,KES,KHR,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MUR,MWK,MXN,MYR,NAD,NGN,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PLN,PKR,QAR,RON,RSD,RUB,SAR,SCR,SDG,SEK,SGD,THB,TND,TRY,TTD,TWD,TZS,UAH,USD,UYU,UZS,VND,XAF,XCD,XOF,ZAR"} +credit = { country = "AD,AE,AG,AL,AM,AO,AR,AT,AU,AZ,BA,BB,BD,BE,BG,BH,BI,BJ,BN,BO,BR,BS,BT,BW,BY,BZ,CA,CD,CF,CG,CH,CI,CL,CM,CN,CO,CR,CV,CY,CZ,DE,DK,DJ,DM,DO,DZ,EC,EE,EG,ER,ES,ET,FI,FJ,FM,FR,GA,GB,GD,GE,GG,GH,GM,GN,GQ,GR,GT,GW,GY,HN,HR,HT,HU,ID,IE,IL,IN,IS,IT,JM,JP,JO,KE,KG,KH,KI,KM,KN,KR,KW,KZ,LA,LB,LC,LI,LK,LR,LS,LT,LU,LV,MA,MC,MD,ME,MG,MH,MK,ML,MM,MN,MR,MT,MU,MV,MW,MX,MY,MZ,NA,NE,NG,NI,NL,NO,NP,NR,NZ,OM,PA,PE,PG,PH,PK,PL,PS,PT,PW,PY,QA,RO,RS,RW,SA,SB,SC,SE,SG,SI,SK,SL,SM,SN,SO,SR,SS,ST,SV,SZ,TD,TG,TH,TJ,TL,TM,TN,TO,TR,TT,TV,TZ,UA,UG,US,UY,UZ,VA,VC,VE,VN,VU,WS,ZA,ZM,ZW", currency = "AED,AFN,ALL,AMD,ANG,ARS,AUD,AWG,BAM,BBD,BGN,BHD,BMD,BND,BOB,BRL,BSD,BWP,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,FJD,GBP,GEL,GIP,GTQ,HKD,HUF,IDR,ILS,INR,ISK,JMD,JPY,KES,KHR,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MUR,MWK,MXN,MYR,NAD,NGN,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PLN,PKR,QAR,RON,RSD,RUB,SAR,SCR,SDG,SEK,SGD,THB,TND,TRY,TTD,TWD,TZS,UAH,USD,UYU,UZS,VND,XAF,XCD,XOF,ZAR" } +google_pay = { country = "AD,AE,AG,AL,AM,AO,AR,AT,AU,AZ,BA,BB,BD,BE,BG,BH,BI,BJ,BN,BO,BR,BS,BT,BW,BY,BZ,CA,CD,CF,CG,CH,CI,CL,CM,CN,CO,CR,CV,CY,CZ,DE,DK,DJ,DM,DO,DZ,EC,EE,EG,ER,ES,ET,FI,FJ,FM,FR,GA,GB,GD,GE,GG,GH,GM,GN,GQ,GR,GT,GW,GY,HN,HR,HT,HU,ID,IE,IL,IN,IS,IT,JM,JP,JO,KE,KG,KH,KI,KM,KN,KR,KW,KZ,LA,LB,LC,LI,LK,LR,LS,LT,LU,LV,MA,MC,MD,ME,MG,MH,MK,ML,MM,MN,MR,MT,MU,MV,MW,MX,MY,MZ,NA,NE,NG,NI,NL,NO,NP,NR,NZ,OM,PA,PE,PG,PH,PK,PL,PS,PT,PW,PY,QA,RO,RS,RW,SA,SB,SC,SE,SG,SI,SK,SL,SM,SN,SO,SR,SS,ST,SV,SZ,TD,TG,TH,TJ,TL,TM,TN,TO,TR,TT,TV,TZ,UA,UG,US,UY,UZ,VA,VC,VE,VN,VU,WS,ZA,ZM,ZW", currency = "AED,AFN,ALL,AMD,ANG,ARS,AUD,AWG,BAM,BBD,BGN,BHD,BMD,BND,BOB,BRL,BSD,BWP,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,FJD,GBP,GEL,GIP,GTQ,HKD,HUF,IDR,ILS,INR,ISK,JMD,JPY,KES,KHR,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MUR,MWK,MXN,MYR,NAD,NGN,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PLN,PKR,QAR,RON,RSD,RUB,SAR,SCR,SDG,SEK,SGD,THB,TND,TRY,TTD,TWD,TZS,UAH,USD,UYU,UZS,VND,XAF,XCD,XOF,ZAR" } +apple_pay = { country = "AD,AE,AG,AL,AM,AO,AR,AT,AU,AZ,BA,BB,BD,BE,BG,BH,BI,BJ,BN,BO,BR,BS,BT,BW,BY,BZ,CA,CD,CF,CG,CH,CI,CL,CM,CN,CO,CR,CV,CY,CZ,DE,DK,DJ,DM,DO,DZ,EC,EE,EG,ER,ES,ET,FI,FJ,FM,FR,GA,GB,GD,GE,GG,GH,GM,GN,GQ,GR,GT,GW,GY,HN,HR,HT,HU,ID,IE,IL,IN,IS,IT,JM,JP,JO,KE,KG,KH,KI,KM,KN,KR,KW,KZ,LA,LB,LC,LI,LK,LR,LS,LT,LU,LV,MA,MC,MD,ME,MG,MH,MK,ML,MM,MN,MR,MT,MU,MV,MW,MX,MY,MZ,NA,NE,NG,NI,NL,NO,NP,NR,NZ,OM,PA,PE,PG,PH,PK,PL,PS,PT,PW,PY,QA,RO,RS,RW,SA,SB,SC,SE,SG,SI,SK,SL,SM,SN,SO,SR,SS,ST,SV,SZ,TD,TG,TH,TJ,TL,TM,TN,TO,TR,TT,TV,TZ,UA,UG,US,UY,UZ,VA,VC,VE,VN,VU,WS,ZA,ZM,ZW", currency = "AED,AFN,ALL,AMD,ANG,ARS,AUD,AWG,BAM,BBD,BGN,BHD,BMD,BND,BOB,BRL,BSD,BWP,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,FJD,GBP,GEL,GIP,GTQ,HKD,HUF,IDR,ILS,INR,ISK,JMD,JPY,KES,KHR,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MUR,MWK,MXN,MYR,NAD,NGN,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PLN,PKR,QAR,RON,RSD,RUB,SAR,SCR,SDG,SEK,SGD,THB,TND,TRY,TTD,TWD,TZS,UAH,USD,UYU,UZS,VND,XAF,XCD,XOF,ZAR" } [pm_filters.inespay] -sepa = { country = "ES", currency = "EUR"} +sepa = { country = "ES", currency = "EUR" } [pm_filters.fiserv] -credit = {country = "AU,NZ,CN,HK,IN,LK,KR,MY,SG,GB,BE,FR,DE,IT,ME,NL,PL,ES,ZA,AR,BR,CO,MX,PA,UY,US,CA", currency = "AFN,ALL,DZD,AOA,ARS,AMD,AWG,AUD,AZN,BSD,BHD,BDT,BBD,BYN,BZD,BMD,BTN,BOB,VES,BAM,BWP,BRL,BND,BGN,BIF,KHR,CAD,CVE,KYD,XAF,CLP,CNY,COP,KMF,CDF,CRC,HRK,CUP,CZK,DKK,DJF,DOP,XCD,EGP,ERN,ETB,EUR,FKP,FJD,XPF,GMD,GEL,GHS,GIP,GTQ,GNF,GYD,HTG,HNL,HKD,HUF,ISK,INR,IDR,IRR,IQD,ILS,JMD,JPY,JOD,KZT,KES,KGS,KWD,LAK,LBP,LSL,LRD,LYD,MOP,MKD,MGA,MWK,MYR,MVR,MRU,MUR,MXN,MDL,MNT,MAD,MZN,MMK,NAD,NPR,ANG,NZD,NIO,NGN,VUV,KPW,NOK,OMR,PKR,PAB,PGK,PYG,PEN,PHP,PLN,GBP,QAR,RON,RUB,RWF,SHP,SVC,WST,STN,SAR,RSD,SCR,SLL,SGD,SBD,SOS,ZAR,KRW,SSP,LKR,SDG,SRD,SZL,SEK,CHF,SYP,TWD,TJS,TZS,THB,TOP,TTD,TND,TRY,TMT,UGX,UAH,AED,USD,UYU,UZS,VND,XOF,YER,ZMW,ZWL"} -debit = {country = "AU,NZ,CN,HK,IN,LK,KR,MY,SG,GB,BE,FR,DE,IT,ME,NL,PL,ES,ZA,AR,BR,CO,MX,PA,UY,US,CA", currency = "AFN,ALL,DZD,AOA,ARS,AMD,AWG,AUD,AZN,BSD,BHD,BDT,BBD,BYN,BZD,BMD,BTN,BOB,VES,BAM,BWP,BRL,BND,BGN,BIF,KHR,CAD,CVE,KYD,XAF,CLP,CNY,COP,KMF,CDF,CRC,HRK,CUP,CZK,DKK,DJF,DOP,XCD,EGP,ERN,ETB,EUR,FKP,FJD,XPF,GMD,GEL,GHS,GIP,GTQ,GNF,GYD,HTG,HNL,HKD,HUF,ISK,INR,IDR,IRR,IQD,ILS,JMD,JPY,JOD,KZT,KES,KGS,KWD,LAK,LBP,LSL,LRD,LYD,MOP,MKD,MGA,MWK,MYR,MVR,MRU,MUR,MXN,MDL,MNT,MAD,MZN,MMK,NAD,NPR,ANG,NZD,NIO,NGN,VUV,KPW,NOK,OMR,PKR,PAB,PGK,PYG,PEN,PHP,PLN,GBP,QAR,RON,RUB,RWF,SHP,SVC,WST,STN,SAR,RSD,SCR,SLL,SGD,SBD,SOS,ZAR,KRW,SSP,LKR,SDG,SRD,SZL,SEK,CHF,SYP,TWD,TJS,TZS,THB,TOP,TTD,TND,TRY,TMT,UGX,UAH,AED,USD,UYU,UZS,VND,XOF,YER,ZMW,ZWL"} +credit = { country = "AU,NZ,CN,HK,IN,LK,KR,MY,SG,GB,BE,FR,DE,IT,ME,NL,PL,ES,ZA,AR,BR,CO,MX,PA,UY,US,CA", currency = "AFN,ALL,DZD,AOA,ARS,AMD,AWG,AUD,AZN,BSD,BHD,BDT,BBD,BYN,BZD,BMD,BTN,BOB,VES,BAM,BWP,BRL,BND,BGN,BIF,KHR,CAD,CVE,KYD,XAF,CLP,CNY,COP,KMF,CDF,CRC,HRK,CUP,CZK,DKK,DJF,DOP,XCD,EGP,ERN,ETB,EUR,FKP,FJD,XPF,GMD,GEL,GHS,GIP,GTQ,GNF,GYD,HTG,HNL,HKD,HUF,ISK,INR,IDR,IRR,IQD,ILS,JMD,JPY,JOD,KZT,KES,KGS,KWD,LAK,LBP,LSL,LRD,LYD,MOP,MKD,MGA,MWK,MYR,MVR,MRU,MUR,MXN,MDL,MNT,MAD,MZN,MMK,NAD,NPR,ANG,NZD,NIO,NGN,VUV,KPW,NOK,OMR,PKR,PAB,PGK,PYG,PEN,PHP,PLN,GBP,QAR,RON,RUB,RWF,SHP,SVC,WST,STN,SAR,RSD,SCR,SLL,SGD,SBD,SOS,ZAR,KRW,SSP,LKR,SDG,SRD,SZL,SEK,CHF,SYP,TWD,TJS,TZS,THB,TOP,TTD,TND,TRY,TMT,UGX,UAH,AED,USD,UYU,UZS,VND,XOF,YER,ZMW,ZWL" } +debit = { country = "AU,NZ,CN,HK,IN,LK,KR,MY,SG,GB,BE,FR,DE,IT,ME,NL,PL,ES,ZA,AR,BR,CO,MX,PA,UY,US,CA", currency = "AFN,ALL,DZD,AOA,ARS,AMD,AWG,AUD,AZN,BSD,BHD,BDT,BBD,BYN,BZD,BMD,BTN,BOB,VES,BAM,BWP,BRL,BND,BGN,BIF,KHR,CAD,CVE,KYD,XAF,CLP,CNY,COP,KMF,CDF,CRC,HRK,CUP,CZK,DKK,DJF,DOP,XCD,EGP,ERN,ETB,EUR,FKP,FJD,XPF,GMD,GEL,GHS,GIP,GTQ,GNF,GYD,HTG,HNL,HKD,HUF,ISK,INR,IDR,IRR,IQD,ILS,JMD,JPY,JOD,KZT,KES,KGS,KWD,LAK,LBP,LSL,LRD,LYD,MOP,MKD,MGA,MWK,MYR,MVR,MRU,MUR,MXN,MDL,MNT,MAD,MZN,MMK,NAD,NPR,ANG,NZD,NIO,NGN,VUV,KPW,NOK,OMR,PKR,PAB,PGK,PYG,PEN,PHP,PLN,GBP,QAR,RON,RUB,RWF,SHP,SVC,WST,STN,SAR,RSD,SCR,SLL,SGD,SBD,SOS,ZAR,KRW,SSP,LKR,SDG,SRD,SZL,SEK,CHF,SYP,TWD,TJS,TZS,THB,TOP,TTD,TND,TRY,TMT,UGX,UAH,AED,USD,UYU,UZS,VND,XOF,YER,ZMW,ZWL" } [pm_filters.stax] credit = { country = "US", currency = "USD" } @@ -512,8 +514,8 @@ debit = { country = "US", currency = "USD" } ach = { country = "US", currency = "USD" } [pm_filters.braintree] -credit = { country = "AD,AT,AU,BE,BG,CA,CH,CY,CZ,DE,DK,EE,ES,FI,FR,GB,GG,GI,GR,HK,HR,HU,IE,IM,IT,JE,LI,LT,LU,LV,MT,MC,MY,NL,NO,NZ,PL,PT,RO,SE,SG,SI,SK,SM,US", currency = "AED,AMD,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BIF,BMD,BND,BOB,BRL,BSD,BWP,BYN,BZD,CAD,CHF,CLP,CNY,COP,CRC,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,ISK,JMD,JPY,KES,KGS,KHR,KMF,KRW,KYD,KZT,LAK,LBP,LKR,LRD,LSL,MAD,MDL,MKD,MNT,MOP,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SEK,SGD,SHP,SLL,SOS,SRD,STD,SVC,SYP,SZL,THB,TJS,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VES,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL"} -debit = { country = "AD,AT,AU,BE,BG,CA,CH,CY,CZ,DE,DK,EE,ES,FI,FR,GB,GG,GI,GR,HK,HR,HU,IE,IM,IT,JE,LI,LT,LU,LV,MT,MC,MY,NL,NO,NZ,PL,PT,RO,SE,SG,SI,SK,SM,US", currency = "AED,AMD,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BIF,BMD,BND,BOB,BRL,BSD,BWP,BYN,BZD,CAD,CHF,CLP,CNY,COP,CRC,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,ISK,JMD,JPY,KES,KGS,KHR,KMF,KRW,KYD,KZT,LAK,LBP,LKR,LRD,LSL,MAD,MDL,MKD,MNT,MOP,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SEK,SGD,SHP,SLL,SOS,SRD,STD,SVC,SYP,SZL,THB,TJS,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VES,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL"} +credit = { country = "AD,AT,AU,BE,BG,CA,CH,CY,CZ,DE,DK,EE,ES,FI,FR,GB,GG,GI,GR,HK,HR,HU,IE,IM,IT,JE,LI,LT,LU,LV,MT,MC,MY,NL,NO,NZ,PL,PT,RO,SE,SG,SI,SK,SM,US", currency = "AED,AMD,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BIF,BMD,BND,BOB,BRL,BSD,BWP,BYN,BZD,CAD,CHF,CLP,CNY,COP,CRC,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,ISK,JMD,JPY,KES,KGS,KHR,KMF,KRW,KYD,KZT,LAK,LBP,LKR,LRD,LSL,MAD,MDL,MKD,MNT,MOP,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SEK,SGD,SHP,SLL,SOS,SRD,STD,SVC,SYP,SZL,THB,TJS,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VES,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL" } +debit = { country = "AD,AT,AU,BE,BG,CA,CH,CY,CZ,DE,DK,EE,ES,FI,FR,GB,GG,GI,GR,HK,HR,HU,IE,IM,IT,JE,LI,LT,LU,LV,MT,MC,MY,NL,NO,NZ,PL,PT,RO,SE,SG,SI,SK,SM,US", currency = "AED,AMD,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BIF,BMD,BND,BOB,BRL,BSD,BWP,BYN,BZD,CAD,CHF,CLP,CNY,COP,CRC,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,ISK,JMD,JPY,KES,KGS,KHR,KMF,KRW,KYD,KZT,LAK,LBP,LKR,LRD,LSL,MAD,MDL,MKD,MNT,MOP,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SEK,SGD,SHP,SLL,SOS,SRD,STD,SVC,SYP,SZL,THB,TJS,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VES,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL" } [pm_filters.aci] credit = { country = "AD,AE,AT,BE,BG,CH,CN,CO,CR,CY,CZ,DE,DK,DO,EE,EG,ES,ET,FI,FR,GB,GH,GI,GR,GT,HN,HK,HR,HU,ID,IE,IS,IT,JP,KH,LA,LI,LT,LU,LY,MK,MM,MX,MY,MZ,NG,NZ,OM,PA,PE,PK,PL,PT,QA,RO,SA,SN,SE,SI,SK,SV,TH,UA,US,UY,VN,ZM", currency = "AED,ALL,ARS,BGN,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,EGP,EUR,GBP,GHS,HKD,HNL,HRK,HUF,IDR,ILS,ISK,JPY,KHR,KPW,LAK,LKR,MAD,MKD,MMK,MXN,MYR,MZN,NGN,NOK,NZD,OMR,PAB,PEN,PHP,PKR,PLN,QAR,RON,RSD,SAR,SEK,SGD,THB,TRY,TWD,UAH,USD,UYU,VND,ZAR,ZMW" } @@ -523,22 +525,22 @@ ali_pay = { country = "CN", currency = "CNY" } eps = { country = "AT", currency = "EUR" } ideal = { country = "NL", currency = "EUR" } giropay = { country = "DE", currency = "EUR" } -sofort = { country = "AT,BE,CH,DE,ES,GB,IT,NL,PL", currency = "CHF,EUR,GBP,HUF,PLN"} -interac = { country = "CA", currency = "CAD,USD"} +sofort = { country = "AT,BE,CH,DE,ES,GB,IT,NL,PL", currency = "CHF,EUR,GBP,HUF,PLN" } +interac = { country = "CA", currency = "CAD,USD" } przelewy24 = { country = "PL", currency = "CZK,EUR,GBP,PLN" } trustly = { country = "ES,GB,SE,NO,AT,NL,DE,DK,FI,EE,LT,LV", currency = "CZK,DKK,EUR,GBP,NOK,SEK" } klarna = { country = "AU,AT,BE,CA,CZ,DK,FI,FR,DE,GR,IE,IT,NL,NZ,NO,PL,PT,ES,SE,CH,GB,US", currency = "CHF,DKK,EUR,GBP,NOK,PLN,SEK,USD,AUD,NZD,CAD" } [pm_filters.authorizedotnet] -credit = {currency = "CAD,USD"} -debit = {currency = "CAD,USD"} -google_pay = {currency = "CHF,DKK,EUR,GBP,NOK,PLN,SEK,USD,AUD,NZD,CAD"} -apple_pay = {currency = "EUR,GBP,ISK,USD,AUD,CAD,BRL,CLP,COP,CRC,CZK,DKK,EGP,GEL,GHS,GTQ,HNL,HKD,HUF,ILS,INR,JPY,KZT,KRW,KWD,MAD,MXN,MYR,NOK,NZD,PEN,PLN,PYG,QAR,RON,SAR,SEK,SGD,THB,TWD,UAH,AED,VND,ZAR"} -paypal = {currency = "AUD,BRL,CAD,CHF,CNY,CZK,DKK,EUR,GBP,HKD,HUF,ILS,JPY,MXN,MYR,NOK,NZD,PHP,PLN,SEK,SGD,THB,TWD,USD"} +credit = { currency = "CAD,USD" } +debit = { currency = "CAD,USD" } +google_pay = { currency = "CHF,DKK,EUR,GBP,NOK,PLN,SEK,USD,AUD,NZD,CAD" } +apple_pay = { currency = "EUR,GBP,ISK,USD,AUD,CAD,BRL,CLP,COP,CRC,CZK,DKK,EGP,GEL,GHS,GTQ,HNL,HKD,HUF,ILS,INR,JPY,KZT,KRW,KWD,MAD,MXN,MYR,NOK,NZD,PEN,PLN,PYG,QAR,RON,SAR,SEK,SGD,THB,TWD,UAH,AED,VND,ZAR" } +paypal = { currency = "AUD,BRL,CAD,CHF,CNY,CZK,DKK,EUR,GBP,HKD,HUF,ILS,JPY,MXN,MYR,NOK,NZD,PHP,PLN,SEK,SGD,THB,TWD,USD" } [pm_filters.forte] -credit = { country = "US, CA", currency = "CAD,USD"} -debit = { country = "US, CA", currency = "CAD,USD"} +credit = { country = "US, CA", currency = "CAD,USD" } +debit = { country = "US, CA", currency = "CAD,USD" } [pm_filters.fiuu] duit_now = { country = "MY", currency = "MYR" } @@ -549,8 +551,8 @@ credit = { country = "CN,HK,ID,MY,PH,SG,TH,TW,VN", currency = "CNY,HKD,IDR,MYR,P debit = { country = "CN,HK,ID,MY,PH,SG,TH,TW,VN", currency = "CNY,HKD,IDR,MYR,PHP,SGD,THB,TWD,VND" } [pm_filters.placetopay] -credit = { country = "BE,CH,CO,CR,EC,HN,MX,PA,PR,UY", currency = "CLP,COP,USD"} -debit = { country = "BE,CH,CO,CR,EC,HN,MX,PA,PR,UY", currency = "CLP,COP,USD"} +credit = { country = "BE,CH,CO,CR,EC,HN,MX,PA,PR,UY", currency = "CLP,COP,USD" } +debit = { country = "BE,CH,CO,CR,EC,HN,MX,PA,PR,UY", currency = "CLP,COP,USD" } [pm_filters.coingate] crypto_currency = { country = "AL, AD, AT, BE, BA, BG, HR, CZ, DK, EE, FI, FR, DE, GR, HU, IS, IE, IT, LV, LT, LU, MT, MD, NL, NO, PL, PT, RO, RS, SK, SI, ES, SE, CH, UA, GB, AR, BR, CL, CO, CR, DO, SV, GD, MX, PE, LC, AU, NZ, CY, HK, IN, IL, JP, KR, QA, SA, SG, EG", currency = "EUR, USD, GBP" } @@ -704,4 +706,4 @@ redsys = { payment_method = "card" } [billing_connectors_payment_sync] billing_connectors_which_require_payment_sync = "stripebilling, recurly" [billing_connectors_invoice_sync] -billing_connectors_which_requires_invoice_sync_call = "recurly" \ No newline at end of file +billing_connectors_which_requires_invoice_sync_call = "recurly" diff --git a/scripts/add_connector.sh b/scripts/add_connector.sh index 534c1614a5e..648d2e68993 100755 --- a/scripts/add_connector.sh +++ b/scripts/add_connector.sh @@ -6,7 +6,7 @@ function find_prev_connector() { git checkout $self cp $self $self.tmp # Add new connector to existing list and sort it - connectors=(aci adyen adyenplatform airwallex amazonpay applepay archipel authorizedotnet bambora bamboraapac bankofamerica barclaycard billwerk bitpay bluesnap boku braintree cashtocode chargebee checkbook checkout coinbase cryptopay ctp_visa cybersource datatrans deutschebank digitalvirgo dlocal dummyconnector dwolla ebanx elavon facilitapay fiserv fiservemea fiuu forte getnet globalpay globepay gocardless gpayments helcim hipay hyperswitch_vault iatapay inespay itaubank jpmorgan juspaythreedsserver klarna mifinity mollie moneris multisafepay netcetera nexinets nexixpay nomupay noon nordea novalnet nuvei opayo opennode paybox payeezy payload payme payone paypal paystack payu placetopay plaid powertranz prophetpay rapyd razorpay recurly redsys santander shift4 square stax stripe stripebilling taxjar threedsecureio thunes tokenio trustpay tsys unified_authentication_service vgs volt wellsfargo wellsfargopayout wise worldline worldpay worldpayvantiv worldpayxml xendit zsl "$1") + connectors=(aci adyen adyenplatform airwallex amazonpay applepay archipel authorizedotnet bambora bamboraapac bankofamerica barclaycard billwerk bitpay bluesnap boku braintree cashtocode celero chargebee checkbook checkout coinbase cryptopay ctp_visa cybersource datatrans deutschebank digitalvirgo dlocal dummyconnector dwolla ebanx elavon facilitapay fiserv fiservemea fiuu forte getnet globalpay globepay gocardless gpayments helcim hipay hyperswitch_vault iatapay inespay itaubank jpmorgan juspaythreedsserver klarna mifinity mollie moneris multisafepay netcetera nexinets nexixpay nomupay noon nordea novalnet nuvei opayo opennode paybox payeezy payload payme payone paypal paystack payu placetopay plaid powertranz prophetpay rapyd razorpay recurly redsys santander shift4 square stax stripe stripebilling taxjar threedsecureio thunes tokenio trustpay tsys unified_authentication_service vgs volt wellsfargo wellsfargopayout wise worldline worldpay worldpayvantiv worldpayxml xendit zsl "$1") IFS=$'\n' sorted=($(sort <<<"${connectors[*]}")); unset IFS res="$(echo ${sorted[@]})" sed -i'' -e "s/^ connectors=.*/ connectors=($res \"\$1\")/" $self.tmp

2025-06-30T08:05:39Z

## Type of Change  - [ ] Bugfix - [x] New feature - [ ] Enhancement - [x] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  Template new connection integration `celero` ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  ## How did you test it?  No testing required as this is template ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [ ] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

9d7edb5cee030a13c8699a914a0d3600b058853d

juspay/hyperswitch

juspay__hyperswitch-8462

Bug: chore: bump tonic version bumping tonic version from 0.12 to 0.13.1

diff --git a/Cargo.lock b/Cargo.lock index 42add100ade..b578a5ff88f 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1186,14 +1186,14 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "3a6c9af12842a67734c9a2e355436e5d03b22383ed60cf13cd0c18fbfe3dcbcf" dependencies = [ "async-trait", - "axum-core", + "axum-core 0.4.3", "bytes 1.10.1", "futures-util", "http 1.3.1", "http-body 1.0.1", "http-body-util", "itoa", - "matchit", + "matchit 0.7.3", "memchr", "mime", "percent-encoding", @@ -1201,7 +1201,33 @@ dependencies = [ "rustversion", "serde", "sync_wrapper 1.0.1", - "tower", + "tower 0.4.13", + "tower-layer", + "tower-service", +] + +[[package]] +name = "axum" +version = "0.8.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "021e862c184ae977658b36c4500f7feac3221ca5da43e3f25bd04ab6c79a29b5" +dependencies = [ + "axum-core 0.5.2", + "bytes 1.10.1", + "futures-util", + "http 1.3.1", + "http-body 1.0.1", + "http-body-util", + "itoa", + "matchit 0.8.4", + "memchr", + "mime", + "percent-encoding", + "pin-project-lite", + "rustversion", + "serde", + "sync_wrapper 1.0.1", + "tower 0.5.2", "tower-layer", "tower-service", ] @@ -1226,6 +1252,25 @@ dependencies = [ "tower-service", ] +[[package]] +name = "axum-core" +version = "0.5.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "68464cd0412f486726fb3373129ef5d2993f90c34bc2bc1c1e9943b2f4fc7ca6" +dependencies = [ + "bytes 1.10.1", + "futures-core", + "http 1.3.1", + "http-body 1.0.1", + "http-body-util", + "mime", + "pin-project-lite", + "rustversion", + "sync_wrapper 1.0.1", + "tower-layer", + "tower-service", +] + [[package]] name = "backtrace" version = "0.3.74" @@ -2969,7 +3014,7 @@ dependencies = [ "serde", "thiserror 1.0.69", "tokio 1.45.1", - "tonic", + "tonic 0.13.1", "tonic-build", "tonic-reflection", "tonic-types", @@ -4704,6 +4749,12 @@ version = "0.7.3" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "0e7465ac9959cc2b1404e8e2367b43684a6d13790fe23056cc8c6c5a6b7bcb94" +[[package]] +name = "matchit" +version = "0.8.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "47e1ffaa40ddd1f3ed91f717a33c8c0ee23fff369e3aa8772b9605cc1d22f4c3" + [[package]] name = "maud" version = "0.26.0" @@ -5337,7 +5388,7 @@ dependencies = [ "prost", "thiserror 1.0.69", "tokio 1.45.1", - "tonic", + "tonic 0.12.3", ] [[package]] @@ -5349,7 +5400,7 @@ dependencies = [ "opentelemetry", "opentelemetry_sdk", "prost", - "tonic", + "tonic 0.12.3", ] [[package]] @@ -5951,8 +6002,8 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "f8650aabb6c35b860610e9cff5dc1af886c9e25073b7b1712a68972af4281302" dependencies = [ "bytes 1.10.1", - "heck 0.4.1", - "itertools 0.10.5", + "heck 0.5.0", + "itertools 0.13.0", "log", "multimap", "once_cell", @@ -5972,7 +6023,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "acf0c195eebb4af52c752bec4f52f645da98b6e92077a04110c7f349477ae5ac" dependencies = [ "anyhow", - "itertools 0.10.5", + "itertools 0.13.0", "proc-macro2", "quote", "syn 2.0.101", @@ -8796,7 +8847,7 @@ checksum = "877c5b330756d856ffcc4553ab34a5684481ade925ecc54bcd1bf02b1d0d4d52" dependencies = [ "async-stream", "async-trait", - "axum", + "axum 0.7.5", "base64 0.22.1", "bytes 1.10.1", "h2 0.4.8", @@ -8812,7 +8863,36 @@ dependencies = [ "socket2", "tokio 1.45.1", "tokio-stream", - "tower", + "tower 0.4.13", + "tower-layer", + "tower-service", + "tracing", +] + +[[package]] +name = "tonic" +version = "0.13.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7e581ba15a835f4d9ea06c55ab1bd4dce26fc53752c69a04aac00703bfb49ba9" +dependencies = [ + "async-trait", + "axum 0.8.4", + "base64 0.22.1", + "bytes 1.10.1", + "h2 0.4.8", + "http 1.3.1", + "http-body 1.0.1", + "http-body-util", + "hyper 1.6.0", + "hyper-timeout", + "hyper-util", + "percent-encoding", + "pin-project", + "prost", + "socket2", + "tokio 1.45.1", + "tokio-stream", + "tower 0.5.2", "tower-layer", "tower-service", "tracing", @@ -8820,39 +8900,40 @@ dependencies = [ [[package]] name = "tonic-build" -version = "0.12.2" +version = "0.13.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "fe4ee8877250136bd7e3d2331632810a4df4ea5e004656990d8d66d2f5ee8a67" +checksum = "eac6f67be712d12f0b41328db3137e0d0757645d8904b4cb7d51cd9c2279e847" dependencies = [ "prettyplease", "proc-macro2", "prost-build", + "prost-types", "quote", "syn 2.0.101", ] [[package]] name = "tonic-reflection" -version = "0.12.3" +version = "0.13.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "878d81f52e7fcfd80026b7fdb6a9b578b3c3653ba987f87f0dce4b64043cba27" +checksum = "f9687bd5bfeafebdded2356950f278bba8226f0b32109537c4253406e09aafe1" dependencies = [ "prost", "prost-types", "tokio 1.45.1", "tokio-stream", - "tonic", + "tonic 0.13.1", ] [[package]] name = "tonic-types" -version = "0.12.3" +version = "0.13.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0081d8ee0847d01271392a5aebe960a4600f5d4da6c67648a6382a0940f8b367" +checksum = "07439468da24d5f211d3f3bd7b63665d8f45072804457e838a87414a478e2db8" dependencies = [ "prost", "prost-types", - "tonic", + "tonic 0.13.1", ] [[package]] @@ -8891,6 +8972,25 @@ dependencies = [ "tracing", ] +[[package]] +name = "tower" +version = "0.5.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d039ad9159c98b70ecfd540b2573b97f7f52c3e8d9f8ad57a24b916a536975f9" +dependencies = [ + "futures-core", + "futures-util", + "indexmap 2.9.0", + "pin-project-lite", + "slab", + "sync_wrapper 1.0.1", + "tokio 1.45.1", + "tokio-util", + "tower-layer", + "tower-service", + "tracing", +] + [[package]] name = "tower-layer" version = "0.3.3" @@ -9057,7 +9157,7 @@ version = "1.6.3" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "97fee6b57c6a41524a810daee9286c02d7752c4253064d0b05472833a438f675" dependencies = [ - "cfg-if 0.1.10", + "cfg-if 1.0.0", "static_assertions", ] @@ -9610,7 +9710,7 @@ version = "0.1.9" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "cf221c93e13a30d793f7645a0e7762c55d169dbb0a49671918a2319d289b10bb" dependencies = [ - "windows-sys 0.48.0", + "windows-sys 0.59.0", ] [[package]] diff --git a/crates/external_services/Cargo.toml b/crates/external_services/Cargo.toml index 34aca99f399..4002e117c62 100644 --- a/crates/external_services/Cargo.toml +++ b/crates/external_services/Cargo.toml @@ -48,9 +48,9 @@ thiserror = "1.0.69" vaultrs = { version = "0.7.4", optional = true } prost = { version = "0.13", optional = true } tokio = "1.45.1" -tonic = { version = "0.12.3", optional = true } -tonic-reflection = { version = "0.12.3", optional = true } -tonic-types = { version = "0.12.3", optional = true } +tonic = { version = "0.13.1", optional = true } +tonic-reflection = { version = "0.13.1", optional = true } +tonic-types = { version = "0.13.1", optional = true } hyper-util = { version = "0.1.12", optional = true } http-body-util = { version = "0.1.3", optional = true } reqwest = { version = "0.11.27", features = ["rustls-tls"] } @@ -71,7 +71,7 @@ api_models = { version = "0.1.0", path = "../api_models", optional = true } [build-dependencies] -tonic-build = { version = "0.12", optional = true } +tonic-build = { version = "0.13.1", optional = true } router_env = { version = "0.1.0", path = "../router_env", default-features = false, optional = true } [lints] diff --git a/crates/external_services/build.rs b/crates/external_services/build.rs index 8dba0bb3e98..c9d9017560b 100644 --- a/crates/external_services/build.rs +++ b/crates/external_services/build.rs @@ -14,7 +14,7 @@ fn main() -> Result<(), Box<dyn std::error::Error>> { // Compile the .proto file tonic_build::configure() .out_dir(out_dir) - .compile( + .compile_protos( &[ success_rate_proto_file, health_check_proto_file, diff --git a/crates/external_services/src/grpc_client.rs b/crates/external_services/src/grpc_client.rs index 7a627d3ab27..45b98c51154 100644 --- a/crates/external_services/src/grpc_client.rs +++ b/crates/external_services/src/grpc_client.rs @@ -13,20 +13,16 @@ use dynamic_routing::{DynamicRoutingClientConfig, RoutingStrategy}; #[cfg(feature = "dynamic_routing")] use health_check_client::HealthCheckClient; #[cfg(feature = "dynamic_routing")] -use http_body_util::combinators::UnsyncBoxBody; -#[cfg(feature = "dynamic_routing")] -use hyper::body::Bytes; -#[cfg(feature = "dynamic_routing")] use hyper_util::client::legacy::connect::HttpConnector; #[cfg(feature = "dynamic_routing")] use router_env::logger; use serde; #[cfg(feature = "dynamic_routing")] -use tonic::Status; +use tonic::body::Body; #[cfg(feature = "dynamic_routing")] /// Hyper based Client type for maintaining connection pool for all gRPC services -pub type Client = hyper_util::client::legacy::Client<HttpConnector, UnsyncBoxBody<Bytes, Status>>; +pub type Client = hyper_util::client::legacy::Client<HttpConnector, Body>; /// Struct contains all the gRPC Clients #[derive(Debug, Clone)]

2025-06-25T12:29:54Z

## Type of Change  - [ ] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description bumping tonic version from 0.12 to 0.13 ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  ## How did you test it? - The client connection was success <img width="1725" alt="Screenshot 2025-06-25 at 6 00 12 PM" src="https://github.com/user-attachments/assets/7981c4cc-041e-4426-a158-d66af2d1e2cd" /> - got response for the health check api ``` { "database": true, "redis": true, "analytics": true, "opensearch": false, "outgoing_request": true, "grpc_health_check": { "dynamic_routing_service": true }, "decision_engine": false } ``` ## Checklist  - [ ] I formatted the code `cargo +nightly fmt --all` - [ ] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.114.0

0a06ad91252d76d0c937344d8c76c9a2bbbc84d7

juspay/hyperswitch

juspay__hyperswitch-8464

Bug: [FEATURE] allow data migration at profile level ### Feature Description The `migrate_payment_methods` API is used for migrating customer and payment method data. Currently, it operates at the merchant level, but since the `merchant_connector_id` is tied to a specific profile, migrations are limited to a single profile at a time. This feature aims to enhance the data migration process to support multiple profiles. The goal is to allow a single payment method to be migrated across several `merchant_connector_id`s, enabling data migration at the profile level. ### Implementation Plan Below are the the changes: **Customer Data Migration:** * Update `PaymentMethodRecord` to allow `merchant_connector_id` and `connector_customer_id` to accept comma-separated strings. * Update `PaymentMethodCustomerMigrate` to handle a list of connector customer details. * The `From` implementation for `PaymentMethodCustomerMigrate` will be updated to parse these new comma-separated strings. * Finally, update the `create_customer` function to handle the list of connector details, allowing a customer to be associated with multiple connector accounts. **Payment Method Migration:** * Update `PaymentMethodsMigrateForm` to accept a comma-separated string for `merchant_connector_id`. * The functions `get_payment_method_records` and `migrate_payment_methods` will be updated to handle this change. * The `TryFrom` implementation for `PaymentMethodMigrate` will be modified to create a `PaymentsMandateReference` for each `merchant_connector_id` in the comma-separated string. All changes will be backward-compatible. ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? Yes, I am willing to submit a PR!

diff --git a/crates/api_models/src/payment_methods.rs b/crates/api_models/src/payment_methods.rs index c681cf7edd0..b3e76e37291 100644 --- a/crates/api_models/src/payment_methods.rs +++ b/crates/api_models/src/payment_methods.rs @@ -19,7 +19,7 @@ use utoipa::{schema, ToSchema}; #[cfg(feature = "payouts")] use crate::payouts; use crate::{ - admin, customers, enums as api_enums, + admin, enums as api_enums, payments::{self, BankCodeResponse}, }; @@ -2517,6 +2517,7 @@ pub struct PaymentMethodRecord { pub billing_address_line3: Option<masking::Secret<String>>, pub raw_card_number: Option<masking::Secret<String>>, pub merchant_connector_id: Option<id_type::MerchantConnectorAccountId>, + pub merchant_connector_ids: Option<String>, pub original_transaction_amount: Option<i64>, pub original_transaction_currency: Option<common_enums::Currency>, pub line_number: Option<i64>, @@ -2526,18 +2527,6 @@ pub struct PaymentMethodRecord { pub network_token_requestor_ref_id: Option<String>, } -#[derive(Debug, Clone, serde::Deserialize, serde::Serialize)] -pub struct ConnectorCustomerDetails { - pub connector_customer_id: String, - pub merchant_connector_id: id_type::MerchantConnectorAccountId, -} - -#[derive(Debug, Clone, serde::Deserialize, serde::Serialize)] -pub struct PaymentMethodCustomerMigrate { - pub customer: customers::CustomerRequest, - pub connector_customer_details: Option<ConnectorCustomerDetails>, -} - #[derive(Debug, Default, serde::Serialize)] pub struct PaymentMethodMigrationResponse { pub line_number: Option<i64>, @@ -2654,47 +2643,56 @@ impl From<PaymentMethodMigrationResponseType> for PaymentMethodMigrationResponse impl TryFrom<( - PaymentMethodRecord, + &PaymentMethodRecord, id_type::MerchantId, - Option<id_type::MerchantConnectorAccountId>, + Option<&Vec<id_type::MerchantConnectorAccountId>>, )> for PaymentMethodMigrate { type Error = error_stack::Report<errors::ValidationError>; + fn try_from( item: ( - PaymentMethodRecord, + &PaymentMethodRecord, id_type::MerchantId, - Option<id_type::MerchantConnectorAccountId>, + Option<&Vec<id_type::MerchantConnectorAccountId>>, ), ) -> Result<Self, Self::Error> { - let (record, merchant_id, mca_id) = item; + let (record, merchant_id, mca_ids) = item; let billing = record.create_billing(); - - // if payment instrument id is present then only construct this - let connector_mandate_details = if record.payment_instrument_id.is_some() { - Some(PaymentsMandateReference(HashMap::from([( - mca_id.get_required_value("merchant_connector_id")?, - PaymentsMandateReferenceRecord { - connector_mandate_id: record - .payment_instrument_id - .get_required_value("payment_instrument_id")? - .peek() - .to_string(), - payment_method_type: record.payment_method_type, - original_payment_authorized_amount: record.original_transaction_amount, - original_payment_authorized_currency: record.original_transaction_currency, - }, - )]))) + let connector_mandate_details = if let Some(payment_instrument_id) = + &record.payment_instrument_id + { + let ids = mca_ids.get_required_value("mca_ids")?; + let mandate_map: HashMap<_, _> = ids + .iter() + .map(|mca_id| { + ( + mca_id.clone(), + PaymentsMandateReferenceRecord { + connector_mandate_id: payment_instrument_id.peek().to_string(), + payment_method_type: record.payment_method_type, + original_payment_authorized_amount: record.original_transaction_amount, + original_payment_authorized_currency: record + .original_transaction_currency, + }, + ) + }) + .collect(); + Some(PaymentsMandateReference(mandate_map)) } else { None }; + Ok(Self { merchant_id, - customer_id: Some(record.customer_id), + customer_id: Some(record.customer_id.clone()), card: Some(MigrateCardDetail { - card_number: record.raw_card_number.unwrap_or(record.card_number_masked), - card_exp_month: record.card_expiry_month, - card_exp_year: record.card_expiry_year, + card_number: record + .raw_card_number + .clone() + .unwrap_or_else(|| record.card_number_masked.clone()), + card_exp_month: record.card_expiry_month.clone(), + card_exp_year: record.card_expiry_year.clone(), card_holder_name: record.name.clone(), card_network: None, card_type: None, @@ -2704,10 +2702,16 @@ impl }), network_token: Some(MigrateNetworkTokenDetail { network_token_data: MigrateNetworkTokenData { - network_token_number: record.network_token_number.unwrap_or_default(), - network_token_exp_month: record.network_token_expiry_month.unwrap_or_default(), - network_token_exp_year: record.network_token_expiry_year.unwrap_or_default(), - card_holder_name: record.name, + network_token_number: record.network_token_number.clone().unwrap_or_default(), + network_token_exp_month: record + .network_token_expiry_month + .clone() + .unwrap_or_default(), + network_token_exp_year: record + .network_token_expiry_year + .clone() + .unwrap_or_default(), + card_holder_name: record.name.clone(), nick_name: record.nick_name.clone(), card_issuing_country: None, card_network: None, @@ -2716,6 +2720,7 @@ impl }, network_token_requestor_ref_id: record .network_token_requestor_ref_id + .clone() .unwrap_or_default(), }), payment_method: record.payment_method, @@ -2740,45 +2745,6 @@ impl } } -#[cfg(feature = "v1")] -impl From<(PaymentMethodRecord, id_type::MerchantId)> for PaymentMethodCustomerMigrate { - fn from(value: (PaymentMethodRecord, id_type::MerchantId)) -> Self { - let (record, merchant_id) = value; - Self { - customer: customers::CustomerRequest { - customer_id: Some(record.customer_id), - merchant_id, - name: record.name, - email: record.email, - phone: record.phone, - description: None, - phone_country_code: record.phone_country_code, - address: Some(payments::AddressDetails { - city: record.billing_address_city, - country: record.billing_address_country, - line1: record.billing_address_line1, - line2: record.billing_address_line2, - state: record.billing_address_state, - line3: record.billing_address_line3, - zip: record.billing_address_zip, - first_name: record.billing_address_first_name, - last_name: record.billing_address_last_name, - }), - metadata: None, - }, - connector_customer_details: record - .connector_customer_id - .zip(record.merchant_connector_id) - .map( - |(connector_customer_id, merchant_connector_id)| ConnectorCustomerDetails { - connector_customer_id, - merchant_connector_id, - }, - ), - } - } -} - #[derive(Debug, serde::Deserialize, serde::Serialize, ToSchema)] pub struct CardNetworkTokenizeRequest { /// Merchant ID associated with the tokenization request diff --git a/crates/hyperswitch_domain_models/src/lib.rs b/crates/hyperswitch_domain_models/src/lib.rs index 4ee8620e35e..35570036c20 100644 --- a/crates/hyperswitch_domain_models/src/lib.rs +++ b/crates/hyperswitch_domain_models/src/lib.rs @@ -36,6 +36,7 @@ pub mod router_response_types; pub mod routing; #[cfg(feature = "tokenization_v2")] pub mod tokenization; +pub mod transformers; pub mod type_encryption; pub mod types; pub mod vault; diff --git a/crates/hyperswitch_domain_models/src/payment_methods.rs b/crates/hyperswitch_domain_models/src/payment_methods.rs index 0f6d4d6f924..aa01465408e 100644 --- a/crates/hyperswitch_domain_models/src/payment_methods.rs +++ b/crates/hyperswitch_domain_models/src/payment_methods.rs @@ -1,5 +1,6 @@ #[cfg(feature = "v2")] use api_models::payment_methods::PaymentMethodsData; +use api_models::{customers, payment_methods, payments}; // specific imports because of using the macro use common_enums::enums::MerchantStorageScheme; #[cfg(feature = "v1")] @@ -27,11 +28,12 @@ use time::PrimitiveDateTime; #[cfg(feature = "v2")] use crate::address::Address; #[cfg(feature = "v1")] -use crate::{mandates, type_encryption::AsyncLift}; +use crate::type_encryption::AsyncLift; use crate::{ - mandates::CommonMandateReference, + mandates::{self, CommonMandateReference}, merchant_key_store::MerchantKeyStore, payment_method_data as domain_payment_method_data, + transformers::ForeignTryFrom, type_encryption::{crypto_operation, CryptoOperation}, }; @@ -87,7 +89,6 @@ pub struct PaymentMethod { pub network_token_locker_id: Option<String>, pub network_token_payment_method_data: OptionalEncryptableValue, } - #[cfg(feature = "v2")] #[derive(Clone, Debug, router_derive::ToEncryption)] pub struct PaymentMethod { @@ -915,6 +916,136 @@ pub struct PaymentMethodsSessionUpdateInternal { pub tokenization_data: Option<pii::SecretSerdeValue>, } +#[derive(Debug, Clone, serde::Deserialize, serde::Serialize)] +pub struct ConnectorCustomerDetails { + pub connector_customer_id: String, + pub merchant_connector_id: id_type::MerchantConnectorAccountId, +} + +#[derive(Debug, Clone, serde::Deserialize, serde::Serialize)] +pub struct PaymentMethodCustomerMigrate { + pub customer: customers::CustomerRequest, + pub connector_customer_details: Option<Vec<ConnectorCustomerDetails>>, +} + +#[cfg(feature = "v1")] +impl TryFrom<(payment_methods::PaymentMethodRecord, id_type::MerchantId)> + for PaymentMethodCustomerMigrate +{ + type Error = error_stack::Report<ValidationError>; + fn try_from( + value: (payment_methods::PaymentMethodRecord, id_type::MerchantId), + ) -> Result<Self, Self::Error> { + let (record, merchant_id) = value; + let connector_customer_details = record + .connector_customer_id + .and_then(|connector_customer_id| { + // Handle single merchant_connector_id + record + .merchant_connector_id + .as_ref() + .map(|merchant_connector_id| { + Ok(vec![ConnectorCustomerDetails { + connector_customer_id: connector_customer_id.clone(), + merchant_connector_id: merchant_connector_id.clone(), + }]) + }) + // Handle comma-separated merchant_connector_ids + .or_else(|| { + record + .merchant_connector_ids + .as_ref() + .map(|merchant_connector_ids_str| { + merchant_connector_ids_str + .split(',') + .map(|id| id.trim()) + .filter(|id| !id.is_empty()) + .map(|merchant_connector_id| { + id_type::MerchantConnectorAccountId::wrap( + merchant_connector_id.to_string(), + ) + .map_err(|_| { + error_stack::report!(ValidationError::InvalidValue { + message: format!( + "Invalid merchant_connector_account_id: {}", + merchant_connector_id + ), + }) + }) + .map( + |merchant_connector_id| ConnectorCustomerDetails { + connector_customer_id: connector_customer_id + .clone(), + merchant_connector_id, + }, + ) + }) + .collect::<Result<Vec<_>, _>>() + }) + }) + }) + .transpose()?; + + Ok(Self { + customer: customers::CustomerRequest { + customer_id: Some(record.customer_id), + merchant_id, + name: record.name, + email: record.email, + phone: record.phone, + description: None, + phone_country_code: record.phone_country_code, + address: Some(payments::AddressDetails { + city: record.billing_address_city, + country: record.billing_address_country, + line1: record.billing_address_line1, + line2: record.billing_address_line2, + state: record.billing_address_state, + line3: record.billing_address_line3, + zip: record.billing_address_zip, + first_name: record.billing_address_first_name, + last_name: record.billing_address_last_name, + }), + metadata: None, + }, + connector_customer_details, + }) + } +} + +#[cfg(feature = "v1")] +impl ForeignTryFrom<(&[payment_methods::PaymentMethodRecord], id_type::MerchantId)> + for Vec<PaymentMethodCustomerMigrate> +{ + type Error = error_stack::Report<ValidationError>; + + fn foreign_try_from( + (records, merchant_id): (&[payment_methods::PaymentMethodRecord], id_type::MerchantId), + ) -> Result<Self, Self::Error> { + let (customers_migration, migration_errors): (Self, Vec<_>) = records + .iter() + .map(|record| { + PaymentMethodCustomerMigrate::try_from((record.clone(), merchant_id.clone())) + }) + .fold((Self::new(), Vec::new()), |mut acc, result| { + match result { + Ok(customer) => acc.0.push(customer), + Err(e) => acc.1.push(e.to_string()), + } + acc + }); + + migration_errors + .is_empty() + .then_some(customers_migration) + .ok_or_else(|| { + error_stack::report!(ValidationError::InvalidValue { + message: migration_errors.join(", "), + }) + }) + } +} + #[cfg(feature = "v1")] #[cfg(test)] mod tests { diff --git a/crates/hyperswitch_domain_models/src/transformers.rs b/crates/hyperswitch_domain_models/src/transformers.rs new file mode 100644 index 00000000000..1208d80c323 --- /dev/null +++ b/crates/hyperswitch_domain_models/src/transformers.rs @@ -0,0 +1,9 @@ +pub trait ForeignFrom<F> { + fn foreign_from(from: F) -> Self; +} + +pub trait ForeignTryFrom<F>: Sized { + type Error; + + fn foreign_try_from(from: F) -> Result<Self, Self::Error>; +} diff --git a/crates/payment_methods/src/core/migration.rs b/crates/payment_methods/src/core/migration.rs index 8b2694cf6fe..6b7ce30b4c5 100644 --- a/crates/payment_methods/src/core/migration.rs +++ b/crates/payment_methods/src/core/migration.rs @@ -24,20 +24,22 @@ pub async fn migrate_payment_methods( payment_methods: Vec<pm_api::PaymentMethodRecord>, merchant_id: &common_utils::id_type::MerchantId, merchant_context: &merchant_context::MerchantContext, - mca_id: Option<common_utils::id_type::MerchantConnectorAccountId>, + mca_ids: Option<Vec<common_utils::id_type::MerchantConnectorAccountId>>, controller: &dyn pm::PaymentMethodsController, ) -> PmMigrationResult<Vec<pm_api::PaymentMethodMigrationResponse>> { - let mut result = Vec::new(); + let mut result = Vec::with_capacity(payment_methods.len()); + for record in payment_methods { let req = pm_api::PaymentMethodMigrate::try_from(( - record.clone(), + &record, merchant_id.clone(), - mca_id.clone(), + mca_ids.as_ref(), )) .map_err(|err| errors::ApiErrorResponse::InvalidRequestData { message: format!("error: {:?}", err), }) .attach_printable("record deserialization failed"); + let res = match req { Ok(migrate_request) => { let res = migrate_payment_method( @@ -56,6 +58,7 @@ pub async fn migrate_payment_methods( } Err(e) => Err(e.to_string()), }; + result.push(pm_api::PaymentMethodMigrationResponse::from((res, record))); } Ok(api::ApplicationResponse::Json(result)) @@ -69,7 +72,138 @@ pub struct PaymentMethodsMigrateForm { pub merchant_id: text::Text<common_utils::id_type::MerchantId>, pub merchant_connector_id: - text::Text<Option<common_utils::id_type::MerchantConnectorAccountId>>, + Option<text::Text<common_utils::id_type::MerchantConnectorAccountId>>, + + pub merchant_connector_ids: Option<text::Text<String>>, +} + +struct MerchantConnectorValidator; + +impl MerchantConnectorValidator { + fn parse_comma_separated_ids( + ids_string: &str, + ) -> Result<Vec<common_utils::id_type::MerchantConnectorAccountId>, errors::ApiErrorResponse> + { + // Estimate capacity based on comma count + let capacity = ids_string.matches(',').count() + 1; + let mut result = Vec::with_capacity(capacity); + + for id in ids_string.split(',') { + let trimmed_id = id.trim(); + if !trimmed_id.is_empty() { + let mca_id = + common_utils::id_type::MerchantConnectorAccountId::wrap(trimmed_id.to_string()) + .map_err(|_| errors::ApiErrorResponse::InvalidRequestData { + message: format!( + "Invalid merchant_connector_account_id: {}", + trimmed_id + ), + })?; + result.push(mca_id); + } + } + + Ok(result) + } + + fn validate_form_csv_conflicts( + records: &[pm_api::PaymentMethodRecord], + form_has_single_id: bool, + form_has_multiple_ids: bool, + ) -> Result<(), errors::ApiErrorResponse> { + if form_has_single_id { + // If form has merchant_connector_id, CSV records should not have merchant_connector_ids + for (index, record) in records.iter().enumerate() { + if record.merchant_connector_ids.is_some() { + return Err(errors::ApiErrorResponse::InvalidRequestData { + message: format!( + "Record at line {} has merchant_connector_ids but form has merchant_connector_id. Only one should be provided", + index + 1 + ), + }); + } + } + } + + if form_has_multiple_ids { + // If form has merchant_connector_ids, CSV records should not have merchant_connector_id + for (index, record) in records.iter().enumerate() { + if record.merchant_connector_id.is_some() { + return Err(errors::ApiErrorResponse::InvalidRequestData { + message: format!( + "Record at line {} has merchant_connector_id but form has merchant_connector_ids. Only one should be provided", + index + 1 + ), + }); + } + } + } + + Ok(()) + } +} + +type MigrationValidationResult = Result< + ( + common_utils::id_type::MerchantId, + Vec<pm_api::PaymentMethodRecord>, + Option<Vec<common_utils::id_type::MerchantConnectorAccountId>>, + ), + errors::ApiErrorResponse, +>; + +impl PaymentMethodsMigrateForm { + pub fn validate_and_get_payment_method_records(self) -> MigrationValidationResult { + // Step 1: Validate form-level conflicts + let form_has_single_id = self.merchant_connector_id.is_some(); + let form_has_multiple_ids = self.merchant_connector_ids.is_some(); + + if form_has_single_id && form_has_multiple_ids { + return Err(errors::ApiErrorResponse::InvalidRequestData { + message: "Both merchant_connector_id and merchant_connector_ids cannot be provided" + .to_string(), + }); + } + + // Ensure at least one is provided + if !form_has_single_id && !form_has_multiple_ids { + return Err(errors::ApiErrorResponse::InvalidRequestData { + message: "Either merchant_connector_id or merchant_connector_ids must be provided" + .to_string(), + }); + } + + // Step 2: Parse CSV + let records = parse_csv(self.file.data.to_bytes()).map_err(|e| { + errors::ApiErrorResponse::PreconditionFailed { + message: e.to_string(), + } + })?; + + // Step 3: Validate CSV vs Form conflicts + MerchantConnectorValidator::validate_form_csv_conflicts( + &records, + form_has_single_id, + form_has_multiple_ids, + )?; + + // Step 4: Prepare the merchant connector account IDs for return + let mca_ids = if let Some(ref single_id) = self.merchant_connector_id { + Some(vec![(**single_id).clone()]) + } else if let Some(ref ids_string) = self.merchant_connector_ids { + let parsed_ids = MerchantConnectorValidator::parse_comma_separated_ids(ids_string)?; + if parsed_ids.is_empty() { + None + } else { + Some(parsed_ids) + } + } else { + None + }; + + // Step 5: Return the updated structure + Ok((self.merchant_id.clone(), records, mca_ids)) + } } fn parse_csv(data: &[u8]) -> csv::Result<Vec<pm_api::PaymentMethodRecord>> { @@ -84,27 +218,6 @@ fn parse_csv(data: &[u8]) -> csv::Result<Vec<pm_api::PaymentMethodRecord>> { } Ok(records) } -pub fn get_payment_method_records( - form: PaymentMethodsMigrateForm, -) -> Result< - ( - common_utils::id_type::MerchantId, - Vec<pm_api::PaymentMethodRecord>, - Option<common_utils::id_type::MerchantConnectorAccountId>, - ), - errors::ApiErrorResponse, -> { - match parse_csv(form.file.data.to_bytes()) { - Ok(records) => { - let merchant_id = form.merchant_id.clone(); - let mca_id = form.merchant_connector_id.clone(); - Ok((merchant_id.clone(), records, mca_id)) - } - Err(e) => Err(errors::ApiErrorResponse::PreconditionFailed { - message: e.to_string(), - }), - } -} #[instrument(skip_all)] pub fn validate_card_expiry( diff --git a/crates/router/src/core/customers.rs b/crates/router/src/core/customers.rs index 2cad1d91eb8..43dbf28c0e0 100644 --- a/crates/router/src/core/customers.rs +++ b/crates/router/src/core/customers.rs @@ -9,6 +9,7 @@ use common_utils::{ }, }; use error_stack::{report, ResultExt}; +use hyperswitch_domain_models::payment_methods as payment_methods_domain; use masking::{ExposeInterface, Secret, SwitchStrategy}; use payment_methods::controller::PaymentMethodsController; use router_env::{instrument, tracing}; @@ -27,7 +28,7 @@ use crate::{ routes::{metrics, SessionState}, services, types::{ - api::{customers, payment_methods as payment_methods_api}, + api::customers, domain::{self, types}, storage::{self, enums}, transformers::ForeignFrom, @@ -41,7 +42,7 @@ pub async fn create_customer( state: SessionState, merchant_context: domain::MerchantContext, customer_data: customers::CustomerRequest, - connector_customer_details: Option<payment_methods_api::ConnectorCustomerDetails>, + connector_customer_details: Option<Vec<payment_methods_domain::ConnectorCustomerDetails>>, ) -> errors::CustomerResponse<customers::CustomerResponse> { let db: &dyn StorageInterface = state.store.as_ref(); let key_manager_state = &(&state).into(); @@ -96,7 +97,9 @@ pub async fn create_customer( trait CustomerCreateBridge { async fn create_domain_model_from_request<'a>( &'a self, - connector_customer_details: &'a Option<payment_methods_api::ConnectorCustomerDetails>, + connector_customer_details: &'a Option< + Vec<payment_methods_domain::ConnectorCustomerDetails>, + >, db: &'a dyn StorageInterface, merchant_reference_id: &'a Option<id_type::CustomerId>, merchant_context: &'a domain::MerchantContext, @@ -115,7 +118,9 @@ trait CustomerCreateBridge { impl CustomerCreateBridge for customers::CustomerRequest { async fn create_domain_model_from_request<'a>( &'a self, - connector_customer_details: &'a Option<payment_methods_api::ConnectorCustomerDetails>, + connector_customer_details: &'a Option< + Vec<payment_methods_domain::ConnectorCustomerDetails>, + >, db: &'a dyn StorageInterface, merchant_reference_id: &'a Option<id_type::CustomerId>, merchant_context: &'a domain::MerchantContext, @@ -175,13 +180,15 @@ impl CustomerCreateBridge for customers::CustomerRequest { domain::FromRequestEncryptableCustomer::from_encryptable(encrypted_data) .change_context(errors::CustomersErrorResponse::InternalServerError)?; - let connector_customer = connector_customer_details.as_ref().map(|details| { - let merchant_connector_id = details.merchant_connector_id.get_string_repr().to_string(); - let connector_customer_id = details.connector_customer_id.to_string(); - let object = serde_json::json!({ - merchant_connector_id: connector_customer_id - }); - pii::SecretSerdeValue::new(object) + let connector_customer = connector_customer_details.as_ref().map(|details_vec| { + let mut map = serde_json::Map::new(); + for details in details_vec { + let merchant_connector_id = + details.merchant_connector_id.get_string_repr().to_string(); + let connector_customer_id = details.connector_customer_id.clone(); + map.insert(merchant_connector_id, connector_customer_id.into()); + } + pii::SecretSerdeValue::new(serde_json::Value::Object(map)) }); Ok(domain::Customer { @@ -227,7 +234,9 @@ impl CustomerCreateBridge for customers::CustomerRequest { impl CustomerCreateBridge for customers::CustomerRequest { async fn create_domain_model_from_request<'a>( &'a self, - connector_customer_details: &'a Option<payment_methods_api::ConnectorCustomerDetails>, + connector_customer_details: &'a Option< + Vec<payment_methods_domain::ConnectorCustomerDetails>, + >, _db: &'a dyn StorageInterface, merchant_reference_id: &'a Option<id_type::CustomerId>, merchant_context: &'a domain::MerchantContext, @@ -297,12 +306,16 @@ impl CustomerCreateBridge for customers::CustomerRequest { domain::FromRequestEncryptableCustomer::from_encryptable(encrypted_data) .change_context(errors::CustomersErrorResponse::InternalServerError)?; - let connector_customer = connector_customer_details.as_ref().map(|details| { - let mut map = std::collections::HashMap::new(); - map.insert( - details.merchant_connector_id.clone(), - details.connector_customer_id.to_string(), - ); + let connector_customer = connector_customer_details.as_ref().map(|details_vec| { + let map: std::collections::HashMap<_, _> = details_vec + .iter() + .map(|details| { + ( + details.merchant_connector_id.clone(), + details.connector_customer_id.to_string(), + ) + }) + .collect(); common_types::customers::ConnectorCustomerMap::new(map) }); @@ -1060,7 +1073,9 @@ pub async fn update_customer( trait CustomerUpdateBridge { async fn create_domain_model_from_request<'a>( &'a self, - connector_customer_details: &'a Option<payment_methods_api::ConnectorCustomerDetails>, + connector_customer_details: &'a Option< + Vec<payment_methods_domain::ConnectorCustomerDetails>, + >, db: &'a dyn StorageInterface, merchant_context: &'a domain::MerchantContext, key_manager_state: &'a KeyManagerState, @@ -1232,7 +1247,9 @@ impl VerifyIdForUpdateCustomer<'_> { impl CustomerUpdateBridge for customers::CustomerUpdateRequest { async fn create_domain_model_from_request<'a>( &'a self, - _connector_customer_details: &'a Option<payment_methods_api::ConnectorCustomerDetails>, + _connector_customer_details: &'a Option< + Vec<payment_methods_domain::ConnectorCustomerDetails>, + >, db: &'a dyn StorageInterface, merchant_context: &'a domain::MerchantContext, key_manager_state: &'a KeyManagerState, @@ -1337,7 +1354,9 @@ impl CustomerUpdateBridge for customers::CustomerUpdateRequest { impl CustomerUpdateBridge for customers::CustomerUpdateRequest { async fn create_domain_model_from_request<'a>( &'a self, - connector_customer_details: &'a Option<payment_methods_api::ConnectorCustomerDetails>, + connector_customer_details: &'a Option< + Vec<payment_methods_domain::ConnectorCustomerDetails>, + >, db: &'a dyn StorageInterface, merchant_context: &'a domain::MerchantContext, key_manager_state: &'a KeyManagerState, @@ -1454,7 +1473,7 @@ impl CustomerUpdateBridge for customers::CustomerUpdateRequest { pub async fn migrate_customers( state: SessionState, - customers_migration: Vec<payment_methods_api::PaymentMethodCustomerMigrate>, + customers_migration: Vec<payment_methods_domain::PaymentMethodCustomerMigrate>, merchant_context: domain::MerchantContext, ) -> errors::CustomerResponse<()> { for customer_migration in customers_migration { diff --git a/crates/router/src/routes/payment_methods.rs b/crates/router/src/routes/payment_methods.rs index 20d0121ebde..31558c2d323 100644 --- a/crates/router/src/routes/payment_methods.rs +++ b/crates/router/src/routes/payment_methods.rs @@ -10,6 +10,7 @@ use diesel_models::enums::IntentStatus; use error_stack::ResultExt; use hyperswitch_domain_models::{ bulk_tokenization::CardNetworkTokenizeRequest, merchant_key_store::MerchantKeyStore, + payment_methods::PaymentMethodCustomerMigrate, transformers::ForeignTryFrom, }; use router_env::{instrument, logger, tracing, Flow}; @@ -331,10 +332,10 @@ pub async fn migrate_payment_methods( MultipartForm(form): MultipartForm<migration::PaymentMethodsMigrateForm>, ) -> HttpResponse { let flow = Flow::PaymentMethodsMigrate; - let (merchant_id, records, merchant_connector_id) = - match migration::get_payment_method_records(form) { - Ok((merchant_id, records, merchant_connector_id)) => { - (merchant_id, records, merchant_connector_id) + let (merchant_id, records, merchant_connector_ids) = + match form.validate_and_get_payment_method_records() { + Ok((merchant_id, records, merchant_connector_ids)) => { + (merchant_id, records, merchant_connector_ids) } Err(e) => return api::log_and_return_error_response(e.into()), }; @@ -345,7 +346,7 @@ pub async fn migrate_payment_methods( records, |state, _, req, _| { let merchant_id = merchant_id.clone(); - let merchant_connector_id = merchant_connector_id.clone(); + let merchant_connector_ids = merchant_connector_ids.clone(); async move { let (key_store, merchant_account) = get_merchant_account(&state, &merchant_id).await?; @@ -354,20 +355,43 @@ pub async fn migrate_payment_methods( domain::Context(merchant_account.clone(), key_store.clone()), )); - customers::migrate_customers( - state.clone(), - req.iter() - .map(|e| { - payment_methods::PaymentMethodCustomerMigrate::from(( - e.clone(), - merchant_id.clone(), - )) - }) - .collect(), - merchant_context.clone(), - ) - .await - .change_context(errors::ApiErrorResponse::InternalServerError)?; + let mut mca_cache = std::collections::HashMap::new(); + let customers = Vec::<PaymentMethodCustomerMigrate>::foreign_try_from(( + &req, + merchant_id.clone(), + )) + .map_err(|e| errors::ApiErrorResponse::InvalidRequestData { + message: e.to_string(), + })?; + + for record in &customers { + if let Some(connector_customer_details) = &record.connector_customer_details { + for connector_customer in connector_customer_details { + if !mca_cache.contains_key(&connector_customer.merchant_connector_id) { + let mca = state + .store + .find_by_merchant_connector_account_merchant_id_merchant_connector_id( + &(&state).into(), + &merchant_id, + &connector_customer.merchant_connector_id, + merchant_context.get_merchant_key_store(), + ) + .await + .to_not_found_response( + errors::ApiErrorResponse::MerchantConnectorAccountNotFound { + id: connector_customer.merchant_connector_id.get_string_repr().to_string(), + }, + )?; + mca_cache + .insert(connector_customer.merchant_connector_id.clone(), mca); + } + } + } + } + + customers::migrate_customers(state.clone(), customers, merchant_context.clone()) + .await + .change_context(errors::ApiErrorResponse::InternalServerError)?; let controller = cards::PmCards { state: &state, merchant_context: &merchant_context, @@ -377,7 +401,7 @@ pub async fn migrate_payment_methods( req, &merchant_id, &merchant_context, - merchant_connector_id, + merchant_connector_ids, &controller, )) .await diff --git a/crates/router/src/types/api/payment_methods.rs b/crates/router/src/types/api/payment_methods.rs index 0c29b58cbb6..4c094af5acc 100644 --- a/crates/router/src/types/api/payment_methods.rs +++ b/crates/router/src/types/api/payment_methods.rs @@ -1,32 +1,30 @@ #[cfg(feature = "v2")] pub use api_models::payment_methods::{ CardDetail, CardDetailFromLocker, CardDetailsPaymentMethod, CardNetworkTokenizeRequest, - CardNetworkTokenizeResponse, CardType, ConnectorCustomerDetails, - CustomerPaymentMethodResponseItem, DeleteTokenizeByTokenRequest, GetTokenizePayloadRequest, - GetTokenizePayloadResponse, ListCountriesCurrenciesRequest, MigrateCardDetail, - NetworkTokenDetailsPaymentMethod, NetworkTokenDetailsResponse, NetworkTokenResponse, - PaymentMethodCollectLinkRenderRequest, PaymentMethodCollectLinkRequest, PaymentMethodCreate, - PaymentMethodCreateData, PaymentMethodCustomerMigrate, PaymentMethodDeleteResponse, - PaymentMethodId, PaymentMethodIntentConfirm, PaymentMethodIntentCreate, PaymentMethodListData, - PaymentMethodListRequest, PaymentMethodListResponseForSession, PaymentMethodMigrate, - PaymentMethodMigrateResponse, PaymentMethodResponse, PaymentMethodResponseData, - PaymentMethodUpdate, PaymentMethodUpdateData, PaymentMethodsData, TokenDataResponse, - TokenDetailsResponse, TokenizePayloadEncrypted, TokenizePayloadRequest, TokenizedCardValue1, - TokenizedCardValue2, TokenizedWalletValue1, TokenizedWalletValue2, - TotalPaymentMethodCountResponse, + CardNetworkTokenizeResponse, CardType, CustomerPaymentMethodResponseItem, + DeleteTokenizeByTokenRequest, GetTokenizePayloadRequest, GetTokenizePayloadResponse, + ListCountriesCurrenciesRequest, MigrateCardDetail, NetworkTokenDetailsPaymentMethod, + NetworkTokenDetailsResponse, NetworkTokenResponse, PaymentMethodCollectLinkRenderRequest, + PaymentMethodCollectLinkRequest, PaymentMethodCreate, PaymentMethodCreateData, + PaymentMethodDeleteResponse, PaymentMethodId, PaymentMethodIntentConfirm, + PaymentMethodIntentCreate, PaymentMethodListData, PaymentMethodListRequest, + PaymentMethodListResponseForSession, PaymentMethodMigrate, PaymentMethodMigrateResponse, + PaymentMethodResponse, PaymentMethodResponseData, PaymentMethodUpdate, PaymentMethodUpdateData, + PaymentMethodsData, TokenDataResponse, TokenDetailsResponse, TokenizePayloadEncrypted, + TokenizePayloadRequest, TokenizedCardValue1, TokenizedCardValue2, TokenizedWalletValue1, + TokenizedWalletValue2, TotalPaymentMethodCountResponse, }; #[cfg(feature = "v1")] pub use api_models::payment_methods::{ CardDetail, CardDetailFromLocker, CardDetailsPaymentMethod, CardNetworkTokenizeRequest, - CardNetworkTokenizeResponse, ConnectorCustomerDetails, CustomerPaymentMethod, - CustomerPaymentMethodsListResponse, DefaultPaymentMethod, DeleteTokenizeByTokenRequest, - GetTokenizePayloadRequest, GetTokenizePayloadResponse, ListCountriesCurrenciesRequest, - MigrateCardDetail, PaymentMethodCollectLinkRenderRequest, PaymentMethodCollectLinkRequest, - PaymentMethodCreate, PaymentMethodCreateData, PaymentMethodCustomerMigrate, - PaymentMethodDeleteResponse, PaymentMethodId, PaymentMethodListRequest, - PaymentMethodListResponse, PaymentMethodMigrate, PaymentMethodMigrateResponse, - PaymentMethodResponse, PaymentMethodUpdate, PaymentMethodsData, TokenizeCardRequest, - TokenizeDataRequest, TokenizePayloadEncrypted, TokenizePayloadRequest, + CardNetworkTokenizeResponse, CustomerPaymentMethod, CustomerPaymentMethodsListResponse, + DefaultPaymentMethod, DeleteTokenizeByTokenRequest, GetTokenizePayloadRequest, + GetTokenizePayloadResponse, ListCountriesCurrenciesRequest, MigrateCardDetail, + PaymentMethodCollectLinkRenderRequest, PaymentMethodCollectLinkRequest, PaymentMethodCreate, + PaymentMethodCreateData, PaymentMethodDeleteResponse, PaymentMethodId, + PaymentMethodListRequest, PaymentMethodListResponse, PaymentMethodMigrate, + PaymentMethodMigrateResponse, PaymentMethodResponse, PaymentMethodUpdate, PaymentMethodsData, + TokenizeCardRequest, TokenizeDataRequest, TokenizePayloadEncrypted, TokenizePayloadRequest, TokenizePaymentMethodRequest, TokenizedCardValue1, TokenizedCardValue2, TokenizedWalletValue1, TokenizedWalletValue2, }; diff --git a/flake.nix b/flake.nix index e9bcb936d7b..35fa05b73a7 100644 --- a/flake.nix +++ b/flake.nix @@ -31,6 +31,7 @@ openssl pkg-config postgresql # for libpq + protobuf ]; # Minimal packages for running hyperswitch @@ -40,6 +41,7 @@ # Development packages devPackages = base ++ (with pkgs; [ + cargo-watch nixd rust-bin.stable.${rustDevVersion}.default swagger-cli

2025-06-26T18:47:13Z

## Type of Change  - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description This pull request enhances the data migration API to support migrating customer and payment method data across multiple business profiles in a single request. Specifically, the following changes have been made: 1. **Customer Data Migration:** * Updated `PaymentMethodRecord` to allow `merchant_connector_id` to accept comma-separated string values. * Modified `PaymentMethodCustomerMigrate` to use a `Vec` of connector-specific customer details. * The `TryFrom<PaymentMethodRecord>` implementation for `PaymentMethodCustomerMigrate` has been updated to parse this comma-separated string. 2. **Payment Method Migration:** * Updated `PaymentMethodsMigrateForm` to accept a comma-separated string for `merchant_connector_id`. * The `get_payment_method_records` and `migrate_payment_methods` functions are updated to process multiple `merchant_connector_id`s. * The `TryFrom` implementation for `PaymentMethodMigrate` is modified to create a `PaymentsMandateReference` for each `merchant_connector_id` provided. ### Additional Changes - [x] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context This allows migrating a payment method entity across multiple profiles (as `MerchantConnectorAccountId` is tied to a profile) during batch migration. ## How did you test it? <details> <summary>1. Batch migration for multiple profiles</summary> cURL curl --location --request POST 'http://localhost:8080/payment_methods/migrate-batch' \ --header 'api-key: test_admin' \ --form 'merchant_id="merchant_1751020165"' \ --form 'merchant_connector_ids="mca_lwpasOxD1FtFmG4SVdjX,mca_4tsKLvIinX1uVL8p9mhy"' \ --form 'file=@"migrate.csv"' Response [{"line_number":1,"payment_method_id":"pm_AO2rTJwFIH0I9yQiZ0zT","payment_method":"card","payment_method_type":"debit","customer_id":"45CC60D1F2283097BB1DE41A2636414445908518D50B8B4CDC57959CD7FB4539","migration_status":"Success","card_number_masked":"4360000 xxxx 0005","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":2,"payment_method_id":"pm_ZN9z4oKF439uxyBerwfL","payment_method":"card","payment_method_type":"credit","customer_id":"782BC898951D910C1A99DA69A4E4FAD6CEE53AB9311FA2C552028DA89428DB7F","migration_status":"Success","card_number_masked":"4111111 xxxx 1111","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null}] Things to verify in DB 1. `connector_mandate_details` for a given payment_method_id in response has connector_mandate_id for multiple MCAs <img width="421" alt="Screenshot 2025-06-28 at 3 09 18 PM" src="https://github.com/user-attachments/assets/8cfe8449-5ed1-441e-bd77-26540d5b6531" /> 2. `connector_customer` for a given customer_id in response has mappings for multiple MCAs <img width="748" alt="Screenshot 2025-06-28 at 3 09 41 PM" src="https://github.com/user-attachments/assets/dec23184-8014-4d8c-91b4-369ec6670e22" /> </details> <details> <summary>2. Batch migration for a single profile - For ensuring backwards compatibility</summary> cURL curl --location --request POST 'http://localhost:8080/payment_methods/migrate-batch' \ --header 'api-key: test_admin' \ --form 'merchant_id="merchant_1751020165"' \ --form 'merchant_connector_id="mca_lwpasOxD1FtFmG4SVdjX"' \ --form 'file=@"migrate.csv"' Response [{"line_number":1,"payment_method_id":"pm_ZGPPsRrU5f4IgVpMS9tj","payment_method":"card","payment_method_type":"debit","customer_id":"45CC60D1F2283097BB1DE41A2636414445908518D50B8B4CDC57959CD7FB4539","migration_status":"Success","card_number_masked":"4360000 xxxx 0005","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":2,"payment_method_id":"pm_Lf2vcheQkYIiZx8PIDHt","payment_method":"card","payment_method_type":"credit","customer_id":"782BC898951D910C1A99DA69A4E4FAD6CEE53AB9311FA2C552028DA89428DB7F","migration_status":"Success","card_number_masked":"4111111 xxxx 1111","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null}] Things to verify in DB - PM migration happens for a single MCA (connector_mandate_details) - Customer migration happens for a single MCA (connector_customer) </details> Sample migration data for multi profile migration [multi-migrate-sample.csv](https://github.com/user-attachments/files/20974125/multi-migrate-sample.csv) ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.114.0

6c66c36a66b6644c43761b7ac9c1326945a6a820

juspay/hyperswitch

juspay__hyperswitch-8442

Bug: [FEATURE] Add x-mcp extension to OpenAPI schema Mintlify supports extracting API endpoints from openAPI json into MCP servers: https://mintlify.com/docs/mcp We need to add: ```json "x-mcp": { "enabled": true }, ``` at the top level of our OpenAPI schema to enable this functionality

diff --git a/README.md b/README.md index a46baab5244..35964d72bf5 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ <a href="https://x.com/hyperswitchio"> <img src="https://img.shields.io/badge/follow-%40hyperswitchio-white?logo=x&labelColor=grey"/> </a> - <a href="https://join.slack.com/t/hyperswitch-io/shared_invite/zt-2jqxmpsbm-WXUENx022HjNEy~Ark7Orw"> + <a href="https://inviter.co/hyperswitch-slack"> <img src="https://img.shields.io/badge/chat-on_slack-blue?logo=slack&labelColor=grey&color=%233f0e40"/> </a> </p> @@ -196,7 +196,7 @@ We welcome contributors from around the world to help build Hyperswitch. Whether Please read our [contributing guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) to get started. -Join the conversation on [Slack](https://join.slack.com/t/hyperswitch-io/shared_invite/zt-2jqxmpsbm-WXUENx022HjNEy~Ark7Orw) or explore open issues on [GitHub](https://github.com/juspay/hyperswitch/issues). +Join the conversation on [Slack](https://inviter.co/hyperswitch-slack) or explore open issues on [GitHub](https://github.com/juspay/hyperswitch/issues). <a href="#feature-requests"> <h2 id="feature-requests">Feature requests & Bugs</h2> diff --git a/api-reference/v1/openapi_spec_v1.json b/api-reference/v1/openapi_spec_v1.json index 6045147a050..c4601519965 100644 --- a/api-reference/v1/openapi_spec_v1.json +++ b/api-reference/v1/openapi_spec_v1.json @@ -1,5 +1,8 @@ { "openapi": "3.0.3", + "x-mcp": { + "enabled": true + }, "info": { "title": "Hyperswitch - API Documentation", "description": "\n## Get started\n\nHyperswitch provides a collection of APIs that enable you to process and manage payments.\nOur APIs accept and return JSON in the HTTP body, and return standard HTTP response codes.\n\nYou can consume the APIs directly using your favorite HTTP/REST library.\n\nWe have a testing environment referred to \"sandbox\", which you can setup to test API calls without\naffecting production data.\nCurrently, our sandbox environment is live while our production environment is under development\nand will be available soon.\nYou can sign up on our Dashboard to get API keys to access Hyperswitch API.\n\n### Environment\n\nUse the following base URLs when making requests to the APIs:\n\n| Environment | Base URL |\n|---------------|------------------------------------|\n| Sandbox | <https://sandbox.hyperswitch.io> |\n| Production | <https://api.hyperswitch.io> |\n\n## Authentication\n\nWhen you sign up on our [dashboard](https://app.hyperswitch.io) and create a merchant\naccount, you are given a secret key (also referred as api-key) and a publishable key.\nYou may authenticate all API requests with Hyperswitch server by providing the appropriate key in\nthe request Authorization header.\n\n| Key | Description |\n|-----------------|-----------------------------------------------------------------------------------------------|\n| api-key | Private key. Used to authenticate all API requests from your merchant server |\n| publishable key | Unique identifier for your account. Used to authenticate API requests from your app's client |\n\nNever share your secret api keys. Keep them guarded and secure.\n", diff --git a/api-reference/v1/payments/payment--flows.mdx b/api-reference/v1/payments/payment--flows.mdx index eff90a0dcb8..9338f835f38 100644 --- a/api-reference/v1/payments/payment--flows.mdx +++ b/api-reference/v1/payments/payment--flows.mdx @@ -226,7 +226,9 @@ sequenceDiagram **Required Fields:** - `off_session: true` -- `recurring_details: { payment_method_id: "<from_setup>" }` +- `recurring_details: { + "type": "payment_method_id", + "data": "<from_setup>"}` **Use Case:** Subscription charges, scheduled billing without customer interaction diff --git a/crates/openapi/src/main.rs b/crates/openapi/src/main.rs index cf8158cfb02..d25b24442df 100644 --- a/crates/openapi/src/main.rs +++ b/crates/openapi/src/main.rs @@ -29,13 +29,33 @@ fn main() { #[allow(clippy::expect_used)] #[cfg(any(feature = "v1", feature = "v2"))] std::fs::write( - file_path, + &file_path, openapi .to_pretty_json() .expect("Failed to serialize OpenAPI specification as JSON"), ) .expect("Failed to write OpenAPI specification to file"); + #[allow(clippy::expect_used)] + #[cfg(feature = "v1")] + { + // TODO: Do this using utoipa::extensions after we have upgraded to 5.x + let file_content = + std::fs::read_to_string(&file_path).expect("Failed to read OpenAPI specification file"); + + let mut lines: Vec<&str> = file_content.lines().collect(); + + // Insert the new text at line 3 (index 2) + if lines.len() > 2 { + let new_line = " \"x-mcp\": {\n \"enabled\": true\n },"; + lines.insert(2, new_line); + } + + let modified_content = lines.join("\n"); + std::fs::write(&file_path, modified_content) + .expect("Failed to write modified OpenAPI specification to file"); + } + #[cfg(any(feature = "v1", feature = "v2"))] println!("Successfully saved OpenAPI specification file at '{relative_file_path}'");

2025-06-24T09:35:51Z

## Type of Change  - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [x] Documentation - [ ] CI/CD ## Description  Modified `openapi/src/main.rs` to append `x-mcp` extension to v1 OpenAPI schema ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  Closes #8442 ## How did you test it?  Verified using: `mintlify openapi-check api-reference/v1/openapi_spec_v1.json` Tested mintlify's mcp server generation functionality by deploying the updated OpenAPI spec file on a custom mintlify account. Used the generated mcp server to do payments - create in cursor. ![image](https://github.com/user-attachments/assets/1a6e37a3-a682-4b84-9cd7-1292f3ed1787) ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.114.0

bc767b9131e2637ce90997da9018085d2dadb80b

juspay/hyperswitch

juspay__hyperswitch-8445

Bug: fix(recovery) : Populate connector request reference id in revenue recovery record attempt flow. Previously there was no restriction in confirmData to connector request reference id to be mandatory. Recovery internally uses proxy flow, which internally uses confirmData where connector request reference id was hardcoded to none.

diff --git a/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs b/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs index c35fbc3163e..86821bfe6ef 100644 --- a/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs +++ b/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs @@ -646,7 +646,6 @@ impl PaymentAttempt { let payment_method_type_data = payment_intent.get_payment_method_type(); let payment_method_subtype_data = payment_intent.get_payment_method_sub_type(); - let authentication_type = payment_intent.authentication_type.unwrap_or_default(); Ok(Self { payment_id: payment_intent.id.clone(), @@ -752,7 +751,10 @@ impl PaymentAttempt { .as_ref() .map(|txn_id| txn_id.get_id().clone()); let connector = request.connector.map(|connector| connector.to_string()); - + let connector_request_reference_id = payment_intent + .merchant_reference_id + .as_ref() + .map(|id| id.get_string_repr().to_owned()); Ok(Self { payment_id: payment_intent.id.clone(), merchant_id: payment_intent.merchant_id.clone(), @@ -804,7 +806,7 @@ impl PaymentAttempt { charges: None, processor_merchant_id: payment_intent.merchant_id.clone(), created_by: None, - connector_request_reference_id: None, + connector_request_reference_id, }) } diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs index 59de54f41fa..2f70a79ec87 100644 --- a/crates/router/src/core/payments.rs +++ b/crates/router/src/core/payments.rs @@ -4042,6 +4042,16 @@ where ) .await?, )); + operation + .to_domain()? + .populate_payment_data( + state, + payment_data, + merchant_context, + business_profile, + &connector, + ) + .await?; let mut router_data = payment_data .construct_router_data( diff --git a/crates/router/src/core/payments/operations/proxy_payments_intent.rs b/crates/router/src/core/payments/operations/proxy_payments_intent.rs index 838cbf9dedf..a65f4cdd99e 100644 --- a/crates/router/src/core/payments/operations/proxy_payments_intent.rs +++ b/crates/router/src/core/payments/operations/proxy_payments_intent.rs @@ -6,6 +6,7 @@ use error_stack::ResultExt; use hyperswitch_domain_models::{ payment_method_data::PaymentMethodData, payments::PaymentConfirmData, }; +use hyperswitch_interfaces::api::ConnectorSpecifications; use masking::PeekInterface; use router_env::{instrument, tracing}; @@ -15,7 +16,7 @@ use crate::{ errors::{self, CustomResult, RouterResult, StorageErrorExt}, payments::{ operations::{self, ValidateStatusForOperation}, - OperationSessionGetters, + OperationSessionGetters, OperationSessionSetters, }, }, routes::{app::ReqState, SessionState}, @@ -303,6 +304,24 @@ impl<F: Clone + Send + Sync> Domain<F, ProxyPaymentsRequest, PaymentConfirmData< )> { Ok((Box::new(self), None, None)) } + #[instrument(skip_all)] + async fn populate_payment_data<'a>( + &'a self, + _state: &SessionState, + payment_data: &mut PaymentConfirmData<F>, + _merchant_context: &domain::MerchantContext, + _business_profile: &domain::Profile, + connector_data: &api::ConnectorData, + ) -> CustomResult<(), errors::ApiErrorResponse> { + let connector_request_reference_id = connector_data + .connector + .generate_connector_request_reference_id( + &payment_data.payment_intent, + &payment_data.payment_attempt, + ); + payment_data.set_connector_request_reference_id(Some(connector_request_reference_id)); + Ok(()) + } async fn perform_routing<'a>( &'a self, diff --git a/crates/router/src/routes/payments.rs b/crates/router/src/routes/payments.rs index 020a1fbf713..e2363633dad 100644 --- a/crates/router/src/routes/payments.rs +++ b/crates/router/src/routes/payments.rs @@ -232,7 +232,7 @@ pub async fn payments_get_intent( header_payload.clone(), ) }, - auth::api_or_client_auth( + auth::api_or_client_or_jwt_auth( &auth::V2ApiKeyAuth { is_connected_allowed: false, is_platform_allowed: false, @@ -240,6 +240,9 @@ pub async fn payments_get_intent( &auth::V2ClientAuth(common_utils::types::authentication::ResourceId::Payment( global_payment_id.clone(), )), + &auth::JWTAuth { + permission: Permission::ProfileRevenueRecoveryRead, + }, req.headers(), ), api_locking::LockAction::NotApplicable, diff --git a/crates/router/src/services/authentication.rs b/crates/router/src/services/authentication.rs index 41b7bd3d87b..d16063939a1 100644 --- a/crates/router/src/services/authentication.rs +++ b/crates/router/src/services/authentication.rs @@ -2698,7 +2698,27 @@ where api_auth } } - +#[cfg(feature = "v2")] +pub fn api_or_client_or_jwt_auth<'a, T, A>( + api_auth: &'a dyn AuthenticateAndFetch<T, A>, + client_auth: &'a dyn AuthenticateAndFetch<T, A>, + jwt_auth: &'a dyn AuthenticateAndFetch<T, A>, + headers: &HeaderMap, +) -> &'a dyn AuthenticateAndFetch<T, A> +where +{ + if let Ok(val) = HeaderMapStruct::new(headers).get_auth_string_from_header() { + if val.trim().starts_with("api-key=") { + api_auth + } else if is_jwt_auth(headers) { + jwt_auth + } else { + client_auth + } + } else { + api_auth + } +} #[derive(Debug)] pub struct PublishableKeyAuth;

2025-06-23T13:31:41Z

## Type of Change  - [x] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  Previously there was no restriction in confirmData to connector request reference id to be mandatory. Recovery internally uses proxy flow, which internally uses confirmData where connector request reference id was hardcoded to none. This Pr adds supports to generate connector request reference to merchant reference id. This Pr also has changes of adding support for jwt auth to payment get for dashboard use case. Previously payment sync was used in dashboard to retrieve payment details, but this would fail now in v2 because if there are no attempts created payment get would return 4xx since active attempt is mandotory. To solve this now dashboard is relying on payment get and payment get attempt list api's . ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  ## How did you test it?  Test case 1 : **step 1 :** create a profile in hyperswitch and wait for 8 mins to move it from monitering to cascading , this would only get updated when webhooks are triggered . **step 2 :** create payment mca ``` curl --location 'http://localhost:8080/v2/connector-accounts' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'x-merchant-id: test_seller_AGZCJiHwUNV1seyoepOE' \ --header 'x-profile-id: pro_kYmv4lQjIZFbAqoOVY4M' \ --header 'Authorization: admin-api-key=test_admin' \ --data '{ "connector_type": "payment_processor", "connector_name": "stripe", "connector_account_details": { "auth_type": "HeaderKey", "api_key": "stripe-api-key" }, "profile_id": "pro_kYmv4lQjIZFbAqoOVY4M" }' ``` **step 4 : ** configure stripe billing connector. ``` curl --location 'http://localhost:8080/v2/connector-accounts' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'x-merchant-id: test_seller_AGZCJiHwUNV1seyoepOE' \ --header 'x-profile-id: pro_kYmv4lQjIZFbAqoOVY4M' \ --header 'Authorization: admin-api-key=test_admin' \ --data '{ "connector_type": "billing_processor", "connector_name": "stripebilling", "connector_account_details": { "auth_type": "HeaderKey", "api_key": "{{stripe-api-key}}" }, "connector_webhook_details": { "merchant_secret": "{{stripe-webhook-key}}", "additional_secret": "password" }, "feature_metadata": { "revenue_recovery": { "max_retry_count": 7, "billing_connector_retry_threshold": 2, "billing_account_reference": { "{{payment_connector_mca_created_in_last_step}}": "stripebilling" } } }, "profile_id": "pro_kYmv4lQjIZFbAqoOVY4M" }' ``` step 5 : Trigger failed invoice from stripe billing by creating new subscription and move the test clock to 1 week. This would trigger few external payments. once it exhausts retry threshold it will create process tracker entry. Follwed by 2 mins it would create all retries by hyperswitch as shown below. <img width="935" alt="Screenshot 2025-06-23 at 7 00 57 PM" src="https://github.com/user-attachments/assets/d51d3d9e-82ff-4385-b318-dbb37230cee8" /> ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.114.0

6fd7626c99e006bb7dcac864c30299bb8ef1d742

juspay/hyperswitch

juspay__hyperswitch-8460

Bug: [BUG] DB constraints for events table ### Bug Description `idempotent_event_id` column is a combination of `payment_id` and the `event_type`. Length of this field in DB can be a maximum of 64 characters. However, since `payment_id` can also be 64 characters, the resulting `idempotent_event_id` can easily exceed 64 characters leading to inconsistent behavior in the flows. Currently, this is breaking outgoing webhooks flow. ### Expected Behavior Outgoing webhooks flow should succeed. ### Actual Behavior Outgoing webhooks flow breaks due to DB constraints. ``` { "message": "[INCOMING_WEBHOOKS_CORE - EVENT] Incoming webhook flow failed", "extra": { "error": "{\"error\":{\"type\":\"router_error\",\"code\":\"WE_03\",\"message\":\"There was some issue processing the webhook\"}}\\n├╴at crates/router/src/core/webhooks/outgoing.rs:196:18\\n├╴Failed to insert event in events table\\n├╴Incoming webhook flow for payments failed\\n│\\n╰─▶ DatabaseError: An unknown error occurred\\n ├╴at /router/crates/diesel_models/src/query/generics.rs:89:36\\n ├╴Error while inserting EventNew { event_id: \"evt_01979b2125017d93bb4d846d42979839\", event_type: PaymentAuthorized, event_class: Payments, is_webhook_notified: false, primary_object_id: \"AFR_202506237e491a4f-1bd8-4d97-a9a6-a2f86832bc79\", primary_object_type: PaymentDetails, created_at: 2025-06-23 4:52:10.113410262, merchant_id: Some(MerchantId(\"merchant_1741787326\")), business_profile_id: Some(ProfileId(\"pro_r3uCseg4NT35RBFpmUPA\")), primary_object_created_at: Some(2025-06-23 4:51:14.154239), idempotent_event_id: Some(\"AFR_202506237e491a4f-1bd8-4d97-a9a6-a2f86832bc79_payment_authorized\"), initial_attempt_id: Some(\"evt_01979b2125017d93bb4d846d42979839\"), request: Some(Encryption { inner: *** Encrypted data of length 7223 bytes *** }), response: None, delivery_attempt: Some(InitialAttempt), metadata: Some(Payment { payment_id: PaymentId(\"AFR_202506237e491a4f-1bd8-4d97-a9a6-a2f86832bc79\") }), is_overall_delivery_successful: Some(false) }\\n │\\n ╰─▶ value too long for type character varying(64)\\n ╰╴at /router/crates/diesel_models/src/query/generics.rs:89:22\\n ╰╴at crates/router/src/db/events.rs:129:30" } } ``` ### Steps To Reproduce -- ### Context For The Bug -- ### Environment -- ### Have you spent some time checking if this bug has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? None

diff --git a/crates/common_utils/src/consts.rs b/crates/common_utils/src/consts.rs index 59ec5377690..bbb65e1afc6 100644 --- a/crates/common_utils/src/consts.rs +++ b/crates/common_utils/src/consts.rs @@ -97,6 +97,11 @@ pub const BASE64_ENGINE: base64::engine::GeneralPurpose = base64::engine::genera /// URL Safe base64 engine pub const BASE64_ENGINE_URL_SAFE: base64::engine::GeneralPurpose = base64::engine::general_purpose::URL_SAFE; + +/// URL Safe base64 engine without padding +pub const BASE64_ENGINE_URL_SAFE_NO_PAD: base64::engine::GeneralPurpose = + base64::engine::general_purpose::URL_SAFE_NO_PAD; + /// Regex for matching a domain /// Eg - /// http://www.example.com diff --git a/crates/router/src/core/errors.rs b/crates/router/src/core/errors.rs index bf5330a9325..a980bb664ef 100644 --- a/crates/router/src/core/errors.rs +++ b/crates/router/src/core/errors.rs @@ -157,6 +157,8 @@ pub enum WebhooksFlowError { OutgoingWebhookRetrySchedulingFailed, #[error("Outgoing webhook response encoding failed")] OutgoingWebhookResponseEncodingFailed, + #[error("ID generation failed")] + IdGenerationFailed, } impl WebhooksFlowError { @@ -174,7 +176,8 @@ impl WebhooksFlowError { | Self::DisputeWebhookValidationFailed | Self::OutgoingWebhookEncodingFailed | Self::OutgoingWebhookProcessTrackerTaskUpdateFailed - | Self::OutgoingWebhookRetrySchedulingFailed => true, + | Self::OutgoingWebhookRetrySchedulingFailed + | Self::IdGenerationFailed => true, } } } diff --git a/crates/router/src/core/webhooks/outgoing.rs b/crates/router/src/core/webhooks/outgoing.rs index 34b49c2fc8a..adc54b09b94 100644 --- a/crates/router/src/core/webhooks/outgoing.rs +++ b/crates/router/src/core/webhooks/outgoing.rs @@ -60,7 +60,9 @@ pub(crate) async fn create_event_and_trigger_outgoing_webhook( ) -> CustomResult<(), errors::ApiErrorResponse> { let delivery_attempt = enums::WebhookDeliveryAttempt::InitialAttempt; let idempotent_event_id = - utils::get_idempotent_event_id(&primary_object_id, event_type, delivery_attempt); + utils::get_idempotent_event_id(&primary_object_id, event_type, delivery_attempt) + .change_context(errors::ApiErrorResponse::WebhookProcessingFailure) + .attach_printable("Failed to generate idempotent event ID")?; let webhook_url_result = get_webhook_url_from_business_profile(&business_profile); if !state.conf.webhooks.outgoing_enabled diff --git a/crates/router/src/core/webhooks/outgoing_v2.rs b/crates/router/src/core/webhooks/outgoing_v2.rs index 07758817e68..d0e0ecaa69a 100644 --- a/crates/router/src/core/webhooks/outgoing_v2.rs +++ b/crates/router/src/core/webhooks/outgoing_v2.rs @@ -48,7 +48,9 @@ pub(crate) async fn create_event_and_trigger_outgoing_webhook( ) -> CustomResult<(), errors::ApiErrorResponse> { let delivery_attempt = enums::WebhookDeliveryAttempt::InitialAttempt; let idempotent_event_id = - utils::get_idempotent_event_id(&primary_object_id, event_type, delivery_attempt); + utils::get_idempotent_event_id(&primary_object_id, event_type, delivery_attempt) + .change_context(errors::ApiErrorResponse::WebhookProcessingFailure) + .attach_printable("Failed to generate idempotent event ID")?; let webhook_url_result = business_profile .get_webhook_url_from_profile() .change_context(errors::WebhooksFlowError::MerchantWebhookUrlNotConfigured); diff --git a/crates/router/src/core/webhooks/utils.rs b/crates/router/src/core/webhooks/utils.rs index 45b6c24a2ed..0344d7d010e 100644 --- a/crates/router/src/core/webhooks/utils.rs +++ b/crates/router/src/core/webhooks/utils.rs @@ -1,6 +1,12 @@ use std::marker::PhantomData; -use common_utils::{errors::CustomResult, ext_traits::ValueExt}; +use base64::Engine; +use common_utils::{ + consts, + crypto::{self, GenerateDigest}, + errors::CustomResult, + ext_traits::ValueExt, +}; use error_stack::{Report, ResultExt}; use redis_interface as redis; use router_env::tracing; @@ -146,18 +152,28 @@ pub(crate) fn get_idempotent_event_id( primary_object_id: &str, event_type: types::storage::enums::EventType, delivery_attempt: types::storage::enums::WebhookDeliveryAttempt, -) -> String { +) -> Result<String, Report<errors::WebhooksFlowError>> { use crate::types::storage::enums::WebhookDeliveryAttempt; const EVENT_ID_SUFFIX_LENGTH: usize = 8; let common_prefix = format!("{primary_object_id}_{event_type}"); - match delivery_attempt { - WebhookDeliveryAttempt::InitialAttempt => common_prefix, + + // Hash the common prefix with SHA256 and encode with URL-safe base64 without padding + let digest = crypto::Sha256 + .generate_digest(common_prefix.as_bytes()) + .change_context(errors::WebhooksFlowError::IdGenerationFailed) + .attach_printable("Failed to generate idempotent event ID")?; + let base_encoded = consts::BASE64_ENGINE_URL_SAFE_NO_PAD.encode(digest); + + let result = match delivery_attempt { + WebhookDeliveryAttempt::InitialAttempt => base_encoded, WebhookDeliveryAttempt::AutomaticRetry | WebhookDeliveryAttempt::ManualRetry => { - common_utils::generate_id(EVENT_ID_SUFFIX_LENGTH, &common_prefix) + common_utils::generate_id(EVENT_ID_SUFFIX_LENGTH, &base_encoded) } - } + }; + + Ok(result) } #[inline] diff --git a/crates/router/src/core/webhooks/webhook_events.rs b/crates/router/src/core/webhooks/webhook_events.rs index 44ce4fdd515..700295af0ec 100644 --- a/crates/router/src/core/webhooks/webhook_events.rs +++ b/crates/router/src/core/webhooks/webhook_events.rs @@ -287,7 +287,9 @@ pub async fn retry_delivery_attempt( &event_to_retry.primary_object_id, event_to_retry.event_type, delivery_attempt, - ); + ) + .change_context(errors::ApiErrorResponse::WebhookProcessingFailure) + .attach_printable("Failed to generate idempotent event ID")?; let now = common_utils::date_time::now(); let new_event = domain::Event { diff --git a/crates/router/src/workflows/outgoing_webhook_retry.rs b/crates/router/src/workflows/outgoing_webhook_retry.rs index 559f62b1a4a..d84f0b26dc7 100644 --- a/crates/router/src/workflows/outgoing_webhook_retry.rs +++ b/crates/router/src/workflows/outgoing_webhook_retry.rs @@ -72,7 +72,9 @@ impl ProcessTrackerWorkflow<SessionState> for OutgoingWebhookRetryWorkflow { &tracking_data.primary_object_id, tracking_data.event_type, delivery_attempt, - ); + ) + .change_context(errors::ApiErrorResponse::WebhookProcessingFailure) + .attach_printable("Failed to generate idempotent event ID")?; let initial_event = match &tracking_data.initial_attempt_id { Some(initial_attempt_id) => {

2025-09-16T13:24:24Z

## Type of Change  - [x] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  This change updates the idempotent_event_id generation to first hash the base string with SHA256 and then encode it using URL-safe Base64 without padding. By doing this, the generated IDs are guaranteed to be short and deterministic, ensuring they always fit within the 64-character database column limit. This fix addresses the issue where long payment_ids combined with event types were exceeding the DB constraint and breaking the outgoing webhooks flow. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  The idempotent_event_id column is a combination of payment_id and event_type. The DB column length is limited to 64 characters. Since payment_id itself can be up to 64 characters long, appending event_type causes the field to exceed the limit, leading to database constraint violations. Currently, this breaks the outgoing webhooks flow. Additionally, during staggered deployments and rollback, the uniqueness of these IDs may cause dual webhook dispatches. closes #8460 ## How did you test it?  1. Started the local Node.js Express webhook listener on port 3000 using the server.js script. <details> <summary>server.js script</summary> ``` mkdir -p /tmp/hs-webhooks && cd /tmp/hs-webhooks npm init -y >/dev/null npm i express >/dev/null cat > server.js <<'JS' const express = require('express'); const app = express(); app.use(express.json({ type: '*/*' })); app.post('/webhooks/hs', (req, res) => { console.log('---- Webhook received ----'); console.log('Headers:', req.headers); console.log('Body:', JSON.stringify(req.body, null, 2)); res.sendStatus(200); }); app.listen(3000, () => console.log('Webhook listener running on port 3000')); JS node server.js ``` </details> 2. **Merchant Creation** <details> <summary>Merchant creation Curl</summary> ```bash curl --location 'http://localhost:8080/accounts' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: test_admin' \ --data-raw '{ "merchant_id": "merchant_1758029612", "locker_id": "m0010", "merchant_name": "worldpay", "merchant_details": { "primary_contact_person": "John Test", "primary_email": "[email protected]", "primary_phone": "sunt laborum", "secondary_contact_person": "John Test2", "secondary_email": "[email protected]", "secondary_phone": "cillum do dolor id", "website": "https://www.example.com", "about_business": "Online Retail with a wide selection of organic products for North America", "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name":"john", "last_name":"Doe" } }, "return_url": "https://google.com/success", "webhook_details": { "webhook_version": "1.0.1", "webhook_username": "ekart_retail", "webhook_password": "password_ekart@123", "webhook_url":"http://localhost:3000/webhooks/hs", "payment_created_enabled": true, "payment_succeeded_enabled": true, "payment_failed_enabled": true }, "sub_merchants_enabled": false, "parent_merchant_id":"merchant_123", "metadata": { "city": "NY", "unit": "245", "merchant_name": "Acme Widgets LLC" }, "primary_business_details": [ { "country": "US", "business": "default" } ] }' ``` </details> After this when i created payment it created event with these idempotent_event_id. <img width="533" height="165" alt="image" src="https://github.com/user-attachments/assets/6610ede4-6ffe-4de1-bde3-664ac00abec4" /> <details> <summary>Manual Retry Curl</summary> ``` curl --location --request POST 'http://localhost:8080/events/merchant_1758190753/evt_01995ce5346575608391d7f8b825175d/retry' \ --header 'api-key: test_admin' ``` </details> <img width="559" height="252" alt="image" src="https://github.com/user-attachments/assets/cb652d7b-5749-48f0-b2f7-78726411e789" /> For primary object id greater than 64 chars still generated idempotent_event_id will always be less than 64 characters in length. <img width="831" height="33" alt="image" src="https://github.com/user-attachments/assets/3d7b838a-df61-401e-ac2c-fd7e5cd5b4c8" /> ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.117.0

f3ab3d63f69279af9254f15eba5654c0680a0747

juspay/hyperswitch

juspay__hyperswitch-8449

Bug: remove frm rule migration support as it is not supported in DE

diff --git a/crates/router/src/core/routing.rs b/crates/router/src/core/routing.rs index b52fc966721..0d34986c838 100644 --- a/crates/router/src/core/routing.rs +++ b/crates/router/src/core/routing.rs @@ -2483,11 +2483,6 @@ pub async fn migrate_rules_for_profile( .attach_printable("Failed to get payout routing algorithm")? .unwrap_or_default() .algorithm_id, - business_profile - .get_frm_routing_algorithm() - .attach_printable("Failed to get frm routing algorithm")? - .unwrap_or_default() - .algorithm_id, ]; #[cfg(feature = "v2")]

2025-06-24T10:58:00Z

## Type of Change  - [X] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  As FRM routing is not supported in DE we can remove support for it from DE migration endpoint ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  ## How did you test it?  Compilation and cypress is working as expected. ## Checklist  - [ ] I formatted the code `cargo +nightly fmt --all` - [ ] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.114.0

bc767b9131e2637ce90997da9018085d2dadb80b

juspay/hyperswitch

juspay__hyperswitch-8440

Bug: [FEATURE] Implement V2 UCS (Unified Connector Service) Integration for Authorization Flow ### Feature Description # [Feature Request] Implement V2 UCS (Unified Connector Service) Integration for Authorization Flow ## Issue Type - [x] Feature Request - [ ] Bug Report - [ ] Enhancement - [ ] Documentation ## Priority - [x] High - [ ] Medium - [ ] Low ## Labels `A-core` `C-feature` `payment-flows` `ucs-integration` `v2-api` ## Summary Implement V2 UCS (Unified Connector Service) integration for the authorization payment flow, upgrading from the existing V1 UCS integration to support the updated gRPC schema and enhanced V2 payment architecture. ## Background Currently, Hyperswitch has V1 UCS integration that works with the legacy gRPC schema. However, the UCS service has evolved to V2 with improved: - Enhanced gRPC schema with better type safety - Improved field structures for card details, addresses, and identifiers - Better error handling and response parsing - Enhanced payment method data transformation ## Problem Statement ### Current State - V1 UCS integration uses outdated `PaymentsAuthorizeRequest` schema - Limited support for V2 payment flow architecture - Outdated transformer implementations for V2 data structures - Monolithic UCS function structure affecting maintainability ### Pain Points 1. **Schema Incompatibility**: V1 gRPC schema doesn't support V2 enhanced data models 2. **Limited Error Handling**: V1 response parsing lacks V2 identifier structure support 3. **Technical Debt**: Monolithic UCS functions make debugging and enhancement difficult 4. **Missing V2 Features**: Cannot leverage V2 payment flow improvements through UCS ### Possible Implementation ## Proposed Solution ### High-Level Approach Implement V2 UCS integration that: 1. **Updates gRPC Schema**: Migrate to `PaymentServiceAuthorizeRequest` with V2 field structure 2. **Enhances Architecture**: Refactor payment flow with better separation of concerns 3. **Improves Transformers**: Update V2 transformers for new schema compatibility 4. **Maintains Backward Compatibility**: Preserve V1 integration with feature flag separation ### Technical Requirements #### 1. gRPC Schema Migration - [ ] Update `rust-grpc-client` dependency to latest version - [ ] Migrate from `PaymentsAuthorizeRequest` to `PaymentServiceAuthorizeRequest` - [ ] Update authentication headers and request metadata handling - [ ] Implement new identifier structure for response parsing #### 2. Payment Flow Architecture - [ ] Refactor `call_connector_service()` into separate prerequisite and decision functions - [ ] Implement `call_connector_service_prerequisites()` for V2 flow preparation - [ ] Create `decide_unified_connector_service_call()` for UCS routing logic - [ ] Maintain feature flag separation between V1 and V2 implementations #### 3. V2 Transformer Enhancements - [ ] Update card data transformation for new schema structure - [ ] Enhance address handling with improved field mapping - [ ] Implement customer ID support in V2 transformers #### 4. Error Handling & Response Parsing - [ ] Update response handlers for new identifier structure - [ ] Enhance error context and fallback mechanisms - [ ] Maintain automatic fallback to traditional connector flow #### 5. Testing & Validation - [ ] Create comprehensive test cases for V2 UCS flow - [ ] Test schema compatibility and field mapping - [ ] Validate fallback mechanisms and error handling ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? Yes, I am willing to submit a PR!

diff --git a/Cargo.lock b/Cargo.lock index 848ccc6648f..f3ab37bbb5b 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1651,6 +1651,20 @@ dependencies = [ "thiserror 1.0.69", ] +[[package]] +name = "cargo_metadata" +version = "0.19.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dd5eb614ed4c27c5d706420e4320fbe3216ab31fa1c33cd8246ac36dae4479ba" +dependencies = [ + "camino", + "cargo-platform", + "semver 1.0.26", + "serde", + "serde_json", + "thiserror 2.0.12", +] + [[package]] name = "cast" version = "0.3.0" @@ -3347,13 +3361,18 @@ dependencies = [ [[package]] name = "g2h" -version = "0.2.0" +version = "0.4.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "312ad594dd0e3c26f860a52c8b703ab509c546931920f277f1afa9b7127fd755" +checksum = "0aece561ff748cdd2a37c8ee938a47bbf9b2c03823b393a332110599b14ee827" dependencies = [ + "cargo_metadata 0.19.2", "heck 0.5.0", + "proc-macro2", + "prost", "prost-build", + "prost-types", "quote", + "thiserror 2.0.12", "tonic-build", ] @@ -3506,7 +3525,7 @@ dependencies = [ [[package]] name = "grpc-api-types" version = "0.1.0" -source = "git+https://github.com/juspay/connector-service?rev=afaef3427f815befe253da152e5f37d3858bbc9f#afaef3427f815befe253da152e5f37d3858bbc9f" +source = "git+https://github.com/juspay/connector-service?rev=4918efedd5ea6c33e4a1600b988b2cf4948bed10#4918efedd5ea6c33e4a1600b988b2cf4948bed10" dependencies = [ "axum 0.8.4", "error-stack 0.5.0", @@ -6827,7 +6846,7 @@ dependencies = [ name = "router_env" version = "0.1.0" dependencies = [ - "cargo_metadata", + "cargo_metadata 0.18.1", "config", "error-stack 0.4.1", "gethostname", @@ -6880,7 +6899,7 @@ dependencies = [ [[package]] name = "rust-grpc-client" version = "0.1.0" -source = "git+https://github.com/juspay/connector-service?rev=afaef3427f815befe253da152e5f37d3858bbc9f#afaef3427f815befe253da152e5f37d3858bbc9f" +source = "git+https://github.com/juspay/connector-service?rev=4918efedd5ea6c33e4a1600b988b2cf4948bed10#4918efedd5ea6c33e4a1600b988b2cf4948bed10" dependencies = [ "grpc-api-types", ] @@ -9501,7 +9520,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "2990d9ea5967266ea0ccf413a4aa5c42a93dbcfda9cb49a97de6931726b12566" dependencies = [ "anyhow", - "cargo_metadata", + "cargo_metadata 0.18.1", "cfg-if 1.0.0", "git2", "regex", diff --git a/crates/external_services/Cargo.toml b/crates/external_services/Cargo.toml index 906f8e9b596..30ee8ee5a2c 100644 --- a/crates/external_services/Cargo.toml +++ b/crates/external_services/Cargo.toml @@ -53,7 +53,7 @@ reqwest = { version = "0.11.27", features = ["rustls-tls"] } http = "0.2.12" url = { version = "2.5.4", features = ["serde"] } quick-xml = { version = "0.31.0", features = ["serialize"] } -unified-connector-service-client = { git = "https://github.com/juspay/connector-service", rev = "afaef3427f815befe253da152e5f37d3858bbc9f", package = "rust-grpc-client" } +unified-connector-service-client = { git = "https://github.com/juspay/connector-service", rev = "4918efedd5ea6c33e4a1600b988b2cf4948bed10", package = "rust-grpc-client" } # First party crates diff --git a/crates/external_services/src/grpc_client/unified_connector_service.rs b/crates/external_services/src/grpc_client/unified_connector_service.rs index 0ad9602985d..5a4a912b798 100644 --- a/crates/external_services/src/grpc_client/unified_connector_service.rs +++ b/crates/external_services/src/grpc_client/unified_connector_service.rs @@ -84,6 +84,10 @@ pub enum UnifiedConnectorServiceError { /// Failed to perform Payment Authorize from gRPC Server #[error("Failed to perform Payment Authorize from gRPC Server")] PaymentAuthorizeFailure, + + /// Failed to perform Payment Get from gRPC Server + #[error("Failed to perform Payment Get from gRPC Server")] + PaymentGetFailure, } /// Result type for Dynamic Routing @@ -191,6 +195,28 @@ impl UnifiedConnectorServiceClient { .change_context(UnifiedConnectorServiceError::PaymentAuthorizeFailure) .inspect_err(|error| logger::error!(?error)) } + + /// Performs Payment Sync/Get + pub async fn payment_get( + &self, + payment_get_request: payments_grpc::PaymentServiceGetRequest, + connector_auth_metadata: ConnectorAuthMetadata, + grpc_headers: GrpcHeaders, + ) -> UnifiedConnectorServiceResult<tonic::Response<payments_grpc::PaymentServiceGetResponse>> + { + let mut request = tonic::Request::new(payment_get_request); + + let metadata = + build_unified_connector_service_grpc_headers(connector_auth_metadata, grpc_headers)?; + *request.metadata_mut() = metadata; + + self.client + .clone() + .get(request) + .await + .change_context(UnifiedConnectorServiceError::PaymentGetFailure) + .inspect_err(|error| logger::error!(?error)) + } } /// Build the gRPC Headers for Unified Connector Service Request diff --git a/crates/hyperswitch_domain_models/src/merchant_connector_account.rs b/crates/hyperswitch_domain_models/src/merchant_connector_account.rs index 92ec2f51de2..1e460ee7306 100644 --- a/crates/hyperswitch_domain_models/src/merchant_connector_account.rs +++ b/crates/hyperswitch_domain_models/src/merchant_connector_account.rs @@ -163,7 +163,9 @@ impl MerchantConnectorAccountTypeDetails { Self::MerchantConnectorAccount(merchant_connector_account) => { Some(merchant_connector_account.connector_name) } - Self::MerchantConnectorDetails(_) => None, + Self::MerchantConnectorDetails(merchant_connector_details) => { + Some(merchant_connector_details.connector_name) + } } } diff --git a/crates/router/Cargo.toml b/crates/router/Cargo.toml index 585c49ffe18..8b80d22dc2a 100644 --- a/crates/router/Cargo.toml +++ b/crates/router/Cargo.toml @@ -88,7 +88,7 @@ reqwest = { version = "0.11.27", features = ["json", "rustls-tls", "gzip", "mult ring = "0.17.14" rust_decimal = { version = "1.37.1", features = ["serde-with-float", "serde-with-str"] } rust-i18n = { git = "https://github.com/kashif-m/rust-i18n", rev = "f2d8096aaaff7a87a847c35a5394c269f75e077a" } -unified-connector-service-client = { git = "https://github.com/juspay/connector-service", rev = "afaef3427f815befe253da152e5f37d3858bbc9f", package = "rust-grpc-client" } +unified-connector-service-client = { git = "https://github.com/juspay/connector-service", rev = "4918efedd5ea6c33e4a1600b988b2cf4948bed10", package = "rust-grpc-client" } rustc-hash = "1.1.0" rustls = "0.22" rustls-pemfile = "2" diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs index 8a0058b79e4..5319e823614 100644 --- a/crates/router/src/core/payments.rs +++ b/crates/router/src/core/payments.rs @@ -216,7 +216,27 @@ where let (payment_data, connector_response_data) = match connector { ConnectorCallType::PreDetermined(connector_data) => { - let router_data = call_connector_service( + let (mca_type_details, updated_customer, router_data) = + call_connector_service_prerequisites( + state, + req_state.clone(), + &merchant_context, + connector_data.connector_data.clone(), + &operation, + &mut payment_data, + &customer, + call_connector_action.clone(), + None, + header_payload.clone(), + None, + profile, + false, + false, //should_retry_with_pan is set to false in case of PreDetermined ConnectorCallType + req.should_return_raw_response(), + ) + .await?; + + let router_data = decide_unified_connector_service_call( state, req_state.clone(), &merchant_context, @@ -225,16 +245,17 @@ where &mut payment_data, &customer, call_connector_action.clone(), - None, + None, // schedule_time is not used in PreDetermined ConnectorCallType header_payload.clone(), #[cfg(feature = "frm")] None, - #[cfg(not(feature = "frm"))] - None, profile, false, false, //should_retry_with_pan is set to false in case of PreDetermined ConnectorCallType req.should_return_raw_response(), + mca_type_details, + router_data, + updated_customer, ) .await?; @@ -271,7 +292,28 @@ where ConnectorCallType::Retryable(connectors) => { let mut connectors = connectors.clone().into_iter(); let connector_data = get_connector_data(&mut connectors)?; - let router_data = call_connector_service( + + let (mca_type_details, updated_customer, router_data) = + call_connector_service_prerequisites( + state, + req_state.clone(), + &merchant_context, + connector_data.connector_data.clone(), + &operation, + &mut payment_data, + &customer, + call_connector_action.clone(), + None, + header_payload.clone(), + None, + profile, + false, + false, //should_retry_with_pan is set to false in case of Retryable ConnectorCallType + req.should_return_raw_response(), + ) + .await?; + + let router_data = decide_unified_connector_service_call( state, req_state.clone(), &merchant_context, @@ -280,16 +322,17 @@ where &mut payment_data, &customer, call_connector_action.clone(), - None, + None, // schedule_time is not used in Retryable ConnectorCallType header_payload.clone(), #[cfg(feature = "frm")] None, - #[cfg(not(feature = "frm"))] - None, profile, - false, + true, false, //should_retry_with_pan is set to false in case of PreDetermined ConnectorCallType req.should_return_raw_response(), + mca_type_details, + router_data, + updated_customer, ) .await?; @@ -409,17 +452,37 @@ where .get_connector_from_request(state, &req, &mut payment_data) .await?; - let router_data = internal_call_connector_service( + let merchant_connector_account = payment_data + .get_merchant_connector_details() + .map(domain::MerchantConnectorAccountTypeDetails::MerchantConnectorDetails) + .ok_or_else(|| { + error_stack::report!(errors::ApiErrorResponse::InternalServerError) + .attach_printable("Merchant connector details not found in payment data") + })?; + + operation + .to_domain()? + .populate_payment_data( + state, + &mut payment_data, + &merchant_context, + profile, + &connector_data, + ) + .await?; + + let router_data = connector_service_decider( state, req_state.clone(), &merchant_context, - connector_data, + connector_data.clone(), &operation, &mut payment_data, call_connector_action.clone(), header_payload.clone(), profile, req.should_return_raw_response(), + merchant_connector_account, ) .await?; @@ -3508,27 +3571,29 @@ where router_data = router_data.add_session_token(state, &connector).await?; - let mut should_continue_further = access_token::update_router_data_with_access_token_result( + let should_continue_further = access_token::update_router_data_with_access_token_result( &add_access_token_result, &mut router_data, &call_connector_action, ); - let add_create_order_result = router_data + let should_continue_further = match router_data .create_order_at_connector(state, &connector, should_continue_further) - .await?; + .await? + { + Some(create_order_response) => { + if let Ok(order_id) = create_order_response.clone().create_order_result { + payment_data.set_connector_response_reference_id(Some(order_id.clone())) + } - if add_create_order_result.is_create_order_performed { - if let Ok(order_id_opt) = &add_create_order_result.create_order_result { - payment_data.set_connector_response_reference_id(order_id_opt.clone()); + // Set the response in routerdata response to carry forward + router_data + .update_router_data_with_create_order_response(create_order_response.clone()); + create_order_response.create_order_result.ok().is_some() } - should_continue_further = router_data - .update_router_data_with_create_order_result( - add_create_order_result, - should_continue_further, - ) - .await?; - } + // If create order is not required, then we can proceed with further processing + None => true, + }; let updated_customer = call_create_connector_customer_if_required( state, @@ -3948,6 +4013,9 @@ pub async fn call_connector_service<F, RouterDReq, ApiRequest, D>( is_retry_payment: bool, should_retry_with_pan: bool, return_raw_connector_response: Option<bool>, + merchant_connector_account_type_details: domain::MerchantConnectorAccountTypeDetails, + mut router_data: RouterData<F, RouterDReq, router_types::PaymentsResponseData>, + updated_customer: Option<storage::CustomerUpdate>, ) -> RouterResult<RouterData<F, RouterDReq, router_types::PaymentsResponseData>> where F: Send + Clone + Sync, @@ -3961,50 +4029,6 @@ where dyn api::Connector: services::api::ConnectorIntegration<F, RouterDReq, router_types::PaymentsResponseData>, { - let stime_connector = Instant::now(); - - let merchant_connector_account = - domain::MerchantConnectorAccountTypeDetails::MerchantConnectorAccount(Box::new( - helpers::get_merchant_connector_account_v2( - state, - merchant_context.get_merchant_key_store(), - connector.merchant_connector_id.as_ref(), - ) - .await?, - )); - - operation - .to_domain()? - .populate_payment_data( - state, - payment_data, - merchant_context, - business_profile, - &connector, - ) - .await?; - - let updated_customer = call_create_connector_customer_if_required( - state, - customer, - merchant_context, - &merchant_connector_account, - payment_data, - ) - .await?; - - let mut router_data = payment_data - .construct_router_data( - state, - connector.connector.id(), - merchant_context, - customer, - &merchant_connector_account, - None, - None, - ) - .await?; - let add_access_token_result = router_data .add_access_token( state, @@ -4016,37 +4040,43 @@ where router_data = router_data.add_session_token(state, &connector).await?; - let mut should_continue_further = access_token::update_router_data_with_access_token_result( + let should_continue_further = access_token::update_router_data_with_access_token_result( &add_access_token_result, &mut router_data, &call_connector_action, ); - let add_create_order_result = router_data + let should_continue = match router_data .create_order_at_connector(state, &connector, should_continue_further) - .await?; + .await? + { + Some(create_order_response) => { + if let Ok(order_id) = create_order_response.clone().create_order_result { + payment_data.set_connector_response_reference_id(Some(order_id)) + } - if add_create_order_result.is_create_order_performed { - if let Ok(order_id_opt) = &add_create_order_result.create_order_result { - payment_data.set_connector_response_reference_id(order_id_opt.clone()); + // Set the response in routerdata response to carry forward + router_data + .update_router_data_with_create_order_response(create_order_response.clone()); + create_order_response.create_order_result.ok().map(|_| ()) } - should_continue_further = router_data - .update_router_data_with_create_order_result( - add_create_order_result, - should_continue_further, - ) - .await?; - } + // If create order is not required, then we can proceed with further processing + None => Some(()), + }; // In case of authorize flow, pre-task and post-tasks are being called in build request // if we do not want to proceed further, then the function will return Ok(None, false) - let (connector_request, should_continue_further) = if should_continue_further { - // Check if the actual flow specific request can be built with available data - router_data - .build_flow_specific_connector_request(state, &connector, call_connector_action.clone()) - .await? - } else { - (None, false) + let (connector_request, should_continue_further) = match should_continue { + Some(_) => { + router_data + .build_flow_specific_connector_request( + state, + &connector, + call_connector_action.clone(), + ) + .await? + } + None => (None, false), }; // Update the payment trackers just before calling the connector @@ -4089,18 +4119,14 @@ where Ok(router_data) }?; - let etime_connector = Instant::now(); - let duration_connector = etime_connector.saturating_duration_since(stime_connector); - tracing::info!(duration = format!("Duration taken: {}", duration_connector.as_millis())); - Ok(router_data) } -#[cfg(feature = "v1")] -// This function does not perform the tokenization action, as the payment method is not saved in this flow. +#[cfg(feature = "v2")] #[allow(clippy::too_many_arguments)] +#[allow(clippy::type_complexity)] #[instrument(skip_all)] -pub async fn proxy_for_call_connector_service<F, RouterDReq, ApiRequest, D>( +pub async fn call_connector_service_prerequisites<F, RouterDReq, ApiRequest, D>( state: &SessionState, req_state: ReqState, merchant_context: &domain::MerchantContext, @@ -4109,15 +4135,17 @@ pub async fn proxy_for_call_connector_service<F, RouterDReq, ApiRequest, D>( payment_data: &mut D, customer: &Option<domain::Customer>, call_connector_action: CallConnectorAction, - validate_result: &operations::ValidateResult, schedule_time: Option<time::PrimitiveDateTime>, header_payload: HeaderPayload, - + frm_suggestion: Option<storage_enums::FrmSuggestion>, business_profile: &domain::Profile, - return_raw_connector_response: Option<bool>, + is_retry_payment: bool, + should_retry_with_pan: bool, + all_keys_required: Option<bool>, ) -> RouterResult<( + domain::MerchantConnectorAccountTypeDetails, + Option<storage::CustomerUpdate>, RouterData<F, RouterDReq, router_types::PaymentsResponseData>, - helpers::MerchantConnectorAccountType, )> where F: Send + Clone + Sync, @@ -4131,145 +4159,354 @@ where dyn api::Connector: services::api::ConnectorIntegration<F, RouterDReq, router_types::PaymentsResponseData>, { - let stime_connector = Instant::now(); + let merchant_connector_account_type_details = + domain::MerchantConnectorAccountTypeDetails::MerchantConnectorAccount(Box::new( + helpers::get_merchant_connector_account_v2( + state, + merchant_context.get_merchant_key_store(), + connector.merchant_connector_id.as_ref(), + ) + .await?, + )); - let merchant_connector_account = construct_profile_id_and_get_mca( + operation + .to_domain()? + .populate_payment_data( + state, + payment_data, + merchant_context, + business_profile, + &connector, + ) + .await?; + + let updated_customer = call_create_connector_customer_if_required( state, + customer, merchant_context, + &merchant_connector_account_type_details, payment_data, - &connector.connector_name.to_string(), - connector.merchant_connector_id.as_ref(), - false, ) .await?; - if payment_data - .get_payment_attempt() - .merchant_connector_id - .is_none() - { - payment_data.set_merchant_connector_id_in_attempt(merchant_connector_account.get_mca_id()); - } - - let merchant_recipient_data = None; - - let mut router_data = payment_data + let router_data = payment_data .construct_router_data( state, connector.connector.id(), merchant_context, customer, - &merchant_connector_account, - merchant_recipient_data, + &merchant_connector_account_type_details, + None, None, ) .await?; - let add_access_token_result = router_data - .add_access_token( + Ok(( + merchant_connector_account_type_details, + updated_customer, + router_data, + )) +} + +#[cfg(feature = "v2")] +#[instrument(skip_all)] +pub async fn internal_call_connector_service_prerequisites<F, RouterDReq, ApiRequest, D>( + state: &SessionState, + merchant_context: &domain::MerchantContext, + connector: api::ConnectorData, + operation: &BoxedOperation<'_, F, ApiRequest, D>, + payment_data: &mut D, + business_profile: &domain::Profile, +) -> RouterResult<( + domain::MerchantConnectorAccountTypeDetails, + RouterData<F, RouterDReq, router_types::PaymentsResponseData>, +)> +where + F: Send + Clone + Sync, + RouterDReq: Send + Sync, + + // To create connector flow specific interface data + D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, + D: ConstructFlowSpecificData<F, RouterDReq, router_types::PaymentsResponseData>, + RouterData<F, RouterDReq, router_types::PaymentsResponseData>: Feature<F, RouterDReq> + Send, + // To construct connector flow specific api + dyn api::Connector: + services::api::ConnectorIntegration<F, RouterDReq, router_types::PaymentsResponseData>, +{ + let merchant_connector_details = + payment_data + .get_merchant_connector_details() + .ok_or_else(|| { + error_stack::report!(errors::ApiErrorResponse::InternalServerError) + .attach_printable("Merchant connector details not found in payment data") + })?; + let merchant_connector_account = + domain::MerchantConnectorAccountTypeDetails::MerchantConnectorDetails( + merchant_connector_details, + ); + + operation + .to_domain()? + .populate_payment_data( state, - &connector, + payment_data, merchant_context, - payment_data.get_creds_identifier(), + business_profile, + &connector, ) .await?; - router_data = router_data.add_session_token(state, &connector).await?; + let router_data = payment_data + .construct_router_data( + state, + connector.connector.id(), + merchant_context, + &None, + &merchant_connector_account, + None, + None, + ) + .await?; - let mut should_continue_further = access_token::update_router_data_with_access_token_result( - &add_access_token_result, - &mut router_data, - &call_connector_action, - ); + Ok((merchant_connector_account, router_data)) +} - (router_data, should_continue_further) = complete_preprocessing_steps_if_required( - state, - &connector, - payment_data, - router_data, - operation, - should_continue_further, - ) - .await?; +#[cfg(feature = "v2")] +#[allow(clippy::too_many_arguments)] +#[instrument(skip_all)] +pub async fn connector_service_decider<F, RouterDReq, ApiRequest, D>( + state: &SessionState, + req_state: ReqState, + merchant_context: &domain::MerchantContext, + connector: api::ConnectorData, + operation: &BoxedOperation<'_, F, ApiRequest, D>, + payment_data: &mut D, + call_connector_action: CallConnectorAction, + header_payload: HeaderPayload, + business_profile: &domain::Profile, + return_raw_connector_response: Option<bool>, + merchant_connector_account_type_details: domain::MerchantConnectorAccountTypeDetails, +) -> RouterResult<RouterData<F, RouterDReq, router_types::PaymentsResponseData>> +where + F: Send + Clone + Sync, + RouterDReq: Send + Sync, - if let Ok(router_types::PaymentsResponseData::PreProcessingResponse { - session_token: Some(session_token), - .. - }) = router_data.response.to_owned() - { - payment_data.push_sessions_token(session_token); - }; + // To create connector flow specific interface data + D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, + D: ConstructFlowSpecificData<F, RouterDReq, router_types::PaymentsResponseData>, + RouterData<F, RouterDReq, router_types::PaymentsResponseData>: Feature<F, RouterDReq> + Send, + // To construct connector flow specific api + dyn api::Connector: + services::api::ConnectorIntegration<F, RouterDReq, router_types::PaymentsResponseData>, +{ + let mut router_data = payment_data + .construct_router_data( + state, + connector.connector.id(), + merchant_context, + &None, + &merchant_connector_account_type_details, + None, + None, + ) + .await?; - let (connector_request, should_continue_further) = if should_continue_further { - // Check if the actual flow specific request can be built with available data - router_data - .build_flow_specific_connector_request(state, &connector, call_connector_action.clone()) + // do order creation + let should_call_unified_connector_service = + should_call_unified_connector_service(state, merchant_context, &router_data).await?; + + let (connector_request, should_continue_further) = if !should_call_unified_connector_service { + let mut should_continue_further = true; + + let should_continue = match router_data + .create_order_at_connector(state, &connector, should_continue_further) .await? + { + Some(create_order_response) => { + if let Ok(order_id) = create_order_response.clone().create_order_result { + payment_data.set_connector_response_reference_id(Some(order_id)) + } + + // Set the response in routerdata response to carry forward + router_data + .update_router_data_with_create_order_response(create_order_response.clone()); + create_order_response.create_order_result.ok().map(|_| ()) + } + // If create order is not required, then we can proceed with further processing + None => Some(()), + }; + + let should_continue: (Option<common_utils::request::Request>, bool) = match should_continue + { + Some(_) => { + router_data + .build_flow_specific_connector_request( + state, + &connector, + call_connector_action.clone(), + ) + .await? + } + None => (None, false), + }; + should_continue } else { + // If unified connector service is called, these values are not used + // as the request is built in the unified connector service call (None, false) }; - if should_add_task_to_process_tracker(payment_data) { - operation - .to_domain()? - .add_task_to_process_tracker( - state, - payment_data.get_payment_attempt(), - validate_result.requeue, - schedule_time, - ) - .await - .map_err(|error| logger::error!(process_tracker_error=?error)) - .ok(); - } - - let updated_customer = None; - let frm_suggestion = None; - (_, *payment_data) = operation .to_update_tracker()? .update_trackers( state, req_state, payment_data.clone(), - customer.clone(), + None, // customer is not used in internal flows merchant_context.get_merchant_account().storage_scheme, - updated_customer, + None, merchant_context.get_merchant_key_store(), - frm_suggestion, + None, // frm_suggestion is not used in internal flows header_payload.clone(), ) .await?; - let router_data = if should_continue_further { - // The status of payment_attempt and intent will be updated in the previous step - // update this in router_data. - // This is added because few connector integrations do not update the status, - // and rely on previous status set in router_data - router_data.status = payment_data.get_payment_attempt().status; - router_data - .decide_flows( + record_time_taken_with(|| async { + if should_call_unified_connector_service { + router_data + .call_unified_connector_service( + state, + merchant_connector_account_type_details.clone(), + merchant_context, + ) + .await?; + + Ok(router_data) + } else { + let router_data = if should_continue_further { + router_data + .decide_flows( + state, + &connector, + call_connector_action, + connector_request, + business_profile, + header_payload.clone(), + return_raw_connector_response, + ) + .await + } else { + Ok(router_data) + }?; + Ok(router_data) + } + }) + .await +} + +#[cfg(feature = "v2")] +#[allow(clippy::too_many_arguments)] +#[instrument(skip_all)] +pub async fn decide_unified_connector_service_call<F, RouterDReq, ApiRequest, D>( + state: &SessionState, + req_state: ReqState, + merchant_context: &domain::MerchantContext, + connector: api::ConnectorData, + operation: &BoxedOperation<'_, F, ApiRequest, D>, + payment_data: &mut D, + customer: &Option<domain::Customer>, + call_connector_action: CallConnectorAction, + schedule_time: Option<time::PrimitiveDateTime>, + header_payload: HeaderPayload, + frm_suggestion: Option<storage_enums::FrmSuggestion>, + business_profile: &domain::Profile, + is_retry_payment: bool, + should_retry_with_pan: bool, + return_raw_connector_response: Option<bool>, + merchant_connector_account_type_details: domain::MerchantConnectorAccountTypeDetails, + mut router_data: RouterData<F, RouterDReq, router_types::PaymentsResponseData>, + updated_customer: Option<storage::CustomerUpdate>, +) -> RouterResult<RouterData<F, RouterDReq, router_types::PaymentsResponseData>> +where + F: Send + Clone + Sync, + RouterDReq: Send + Sync, + + // To create connector flow specific interface data + D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, + D: ConstructFlowSpecificData<F, RouterDReq, router_types::PaymentsResponseData>, + RouterData<F, RouterDReq, router_types::PaymentsResponseData>: Feature<F, RouterDReq> + Send, + // To construct connector flow specific api + dyn api::Connector: + services::api::ConnectorIntegration<F, RouterDReq, router_types::PaymentsResponseData>, +{ + record_time_taken_with(|| async { + if should_call_unified_connector_service(state, merchant_context, &router_data).await? { + if should_add_task_to_process_tracker(payment_data) { + operation + .to_domain()? + .add_task_to_process_tracker( + state, + payment_data.get_payment_attempt(), + false, + schedule_time, + ) + .await + .map_err(|error| logger::error!(process_tracker_error=?error)) + .ok(); + } + + (_, *payment_data) = operation + .to_update_tracker()? + .update_trackers( + state, + req_state, + payment_data.clone(), + customer.clone(), + merchant_context.get_merchant_account().storage_scheme, + None, + merchant_context.get_merchant_key_store(), + frm_suggestion, + header_payload.clone(), + ) + .await?; + + router_data + .call_unified_connector_service( + state, + merchant_connector_account_type_details.clone(), + merchant_context, + ) + .await?; + + Ok(router_data) + } else { + call_connector_service( state, - &connector, + req_state, + merchant_context, + connector, + operation, + payment_data, + customer, call_connector_action, - connector_request, + schedule_time, + header_payload, + frm_suggestion, business_profile, - header_payload.clone(), + is_retry_payment, + should_retry_with_pan, return_raw_connector_response, + merchant_connector_account_type_details, + router_data, + updated_customer, ) .await - } else { - Ok(router_data) - }?; - - let etime_connector = Instant::now(); - let duration_connector = etime_connector.saturating_duration_since(stime_connector); - tracing::info!(duration = format!("Duration taken: {}", duration_connector.as_millis())); - - Ok((router_data, merchant_connector_account)) + } + }) + .await } - -#[cfg(feature = "v2")] +#[cfg(feature = "v1")] +// This function does not perform the tokenization action, as the payment method is not saved in this flow. #[allow(clippy::too_many_arguments)] #[instrument(skip_all)] pub async fn proxy_for_call_connector_service<F, RouterDReq, ApiRequest, D>( @@ -4279,11 +4516,18 @@ pub async fn proxy_for_call_connector_service<F, RouterDReq, ApiRequest, D>( connector: api::ConnectorData, operation: &BoxedOperation<'_, F, ApiRequest, D>, payment_data: &mut D, + customer: &Option<domain::Customer>, call_connector_action: CallConnectorAction, + validate_result: &operations::ValidateResult, + schedule_time: Option<time::PrimitiveDateTime>, header_payload: HeaderPayload, + business_profile: &domain::Profile, return_raw_connector_response: Option<bool>, -) -> RouterResult<RouterData<F, RouterDReq, router_types::PaymentsResponseData>> +) -> RouterResult<( + RouterData<F, RouterDReq, router_types::PaymentsResponseData>, + helpers::MerchantConnectorAccountType, +)> where F: Send + Clone + Sync, RouterDReq: Send + Sync, @@ -4298,34 +4542,34 @@ where { let stime_connector = Instant::now(); - let merchant_connector_account = - domain::MerchantConnectorAccountTypeDetails::MerchantConnectorAccount(Box::new( - helpers::get_merchant_connector_account_v2( - state, - merchant_context.get_merchant_key_store(), - connector.merchant_connector_id.as_ref(), - ) - .await?, - )); - operation - .to_domain()? - .populate_payment_data( - state, - payment_data, - merchant_context, - business_profile, - &connector, - ) - .await?; + let merchant_connector_account = construct_profile_id_and_get_mca( + state, + merchant_context, + payment_data, + &connector.connector_name.to_string(), + connector.merchant_connector_id.as_ref(), + false, + ) + .await?; + + if payment_data + .get_payment_attempt() + .merchant_connector_id + .is_none() + { + payment_data.set_merchant_connector_id_in_attempt(merchant_connector_account.get_mca_id()); + } + + let merchant_recipient_data = None; let mut router_data = payment_data .construct_router_data( state, connector.connector.id(), merchant_context, - &None, + customer, &merchant_connector_account, - None, + merchant_recipient_data, None, ) .await?; @@ -4347,7 +4591,26 @@ where &call_connector_action, ); + (router_data, should_continue_further) = complete_preprocessing_steps_if_required( + state, + &connector, + payment_data, + router_data, + operation, + should_continue_further, + ) + .await?; + + if let Ok(router_types::PaymentsResponseData::PreProcessingResponse { + session_token: Some(session_token), + .. + }) = router_data.response.to_owned() + { + payment_data.push_sessions_token(session_token); + }; + let (connector_request, should_continue_further) = if should_continue_further { + // Check if the actual flow specific request can be built with available data router_data .build_flow_specific_connector_request(state, &connector, call_connector_action.clone()) .await? @@ -4355,22 +4618,44 @@ where (None, false) }; + if should_add_task_to_process_tracker(payment_data) { + operation + .to_domain()? + .add_task_to_process_tracker( + state, + payment_data.get_payment_attempt(), + validate_result.requeue, + schedule_time, + ) + .await + .map_err(|error| logger::error!(process_tracker_error=?error)) + .ok(); + } + + let updated_customer = None; + let frm_suggestion = None; + (_, *payment_data) = operation .to_update_tracker()? .update_trackers( state, req_state, payment_data.clone(), - None, + customer.clone(), merchant_context.get_merchant_account().storage_scheme, - None, + updated_customer, merchant_context.get_merchant_key_store(), - None, + frm_suggestion, header_payload.clone(), ) .await?; let router_data = if should_continue_further { + // The status of payment_attempt and intent will be updated in the previous step + // update this in router_data. + // This is added because few connector integrations do not update the status, + // and rely on previous status set in router_data + router_data.status = payment_data.get_payment_attempt().status; router_data .decide_flows( state, @@ -4390,13 +4675,13 @@ where let duration_connector = etime_connector.saturating_duration_since(stime_connector); tracing::info!(duration = format!("Duration taken: {}", duration_connector.as_millis())); - Ok(router_data) + Ok((router_data, merchant_connector_account)) } #[cfg(feature = "v2")] #[allow(clippy::too_many_arguments)] #[instrument(skip_all)] -pub async fn internal_call_connector_service<F, RouterDReq, ApiRequest, D>( +pub async fn proxy_for_call_connector_service<F, RouterDReq, ApiRequest, D>( state: &SessionState, req_state: ReqState, merchant_context: &domain::MerchantContext, @@ -4422,18 +4707,15 @@ where { let stime_connector = Instant::now(); - let merchant_connector_details = - payment_data - .get_merchant_connector_details() - .ok_or_else(|| { - error_stack::report!(errors::ApiErrorResponse::InternalServerError) - .attach_printable("Merchant connector details not found in payment data") - })?; let merchant_connector_account = - domain::MerchantConnectorAccountTypeDetails::MerchantConnectorDetails( - merchant_connector_details, - ); - + domain::MerchantConnectorAccountTypeDetails::MerchantConnectorAccount(Box::new( + helpers::get_merchant_connector_account_v2( + state, + merchant_context.get_merchant_key_store(), + connector.merchant_connector_id.as_ref(), + ) + .await?, + )); operation .to_domain()? .populate_payment_data( @@ -4474,22 +4756,6 @@ where &call_connector_action, ); - let add_create_order_result = router_data - .create_order_at_connector(state, &connector, should_continue_further) - .await?; - - if add_create_order_result.is_create_order_performed { - if let Ok(order_id_opt) = &add_create_order_result.create_order_result { - payment_data.set_connector_response_reference_id(order_id_opt.clone()); - } - should_continue_further = router_data - .update_router_data_with_create_order_result( - add_create_order_result, - should_continue_further, - ) - .await?; - } - let (connector_request, should_continue_further) = if should_continue_further { router_data .build_flow_specific_connector_request(state, &connector, call_connector_action.clone()) diff --git a/crates/router/src/core/payments/flows.rs b/crates/router/src/core/payments/flows.rs index a93e2f391fe..2cae2f0600d 100644 --- a/crates/router/src/core/payments/flows.rs +++ b/crates/router/src/core/payments/flows.rs @@ -185,35 +185,27 @@ pub trait Feature<F, T> { _state: &SessionState, _connector: &api::ConnectorData, _should_continue_payment: bool, - ) -> RouterResult<types::CreateOrderResult> + ) -> RouterResult<Option<types::CreateOrderResult>> where F: Clone, Self: Sized, dyn api::Connector: services::ConnectorIntegration<F, T, types::PaymentsResponseData>, { - Ok(types::CreateOrderResult { - create_order_result: Ok(None), - is_create_order_performed: false, - }) + Ok(None) } - async fn update_router_data_with_create_order_result( + fn update_router_data_with_create_order_response( &mut self, _create_order_result: types::CreateOrderResult, - should_continue_payment: bool, - ) -> RouterResult<bool> - where - F: Clone, - Self: Sized, - dyn api::Connector: services::ConnectorIntegration<F, T, types::PaymentsResponseData>, - { - Ok(should_continue_payment) + ) { } async fn call_unified_connector_service<'a>( &mut self, _state: &SessionState, - _merchant_connector_account: helpers::MerchantConnectorAccountType, + #[cfg(feature = "v1")] _merchant_connector_account: helpers::MerchantConnectorAccountType, + #[cfg(feature = "v2")] + _merchant_connector_account: domain::MerchantConnectorAccountTypeDetails, _merchant_context: &domain::MerchantContext, ) -> RouterResult<()> where diff --git a/crates/router/src/core/payments/flows/authorize_flow.rs b/crates/router/src/core/payments/flows/authorize_flow.rs index 1532fffa3f9..f42efa0c1e4 100644 --- a/crates/router/src/core/payments/flows/authorize_flow.rs +++ b/crates/router/src/core/payments/flows/authorize_flow.rs @@ -431,7 +431,7 @@ impl Feature<api::Authorize, types::PaymentsAuthorizeData> for types::PaymentsAu state: &SessionState, connector: &api::ConnectorData, should_continue_payment: bool, - ) -> RouterResult<types::CreateOrderResult> { + ) -> RouterResult<Option<types::CreateOrderResult>> { if connector .connector_name .requires_order_creation_before_payment(self.payment_method) @@ -471,7 +471,7 @@ impl Feature<api::Authorize, types::PaymentsAuthorizeData> for types::PaymentsAu if let types::PaymentsResponseData::PaymentsCreateOrderResponse { order_id } = res { - Ok(Some(order_id)) + Ok(order_id) } else { Err(error_stack::report!(ApiErrorResponse::InternalServerError) .attach_printable(format!( @@ -482,47 +482,37 @@ impl Feature<api::Authorize, types::PaymentsAuthorizeData> for types::PaymentsAu Err(error) => Err(error), }; - Ok(types::CreateOrderResult { + Ok(Some(types::CreateOrderResult { create_order_result: create_order_resp, - is_create_order_performed: true, - }) + })) } else { - Ok(types::CreateOrderResult { - create_order_result: Ok(None), - is_create_order_performed: false, - }) + // If the connector does not require order creation, return None + Ok(None) } } - async fn update_router_data_with_create_order_result( + fn update_router_data_with_create_order_response( &mut self, create_order_result: types::CreateOrderResult, - should_continue_further: bool, - ) -> RouterResult<bool> { - if create_order_result.is_create_order_performed { - match create_order_result.create_order_result { - Ok(Some(order_id)) => { - self.request.order_id = Some(order_id.clone()); - self.response = - Ok(types::PaymentsResponseData::PaymentsCreateOrderResponse { order_id }); - Ok(true) - } - Ok(None) => Err(error_stack::report!(ApiErrorResponse::InternalServerError) - .attach_printable("Order Id not found."))?, - Err(err) => { - self.response = Err(err.clone()); - Ok(false) - } + ) { + match create_order_result.create_order_result { + Ok(order_id) => { + self.request.order_id = Some(order_id.clone()); // ? why this is assigned here and ucs also wants this to populate data + self.response = + Ok(types::PaymentsResponseData::PaymentsCreateOrderResponse { order_id }); + } + Err(err) => { + self.response = Err(err.clone()); } - } else { - Ok(should_continue_further) } } async fn call_unified_connector_service<'a>( &mut self, state: &SessionState, - merchant_connector_account: helpers::MerchantConnectorAccountType, + #[cfg(feature = "v1")] merchant_connector_account: helpers::MerchantConnectorAccountType, + #[cfg(feature = "v2")] + merchant_connector_account: domain::MerchantConnectorAccountTypeDetails, merchant_context: &domain::MerchantContext, ) -> RouterResult<()> { let client = state @@ -558,13 +548,14 @@ impl Feature<api::Authorize, types::PaymentsAuthorizeData> for types::PaymentsAu let (status, router_data_response) = handle_unified_connector_service_response_for_payment_authorize( - payment_authorize_response, + payment_authorize_response.clone(), ) .change_context(ApiErrorResponse::InternalServerError) .attach_printable("Failed to deserialize UCS response")?; self.status = status; self.response = router_data_response; + self.raw_connector_response = payment_authorize_response.raw_connector_response; Ok(()) } diff --git a/crates/router/src/core/payments/flows/psync_flow.rs b/crates/router/src/core/payments/flows/psync_flow.rs index f2ffbe24d11..e27c9974406 100644 --- a/crates/router/src/core/payments/flows/psync_flow.rs +++ b/crates/router/src/core/payments/flows/psync_flow.rs @@ -1,6 +1,8 @@ use std::collections::HashMap; use async_trait::async_trait; +use error_stack::ResultExt; +use unified_connector_service_client::payments as payments_grpc; use super::{ConstructFlowSpecificData, Feature}; use crate::{ @@ -8,10 +10,14 @@ use crate::{ core::{ errors::{ApiErrorResponse, ConnectorErrorExt, RouterResult}, payments::{self, access_token, helpers, transformers, PaymentData}, + unified_connector_service::{ + build_unified_connector_service_auth_metadata, + handle_unified_connector_service_response_for_payment_get, + }, }, routes::SessionState, services::{self, api::ConnectorValidation, logger}, - types::{self, api, domain}, + types::{self, api, domain, transformers::ForeignTryFrom}, }; #[cfg(feature = "v1")] @@ -204,6 +210,56 @@ impl Feature<api::PSync, types::PaymentsSyncData> Ok((request, true)) } + + async fn call_unified_connector_service<'a>( + &mut self, + state: &SessionState, + #[cfg(feature = "v1")] merchant_connector_account: helpers::MerchantConnectorAccountType, + #[cfg(feature = "v2")] + merchant_connector_account: domain::MerchantConnectorAccountTypeDetails, + merchant_context: &domain::MerchantContext, + ) -> RouterResult<()> { + let client = state + .grpc_client + .unified_connector_service_client + .clone() + .ok_or(ApiErrorResponse::InternalServerError) + .attach_printable("Failed to fetch Unified Connector Service client")?; + + let payment_get_request = payments_grpc::PaymentServiceGetRequest::foreign_try_from(self) + .change_context(ApiErrorResponse::InternalServerError) + .attach_printable("Failed to construct Payment Get Request")?; + + let connector_auth_metadata = build_unified_connector_service_auth_metadata( + merchant_connector_account, + merchant_context, + ) + .change_context(ApiErrorResponse::InternalServerError) + .attach_printable("Failed to construct request metadata")?; + + let response = client + .payment_get( + payment_get_request, + connector_auth_metadata, + state.get_grpc_headers(), + ) + .await + .change_context(ApiErrorResponse::InternalServerError) + .attach_printable("Failed to get payment")?; + + let payment_get_response = response.into_inner(); + + let (status, router_data_response) = + handle_unified_connector_service_response_for_payment_get(payment_get_response.clone()) + .change_context(ApiErrorResponse::InternalServerError) + .attach_printable("Failed to deserialize UCS response")?; + + self.status = status; + self.response = router_data_response; + self.raw_connector_response = payment_get_response.raw_connector_response; + + Ok(()) + } } #[async_trait] diff --git a/crates/router/src/core/payments/transformers.rs b/crates/router/src/core/payments/transformers.rs index 2379dddb8fd..59359429080 100644 --- a/crates/router/src/core/payments/transformers.rs +++ b/crates/router/src/core/payments/transformers.rs @@ -304,7 +304,7 @@ pub async fn construct_payment_router_data_for_authorize<'a>( router_return_url: Some(router_return_url), webhook_url, complete_authorize_url, - customer_id: None, + customer_id: customer_id.clone(), surcharge_details: None, request_extended_authorization: None, request_incremental_authorization: matches!( @@ -3466,8 +3466,126 @@ where impl<F: Clone> TryFrom<PaymentAdditionalData<'_, F>> for types::PaymentsAuthorizeData { type Error = error_stack::Report<errors::ApiErrorResponse>; - fn try_from(_additional_data: PaymentAdditionalData<'_, F>) -> Result<Self, Self::Error> { - todo!() + fn try_from(additional_data: PaymentAdditionalData<'_, F>) -> Result<Self, Self::Error> { + let payment_data = additional_data.payment_data.clone(); + let router_base_url = &additional_data.router_base_url; + let connector_name = &additional_data.connector_name; + let attempt = &payment_data.payment_attempt; + let browser_info: Option<types::BrowserInformation> = attempt + .browser_info + .clone() + .map(types::BrowserInformation::from); + + let complete_authorize_url = Some(helpers::create_complete_authorize_url( + router_base_url, + attempt, + connector_name, + payment_data.creds_identifier.as_deref(), + )); + + let merchant_connector_account_id_or_connector_name = payment_data + .payment_attempt + .merchant_connector_id + .as_ref() + .map(|mca_id| mca_id.get_string_repr()) + .unwrap_or(connector_name); + + let webhook_url = Some(helpers::create_webhook_url( + router_base_url, + &attempt.merchant_id, + merchant_connector_account_id_or_connector_name, + )); + let router_return_url = Some(helpers::create_redirect_url( + router_base_url, + attempt, + connector_name, + payment_data.creds_identifier.as_deref(), + )); + + let payment_method_data = payment_data.payment_method_data.or_else(|| { + if payment_data.mandate_id.is_some() { + Some(domain::PaymentMethodData::MandatePayment) + } else { + None + } + }); + + let amount = payment_data + .payment_attempt + .get_total_amount() + .get_amount_as_i64(); + + let customer_name = additional_data + .customer_data + .as_ref() + .and_then(|customer_data| { + customer_data + .name + .as_ref() + .map(|customer| customer.clone().into_inner()) + }); + + let customer_id = additional_data + .customer_data + .as_ref() + .and_then(|data| data.get_id().clone().try_into().ok()); + + let merchant_order_reference_id = payment_data + .payment_intent + .merchant_reference_id + .map(|s| s.get_string_repr().to_string()); + + let shipping_cost = payment_data.payment_intent.amount_details.shipping_cost; + + Ok(Self { + payment_method_data: payment_method_data + .unwrap_or(domain::PaymentMethodData::Card(domain::Card::default())), + amount, + order_tax_amount: None, // V2 doesn't currently support order tax amount + email: None, // V2 doesn't store email directly in payment_intent + customer_name, + currency: payment_data.currency, + confirm: true, + statement_descriptor_suffix: None, + statement_descriptor: None, + capture_method: Some(payment_data.payment_intent.capture_method), + router_return_url, + webhook_url, + complete_authorize_url, + setup_future_usage: Some(payment_data.payment_intent.setup_future_usage), + mandate_id: payment_data.mandate_id.clone(), + off_session: get_off_session(payment_data.mandate_id.as_ref(), None), + customer_acceptance: None, + setup_mandate_details: None, + browser_info, + order_details: None, + order_category: None, + session_token: None, + enrolled_for_3ds: false, + related_transaction_id: None, + payment_experience: None, + payment_method_type: Some(payment_data.payment_attempt.payment_method_subtype), + surcharge_details: None, + customer_id, + request_incremental_authorization: false, + metadata: payment_data + .payment_intent + .metadata + .clone() + .map(|m| m.expose()), + authentication_data: None, + request_extended_authorization: None, + split_payments: None, + minor_amount: payment_data.payment_attempt.get_total_amount(), + merchant_order_reference_id, + integrity_object: None, + shipping_cost, + additional_payment_method_data: None, + merchant_account_id: None, + merchant_config_currency: None, + connector_testing_data: None, + order_id: None, + }) } } diff --git a/crates/router/src/core/unified_connector_service.rs b/crates/router/src/core/unified_connector_service.rs index 3cdcb28d4d8..14836ff20c6 100644 --- a/crates/router/src/core/unified_connector_service.rs +++ b/crates/router/src/core/unified_connector_service.rs @@ -1,4 +1,3 @@ -use api_models::admin::ConnectorAuthType; use common_enums::{AttemptStatus, PaymentMethodType}; use common_utils::{errors::CustomResult, ext_traits::ValueExt}; use error_stack::ResultExt; @@ -6,9 +5,11 @@ use external_services::grpc_client::unified_connector_service::{ ConnectorAuthMetadata, UnifiedConnectorServiceError, }; use hyperswitch_connectors::utils::CardData; +#[cfg(feature = "v2")] +use hyperswitch_domain_models::merchant_connector_account::MerchantConnectorAccountTypeDetails; use hyperswitch_domain_models::{ merchant_context::MerchantContext, - router_data::{ErrorResponse, RouterData}, + router_data::{ConnectorAuthType, ErrorResponse, RouterData}, router_response_types::{PaymentsResponseData, RedirectForm}, }; use masking::{ExposeInterface, PeekInterface, Secret}; @@ -101,7 +102,7 @@ pub fn build_unified_connector_service_payment_method( } _ => { return Err(UnifiedConnectorServiceError::NotImplemented(format!( - "Unimplemented card payment method type: {payment_method_type:?}" + "Unimplemented payment method subtype: {payment_method_type:?}" )) .into()); } @@ -113,24 +114,52 @@ pub fn build_unified_connector_service_payment_method( })), }) } + hyperswitch_domain_models::payment_method_data::PaymentMethodData::Upi(upi_data) => { + let upi_type = match upi_data { + hyperswitch_domain_models::payment_method_data::UpiData::UpiCollect( + upi_collect_data, + ) => { + let vpa_id = upi_collect_data.vpa_id.map(|vpa| vpa.expose()); + let upi_details = payments_grpc::UpiCollect { vpa_id }; + PaymentMethod::UpiCollect(upi_details) + } + _ => { + return Err(UnifiedConnectorServiceError::NotImplemented(format!( + "Unimplemented payment method subtype: {payment_method_type:?}" + )) + .into()); + } + }; - _ => Err(UnifiedConnectorServiceError::NotImplemented( - "Unimplemented Payment Method".to_string(), - ) + Ok(payments_grpc::PaymentMethod { + payment_method: Some(upi_type), + }) + } + _ => Err(UnifiedConnectorServiceError::NotImplemented(format!( + "Unimplemented payment method: {payment_method_data:?}" + )) .into()), } } pub fn build_unified_connector_service_auth_metadata( - merchant_connector_account: MerchantConnectorAccountType, + #[cfg(feature = "v1")] merchant_connector_account: MerchantConnectorAccountType, + #[cfg(feature = "v2")] merchant_connector_account: MerchantConnectorAccountTypeDetails, merchant_context: &MerchantContext, ) -> CustomResult<ConnectorAuthMetadata, UnifiedConnectorServiceError> { + #[cfg(feature = "v1")] let auth_type: ConnectorAuthType = merchant_connector_account .get_connector_account_details() .parse_value("ConnectorAuthType") .change_context(UnifiedConnectorServiceError::FailedToObtainAuthType) .attach_printable("Failed while parsing value for ConnectorAuthType")?; + #[cfg(feature = "v2")] + let auth_type: ConnectorAuthType = merchant_connector_account + .get_connector_account_details() + .change_context(UnifiedConnectorServiceError::FailedToObtainAuthType) + .attach_printable("Failed to obtain ConnectorAuthType")?; + let connector_name = { #[cfg(feature = "v1")] { @@ -211,30 +240,126 @@ pub fn handle_unified_connector_service_response_for_payment_authorize( }) }); + let transaction_id = response.transaction_id.as_ref().and_then(|id| { + id.id_type.clone().and_then(|id_type| match id_type { + payments_grpc::identifier::IdType::Id(id) => Some(id), + payments_grpc::identifier::IdType::EncodedData(encoded_data) => Some(encoded_data), + payments_grpc::identifier::IdType::NoResponseIdMarker(_) => None, + }) + }); + let router_data_response = match status { AttemptStatus::Charged | - AttemptStatus::Authorized | - AttemptStatus::AuthenticationPending | - AttemptStatus::DeviceDataCollectionPending => Ok(PaymentsResponseData::TransactionResponse { - resource_id: match connector_response_reference_id.as_ref() { + AttemptStatus::Authorized | + AttemptStatus::AuthenticationPending | + AttemptStatus::DeviceDataCollectionPending | + AttemptStatus::Started | + AttemptStatus::AuthenticationSuccessful | + AttemptStatus::Authorizing | + AttemptStatus::ConfirmationAwaited | + AttemptStatus::Pending => Ok(PaymentsResponseData::TransactionResponse { + resource_id: match transaction_id.as_ref() { + Some(transaction_id) => hyperswitch_domain_models::router_request_types::ResponseId::ConnectorTransactionId(transaction_id.clone()), + None => hyperswitch_domain_models::router_request_types::ResponseId::NoResponseId, + }, + redirection_data: Box::new( + response + .redirection_data + .clone() + .map(RedirectForm::foreign_try_from) + .transpose()? + ), + mandate_reference: Box::new(None), + connector_metadata: None, + network_txn_id: response.network_txn_id.clone(), + connector_response_reference_id, + incremental_authorization_allowed: response.incremental_authorization_allowed, + charges: None, + }), + AttemptStatus::AuthenticationFailed + | AttemptStatus::AuthorizationFailed + | AttemptStatus::Unresolved + | AttemptStatus::Failure => Err(ErrorResponse { + code: response.error_code().to_owned(), + message: response.error_message().to_owned(), + reason: Some(response.error_message().to_owned()), + status_code: 500, + attempt_status: Some(status), + connector_transaction_id: connector_response_reference_id, + network_decline_code: None, + network_advice_code: None, + network_error_message: None, + }), + AttemptStatus::RouterDeclined | + AttemptStatus::CodInitiated | + AttemptStatus::Voided | + AttemptStatus::VoidInitiated | + AttemptStatus::CaptureInitiated | + AttemptStatus::VoidFailed | + AttemptStatus::AutoRefunded | + AttemptStatus::PartialCharged | + AttemptStatus::PartialChargedAndChargeable | + AttemptStatus::PaymentMethodAwaited | + AttemptStatus::CaptureFailed | + AttemptStatus::IntegrityFailure => return Err(UnifiedConnectorServiceError::NotImplemented(format!( + "AttemptStatus {status:?} is not implemented for Unified Connector Service" + )).into()), + }; + + Ok((status, router_data_response)) +} + +pub fn handle_unified_connector_service_response_for_payment_get( + response: payments_grpc::PaymentServiceGetResponse, +) -> CustomResult< + (AttemptStatus, Result<PaymentsResponseData, ErrorResponse>), + UnifiedConnectorServiceError, +> { + let status = AttemptStatus::foreign_try_from(response.status())?; + + let connector_response_reference_id = + response.response_ref_id.as_ref().and_then(|identifier| { + identifier + .id_type + .clone() + .and_then(|id_type| match id_type { + payments_grpc::identifier::IdType::Id(id) => Some(id), + payments_grpc::identifier::IdType::EncodedData(encoded_data) => { + Some(encoded_data) + } + payments_grpc::identifier::IdType::NoResponseIdMarker(_) => None, + }) + }); + + let router_data_response = match status { + AttemptStatus::Charged | + AttemptStatus::Authorized | + AttemptStatus::AuthenticationPending | + AttemptStatus::DeviceDataCollectionPending | + AttemptStatus::Started | + AttemptStatus::AuthenticationSuccessful | + AttemptStatus::Authorizing | + AttemptStatus::ConfirmationAwaited | + AttemptStatus::Pending => Ok( + PaymentsResponseData::TransactionResponse { + resource_id: match connector_response_reference_id.as_ref() { Some(connector_response_reference_id) => hyperswitch_domain_models::router_request_types::ResponseId::ConnectorTransactionId(connector_response_reference_id.clone()), None => hyperswitch_domain_models::router_request_types::ResponseId::NoResponseId, }, - redirection_data: Box::new( - response - .redirection_data - .clone() - .map(RedirectForm::foreign_try_from) - .transpose()? - ), - mandate_reference: Box::new(None), - connector_metadata: None, - network_txn_id: response.network_txn_id.clone(), - connector_response_reference_id, - incremental_authorization_allowed: response.incremental_authorization_allowed, - charges: None, - }), - _ => Err(ErrorResponse { + redirection_data: Box::new( + None + ), + mandate_reference: Box::new(None), + connector_metadata: None, + network_txn_id: response.network_txn_id.clone(), + connector_response_reference_id, + incremental_authorization_allowed: None, + charges: None, + } + ), + AttemptStatus::AuthenticationFailed + | AttemptStatus::AuthorizationFailed + | AttemptStatus::Failure => Err(ErrorResponse { code: response.error_code().to_owned(), message: response.error_message().to_owned(), reason: Some(response.error_message().to_owned()), @@ -244,7 +369,22 @@ pub fn handle_unified_connector_service_response_for_payment_authorize( network_decline_code: None, network_advice_code: None, network_error_message: None, - }) + }), + AttemptStatus::RouterDeclined | + AttemptStatus::CodInitiated | + AttemptStatus::Voided | + AttemptStatus::VoidInitiated | + AttemptStatus::CaptureInitiated | + AttemptStatus::VoidFailed | + AttemptStatus::AutoRefunded | + AttemptStatus::PartialCharged | + AttemptStatus::PartialChargedAndChargeable | + AttemptStatus::Unresolved | + AttemptStatus::PaymentMethodAwaited | + AttemptStatus::CaptureFailed | + AttemptStatus::IntegrityFailure => return Err(UnifiedConnectorServiceError::NotImplemented(format!( + "AttemptStatus {status:?} is not implemented for Unified Connector Service" + )).into()), }; Ok((status, router_data_response)) diff --git a/crates/router/src/core/unified_connector_service/transformers.rs b/crates/router/src/core/unified_connector_service/transformers.rs index 0e2ae6fd343..e937a7e7d2d 100644 --- a/crates/router/src/core/unified_connector_service/transformers.rs +++ b/crates/router/src/core/unified_connector_service/transformers.rs @@ -7,8 +7,8 @@ use error_stack::ResultExt; use external_services::grpc_client::unified_connector_service::UnifiedConnectorServiceError; use hyperswitch_domain_models::{ router_data::RouterData, - router_flow_types::payments::Authorize, - router_request_types::{AuthenticationData, PaymentsAuthorizeData}, + router_flow_types::payments::{Authorize, PSync}, + router_request_types::{AuthenticationData, PaymentsAuthorizeData, PaymentsSyncData}, router_response_types::{PaymentsResponseData, RedirectForm}, }; use masking::{ExposeInterface, PeekInterface}; @@ -18,6 +18,37 @@ use crate::{ core::unified_connector_service::build_unified_connector_service_payment_method, types::transformers::ForeignTryFrom, }; +impl ForeignTryFrom<&RouterData<PSync, PaymentsSyncData, PaymentsResponseData>> + for payments_grpc::PaymentServiceGetRequest +{ + type Error = error_stack::Report<UnifiedConnectorServiceError>; + + fn foreign_try_from( + router_data: &RouterData<PSync, PaymentsSyncData, PaymentsResponseData>, + ) -> Result<Self, Self::Error> { + let connector_transaction_id = router_data + .request + .connector_transaction_id + .get_connector_transaction_id() + .map(|id| Identifier { + id_type: Some(payments_grpc::identifier::IdType::Id(id)), + }) + .ok(); + + let connector_ref_id = router_data + .request + .connector_reference_id + .clone() + .map(|id| Identifier { + id_type: Some(payments_grpc::identifier::IdType::Id(id)), + }); + + Ok(Self { + transaction_id: connector_transaction_id, + request_ref_id: connector_ref_id, + }) + } +} impl ForeignTryFrom<&RouterData<Authorize, PaymentsAuthorizeData, PaymentsResponseData>> for payments_grpc::PaymentServiceAuthorizeRequest @@ -113,7 +144,7 @@ impl ForeignTryFrom<&RouterData<Authorize, PaymentsAuthorizeData, PaymentsRespon .map(|shipping_cost| shipping_cost.get_amount_as_i64()), request_ref_id: Some(Identifier { id_type: Some(payments_grpc::identifier::IdType::Id( - router_data.payment_id.clone(), + router_data.connector_request_reference_id.clone(), )), }), connector_customer_id: router_data @@ -181,89 +212,115 @@ impl ForeignTryFrom<hyperswitch_domain_models::payment_address::PaymentAddress> fn foreign_try_from( payment_address: hyperswitch_domain_models::payment_address::PaymentAddress, ) -> Result<Self, Self::Error> { - let shipping = payment_address.get_shipping().and_then(|address| { - let details = address.address.as_ref()?; + let shipping = payment_address.get_shipping().map(|address| { + let details = address.address.as_ref(); let get_str = |opt: &Option<masking::Secret<String>>| opt.as_ref().map(|s| s.peek().to_owned()); let get_plain = |opt: &Option<String>| opt.clone(); - let country = details - .country - .as_ref() - .and_then(|c| payments_grpc::CountryAlpha2::from_str_name(&c.to_string())) - .ok_or_else(|| { - UnifiedConnectorServiceError::RequestEncodingFailedWithReason( - "Invalid country code".to_string(), - ) - }) - .attach_printable("Invalid country code") - .ok()? // Return None if invalid - .into(); - - Some(payments_grpc::Address { - first_name: get_str(&details.first_name), - last_name: get_str(&details.last_name), - line1: get_str(&details.line1), - line2: get_str(&details.line2), - line3: get_str(&details.line3), - city: get_plain(&details.city), - state: get_str(&details.state), - zip_code: get_str(&details.zip), - country_alpha2_code: Some(country), + let country = details.and_then(|details| { + details + .country + .as_ref() + .and_then(|c| payments_grpc::CountryAlpha2::from_str_name(&c.to_string())) + .map(|country| country.into()) + }); + + payments_grpc::Address { + first_name: get_str(&details.and_then(|d| d.first_name.clone())), + last_name: get_str(&details.and_then(|d| d.last_name.clone())), + line1: get_str(&details.and_then(|d| d.line1.clone())), + line2: get_str(&details.and_then(|d| d.line2.clone())), + line3: get_str(&details.and_then(|d| d.line3.clone())), + city: get_plain(&details.and_then(|d| d.city.clone())), + state: get_str(&details.and_then(|d| d.state.clone())), + zip_code: get_str(&details.and_then(|d| d.zip.clone())), + country_alpha2_code: country, email: address.email.as_ref().map(|e| e.peek().to_string()), phone_number: address .phone .as_ref() .and_then(|phone| phone.number.as_ref().map(|n| n.peek().to_string())), phone_country_code: address.phone.as_ref().and_then(|p| p.country_code.clone()), - }) + } }); - let billing = payment_address.get_payment_billing().and_then(|address| { - let details = address.address.as_ref()?; + let billing = payment_address.get_payment_billing().map(|address| { + let details = address.address.as_ref(); let get_str = |opt: &Option<masking::Secret<String>>| opt.as_ref().map(|s| s.peek().to_owned()); let get_plain = |opt: &Option<String>| opt.clone(); - let country = details - .country - .as_ref() - .and_then(|c| payments_grpc::CountryAlpha2::from_str_name(&c.to_string())) - .ok_or_else(|| { - UnifiedConnectorServiceError::RequestEncodingFailedWithReason( - "Invalid country code".to_string(), - ) - }) - .attach_printable("Invalid country code") - .ok()? // Return None if invalid - .into(); - - Some(payments_grpc::Address { - first_name: get_str(&details.first_name), - last_name: get_str(&details.last_name), - line1: get_str(&details.line1), - line2: get_str(&details.line2), - line3: get_str(&details.line3), - city: get_plain(&details.city), - state: get_str(&details.state), - zip_code: get_str(&details.zip), - country_alpha2_code: Some(country), + let country = details.and_then(|details| { + details + .country + .as_ref() + .and_then(|c| payments_grpc::CountryAlpha2::from_str_name(&c.to_string())) + .map(|country| country.into()) + }); + + payments_grpc::Address { + first_name: get_str(&details.and_then(|d| d.first_name.clone())), + last_name: get_str(&details.and_then(|d| d.last_name.clone())), + line1: get_str(&details.and_then(|d| d.line1.clone())), + line2: get_str(&details.and_then(|d| d.line2.clone())), + line3: get_str(&details.and_then(|d| d.line3.clone())), + city: get_plain(&details.and_then(|d| d.city.clone())), + state: get_str(&details.and_then(|d| d.state.clone())), + zip_code: get_str(&details.and_then(|d| d.zip.clone())), + country_alpha2_code: country, email: address.email.as_ref().map(|e| e.peek().to_string()), phone_number: address .phone .as_ref() .and_then(|phone| phone.number.as_ref().map(|n| n.peek().to_string())), phone_country_code: address.phone.as_ref().and_then(|p| p.country_code.clone()), - }) + } }); + let unified_payment_method_billing = + payment_address.get_payment_method_billing().map(|address| { + let details = address.address.as_ref(); + + let get_str = |opt: &Option<masking::Secret<String>>| { + opt.as_ref().map(|s| s.peek().to_owned()) + }; + + let get_plain = |opt: &Option<String>| opt.clone(); + + let country = details.and_then(|details| { + details + .country + .as_ref() + .and_then(|c| payments_grpc::CountryAlpha2::from_str_name(&c.to_string())) + .map(|country| country.into()) + }); + + payments_grpc::Address { + first_name: get_str(&details.and_then(|d| d.first_name.clone())), + last_name: get_str(&details.and_then(|d| d.last_name.clone())), + line1: get_str(&details.and_then(|d| d.line1.clone())), + line2: get_str(&details.and_then(|d| d.line2.clone())), + line3: get_str(&details.and_then(|d| d.line3.clone())), + city: get_plain(&details.and_then(|d| d.city.clone())), + state: get_str(&details.and_then(|d| d.state.clone())), + zip_code: get_str(&details.and_then(|d| d.zip.clone())), + country_alpha2_code: country, + email: address.email.as_ref().map(|e| e.peek().to_string()), + phone_number: address + .phone + .as_ref() + .and_then(|phone| phone.number.as_ref().map(|n| n.peek().to_string())), + phone_country_code: address.phone.as_ref().and_then(|p| p.country_code.clone()), + } + }); Ok(Self { - shipping_address: shipping, - billing_address: billing, + shipping_address: shipping.or(unified_payment_method_billing.clone()), + billing_address: billing.or(unified_payment_method_billing), }) } } @@ -391,6 +448,12 @@ impl ForeignTryFrom<payments_grpc::RedirectForm> for RedirectForm { Some(payments_grpc::redirect_form::FormType::Html(html)) => Ok(Self::Html { html_data: html.html_data, }), + Some(payments_grpc::redirect_form::FormType::Uri(_)) => Err( + UnifiedConnectorServiceError::RequestEncodingFailedWithReason( + "URI form type is not implemented".to_string(), + ) + .into(), + ), None => Err( UnifiedConnectorServiceError::RequestEncodingFailedWithReason( "Missing form type".to_string(), diff --git a/crates/router/src/types.rs b/crates/router/src/types.rs index a5740561c7f..57043bbcc05 100644 --- a/crates/router/src/types.rs +++ b/crates/router/src/types.rs @@ -514,9 +514,9 @@ pub struct PaymentMethodTokenResult { pub connector_response: Option<ConnectorResponseData>, } +#[derive(Clone)] pub struct CreateOrderResult { - pub create_order_result: Result<Option<String>, ErrorResponse>, - pub is_create_order_performed: bool, + pub create_order_result: Result<String, ErrorResponse>, } pub struct PspTokenResult {

2025-06-24T06:16:40Z

## Type of Change  - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ### Fixes #8440 ## Description  This PR implements **V2 UCS (Unified Connector Service) Integration** for authorization and synchronization flows, building upon the existing V1 UCS integration (PR#[8280](https://github.com/juspay/hyperswitch/pull/8280)), with enhanced V2 schema support according to updated gRPC contract. **Key Features Implemented:** 1. **Authorization Flow (Payments)**: Full V2 schema support for payment authorization 2. **PSync Flow**: Payment status synchronization through UCS V2 3. **UPI Payment Method**: Support for UPI Collect payment method 4. **Enhanced Response Handling**: Improved status mapping and error handling 5. **Address Transformation Fix**: Better handling of optional address fields **Key Changes from V1 to V2:** 1. **Updated gRPC Schema**: - Migrated from `PaymentsAuthorizeRequest` to `PaymentServiceAuthorizeRequest` - Added `PaymentServiceGetRequest` for PSync flow - Enhanced field structure for better type safety 2. **New Payment Methods**: - Added UPI Collect payment method support - Proper VPA ID extraction and handling 3. **Enhanced Transformers**: - Updated transformers for authorization and sync flows - Improved card details, address structure, and payment method handling - Fixed address transformation to handle None values gracefully 4. **V2 Flow Architecture**: - Refactored payment flow to separate UCS prerequisites and decision logic - Added PSync flow integration through UCS - Feature flag protection for clean V1/V2 separation 5. **Improved Response Handling**: - Enhanced response parsing with new identifier structure - Added support for more payment states (Started, AuthenticationSuccessful, Authorizing, etc.) - Better error handling and status mapping **V2 Architecture Flow:** V2 Payment Request → call_connector_service_prerequisites() → decide_unified_connector_service_call() → ├── UCS Available → V2 Transformers → gRPC Call → V2 Response Handling └── UCS Unavailable → Traditional Connector Flow (Fallback) V2 PSync Request → call_unified_connector_service() → ├── UCS Available → V2 PSync Transformer → gRPC Get Call → Status Response └── UCS Unavailable → Traditional Connector Sync Flow **Key Technical Improvements:** - **Refactored Payment Functions**: Split `call_connector_service()` into `call_connector_service_prerequisites()` and `decide_unified_connector_service_call()` for better separation of concerns - **Enhanced V2 Transformers**: Updated card data transformation, address structure, and authentication data handling - **PSync Flow Integration**: Added complete payment synchronization support through UCS - **UPI Payment Support**: Added UPI Collect payment method with VPA ID handling - **Improved Error Handling**: Better response parsing with new identifier structure - **Customer ID Support**: Added customer ID mapping in V2 transformer implementation - **Enhanced Authentication**: Added tenant_id and merchant_id to ConnectorAuthMetadata **Files Modified:** - `crates/router/Cargo.toml` - Updated rust-grpc-client dependency to main branch - `crates/router/src/core/payments.rs` - Refactored UCS integration with V2 prerequisite and decision functions - `crates/router/src/core/payments/flows/authorize_flow.rs` - Updated to use `PaymentServiceAuthorizeRequest` - `crates/router/src/core/payments/flows/psync_flow.rs` - Added UCS V2 support for payment synchronization - `crates/router/src/core/payments/transformers.rs` - Added V2 PaymentsAuthorizeData transformer implementation and customer_id support - `crates/router/src/core/unified_connector_service/` - Updated transformers and response handlers for V2 schema - `crates/router/src/core/unified_connector_service.rs` - Added UPI payment method support and enhanced response handling - `crates/router/src/core/unified_connector_service/transformers.rs` - Major updates for V2 gRPC schema compatibility - `crates/external_services/src/grpc_client/unified_connector_service.rs` - Added payment get operations support ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  **V2 UCS Integration Evolution:** This change builds upon the existing V1 UCS integration to support the updated V2 gRPC schema and enhanced payment flow architecture. Key motivations: **Schema Evolution:** - **Updated gRPC Contracts**: V2 introduces improved field structures for better type safety and extensibility - **Enhanced Data Models**: New card details structure, improved address handling, and better identifier management - **Backward Compatibility**: V2 implementation maintains compatibility while leveraging new schema features **Feature Additions:** - **PSync Flow Support**: Enables payment status synchronization through UCS, reducing direct connector calls - **UPI Payment Method**: Adds support for popular Indian payment method through unified interface - **Enhanced Status Handling**: More granular payment states for better payment lifecycle tracking **Architectural Improvements:** - **Separation of Concerns**: Split monolithic UCS functions into prerequisite preparation and decision logic phases - **Better Feature Flag Management**: Clean V1/V2 separation using `#[cfg(feature = "v2")]` prevents conflicts - **Enhanced Error Handling**: Improved response parsing and identifier handling for better reliability - **Maintainability**: Cleaner code structure for easier debugging and future enhancements **Business Value:** - **Future-Proofing**: V2 schema supports upcoming UCS enhancements and new payment flows - **Improved Reliability**: Better error handling and response parsing reduces failure rates - **Enhanced Developer Experience**: Cleaner API interfaces and better type safety - **Operational Excellence**: Maintains existing rollout controls while improving monitoring capabilities - **Broader Payment Support**: UPI integration opens up access to Indian market payment preferences ## How did you test it?  ### Manual Testing (HAPPY CASE) #### **V2 Payment Intent Creation (Adyen via UCS)** *Request:* ```bash curl --location 'http://localhost:8080/v2/payments/create-intent' \ --header 'api-key: dev_ymXSN8By3WESknjGnFyLVwDE4tK9v8ZjnkMZsKb2cM7KgjlzLfU1SOnJ63LsIrfR' \ --header 'Content-Type: application/json' \ --header 'x-profile-id: pro_2MBjeGslBsr2Lr7AoLvr' \ --header 'Authorization: api-key=dev_ymXSN8By3WESknjGnFyLVwDE4tK9v8ZjnkMZsKb2cM7KgjlzLfU1SOnJ63LsIrfR' \ --data '{ "amount_details": { "order_amount": 100, "currency": "USD" }, "capture_method": "automatic", "authentication_type": "no_three_ds", "customer_id": "12345_cus_0197abe38df57a408b928b4111ff5038", "billing": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" } }, "shipping": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" } } }' ``` *Response:* ```json { "id": "12345_pay_0197ac4f440c73c0b34c7050d248e483", "status": "requires_payment_method", "amount_details": { "order_amount": 100, "currency": "USD", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null }, "client_secret": "cs_0197ac4f4421744094d3abffdeae634c", "profile_id": "pro_2MBjeGslBsr2Lr7AoLvr", "merchant_reference_id": null, "routing_algorithm_id": null, "capture_method": "automatic", "authentication_type": "no_three_ds", "billing": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "joseph", "last_name": "Doe" }, "phone": null, "email": null }, "shipping": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "joseph", "last_name": "Doe" }, "phone": null, "email": null }, "customer_id": "12345_cus_0197abe38df57a408b928b4111ff5038", "customer_present": "present", "description": null, "return_url": null, "setup_future_usage": "on_session", "apply_mit_exemption": "Skip", "statement_descriptor": null, "order_details": null, "allowed_payment_method_types": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "payment_link_enabled": "Skip", "payment_link_config": null, "request_incremental_authorization": "default", "expires_on": "2025-06-26T13:11:05.403Z", "frm_metadata": null, "request_external_three_ds_authentication": "Skip" } ``` #### **V2 Payment Confirmation (Adyen via UCS)** *Request:* ```bash curl --location 'http://localhost:8080/v2/payments/12345_pay_0197ac4f440c73c0b34c7050d248e483/confirm-intent' \ --header 'x-client-secret: cs_0197ac4f4421744094d3abffdeae634c' \ --header 'x-profile-id: pro_2MBjeGslBsr2Lr7AoLvr' \ --header 'x-connected-merchant-id: cloth_seller_2_X5u3WjKKaUMMtPMYCNQM' \ --header 'Authorization: publishable-key=pk_dev_b78d41b686d54407842e55c1be492fce,client-secret=cs_0197ac4f4421744094d3abffdeae634c' \ --header 'Content-Type: application/json' \ --header 'api-key: pk_dev_b78d41b686d54407842e55c1be492fce' \ --data '{ "payment_method_type": "card", "payment_method_subtype": "credit", "payment_method_data": { "card": { "card_number": "4111111111111111", "card_exp_month": "03", "card_exp_year": "30", "card_holder_name": "Joseph Doe", "card_cvc": "737" } }, "browser_info": { "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8", "language": "nl-NL", "color_depth": 24, "screen_height": 723, "screen_width": 1536, "time_zone": 0, "java_enabled": true, "java_script_enabled": true } }' ``` *Response:* ```json { "id": "12345_pay_0197ac4f440c73c0b34c7050d248e483", "status": "succeeded", "amount": { "order_amount": 100, "currency": "USD", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null, "net_amount": 100, "amount_to_capture": null, "amount_capturable": 0, "amount_captured": 100 }, "customer_id": "12345_cus_0197abe38df57a408b928b4111ff5038", "connector": "adyen", "created": "2025-06-26T12:56:05.403Z", "payment_method_data": { "billing": null }, "payment_method_type": "card", "payment_method_subtype": "credit", "connector_transaction_id": "12345_pay_0197ac4f440c73c0b34c7050d248e483", "connector_reference_id": null, "merchant_connector_id": "mca_YUhrsoeHfh0EQJE6Zqut", "browser_info": null, "error": null, "shipping": null, "billing": null, "attempts": null, "connector_token_details": null, "payment_method_id": null, "next_action": null, "return_url": "https://google.com/success", "authentication_type": "no_three_ds", "authentication_type_applied": "no_three_ds", "is_iframe_redirection_enabled": null, "merchant_reference_id": null } ``` #### **V2 Payment Intent Creation (Adyen via Traditional Connector Flow)** *Request:* ```bash curl --location 'http://localhost:8080/v2/payments/create-intent' \ --header 'api-key: dev_ymXSN8By3WESknjGnFyLVwDE4tK9v8ZjnkMZsKb2cM7KgjlzLfU1SOnJ63LsIrfR' \ --header 'Content-Type: application/json' \ --header 'x-profile-id: pro_2MBjeGslBsr2Lr7AoLvr' \ --header 'Authorization: api-key=dev_ymXSN8By3WESknjGnFyLVwDE4tK9v8ZjnkMZsKb2cM7KgjlzLfU1SOnJ63LsIrfR' \ --data '{ "amount_details": { "order_amount": 100, "currency": "USD" }, "capture_method": "automatic", "authentication_type": "no_three_ds", "customer_id": "12345_cus_0197abe38df57a408b928b4111ff5038", "billing": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" } }, "shipping": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" } } }' ``` *Response:* ```json { "id": "12345_pay_0197ac4c67657d81a796bc358b364d04", "status": "requires_payment_method", "amount_details": { "order_amount": 100, "currency": "USD", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null }, "client_secret": "cs_0197ac4c67ac7731907d52f9dac88996", "profile_id": "pro_2MBjeGslBsr2Lr7AoLvr", "merchant_reference_id": null, "routing_algorithm_id": null, "capture_method": "automatic", "authentication_type": "no_three_ds", "billing": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "joseph", "last_name": "Doe" }, "phone": null, "email": null }, "shipping": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "joseph", "last_name": "Doe" }, "phone": null, "email": null }, "customer_id": "12345_cus_0197abe38df57a408b928b4111ff5038", "customer_present": "present", "description": null, "return_url": null, "setup_future_usage": "on_session", "apply_mit_exemption": "Skip", "statement_descriptor": null, "order_details": null, "allowed_payment_method_types": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "payment_link_enabled": "Skip", "payment_link_config": null, "request_incremental_authorization": "default", "expires_on": "2025-06-26T13:07:57.887Z", "frm_metadata": null, "request_external_three_ds_authentication": "Skip" } ``` #### **V2 Payment Confirmation (Adyen via Traditional Connector Flow)** *Request:* ```bash curl --location 'http://localhost:8080/v2/payments/12345_pay_0197ac4c67657d81a796bc358b364d04/confirm-intent' \ --header 'x-client-secret: cs_0197ac4c67ac7731907d52f9dac88996' \ --header 'x-profile-id: pro_2MBjeGslBsr2Lr7AoLvr' \ --header 'x-connected-merchant-id: cloth_seller_2_X5u3WjKKaUMMtPMYCNQM' \ --header 'Authorization: publishable-key=pk_dev_b78d41b686d54407842e55c1be492fce,client-secret=cs_0197ac4c67ac7731907d52f9dac88996' \ --header 'Content-Type: application/json' \ --header 'api-key: pk_dev_b78d41b686d54407842e55c1be492fce' \ --data '{ "payment_method_type": "card", "payment_method_subtype": "credit", "payment_method_data": { "card": { "card_number": "4111111111111111", "card_exp_month": "03", "card_exp_year": "30", "card_holder_name": "Joseph Doe", "card_cvc": "737" } }, "browser_info": { "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8", "language": "nl-NL", "color_depth": 24, "screen_height": 723, "screen_width": 1536, "time_zone": 0, "java_enabled": true, "java_script_enabled": true } }' ``` *Response:* ```json { "id": "12345_pay_0197ac4c67657d81a796bc358b364d04", "status": "succeeded", "amount": { "order_amount": 100, "currency": "USD", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null, "net_amount": 100, "amount_to_capture": null, "amount_capturable": 0, "amount_captured": 100 }, "customer_id": "12345_cus_0197abe38df57a408b928b4111ff5038", "connector": "adyen", "created": "2025-06-26T12:52:57.887Z", "payment_method_data": { "billing": null }, "payment_method_type": "card", "payment_method_subtype": "credit", "connector_transaction_id": "K2LGMPJFQZ9TPM75", "connector_reference_id": null, "merchant_connector_id": "mca_YUhrsoeHfh0EQJE6Zqut", "browser_info": null, "error": null, "shipping": null, "billing": null, "attempts": null, "connector_token_details": null, "payment_method_id": null, "next_action": null, "return_url": "https://google.com/success", "authentication_type": "no_three_ds", "authentication_type_applied": "no_three_ds", "is_iframe_redirection_enabled": null, "merchant_reference_id": null } ``` ### Manual Testing (FAILURE CASE) #### **V2 Payment Intent Creation (Adyen via UCS)** *Request:* ```bash curl --location 'http://localhost:8080/v2/payments/create-intent' \ --header 'api-key: dev_ymXSN8By3WESknjGnFyLVwDE4tK9v8ZjnkMZsKb2cM7KgjlzLfU1SOnJ63LsIrfR' \ --header 'Content-Type: application/json' \ --header 'x-profile-id: pro_2MBjeGslBsr2Lr7AoLvr' \ --header 'Authorization: api-key=dev_ymXSN8By3WESknjGnFyLVwDE4tK9v8ZjnkMZsKb2cM7KgjlzLfU1SOnJ63LsIrfR' \ --data '{ "amount_details": { "order_amount": 100, "currency": "USD" }, "capture_method": "automatic", "authentication_type": "no_three_ds", "customer_id": "12345_cus_0197abe38df57a408b928b4111ff5038", "billing": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" } }, "shipping": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" } } }' ``` *Response:* ```json { "id": "12345_pay_0197ac52cee5796099a0ae352092a707", "status": "requires_payment_method", "amount_details": { "order_amount": 100, "currency": "USD", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null }, "client_secret": "cs_0197ac52cefb77e2be6097f5d54b1152", "profile_id": "pro_2MBjeGslBsr2Lr7AoLvr", "merchant_reference_id": null, "routing_algorithm_id": null, "capture_method": "automatic", "authentication_type": "no_three_ds", "billing": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "joseph", "last_name": "Doe" }, "phone": null, "email": null }, "shipping": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "joseph", "last_name": "Doe" }, "phone": null, "email": null }, "customer_id": "12345_cus_0197abe38df57a408b928b4111ff5038", "customer_present": "present", "description": null, "return_url": null, "setup_future_usage": "on_session", "apply_mit_exemption": "Skip", "statement_descriptor": null, "order_details": null, "allowed_payment_method_types": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "payment_link_enabled": "Skip", "payment_link_config": null, "request_incremental_authorization": "default", "expires_on": "2025-06-26T13:14:57.559Z", "frm_metadata": null, "request_external_three_ds_authentication": "Skip" } ``` #### **V2 Payment Confirmation (Adyen via UCS)** *Request:* ```bash curl --location 'http://localhost:8080/v2/payments/12345_pay_0197ac52cee5796099a0ae352092a707/confirm-intent' \ --header 'x-client-secret: cs_0197ac52cefb77e2be6097f5d54b1152' \ --header 'x-profile-id: pro_2MBjeGslBsr2Lr7AoLvr' \ --header 'x-connected-merchant-id: cloth_seller_2_X5u3WjKKaUMMtPMYCNQM' \ --header 'Authorization: publishable-key=pk_dev_b78d41b686d54407842e55c1be492fce,client-secret=cs_0197ac52cefb77e2be6097f5d54b1152' \ --header 'Content-Type: application/json' \ --header 'api-key: pk_dev_b78d41b686d54407842e55c1be492fce' \ --data '{ "payment_method_type": "card", "payment_method_subtype": "credit", "payment_method_data": { "card": { "card_number": "4111111111111111", "card_exp_month": "03", "card_exp_year": "30", "card_holder_name": "Joseph Doe", "card_cvc": "730" } }, "browser_info": { "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8", "language": "nl-NL", "color_depth": 24, "screen_height": 723, "screen_width": 1536, "time_zone": 0, "java_enabled": true, "java_script_enabled": true } }' ``` *Response:* ```json { "id": "12345_pay_0197ac52cee5796099a0ae352092a707", "status": "failed", "amount": { "order_amount": 100, "currency": "USD", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null, "net_amount": 100, "amount_to_capture": null, "amount_capturable": 0, "amount_captured": 0 }, "customer_id": "12345_cus_0197abe38df57a408b928b4111ff5038", "connector": "adyen", "created": "2025-06-26T12:59:57.559Z", "payment_method_data": { "billing": null }, "payment_method_type": "card", "payment_method_subtype": "credit", "connector_transaction_id": "G4QT66CH8WCFHJ75", "connector_reference_id": null, "merchant_connector_id": "mca_YUhrsoeHfh0EQJE6Zqut", "browser_info": null, "error": { "code": "24", "message": "CVC Declined", "unified_code": null, "unified_message": null, "network_advice_code": null, "network_decline_code": null, "network_error_message": null }, "shipping": null, "billing": null, "attempts": null, "connector_token_details": null, "payment_method_id": null, "next_action": null, "return_url": "https://google.com/success", "authentication_type": "no_three_ds", "authentication_type_applied": "no_three_ds", "is_iframe_redirection_enabled": null, "merchant_reference_id": null } ``` #### **V2 Payment Intent Creation (Adyen via Traditional Connector Flow)** *Request:* ```bash curl --location 'http://localhost:8080/v2/payments/create-intent' \ --header 'api-key: dev_ymXSN8By3WESknjGnFyLVwDE4tK9v8ZjnkMZsKb2cM7KgjlzLfU1SOnJ63LsIrfR' \ --header 'Content-Type: application/json' \ --header 'x-profile-id: pro_2MBjeGslBsr2Lr7AoLvr' \ --header 'Authorization: api-key=dev_ymXSN8By3WESknjGnFyLVwDE4tK9v8ZjnkMZsKb2cM7KgjlzLfU1SOnJ63LsIrfR' \ --data '{ "amount_details": { "order_amount": 100, "currency": "USD" }, "capture_method": "automatic", "authentication_type": "no_three_ds", "customer_id": "12345_cus_0197abe38df57a408b928b4111ff5038", "billing": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" } }, "shipping": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" } } }' ``` *Response:* ```json { "id": "12345_pay_0197ac5574b37982b150606298590cfb", "status": "requires_payment_method", "amount_details": { "order_amount": 100, "currency": "USD", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null }, "client_secret": "cs_0197ac5574c57c50b773a7230ffffe69", "profile_id": "pro_2MBjeGslBsr2Lr7AoLvr", "merchant_reference_id": null, "routing_algorithm_id": null, "capture_method": "automatic", "authentication_type": "no_three_ds", "billing": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "joseph", "last_name": "Doe" }, "phone": null, "email": null }, "shipping": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "joseph", "last_name": "Doe" }, "phone": null, "email": null }, "customer_id": "12345_cus_0197abe38df57a408b928b4111ff5038", "customer_present": "present", "description": null, "return_url": null, "setup_future_usage": "on_session", "apply_mit_exemption": "Skip", "statement_descriptor": null, "order_details": null, "allowed_payment_method_types": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "payment_link_enabled": "Skip", "payment_link_config": null, "request_incremental_authorization": "default", "expires_on": "2025-06-26T13:17:51.072Z", "frm_metadata": null, "request_external_three_ds_authentication": "Skip" } ``` #### **V2 Payment Confirmation (Adyen via Traditional Connector Flow)** *Request:* ```bash curl --location 'http://localhost:8080/v2/payments/12345_pay_0197ac5574b37982b150606298590cfb/confirm-intent' \ --header 'x-client-secret: cs_0197ac5574c57c50b773a7230ffffe69' \ --header 'x-profile-id: pro_2MBjeGslBsr2Lr7AoLvr' \ --header 'x-connected-merchant-id: cloth_seller_2_X5u3WjKKaUMMtPMYCNQM' \ --header 'Authorization: publishable-key=pk_dev_b78d41b686d54407842e55c1be492fce,client-secret=cs_0197ac5574c57c50b773a7230ffffe69' \ --header 'Content-Type: application/json' \ --header 'api-key: pk_dev_b78d41b686d54407842e55c1be492fce' \ --data '{ "payment_method_type": "card", "payment_method_subtype": "credit", "payment_method_data": { "card": { "card_number": "4111111111111111", "card_exp_month": "03", "card_exp_year": "30", "card_holder_name": "Joseph Doe", "card_cvc": "730" } }, "browser_info": { "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8", "language": "nl-NL", "color_depth": 24, "screen_height": 723, "screen_width": 1536, "time_zone": 0, "java_enabled": true, "java_script_enabled": true } }' ``` *Response:* ```json { "id": "12345_pay_0197ac5574b37982b150606298590cfb", "status": "failed", "amount": { "order_amount": 100, "currency": "USD", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null, "net_amount": 100, "amount_to_capture": null, "amount_capturable": 0, "amount_captured": 0 }, "customer_id": "12345_cus_0197abe38df57a408b928b4111ff5038", "connector": "adyen", "created": "2025-06-26T13:02:51.072Z", "payment_method_data": { "billing": null }, "payment_method_type": "card", "payment_method_subtype": "credit", "connector_transaction_id": "DXZQPDL34QGTPM75", "connector_reference_id": null, "merchant_connector_id": "mca_YUhrsoeHfh0EQJE6Zqut", "browser_info": null, "error": { "code": "24", "message": "CVC Declined", "unified_code": null, "unified_message": null, "network_advice_code": null, "network_decline_code": null, "network_error_message": "DECLINED CVC Incorrect" }, "shipping": null, "billing": null, "attempts": null, "connector_token_details": null, "payment_method_id": null, "next_action": null, "return_url": "https://google.com/success", "authentication_type": "no_three_ds", "authentication_type_applied": "no_three_ds", "is_iframe_redirection_enabled": null, "merchant_reference_id": null } ``` ###UPI Collect payment through UCS *Request* ```bash curl --location 'http://localhost:8080/v2/payments' \ --header 'x-profile-id: pro_2MBjeGslBsr2Lr7AoLvr' \ --header 'x-merchant-id: cloth_seller_2_H3Oh1h4iu0wg8BWGvMzu' \ --header 'x-tenant-id: public' \ --header 'Content-Type: application/json' \ --header 'api-key: dev_ymXSN8By3WESknjGnFyLVwDE4tK9v8ZjnkMZsKb2cM7KgjlzLfU1SOnJ63LsIrfR' \ --data-raw '{ "amount_details": { "currency": "INR", "order_amount": 1000 }, "merchant_connector_details": { "connector_name": "razorpay", "merchant_connector_creds": { "auth_type": "SignatureKey", "key1": "*************************", "api_key": "********************", "api_secret": "*******************" } }, "merchant_reference_id": "12345_pay_01970c787911751013554", "payment_method_data": { "upi": { "upi_collect": { "vpa_id": "failure@razorpay" } }, "billing": { "phone": { "number": "8800574493", "country_code": "+91" }, "email": "[email protected]" } }, "payment_method_subtype": "upi_collect", "payment_method_type": "upi" }' ``` *Response* ```json { "id": "12345_pay_0197ceee564473609731b2ab35827cc7", "status": "processing", "amount": { "order_amount": 1000, "currency": "INR", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null, "net_amount": 1000, "amount_to_capture": null, "amount_capturable": 0, "amount_captured": null }, "customer_id": null, "connector": "razorpay", "created": "2025-07-03T06:16:55.621Z", "payment_method_data": { "billing": { "address": null, "phone": { "number": "8800574493", "country_code": "+91" }, "email": "[email protected]" } }, "payment_method_type": "upi", "payment_method_subtype": "upi_collect", "connector_transaction_id": "pay_QoUbCBtcPCfaWY", "connector_reference_id": "order_QoUbBDL6PKnuZY", "merchant_connector_id": null, "browser_info": null, "error": null, "shipping": null, "billing": null, "attempts": null, "connector_token_details": null, "payment_method_id": null, "next_action": null, "return_url": "https://google.com/success", "authentication_type": null, "authentication_type_applied": "no_three_ds", "is_iframe_redirection_enabled": null, "merchant_reference_id": "12345_pay_01970c787911751013554", "whole_connector_response": null } ``` ### PSync through UCS *Request* ```bash curl --location 'http://localhost:8080/v2/payments/12345_pay_0197ceee564473609731b2ab35827cc7' \ --header 'x-profile-id: pro_2MBjeGslBsr2Lr7AoLvr' \ --header 'x-merchant-id: cloth_seller_2_H3Oh1h4iu0wg8BWGvMzu' \ --header 'x-tenant-id: public' \ --header 'Content-Type: application/json' \ --header 'api-key: dev_ymXSN8By3WESknjGnFyLVwDE4tK9v8ZjnkMZsKb2cM7KgjlzLfU1SOnJ63LsIrfR' \ --data '{ "merchant_connector_details": { "connector_name": "razorpay", "merchant_connector_creds": { "auth_type": "SignatureKey", "key1": "**************", "api_key": "********************", "api_secret": "******************" } }, "force_sync": true }'``` *Response* ```json { "id": "12345_pay_0197ceee564473609731b2ab35827cc7", "status": "failed", "amount": { "order_amount": 1000, "currency": "INR", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null, "net_amount": 1000, "amount_to_capture": null, "amount_capturable": 0, "amount_captured": 0 }, "customer_id": null, "connector": "razorpay", "created": "2025-07-03T06:16:55.621Z", "payment_method_data": { "billing": { "address": null, "phone": { "number": "8800574493", "country_code": "+91" }, "email": "[email protected]" } }, "payment_method_type": "upi", "payment_method_subtype": "upi_collect", "connector_transaction_id": "pay_QoUbCBtcPCfaWY", "connector_reference_id": "order_QoUbBDL6PKnuZY", "merchant_connector_id": null, "browser_info": null, "error": { "code": "", "message": "", "unified_code": null, "unified_message": null, "network_advice_code": null, "network_decline_code": null, "network_error_message": null }, "shipping": null, "billing": null, "attempts": null, "connector_token_details": null, "payment_method_id": null, "next_action": null, "return_url": "https://google.com/success", "authentication_type": null, "authentication_type_applied": null, "is_iframe_redirection_enabled": null, "merchant_reference_id": "12345_pay_01970c787911751013554", "whole_connector_response": null } ``` **V2 Schema Testing:** - V2 gRPC schema compatibility verification - `PaymentServiceAuthorizeRequest` field mapping validation - Enhanced card details and address structure testing - Response identifier parsing with new structure **Fallback Testing:** - UCS service unavailable → Automatic fallback to traditional connector flow - Invalid authentication → Fallback with error logging - V2 transformer errors → Graceful degradation to V1 flow - Rollout percentage = 0% → Traditional flow used - Rollout percentage = 100% → UCS V2 flow used ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

b1c9be1600dbd897c32adcc2d8b98e77ec67c516

juspay/hyperswitch

juspay__hyperswitch-8437

Bug: [REFACTOR] allow option for skipping billing details during batched data migration **Problem Statement** Currently, `/migrate-batch` API has below mandatory parameters ```rust { pub customer_id: id_type::CustomerId, pub nick_name: masking::Secret<String>, pub card_number_masked: masking::Secret<String>, pub card_expiry_month: masking::Secret<String>, pub card_expiry_year: masking::Secret<String>, pub billing_address_zip: masking::Secret<String>, pub billing_address_state: masking::Secret<String>, pub billing_address_first_name: masking::Secret<String>, pub billing_address_last_name: masking::Secret<String>, pub billing_address_city: String, pub billing_address_line1: masking::Secret<String>, } ``` Billing details are mandatory but there can be use cases when these details are not be required by the underlying connector during payments. For such cases, these details become a blocker for using the migrate API. These can be made optional. **Proposed Solution** Fields related to billing details can be made `Optional`

diff --git a/crates/api_models/src/payment_methods.rs b/crates/api_models/src/payment_methods.rs index 5ecd2f71ef7..25b583f5dc4 100644 --- a/crates/api_models/src/payment_methods.rs +++ b/crates/api_models/src/payment_methods.rs @@ -2481,7 +2481,7 @@ pub struct PaymentMethodRecord { pub merchant_id: Option<id_type::MerchantId>, pub payment_method: Option<api_enums::PaymentMethod>, pub payment_method_type: Option<api_enums::PaymentMethodType>, - pub nick_name: masking::Secret<String>, + pub nick_name: Option<masking::Secret<String>>, pub payment_instrument_id: Option<masking::Secret<String>>, pub connector_customer_id: Option<String>, pub card_number_masked: masking::Secret<String>, @@ -2489,13 +2489,13 @@ pub struct PaymentMethodRecord { pub card_expiry_year: masking::Secret<String>, pub card_scheme: Option<String>, pub original_transaction_id: Option<String>, - pub billing_address_zip: masking::Secret<String>, - pub billing_address_state: masking::Secret<String>, - pub billing_address_first_name: masking::Secret<String>, - pub billing_address_last_name: masking::Secret<String>, - pub billing_address_city: String, + pub billing_address_zip: Option<masking::Secret<String>>, + pub billing_address_state: Option<masking::Secret<String>>, + pub billing_address_first_name: Option<masking::Secret<String>>, + pub billing_address_last_name: Option<masking::Secret<String>>, + pub billing_address_city: Option<String>, pub billing_address_country: Option<api_enums::CountryAlpha2>, - pub billing_address_line1: masking::Secret<String>, + pub billing_address_line1: Option<masking::Secret<String>>, pub billing_address_line2: Option<masking::Secret<String>>, pub billing_address_line3: Option<masking::Secret<String>>, pub raw_card_number: Option<masking::Secret<String>>, @@ -2548,6 +2548,57 @@ pub enum MigrationStatus { Failed, } +impl PaymentMethodRecord { + fn create_address(&self) -> Option<payments::AddressDetails> { + if self.billing_address_first_name.is_some() + && self.billing_address_line1.is_some() + && self.billing_address_zip.is_some() + && self.billing_address_city.is_some() + && self.billing_address_country.is_some() + { + Some(payments::AddressDetails { + city: self.billing_address_city.clone(), + country: self.billing_address_country, + line1: self.billing_address_line1.clone(), + line2: self.billing_address_line2.clone(), + state: self.billing_address_state.clone(), + line3: self.billing_address_line3.clone(), + zip: self.billing_address_zip.clone(), + first_name: self.billing_address_first_name.clone(), + last_name: self.billing_address_last_name.clone(), + }) + } else { + None + } + } + + fn create_phone(&self) -> Option<payments::PhoneDetails> { + if self.phone.is_some() || self.phone_country_code.is_some() { + Some(payments::PhoneDetails { + number: self.phone.clone(), + country_code: self.phone_country_code.clone(), + }) + } else { + None + } + } + + fn create_billing(&self) -> Option<payments::Address> { + let address = self.create_address(); + let phone = self.create_phone(); + + if address.is_some() || phone.is_some() || self.email.is_some() { + Some(payments::Address { + address, + phone, + email: self.email.clone(), + }) + } else { + None + } + } +} + #[cfg(feature = "v1")] type PaymentMethodMigrationResponseType = ( Result<PaymentMethodMigrateResponse, String>, @@ -2600,6 +2651,7 @@ impl ), ) -> Result<Self, Self::Error> { let (record, merchant_id, mca_id) = item; + let billing = record.create_billing(); // if payment instrument id is present then only construct this let connector_mandate_details = if record.payment_instrument_id.is_some() { @@ -2631,7 +2683,7 @@ impl card_type: None, card_issuer: None, card_issuing_country: None, - nick_name: Some(record.nick_name.clone()), + nick_name: record.nick_name.clone(), }), network_token: Some(MigrateNetworkTokenDetail { network_token_data: MigrateNetworkTokenData { @@ -2639,7 +2691,7 @@ impl network_token_exp_month: record.network_token_expiry_month.unwrap_or_default(), network_token_exp_year: record.network_token_expiry_year.unwrap_or_default(), card_holder_name: record.name, - nick_name: Some(record.nick_name.clone()), + nick_name: record.nick_name.clone(), card_issuing_country: None, card_network: None, card_issuer: None, @@ -2652,24 +2704,7 @@ impl payment_method: record.payment_method, payment_method_type: record.payment_method_type, payment_method_issuer: None, - billing: Some(payments::Address { - address: Some(payments::AddressDetails { - city: Some(record.billing_address_city), - country: record.billing_address_country, - line1: Some(record.billing_address_line1), - line2: record.billing_address_line2, - state: Some(record.billing_address_state), - line3: record.billing_address_line3, - zip: Some(record.billing_address_zip), - first_name: Some(record.billing_address_first_name), - last_name: Some(record.billing_address_last_name), - }), - phone: Some(payments::PhoneDetails { - number: record.phone, - country_code: record.phone_country_code, - }), - email: record.email, - }), + billing, connector_mandate_details: connector_mandate_details.map( |payments_mandate_reference| { CommonMandateReference::from(payments_mandate_reference) @@ -2683,7 +2718,7 @@ impl #[cfg(feature = "payouts")] wallet: None, payment_method_data: None, - network_transaction_id: record.original_transaction_id, + network_transaction_id: record.original_transaction_id.clone(), }) } } @@ -2702,15 +2737,15 @@ impl From<(PaymentMethodRecord, id_type::MerchantId)> for PaymentMethodCustomerM description: None, phone_country_code: record.phone_country_code, address: Some(payments::AddressDetails { - city: Some(record.billing_address_city), + city: record.billing_address_city, country: record.billing_address_country, - line1: Some(record.billing_address_line1), + line1: record.billing_address_line1, line2: record.billing_address_line2, - state: Some(record.billing_address_state), + state: record.billing_address_state, line3: record.billing_address_line3, - zip: Some(record.billing_address_zip), - first_name: Some(record.billing_address_first_name), - last_name: Some(record.billing_address_last_name), + zip: record.billing_address_zip, + first_name: record.billing_address_first_name, + last_name: record.billing_address_last_name, }), metadata: None, }, diff --git a/crates/payment_methods/src/core/migration/payment_methods.rs b/crates/payment_methods/src/core/migration/payment_methods.rs index 10808f08a25..5c30698f615 100644 --- a/crates/payment_methods/src/core/migration/payment_methods.rs +++ b/crates/payment_methods/src/core/migration/payment_methods.rs @@ -184,7 +184,7 @@ pub async fn populate_bin_details_for_masked_card( card_number.peek(), ) .change_context(errors::ApiErrorResponse::InvalidRequestData { - message: "Invalid card number".to_string(), + message: "Invalid masked card number".to_string(), })?; let card_bin_details = if card_details.card_issuer.is_some() @@ -223,7 +223,7 @@ impl let (card_isin, last4_digits) = get_card_bin_and_last4_digits_for_masked_card(card_details.card_number.peek()) .change_context(errors::ApiErrorResponse::InvalidRequestData { - message: "Invalid card number".to_string(), + message: "Invalid masked card number".to_string(), })?; if let Some(card_bin_info) = card_info { Ok(Self { @@ -298,7 +298,7 @@ impl let (card_isin, last4_digits) = get_card_bin_and_last4_digits_for_masked_card(card_details.card_number.peek()) .change_context(errors::ApiErrorResponse::InvalidRequestData { - message: "Invalid card number".to_string(), + message: "Invalid masked card number".to_string(), })?; if let Some(card_bin_info) = card_info { Ok(Self {

2025-06-23T19:23:01Z

## Type of Change  - [ ] Bugfix - [ ] New feature - [ ] Enhancement - [x] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description This PR includes changes to make billing details related fields optional during batched operation of data migration. ### Additional Changes - [x] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context Allows merchants who use connectors which does not mandate address fields to be present during a payment txn to be able to migrate their data. Billing details will not be mandated during batched operation of data migration. ## How did you test it? 1. Create MCA <details> <summary>2. Run batch migration</summary> cURL curl --location --request POST 'http://localhost:8080/payment_methods/migrate-batch' \ --header 'api-key: test_admin' \ --form 'merchant_id="merchant_1750764063"' \ --form 'merchant_connector_id="mca_F0qqizsBSwbZ77gQYLRs"' \ --form 'file=@"sample.csv"' Response [{"line_number":1,"payment_method_id":"pm_wY7TUBMPZZISgu2Zf74M","payment_method":"card","payment_method_type":"debit","customer_id":"45CC60D1F2283097BB1DE41A2636414445908518D50B8B4CDC57959CD7FB4539","migration_status":"Success","card_number_masked":"4360000 xxxx 0005","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":2,"payment_method_id":"pm_gNTfSTNVhvlURJPnsiYQ","payment_method":"card","payment_method_type":"credit","customer_id":"782BC898951D910C1A99DA69A4E4FAD6CEE53AB9311FA2C552028DA89428DB7F","migration_status":"Success","card_number_masked":"4111111 xxxx 1111","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":3,"payment_method_id":"pm_EeJ2hgF3OmHgTFEfe58X","payment_method":"card","payment_method_type":"credit","customer_id":"C81CC958611A803D9CC3E2E7818A1691943E3143E6DF603A7F45E55BA7629938","migration_status":"Success","card_number_masked":"222300 xxxx 0010","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":4,"payment_method_id":"pm_p1ckEakoWB12EtHYtjtm","payment_method":"card","payment_method_type":"credit","customer_id":"9F4BB23B3ED615753F5A27CF6D75274713B30A67ACFEA7CE44B058F6AC044E33","migration_status":"Success","card_number_masked":"5555555 xxxx 4444","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":5,"payment_method_id":"pm_0HrpkOfnLuIPSJiU3fdZ","payment_method":"card","payment_method_type":"debit","customer_id":"B22BFDD8BB5840B5F6EE0026A430B72359C50E631C7A2D9D2BC014BDB1EB212C","migration_status":"Success","card_number_masked":"222300 xxxx 0010","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":6,"payment_method_id":"pm_iOtdYdcOErhUz4bXmZgX","payment_method":"card","payment_method_type":"credit","customer_id":"EECB88827D346EDCFB9AB7302B0C387C42FB5EBAD87EC0E4FA4301F6148BB22B","migration_status":"Success","card_number_masked":"557700 xxxx 0004","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":7,"payment_method_id":"pm_JnzwASYJStJUQ02LEcqf","payment_method":"card","payment_method_type":"credit","customer_id":"C81CC958611A803D9CC3E2E7818A1691943E3143E6DF603A7F45E55BA7629938","migration_status":"Success","card_number_masked":"222241 xxxx 0002","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":8,"payment_method_id":"pm_CJsKWoBsOqkRlikFMO2t","payment_method":"card","payment_method_type":"credit","customer_id":"66C96C852E423B701EF06C5109C40D72E77B4C7F4CDD108AD4FCC3DCCC38AB2F","migration_status":"Success","card_number_masked":"513029 xxxx 0009","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":9,"payment_method_id":"pm_z0jFnOfXn1andQp9qbXd","payment_method":"card","payment_method_type":"credit","customer_id":"C81CC958611A803D9CC3E2E7818A1691943E3143E6DF603A7F45E55BA7629938","migration_status":"Success","card_number_masked":"510322 xxxx 9245","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":10,"payment_method_id":"pm_4lJAPwuf8iepQCWKDub1","payment_method":"card","payment_method_type":"credit","customer_id":"C81CC958611A803D9CC3E2E7818A1691943E3143E6DF603A7F45E55BA7629938","migration_status":"Success","card_number_masked":"222241 xxxx 0002","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":11,"payment_method_id":"pm_J1ZMlj5lzHyf2P5Lid6S","payment_method":"card","payment_method_type":"credit","customer_id":"ADE2795AC3C88525528F0DB95677BE9DB27E792850B1A67CA654BFFAEB31AFE3","migration_status":"Success","card_number_masked":"222241 xxxx 0018","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":12,"payment_method_id":"pm_zySRb0JCNxcCMH2Ubocc","payment_method":"card","payment_method_type":"credit","customer_id":"ADE2795AC3C88525528F0DB95677BE9DB27E792850B1A67CA654BFFAEB31AFE3","migration_status":"Success","card_number_masked":"411111 xxxx 1111","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":13,"payment_method_id":"pm_M9wKyu4kEYNcHIjyrVfI","payment_method":"card","payment_method_type":"credit","customer_id":"D83D0437F8883C26C75C04756D95E21B90877020743EA1C1CC49883A90E8DF97","migration_status":"Success","card_number_masked":"411111 xxxx 1111","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":14,"payment_method_id":"pm_RDiPAalAZkCj1uOqKYSb","payment_method":"card","payment_method_type":"credit","customer_id":"ADE2795AC3C88525528F0DB95677BE9DB27E792850B1A67CA654BFFAEB31AFE3","migration_status":"Success","card_number_masked":"624303 xxxx 0001","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":15,"payment_method_id":"pm_0XTr9lrG6LGNl9d4iFPR","payment_method":"card","payment_method_type":"debit","customer_id":"ADE2795AC3C88525528F0DB95677BE9DB27E792850B1A67CA654BFFAEB31AFE3","migration_status":"Success","card_number_masked":"222241 xxxx 0002","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":16,"payment_method_id":"pm_aUtJIRDcCH7CIwJ2hQEk","payment_method":"card","payment_method_type":"credit","customer_id":"D83D0437F8883C26C75C04756D95E21B90877020743EA1C1CC49883A90E8DF97","migration_status":"Success","card_number_masked":"817199 xxxx 0000","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":17,"payment_method_id":"pm_THz5Ds8VHAgyJPPOA4GY","payment_method":"card","payment_method_type":"credit","customer_id":"D83D0437F8883C26C75C04756D95E21B90877020743EA1C1CC49883A90E8DF97","migration_status":"Success","card_number_masked":"464646 xxxx 4644","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":18,"payment_method_id":"pm_l82mYW4tMsRkJF4hq5fn","payment_method":"card","payment_method_type":"credit","customer_id":"ADE2795AC3C88525528F0DB95677BE9DB27E792850B1A67CA654BFFAEB31AFE3","migration_status":"Success","card_number_masked":"222240 xxxx 0007","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":19,"payment_method_id":"pm_E8fkAc9RHknoPmnYFBOa","payment_method":"card","payment_method_type":"debit","customer_id":"ADE2795AC3C88525528F0DB95677BE9DB27E792850B1A67CA654BFFAEB31AFE3","migration_status":"Success","card_number_masked":"400006 xxxx 0006","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":20,"payment_method_id":"pm_TEEJO7DdZTkl55PH8P1T","payment_method":"card","payment_method_type":"credit","customer_id":"D83D0437F8883C26C75C04756D95E21B90877020743EA1C1CC49883A90E8DF97","migration_status":"Success","card_number_masked":"497794 xxxx 9497","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":21,"payment_method_id":"pm_3gTcA4MJsTjasj2XlJs2","payment_method":"card","payment_method_type":"credit","customer_id":"C81CC958611A803D9CC3E2E7818A1691943E3143E6DF603A7F45E55BA7629938","migration_status":"Success","card_number_masked":"436000 xxxx 0005","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":22,"payment_method_id":"pm_GzUYGU3GpOXOIkWFRkM0","payment_method":"card","payment_method_type":"credit","customer_id":"C80162F403CCA7AF1CB6732291D6D53B88636BB6A9B82D2CD43AC30775925B4F","migration_status":"Success","card_number_masked":"222241 xxxx 0002","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null}] </details> ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.114.0

a3cc44c6e15ce69f39104b2ce205bed632e3971e

juspay/hyperswitch

juspay__hyperswitch-8430

Bug: [BUG] adyen connector creates connector's customer reference on the fly ### Bug Description Connector's customer ID is a unique identifier for a customer's entity in the underlying connector for HyperSwitch for mapping a customer. This identifier is stored under `connector_customer` in `customers` table. However, for Adyen - this field is a combination of merchant ID and customer ID in HyperSwitch which is unique across different merchants and customers. This is a blocker for migrated customers whose `shopperReference` (customer ID in Adyen) can be in a different format. ### Expected Behavior Adyen should rely on the `connector_customer` field for customer and fallback to any default connector specific behavior. ### Actual Behavior Adyen uses a default behavior for generating `connector_customer_id` ### Steps To Reproduce -- ### Context For The Bug -- ### Environment -- ### Have you spent some time checking if this bug has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? None

diff --git a/config/config.example.toml b/config/config.example.toml index 040e027dcf9..08589cbcc65 100644 --- a/config/config.example.toml +++ b/config/config.example.toml @@ -827,7 +827,7 @@ credit = {country = "AU,NZ,CN,HK,IN,LK,KR,MY,SG,GB,BE,FR,DE,IT,ME,NL,PL,ES,ZA,AR debit = {country = "AU,NZ,CN,HK,IN,LK,KR,MY,SG,GB,BE,FR,DE,IT,ME,NL,PL,ES,ZA,AR,BR,CO,MX,PA,UY,US,CA", currency = "AFN,ALL,DZD,AOA,ARS,AMD,AWG,AUD,AZN,BSD,BHD,BDT,BBD,BYN,BZD,BMD,BTN,BOB,VES,BAM,BWP,BRL,BND,BGN,BIF,KHR,CAD,CVE,KYD,XAF,CLP,CNY,COP,KMF,CDF,CRC,HRK,CUP,CZK,DKK,DJF,DOP,XCD,EGP,ERN,ETB,EUR,FKP,FJD,XPF,GMD,GEL,GHS,GIP,GTQ,GNF,GYD,HTG,HNL,HKD,HUF,ISK,INR,IDR,IRR,IQD,ILS,JMD,JPY,JOD,KZT,KES,KGS,KWD,LAK,LBP,LSL,LRD,LYD,MOP,MKD,MGA,MWK,MYR,MVR,MRU,MUR,MXN,MDL,MNT,MAD,MZN,MMK,NAD,NPR,ANG,NZD,NIO,NGN,VUV,KPW,NOK,OMR,PKR,PAB,PGK,PYG,PEN,PHP,PLN,GBP,QAR,RON,RUB,RWF,SHP,SVC,WST,STN,SAR,RSD,SCR,SLL,SGD,SBD,SOS,ZAR,KRW,SSP,LKR,SDG,SRD,SZL,SEK,CHF,SYP,TWD,TJS,TZS,THB,TOP,TTD,TND,TRY,TMT,UGX,UAH,AED,USD,UYU,UZS,VND,XOF,YER,ZMW,ZWL"} [connector_customer] -connector_list = "gocardless,stax,stripe,facilitapay,hyperswitch_vault" +connector_list = "adyen,facilitapay,gocardless,hyperswitch_vault,stax,stripe" payout_connector_list = "nomupay,stripe,wise" [bank_config.online_banking_fpx] diff --git a/config/deployments/integration_test.toml b/config/deployments/integration_test.toml index 513cb587176..f4c3e3815d0 100644 --- a/config/deployments/integration_test.toml +++ b/config/deployments/integration_test.toml @@ -174,7 +174,7 @@ force_cookies = true enabled = true [connector_customer] -connector_list = "gocardless,stax,stripe,facilitapay,hyperswitch_vault" +connector_list = "adyen,facilitapay,gocardless,hyperswitch_vault,stax,stripe" payout_connector_list = "nomupay,stripe,wise" [delayed_session_response] diff --git a/config/deployments/production.toml b/config/deployments/production.toml index 4b990ad0464..23f5c72e3cd 100644 --- a/config/deployments/production.toml +++ b/config/deployments/production.toml @@ -15,7 +15,7 @@ open_banking_uk.adyen.banks = "aib,bank_of_scotland,danske_bank,first_direct,fir przelewy24.stripe.banks = "alior_bank,bank_millennium,bank_nowy_bfg_sa,bank_pekao_sa,banki_spbdzielcze,blik,bnp_paribas,boz,citi,credit_agricole,e_transfer_pocztowy24,getin_bank,idea_bank,inteligo,mbank_mtransfer,nest_przelew,noble_pay,pbac_z_ipko,plus_bank,santander_przelew24,toyota_bank,volkswagen_bank" [connector_customer] -connector_list = "stax,stripe,gocardless,facilitapay,hyperswitch_vault" +connector_list = "adyen,facilitapay,gocardless,hyperswitch_vault,stax,stripe" payout_connector_list = "nomupay,stripe,wise" # Connector configuration, provided attributes will be used to fulfill API requests. diff --git a/config/deployments/sandbox.toml b/config/deployments/sandbox.toml index d00b12c751f..e09aa5f88fd 100644 --- a/config/deployments/sandbox.toml +++ b/config/deployments/sandbox.toml @@ -15,7 +15,7 @@ open_banking_uk.adyen.banks = "aib,bank_of_scotland,danske_bank,first_direct,fir przelewy24.stripe.banks = "alior_bank,bank_millennium,bank_nowy_bfg_sa,bank_pekao_sa,banki_spbdzielcze,blik,bnp_paribas,boz,citi,credit_agricole,e_transfer_pocztowy24,getin_bank,idea_bank,inteligo,mbank_mtransfer,nest_przelew,noble_pay,pbac_z_ipko,plus_bank,santander_przelew24,toyota_bank,volkswagen_bank" [connector_customer] -connector_list = "stax,stripe,gocardless,facilitapay,hyperswitch_vault" +connector_list = "adyen,facilitapay,gocardless,hyperswitch_vault,stax,stripe" payout_connector_list = "nomupay,stripe,wise" # Connector configuration, provided attributes will be used to fulfill API requests. diff --git a/config/development.toml b/config/development.toml index 95484d6b014..8107dce3886 100644 --- a/config/development.toml +++ b/config/development.toml @@ -872,7 +872,7 @@ nexixpay = { payment_method = "card" } redsys = { payment_method = "card" } [connector_customer] -connector_list = "gocardless,stax,stripe,facilitapay,hyperswitch_vault" +connector_list = "adyen,facilitapay,gocardless,hyperswitch_vault,stax,stripe" payout_connector_list = "nomupay,stripe,wise" [dummy_connector] diff --git a/config/docker_compose.toml b/config/docker_compose.toml index b029fb9987f..484dd76097a 100644 --- a/config/docker_compose.toml +++ b/config/docker_compose.toml @@ -883,7 +883,7 @@ card.debit = { connector_list = "cybersource" } connector_list = "adyen,archipel,cybersource,novalnet,stripe,worldpay" [connector_customer] -connector_list = "gocardless,stax,stripe,facilitapay,hyperswitch_vault" +connector_list = "adyen,facilitapay,gocardless,hyperswitch_vault,stax,stripe" payout_connector_list = "nomupay,stripe,wise" diff --git a/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs b/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs index c78daba6c4e..504635fe070 100644 --- a/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs @@ -1765,29 +1765,31 @@ type RecurringDetails = (Option<AdyenRecurringModel>, Option<bool>, Option<Strin fn get_recurring_processing_model( item: &PaymentsAuthorizeRouterData, ) -> Result<RecurringDetails, Error> { - match (item.request.setup_future_usage, item.request.off_session) { - (Some(storage_enums::FutureUsage::OffSession), _) => { + let shopper_reference = match item.get_connector_customer_id() { + Ok(connector_customer_id) => Some(connector_customer_id), + Err(_) => { let customer_id = item.get_customer_id()?; - let shopper_reference = format!( + Some(format!( "{}_{}", item.merchant_id.get_string_repr(), customer_id.get_string_repr() - ); + )) + } + }; + + match (item.request.setup_future_usage, item.request.off_session) { + (Some(storage_enums::FutureUsage::OffSession), _) => { let store_payment_method = item.request.is_mandate_payment(); Ok(( Some(AdyenRecurringModel::UnscheduledCardOnFile), Some(store_payment_method), - Some(shopper_reference), + shopper_reference, )) } (_, Some(true)) => Ok(( Some(AdyenRecurringModel::UnscheduledCardOnFile), None, - Some(format!( - "{}_{}", - item.merchant_id.get_string_repr(), - item.get_customer_id()?.get_string_repr() - )), + shopper_reference, )), _ => Ok((None, None, None)), } @@ -1967,17 +1969,18 @@ fn get_social_security_number(voucher_data: &VoucherData) -> Option<Secret<Strin } } -fn build_shopper_reference( - customer_id: &Option<common_utils::id_type::CustomerId>, - merchant_id: common_utils::id_type::MerchantId, -) -> Option<String> { - customer_id.clone().map(|c_id| { - format!( - "{}_{}", - merchant_id.get_string_repr(), - c_id.get_string_repr() - ) - }) +fn build_shopper_reference(item: &PaymentsAuthorizeRouterData) -> Option<String> { + match item.get_connector_customer_id() { + Ok(connector_customer_id) => Some(connector_customer_id), + Err(_) => match item.get_customer_id() { + Ok(customer_id) => Some(format!( + "{}_{}", + item.merchant_id.get_string_repr(), + customer_id.get_string_repr() + )), + Err(_) => None, + }, + } } impl TryFrom<(&BankDebitData, &PaymentsAuthorizeRouterData)> for AdyenPaymentMethod<'_> { @@ -2898,10 +2901,7 @@ impl TryFrom<(&AdyenRouterData<&PaymentsAuthorizeRouterData>, &Card)> for AdyenP let amount = get_amount_data(item); let auth_type = AdyenAuthType::try_from(&item.router_data.connector_auth_type)?; let shopper_interaction = AdyenShopperInteraction::from(item.router_data); - let shopper_reference = build_shopper_reference( - &item.router_data.customer_id, - item.router_data.merchant_id.clone(), - ); + let shopper_reference = build_shopper_reference(item.router_data); let (recurring_processing_model, store_payment_method, _) = get_recurring_processing_model(item.router_data)?; let browser_info = get_browser_info(item.router_data)?; @@ -3506,10 +3506,7 @@ impl let additional_data = get_additional_data(item.router_data); let country_code = get_country_code(item.router_data.get_optional_billing()); let shopper_interaction = AdyenShopperInteraction::from(item.router_data); - let shopper_reference = build_shopper_reference( - &item.router_data.customer_id, - item.router_data.merchant_id.clone(), - ); + let shopper_reference = build_shopper_reference(item.router_data); let (recurring_processing_model, store_payment_method, _) = get_recurring_processing_model(item.router_data)?; let return_url = item.router_data.request.get_router_return_url()?; @@ -5822,10 +5819,7 @@ impl let amount = get_amount_data(item); let auth_type = AdyenAuthType::try_from(&item.router_data.connector_auth_type)?; let shopper_interaction = AdyenShopperInteraction::from(item.router_data); - let shopper_reference = build_shopper_reference( - &item.router_data.customer_id, - item.router_data.merchant_id.clone(), - ); + let shopper_reference = build_shopper_reference(item.router_data); let (recurring_processing_model, store_payment_method, _) = get_recurring_processing_model(item.router_data)?; let browser_info = get_browser_info(item.router_data)?; diff --git a/loadtest/config/development.toml b/loadtest/config/development.toml index 5a59523eeb3..b82746362d0 100644 --- a/loadtest/config/development.toml +++ b/loadtest/config/development.toml @@ -554,7 +554,7 @@ gocardless = { long_lived_token = true, payment_method = "bank_debit" } billwerk = { long_lived_token = false, payment_method = "card" } [connector_customer] -connector_list = "gocardless,stax,stripe,facilitapay,hyperswitch_vault" +connector_list = "adyen,facilitapay,gocardless,hyperswitch_vault,stax,stripe" payout_connector_list = "nomupay,wise" [dummy_connector]

2025-06-24T10:42:43Z

## Type of Change  - [ ] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  Adyen now uses `connector_customer_id` to form `shopper_reference` if the field is present, else falls to previous implementation. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  ## How did you test it?  <img width="1081" alt="Screenshot 2025-06-24 at 4 01 08 PM" src="https://github.com/user-attachments/assets/08ad7563-b19a-41a5-8729-74aa3b5f6295" /> ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.114.0

bc767b9131e2637ce90997da9018085d2dadb80b

juspay/hyperswitch

juspay__hyperswitch-8435

Bug: [FEAT] Implement Refund for JPMorgan this connector lacks basic feature i.e., refunds. relevant docs: - https://developer.payments.jpmorgan.com/api/commerce/online-payments/overview - https://developer.payments.jpmorgan.com/api/commerce/online-payments/online-payments/online-payments#/operations/V2RefundPost

diff --git a/crates/hyperswitch_connectors/src/connectors/jpmorgan.rs b/crates/hyperswitch_connectors/src/connectors/jpmorgan.rs index 9783324c042..043f140a174 100644 --- a/crates/hyperswitch_connectors/src/connectors/jpmorgan.rs +++ b/crates/hyperswitch_connectors/src/connectors/jpmorgan.rs @@ -665,9 +665,9 @@ impl ConnectorIntegration<Execute, RefundsData, RefundsResponseData> for Jpmorga fn get_url( &self, _req: &RefundsRouterData<Execute>, - _connectors: &Connectors, + connectors: &Connectors, ) -> CustomResult<String, errors::ConnectorError> { - Err(errors::ConnectorError::NotImplemented("Refunds".to_string()).into()) + Ok(format!("{}/refunds", self.base_url(connectors))) } fn get_request_body( diff --git a/crates/hyperswitch_connectors/src/connectors/jpmorgan/transformers.rs b/crates/hyperswitch_connectors/src/connectors/jpmorgan/transformers.rs index 9f253c0ffb7..0c2f6110f30 100644 --- a/crates/hyperswitch_connectors/src/connectors/jpmorgan/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/jpmorgan/transformers.rs @@ -272,18 +272,10 @@ pub struct JpmorganPaymentsResponse { #[serde(rename_all = "camelCase")] pub struct Merchant { merchant_id: Option<String>, - merchant_software: MerchantSoftware, + merchant_software: JpmorganMerchantSoftware, merchant_category_code: Option<String>, } -#[derive(Default, Debug, Serialize, Deserialize)] -#[serde(rename_all = "camelCase")] -pub struct MerchantSoftware { - company_name: Secret<String>, - product_name: Secret<String>, - version: Option<Secret<String>>, -} - #[derive(Default, Debug, Deserialize, Serialize)] #[serde(rename_all = "camelCase")] pub struct PaymentMethodType { @@ -522,18 +514,31 @@ pub struct TransactionData { pub struct JpmorganRefundRequest { pub merchant: MerchantRefundReq, pub amount: MinorUnit, + pub currency: common_enums::Currency, } #[derive(Default, Debug, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct MerchantRefundReq { - pub merchant_software: MerchantSoftware, + pub merchant_software: JpmorganMerchantSoftware, } impl<F> TryFrom<&JpmorganRouterData<&RefundsRouterData<F>>> for JpmorganRefundRequest { type Error = error_stack::Report<errors::ConnectorError>; - fn try_from(_item: &JpmorganRouterData<&RefundsRouterData<F>>) -> Result<Self, Self::Error> { - Err(errors::ConnectorError::NotImplemented("Refunds".to_string()).into()) + fn try_from(item: &JpmorganRouterData<&RefundsRouterData<F>>) -> Result<Self, Self::Error> { + let merchant_software = JpmorganMerchantSoftware { + company_name: String::from("JPMC").into(), + product_name: String::from("Hyperswitch").into(), + }; + let merchant = MerchantRefundReq { merchant_software }; + let amount = item.amount; + let currency = item.router_data.request.currency; + + Ok(Self { + merchant, + amount, + currency, + }) } } @@ -552,7 +557,6 @@ pub struct JpmorganRefundResponse { pub remaining_refundable_amount: Option<i64>, } -#[allow(dead_code)] #[derive(Debug, Serialize, Default, Deserialize, Clone)] pub enum RefundStatus { Succeeded, @@ -571,24 +575,23 @@ impl From<RefundStatus> for common_enums::RefundStatus { } } -#[derive(Default, Debug, Clone, Serialize, Deserialize)] -pub struct RefundResponse { - id: String, - status: RefundStatus, -} - -pub fn refund_status_from_transaction_state( - transaction_state: JpmorganTransactionState, -) -> common_enums::RefundStatus { - match transaction_state { - JpmorganTransactionState::Voided | JpmorganTransactionState::Closed => { - common_enums::RefundStatus::Success - } - JpmorganTransactionState::Declined | JpmorganTransactionState::Error => { - common_enums::RefundStatus::Failure - } - JpmorganTransactionState::Pending | JpmorganTransactionState::Authorized => { - common_enums::RefundStatus::Pending +impl From<(JpmorganResponseStatus, JpmorganTransactionState)> for RefundStatus { + fn from( + (response_status, transaction_state): (JpmorganResponseStatus, JpmorganTransactionState), + ) -> Self { + match response_status { + JpmorganResponseStatus::Success => match transaction_state { + JpmorganTransactionState::Voided | JpmorganTransactionState::Closed => { + Self::Succeeded + } + JpmorganTransactionState::Declined | JpmorganTransactionState::Error => { + Self::Failed + } + JpmorganTransactionState::Pending | JpmorganTransactionState::Authorized => { + Self::Processing + } + }, + JpmorganResponseStatus::Denied | JpmorganResponseStatus::Error => Self::Failed, } } } @@ -607,9 +610,11 @@ impl TryFrom<RefundsResponseRouterData<Execute, JpmorganRefundResponse>> .transaction_id .clone() .ok_or(errors::ConnectorError::ResponseHandlingFailed)?, - refund_status: refund_status_from_transaction_state( + refund_status: RefundStatus::from(( + item.response.response_status, item.response.transaction_state, - ), + )) + .into(), }), ..item.data }) @@ -638,9 +643,11 @@ impl TryFrom<RefundsResponseRouterData<RSync, JpmorganRefundSyncResponse>> Ok(Self { response: Ok(RefundsResponseData { connector_refund_id: item.response.transaction_id.clone(), - refund_status: refund_status_from_transaction_state( + refund_status: RefundStatus::from(( + item.response.response_status, item.response.transaction_state, - ), + )) + .into(), }), ..item.data })

2025-06-23T17:30:48Z

## Type of Change  - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [x] CI/CD ## Description  This PR implements refund flow for JPMorgan connector. Connector returns `Authorized` state (`Pending`). Post RSync call, the status gets updated to `Success`. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  The connector lacked this basic feature until now. Closes #8435 ## How did you test it?  Updated Cypress tests: <img width="558" alt="image" src="https://github.com/user-attachments/assets/cb18d34e-d6d2-4145-8e94-773ab6638389" /> There exist an issue from the connector where it returns same `transaction_id` (`connector_transaction_id`) every single time which we have no control. Because of this, refunds tend to exceed the maximum refundable amount resulting in 4xx as shown below: <img width="557" alt="image" src="https://github.com/user-attachments/assets/549c517b-cc54-4114-b034-5df64783bd68" /> <img width="477" alt="image" src="https://github.com/user-attachments/assets/47018470-5798-4a07-b480-1f0694540d68" /> ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `just clippy && jut clippy_v2` - [x] I reviewed the submitted code - [x] I added unit tests for my changes where possible

v1.114.0

786fe699c2abd1a3eb752121a1915acd2012d94a

juspay/hyperswitch

juspay__hyperswitch-8407

Bug: ci(connector): [ARCHIPEL] configure test cases Automate CI Checks by Fixing, Adding and Configuring Test Cases over:- - [Postman](https://github.com/juspay/hyperswitch/pull/8360) - [Cypress](https://github.com/juspay/hyperswitch/pull/8189)

2025-05-30T16:25:08Z

## Type of Change  - [ ] Bugfix - [ ] New feature - [x] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [x] CI/CD ## Description  Enhancements for `archipel` Cypress Tests. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  `archipel` Cypress Tests were failing. ## How did you test it?   <img width="726" height="962" alt="image" src="https://github.com/user-attachments/assets/ee72bc01-69a1-4afb-ac76-8c3edec1c124" /> _PS: There is an issue with Incremental Auth, not anything related to the configs, but the spec itself, addressing it in another PR because that would affect 1 other connector as well, and after it is fixed, it would affect 3 connectors in total._ ## Checklist  - [ ] I formatted the code `cargo +nightly fmt --all` - [ ] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

8ccaac7c10e9366772e43d34f271d946cc4b3baa

juspay/hyperswitch

juspay__hyperswitch-8409

Bug: [FEATURE] Add routing metrics endpoint ### Feature Description Need to add an endpoint for routing metrics. Also add routing approach as a filter in payment analytics ### Possible Implementation Need to add an endpoint for routing metrics. Also add routing approach as a filter in payment analytics ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? Yes, I am willing to submit a PR!

diff --git a/crates/analytics/docs/clickhouse/scripts/payment_attempts.sql b/crates/analytics/docs/clickhouse/scripts/payment_attempts.sql index f5d0ca51fd7..6673b73fedb 100644 --- a/crates/analytics/docs/clickhouse/scripts/payment_attempts.sql +++ b/crates/analytics/docs/clickhouse/scripts/payment_attempts.sql @@ -43,6 +43,7 @@ CREATE TABLE payment_attempt_queue ( `organization_id` String, `profile_id` String, `card_network` Nullable(String), + `routing_approach` LowCardinality(Nullable(String)), `sign_flag` Int8 ) ENGINE = Kafka SETTINGS kafka_broker_list = 'kafka0:29092', kafka_topic_list = 'hyperswitch-payment-attempt-events', @@ -96,6 +97,7 @@ CREATE TABLE payment_attempts ( `organization_id` String, `profile_id` String, `card_network` Nullable(String), + `routing_approach` LowCardinality(Nullable(String)), `sign_flag` Int8, INDEX connectorIndex connector TYPE bloom_filter GRANULARITY 1, INDEX paymentMethodIndex payment_method TYPE bloom_filter GRANULARITY 1, @@ -152,6 +154,7 @@ CREATE MATERIALIZED VIEW payment_attempt_mv TO payment_attempts ( `organization_id` String, `profile_id` String, `card_network` Nullable(String), + `routing_approach` LowCardinality(Nullable(String)), `sign_flag` Int8 ) AS SELECT @@ -200,6 +203,7 @@ SELECT organization_id, profile_id, card_network, + routing_approach, sign_flag FROM payment_attempt_queue diff --git a/crates/analytics/src/core.rs b/crates/analytics/src/core.rs index 980e17bc90a..f3dd8e8eb8c 100644 --- a/crates/analytics/src/core.rs +++ b/crates/analytics/src/core.rs @@ -46,6 +46,11 @@ pub async fn get_domain_info( download_dimensions: None, dimensions: utils::get_dispute_dimensions(), }, + AnalyticsDomain::Routing => GetInfoResponse { + metrics: utils::get_payment_metrics_info(), + download_dimensions: None, + dimensions: utils::get_payment_dimensions(), + }, }; Ok(info) } diff --git a/crates/analytics/src/payments/core.rs b/crates/analytics/src/payments/core.rs index 7291d2f1fcc..e55ba2726af 100644 --- a/crates/analytics/src/payments/core.rs +++ b/crates/analytics/src/payments/core.rs @@ -410,6 +410,7 @@ pub async fn get_filters( PaymentDimensions::CardLast4 => fil.card_last_4, PaymentDimensions::CardIssuer => fil.card_issuer, PaymentDimensions::ErrorReason => fil.error_reason, + PaymentDimensions::RoutingApproach => fil.routing_approach.map(|i| i.as_ref().to_string()), }) .collect::<Vec<String>>(); res.query_data.push(FilterValue { diff --git a/crates/analytics/src/payments/distribution.rs b/crates/analytics/src/payments/distribution.rs index 86a2f06c5f5..ab82e48f407 100644 --- a/crates/analytics/src/payments/distribution.rs +++ b/crates/analytics/src/payments/distribution.rs @@ -37,6 +37,7 @@ pub struct PaymentDistributionRow { pub total: Option<bigdecimal::BigDecimal>, pub count: Option<i64>, pub error_message: Option<String>, + pub routing_approach: Option<DBEnumWrapper<storage_enums::RoutingApproach>>, #[serde(with = "common_utils::custom_serde::iso8601::option")] pub start_bucket: Option<PrimitiveDateTime>, #[serde(with = "common_utils::custom_serde::iso8601::option")] diff --git a/crates/analytics/src/payments/distribution/payment_error_message.rs b/crates/analytics/src/payments/distribution/payment_error_message.rs index 0a92cfbe470..d5fa0569452 100644 --- a/crates/analytics/src/payments/distribution/payment_error_message.rs +++ b/crates/analytics/src/payments/distribution/payment_error_message.rs @@ -160,6 +160,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(|i| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/filters.rs b/crates/analytics/src/payments/filters.rs index 668bdaa6c8b..b6ebf094e81 100644 --- a/crates/analytics/src/payments/filters.rs +++ b/crates/analytics/src/payments/filters.rs @@ -1,6 +1,6 @@ use api_models::analytics::{payments::PaymentDimensions, Granularity, TimeRange}; use common_utils::errors::ReportSwitchExt; -use diesel_models::enums::{AttemptStatus, AuthenticationType, Currency}; +use diesel_models::enums::{AttemptStatus, AuthenticationType, Currency, RoutingApproach}; use error_stack::ResultExt; use time::PrimitiveDateTime; @@ -65,4 +65,5 @@ pub struct PaymentFilterRow { pub card_issuer: Option<String>, pub error_reason: Option<String>, pub first_attempt: Option<bool>, + pub routing_approach: Option<DBEnumWrapper<RoutingApproach>>, } diff --git a/crates/analytics/src/payments/metrics.rs b/crates/analytics/src/payments/metrics.rs index 71d2e57d7fa..67dc50c5152 100644 --- a/crates/analytics/src/payments/metrics.rs +++ b/crates/analytics/src/payments/metrics.rs @@ -50,6 +50,7 @@ pub struct PaymentMetricRow { pub first_attempt: Option<bool>, pub total: Option<bigdecimal::BigDecimal>, pub count: Option<i64>, + pub routing_approach: Option<DBEnumWrapper<storage_enums::RoutingApproach>>, #[serde(with = "common_utils::custom_serde::iso8601::option")] pub start_bucket: Option<PrimitiveDateTime>, #[serde(with = "common_utils::custom_serde::iso8601::option")] diff --git a/crates/analytics/src/payments/metrics/avg_ticket_size.rs b/crates/analytics/src/payments/metrics/avg_ticket_size.rs index 10f350e30ce..8ec175cf8da 100644 --- a/crates/analytics/src/payments/metrics/avg_ticket_size.rs +++ b/crates/analytics/src/payments/metrics/avg_ticket_size.rs @@ -122,6 +122,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(|i| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/connector_success_rate.rs b/crates/analytics/src/payments/metrics/connector_success_rate.rs index 9e6bf31fbfb..eb4518f6d23 100644 --- a/crates/analytics/src/payments/metrics/connector_success_rate.rs +++ b/crates/analytics/src/payments/metrics/connector_success_rate.rs @@ -117,6 +117,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(|i| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/payment_count.rs b/crates/analytics/src/payments/metrics/payment_count.rs index 297aef4fec5..ed23a400fb7 100644 --- a/crates/analytics/src/payments/metrics/payment_count.rs +++ b/crates/analytics/src/payments/metrics/payment_count.rs @@ -108,6 +108,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(|i| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/payment_processed_amount.rs b/crates/analytics/src/payments/metrics/payment_processed_amount.rs index 95846924665..302acf097ed 100644 --- a/crates/analytics/src/payments/metrics/payment_processed_amount.rs +++ b/crates/analytics/src/payments/metrics/payment_processed_amount.rs @@ -122,6 +122,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(|i| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/payment_success_count.rs b/crates/analytics/src/payments/metrics/payment_success_count.rs index 843e2858977..d1f437d812d 100644 --- a/crates/analytics/src/payments/metrics/payment_success_count.rs +++ b/crates/analytics/src/payments/metrics/payment_success_count.rs @@ -115,6 +115,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(|i| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/retries_count.rs b/crates/analytics/src/payments/metrics/retries_count.rs index ced845651cf..63ebfaefca6 100644 --- a/crates/analytics/src/payments/metrics/retries_count.rs +++ b/crates/analytics/src/payments/metrics/retries_count.rs @@ -112,6 +112,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(|i| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/sessionized_metrics/avg_ticket_size.rs b/crates/analytics/src/payments/metrics/sessionized_metrics/avg_ticket_size.rs index e29c19bda88..a5138777361 100644 --- a/crates/analytics/src/payments/metrics/sessionized_metrics/avg_ticket_size.rs +++ b/crates/analytics/src/payments/metrics/sessionized_metrics/avg_ticket_size.rs @@ -123,6 +123,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(|i| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/sessionized_metrics/connector_success_rate.rs b/crates/analytics/src/payments/metrics/sessionized_metrics/connector_success_rate.rs index d8ee7fcb473..626f11aa229 100644 --- a/crates/analytics/src/payments/metrics/sessionized_metrics/connector_success_rate.rs +++ b/crates/analytics/src/payments/metrics/sessionized_metrics/connector_success_rate.rs @@ -118,6 +118,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(|i| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/sessionized_metrics/failure_reasons.rs b/crates/analytics/src/payments/metrics/sessionized_metrics/failure_reasons.rs index d6944d8d0bd..f19185b345e 100644 --- a/crates/analytics/src/payments/metrics/sessionized_metrics/failure_reasons.rs +++ b/crates/analytics/src/payments/metrics/sessionized_metrics/failure_reasons.rs @@ -183,6 +183,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(|i| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/sessionized_metrics/payment_count.rs b/crates/analytics/src/payments/metrics/sessionized_metrics/payment_count.rs index 98735b9383a..79d57477e13 100644 --- a/crates/analytics/src/payments/metrics/sessionized_metrics/payment_count.rs +++ b/crates/analytics/src/payments/metrics/sessionized_metrics/payment_count.rs @@ -109,6 +109,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(|i| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/sessionized_metrics/payment_processed_amount.rs b/crates/analytics/src/payments/metrics/sessionized_metrics/payment_processed_amount.rs index 453f988d229..0a2ab1f8a23 100644 --- a/crates/analytics/src/payments/metrics/sessionized_metrics/payment_processed_amount.rs +++ b/crates/analytics/src/payments/metrics/sessionized_metrics/payment_processed_amount.rs @@ -140,6 +140,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(|i| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/sessionized_metrics/payment_success_count.rs b/crates/analytics/src/payments/metrics/sessionized_metrics/payment_success_count.rs index 14391588b48..e59402933aa 100644 --- a/crates/analytics/src/payments/metrics/sessionized_metrics/payment_success_count.rs +++ b/crates/analytics/src/payments/metrics/sessionized_metrics/payment_success_count.rs @@ -116,6 +116,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(|i| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/sessionized_metrics/payments_distribution.rs b/crates/analytics/src/payments/metrics/sessionized_metrics/payments_distribution.rs index 5c6a8c6adec..d7305cd0792 100644 --- a/crates/analytics/src/payments/metrics/sessionized_metrics/payments_distribution.rs +++ b/crates/analytics/src/payments/metrics/sessionized_metrics/payments_distribution.rs @@ -119,6 +119,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(|i| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/sessionized_metrics/retries_count.rs b/crates/analytics/src/payments/metrics/sessionized_metrics/retries_count.rs index 7d81c48274b..83307d75f7a 100644 --- a/crates/analytics/src/payments/metrics/sessionized_metrics/retries_count.rs +++ b/crates/analytics/src/payments/metrics/sessionized_metrics/retries_count.rs @@ -112,6 +112,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(|i| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/sessionized_metrics/success_rate.rs b/crates/analytics/src/payments/metrics/sessionized_metrics/success_rate.rs index f20308ed3b1..8159a615ba8 100644 --- a/crates/analytics/src/payments/metrics/sessionized_metrics/success_rate.rs +++ b/crates/analytics/src/payments/metrics/sessionized_metrics/success_rate.rs @@ -112,6 +112,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(|i| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/success_rate.rs b/crates/analytics/src/payments/metrics/success_rate.rs index 6698fe8ce65..032f3219a68 100644 --- a/crates/analytics/src/payments/metrics/success_rate.rs +++ b/crates/analytics/src/payments/metrics/success_rate.rs @@ -111,6 +111,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(|i| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/types.rs b/crates/analytics/src/payments/types.rs index b9af3cd0610..7bb23d7af78 100644 --- a/crates/analytics/src/payments/types.rs +++ b/crates/analytics/src/payments/types.rs @@ -109,6 +109,16 @@ where .add_filter_in_range_clause("first_attempt", &self.first_attempt) .attach_printable("Error adding first attempt filter")?; } + + if !self.routing_approach.is_empty() { + builder + .add_filter_in_range_clause( + PaymentDimensions::RoutingApproach, + &self.routing_approach, + ) + .attach_printable("Error adding routing approach filter")?; + } + Ok(()) } } diff --git a/crates/analytics/src/query.rs b/crates/analytics/src/query.rs index 5effd9e70a7..50d16c68e6f 100644 --- a/crates/analytics/src/query.rs +++ b/crates/analytics/src/query.rs @@ -15,7 +15,7 @@ use api_models::{ }, enums::{ AttemptStatus, AuthenticationType, Connector, Currency, DisputeStage, IntentStatus, - PaymentMethod, PaymentMethodType, + PaymentMethod, PaymentMethodType, RoutingApproach, }, refunds::RefundStatus, }; @@ -514,7 +514,8 @@ impl_to_sql_for_to_string!( &bool, &u64, u64, - Order + Order, + RoutingApproach ); impl_to_sql_for_to_string!( diff --git a/crates/analytics/src/sqlx.rs b/crates/analytics/src/sqlx.rs index 028a1ddc143..53b9cc10e10 100644 --- a/crates/analytics/src/sqlx.rs +++ b/crates/analytics/src/sqlx.rs @@ -13,7 +13,7 @@ use common_utils::{ }; use diesel_models::enums::{ AttemptStatus, AuthenticationType, Currency, FraudCheckStatus, IntentStatus, PaymentMethod, - RefundStatus, + RefundStatus, RoutingApproach, }; use error_stack::ResultExt; use sqlx::{ @@ -103,6 +103,7 @@ db_type!(AuthenticationStatus); db_type!(TransactionStatus); db_type!(AuthenticationConnectors); db_type!(DecoupledAuthenticationType); +db_type!(RoutingApproach); impl<'q, Type> Encode<'q, Postgres> for DBEnumWrapper<Type> where @@ -730,6 +731,11 @@ impl<'a> FromRow<'a, PgRow> for super::payments::metrics::PaymentMetricRow { ColumnNotFound(_) => Ok(Default::default()), e => Err(e), })?; + let routing_approach: Option<DBEnumWrapper<RoutingApproach>> = + row.try_get("routing_approach").or_else(|e| match e { + ColumnNotFound(_) => Ok(Default::default()), + e => Err(e), + })?; let total: Option<bigdecimal::BigDecimal> = row.try_get("total").or_else(|e| match e { ColumnNotFound(_) => Ok(Default::default()), e => Err(e), @@ -761,6 +767,7 @@ impl<'a> FromRow<'a, PgRow> for super::payments::metrics::PaymentMetricRow { card_issuer, error_reason, first_attempt, + routing_approach, total, count, start_bucket, @@ -833,6 +840,11 @@ impl<'a> FromRow<'a, PgRow> for super::payments::distribution::PaymentDistributi ColumnNotFound(_) => Ok(Default::default()), e => Err(e), })?; + let routing_approach: Option<DBEnumWrapper<RoutingApproach>> = + row.try_get("routing_approach").or_else(|e| match e { + ColumnNotFound(_) => Ok(Default::default()), + e => Err(e), + })?; let total: Option<bigdecimal::BigDecimal> = row.try_get("total").or_else(|e| match e { ColumnNotFound(_) => Ok(Default::default()), e => Err(e), @@ -875,6 +887,7 @@ impl<'a> FromRow<'a, PgRow> for super::payments::distribution::PaymentDistributi total, count, error_message, + routing_approach, start_bucket, end_bucket, }) @@ -949,6 +962,11 @@ impl<'a> FromRow<'a, PgRow> for super::payments::filters::PaymentFilterRow { ColumnNotFound(_) => Ok(Default::default()), e => Err(e), })?; + let routing_approach: Option<DBEnumWrapper<RoutingApproach>> = + row.try_get("routing_approach").or_else(|e| match e { + ColumnNotFound(_) => Ok(Default::default()), + e => Err(e), + })?; Ok(Self { currency, status, @@ -965,6 +983,7 @@ impl<'a> FromRow<'a, PgRow> for super::payments::filters::PaymentFilterRow { card_issuer, error_reason, first_attempt, + routing_approach, }) } } diff --git a/crates/analytics/src/types.rs b/crates/analytics/src/types.rs index 28ff2cec8bd..4f9a7655ede 100644 --- a/crates/analytics/src/types.rs +++ b/crates/analytics/src/types.rs @@ -21,6 +21,7 @@ pub enum AnalyticsDomain { SdkEvents, ApiEvents, Dispute, + Routing, } #[derive(Debug, strum::AsRefStr, strum::Display, Clone, Copy)] diff --git a/crates/analytics/src/utils.rs b/crates/analytics/src/utils.rs index 06cc998f3da..36121e56ebb 100644 --- a/crates/analytics/src/utils.rs +++ b/crates/analytics/src/utils.rs @@ -24,6 +24,7 @@ pub fn get_payment_dimensions() -> Vec<NameDescription> { PaymentDimensions::ProfileId, PaymentDimensions::CardNetwork, PaymentDimensions::MerchantId, + PaymentDimensions::RoutingApproach, ] .into_iter() .map(Into::into) diff --git a/crates/api_models/src/analytics/payments.rs b/crates/api_models/src/analytics/payments.rs index 691e827043f..537d6df09d1 100644 --- a/crates/api_models/src/analytics/payments.rs +++ b/crates/api_models/src/analytics/payments.rs @@ -8,7 +8,7 @@ use common_utils::id_type; use super::{ForexMetric, NameDescription, TimeRange}; use crate::enums::{ AttemptStatus, AuthenticationType, CardNetwork, Connector, Currency, PaymentMethod, - PaymentMethodType, + PaymentMethodType, RoutingApproach, }; #[derive(Clone, Debug, Default, serde::Deserialize, serde::Serialize)] @@ -43,6 +43,8 @@ pub struct PaymentFilters { pub error_reason: Vec<String>, #[serde(default)] pub first_attempt: Vec<bool>, + #[serde(default)] + pub routing_approach: Vec<RoutingApproach>, } #[derive( @@ -84,6 +86,7 @@ pub enum PaymentDimensions { CardLast4, CardIssuer, ErrorReason, + RoutingApproach, } #[derive( @@ -200,6 +203,7 @@ pub struct PaymentMetricsBucketIdentifier { pub card_last_4: Option<String>, pub card_issuer: Option<String>, pub error_reason: Option<String>, + pub routing_approach: Option<RoutingApproach>, #[serde(rename = "time_range")] pub time_bucket: TimeRange, // Coz FE sucks @@ -225,6 +229,7 @@ impl PaymentMetricsBucketIdentifier { card_last_4: Option<String>, card_issuer: Option<String>, error_reason: Option<String>, + routing_approach: Option<RoutingApproach>, normalized_time_range: TimeRange, ) -> Self { Self { @@ -242,6 +247,7 @@ impl PaymentMetricsBucketIdentifier { card_last_4, card_issuer, error_reason, + routing_approach, time_bucket: normalized_time_range, start_time: normalized_time_range.start_time, } @@ -264,6 +270,7 @@ impl Hash for PaymentMetricsBucketIdentifier { self.card_last_4.hash(state); self.card_issuer.hash(state); self.error_reason.hash(state); + self.routing_approach.map(|i| i.to_string()).hash(state); self.time_bucket.hash(state); } } diff --git a/crates/common_enums/src/enums.rs b/crates/common_enums/src/enums.rs index 641dc83291c..d7f4a1b2a20 100644 --- a/crates/common_enums/src/enums.rs +++ b/crates/common_enums/src/enums.rs @@ -29,7 +29,7 @@ pub mod diesel_exports { DbPaymentType as PaymentType, DbProcessTrackerStatus as ProcessTrackerStatus, DbRefundStatus as RefundStatus, DbRequestIncrementalAuthorization as RequestIncrementalAuthorization, - DbScaExemptionType as ScaExemptionType, + DbRoutingApproach as RoutingApproach, DbScaExemptionType as ScaExemptionType, DbSuccessBasedRoutingConclusiveState as SuccessBasedRoutingConclusiveState, DbTokenizationFlag as TokenizationFlag, DbWebhookDeliveryAttempt as WebhookDeliveryAttempt, }; @@ -8494,3 +8494,44 @@ pub enum TokenDataType { /// Fetch network token for the given payment method NetworkToken, } + +#[derive( + Clone, + Copy, + Debug, + Default, + Eq, + Hash, + PartialEq, + serde::Deserialize, + serde::Serialize, + strum::Display, + strum::VariantNames, + strum::EnumIter, + strum::EnumString, + ToSchema, +)] +#[router_derive::diesel_enum(storage_type = "db_enum")] +#[serde(rename_all = "snake_case")] +#[strum(serialize_all = "snake_case")] +pub enum RoutingApproach { + SuccessRateExploitation, + SuccessRateExploration, + ContractBasedRouting, + DebitRouting, + RuleBasedRouting, + VolumeBasedRouting, + #[default] + DefaultFallback, +} + +impl RoutingApproach { + pub fn from_decision_engine_approach(approach: &str) -> Self { + match approach { + "SR_SELECTION_V3_ROUTING" => Self::SuccessRateExploitation, + "SR_V3_HEDGING" => Self::SuccessRateExploration, + "NTW_BASED_ROUTING" => Self::DebitRouting, + _ => Self::DefaultFallback, + } + } +} diff --git a/crates/diesel_models/src/enums.rs b/crates/diesel_models/src/enums.rs index fc9417342e1..f7c84368b42 100644 --- a/crates/diesel_models/src/enums.rs +++ b/crates/diesel_models/src/enums.rs @@ -21,7 +21,8 @@ pub mod diesel_exports { DbRelayType as RelayType, DbRequestIncrementalAuthorization as RequestIncrementalAuthorization, DbRevenueRecoveryAlgorithmType as RevenueRecoveryAlgorithmType, DbRoleScope as RoleScope, - DbRoutingAlgorithmKind as RoutingAlgorithmKind, DbScaExemptionType as ScaExemptionType, + DbRoutingAlgorithmKind as RoutingAlgorithmKind, DbRoutingApproach as RoutingApproach, + DbScaExemptionType as ScaExemptionType, DbSuccessBasedRoutingConclusiveState as SuccessBasedRoutingConclusiveState, DbTokenizationFlag as TokenizationFlag, DbTotpStatus as TotpStatus, DbTransactionType as TransactionType, DbUserRoleVersion as UserRoleVersion, diff --git a/crates/diesel_models/src/payment_attempt.rs b/crates/diesel_models/src/payment_attempt.rs index 473502ad746..d438b093513 100644 --- a/crates/diesel_models/src/payment_attempt.rs +++ b/crates/diesel_models/src/payment_attempt.rs @@ -203,6 +203,7 @@ pub struct PaymentAttempt { pub processor_merchant_id: Option<id_type::MerchantId>, pub created_by: Option<String>, pub setup_future_usage_applied: Option<storage_enums::FutureUsage>, + pub routing_approach: Option<storage_enums::RoutingApproach>, } #[cfg(feature = "v1")] @@ -422,6 +423,7 @@ pub struct PaymentAttemptNew { pub processor_merchant_id: Option<id_type::MerchantId>, pub created_by: Option<String>, pub setup_future_usage_applied: Option<storage_enums::FutureUsage>, + pub routing_approach: Option<storage_enums::RoutingApproach>, } #[cfg(feature = "v1")] @@ -495,6 +497,7 @@ pub enum PaymentAttemptUpdate { order_tax_amount: Option<MinorUnit>, connector_mandate_detail: Option<ConnectorMandateReferenceId>, card_discovery: Option<storage_enums::CardDiscovery>, + routing_approach: Option<storage_enums::RoutingApproach>, }, VoidUpdate { status: storage_enums::AttemptStatus, @@ -937,6 +940,7 @@ pub struct PaymentAttemptUpdateInternal { pub issuer_error_code: Option<String>, pub issuer_error_message: Option<String>, pub setup_future_usage_applied: Option<storage_enums::FutureUsage>, + pub routing_approach: Option<storage_enums::RoutingApproach>, } #[cfg(feature = "v1")] @@ -1126,6 +1130,7 @@ impl PaymentAttemptUpdate { issuer_error_code, issuer_error_message, setup_future_usage_applied, + routing_approach, } = PaymentAttemptUpdateInternal::from(self).populate_derived_fields(&source); PaymentAttempt { amount: amount.unwrap_or(source.amount), @@ -1192,6 +1197,7 @@ impl PaymentAttemptUpdate { issuer_error_message: issuer_error_message.or(source.issuer_error_message), setup_future_usage_applied: setup_future_usage_applied .or(source.setup_future_usage_applied), + routing_approach: routing_approach.or(source.routing_approach), ..source } } @@ -2250,6 +2256,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::AuthenticationTypeUpdate { authentication_type, @@ -2312,6 +2319,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::ConfirmUpdate { amount, @@ -2348,6 +2356,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { order_tax_amount, connector_mandate_detail, card_discovery, + routing_approach, } => Self { amount: Some(amount), currency: Some(currency), @@ -2406,6 +2415,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach, }, PaymentAttemptUpdate::VoidUpdate { status, @@ -2469,6 +2479,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::RejectUpdate { status, @@ -2533,6 +2544,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::BlocklistUpdate { status, @@ -2597,6 +2609,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::ConnectorMandateDetailUpdate { connector_mandate_detail, @@ -2659,6 +2672,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::PaymentMethodDetailsUpdate { payment_method_id, @@ -2721,6 +2735,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::ResponseUpdate { status, @@ -2811,6 +2826,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied, + routing_approach: None, } } PaymentAttemptUpdate::ErrorUpdate { @@ -2892,6 +2908,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { card_discovery: None, charges: None, setup_future_usage_applied: None, + routing_approach: None, } } PaymentAttemptUpdate::StatusUpdate { status, updated_by } => Self { @@ -2952,6 +2969,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::UpdateTrackers { payment_token, @@ -3020,6 +3038,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::UnresolvedResponseUpdate { status, @@ -3095,6 +3114,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, } } PaymentAttemptUpdate::PreprocessingUpdate { @@ -3169,6 +3189,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, } } PaymentAttemptUpdate::CaptureUpdate { @@ -3233,6 +3254,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::AmountToCaptureUpdate { status, @@ -3296,6 +3318,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::ConnectorResponse { authentication_data, @@ -3368,6 +3391,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, } } PaymentAttemptUpdate::IncrementalAuthorizationAmountUpdate { @@ -3431,6 +3455,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::AuthenticationUpdate { status, @@ -3496,6 +3521,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::ManualUpdate { status, @@ -3570,6 +3596,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, } } PaymentAttemptUpdate::PostSessionTokensUpdate { @@ -3633,6 +3660,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, } } diff --git a/crates/diesel_models/src/schema.rs b/crates/diesel_models/src/schema.rs index 522ad271be9..cb690e3f602 100644 --- a/crates/diesel_models/src/schema.rs +++ b/crates/diesel_models/src/schema.rs @@ -950,6 +950,7 @@ diesel::table! { #[max_length = 255] created_by -> Nullable<Varchar>, setup_future_usage_applied -> Nullable<FutureUsage>, + routing_approach -> Nullable<RoutingApproach>, } } diff --git a/crates/diesel_models/src/user/sample_data.rs b/crates/diesel_models/src/user/sample_data.rs index 3e445bb5020..2a21bb7c404 100644 --- a/crates/diesel_models/src/user/sample_data.rs +++ b/crates/diesel_models/src/user/sample_data.rs @@ -216,6 +216,7 @@ pub struct PaymentAttemptBatchNew { pub processor_merchant_id: Option<common_utils::id_type::MerchantId>, pub created_by: Option<String>, pub setup_future_usage_applied: Option<common_enums::FutureUsage>, + pub routing_approach: Option<common_enums::RoutingApproach>, } #[cfg(feature = "v1")] @@ -301,6 +302,7 @@ impl PaymentAttemptBatchNew { processor_merchant_id: self.processor_merchant_id, created_by: self.created_by, setup_future_usage_applied: self.setup_future_usage_applied, + routing_approach: self.routing_approach, } } } diff --git a/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs b/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs index c35fbc3163e..6369c2168fe 100644 --- a/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs +++ b/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs @@ -902,6 +902,7 @@ pub struct PaymentAttempt { /// merchantwho invoked the resource based api (identifier) and through what source (Api, Jwt(Dashboard)) pub created_by: Option<CreatedBy>, pub setup_future_usage_applied: Option<storage_enums::FutureUsage>, + pub routing_approach: Option<storage_enums::RoutingApproach>, } #[cfg(feature = "v1")] @@ -1156,6 +1157,7 @@ pub struct PaymentAttemptNew { /// merchantwho invoked the resource based api (identifier) and through what source (Api, Jwt(Dashboard)) pub created_by: Option<CreatedBy>, pub setup_future_usage_applied: Option<storage_enums::FutureUsage>, + pub routing_approach: Option<storage_enums::RoutingApproach>, } #[cfg(feature = "v1")] @@ -1223,6 +1225,7 @@ pub enum PaymentAttemptUpdate { customer_acceptance: Option<pii::SecretSerdeValue>, connector_mandate_detail: Option<ConnectorMandateReferenceId>, card_discovery: Option<common_enums::CardDiscovery>, + routing_approach: Option<storage_enums::RoutingApproach>, // where all to add this one }, RejectUpdate { status: storage_enums::AttemptStatus, @@ -1481,6 +1484,7 @@ impl PaymentAttemptUpdate { customer_acceptance, connector_mandate_detail, card_discovery, + routing_approach, } => DieselPaymentAttemptUpdate::ConfirmUpdate { amount: net_amount.get_order_amount(), currency, @@ -1516,6 +1520,7 @@ impl PaymentAttemptUpdate { order_tax_amount: net_amount.get_order_tax_amount(), connector_mandate_detail, card_discovery, + routing_approach, }, Self::VoidUpdate { status, @@ -1917,6 +1922,7 @@ impl behaviour::Conversion for PaymentAttempt { connector_transaction_data: None, processor_merchant_id: Some(self.processor_merchant_id), created_by: self.created_by.map(|cb| cb.to_string()), + routing_approach: self.routing_approach, }) } @@ -2012,6 +2018,7 @@ impl behaviour::Conversion for PaymentAttempt { .created_by .and_then(|created_by| created_by.parse::<CreatedBy>().ok()), setup_future_usage_applied: storage_model.setup_future_usage_applied, + routing_approach: storage_model.routing_approach, }) } .await @@ -2100,6 +2107,7 @@ impl behaviour::Conversion for PaymentAttempt { processor_merchant_id: Some(self.processor_merchant_id), created_by: self.created_by.map(|cb| cb.to_string()), setup_future_usage_applied: self.setup_future_usage_applied, + routing_approach: self.routing_approach, }) } } diff --git a/crates/router/src/analytics.rs b/crates/router/src/analytics.rs index ffac49e7a8e..e40bce12339 100644 --- a/crates/router/src/analytics.rs +++ b/crates/router/src/analytics.rs @@ -62,6 +62,10 @@ pub mod routes { web::resource("metrics/payments") .route(web::post().to(get_merchant_payment_metrics)), ) + .service( + web::resource("metrics/routing") + .route(web::post().to(get_merchant_payment_metrics)), + ) .service( web::resource("metrics/refunds") .route(web::post().to(get_merchant_refund_metrics)), @@ -70,6 +74,10 @@ pub mod routes { web::resource("filters/payments") .route(web::post().to(get_merchant_payment_filters)), ) + .service( + web::resource("filters/routing") + .route(web::post().to(get_merchant_payment_filters)), + ) .service( web::resource("filters/frm").route(web::post().to(get_frm_filters)), ) @@ -175,6 +183,10 @@ pub mod routes { web::resource("metrics/payments") .route(web::post().to(get_merchant_payment_metrics)), ) + .service( + web::resource("metrics/routing") + .route(web::post().to(get_merchant_payment_metrics)), + ) .service( web::resource("metrics/refunds") .route(web::post().to(get_merchant_refund_metrics)), @@ -183,6 +195,10 @@ pub mod routes { web::resource("filters/payments") .route(web::post().to(get_merchant_payment_filters)), ) + .service( + web::resource("filters/routing") + .route(web::post().to(get_merchant_payment_filters)), + ) .service( web::resource("filters/refunds") .route(web::post().to(get_merchant_refund_filters)), @@ -241,6 +257,14 @@ pub mod routes { web::resource("filters/payments") .route(web::post().to(get_org_payment_filters)), ) + .service( + web::resource("metrics/routing") + .route(web::post().to(get_org_payment_metrics)), + ) + .service( + web::resource("filters/routing") + .route(web::post().to(get_org_payment_filters)), + ) .service( web::resource("metrics/refunds") .route(web::post().to(get_org_refund_metrics)), @@ -291,6 +315,14 @@ pub mod routes { web::resource("filters/payments") .route(web::post().to(get_profile_payment_filters)), ) + .service( + web::resource("metrics/routing") + .route(web::post().to(get_profile_payment_metrics)), + ) + .service( + web::resource("filters/routing") + .route(web::post().to(get_profile_payment_filters)), + ) .service( web::resource("metrics/refunds") .route(web::post().to(get_profile_refund_metrics)), diff --git a/crates/router/src/core/debit_routing.rs b/crates/router/src/core/debit_routing.rs index ca03f5d2532..4975ffc4bd1 100644 --- a/crates/router/src/core/debit_routing.rs +++ b/crates/router/src/core/debit_routing.rs @@ -306,15 +306,14 @@ where } pub async fn get_debit_routing_output< - F: Clone, - D: OperationSessionGetters<F> + OperationSessionSetters<F>, + F: Clone + Send, + D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, >( state: &SessionState, payment_data: &mut D, acquirer_country: enums::CountryAlpha2, ) -> Option<open_router::DebitRoutingOutput> { logger::debug!("Fetching sorted card networks"); - let payment_attempt = payment_data.get_payment_attempt(); let (saved_co_badged_card_data, saved_card_type, card_isin) = extract_saved_card_info(payment_data); @@ -355,9 +354,9 @@ pub async fn get_debit_routing_output< routing::perform_open_routing_for_debit_routing( state, - payment_attempt, co_badged_card_request, card_isin, + payment_data, ) .await .map_err(|error| { diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs index 59de54f41fa..f361be5a76c 100644 --- a/crates/router/src/core/payments.rs +++ b/crates/router/src/core/payments.rs @@ -7996,7 +7996,7 @@ pub async fn route_connector_v2_for_payments( .as_ref() .or(business_profile.routing_algorithm_id.as_ref()); - let connectors = routing::perform_static_routing_v1( + let (connectors, _) = routing::perform_static_routing_v1( state, merchant_context.get_merchant_account().get_id(), routing_algorithm_id, @@ -8063,7 +8063,7 @@ where algorithm_ref.algorithm_id }; - let connectors = routing::perform_static_routing_v1( + let (connectors, routing_approach) = routing::perform_static_routing_v1( state, merchant_context.get_merchant_account().get_id(), routing_algorithm_id.as_ref(), @@ -8073,6 +8073,8 @@ where .await .change_context(errors::ApiErrorResponse::InternalServerError)?; + payment_data.set_routing_approach_in_attempt(routing_approach); + #[cfg(all(feature = "v1", feature = "dynamic_routing"))] let payment_attempt = transaction_data.payment_attempt.clone(); @@ -8121,6 +8123,7 @@ where connectors.clone(), business_profile, payment_attempt, + payment_data, ) .await .map_err(|e| logger::error!(open_routing_error=?e)) @@ -8163,7 +8166,7 @@ where connectors.clone(), business_profile, dynamic_routing_config_params_interpolator, - payment_data.get_payment_attempt(), + payment_data, ) .await .map_err(|e| logger::error!(dynamic_routing_error=?e)) @@ -8240,7 +8243,7 @@ pub async fn route_connector_v1_for_payouts( algorithm_ref.algorithm_id }; - let connectors = routing::perform_static_routing_v1( + let (connectors, _) = routing::perform_static_routing_v1( state, merchant_context.get_merchant_account().get_id(), routing_algorithm_id.as_ref(), @@ -8965,6 +8968,7 @@ pub trait OperationSessionSetters<F> { &mut self, external_vault_session_details: Option<api::VaultSessionDetails>, ); + fn set_routing_approach_in_attempt(&mut self, routing_approach: Option<enums::RoutingApproach>); } #[cfg(feature = "v1")] @@ -9264,6 +9268,13 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentData<F> { fn set_vault_operation(&mut self, vault_operation: domain_payments::VaultOperation) { self.vault_operation = Some(vault_operation); } + + fn set_routing_approach_in_attempt( + &mut self, + routing_approach: Option<enums::RoutingApproach>, + ) { + self.payment_attempt.routing_approach = routing_approach; + } } #[cfg(feature = "v2")] @@ -9550,6 +9561,13 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentIntentData<F> { ) { self.vault_session_details = vault_session_details; } + + fn set_routing_approach_in_attempt( + &mut self, + routing_approach: Option<enums::RoutingApproach>, + ) { + todo!() + } } #[cfg(feature = "v2")] @@ -9839,6 +9857,13 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentConfirmData<F> { ) { todo!() } + + fn set_routing_approach_in_attempt( + &mut self, + routing_approach: Option<enums::RoutingApproach>, + ) { + todo!() + } } #[cfg(feature = "v2")] @@ -10124,6 +10149,12 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentStatusData<F> { ) { todo!() } + fn set_routing_approach_in_attempt( + &mut self, + routing_approach: Option<enums::RoutingApproach>, + ) { + todo!() + } } #[cfg(feature = "v2")] @@ -10410,6 +10441,13 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentCaptureData<F> { ) { todo!() } + + fn set_routing_approach_in_attempt( + &mut self, + routing_approach: Option<enums::RoutingApproach>, + ) { + todo!() + } } #[cfg(feature = "v2")] diff --git a/crates/router/src/core/payments/helpers.rs b/crates/router/src/core/payments/helpers.rs index 9f6e317531a..a34a169d38a 100644 --- a/crates/router/src/core/payments/helpers.rs +++ b/crates/router/src/core/payments/helpers.rs @@ -4399,6 +4399,7 @@ impl AttemptType { processor_merchant_id: old_payment_attempt.processor_merchant_id, created_by: old_payment_attempt.created_by, setup_future_usage_applied: None, + routing_approach: old_payment_attempt.routing_approach, } } diff --git a/crates/router/src/core/payments/operations/payment_confirm.rs b/crates/router/src/core/payments/operations/payment_confirm.rs index 944f2852b18..866449c74dd 100644 --- a/crates/router/src/core/payments/operations/payment_confirm.rs +++ b/crates/router/src/core/payments/operations/payment_confirm.rs @@ -1794,6 +1794,7 @@ impl<F: Clone + Sync> UpdateTracker<F, PaymentData<F>, api::PaymentsRequest> for .payment_attempt .connector_mandate_detail, card_discovery, + routing_approach: payment_data.payment_attempt.routing_approach, }, storage_scheme, ) diff --git a/crates/router/src/core/payments/operations/payment_create.rs b/crates/router/src/core/payments/operations/payment_create.rs index 68f1b9d9c15..43e9c39c566 100644 --- a/crates/router/src/core/payments/operations/payment_create.rs +++ b/crates/router/src/core/payments/operations/payment_create.rs @@ -1362,6 +1362,7 @@ impl PaymentCreate { processor_merchant_id: merchant_id.to_owned(), created_by: None, setup_future_usage_applied: request.setup_future_usage, + routing_approach: Some(common_enums::RoutingApproach::default()) }, additional_pm_data, diff --git a/crates/router/src/core/payments/retry.rs b/crates/router/src/core/payments/retry.rs index a4d1cc51518..1cc886be828 100644 --- a/crates/router/src/core/payments/retry.rs +++ b/crates/router/src/core/payments/retry.rs @@ -702,6 +702,7 @@ pub fn make_new_payment_attempt( processor_merchant_id: old_payment_attempt.processor_merchant_id, created_by: old_payment_attempt.created_by, setup_future_usage_applied: setup_future_usage_intent, // setup future usage is picked from intent for new payment attempt + routing_approach: old_payment_attempt.routing_approach, } } diff --git a/crates/router/src/core/payments/routing.rs b/crates/router/src/core/payments/routing.rs index 2ab004cccd1..ef7d1d46f53 100644 --- a/crates/router/src/core/payments/routing.rs +++ b/crates/router/src/core/payments/routing.rs @@ -59,7 +59,12 @@ use crate::core::routing::transformers::OpenRouterDecideGatewayRequestExt; use crate::routes::app::SessionStateInfo; use crate::{ core::{ - errors, errors as oss_errors, payments::routing::utils::DecisionEngineApiHandler, routing, + errors, errors as oss_errors, + payments::{ + routing::utils::DecisionEngineApiHandler, OperationSessionGetters, + OperationSessionSetters, + }, + routing, }, logger, services, types::{ @@ -432,7 +437,10 @@ pub async fn perform_static_routing_v1( algorithm_id: Option<&common_utils::id_type::RoutingId>, business_profile: &domain::Profile, transaction_data: &routing::TransactionData<'_>, -) -> RoutingResult<Vec<routing_types::RoutableConnectorChoice>> { +) -> RoutingResult<( + Vec<routing_types::RoutableConnectorChoice>, + Option<common_enums::RoutingApproach>, +)> { let algorithm_id = if let Some(id) = algorithm_id { id } else { @@ -449,7 +457,7 @@ pub async fn perform_static_routing_v1( .get_default_fallback_list_of_connector_under_profile() .change_context(errors::RoutingError::FallbackConfigFetchFailed)?; - return Ok(fallback_config); + return Ok((fallback_config, None)); }; let cached_algorithm = ensure_algorithm_cached_v1( state, @@ -503,14 +511,18 @@ pub async fn perform_static_routing_v1( logger::error!(decision_engine_euclid_evaluate_error=?e, "decision_engine_euclid: error in evaluation of rule") ).unwrap_or_default(); - let routable_connectors = match cached_algorithm.as_ref() { - CachedAlgorithm::Single(conn) => vec![(**conn).clone()], - CachedAlgorithm::Priority(plist) => plist.clone(), - CachedAlgorithm::VolumeSplit(splits) => perform_volume_split(splits.to_vec()) - .change_context(errors::RoutingError::ConnectorSelectionFailed)?, - CachedAlgorithm::Advanced(interpreter) => { - execute_dsl_and_get_connector_v1(backend_input, interpreter)? - } + let (routable_connectors, routing_approach) = match cached_algorithm.as_ref() { + CachedAlgorithm::Single(conn) => (vec![(**conn).clone()], None), + CachedAlgorithm::Priority(plist) => (plist.clone(), None), + CachedAlgorithm::VolumeSplit(splits) => ( + perform_volume_split(splits.to_vec()) + .change_context(errors::RoutingError::ConnectorSelectionFailed)?, + Some(common_enums::RoutingApproach::VolumeBasedRouting), + ), + CachedAlgorithm::Advanced(interpreter) => ( + execute_dsl_and_get_connector_v1(backend_input, interpreter)?, + Some(common_enums::RoutingApproach::RuleBasedRouting), + ), }; utils::compare_and_log_result( @@ -519,13 +531,16 @@ pub async fn perform_static_routing_v1( "evaluate_routing".to_string(), ); - Ok(utils::select_routing_result( - state, - business_profile, - routable_connectors, - de_euclid_connectors, - ) - .await) + Ok(( + utils::select_routing_result( + state, + business_profile, + routable_connectors, + de_euclid_connectors, + ) + .await, + routing_approach, + )) } async fn ensure_algorithm_cached_v1( @@ -1573,12 +1588,17 @@ pub fn make_dsl_input_for_surcharge( } #[cfg(all(feature = "v1", feature = "dynamic_routing"))] -pub async fn perform_dynamic_routing_with_open_router( +pub async fn perform_dynamic_routing_with_open_router<F, D>( state: &SessionState, routable_connectors: Vec<api_routing::RoutableConnectorChoice>, profile: &domain::Profile, payment_data: oss_storage::PaymentAttempt, -) -> RoutingResult<Vec<api_routing::RoutableConnectorChoice>> { + old_payment_data: &mut D, +) -> RoutingResult<Vec<api_routing::RoutableConnectorChoice>> +where + F: Send + Clone, + D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, +{ let dynamic_routing_algo_ref: api_routing::DynamicRoutingAlgorithmRef = profile .dynamic_routing_algorithm .clone() @@ -1610,6 +1630,7 @@ pub async fn perform_dynamic_routing_with_open_router( profile.get_id(), &payment_data, is_elimination_enabled, + old_payment_data, ) .await?; @@ -1642,12 +1663,18 @@ pub async fn perform_dynamic_routing_with_open_router( } #[cfg(feature = "v1")] -pub async fn perform_open_routing_for_debit_routing( +pub async fn perform_open_routing_for_debit_routing<F, D>( state: &SessionState, - payment_attempt: &oss_storage::PaymentAttempt, co_badged_card_request: or_types::CoBadgedCardRequest, card_isin: Option<Secret<String>>, -) -> RoutingResult<or_types::DebitRoutingOutput> { + old_payment_data: &mut D, +) -> RoutingResult<or_types::DebitRoutingOutput> +where + F: Send + Clone, + D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, +{ + let payment_attempt = old_payment_data.get_payment_attempt().clone(); + logger::debug!( "performing debit routing with open_router for profile {}", payment_attempt.profile_id.get_string_repr() @@ -1661,7 +1688,7 @@ pub async fn perform_open_routing_for_debit_routing( ); let open_router_req_body = OpenRouterDecideGatewayRequest::construct_debit_request( - payment_attempt, + &payment_attempt, metadata, card_isin, Some(or_types::RankingAlgorithm::NtwBasedRouting), @@ -1692,11 +1719,14 @@ pub async fn perform_open_routing_for_debit_routing( let output = match response { Ok(events_response) => { - let debit_routing_output = events_response - .response - .ok_or(errors::RoutingError::OpenRouterError( - "Response from decision engine API is empty".to_string(), - ))? + let response = + events_response + .response + .ok_or(errors::RoutingError::OpenRouterError( + "Response from decision engine API is empty".to_string(), + ))?; + + let debit_routing_output = response .debit_routing_output .get_required_value("debit_routing_output") .change_context(errors::RoutingError::OpenRouterError( @@ -1704,6 +1734,12 @@ pub async fn perform_open_routing_for_debit_routing( )) .attach_printable("debit_routing_output is missing in the open routing response")?; + old_payment_data.set_routing_approach_in_attempt(Some( + common_enums::RoutingApproach::from_decision_engine_approach( + &response.routing_approach, + ), + )); + Ok(debit_routing_output) } Err(error_response) => { @@ -1718,13 +1754,17 @@ pub async fn perform_open_routing_for_debit_routing( } #[cfg(all(feature = "v1", feature = "dynamic_routing"))] -pub async fn perform_dynamic_routing_with_intelligent_router( +pub async fn perform_dynamic_routing_with_intelligent_router<F, D>( state: &SessionState, routable_connectors: Vec<api_routing::RoutableConnectorChoice>, profile: &domain::Profile, dynamic_routing_config_params_interpolator: routing::helpers::DynamicRoutingConfigParamsInterpolator, - payment_attempt: &oss_storage::PaymentAttempt, -) -> RoutingResult<Vec<api_routing::RoutableConnectorChoice>> { + payment_data: &mut D, +) -> RoutingResult<Vec<api_routing::RoutableConnectorChoice>> +where + F: Send + Clone, + D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, +{ let dynamic_routing_algo_ref: api_routing::DynamicRoutingAlgorithmRef = profile .dynamic_routing_algorithm .clone() @@ -1744,6 +1784,8 @@ pub async fn perform_dynamic_routing_with_intelligent_router( profile.get_id().get_string_repr() ); + let payment_attempt = payment_data.get_payment_attempt().clone(); + let mut connector_list = match dynamic_routing_algo_ref .success_based_algorithm .as_ref() @@ -1756,6 +1798,7 @@ pub async fn perform_dynamic_routing_with_intelligent_router( &payment_attempt.payment_id, dynamic_routing_config_params_interpolator.clone(), algorithm.clone(), + payment_data, ) }) .await @@ -1779,6 +1822,7 @@ pub async fn perform_dynamic_routing_with_intelligent_router( &payment_attempt.payment_id, dynamic_routing_config_params_interpolator.clone(), algorithm.clone(), + payment_data, ) }) .await @@ -1816,13 +1860,18 @@ pub async fn perform_dynamic_routing_with_intelligent_router( #[cfg(all(feature = "v1", feature = "dynamic_routing"))] #[instrument(skip_all)] -pub async fn perform_decide_gateway_call_with_open_router( +pub async fn perform_decide_gateway_call_with_open_router<F, D>( state: &SessionState, mut routable_connectors: Vec<api_routing::RoutableConnectorChoice>, profile_id: &common_utils::id_type::ProfileId, payment_attempt: &oss_storage::PaymentAttempt, is_elimination_enabled: bool, -) -> RoutingResult<Vec<api_routing::RoutableConnectorChoice>> { + old_payment_data: &mut D, +) -> RoutingResult<Vec<api_routing::RoutableConnectorChoice>> +where + F: Send + Clone, + D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, +{ logger::debug!( "performing decide_gateway call with open_router for profile {}", profile_id.get_string_repr() @@ -1879,6 +1928,12 @@ pub async fn perform_decide_gateway_call_with_open_router( .to_string(), ); + old_payment_data.set_routing_approach_in_attempt(Some( + common_enums::RoutingApproach::from_decision_engine_approach( + &decided_gateway.routing_approach, + ), + )); + if let Some(gateway_priority_map) = decided_gateway.gateway_priority_map { logger::debug!(gateway_priority_map=?gateway_priority_map, routing_approach=decided_gateway.routing_approach, "open_router decide_gateway call response"); routable_connectors.sort_by(|connector_choice_a, connector_choice_b| { @@ -1992,7 +2047,8 @@ pub async fn update_gateway_score_with_open_router( /// success based dynamic routing #[cfg(all(feature = "v1", feature = "dynamic_routing"))] #[instrument(skip_all)] -pub async fn perform_success_based_routing( +#[allow(clippy::too_many_arguments)] +pub async fn perform_success_based_routing<F, D>( state: &SessionState, routable_connectors: Vec<api_routing::RoutableConnectorChoice>, profile_id: &common_utils::id_type::ProfileId, @@ -2000,7 +2056,12 @@ pub async fn perform_success_based_routing( payment_id: &common_utils::id_type::PaymentId, success_based_routing_config_params_interpolator: routing::helpers::DynamicRoutingConfigParamsInterpolator, success_based_algo_ref: api_routing::SuccessBasedAlgorithm, -) -> RoutingResult<Vec<api_routing::RoutableConnectorChoice>> { + payment_data: &mut D, +) -> RoutingResult<Vec<api_routing::RoutableConnectorChoice>> +where + F: Send + Clone, + D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, +{ if success_based_algo_ref.enabled_feature == api_routing::DynamicRoutingFeatures::DynamicConnectorSelection { @@ -2131,6 +2192,9 @@ pub async fn perform_success_based_routing( })?; routing_event.set_routing_approach(success_based_connectors.routing_approach.to_string()); + payment_data.set_routing_approach_in_attempt(Some(common_enums::RoutingApproach::from( + success_based_connectors.routing_approach, + ))); let mut connectors = Vec::with_capacity(success_based_connectors.labels_with_score.len()); for label_with_score in success_based_connectors.labels_with_score { @@ -2367,7 +2431,8 @@ pub async fn perform_elimination_routing( } #[cfg(all(feature = "v1", feature = "dynamic_routing"))] -pub async fn perform_contract_based_routing( +#[allow(clippy::too_many_arguments)] +pub async fn perform_contract_based_routing<F, D>( state: &SessionState, routable_connectors: Vec<api_routing::RoutableConnectorChoice>, profile_id: &common_utils::id_type::ProfileId, @@ -2375,7 +2440,12 @@ pub async fn perform_contract_based_routing( payment_id: &common_utils::id_type::PaymentId, _dynamic_routing_config_params_interpolator: routing::helpers::DynamicRoutingConfigParamsInterpolator, contract_based_algo_ref: api_routing::ContractRoutingAlgorithm, -) -> RoutingResult<Vec<api_routing::RoutableConnectorChoice>> { + payment_data: &mut D, +) -> RoutingResult<Vec<api_routing::RoutableConnectorChoice>> +where + F: Send + Clone, + D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, +{ if contract_based_algo_ref.enabled_feature == api_routing::DynamicRoutingFeatures::DynamicConnectorSelection { @@ -2528,6 +2598,10 @@ pub async fn perform_contract_based_routing( status_code: 500, })?; + payment_data.set_routing_approach_in_attempt(Some( + common_enums::RoutingApproach::ContractBasedRouting, + )); + let mut connectors = Vec::with_capacity(contract_based_connectors.labels_with_score.len()); for label_with_score in contract_based_connectors.labels_with_score { @@ -2565,6 +2639,7 @@ pub async fn perform_contract_based_routing( routing_event.set_status_code(200); routing_event.set_routable_connectors(connectors.clone()); + routing_event.set_routing_approach(api_routing::RoutingApproach::ContractBased.to_string()); state.event_handler().log_event(&routing_event); Ok(connectors) } else { diff --git a/crates/router/src/core/payments/routing/utils.rs b/crates/router/src/core/payments/routing/utils.rs index 4296fea819f..0b74273419b 100644 --- a/crates/router/src/core/payments/routing/utils.rs +++ b/crates/router/src/core/payments/routing/utils.rs @@ -1522,6 +1522,18 @@ impl RoutingApproach { } } +impl From<RoutingApproach> for common_enums::RoutingApproach { + fn from(approach: RoutingApproach) -> Self { + match approach { + RoutingApproach::Exploitation => Self::SuccessRateExploitation, + RoutingApproach::Exploration => Self::SuccessRateExploration, + RoutingApproach::ContractBased => Self::ContractBasedRouting, + RoutingApproach::StaticRouting => Self::RuleBasedRouting, + _ => Self::DefaultFallback, + } + } +} + impl std::fmt::Display for RoutingApproach { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { match self { diff --git a/crates/router/src/core/routing/helpers.rs b/crates/router/src/core/routing/helpers.rs index e73c9c5bc75..6d263eece26 100644 --- a/crates/router/src/core/routing/helpers.rs +++ b/crates/router/src/core/routing/helpers.rs @@ -54,7 +54,10 @@ use crate::{ }; #[cfg(feature = "v1")] use crate::{ - core::payments::routing::utils::{self as routing_utils, DecisionEngineApiHandler}, + core::payments::{ + routing::utils::{self as routing_utils, DecisionEngineApiHandler}, + OperationSessionGetters, OperationSessionSetters, + }, services, }; #[cfg(all(feature = "dynamic_routing", feature = "v1"))] @@ -338,11 +341,7 @@ impl RoutingDecisionData { pub fn apply_routing_decision<F, D>(&self, payment_data: &mut D) where F: Send + Clone, - D: crate::core::payments::OperationSessionGetters<F> - + crate::core::payments::OperationSessionSetters<F> - + Send - + Sync - + Clone, + D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, { match self { Self::DebitRouting(data) => data.apply_debit_routing_decision(payment_data), @@ -364,11 +363,7 @@ impl DebitRoutingDecisionData { pub fn apply_debit_routing_decision<F, D>(&self, payment_data: &mut D) where F: Send + Clone, - D: crate::core::payments::OperationSessionGetters<F> - + crate::core::payments::OperationSessionSetters<F> - + Send - + Sync - + Clone, + D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, { payment_data.set_card_network(self.card_network.clone()); self.debit_routing_result diff --git a/crates/router/src/services/kafka/payment_attempt.rs b/crates/router/src/services/kafka/payment_attempt.rs index f2c18ae9302..68f1d013517 100644 --- a/crates/router/src/services/kafka/payment_attempt.rs +++ b/crates/router/src/services/kafka/payment_attempt.rs @@ -69,6 +69,7 @@ pub struct KafkaPaymentAttempt<'a> { pub organization_id: &'a id_type::OrganizationId, pub card_network: Option<String>, pub card_discovery: Option<String>, + pub routing_approach: Option<storage_enums::RoutingApproach>, } #[cfg(feature = "v1")] @@ -130,6 +131,7 @@ impl<'a> KafkaPaymentAttempt<'a> { card_discovery: attempt .card_discovery .map(|discovery| discovery.to_string()), + routing_approach: attempt.routing_approach, } } } diff --git a/crates/router/src/services/kafka/payment_attempt_event.rs b/crates/router/src/services/kafka/payment_attempt_event.rs index e06f4e014dd..9bfc6f8c31d 100644 --- a/crates/router/src/services/kafka/payment_attempt_event.rs +++ b/crates/router/src/services/kafka/payment_attempt_event.rs @@ -70,6 +70,7 @@ pub struct KafkaPaymentAttemptEvent<'a> { pub organization_id: &'a id_type::OrganizationId, pub card_network: Option<String>, pub card_discovery: Option<String>, + pub routing_approach: Option<storage_enums::RoutingApproach>, } #[cfg(feature = "v1")] @@ -131,6 +132,7 @@ impl<'a> KafkaPaymentAttemptEvent<'a> { card_discovery: attempt .card_discovery .map(|discovery| discovery.to_string()), + routing_approach: attempt.routing_approach, } } } diff --git a/crates/router/src/types/storage/payment_attempt.rs b/crates/router/src/types/storage/payment_attempt.rs index 3a942f70e32..5289ed02af9 100644 --- a/crates/router/src/types/storage/payment_attempt.rs +++ b/crates/router/src/types/storage/payment_attempt.rs @@ -225,6 +225,7 @@ mod tests { processor_merchant_id: Default::default(), created_by: None, setup_future_usage_applied: Default::default(), + routing_approach: Default::default(), }; let store = state @@ -315,6 +316,7 @@ mod tests { processor_merchant_id: Default::default(), created_by: None, setup_future_usage_applied: Default::default(), + routing_approach: Default::default(), }; let store = state .stores @@ -418,6 +420,7 @@ mod tests { processor_merchant_id: Default::default(), created_by: None, setup_future_usage_applied: Default::default(), + routing_approach: Default::default(), }; let store = state .stores diff --git a/crates/router/src/utils/user/sample_data.rs b/crates/router/src/utils/user/sample_data.rs index 989e7db3c0c..52c3d29482e 100644 --- a/crates/router/src/utils/user/sample_data.rs +++ b/crates/router/src/utils/user/sample_data.rs @@ -381,6 +381,7 @@ pub async fn generate_sample_data( processor_merchant_id: Some(merchant_id.clone()), created_by: None, setup_future_usage_applied: None, + routing_approach: None, }; let refund = if refunds_count < number_of_refunds && !is_failed_payment { diff --git a/crates/storage_impl/src/mock_db/payment_attempt.rs b/crates/storage_impl/src/mock_db/payment_attempt.rs index feec3a1f3a9..0de343b94ea 100644 --- a/crates/storage_impl/src/mock_db/payment_attempt.rs +++ b/crates/storage_impl/src/mock_db/payment_attempt.rs @@ -235,6 +235,7 @@ impl PaymentAttemptInterface for MockDb { processor_merchant_id: payment_attempt.processor_merchant_id, created_by: payment_attempt.created_by, setup_future_usage_applied: payment_attempt.setup_future_usage_applied, + routing_approach: payment_attempt.routing_approach, }; payment_attempts.push(payment_attempt.clone()); Ok(payment_attempt) diff --git a/crates/storage_impl/src/payments/payment_attempt.rs b/crates/storage_impl/src/payments/payment_attempt.rs index db3400c5fa4..ea1552248b9 100644 --- a/crates/storage_impl/src/payments/payment_attempt.rs +++ b/crates/storage_impl/src/payments/payment_attempt.rs @@ -680,6 +680,7 @@ impl<T: DatabaseStore> PaymentAttemptInterface for KVRouterStore<T> { processor_merchant_id: payment_attempt.processor_merchant_id.clone(), created_by: payment_attempt.created_by.clone(), setup_future_usage_applied: payment_attempt.setup_future_usage_applied, + routing_approach: payment_attempt.routing_approach, }; let field = format!("pa_{}", created_attempt.attempt_id); @@ -1704,6 +1705,7 @@ impl DataModelExt for PaymentAttempt { issuer_error_code: self.issuer_error_code, issuer_error_message: self.issuer_error_message, setup_future_usage_applied: self.setup_future_usage_applied, + routing_approach: self.routing_approach, // Below fields are deprecated. Please add any new fields above this line. connector_transaction_data: None, processor_merchant_id: Some(self.processor_merchant_id), @@ -1798,6 +1800,7 @@ impl DataModelExt for PaymentAttempt { .created_by .and_then(|created_by| created_by.parse::<CreatedBy>().ok()), setup_future_usage_applied: storage_model.setup_future_usage_applied, + routing_approach: storage_model.routing_approach, } } } @@ -1887,6 +1890,7 @@ impl DataModelExt for PaymentAttemptNew { processor_merchant_id: Some(self.processor_merchant_id), created_by: self.created_by.map(|created_by| created_by.to_string()), setup_future_usage_applied: self.setup_future_usage_applied, + routing_approach: self.routing_approach, } } @@ -1969,6 +1973,7 @@ impl DataModelExt for PaymentAttemptNew { .created_by .and_then(|created_by| created_by.parse::<CreatedBy>().ok()), setup_future_usage_applied: storage_model.setup_future_usage_applied, + routing_approach: storage_model.routing_approach, } } } diff --git a/migrations/2025-06-19-124558_add_routing_approach_to_attempt/down.sql b/migrations/2025-06-19-124558_add_routing_approach_to_attempt/down.sql new file mode 100644 index 00000000000..0c6fce15b58 --- /dev/null +++ b/migrations/2025-06-19-124558_add_routing_approach_to_attempt/down.sql @@ -0,0 +1,6 @@ +-- This file should undo anything in `up.sql` + +ALTER TABLE payment_attempt +DROP COLUMN IF EXISTS routing_approach; + +DROP TYPE "RoutingApproach"; diff --git a/migrations/2025-06-19-124558_add_routing_approach_to_attempt/up.sql b/migrations/2025-06-19-124558_add_routing_approach_to_attempt/up.sql new file mode 100644 index 00000000000..f5ec97a93f3 --- /dev/null +++ b/migrations/2025-06-19-124558_add_routing_approach_to_attempt/up.sql @@ -0,0 +1,15 @@ +-- Your SQL goes here +CREATE TYPE "RoutingApproach" AS ENUM ( + 'success_rate_exploitation', + 'success_rate_exploration', + 'contract_based_routing', + 'debit_routing', + 'rule_based_routing', + 'volume_based_routing', + 'default_fallback' +); + + +ALTER TABLE payment_attempt +ADD COLUMN IF NOT EXISTS routing_approach "RoutingApproach"; + diff --git a/v2_migrations/2025-01-13-081847_drop_v1_columns/up.sql b/v2_migrations/2025-01-13-081847_drop_v1_columns/up.sql index 7913af26d66..8eac6ae97ac 100644 --- a/v2_migrations/2025-01-13-081847_drop_v1_columns/up.sql +++ b/v2_migrations/2025-01-13-081847_drop_v1_columns/up.sql @@ -93,7 +93,8 @@ ALTER TABLE payment_attempt DROP COLUMN attempt_id, DROP COLUMN charge_id, DROP COLUMN issuer_error_code, DROP COLUMN issuer_error_message, - DROP COLUMN setup_future_usage_applied; + DROP COLUMN setup_future_usage_applied, + DROP COLUMN routing_approach; ALTER TABLE payment_methods

2025-06-20T18:09:08Z

## Type of Change  - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  - Added RoutingApproach column in Payment attempt - Added RoutingApproach as a filter and dimension in payment analytics - Added routing metric endpoints DB queries - ```sql CREATE TYPE "RoutingApproach" AS ENUM ( 'success_rate_exploitation', 'success_rate_exploration', 'contract_based_routing', 'debit_routing', 'rule_based_routing', 'volume_based_routing', 'default_fallback' ); ALTER TABLE payment_attempt ADD COLUMN IF NOT EXISTS routing_approach "RoutingApproach"; ``` ### Additional Changes - [x] This PR modifies the API contract - [x] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  ## How did you test it?  ```bash curl -X GET 'http://localhost:8080/analytics/v1/org/routing/info' \ -H 'Accept: */*' \ -H 'Accept-Language: en-GB,en-US;q=0.9,en;q=0.8' \ -H 'Connection: keep-alive' \ -H 'Content-Type: application/json' \ -H 'Origin: http://localhost:9000' \ -H 'Referer: http://localhost:9000/' \ -H 'Sec-Fetch-Dest: empty' \ -H 'Sec-Fetch-Mode: cors' \ -H 'Sec-Fetch-Site: same-site' \ -H 'User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/136.0.0.0 Safari/537.36' \ -H 'X-Merchant-Id: merchant_1750414514' \ -H 'X-Profile-Id: pro_8QBK8uJG8ZHGwiZfWcAr' \ -H 'api-key: hyperswitch' \ -H 'authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiOGMzNzEwZmMtNDU3NS00NDlmLWFhNzItNWFjOWUyYmJlODViIiwibWVyY2hhbnRfaWQiOiJtZXJjaGFudF8xNzUwNDE0NTE0Iiwicm9sZV9pZCI6Im9yZ19hZG1pbiIsImV4cCI6MTc1MDg1MDY3MCwib3JnX2lkIjoib3JnX2EycGVlblVCaVNqY2dmVzNMQ2xXIiwicHJvZmlsZV9pZCI6InByb184UUJLOHVKRzhaSEd3aVpmV2NBciIsInRlbmFudF9pZCI6InB1YmxpYyJ9.wutHNAmKapYOM4kcOF0t-Lrrx-ZVFKelyFCXk_Xk8JA' \ -H 'sec-ch-ua: "Chromium";v="136", "Google Chrome";v="136", "Not.A/Brand";v="99"' \ -H 'sec-ch-ua-mobile: ?0' \ -H 'sec-ch-ua-platform: "macOS"' ``` response - ```json { "metrics": [ { "name": "payment_success_rate", "desc": "" }, { "name": "payment_count", "desc": "" }, { "name": "payment_success_count", "desc": "" }, { "name": "payment_processed_amount", "desc": "" }, { "name": "avg_ticket_size", "desc": "" }, { "name": "retries_count", "desc": "" }, { "name": "connector_success_rate", "desc": "" }, { "name": "sessionized_payment_success_rate", "desc": "" }, { "name": "sessionized_payment_count", "desc": "" }, { "name": "sessionized_payment_success_count", "desc": "" }, { "name": "sessionized_payment_processed_amount", "desc": "" }, { "name": "sessionized_avg_ticket_size", "desc": "" }, { "name": "sessionized_retries_count", "desc": "" }, { "name": "sessionized_connector_success_rate", "desc": "" }, { "name": "payments_distribution", "desc": "" }, { "name": "failure_reasons", "desc": "" } ], "downloadDimensions": null, "dimensions": [ { "name": "connector", "desc": "" }, { "name": "payment_method", "desc": "" }, { "name": "payment_method_type", "desc": "" }, { "name": "currency", "desc": "" }, { "name": "authentication_type", "desc": "" }, { "name": "status", "desc": "" }, { "name": "client_source", "desc": "" }, { "name": "client_version", "desc": "" }, { "name": "profile_id", "desc": "" }, { "name": "card_network", "desc": "" }, { "name": "merchant_id", "desc": "" }, { "name": "routing_approach", "desc": "" } ] } ``` ```bash curl -X POST http://localhost:8080/analytics/v1/org/filters/routing \ -H "Content-Type: application/json" \ -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiOGMzNzEwZmMtNDU3NS00NDlmLWFhNzItNWFjOWUyYmJlODViIiwibWVyY2hhbnRfaWQiOiJtZXJjaGFudF8xNzUwNDE0NTE0Iiwicm9sZV9pZCI6Im9yZ19hZG1pbiIsImV4cCI6MTc1MDU4NzUzMCwib3JnX2lkIjoib3JnX2EycGVlblVCaVNqY2dmVzNMQ2xXIiwicHJvZmlsZV9pZCI6InByb184UUJLOHVKRzhaSEd3aVpmV2NBciIsInRlbmFudF9pZCI6InB1YmxpYyJ9.4PuaaBWunN6wnLnm6Pxj08r9rXuuMrZ6GfYewQX9IFE" \ -d '{ "timeRange": { "startTime": "2025-06-11T18:30:00.000Z", "endTime": "2025-06-20T11:10:32.000Z" }, "groupByNames": [ "connector", "payment_method", "payment_method_type", "currency", "authentication_type", "status", "client_source", "client_version", "profile_id", "card_network", "merchant_id", "routing_approach" ], "source": "BATCH", "delta": true }' ``` ```bash curl 'http://localhost:8080/analytics/v1/org/metrics/routing' \ -H 'Accept: */*' \ -H 'Accept-Language: en-GB,en-US;q=0.9,en;q=0.8' \ -H 'Connection: keep-alive' \ -H 'Content-Type: application/json' \ -H 'Origin: http://localhost:9000' \ -H 'Referer: http://localhost:9000/' \ -H 'Sec-Fetch-Dest: empty' \ -H 'Sec-Fetch-Mode: cors' \ -H 'Sec-Fetch-Site: same-site' \ -H 'User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/136.0.0.0 Safari/537.36' \ -H 'X-Merchant-Id: merchant_1750414514' \ -H 'X-Profile-Id: pro_8QBK8uJG8ZHGwiZfWcAr' \ -H 'api-key: hyperswitch' \ -H 'authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiOGMzNzEwZmMtNDU3NS00NDlmLWFhNzItNWFjOWUyYmJlODViIiwibWVyY2hhbnRfaWQiOiJtZXJjaGFudF8xNzUwNDE0NTE0Iiwicm9sZV9pZCI6Im9yZ19hZG1pbiIsImV4cCI6MTc1MDg1MDY3MCwib3JnX2lkIjoib3JnX2EycGVlblVCaVNqY2dmVzNMQ2xXIiwicHJvZmlsZV9pZCI6InByb184UUJLOHVKRzhaSEd3aVpmV2NBciIsInRlbmFudF9pZCI6InB1YmxpYyJ9.wutHNAmKapYOM4kcOF0t-Lrrx-ZVFKelyFCXk_Xk8JA' \ -H 'sec-ch-ua: "Chromium";v="136", "Google Chrome";v="136", "Not.A/Brand";v="99"' \ -H 'sec-ch-ua-mobile: ?0' \ -H 'sec-ch-ua-platform: "macOS"' \ --data-raw '[{"timeRange":{"startTime":"2025-06-12T18:30:00Z","endTime":"2025-06-23T18:23:53Z"},"groupByNames":["routing_approach","connector"],"source":"BATCH","metrics":[ "payment_count","payment_success_rate", "payment_processed_amount"],"delta":true}]' ``` Response ```json { "queryData": [ { "payment_success_rate": null, "payment_count": null, "payment_success_count": null, "payment_processed_amount": 20400, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "currency": "USD", "status": null, "connector": "stripe", "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": "rule_based_routing", "time_range": { "start_time": "2025-06-12T18:30:00.000Z", "end_time": "2025-06-23T18:23:53.000Z" }, "time_bucket": "2025-06-12 18:30:00" }, { "payment_success_rate": null, "payment_count": null, "payment_success_count": null, "payment_processed_amount": 20300, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "currency": "USD", "status": null, "connector": "pretendpay", "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": null, "time_range": { "start_time": "2025-06-12T18:30:00.000Z", "end_time": "2025-06-23T18:23:53.000Z" }, "time_bucket": "2025-06-12 18:30:00" }, { "payment_success_rate": 100.0, "payment_count": 2, "payment_success_count": null, "payment_processed_amount": 0, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "currency": null, "status": null, "connector": "stripe", "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": "volume_based_routing", "time_range": { "start_time": "2025-06-12T18:30:00.000Z", "end_time": "2025-06-23T18:23:53.000Z" }, "time_bucket": "2025-06-12 18:30:00" }, { "payment_success_rate": 100.0, "payment_count": 2, "payment_success_count": null, "payment_processed_amount": 0, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "currency": null, "status": null, "connector": "stripe", "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": "rule_based_routing", "time_range": { "start_time": "2025-06-12T18:30:00.000Z", "end_time": "2025-06-23T18:23:53.000Z" }, "time_bucket": "2025-06-12 18:30:00" }, { "payment_success_rate": null, "payment_count": null, "payment_success_count": null, "payment_processed_amount": 10200, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "currency": "USD", "status": null, "connector": "stripe", "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": "default_fallback", "time_range": { "start_time": "2025-06-12T18:30:00.000Z", "end_time": "2025-06-23T18:23:53.000Z" }, "time_bucket": "2025-06-12 18:30:00" }, { "payment_success_rate": 100.0, "payment_count": 4, "payment_success_count": null, "payment_processed_amount": 0, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "currency": null, "status": null, "connector": "stripe", "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": null, "time_range": { "start_time": "2025-06-12T18:30:00.000Z", "end_time": "2025-06-23T18:23:53.000Z" }, "time_bucket": "2025-06-12 18:30:00" }, { "payment_success_rate": 0.0, "payment_count": 12, "payment_success_count": null, "payment_processed_amount": 0, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "currency": null, "status": null, "connector": null, "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": null, "time_range": { "start_time": "2025-06-12T18:30:00.000Z", "end_time": "2025-06-23T18:23:53.000Z" }, "time_bucket": "2025-06-12 18:30:00" }, { "payment_success_rate": 0.0, "payment_count": 6, "payment_success_count": null, "payment_processed_amount": 0, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "currency": null, "status": null, "connector": null, "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": "rule_based_routing", "time_range": { "start_time": "2025-06-12T18:30:00.000Z", "end_time": "2025-06-23T18:23:53.000Z" }, "time_bucket": "2025-06-12 18:30:00" }, { "payment_success_rate": null, "payment_count": null, "payment_success_count": null, "payment_processed_amount": 20000, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "currency": "USD", "status": null, "connector": "stripe", "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": "volume_based_routing", "time_range": { "start_time": "2025-06-12T18:30:00.000Z", "end_time": "2025-06-23T18:23:53.000Z" }, "time_bucket": "2025-06-12 18:30:00" }, { "payment_success_rate": null, "payment_count": null, "payment_success_count": null, "payment_processed_amount": 40000, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "currency": "USD", "status": null, "connector": "stripe", "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": null, "time_range": { "start_time": "2025-06-12T18:30:00.000Z", "end_time": "2025-06-23T18:23:53.000Z" }, "time_bucket": "2025-06-12 18:30:00" }, { "payment_success_rate": 100.0, "payment_count": 2, "payment_success_count": null, "payment_processed_amount": 0, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "currency": null, "status": null, "connector": "pretendpay", "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": null, "time_range": { "start_time": "2025-06-12T18:30:00.000Z", "end_time": "2025-06-23T18:23:53.000Z" }, "time_bucket": "2025-06-12 18:30:00" }, { "payment_success_rate": 100.0, "payment_count": 1, "payment_success_count": null, "payment_processed_amount": 0, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "currency": null, "status": null, "connector": "stripe", "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": "default_fallback", "time_range": { "start_time": "2025-06-12T18:30:00.000Z", "end_time": "2025-06-23T18:23:53.000Z" }, "time_bucket": "2025-06-12 18:30:00" } ], "metaData": [ { "total_payment_processed_amount": 110900, "total_payment_processed_amount_in_usd": null, "total_payment_processed_amount_without_smart_retries": 0, "total_payment_processed_amount_without_smart_retries_usd": null, "total_payment_processed_count": 0, "total_payment_processed_count_without_smart_retries": 0, "total_failure_reasons_count": 0, "total_failure_reasons_count_without_smart_retries": 0 } ] } ``` ## Checklist  - [ ] I formatted the code `cargo +nightly fmt --all` - [ ] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.114.0

0851c6ece574ce961830c14d91e6e2040cb3b286

juspay/hyperswitch

juspay__hyperswitch-8406

Bug: Fix payment redirects for v2 Fix payment redirects for v2

diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs index 59de54f41fa..e3fdf6e1cac 100644 --- a/crates/router/src/core/payments.rs +++ b/crates/router/src/core/payments.rs @@ -2996,7 +2996,7 @@ impl PaymentRedirectFlow for PaymentRedirectSync { force_sync: true, expand_attempts: false, all_keys_required: None, - merchant_connector_details: todo!(), // TODO: Implement for connectors requiring 3DS or redirection-based authentication flows. + merchant_connector_details: None, // TODO: Implement for connectors requiring 3DS or redirection-based authentication flows. }; let operation = operations::PaymentGet;

2025-06-20T11:02:47Z

## Type of Change  - [x] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  This PR fixes payment redirects in v2. This was due to the field merchant_connector_details set as todo!() ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  ## How did you test it?  - Make 3DS payment ``` curl --location 'http://localhost:8080/v2/payments' \ --header 'Content-Type: application/json' \ --header 'x-profile-id: pro_295oknnkIU8LhiO6RTCy' \ --header 'Authorization: api-key=dev_8OKnwsVtu4ZIxxgqDfVQwnQrUfdORX3Ivo9i8Yxp0rB3mEZxiv9UZchQimjPgNnx' \ --data-raw '{ "amount_details": { "currency": "USD", "order_amount": 6540 }, "authentication_type": "three_ds", "payment_method_data": { "card": { "card_cvc": "123", "card_exp_month": "10", "card_exp_year": "25", "card_holder_name": "joseph Doe", "card_number": "4242424242424242" } }, "payment_method_subtype": "credit", "payment_method_type": "card" }' ``` Response ``` { "id": "12345_pay_01978cfda5fa7c12b1ba298cca0470c2", "status": "requires_customer_action", "amount": { "order_amount": 6540, "currency": "USD", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null, "net_amount": 6540, "amount_to_capture": null, "amount_capturable": 0, "amount_captured": null }, "customer_id": null, "connector": "stripe", "created": "2025-06-20T10:58:42.813Z", "payment_method_data": { "billing": null }, "payment_method_type": "card", "payment_method_subtype": "credit", "connector_transaction_id": "pi_3Rc2edD5R7gDAGff01vwkClL", "connector_reference_id": null, "merchant_connector_id": "mca_0GI0dABwex0qdnwlUelt", "browser_info": null, "error": null, "shipping": null, "billing": null, "attempts": null, "connector_token_details": { "token": "pm_1Rc2edD5R7gDAGffEOosatGV", "connector_token_request_reference_id": "eDuVwDClp0zQPbbkLZ" }, "payment_method_id": null, "next_action": { "type": "redirect_to_url", "redirect_to_url": "http://localhost:8080/v2/payments/12345_pay_01978cfda5fa7c12b1ba298cca0470c2/start-redirection?publishable_key=pk_dev_4499ca4660714d6b83b379218164187a&profile_id=pro_295oknnkIU8LhiO6RTCy" }, "return_url": "https://google.com/success", "authentication_type": "three_ds", "authentication_type_applied": "three_ds", "is_iframe_redirection_enabled": null, "merchant_reference_id": null } ``` Redirect to URL - Payments Sync ``` curl --location 'http://localhost:8080/v2/payments/12345_pay_01978cfda5fa7c12b1ba298cca0470c2?force_sync=true' \ --header 'x-profile-id: pro_295oknnkIU8LhiO6RTCy' \ --header 'Authorization: api-key=dev_8OKnwsVtu4ZIxxgqDfVQwnQrUfdORX3Ivo9i8Yxp0rB3mEZxiv9UZchQimjPgNnx' \ --data '' ``` Response ``` { "id": "12345_pay_01978cfda5fa7c12b1ba298cca0470c2", "status": "succeeded", "amount": { "order_amount": 6540, "currency": "USD", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null, "net_amount": 6540, "amount_to_capture": null, "amount_capturable": 0, "amount_captured": 6540 }, "customer_id": null, "connector": "stripe", "created": "2025-06-20T10:58:42.813Z", "payment_method_data": { "billing": null }, "payment_method_type": "card", "payment_method_subtype": "credit", "connector_transaction_id": "pi_3Rc2edD5R7gDAGff01vwkClL", "connector_reference_id": null, "merchant_connector_id": "mca_0GI0dABwex0qdnwlUelt", "browser_info": null, "error": null, "shipping": null, "billing": null, "attempts": null, "connector_token_details": { "token": "pm_1Rc2edD5R7gDAGffEOosatGV", "connector_token_request_reference_id": "eDuVwDClp0zQPbbkLZ" }, "payment_method_id": null, "next_action": null, "return_url": "https://google.com/success", "authentication_type": "three_ds", "authentication_type_applied": null, "is_iframe_redirection_enabled": null, "merchant_reference_id": null } ``` ## Checklist  - [ ] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.114.0

c99ec73885e0c64552f01826b20a1af7a934a65c

juspay/hyperswitch

juspay__hyperswitch-8394

Bug: feat(revenue_recovery): Invoke attempt list instead of payment get in recovery webhooks flow Previously we were using payment get to find whether attempt is present in db or not, but for the first invoice webhook there won't be any attempt present in db and recently we added a validation to use payment get only in case of attempt is present. Also for stripe billing / stripe connector_transaction_id remains same instead charge id keeps changing , so we need to add support for this by checking if charge id is present we compare charge id if not we check for connector transaction id.

diff --git a/api-reference/README.md b/api-reference/README.md index b0343f44e62..ef3537d6b73 100644 --- a/api-reference/README.md +++ b/api-reference/README.md @@ -45,4 +45,4 @@ npx @mintlify/scraping@latest openapi-file v1/openapi_spec_v1.json -o v1 This will generate files in [api-reference](api-reference) folder. These routes should be added to the [mint.json](mint.json) file under navigation, under respective group. -NOTE: For working with V2 API reference, replace every occurence of `v1` with `v2` in above commands \ No newline at end of file +NOTE: For working with V2 API reference, replace every occurrence of `v1` with `v2` in above commands \ No newline at end of file diff --git a/api-reference/v2/openapi_spec_v2.json b/api-reference/v2/openapi_spec_v2.json index b213d96accd..853b0c3c5b5 100644 --- a/api-reference/v2/openapi_spec_v2.json +++ b/api-reference/v2/openapi_spec_v2.json @@ -15711,6 +15711,11 @@ } ], "nullable": true + }, + "charge_id": { + "type": "string", + "example": "ch_123abc456def789ghi012klmn", + "nullable": true } } }, diff --git a/crates/api_models/src/payments.rs b/crates/api_models/src/payments.rs index cb5480ed1f4..25e85c3f90c 100644 --- a/crates/api_models/src/payments.rs +++ b/crates/api_models/src/payments.rs @@ -1668,6 +1668,9 @@ pub struct PaymentAttemptRevenueRecoveryData { /// Flag to find out whether an attempt was created by external or internal system. #[schema(value_type = Option<TriggeredBy>, example = "internal")] pub attempt_triggered_by: common_enums::TriggeredBy, + // stripe specific field used to identify duplicate attempts. + #[schema(value_type = Option<String>, example = "ch_123abc456def789ghi012klmn")] + pub charge_id: Option<String>, } #[derive( @@ -5812,22 +5815,34 @@ pub struct PaymentsResponse { } #[cfg(feature = "v2")] -impl PaymentsResponse { +impl PaymentAttemptListResponse { pub fn find_attempt_in_attempts_list_using_connector_transaction_id( - self, + &self, connector_transaction_id: &common_utils::types::ConnectorTransactionId, ) -> Option<PaymentAttemptResponse> { - self.attempts - .as_ref() - .and_then(|attempts| { - attempts.iter().find(|attempt| { - attempt - .connector_payment_id + self.payment_attempt_list.iter().find_map(|attempt| { + attempt + .connector_payment_id + .as_ref() + .filter(|txn_id| *txn_id == connector_transaction_id) + .map(|_| attempt.clone()) + }) + } + pub fn find_attempt_in_attempts_list_using_charge_id( + &self, + charge_id: String, + ) -> Option<PaymentAttemptResponse> { + self.payment_attempt_list.iter().find_map(|attempt| { + attempt.feature_metadata.as_ref().and_then(|metadata| { + metadata.revenue_recovery.as_ref().and_then(|recovery| { + recovery + .charge_id .as_ref() - .is_some_and(|txn_id| txn_id == connector_transaction_id) + .filter(|id| **id == charge_id) + .map(|_| attempt.clone()) }) }) - .cloned() + }) } } diff --git a/crates/diesel_models/src/payment_attempt.rs b/crates/diesel_models/src/payment_attempt.rs index fa373d2305b..473502ad746 100644 --- a/crates/diesel_models/src/payment_attempt.rs +++ b/crates/diesel_models/src/payment_attempt.rs @@ -3708,6 +3708,8 @@ pub struct PaymentAttemptFeatureMetadata { #[diesel(sql_type = diesel::pg::sql_types::Jsonb)] pub struct PaymentAttemptRecoveryData { pub attempt_triggered_by: common_enums::TriggeredBy, + // stripe specific field used to identify duplicate attempts. + pub charge_id: Option<String>, } #[cfg(feature = "v2")] common_utils::impl_to_sql_from_sql_json!(PaymentAttemptFeatureMetadata); diff --git a/crates/hyperswitch_connectors/src/connectors/chargebee/transformers.rs b/crates/hyperswitch_connectors/src/connectors/chargebee/transformers.rs index 6436cd952e7..e0c84b4b459 100644 --- a/crates/hyperswitch_connectors/src/connectors/chargebee/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/chargebee/transformers.rs @@ -509,6 +509,8 @@ impl TryFrom<ChargebeeWebhookBody> for revenue_recovery::RevenueRecoveryAttemptD invoice_next_billing_time, card_network: Some(payment_method_details.card.brand), card_isin: Some(payment_method_details.card.iin), + // This field is none because it is specific to stripebilling. + charge_id: None, }) } } diff --git a/crates/hyperswitch_connectors/src/connectors/recurly/transformers.rs b/crates/hyperswitch_connectors/src/connectors/recurly/transformers.rs index 9ffd900dc45..70edb327ded 100644 --- a/crates/hyperswitch_connectors/src/connectors/recurly/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/recurly/transformers.rs @@ -208,6 +208,8 @@ impl ), card_network: Some(item.response.payment_method.card_type), card_isin: Some(item.response.payment_method.first_six), + // This none because this field is specific to stripebilling. + charge_id: None, }, ), ..item.data diff --git a/crates/hyperswitch_connectors/src/connectors/stripebilling/transformers.rs b/crates/hyperswitch_connectors/src/connectors/stripebilling/transformers.rs index 1352b874c8a..ca0875ba4ce 100644 --- a/crates/hyperswitch_connectors/src/connectors/stripebilling/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/stripebilling/transformers.rs @@ -561,6 +561,7 @@ impl )), // Todo: Fetch Card issuer details. Generally in the other billing connector we are getting card_issuer using the card bin info. But stripe dosent provide any such details. We should find a way for stripe billing case card_isin: None, + charge_id: Some(charge_details.charge_id.clone()), }, ), ..item.data diff --git a/crates/hyperswitch_domain_models/src/payments.rs b/crates/hyperswitch_domain_models/src/payments.rs index 99ce4ca17f3..25e194ca391 100644 --- a/crates/hyperswitch_domain_models/src/payments.rs +++ b/crates/hyperswitch_domain_models/src/payments.rs @@ -746,6 +746,8 @@ impl PaymentIntent { invoice_next_billing_time: None, card_isin: None, card_network: None, + // No charge id is present here since it is an internal payment and we didn't call connector yet. + charge_id: None, }) } diff --git a/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs b/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs index 56e0942431c..c35fbc3163e 100644 --- a/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs +++ b/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs @@ -726,6 +726,12 @@ impl PaymentAttempt { revenue_recovery: Some({ PaymentAttemptRevenueRecoveryData { attempt_triggered_by: request.triggered_by, + charge_id: request.feature_metadata.as_ref().and_then(|metadata| { + metadata + .revenue_recovery + .as_ref() + .and_then(|data| data.charge_id.clone()) + }), } }), }; @@ -2781,6 +2787,8 @@ pub struct PaymentAttemptFeatureMetadata { #[derive(Debug, Clone, serde::Serialize, PartialEq)] pub struct PaymentAttemptRevenueRecoveryData { pub attempt_triggered_by: common_enums::TriggeredBy, + // stripe specific field used to identify duplicate attempts. + pub charge_id: Option<String>, } #[cfg(feature = "v2")] @@ -2791,6 +2799,7 @@ impl From<&PaymentAttemptFeatureMetadata> for DieselPaymentAttemptFeatureMetadat .as_ref() .map(|recovery_data| DieselPassiveChurnRecoveryData { attempt_triggered_by: recovery_data.attempt_triggered_by, + charge_id: recovery_data.charge_id.clone(), }); Self { revenue_recovery } } @@ -2803,6 +2812,7 @@ impl From<DieselPaymentAttemptFeatureMetadata> for PaymentAttemptFeatureMetadata item.revenue_recovery .map(|recovery_data| PaymentAttemptRevenueRecoveryData { attempt_triggered_by: recovery_data.attempt_triggered_by, + charge_id: recovery_data.charge_id, }); Self { revenue_recovery } } diff --git a/crates/hyperswitch_domain_models/src/revenue_recovery.rs b/crates/hyperswitch_domain_models/src/revenue_recovery.rs index 837d5d90839..0485644628a 100644 --- a/crates/hyperswitch_domain_models/src/revenue_recovery.rs +++ b/crates/hyperswitch_domain_models/src/revenue_recovery.rs @@ -52,6 +52,8 @@ pub struct RevenueRecoveryAttemptData { pub card_network: Option<common_enums::CardNetwork>, /// card isin pub card_isin: Option<String>, + /// stripe specific id used to validate duplicate attempts in revenue recovery flow + pub charge_id: Option<String>, } /// This is unified struct for Revenue Recovery Invoice Data and it is constructed from billing connectors @@ -278,6 +280,7 @@ impl invoice_next_billing_time: invoice_details.next_billing_at, card_network: billing_connector_payment_details.card_network.clone(), card_isin: billing_connector_payment_details.card_isin.clone(), + charge_id: billing_connector_payment_details.charge_id.clone(), } } } diff --git a/crates/hyperswitch_domain_models/src/router_response_types/revenue_recovery.rs b/crates/hyperswitch_domain_models/src/router_response_types/revenue_recovery.rs index 8dd6aa2e74c..3df81e6b66d 100644 --- a/crates/hyperswitch_domain_models/src/router_response_types/revenue_recovery.rs +++ b/crates/hyperswitch_domain_models/src/router_response_types/revenue_recovery.rs @@ -32,6 +32,8 @@ pub struct BillingConnectorPaymentsSyncResponse { pub card_network: Option<common_enums::CardNetwork>, /// card isin pub card_isin: Option<String>, + /// stripe specific id used to validate duplicate attempts. + pub charge_id: Option<String>, } #[derive(Debug, Clone)] diff --git a/crates/router/src/core/payments/transformers.rs b/crates/router/src/core/payments/transformers.rs index 5d40a603cbb..65f526af2e3 100644 --- a/crates/router/src/core/payments/transformers.rs +++ b/crates/router/src/core/payments/transformers.rs @@ -4989,6 +4989,7 @@ impl let revenue_recovery = feature_metadata.revenue_recovery.as_ref().map(|recovery| { api_models::payments::PaymentAttemptRevenueRecoveryData { attempt_triggered_by: recovery.attempt_triggered_by, + charge_id: recovery.charge_id.clone(), } }); Self { revenue_recovery } diff --git a/crates/router/src/core/routing/helpers.rs b/crates/router/src/core/routing/helpers.rs index 1dd965a71ce..666d0020260 100644 --- a/crates/router/src/core/routing/helpers.rs +++ b/crates/router/src/core/routing/helpers.rs @@ -1539,7 +1539,7 @@ pub async fn push_metrics_with_update_window_for_contract_based_routing( routing_events::RoutingEngine::IntelligentRouter, routing_events::ApiMethod::Grpc) .change_context(errors::ApiErrorResponse::InternalServerError) - .attach_printable("ContractRouting-Intelligent-Router: Failed to contruct RoutingEventsBuilder")? + .attach_printable("ContractRouting-Intelligent-Router: Failed to construct RoutingEventsBuilder")? .trigger_event(state, closure) .await .change_context(errors::ApiErrorResponse::InternalServerError) diff --git a/crates/router/src/core/webhooks/recovery_incoming.rs b/crates/router/src/core/webhooks/recovery_incoming.rs index cc4e08861ac..f13caeefb76 100644 --- a/crates/router/src/core/webhooks/recovery_incoming.rs +++ b/crates/router/src/core/webhooks/recovery_incoming.rs @@ -467,45 +467,49 @@ impl RevenueRecoveryAttempt { )>, errors::RevenueRecoveryError, > { - let attempt_response = Box::pin(payments::payments_core::< - router_flow_types::payments::PSync, - api_payments::PaymentsResponse, - _, - _, - _, - hyperswitch_domain_models::payments::PaymentStatusData< - router_flow_types::payments::PSync, - >, - >( - state.clone(), - req_state.clone(), - merchant_context.clone(), - profile.clone(), - payments::operations::PaymentGet, - api_payments::PaymentsRetrieveRequest { - force_sync: false, - expand_attempts: true, - param: None, - all_keys_required: None, - merchant_connector_details: None, - }, - payment_intent.payment_id.clone(), - payments::CallConnectorAction::Avoid, - hyperswitch_domain_models::payments::HeaderPayload::default(), - )) - .await; + let attempt_response = + Box::pin(payments::payments_list_attempts_using_payment_intent_id::< + payments::operations::PaymentGetListAttempts, + api_payments::PaymentAttemptListResponse, + _, + payments::operations::payment_attempt_list::PaymentGetListAttempts, + hyperswitch_domain_models::payments::PaymentAttemptListData< + payments::operations::PaymentGetListAttempts, + >, + >( + state.clone(), + req_state.clone(), + merchant_context.clone(), + profile.clone(), + payments::operations::PaymentGetListAttempts, + api_payments::PaymentAttemptListRequest { + payment_intent_id: payment_intent.payment_id.clone(), + }, + payment_intent.payment_id.clone(), + hyperswitch_domain_models::payments::HeaderPayload::default(), + )) + .await; let response = match attempt_response { Ok(services::ApplicationResponse::JsonWithHeaders((payments_response, _))) => { - let final_attempt = - self.0 - .connector_transaction_id - .as_ref() - .and_then(|transaction_id| { - payments_response - .find_attempt_in_attempts_list_using_connector_transaction_id( - transaction_id, - ) - }); + let final_attempt = self + .0 + .charge_id + .as_ref() + .map(|charge_id| { + payments_response + .find_attempt_in_attempts_list_using_charge_id(charge_id.clone()) + }) + .unwrap_or_else(|| { + self.0 + .connector_transaction_id + .as_ref() + .and_then(|transaction_id| { + payments_response + .find_attempt_in_attempts_list_using_connector_transaction_id( + transaction_id, + ) + }) + }); let payment_attempt = final_attempt.map(|attempt_res| revenue_recovery::RecoveryPaymentAttempt { attempt_id: attempt_res.id.to_owned(), @@ -613,6 +617,7 @@ impl RevenueRecoveryAttempt { revenue_recovery: Some(api_payments::PaymentAttemptRevenueRecoveryData { // Since we are recording the external paymenmt attempt, this is hardcoded to External attempt_triggered_by: triggered_by, + charge_id: self.0.charge_id.clone(), }), };

2025-06-19T17:51:05Z

## Type of Change  - [x] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  Previously we were using payment get to find whether attempt is present in db or not, but for the first invoice webhook there won't be any attempt present in db and recently we added a validation to use payment get only in case of attempt is present. This PR solves this issue by invoking payment get attempt list instead of payment get. Also for stripe billing / stripe connector_transaction_id remains same instead charge id keeps changing , so we added a support for this by checking if charge id is present we compare charge id if not we check for connector transaction id. ### Additional Changes - [x] This PR modifies the API contract - [x] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  ## How did you test it?  Tested complete revenue recovery flow with stripebilling 1) Set up merchant and mca for billing and payment connector for stripebilling and stripe 2) Make sure merchant have retry_algorithm_type to cascading in business profile 3) Trigger payment invoice from stripe, after threshold external attempts , pt entry should be done in and start triggering internal payments. ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.114.0

7943fb4bfb156e22d5329d45a580f90e02283604

juspay/hyperswitch

juspay__hyperswitch-8398

Bug: [FEATURE] [AUTHIPAY] Integrate cards non-3ds payments ### Feature Description cards non-3ds payments needs to be integrated for authipay ### Possible Implementation cards non-3ds payments needs to be integrated for authipay ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? None

diff --git a/api-reference/v1/openapi_spec_v1.json b/api-reference/v1/openapi_spec_v1.json index 940922743ca..d748f65261a 100644 --- a/api-reference/v1/openapi_spec_v1.json +++ b/api-reference/v1/openapi_spec_v1.json @@ -10916,6 +10916,7 @@ "Connector": { "type": "string", "enum": [ + "authipay", "adyenplatform", "stripe_billing_test", "phonypay", @@ -27926,6 +27927,7 @@ "type": "string", "description": "RoutableConnectors are the subset of Connectors that are eligible for payments routing", "enum": [ + "authipay", "adyenplatform", "stripe_billing_test", "phonypay", diff --git a/api-reference/v2/openapi_spec_v2.json b/api-reference/v2/openapi_spec_v2.json index 12340ea5dcb..53bbace7dfb 100644 --- a/api-reference/v2/openapi_spec_v2.json +++ b/api-reference/v2/openapi_spec_v2.json @@ -8123,6 +8123,7 @@ "Connector": { "type": "string", "enum": [ + "authipay", "adyenplatform", "stripe_billing_test", "phonypay", @@ -22643,6 +22644,7 @@ "type": "string", "description": "RoutableConnectors are the subset of Connectors that are eligible for payments routing", "enum": [ + "authipay", "adyenplatform", "stripe_billing_test", "phonypay", diff --git a/config/config.example.toml b/config/config.example.toml index 10f796128f7..2b1916d41c2 100644 --- a/config/config.example.toml +++ b/config/config.example.toml @@ -189,6 +189,7 @@ airwallex.base_url = "https://api-demo.airwallex.com/" amazonpay.base_url = "https://pay-api.amazon.com/v2" applepay.base_url = "https://apple-pay-gateway.apple.com/" archipel.base_url = "https://{{merchant_endpoint_prefix}}/ArchiPEL/Transaction/v1" +authipay.base_url = "https://prod.emea.api.fiservapps.com/sandbox/ipp/payments-gateway/v2" authorizedotnet.base_url = "https://apitest.authorize.net/xml/v1/request.api" bambora.base_url = "https://api.na.bambora.com" bamboraapac.base_url = "https://demo.ippayments.com.au/interface/api" @@ -343,6 +344,7 @@ cards = [ "adyen", "adyenplatform", "archipel", + "authipay", "authorizedotnet", "celero", "coinbase", diff --git a/config/deployments/integration_test.toml b/config/deployments/integration_test.toml index 803047dca2e..f839aabbf60 100644 --- a/config/deployments/integration_test.toml +++ b/config/deployments/integration_test.toml @@ -28,6 +28,7 @@ airwallex.base_url = "https://api-demo.airwallex.com/" amazonpay.base_url = "https://pay-api.amazon.com/v2" applepay.base_url = "https://apple-pay-gateway.apple.com/" archipel.base_url = "https://{{merchant_endpoint_prefix}}/ArchiPEL/Transaction/v1" +authipay.base_url = "https://prod.emea.api.fiservapps.com/sandbox/ipp/payments-gateway/v2/" authorizedotnet.base_url = "https://apitest.authorize.net/xml/v1/request.api" bambora.base_url = "https://api.na.bambora.com" bamboraapac.base_url = "https://demo.ippayments.com.au/interface/api" diff --git a/config/deployments/production.toml b/config/deployments/production.toml index 94d8f18d44d..36f80248f9b 100644 --- a/config/deployments/production.toml +++ b/config/deployments/production.toml @@ -32,6 +32,7 @@ airwallex.base_url = "https://api.airwallex.com/" amazonpay.base_url = "https://pay-api.amazon.com/v2" applepay.base_url = "https://apple-pay-gateway.apple.com/" archipel.base_url = "https://{{merchant_endpoint_prefix}}/ArchiPEL/Transaction/v1" +authipay.base_url = "https://prod.emea.api.fiservapps.com/ipp/payments-gateway/v2/" authorizedotnet.base_url = "https://api.authorize.net/xml/v1/request.api" bambora.base_url = "https://api.na.bambora.com" bamboraapac.base_url = "https://www.bambora.co.nz/interface/api/dts.asmx" diff --git a/config/deployments/sandbox.toml b/config/deployments/sandbox.toml index 99daaab178d..3018fb176d0 100644 --- a/config/deployments/sandbox.toml +++ b/config/deployments/sandbox.toml @@ -32,6 +32,7 @@ airwallex.base_url = "https://api-demo.airwallex.com/" amazonpay.base_url = "https://pay-api.amazon.com/v2" applepay.base_url = "https://apple-pay-gateway.apple.com/" archipel.base_url = "https://{{merchant_endpoint_prefix}}/ArchiPEL/Transaction/v1" +authipay.base_url = "https://prod.emea.api.fiservapps.com/sandbox/ipp/payments-gateway/v2" authorizedotnet.base_url = "https://apitest.authorize.net/xml/v1/request.api" bambora.base_url = "https://api.na.bambora.com" bamboraapac.base_url = "https://demo.ippayments.com.au/interface/api" diff --git a/config/development.toml b/config/development.toml index b72f7bcbaee..8808aabb0ef 100644 --- a/config/development.toml +++ b/config/development.toml @@ -99,6 +99,7 @@ cards = [ "airwallex", "amazonpay", "archipel", + "authipay", "authorizedotnet", "bambora", "bamboraapac", @@ -227,6 +228,7 @@ airwallex.base_url = "https://api-demo.airwallex.com/" amazonpay.base_url = "https://pay-api.amazon.com/v2" applepay.base_url = "https://apple-pay-gateway.apple.com/" archipel.base_url = "https://{{merchant_endpoint_prefix}}/ArchiPEL/Transaction/v1" +authipay.base_url = "https://prod.emea.api.fiservapps.com/sandbox/ipp/payments-gateway/v2/" authorizedotnet.base_url = "https://apitest.authorize.net/xml/v1/request.api" bambora.base_url = "https://api.na.bambora.com" bamboraapac.base_url = "https://demo.ippayments.com.au/interface/api" diff --git a/config/docker_compose.toml b/config/docker_compose.toml index ef3ad0b1b05..b232636421f 100644 --- a/config/docker_compose.toml +++ b/config/docker_compose.toml @@ -115,6 +115,7 @@ airwallex.base_url = "https://api-demo.airwallex.com/" amazonpay.base_url = "https://pay-api.amazon.com/v2" applepay.base_url = "https://apple-pay-gateway.apple.com/" archipel.base_url = "https://{{merchant_endpoint_prefix}}/ArchiPEL/Transaction/v1" +authipay.base_url = "https://prod.emea.api.fiservapps.com/sandbox/ipp/payments-gateway/v2/" authorizedotnet.base_url = "https://apitest.authorize.net/xml/v1/request.api" bambora.base_url = "https://api.na.bambora.com" bamboraapac.base_url = "https://demo.ippayments.com.au/interface/api" @@ -251,6 +252,7 @@ cards = [ "airwallex", "amazonpay", "archipel", + "authipay", "authorizedotnet", "bambora", "bamboraapac", diff --git a/config/payment_required_fields_v2.toml b/config/payment_required_fields_v2.toml index cc9ffee29e2..fe1e6e050d2 100644 --- a/config/payment_required_fields_v2.toml +++ b/config/payment_required_fields_v2.toml @@ -47,6 +47,14 @@ common = [ { required_field = "payment_method_data.billing.address.last_name", display_name = "card_holder_name", field_type = "user_full_name" } ] +[required_fields.Card.Debit.fields.Authipay] +common = [ + { required_field = "payment_method_data.card.card_number", display_name = "card_number", field_type = "user_card_number" }, + { required_field = "payment_method_data.card.card_exp_month", display_name = "card_exp_month", field_type = "user_card_expiry_month" }, + { required_field = "payment_method_data.card.card_exp_year", display_name = "card_exp_year", field_type = "user_card_expiry_year" }, + { required_field = "payment_method_data.card.card_cvc", display_name = "card_cvc", field_type = "user_card_cvc" } +] + [required_fields.Card.Debit.fields.Bambora] non_mandate = [ { required_field = "payment_method_data.card.card_number", display_name = "card_number", field_type = "user_card_number" }, @@ -546,6 +554,14 @@ common = [ { required_field = "payment_method_data.card.card_cvc", display_name = "card_cvc", field_type = "user_card_cvc" } ] +[required_fields.Card.Credit.fields.Authipay] +common = [ + { required_field = "payment_method_data.card.card_number", display_name = "card_number", field_type = "user_card_number" }, + { required_field = "payment_method_data.card.card_exp_month", display_name = "card_exp_month", field_type = "user_card_expiry_month" }, + { required_field = "payment_method_data.card.card_exp_year", display_name = "card_exp_year", field_type = "user_card_expiry_year" }, + { required_field = "payment_method_data.card.card_cvc", display_name = "card_cvc", field_type = "user_card_cvc" } +] + [required_fields.Card.Credit.fields.Bambora] non_mandate = [ { required_field = "payment_method_data.card.card_number", display_name = "card_number", field_type = "user_card_number" }, @@ -2341,4 +2357,4 @@ non_mandate = [ [required_fields.card_redirect.momo_atm.fields.Adyen] common = [] mandate = [] -non_mandate = [] \ No newline at end of file +non_mandate = [] diff --git a/crates/common_enums/src/connector_enums.rs b/crates/common_enums/src/connector_enums.rs index 5251b9b3177..41563d56f27 100644 --- a/crates/common_enums/src/connector_enums.rs +++ b/crates/common_enums/src/connector_enums.rs @@ -25,6 +25,7 @@ pub use crate::PaymentMethodType; #[strum(serialize_all = "snake_case")] /// RoutableConnectors are the subset of Connectors that are eligible for payments routing pub enum RoutableConnectors { + Authipay, Adyenplatform, #[cfg(feature = "dummy_connector")] #[serde(rename = "stripe_billing_test")] @@ -184,6 +185,7 @@ pub enum RoutableConnectors { #[serde(rename_all = "snake_case")] #[strum(serialize_all = "snake_case")] pub enum Connector { + Authipay, Adyenplatform, #[cfg(feature = "dummy_connector")] #[serde(rename = "stripe_billing_test")] @@ -404,6 +406,7 @@ impl Connector { | Self::DummyConnector7 => false, Self::Aci // Add Separate authentication support for connectors + | Self::Authipay | Self::Adyen | Self::Adyenplatform | Self::Airwallex @@ -551,6 +554,7 @@ impl Connector { impl From<RoutableConnectors> for Connector { fn from(routable_connector: RoutableConnectors) -> Self { match routable_connector { + RoutableConnectors::Authipay => Self::Authipay, RoutableConnectors::Adyenplatform => Self::Adyenplatform, #[cfg(feature = "dummy_connector")] RoutableConnectors::DummyBillingConnector => Self::DummyBillingConnector, @@ -673,6 +677,7 @@ impl TryFrom<Connector> for RoutableConnectors { fn try_from(connector: Connector) -> Result<Self, Self::Error> { match connector { + Connector::Authipay => Ok(Self::Authipay), Connector::Adyenplatform => Ok(Self::Adyenplatform), #[cfg(feature = "dummy_connector")] Connector::DummyBillingConnector => Ok(Self::DummyBillingConnector), diff --git a/crates/connector_configs/src/connector.rs b/crates/connector_configs/src/connector.rs index f092b543f8c..67e340fa155 100644 --- a/crates/connector_configs/src/connector.rs +++ b/crates/connector_configs/src/connector.rs @@ -171,6 +171,7 @@ pub struct ConnectorTomlConfig { #[serde_with::skip_serializing_none] #[derive(Debug, Deserialize, serde::Serialize, Clone)] pub struct ConnectorConfig { + pub authipay: Option<ConnectorTomlConfig>, pub juspaythreedsserver: Option<ConnectorTomlConfig>, pub aci: Option<ConnectorTomlConfig>, pub adyen: Option<ConnectorTomlConfig>, @@ -369,6 +370,7 @@ impl ConnectorConfig { let connector_data = Self::new()?; match connector { Connector::Aci => Ok(connector_data.aci), + Connector::Authipay => Ok(connector_data.authipay), Connector::Adyen => Ok(connector_data.adyen), Connector::Adyenplatform => Err("Use get_payout_connector_config".to_string()), Connector::Airwallex => Ok(connector_data.airwallex), diff --git a/crates/connector_configs/toml/development.toml b/crates/connector_configs/toml/development.toml index f8919cba957..a8a0baa2661 100644 --- a/crates/connector_configs/toml/development.toml +++ b/crates/connector_configs/toml/development.toml @@ -502,7 +502,21 @@ required=true type="MultiSelect" options=["PAN_ONLY", "CRYPTOGRAM_3DS"] - +[authipay] +[[authipay.credit]] + payment_method_type = "Mastercard" +[[authipay.credit]] + payment_method_type = "Visa" +[[authipay.debit]] + payment_method_type = "Mastercard" +[[authipay.debit]] + payment_method_type = "Visa" +[authipay.connector_auth.SignatureKey] +api_key="API Key" +api_secret="API Secret" +key1="Merchant ID" +[authipay.connector_webhook_details] +merchant_secret="Source verification key" [authorizedotnet] [[authorizedotnet.credit]] diff --git a/crates/connector_configs/toml/production.toml b/crates/connector_configs/toml/production.toml index 667c5028c95..a22b50a9b4f 100644 --- a/crates/connector_configs/toml/production.toml +++ b/crates/connector_configs/toml/production.toml @@ -305,6 +305,22 @@ key1="Client ID" [airwallex.connector_webhook_details] merchant_secret="Source verification key" +[authipay] +[[authipay.credit]] + payment_method_type = "Mastercard" +[[authipay.credit]] + payment_method_type = "Visa" +[[authipay.debit]] + payment_method_type = "Mastercard" +[[authipay.debit]] + payment_method_type = "Visa" +[authipay.connector_auth.SignatureKey] +api_key="API Key" +api_secret="API Secret" +key1="Merchant ID" +[authipay.connector_webhook_details] +merchant_secret="Source verification key" + [authorizedotnet] [[authorizedotnet.credit]] payment_method_type = "Mastercard" diff --git a/crates/connector_configs/toml/sandbox.toml b/crates/connector_configs/toml/sandbox.toml index 20b7cdf09bf..d7026129699 100644 --- a/crates/connector_configs/toml/sandbox.toml +++ b/crates/connector_configs/toml/sandbox.toml @@ -503,7 +503,21 @@ required=true type="MultiSelect" options=["PAN_ONLY", "CRYPTOGRAM_3DS"] - +[authipay] +[[authipay.credit]] + payment_method_type = "Mastercard" +[[authipay.credit]] + payment_method_type = "Visa" +[[authipay.debit]] + payment_method_type = "Mastercard" +[[authipay.debit]] + payment_method_type = "Visa" +[authipay.connector_auth.SignatureKey] +api_key="API Key" +api_secret="API Secret" +key1="Merchant ID" +[authipay.connector_webhook_details] +merchant_secret="Source verification key" [authorizedotnet] [[authorizedotnet.credit]] diff --git a/crates/hyperswitch_connectors/src/connectors.rs b/crates/hyperswitch_connectors/src/connectors.rs index 6583e2ce5b9..84b53c97143 100644 --- a/crates/hyperswitch_connectors/src/connectors.rs +++ b/crates/hyperswitch_connectors/src/connectors.rs @@ -4,6 +4,7 @@ pub mod adyenplatform; pub mod airwallex; pub mod amazonpay; pub mod archipel; +pub mod authipay; pub mod authorizedotnet; pub mod bambora; pub mod bamboraapac; @@ -115,16 +116,16 @@ pub mod zsl; pub use self::dummyconnector::DummyConnector; pub use self::{ aci::Aci, adyen::Adyen, adyenplatform::Adyenplatform, airwallex::Airwallex, - amazonpay::Amazonpay, archipel::Archipel, authorizedotnet::Authorizedotnet, bambora::Bambora, - bamboraapac::Bamboraapac, bankofamerica::Bankofamerica, barclaycard::Barclaycard, - billwerk::Billwerk, bitpay::Bitpay, bluesnap::Bluesnap, boku::Boku, braintree::Braintree, - cashtocode::Cashtocode, celero::Celero, chargebee::Chargebee, checkbook::Checkbook, - checkout::Checkout, coinbase::Coinbase, coingate::Coingate, cryptopay::Cryptopay, - ctp_mastercard::CtpMastercard, cybersource::Cybersource, datatrans::Datatrans, - deutschebank::Deutschebank, digitalvirgo::Digitalvirgo, dlocal::Dlocal, dwolla::Dwolla, - ebanx::Ebanx, elavon::Elavon, facilitapay::Facilitapay, fiserv::Fiserv, fiservemea::Fiservemea, - fiuu::Fiuu, forte::Forte, getnet::Getnet, globalpay::Globalpay, globepay::Globepay, - gocardless::Gocardless, gpayments::Gpayments, helcim::Helcim, hipay::Hipay, + amazonpay::Amazonpay, archipel::Archipel, authipay::Authipay, authorizedotnet::Authorizedotnet, + bambora::Bambora, bamboraapac::Bamboraapac, bankofamerica::Bankofamerica, + barclaycard::Barclaycard, billwerk::Billwerk, bitpay::Bitpay, bluesnap::Bluesnap, boku::Boku, + braintree::Braintree, cashtocode::Cashtocode, celero::Celero, chargebee::Chargebee, + checkbook::Checkbook, checkout::Checkout, coinbase::Coinbase, coingate::Coingate, + cryptopay::Cryptopay, ctp_mastercard::CtpMastercard, cybersource::Cybersource, + datatrans::Datatrans, deutschebank::Deutschebank, digitalvirgo::Digitalvirgo, dlocal::Dlocal, + dwolla::Dwolla, ebanx::Ebanx, elavon::Elavon, facilitapay::Facilitapay, fiserv::Fiserv, + fiservemea::Fiservemea, fiuu::Fiuu, forte::Forte, getnet::Getnet, globalpay::Globalpay, + globepay::Globepay, gocardless::Gocardless, gpayments::Gpayments, helcim::Helcim, hipay::Hipay, hyperswitch_vault::HyperswitchVault, iatapay::Iatapay, inespay::Inespay, itaubank::Itaubank, jpmorgan::Jpmorgan, juspaythreedsserver::Juspaythreedsserver, klarna::Klarna, mifinity::Mifinity, mollie::Mollie, moneris::Moneris, multisafepay::Multisafepay, diff --git a/crates/hyperswitch_connectors/src/connectors/authipay.rs b/crates/hyperswitch_connectors/src/connectors/authipay.rs new file mode 100644 index 00000000000..5a5179ef5f1 --- /dev/null +++ b/crates/hyperswitch_connectors/src/connectors/authipay.rs @@ -0,0 +1,849 @@ +pub mod transformers; + +use std::sync::LazyLock; + +use base64::Engine; +use common_enums::enums; +use common_utils::{ + errors::CustomResult, + ext_traits::BytesExt, + request::{Method, Request, RequestBuilder, RequestContent}, + types::{AmountConvertor, FloatMajorUnit, FloatMajorUnitForConnector}, +}; +use error_stack::{report, ResultExt}; +use hyperswitch_domain_models::{ + router_data::{AccessToken, ConnectorAuthType, ErrorResponse, RouterData}, + router_flow_types::{ + access_token_auth::AccessTokenAuth, + payments::{Authorize, Capture, PSync, PaymentMethodToken, Session, SetupMandate, Void}, + refunds::{Execute, RSync}, + }, + router_request_types::{ + AccessTokenRequestData, PaymentMethodTokenizationData, PaymentsAuthorizeData, + PaymentsCancelData, PaymentsCaptureData, PaymentsSessionData, PaymentsSyncData, + RefundsData, SetupMandateRequestData, + }, + router_response_types::{ + ConnectorInfo, PaymentMethodDetails, PaymentsResponseData, RefundsResponseData, + SupportedPaymentMethods, SupportedPaymentMethodsExt, + }, + types::{ + PaymentsAuthorizeRouterData, PaymentsCancelRouterData, PaymentsCaptureRouterData, + PaymentsSyncRouterData, RefundSyncRouterData, RefundsRouterData, + }, +}; +use hyperswitch_interfaces::{ + api::{ + self, ConnectorCommon, ConnectorCommonExt, ConnectorIntegration, ConnectorSpecifications, + ConnectorValidation, + }, + configs::Connectors, + errors, + events::connector_api_logs::ConnectorEvent, + types::{self, Response}, + webhooks, +}; +use masking::{ExposeInterface, Mask, PeekInterface}; +use transformers as authipay; + +use crate::{constants::headers, types::ResponseRouterData, utils}; + +#[derive(Clone)] +pub struct Authipay { + amount_converter: &'static (dyn AmountConvertor<Output = FloatMajorUnit> + Sync), +} + +impl Authipay { + pub fn new() -> &'static Self { + &Self { + amount_converter: &FloatMajorUnitForConnector, + } + } + + pub fn generate_authorization_signature( + &self, + auth: authipay::AuthipayAuthType, + request_id: &str, + payload: &str, + timestamp: i128, + ) -> CustomResult<String, errors::ConnectorError> { + let authipay::AuthipayAuthType { + api_key, + api_secret, + } = auth; + let raw_signature = format!("{}{request_id}{timestamp}{payload}", api_key.peek()); + + let key = ring::hmac::Key::new(ring::hmac::HMAC_SHA256, api_secret.expose().as_bytes()); + let signature_value = common_utils::consts::BASE64_ENGINE + .encode(ring::hmac::sign(&key, raw_signature.as_bytes()).as_ref()); + Ok(signature_value) + } +} + +impl api::Payment for Authipay {} +impl api::PaymentSession for Authipay {} +impl api::ConnectorAccessToken for Authipay {} +impl api::MandateSetup for Authipay {} +impl api::PaymentAuthorize for Authipay {} +impl api::PaymentSync for Authipay {} +impl api::PaymentCapture for Authipay {} +impl api::PaymentVoid for Authipay {} +impl api::Refund for Authipay {} +impl api::RefundExecute for Authipay {} +impl api::RefundSync for Authipay {} +impl api::PaymentToken for Authipay {} + +impl ConnectorIntegration<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData> + for Authipay +{ + // Not Implemented (R) +} + +impl<Flow, Request, Response> ConnectorCommonExt<Flow, Request, Response> for Authipay +where + Self: ConnectorIntegration<Flow, Request, Response>, +{ + fn build_headers( + &self, + req: &RouterData<Flow, Request, Response>, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + let timestamp = time::OffsetDateTime::now_utc().unix_timestamp_nanos() / 1_000_000; + let auth: authipay::AuthipayAuthType = + authipay::AuthipayAuthType::try_from(&req.connector_auth_type)?; + let mut auth_header = self.get_auth_header(&req.connector_auth_type)?; + + let authipay_req = self.get_request_body(req, connectors)?; + + let client_request_id = uuid::Uuid::new_v4().to_string(); + let hmac = self + .generate_authorization_signature( + auth, + &client_request_id, + authipay_req.get_inner_value().peek(), + timestamp, + ) + .change_context(errors::ConnectorError::RequestEncodingFailed)?; + let mut headers = vec![ + ( + headers::CONTENT_TYPE.to_string(), + types::PaymentsAuthorizeType::get_content_type(self) + .to_string() + .into(), + ), + ("Client-Request-Id".to_string(), client_request_id.into()), + ("Auth-Token-Type".to_string(), "HMAC".to_string().into()), + (headers::TIMESTAMP.to_string(), timestamp.to_string().into()), + ("Message-Signature".to_string(), hmac.into_masked()), + ]; + headers.append(&mut auth_header); + Ok(headers) + } +} + +impl ConnectorCommon for Authipay { + fn id(&self) -> &'static str { + "authipay" + } + + fn get_currency_unit(&self) -> api::CurrencyUnit { + api::CurrencyUnit::Base + } + + fn common_get_content_type(&self) -> &'static str { + "application/json" + } + + fn base_url<'a>(&self, connectors: &'a Connectors) -> &'a str { + connectors.authipay.base_url.as_ref() + } + + fn get_auth_header( + &self, + auth_type: &ConnectorAuthType, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + let auth = authipay::AuthipayAuthType::try_from(auth_type) + .change_context(errors::ConnectorError::FailedToObtainAuthType)?; + Ok(vec![( + headers::API_KEY.to_string(), + auth.api_key.into_masked(), + )]) + } + + fn build_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + let response: authipay::AuthipayErrorResponse = res + .response + .parse_struct("AuthipayErrorResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + + event_builder.map(|i| i.set_error_response_body(&response)); + + let mut error_response = ErrorResponse::from(&response); + + // Set status code from the response, or 400 if error code is a "404" + if let Some(error_code) = &response.error.code { + if error_code == "404" { + error_response.status_code = 404; + } else { + error_response.status_code = res.status_code; + } + } else { + error_response.status_code = res.status_code; + } + + Ok(error_response) + } +} + +impl ConnectorValidation for Authipay { + fn validate_connector_against_payment_request( + &self, + capture_method: Option<enums::CaptureMethod>, + _payment_method: enums::PaymentMethod, + _pmt: Option<enums::PaymentMethodType>, + ) -> CustomResult<(), errors::ConnectorError> { + let capture_method = capture_method.unwrap_or_default(); + match capture_method { + enums::CaptureMethod::Automatic + | enums::CaptureMethod::Manual + | enums::CaptureMethod::SequentialAutomatic => Ok(()), + enums::CaptureMethod::Scheduled | enums::CaptureMethod::ManualMultiple => Err( + utils::construct_not_implemented_error_report(capture_method, self.id()), + ), + } + } +} + +impl ConnectorIntegration<Session, PaymentsSessionData, PaymentsResponseData> for Authipay { + //TODO: implement sessions flow +} + +impl ConnectorIntegration<AccessTokenAuth, AccessTokenRequestData, AccessToken> for Authipay {} + +impl ConnectorIntegration<SetupMandate, SetupMandateRequestData, PaymentsResponseData> + for Authipay +{ +} + +impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData> for Authipay { + fn get_headers( + &self, + req: &PaymentsAuthorizeRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsAuthorizeRouterData, + connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Ok(format!("{}payments", self.base_url(connectors))) + } + + fn get_request_body( + &self, + req: &PaymentsAuthorizeRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let amount = utils::convert_amount( + self.amount_converter, + req.request.minor_amount, + req.request.currency, + )?; + + let connector_router_data = authipay::AuthipayRouterData::from((amount, req)); + let connector_req = authipay::AuthipayPaymentsRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &PaymentsAuthorizeRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::PaymentsAuthorizeType::get_url( + self, req, connectors, + )?) + .attach_default_headers() + .headers(types::PaymentsAuthorizeType::get_headers( + self, req, connectors, + )?) + .set_body(types::PaymentsAuthorizeType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsAuthorizeRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsAuthorizeRouterData, errors::ConnectorError> { + let response: authipay::AuthipayPaymentsResponse = res + .response + .parse_struct("Authipay PaymentsAuthorizeResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<PSync, PaymentsSyncData, PaymentsResponseData> for Authipay { + fn get_headers( + &self, + req: &PaymentsSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + req: &PaymentsSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + let connector_transaction_id = req + .request + .connector_transaction_id + .get_connector_transaction_id() + .change_context(errors::ConnectorError::RequestEncodingFailed)?; + Ok(format!( + "{}payments/{}", + self.base_url(connectors), + connector_transaction_id + )) + } + + fn get_request_body( + &self, + _req: &PaymentsSyncRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + Ok(RequestContent::RawBytes(Vec::new())) + } + + fn build_request( + &self, + req: &PaymentsSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Get) + .url(&types::PaymentsSyncType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::PaymentsSyncType::get_headers(self, req, connectors)?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsSyncRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsSyncRouterData, errors::ConnectorError> { + let response: authipay::AuthipayPaymentsResponse = res + .response + .parse_struct("authipay PaymentsSyncResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<Capture, PaymentsCaptureData, PaymentsResponseData> for Authipay { + fn get_headers( + &self, + req: &PaymentsCaptureRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + req: &PaymentsCaptureRouterData, + connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + let connector_transaction_id = req.request.connector_transaction_id.clone(); + Ok(format!( + "{}payments/{}", + self.base_url(connectors), + connector_transaction_id + )) + } + + fn get_request_body( + &self, + req: &PaymentsCaptureRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let amount = utils::convert_amount( + self.amount_converter, + req.request.minor_amount_to_capture, + req.request.currency, + )?; + + let connector_router_data = authipay::AuthipayRouterData::from((amount, req)); + let connector_req = authipay::AuthipayCaptureRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &PaymentsCaptureRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::PaymentsCaptureType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::PaymentsCaptureType::get_headers( + self, req, connectors, + )?) + .set_body(types::PaymentsCaptureType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsCaptureRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsCaptureRouterData, errors::ConnectorError> { + let response: authipay::AuthipayPaymentsResponse = res + .response + .parse_struct("Authipay PaymentsCaptureResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<Void, PaymentsCancelData, PaymentsResponseData> for Authipay { + fn get_headers( + &self, + req: &PaymentsCancelRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + req: &PaymentsCancelRouterData, + connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + // For void operations, Authipay requires using the /orders/{orderId} endpoint + // The orderId should be stored in connector_meta from the authorization response + let order_id = req + .request + .connector_meta + .as_ref() + .and_then(|meta| meta.get("order_id")) + .and_then(|v| v.as_str()) + .ok_or(errors::ConnectorError::RequestEncodingFailed)?; + + Ok(format!("{}orders/{}", self.base_url(connectors), order_id)) + } + + fn get_request_body( + &self, + req: &PaymentsCancelRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + // For void, we don't need amount conversion since it's always full amount + let connector_router_data = + authipay::AuthipayRouterData::from((FloatMajorUnit::zero(), req)); + let connector_req = authipay::AuthipayVoidRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &PaymentsCancelRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::PaymentsVoidType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::PaymentsVoidType::get_headers(self, req, connectors)?) + .set_body(types::PaymentsVoidType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsCancelRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsCancelRouterData, errors::ConnectorError> { + let response: authipay::AuthipayPaymentsResponse = res + .response + .parse_struct("Authipay PaymentsVoidResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<Execute, RefundsData, RefundsResponseData> for Authipay { + fn get_headers( + &self, + req: &RefundsRouterData<Execute>, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + req: &RefundsRouterData<Execute>, + connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + let connector_payment_id = req.request.connector_transaction_id.clone(); + Ok(format!( + "{}payments/{}", + self.base_url(connectors), + connector_payment_id + )) + } + + fn get_request_body( + &self, + req: &RefundsRouterData<Execute>, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let refund_amount = utils::convert_amount( + self.amount_converter, + req.request.minor_refund_amount, + req.request.currency, + )?; + + let connector_router_data = authipay::AuthipayRouterData::from((refund_amount, req)); + let connector_req = authipay::AuthipayRefundRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &RefundsRouterData<Execute>, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + let request = RequestBuilder::new() + .method(Method::Post) + .url(&types::RefundExecuteType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::RefundExecuteType::get_headers( + self, req, connectors, + )?) + .set_body(types::RefundExecuteType::get_request_body( + self, req, connectors, + )?) + .build(); + Ok(Some(request)) + } + + fn handle_response( + &self, + data: &RefundsRouterData<Execute>, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<RefundsRouterData<Execute>, errors::ConnectorError> { + let response: authipay::RefundResponse = res + .response + .parse_struct("authipay RefundResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<RSync, RefundsData, RefundsResponseData> for Authipay { + fn get_headers( + &self, + req: &RefundSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + req: &RefundSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + let refund_id = req + .request + .connector_refund_id + .clone() + .ok_or(errors::ConnectorError::RequestEncodingFailed)?; + Ok(format!( + "{}payments/{}", + self.base_url(connectors), + refund_id + )) + } + + fn get_request_body( + &self, + _req: &RefundSyncRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + Ok(RequestContent::RawBytes(Vec::new())) + } + + fn build_request( + &self, + req: &RefundSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Get) + .url(&types::RefundSyncType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::RefundSyncType::get_headers(self, req, connectors)?) + .build(), + )) + } + + fn handle_response( + &self, + data: &RefundSyncRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<RefundSyncRouterData, errors::ConnectorError> { + let response: authipay::RefundResponse = res + .response + .parse_struct("authipay RefundSyncResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +#[async_trait::async_trait] +impl webhooks::IncomingWebhook for Authipay { + fn get_webhook_object_reference_id( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<api_models::webhooks::ObjectReferenceId, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } + + fn get_webhook_event_type( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<api_models::webhooks::IncomingWebhookEvent, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } + + fn get_webhook_resource_object( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<Box<dyn masking::ErasedMaskSerialize>, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } +} + +static AUTHIPAY_SUPPORTED_PAYMENT_METHODS: LazyLock<SupportedPaymentMethods> = + LazyLock::new(|| { + let supported_capture_methods = vec![ + enums::CaptureMethod::Automatic, + enums::CaptureMethod::SequentialAutomatic, + enums::CaptureMethod::Manual, + ]; + + let supported_card_network = vec![ + common_enums::CardNetwork::Visa, + common_enums::CardNetwork::Mastercard, + ]; + + let mut authipay_supported_payment_methods = SupportedPaymentMethods::new(); + + authipay_supported_payment_methods.add( + enums::PaymentMethod::Card, + enums::PaymentMethodType::Credit, + PaymentMethodDetails { + mandates: enums::FeatureStatus::NotSupported, + refunds: enums::FeatureStatus::Supported, + supported_capture_methods: supported_capture_methods.clone(), + specific_features: Some( + api_models::feature_matrix::PaymentMethodSpecificFeatures::Card({ + api_models::feature_matrix::CardSpecificFeatures { + three_ds: common_enums::FeatureStatus::NotSupported, + no_three_ds: common_enums::FeatureStatus::Supported, + supported_card_networks: supported_card_network.clone(), + } + }), + ), + }, + ); + + authipay_supported_payment_methods.add( + enums::PaymentMethod::Card, + enums::PaymentMethodType::Debit, + PaymentMethodDetails { + mandates: enums::FeatureStatus::NotSupported, + refunds: enums::FeatureStatus::Supported, + supported_capture_methods: supported_capture_methods.clone(), + specific_features: Some( + api_models::feature_matrix::PaymentMethodSpecificFeatures::Card({ + api_models::feature_matrix::CardSpecificFeatures { + three_ds: common_enums::FeatureStatus::NotSupported, + no_three_ds: common_enums::FeatureStatus::Supported, + supported_card_networks: supported_card_network.clone(), + } + }), + ), + }, + ); + + authipay_supported_payment_methods + }); + +static AUTHIPAY_CONNECTOR_INFO: ConnectorInfo = ConnectorInfo { + display_name: "Authipay", + description: "Authipay is a Fiserv-powered payment gateway for the EMEA region supporting Visa and Mastercard transactions. Features include flexible capture methods (automatic, manual, sequential), partial captures/refunds, payment tokenization, and secure HMAC SHA256 authentication.", + connector_type: enums::PaymentConnectorCategory::PaymentGateway, +}; + +static AUTHIPAY_SUPPORTED_WEBHOOK_FLOWS: [enums::EventClass; 0] = []; + +impl ConnectorSpecifications for Authipay { + fn get_connector_about(&self) -> Option<&'static ConnectorInfo> { + Some(&AUTHIPAY_CONNECTOR_INFO) + } + + fn get_supported_payment_methods(&self) -> Option<&'static SupportedPaymentMethods> { + Some(&*AUTHIPAY_SUPPORTED_PAYMENT_METHODS) + } + + fn get_supported_webhook_flows(&self) -> Option<&'static [enums::EventClass]> { + Some(&AUTHIPAY_SUPPORTED_WEBHOOK_FLOWS) + } +} diff --git a/crates/hyperswitch_connectors/src/connectors/authipay/transformers.rs b/crates/hyperswitch_connectors/src/connectors/authipay/transformers.rs new file mode 100644 index 00000000000..c7c21404752 --- /dev/null +++ b/crates/hyperswitch_connectors/src/connectors/authipay/transformers.rs @@ -0,0 +1,624 @@ +use cards; +use common_enums::enums; +use common_utils::types::FloatMajorUnit; +use hyperswitch_domain_models::{ + payment_method_data::PaymentMethodData, + router_data::{ConnectorAuthType, ErrorResponse, RouterData}, + router_flow_types::refunds::{Execute, RSync}, + router_request_types::ResponseId, + router_response_types::{PaymentsResponseData, RefundsResponseData}, + types::{ + PaymentsAuthorizeRouterData, PaymentsCancelRouterData, PaymentsCaptureRouterData, + RefundsRouterData, + }, +}; +use hyperswitch_interfaces::errors; +use masking::Secret; +use serde::{Deserialize, Serialize}; + +use crate::{ + types::{RefundsResponseRouterData, ResponseRouterData}, + utils, +}; + +// Type definition for router data with amount +pub struct AuthipayRouterData<T> { + pub amount: FloatMajorUnit, // Amount in major units (e.g., dollars instead of cents) + pub router_data: T, +} + +impl<T> From<(FloatMajorUnit, T)> for AuthipayRouterData<T> { + fn from((amount, item): (FloatMajorUnit, T)) -> Self { + Self { + amount, + router_data: item, + } + } +} + +// Basic request/response structs used across multiple operations + +#[derive(Default, Debug, Serialize, Deserialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct Amount { + total: FloatMajorUnit, + currency: String, + #[serde(skip_serializing_if = "Option::is_none")] + components: Option<AmountComponents>, +} + +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct AmountComponents { + subtotal: FloatMajorUnit, +} + +#[derive(Default, Debug, Serialize, Deserialize, Clone, Eq, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct ExpiryDate { + month: Secret<String>, + year: Secret<String>, +} + +#[derive(Default, Debug, Serialize, Eq, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct Card { + number: cards::CardNumber, + security_code: Secret<String>, + expiry_date: ExpiryDate, +} + +#[derive(Default, Debug, Serialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct PaymentMethod { + payment_card: Card, +} + +#[derive(Default, Debug, Serialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct SplitShipment { + total_count: i32, + final_shipment: bool, +} + +#[derive(Debug, Serialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct AuthipayPaymentsRequest { + request_type: &'static str, + transaction_amount: Amount, + payment_method: PaymentMethod, + // split_shipment: Option<SplitShipment>, + // incremental_flag: Option<bool>, +} + +impl TryFrom<&AuthipayRouterData<&PaymentsAuthorizeRouterData>> for AuthipayPaymentsRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: &AuthipayRouterData<&PaymentsAuthorizeRouterData>, + ) -> Result<Self, Self::Error> { + // Check if 3DS is being requested - Authipay doesn't support 3DS + if matches!( + item.router_data.auth_type, + enums::AuthenticationType::ThreeDs + ) { + return Err(errors::ConnectorError::NotImplemented( + utils::get_unimplemented_payment_method_error_message("authipay"), + ) + .into()); + } + + match item.router_data.request.payment_method_data.clone() { + PaymentMethodData::Card(req_card) => { + let expiry_date = ExpiryDate { + month: req_card.card_exp_month.clone(), + year: req_card.card_exp_year.clone(), + }; + + let card = Card { + number: req_card.card_number.clone(), + security_code: req_card.card_cvc.clone(), + expiry_date, + }; + + let payment_method = PaymentMethod { payment_card: card }; + + let transaction_amount = Amount { + total: item.amount, + currency: item.router_data.request.currency.to_string(), + components: None, + }; + + // Determine request type based on capture method + let request_type = match item.router_data.request.capture_method { + Some(enums::CaptureMethod::Manual) => "PaymentCardPreAuthTransaction", + Some(enums::CaptureMethod::Automatic) => "PaymentCardSaleTransaction", + Some(enums::CaptureMethod::SequentialAutomatic) => "PaymentCardSaleTransaction", + Some(enums::CaptureMethod::ManualMultiple) + | Some(enums::CaptureMethod::Scheduled) => { + return Err(errors::ConnectorError::NotSupported { + message: "Capture method not supported by Authipay".to_string(), + connector: "Authipay", + } + .into()); + } + None => "PaymentCardSaleTransaction", // Default when not specified + }; + + let request = Self { + request_type, + transaction_amount, + payment_method, + }; + + Ok(request) + } + _ => Err(errors::ConnectorError::NotImplemented( + utils::get_unimplemented_payment_method_error_message("authipay"), + ) + .into()), + } + } +} + +//TODO: Fill the struct with respective fields +// Auth Struct +pub struct AuthipayAuthType { + pub(super) api_key: Secret<String>, + pub(super) api_secret: Secret<String>, +} + +impl TryFrom<&ConnectorAuthType> for AuthipayAuthType { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from(auth_type: &ConnectorAuthType) -> Result<Self, Self::Error> { + match auth_type { + ConnectorAuthType::SignatureKey { + api_key, + api_secret, + .. + } => Ok(Self { + api_key: api_key.to_owned(), + api_secret: api_secret.to_owned(), + }), + _ => Err(errors::ConnectorError::FailedToObtainAuthType.into()), + } + } +} +// Transaction Status enum (like Fiserv's FiservPaymentStatus) +#[derive(Debug, Clone, Default, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "UPPERCASE")] +pub enum AuthipayTransactionStatus { + Authorized, + Captured, + Voided, + Declined, + Failed, + #[default] + Processing, +} + +impl From<AuthipayTransactionStatus> for enums::AttemptStatus { + fn from(item: AuthipayTransactionStatus) -> Self { + match item { + AuthipayTransactionStatus::Captured => Self::Charged, + AuthipayTransactionStatus::Declined | AuthipayTransactionStatus::Failed => { + Self::Failure + } + AuthipayTransactionStatus::Processing => Self::Pending, + AuthipayTransactionStatus::Authorized => Self::Authorized, + AuthipayTransactionStatus::Voided => Self::Voided, + } + } +} + +// Transaction Processing Details (like Fiserv's TransactionProcessingDetails) +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct AuthipayTransactionProcessingDetails { + pub order_id: String, + pub transaction_id: String, +} + +// Gateway Response (like Fiserv's GatewayResponse) +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct AuthipayGatewayResponse { + pub transaction_state: AuthipayTransactionStatus, + pub transaction_processing_details: AuthipayTransactionProcessingDetails, +} + +// Payment Receipt (like Fiserv's PaymentReceipt) +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct AuthipayPaymentReceipt { + pub approved_amount: Amount, + pub processor_response_details: Option<Processor>, +} + +// Main Response (like Fiserv's FiservPaymentsResponse) - but flat for JSON deserialization +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct AuthipayPaymentsResponse { + #[serde(rename = "type")] + response_type: Option<String>, + client_request_id: String, + api_trace_id: String, + ipg_transaction_id: String, + order_id: String, + transaction_type: String, + payment_token: Option<PaymentToken>, + transaction_origin: Option<String>, + payment_method_details: Option<PaymentMethodDetails>, + country: Option<String>, + terminal_id: Option<String>, + merchant_id: Option<String>, + transaction_time: i64, + approved_amount: Amount, + transaction_amount: Amount, + // For payment transactions (SALE) + transaction_status: Option<String>, + // For refund transactions (RETURN) + transaction_result: Option<String>, + transaction_state: Option<String>, + approval_code: String, + scheme_transaction_id: Option<String>, + processor: Processor, +} + +impl AuthipayPaymentsResponse { + /// Get gateway response (like Fiserv's gateway_response) + pub fn gateway_response(&self) -> AuthipayGatewayResponse { + AuthipayGatewayResponse { + transaction_state: self.get_transaction_status(), + transaction_processing_details: AuthipayTransactionProcessingDetails { + order_id: self.order_id.clone(), + transaction_id: self.ipg_transaction_id.clone(), + }, + } + } + + /// Get payment receipt (like Fiserv's payment_receipt) + pub fn payment_receipt(&self) -> AuthipayPaymentReceipt { + AuthipayPaymentReceipt { + approved_amount: self.approved_amount.clone(), + processor_response_details: Some(self.processor.clone()), + } + } + + /// Determine the transaction status based on transaction type and various status fields (like Fiserv) + fn get_transaction_status(&self) -> AuthipayTransactionStatus { + match self.transaction_type.as_str() { + "RETURN" => { + // Refund transaction - use transaction_result + match self.transaction_result.as_deref() { + Some("APPROVED") => AuthipayTransactionStatus::Captured, + Some("DECLINED") | Some("FAILED") => AuthipayTransactionStatus::Failed, + _ => AuthipayTransactionStatus::Processing, + } + } + "VOID" => { + // Void transaction - use transaction_result, fallback to transaction_state + match self.transaction_result.as_deref() { + Some("APPROVED") => AuthipayTransactionStatus::Voided, + Some("DECLINED") | Some("FAILED") => AuthipayTransactionStatus::Failed, + Some("PENDING") | Some("PROCESSING") => AuthipayTransactionStatus::Processing, + _ => { + // Fallback to transaction_state for void operations + match self.transaction_state.as_deref() { + Some("VOIDED") => AuthipayTransactionStatus::Voided, + Some("FAILED") | Some("DECLINED") => AuthipayTransactionStatus::Failed, + _ => AuthipayTransactionStatus::Voided, // Default assumption for void requests + } + } + } + } + _ => { + // Payment transaction - prioritize transaction_state over transaction_status + match self.transaction_state.as_deref() { + Some("AUTHORIZED") => AuthipayTransactionStatus::Authorized, + Some("CAPTURED") => AuthipayTransactionStatus::Captured, + Some("VOIDED") => AuthipayTransactionStatus::Voided, + Some("DECLINED") | Some("FAILED") => AuthipayTransactionStatus::Failed, + _ => { + // Fallback to transaction_status with transaction_type context + match ( + self.transaction_type.as_str(), + self.transaction_status.as_deref(), + ) { + // For PREAUTH transactions, "APPROVED" means authorized and awaiting capture + ("PREAUTH", Some("APPROVED")) => AuthipayTransactionStatus::Authorized, + // For POSTAUTH transactions, "APPROVED" means successfully captured + ("POSTAUTH", Some("APPROVED")) => AuthipayTransactionStatus::Captured, + // For SALE transactions, "APPROVED" means completed payment + ("SALE", Some("APPROVED")) => AuthipayTransactionStatus::Captured, + // For VOID transactions, "APPROVED" means successfully voided + ("VOID", Some("APPROVED")) => AuthipayTransactionStatus::Voided, + // Generic status mappings for other cases + (_, Some("APPROVED")) => AuthipayTransactionStatus::Captured, + (_, Some("AUTHORIZED")) => AuthipayTransactionStatus::Authorized, + (_, Some("DECLINED") | Some("FAILED")) => { + AuthipayTransactionStatus::Failed + } + _ => AuthipayTransactionStatus::Processing, + } + } + } + } + } + } +} + +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct PaymentToken { + reusable: Option<bool>, + decline_duplicates: Option<bool>, + brand: Option<String>, + #[serde(rename = "type")] + token_type: Option<String>, +} + +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct PaymentMethodDetails { + payment_card: Option<PaymentCardDetails>, + payment_method_type: Option<String>, + payment_method_brand: Option<String>, +} + +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct PaymentCardDetails { + expiry_date: ExpiryDate, + bin: String, + last4: String, + brand: String, +} + +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct Processor { + reference_number: Option<String>, + authorization_code: Option<String>, + response_code: String, + response_message: String, + avs_response: Option<AvsResponse>, + security_code_response: Option<String>, + tax_refund_data: Option<serde_json::Value>, +} + +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct AvsResponse { + street_match: Option<String>, + postal_code_match: Option<String>, +} + +impl<F, T> TryFrom<ResponseRouterData<F, AuthipayPaymentsResponse, T, PaymentsResponseData>> + for RouterData<F, T, PaymentsResponseData> +{ + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: ResponseRouterData<F, AuthipayPaymentsResponse, T, PaymentsResponseData>, + ) -> Result<Self, Self::Error> { + // Get gateway response (like Fiserv pattern) + let gateway_resp = item.response.gateway_response(); + + // Store order_id in connector_metadata for void operations (like Fiserv) + let mut metadata = std::collections::HashMap::new(); + metadata.insert( + "order_id".to_string(), + serde_json::Value::String(gateway_resp.transaction_processing_details.order_id.clone()), + ); + let connector_metadata = Some(serde_json::Value::Object(serde_json::Map::from_iter( + metadata, + ))); + + Ok(Self { + status: enums::AttemptStatus::from(gateway_resp.transaction_state.clone()), + response: Ok(PaymentsResponseData::TransactionResponse { + resource_id: ResponseId::ConnectorTransactionId( + gateway_resp + .transaction_processing_details + .transaction_id + .clone(), + ), + redirection_data: Box::new(None), + mandate_reference: Box::new(None), + connector_metadata, + network_txn_id: None, + connector_response_reference_id: Some( + gateway_resp.transaction_processing_details.order_id.clone(), + ), + incremental_authorization_allowed: None, + charges: None, + }), + ..item.data + }) + } +} + +// Type definition for CaptureRequest +#[derive(Debug, Serialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct AuthipayCaptureRequest { + request_type: &'static str, + transaction_amount: Amount, +} + +impl TryFrom<&AuthipayRouterData<&PaymentsCaptureRouterData>> for AuthipayCaptureRequest { + type Error = error_stack::Report<errors::ConnectorError>; + + fn try_from( + item: &AuthipayRouterData<&PaymentsCaptureRouterData>, + ) -> Result<Self, Self::Error> { + Ok(Self { + request_type: "PostAuthTransaction", + transaction_amount: Amount { + total: item.amount, + currency: item.router_data.request.currency.to_string(), + components: None, + }, + }) + } +} + +// Type definition for VoidRequest +#[derive(Debug, Serialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct AuthipayVoidRequest { + request_type: &'static str, +} + +impl TryFrom<&AuthipayRouterData<&PaymentsCancelRouterData>> for AuthipayVoidRequest { + type Error = error_stack::Report<errors::ConnectorError>; + + fn try_from( + _item: &AuthipayRouterData<&PaymentsCancelRouterData>, + ) -> Result<Self, Self::Error> { + Ok(Self { + request_type: "VoidTransaction", + }) + } +} + +// Type definition for RefundRequest +#[derive(Default, Debug, Serialize)] +#[serde(rename_all = "camelCase")] +pub struct AuthipayRefundRequest { + request_type: &'static str, + transaction_amount: Amount, +} + +impl<F> TryFrom<&AuthipayRouterData<&RefundsRouterData<F>>> for AuthipayRefundRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from(item: &AuthipayRouterData<&RefundsRouterData<F>>) -> Result<Self, Self::Error> { + Ok(Self { + request_type: "ReturnTransaction", + transaction_amount: Amount { + total: item.amount.to_owned(), + currency: item.router_data.request.currency.to_string(), + components: None, + }, + }) + } +} + +// Type definition for Refund Response + +#[allow(dead_code)] +#[derive(Debug, Serialize, Default, Deserialize, Clone)] +pub enum RefundStatus { + Succeeded, + Failed, + #[default] + Processing, +} + +impl From<RefundStatus> for enums::RefundStatus { + fn from(item: RefundStatus) -> Self { + match item { + RefundStatus::Succeeded => Self::Success, + RefundStatus::Failed => Self::Failure, + RefundStatus::Processing => Self::Pending, + //TODO: Review mapping + } + } +} + +// Reusing the payments response structure for refunds +// because Authipay uses the same endpoint and response format +pub type RefundResponse = AuthipayPaymentsResponse; + +impl TryFrom<RefundsResponseRouterData<Execute, RefundResponse>> for RefundsRouterData<Execute> { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: RefundsResponseRouterData<Execute, RefundResponse>, + ) -> Result<Self, Self::Error> { + let refund_status = if item.response.transaction_type == "RETURN" { + match item.response.transaction_result.as_deref() { + Some("APPROVED") => RefundStatus::Succeeded, + Some("DECLINED") | Some("FAILED") => RefundStatus::Failed, + _ => RefundStatus::Processing, + } + } else { + RefundStatus::Processing + }; + + Ok(Self { + response: Ok(RefundsResponseData { + connector_refund_id: item.response.ipg_transaction_id.to_string(), + refund_status: enums::RefundStatus::from(refund_status), + }), + ..item.data + }) + } +} + +impl TryFrom<RefundsResponseRouterData<RSync, RefundResponse>> for RefundsRouterData<RSync> { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: RefundsResponseRouterData<RSync, RefundResponse>, + ) -> Result<Self, Self::Error> { + let refund_status = if item.response.transaction_type == "RETURN" { + match item.response.transaction_result.as_deref() { + Some("APPROVED") => RefundStatus::Succeeded, + Some("DECLINED") | Some("FAILED") => RefundStatus::Failed, + _ => RefundStatus::Processing, + } + } else { + RefundStatus::Processing + }; + + Ok(Self { + response: Ok(RefundsResponseData { + connector_refund_id: item.response.ipg_transaction_id.to_string(), + refund_status: enums::RefundStatus::from(refund_status), + }), + ..item.data + }) + } +} + +// Error Response structs +#[derive(Default, Debug, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ErrorDetailItem { + pub field: String, + pub message: String, +} + +#[derive(Default, Debug, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ErrorDetails { + pub code: Option<String>, + pub message: String, + pub details: Option<Vec<ErrorDetailItem>>, +} + +#[derive(Default, Debug, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct AuthipayErrorResponse { + pub client_request_id: Option<String>, + pub api_trace_id: Option<String>, + pub response_type: Option<String>, + #[serde(rename = "type")] + pub response_object_type: Option<String>, + pub error: ErrorDetails, + pub decline_reason_code: Option<String>, +} + +impl From<&AuthipayErrorResponse> for ErrorResponse { + fn from(item: &AuthipayErrorResponse) -> Self { + Self { + status_code: 500, // Default to Internal Server Error, will be overridden by actual HTTP status + code: item.error.code.clone().unwrap_or_default(), + message: item.error.message.clone(), + reason: None, + attempt_status: None, + connector_transaction_id: None, + network_decline_code: None, + network_advice_code: None, + network_error_message: None, + } + } +} diff --git a/crates/hyperswitch_connectors/src/default_implementations.rs b/crates/hyperswitch_connectors/src/default_implementations.rs index 9cc798d57cd..38e63124029 100644 --- a/crates/hyperswitch_connectors/src/default_implementations.rs +++ b/crates/hyperswitch_connectors/src/default_implementations.rs @@ -148,6 +148,7 @@ default_imp_for_authorize_session_token!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -274,6 +275,7 @@ default_imp_for_calculate_tax!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -401,6 +403,7 @@ default_imp_for_session_update!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -528,6 +531,7 @@ default_imp_for_post_session_tokens!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -654,6 +658,7 @@ default_imp_for_create_order!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -781,6 +786,7 @@ default_imp_for_update_metadata!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -911,6 +917,7 @@ default_imp_for_complete_authorize!( connectors::Adyenplatform, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Bamboraapac, connectors::Bankofamerica, connectors::Barclaycard, @@ -1018,6 +1025,7 @@ default_imp_for_incremental_authorization!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1145,6 +1153,7 @@ default_imp_for_create_customer!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1270,6 +1279,7 @@ default_imp_for_connector_redirect_response!( connectors::Adyenplatform, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Billwerk, connectors::Bitpay, connectors::Bamboraapac, @@ -1377,6 +1387,7 @@ default_imp_for_pre_processing_steps!( connectors::Adyenplatform, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1494,6 +1505,7 @@ default_imp_for_post_processing_steps!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1622,6 +1634,7 @@ default_imp_for_approve!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1751,6 +1764,7 @@ default_imp_for_reject!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1880,6 +1894,7 @@ default_imp_for_webhook_source_verification!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2008,6 +2023,7 @@ default_imp_for_accept_dispute!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2135,6 +2151,7 @@ default_imp_for_submit_evidence!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2261,6 +2278,7 @@ default_imp_for_defend_dispute!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2397,6 +2415,7 @@ default_imp_for_file_upload!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2515,6 +2534,7 @@ default_imp_for_payouts!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2637,6 +2657,7 @@ default_imp_for_payouts_create!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2763,6 +2784,7 @@ default_imp_for_payouts_retrieve!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2891,6 +2913,7 @@ default_imp_for_payouts_eligibility!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -3017,6 +3040,7 @@ default_imp_for_payouts_fulfill!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -3140,6 +3164,7 @@ default_imp_for_payouts_cancel!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -3267,6 +3292,7 @@ default_imp_for_payouts_quote!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -3395,6 +3421,7 @@ default_imp_for_payouts_recipient!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -3522,6 +3549,7 @@ default_imp_for_payouts_recipient_account!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -3651,6 +3679,7 @@ default_imp_for_frm_sale!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -3780,6 +3809,7 @@ default_imp_for_frm_checkout!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -3909,6 +3939,7 @@ default_imp_for_frm_transaction!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -4038,6 +4069,7 @@ default_imp_for_frm_fulfillment!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -4167,6 +4199,7 @@ default_imp_for_frm_record_return!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -4293,6 +4326,7 @@ default_imp_for_revoking_mandates!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -4417,6 +4451,7 @@ default_imp_for_uas_pre_authentication!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -4543,6 +4578,7 @@ default_imp_for_uas_post_authentication!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -4670,6 +4706,7 @@ default_imp_for_uas_authentication_confirmation!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -4788,6 +4825,7 @@ default_imp_for_connector_request_id!( connectors::Adyenplatform, connectors::Airwallex, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Amazonpay, connectors::Bambora, @@ -4910,6 +4948,7 @@ default_imp_for_fraud_check!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -5061,6 +5100,7 @@ default_imp_for_connector_authentication!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -5185,6 +5225,7 @@ default_imp_for_uas_authentication!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -5304,6 +5345,7 @@ default_imp_for_revenue_recovery!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -5434,6 +5476,7 @@ default_imp_for_billing_connector_payment_sync!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -5563,6 +5606,7 @@ default_imp_for_revenue_recovery_record_back!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -5690,6 +5734,7 @@ default_imp_for_billing_connector_invoice_sync!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -5812,6 +5857,7 @@ default_imp_for_external_vault!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Barclaycard, connectors::Bambora, @@ -5940,6 +5986,7 @@ default_imp_for_external_vault_insert!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Barclaycard, connectors::Bambora, @@ -6068,6 +6115,7 @@ default_imp_for_external_vault_retrieve!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Barclaycard, connectors::Bambora, @@ -6196,6 +6244,7 @@ default_imp_for_external_vault_delete!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Barclaycard, connectors::Bambora, @@ -6324,6 +6373,7 @@ default_imp_for_external_vault_create!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Barclaycard, connectors::Bambora, diff --git a/crates/hyperswitch_connectors/src/default_implementations_v2.rs b/crates/hyperswitch_connectors/src/default_implementations_v2.rs index 7bc66a1e6cf..89a7b3de2ac 100644 --- a/crates/hyperswitch_connectors/src/default_implementations_v2.rs +++ b/crates/hyperswitch_connectors/src/default_implementations_v2.rs @@ -253,6 +253,7 @@ default_imp_for_new_connector_integration_payment!( connectors::Airwallex, connectors::Amazonpay, connectors::Adyenplatform, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -382,6 +383,7 @@ default_imp_for_new_connector_integration_refund!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -506,6 +508,7 @@ default_imp_for_new_connector_integration_connector_access_token!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -636,6 +639,7 @@ default_imp_for_new_connector_integration_accept_dispute!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -764,6 +768,7 @@ default_imp_for_new_connector_integration_submit_evidence!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -892,6 +897,7 @@ default_imp_for_new_connector_integration_defend_dispute!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1031,6 +1037,7 @@ default_imp_for_new_connector_integration_file_upload!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1162,6 +1169,7 @@ default_imp_for_new_connector_integration_payouts_create!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1293,6 +1301,7 @@ default_imp_for_new_connector_integration_payouts_eligibility!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1424,6 +1433,7 @@ default_imp_for_new_connector_integration_payouts_fulfill!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1555,6 +1565,7 @@ default_imp_for_new_connector_integration_payouts_cancel!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1686,6 +1697,7 @@ default_imp_for_new_connector_integration_payouts_quote!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1817,6 +1829,7 @@ default_imp_for_new_connector_integration_payouts_recipient!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1948,6 +1961,7 @@ default_imp_for_new_connector_integration_payouts_sync!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2079,6 +2093,7 @@ default_imp_for_new_connector_integration_payouts_recipient_account!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2208,6 +2223,7 @@ default_imp_for_new_connector_integration_webhook_source_verification!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2339,6 +2355,7 @@ default_imp_for_new_connector_integration_frm_sale!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2470,6 +2487,7 @@ default_imp_for_new_connector_integration_frm_checkout!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2601,6 +2619,7 @@ default_imp_for_new_connector_integration_frm_transaction!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2732,6 +2751,7 @@ default_imp_for_new_connector_integration_frm_fulfillment!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2863,6 +2883,7 @@ default_imp_for_new_connector_integration_frm_record_return!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2991,6 +3012,7 @@ default_imp_for_new_connector_integration_revoking_mandates!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -3110,6 +3132,7 @@ default_imp_for_new_connector_integration_frm!( connectors::Vgs, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Bambora, connectors::Bamboraapac, connectors::Barclaycard, @@ -3238,6 +3261,7 @@ default_imp_for_new_connector_integration_connector_authentication!( connectors::Vgs, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Bambora, connectors::Bamboraapac, connectors::Barclaycard, @@ -3355,6 +3379,7 @@ default_imp_for_new_connector_integration_revenue_recovery!( connectors::Vgs, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Bambora, connectors::Bamboraapac, connectors::Barclaycard, @@ -3485,6 +3510,7 @@ default_imp_for_new_connector_integration_external_vault!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Barclaycard, connectors::Bambora, diff --git a/crates/hyperswitch_domain_models/src/configs.rs b/crates/hyperswitch_domain_models/src/configs.rs index 9e64262f78f..9e4b94f9465 100644 --- a/crates/hyperswitch_domain_models/src/configs.rs +++ b/crates/hyperswitch_domain_models/src/configs.rs @@ -12,6 +12,7 @@ use crate::errors::api_error_response; #[serde(default)] pub struct Connectors { pub aci: ConnectorParams, + pub authipay: ConnectorParams, pub adyen: AdyenParamsWithThreeBaseUrls, pub adyenplatform: ConnectorParams, pub airwallex: ConnectorParams, diff --git a/crates/payment_methods/src/configs/payment_connector_required_fields.rs b/crates/payment_methods/src/configs/payment_connector_required_fields.rs index 08baca7e35f..ec3ea46ccd2 100644 --- a/crates/payment_methods/src/configs/payment_connector_required_fields.rs +++ b/crates/payment_methods/src/configs/payment_connector_required_fields.rs @@ -1195,6 +1195,7 @@ impl Default for RequiredFields { fn get_cards_required_fields() -> HashMap<Connector, RequiredFieldFinal> { HashMap::from([ (Connector::Aci, fields(vec![], vec![], card_with_name())), + (Connector::Authipay, fields(vec![], vec![], card_basic())), (Connector::Adyen, fields(vec![], vec![], card_with_name())), (Connector::Airwallex, fields(vec![], card_basic(), vec![])), ( diff --git a/crates/router/src/connector.rs b/crates/router/src/connector.rs index 619608a95de..d50086f5481 100644 --- a/crates/router/src/connector.rs +++ b/crates/router/src/connector.rs @@ -4,16 +4,16 @@ pub mod utils; pub use hyperswitch_connectors::connectors::DummyConnector; pub use hyperswitch_connectors::connectors::{ aci, aci::Aci, adyen, adyen::Adyen, adyenplatform, adyenplatform::Adyenplatform, airwallex, - airwallex::Airwallex, amazonpay, amazonpay::Amazonpay, archipel, archipel::Archipel, - authorizedotnet, authorizedotnet::Authorizedotnet, bambora, bambora::Bambora, bamboraapac, - bamboraapac::Bamboraapac, bankofamerica, bankofamerica::Bankofamerica, barclaycard, - barclaycard::Barclaycard, billwerk, billwerk::Billwerk, bitpay, bitpay::Bitpay, bluesnap, - bluesnap::Bluesnap, boku, boku::Boku, braintree, braintree::Braintree, cashtocode, - cashtocode::Cashtocode, celero, celero::Celero, chargebee, chargebee::Chargebee, checkbook, - checkbook::Checkbook, checkout, checkout::Checkout, coinbase, coinbase::Coinbase, coingate, - coingate::Coingate, cryptopay, cryptopay::Cryptopay, ctp_mastercard, - ctp_mastercard::CtpMastercard, cybersource, cybersource::Cybersource, datatrans, - datatrans::Datatrans, deutschebank, deutschebank::Deutschebank, digitalvirgo, + airwallex::Airwallex, amazonpay, amazonpay::Amazonpay, archipel, archipel::Archipel, authipay, + authipay::Authipay, authorizedotnet, authorizedotnet::Authorizedotnet, bambora, + bambora::Bambora, bamboraapac, bamboraapac::Bamboraapac, bankofamerica, + bankofamerica::Bankofamerica, barclaycard, barclaycard::Barclaycard, billwerk, + billwerk::Billwerk, bitpay, bitpay::Bitpay, bluesnap, bluesnap::Bluesnap, boku, boku::Boku, + braintree, braintree::Braintree, cashtocode, cashtocode::Cashtocode, celero, celero::Celero, + chargebee, chargebee::Chargebee, checkbook, checkbook::Checkbook, checkout, checkout::Checkout, + coinbase, coinbase::Coinbase, coingate, coingate::Coingate, cryptopay, cryptopay::Cryptopay, + ctp_mastercard, ctp_mastercard::CtpMastercard, cybersource, cybersource::Cybersource, + datatrans, datatrans::Datatrans, deutschebank, deutschebank::Deutschebank, digitalvirgo, digitalvirgo::Digitalvirgo, dlocal, dlocal::Dlocal, dwolla, dwolla::Dwolla, ebanx, ebanx::Ebanx, elavon, elavon::Elavon, facilitapay, facilitapay::Facilitapay, fiserv, fiserv::Fiserv, fiservemea, fiservemea::Fiservemea, fiuu, fiuu::Fiuu, forte, forte::Forte, diff --git a/crates/router/src/core/connector_validation.rs b/crates/router/src/core/connector_validation.rs index 655636197d8..6fb5a340ba2 100644 --- a/crates/router/src/core/connector_validation.rs +++ b/crates/router/src/core/connector_validation.rs @@ -89,6 +89,10 @@ impl ConnectorAuthTypeAndMetadataValidation<'_> { archipel::transformers::ArchipelConfigData::try_from(self.connector_meta_data)?; Ok(()) } + api_enums::Connector::Authipay => { + authipay::transformers::AuthipayAuthType::try_from(self.auth_type)?; + Ok(()) + } api_enums::Connector::Authorizedotnet => { authorizedotnet::transformers::AuthorizedotnetAuthType::try_from(self.auth_type)?; Ok(()) diff --git a/crates/router/src/types/api.rs b/crates/router/src/types/api.rs index 45d6dd0d75e..eab04a9f0cc 100644 --- a/crates/router/src/types/api.rs +++ b/crates/router/src/types/api.rs @@ -328,6 +328,10 @@ impl ConnectorData { match enums::Connector::from_str(connector_name) { Ok(name) => match name { enums::Connector::Aci => Ok(ConnectorEnum::Old(Box::new(connector::Aci::new()))), + + enums::Connector::Authipay => { + Ok(ConnectorEnum::Old(Box::new(connector::Authipay::new()))) + } enums::Connector::Adyen => { Ok(ConnectorEnum::Old(Box::new(connector::Adyen::new()))) } diff --git a/crates/router/src/types/transformers.rs b/crates/router/src/types/transformers.rs index 713293568b3..35ba30da6a7 100644 --- a/crates/router/src/types/transformers.rs +++ b/crates/router/src/types/transformers.rs @@ -207,6 +207,7 @@ impl ForeignTryFrom<api_enums::Connector> for common_enums::RoutableConnectors { fn foreign_try_from(from: api_enums::Connector) -> Result<Self, Self::Error> { Ok(match from { api_enums::Connector::Aci => Self::Aci, + api_enums::Connector::Authipay => Self::Authipay, api_enums::Connector::Adyen => Self::Adyen, api_enums::Connector::Adyenplatform => Self::Adyenplatform, api_enums::Connector::Airwallex => Self::Airwallex, diff --git a/crates/router/tests/connectors/authipay.rs b/crates/router/tests/connectors/authipay.rs new file mode 100644 index 00000000000..aa362166fdf --- /dev/null +++ b/crates/router/tests/connectors/authipay.rs @@ -0,0 +1,454 @@ +use std::str::FromStr; +use masking::Secret; +use router::{ + types::{self, api, storage::enums}, + core::errors, +}; +use cards; + +use crate::utils::{self, ConnectorActions}; +use test_utils::connector_auth; + +#[derive(Clone, Copy)] +struct AuthipayTest; +impl ConnectorActions for AuthipayTest {} +impl utils::Connector for AuthipayTest { + fn get_data(&self) -> api::ConnectorData { + use router::connector::Authipay; + api::ConnectorData { + connector: Box::new(Authipay::new()), + connector_name: types::Connector::Authipay, + get_token: types::api::GetToken::Connector, + merchant_connector_id: None, + } + } + + fn get_auth_token(&self) -> types::ConnectorAuthType { + utils::to_connector_auth_type( + connector_auth::ConnectorAuthentication::new() + .authipay + .expect("Missing connector authentication configuration").into(), + ) + } + + fn get_name(&self) -> String { + "authipay".to_string() + } +} + +static CONNECTOR: AuthipayTest = AuthipayTest {}; + +fn get_default_payment_info() -> Option<utils::PaymentInfo> { + Some(utils::PaymentInfo { + payment_id: utils::get_payment_id(), + payment_method: enums::PaymentMethod::Card, + payment_method_type: Some(enums::PaymentMethodType::Credit), + amount: 100, // $1.00 + currency: enums::Currency::USD, + capture_method: Some(enums::CaptureMethod::Manual), + mandate_id: None, + setup_future_usage: None, + off_session: None, + merchant_connector_id: None, + browser_info: None, + recurring_mandate_payment: None, + router_return_url: None, + connector_meta: None, + allowed_payment_method_types: None, + pm_token: None, + payment_experience: None, + webhook_url: None, + customer_id: None, + surcharge_details: None, + connector_request_reference_id: None, + request_incremental_authorization: None, + metadata: None, + payment_type: None, + session_token: None, + terminal_id: None, + card_network: None, + capture_on: None, + incremental_authorization_allowed: None, + }) +} + +fn payment_method_details() -> Option<types::PaymentsAuthorizeData> { + Some(types::PaymentsAuthorizeData { + payment_method_data: api::PaymentMethodData::Card(api::Card { + card_number: cards::CardNumber::from_str("4035874000424977").unwrap(), // Visa test card from Authipay specs + card_exp_month: Secret::new("12".to_string()), + card_exp_year: Secret::new("2024".to_string()), + card_cvc: Secret::new("123".to_string()), + card_holder_name: Secret::new("John Doe".to_string()), + card_issuer: None, + card_network: None, + card_type: None, + card_issuing_country: None, + bank_code: None, + nick_name: Some("Default Card".to_string()), + }), + currency: enums::Currency::USD, + amount: 100, // $1.00 + router_return_url: String::from("http://localhost:8080/"), + payment_method_type: Some(enums::PaymentMethodType::Credit), + ..utils::PaymentAuthorizeType::default().0 + }) +} + +// Cards Positive Tests +// Creates a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_only_authorize_payment() { + let response = CONNECTOR + .authorize_payment(payment_method_details(), get_default_payment_info()) + .await + .expect("Authorize payment response"); + assert_eq!(response.status, enums::AttemptStatus::Authorized); +} + +// Captures a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_capture_authorized_payment() { + let response = CONNECTOR + .authorize_and_capture_payment(payment_method_details(), None, get_default_payment_info()) + .await + .expect("Capture payment response"); + assert_eq!(response.status, enums::AttemptStatus::Charged); +} + +// Partially captures a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_capture_authorized_payment() { + let response = CONNECTOR + .authorize_and_capture_payment( + payment_method_details(), + Some(types::PaymentsCaptureData { + amount_to_capture: 50, + ..utils::PaymentCaptureType::default().0 + }), + get_default_payment_info(), + ) + .await + .expect("Capture payment response"); + assert_eq!(response.status, enums::AttemptStatus::Charged); +} + +// Synchronizes a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_authorized_payment() { + let authorize_response = CONNECTOR + .authorize_payment(payment_method_details(), get_default_payment_info()) + .await + .expect("Authorize payment response"); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + let response = CONNECTOR + .psync_retry_till_status_matches( + enums::AttemptStatus::Authorized, + Some(types::PaymentsSyncData { + connector_transaction_id: types::ResponseId::ConnectorTransactionId( + txn_id.unwrap(), + ), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .expect("PSync response"); + assert_eq!(response.status, enums::AttemptStatus::Authorized,); +} + +// Voids a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_void_authorized_payment() { + let response = CONNECTOR + .authorize_and_void_payment( + payment_method_details(), + Some(types::PaymentsCancelData { + connector_transaction_id: String::from(""), + cancellation_reason: Some("requested_by_customer".to_string()), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .expect("Void payment response"); + assert_eq!(response.status, enums::AttemptStatus::Voided); +} + +// Refunds a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_manually_captured_payment() { + let response = CONNECTOR + .capture_payment_and_refund(payment_method_details(), None, None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Partially refunds a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_refund_manually_captured_payment() { + let response = CONNECTOR + .capture_payment_and_refund( + payment_method_details(), + None, + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Synchronizes a refund using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_manually_captured_refund() { + let refund_response = CONNECTOR + .capture_payment_and_refund(payment_method_details(), None, None, get_default_payment_info()) + .await + .unwrap(); + let response = CONNECTOR + .rsync_retry_till_status_matches( + enums::RefundStatus::Success, + refund_response.response.unwrap().connector_refund_id, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Creates a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_make_payment() { + let authorize_response = CONNECTOR.make_payment(payment_method_details(), get_default_payment_info()).await.unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); +} + +// Synchronizes a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_auto_captured_payment() { + let authorize_response = CONNECTOR.make_payment(payment_method_details(), get_default_payment_info()).await.unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + assert_ne!(txn_id, None, "Empty connector transaction id"); + let response = CONNECTOR + .psync_retry_till_status_matches( + enums::AttemptStatus::Charged, + Some(types::PaymentsSyncData { + connector_transaction_id: types::ResponseId::ConnectorTransactionId( + txn_id.unwrap(), + ), + capture_method: Some(enums::CaptureMethod::Automatic), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!(response.status, enums::AttemptStatus::Charged,); +} + +// Refunds a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_auto_captured_payment() { + let response = CONNECTOR + .make_payment_and_refund(payment_method_details(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Partially refunds a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_refund_succeeded_payment() { + let refund_response = CONNECTOR + .make_payment_and_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + refund_response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Creates multiple refunds against a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_succeeded_payment_multiple_times() { + CONNECTOR + .make_payment_and_multiple_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await; +} + +// Synchronizes a refund using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_refund() { + let refund_response = CONNECTOR + .make_payment_and_refund(payment_method_details(), None, get_default_payment_info()) + .await + .unwrap(); + let response = CONNECTOR + .rsync_retry_till_status_matches( + enums::RefundStatus::Success, + refund_response.response.unwrap().connector_refund_id, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Cards Negative scenarios +// Creates a payment with incorrect CVC. +#[actix_web::test] +async fn should_fail_payment_for_incorrect_cvc() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: types::api::PaymentMethodData::Card(api::Card { + card_cvc: Secret::new("12345".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's security code is invalid.".to_string(), + ); +} + +// Creates a payment with incorrect expiry month. +#[actix_web::test] +async fn should_fail_payment_for_invalid_exp_month() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: api::PaymentMethodData::Card(api::Card { + card_exp_month: Secret::new("20".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's expiration month is invalid.".to_string(), + ); +} + +// Creates a payment with incorrect expiry year. +#[actix_web::test] +async fn should_fail_payment_for_incorrect_expiry_year() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: api::PaymentMethodData::Card(api::Card { + card_exp_year: Secret::new("2000".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's expiration year is invalid.".to_string(), + ); +} + +// Voids a payment using automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_fail_void_payment_for_auto_capture() { + let authorize_response = CONNECTOR.make_payment(payment_method_details(), get_default_payment_info()).await.unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + assert_ne!(txn_id, None, "Empty connector transaction id"); + let void_response = CONNECTOR + .void_payment(txn_id.unwrap(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + void_response.response.unwrap_err().message, + "You cannot cancel this PaymentIntent because it has a status of succeeded." + ); +} + +// Captures a payment using invalid connector payment id. +#[actix_web::test] +async fn should_fail_capture_for_invalid_payment() { + let capture_response = CONNECTOR + .capture_payment("123456789".to_string(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + capture_response.response.unwrap_err().message, + String::from("No such payment_intent: '123456789'") + ); +} + +// Refunds a payment with refund amount higher than payment amount. +#[actix_web::test] +async fn should_fail_for_refund_amount_higher_than_payment_amount() { + let response = CONNECTOR + .make_payment_and_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 150, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Refund amount (₹1.50) is greater than charge amount (₹1.00)", + ); +} + +// Connector dependent test cases goes here + +// [#478]: add unit tests for non 3DS, wallets & webhooks in connector tests diff --git a/crates/router/tests/connectors/sample_auth.toml b/crates/router/tests/connectors/sample_auth.toml index 7d5a742aaf5..a7f18afcb78 100644 --- a/crates/router/tests/connectors/sample_auth.toml +++ b/crates/router/tests/connectors/sample_auth.toml @@ -341,10 +341,16 @@ api_key = "MyApiKey" key1 = "Merchant id" api_secret = "Secret key" + +[authipay] +api_key = "MyApiKey" +api_secret = "MySecretKey" + [checkbook] api_key="Client ID" key1 ="Client Secret" + [santander] api_key="Client ID" key1 ="Client Secret" @@ -354,4 +360,5 @@ api_key="Client ID" key1="Client Secret" [payload] -api_key="API Key" \ No newline at end of file +api_key="API Key" + diff --git a/crates/test_utils/src/connector_auth.rs b/crates/test_utils/src/connector_auth.rs index 25fffd09b0f..14e08be1623 100644 --- a/crates/test_utils/src/connector_auth.rs +++ b/crates/test_utils/src/connector_auth.rs @@ -19,6 +19,7 @@ pub struct ConnectorAuthentication { pub airwallex: Option<BodyKey>, pub amazonpay: Option<HeaderKey>, pub archipel: Option<NoKey>, + pub authipay: Option<SignatureKey>, pub authorizedotnet: Option<BodyKey>, pub bambora: Option<BodyKey>, pub bamboraapac: Option<HeaderKey>, diff --git a/loadtest/config/development.toml b/loadtest/config/development.toml index b1c7a7581c4..4711699bdf9 100644 --- a/loadtest/config/development.toml +++ b/loadtest/config/development.toml @@ -82,6 +82,7 @@ airwallex.base_url = "https://api-demo.airwallex.com/" amazonpay.base_url = "https://pay-api.amazon.com/v2" applepay.base_url = "https://apple-pay-gateway.apple.com/" archipel.base_url = "https://{{merchant_endpoint_prefix}}/ArchiPEL/Transaction/v1" +authipay.base_url = "https://prod.emea.api.fiservapps.com/sandbox/ipp/payments-gateway/v2/" authorizedotnet.base_url = "https://apitest.authorize.net/xml/v1/request.api" bambora.base_url = "https://api.na.bambora.com" bamboraapac.base_url = "https://demo.ippayments.com.au/interface/api" @@ -217,6 +218,7 @@ cards = [ "airwallex", "amazonpay", "archipel", + "authipay", "authorizedotnet", "bambora", "bamboraapac", diff --git a/scripts/add_connector.sh b/scripts/add_connector.sh index 90424011957..98490f12324 100755 --- a/scripts/add_connector.sh +++ b/scripts/add_connector.sh @@ -6,7 +6,7 @@ function find_prev_connector() { git checkout $self cp $self $self.tmp # Add new connector to existing list and sort it - connectors=(aci adyen adyenplatform airwallex amazonpay applepay archipel authorizedotnet bambora bamboraapac bankofamerica barclaycard billwerk bitpay bluesnap boku braintree cashtocode celero chargebee checkbook checkout coinbase cryptopay ctp_visa cybersource datatrans deutschebank digitalvirgo dlocal dummyconnector dwolla ebanx elavon facilitapay fiserv fiservemea fiuu forte getnet globalpay globepay gocardless gpayments helcim hipay hyperswitch_vault iatapay inespay itaubank jpmorgan juspaythreedsserver klarna mifinity mollie moneris multisafepay netcetera nexinets nexixpay nomupay noon nordea novalnet nuvei opayo opennode paybox payeezy payload payme payone paypal paystack payu placetopay plaid powertranz prophetpay rapyd razorpay recurly redsys santander shift4 silverflow square stax stripe stripebilling taxjar threedsecureio thunes tokenio trustpay tsys unified_authentication_service vgs volt wellsfargo wellsfargopayout wise worldline worldpay worldpayvantiv worldpayxml xendit zsl "$1") + connectors=(aci adyen adyenplatform airwallex amazonpay applepay archipel authipay authorizedotnet bambora bamboraapac bankofamerica barclaycard billwerk bitpay bluesnap boku braintree cashtocode celero chargebee checkbook checkout coinbase cryptopay ctp_visa cybersource datatrans deutschebank digitalvirgo dlocal dummyconnector dwolla ebanx elavon facilitapay fiserv fiservemea fiuu forte getnet globalpay globepay gocardless gpayments helcim hipay hyperswitch_vault iatapay inespay itaubank jpmorgan juspaythreedsserver klarna mifinity mollie moneris multisafepay netcetera nexinets nexixpay nomupay noon nordea novalnet nuvei opayo opennode paybox payeezy payload payme payone paypal paystack payu placetopay plaid powertranz prophetpay rapyd razorpay recurly redsys santander shift4 silverflow square stax stripe stripebilling taxjar threedsecureio thunes tokenio trustpay tsys unified_authentication_service vgs volt wellsfargo wellsfargopayout wise worldline worldpay worldpayvantiv worldpayxml xendit zsl "$1") IFS=$'\n' sorted=($(sort <<<"${connectors[*]}")); unset IFS res="$(echo ${sorted[@]})"

2025-06-05T09:43:43Z

## Type of Change  - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description Cards Non-3DS payments added for authipay https://docs.fiserv.dev/public/reference/payments-intro ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  https://github.com/juspay/hyperswitch/issues/8398 ## How did you test it? Tested using cargo build and cypress test <img width="738" alt="Screenshot 2025-07-04 at 11 49 02 AM" src="https://github.com/user-attachments/assets/d4927935-5af6-4b14-88c4-dc1c9f723886" />  ## Checklist  - [`x`] I formatted the code `cargo +nightly fmt --all` - [`x`] I addressed lints thrown by `cargo clippy` - [`x`] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

c322eb9cabb2ca7a8ad0c3ed57192dde9bf7eaa4

juspay/hyperswitch

juspay__hyperswitch-8389

Bug: [FEATURE] Kv Redis feature for V2 models ### Feature Description Extend kv support for v2 models ### Possible Implementation Use existing construct to extend to v2 models ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? Yes, I am willing to submit a PR!

diff --git a/crates/diesel_models/src/kv.rs b/crates/diesel_models/src/kv.rs index 6c0666e5903..ed984649e92 100644 --- a/crates/diesel_models/src/kv.rs +++ b/crates/diesel_models/src/kv.rs @@ -126,12 +126,7 @@ impl DBOperation { )), #[cfg(feature = "v2")] Updateable::PaymentAttemptUpdate(a) => DBResult::PaymentAttempt(Box::new( - a.orig - .update_with_attempt_id( - conn, - PaymentAttemptUpdateInternal::from(a.update_data), - ) - .await?, + a.orig.update_with_attempt_id(conn, a.update_data).await?, )), #[cfg(feature = "v1")] Updateable::RefundUpdate(a) => { @@ -263,12 +258,20 @@ pub struct PaymentIntentUpdateMems { pub update_data: PaymentIntentUpdateInternal, } +#[cfg(feature = "v1")] #[derive(Debug, Serialize, Deserialize)] pub struct PaymentAttemptUpdateMems { pub orig: PaymentAttempt, pub update_data: PaymentAttemptUpdate, } +#[cfg(feature = "v2")] +#[derive(Debug, Serialize, Deserialize)] +pub struct PaymentAttemptUpdateMems { + pub orig: PaymentAttempt, + pub update_data: PaymentAttemptUpdateInternal, +} + #[derive(Debug, Serialize, Deserialize)] pub struct RefundUpdateMems { pub orig: Refund, diff --git a/crates/diesel_models/src/payment_attempt.rs b/crates/diesel_models/src/payment_attempt.rs index 95fb600adc4..0afea0574a7 100644 --- a/crates/diesel_models/src/payment_attempt.rs +++ b/crates/diesel_models/src/payment_attempt.rs @@ -833,7 +833,7 @@ pub enum PaymentAttemptUpdate { // TODO: uncomment fields as and when required #[cfg(feature = "v2")] -#[derive(Clone, Debug, AsChangeset, router_derive::DebugAsDisplay)] +#[derive(Clone, Debug, AsChangeset, router_derive::DebugAsDisplay, Serialize, Deserialize)] #[diesel(table_name = payment_attempt)] pub struct PaymentAttemptUpdateInternal { pub status: Option<storage_enums::AttemptStatus>, @@ -881,6 +881,112 @@ pub struct PaymentAttemptUpdateInternal { pub connector_request_reference_id: Option<String>, } +#[cfg(feature = "v2")] +impl PaymentAttemptUpdateInternal { + pub fn apply_changeset(self, source: PaymentAttempt) -> PaymentAttempt { + let Self { + status, + authentication_type, + error_message, + connector_payment_id, + modified_at, + browser_info, + error_code, + connector_metadata, + error_reason, + amount_capturable, + amount_to_capture, + updated_by, + merchant_connector_id, + connector, + redirection_data, + unified_code, + unified_message, + connector_token_details, + feature_metadata, + network_decline_code, + network_advice_code, + network_error_message, + payment_method_id, + connector_request_reference_id, + } = self; + + PaymentAttempt { + payment_id: source.payment_id, + merchant_id: source.merchant_id, + status: status.unwrap_or(source.status), + connector: connector.or(source.connector), + error_message: error_message.or(source.error_message), + surcharge_amount: source.surcharge_amount, + payment_method_id: payment_method_id.or(source.payment_method_id), + authentication_type: authentication_type.unwrap_or(source.authentication_type), + created_at: source.created_at, + modified_at: common_utils::date_time::now(), + last_synced: source.last_synced, + cancellation_reason: source.cancellation_reason, + amount_to_capture: amount_to_capture.or(source.amount_to_capture), + browser_info: browser_info + .and_then(|val| { + serde_json::from_value::<common_utils::types::BrowserInformation>(val).ok() + }) + .or(source.browser_info), + error_code: error_code.or(source.error_code), + payment_token: source.payment_token, + connector_metadata: connector_metadata.or(source.connector_metadata), + payment_experience: source.payment_experience, + payment_method_data: source.payment_method_data, + preprocessing_step_id: source.preprocessing_step_id, + error_reason: error_reason.or(source.error_reason), + multiple_capture_count: source.multiple_capture_count, + connector_response_reference_id: source.connector_response_reference_id, + amount_capturable: amount_capturable.unwrap_or(source.amount_capturable), + updated_by, + merchant_connector_id: merchant_connector_id.or(source.merchant_connector_id), + encoded_data: source.encoded_data, + unified_code: unified_code.flatten().or(source.unified_code), + unified_message: unified_message.flatten().or(source.unified_message), + net_amount: source.net_amount, + external_three_ds_authentication_attempted: source + .external_three_ds_authentication_attempted, + authentication_connector: source.authentication_connector, + authentication_id: source.authentication_id, + fingerprint_id: source.fingerprint_id, + client_source: source.client_source, + client_version: source.client_version, + customer_acceptance: source.customer_acceptance, + profile_id: source.profile_id, + organization_id: source.organization_id, + card_network: source.card_network, + shipping_cost: source.shipping_cost, + order_tax_amount: source.order_tax_amount, + request_extended_authorization: source.request_extended_authorization, + extended_authorization_applied: source.extended_authorization_applied, + capture_before: source.capture_before, + card_discovery: source.card_discovery, + charges: source.charges, + processor_merchant_id: source.processor_merchant_id, + created_by: source.created_by, + payment_method_type_v2: source.payment_method_type_v2, + connector_payment_id: source.connector_payment_id, + payment_method_subtype: source.payment_method_subtype, + routing_result: source.routing_result, + authentication_applied: source.authentication_applied, + external_reference_id: source.external_reference_id, + tax_on_surcharge: source.tax_on_surcharge, + payment_method_billing_address: source.payment_method_billing_address, + redirection_data: redirection_data.or(source.redirection_data), + connector_payment_data: source.connector_payment_data, + connector_token_details: connector_token_details.or(source.connector_token_details), + id: source.id, + feature_metadata: feature_metadata.or(source.feature_metadata), + network_advice_code: network_advice_code.or(source.network_advice_code), + network_decline_code: network_decline_code.or(source.network_decline_code), + network_error_message: network_error_message.or(source.network_error_message), + connector_request_reference_id: connector_request_reference_id + .or(source.connector_request_reference_id), + } + } +} #[cfg(feature = "v1")] #[derive(Clone, Debug, AsChangeset, router_derive::DebugAsDisplay)] #[diesel(table_name = payment_attempt)] diff --git a/crates/diesel_models/src/payment_intent.rs b/crates/diesel_models/src/payment_intent.rs index ea0a9cead20..bcaefa512db 100644 --- a/crates/diesel_models/src/payment_intent.rs +++ b/crates/diesel_models/src/payment_intent.rs @@ -632,6 +632,122 @@ pub struct PaymentIntentUpdateInternal { pub is_iframe_redirection_enabled: Option<bool>, } +#[cfg(feature = "v2")] +impl PaymentIntentUpdateInternal { + pub fn apply_changeset(self, source: PaymentIntent) -> PaymentIntent { + let Self { + status, + prerouting_algorithm, + amount_captured, + modified_at: _, // This will be ignored from self + active_attempt_id, + amount, + currency, + shipping_cost, + tax_details, + skip_external_tax_calculation, + surcharge_applicable, + surcharge_amount, + tax_on_surcharge, + routing_algorithm_id, + capture_method, + authentication_type, + billing_address, + shipping_address, + customer_present, + description, + return_url, + setup_future_usage, + apply_mit_exemption, + statement_descriptor, + order_details, + allowed_payment_method_types, + metadata, + connector_metadata, + feature_metadata, + payment_link_config, + request_incremental_authorization, + session_expiry, + frm_metadata, + request_external_three_ds_authentication, + updated_by, + force_3ds_challenge, + is_iframe_redirection_enabled, + } = self; + + PaymentIntent { + status: status.unwrap_or(source.status), + prerouting_algorithm: prerouting_algorithm.or(source.prerouting_algorithm), + amount_captured: amount_captured.or(source.amount_captured), + modified_at: common_utils::date_time::now(), + active_attempt_id: match active_attempt_id { + Some(v_option) => v_option, + None => source.active_attempt_id, + }, + amount: amount.unwrap_or(source.amount), + currency: currency.unwrap_or(source.currency), + shipping_cost: shipping_cost.or(source.shipping_cost), + tax_details: tax_details.or(source.tax_details), + skip_external_tax_calculation: skip_external_tax_calculation + .or(source.skip_external_tax_calculation), + surcharge_applicable: surcharge_applicable.or(source.surcharge_applicable), + surcharge_amount: surcharge_amount.or(source.surcharge_amount), + tax_on_surcharge: tax_on_surcharge.or(source.tax_on_surcharge), + routing_algorithm_id: routing_algorithm_id.or(source.routing_algorithm_id), + capture_method: capture_method.or(source.capture_method), + authentication_type: authentication_type.or(source.authentication_type), + billing_address: billing_address.or(source.billing_address), + shipping_address: shipping_address.or(source.shipping_address), + customer_present: customer_present.or(source.customer_present), + description: description.or(source.description), + return_url: return_url.or(source.return_url), + setup_future_usage: setup_future_usage.or(source.setup_future_usage), + apply_mit_exemption: apply_mit_exemption.or(source.apply_mit_exemption), + statement_descriptor: statement_descriptor.or(source.statement_descriptor), + order_details: order_details.or(source.order_details), + allowed_payment_method_types: allowed_payment_method_types + .or(source.allowed_payment_method_types), + metadata: metadata.or(source.metadata), + connector_metadata: connector_metadata.or(source.connector_metadata), + feature_metadata: feature_metadata.or(source.feature_metadata), + payment_link_config: payment_link_config.or(source.payment_link_config), + request_incremental_authorization: request_incremental_authorization + .or(source.request_incremental_authorization), + session_expiry: session_expiry.unwrap_or(source.session_expiry), + frm_metadata: frm_metadata.or(source.frm_metadata), + request_external_three_ds_authentication: request_external_three_ds_authentication + .or(source.request_external_three_ds_authentication), + updated_by, + force_3ds_challenge: force_3ds_challenge.or(source.force_3ds_challenge), + is_iframe_redirection_enabled: is_iframe_redirection_enabled + .or(source.is_iframe_redirection_enabled), + + // Fields from source + merchant_id: source.merchant_id, + customer_id: source.customer_id, + created_at: source.created_at, + last_synced: source.last_synced, + attempt_count: source.attempt_count, + profile_id: source.profile_id, + payment_link_id: source.payment_link_id, + authorization_count: source.authorization_count, + customer_details: source.customer_details, + organization_id: source.organization_id, + request_extended_authorization: source.request_extended_authorization, + psd2_sca_exemption_type: source.psd2_sca_exemption_type, + split_payments: source.split_payments, + platform_merchant_id: source.platform_merchant_id, + force_3ds_challenge_trigger: source.force_3ds_challenge_trigger, + processor_merchant_id: source.processor_merchant_id, + created_by: source.created_by, + merchant_reference_id: source.merchant_reference_id, + frm_merchant_decision: source.frm_merchant_decision, + enable_payment_link: source.enable_payment_link, + id: source.id, + } + } +} + #[cfg(feature = "v1")] #[derive(Clone, Debug, AsChangeset, router_derive::DebugAsDisplay)] #[diesel(table_name = payment_intent)] diff --git a/crates/drainer/Cargo.toml b/crates/drainer/Cargo.toml index 1a02f9f3d95..800622cf36a 100644 --- a/crates/drainer/Cargo.toml +++ b/crates/drainer/Cargo.toml @@ -11,6 +11,7 @@ license.workspace = true release = ["vergen", "external_services/aws_kms"] vergen = ["router_env/vergen"] v1 = ["diesel_models/v1", "hyperswitch_interfaces/v1", "common_utils/v1"] +v2 = ["diesel_models/v2", "hyperswitch_interfaces/v2", "common_utils/v2"] [dependencies] actix-web = "4.11.0" diff --git a/crates/hyperswitch_interfaces/Cargo.toml b/crates/hyperswitch_interfaces/Cargo.toml index 04cb644a1d7..6b216d5c86f 100644 --- a/crates/hyperswitch_interfaces/Cargo.toml +++ b/crates/hyperswitch_interfaces/Cargo.toml @@ -10,7 +10,7 @@ license.workspace = true default = ["dummy_connector", "frm", "payouts"] dummy_connector = [] v1 = ["hyperswitch_domain_models/v1", "api_models/v1", "common_utils/v1"] -v2 = [] +v2 = ["api_models/v2", "common_utils/v2", "hyperswitch_domain_models/v2"] payouts = ["hyperswitch_domain_models/payouts"] frm = ["hyperswitch_domain_models/frm"] revenue_recovery = [] diff --git a/crates/router/src/lib.rs b/crates/router/src/lib.rs index ed51b12ff00..6bcb17ad1a5 100644 --- a/crates/router/src/lib.rs +++ b/crates/router/src/lib.rs @@ -116,7 +116,7 @@ pub fn mk_app( > { let mut server_app = get_application_builder(request_body_limit, state.conf.cors.clone()); - #[cfg(all(feature = "dummy_connector", feature = "v1"))] + #[cfg(feature = "dummy_connector")] { use routes::DummyConnector; server_app = server_app.service(DummyConnector::server(state.clone())); diff --git a/crates/router/src/routes/admin.rs b/crates/router/src/routes/admin.rs index d3ffb715b73..20de3c492e7 100644 --- a/crates/router/src/routes/admin.rs +++ b/crates/router/src/routes/admin.rs @@ -915,6 +915,7 @@ pub async fn connector_delete( /// Merchant Account - Toggle KV /// /// Toggle KV mode for the Merchant Account +#[cfg(feature = "v1")] #[instrument(skip_all)] pub async fn merchant_account_toggle_kv( state: web::Data<AppState>, @@ -938,6 +939,29 @@ pub async fn merchant_account_toggle_kv( .await } +#[cfg(feature = "v2")] +#[instrument(skip_all)] +pub async fn merchant_account_toggle_kv( + state: web::Data<AppState>, + req: HttpRequest, + path: web::Path<common_utils::id_type::MerchantId>, + json_payload: web::Json<admin::ToggleKVRequest>, +) -> HttpResponse { + let flow = Flow::ConfigKeyUpdate; + let mut payload = json_payload.into_inner(); + payload.merchant_id = path.into_inner(); + + api::server_wrap( + flow, + state, + &req, + payload, + |state, _, payload, _| kv_for_merchant(state, payload.merchant_id, payload.kv_enabled), + &auth::V2AdminApiAuth, + api_locking::LockAction::NotApplicable, + ) + .await +} /// Merchant Account - Transfer Keys /// /// Transfer Merchant Encryption key to keymanager @@ -965,6 +989,7 @@ pub async fn merchant_account_toggle_all_kv( /// Merchant Account - KV Status /// /// Toggle KV mode for the Merchant Account +#[cfg(feature = "v1")] #[instrument(skip_all)] pub async fn merchant_account_kv_status( state: web::Data<AppState>, @@ -986,6 +1011,27 @@ pub async fn merchant_account_kv_status( .await } +#[cfg(feature = "v2")] +#[instrument(skip_all)] +pub async fn merchant_account_kv_status( + state: web::Data<AppState>, + req: HttpRequest, + path: web::Path<common_utils::id_type::MerchantId>, +) -> HttpResponse { + let flow = Flow::ConfigKeyFetch; + let merchant_id = path.into_inner(); + + api::server_wrap( + flow, + state, + &req, + merchant_id, + |state, _, req, _| check_merchant_account_kv_status(state, req), + &auth::V2AdminApiAuth, + api_locking::LockAction::NotApplicable, + ) + .await +} /// Merchant Account - KV Status /// /// Toggle KV mode for the Merchant Account diff --git a/crates/router/src/routes/app.rs b/crates/router/src/routes/app.rs index 8656d3f2890..cabcc8d1507 100644 --- a/crates/router/src/routes/app.rs +++ b/crates/router/src/routes/app.rs @@ -600,6 +600,22 @@ impl DummyConnector { } } +#[cfg(all(feature = "dummy_connector", feature = "v2"))] +impl DummyConnector { + pub fn server(state: AppState) -> Scope { + let mut routes_with_restricted_access = web::scope(""); + #[cfg(not(feature = "external_access_dc"))] + { + routes_with_restricted_access = + routes_with_restricted_access.guard(actix_web::guard::Host("localhost")); + } + routes_with_restricted_access = routes_with_restricted_access + .service(web::resource("/payment").route(web::post().to(dummy_connector_payment))); + web::scope("/dummy-connector") + .app_data(web::Data::new(state)) + .service(routes_with_restricted_access) + } +} pub struct Payments; #[cfg(all(any(feature = "olap", feature = "oltp"), feature = "v2"))] @@ -1556,6 +1572,11 @@ impl MerchantAccount { ) .service( web::resource("/profiles").route(web::get().to(profiles::profiles_list)), + ) + .service( + web::resource("/kv") + .route(web::post().to(admin::merchant_account_toggle_kv)) + .route(web::get().to(admin::merchant_account_kv_status)), ), ) } diff --git a/crates/router/src/routes/dummy_connector.rs b/crates/router/src/routes/dummy_connector.rs index 5d425c675a5..c0a7bc9f7fc 100644 --- a/crates/router/src/routes/dummy_connector.rs +++ b/crates/router/src/routes/dummy_connector.rs @@ -61,7 +61,7 @@ pub async fn dummy_connector_complete_payment( .await } -#[cfg(all(feature = "dummy_connector", feature = "v1"))] +#[cfg(feature = "dummy_connector")] #[instrument(skip_all, fields(flow = ?types::Flow::DummyPaymentCreate))] pub async fn dummy_connector_payment( state: web::Data<app::AppState>, @@ -82,7 +82,7 @@ pub async fn dummy_connector_payment( .await } -#[cfg(all(feature = "dummy_connector", feature = "v1"))] +#[cfg(feature = "dummy_connector")] #[instrument(skip_all, fields(flow = ?types::Flow::DummyPaymentRetrieve))] pub async fn dummy_connector_payment_data( state: web::Data<app::AppState>, diff --git a/crates/router/src/routes/dummy_connector/core.rs b/crates/router/src/routes/dummy_connector/core.rs index cafb6b58bca..0d7fb9627cc 100644 --- a/crates/router/src/routes/dummy_connector/core.rs +++ b/crates/router/src/routes/dummy_connector/core.rs @@ -9,7 +9,7 @@ use crate::{ utils::OptionExt, }; -#[cfg(all(feature = "dummy_connector", feature = "v1"))] +#[cfg(feature = "dummy_connector")] pub async fn payment( state: SessionState, req: types::DummyConnectorPaymentRequest, diff --git a/crates/storage_impl/src/customers.rs b/crates/storage_impl/src/customers.rs index bedbcadd6a8..53056a137c1 100644 --- a/crates/storage_impl/src/customers.rs +++ b/crates/storage_impl/src/customers.rs @@ -23,6 +23,32 @@ use crate::{ impl KvStorePartition for customers::Customer {} +#[cfg(feature = "v2")] +mod label { + use common_utils::id_type; + + pub(super) const MODEL_NAME: &str = "customer_v2"; + pub(super) const CLUSTER_LABEL: &str = "cust"; + + pub(super) fn get_global_id_label(global_customer_id: &id_type::GlobalCustomerId) -> String { + format!( + "customer_global_id_{}", + global_customer_id.get_string_repr() + ) + } + + pub(super) fn get_merchant_scoped_id_label( + merchant_id: &id_type::MerchantId, + merchant_reference_id: &id_type::CustomerId, + ) -> String { + format!( + "customer_mid_{}_mrefid_{}", + merchant_id.get_string_repr(), + merchant_reference_id.get_string_repr() + ) + } +} + #[async_trait::async_trait] impl<T: DatabaseStore> domain::CustomerInterface for kv_router_store::KVRouterStore<T> { type Error = StorageError; @@ -283,22 +309,32 @@ impl<T: DatabaseStore> domain::CustomerInterface for kv_router_store::KVRouterSt .construct_new() .await .change_context(StorageError::EncryptionError)?; - let storage_scheme = Box::pin(decide_storage_scheme::<_, customers::Customer>( + + let decided_storage_scheme = Box::pin(decide_storage_scheme::<_, customers::Customer>( self, storage_scheme, Op::Insert, )) .await; - new_customer.update_storage_scheme(storage_scheme); + new_customer.update_storage_scheme(decided_storage_scheme); + + let mut reverse_lookups = Vec::new(); + + if let Some(ref merchant_ref_id) = new_customer.merchant_reference_id { + let reverse_lookup_merchant_scoped_id = + label::get_merchant_scoped_id_label(&new_customer.merchant_id, merchant_ref_id); + reverse_lookups.push(reverse_lookup_merchant_scoped_id); + } + self.insert_resource( state, key_store, - storage_scheme, + decided_storage_scheme, new_customer.clone().insert(&conn), new_customer.clone().into(), kv_router_store::InsertResourceParams { insertable: kv::Insertable::Customer(new_customer.clone()), - reverse_lookups: vec![], + reverse_lookups, identifier, key, resource_type: "customer", diff --git a/crates/storage_impl/src/lib.rs b/crates/storage_impl/src/lib.rs index 814314f4351..156ebee2dea 100644 --- a/crates/storage_impl/src/lib.rs +++ b/crates/storage_impl/src/lib.rs @@ -378,6 +378,16 @@ impl UniqueConstraints for diesel_models::PaymentAttempt { } } +#[cfg(feature = "v2")] +impl UniqueConstraints for diesel_models::PaymentAttempt { + fn unique_constraints(&self) -> Vec<String> { + vec![format!("pa_{}", self.id.get_string_repr())] + } + fn table_name(&self) -> &str { + "PaymentAttempt" + } +} + #[cfg(feature = "v1")] impl UniqueConstraints for diesel_models::Refund { fn unique_constraints(&self) -> Vec<String> { diff --git a/crates/storage_impl/src/payments/payment_attempt.rs b/crates/storage_impl/src/payments/payment_attempt.rs index 8eb8222afbf..78531b78ad6 100644 --- a/crates/storage_impl/src/payments/payment_attempt.rs +++ b/crates/storage_impl/src/payments/payment_attempt.rs @@ -6,16 +6,17 @@ use common_utils::{ fallback_reverse_lookup_not_found, types::{ConnectorTransactionId, ConnectorTransactionIdTrait, CreatedBy}, }; +#[cfg(feature = "v1")] +use diesel_models::payment_attempt::PaymentAttemptNew as DieselPaymentAttemptNew; use diesel_models::{ enums::{ MandateAmountData as DieselMandateAmountData, MandateDataType as DieselMandateType, MandateDetails as DieselMandateDetails, MerchantStorageScheme, }, + kv, payment_attempt::PaymentAttempt as DieselPaymentAttempt, reverse_lookup::{ReverseLookup, ReverseLookupNew}, }; -#[cfg(feature = "v1")] -use diesel_models::{kv, payment_attempt::PaymentAttemptNew as DieselPaymentAttemptNew}; use error_stack::ResultExt; #[cfg(feature = "v1")] use hyperswitch_domain_models::payments::payment_attempt::PaymentAttemptNew; @@ -32,22 +33,21 @@ use hyperswitch_domain_models::{ use hyperswitch_domain_models::{ payments::payment_attempt::PaymentListFilters, payments::PaymentIntent, }; -#[cfg(feature = "v1")] +#[cfg(feature = "v2")] +use label::*; use redis_interface::HsetnxReply; use router_env::{instrument, tracing}; +#[cfg(feature = "v2")] +use crate::kv_router_store::{FilterResourceParams, FindResourceBy, UpdateResourceParams}; use crate::{ diesel_error_to_data_error, errors, + errors::RedisErrorExt, kv_router_store::KVRouterStore, lookup::ReverseLookupInterface, - utils::{pg_connection_read, pg_connection_write}, - DataModelExt, DatabaseStore, RouterStore, -}; -#[cfg(feature = "v1")] -use crate::{ - errors::RedisErrorExt, redis::kv_store::{decide_storage_scheme, kv_wrapper, KvOperation, Op, PartitionKey}, - utils::try_redis_get_else_try_database_get, + utils::{pg_connection_read, pg_connection_write, try_redis_get_else_try_database_get}, + DataModelExt, DatabaseStore, RouterStore, }; #[async_trait::async_trait] @@ -747,15 +747,98 @@ impl<T: DatabaseStore> PaymentAttemptInterface for KVRouterStore<T> { payment_attempt: PaymentAttempt, storage_scheme: MerchantStorageScheme, ) -> error_stack::Result<PaymentAttempt, errors::StorageError> { - // Ignoring storage scheme for v2 implementation - self.router_store - .insert_payment_attempt( - key_manager_state, - merchant_key_store, - payment_attempt, - storage_scheme, - ) - .await + let decided_storage_scheme = Box::pin(decide_storage_scheme::<_, DieselPaymentAttempt>( + self, + storage_scheme, + Op::Insert, + )) + .await; + + match decided_storage_scheme { + MerchantStorageScheme::PostgresOnly => { + self.router_store + .insert_payment_attempt( + key_manager_state, + merchant_key_store, + payment_attempt, + decided_storage_scheme, + ) + .await + } + MerchantStorageScheme::RedisKv => { + let key = PartitionKey::GlobalPaymentId { + id: &payment_attempt.payment_id, + }; + let key_str = key.to_string(); + let field = format!( + "{}_{}", + label::CLUSTER_LABEL, + payment_attempt.id.get_string_repr() + ); + + let diesel_payment_attempt_new = payment_attempt + .clone() + .construct_new() + .await + .change_context(errors::StorageError::EncryptionError)?; + + let diesel_payment_attempt_for_redis: DieselPaymentAttempt = + Conversion::convert(payment_attempt.clone()) + .await + .change_context(errors::StorageError::EncryptionError)?; + + let redis_entry = kv::TypedSql { + op: kv::DBOperation::Insert { + insertable: Box::new(kv::Insertable::PaymentAttempt(Box::new( + diesel_payment_attempt_new.clone(), + ))), + }, + }; + + let reverse_lookup_attempt_id = ReverseLookupNew { + lookup_id: label::get_global_id_label(&payment_attempt.id), + pk_id: key_str.clone(), + sk_id: field.clone(), + source: "payment_attempt".to_string(), + updated_by: decided_storage_scheme.to_string(), + }; + self.insert_reverse_lookup(reverse_lookup_attempt_id, decided_storage_scheme) + .await?; + + if let Some(ref conn_txn_id_val) = payment_attempt.connector_payment_id { + let reverse_lookup_conn_txn_id = ReverseLookupNew { + lookup_id: label::get_profile_id_connector_transaction_label( + payment_attempt.profile_id.get_string_repr(), + conn_txn_id_val, + ), + pk_id: key_str.clone(), + sk_id: field.clone(), + source: "payment_attempt".to_string(), + updated_by: decided_storage_scheme.to_string(), + }; + self.insert_reverse_lookup(reverse_lookup_conn_txn_id, decided_storage_scheme) + .await?; + } + + match Box::pin(kv_wrapper::<DieselPaymentAttempt, _, _>( + self, + KvOperation::HSetNx(&field, &diesel_payment_attempt_for_redis, redis_entry), + key, + )) + .await + .map_err(|err| err.to_redis_failed_response(&key_str))? + .try_into_hsetnx() + { + Ok(HsetnxReply::KeyNotSet) => Err(errors::StorageError::DuplicateValue { + entity: "payment_attempt", + key: Some(payment_attempt.id.get_string_repr().to_owned()), + } + .into()), + Ok(HsetnxReply::KeySet) => Ok(payment_attempt), + Err(error) => Err(error.change_context(errors::StorageError::KVError)), + } + } + } } #[cfg(feature = "v1")] @@ -889,19 +972,48 @@ impl<T: DatabaseStore> PaymentAttemptInterface for KVRouterStore<T> { key_manager_state: &KeyManagerState, merchant_key_store: &MerchantKeyStore, this: PaymentAttempt, - payment_attempt: PaymentAttemptUpdate, + payment_attempt_update: PaymentAttemptUpdate, storage_scheme: MerchantStorageScheme, ) -> error_stack::Result<PaymentAttempt, errors::StorageError> { - // Ignoring storage scheme for v2 implementation - self.router_store - .update_payment_attempt( - key_manager_state, - merchant_key_store, - this, - payment_attempt, - storage_scheme, - ) + let payment_attempt = Conversion::convert(this.clone()) .await + .change_context(errors::StorageError::DecryptionError)?; + + let key = PartitionKey::GlobalPaymentId { + id: &this.payment_id, + }; + + let field = format!("{}_{}", label::CLUSTER_LABEL, this.id.get_string_repr()); + let conn = pg_connection_write(self).await?; + + let payment_attempt_internal = + diesel_models::PaymentAttemptUpdateInternal::from(payment_attempt_update); + let updated_payment_attempt = payment_attempt_internal + .clone() + .apply_changeset(payment_attempt.clone()); + + let updated_by = updated_payment_attempt.updated_by.to_owned(); + let updated_payment_attempt_with_id = payment_attempt + .clone() + .update_with_attempt_id(&conn, payment_attempt_internal.clone()); + + Box::pin(self.update_resource( + key_manager_state, + merchant_key_store, + storage_scheme, + updated_payment_attempt_with_id, + updated_payment_attempt, + UpdateResourceParams { + updateable: kv::Updateable::PaymentAttemptUpdate(Box::new( + kv::PaymentAttemptUpdateMems { + orig: payment_attempt, + update_data: payment_attempt_internal, + }, + )), + operation: Op::Update(key.clone(), &field, Some(updated_by.as_str())), + }, + )) + .await } #[cfg(feature = "v1")] @@ -1095,15 +1207,69 @@ impl<T: DatabaseStore> PaymentAttemptInterface for KVRouterStore<T> { payment_id: &common_utils::id_type::GlobalPaymentId, storage_scheme: MerchantStorageScheme, ) -> error_stack::Result<PaymentAttempt, errors::StorageError> { - // Ignoring storage scheme for v2 implementation - self.router_store - .find_payment_attempt_last_successful_or_partially_captured_attempt_by_payment_id( - key_manager_state, - merchant_key_store, - payment_id, - storage_scheme, - ) - .await + let database_call = || { + self.router_store + .find_payment_attempt_last_successful_or_partially_captured_attempt_by_payment_id( + key_manager_state, + merchant_key_store, + payment_id, + storage_scheme, + ) + }; + + let decided_storage_scheme = Box::pin(decide_storage_scheme::<_, DieselPaymentAttempt>( + self, + storage_scheme, + Op::Find, + )) + .await; + + match decided_storage_scheme { + MerchantStorageScheme::PostgresOnly => database_call().await, + MerchantStorageScheme::RedisKv => { + let key = PartitionKey::GlobalPaymentId { id: payment_id }; + + let redis_fut = async { + let kv_result = kv_wrapper::<DieselPaymentAttempt, _, _>( + self, + KvOperation::<DieselPaymentAttempt>::Scan("pa_*"), + key.clone(), + ) + .await? + .try_into_scan(); + + let payment_attempt = kv_result.and_then(|mut payment_attempts| { + payment_attempts.sort_by(|a, b| b.modified_at.cmp(&a.modified_at)); + payment_attempts + .iter() + .find(|&pa| { + pa.status == diesel_models::enums::AttemptStatus::Charged + || pa.status + == diesel_models::enums::AttemptStatus::PartialCharged + }) + .cloned() + .ok_or(error_stack::report!( + redis_interface::errors::RedisError::NotFound + )) + })?; + let merchant_id = payment_attempt.merchant_id.clone(); + PaymentAttempt::convert_back( + key_manager_state, + payment_attempt, + merchant_key_store.key.get_inner(), + merchant_id.into(), + ) + .await + .change_context(redis_interface::errors::RedisError::UnknownResult) + }; + + Box::pin(try_redis_get_else_try_database_get( + redis_fut, + database_call, + )) + .await + } + } } #[cfg(feature = "v2")] @@ -1115,16 +1281,22 @@ impl<T: DatabaseStore> PaymentAttemptInterface for KVRouterStore<T> { connector_transaction_id: &str, storage_scheme: MerchantStorageScheme, ) -> CustomResult<PaymentAttempt, errors::StorageError> { - // Ignoring storage scheme for v2 implementation - self.router_store - .find_payment_attempt_by_profile_id_connector_transaction_id( - key_manager_state, - merchant_key_store, + let conn = pg_connection_read(self).await?; + self.find_resource_by_id( + key_manager_state, + merchant_key_store, + storage_scheme, + DieselPaymentAttempt::find_by_profile_id_connector_transaction_id( + &conn, profile_id, connector_transaction_id, - storage_scheme, - ) - .await + ), + FindResourceBy::LookupId(label::get_profile_id_connector_transaction_label( + profile_id.get_string_repr(), + connector_transaction_id, + )), + ) + .await } #[instrument(skip_all)] @@ -1329,15 +1501,15 @@ impl<T: DatabaseStore> PaymentAttemptInterface for KVRouterStore<T> { attempt_id: &common_utils::id_type::GlobalAttemptId, storage_scheme: MerchantStorageScheme, ) -> error_stack::Result<PaymentAttempt, errors::StorageError> { - // Ignoring storage scheme for v2 implementation - self.router_store - .find_payment_attempt_by_id( - key_manager_state, - merchant_key_store, - attempt_id, - storage_scheme, - ) - .await + let conn = pg_connection_read(self).await?; + self.find_resource_by_id( + key_manager_state, + merchant_key_store, + storage_scheme, + DieselPaymentAttempt::find_by_id(&conn, attempt_id), + FindResourceBy::LookupId(label::get_global_id_label(attempt_id)), + ) + .await } #[cfg(feature = "v2")] @@ -1349,14 +1521,20 @@ impl<T: DatabaseStore> PaymentAttemptInterface for KVRouterStore<T> { merchant_key_store: &MerchantKeyStore, storage_scheme: MerchantStorageScheme, ) -> error_stack::Result<Vec<PaymentAttempt>, errors::StorageError> { - self.router_store - .find_payment_attempts_by_payment_intent_id( - key_manager_state, - payment_id, - merchant_key_store, - storage_scheme, - ) - .await + let conn = pg_connection_read(self).await?; + self.filter_resources( + key_manager_state, + merchant_key_store, + storage_scheme, + DieselPaymentAttempt::find_by_payment_id(&conn, payment_id), + |_| true, + FilterResourceParams { + key: PartitionKey::GlobalPaymentId { id: payment_id }, + pattern: "pa_*", + limit: None, + }, + ) + .await } #[cfg(feature = "v1")] @@ -2036,3 +2214,25 @@ async fn add_preprocessing_id_to_reverse_lookup<T: DatabaseStore>( .insert_reverse_lookup(reverse_lookup_new, storage_scheme) .await } + +#[cfg(feature = "v2")] +mod label { + pub(super) const MODEL_NAME: &str = "payment_attempt_v2"; + pub(super) const CLUSTER_LABEL: &str = "pa"; + + pub(super) fn get_profile_id_connector_transaction_label( + profile_id: &str, + connector_transaction_id: &str, + ) -> String { + format!( + "profile_{}_conn_txn_{}", + profile_id, connector_transaction_id + ) + } + + pub(super) fn get_global_id_label( + attempt_id: &common_utils::id_type::GlobalAttemptId, + ) -> String { + format!("attempt_global_id_{}", attempt_id.get_string_repr()) + } +} diff --git a/crates/storage_impl/src/payments/payment_intent.rs b/crates/storage_impl/src/payments/payment_intent.rs index 17156855e13..d054a4b1650 100644 --- a/crates/storage_impl/src/payments/payment_intent.rs +++ b/crates/storage_impl/src/payments/payment_intent.rs @@ -2,13 +2,22 @@ use api_models::payments::{AmountFilter, Order, SortBy, SortOn}; #[cfg(feature = "olap")] use async_bb8_diesel::{AsyncConnection, AsyncRunQueryDsl}; -#[cfg(feature = "v1")] -use common_utils::ext_traits::Encode; -use common_utils::{ext_traits::AsyncExt, types::keymanager::KeyManagerState}; +#[cfg(feature = "v2")] +use common_utils::fallback_reverse_lookup_not_found; +use common_utils::{ + ext_traits::{AsyncExt, Encode}, + types::keymanager::KeyManagerState, +}; #[cfg(feature = "olap")] use diesel::{associations::HasTable, ExpressionMethods, JoinOnDsl, QueryDsl}; +#[cfg(feature = "v1")] +use diesel_models::payment_intent::PaymentIntentUpdate as DieselPaymentIntentUpdate; +#[cfg(feature = "v2")] +use diesel_models::payment_intent::PaymentIntentUpdateInternal; #[cfg(feature = "olap")] use diesel_models::query::generics::db_metrics; +#[cfg(feature = "v2")] +use diesel_models::reverse_lookup::ReverseLookupNew; #[cfg(all(feature = "v1", feature = "olap"))] use diesel_models::schema::{ payment_attempt::{self as payment_attempt_schema, dsl as pa_dsl}, @@ -20,10 +29,8 @@ use diesel_models::schema_v2::{ payment_intent::dsl as pi_dsl, }; use diesel_models::{ - enums::MerchantStorageScheme, payment_intent::PaymentIntent as DieselPaymentIntent, + enums::MerchantStorageScheme, kv, payment_intent::PaymentIntent as DieselPaymentIntent, }; -#[cfg(feature = "v1")] -use diesel_models::{kv, payment_intent::PaymentIntentUpdate as DieselPaymentIntentUpdate}; use error_stack::ResultExt; #[cfg(feature = "olap")] use hyperswitch_domain_models::payments::{ @@ -37,7 +44,6 @@ use hyperswitch_domain_models::{ PaymentIntent, }, }; -#[cfg(feature = "v1")] use redis_interface::HsetnxReply; #[cfg(feature = "olap")] use router_env::logger; @@ -47,17 +53,14 @@ use router_env::{instrument, tracing}; use crate::connection; use crate::{ diesel_error_to_data_error, - errors::StorageError, + errors::{RedisErrorExt, StorageError}, kv_router_store::KVRouterStore, - utils::{pg_connection_read, pg_connection_write}, - DatabaseStore, -}; -#[cfg(feature = "v1")] -use crate::{ - errors::RedisErrorExt, redis::kv_store::{decide_storage_scheme, kv_wrapper, KvOperation, Op, PartitionKey}, - utils, + utils::{self, pg_connection_read, pg_connection_write}, + DatabaseStore, }; +#[cfg(feature = "v2")] +use crate::{errors, lookup::ReverseLookupInterface}; #[async_trait::async_trait] impl<T: DatabaseStore> PaymentIntentInterface for KVRouterStore<T> { @@ -163,7 +166,68 @@ impl<T: DatabaseStore> PaymentIntentInterface for KVRouterStore<T> { } MerchantStorageScheme::RedisKv => { - todo!("Implement payment intent insert for kv") + let id = payment_intent.id.clone(); + let key = PartitionKey::GlobalPaymentId { id: &id }; + let field = format!("pi_{}", id.get_string_repr()); + let key_str = key.to_string(); + + let new_payment_intent = payment_intent + .clone() + .construct_new() + .await + .change_context(StorageError::EncryptionError)?; + + let redis_entry = kv::TypedSql { + op: kv::DBOperation::Insert { + insertable: Box::new(kv::Insertable::PaymentIntent(Box::new( + new_payment_intent, + ))), + }, + }; + + let diesel_payment_intent = payment_intent + .clone() + .convert() + .await + .change_context(StorageError::EncryptionError)?; + + if let Some(merchant_reference_id) = &payment_intent.merchant_reference_id { + let reverse_lookup = ReverseLookupNew { + lookup_id: format!( + "pi_merchant_reference_{}_{}", + payment_intent.profile_id.get_string_repr(), + merchant_reference_id.get_string_repr() + ), + pk_id: key_str.clone(), + sk_id: field.clone(), + source: "payment_intent".to_string(), + updated_by: storage_scheme.to_string(), + }; + self.insert_reverse_lookup(reverse_lookup, storage_scheme) + .await?; + } + + match Box::pin(kv_wrapper::<DieselPaymentIntent, _, _>( + self, + KvOperation::<DieselPaymentIntent>::HSetNx( + &field, + &diesel_payment_intent, + redis_entry, + ), + key, + )) + .await + .map_err(|err| err.to_redis_failed_response(&key_str))? + .try_into_hsetnx() + { + Ok(HsetnxReply::KeyNotSet) => Err(StorageError::DuplicateValue { + entity: "payment_intent", + key: Some(key_str), + } + .into()), + Ok(HsetnxReply::KeySet) => Ok(payment_intent), + Err(error) => Err(error.change_context(StorageError::KVError)), + } } } } @@ -300,7 +364,59 @@ impl<T: DatabaseStore> PaymentIntentInterface for KVRouterStore<T> { .await } MerchantStorageScheme::RedisKv => { - todo!() + let id = this.id.clone(); + let merchant_id = this.merchant_id.clone(); + let key = PartitionKey::GlobalPaymentId { id: &id }; + let field = format!("pi_{}", id.get_string_repr()); + let key_str = key.to_string(); + + let diesel_intent_update = + PaymentIntentUpdateInternal::try_from(payment_intent_update) + .change_context(StorageError::DeserializationFailed)?; + let origin_diesel_intent = this + .convert() + .await + .change_context(StorageError::EncryptionError)?; + + let diesel_intent = diesel_intent_update + .clone() + .apply_changeset(origin_diesel_intent.clone()); + + let redis_value = diesel_intent + .encode_to_string_of_json() + .change_context(StorageError::SerializationFailed)?; + + let redis_entry = kv::TypedSql { + op: kv::DBOperation::Update { + updatable: Box::new(kv::Updateable::PaymentIntentUpdate(Box::new( + kv::PaymentIntentUpdateMems { + orig: origin_diesel_intent, + update_data: diesel_intent_update, + }, + ))), + }, + }; + + Box::pin(kv_wrapper::<(), _, _>( + self, + KvOperation::<DieselPaymentIntent>::Hset((&field, redis_value), redis_entry), + key, + )) + .await + .map_err(|err| err.to_redis_failed_response(&key_str))? + .try_into_hset() + .change_context(StorageError::KVError)?; + + let payment_intent = PaymentIntent::convert_back( + state, + diesel_intent, + merchant_key_store.key.get_inner(), + merchant_id.into(), + ) + .await + .change_context(StorageError::DecryptionError)?; + + Ok(payment_intent) } } } @@ -372,18 +488,50 @@ impl<T: DatabaseStore> PaymentIntentInterface for KVRouterStore<T> { state: &KeyManagerState, id: &common_utils::id_type::GlobalPaymentId, merchant_key_store: &MerchantKeyStore, - _storage_scheme: MerchantStorageScheme, + storage_scheme: MerchantStorageScheme, ) -> error_stack::Result<PaymentIntent, StorageError> { - let conn: bb8::PooledConnection< - '_, - async_bb8_diesel::ConnectionManager<diesel::PgConnection>, - > = pg_connection_read(self).await?; - let diesel_payment_intent = DieselPaymentIntent::find_by_global_id(&conn, id) - .await - .map_err(|er| { - let new_err = diesel_error_to_data_error(*er.current_context()); - er.change_context(new_err) - })?; + let storage_scheme = Box::pin(decide_storage_scheme::<_, DieselPaymentIntent>( + self, + storage_scheme, + Op::Find, + )) + .await; + + let database_call = || async { + let conn: bb8::PooledConnection< + '_, + async_bb8_diesel::ConnectionManager<diesel::PgConnection>, + > = pg_connection_read(self).await?; + + DieselPaymentIntent::find_by_global_id(&conn, id) + .await + .map_err(|er| { + let new_err = diesel_error_to_data_error(*er.current_context()); + er.change_context(new_err) + }) + }; + + let diesel_payment_intent = match storage_scheme { + MerchantStorageScheme::PostgresOnly => database_call().await, + MerchantStorageScheme::RedisKv => { + let key = PartitionKey::GlobalPaymentId { id }; + let field = format!("pi_{}", id.get_string_repr()); + + Box::pin(utils::try_redis_get_else_try_database_get( + async { + Box::pin(kv_wrapper::<DieselPaymentIntent, _, _>( + self, + KvOperation::<DieselPaymentIntent>::HGet(&field), + key, + )) + .await? + .try_into_hget() + }, + database_call, + )) + .await + } + }?; let merchant_id = diesel_payment_intent.merchant_id.clone(); @@ -391,7 +539,7 @@ impl<T: DatabaseStore> PaymentIntentInterface for KVRouterStore<T> { state, diesel_payment_intent, merchant_key_store.key.get_inner(), - merchant_id.to_owned().into(), + merchant_id.into(), ) .await .change_context(StorageError::DecryptionError) @@ -523,7 +671,68 @@ impl<T: DatabaseStore> PaymentIntentInterface for KVRouterStore<T> { .await } MerchantStorageScheme::RedisKv => { - todo!() + let lookup_id = format!( + "pi_merchant_reference_{}_{}", + profile_id.get_string_repr(), + merchant_reference_id.get_string_repr() + ); + + let lookup = fallback_reverse_lookup_not_found!( + self.get_lookup_by_lookup_id(&lookup_id, *storage_scheme) + .await, + self.router_store + .find_payment_intent_by_merchant_reference_id_profile_id( + state, + merchant_reference_id, + profile_id, + merchant_key_store, + storage_scheme, + ) + .await + ); + + let key = PartitionKey::CombinationKey { + combination: &lookup.pk_id, + }; + + let database_call = || async { + let conn = pg_connection_read(self).await?; + DieselPaymentIntent::find_by_merchant_reference_id_profile_id( + &conn, + merchant_reference_id, + profile_id, + ) + .await + .map_err(|er| { + let new_err = diesel_error_to_data_error(*er.current_context()); + er.change_context(new_err) + }) + }; + + let diesel_payment_intent = Box::pin(utils::try_redis_get_else_try_database_get( + async { + Box::pin(kv_wrapper::<DieselPaymentIntent, _, _>( + self, + KvOperation::<DieselPaymentIntent>::HGet(&lookup.sk_id), + key, + )) + .await? + .try_into_hget() + }, + database_call, + )) + .await?; + + let merchant_id = diesel_payment_intent.merchant_id.clone(); + + PaymentIntent::convert_back( + state, + diesel_payment_intent, + merchant_key_store.key.get_inner(), + merchant_id.into(), + ) + .await + .change_context(StorageError::DecryptionError) } } } @@ -607,9 +816,8 @@ impl<T: DatabaseStore> PaymentIntentInterface for crate::RouterStore<T> { _storage_scheme: MerchantStorageScheme, ) -> error_stack::Result<PaymentIntent, StorageError> { let conn = pg_connection_write(self).await?; - let diesel_payment_intent_update = - diesel_models::PaymentIntentUpdateInternal::try_from(payment_intent) - .change_context(StorageError::DeserializationFailed)?; + let diesel_payment_intent_update = PaymentIntentUpdateInternal::try_from(payment_intent) + .change_context(StorageError::DeserializationFailed)?; let diesel_payment_intent = this .convert() .await diff --git a/crates/storage_impl/src/redis/kv_store.rs b/crates/storage_impl/src/redis/kv_store.rs index f09506bc76b..fd583f500ed 100644 --- a/crates/storage_impl/src/redis/kv_store.rs +++ b/crates/storage_impl/src/redis/kv_store.rs @@ -55,6 +55,10 @@ pub enum PartitionKey<'a> { GlobalId { id: &'a str, }, + #[cfg(feature = "v2")] + GlobalPaymentId { + id: &'a common_utils::id_type::GlobalPaymentId, + }, } // PartitionKey::MerchantIdPaymentId {merchant_id, payment_id} impl std::fmt::Display for PartitionKey<'_> { @@ -108,7 +112,11 @@ impl std::fmt::Display for PartitionKey<'_> { )), #[cfg(feature = "v2")] - PartitionKey::GlobalId { id } => f.write_str(&format!("cust_{id}",)), + PartitionKey::GlobalId { id } => f.write_str(&format!("global_cust_{id}",)), + #[cfg(feature = "v2")] + PartitionKey::GlobalPaymentId { id } => { + f.write_str(&format!("global_payment_{}", id.get_string_repr())) + } } } }

2025-06-02T04:50:28Z

## Type of Change  - [ ] Bugfix - [ ] New feature - [x] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description #8389 - Added Kv Redis support to - payment_intent V2, payment_attempt V2 models - Added enable Kv route for v2 merchant-account added enable kv api for v2 merchant account ` curl --location 'https://<host>/v2/merchant-accounts/:mid/kv' \ --header 'Authorization: admin-api-key=***' \ --header 'x-organization-id:***' \ --header 'Content-Type: application/json' \ --data '{"kv_enabled" : true}' ` ### Additional Changes - [x] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  ## How did you test it?  Locally tested kv writes and drainer functionality ## Checklist  - [ ] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.114.0

c5c0e677f2a2d43170a66330c98e0ebc4d771717

juspay/hyperswitch

juspay__hyperswitch-8392

Bug: [FEATURE] allow payout_id to be configurable ### Feature Description `payout_id` is an unique identifier for payout resource which is auto generated during payout creation. This field needs to be configurable during payout creation by accepting in the API. Along with this, a `merchant_order_reference_id` needs to be added which is an unique identifier for the consumer of the API. ### Possible Implementation Below changes are needed in payout flow across different components - - Add `payout_id` to API models - Add `PayoutId` domain type - Add `merchant_order_reference_id` to API and diesel models - Add DB queries for fetching orders using `merchant_order_reference_id` - Add `merchant_order_reference_id` as a filter for OLAP APIs - Use uuidv4 for payout ID creation for Wise ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? None

diff --git a/api-reference/v1/openapi_spec_v1.json b/api-reference/v1/openapi_spec_v1.json index fe57a935d16..85223163b29 100644 --- a/api-reference/v1/openapi_spec_v1.json +++ b/api-reference/v1/openapi_spec_v1.json @@ -24303,6 +24303,13 @@ "client_secret" ], "properties": { + "merchant_order_reference_id": { + "type": "string", + "description": "Your unique identifier for this payout or order. This ID helps you reconcile payouts on your system. If provided, it is passed to the connector if supported.", + "example": "merchant_order_ref_123", + "nullable": true, + "maxLength": 255 + }, "amount": { "type": "integer", "format": "int64", @@ -24609,6 +24616,13 @@ "example": "merchant_1668273825", "maxLength": 255 }, + "merchant_order_reference_id": { + "type": "string", + "description": "Your unique identifier for this payout or order. This ID helps you reconcile payouts on your system. If provided, it is passed to the connector if supported.", + "example": "merchant_order_ref_123", + "nullable": true, + "maxLength": 255 + }, "amount": { "type": "integer", "format": "int64", @@ -24902,13 +24916,13 @@ "starting_after": { "type": "string", "description": "A cursor for use in pagination, fetch the next list after some object", - "example": "pay_fafa124123", + "example": "payout_fafa124123", "nullable": true }, "ending_before": { "type": "string", "description": "A cursor for use in pagination, fetch the previous list before some object", - "example": "pay_fafa124123", + "example": "payout_fafa124123", "nullable": true }, "limit": { @@ -24955,6 +24969,13 @@ "maxLength": 30, "minLength": 30 }, + "merchant_order_reference_id": { + "type": "string", + "description": "The merchant order reference ID for payout", + "example": "merchant_order_ref_123", + "nullable": true, + "maxLength": 255 + }, "profile_id": { "type": "string", "description": "The identifier for business profile", @@ -25249,6 +25270,13 @@ "PayoutUpdateRequest": { "type": "object", "properties": { + "merchant_order_reference_id": { + "type": "string", + "description": "Your unique identifier for this payout or order. This ID helps you reconcile payouts on your system. If provided, it is passed to the connector if supported.", + "example": "merchant_order_ref_123", + "nullable": true, + "maxLength": 255 + }, "amount": { "type": "integer", "format": "int64", @@ -25479,6 +25507,13 @@ "currency" ], "properties": { + "merchant_order_reference_id": { + "type": "string", + "description": "Your unique identifier for this payout or order. This ID helps you reconcile payouts on your system. If provided, it is passed to the connector if supported.", + "example": "merchant_order_ref_123", + "nullable": true, + "maxLength": 255 + }, "amount": { "type": "integer", "format": "int64", diff --git a/api-reference/v2/openapi_spec_v2.json b/api-reference/v2/openapi_spec_v2.json index 5ceb5f032f5..0bd642c8be8 100644 --- a/api-reference/v2/openapi_spec_v2.json +++ b/api-reference/v2/openapi_spec_v2.json @@ -19579,7 +19579,19 @@ "additionalProperties": false }, "PayoutActionRequest": { - "type": "object" + "type": "object", + "required": [ + "payout_id" + ], + "properties": { + "payout_id": { + "type": "string", + "description": "Unique identifier for the payout. This ensures idempotency for multiple payouts\nthat have been done by a single merchant. This field is auto generated and is returned in the API response.", + "example": "187282ab-40ef-47a9-9206-5099ba31e432", + "maxLength": 30, + "minLength": 30 + } + } }, "PayoutAttemptResponse": { "type": "object", @@ -19746,6 +19758,13 @@ "nullable": true, "maxLength": 255 }, + "merchant_order_reference_id": { + "type": "string", + "description": "Your unique identifier for this payout or order. This ID helps you reconcile payouts on your system. If provided, it is passed to the connector if supported.", + "example": "merchant_order_ref_123", + "nullable": true, + "maxLength": 255 + }, "amount": { "type": "integer", "format": "int64", @@ -20001,6 +20020,13 @@ "example": "merchant_1668273825", "maxLength": 255 }, + "merchant_order_reference_id": { + "type": "string", + "description": "Your unique identifier for this payout or order. This ID helps you reconcile payouts on your system. If provided, it is passed to the connector if supported.", + "example": "merchant_order_ref_123", + "nullable": true, + "maxLength": 255 + }, "amount": { "type": "integer", "format": "int64", @@ -20279,13 +20305,13 @@ "starting_after": { "type": "string", "description": "A cursor for use in pagination, fetch the next list after some object", - "example": "pay_fafa124123", + "example": "payout_fafa124123", "nullable": true }, "ending_before": { "type": "string", "description": "A cursor for use in pagination, fetch the previous list before some object", - "example": "pay_fafa124123", + "example": "payout_fafa124123", "nullable": true }, "limit": { @@ -20332,6 +20358,13 @@ "maxLength": 30, "minLength": 30 }, + "merchant_order_reference_id": { + "type": "string", + "description": "The merchant order reference ID for payout", + "example": "merchant_order_ref_123", + "nullable": true, + "maxLength": 255 + }, "profile_id": { "type": "string", "description": "The identifier for business profile", diff --git a/crates/api_models/src/events/payouts.rs b/crates/api_models/src/events/payouts.rs index a08f3ed94a8..b7eded681a3 100644 --- a/crates/api_models/src/events/payouts.rs +++ b/crates/api_models/src/events/payouts.rs @@ -9,7 +9,7 @@ use crate::payouts::{ impl ApiEventMetric for PayoutRetrieveRequest { fn get_api_event_type(&self) -> Option<ApiEventsType> { Some(ApiEventsType::Payout { - payout_id: self.payout_id.clone(), + payout_id: self.payout_id.to_owned(), }) } } @@ -17,7 +17,7 @@ impl ApiEventMetric for PayoutRetrieveRequest { impl ApiEventMetric for PayoutCreateRequest { fn get_api_event_type(&self) -> Option<ApiEventsType> { self.payout_id.as_ref().map(|id| ApiEventsType::Payout { - payout_id: id.clone(), + payout_id: id.to_owned(), }) } } @@ -25,7 +25,7 @@ impl ApiEventMetric for PayoutCreateRequest { impl ApiEventMetric for PayoutCreateResponse { fn get_api_event_type(&self) -> Option<ApiEventsType> { Some(ApiEventsType::Payout { - payout_id: self.payout_id.clone(), + payout_id: self.payout_id.to_owned(), }) } } @@ -33,7 +33,7 @@ impl ApiEventMetric for PayoutCreateResponse { impl ApiEventMetric for PayoutActionRequest { fn get_api_event_type(&self) -> Option<ApiEventsType> { Some(ApiEventsType::Payout { - payout_id: self.payout_id.clone(), + payout_id: self.payout_id.to_owned(), }) } } @@ -65,7 +65,7 @@ impl ApiEventMetric for PayoutListFilters { impl ApiEventMetric for PayoutLinkInitiateRequest { fn get_api_event_type(&self) -> Option<ApiEventsType> { Some(ApiEventsType::Payout { - payout_id: self.payout_id.clone(), + payout_id: self.payout_id.to_owned(), }) } } diff --git a/crates/api_models/src/payouts.rs b/crates/api_models/src/payouts.rs index cf07fd9e109..a6fdaa2b6e5 100644 --- a/crates/api_models/src/payouts.rs +++ b/crates/api_models/src/payouts.rs @@ -16,7 +16,7 @@ use utoipa::ToSchema; use crate::{enums as api_enums, payment_methods::RequiredFieldInfo, payments}; -#[derive(Debug, Deserialize, Serialize, Clone, ToSchema)] +#[derive(Debug, Serialize, Clone, ToSchema)] pub enum PayoutRequest { PayoutActionRequest(PayoutActionRequest), PayoutCreateRequest(Box<PayoutCreateRequest>), @@ -37,13 +37,17 @@ pub struct PayoutCreateRequest { example = "187282ab-40ef-47a9-9206-5099ba31e432" )] #[remove_in(PayoutsCreateRequest, PayoutUpdateRequest, PayoutConfirmRequest)] - pub payout_id: Option<String>, // TODO: #1321 https://github.com/juspay/hyperswitch/issues/1321 + pub payout_id: Option<id_type::PayoutId>, /// This is an identifier for the merchant account. This is inferred from the API key provided during the request, **not required to be included in the Payout Create/Update Request.** #[schema(max_length = 255, value_type = Option<String>, example = "merchant_1668273825")] #[remove_in(PayoutsCreateRequest, PayoutUpdateRequest, PayoutConfirmRequest)] pub merchant_id: Option<id_type::MerchantId>, + /// Your unique identifier for this payout or order. This ID helps you reconcile payouts on your system. If provided, it is passed to the connector if supported. + #[schema(value_type = Option<String>, max_length = 255, example = "merchant_order_ref_123")] + pub merchant_order_reference_id: Option<String>, + /// The payout amount. Amount for the payout in lowest denomination of the currency. (i.e) in cents for USD denomination, in paisa for INR denomination etc., #[schema(value_type = Option<u64>, example = 1000)] #[mandatory_in(PayoutsCreateRequest = u64)] @@ -399,13 +403,17 @@ pub struct PayoutCreateResponse { max_length = 30, example = "187282ab-40ef-47a9-9206-5099ba31e432" )] - pub payout_id: String, // TODO: Update this to PayoutIdType similar to PaymentIdType + pub payout_id: id_type::PayoutId, /// This is an identifier for the merchant account. This is inferred from the API key /// provided during the request #[schema(max_length = 255, value_type = String, example = "merchant_1668273825")] pub merchant_id: id_type::MerchantId, + /// Your unique identifier for this payout or order. This ID helps you reconcile payouts on your system. If provided, it is passed to the connector if supported. + #[schema(value_type = Option<String>, max_length = 255, example = "merchant_order_ref_123")] + pub merchant_order_reference_id: Option<String>, + /// The payout amount. Amount for the payout in lowest denomination of the currency. (i.e) in cents for USD denomination, in paisa for INR denomination etc., #[schema(value_type = i64, example = 1000)] pub amount: common_utils::types::MinorUnit, @@ -638,7 +646,7 @@ pub struct PayoutRetrieveBody { pub merchant_id: Option<id_type::MerchantId>, } -#[derive(Default, Debug, Serialize, ToSchema, Clone, Deserialize)] +#[derive(Debug, Serialize, ToSchema, Clone, Deserialize)] pub struct PayoutRetrieveRequest { /// Unique identifier for the payout. This ensures idempotency for multiple payouts /// that have been done by a single merchant. This field is auto generated and is returned in the API response. @@ -648,7 +656,7 @@ pub struct PayoutRetrieveRequest { max_length = 30, example = "187282ab-40ef-47a9-9206-5099ba31e432" )] - pub payout_id: String, + pub payout_id: id_type::PayoutId, /// `force_sync` with the connector to get payout details /// (defaults to false) @@ -660,9 +668,7 @@ pub struct PayoutRetrieveRequest { pub merchant_id: Option<id_type::MerchantId>, } -#[derive( - Default, Debug, Deserialize, Serialize, Clone, ToSchema, router_derive::PolymorphicSchema, -)] +#[derive(Debug, Serialize, Clone, ToSchema, router_derive::PolymorphicSchema)] #[generate_schemas(PayoutCancelRequest, PayoutFulfillRequest)] pub struct PayoutActionRequest { /// Unique identifier for the payout. This ensures idempotency for multiple payouts @@ -673,8 +679,7 @@ pub struct PayoutActionRequest { max_length = 30, example = "187282ab-40ef-47a9-9206-5099ba31e432" )] - #[serde(skip_deserializing)] - pub payout_id: String, + pub payout_id: id_type::PayoutId, } #[derive(Default, Debug, ToSchema, Clone, Deserialize)] @@ -722,12 +727,12 @@ pub struct PayoutListConstraints { pub customer_id: Option<id_type::CustomerId>, /// A cursor for use in pagination, fetch the next list after some object - #[schema(example = "pay_fafa124123")] - pub starting_after: Option<String>, + #[schema(example = "payout_fafa124123", value_type = Option<String>,)] + pub starting_after: Option<id_type::PayoutId>, /// A cursor for use in pagination, fetch the previous list before some object - #[schema(example = "pay_fafa124123")] - pub ending_before: Option<String>, + #[schema(example = "payout_fafa124123", value_type = Option<String>,)] + pub ending_before: Option<id_type::PayoutId>, /// limit on the number of objects to return #[schema(default = 10, maximum = 100)] @@ -755,7 +760,10 @@ pub struct PayoutListFilterConstraints { max_length = 30, example = "187282ab-40ef-47a9-9206-5099ba31e432" )] - pub payout_id: Option<String>, + pub payout_id: Option<id_type::PayoutId>, + /// The merchant order reference ID for payout + #[schema(value_type = Option<String>, max_length = 255, example = "merchant_order_ref_123")] + pub merchant_order_reference_id: Option<String>, /// The identifier for business profile #[schema(value_type = Option<String>)] pub profile_id: Option<id_type::ProfileId>, @@ -826,7 +834,8 @@ pub struct PayoutLinkResponse { pub struct PayoutLinkInitiateRequest { #[schema(value_type = String)] pub merchant_id: id_type::MerchantId, - pub payout_id: String, + #[schema(value_type = String)] + pub payout_id: id_type::PayoutId, } #[derive(Clone, Debug, serde::Serialize)] @@ -834,7 +843,7 @@ pub struct PayoutLinkDetails { pub publishable_key: Secret<String>, pub client_secret: Secret<String>, pub payout_link_id: String, - pub payout_id: String, + pub payout_id: id_type::PayoutId, pub customer_id: id_type::CustomerId, #[serde(with = "common_utils::custom_serde::iso8601")] pub session_expiry: PrimitiveDateTime, @@ -870,7 +879,7 @@ pub struct RequiredFieldsOverrideRequest { #[derive(Clone, Debug, serde::Serialize)] pub struct PayoutLinkStatusDetails { pub payout_link_id: String, - pub payout_id: String, + pub payout_id: id_type::PayoutId, pub customer_id: id_type::CustomerId, #[serde(with = "common_utils::custom_serde::iso8601")] pub session_expiry: PrimitiveDateTime, diff --git a/crates/api_models/src/webhooks.rs b/crates/api_models/src/webhooks.rs index 4667866073b..177310de18f 100644 --- a/crates/api_models/src/webhooks.rs +++ b/crates/api_models/src/webhooks.rs @@ -98,7 +98,7 @@ pub enum WebhookResponseTracker { }, #[cfg(feature = "payouts")] Payout { - payout_id: String, + payout_id: common_utils::id_type::PayoutId, status: common_enums::PayoutStatus, }, #[cfg(feature = "v1")] diff --git a/crates/common_utils/src/events.rs b/crates/common_utils/src/events.rs index 376b57fbb47..e1964296755 100644 --- a/crates/common_utils/src/events.rs +++ b/crates/common_utils/src/events.rs @@ -12,7 +12,7 @@ pub trait ApiEventMetric { #[serde(tag = "flow_type", rename_all = "snake_case")] pub enum ApiEventsType { Payout { - payout_id: String, + payout_id: id_type::PayoutId, }, #[cfg(feature = "v1")] Payment { diff --git a/crates/common_utils/src/id_type.rs b/crates/common_utils/src/id_type.rs index d9daa5caf9d..6d73a90eab2 100644 --- a/crates/common_utils/src/id_type.rs +++ b/crates/common_utils/src/id_type.rs @@ -11,6 +11,7 @@ mod merchant; mod merchant_connector_account; mod organization; mod payment; +mod payout; mod profile; mod profile_acquirer; mod refunds; @@ -27,6 +28,7 @@ use diesel::{ serialize::{Output, ToSql}, sql_types, }; +pub use payout::PayoutId; use serde::{Deserialize, Serialize}; use thiserror::Error; diff --git a/crates/common_utils/src/id_type/payout.rs b/crates/common_utils/src/id_type/payout.rs new file mode 100644 index 00000000000..8faa661d363 --- /dev/null +++ b/crates/common_utils/src/id_type/payout.rs @@ -0,0 +1,10 @@ +crate::id_type!( + PayoutId, + "A domain type for payout_id that can be used for payout ids" +); +crate::impl_id_type_methods!(PayoutId, "payout_id"); +crate::impl_debug_id_type!(PayoutId); +crate::impl_try_from_cow_str_id_type!(PayoutId, "payout_id"); +crate::impl_generate_id_id_type!(PayoutId, "payout"); +crate::impl_queryable_id_type!(PayoutId); +crate::impl_to_sql_from_sql_id_type!(PayoutId); diff --git a/crates/common_utils/src/link_utils.rs b/crates/common_utils/src/link_utils.rs index 2201000d062..89a52f44792 100644 --- a/crates/common_utils/src/link_utils.rs +++ b/crates/common_utils/src/link_utils.rs @@ -149,7 +149,7 @@ pub struct PayoutLinkData { /// Identifier for the customer pub customer_id: id_type::CustomerId, /// Identifier for the payouts resource - pub payout_id: String, + pub payout_id: id_type::PayoutId, /// Link to render the payout link pub link: url::Url, /// Client secret generated for authenticating frontend APIs diff --git a/crates/diesel_models/src/events.rs b/crates/diesel_models/src/events.rs index cbc39340dcf..bc9f0788113 100644 --- a/crates/diesel_models/src/events.rs +++ b/crates/diesel_models/src/events.rs @@ -74,7 +74,7 @@ pub enum EventMetadata { payment_id: common_utils::id_type::GlobalPaymentId, }, Payout { - payout_id: String, + payout_id: common_utils::id_type::PayoutId, }, #[cfg(feature = "v1")] Refund { diff --git a/crates/diesel_models/src/generic_link.rs b/crates/diesel_models/src/generic_link.rs index 28402692480..d6071268eae 100644 --- a/crates/diesel_models/src/generic_link.rs +++ b/crates/diesel_models/src/generic_link.rs @@ -156,7 +156,7 @@ pub struct PaymentMethodCollectLinkData { #[diesel(primary_key(link_id))] pub struct PayoutLink { pub link_id: String, - pub primary_reference: String, + pub primary_reference: common_utils::id_type::PayoutId, pub merchant_id: common_utils::id_type::MerchantId, #[serde(with = "common_utils::custom_serde::iso8601")] pub created_at: PrimitiveDateTime, diff --git a/crates/diesel_models/src/payout_attempt.rs b/crates/diesel_models/src/payout_attempt.rs index 0e12a9ed801..a908ef7bdf5 100644 --- a/crates/diesel_models/src/payout_attempt.rs +++ b/crates/diesel_models/src/payout_attempt.rs @@ -14,7 +14,7 @@ use crate::{enums as storage_enums, schema::payout_attempt}; #[diesel(table_name = payout_attempt, primary_key(payout_attempt_id), check_for_backend(diesel::pg::Pg))] pub struct PayoutAttempt { pub payout_attempt_id: String, - pub payout_id: String, + pub payout_id: common_utils::id_type::PayoutId, pub customer_id: Option<common_utils::id_type::CustomerId>, pub merchant_id: common_utils::id_type::MerchantId, pub address_id: Option<String>, @@ -37,6 +37,7 @@ pub struct PayoutAttempt { pub unified_code: Option<UnifiedCode>, pub unified_message: Option<UnifiedMessage>, pub additional_payout_method_data: Option<payout_method_utils::AdditionalPayoutMethodData>, + pub merchant_order_reference_id: Option<String>, } #[derive( @@ -53,7 +54,7 @@ pub struct PayoutAttempt { #[diesel(table_name = payout_attempt)] pub struct PayoutAttemptNew { pub payout_attempt_id: String, - pub payout_id: String, + pub payout_id: common_utils::id_type::PayoutId, pub customer_id: Option<common_utils::id_type::CustomerId>, pub merchant_id: common_utils::id_type::MerchantId, pub address_id: Option<String>, @@ -76,6 +77,7 @@ pub struct PayoutAttemptNew { pub unified_code: Option<UnifiedCode>, pub unified_message: Option<UnifiedMessage>, pub additional_payout_method_data: Option<payout_method_utils::AdditionalPayoutMethodData>, + pub merchant_order_reference_id: Option<String>, } #[derive(Debug, Clone, Serialize, Deserialize)] @@ -128,6 +130,7 @@ pub struct PayoutAttemptUpdateInternal { pub unified_code: Option<UnifiedCode>, pub unified_message: Option<UnifiedMessage>, pub additional_payout_method_data: Option<payout_method_utils::AdditionalPayoutMethodData>, + pub merchant_order_reference_id: Option<String>, } impl Default for PayoutAttemptUpdateInternal { @@ -150,6 +153,7 @@ impl Default for PayoutAttemptUpdateInternal { unified_code: None, unified_message: None, additional_payout_method_data: None, + merchant_order_reference_id: None, } } } @@ -231,6 +235,7 @@ impl PayoutAttemptUpdate { unified_code, unified_message, additional_payout_method_data, + merchant_order_reference_id, } = self.into(); PayoutAttempt { payout_token: payout_token.or(source.payout_token), @@ -251,6 +256,8 @@ impl PayoutAttemptUpdate { unified_message: unified_message.or(source.unified_message), additional_payout_method_data: additional_payout_method_data .or(source.additional_payout_method_data), + merchant_order_reference_id: merchant_order_reference_id + .or(source.merchant_order_reference_id), ..source } } diff --git a/crates/diesel_models/src/payouts.rs b/crates/diesel_models/src/payouts.rs index 8acdc4a0a5a..881875494ab 100644 --- a/crates/diesel_models/src/payouts.rs +++ b/crates/diesel_models/src/payouts.rs @@ -11,7 +11,7 @@ use crate::{enums as storage_enums, schema::payouts}; )] #[diesel(table_name = payouts, primary_key(payout_id), check_for_backend(diesel::pg::Pg))] pub struct Payouts { - pub payout_id: String, + pub payout_id: common_utils::id_type::PayoutId, pub merchant_id: common_utils::id_type::MerchantId, pub customer_id: Option<common_utils::id_type::CustomerId>, pub address_id: Option<String>, @@ -52,7 +52,7 @@ pub struct Payouts { )] #[diesel(table_name = payouts)] pub struct PayoutsNew { - pub payout_id: String, + pub payout_id: common_utils::id_type::PayoutId, pub merchant_id: common_utils::id_type::MerchantId, pub customer_id: Option<common_utils::id_type::CustomerId>, pub address_id: Option<String>, diff --git a/crates/diesel_models/src/query/generic_link.rs b/crates/diesel_models/src/query/generic_link.rs index 75f1fc8ded8..96966e14547 100644 --- a/crates/diesel_models/src/query/generic_link.rs +++ b/crates/diesel_models/src/query/generic_link.rs @@ -224,7 +224,11 @@ impl TryFrom<GenericLink> for PayoutLink { Ok(Self { link_id: db_val.link_id, - primary_reference: db_val.primary_reference, + primary_reference: common_utils::id_type::PayoutId::try_from(std::borrow::Cow::Owned( + db_val.primary_reference, + )) + .change_context(errors::ParsingError::UnknownError) + .attach_printable("Failed to parse PayoutId from primary_reference string")?, merchant_id: db_val.merchant_id, created_at: db_val.created_at, last_modified_at: db_val.last_modified_at, diff --git a/crates/diesel_models/src/query/payout_attempt.rs b/crates/diesel_models/src/query/payout_attempt.rs index 939336a223a..300b6fdb647 100644 --- a/crates/diesel_models/src/query/payout_attempt.rs +++ b/crates/diesel_models/src/query/payout_attempt.rs @@ -56,7 +56,7 @@ impl PayoutAttempt { pub async fn find_by_merchant_id_payout_id( conn: &PgPooledConn, merchant_id: &common_utils::id_type::MerchantId, - payout_id: &str, + payout_id: &common_utils::id_type::PayoutId, ) -> StorageResult<Self> { generics::generic_find_one::<<Self as HasTable>::Table, _, _>( conn, @@ -95,10 +95,24 @@ impl PayoutAttempt { .await } + pub async fn find_by_merchant_id_merchant_order_reference_id( + conn: &PgPooledConn, + merchant_id_input: &common_utils::id_type::MerchantId, + merchant_order_reference_id_input: &str, + ) -> StorageResult<Self> { + generics::generic_find_one::<<Self as HasTable>::Table, _, _>( + conn, + dsl::merchant_id.eq(merchant_id_input.to_owned()).and( + dsl::merchant_order_reference_id.eq(merchant_order_reference_id_input.to_owned()), + ), + ) + .await + } + pub async fn update_by_merchant_id_payout_id( conn: &PgPooledConn, merchant_id: &common_utils::id_type::MerchantId, - payout_id: &str, + payout_id: &common_utils::id_type::PayoutId, payout: PayoutAttemptUpdate, ) -> StorageResult<Self> { generics::generic_update_with_results::<<Self as HasTable>::Table, _, _, _>( @@ -152,7 +166,7 @@ impl PayoutAttempt { .map(|payout| { format!( "{}_{}", - payout.payout_id.clone(), + payout.payout_id.get_string_repr(), payout.attempt_count.clone() ) }) @@ -160,8 +174,8 @@ impl PayoutAttempt { let active_payout_ids = payouts .iter() - .map(|payout| payout.payout_id.clone()) - .collect::<Vec<String>>(); + .map(|payout| payout.payout_id.to_owned()) + .collect::<Vec<common_utils::id_type::PayoutId>>(); let filter = <Self as HasTable>::table() .filter(dsl::merchant_id.eq(merchant_id.to_owned())) diff --git a/crates/diesel_models/src/query/payouts.rs b/crates/diesel_models/src/query/payouts.rs index 25c7bfc4f7e..e7d06d05ffe 100644 --- a/crates/diesel_models/src/query/payouts.rs +++ b/crates/diesel_models/src/query/payouts.rs @@ -47,7 +47,7 @@ impl Payouts { pub async fn find_by_merchant_id_payout_id( conn: &PgPooledConn, merchant_id: &common_utils::id_type::MerchantId, - payout_id: &str, + payout_id: &common_utils::id_type::PayoutId, ) -> StorageResult<Self> { generics::generic_find_one::<<Self as HasTable>::Table, _, _>( conn, @@ -61,7 +61,7 @@ impl Payouts { pub async fn update_by_merchant_id_payout_id( conn: &PgPooledConn, merchant_id: &common_utils::id_type::MerchantId, - payout_id: &str, + payout_id: &common_utils::id_type::PayoutId, payout: PayoutsUpdate, ) -> StorageResult<Self> { generics::generic_update_with_results::<<Self as HasTable>::Table, _, _, _>( @@ -82,7 +82,7 @@ impl Payouts { pub async fn find_optional_by_merchant_id_payout_id( conn: &PgPooledConn, merchant_id: &common_utils::id_type::MerchantId, - payout_id: &str, + payout_id: &common_utils::id_type::PayoutId, ) -> StorageResult<Option<Self>> { generics::generic_find_one_optional::<<Self as HasTable>::Table, _, _>( conn, @@ -96,7 +96,7 @@ impl Payouts { pub async fn get_total_count_of_payouts( conn: &PgPooledConn, merchant_id: &common_utils::id_type::MerchantId, - active_payout_ids: &[String], + active_payout_ids: &[common_utils::id_type::PayoutId], connector: Option<Vec<String>>, currency: Option<Vec<enums::Currency>>, status: Option<Vec<enums::PayoutStatus>>, @@ -106,7 +106,7 @@ impl Payouts { .inner_join(payout_attempt::table.on(payout_attempt::dsl::payout_id.eq(dsl::payout_id))) .count() .filter(dsl::merchant_id.eq(merchant_id.to_owned())) - .filter(dsl::payout_id.eq_any(active_payout_ids.to_owned())) + .filter(dsl::payout_id.eq_any(active_payout_ids.to_vec())) .into_boxed(); if let Some(connector) = connector { diff --git a/crates/diesel_models/src/schema.rs b/crates/diesel_models/src/schema.rs index e303dfc553f..1629780458c 100644 --- a/crates/diesel_models/src/schema.rs +++ b/crates/diesel_models/src/schema.rs @@ -1151,7 +1151,7 @@ diesel::table! { use diesel::sql_types::*; use crate::enums::diesel_exports::*; - payout_attempt (payout_attempt_id) { + payout_attempt (merchant_id, payout_attempt_id) { #[max_length = 64] payout_attempt_id -> Varchar, #[max_length = 64] @@ -1188,6 +1188,8 @@ diesel::table! { #[max_length = 1024] unified_message -> Nullable<Varchar>, additional_payout_method_data -> Nullable<Jsonb>, + #[max_length = 255] + merchant_order_reference_id -> Nullable<Varchar>, } } @@ -1195,7 +1197,7 @@ diesel::table! { use diesel::sql_types::*; use crate::enums::diesel_exports::*; - payouts (payout_id) { + payouts (merchant_id, payout_id) { #[max_length = 64] payout_id -> Varchar, #[max_length = 64] diff --git a/crates/diesel_models/src/schema_v2.rs b/crates/diesel_models/src/schema_v2.rs index 9ba5cdfaff6..c931cec977a 100644 --- a/crates/diesel_models/src/schema_v2.rs +++ b/crates/diesel_models/src/schema_v2.rs @@ -1090,7 +1090,7 @@ diesel::table! { use diesel::sql_types::*; use crate::enums::diesel_exports::*; - payout_attempt (payout_attempt_id) { + payout_attempt (merchant_id, payout_attempt_id) { #[max_length = 64] payout_attempt_id -> Varchar, #[max_length = 64] @@ -1127,6 +1127,8 @@ diesel::table! { #[max_length = 1024] unified_message -> Nullable<Varchar>, additional_payout_method_data -> Nullable<Jsonb>, + #[max_length = 255] + merchant_order_reference_id -> Nullable<Varchar>, } } @@ -1134,7 +1136,7 @@ diesel::table! { use diesel::sql_types::*; use crate::enums::diesel_exports::*; - payouts (payout_id) { + payouts (merchant_id, payout_id) { #[max_length = 64] payout_id -> Varchar, #[max_length = 64] diff --git a/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs b/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs index 8eec0abb9fc..8f4d667711b 100644 --- a/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs @@ -5351,7 +5351,7 @@ impl<F> TryFrom<&AdyenRouterData<&PayoutsRouterData<F>>> for AdyenPayoutCreateRe }, merchant_account, payment_data: PayoutPaymentMethodData::PayoutWalletData(payout_wallet), - reference: item.router_data.request.payout_id.to_owned(), + reference: item.router_data.connector_request_reference_id.clone(), shopper_reference: item.router_data.merchant_id.get_string_repr().to_owned(), shopper_email: customer_email, shopper_name: ShopperName { diff --git a/crates/hyperswitch_connectors/src/connectors/adyenplatform/transformers/payouts.rs b/crates/hyperswitch_connectors/src/connectors/adyenplatform/transformers/payouts.rs index 7262ec9f3ff..82c9afadeed 100644 --- a/crates/hyperswitch_connectors/src/connectors/adyenplatform/transformers/payouts.rs +++ b/crates/hyperswitch_connectors/src/connectors/adyenplatform/transformers/payouts.rs @@ -361,7 +361,7 @@ impl<F> TryFrom<&AdyenPlatformRouterData<&types::PayoutsRouterData<F>>> for Adye counterparty, priority, reference: item.router_data.connector_request_reference_id.clone(), - reference_for_beneficiary: request.payout_id.clone(), + reference_for_beneficiary: item.router_data.connector_request_reference_id.clone(), description: item.router_data.description.clone(), }) } diff --git a/crates/hyperswitch_connectors/src/connectors/cybersource/transformers.rs b/crates/hyperswitch_connectors/src/connectors/cybersource/transformers.rs index 6b4101a15d2..09b468c3caf 100644 --- a/crates/hyperswitch_connectors/src/connectors/cybersource/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/cybersource/transformers.rs @@ -3958,7 +3958,7 @@ impl TryFrom<&CybersourceRouterData<&PayoutsRouterData<PoFulfill>>> match payout_type { enums::PayoutType::Card => { let client_reference_information = ClientReferenceInformation { - code: Some(item.router_data.request.payout_id.clone()), + code: Some(item.router_data.connector_request_reference_id.clone()), }; let order_information = OrderInformation { @@ -3974,7 +3974,7 @@ impl TryFrom<&CybersourceRouterData<&PayoutsRouterData<PoFulfill>>> CybersourceRecipientInfo::try_from((billing_address, phone_address))?; let sender_information = CybersourceSenderInfo { - reference_number: item.router_data.request.payout_id.clone(), + reference_number: item.router_data.connector_request_reference_id.clone(), account: CybersourceAccountInfo { funds_source: CybersourcePayoutFundSourceType::Disbursement, }, diff --git a/crates/hyperswitch_connectors/src/connectors/nomupay/transformers.rs b/crates/hyperswitch_connectors/src/connectors/nomupay/transformers.rs index 9a1a50e8642..3eab923ff16 100644 --- a/crates/hyperswitch_connectors/src/connectors/nomupay/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/nomupay/transformers.rs @@ -385,7 +385,7 @@ impl<F> TryFrom<&PayoutsRouterData<F>> for OnboardSubAccountRequest { match payout_type { Some(common_enums::PayoutType::Bank) => Ok(Self { account_id: nomupay_auth_type.eid, - client_sub_account_id: Secret::new(request.payout_id), + client_sub_account_id: Secret::new(item.connector_request_reference_id.clone()), profile, }), _ => Err(errors::ConnectorError::NotImplemented( @@ -498,7 +498,7 @@ impl<F> TryFrom<(&PayoutsRouterData<F>, FloatMajorUnit)> for NomupayPaymentReque Ok(Self { source_id: nomupay_auth_type.eid, destination_id: Secret::new(destination), - payment_reference: item.request.clone().payout_id, + payment_reference: item.connector_request_reference_id.clone(), amount, currency_code: item.request.destination_currency, purpose: PURPOSE_OF_PAYMENT_IS_OTHER.to_string(), diff --git a/crates/hyperswitch_connectors/src/connectors/paypal/transformers.rs b/crates/hyperswitch_connectors/src/connectors/paypal/transformers.rs index 6b56ccea208..18c7ac02e71 100644 --- a/crates/hyperswitch_connectors/src/connectors/paypal/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/paypal/transformers.rs @@ -2309,7 +2309,7 @@ impl TryFrom<&PaypalRouterData<&PayoutsRouterData<PoFulfill>>> for PaypalFulfill let item_data = PaypalPayoutItem::try_from(item)?; Ok(Self { sender_batch_header: PayoutBatchHeader { - sender_batch_id: item.router_data.request.payout_id.to_owned(), + sender_batch_id: item.router_data.connector_request_reference_id.to_owned(), }, items: vec![item_data], }) diff --git a/crates/hyperswitch_connectors/src/connectors/stripe/transformers/connect.rs b/crates/hyperswitch_connectors/src/connectors/stripe/transformers/connect.rs index bb8d4509dac..321aad76551 100644 --- a/crates/hyperswitch_connectors/src/connectors/stripe/transformers/connect.rs +++ b/crates/hyperswitch_connectors/src/connectors/stripe/transformers/connect.rs @@ -216,7 +216,7 @@ impl<F> TryFrom<&PayoutsRouterData<F>> for StripeConnectPayoutCreateRequest { amount: request.amount, currency: request.destination_currency, destination: connector_customer_id, - transfer_group: request.payout_id, + transfer_group: item.connector_request_reference_id.clone(), }) } } diff --git a/crates/hyperswitch_connectors/src/connectors/wise/transformers.rs b/crates/hyperswitch_connectors/src/connectors/wise/transformers.rs index 1a9ff7bf89f..f844e15a488 100644 --- a/crates/hyperswitch_connectors/src/connectors/wise/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/wise/transformers.rs @@ -510,7 +510,7 @@ impl<F> TryFrom<&PayoutsRouterData<F>> for WisePayoutCreateRequest { Ok(Self { target_account, quote_uuid, - customer_transaction_id: request.payout_id, + customer_transaction_id: request.payout_id.get_string_repr().to_string(), details: wise_transfer_details, }) } diff --git a/crates/hyperswitch_domain_models/src/errors/api_error_response.rs b/crates/hyperswitch_domain_models/src/errors/api_error_response.rs index 21accfa22c5..2924093da3a 100644 --- a/crates/hyperswitch_domain_models/src/errors/api_error_response.rs +++ b/crates/hyperswitch_domain_models/src/errors/api_error_response.rs @@ -79,8 +79,10 @@ pub enum ApiErrorResponse { DuplicatePayment { payment_id: common_utils::id_type::PaymentId, }, - #[error(error_type = ErrorType::DuplicateRequest, code = "HE_01", message = "The payout with the specified payout_id '{payout_id}' already exists in our records")] - DuplicatePayout { payout_id: String }, + #[error(error_type = ErrorType::DuplicateRequest, code = "HE_01", message = "The payout with the specified payout_id '{payout_id:?}' already exists in our records")] + DuplicatePayout { + payout_id: common_utils::id_type::PayoutId, + }, #[error(error_type = ErrorType::DuplicateRequest, code = "HE_01", message = "The config with the specified key already exists in our records")] DuplicateConfig, #[error(error_type = ErrorType::ObjectNotFound, code = "HE_02", message = "Refund does not exist in our records")] @@ -403,7 +405,7 @@ impl ErrorSwitch<api_models::errors::types::ApiErrorResponse> for ApiErrorRespon AER::BadRequest(ApiError::new("HE", 1, "The payment with the specified payment_id already exists in our records", Some(Extra {reason: Some(format!("{payment_id:?} already exists")), ..Default::default()}))) } Self::DuplicatePayout { payout_id } => { - AER::BadRequest(ApiError::new("HE", 1, format!("The payout with the specified payout_id '{payout_id}' already exists in our records"), None)) + AER::BadRequest(ApiError::new("HE", 1, format!("The payout with the specified payout_id '{payout_id:?}' already exists in our records"), None)) } Self::DuplicateConfig => { AER::BadRequest(ApiError::new("HE", 1, "The config with the specified key already exists in our records", None)) diff --git a/crates/hyperswitch_domain_models/src/payouts.rs b/crates/hyperswitch_domain_models/src/payouts.rs index 8c6d751ebec..9a40dc119c0 100644 --- a/crates/hyperswitch_domain_models/src/payouts.rs +++ b/crates/hyperswitch_domain_models/src/payouts.rs @@ -7,7 +7,7 @@ use common_utils::{consts, id_type}; use time::PrimitiveDateTime; pub enum PayoutFetchConstraints { - Single { payout_id: String }, + Single { payout_id: id_type::PayoutId }, List(Box<PayoutListParams>), } @@ -21,10 +21,11 @@ pub struct PayoutListParams { pub payout_method: Option<Vec<common_enums::PayoutType>>, pub profile_id: Option<id_type::ProfileId>, pub customer_id: Option<id_type::CustomerId>, - pub starting_after_id: Option<String>, - pub ending_before_id: Option<String>, + pub starting_after_id: Option<id_type::PayoutId>, + pub ending_before_id: Option<id_type::PayoutId>, pub entity_type: Option<common_enums::PayoutEntityType>, pub limit: Option<u32>, + pub merchant_order_reference_id: Option<String>, } impl From<api_models::payouts::PayoutListConstraints> for PayoutFetchConstraints { @@ -44,6 +45,7 @@ impl From<api_models::payouts::PayoutListConstraints> for PayoutFetchConstraints starting_after_id: value.starting_after, ending_before_id: value.ending_before, entity_type: None, + merchant_order_reference_id: None, limit: Some(std::cmp::min( value.limit, consts::PAYOUTS_LIST_MAX_LIMIT_GET, @@ -67,6 +69,7 @@ impl From<common_utils::types::TimeRange> for PayoutFetchConstraints { starting_after_id: None, ending_before_id: None, entity_type: None, + merchant_order_reference_id: None, limit: None, })) } @@ -90,6 +93,7 @@ impl From<api_models::payouts::PayoutListFilterConstraints> for PayoutFetchConst starting_after_id: None, ending_before_id: None, entity_type: value.entity_type, + merchant_order_reference_id: value.merchant_order_reference_id, limit: Some(std::cmp::min( value.limit, consts::PAYOUTS_LIST_MAX_LIMIT_POST, diff --git a/crates/hyperswitch_domain_models/src/payouts/payout_attempt.rs b/crates/hyperswitch_domain_models/src/payouts/payout_attempt.rs index dcb61bddc97..b6293faa841 100644 --- a/crates/hyperswitch_domain_models/src/payouts/payout_attempt.rs +++ b/crates/hyperswitch_domain_models/src/payouts/payout_attempt.rs @@ -42,6 +42,13 @@ pub trait PayoutAttemptInterface { _storage_scheme: MerchantStorageScheme, ) -> error_stack::Result<PayoutAttempt, Self::Error>; + async fn find_payout_attempt_by_merchant_id_merchant_order_reference_id( + &self, + _merchant_id: &id_type::MerchantId, + _merchant_order_reference_id: &str, + _storage_scheme: MerchantStorageScheme, + ) -> error_stack::Result<PayoutAttempt, Self::Error>; + async fn get_filters_for_payouts( &self, _payout: &[Payouts], @@ -61,7 +68,7 @@ pub struct PayoutListFilters { #[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)] pub struct PayoutAttempt { pub payout_attempt_id: String, - pub payout_id: String, + pub payout_id: id_type::PayoutId, pub customer_id: Option<id_type::CustomerId>, pub merchant_id: id_type::MerchantId, pub address_id: Option<String>, @@ -84,12 +91,13 @@ pub struct PayoutAttempt { pub unified_code: Option<UnifiedCode>, pub unified_message: Option<UnifiedMessage>, pub additional_payout_method_data: Option<payout_method_utils::AdditionalPayoutMethodData>, + pub merchant_order_reference_id: Option<String>, } #[derive(Clone, Debug, PartialEq)] pub struct PayoutAttemptNew { pub payout_attempt_id: String, - pub payout_id: String, + pub payout_id: id_type::PayoutId, pub customer_id: Option<id_type::CustomerId>, pub merchant_id: id_type::MerchantId, pub address_id: Option<String>, @@ -110,6 +118,7 @@ pub struct PayoutAttemptNew { pub unified_code: Option<UnifiedCode>, pub unified_message: Option<UnifiedMessage>, pub additional_payout_method_data: Option<payout_method_utils::AdditionalPayoutMethodData>, + pub merchant_order_reference_id: Option<String>, } #[derive(Debug, Clone)] diff --git a/crates/hyperswitch_domain_models/src/payouts/payouts.rs b/crates/hyperswitch_domain_models/src/payouts/payouts.rs index 7c34b3c26df..1d41a5f9a32 100644 --- a/crates/hyperswitch_domain_models/src/payouts/payouts.rs +++ b/crates/hyperswitch_domain_models/src/payouts/payouts.rs @@ -20,7 +20,7 @@ pub trait PayoutsInterface { async fn find_payout_by_merchant_id_payout_id( &self, _merchant_id: &id_type::MerchantId, - _payout_id: &str, + _payout_id: &id_type::PayoutId, _storage_scheme: MerchantStorageScheme, ) -> error_stack::Result<Payouts, Self::Error>; @@ -35,7 +35,7 @@ pub trait PayoutsInterface { async fn find_optional_payout_by_merchant_id_payout_id( &self, _merchant_id: &id_type::MerchantId, - _payout_id: &str, + _payout_id: &id_type::PayoutId, _storage_scheme: MerchantStorageScheme, ) -> error_stack::Result<Option<Payouts>, Self::Error>; @@ -76,7 +76,7 @@ pub trait PayoutsInterface { async fn get_total_count_of_filtered_payouts( &self, _merchant_id: &id_type::MerchantId, - _active_payout_ids: &[String], + _active_payout_ids: &[id_type::PayoutId], _connector: Option<Vec<api_models::enums::PayoutConnectors>>, _currency: Option<Vec<storage_enums::Currency>>, _status: Option<Vec<storage_enums::PayoutStatus>>, @@ -88,12 +88,12 @@ pub trait PayoutsInterface { &self, _merchant_id: &id_type::MerchantId, _constraints: &PayoutFetchConstraints, - ) -> error_stack::Result<Vec<String>, Self::Error>; + ) -> error_stack::Result<Vec<id_type::PayoutId>, Self::Error>; } #[derive(Clone, Debug, Eq, PartialEq)] pub struct Payouts { - pub payout_id: String, + pub payout_id: id_type::PayoutId, pub merchant_id: id_type::MerchantId, pub customer_id: Option<id_type::CustomerId>, pub address_id: Option<String>, @@ -121,7 +121,7 @@ pub struct Payouts { #[derive(Clone, Debug, Eq, PartialEq)] pub struct PayoutsNew { - pub payout_id: String, + pub payout_id: id_type::PayoutId, pub merchant_id: id_type::MerchantId, pub customer_id: Option<id_type::CustomerId>, pub address_id: Option<String>, diff --git a/crates/hyperswitch_domain_models/src/router_request_types.rs b/crates/hyperswitch_domain_models/src/router_request_types.rs index e811b872c8c..c7987122ead 100644 --- a/crates/hyperswitch_domain_models/src/router_request_types.rs +++ b/crates/hyperswitch_domain_models/src/router_request_types.rs @@ -890,7 +890,7 @@ pub struct UploadFileRequestData { #[cfg(feature = "payouts")] #[derive(Debug, Clone)] pub struct PayoutsData { - pub payout_id: String, + pub payout_id: id_type::PayoutId, pub amount: i64, pub connector_payout_id: Option<String>, pub destination_currency: storage_enums::Currency, diff --git a/crates/router/src/compatibility/stripe/errors.rs b/crates/router/src/compatibility/stripe/errors.rs index 58f707b2db6..83f7fe69053 100644 --- a/crates/router/src/compatibility/stripe/errors.rs +++ b/crates/router/src/compatibility/stripe/errors.rs @@ -1,4 +1,4 @@ -use common_utils::errors::ErrorSwitch; +use common_utils::{errors::ErrorSwitch, id_type}; use hyperswitch_domain_models::errors::api_error_response as errors; use crate::core::errors::CustomersErrorResponse; @@ -133,7 +133,7 @@ pub enum StripeErrorCode { EventNotFound, #[error(error_type = StripeErrorType::InvalidRequestError, code = "token_already_used", message = "Duplicate payout request")] - DuplicatePayout { payout_id: String }, + DuplicatePayout { payout_id: id_type::PayoutId }, #[error(error_type = StripeErrorType::InvalidRequestError, code = "parameter_missing", message = "Return url is not available")] ReturnUrlUnavailable, @@ -209,9 +209,7 @@ pub enum StripeErrorCode { PaymentIntentMandateInvalid { message: String }, #[error(error_type = StripeErrorType::InvalidRequestError, code = "", message = "The payment with the specified payment_id already exists in our records.")] - DuplicatePayment { - payment_id: common_utils::id_type::PaymentId, - }, + DuplicatePayment { payment_id: id_type::PaymentId }, #[error(error_type = StripeErrorType::ConnectorError, code = "", message = "{code}: {message}")] ExternalConnectorError { diff --git a/crates/router/src/compatibility/stripe/webhooks.rs b/crates/router/src/compatibility/stripe/webhooks.rs index f5dde401b35..3bd0f83b7db 100644 --- a/crates/router/src/compatibility/stripe/webhooks.rs +++ b/crates/router/src/compatibility/stripe/webhooks.rs @@ -4,9 +4,12 @@ use api_models::{ enums::{Currency, DisputeStatus, MandateStatus}, webhooks::{self as api}, }; -#[cfg(feature = "payouts")] -use common_utils::pii::{self, Email}; use common_utils::{crypto::SignMessage, date_time, ext_traits::Encode}; +#[cfg(feature = "payouts")] +use common_utils::{ + id_type, + pii::{self, Email}, +}; use error_stack::ResultExt; use router_env::logger; use serde::Serialize; @@ -94,7 +97,7 @@ pub struct StripeDisputeResponse { pub id: String, pub amount: String, pub currency: Currency, - pub payment_intent: common_utils::id_type::PaymentId, + pub payment_intent: id_type::PaymentId, pub reason: Option<String>, pub status: StripeDisputeStatus, } @@ -110,7 +113,7 @@ pub struct StripeMandateResponse { #[cfg(feature = "payouts")] #[derive(Clone, Serialize, Debug)] pub struct StripePayoutResponse { - pub id: String, + pub id: id_type::PayoutId, pub amount: i64, pub currency: String, pub payout_type: Option<common_enums::PayoutType>, diff --git a/crates/router/src/core/payments/routing.rs b/crates/router/src/core/payments/routing.rs index 4cc667bdc8a..7126ed9617e 100644 --- a/crates/router/src/core/payments/routing.rs +++ b/crates/router/src/core/payments/routing.rs @@ -483,9 +483,11 @@ pub async fn perform_static_routing_v1( .get_string_repr() .to_string(), #[cfg(feature = "payouts")] - routing::TransactionData::Payout(payout_data) => { - payout_data.payout_attempt.payout_id.clone() - } + routing::TransactionData::Payout(payout_data) => payout_data + .payout_attempt + .payout_id + .get_string_repr() + .to_string(), }; let routing_events_wrapper = utils::RoutingEventsWrapper::new( diff --git a/crates/router/src/core/payout_link.rs b/crates/router/src/core/payout_link.rs index 8c234889630..1d224ffbd79 100644 --- a/crates/router/src/core/payout_link.rs +++ b/crates/router/src/core/payout_link.rs @@ -22,6 +22,7 @@ use crate::{ routes::{app::StorageInterface, SessionState}, services, types::{api, domain, transformers::ForeignFrom}, + utils::get_payout_attempt_id, }; #[cfg(feature = "v2")] @@ -56,7 +57,7 @@ pub async fn initiate_payout_link( let payout_attempt = db .find_payout_attempt_by_merchant_id_payout_attempt_id( merchant_id, - &format!("{}_{}", payout.payout_id, payout.attempt_count), + &get_payout_attempt_id(payout.payout_id.get_string_repr(), payout.attempt_count), merchant_context.get_merchant_account().storage_scheme, ) .await @@ -146,13 +147,11 @@ pub async fn initiate_payout_link( .await .change_context(errors::ApiErrorResponse::InvalidRequestData { message: format!( - "Customer [{}] not found for link_id - {}", - payout_link.primary_reference, payout_link.link_id + "Customer [{:?}] not found for link_id - {}", + customer_id, payout_link.link_id ), }) - .attach_printable_lazy(|| { - format!("customer [{}] not found", payout_link.primary_reference) - })?; + .attach_printable_lazy(|| format!("customer [{:?}] not found", customer_id))?; let address = payout .address_id .as_ref() @@ -169,7 +168,7 @@ pub async fn initiate_payout_link( .change_context(errors::ApiErrorResponse::InternalServerError) .attach_printable_lazy(|| { format!( - "Failed while fetching address [id - {:?}] for payout [id - {}]", + "Failed while fetching address [id - {:?}] for payout [id - {:?}]", payout.address_id, payout.payout_id ) })?; @@ -227,7 +226,7 @@ pub async fn initiate_payout_link( ), client_secret: link_data.client_secret.clone(), payout_link_id: payout_link.link_id, - payout_id: payout_link.primary_reference, + payout_id: payout_link.primary_reference.clone(), customer_id: customer.customer_id, session_expiry: payout_link.expiry, return_url: payout_link @@ -284,7 +283,7 @@ pub async fn initiate_payout_link( .await?; let js_data = payouts::PayoutLinkStatusDetails { payout_link_id: payout_link.link_id, - payout_id: payout_link.primary_reference, + payout_id: payout_link.primary_reference.clone(), customer_id: link_data.customer_id, session_expiry: payout_link.expiry, return_url: payout_link diff --git a/crates/router/src/core/payouts.rs b/crates/router/src/core/payouts.rs index 495bea84eac..3cc996bd9a6 100644 --- a/crates/router/src/core/payouts.rs +++ b/crates/router/src/core/payouts.rs @@ -17,7 +17,7 @@ use common_enums::PayoutRetryType; use common_utils::{ consts, ext_traits::{AsyncExt, ValueExt}, - id_type::CustomerId, + id_type::{self, GenerateId}, link_utils::{GenericLinkStatus, GenericLinkUiConfig, PayoutLinkData, PayoutLinkStatus}, types::{MinorUnit, UnifiedCode, UnifiedMessage}, }; @@ -73,7 +73,7 @@ pub struct PayoutData { pub payouts: storage::Payouts, pub payout_attempt: storage::PayoutAttempt, pub payout_method_data: Option<payouts::PayoutMethodData>, - pub profile_id: common_utils::id_type::ProfileId, + pub profile_id: id_type::ProfileId, pub should_terminate: bool, pub payout_link: Option<PayoutLink>, pub current_locale: String, @@ -451,7 +451,7 @@ pub async fn payouts_update_core( if helpers::is_payout_terminal_state(status) || helpers::is_payout_initiated(status) { return Err(report!(errors::ApiErrorResponse::InvalidRequestData { message: format!( - "Payout {} cannot be updated for status {}", + "Payout {:?} cannot be updated for status {}", payout_id, status ), })); @@ -506,7 +506,7 @@ pub async fn payouts_update_core( pub async fn payouts_retrieve_core( state: SessionState, merchant_context: domain::MerchantContext, - profile_id: Option<common_utils::id_type::ProfileId>, + profile_id: Option<id_type::ProfileId>, req: payouts::PayoutRetrieveRequest, ) -> RouterResponse<payouts::PayoutCreateResponse> { let mut payout_data = Box::pin(make_payout_data( @@ -568,7 +568,7 @@ pub async fn payouts_cancel_core( if helpers::is_payout_terminal_state(status) { return Err(report!(errors::ApiErrorResponse::InvalidRequestData { message: format!( - "Payout {} cannot be cancelled for status {}", + "Payout {:?} cannot be cancelled for status {}", payout_attempt.payout_id, status ), })); @@ -663,7 +663,7 @@ pub async fn payouts_fulfill_core( { return Err(report!(errors::ApiErrorResponse::InvalidRequestData { message: format!( - "Payout {} cannot be fulfilled for status {}", + "Payout {:?} cannot be fulfilled for status {}", payout_attempt.payout_id, status ), })); @@ -733,7 +733,7 @@ pub async fn payouts_fulfill_core( pub async fn payouts_list_core( _state: SessionState, _merchant_context: domain::MerchantContext, - _profile_id_list: Option<Vec<common_utils::id_type::ProfileId>>, + _profile_id_list: Option<Vec<id_type::ProfileId>>, _constraints: payouts::PayoutListConstraints, ) -> RouterResponse<payouts::PayoutListResponse> { todo!() @@ -743,7 +743,7 @@ pub async fn payouts_list_core( pub async fn payouts_list_core( state: SessionState, merchant_context: domain::MerchantContext, - profile_id_list: Option<Vec<common_utils::id_type::ProfileId>>, + profile_id_list: Option<Vec<id_type::ProfileId>>, constraints: payouts::PayoutListConstraints, ) -> RouterResponse<payouts::PayoutListResponse> { validator::validate_payout_list_request(&constraints)?; @@ -765,7 +765,10 @@ pub async fn payouts_list_core( match db .find_payout_attempt_by_merchant_id_payout_attempt_id( merchant_id, - &utils::get_payout_attempt_id(payout.payout_id.clone(), payout.attempt_count), + &utils::get_payout_attempt_id( + payout.payout_id.get_string_repr(), + payout.attempt_count, + ), storage_enums::MerchantStorageScheme::PostgresOnly, ) .await @@ -795,7 +798,7 @@ pub async fn payouts_list_core( }; let payout_id_as_payment_id_type = - common_utils::id_type::PaymentId::wrap(payout.payout_id.clone()) + id_type::PaymentId::wrap(payout.payout_id.get_string_repr().to_string()) .change_context(errors::ApiErrorResponse::InvalidRequestData { message: "payout_id contains invalid data".to_string(), }) @@ -862,7 +865,7 @@ pub async fn payouts_list_core( pub async fn payouts_filtered_list_core( state: SessionState, merchant_context: domain::MerchantContext, - profile_id_list: Option<Vec<common_utils::id_type::ProfileId>>, + profile_id_list: Option<Vec<id_type::ProfileId>>, filters: payouts::PayoutListFilterConstraints, ) -> RouterResponse<payouts::PayoutListResponse> { let limit = &filters.limit; @@ -976,7 +979,7 @@ pub async fn payouts_filtered_list_core( pub async fn payouts_list_available_filters_core( state: SessionState, merchant_context: domain::MerchantContext, - profile_id_list: Option<Vec<common_utils::id_type::ProfileId>>, + profile_id_list: Option<Vec<id_type::ProfileId>>, time_range: common_utils::types::TimeRange, ) -> RouterResponse<api::PayoutListFilters> { let db = state.store.as_ref(); @@ -2540,6 +2543,7 @@ pub async fn response_handler( let response = api::PayoutCreateResponse { payout_id: payouts.payout_id.to_owned(), merchant_id: merchant_context.get_merchant_account().get_id().to_owned(), + merchant_order_reference_id: payout_attempt.merchant_order_reference_id.clone(), amount: payouts.amount, currency: payouts.destination_currency.to_owned(), connector: payout_attempt.connector, @@ -2615,8 +2619,8 @@ pub async fn payout_create_db_entries( state: &SessionState, merchant_context: &domain::MerchantContext, req: &payouts::PayoutCreateRequest, - payout_id: &String, - profile_id: &common_utils::id_type::ProfileId, + payout_id: &id_type::PayoutId, + profile_id: &id_type::ProfileId, stored_payout_method_data: Option<&payouts::PayoutMethodData>, locale: &str, customer: Option<&domain::Customer>, @@ -2655,12 +2659,13 @@ pub async fn payout_create_db_entries( // We have to do this because the function that is being used to create / get address is from payments // which expects a payment_id - let payout_id_as_payment_id_type = - common_utils::id_type::PaymentId::try_from(std::borrow::Cow::Owned(payout_id.to_string())) - .change_context(errors::ApiErrorResponse::InvalidRequestData { - message: "payout_id contains invalid data".to_string(), - }) - .attach_printable("Error converting payout_id to PaymentId type")?; + let payout_id_as_payment_id_type = id_type::PaymentId::try_from(std::borrow::Cow::Owned( + payout_id.get_string_repr().to_string(), + )) + .change_context(errors::ApiErrorResponse::InvalidRequestData { + message: "payout_id contains invalid data".to_string(), + }) + .attach_printable("Error converting payout_id to PaymentId type")?; // Get or create address let billing_address = payment_helpers::create_or_find_address_for_payment_by_request( @@ -2696,7 +2701,7 @@ pub async fn payout_create_db_entries( let client_secret = utils::generate_id( consts::ID_LENGTH, - format!("payout_{payout_id}_secret").as_str(), + format!("payout_{payout_id:?}_secret").as_str(), ); let amount = MinorUnit::from(req.amount.unwrap_or(api::Amount::Zero)); let status = if req.payout_method_data.is_some() @@ -2712,7 +2717,7 @@ pub async fn payout_create_db_entries( }; let payouts_req = storage::PayoutsNew { - payout_id: payout_id.to_string(), + payout_id: payout_id.clone(), merchant_id: merchant_id.to_owned(), customer_id: customer_id.to_owned(), address_id: address_id.to_owned(), @@ -2746,11 +2751,11 @@ pub async fn payout_create_db_entries( ) .await .to_duplicate_response(errors::ApiErrorResponse::DuplicatePayout { - payout_id: payout_id.to_owned(), + payout_id: payout_id.clone(), }) .attach_printable("Error inserting payouts in db")?; // Make payout_attempt entry - let payout_attempt_id = utils::get_payout_attempt_id(payout_id, 1); + let payout_attempt_id = utils::get_payout_attempt_id(payout_id.get_string_repr(), 1); let additional_pm_data_value = req .payout_method_data @@ -2764,9 +2769,10 @@ pub async fn payout_create_db_entries( let payout_attempt_req = storage::PayoutAttemptNew { payout_attempt_id: payout_attempt_id.to_string(), - payout_id: payout_id.to_owned(), + payout_id: payout_id.clone(), additional_payout_method_data: additional_pm_data_value, merchant_id: merchant_id.to_owned(), + merchant_order_reference_id: req.merchant_order_reference_id.clone(), status, business_country: req.business_country.to_owned(), business_label: req.business_label.to_owned(), @@ -2794,7 +2800,7 @@ pub async fn payout_create_db_entries( ) .await .to_duplicate_response(errors::ApiErrorResponse::DuplicatePayout { - payout_id: payout_id.to_owned(), + payout_id: payout_id.clone(), }) .attach_printable("Error inserting payout_attempt in db")?; @@ -2823,7 +2829,7 @@ pub async fn payout_create_db_entries( pub async fn make_payout_data( _state: &SessionState, _merchant_context: &domain::MerchantContext, - _auth_profile_id: Option<common_utils::id_type::ProfileId>, + _auth_profile_id: Option<id_type::ProfileId>, _req: &payouts::PayoutRequest, locale: &str, ) -> RouterResult<PayoutData> { @@ -2834,7 +2840,7 @@ pub async fn make_payout_data( pub async fn make_payout_data( state: &SessionState, merchant_context: &domain::MerchantContext, - auth_profile_id: Option<common_utils::id_type::ProfileId>, + auth_profile_id: Option<id_type::ProfileId>, req: &payouts::PayoutRequest, locale: &str, ) -> RouterResult<PayoutData> { @@ -2842,7 +2848,9 @@ pub async fn make_payout_data( let merchant_id = merchant_context.get_merchant_account().get_id(); let payout_id = match req { payouts::PayoutRequest::PayoutActionRequest(r) => r.payout_id.clone(), - payouts::PayoutRequest::PayoutCreateRequest(r) => r.payout_id.clone().unwrap_or_default(), + payouts::PayoutRequest::PayoutCreateRequest(r) => { + r.payout_id.clone().unwrap_or(id_type::PayoutId::generate()) + } payouts::PayoutRequest::PayoutRetrieveRequest(r) => r.payout_id.clone(), }; @@ -2856,7 +2864,8 @@ pub async fn make_payout_data( .to_not_found_response(errors::ApiErrorResponse::PayoutNotFound)?; core_utils::validate_profile_id_from_auth_layer(auth_profile_id, &payouts)?; - let payout_attempt_id = utils::get_payout_attempt_id(payout_id, payouts.attempt_count); + let payout_attempt_id = + utils::get_payout_attempt_id(payouts.payout_id.get_string_repr(), payouts.attempt_count); let mut payout_attempt = db .find_payout_attempt_by_merchant_id_payout_attempt_id( @@ -2871,9 +2880,9 @@ pub async fn make_payout_data( // We have to do this because the function that is being used to create / get address is from payments // which expects a payment_id - let payout_id_as_payment_id_type = common_utils::id_type::PaymentId::try_from( - std::borrow::Cow::Owned(payouts.payout_id.clone()), - ) + let payout_id_as_payment_id_type = id_type::PaymentId::try_from(std::borrow::Cow::Owned( + payouts.payout_id.get_string_repr().to_string(), + )) .change_context(errors::ApiErrorResponse::InvalidRequestData { message: "payout_id contains invalid data".to_string(), }) @@ -2906,7 +2915,7 @@ pub async fn make_payout_data( .map_err(|err| err.change_context(errors::ApiErrorResponse::InternalServerError)) .attach_printable_lazy(|| { format!( - "Failed while fetching optional customer [id - {:?}] for payout [id - {}]", + "Failed while fetching optional customer [id - {:?}] for payout [id - {:?}]", customer_id, payout_id ) }) @@ -3079,8 +3088,8 @@ pub async fn add_external_account_addition_task( async fn validate_and_get_business_profile( state: &SessionState, merchant_key_store: &domain::MerchantKeyStore, - profile_id: &common_utils::id_type::ProfileId, - merchant_id: &common_utils::id_type::MerchantId, + profile_id: &id_type::ProfileId, + merchant_id: &id_type::MerchantId, ) -> RouterResult<domain::Profile> { let db = &*state.store; let key_manager_state = &state.into(); @@ -3108,10 +3117,10 @@ async fn validate_and_get_business_profile( pub async fn create_payout_link( state: &SessionState, business_profile: &domain::Profile, - customer_id: &CustomerId, - merchant_id: &common_utils::id_type::MerchantId, + customer_id: &id_type::CustomerId, + merchant_id: &id_type::MerchantId, req: &payouts::PayoutCreateRequest, - payout_id: &str, + payout_id: &id_type::PayoutId, locale: &str, ) -> RouterResult<PayoutLink> { let payout_link_config_req = req.payout_link_config.to_owned(); @@ -3175,7 +3184,7 @@ pub async fn create_payout_link( .as_ref() .map_or(default_config.expiry, |expiry| *expiry); let url = format!( - "{base_url}/payout_link/{}/{payout_id}?locale={}", + "{base_url}/payout_link/{}/{payout_id:?}?locale={}", merchant_id.get_string_repr(), locale ); @@ -3214,7 +3223,7 @@ pub async fn create_payout_link( let data = PayoutLinkData { payout_link_id: payout_link_id.clone(), customer_id: customer_id.clone(), - payout_id: payout_id.to_string(), + payout_id: payout_id.clone(), link, client_secret: Secret::new(client_secret), session_expiry, @@ -3232,7 +3241,7 @@ pub async fn create_payout_link( pub async fn create_payout_link_db_entry( state: &SessionState, - merchant_id: &common_utils::id_type::MerchantId, + merchant_id: &id_type::MerchantId, payout_link_data: &PayoutLinkData, return_url: Option<String>, ) -> RouterResult<PayoutLink> { @@ -3244,7 +3253,7 @@ pub async fn create_payout_link_db_entry( let payout_link = GenericLinkNew { link_id: payout_link_data.payout_link_id.to_string(), - primary_reference: payout_link_data.payout_id.to_string(), + primary_reference: payout_link_data.payout_id.get_string_repr().to_string(), merchant_id: merchant_id.to_owned(), link_type: common_enums::GenericLinkType::PayoutLink, link_status: GenericLinkStatus::PayoutLink(PayoutLinkStatus::Initiated), @@ -3267,9 +3276,9 @@ pub async fn create_payout_link_db_entry( pub async fn get_mca_from_profile_id( state: &SessionState, merchant_context: &domain::MerchantContext, - profile_id: &common_utils::id_type::ProfileId, + profile_id: &id_type::ProfileId, connector_name: &str, - merchant_connector_id: Option<&common_utils::id_type::MerchantConnectorAccountId>, + merchant_connector_id: Option<&id_type::MerchantConnectorAccountId>, ) -> RouterResult<payment_helpers::MerchantConnectorAccountType> { let merchant_connector_account = payment_helpers::get_merchant_connector_account( state, diff --git a/crates/router/src/core/payouts/helpers.rs b/crates/router/src/core/payouts/helpers.rs index 1003ee699f2..9e006ed9ce4 100644 --- a/crates/router/src/core/payouts/helpers.rs +++ b/crates/router/src/core/payouts/helpers.rs @@ -1201,7 +1201,8 @@ pub async fn update_payouts_and_payout_attempt( return Err(report!(errors::ApiErrorResponse::InvalidRequestData { message: format!( "Payout {} cannot be updated for status {}", - payout_id, status + payout_id.get_string_repr(), + status ), })); } @@ -1226,12 +1227,13 @@ pub async fn update_payouts_and_payout_attempt( // We have to do this because the function that is being used to create / get address is from payments // which expects a payment_id - let payout_id_as_payment_id_type = - id_type::PaymentId::try_from(std::borrow::Cow::Owned(payout_id.clone())) - .change_context(errors::ApiErrorResponse::InvalidRequestData { - message: "payout_id contains invalid data".to_string(), - }) - .attach_printable("Error converting payout_id to PaymentId type")?; + let payout_id_as_payment_id_type = id_type::PaymentId::try_from(std::borrow::Cow::Owned( + payout_id.get_string_repr().to_string(), + )) + .change_context(errors::ApiErrorResponse::InvalidRequestData { + message: "payout_id contains invalid data for PaymentId conversion".to_string(), + }) + .attach_printable("Error converting payout_id to PaymentId type")?; // Fetch address details from request and create new or else use existing address that was attached let billing_address = payment_helpers::create_or_find_address_for_payment_by_request( diff --git a/crates/router/src/core/payouts/retry.rs b/crates/router/src/core/payouts/retry.rs index 3b5e93eaf11..30100a580d4 100644 --- a/crates/router/src/core/payouts/retry.rs +++ b/crates/router/src/core/payouts/retry.rs @@ -269,12 +269,18 @@ pub async fn modify_trackers( .change_context(errors::ApiErrorResponse::InternalServerError) .attach_printable("Error updating payouts")?; - let payout_attempt_id = - utils::get_payout_attempt_id(payout_id.to_owned(), payout_data.payouts.attempt_count); + let payout_attempt_id = utils::get_payout_attempt_id( + payout_id.get_string_repr(), + payout_data.payouts.attempt_count, + ); let payout_attempt_req = storage::PayoutAttemptNew { payout_attempt_id: payout_attempt_id.to_string(), payout_id: payout_id.to_owned(), + merchant_order_reference_id: payout_data + .payout_attempt + .merchant_order_reference_id + .clone(), customer_id: payout_data.payout_attempt.customer_id.to_owned(), connector: Some(connector.connector_name.to_string()), merchant_id: payout_data.payout_attempt.merchant_id.to_owned(), diff --git a/crates/router/src/core/payouts/transformers.rs b/crates/router/src/core/payouts/transformers.rs index a1c92ec3b29..7040559d9f4 100644 --- a/crates/router/src/core/payouts/transformers.rs +++ b/crates/router/src/core/payouts/transformers.rs @@ -69,6 +69,7 @@ impl payout_id: payout.payout_id, merchant_id: payout.merchant_id, merchant_connector_id: payout_attempt.merchant_connector_id, + merchant_order_reference_id: payout_attempt.merchant_order_reference_id.clone(), amount: payout.amount, currency: payout.destination_currency, connector: payout_attempt.connector, diff --git a/crates/router/src/core/payouts/validator.rs b/crates/router/src/core/payouts/validator.rs index 35c4599dbc2..1af3f4d2cb5 100644 --- a/crates/router/src/core/payouts/validator.rs +++ b/crates/router/src/core/payouts/validator.rs @@ -3,7 +3,10 @@ use std::collections::HashSet; use actix_web::http::header; #[cfg(feature = "olap")] use common_utils::errors::CustomResult; -use common_utils::validation::validate_domain_against_allowed_domains; +use common_utils::{ + id_type::{self, GenerateId}, + validation::validate_domain_against_allowed_domains, +}; use diesel_models::generic_link::PayoutLink; use error_stack::{report, ResultExt}; use hyperswitch_domain_models::payment_methods::PaymentMethod; @@ -29,8 +32,8 @@ use crate::{ #[instrument(skip(db))] pub async fn validate_uniqueness_of_payout_id_against_merchant_id( db: &dyn StorageInterface, - payout_id: &str, - merchant_id: &common_utils::id_type::MerchantId, + payout_id: &id_type::PayoutId, + merchant_id: &id_type::MerchantId, storage_scheme: storage::enums::MerchantStorageScheme, ) -> RouterResult<Option<storage::Payouts>> { let maybe_payouts = db @@ -75,9 +78,9 @@ pub async fn validate_create_request( merchant_context: &domain::MerchantContext, req: &payouts::PayoutCreateRequest, ) -> RouterResult<( - String, + id_type::PayoutId, Option<payouts::PayoutMethodData>, - common_utils::id_type::ProfileId, + id_type::ProfileId, Option<domain::Customer>, Option<PaymentMethod>, )> { @@ -101,7 +104,11 @@ pub async fn validate_create_request( // Payout ID let db: &dyn StorageInterface = &*state.store; - let payout_id = core_utils::get_or_generate_uuid("payout_id", req.payout_id.as_ref())?; + let payout_id = match req.payout_id.as_ref() { + Some(provided_payout_id) => provided_payout_id.clone(), + None => id_type::PayoutId::generate(), + }; + match validate_uniqueness_of_payout_id_against_merchant_id( db, &payout_id, @@ -111,13 +118,12 @@ pub async fn validate_create_request( .await .attach_printable_lazy(|| { format!( - "Unique violation while checking payout_id: {} against merchant_id: {:?}", - payout_id.to_owned(), - merchant_id + "Unique violation while checking payout_id: {:?} against merchant_id: {:?}", + payout_id, merchant_id ) })? { Some(_) => Err(report!(errors::ApiErrorResponse::DuplicatePayout { - payout_id: payout_id.to_owned() + payout_id: payout_id.clone() })), None => Ok(()), }?; diff --git a/crates/router/src/core/utils.rs b/crates/router/src/core/utils.rs index 17ac3f9abd0..d0a27406eb5 100644 --- a/crates/router/src/core/utils.rs +++ b/crates/router/src/core/utils.rs @@ -34,7 +34,6 @@ use masking::{ExposeInterface, PeekInterface}; use maud::{html, PreEscaped}; use regex::Regex; use router_env::{instrument, tracing}; -use uuid::Uuid; use super::payments::helpers; #[cfg(feature = "payouts")] @@ -57,7 +56,7 @@ use crate::{ storage::{self, enums}, PollConfig, }, - utils::{generate_id, generate_uuid, OptionExt, ValueExt}, + utils::{generate_id, OptionExt, ValueExt}, }; pub const IRRELEVANT_CONNECTOR_REQUEST_REFERENCE_ID_IN_DISPUTE_FLOW: &str = @@ -188,7 +187,7 @@ pub async fn construct_payout_router_data<'a, F>( minor_amount_captured: None, payment_method_status: None, request: types::PayoutsData { - payout_id: payouts.payout_id.to_owned(), + payout_id: payouts.payout_id.clone(), amount: payouts.amount.get_amount_as_i64(), minor_amount: payouts.amount, connector_payout_id: payout_attempt.connector_payout_id.clone(), @@ -622,16 +621,6 @@ pub fn get_or_generate_id( .map_or(Ok(generate_id(consts::ID_LENGTH, prefix)), validate_id) } -pub fn get_or_generate_uuid( - key: &str, - provided_id: Option<&String>, -) -> Result<String, errors::ApiErrorResponse> { - let validate_id = |id: String| validate_uuid(id, key); - provided_id - .cloned() - .map_or(Ok(generate_uuid()), validate_id) -} - fn invalid_id_format_error(key: &str) -> errors::ApiErrorResponse { errors::ApiErrorResponse::InvalidDataFormat { field_name: key.to_string(), @@ -650,13 +639,6 @@ pub fn validate_id(id: String, key: &str) -> Result<String, errors::ApiErrorResp } } -pub fn validate_uuid(uuid: String, key: &str) -> Result<String, errors::ApiErrorResponse> { - match (Uuid::parse_str(&uuid), uuid.len() > consts::MAX_ID_LENGTH) { - (Ok(_), false) => Ok(uuid), - (_, _) => Err(invalid_id_format_error(key)), - } -} - #[cfg(feature = "v1")] pub fn get_split_refunds( split_refund_input: refunds_transformers::SplitRefundInput, diff --git a/crates/router/src/core/webhooks/incoming.rs b/crates/router/src/core/webhooks/incoming.rs index 5fef952532f..cc1dc7bc506 100644 --- a/crates/router/src/core/webhooks/incoming.rs +++ b/crates/router/src/core/webhooks/incoming.rs @@ -997,7 +997,10 @@ async fn payouts_incoming_webhook_flow( business_profile, outgoing_event_type, enums::EventClass::Payouts, - updated_payout_attempt.payout_id.clone(), + updated_payout_attempt + .payout_id + .get_string_repr() + .to_string(), enums::EventObjectType::PayoutDetails, api::OutgoingWebhookContent::PayoutDetails(Box::new(payout_create_response)), Some(updated_payout_attempt.created_at), diff --git a/crates/router/src/db/kafka_store.rs b/crates/router/src/db/kafka_store.rs index 48d0d582abb..7f24d2f5c99 100644 --- a/crates/router/src/db/kafka_store.rs +++ b/crates/router/src/db/kafka_store.rs @@ -2325,6 +2325,22 @@ impl PayoutAttemptInterface for KafkaStore {} #[async_trait::async_trait] impl PayoutAttemptInterface for KafkaStore { type Error = errors::StorageError; + + async fn find_payout_attempt_by_merchant_id_merchant_order_reference_id( + &self, + merchant_id: &id_type::MerchantId, + merchant_order_reference_id: &str, + storage_scheme: MerchantStorageScheme, + ) -> CustomResult<storage::PayoutAttempt, errors::StorageError> { + self.diesel_store + .find_payout_attempt_by_merchant_id_merchant_order_reference_id( + merchant_id, + merchant_order_reference_id, + storage_scheme, + ) + .await + } + async fn find_payout_attempt_by_merchant_id_payout_attempt_id( &self, merchant_id: &id_type::MerchantId, @@ -2431,7 +2447,7 @@ impl PayoutsInterface for KafkaStore { async fn find_payout_by_merchant_id_payout_id( &self, merchant_id: &id_type::MerchantId, - payout_id: &str, + payout_id: &id_type::PayoutId, storage_scheme: MerchantStorageScheme, ) -> CustomResult<storage::Payouts, errors::StorageError> { self.diesel_store @@ -2477,7 +2493,7 @@ impl PayoutsInterface for KafkaStore { async fn find_optional_payout_by_merchant_id_payout_id( &self, merchant_id: &id_type::MerchantId, - payout_id: &str, + payout_id: &id_type::PayoutId, storage_scheme: MerchantStorageScheme, ) -> CustomResult<Option<storage::Payouts>, errors::StorageError> { self.diesel_store @@ -2533,7 +2549,7 @@ impl PayoutsInterface for KafkaStore { async fn get_total_count_of_filtered_payouts( &self, merchant_id: &id_type::MerchantId, - active_payout_ids: &[String], + active_payout_ids: &[id_type::PayoutId], connector: Option<Vec<api_models::enums::PayoutConnectors>>, currency: Option<Vec<enums::Currency>>, status: Option<Vec<enums::PayoutStatus>>, @@ -2556,7 +2572,7 @@ impl PayoutsInterface for KafkaStore { &self, merchant_id: &id_type::MerchantId, constraints: &hyperswitch_domain_models::payouts::PayoutFetchConstraints, - ) -> CustomResult<Vec<String>, errors::StorageError> { + ) -> CustomResult<Vec<id_type::PayoutId>, errors::StorageError> { self.diesel_store .filter_active_payout_ids_by_constraints(merchant_id, constraints) .await diff --git a/crates/router/src/events/outgoing_webhook_logs.rs b/crates/router/src/events/outgoing_webhook_logs.rs index 7574332f778..43f2ae54be4 100644 --- a/crates/router/src/events/outgoing_webhook_logs.rs +++ b/crates/router/src/events/outgoing_webhook_logs.rs @@ -38,7 +38,7 @@ pub enum OutgoingWebhookEventContent { content: Value, }, Payout { - payout_id: String, + payout_id: common_utils::id_type::PayoutId, content: Value, }, #[cfg(feature = "v1")] diff --git a/crates/router/src/routes/payout_link.rs b/crates/router/src/routes/payout_link.rs index 0727890bb32..71e3439d337 100644 --- a/crates/router/src/routes/payout_link.rs +++ b/crates/router/src/routes/payout_link.rs @@ -15,7 +15,10 @@ use crate::{ pub async fn render_payout_link( state: web::Data<AppState>, req: actix_web::HttpRequest, - path: web::Path<(common_utils::id_type::MerchantId, String)>, + path: web::Path<( + common_utils::id_type::MerchantId, + common_utils::id_type::PayoutId, + )>, ) -> impl Responder { let flow = Flow::PayoutLinkInitiate; let (merchant_id, payout_id) = path.into_inner(); diff --git a/crates/router/src/routes/payouts.rs b/crates/router/src/routes/payouts.rs index be0aa027d70..5bccdd06668 100644 --- a/crates/router/src/routes/payouts.rs +++ b/crates/router/src/routes/payouts.rs @@ -2,6 +2,7 @@ use actix_web::{ body::{BoxBody, MessageBody}, web, HttpRequest, HttpResponse, Responder, }; +use common_utils::id_type; use router_env::{instrument, tracing, Flow}; use super::app::AppState; @@ -50,7 +51,7 @@ pub async fn payouts_create( pub async fn payouts_retrieve( state: web::Data<AppState>, req: HttpRequest, - path: web::Path<String>, + path: web::Path<id_type::PayoutId>, query_params: web::Query<payout_types::PayoutRetrieveBody>, ) -> HttpResponse { let payout_retrieve_request = payout_types::PayoutRetrieveRequest { @@ -90,7 +91,7 @@ pub async fn payouts_retrieve( pub async fn payouts_update( state: web::Data<AppState>, req: HttpRequest, - path: web::Path<String>, + path: web::Path<id_type::PayoutId>, json_payload: web::Json<payout_types::PayoutCreateRequest>, ) -> HttpResponse { let flow = Flow::PayoutsUpdate; @@ -122,12 +123,12 @@ pub async fn payouts_confirm( state: web::Data<AppState>, req: HttpRequest, json_payload: web::Json<payout_types::PayoutCreateRequest>, - path: web::Path<String>, + path: web::Path<id_type::PayoutId>, ) -> HttpResponse { let flow = Flow::PayoutsConfirm; let mut payload = json_payload.into_inner(); let payout_id = path.into_inner(); - tracing::Span::current().record("payout_id", &payout_id); + tracing::Span::current().record("payout_id", payout_id.get_string_repr()); payload.payout_id = Some(payout_id); payload.confirm = Some(true); let api_auth = auth::ApiKeyAuth::default(); @@ -160,12 +161,12 @@ pub async fn payouts_confirm( pub async fn payouts_cancel( state: web::Data<AppState>, req: HttpRequest, - json_payload: web::Json<payout_types::PayoutActionRequest>, - path: web::Path<String>, + path: web::Path<id_type::PayoutId>, ) -> HttpResponse { let flow = Flow::PayoutsCancel; - let mut payload = json_payload.into_inner(); - payload.payout_id = path.into_inner(); + let payload = payout_types::PayoutActionRequest { + payout_id: path.into_inner(), + }; Box::pin(api::server_wrap( flow, @@ -191,12 +192,12 @@ pub async fn payouts_cancel( pub async fn payouts_fulfill( state: web::Data<AppState>, req: HttpRequest, - json_payload: web::Json<payout_types::PayoutActionRequest>, - path: web::Path<String>, + path: web::Path<id_type::PayoutId>, ) -> HttpResponse { let flow = Flow::PayoutsFulfill; - let mut payload = json_payload.into_inner(); - payload.payout_id = path.into_inner(); + let payload = payout_types::PayoutActionRequest { + payout_id: path.into_inner(), + }; Box::pin(api::server_wrap( flow, diff --git a/crates/router/src/services/kafka/payout.rs b/crates/router/src/services/kafka/payout.rs index babf7c1c568..e27009b3989 100644 --- a/crates/router/src/services/kafka/payout.rs +++ b/crates/router/src/services/kafka/payout.rs @@ -5,7 +5,7 @@ use time::OffsetDateTime; #[derive(serde::Serialize, Debug)] pub struct KafkaPayout<'a> { - pub payout_id: &'a String, + pub payout_id: &'a id_type::PayoutId, pub payout_attempt_id: &'a String, pub merchant_id: &'a id_type::MerchantId, pub customer_id: Option<&'a id_type::CustomerId>, diff --git a/crates/router/src/utils.rs b/crates/router/src/utils.rs index f89dbbec70a..a733de87656 100644 --- a/crates/router/src/utils.rs +++ b/crates/router/src/utils.rs @@ -41,7 +41,6 @@ use nanoid::nanoid; use serde::de::DeserializeOwned; use serde_json::Value; use tracing_futures::Instrument; -use uuid::Uuid; pub use self::ext_traits::{OptionExt, ValidateCall}; use crate::{ @@ -115,11 +114,6 @@ pub fn generate_id(length: usize, prefix: &str) -> String { format!("{}_{}", prefix, nanoid!(length, &consts::ALPHABETS)) } -#[inline] -pub fn generate_uuid() -> String { - Uuid::new_v4().to_string() -} - pub trait ConnectorResponseExt: Sized { fn get_response(self) -> RouterResult<types::Response>; fn get_error_response(self) -> RouterResult<types::Response>; @@ -164,7 +158,7 @@ impl<E> ConnectorResponseExt } #[inline] -pub fn get_payout_attempt_id(payout_id: impl std::fmt::Display, attempt_count: i16) -> String { +pub fn get_payout_attempt_id(payout_id: &str, attempt_count: i16) -> String { format!("{payout_id}_{attempt_count}") } @@ -1356,7 +1350,7 @@ pub async fn trigger_payouts_webhook( business_profile, event_type, diesel_models::enums::EventClass::Payouts, - cloned_response.payout_id.clone(), + cloned_response.payout_id.get_string_repr().to_owned(), diesel_models::enums::EventObjectType::PayoutDetails, webhooks::OutgoingWebhookContent::PayoutDetails(Box::new(cloned_response)), primary_object_created_at, diff --git a/crates/router/src/workflows/outgoing_webhook_retry.rs b/crates/router/src/workflows/outgoing_webhook_retry.rs index 8a04094f31d..243c7382023 100644 --- a/crates/router/src/workflows/outgoing_webhook_retry.rs +++ b/crates/router/src/workflows/outgoing_webhook_retry.rs @@ -8,6 +8,7 @@ use api_models::{ use common_utils::{ consts::DEFAULT_LOCALE, ext_traits::{StringExt, ValueExt}, + id_type, }; use diesel_models::process_tracker::business_status; use error_stack::ResultExt; @@ -283,7 +284,7 @@ impl ProcessTrackerWorkflow<SessionState> for OutgoingWebhookRetryWorkflow { #[instrument(skip_all)] pub(crate) async fn get_webhook_delivery_retry_schedule_time( db: &dyn StorageInterface, - merchant_id: &common_utils::id_type::MerchantId, + merchant_id: &id_type::MerchantId, retry_count: i32, ) -> Option<time::PrimitiveDateTime> { let key = "pt_mapping_outgoing_webhooks"; @@ -329,7 +330,7 @@ pub(crate) async fn get_webhook_delivery_retry_schedule_time( #[instrument(skip_all)] pub(crate) async fn retry_webhook_delivery_task( db: &dyn StorageInterface, - merchant_id: &common_utils::id_type::MerchantId, + merchant_id: &id_type::MerchantId, process: storage::ProcessTracker, ) -> errors::CustomResult<(), errors::StorageError> { let schedule_time = @@ -385,15 +386,14 @@ async fn get_outgoing_webhook_content_and_event_type( match tracking_data.event_class { diesel_models::enums::EventClass::Payments => { let payment_id = tracking_data.primary_object_id.clone(); - let payment_id = - common_utils::id_type::PaymentId::try_from(std::borrow::Cow::Owned(payment_id)) - .map_err(|payment_id_parsing_error| { - logger::error!( - ?payment_id_parsing_error, - "Failed to parse payment ID from tracking data" - ); - errors::ProcessTrackerError::DeserializationFailed - })?; + let payment_id = id_type::PaymentId::try_from(std::borrow::Cow::Owned(payment_id)) + .map_err(|payment_id_parsing_error| { + logger::error!( + ?payment_id_parsing_error, + "Failed to parse payment ID from tracking data" + ); + errors::ProcessTrackerError::DeserializationFailed + })?; let request = PaymentsRetrieveRequest { resource_id: PaymentIdType::PaymentIntentId(payment_id), merchant_id: Some(tracking_data.merchant_id.clone()), @@ -539,7 +539,9 @@ async fn get_outgoing_webhook_content_and_event_type( diesel_models::enums::EventClass::Payouts => { let payout_id = tracking_data.primary_object_id.clone(); let request = payout_models::PayoutRequest::PayoutActionRequest( - payout_models::PayoutActionRequest { payout_id }, + payout_models::PayoutActionRequest { + payout_id: id_type::PayoutId::try_from(std::borrow::Cow::Owned(payout_id))?, + }, ); let payout_data = Box::pin(payouts::make_payout_data( diff --git a/crates/router/tests/connectors/utils.rs b/crates/router/tests/connectors/utils.rs index 4bc234cca24..bf9bc355334 100644 --- a/crates/router/tests/connectors/utils.rs +++ b/crates/router/tests/connectors/utils.rs @@ -1,11 +1,9 @@ use std::{fmt::Debug, marker::PhantomData, str::FromStr, sync::Arc, time::Duration}; use async_trait::async_trait; -use common_utils::pii::Email; +use common_utils::{id_type::GenerateId, pii::Email}; use error_stack::Report; use masking::Secret; -#[cfg(feature = "payouts")] -use router::core::utils as core_utils; use router::{ configs::settings::Settings, core::{errors::ConnectorError, payments}, @@ -454,8 +452,7 @@ pub trait ConnectorActions: Connector { ) -> RouterData<Flow, types::PayoutsData, Res> { self.generate_data( types::PayoutsData { - payout_id: core_utils::get_or_generate_uuid("payout_id", None) - .map_or("payout_3154763247".to_string(), |p| p), + payout_id: common_utils::id_type::PayoutId::generate(), amount: 1, minor_amount: MinorUnit::new(1), connector_payout_id, diff --git a/crates/storage_impl/src/lib.rs b/crates/storage_impl/src/lib.rs index 156ebee2dea..b2a2dba5779 100644 --- a/crates/storage_impl/src/lib.rs +++ b/crates/storage_impl/src/lib.rs @@ -427,7 +427,7 @@ impl UniqueConstraints for diesel_models::Payouts { vec![format!( "po_{}_{}", self.merchant_id.get_string_repr(), - self.payout_id + self.payout_id.get_string_repr() )] } fn table_name(&self) -> &str { diff --git a/crates/storage_impl/src/mock_db/payout_attempt.rs b/crates/storage_impl/src/mock_db/payout_attempt.rs index 1fd2058e95a..008e9f921b0 100644 --- a/crates/storage_impl/src/mock_db/payout_attempt.rs +++ b/crates/storage_impl/src/mock_db/payout_attempt.rs @@ -65,4 +65,13 @@ impl PayoutAttemptInterface for MockDb { > { Err(StorageError::MockDbError)? } + + async fn find_payout_attempt_by_merchant_id_merchant_order_reference_id( + &self, + _merchant_id: &common_utils::id_type::MerchantId, + _merchant_order_reference_id: &str, + _storage_scheme: storage_enums::MerchantStorageScheme, + ) -> CustomResult<PayoutAttempt, StorageError> { + Err(StorageError::MockDbError)? + } } diff --git a/crates/storage_impl/src/mock_db/payouts.rs b/crates/storage_impl/src/mock_db/payouts.rs index ecba8f88df6..648e09bd5c6 100644 --- a/crates/storage_impl/src/mock_db/payouts.rs +++ b/crates/storage_impl/src/mock_db/payouts.rs @@ -13,7 +13,7 @@ impl PayoutsInterface for MockDb { async fn find_payout_by_merchant_id_payout_id( &self, _merchant_id: &common_utils::id_type::MerchantId, - _payout_id: &str, + _payout_id: &common_utils::id_type::PayoutId, _storage_scheme: storage_enums::MerchantStorageScheme, ) -> CustomResult<Payouts, StorageError> { // TODO: Implement function for `MockDb` @@ -43,7 +43,7 @@ impl PayoutsInterface for MockDb { async fn find_optional_payout_by_merchant_id_payout_id( &self, _merchant_id: &common_utils::id_type::MerchantId, - _payout_id: &str, + _payout_id: &common_utils::id_type::PayoutId, _storage_scheme: storage_enums::MerchantStorageScheme, ) -> CustomResult<Option<Payouts>, StorageError> { // TODO: Implement function for `MockDb` @@ -95,7 +95,7 @@ impl PayoutsInterface for MockDb { async fn get_total_count_of_filtered_payouts( &self, _merchant_id: &common_utils::id_type::MerchantId, - _active_payout_ids: &[String], + _active_payout_ids: &[common_utils::id_type::PayoutId], _connector: Option<Vec<api_models::enums::PayoutConnectors>>, _currency: Option<Vec<storage_enums::Currency>>, _status: Option<Vec<storage_enums::PayoutStatus>>, @@ -110,7 +110,7 @@ impl PayoutsInterface for MockDb { &self, _merchant_id: &common_utils::id_type::MerchantId, _constraints: &hyperswitch_domain_models::payouts::PayoutFetchConstraints, - ) -> CustomResult<Vec<String>, StorageError> { + ) -> CustomResult<Vec<common_utils::id_type::PayoutId>, StorageError> { // TODO: Implement function for `MockDb` Err(StorageError::MockDbError)? } diff --git a/crates/storage_impl/src/payouts/payout_attempt.rs b/crates/storage_impl/src/payouts/payout_attempt.rs index e1706fad124..35939c11323 100644 --- a/crates/storage_impl/src/payouts/payout_attempt.rs +++ b/crates/storage_impl/src/payouts/payout_attempt.rs @@ -60,7 +60,7 @@ impl<T: DatabaseStore> PayoutAttemptInterface for KVRouterStore<T> { let payout_attempt_id = new_payout_attempt.payout_id.clone(); let key = PartitionKey::MerchantIdPayoutAttemptId { merchant_id: &merchant_id, - payout_attempt_id: &payout_attempt_id, + payout_attempt_id: payout_attempt_id.get_string_repr(), }; let key_str = key.to_string(); let created_attempt = PayoutAttempt { @@ -88,6 +88,9 @@ impl<T: DatabaseStore> PayoutAttemptInterface for KVRouterStore<T> { routing_info: new_payout_attempt.routing_info.clone(), unified_code: new_payout_attempt.unified_code.clone(), unified_message: new_payout_attempt.unified_message.clone(), + merchant_order_reference_id: new_payout_attempt + .merchant_order_reference_id + .clone(), }; let redis_entry = kv::TypedSql { @@ -149,7 +152,7 @@ impl<T: DatabaseStore> PayoutAttemptInterface for KVRouterStore<T> { ) -> error_stack::Result<PayoutAttempt, errors::StorageError> { let key = PartitionKey::MerchantIdPayoutAttemptId { merchant_id: &this.merchant_id, - payout_attempt_id: &this.payout_id, + payout_attempt_id: this.payout_id.get_string_repr(), }; let field = format!("poa_{}", this.payout_attempt_id); let storage_scheme = Box::pin(decide_storage_scheme::<_, DieselPayoutAttempt>( @@ -378,6 +381,22 @@ impl<T: DatabaseStore> PayoutAttemptInterface for KVRouterStore<T> { .get_filters_for_payouts(payouts, merchant_id, storage_scheme) .await } + + #[instrument(skip_all)] + async fn find_payout_attempt_by_merchant_id_merchant_order_reference_id( + &self, + merchant_id: &common_utils::id_type::MerchantId, + merchant_order_reference_id: &str, + storage_scheme: MerchantStorageScheme, + ) -> error_stack::Result<PayoutAttempt, errors::StorageError> { + self.router_store + .find_payout_attempt_by_merchant_id_merchant_order_reference_id( + merchant_id, + merchant_order_reference_id, + storage_scheme, + ) + .await + } } #[async_trait::async_trait] @@ -504,6 +523,27 @@ impl<T: DatabaseStore> PayoutAttemptInterface for crate::RouterStore<T> { }, ) } + + #[instrument(skip_all)] + async fn find_payout_attempt_by_merchant_id_merchant_order_reference_id( + &self, + merchant_id: &common_utils::id_type::MerchantId, + merchant_order_reference_id: &str, + _storage_scheme: MerchantStorageScheme, + ) -> error_stack::Result<PayoutAttempt, errors::StorageError> { + let conn = pg_connection_read(self).await?; + DieselPayoutAttempt::find_by_merchant_id_merchant_order_reference_id( + &conn, + merchant_id, + merchant_order_reference_id, + ) + .await + .map(PayoutAttempt::from_storage_model) + .map_err(|er| { + let new_err = diesel_error_to_data_error(*er.current_context()); + er.change_context(new_err) + }) + } } impl DataModelExt for PayoutAttempt { @@ -533,6 +573,7 @@ impl DataModelExt for PayoutAttempt { unified_code: self.unified_code, unified_message: self.unified_message, additional_payout_method_data: self.additional_payout_method_data, + merchant_order_reference_id: self.merchant_order_reference_id, } } @@ -560,6 +601,7 @@ impl DataModelExt for PayoutAttempt { unified_code: storage_model.unified_code, unified_message: storage_model.unified_message, additional_payout_method_data: storage_model.additional_payout_method_data, + merchant_order_reference_id: storage_model.merchant_order_reference_id, } } } @@ -590,6 +632,7 @@ impl DataModelExt for PayoutAttemptNew { unified_code: self.unified_code, unified_message: self.unified_message, additional_payout_method_data: self.additional_payout_method_data, + merchant_order_reference_id: self.merchant_order_reference_id, } } @@ -617,6 +660,7 @@ impl DataModelExt for PayoutAttemptNew { unified_code: storage_model.unified_code, unified_message: storage_model.unified_message, additional_payout_method_data: storage_model.additional_payout_method_data, + merchant_order_reference_id: storage_model.merchant_order_reference_id, } } } diff --git a/crates/storage_impl/src/payouts/payouts.rs b/crates/storage_impl/src/payouts/payouts.rs index 484328aabab..c9d16b7d8a2 100644 --- a/crates/storage_impl/src/payouts/payouts.rs +++ b/crates/storage_impl/src/payouts/payouts.rs @@ -80,7 +80,7 @@ impl<T: DatabaseStore> PayoutsInterface for KVRouterStore<T> { payout_id: &payout_id, }; let key_str = key.to_string(); - let field = format!("po_{}", new.payout_id); + let field = format!("po_{}", new.payout_id.get_string_repr()); let created_payout = Payouts { payout_id: new.payout_id.clone(), merchant_id: new.merchant_id.clone(), @@ -151,7 +151,7 @@ impl<T: DatabaseStore> PayoutsInterface for KVRouterStore<T> { merchant_id: &this.merchant_id, payout_id: &this.payout_id, }; - let field = format!("po_{}", this.payout_id); + let field = format!("po_{}", this.payout_id.get_string_repr()); let storage_scheme = Box::pin(decide_storage_scheme::<_, DieselPayouts>( self, storage_scheme, @@ -207,7 +207,7 @@ impl<T: DatabaseStore> PayoutsInterface for KVRouterStore<T> { async fn find_payout_by_merchant_id_payout_id( &self, merchant_id: &common_utils::id_type::MerchantId, - payout_id: &str, + payout_id: &common_utils::id_type::PayoutId, storage_scheme: MerchantStorageScheme, ) -> error_stack::Result<Payouts, StorageError> { let database_call = || async { @@ -232,7 +232,7 @@ impl<T: DatabaseStore> PayoutsInterface for KVRouterStore<T> { merchant_id, payout_id, }; - let field = format!("po_{payout_id}"); + let field = format!("po_{}", payout_id.get_string_repr()); Box::pin(utils::try_redis_get_else_try_database_get( async { Box::pin(kv_wrapper::<DieselPayouts, _, _>( @@ -255,7 +255,7 @@ impl<T: DatabaseStore> PayoutsInterface for KVRouterStore<T> { async fn find_optional_payout_by_merchant_id_payout_id( &self, merchant_id: &common_utils::id_type::MerchantId, - payout_id: &str, + payout_id: &common_utils::id_type::PayoutId, storage_scheme: MerchantStorageScheme, ) -> error_stack::Result<Option<Payouts>, StorageError> { let database_call = || async { @@ -276,20 +276,14 @@ impl<T: DatabaseStore> PayoutsInterface for KVRouterStore<T> { match storage_scheme { MerchantStorageScheme::PostgresOnly => { let maybe_payouts = database_call().await?; - Ok(maybe_payouts.and_then(|payout| { - if payout.payout_id == payout_id { - Some(payout) - } else { - None - } - })) + Ok(maybe_payouts.filter(|payout| &payout.payout_id == payout_id)) } MerchantStorageScheme::RedisKv => { let key = PartitionKey::MerchantIdPayoutId { merchant_id, payout_id, }; - let field = format!("po_{payout_id}"); + let field = format!("po_{}", payout_id.get_string_repr()); Box::pin(utils::try_redis_get_else_try_database_get( async { Box::pin(kv_wrapper::<DieselPayouts, _, _>( @@ -360,7 +354,7 @@ impl<T: DatabaseStore> PayoutsInterface for KVRouterStore<T> { async fn get_total_count_of_filtered_payouts( &self, merchant_id: &common_utils::id_type::MerchantId, - active_payout_ids: &[String], + active_payout_ids: &[common_utils::id_type::PayoutId], connector: Option<Vec<PayoutConnectors>>, currency: Option<Vec<storage_enums::Currency>>, status: Option<Vec<storage_enums::PayoutStatus>>, @@ -383,7 +377,7 @@ impl<T: DatabaseStore> PayoutsInterface for KVRouterStore<T> { &self, merchant_id: &common_utils::id_type::MerchantId, constraints: &PayoutFetchConstraints, - ) -> error_stack::Result<Vec<String>, StorageError> { + ) -> error_stack::Result<Vec<common_utils::id_type::PayoutId>, StorageError> { self.router_store .filter_active_payout_ids_by_constraints(merchant_id, constraints) .await @@ -434,7 +428,7 @@ impl<T: DatabaseStore> PayoutsInterface for crate::RouterStore<T> { async fn find_payout_by_merchant_id_payout_id( &self, merchant_id: &common_utils::id_type::MerchantId, - payout_id: &str, + payout_id: &common_utils::id_type::PayoutId, _storage_scheme: MerchantStorageScheme, ) -> error_stack::Result<Payouts, StorageError> { let conn = pg_connection_read(self).await?; @@ -451,7 +445,7 @@ impl<T: DatabaseStore> PayoutsInterface for crate::RouterStore<T> { async fn find_optional_payout_by_merchant_id_payout_id( &self, merchant_id: &common_utils::id_type::MerchantId, - payout_id: &str, + payout_id: &common_utils::id_type::PayoutId, _storage_scheme: MerchantStorageScheme, ) -> error_stack::Result<Option<Payouts>, StorageError> { let conn = pg_connection_read(self).await?; @@ -498,7 +492,7 @@ impl<T: DatabaseStore> PayoutsInterface for crate::RouterStore<T> { query = query.filter(po_dsl::profile_id.eq(profile_id.clone())); } - query = match (params.starting_at, &params.starting_after_id) { + query = match (params.starting_at, params.starting_after_id.as_ref()) { (Some(starting_at), _) => query.filter(po_dsl::created_at.ge(starting_at)), (None, Some(starting_after_id)) => { // TODO: Fetch partial columns for this query since we only need some columns @@ -515,7 +509,7 @@ impl<T: DatabaseStore> PayoutsInterface for crate::RouterStore<T> { (None, None) => query, }; - query = match (params.ending_at, &params.ending_before_id) { + query = match (params.ending_at, params.ending_before_id.as_ref()) { (Some(ending_at), _) => query.filter(po_dsl::created_at.le(ending_at)), (None, Some(ending_before_id)) => { // TODO: Fetch partial columns for this query since we only need some columns @@ -619,10 +613,18 @@ impl<T: DatabaseStore> PayoutsInterface for crate::RouterStore<T> { query = query.filter(po_dsl::profile_id.eq(profile_id.clone())); } - query = match (params.starting_at, &params.starting_after_id) { + if let Some(merchant_order_reference_id_filter) = + &params.merchant_order_reference_id + { + query = query.filter( + poa_dsl::merchant_order_reference_id + .eq(merchant_order_reference_id_filter.clone()), + ); + } + + query = match (params.starting_at, params.starting_after_id.as_ref()) { (Some(starting_at), _) => query.filter(po_dsl::created_at.ge(starting_at)), (None, Some(starting_after_id)) => { - // TODO: Fetch partial columns for this query since we only need some columns let starting_at = self .find_payout_by_merchant_id_payout_id( merchant_id, @@ -636,10 +638,9 @@ impl<T: DatabaseStore> PayoutsInterface for crate::RouterStore<T> { (None, None) => query, }; - query = match (params.ending_at, &params.ending_before_id) { + query = match (params.ending_at, params.ending_before_id.as_ref()) { (Some(ending_at), _) => query.filter(po_dsl::created_at.le(ending_at)), (None, Some(ending_before_id)) => { - // TODO: Fetch partial columns for this query since we only need some columns let ending_at = self .find_payout_by_merchant_id_payout_id( merchant_id, @@ -665,20 +666,24 @@ impl<T: DatabaseStore> PayoutsInterface for crate::RouterStore<T> { .map(|c| c.iter().map(|c| c.to_string()).collect::<Vec<String>>()); query = match connectors { - Some(connectors) => query.filter(poa_dsl::connector.eq_any(connectors)), - None => query, + Some(conn_filters) if !conn_filters.is_empty() => { + query.filter(poa_dsl::connector.eq_any(conn_filters)) + } + _ => query, }; query = match &params.status { - Some(status) => query.filter(po_dsl::status.eq_any(status.clone())), - None => query, + Some(status_filters) if !status_filters.is_empty() => { + query.filter(po_dsl::status.eq_any(status_filters.clone())) + } + _ => query, }; query = match &params.payout_method { - Some(payout_method) => { + Some(payout_method) if !payout_method.is_empty() => { query.filter(po_dsl::payout_type.eq_any(payout_method.clone())) } - None => query, + _ => query, }; query @@ -760,7 +765,7 @@ impl<T: DatabaseStore> PayoutsInterface for crate::RouterStore<T> { async fn get_total_count_of_filtered_payouts( &self, merchant_id: &common_utils::id_type::MerchantId, - active_payout_ids: &[String], + active_payout_ids: &[common_utils::id_type::PayoutId], connector: Option<Vec<PayoutConnectors>>, currency: Option<Vec<storage_enums::Currency>>, status: Option<Vec<storage_enums::PayoutStatus>>, @@ -800,7 +805,7 @@ impl<T: DatabaseStore> PayoutsInterface for crate::RouterStore<T> { &self, merchant_id: &common_utils::id_type::MerchantId, constraints: &PayoutFetchConstraints, - ) -> error_stack::Result<Vec<String>, StorageError> { + ) -> error_stack::Result<Vec<common_utils::id_type::PayoutId>, StorageError> { let conn = connection::pg_connection_read(self).await?; let conn = async_bb8_diesel::Connection::as_async_conn(&conn); let mut query = DieselPayouts::table() @@ -868,8 +873,14 @@ impl<T: DatabaseStore> PayoutsInterface for crate::RouterStore<T> { error_stack::report!(diesel_models::errors::DatabaseError::from(er)) .attach_printable("Error filtering payout records"), ) - .into() + })? + .into_iter() + .map(|s| { + common_utils::id_type::PayoutId::try_from(std::borrow::Cow::Owned(s)) + .change_context(StorageError::DeserializationFailed) + .attach_printable("Failed to deserialize PayoutId from database string") }) + .collect::<error_stack::Result<Vec<_>, _>>() } #[cfg(all(feature = "olap", feature = "v2"))] @@ -878,7 +889,7 @@ impl<T: DatabaseStore> PayoutsInterface for crate::RouterStore<T> { &self, _merchant_id: &common_utils::id_type::MerchantId, _constraints: &PayoutFetchConstraints, - ) -> error_stack::Result<Vec<String>, StorageError> { + ) -> error_stack::Result<Vec<common_utils::id_type::PayoutId>, StorageError> { todo!() } } diff --git a/crates/storage_impl/src/redis/kv_store.rs b/crates/storage_impl/src/redis/kv_store.rs index fd583f500ed..e7c47c58996 100644 --- a/crates/storage_impl/src/redis/kv_store.rs +++ b/crates/storage_impl/src/redis/kv_store.rs @@ -41,7 +41,7 @@ pub enum PartitionKey<'a> { }, MerchantIdPayoutId { merchant_id: &'a common_utils::id_type::MerchantId, - payout_id: &'a str, + payout_id: &'a common_utils::id_type::PayoutId, }, MerchantIdPayoutAttemptId { merchant_id: &'a common_utils::id_type::MerchantId, @@ -93,8 +93,9 @@ impl std::fmt::Display for PartitionKey<'_> { merchant_id, payout_id, } => f.write_str(&format!( - "mid_{}_po_{payout_id}", - merchant_id.get_string_repr() + "mid_{}_po_{}", + merchant_id.get_string_repr(), + payout_id.get_string_repr() )), PartitionKey::MerchantIdPayoutAttemptId { merchant_id, diff --git a/flake.nix b/flake.nix index 35fa05b73a7..05058a75d9e 100644 --- a/flake.nix +++ b/flake.nix @@ -43,6 +43,7 @@ devPackages = base ++ (with pkgs; [ cargo-watch nixd + protobuf rust-bin.stable.${rustDevVersion}.default swagger-cli ]); diff --git a/migrations/2025-06-19-170656_alter_payout_primary_key/down.sql b/migrations/2025-06-19-170656_alter_payout_primary_key/down.sql new file mode 100644 index 00000000000..e8ff6e1c5a1 --- /dev/null +++ b/migrations/2025-06-19-170656_alter_payout_primary_key/down.sql @@ -0,0 +1,7 @@ +ALTER TABLE payout_attempt DROP COLUMN merchant_order_reference_id; + +ALTER TABLE payout_attempt DROP CONSTRAINT payout_attempt_pkey; +ALTER TABLE payout_attempt ADD PRIMARY KEY (payout_attempt_id); + +ALTER TABLE payouts DROP CONSTRAINT payouts_pkey; +ALTER TABLE payouts ADD PRIMARY KEY (payout_id); diff --git a/migrations/2025-06-19-170656_alter_payout_primary_key/up.sql b/migrations/2025-06-19-170656_alter_payout_primary_key/up.sql new file mode 100644 index 00000000000..d65c931719f --- /dev/null +++ b/migrations/2025-06-19-170656_alter_payout_primary_key/up.sql @@ -0,0 +1,7 @@ +ALTER TABLE payout_attempt DROP CONSTRAINT payout_attempt_pkey; +ALTER TABLE payout_attempt ADD PRIMARY KEY (merchant_id, payout_attempt_id); + +ALTER TABLE payouts DROP CONSTRAINT payouts_pkey; +ALTER TABLE payouts ADD PRIMARY KEY (merchant_id, payout_id); + +ALTER TABLE payout_attempt ADD COLUMN merchant_order_reference_id VARCHAR(255) NULL;

2025-06-20T04:35:56Z

feat(payouts): allow payout_id to be configurable in API request feat(payouts): add merchant_order_reference_id for referencing payouts ## Type of Change  - [ ] Bugfix - [x] New feature - [ ] Enhancement - [x] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description This pull request introduces two main features for payouts: 1. **Configurable `payout_id` in API Requests**: * The `payout_id` field in payout creation API requests can now be optionally provided by the merchant. If provided, this ID will be used for the payout. If not provided, the system will generate one. * Internally, the usage of `payout_id` has been standardized to use the strongly-typed `common_utils::id_type::PayoutId` instead of `String`. This change has been propagated throughout relevant structs and functionalities like `PayoutsData`, data handling logic in `crates/router/src/core/utils.rs`, test utilities and DB queries. 2. **`merchant_order_reference_id` for Payout Referencing**: * The `merchant_order_reference_id` field has been added/updated in payout API models (e.g., `PayoutListFilterConstraints` in `crates/api_models/src/payouts.rs`). This allows merchants to use their own unique identifier to reference payouts. **Refactoring and Connector Updates**: * To support the `id_type::PayoutId` change and ensure correct data flow, connector integrations (Adyen, Adyenplatform, Cybersource, Nomupay) have been refactored. * Connectors now consistently use `RouterData.connector_request_reference_id` (which typically holds the `payout_attempt_id` as a `String`) when a string-based reference is required by the external service, rather than converting the internal `PayoutsData.payout_id`. This ensures that connectors receive the appropriate string identifier (e.g., `payout_attempt_id`) they expect. ### Additional Changes - [x] This PR modifies the API contract. - [x] This PR modifies the database schema. - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context These changes address the need for greater flexibility and type safety in payout processing, as outlined in GitHub issues #8392 and #1321. * **Configurable `payout_id`**: Allows merchants more control over their payout identifiers within the Hyperswitch. * **`merchant_order_reference_id`**: Provides a dedicated field for merchants to use their internal order or reference IDs. * **`PayoutId` Type Standardization**: Using `common_utils::id_type::PayoutId` enhances code robustness and maintainability by leveraging Rust's type system to prevent errors related to ID handling. * **Connector Refactoring**: Ensures that connectors use the correct string-based identifiers (like `payout_attempt_id` via `connector_request_reference_id`) required by external payout processors, maintaining correctness of integrations. Links to issues: * https://github.com/juspay/hyperswitch/issues/8392 * https://github.com/juspay/hyperswitch/issues/1321 ## How did you test it? <details> <summary>1. Card payouts via API</summary> cURL curl --location --request POST 'http://localhost:8080/payouts/create' \ --header 'Content-Type: application/json' \ --header 'api-key: dev_lAISInmiO4UNrMmvkJogzRVKEGKlBKQbRCBFOkLJTXmq6nsD5G1H65BjOd4H72H8' \ --data '{"amount":100,"currency":"EUR","profile_id":"pro_vVSlzCG7M1GSX9SyssY8","customer_id":"cus_WULwykbL8laUbxDUeGEB","connector":["adyenplatform"],"description":"Its my first payout request","payout_type":"card","payout_method_data":{"card":{"card_number":"4111111111111111","expiry_month":"03","expiry_year":"2030"}},"billing":{"address":{"line1":"1467","line2":"Harrison Street","line3":"Harrison Street","city":"San Fransico","state":"CA","zip":"94122","country":"FR","first_name":"John","last_name":"Doe"}},"entity_type":"Individual","recurring":true,"metadata":{"ref":"123"},"confirm":true,"auto_fulfill":true}' Response {"payout_id":"ff21b89d-3cfd-4f0f-b3ff-c468d90d7074","merchant_id":"merchant_1751292662","amount":100,"currency":"EUR","connector":"adyenplatform","payout_type":"card","payout_method_data":{"card":{"card_issuer":null,"card_network":null,"card_type":null,"card_issuing_country":null,"bank_code":null,"last4":"1111","card_isin":"411111","card_extended_bin":null,"card_exp_month":"03","card_exp_year":"2030","card_holder_name":null}},"billing":{"address":{"city":"San Fransico","country":"FR","line1":"1467","line2":"Harrison Street","line3":"Harrison Street","zip":"94122","state":"CA","first_name":"John","last_name":"Doe"},"phone":null,"email":null},"auto_fulfill":true,"customer_id":"cus_WULwykbL8laUbxDUeGEB","customer":{"id":"cus_WULwykbL8laUbxDUeGEB","name":"John Nether","email":null,"phone":"6168205362","phone_country_code":"+1"},"client_secret":"payout_ff21b89d-3cfd-4f0f-b3ff-c468d90d7074_secret_qzFALtOg6ZhYAOAUr2qY","return_url":null,"business_country":null,"business_label":null,"description":"Its my first payout request","entity_type":"Individual","recurring":true,"metadata":{"ref":"123"},"merchant_connector_id":"mca_SfssFvg5RBT2k7iKRRsS","status":"initiated","error_message":null,"error_code":null,"profile_id":"pro_vVSlzCG7M1GSX9SyssY8","created":"2025-06-30T14:12:47.886Z","connector_transaction_id":"38EBIX67HBSYZ30V","priority":null,"payout_link":null,"email":null,"name":"John Nether","phone":"6168205362","phone_country_code":"+1","unified_code":null,"unified_message":null,"payout_method_id":"pm_wScFhCfxELZ7gN13Nbxz"} </details> <details> <summary>2. Card payouts via Payout Links</summary> cURL curl --location --request POST 'http://localhost:8080/payouts/create' \ --header 'Content-Type: application/json' \ --header 'api-key: dev_lAISInmiO4UNrMmvkJogzRVKEGKlBKQbRCBFOkLJTXmq6nsD5G1H65BjOd4H72H8' \ --data '{"amount":1,"currency":"EUR","customer_id":"cus_WULwykbL8laUbxDUeGEB","description":"Its my first payout request","entity_type":"Individual","confirm":false,"auto_fulfill":true,"session_expiry":1000000,"profile_id":"pro_vVSlzCG7M1GSX9SyssY8","payout_link":true,"return_url":"https://www.google.com","payout_link_config":{"form_layout":"journey","theme":"#0066ff","logo":"https://hyperswitch.io/favicon.ico","merchant_name":"HyperSwitch Inc.","test_mode":true}}' Response {"payout_id":"2371746b-df3d-41da-8fa2-455faf921ea9","merchant_id":"merchant_1751292662","amount":1,"currency":"EUR","connector":null,"payout_type":null,"payout_method_data":null,"billing":null,"auto_fulfill":true,"customer_id":"cus_WULwykbL8laUbxDUeGEB","customer":{"id":"cus_WULwykbL8laUbxDUeGEB","name":"John Nether","email":null,"phone":"6168205362","phone_country_code":"+1"},"client_secret":"payout_2371746b-df3d-41da-8fa2-455faf921ea9_secret_VwDeIScMTLFzG7Iz1DZU","return_url":"https://www.google.com","business_country":null,"business_label":null,"description":"Its my first payout request","entity_type":"Individual","recurring":false,"metadata":{},"merchant_connector_id":null,"status":"requires_payout_method_data","error_message":null,"error_code":null,"profile_id":"pro_vVSlzCG7M1GSX9SyssY8","created":"2025-06-30T14:14:48.897Z","connector_transaction_id":null,"priority":null,"payout_link":{"payout_link_id":"payout_link_vITmtOWGkaUfeXopruRs","link":"http://localhost:8080/payout_link/merchant_1751292662/2371746b-df3d-41da-8fa2-455faf921ea9?locale=en"},"email":null,"name":"John Nether","phone":"6168205362","phone_country_code":"+1","unified_code":null,"unified_message":null,"payout_method_id":null} <img width="1719" alt="Screenshot 2025-06-30 at 7 45 32 PM" src="https://github.com/user-attachments/assets/e1ace815-74b5-411a-83be-badb2c04bf7d" /> <img width="1721" alt="Screenshot 2025-06-30 at 7 45 48 PM" src="https://github.com/user-attachments/assets/a8233053-9c1e-402d-87af-e59783fefc9d" /> <img width="913" alt="Screenshot 2025-06-30 at 7 45 54 PM" src="https://github.com/user-attachments/assets/586d1aa9-0116-46f3-b597-91b1f46ba5d2" /> </details> ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.114.0

0c649158a8ee491e2ff6ff37e922266d5b64b22d

juspay/hyperswitch

juspay__hyperswitch-8386

Bug: Api contract changes to accept `saving_percentage` in the decision engine response Api contract changes to accept `saving_percentage` in the decision engine response

diff --git a/crates/api_models/src/open_router.rs b/crates/api_models/src/open_router.rs index af91ece3f12..5d5f8f016c0 100644 --- a/crates/api_models/src/open_router.rs +++ b/crates/api_models/src/open_router.rs @@ -67,17 +67,32 @@ pub struct DecidedGateway { #[derive(Debug, Serialize, Deserialize, PartialEq, Clone)] pub struct DebitRoutingOutput { - pub co_badged_card_networks: Vec<common_enums::CardNetwork>, + pub co_badged_card_networks_info: Vec<CoBadgedCardNetworksInfo>, pub issuer_country: common_enums::CountryAlpha2, pub is_regulated: bool, pub regulated_name: Option<common_enums::RegulatedName>, pub card_type: common_enums::CardType, } +#[derive(Debug, Serialize, Deserialize, PartialEq, Clone)] +pub struct CoBadgedCardNetworksInfo { + pub network: common_enums::CardNetwork, + pub saving_percentage: f64, +} + +impl DebitRoutingOutput { + pub fn get_co_badged_card_networks(&self) -> Vec<common_enums::CardNetwork> { + self.co_badged_card_networks_info + .iter() + .map(|data| data.network.clone()) + .collect() + } +} + impl From<&DebitRoutingOutput> for payment_methods::CoBadgedCardData { fn from(output: &DebitRoutingOutput) -> Self { Self { - co_badged_card_networks: output.co_badged_card_networks.clone(), + co_badged_card_networks: output.get_co_badged_card_networks(), issuer_country_code: output.issuer_country, is_regulated: output.is_regulated, regulated_name: output.regulated_name.clone(), @@ -96,7 +111,7 @@ impl TryFrom<(payment_methods::CoBadgedCardData, String)> for DebitRoutingReques })?; Ok(Self { - co_badged_card_networks: output.co_badged_card_networks, + co_badged_card_networks_info: output.co_badged_card_networks, issuer_country: output.issuer_country_code, is_regulated: output.is_regulated, regulated_name: output.regulated_name, @@ -114,7 +129,7 @@ pub struct CoBadgedCardRequest { #[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] pub struct DebitRoutingRequestData { - pub co_badged_card_networks: Vec<common_enums::CardNetwork>, + pub co_badged_card_networks_info: Vec<common_enums::CardNetwork>, pub issuer_country: common_enums::CountryAlpha2, pub is_regulated: bool, pub regulated_name: Option<common_enums::RegulatedName>, diff --git a/crates/router/src/core/debit_routing.rs b/crates/router/src/core/debit_routing.rs index c7de440bbf6..ca03f5d2532 100644 --- a/crates/router/src/core/debit_routing.rs +++ b/crates/router/src/core/debit_routing.rs @@ -256,8 +256,8 @@ where get_debit_routing_output::<F, D>(state, payment_data, acquirer_country).await?; logger::debug!( - "Sorted co-badged networks: {:?}", - debit_routing_output.co_badged_card_networks + "Sorted co-badged networks info: {:?}", + debit_routing_output.co_badged_card_networks_info ); let key_store = db @@ -281,7 +281,7 @@ where &profile_id, &key_store, vec![connector_data.clone()], - debit_routing_output.co_badged_card_networks.clone(), + debit_routing_output.get_co_badged_card_networks(), ) .await .map_err(|error| { @@ -455,7 +455,7 @@ where &profile_id, &key_store, connector_data_list.clone(), - debit_routing_output.co_badged_card_networks.clone(), + debit_routing_output.get_co_badged_card_networks(), ) .await .map_err(|error| {

2025-06-19T08:01:15Z

- [ ] Bugfix - [ ] New feature - [ ] Enhancement - [x] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  This pull request refactors the `DebitRoutingOutput` structure to introduce a new `CoBadgedCardNetworksInfo` type, enhancing the representation of co-badged card networks by including additional metadata such as saving percentages. It also updates related methods and structures to align with this change. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  ## How did you test it?  -> Enable debit routing for a profile and configure adyen connector -> Make a payment ``` curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'x-feature: router-custom' \ --header 'x-tenant-id: hyperswitch' \ --header 'api-key: ' \ --data-raw '{ "amount": 10000, "amount_to_capture": 10000, "currency": "USD", "confirm": true, "capture_method": "automatic", "setup_future_usage": "on_session", "capture_on": "2022-09-10T10:11:12Z", "email": "[email protected]", "name": "John Doe", "phone": "999999999", "phone_country_code": "+1", "description": "Its my first payment request", "authentication_type": "no_three_ds", "customer_id": "cu_1750319776", "return_url": "http://127.0.0.1:4040", "payment_method": "card", "payment_method_type": "debit", "payment_method_data": { "card": { "card_number": "4400 0020 0000 0004", "card_exp_month": "03", "card_exp_year": "2030", "card_holder_name": "joseph Doe", "card_cvc": "737" } }, "billing": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San", "state": "California", "zip": "94122", "country": "US", "first_name": "PiX", "last_name": "ss" }, "email": "[email protected]" }, "shipping": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "PiX" } }, "customer_acceptance": { "acceptance_type": "offline", "accepted_at": "1963-05-03T04:07:52.723Z", "online": { "ip_address": "in sit", "user_agent": "amet irure esse" } }, "browser_info": { "user_agent": "Mozilla\/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/70.0.3538.110 Safari\/537.36", "accept_header": "text\/html,application\/xhtml+xml,application\/xml;q=0.9,image\/webp,image\/apng,*\/*;q=0.8", "language": "nl-NL", "color_depth": 24, "screen_height": 723, "screen_width": 1536, "time_zone": 0, "java_enabled": true, "java_script_enabled": true, "ip_address": "125.0.0.1" }, "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "metadata": { "udf1": "value1", "new_customer": "true", "login_date": "2019-09-10T10:11:12Z" } }' ``` ``` { "payment_id": "pay_7aTZkTRH72iemhbxOqvc", "merchant_id": "merchant_1750232289", "status": "succeeded", "amount": 10000, "net_amount": 10000, "shipping_cost": null, "amount_capturable": 0, "amount_received": 10000, "connector": "adyen", "client_secret": "pay_7aTZkTRH72iemhbxOqvc_secret_2v6ATAqLFQsKVhms16hF", "created": "2025-06-18T07:40:06.149Z", "currency": "USD", "customer_id": "cu_1750232406", "customer": { "id": "cu_1750232406", "name": "John Doe", "email": "[email protected]", "phone": "999999999", "phone_country_code": "+1" }, "description": "Its my first payment request", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": "on_session", "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "card", "payment_method_data": { "card": { "last4": "0004", "card_type": null, "card_network": "Accel", "card_issuer": null, "card_issuing_country": null, "card_isin": "440000", "card_extended_bin": null, "card_exp_month": "03", "card_exp_year": "2030", "card_holder_name": "joseph Doe", "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "PiX", "last_name": null }, "phone": null, "email": null }, "billing": { "address": { "city": "San", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "PiX", "last_name": "ss" }, "phone": null, "email": "[email protected]" }, "order_details": null, "email": "[email protected]", "name": "John Doe", "phone": "999999999", "return_url": "http://127.0.0.1:4040/", "authentication_type": "no_three_ds", "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "debit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": { "customer_id": "cu_1750232406", "created_at": 1750232406, "expires": 1750236006, "secret": "epk_1a8a73a55db941eb89b3c5a54b42bc3d" }, "manual_retry_allowed": false, "connector_transaction_id": "JKCHRB6V9DDHL975", "frm_message": null, "metadata": { "udf1": "value1", "login_date": "2019-09-10T10:11:12Z", "new_customer": "true" }, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_7aTZkTRH72iemhbxOqvc_1", "payment_link": null, "profile_id": "pro_n23wrYOtUyaiFMM71SEq", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_xC22XUKnNCBkg5vHm1W0", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-06-18T07:55:06.149Z", "fingerprint": null, "browser_info": { "language": "nl-NL", "time_zone": 0, "ip_address": "125.0.0.1", "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "color_depth": 24, "java_enabled": true, "screen_width": 1536, "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8", "screen_height": 723, "java_script_enabled": true }, "payment_method_id": null, "payment_method_status": null, "updated": "2025-06-18T07:40:07.133Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` Once the payment is done the api events should have the `saving_percentage` in the decision engine response ``` { "decided_gateway": "ADYEN", "gateway_priority_map": null, "filter_wise_gateways": null, "priority_logic_tag": null, "routing_approach": "NONE", "gateway_before_evaluation": null, "priority_logic_output": null, "debit_routing_output": { "co_badged_card_networks_info": [ { "network": "ACCEL", "saving_percentage": 0.14 }, { "network": "STAR", "saving_percentage": 0.04 }, { "network": "VISA", "saving_percentage": 0.0 } ], "issuer_country": "US", "is_regulated": true, "regulated_name": "GOVERNMENT EXEMPT INTERCHANGE FEE", "card_type": "debit" }, "reset_approach": "NO_RESET", "routing_dimension": null, "routing_dimension_level": null, "is_scheduled_outage": false, "is_dynamic_mga_enabled": false, "gateway_mga_id_map": null } ``` ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.114.0

305ca9bda9d3c5bf3cc97458b7ed07b79e894154

juspay/hyperswitch

juspay__hyperswitch-8492

Bug: [FIX] Fix routing approach update in wallet flow ### Feature Description Fix routing approach update in wallet flow ### Possible Implementation Fix routing approach update in wallet flow ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? Yes, I am willing to submit a PR!

diff --git a/crates/common_enums/src/enums.rs b/crates/common_enums/src/enums.rs index 29cf75ac504..1d00a451708 100644 --- a/crates/common_enums/src/enums.rs +++ b/crates/common_enums/src/enums.rs @@ -8523,6 +8523,7 @@ pub enum RoutingApproach { DebitRouting, RuleBasedRouting, VolumeBasedRouting, + StraightThroughRouting, #[default] DefaultFallback, } @@ -8533,6 +8534,7 @@ impl RoutingApproach { "SR_SELECTION_V3_ROUTING" => Self::SuccessRateExploitation, "SR_V3_HEDGING" => Self::SuccessRateExploration, "NTW_BASED_ROUTING" => Self::DebitRouting, + "DEFAULT" => Self::StraightThroughRouting, _ => Self::DefaultFallback, } } diff --git a/crates/diesel_models/src/payment_attempt.rs b/crates/diesel_models/src/payment_attempt.rs index 0afea0574a7..eeda9e78877 100644 --- a/crates/diesel_models/src/payment_attempt.rs +++ b/crates/diesel_models/src/payment_attempt.rs @@ -459,6 +459,7 @@ pub enum PaymentAttemptUpdate { tax_amount: Option<MinorUnit>, updated_by: String, merchant_connector_id: Option<id_type::MerchantConnectorAccountId>, + routing_approach: Option<storage_enums::RoutingApproach>, }, AuthenticationTypeUpdate { authentication_type: storage_enums::AuthenticationType, @@ -3088,6 +3089,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { tax_amount, updated_by, merchant_connector_id, + routing_approach, } => Self { payment_token, modified_at: common_utils::date_time::now(), @@ -3146,7 +3148,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, - routing_approach: None, + routing_approach, }, PaymentAttemptUpdate::UnresolvedResponseUpdate { status, diff --git a/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs b/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs index 3a2692e5830..d644c519ea9 100644 --- a/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs +++ b/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs @@ -1191,6 +1191,7 @@ pub enum PaymentAttemptUpdate { tax_amount: Option<MinorUnit>, updated_by: String, merchant_connector_id: Option<id_type::MerchantConnectorAccountId>, + routing_approach: Option<storage_enums::RoutingApproach>, }, AuthenticationTypeUpdate { authentication_type: storage_enums::AuthenticationType, @@ -1227,7 +1228,7 @@ pub enum PaymentAttemptUpdate { customer_acceptance: Option<pii::SecretSerdeValue>, connector_mandate_detail: Option<ConnectorMandateReferenceId>, card_discovery: Option<common_enums::CardDiscovery>, - routing_approach: Option<storage_enums::RoutingApproach>, // where all to add this one + routing_approach: Option<storage_enums::RoutingApproach>, }, RejectUpdate { status: storage_enums::AttemptStatus, @@ -1413,6 +1414,7 @@ impl PaymentAttemptUpdate { surcharge_amount, tax_amount, merchant_connector_id, + routing_approach, } => DieselPaymentAttemptUpdate::UpdateTrackers { payment_token, connector, @@ -1422,6 +1424,7 @@ impl PaymentAttemptUpdate { tax_amount, updated_by, merchant_connector_id, + routing_approach, }, Self::AuthenticationTypeUpdate { authentication_type, diff --git a/crates/router/src/core/payment_methods/cards.rs b/crates/router/src/core/payment_methods/cards.rs index 11b1489b5cf..c42b05bd424 100644 --- a/crates/router/src/core/payment_methods/cards.rs +++ b/crates/router/src/core/payment_methods/cards.rs @@ -2845,7 +2845,7 @@ pub async fn list_payment_methods( payment_intent, chosen, }; - let result = routing::perform_session_flow_routing( + let (result, routing_approach) = routing::perform_session_flow_routing( sfr, &business_profile, &enums::TransactionType::Payment, @@ -3027,6 +3027,7 @@ pub async fn list_payment_methods( merchant_connector_id: None, surcharge_amount: None, tax_amount: None, + routing_approach, }; state diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs index 83176881ead..83ff156ea95 100644 --- a/crates/router/src/core/payments.rs +++ b/crates/router/src/core/payments.rs @@ -7331,6 +7331,10 @@ where .change_context(errors::ApiErrorResponse::InternalServerError) .attach_printable("Failed execution of straight through routing")?; + payment_data.set_routing_approach_in_attempt(Some( + common_enums::RoutingApproach::StraightThroughRouting, + )); + if check_eligibility { let transaction_data = core_routing::PaymentsDslInput::new( payment_data.get_setup_mandate(), @@ -7911,12 +7915,12 @@ pub async fn perform_session_token_routing<F, D>( state: SessionState, merchant_context: &domain::MerchantContext, business_profile: &domain::Profile, - payment_data: &D, + payment_data: &mut D, connectors: api::SessionConnectorDatas, ) -> RouterResult<api::SessionConnectorDatas> where F: Clone, - D: OperationSessionGetters<F>, + D: OperationSessionGetters<F> + OperationSessionSetters<F>, { let chosen = connectors.apply_filter_for_session_routing(); let sfr = SessionFlowRoutingInput { @@ -7932,7 +7936,7 @@ where payment_intent: payment_data.get_payment_intent(), chosen, }; - let result = self_routing::perform_session_flow_routing( + let (result, routing_approach) = self_routing::perform_session_flow_routing( sfr, business_profile, &enums::TransactionType::Payment, @@ -7941,6 +7945,8 @@ where .change_context(errors::ApiErrorResponse::InternalServerError) .attach_printable("error performing session flow routing")?; + payment_data.set_routing_approach_in_attempt(routing_approach); + let final_list = connectors.filter_and_validate_for_session_flow(&result)?; Ok(final_list) diff --git a/crates/router/src/core/payments/operations/payment_create.rs b/crates/router/src/core/payments/operations/payment_create.rs index 4c463c74ed7..413aa121a9c 100644 --- a/crates/router/src/core/payments/operations/payment_create.rs +++ b/crates/router/src/core/payments/operations/payment_create.rs @@ -880,6 +880,8 @@ impl<F: Clone + Sync> UpdateTracker<F, PaymentData<F>, api::PaymentsRequest> for .as_ref() .map(|surcharge_details| surcharge_details.tax_on_surcharge_amount); + let routing_approach = payment_data.payment_attempt.routing_approach; + payment_data.payment_attempt = state .store .update_payment_attempt_with_attempt_id( @@ -896,6 +898,7 @@ impl<F: Clone + Sync> UpdateTracker<F, PaymentData<F>, api::PaymentsRequest> for tax_amount, updated_by: storage_scheme.to_string(), merchant_connector_id, + routing_approach, }, storage_scheme, ) diff --git a/crates/router/src/core/payments/routing.rs b/crates/router/src/core/payments/routing.rs index 7126ed9617e..c3823aa2f30 100644 --- a/crates/router/src/core/payments/routing.rs +++ b/crates/router/src/core/payments/routing.rs @@ -515,7 +515,10 @@ pub async fn perform_static_routing_v1( ).unwrap_or_default(); let (routable_connectors, routing_approach) = match cached_algorithm.as_ref() { - CachedAlgorithm::Single(conn) => (vec![(**conn).clone()], None), + CachedAlgorithm::Single(conn) => ( + vec![(**conn).clone()], + Some(common_enums::RoutingApproach::StraightThroughRouting), + ), CachedAlgorithm::Priority(plist) => (plist.clone(), None), CachedAlgorithm::VolumeSplit(splits) => ( perform_volume_split(splits.to_vec()) @@ -1208,8 +1211,10 @@ pub async fn perform_session_flow_routing( session_input: SessionFlowRoutingInput<'_>, business_profile: &domain::Profile, transaction_type: &api_enums::TransactionType, -) -> RoutingResult<FxHashMap<api_enums::PaymentMethodType, Vec<routing_types::SessionRoutingChoice>>> -{ +) -> RoutingResult<( + FxHashMap<api_enums::PaymentMethodType, Vec<routing_types::SessionRoutingChoice>>, + Option<common_enums::RoutingApproach>, +)> { let mut pm_type_map: FxHashMap<api_enums::PaymentMethodType, FxHashMap<String, api::GetToken>> = FxHashMap::default(); @@ -1297,6 +1302,7 @@ pub async fn perform_session_flow_routing( api_enums::PaymentMethodType, Vec<routing_types::SessionRoutingChoice>, > = FxHashMap::default(); + let mut final_routing_approach = None; for (pm_type, allowed_connectors) in pm_type_map { let euclid_pmt: euclid_enums::PaymentMethodType = pm_type; @@ -1315,12 +1321,15 @@ pub async fn perform_session_flow_routing( profile_id: &profile_id, }; - let routable_connector_choice_option = perform_session_routing_for_pm_type( - &session_pm_input, - transaction_type, - business_profile, - ) - .await?; + let (routable_connector_choice_option, routing_approach) = + perform_session_routing_for_pm_type( + &session_pm_input, + transaction_type, + business_profile, + ) + .await?; + + final_routing_approach = routing_approach; if let Some(routable_connector_choice) = routable_connector_choice_option { let mut session_routing_choice: Vec<routing_types::SessionRoutingChoice> = Vec::new(); @@ -1348,7 +1357,7 @@ pub async fn perform_session_flow_routing( } } - Ok(result) + Ok((result, final_routing_approach)) } #[cfg(feature = "v1")] @@ -1356,14 +1365,17 @@ async fn perform_session_routing_for_pm_type( session_pm_input: &SessionRoutingPmTypeInput<'_>, transaction_type: &api_enums::TransactionType, _business_profile: &domain::Profile, -) -> RoutingResult<Option<Vec<api_models::routing::RoutableConnectorChoice>>> { +) -> RoutingResult<( + Option<Vec<api_models::routing::RoutableConnectorChoice>>, + Option<common_enums::RoutingApproach>, +)> { let merchant_id = &session_pm_input.key_store.merchant_id; let algorithm_id = match session_pm_input.routing_algorithm { MerchantAccountRoutingAlgorithm::V1(algorithm_ref) => &algorithm_ref.algorithm_id, }; - let chosen_connectors = if let Some(ref algorithm_id) = algorithm_id { + let (chosen_connectors, routing_approach) = if let Some(ref algorithm_id) = algorithm_id { let cached_algorithm = ensure_algorithm_cached_v1( &session_pm_input.state.clone(), merchant_id, @@ -1374,23 +1386,35 @@ async fn perform_session_routing_for_pm_type( .await?; match cached_algorithm.as_ref() { - CachedAlgorithm::Single(conn) => vec![(**conn).clone()], - CachedAlgorithm::Priority(plist) => plist.clone(), - CachedAlgorithm::VolumeSplit(splits) => perform_volume_split(splits.to_vec()) - .change_context(errors::RoutingError::ConnectorSelectionFailed)?, - CachedAlgorithm::Advanced(interpreter) => execute_dsl_and_get_connector_v1( - session_pm_input.backend_input.clone(), - interpreter, - )?, + CachedAlgorithm::Single(conn) => ( + vec![(**conn).clone()], + Some(common_enums::RoutingApproach::StraightThroughRouting), + ), + CachedAlgorithm::Priority(plist) => (plist.clone(), None), + CachedAlgorithm::VolumeSplit(splits) => ( + perform_volume_split(splits.to_vec()) + .change_context(errors::RoutingError::ConnectorSelectionFailed)?, + Some(common_enums::RoutingApproach::VolumeBasedRouting), + ), + CachedAlgorithm::Advanced(interpreter) => ( + execute_dsl_and_get_connector_v1( + session_pm_input.backend_input.clone(), + interpreter, + )?, + Some(common_enums::RoutingApproach::RuleBasedRouting), + ), } } else { - routing::helpers::get_merchant_default_config( - &*session_pm_input.state.clone().store, - session_pm_input.profile_id.get_string_repr(), - transaction_type, + ( + routing::helpers::get_merchant_default_config( + &*session_pm_input.state.clone().store, + session_pm_input.profile_id.get_string_repr(), + transaction_type, + ) + .await + .change_context(errors::RoutingError::FallbackConfigFetchFailed)?, + None, ) - .await - .change_context(errors::RoutingError::FallbackConfigFetchFailed)? }; let mut final_selection = perform_cgraph_filtering( @@ -1426,9 +1450,9 @@ async fn perform_session_routing_for_pm_type( } if final_selection.is_empty() { - Ok(None) + Ok((None, routing_approach)) } else { - Ok(Some(final_selection)) + Ok((Some(final_selection), routing_approach)) } } diff --git a/migrations/2025-06-27-120507_update_routing_approach/down.sql b/migrations/2025-06-27-120507_update_routing_approach/down.sql new file mode 100644 index 00000000000..c7c9cbeb401 --- /dev/null +++ b/migrations/2025-06-27-120507_update_routing_approach/down.sql @@ -0,0 +1,2 @@ +-- This file should undo anything in `up.sql` +SELECT 1; \ No newline at end of file diff --git a/migrations/2025-06-27-120507_update_routing_approach/up.sql b/migrations/2025-06-27-120507_update_routing_approach/up.sql new file mode 100644 index 00000000000..c7f75cb5235 --- /dev/null +++ b/migrations/2025-06-27-120507_update_routing_approach/up.sql @@ -0,0 +1,3 @@ +-- Your SQL goes here +ALTER TYPE "RoutingApproach" +ADD VALUE 'straight_through_routing';

2025-06-30T08:06:48Z

## Type of Change  - [x] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  Fixes routing approach updation for wallets flow ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  ## How did you test it?  1. make wallet payment and check for `routing_approach` column in payment_attempt ApplePay payment create - ``` curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_BNOaWRzwyZ3hMAbhRNtp9t6Mx7ZSVyK5gPvd1bavl0FWehvrHlre1eMifYA244TE' \ --data-raw '{ "amount": 650, "currency": "USD", "confirm": false, "business_country": "US", "business_label": "default", "amount_to_capture": 650, "customer_id": "cu_1751271429", "capture_method": "automatic", "capture_on": "2022-09-10T10:11:12Z", "setup_future_usage": "off_session", "authentication_type": "no_three_ds", "return_url": "https://google.com", "email": "[email protected]", "name": "Joseph Doe", "phone": "999999999", "phone_country_code": "+65", "description": "Its my first payment request", "statement_descriptor_name": "Juspay", "statement_descriptor_suffix": "Router", "payment_method": "wallet", "payment_method_type": "apple_pay", "billing": { "address": { "line1": "1467", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" }, "phone": { "number": "8056594427", "country_code": "+91" } }, "customer_acceptance": { "acceptance_type": "offline", "accepted_at": "1963-05-03T04:07:52.723Z", "online": { "ip_address": "in sit", "user_agent": "amet irure esse" } }, "payment_method_data": { "wallet": { "apple_pay": { "payment_data": "eyJkYXRhIjogInR1OHlCcFY3MHJ5WFpSTUJqaEt3T2VtTGhrbHlPREIzNVVLdnpNUDVFRk50eW9OMUdtK2pRRkZnaTF1T0t3WmJQZUUwdmxVUnJIeU5vQkhLOUZSY1pmYzJVL2cydytHbExweWxVcEQwc2VXdU9rRTZYb1E1SHFsZ085bFZRclZacHZsNmFndHdVYU5Cc2pqWTB0Q1F1SHRMRHQzQWI4c2pJdWhpL1g1cFNYakM0ak5PdUoxRkdJKy9CS016OHBNdUZGMkUvbmJWenhNQjhoT1lDWjlUVGdFZlN3Z3VwbE9SaFY5dFV1by9VVFhFUG40cGljNVpPYUR6WnB6Z1BuK0d1V2JVVExuL0h5Rk9MQW5xc3pNZzFkdklHcjd3c0pWRE1LUzJIdHZ5VzA2QXUzNGVSZGxkaEVWbFhnYWNDcWFualVwZlJBcVhod2VtQjNwd2p4bFBUMkxrcUE3VzJwWnNLNkF1Z0lwUi9tMTUwazFRRjl3d1AwVTF6YkpBbGc5bE9VL1IyRlVZR1BKRUZ4ay92SWowL3ZiYnkvcE96L0RBY1ZRd3NGek9UbUk9IiwKICAgICAgInNpZ25hdHVyZSI6ICJNSUFHQ1NxR1NJYjNEUUVIQXFDQU1JQUNBUUV4RFRBTEJnbGdoa2dCWlFNRUFnRXdnQVlKS29aSWh2Y05BUWNCQUFDZ2dEQ0NBK1F3Z2dPTG9BTUNBUUlDQ0ZuWW9ieXE5T1BOTUFvR0NDcUdTTTQ5QkFNQ01Ib3hMakFzQmdOVkJBTU1KVUZ3Y0d4bElFRndjR3hwWTJGMGFXOXVJRWx1ZEdWbmNtRjBhVzl1SUVOQklDMGdSek14SmpBa0JnTlZCQXNNSFVGd2NHeGxJRU5sY25ScFptbGpZWFJwYjI0Z1FYVjBhRzl5YVhSNU1STXdFUVlEVlFRS0RBcEJjSEJzWlNCSmJtTXVNUXN3Q1FZRFZRUUdFd0pWVXpBZUZ3MHlNVEEwTWpBeE9UTTNNREJhRncweU5qQTBNVGt4T1RNMk5UbGFNR0l4S0RBbUJnTlZCQU1NSDJWall5MXpiWEF0WW5KdmEyVnlMWE5wWjI1ZlZVTTBMVk5CVGtSQ1QxZ3hGREFTQmdOVkJBc01DMmxQVXlCVGVYTjBaVzF6TVJNd0VRWURWUVFLREFwQmNIQnNaU0JKYm1NdU1Rc3dDUVlEVlFRR0V3SlZVekJaTUJNR0J5cUdTTTQ5QWdFR0NDcUdTTTQ5QXdFSEEwSUFCSUl3L2F2RG5QZGVJQ3hRMlp0RkV1WTM0cWtCM1d5ejRMSE5TMUpubVBqUFRyM29HaVdvd2g1TU05M09qaXFXd3Zhdm9aTURSY1RvZWtRbXpwVWJFcFdqZ2dJUk1JSUNEVEFNQmdOVkhSTUJBZjhFQWpBQU1COEdBMVVkSXdRWU1CYUFGQ1B5U2NSUGsrVHZKK2JFOWloc1A2SzcvUzVMTUVVR0NDc0dBUVVGQndFQkJEa3dOekExQmdnckJnRUZCUWN3QVlZcGFIUjBjRG92TDI5amMzQXVZWEJ3YkdVdVkyOXRMMjlqYzNBd05DMWhjSEJzWldGcFkyRXpNREl3Z2dFZEJnTlZIU0FFZ2dFVU1JSUJFRENDQVF3R0NTcUdTSWIzWTJRRkFUQ0IvakNCd3dZSUt3WUJCUVVIQWdJd2diWU1nYk5TWld4cFlXNWpaU0J2YmlCMGFHbHpJR05sY25ScFptbGpZWFJsSUdKNUlHRnVlU0J3WVhKMGVTQmhjM04xYldWeklHRmpZMlZ3ZEdGdVkyVWdiMllnZEdobElIUm9aVzRnWVhCd2JHbGpZV0pzWlNCemRHRnVaR0Z5WkNCMFpYSnRjeUJoYm1RZ1kyOXVaR2wwYVc5dWN5QnZaaUIxYzJVc0lHTmxjblJwWm1sallYUmxJSEJ2YkdsamVTQmhibVFnWTJWeWRHbG1hV05oZEdsdmJpQndjbUZqZEdsalpTQnpkR0YwWlcxbGJuUnpMakEyQmdnckJnRUZCUWNDQVJZcWFIUjBjRG92TDNkM2R5NWhjSEJzWlM1amIyMHZZMlZ5ZEdsbWFXTmhkR1ZoZFhSb2IzSnBkSGt2TURRR0ExVWRId1F0TUNzd0thQW5vQ1dHSTJoMGRIQTZMeTlqY213dVlYQndiR1V1WTI5dEwyRndjR3hsWVdsallUTXVZM0pzTUIwR0ExVWREZ1FXQkJRQ0pEQUxtdTd0UmpHWHBLWmFLWjVDY1lJY1JUQU9CZ05WSFE4QkFmOEVCQU1DQjRBd0R3WUpLb1pJaHZkalpBWWRCQUlGQURBS0JnZ3Foa2pPUFFRREFnTkhBREJFQWlCMG9iTWsyMEpKUXczVEoweFFkTVNBalpvZlNBNDZoY1hCTmlWbU1sKzhvd0lnYVRhUVU2djFDMXBTK2ZZQVRjV0tyV3hRcDlZSWFEZVE0S2M2MEI1SzJZRXdnZ0x1TUlJQ2RhQURBZ0VDQWdoSmJTKy9PcGphbHpBS0JnZ3Foa2pPUFFRREFqQm5NUnN3R1FZRFZRUUREQkpCY0hCc1pTQlNiMjkwSUVOQklDMGdSek14SmpBa0JnTlZCQXNNSFVGd2NHeGxJRU5sY25ScFptbGpZWFJwYjI0Z1FYVjBhRzl5YVhSNU1STXdFUVlEVlFRS0RBcEJjSEJzWlNCSmJtTXVNUXN3Q1FZRFZRUUdFd0pWVXpBZUZ3MHhOREExTURZeU16UTJNekJhRncweU9UQTFNRFl5TXpRMk16QmFNSG94TGpBc0JnTlZCQU1NSlVGd2NHeGxJRUZ3Y0d4cFkyRjBhVzl1SUVsdWRHVm5jbUYwYVc5dUlFTkJJQzBnUnpNeEpqQWtCZ05WQkFzTUhVRndjR3hsSUVObGNuUnBabWxqWVhScGIyNGdRWFYwYUc5eWFYUjVNUk13RVFZRFZRUUtEQXBCY0hCc1pTQkpibU11TVFzd0NRWURWUVFHRXdKVlV6QlpNQk1HQnlxR1NNNDlBZ0VHQ0NxR1NNNDlBd0VIQTBJQUJQQVhFWVFaMTJTRjFScGVKWUVIZHVpQW91L2VlNjVONEkzOFM1UGhNMWJWWmxzMXJpTFFsM1lOSWs1N3VnajlkaGZPaU10MnUyWnd2c2pvS1lUL1ZFV2pnZmN3Z2ZRd1JnWUlLd1lCQlFVSEFRRUVPakE0TURZR0NDc0dBUVVGQnpBQmhpcG9kSFJ3T2k4dmIyTnpjQzVoY0hCc1pTNWpiMjB2YjJOemNEQTBMV0Z3Y0d4bGNtOXZkR05oWnpNd0hRWURWUjBPQkJZRUZDUHlTY1JQaytUdkorYkU5aWhzUDZLNy9TNUxNQThHQTFVZEV3RUIvd1FGTUFNQkFmOHdId1lEVlIwakJCZ3dGb0FVdTdEZW9WZ3ppSnFraXBuZXZyM3JyOXJMSktzd053WURWUjBmQkRBd0xqQXNvQ3FnS0lZbWFIUjBjRG92TDJOeWJDNWhjSEJzWlM1amIyMHZZWEJ3YkdWeWIyOTBZMkZuTXk1amNtd3dEZ1lEVlIwUEFRSC9CQVFEQWdFR01CQUdDaXFHU0liM1kyUUdBZzRFQWdVQU1Bb0dDQ3FHU000OUJBTUNBMmNBTUdRQ01EclBjb05SRnBteGh2czF3MWJLWXIvMEYrM1pEM1ZOb282KzhaeUJYa0szaWZpWTk1dFpuNWpWUVEyUG5lbkMvZ0l3TWkzVlJDR3dvd1YzYkYzek9EdVFaLzBYZkN3aGJaWlB4bkpwZ2hKdlZQaDZmUnVaeTVzSmlTRmhCcGtQQ1pJZEFBQXhnZ0dITUlJQmd3SUJBVENCaGpCNk1TNHdMQVlEVlFRRERDVkJjSEJzWlNCQmNIQnNhV05oZEdsdmJpQkpiblJsWjNKaGRHbHZiaUJEUVNBdElFY3pNU1l3SkFZRFZRUUxEQjFCY0hCc1pTQkRaWEowYVdacFkyRjBhVzl1SUVGMWRHaHZjbWwwZVRFVE1CRUdBMVVFQ2d3S1FYQndiR1VnU1c1akxqRUxNQWtHQTFVRUJoTUNWVk1DQ0ZuWW9ieXE5T1BOTUFzR0NXQ0dTQUZsQXdRQ0FhQ0JrekFZQmdrcWhraUc5dzBCQ1FNeEN3WUpLb1pJaHZjTkFRY0JNQndHQ1NxR1NJYjNEUUVKQlRFUEZ3MHlOREV5TVRJd09ESTFNalphTUNnR0NTcUdTSWIzRFFFSk5ERWJNQmt3Q3dZSllJWklBV1VEQkFJQm9Rb0dDQ3FHU000OUJBTUNNQzhHQ1NxR1NJYjNEUUVKQkRFaUJDQmZHSHBFQ2RnOWQ0YWl0VTlDRndSTGVEYXNZSDRMdUNuQjIvZHd2VFE2SWpBS0JnZ3Foa2pPUFFRREFnUkdNRVFDSUhnK3dKd25RdlJuZEdIN1UrL1hVb094c21VRVI2a2RqQ0RQNStTajF4eXpBaUJydEdIUGtWUXB1VEFHeDQ5SllEUFl5MzdhUDhoeGxtK1VjRThzVWFFa0V3QUFBQUFBQUE9PSIsCiAgICAgICJoZWFkZXIiOiB7CiAgICAgICAgInB1YmxpY0tleUhhc2giOiAiMkNnWTU3TERJVFVEMHFSN0R3eUhsdVRtMTIyQnowOXNhczJCVVorRUU5VT0iLAogICAgICAgICJlcGhlbWVyYWxQdWJsaWNLZXkiOiAiTUZrd0V3WUhLb1pJemowQ0FRWUlLb1pJemowREFRY0RRZ0FFQmN1VGNHRGl0V1B3UVE5SFZ0d1dEZmRkZDlhelJ3VFJlL00zVUNSb3NHaEhhUklQUnNoZWp2ZWpaL0Z4MlFiamVYRmNRSnVra0creUdYUmlnTDR2MUE9PSIsCiAgICAgICAgInRyYW5zYWN0aW9uSWQiOiAiNzAwOTVhMWFjMTZkNGQ4NzAyODQ0ZDdjZDJhZGVkZWMxZmQyMzA0YTFkNmU3OTBhZWVmOWJjYzA5MmZkYjk2MSIKICAgICAgfSwKICAgICAgInZlcnNpb24iOiAiRUNfdjEifQ==", "payment_method": { "display_name": "Discover 9319", "network": "Discover", "type": "credit" }, "transaction_identifier": "c635c5b3af900d7bd81fecd7028f1262f9d030754ee65ec7afd988a678194751" } } } }' ``` Payment method list - ``` curl --location 'http://localhost:8080/account/payment_methods?client_secret=pay_mgPMJsvP0EXSt7fDSmIF_secret_TbYn03eKtktMmmjUMTKe' \ --header 'Accept: application/json' \ --header 'api-key: pk_dev_bc5af669d7594cb7aaf277fc6b6c60dc' ``` Routing approach after this - <img width="850" alt="image" src="https://github.com/user-attachments/assets/4d637044-03e0-4c34-ab7c-abbe60a700fc" /> test straight_through routing - ``` curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_BNOaWRzwyZ3hMAbhRNtp9t6Mx7ZSVyK5gPvd1bavl0FWehvrHlre1eMifYA244TE' \ --data-raw '{ "amount": 6540, "currency": "USD", "confirm": true, "capture_method": "automatic", "capture_on": "2022-09-10T10:11:12Z", "amount_to_capture": 6540, "customer_id": "StripeCustomer", "profile_id": "pro_EfD8EtQQSPZxXStG6B7x", "email": "[email protected]", "name": "John Doe", "phone": "999999999", "phone_country_code": "+1", "description": "Its my first payment request", "authentication_type": "no_three_ds", "return_url": "https://google.com", "payment_method": "card", "routing": { "type": "single", "data": {"connector": "stripe", "merchant_connector_id": "mca_SdftCCtpClu32qA6oijC"} }, "payment_method_type": "credit", "payment_method_data": { "card": { "card_number": "4242424242424242", "card_exp_month": "03", "card_exp_year": "30", "card_holder_name": "joseph Doe", "card_cvc": "737" } }, "billing": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "NL", "first_name": "joseph", "last_name": "Doe" }, "phone": { "number": "8056594427", "country_code": "+91" } }, "shipping": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" }, "phone": { "number": "8056594427", "country_code": "+91" } }, "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "metadata": { "udf1": "value1", "new_customer": "true", "login_date": "2019-09-10T10:11:12Z" }, "browser_info": { "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8", "language": "nl-NL", "color_depth": 24, "screen_height": 723, "screen_width": 1536, "time_zone": 0, "java_enabled": true, "java_script_enabled": true, "ip_address": "127.0.0.1" } }' ``` DB - <img width="852" alt="image" src="https://github.com/user-attachments/assets/6fa08603-19af-485b-bce2-9266b3419749" /> ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [ ] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

1c3811773ded20da19fac6f1dc679e337384f1cb

juspay/hyperswitch

juspay__hyperswitch-8491

Bug: [FEATURE] celero connector template ### Feature Description Create connector template ### Possible Implementation https://celerocommerce.com/developers/ ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? None

diff --git a/api-reference/v1/openapi_spec_v1.json b/api-reference/v1/openapi_spec_v1.json index 84cfe8e6199..940922743ca 100644 --- a/api-reference/v1/openapi_spec_v1.json +++ b/api-reference/v1/openapi_spec_v1.json @@ -10940,6 +10940,7 @@ "boku", "braintree", "cashtocode", + "celero", "chargebee", "checkout", "coinbase", @@ -27949,6 +27950,7 @@ "boku", "braintree", "cashtocode", + "celero", "chargebee", "checkout", "coinbase", diff --git a/api-reference/v2/openapi_spec_v2.json b/api-reference/v2/openapi_spec_v2.json index 63a25bf4fc2..12340ea5dcb 100644 --- a/api-reference/v2/openapi_spec_v2.json +++ b/api-reference/v2/openapi_spec_v2.json @@ -8147,6 +8147,7 @@ "boku", "braintree", "cashtocode", + "celero", "chargebee", "checkout", "coinbase", @@ -22666,6 +22667,7 @@ "boku", "braintree", "cashtocode", + "celero", "chargebee", "checkout", "coinbase", diff --git a/config/config.example.toml b/config/config.example.toml index 3c6da56b240..0bb5cb13007 100644 --- a/config/config.example.toml +++ b/config/config.example.toml @@ -202,6 +202,7 @@ bluesnap.secondary_base_url = "https://sandpay.bluesnap.com/" boku.base_url = "https://$-api4-stage.boku.com" braintree.base_url = "https://payments.sandbox.braintree-api.com/graphql" cashtocode.base_url = "https://cluster05.api-test.cashtocode.com" +celero.base_url = "https://sandbox.gotnpgateway.com" chargebee.base_url = "https://$.chargebee.com/api/" checkbook.base_url = "https://api.sandbox.checkbook.io" checkout.base_url = "https://api.sandbox.checkout.com/" @@ -342,6 +343,7 @@ cards = [ "adyenplatform", "archipel", "authorizedotnet", + "celero", "coinbase", "coingate", "cryptopay", diff --git a/config/deployments/integration_test.toml b/config/deployments/integration_test.toml index 495847bd896..c92570aaeef 100644 --- a/config/deployments/integration_test.toml +++ b/config/deployments/integration_test.toml @@ -41,6 +41,7 @@ bluesnap.secondary_base_url = "https://sandpay.bluesnap.com/" boku.base_url = "https://$-api4-stage.boku.com" braintree.base_url = "https://payments.sandbox.braintree-api.com/graphql" cashtocode.base_url = "https://cluster05.api-test.cashtocode.com" +celero.base_url = "https://sandbox.gotnpgateway.com" chargebee.base_url = "https://$.chargebee.com/api/" checkbook.base_url = "https://api.sandbox.checkbook.io" checkout.base_url = "https://api.sandbox.checkout.com/" diff --git a/config/deployments/production.toml b/config/deployments/production.toml index 335d7f5acea..8e7fd10702c 100644 --- a/config/deployments/production.toml +++ b/config/deployments/production.toml @@ -45,6 +45,7 @@ bluesnap.secondary_base_url = "https://pay.bluesnap.com/" boku.base_url = "https://country-api4-stage.boku.com" braintree.base_url = "https://payments.braintree-api.com/graphql" cashtocode.base_url = "https://cluster14.api.cashtocode.com" +celero.base_url = "https://app.gotnpgateway.com" chargebee.base_url = "https://{{merchant_endpoint_prefix}}.chargebee.com/api/" checkbook.base_url = "https://api.checkbook.io" checkout.base_url = "https://api.checkout.com/" diff --git a/config/deployments/sandbox.toml b/config/deployments/sandbox.toml index 721e32b9b8e..2011b50b756 100644 --- a/config/deployments/sandbox.toml +++ b/config/deployments/sandbox.toml @@ -45,6 +45,7 @@ bluesnap.secondary_base_url = "https://sandpay.bluesnap.com/" boku.base_url = "https://$-api4-stage.boku.com" braintree.base_url = "https://payments.sandbox.braintree-api.com/graphql" cashtocode.base_url = "https://cluster05.api-test.cashtocode.com" +celero.base_url = "https://sandbox.gotnpgateway.com" checkbook.base_url = "https://api.sandbox.checkbook.io" checkout.base_url = "https://api.sandbox.checkout.com/" chargebee.base_url = "https://$.chargebee.com/api/" diff --git a/config/development.toml b/config/development.toml index ab885503c85..49e5bb8a52e 100644 --- a/config/development.toml +++ b/config/development.toml @@ -109,6 +109,7 @@ cards = [ "bluesnap", "boku", "braintree", + "celero", "checkbook", "checkout", "coinbase", @@ -238,6 +239,7 @@ bluesnap.secondary_base_url = "https://sandpay.bluesnap.com/" boku.base_url = "https://$-api4-stage.boku.com" braintree.base_url = "https://payments.sandbox.braintree-api.com/graphql" cashtocode.base_url = "https://cluster05.api-test.cashtocode.com" +celero.base_url = "https://sandbox.gotnpgateway.com" chargebee.base_url = "https://$.chargebee.com/api/" checkbook.base_url = "https://api.sandbox.checkbook.io" checkout.base_url = "https://api.sandbox.checkout.com/" diff --git a/config/docker_compose.toml b/config/docker_compose.toml index dbfeccf7cd0..329c3743d39 100644 --- a/config/docker_compose.toml +++ b/config/docker_compose.toml @@ -128,6 +128,7 @@ bluesnap.secondary_base_url = "https://sandpay.bluesnap.com/" boku.base_url = "https://$-api4-stage.boku.com" braintree.base_url = "https://payments.sandbox.braintree-api.com/graphql" cashtocode.base_url = "https://cluster05.api-test.cashtocode.com" +celero.base_url = "https://sandbox.gotnpgateway.com" chargebee.base_url = "https://$.chargebee.com/api/" checkbook.base_url = "https://api.sandbox.checkbook.io" checkout.base_url = "https://api.sandbox.checkout.com/" @@ -259,6 +260,7 @@ cards = [ "bluesnap", "boku", "braintree", + "celero", "checkout", "checkbook", "coinbase", diff --git a/crates/common_enums/src/connector_enums.rs b/crates/common_enums/src/connector_enums.rs index e975dc8bcbd..5251b9b3177 100644 --- a/crates/common_enums/src/connector_enums.rs +++ b/crates/common_enums/src/connector_enums.rs @@ -74,6 +74,7 @@ pub enum RoutableConnectors { Boku, Braintree, Cashtocode, + Celero, Chargebee, // Checkbook, Checkout, @@ -232,6 +233,7 @@ pub enum Connector { Boku, Braintree, Cashtocode, + Celero, Chargebee, // Checkbook, Checkout, @@ -417,6 +419,7 @@ impl Connector { | Self::Boku | Self::Braintree | Self::Cashtocode + | Self::Celero | Self::Chargebee // | Self::Checkbook | Self::Coinbase @@ -580,6 +583,7 @@ impl From<RoutableConnectors> for Connector { RoutableConnectors::Boku => Self::Boku, RoutableConnectors::Braintree => Self::Braintree, RoutableConnectors::Cashtocode => Self::Cashtocode, + RoutableConnectors::Celero => Self::Celero, RoutableConnectors::Chargebee => Self::Chargebee, // RoutableConnectors::Checkbook => Self::Checkbook, RoutableConnectors::Checkout => Self::Checkout, @@ -701,6 +705,7 @@ impl TryFrom<Connector> for RoutableConnectors { Connector::Boku => Ok(Self::Boku), Connector::Braintree => Ok(Self::Braintree), Connector::Cashtocode => Ok(Self::Cashtocode), + Connector::Celero => Ok(Self::Celero), Connector::Chargebee => Ok(Self::Chargebee), // Connector::Checkbook => Ok(Self::Checkbook), Connector::Checkout => Ok(Self::Checkout), diff --git a/crates/connector_configs/src/connector.rs b/crates/connector_configs/src/connector.rs index 6ec11e8ca78..3e36dc023b9 100644 --- a/crates/connector_configs/src/connector.rs +++ b/crates/connector_configs/src/connector.rs @@ -190,6 +190,7 @@ pub struct ConnectorConfig { pub boku: Option<ConnectorTomlConfig>, pub braintree: Option<ConnectorTomlConfig>, pub cashtocode: Option<ConnectorTomlConfig>, + pub celero: Option<ConnectorTomlConfig>, pub chargebee: Option<ConnectorTomlConfig>, pub checkbook: Option<ConnectorTomlConfig>, pub checkout: Option<ConnectorTomlConfig>, @@ -381,6 +382,7 @@ impl ConnectorConfig { Connector::Boku => Ok(connector_data.boku), Connector::Braintree => Ok(connector_data.braintree), Connector::Cashtocode => Ok(connector_data.cashtocode), + Connector::Celero => Ok(connector_data.celero), Connector::Chargebee => Ok(connector_data.chargebee), Connector::Checkout => Ok(connector_data.checkout), Connector::Coinbase => Ok(connector_data.coinbase), diff --git a/crates/hyperswitch_connectors/src/connectors.rs b/crates/hyperswitch_connectors/src/connectors.rs index 16b56bed6fc..0861bbb4610 100644 --- a/crates/hyperswitch_connectors/src/connectors.rs +++ b/crates/hyperswitch_connectors/src/connectors.rs @@ -15,6 +15,7 @@ pub mod bluesnap; pub mod boku; pub mod braintree; pub mod cashtocode; +pub mod celero; pub mod chargebee; pub mod checkbook; pub mod checkout; @@ -116,26 +117,26 @@ pub use self::{ amazonpay::Amazonpay, archipel::Archipel, authorizedotnet::Authorizedotnet, bambora::Bambora, bamboraapac::Bamboraapac, bankofamerica::Bankofamerica, barclaycard::Barclaycard, billwerk::Billwerk, bitpay::Bitpay, bluesnap::Bluesnap, boku::Boku, braintree::Braintree, - cashtocode::Cashtocode, chargebee::Chargebee, checkbook::Checkbook, checkout::Checkout, - coinbase::Coinbase, coingate::Coingate, cryptopay::Cryptopay, ctp_mastercard::CtpMastercard, - cybersource::Cybersource, datatrans::Datatrans, deutschebank::Deutschebank, - digitalvirgo::Digitalvirgo, dlocal::Dlocal, dwolla::Dwolla, ebanx::Ebanx, elavon::Elavon, - facilitapay::Facilitapay, fiserv::Fiserv, fiservemea::Fiservemea, fiuu::Fiuu, forte::Forte, - getnet::Getnet, globalpay::Globalpay, globepay::Globepay, gocardless::Gocardless, - gpayments::Gpayments, helcim::Helcim, hipay::Hipay, hyperswitch_vault::HyperswitchVault, - iatapay::Iatapay, inespay::Inespay, itaubank::Itaubank, jpmorgan::Jpmorgan, - juspaythreedsserver::Juspaythreedsserver, klarna::Klarna, mifinity::Mifinity, mollie::Mollie, - moneris::Moneris, multisafepay::Multisafepay, netcetera::Netcetera, nexinets::Nexinets, - nexixpay::Nexixpay, nmi::Nmi, nomupay::Nomupay, noon::Noon, nordea::Nordea, novalnet::Novalnet, - nuvei::Nuvei, opayo::Opayo, opennode::Opennode, paybox::Paybox, payeezy::Payeezy, - payload::Payload, payme::Payme, payone::Payone, paypal::Paypal, paystack::Paystack, payu::Payu, - placetopay::Placetopay, plaid::Plaid, powertranz::Powertranz, prophetpay::Prophetpay, - rapyd::Rapyd, razorpay::Razorpay, recurly::Recurly, redsys::Redsys, riskified::Riskified, - santander::Santander, shift4::Shift4, signifyd::Signifyd, square::Square, stax::Stax, - stripe::Stripe, stripebilling::Stripebilling, taxjar::Taxjar, threedsecureio::Threedsecureio, - thunes::Thunes, tokenio::Tokenio, trustpay::Trustpay, tsys::Tsys, - unified_authentication_service::UnifiedAuthenticationService, vgs::Vgs, volt::Volt, - wellsfargo::Wellsfargo, wellsfargopayout::Wellsfargopayout, wise::Wise, worldline::Worldline, - worldpay::Worldpay, worldpayvantiv::Worldpayvantiv, worldpayxml::Worldpayxml, xendit::Xendit, - zen::Zen, zsl::Zsl, + cashtocode::Cashtocode, celero::Celero, chargebee::Chargebee, checkbook::Checkbook, + checkout::Checkout, coinbase::Coinbase, coingate::Coingate, cryptopay::Cryptopay, + ctp_mastercard::CtpMastercard, cybersource::Cybersource, datatrans::Datatrans, + deutschebank::Deutschebank, digitalvirgo::Digitalvirgo, dlocal::Dlocal, dwolla::Dwolla, + ebanx::Ebanx, elavon::Elavon, facilitapay::Facilitapay, fiserv::Fiserv, fiservemea::Fiservemea, + fiuu::Fiuu, forte::Forte, getnet::Getnet, globalpay::Globalpay, globepay::Globepay, + gocardless::Gocardless, gpayments::Gpayments, helcim::Helcim, hipay::Hipay, + hyperswitch_vault::HyperswitchVault, iatapay::Iatapay, inespay::Inespay, itaubank::Itaubank, + jpmorgan::Jpmorgan, juspaythreedsserver::Juspaythreedsserver, klarna::Klarna, + mifinity::Mifinity, mollie::Mollie, moneris::Moneris, multisafepay::Multisafepay, + netcetera::Netcetera, nexinets::Nexinets, nexixpay::Nexixpay, nmi::Nmi, nomupay::Nomupay, + noon::Noon, nordea::Nordea, novalnet::Novalnet, nuvei::Nuvei, opayo::Opayo, opennode::Opennode, + paybox::Paybox, payeezy::Payeezy, payload::Payload, payme::Payme, payone::Payone, + paypal::Paypal, paystack::Paystack, payu::Payu, placetopay::Placetopay, plaid::Plaid, + powertranz::Powertranz, prophetpay::Prophetpay, rapyd::Rapyd, razorpay::Razorpay, + recurly::Recurly, redsys::Redsys, riskified::Riskified, santander::Santander, shift4::Shift4, + signifyd::Signifyd, square::Square, stax::Stax, stripe::Stripe, stripebilling::Stripebilling, + taxjar::Taxjar, threedsecureio::Threedsecureio, thunes::Thunes, tokenio::Tokenio, + trustpay::Trustpay, tsys::Tsys, unified_authentication_service::UnifiedAuthenticationService, + vgs::Vgs, volt::Volt, wellsfargo::Wellsfargo, wellsfargopayout::Wellsfargopayout, wise::Wise, + worldline::Worldline, worldpay::Worldpay, worldpayvantiv::Worldpayvantiv, + worldpayxml::Worldpayxml, xendit::Xendit, zen::Zen, zsl::Zsl, }; diff --git a/crates/hyperswitch_connectors/src/connectors/celero.rs b/crates/hyperswitch_connectors/src/connectors/celero.rs new file mode 100644 index 00000000000..5d37d737355 --- /dev/null +++ b/crates/hyperswitch_connectors/src/connectors/celero.rs @@ -0,0 +1,571 @@ +pub mod transformers; + +use common_utils::{ + errors::CustomResult, + ext_traits::BytesExt, + request::{Method, Request, RequestBuilder, RequestContent}, + types::{AmountConvertor, StringMinorUnit, StringMinorUnitForConnector}, +}; +use error_stack::{report, ResultExt}; +use hyperswitch_domain_models::{ + router_data::{AccessToken, ConnectorAuthType, ErrorResponse, RouterData}, + router_flow_types::{ + access_token_auth::AccessTokenAuth, + payments::{Authorize, Capture, PSync, PaymentMethodToken, Session, SetupMandate, Void}, + refunds::{Execute, RSync}, + }, + router_request_types::{ + AccessTokenRequestData, PaymentMethodTokenizationData, PaymentsAuthorizeData, + PaymentsCancelData, PaymentsCaptureData, PaymentsSessionData, PaymentsSyncData, + RefundsData, SetupMandateRequestData, + }, + router_response_types::{PaymentsResponseData, RefundsResponseData}, + types::{ + PaymentsAuthorizeRouterData, PaymentsCaptureRouterData, PaymentsSyncRouterData, + RefundSyncRouterData, RefundsRouterData, + }, +}; +use hyperswitch_interfaces::{ + api::{ + self, ConnectorCommon, ConnectorCommonExt, ConnectorIntegration, ConnectorSpecifications, + ConnectorValidation, + }, + configs::Connectors, + errors, + events::connector_api_logs::ConnectorEvent, + types::{self, Response}, + webhooks, +}; +use masking::{ExposeInterface, Mask}; +use transformers as celero; + +use crate::{constants::headers, types::ResponseRouterData, utils}; + +#[derive(Clone)] +pub struct Celero { + amount_converter: &'static (dyn AmountConvertor<Output = StringMinorUnit> + Sync), +} + +impl Celero { + pub fn new() -> &'static Self { + &Self { + amount_converter: &StringMinorUnitForConnector, + } + } +} + +impl api::Payment for Celero {} +impl api::PaymentSession for Celero {} +impl api::ConnectorAccessToken for Celero {} +impl api::MandateSetup for Celero {} +impl api::PaymentAuthorize for Celero {} +impl api::PaymentSync for Celero {} +impl api::PaymentCapture for Celero {} +impl api::PaymentVoid for Celero {} +impl api::Refund for Celero {} +impl api::RefundExecute for Celero {} +impl api::RefundSync for Celero {} +impl api::PaymentToken for Celero {} + +impl ConnectorIntegration<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData> + for Celero +{ + // Not Implemented (R) +} + +impl<Flow, Request, Response> ConnectorCommonExt<Flow, Request, Response> for Celero +where + Self: ConnectorIntegration<Flow, Request, Response>, +{ + fn build_headers( + &self, + req: &RouterData<Flow, Request, Response>, + _connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + let mut header = vec![( + headers::CONTENT_TYPE.to_string(), + self.get_content_type().to_string().into(), + )]; + let mut api_key = self.get_auth_header(&req.connector_auth_type)?; + header.append(&mut api_key); + Ok(header) + } +} + +impl ConnectorCommon for Celero { + fn id(&self) -> &'static str { + "celero" + } + + fn get_currency_unit(&self) -> api::CurrencyUnit { + api::CurrencyUnit::Base + // TODO! Check connector documentation, on which unit they are processing the currency. + // If the connector accepts amount in lower unit ( i.e cents for USD) then return api::CurrencyUnit::Minor, + // if connector accepts amount in base unit (i.e dollars for USD) then return api::CurrencyUnit::Base + } + + fn common_get_content_type(&self) -> &'static str { + "application/json" + } + + fn base_url<'a>(&self, connectors: &'a Connectors) -> &'a str { + connectors.celero.base_url.as_ref() + } + + fn get_auth_header( + &self, + auth_type: &ConnectorAuthType, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + let auth = celero::CeleroAuthType::try_from(auth_type) + .change_context(errors::ConnectorError::FailedToObtainAuthType)?; + Ok(vec![( + headers::AUTHORIZATION.to_string(), + auth.api_key.expose().into_masked(), + )]) + } + + fn build_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + let response: celero::CeleroErrorResponse = res + .response + .parse_struct("CeleroErrorResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + + Ok(ErrorResponse { + status_code: res.status_code, + code: response.code, + message: response.message, + reason: response.reason, + attempt_status: None, + connector_transaction_id: None, + network_decline_code: None, + network_advice_code: None, + network_error_message: None, + }) + } +} + +impl ConnectorValidation for Celero { + //TODO: implement functions when support enabled +} + +impl ConnectorIntegration<Session, PaymentsSessionData, PaymentsResponseData> for Celero { + //TODO: implement sessions flow +} + +impl ConnectorIntegration<AccessTokenAuth, AccessTokenRequestData, AccessToken> for Celero {} + +impl ConnectorIntegration<SetupMandate, SetupMandateRequestData, PaymentsResponseData> for Celero {} + +impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData> for Celero { + fn get_headers( + &self, + req: &PaymentsAuthorizeRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsAuthorizeRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn get_request_body( + &self, + req: &PaymentsAuthorizeRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let amount = utils::convert_amount( + self.amount_converter, + req.request.minor_amount, + req.request.currency, + )?; + + let connector_router_data = celero::CeleroRouterData::from((amount, req)); + let connector_req = celero::CeleroPaymentsRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &PaymentsAuthorizeRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::PaymentsAuthorizeType::get_url( + self, req, connectors, + )?) + .attach_default_headers() + .headers(types::PaymentsAuthorizeType::get_headers( + self, req, connectors, + )?) + .set_body(types::PaymentsAuthorizeType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsAuthorizeRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsAuthorizeRouterData, errors::ConnectorError> { + let response: celero::CeleroPaymentsResponse = res + .response + .parse_struct("Celero PaymentsAuthorizeResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<PSync, PaymentsSyncData, PaymentsResponseData> for Celero { + fn get_headers( + &self, + req: &PaymentsSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsSyncRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn build_request( + &self, + req: &PaymentsSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Get) + .url(&types::PaymentsSyncType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::PaymentsSyncType::get_headers(self, req, connectors)?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsSyncRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsSyncRouterData, errors::ConnectorError> { + let response: celero::CeleroPaymentsResponse = res + .response + .parse_struct("celero PaymentsSyncResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<Capture, PaymentsCaptureData, PaymentsResponseData> for Celero { + fn get_headers( + &self, + req: &PaymentsCaptureRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsCaptureRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn get_request_body( + &self, + _req: &PaymentsCaptureRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_request_body method".to_string()).into()) + } + + fn build_request( + &self, + req: &PaymentsCaptureRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::PaymentsCaptureType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::PaymentsCaptureType::get_headers( + self, req, connectors, + )?) + .set_body(types::PaymentsCaptureType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsCaptureRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsCaptureRouterData, errors::ConnectorError> { + let response: celero::CeleroPaymentsResponse = res + .response + .parse_struct("Celero PaymentsCaptureResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<Void, PaymentsCancelData, PaymentsResponseData> for Celero {} + +impl ConnectorIntegration<Execute, RefundsData, RefundsResponseData> for Celero { + fn get_headers( + &self, + req: &RefundsRouterData<Execute>, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &RefundsRouterData<Execute>, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn get_request_body( + &self, + req: &RefundsRouterData<Execute>, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let refund_amount = utils::convert_amount( + self.amount_converter, + req.request.minor_refund_amount, + req.request.currency, + )?; + + let connector_router_data = celero::CeleroRouterData::from((refund_amount, req)); + let connector_req = celero::CeleroRefundRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &RefundsRouterData<Execute>, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + let request = RequestBuilder::new() + .method(Method::Post) + .url(&types::RefundExecuteType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::RefundExecuteType::get_headers( + self, req, connectors, + )?) + .set_body(types::RefundExecuteType::get_request_body( + self, req, connectors, + )?) + .build(); + Ok(Some(request)) + } + + fn handle_response( + &self, + data: &RefundsRouterData<Execute>, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<RefundsRouterData<Execute>, errors::ConnectorError> { + let response: celero::RefundResponse = + res.response + .parse_struct("celero RefundResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<RSync, RefundsData, RefundsResponseData> for Celero { + fn get_headers( + &self, + req: &RefundSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &RefundSyncRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn build_request( + &self, + req: &RefundSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Get) + .url(&types::RefundSyncType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::RefundSyncType::get_headers(self, req, connectors)?) + .set_body(types::RefundSyncType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &RefundSyncRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<RefundSyncRouterData, errors::ConnectorError> { + let response: celero::RefundResponse = res + .response + .parse_struct("celero RefundSyncResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +#[async_trait::async_trait] +impl webhooks::IncomingWebhook for Celero { + fn get_webhook_object_reference_id( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<api_models::webhooks::ObjectReferenceId, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } + + fn get_webhook_event_type( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<api_models::webhooks::IncomingWebhookEvent, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } + + fn get_webhook_resource_object( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<Box<dyn masking::ErasedMaskSerialize>, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } +} + +impl ConnectorSpecifications for Celero {} diff --git a/crates/hyperswitch_connectors/src/connectors/celero/transformers.rs b/crates/hyperswitch_connectors/src/connectors/celero/transformers.rs new file mode 100644 index 00000000000..2579c81ae6b --- /dev/null +++ b/crates/hyperswitch_connectors/src/connectors/celero/transformers.rs @@ -0,0 +1,228 @@ +use common_enums::enums; +use common_utils::types::StringMinorUnit; +use hyperswitch_domain_models::{ + payment_method_data::PaymentMethodData, + router_data::{ConnectorAuthType, RouterData}, + router_flow_types::refunds::{Execute, RSync}, + router_request_types::ResponseId, + router_response_types::{PaymentsResponseData, RefundsResponseData}, + types::{PaymentsAuthorizeRouterData, RefundsRouterData}, +}; +use hyperswitch_interfaces::errors; +use masking::Secret; +use serde::{Deserialize, Serialize}; + +use crate::{ + types::{RefundsResponseRouterData, ResponseRouterData}, + utils::PaymentsAuthorizeRequestData, +}; + +//TODO: Fill the struct with respective fields +pub struct CeleroRouterData<T> { + pub amount: StringMinorUnit, // The type of amount that a connector accepts, for example, String, i64, f64, etc. + pub router_data: T, +} + +impl<T> From<(StringMinorUnit, T)> for CeleroRouterData<T> { + fn from((amount, item): (StringMinorUnit, T)) -> Self { + //Todo : use utils to convert the amount to the type of amount that a connector accepts + Self { + amount, + router_data: item, + } + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Serialize, PartialEq)] +pub struct CeleroPaymentsRequest { + amount: StringMinorUnit, + card: CeleroCard, +} + +#[derive(Default, Debug, Serialize, Eq, PartialEq)] +pub struct CeleroCard { + number: cards::CardNumber, + expiry_month: Secret<String>, + expiry_year: Secret<String>, + cvc: Secret<String>, + complete: bool, +} + +impl TryFrom<&CeleroRouterData<&PaymentsAuthorizeRouterData>> for CeleroPaymentsRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: &CeleroRouterData<&PaymentsAuthorizeRouterData>, + ) -> Result<Self, Self::Error> { + match item.router_data.request.payment_method_data.clone() { + PaymentMethodData::Card(req_card) => { + let card = CeleroCard { + number: req_card.card_number, + expiry_month: req_card.card_exp_month, + expiry_year: req_card.card_exp_year, + cvc: req_card.card_cvc, + complete: item.router_data.request.is_auto_capture()?, + }; + Ok(Self { + amount: item.amount.clone(), + card, + }) + } + _ => Err(errors::ConnectorError::NotImplemented("Payment method".to_string()).into()), + } + } +} + +//TODO: Fill the struct with respective fields +// Auth Struct +pub struct CeleroAuthType { + pub(super) api_key: Secret<String>, +} + +impl TryFrom<&ConnectorAuthType> for CeleroAuthType { + 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)] +#[serde(rename_all = "lowercase")] +pub enum CeleroPaymentStatus { + Succeeded, + Failed, + #[default] + Processing, +} + +impl From<CeleroPaymentStatus> for common_enums::AttemptStatus { + fn from(item: CeleroPaymentStatus) -> Self { + match item { + CeleroPaymentStatus::Succeeded => Self::Charged, + CeleroPaymentStatus::Failed => Self::Failure, + CeleroPaymentStatus::Processing => Self::Authorizing, + } + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] +pub struct CeleroPaymentsResponse { + status: CeleroPaymentStatus, + id: String, +} + +impl<F, T> TryFrom<ResponseRouterData<F, CeleroPaymentsResponse, T, PaymentsResponseData>> + for RouterData<F, T, PaymentsResponseData> +{ + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: ResponseRouterData<F, CeleroPaymentsResponse, T, PaymentsResponseData>, + ) -> Result<Self, Self::Error> { + Ok(Self { + status: common_enums::AttemptStatus::from(item.response.status), + response: Ok(PaymentsResponseData::TransactionResponse { + resource_id: ResponseId::ConnectorTransactionId(item.response.id), + redirection_data: Box::new(None), + mandate_reference: Box::new(None), + connector_metadata: None, + network_txn_id: None, + connector_response_reference_id: None, + incremental_authorization_allowed: None, + charges: None, + }), + ..item.data + }) + } +} + +//TODO: Fill the struct with respective fields +// REFUND : +// Type definition for RefundRequest +#[derive(Default, Debug, Serialize)] +pub struct CeleroRefundRequest { + pub amount: StringMinorUnit, +} + +impl<F> TryFrom<&CeleroRouterData<&RefundsRouterData<F>>> for CeleroRefundRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from(item: &CeleroRouterData<&RefundsRouterData<F>>) -> Result<Self, Self::Error> { + Ok(Self { + amount: item.amount.to_owned(), + }) + } +} + +// Type definition for Refund Response + +#[allow(dead_code)] +#[derive(Debug, Serialize, Default, Deserialize, Clone)] +pub enum RefundStatus { + Succeeded, + Failed, + #[default] + Processing, +} + +impl From<RefundStatus> for enums::RefundStatus { + fn from(item: RefundStatus) -> Self { + match item { + RefundStatus::Succeeded => Self::Success, + RefundStatus::Failed => Self::Failure, + RefundStatus::Processing => Self::Pending, + //TODO: Review mapping + } + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Clone, Serialize, Deserialize)] +pub struct RefundResponse { + id: String, + status: RefundStatus, +} + +impl TryFrom<RefundsResponseRouterData<Execute, RefundResponse>> for RefundsRouterData<Execute> { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: RefundsResponseRouterData<Execute, RefundResponse>, + ) -> Result<Self, Self::Error> { + Ok(Self { + response: Ok(RefundsResponseData { + connector_refund_id: item.response.id.to_string(), + refund_status: enums::RefundStatus::from(item.response.status), + }), + ..item.data + }) + } +} + +impl TryFrom<RefundsResponseRouterData<RSync, RefundResponse>> for RefundsRouterData<RSync> { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: RefundsResponseRouterData<RSync, RefundResponse>, + ) -> Result<Self, Self::Error> { + Ok(Self { + response: Ok(RefundsResponseData { + connector_refund_id: item.response.id.to_string(), + refund_status: enums::RefundStatus::from(item.response.status), + }), + ..item.data + }) + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Serialize, Deserialize, PartialEq)] +pub struct CeleroErrorResponse { + pub status_code: u16, + pub code: String, + pub message: String, + pub reason: Option<String>, +} diff --git a/crates/hyperswitch_connectors/src/default_implementations.rs b/crates/hyperswitch_connectors/src/default_implementations.rs index a338b96bc55..a2a5c163865 100644 --- a/crates/hyperswitch_connectors/src/default_implementations.rs +++ b/crates/hyperswitch_connectors/src/default_implementations.rs @@ -159,6 +159,7 @@ default_imp_for_authorize_session_token!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -283,6 +284,7 @@ default_imp_for_calculate_tax!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -408,6 +410,7 @@ default_imp_for_session_update!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -533,6 +536,7 @@ default_imp_for_post_session_tokens!( connectors::Boku, connectors::Billwerk, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -657,6 +661,7 @@ default_imp_for_create_order!( connectors::Boku, connectors::Billwerk, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -782,6 +787,7 @@ default_imp_for_update_metadata!( connectors::Boku, connectors::Billwerk, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -905,6 +911,7 @@ default_imp_for_complete_authorize!( connectors::Bitpay, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1015,6 +1022,7 @@ default_imp_for_incremental_authorization!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1140,6 +1148,7 @@ default_imp_for_create_customer!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1259,6 +1268,7 @@ default_imp_for_connector_redirect_response!( connectors::Barclaycard, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Coinbase, @@ -1367,6 +1377,7 @@ default_imp_for_pre_processing_steps!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1483,6 +1494,7 @@ default_imp_for_post_processing_steps!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1609,6 +1621,7 @@ default_imp_for_approve!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1736,6 +1749,7 @@ default_imp_for_reject!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1863,6 +1877,7 @@ default_imp_for_webhook_source_verification!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1989,6 +2004,7 @@ default_imp_for_accept_dispute!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Coinbase, @@ -2114,6 +2130,7 @@ default_imp_for_submit_evidence!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Coinbase, @@ -2238,6 +2255,7 @@ default_imp_for_defend_dispute!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Coinbase, @@ -2372,6 +2390,7 @@ default_imp_for_file_upload!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Coinbase, @@ -2488,6 +2507,7 @@ default_imp_for_payouts!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -2608,6 +2628,7 @@ default_imp_for_payouts_create!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -2732,6 +2753,7 @@ default_imp_for_payouts_retrieve!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -2858,6 +2880,7 @@ default_imp_for_payouts_eligibility!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -2982,6 +3005,7 @@ default_imp_for_payouts_fulfill!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -3103,6 +3127,7 @@ default_imp_for_payouts_cancel!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -3228,6 +3253,7 @@ default_imp_for_payouts_quote!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -3354,6 +3380,7 @@ default_imp_for_payouts_recipient!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -3479,6 +3506,7 @@ default_imp_for_payouts_recipient_account!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -3606,6 +3634,7 @@ default_imp_for_frm_sale!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -3733,6 +3762,7 @@ default_imp_for_frm_checkout!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -3860,6 +3890,7 @@ default_imp_for_frm_transaction!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -3987,6 +4018,7 @@ default_imp_for_frm_fulfillment!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -4114,6 +4146,7 @@ default_imp_for_frm_record_return!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -4237,6 +4270,7 @@ default_imp_for_revoking_mandates!( connectors::Bluesnap, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -4360,6 +4394,7 @@ default_imp_for_uas_pre_authentication!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -4484,6 +4519,7 @@ default_imp_for_uas_post_authentication!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -4609,6 +4645,7 @@ default_imp_for_uas_authentication_confirmation!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -4726,6 +4763,7 @@ default_imp_for_connector_request_id!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -4845,6 +4883,7 @@ default_imp_for_fraud_check!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -4994,6 +5033,7 @@ default_imp_for_connector_authentication!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -5116,6 +5156,7 @@ default_imp_for_uas_authentication!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -5233,6 +5274,7 @@ default_imp_for_revenue_recovery!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -5361,6 +5403,7 @@ default_imp_for_billing_connector_payment_sync!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -5488,6 +5531,7 @@ default_imp_for_revenue_recovery_record_back!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Checkbook, connectors::Checkout, connectors::Coinbase, @@ -5613,6 +5657,7 @@ default_imp_for_billing_connector_invoice_sync!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -5733,6 +5778,7 @@ default_imp_for_external_vault!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -5859,6 +5905,7 @@ default_imp_for_external_vault_insert!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -5985,6 +6032,7 @@ default_imp_for_external_vault_retrieve!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -6111,6 +6159,7 @@ default_imp_for_external_vault_delete!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -6237,6 +6286,7 @@ default_imp_for_external_vault_create!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, diff --git a/crates/hyperswitch_connectors/src/default_implementations_v2.rs b/crates/hyperswitch_connectors/src/default_implementations_v2.rs index 99685607c48..2c3e849d4c9 100644 --- a/crates/hyperswitch_connectors/src/default_implementations_v2.rs +++ b/crates/hyperswitch_connectors/src/default_implementations_v2.rs @@ -264,6 +264,7 @@ default_imp_for_new_connector_integration_payment!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -391,6 +392,7 @@ default_imp_for_new_connector_integration_refund!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -513,6 +515,7 @@ default_imp_for_new_connector_integration_connector_access_token!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -641,6 +644,7 @@ default_imp_for_new_connector_integration_accept_dispute!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -767,6 +771,7 @@ default_imp_for_new_connector_integration_submit_evidence!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -893,6 +898,7 @@ default_imp_for_new_connector_integration_defend_dispute!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1030,6 +1036,7 @@ default_imp_for_new_connector_integration_file_upload!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1159,6 +1166,7 @@ default_imp_for_new_connector_integration_payouts_create!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1288,6 +1296,7 @@ default_imp_for_new_connector_integration_payouts_eligibility!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1417,6 +1426,7 @@ default_imp_for_new_connector_integration_payouts_fulfill!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1546,6 +1556,7 @@ default_imp_for_new_connector_integration_payouts_cancel!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1675,6 +1686,7 @@ default_imp_for_new_connector_integration_payouts_quote!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1804,6 +1816,7 @@ default_imp_for_new_connector_integration_payouts_recipient!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -1933,6 +1946,7 @@ default_imp_for_new_connector_integration_payouts_sync!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -2062,6 +2076,7 @@ default_imp_for_new_connector_integration_payouts_recipient_account!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -2189,6 +2204,7 @@ default_imp_for_new_connector_integration_webhook_source_verification!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -2318,6 +2334,7 @@ default_imp_for_new_connector_integration_frm_sale!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -2447,6 +2464,7 @@ default_imp_for_new_connector_integration_frm_checkout!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -2576,6 +2594,7 @@ default_imp_for_new_connector_integration_frm_transaction!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -2705,6 +2724,7 @@ default_imp_for_new_connector_integration_frm_fulfillment!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -2834,6 +2854,7 @@ default_imp_for_new_connector_integration_frm_record_return!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -2960,6 +2981,7 @@ default_imp_for_new_connector_integration_revoking_mandates!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, @@ -3074,6 +3096,7 @@ default_imp_for_new_connector_integration_frm!( connectors::Bluesnap, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Checkbook, connectors::Coinbase, connectors::Cryptopay, @@ -3200,6 +3223,7 @@ default_imp_for_new_connector_integration_connector_authentication!( connectors::Bluesnap, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Checkbook, connectors::Coinbase, connectors::Cryptopay, @@ -3315,6 +3339,7 @@ default_imp_for_new_connector_integration_revenue_recovery!( connectors::Bluesnap, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Checkbook, connectors::Coinbase, connectors::Cryptopay, @@ -3446,6 +3471,7 @@ default_imp_for_new_connector_integration_external_vault!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Celero, connectors::Chargebee, connectors::Checkbook, connectors::Checkout, diff --git a/crates/hyperswitch_domain_models/src/configs.rs b/crates/hyperswitch_domain_models/src/configs.rs index 16fbd3e1d31..89f8ddf673f 100644 --- a/crates/hyperswitch_domain_models/src/configs.rs +++ b/crates/hyperswitch_domain_models/src/configs.rs @@ -29,6 +29,7 @@ pub struct Connectors { pub boku: ConnectorParams, pub braintree: ConnectorParams, pub cashtocode: ConnectorParams, + pub celero: ConnectorParams, pub chargebee: ConnectorParams, pub checkbook: ConnectorParams, pub checkout: ConnectorParams, diff --git a/crates/router/src/connector.rs b/crates/router/src/connector.rs index 4b12c47118b..49aa7c61cd9 100644 --- a/crates/router/src/connector.rs +++ b/crates/router/src/connector.rs @@ -9,31 +9,32 @@ pub use hyperswitch_connectors::connectors::{ bamboraapac::Bamboraapac, bankofamerica, bankofamerica::Bankofamerica, barclaycard, barclaycard::Barclaycard, billwerk, billwerk::Billwerk, bitpay, bitpay::Bitpay, bluesnap, bluesnap::Bluesnap, boku, boku::Boku, braintree, braintree::Braintree, cashtocode, - cashtocode::Cashtocode, chargebee, chargebee::Chargebee, checkbook, checkbook::Checkbook, - checkout, checkout::Checkout, coinbase, coinbase::Coinbase, coingate, coingate::Coingate, - cryptopay, cryptopay::Cryptopay, ctp_mastercard, ctp_mastercard::CtpMastercard, cybersource, - cybersource::Cybersource, datatrans, datatrans::Datatrans, deutschebank, - deutschebank::Deutschebank, digitalvirgo, digitalvirgo::Digitalvirgo, dlocal, dlocal::Dlocal, - dwolla, dwolla::Dwolla, ebanx, ebanx::Ebanx, elavon, elavon::Elavon, facilitapay, - facilitapay::Facilitapay, fiserv, fiserv::Fiserv, fiservemea, fiservemea::Fiservemea, fiuu, - fiuu::Fiuu, forte, forte::Forte, getnet, getnet::Getnet, globalpay, globalpay::Globalpay, - globepay, globepay::Globepay, gocardless, gocardless::Gocardless, gpayments, - gpayments::Gpayments, helcim, helcim::Helcim, hipay, hipay::Hipay, hyperswitch_vault, - hyperswitch_vault::HyperswitchVault, iatapay, iatapay::Iatapay, inespay, inespay::Inespay, - itaubank, itaubank::Itaubank, jpmorgan, jpmorgan::Jpmorgan, juspaythreedsserver, - juspaythreedsserver::Juspaythreedsserver, klarna, klarna::Klarna, mifinity, mifinity::Mifinity, - mollie, mollie::Mollie, moneris, moneris::Moneris, multisafepay, multisafepay::Multisafepay, - netcetera, netcetera::Netcetera, nexinets, nexinets::Nexinets, nexixpay, nexixpay::Nexixpay, - nmi, nmi::Nmi, nomupay, nomupay::Nomupay, noon, noon::Noon, nordea, nordea::Nordea, novalnet, - novalnet::Novalnet, nuvei, nuvei::Nuvei, opayo, opayo::Opayo, opennode, opennode::Opennode, - paybox, paybox::Paybox, payeezy, payeezy::Payeezy, payload, payload::Payload, payme, - payme::Payme, payone, payone::Payone, paypal, paypal::Paypal, paystack, paystack::Paystack, - payu, payu::Payu, placetopay, placetopay::Placetopay, plaid, plaid::Plaid, powertranz, - powertranz::Powertranz, prophetpay, prophetpay::Prophetpay, rapyd, rapyd::Rapyd, razorpay, - razorpay::Razorpay, recurly, recurly::Recurly, redsys, redsys::Redsys, riskified, - riskified::Riskified, santander, santander::Santander, shift4, shift4::Shift4, signifyd, - signifyd::Signifyd, square, square::Square, stax, stax::Stax, stripe, stripe::Stripe, - stripebilling, stripebilling::Stripebilling, taxjar, taxjar::Taxjar, threedsecureio, + cashtocode::Cashtocode, celero, celero::Celero, chargebee, chargebee::Chargebee, checkbook, + checkbook::Checkbook, checkout, checkout::Checkout, coinbase, coinbase::Coinbase, coingate, + coingate::Coingate, cryptopay, cryptopay::Cryptopay, ctp_mastercard, + ctp_mastercard::CtpMastercard, cybersource, cybersource::Cybersource, datatrans, + datatrans::Datatrans, deutschebank, deutschebank::Deutschebank, digitalvirgo, + digitalvirgo::Digitalvirgo, dlocal, dlocal::Dlocal, dwolla, dwolla::Dwolla, ebanx, + ebanx::Ebanx, elavon, elavon::Elavon, facilitapay, facilitapay::Facilitapay, fiserv, + fiserv::Fiserv, fiservemea, fiservemea::Fiservemea, fiuu, fiuu::Fiuu, forte, forte::Forte, + getnet, getnet::Getnet, globalpay, globalpay::Globalpay, globepay, globepay::Globepay, + gocardless, gocardless::Gocardless, gpayments, gpayments::Gpayments, helcim, helcim::Helcim, + hipay, hipay::Hipay, hyperswitch_vault, hyperswitch_vault::HyperswitchVault, iatapay, + iatapay::Iatapay, inespay, inespay::Inespay, itaubank, itaubank::Itaubank, jpmorgan, + jpmorgan::Jpmorgan, juspaythreedsserver, juspaythreedsserver::Juspaythreedsserver, klarna, + klarna::Klarna, mifinity, mifinity::Mifinity, mollie, mollie::Mollie, moneris, + moneris::Moneris, multisafepay, multisafepay::Multisafepay, netcetera, netcetera::Netcetera, + nexinets, nexinets::Nexinets, nexixpay, nexixpay::Nexixpay, nmi, nmi::Nmi, nomupay, + nomupay::Nomupay, noon, noon::Noon, nordea, nordea::Nordea, novalnet, novalnet::Novalnet, + nuvei, nuvei::Nuvei, opayo, opayo::Opayo, opennode, opennode::Opennode, paybox, paybox::Paybox, + payeezy, payeezy::Payeezy, payload, payload::Payload, payme, payme::Payme, payone, + payone::Payone, paypal, paypal::Paypal, paystack, paystack::Paystack, payu, payu::Payu, + placetopay, placetopay::Placetopay, plaid, plaid::Plaid, powertranz, powertranz::Powertranz, + prophetpay, prophetpay::Prophetpay, rapyd, rapyd::Rapyd, razorpay, razorpay::Razorpay, recurly, + recurly::Recurly, redsys, redsys::Redsys, riskified, riskified::Riskified, santander, + santander::Santander, shift4, shift4::Shift4, signifyd, signifyd::Signifyd, square, + square::Square, stax, stax::Stax, stripe, stripe::Stripe, stripebilling, + stripebilling::Stripebilling, taxjar, taxjar::Taxjar, threedsecureio, threedsecureio::Threedsecureio, thunes, thunes::Thunes, tokenio, tokenio::Tokenio, trustpay, trustpay::Trustpay, tsys, tsys::Tsys, unified_authentication_service, unified_authentication_service::UnifiedAuthenticationService, vgs, vgs::Vgs, volt, volt::Volt, diff --git a/crates/router/src/core/connector_validation.rs b/crates/router/src/core/connector_validation.rs index d23a3a175f7..655636197d8 100644 --- a/crates/router/src/core/connector_validation.rs +++ b/crates/router/src/core/connector_validation.rs @@ -136,7 +136,10 @@ impl ConnectorAuthTypeAndMetadataValidation<'_> { } api_enums::Connector::Chargebee => { chargebee::transformers::ChargebeeAuthType::try_from(self.auth_type)?; - chargebee::transformers::ChargebeeMetadata::try_from(self.connector_meta_data)?; + Ok(()) + } + api_enums::Connector::Celero => { + celero::transformers::CeleroAuthType::try_from(self.auth_type)?; Ok(()) } // api_enums::Connector::Checkbook => { diff --git a/crates/router/src/types/api.rs b/crates/router/src/types/api.rs index 3fa8aebf2cf..45d6dd0d75e 100644 --- a/crates/router/src/types/api.rs +++ b/crates/router/src/types/api.rs @@ -372,6 +372,9 @@ impl ConnectorData { enums::Connector::Cashtocode => { Ok(ConnectorEnum::Old(Box::new(connector::Cashtocode::new()))) } + enums::Connector::Celero => { + Ok(ConnectorEnum::Old(Box::new(connector::Celero::new()))) + } enums::Connector::Chargebee => { Ok(ConnectorEnum::Old(Box::new(connector::Chargebee::new()))) } diff --git a/crates/router/src/types/transformers.rs b/crates/router/src/types/transformers.rs index 284a5243d05..713293568b3 100644 --- a/crates/router/src/types/transformers.rs +++ b/crates/router/src/types/transformers.rs @@ -223,6 +223,7 @@ impl ForeignTryFrom<api_enums::Connector> for common_enums::RoutableConnectors { api_enums::Connector::Boku => Self::Boku, api_enums::Connector::Braintree => Self::Braintree, api_enums::Connector::Cashtocode => Self::Cashtocode, + api_enums::Connector::Celero => Self::Celero, api_enums::Connector::Chargebee => Self::Chargebee, // api_enums::Connector::Checkbook => Self::Checkbook, api_enums::Connector::Checkout => Self::Checkout, diff --git a/crates/router/tests/connectors/celero.rs b/crates/router/tests/connectors/celero.rs new file mode 100644 index 00000000000..7d4e942471b --- /dev/null +++ b/crates/router/tests/connectors/celero.rs @@ -0,0 +1,420 @@ +use masking::Secret; +use router::types::{self, api, domain, storage::enums}; +use test_utils::connector_auth; + +use crate::utils::{self, ConnectorActions}; + +#[derive(Clone, Copy)] +struct CeleroTest; +impl ConnectorActions for CeleroTest {} +impl utils::Connector for CeleroTest { + fn get_data(&self) -> api::ConnectorData { + use router::connector::Celero; + utils::construct_connector_data_old( + Box::new(Celero::new()), + types::Connector::Celero, + api::GetToken::Connector, + None, + ) + } + + fn get_auth_token(&self) -> types::ConnectorAuthType { + utils::to_connector_auth_type( + connector_auth::ConnectorAuthentication::new() + .celero + .expect("Missing connector authentication configuration") + .into(), + ) + } + + fn get_name(&self) -> String { + "celero".to_string() + } +} + +static CONNECTOR: CeleroTest = CeleroTest {}; + +fn get_default_payment_info() -> Option<utils::PaymentInfo> { + None +} + +fn payment_method_details() -> Option<types::PaymentsAuthorizeData> { + None +} + +// Cards Positive Tests +// Creates a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_only_authorize_payment() { + let response = CONNECTOR + .authorize_payment(payment_method_details(), get_default_payment_info()) + .await + .expect("Authorize payment response"); + assert_eq!(response.status, enums::AttemptStatus::Authorized); +} + +// Captures a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_capture_authorized_payment() { + let response = CONNECTOR + .authorize_and_capture_payment(payment_method_details(), None, get_default_payment_info()) + .await + .expect("Capture payment response"); + assert_eq!(response.status, enums::AttemptStatus::Charged); +} + +// Partially captures a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_capture_authorized_payment() { + let response = CONNECTOR + .authorize_and_capture_payment( + payment_method_details(), + Some(types::PaymentsCaptureData { + amount_to_capture: 50, + ..utils::PaymentCaptureType::default().0 + }), + get_default_payment_info(), + ) + .await + .expect("Capture payment response"); + assert_eq!(response.status, enums::AttemptStatus::Charged); +} + +// Synchronizes a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_authorized_payment() { + let authorize_response = CONNECTOR + .authorize_payment(payment_method_details(), get_default_payment_info()) + .await + .expect("Authorize payment response"); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + let response = CONNECTOR + .psync_retry_till_status_matches( + enums::AttemptStatus::Authorized, + Some(types::PaymentsSyncData { + connector_transaction_id: types::ResponseId::ConnectorTransactionId( + txn_id.unwrap(), + ), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .expect("PSync response"); + assert_eq!(response.status, enums::AttemptStatus::Authorized,); +} + +// Voids a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_void_authorized_payment() { + let response = CONNECTOR + .authorize_and_void_payment( + payment_method_details(), + Some(types::PaymentsCancelData { + connector_transaction_id: String::from(""), + cancellation_reason: Some("requested_by_customer".to_string()), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .expect("Void payment response"); + assert_eq!(response.status, enums::AttemptStatus::Voided); +} + +// Refunds a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_manually_captured_payment() { + let response = CONNECTOR + .capture_payment_and_refund( + payment_method_details(), + None, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Partially refunds a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_refund_manually_captured_payment() { + let response = CONNECTOR + .capture_payment_and_refund( + payment_method_details(), + None, + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Synchronizes a refund using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_manually_captured_refund() { + let refund_response = CONNECTOR + .capture_payment_and_refund( + payment_method_details(), + None, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + let response = CONNECTOR + .rsync_retry_till_status_matches( + enums::RefundStatus::Success, + refund_response.response.unwrap().connector_refund_id, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Creates a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_make_payment() { + let authorize_response = CONNECTOR + .make_payment(payment_method_details(), get_default_payment_info()) + .await + .unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); +} + +// Synchronizes a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_auto_captured_payment() { + let authorize_response = CONNECTOR + .make_payment(payment_method_details(), get_default_payment_info()) + .await + .unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + assert_ne!(txn_id, None, "Empty connector transaction id"); + let response = CONNECTOR + .psync_retry_till_status_matches( + enums::AttemptStatus::Charged, + Some(types::PaymentsSyncData { + connector_transaction_id: types::ResponseId::ConnectorTransactionId( + txn_id.unwrap(), + ), + capture_method: Some(enums::CaptureMethod::Automatic), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!(response.status, enums::AttemptStatus::Charged,); +} + +// Refunds a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_auto_captured_payment() { + let response = CONNECTOR + .make_payment_and_refund(payment_method_details(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Partially refunds a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_refund_succeeded_payment() { + let refund_response = CONNECTOR + .make_payment_and_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + refund_response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Creates multiple refunds against a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_succeeded_payment_multiple_times() { + CONNECTOR + .make_payment_and_multiple_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await; +} + +// Synchronizes a refund using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_refund() { + let refund_response = CONNECTOR + .make_payment_and_refund(payment_method_details(), None, get_default_payment_info()) + .await + .unwrap(); + let response = CONNECTOR + .rsync_retry_till_status_matches( + enums::RefundStatus::Success, + refund_response.response.unwrap().connector_refund_id, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Cards Negative scenarios +// Creates a payment with incorrect CVC. +#[actix_web::test] +async fn should_fail_payment_for_incorrect_cvc() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: domain::PaymentMethodData::Card(domain::Card { + card_cvc: Secret::new("12345".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's security code is invalid.".to_string(), + ); +} + +// Creates a payment with incorrect expiry month. +#[actix_web::test] +async fn should_fail_payment_for_invalid_exp_month() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: domain::PaymentMethodData::Card(domain::Card { + card_exp_month: Secret::new("20".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's expiration month is invalid.".to_string(), + ); +} + +// Creates a payment with incorrect expiry year. +#[actix_web::test] +async fn should_fail_payment_for_incorrect_expiry_year() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: domain::PaymentMethodData::Card(domain::Card { + card_exp_year: Secret::new("2000".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's expiration year is invalid.".to_string(), + ); +} + +// Voids a payment using automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_fail_void_payment_for_auto_capture() { + let authorize_response = CONNECTOR + .make_payment(payment_method_details(), get_default_payment_info()) + .await + .unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + assert_ne!(txn_id, None, "Empty connector transaction id"); + let void_response = CONNECTOR + .void_payment(txn_id.unwrap(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + void_response.response.unwrap_err().message, + "You cannot cancel this PaymentIntent because it has a status of succeeded." + ); +} + +// Captures a payment using invalid connector payment id. +#[actix_web::test] +async fn should_fail_capture_for_invalid_payment() { + let capture_response = CONNECTOR + .capture_payment("123456789".to_string(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + capture_response.response.unwrap_err().message, + String::from("No such payment_intent: '123456789'") + ); +} + +// Refunds a payment with refund amount higher than payment amount. +#[actix_web::test] +async fn should_fail_for_refund_amount_higher_than_payment_amount() { + let response = CONNECTOR + .make_payment_and_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 150, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Refund amount (₹1.50) is greater than charge amount (₹1.00)", + ); +} + +// Connector dependent test cases goes here + +// [#478]: add unit tests for non 3DS, wallets & webhooks in connector tests diff --git a/crates/router/tests/connectors/main.rs b/crates/router/tests/connectors/main.rs index 90af2bd8d80..10707ba2f4e 100644 --- a/crates/router/tests/connectors/main.rs +++ b/crates/router/tests/connectors/main.rs @@ -23,6 +23,7 @@ mod bitpay; mod bluesnap; mod boku; mod cashtocode; +mod celero; mod chargebee; mod checkbook; mod checkout; diff --git a/crates/test_utils/src/connector_auth.rs b/crates/test_utils/src/connector_auth.rs index fd0f9180910..31141205523 100644 --- a/crates/test_utils/src/connector_auth.rs +++ b/crates/test_utils/src/connector_auth.rs @@ -29,6 +29,7 @@ pub struct ConnectorAuthentication { pub bluesnap: Option<BodyKey>, pub boku: Option<BodyKey>, pub cashtocode: Option<BodyKey>, + pub celero: Option<HeaderKey>, pub chargebee: Option<HeaderKey>, pub checkbook: Option<BodyKey>, pub checkout: Option<SignatureKey>, diff --git a/loadtest/config/development.toml b/loadtest/config/development.toml index 28e3e724c3a..d2c62a57796 100644 --- a/loadtest/config/development.toml +++ b/loadtest/config/development.toml @@ -95,6 +95,7 @@ bluesnap.secondary_base_url = "https://sandpay.bluesnap.com/" boku.base_url = "https://country-api4-stage.boku.com" braintree.base_url = "https://payments.sandbox.braintree-api.com/graphql" cashtocode.base_url = "https://cluster05.api-test.cashtocode.com" +celero.base_url = "https://sandbox.gotnpgateway.com" chargebee.base_url = "https://$.chargebee.com/api/" checkbook.base_url = "https://api.sandbox.checkbook.io" checkout.base_url = "https://api.sandbox.checkout.com/" @@ -225,6 +226,7 @@ cards = [ "bluesnap", "boku", "braintree", + "celero", "checkbook", "checkout", "coinbase", @@ -332,36 +334,36 @@ przelewy24 = { country = "PL", currency = "PLN,EUR" } mifinity = { country = "BR,CN,SG,MY,DE,CH,DK,GB,ES,AD,GI,FI,FR,GR,HR,IT,JP,MX,AR,CO,CL,PE,VE,UY,PY,BO,EC,GT,HN,SV,NI,CR,PA,DO,CU,PR,NL,NO,PL,PT,SE,RU,TR,TW,HK,MO,AX,AL,DZ,AS,AO,AI,AG,AM,AW,AU,AT,AZ,BS,BH,BD,BB,BE,BZ,BJ,BM,BT,BQ,BA,BW,IO,BN,BG,BF,BI,KH,CM,CA,CV,KY,CF,TD,CX,CC,KM,CG,CK,CI,CW,CY,CZ,DJ,DM,EG,GQ,ER,EE,ET,FK,FO,FJ,GF,PF,TF,GA,GM,GE,GH,GL,GD,GP,GU,GG,GN,GW,GY,HT,HM,VA,IS,IN,ID,IE,IM,IL,JE,JO,KZ,KE,KI,KW,KG,LA,LV,LB,LS,LI,LT,LU,MK,MG,MW,MV,ML,MT,MH,MQ,MR,MU,YT,FM,MD,MC,MN,ME,MS,MA,MZ,NA,NR,NP,NC,NZ,NE,NG,NU,NF,MP,OM,PK,PW,PS,PG,PH,PN,QA,RE,RO,RW,BL,SH,KN,LC,MF,PM,VC,WS,SM,ST,SA,SN,RS,SC,SL,SX,SK,SI,SB,SO,ZA,GS,KR,LK,SR,SJ,SZ,TH,TL,TG,TK,TO,TT,TN,TM,TC,TV,UG,UA,AE,UZ,VU,VN,VG,VI,WF,EH,ZM", currency = "AUD,CAD,CHF,CNY,CZK,DKK,EUR,GBP,INR,JPY,NOK,NZD,PLN,RUB,SEK,ZAR,USD,EGP,UYU,UZS" } [pm_filters.globepay] -ali_pay = { country = "GB",currency = "GBP,CNY" } -we_chat_pay = { country = "GB",currency = "GBP,CNY" } +ali_pay = { country = "GB", currency = "GBP,CNY" } +we_chat_pay = { country = "GB", currency = "GBP,CNY" } [pm_filters.itaubank] pix = { country = "BR", currency = "BRL" } [pm_filters.nexinets] -credit = { country = "DE",currency = "EUR" } -debit = { country = "DE",currency = "EUR" } -ideal = { country = "DE",currency = "EUR" } -giropay = { country = "DE",currency = "EUR" } -sofort = { country = "DE",currency = "EUR" } -eps = { country = "DE",currency = "EUR" } -apple_pay = { country = "DE",currency = "EUR" } -paypal = { country = "DE",currency = "EUR" } +credit = { country = "DE", currency = "EUR" } +debit = { country = "DE", currency = "EUR" } +ideal = { country = "DE", currency = "EUR" } +giropay = { country = "DE", currency = "EUR" } +sofort = { country = "DE", currency = "EUR" } +eps = { country = "DE", currency = "EUR" } +apple_pay = { country = "DE", currency = "EUR" } +paypal = { country = "DE", currency = "EUR" } [pm_filters.nuvei] -credit = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US",currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } -debit = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US",currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } -klarna = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US",currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } -afterpay_clearpay = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US",currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } -ideal = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US",currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } -giropay = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US",currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } -sofort = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US",currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } -eps = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US",currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } -apple_pay = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US",currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } -google_pay = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US",currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } -paypal = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US",currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } +credit = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US", currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } +debit = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US", currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } +klarna = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US", currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } +afterpay_clearpay = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US", currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } +ideal = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US", currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } +giropay = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US", currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } +sofort = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US", currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } +eps = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US", currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } +apple_pay = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US", currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } +google_pay = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US", currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } +paypal = { country = "AU,CA,GB,IN,JP,NZ,PH,SG,TH,US", currency = "AED,AMD,ARS,AUD,AZN,BAM,BDT,BGN,BHD,BMD,BND,BRL,BYN,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,GBP,GEL,GHS,GTQ,HKD,HUF,IDR,INR,IQD,ISK,JOD,JPY,KES,KGS,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MMK,MNT,MUR,MWK,MXN,MYR,MZN,NAD,NGN,NOK,NZD,OMR,PEN,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,SAR,SEK,SGD,SOS,THB,TND,TOP,TRY,TTD,TWD,UAH,UGX,USD,UYU,UZS,VND,XAF,YER,ZAR" } [pm_filters.prophetpay] card_redirect = { country = "US", currency = "USD" } @@ -495,16 +497,16 @@ crypto_currency = { country = "US, CA, GB, AU, BR, MX, SG, PH, NZ, ZA, JP, AT, B klarna = { country = "AU,AT,BE,CA,CZ,DK,FI,FR,DE,GR,IE,IT,NL,NZ,NO,PL,PT,ES,SE,CH,GB,US", currency = "CHF,DKK,EUR,GBP,NOK,PLN,SEK,USD,AUD,NZD,CAD" } [pm_filters.bluesnap] -credit = { country = "AD,AE,AG,AL,AM,AO,AR,AT,AU,AZ,BA,BB,BD,BE,BG,BH,BI,BJ,BN,BO,BR,BS,BT,BW,BY,BZ,CA,CD,CF,CG,CH,CI,CL,CM,CN,CO,CR,CV,CY,CZ,DE,DK,DJ,DM,DO,DZ,EC,EE,EG,ER,ES,ET,FI,FJ,FM,FR,GA,GB,GD,GE,GG,GH,GM,GN,GQ,GR,GT,GW,GY,HN,HR,HT,HU,ID,IE,IL,IN,IS,IT,JM,JP,JO,KE,KG,KH,KI,KM,KN,KR,KW,KZ,LA,LB,LC,LI,LK,LR,LS,LT,LU,LV,MA,MC,MD,ME,MG,MH,MK,ML,MM,MN,MR,MT,MU,MV,MW,MX,MY,MZ,NA,NE,NG,NI,NL,NO,NP,NR,NZ,OM,PA,PE,PG,PH,PK,PL,PS,PT,PW,PY,QA,RO,RS,RW,SA,SB,SC,SE,SG,SI,SK,SL,SM,SN,SO,SR,SS,ST,SV,SZ,TD,TG,TH,TJ,TL,TM,TN,TO,TR,TT,TV,TZ,UA,UG,US,UY,UZ,VA,VC,VE,VN,VU,WS,ZA,ZM,ZW", currency = "AED,AFN,ALL,AMD,ANG,ARS,AUD,AWG,BAM,BBD,BGN,BHD,BMD,BND,BOB,BRL,BSD,BWP,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,FJD,GBP,GEL,GIP,GTQ,HKD,HUF,IDR,ILS,INR,ISK,JMD,JPY,KES,KHR,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MUR,MWK,MXN,MYR,NAD,NGN,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PLN,PKR,QAR,RON,RSD,RUB,SAR,SCR,SDG,SEK,SGD,THB,TND,TRY,TTD,TWD,TZS,UAH,USD,UYU,UZS,VND,XAF,XCD,XOF,ZAR"} -google_pay = { country = "AD,AE,AG,AL,AM,AO,AR,AT,AU,AZ,BA,BB,BD,BE,BG,BH,BI,BJ,BN,BO,BR,BS,BT,BW,BY,BZ,CA,CD,CF,CG,CH,CI,CL,CM,CN,CO,CR,CV,CY,CZ,DE,DK,DJ,DM,DO,DZ,EC,EE,EG,ER,ES,ET,FI,FJ,FM,FR,GA,GB,GD,GE,GG,GH,GM,GN,GQ,GR,GT,GW,GY,HN,HR,HT,HU,ID,IE,IL,IN,IS,IT,JM,JP,JO,KE,KG,KH,KI,KM,KN,KR,KW,KZ,LA,LB,LC,LI,LK,LR,LS,LT,LU,LV,MA,MC,MD,ME,MG,MH,MK,ML,MM,MN,MR,MT,MU,MV,MW,MX,MY,MZ,NA,NE,NG,NI,NL,NO,NP,NR,NZ,OM,PA,PE,PG,PH,PK,PL,PS,PT,PW,PY,QA,RO,RS,RW,SA,SB,SC,SE,SG,SI,SK,SL,SM,SN,SO,SR,SS,ST,SV,SZ,TD,TG,TH,TJ,TL,TM,TN,TO,TR,TT,TV,TZ,UA,UG,US,UY,UZ,VA,VC,VE,VN,VU,WS,ZA,ZM,ZW", currency = "AED,AFN,ALL,AMD,ANG,ARS,AUD,AWG,BAM,BBD,BGN,BHD,BMD,BND,BOB,BRL,BSD,BWP,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,FJD,GBP,GEL,GIP,GTQ,HKD,HUF,IDR,ILS,INR,ISK,JMD,JPY,KES,KHR,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MUR,MWK,MXN,MYR,NAD,NGN,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PLN,PKR,QAR,RON,RSD,RUB,SAR,SCR,SDG,SEK,SGD,THB,TND,TRY,TTD,TWD,TZS,UAH,USD,UYU,UZS,VND,XAF,XCD,XOF,ZAR"} -apple_pay = { country = "AD,AE,AG,AL,AM,AO,AR,AT,AU,AZ,BA,BB,BD,BE,BG,BH,BI,BJ,BN,BO,BR,BS,BT,BW,BY,BZ,CA,CD,CF,CG,CH,CI,CL,CM,CN,CO,CR,CV,CY,CZ,DE,DK,DJ,DM,DO,DZ,EC,EE,EG,ER,ES,ET,FI,FJ,FM,FR,GA,GB,GD,GE,GG,GH,GM,GN,GQ,GR,GT,GW,GY,HN,HR,HT,HU,ID,IE,IL,IN,IS,IT,JM,JP,JO,KE,KG,KH,KI,KM,KN,KR,KW,KZ,LA,LB,LC,LI,LK,LR,LS,LT,LU,LV,MA,MC,MD,ME,MG,MH,MK,ML,MM,MN,MR,MT,MU,MV,MW,MX,MY,MZ,NA,NE,NG,NI,NL,NO,NP,NR,NZ,OM,PA,PE,PG,PH,PK,PL,PS,PT,PW,PY,QA,RO,RS,RW,SA,SB,SC,SE,SG,SI,SK,SL,SM,SN,SO,SR,SS,ST,SV,SZ,TD,TG,TH,TJ,TL,TM,TN,TO,TR,TT,TV,TZ,UA,UG,US,UY,UZ,VA,VC,VE,VN,VU,WS,ZA,ZM,ZW", currency = "AED,AFN,ALL,AMD,ANG,ARS,AUD,AWG,BAM,BBD,BGN,BHD,BMD,BND,BOB,BRL,BSD,BWP,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,FJD,GBP,GEL,GIP,GTQ,HKD,HUF,IDR,ILS,INR,ISK,JMD,JPY,KES,KHR,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MUR,MWK,MXN,MYR,NAD,NGN,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PLN,PKR,QAR,RON,RSD,RUB,SAR,SCR,SDG,SEK,SGD,THB,TND,TRY,TTD,TWD,TZS,UAH,USD,UYU,UZS,VND,XAF,XCD,XOF,ZAR"} +credit = { country = "AD,AE,AG,AL,AM,AO,AR,AT,AU,AZ,BA,BB,BD,BE,BG,BH,BI,BJ,BN,BO,BR,BS,BT,BW,BY,BZ,CA,CD,CF,CG,CH,CI,CL,CM,CN,CO,CR,CV,CY,CZ,DE,DK,DJ,DM,DO,DZ,EC,EE,EG,ER,ES,ET,FI,FJ,FM,FR,GA,GB,GD,GE,GG,GH,GM,GN,GQ,GR,GT,GW,GY,HN,HR,HT,HU,ID,IE,IL,IN,IS,IT,JM,JP,JO,KE,KG,KH,KI,KM,KN,KR,KW,KZ,LA,LB,LC,LI,LK,LR,LS,LT,LU,LV,MA,MC,MD,ME,MG,MH,MK,ML,MM,MN,MR,MT,MU,MV,MW,MX,MY,MZ,NA,NE,NG,NI,NL,NO,NP,NR,NZ,OM,PA,PE,PG,PH,PK,PL,PS,PT,PW,PY,QA,RO,RS,RW,SA,SB,SC,SE,SG,SI,SK,SL,SM,SN,SO,SR,SS,ST,SV,SZ,TD,TG,TH,TJ,TL,TM,TN,TO,TR,TT,TV,TZ,UA,UG,US,UY,UZ,VA,VC,VE,VN,VU,WS,ZA,ZM,ZW", currency = "AED,AFN,ALL,AMD,ANG,ARS,AUD,AWG,BAM,BBD,BGN,BHD,BMD,BND,BOB,BRL,BSD,BWP,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,FJD,GBP,GEL,GIP,GTQ,HKD,HUF,IDR,ILS,INR,ISK,JMD,JPY,KES,KHR,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MUR,MWK,MXN,MYR,NAD,NGN,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PLN,PKR,QAR,RON,RSD,RUB,SAR,SCR,SDG,SEK,SGD,THB,TND,TRY,TTD,TWD,TZS,UAH,USD,UYU,UZS,VND,XAF,XCD,XOF,ZAR" } +google_pay = { country = "AD,AE,AG,AL,AM,AO,AR,AT,AU,AZ,BA,BB,BD,BE,BG,BH,BI,BJ,BN,BO,BR,BS,BT,BW,BY,BZ,CA,CD,CF,CG,CH,CI,CL,CM,CN,CO,CR,CV,CY,CZ,DE,DK,DJ,DM,DO,DZ,EC,EE,EG,ER,ES,ET,FI,FJ,FM,FR,GA,GB,GD,GE,GG,GH,GM,GN,GQ,GR,GT,GW,GY,HN,HR,HT,HU,ID,IE,IL,IN,IS,IT,JM,JP,JO,KE,KG,KH,KI,KM,KN,KR,KW,KZ,LA,LB,LC,LI,LK,LR,LS,LT,LU,LV,MA,MC,MD,ME,MG,MH,MK,ML,MM,MN,MR,MT,MU,MV,MW,MX,MY,MZ,NA,NE,NG,NI,NL,NO,NP,NR,NZ,OM,PA,PE,PG,PH,PK,PL,PS,PT,PW,PY,QA,RO,RS,RW,SA,SB,SC,SE,SG,SI,SK,SL,SM,SN,SO,SR,SS,ST,SV,SZ,TD,TG,TH,TJ,TL,TM,TN,TO,TR,TT,TV,TZ,UA,UG,US,UY,UZ,VA,VC,VE,VN,VU,WS,ZA,ZM,ZW", currency = "AED,AFN,ALL,AMD,ANG,ARS,AUD,AWG,BAM,BBD,BGN,BHD,BMD,BND,BOB,BRL,BSD,BWP,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,FJD,GBP,GEL,GIP,GTQ,HKD,HUF,IDR,ILS,INR,ISK,JMD,JPY,KES,KHR,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MUR,MWK,MXN,MYR,NAD,NGN,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PLN,PKR,QAR,RON,RSD,RUB,SAR,SCR,SDG,SEK,SGD,THB,TND,TRY,TTD,TWD,TZS,UAH,USD,UYU,UZS,VND,XAF,XCD,XOF,ZAR" } +apple_pay = { country = "AD,AE,AG,AL,AM,AO,AR,AT,AU,AZ,BA,BB,BD,BE,BG,BH,BI,BJ,BN,BO,BR,BS,BT,BW,BY,BZ,CA,CD,CF,CG,CH,CI,CL,CM,CN,CO,CR,CV,CY,CZ,DE,DK,DJ,DM,DO,DZ,EC,EE,EG,ER,ES,ET,FI,FJ,FM,FR,GA,GB,GD,GE,GG,GH,GM,GN,GQ,GR,GT,GW,GY,HN,HR,HT,HU,ID,IE,IL,IN,IS,IT,JM,JP,JO,KE,KG,KH,KI,KM,KN,KR,KW,KZ,LA,LB,LC,LI,LK,LR,LS,LT,LU,LV,MA,MC,MD,ME,MG,MH,MK,ML,MM,MN,MR,MT,MU,MV,MW,MX,MY,MZ,NA,NE,NG,NI,NL,NO,NP,NR,NZ,OM,PA,PE,PG,PH,PK,PL,PS,PT,PW,PY,QA,RO,RS,RW,SA,SB,SC,SE,SG,SI,SK,SL,SM,SN,SO,SR,SS,ST,SV,SZ,TD,TG,TH,TJ,TL,TM,TN,TO,TR,TT,TV,TZ,UA,UG,US,UY,UZ,VA,VC,VE,VN,VU,WS,ZA,ZM,ZW", currency = "AED,AFN,ALL,AMD,ANG,ARS,AUD,AWG,BAM,BBD,BGN,BHD,BMD,BND,BOB,BRL,BSD,BWP,CAD,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,DZD,EGP,EUR,FJD,GBP,GEL,GIP,GTQ,HKD,HUF,IDR,ILS,INR,ISK,JMD,JPY,KES,KHR,KRW,KWD,KYD,KZT,LBP,LKR,MAD,MDL,MKD,MUR,MWK,MXN,MYR,NAD,NGN,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PLN,PKR,QAR,RON,RSD,RUB,SAR,SCR,SDG,SEK,SGD,THB,TND,TRY,TTD,TWD,TZS,UAH,USD,UYU,UZS,VND,XAF,XCD,XOF,ZAR" } [pm_filters.inespay] -sepa = { country = "ES", currency = "EUR"} +sepa = { country = "ES", currency = "EUR" } [pm_filters.fiserv] -credit = {country = "AU,NZ,CN,HK,IN,LK,KR,MY,SG,GB,BE,FR,DE,IT,ME,NL,PL,ES,ZA,AR,BR,CO,MX,PA,UY,US,CA", currency = "AFN,ALL,DZD,AOA,ARS,AMD,AWG,AUD,AZN,BSD,BHD,BDT,BBD,BYN,BZD,BMD,BTN,BOB,VES,BAM,BWP,BRL,BND,BGN,BIF,KHR,CAD,CVE,KYD,XAF,CLP,CNY,COP,KMF,CDF,CRC,HRK,CUP,CZK,DKK,DJF,DOP,XCD,EGP,ERN,ETB,EUR,FKP,FJD,XPF,GMD,GEL,GHS,GIP,GTQ,GNF,GYD,HTG,HNL,HKD,HUF,ISK,INR,IDR,IRR,IQD,ILS,JMD,JPY,JOD,KZT,KES,KGS,KWD,LAK,LBP,LSL,LRD,LYD,MOP,MKD,MGA,MWK,MYR,MVR,MRU,MUR,MXN,MDL,MNT,MAD,MZN,MMK,NAD,NPR,ANG,NZD,NIO,NGN,VUV,KPW,NOK,OMR,PKR,PAB,PGK,PYG,PEN,PHP,PLN,GBP,QAR,RON,RUB,RWF,SHP,SVC,WST,STN,SAR,RSD,SCR,SLL,SGD,SBD,SOS,ZAR,KRW,SSP,LKR,SDG,SRD,SZL,SEK,CHF,SYP,TWD,TJS,TZS,THB,TOP,TTD,TND,TRY,TMT,UGX,UAH,AED,USD,UYU,UZS,VND,XOF,YER,ZMW,ZWL"} -debit = {country = "AU,NZ,CN,HK,IN,LK,KR,MY,SG,GB,BE,FR,DE,IT,ME,NL,PL,ES,ZA,AR,BR,CO,MX,PA,UY,US,CA", currency = "AFN,ALL,DZD,AOA,ARS,AMD,AWG,AUD,AZN,BSD,BHD,BDT,BBD,BYN,BZD,BMD,BTN,BOB,VES,BAM,BWP,BRL,BND,BGN,BIF,KHR,CAD,CVE,KYD,XAF,CLP,CNY,COP,KMF,CDF,CRC,HRK,CUP,CZK,DKK,DJF,DOP,XCD,EGP,ERN,ETB,EUR,FKP,FJD,XPF,GMD,GEL,GHS,GIP,GTQ,GNF,GYD,HTG,HNL,HKD,HUF,ISK,INR,IDR,IRR,IQD,ILS,JMD,JPY,JOD,KZT,KES,KGS,KWD,LAK,LBP,LSL,LRD,LYD,MOP,MKD,MGA,MWK,MYR,MVR,MRU,MUR,MXN,MDL,MNT,MAD,MZN,MMK,NAD,NPR,ANG,NZD,NIO,NGN,VUV,KPW,NOK,OMR,PKR,PAB,PGK,PYG,PEN,PHP,PLN,GBP,QAR,RON,RUB,RWF,SHP,SVC,WST,STN,SAR,RSD,SCR,SLL,SGD,SBD,SOS,ZAR,KRW,SSP,LKR,SDG,SRD,SZL,SEK,CHF,SYP,TWD,TJS,TZS,THB,TOP,TTD,TND,TRY,TMT,UGX,UAH,AED,USD,UYU,UZS,VND,XOF,YER,ZMW,ZWL"} +credit = { country = "AU,NZ,CN,HK,IN,LK,KR,MY,SG,GB,BE,FR,DE,IT,ME,NL,PL,ES,ZA,AR,BR,CO,MX,PA,UY,US,CA", currency = "AFN,ALL,DZD,AOA,ARS,AMD,AWG,AUD,AZN,BSD,BHD,BDT,BBD,BYN,BZD,BMD,BTN,BOB,VES,BAM,BWP,BRL,BND,BGN,BIF,KHR,CAD,CVE,KYD,XAF,CLP,CNY,COP,KMF,CDF,CRC,HRK,CUP,CZK,DKK,DJF,DOP,XCD,EGP,ERN,ETB,EUR,FKP,FJD,XPF,GMD,GEL,GHS,GIP,GTQ,GNF,GYD,HTG,HNL,HKD,HUF,ISK,INR,IDR,IRR,IQD,ILS,JMD,JPY,JOD,KZT,KES,KGS,KWD,LAK,LBP,LSL,LRD,LYD,MOP,MKD,MGA,MWK,MYR,MVR,MRU,MUR,MXN,MDL,MNT,MAD,MZN,MMK,NAD,NPR,ANG,NZD,NIO,NGN,VUV,KPW,NOK,OMR,PKR,PAB,PGK,PYG,PEN,PHP,PLN,GBP,QAR,RON,RUB,RWF,SHP,SVC,WST,STN,SAR,RSD,SCR,SLL,SGD,SBD,SOS,ZAR,KRW,SSP,LKR,SDG,SRD,SZL,SEK,CHF,SYP,TWD,TJS,TZS,THB,TOP,TTD,TND,TRY,TMT,UGX,UAH,AED,USD,UYU,UZS,VND,XOF,YER,ZMW,ZWL" } +debit = { country = "AU,NZ,CN,HK,IN,LK,KR,MY,SG,GB,BE,FR,DE,IT,ME,NL,PL,ES,ZA,AR,BR,CO,MX,PA,UY,US,CA", currency = "AFN,ALL,DZD,AOA,ARS,AMD,AWG,AUD,AZN,BSD,BHD,BDT,BBD,BYN,BZD,BMD,BTN,BOB,VES,BAM,BWP,BRL,BND,BGN,BIF,KHR,CAD,CVE,KYD,XAF,CLP,CNY,COP,KMF,CDF,CRC,HRK,CUP,CZK,DKK,DJF,DOP,XCD,EGP,ERN,ETB,EUR,FKP,FJD,XPF,GMD,GEL,GHS,GIP,GTQ,GNF,GYD,HTG,HNL,HKD,HUF,ISK,INR,IDR,IRR,IQD,ILS,JMD,JPY,JOD,KZT,KES,KGS,KWD,LAK,LBP,LSL,LRD,LYD,MOP,MKD,MGA,MWK,MYR,MVR,MRU,MUR,MXN,MDL,MNT,MAD,MZN,MMK,NAD,NPR,ANG,NZD,NIO,NGN,VUV,KPW,NOK,OMR,PKR,PAB,PGK,PYG,PEN,PHP,PLN,GBP,QAR,RON,RUB,RWF,SHP,SVC,WST,STN,SAR,RSD,SCR,SLL,SGD,SBD,SOS,ZAR,KRW,SSP,LKR,SDG,SRD,SZL,SEK,CHF,SYP,TWD,TJS,TZS,THB,TOP,TTD,TND,TRY,TMT,UGX,UAH,AED,USD,UYU,UZS,VND,XOF,YER,ZMW,ZWL" } [pm_filters.stax] credit = { country = "US", currency = "USD" } @@ -512,8 +514,8 @@ debit = { country = "US", currency = "USD" } ach = { country = "US", currency = "USD" } [pm_filters.braintree] -credit = { country = "AD,AT,AU,BE,BG,CA,CH,CY,CZ,DE,DK,EE,ES,FI,FR,GB,GG,GI,GR,HK,HR,HU,IE,IM,IT,JE,LI,LT,LU,LV,MT,MC,MY,NL,NO,NZ,PL,PT,RO,SE,SG,SI,SK,SM,US", currency = "AED,AMD,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BIF,BMD,BND,BOB,BRL,BSD,BWP,BYN,BZD,CAD,CHF,CLP,CNY,COP,CRC,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,ISK,JMD,JPY,KES,KGS,KHR,KMF,KRW,KYD,KZT,LAK,LBP,LKR,LRD,LSL,MAD,MDL,MKD,MNT,MOP,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SEK,SGD,SHP,SLL,SOS,SRD,STD,SVC,SYP,SZL,THB,TJS,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VES,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL"} -debit = { country = "AD,AT,AU,BE,BG,CA,CH,CY,CZ,DE,DK,EE,ES,FI,FR,GB,GG,GI,GR,HK,HR,HU,IE,IM,IT,JE,LI,LT,LU,LV,MT,MC,MY,NL,NO,NZ,PL,PT,RO,SE,SG,SI,SK,SM,US", currency = "AED,AMD,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BIF,BMD,BND,BOB,BRL,BSD,BWP,BYN,BZD,CAD,CHF,CLP,CNY,COP,CRC,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,ISK,JMD,JPY,KES,KGS,KHR,KMF,KRW,KYD,KZT,LAK,LBP,LKR,LRD,LSL,MAD,MDL,MKD,MNT,MOP,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SEK,SGD,SHP,SLL,SOS,SRD,STD,SVC,SYP,SZL,THB,TJS,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VES,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL"} +credit = { country = "AD,AT,AU,BE,BG,CA,CH,CY,CZ,DE,DK,EE,ES,FI,FR,GB,GG,GI,GR,HK,HR,HU,IE,IM,IT,JE,LI,LT,LU,LV,MT,MC,MY,NL,NO,NZ,PL,PT,RO,SE,SG,SI,SK,SM,US", currency = "AED,AMD,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BIF,BMD,BND,BOB,BRL,BSD,BWP,BYN,BZD,CAD,CHF,CLP,CNY,COP,CRC,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,ISK,JMD,JPY,KES,KGS,KHR,KMF,KRW,KYD,KZT,LAK,LBP,LKR,LRD,LSL,MAD,MDL,MKD,MNT,MOP,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SEK,SGD,SHP,SLL,SOS,SRD,STD,SVC,SYP,SZL,THB,TJS,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VES,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL" } +debit = { country = "AD,AT,AU,BE,BG,CA,CH,CY,CZ,DE,DK,EE,ES,FI,FR,GB,GG,GI,GR,HK,HR,HU,IE,IM,IT,JE,LI,LT,LU,LV,MT,MC,MY,NL,NO,NZ,PL,PT,RO,SE,SG,SI,SK,SM,US", currency = "AED,AMD,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BIF,BMD,BND,BOB,BRL,BSD,BWP,BYN,BZD,CAD,CHF,CLP,CNY,COP,CRC,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,ISK,JMD,JPY,KES,KGS,KHR,KMF,KRW,KYD,KZT,LAK,LBP,LKR,LRD,LSL,MAD,MDL,MKD,MNT,MOP,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SEK,SGD,SHP,SLL,SOS,SRD,STD,SVC,SYP,SZL,THB,TJS,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VES,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL" } [pm_filters.aci] credit = { country = "AD,AE,AT,BE,BG,CH,CN,CO,CR,CY,CZ,DE,DK,DO,EE,EG,ES,ET,FI,FR,GB,GH,GI,GR,GT,HN,HK,HR,HU,ID,IE,IS,IT,JP,KH,LA,LI,LT,LU,LY,MK,MM,MX,MY,MZ,NG,NZ,OM,PA,PE,PK,PL,PT,QA,RO,SA,SN,SE,SI,SK,SV,TH,UA,US,UY,VN,ZM", currency = "AED,ALL,ARS,BGN,CHF,CLP,CNY,COP,CRC,CZK,DKK,DOP,EGP,EUR,GBP,GHS,HKD,HNL,HRK,HUF,IDR,ILS,ISK,JPY,KHR,KPW,LAK,LKR,MAD,MKD,MMK,MXN,MYR,MZN,NGN,NOK,NZD,OMR,PAB,PEN,PHP,PKR,PLN,QAR,RON,RSD,SAR,SEK,SGD,THB,TRY,TWD,UAH,USD,UYU,VND,ZAR,ZMW" } @@ -523,22 +525,22 @@ ali_pay = { country = "CN", currency = "CNY" } eps = { country = "AT", currency = "EUR" } ideal = { country = "NL", currency = "EUR" } giropay = { country = "DE", currency = "EUR" } -sofort = { country = "AT,BE,CH,DE,ES,GB,IT,NL,PL", currency = "CHF,EUR,GBP,HUF,PLN"} -interac = { country = "CA", currency = "CAD,USD"} +sofort = { country = "AT,BE,CH,DE,ES,GB,IT,NL,PL", currency = "CHF,EUR,GBP,HUF,PLN" } +interac = { country = "CA", currency = "CAD,USD" } przelewy24 = { country = "PL", currency = "CZK,EUR,GBP,PLN" } trustly = { country = "ES,GB,SE,NO,AT,NL,DE,DK,FI,EE,LT,LV", currency = "CZK,DKK,EUR,GBP,NOK,SEK" } klarna = { country = "AU,AT,BE,CA,CZ,DK,FI,FR,DE,GR,IE,IT,NL,NZ,NO,PL,PT,ES,SE,CH,GB,US", currency = "CHF,DKK,EUR,GBP,NOK,PLN,SEK,USD,AUD,NZD,CAD" } [pm_filters.authorizedotnet] -credit = {currency = "CAD,USD"} -debit = {currency = "CAD,USD"} -google_pay = {currency = "CHF,DKK,EUR,GBP,NOK,PLN,SEK,USD,AUD,NZD,CAD"} -apple_pay = {currency = "EUR,GBP,ISK,USD,AUD,CAD,BRL,CLP,COP,CRC,CZK,DKK,EGP,GEL,GHS,GTQ,HNL,HKD,HUF,ILS,INR,JPY,KZT,KRW,KWD,MAD,MXN,MYR,NOK,NZD,PEN,PLN,PYG,QAR,RON,SAR,SEK,SGD,THB,TWD,UAH,AED,VND,ZAR"} -paypal = {currency = "AUD,BRL,CAD,CHF,CNY,CZK,DKK,EUR,GBP,HKD,HUF,ILS,JPY,MXN,MYR,NOK,NZD,PHP,PLN,SEK,SGD,THB,TWD,USD"} +credit = { currency = "CAD,USD" } +debit = { currency = "CAD,USD" } +google_pay = { currency = "CHF,DKK,EUR,GBP,NOK,PLN,SEK,USD,AUD,NZD,CAD" } +apple_pay = { currency = "EUR,GBP,ISK,USD,AUD,CAD,BRL,CLP,COP,CRC,CZK,DKK,EGP,GEL,GHS,GTQ,HNL,HKD,HUF,ILS,INR,JPY,KZT,KRW,KWD,MAD,MXN,MYR,NOK,NZD,PEN,PLN,PYG,QAR,RON,SAR,SEK,SGD,THB,TWD,UAH,AED,VND,ZAR" } +paypal = { currency = "AUD,BRL,CAD,CHF,CNY,CZK,DKK,EUR,GBP,HKD,HUF,ILS,JPY,MXN,MYR,NOK,NZD,PHP,PLN,SEK,SGD,THB,TWD,USD" } [pm_filters.forte] -credit = { country = "US, CA", currency = "CAD,USD"} -debit = { country = "US, CA", currency = "CAD,USD"} +credit = { country = "US, CA", currency = "CAD,USD" } +debit = { country = "US, CA", currency = "CAD,USD" } [pm_filters.fiuu] duit_now = { country = "MY", currency = "MYR" } @@ -549,8 +551,8 @@ credit = { country = "CN,HK,ID,MY,PH,SG,TH,TW,VN", currency = "CNY,HKD,IDR,MYR,P debit = { country = "CN,HK,ID,MY,PH,SG,TH,TW,VN", currency = "CNY,HKD,IDR,MYR,PHP,SGD,THB,TWD,VND" } [pm_filters.placetopay] -credit = { country = "BE,CH,CO,CR,EC,HN,MX,PA,PR,UY", currency = "CLP,COP,USD"} -debit = { country = "BE,CH,CO,CR,EC,HN,MX,PA,PR,UY", currency = "CLP,COP,USD"} +credit = { country = "BE,CH,CO,CR,EC,HN,MX,PA,PR,UY", currency = "CLP,COP,USD" } +debit = { country = "BE,CH,CO,CR,EC,HN,MX,PA,PR,UY", currency = "CLP,COP,USD" } [pm_filters.coingate] crypto_currency = { country = "AL, AD, AT, BE, BA, BG, HR, CZ, DK, EE, FI, FR, DE, GR, HU, IS, IE, IT, LV, LT, LU, MT, MD, NL, NO, PL, PT, RO, RS, SK, SI, ES, SE, CH, UA, GB, AR, BR, CL, CO, CR, DO, SV, GD, MX, PE, LC, AU, NZ, CY, HK, IN, IL, JP, KR, QA, SA, SG, EG", currency = "EUR, USD, GBP" } @@ -704,4 +706,4 @@ redsys = { payment_method = "card" } [billing_connectors_payment_sync] billing_connectors_which_require_payment_sync = "stripebilling, recurly" [billing_connectors_invoice_sync] -billing_connectors_which_requires_invoice_sync_call = "recurly" \ No newline at end of file +billing_connectors_which_requires_invoice_sync_call = "recurly" diff --git a/scripts/add_connector.sh b/scripts/add_connector.sh index 534c1614a5e..648d2e68993 100755 --- a/scripts/add_connector.sh +++ b/scripts/add_connector.sh @@ -6,7 +6,7 @@ function find_prev_connector() { git checkout $self cp $self $self.tmp # Add new connector to existing list and sort it - connectors=(aci adyen adyenplatform airwallex amazonpay applepay archipel authorizedotnet bambora bamboraapac bankofamerica barclaycard billwerk bitpay bluesnap boku braintree cashtocode chargebee checkbook checkout coinbase cryptopay ctp_visa cybersource datatrans deutschebank digitalvirgo dlocal dummyconnector dwolla ebanx elavon facilitapay fiserv fiservemea fiuu forte getnet globalpay globepay gocardless gpayments helcim hipay hyperswitch_vault iatapay inespay itaubank jpmorgan juspaythreedsserver klarna mifinity mollie moneris multisafepay netcetera nexinets nexixpay nomupay noon nordea novalnet nuvei opayo opennode paybox payeezy payload payme payone paypal paystack payu placetopay plaid powertranz prophetpay rapyd razorpay recurly redsys santander shift4 square stax stripe stripebilling taxjar threedsecureio thunes tokenio trustpay tsys unified_authentication_service vgs volt wellsfargo wellsfargopayout wise worldline worldpay worldpayvantiv worldpayxml xendit zsl "$1") + connectors=(aci adyen adyenplatform airwallex amazonpay applepay archipel authorizedotnet bambora bamboraapac bankofamerica barclaycard billwerk bitpay bluesnap boku braintree cashtocode celero chargebee checkbook checkout coinbase cryptopay ctp_visa cybersource datatrans deutschebank digitalvirgo dlocal dummyconnector dwolla ebanx elavon facilitapay fiserv fiservemea fiuu forte getnet globalpay globepay gocardless gpayments helcim hipay hyperswitch_vault iatapay inespay itaubank jpmorgan juspaythreedsserver klarna mifinity mollie moneris multisafepay netcetera nexinets nexixpay nomupay noon nordea novalnet nuvei opayo opennode paybox payeezy payload payme payone paypal paystack payu placetopay plaid powertranz prophetpay rapyd razorpay recurly redsys santander shift4 square stax stripe stripebilling taxjar threedsecureio thunes tokenio trustpay tsys unified_authentication_service vgs volt wellsfargo wellsfargopayout wise worldline worldpay worldpayvantiv worldpayxml xendit zsl "$1") IFS=$'\n' sorted=($(sort <<<"${connectors[*]}")); unset IFS res="$(echo ${sorted[@]})" sed -i'' -e "s/^ connectors=.*/ connectors=($res \"\$1\")/" $self.tmp

2025-06-30T08:05:39Z

## Type of Change  - [ ] Bugfix - [x] New feature - [ ] Enhancement - [x] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  Template new connection integration `celero` ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  ## How did you test it?  No testing required as this is template ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [ ] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

9d7edb5cee030a13c8699a914a0d3600b058853d

juspay/hyperswitch

juspay__hyperswitch-8497

Bug: chore: address Rust 1.88.0 clippy lints Address the clippy lints occurring due to new rust version 1.88.0 See https://github.com/juspay/hyperswitch/issues/3391 for more information.

diff --git a/crates/router/src/core/payment_methods/vault.rs b/crates/router/src/core/payment_methods/vault.rs index c59a2f84c35..d5848c7f418 100644 --- a/crates/router/src/core/payment_methods/vault.rs +++ b/crates/router/src/core/payment_methods/vault.rs @@ -1555,10 +1555,7 @@ pub async fn insert_cvc_using_payment_token( .change_context(errors::ApiErrorResponse::InternalServerError) .attach_printable("Failed to get redis connection")?; - let key = format!( - "pm_token_{}_{}_hyperswitch_cvc", - payment_token, payment_method - ); + let key = format!("pm_token_{payment_token}_{payment_method}_hyperswitch_cvc"); let payload_to_be_encrypted = TemporaryVaultCvc { card_cvc }; @@ -1601,10 +1598,7 @@ pub async fn retrieve_and_delete_cvc_from_payment_token( .change_context(errors::ApiErrorResponse::InternalServerError) .attach_printable("Failed to get redis connection")?; - let key = format!( - "pm_token_{}_{}_hyperswitch_cvc", - payment_token, payment_method - ); + let key = format!("pm_token_{payment_token}_{payment_method}_hyperswitch_cvc"); let data = redis_conn .get_key::<bytes::Bytes>(&key.clone().into()) diff --git a/crates/router/src/core/unified_connector_service.rs b/crates/router/src/core/unified_connector_service.rs index d9c00fbadba..3cdcb28d4d8 100644 --- a/crates/router/src/core/unified_connector_service.rs +++ b/crates/router/src/core/unified_connector_service.rs @@ -101,8 +101,7 @@ pub fn build_unified_connector_service_payment_method( } _ => { return Err(UnifiedConnectorServiceError::NotImplemented(format!( - "Unimplemented card payment method type: {:?}", - payment_method_type + "Unimplemented card payment method type: {payment_method_type:?}" )) .into()); }

2025-07-10T13:43:08Z

## Type of Change  - [ ] Bugfix - [ ] New feature - [ ] Enhancement - [x] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  This pull request includes a minor improvement to error message formatting in the `build_unified_connector_service_payment_method` function. * [`crates/router/src/core/unified_connector_service.rs`](diffhunk://#diff-b8e808846f58e455687a9e192c1c8d192598081aac942628640c42c1d397dfaeL104-R104): Updated the error message to use inline formatting for `payment_method_type`, improving readability and consistency. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  ## How did you test it?  ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

1b08de652f6b0f3c08374d0806c8999f4b73ec2f

juspay/hyperswitch

juspay__hyperswitch-8467

Bug: [FEATURE] multisafepay : addpayment methods | TRUSTLY | WeChatpay | Alipay ### Feature Description Integrate 1. Turstly 2. WeChatPay 3. Alipay ### Possible Implementation Integrate the redirection flows for the wallet ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? Yes, I am willing to submit a PR!

diff --git a/config/deployments/integration_test.toml b/config/deployments/integration_test.toml index 513cb587176..e04583cbfb5 100644 --- a/config/deployments/integration_test.toml +++ b/config/deployments/integration_test.toml @@ -541,6 +541,9 @@ paypal = { country = "AF,AX,AL,DZ,AS,AD,AO,AI,AQ,AG,AR,AM,AW,AU,AT,AZ,BS,BH,BD,B giropay = { country = "DE", currency = "EUR" } ideal = { country = "NL", currency = "EUR" } klarna = { country = "AT,BE,DK,FI,FR,DE,IT,NL,NO,PT,ES,SE,GB", currency = "DKK,EUR,GBP,NOK,SEK" } +trustly = { country = "AT,CZ,DK,EE,FI,DE,LV,LT,NL,NO,PL,PT,ES,SE,GB" , currency = "EUR,GBP,SEK"} +ali_pay = {currency = "EUR,USD"} +we_chat_pay = { currency = "EUR"} [pm_filters.cashtocode] classic = { country = "AF,AX,AL,DZ,AS,AD,AO,AI,AQ,AG,AR,AM,AW,AU,AT,AZ,BS,BH,BD,BB,BY,BE,BZ,BJ,BM,BT,BO,BQ,BA,BW,BV,BR,IO,BN,BG,BF,BI,KH,CM,CA,CV,KY,CF,TD,CL,CN,CX,CC,CO,KM,CG,CD,CK,CR,CI,HR,CU,CW,CY,CZ,DK,DJ,DM,DO,EC,EG,SV,GQ,ER,EE,ET,FK,FO,FJ,FI,FR,GF,PF,TF,GA,GM,GE,DE,GH,GI,GR,GL,GD,GP,GU,GT,GG,GN,GW,GY,HT,HM,VA,HN,HK,HU,IS,IN,ID,IR,IQ,IE,IM,IL,IT,JM,JP,JE,JO,KZ,KE,KI,KP,KR,KW,KG,LA,LV,LB,LS,LR,LY,LI,LT,LU,MO,MK,MG,MW,MY,MV,ML,MT,MH,MQ,MR,MU,YT,MX,FM,MD,MC,MN,ME,MS,MA,MZ,MM,NA,NR,NP,NL,NC,NZ,NI,NE,NG,NU,NF,MP,NO,OM,PK,PW,PS,PA,PG,PY,PE,PH,PN,PL,PT,PR,QA,RE,RO,RU,RW,BL,SH,KN,LC,MF,PM,VC,WS,SM,ST,SA,SN,RS,SC,SL,SG,SX,SK,SI,SB,SO,ZA,GS,SS,ES,LK,SD,SR,SJ,SZ,SE,CH,SY,TW,TJ,TZ,TH,TL,TG,TK,TO,TT,TN,TR,TM,TC,TV,UG,UA,AE,GB,UM,UY,UZ,VU,VE,VN,VG,VI,WF,EH,YE,ZM,ZW,US", currency = "AED,AFN,ALL,AMD,ANG,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BHD,BIF,BMD,BND,BOB,BRL,BSD,BTN,BWP,BYN,BZD,CAD,CDF,CHF,CLF,CLP,CNY,COP,CRC,CUC,CUP,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ERN,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,IQD,IRR,ISK,JMD,JOD,JPY,KES,KGS,KHR,KMF,KPW,KRW,KWD,KYD,KZT,LAK,LBP,LKR,LRD,LSL,LYD,MAD,MDL,MGA,MKD,MMK,MNT,MOP,MRU,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SDG,SEK,SGD,SHP,SLE,SLL,SOS,SRD,SSP,STD,STN,SVC,SYP,SZL,THB,TJS,TMT,TND,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VES,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL" } diff --git a/config/deployments/production.toml b/config/deployments/production.toml index 4b990ad0464..eba6e2334b7 100644 --- a/config/deployments/production.toml +++ b/config/deployments/production.toml @@ -524,6 +524,9 @@ paypal = { country = "AF,AX,AL,DZ,AS,AD,AO,AI,AQ,AG,AR,AM,AW,AU,AT,AZ,BS,BH,BD,B giropay = { country = "DE", currency = "EUR" } ideal = { country = "NL", currency = "EUR" } klarna = { country = "AT,BE,DK,FI,FR,DE,IT,NL,NO,PT,ES,SE,GB", currency = "DKK,EUR,GBP,NOK,SEK" } +trustly = { country = "AT,CZ,DK,EE,FI,DE,LV,LT,NL,NO,PL,PT,ES,SE,GB" , currency = "EUR,GBP,SEK"} +ali_pay = {currency = "EUR,USD"} +we_chat_pay = { currency = "EUR"} [pm_filters.cashtocode] classic = { country = "AF,AX,AL,DZ,AS,AD,AO,AI,AQ,AG,AR,AM,AW,AU,AT,AZ,BS,BH,BD,BB,BY,BE,BZ,BJ,BM,BT,BO,BQ,BA,BW,BV,BR,IO,BN,BG,BF,BI,KH,CM,CA,CV,KY,CF,TD,CL,CN,CX,CC,CO,KM,CG,CD,CK,CR,CI,HR,CU,CW,CY,CZ,DK,DJ,DM,DO,EC,EG,SV,GQ,ER,EE,ET,FK,FO,FJ,FI,FR,GF,PF,TF,GA,GM,GE,DE,GH,GI,GR,GL,GD,GP,GU,GT,GG,GN,GW,GY,HT,HM,VA,HN,HK,HU,IS,IN,ID,IR,IQ,IE,IM,IL,IT,JM,JP,JE,JO,KZ,KE,KI,KP,KR,KW,KG,LA,LV,LB,LS,LR,LY,LI,LT,LU,MO,MK,MG,MW,MY,MV,ML,MT,MH,MQ,MR,MU,YT,MX,FM,MD,MC,MN,ME,MS,MA,MZ,MM,NA,NR,NP,NL,NC,NZ,NI,NE,NG,NU,NF,MP,NO,OM,PK,PW,PS,PA,PG,PY,PE,PH,PN,PL,PT,PR,QA,RE,RO,RU,RW,BL,SH,KN,LC,MF,PM,VC,WS,SM,ST,SA,SN,RS,SC,SL,SG,SX,SK,SI,SB,SO,ZA,GS,SS,ES,LK,SD,SR,SJ,SZ,SE,CH,SY,TW,TJ,TZ,TH,TL,TG,TK,TO,TT,TN,TR,TM,TC,TV,UG,UA,AE,GB,UM,UY,UZ,VU,VE,VN,VG,VI,WF,EH,YE,ZM,ZW,US", currency = "AED,AFN,ALL,AMD,ANG,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BHD,BIF,BMD,BND,BOB,BRL,BSD,BTN,BWP,BYN,BZD,CAD,CDF,CHF,CLF,CLP,CNY,COP,CRC,CUC,CUP,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ERN,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,IQD,IRR,ISK,JMD,JOD,JPY,KES,KGS,KHR,KMF,KPW,KRW,KWD,KYD,KZT,LAK,LBP,LKR,LRD,LSL,LYD,MAD,MDL,MGA,MKD,MMK,MNT,MOP,MRU,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SDG,SEK,SGD,SHP,SLE,SLL,SOS,SRD,SSP,STD,STN,SVC,SYP,SZL,THB,TJS,TMT,TND,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VES,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL" } diff --git a/config/deployments/sandbox.toml b/config/deployments/sandbox.toml index d00b12c751f..ac5442fcdd6 100644 --- a/config/deployments/sandbox.toml +++ b/config/deployments/sandbox.toml @@ -532,6 +532,9 @@ google_pay = { country = "AF,AX,AL,DZ,AS,AD,AO,AI,AQ,AG,AR,AM,AW,AU,AT,AZ,BS,BH, paypal = { country = "AF,AX,AL,DZ,AS,AD,AO,AI,AQ,AG,AR,AM,AW,AU,AT,AZ,BS,BH,BD,BB,BY,BE,BZ,BJ,BM,BT,BO,BQ,BA,BW,BV,BR,IO,BN,BG,BF,BI,CV,KH,CM,CA,KY,CF,TD,CL,CN,CX,CC,CO,KM,CG,CD,CK,CR,CI,HR,CU,CW,CY,CZ,DK,DJ,DM,DO,EC,EG,SV,GQ,ER,EE,ET,FK,FO,FJ,FI,FR,GF,PF,TF,GA,GM,GE,DE,GH,GI,GR,GL,GD,GP,GU,GT,GG,GN,GW,GY,HT,HM,VA,HN,HK,HU,IS,IN,ID,IR,IQ,IE,IM,IL,IT,JM,JP,JE,JO,KZ,KE,KI,KP,KR,KW,KG,LA,LV,LB,LS,LR,LY,LI,LT,LU,MO,MK,MG,MW,MY,MV,ML,MT,MH,MQ,MR,MU,YT,MX,FM,MD,MC,MN,ME,MS,MA,MZ,MM,NA,NR,NP,NL,NC,NZ,NI,NE,NG,NU,NF,MP,NO,OM,PK,PW,PS,PA,PG,PY,PE,PH,PN,PL,PT,PR,QA,RE,RO,RU,RW,BL,SH,KN,LC,MF,PM,VC,WS,SM,ST,SA,SN,RS,SC,SL,SG,SX,SK,SI,SB,SO,ZA,GS,SS,ES,LK,SD,SR,SJ,SZ,SE,CH,SY,TW,TJ,TZ,TH,TL,TG,TK,TO,TT,TN,TR,TM,TC,TV,UG,UA,AE,GB,US,UM,UY,UZ,VU,VE,VN,VG,VI,WF,EH,YE,ZM,ZW", currency = "AUD,BRL,CAD,CHF,CZK,DKK,EUR,GBP,HKD,HRK,HUF,JPY,MXN,MYR,NOK,NZD,PHP,PLN,RUB,SEK,SGD,THB,TRY,TWD,USD" } ideal = { country = "NL", currency = "EUR" } klarna = { country = "AT,BE,DK,FI,FR,DE,IT,NL,NO,PT,ES,SE,GB", currency = "DKK,EUR,GBP,NOK,SEK" } +trustly = { country = "AT,CZ,DK,EE,FI,DE,LV,LT,NL,NO,PL,PT,ES,SE,GB" , currency = "EUR,GBP,SEK"} +ali_pay = {currency = "EUR,USD"} +we_chat_pay = { currency = "EUR"} [pm_filters.cashtocode] classic = { country = "AF,AX,AL,DZ,AS,AD,AO,AI,AQ,AG,AR,AM,AW,AU,AT,AZ,BS,BH,BD,BB,BY,BE,BZ,BJ,BM,BT,BO,BQ,BA,BW,BV,BR,IO,BN,BG,BF,BI,KH,CM,CA,CV,KY,CF,TD,CL,CN,CX,CC,CO,KM,CG,CD,CK,CR,CI,HR,CU,CW,CY,CZ,DK,DJ,DM,DO,EC,EG,SV,GQ,ER,EE,ET,FK,FO,FJ,FI,FR,GF,PF,TF,GA,GM,GE,DE,GH,GI,GR,GL,GD,GP,GU,GT,GG,GN,GW,GY,HT,HM,VA,HN,HK,HU,IS,IN,ID,IR,IQ,IE,IM,IL,IT,JM,JP,JE,JO,KZ,KE,KI,KP,KR,KW,KG,LA,LV,LB,LS,LR,LY,LI,LT,LU,MO,MK,MG,MW,MY,MV,ML,MT,MH,MQ,MR,MU,YT,MX,FM,MD,MC,MN,ME,MS,MA,MZ,MM,NA,NR,NP,NL,NC,NZ,NI,NE,NG,NU,NF,MP,NO,OM,PK,PW,PS,PA,PG,PY,PE,PH,PN,PL,PT,PR,QA,RE,RO,RU,RW,BL,SH,KN,LC,MF,PM,VC,WS,SM,ST,SA,SN,RS,SC,SL,SG,SX,SK,SI,SB,SO,ZA,GS,SS,ES,LK,SD,SR,SJ,SZ,SE,CH,SY,TW,TJ,TZ,TH,TL,TG,TK,TO,TT,TN,TR,TM,TC,TV,UG,UA,AE,GB,UM,UY,UZ,VU,VE,VN,VG,VI,WF,EH,YE,ZM,ZW,US", currency = "AED,AFN,ALL,AMD,ANG,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BHD,BIF,BMD,BND,BOB,BRL,BSD,BTN,BWP,BYN,BZD,CAD,CDF,CHF,CLF,CLP,CNY,COP,CRC,CUC,CUP,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ERN,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,IQD,IRR,ISK,JMD,JOD,JPY,KES,KGS,KHR,KMF,KPW,KRW,KWD,KYD,KZT,LAK,LBP,LKR,LRD,LSL,LYD,MAD,MDL,MGA,MKD,MMK,MNT,MOP,MRU,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SDG,SEK,SGD,SHP,SLE,SLL,SOS,SRD,SSP,STD,STN,SVC,SYP,SZL,THB,TJS,TMT,TND,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VES,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL" } diff --git a/config/development.toml b/config/development.toml index 95484d6b014..d85f36cef18 100644 --- a/config/development.toml +++ b/config/development.toml @@ -728,6 +728,9 @@ paypal = { country = "AF,AX,AL,DZ,AS,AD,AO,AI,AQ,AG,AR,AM,AW,AU,AT,AZ,BS,BH,BD,B giropay = { country = "DE", currency = "EUR" } ideal = { country = "NL", currency = "EUR" } klarna = { country = "AT,BE,DK,FI,FR,DE,IT,NL,NO,PT,ES,SE,GB", currency = "DKK,EUR,GBP,NOK,SEK" } +trustly = { country = "AT,CZ,DK,EE,FI,DE,LV,LT,NL,NO,PL,PT,ES,SE,GB" , currency = "EUR,GBP,SEK"} +ali_pay = { currency = "EUR,USD" } +we_chat_pay = { currency = "EUR"} [pm_filters.cashtocode] classic = { country = "AF,AX,AL,DZ,AS,AD,AO,AI,AQ,AG,AR,AM,AW,AU,AT,AZ,BS,BH,BD,BB,BY,BE,BZ,BJ,BM,BT,BO,BQ,BA,BW,BV,BR,IO,BN,BG,BF,BI,KH,CM,CA,CV,KY,CF,TD,CL,CN,CX,CC,CO,KM,CG,CD,CK,CR,CI,HR,CU,CW,CY,CZ,DK,DJ,DM,DO,EC,EG,SV,GQ,ER,EE,ET,FK,FO,FJ,FI,FR,GF,PF,TF,GA,GM,GE,DE,GH,GI,GR,GL,GD,GP,GU,GT,GG,GN,GW,GY,HT,HM,VA,HN,HK,HU,IS,IN,ID,IR,IQ,IE,IM,IL,IT,JM,JP,JE,JO,KZ,KE,KI,KP,KR,KW,KG,LA,LV,LB,LS,LR,LY,LI,LT,LU,MO,MK,MG,MW,MY,MV,ML,MT,MH,MQ,MR,MU,YT,MX,FM,MD,MC,MN,ME,MS,MA,MZ,MM,NA,NR,NP,NL,NC,NZ,NI,NE,NG,NU,NF,MP,NO,OM,PK,PW,PS,PA,PG,PY,PE,PH,PN,PL,PT,PR,QA,RE,RO,RU,RW,BL,SH,KN,LC,MF,PM,VC,WS,SM,ST,SA,SN,RS,SC,SL,SG,SX,SK,SI,SB,SO,ZA,GS,SS,ES,LK,SD,SR,SJ,SZ,SE,CH,SY,TW,TJ,TZ,TH,TL,TG,TK,TO,TT,TN,TR,TM,TC,TV,UG,UA,AE,GB,UM,UY,UZ,VU,VE,VN,VG,VI,WF,EH,YE,ZM,ZW,US", currency = "AED,AFN,ALL,AMD,ANG,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BHD,BIF,BMD,BND,BOB,BRL,BSD,BTN,BWP,BYN,BZD,CAD,CDF,CHF,CLF,CLP,CNY,COP,CRC,CUC,CUP,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ERN,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,IQD,IRR,ISK,JMD,JOD,JPY,KES,KGS,KHR,KMF,KPW,KRW,KWD,KYD,KZT,LAK,LBP,LKR,LRD,LSL,LYD,MAD,MDL,MGA,MKD,MMK,MNT,MOP,MRU,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SDG,SEK,SGD,SHP,SLE,SLL,SOS,SRD,SSP,STD,STN,SVC,SYP,SZL,THB,TJS,TMT,TND,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VES,VND,VUV,WST,XAF,XCD,XOF,XPF,YER,ZAR,ZMW,ZWL" } diff --git a/crates/hyperswitch_connectors/src/connectors/multisafepay.rs b/crates/hyperswitch_connectors/src/connectors/multisafepay.rs index f2fc62d6cbf..08e76940237 100644 --- a/crates/hyperswitch_connectors/src/connectors/multisafepay.rs +++ b/crates/hyperswitch_connectors/src/connectors/multisafepay.rs @@ -634,6 +634,27 @@ static MULTISAFEPAY_SUPPORTED_PAYMENT_METHODS: LazyLock<SupportedPaymentMethods> }, ); + multisafepay_supported_payment_methods.add( + enums::PaymentMethod::Wallet, + enums::PaymentMethodType::AliPay, + PaymentMethodDetails { + mandates: enums::FeatureStatus::NotSupported, + refunds: enums::FeatureStatus::Supported, + supported_capture_methods: supported_capture_methods.clone(), + specific_features: None, + }, + ); + multisafepay_supported_payment_methods.add( + enums::PaymentMethod::Wallet, + enums::PaymentMethodType::WeChatPay, + PaymentMethodDetails { + mandates: enums::FeatureStatus::NotSupported, + refunds: enums::FeatureStatus::Supported, + supported_capture_methods: supported_capture_methods.clone(), + specific_features: None, + }, + ); + multisafepay_supported_payment_methods.add( enums::PaymentMethod::BankRedirect, enums::PaymentMethodType::Giropay, @@ -644,6 +665,16 @@ static MULTISAFEPAY_SUPPORTED_PAYMENT_METHODS: LazyLock<SupportedPaymentMethods> specific_features: None, }, ); + multisafepay_supported_payment_methods.add( + enums::PaymentMethod::BankRedirect, + enums::PaymentMethodType::Trustly, + PaymentMethodDetails { + mandates: enums::FeatureStatus::NotSupported, + refunds: enums::FeatureStatus::Supported, + supported_capture_methods: supported_capture_methods.clone(), + specific_features: None, + }, + ); multisafepay_supported_payment_methods.add( enums::PaymentMethod::BankRedirect, diff --git a/crates/hyperswitch_connectors/src/connectors/multisafepay/transformers.rs b/crates/hyperswitch_connectors/src/connectors/multisafepay/transformers.rs index c7cc7967c4c..bcdbd7e28e6 100644 --- a/crates/hyperswitch_connectors/src/connectors/multisafepay/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/multisafepay/transformers.rs @@ -66,6 +66,10 @@ pub enum Gateway { Paypal, Ideal, Giropay, + Trustly, + Alipay, + #[serde(rename = "WECHAT")] + WeChatPay, } #[serde_with::skip_serializing_none] @@ -183,14 +187,24 @@ pub enum GatewayInfo { #[serde(untagged)] pub enum WalletInfo { GooglePay(GpayInfo), + Alipay(AlipayInfo), + WeChatPay(WeChatPayInfo), } +#[derive(Debug, Clone, Serialize, Eq, PartialEq)] +pub struct WeChatPayInfo {} + +#[derive(Debug, Clone, Serialize, Eq, PartialEq)] +pub struct AlipayInfo {} + #[derive(Clone, Debug, Eq, PartialEq, Serialize)] #[serde(untagged)] pub enum BankRedirectInfo { Ideal(IdealInfo), + Trustly(TrustlyInfo), } - +#[derive(Debug, Clone, Serialize, Eq, PartialEq)] +pub struct TrustlyInfo {} #[derive(Debug, Clone, Serialize, Eq, PartialEq)] pub struct IdealInfo { pub issuer_id: MultisafepayBankNames, @@ -490,8 +504,9 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> PaymentMethodData::Wallet(ref wallet_data) => match wallet_data { WalletData::GooglePay(_) => Type::Direct, WalletData::PaypalRedirect(_) => Type::Redirect, + WalletData::AliPayRedirect(_) => Type::Redirect, + WalletData::WeChatPayRedirect(_) => Type::Redirect, WalletData::AliPayQr(_) - | WalletData::AliPayRedirect(_) | WalletData::AliPayHkRedirect(_) | WalletData::AmazonPayRedirect(_) | WalletData::MomoRedirect(_) @@ -512,7 +527,6 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> | WalletData::TwintRedirect {} | WalletData::VippsRedirect {} | WalletData::TouchNGoRedirect(_) - | WalletData::WeChatPayRedirect(_) | WalletData::WeChatPayQr(_) | WalletData::CashappQr(_) | WalletData::SwishQr(_) @@ -524,6 +538,7 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> PaymentMethodData::BankRedirect(ref bank_data) => match bank_data { BankRedirectData::Giropay { .. } => Type::Redirect, BankRedirectData::Ideal { .. } => Type::Direct, + BankRedirectData::Trustly { .. } => Type::Redirect, BankRedirectData::BancontactCard { .. } | BankRedirectData::Bizum { .. } | BankRedirectData::Blik { .. } @@ -537,7 +552,6 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> | BankRedirectData::OpenBankingUk { .. } | BankRedirectData::Przelewy24 { .. } | BankRedirectData::Sofort { .. } - | BankRedirectData::Trustly { .. } | BankRedirectData::OnlineBankingFpx { .. } | BankRedirectData::OnlineBankingThailand { .. } | BankRedirectData::LocalBankRedirect {} => { @@ -557,8 +571,9 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> PaymentMethodData::Wallet(ref wallet_data) => Some(match wallet_data { WalletData::GooglePay(_) => Gateway::Googlepay, WalletData::PaypalRedirect(_) => Gateway::Paypal, + WalletData::AliPayRedirect(_) => Gateway::Alipay, + WalletData::WeChatPayRedirect(_) => Gateway::WeChatPay, WalletData::AliPayQr(_) - | WalletData::AliPayRedirect(_) | WalletData::AliPayHkRedirect(_) | WalletData::AmazonPayRedirect(_) | WalletData::MomoRedirect(_) @@ -579,7 +594,6 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> | WalletData::TwintRedirect {} | WalletData::VippsRedirect {} | WalletData::TouchNGoRedirect(_) - | WalletData::WeChatPayRedirect(_) | WalletData::WeChatPayQr(_) | WalletData::CashappQr(_) | WalletData::SwishQr(_) @@ -591,6 +605,7 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> PaymentMethodData::BankRedirect(ref bank_data) => Some(match bank_data { BankRedirectData::Giropay { .. } => Gateway::Giropay, BankRedirectData::Ideal { .. } => Gateway::Ideal, + BankRedirectData::Trustly { .. } => Gateway::Trustly, BankRedirectData::BancontactCard { .. } | BankRedirectData::Bizum { .. } | BankRedirectData::Blik { .. } @@ -604,7 +619,6 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> | BankRedirectData::OpenBankingUk { .. } | BankRedirectData::Przelewy24 { .. } | BankRedirectData::Sofort { .. } - | BankRedirectData::Trustly { .. } | BankRedirectData::OnlineBankingFpx { .. } | BankRedirectData::OnlineBankingThailand { .. } | BankRedirectData::LocalBankRedirect {} => { @@ -718,9 +732,14 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> } }))) } + WalletData::AliPayRedirect(_) => { + Some(GatewayInfo::Wallet(WalletInfo::Alipay(AlipayInfo {}))) + } WalletData::PaypalRedirect(_) => None, + WalletData::WeChatPayRedirect(_) => { + Some(GatewayInfo::Wallet(WalletInfo::WeChatPay(WeChatPayInfo {}))) + } WalletData::AliPayQr(_) - | WalletData::AliPayRedirect(_) | WalletData::AliPayHkRedirect(_) | WalletData::AmazonPayRedirect(_) | WalletData::MomoRedirect(_) @@ -741,7 +760,6 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> | WalletData::TwintRedirect {} | WalletData::VippsRedirect {} | WalletData::TouchNGoRedirect(_) - | WalletData::WeChatPayRedirect(_) | WalletData::WeChatPayQr(_) | WalletData::CashappQr(_) | WalletData::SwishQr(_) @@ -780,6 +798,9 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> )?)?, }), )), + BankRedirectData::Trustly { .. } => Some(GatewayInfo::BankRedirect( + BankRedirectInfo::Trustly(TrustlyInfo {}), + )), BankRedirectData::BancontactCard { .. } | BankRedirectData::Bizum { .. } | BankRedirectData::Blik { .. } @@ -794,7 +815,6 @@ impl TryFrom<&MultisafepayRouterData<&types::PaymentsAuthorizeRouterData>> | BankRedirectData::OpenBankingUk { .. } | BankRedirectData::Przelewy24 { .. } | BankRedirectData::Sofort { .. } - | BankRedirectData::Trustly { .. } | BankRedirectData::OnlineBankingFpx { .. } | BankRedirectData::OnlineBankingThailand { .. } | BankRedirectData::LocalBankRedirect {} => None,

2025-06-26T04:34:28Z

## Type of Change  - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description Add newer payment methods for `multisafepay` connector - Trustly - WeChatPay - Alipay ### MCA <details> <summary>Create Merchant Account</summary> ```json { "connector_type": "payment_processor", "connector_account_details": { "auth_type": "HeaderKey", "api_key": "**************" }, "connector_name": "multisafepay", "test_mode": false, "disabled": false, "payment_methods_enabled": [ { "payment_method": "wallet", "payment_method_types": [ { "payment_method_type": "we_chat_pay", "payment_experience": "redirect_to_url" } ] }, { "payment_method": "wallet", "payment_method_types": [ { "payment_method_type": "ali_pay", "payment_experience": "redirect_to_url" } ] }, { "payment_method": "wallet", "payment_method_types": [ { "payment_method_type": "amazon_pay", "payment_experience": "redirect_to_url" } ] }, { "payment_method": "bank_redirect", "payment_method_types": [ { "payment_method_type": "trustly" } ] }, { "payment_method": "card", "payment_method_types": [ { "payment_method_type": "credit", "card_networks": ["Visa", "Mastercard"], "minimum_amount": 1, "maximum_amount": 68607706, "recurring_enabled": true, "installment_payment_enabled": true }, { "payment_method_type": "debit", "card_networks": ["Visa", "Mastercard"], "minimum_amount": 1, "maximum_amount": 68607706, "recurring_enabled": true, "installment_payment_enabled": true } ] } ], "metadata": { "city": "NY", "unit": "245" }, "business_country": "US", "business_label": "default" } ``` </details> ## Trustly <details> <summary>Create payement</summary> ```json { "amount": 333, "currency": "EUR", "confirm": true, "capture_method": "automatic", "payment_method": "bank_redirect", "payment_method_type": "trustly", "description": "hellow world", "billing": { "address": { "zip": "560095", "first_name": "Sakil", "last_name": "Mostak", "line1": "Fasdf", "country": "AT", "line2": "Fasdf", "city": "Fasdf" } }, "payment_method_data": { "bank_redirect": { "trustly": { "country": "AT" } } } } ``` </details> <details> <summary> Response</summary> ```json { "payment_id": "pay_wRU9qZTZ8Q8VGd8Bry2i", "merchant_id": "merchant_1750676714", "status": "requires_customer_action", "amount": 333, "net_amount": 333, "shipping_cost": null, "amount_capturable": 333, "amount_received": null, "connector": "multisafepay", "client_secret": "pay_wRU9qZTZ8Q8VGd8Bry2i_secret_Cikbt0vSVNo1G9dXT8LR", "created": "2025-06-26T04:55:03.318Z", "currency": "EUR", "customer_id": null, "customer": null, "description": "hellow world", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "bank_redirect", "payment_method_data": { "bank_redirect": { "type": "BankRedirectResponse", "bank_name": null }, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": "Fasdf", "country": "AT", "line1": "Fasdf", "line2": "Fasdf", "line3": null, "zip": "560095", "state": null, "first_name": "Sakil", "last_name": "Mostak" }, "phone": null, "email": null }, "order_details": null, "email": null, "name": null, "phone": null, "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": { "type": "redirect_to_url", "redirect_to_url": "http://localhost:8080/payments/redirect/pay_wRU9qZTZ8Q8VGd8Bry2i/merchant_1750676714/pay_wRU9qZTZ8Q8VGd8Bry2i_1" }, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "trustly", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": null, "connector_transaction_id": "pay_wRU9qZTZ8Q8VGd8Bry2i_1", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_wRU9qZTZ8Q8VGd8Bry2i_1", "payment_link": null, "profile_id": "pro_7Pno0Wbshvrioh4kTJLM", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_aliGZhhX1SDuuEtkipSs", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-06-26T05:10:03.318Z", "fingerprint": null, "browser_info": null, "payment_method_id": null, "payment_method_status": null, "updated": "2025-06-26T04:55:05.045Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": null, "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` </details> <details> <summary>Confirm page</summary> <img width="1322" alt="Screenshot 2025-06-26 at 10 26 20 AM" src="https://github.com/user-attachments/assets/6a428b08-d3fb-4b6d-bf94-d6348025d208" /> </details> <details> <summary>Psync</summary> ```json { "payment_id": "pay_wRU9qZTZ8Q8VGd8Bry2i", "merchant_id": "merchant_1750676714", "status": "succeeded", "amount": 333, "net_amount": 333, "shipping_cost": null, "amount_capturable": 0, "amount_received": 333, "connector": "multisafepay", "client_secret": "pay_wRU9qZTZ8Q8VGd8Bry2i_secret_Cikbt0vSVNo1G9dXT8LR", "created": "2025-06-26T04:55:03.318Z", "currency": "EUR", "customer_id": null, "customer": null, "description": "hellow world", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "bank_redirect", "payment_method_data": { "bank_redirect": { "type": "BankRedirectResponse", "bank_name": null }, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": "Fasdf", "country": "AT", "line1": "Fasdf", "line2": "Fasdf", "line3": null, "zip": "560095", "state": null, "first_name": "Sakil", "last_name": "Mostak" }, "phone": null, "email": null }, "order_details": null, "email": null, "name": null, "phone": null, "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "trustly", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": false, "connector_transaction_id": "pay_wRU9qZTZ8Q8VGd8Bry2i_1", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_wRU9qZTZ8Q8VGd8Bry2i_1", "payment_link": null, "profile_id": "pro_7Pno0Wbshvrioh4kTJLM", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_aliGZhhX1SDuuEtkipSs", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-06-26T05:10:03.318Z", "fingerprint": null, "browser_info": null, "payment_method_id": null, "payment_method_status": null, "updated": "2025-06-26T04:56:22.878Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": null, "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` </details> ## Alipay <details> <summary> Payment create </summary> ```json { "amount": 333, "currency": "EUR", "confirm": true, "capture_method": "automatic", "payment_method": "wallet", "payment_method_type": "ali_pay", "authentication_type": "no_three_ds", "description": "hellow world", "billing": { "address": { "zip": "560095", "first_name": "Sakil", "last_name": "Mostak", "line1": "Fasdf", "country": "AT", "line2": "Fasdf", "city": "Fasdf" } }, "payment_method_data": { "wallet": { "ali_pay_redirect": {} } } } ``` </details> <details> <summary>Payment Response</summary> ```json { "payment_id": "pay_Ovu6Gi04d695EdCCEUlP", "merchant_id": "merchant_1750676714", "status": "requires_customer_action", "amount": 333, "net_amount": 333, "shipping_cost": null, "amount_capturable": 333, "amount_received": null, "connector": "multisafepay", "client_secret": "pay_Ovu6Gi04d695EdCCEUlP_secret_M57QtvAffR5Z5DEAkVko", "created": "2025-06-26T05:00:28.713Z", "currency": "EUR", "customer_id": null, "customer": null, "description": "hellow world", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "wallet", "payment_method_data": { "wallet": {}, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": "Fasdf", "country": "AT", "line1": "Fasdf", "line2": "Fasdf", "line3": null, "zip": "560095", "state": null, "first_name": "Sakil", "last_name": "Mostak" }, "phone": null, "email": null }, "order_details": null, "email": null, "name": null, "phone": null, "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": { "type": "redirect_to_url", "redirect_to_url": "http://localhost:8080/payments/redirect/pay_Ovu6Gi04d695EdCCEUlP/merchant_1750676714/pay_Ovu6Gi04d695EdCCEUlP_1" }, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "ali_pay", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": null, "connector_transaction_id": "pay_Ovu6Gi04d695EdCCEUlP_1", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_Ovu6Gi04d695EdCCEUlP_1", "payment_link": null, "profile_id": "pro_7Pno0Wbshvrioh4kTJLM", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_aliGZhhX1SDuuEtkipSs", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-06-26T05:15:28.713Z", "fingerprint": null, "browser_info": null, "payment_method_id": null, "payment_method_status": null, "updated": "2025-06-26T05:00:30.315Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": null, "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` </details> <details> <summary> Confirm page </summary> <img width="1188" alt="Screenshot 2025-06-26 at 10 44 33 AM" src="https://github.com/user-attachments/assets/86978961-b4c1-42e0-8ae0-a28f72ea44a4" /> </details> <details> <summary>Psync</summary> ```json { "payment_id": "pay_Ovu6Gi04d695EdCCEUlP", "merchant_id": "merchant_1750676714", "status": "succeeded", "amount": 333, "net_amount": 333, "shipping_cost": null, "amount_capturable": 0, "amount_received": 333, "connector": "multisafepay", "client_secret": "pay_Ovu6Gi04d695EdCCEUlP_secret_M57QtvAffR5Z5DEAkVko", "created": "2025-06-26T05:00:28.713Z", "currency": "EUR", "customer_id": null, "customer": null, "description": "hellow world", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "wallet", "payment_method_data": { "wallet": {}, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": "Fasdf", "country": "AT", "line1": "Fasdf", "line2": "Fasdf", "line3": null, "zip": "560095", "state": null, "first_name": "Sakil", "last_name": "Mostak" }, "phone": null, "email": null }, "order_details": null, "email": null, "name": null, "phone": null, "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "ali_pay", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": false, "connector_transaction_id": "pay_Ovu6Gi04d695EdCCEUlP_1", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_Ovu6Gi04d695EdCCEUlP_1", "payment_link": null, "profile_id": "pro_7Pno0Wbshvrioh4kTJLM", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_aliGZhhX1SDuuEtkipSs", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-06-26T05:15:28.713Z", "fingerprint": null, "browser_info": null, "payment_method_id": null, "payment_method_status": null, "updated": "2025-06-26T05:14:27.864Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": null, "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` </details> ## WeChat pay <details> <summary>Create payment </summary> ```json { "amount": 333, "currency": "EUR", "confirm": true, "capture_method": "automatic", "payment_method": "wallet", "payment_method_type": "we_chat_pay", "authentication_type": "no_three_ds", "description": "hellow world", "billing": { "address": { "zip": "560095", "first_name": "Sakil", "last_name": "Mostak", "line1": "Fasdf", "country": "CN", "line2": "Fasdf", "city": "Fasdf" } }, "payment_method_data": { "wallet": { "we_chat_pay_redirect": {} } } } ``` </details> <details> <summary>create payment response</summary> ```json { "payment_id": "pay_ly7Ihm9zEVRPGi4Q9rAY", "merchant_id": "merchant_1750676714", "status": "requires_customer_action", "amount": 333, "net_amount": 333, "shipping_cost": null, "amount_capturable": 333, "amount_received": null, "connector": "multisafepay", "client_secret": "pay_ly7Ihm9zEVRPGi4Q9rAY_secret_0QAA4w1LChiYL9nlsVW7", "created": "2025-06-26T05:22:38.368Z", "currency": "EUR", "customer_id": null, "customer": null, "description": "hellow world", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "wallet", "payment_method_data": { "wallet": {}, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": "Fasdf", "country": "CN", "line1": "Fasdf", "line2": "Fasdf", "line3": null, "zip": "560095", "state": null, "first_name": "Sakil", "last_name": "Mostak" }, "phone": null, "email": null }, "order_details": null, "email": null, "name": null, "phone": null, "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": { "type": "redirect_to_url", "redirect_to_url": "http://localhost:8080/payments/redirect/pay_ly7Ihm9zEVRPGi4Q9rAY/merchant_1750676714/pay_ly7Ihm9zEVRPGi4Q9rAY_1" }, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "we_chat_pay", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": null, "connector_transaction_id": "pay_ly7Ihm9zEVRPGi4Q9rAY_1", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_ly7Ihm9zEVRPGi4Q9rAY_1", "payment_link": null, "profile_id": "pro_7Pno0Wbshvrioh4kTJLM", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_aliGZhhX1SDuuEtkipSs", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-06-26T05:37:38.368Z", "fingerprint": null, "browser_info": null, "payment_method_id": null, "payment_method_status": null, "updated": "2025-06-26T05:22:39.622Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": null, "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` </details> <details> <summary>Confirm page</summary> ## You will get a qr page and it needs to be scanned normally and it will direct to confirm page (test mode) <img width="1105" alt="Screenshot 2025-06-26 at 10 53 31 AM" src="https://github.com/user-attachments/assets/e7385469-ae56-4849-a131-d3ff941445ba" /> </details> <details> <summary>Psync </summary> ```json { "payment_id": "pay_ly7Ihm9zEVRPGi4Q9rAY", "merchant_id": "merchant_1750676714", "status": "succeeded", "amount": 333, "net_amount": 333, "shipping_cost": null, "amount_capturable": 0, "amount_received": 333, "connector": "multisafepay", "client_secret": "pay_ly7Ihm9zEVRPGi4Q9rAY_secret_0QAA4w1LChiYL9nlsVW7", "created": "2025-06-26T05:22:38.368Z", "currency": "EUR", "customer_id": null, "customer": null, "description": "hellow world", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "wallet", "payment_method_data": { "wallet": {}, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": "Fasdf", "country": "CN", "line1": "Fasdf", "line2": "Fasdf", "line3": null, "zip": "560095", "state": null, "first_name": "Sakil", "last_name": "Mostak" }, "phone": null, "email": null }, "order_details": null, "email": null, "name": null, "phone": null, "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "we_chat_pay", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": false, "connector_transaction_id": "pay_ly7Ihm9zEVRPGi4Q9rAY_1", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_ly7Ihm9zEVRPGi4Q9rAY_1", "payment_link": null, "profile_id": "pro_7Pno0Wbshvrioh4kTJLM", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_aliGZhhX1SDuuEtkipSs", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-06-26T05:37:38.368Z", "fingerprint": null, "browser_info": null, "payment_method_id": null, "payment_method_status": null, "updated": "2025-06-26T05:23:57.958Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": null, "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` </details> ## Checklist - [x] I formatted the code `cargo +nightly fmt --all` - [ ] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.114.0

6d98d5721be41bbd2b9674ab0dbdeafe6c95b95f

juspay/hyperswitch

juspay__hyperswitch-8516

Bug: [FEATURE] Add incremental authorization for Paypal, AuthorizeDotNet, Stripe ### Feature Description Add incremental authorization for Paypal, AuthorizeDotNet, Stripe ### Possible Implementation Add incremental authorization for Paypal, AuthorizeDotNet, Stripe ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? Yes, I am willing to submit a PR!

diff --git a/crates/hyperswitch_connectors/src/connectors/helcim.rs b/crates/hyperswitch_connectors/src/connectors/helcim.rs index 05165fbe91b..4845b2cbc7b 100644 --- a/crates/hyperswitch_connectors/src/connectors/helcim.rs +++ b/crates/hyperswitch_connectors/src/connectors/helcim.rs @@ -924,7 +924,7 @@ impl ConnectorTransactionId for Helcim { #[cfg(feature = "v1")] fn connector_transaction_id( &self, - payment_attempt: PaymentAttempt, + payment_attempt: &PaymentAttempt, ) -> Result<Option<String>, ApiErrorResponse> { if payment_attempt.get_connector_payment_id().is_none() { let metadata = @@ -940,7 +940,7 @@ impl ConnectorTransactionId for Helcim { #[cfg(feature = "v2")] fn connector_transaction_id( &self, - payment_attempt: PaymentAttempt, + payment_attempt: &PaymentAttempt, ) -> Result<Option<String>, ApiErrorResponse> { use hyperswitch_domain_models::errors::api_error_response::ApiErrorResponse; diff --git a/crates/hyperswitch_connectors/src/connectors/nexinets.rs b/crates/hyperswitch_connectors/src/connectors/nexinets.rs index 08084973c50..8733bede9c4 100644 --- a/crates/hyperswitch_connectors/src/connectors/nexinets.rs +++ b/crates/hyperswitch_connectors/src/connectors/nexinets.rs @@ -886,7 +886,7 @@ impl ConnectorTransactionId for Nexinets { #[cfg(feature = "v1")] fn connector_transaction_id( &self, - payment_attempt: PaymentAttempt, + payment_attempt: &PaymentAttempt, ) -> Result<Option<String>, ApiErrorResponse> { let metadata = Self::connector_transaction_id(self, payment_attempt.connector_metadata.as_ref()); @@ -896,7 +896,7 @@ impl ConnectorTransactionId for Nexinets { #[cfg(feature = "v2")] fn connector_transaction_id( &self, - payment_attempt: PaymentAttempt, + payment_attempt: &PaymentAttempt, ) -> Result<Option<String>, ApiErrorResponse> { use hyperswitch_domain_models::errors::api_error_response::ApiErrorResponse; diff --git a/crates/hyperswitch_connectors/src/connectors/paypal.rs b/crates/hyperswitch_connectors/src/connectors/paypal.rs index 578baba88b5..f90ac021fb2 100644 --- a/crates/hyperswitch_connectors/src/connectors/paypal.rs +++ b/crates/hyperswitch_connectors/src/connectors/paypal.rs @@ -20,8 +20,8 @@ use hyperswitch_domain_models::{ router_flow_types::{ access_token_auth::AccessTokenAuth, payments::{ - Authorize, Capture, PSync, PaymentMethodToken, PostSessionTokens, PreProcessing, - SdkSessionUpdate, Session, SetupMandate, Void, + Authorize, Capture, IncrementalAuthorization, PSync, PaymentMethodToken, + PostSessionTokens, PreProcessing, SdkSessionUpdate, Session, SetupMandate, Void, }, refunds::{Execute, RSync}, CompleteAuthorize, VerifyWebhookSource, @@ -29,19 +29,19 @@ use hyperswitch_domain_models::{ router_request_types::{ AccessTokenRequestData, CompleteAuthorizeData, PaymentMethodTokenizationData, PaymentsAuthorizeData, PaymentsCancelData, PaymentsCaptureData, - PaymentsPostSessionTokensData, PaymentsPreProcessingData, PaymentsSessionData, - PaymentsSyncData, RefundsData, ResponseId, SdkPaymentsSessionUpdateData, - SetupMandateRequestData, VerifyWebhookSourceRequestData, + PaymentsIncrementalAuthorizationData, PaymentsPostSessionTokensData, + PaymentsPreProcessingData, PaymentsSessionData, PaymentsSyncData, RefundsData, ResponseId, + SdkPaymentsSessionUpdateData, SetupMandateRequestData, VerifyWebhookSourceRequestData, }, router_response_types::{ PaymentsResponseData, RefundsResponseData, VerifyWebhookSourceResponseData, }, types::{ PaymentsAuthorizeRouterData, PaymentsCancelRouterData, PaymentsCaptureRouterData, - PaymentsCompleteAuthorizeRouterData, PaymentsPostSessionTokensRouterData, - PaymentsPreProcessingRouterData, PaymentsSyncRouterData, RefreshTokenRouterData, - RefundSyncRouterData, RefundsRouterData, SdkSessionUpdateRouterData, - SetupMandateRouterData, VerifyWebhookSourceRouterData, + PaymentsCompleteAuthorizeRouterData, PaymentsIncrementalAuthorizationRouterData, + PaymentsPostSessionTokensRouterData, PaymentsPreProcessingRouterData, + PaymentsSyncRouterData, RefreshTokenRouterData, RefundSyncRouterData, RefundsRouterData, + SdkSessionUpdateRouterData, SetupMandateRouterData, VerifyWebhookSourceRouterData, }, }; #[cfg(feature = "payouts")] @@ -55,17 +55,17 @@ use hyperswitch_interfaces::types::{PayoutFulfillType, PayoutSyncType}; use hyperswitch_interfaces::{ api::{ self, ConnectorCommon, ConnectorCommonExt, ConnectorIntegration, ConnectorRedirectResponse, - ConnectorSpecifications, ConnectorValidation, + ConnectorSpecifications, ConnectorValidation, PaymentIncrementalAuthorization, }, configs::Connectors, consts::{NO_ERROR_CODE, NO_ERROR_MESSAGE}, disputes, errors, events::connector_api_logs::ConnectorEvent, types::{ - PaymentsAuthorizeType, PaymentsCaptureType, PaymentsCompleteAuthorizeType, - PaymentsPostSessionTokensType, PaymentsPreProcessingType, PaymentsSyncType, - PaymentsVoidType, RefreshTokenType, RefundExecuteType, RefundSyncType, Response, - SdkSessionUpdateType, SetupMandateType, VerifyWebhookSourceType, + IncrementalAuthorizationType, PaymentsAuthorizeType, PaymentsCaptureType, + PaymentsCompleteAuthorizeType, PaymentsPostSessionTokensType, PaymentsPreProcessingType, + PaymentsSyncType, PaymentsVoidType, RefreshTokenType, RefundExecuteType, RefundSyncType, + Response, SdkSessionUpdateType, SetupMandateType, VerifyWebhookSourceType, }, webhooks::{IncomingWebhook, IncomingWebhookRequestDetails}, }; @@ -73,7 +73,8 @@ use masking::{ExposeInterface, Mask, Maskable, PeekInterface, Secret}; #[cfg(feature = "payouts")] use router_env::{instrument, tracing}; use transformers::{ - self as paypal, auth_headers, PaypalAuthResponse, PaypalMeta, PaypalWebhookEventType, + self as paypal, auth_headers, PaypalAuthResponse, PaypalIncrementalAuthResponse, PaypalMeta, + PaypalWebhookEventType, }; use crate::{ @@ -1105,6 +1106,123 @@ impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData } } +impl PaymentIncrementalAuthorization for Paypal {} + +impl + ConnectorIntegration< + IncrementalAuthorization, + PaymentsIncrementalAuthorizationData, + PaymentsResponseData, + > for Paypal +{ + fn get_headers( + &self, + req: &PaymentsIncrementalAuthorizationRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_http_method(&self) -> Method { + Method::Post + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + req: &PaymentsIncrementalAuthorizationRouterData, + connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + let paypal_meta: PaypalMeta = to_connector_meta(req.request.connector_meta.clone())?; + let incremental_authorization_id = paypal_meta.incremental_authorization_id.ok_or( + errors::ConnectorError::RequestEncodingFailedWithReason( + "Missing incremental authorization id".to_string(), + ), + )?; + Ok(format!( + "{}v2/payments/authorizations/{}/reauthorize", + self.base_url(connectors), + incremental_authorization_id + )) + } + + fn get_request_body( + &self, + req: &PaymentsIncrementalAuthorizationRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let amount = connector_utils::convert_amount( + self.amount_converter, + MinorUnit::new(req.request.total_amount), + req.request.currency, + )?; + let connector_router_data = + paypal::PaypalRouterData::try_from((amount, None, None, None, req))?; + let connector_req = paypal::PaypalIncrementalAuthRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &PaymentsIncrementalAuthorizationRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&IncrementalAuthorizationType::get_url( + self, req, connectors, + )?) + .attach_default_headers() + .headers(IncrementalAuthorizationType::get_headers( + self, req, connectors, + )?) + .set_body(IncrementalAuthorizationType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsIncrementalAuthorizationRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult< + RouterData< + IncrementalAuthorization, + PaymentsIncrementalAuthorizationData, + PaymentsResponseData, + >, + errors::ConnectorError, + > { + let response: PaypalIncrementalAuthResponse = res + .response + .parse_struct("Paypal IncrementalAuthResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + .change_context(errors::ConnectorError::ResponseHandlingFailed) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + impl api::PaymentsPreProcessing for Paypal {} impl ConnectorIntegration<PreProcessing, PaymentsPreProcessingData, PaymentsResponseData> diff --git a/crates/hyperswitch_connectors/src/connectors/paypal/transformers.rs b/crates/hyperswitch_connectors/src/connectors/paypal/transformers.rs index 8cabfcf4663..3814694b08b 100644 --- a/crates/hyperswitch_connectors/src/connectors/paypal/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/paypal/transformers.rs @@ -19,7 +19,8 @@ use hyperswitch_domain_models::{ VerifyWebhookSource, }, router_request_types::{ - PaymentsAuthorizeData, PaymentsPostSessionTokensData, PaymentsSyncData, ResponseId, + CompleteAuthorizeData, PaymentsAuthorizeData, PaymentsIncrementalAuthorizationData, + PaymentsPostSessionTokensData, PaymentsSyncData, ResponseId, VerifyWebhookSourceRequestData, }, router_response_types::{ @@ -28,8 +29,9 @@ use hyperswitch_domain_models::{ }, types::{ PaymentsAuthorizeRouterData, PaymentsCaptureRouterData, - PaymentsPostSessionTokensRouterData, RefreshTokenRouterData, RefundsRouterData, - SdkSessionUpdateRouterData, SetupMandateRouterData, VerifyWebhookSourceRouterData, + PaymentsIncrementalAuthorizationRouterData, PaymentsPostSessionTokensRouterData, + RefreshTokenRouterData, RefundsRouterData, SdkSessionUpdateRouterData, + SetupMandateRouterData, VerifyWebhookSourceRouterData, }, }; #[cfg(feature = "payouts")] @@ -55,6 +57,28 @@ use crate::{ }, }; +trait GetRequestIncrementalAuthorization { + fn get_request_incremental_authorization(&self) -> Option<bool>; +} + +impl GetRequestIncrementalAuthorization for PaymentsAuthorizeData { + fn get_request_incremental_authorization(&self) -> Option<bool> { + Some(self.request_incremental_authorization) + } +} + +impl GetRequestIncrementalAuthorization for CompleteAuthorizeData { + fn get_request_incremental_authorization(&self) -> Option<bool> { + None + } +} + +impl GetRequestIncrementalAuthorization for PaymentsSyncData { + fn get_request_incremental_authorization(&self) -> Option<bool> { + None + } +} + #[derive(Debug, Serialize)] pub struct PaypalRouterData<T> { pub amount: StringMajorUnit, @@ -237,7 +261,7 @@ pub struct PurchaseUnitRequest { items: Vec<ItemDetails>, } -#[derive(Default, Debug, Serialize, Eq, PartialEq)] +#[derive(Default, Debug, Deserialize, Serialize, Eq, PartialEq)] pub struct Payee { merchant_id: Secret<String>, } @@ -1425,6 +1449,119 @@ impl<F, T> TryFrom<ResponseRouterData<F, PaypalAuthUpdateResponse, T, AccessToke } } +#[derive(Debug, Serialize)] +pub struct PaypalIncrementalAuthRequest { + amount: OrderAmount, +} + +impl TryFrom<&PaypalRouterData<&PaymentsIncrementalAuthorizationRouterData>> + for PaypalIncrementalAuthRequest +{ + type Error = error_stack::Report<errors::ConnectorError>; + + fn try_from( + item: &PaypalRouterData<&PaymentsIncrementalAuthorizationRouterData>, + ) -> Result<Self, Self::Error> { + Ok(Self { + amount: OrderAmount { + currency_code: item.router_data.request.currency, + value: item.amount.clone(), + }, + }) + } +} + +#[derive(Debug, Deserialize, Serialize)] +pub struct PaypalIncrementalAuthResponse { + status: PaypalIncrementalStatus, + status_details: PaypalIncrementalAuthStatusDetails, + id: String, + invoice_id: String, + custom_id: String, + links: Vec<PaypalLinks>, + amount: OrderAmount, + network_transaction_reference: PaypalNetworkTransactionReference, + expiration_time: String, + create_time: String, + update_time: String, + supplementary_data: PaypalSupplementaryData, + payee: Payee, + name: Option<String>, + message: Option<String>, +} + +#[derive(Debug, Deserialize, Serialize)] +#[serde(rename_all = "SCREAMING_SNAKE_CASE")] +pub enum PaypalIncrementalStatus { + CREATED, + CAPTURED, + DENIED, + PARTIALLYCAPTURED, + VOIDED, + PENDING, +} + +#[derive(Debug, Deserialize, Serialize)] +pub struct PaypalNetworkTransactionReference { + id: String, +} + +#[derive(Debug, Deserialize, Serialize)] +pub struct PaypalIncrementalAuthStatusDetails { + reason: PaypalStatusPendingReason, +} + +#[derive(Debug, Deserialize, Serialize)] +#[serde(rename_all = "SCREAMING_SNAKE_CASE")] +pub enum PaypalStatusPendingReason { + PENDINGREVIEW, + DECLINEDBYRISKFRAUDFILTERS, +} + +impl From<PaypalIncrementalStatus> for common_enums::AuthorizationStatus { + fn from(item: PaypalIncrementalStatus) -> Self { + match item { + PaypalIncrementalStatus::CREATED + | PaypalIncrementalStatus::CAPTURED + | PaypalIncrementalStatus::PARTIALLYCAPTURED => Self::Success, + PaypalIncrementalStatus::PENDING => Self::Processing, + PaypalIncrementalStatus::DENIED | PaypalIncrementalStatus::VOIDED => Self::Failure, + } + } +} + +impl<F> + TryFrom< + ResponseRouterData< + F, + PaypalIncrementalAuthResponse, + PaymentsIncrementalAuthorizationData, + PaymentsResponseData, + >, + > for RouterData<F, PaymentsIncrementalAuthorizationData, PaymentsResponseData> +{ + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: ResponseRouterData< + F, + PaypalIncrementalAuthResponse, + PaymentsIncrementalAuthorizationData, + PaymentsResponseData, + >, + ) -> Result<Self, Self::Error> { + let status = common_enums::AuthorizationStatus::from(item.response.status); + Ok(Self { + response: Ok(PaymentsResponseData::IncrementalAuthorizationResponse { + status, + error_code: None, + error_message: None, + connector_authorization_id: Some(item.response.id), + }), + ..item.data + }) + } +} + #[derive(Debug)] pub enum PaypalAuthType { TemporaryAuth, @@ -1747,6 +1884,7 @@ pub struct CardDetails { pub struct PaypalMeta { pub authorize_id: Option<String>, pub capture_id: Option<String>, + pub incremental_authorization_id: Option<String>, pub psync_flow: PaypalPaymentIntent, pub next_action: Option<api_models::payments::NextActionCall>, pub order_id: Option<String>, @@ -1782,12 +1920,25 @@ fn get_id_based_on_intent( .ok_or_else(|| errors::ConnectorError::MissingConnectorTransactionID.into()) } -impl<F, T> TryFrom<ResponseRouterData<F, PaypalOrdersResponse, T, PaymentsResponseData>> - for RouterData<F, T, PaymentsResponseData> +fn extract_incremental_authorization_id(response: &PaypalOrdersResponse) -> Option<String> { + for unit in &response.purchase_units { + if let Some(authorizations) = &unit.payments.authorizations { + if let Some(first_auth) = authorizations.first() { + return Some(first_auth.id.clone()); + } + } + } + None +} + +impl<F, Req> TryFrom<ResponseRouterData<F, PaypalOrdersResponse, Req, PaymentsResponseData>> + for RouterData<F, Req, PaymentsResponseData> +where + Req: GetRequestIncrementalAuthorization, { type Error = error_stack::Report<errors::ConnectorError>; fn try_from( - item: ResponseRouterData<F, PaypalOrdersResponse, T, PaymentsResponseData>, + item: ResponseRouterData<F, PaypalOrdersResponse, Req, PaymentsResponseData>, ) -> Result<Self, Self::Error> { let purchase_units = item .response @@ -1801,6 +1952,7 @@ impl<F, T> TryFrom<ResponseRouterData<F, PaypalOrdersResponse, T, PaymentsRespon serde_json::json!(PaypalMeta { authorize_id: None, capture_id: Some(id), + incremental_authorization_id: None, psync_flow: item.response.intent.clone(), next_action: None, order_id: None, @@ -1812,6 +1964,9 @@ impl<F, T> TryFrom<ResponseRouterData<F, PaypalOrdersResponse, T, PaymentsRespon serde_json::json!(PaypalMeta { authorize_id: Some(id), capture_id: None, + incremental_authorization_id: extract_incremental_authorization_id( + &item.response + ), psync_flow: item.response.intent.clone(), next_action: None, order_id: None, @@ -1872,7 +2027,10 @@ impl<F, T> TryFrom<ResponseRouterData<F, PaypalOrdersResponse, T, PaymentsRespon .invoice_id .clone() .or(Some(item.response.id)), - incremental_authorization_allowed: None, + incremental_authorization_allowed: item + .data + .request + .get_request_incremental_authorization(), charges: None, }), ..item.data @@ -1965,6 +2123,7 @@ impl<F, T> let connector_meta = serde_json::json!(PaypalMeta { authorize_id: None, capture_id: None, + incremental_authorization_id: None, psync_flow: item.response.intent, next_action, order_id: None, @@ -2017,6 +2176,7 @@ impl let connector_meta = serde_json::json!(PaypalMeta { authorize_id: None, capture_id: None, + incremental_authorization_id: None, psync_flow: item.response.intent, next_action: None, order_id: None, @@ -2072,6 +2232,7 @@ impl let connector_meta = serde_json::json!(PaypalMeta { authorize_id: None, capture_id: None, + incremental_authorization_id: None, psync_flow: item.response.intent, next_action, order_id: Some(item.response.id.clone()), @@ -2144,6 +2305,7 @@ impl<F> let connector_meta = serde_json::json!(PaypalMeta { authorize_id: None, capture_id: None, + incremental_authorization_id: None, psync_flow: PaypalPaymentIntent::Authenticate, // when there is no capture or auth id present next_action: None, order_id: None, @@ -2550,6 +2712,7 @@ impl TryFrom<PaymentsCaptureResponseRouterData<PaypalCaptureResponse>> connector_metadata: Some(serde_json::json!(PaypalMeta { authorize_id: connector_payment_id.authorize_id, capture_id: Some(item.response.id.clone()), + incremental_authorization_id: None, psync_flow: PaypalPaymentIntent::Capture, next_action: None, order_id: None, diff --git a/crates/hyperswitch_connectors/src/default_implementations.rs b/crates/hyperswitch_connectors/src/default_implementations.rs index 38e63124029..bdf3ee5604b 100644 --- a/crates/hyperswitch_connectors/src/default_implementations.rs +++ b/crates/hyperswitch_connectors/src/default_implementations.rs @@ -1086,7 +1086,6 @@ default_imp_for_incremental_authorization!( connectors::Payload, connectors::Payme, connectors::Payone, - connectors::Paypal, connectors::Paystack, connectors::Payu, connectors::Placetopay, diff --git a/crates/hyperswitch_domain_models/src/router_request_types.rs b/crates/hyperswitch_domain_models/src/router_request_types.rs index 31879b4cfe3..fd37b30f6f8 100644 --- a/crates/hyperswitch_domain_models/src/router_request_types.rs +++ b/crates/hyperswitch_domain_models/src/router_request_types.rs @@ -155,6 +155,7 @@ pub struct PaymentsIncrementalAuthorizationData { pub currency: storage_enums::Currency, pub reason: Option<String>, pub connector_transaction_id: String, + pub connector_meta: Option<serde_json::Value>, } #[derive(Debug, Clone, Default)] diff --git a/crates/hyperswitch_interfaces/src/api.rs b/crates/hyperswitch_interfaces/src/api.rs index 4162eb29094..70d1bc2c1b6 100644 --- a/crates/hyperswitch_interfaces/src/api.rs +++ b/crates/hyperswitch_interfaces/src/api.rs @@ -722,7 +722,7 @@ pub trait ConnectorTransactionId: ConnectorCommon + Sync { /// fn connector_transaction_id fn connector_transaction_id( &self, - payment_attempt: hyperswitch_domain_models::payments::payment_attempt::PaymentAttempt, + payment_attempt: &hyperswitch_domain_models::payments::payment_attempt::PaymentAttempt, ) -> Result<Option<String>, ApiErrorResponse> { Ok(payment_attempt .get_connector_payment_id() diff --git a/crates/hyperswitch_interfaces/src/connector_integration_interface.rs b/crates/hyperswitch_interfaces/src/connector_integration_interface.rs index 998df9ec61c..c40c65ac5f7 100644 --- a/crates/hyperswitch_interfaces/src/connector_integration_interface.rs +++ b/crates/hyperswitch_interfaces/src/connector_integration_interface.rs @@ -793,7 +793,7 @@ impl api::ConnectorTransactionId for ConnectorEnum { /// A `Result` containing an optional transaction ID or an ApiErrorResponse fn connector_transaction_id( &self, - payment_attempt: hyperswitch_domain_models::payments::payment_attempt::PaymentAttempt, + payment_attempt: &hyperswitch_domain_models::payments::payment_attempt::PaymentAttempt, ) -> Result<Option<String>, ApiErrorResponse> { match self { Self::Old(connector) => connector.connector_transaction_id(payment_attempt), diff --git a/crates/router/src/core/payments/transformers.rs b/crates/router/src/core/payments/transformers.rs index 2379dddb8fd..1cd67d61f68 100644 --- a/crates/router/src/core/payments/transformers.rs +++ b/crates/router/src/core/payments/transformers.rs @@ -478,7 +478,7 @@ pub async fn construct_payment_router_data_for_capture<'a>( currency: payment_data.payment_intent.amount_details.currency, connector_transaction_id: connector .connector - .connector_transaction_id(payment_data.payment_attempt.clone())? + .connector_transaction_id(&payment_data.payment_attempt)? .ok_or(errors::ApiErrorResponse::ResourceIdNotFound)?, payment_amount: amount.get_amount_as_i64(), // This should be removed once we start moving to connector module minor_payment_amount: amount, @@ -3756,6 +3756,7 @@ impl<F: Clone> TryFrom<PaymentAdditionalData<'_, F>> for types::PaymentsSyncData } } +#[cfg(feature = "v1")] impl<F: Clone> TryFrom<PaymentAdditionalData<'_, F>> for types::PaymentsIncrementalAuthorizationData { @@ -3763,39 +3764,68 @@ impl<F: Clone> TryFrom<PaymentAdditionalData<'_, F>> fn try_from(additional_data: PaymentAdditionalData<'_, F>) -> Result<Self, Self::Error> { let payment_data = additional_data.payment_data; + let payment_attempt = &payment_data.payment_attempt; let connector = api::ConnectorData::get_connector_by_name( &additional_data.state.conf.connectors, &additional_data.connector_name, api::GetToken::Connector, - payment_data.payment_attempt.merchant_connector_id.clone(), + payment_attempt.merchant_connector_id.clone(), )?; - let total_amount = payment_data + let incremental_details = payment_data .incremental_authorization_details - .clone() - .map(|details| details.total_amount) + .as_ref() .ok_or( report!(errors::ApiErrorResponse::InternalServerError) .attach_printable("missing incremental_authorization_details in payment_data"), )?; - let additional_amount = payment_data + Ok(Self { + total_amount: incremental_details.total_amount.get_amount_as_i64(), + additional_amount: incremental_details.additional_amount.get_amount_as_i64(), + reason: incremental_details.reason.clone(), + currency: payment_data.currency, + connector_transaction_id: connector + .connector + .connector_transaction_id(payment_attempt)? + .ok_or(errors::ApiErrorResponse::ResourceIdNotFound)?, + connector_meta: payment_attempt.connector_metadata.clone(), + }) + } +} + +#[cfg(feature = "v2")] +impl<F: Clone> TryFrom<PaymentAdditionalData<'_, F>> + for types::PaymentsIncrementalAuthorizationData +{ + type Error = error_stack::Report<errors::ApiErrorResponse>; + + fn try_from(additional_data: PaymentAdditionalData<'_, F>) -> Result<Self, Self::Error> { + let payment_data = additional_data.payment_data; + let connector = api::ConnectorData::get_connector_by_name( + &additional_data.state.conf.connectors, + &additional_data.connector_name, + api::GetToken::Connector, + payment_data.payment_attempt.merchant_connector_id.clone(), + )?; + let incremental_details = payment_data .incremental_authorization_details - .clone() - .map(|details| details.additional_amount) + .as_ref() .ok_or( report!(errors::ApiErrorResponse::InternalServerError) .attach_printable("missing incremental_authorization_details in payment_data"), )?; Ok(Self { - total_amount: total_amount.get_amount_as_i64(), - additional_amount: additional_amount.get_amount_as_i64(), - reason: payment_data - .incremental_authorization_details - .and_then(|details| details.reason), + total_amount: incremental_details.total_amount.get_amount_as_i64(), + additional_amount: incremental_details.additional_amount.get_amount_as_i64(), + reason: incremental_details.reason.clone(), currency: payment_data.currency, connector_transaction_id: connector .connector - .connector_transaction_id(payment_data.payment_attempt.clone())? + .connector_transaction_id(&payment_data.payment_attempt)? .ok_or(errors::ApiErrorResponse::ResourceIdNotFound)?, + connector_meta: payment_data + .payment_attempt + .connector_metadata + .map(|secret| secret.expose()), }) } } @@ -3828,7 +3858,7 @@ impl<F: Clone> TryFrom<PaymentAdditionalData<'_, F>> for types::PaymentsCaptureD currency: payment_data.currency, connector_transaction_id: connector .connector - .connector_transaction_id(payment_data.payment_attempt.clone())? + .connector_transaction_id(&payment_data.payment_attempt)? .ok_or(errors::ApiErrorResponse::ResourceIdNotFound)?, payment_amount: amount.get_amount_as_i64(), // This should be removed once we start moving to connector module minor_payment_amount: amount, @@ -3896,7 +3926,7 @@ impl<F: Clone> TryFrom<PaymentAdditionalData<'_, F>> for types::PaymentsCaptureD currency: payment_data.currency, connector_transaction_id: connector .connector - .connector_transaction_id(payment_data.payment_attempt.clone())? + .connector_transaction_id(&payment_data.payment_attempt)? .ok_or(errors::ApiErrorResponse::ResourceIdNotFound)?, payment_amount: amount.get_amount_as_i64(), // This should be removed once we start moving to connector module minor_payment_amount: amount, @@ -3973,7 +4003,7 @@ impl<F: Clone> TryFrom<PaymentAdditionalData<'_, F>> for types::PaymentsCancelDa currency: Some(payment_data.currency), connector_transaction_id: connector .connector - .connector_transaction_id(payment_data.payment_attempt.clone())? + .connector_transaction_id(&payment_data.payment_attempt)? .ok_or(errors::ApiErrorResponse::ResourceIdNotFound)?, cancellation_reason: payment_data.payment_attempt.cancellation_reason, connector_meta: payment_data.payment_attempt.connector_metadata, @@ -4127,7 +4157,7 @@ impl<F: Clone> TryFrom<PaymentAdditionalData<'_, F>> for types::PaymentsUpdateMe .attach_printable("payment_intent.metadata not found")?, connector_transaction_id: connector .connector - .connector_transaction_id(payment_data.payment_attempt.clone())? + .connector_transaction_id(&payment_data.payment_attempt)? .ok_or(errors::ApiErrorResponse::ResourceIdNotFound)?, }) }

2025-07-01T23:24:24Z

## Type of Change  - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD Closes this [issue](https://github.com/juspay/hyperswitch/issues/8516) ## Description  Added Incremental Authorization flow for Paypal ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  https://github.com/juspay/hyperswitch/issues/8516 ## How did you test it?  Postman Test Payments - Create: Request: ``` curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_1PzpFzUXX4ZALEpOUNRFMeXyRB2WCZHfhd6AXOKifb7fqVRfrUFQLiqS4DchmszP' \ --data-raw ' { "amount": 1000, "currency": "USD", "confirm": true, "capture_method": "manual", "capture_on": "2022-09-10T10:11:12Z", "amount_to_capture": 1000, "customer_id": "StripeCustomer", "email": "[email protected]", "name": "John Doe", "phone": "999999999", "phone_country_code": "+65", "description": "Its my first payment request", "authentication_type": "no_three_ds", "return_url": "https://duck.com", "billing": { "address": { "first_name": "John", "last_name": "Doe", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "AT" } }, "payment_method": "card", "payment_method_type": "credit", "payment_method_data": { "card": { "card_number": "4111111111111111", "card_exp_month": "11", "card_exp_year": "2030", "card_holder_name": "joseph Doe", "card_cvc": "276" } }, "browser_info": { "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8", "language": "nl-NL", "color_depth": 24, "screen_height": 723, "screen_width": 1536, "time_zone": 0, "java_enabled": true, "java_script_enabled": true, "ip_address": "127.0.0.1" }, "shipping": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "John", "last_name": "Doe" } }, "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "metadata": { "udf1": "value1", "new_customer": "true", "login_date": "2019-09-10T10:11:12Z" }, "request_incremental_authorization": true }' ``` Response: ``` { "payment_id": "pay_1agl8yqCWefEuD7cM9DK", "merchant_id": "merchant_1751411099", "status": "requires_capture", "amount": 1000, "net_amount": 1000, "shipping_cost": null, "amount_capturable": 1000, "amount_received": null, "connector": "paypal", "client_secret": "pay_1agl8yqCWefEuD7cM9DK_secret_iYISlExnoU9wZBlUbA0J", "created": "2025-07-01T23:05:08.941Z", "currency": "USD", "customer_id": "StripeCustomer", "customer": { "id": "StripeCustomer", "name": "John Doe", "email": "[email protected]", "phone": "999999999", "phone_country_code": "+65" }, "description": "Its my first payment request", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "manual", "payment_method": "card", "payment_method_data": { "card": { "last4": "1111", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "411111", "card_extended_bin": null, "card_exp_month": "11", "card_exp_year": "2030", "card_holder_name": "joseph Doe", "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "John", "last_name": "Doe" }, "phone": null, "email": null }, "billing": { "address": { "city": "San Fransico", "country": "AT", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "John", "last_name": "Doe" }, "phone": null, "email": null }, "order_details": null, "email": "[email protected]", "name": "John Doe", "phone": "999999999", "return_url": "https://duck.com/", "authentication_type": "no_three_ds", "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "credit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": { "customer_id": "StripeCustomer", "created_at": 1751411108, "expires": 1751414708, "secret": "epk_dc7e9d0a449a4c28816179c01355a423" }, "manual_retry_allowed": false, "connector_transaction_id": "120066274887", "frm_message": null, "metadata": { "udf1": "value1", "login_date": "2019-09-10T10:11:12Z", "new_customer": "true" }, "connector_metadata": null, "feature_metadata": null, "reference_id": "120066274887", "payment_link": null, "profile_id": "pro_ufQauYhoCJvm3iPPC8mG", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_6BJ52EkitWXtjk3xh9jx", "incremental_authorization_allowed": true, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-07-01T23:20:08.940Z", "fingerprint": null, "browser_info": { "language": "nl-NL", "time_zone": 0, "ip_address": "127.0.0.1", "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "color_depth": 24, "java_enabled": true, "screen_width": 1536, "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8", "screen_height": 723, "java_script_enabled": true }, "payment_method_id": null, "payment_method_status": null, "updated": "2025-07-01T23:05:11.094Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` Incremental Authorization: Request: ``` curl --location 'http://localhost:8080/payments/pay_1agl8yqCWefEuD7cM9DK/incremental_authorization' \ --header 'Content-Type: application/json' \ --header 'api-key: dev_1PzpFzUXX4ZALEpOUNRFMeXyRB2WCZHfhd6AXOKifb7fqVRfrUFQLiqS4DchmszP' \ --data '{ "amount": 6540, "reason": "customer gone overbudget" }' ``` **NOTE**: The response will return failure status if the payment authorization has not yet surpassed the 4-day threshold. As per Paypal's documentation, a payment becomes eligible for incremental authorization only after the initial authorization is older than 4 days. Response: ``` { "payment_id": "pay_KorlaZqtqUdTrpKtGhwj", "merchant_id": "merchant_1751412204", "status": "requires_capture", "amount": 1050, "net_amount": 1050, "shipping_cost": null, "amount_capturable": 1050, "amount_received": null, "connector": "paypal", "client_secret": "pay_KorlaZqtqUdTrpKtGhwj_secret_JvQWos0QgC06DTMUIUod", "created": "2025-07-01T23:23:32.564Z", "currency": "USD", "customer_id": null, "customer": { "id": null, "name": "John Doe", "email": "[email protected]", "phone": "999999999", "phone_country_code": "+65" }, "description": "Its my first payment request", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "manual", "payment_method": "card", "payment_method_data": { "card": { "last4": "1111", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "411111", "card_extended_bin": null, "card_exp_month": "11", "card_exp_year": "2030", "card_holder_name": "joseph Doe", "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": null, "billing": null, "order_details": null, "email": null, "name": null, "phone": null, "return_url": "https://duck.com/", "authentication_type": "no_three_ds", "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "credit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": false, "connector_transaction_id": "4657001324168371U", "frm_message": null, "metadata": { "udf1": "value1", "login_date": "2019-09-10T10:11:12Z", "new_customer": "true" }, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_KorlaZqtqUdTrpKtGhwj_1", "payment_link": null, "profile_id": "pro_K0AcXOIDkvcyvNd6AU0K", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_frPGdve129UARoghNL0x", "incremental_authorization_allowed": true, "authorization_count": 2, "incremental_authorizations": [ { "authorization_id": "auth_bdKFP2R2zflE7nGe7DSm_1", "amount": 6540, "status": "failure", "error_code": "REAUTHORIZATION_TOO_SOON", "error_message": "REAUTHORIZATION_TOO_SOON", "previously_authorized_amount": 1000 }, { "authorization_id": "auth_fkKGl3yaPor09wvHf7KmS_2", "amount": 1050, "status": "succeeded", "error_code": null, "error_message": null, "previously_authorized_amount": 1000 }, ], "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-07-01T23:38:32.564Z", "fingerprint": null, "browser_info": { "language": "nl-NL", "time_zone": 0, "ip_address": "127.0.0.1", "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "color_depth": 24, "java_enabled": true, "screen_width": 1536, "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8", "screen_height": 723, "java_script_enabled": true }, "payment_method_id": null, "payment_method_status": null, "updated": "2025-07-01T23:23:41.215Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` Cypress Screenshot for Incremental Authorization: <img width="627" height="416" alt="Screenshot 2025-07-14 at 1 34 28 PM" src="https://github.com/user-attachments/assets/b7917284-2f90-484e-b720-162ae28a1b32" /> ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

3c498714e76b400657fc0fc25b7559ca3dca1908

juspay/hyperswitch

juspay__hyperswitch-8520

Bug: add `debit_routing_savings` in analytics payment attempt We need to add debit_routing_savings to the payment analytics. This will provide the savings per card network, as well as the total savings for a profile.

diff --git a/crates/analytics/docs/clickhouse/scripts/payment_attempts.sql b/crates/analytics/docs/clickhouse/scripts/payment_attempts.sql index 6673b73fedb..16815e9a33d 100644 --- a/crates/analytics/docs/clickhouse/scripts/payment_attempts.sql +++ b/crates/analytics/docs/clickhouse/scripts/payment_attempts.sql @@ -44,6 +44,7 @@ CREATE TABLE payment_attempt_queue ( `profile_id` String, `card_network` Nullable(String), `routing_approach` LowCardinality(Nullable(String)), + `debit_routing_savings` Nullable(UInt32), `sign_flag` Int8 ) ENGINE = Kafka SETTINGS kafka_broker_list = 'kafka0:29092', kafka_topic_list = 'hyperswitch-payment-attempt-events', @@ -98,6 +99,7 @@ CREATE TABLE payment_attempts ( `profile_id` String, `card_network` Nullable(String), `routing_approach` LowCardinality(Nullable(String)), + `debit_routing_savings` Nullable(UInt32), `sign_flag` Int8, INDEX connectorIndex connector TYPE bloom_filter GRANULARITY 1, INDEX paymentMethodIndex payment_method TYPE bloom_filter GRANULARITY 1, @@ -155,6 +157,7 @@ CREATE MATERIALIZED VIEW payment_attempt_mv TO payment_attempts ( `profile_id` String, `card_network` Nullable(String), `routing_approach` LowCardinality(Nullable(String)), + `debit_routing_savings` Nullable(UInt32), `sign_flag` Int8 ) AS SELECT @@ -204,6 +207,7 @@ SELECT profile_id, card_network, routing_approach, + debit_routing_savings, sign_flag FROM payment_attempt_queue diff --git a/crates/analytics/src/payments/accumulator.rs b/crates/analytics/src/payments/accumulator.rs index 20ccc634068..6d7dca22a30 100644 --- a/crates/analytics/src/payments/accumulator.rs +++ b/crates/analytics/src/payments/accumulator.rs @@ -18,6 +18,7 @@ pub struct PaymentMetricsAccumulator { pub connector_success_rate: SuccessRateAccumulator, pub payments_distribution: PaymentsDistributionAccumulator, pub failure_reasons_distribution: FailureReasonsDistributionAccumulator, + pub debit_routing: DebitRoutingAccumulator, } #[derive(Debug, Default)] @@ -58,6 +59,12 @@ pub struct ProcessedAmountAccumulator { pub total_without_retries: Option<i64>, } +#[derive(Debug, Default)] +pub struct DebitRoutingAccumulator { + pub transaction_count: u64, + pub savings_amount: u64, +} + #[derive(Debug, Default)] pub struct AverageAccumulator { pub total: u32, @@ -183,6 +190,27 @@ impl PaymentMetricAccumulator for SuccessRateAccumulator { } } +impl PaymentMetricAccumulator for DebitRoutingAccumulator { + type MetricOutput = (Option<u64>, Option<u64>, Option<u64>); + + fn add_metrics_bucket(&mut self, metrics: &PaymentMetricRow) { + if let Some(count) = metrics.count { + self.transaction_count += u64::try_from(count).unwrap_or(0); + } + if let Some(total) = metrics.total.as_ref().and_then(ToPrimitive::to_u64) { + self.savings_amount += total; + } + } + + fn collect(self) -> Self::MetricOutput { + ( + Some(self.transaction_count), + Some(self.savings_amount), + Some(0), + ) + } +} + impl PaymentMetricAccumulator for PaymentsDistributionAccumulator { type MetricOutput = ( Option<f64>, @@ -440,6 +468,9 @@ impl PaymentMetricsAccumulator { ) = self.payments_distribution.collect(); let (failure_reason_count, failure_reason_count_without_smart_retries) = self.failure_reasons_distribution.collect(); + let (debit_routed_transaction_count, debit_routing_savings, debit_routing_savings_in_usd) = + self.debit_routing.collect(); + PaymentMetricsBucketValue { payment_success_rate: self.payment_success_rate.collect(), payment_count: self.payment_count.collect(), @@ -463,6 +494,9 @@ impl PaymentMetricsAccumulator { failure_reason_count_without_smart_retries, payment_processed_amount_in_usd, payment_processed_amount_without_smart_retries_usd, + debit_routed_transaction_count, + debit_routing_savings, + debit_routing_savings_in_usd, } } } diff --git a/crates/analytics/src/payments/core.rs b/crates/analytics/src/payments/core.rs index e55ba2726af..c1922ffe924 100644 --- a/crates/analytics/src/payments/core.rs +++ b/crates/analytics/src/payments/core.rs @@ -171,6 +171,9 @@ pub async fn get_metrics( .connector_success_rate .add_metrics_bucket(&value); } + PaymentMetrics::DebitRouting | PaymentMetrics::SessionizedDebitRouting => { + metrics_builder.debit_routing.add_metrics_bucket(&value); + } PaymentMetrics::PaymentsDistribution => { metrics_builder .payments_distribution @@ -294,6 +297,33 @@ pub async fn get_metrics( if let Some(count) = collected_values.failure_reason_count_without_smart_retries { total_failure_reasons_count_without_smart_retries += count; } + if let Some(savings) = collected_values.debit_routing_savings { + let savings_in_usd = if let Some(ex_rates) = ex_rates { + id.currency + .and_then(|currency| { + i64::try_from(savings) + .inspect_err(|e| { + logger::error!( + "Debit Routing savings conversion error: {:?}", + e + ) + }) + .ok() + .and_then(|savings_i64| { + convert(ex_rates, currency, Currency::USD, savings_i64) + .inspect_err(|e| { + logger::error!("Currency conversion error: {:?}", e) + }) + .ok() + }) + }) + .map(|savings| (savings * rust_decimal::Decimal::new(100, 0)).to_u64()) + .unwrap_or_default() + } else { + None + }; + collected_values.debit_routing_savings_in_usd = savings_in_usd; + } MetricsBucketResponse { values: collected_values, dimensions: id, diff --git a/crates/analytics/src/payments/metrics.rs b/crates/analytics/src/payments/metrics.rs index 67dc50c5152..b19c661322d 100644 --- a/crates/analytics/src/payments/metrics.rs +++ b/crates/analytics/src/payments/metrics.rs @@ -15,6 +15,7 @@ use crate::{ mod avg_ticket_size; mod connector_success_rate; +mod debit_routing; mod payment_count; mod payment_processed_amount; mod payment_success_count; @@ -24,6 +25,7 @@ mod success_rate; use avg_ticket_size::AvgTicketSize; use connector_success_rate::ConnectorSuccessRate; +use debit_routing::DebitRouting; use payment_count::PaymentCount; use payment_processed_amount::PaymentProcessedAmount; use payment_success_count::PaymentSuccessCount; @@ -130,6 +132,11 @@ where .load_metrics(dimensions, auth, filters, granularity, time_range, pool) .await } + Self::DebitRouting => { + DebitRouting + .load_metrics(dimensions, auth, filters, granularity, time_range, pool) + .await + } Self::SessionizedPaymentSuccessRate => { sessionized_metrics::PaymentSuccessRate .load_metrics(dimensions, auth, filters, granularity, time_range, pool) @@ -175,6 +182,11 @@ where .load_metrics(dimensions, auth, filters, granularity, time_range, pool) .await } + Self::SessionizedDebitRouting => { + sessionized_metrics::DebitRouting + .load_metrics(dimensions, auth, filters, granularity, time_range, pool) + .await + } } } } diff --git a/crates/analytics/src/payments/metrics/debit_routing.rs b/crates/analytics/src/payments/metrics/debit_routing.rs new file mode 100644 index 00000000000..584221205cd --- /dev/null +++ b/crates/analytics/src/payments/metrics/debit_routing.rs @@ -0,0 +1,151 @@ +use std::collections::HashSet; + +use api_models::analytics::{ + payments::{PaymentDimensions, PaymentFilters, PaymentMetricsBucketIdentifier}, + Granularity, TimeRange, +}; +use common_utils::errors::ReportSwitchExt; +use diesel_models::enums as storage_enums; +use error_stack::ResultExt; +use time::PrimitiveDateTime; + +use super::PaymentMetricRow; +use crate::{ + enums::AuthInfo, + query::{Aggregate, GroupByClause, QueryBuilder, QueryFilter, SeriesBucket, ToSql, Window}, + types::{AnalyticsCollection, AnalyticsDataSource, MetricsError, MetricsResult}, +}; + +#[derive(Default)] +pub(super) struct DebitRouting; + +#[async_trait::async_trait] +impl<T> super::PaymentMetric<T> for DebitRouting +where + T: AnalyticsDataSource + super::PaymentMetricAnalytics, + PrimitiveDateTime: ToSql<T>, + AnalyticsCollection: ToSql<T>, + Granularity: GroupByClause<T>, + Aggregate<&'static str>: ToSql<T>, + Window<&'static str>: ToSql<T>, +{ + async fn load_metrics( + &self, + dimensions: &[PaymentDimensions], + auth: &AuthInfo, + filters: &PaymentFilters, + granularity: Option<Granularity>, + time_range: &TimeRange, + pool: &T, + ) -> MetricsResult<HashSet<(PaymentMetricsBucketIdentifier, PaymentMetricRow)>> { + let mut query_builder: QueryBuilder<T> = QueryBuilder::new(AnalyticsCollection::Payment); + + for dim in dimensions.iter() { + query_builder.add_select_column(dim).switch()?; + } + query_builder + .add_select_column(Aggregate::Count { + field: None, + alias: Some("count"), + }) + .switch()?; + query_builder + .add_select_column(Aggregate::Sum { + field: "debit_routing_savings", + alias: Some("total"), + }) + .switch()?; + query_builder.add_select_column("currency").switch()?; + query_builder + .add_select_column(Aggregate::Min { + field: "created_at", + alias: Some("start_bucket"), + }) + .switch()?; + query_builder + .add_select_column(Aggregate::Max { + field: "created_at", + alias: Some("end_bucket"), + }) + .switch()?; + + filters.set_filter_clause(&mut query_builder).switch()?; + + auth.set_filter_clause(&mut query_builder).switch()?; + + time_range + .set_filter_clause(&mut query_builder) + .attach_printable("Error filtering time range") + .switch()?; + + for dim in dimensions.iter() { + query_builder + .add_group_by_clause(dim) + .attach_printable("Error grouping by dimensions") + .switch()?; + } + + query_builder + .add_group_by_clause("currency") + .attach_printable("Error grouping by currency") + .switch()?; + + if let Some(granularity) = granularity { + granularity + .set_group_by_clause(&mut query_builder) + .attach_printable("Error adding granularity") + .switch()?; + } + + query_builder + .add_filter_clause( + PaymentDimensions::PaymentStatus, + storage_enums::AttemptStatus::Charged, + ) + .switch()?; + + query_builder + .execute_query::<PaymentMetricRow, _>(pool) + .await + .change_context(MetricsError::QueryBuildingError)? + .change_context(MetricsError::QueryExecutionFailure)? + .into_iter() + .map(|i| { + Ok(( + PaymentMetricsBucketIdentifier::new( + i.currency.as_ref().map(|i| i.0), + None, + i.connector.clone(), + i.authentication_type.as_ref().map(|i| i.0), + i.payment_method.clone(), + i.payment_method_type.clone(), + i.client_source.clone(), + i.client_version.clone(), + i.profile_id.clone(), + i.card_network.clone(), + i.merchant_id.clone(), + i.card_last_4.clone(), + i.card_issuer.clone(), + i.error_reason.clone(), + i.routing_approach.as_ref().map(|i| i.0), + TimeRange { + start_time: match (granularity, i.start_bucket) { + (Some(g), Some(st)) => g.clip_to_start(st)?, + _ => time_range.start_time, + }, + end_time: granularity.as_ref().map_or_else( + || Ok(time_range.end_time), + |g| i.end_bucket.map(|et| g.clip_to_end(et)).transpose(), + )?, + }, + ), + i, + )) + }) + .collect::<error_stack::Result< + HashSet<(PaymentMetricsBucketIdentifier, PaymentMetricRow)>, + crate::query::PostProcessingError, + >>() + .change_context(MetricsError::PostProcessingFailure) + } +} diff --git a/crates/analytics/src/payments/metrics/sessionized_metrics.rs b/crates/analytics/src/payments/metrics/sessionized_metrics.rs index e3a5e370534..9d10c9db008 100644 --- a/crates/analytics/src/payments/metrics/sessionized_metrics.rs +++ b/crates/analytics/src/payments/metrics/sessionized_metrics.rs @@ -1,5 +1,6 @@ mod avg_ticket_size; mod connector_success_rate; +mod debit_routing; mod failure_reasons; mod payment_count; mod payment_processed_amount; @@ -9,6 +10,7 @@ mod retries_count; mod success_rate; pub(super) use avg_ticket_size::AvgTicketSize; pub(super) use connector_success_rate::ConnectorSuccessRate; +pub(super) use debit_routing::DebitRouting; pub(super) use failure_reasons::FailureReasons; pub(super) use payment_count::PaymentCount; pub(super) use payment_processed_amount::PaymentProcessedAmount; diff --git a/crates/analytics/src/payments/metrics/sessionized_metrics/debit_routing.rs b/crates/analytics/src/payments/metrics/sessionized_metrics/debit_routing.rs new file mode 100644 index 00000000000..f7c84e1b65c --- /dev/null +++ b/crates/analytics/src/payments/metrics/sessionized_metrics/debit_routing.rs @@ -0,0 +1,152 @@ +use std::collections::HashSet; + +use api_models::analytics::{ + payments::{PaymentDimensions, PaymentFilters, PaymentMetricsBucketIdentifier}, + Granularity, TimeRange, +}; +use common_utils::errors::ReportSwitchExt; +use diesel_models::enums as storage_enums; +use error_stack::ResultExt; +use time::PrimitiveDateTime; + +use super::PaymentMetricRow; +use crate::{ + enums::AuthInfo, + query::{Aggregate, GroupByClause, QueryBuilder, QueryFilter, SeriesBucket, ToSql, Window}, + types::{AnalyticsCollection, AnalyticsDataSource, MetricsError, MetricsResult}, +}; + +#[derive(Default)] +pub(crate) struct DebitRouting; + +#[async_trait::async_trait] +impl<T> super::PaymentMetric<T> for DebitRouting +where + T: AnalyticsDataSource + super::PaymentMetricAnalytics, + PrimitiveDateTime: ToSql<T>, + AnalyticsCollection: ToSql<T>, + Granularity: GroupByClause<T>, + Aggregate<&'static str>: ToSql<T>, + Window<&'static str>: ToSql<T>, +{ + async fn load_metrics( + &self, + dimensions: &[PaymentDimensions], + auth: &AuthInfo, + filters: &PaymentFilters, + granularity: Option<Granularity>, + time_range: &TimeRange, + pool: &T, + ) -> MetricsResult<HashSet<(PaymentMetricsBucketIdentifier, PaymentMetricRow)>> { + let mut query_builder: QueryBuilder<T> = + QueryBuilder::new(AnalyticsCollection::PaymentSessionized); + + for dim in dimensions.iter() { + query_builder.add_select_column(dim).switch()?; + } + query_builder + .add_select_column(Aggregate::Count { + field: None, + alias: Some("count"), + }) + .switch()?; + query_builder + .add_select_column(Aggregate::Sum { + field: "debit_routing_savings", + alias: Some("total"), + }) + .switch()?; + query_builder.add_select_column("currency").switch()?; + query_builder + .add_select_column(Aggregate::Min { + field: "created_at", + alias: Some("start_bucket"), + }) + .switch()?; + query_builder + .add_select_column(Aggregate::Max { + field: "created_at", + alias: Some("end_bucket"), + }) + .switch()?; + + filters.set_filter_clause(&mut query_builder).switch()?; + + auth.set_filter_clause(&mut query_builder).switch()?; + + time_range + .set_filter_clause(&mut query_builder) + .attach_printable("Error filtering time range") + .switch()?; + + for dim in dimensions.iter() { + query_builder + .add_group_by_clause(dim) + .attach_printable("Error grouping by dimensions") + .switch()?; + } + + query_builder + .add_group_by_clause("currency") + .attach_printable("Error grouping by currency") + .switch()?; + + if let Some(granularity) = granularity { + granularity + .set_group_by_clause(&mut query_builder) + .attach_printable("Error adding granularity") + .switch()?; + } + + query_builder + .add_filter_clause( + PaymentDimensions::PaymentStatus, + storage_enums::AttemptStatus::Charged, + ) + .switch()?; + + query_builder + .execute_query::<PaymentMetricRow, _>(pool) + .await + .change_context(MetricsError::QueryBuildingError)? + .change_context(MetricsError::QueryExecutionFailure)? + .into_iter() + .map(|i| { + Ok(( + PaymentMetricsBucketIdentifier::new( + i.currency.as_ref().map(|i| i.0), + None, + i.connector.clone(), + i.authentication_type.as_ref().map(|i| i.0), + i.payment_method.clone(), + i.payment_method_type.clone(), + i.client_source.clone(), + i.client_version.clone(), + i.profile_id.clone(), + i.card_network.clone(), + i.merchant_id.clone(), + i.card_last_4.clone(), + i.card_issuer.clone(), + i.error_reason.clone(), + i.routing_approach.as_ref().map(|i| i.0), + TimeRange { + start_time: match (granularity, i.start_bucket) { + (Some(g), Some(st)) => g.clip_to_start(st)?, + _ => time_range.start_time, + }, + end_time: granularity.as_ref().map_or_else( + || Ok(time_range.end_time), + |g| i.end_bucket.map(|et| g.clip_to_end(et)).transpose(), + )?, + }, + ), + i, + )) + }) + .collect::<error_stack::Result< + HashSet<(PaymentMetricsBucketIdentifier, PaymentMetricRow)>, + crate::query::PostProcessingError, + >>() + .change_context(MetricsError::PostProcessingFailure) + } +} diff --git a/crates/api_models/src/analytics/payments.rs b/crates/api_models/src/analytics/payments.rs index 537d6df09d1..ec5719f1adb 100644 --- a/crates/api_models/src/analytics/payments.rs +++ b/crates/api_models/src/analytics/payments.rs @@ -111,6 +111,7 @@ pub enum PaymentMetrics { AvgTicketSize, RetriesCount, ConnectorSuccessRate, + DebitRouting, SessionizedPaymentSuccessRate, SessionizedPaymentCount, SessionizedPaymentSuccessCount, @@ -118,6 +119,7 @@ pub enum PaymentMetrics { SessionizedAvgTicketSize, SessionizedRetriesCount, SessionizedConnectorSuccessRate, + SessionizedDebitRouting, PaymentsDistribution, FailureReasons, } @@ -128,8 +130,10 @@ impl ForexMetric for PaymentMetrics { self, Self::PaymentProcessedAmount | Self::AvgTicketSize + | Self::DebitRouting | Self::SessionizedPaymentProcessedAmount | Self::SessionizedAvgTicketSize + | Self::SessionizedDebitRouting, ) } } @@ -309,6 +313,9 @@ pub struct PaymentMetricsBucketValue { pub payments_failure_rate_distribution_with_only_retries: Option<f64>, pub failure_reason_count: Option<u64>, pub failure_reason_count_without_smart_retries: Option<u64>, + pub debit_routed_transaction_count: Option<u64>, + pub debit_routing_savings: Option<u64>, + pub debit_routing_savings_in_usd: Option<u64>, } #[derive(Debug, serde::Serialize)] diff --git a/crates/api_models/src/open_router.rs b/crates/api_models/src/open_router.rs index ba53f4c1f00..f5b80383bfb 100644 --- a/crates/api_models/src/open_router.rs +++ b/crates/api_models/src/open_router.rs @@ -67,7 +67,7 @@ pub struct DecidedGateway { #[derive(Debug, Serialize, Deserialize, PartialEq, Clone)] pub struct DebitRoutingOutput { - pub co_badged_card_networks_info: Vec<CoBadgedCardNetworksInfo>, + pub co_badged_card_networks_info: CoBadgedCardNetworks, pub issuer_country: common_enums::CountryAlpha2, pub is_regulated: bool, pub regulated_name: Option<common_enums::RegulatedName>, @@ -80,19 +80,19 @@ pub struct CoBadgedCardNetworksInfo { pub saving_percentage: f64, } -impl DebitRoutingOutput { - pub fn get_co_badged_card_networks(&self) -> Vec<common_enums::CardNetwork> { - self.co_badged_card_networks_info - .iter() - .map(|data| data.network.clone()) - .collect() +#[derive(Debug, Serialize, Deserialize, PartialEq, Clone)] +pub struct CoBadgedCardNetworks(pub Vec<CoBadgedCardNetworksInfo>); + +impl CoBadgedCardNetworks { + pub fn get_card_networks(&self) -> Vec<common_enums::CardNetwork> { + self.0.iter().map(|info| info.network.clone()).collect() } } impl From<&DebitRoutingOutput> for payment_methods::CoBadgedCardData { fn from(output: &DebitRoutingOutput) -> Self { Self { - co_badged_card_networks: output.get_co_badged_card_networks(), + co_badged_card_networks_info: output.co_badged_card_networks_info.clone(), issuer_country_code: output.issuer_country, is_regulated: output.is_regulated, regulated_name: output.regulated_name.clone(), @@ -111,7 +111,7 @@ impl TryFrom<(payment_methods::CoBadgedCardData, String)> for DebitRoutingReques })?; Ok(Self { - co_badged_card_networks_info: output.co_badged_card_networks, + co_badged_card_networks_info: output.co_badged_card_networks_info.get_card_networks(), issuer_country: output.issuer_country_code, is_regulated: output.is_regulated, regulated_name: output.regulated_name, diff --git a/crates/api_models/src/payment_methods.rs b/crates/api_models/src/payment_methods.rs index 6a8f61484dc..0745fade987 100644 --- a/crates/api_models/src/payment_methods.rs +++ b/crates/api_models/src/payment_methods.rs @@ -19,7 +19,7 @@ use utoipa::{schema, ToSchema}; #[cfg(feature = "payouts")] use crate::payouts; use crate::{ - admin, enums as api_enums, + admin, enums as api_enums, open_router, payments::{self, BankCodeResponse}, }; @@ -937,14 +937,14 @@ pub struct PaymentMethodResponse { pub network_token: Option<NetworkTokenResponse>, } -#[derive(Clone, Debug, Eq, PartialEq, serde::Deserialize, serde::Serialize)] +#[derive(Clone, Debug, PartialEq, serde::Deserialize, serde::Serialize)] pub enum PaymentMethodsData { Card(CardDetailsPaymentMethod), BankDetails(PaymentMethodDataBankCreds), WalletDetails(PaymentMethodDataWalletInfo), } -#[derive(Clone, Debug, Eq, PartialEq, serde::Deserialize, serde::Serialize)] +#[derive(Clone, Debug, PartialEq, serde::Deserialize, serde::Serialize)] pub struct CardDetailsPaymentMethod { pub last4_digits: Option<String>, pub issuer_country: Option<String>, @@ -958,12 +958,33 @@ pub struct CardDetailsPaymentMethod { pub card_type: Option<String>, #[serde(default = "saved_in_locker_default")] pub saved_to_locker: bool, - pub co_badged_card_data: Option<CoBadgedCardData>, + pub co_badged_card_data: Option<CoBadgedCardDataToBeSaved>, } -#[derive(Clone, Debug, Eq, PartialEq, serde::Deserialize, serde::Serialize)] +impl From<&CoBadgedCardData> for CoBadgedCardDataToBeSaved { + fn from(co_badged_card_data: &CoBadgedCardData) -> Self { + Self { + co_badged_card_networks: co_badged_card_data + .co_badged_card_networks_info + .get_card_networks(), + issuer_country_code: co_badged_card_data.issuer_country_code, + is_regulated: co_badged_card_data.is_regulated, + regulated_name: co_badged_card_data.regulated_name.clone(), + } + } +} + +#[derive(Clone, Debug, PartialEq, serde::Deserialize, serde::Serialize)] pub struct CoBadgedCardData { - pub co_badged_card_networks: Vec<api_enums::CardNetwork>, + pub co_badged_card_networks_info: open_router::CoBadgedCardNetworks, + pub issuer_country_code: common_enums::CountryAlpha2, + pub is_regulated: bool, + pub regulated_name: Option<common_enums::RegulatedName>, +} + +#[derive(Clone, Debug, PartialEq, serde::Deserialize, serde::Serialize)] +pub struct CoBadgedCardDataToBeSaved { + pub co_badged_card_networks: Vec<common_enums::CardNetwork>, pub issuer_country_code: common_enums::CountryAlpha2, pub is_regulated: bool, pub regulated_name: Option<common_enums::RegulatedName>, @@ -1325,7 +1346,7 @@ impl From<(CardDetailFromLocker, Option<&CoBadgedCardData>)> for CardDetailsPaym card_network: item.card_network, card_type: item.card_type, saved_to_locker: item.saved_to_locker, - co_badged_card_data: co_badged_card_data.cloned(), + co_badged_card_data: co_badged_card_data.map(CoBadgedCardDataToBeSaved::from), } } } diff --git a/crates/hyperswitch_domain_models/src/api.rs b/crates/hyperswitch_domain_models/src/api.rs index f6d93497627..723cc458e7b 100644 --- a/crates/hyperswitch_domain_models/src/api.rs +++ b/crates/hyperswitch_domain_models/src/api.rs @@ -7,7 +7,7 @@ use common_utils::{ use super::payment_method_data::PaymentMethodData; -#[derive(Debug, Eq, PartialEq)] +#[derive(Debug, PartialEq)] pub enum ApplicationResponse<R> { Json(R), StatusOk, @@ -54,7 +54,7 @@ impl<T: ApiEventMetric> ApiEventMetric for ApplicationResponse<T> { impl_api_event_type!(Miscellaneous, (PaymentLinkFormData, GenericLinkFormData)); -#[derive(Debug, Eq, PartialEq)] +#[derive(Debug, PartialEq)] pub struct RedirectionFormData { pub redirect_form: crate::router_response_types::RedirectForm, pub payment_method_data: Option<PaymentMethodData>, diff --git a/crates/hyperswitch_domain_models/src/payment_method_data.rs b/crates/hyperswitch_domain_models/src/payment_method_data.rs index 5433c486fbe..7a420010657 100644 --- a/crates/hyperswitch_domain_models/src/payment_method_data.rs +++ b/crates/hyperswitch_domain_models/src/payment_method_data.rs @@ -24,7 +24,7 @@ use time::Date; // We need to derive Serialize and Deserialize because some parts of payment method data are being // stored in the database as serde_json::Value -#[derive(Eq, PartialEq, Clone, Debug, Serialize, Deserialize)] +#[derive(PartialEq, Clone, Debug, Serialize, Deserialize)] pub enum PaymentMethodData { Card(Card), CardDetailsForNetworkTransactionId(CardDetailsForNetworkTransactionId), @@ -88,9 +88,21 @@ impl PaymentMethodData { None } } + + pub fn extract_debit_routing_saving_percentage( + &self, + network: &common_enums::CardNetwork, + ) -> Option<f64> { + self.get_co_badged_card_data()? + .co_badged_card_networks_info + .0 + .iter() + .find(|info| &info.network == network) + .map(|info| info.saving_percentage) + } } -#[derive(Eq, PartialEq, Clone, Debug, Serialize, Deserialize, Default)] +#[derive(PartialEq, Clone, Debug, Serialize, Deserialize, Default)] pub struct Card { pub card_number: cards::CardNumber, pub card_exp_month: Secret<String>, @@ -120,7 +132,7 @@ pub struct CardDetailsForNetworkTransactionId { pub card_holder_name: Option<Secret<String>>, } -#[derive(Eq, PartialEq, Clone, Debug, Serialize, Deserialize, Default)] +#[derive(PartialEq, Clone, Debug, Serialize, Deserialize, Default)] pub struct CardDetail { pub card_number: cards::CardNumber, pub card_exp_month: Secret<String>, @@ -1961,7 +1973,7 @@ impl From<GooglePayWalletData> for payment_methods::PaymentMethodDataWalletInfo } } -#[derive(Clone, Debug, Eq, PartialEq, serde::Deserialize, serde::Serialize)] +#[derive(Clone, Debug, PartialEq, serde::Deserialize, serde::Serialize)] pub enum PaymentMethodsData { Card(CardDetailsPaymentMethod), BankDetails(payment_methods::PaymentMethodDataBankCreds), //PaymentMethodDataBankCreds and its transformations should be moved to the domain models @@ -2005,7 +2017,7 @@ fn saved_in_locker_default() -> bool { } #[cfg(feature = "v1")] -#[derive(Clone, Debug, Eq, PartialEq, serde::Deserialize, serde::Serialize)] +#[derive(Clone, Debug, PartialEq, serde::Deserialize, serde::Serialize)] pub struct CardDetailsPaymentMethod { pub last4_digits: Option<String>, pub issuer_country: Option<String>, diff --git a/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs b/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs index 2b568b70af8..3baddfa98c5 100644 --- a/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs +++ b/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs @@ -9,14 +9,12 @@ use common_types::primitive_wrappers::{ }; #[cfg(feature = "v2")] use common_utils::{ - crypto::Encryptable, - encryption::Encryption, - ext_traits::{Encode, ValueExt}, + crypto::Encryptable, encryption::Encryption, ext_traits::Encode, types::keymanager::ToEncryptable, }; use common_utils::{ errors::{CustomResult, ValidationError}, - ext_traits::OptionExt, + ext_traits::{OptionExt, ValueExt}, id_type, pii, types::{ keymanager::{self, KeyManagerState}, @@ -906,6 +904,7 @@ pub struct PaymentAttempt { pub setup_future_usage_applied: Option<storage_enums::FutureUsage>, pub routing_approach: Option<storage_enums::RoutingApproach>, pub connector_request_reference_id: Option<String>, + pub debit_routing_savings: Option<MinorUnit>, } #[cfg(feature = "v1")] @@ -1063,6 +1062,10 @@ impl PaymentAttempt { pub fn get_total_surcharge_amount(&self) -> Option<MinorUnit> { self.amount_details.surcharge_amount } + + pub fn extract_card_network(&self) -> Option<common_enums::CardNetwork> { + todo!() + } } #[cfg(feature = "v1")] @@ -1074,6 +1077,25 @@ impl PaymentAttempt { pub fn get_total_surcharge_amount(&self) -> Option<MinorUnit> { self.net_amount.get_total_surcharge_amount() } + + pub fn set_debit_routing_savings(&mut self, debit_routing_savings: Option<&MinorUnit>) { + self.debit_routing_savings = debit_routing_savings.copied(); + } + + pub fn extract_card_network(&self) -> Option<common_enums::CardNetwork> { + self.payment_method_data + .as_ref() + .and_then(|value| { + value + .clone() + .parse_value::<api_models::payments::AdditionalPaymentData>( + "AdditionalPaymentData", + ) + .ok() + }) + .and_then(|data| data.get_additional_card_info()) + .and_then(|card_info| card_info.card_network) + } } #[derive(Clone, Debug, Eq, PartialEq)] @@ -1283,6 +1305,7 @@ pub enum PaymentAttemptUpdate { connector_mandate_detail: Option<ConnectorMandateReferenceId>, charges: Option<common_types::payments::ConnectorChargeResponseData>, setup_future_usage_applied: Option<storage_enums::FutureUsage>, + debit_routing_savings: Option<MinorUnit>, }, UnresolvedResponseUpdate { status: storage_enums::AttemptStatus, @@ -1566,6 +1589,7 @@ impl PaymentAttemptUpdate { connector_mandate_detail, charges, setup_future_usage_applied, + debit_routing_savings: _, } => DieselPaymentAttemptUpdate::ResponseUpdate { status, connector, @@ -1756,6 +1780,35 @@ impl PaymentAttemptUpdate { }, } } + + pub fn get_debit_routing_savings(&self) -> Option<&MinorUnit> { + match self { + Self::ResponseUpdate { + debit_routing_savings, + .. + } => debit_routing_savings.as_ref(), + Self::Update { .. } + | Self::UpdateTrackers { .. } + | Self::AuthenticationTypeUpdate { .. } + | Self::ConfirmUpdate { .. } + | Self::RejectUpdate { .. } + | Self::BlocklistUpdate { .. } + | Self::PaymentMethodDetailsUpdate { .. } + | Self::ConnectorMandateDetailUpdate { .. } + | Self::VoidUpdate { .. } + | Self::UnresolvedResponseUpdate { .. } + | Self::StatusUpdate { .. } + | Self::ErrorUpdate { .. } + | Self::CaptureUpdate { .. } + | Self::AmountToCaptureUpdate { .. } + | Self::PreprocessingUpdate { .. } + | Self::ConnectorResponse { .. } + | Self::IncrementalAuthorizationAmountUpdate { .. } + | Self::AuthenticationUpdate { .. } + | Self::ManualUpdate { .. } + | Self::PostSessionTokensUpdate { .. } => None, + } + } } #[cfg(feature = "v2")] @@ -2033,6 +2086,7 @@ impl behaviour::Conversion for PaymentAttempt { setup_future_usage_applied: storage_model.setup_future_usage_applied, routing_approach: storage_model.routing_approach, connector_request_reference_id: storage_model.connector_request_reference_id, + debit_routing_savings: None, }) } .await diff --git a/crates/router/src/core/debit_routing.rs b/crates/router/src/core/debit_routing.rs index 4975ffc4bd1..d4f7c8bd753 100644 --- a/crates/router/src/core/debit_routing.rs +++ b/crates/router/src/core/debit_routing.rs @@ -281,7 +281,10 @@ where &profile_id, &key_store, vec![connector_data.clone()], - debit_routing_output.get_co_badged_card_networks(), + debit_routing_output + .co_badged_card_networks_info + .clone() + .get_card_networks(), ) .await .map_err(|error| { @@ -454,7 +457,10 @@ where &profile_id, &key_store, connector_data_list.clone(), - debit_routing_output.get_co_badged_card_networks(), + debit_routing_output + .co_badged_card_networks_info + .clone() + .get_card_networks(), ) .await .map_err(|error| { diff --git a/crates/router/src/core/payment_methods.rs b/crates/router/src/core/payment_methods.rs index 4b1cff09be2..e8e5b2040ed 100644 --- a/crates/router/src/core/payment_methods.rs +++ b/crates/router/src/core/payment_methods.rs @@ -865,12 +865,15 @@ fn get_card_network_with_us_local_debit_network_override( .map(|network| network.is_us_local_network()) { services::logger::debug!("Card network is a US local network, checking for global network in co-badged card data"); - co_badged_card_data.and_then(|data| { - data.co_badged_card_networks - .iter() - .find(|network| network.is_global_network()) - .cloned() - }) + let info: Option<api_models::open_router::CoBadgedCardNetworksInfo> = co_badged_card_data + .and_then(|data| { + data.co_badged_card_networks_info + .0 + .iter() + .find(|info| info.network.is_global_network()) + .cloned() + }); + info.map(|data| data.network) } else { card_network } diff --git a/crates/router/src/core/payment_methods/tokenize.rs b/crates/router/src/core/payment_methods/tokenize.rs index 3556673510c..f0eaea45d98 100644 --- a/crates/router/src/core/payment_methods/tokenize.rs +++ b/crates/router/src/core/payment_methods/tokenize.rs @@ -272,8 +272,12 @@ where card_network: card_details.card_network.clone(), card_type: card_details.card_type.clone(), saved_to_locker, - co_badged_card_data: card_details.co_badged_card_data.clone(), + co_badged_card_data: card_details + .co_badged_card_data + .as_ref() + .map(|data| data.into()), }); + create_encrypted_data(&self.state.into(), self.key_store, pm_data) .await .inspect_err(|err| logger::info!("Error encrypting payment method data: {:?}", err)) diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs index b12704aab1f..1d5e2a7b4af 100644 --- a/crates/router/src/core/payments.rs +++ b/crates/router/src/core/payments.rs @@ -471,7 +471,7 @@ where // To perform router related operation for PaymentResponse PaymentResponse: Operation<F, FData, Data = D>, - FData: Send + Sync + Clone, + FData: Send + Sync + Clone + router_types::Capturable, { let operation: BoxedOperation<'_, F, Req, D> = Box::new(operation); @@ -1844,7 +1844,7 @@ pub async fn payments_core<F, Res, Req, Op, FData, D>( ) -> RouterResponse<Res> where F: Send + Clone + Sync, - FData: Send + Sync + Clone, + FData: Send + Sync + Clone + router_types::Capturable, Op: Operation<F, Req, Data = D> + Send + Sync + Clone, Req: Debug + Authenticate + Clone, D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, diff --git a/crates/router/src/core/payments/helpers.rs b/crates/router/src/core/payments/helpers.rs index d855ca84e18..9065dcd2ce3 100644 --- a/crates/router/src/core/payments/helpers.rs +++ b/crates/router/src/core/payments/helpers.rs @@ -44,6 +44,7 @@ use hyperswitch_domain_models::{ use hyperswitch_interfaces::integrity::{CheckIntegrity, FlowIntegrity, GetIntegrityObject}; use josekit::jwe; use masking::{ExposeInterface, PeekInterface, SwitchStrategy}; +use num_traits::{FromPrimitive, ToPrimitive}; use openssl::{ derive::Deriver, pkey::PKey, @@ -52,6 +53,7 @@ use openssl::{ #[cfg(feature = "v2")] use redis_interface::errors::RedisError; use router_env::{instrument, logger, tracing}; +use rust_decimal::Decimal; use serde::{Deserialize, Serialize}; use uuid::Uuid; use x509_parser::parse_x509_certificate; @@ -5208,6 +5210,54 @@ pub fn get_applepay_metadata( }) } +pub fn calculate_debit_routing_savings(net_amount: i64, saving_percentage: f64) -> MinorUnit { + logger::debug!( + ?net_amount, + ?saving_percentage, + "Calculating debit routing saving amount" + ); + + let net_decimal = Decimal::from_i64(net_amount).unwrap_or_else(|| { + logger::warn!(?net_amount, "Invalid net_amount, using 0"); + Decimal::ZERO + }); + + let percentage_decimal = Decimal::from_f64(saving_percentage).unwrap_or_else(|| { + logger::warn!(?saving_percentage, "Invalid saving_percentage, using 0"); + Decimal::ZERO + }); + + let savings_decimal = net_decimal * percentage_decimal / Decimal::from(100); + let rounded_savings = savings_decimal.round(); + + let savings_int = rounded_savings.to_i64().unwrap_or_else(|| { + logger::warn!( + ?rounded_savings, + "Debit routing savings calculation overflowed when converting to i64" + ); + 0 + }); + + MinorUnit::new(savings_int) +} + +pub fn get_debit_routing_savings_amount( + payment_method_data: &domain::PaymentMethodData, + payment_attempt: &PaymentAttempt, +) -> Option<MinorUnit> { + let card_network = payment_attempt.extract_card_network()?; + + let saving_percentage = + payment_method_data.extract_debit_routing_saving_percentage(&card_network)?; + + let net_amount = payment_attempt.get_total_amount().get_amount_as_i64(); + + Some(calculate_debit_routing_savings( + net_amount, + saving_percentage, + )) +} + #[cfg(all(feature = "retry", feature = "v1"))] pub async fn get_apple_pay_retryable_connectors<F, D>( state: &SessionState, diff --git a/crates/router/src/core/payments/operations/payment_response.rs b/crates/router/src/core/payments/operations/payment_response.rs index 939679ef51f..e72555b2ede 100644 --- a/crates/router/src/core/payments/operations/payment_response.rs +++ b/crates/router/src/core/payments/operations/payment_response.rs @@ -1767,6 +1767,14 @@ async fn payment_response_update_tracker<F: Clone, T: types::Capturable>( let payment_method_id = payment_data.payment_attempt.payment_method_id.clone(); + let debit_routing_savings = + payment_data.payment_method_data.as_ref().and_then(|data| { + payments_helpers::get_debit_routing_savings_amount( + data, + &payment_data.payment_attempt, + ) + }); + utils::add_apple_pay_payment_status_metrics( router_data.status, router_data.apple_pay_flow.clone(), @@ -1857,6 +1865,7 @@ async fn payment_response_update_tracker<F: Clone, T: types::Capturable>( setup_future_usage_applied: payment_data .payment_attempt .setup_future_usage_applied, + debit_routing_savings, }), ), }; diff --git a/crates/router/src/core/payments/retry.rs b/crates/router/src/core/payments/retry.rs index 728396ef530..f7d8b3e888b 100644 --- a/crates/router/src/core/payments/retry.rs +++ b/crates/router/src/core/payments/retry.rs @@ -48,7 +48,7 @@ pub async fn do_gsm_actions<F, ApiRequest, FData, D>( ) -> RouterResult<types::RouterData<F, FData, types::PaymentsResponseData>> where F: Clone + Send + Sync, - FData: Send + Sync, + FData: Send + Sync + types::Capturable, payments::PaymentResponse: operations::Operation<F, FData>, D: payments::OperationSessionGetters<F> + payments::OperationSessionSetters<F> @@ -345,7 +345,7 @@ pub async fn do_retry<F, ApiRequest, FData, D>( ) -> RouterResult<types::RouterData<F, FData, types::PaymentsResponseData>> where F: Clone + Send + Sync, - FData: Send + Sync, + FData: Send + Sync + types::Capturable, payments::PaymentResponse: operations::Operation<F, FData>, D: payments::OperationSessionGetters<F> + payments::OperationSessionSetters<F> @@ -425,7 +425,7 @@ pub async fn modify_trackers<F, FData, D>( ) -> RouterResult<()> where F: Clone + Send, - FData: Send, + FData: Send + types::Capturable, D: payments::OperationSessionGetters<F> + payments::OperationSessionSetters<F> + Send + Sync, { let new_attempt_count = payment_data.get_payment_intent().attempt_count + 1; @@ -451,6 +451,13 @@ where .and_then(|connector_response| connector_response.additional_payment_method_data), )?; + let debit_routing_savings = payment_data.get_payment_method_data().and_then(|data| { + payments::helpers::get_debit_routing_savings_amount( + data, + payment_data.get_payment_attempt(), + ) + }); + match router_data.response { Ok(types::PaymentsResponseData::TransactionResponse { resource_id, @@ -506,6 +513,7 @@ where connector_mandate_detail: None, charges, setup_future_usage_applied: None, + debit_routing_savings, }; #[cfg(feature = "v1")] diff --git a/crates/router/src/core/routing/transformers.rs b/crates/router/src/core/routing/transformers.rs index 6560e6786c8..b13dee1bcb4 100644 --- a/crates/router/src/core/routing/transformers.rs +++ b/crates/router/src/core/routing/transformers.rs @@ -180,7 +180,7 @@ impl OpenRouterDecideGatewayRequestExt for OpenRouterDecideGatewayRequest { Self { payment_info: PaymentInfo { payment_id: attempt.payment_id.clone(), - amount: attempt.net_amount.get_order_amount(), + amount: attempt.net_amount.get_total_amount(), currency: attempt.currency.unwrap_or(storage_enums::Currency::USD), payment_type: "ORDER_PAYMENT".to_string(), card_isin: card_isin.map(|value| value.peek().clone()), diff --git a/crates/router/src/db/kafka_store.rs b/crates/router/src/db/kafka_store.rs index 7f24d2f5c99..68af56f2262 100644 --- a/crates/router/src/db/kafka_store.rs +++ b/crates/router/src/db/kafka_store.rs @@ -1520,11 +1520,18 @@ impl PaymentAttemptInterface for KafkaStore { payment_attempt: storage::PaymentAttemptUpdate, storage_scheme: MerchantStorageScheme, ) -> CustomResult<storage::PaymentAttempt, errors::StorageError> { - let attempt = self + let mut attempt = self .diesel_store - .update_payment_attempt_with_attempt_id(this.clone(), payment_attempt, storage_scheme) + .update_payment_attempt_with_attempt_id( + this.clone(), + payment_attempt.clone(), + storage_scheme, + ) .await?; + let debit_routing_savings = payment_attempt.get_debit_routing_savings(); + + attempt.set_debit_routing_savings(debit_routing_savings); if let Err(er) = self .kafka_producer .log_payment_attempt(&attempt, Some(this), self.tenant_id.clone()) diff --git a/crates/router/src/services/kafka/payment_attempt.rs b/crates/router/src/services/kafka/payment_attempt.rs index f51e5a12d29..e0dbc6ad213 100644 --- a/crates/router/src/services/kafka/payment_attempt.rs +++ b/crates/router/src/services/kafka/payment_attempt.rs @@ -70,6 +70,7 @@ pub struct KafkaPaymentAttempt<'a> { pub card_network: Option<String>, pub card_discovery: Option<String>, pub routing_approach: Option<storage_enums::RoutingApproach>, + pub debit_routing_savings: Option<MinorUnit>, } #[cfg(feature = "v1")] @@ -132,6 +133,7 @@ impl<'a> KafkaPaymentAttempt<'a> { .card_discovery .map(|discovery| discovery.to_string()), routing_approach: attempt.routing_approach, + debit_routing_savings: attempt.debit_routing_savings, } } } diff --git a/crates/router/src/services/kafka/payment_attempt_event.rs b/crates/router/src/services/kafka/payment_attempt_event.rs index e2a88e2c29d..a54ff3cc28a 100644 --- a/crates/router/src/services/kafka/payment_attempt_event.rs +++ b/crates/router/src/services/kafka/payment_attempt_event.rs @@ -71,6 +71,7 @@ pub struct KafkaPaymentAttemptEvent<'a> { pub card_network: Option<String>, pub card_discovery: Option<String>, pub routing_approach: Option<storage_enums::RoutingApproach>, + pub debit_routing_savings: Option<MinorUnit>, } #[cfg(feature = "v1")] @@ -133,6 +134,7 @@ impl<'a> KafkaPaymentAttemptEvent<'a> { .card_discovery .map(|discovery| discovery.to_string()), routing_approach: attempt.routing_approach, + debit_routing_savings: attempt.debit_routing_savings, } } } diff --git a/crates/storage_impl/src/mock_db/payment_attempt.rs b/crates/storage_impl/src/mock_db/payment_attempt.rs index 88ddc824b2f..ec27f9bed65 100644 --- a/crates/storage_impl/src/mock_db/payment_attempt.rs +++ b/crates/storage_impl/src/mock_db/payment_attempt.rs @@ -237,6 +237,7 @@ impl PaymentAttemptInterface for MockDb { setup_future_usage_applied: payment_attempt.setup_future_usage_applied, routing_approach: payment_attempt.routing_approach, connector_request_reference_id: payment_attempt.connector_request_reference_id, + debit_routing_savings: None, }; payment_attempts.push(payment_attempt.clone()); Ok(payment_attempt) diff --git a/crates/storage_impl/src/payments/payment_attempt.rs b/crates/storage_impl/src/payments/payment_attempt.rs index 2c69c0766ba..b3fccea353e 100644 --- a/crates/storage_impl/src/payments/payment_attempt.rs +++ b/crates/storage_impl/src/payments/payment_attempt.rs @@ -689,6 +689,7 @@ impl<T: DatabaseStore> PaymentAttemptInterface for KVRouterStore<T> { connector_request_reference_id: payment_attempt .connector_request_reference_id .clone(), + debit_routing_savings: None, }; let field = format!("pa_{}", created_attempt.attempt_id); @@ -1989,6 +1990,7 @@ impl DataModelExt for PaymentAttempt { setup_future_usage_applied: storage_model.setup_future_usage_applied, routing_approach: storage_model.routing_approach, connector_request_reference_id: storage_model.connector_request_reference_id, + debit_routing_savings: None, } } }

2025-07-02T07:21:14Z

- [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  This pull request introduces a new feature to track and analyze debit routing savings and integrates it across multiple components of the analytics system. It also refactors the handling of co-badged card networks to provide additional details, such as saving percentages. Below is a breakdown of the most important changes grouped by theme: ### Debit Routing Analytics Integration: * Added a new column `debit_routing_savings` to the `payment_attempt_queue`, `payment_attempts`, and `payment_attempt_mv` tables in ClickHouse for tracking debit routing savings. * Updated the `PaymentMetricsAccumulator` struct to include a new `DebitRoutingAccumulator`, which tracks transaction counts and savings amounts. Implemented the necessary methods for metric collection and aggregation. * Introduced a new `PaymentMetrics::DebitRouting` enum variant and its corresponding implementation to load metrics, process data, and convert savings to USD. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  ## How did you test it?  -> Enable debit routing for a profile -> Configure adyen connector with local debit networks enabled -> Make some debit routing payments ``` { "amount": 1, "amount_to_capture": 1, "currency": "USD", "confirm": true, "capture_method": "automatic", "setup_future_usage": "on_session", "capture_on": "2022-09-10T10:11:12Z", "email": "[email protected]", "name": "John Doe", "phone": "999999999", "phone_country_code": "+1", "description": "Its my first payment request", "authentication_type": "no_three_ds", "customer_id": "cu_{{$timestamp}}", "return_url": "http://127.0.0.1:4040", "payment_method": "card", "payment_method_type": "debit", "payment_method_data": { "card": { "card_number": "4000 0330 0330 0335", "card_exp_month": "03", "card_exp_year": "2030", "card_holder_name": "joseph Doe", "card_cvc": "737" } }, "billing": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San", "state": "California", "zip": "94122", "country": "US", "first_name": "PiX", "last_name": "ss" }, "email": "[email protected]" }, "shipping": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "PiX" } }, "customer_acceptance": { "acceptance_type": "offline", "accepted_at": "1963-05-03T04:07:52.723Z", "online": { "ip_address": "in sit", "user_agent": "amet irure esse" } }, "browser_info": { "user_agent": "Mozilla\/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/70.0.3538.110 Safari\/537.36", "accept_header": "text\/html,application\/xhtml+xml,application\/xml;q=0.9,image\/webp,image\/apng,*\/*;q=0.8", "language": "nl-NL", "color_depth": 24, "screen_height": 723, "screen_width": 1536, "time_zone": 0, "java_enabled": true, "java_script_enabled": true, "ip_address": "125.0.0.1" }, "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "metadata": { "udf1": "value1", "new_customer": "true", "login_date": "2019-09-10T10:11:12Z" } } ``` ``` { "payment_id": "pay_xrXjk0rlKJG83LNngQ2B", "merchant_id": "merchant_1751293949", "status": "succeeded", "amount": 150000, "net_amount": 150000, "shipping_cost": null, "amount_capturable": 0, "amount_received": 150000, "connector": "adyen", "client_secret": "pay_xrXjk0rlKJG83LNngQ2B_secret_doz5GI9CEnlmcQoBpiNT", "created": "2025-06-30T15:09:44.649Z", "currency": "USD", "customer_id": "cu_1751296185", "customer": { "id": "cu_1751296185", "name": "John Doe", "email": "[email protected]", "phone": "999999999", "phone_country_code": "+1" }, "description": "Its my first payment request", "refunds": null, "disputes": null, "attempts": [ { "attempt_id": "pay_xrXjk0rlKJG83LNngQ2B_1", "status": "charged", "amount": 150000, "order_tax_amount": null, "currency": "USD", "connector": "adyen", "error_message": null, "payment_method": "card", "connector_transaction_id": "KGRXNH7KQZ9TPM75", "capture_method": "automatic", "authentication_type": "no_three_ds", "created_at": "2025-06-30T15:09:44.649Z", "modified_at": "2025-06-30T15:09:45.587Z", "cancellation_reason": null, "mandate_id": null, "error_code": null, "payment_token": null, "connector_metadata": null, "payment_experience": null, "payment_method_type": "debit", "reference_id": "pay_xrXjk0rlKJG83LNngQ2B_1", "unified_code": null, "unified_message": null, "client_source": null, "client_version": null } ], "mandate_id": null, "mandate_data": null, "setup_future_usage": "on_session", "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "card", "payment_method_data": { "card": { "last4": "0335", "card_type": null, "card_network": "Nyce", "card_issuer": null, "card_issuing_country": null, "card_isin": "400003", "card_extended_bin": null, "card_exp_month": "03", "card_exp_year": "2030", "card_holder_name": "joseph Doe", "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "PiX", "last_name": null }, "phone": null, "email": null }, "billing": { "address": { "city": "San", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "PiX", "last_name": "ss" }, "phone": null, "email": "[email protected]" }, "order_details": null, "email": "[email protected]", "name": "John Doe", "phone": "999999999", "return_url": "http://127.0.0.1:4040/", "authentication_type": "no_three_ds", "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "debit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": false, "connector_transaction_id": "KGRXNH7KQZ9TPM75", "frm_message": null, "metadata": { "udf1": "value1", "login_date": "2019-09-10T10:11:12Z", "new_customer": "true" }, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_xrXjk0rlKJG83LNngQ2B_1", "payment_link": null, "profile_id": "pro_0YmTwtjkst9iUDkg4R5D", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_d1x2St1F4pbgEFYNmxOV", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-06-30T15:24:44.649Z", "fingerprint": null, "browser_info": { "language": "nl-NL", "time_zone": 0, "ip_address": "125.0.0.1", "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "color_depth": 24, "java_enabled": true, "screen_width": 1536, "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8", "screen_height": 723, "java_script_enabled": true }, "payment_method_id": "pm_pRJ3v7spaJ1pfIsMlAqD", "payment_method_status": "active", "updated": "2025-06-30T15:09:45.566Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` -> Payment FIlters ``` curl --location 'http://localhost:8080/analytics/v1/org/filters/payments' \ --header 'Accept: */*' \ --header 'Accept-Language: en-US,en;q=0.9' \ --header 'Connection: keep-alive' \ --header 'Content-Type: application/json' \ --header 'Origin: http://localhost:9000' \ --header 'Referer: http://localhost:9000/' \ --header 'Sec-Fetch-Dest: empty' \ --header 'Sec-Fetch-Mode: cors' \ --header 'Sec-Fetch-Site: same-site' \ --header 'User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/128.0.0.0 Safari/537.36' \ --header 'api-key: hyperswitch' \ --header 'authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiZTAxZDlhMzgtMDdlMi00ZmFiLTg3ZmYtZWU0NmE2YTU2MDlhIiwibWVyY2hhbnRfaWQiOiJtZXJjaGFudF8xNzUxMjkzOTQ5Iiwicm9sZV9pZCI6Im9yZ19hZG1pbiIsImV4cCI6MTc1MTQ2Njc1MSwib3JnX2lkIjoib3JnX2tOa2k3aXBKS1h4NFc3bGVJU3FQIiwicHJvZmlsZV9pZCI6InByb18wWW1Ud3Rqa3N0OWlVRGtnNFI1RCIsInRlbmFudF9pZCI6InB1YmxpYyJ9.jty5ccBH_Em-odSAlde-FQLMC34aoGdV_UYsJFoUN-w' \ --header 'sec-ch-ua: "Chromium";v="128", "Not;A=Brand";v="24", "Google Chrome";v="128"' \ --header 'sec-ch-ua-mobile: ?0' \ --header 'sec-ch-ua-platform: "macOS"' \ --data '{ "timeRange": { "startTime": "2024-09-03T18:30:00.000Z", "endTime": "2025-09-12T09:22:30.000Z" }, "groupByNames": [ "connector", "payment_method", "payment_method_type", "currency", "authentication_type", "status", "client_source", "client_version", "profile_id", "routing_approach" ], "source": "BATCH", "delta": true }' ``` ``` { "queryData": [ { "dimension": "connector", "values": [ "adyen" ] }, { "dimension": "payment_method", "values": [ "card" ] }, { "dimension": "payment_method_type", "values": [ "debit" ] }, { "dimension": "currency", "values": [ "USD" ] }, { "dimension": "authentication_type", "values": [ "no_three_ds" ] }, { "dimension": "status", "values": [ "charged" ] }, { "dimension": "client_source", "values": [] }, { "dimension": "client_version", "values": [] }, { "dimension": "profile_id", "values": [ "pro_0YmTwtjkst9iUDkg4R5D" ] }, { "dimension": "routing_approach", "values": [ "default_fallback", "debit_routing" ] } ] } ``` -> Payment metric that gives total debit routed txn and savings ``` curl --location 'http://localhost:8080/analytics/v1/org/metrics/payments' \ --header 'Accept: */*' \ --header 'Accept-Language: en-US,en;q=0.9' \ --header 'Connection: keep-alive' \ --header 'Content-Type: application/json' \ --header 'Origin: http://localhost:9000' \ --header 'Referer: http://localhost:9000/' \ --header 'Sec-Fetch-Dest: empty' \ --header 'Sec-Fetch-Mode: cors' \ --header 'Sec-Fetch-Site: same-site' \ --header 'User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/128.0.0.0 Safari/537.36' \ --header 'sec-ch-ua: "Chromium";v="128", "Not;A=Brand";v="24", "Google Chrome";v="128"' \ --header 'sec-ch-ua-mobile: ?0' \ --header 'sec-ch-ua-platform: "macOS"' \ --header 'api-key: dev_cW7LmHwdGurYUqCHLMkUX8AfU9uYzKJc6sT0bsAB1wQJFe6lOP01lRO30Dj0WpcH' \ --header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiZTAxZDlhMzgtMDdlMi00ZmFiLTg3ZmYtZWU0NmE2YTU2MDlhIiwibWVyY2hhbnRfaWQiOiJtZXJjaGFudF8xNzUxMjkzOTQ5Iiwicm9sZV9pZCI6Im9yZ19hZG1pbiIsImV4cCI6MTc1MTQ2Njc1MSwib3JnX2lkIjoib3JnX2tOa2k3aXBKS1h4NFc3bGVJU3FQIiwicHJvZmlsZV9pZCI6InByb18wWW1Ud3Rqa3N0OWlVRGtnNFI1RCIsInRlbmFudF9pZCI6InB1YmxpYyJ9.jty5ccBH_Em-odSAlde-FQLMC34aoGdV_UYsJFoUN-w' \ --data '[ { "timeRange": { "startTime": "2025-03-01T18:30:00Z", "endTime": "2025-07-31T09:22:00Z" }, "filters": { "routing_approach": [ "debit_routing" ] }, "source": "BATCH", "metrics": [ "debit_routing" ], "timeSeries": { "granularity": "G_ONEDAY" }, "delta": true } ]' ``` ``` { "queryData": [ { "payment_success_rate": null, "payment_count": null, "payment_success_count": null, "payment_processed_amount": 0, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "debit_routed_transaction_count": 8, "debit_routing_savings": 369, "debit_routing_savings_in_usd": null, "currency": "USD", "status": null, "connector": null, "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": null, "time_range": { "start_time": "2025-06-30T00:00:00.000Z", "end_time": "2025-06-30T23:00:00.000Z" }, "time_bucket": "2025-06-30 00:00:00" } ], "metaData": [ { "total_payment_processed_amount": 0, "total_payment_processed_amount_in_usd": null, "total_payment_processed_amount_without_smart_retries": 0, "total_payment_processed_amount_without_smart_retries_usd": null, "total_payment_processed_count": 0, "total_payment_processed_count_without_smart_retries": 0, "total_failure_reasons_count": 0, "total_failure_reasons_count_without_smart_retries": 0 } ] } ``` -> Payment metrics that gives savings per txn ``` curl --location 'http://localhost:8080/analytics/v1/org/metrics/payments' \ --header 'Accept: */*' \ --header 'Accept-Language: en-US,en;q=0.9' \ --header 'Connection: keep-alive' \ --header 'Content-Type: application/json' \ --header 'Origin: http://localhost:9000' \ --header 'Referer: http://localhost:9000/' \ --header 'Sec-Fetch-Dest: empty' \ --header 'Sec-Fetch-Mode: cors' \ --header 'Sec-Fetch-Site: same-site' \ --header 'User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/128.0.0.0 Safari/537.36' \ --header 'sec-ch-ua: "Chromium";v="128", "Not;A=Brand";v="24", "Google Chrome";v="128"' \ --header 'sec-ch-ua-mobile: ?0' \ --header 'sec-ch-ua-platform: "macOS"' \ --header 'api-key: dev_cW7LmHwdGurYUqCHLMkUX8AfU9uYzKJc6sT0bsAB1wQJFe6lOP01lRO30Dj0WpcH' \ --header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiZTAxZDlhMzgtMDdlMi00ZmFiLTg3ZmYtZWU0NmE2YTU2MDlhIiwibWVyY2hhbnRfaWQiOiJtZXJjaGFudF8xNzUxMjkzOTQ5Iiwicm9sZV9pZCI6Im9yZ19hZG1pbiIsImV4cCI6MTc1MTQ2Njc1MSwib3JnX2lkIjoib3JnX2tOa2k3aXBKS1h4NFc3bGVJU3FQIiwicHJvZmlsZV9pZCI6InByb18wWW1Ud3Rqa3N0OWlVRGtnNFI1RCIsInRlbmFudF9pZCI6InB1YmxpYyJ9.jty5ccBH_Em-odSAlde-FQLMC34aoGdV_UYsJFoUN-w' \ --data '[ { "timeRange": { "startTime": "2025-03-01T18:30:00Z", "endTime": "2025-07-31T09:22:00Z" }, "groupByNames": [ "card_network" ], "filters": { "routing_approach": [ "debit_routing" ] }, "source": "BATCH", "metrics": [ "debit_routing" ], "timeSeries": { "granularity": "G_ONEDAY" }, "delta": true } ]' ``` ``` { "queryData": [ { "payment_success_rate": null, "payment_count": null, "payment_success_count": null, "payment_processed_amount": 0, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "debit_routed_transaction_count": 2, "debit_routing_savings": 107, "debit_routing_savings_in_usd": null, "currency": "USD", "status": null, "connector": null, "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": "Star", "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": null, "time_range": { "start_time": "2025-06-30T00:00:00.000Z", "end_time": "2025-06-30T23:00:00.000Z" }, "time_bucket": "2025-06-30 00:00:00" }, { "payment_success_rate": null, "payment_count": null, "payment_success_count": null, "payment_processed_amount": 0, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "debit_routed_transaction_count": 2, "debit_routing_savings": 199, "debit_routing_savings_in_usd": null, "currency": "USD", "status": null, "connector": null, "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": "Nyce", "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": null, "time_range": { "start_time": "2025-06-30T00:00:00.000Z", "end_time": "2025-06-30T23:00:00.000Z" }, "time_bucket": "2025-06-30 00:00:00" }, { "payment_success_rate": null, "payment_count": null, "payment_success_count": null, "payment_processed_amount": 0, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "debit_routed_transaction_count": 3, "debit_routing_savings": 0, "debit_routing_savings_in_usd": null, "currency": "USD", "status": null, "connector": null, "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": "Visa", "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": null, "time_range": { "start_time": "2025-06-30T00:00:00.000Z", "end_time": "2025-06-30T23:00:00.000Z" }, "time_bucket": "2025-06-30 00:00:00" }, { "payment_success_rate": null, "payment_count": null, "payment_success_count": null, "payment_processed_amount": 0, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "debit_routed_transaction_count": 1, "debit_routing_savings": 63, "debit_routing_savings_in_usd": null, "currency": "USD", "status": null, "connector": null, "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": "Accel", "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": null, "time_range": { "start_time": "2025-06-30T00:00:00.000Z", "end_time": "2025-06-30T23:00:00.000Z" }, "time_bucket": "2025-06-30 00:00:00" } ], "metaData": [ { "total_payment_processed_amount": 0, "total_payment_processed_amount_in_usd": null, "total_payment_processed_amount_without_smart_retries": 0, "total_payment_processed_amount_without_smart_retries_usd": null, "total_payment_processed_count": 0, "total_payment_processed_count_without_smart_retries": 0, "total_failure_reasons_count": 0, "total_failure_reasons_count_without_smart_retries": 0 } ] } ``` ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

6678ee351748e5629a22e84677d58297cbac62a5

juspay/hyperswitch

juspay__hyperswitch-8507

Bug: [FEATURE] populate connector raw response and connector_response_reference_id in v2 populate connector raw response and connector_response_reference_id

diff --git a/api-reference/v2/openapi_spec_v2.json b/api-reference/v2/openapi_spec_v2.json index 8da8f56f709..76a35e926e2 100644 --- a/api-reference/v2/openapi_spec_v2.json +++ b/api-reference/v2/openapi_spec_v2.json @@ -17881,41 +17881,6 @@ "propertyName": "payment_processing_details_at" } }, - "PaymentRetrieveBody": { - "type": "object", - "properties": { - "merchant_id": { - "type": "string", - "description": "The identifier for the Merchant Account.", - "nullable": true - }, - "force_sync": { - "type": "boolean", - "description": "Decider to enable or disable the connector call for retrieve request", - "nullable": true - }, - "client_secret": { - "type": "string", - "description": "This is a token which expires after 15 minutes, used from the client to authenticate and create sessions from the SDK", - "nullable": true - }, - "expand_captures": { - "type": "boolean", - "description": "If enabled provides list of captures linked to latest attempt", - "nullable": true - }, - "expand_attempts": { - "type": "boolean", - "description": "If enabled provides list of attempts linked to payment intent", - "nullable": true - }, - "all_keys_required": { - "type": "boolean", - "description": "If enabled, provides whole connector response", - "nullable": true - } - } - }, "PaymentRevenueRecoveryMetadata": { "type": "object", "required": [ @@ -18128,6 +18093,11 @@ } ], "nullable": true + }, + "return_raw_connector_response": { + "type": "boolean", + "description": "If true, returns stringified connector raw response body", + "nullable": true } }, "additionalProperties": false @@ -19127,6 +19097,11 @@ } ], "nullable": true + }, + "return_raw_connector_response": { + "type": "boolean", + "description": "Stringified connector raw response body. Only returned if `return_raw_connector_response` is true", + "nullable": true } }, "additionalProperties": false @@ -19311,6 +19286,11 @@ "nullable": true, "maxLength": 30, "minLength": 30 + }, + "raw_connector_response": { + "type": "string", + "description": "Stringified connector raw response body. Only returned if `return_raw_connector_response` is true", + "nullable": true } } }, @@ -19331,9 +19311,9 @@ "description": "These are the query params that are sent in case of redirect response.\nThese can be ingested by the connector to take necessary actions.", "nullable": true }, - "all_keys_required": { + "return_raw_connector_response": { "type": "boolean", - "description": "If enabled, provides whole connector response", + "description": "If true, returns stringified connector raw response body", "nullable": true }, "merchant_connector_details": { @@ -19394,9 +19374,9 @@ "description": "These are the query params that are sent in case of redirect response.\nThese can be ingested by the connector to take necessary actions.", "nullable": true }, - "all_keys_required": { + "return_raw_connector_response": { "type": "boolean", - "description": "If enabled, provides whole connector response", + "description": "If true, returns stringified connector raw response body", "nullable": true } } diff --git a/crates/api_models/src/payments.rs b/crates/api_models/src/payments.rs index 2ff07472a0d..9150697aa19 100644 --- a/crates/api_models/src/payments.rs +++ b/crates/api_models/src/payments.rs @@ -5347,6 +5347,9 @@ pub struct PaymentsConfirmIntentRequest { /// Merchant connector details used to make payments. #[schema(value_type = Option<MerchantConnectorAuthDetails>)] pub merchant_connector_details: Option<common_types::domain::MerchantConnectorAuthDetails>, + + /// If true, returns stringified connector raw response body + pub return_raw_connector_response: Option<bool>, } #[cfg(feature = "v2")] @@ -5523,6 +5526,9 @@ pub struct PaymentsRequest { /// Merchant connector details used to make payments. #[schema(value_type = Option<MerchantConnectorAuthDetails>)] pub merchant_connector_details: Option<common_types::domain::MerchantConnectorAuthDetails>, + + /// Stringified connector raw response body. Only returned if `return_raw_connector_response` is true + pub return_raw_connector_response: Option<bool>, } #[cfg(feature = "v2")] @@ -5575,6 +5581,7 @@ impl From<&PaymentsRequest> for PaymentsConfirmIntentRequest { payment_method_id: request.payment_method_id.clone(), payment_token: None, merchant_connector_details: request.merchant_connector_details.clone(), + return_raw_connector_response: request.return_raw_connector_response, } } } @@ -5597,8 +5604,8 @@ pub struct PaymentsRetrieveRequest { /// These are the query params that are sent in case of redirect response. /// These can be ingested by the connector to take necessary actions. pub param: Option<String>, - /// If enabled, provides whole connector response - pub all_keys_required: Option<bool>, + /// If true, returns stringified connector raw response body + pub return_raw_connector_response: Option<bool>, /// Merchant connector details used to make payments. #[schema(value_type = Option<MerchantConnectorAuthDetails>)] pub merchant_connector_details: Option<common_types::domain::MerchantConnectorAuthDetails>, @@ -5619,8 +5626,8 @@ pub struct PaymentsStatusRequest { /// These are the query params that are sent in case of redirect response. /// These can be ingested by the connector to take necessary actions. pub param: Option<String>, - /// If enabled, provides whole connector response - pub all_keys_required: Option<bool>, + /// If true, returns stringified connector raw response body + pub return_raw_connector_response: Option<bool>, } /// Error details for the payment @@ -5776,6 +5783,9 @@ pub struct PaymentsResponse { example = "pay_mbabizu24mvu3mela5njyhpit4" )] pub merchant_reference_id: Option<id_type::PaymentReferenceId>, + + /// Stringified connector raw response body. Only returned if `return_raw_connector_response` is true + pub raw_connector_response: Option<String>, } #[cfg(feature = "v2")] @@ -7496,6 +7506,7 @@ pub struct PaymentsSessionResponse { pub vault_details: Option<VaultSessionDetails>, } +#[cfg(feature = "v1")] #[derive(Default, Debug, serde::Deserialize, serde::Serialize, Clone, ToSchema)] pub struct PaymentRetrieveBody { /// The identifier for the Merchant Account. @@ -7513,6 +7524,7 @@ pub struct PaymentRetrieveBody { pub all_keys_required: Option<bool>, } +#[cfg(feature = "v1")] #[derive(Default, Debug, serde::Deserialize, serde::Serialize, Clone, ToSchema)] pub struct PaymentRetrieveBodyWithCredentials { /// The identifier for payment. diff --git a/crates/common_types/src/domain.rs b/crates/common_types/src/domain.rs index f41f874cd06..66ffa6029d0 100644 --- a/crates/common_types/src/domain.rs +++ b/crates/common_types/src/domain.rs @@ -106,3 +106,11 @@ pub struct MerchantConnectorAuthDetails { }"#)] pub merchant_connector_creds: common_utils::pii::SecretSerdeValue, } + +/// Connector Response Data that are required to be populated in response +#[cfg(feature = "v2")] +#[derive(Clone, Debug)] +pub struct ConnectorResponseData { + /// Stringified connector raw response body + pub raw_connector_response: Option<String>, +} diff --git a/crates/diesel_models/src/payment_attempt.rs b/crates/diesel_models/src/payment_attempt.rs index eeda9e78877..95bb5a875d1 100644 --- a/crates/diesel_models/src/payment_attempt.rs +++ b/crates/diesel_models/src/payment_attempt.rs @@ -852,7 +852,7 @@ pub struct PaymentAttemptUpdateInternal { // payment_experience: Option<storage_enums::PaymentExperience>, // preprocessing_step_id: Option<String>, pub error_reason: Option<String>, - // connector_response_reference_id: Option<String>, + pub connector_response_reference_id: Option<String>, // multiple_capture_count: Option<i16>, // pub surcharge_amount: Option<MinorUnit>, // tax_on_surcharge: Option<MinorUnit>, @@ -910,6 +910,7 @@ impl PaymentAttemptUpdateInternal { network_error_message, payment_method_id, connector_request_reference_id, + connector_response_reference_id, } = self; PaymentAttempt { @@ -939,7 +940,8 @@ impl PaymentAttemptUpdateInternal { preprocessing_step_id: source.preprocessing_step_id, error_reason: error_reason.or(source.error_reason), multiple_capture_count: source.multiple_capture_count, - connector_response_reference_id: source.connector_response_reference_id, + connector_response_reference_id: connector_response_reference_id + .or(source.connector_response_reference_id), amount_capturable: amount_capturable.unwrap_or(source.amount_capturable), updated_by, merchant_connector_id: merchant_connector_id.or(source.merchant_connector_id), diff --git a/crates/hyperswitch_connectors/src/connectors/razorpay.rs b/crates/hyperswitch_connectors/src/connectors/razorpay.rs index 39b83c73e43..33cdc326987 100644 --- a/crates/hyperswitch_connectors/src/connectors/razorpay.rs +++ b/crates/hyperswitch_connectors/src/connectors/razorpay.rs @@ -316,7 +316,7 @@ impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData connectors: &Connectors, ) -> CustomResult<String, errors::ConnectorError> { Ok(format!( - "{}v1/payments/create/json", + "{}v1/payments/create/upi", self.base_url(connectors) )) } @@ -404,15 +404,15 @@ impl ConnectorIntegration<PSync, PaymentsSyncData, PaymentsResponseData> for Raz req: &PaymentsSyncRouterData, connectors: &Connectors, ) -> CustomResult<String, errors::ConnectorError> { - let connector_payment_id = req + let order_id = req .request - .connector_transaction_id - .get_connector_transaction_id() - .change_context(errors::ConnectorError::MissingConnectorTransactionID)?; + .connector_reference_id + .clone() + .ok_or(errors::ConnectorError::RequestEncodingFailed)?; Ok(format!( - "{}v1/payments/{}", + "{}v1/orders/{}/payments", self.base_url(connectors), - connector_payment_id, + order_id, )) } @@ -512,21 +512,11 @@ impl ConnectorIntegration<Capture, PaymentsCaptureData, PaymentsResponseData> fo fn handle_response( &self, - data: &PaymentsCaptureRouterData, - event_builder: Option<&mut ConnectorEvent>, - res: Response, + _data: &PaymentsCaptureRouterData, + _event_builder: Option<&mut ConnectorEvent>, + _res: Response, ) -> CustomResult<PaymentsCaptureRouterData, errors::ConnectorError> { - let response: razorpay::RazorpayPaymentsResponse = res - .response - .parse_struct("Razorpay PaymentsCaptureResponse") - .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; - event_builder.map(|i| i.set_response_body(&response)); - router_env::logger::info!(connector_response=?response); - RouterData::try_from(ResponseRouterData { - response, - data: data.clone(), - http_code: res.status_code, - }) + Err(errors::ConnectorError::NotImplemented("get_request_body method".to_string()).into()) } fn get_error_response( diff --git a/crates/hyperswitch_connectors/src/connectors/razorpay/transformers.rs b/crates/hyperswitch_connectors/src/connectors/razorpay/transformers.rs index 23aa8828291..0176ae47854 100644 --- a/crates/hyperswitch_connectors/src/connectors/razorpay/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/razorpay/transformers.rs @@ -11,7 +11,7 @@ use hyperswitch_domain_models::{ payment_method_data::{PaymentMethodData, UpiData}, router_data::{ConnectorAuthType, RouterData}, router_flow_types::refunds::{Execute, RSync}, - router_request_types::ResponseId, + router_request_types::{PaymentsAuthorizeData, ResponseId}, router_response_types::{PaymentsResponseData, RefundsResponseData}, types, }; @@ -227,18 +227,29 @@ pub struct NextAction { #[derive(Debug, Clone, Serialize, Deserialize)] pub struct RazorpayPaymentsResponse { pub razorpay_payment_id: String, - pub next: Option<Vec<NextAction>>, } -impl<F, T> TryFrom<ResponseRouterData<F, RazorpayPaymentsResponse, T, PaymentsResponseData>> - for RouterData<F, T, PaymentsResponseData> +impl<F> + TryFrom< + ResponseRouterData< + F, + RazorpayPaymentsResponse, + PaymentsAuthorizeData, + PaymentsResponseData, + >, + > for RouterData<F, PaymentsAuthorizeData, PaymentsResponseData> { type Error = error_stack::Report<errors::ConnectorError>; fn try_from( - item: ResponseRouterData<F, RazorpayPaymentsResponse, T, PaymentsResponseData>, + item: ResponseRouterData< + F, + RazorpayPaymentsResponse, + PaymentsAuthorizeData, + PaymentsResponseData, + >, ) -> Result<Self, Self::Error> { let connector_metadata = get_wait_screen_metadata()?; - + let order_id = item.data.request.get_order_id()?; Ok(Self { status: enums::AttemptStatus::AuthenticationPending, response: Ok(PaymentsResponseData::TransactionResponse { @@ -249,7 +260,7 @@ impl<F, T> TryFrom<ResponseRouterData<F, RazorpayPaymentsResponse, T, PaymentsRe mandate_reference: Box::new(None), connector_metadata, network_txn_id: None, - connector_response_reference_id: Some(item.response.razorpay_payment_id), + connector_response_reference_id: Some(order_id), incremental_authorization_allowed: None, charges: None, }), @@ -281,6 +292,12 @@ pub fn get_wait_screen_metadata() -> CustomResult<Option<serde_json::Value>, err #[derive(Debug, Clone, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct RazorpaySyncResponse { + items: Vec<RazorpaySyncItem>, +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct RazorpaySyncItem { id: String, status: RazorpayStatus, } @@ -311,8 +328,15 @@ impl<F, T> TryFrom<ResponseRouterData<F, RazorpaySyncResponse, T, PaymentsRespon fn try_from( item: ResponseRouterData<F, RazorpaySyncResponse, T, PaymentsResponseData>, ) -> Result<Self, Self::Error> { + let status = match item.response.items.last() { + Some(last_item) => { + let razorpay_status = last_item.status; + get_psync_razorpay_payment_status(razorpay_status) + } + None => item.data.status, + }; Ok(Self { - status: get_psync_razorpay_payment_status(item.response.status), + status, response: Ok(PaymentsResponseData::TransactionResponse { resource_id: ResponseId::NoResponseId, redirection_data: Box::new(None), diff --git a/crates/hyperswitch_connectors/src/utils.rs b/crates/hyperswitch_connectors/src/utils.rs index b346b40d970..1353d068190 100644 --- a/crates/hyperswitch_connectors/src/utils.rs +++ b/crates/hyperswitch_connectors/src/utils.rs @@ -6209,7 +6209,7 @@ pub(crate) fn convert_payment_authorize_router_response<F1, F2, T1, T2>( connector_mandate_request_reference_id: data.connector_mandate_request_reference_id.clone(), authentication_id: data.authentication_id.clone(), psd2_sca_exemption_type: data.psd2_sca_exemption_type, - whole_connector_response: data.whole_connector_response.clone(), + raw_connector_response: data.raw_connector_response.clone(), } } diff --git a/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs b/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs index d644c519ea9..9078f1d49df 100644 --- a/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs +++ b/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs @@ -1763,6 +1763,7 @@ pub struct ConfirmIntentResponseUpdate { pub connector_metadata: Option<pii::SecretSerdeValue>, pub amount_capturable: Option<MinorUnit>, pub connector_token_details: Option<diesel_models::ConnectorTokenDetails>, + pub connector_response_reference_id: Option<String>, } #[cfg(feature = "v2")] @@ -1776,6 +1777,7 @@ pub enum PaymentAttemptUpdate { merchant_connector_id: Option<id_type::MerchantConnectorAccountId>, authentication_type: storage_enums::AuthenticationType, connector_request_reference_id: Option<String>, + connector_response_reference_id: Option<String>, }, /// Update the payment attempt on confirming the intent, before calling the connector, when payment_method_id is present ConfirmIntentTokenized { @@ -2569,6 +2571,7 @@ impl From<PaymentAttemptUpdate> for diesel_models::PaymentAttemptUpdateInternal merchant_connector_id, authentication_type, connector_request_reference_id, + connector_response_reference_id, } => Self { status: Some(status), payment_method_id: None, @@ -2594,6 +2597,7 @@ impl From<PaymentAttemptUpdate> for diesel_models::PaymentAttemptUpdateInternal network_decline_code: None, network_error_message: None, connector_request_reference_id, + connector_response_reference_id, }, PaymentAttemptUpdate::ErrorUpdate { status, @@ -2626,6 +2630,7 @@ impl From<PaymentAttemptUpdate> for diesel_models::PaymentAttemptUpdateInternal network_decline_code: error.network_decline_code, network_error_message: error.network_error_message, connector_request_reference_id: None, + connector_response_reference_id: None, }, PaymentAttemptUpdate::ConfirmIntentResponse(confirm_intent_response_update) => { let ConfirmIntentResponseUpdate { @@ -2636,6 +2641,7 @@ impl From<PaymentAttemptUpdate> for diesel_models::PaymentAttemptUpdateInternal connector_metadata, amount_capturable, connector_token_details, + connector_response_reference_id, } = *confirm_intent_response_update; Self { status: Some(status), @@ -2663,6 +2669,7 @@ impl From<PaymentAttemptUpdate> for diesel_models::PaymentAttemptUpdateInternal network_decline_code: None, network_error_message: None, connector_request_reference_id: None, + connector_response_reference_id, } } PaymentAttemptUpdate::SyncUpdate { @@ -2694,6 +2701,7 @@ impl From<PaymentAttemptUpdate> for diesel_models::PaymentAttemptUpdateInternal network_decline_code: None, network_error_message: None, connector_request_reference_id: None, + connector_response_reference_id: None, }, PaymentAttemptUpdate::CaptureUpdate { status, @@ -2724,6 +2732,7 @@ impl From<PaymentAttemptUpdate> for diesel_models::PaymentAttemptUpdateInternal network_decline_code: None, network_error_message: None, connector_request_reference_id: None, + connector_response_reference_id: None, }, PaymentAttemptUpdate::PreCaptureUpdate { amount_to_capture, @@ -2753,6 +2762,7 @@ impl From<PaymentAttemptUpdate> for diesel_models::PaymentAttemptUpdateInternal network_decline_code: None, network_error_message: None, connector_request_reference_id: None, + connector_response_reference_id: None, }, PaymentAttemptUpdate::ConfirmIntentTokenized { status, @@ -2786,6 +2796,7 @@ impl From<PaymentAttemptUpdate> for diesel_models::PaymentAttemptUpdateInternal network_decline_code: None, network_error_message: None, connector_request_reference_id: None, + connector_response_reference_id: None, }, } } diff --git a/crates/hyperswitch_domain_models/src/router_data.rs b/crates/hyperswitch_domain_models/src/router_data.rs index dd1004c7018..851ac69a81c 100644 --- a/crates/hyperswitch_domain_models/src/router_data.rs +++ b/crates/hyperswitch_domain_models/src/router_data.rs @@ -103,8 +103,8 @@ pub struct RouterData<Flow, Request, Response> { /// Contains the type of sca exemption required for the transaction pub psd2_sca_exemption_type: Option<common_enums::ScaExemptionType>, - /// Contains whole connector response - pub whole_connector_response: Option<String>, + /// Contains stringified connector raw response body + pub raw_connector_response: Option<String>, } // Different patterns of authentication. @@ -567,6 +567,7 @@ impl resource_id, redirection_data, connector_metadata, + connector_response_reference_id, .. } => { let attempt_status = self.get_attempt_status_for_db_update(payment_data); @@ -595,6 +596,8 @@ impl token_details.get_connector_token_request_reference_id() }), ), + connector_response_reference_id: connector_response_reference_id + .clone(), }, )) } @@ -1253,6 +1256,7 @@ impl resource_id, redirection_data, connector_metadata, + connector_response_reference_id, .. } => { let attempt_status = self.get_attempt_status_for_db_update(payment_data); @@ -1281,6 +1285,9 @@ impl token_details.get_connector_token_request_reference_id() }), ), + + connector_response_reference_id: connector_response_reference_id + .clone(), }, )) } diff --git a/crates/hyperswitch_domain_models/src/router_request_types.rs b/crates/hyperswitch_domain_models/src/router_request_types.rs index c7987122ead..31879b4cfe3 100644 --- a/crates/hyperswitch_domain_models/src/router_request_types.rs +++ b/crates/hyperswitch_domain_models/src/router_request_types.rs @@ -508,6 +508,7 @@ pub struct PaymentsSyncData { pub split_payments: Option<common_types::payments::SplitPaymentsRequest>, pub amount: MinorUnit, pub integrity_object: Option<SyncIntegrityObject>, + pub connector_reference_id: Option<String>, } #[derive(Debug, Default, Clone)] diff --git a/crates/hyperswitch_interfaces/src/conversion_impls.rs b/crates/hyperswitch_interfaces/src/conversion_impls.rs index 252caed961e..ae5f071a209 100644 --- a/crates/hyperswitch_interfaces/src/conversion_impls.rs +++ b/crates/hyperswitch_interfaces/src/conversion_impls.rs @@ -84,7 +84,7 @@ fn get_default_router_data<F, Req, Resp>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, } } diff --git a/crates/openapi/src/openapi_v2.rs b/crates/openapi/src/openapi_v2.rs index 4a3c03d69fb..11dae0588ab 100644 --- a/crates/openapi/src/openapi_v2.rs +++ b/crates/openapi/src/openapi_v2.rs @@ -424,7 +424,6 @@ Never share your secret api keys. Keep them guarded and secure. api_models::payments::PaymentsRequest, api_models::payments::PaymentsResponse, api_models::payments::PaymentsListResponseItem, - api_models::payments::PaymentRetrieveBody, api_models::payments::PaymentsRetrieveRequest, api_models::payments::PaymentsStatusRequest, api_models::payments::PaymentsCaptureRequest, diff --git a/crates/router/src/core/authentication/transformers.rs b/crates/router/src/core/authentication/transformers.rs index e1cf04c20aa..91b7c23f053 100644 --- a/crates/router/src/core/authentication/transformers.rs +++ b/crates/router/src/core/authentication/transformers.rs @@ -206,7 +206,7 @@ pub fn construct_router_data<F: Clone, Req, Res>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type, - whole_connector_response: None, + raw_connector_response: None, }) } diff --git a/crates/router/src/core/fraud_check/flows/checkout_flow.rs b/crates/router/src/core/fraud_check/flows/checkout_flow.rs index 786192f8e98..a33dcc89a99 100644 --- a/crates/router/src/core/fraud_check/flows/checkout_flow.rs +++ b/crates/router/src/core/fraud_check/flows/checkout_flow.rs @@ -161,7 +161,7 @@ impl ConstructFlowSpecificData<frm_api::Checkout, FraudCheckCheckoutData, FraudC connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) diff --git a/crates/router/src/core/fraud_check/flows/fulfillment_flow.rs b/crates/router/src/core/fraud_check/flows/fulfillment_flow.rs index 421c255e117..08b3c789264 100644 --- a/crates/router/src/core/fraud_check/flows/fulfillment_flow.rs +++ b/crates/router/src/core/fraud_check/flows/fulfillment_flow.rs @@ -128,7 +128,7 @@ pub async fn construct_fulfillment_router_data<'a>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) } diff --git a/crates/router/src/core/fraud_check/flows/record_return.rs b/crates/router/src/core/fraud_check/flows/record_return.rs index ea34b8af172..d33cd51e574 100644 --- a/crates/router/src/core/fraud_check/flows/record_return.rs +++ b/crates/router/src/core/fraud_check/flows/record_return.rs @@ -129,7 +129,7 @@ impl ConstructFlowSpecificData<RecordReturn, FraudCheckRecordReturnData, FraudCh connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) diff --git a/crates/router/src/core/fraud_check/flows/sale_flow.rs b/crates/router/src/core/fraud_check/flows/sale_flow.rs index efdeeec7747..55d53f00964 100644 --- a/crates/router/src/core/fraud_check/flows/sale_flow.rs +++ b/crates/router/src/core/fraud_check/flows/sale_flow.rs @@ -137,7 +137,7 @@ impl ConstructFlowSpecificData<frm_api::Sale, FraudCheckSaleData, FraudCheckResp connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) diff --git a/crates/router/src/core/fraud_check/flows/transaction_flow.rs b/crates/router/src/core/fraud_check/flows/transaction_flow.rs index eae995be4b4..29013c70e92 100644 --- a/crates/router/src/core/fraud_check/flows/transaction_flow.rs +++ b/crates/router/src/core/fraud_check/flows/transaction_flow.rs @@ -146,7 +146,7 @@ impl connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) diff --git a/crates/router/src/core/mandate/utils.rs b/crates/router/src/core/mandate/utils.rs index 642a28c5671..1298162d412 100644 --- a/crates/router/src/core/mandate/utils.rs +++ b/crates/router/src/core/mandate/utils.rs @@ -85,7 +85,7 @@ pub async fn construct_mandate_revoke_router_data( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) diff --git a/crates/router/src/core/payment_methods.rs b/crates/router/src/core/payment_methods.rs index 6d36f7d4341..d04bf5b39ed 100644 --- a/crates/router/src/core/payment_methods.rs +++ b/crates/router/src/core/payment_methods.rs @@ -2922,6 +2922,7 @@ fn construct_zero_auth_payments_request( force_3ds_challenge: None, is_iframe_redirection_enabled: None, merchant_connector_details: None, + return_raw_connector_response: None, }) } @@ -3263,7 +3264,7 @@ async fn create_single_use_tokenization_flow( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; let payment_method_token_response = tokenization::add_token_for_payment_method( diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs index 66334148b09..7e5328763fd 100644 --- a/crates/router/src/core/payments.rs +++ b/crates/router/src/core/payments.rs @@ -148,7 +148,14 @@ pub async fn payments_operation_core<F, Req, Op, FData, D>( get_tracker_response: operations::GetTrackerResponse<D>, call_connector_action: CallConnectorAction, header_payload: HeaderPayload, -) -> RouterResult<(D, Req, Option<domain::Customer>, Option<u16>, Option<u128>)> +) -> RouterResult<( + D, + Req, + Option<domain::Customer>, + Option<u16>, + Option<u128>, + common_types::domain::ConnectorResponseData, +)> where F: Send + Clone + Sync, Req: Send + Sync + Authenticate, @@ -204,7 +211,7 @@ where .perform_routing(&merchant_context, profile, state, &mut payment_data) .await?; - let payment_data = match connector { + let (payment_data, connector_response_data) = match connector { ConnectorCallType::PreDetermined(connector_data) => { let router_data = call_connector_service( state, @@ -224,10 +231,14 @@ where profile, false, false, //should_retry_with_pan is set to false in case of PreDetermined ConnectorCallType - req.get_all_keys_required(), + req.should_return_raw_response(), ) .await?; + let connector_response_data = common_types::domain::ConnectorResponseData { + raw_connector_response: router_data.raw_connector_response.clone(), + }; + let payments_response_operation = Box::new(PaymentResponse); payments_response_operation @@ -241,7 +252,7 @@ where ) .await?; - payments_response_operation + let payment_data = payments_response_operation .to_post_update_tracker()? .update_tracker( state, @@ -250,7 +261,9 @@ where merchant_context.get_merchant_key_store(), merchant_context.get_merchant_account().storage_scheme, ) - .await? + .await?; + + (payment_data, connector_response_data) } ConnectorCallType::Retryable(connectors) => { let mut connectors = connectors.clone().into_iter(); @@ -273,10 +286,14 @@ where profile, false, false, //should_retry_with_pan is set to false in case of PreDetermined ConnectorCallType - req.get_all_keys_required(), + req.should_return_raw_response(), ) .await?; + let connector_response_data = common_types::domain::ConnectorResponseData { + raw_connector_response: router_data.raw_connector_response.clone(), + }; + let payments_response_operation = Box::new(PaymentResponse); payments_response_operation @@ -290,7 +307,7 @@ where ) .await?; - payments_response_operation + let payment_data = payments_response_operation .to_post_update_tracker()? .update_tracker( state, @@ -299,10 +316,17 @@ where merchant_context.get_merchant_key_store(), merchant_context.get_merchant_account().storage_scheme, ) - .await? + .await?; + + (payment_data, connector_response_data) } ConnectorCallType::SessionMultiple(vec) => todo!(), - ConnectorCallType::Skip => payment_data, + ConnectorCallType::Skip => ( + payment_data, + common_types::domain::ConnectorResponseData { + raw_connector_response: None, + }, + ), }; let payment_intent_status = payment_data.get_payment_intent().status; @@ -321,7 +345,14 @@ where }) .await; - Ok((payment_data, req, customer, None, None)) + Ok(( + payment_data, + req, + customer, + None, + None, + connector_response_data, + )) } #[cfg(feature = "v2")] @@ -337,7 +368,13 @@ pub async fn internal_payments_operation_core<F, Req, Op, FData, D>( get_tracker_response: operations::GetTrackerResponse<D>, call_connector_action: CallConnectorAction, header_payload: HeaderPayload, -) -> RouterResult<(D, Req, Option<u16>, Option<u128>)> +) -> RouterResult<( + D, + Req, + Option<u16>, + Option<u128>, + common_types::domain::ConnectorResponseData, +)> where F: Send + Clone + Sync, Req: Send + Sync + Authenticate, @@ -379,10 +416,14 @@ where call_connector_action.clone(), header_payload.clone(), profile, - req.get_all_keys_required(), + req.should_return_raw_response(), ) .await?; + let connector_response_data = common_types::domain::ConnectorResponseData { + raw_connector_response: router_data.raw_connector_response.clone(), + }; + let payments_response_operation = Box::new(PaymentResponse); let payment_data = payments_response_operation @@ -396,7 +437,7 @@ where ) .await?; - Ok((payment_data, req, None, None)) + Ok((payment_data, req, None, None, connector_response_data)) } #[cfg(feature = "v1")] @@ -686,7 +727,7 @@ where false, false, None, - <Req as Authenticate>::get_all_keys_required(&req), + <Req as Authenticate>::should_return_raw_response(&req), ) .await?; @@ -810,7 +851,7 @@ where false, false, routing_decision, - <Req as Authenticate>::get_all_keys_required(&req), + <Req as Authenticate>::should_return_raw_response(&req), ) .await?; @@ -941,7 +982,7 @@ where session_surcharge_details, &business_profile, header_payload.clone(), - <Req as Authenticate>::get_all_keys_required(&req), + <Req as Authenticate>::should_return_raw_response(&req), )) .await? } @@ -1070,7 +1111,7 @@ pub async fn proxy_for_payments_operation_core<F, Req, Op, FData, D>( call_connector_action: CallConnectorAction, auth_flow: services::AuthFlow, header_payload: HeaderPayload, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<(D, Req, Option<domain::Customer>, Option<u16>, Option<u128>)> where F: Send + Clone + Sync, @@ -1184,7 +1225,7 @@ where schedule_time, header_payload.clone(), &business_profile, - all_keys_required, + return_raw_connector_response, ) .await?; @@ -1270,7 +1311,7 @@ pub async fn proxy_for_payments_operation_core<F, Req, Op, FData, D>( get_tracker_response: operations::GetTrackerResponse<D>, call_connector_action: CallConnectorAction, header_payload: HeaderPayload, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<(D, Req, Option<u16>, Option<u128>)> where F: Send + Clone + Sync, @@ -1315,7 +1356,7 @@ where call_connector_action.clone(), header_payload.clone(), &profile, - all_keys_required, + return_raw_connector_response, ) .await?; @@ -1865,7 +1906,7 @@ pub async fn proxy_for_payments_core<F, Res, Req, Op, FData, D>( auth_flow: services::AuthFlow, call_connector_action: CallConnectorAction, header_payload: HeaderPayload, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResponse<Res> where F: Send + Clone + Sync, @@ -1896,7 +1937,7 @@ where call_connector_action, auth_flow, header_payload.clone(), - all_keys_required, + return_raw_connector_response, ) .await?; @@ -1925,7 +1966,7 @@ pub async fn proxy_for_payments_core<F, Res, Req, Op, FData, D>( payment_id: id_type::GlobalPaymentId, call_connector_action: CallConnectorAction, header_payload: HeaderPayload, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResponse<Res> where F: Send + Clone + Sync, @@ -1977,7 +2018,7 @@ where get_tracker_response, call_connector_action, header_payload.clone(), - all_keys_required, + return_raw_connector_response, ) .await?; @@ -1988,6 +2029,7 @@ where header_payload.x_hs_latency, &merchant_context, &profile, + None, ) } @@ -2065,7 +2107,7 @@ pub async fn record_attempt_core( force_sync: true, expand_attempts: false, param: None, - all_keys_required: None, + return_raw_connector_response: None, merchant_connector_details: None, }, operations::GetTrackerResponse { @@ -2125,6 +2167,7 @@ pub async fn record_attempt_core( header_payload.x_hs_latency, &merchant_context, &profile, + None, ) } @@ -2334,37 +2377,58 @@ where ) .await?; - let (payment_data, connector_http_status_code, external_latency) = + let (payment_data, connector_http_status_code, external_latency, connector_response_data) = if state.conf.merchant_id_auth.merchant_id_auth_enabled { - let (payment_data, _req, connector_http_status_code, external_latency) = - internal_payments_operation_core::<_, _, _, _, _>( - &state, - req_state, - merchant_context.clone(), - &profile, - operation.clone(), - req, - get_tracker_response, - call_connector_action, - header_payload.clone(), - ) - .await?; - (payment_data, connector_http_status_code, external_latency) + let ( + payment_data, + _req, + connector_http_status_code, + external_latency, + connector_response_data, + ) = internal_payments_operation_core::<_, _, _, _, _>( + &state, + req_state, + merchant_context.clone(), + &profile, + operation.clone(), + req, + get_tracker_response, + call_connector_action, + header_payload.clone(), + ) + .await?; + ( + payment_data, + connector_http_status_code, + external_latency, + connector_response_data, + ) } else { - let (payment_data, _req, _customer, connector_http_status_code, external_latency) = - payments_operation_core::<_, _, _, _, _>( - &state, - req_state, - merchant_context.clone(), - &profile, - operation.clone(), - req, - get_tracker_response, - call_connector_action, - header_payload.clone(), - ) - .await?; - (payment_data, connector_http_status_code, external_latency) + let ( + payment_data, + _req, + _customer, + connector_http_status_code, + external_latency, + connector_response_data, + ) = payments_operation_core::<_, _, _, _, _>( + &state, + req_state, + merchant_context.clone(), + &profile, + operation.clone(), + req, + get_tracker_response, + call_connector_action, + header_payload.clone(), + ) + .await?; + ( + payment_data, + connector_http_status_code, + external_latency, + connector_response_data, + ) }; payment_data.generate_response( @@ -2374,6 +2438,7 @@ where header_payload.x_hs_latency, &merchant_context, &profile, + Some(connector_response_data), ) } @@ -3000,7 +3065,7 @@ impl PaymentRedirectFlow for PaymentRedirectSync { param: Some(req.query_params.clone()), force_sync: true, expand_attempts: false, - all_keys_required: None, + return_raw_connector_response: None, merchant_connector_details: None, // TODO: Implement for connectors requiring 3DS or redirection-based authentication flows. }; @@ -3056,7 +3121,7 @@ impl PaymentRedirectFlow for PaymentRedirectSync { .change_context(errors::ApiErrorResponse::InternalServerError) .attach_printable("Failed to decide the response flow")?; - let (payment_data, _, _, _, _) = + let (payment_data, _, _, _, _, _) = Box::pin(payments_operation_core::<api::PSync, _, _, _, _>( state, req_state, @@ -3378,7 +3443,7 @@ pub async fn call_connector_service<F, RouterDReq, ApiRequest, D>( is_retry_payment: bool, should_retry_with_pan: bool, routing_decision: Option<routing_helpers::RoutingDecisionData>, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<( RouterData<F, RouterDReq, router_types::PaymentsResponseData>, helpers::MerchantConnectorAccountType, @@ -3539,16 +3604,28 @@ where router_data = router_data.add_session_token(state, &connector).await?; - let should_continue_further = access_token::update_router_data_with_access_token_result( + let mut should_continue_further = access_token::update_router_data_with_access_token_result( &add_access_token_result, &mut router_data, &call_connector_action, ); - let should_continue_further = router_data + let add_create_order_result = router_data .create_order_at_connector(state, &connector, should_continue_further) .await?; + if add_create_order_result.is_create_order_performed { + if let Ok(order_id_opt) = &add_create_order_result.create_order_result { + payment_data.set_connector_response_reference_id(order_id_opt.clone()); + } + should_continue_further = router_data + .update_router_data_with_create_order_result( + add_create_order_result, + should_continue_further, + ) + .await?; + } + let updated_customer = call_create_connector_customer_if_required( state, customer, @@ -3664,7 +3741,7 @@ where connector_request, business_profile, header_payload.clone(), - all_keys_required, + return_raw_connector_response, ) .await } else { @@ -3696,7 +3773,7 @@ pub async fn call_connector_service<F, RouterDReq, ApiRequest, D>( business_profile: &domain::Profile, is_retry_payment: bool, should_retry_with_pan: bool, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<RouterData<F, RouterDReq, router_types::PaymentsResponseData>> where F: Send + Clone + Sync, @@ -3765,16 +3842,28 @@ where router_data = router_data.add_session_token(state, &connector).await?; - let should_continue_further = access_token::update_router_data_with_access_token_result( + let mut should_continue_further = access_token::update_router_data_with_access_token_result( &add_access_token_result, &mut router_data, &call_connector_action, ); - let should_continue_further = router_data + let add_create_order_result = router_data .create_order_at_connector(state, &connector, should_continue_further) .await?; + if add_create_order_result.is_create_order_performed { + if let Ok(order_id_opt) = &add_create_order_result.create_order_result { + payment_data.set_connector_response_reference_id(order_id_opt.clone()); + } + should_continue_further = router_data + .update_router_data_with_create_order_result( + add_create_order_result, + should_continue_further, + ) + .await?; + } + // In case of authorize flow, pre-task and post-tasks are being called in build request // if we do not want to proceed further, then the function will return Ok(None, false) let (connector_request, should_continue_further) = if should_continue_further { @@ -3819,7 +3908,7 @@ where connector_request, business_profile, header_payload.clone(), - all_keys_required, + return_raw_connector_response, ) .await } else { @@ -3851,7 +3940,7 @@ pub async fn proxy_for_call_connector_service<F, RouterDReq, ApiRequest, D>( header_payload: HeaderPayload, business_profile: &domain::Profile, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<( RouterData<F, RouterDReq, router_types::PaymentsResponseData>, helpers::MerchantConnectorAccountType, @@ -3992,7 +4081,7 @@ where connector_request, business_profile, header_payload.clone(), - all_keys_required, + return_raw_connector_response, ) .await } else { @@ -4019,7 +4108,7 @@ pub async fn proxy_for_call_connector_service<F, RouterDReq, ApiRequest, D>( call_connector_action: CallConnectorAction, header_payload: HeaderPayload, business_profile: &domain::Profile, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<RouterData<F, RouterDReq, router_types::PaymentsResponseData>> where F: Send + Clone + Sync, @@ -4116,7 +4205,7 @@ where connector_request, business_profile, header_payload.clone(), - all_keys_required, + return_raw_connector_response, ) .await } else { @@ -4143,7 +4232,7 @@ pub async fn internal_call_connector_service<F, RouterDReq, ApiRequest, D>( call_connector_action: CallConnectorAction, header_payload: HeaderPayload, business_profile: &domain::Profile, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<RouterData<F, RouterDReq, router_types::PaymentsResponseData>> where F: Send + Clone + Sync, @@ -4211,10 +4300,22 @@ where &call_connector_action, ); - let should_continue_further = router_data + let add_create_order_result = router_data .create_order_at_connector(state, &connector, should_continue_further) .await?; + if add_create_order_result.is_create_order_performed { + if let Ok(order_id_opt) = &add_create_order_result.create_order_result { + payment_data.set_connector_response_reference_id(order_id_opt.clone()); + } + should_continue_further = router_data + .update_router_data_with_create_order_result( + add_create_order_result, + should_continue_further, + ) + .await?; + } + let (connector_request, should_continue_further) = if should_continue_further { router_data .build_flow_specific_connector_request(state, &connector, call_connector_action.clone()) @@ -4247,7 +4348,7 @@ where connector_request, business_profile, header_payload.clone(), - all_keys_required, + return_raw_connector_response, ) .await } else { @@ -4509,7 +4610,7 @@ pub async fn call_multiple_connectors_service<F, Op, Req, D>( _session_surcharge_details: Option<api::SessionSurchargeDetails>, business_profile: &domain::Profile, header_payload: HeaderPayload, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<D> where Op: Debug, @@ -4560,7 +4661,7 @@ where None, business_profile, header_payload.clone(), - all_keys_required, + return_raw_connector_response, ); join_handlers.push(res); @@ -4620,7 +4721,7 @@ pub async fn call_multiple_connectors_service<F, Op, Req, D>( session_surcharge_details: Option<api::SessionSurchargeDetails>, business_profile: &domain::Profile, header_payload: HeaderPayload, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<D> where Op: Debug, @@ -4682,7 +4783,7 @@ where None, business_profile, header_payload.clone(), - all_keys_required, + return_raw_connector_response, ); join_handlers.push(res); @@ -8894,6 +8995,7 @@ pub trait OperationSessionGetters<F> { fn get_token_data(&self) -> Option<&storage::PaymentTokenData>; fn get_mandate_connector(&self) -> Option<&MandateConnectorDetails>; fn get_force_sync(&self) -> Option<bool>; + #[cfg(feature = "v1")] fn get_all_keys_required(&self) -> Option<bool>; fn get_capture_method(&self) -> Option<enums::CaptureMethod>; fn get_merchant_connector_id_in_attempt(&self) -> Option<id_type::MerchantConnectorAccountId>; @@ -8903,6 +9005,8 @@ pub trait OperationSessionGetters<F> { ) -> Option<common_types::domain::MerchantConnectorAuthDetails>; fn get_connector_customer_id(&self) -> Option<String>; + + #[cfg(feature = "v1")] fn get_whole_connector_response(&self) -> Option<String>; #[cfg(feature = "v1")] @@ -8981,6 +9085,8 @@ pub trait OperationSessionSetters<F> { #[cfg(feature = "v2")] fn set_connector_request_reference_id(&mut self, reference_id: Option<String>); + fn set_connector_response_reference_id(&mut self, reference_id: Option<String>); + #[cfg(feature = "v2")] fn set_vault_session_details( &mut self, @@ -9293,6 +9399,10 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentData<F> { ) { self.payment_attempt.routing_approach = routing_approach; } + + fn set_connector_response_reference_id(&mut self, reference_id: Option<String>) { + self.payment_attempt.connector_response_reference_id = reference_id; + } } #[cfg(feature = "v2")] @@ -9447,14 +9557,6 @@ impl<F: Clone> OperationSessionGetters<F> for PaymentIntentData<F> { todo!(); } - fn get_all_keys_required(&self) -> Option<bool> { - todo!(); - } - - fn get_whole_connector_response(&self) -> Option<String> { - todo!(); - } - fn get_pre_routing_result( &self, ) -> Option<HashMap<enums::PaymentMethodType, domain::PreRoutingConnectorChoice>> { @@ -9573,6 +9675,10 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentIntentData<F> { todo!() } + fn set_connector_response_reference_id(&mut self, reference_id: Option<String>) { + todo!() + } + fn set_vault_session_details( &mut self, vault_session_details: Option<api::VaultSessionDetails>, @@ -9738,14 +9844,6 @@ impl<F: Clone> OperationSessionGetters<F> for PaymentConfirmData<F> { Some(&self.payment_attempt) } - fn get_all_keys_required(&self) -> Option<bool> { - todo!() - } - - fn get_whole_connector_response(&self) -> Option<String> { - todo!() - } - fn get_pre_routing_result( &self, ) -> Option<HashMap<enums::PaymentMethodType, domain::PreRoutingConnectorChoice>> { @@ -9869,6 +9967,10 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentConfirmData<F> { self.payment_attempt.connector_request_reference_id = reference_id; } + fn set_connector_response_reference_id(&mut self, reference_id: Option<String>) { + self.payment_attempt.connector_response_reference_id = reference_id; + } + fn set_vault_session_details( &mut self, external_vault_session_details: Option<api::VaultSessionDetails>, @@ -10034,14 +10136,6 @@ impl<F: Clone> OperationSessionGetters<F> for PaymentStatusData<F> { Some(&self.payment_attempt) } - fn get_all_keys_required(&self) -> Option<bool> { - todo!() - } - - fn get_whole_connector_response(&self) -> Option<String> { - todo!() - } - fn get_pre_routing_result( &self, ) -> Option<HashMap<enums::PaymentMethodType, domain::PreRoutingConnectorChoice>> { @@ -10161,6 +10255,10 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentStatusData<F> { todo!() } + fn set_connector_response_reference_id(&mut self, reference_id: Option<String>) { + todo!() + } + fn set_vault_session_details( &mut self, external_vault_session_details: Option<api::VaultSessionDetails>, @@ -10327,13 +10425,6 @@ impl<F: Clone> OperationSessionGetters<F> for PaymentCaptureData<F> { Some(&self.payment_attempt) } - fn get_all_keys_required(&self) -> Option<bool> { - todo!(); - } - - fn get_whole_connector_response(&self) -> Option<String> { - todo!(); - } fn get_pre_routing_result( &self, ) -> Option<HashMap<enums::PaymentMethodType, domain::PreRoutingConnectorChoice>> { @@ -10453,6 +10544,10 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentCaptureData<F> { todo!() } + fn set_connector_response_reference_id(&mut self, reference_id: Option<String>) { + todo!() + } + fn set_vault_session_details( &mut self, external_vault_session_details: Option<api::VaultSessionDetails>, @@ -10614,13 +10709,6 @@ impl<F: Clone> OperationSessionGetters<F> for PaymentAttemptListData<F> { todo!() } - fn get_all_keys_required(&self) -> Option<bool> { - todo!(); - } - - fn get_whole_connector_response(&self) -> Option<String> { - todo!(); - } fn get_pre_routing_result( &self, ) -> Option<HashMap<enums::PaymentMethodType, domain::PreRoutingConnectorChoice>> { diff --git a/crates/router/src/core/payments/flows.rs b/crates/router/src/core/payments/flows.rs index 2b681202743..5cc7cfa777e 100644 --- a/crates/router/src/core/payments/flows.rs +++ b/crates/router/src/core/payments/flows.rs @@ -78,7 +78,7 @@ pub trait Feature<F, T> { connector_request: Option<services::Request>, business_profile: &domain::Profile, header_payload: hyperswitch_domain_models::payments::HeaderPayload, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> where Self: Sized, @@ -182,6 +182,22 @@ pub trait Feature<F, T> { &mut self, _state: &SessionState, _connector: &api::ConnectorData, + _should_continue_payment: bool, + ) -> RouterResult<types::CreateOrderResult> + where + F: Clone, + Self: Sized, + dyn api::Connector: services::ConnectorIntegration<F, T, types::PaymentsResponseData>, + { + Ok(types::CreateOrderResult { + create_order_result: Ok(None), + is_create_order_performed: false, + }) + } + + async fn update_router_data_with_create_order_result( + &mut self, + _create_order_result: types::CreateOrderResult, should_continue_payment: bool, ) -> RouterResult<bool> where diff --git a/crates/router/src/core/payments/flows/approve_flow.rs b/crates/router/src/core/payments/flows/approve_flow.rs index 30b7b834f5a..e2f671d914b 100644 --- a/crates/router/src/core/payments/flows/approve_flow.rs +++ b/crates/router/src/core/payments/flows/approve_flow.rs @@ -80,7 +80,7 @@ impl Feature<api::Approve, types::PaymentsApproveData> _connector_request: Option<services::Request>, _business_profile: &domain::Profile, _header_payload: hyperswitch_domain_models::payments::HeaderPayload, - _all_keys_required: Option<bool>, + _return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { Err(ApiErrorResponse::NotImplemented { message: NotImplementedMessage::Reason("Flow not supported".to_string()), diff --git a/crates/router/src/core/payments/flows/authorize_flow.rs b/crates/router/src/core/payments/flows/authorize_flow.rs index ace3588c229..4df6ae9fe91 100644 --- a/crates/router/src/core/payments/flows/authorize_flow.rs +++ b/crates/router/src/core/payments/flows/authorize_flow.rs @@ -171,7 +171,7 @@ impl Feature<api::Authorize, types::PaymentsAuthorizeData> for types::PaymentsAu connector_request: Option<services::Request>, business_profile: &domain::Profile, header_payload: hyperswitch_domain_models::payments::HeaderPayload, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { let connector_integration: services::BoxedPaymentConnectorIntegrationInterface< api::Authorize, @@ -188,7 +188,7 @@ impl Feature<api::Authorize, types::PaymentsAuthorizeData> for types::PaymentsAu &self, call_connector_action.clone(), connector_request, - all_keys_required, + return_raw_connector_response, ) .await .to_payment_failed_response()?; @@ -422,17 +422,92 @@ impl Feature<api::Authorize, types::PaymentsAuthorizeData> for types::PaymentsAu state: &SessionState, connector: &api::ConnectorData, should_continue_payment: bool, - ) -> RouterResult<bool> { - let create_order_result = - create_order_at_connector(self, state, connector, should_continue_payment).await?; + ) -> RouterResult<types::CreateOrderResult> { + if connector + .connector_name + .requires_order_creation_before_payment(self.payment_method) + && should_continue_payment + { + let connector_integration: services::BoxedPaymentConnectorIntegrationInterface< + api::CreateOrder, + types::CreateOrderRequestData, + types::PaymentsResponseData, + > = connector.connector.get_connector_integration(); + + let request_data = types::CreateOrderRequestData::try_from(self.request.clone())?; + + let response_data: Result<types::PaymentsResponseData, types::ErrorResponse> = + Err(types::ErrorResponse::default()); + + let createorder_router_data = + helpers::router_data_type_conversion::<_, api::CreateOrder, _, _, _, _>( + self.clone(), + request_data, + response_data, + ); - let should_continue_payment = update_router_data_with_create_order_result( - create_order_result, - self, - should_continue_payment, - )?; + let resp = services::execute_connector_processing_step( + state, + connector_integration, + &createorder_router_data, + payments::CallConnectorAction::Trigger, + None, + None, + ) + .await + .to_payment_failed_response()?; + + let create_order_resp = match resp.response { + Ok(res) => { + if let types::PaymentsResponseData::PaymentsCreateOrderResponse { order_id } = + res + { + Ok(Some(order_id)) + } else { + Err(error_stack::report!(ApiErrorResponse::InternalServerError) + .attach_printable(format!( + "Unexpected response format from connector: {res:?}", + )))? + } + } + Err(error) => Err(error), + }; + + Ok(types::CreateOrderResult { + create_order_result: create_order_resp, + is_create_order_performed: true, + }) + } else { + Ok(types::CreateOrderResult { + create_order_result: Ok(None), + is_create_order_performed: false, + }) + } + } - Ok(should_continue_payment) + async fn update_router_data_with_create_order_result( + &mut self, + create_order_result: types::CreateOrderResult, + should_continue_further: bool, + ) -> RouterResult<bool> { + if create_order_result.is_create_order_performed { + match create_order_result.create_order_result { + Ok(Some(order_id)) => { + self.request.order_id = Some(order_id.clone()); + self.response = + Ok(types::PaymentsResponseData::PaymentsCreateOrderResponse { order_id }); + Ok(true) + } + Ok(None) => Err(error_stack::report!(ApiErrorResponse::InternalServerError) + .attach_printable("Order Id not found."))?, + Err(err) => { + self.response = Err(err.clone()); + Ok(false) + } + } + } else { + Ok(should_continue_further) + } } } @@ -719,102 +794,3 @@ async fn process_capture_flow( router_data.response = Ok(updated_response); Ok(router_data) } - -async fn create_order_at_connector<F: Clone>( - router_data: &mut types::RouterData< - F, - types::PaymentsAuthorizeData, - types::PaymentsResponseData, - >, - state: &SessionState, - connector: &api::ConnectorData, - should_continue_payment: bool, -) -> RouterResult<types::CreateOrderResult> { - if connector - .connector_name - .requires_order_creation_before_payment(router_data.payment_method) - && should_continue_payment - { - let connector_integration: services::BoxedPaymentConnectorIntegrationInterface< - api::CreateOrder, - types::CreateOrderRequestData, - types::PaymentsResponseData, - > = connector.connector.get_connector_integration(); - - let request_data = types::CreateOrderRequestData::try_from(router_data.request.clone())?; - - let response_data: Result<types::PaymentsResponseData, types::ErrorResponse> = - Err(types::ErrorResponse::default()); - - let createorder_router_data = - helpers::router_data_type_conversion::<_, api::CreateOrder, _, _, _, _>( - router_data.clone(), - request_data, - response_data, - ); - - let resp = services::execute_connector_processing_step( - state, - connector_integration, - &createorder_router_data, - payments::CallConnectorAction::Trigger, - None, - None, - ) - .await - .to_payment_failed_response()?; - - let create_order_resp = match resp.response { - Ok(res) => { - if let types::PaymentsResponseData::PaymentsCreateOrderResponse { order_id } = res { - Ok(Some(order_id)) - } else { - Err(error_stack::report!(ApiErrorResponse::InternalServerError) - .attach_printable(format!( - "Unexpected response format from connector: {res:?}", - )))? - } - } - Err(error) => Err(error), - }; - - Ok(types::CreateOrderResult { - create_order_result: create_order_resp, - is_create_order_performed: true, - }) - } else { - Ok(types::CreateOrderResult { - create_order_result: Ok(None), - is_create_order_performed: false, - }) - } -} - -fn update_router_data_with_create_order_result<F>( - create_order_result: types::CreateOrderResult, - router_data: &mut types::RouterData< - F, - types::PaymentsAuthorizeData, - types::PaymentsResponseData, - >, - should_continue_further: bool, -) -> RouterResult<bool> { - if create_order_result.is_create_order_performed { - match create_order_result.create_order_result { - Ok(Some(order_id)) => { - router_data.request.order_id = Some(order_id.clone()); - router_data.response = - Ok(types::PaymentsResponseData::PaymentsCreateOrderResponse { order_id }); - Ok(true) - } - Ok(None) => Err(error_stack::report!(ApiErrorResponse::InternalServerError) - .attach_printable("Order Id not found."))?, - Err(err) => { - router_data.response = Err(err.clone()); - Ok(false) - } - } - } else { - Ok(should_continue_further) - } -} diff --git a/crates/router/src/core/payments/flows/cancel_flow.rs b/crates/router/src/core/payments/flows/cancel_flow.rs index fc27a600421..046213dbe52 100644 --- a/crates/router/src/core/payments/flows/cancel_flow.rs +++ b/crates/router/src/core/payments/flows/cancel_flow.rs @@ -79,7 +79,7 @@ impl Feature<api::Void, types::PaymentsCancelData> connector_request: Option<services::Request>, _business_profile: &domain::Profile, _header_payload: hyperswitch_domain_models::payments::HeaderPayload, - _all_keys_required: Option<bool>, + _return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { metrics::PAYMENT_CANCEL_COUNT.add( 1, diff --git a/crates/router/src/core/payments/flows/capture_flow.rs b/crates/router/src/core/payments/flows/capture_flow.rs index 545b3fc2631..09d60db9a48 100644 --- a/crates/router/src/core/payments/flows/capture_flow.rs +++ b/crates/router/src/core/payments/flows/capture_flow.rs @@ -108,7 +108,7 @@ impl Feature<api::Capture, types::PaymentsCaptureData> connector_request: Option<services::Request>, _business_profile: &domain::Profile, _header_payload: hyperswitch_domain_models::payments::HeaderPayload, - _all_keys_required: Option<bool>, + _return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { let connector_integration: services::BoxedPaymentConnectorIntegrationInterface< api::Capture, diff --git a/crates/router/src/core/payments/flows/complete_authorize_flow.rs b/crates/router/src/core/payments/flows/complete_authorize_flow.rs index 4fb4e7574a4..d734f195cec 100644 --- a/crates/router/src/core/payments/flows/complete_authorize_flow.rs +++ b/crates/router/src/core/payments/flows/complete_authorize_flow.rs @@ -100,7 +100,7 @@ impl Feature<api::CompleteAuthorize, types::CompleteAuthorizeData> connector_request: Option<services::Request>, business_profile: &domain::Profile, header_payload: hyperswitch_domain_models::payments::HeaderPayload, - _all_keys_required: Option<bool>, + _return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { let connector_integration: services::BoxedPaymentConnectorIntegrationInterface< api::CompleteAuthorize, diff --git a/crates/router/src/core/payments/flows/incremental_authorization_flow.rs b/crates/router/src/core/payments/flows/incremental_authorization_flow.rs index 092be332191..c7dee2ad9e8 100644 --- a/crates/router/src/core/payments/flows/incremental_authorization_flow.rs +++ b/crates/router/src/core/payments/flows/incremental_authorization_flow.rs @@ -87,7 +87,7 @@ impl Feature<api::IncrementalAuthorization, types::PaymentsIncrementalAuthorizat connector_request: Option<services::Request>, _business_profile: &domain::Profile, _header_payload: hyperswitch_domain_models::payments::HeaderPayload, - _all_keys_required: Option<bool>, + _return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { let connector_integration: services::BoxedPaymentConnectorIntegrationInterface< api::IncrementalAuthorization, diff --git a/crates/router/src/core/payments/flows/post_session_tokens_flow.rs b/crates/router/src/core/payments/flows/post_session_tokens_flow.rs index e29739cf01b..118dd17a10a 100644 --- a/crates/router/src/core/payments/flows/post_session_tokens_flow.rs +++ b/crates/router/src/core/payments/flows/post_session_tokens_flow.rs @@ -87,7 +87,7 @@ impl Feature<api::PostSessionTokens, types::PaymentsPostSessionTokensData> connector_request: Option<services::Request>, _business_profile: &domain::Profile, _header_payload: hyperswitch_domain_models::payments::HeaderPayload, - _all_keys_required: Option<bool>, + _return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { let connector_integration: services::BoxedPaymentConnectorIntegrationInterface< api::PostSessionTokens, diff --git a/crates/router/src/core/payments/flows/psync_flow.rs b/crates/router/src/core/payments/flows/psync_flow.rs index 38fc08a1df1..87536525beb 100644 --- a/crates/router/src/core/payments/flows/psync_flow.rs +++ b/crates/router/src/core/payments/flows/psync_flow.rs @@ -111,7 +111,7 @@ impl Feature<api::PSync, types::PaymentsSyncData> connector_request: Option<services::Request>, _business_profile: &domain::Profile, _header_payload: hyperswitch_domain_models::payments::HeaderPayload, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { let connector_integration: services::BoxedPaymentConnectorIntegrationInterface< api::PSync, @@ -134,7 +134,7 @@ impl Feature<api::PSync, types::PaymentsSyncData> pending_connector_capture_id_list, call_connector_action, connector_integration, - all_keys_required, + return_raw_connector_response, ) .await?; // Initiating Integrity checks @@ -156,7 +156,7 @@ impl Feature<api::PSync, types::PaymentsSyncData> &self, call_connector_action, connector_request, - all_keys_required, + return_raw_connector_response, ) .await .to_payment_failed_response()?; @@ -241,7 +241,7 @@ where types::PaymentsSyncData, types::PaymentsResponseData, >, - _all_keys_required: Option<bool>, + _return_raw_connector_response: Option<bool>, ) -> RouterResult<Self>; } @@ -259,7 +259,7 @@ impl RouterDataPSync types::PaymentsSyncData, types::PaymentsResponseData, >, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { let mut capture_sync_response_map = HashMap::new(); if let payments::CallConnectorAction::HandleResponse(_) = call_connector_action { @@ -270,7 +270,7 @@ impl RouterDataPSync self, call_connector_action.clone(), None, - all_keys_required, + return_raw_connector_response, ) .await .to_payment_failed_response()?; @@ -289,7 +289,7 @@ impl RouterDataPSync &cloned_router_data, call_connector_action.clone(), None, - all_keys_required, + return_raw_connector_response, ) .await .to_payment_failed_response()?; diff --git a/crates/router/src/core/payments/flows/reject_flow.rs b/crates/router/src/core/payments/flows/reject_flow.rs index 852058dc377..efb34be54b3 100644 --- a/crates/router/src/core/payments/flows/reject_flow.rs +++ b/crates/router/src/core/payments/flows/reject_flow.rs @@ -79,7 +79,7 @@ impl Feature<api::Reject, types::PaymentsRejectData> _connector_request: Option<services::Request>, _business_profile: &domain::Profile, _header_payload: hyperswitch_domain_models::payments::HeaderPayload, - _all_keys_required: Option<bool>, + _return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { Err(ApiErrorResponse::NotImplemented { message: NotImplementedMessage::Reason("Flow not supported".to_string()), diff --git a/crates/router/src/core/payments/flows/session_flow.rs b/crates/router/src/core/payments/flows/session_flow.rs index a805f455b4b..ae0450f28f0 100644 --- a/crates/router/src/core/payments/flows/session_flow.rs +++ b/crates/router/src/core/payments/flows/session_flow.rs @@ -121,7 +121,7 @@ impl Feature<api::Session, types::PaymentsSessionData> for types::PaymentsSessio _connector_request: Option<services::Request>, business_profile: &domain::Profile, header_payload: hyperswitch_domain_models::payments::HeaderPayload, - _all_keys_required: Option<bool>, + _return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { metrics::SESSION_TOKEN_CREATED.add( 1, diff --git a/crates/router/src/core/payments/flows/session_update_flow.rs b/crates/router/src/core/payments/flows/session_update_flow.rs index e717ff50c26..cd42f855c11 100644 --- a/crates/router/src/core/payments/flows/session_update_flow.rs +++ b/crates/router/src/core/payments/flows/session_update_flow.rs @@ -87,7 +87,7 @@ impl Feature<api::SdkSessionUpdate, types::SdkPaymentsSessionUpdateData> connector_request: Option<services::Request>, _business_profile: &domain::Profile, _header_payload: hyperswitch_domain_models::payments::HeaderPayload, - _all_keys_required: Option<bool>, + _return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { let connector_integration: services::BoxedPaymentConnectorIntegrationInterface< api::SdkSessionUpdate, diff --git a/crates/router/src/core/payments/flows/setup_mandate_flow.rs b/crates/router/src/core/payments/flows/setup_mandate_flow.rs index a5bcdb4f55e..f99d13bd312 100644 --- a/crates/router/src/core/payments/flows/setup_mandate_flow.rs +++ b/crates/router/src/core/payments/flows/setup_mandate_flow.rs @@ -117,7 +117,7 @@ impl Feature<api::SetupMandate, types::SetupMandateRequestData> for types::Setup connector_request: Option<services::Request>, _business_profile: &domain::Profile, _header_payload: hyperswitch_domain_models::payments::HeaderPayload, - _all_keys_required: Option<bool>, + _return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { let connector_integration: services::BoxedPaymentConnectorIntegrationInterface< api::SetupMandate, diff --git a/crates/router/src/core/payments/flows/update_metadata_flow.rs b/crates/router/src/core/payments/flows/update_metadata_flow.rs index a6a35833255..f654b7ead13 100644 --- a/crates/router/src/core/payments/flows/update_metadata_flow.rs +++ b/crates/router/src/core/payments/flows/update_metadata_flow.rs @@ -86,7 +86,7 @@ impl Feature<api::UpdateMetadata, types::PaymentsUpdateMetadataData> connector_request: Option<services::Request>, _business_profile: &domain::Profile, _header_payload: hyperswitch_domain_models::payments::HeaderPayload, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> RouterResult<Self> { let connector_integration: services::BoxedPaymentConnectorIntegrationInterface< api::UpdateMetadata, @@ -100,7 +100,7 @@ impl Feature<api::UpdateMetadata, types::PaymentsUpdateMetadataData> &self, call_connector_action, connector_request, - all_keys_required, + return_raw_connector_response, ) .await .to_payment_failed_response()?; diff --git a/crates/router/src/core/payments/helpers.rs b/crates/router/src/core/payments/helpers.rs index 4b7791bb084..5eaee11c18a 100644 --- a/crates/router/src/core/payments/helpers.rs +++ b/crates/router/src/core/payments/helpers.rs @@ -4175,7 +4175,7 @@ pub fn router_data_type_conversion<F1, F2, Req1, Req2, Res1, Res2>( connector_mandate_request_reference_id: router_data.connector_mandate_request_reference_id, authentication_id: router_data.authentication_id, psd2_sca_exemption_type: router_data.psd2_sca_exemption_type, - whole_connector_response: router_data.whole_connector_response, + raw_connector_response: router_data.raw_connector_response, } } diff --git a/crates/router/src/core/payments/operations/payment_confirm_intent.rs b/crates/router/src/core/payments/operations/payment_confirm_intent.rs index dce33895fde..8ab7ddcfa28 100644 --- a/crates/router/src/core/payments/operations/payment_confirm_intent.rs +++ b/crates/router/src/core/payments/operations/payment_confirm_intent.rs @@ -588,6 +588,11 @@ impl<F: Clone + Sync> UpdateTracker<F, PaymentConfirmData<F>, PaymentsConfirmInt .connector_request_reference_id .clone(); + let connector_response_reference_id = payment_data + .payment_attempt + .connector_response_reference_id + .clone(); + let payment_attempt_update = match &payment_data.payment_method { // In the case of a tokenized payment method, we update the payment attempt with the tokenized payment method details. Some(payment_method) => { @@ -611,6 +616,7 @@ impl<F: Clone + Sync> UpdateTracker<F, PaymentConfirmData<F>, PaymentsConfirmInt merchant_connector_id, authentication_type, connector_request_reference_id, + connector_response_reference_id, } } }; diff --git a/crates/router/src/core/payments/operations/payment_response.rs b/crates/router/src/core/payments/operations/payment_response.rs index ff618a7b349..939679ef51f 100644 --- a/crates/router/src/core/payments/operations/payment_response.rs +++ b/crates/router/src/core/payments/operations/payment_response.rs @@ -1412,7 +1412,7 @@ async fn payment_response_update_tracker<F: Clone, T: types::Capturable>( .as_mut() .map(|info| info.status = status) }); - payment_data.whole_connector_response = router_data.whole_connector_response.clone(); + payment_data.whole_connector_response = router_data.raw_connector_response.clone(); // TODO: refactor of gsm_error_category with respective feature flag #[allow(unused_variables)] diff --git a/crates/router/src/core/payments/operations/proxy_payments_intent.rs b/crates/router/src/core/payments/operations/proxy_payments_intent.rs index a65f4cdd99e..30ea6913c6d 100644 --- a/crates/router/src/core/payments/operations/proxy_payments_intent.rs +++ b/crates/router/src/core/payments/operations/proxy_payments_intent.rs @@ -409,6 +409,11 @@ impl<F: Clone + Sync> UpdateTracker<F, PaymentConfirmData<F>, ProxyPaymentsReque .connector_request_reference_id .clone(); + let connector_response_reference_id = payment_data + .payment_attempt + .connector_response_reference_id + .clone(); + let payment_attempt_update = hyperswitch_domain_models::payments::payment_attempt::PaymentAttemptUpdate::ConfirmIntent { status: attempt_status, updated_by: storage_scheme.to_string(), @@ -416,6 +421,7 @@ impl<F: Clone + Sync> UpdateTracker<F, PaymentConfirmData<F>, ProxyPaymentsReque merchant_connector_id, authentication_type, connector_request_reference_id, + connector_response_reference_id, }; let updated_payment_intent = db diff --git a/crates/router/src/core/payments/transformers.rs b/crates/router/src/core/payments/transformers.rs index 636b1da0bbc..71ff92b0bb2 100644 --- a/crates/router/src/core/payments/transformers.rs +++ b/crates/router/src/core/payments/transformers.rs @@ -171,7 +171,7 @@ where connector_mandate_request_reference_id, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) } @@ -399,7 +399,7 @@ pub async fn construct_payment_router_data_for_authorize<'a>( connector_mandate_request_reference_id, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) @@ -563,7 +563,7 @@ pub async fn construct_payment_router_data_for_capture<'a>( connector_mandate_request_reference_id, psd2_sca_exemption_type: None, authentication_id: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) @@ -626,6 +626,7 @@ pub async fn construct_router_data_for_psync<'a>( // TODO: Get the charges object from feature metadata split_payments: None, payment_experience: None, + connector_reference_id: attempt.connector_response_reference_id.clone(), }; // TODO: evaluate the fields in router data, if they are required or not @@ -689,7 +690,7 @@ pub async fn construct_router_data_for_psync<'a>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) @@ -871,7 +872,7 @@ pub async fn construct_payment_router_data_for_sdk_session<'a>( connector_mandate_request_reference_id: None, psd2_sca_exemption_type: None, authentication_id: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) @@ -1088,7 +1089,7 @@ pub async fn construct_payment_router_data_for_setup_mandate<'a>( connector_mandate_request_reference_id, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) @@ -1287,7 +1288,7 @@ where connector_mandate_request_reference_id, authentication_id: None, psd2_sca_exemption_type: payment_data.payment_intent.psd2_sca_exemption_type, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) @@ -1477,7 +1478,7 @@ pub async fn construct_payment_router_data_for_update_metadata<'a>( connector_mandate_request_reference_id, authentication_id: None, psd2_sca_exemption_type: payment_data.payment_intent.psd2_sca_exemption_type, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) @@ -1524,6 +1525,7 @@ where Self: Sized, { #[cfg(feature = "v2")] + #[allow(clippy::too_many_arguments)] fn generate_response( self, state: &SessionState, @@ -1532,6 +1534,7 @@ where is_latency_header_enabled: Option<bool>, merchant_context: &domain::MerchantContext, profile: &domain::Profile, + connector_response_data: Option<common_types::domain::ConnectorResponseData>, ) -> RouterResponse<Response>; } @@ -1549,6 +1552,7 @@ where is_latency_header_enabled: Option<bool>, merchant_context: &domain::MerchantContext, profile: &domain::Profile, + _connector_response_data: Option<common_types::domain::ConnectorResponseData>, ) -> RouterResponse<api_models::payments::PaymentsCaptureResponse> { let payment_intent = &self.payment_intent; let payment_attempt = &self.payment_attempt; @@ -1872,6 +1876,7 @@ where is_latency_header_enabled: Option<bool>, merchant_context: &domain::MerchantContext, profile: &domain::Profile, + connector_response_data: Option<common_types::domain::ConnectorResponseData>, ) -> RouterResponse<api_models::payments::PaymentsResponse> { let payment_intent = self.payment_intent; let payment_attempt = self.payment_attempt; @@ -1897,6 +1902,9 @@ where let payment_address = self.payment_address; + let raw_connector_response = + connector_response_data.and_then(|data| data.raw_connector_response); + let payment_method_data = Some(api_models::payments::PaymentMethodDataResponseWithBilling { payment_method_data: None, @@ -1951,7 +1959,7 @@ where payment_method_subtype: Some(payment_attempt.payment_method_subtype), next_action, connector_transaction_id: payment_attempt.connector_payment_id.clone(), - connector_reference_id: None, + connector_reference_id: payment_attempt.connector_response_reference_id.clone(), connector_token_details, merchant_connector_id, browser_info: None, @@ -1965,6 +1973,7 @@ where shipping: None, //TODO: add this is_iframe_redirection_enabled: None, merchant_reference_id: payment_intent.merchant_reference_id.clone(), + raw_connector_response, }; Ok(services::ApplicationResponse::JsonWithHeaders(( @@ -1988,6 +1997,7 @@ where is_latency_header_enabled: Option<bool>, merchant_context: &domain::MerchantContext, profile: &domain::Profile, + connector_response_data: Option<common_types::domain::ConnectorResponseData>, ) -> RouterResponse<api_models::payments::PaymentsResponse> { let payment_intent = self.payment_intent; let payment_attempt = &self.payment_attempt; @@ -2022,6 +2032,9 @@ where .map(From::from), }); + let raw_connector_response = + connector_response_data.and_then(|data| data.raw_connector_response); + let connector_token_details = self .payment_attempt .connector_token_details @@ -2047,7 +2060,7 @@ where payment_method_type: Some(payment_attempt.payment_method_type), payment_method_subtype: Some(payment_attempt.payment_method_subtype), connector_transaction_id: payment_attempt.connector_payment_id.clone(), - connector_reference_id: None, + connector_reference_id: payment_attempt.connector_response_reference_id.clone(), merchant_connector_id, browser_info: None, connector_token_details, @@ -2060,6 +2073,7 @@ where return_url, is_iframe_redirection_enabled: payment_intent.is_iframe_redirection_enabled, merchant_reference_id: payment_intent.merchant_reference_id.clone(), + raw_connector_response, }; Ok(services::ApplicationResponse::JsonWithHeaders(( @@ -2083,6 +2097,7 @@ where _is_latency_header_enabled: Option<bool>, _merchant_context: &domain::MerchantContext, _profile: &domain::Profile, + _connector_response_data: Option<common_types::domain::ConnectorResponseData>, ) -> RouterResponse<api_models::payments::PaymentAttemptResponse> { let payment_attempt = self.payment_attempt; let response = api_models::payments::PaymentAttemptResponse::foreign_from(&payment_attempt); @@ -2107,6 +2122,7 @@ where _is_latency_header_enabled: Option<bool>, _merchant_context: &domain::MerchantContext, _profile: &domain::Profile, + _connector_response_data: Option<common_types::domain::ConnectorResponseData>, ) -> RouterResponse<api_models::payments::PaymentAttemptRecordResponse> { let payment_attempt = self.payment_attempt; let payment_intent = self.payment_intent; @@ -3718,6 +3734,10 @@ impl<F: Clone> TryFrom<PaymentAdditionalData<'_, F>> for types::PaymentsSyncData currency: payment_data.currency, split_payments: payment_data.payment_intent.split_payments, payment_experience: payment_data.payment_attempt.payment_experience, + connector_reference_id: payment_data + .payment_attempt + .connector_response_reference_id + .clone(), }) } } diff --git a/crates/router/src/core/relay/utils.rs b/crates/router/src/core/relay/utils.rs index effc2178ec3..1adacfbe949 100644 --- a/crates/router/src/core/relay/utils.rs +++ b/crates/router/src/core/relay/utils.rs @@ -143,7 +143,7 @@ pub async fn construct_relay_refund_router_data<F>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) diff --git a/crates/router/src/core/revenue_recovery/api.rs b/crates/router/src/core/revenue_recovery/api.rs index 3627d5062c6..052f4351c7e 100644 --- a/crates/router/src/core/revenue_recovery/api.rs +++ b/crates/router/src/core/revenue_recovery/api.rs @@ -31,7 +31,7 @@ pub async fn call_psync_api( force_sync: false, param: None, expand_attempts: true, - all_keys_required: None, + return_raw_connector_response: None, merchant_connector_details: None, }; let merchant_context_from_revenue_recovery_data = @@ -53,7 +53,7 @@ pub async fn call_psync_api( ) .await?; - let (payment_data, _req, _, _, _) = Box::pin(payments::payments_operation_core::< + let (payment_data, _req, _, _, _, _) = Box::pin(payments::payments_operation_core::< api_types::PSync, _, _, diff --git a/crates/router/src/core/unified_authentication_service/utils.rs b/crates/router/src/core/unified_authentication_service/utils.rs index 6c841a02d31..20ac12a9940 100644 --- a/crates/router/src/core/unified_authentication_service/utils.rs +++ b/crates/router/src/core/unified_authentication_service/utils.rs @@ -124,7 +124,7 @@ pub fn construct_uas_router_data<F: Clone, Req, Res>( connector_mandate_request_reference_id: None, authentication_id, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }) } diff --git a/crates/router/src/core/utils.rs b/crates/router/src/core/utils.rs index d1d298bd17b..c097b3fbfe6 100644 --- a/crates/router/src/core/utils.rs +++ b/crates/router/src/core/utils.rs @@ -234,7 +234,7 @@ pub async fn construct_payout_router_data<'a, F>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) @@ -401,7 +401,7 @@ pub async fn construct_refund_router_data<'a, F>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) @@ -604,7 +604,7 @@ pub async fn construct_refund_router_data<'a, F>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) @@ -1028,7 +1028,7 @@ pub async fn construct_accept_dispute_router_data<'a>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) } @@ -1126,7 +1126,7 @@ pub async fn construct_submit_evidence_router_data<'a>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) } @@ -1230,7 +1230,7 @@ pub async fn construct_upload_file_router_data<'a>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) } @@ -1353,7 +1353,7 @@ pub async fn construct_payments_dynamic_tax_calculation_router_data<F: Clone>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) } @@ -1454,7 +1454,7 @@ pub async fn construct_defend_dispute_router_data<'a>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) } @@ -1549,7 +1549,7 @@ pub async fn construct_retrieve_file_router_data<'a>( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) } diff --git a/crates/router/src/core/webhooks/incoming_v2.rs b/crates/router/src/core/webhooks/incoming_v2.rs index 0cf8b2bfe7b..464781876cf 100644 --- a/crates/router/src/core/webhooks/incoming_v2.rs +++ b/crates/router/src/core/webhooks/incoming_v2.rs @@ -456,31 +456,37 @@ async fn payments_incoming_webhook_flow( ) .await?; - let (payment_data, _req, customer, connector_http_status_code, external_latency) = - Box::pin(payments::payments_operation_core::< - api::PSync, - _, - _, - _, - PaymentStatusData<api::PSync>, - >( - &state, - req_state, - merchant_context.clone(), - &profile, - payments::operations::PaymentGet, - api::PaymentsRetrieveRequest { - force_sync: true, - expand_attempts: false, - param: None, - all_keys_required: None, - merchant_connector_details: None, - }, - get_trackers_response, - consume_or_trigger_flow, - HeaderPayload::default(), - )) - .await?; + let ( + payment_data, + _req, + customer, + connector_http_status_code, + external_latency, + connector_response_data, + ) = Box::pin(payments::payments_operation_core::< + api::PSync, + _, + _, + _, + PaymentStatusData<api::PSync>, + >( + &state, + req_state, + merchant_context.clone(), + &profile, + payments::operations::PaymentGet, + api::PaymentsRetrieveRequest { + force_sync: true, + expand_attempts: false, + param: None, + return_raw_connector_response: None, + merchant_connector_details: None, + }, + get_trackers_response, + consume_or_trigger_flow, + HeaderPayload::default(), + )) + .await?; let response = payment_data.generate_response( &state, @@ -489,6 +495,7 @@ async fn payments_incoming_webhook_flow( None, &merchant_context, &profile, + Some(connector_response_data), ); lock_action diff --git a/crates/router/src/core/webhooks/utils.rs b/crates/router/src/core/webhooks/utils.rs index 4cf0d784a05..c0c362a9dd3 100644 --- a/crates/router/src/core/webhooks/utils.rs +++ b/crates/router/src/core/webhooks/utils.rs @@ -133,7 +133,7 @@ pub async fn construct_webhook_router_data( connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, }; Ok(router_data) } diff --git a/crates/router/src/routes/payments.rs b/crates/router/src/routes/payments.rs index e2363633dad..163bc2dab2e 100644 --- a/crates/router/src/routes/payments.rs +++ b/crates/router/src/routes/payments.rs @@ -2953,7 +2953,7 @@ pub async fn payment_status( force_sync: payload.force_sync, expand_attempts: payload.expand_attempts, param: payload.param.clone(), - all_keys_required: payload.all_keys_required, + return_raw_connector_response: payload.return_raw_connector_response, merchant_connector_details: None, }; diff --git a/crates/router/src/services/api.rs b/crates/router/src/services/api.rs index 57bb8ec2427..fabfe3e38d2 100644 --- a/crates/router/src/services/api.rs +++ b/crates/router/src/services/api.rs @@ -142,7 +142,7 @@ pub async fn execute_connector_processing_step< req: &'b types::RouterData<T, Req, Resp>, call_connector_action: payments::CallConnectorAction, connector_request: Option<Request>, - all_keys_required: Option<bool>, + return_raw_connector_response: Option<bool>, ) -> CustomResult<types::RouterData<T, Req, Resp>, errors::ConnectorError> where T: Clone + Debug + 'static, @@ -302,7 +302,7 @@ where val + external_latency }), ); - if all_keys_required == Some(true) { + if return_raw_connector_response == Some(true) { let mut decoded = String::from_utf8(body.response.as_ref().to_vec()) .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; if decoded.starts_with('\u{feff}') { @@ -310,7 +310,7 @@ where .trim_start_matches('\u{feff}') .to_string(); } - data.whole_connector_response = Some(decoded); + data.raw_connector_response = Some(decoded); } Ok(data) } @@ -1076,13 +1076,17 @@ pub trait Authenticate { None } - fn get_all_keys_required(&self) -> Option<bool> { + fn should_return_raw_response(&self) -> Option<bool> { None } } #[cfg(feature = "v2")] -impl Authenticate for api_models::payments::PaymentsConfirmIntentRequest {} +impl Authenticate for api_models::payments::PaymentsConfirmIntentRequest { + fn should_return_raw_response(&self) -> Option<bool> { + self.return_raw_connector_response + } +} #[cfg(feature = "v2")] impl Authenticate for api_models::payments::ProxyPaymentsRequest {} @@ -1092,7 +1096,9 @@ impl Authenticate for api_models::payments::PaymentsRequest { self.client_secret.as_ref() } - fn get_all_keys_required(&self) -> Option<bool> { + fn should_return_raw_response(&self) -> Option<bool> { + // In v1, this maps to `all_keys_required` to retain backward compatibility. + // The equivalent field in v2 is `return_raw_connector_response`. self.all_keys_required } } @@ -1123,7 +1129,15 @@ impl Authenticate for api_models::payments::PaymentsPostSessionTokensRequest { impl Authenticate for api_models::payments::PaymentsUpdateMetadataRequest {} impl Authenticate for api_models::payments::PaymentsRetrieveRequest { - fn get_all_keys_required(&self) -> Option<bool> { + #[cfg(feature = "v2")] + fn should_return_raw_response(&self) -> Option<bool> { + self.return_raw_connector_response + } + + #[cfg(feature = "v1")] + fn should_return_raw_response(&self) -> Option<bool> { + // In v1, this maps to `all_keys_required` to retain backward compatibility. + // The equivalent field in v2 is `return_raw_connector_response`. self.all_keys_required } } diff --git a/crates/router/src/types.rs b/crates/router/src/types.rs index 52e3f267c84..dd64c5b3703 100644 --- a/crates/router/src/types.rs +++ b/crates/router/src/types.rs @@ -1151,7 +1151,7 @@ impl<F1, F2, T1, T2> ForeignFrom<(&RouterData<F1, T1, PaymentsResponseData>, T2) .clone(), authentication_id: data.authentication_id.clone(), psd2_sca_exemption_type: data.psd2_sca_exemption_type, - whole_connector_response: data.whole_connector_response.clone(), + raw_connector_response: data.raw_connector_response.clone(), } } } @@ -1219,7 +1219,7 @@ impl<F1, F2> psd2_sca_exemption_type: None, additional_merchant_data: data.additional_merchant_data.clone(), connector_mandate_request_reference_id: None, - whole_connector_response: None, + raw_connector_response: None, } } } diff --git a/crates/router/src/types/api/payments.rs b/crates/router/src/types/api/payments.rs index 62738680b1b..02fad384f59 100644 --- a/crates/router/src/types/api/payments.rs +++ b/crates/router/src/types/api/payments.rs @@ -5,7 +5,8 @@ pub use api_models::payments::{ }; #[cfg(feature = "v1")] pub use api_models::payments::{ - PaymentListFilterConstraints, PaymentListResponse, PaymentListResponseV2, + PaymentListFilterConstraints, PaymentListResponse, PaymentListResponseV2, PaymentRetrieveBody, + PaymentRetrieveBodyWithCredentials, }; pub use api_models::{ feature_matrix::{ @@ -18,18 +19,17 @@ pub use api_models::{ MandateValidationFields, NextActionType, OpenBankingSessionToken, PayLaterData, PaymentIdType, PaymentListConstraints, PaymentListFilters, PaymentListFiltersV2, PaymentMethodData, PaymentMethodDataRequest, PaymentMethodDataResponse, PaymentOp, - PaymentRetrieveBody, PaymentRetrieveBodyWithCredentials, PaymentsAggregateResponse, - PaymentsApproveRequest, PaymentsCancelRequest, PaymentsCaptureRequest, - PaymentsCompleteAuthorizeRequest, PaymentsDynamicTaxCalculationRequest, - PaymentsDynamicTaxCalculationResponse, PaymentsExternalAuthenticationRequest, - PaymentsIncrementalAuthorizationRequest, PaymentsManualUpdateRequest, - PaymentsPostSessionTokensRequest, PaymentsPostSessionTokensResponse, - PaymentsRedirectRequest, PaymentsRedirectionResponse, PaymentsRejectRequest, - PaymentsRequest, PaymentsResponse, PaymentsResponseForm, PaymentsRetrieveRequest, - PaymentsSessionRequest, PaymentsSessionResponse, PaymentsStartRequest, - PaymentsUpdateMetadataRequest, PaymentsUpdateMetadataResponse, PgRedirectResponse, - PhoneDetails, RedirectionResponse, SessionToken, UrlDetails, VaultSessionDetails, - VerifyRequest, VerifyResponse, VgsSessionDetails, WalletData, + PaymentsAggregateResponse, PaymentsApproveRequest, PaymentsCancelRequest, + PaymentsCaptureRequest, PaymentsCompleteAuthorizeRequest, + PaymentsDynamicTaxCalculationRequest, PaymentsDynamicTaxCalculationResponse, + PaymentsExternalAuthenticationRequest, PaymentsIncrementalAuthorizationRequest, + PaymentsManualUpdateRequest, PaymentsPostSessionTokensRequest, + PaymentsPostSessionTokensResponse, PaymentsRedirectRequest, PaymentsRedirectionResponse, + PaymentsRejectRequest, PaymentsRequest, PaymentsResponse, PaymentsResponseForm, + PaymentsRetrieveRequest, PaymentsSessionRequest, PaymentsSessionResponse, + PaymentsStartRequest, PaymentsUpdateMetadataRequest, PaymentsUpdateMetadataResponse, + PgRedirectResponse, PhoneDetails, RedirectionResponse, SessionToken, UrlDetails, + VaultSessionDetails, VerifyRequest, VerifyResponse, VgsSessionDetails, WalletData, }, }; pub use common_types::payments::{AcceptanceType, CustomerAcceptance, OnlineMandate}; diff --git a/crates/router/src/types/api/verify_connector.rs b/crates/router/src/types/api/verify_connector.rs index c9be34037cb..8298be10aab 100644 --- a/crates/router/src/types/api/verify_connector.rs +++ b/crates/router/src/types/api/verify_connector.rs @@ -127,7 +127,7 @@ impl VerifyConnectorData { connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, } } } diff --git a/crates/router/tests/connectors/aci.rs b/crates/router/tests/connectors/aci.rs index 61272a05877..cf0889931d8 100644 --- a/crates/router/tests/connectors/aci.rs +++ b/crates/router/tests/connectors/aci.rs @@ -133,7 +133,7 @@ fn construct_payment_router_data() -> types::PaymentsAuthorizeRouterData { connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, } } @@ -206,7 +206,7 @@ fn construct_refund_router_data<F>() -> types::RefundsRouterData<F> { connector_mandate_request_reference_id: None, authentication_id: None, psd2_sca_exemption_type: None, - whole_connector_response: None, + raw_connector_response: None, } } diff --git a/crates/router/tests/connectors/utils.rs b/crates/router/tests/connectors/utils.rs index bf9bc355334..db3aeddfb8c 100644 --- a/crates/router/tests/connectors/utils.rs +++ b/crates/router/tests/connectors/utils.rs @@ -553,7 +553,7 @@ pub trait ConnectorActions: Connector { connector_mandate_request_reference_id: None, psd2_sca_exemption_type: None, authentication_id: None, - whole_connector_response: None, + raw_connector_response: None, } }

2025-06-30T11:36:23Z

## Type of Change  - [ ] Bugfix - [ ] New feature - [ ] Enhancement - [x] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  This PR populates raw_connector_response for Payments when return_raw_connector_response is set to True. It also changes Payments Create and Psync endpoint for Razorpay connector. Additional Changes: - Introduces a struct ConnectorResponseData which sends raw_connector_response at core flows instead of it being in PaymentData (changed only in v2) - Rename `all_keys_required` as `return_raw_connector_response`, `get_all_keys_required()` as `should_return_raw_response()` , `whole_connector_response` as `raw_connector_response`. This rename is applied only on v2 Api and core flows to retain backward compatibility at v1. - `get_whole_connector_response()` and `get_all_keys_required()` at OperationSessionGetters are marked under v1 feature - `connector_response_reference_id` is updated in Payment_attempt at both update_trackers and post_update_trackers for v2. This is included in update_trackers in cases where Authorize flow is not performed at Connector End - Also marked this PaymentRetrieveBody, PaymentRetrieveBodyWithCredentials under v1 feature as it is not required in v2 flows ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  ## How did you test it?  - Payments - Create ``` curl --location 'http://localhost:8080/v2/payments' \ --header 'Content-Type: application/json' \ --header 'x-profile-id: pro_L5WeuuGWl0EUYBhEEME1' \ --header 'Authorization: api-key=_' \ --data-raw '{ "amount_details": { "order_amount": 100, "currency": "INR" }, "capture_method":"automatic", "description": "Its my first payment request", "authentication_type": "no_three_ds", "return_url": "https://google.com", "payment_method_data": { "upi": { "upi_collect": { "vpa_id": "success@razorpay" } }, "billing": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "IN", "first_name": "Swangi", "last_name": "Kumari" }, "phone": { "number": "8056594427", "country_code": "+91" }, "email": "[email protected]" } }, "payment_method_subtype": "upi_collect", "payment_method_type": "upi", "return_raw_connector_response": true }' ``` Response ``` { "id": "12345_pay_0197c4e2b8087181963fdaae32be36b3", "status": "requires_customer_action", "amount": { "order_amount": 100, "currency": "INR", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null, "net_amount": 100, "amount_to_capture": null, "amount_capturable": 0, "amount_captured": null }, "customer_id": null, "connector": "razorpay", "created": "2025-07-01T07:28:02.057Z", "payment_method_data": { "billing": { "address": { "city": "San Fransico", "country": "IN", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "Swangi", "last_name": "Kumari" }, "phone": { "number": "8056594427", "country_code": "+91" }, "email": "[email protected]" } }, "payment_method_type": "upi", "payment_method_subtype": "upi_collect", "connector_transaction_id": "pay_Qnik5RSCB4oVjf", "connector_reference_id": "order_Qnik4SrNFCdv8H", "merchant_connector_id": "mca_GWx9LT38SlIQ1qNFfw1p", "browser_info": null, "error": null, "shipping": null, "billing": null, "attempts": null, "connector_token_details": null, "payment_method_id": null, "next_action": { "type": "wait_screen_information", "display_from_timestamp": 1751354885589516000, "display_to_timestamp": 1751355185589516000, "poll_config": { "delay_in_secs": 5, "frequency": 5 } }, "return_url": "https://google.com/", "authentication_type": "no_three_ds", "authentication_type_applied": "no_three_ds", "is_iframe_redirection_enabled": null, "merchant_reference_id": null, "raw_connector_response": "{\"razorpay_payment_id\":\"pay_Qnik5RSCB4oVjf\"}" } ``` - Payments - Retrieve ``` curl --location 'http://localhost:8080/v2/payments/12345_pay_0197c4e2b8087181963fdaae32be36b3?force_sync=true&return_raw_connector_response=true' \ --header 'x-profile-id: pro_L5WeuuGWl0EUYBhEEME1' \ --header 'Authorization: api-key=_' \ --data '' ``` Response ``` { "id": "12345_pay_0197c4e2b8087181963fdaae32be36b3", "status": "requires_capture", "amount": { "order_amount": 100, "currency": "INR", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null, "net_amount": 100, "amount_to_capture": null, "amount_capturable": 100, "amount_captured": 100 }, "customer_id": null, "connector": "razorpay", "created": "2025-07-01T07:36:11.733Z", "payment_method_data": { "billing": { "address": { "city": "San Fransico", "country": "IN", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "Swangi", "last_name": "Kumari" }, "phone": { "number": "8056594427", "country_code": "+91" }, "email": "[email protected]" } }, "payment_method_type": "upi", "payment_method_subtype": "upi_collect", "connector_transaction_id": "pay_Qnik5RSCB4oVjf", "connector_reference_id": "order_Qnik4SrNFCdv8H", "merchant_connector_id": "mca_GWx9LT38SlIQ1qNFfw1p", "browser_info": null, "error": null, "shipping": null, "billing": null, "attempts": null, "connector_token_details": null, "payment_method_id": null, "next_action": null, "return_url": "https://google.com/", "authentication_type": "no_three_ds", "authentication_type_applied": null, "is_iframe_redirection_enabled": null, "merchant_reference_id": null, "raw_connector_response": "{\"entity\":\"collection\",\"count\":1,\"items\":[{\"id\":\"pay_QnishOLxdHvKJ6\",\"entity\":\"payment\",\"amount\":100,\"currency\":\"INR\",\"status\":\"authorized\",\"order_id\":\"order_QnisgYZGQHtI92\",\"invoice_id\":null,\"international\":false,\"method\":\"upi\",\"amount_refunded\":0,\"refund_status\":null,\"captured\":false,\"description\":null,\"card_id\":null,\"bank\":null,\"wallet\":null,\"vpa\":\"success@razorpay\",\"email\":\"[email protected]\",\"contact\":\"+918056594427\",\"notes\":{\"optimizer_provider_name\":\"razorpay\"},\"fee\":null,\"tax\":null,\"error_code\":null,\"error_description\":null,\"error_source\":null,\"error_step\":null,\"error_reason\":null,\"acquirer_data\":{\"rrn\":\"216013077213\",\"upi_transaction_id\":\"614E93092FDA8E2A9FA28264CF769689\"},\"gateway_provider\":\"Razorpay\",\"created_at\":1751355374,\"upi\":{\"vpa\":\"success@razorpay\"}}]}" } ``` ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

c275e13caf22362173e77d2260b440159abcabb3

juspay/hyperswitch

juspay__hyperswitch-8470

Bug: [FEATURE] allow a dummy connector to succeed for a failure card to show smart routing ### Feature Description Objective is to show user how smart retry works ### Possible Implementation stripe_test if the card number is 4000000000009995 previously it was failure with insufficient funds. But now we need to allow it to become success. ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? None

diff --git a/crates/router/src/routes/dummy_connector/utils.rs b/crates/router/src/routes/dummy_connector/utils.rs index 367c3bc63d4..0bec0398193 100644 --- a/crates/router/src/routes/dummy_connector/utils.rs +++ b/crates/router/src/routes/dummy_connector/utils.rs @@ -11,7 +11,10 @@ use super::{ consts, errors, types::{self, GetPaymentMethodDetails}, }; -use crate::{configs::settings, routes::SessionState}; +use crate::{ + configs::settings, + routes::{dummy_connector::types::DummyConnectors, SessionState}, +}; pub async fn tokio_mock_sleep(delay: u64, tolerance: u64) { let mut rng = rand::thread_rng(); @@ -219,7 +222,7 @@ impl ProcessPaymentAttempt for types::DummyConnectorCard { payment_attempt: types::DummyConnectorPaymentAttempt, redirect_url: String, ) -> types::DummyConnectorResult<types::DummyConnectorPaymentData> { - match self.get_flow_from_card_number()? { + match self.get_flow_from_card_number(payment_attempt.payment_request.connector.clone())? { types::DummyConnectorCardFlow::NoThreeDS(status, error) => { if let Some(error) = error { Err(error)?; @@ -291,6 +294,7 @@ impl types::DummyConnectorUpiCollect { impl types::DummyConnectorCard { pub fn get_flow_from_card_number( self, + connector: DummyConnectors, ) -> types::DummyConnectorResult<types::DummyConnectorCardFlow> { let card_number = self.number.peek(); match card_number.as_str() { @@ -309,12 +313,21 @@ impl types::DummyConnectorCard { }), )) } - "4000000000009995" => Ok(types::DummyConnectorCardFlow::NoThreeDS( - types::DummyConnectorStatus::Failed, - Some(errors::DummyConnectorErrors::PaymentDeclined { - message: "Insufficient funds", - }), - )), + "4000000000009995" => { + if connector == DummyConnectors::StripeTest { + Ok(types::DummyConnectorCardFlow::NoThreeDS( + types::DummyConnectorStatus::Succeeded, + None, + )) + } else { + Ok(types::DummyConnectorCardFlow::NoThreeDS( + types::DummyConnectorStatus::Failed, + Some(errors::DummyConnectorErrors::PaymentDeclined { + message: "Internal Server Error from Connector, Please try again later", + }), + )) + } + } "4000000000009987" => Ok(types::DummyConnectorCardFlow::NoThreeDS( types::DummyConnectorStatus::Failed, Some(errors::DummyConnectorErrors::PaymentDeclined {

2025-06-26T10:37:04Z

…rd payment ## Type of Change  - [ ] Bugfix - [ ] New feature - [x] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  For one connector alone to hard code success with a particular failure card ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  `stripe_test` if the card number is `4000000000009995` previously it was failure with insufficient funds. But now we need to allow it to become success. ## Motivation and Context Objective is to show user how smart retry works so a relevant error message will help ## How did you test it?  ## failure for other gateways <details> <summary>Request </summary> ```json { "amount": 333, "currency": "EUR", "confirm": true, "capture_method": "automatic", "payment_method": "card", "payment_method_type": "credit", "authentication_type": "no_three_ds", "description": "hellow world", "connector":["paypal_test"], "billing": { "address": { "zip": "560095", "country": "IN", "first_name": "Sakil", "last_name": "Mostak", "line1": "Fasdf", "line2": "Fasdf", "city": "Fasdf" } }, "payment_method_data": { "card": { "card_number": "4000000000009995", "card_exp_month": "01", "card_exp_year": "2026", "card_holder_name": "John Smith", "card_cvc": "100" } } } ``` </details> <details> <summary>Response</summary> ```json { "payment_id": "pay_04Vahgm5zSgQLH5y5o0S", "merchant_id": "merchant_1750933328", "status": "failed", "amount": 333, "net_amount": 333, "shipping_cost": null, "amount_capturable": 0, "amount_received": null, "connector": "paypal_test", "client_secret": "pay_04Vahgm5zSgQLH5y5o0S_secret_iKiVIRw76fiMFvPXCzU7", "created": "2025-06-26T10:32:26.951Z", "currency": "EUR", "customer_id": null, "customer": null, "description": "hellow world", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "card", "payment_method_data": { "card": { "last4": "9995", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "400000", "card_extended_bin": null, "card_exp_month": "01", "card_exp_year": "2026", "card_holder_name": "John Smith", "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": "Fasdf", "country": "IN", "line1": "Fasdf", "line2": "Fasdf", "line3": null, "zip": "560095", "state": null, "first_name": "Sakil", "last_name": "Mostak" }, "phone": null, "email": null }, "order_details": null, "email": null, "name": null, "phone": null, "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": null, "cancellation_reason": null, "error_code": "DC_08", "error_message": "Payment declined: Internal Server Error", "unified_code": "UE_9000", "unified_message": "Something went wrong", "payment_experience": null, "payment_method_type": "credit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": true, "connector_transaction_id": null, "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": null, "payment_link": null, "profile_id": "pro_tvhMochAzQxRKYmWKPgs", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_XioVM508jgIaVMwxgAsw", "incremental_authorization_allowed": false, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-06-26T10:47:26.951Z", "fingerprint": null, "browser_info": null, "payment_method_id": null, "payment_method_status": null, "updated": "2025-06-26T10:32:28.008Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` </details> ## success for `stripe_test` <details> <summary>Request</summary> ```json { "amount": 333, "currency": "EUR", "confirm": true, "capture_method": "automatic", "payment_method": "card", "payment_method_type": "credit", "authentication_type": "no_three_ds", "description": "hellow world", "connector":["stripe_test"], "billing": { "address": { "zip": "560095", "country": "IN", "first_name": "Sakil", "last_name": "Mostak", "line1": "Fasdf", "line2": "Fasdf", "city": "Fasdf" } }, "payment_method_data": { "card": { "card_number": "4000000000009995", "card_exp_month": "01", "card_exp_year": "2026", "card_holder_name": "John Smith", "card_cvc": "100" } } } ``` </details> <details> <summary>Response</summary> ```json { "payment_id": "pay_OqK97rLSs9s7NnwRvLV0", "merchant_id": "merchant_1750933328", "status": "succeeded", "amount": 333, "net_amount": 333, "shipping_cost": null, "amount_capturable": 0, "amount_received": 333, "connector": "stripe_test", "client_secret": "pay_OqK97rLSs9s7NnwRvLV0_secret_ZfXwEiZvzXjz0jiQFt7y", "created": "2025-06-26T10:39:21.936Z", "currency": "EUR", "customer_id": null, "customer": null, "description": "hellow world", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "card", "payment_method_data": { "card": { "last4": "9995", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "400000", "card_extended_bin": null, "card_exp_month": "01", "card_exp_year": "2026", "card_holder_name": "John Smith", "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": "Fasdf", "country": "IN", "line1": "Fasdf", "line2": "Fasdf", "line3": null, "zip": "560095", "state": null, "first_name": "Sakil", "last_name": "Mostak" }, "phone": null, "email": null }, "order_details": null, "email": null, "name": null, "phone": null, "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "credit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": false, "connector_transaction_id": "pay_LDgbgr5HUer6sqe8YSsq", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": null, "payment_link": null, "profile_id": "pro_tvhMochAzQxRKYmWKPgs", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_KNpkA14s7QSE6SE8SuUA", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-06-26T10:54:21.936Z", "fingerprint": null, "browser_info": null, "payment_method_id": null, "payment_method_status": null, "updated": "2025-06-26T10:39:22.945Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` </details> ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.114.0

ec6d0e4d62a530163ae1c806dcf40ccfd264b246

juspay/hyperswitch

juspay__hyperswitch-8481

Bug: [BUG] GlobalPay throws 501 for mandates below function is the culprit: ```rs fn get_payment_method_data( item: &PaymentsAuthorizeRouterData, brand_reference: Option<String>, ) -> Result<PaymentMethodData, Error> { match &item.request.payment_method_data { payment_method_data::PaymentMethodData::Card(ccard) => { Ok(PaymentMethodData::Card(requests::Card { number: ccard.card_number.clone(), expiry_month: ccard.card_exp_month.clone(), expiry_year: ccard.get_card_expiry_year_2_digit()?, cvv: ccard.card_cvc.clone(), account_type: None, authcode: None, avs_address: None, avs_postal_code: None, brand_reference, chip_condition: None, funding: None, pin_block: None, tag: None, track: None, })) } payment_method_data::PaymentMethodData::Wallet(wallet_data) => get_wallet_data(wallet_data), payment_method_data::PaymentMethodData::BankRedirect(bank_redirect) => { PaymentMethodData::try_from(bank_redirect) } _ => Err(errors::ConnectorError::NotImplemented( "Payment methods".to_string(), ))?, } } ``` just because `MandatePayment` isn't covered, it falls back to the default case which throws `501`. relevant docs: - [Tokenization](https://developer.globalpay.com/api/payment-methods-tokenization#/Create/post-payment-method) - [MIT](https://developer.globalpay.com/docs/MIT) - [Recurring](https://developer.globalpay.com/docs/payments/recurring/credentials-on-file)

diff --git a/config/config.example.toml b/config/config.example.toml index 9454b3f0adc..c6ae6f75ec5 100644 --- a/config/config.example.toml +++ b/config/config.example.toml @@ -467,6 +467,7 @@ square = { long_lived_token = false, payment_method = "card" } braintree = { long_lived_token = false, payment_method = "card" } gocardless = { long_lived_token = true, payment_method = "bank_debit" } billwerk = { long_lived_token = false, payment_method = "card" } +globalpay = { long_lived_token = false, payment_method = "card", flow = "mandates" } [debit_routing_config] # Debit Routing configs supported_currencies = "USD" # Supported currencies for debit routing diff --git a/config/deployments/integration_test.toml b/config/deployments/integration_test.toml index ddff65fa9c0..426b3ba808a 100644 --- a/config/deployments/integration_test.toml +++ b/config/deployments/integration_test.toml @@ -748,6 +748,7 @@ square = { long_lived_token = false, payment_method = "card" } stax = { long_lived_token = true, payment_method = "card,bank_debit" } stripe = { long_lived_token = false, payment_method = "wallet", payment_method_type = { list = "google_pay", type = "disable_only" } } billwerk = {long_lived_token = false, payment_method = "card"} +globalpay = { long_lived_token = false, payment_method = "card", flow = "mandates" } [webhooks] outgoing_enabled = true diff --git a/config/deployments/production.toml b/config/deployments/production.toml index 11d96d6269f..7c5cc65f2ca 100644 --- a/config/deployments/production.toml +++ b/config/deployments/production.toml @@ -758,6 +758,7 @@ square = { long_lived_token = false, payment_method = "card" } stax = { long_lived_token = true, payment_method = "card,bank_debit" } stripe = { long_lived_token = false, payment_method = "wallet", payment_method_type = { list = "google_pay", type = "disable_only" } } billwerk = {long_lived_token = false, payment_method = "card"} +globalpay = { long_lived_token = false, payment_method = "card", flow = "mandates" } [webhooks] outgoing_enabled = true diff --git a/config/deployments/sandbox.toml b/config/deployments/sandbox.toml index a372c873c78..305210ecb64 100644 --- a/config/deployments/sandbox.toml +++ b/config/deployments/sandbox.toml @@ -764,6 +764,7 @@ square = { long_lived_token = false, payment_method = "card" } stax = { long_lived_token = true, payment_method = "card,bank_debit" } stripe = { long_lived_token = false, payment_method = "wallet", payment_method_type = { list = "google_pay", type = "disable_only" } } billwerk = {long_lived_token = false, payment_method = "card"} +globalpay = { long_lived_token = false, payment_method = "card", flow = "mandates" } [webhooks] outgoing_enabled = true diff --git a/config/development.toml b/config/development.toml index 173d9363f2a..a3078b05089 100644 --- a/config/development.toml +++ b/config/development.toml @@ -895,6 +895,7 @@ braintree = { long_lived_token = false, payment_method = "card" } payme = { long_lived_token = false, payment_method = "card" } gocardless = { long_lived_token = true, payment_method = "bank_debit" } billwerk = { long_lived_token = false, payment_method = "card" } +globalpay = { long_lived_token = false, payment_method = "card", flow = "mandates" } [temp_locker_enable_config] stripe = { payment_method = "bank_transfer" } diff --git a/config/docker_compose.toml b/config/docker_compose.toml index 01abf5e8137..621b437bd28 100644 --- a/config/docker_compose.toml +++ b/config/docker_compose.toml @@ -390,6 +390,7 @@ hipay = { long_lived_token = false, payment_method = "card" } braintree = { long_lived_token = false, payment_method = "card" } gocardless = { long_lived_token = true, payment_method = "bank_debit" } billwerk = { long_lived_token = false, payment_method = "card" } +globalpay = { long_lived_token = false, payment_method = "card", flow = "mandates" } [temp_locker_enable_config] stripe = { payment_method = "bank_transfer" } diff --git a/crates/hyperswitch_connectors/src/connectors/globalpay.rs b/crates/hyperswitch_connectors/src/connectors/globalpay.rs index 7e9ad1aa820..215c8322dff 100644 --- a/crates/hyperswitch_connectors/src/connectors/globalpay.rs +++ b/crates/hyperswitch_connectors/src/connectors/globalpay.rs @@ -34,7 +34,7 @@ use hyperswitch_domain_models::{ types::{ PaymentsAuthorizeRouterData, PaymentsCancelRouterData, PaymentsCaptureRouterData, PaymentsCompleteAuthorizeRouterData, PaymentsSyncRouterData, RefundSyncRouterData, - RefundsRouterData, + RefundsRouterData, TokenizationRouterData, }, }; use hyperswitch_interfaces::{ @@ -49,7 +49,7 @@ use hyperswitch_interfaces::{ types::{ PaymentsAuthorizeType, PaymentsCaptureType, PaymentsCompleteAuthorizeType, PaymentsSyncType, PaymentsVoidType, RefreshTokenType, RefundExecuteType, RefundSyncType, - Response, + Response, TokenizationType, }, webhooks::{IncomingWebhook, IncomingWebhookRequestDetails}, }; @@ -61,6 +61,7 @@ use response::{ use serde_json::Value; use crate::{ + connectors::globalpay::response::GlobalpayPaymentMethodsResponse, constants::headers, types::{RefreshTokenRouterData, ResponseRouterData}, utils::{ @@ -381,7 +382,79 @@ impl api::PaymentToken for Globalpay {} impl ConnectorIntegration<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData> for Globalpay { - // Not Implemented (R) + fn get_headers( + &self, + req: &TokenizationRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + fn get_url( + &self, + _req: &TokenizationRouterData, + connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Ok(format!("{}/payment-methods", self.base_url(connectors),)) + } + + fn build_request( + &self, + req: &TokenizationRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&TokenizationType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(TokenizationType::get_headers(self, req, connectors)?) + .set_body(TokenizationType::get_request_body(self, req, connectors)?) + .build(), + )) + } + + fn get_request_body( + &self, + req: &TokenizationRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let connector_req = requests::GlobalPayPaymentMethodsRequest::try_from(req)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn handle_response( + &self, + data: &TokenizationRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<TokenizationRouterData, errors::ConnectorError> { + let response: GlobalpayPaymentMethodsResponse = res + .response + .parse_struct("GlobalpayPaymentMethodsResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + .change_context(errors::ConnectorError::ResponseHandlingFailed) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } } impl api::MandateSetup for Globalpay {} diff --git a/crates/hyperswitch_connectors/src/connectors/globalpay/requests.rs b/crates/hyperswitch_connectors/src/connectors/globalpay/requests.rs index 45749332081..056e546db20 100644 --- a/crates/hyperswitch_connectors/src/connectors/globalpay/requests.rs +++ b/crates/hyperswitch_connectors/src/connectors/globalpay/requests.rs @@ -16,78 +16,17 @@ pub struct GlobalpayCancelRouterData<T> { #[derive(Debug, Serialize)] pub struct GlobalpayPaymentsRequest { - /// A meaningful label for the merchant account set by Global Payments. pub account_name: Secret<String>, - /// The amount to transfer between Payer and Merchant for a SALE or a REFUND. It is always - /// represented in the lowest denomiation of the related currency. pub amount: Option<StringMinorUnit>, - /// Indicates if the merchant would accept an authorization for an amount less than the - /// requested amount. This is available for CP channel - /// only where the balance not authorized can be processed again using a different card. - pub authorization_mode: Option<AuthorizationMode>, - /// Indicates whether the transaction is to be captured automatically, later or later using - /// more than 1 partial capture. + pub currency: String, + pub reference: String, + pub country: api_models::enums::CountryAlpha2, pub capture_mode: Option<CaptureMode>, - /// The amount of the transaction that relates to cashback.It is always represented in the - /// lowest denomiation of the related currency. - pub cashback_amount: Option<StringMinorUnit>, - /// Describes whether the transaction was processed in a face to face(CP) scenario or a - /// Customer Not Present (CNP) scenario. + pub notifications: Option<Notifications>, + pub payment_method: GlobalPayPaymentMethodData, pub channel: Channel, - /// The amount that reflects the charge the merchant applied to the transaction for availing - /// of a more convenient purchase.It is always represented in the lowest denomiation of the - /// related currency. - pub convenience_amount: Option<StringMinorUnit>, - /// The country in ISO-3166-1(alpha-2 code) format. - pub country: api_models::enums::CountryAlpha2, - /// The currency of the amount in ISO-4217(alpha-3) - pub currency: String, - - pub currency_conversion: Option<CurrencyConversion>, - /// Merchant defined field to describe the transaction. - pub description: Option<String>, - - pub device: Option<Device>, - /// The amount of the gratuity for a transaction.It is always represented in the lowest - /// denomiation of the related currency. - pub gratuity_amount: Option<StringMinorUnit>, - /// Indicates whether the Merchant or the Payer initiated the creation of a transaction. pub initiator: Option<Initiator>, - /// Indicates the source IP Address of the system used to create the transaction. - pub ip_address: Option<Secret<String, common_utils::pii::IpAddress>>, - /// Indicates the language the transaction was executed in. In the format ISO-639-1 (alpha-2) - /// or ISO-639-1 (alpha-2)_ISO-3166(alpha-2) - pub language: Option<Language>, - - pub lodging: Option<Lodging>, - /// Indicates to Global Payments where the merchant wants to receive notifications of certain - /// events that occur on the Global Payments system. - pub notifications: Option<Notifications>, - - pub order: Option<Order>, - /// The merchant's payer reference for the transaction - pub payer_reference: Option<String>, - pub payment_method: PaymentMethod, - /// Merchant defined field to reference the transaction. - pub reference: String, - /// A merchant defined reference for the location that created the transaction. - pub site_reference: Option<String>, - /// Stored data information used to create a transaction. pub stored_credential: Option<StoredCredential>, - /// The amount that reflects the additional charge the merchant applied to the transaction - /// for using a specific payment method.It is always represented in the lowest denomiation of - /// the related currency. - pub surcharge_amount: Option<StringMinorUnit>, - /// Indicates the total or expected total of captures that will executed against a - /// transaction flagged as being captured multiple times. - pub total_capture_count: Option<i64>, - /// Describes whether the transaction is a SALE, that moves funds from Payer to Merchant, or - /// a REFUND where funds move from Merchant to Payer. - #[serde(rename = "type")] - pub globalpay_payments_request_type: Option<GlobalpayPaymentsRequestType>, - /// The merchant's user reference for the transaction. This represents the person who - /// processed the transaction on the merchant's behalf like a clerk or cashier reference. - pub user_reference: Option<String>, } #[derive(Debug, Serialize)] @@ -98,256 +37,60 @@ pub struct GlobalpayRefreshTokenRequest { pub grant_type: String, } -#[derive(Debug, Serialize, Deserialize)] -pub struct CurrencyConversion { - /// A unique identifier generated by Global Payments to identify the currency conversion. It - /// can be used to reference a currency conversion when processing a sale or a refund - /// transaction. - pub id: Option<String>, -} - -#[derive(Debug, Serialize, Deserialize)] -pub struct Device { - pub capabilities: Option<Capabilities>, - - pub entry_modes: Option<Vec<Vec<DeviceEntryMode>>>, - /// Describes whether a device prompts a payer for a gratuity when the payer is entering - /// their payment method details to the device. - pub gratuity_prompt_mode: Option<GratuityPromptMode>, - /// Describes the receipts a device prints when processing a transaction. - pub print_receipt_mode: Option<PrintReceiptMode>, - /// The sequence number from the device used to align with processing platform. - pub sequence_number: Option<Secret<String>>, - /// A unique identifier for the physical device. This value persists with the device even if - /// it is repurposed. - pub serial_number: Option<Secret<String>>, - /// The time from the device in ISO8601 format - pub time: Option<String>, -} - -#[derive(Debug, Serialize, Deserialize)] -pub struct Capabilities { - pub authorization_modes: Option<Vec<AuthorizationMode>>, - /// The number of lines that can be used to display information on the device. - pub display_line_count: Option<f64>, - - pub enabled_response: Option<Vec<EnabledResponse>>, - - pub entry_modes: Option<Vec<CapabilitiesEntryMode>>, - - pub fraud: Option<Vec<AuthorizationMode>>, - - pub mobile: Option<Vec<Mobile>>, - - pub payer_verifications: Option<Vec<PayerVerification>>, -} - -#[derive(Debug, Serialize, Deserialize)] -pub struct Lodging { - /// A reference that identifies the booking reference for a lodging stay. - pub booking_reference: Option<String>, - /// The amount charged for one nights lodging. - pub daily_rate_amount: Option<StringMinorUnit>, - /// A reference that identifies the booking reference for a lodging stay. - pub date_checked_in: Option<String>, - /// The check out date for a lodging stay. - pub date_checked_out: Option<String>, - /// The total number of days of the lodging stay. - pub duration_days: Option<f64>, - #[serde(rename = "lodging.charge_items")] - pub lodging_charge_items: Option<Vec<LodgingChargeItem>>, -} - -#[derive(Debug, Serialize, Deserialize)] -pub struct LodgingChargeItem { - pub payment_method_program_codes: Option<Vec<PaymentMethodProgramCode>>, - /// A reference that identifies the charge item, such as a lodging folio number. - pub reference: Option<String>, - /// The total amount for the list of charge types for a charge item. - pub total_amount: Option<StringMinorUnit>, - - pub types: Option<Vec<TypeElement>>, -} - -/// Indicates to Global Payments where the merchant wants to receive notifications of certain -/// events that occur on the Global Payments system. #[derive(Debug, Serialize, Deserialize, Default)] pub struct Notifications { - /// The merchant URL that will receive the notification when the customer has completed the - /// authentication. - pub challenge_return_url: Option<String>, - /// The merchant URL that will receive the notification when the customer has completed the - /// authentication when the authentication is decoupled and separate to the purchase. - pub decoupled_challenge_return_url: Option<String>, - /// The merchant URL to return the payer to, once the payer has completed payment using the - /// payment method. This returns control of the payer's payment experience to the merchant. pub return_url: Option<String>, - /// The merchant URL to notify the merchant of the latest status of the transaction. pub status_url: Option<String>, - /// The merchant URL that will receive the notification when the 3DS ACS successfully gathers - /// de ice informatiSon and tonotification_configurations.cordingly. - pub three_ds_method_return_url: Option<String>, - /// The URL on merchant's website to which the customer should be redirected in the event of - /// the customer canceling the transaction. pub cancel_url: Option<String>, } -#[derive(Debug, Serialize, Deserialize)] -pub struct Order { - /// Merchant defined field common to all transactions that are part of the same order. - pub reference: Option<String>, -} - #[derive(Debug, Serialize, Deserialize)] #[serde(rename_all = "snake_case")] pub enum PaymentMethodData { Card(Card), Apm(Apm), - BankTransfer(BankTransfer), DigitalWallet(DigitalWallet), + Token(TokenizationData), } #[derive(Debug, Serialize, Deserialize)] -pub struct PaymentMethod { +pub struct CommonPaymentMethodData { #[serde(flatten)] pub payment_method_data: PaymentMethodData, - pub authentication: Option<Authentication>, - pub encryption: Option<Encryption>, - /// Indicates how the payment method information was obtained by the Merchant for this - /// transaction. pub entry_mode: PaymentMethodEntryMode, - /// Indicates whether to execute the fingerprint signature functionality. - pub fingerprint_mode: Option<FingerprintMode>, - /// Specify the first name of the owner of the payment method. - pub first_name: Option<Secret<String>>, - /// Unique Global Payments generated id used to reference a stored payment method on the - /// Global Payments system. Often referred to as the payment method token. This value can be - /// used instead of payment method details such as a card number and expiry date. - pub id: Option<Secret<String>>, - /// Specify the surname of the owner of the payment method. - pub last_name: Option<Secret<String>>, - /// The full name of the owner of the payment method. - pub name: Option<Secret<String>>, - /// Contains the value a merchant wishes to appear on the payer's payment method statement - /// for this transaction - pub narrative: Option<String>, - /// Indicates whether to store the card as part of a transaction. - pub storage_mode: Option<CardStorageMode>, -} - -#[derive(Debug, Serialize, Deserialize)] -pub struct Apm { - /// A string used to identify the payment method provider being used to execute this - /// transaction. - pub provider: Option<ApmProvider>, -} - -/// Information outlining the degree of authentication executed related to a transaction. -#[derive(Debug, Serialize, Deserialize)] -pub struct Authentication { - /// Information outlining the degree of 3D Secure authentication executed. - pub three_ds: Option<ThreeDs>, - /// A message authentication code that is used to confirm the security and integrity of the - /// messaging to Global Payments. - pub mac: Option<String>, } -/// Information outlining the degree of 3D Secure authentication executed. #[derive(Debug, Serialize, Deserialize)] -pub struct ThreeDs { - /// The reference created by the 3DSecure Directory Server to identify the specific - /// authentication attempt. - pub ds_trans_reference: Option<String>, - /// An indication of the degree of the authentication and liability shift obtained for this - /// transaction. It is determined during the 3D Secure process. 2 or 1 for Mastercard - /// indicates the merchant has a liability shift. 5 or 6 for Visa or Amex indicates the - /// merchant has a liability shift. However for Amex if the payer is not enrolled the eci may - /// still be 6 but liability shift has not bee achieved. - pub eci: Option<String>, - /// Indicates if any exemptions apply to this transaction. - pub exempt_status: Option<ExemptStatus>, - /// Indicates the version of 3DS - pub message_version: Option<String>, - /// The reference created by the 3DSecure provider to identify the specific authentication - /// attempt. - pub server_trans_reference: Option<String>, - /// The authentication value created as part of the 3D Secure process. - pub value: Option<String>, +pub struct MandatePaymentMethodData { + pub entry_mode: PaymentMethodEntryMode, + pub id: Option<String>, } #[derive(Debug, Serialize, Deserialize)] -pub struct BankTransfer { - /// The number or reference for the payer's bank account. - pub account_number: Option<Secret<String>>, - - pub bank: Option<Bank>, - /// The number or reference for the check - pub check_reference: Option<Secret<String>>, - /// The type of bank account associated with the payer's bank account. - pub number_type: Option<NumberType>, - /// Indicates how the transaction was authorized by the merchant. - pub sec_code: Option<SecCode>, -} -#[derive(Debug, Serialize, Deserialize)] -pub struct Bank { - pub address: Option<Address>, - /// The local identifier code for the bank. - pub code: Option<Secret<String>>, - /// The name of the bank. - pub name: Option<String>, +#[serde(untagged)] +pub enum GlobalPayPaymentMethodData { + Common(CommonPaymentMethodData), + Mandate(MandatePaymentMethodData), } #[derive(Debug, Serialize, Deserialize)] -pub struct Address { - /// Merchant defined field common to all transactions that are part of the same order. - pub city: Option<Secret<String>>, - /// The country in ISO-3166-1(alpha-2 code) format. - pub country: Option<String>, - /// First line of the address. - pub line_1: Option<Secret<String>>, - /// Second line of the address. - pub line_2: Option<Secret<String>>, - /// Third line of the address. - pub line_3: Option<Secret<String>>, - /// The city or town of the address. - pub postal_code: Option<Secret<String>>, - /// The state or region of the address. ISO 3166-2 minus the country code itself. For - /// example, US Illinois = IL, or in the case of GB counties Wiltshire = WI or Aberdeenshire - /// = ABD - pub state: Option<String>, +pub struct Apm { + /// A string used to identify the payment method provider being used to execute this + /// transaction. + pub provider: Option<ApmProvider>, } #[derive(Debug, Default, Serialize, Deserialize)] pub struct Card { - /// The card providers description of their card product. - pub account_type: Option<String>, - /// Code generated when the card is successfully authorized. - pub authcode: Option<Secret<String>>, - /// First line of the address associated with the card. - pub avs_address: Option<String>, - /// Postal code of the address associated with the card. - pub avs_postal_code: Option<String>, - /// The unique reference created by the brands/schemes to uniquely identify the transaction. - pub brand_reference: Option<String>, - /// Indicates if a fallback mechanism was used to obtain the card information when EMV/chip - /// did not work as expected. - pub chip_condition: Option<ChipCondition>, - /// The numeric value printed on the physical card. pub cvv: Secret<String>, - /// The 2 digit expiry date month of the card. pub expiry_month: Secret<String>, - /// The 2 digit expiry date year of the card. pub expiry_year: Secret<String>, - /// Indicates whether the card is a debit or credit card. - pub funding: Option<Funding>, - /// The card account number used to authorize the transaction. Also known as PAN. pub number: cards::CardNumber, - /// Contains the pin block info, relating to the pin code the Payer entered. - pub pin_block: Option<Secret<String>>, - /// The full card tag data for an EMV/chip card transaction. - pub tag: Option<Secret<String>>, - /// Data from magnetic stripe of a card - pub track: Option<Secret<String>>, +} + +#[derive(Debug, Default, Serialize, Deserialize)] +pub struct TokenizationData { + pub brand_reference: Option<String>, } #[derive(Debug, Serialize, Deserialize)] @@ -358,16 +101,6 @@ pub struct DigitalWallet { pub payment_token: Option<serde_json::Value>, } -#[derive(Debug, Serialize, Deserialize)] -pub struct Encryption { - /// The encryption info used when sending encrypted card data to Global Payments. - pub info: Option<Secret<String>>, - /// The encryption method used when sending encrypted card data to Global Payments. - pub method: Option<Method>, - /// The version of encryption being used. - pub version: Option<String>, -} - /// Stored data information used to create a transaction. #[derive(Debug, Serialize, Deserialize)] pub struct StoredCredential { @@ -379,22 +112,6 @@ pub struct StoredCredential { pub sequence: Option<Sequence>, } -/// Indicates if the merchant would accept an authorization for an amount less than the -/// requested amount. This is available for CP channel -/// only where the balance not authorized can be processed again using a different card. -/// -/// Describes the instruction a device can indicate to the clerk in the case of fraud. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum AuthorizationMode { - /// Indicates merchant would accept an authorization for an amount less than the - /// requested amount. - /// pub example: PARTIAL - /// - /// Describes whether the device can process partial authorizations. - Partial, -} - /// Indicates whether the transaction is to be captured automatically, later or later using /// more than 1 partial capture. #[derive(Debug, Serialize, Deserialize)] @@ -432,88 +149,6 @@ pub enum Channel { CustomerPresent, } -/// Describes the data the device can handle when it receives a response for a card -/// authorization. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum EnabledResponse { - Avs, - BrandReference, - Cvv, - MaskedNumberLast4, -} - -/// Describes the entry mode capabilities a device has. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum CapabilitiesEntryMode { - Chip, - Contactless, - ContactlessSwipe, - Manual, - Swipe, -} - -/// Describes the mobile features a device has -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum Mobile { - IntegratedCardReader, - SeparateCardReader, -} - -/// Describes the capabilities a device has to verify a payer. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum PayerVerification { - ContactlessSignature, - PayerDevice, - Pinpad, -} - -/// Describes the allowed entry modes to obtain payment method information from the payer as -/// part of a transaction request. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum DeviceEntryMode { - Chip, - Contactless, - Manual, - Swipe, -} - -/// Describes whether a device prompts a payer for a gratuity when the payer is entering -/// their payment method details to the device. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum GratuityPromptMode { - NotRequired, - Prompt, -} - -/// Describes the receipts a device prints when processing a transaction. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum PrintReceiptMode { - Both, - Merchant, - None, - Payer, -} - -/// Describes whether the transaction is a SALE, that moves funds from Payer to Merchant, or -/// a REFUND where funds move from Merchant to Payer. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum GlobalpayPaymentsRequestType { - /// indicates the movement, or the attempt to move, funds from merchant to the - /// payer. - Refund, - /// indicates the movement, or the attempt to move, funds from payer to a - /// merchant. - Sale, -} - /// Indicates whether the Merchant or the Payer initiated the creation of a transaction. #[derive(Debug, Serialize, Deserialize)] #[serde(rename_all = "SCREAMING_SNAKE_CASE")] @@ -525,45 +160,6 @@ pub enum Initiator { Payer, } -/// Indicates the language the transaction was executed in. In the format ISO-639-1 (alpha-2) -/// or ISO-639-1 (alpha-2)_ISO-3166(alpha-2) -#[derive(Debug, Serialize, Deserialize)] -pub enum Language { - #[serde(rename = "fr")] - Fr, - #[serde(rename = "fr_CA")] - FrCa, - #[serde(rename = "ISO-639(alpha-2)")] - Iso639Alpha2, - #[serde(rename = "ISO-639(alpha-2)_ISO-3166(alpha-2)")] - Iso639alpha2Iso3166alpha2, -} - -/// Describes the payment method programs, typically run by card brands such as Amex, Visa -/// and MC. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum PaymentMethodProgramCode { - AssuredReservation, - CardDeposit, - Other, - Purchase, -} - -/// Describes the types of charges associated with a transaction. This can be one or more -/// than more charge type. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum TypeElement { - GiftShop, - Laundry, - MiniBar, - NoShow, - Other, - Phone, - Restaurant, -} - /// A string used to identify the payment method provider being used to execute this /// transaction. #[derive(Debug, Serialize, Deserialize)] @@ -577,87 +173,6 @@ pub enum ApmProvider { Testpay, } -/// Indicates if any exemptions apply to this transaction. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum ExemptStatus { - LowValue, - ScaDelegation, - SecureCorporatePayment, - TransactionRiskAnalysis, - TrustedMerchant, -} - -/// The type of bank account associated with the payer's bank account. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum NumberType { - Checking, - Savings, -} - -/// Indicates how the transaction was authorized by the merchant. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum SecCode { - /// Cash Concentration or Disbursement - Can be either a credit or debit application - /// where funds are wither distributed or consolidated between corporate entities. - #[serde(rename = "CCD")] - CashConcentrationOrDisbursement, - - /// Point of Sale Entry - Point of sale debit applications non-shared (POS) - /// environment. These transactions are most often initiated by the consumer via a plastic - /// access card. This is only support for normal ACH transactions - #[serde(rename = "POP")] - PointOfSaleEntry, - /// Prearranged Payment and Deposits - used to credit or debit a consumer account. - /// Popularity used for payroll direct deposits and pre-authorized bill payments. - #[serde(rename = "PPD")] - PrearrangedPaymentAndDeposits, - /// Telephone-Initiated Entry - Used for the origination of a single entry debit - /// transaction to a consumer's account pursuant to a verbal authorization obtained from the - /// consumer via the telephone. - #[serde(rename = "TEL")] - TelephoneInitiatedEntry, - /// Internet (Web)-Initiated Entry - Used for the origination of debit entries - /// (either Single or Recurring Entry) to a consumer's account pursuant to a to an - /// authorization that is obtained from the Receiver via the Internet. - #[serde(rename = "WEB")] - WebInitiatedEntry, -} - -/// Indicates if a fallback mechanism was used to obtain the card information when EMV/chip -/// did not work as expected. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum ChipCondition { - /// indicates the previous transaction with this card failed. - PrevFailed, - /// indicates the previous transaction with this card was a success. - PrevSuccess, -} - -/// Indicates whether the card is a debit or credit card. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum Funding { - /// indicates the card is an, Electronic Benefits Transfer, for cash - /// benefits. - CashBenefits, - /// indicates the card is a credit card where the funds may be available on credit - /// to the payer to fulfill the transaction amount. - Credit, - /// indicates the card is a debit card where the funds may be present in an account - /// to fulfill the transaction amount. - Debit, - /// indicates the card is an, Electronic Benefits Transfer, for food stamps. - FoodStamp, - /// indicates the card is a prepaid card where the funds are loaded to the card - /// account to fulfill the transaction amount. Unlike a debit card, a prepaid is not linked - /// to a bank account. - Prepaid, -} - /// Identifies who provides the digital wallet for the Payer. #[derive(Debug, Serialize, Deserialize)] #[serde(rename_all = "SCREAMING_SNAKE_CASE")] @@ -666,27 +181,6 @@ pub enum DigitalWalletProvider { PayByGoogle, } -/// Indicates if the actual card number or a token is being used to process the -/// transaction. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum TokenFormat { - /// The value in the digital wallet token field is a real card number - /// (PAN) - CardNumber, - /// The value in the digital wallet token field is a temporary token in the - /// format of a card number (PAN) but is not a real card number. - CardToken, -} - -/// The encryption method used when sending encrypted card data to Global Payments. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum Method { - Ksn, - Ktb, -} - /// Indicates how the payment method information was obtained by the Merchant for this /// transaction. #[derive(Debug, Default, Serialize, Deserialize)] @@ -727,30 +221,6 @@ pub enum PaymentMethodEntryMode { Swipe, } -/// Indicates whether to execute the fingerprint signature functionality. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum FingerprintMode { - /// Always check and create the fingerprint value regardless of the result of the - /// card authorization. - Always, - /// Always check and create the fingerprint value when the card authorization - /// is successful. - OnSuccess, -} - -/// Indicates whether to store the card as part of a transaction. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum CardStorageMode { - /// /// The card information is always stored irrespective of whether the payment - /// method authorization was successful or not. - Always, - /// The card information is only stored if the payment method authorization was - /// successful. - OnSuccess, -} - /// Indicates the transaction processing model being executed when using stored /// credentials. #[derive(Debug, Serialize, Deserialize)] @@ -775,17 +245,6 @@ pub enum Model { Unscheduled, } -/// The reason stored credentials are being used to create a transaction. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum Reason { - Delayed, - Incremental, - NoShow, - Reauthorization, - Resubmission, -} - /// Indicates the order of this transaction in the sequence of a planned repeating /// transaction processing model. #[derive(Debug, Serialize, Deserialize)] @@ -812,3 +271,34 @@ pub struct GlobalpayCaptureRequest { pub struct GlobalpayCancelRequest { pub amount: Option<StringMinorUnit>, } + +#[derive(Default, Debug, Serialize, Deserialize)] +#[serde(rename_all = "SCREAMING_SNAKE_CASE")] +pub enum UsageMode { + /// This value must be used if using the Hosted Fields or the Drop-in UI integration types. + /// When creating the payment method token, this option ensures the payment method token is temporary and will be removed once a transaction is executed or after a short period of time. + #[default] + Single, + /// When creating the payment method token, this indicates it is permanent and can be used to create many transactions. + Multiple, + /// When using the payment method token to transaction process, this indicates to use the card number also known as the PAN or FPAN when both the card number and the network token are available. + UseCardNumber, + /// When using the payment method token to transaction process, this indicates to use the network token instead of the card number if both are available. + UseNetworkToken, +} + +#[derive(Default, Debug, Serialize, Deserialize)] +pub struct GlobalPayPayer { + /// Unique identifier for the Payer on the Global Payments system. + #[serde(rename = "id", skip_serializing_if = "Option::is_none")] + pub payer_id: Option<String>, +} + +#[derive(Default, Debug, Serialize)] +pub struct GlobalPayPaymentMethodsRequest { + pub reference: String, + #[serde(skip_serializing_if = "Option::is_none")] + pub usage_mode: Option<UsageMode>, + #[serde(skip_serializing_if = "Option::is_none")] + pub card: Option<Card>, +} diff --git a/crates/hyperswitch_connectors/src/connectors/globalpay/response.rs b/crates/hyperswitch_connectors/src/connectors/globalpay/response.rs index 11bd9e1a047..daa629641e6 100644 --- a/crates/hyperswitch_connectors/src/connectors/globalpay/response.rs +++ b/crates/hyperswitch_connectors/src/connectors/globalpay/response.rs @@ -3,75 +3,17 @@ use common_utils::types::StringMinorUnit; use masking::Secret; use serde::{Deserialize, Serialize}; -use super::requests; use crate::utils::deserialize_optional_currency; #[derive(Debug, Serialize, Deserialize)] pub struct GlobalpayPaymentsResponse { - /// A unique identifier for the merchant account set by Global Payments. - pub account_id: Option<Secret<String>>, - /// A meaningful label for the merchant account set by Global Payments. - pub account_name: Option<Secret<String>>, - /// Information about the Action executed. - pub action: Option<Action>, - /// The amount to transfer between Payer and Merchant for a SALE or a REFUND. It is always - /// represented in the lowest denomiation of the related currency. + pub status: GlobalpayPaymentStatus, + pub payment_method: Option<PaymentMethod>, + pub id: String, pub amount: Option<StringMinorUnit>, - /// Indicates if the merchant would accept an authorization for an amount less than the - /// requested amount. This is available for CP channel - /// only where the balance not authorized can be processed again using a different card. - pub authorization_mode: Option<requests::AuthorizationMode>, - /// A Global Payments created reference that uniquely identifies the batch. - pub batch_id: Option<String>, - /// Indicates whether the transaction is to be captured automatically, later or later using - /// more than 1 partial capture. - pub capture_mode: Option<requests::CaptureMode>, - /// Describes whether the transaction was processed in a face to face(CP) scenario or a - /// Customer Not Present (CNP) scenario. - pub channel: Option<requests::Channel>, - /// The country in ISO-3166-1(alpha-2 code) format. - pub country: Option<String>, - /// The currency of the amount in ISO-4217(alpha-3) #[serde(deserialize_with = "deserialize_optional_currency")] pub currency: Option<Currency>, - /// Information relating to a currency conversion. - pub currency_conversion: Option<requests::CurrencyConversion>, - /// A unique identifier generated by Global Payments to identify the transaction. - pub id: String, - /// A unique identifier for the merchant set by Global Payments. - pub merchant_id: Option<String>, - /// A meaningful label for the merchant set by Global Payments. - pub merchant_name: Option<Secret<String>>, - pub payment_method: Option<PaymentMethod>, - /// Merchant defined field to reference the transaction. pub reference: Option<String>, - /// Indicates where a transaction is in its lifecycle. - pub status: GlobalpayPaymentStatus, - /// Global Payments time indicating when the object was created in ISO-8601 format. - pub time_created: Option<String>, - /// Describes whether the transaction is a SALE, that moves funds from Payer to Merchant, or - /// a REFUND where funds move from Merchant to Payer. - #[serde(rename = "type")] - pub globalpay_payments_response_type: Option<requests::GlobalpayPaymentsRequestType>, -} - -/// Information about the Action executed. -#[derive(Debug, Serialize, Deserialize)] -pub struct Action { - /// The id of the app that was used to create the token. - pub app_id: Option<Secret<String>>, - /// The name of the app the user gave to the application. - pub app_name: Option<Secret<String>>, - /// A unique identifier for the object created by Global Payments. The first 3 characters - /// identifies the resource an id relates to. - pub id: Option<Secret<String>>, - /// The result of the action executed. - pub result_code: Option<ResultCode>, - /// Global Payments time indicating when the object was created in ISO-8601 format. - pub time_created: Option<String>, - /// Indicates the action taken. - #[serde(rename = "type")] - pub action_type: Option<ActionType>, } #[derive(Debug, Deserialize, Serialize)] @@ -86,230 +28,25 @@ pub struct GlobalpayRefreshTokenErrorResponse { pub detailed_error_description: String, } -/// Information relating to a currency conversion. -#[derive(Debug, Serialize, Deserialize)] -pub struct CurrencyConversion { - /// The percentage commission taken for providing the currency conversion. - pub commission_percentage: Option<String>, - /// The exchange rate used to convert one currency to another. - pub conversion_rate: Option<String>, - /// The source of the base exchange rate was obtained to execute the currency conversion. - pub exchange_rate_source: Option<String>, - /// The time the base exchange rate was obtained from the source. - pub exchange_source_time: Option<String>, - /// The exchange rate used to convert one currency to another. - pub margin_rate_percentage: Option<String>, - /// The amount that will affect the payer's account. - pub payer_amount: Option<StringMinorUnit>, - /// The currency of the amount that will affect the payer's account. - pub payer_currency: Option<String>, -} - #[derive(Debug, Serialize, Deserialize)] pub struct PaymentMethod { - /// Data associated with the response of an APM transaction. pub apm: Option<Apm>, - /// Information outlining the degree of authentication executed related to a transaction. - pub authentication: Option<Authentication>, - pub bank_transfer: Option<BankTransfer>, pub card: Option<Card>, - pub digital_wallet: Option<requests::DigitalWallet>, - /// Indicates how the payment method information was obtained by the Merchant for this - /// transaction. - pub entry_mode: Option<requests::PaymentMethodEntryMode>, - /// If enabled, this field contains the unique fingerprint signature for that payment method - /// for that merchant. If the payment method is seen again this same value is generated. For - /// cards the primary account number is checked only. The expiry date or the CVV is not used - /// for this check. - pub fingerprint: Option<Secret<String>>, - /// If enabled, this field indicates whether the payment method has been seen before or is - /// new. - /// * EXISTS - Indicates that the payment method was seen on the platform before by this - /// merchant. - /// * NEW - Indicates that the payment method was not seen on the platform before by this - /// merchant. - pub fingerprint_presence_indicator: Option<String>, - /// Unique Global Payments generated id used to reference a stored payment method on the - /// Global Payments system. Often referred to as the payment method token. This value can be - /// used instead of payment method details such as a card number and expiry date. pub id: Option<Secret<String>>, - /// Result message from the payment method provider corresponding to the result code. pub message: Option<String>, - /// Result code from the payment method provider. - /// If a card authorization declines, the payment_method result and message include more detail from the Issuer on why it was declined. - /// For example, 51 - INSUFFICIENT FUNDS. This is generated by the issuing bank, who will provide decline codes in the response back to the authorization platform. pub result: Option<String>, } /// Data associated with the response of an APM transaction. #[derive(Debug, Serialize, Deserialize)] pub struct Apm { - pub bank: Option<Bank>, - /// A string generated by the payment method that represents to what degree the merchant is - /// funded for the transaction. - #[serde(skip_deserializing)] - pub fund_status: Option<FundStatus>, - pub mandate: Option<Mandate>, - /// A string used to identify the payment method provider being used to execute this - /// transaction. - pub provider: Option<ApmProvider>, - /// A name of the payer from the payment method system. - pub provider_payer_name: Option<Secret<String>>, - /// The time the payment method provider created the transaction at on their system. - pub provider_time_created: Option<String>, - /// The reference the payment method provider created for the transaction. - pub provider_transaction_reference: Option<String>, - /// URL to redirect the payer from the merchant's system to the payment method's system. - //1)paypal sends redirect_url as provider_redirect_url for require_customer_action - //2)bankredirects sends redirect_url as redirect_url for require_customer_action - //3)after completeauthorize in paypal it doesn't send redirect_url - //4)after customer action in bankredirects it sends empty string in redirect_url #[serde(alias = "provider_redirect_url")] pub redirect_url: Option<String>, - /// A string generated by the payment method to represent the session created on the payment - /// method's platform to facilitate the creation of a transaction. - pub session_token: Option<Secret<String>>, - pub payment_description: Option<String>, -} - -#[derive(Debug, Serialize, Deserialize)] -pub struct Bank { - /// The local identifier of the bank account. - pub account_number: Option<Secret<String>>, - /// The local identifier of the bank. - pub code: Option<Secret<String>>, - /// The international identifier of the bank account. - pub iban: Option<Secret<String>>, - /// The international identifier code for the bank. - pub identifier_code: Option<Secret<String>>, - /// The name associated with the bank account - pub name: Option<Secret<String>>, -} - -#[derive(Debug, Serialize, Deserialize)] -pub struct Mandate { - /// The reference to identify the mandate. - pub code: Option<Secret<String>>, -} - -/// Information outlining the degree of authentication executed related to a transaction. -#[derive(Debug, Serialize, Deserialize)] -pub struct Authentication { - /// Information outlining the degree of 3D Secure authentication executed. - pub three_ds: Option<ThreeDs>, -} - -/// Information outlining the degree of 3D Secure authentication executed. -#[derive(Debug, Serialize, Deserialize)] -pub struct ThreeDs { - /// The result of the three_ds value validation by the brands or issuing bank. - pub value_result: Option<String>, -} - -#[derive(Debug, Serialize, Deserialize)] -pub struct BankTransfer { - /// The last 4 characters of the local reference for a bank account number. - pub masked_number_last4: Option<String>, - /// The name of the bank. - pub name: Option<Secret<String>>, - /// The type of bank account associated with the payer's bank account. - pub number_type: Option<NumberType>, } #[derive(Debug, Serialize, Deserialize)] pub struct Card { - /// Code generated when the card is successfully authorized. - pub authcode: Option<Secret<String>>, - /// The recommended AVS action to be taken by the agent processing the card transaction. - pub avs_action: Option<String>, - /// The result of the AVS address check. - pub avs_address_result: Option<String>, - /// The result of the AVS postal code check. - pub avs_postal_code_result: Option<String>, - /// Indicates the card brand that issued the card. - pub brand: Option<Brand>, - /// The unique reference created by the brands/schemes to uniquely identify the transaction. pub brand_reference: Option<Secret<String>>, - /// The time returned by the card brand indicating when the transaction was processed on - /// their system. - pub brand_time_reference: Option<String>, - /// The result of the CVV check. - pub cvv_result: Option<String>, - /// Masked card number with last 4 digits showing. - pub masked_number_last4: Option<String>, - /// The result codes directly from the card issuer. - pub provider: Option<ProviderClass>, - /// The card EMV tag response data from the card issuer for a contactless or chip card - /// transaction. - pub tag_response: Option<Secret<String>>, -} - -/// The result codes directly from the card issuer. -#[derive(Debug, Serialize, Deserialize)] -pub struct ProviderClass { - /// The result code of the AVS address check from the card issuer. - #[serde(rename = "card.provider.avs_address_result")] - pub card_provider_avs_address_result: Option<String>, - /// The result of the AVS postal code check from the card issuer.. - #[serde(rename = "card.provider.avs_postal_code_result")] - pub card_provider_avs_postal_code_result: Option<String>, - /// The result code of the AVS check from the card issuer. - #[serde(rename = "card.provider.avs_result")] - pub card_provider_avs_result: Option<String>, - /// The result code of the CVV check from the card issuer. - #[serde(rename = "card.provider.cvv_result")] - pub card_provider_cvv_result: Option<String>, - /// Result code from the card issuer. - #[serde(rename = "card.provider.result")] - pub card_provider_result: Option<String>, -} - -/// The result of the action executed. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum ResultCode { - Declined, - Success, - Pending, - Error, -} - -/// Indicates the specific action taken. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum ActionType { - Adjust, - Authorize, - Capture, - Confirm, - Force, - Increment, - Initiate, - MultipleCapture, - Preauthorize, - PreauthorizeMultipleCapturere, - Authorization, - RedirectFrom, - RedirectTo, - Refund, - Hold, - Release, - Reverse, - Split, - StatusNotification, - TransactionList, - TransactionSingle, -} - -/// A string generated by the payment method that represents to what degree the merchant is -/// funded for the transaction. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum FundStatus { - Missing, - NotExpected, - Received, - Waiting, } /// A string used to identify the payment method provider being used to execute this @@ -325,49 +62,6 @@ pub enum ApmProvider { Testpay, } -/// The type of bank account associated with the payer's bank account. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum NumberType { - Checking, - Savings, -} - -/// The recommended AVS action to be taken by the agent processing the card transaction. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum AvsAction { - Accept, - Decline, - Prompt, -} - -/// The result of the AVS address check. -/// -/// The result of the AVS postal code check. -/// -/// The result of the CVV check. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum GlobalPayResult { - Matched, - NotChecked, - NotMatched, -} - -/// Indicates the card brand that issued the card. -#[derive(Debug, Serialize, Deserialize)] -#[serde(rename_all = "SCREAMING_SNAKE_CASE")] -pub enum Brand { - Amex, - Cup, - Diners, - Discover, - Jcb, - Mastercard, - Visa, -} - /// Indicates where a transaction is in its lifecycle. #[derive(Clone, Copy, Debug, Serialize, Deserialize)] #[serde(rename_all = "SCREAMING_SNAKE_CASE")] @@ -417,3 +111,22 @@ pub enum GlobalpayWebhookStatus { #[serde(other)] Unknown, } + +#[derive(Debug, Serialize, Deserialize)] +#[serde(rename_all = "SCREAMING_SNAKE_CASE")] +pub enum GlobalpayPaymentMethodStatus { + /// The entity is ACTIVE and can be used. + Active, + /// The entity is INACTIVE and cannot be used. + Inactive, + /// The status is DELETED. Once returned in an action response for a resource. + /// The resource has been removed from the platform. + Delete, +} + +#[derive(Debug, Serialize, Deserialize)] +pub struct GlobalpayPaymentMethodsResponse { + #[serde(rename = "id")] + pub payment_method_token_id: Option<Secret<String>>, + pub card: Card, +} diff --git a/crates/hyperswitch_connectors/src/connectors/globalpay/transformers.rs b/crates/hyperswitch_connectors/src/connectors/globalpay/transformers.rs index a7fd9abd2f8..e4239d28395 100644 --- a/crates/hyperswitch_connectors/src/connectors/globalpay/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/globalpay/transformers.rs @@ -8,7 +8,7 @@ use common_utils::{ use error_stack::ResultExt; use hyperswitch_domain_models::{ payment_method_data, - router_data::{AccessToken, ConnectorAuthType, ErrorResponse, RouterData}, + router_data::{AccessToken, ConnectorAuthType, ErrorResponse, PaymentMethodToken, RouterData}, router_flow_types::{Execute, RSync}, router_request_types::ResponseId, router_response_types::{ @@ -17,6 +17,7 @@ use hyperswitch_domain_models::{ types::{ PaymentsAuthorizeRouterData, PaymentsCancelRouterData, PaymentsCaptureRouterData, PaymentsSyncRouterData, RefreshTokenRouterData, RefundExecuteRouterData, RefundsRouterData, + TokenizationRouterData, }, }; use hyperswitch_interfaces::{ @@ -37,10 +38,14 @@ use super::{ response::{GlobalpayPaymentStatus, GlobalpayPaymentsResponse, GlobalpayRefreshTokenResponse}, }; use crate::{ + connectors::globalpay::{ + requests::CommonPaymentMethodData, response::GlobalpayPaymentMethodsResponse, + }, types::{PaymentsSyncResponseRouterData, RefundsResponseRouterData, ResponseRouterData}, utils::{ self, construct_captures_response_hashmap, CardData, ForeignTryFrom, - MultipleCaptureSyncResponse, PaymentsAuthorizeRequestData, RouterData as _, WalletData, + MultipleCaptureSyncResponse, PaymentMethodTokenizationRequestData, + PaymentsAuthorizeRequestData, RouterData as _, WalletData, }, }; @@ -82,65 +87,115 @@ impl TryFrom<&Option<pii::SecretSerdeValue>> for GlobalPayMeta { impl TryFrom<&GlobalPayRouterData<&PaymentsAuthorizeRouterData>> for GlobalpayPaymentsRequest { type Error = Error; + fn try_from( item: &GlobalPayRouterData<&PaymentsAuthorizeRouterData>, ) -> Result<Self, Self::Error> { + if item.router_data.is_three_ds() { + return Err(errors::ConnectorError::NotSupported { + message: "3DS flow".to_string(), + connector: "Globalpay", + } + .into()); + } + let metadata = GlobalPayMeta::try_from(&item.router_data.connector_meta_data)?; let account_name = metadata.account_name; - let (initiator, stored_credential, brand_reference) = - get_mandate_details(item.router_data)?; - let payment_method_data = get_payment_method_data(item.router_data, brand_reference)?; + + let (initiator, stored_credential, connector_mandate_id) = + if item.router_data.request.is_mandate_payment() { + let connector_mandate_id = + item.router_data + .request + .mandate_id + .as_ref() + .and_then(|mandate_ids| match &mandate_ids.mandate_reference_id { + Some(api_models::payments::MandateReferenceId::ConnectorMandateId( + connector_mandate_ids, + )) => connector_mandate_ids.get_connector_mandate_id(), + _ => None, + }); + + let initiator = Some(match item.router_data.request.off_session { + Some(true) => Initiator::Merchant, + _ => Initiator::Payer, + }); + + let stored_credential = Some(StoredCredential { + model: Some(if connector_mandate_id.is_some() { + requests::Model::Recurring + } else { + requests::Model::Unscheduled + }), + sequence: Some(if connector_mandate_id.is_some() { + Sequence::Subsequent + } else { + Sequence::First + }), + }); + + (initiator, stored_credential, connector_mandate_id) + } else { + (None, None, None) + }; + + let payment_method = match &item.router_data.request.payment_method_data { + payment_method_data::PaymentMethodData::Card(ccard) => { + requests::GlobalPayPaymentMethodData::Common(CommonPaymentMethodData { + payment_method_data: PaymentMethodData::Card(requests::Card { + number: ccard.card_number.clone(), + expiry_month: ccard.card_exp_month.clone(), + expiry_year: ccard.get_card_expiry_year_2_digit()?, + cvv: ccard.card_cvc.clone(), + }), + entry_mode: Default::default(), + }) + } + + payment_method_data::PaymentMethodData::Wallet(wallet_data) => { + requests::GlobalPayPaymentMethodData::Common(CommonPaymentMethodData { + payment_method_data: get_wallet_data(wallet_data)?, + entry_mode: Default::default(), + }) + } + + payment_method_data::PaymentMethodData::BankRedirect(bank_redirect) => { + requests::GlobalPayPaymentMethodData::Common(CommonPaymentMethodData { + payment_method_data: PaymentMethodData::try_from(bank_redirect)?, + entry_mode: Default::default(), + }) + } + + payment_method_data::PaymentMethodData::MandatePayment => { + requests::GlobalPayPaymentMethodData::Mandate(requests::MandatePaymentMethodData { + entry_mode: Default::default(), + id: connector_mandate_id, + }) + } + + _ => Err(errors::ConnectorError::NotImplemented( + "Payment methods".to_string(), + ))?, + }; + Ok(Self { account_name, amount: Some(item.amount.to_owned()), currency: item.router_data.request.currency.to_string(), - reference: item.router_data.connector_request_reference_id.to_string(), country: item.router_data.get_billing_country()?, capture_mode: Some(requests::CaptureMode::from( item.router_data.request.capture_method, )), - payment_method: requests::PaymentMethod { - payment_method_data, - authentication: None, - encryption: None, - entry_mode: Default::default(), - fingerprint_mode: None, - first_name: None, - id: None, - last_name: None, - name: None, - narrative: None, - storage_mode: None, - }, + payment_method, notifications: Some(requests::Notifications { return_url: get_return_url(item.router_data), - challenge_return_url: None, - decoupled_challenge_return_url: None, status_url: item.router_data.request.webhook_url.clone(), - three_ds_method_return_url: None, cancel_url: get_return_url(item.router_data), }), - authorization_mode: None, - cashback_amount: None, + stored_credential, channel: Default::default(), - convenience_amount: None, - currency_conversion: None, - description: None, - device: None, - gratuity_amount: None, initiator, - ip_address: None, - language: None, - lodging: None, - order: None, - payer_reference: None, - site_reference: None, - stored_credential, - surcharge_amount: None, - total_capture_count: None, - globalpay_payments_request_type: None, - user_reference: None, }) } } @@ -176,6 +231,32 @@ impl TryFrom<&GlobalPayRouterData<&PaymentsCaptureRouterData>> } } +impl TryFrom<&TokenizationRouterData> for requests::GlobalPayPaymentMethodsRequest { + type Error = Error; + fn try_from(item: &TokenizationRouterData) -> Result<Self, Self::Error> { + if !item.request.is_mandate_payment() { + return Err(errors::ConnectorError::FlowNotSupported { + flow: "Tokenization apart from Mandates".to_string(), + connector: "Globalpay".to_string(), + } + .into()); + } + Ok(Self { + reference: item.connector_request_reference_id.clone(), + usage_mode: Some(requests::UsageMode::Multiple), + card: match &item.request.payment_method_data { + payment_method_data::PaymentMethodData::Card(card_data) => Some(requests::Card { + number: card_data.card_number.clone(), + expiry_month: card_data.card_exp_month.clone(), + expiry_year: card_data.get_card_expiry_year_2_digit()?, + cvv: card_data.card_cvc.clone(), + }), + _ => None, + }, + }) + } +} + impl TryFrom<&GlobalpayCancelRouterData<&PaymentsCancelRouterData>> for requests::GlobalpayCancelRequest { @@ -278,73 +359,18 @@ impl From<Option<common_enums::CaptureMethod>> for requests::CaptureMode { } } -fn get_payment_response( - status: common_enums::AttemptStatus, - response: GlobalpayPaymentsResponse, - redirection_data: Option<RedirectForm>, - status_code: u16, -) -> Result<PaymentsResponseData, Box<ErrorResponse>> { - let mandate_reference = response.payment_method.as_ref().and_then(|pm| { - pm.card - .as_ref() - .and_then(|card| card.brand_reference.to_owned()) - .map(|id| MandateReference { - connector_mandate_id: Some(id.expose()), - payment_method_id: None, - mandate_metadata: None, - connector_mandate_request_reference_id: None, - }) - }); - match status { - common_enums::AttemptStatus::Failure => Err(Box::new(ErrorResponse { - message: response - .payment_method - .as_ref() - .and_then(|payment_method| payment_method.message.clone()) - .unwrap_or_else(|| NO_ERROR_MESSAGE.to_string()), - code: response - .payment_method - .as_ref() - .and_then(|payment_method| payment_method.result.clone()) - .unwrap_or_else(|| consts::NO_ERROR_CODE.to_string()), - reason: response - .payment_method - .as_ref() - .and_then(|payment_method| payment_method.message.clone()), - status_code, - attempt_status: Some(status), - connector_transaction_id: Some(response.id), - network_decline_code: response - .payment_method - .as_ref() - .and_then(|payment_method| payment_method.result.clone()), - network_advice_code: None, - network_error_message: response - .payment_method - .as_ref() - .and_then(|payment_method| payment_method.message.clone()), - })), - _ => Ok(PaymentsResponseData::TransactionResponse { - resource_id: ResponseId::ConnectorTransactionId(response.id.clone()), - redirection_data: Box::new(redirection_data), - mandate_reference: Box::new(mandate_reference), - connector_metadata: None, - network_txn_id: None, - connector_response_reference_id: response.reference, - incremental_authorization_allowed: None, - charges: None, - }), - } -} +// } impl<F, T> TryFrom<ResponseRouterData<F, GlobalpayPaymentsResponse, T, PaymentsResponseData>> for RouterData<F, T, PaymentsResponseData> { type Error = Error; + fn try_from( item: ResponseRouterData<F, GlobalpayPaymentsResponse, T, PaymentsResponseData>, ) -> Result<Self, Self::Error> { let status = common_enums::AttemptStatus::from(item.response.status); + let redirect_url = item .response .payment_method @@ -360,12 +386,92 @@ impl<F, T> TryFrom<ResponseRouterData<F, GlobalpayPaymentsResponse, T, PaymentsR Url::parse(url).change_context(errors::ConnectorError::FailedToObtainIntegrationUrl) }) .transpose()?; + let redirection_data = redirect_url.map(|url| RedirectForm::from((url, Method::Get))); + let payment_method_token = item.data.get_payment_method_token(); let status_code = item.http_code; + + let mandate_reference = payment_method_token.ok().and_then(|token| match token { + PaymentMethodToken::Token(token_string) => Some(MandateReference { + connector_mandate_id: Some(token_string.clone().expose()), + payment_method_id: None, + mandate_metadata: None, + connector_mandate_request_reference_id: None, + }), + _ => None, + }); + + let response = match status { + common_enums::AttemptStatus::Failure => Err(Box::new(ErrorResponse { + message: item + .response + .payment_method + .as_ref() + .and_then(|payment_method| payment_method.message.clone()) + .unwrap_or_else(|| NO_ERROR_MESSAGE.to_string()), + code: item + .response + .payment_method + .as_ref() + .and_then(|payment_method| payment_method.result.clone()) + .unwrap_or_else(|| consts::NO_ERROR_CODE.to_string()), + reason: item + .response + .payment_method + .as_ref() + .and_then(|payment_method| payment_method.message.clone()), + status_code, + attempt_status: Some(status), + connector_transaction_id: Some(item.response.id.clone()), + network_decline_code: item + .response + .payment_method + .as_ref() + .and_then(|payment_method| payment_method.result.clone()), + network_advice_code: None, + network_error_message: item + .response + .payment_method + .as_ref() + .and_then(|payment_method| payment_method.message.clone()), + })), + _ => Ok(PaymentsResponseData::TransactionResponse { + resource_id: ResponseId::ConnectorTransactionId(item.response.id.clone()), + redirection_data: Box::new(redirection_data), + mandate_reference: Box::new(mandate_reference), + connector_metadata: None, + network_txn_id: None, + connector_response_reference_id: item.response.reference.clone(), + incremental_authorization_allowed: None, + charges: None, + }), + }; + Ok(Self { status, - response: get_payment_response(status, item.response, redirection_data, status_code) - .map_err(|err| *err), + response: response.map_err(|err| *err), + ..item.data + }) + } +} + +impl<F, T> TryFrom<ResponseRouterData<F, GlobalpayPaymentMethodsResponse, T, PaymentsResponseData>> + for RouterData<F, T, PaymentsResponseData> +{ + type Error = Error; + fn try_from( + item: ResponseRouterData<F, GlobalpayPaymentMethodsResponse, T, PaymentsResponseData>, + ) -> Result<Self, Self::Error> { + let token = item + .response + .payment_method_token_id + .clone() + .unwrap_or_default(); + + Ok(Self { + response: Ok(PaymentsResponseData::TokenizationResponse { + token: token.expose(), + }), ..item.data }) } @@ -467,39 +573,6 @@ pub struct GlobalpayErrorResponse { pub detailed_error_description: String, } -fn get_payment_method_data( - item: &PaymentsAuthorizeRouterData, - brand_reference: Option<String>, -) -> Result<PaymentMethodData, Error> { - match &item.request.payment_method_data { - payment_method_data::PaymentMethodData::Card(ccard) => { - Ok(PaymentMethodData::Card(requests::Card { - number: ccard.card_number.clone(), - expiry_month: ccard.card_exp_month.clone(), - expiry_year: ccard.get_card_expiry_year_2_digit()?, - cvv: ccard.card_cvc.clone(), - account_type: None, - authcode: None, - avs_address: None, - avs_postal_code: None, - brand_reference, - chip_condition: None, - funding: None, - pin_block: None, - tag: None, - track: None, - })) - } - payment_method_data::PaymentMethodData::Wallet(wallet_data) => get_wallet_data(wallet_data), - payment_method_data::PaymentMethodData::BankRedirect(bank_redirect) => { - PaymentMethodData::try_from(bank_redirect) - } - _ => Err(errors::ConnectorError::NotImplemented( - "Payment methods".to_string(), - ))?, - } -} - fn get_return_url(item: &PaymentsAuthorizeRouterData) -> Option<String> { match item.request.payment_method_data.clone() { payment_method_data::PaymentMethodData::Wallet( @@ -516,36 +589,6 @@ fn get_return_url(item: &PaymentsAuthorizeRouterData) -> Option<String> { } } -type MandateDetails = (Option<Initiator>, Option<StoredCredential>, Option<String>); -fn get_mandate_details(item: &PaymentsAuthorizeRouterData) -> Result<MandateDetails, Error> { - Ok(if item.request.is_mandate_payment() { - let connector_mandate_id = item.request.mandate_id.as_ref().and_then(|mandate_ids| { - match mandate_ids.mandate_reference_id.clone() { - Some(api_models::payments::MandateReferenceId::ConnectorMandateId( - connector_mandate_ids, - )) => connector_mandate_ids.get_connector_mandate_id(), - _ => None, - } - }); - ( - Some(match item.request.off_session { - Some(true) => Initiator::Merchant, - _ => Initiator::Payer, - }), - Some(StoredCredential { - model: Some(requests::Model::Recurring), - sequence: Some(match connector_mandate_id.is_some() { - true => Sequence::Subsequent, - false => Sequence::First, - }), - }), - connector_mandate_id, - ) - } else { - (None, None, None) - }) -} - fn get_wallet_data( wallet_data: &payment_method_data::WalletData, ) -> Result<PaymentMethodData, Error> { diff --git a/crates/hyperswitch_connectors/src/utils.rs b/crates/hyperswitch_connectors/src/utils.rs index 143e7474dd3..09a56474c27 100644 --- a/crates/hyperswitch_connectors/src/utils.rs +++ b/crates/hyperswitch_connectors/src/utils.rs @@ -2190,6 +2190,7 @@ impl PaymentsSetupMandateRequestData for SetupMandateRequestData { pub trait PaymentMethodTokenizationRequestData { fn get_browser_info(&self) -> Result<BrowserInformation, Error>; + fn is_mandate_payment(&self) -> bool; } impl PaymentMethodTokenizationRequestData for PaymentMethodTokenizationData { @@ -2198,6 +2199,15 @@ impl PaymentMethodTokenizationRequestData for PaymentMethodTokenizationData { .clone() .ok_or_else(missing_field_err("browser_info")) } + fn is_mandate_payment(&self) -> bool { + ((self.customer_acceptance.is_some() || self.setup_mandate_details.is_some()) + && (self.setup_future_usage == Some(FutureUsage::OffSession))) + || self + .mandate_id + .as_ref() + .and_then(|mandate_ids| mandate_ids.mandate_reference_id.as_ref()) + .is_some() + } } pub trait PaymentsCompleteAuthorizeRequestData { diff --git a/crates/hyperswitch_domain_models/src/router_request_types.rs b/crates/hyperswitch_domain_models/src/router_request_types.rs index b9e2e4a74a6..e919538ea5e 100644 --- a/crates/hyperswitch_domain_models/src/router_request_types.rs +++ b/crates/hyperswitch_domain_models/src/router_request_types.rs @@ -254,6 +254,10 @@ pub struct PaymentMethodTokenizationData { pub currency: storage_enums::Currency, pub amount: Option<i64>, pub split_payments: Option<common_types::payments::SplitPaymentsRequest>, + pub customer_acceptance: Option<common_payments_types::CustomerAcceptance>, + pub setup_future_usage: Option<storage_enums::FutureUsage>, + pub setup_mandate_details: Option<mandates::MandateData>, + pub mandate_id: Option<api_models::payments::MandateIds>, } impl TryFrom<SetupMandateRequestData> for PaymentMethodTokenizationData { @@ -266,6 +270,10 @@ impl TryFrom<SetupMandateRequestData> for PaymentMethodTokenizationData { currency: data.currency, amount: data.amount, split_payments: None, + customer_acceptance: data.customer_acceptance, + setup_future_usage: data.setup_future_usage, + setup_mandate_details: data.setup_mandate_details, + mandate_id: data.mandate_id, }) } } @@ -281,6 +289,10 @@ impl<F> From<&RouterData<F, PaymentsAuthorizeData, response_types::PaymentsRespo currency: data.request.currency, amount: Some(data.request.amount), split_payments: data.request.split_payments.clone(), + customer_acceptance: data.request.customer_acceptance.clone(), + setup_future_usage: data.request.setup_future_usage, + setup_mandate_details: data.request.setup_mandate_details.clone(), + mandate_id: data.request.mandate_id.clone(), } } } @@ -295,6 +307,10 @@ impl TryFrom<PaymentsAuthorizeData> for PaymentMethodTokenizationData { currency: data.currency, amount: Some(data.amount), split_payments: data.split_payments.clone(), + customer_acceptance: data.customer_acceptance, + setup_future_usage: data.setup_future_usage, + setup_mandate_details: data.setup_mandate_details, + mandate_id: data.mandate_id, }) } } @@ -314,6 +330,10 @@ impl TryFrom<CompleteAuthorizeData> for PaymentMethodTokenizationData { currency: data.currency, amount: Some(data.amount), split_payments: None, + customer_acceptance: data.customer_acceptance, + setup_future_usage: data.setup_future_usage, + setup_mandate_details: data.setup_mandate_details, + mandate_id: data.mandate_id, }) } } diff --git a/crates/router/src/configs/settings.rs b/crates/router/src/configs/settings.rs index ae4c8a3cda0..f381712ddfc 100644 --- a/crates/router/src/configs/settings.rs +++ b/crates/router/src/configs/settings.rs @@ -620,6 +620,13 @@ pub struct PaymentMethodTokenFilter { pub payment_method_type: Option<PaymentMethodTypeTokenFilter>, pub long_lived_token: bool, pub apple_pay_pre_decrypt_flow: Option<ApplePayPreDecryptFlow>, + pub flow: Option<PaymentFlow>, +} + +#[derive(Debug, Deserialize, Clone, PartialEq)] +#[serde(deny_unknown_fields, rename_all = "snake_case")] +pub enum PaymentFlow { + Mandates, } #[derive(Debug, Deserialize, Clone, Default)] diff --git a/crates/router/src/core/payment_methods.rs b/crates/router/src/core/payment_methods.rs index 4a23f04cda6..b9d17129249 100644 --- a/crates/router/src/core/payment_methods.rs +++ b/crates/router/src/core/payment_methods.rs @@ -3249,6 +3249,10 @@ async fn create_single_use_tokenization_flow( currency: api_models::enums::Currency::default(), amount: None, split_payments: None, + mandate_id: None, + setup_future_usage: None, + customer_acceptance: None, + setup_mandate_details: None, }; let payment_method_session_address = types::PaymentAddress::new( @@ -3317,12 +3321,12 @@ async fn create_single_use_tokenization_flow( is_payment_id_from_merchant: None, }; - let payment_method_token_response = tokenization::add_token_for_payment_method( + let payment_method_token_response = Box::pin(tokenization::add_token_for_payment_method( &mut router_data, payment_method_data_request.clone(), state.clone(), &merchant_connector_account_details.clone(), - ) + )) .await?; let token_response = payment_method_token_response.token.map_err(|err| { diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs index cc6f3384a22..b5c04cfc927 100644 --- a/crates/router/src/core/payments.rs +++ b/crates/router/src/core/payments.rs @@ -106,7 +106,7 @@ use crate::core::routing::helpers as routing_helpers; #[cfg(all(feature = "v1", feature = "dynamic_routing"))] use crate::types::api::convert_connector_data_to_routable_connectors; use crate::{ - configs::settings::{ApplePayPreDecryptFlow, PaymentMethodTypeTokenFilter}, + configs::settings::{ApplePayPreDecryptFlow, PaymentFlow, PaymentMethodTypeTokenFilter}, consts, core::{ errors::{self, CustomResult, RouterResponse, RouterResult}, @@ -6153,6 +6153,7 @@ fn is_payment_method_tokenization_enabled_for_connector( payment_method: storage::enums::PaymentMethod, payment_method_type: Option<storage::enums::PaymentMethodType>, payment_method_token: Option<&PaymentMethodToken>, + mandate_flow_enabled: Option<storage_enums::FutureUsage>, ) -> RouterResult<bool> { let connector_tokenization_filter = state.conf.tokenization.0.get(connector_name); @@ -6171,10 +6172,29 @@ fn is_payment_method_tokenization_enabled_for_connector( payment_method_token, connector_filter.apple_pay_pre_decrypt_flow.clone(), ) + && is_payment_flow_allowed_for_connector( + mandate_flow_enabled, + connector_filter.flow.clone(), + ) }) .unwrap_or(false)) } +fn is_payment_flow_allowed_for_connector( + mandate_flow_enabled: Option<storage_enums::FutureUsage>, + payment_flow: Option<PaymentFlow>, +) -> bool { + if payment_flow.is_none() { + true + } else { + matches!(payment_flow, Some(PaymentFlow::Mandates)) + && matches!( + mandate_flow_enabled, + Some(storage_enums::FutureUsage::OffSession) + ) + } +} + fn is_apple_pay_pre_decrypt_type_connector_tokenization( payment_method_type: Option<storage::enums::PaymentMethodType>, payment_method_token: Option<&PaymentMethodToken>, @@ -6500,6 +6520,10 @@ where .get_required_value("payment_method")?; let payment_method_type = payment_data.get_payment_attempt().payment_method_type; + let mandate_flow_enabled = payment_data + .get_payment_attempt() + .setup_future_usage_applied; + let is_connector_tokenization_enabled = is_payment_method_tokenization_enabled_for_connector( state, @@ -6507,6 +6531,7 @@ where payment_method, payment_method_type, payment_data.get_payment_method_token(), + mandate_flow_enabled, )?; let payment_method_action = decide_payment_method_tokenize_action( @@ -8341,7 +8366,7 @@ where .change_context(errors::ApiErrorResponse::InternalServerError) .attach_printable("Failed to get the common mandate reference")?; - let connector_mandate_details = connector_common_mandate_details.payments; + let connector_mandate_details = connector_common_mandate_details.payments.clone(); let mut connector_choice = None; diff --git a/crates/router/src/core/payments/helpers.rs b/crates/router/src/core/payments/helpers.rs index 4a023f7d8c4..0b1758990ab 100644 --- a/crates/router/src/core/payments/helpers.rs +++ b/crates/router/src/core/payments/helpers.rs @@ -2039,8 +2039,7 @@ pub fn decide_payment_method_retrieval_action( pub async fn is_ucs_enabled(state: &SessionState, config_key: &str) -> bool { let db = state.store.as_ref(); - let is_enabled = db - .find_config_by_key_unwrap_or(config_key, Some("false".to_string())) + db.find_config_by_key_unwrap_or(config_key, Some("false".to_string())) .await .map_err(|error| { logger::error!( @@ -2053,9 +2052,7 @@ pub async fn is_ucs_enabled(state: &SessionState, config_key: &str) -> bool { logger::error!(?error, "Failed to parse `{config_key}` UCS enabled config"); }) }) - .unwrap_or(false); - - is_enabled + .unwrap_or(false) } pub async fn should_execute_based_on_rollout( diff --git a/crates/router/tests/connectors/square.rs b/crates/router/tests/connectors/square.rs index 81ea8112276..760e8ebdaea 100644 --- a/crates/router/tests/connectors/square.rs +++ b/crates/router/tests/connectors/square.rs @@ -68,6 +68,10 @@ fn token_details() -> Option<types::PaymentMethodTokenizationData> { amount: None, currency: enums::Currency::USD, split_payments: None, + mandate_id: None, + setup_future_usage: None, + customer_acceptance: None, + setup_mandate_details: None, }) } @@ -442,6 +446,10 @@ async fn should_fail_payment_for_incorrect_cvc() { amount: None, currency: enums::Currency::USD, split_payments: None, + mandate_id: None, + setup_future_usage: None, + customer_acceptance: None, + setup_mandate_details: None, }), get_default_payment_info(None), ) @@ -474,6 +482,10 @@ async fn should_fail_payment_for_invalid_exp_month() { amount: None, currency: enums::Currency::USD, split_payments: None, + mandate_id: None, + setup_future_usage: None, + customer_acceptance: None, + setup_mandate_details: None, }), get_default_payment_info(None), ) @@ -506,6 +518,10 @@ async fn should_fail_payment_for_incorrect_expiry_year() { amount: None, currency: enums::Currency::USD, split_payments: None, + mandate_id: None, + setup_future_usage: None, + customer_acceptance: None, + setup_mandate_details: None, }), get_default_payment_info(None), ) diff --git a/crates/router/tests/connectors/stax.rs b/crates/router/tests/connectors/stax.rs index 93c2394354b..89b1bc7f4b9 100644 --- a/crates/router/tests/connectors/stax.rs +++ b/crates/router/tests/connectors/stax.rs @@ -73,6 +73,10 @@ fn token_details() -> Option<types::PaymentMethodTokenizationData> { amount: None, currency: enums::Currency::USD, split_payments: None, + mandate_id: None, + setup_future_usage: None, + customer_acceptance: None, + setup_mandate_details: None, }) } @@ -484,6 +488,10 @@ async fn should_fail_payment_for_incorrect_cvc() { amount: None, currency: enums::Currency::USD, split_payments: None, + mandate_id: None, + setup_future_usage: None, + customer_acceptance: None, + setup_mandate_details: None, }), get_default_payment_info(connector_customer_id, None), ) @@ -523,6 +531,10 @@ async fn should_fail_payment_for_invalid_exp_month() { amount: None, currency: enums::Currency::USD, split_payments: None, + mandate_id: None, + setup_future_usage: None, + customer_acceptance: None, + setup_mandate_details: None, }), get_default_payment_info(connector_customer_id, None), ) @@ -562,6 +574,10 @@ async fn should_fail_payment_for_incorrect_expiry_year() { amount: None, currency: enums::Currency::USD, split_payments: None, + mandate_id: None, + setup_future_usage: None, + customer_acceptance: None, + setup_mandate_details: None, }), get_default_payment_info(connector_customer_id, None), ) diff --git a/crates/router/tests/connectors/utils.rs b/crates/router/tests/connectors/utils.rs index e3884894b33..a8676834040 100644 --- a/crates/router/tests/connectors/utils.rs +++ b/crates/router/tests/connectors/utils.rs @@ -1121,6 +1121,10 @@ impl Default for TokenType { amount: Some(100), currency: enums::Currency::USD, split_payments: None, + mandate_id: None, + setup_future_usage: None, + customer_acceptance: None, + setup_mandate_details: None, }; Self(data) } diff --git a/loadtest/config/development.toml b/loadtest/config/development.toml index b0bc2e9ee1c..0d1e27961d4 100644 --- a/loadtest/config/development.toml +++ b/loadtest/config/development.toml @@ -591,6 +591,7 @@ mollie = { long_lived_token = false, payment_method = "card" } braintree = { long_lived_token = false, payment_method = "card" } gocardless = { long_lived_token = true, payment_method = "bank_debit" } billwerk = { long_lived_token = false, payment_method = "card" } +globalpay = { long_lived_token = false, payment_method = "card", flow = "mandates" } [connector_customer] connector_list = "adyen,facilitapay,gocardless,hyperswitch_vault,stax,stripe"

2025-07-07T11:53:46Z

## Type of Change  - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  In One-off payments, we donot need to create the token. Just passing raw cards would be enough. In CITs, we need to create a token and store it in `connector_mandate_id` for future MITs but while executing the CIT, raw cards need to be passed. In MITs, we need to use that previously stored token in CIT and no more need to hit the tokenization endpoint at connector. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [x] This PR modifies application configuration/environment variables  ## Motivation and Context  ## How did you test it?  1. Payments Create - One-off cURL: ``` curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_v5jp7Ow9W5g6tgWaDHs4UR385iFfpg9dXQGYQkxxRXQdHlcvR70WmjJRPWJt7Xe7' \ --header 'Cookie: PHPSESSID=0b47db9d7de94c37b6b272087a9f2fa7' \ --data-raw '{ "currency":"USD", "amount": 300, "confirm": true, "amount_to_capture": 300, "capture_method": "automatic", "capture_on": "2022-09-10T10:11:12Z", "authentication_type": "no_three_ds", "return_url": "https://www.google.com", "email": "[email protected]", "name": "Joseph Doe", "phone": "999999999", "phone_country_code": "+65", "description": "Its my first payment request", "statement_descriptor_name": "Juspay", "statement_descriptor_suffix": "Router", "payment_method": "card", "payment_method_type": "credit", "payment_method_data": { "card": { "card_number": "4242424242424242", "card_exp_month": "03", "card_exp_year": "2030", "card_holder_name": "joseph Doe", "card_cvc": "737" } }, "billing": { "address": { "line1": "1467", "line2": "CA", "line3": "Harrison Street", "city": "San Fransico", "state": "CA", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" }, "phone": { "number": "8056594427", "country_code": "+91" } }, "browser_info": { "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8", "language": "nl-NL", "color_depth": 24, "screen_height": 723, "screen_width": 1536, "time_zone": 0, "java_enabled": true, "java_script_enabled": true, "ip_address": "109.71.40.0" }, "metadata": { "order_category": "applepay" }, "order_details": [ { "product_name": "Apple iphone 15", "quantity": 1, "amount": 300, "account_name": "transaction_processing" } ] }' ``` Response: ``` { "payment_id": "pay_j2mMaanCWkdCD2ytx5gg", "merchant_id": "merchant_1751871882", "status": "succeeded", "amount": 300, "net_amount": 300, "shipping_cost": null, "amount_capturable": 0, "amount_received": 300, "connector": "globalpay", "client_secret": "pay_j2mMaanCWkdCD2ytx5gg_secret_CqzsQEqF82ClZdEAoVF3", "created": "2025-07-07T11:03:44.204Z", "currency": "USD", "customer_id": null, "customer": { "id": null, "name": "Joseph Doe", "email": "[email protected]", "phone": "999999999", "phone_country_code": "+65" }, "description": "Its my first payment request", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "card", "payment_method_data": { "card": { "last4": "4242", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "424242", "card_extended_bin": null, "card_exp_month": "03", "card_exp_year": "2030", "card_holder_name": "joseph Doe", "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "CA", "line3": "Harrison Street", "zip": "94122", "state": "CA", "first_name": "joseph", "last_name": "Doe" }, "phone": { "number": "8056594427", "country_code": "+91" }, "email": null }, "order_details": [ { "brand": null, "amount": 300, "category": null, "quantity": 1, "tax_rate": null, "product_id": null, "product_name": "Apple iphone 15", "product_type": null, "sub_category": null, "product_img_link": null, "product_tax_code": null, "total_tax_amount": null, "requires_shipping": null } ], "email": null, "name": null, "phone": null, "return_url": "https://www.google.com/", "authentication_type": "no_three_ds", "statement_descriptor_name": "Juspay", "statement_descriptor_suffix": "Router", "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "credit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": null, "manual_retry_allowed": false, "connector_transaction_id": "TRN_IORyBbPseO4Qiy0L2v8YpZpgWA9auN_dCD2ytx5gg_1", "frm_message": null, "metadata": { "order_category": "applepay" }, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_j2mMaanCWkdCD2ytx5gg_1", "payment_link": null, "profile_id": "pro_GIxd8tTl8PWNt9L2ynbr", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_ghTQYltef3iCpp4cdsVu", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-07-07T11:18:44.204Z", "fingerprint": null, "browser_info": { "language": "nl-NL", "time_zone": 0, "ip_address": "109.71.40.0", "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "color_depth": 24, "java_enabled": true, "screen_width": 1536, "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8", "screen_height": 723, "java_script_enabled": true }, "payment_method_id": null, "payment_method_status": null, "updated": "2025-07-07T11:03:46.731Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` 2. CIT using `mandate_id` Request: ``` curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_otcCi6DyRzeDWx38OH5BTLBjBK1WS7Jt1BbsMpPepSR2Rr5dIPgVgPMoeekaqoXL' \ --header 'Cookie: PHPSESSID=0b47db9d7de94c37b6b272087a9f2fa7' \ --data-raw '{ "amount": 6000, "all_keys_required": true, "currency": "USD", "confirm": true, "capture_method": "automatic", "capture_on": "2022-09-10T10:11:12Z", "customer_id": "cus_LI9DQMmb1tHRjnfnkjwknjfXtonFkU", "email": "[email protected]", "name": "John Doe", "phone": "999999999", "phone_country_code": "+65", "description": "Its my first payment request", "authentication_type": "no_three_ds", "return_url": "https://example.com", "payment_method": "card", "payment_method_type": "debit", "payment_method_data": { "card": { "card_number": "4111111111111111", "card_exp_month": "12", "card_exp_year": "2030", "card_holder_name": "joseph Doe", "card_cvc": "123" } }, "setup_future_usage": "off_session", "customer_acceptance": { "acceptance_type": "offline", "accepted_at": "1963-05-03T04:07:52.723Z", "online": { "ip_address": "in sit", "user_agent": "amet irure esse" } }, "mandate_data": { "customer_acceptance": { "acceptance_type": "offline", "accepted_at": "1963-05-03T04:07:52.723Z", "online": { "ip_address": "127.0.0.1", "user_agent": "amet irure esse" } }, "mandate_type": { "single_use": { "amount": 8000, "currency": "USD" } } }, "payment_type": "new_mandate", "billing": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "john", "last_name": "Doe" } }, "shipping": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "john", "last_name": "Doe" } }, "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "metadata": { "udf1": "value1", "new_customer": "true", "login_date": "2019-09-10T10:11:12Z" }, "browser_info": { "ip_address": "129.0.0.1", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36", "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8", "language": "en-US", "color_depth": 32, "screen_height": 1117, "screen_width": 1728, "time_zone": -330, "java_enabled": true, "java_script_enabled": true } }' ``` Response: ``` { "payment_id": "pay_pgbcY6mXYI4IYk2Zt5kc", "merchant_id": "merchant_1753277415", "status": "succeeded", "amount": 6000, "net_amount": 6000, "shipping_cost": null, "amount_capturable": 0, "amount_received": 6000, "connector": "globalpay", "client_secret": "pay_pgbcY6mXYI4IYk2Zt5kc_secret_H0sK1auIjNZsIcfjVE1d", "created": "2025-07-23T17:30:07.918Z", "currency": "USD", "customer_id": "cus_LI9DQMmb1tHRjnfnkjwknjfXtonFkU", "customer": { "id": "cus_LI9DQMmb1tHRjnfnkjwknjfXtonFkU", "name": "John Doe", "email": "[email protected]", "phone": "999999999", "phone_country_code": "+65" }, "description": "Its my first payment request", "refunds": null, "disputes": null, "mandate_id": "man_bRinPSQhGM8Pky90uBNb", "mandate_data": { "update_mandate_id": null, "customer_acceptance": { "acceptance_type": "offline", "accepted_at": "1963-05-03T04:07:52.723Z", "online": { "ip_address": "127.0.0.1", "user_agent": "amet irure esse" } }, "mandate_type": { "single_use": { "amount": 8000, "currency": "USD", "start_date": null, "end_date": null, "metadata": null } } }, "setup_future_usage": "off_session", "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "card", "payment_method_data": { "card": { "last4": "1111", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "411111", "card_extended_bin": null, "card_exp_month": "12", "card_exp_year": "2030", "card_holder_name": "joseph Doe", "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "john", "last_name": "Doe" }, "phone": null, "email": null }, "billing": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "john", "last_name": "Doe" }, "phone": null, "email": null }, "order_details": null, "email": "[email protected]", "name": "John Doe", "phone": "999999999", "return_url": "https://example.com/", "authentication_type": "no_three_ds", "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "debit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": { "customer_id": "cus_LI9DQMmb1tHRjnfnkjwknjfXtonFkU", "created_at": 1753291807, "expires": 1753295407, "secret": "epk_222a00737e6c47d181b899d8afc76813" }, "manual_retry_allowed": false, "connector_transaction_id": "TRN_gBpefdKHlBxfmgVgFSlfPuCQXj86TT_4IYk2Zt5kc_1", "frm_message": null, "metadata": { "udf1": "value1", "login_date": "2019-09-10T10:11:12Z", "new_customer": "true" }, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_pgbcY6mXYI4IYk2Zt5kc_1", "payment_link": null, "profile_id": "pro_roCz974ra9LQxsifUris", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_5Y545k7TI4upQYSbJJ9L", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-07-23T17:45:07.918Z", "fingerprint": null, "browser_info": { "language": "en-US", "time_zone": -330, "ip_address": "129.0.0.1", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36", "color_depth": 32, "java_enabled": true, "screen_width": 1728, "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8", "screen_height": 1117, "java_script_enabled": true }, "payment_method_id": "pm_uDtgQsunDERQMrEXxbcy", "payment_method_status": null, "updated": "2025-07-23T17:30:11.412Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": "{\"id\":\"TRN_gBpefdKHlBxfmgVgFSlfPuCQXj86TT_4IYk2Zt5kc_1\",\"time_created\":\"2025-07-23T17:30:11.323Z\",\"type\":\"SALE\",\"status\":\"CAPTURED\",\"channel\":\"CNP\",\"capture_mode\":\"AUTO\",\"amount\":\"6000\",\"currency\":\"USD\",\"country\":\"US\",\"merchant_id\":\"MER_7e3e2c7df34f42819b3edee31022ee3f\",\"merchant_name\":\"Sandbox_merchant_3\",\"account_id\":\"TRA_c9967ad7d8ec4b46b6dd44a61cde9a91\",\"account_name\":\"transaction_processing\",\"reference\":\"pay_pgbcY6mXYI4IYk2Zt5kc_1\",\"payment_method\":{\"result\":\"00\",\"message\":\"(00)[ test system ] Authorised\",\"entry_mode\":\"ECOM\",\"card\":{\"brand\":\"VISA\",\"masked_number_last4\":\"XXXXXXXXXXXX1111\",\"authcode\":\"123456\",\"brand_reference\":\"R0LEZpZE51h4fEcD\",\"brand_time_created\":\"\",\"cvv_result\":\"MATCHED\",\"provider\":{\"result\":\"00\",\"cvv_result\":\"M\",\"avs_address_result\":\"M\",\"avs_postal_code_result\":\"M\"}}},\"risk_assessment\":[{\"mode\":\"ACTIVE\",\"result\":\"ACCEPTED\",\"rules\":[{\"reference\":\"0c93a6c9-7649-4822-b5ea-1efa356337fd\",\"description\":\"Cardholder Name Rule\",\"mode\":\"ACTIVE\",\"result\":\"ACCEPTED\"},{\"reference\":\"a539d51a-abc1-4fff-a38e-b34e00ad0cc3\",\"description\":\"CardNumber block\",\"mode\":\"ACTIVE\",\"result\":\"ACCEPTED\"},{\"reference\":\"d023a19e-6985-4fda-bb9b-5d4e0dedbb1e\",\"description\":\"Amount test\",\"mode\":\"ACTIVE\",\"result\":\"ACCEPTED\"}]}],\"batch_id\":\"BAT_1558804\",\"action\":{\"id\":\"ACT_gBpefdKHlBxfmgVgFSlfPuCQXj86TT\",\"type\":\"AUTHORIZE\",\"time_created\":\"2025-07-23T17:30:11.323Z\",\"result_code\":\"SUCCESS\",\"app_id\":\"OXKlGGm6ecZLIqMyRgPHRfMxdUAiEcp8\",\"app_name\":\"rotate_again\"}}" } ``` 3. MIT using `mandate_id` Request: ``` curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_otcCi6DyRzeDWx38OH5BTLBjBK1WS7Jt1BbsMpPepSR2Rr5dIPgVgPMoeekaqoXL' \ --header 'Cookie: PHPSESSID=0b47db9d7de94c37b6b272087a9f2fa7' \ --data '{ "amount": 6000, "currency": "USD", "capture_method": "automatic", "off_session": true, "confirm": true, "description": "Initiated by merchant", "mandate_id": "man_bRinPSQhGM8Pky90uBNb", "customer_id": "cus_LI9DQMmb1tHRjnfnkjwknjfXtonFkU" }' ``` Response: ``` { "payment_id": "pay_RI5mPEtiRZOUPPBEckqZ", "merchant_id": "merchant_1753277415", "status": "succeeded", "amount": 6000, "net_amount": 6000, "shipping_cost": null, "amount_capturable": 0, "amount_received": 6000, "connector": "globalpay", "client_secret": "pay_RI5mPEtiRZOUPPBEckqZ_secret_Aj61vZbZEdJkamRrE2EK", "created": "2025-07-23T17:30:20.230Z", "currency": "USD", "customer_id": "cus_LI9DQMmb1tHRjnfnkjwknjfXtonFkU", "customer": { "id": "cus_LI9DQMmb1tHRjnfnkjwknjfXtonFkU", "name": "John Doe", "email": "[email protected]", "phone": "999999999", "phone_country_code": "+65" }, "description": "Initiated by merchant", "refunds": null, "disputes": null, "mandate_id": "man_bRinPSQhGM8Pky90uBNb", "mandate_data": null, "setup_future_usage": null, "off_session": true, "capture_on": null, "capture_method": "automatic", "payment_method": "card", "payment_method_data": { "card": { "last4": "1111", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "411111", "card_extended_bin": null, "card_exp_month": "12", "card_exp_year": "2030", "card_holder_name": "joseph Doe", "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": "23420a93-c0ad-435f-885f-2d57c30c14d9", "shipping": null, "billing": null, "order_details": null, "email": "[email protected]", "name": "John Doe", "phone": "999999999", "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "debit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": { "customer_id": "cus_LI9DQMmb1tHRjnfnkjwknjfXtonFkU", "created_at": 1753291820, "expires": 1753295420, "secret": "epk_ceed93e4ac414b0ea6c2f454b9187067" }, "manual_retry_allowed": false, "connector_transaction_id": "TRN_VlfWAjrCer1pEZaQ7BRJsxE9tqGHnn_OUPPBEckqZ_1", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_RI5mPEtiRZOUPPBEckqZ_1", "payment_link": null, "profile_id": "pro_roCz974ra9LQxsifUris", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_5Y545k7TI4upQYSbJJ9L", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-07-23T17:45:20.230Z", "fingerprint": null, "browser_info": null, "payment_method_id": "pm_uDtgQsunDERQMrEXxbcy", "payment_method_status": "active", "updated": "2025-07-23T17:30:23.884Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": "PMT_9fd7c105-65f1-4b54-9b3f-d3f34c35100d", "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` 4. CIT using `payment_method_id` cURL: ``` curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_otcCi6DyRzeDWx38OH5BTLBjBK1WS7Jt1BbsMpPepSR2Rr5dIPgVgPMoeekaqoXL' \ --header 'Cookie: PHPSESSID=0b47db9d7de94c37b6b272087a9f2fa7' \ --data-raw '{ "amount": 1650, "currency": "USD", "connector": ["globalpay"], "confirm": true, "customer_id": "customer123ffffa", "setup_future_usage": "off_session", "payment_method_type": "debit", "payment_method": "card", "payment_method_data": { "card": { "card_number": "4111111111111111", "card_exp_month": "03", "card_exp_year": "30", "card_holder_name": "joseph Doe", "card_cvc": "737" } }, "billing": { "address": { "first_name": "joseph", "last_name": "Doe", "country": "US" } }, "email": "[email protected]", "customer_acceptance": { "acceptance_type": "offline" } }' ``` Response: ``` { "payment_id": "pay_CNM35m7O7JfdmH9qYyFq", "merchant_id": "merchant_1753277415", "status": "succeeded", "amount": 1650, "net_amount": 1650, "shipping_cost": null, "amount_capturable": 0, "amount_received": 1650, "connector": "globalpay", "client_secret": "pay_CNM35m7O7JfdmH9qYyFq_secret_uz67njQIBT8dhkSR2jcr", "created": "2025-07-23T17:29:50.150Z", "currency": "USD", "customer_id": "customer123ffffa", "customer": { "id": "customer123ffffa", "name": null, "email": "[email protected]", "phone": null, "phone_country_code": null }, "description": null, "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": "off_session", "off_session": null, "capture_on": null, "capture_method": null, "payment_method": "card", "payment_method_data": { "card": { "last4": "1111", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "411111", "card_extended_bin": null, "card_exp_month": "03", "card_exp_year": "30", "card_holder_name": "joseph Doe", "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": null, "billing": { "address": { "city": null, "country": "US", "line1": null, "line2": null, "line3": null, "zip": null, "state": null, "first_name": "joseph", "last_name": "Doe" }, "phone": null, "email": null }, "order_details": null, "email": "[email protected]", "name": null, "phone": null, "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "debit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": { "customer_id": "customer123ffffa", "created_at": 1753291790, "expires": 1753295390, "secret": "epk_b79f5365965648aea900af73ee98fc51" }, "manual_retry_allowed": false, "connector_transaction_id": "TRN_hR9reO0fbf15HP7SDBznXeKNnhvb6u_fdmH9qYyFq_1", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_CNM35m7O7JfdmH9qYyFq_1", "payment_link": null, "profile_id": "pro_roCz974ra9LQxsifUris", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_5Y545k7TI4upQYSbJJ9L", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-07-23T17:44:50.150Z", "fingerprint": null, "browser_info": null, "payment_method_id": "pm_P66KYq7rG0B7f7RENNf2", "payment_method_status": "active", "updated": "2025-07-23T17:29:53.258Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": "PMT_d6001c7b-6150-404d-92f3-56b217fb8a3d", "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` 5. MIT using `payment_method_id` cURL: ``` curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: dev_otcCi6DyRzeDWx38OH5BTLBjBK1WS7Jt1BbsMpPepSR2Rr5dIPgVgPMoeekaqoXL' \ --header 'Cookie: PHPSESSID=0b47db9d7de94c37b6b272087a9f2fa7' \ --data '{ "amount": 179, "currency": "USD", "confirm": true, "customer_id": "customer123ffffa", "recurring_details": { "type": "payment_method_id", "data": "pm_P66KYq7rG0B7f7RENNf2" }, "off_session": true }' ``` Response: ``` { "payment_id": "pay_6pONwGPfaI6X8zmyOPcS", "merchant_id": "merchant_1753277415", "status": "succeeded", "amount": 179, "net_amount": 179, "shipping_cost": null, "amount_capturable": 0, "amount_received": 179, "connector": "globalpay", "client_secret": "pay_6pONwGPfaI6X8zmyOPcS_secret_XRjvCntYf6esUICifOQg", "created": "2025-07-23T17:30:01.371Z", "currency": "USD", "customer_id": "customer123ffffa", "customer": { "id": "customer123ffffa", "name": null, "email": "[email protected]", "phone": null, "phone_country_code": null }, "description": null, "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": null, "off_session": true, "capture_on": null, "capture_method": null, "payment_method": "card", "payment_method_data": { "card": { "last4": "1111", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "411111", "card_extended_bin": null, "card_exp_month": "03", "card_exp_year": "30", "card_holder_name": "joseph Doe", "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": null, "billing": null, "order_details": null, "email": "[email protected]", "name": null, "phone": null, "return_url": null, "authentication_type": "no_three_ds", "statement_descriptor_name": null, "statement_descriptor_suffix": null, "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "debit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": { "customer_id": "customer123ffffa", "created_at": 1753291801, "expires": 1753295401, "secret": "epk_66d9de3b79db4ee3b35e9dd6db9c18e4" }, "manual_retry_allowed": false, "connector_transaction_id": "TRN_xgxrFV1PkebYZKabeA2R4qN63rqTka_6X8zmyOPcS_1", "frm_message": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_6pONwGPfaI6X8zmyOPcS_1", "payment_link": null, "profile_id": "pro_roCz974ra9LQxsifUris", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_5Y545k7TI4upQYSbJJ9L", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-07-23T17:45:01.371Z", "fingerprint": null, "browser_info": null, "payment_method_id": "pm_P66KYq7rG0B7f7RENNf2", "payment_method_status": "active", "updated": "2025-07-23T17:30:05.264Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": "PMT_d6001c7b-6150-404d-92f3-56b217fb8a3d", "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` ## Cypress test <details> <summary> Globalpay </summary> <img width="490" height="1088" alt="Screenshot 2025-07-15 at 7 31 52 PM" src="https://github.com/user-attachments/assets/fc412951-43e1-4be9-bd07-28c7980db3a4" /> </details> ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

260df2836cea8f9aa7448888d3b61e942eda313b

juspay/hyperswitch

juspay__hyperswitch-8493

Bug: [FEATURE] [CONNECTOR] Checkbook ### Feature Description Integrate a new connector : Checkbook API Ref: https://docs.checkbook.io/reference/ ### Possible Implementation Integrate a new connector : Checkbook API Ref: https://docs.checkbook.io/reference/ ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? Yes, I am willing to submit a PR!

diff --git a/config/config.example.toml b/config/config.example.toml index c781ec3705b..7d072f93e47 100644 --- a/config/config.example.toml +++ b/config/config.example.toml @@ -203,6 +203,7 @@ boku.base_url = "https://$-api4-stage.boku.com" braintree.base_url = "https://payments.sandbox.braintree-api.com/graphql" cashtocode.base_url = "https://cluster05.api-test.cashtocode.com" chargebee.base_url = "https://$.chargebee.com/api/" +checkbook.base_url = "https://api.sandbox.checkbook.io" checkout.base_url = "https://api.sandbox.checkout.com/" coinbase.base_url = "https://api.commerce.coinbase.com" coingate.base_url = "https://api-sandbox.coingate.com" @@ -344,6 +345,7 @@ cards = [ "coingate", "cryptopay", "braintree", + "checkbook", "checkout", "cybersource", "datatrans", diff --git a/config/deployments/integration_test.toml b/config/deployments/integration_test.toml index 898a84e7db0..2431f89a0ab 100644 --- a/config/deployments/integration_test.toml +++ b/config/deployments/integration_test.toml @@ -42,6 +42,7 @@ boku.base_url = "https://$-api4-stage.boku.com" braintree.base_url = "https://payments.sandbox.braintree-api.com/graphql" cashtocode.base_url = "https://cluster05.api-test.cashtocode.com" chargebee.base_url = "https://$.chargebee.com/api/" +checkbook.base_url = "https://api.sandbox.checkbook.io" checkout.base_url = "https://api.sandbox.checkout.com/" coinbase.base_url = "https://api.commerce.coinbase.com" coingate.base_url = "https://api-sandbox.coingate.com" diff --git a/config/deployments/production.toml b/config/deployments/production.toml index f08bb64136c..2f4e00d1137 100644 --- a/config/deployments/production.toml +++ b/config/deployments/production.toml @@ -46,6 +46,7 @@ boku.base_url = "https://country-api4-stage.boku.com" braintree.base_url = "https://payments.braintree-api.com/graphql" cashtocode.base_url = "https://cluster14.api.cashtocode.com" chargebee.base_url = "https://{{merchant_endpoint_prefix}}.chargebee.com/api/" +checkbook.base_url = "https://api.checkbook.io" checkout.base_url = "https://api.checkout.com/" coinbase.base_url = "https://api.commerce.coinbase.com" coingate.base_url = "https://api.coingate.com" diff --git a/config/deployments/sandbox.toml b/config/deployments/sandbox.toml index e48ddf3ff0b..b05d9d04a82 100644 --- a/config/deployments/sandbox.toml +++ b/config/deployments/sandbox.toml @@ -45,6 +45,7 @@ bluesnap.secondary_base_url = "https://sandpay.bluesnap.com/" boku.base_url = "https://$-api4-stage.boku.com" braintree.base_url = "https://payments.sandbox.braintree-api.com/graphql" cashtocode.base_url = "https://cluster05.api-test.cashtocode.com" +checkbook.base_url = "https://api.sandbox.checkbook.io" checkout.base_url = "https://api.sandbox.checkout.com/" chargebee.base_url = "https://$.chargebee.com/api/" coinbase.base_url = "https://api.commerce.coinbase.com" diff --git a/config/development.toml b/config/development.toml index d340abae6ef..84afa679d11 100644 --- a/config/development.toml +++ b/config/development.toml @@ -109,6 +109,7 @@ cards = [ "bluesnap", "boku", "braintree", + "checkbook", "checkout", "coinbase", "coingate", @@ -237,6 +238,7 @@ boku.base_url = "https://$-api4-stage.boku.com" braintree.base_url = "https://payments.sandbox.braintree-api.com/graphql" cashtocode.base_url = "https://cluster05.api-test.cashtocode.com" chargebee.base_url = "https://$.chargebee.com/api/" +checkbook.base_url = "https://api.sandbox.checkbook.io" checkout.base_url = "https://api.sandbox.checkout.com/" coinbase.base_url = "https://api.commerce.coinbase.com" coingate.base_url = "https://api-sandbox.coingate.com" diff --git a/config/docker_compose.toml b/config/docker_compose.toml index 31ecb58bb6f..80a672453ea 100644 --- a/config/docker_compose.toml +++ b/config/docker_compose.toml @@ -129,6 +129,7 @@ boku.base_url = "https://$-api4-stage.boku.com" braintree.base_url = "https://payments.sandbox.braintree-api.com/graphql" cashtocode.base_url = "https://cluster05.api-test.cashtocode.com" chargebee.base_url = "https://$.chargebee.com/api/" +checkbook.base_url = "https://api.sandbox.checkbook.io" checkout.base_url = "https://api.sandbox.checkout.com/" coinbase.base_url = "https://api.commerce.coinbase.com" coingate.base_url = "https://api-sandbox.coingate.com" @@ -258,6 +259,7 @@ cards = [ "boku", "braintree", "checkout", + "checkbook", "coinbase", "coingate", "cryptopay", diff --git a/crates/common_enums/src/connector_enums.rs b/crates/common_enums/src/connector_enums.rs index 58c627cca84..afe83a0f40f 100644 --- a/crates/common_enums/src/connector_enums.rs +++ b/crates/common_enums/src/connector_enums.rs @@ -75,6 +75,7 @@ pub enum RoutableConnectors { Braintree, Cashtocode, Chargebee, + // Checkbook, Checkout, Coinbase, Coingate, @@ -231,6 +232,7 @@ pub enum Connector { Braintree, Cashtocode, Chargebee, + // Checkbook, Checkout, Coinbase, Coingate, @@ -414,6 +416,7 @@ impl Connector { | Self::Braintree | Self::Cashtocode | Self::Chargebee + // | Self::Checkbook | Self::Coinbase | Self::Coingate | Self::Cryptopay @@ -575,6 +578,7 @@ impl From<RoutableConnectors> for Connector { RoutableConnectors::Braintree => Self::Braintree, RoutableConnectors::Cashtocode => Self::Cashtocode, RoutableConnectors::Chargebee => Self::Chargebee, + // RoutableConnectors::Checkbook => Self::Checkbook, RoutableConnectors::Checkout => Self::Checkout, RoutableConnectors::Coinbase => Self::Coinbase, RoutableConnectors::Cryptopay => Self::Cryptopay, @@ -694,6 +698,7 @@ impl TryFrom<Connector> for RoutableConnectors { Connector::Braintree => Ok(Self::Braintree), Connector::Cashtocode => Ok(Self::Cashtocode), Connector::Chargebee => Ok(Self::Chargebee), + // Connector::Checkbook => Ok(Self::Checkbook), Connector::Checkout => Ok(Self::Checkout), Connector::Coinbase => Ok(Self::Coinbase), Connector::Coingate => Ok(Self::Coingate), diff --git a/crates/connector_configs/src/connector.rs b/crates/connector_configs/src/connector.rs index 62ad0993f03..abf73e20acc 100644 --- a/crates/connector_configs/src/connector.rs +++ b/crates/connector_configs/src/connector.rs @@ -191,6 +191,7 @@ pub struct ConnectorConfig { pub braintree: Option<ConnectorTomlConfig>, pub cashtocode: Option<ConnectorTomlConfig>, pub chargebee: Option<ConnectorTomlConfig>, + pub checkbook: Option<ConnectorTomlConfig>, pub checkout: Option<ConnectorTomlConfig>, pub coinbase: Option<ConnectorTomlConfig>, pub coingate: Option<ConnectorTomlConfig>, diff --git a/crates/hyperswitch_connectors/src/connectors.rs b/crates/hyperswitch_connectors/src/connectors.rs index 9f1355a1372..55f2047a59f 100644 --- a/crates/hyperswitch_connectors/src/connectors.rs +++ b/crates/hyperswitch_connectors/src/connectors.rs @@ -16,6 +16,7 @@ pub mod boku; pub mod braintree; pub mod cashtocode; pub mod chargebee; +pub mod checkbook; pub mod checkout; pub mod coinbase; pub mod coingate; @@ -114,8 +115,8 @@ pub use self::{ amazonpay::Amazonpay, archipel::Archipel, authorizedotnet::Authorizedotnet, bambora::Bambora, bamboraapac::Bamboraapac, bankofamerica::Bankofamerica, barclaycard::Barclaycard, billwerk::Billwerk, bitpay::Bitpay, bluesnap::Bluesnap, boku::Boku, braintree::Braintree, - cashtocode::Cashtocode, chargebee::Chargebee, checkout::Checkout, coinbase::Coinbase, - coingate::Coingate, cryptopay::Cryptopay, ctp_mastercard::CtpMastercard, + cashtocode::Cashtocode, chargebee::Chargebee, checkbook::Checkbook, checkout::Checkout, + coinbase::Coinbase, coingate::Coingate, cryptopay::Cryptopay, ctp_mastercard::CtpMastercard, cybersource::Cybersource, datatrans::Datatrans, deutschebank::Deutschebank, digitalvirgo::Digitalvirgo, dlocal::Dlocal, dwolla::Dwolla, ebanx::Ebanx, elavon::Elavon, facilitapay::Facilitapay, fiserv::Fiserv, fiservemea::Fiservemea, fiuu::Fiuu, forte::Forte, diff --git a/crates/hyperswitch_connectors/src/connectors/checkbook.rs b/crates/hyperswitch_connectors/src/connectors/checkbook.rs new file mode 100644 index 00000000000..e0f31ceb57f --- /dev/null +++ b/crates/hyperswitch_connectors/src/connectors/checkbook.rs @@ -0,0 +1,571 @@ +pub mod transformers; + +use common_utils::{ + errors::CustomResult, + ext_traits::BytesExt, + request::{Method, Request, RequestBuilder, RequestContent}, + types::{AmountConvertor, FloatMajorUnit, FloatMajorUnitForConnector}, +}; +use error_stack::{report, ResultExt}; +use hyperswitch_domain_models::{ + router_data::{AccessToken, ConnectorAuthType, ErrorResponse, RouterData}, + router_flow_types::{ + access_token_auth::AccessTokenAuth, + payments::{Authorize, Capture, PSync, PaymentMethodToken, Session, SetupMandate, Void}, + refunds::{Execute, RSync}, + }, + router_request_types::{ + AccessTokenRequestData, PaymentMethodTokenizationData, PaymentsAuthorizeData, + PaymentsCancelData, PaymentsCaptureData, PaymentsSessionData, PaymentsSyncData, + RefundsData, SetupMandateRequestData, + }, + router_response_types::{PaymentsResponseData, RefundsResponseData}, + types::{ + PaymentsAuthorizeRouterData, PaymentsCaptureRouterData, PaymentsSyncRouterData, + RefundSyncRouterData, RefundsRouterData, + }, +}; +use hyperswitch_interfaces::{ + api::{ + self, ConnectorCommon, ConnectorCommonExt, ConnectorIntegration, ConnectorSpecifications, + ConnectorValidation, + }, + configs::Connectors, + errors, + events::connector_api_logs::ConnectorEvent, + types::{self, Response}, + webhooks, +}; +use masking::{ExposeInterface, Mask}; +use transformers as checkbook; + +use crate::{constants::headers, types::ResponseRouterData, utils}; + +#[derive(Clone)] +pub struct Checkbook { + amount_converter: &'static (dyn AmountConvertor<Output = FloatMajorUnit> + Sync), +} + +impl Checkbook { + pub fn new() -> &'static Self { + &Self { + amount_converter: &FloatMajorUnitForConnector, + } + } +} + +impl api::Payment for Checkbook {} +impl api::PaymentSession for Checkbook {} +impl api::ConnectorAccessToken for Checkbook {} +impl api::MandateSetup for Checkbook {} +impl api::PaymentAuthorize for Checkbook {} +impl api::PaymentSync for Checkbook {} +impl api::PaymentCapture for Checkbook {} +impl api::PaymentVoid for Checkbook {} +impl api::Refund for Checkbook {} +impl api::RefundExecute for Checkbook {} +impl api::RefundSync for Checkbook {} +impl api::PaymentToken for Checkbook {} + +impl ConnectorIntegration<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData> + for Checkbook +{ + // Not Implemented (R) +} + +impl<Flow, Request, Response> ConnectorCommonExt<Flow, Request, Response> for Checkbook +where + Self: ConnectorIntegration<Flow, Request, Response>, +{ + fn build_headers( + &self, + req: &RouterData<Flow, Request, Response>, + _connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + let mut header = vec![( + headers::CONTENT_TYPE.to_string(), + self.get_content_type().to_string().into(), + )]; + let mut api_key = self.get_auth_header(&req.connector_auth_type)?; + header.append(&mut api_key); + Ok(header) + } +} + +impl ConnectorCommon for Checkbook { + fn id(&self) -> &'static str { + "checkbook" + } + + fn get_currency_unit(&self) -> api::CurrencyUnit { + api::CurrencyUnit::Base + } + + fn common_get_content_type(&self) -> &'static str { + "application/json" + } + + fn base_url<'a>(&self, connectors: &'a Connectors) -> &'a str { + connectors.checkbook.base_url.as_ref() + } + + fn get_auth_header( + &self, + auth_type: &ConnectorAuthType, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + let auth = checkbook::CheckbookAuthType::try_from(auth_type) + .change_context(errors::ConnectorError::FailedToObtainAuthType)?; + Ok(vec![( + headers::AUTHORIZATION.to_string(), + auth.api_key.expose().into_masked(), + )]) + } + + fn build_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + let response: checkbook::CheckbookErrorResponse = res + .response + .parse_struct("CheckbookErrorResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + + Ok(ErrorResponse { + status_code: res.status_code, + code: response.code, + message: response.message, + reason: response.reason, + attempt_status: None, + connector_transaction_id: None, + network_advice_code: None, + network_decline_code: None, + network_error_message: None, + }) + } +} + +impl ConnectorValidation for Checkbook { + //TODO: implement functions when support enabled +} + +impl ConnectorIntegration<Session, PaymentsSessionData, PaymentsResponseData> for Checkbook { + //TODO: implement sessions flow +} + +impl ConnectorIntegration<AccessTokenAuth, AccessTokenRequestData, AccessToken> for Checkbook {} + +impl ConnectorIntegration<SetupMandate, SetupMandateRequestData, PaymentsResponseData> + for Checkbook +{ +} + +impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData> for Checkbook { + fn get_headers( + &self, + req: &PaymentsAuthorizeRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsAuthorizeRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn get_request_body( + &self, + req: &PaymentsAuthorizeRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let amount = utils::convert_amount( + self.amount_converter, + req.request.minor_amount, + req.request.currency, + )?; + + let connector_router_data = checkbook::CheckbookRouterData::from((amount, req)); + let connector_req = checkbook::CheckbookPaymentsRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &PaymentsAuthorizeRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::PaymentsAuthorizeType::get_url( + self, req, connectors, + )?) + .attach_default_headers() + .headers(types::PaymentsAuthorizeType::get_headers( + self, req, connectors, + )?) + .set_body(types::PaymentsAuthorizeType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsAuthorizeRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsAuthorizeRouterData, errors::ConnectorError> { + let response: checkbook::CheckbookPaymentsResponse = res + .response + .parse_struct("Checkbook PaymentsAuthorizeResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<PSync, PaymentsSyncData, PaymentsResponseData> for Checkbook { + fn get_headers( + &self, + req: &PaymentsSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsSyncRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn build_request( + &self, + req: &PaymentsSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Get) + .url(&types::PaymentsSyncType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::PaymentsSyncType::get_headers(self, req, connectors)?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsSyncRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsSyncRouterData, errors::ConnectorError> { + let response: checkbook::CheckbookPaymentsResponse = res + .response + .parse_struct("checkbook PaymentsSyncResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<Capture, PaymentsCaptureData, PaymentsResponseData> for Checkbook { + fn get_headers( + &self, + req: &PaymentsCaptureRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsCaptureRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn get_request_body( + &self, + _req: &PaymentsCaptureRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_request_body method".to_string()).into()) + } + + fn build_request( + &self, + req: &PaymentsCaptureRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::PaymentsCaptureType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::PaymentsCaptureType::get_headers( + self, req, connectors, + )?) + .set_body(types::PaymentsCaptureType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsCaptureRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsCaptureRouterData, errors::ConnectorError> { + let response: checkbook::CheckbookPaymentsResponse = res + .response + .parse_struct("Checkbook PaymentsCaptureResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<Void, PaymentsCancelData, PaymentsResponseData> for Checkbook {} + +impl ConnectorIntegration<Execute, RefundsData, RefundsResponseData> for Checkbook { + fn get_headers( + &self, + req: &RefundsRouterData<Execute>, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &RefundsRouterData<Execute>, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn get_request_body( + &self, + req: &RefundsRouterData<Execute>, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let refund_amount = utils::convert_amount( + self.amount_converter, + req.request.minor_refund_amount, + req.request.currency, + )?; + + let connector_router_data = checkbook::CheckbookRouterData::from((refund_amount, req)); + let connector_req = checkbook::CheckbookRefundRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &RefundsRouterData<Execute>, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + let request = RequestBuilder::new() + .method(Method::Post) + .url(&types::RefundExecuteType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::RefundExecuteType::get_headers( + self, req, connectors, + )?) + .set_body(types::RefundExecuteType::get_request_body( + self, req, connectors, + )?) + .build(); + Ok(Some(request)) + } + + fn handle_response( + &self, + data: &RefundsRouterData<Execute>, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<RefundsRouterData<Execute>, errors::ConnectorError> { + let response: checkbook::RefundResponse = res + .response + .parse_struct("checkbook RefundResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<RSync, RefundsData, RefundsResponseData> for Checkbook { + fn get_headers( + &self, + req: &RefundSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &RefundSyncRouterData, + _connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into()) + } + + fn build_request( + &self, + req: &RefundSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Get) + .url(&types::RefundSyncType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::RefundSyncType::get_headers(self, req, connectors)?) + .set_body(types::RefundSyncType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &RefundSyncRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<RefundSyncRouterData, errors::ConnectorError> { + let response: checkbook::RefundResponse = res + .response + .parse_struct("checkbook RefundSyncResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + router_env::logger::info!(connector_response=?response); + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +#[async_trait::async_trait] +impl webhooks::IncomingWebhook for Checkbook { + fn get_webhook_object_reference_id( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<api_models::webhooks::ObjectReferenceId, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } + + fn get_webhook_event_type( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<api_models::webhooks::IncomingWebhookEvent, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } + + fn get_webhook_resource_object( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<Box<dyn masking::ErasedMaskSerialize>, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } +} + +impl ConnectorSpecifications for Checkbook {} diff --git a/crates/hyperswitch_connectors/src/connectors/checkbook/transformers.rs b/crates/hyperswitch_connectors/src/connectors/checkbook/transformers.rs new file mode 100644 index 00000000000..d9f009f78fe --- /dev/null +++ b/crates/hyperswitch_connectors/src/connectors/checkbook/transformers.rs @@ -0,0 +1,228 @@ +use common_enums::enums; +use common_utils::types::FloatMajorUnit; +use hyperswitch_domain_models::{ + payment_method_data::PaymentMethodData, + router_data::{ConnectorAuthType, RouterData}, + router_flow_types::refunds::{Execute, RSync}, + router_request_types::ResponseId, + router_response_types::{PaymentsResponseData, RefundsResponseData}, + types::{PaymentsAuthorizeRouterData, RefundsRouterData}, +}; +use hyperswitch_interfaces::errors; +use masking::Secret; +use serde::{Deserialize, Serialize}; + +use crate::{ + types::{RefundsResponseRouterData, ResponseRouterData}, + utils::PaymentsAuthorizeRequestData, +}; + +//TODO: Fill the struct with respective fields +pub struct CheckbookRouterData<T> { + pub amount: FloatMajorUnit, // The type of amount that a connector accepts, for example, String, i64, f64, etc. + pub router_data: T, +} + +impl<T> From<(FloatMajorUnit, T)> for CheckbookRouterData<T> { + fn from((amount, item): (FloatMajorUnit, T)) -> Self { + //Todo : use utils to convert the amount to the type of amount that a connector accepts + Self { + amount, + router_data: item, + } + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Serialize, PartialEq)] +pub struct CheckbookPaymentsRequest { + amount: FloatMajorUnit, + card: CheckbookCard, +} + +#[derive(Default, Debug, Serialize, Eq, PartialEq)] +pub struct CheckbookCard { + number: cards::CardNumber, + expiry_month: Secret<String>, + expiry_year: Secret<String>, + cvc: Secret<String>, + complete: bool, +} + +impl TryFrom<&CheckbookRouterData<&PaymentsAuthorizeRouterData>> for CheckbookPaymentsRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: &CheckbookRouterData<&PaymentsAuthorizeRouterData>, + ) -> Result<Self, Self::Error> { + match item.router_data.request.payment_method_data.clone() { + PaymentMethodData::Card(req_card) => { + let card = CheckbookCard { + number: req_card.card_number, + expiry_month: req_card.card_exp_month, + expiry_year: req_card.card_exp_year, + cvc: req_card.card_cvc, + complete: item.router_data.request.is_auto_capture()?, + }; + Ok(Self { + amount: item.amount, + card, + }) + } + _ => Err(errors::ConnectorError::NotImplemented("Payment method".to_string()).into()), + } + } +} + +//TODO: Fill the struct with respective fields +// Auth Struct +pub struct CheckbookAuthType { + pub(super) api_key: Secret<String>, +} + +impl TryFrom<&ConnectorAuthType> for CheckbookAuthType { + 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)] +#[serde(rename_all = "lowercase")] +pub enum CheckbookPaymentStatus { + Succeeded, + Failed, + #[default] + Processing, +} + +impl From<CheckbookPaymentStatus> for common_enums::AttemptStatus { + fn from(item: CheckbookPaymentStatus) -> Self { + match item { + CheckbookPaymentStatus::Succeeded => Self::Charged, + CheckbookPaymentStatus::Failed => Self::Failure, + CheckbookPaymentStatus::Processing => Self::Authorizing, + } + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)] +pub struct CheckbookPaymentsResponse { + status: CheckbookPaymentStatus, + id: String, +} + +impl<F, T> TryFrom<ResponseRouterData<F, CheckbookPaymentsResponse, T, PaymentsResponseData>> + for RouterData<F, T, PaymentsResponseData> +{ + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: ResponseRouterData<F, CheckbookPaymentsResponse, T, PaymentsResponseData>, + ) -> Result<Self, Self::Error> { + Ok(Self { + status: common_enums::AttemptStatus::from(item.response.status), + response: Ok(PaymentsResponseData::TransactionResponse { + resource_id: ResponseId::ConnectorTransactionId(item.response.id), + redirection_data: Box::new(None), + mandate_reference: Box::new(None), + connector_metadata: None, + network_txn_id: None, + connector_response_reference_id: None, + incremental_authorization_allowed: None, + charges: None, + }), + ..item.data + }) + } +} + +//TODO: Fill the struct with respective fields +// REFUND : +// Type definition for RefundRequest +#[derive(Default, Debug, Serialize)] +pub struct CheckbookRefundRequest { + pub amount: FloatMajorUnit, +} + +impl<F> TryFrom<&CheckbookRouterData<&RefundsRouterData<F>>> for CheckbookRefundRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from(item: &CheckbookRouterData<&RefundsRouterData<F>>) -> Result<Self, Self::Error> { + Ok(Self { + amount: item.amount.to_owned(), + }) + } +} + +// Type definition for Refund Response + +#[allow(dead_code)] +#[derive(Debug, Serialize, Default, Deserialize, Clone)] +pub enum RefundStatus { + Succeeded, + Failed, + #[default] + Processing, +} + +impl From<RefundStatus> for enums::RefundStatus { + fn from(item: RefundStatus) -> Self { + match item { + RefundStatus::Succeeded => Self::Success, + RefundStatus::Failed => Self::Failure, + RefundStatus::Processing => Self::Pending, + //TODO: Review mapping + } + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Clone, Serialize, Deserialize)] +pub struct RefundResponse { + id: String, + status: RefundStatus, +} + +impl TryFrom<RefundsResponseRouterData<Execute, RefundResponse>> for RefundsRouterData<Execute> { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: RefundsResponseRouterData<Execute, RefundResponse>, + ) -> Result<Self, Self::Error> { + Ok(Self { + response: Ok(RefundsResponseData { + connector_refund_id: item.response.id.to_string(), + refund_status: enums::RefundStatus::from(item.response.status), + }), + ..item.data + }) + } +} + +impl TryFrom<RefundsResponseRouterData<RSync, RefundResponse>> for RefundsRouterData<RSync> { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: RefundsResponseRouterData<RSync, RefundResponse>, + ) -> Result<Self, Self::Error> { + Ok(Self { + response: Ok(RefundsResponseData { + connector_refund_id: item.response.id.to_string(), + refund_status: enums::RefundStatus::from(item.response.status), + }), + ..item.data + }) + } +} + +//TODO: Fill the struct with respective fields +#[derive(Default, Debug, Serialize, Deserialize, PartialEq)] +pub struct CheckbookErrorResponse { + pub status_code: u16, + pub code: String, + pub message: String, + pub reason: Option<String>, +} diff --git a/crates/hyperswitch_connectors/src/default_implementations.rs b/crates/hyperswitch_connectors/src/default_implementations.rs index 6717a25d2ac..54c5d81edd9 100644 --- a/crates/hyperswitch_connectors/src/default_implementations.rs +++ b/crates/hyperswitch_connectors/src/default_implementations.rs @@ -160,6 +160,7 @@ default_imp_for_authorize_session_token!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -282,6 +283,7 @@ default_imp_for_calculate_tax!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -405,6 +407,7 @@ default_imp_for_session_update!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -528,6 +531,7 @@ default_imp_for_post_session_tokens!( connectors::Billwerk, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -650,6 +654,7 @@ default_imp_for_create_order!( connectors::Billwerk, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -773,6 +778,7 @@ default_imp_for_update_metadata!( connectors::Billwerk, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -894,6 +900,7 @@ default_imp_for_complete_authorize!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1002,6 +1009,7 @@ default_imp_for_incremental_authorization!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1125,6 +1133,7 @@ default_imp_for_create_customer!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1242,6 +1251,7 @@ default_imp_for_connector_redirect_response!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, @@ -1348,6 +1358,7 @@ default_imp_for_pre_processing_steps!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1462,6 +1473,7 @@ default_imp_for_post_processing_steps!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1586,6 +1598,7 @@ default_imp_for_approve!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1711,6 +1724,7 @@ default_imp_for_reject!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1836,6 +1850,7 @@ default_imp_for_webhook_source_verification!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1960,6 +1975,7 @@ default_imp_for_accept_dispute!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, @@ -2083,6 +2099,7 @@ default_imp_for_submit_evidence!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, @@ -2205,6 +2222,7 @@ default_imp_for_defend_dispute!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, @@ -2337,6 +2355,7 @@ default_imp_for_file_upload!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, @@ -2451,6 +2470,7 @@ default_imp_for_payouts!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Cryptopay, connectors::Datatrans, @@ -2569,6 +2589,7 @@ default_imp_for_payouts_create!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -2691,6 +2712,7 @@ default_imp_for_payouts_retrieve!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -2815,6 +2837,7 @@ default_imp_for_payouts_eligibility!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -2937,6 +2960,7 @@ default_imp_for_payouts_fulfill!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -3056,6 +3080,7 @@ default_imp_for_payouts_cancel!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -3179,6 +3204,7 @@ default_imp_for_payouts_quote!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -3303,6 +3329,7 @@ default_imp_for_payouts_recipient!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -3426,6 +3453,7 @@ default_imp_for_payouts_recipient_account!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -3551,6 +3579,7 @@ default_imp_for_frm_sale!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -3676,6 +3705,7 @@ default_imp_for_frm_checkout!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -3801,6 +3831,7 @@ default_imp_for_frm_transaction!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -3926,6 +3957,7 @@ default_imp_for_frm_fulfillment!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -4051,6 +4083,7 @@ default_imp_for_frm_record_return!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -4172,6 +4205,7 @@ default_imp_for_revoking_mandates!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -4293,6 +4327,7 @@ default_imp_for_uas_pre_authentication!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -4415,6 +4450,7 @@ default_imp_for_uas_post_authentication!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -4538,6 +4574,7 @@ default_imp_for_uas_authentication_confirmation!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -4653,6 +4690,7 @@ default_imp_for_connector_request_id!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -4770,6 +4808,7 @@ default_imp_for_fraud_check!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -4917,6 +4956,7 @@ default_imp_for_connector_authentication!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -5037,6 +5077,7 @@ default_imp_for_uas_authentication!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -5151,8 +5192,9 @@ default_imp_for_revenue_recovery!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, - connectors::Checkout, connectors::Chargebee, + connectors::Checkbook, + connectors::Checkout, connectors::Coinbase, connectors::Coingate, connectors::Cryptopay, @@ -5278,6 +5320,7 @@ default_imp_for_billing_connector_payment_sync!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -5402,6 +5445,7 @@ default_imp_for_revenue_recovery_record_back!( connectors::Braintree, connectors::Boku, connectors::Cashtocode, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -5526,6 +5570,7 @@ default_imp_for_billing_connector_invoice_sync!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -5644,6 +5689,7 @@ default_imp_for_external_vault!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -5768,6 +5814,7 @@ default_imp_for_external_vault_insert!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -5892,6 +5939,7 @@ default_imp_for_external_vault_retrieve!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -6016,6 +6064,7 @@ default_imp_for_external_vault_delete!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -6140,6 +6189,7 @@ default_imp_for_external_vault_create!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, diff --git a/crates/hyperswitch_connectors/src/default_implementations_v2.rs b/crates/hyperswitch_connectors/src/default_implementations_v2.rs index 0121aa1d951..27c13c9d6be 100644 --- a/crates/hyperswitch_connectors/src/default_implementations_v2.rs +++ b/crates/hyperswitch_connectors/src/default_implementations_v2.rs @@ -265,6 +265,7 @@ default_imp_for_new_connector_integration_payment!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -390,6 +391,7 @@ default_imp_for_new_connector_integration_refund!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -510,6 +512,7 @@ default_imp_for_new_connector_integration_connector_access_token!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -636,6 +639,7 @@ default_imp_for_new_connector_integration_accept_dispute!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -760,6 +764,7 @@ default_imp_for_new_connector_integration_submit_evidence!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -884,6 +889,7 @@ default_imp_for_new_connector_integration_defend_dispute!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1019,6 +1025,7 @@ default_imp_for_new_connector_integration_file_upload!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1146,6 +1153,7 @@ default_imp_for_new_connector_integration_payouts_create!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1273,6 +1281,7 @@ default_imp_for_new_connector_integration_payouts_eligibility!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1400,6 +1409,7 @@ default_imp_for_new_connector_integration_payouts_fulfill!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1527,6 +1537,7 @@ default_imp_for_new_connector_integration_payouts_cancel!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1654,6 +1665,7 @@ default_imp_for_new_connector_integration_payouts_quote!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1781,6 +1793,7 @@ default_imp_for_new_connector_integration_payouts_recipient!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -1908,6 +1921,7 @@ default_imp_for_new_connector_integration_payouts_sync!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -2035,6 +2049,7 @@ default_imp_for_new_connector_integration_payouts_recipient_account!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -2160,6 +2175,7 @@ default_imp_for_new_connector_integration_webhook_source_verification!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -2287,6 +2303,7 @@ default_imp_for_new_connector_integration_frm_sale!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -2414,6 +2431,7 @@ default_imp_for_new_connector_integration_frm_checkout!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -2541,6 +2559,7 @@ default_imp_for_new_connector_integration_frm_transaction!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -2668,6 +2687,7 @@ default_imp_for_new_connector_integration_frm_fulfillment!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -2795,6 +2815,7 @@ default_imp_for_new_connector_integration_frm_record_return!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -2919,6 +2940,7 @@ default_imp_for_new_connector_integration_revoking_mandates!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, @@ -3030,6 +3052,7 @@ default_imp_for_new_connector_integration_frm!( connectors::Bluesnap, connectors::Boku, connectors::Cashtocode, + connectors::Checkbook, connectors::Coinbase, connectors::Cryptopay, connectors::CtpMastercard, @@ -3154,6 +3177,7 @@ default_imp_for_new_connector_integration_connector_authentication!( connectors::Bluesnap, connectors::Boku, connectors::Cashtocode, + connectors::Checkbook, connectors::Coinbase, connectors::Cryptopay, connectors::CtpMastercard, @@ -3267,6 +3291,7 @@ default_imp_for_new_connector_integration_revenue_recovery!( connectors::Bluesnap, connectors::Boku, connectors::Cashtocode, + connectors::Checkbook, connectors::Coinbase, connectors::Cryptopay, connectors::CtpMastercard, @@ -3397,6 +3422,7 @@ default_imp_for_new_connector_integration_external_vault!( connectors::Boku, connectors::Cashtocode, connectors::Chargebee, + connectors::Checkbook, connectors::Checkout, connectors::Coinbase, connectors::Coingate, diff --git a/crates/hyperswitch_domain_models/src/configs.rs b/crates/hyperswitch_domain_models/src/configs.rs index ab84cf26aa4..f15ea290f56 100644 --- a/crates/hyperswitch_domain_models/src/configs.rs +++ b/crates/hyperswitch_domain_models/src/configs.rs @@ -30,6 +30,7 @@ pub struct Connectors { pub braintree: ConnectorParams, pub cashtocode: ConnectorParams, pub chargebee: ConnectorParams, + pub checkbook: ConnectorParams, pub checkout: ConnectorParams, pub coinbase: ConnectorParams, pub coingate: ConnectorParams, diff --git a/crates/router/src/connector.rs b/crates/router/src/connector.rs index de9eb4f3923..af2d9a52352 100644 --- a/crates/router/src/connector.rs +++ b/crates/router/src/connector.rs @@ -9,30 +9,31 @@ pub use hyperswitch_connectors::connectors::{ bamboraapac::Bamboraapac, bankofamerica, bankofamerica::Bankofamerica, barclaycard, barclaycard::Barclaycard, billwerk, billwerk::Billwerk, bitpay, bitpay::Bitpay, bluesnap, bluesnap::Bluesnap, boku, boku::Boku, braintree, braintree::Braintree, cashtocode, - cashtocode::Cashtocode, chargebee, chargebee::Chargebee, checkout, checkout::Checkout, - coinbase, coinbase::Coinbase, coingate, coingate::Coingate, cryptopay, cryptopay::Cryptopay, - ctp_mastercard, ctp_mastercard::CtpMastercard, cybersource, cybersource::Cybersource, - datatrans, datatrans::Datatrans, deutschebank, deutschebank::Deutschebank, digitalvirgo, - digitalvirgo::Digitalvirgo, dlocal, dlocal::Dlocal, dwolla, dwolla::Dwolla, ebanx, - ebanx::Ebanx, elavon, elavon::Elavon, facilitapay, facilitapay::Facilitapay, fiserv, - fiserv::Fiserv, fiservemea, fiservemea::Fiservemea, fiuu, fiuu::Fiuu, forte, forte::Forte, - getnet, getnet::Getnet, globalpay, globalpay::Globalpay, globepay, globepay::Globepay, - gocardless, gocardless::Gocardless, gpayments, gpayments::Gpayments, helcim, helcim::Helcim, - hipay, hipay::Hipay, hyperswitch_vault, hyperswitch_vault::HyperswitchVault, iatapay, - iatapay::Iatapay, inespay, inespay::Inespay, itaubank, itaubank::Itaubank, jpmorgan, - jpmorgan::Jpmorgan, juspaythreedsserver, juspaythreedsserver::Juspaythreedsserver, klarna, - klarna::Klarna, mifinity, mifinity::Mifinity, mollie, mollie::Mollie, moneris, - moneris::Moneris, multisafepay, multisafepay::Multisafepay, netcetera, netcetera::Netcetera, - nexinets, nexinets::Nexinets, nexixpay, nexixpay::Nexixpay, nmi, nmi::Nmi, nomupay, - nomupay::Nomupay, noon, noon::Noon, nordea, nordea::Nordea, novalnet, novalnet::Novalnet, - nuvei, nuvei::Nuvei, opayo, opayo::Opayo, opennode, opennode::Opennode, paybox, paybox::Paybox, - payeezy, payeezy::Payeezy, payme, payme::Payme, payone, payone::Payone, paypal, paypal::Paypal, - paystack, paystack::Paystack, payu, payu::Payu, placetopay, placetopay::Placetopay, plaid, - plaid::Plaid, powertranz, powertranz::Powertranz, prophetpay, prophetpay::Prophetpay, rapyd, - rapyd::Rapyd, razorpay, razorpay::Razorpay, recurly, recurly::Recurly, redsys, redsys::Redsys, - riskified, riskified::Riskified, santander, santander::Santander, shift4, shift4::Shift4, - signifyd, signifyd::Signifyd, square, square::Square, stax, stax::Stax, stripe, stripe::Stripe, - stripebilling, stripebilling::Stripebilling, taxjar, taxjar::Taxjar, threedsecureio, + cashtocode::Cashtocode, chargebee, chargebee::Chargebee, checkbook, checkbook::Checkbook, + checkout, checkout::Checkout, coinbase, coinbase::Coinbase, coingate, coingate::Coingate, + cryptopay, cryptopay::Cryptopay, ctp_mastercard, ctp_mastercard::CtpMastercard, cybersource, + cybersource::Cybersource, datatrans, datatrans::Datatrans, deutschebank, + deutschebank::Deutschebank, digitalvirgo, digitalvirgo::Digitalvirgo, dlocal, dlocal::Dlocal, + dwolla, dwolla::Dwolla, ebanx, ebanx::Ebanx, elavon, elavon::Elavon, facilitapay, + facilitapay::Facilitapay, fiserv, fiserv::Fiserv, fiservemea, fiservemea::Fiservemea, fiuu, + fiuu::Fiuu, forte, forte::Forte, getnet, getnet::Getnet, globalpay, globalpay::Globalpay, + globepay, globepay::Globepay, gocardless, gocardless::Gocardless, gpayments, + gpayments::Gpayments, helcim, helcim::Helcim, hipay, hipay::Hipay, hyperswitch_vault, + hyperswitch_vault::HyperswitchVault, iatapay, iatapay::Iatapay, inespay, inespay::Inespay, + itaubank, itaubank::Itaubank, jpmorgan, jpmorgan::Jpmorgan, juspaythreedsserver, + juspaythreedsserver::Juspaythreedsserver, klarna, klarna::Klarna, mifinity, mifinity::Mifinity, + mollie, mollie::Mollie, moneris, moneris::Moneris, multisafepay, multisafepay::Multisafepay, + netcetera, netcetera::Netcetera, nexinets, nexinets::Nexinets, nexixpay, nexixpay::Nexixpay, + nmi, nmi::Nmi, nomupay, nomupay::Nomupay, noon, noon::Noon, nordea, nordea::Nordea, novalnet, + novalnet::Novalnet, nuvei, nuvei::Nuvei, opayo, opayo::Opayo, opennode, opennode::Opennode, + paybox, paybox::Paybox, payeezy, payeezy::Payeezy, payme, payme::Payme, payone, payone::Payone, + paypal, paypal::Paypal, paystack, paystack::Paystack, payu, payu::Payu, placetopay, + placetopay::Placetopay, plaid, plaid::Plaid, powertranz, powertranz::Powertranz, prophetpay, + prophetpay::Prophetpay, rapyd, rapyd::Rapyd, razorpay, razorpay::Razorpay, recurly, + recurly::Recurly, redsys, redsys::Redsys, riskified, riskified::Riskified, santander, + santander::Santander, shift4, shift4::Shift4, signifyd, signifyd::Signifyd, square, + square::Square, stax, stax::Stax, stripe, stripe::Stripe, stripebilling, + stripebilling::Stripebilling, taxjar, taxjar::Taxjar, threedsecureio, threedsecureio::Threedsecureio, thunes, thunes::Thunes, tokenio, tokenio::Tokenio, trustpay, trustpay::Trustpay, tsys, tsys::Tsys, unified_authentication_service, unified_authentication_service::UnifiedAuthenticationService, vgs, vgs::Vgs, volt, volt::Volt, diff --git a/crates/router/src/core/admin.rs b/crates/router/src/core/admin.rs index eeb4557daf3..6763bd029b2 100644 --- a/crates/router/src/core/admin.rs +++ b/crates/router/src/core/admin.rs @@ -1456,6 +1456,10 @@ impl ConnectorAuthTypeAndMetadataValidation<'_> { chargebee::transformers::ChargebeeMetadata::try_from(self.connector_meta_data)?; Ok(()) } + // api_enums::Connector::Checkbook => { + // checkbook::transformers::CheckbookAuthType::try_from(self.auth_type)?; + // Ok(()) + // }, api_enums::Connector::Checkout => { checkout::transformers::CheckoutAuthType::try_from(self.auth_type)?; Ok(()) diff --git a/crates/router/src/types/api.rs b/crates/router/src/types/api.rs index e189a0f1a43..f40520a42e7 100644 --- a/crates/router/src/types/api.rs +++ b/crates/router/src/types/api.rs @@ -378,6 +378,9 @@ impl ConnectorData { enums::Connector::Chargebee => { Ok(ConnectorEnum::Old(Box::new(connector::Chargebee::new()))) } + // enums::Connector::Checkbook => { + // Ok(ConnectorEnum::Old(Box::new(connector::Checkbook))) + // } enums::Connector::Checkout => { Ok(ConnectorEnum::Old(Box::new(connector::Checkout::new()))) } diff --git a/crates/router/src/types/transformers.rs b/crates/router/src/types/transformers.rs index ad3d4de7f94..82ca2f7ae67 100644 --- a/crates/router/src/types/transformers.rs +++ b/crates/router/src/types/transformers.rs @@ -224,6 +224,7 @@ impl ForeignTryFrom<api_enums::Connector> for common_enums::RoutableConnectors { api_enums::Connector::Braintree => Self::Braintree, api_enums::Connector::Cashtocode => Self::Cashtocode, api_enums::Connector::Chargebee => Self::Chargebee, + // api_enums::Connector::Checkbook => Self::Checkbook, api_enums::Connector::Checkout => Self::Checkout, api_enums::Connector::Coinbase => Self::Coinbase, api_enums::Connector::Coingate => Self::Coingate, diff --git a/crates/router/tests/connectors/checkbook.rs b/crates/router/tests/connectors/checkbook.rs new file mode 100644 index 00000000000..b6b4252f852 --- /dev/null +++ b/crates/router/tests/connectors/checkbook.rs @@ -0,0 +1,420 @@ +use masking::Secret; +use router::types::{self, api, domain, storage::enums}; +use test_utils::connector_auth; + +use crate::utils::{self, ConnectorActions}; + +#[derive(Clone, Copy)] +struct CheckbookTest; +impl ConnectorActions for CheckbookTest {} +impl utils::Connector for CheckbookTest { + fn get_data(&self) -> api::ConnectorData { + use router::connector::Checkbook; + utils::construct_connector_data_old( + Box::new(Checkbook::new()), + types::Connector::DummyConnector1, + api::GetToken::Connector, + None, + ) + } + + fn get_auth_token(&self) -> types::ConnectorAuthType { + utils::to_connector_auth_type( + connector_auth::ConnectorAuthentication::new() + .checkbook + .expect("Missing connector authentication configuration") + .into(), + ) + } + + fn get_name(&self) -> String { + "checkbook".to_string() + } +} + +static CONNECTOR: CheckbookTest = CheckbookTest {}; + +fn get_default_payment_info() -> Option<utils::PaymentInfo> { + None +} + +fn payment_method_details() -> Option<types::PaymentsAuthorizeData> { + None +} + +// Cards Positive Tests +// Creates a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_only_authorize_payment() { + let response = CONNECTOR + .authorize_payment(payment_method_details(), get_default_payment_info()) + .await + .expect("Authorize payment response"); + assert_eq!(response.status, enums::AttemptStatus::Authorized); +} + +// Captures a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_capture_authorized_payment() { + let response = CONNECTOR + .authorize_and_capture_payment(payment_method_details(), None, get_default_payment_info()) + .await + .expect("Capture payment response"); + assert_eq!(response.status, enums::AttemptStatus::Charged); +} + +// Partially captures a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_capture_authorized_payment() { + let response = CONNECTOR + .authorize_and_capture_payment( + payment_method_details(), + Some(types::PaymentsCaptureData { + amount_to_capture: 50, + ..utils::PaymentCaptureType::default().0 + }), + get_default_payment_info(), + ) + .await + .expect("Capture payment response"); + assert_eq!(response.status, enums::AttemptStatus::Charged); +} + +// Synchronizes a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_authorized_payment() { + let authorize_response = CONNECTOR + .authorize_payment(payment_method_details(), get_default_payment_info()) + .await + .expect("Authorize payment response"); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + let response = CONNECTOR + .psync_retry_till_status_matches( + enums::AttemptStatus::Authorized, + Some(types::PaymentsSyncData { + connector_transaction_id: types::ResponseId::ConnectorTransactionId( + txn_id.unwrap(), + ), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .expect("PSync response"); + assert_eq!(response.status, enums::AttemptStatus::Authorized,); +} + +// Voids a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_void_authorized_payment() { + let response = CONNECTOR + .authorize_and_void_payment( + payment_method_details(), + Some(types::PaymentsCancelData { + connector_transaction_id: String::from(""), + cancellation_reason: Some("requested_by_customer".to_string()), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .expect("Void payment response"); + assert_eq!(response.status, enums::AttemptStatus::Voided); +} + +// Refunds a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_manually_captured_payment() { + let response = CONNECTOR + .capture_payment_and_refund( + payment_method_details(), + None, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Partially refunds a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_refund_manually_captured_payment() { + let response = CONNECTOR + .capture_payment_and_refund( + payment_method_details(), + None, + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Synchronizes a refund using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_manually_captured_refund() { + let refund_response = CONNECTOR + .capture_payment_and_refund( + payment_method_details(), + None, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + let response = CONNECTOR + .rsync_retry_till_status_matches( + enums::RefundStatus::Success, + refund_response.response.unwrap().connector_refund_id, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Creates a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_make_payment() { + let authorize_response = CONNECTOR + .make_payment(payment_method_details(), get_default_payment_info()) + .await + .unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); +} + +// Synchronizes a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_auto_captured_payment() { + let authorize_response = CONNECTOR + .make_payment(payment_method_details(), get_default_payment_info()) + .await + .unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + assert_ne!(txn_id, None, "Empty connector transaction id"); + let response = CONNECTOR + .psync_retry_till_status_matches( + enums::AttemptStatus::Charged, + Some(types::PaymentsSyncData { + connector_transaction_id: types::ResponseId::ConnectorTransactionId( + txn_id.unwrap(), + ), + capture_method: Some(enums::CaptureMethod::Automatic), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!(response.status, enums::AttemptStatus::Charged,); +} + +// Refunds a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_auto_captured_payment() { + let response = CONNECTOR + .make_payment_and_refund(payment_method_details(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Partially refunds a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_refund_succeeded_payment() { + let refund_response = CONNECTOR + .make_payment_and_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + refund_response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Creates multiple refunds against a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_succeeded_payment_multiple_times() { + CONNECTOR + .make_payment_and_multiple_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await; +} + +// Synchronizes a refund using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_refund() { + let refund_response = CONNECTOR + .make_payment_and_refund(payment_method_details(), None, get_default_payment_info()) + .await + .unwrap(); + let response = CONNECTOR + .rsync_retry_till_status_matches( + enums::RefundStatus::Success, + refund_response.response.unwrap().connector_refund_id, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Cards Negative scenarios +// Creates a payment with incorrect CVC. +#[actix_web::test] +async fn should_fail_payment_for_incorrect_cvc() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: domain::PaymentMethodData::Card(domain::Card { + card_cvc: Secret::new("12345".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's security code is invalid.".to_string(), + ); +} + +// Creates a payment with incorrect expiry month. +#[actix_web::test] +async fn should_fail_payment_for_invalid_exp_month() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: domain::PaymentMethodData::Card(domain::Card { + card_exp_month: Secret::new("20".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's expiration month is invalid.".to_string(), + ); +} + +// Creates a payment with incorrect expiry year. +#[actix_web::test] +async fn should_fail_payment_for_incorrect_expiry_year() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: domain::PaymentMethodData::Card(domain::Card { + card_exp_year: Secret::new("2000".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's expiration year is invalid.".to_string(), + ); +} + +// Voids a payment using automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_fail_void_payment_for_auto_capture() { + let authorize_response = CONNECTOR + .make_payment(payment_method_details(), get_default_payment_info()) + .await + .unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + assert_ne!(txn_id, None, "Empty connector transaction id"); + let void_response = CONNECTOR + .void_payment(txn_id.unwrap(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + void_response.response.unwrap_err().message, + "You cannot cancel this PaymentIntent because it has a status of succeeded." + ); +} + +// Captures a payment using invalid connector payment id. +#[actix_web::test] +async fn should_fail_capture_for_invalid_payment() { + let capture_response = CONNECTOR + .capture_payment("123456789".to_string(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + capture_response.response.unwrap_err().message, + String::from("No such payment_intent: '123456789'") + ); +} + +// Refunds a payment with refund amount higher than payment amount. +#[actix_web::test] +async fn should_fail_for_refund_amount_higher_than_payment_amount() { + let response = CONNECTOR + .make_payment_and_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 150, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Refund amount (₹1.50) is greater than charge amount (₹1.00)", + ); +} + +// Connector dependent test cases goes here + +// [#478]: add unit tests for non 3DS, wallets & webhooks in connector tests diff --git a/crates/router/tests/connectors/main.rs b/crates/router/tests/connectors/main.rs index fced1b6bff3..8005e84652b 100644 --- a/crates/router/tests/connectors/main.rs +++ b/crates/router/tests/connectors/main.rs @@ -24,6 +24,7 @@ mod bluesnap; mod boku; mod cashtocode; mod chargebee; +mod checkbook; mod checkout; mod coinbase; mod cryptopay; diff --git a/crates/router/tests/connectors/sample_auth.toml b/crates/router/tests/connectors/sample_auth.toml index 354959856bf..25c63908448 100644 --- a/crates/router/tests/connectors/sample_auth.toml +++ b/crates/router/tests/connectors/sample_auth.toml @@ -341,6 +341,10 @@ api_key = "MyApiKey" key1 = "Merchant id" api_secret = "Secret key" +[checkbook] +api_key="Client ID" +key1 ="Client Secret" + [santander] api_key="Client ID" key1 ="Client Secret" diff --git a/crates/test_utils/src/connector_auth.rs b/crates/test_utils/src/connector_auth.rs index 17d442315c6..c92d4aa8591 100644 --- a/crates/test_utils/src/connector_auth.rs +++ b/crates/test_utils/src/connector_auth.rs @@ -30,6 +30,7 @@ pub struct ConnectorAuthentication { pub boku: Option<BodyKey>, pub cashtocode: Option<BodyKey>, pub chargebee: Option<HeaderKey>, + pub checkbook: Option<BodyKey>, pub checkout: Option<SignatureKey>, pub coinbase: Option<HeaderKey>, pub coingate: Option<HeaderKey>, diff --git a/loadtest/config/development.toml b/loadtest/config/development.toml index 4fade351226..102daf94c6a 100644 --- a/loadtest/config/development.toml +++ b/loadtest/config/development.toml @@ -96,6 +96,7 @@ boku.base_url = "https://country-api4-stage.boku.com" braintree.base_url = "https://payments.sandbox.braintree-api.com/graphql" cashtocode.base_url = "https://cluster05.api-test.cashtocode.com" chargebee.base_url = "https://$.chargebee.com/api/" +checkbook.base_url = "https://api.sandbox.checkbook.io" checkout.base_url = "https://api.sandbox.checkout.com/" coinbase.base_url = "https://api.commerce.coinbase.com" coingate.base_url = "https://api-sandbox.coingate.com" @@ -223,6 +224,7 @@ cards = [ "bluesnap", "boku", "braintree", + "checkbook", "checkout", "coinbase", "coingate", diff --git a/scripts/add_connector.sh b/scripts/add_connector.sh index a8fbbb15af8..a76e9beacf9 100755 --- a/scripts/add_connector.sh +++ b/scripts/add_connector.sh @@ -6,7 +6,7 @@ function find_prev_connector() { git checkout $self cp $self $self.tmp # Add new connector to existing list and sort it - connectors=(aci adyen adyenplatform airwallex amazonpay applepay archipel authorizedotnet bambora bamboraapac bankofamerica barclaycard billwerk bitpay bluesnap boku braintree cashtocode chargebee checkout coinbase cryptopay ctp_visa cybersource datatrans deutschebank digitalvirgo dlocal dummyconnector dwolla ebanx elavon facilitapay fiserv fiservemea fiuu forte getnet globalpay globepay gocardless gpayments helcim hipay hyperswitch_vault iatapay inespay itaubank jpmorgan juspaythreedsserver klarna mifinity mollie moneris multisafepay netcetera nexinets nexixpay nomupay noon nordea novalnet nuvei opayo opennode paybox payeezy payme payone paypal paystack payu placetopay plaid powertranz prophetpay rapyd razorpay recurly redsys santander shift4 square stax stripe stripebilling taxjar threedsecureio thunes tokenio trustpay tsys unified_authentication_service vgs volt wellsfargo wellsfargopayout wise worldline worldpay worldpayvantiv worldpayxml xendit zsl "$1") + connectors=(aci adyen adyenplatform airwallex amazonpay applepay archipel authorizedotnet bambora bamboraapac bankofamerica barclaycard billwerk bitpay bluesnap boku braintree cashtocode chargebee checkbook checkout coinbase cryptopay ctp_visa cybersource datatrans deutschebank digitalvirgo dlocal dummyconnector dwolla ebanx elavon facilitapay fiserv fiservemea fiuu forte getnet globalpay globepay gocardless gpayments helcim hipay hyperswitch_vault iatapay inespay itaubank jpmorgan juspaythreedsserver klarna mifinity mollie moneris multisafepay netcetera nexinets nexixpay nomupay noon nordea novalnet nuvei opayo opennode paybox payeezy payme payone paypal paystack payu placetopay plaid powertranz prophetpay rapyd razorpay recurly redsys santander shift4 square stax stripe stripebilling taxjar threedsecureio thunes tokenio trustpay tsys unified_authentication_service vgs volt wellsfargo wellsfargopayout wise worldline worldpay worldpayvantiv worldpayxml xendit zsl "$1") IFS=$'\n' sorted=($(sort <<<"${connectors[*]}")); unset IFS res="$(echo ${sorted[@]})" sed -i'' -e "s/^ connectors=.*/ connectors=($res \"\$1\")/" $self.tmp

2025-06-30T09:30:05Z

## Type of Change  - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD Closes this [issue](https://github.com/juspay/hyperswitch/issues/8493) ## Description  Added template code for [Checkbook](https://docs.checkbook.io/reference/) ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  ## How did you test it?  No tests required ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.114.0

28d63575e63d87b1cba7c6215faee803f2fff7d8

juspay/hyperswitch

juspay__hyperswitch-8462

Bug: chore: bump tonic version bumping tonic version from 0.12 to 0.13.1

diff --git a/Cargo.lock b/Cargo.lock index 42add100ade..b578a5ff88f 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1186,14 +1186,14 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "3a6c9af12842a67734c9a2e355436e5d03b22383ed60cf13cd0c18fbfe3dcbcf" dependencies = [ "async-trait", - "axum-core", + "axum-core 0.4.3", "bytes 1.10.1", "futures-util", "http 1.3.1", "http-body 1.0.1", "http-body-util", "itoa", - "matchit", + "matchit 0.7.3", "memchr", "mime", "percent-encoding", @@ -1201,7 +1201,33 @@ dependencies = [ "rustversion", "serde", "sync_wrapper 1.0.1", - "tower", + "tower 0.4.13", + "tower-layer", + "tower-service", +] + +[[package]] +name = "axum" +version = "0.8.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "021e862c184ae977658b36c4500f7feac3221ca5da43e3f25bd04ab6c79a29b5" +dependencies = [ + "axum-core 0.5.2", + "bytes 1.10.1", + "futures-util", + "http 1.3.1", + "http-body 1.0.1", + "http-body-util", + "itoa", + "matchit 0.8.4", + "memchr", + "mime", + "percent-encoding", + "pin-project-lite", + "rustversion", + "serde", + "sync_wrapper 1.0.1", + "tower 0.5.2", "tower-layer", "tower-service", ] @@ -1226,6 +1252,25 @@ dependencies = [ "tower-service", ] +[[package]] +name = "axum-core" +version = "0.5.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "68464cd0412f486726fb3373129ef5d2993f90c34bc2bc1c1e9943b2f4fc7ca6" +dependencies = [ + "bytes 1.10.1", + "futures-core", + "http 1.3.1", + "http-body 1.0.1", + "http-body-util", + "mime", + "pin-project-lite", + "rustversion", + "sync_wrapper 1.0.1", + "tower-layer", + "tower-service", +] + [[package]] name = "backtrace" version = "0.3.74" @@ -2969,7 +3014,7 @@ dependencies = [ "serde", "thiserror 1.0.69", "tokio 1.45.1", - "tonic", + "tonic 0.13.1", "tonic-build", "tonic-reflection", "tonic-types", @@ -4704,6 +4749,12 @@ version = "0.7.3" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "0e7465ac9959cc2b1404e8e2367b43684a6d13790fe23056cc8c6c5a6b7bcb94" +[[package]] +name = "matchit" +version = "0.8.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "47e1ffaa40ddd1f3ed91f717a33c8c0ee23fff369e3aa8772b9605cc1d22f4c3" + [[package]] name = "maud" version = "0.26.0" @@ -5337,7 +5388,7 @@ dependencies = [ "prost", "thiserror 1.0.69", "tokio 1.45.1", - "tonic", + "tonic 0.12.3", ] [[package]] @@ -5349,7 +5400,7 @@ dependencies = [ "opentelemetry", "opentelemetry_sdk", "prost", - "tonic", + "tonic 0.12.3", ] [[package]] @@ -5951,8 +6002,8 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "f8650aabb6c35b860610e9cff5dc1af886c9e25073b7b1712a68972af4281302" dependencies = [ "bytes 1.10.1", - "heck 0.4.1", - "itertools 0.10.5", + "heck 0.5.0", + "itertools 0.13.0", "log", "multimap", "once_cell", @@ -5972,7 +6023,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "acf0c195eebb4af52c752bec4f52f645da98b6e92077a04110c7f349477ae5ac" dependencies = [ "anyhow", - "itertools 0.10.5", + "itertools 0.13.0", "proc-macro2", "quote", "syn 2.0.101", @@ -8796,7 +8847,7 @@ checksum = "877c5b330756d856ffcc4553ab34a5684481ade925ecc54bcd1bf02b1d0d4d52" dependencies = [ "async-stream", "async-trait", - "axum", + "axum 0.7.5", "base64 0.22.1", "bytes 1.10.1", "h2 0.4.8", @@ -8812,7 +8863,36 @@ dependencies = [ "socket2", "tokio 1.45.1", "tokio-stream", - "tower", + "tower 0.4.13", + "tower-layer", + "tower-service", + "tracing", +] + +[[package]] +name = "tonic" +version = "0.13.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7e581ba15a835f4d9ea06c55ab1bd4dce26fc53752c69a04aac00703bfb49ba9" +dependencies = [ + "async-trait", + "axum 0.8.4", + "base64 0.22.1", + "bytes 1.10.1", + "h2 0.4.8", + "http 1.3.1", + "http-body 1.0.1", + "http-body-util", + "hyper 1.6.0", + "hyper-timeout", + "hyper-util", + "percent-encoding", + "pin-project", + "prost", + "socket2", + "tokio 1.45.1", + "tokio-stream", + "tower 0.5.2", "tower-layer", "tower-service", "tracing", @@ -8820,39 +8900,40 @@ dependencies = [ [[package]] name = "tonic-build" -version = "0.12.2" +version = "0.13.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "fe4ee8877250136bd7e3d2331632810a4df4ea5e004656990d8d66d2f5ee8a67" +checksum = "eac6f67be712d12f0b41328db3137e0d0757645d8904b4cb7d51cd9c2279e847" dependencies = [ "prettyplease", "proc-macro2", "prost-build", + "prost-types", "quote", "syn 2.0.101", ] [[package]] name = "tonic-reflection" -version = "0.12.3" +version = "0.13.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "878d81f52e7fcfd80026b7fdb6a9b578b3c3653ba987f87f0dce4b64043cba27" +checksum = "f9687bd5bfeafebdded2356950f278bba8226f0b32109537c4253406e09aafe1" dependencies = [ "prost", "prost-types", "tokio 1.45.1", "tokio-stream", - "tonic", + "tonic 0.13.1", ] [[package]] name = "tonic-types" -version = "0.12.3" +version = "0.13.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0081d8ee0847d01271392a5aebe960a4600f5d4da6c67648a6382a0940f8b367" +checksum = "07439468da24d5f211d3f3bd7b63665d8f45072804457e838a87414a478e2db8" dependencies = [ "prost", "prost-types", - "tonic", + "tonic 0.13.1", ] [[package]] @@ -8891,6 +8972,25 @@ dependencies = [ "tracing", ] +[[package]] +name = "tower" +version = "0.5.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d039ad9159c98b70ecfd540b2573b97f7f52c3e8d9f8ad57a24b916a536975f9" +dependencies = [ + "futures-core", + "futures-util", + "indexmap 2.9.0", + "pin-project-lite", + "slab", + "sync_wrapper 1.0.1", + "tokio 1.45.1", + "tokio-util", + "tower-layer", + "tower-service", + "tracing", +] + [[package]] name = "tower-layer" version = "0.3.3" @@ -9057,7 +9157,7 @@ version = "1.6.3" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "97fee6b57c6a41524a810daee9286c02d7752c4253064d0b05472833a438f675" dependencies = [ - "cfg-if 0.1.10", + "cfg-if 1.0.0", "static_assertions", ] @@ -9610,7 +9710,7 @@ version = "0.1.9" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "cf221c93e13a30d793f7645a0e7762c55d169dbb0a49671918a2319d289b10bb" dependencies = [ - "windows-sys 0.48.0", + "windows-sys 0.59.0", ] [[package]] diff --git a/crates/external_services/Cargo.toml b/crates/external_services/Cargo.toml index 34aca99f399..4002e117c62 100644 --- a/crates/external_services/Cargo.toml +++ b/crates/external_services/Cargo.toml @@ -48,9 +48,9 @@ thiserror = "1.0.69" vaultrs = { version = "0.7.4", optional = true } prost = { version = "0.13", optional = true } tokio = "1.45.1" -tonic = { version = "0.12.3", optional = true } -tonic-reflection = { version = "0.12.3", optional = true } -tonic-types = { version = "0.12.3", optional = true } +tonic = { version = "0.13.1", optional = true } +tonic-reflection = { version = "0.13.1", optional = true } +tonic-types = { version = "0.13.1", optional = true } hyper-util = { version = "0.1.12", optional = true } http-body-util = { version = "0.1.3", optional = true } reqwest = { version = "0.11.27", features = ["rustls-tls"] } @@ -71,7 +71,7 @@ api_models = { version = "0.1.0", path = "../api_models", optional = true } [build-dependencies] -tonic-build = { version = "0.12", optional = true } +tonic-build = { version = "0.13.1", optional = true } router_env = { version = "0.1.0", path = "../router_env", default-features = false, optional = true } [lints] diff --git a/crates/external_services/build.rs b/crates/external_services/build.rs index 8dba0bb3e98..c9d9017560b 100644 --- a/crates/external_services/build.rs +++ b/crates/external_services/build.rs @@ -14,7 +14,7 @@ fn main() -> Result<(), Box<dyn std::error::Error>> { // Compile the .proto file tonic_build::configure() .out_dir(out_dir) - .compile( + .compile_protos( &[ success_rate_proto_file, health_check_proto_file, diff --git a/crates/external_services/src/grpc_client.rs b/crates/external_services/src/grpc_client.rs index 7a627d3ab27..45b98c51154 100644 --- a/crates/external_services/src/grpc_client.rs +++ b/crates/external_services/src/grpc_client.rs @@ -13,20 +13,16 @@ use dynamic_routing::{DynamicRoutingClientConfig, RoutingStrategy}; #[cfg(feature = "dynamic_routing")] use health_check_client::HealthCheckClient; #[cfg(feature = "dynamic_routing")] -use http_body_util::combinators::UnsyncBoxBody; -#[cfg(feature = "dynamic_routing")] -use hyper::body::Bytes; -#[cfg(feature = "dynamic_routing")] use hyper_util::client::legacy::connect::HttpConnector; #[cfg(feature = "dynamic_routing")] use router_env::logger; use serde; #[cfg(feature = "dynamic_routing")] -use tonic::Status; +use tonic::body::Body; #[cfg(feature = "dynamic_routing")] /// Hyper based Client type for maintaining connection pool for all gRPC services -pub type Client = hyper_util::client::legacy::Client<HttpConnector, UnsyncBoxBody<Bytes, Status>>; +pub type Client = hyper_util::client::legacy::Client<HttpConnector, Body>; /// Struct contains all the gRPC Clients #[derive(Debug, Clone)]

2025-06-25T12:29:54Z

## Type of Change  - [ ] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description bumping tonic version from 0.12 to 0.13 ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  ## How did you test it? - The client connection was success <img width="1725" alt="Screenshot 2025-06-25 at 6 00 12 PM" src="https://github.com/user-attachments/assets/7981c4cc-041e-4426-a158-d66af2d1e2cd" /> - got response for the health check api ``` { "database": true, "redis": true, "analytics": true, "opensearch": false, "outgoing_request": true, "grpc_health_check": { "dynamic_routing_service": true }, "decision_engine": false } ``` ## Checklist  - [ ] I formatted the code `cargo +nightly fmt --all` - [ ] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.114.0

0a06ad91252d76d0c937344d8c76c9a2bbbc84d7

juspay/hyperswitch

juspay__hyperswitch-8464

Bug: [FEATURE] allow data migration at profile level ### Feature Description The `migrate_payment_methods` API is used for migrating customer and payment method data. Currently, it operates at the merchant level, but since the `merchant_connector_id` is tied to a specific profile, migrations are limited to a single profile at a time. This feature aims to enhance the data migration process to support multiple profiles. The goal is to allow a single payment method to be migrated across several `merchant_connector_id`s, enabling data migration at the profile level. ### Implementation Plan Below are the the changes: **Customer Data Migration:** * Update `PaymentMethodRecord` to allow `merchant_connector_id` and `connector_customer_id` to accept comma-separated strings. * Update `PaymentMethodCustomerMigrate` to handle a list of connector customer details. * The `From` implementation for `PaymentMethodCustomerMigrate` will be updated to parse these new comma-separated strings. * Finally, update the `create_customer` function to handle the list of connector details, allowing a customer to be associated with multiple connector accounts. **Payment Method Migration:** * Update `PaymentMethodsMigrateForm` to accept a comma-separated string for `merchant_connector_id`. * The functions `get_payment_method_records` and `migrate_payment_methods` will be updated to handle this change. * The `TryFrom` implementation for `PaymentMethodMigrate` will be modified to create a `PaymentsMandateReference` for each `merchant_connector_id` in the comma-separated string. All changes will be backward-compatible. ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? Yes, I am willing to submit a PR!

diff --git a/crates/api_models/src/payment_methods.rs b/crates/api_models/src/payment_methods.rs index c681cf7edd0..b3e76e37291 100644 --- a/crates/api_models/src/payment_methods.rs +++ b/crates/api_models/src/payment_methods.rs @@ -19,7 +19,7 @@ use utoipa::{schema, ToSchema}; #[cfg(feature = "payouts")] use crate::payouts; use crate::{ - admin, customers, enums as api_enums, + admin, enums as api_enums, payments::{self, BankCodeResponse}, }; @@ -2517,6 +2517,7 @@ pub struct PaymentMethodRecord { pub billing_address_line3: Option<masking::Secret<String>>, pub raw_card_number: Option<masking::Secret<String>>, pub merchant_connector_id: Option<id_type::MerchantConnectorAccountId>, + pub merchant_connector_ids: Option<String>, pub original_transaction_amount: Option<i64>, pub original_transaction_currency: Option<common_enums::Currency>, pub line_number: Option<i64>, @@ -2526,18 +2527,6 @@ pub struct PaymentMethodRecord { pub network_token_requestor_ref_id: Option<String>, } -#[derive(Debug, Clone, serde::Deserialize, serde::Serialize)] -pub struct ConnectorCustomerDetails { - pub connector_customer_id: String, - pub merchant_connector_id: id_type::MerchantConnectorAccountId, -} - -#[derive(Debug, Clone, serde::Deserialize, serde::Serialize)] -pub struct PaymentMethodCustomerMigrate { - pub customer: customers::CustomerRequest, - pub connector_customer_details: Option<ConnectorCustomerDetails>, -} - #[derive(Debug, Default, serde::Serialize)] pub struct PaymentMethodMigrationResponse { pub line_number: Option<i64>, @@ -2654,47 +2643,56 @@ impl From<PaymentMethodMigrationResponseType> for PaymentMethodMigrationResponse impl TryFrom<( - PaymentMethodRecord, + &PaymentMethodRecord, id_type::MerchantId, - Option<id_type::MerchantConnectorAccountId>, + Option<&Vec<id_type::MerchantConnectorAccountId>>, )> for PaymentMethodMigrate { type Error = error_stack::Report<errors::ValidationError>; + fn try_from( item: ( - PaymentMethodRecord, + &PaymentMethodRecord, id_type::MerchantId, - Option<id_type::MerchantConnectorAccountId>, + Option<&Vec<id_type::MerchantConnectorAccountId>>, ), ) -> Result<Self, Self::Error> { - let (record, merchant_id, mca_id) = item; + let (record, merchant_id, mca_ids) = item; let billing = record.create_billing(); - - // if payment instrument id is present then only construct this - let connector_mandate_details = if record.payment_instrument_id.is_some() { - Some(PaymentsMandateReference(HashMap::from([( - mca_id.get_required_value("merchant_connector_id")?, - PaymentsMandateReferenceRecord { - connector_mandate_id: record - .payment_instrument_id - .get_required_value("payment_instrument_id")? - .peek() - .to_string(), - payment_method_type: record.payment_method_type, - original_payment_authorized_amount: record.original_transaction_amount, - original_payment_authorized_currency: record.original_transaction_currency, - }, - )]))) + let connector_mandate_details = if let Some(payment_instrument_id) = + &record.payment_instrument_id + { + let ids = mca_ids.get_required_value("mca_ids")?; + let mandate_map: HashMap<_, _> = ids + .iter() + .map(|mca_id| { + ( + mca_id.clone(), + PaymentsMandateReferenceRecord { + connector_mandate_id: payment_instrument_id.peek().to_string(), + payment_method_type: record.payment_method_type, + original_payment_authorized_amount: record.original_transaction_amount, + original_payment_authorized_currency: record + .original_transaction_currency, + }, + ) + }) + .collect(); + Some(PaymentsMandateReference(mandate_map)) } else { None }; + Ok(Self { merchant_id, - customer_id: Some(record.customer_id), + customer_id: Some(record.customer_id.clone()), card: Some(MigrateCardDetail { - card_number: record.raw_card_number.unwrap_or(record.card_number_masked), - card_exp_month: record.card_expiry_month, - card_exp_year: record.card_expiry_year, + card_number: record + .raw_card_number + .clone() + .unwrap_or_else(|| record.card_number_masked.clone()), + card_exp_month: record.card_expiry_month.clone(), + card_exp_year: record.card_expiry_year.clone(), card_holder_name: record.name.clone(), card_network: None, card_type: None, @@ -2704,10 +2702,16 @@ impl }), network_token: Some(MigrateNetworkTokenDetail { network_token_data: MigrateNetworkTokenData { - network_token_number: record.network_token_number.unwrap_or_default(), - network_token_exp_month: record.network_token_expiry_month.unwrap_or_default(), - network_token_exp_year: record.network_token_expiry_year.unwrap_or_default(), - card_holder_name: record.name, + network_token_number: record.network_token_number.clone().unwrap_or_default(), + network_token_exp_month: record + .network_token_expiry_month + .clone() + .unwrap_or_default(), + network_token_exp_year: record + .network_token_expiry_year + .clone() + .unwrap_or_default(), + card_holder_name: record.name.clone(), nick_name: record.nick_name.clone(), card_issuing_country: None, card_network: None, @@ -2716,6 +2720,7 @@ impl }, network_token_requestor_ref_id: record .network_token_requestor_ref_id + .clone() .unwrap_or_default(), }), payment_method: record.payment_method, @@ -2740,45 +2745,6 @@ impl } } -#[cfg(feature = "v1")] -impl From<(PaymentMethodRecord, id_type::MerchantId)> for PaymentMethodCustomerMigrate { - fn from(value: (PaymentMethodRecord, id_type::MerchantId)) -> Self { - let (record, merchant_id) = value; - Self { - customer: customers::CustomerRequest { - customer_id: Some(record.customer_id), - merchant_id, - name: record.name, - email: record.email, - phone: record.phone, - description: None, - phone_country_code: record.phone_country_code, - address: Some(payments::AddressDetails { - city: record.billing_address_city, - country: record.billing_address_country, - line1: record.billing_address_line1, - line2: record.billing_address_line2, - state: record.billing_address_state, - line3: record.billing_address_line3, - zip: record.billing_address_zip, - first_name: record.billing_address_first_name, - last_name: record.billing_address_last_name, - }), - metadata: None, - }, - connector_customer_details: record - .connector_customer_id - .zip(record.merchant_connector_id) - .map( - |(connector_customer_id, merchant_connector_id)| ConnectorCustomerDetails { - connector_customer_id, - merchant_connector_id, - }, - ), - } - } -} - #[derive(Debug, serde::Deserialize, serde::Serialize, ToSchema)] pub struct CardNetworkTokenizeRequest { /// Merchant ID associated with the tokenization request diff --git a/crates/hyperswitch_domain_models/src/lib.rs b/crates/hyperswitch_domain_models/src/lib.rs index 4ee8620e35e..35570036c20 100644 --- a/crates/hyperswitch_domain_models/src/lib.rs +++ b/crates/hyperswitch_domain_models/src/lib.rs @@ -36,6 +36,7 @@ pub mod router_response_types; pub mod routing; #[cfg(feature = "tokenization_v2")] pub mod tokenization; +pub mod transformers; pub mod type_encryption; pub mod types; pub mod vault; diff --git a/crates/hyperswitch_domain_models/src/payment_methods.rs b/crates/hyperswitch_domain_models/src/payment_methods.rs index 0f6d4d6f924..aa01465408e 100644 --- a/crates/hyperswitch_domain_models/src/payment_methods.rs +++ b/crates/hyperswitch_domain_models/src/payment_methods.rs @@ -1,5 +1,6 @@ #[cfg(feature = "v2")] use api_models::payment_methods::PaymentMethodsData; +use api_models::{customers, payment_methods, payments}; // specific imports because of using the macro use common_enums::enums::MerchantStorageScheme; #[cfg(feature = "v1")] @@ -27,11 +28,12 @@ use time::PrimitiveDateTime; #[cfg(feature = "v2")] use crate::address::Address; #[cfg(feature = "v1")] -use crate::{mandates, type_encryption::AsyncLift}; +use crate::type_encryption::AsyncLift; use crate::{ - mandates::CommonMandateReference, + mandates::{self, CommonMandateReference}, merchant_key_store::MerchantKeyStore, payment_method_data as domain_payment_method_data, + transformers::ForeignTryFrom, type_encryption::{crypto_operation, CryptoOperation}, }; @@ -87,7 +89,6 @@ pub struct PaymentMethod { pub network_token_locker_id: Option<String>, pub network_token_payment_method_data: OptionalEncryptableValue, } - #[cfg(feature = "v2")] #[derive(Clone, Debug, router_derive::ToEncryption)] pub struct PaymentMethod { @@ -915,6 +916,136 @@ pub struct PaymentMethodsSessionUpdateInternal { pub tokenization_data: Option<pii::SecretSerdeValue>, } +#[derive(Debug, Clone, serde::Deserialize, serde::Serialize)] +pub struct ConnectorCustomerDetails { + pub connector_customer_id: String, + pub merchant_connector_id: id_type::MerchantConnectorAccountId, +} + +#[derive(Debug, Clone, serde::Deserialize, serde::Serialize)] +pub struct PaymentMethodCustomerMigrate { + pub customer: customers::CustomerRequest, + pub connector_customer_details: Option<Vec<ConnectorCustomerDetails>>, +} + +#[cfg(feature = "v1")] +impl TryFrom<(payment_methods::PaymentMethodRecord, id_type::MerchantId)> + for PaymentMethodCustomerMigrate +{ + type Error = error_stack::Report<ValidationError>; + fn try_from( + value: (payment_methods::PaymentMethodRecord, id_type::MerchantId), + ) -> Result<Self, Self::Error> { + let (record, merchant_id) = value; + let connector_customer_details = record + .connector_customer_id + .and_then(|connector_customer_id| { + // Handle single merchant_connector_id + record + .merchant_connector_id + .as_ref() + .map(|merchant_connector_id| { + Ok(vec![ConnectorCustomerDetails { + connector_customer_id: connector_customer_id.clone(), + merchant_connector_id: merchant_connector_id.clone(), + }]) + }) + // Handle comma-separated merchant_connector_ids + .or_else(|| { + record + .merchant_connector_ids + .as_ref() + .map(|merchant_connector_ids_str| { + merchant_connector_ids_str + .split(',') + .map(|id| id.trim()) + .filter(|id| !id.is_empty()) + .map(|merchant_connector_id| { + id_type::MerchantConnectorAccountId::wrap( + merchant_connector_id.to_string(), + ) + .map_err(|_| { + error_stack::report!(ValidationError::InvalidValue { + message: format!( + "Invalid merchant_connector_account_id: {}", + merchant_connector_id + ), + }) + }) + .map( + |merchant_connector_id| ConnectorCustomerDetails { + connector_customer_id: connector_customer_id + .clone(), + merchant_connector_id, + }, + ) + }) + .collect::<Result<Vec<_>, _>>() + }) + }) + }) + .transpose()?; + + Ok(Self { + customer: customers::CustomerRequest { + customer_id: Some(record.customer_id), + merchant_id, + name: record.name, + email: record.email, + phone: record.phone, + description: None, + phone_country_code: record.phone_country_code, + address: Some(payments::AddressDetails { + city: record.billing_address_city, + country: record.billing_address_country, + line1: record.billing_address_line1, + line2: record.billing_address_line2, + state: record.billing_address_state, + line3: record.billing_address_line3, + zip: record.billing_address_zip, + first_name: record.billing_address_first_name, + last_name: record.billing_address_last_name, + }), + metadata: None, + }, + connector_customer_details, + }) + } +} + +#[cfg(feature = "v1")] +impl ForeignTryFrom<(&[payment_methods::PaymentMethodRecord], id_type::MerchantId)> + for Vec<PaymentMethodCustomerMigrate> +{ + type Error = error_stack::Report<ValidationError>; + + fn foreign_try_from( + (records, merchant_id): (&[payment_methods::PaymentMethodRecord], id_type::MerchantId), + ) -> Result<Self, Self::Error> { + let (customers_migration, migration_errors): (Self, Vec<_>) = records + .iter() + .map(|record| { + PaymentMethodCustomerMigrate::try_from((record.clone(), merchant_id.clone())) + }) + .fold((Self::new(), Vec::new()), |mut acc, result| { + match result { + Ok(customer) => acc.0.push(customer), + Err(e) => acc.1.push(e.to_string()), + } + acc + }); + + migration_errors + .is_empty() + .then_some(customers_migration) + .ok_or_else(|| { + error_stack::report!(ValidationError::InvalidValue { + message: migration_errors.join(", "), + }) + }) + } +} + #[cfg(feature = "v1")] #[cfg(test)] mod tests { diff --git a/crates/hyperswitch_domain_models/src/transformers.rs b/crates/hyperswitch_domain_models/src/transformers.rs new file mode 100644 index 00000000000..1208d80c323 --- /dev/null +++ b/crates/hyperswitch_domain_models/src/transformers.rs @@ -0,0 +1,9 @@ +pub trait ForeignFrom<F> { + fn foreign_from(from: F) -> Self; +} + +pub trait ForeignTryFrom<F>: Sized { + type Error; + + fn foreign_try_from(from: F) -> Result<Self, Self::Error>; +} diff --git a/crates/payment_methods/src/core/migration.rs b/crates/payment_methods/src/core/migration.rs index 8b2694cf6fe..6b7ce30b4c5 100644 --- a/crates/payment_methods/src/core/migration.rs +++ b/crates/payment_methods/src/core/migration.rs @@ -24,20 +24,22 @@ pub async fn migrate_payment_methods( payment_methods: Vec<pm_api::PaymentMethodRecord>, merchant_id: &common_utils::id_type::MerchantId, merchant_context: &merchant_context::MerchantContext, - mca_id: Option<common_utils::id_type::MerchantConnectorAccountId>, + mca_ids: Option<Vec<common_utils::id_type::MerchantConnectorAccountId>>, controller: &dyn pm::PaymentMethodsController, ) -> PmMigrationResult<Vec<pm_api::PaymentMethodMigrationResponse>> { - let mut result = Vec::new(); + let mut result = Vec::with_capacity(payment_methods.len()); + for record in payment_methods { let req = pm_api::PaymentMethodMigrate::try_from(( - record.clone(), + &record, merchant_id.clone(), - mca_id.clone(), + mca_ids.as_ref(), )) .map_err(|err| errors::ApiErrorResponse::InvalidRequestData { message: format!("error: {:?}", err), }) .attach_printable("record deserialization failed"); + let res = match req { Ok(migrate_request) => { let res = migrate_payment_method( @@ -56,6 +58,7 @@ pub async fn migrate_payment_methods( } Err(e) => Err(e.to_string()), }; + result.push(pm_api::PaymentMethodMigrationResponse::from((res, record))); } Ok(api::ApplicationResponse::Json(result)) @@ -69,7 +72,138 @@ pub struct PaymentMethodsMigrateForm { pub merchant_id: text::Text<common_utils::id_type::MerchantId>, pub merchant_connector_id: - text::Text<Option<common_utils::id_type::MerchantConnectorAccountId>>, + Option<text::Text<common_utils::id_type::MerchantConnectorAccountId>>, + + pub merchant_connector_ids: Option<text::Text<String>>, +} + +struct MerchantConnectorValidator; + +impl MerchantConnectorValidator { + fn parse_comma_separated_ids( + ids_string: &str, + ) -> Result<Vec<common_utils::id_type::MerchantConnectorAccountId>, errors::ApiErrorResponse> + { + // Estimate capacity based on comma count + let capacity = ids_string.matches(',').count() + 1; + let mut result = Vec::with_capacity(capacity); + + for id in ids_string.split(',') { + let trimmed_id = id.trim(); + if !trimmed_id.is_empty() { + let mca_id = + common_utils::id_type::MerchantConnectorAccountId::wrap(trimmed_id.to_string()) + .map_err(|_| errors::ApiErrorResponse::InvalidRequestData { + message: format!( + "Invalid merchant_connector_account_id: {}", + trimmed_id + ), + })?; + result.push(mca_id); + } + } + + Ok(result) + } + + fn validate_form_csv_conflicts( + records: &[pm_api::PaymentMethodRecord], + form_has_single_id: bool, + form_has_multiple_ids: bool, + ) -> Result<(), errors::ApiErrorResponse> { + if form_has_single_id { + // If form has merchant_connector_id, CSV records should not have merchant_connector_ids + for (index, record) in records.iter().enumerate() { + if record.merchant_connector_ids.is_some() { + return Err(errors::ApiErrorResponse::InvalidRequestData { + message: format!( + "Record at line {} has merchant_connector_ids but form has merchant_connector_id. Only one should be provided", + index + 1 + ), + }); + } + } + } + + if form_has_multiple_ids { + // If form has merchant_connector_ids, CSV records should not have merchant_connector_id + for (index, record) in records.iter().enumerate() { + if record.merchant_connector_id.is_some() { + return Err(errors::ApiErrorResponse::InvalidRequestData { + message: format!( + "Record at line {} has merchant_connector_id but form has merchant_connector_ids. Only one should be provided", + index + 1 + ), + }); + } + } + } + + Ok(()) + } +} + +type MigrationValidationResult = Result< + ( + common_utils::id_type::MerchantId, + Vec<pm_api::PaymentMethodRecord>, + Option<Vec<common_utils::id_type::MerchantConnectorAccountId>>, + ), + errors::ApiErrorResponse, +>; + +impl PaymentMethodsMigrateForm { + pub fn validate_and_get_payment_method_records(self) -> MigrationValidationResult { + // Step 1: Validate form-level conflicts + let form_has_single_id = self.merchant_connector_id.is_some(); + let form_has_multiple_ids = self.merchant_connector_ids.is_some(); + + if form_has_single_id && form_has_multiple_ids { + return Err(errors::ApiErrorResponse::InvalidRequestData { + message: "Both merchant_connector_id and merchant_connector_ids cannot be provided" + .to_string(), + }); + } + + // Ensure at least one is provided + if !form_has_single_id && !form_has_multiple_ids { + return Err(errors::ApiErrorResponse::InvalidRequestData { + message: "Either merchant_connector_id or merchant_connector_ids must be provided" + .to_string(), + }); + } + + // Step 2: Parse CSV + let records = parse_csv(self.file.data.to_bytes()).map_err(|e| { + errors::ApiErrorResponse::PreconditionFailed { + message: e.to_string(), + } + })?; + + // Step 3: Validate CSV vs Form conflicts + MerchantConnectorValidator::validate_form_csv_conflicts( + &records, + form_has_single_id, + form_has_multiple_ids, + )?; + + // Step 4: Prepare the merchant connector account IDs for return + let mca_ids = if let Some(ref single_id) = self.merchant_connector_id { + Some(vec![(**single_id).clone()]) + } else if let Some(ref ids_string) = self.merchant_connector_ids { + let parsed_ids = MerchantConnectorValidator::parse_comma_separated_ids(ids_string)?; + if parsed_ids.is_empty() { + None + } else { + Some(parsed_ids) + } + } else { + None + }; + + // Step 5: Return the updated structure + Ok((self.merchant_id.clone(), records, mca_ids)) + } } fn parse_csv(data: &[u8]) -> csv::Result<Vec<pm_api::PaymentMethodRecord>> { @@ -84,27 +218,6 @@ fn parse_csv(data: &[u8]) -> csv::Result<Vec<pm_api::PaymentMethodRecord>> { } Ok(records) } -pub fn get_payment_method_records( - form: PaymentMethodsMigrateForm, -) -> Result< - ( - common_utils::id_type::MerchantId, - Vec<pm_api::PaymentMethodRecord>, - Option<common_utils::id_type::MerchantConnectorAccountId>, - ), - errors::ApiErrorResponse, -> { - match parse_csv(form.file.data.to_bytes()) { - Ok(records) => { - let merchant_id = form.merchant_id.clone(); - let mca_id = form.merchant_connector_id.clone(); - Ok((merchant_id.clone(), records, mca_id)) - } - Err(e) => Err(errors::ApiErrorResponse::PreconditionFailed { - message: e.to_string(), - }), - } -} #[instrument(skip_all)] pub fn validate_card_expiry( diff --git a/crates/router/src/core/customers.rs b/crates/router/src/core/customers.rs index 2cad1d91eb8..43dbf28c0e0 100644 --- a/crates/router/src/core/customers.rs +++ b/crates/router/src/core/customers.rs @@ -9,6 +9,7 @@ use common_utils::{ }, }; use error_stack::{report, ResultExt}; +use hyperswitch_domain_models::payment_methods as payment_methods_domain; use masking::{ExposeInterface, Secret, SwitchStrategy}; use payment_methods::controller::PaymentMethodsController; use router_env::{instrument, tracing}; @@ -27,7 +28,7 @@ use crate::{ routes::{metrics, SessionState}, services, types::{ - api::{customers, payment_methods as payment_methods_api}, + api::customers, domain::{self, types}, storage::{self, enums}, transformers::ForeignFrom, @@ -41,7 +42,7 @@ pub async fn create_customer( state: SessionState, merchant_context: domain::MerchantContext, customer_data: customers::CustomerRequest, - connector_customer_details: Option<payment_methods_api::ConnectorCustomerDetails>, + connector_customer_details: Option<Vec<payment_methods_domain::ConnectorCustomerDetails>>, ) -> errors::CustomerResponse<customers::CustomerResponse> { let db: &dyn StorageInterface = state.store.as_ref(); let key_manager_state = &(&state).into(); @@ -96,7 +97,9 @@ pub async fn create_customer( trait CustomerCreateBridge { async fn create_domain_model_from_request<'a>( &'a self, - connector_customer_details: &'a Option<payment_methods_api::ConnectorCustomerDetails>, + connector_customer_details: &'a Option< + Vec<payment_methods_domain::ConnectorCustomerDetails>, + >, db: &'a dyn StorageInterface, merchant_reference_id: &'a Option<id_type::CustomerId>, merchant_context: &'a domain::MerchantContext, @@ -115,7 +118,9 @@ trait CustomerCreateBridge { impl CustomerCreateBridge for customers::CustomerRequest { async fn create_domain_model_from_request<'a>( &'a self, - connector_customer_details: &'a Option<payment_methods_api::ConnectorCustomerDetails>, + connector_customer_details: &'a Option< + Vec<payment_methods_domain::ConnectorCustomerDetails>, + >, db: &'a dyn StorageInterface, merchant_reference_id: &'a Option<id_type::CustomerId>, merchant_context: &'a domain::MerchantContext, @@ -175,13 +180,15 @@ impl CustomerCreateBridge for customers::CustomerRequest { domain::FromRequestEncryptableCustomer::from_encryptable(encrypted_data) .change_context(errors::CustomersErrorResponse::InternalServerError)?; - let connector_customer = connector_customer_details.as_ref().map(|details| { - let merchant_connector_id = details.merchant_connector_id.get_string_repr().to_string(); - let connector_customer_id = details.connector_customer_id.to_string(); - let object = serde_json::json!({ - merchant_connector_id: connector_customer_id - }); - pii::SecretSerdeValue::new(object) + let connector_customer = connector_customer_details.as_ref().map(|details_vec| { + let mut map = serde_json::Map::new(); + for details in details_vec { + let merchant_connector_id = + details.merchant_connector_id.get_string_repr().to_string(); + let connector_customer_id = details.connector_customer_id.clone(); + map.insert(merchant_connector_id, connector_customer_id.into()); + } + pii::SecretSerdeValue::new(serde_json::Value::Object(map)) }); Ok(domain::Customer { @@ -227,7 +234,9 @@ impl CustomerCreateBridge for customers::CustomerRequest { impl CustomerCreateBridge for customers::CustomerRequest { async fn create_domain_model_from_request<'a>( &'a self, - connector_customer_details: &'a Option<payment_methods_api::ConnectorCustomerDetails>, + connector_customer_details: &'a Option< + Vec<payment_methods_domain::ConnectorCustomerDetails>, + >, _db: &'a dyn StorageInterface, merchant_reference_id: &'a Option<id_type::CustomerId>, merchant_context: &'a domain::MerchantContext, @@ -297,12 +306,16 @@ impl CustomerCreateBridge for customers::CustomerRequest { domain::FromRequestEncryptableCustomer::from_encryptable(encrypted_data) .change_context(errors::CustomersErrorResponse::InternalServerError)?; - let connector_customer = connector_customer_details.as_ref().map(|details| { - let mut map = std::collections::HashMap::new(); - map.insert( - details.merchant_connector_id.clone(), - details.connector_customer_id.to_string(), - ); + let connector_customer = connector_customer_details.as_ref().map(|details_vec| { + let map: std::collections::HashMap<_, _> = details_vec + .iter() + .map(|details| { + ( + details.merchant_connector_id.clone(), + details.connector_customer_id.to_string(), + ) + }) + .collect(); common_types::customers::ConnectorCustomerMap::new(map) }); @@ -1060,7 +1073,9 @@ pub async fn update_customer( trait CustomerUpdateBridge { async fn create_domain_model_from_request<'a>( &'a self, - connector_customer_details: &'a Option<payment_methods_api::ConnectorCustomerDetails>, + connector_customer_details: &'a Option< + Vec<payment_methods_domain::ConnectorCustomerDetails>, + >, db: &'a dyn StorageInterface, merchant_context: &'a domain::MerchantContext, key_manager_state: &'a KeyManagerState, @@ -1232,7 +1247,9 @@ impl VerifyIdForUpdateCustomer<'_> { impl CustomerUpdateBridge for customers::CustomerUpdateRequest { async fn create_domain_model_from_request<'a>( &'a self, - _connector_customer_details: &'a Option<payment_methods_api::ConnectorCustomerDetails>, + _connector_customer_details: &'a Option< + Vec<payment_methods_domain::ConnectorCustomerDetails>, + >, db: &'a dyn StorageInterface, merchant_context: &'a domain::MerchantContext, key_manager_state: &'a KeyManagerState, @@ -1337,7 +1354,9 @@ impl CustomerUpdateBridge for customers::CustomerUpdateRequest { impl CustomerUpdateBridge for customers::CustomerUpdateRequest { async fn create_domain_model_from_request<'a>( &'a self, - connector_customer_details: &'a Option<payment_methods_api::ConnectorCustomerDetails>, + connector_customer_details: &'a Option< + Vec<payment_methods_domain::ConnectorCustomerDetails>, + >, db: &'a dyn StorageInterface, merchant_context: &'a domain::MerchantContext, key_manager_state: &'a KeyManagerState, @@ -1454,7 +1473,7 @@ impl CustomerUpdateBridge for customers::CustomerUpdateRequest { pub async fn migrate_customers( state: SessionState, - customers_migration: Vec<payment_methods_api::PaymentMethodCustomerMigrate>, + customers_migration: Vec<payment_methods_domain::PaymentMethodCustomerMigrate>, merchant_context: domain::MerchantContext, ) -> errors::CustomerResponse<()> { for customer_migration in customers_migration { diff --git a/crates/router/src/routes/payment_methods.rs b/crates/router/src/routes/payment_methods.rs index 20d0121ebde..31558c2d323 100644 --- a/crates/router/src/routes/payment_methods.rs +++ b/crates/router/src/routes/payment_methods.rs @@ -10,6 +10,7 @@ use diesel_models::enums::IntentStatus; use error_stack::ResultExt; use hyperswitch_domain_models::{ bulk_tokenization::CardNetworkTokenizeRequest, merchant_key_store::MerchantKeyStore, + payment_methods::PaymentMethodCustomerMigrate, transformers::ForeignTryFrom, }; use router_env::{instrument, logger, tracing, Flow}; @@ -331,10 +332,10 @@ pub async fn migrate_payment_methods( MultipartForm(form): MultipartForm<migration::PaymentMethodsMigrateForm>, ) -> HttpResponse { let flow = Flow::PaymentMethodsMigrate; - let (merchant_id, records, merchant_connector_id) = - match migration::get_payment_method_records(form) { - Ok((merchant_id, records, merchant_connector_id)) => { - (merchant_id, records, merchant_connector_id) + let (merchant_id, records, merchant_connector_ids) = + match form.validate_and_get_payment_method_records() { + Ok((merchant_id, records, merchant_connector_ids)) => { + (merchant_id, records, merchant_connector_ids) } Err(e) => return api::log_and_return_error_response(e.into()), }; @@ -345,7 +346,7 @@ pub async fn migrate_payment_methods( records, |state, _, req, _| { let merchant_id = merchant_id.clone(); - let merchant_connector_id = merchant_connector_id.clone(); + let merchant_connector_ids = merchant_connector_ids.clone(); async move { let (key_store, merchant_account) = get_merchant_account(&state, &merchant_id).await?; @@ -354,20 +355,43 @@ pub async fn migrate_payment_methods( domain::Context(merchant_account.clone(), key_store.clone()), )); - customers::migrate_customers( - state.clone(), - req.iter() - .map(|e| { - payment_methods::PaymentMethodCustomerMigrate::from(( - e.clone(), - merchant_id.clone(), - )) - }) - .collect(), - merchant_context.clone(), - ) - .await - .change_context(errors::ApiErrorResponse::InternalServerError)?; + let mut mca_cache = std::collections::HashMap::new(); + let customers = Vec::<PaymentMethodCustomerMigrate>::foreign_try_from(( + &req, + merchant_id.clone(), + )) + .map_err(|e| errors::ApiErrorResponse::InvalidRequestData { + message: e.to_string(), + })?; + + for record in &customers { + if let Some(connector_customer_details) = &record.connector_customer_details { + for connector_customer in connector_customer_details { + if !mca_cache.contains_key(&connector_customer.merchant_connector_id) { + let mca = state + .store + .find_by_merchant_connector_account_merchant_id_merchant_connector_id( + &(&state).into(), + &merchant_id, + &connector_customer.merchant_connector_id, + merchant_context.get_merchant_key_store(), + ) + .await + .to_not_found_response( + errors::ApiErrorResponse::MerchantConnectorAccountNotFound { + id: connector_customer.merchant_connector_id.get_string_repr().to_string(), + }, + )?; + mca_cache + .insert(connector_customer.merchant_connector_id.clone(), mca); + } + } + } + } + + customers::migrate_customers(state.clone(), customers, merchant_context.clone()) + .await + .change_context(errors::ApiErrorResponse::InternalServerError)?; let controller = cards::PmCards { state: &state, merchant_context: &merchant_context, @@ -377,7 +401,7 @@ pub async fn migrate_payment_methods( req, &merchant_id, &merchant_context, - merchant_connector_id, + merchant_connector_ids, &controller, )) .await diff --git a/crates/router/src/types/api/payment_methods.rs b/crates/router/src/types/api/payment_methods.rs index 0c29b58cbb6..4c094af5acc 100644 --- a/crates/router/src/types/api/payment_methods.rs +++ b/crates/router/src/types/api/payment_methods.rs @@ -1,32 +1,30 @@ #[cfg(feature = "v2")] pub use api_models::payment_methods::{ CardDetail, CardDetailFromLocker, CardDetailsPaymentMethod, CardNetworkTokenizeRequest, - CardNetworkTokenizeResponse, CardType, ConnectorCustomerDetails, - CustomerPaymentMethodResponseItem, DeleteTokenizeByTokenRequest, GetTokenizePayloadRequest, - GetTokenizePayloadResponse, ListCountriesCurrenciesRequest, MigrateCardDetail, - NetworkTokenDetailsPaymentMethod, NetworkTokenDetailsResponse, NetworkTokenResponse, - PaymentMethodCollectLinkRenderRequest, PaymentMethodCollectLinkRequest, PaymentMethodCreate, - PaymentMethodCreateData, PaymentMethodCustomerMigrate, PaymentMethodDeleteResponse, - PaymentMethodId, PaymentMethodIntentConfirm, PaymentMethodIntentCreate, PaymentMethodListData, - PaymentMethodListRequest, PaymentMethodListResponseForSession, PaymentMethodMigrate, - PaymentMethodMigrateResponse, PaymentMethodResponse, PaymentMethodResponseData, - PaymentMethodUpdate, PaymentMethodUpdateData, PaymentMethodsData, TokenDataResponse, - TokenDetailsResponse, TokenizePayloadEncrypted, TokenizePayloadRequest, TokenizedCardValue1, - TokenizedCardValue2, TokenizedWalletValue1, TokenizedWalletValue2, - TotalPaymentMethodCountResponse, + CardNetworkTokenizeResponse, CardType, CustomerPaymentMethodResponseItem, + DeleteTokenizeByTokenRequest, GetTokenizePayloadRequest, GetTokenizePayloadResponse, + ListCountriesCurrenciesRequest, MigrateCardDetail, NetworkTokenDetailsPaymentMethod, + NetworkTokenDetailsResponse, NetworkTokenResponse, PaymentMethodCollectLinkRenderRequest, + PaymentMethodCollectLinkRequest, PaymentMethodCreate, PaymentMethodCreateData, + PaymentMethodDeleteResponse, PaymentMethodId, PaymentMethodIntentConfirm, + PaymentMethodIntentCreate, PaymentMethodListData, PaymentMethodListRequest, + PaymentMethodListResponseForSession, PaymentMethodMigrate, PaymentMethodMigrateResponse, + PaymentMethodResponse, PaymentMethodResponseData, PaymentMethodUpdate, PaymentMethodUpdateData, + PaymentMethodsData, TokenDataResponse, TokenDetailsResponse, TokenizePayloadEncrypted, + TokenizePayloadRequest, TokenizedCardValue1, TokenizedCardValue2, TokenizedWalletValue1, + TokenizedWalletValue2, TotalPaymentMethodCountResponse, }; #[cfg(feature = "v1")] pub use api_models::payment_methods::{ CardDetail, CardDetailFromLocker, CardDetailsPaymentMethod, CardNetworkTokenizeRequest, - CardNetworkTokenizeResponse, ConnectorCustomerDetails, CustomerPaymentMethod, - CustomerPaymentMethodsListResponse, DefaultPaymentMethod, DeleteTokenizeByTokenRequest, - GetTokenizePayloadRequest, GetTokenizePayloadResponse, ListCountriesCurrenciesRequest, - MigrateCardDetail, PaymentMethodCollectLinkRenderRequest, PaymentMethodCollectLinkRequest, - PaymentMethodCreate, PaymentMethodCreateData, PaymentMethodCustomerMigrate, - PaymentMethodDeleteResponse, PaymentMethodId, PaymentMethodListRequest, - PaymentMethodListResponse, PaymentMethodMigrate, PaymentMethodMigrateResponse, - PaymentMethodResponse, PaymentMethodUpdate, PaymentMethodsData, TokenizeCardRequest, - TokenizeDataRequest, TokenizePayloadEncrypted, TokenizePayloadRequest, + CardNetworkTokenizeResponse, CustomerPaymentMethod, CustomerPaymentMethodsListResponse, + DefaultPaymentMethod, DeleteTokenizeByTokenRequest, GetTokenizePayloadRequest, + GetTokenizePayloadResponse, ListCountriesCurrenciesRequest, MigrateCardDetail, + PaymentMethodCollectLinkRenderRequest, PaymentMethodCollectLinkRequest, PaymentMethodCreate, + PaymentMethodCreateData, PaymentMethodDeleteResponse, PaymentMethodId, + PaymentMethodListRequest, PaymentMethodListResponse, PaymentMethodMigrate, + PaymentMethodMigrateResponse, PaymentMethodResponse, PaymentMethodUpdate, PaymentMethodsData, + TokenizeCardRequest, TokenizeDataRequest, TokenizePayloadEncrypted, TokenizePayloadRequest, TokenizePaymentMethodRequest, TokenizedCardValue1, TokenizedCardValue2, TokenizedWalletValue1, TokenizedWalletValue2, }; diff --git a/flake.nix b/flake.nix index e9bcb936d7b..35fa05b73a7 100644 --- a/flake.nix +++ b/flake.nix @@ -31,6 +31,7 @@ openssl pkg-config postgresql # for libpq + protobuf ]; # Minimal packages for running hyperswitch @@ -40,6 +41,7 @@ # Development packages devPackages = base ++ (with pkgs; [ + cargo-watch nixd rust-bin.stable.${rustDevVersion}.default swagger-cli

2025-06-26T18:47:13Z

## Type of Change  - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description This pull request enhances the data migration API to support migrating customer and payment method data across multiple business profiles in a single request. Specifically, the following changes have been made: 1. **Customer Data Migration:** * Updated `PaymentMethodRecord` to allow `merchant_connector_id` to accept comma-separated string values. * Modified `PaymentMethodCustomerMigrate` to use a `Vec` of connector-specific customer details. * The `TryFrom<PaymentMethodRecord>` implementation for `PaymentMethodCustomerMigrate` has been updated to parse this comma-separated string. 2. **Payment Method Migration:** * Updated `PaymentMethodsMigrateForm` to accept a comma-separated string for `merchant_connector_id`. * The `get_payment_method_records` and `migrate_payment_methods` functions are updated to process multiple `merchant_connector_id`s. * The `TryFrom` implementation for `PaymentMethodMigrate` is modified to create a `PaymentsMandateReference` for each `merchant_connector_id` provided. ### Additional Changes - [x] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context This allows migrating a payment method entity across multiple profiles (as `MerchantConnectorAccountId` is tied to a profile) during batch migration. ## How did you test it? <details> <summary>1. Batch migration for multiple profiles</summary> cURL curl --location --request POST 'http://localhost:8080/payment_methods/migrate-batch' \ --header 'api-key: test_admin' \ --form 'merchant_id="merchant_1751020165"' \ --form 'merchant_connector_ids="mca_lwpasOxD1FtFmG4SVdjX,mca_4tsKLvIinX1uVL8p9mhy"' \ --form 'file=@"migrate.csv"' Response [{"line_number":1,"payment_method_id":"pm_AO2rTJwFIH0I9yQiZ0zT","payment_method":"card","payment_method_type":"debit","customer_id":"45CC60D1F2283097BB1DE41A2636414445908518D50B8B4CDC57959CD7FB4539","migration_status":"Success","card_number_masked":"4360000 xxxx 0005","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":2,"payment_method_id":"pm_ZN9z4oKF439uxyBerwfL","payment_method":"card","payment_method_type":"credit","customer_id":"782BC898951D910C1A99DA69A4E4FAD6CEE53AB9311FA2C552028DA89428DB7F","migration_status":"Success","card_number_masked":"4111111 xxxx 1111","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null}] Things to verify in DB 1. `connector_mandate_details` for a given payment_method_id in response has connector_mandate_id for multiple MCAs <img width="421" alt="Screenshot 2025-06-28 at 3 09 18 PM" src="https://github.com/user-attachments/assets/8cfe8449-5ed1-441e-bd77-26540d5b6531" /> 2. `connector_customer` for a given customer_id in response has mappings for multiple MCAs <img width="748" alt="Screenshot 2025-06-28 at 3 09 41 PM" src="https://github.com/user-attachments/assets/dec23184-8014-4d8c-91b4-369ec6670e22" /> </details> <details> <summary>2. Batch migration for a single profile - For ensuring backwards compatibility</summary> cURL curl --location --request POST 'http://localhost:8080/payment_methods/migrate-batch' \ --header 'api-key: test_admin' \ --form 'merchant_id="merchant_1751020165"' \ --form 'merchant_connector_id="mca_lwpasOxD1FtFmG4SVdjX"' \ --form 'file=@"migrate.csv"' Response [{"line_number":1,"payment_method_id":"pm_ZGPPsRrU5f4IgVpMS9tj","payment_method":"card","payment_method_type":"debit","customer_id":"45CC60D1F2283097BB1DE41A2636414445908518D50B8B4CDC57959CD7FB4539","migration_status":"Success","card_number_masked":"4360000 xxxx 0005","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":2,"payment_method_id":"pm_Lf2vcheQkYIiZx8PIDHt","payment_method":"card","payment_method_type":"credit","customer_id":"782BC898951D910C1A99DA69A4E4FAD6CEE53AB9311FA2C552028DA89428DB7F","migration_status":"Success","card_number_masked":"4111111 xxxx 1111","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null}] Things to verify in DB - PM migration happens for a single MCA (connector_mandate_details) - Customer migration happens for a single MCA (connector_customer) </details> Sample migration data for multi profile migration [multi-migrate-sample.csv](https://github.com/user-attachments/files/20974125/multi-migrate-sample.csv) ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.114.0

6c66c36a66b6644c43761b7ac9c1326945a6a820

juspay/hyperswitch

juspay__hyperswitch-8460

Bug: [BUG] DB constraints for events table ### Bug Description `idempotent_event_id` column is a combination of `payment_id` and the `event_type`. Length of this field in DB can be a maximum of 64 characters. However, since `payment_id` can also be 64 characters, the resulting `idempotent_event_id` can easily exceed 64 characters leading to inconsistent behavior in the flows. Currently, this is breaking outgoing webhooks flow. ### Expected Behavior Outgoing webhooks flow should succeed. ### Actual Behavior Outgoing webhooks flow breaks due to DB constraints. ``` { "message": "[INCOMING_WEBHOOKS_CORE - EVENT] Incoming webhook flow failed", "extra": { "error": "{\"error\":{\"type\":\"router_error\",\"code\":\"WE_03\",\"message\":\"There was some issue processing the webhook\"}}\\n├╴at crates/router/src/core/webhooks/outgoing.rs:196:18\\n├╴Failed to insert event in events table\\n├╴Incoming webhook flow for payments failed\\n│\\n╰─▶ DatabaseError: An unknown error occurred\\n ├╴at /router/crates/diesel_models/src/query/generics.rs:89:36\\n ├╴Error while inserting EventNew { event_id: \"evt_01979b2125017d93bb4d846d42979839\", event_type: PaymentAuthorized, event_class: Payments, is_webhook_notified: false, primary_object_id: \"AFR_202506237e491a4f-1bd8-4d97-a9a6-a2f86832bc79\", primary_object_type: PaymentDetails, created_at: 2025-06-23 4:52:10.113410262, merchant_id: Some(MerchantId(\"merchant_1741787326\")), business_profile_id: Some(ProfileId(\"pro_r3uCseg4NT35RBFpmUPA\")), primary_object_created_at: Some(2025-06-23 4:51:14.154239), idempotent_event_id: Some(\"AFR_202506237e491a4f-1bd8-4d97-a9a6-a2f86832bc79_payment_authorized\"), initial_attempt_id: Some(\"evt_01979b2125017d93bb4d846d42979839\"), request: Some(Encryption { inner: *** Encrypted data of length 7223 bytes *** }), response: None, delivery_attempt: Some(InitialAttempt), metadata: Some(Payment { payment_id: PaymentId(\"AFR_202506237e491a4f-1bd8-4d97-a9a6-a2f86832bc79\") }), is_overall_delivery_successful: Some(false) }\\n │\\n ╰─▶ value too long for type character varying(64)\\n ╰╴at /router/crates/diesel_models/src/query/generics.rs:89:22\\n ╰╴at crates/router/src/db/events.rs:129:30" } } ``` ### Steps To Reproduce -- ### Context For The Bug -- ### Environment -- ### Have you spent some time checking if this bug has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? None

diff --git a/crates/common_utils/src/consts.rs b/crates/common_utils/src/consts.rs index 59ec5377690..bbb65e1afc6 100644 --- a/crates/common_utils/src/consts.rs +++ b/crates/common_utils/src/consts.rs @@ -97,6 +97,11 @@ pub const BASE64_ENGINE: base64::engine::GeneralPurpose = base64::engine::genera /// URL Safe base64 engine pub const BASE64_ENGINE_URL_SAFE: base64::engine::GeneralPurpose = base64::engine::general_purpose::URL_SAFE; + +/// URL Safe base64 engine without padding +pub const BASE64_ENGINE_URL_SAFE_NO_PAD: base64::engine::GeneralPurpose = + base64::engine::general_purpose::URL_SAFE_NO_PAD; + /// Regex for matching a domain /// Eg - /// http://www.example.com diff --git a/crates/router/src/core/errors.rs b/crates/router/src/core/errors.rs index bf5330a9325..a980bb664ef 100644 --- a/crates/router/src/core/errors.rs +++ b/crates/router/src/core/errors.rs @@ -157,6 +157,8 @@ pub enum WebhooksFlowError { OutgoingWebhookRetrySchedulingFailed, #[error("Outgoing webhook response encoding failed")] OutgoingWebhookResponseEncodingFailed, + #[error("ID generation failed")] + IdGenerationFailed, } impl WebhooksFlowError { @@ -174,7 +176,8 @@ impl WebhooksFlowError { | Self::DisputeWebhookValidationFailed | Self::OutgoingWebhookEncodingFailed | Self::OutgoingWebhookProcessTrackerTaskUpdateFailed - | Self::OutgoingWebhookRetrySchedulingFailed => true, + | Self::OutgoingWebhookRetrySchedulingFailed + | Self::IdGenerationFailed => true, } } } diff --git a/crates/router/src/core/webhooks/outgoing.rs b/crates/router/src/core/webhooks/outgoing.rs index 34b49c2fc8a..adc54b09b94 100644 --- a/crates/router/src/core/webhooks/outgoing.rs +++ b/crates/router/src/core/webhooks/outgoing.rs @@ -60,7 +60,9 @@ pub(crate) async fn create_event_and_trigger_outgoing_webhook( ) -> CustomResult<(), errors::ApiErrorResponse> { let delivery_attempt = enums::WebhookDeliveryAttempt::InitialAttempt; let idempotent_event_id = - utils::get_idempotent_event_id(&primary_object_id, event_type, delivery_attempt); + utils::get_idempotent_event_id(&primary_object_id, event_type, delivery_attempt) + .change_context(errors::ApiErrorResponse::WebhookProcessingFailure) + .attach_printable("Failed to generate idempotent event ID")?; let webhook_url_result = get_webhook_url_from_business_profile(&business_profile); if !state.conf.webhooks.outgoing_enabled diff --git a/crates/router/src/core/webhooks/outgoing_v2.rs b/crates/router/src/core/webhooks/outgoing_v2.rs index 07758817e68..d0e0ecaa69a 100644 --- a/crates/router/src/core/webhooks/outgoing_v2.rs +++ b/crates/router/src/core/webhooks/outgoing_v2.rs @@ -48,7 +48,9 @@ pub(crate) async fn create_event_and_trigger_outgoing_webhook( ) -> CustomResult<(), errors::ApiErrorResponse> { let delivery_attempt = enums::WebhookDeliveryAttempt::InitialAttempt; let idempotent_event_id = - utils::get_idempotent_event_id(&primary_object_id, event_type, delivery_attempt); + utils::get_idempotent_event_id(&primary_object_id, event_type, delivery_attempt) + .change_context(errors::ApiErrorResponse::WebhookProcessingFailure) + .attach_printable("Failed to generate idempotent event ID")?; let webhook_url_result = business_profile .get_webhook_url_from_profile() .change_context(errors::WebhooksFlowError::MerchantWebhookUrlNotConfigured); diff --git a/crates/router/src/core/webhooks/utils.rs b/crates/router/src/core/webhooks/utils.rs index 45b6c24a2ed..0344d7d010e 100644 --- a/crates/router/src/core/webhooks/utils.rs +++ b/crates/router/src/core/webhooks/utils.rs @@ -1,6 +1,12 @@ use std::marker::PhantomData; -use common_utils::{errors::CustomResult, ext_traits::ValueExt}; +use base64::Engine; +use common_utils::{ + consts, + crypto::{self, GenerateDigest}, + errors::CustomResult, + ext_traits::ValueExt, +}; use error_stack::{Report, ResultExt}; use redis_interface as redis; use router_env::tracing; @@ -146,18 +152,28 @@ pub(crate) fn get_idempotent_event_id( primary_object_id: &str, event_type: types::storage::enums::EventType, delivery_attempt: types::storage::enums::WebhookDeliveryAttempt, -) -> String { +) -> Result<String, Report<errors::WebhooksFlowError>> { use crate::types::storage::enums::WebhookDeliveryAttempt; const EVENT_ID_SUFFIX_LENGTH: usize = 8; let common_prefix = format!("{primary_object_id}_{event_type}"); - match delivery_attempt { - WebhookDeliveryAttempt::InitialAttempt => common_prefix, + + // Hash the common prefix with SHA256 and encode with URL-safe base64 without padding + let digest = crypto::Sha256 + .generate_digest(common_prefix.as_bytes()) + .change_context(errors::WebhooksFlowError::IdGenerationFailed) + .attach_printable("Failed to generate idempotent event ID")?; + let base_encoded = consts::BASE64_ENGINE_URL_SAFE_NO_PAD.encode(digest); + + let result = match delivery_attempt { + WebhookDeliveryAttempt::InitialAttempt => base_encoded, WebhookDeliveryAttempt::AutomaticRetry | WebhookDeliveryAttempt::ManualRetry => { - common_utils::generate_id(EVENT_ID_SUFFIX_LENGTH, &common_prefix) + common_utils::generate_id(EVENT_ID_SUFFIX_LENGTH, &base_encoded) } - } + }; + + Ok(result) } #[inline] diff --git a/crates/router/src/core/webhooks/webhook_events.rs b/crates/router/src/core/webhooks/webhook_events.rs index 44ce4fdd515..700295af0ec 100644 --- a/crates/router/src/core/webhooks/webhook_events.rs +++ b/crates/router/src/core/webhooks/webhook_events.rs @@ -287,7 +287,9 @@ pub async fn retry_delivery_attempt( &event_to_retry.primary_object_id, event_to_retry.event_type, delivery_attempt, - ); + ) + .change_context(errors::ApiErrorResponse::WebhookProcessingFailure) + .attach_printable("Failed to generate idempotent event ID")?; let now = common_utils::date_time::now(); let new_event = domain::Event { diff --git a/crates/router/src/workflows/outgoing_webhook_retry.rs b/crates/router/src/workflows/outgoing_webhook_retry.rs index 559f62b1a4a..d84f0b26dc7 100644 --- a/crates/router/src/workflows/outgoing_webhook_retry.rs +++ b/crates/router/src/workflows/outgoing_webhook_retry.rs @@ -72,7 +72,9 @@ impl ProcessTrackerWorkflow<SessionState> for OutgoingWebhookRetryWorkflow { &tracking_data.primary_object_id, tracking_data.event_type, delivery_attempt, - ); + ) + .change_context(errors::ApiErrorResponse::WebhookProcessingFailure) + .attach_printable("Failed to generate idempotent event ID")?; let initial_event = match &tracking_data.initial_attempt_id { Some(initial_attempt_id) => {

2025-09-16T13:24:24Z

## Type of Change  - [x] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  This change updates the idempotent_event_id generation to first hash the base string with SHA256 and then encode it using URL-safe Base64 without padding. By doing this, the generated IDs are guaranteed to be short and deterministic, ensuring they always fit within the 64-character database column limit. This fix addresses the issue where long payment_ids combined with event types were exceeding the DB constraint and breaking the outgoing webhooks flow. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  The idempotent_event_id column is a combination of payment_id and event_type. The DB column length is limited to 64 characters. Since payment_id itself can be up to 64 characters long, appending event_type causes the field to exceed the limit, leading to database constraint violations. Currently, this breaks the outgoing webhooks flow. Additionally, during staggered deployments and rollback, the uniqueness of these IDs may cause dual webhook dispatches. closes #8460 ## How did you test it?  1. Started the local Node.js Express webhook listener on port 3000 using the server.js script. <details> <summary>server.js script</summary> ``` mkdir -p /tmp/hs-webhooks && cd /tmp/hs-webhooks npm init -y >/dev/null npm i express >/dev/null cat > server.js <<'JS' const express = require('express'); const app = express(); app.use(express.json({ type: '*/*' })); app.post('/webhooks/hs', (req, res) => { console.log('---- Webhook received ----'); console.log('Headers:', req.headers); console.log('Body:', JSON.stringify(req.body, null, 2)); res.sendStatus(200); }); app.listen(3000, () => console.log('Webhook listener running on port 3000')); JS node server.js ``` </details> 2. **Merchant Creation** <details> <summary>Merchant creation Curl</summary> ```bash curl --location 'http://localhost:8080/accounts' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'api-key: test_admin' \ --data-raw '{ "merchant_id": "merchant_1758029612", "locker_id": "m0010", "merchant_name": "worldpay", "merchant_details": { "primary_contact_person": "John Test", "primary_email": "[email protected]", "primary_phone": "sunt laborum", "secondary_contact_person": "John Test2", "secondary_email": "[email protected]", "secondary_phone": "cillum do dolor id", "website": "https://www.example.com", "about_business": "Online Retail with a wide selection of organic products for North America", "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name":"john", "last_name":"Doe" } }, "return_url": "https://google.com/success", "webhook_details": { "webhook_version": "1.0.1", "webhook_username": "ekart_retail", "webhook_password": "password_ekart@123", "webhook_url":"http://localhost:3000/webhooks/hs", "payment_created_enabled": true, "payment_succeeded_enabled": true, "payment_failed_enabled": true }, "sub_merchants_enabled": false, "parent_merchant_id":"merchant_123", "metadata": { "city": "NY", "unit": "245", "merchant_name": "Acme Widgets LLC" }, "primary_business_details": [ { "country": "US", "business": "default" } ] }' ``` </details> After this when i created payment it created event with these idempotent_event_id. <img width="533" height="165" alt="image" src="https://github.com/user-attachments/assets/6610ede4-6ffe-4de1-bde3-664ac00abec4" /> <details> <summary>Manual Retry Curl</summary> ``` curl --location --request POST 'http://localhost:8080/events/merchant_1758190753/evt_01995ce5346575608391d7f8b825175d/retry' \ --header 'api-key: test_admin' ``` </details> <img width="559" height="252" alt="image" src="https://github.com/user-attachments/assets/cb652d7b-5749-48f0-b2f7-78726411e789" /> For primary object id greater than 64 chars still generated idempotent_event_id will always be less than 64 characters in length. <img width="831" height="33" alt="image" src="https://github.com/user-attachments/assets/3d7b838a-df61-401e-ac2c-fd7e5cd5b4c8" /> ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.117.0

f3ab3d63f69279af9254f15eba5654c0680a0747

juspay/hyperswitch

juspay__hyperswitch-8442

Bug: [FEATURE] Add x-mcp extension to OpenAPI schema Mintlify supports extracting API endpoints from openAPI json into MCP servers: https://mintlify.com/docs/mcp We need to add: ```json "x-mcp": { "enabled": true }, ``` at the top level of our OpenAPI schema to enable this functionality

diff --git a/README.md b/README.md index a46baab5244..35964d72bf5 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ <a href="https://x.com/hyperswitchio"> <img src="https://img.shields.io/badge/follow-%40hyperswitchio-white?logo=x&labelColor=grey"/> </a> - <a href="https://join.slack.com/t/hyperswitch-io/shared_invite/zt-2jqxmpsbm-WXUENx022HjNEy~Ark7Orw"> + <a href="https://inviter.co/hyperswitch-slack"> <img src="https://img.shields.io/badge/chat-on_slack-blue?logo=slack&labelColor=grey&color=%233f0e40"/> </a> </p> @@ -196,7 +196,7 @@ We welcome contributors from around the world to help build Hyperswitch. Whether Please read our [contributing guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) to get started. -Join the conversation on [Slack](https://join.slack.com/t/hyperswitch-io/shared_invite/zt-2jqxmpsbm-WXUENx022HjNEy~Ark7Orw) or explore open issues on [GitHub](https://github.com/juspay/hyperswitch/issues). +Join the conversation on [Slack](https://inviter.co/hyperswitch-slack) or explore open issues on [GitHub](https://github.com/juspay/hyperswitch/issues). <a href="#feature-requests"> <h2 id="feature-requests">Feature requests & Bugs</h2> diff --git a/api-reference/v1/openapi_spec_v1.json b/api-reference/v1/openapi_spec_v1.json index 6045147a050..c4601519965 100644 --- a/api-reference/v1/openapi_spec_v1.json +++ b/api-reference/v1/openapi_spec_v1.json @@ -1,5 +1,8 @@ { "openapi": "3.0.3", + "x-mcp": { + "enabled": true + }, "info": { "title": "Hyperswitch - API Documentation", "description": "\n## Get started\n\nHyperswitch provides a collection of APIs that enable you to process and manage payments.\nOur APIs accept and return JSON in the HTTP body, and return standard HTTP response codes.\n\nYou can consume the APIs directly using your favorite HTTP/REST library.\n\nWe have a testing environment referred to \"sandbox\", which you can setup to test API calls without\naffecting production data.\nCurrently, our sandbox environment is live while our production environment is under development\nand will be available soon.\nYou can sign up on our Dashboard to get API keys to access Hyperswitch API.\n\n### Environment\n\nUse the following base URLs when making requests to the APIs:\n\n| Environment | Base URL |\n|---------------|------------------------------------|\n| Sandbox | <https://sandbox.hyperswitch.io> |\n| Production | <https://api.hyperswitch.io> |\n\n## Authentication\n\nWhen you sign up on our [dashboard](https://app.hyperswitch.io) and create a merchant\naccount, you are given a secret key (also referred as api-key) and a publishable key.\nYou may authenticate all API requests with Hyperswitch server by providing the appropriate key in\nthe request Authorization header.\n\n| Key | Description |\n|-----------------|-----------------------------------------------------------------------------------------------|\n| api-key | Private key. Used to authenticate all API requests from your merchant server |\n| publishable key | Unique identifier for your account. Used to authenticate API requests from your app's client |\n\nNever share your secret api keys. Keep them guarded and secure.\n", diff --git a/api-reference/v1/payments/payment--flows.mdx b/api-reference/v1/payments/payment--flows.mdx index eff90a0dcb8..9338f835f38 100644 --- a/api-reference/v1/payments/payment--flows.mdx +++ b/api-reference/v1/payments/payment--flows.mdx @@ -226,7 +226,9 @@ sequenceDiagram **Required Fields:** - `off_session: true` -- `recurring_details: { payment_method_id: "<from_setup>" }` +- `recurring_details: { + "type": "payment_method_id", + "data": "<from_setup>"}` **Use Case:** Subscription charges, scheduled billing without customer interaction diff --git a/crates/openapi/src/main.rs b/crates/openapi/src/main.rs index cf8158cfb02..d25b24442df 100644 --- a/crates/openapi/src/main.rs +++ b/crates/openapi/src/main.rs @@ -29,13 +29,33 @@ fn main() { #[allow(clippy::expect_used)] #[cfg(any(feature = "v1", feature = "v2"))] std::fs::write( - file_path, + &file_path, openapi .to_pretty_json() .expect("Failed to serialize OpenAPI specification as JSON"), ) .expect("Failed to write OpenAPI specification to file"); + #[allow(clippy::expect_used)] + #[cfg(feature = "v1")] + { + // TODO: Do this using utoipa::extensions after we have upgraded to 5.x + let file_content = + std::fs::read_to_string(&file_path).expect("Failed to read OpenAPI specification file"); + + let mut lines: Vec<&str> = file_content.lines().collect(); + + // Insert the new text at line 3 (index 2) + if lines.len() > 2 { + let new_line = " \"x-mcp\": {\n \"enabled\": true\n },"; + lines.insert(2, new_line); + } + + let modified_content = lines.join("\n"); + std::fs::write(&file_path, modified_content) + .expect("Failed to write modified OpenAPI specification to file"); + } + #[cfg(any(feature = "v1", feature = "v2"))] println!("Successfully saved OpenAPI specification file at '{relative_file_path}'");

2025-06-24T09:35:51Z

## Type of Change  - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [x] Documentation - [ ] CI/CD ## Description  Modified `openapi/src/main.rs` to append `x-mcp` extension to v1 OpenAPI schema ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  Closes #8442 ## How did you test it?  Verified using: `mintlify openapi-check api-reference/v1/openapi_spec_v1.json` Tested mintlify's mcp server generation functionality by deploying the updated OpenAPI spec file on a custom mintlify account. Used the generated mcp server to do payments - create in cursor. ![image](https://github.com/user-attachments/assets/1a6e37a3-a682-4b84-9cd7-1292f3ed1787) ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.114.0

bc767b9131e2637ce90997da9018085d2dadb80b

juspay/hyperswitch

juspay__hyperswitch-8445

Bug: fix(recovery) : Populate connector request reference id in revenue recovery record attempt flow. Previously there was no restriction in confirmData to connector request reference id to be mandatory. Recovery internally uses proxy flow, which internally uses confirmData where connector request reference id was hardcoded to none.

diff --git a/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs b/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs index c35fbc3163e..86821bfe6ef 100644 --- a/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs +++ b/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs @@ -646,7 +646,6 @@ impl PaymentAttempt { let payment_method_type_data = payment_intent.get_payment_method_type(); let payment_method_subtype_data = payment_intent.get_payment_method_sub_type(); - let authentication_type = payment_intent.authentication_type.unwrap_or_default(); Ok(Self { payment_id: payment_intent.id.clone(), @@ -752,7 +751,10 @@ impl PaymentAttempt { .as_ref() .map(|txn_id| txn_id.get_id().clone()); let connector = request.connector.map(|connector| connector.to_string()); - + let connector_request_reference_id = payment_intent + .merchant_reference_id + .as_ref() + .map(|id| id.get_string_repr().to_owned()); Ok(Self { payment_id: payment_intent.id.clone(), merchant_id: payment_intent.merchant_id.clone(), @@ -804,7 +806,7 @@ impl PaymentAttempt { charges: None, processor_merchant_id: payment_intent.merchant_id.clone(), created_by: None, - connector_request_reference_id: None, + connector_request_reference_id, }) } diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs index 59de54f41fa..2f70a79ec87 100644 --- a/crates/router/src/core/payments.rs +++ b/crates/router/src/core/payments.rs @@ -4042,6 +4042,16 @@ where ) .await?, )); + operation + .to_domain()? + .populate_payment_data( + state, + payment_data, + merchant_context, + business_profile, + &connector, + ) + .await?; let mut router_data = payment_data .construct_router_data( diff --git a/crates/router/src/core/payments/operations/proxy_payments_intent.rs b/crates/router/src/core/payments/operations/proxy_payments_intent.rs index 838cbf9dedf..a65f4cdd99e 100644 --- a/crates/router/src/core/payments/operations/proxy_payments_intent.rs +++ b/crates/router/src/core/payments/operations/proxy_payments_intent.rs @@ -6,6 +6,7 @@ use error_stack::ResultExt; use hyperswitch_domain_models::{ payment_method_data::PaymentMethodData, payments::PaymentConfirmData, }; +use hyperswitch_interfaces::api::ConnectorSpecifications; use masking::PeekInterface; use router_env::{instrument, tracing}; @@ -15,7 +16,7 @@ use crate::{ errors::{self, CustomResult, RouterResult, StorageErrorExt}, payments::{ operations::{self, ValidateStatusForOperation}, - OperationSessionGetters, + OperationSessionGetters, OperationSessionSetters, }, }, routes::{app::ReqState, SessionState}, @@ -303,6 +304,24 @@ impl<F: Clone + Send + Sync> Domain<F, ProxyPaymentsRequest, PaymentConfirmData< )> { Ok((Box::new(self), None, None)) } + #[instrument(skip_all)] + async fn populate_payment_data<'a>( + &'a self, + _state: &SessionState, + payment_data: &mut PaymentConfirmData<F>, + _merchant_context: &domain::MerchantContext, + _business_profile: &domain::Profile, + connector_data: &api::ConnectorData, + ) -> CustomResult<(), errors::ApiErrorResponse> { + let connector_request_reference_id = connector_data + .connector + .generate_connector_request_reference_id( + &payment_data.payment_intent, + &payment_data.payment_attempt, + ); + payment_data.set_connector_request_reference_id(Some(connector_request_reference_id)); + Ok(()) + } async fn perform_routing<'a>( &'a self, diff --git a/crates/router/src/routes/payments.rs b/crates/router/src/routes/payments.rs index 020a1fbf713..e2363633dad 100644 --- a/crates/router/src/routes/payments.rs +++ b/crates/router/src/routes/payments.rs @@ -232,7 +232,7 @@ pub async fn payments_get_intent( header_payload.clone(), ) }, - auth::api_or_client_auth( + auth::api_or_client_or_jwt_auth( &auth::V2ApiKeyAuth { is_connected_allowed: false, is_platform_allowed: false, @@ -240,6 +240,9 @@ pub async fn payments_get_intent( &auth::V2ClientAuth(common_utils::types::authentication::ResourceId::Payment( global_payment_id.clone(), )), + &auth::JWTAuth { + permission: Permission::ProfileRevenueRecoveryRead, + }, req.headers(), ), api_locking::LockAction::NotApplicable, diff --git a/crates/router/src/services/authentication.rs b/crates/router/src/services/authentication.rs index 41b7bd3d87b..d16063939a1 100644 --- a/crates/router/src/services/authentication.rs +++ b/crates/router/src/services/authentication.rs @@ -2698,7 +2698,27 @@ where api_auth } } - +#[cfg(feature = "v2")] +pub fn api_or_client_or_jwt_auth<'a, T, A>( + api_auth: &'a dyn AuthenticateAndFetch<T, A>, + client_auth: &'a dyn AuthenticateAndFetch<T, A>, + jwt_auth: &'a dyn AuthenticateAndFetch<T, A>, + headers: &HeaderMap, +) -> &'a dyn AuthenticateAndFetch<T, A> +where +{ + if let Ok(val) = HeaderMapStruct::new(headers).get_auth_string_from_header() { + if val.trim().starts_with("api-key=") { + api_auth + } else if is_jwt_auth(headers) { + jwt_auth + } else { + client_auth + } + } else { + api_auth + } +} #[derive(Debug)] pub struct PublishableKeyAuth;

2025-06-23T13:31:41Z

## Type of Change  - [x] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  Previously there was no restriction in confirmData to connector request reference id to be mandatory. Recovery internally uses proxy flow, which internally uses confirmData where connector request reference id was hardcoded to none. This Pr adds supports to generate connector request reference to merchant reference id. This Pr also has changes of adding support for jwt auth to payment get for dashboard use case. Previously payment sync was used in dashboard to retrieve payment details, but this would fail now in v2 because if there are no attempts created payment get would return 4xx since active attempt is mandotory. To solve this now dashboard is relying on payment get and payment get attempt list api's . ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  ## How did you test it?  Test case 1 : **step 1 :** create a profile in hyperswitch and wait for 8 mins to move it from monitering to cascading , this would only get updated when webhooks are triggered . **step 2 :** create payment mca ``` curl --location 'http://localhost:8080/v2/connector-accounts' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'x-merchant-id: test_seller_AGZCJiHwUNV1seyoepOE' \ --header 'x-profile-id: pro_kYmv4lQjIZFbAqoOVY4M' \ --header 'Authorization: admin-api-key=test_admin' \ --data '{ "connector_type": "payment_processor", "connector_name": "stripe", "connector_account_details": { "auth_type": "HeaderKey", "api_key": "stripe-api-key" }, "profile_id": "pro_kYmv4lQjIZFbAqoOVY4M" }' ``` **step 4 : ** configure stripe billing connector. ``` curl --location 'http://localhost:8080/v2/connector-accounts' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'x-merchant-id: test_seller_AGZCJiHwUNV1seyoepOE' \ --header 'x-profile-id: pro_kYmv4lQjIZFbAqoOVY4M' \ --header 'Authorization: admin-api-key=test_admin' \ --data '{ "connector_type": "billing_processor", "connector_name": "stripebilling", "connector_account_details": { "auth_type": "HeaderKey", "api_key": "{{stripe-api-key}}" }, "connector_webhook_details": { "merchant_secret": "{{stripe-webhook-key}}", "additional_secret": "password" }, "feature_metadata": { "revenue_recovery": { "max_retry_count": 7, "billing_connector_retry_threshold": 2, "billing_account_reference": { "{{payment_connector_mca_created_in_last_step}}": "stripebilling" } } }, "profile_id": "pro_kYmv4lQjIZFbAqoOVY4M" }' ``` step 5 : Trigger failed invoice from stripe billing by creating new subscription and move the test clock to 1 week. This would trigger few external payments. once it exhausts retry threshold it will create process tracker entry. Follwed by 2 mins it would create all retries by hyperswitch as shown below. <img width="935" alt="Screenshot 2025-06-23 at 7 00 57 PM" src="https://github.com/user-attachments/assets/d51d3d9e-82ff-4385-b318-dbb37230cee8" /> ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.114.0

6fd7626c99e006bb7dcac864c30299bb8ef1d742

juspay/hyperswitch

juspay__hyperswitch-8449

Bug: remove frm rule migration support as it is not supported in DE

diff --git a/crates/router/src/core/routing.rs b/crates/router/src/core/routing.rs index b52fc966721..0d34986c838 100644 --- a/crates/router/src/core/routing.rs +++ b/crates/router/src/core/routing.rs @@ -2483,11 +2483,6 @@ pub async fn migrate_rules_for_profile( .attach_printable("Failed to get payout routing algorithm")? .unwrap_or_default() .algorithm_id, - business_profile - .get_frm_routing_algorithm() - .attach_printable("Failed to get frm routing algorithm")? - .unwrap_or_default() - .algorithm_id, ]; #[cfg(feature = "v2")]

2025-06-24T10:58:00Z

## Type of Change  - [X] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  As FRM routing is not supported in DE we can remove support for it from DE migration endpoint ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  ## How did you test it?  Compilation and cypress is working as expected. ## Checklist  - [ ] I formatted the code `cargo +nightly fmt --all` - [ ] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.114.0

bc767b9131e2637ce90997da9018085d2dadb80b

juspay/hyperswitch

juspay__hyperswitch-8437

Bug: [REFACTOR] allow option for skipping billing details during batched data migration **Problem Statement** Currently, `/migrate-batch` API has below mandatory parameters ```rust { pub customer_id: id_type::CustomerId, pub nick_name: masking::Secret<String>, pub card_number_masked: masking::Secret<String>, pub card_expiry_month: masking::Secret<String>, pub card_expiry_year: masking::Secret<String>, pub billing_address_zip: masking::Secret<String>, pub billing_address_state: masking::Secret<String>, pub billing_address_first_name: masking::Secret<String>, pub billing_address_last_name: masking::Secret<String>, pub billing_address_city: String, pub billing_address_line1: masking::Secret<String>, } ``` Billing details are mandatory but there can be use cases when these details are not be required by the underlying connector during payments. For such cases, these details become a blocker for using the migrate API. These can be made optional. **Proposed Solution** Fields related to billing details can be made `Optional`

diff --git a/crates/api_models/src/payment_methods.rs b/crates/api_models/src/payment_methods.rs index 5ecd2f71ef7..25b583f5dc4 100644 --- a/crates/api_models/src/payment_methods.rs +++ b/crates/api_models/src/payment_methods.rs @@ -2481,7 +2481,7 @@ pub struct PaymentMethodRecord { pub merchant_id: Option<id_type::MerchantId>, pub payment_method: Option<api_enums::PaymentMethod>, pub payment_method_type: Option<api_enums::PaymentMethodType>, - pub nick_name: masking::Secret<String>, + pub nick_name: Option<masking::Secret<String>>, pub payment_instrument_id: Option<masking::Secret<String>>, pub connector_customer_id: Option<String>, pub card_number_masked: masking::Secret<String>, @@ -2489,13 +2489,13 @@ pub struct PaymentMethodRecord { pub card_expiry_year: masking::Secret<String>, pub card_scheme: Option<String>, pub original_transaction_id: Option<String>, - pub billing_address_zip: masking::Secret<String>, - pub billing_address_state: masking::Secret<String>, - pub billing_address_first_name: masking::Secret<String>, - pub billing_address_last_name: masking::Secret<String>, - pub billing_address_city: String, + pub billing_address_zip: Option<masking::Secret<String>>, + pub billing_address_state: Option<masking::Secret<String>>, + pub billing_address_first_name: Option<masking::Secret<String>>, + pub billing_address_last_name: Option<masking::Secret<String>>, + pub billing_address_city: Option<String>, pub billing_address_country: Option<api_enums::CountryAlpha2>, - pub billing_address_line1: masking::Secret<String>, + pub billing_address_line1: Option<masking::Secret<String>>, pub billing_address_line2: Option<masking::Secret<String>>, pub billing_address_line3: Option<masking::Secret<String>>, pub raw_card_number: Option<masking::Secret<String>>, @@ -2548,6 +2548,57 @@ pub enum MigrationStatus { Failed, } +impl PaymentMethodRecord { + fn create_address(&self) -> Option<payments::AddressDetails> { + if self.billing_address_first_name.is_some() + && self.billing_address_line1.is_some() + && self.billing_address_zip.is_some() + && self.billing_address_city.is_some() + && self.billing_address_country.is_some() + { + Some(payments::AddressDetails { + city: self.billing_address_city.clone(), + country: self.billing_address_country, + line1: self.billing_address_line1.clone(), + line2: self.billing_address_line2.clone(), + state: self.billing_address_state.clone(), + line3: self.billing_address_line3.clone(), + zip: self.billing_address_zip.clone(), + first_name: self.billing_address_first_name.clone(), + last_name: self.billing_address_last_name.clone(), + }) + } else { + None + } + } + + fn create_phone(&self) -> Option<payments::PhoneDetails> { + if self.phone.is_some() || self.phone_country_code.is_some() { + Some(payments::PhoneDetails { + number: self.phone.clone(), + country_code: self.phone_country_code.clone(), + }) + } else { + None + } + } + + fn create_billing(&self) -> Option<payments::Address> { + let address = self.create_address(); + let phone = self.create_phone(); + + if address.is_some() || phone.is_some() || self.email.is_some() { + Some(payments::Address { + address, + phone, + email: self.email.clone(), + }) + } else { + None + } + } +} + #[cfg(feature = "v1")] type PaymentMethodMigrationResponseType = ( Result<PaymentMethodMigrateResponse, String>, @@ -2600,6 +2651,7 @@ impl ), ) -> Result<Self, Self::Error> { let (record, merchant_id, mca_id) = item; + let billing = record.create_billing(); // if payment instrument id is present then only construct this let connector_mandate_details = if record.payment_instrument_id.is_some() { @@ -2631,7 +2683,7 @@ impl card_type: None, card_issuer: None, card_issuing_country: None, - nick_name: Some(record.nick_name.clone()), + nick_name: record.nick_name.clone(), }), network_token: Some(MigrateNetworkTokenDetail { network_token_data: MigrateNetworkTokenData { @@ -2639,7 +2691,7 @@ impl network_token_exp_month: record.network_token_expiry_month.unwrap_or_default(), network_token_exp_year: record.network_token_expiry_year.unwrap_or_default(), card_holder_name: record.name, - nick_name: Some(record.nick_name.clone()), + nick_name: record.nick_name.clone(), card_issuing_country: None, card_network: None, card_issuer: None, @@ -2652,24 +2704,7 @@ impl payment_method: record.payment_method, payment_method_type: record.payment_method_type, payment_method_issuer: None, - billing: Some(payments::Address { - address: Some(payments::AddressDetails { - city: Some(record.billing_address_city), - country: record.billing_address_country, - line1: Some(record.billing_address_line1), - line2: record.billing_address_line2, - state: Some(record.billing_address_state), - line3: record.billing_address_line3, - zip: Some(record.billing_address_zip), - first_name: Some(record.billing_address_first_name), - last_name: Some(record.billing_address_last_name), - }), - phone: Some(payments::PhoneDetails { - number: record.phone, - country_code: record.phone_country_code, - }), - email: record.email, - }), + billing, connector_mandate_details: connector_mandate_details.map( |payments_mandate_reference| { CommonMandateReference::from(payments_mandate_reference) @@ -2683,7 +2718,7 @@ impl #[cfg(feature = "payouts")] wallet: None, payment_method_data: None, - network_transaction_id: record.original_transaction_id, + network_transaction_id: record.original_transaction_id.clone(), }) } } @@ -2702,15 +2737,15 @@ impl From<(PaymentMethodRecord, id_type::MerchantId)> for PaymentMethodCustomerM description: None, phone_country_code: record.phone_country_code, address: Some(payments::AddressDetails { - city: Some(record.billing_address_city), + city: record.billing_address_city, country: record.billing_address_country, - line1: Some(record.billing_address_line1), + line1: record.billing_address_line1, line2: record.billing_address_line2, - state: Some(record.billing_address_state), + state: record.billing_address_state, line3: record.billing_address_line3, - zip: Some(record.billing_address_zip), - first_name: Some(record.billing_address_first_name), - last_name: Some(record.billing_address_last_name), + zip: record.billing_address_zip, + first_name: record.billing_address_first_name, + last_name: record.billing_address_last_name, }), metadata: None, }, diff --git a/crates/payment_methods/src/core/migration/payment_methods.rs b/crates/payment_methods/src/core/migration/payment_methods.rs index 10808f08a25..5c30698f615 100644 --- a/crates/payment_methods/src/core/migration/payment_methods.rs +++ b/crates/payment_methods/src/core/migration/payment_methods.rs @@ -184,7 +184,7 @@ pub async fn populate_bin_details_for_masked_card( card_number.peek(), ) .change_context(errors::ApiErrorResponse::InvalidRequestData { - message: "Invalid card number".to_string(), + message: "Invalid masked card number".to_string(), })?; let card_bin_details = if card_details.card_issuer.is_some() @@ -223,7 +223,7 @@ impl let (card_isin, last4_digits) = get_card_bin_and_last4_digits_for_masked_card(card_details.card_number.peek()) .change_context(errors::ApiErrorResponse::InvalidRequestData { - message: "Invalid card number".to_string(), + message: "Invalid masked card number".to_string(), })?; if let Some(card_bin_info) = card_info { Ok(Self { @@ -298,7 +298,7 @@ impl let (card_isin, last4_digits) = get_card_bin_and_last4_digits_for_masked_card(card_details.card_number.peek()) .change_context(errors::ApiErrorResponse::InvalidRequestData { - message: "Invalid card number".to_string(), + message: "Invalid masked card number".to_string(), })?; if let Some(card_bin_info) = card_info { Ok(Self {

2025-06-23T19:23:01Z

## Type of Change  - [ ] Bugfix - [ ] New feature - [ ] Enhancement - [x] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description This PR includes changes to make billing details related fields optional during batched operation of data migration. ### Additional Changes - [x] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context Allows merchants who use connectors which does not mandate address fields to be present during a payment txn to be able to migrate their data. Billing details will not be mandated during batched operation of data migration. ## How did you test it? 1. Create MCA <details> <summary>2. Run batch migration</summary> cURL curl --location --request POST 'http://localhost:8080/payment_methods/migrate-batch' \ --header 'api-key: test_admin' \ --form 'merchant_id="merchant_1750764063"' \ --form 'merchant_connector_id="mca_F0qqizsBSwbZ77gQYLRs"' \ --form 'file=@"sample.csv"' Response [{"line_number":1,"payment_method_id":"pm_wY7TUBMPZZISgu2Zf74M","payment_method":"card","payment_method_type":"debit","customer_id":"45CC60D1F2283097BB1DE41A2636414445908518D50B8B4CDC57959CD7FB4539","migration_status":"Success","card_number_masked":"4360000 xxxx 0005","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":2,"payment_method_id":"pm_gNTfSTNVhvlURJPnsiYQ","payment_method":"card","payment_method_type":"credit","customer_id":"782BC898951D910C1A99DA69A4E4FAD6CEE53AB9311FA2C552028DA89428DB7F","migration_status":"Success","card_number_masked":"4111111 xxxx 1111","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":3,"payment_method_id":"pm_EeJ2hgF3OmHgTFEfe58X","payment_method":"card","payment_method_type":"credit","customer_id":"C81CC958611A803D9CC3E2E7818A1691943E3143E6DF603A7F45E55BA7629938","migration_status":"Success","card_number_masked":"222300 xxxx 0010","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":4,"payment_method_id":"pm_p1ckEakoWB12EtHYtjtm","payment_method":"card","payment_method_type":"credit","customer_id":"9F4BB23B3ED615753F5A27CF6D75274713B30A67ACFEA7CE44B058F6AC044E33","migration_status":"Success","card_number_masked":"5555555 xxxx 4444","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":5,"payment_method_id":"pm_0HrpkOfnLuIPSJiU3fdZ","payment_method":"card","payment_method_type":"debit","customer_id":"B22BFDD8BB5840B5F6EE0026A430B72359C50E631C7A2D9D2BC014BDB1EB212C","migration_status":"Success","card_number_masked":"222300 xxxx 0010","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":6,"payment_method_id":"pm_iOtdYdcOErhUz4bXmZgX","payment_method":"card","payment_method_type":"credit","customer_id":"EECB88827D346EDCFB9AB7302B0C387C42FB5EBAD87EC0E4FA4301F6148BB22B","migration_status":"Success","card_number_masked":"557700 xxxx 0004","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":7,"payment_method_id":"pm_JnzwASYJStJUQ02LEcqf","payment_method":"card","payment_method_type":"credit","customer_id":"C81CC958611A803D9CC3E2E7818A1691943E3143E6DF603A7F45E55BA7629938","migration_status":"Success","card_number_masked":"222241 xxxx 0002","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":8,"payment_method_id":"pm_CJsKWoBsOqkRlikFMO2t","payment_method":"card","payment_method_type":"credit","customer_id":"66C96C852E423B701EF06C5109C40D72E77B4C7F4CDD108AD4FCC3DCCC38AB2F","migration_status":"Success","card_number_masked":"513029 xxxx 0009","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":9,"payment_method_id":"pm_z0jFnOfXn1andQp9qbXd","payment_method":"card","payment_method_type":"credit","customer_id":"C81CC958611A803D9CC3E2E7818A1691943E3143E6DF603A7F45E55BA7629938","migration_status":"Success","card_number_masked":"510322 xxxx 9245","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":10,"payment_method_id":"pm_4lJAPwuf8iepQCWKDub1","payment_method":"card","payment_method_type":"credit","customer_id":"C81CC958611A803D9CC3E2E7818A1691943E3143E6DF603A7F45E55BA7629938","migration_status":"Success","card_number_masked":"222241 xxxx 0002","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":11,"payment_method_id":"pm_J1ZMlj5lzHyf2P5Lid6S","payment_method":"card","payment_method_type":"credit","customer_id":"ADE2795AC3C88525528F0DB95677BE9DB27E792850B1A67CA654BFFAEB31AFE3","migration_status":"Success","card_number_masked":"222241 xxxx 0018","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":12,"payment_method_id":"pm_zySRb0JCNxcCMH2Ubocc","payment_method":"card","payment_method_type":"credit","customer_id":"ADE2795AC3C88525528F0DB95677BE9DB27E792850B1A67CA654BFFAEB31AFE3","migration_status":"Success","card_number_masked":"411111 xxxx 1111","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":13,"payment_method_id":"pm_M9wKyu4kEYNcHIjyrVfI","payment_method":"card","payment_method_type":"credit","customer_id":"D83D0437F8883C26C75C04756D95E21B90877020743EA1C1CC49883A90E8DF97","migration_status":"Success","card_number_masked":"411111 xxxx 1111","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":14,"payment_method_id":"pm_RDiPAalAZkCj1uOqKYSb","payment_method":"card","payment_method_type":"credit","customer_id":"ADE2795AC3C88525528F0DB95677BE9DB27E792850B1A67CA654BFFAEB31AFE3","migration_status":"Success","card_number_masked":"624303 xxxx 0001","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":15,"payment_method_id":"pm_0XTr9lrG6LGNl9d4iFPR","payment_method":"card","payment_method_type":"debit","customer_id":"ADE2795AC3C88525528F0DB95677BE9DB27E792850B1A67CA654BFFAEB31AFE3","migration_status":"Success","card_number_masked":"222241 xxxx 0002","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":16,"payment_method_id":"pm_aUtJIRDcCH7CIwJ2hQEk","payment_method":"card","payment_method_type":"credit","customer_id":"D83D0437F8883C26C75C04756D95E21B90877020743EA1C1CC49883A90E8DF97","migration_status":"Success","card_number_masked":"817199 xxxx 0000","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":17,"payment_method_id":"pm_THz5Ds8VHAgyJPPOA4GY","payment_method":"card","payment_method_type":"credit","customer_id":"D83D0437F8883C26C75C04756D95E21B90877020743EA1C1CC49883A90E8DF97","migration_status":"Success","card_number_masked":"464646 xxxx 4644","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":18,"payment_method_id":"pm_l82mYW4tMsRkJF4hq5fn","payment_method":"card","payment_method_type":"credit","customer_id":"ADE2795AC3C88525528F0DB95677BE9DB27E792850B1A67CA654BFFAEB31AFE3","migration_status":"Success","card_number_masked":"222240 xxxx 0007","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":19,"payment_method_id":"pm_E8fkAc9RHknoPmnYFBOa","payment_method":"card","payment_method_type":"debit","customer_id":"ADE2795AC3C88525528F0DB95677BE9DB27E792850B1A67CA654BFFAEB31AFE3","migration_status":"Success","card_number_masked":"400006 xxxx 0006","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":20,"payment_method_id":"pm_TEEJO7DdZTkl55PH8P1T","payment_method":"card","payment_method_type":"credit","customer_id":"D83D0437F8883C26C75C04756D95E21B90877020743EA1C1CC49883A90E8DF97","migration_status":"Success","card_number_masked":"497794 xxxx 9497","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":21,"payment_method_id":"pm_3gTcA4MJsTjasj2XlJs2","payment_method":"card","payment_method_type":"credit","customer_id":"C81CC958611A803D9CC3E2E7818A1691943E3143E6DF603A7F45E55BA7629938","migration_status":"Success","card_number_masked":"436000 xxxx 0005","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null},{"line_number":22,"payment_method_id":"pm_GzUYGU3GpOXOIkWFRkM0","payment_method":"card","payment_method_type":"credit","customer_id":"C80162F403CCA7AF1CB6732291D6D53B88636BB6A9B82D2CD43AC30775925B4F","migration_status":"Success","card_number_masked":"222241 xxxx 0002","card_migrated":null,"network_token_migrated":true,"connector_mandate_details_migrated":true,"network_transaction_id_migrated":null}] </details> ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.114.0

a3cc44c6e15ce69f39104b2ce205bed632e3971e

juspay/hyperswitch

juspay__hyperswitch-8435

Bug: [FEAT] Implement Refund for JPMorgan this connector lacks basic feature i.e., refunds. relevant docs: - https://developer.payments.jpmorgan.com/api/commerce/online-payments/overview - https://developer.payments.jpmorgan.com/api/commerce/online-payments/online-payments/online-payments#/operations/V2RefundPost

diff --git a/crates/hyperswitch_connectors/src/connectors/jpmorgan.rs b/crates/hyperswitch_connectors/src/connectors/jpmorgan.rs index 9783324c042..043f140a174 100644 --- a/crates/hyperswitch_connectors/src/connectors/jpmorgan.rs +++ b/crates/hyperswitch_connectors/src/connectors/jpmorgan.rs @@ -665,9 +665,9 @@ impl ConnectorIntegration<Execute, RefundsData, RefundsResponseData> for Jpmorga fn get_url( &self, _req: &RefundsRouterData<Execute>, - _connectors: &Connectors, + connectors: &Connectors, ) -> CustomResult<String, errors::ConnectorError> { - Err(errors::ConnectorError::NotImplemented("Refunds".to_string()).into()) + Ok(format!("{}/refunds", self.base_url(connectors))) } fn get_request_body( diff --git a/crates/hyperswitch_connectors/src/connectors/jpmorgan/transformers.rs b/crates/hyperswitch_connectors/src/connectors/jpmorgan/transformers.rs index 9f253c0ffb7..0c2f6110f30 100644 --- a/crates/hyperswitch_connectors/src/connectors/jpmorgan/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/jpmorgan/transformers.rs @@ -272,18 +272,10 @@ pub struct JpmorganPaymentsResponse { #[serde(rename_all = "camelCase")] pub struct Merchant { merchant_id: Option<String>, - merchant_software: MerchantSoftware, + merchant_software: JpmorganMerchantSoftware, merchant_category_code: Option<String>, } -#[derive(Default, Debug, Serialize, Deserialize)] -#[serde(rename_all = "camelCase")] -pub struct MerchantSoftware { - company_name: Secret<String>, - product_name: Secret<String>, - version: Option<Secret<String>>, -} - #[derive(Default, Debug, Deserialize, Serialize)] #[serde(rename_all = "camelCase")] pub struct PaymentMethodType { @@ -522,18 +514,31 @@ pub struct TransactionData { pub struct JpmorganRefundRequest { pub merchant: MerchantRefundReq, pub amount: MinorUnit, + pub currency: common_enums::Currency, } #[derive(Default, Debug, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct MerchantRefundReq { - pub merchant_software: MerchantSoftware, + pub merchant_software: JpmorganMerchantSoftware, } impl<F> TryFrom<&JpmorganRouterData<&RefundsRouterData<F>>> for JpmorganRefundRequest { type Error = error_stack::Report<errors::ConnectorError>; - fn try_from(_item: &JpmorganRouterData<&RefundsRouterData<F>>) -> Result<Self, Self::Error> { - Err(errors::ConnectorError::NotImplemented("Refunds".to_string()).into()) + fn try_from(item: &JpmorganRouterData<&RefundsRouterData<F>>) -> Result<Self, Self::Error> { + let merchant_software = JpmorganMerchantSoftware { + company_name: String::from("JPMC").into(), + product_name: String::from("Hyperswitch").into(), + }; + let merchant = MerchantRefundReq { merchant_software }; + let amount = item.amount; + let currency = item.router_data.request.currency; + + Ok(Self { + merchant, + amount, + currency, + }) } } @@ -552,7 +557,6 @@ pub struct JpmorganRefundResponse { pub remaining_refundable_amount: Option<i64>, } -#[allow(dead_code)] #[derive(Debug, Serialize, Default, Deserialize, Clone)] pub enum RefundStatus { Succeeded, @@ -571,24 +575,23 @@ impl From<RefundStatus> for common_enums::RefundStatus { } } -#[derive(Default, Debug, Clone, Serialize, Deserialize)] -pub struct RefundResponse { - id: String, - status: RefundStatus, -} - -pub fn refund_status_from_transaction_state( - transaction_state: JpmorganTransactionState, -) -> common_enums::RefundStatus { - match transaction_state { - JpmorganTransactionState::Voided | JpmorganTransactionState::Closed => { - common_enums::RefundStatus::Success - } - JpmorganTransactionState::Declined | JpmorganTransactionState::Error => { - common_enums::RefundStatus::Failure - } - JpmorganTransactionState::Pending | JpmorganTransactionState::Authorized => { - common_enums::RefundStatus::Pending +impl From<(JpmorganResponseStatus, JpmorganTransactionState)> for RefundStatus { + fn from( + (response_status, transaction_state): (JpmorganResponseStatus, JpmorganTransactionState), + ) -> Self { + match response_status { + JpmorganResponseStatus::Success => match transaction_state { + JpmorganTransactionState::Voided | JpmorganTransactionState::Closed => { + Self::Succeeded + } + JpmorganTransactionState::Declined | JpmorganTransactionState::Error => { + Self::Failed + } + JpmorganTransactionState::Pending | JpmorganTransactionState::Authorized => { + Self::Processing + } + }, + JpmorganResponseStatus::Denied | JpmorganResponseStatus::Error => Self::Failed, } } } @@ -607,9 +610,11 @@ impl TryFrom<RefundsResponseRouterData<Execute, JpmorganRefundResponse>> .transaction_id .clone() .ok_or(errors::ConnectorError::ResponseHandlingFailed)?, - refund_status: refund_status_from_transaction_state( + refund_status: RefundStatus::from(( + item.response.response_status, item.response.transaction_state, - ), + )) + .into(), }), ..item.data }) @@ -638,9 +643,11 @@ impl TryFrom<RefundsResponseRouterData<RSync, JpmorganRefundSyncResponse>> Ok(Self { response: Ok(RefundsResponseData { connector_refund_id: item.response.transaction_id.clone(), - refund_status: refund_status_from_transaction_state( + refund_status: RefundStatus::from(( + item.response.response_status, item.response.transaction_state, - ), + )) + .into(), }), ..item.data })

2025-06-23T17:30:48Z

## Type of Change  - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [x] CI/CD ## Description  This PR implements refund flow for JPMorgan connector. Connector returns `Authorized` state (`Pending`). Post RSync call, the status gets updated to `Success`. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  The connector lacked this basic feature until now. Closes #8435 ## How did you test it?  Updated Cypress tests: <img width="558" alt="image" src="https://github.com/user-attachments/assets/cb18d34e-d6d2-4145-8e94-773ab6638389" /> There exist an issue from the connector where it returns same `transaction_id` (`connector_transaction_id`) every single time which we have no control. Because of this, refunds tend to exceed the maximum refundable amount resulting in 4xx as shown below: <img width="557" alt="image" src="https://github.com/user-attachments/assets/549c517b-cc54-4114-b034-5df64783bd68" /> <img width="477" alt="image" src="https://github.com/user-attachments/assets/47018470-5798-4a07-b480-1f0694540d68" /> ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `just clippy && jut clippy_v2` - [x] I reviewed the submitted code - [x] I added unit tests for my changes where possible

v1.114.0

786fe699c2abd1a3eb752121a1915acd2012d94a

juspay/hyperswitch

juspay__hyperswitch-8430

Bug: [BUG] adyen connector creates connector's customer reference on the fly ### Bug Description Connector's customer ID is a unique identifier for a customer's entity in the underlying connector for HyperSwitch for mapping a customer. This identifier is stored under `connector_customer` in `customers` table. However, for Adyen - this field is a combination of merchant ID and customer ID in HyperSwitch which is unique across different merchants and customers. This is a blocker for migrated customers whose `shopperReference` (customer ID in Adyen) can be in a different format. ### Expected Behavior Adyen should rely on the `connector_customer` field for customer and fallback to any default connector specific behavior. ### Actual Behavior Adyen uses a default behavior for generating `connector_customer_id` ### Steps To Reproduce -- ### Context For The Bug -- ### Environment -- ### Have you spent some time checking if this bug has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? None

diff --git a/config/config.example.toml b/config/config.example.toml index 040e027dcf9..08589cbcc65 100644 --- a/config/config.example.toml +++ b/config/config.example.toml @@ -827,7 +827,7 @@ credit = {country = "AU,NZ,CN,HK,IN,LK,KR,MY,SG,GB,BE,FR,DE,IT,ME,NL,PL,ES,ZA,AR debit = {country = "AU,NZ,CN,HK,IN,LK,KR,MY,SG,GB,BE,FR,DE,IT,ME,NL,PL,ES,ZA,AR,BR,CO,MX,PA,UY,US,CA", currency = "AFN,ALL,DZD,AOA,ARS,AMD,AWG,AUD,AZN,BSD,BHD,BDT,BBD,BYN,BZD,BMD,BTN,BOB,VES,BAM,BWP,BRL,BND,BGN,BIF,KHR,CAD,CVE,KYD,XAF,CLP,CNY,COP,KMF,CDF,CRC,HRK,CUP,CZK,DKK,DJF,DOP,XCD,EGP,ERN,ETB,EUR,FKP,FJD,XPF,GMD,GEL,GHS,GIP,GTQ,GNF,GYD,HTG,HNL,HKD,HUF,ISK,INR,IDR,IRR,IQD,ILS,JMD,JPY,JOD,KZT,KES,KGS,KWD,LAK,LBP,LSL,LRD,LYD,MOP,MKD,MGA,MWK,MYR,MVR,MRU,MUR,MXN,MDL,MNT,MAD,MZN,MMK,NAD,NPR,ANG,NZD,NIO,NGN,VUV,KPW,NOK,OMR,PKR,PAB,PGK,PYG,PEN,PHP,PLN,GBP,QAR,RON,RUB,RWF,SHP,SVC,WST,STN,SAR,RSD,SCR,SLL,SGD,SBD,SOS,ZAR,KRW,SSP,LKR,SDG,SRD,SZL,SEK,CHF,SYP,TWD,TJS,TZS,THB,TOP,TTD,TND,TRY,TMT,UGX,UAH,AED,USD,UYU,UZS,VND,XOF,YER,ZMW,ZWL"} [connector_customer] -connector_list = "gocardless,stax,stripe,facilitapay,hyperswitch_vault" +connector_list = "adyen,facilitapay,gocardless,hyperswitch_vault,stax,stripe" payout_connector_list = "nomupay,stripe,wise" [bank_config.online_banking_fpx] diff --git a/config/deployments/integration_test.toml b/config/deployments/integration_test.toml index 513cb587176..f4c3e3815d0 100644 --- a/config/deployments/integration_test.toml +++ b/config/deployments/integration_test.toml @@ -174,7 +174,7 @@ force_cookies = true enabled = true [connector_customer] -connector_list = "gocardless,stax,stripe,facilitapay,hyperswitch_vault" +connector_list = "adyen,facilitapay,gocardless,hyperswitch_vault,stax,stripe" payout_connector_list = "nomupay,stripe,wise" [delayed_session_response] diff --git a/config/deployments/production.toml b/config/deployments/production.toml index 4b990ad0464..23f5c72e3cd 100644 --- a/config/deployments/production.toml +++ b/config/deployments/production.toml @@ -15,7 +15,7 @@ open_banking_uk.adyen.banks = "aib,bank_of_scotland,danske_bank,first_direct,fir przelewy24.stripe.banks = "alior_bank,bank_millennium,bank_nowy_bfg_sa,bank_pekao_sa,banki_spbdzielcze,blik,bnp_paribas,boz,citi,credit_agricole,e_transfer_pocztowy24,getin_bank,idea_bank,inteligo,mbank_mtransfer,nest_przelew,noble_pay,pbac_z_ipko,plus_bank,santander_przelew24,toyota_bank,volkswagen_bank" [connector_customer] -connector_list = "stax,stripe,gocardless,facilitapay,hyperswitch_vault" +connector_list = "adyen,facilitapay,gocardless,hyperswitch_vault,stax,stripe" payout_connector_list = "nomupay,stripe,wise" # Connector configuration, provided attributes will be used to fulfill API requests. diff --git a/config/deployments/sandbox.toml b/config/deployments/sandbox.toml index d00b12c751f..e09aa5f88fd 100644 --- a/config/deployments/sandbox.toml +++ b/config/deployments/sandbox.toml @@ -15,7 +15,7 @@ open_banking_uk.adyen.banks = "aib,bank_of_scotland,danske_bank,first_direct,fir przelewy24.stripe.banks = "alior_bank,bank_millennium,bank_nowy_bfg_sa,bank_pekao_sa,banki_spbdzielcze,blik,bnp_paribas,boz,citi,credit_agricole,e_transfer_pocztowy24,getin_bank,idea_bank,inteligo,mbank_mtransfer,nest_przelew,noble_pay,pbac_z_ipko,plus_bank,santander_przelew24,toyota_bank,volkswagen_bank" [connector_customer] -connector_list = "stax,stripe,gocardless,facilitapay,hyperswitch_vault" +connector_list = "adyen,facilitapay,gocardless,hyperswitch_vault,stax,stripe" payout_connector_list = "nomupay,stripe,wise" # Connector configuration, provided attributes will be used to fulfill API requests. diff --git a/config/development.toml b/config/development.toml index 95484d6b014..8107dce3886 100644 --- a/config/development.toml +++ b/config/development.toml @@ -872,7 +872,7 @@ nexixpay = { payment_method = "card" } redsys = { payment_method = "card" } [connector_customer] -connector_list = "gocardless,stax,stripe,facilitapay,hyperswitch_vault" +connector_list = "adyen,facilitapay,gocardless,hyperswitch_vault,stax,stripe" payout_connector_list = "nomupay,stripe,wise" [dummy_connector] diff --git a/config/docker_compose.toml b/config/docker_compose.toml index b029fb9987f..484dd76097a 100644 --- a/config/docker_compose.toml +++ b/config/docker_compose.toml @@ -883,7 +883,7 @@ card.debit = { connector_list = "cybersource" } connector_list = "adyen,archipel,cybersource,novalnet,stripe,worldpay" [connector_customer] -connector_list = "gocardless,stax,stripe,facilitapay,hyperswitch_vault" +connector_list = "adyen,facilitapay,gocardless,hyperswitch_vault,stax,stripe" payout_connector_list = "nomupay,stripe,wise" diff --git a/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs b/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs index c78daba6c4e..504635fe070 100644 --- a/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs @@ -1765,29 +1765,31 @@ type RecurringDetails = (Option<AdyenRecurringModel>, Option<bool>, Option<Strin fn get_recurring_processing_model( item: &PaymentsAuthorizeRouterData, ) -> Result<RecurringDetails, Error> { - match (item.request.setup_future_usage, item.request.off_session) { - (Some(storage_enums::FutureUsage::OffSession), _) => { + let shopper_reference = match item.get_connector_customer_id() { + Ok(connector_customer_id) => Some(connector_customer_id), + Err(_) => { let customer_id = item.get_customer_id()?; - let shopper_reference = format!( + Some(format!( "{}_{}", item.merchant_id.get_string_repr(), customer_id.get_string_repr() - ); + )) + } + }; + + match (item.request.setup_future_usage, item.request.off_session) { + (Some(storage_enums::FutureUsage::OffSession), _) => { let store_payment_method = item.request.is_mandate_payment(); Ok(( Some(AdyenRecurringModel::UnscheduledCardOnFile), Some(store_payment_method), - Some(shopper_reference), + shopper_reference, )) } (_, Some(true)) => Ok(( Some(AdyenRecurringModel::UnscheduledCardOnFile), None, - Some(format!( - "{}_{}", - item.merchant_id.get_string_repr(), - item.get_customer_id()?.get_string_repr() - )), + shopper_reference, )), _ => Ok((None, None, None)), } @@ -1967,17 +1969,18 @@ fn get_social_security_number(voucher_data: &VoucherData) -> Option<Secret<Strin } } -fn build_shopper_reference( - customer_id: &Option<common_utils::id_type::CustomerId>, - merchant_id: common_utils::id_type::MerchantId, -) -> Option<String> { - customer_id.clone().map(|c_id| { - format!( - "{}_{}", - merchant_id.get_string_repr(), - c_id.get_string_repr() - ) - }) +fn build_shopper_reference(item: &PaymentsAuthorizeRouterData) -> Option<String> { + match item.get_connector_customer_id() { + Ok(connector_customer_id) => Some(connector_customer_id), + Err(_) => match item.get_customer_id() { + Ok(customer_id) => Some(format!( + "{}_{}", + item.merchant_id.get_string_repr(), + customer_id.get_string_repr() + )), + Err(_) => None, + }, + } } impl TryFrom<(&BankDebitData, &PaymentsAuthorizeRouterData)> for AdyenPaymentMethod<'_> { @@ -2898,10 +2901,7 @@ impl TryFrom<(&AdyenRouterData<&PaymentsAuthorizeRouterData>, &Card)> for AdyenP let amount = get_amount_data(item); let auth_type = AdyenAuthType::try_from(&item.router_data.connector_auth_type)?; let shopper_interaction = AdyenShopperInteraction::from(item.router_data); - let shopper_reference = build_shopper_reference( - &item.router_data.customer_id, - item.router_data.merchant_id.clone(), - ); + let shopper_reference = build_shopper_reference(item.router_data); let (recurring_processing_model, store_payment_method, _) = get_recurring_processing_model(item.router_data)?; let browser_info = get_browser_info(item.router_data)?; @@ -3506,10 +3506,7 @@ impl let additional_data = get_additional_data(item.router_data); let country_code = get_country_code(item.router_data.get_optional_billing()); let shopper_interaction = AdyenShopperInteraction::from(item.router_data); - let shopper_reference = build_shopper_reference( - &item.router_data.customer_id, - item.router_data.merchant_id.clone(), - ); + let shopper_reference = build_shopper_reference(item.router_data); let (recurring_processing_model, store_payment_method, _) = get_recurring_processing_model(item.router_data)?; let return_url = item.router_data.request.get_router_return_url()?; @@ -5822,10 +5819,7 @@ impl let amount = get_amount_data(item); let auth_type = AdyenAuthType::try_from(&item.router_data.connector_auth_type)?; let shopper_interaction = AdyenShopperInteraction::from(item.router_data); - let shopper_reference = build_shopper_reference( - &item.router_data.customer_id, - item.router_data.merchant_id.clone(), - ); + let shopper_reference = build_shopper_reference(item.router_data); let (recurring_processing_model, store_payment_method, _) = get_recurring_processing_model(item.router_data)?; let browser_info = get_browser_info(item.router_data)?; diff --git a/loadtest/config/development.toml b/loadtest/config/development.toml index 5a59523eeb3..b82746362d0 100644 --- a/loadtest/config/development.toml +++ b/loadtest/config/development.toml @@ -554,7 +554,7 @@ gocardless = { long_lived_token = true, payment_method = "bank_debit" } billwerk = { long_lived_token = false, payment_method = "card" } [connector_customer] -connector_list = "gocardless,stax,stripe,facilitapay,hyperswitch_vault" +connector_list = "adyen,facilitapay,gocardless,hyperswitch_vault,stax,stripe" payout_connector_list = "nomupay,wise" [dummy_connector]

2025-06-24T10:42:43Z

## Type of Change  - [ ] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  Adyen now uses `connector_customer_id` to form `shopper_reference` if the field is present, else falls to previous implementation. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  ## How did you test it?  <img width="1081" alt="Screenshot 2025-06-24 at 4 01 08 PM" src="https://github.com/user-attachments/assets/08ad7563-b19a-41a5-8729-74aa3b5f6295" /> ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.114.0

bc767b9131e2637ce90997da9018085d2dadb80b

juspay/hyperswitch

juspay__hyperswitch-8440

Bug: [FEATURE] Implement V2 UCS (Unified Connector Service) Integration for Authorization Flow ### Feature Description # [Feature Request] Implement V2 UCS (Unified Connector Service) Integration for Authorization Flow ## Issue Type - [x] Feature Request - [ ] Bug Report - [ ] Enhancement - [ ] Documentation ## Priority - [x] High - [ ] Medium - [ ] Low ## Labels `A-core` `C-feature` `payment-flows` `ucs-integration` `v2-api` ## Summary Implement V2 UCS (Unified Connector Service) integration for the authorization payment flow, upgrading from the existing V1 UCS integration to support the updated gRPC schema and enhanced V2 payment architecture. ## Background Currently, Hyperswitch has V1 UCS integration that works with the legacy gRPC schema. However, the UCS service has evolved to V2 with improved: - Enhanced gRPC schema with better type safety - Improved field structures for card details, addresses, and identifiers - Better error handling and response parsing - Enhanced payment method data transformation ## Problem Statement ### Current State - V1 UCS integration uses outdated `PaymentsAuthorizeRequest` schema - Limited support for V2 payment flow architecture - Outdated transformer implementations for V2 data structures - Monolithic UCS function structure affecting maintainability ### Pain Points 1. **Schema Incompatibility**: V1 gRPC schema doesn't support V2 enhanced data models 2. **Limited Error Handling**: V1 response parsing lacks V2 identifier structure support 3. **Technical Debt**: Monolithic UCS functions make debugging and enhancement difficult 4. **Missing V2 Features**: Cannot leverage V2 payment flow improvements through UCS ### Possible Implementation ## Proposed Solution ### High-Level Approach Implement V2 UCS integration that: 1. **Updates gRPC Schema**: Migrate to `PaymentServiceAuthorizeRequest` with V2 field structure 2. **Enhances Architecture**: Refactor payment flow with better separation of concerns 3. **Improves Transformers**: Update V2 transformers for new schema compatibility 4. **Maintains Backward Compatibility**: Preserve V1 integration with feature flag separation ### Technical Requirements #### 1. gRPC Schema Migration - [ ] Update `rust-grpc-client` dependency to latest version - [ ] Migrate from `PaymentsAuthorizeRequest` to `PaymentServiceAuthorizeRequest` - [ ] Update authentication headers and request metadata handling - [ ] Implement new identifier structure for response parsing #### 2. Payment Flow Architecture - [ ] Refactor `call_connector_service()` into separate prerequisite and decision functions - [ ] Implement `call_connector_service_prerequisites()` for V2 flow preparation - [ ] Create `decide_unified_connector_service_call()` for UCS routing logic - [ ] Maintain feature flag separation between V1 and V2 implementations #### 3. V2 Transformer Enhancements - [ ] Update card data transformation for new schema structure - [ ] Enhance address handling with improved field mapping - [ ] Implement customer ID support in V2 transformers #### 4. Error Handling & Response Parsing - [ ] Update response handlers for new identifier structure - [ ] Enhance error context and fallback mechanisms - [ ] Maintain automatic fallback to traditional connector flow #### 5. Testing & Validation - [ ] Create comprehensive test cases for V2 UCS flow - [ ] Test schema compatibility and field mapping - [ ] Validate fallback mechanisms and error handling ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? Yes, I am willing to submit a PR!

diff --git a/Cargo.lock b/Cargo.lock index 848ccc6648f..f3ab37bbb5b 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1651,6 +1651,20 @@ dependencies = [ "thiserror 1.0.69", ] +[[package]] +name = "cargo_metadata" +version = "0.19.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dd5eb614ed4c27c5d706420e4320fbe3216ab31fa1c33cd8246ac36dae4479ba" +dependencies = [ + "camino", + "cargo-platform", + "semver 1.0.26", + "serde", + "serde_json", + "thiserror 2.0.12", +] + [[package]] name = "cast" version = "0.3.0" @@ -3347,13 +3361,18 @@ dependencies = [ [[package]] name = "g2h" -version = "0.2.0" +version = "0.4.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "312ad594dd0e3c26f860a52c8b703ab509c546931920f277f1afa9b7127fd755" +checksum = "0aece561ff748cdd2a37c8ee938a47bbf9b2c03823b393a332110599b14ee827" dependencies = [ + "cargo_metadata 0.19.2", "heck 0.5.0", + "proc-macro2", + "prost", "prost-build", + "prost-types", "quote", + "thiserror 2.0.12", "tonic-build", ] @@ -3506,7 +3525,7 @@ dependencies = [ [[package]] name = "grpc-api-types" version = "0.1.0" -source = "git+https://github.com/juspay/connector-service?rev=afaef3427f815befe253da152e5f37d3858bbc9f#afaef3427f815befe253da152e5f37d3858bbc9f" +source = "git+https://github.com/juspay/connector-service?rev=4918efedd5ea6c33e4a1600b988b2cf4948bed10#4918efedd5ea6c33e4a1600b988b2cf4948bed10" dependencies = [ "axum 0.8.4", "error-stack 0.5.0", @@ -6827,7 +6846,7 @@ dependencies = [ name = "router_env" version = "0.1.0" dependencies = [ - "cargo_metadata", + "cargo_metadata 0.18.1", "config", "error-stack 0.4.1", "gethostname", @@ -6880,7 +6899,7 @@ dependencies = [ [[package]] name = "rust-grpc-client" version = "0.1.0" -source = "git+https://github.com/juspay/connector-service?rev=afaef3427f815befe253da152e5f37d3858bbc9f#afaef3427f815befe253da152e5f37d3858bbc9f" +source = "git+https://github.com/juspay/connector-service?rev=4918efedd5ea6c33e4a1600b988b2cf4948bed10#4918efedd5ea6c33e4a1600b988b2cf4948bed10" dependencies = [ "grpc-api-types", ] @@ -9501,7 +9520,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "2990d9ea5967266ea0ccf413a4aa5c42a93dbcfda9cb49a97de6931726b12566" dependencies = [ "anyhow", - "cargo_metadata", + "cargo_metadata 0.18.1", "cfg-if 1.0.0", "git2", "regex", diff --git a/crates/external_services/Cargo.toml b/crates/external_services/Cargo.toml index 906f8e9b596..30ee8ee5a2c 100644 --- a/crates/external_services/Cargo.toml +++ b/crates/external_services/Cargo.toml @@ -53,7 +53,7 @@ reqwest = { version = "0.11.27", features = ["rustls-tls"] } http = "0.2.12" url = { version = "2.5.4", features = ["serde"] } quick-xml = { version = "0.31.0", features = ["serialize"] } -unified-connector-service-client = { git = "https://github.com/juspay/connector-service", rev = "afaef3427f815befe253da152e5f37d3858bbc9f", package = "rust-grpc-client" } +unified-connector-service-client = { git = "https://github.com/juspay/connector-service", rev = "4918efedd5ea6c33e4a1600b988b2cf4948bed10", package = "rust-grpc-client" } # First party crates diff --git a/crates/external_services/src/grpc_client/unified_connector_service.rs b/crates/external_services/src/grpc_client/unified_connector_service.rs index 0ad9602985d..5a4a912b798 100644 --- a/crates/external_services/src/grpc_client/unified_connector_service.rs +++ b/crates/external_services/src/grpc_client/unified_connector_service.rs @@ -84,6 +84,10 @@ pub enum UnifiedConnectorServiceError { /// Failed to perform Payment Authorize from gRPC Server #[error("Failed to perform Payment Authorize from gRPC Server")] PaymentAuthorizeFailure, + + /// Failed to perform Payment Get from gRPC Server + #[error("Failed to perform Payment Get from gRPC Server")] + PaymentGetFailure, } /// Result type for Dynamic Routing @@ -191,6 +195,28 @@ impl UnifiedConnectorServiceClient { .change_context(UnifiedConnectorServiceError::PaymentAuthorizeFailure) .inspect_err(|error| logger::error!(?error)) } + + /// Performs Payment Sync/Get + pub async fn payment_get( + &self, + payment_get_request: payments_grpc::PaymentServiceGetRequest, + connector_auth_metadata: ConnectorAuthMetadata, + grpc_headers: GrpcHeaders, + ) -> UnifiedConnectorServiceResult<tonic::Response<payments_grpc::PaymentServiceGetResponse>> + { + let mut request = tonic::Request::new(payment_get_request); + + let metadata = + build_unified_connector_service_grpc_headers(connector_auth_metadata, grpc_headers)?; + *request.metadata_mut() = metadata; + + self.client + .clone() + .get(request) + .await + .change_context(UnifiedConnectorServiceError::PaymentGetFailure) + .inspect_err(|error| logger::error!(?error)) + } } /// Build the gRPC Headers for Unified Connector Service Request diff --git a/crates/hyperswitch_domain_models/src/merchant_connector_account.rs b/crates/hyperswitch_domain_models/src/merchant_connector_account.rs index 92ec2f51de2..1e460ee7306 100644 --- a/crates/hyperswitch_domain_models/src/merchant_connector_account.rs +++ b/crates/hyperswitch_domain_models/src/merchant_connector_account.rs @@ -163,7 +163,9 @@ impl MerchantConnectorAccountTypeDetails { Self::MerchantConnectorAccount(merchant_connector_account) => { Some(merchant_connector_account.connector_name) } - Self::MerchantConnectorDetails(_) => None, + Self::MerchantConnectorDetails(merchant_connector_details) => { + Some(merchant_connector_details.connector_name) + } } } diff --git a/crates/router/Cargo.toml b/crates/router/Cargo.toml index 585c49ffe18..8b80d22dc2a 100644 --- a/crates/router/Cargo.toml +++ b/crates/router/Cargo.toml @@ -88,7 +88,7 @@ reqwest = { version = "0.11.27", features = ["json", "rustls-tls", "gzip", "mult ring = "0.17.14" rust_decimal = { version = "1.37.1", features = ["serde-with-float", "serde-with-str"] } rust-i18n = { git = "https://github.com/kashif-m/rust-i18n", rev = "f2d8096aaaff7a87a847c35a5394c269f75e077a" } -unified-connector-service-client = { git = "https://github.com/juspay/connector-service", rev = "afaef3427f815befe253da152e5f37d3858bbc9f", package = "rust-grpc-client" } +unified-connector-service-client = { git = "https://github.com/juspay/connector-service", rev = "4918efedd5ea6c33e4a1600b988b2cf4948bed10", package = "rust-grpc-client" } rustc-hash = "1.1.0" rustls = "0.22" rustls-pemfile = "2" diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs index 8a0058b79e4..5319e823614 100644 --- a/crates/router/src/core/payments.rs +++ b/crates/router/src/core/payments.rs @@ -216,7 +216,27 @@ where let (payment_data, connector_response_data) = match connector { ConnectorCallType::PreDetermined(connector_data) => { - let router_data = call_connector_service( + let (mca_type_details, updated_customer, router_data) = + call_connector_service_prerequisites( + state, + req_state.clone(), + &merchant_context, + connector_data.connector_data.clone(), + &operation, + &mut payment_data, + &customer, + call_connector_action.clone(), + None, + header_payload.clone(), + None, + profile, + false, + false, //should_retry_with_pan is set to false in case of PreDetermined ConnectorCallType + req.should_return_raw_response(), + ) + .await?; + + let router_data = decide_unified_connector_service_call( state, req_state.clone(), &merchant_context, @@ -225,16 +245,17 @@ where &mut payment_data, &customer, call_connector_action.clone(), - None, + None, // schedule_time is not used in PreDetermined ConnectorCallType header_payload.clone(), #[cfg(feature = "frm")] None, - #[cfg(not(feature = "frm"))] - None, profile, false, false, //should_retry_with_pan is set to false in case of PreDetermined ConnectorCallType req.should_return_raw_response(), + mca_type_details, + router_data, + updated_customer, ) .await?; @@ -271,7 +292,28 @@ where ConnectorCallType::Retryable(connectors) => { let mut connectors = connectors.clone().into_iter(); let connector_data = get_connector_data(&mut connectors)?; - let router_data = call_connector_service( + + let (mca_type_details, updated_customer, router_data) = + call_connector_service_prerequisites( + state, + req_state.clone(), + &merchant_context, + connector_data.connector_data.clone(), + &operation, + &mut payment_data, + &customer, + call_connector_action.clone(), + None, + header_payload.clone(), + None, + profile, + false, + false, //should_retry_with_pan is set to false in case of Retryable ConnectorCallType + req.should_return_raw_response(), + ) + .await?; + + let router_data = decide_unified_connector_service_call( state, req_state.clone(), &merchant_context, @@ -280,16 +322,17 @@ where &mut payment_data, &customer, call_connector_action.clone(), - None, + None, // schedule_time is not used in Retryable ConnectorCallType header_payload.clone(), #[cfg(feature = "frm")] None, - #[cfg(not(feature = "frm"))] - None, profile, - false, + true, false, //should_retry_with_pan is set to false in case of PreDetermined ConnectorCallType req.should_return_raw_response(), + mca_type_details, + router_data, + updated_customer, ) .await?; @@ -409,17 +452,37 @@ where .get_connector_from_request(state, &req, &mut payment_data) .await?; - let router_data = internal_call_connector_service( + let merchant_connector_account = payment_data + .get_merchant_connector_details() + .map(domain::MerchantConnectorAccountTypeDetails::MerchantConnectorDetails) + .ok_or_else(|| { + error_stack::report!(errors::ApiErrorResponse::InternalServerError) + .attach_printable("Merchant connector details not found in payment data") + })?; + + operation + .to_domain()? + .populate_payment_data( + state, + &mut payment_data, + &merchant_context, + profile, + &connector_data, + ) + .await?; + + let router_data = connector_service_decider( state, req_state.clone(), &merchant_context, - connector_data, + connector_data.clone(), &operation, &mut payment_data, call_connector_action.clone(), header_payload.clone(), profile, req.should_return_raw_response(), + merchant_connector_account, ) .await?; @@ -3508,27 +3571,29 @@ where router_data = router_data.add_session_token(state, &connector).await?; - let mut should_continue_further = access_token::update_router_data_with_access_token_result( + let should_continue_further = access_token::update_router_data_with_access_token_result( &add_access_token_result, &mut router_data, &call_connector_action, ); - let add_create_order_result = router_data + let should_continue_further = match router_data .create_order_at_connector(state, &connector, should_continue_further) - .await?; + .await? + { + Some(create_order_response) => { + if let Ok(order_id) = create_order_response.clone().create_order_result { + payment_data.set_connector_response_reference_id(Some(order_id.clone())) + } - if add_create_order_result.is_create_order_performed { - if let Ok(order_id_opt) = &add_create_order_result.create_order_result { - payment_data.set_connector_response_reference_id(order_id_opt.clone()); + // Set the response in routerdata response to carry forward + router_data + .update_router_data_with_create_order_response(create_order_response.clone()); + create_order_response.create_order_result.ok().is_some() } - should_continue_further = router_data - .update_router_data_with_create_order_result( - add_create_order_result, - should_continue_further, - ) - .await?; - } + // If create order is not required, then we can proceed with further processing + None => true, + }; let updated_customer = call_create_connector_customer_if_required( state, @@ -3948,6 +4013,9 @@ pub async fn call_connector_service<F, RouterDReq, ApiRequest, D>( is_retry_payment: bool, should_retry_with_pan: bool, return_raw_connector_response: Option<bool>, + merchant_connector_account_type_details: domain::MerchantConnectorAccountTypeDetails, + mut router_data: RouterData<F, RouterDReq, router_types::PaymentsResponseData>, + updated_customer: Option<storage::CustomerUpdate>, ) -> RouterResult<RouterData<F, RouterDReq, router_types::PaymentsResponseData>> where F: Send + Clone + Sync, @@ -3961,50 +4029,6 @@ where dyn api::Connector: services::api::ConnectorIntegration<F, RouterDReq, router_types::PaymentsResponseData>, { - let stime_connector = Instant::now(); - - let merchant_connector_account = - domain::MerchantConnectorAccountTypeDetails::MerchantConnectorAccount(Box::new( - helpers::get_merchant_connector_account_v2( - state, - merchant_context.get_merchant_key_store(), - connector.merchant_connector_id.as_ref(), - ) - .await?, - )); - - operation - .to_domain()? - .populate_payment_data( - state, - payment_data, - merchant_context, - business_profile, - &connector, - ) - .await?; - - let updated_customer = call_create_connector_customer_if_required( - state, - customer, - merchant_context, - &merchant_connector_account, - payment_data, - ) - .await?; - - let mut router_data = payment_data - .construct_router_data( - state, - connector.connector.id(), - merchant_context, - customer, - &merchant_connector_account, - None, - None, - ) - .await?; - let add_access_token_result = router_data .add_access_token( state, @@ -4016,37 +4040,43 @@ where router_data = router_data.add_session_token(state, &connector).await?; - let mut should_continue_further = access_token::update_router_data_with_access_token_result( + let should_continue_further = access_token::update_router_data_with_access_token_result( &add_access_token_result, &mut router_data, &call_connector_action, ); - let add_create_order_result = router_data + let should_continue = match router_data .create_order_at_connector(state, &connector, should_continue_further) - .await?; + .await? + { + Some(create_order_response) => { + if let Ok(order_id) = create_order_response.clone().create_order_result { + payment_data.set_connector_response_reference_id(Some(order_id)) + } - if add_create_order_result.is_create_order_performed { - if let Ok(order_id_opt) = &add_create_order_result.create_order_result { - payment_data.set_connector_response_reference_id(order_id_opt.clone()); + // Set the response in routerdata response to carry forward + router_data + .update_router_data_with_create_order_response(create_order_response.clone()); + create_order_response.create_order_result.ok().map(|_| ()) } - should_continue_further = router_data - .update_router_data_with_create_order_result( - add_create_order_result, - should_continue_further, - ) - .await?; - } + // If create order is not required, then we can proceed with further processing + None => Some(()), + }; // In case of authorize flow, pre-task and post-tasks are being called in build request // if we do not want to proceed further, then the function will return Ok(None, false) - let (connector_request, should_continue_further) = if should_continue_further { - // Check if the actual flow specific request can be built with available data - router_data - .build_flow_specific_connector_request(state, &connector, call_connector_action.clone()) - .await? - } else { - (None, false) + let (connector_request, should_continue_further) = match should_continue { + Some(_) => { + router_data + .build_flow_specific_connector_request( + state, + &connector, + call_connector_action.clone(), + ) + .await? + } + None => (None, false), }; // Update the payment trackers just before calling the connector @@ -4089,18 +4119,14 @@ where Ok(router_data) }?; - let etime_connector = Instant::now(); - let duration_connector = etime_connector.saturating_duration_since(stime_connector); - tracing::info!(duration = format!("Duration taken: {}", duration_connector.as_millis())); - Ok(router_data) } -#[cfg(feature = "v1")] -// This function does not perform the tokenization action, as the payment method is not saved in this flow. +#[cfg(feature = "v2")] #[allow(clippy::too_many_arguments)] +#[allow(clippy::type_complexity)] #[instrument(skip_all)] -pub async fn proxy_for_call_connector_service<F, RouterDReq, ApiRequest, D>( +pub async fn call_connector_service_prerequisites<F, RouterDReq, ApiRequest, D>( state: &SessionState, req_state: ReqState, merchant_context: &domain::MerchantContext, @@ -4109,15 +4135,17 @@ pub async fn proxy_for_call_connector_service<F, RouterDReq, ApiRequest, D>( payment_data: &mut D, customer: &Option<domain::Customer>, call_connector_action: CallConnectorAction, - validate_result: &operations::ValidateResult, schedule_time: Option<time::PrimitiveDateTime>, header_payload: HeaderPayload, - + frm_suggestion: Option<storage_enums::FrmSuggestion>, business_profile: &domain::Profile, - return_raw_connector_response: Option<bool>, + is_retry_payment: bool, + should_retry_with_pan: bool, + all_keys_required: Option<bool>, ) -> RouterResult<( + domain::MerchantConnectorAccountTypeDetails, + Option<storage::CustomerUpdate>, RouterData<F, RouterDReq, router_types::PaymentsResponseData>, - helpers::MerchantConnectorAccountType, )> where F: Send + Clone + Sync, @@ -4131,145 +4159,354 @@ where dyn api::Connector: services::api::ConnectorIntegration<F, RouterDReq, router_types::PaymentsResponseData>, { - let stime_connector = Instant::now(); + let merchant_connector_account_type_details = + domain::MerchantConnectorAccountTypeDetails::MerchantConnectorAccount(Box::new( + helpers::get_merchant_connector_account_v2( + state, + merchant_context.get_merchant_key_store(), + connector.merchant_connector_id.as_ref(), + ) + .await?, + )); - let merchant_connector_account = construct_profile_id_and_get_mca( + operation + .to_domain()? + .populate_payment_data( + state, + payment_data, + merchant_context, + business_profile, + &connector, + ) + .await?; + + let updated_customer = call_create_connector_customer_if_required( state, + customer, merchant_context, + &merchant_connector_account_type_details, payment_data, - &connector.connector_name.to_string(), - connector.merchant_connector_id.as_ref(), - false, ) .await?; - if payment_data - .get_payment_attempt() - .merchant_connector_id - .is_none() - { - payment_data.set_merchant_connector_id_in_attempt(merchant_connector_account.get_mca_id()); - } - - let merchant_recipient_data = None; - - let mut router_data = payment_data + let router_data = payment_data .construct_router_data( state, connector.connector.id(), merchant_context, customer, - &merchant_connector_account, - merchant_recipient_data, + &merchant_connector_account_type_details, + None, None, ) .await?; - let add_access_token_result = router_data - .add_access_token( + Ok(( + merchant_connector_account_type_details, + updated_customer, + router_data, + )) +} + +#[cfg(feature = "v2")] +#[instrument(skip_all)] +pub async fn internal_call_connector_service_prerequisites<F, RouterDReq, ApiRequest, D>( + state: &SessionState, + merchant_context: &domain::MerchantContext, + connector: api::ConnectorData, + operation: &BoxedOperation<'_, F, ApiRequest, D>, + payment_data: &mut D, + business_profile: &domain::Profile, +) -> RouterResult<( + domain::MerchantConnectorAccountTypeDetails, + RouterData<F, RouterDReq, router_types::PaymentsResponseData>, +)> +where + F: Send + Clone + Sync, + RouterDReq: Send + Sync, + + // To create connector flow specific interface data + D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, + D: ConstructFlowSpecificData<F, RouterDReq, router_types::PaymentsResponseData>, + RouterData<F, RouterDReq, router_types::PaymentsResponseData>: Feature<F, RouterDReq> + Send, + // To construct connector flow specific api + dyn api::Connector: + services::api::ConnectorIntegration<F, RouterDReq, router_types::PaymentsResponseData>, +{ + let merchant_connector_details = + payment_data + .get_merchant_connector_details() + .ok_or_else(|| { + error_stack::report!(errors::ApiErrorResponse::InternalServerError) + .attach_printable("Merchant connector details not found in payment data") + })?; + let merchant_connector_account = + domain::MerchantConnectorAccountTypeDetails::MerchantConnectorDetails( + merchant_connector_details, + ); + + operation + .to_domain()? + .populate_payment_data( state, - &connector, + payment_data, merchant_context, - payment_data.get_creds_identifier(), + business_profile, + &connector, ) .await?; - router_data = router_data.add_session_token(state, &connector).await?; + let router_data = payment_data + .construct_router_data( + state, + connector.connector.id(), + merchant_context, + &None, + &merchant_connector_account, + None, + None, + ) + .await?; - let mut should_continue_further = access_token::update_router_data_with_access_token_result( - &add_access_token_result, - &mut router_data, - &call_connector_action, - ); + Ok((merchant_connector_account, router_data)) +} - (router_data, should_continue_further) = complete_preprocessing_steps_if_required( - state, - &connector, - payment_data, - router_data, - operation, - should_continue_further, - ) - .await?; +#[cfg(feature = "v2")] +#[allow(clippy::too_many_arguments)] +#[instrument(skip_all)] +pub async fn connector_service_decider<F, RouterDReq, ApiRequest, D>( + state: &SessionState, + req_state: ReqState, + merchant_context: &domain::MerchantContext, + connector: api::ConnectorData, + operation: &BoxedOperation<'_, F, ApiRequest, D>, + payment_data: &mut D, + call_connector_action: CallConnectorAction, + header_payload: HeaderPayload, + business_profile: &domain::Profile, + return_raw_connector_response: Option<bool>, + merchant_connector_account_type_details: domain::MerchantConnectorAccountTypeDetails, +) -> RouterResult<RouterData<F, RouterDReq, router_types::PaymentsResponseData>> +where + F: Send + Clone + Sync, + RouterDReq: Send + Sync, - if let Ok(router_types::PaymentsResponseData::PreProcessingResponse { - session_token: Some(session_token), - .. - }) = router_data.response.to_owned() - { - payment_data.push_sessions_token(session_token); - }; + // To create connector flow specific interface data + D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, + D: ConstructFlowSpecificData<F, RouterDReq, router_types::PaymentsResponseData>, + RouterData<F, RouterDReq, router_types::PaymentsResponseData>: Feature<F, RouterDReq> + Send, + // To construct connector flow specific api + dyn api::Connector: + services::api::ConnectorIntegration<F, RouterDReq, router_types::PaymentsResponseData>, +{ + let mut router_data = payment_data + .construct_router_data( + state, + connector.connector.id(), + merchant_context, + &None, + &merchant_connector_account_type_details, + None, + None, + ) + .await?; - let (connector_request, should_continue_further) = if should_continue_further { - // Check if the actual flow specific request can be built with available data - router_data - .build_flow_specific_connector_request(state, &connector, call_connector_action.clone()) + // do order creation + let should_call_unified_connector_service = + should_call_unified_connector_service(state, merchant_context, &router_data).await?; + + let (connector_request, should_continue_further) = if !should_call_unified_connector_service { + let mut should_continue_further = true; + + let should_continue = match router_data + .create_order_at_connector(state, &connector, should_continue_further) .await? + { + Some(create_order_response) => { + if let Ok(order_id) = create_order_response.clone().create_order_result { + payment_data.set_connector_response_reference_id(Some(order_id)) + } + + // Set the response in routerdata response to carry forward + router_data + .update_router_data_with_create_order_response(create_order_response.clone()); + create_order_response.create_order_result.ok().map(|_| ()) + } + // If create order is not required, then we can proceed with further processing + None => Some(()), + }; + + let should_continue: (Option<common_utils::request::Request>, bool) = match should_continue + { + Some(_) => { + router_data + .build_flow_specific_connector_request( + state, + &connector, + call_connector_action.clone(), + ) + .await? + } + None => (None, false), + }; + should_continue } else { + // If unified connector service is called, these values are not used + // as the request is built in the unified connector service call (None, false) }; - if should_add_task_to_process_tracker(payment_data) { - operation - .to_domain()? - .add_task_to_process_tracker( - state, - payment_data.get_payment_attempt(), - validate_result.requeue, - schedule_time, - ) - .await - .map_err(|error| logger::error!(process_tracker_error=?error)) - .ok(); - } - - let updated_customer = None; - let frm_suggestion = None; - (_, *payment_data) = operation .to_update_tracker()? .update_trackers( state, req_state, payment_data.clone(), - customer.clone(), + None, // customer is not used in internal flows merchant_context.get_merchant_account().storage_scheme, - updated_customer, + None, merchant_context.get_merchant_key_store(), - frm_suggestion, + None, // frm_suggestion is not used in internal flows header_payload.clone(), ) .await?; - let router_data = if should_continue_further { - // The status of payment_attempt and intent will be updated in the previous step - // update this in router_data. - // This is added because few connector integrations do not update the status, - // and rely on previous status set in router_data - router_data.status = payment_data.get_payment_attempt().status; - router_data - .decide_flows( + record_time_taken_with(|| async { + if should_call_unified_connector_service { + router_data + .call_unified_connector_service( + state, + merchant_connector_account_type_details.clone(), + merchant_context, + ) + .await?; + + Ok(router_data) + } else { + let router_data = if should_continue_further { + router_data + .decide_flows( + state, + &connector, + call_connector_action, + connector_request, + business_profile, + header_payload.clone(), + return_raw_connector_response, + ) + .await + } else { + Ok(router_data) + }?; + Ok(router_data) + } + }) + .await +} + +#[cfg(feature = "v2")] +#[allow(clippy::too_many_arguments)] +#[instrument(skip_all)] +pub async fn decide_unified_connector_service_call<F, RouterDReq, ApiRequest, D>( + state: &SessionState, + req_state: ReqState, + merchant_context: &domain::MerchantContext, + connector: api::ConnectorData, + operation: &BoxedOperation<'_, F, ApiRequest, D>, + payment_data: &mut D, + customer: &Option<domain::Customer>, + call_connector_action: CallConnectorAction, + schedule_time: Option<time::PrimitiveDateTime>, + header_payload: HeaderPayload, + frm_suggestion: Option<storage_enums::FrmSuggestion>, + business_profile: &domain::Profile, + is_retry_payment: bool, + should_retry_with_pan: bool, + return_raw_connector_response: Option<bool>, + merchant_connector_account_type_details: domain::MerchantConnectorAccountTypeDetails, + mut router_data: RouterData<F, RouterDReq, router_types::PaymentsResponseData>, + updated_customer: Option<storage::CustomerUpdate>, +) -> RouterResult<RouterData<F, RouterDReq, router_types::PaymentsResponseData>> +where + F: Send + Clone + Sync, + RouterDReq: Send + Sync, + + // To create connector flow specific interface data + D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, + D: ConstructFlowSpecificData<F, RouterDReq, router_types::PaymentsResponseData>, + RouterData<F, RouterDReq, router_types::PaymentsResponseData>: Feature<F, RouterDReq> + Send, + // To construct connector flow specific api + dyn api::Connector: + services::api::ConnectorIntegration<F, RouterDReq, router_types::PaymentsResponseData>, +{ + record_time_taken_with(|| async { + if should_call_unified_connector_service(state, merchant_context, &router_data).await? { + if should_add_task_to_process_tracker(payment_data) { + operation + .to_domain()? + .add_task_to_process_tracker( + state, + payment_data.get_payment_attempt(), + false, + schedule_time, + ) + .await + .map_err(|error| logger::error!(process_tracker_error=?error)) + .ok(); + } + + (_, *payment_data) = operation + .to_update_tracker()? + .update_trackers( + state, + req_state, + payment_data.clone(), + customer.clone(), + merchant_context.get_merchant_account().storage_scheme, + None, + merchant_context.get_merchant_key_store(), + frm_suggestion, + header_payload.clone(), + ) + .await?; + + router_data + .call_unified_connector_service( + state, + merchant_connector_account_type_details.clone(), + merchant_context, + ) + .await?; + + Ok(router_data) + } else { + call_connector_service( state, - &connector, + req_state, + merchant_context, + connector, + operation, + payment_data, + customer, call_connector_action, - connector_request, + schedule_time, + header_payload, + frm_suggestion, business_profile, - header_payload.clone(), + is_retry_payment, + should_retry_with_pan, return_raw_connector_response, + merchant_connector_account_type_details, + router_data, + updated_customer, ) .await - } else { - Ok(router_data) - }?; - - let etime_connector = Instant::now(); - let duration_connector = etime_connector.saturating_duration_since(stime_connector); - tracing::info!(duration = format!("Duration taken: {}", duration_connector.as_millis())); - - Ok((router_data, merchant_connector_account)) + } + }) + .await } - -#[cfg(feature = "v2")] +#[cfg(feature = "v1")] +// This function does not perform the tokenization action, as the payment method is not saved in this flow. #[allow(clippy::too_many_arguments)] #[instrument(skip_all)] pub async fn proxy_for_call_connector_service<F, RouterDReq, ApiRequest, D>( @@ -4279,11 +4516,18 @@ pub async fn proxy_for_call_connector_service<F, RouterDReq, ApiRequest, D>( connector: api::ConnectorData, operation: &BoxedOperation<'_, F, ApiRequest, D>, payment_data: &mut D, + customer: &Option<domain::Customer>, call_connector_action: CallConnectorAction, + validate_result: &operations::ValidateResult, + schedule_time: Option<time::PrimitiveDateTime>, header_payload: HeaderPayload, + business_profile: &domain::Profile, return_raw_connector_response: Option<bool>, -) -> RouterResult<RouterData<F, RouterDReq, router_types::PaymentsResponseData>> +) -> RouterResult<( + RouterData<F, RouterDReq, router_types::PaymentsResponseData>, + helpers::MerchantConnectorAccountType, +)> where F: Send + Clone + Sync, RouterDReq: Send + Sync, @@ -4298,34 +4542,34 @@ where { let stime_connector = Instant::now(); - let merchant_connector_account = - domain::MerchantConnectorAccountTypeDetails::MerchantConnectorAccount(Box::new( - helpers::get_merchant_connector_account_v2( - state, - merchant_context.get_merchant_key_store(), - connector.merchant_connector_id.as_ref(), - ) - .await?, - )); - operation - .to_domain()? - .populate_payment_data( - state, - payment_data, - merchant_context, - business_profile, - &connector, - ) - .await?; + let merchant_connector_account = construct_profile_id_and_get_mca( + state, + merchant_context, + payment_data, + &connector.connector_name.to_string(), + connector.merchant_connector_id.as_ref(), + false, + ) + .await?; + + if payment_data + .get_payment_attempt() + .merchant_connector_id + .is_none() + { + payment_data.set_merchant_connector_id_in_attempt(merchant_connector_account.get_mca_id()); + } + + let merchant_recipient_data = None; let mut router_data = payment_data .construct_router_data( state, connector.connector.id(), merchant_context, - &None, + customer, &merchant_connector_account, - None, + merchant_recipient_data, None, ) .await?; @@ -4347,7 +4591,26 @@ where &call_connector_action, ); + (router_data, should_continue_further) = complete_preprocessing_steps_if_required( + state, + &connector, + payment_data, + router_data, + operation, + should_continue_further, + ) + .await?; + + if let Ok(router_types::PaymentsResponseData::PreProcessingResponse { + session_token: Some(session_token), + .. + }) = router_data.response.to_owned() + { + payment_data.push_sessions_token(session_token); + }; + let (connector_request, should_continue_further) = if should_continue_further { + // Check if the actual flow specific request can be built with available data router_data .build_flow_specific_connector_request(state, &connector, call_connector_action.clone()) .await? @@ -4355,22 +4618,44 @@ where (None, false) }; + if should_add_task_to_process_tracker(payment_data) { + operation + .to_domain()? + .add_task_to_process_tracker( + state, + payment_data.get_payment_attempt(), + validate_result.requeue, + schedule_time, + ) + .await + .map_err(|error| logger::error!(process_tracker_error=?error)) + .ok(); + } + + let updated_customer = None; + let frm_suggestion = None; + (_, *payment_data) = operation .to_update_tracker()? .update_trackers( state, req_state, payment_data.clone(), - None, + customer.clone(), merchant_context.get_merchant_account().storage_scheme, - None, + updated_customer, merchant_context.get_merchant_key_store(), - None, + frm_suggestion, header_payload.clone(), ) .await?; let router_data = if should_continue_further { + // The status of payment_attempt and intent will be updated in the previous step + // update this in router_data. + // This is added because few connector integrations do not update the status, + // and rely on previous status set in router_data + router_data.status = payment_data.get_payment_attempt().status; router_data .decide_flows( state, @@ -4390,13 +4675,13 @@ where let duration_connector = etime_connector.saturating_duration_since(stime_connector); tracing::info!(duration = format!("Duration taken: {}", duration_connector.as_millis())); - Ok(router_data) + Ok((router_data, merchant_connector_account)) } #[cfg(feature = "v2")] #[allow(clippy::too_many_arguments)] #[instrument(skip_all)] -pub async fn internal_call_connector_service<F, RouterDReq, ApiRequest, D>( +pub async fn proxy_for_call_connector_service<F, RouterDReq, ApiRequest, D>( state: &SessionState, req_state: ReqState, merchant_context: &domain::MerchantContext, @@ -4422,18 +4707,15 @@ where { let stime_connector = Instant::now(); - let merchant_connector_details = - payment_data - .get_merchant_connector_details() - .ok_or_else(|| { - error_stack::report!(errors::ApiErrorResponse::InternalServerError) - .attach_printable("Merchant connector details not found in payment data") - })?; let merchant_connector_account = - domain::MerchantConnectorAccountTypeDetails::MerchantConnectorDetails( - merchant_connector_details, - ); - + domain::MerchantConnectorAccountTypeDetails::MerchantConnectorAccount(Box::new( + helpers::get_merchant_connector_account_v2( + state, + merchant_context.get_merchant_key_store(), + connector.merchant_connector_id.as_ref(), + ) + .await?, + )); operation .to_domain()? .populate_payment_data( @@ -4474,22 +4756,6 @@ where &call_connector_action, ); - let add_create_order_result = router_data - .create_order_at_connector(state, &connector, should_continue_further) - .await?; - - if add_create_order_result.is_create_order_performed { - if let Ok(order_id_opt) = &add_create_order_result.create_order_result { - payment_data.set_connector_response_reference_id(order_id_opt.clone()); - } - should_continue_further = router_data - .update_router_data_with_create_order_result( - add_create_order_result, - should_continue_further, - ) - .await?; - } - let (connector_request, should_continue_further) = if should_continue_further { router_data .build_flow_specific_connector_request(state, &connector, call_connector_action.clone()) diff --git a/crates/router/src/core/payments/flows.rs b/crates/router/src/core/payments/flows.rs index a93e2f391fe..2cae2f0600d 100644 --- a/crates/router/src/core/payments/flows.rs +++ b/crates/router/src/core/payments/flows.rs @@ -185,35 +185,27 @@ pub trait Feature<F, T> { _state: &SessionState, _connector: &api::ConnectorData, _should_continue_payment: bool, - ) -> RouterResult<types::CreateOrderResult> + ) -> RouterResult<Option<types::CreateOrderResult>> where F: Clone, Self: Sized, dyn api::Connector: services::ConnectorIntegration<F, T, types::PaymentsResponseData>, { - Ok(types::CreateOrderResult { - create_order_result: Ok(None), - is_create_order_performed: false, - }) + Ok(None) } - async fn update_router_data_with_create_order_result( + fn update_router_data_with_create_order_response( &mut self, _create_order_result: types::CreateOrderResult, - should_continue_payment: bool, - ) -> RouterResult<bool> - where - F: Clone, - Self: Sized, - dyn api::Connector: services::ConnectorIntegration<F, T, types::PaymentsResponseData>, - { - Ok(should_continue_payment) + ) { } async fn call_unified_connector_service<'a>( &mut self, _state: &SessionState, - _merchant_connector_account: helpers::MerchantConnectorAccountType, + #[cfg(feature = "v1")] _merchant_connector_account: helpers::MerchantConnectorAccountType, + #[cfg(feature = "v2")] + _merchant_connector_account: domain::MerchantConnectorAccountTypeDetails, _merchant_context: &domain::MerchantContext, ) -> RouterResult<()> where diff --git a/crates/router/src/core/payments/flows/authorize_flow.rs b/crates/router/src/core/payments/flows/authorize_flow.rs index 1532fffa3f9..f42efa0c1e4 100644 --- a/crates/router/src/core/payments/flows/authorize_flow.rs +++ b/crates/router/src/core/payments/flows/authorize_flow.rs @@ -431,7 +431,7 @@ impl Feature<api::Authorize, types::PaymentsAuthorizeData> for types::PaymentsAu state: &SessionState, connector: &api::ConnectorData, should_continue_payment: bool, - ) -> RouterResult<types::CreateOrderResult> { + ) -> RouterResult<Option<types::CreateOrderResult>> { if connector .connector_name .requires_order_creation_before_payment(self.payment_method) @@ -471,7 +471,7 @@ impl Feature<api::Authorize, types::PaymentsAuthorizeData> for types::PaymentsAu if let types::PaymentsResponseData::PaymentsCreateOrderResponse { order_id } = res { - Ok(Some(order_id)) + Ok(order_id) } else { Err(error_stack::report!(ApiErrorResponse::InternalServerError) .attach_printable(format!( @@ -482,47 +482,37 @@ impl Feature<api::Authorize, types::PaymentsAuthorizeData> for types::PaymentsAu Err(error) => Err(error), }; - Ok(types::CreateOrderResult { + Ok(Some(types::CreateOrderResult { create_order_result: create_order_resp, - is_create_order_performed: true, - }) + })) } else { - Ok(types::CreateOrderResult { - create_order_result: Ok(None), - is_create_order_performed: false, - }) + // If the connector does not require order creation, return None + Ok(None) } } - async fn update_router_data_with_create_order_result( + fn update_router_data_with_create_order_response( &mut self, create_order_result: types::CreateOrderResult, - should_continue_further: bool, - ) -> RouterResult<bool> { - if create_order_result.is_create_order_performed { - match create_order_result.create_order_result { - Ok(Some(order_id)) => { - self.request.order_id = Some(order_id.clone()); - self.response = - Ok(types::PaymentsResponseData::PaymentsCreateOrderResponse { order_id }); - Ok(true) - } - Ok(None) => Err(error_stack::report!(ApiErrorResponse::InternalServerError) - .attach_printable("Order Id not found."))?, - Err(err) => { - self.response = Err(err.clone()); - Ok(false) - } + ) { + match create_order_result.create_order_result { + Ok(order_id) => { + self.request.order_id = Some(order_id.clone()); // ? why this is assigned here and ucs also wants this to populate data + self.response = + Ok(types::PaymentsResponseData::PaymentsCreateOrderResponse { order_id }); + } + Err(err) => { + self.response = Err(err.clone()); } - } else { - Ok(should_continue_further) } } async fn call_unified_connector_service<'a>( &mut self, state: &SessionState, - merchant_connector_account: helpers::MerchantConnectorAccountType, + #[cfg(feature = "v1")] merchant_connector_account: helpers::MerchantConnectorAccountType, + #[cfg(feature = "v2")] + merchant_connector_account: domain::MerchantConnectorAccountTypeDetails, merchant_context: &domain::MerchantContext, ) -> RouterResult<()> { let client = state @@ -558,13 +548,14 @@ impl Feature<api::Authorize, types::PaymentsAuthorizeData> for types::PaymentsAu let (status, router_data_response) = handle_unified_connector_service_response_for_payment_authorize( - payment_authorize_response, + payment_authorize_response.clone(), ) .change_context(ApiErrorResponse::InternalServerError) .attach_printable("Failed to deserialize UCS response")?; self.status = status; self.response = router_data_response; + self.raw_connector_response = payment_authorize_response.raw_connector_response; Ok(()) } diff --git a/crates/router/src/core/payments/flows/psync_flow.rs b/crates/router/src/core/payments/flows/psync_flow.rs index f2ffbe24d11..e27c9974406 100644 --- a/crates/router/src/core/payments/flows/psync_flow.rs +++ b/crates/router/src/core/payments/flows/psync_flow.rs @@ -1,6 +1,8 @@ use std::collections::HashMap; use async_trait::async_trait; +use error_stack::ResultExt; +use unified_connector_service_client::payments as payments_grpc; use super::{ConstructFlowSpecificData, Feature}; use crate::{ @@ -8,10 +10,14 @@ use crate::{ core::{ errors::{ApiErrorResponse, ConnectorErrorExt, RouterResult}, payments::{self, access_token, helpers, transformers, PaymentData}, + unified_connector_service::{ + build_unified_connector_service_auth_metadata, + handle_unified_connector_service_response_for_payment_get, + }, }, routes::SessionState, services::{self, api::ConnectorValidation, logger}, - types::{self, api, domain}, + types::{self, api, domain, transformers::ForeignTryFrom}, }; #[cfg(feature = "v1")] @@ -204,6 +210,56 @@ impl Feature<api::PSync, types::PaymentsSyncData> Ok((request, true)) } + + async fn call_unified_connector_service<'a>( + &mut self, + state: &SessionState, + #[cfg(feature = "v1")] merchant_connector_account: helpers::MerchantConnectorAccountType, + #[cfg(feature = "v2")] + merchant_connector_account: domain::MerchantConnectorAccountTypeDetails, + merchant_context: &domain::MerchantContext, + ) -> RouterResult<()> { + let client = state + .grpc_client + .unified_connector_service_client + .clone() + .ok_or(ApiErrorResponse::InternalServerError) + .attach_printable("Failed to fetch Unified Connector Service client")?; + + let payment_get_request = payments_grpc::PaymentServiceGetRequest::foreign_try_from(self) + .change_context(ApiErrorResponse::InternalServerError) + .attach_printable("Failed to construct Payment Get Request")?; + + let connector_auth_metadata = build_unified_connector_service_auth_metadata( + merchant_connector_account, + merchant_context, + ) + .change_context(ApiErrorResponse::InternalServerError) + .attach_printable("Failed to construct request metadata")?; + + let response = client + .payment_get( + payment_get_request, + connector_auth_metadata, + state.get_grpc_headers(), + ) + .await + .change_context(ApiErrorResponse::InternalServerError) + .attach_printable("Failed to get payment")?; + + let payment_get_response = response.into_inner(); + + let (status, router_data_response) = + handle_unified_connector_service_response_for_payment_get(payment_get_response.clone()) + .change_context(ApiErrorResponse::InternalServerError) + .attach_printable("Failed to deserialize UCS response")?; + + self.status = status; + self.response = router_data_response; + self.raw_connector_response = payment_get_response.raw_connector_response; + + Ok(()) + } } #[async_trait] diff --git a/crates/router/src/core/payments/transformers.rs b/crates/router/src/core/payments/transformers.rs index 2379dddb8fd..59359429080 100644 --- a/crates/router/src/core/payments/transformers.rs +++ b/crates/router/src/core/payments/transformers.rs @@ -304,7 +304,7 @@ pub async fn construct_payment_router_data_for_authorize<'a>( router_return_url: Some(router_return_url), webhook_url, complete_authorize_url, - customer_id: None, + customer_id: customer_id.clone(), surcharge_details: None, request_extended_authorization: None, request_incremental_authorization: matches!( @@ -3466,8 +3466,126 @@ where impl<F: Clone> TryFrom<PaymentAdditionalData<'_, F>> for types::PaymentsAuthorizeData { type Error = error_stack::Report<errors::ApiErrorResponse>; - fn try_from(_additional_data: PaymentAdditionalData<'_, F>) -> Result<Self, Self::Error> { - todo!() + fn try_from(additional_data: PaymentAdditionalData<'_, F>) -> Result<Self, Self::Error> { + let payment_data = additional_data.payment_data.clone(); + let router_base_url = &additional_data.router_base_url; + let connector_name = &additional_data.connector_name; + let attempt = &payment_data.payment_attempt; + let browser_info: Option<types::BrowserInformation> = attempt + .browser_info + .clone() + .map(types::BrowserInformation::from); + + let complete_authorize_url = Some(helpers::create_complete_authorize_url( + router_base_url, + attempt, + connector_name, + payment_data.creds_identifier.as_deref(), + )); + + let merchant_connector_account_id_or_connector_name = payment_data + .payment_attempt + .merchant_connector_id + .as_ref() + .map(|mca_id| mca_id.get_string_repr()) + .unwrap_or(connector_name); + + let webhook_url = Some(helpers::create_webhook_url( + router_base_url, + &attempt.merchant_id, + merchant_connector_account_id_or_connector_name, + )); + let router_return_url = Some(helpers::create_redirect_url( + router_base_url, + attempt, + connector_name, + payment_data.creds_identifier.as_deref(), + )); + + let payment_method_data = payment_data.payment_method_data.or_else(|| { + if payment_data.mandate_id.is_some() { + Some(domain::PaymentMethodData::MandatePayment) + } else { + None + } + }); + + let amount = payment_data + .payment_attempt + .get_total_amount() + .get_amount_as_i64(); + + let customer_name = additional_data + .customer_data + .as_ref() + .and_then(|customer_data| { + customer_data + .name + .as_ref() + .map(|customer| customer.clone().into_inner()) + }); + + let customer_id = additional_data + .customer_data + .as_ref() + .and_then(|data| data.get_id().clone().try_into().ok()); + + let merchant_order_reference_id = payment_data + .payment_intent + .merchant_reference_id + .map(|s| s.get_string_repr().to_string()); + + let shipping_cost = payment_data.payment_intent.amount_details.shipping_cost; + + Ok(Self { + payment_method_data: payment_method_data + .unwrap_or(domain::PaymentMethodData::Card(domain::Card::default())), + amount, + order_tax_amount: None, // V2 doesn't currently support order tax amount + email: None, // V2 doesn't store email directly in payment_intent + customer_name, + currency: payment_data.currency, + confirm: true, + statement_descriptor_suffix: None, + statement_descriptor: None, + capture_method: Some(payment_data.payment_intent.capture_method), + router_return_url, + webhook_url, + complete_authorize_url, + setup_future_usage: Some(payment_data.payment_intent.setup_future_usage), + mandate_id: payment_data.mandate_id.clone(), + off_session: get_off_session(payment_data.mandate_id.as_ref(), None), + customer_acceptance: None, + setup_mandate_details: None, + browser_info, + order_details: None, + order_category: None, + session_token: None, + enrolled_for_3ds: false, + related_transaction_id: None, + payment_experience: None, + payment_method_type: Some(payment_data.payment_attempt.payment_method_subtype), + surcharge_details: None, + customer_id, + request_incremental_authorization: false, + metadata: payment_data + .payment_intent + .metadata + .clone() + .map(|m| m.expose()), + authentication_data: None, + request_extended_authorization: None, + split_payments: None, + minor_amount: payment_data.payment_attempt.get_total_amount(), + merchant_order_reference_id, + integrity_object: None, + shipping_cost, + additional_payment_method_data: None, + merchant_account_id: None, + merchant_config_currency: None, + connector_testing_data: None, + order_id: None, + }) } } diff --git a/crates/router/src/core/unified_connector_service.rs b/crates/router/src/core/unified_connector_service.rs index 3cdcb28d4d8..14836ff20c6 100644 --- a/crates/router/src/core/unified_connector_service.rs +++ b/crates/router/src/core/unified_connector_service.rs @@ -1,4 +1,3 @@ -use api_models::admin::ConnectorAuthType; use common_enums::{AttemptStatus, PaymentMethodType}; use common_utils::{errors::CustomResult, ext_traits::ValueExt}; use error_stack::ResultExt; @@ -6,9 +5,11 @@ use external_services::grpc_client::unified_connector_service::{ ConnectorAuthMetadata, UnifiedConnectorServiceError, }; use hyperswitch_connectors::utils::CardData; +#[cfg(feature = "v2")] +use hyperswitch_domain_models::merchant_connector_account::MerchantConnectorAccountTypeDetails; use hyperswitch_domain_models::{ merchant_context::MerchantContext, - router_data::{ErrorResponse, RouterData}, + router_data::{ConnectorAuthType, ErrorResponse, RouterData}, router_response_types::{PaymentsResponseData, RedirectForm}, }; use masking::{ExposeInterface, PeekInterface, Secret}; @@ -101,7 +102,7 @@ pub fn build_unified_connector_service_payment_method( } _ => { return Err(UnifiedConnectorServiceError::NotImplemented(format!( - "Unimplemented card payment method type: {payment_method_type:?}" + "Unimplemented payment method subtype: {payment_method_type:?}" )) .into()); } @@ -113,24 +114,52 @@ pub fn build_unified_connector_service_payment_method( })), }) } + hyperswitch_domain_models::payment_method_data::PaymentMethodData::Upi(upi_data) => { + let upi_type = match upi_data { + hyperswitch_domain_models::payment_method_data::UpiData::UpiCollect( + upi_collect_data, + ) => { + let vpa_id = upi_collect_data.vpa_id.map(|vpa| vpa.expose()); + let upi_details = payments_grpc::UpiCollect { vpa_id }; + PaymentMethod::UpiCollect(upi_details) + } + _ => { + return Err(UnifiedConnectorServiceError::NotImplemented(format!( + "Unimplemented payment method subtype: {payment_method_type:?}" + )) + .into()); + } + }; - _ => Err(UnifiedConnectorServiceError::NotImplemented( - "Unimplemented Payment Method".to_string(), - ) + Ok(payments_grpc::PaymentMethod { + payment_method: Some(upi_type), + }) + } + _ => Err(UnifiedConnectorServiceError::NotImplemented(format!( + "Unimplemented payment method: {payment_method_data:?}" + )) .into()), } } pub fn build_unified_connector_service_auth_metadata( - merchant_connector_account: MerchantConnectorAccountType, + #[cfg(feature = "v1")] merchant_connector_account: MerchantConnectorAccountType, + #[cfg(feature = "v2")] merchant_connector_account: MerchantConnectorAccountTypeDetails, merchant_context: &MerchantContext, ) -> CustomResult<ConnectorAuthMetadata, UnifiedConnectorServiceError> { + #[cfg(feature = "v1")] let auth_type: ConnectorAuthType = merchant_connector_account .get_connector_account_details() .parse_value("ConnectorAuthType") .change_context(UnifiedConnectorServiceError::FailedToObtainAuthType) .attach_printable("Failed while parsing value for ConnectorAuthType")?; + #[cfg(feature = "v2")] + let auth_type: ConnectorAuthType = merchant_connector_account + .get_connector_account_details() + .change_context(UnifiedConnectorServiceError::FailedToObtainAuthType) + .attach_printable("Failed to obtain ConnectorAuthType")?; + let connector_name = { #[cfg(feature = "v1")] { @@ -211,30 +240,126 @@ pub fn handle_unified_connector_service_response_for_payment_authorize( }) }); + let transaction_id = response.transaction_id.as_ref().and_then(|id| { + id.id_type.clone().and_then(|id_type| match id_type { + payments_grpc::identifier::IdType::Id(id) => Some(id), + payments_grpc::identifier::IdType::EncodedData(encoded_data) => Some(encoded_data), + payments_grpc::identifier::IdType::NoResponseIdMarker(_) => None, + }) + }); + let router_data_response = match status { AttemptStatus::Charged | - AttemptStatus::Authorized | - AttemptStatus::AuthenticationPending | - AttemptStatus::DeviceDataCollectionPending => Ok(PaymentsResponseData::TransactionResponse { - resource_id: match connector_response_reference_id.as_ref() { + AttemptStatus::Authorized | + AttemptStatus::AuthenticationPending | + AttemptStatus::DeviceDataCollectionPending | + AttemptStatus::Started | + AttemptStatus::AuthenticationSuccessful | + AttemptStatus::Authorizing | + AttemptStatus::ConfirmationAwaited | + AttemptStatus::Pending => Ok(PaymentsResponseData::TransactionResponse { + resource_id: match transaction_id.as_ref() { + Some(transaction_id) => hyperswitch_domain_models::router_request_types::ResponseId::ConnectorTransactionId(transaction_id.clone()), + None => hyperswitch_domain_models::router_request_types::ResponseId::NoResponseId, + }, + redirection_data: Box::new( + response + .redirection_data + .clone() + .map(RedirectForm::foreign_try_from) + .transpose()? + ), + mandate_reference: Box::new(None), + connector_metadata: None, + network_txn_id: response.network_txn_id.clone(), + connector_response_reference_id, + incremental_authorization_allowed: response.incremental_authorization_allowed, + charges: None, + }), + AttemptStatus::AuthenticationFailed + | AttemptStatus::AuthorizationFailed + | AttemptStatus::Unresolved + | AttemptStatus::Failure => Err(ErrorResponse { + code: response.error_code().to_owned(), + message: response.error_message().to_owned(), + reason: Some(response.error_message().to_owned()), + status_code: 500, + attempt_status: Some(status), + connector_transaction_id: connector_response_reference_id, + network_decline_code: None, + network_advice_code: None, + network_error_message: None, + }), + AttemptStatus::RouterDeclined | + AttemptStatus::CodInitiated | + AttemptStatus::Voided | + AttemptStatus::VoidInitiated | + AttemptStatus::CaptureInitiated | + AttemptStatus::VoidFailed | + AttemptStatus::AutoRefunded | + AttemptStatus::PartialCharged | + AttemptStatus::PartialChargedAndChargeable | + AttemptStatus::PaymentMethodAwaited | + AttemptStatus::CaptureFailed | + AttemptStatus::IntegrityFailure => return Err(UnifiedConnectorServiceError::NotImplemented(format!( + "AttemptStatus {status:?} is not implemented for Unified Connector Service" + )).into()), + }; + + Ok((status, router_data_response)) +} + +pub fn handle_unified_connector_service_response_for_payment_get( + response: payments_grpc::PaymentServiceGetResponse, +) -> CustomResult< + (AttemptStatus, Result<PaymentsResponseData, ErrorResponse>), + UnifiedConnectorServiceError, +> { + let status = AttemptStatus::foreign_try_from(response.status())?; + + let connector_response_reference_id = + response.response_ref_id.as_ref().and_then(|identifier| { + identifier + .id_type + .clone() + .and_then(|id_type| match id_type { + payments_grpc::identifier::IdType::Id(id) => Some(id), + payments_grpc::identifier::IdType::EncodedData(encoded_data) => { + Some(encoded_data) + } + payments_grpc::identifier::IdType::NoResponseIdMarker(_) => None, + }) + }); + + let router_data_response = match status { + AttemptStatus::Charged | + AttemptStatus::Authorized | + AttemptStatus::AuthenticationPending | + AttemptStatus::DeviceDataCollectionPending | + AttemptStatus::Started | + AttemptStatus::AuthenticationSuccessful | + AttemptStatus::Authorizing | + AttemptStatus::ConfirmationAwaited | + AttemptStatus::Pending => Ok( + PaymentsResponseData::TransactionResponse { + resource_id: match connector_response_reference_id.as_ref() { Some(connector_response_reference_id) => hyperswitch_domain_models::router_request_types::ResponseId::ConnectorTransactionId(connector_response_reference_id.clone()), None => hyperswitch_domain_models::router_request_types::ResponseId::NoResponseId, }, - redirection_data: Box::new( - response - .redirection_data - .clone() - .map(RedirectForm::foreign_try_from) - .transpose()? - ), - mandate_reference: Box::new(None), - connector_metadata: None, - network_txn_id: response.network_txn_id.clone(), - connector_response_reference_id, - incremental_authorization_allowed: response.incremental_authorization_allowed, - charges: None, - }), - _ => Err(ErrorResponse { + redirection_data: Box::new( + None + ), + mandate_reference: Box::new(None), + connector_metadata: None, + network_txn_id: response.network_txn_id.clone(), + connector_response_reference_id, + incremental_authorization_allowed: None, + charges: None, + } + ), + AttemptStatus::AuthenticationFailed + | AttemptStatus::AuthorizationFailed + | AttemptStatus::Failure => Err(ErrorResponse { code: response.error_code().to_owned(), message: response.error_message().to_owned(), reason: Some(response.error_message().to_owned()), @@ -244,7 +369,22 @@ pub fn handle_unified_connector_service_response_for_payment_authorize( network_decline_code: None, network_advice_code: None, network_error_message: None, - }) + }), + AttemptStatus::RouterDeclined | + AttemptStatus::CodInitiated | + AttemptStatus::Voided | + AttemptStatus::VoidInitiated | + AttemptStatus::CaptureInitiated | + AttemptStatus::VoidFailed | + AttemptStatus::AutoRefunded | + AttemptStatus::PartialCharged | + AttemptStatus::PartialChargedAndChargeable | + AttemptStatus::Unresolved | + AttemptStatus::PaymentMethodAwaited | + AttemptStatus::CaptureFailed | + AttemptStatus::IntegrityFailure => return Err(UnifiedConnectorServiceError::NotImplemented(format!( + "AttemptStatus {status:?} is not implemented for Unified Connector Service" + )).into()), }; Ok((status, router_data_response)) diff --git a/crates/router/src/core/unified_connector_service/transformers.rs b/crates/router/src/core/unified_connector_service/transformers.rs index 0e2ae6fd343..e937a7e7d2d 100644 --- a/crates/router/src/core/unified_connector_service/transformers.rs +++ b/crates/router/src/core/unified_connector_service/transformers.rs @@ -7,8 +7,8 @@ use error_stack::ResultExt; use external_services::grpc_client::unified_connector_service::UnifiedConnectorServiceError; use hyperswitch_domain_models::{ router_data::RouterData, - router_flow_types::payments::Authorize, - router_request_types::{AuthenticationData, PaymentsAuthorizeData}, + router_flow_types::payments::{Authorize, PSync}, + router_request_types::{AuthenticationData, PaymentsAuthorizeData, PaymentsSyncData}, router_response_types::{PaymentsResponseData, RedirectForm}, }; use masking::{ExposeInterface, PeekInterface}; @@ -18,6 +18,37 @@ use crate::{ core::unified_connector_service::build_unified_connector_service_payment_method, types::transformers::ForeignTryFrom, }; +impl ForeignTryFrom<&RouterData<PSync, PaymentsSyncData, PaymentsResponseData>> + for payments_grpc::PaymentServiceGetRequest +{ + type Error = error_stack::Report<UnifiedConnectorServiceError>; + + fn foreign_try_from( + router_data: &RouterData<PSync, PaymentsSyncData, PaymentsResponseData>, + ) -> Result<Self, Self::Error> { + let connector_transaction_id = router_data + .request + .connector_transaction_id + .get_connector_transaction_id() + .map(|id| Identifier { + id_type: Some(payments_grpc::identifier::IdType::Id(id)), + }) + .ok(); + + let connector_ref_id = router_data + .request + .connector_reference_id + .clone() + .map(|id| Identifier { + id_type: Some(payments_grpc::identifier::IdType::Id(id)), + }); + + Ok(Self { + transaction_id: connector_transaction_id, + request_ref_id: connector_ref_id, + }) + } +} impl ForeignTryFrom<&RouterData<Authorize, PaymentsAuthorizeData, PaymentsResponseData>> for payments_grpc::PaymentServiceAuthorizeRequest @@ -113,7 +144,7 @@ impl ForeignTryFrom<&RouterData<Authorize, PaymentsAuthorizeData, PaymentsRespon .map(|shipping_cost| shipping_cost.get_amount_as_i64()), request_ref_id: Some(Identifier { id_type: Some(payments_grpc::identifier::IdType::Id( - router_data.payment_id.clone(), + router_data.connector_request_reference_id.clone(), )), }), connector_customer_id: router_data @@ -181,89 +212,115 @@ impl ForeignTryFrom<hyperswitch_domain_models::payment_address::PaymentAddress> fn foreign_try_from( payment_address: hyperswitch_domain_models::payment_address::PaymentAddress, ) -> Result<Self, Self::Error> { - let shipping = payment_address.get_shipping().and_then(|address| { - let details = address.address.as_ref()?; + let shipping = payment_address.get_shipping().map(|address| { + let details = address.address.as_ref(); let get_str = |opt: &Option<masking::Secret<String>>| opt.as_ref().map(|s| s.peek().to_owned()); let get_plain = |opt: &Option<String>| opt.clone(); - let country = details - .country - .as_ref() - .and_then(|c| payments_grpc::CountryAlpha2::from_str_name(&c.to_string())) - .ok_or_else(|| { - UnifiedConnectorServiceError::RequestEncodingFailedWithReason( - "Invalid country code".to_string(), - ) - }) - .attach_printable("Invalid country code") - .ok()? // Return None if invalid - .into(); - - Some(payments_grpc::Address { - first_name: get_str(&details.first_name), - last_name: get_str(&details.last_name), - line1: get_str(&details.line1), - line2: get_str(&details.line2), - line3: get_str(&details.line3), - city: get_plain(&details.city), - state: get_str(&details.state), - zip_code: get_str(&details.zip), - country_alpha2_code: Some(country), + let country = details.and_then(|details| { + details + .country + .as_ref() + .and_then(|c| payments_grpc::CountryAlpha2::from_str_name(&c.to_string())) + .map(|country| country.into()) + }); + + payments_grpc::Address { + first_name: get_str(&details.and_then(|d| d.first_name.clone())), + last_name: get_str(&details.and_then(|d| d.last_name.clone())), + line1: get_str(&details.and_then(|d| d.line1.clone())), + line2: get_str(&details.and_then(|d| d.line2.clone())), + line3: get_str(&details.and_then(|d| d.line3.clone())), + city: get_plain(&details.and_then(|d| d.city.clone())), + state: get_str(&details.and_then(|d| d.state.clone())), + zip_code: get_str(&details.and_then(|d| d.zip.clone())), + country_alpha2_code: country, email: address.email.as_ref().map(|e| e.peek().to_string()), phone_number: address .phone .as_ref() .and_then(|phone| phone.number.as_ref().map(|n| n.peek().to_string())), phone_country_code: address.phone.as_ref().and_then(|p| p.country_code.clone()), - }) + } }); - let billing = payment_address.get_payment_billing().and_then(|address| { - let details = address.address.as_ref()?; + let billing = payment_address.get_payment_billing().map(|address| { + let details = address.address.as_ref(); let get_str = |opt: &Option<masking::Secret<String>>| opt.as_ref().map(|s| s.peek().to_owned()); let get_plain = |opt: &Option<String>| opt.clone(); - let country = details - .country - .as_ref() - .and_then(|c| payments_grpc::CountryAlpha2::from_str_name(&c.to_string())) - .ok_or_else(|| { - UnifiedConnectorServiceError::RequestEncodingFailedWithReason( - "Invalid country code".to_string(), - ) - }) - .attach_printable("Invalid country code") - .ok()? // Return None if invalid - .into(); - - Some(payments_grpc::Address { - first_name: get_str(&details.first_name), - last_name: get_str(&details.last_name), - line1: get_str(&details.line1), - line2: get_str(&details.line2), - line3: get_str(&details.line3), - city: get_plain(&details.city), - state: get_str(&details.state), - zip_code: get_str(&details.zip), - country_alpha2_code: Some(country), + let country = details.and_then(|details| { + details + .country + .as_ref() + .and_then(|c| payments_grpc::CountryAlpha2::from_str_name(&c.to_string())) + .map(|country| country.into()) + }); + + payments_grpc::Address { + first_name: get_str(&details.and_then(|d| d.first_name.clone())), + last_name: get_str(&details.and_then(|d| d.last_name.clone())), + line1: get_str(&details.and_then(|d| d.line1.clone())), + line2: get_str(&details.and_then(|d| d.line2.clone())), + line3: get_str(&details.and_then(|d| d.line3.clone())), + city: get_plain(&details.and_then(|d| d.city.clone())), + state: get_str(&details.and_then(|d| d.state.clone())), + zip_code: get_str(&details.and_then(|d| d.zip.clone())), + country_alpha2_code: country, email: address.email.as_ref().map(|e| e.peek().to_string()), phone_number: address .phone .as_ref() .and_then(|phone| phone.number.as_ref().map(|n| n.peek().to_string())), phone_country_code: address.phone.as_ref().and_then(|p| p.country_code.clone()), - }) + } }); + let unified_payment_method_billing = + payment_address.get_payment_method_billing().map(|address| { + let details = address.address.as_ref(); + + let get_str = |opt: &Option<masking::Secret<String>>| { + opt.as_ref().map(|s| s.peek().to_owned()) + }; + + let get_plain = |opt: &Option<String>| opt.clone(); + + let country = details.and_then(|details| { + details + .country + .as_ref() + .and_then(|c| payments_grpc::CountryAlpha2::from_str_name(&c.to_string())) + .map(|country| country.into()) + }); + + payments_grpc::Address { + first_name: get_str(&details.and_then(|d| d.first_name.clone())), + last_name: get_str(&details.and_then(|d| d.last_name.clone())), + line1: get_str(&details.and_then(|d| d.line1.clone())), + line2: get_str(&details.and_then(|d| d.line2.clone())), + line3: get_str(&details.and_then(|d| d.line3.clone())), + city: get_plain(&details.and_then(|d| d.city.clone())), + state: get_str(&details.and_then(|d| d.state.clone())), + zip_code: get_str(&details.and_then(|d| d.zip.clone())), + country_alpha2_code: country, + email: address.email.as_ref().map(|e| e.peek().to_string()), + phone_number: address + .phone + .as_ref() + .and_then(|phone| phone.number.as_ref().map(|n| n.peek().to_string())), + phone_country_code: address.phone.as_ref().and_then(|p| p.country_code.clone()), + } + }); Ok(Self { - shipping_address: shipping, - billing_address: billing, + shipping_address: shipping.or(unified_payment_method_billing.clone()), + billing_address: billing.or(unified_payment_method_billing), }) } } @@ -391,6 +448,12 @@ impl ForeignTryFrom<payments_grpc::RedirectForm> for RedirectForm { Some(payments_grpc::redirect_form::FormType::Html(html)) => Ok(Self::Html { html_data: html.html_data, }), + Some(payments_grpc::redirect_form::FormType::Uri(_)) => Err( + UnifiedConnectorServiceError::RequestEncodingFailedWithReason( + "URI form type is not implemented".to_string(), + ) + .into(), + ), None => Err( UnifiedConnectorServiceError::RequestEncodingFailedWithReason( "Missing form type".to_string(), diff --git a/crates/router/src/types.rs b/crates/router/src/types.rs index a5740561c7f..57043bbcc05 100644 --- a/crates/router/src/types.rs +++ b/crates/router/src/types.rs @@ -514,9 +514,9 @@ pub struct PaymentMethodTokenResult { pub connector_response: Option<ConnectorResponseData>, } +#[derive(Clone)] pub struct CreateOrderResult { - pub create_order_result: Result<Option<String>, ErrorResponse>, - pub is_create_order_performed: bool, + pub create_order_result: Result<String, ErrorResponse>, } pub struct PspTokenResult {

2025-06-24T06:16:40Z

## Type of Change  - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ### Fixes #8440 ## Description  This PR implements **V2 UCS (Unified Connector Service) Integration** for authorization and synchronization flows, building upon the existing V1 UCS integration (PR#[8280](https://github.com/juspay/hyperswitch/pull/8280)), with enhanced V2 schema support according to updated gRPC contract. **Key Features Implemented:** 1. **Authorization Flow (Payments)**: Full V2 schema support for payment authorization 2. **PSync Flow**: Payment status synchronization through UCS V2 3. **UPI Payment Method**: Support for UPI Collect payment method 4. **Enhanced Response Handling**: Improved status mapping and error handling 5. **Address Transformation Fix**: Better handling of optional address fields **Key Changes from V1 to V2:** 1. **Updated gRPC Schema**: - Migrated from `PaymentsAuthorizeRequest` to `PaymentServiceAuthorizeRequest` - Added `PaymentServiceGetRequest` for PSync flow - Enhanced field structure for better type safety 2. **New Payment Methods**: - Added UPI Collect payment method support - Proper VPA ID extraction and handling 3. **Enhanced Transformers**: - Updated transformers for authorization and sync flows - Improved card details, address structure, and payment method handling - Fixed address transformation to handle None values gracefully 4. **V2 Flow Architecture**: - Refactored payment flow to separate UCS prerequisites and decision logic - Added PSync flow integration through UCS - Feature flag protection for clean V1/V2 separation 5. **Improved Response Handling**: - Enhanced response parsing with new identifier structure - Added support for more payment states (Started, AuthenticationSuccessful, Authorizing, etc.) - Better error handling and status mapping **V2 Architecture Flow:** V2 Payment Request → call_connector_service_prerequisites() → decide_unified_connector_service_call() → ├── UCS Available → V2 Transformers → gRPC Call → V2 Response Handling └── UCS Unavailable → Traditional Connector Flow (Fallback) V2 PSync Request → call_unified_connector_service() → ├── UCS Available → V2 PSync Transformer → gRPC Get Call → Status Response └── UCS Unavailable → Traditional Connector Sync Flow **Key Technical Improvements:** - **Refactored Payment Functions**: Split `call_connector_service()` into `call_connector_service_prerequisites()` and `decide_unified_connector_service_call()` for better separation of concerns - **Enhanced V2 Transformers**: Updated card data transformation, address structure, and authentication data handling - **PSync Flow Integration**: Added complete payment synchronization support through UCS - **UPI Payment Support**: Added UPI Collect payment method with VPA ID handling - **Improved Error Handling**: Better response parsing with new identifier structure - **Customer ID Support**: Added customer ID mapping in V2 transformer implementation - **Enhanced Authentication**: Added tenant_id and merchant_id to ConnectorAuthMetadata **Files Modified:** - `crates/router/Cargo.toml` - Updated rust-grpc-client dependency to main branch - `crates/router/src/core/payments.rs` - Refactored UCS integration with V2 prerequisite and decision functions - `crates/router/src/core/payments/flows/authorize_flow.rs` - Updated to use `PaymentServiceAuthorizeRequest` - `crates/router/src/core/payments/flows/psync_flow.rs` - Added UCS V2 support for payment synchronization - `crates/router/src/core/payments/transformers.rs` - Added V2 PaymentsAuthorizeData transformer implementation and customer_id support - `crates/router/src/core/unified_connector_service/` - Updated transformers and response handlers for V2 schema - `crates/router/src/core/unified_connector_service.rs` - Added UPI payment method support and enhanced response handling - `crates/router/src/core/unified_connector_service/transformers.rs` - Major updates for V2 gRPC schema compatibility - `crates/external_services/src/grpc_client/unified_connector_service.rs` - Added payment get operations support ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  **V2 UCS Integration Evolution:** This change builds upon the existing V1 UCS integration to support the updated V2 gRPC schema and enhanced payment flow architecture. Key motivations: **Schema Evolution:** - **Updated gRPC Contracts**: V2 introduces improved field structures for better type safety and extensibility - **Enhanced Data Models**: New card details structure, improved address handling, and better identifier management - **Backward Compatibility**: V2 implementation maintains compatibility while leveraging new schema features **Feature Additions:** - **PSync Flow Support**: Enables payment status synchronization through UCS, reducing direct connector calls - **UPI Payment Method**: Adds support for popular Indian payment method through unified interface - **Enhanced Status Handling**: More granular payment states for better payment lifecycle tracking **Architectural Improvements:** - **Separation of Concerns**: Split monolithic UCS functions into prerequisite preparation and decision logic phases - **Better Feature Flag Management**: Clean V1/V2 separation using `#[cfg(feature = "v2")]` prevents conflicts - **Enhanced Error Handling**: Improved response parsing and identifier handling for better reliability - **Maintainability**: Cleaner code structure for easier debugging and future enhancements **Business Value:** - **Future-Proofing**: V2 schema supports upcoming UCS enhancements and new payment flows - **Improved Reliability**: Better error handling and response parsing reduces failure rates - **Enhanced Developer Experience**: Cleaner API interfaces and better type safety - **Operational Excellence**: Maintains existing rollout controls while improving monitoring capabilities - **Broader Payment Support**: UPI integration opens up access to Indian market payment preferences ## How did you test it?  ### Manual Testing (HAPPY CASE) #### **V2 Payment Intent Creation (Adyen via UCS)** *Request:* ```bash curl --location 'http://localhost:8080/v2/payments/create-intent' \ --header 'api-key: dev_ymXSN8By3WESknjGnFyLVwDE4tK9v8ZjnkMZsKb2cM7KgjlzLfU1SOnJ63LsIrfR' \ --header 'Content-Type: application/json' \ --header 'x-profile-id: pro_2MBjeGslBsr2Lr7AoLvr' \ --header 'Authorization: api-key=dev_ymXSN8By3WESknjGnFyLVwDE4tK9v8ZjnkMZsKb2cM7KgjlzLfU1SOnJ63LsIrfR' \ --data '{ "amount_details": { "order_amount": 100, "currency": "USD" }, "capture_method": "automatic", "authentication_type": "no_three_ds", "customer_id": "12345_cus_0197abe38df57a408b928b4111ff5038", "billing": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" } }, "shipping": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" } } }' ``` *Response:* ```json { "id": "12345_pay_0197ac4f440c73c0b34c7050d248e483", "status": "requires_payment_method", "amount_details": { "order_amount": 100, "currency": "USD", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null }, "client_secret": "cs_0197ac4f4421744094d3abffdeae634c", "profile_id": "pro_2MBjeGslBsr2Lr7AoLvr", "merchant_reference_id": null, "routing_algorithm_id": null, "capture_method": "automatic", "authentication_type": "no_three_ds", "billing": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "joseph", "last_name": "Doe" }, "phone": null, "email": null }, "shipping": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "joseph", "last_name": "Doe" }, "phone": null, "email": null }, "customer_id": "12345_cus_0197abe38df57a408b928b4111ff5038", "customer_present": "present", "description": null, "return_url": null, "setup_future_usage": "on_session", "apply_mit_exemption": "Skip", "statement_descriptor": null, "order_details": null, "allowed_payment_method_types": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "payment_link_enabled": "Skip", "payment_link_config": null, "request_incremental_authorization": "default", "expires_on": "2025-06-26T13:11:05.403Z", "frm_metadata": null, "request_external_three_ds_authentication": "Skip" } ``` #### **V2 Payment Confirmation (Adyen via UCS)** *Request:* ```bash curl --location 'http://localhost:8080/v2/payments/12345_pay_0197ac4f440c73c0b34c7050d248e483/confirm-intent' \ --header 'x-client-secret: cs_0197ac4f4421744094d3abffdeae634c' \ --header 'x-profile-id: pro_2MBjeGslBsr2Lr7AoLvr' \ --header 'x-connected-merchant-id: cloth_seller_2_X5u3WjKKaUMMtPMYCNQM' \ --header 'Authorization: publishable-key=pk_dev_b78d41b686d54407842e55c1be492fce,client-secret=cs_0197ac4f4421744094d3abffdeae634c' \ --header 'Content-Type: application/json' \ --header 'api-key: pk_dev_b78d41b686d54407842e55c1be492fce' \ --data '{ "payment_method_type": "card", "payment_method_subtype": "credit", "payment_method_data": { "card": { "card_number": "4111111111111111", "card_exp_month": "03", "card_exp_year": "30", "card_holder_name": "Joseph Doe", "card_cvc": "737" } }, "browser_info": { "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8", "language": "nl-NL", "color_depth": 24, "screen_height": 723, "screen_width": 1536, "time_zone": 0, "java_enabled": true, "java_script_enabled": true } }' ``` *Response:* ```json { "id": "12345_pay_0197ac4f440c73c0b34c7050d248e483", "status": "succeeded", "amount": { "order_amount": 100, "currency": "USD", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null, "net_amount": 100, "amount_to_capture": null, "amount_capturable": 0, "amount_captured": 100 }, "customer_id": "12345_cus_0197abe38df57a408b928b4111ff5038", "connector": "adyen", "created": "2025-06-26T12:56:05.403Z", "payment_method_data": { "billing": null }, "payment_method_type": "card", "payment_method_subtype": "credit", "connector_transaction_id": "12345_pay_0197ac4f440c73c0b34c7050d248e483", "connector_reference_id": null, "merchant_connector_id": "mca_YUhrsoeHfh0EQJE6Zqut", "browser_info": null, "error": null, "shipping": null, "billing": null, "attempts": null, "connector_token_details": null, "payment_method_id": null, "next_action": null, "return_url": "https://google.com/success", "authentication_type": "no_three_ds", "authentication_type_applied": "no_three_ds", "is_iframe_redirection_enabled": null, "merchant_reference_id": null } ``` #### **V2 Payment Intent Creation (Adyen via Traditional Connector Flow)** *Request:* ```bash curl --location 'http://localhost:8080/v2/payments/create-intent' \ --header 'api-key: dev_ymXSN8By3WESknjGnFyLVwDE4tK9v8ZjnkMZsKb2cM7KgjlzLfU1SOnJ63LsIrfR' \ --header 'Content-Type: application/json' \ --header 'x-profile-id: pro_2MBjeGslBsr2Lr7AoLvr' \ --header 'Authorization: api-key=dev_ymXSN8By3WESknjGnFyLVwDE4tK9v8ZjnkMZsKb2cM7KgjlzLfU1SOnJ63LsIrfR' \ --data '{ "amount_details": { "order_amount": 100, "currency": "USD" }, "capture_method": "automatic", "authentication_type": "no_three_ds", "customer_id": "12345_cus_0197abe38df57a408b928b4111ff5038", "billing": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" } }, "shipping": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" } } }' ``` *Response:* ```json { "id": "12345_pay_0197ac4c67657d81a796bc358b364d04", "status": "requires_payment_method", "amount_details": { "order_amount": 100, "currency": "USD", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null }, "client_secret": "cs_0197ac4c67ac7731907d52f9dac88996", "profile_id": "pro_2MBjeGslBsr2Lr7AoLvr", "merchant_reference_id": null, "routing_algorithm_id": null, "capture_method": "automatic", "authentication_type": "no_three_ds", "billing": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "joseph", "last_name": "Doe" }, "phone": null, "email": null }, "shipping": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "joseph", "last_name": "Doe" }, "phone": null, "email": null }, "customer_id": "12345_cus_0197abe38df57a408b928b4111ff5038", "customer_present": "present", "description": null, "return_url": null, "setup_future_usage": "on_session", "apply_mit_exemption": "Skip", "statement_descriptor": null, "order_details": null, "allowed_payment_method_types": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "payment_link_enabled": "Skip", "payment_link_config": null, "request_incremental_authorization": "default", "expires_on": "2025-06-26T13:07:57.887Z", "frm_metadata": null, "request_external_three_ds_authentication": "Skip" } ``` #### **V2 Payment Confirmation (Adyen via Traditional Connector Flow)** *Request:* ```bash curl --location 'http://localhost:8080/v2/payments/12345_pay_0197ac4c67657d81a796bc358b364d04/confirm-intent' \ --header 'x-client-secret: cs_0197ac4c67ac7731907d52f9dac88996' \ --header 'x-profile-id: pro_2MBjeGslBsr2Lr7AoLvr' \ --header 'x-connected-merchant-id: cloth_seller_2_X5u3WjKKaUMMtPMYCNQM' \ --header 'Authorization: publishable-key=pk_dev_b78d41b686d54407842e55c1be492fce,client-secret=cs_0197ac4c67ac7731907d52f9dac88996' \ --header 'Content-Type: application/json' \ --header 'api-key: pk_dev_b78d41b686d54407842e55c1be492fce' \ --data '{ "payment_method_type": "card", "payment_method_subtype": "credit", "payment_method_data": { "card": { "card_number": "4111111111111111", "card_exp_month": "03", "card_exp_year": "30", "card_holder_name": "Joseph Doe", "card_cvc": "737" } }, "browser_info": { "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8", "language": "nl-NL", "color_depth": 24, "screen_height": 723, "screen_width": 1536, "time_zone": 0, "java_enabled": true, "java_script_enabled": true } }' ``` *Response:* ```json { "id": "12345_pay_0197ac4c67657d81a796bc358b364d04", "status": "succeeded", "amount": { "order_amount": 100, "currency": "USD", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null, "net_amount": 100, "amount_to_capture": null, "amount_capturable": 0, "amount_captured": 100 }, "customer_id": "12345_cus_0197abe38df57a408b928b4111ff5038", "connector": "adyen", "created": "2025-06-26T12:52:57.887Z", "payment_method_data": { "billing": null }, "payment_method_type": "card", "payment_method_subtype": "credit", "connector_transaction_id": "K2LGMPJFQZ9TPM75", "connector_reference_id": null, "merchant_connector_id": "mca_YUhrsoeHfh0EQJE6Zqut", "browser_info": null, "error": null, "shipping": null, "billing": null, "attempts": null, "connector_token_details": null, "payment_method_id": null, "next_action": null, "return_url": "https://google.com/success", "authentication_type": "no_three_ds", "authentication_type_applied": "no_three_ds", "is_iframe_redirection_enabled": null, "merchant_reference_id": null } ``` ### Manual Testing (FAILURE CASE) #### **V2 Payment Intent Creation (Adyen via UCS)** *Request:* ```bash curl --location 'http://localhost:8080/v2/payments/create-intent' \ --header 'api-key: dev_ymXSN8By3WESknjGnFyLVwDE4tK9v8ZjnkMZsKb2cM7KgjlzLfU1SOnJ63LsIrfR' \ --header 'Content-Type: application/json' \ --header 'x-profile-id: pro_2MBjeGslBsr2Lr7AoLvr' \ --header 'Authorization: api-key=dev_ymXSN8By3WESknjGnFyLVwDE4tK9v8ZjnkMZsKb2cM7KgjlzLfU1SOnJ63LsIrfR' \ --data '{ "amount_details": { "order_amount": 100, "currency": "USD" }, "capture_method": "automatic", "authentication_type": "no_three_ds", "customer_id": "12345_cus_0197abe38df57a408b928b4111ff5038", "billing": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" } }, "shipping": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" } } }' ``` *Response:* ```json { "id": "12345_pay_0197ac52cee5796099a0ae352092a707", "status": "requires_payment_method", "amount_details": { "order_amount": 100, "currency": "USD", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null }, "client_secret": "cs_0197ac52cefb77e2be6097f5d54b1152", "profile_id": "pro_2MBjeGslBsr2Lr7AoLvr", "merchant_reference_id": null, "routing_algorithm_id": null, "capture_method": "automatic", "authentication_type": "no_three_ds", "billing": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "joseph", "last_name": "Doe" }, "phone": null, "email": null }, "shipping": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "joseph", "last_name": "Doe" }, "phone": null, "email": null }, "customer_id": "12345_cus_0197abe38df57a408b928b4111ff5038", "customer_present": "present", "description": null, "return_url": null, "setup_future_usage": "on_session", "apply_mit_exemption": "Skip", "statement_descriptor": null, "order_details": null, "allowed_payment_method_types": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "payment_link_enabled": "Skip", "payment_link_config": null, "request_incremental_authorization": "default", "expires_on": "2025-06-26T13:14:57.559Z", "frm_metadata": null, "request_external_three_ds_authentication": "Skip" } ``` #### **V2 Payment Confirmation (Adyen via UCS)** *Request:* ```bash curl --location 'http://localhost:8080/v2/payments/12345_pay_0197ac52cee5796099a0ae352092a707/confirm-intent' \ --header 'x-client-secret: cs_0197ac52cefb77e2be6097f5d54b1152' \ --header 'x-profile-id: pro_2MBjeGslBsr2Lr7AoLvr' \ --header 'x-connected-merchant-id: cloth_seller_2_X5u3WjKKaUMMtPMYCNQM' \ --header 'Authorization: publishable-key=pk_dev_b78d41b686d54407842e55c1be492fce,client-secret=cs_0197ac52cefb77e2be6097f5d54b1152' \ --header 'Content-Type: application/json' \ --header 'api-key: pk_dev_b78d41b686d54407842e55c1be492fce' \ --data '{ "payment_method_type": "card", "payment_method_subtype": "credit", "payment_method_data": { "card": { "card_number": "4111111111111111", "card_exp_month": "03", "card_exp_year": "30", "card_holder_name": "Joseph Doe", "card_cvc": "730" } }, "browser_info": { "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8", "language": "nl-NL", "color_depth": 24, "screen_height": 723, "screen_width": 1536, "time_zone": 0, "java_enabled": true, "java_script_enabled": true } }' ``` *Response:* ```json { "id": "12345_pay_0197ac52cee5796099a0ae352092a707", "status": "failed", "amount": { "order_amount": 100, "currency": "USD", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null, "net_amount": 100, "amount_to_capture": null, "amount_capturable": 0, "amount_captured": 0 }, "customer_id": "12345_cus_0197abe38df57a408b928b4111ff5038", "connector": "adyen", "created": "2025-06-26T12:59:57.559Z", "payment_method_data": { "billing": null }, "payment_method_type": "card", "payment_method_subtype": "credit", "connector_transaction_id": "G4QT66CH8WCFHJ75", "connector_reference_id": null, "merchant_connector_id": "mca_YUhrsoeHfh0EQJE6Zqut", "browser_info": null, "error": { "code": "24", "message": "CVC Declined", "unified_code": null, "unified_message": null, "network_advice_code": null, "network_decline_code": null, "network_error_message": null }, "shipping": null, "billing": null, "attempts": null, "connector_token_details": null, "payment_method_id": null, "next_action": null, "return_url": "https://google.com/success", "authentication_type": "no_three_ds", "authentication_type_applied": "no_three_ds", "is_iframe_redirection_enabled": null, "merchant_reference_id": null } ``` #### **V2 Payment Intent Creation (Adyen via Traditional Connector Flow)** *Request:* ```bash curl --location 'http://localhost:8080/v2/payments/create-intent' \ --header 'api-key: dev_ymXSN8By3WESknjGnFyLVwDE4tK9v8ZjnkMZsKb2cM7KgjlzLfU1SOnJ63LsIrfR' \ --header 'Content-Type: application/json' \ --header 'x-profile-id: pro_2MBjeGslBsr2Lr7AoLvr' \ --header 'Authorization: api-key=dev_ymXSN8By3WESknjGnFyLVwDE4tK9v8ZjnkMZsKb2cM7KgjlzLfU1SOnJ63LsIrfR' \ --data '{ "amount_details": { "order_amount": 100, "currency": "USD" }, "capture_method": "automatic", "authentication_type": "no_three_ds", "customer_id": "12345_cus_0197abe38df57a408b928b4111ff5038", "billing": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" } }, "shipping": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "joseph", "last_name": "Doe" } } }' ``` *Response:* ```json { "id": "12345_pay_0197ac5574b37982b150606298590cfb", "status": "requires_payment_method", "amount_details": { "order_amount": 100, "currency": "USD", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null }, "client_secret": "cs_0197ac5574c57c50b773a7230ffffe69", "profile_id": "pro_2MBjeGslBsr2Lr7AoLvr", "merchant_reference_id": null, "routing_algorithm_id": null, "capture_method": "automatic", "authentication_type": "no_three_ds", "billing": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "joseph", "last_name": "Doe" }, "phone": null, "email": null }, "shipping": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "joseph", "last_name": "Doe" }, "phone": null, "email": null }, "customer_id": "12345_cus_0197abe38df57a408b928b4111ff5038", "customer_present": "present", "description": null, "return_url": null, "setup_future_usage": "on_session", "apply_mit_exemption": "Skip", "statement_descriptor": null, "order_details": null, "allowed_payment_method_types": null, "metadata": null, "connector_metadata": null, "feature_metadata": null, "payment_link_enabled": "Skip", "payment_link_config": null, "request_incremental_authorization": "default", "expires_on": "2025-06-26T13:17:51.072Z", "frm_metadata": null, "request_external_three_ds_authentication": "Skip" } ``` #### **V2 Payment Confirmation (Adyen via Traditional Connector Flow)** *Request:* ```bash curl --location 'http://localhost:8080/v2/payments/12345_pay_0197ac5574b37982b150606298590cfb/confirm-intent' \ --header 'x-client-secret: cs_0197ac5574c57c50b773a7230ffffe69' \ --header 'x-profile-id: pro_2MBjeGslBsr2Lr7AoLvr' \ --header 'x-connected-merchant-id: cloth_seller_2_X5u3WjKKaUMMtPMYCNQM' \ --header 'Authorization: publishable-key=pk_dev_b78d41b686d54407842e55c1be492fce,client-secret=cs_0197ac5574c57c50b773a7230ffffe69' \ --header 'Content-Type: application/json' \ --header 'api-key: pk_dev_b78d41b686d54407842e55c1be492fce' \ --data '{ "payment_method_type": "card", "payment_method_subtype": "credit", "payment_method_data": { "card": { "card_number": "4111111111111111", "card_exp_month": "03", "card_exp_year": "30", "card_holder_name": "Joseph Doe", "card_cvc": "730" } }, "browser_info": { "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8", "language": "nl-NL", "color_depth": 24, "screen_height": 723, "screen_width": 1536, "time_zone": 0, "java_enabled": true, "java_script_enabled": true } }' ``` *Response:* ```json { "id": "12345_pay_0197ac5574b37982b150606298590cfb", "status": "failed", "amount": { "order_amount": 100, "currency": "USD", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null, "net_amount": 100, "amount_to_capture": null, "amount_capturable": 0, "amount_captured": 0 }, "customer_id": "12345_cus_0197abe38df57a408b928b4111ff5038", "connector": "adyen", "created": "2025-06-26T13:02:51.072Z", "payment_method_data": { "billing": null }, "payment_method_type": "card", "payment_method_subtype": "credit", "connector_transaction_id": "DXZQPDL34QGTPM75", "connector_reference_id": null, "merchant_connector_id": "mca_YUhrsoeHfh0EQJE6Zqut", "browser_info": null, "error": { "code": "24", "message": "CVC Declined", "unified_code": null, "unified_message": null, "network_advice_code": null, "network_decline_code": null, "network_error_message": "DECLINED CVC Incorrect" }, "shipping": null, "billing": null, "attempts": null, "connector_token_details": null, "payment_method_id": null, "next_action": null, "return_url": "https://google.com/success", "authentication_type": "no_three_ds", "authentication_type_applied": "no_three_ds", "is_iframe_redirection_enabled": null, "merchant_reference_id": null } ``` ###UPI Collect payment through UCS *Request* ```bash curl --location 'http://localhost:8080/v2/payments' \ --header 'x-profile-id: pro_2MBjeGslBsr2Lr7AoLvr' \ --header 'x-merchant-id: cloth_seller_2_H3Oh1h4iu0wg8BWGvMzu' \ --header 'x-tenant-id: public' \ --header 'Content-Type: application/json' \ --header 'api-key: dev_ymXSN8By3WESknjGnFyLVwDE4tK9v8ZjnkMZsKb2cM7KgjlzLfU1SOnJ63LsIrfR' \ --data-raw '{ "amount_details": { "currency": "INR", "order_amount": 1000 }, "merchant_connector_details": { "connector_name": "razorpay", "merchant_connector_creds": { "auth_type": "SignatureKey", "key1": "*************************", "api_key": "********************", "api_secret": "*******************" } }, "merchant_reference_id": "12345_pay_01970c787911751013554", "payment_method_data": { "upi": { "upi_collect": { "vpa_id": "failure@razorpay" } }, "billing": { "phone": { "number": "8800574493", "country_code": "+91" }, "email": "[email protected]" } }, "payment_method_subtype": "upi_collect", "payment_method_type": "upi" }' ``` *Response* ```json { "id": "12345_pay_0197ceee564473609731b2ab35827cc7", "status": "processing", "amount": { "order_amount": 1000, "currency": "INR", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null, "net_amount": 1000, "amount_to_capture": null, "amount_capturable": 0, "amount_captured": null }, "customer_id": null, "connector": "razorpay", "created": "2025-07-03T06:16:55.621Z", "payment_method_data": { "billing": { "address": null, "phone": { "number": "8800574493", "country_code": "+91" }, "email": "[email protected]" } }, "payment_method_type": "upi", "payment_method_subtype": "upi_collect", "connector_transaction_id": "pay_QoUbCBtcPCfaWY", "connector_reference_id": "order_QoUbBDL6PKnuZY", "merchant_connector_id": null, "browser_info": null, "error": null, "shipping": null, "billing": null, "attempts": null, "connector_token_details": null, "payment_method_id": null, "next_action": null, "return_url": "https://google.com/success", "authentication_type": null, "authentication_type_applied": "no_three_ds", "is_iframe_redirection_enabled": null, "merchant_reference_id": "12345_pay_01970c787911751013554", "whole_connector_response": null } ``` ### PSync through UCS *Request* ```bash curl --location 'http://localhost:8080/v2/payments/12345_pay_0197ceee564473609731b2ab35827cc7' \ --header 'x-profile-id: pro_2MBjeGslBsr2Lr7AoLvr' \ --header 'x-merchant-id: cloth_seller_2_H3Oh1h4iu0wg8BWGvMzu' \ --header 'x-tenant-id: public' \ --header 'Content-Type: application/json' \ --header 'api-key: dev_ymXSN8By3WESknjGnFyLVwDE4tK9v8ZjnkMZsKb2cM7KgjlzLfU1SOnJ63LsIrfR' \ --data '{ "merchant_connector_details": { "connector_name": "razorpay", "merchant_connector_creds": { "auth_type": "SignatureKey", "key1": "**************", "api_key": "********************", "api_secret": "******************" } }, "force_sync": true }'``` *Response* ```json { "id": "12345_pay_0197ceee564473609731b2ab35827cc7", "status": "failed", "amount": { "order_amount": 1000, "currency": "INR", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null, "net_amount": 1000, "amount_to_capture": null, "amount_capturable": 0, "amount_captured": 0 }, "customer_id": null, "connector": "razorpay", "created": "2025-07-03T06:16:55.621Z", "payment_method_data": { "billing": { "address": null, "phone": { "number": "8800574493", "country_code": "+91" }, "email": "[email protected]" } }, "payment_method_type": "upi", "payment_method_subtype": "upi_collect", "connector_transaction_id": "pay_QoUbCBtcPCfaWY", "connector_reference_id": "order_QoUbBDL6PKnuZY", "merchant_connector_id": null, "browser_info": null, "error": { "code": "", "message": "", "unified_code": null, "unified_message": null, "network_advice_code": null, "network_decline_code": null, "network_error_message": null }, "shipping": null, "billing": null, "attempts": null, "connector_token_details": null, "payment_method_id": null, "next_action": null, "return_url": "https://google.com/success", "authentication_type": null, "authentication_type_applied": null, "is_iframe_redirection_enabled": null, "merchant_reference_id": "12345_pay_01970c787911751013554", "whole_connector_response": null } ``` **V2 Schema Testing:** - V2 gRPC schema compatibility verification - `PaymentServiceAuthorizeRequest` field mapping validation - Enhanced card details and address structure testing - Response identifier parsing with new structure **Fallback Testing:** - UCS service unavailable → Automatic fallback to traditional connector flow - Invalid authentication → Fallback with error logging - V2 transformer errors → Graceful degradation to V1 flow - Rollout percentage = 0% → Traditional flow used - Rollout percentage = 100% → UCS V2 flow used ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

b1c9be1600dbd897c32adcc2d8b98e77ec67c516

juspay/hyperswitch

juspay__hyperswitch-8406

Bug: Fix payment redirects for v2 Fix payment redirects for v2

diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs index 59de54f41fa..e3fdf6e1cac 100644 --- a/crates/router/src/core/payments.rs +++ b/crates/router/src/core/payments.rs @@ -2996,7 +2996,7 @@ impl PaymentRedirectFlow for PaymentRedirectSync { force_sync: true, expand_attempts: false, all_keys_required: None, - merchant_connector_details: todo!(), // TODO: Implement for connectors requiring 3DS or redirection-based authentication flows. + merchant_connector_details: None, // TODO: Implement for connectors requiring 3DS or redirection-based authentication flows. }; let operation = operations::PaymentGet;

2025-06-20T11:02:47Z

## Type of Change  - [x] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  This PR fixes payment redirects in v2. This was due to the field merchant_connector_details set as todo!() ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  ## How did you test it?  - Make 3DS payment ``` curl --location 'http://localhost:8080/v2/payments' \ --header 'Content-Type: application/json' \ --header 'x-profile-id: pro_295oknnkIU8LhiO6RTCy' \ --header 'Authorization: api-key=dev_8OKnwsVtu4ZIxxgqDfVQwnQrUfdORX3Ivo9i8Yxp0rB3mEZxiv9UZchQimjPgNnx' \ --data-raw '{ "amount_details": { "currency": "USD", "order_amount": 6540 }, "authentication_type": "three_ds", "payment_method_data": { "card": { "card_cvc": "123", "card_exp_month": "10", "card_exp_year": "25", "card_holder_name": "joseph Doe", "card_number": "4242424242424242" } }, "payment_method_subtype": "credit", "payment_method_type": "card" }' ``` Response ``` { "id": "12345_pay_01978cfda5fa7c12b1ba298cca0470c2", "status": "requires_customer_action", "amount": { "order_amount": 6540, "currency": "USD", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null, "net_amount": 6540, "amount_to_capture": null, "amount_capturable": 0, "amount_captured": null }, "customer_id": null, "connector": "stripe", "created": "2025-06-20T10:58:42.813Z", "payment_method_data": { "billing": null }, "payment_method_type": "card", "payment_method_subtype": "credit", "connector_transaction_id": "pi_3Rc2edD5R7gDAGff01vwkClL", "connector_reference_id": null, "merchant_connector_id": "mca_0GI0dABwex0qdnwlUelt", "browser_info": null, "error": null, "shipping": null, "billing": null, "attempts": null, "connector_token_details": { "token": "pm_1Rc2edD5R7gDAGffEOosatGV", "connector_token_request_reference_id": "eDuVwDClp0zQPbbkLZ" }, "payment_method_id": null, "next_action": { "type": "redirect_to_url", "redirect_to_url": "http://localhost:8080/v2/payments/12345_pay_01978cfda5fa7c12b1ba298cca0470c2/start-redirection?publishable_key=pk_dev_4499ca4660714d6b83b379218164187a&profile_id=pro_295oknnkIU8LhiO6RTCy" }, "return_url": "https://google.com/success", "authentication_type": "three_ds", "authentication_type_applied": "three_ds", "is_iframe_redirection_enabled": null, "merchant_reference_id": null } ``` Redirect to URL - Payments Sync ``` curl --location 'http://localhost:8080/v2/payments/12345_pay_01978cfda5fa7c12b1ba298cca0470c2?force_sync=true' \ --header 'x-profile-id: pro_295oknnkIU8LhiO6RTCy' \ --header 'Authorization: api-key=dev_8OKnwsVtu4ZIxxgqDfVQwnQrUfdORX3Ivo9i8Yxp0rB3mEZxiv9UZchQimjPgNnx' \ --data '' ``` Response ``` { "id": "12345_pay_01978cfda5fa7c12b1ba298cca0470c2", "status": "succeeded", "amount": { "order_amount": 6540, "currency": "USD", "shipping_cost": null, "order_tax_amount": null, "external_tax_calculation": "skip", "surcharge_calculation": "skip", "surcharge_amount": null, "tax_on_surcharge": null, "net_amount": 6540, "amount_to_capture": null, "amount_capturable": 0, "amount_captured": 6540 }, "customer_id": null, "connector": "stripe", "created": "2025-06-20T10:58:42.813Z", "payment_method_data": { "billing": null }, "payment_method_type": "card", "payment_method_subtype": "credit", "connector_transaction_id": "pi_3Rc2edD5R7gDAGff01vwkClL", "connector_reference_id": null, "merchant_connector_id": "mca_0GI0dABwex0qdnwlUelt", "browser_info": null, "error": null, "shipping": null, "billing": null, "attempts": null, "connector_token_details": { "token": "pm_1Rc2edD5R7gDAGffEOosatGV", "connector_token_request_reference_id": "eDuVwDClp0zQPbbkLZ" }, "payment_method_id": null, "next_action": null, "return_url": "https://google.com/success", "authentication_type": "three_ds", "authentication_type_applied": null, "is_iframe_redirection_enabled": null, "merchant_reference_id": null } ``` ## Checklist  - [ ] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.114.0

c99ec73885e0c64552f01826b20a1af7a934a65c

juspay/hyperswitch

juspay__hyperswitch-8392

Bug: [FEATURE] allow payout_id to be configurable ### Feature Description `payout_id` is an unique identifier for payout resource which is auto generated during payout creation. This field needs to be configurable during payout creation by accepting in the API. Along with this, a `merchant_order_reference_id` needs to be added which is an unique identifier for the consumer of the API. ### Possible Implementation Below changes are needed in payout flow across different components - - Add `payout_id` to API models - Add `PayoutId` domain type - Add `merchant_order_reference_id` to API and diesel models - Add DB queries for fetching orders using `merchant_order_reference_id` - Add `merchant_order_reference_id` as a filter for OLAP APIs - Use uuidv4 for payout ID creation for Wise ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? None

diff --git a/api-reference/v1/openapi_spec_v1.json b/api-reference/v1/openapi_spec_v1.json index fe57a935d16..85223163b29 100644 --- a/api-reference/v1/openapi_spec_v1.json +++ b/api-reference/v1/openapi_spec_v1.json @@ -24303,6 +24303,13 @@ "client_secret" ], "properties": { + "merchant_order_reference_id": { + "type": "string", + "description": "Your unique identifier for this payout or order. This ID helps you reconcile payouts on your system. If provided, it is passed to the connector if supported.", + "example": "merchant_order_ref_123", + "nullable": true, + "maxLength": 255 + }, "amount": { "type": "integer", "format": "int64", @@ -24609,6 +24616,13 @@ "example": "merchant_1668273825", "maxLength": 255 }, + "merchant_order_reference_id": { + "type": "string", + "description": "Your unique identifier for this payout or order. This ID helps you reconcile payouts on your system. If provided, it is passed to the connector if supported.", + "example": "merchant_order_ref_123", + "nullable": true, + "maxLength": 255 + }, "amount": { "type": "integer", "format": "int64", @@ -24902,13 +24916,13 @@ "starting_after": { "type": "string", "description": "A cursor for use in pagination, fetch the next list after some object", - "example": "pay_fafa124123", + "example": "payout_fafa124123", "nullable": true }, "ending_before": { "type": "string", "description": "A cursor for use in pagination, fetch the previous list before some object", - "example": "pay_fafa124123", + "example": "payout_fafa124123", "nullable": true }, "limit": { @@ -24955,6 +24969,13 @@ "maxLength": 30, "minLength": 30 }, + "merchant_order_reference_id": { + "type": "string", + "description": "The merchant order reference ID for payout", + "example": "merchant_order_ref_123", + "nullable": true, + "maxLength": 255 + }, "profile_id": { "type": "string", "description": "The identifier for business profile", @@ -25249,6 +25270,13 @@ "PayoutUpdateRequest": { "type": "object", "properties": { + "merchant_order_reference_id": { + "type": "string", + "description": "Your unique identifier for this payout or order. This ID helps you reconcile payouts on your system. If provided, it is passed to the connector if supported.", + "example": "merchant_order_ref_123", + "nullable": true, + "maxLength": 255 + }, "amount": { "type": "integer", "format": "int64", @@ -25479,6 +25507,13 @@ "currency" ], "properties": { + "merchant_order_reference_id": { + "type": "string", + "description": "Your unique identifier for this payout or order. This ID helps you reconcile payouts on your system. If provided, it is passed to the connector if supported.", + "example": "merchant_order_ref_123", + "nullable": true, + "maxLength": 255 + }, "amount": { "type": "integer", "format": "int64", diff --git a/api-reference/v2/openapi_spec_v2.json b/api-reference/v2/openapi_spec_v2.json index 5ceb5f032f5..0bd642c8be8 100644 --- a/api-reference/v2/openapi_spec_v2.json +++ b/api-reference/v2/openapi_spec_v2.json @@ -19579,7 +19579,19 @@ "additionalProperties": false }, "PayoutActionRequest": { - "type": "object" + "type": "object", + "required": [ + "payout_id" + ], + "properties": { + "payout_id": { + "type": "string", + "description": "Unique identifier for the payout. This ensures idempotency for multiple payouts\nthat have been done by a single merchant. This field is auto generated and is returned in the API response.", + "example": "187282ab-40ef-47a9-9206-5099ba31e432", + "maxLength": 30, + "minLength": 30 + } + } }, "PayoutAttemptResponse": { "type": "object", @@ -19746,6 +19758,13 @@ "nullable": true, "maxLength": 255 }, + "merchant_order_reference_id": { + "type": "string", + "description": "Your unique identifier for this payout or order. This ID helps you reconcile payouts on your system. If provided, it is passed to the connector if supported.", + "example": "merchant_order_ref_123", + "nullable": true, + "maxLength": 255 + }, "amount": { "type": "integer", "format": "int64", @@ -20001,6 +20020,13 @@ "example": "merchant_1668273825", "maxLength": 255 }, + "merchant_order_reference_id": { + "type": "string", + "description": "Your unique identifier for this payout or order. This ID helps you reconcile payouts on your system. If provided, it is passed to the connector if supported.", + "example": "merchant_order_ref_123", + "nullable": true, + "maxLength": 255 + }, "amount": { "type": "integer", "format": "int64", @@ -20279,13 +20305,13 @@ "starting_after": { "type": "string", "description": "A cursor for use in pagination, fetch the next list after some object", - "example": "pay_fafa124123", + "example": "payout_fafa124123", "nullable": true }, "ending_before": { "type": "string", "description": "A cursor for use in pagination, fetch the previous list before some object", - "example": "pay_fafa124123", + "example": "payout_fafa124123", "nullable": true }, "limit": { @@ -20332,6 +20358,13 @@ "maxLength": 30, "minLength": 30 }, + "merchant_order_reference_id": { + "type": "string", + "description": "The merchant order reference ID for payout", + "example": "merchant_order_ref_123", + "nullable": true, + "maxLength": 255 + }, "profile_id": { "type": "string", "description": "The identifier for business profile", diff --git a/crates/api_models/src/events/payouts.rs b/crates/api_models/src/events/payouts.rs index a08f3ed94a8..b7eded681a3 100644 --- a/crates/api_models/src/events/payouts.rs +++ b/crates/api_models/src/events/payouts.rs @@ -9,7 +9,7 @@ use crate::payouts::{ impl ApiEventMetric for PayoutRetrieveRequest { fn get_api_event_type(&self) -> Option<ApiEventsType> { Some(ApiEventsType::Payout { - payout_id: self.payout_id.clone(), + payout_id: self.payout_id.to_owned(), }) } } @@ -17,7 +17,7 @@ impl ApiEventMetric for PayoutRetrieveRequest { impl ApiEventMetric for PayoutCreateRequest { fn get_api_event_type(&self) -> Option<ApiEventsType> { self.payout_id.as_ref().map(|id| ApiEventsType::Payout { - payout_id: id.clone(), + payout_id: id.to_owned(), }) } } @@ -25,7 +25,7 @@ impl ApiEventMetric for PayoutCreateRequest { impl ApiEventMetric for PayoutCreateResponse { fn get_api_event_type(&self) -> Option<ApiEventsType> { Some(ApiEventsType::Payout { - payout_id: self.payout_id.clone(), + payout_id: self.payout_id.to_owned(), }) } } @@ -33,7 +33,7 @@ impl ApiEventMetric for PayoutCreateResponse { impl ApiEventMetric for PayoutActionRequest { fn get_api_event_type(&self) -> Option<ApiEventsType> { Some(ApiEventsType::Payout { - payout_id: self.payout_id.clone(), + payout_id: self.payout_id.to_owned(), }) } } @@ -65,7 +65,7 @@ impl ApiEventMetric for PayoutListFilters { impl ApiEventMetric for PayoutLinkInitiateRequest { fn get_api_event_type(&self) -> Option<ApiEventsType> { Some(ApiEventsType::Payout { - payout_id: self.payout_id.clone(), + payout_id: self.payout_id.to_owned(), }) } } diff --git a/crates/api_models/src/payouts.rs b/crates/api_models/src/payouts.rs index cf07fd9e109..a6fdaa2b6e5 100644 --- a/crates/api_models/src/payouts.rs +++ b/crates/api_models/src/payouts.rs @@ -16,7 +16,7 @@ use utoipa::ToSchema; use crate::{enums as api_enums, payment_methods::RequiredFieldInfo, payments}; -#[derive(Debug, Deserialize, Serialize, Clone, ToSchema)] +#[derive(Debug, Serialize, Clone, ToSchema)] pub enum PayoutRequest { PayoutActionRequest(PayoutActionRequest), PayoutCreateRequest(Box<PayoutCreateRequest>), @@ -37,13 +37,17 @@ pub struct PayoutCreateRequest { example = "187282ab-40ef-47a9-9206-5099ba31e432" )] #[remove_in(PayoutsCreateRequest, PayoutUpdateRequest, PayoutConfirmRequest)] - pub payout_id: Option<String>, // TODO: #1321 https://github.com/juspay/hyperswitch/issues/1321 + pub payout_id: Option<id_type::PayoutId>, /// This is an identifier for the merchant account. This is inferred from the API key provided during the request, **not required to be included in the Payout Create/Update Request.** #[schema(max_length = 255, value_type = Option<String>, example = "merchant_1668273825")] #[remove_in(PayoutsCreateRequest, PayoutUpdateRequest, PayoutConfirmRequest)] pub merchant_id: Option<id_type::MerchantId>, + /// Your unique identifier for this payout or order. This ID helps you reconcile payouts on your system. If provided, it is passed to the connector if supported. + #[schema(value_type = Option<String>, max_length = 255, example = "merchant_order_ref_123")] + pub merchant_order_reference_id: Option<String>, + /// The payout amount. Amount for the payout in lowest denomination of the currency. (i.e) in cents for USD denomination, in paisa for INR denomination etc., #[schema(value_type = Option<u64>, example = 1000)] #[mandatory_in(PayoutsCreateRequest = u64)] @@ -399,13 +403,17 @@ pub struct PayoutCreateResponse { max_length = 30, example = "187282ab-40ef-47a9-9206-5099ba31e432" )] - pub payout_id: String, // TODO: Update this to PayoutIdType similar to PaymentIdType + pub payout_id: id_type::PayoutId, /// This is an identifier for the merchant account. This is inferred from the API key /// provided during the request #[schema(max_length = 255, value_type = String, example = "merchant_1668273825")] pub merchant_id: id_type::MerchantId, + /// Your unique identifier for this payout or order. This ID helps you reconcile payouts on your system. If provided, it is passed to the connector if supported. + #[schema(value_type = Option<String>, max_length = 255, example = "merchant_order_ref_123")] + pub merchant_order_reference_id: Option<String>, + /// The payout amount. Amount for the payout in lowest denomination of the currency. (i.e) in cents for USD denomination, in paisa for INR denomination etc., #[schema(value_type = i64, example = 1000)] pub amount: common_utils::types::MinorUnit, @@ -638,7 +646,7 @@ pub struct PayoutRetrieveBody { pub merchant_id: Option<id_type::MerchantId>, } -#[derive(Default, Debug, Serialize, ToSchema, Clone, Deserialize)] +#[derive(Debug, Serialize, ToSchema, Clone, Deserialize)] pub struct PayoutRetrieveRequest { /// Unique identifier for the payout. This ensures idempotency for multiple payouts /// that have been done by a single merchant. This field is auto generated and is returned in the API response. @@ -648,7 +656,7 @@ pub struct PayoutRetrieveRequest { max_length = 30, example = "187282ab-40ef-47a9-9206-5099ba31e432" )] - pub payout_id: String, + pub payout_id: id_type::PayoutId, /// `force_sync` with the connector to get payout details /// (defaults to false) @@ -660,9 +668,7 @@ pub struct PayoutRetrieveRequest { pub merchant_id: Option<id_type::MerchantId>, } -#[derive( - Default, Debug, Deserialize, Serialize, Clone, ToSchema, router_derive::PolymorphicSchema, -)] +#[derive(Debug, Serialize, Clone, ToSchema, router_derive::PolymorphicSchema)] #[generate_schemas(PayoutCancelRequest, PayoutFulfillRequest)] pub struct PayoutActionRequest { /// Unique identifier for the payout. This ensures idempotency for multiple payouts @@ -673,8 +679,7 @@ pub struct PayoutActionRequest { max_length = 30, example = "187282ab-40ef-47a9-9206-5099ba31e432" )] - #[serde(skip_deserializing)] - pub payout_id: String, + pub payout_id: id_type::PayoutId, } #[derive(Default, Debug, ToSchema, Clone, Deserialize)] @@ -722,12 +727,12 @@ pub struct PayoutListConstraints { pub customer_id: Option<id_type::CustomerId>, /// A cursor for use in pagination, fetch the next list after some object - #[schema(example = "pay_fafa124123")] - pub starting_after: Option<String>, + #[schema(example = "payout_fafa124123", value_type = Option<String>,)] + pub starting_after: Option<id_type::PayoutId>, /// A cursor for use in pagination, fetch the previous list before some object - #[schema(example = "pay_fafa124123")] - pub ending_before: Option<String>, + #[schema(example = "payout_fafa124123", value_type = Option<String>,)] + pub ending_before: Option<id_type::PayoutId>, /// limit on the number of objects to return #[schema(default = 10, maximum = 100)] @@ -755,7 +760,10 @@ pub struct PayoutListFilterConstraints { max_length = 30, example = "187282ab-40ef-47a9-9206-5099ba31e432" )] - pub payout_id: Option<String>, + pub payout_id: Option<id_type::PayoutId>, + /// The merchant order reference ID for payout + #[schema(value_type = Option<String>, max_length = 255, example = "merchant_order_ref_123")] + pub merchant_order_reference_id: Option<String>, /// The identifier for business profile #[schema(value_type = Option<String>)] pub profile_id: Option<id_type::ProfileId>, @@ -826,7 +834,8 @@ pub struct PayoutLinkResponse { pub struct PayoutLinkInitiateRequest { #[schema(value_type = String)] pub merchant_id: id_type::MerchantId, - pub payout_id: String, + #[schema(value_type = String)] + pub payout_id: id_type::PayoutId, } #[derive(Clone, Debug, serde::Serialize)] @@ -834,7 +843,7 @@ pub struct PayoutLinkDetails { pub publishable_key: Secret<String>, pub client_secret: Secret<String>, pub payout_link_id: String, - pub payout_id: String, + pub payout_id: id_type::PayoutId, pub customer_id: id_type::CustomerId, #[serde(with = "common_utils::custom_serde::iso8601")] pub session_expiry: PrimitiveDateTime, @@ -870,7 +879,7 @@ pub struct RequiredFieldsOverrideRequest { #[derive(Clone, Debug, serde::Serialize)] pub struct PayoutLinkStatusDetails { pub payout_link_id: String, - pub payout_id: String, + pub payout_id: id_type::PayoutId, pub customer_id: id_type::CustomerId, #[serde(with = "common_utils::custom_serde::iso8601")] pub session_expiry: PrimitiveDateTime, diff --git a/crates/api_models/src/webhooks.rs b/crates/api_models/src/webhooks.rs index 4667866073b..177310de18f 100644 --- a/crates/api_models/src/webhooks.rs +++ b/crates/api_models/src/webhooks.rs @@ -98,7 +98,7 @@ pub enum WebhookResponseTracker { }, #[cfg(feature = "payouts")] Payout { - payout_id: String, + payout_id: common_utils::id_type::PayoutId, status: common_enums::PayoutStatus, }, #[cfg(feature = "v1")] diff --git a/crates/common_utils/src/events.rs b/crates/common_utils/src/events.rs index 376b57fbb47..e1964296755 100644 --- a/crates/common_utils/src/events.rs +++ b/crates/common_utils/src/events.rs @@ -12,7 +12,7 @@ pub trait ApiEventMetric { #[serde(tag = "flow_type", rename_all = "snake_case")] pub enum ApiEventsType { Payout { - payout_id: String, + payout_id: id_type::PayoutId, }, #[cfg(feature = "v1")] Payment { diff --git a/crates/common_utils/src/id_type.rs b/crates/common_utils/src/id_type.rs index d9daa5caf9d..6d73a90eab2 100644 --- a/crates/common_utils/src/id_type.rs +++ b/crates/common_utils/src/id_type.rs @@ -11,6 +11,7 @@ mod merchant; mod merchant_connector_account; mod organization; mod payment; +mod payout; mod profile; mod profile_acquirer; mod refunds; @@ -27,6 +28,7 @@ use diesel::{ serialize::{Output, ToSql}, sql_types, }; +pub use payout::PayoutId; use serde::{Deserialize, Serialize}; use thiserror::Error; diff --git a/crates/common_utils/src/id_type/payout.rs b/crates/common_utils/src/id_type/payout.rs new file mode 100644 index 00000000000..8faa661d363 --- /dev/null +++ b/crates/common_utils/src/id_type/payout.rs @@ -0,0 +1,10 @@ +crate::id_type!( + PayoutId, + "A domain type for payout_id that can be used for payout ids" +); +crate::impl_id_type_methods!(PayoutId, "payout_id"); +crate::impl_debug_id_type!(PayoutId); +crate::impl_try_from_cow_str_id_type!(PayoutId, "payout_id"); +crate::impl_generate_id_id_type!(PayoutId, "payout"); +crate::impl_queryable_id_type!(PayoutId); +crate::impl_to_sql_from_sql_id_type!(PayoutId); diff --git a/crates/common_utils/src/link_utils.rs b/crates/common_utils/src/link_utils.rs index 2201000d062..89a52f44792 100644 --- a/crates/common_utils/src/link_utils.rs +++ b/crates/common_utils/src/link_utils.rs @@ -149,7 +149,7 @@ pub struct PayoutLinkData { /// Identifier for the customer pub customer_id: id_type::CustomerId, /// Identifier for the payouts resource - pub payout_id: String, + pub payout_id: id_type::PayoutId, /// Link to render the payout link pub link: url::Url, /// Client secret generated for authenticating frontend APIs diff --git a/crates/diesel_models/src/events.rs b/crates/diesel_models/src/events.rs index cbc39340dcf..bc9f0788113 100644 --- a/crates/diesel_models/src/events.rs +++ b/crates/diesel_models/src/events.rs @@ -74,7 +74,7 @@ pub enum EventMetadata { payment_id: common_utils::id_type::GlobalPaymentId, }, Payout { - payout_id: String, + payout_id: common_utils::id_type::PayoutId, }, #[cfg(feature = "v1")] Refund { diff --git a/crates/diesel_models/src/generic_link.rs b/crates/diesel_models/src/generic_link.rs index 28402692480..d6071268eae 100644 --- a/crates/diesel_models/src/generic_link.rs +++ b/crates/diesel_models/src/generic_link.rs @@ -156,7 +156,7 @@ pub struct PaymentMethodCollectLinkData { #[diesel(primary_key(link_id))] pub struct PayoutLink { pub link_id: String, - pub primary_reference: String, + pub primary_reference: common_utils::id_type::PayoutId, pub merchant_id: common_utils::id_type::MerchantId, #[serde(with = "common_utils::custom_serde::iso8601")] pub created_at: PrimitiveDateTime, diff --git a/crates/diesel_models/src/payout_attempt.rs b/crates/diesel_models/src/payout_attempt.rs index 0e12a9ed801..a908ef7bdf5 100644 --- a/crates/diesel_models/src/payout_attempt.rs +++ b/crates/diesel_models/src/payout_attempt.rs @@ -14,7 +14,7 @@ use crate::{enums as storage_enums, schema::payout_attempt}; #[diesel(table_name = payout_attempt, primary_key(payout_attempt_id), check_for_backend(diesel::pg::Pg))] pub struct PayoutAttempt { pub payout_attempt_id: String, - pub payout_id: String, + pub payout_id: common_utils::id_type::PayoutId, pub customer_id: Option<common_utils::id_type::CustomerId>, pub merchant_id: common_utils::id_type::MerchantId, pub address_id: Option<String>, @@ -37,6 +37,7 @@ pub struct PayoutAttempt { pub unified_code: Option<UnifiedCode>, pub unified_message: Option<UnifiedMessage>, pub additional_payout_method_data: Option<payout_method_utils::AdditionalPayoutMethodData>, + pub merchant_order_reference_id: Option<String>, } #[derive( @@ -53,7 +54,7 @@ pub struct PayoutAttempt { #[diesel(table_name = payout_attempt)] pub struct PayoutAttemptNew { pub payout_attempt_id: String, - pub payout_id: String, + pub payout_id: common_utils::id_type::PayoutId, pub customer_id: Option<common_utils::id_type::CustomerId>, pub merchant_id: common_utils::id_type::MerchantId, pub address_id: Option<String>, @@ -76,6 +77,7 @@ pub struct PayoutAttemptNew { pub unified_code: Option<UnifiedCode>, pub unified_message: Option<UnifiedMessage>, pub additional_payout_method_data: Option<payout_method_utils::AdditionalPayoutMethodData>, + pub merchant_order_reference_id: Option<String>, } #[derive(Debug, Clone, Serialize, Deserialize)] @@ -128,6 +130,7 @@ pub struct PayoutAttemptUpdateInternal { pub unified_code: Option<UnifiedCode>, pub unified_message: Option<UnifiedMessage>, pub additional_payout_method_data: Option<payout_method_utils::AdditionalPayoutMethodData>, + pub merchant_order_reference_id: Option<String>, } impl Default for PayoutAttemptUpdateInternal { @@ -150,6 +153,7 @@ impl Default for PayoutAttemptUpdateInternal { unified_code: None, unified_message: None, additional_payout_method_data: None, + merchant_order_reference_id: None, } } } @@ -231,6 +235,7 @@ impl PayoutAttemptUpdate { unified_code, unified_message, additional_payout_method_data, + merchant_order_reference_id, } = self.into(); PayoutAttempt { payout_token: payout_token.or(source.payout_token), @@ -251,6 +256,8 @@ impl PayoutAttemptUpdate { unified_message: unified_message.or(source.unified_message), additional_payout_method_data: additional_payout_method_data .or(source.additional_payout_method_data), + merchant_order_reference_id: merchant_order_reference_id + .or(source.merchant_order_reference_id), ..source } } diff --git a/crates/diesel_models/src/payouts.rs b/crates/diesel_models/src/payouts.rs index 8acdc4a0a5a..881875494ab 100644 --- a/crates/diesel_models/src/payouts.rs +++ b/crates/diesel_models/src/payouts.rs @@ -11,7 +11,7 @@ use crate::{enums as storage_enums, schema::payouts}; )] #[diesel(table_name = payouts, primary_key(payout_id), check_for_backend(diesel::pg::Pg))] pub struct Payouts { - pub payout_id: String, + pub payout_id: common_utils::id_type::PayoutId, pub merchant_id: common_utils::id_type::MerchantId, pub customer_id: Option<common_utils::id_type::CustomerId>, pub address_id: Option<String>, @@ -52,7 +52,7 @@ pub struct Payouts { )] #[diesel(table_name = payouts)] pub struct PayoutsNew { - pub payout_id: String, + pub payout_id: common_utils::id_type::PayoutId, pub merchant_id: common_utils::id_type::MerchantId, pub customer_id: Option<common_utils::id_type::CustomerId>, pub address_id: Option<String>, diff --git a/crates/diesel_models/src/query/generic_link.rs b/crates/diesel_models/src/query/generic_link.rs index 75f1fc8ded8..96966e14547 100644 --- a/crates/diesel_models/src/query/generic_link.rs +++ b/crates/diesel_models/src/query/generic_link.rs @@ -224,7 +224,11 @@ impl TryFrom<GenericLink> for PayoutLink { Ok(Self { link_id: db_val.link_id, - primary_reference: db_val.primary_reference, + primary_reference: common_utils::id_type::PayoutId::try_from(std::borrow::Cow::Owned( + db_val.primary_reference, + )) + .change_context(errors::ParsingError::UnknownError) + .attach_printable("Failed to parse PayoutId from primary_reference string")?, merchant_id: db_val.merchant_id, created_at: db_val.created_at, last_modified_at: db_val.last_modified_at, diff --git a/crates/diesel_models/src/query/payout_attempt.rs b/crates/diesel_models/src/query/payout_attempt.rs index 939336a223a..300b6fdb647 100644 --- a/crates/diesel_models/src/query/payout_attempt.rs +++ b/crates/diesel_models/src/query/payout_attempt.rs @@ -56,7 +56,7 @@ impl PayoutAttempt { pub async fn find_by_merchant_id_payout_id( conn: &PgPooledConn, merchant_id: &common_utils::id_type::MerchantId, - payout_id: &str, + payout_id: &common_utils::id_type::PayoutId, ) -> StorageResult<Self> { generics::generic_find_one::<<Self as HasTable>::Table, _, _>( conn, @@ -95,10 +95,24 @@ impl PayoutAttempt { .await } + pub async fn find_by_merchant_id_merchant_order_reference_id( + conn: &PgPooledConn, + merchant_id_input: &common_utils::id_type::MerchantId, + merchant_order_reference_id_input: &str, + ) -> StorageResult<Self> { + generics::generic_find_one::<<Self as HasTable>::Table, _, _>( + conn, + dsl::merchant_id.eq(merchant_id_input.to_owned()).and( + dsl::merchant_order_reference_id.eq(merchant_order_reference_id_input.to_owned()), + ), + ) + .await + } + pub async fn update_by_merchant_id_payout_id( conn: &PgPooledConn, merchant_id: &common_utils::id_type::MerchantId, - payout_id: &str, + payout_id: &common_utils::id_type::PayoutId, payout: PayoutAttemptUpdate, ) -> StorageResult<Self> { generics::generic_update_with_results::<<Self as HasTable>::Table, _, _, _>( @@ -152,7 +166,7 @@ impl PayoutAttempt { .map(|payout| { format!( "{}_{}", - payout.payout_id.clone(), + payout.payout_id.get_string_repr(), payout.attempt_count.clone() ) }) @@ -160,8 +174,8 @@ impl PayoutAttempt { let active_payout_ids = payouts .iter() - .map(|payout| payout.payout_id.clone()) - .collect::<Vec<String>>(); + .map(|payout| payout.payout_id.to_owned()) + .collect::<Vec<common_utils::id_type::PayoutId>>(); let filter = <Self as HasTable>::table() .filter(dsl::merchant_id.eq(merchant_id.to_owned())) diff --git a/crates/diesel_models/src/query/payouts.rs b/crates/diesel_models/src/query/payouts.rs index 25c7bfc4f7e..e7d06d05ffe 100644 --- a/crates/diesel_models/src/query/payouts.rs +++ b/crates/diesel_models/src/query/payouts.rs @@ -47,7 +47,7 @@ impl Payouts { pub async fn find_by_merchant_id_payout_id( conn: &PgPooledConn, merchant_id: &common_utils::id_type::MerchantId, - payout_id: &str, + payout_id: &common_utils::id_type::PayoutId, ) -> StorageResult<Self> { generics::generic_find_one::<<Self as HasTable>::Table, _, _>( conn, @@ -61,7 +61,7 @@ impl Payouts { pub async fn update_by_merchant_id_payout_id( conn: &PgPooledConn, merchant_id: &common_utils::id_type::MerchantId, - payout_id: &str, + payout_id: &common_utils::id_type::PayoutId, payout: PayoutsUpdate, ) -> StorageResult<Self> { generics::generic_update_with_results::<<Self as HasTable>::Table, _, _, _>( @@ -82,7 +82,7 @@ impl Payouts { pub async fn find_optional_by_merchant_id_payout_id( conn: &PgPooledConn, merchant_id: &common_utils::id_type::MerchantId, - payout_id: &str, + payout_id: &common_utils::id_type::PayoutId, ) -> StorageResult<Option<Self>> { generics::generic_find_one_optional::<<Self as HasTable>::Table, _, _>( conn, @@ -96,7 +96,7 @@ impl Payouts { pub async fn get_total_count_of_payouts( conn: &PgPooledConn, merchant_id: &common_utils::id_type::MerchantId, - active_payout_ids: &[String], + active_payout_ids: &[common_utils::id_type::PayoutId], connector: Option<Vec<String>>, currency: Option<Vec<enums::Currency>>, status: Option<Vec<enums::PayoutStatus>>, @@ -106,7 +106,7 @@ impl Payouts { .inner_join(payout_attempt::table.on(payout_attempt::dsl::payout_id.eq(dsl::payout_id))) .count() .filter(dsl::merchant_id.eq(merchant_id.to_owned())) - .filter(dsl::payout_id.eq_any(active_payout_ids.to_owned())) + .filter(dsl::payout_id.eq_any(active_payout_ids.to_vec())) .into_boxed(); if let Some(connector) = connector { diff --git a/crates/diesel_models/src/schema.rs b/crates/diesel_models/src/schema.rs index e303dfc553f..1629780458c 100644 --- a/crates/diesel_models/src/schema.rs +++ b/crates/diesel_models/src/schema.rs @@ -1151,7 +1151,7 @@ diesel::table! { use diesel::sql_types::*; use crate::enums::diesel_exports::*; - payout_attempt (payout_attempt_id) { + payout_attempt (merchant_id, payout_attempt_id) { #[max_length = 64] payout_attempt_id -> Varchar, #[max_length = 64] @@ -1188,6 +1188,8 @@ diesel::table! { #[max_length = 1024] unified_message -> Nullable<Varchar>, additional_payout_method_data -> Nullable<Jsonb>, + #[max_length = 255] + merchant_order_reference_id -> Nullable<Varchar>, } } @@ -1195,7 +1197,7 @@ diesel::table! { use diesel::sql_types::*; use crate::enums::diesel_exports::*; - payouts (payout_id) { + payouts (merchant_id, payout_id) { #[max_length = 64] payout_id -> Varchar, #[max_length = 64] diff --git a/crates/diesel_models/src/schema_v2.rs b/crates/diesel_models/src/schema_v2.rs index 9ba5cdfaff6..c931cec977a 100644 --- a/crates/diesel_models/src/schema_v2.rs +++ b/crates/diesel_models/src/schema_v2.rs @@ -1090,7 +1090,7 @@ diesel::table! { use diesel::sql_types::*; use crate::enums::diesel_exports::*; - payout_attempt (payout_attempt_id) { + payout_attempt (merchant_id, payout_attempt_id) { #[max_length = 64] payout_attempt_id -> Varchar, #[max_length = 64] @@ -1127,6 +1127,8 @@ diesel::table! { #[max_length = 1024] unified_message -> Nullable<Varchar>, additional_payout_method_data -> Nullable<Jsonb>, + #[max_length = 255] + merchant_order_reference_id -> Nullable<Varchar>, } } @@ -1134,7 +1136,7 @@ diesel::table! { use diesel::sql_types::*; use crate::enums::diesel_exports::*; - payouts (payout_id) { + payouts (merchant_id, payout_id) { #[max_length = 64] payout_id -> Varchar, #[max_length = 64] diff --git a/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs b/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs index 8eec0abb9fc..8f4d667711b 100644 --- a/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/adyen/transformers.rs @@ -5351,7 +5351,7 @@ impl<F> TryFrom<&AdyenRouterData<&PayoutsRouterData<F>>> for AdyenPayoutCreateRe }, merchant_account, payment_data: PayoutPaymentMethodData::PayoutWalletData(payout_wallet), - reference: item.router_data.request.payout_id.to_owned(), + reference: item.router_data.connector_request_reference_id.clone(), shopper_reference: item.router_data.merchant_id.get_string_repr().to_owned(), shopper_email: customer_email, shopper_name: ShopperName { diff --git a/crates/hyperswitch_connectors/src/connectors/adyenplatform/transformers/payouts.rs b/crates/hyperswitch_connectors/src/connectors/adyenplatform/transformers/payouts.rs index 7262ec9f3ff..82c9afadeed 100644 --- a/crates/hyperswitch_connectors/src/connectors/adyenplatform/transformers/payouts.rs +++ b/crates/hyperswitch_connectors/src/connectors/adyenplatform/transformers/payouts.rs @@ -361,7 +361,7 @@ impl<F> TryFrom<&AdyenPlatformRouterData<&types::PayoutsRouterData<F>>> for Adye counterparty, priority, reference: item.router_data.connector_request_reference_id.clone(), - reference_for_beneficiary: request.payout_id.clone(), + reference_for_beneficiary: item.router_data.connector_request_reference_id.clone(), description: item.router_data.description.clone(), }) } diff --git a/crates/hyperswitch_connectors/src/connectors/cybersource/transformers.rs b/crates/hyperswitch_connectors/src/connectors/cybersource/transformers.rs index 6b4101a15d2..09b468c3caf 100644 --- a/crates/hyperswitch_connectors/src/connectors/cybersource/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/cybersource/transformers.rs @@ -3958,7 +3958,7 @@ impl TryFrom<&CybersourceRouterData<&PayoutsRouterData<PoFulfill>>> match payout_type { enums::PayoutType::Card => { let client_reference_information = ClientReferenceInformation { - code: Some(item.router_data.request.payout_id.clone()), + code: Some(item.router_data.connector_request_reference_id.clone()), }; let order_information = OrderInformation { @@ -3974,7 +3974,7 @@ impl TryFrom<&CybersourceRouterData<&PayoutsRouterData<PoFulfill>>> CybersourceRecipientInfo::try_from((billing_address, phone_address))?; let sender_information = CybersourceSenderInfo { - reference_number: item.router_data.request.payout_id.clone(), + reference_number: item.router_data.connector_request_reference_id.clone(), account: CybersourceAccountInfo { funds_source: CybersourcePayoutFundSourceType::Disbursement, }, diff --git a/crates/hyperswitch_connectors/src/connectors/nomupay/transformers.rs b/crates/hyperswitch_connectors/src/connectors/nomupay/transformers.rs index 9a1a50e8642..3eab923ff16 100644 --- a/crates/hyperswitch_connectors/src/connectors/nomupay/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/nomupay/transformers.rs @@ -385,7 +385,7 @@ impl<F> TryFrom<&PayoutsRouterData<F>> for OnboardSubAccountRequest { match payout_type { Some(common_enums::PayoutType::Bank) => Ok(Self { account_id: nomupay_auth_type.eid, - client_sub_account_id: Secret::new(request.payout_id), + client_sub_account_id: Secret::new(item.connector_request_reference_id.clone()), profile, }), _ => Err(errors::ConnectorError::NotImplemented( @@ -498,7 +498,7 @@ impl<F> TryFrom<(&PayoutsRouterData<F>, FloatMajorUnit)> for NomupayPaymentReque Ok(Self { source_id: nomupay_auth_type.eid, destination_id: Secret::new(destination), - payment_reference: item.request.clone().payout_id, + payment_reference: item.connector_request_reference_id.clone(), amount, currency_code: item.request.destination_currency, purpose: PURPOSE_OF_PAYMENT_IS_OTHER.to_string(), diff --git a/crates/hyperswitch_connectors/src/connectors/paypal/transformers.rs b/crates/hyperswitch_connectors/src/connectors/paypal/transformers.rs index 6b56ccea208..18c7ac02e71 100644 --- a/crates/hyperswitch_connectors/src/connectors/paypal/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/paypal/transformers.rs @@ -2309,7 +2309,7 @@ impl TryFrom<&PaypalRouterData<&PayoutsRouterData<PoFulfill>>> for PaypalFulfill let item_data = PaypalPayoutItem::try_from(item)?; Ok(Self { sender_batch_header: PayoutBatchHeader { - sender_batch_id: item.router_data.request.payout_id.to_owned(), + sender_batch_id: item.router_data.connector_request_reference_id.to_owned(), }, items: vec![item_data], }) diff --git a/crates/hyperswitch_connectors/src/connectors/stripe/transformers/connect.rs b/crates/hyperswitch_connectors/src/connectors/stripe/transformers/connect.rs index bb8d4509dac..321aad76551 100644 --- a/crates/hyperswitch_connectors/src/connectors/stripe/transformers/connect.rs +++ b/crates/hyperswitch_connectors/src/connectors/stripe/transformers/connect.rs @@ -216,7 +216,7 @@ impl<F> TryFrom<&PayoutsRouterData<F>> for StripeConnectPayoutCreateRequest { amount: request.amount, currency: request.destination_currency, destination: connector_customer_id, - transfer_group: request.payout_id, + transfer_group: item.connector_request_reference_id.clone(), }) } } diff --git a/crates/hyperswitch_connectors/src/connectors/wise/transformers.rs b/crates/hyperswitch_connectors/src/connectors/wise/transformers.rs index 1a9ff7bf89f..f844e15a488 100644 --- a/crates/hyperswitch_connectors/src/connectors/wise/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/wise/transformers.rs @@ -510,7 +510,7 @@ impl<F> TryFrom<&PayoutsRouterData<F>> for WisePayoutCreateRequest { Ok(Self { target_account, quote_uuid, - customer_transaction_id: request.payout_id, + customer_transaction_id: request.payout_id.get_string_repr().to_string(), details: wise_transfer_details, }) } diff --git a/crates/hyperswitch_domain_models/src/errors/api_error_response.rs b/crates/hyperswitch_domain_models/src/errors/api_error_response.rs index 21accfa22c5..2924093da3a 100644 --- a/crates/hyperswitch_domain_models/src/errors/api_error_response.rs +++ b/crates/hyperswitch_domain_models/src/errors/api_error_response.rs @@ -79,8 +79,10 @@ pub enum ApiErrorResponse { DuplicatePayment { payment_id: common_utils::id_type::PaymentId, }, - #[error(error_type = ErrorType::DuplicateRequest, code = "HE_01", message = "The payout with the specified payout_id '{payout_id}' already exists in our records")] - DuplicatePayout { payout_id: String }, + #[error(error_type = ErrorType::DuplicateRequest, code = "HE_01", message = "The payout with the specified payout_id '{payout_id:?}' already exists in our records")] + DuplicatePayout { + payout_id: common_utils::id_type::PayoutId, + }, #[error(error_type = ErrorType::DuplicateRequest, code = "HE_01", message = "The config with the specified key already exists in our records")] DuplicateConfig, #[error(error_type = ErrorType::ObjectNotFound, code = "HE_02", message = "Refund does not exist in our records")] @@ -403,7 +405,7 @@ impl ErrorSwitch<api_models::errors::types::ApiErrorResponse> for ApiErrorRespon AER::BadRequest(ApiError::new("HE", 1, "The payment with the specified payment_id already exists in our records", Some(Extra {reason: Some(format!("{payment_id:?} already exists")), ..Default::default()}))) } Self::DuplicatePayout { payout_id } => { - AER::BadRequest(ApiError::new("HE", 1, format!("The payout with the specified payout_id '{payout_id}' already exists in our records"), None)) + AER::BadRequest(ApiError::new("HE", 1, format!("The payout with the specified payout_id '{payout_id:?}' already exists in our records"), None)) } Self::DuplicateConfig => { AER::BadRequest(ApiError::new("HE", 1, "The config with the specified key already exists in our records", None)) diff --git a/crates/hyperswitch_domain_models/src/payouts.rs b/crates/hyperswitch_domain_models/src/payouts.rs index 8c6d751ebec..9a40dc119c0 100644 --- a/crates/hyperswitch_domain_models/src/payouts.rs +++ b/crates/hyperswitch_domain_models/src/payouts.rs @@ -7,7 +7,7 @@ use common_utils::{consts, id_type}; use time::PrimitiveDateTime; pub enum PayoutFetchConstraints { - Single { payout_id: String }, + Single { payout_id: id_type::PayoutId }, List(Box<PayoutListParams>), } @@ -21,10 +21,11 @@ pub struct PayoutListParams { pub payout_method: Option<Vec<common_enums::PayoutType>>, pub profile_id: Option<id_type::ProfileId>, pub customer_id: Option<id_type::CustomerId>, - pub starting_after_id: Option<String>, - pub ending_before_id: Option<String>, + pub starting_after_id: Option<id_type::PayoutId>, + pub ending_before_id: Option<id_type::PayoutId>, pub entity_type: Option<common_enums::PayoutEntityType>, pub limit: Option<u32>, + pub merchant_order_reference_id: Option<String>, } impl From<api_models::payouts::PayoutListConstraints> for PayoutFetchConstraints { @@ -44,6 +45,7 @@ impl From<api_models::payouts::PayoutListConstraints> for PayoutFetchConstraints starting_after_id: value.starting_after, ending_before_id: value.ending_before, entity_type: None, + merchant_order_reference_id: None, limit: Some(std::cmp::min( value.limit, consts::PAYOUTS_LIST_MAX_LIMIT_GET, @@ -67,6 +69,7 @@ impl From<common_utils::types::TimeRange> for PayoutFetchConstraints { starting_after_id: None, ending_before_id: None, entity_type: None, + merchant_order_reference_id: None, limit: None, })) } @@ -90,6 +93,7 @@ impl From<api_models::payouts::PayoutListFilterConstraints> for PayoutFetchConst starting_after_id: None, ending_before_id: None, entity_type: value.entity_type, + merchant_order_reference_id: value.merchant_order_reference_id, limit: Some(std::cmp::min( value.limit, consts::PAYOUTS_LIST_MAX_LIMIT_POST, diff --git a/crates/hyperswitch_domain_models/src/payouts/payout_attempt.rs b/crates/hyperswitch_domain_models/src/payouts/payout_attempt.rs index dcb61bddc97..b6293faa841 100644 --- a/crates/hyperswitch_domain_models/src/payouts/payout_attempt.rs +++ b/crates/hyperswitch_domain_models/src/payouts/payout_attempt.rs @@ -42,6 +42,13 @@ pub trait PayoutAttemptInterface { _storage_scheme: MerchantStorageScheme, ) -> error_stack::Result<PayoutAttempt, Self::Error>; + async fn find_payout_attempt_by_merchant_id_merchant_order_reference_id( + &self, + _merchant_id: &id_type::MerchantId, + _merchant_order_reference_id: &str, + _storage_scheme: MerchantStorageScheme, + ) -> error_stack::Result<PayoutAttempt, Self::Error>; + async fn get_filters_for_payouts( &self, _payout: &[Payouts], @@ -61,7 +68,7 @@ pub struct PayoutListFilters { #[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)] pub struct PayoutAttempt { pub payout_attempt_id: String, - pub payout_id: String, + pub payout_id: id_type::PayoutId, pub customer_id: Option<id_type::CustomerId>, pub merchant_id: id_type::MerchantId, pub address_id: Option<String>, @@ -84,12 +91,13 @@ pub struct PayoutAttempt { pub unified_code: Option<UnifiedCode>, pub unified_message: Option<UnifiedMessage>, pub additional_payout_method_data: Option<payout_method_utils::AdditionalPayoutMethodData>, + pub merchant_order_reference_id: Option<String>, } #[derive(Clone, Debug, PartialEq)] pub struct PayoutAttemptNew { pub payout_attempt_id: String, - pub payout_id: String, + pub payout_id: id_type::PayoutId, pub customer_id: Option<id_type::CustomerId>, pub merchant_id: id_type::MerchantId, pub address_id: Option<String>, @@ -110,6 +118,7 @@ pub struct PayoutAttemptNew { pub unified_code: Option<UnifiedCode>, pub unified_message: Option<UnifiedMessage>, pub additional_payout_method_data: Option<payout_method_utils::AdditionalPayoutMethodData>, + pub merchant_order_reference_id: Option<String>, } #[derive(Debug, Clone)] diff --git a/crates/hyperswitch_domain_models/src/payouts/payouts.rs b/crates/hyperswitch_domain_models/src/payouts/payouts.rs index 7c34b3c26df..1d41a5f9a32 100644 --- a/crates/hyperswitch_domain_models/src/payouts/payouts.rs +++ b/crates/hyperswitch_domain_models/src/payouts/payouts.rs @@ -20,7 +20,7 @@ pub trait PayoutsInterface { async fn find_payout_by_merchant_id_payout_id( &self, _merchant_id: &id_type::MerchantId, - _payout_id: &str, + _payout_id: &id_type::PayoutId, _storage_scheme: MerchantStorageScheme, ) -> error_stack::Result<Payouts, Self::Error>; @@ -35,7 +35,7 @@ pub trait PayoutsInterface { async fn find_optional_payout_by_merchant_id_payout_id( &self, _merchant_id: &id_type::MerchantId, - _payout_id: &str, + _payout_id: &id_type::PayoutId, _storage_scheme: MerchantStorageScheme, ) -> error_stack::Result<Option<Payouts>, Self::Error>; @@ -76,7 +76,7 @@ pub trait PayoutsInterface { async fn get_total_count_of_filtered_payouts( &self, _merchant_id: &id_type::MerchantId, - _active_payout_ids: &[String], + _active_payout_ids: &[id_type::PayoutId], _connector: Option<Vec<api_models::enums::PayoutConnectors>>, _currency: Option<Vec<storage_enums::Currency>>, _status: Option<Vec<storage_enums::PayoutStatus>>, @@ -88,12 +88,12 @@ pub trait PayoutsInterface { &self, _merchant_id: &id_type::MerchantId, _constraints: &PayoutFetchConstraints, - ) -> error_stack::Result<Vec<String>, Self::Error>; + ) -> error_stack::Result<Vec<id_type::PayoutId>, Self::Error>; } #[derive(Clone, Debug, Eq, PartialEq)] pub struct Payouts { - pub payout_id: String, + pub payout_id: id_type::PayoutId, pub merchant_id: id_type::MerchantId, pub customer_id: Option<id_type::CustomerId>, pub address_id: Option<String>, @@ -121,7 +121,7 @@ pub struct Payouts { #[derive(Clone, Debug, Eq, PartialEq)] pub struct PayoutsNew { - pub payout_id: String, + pub payout_id: id_type::PayoutId, pub merchant_id: id_type::MerchantId, pub customer_id: Option<id_type::CustomerId>, pub address_id: Option<String>, diff --git a/crates/hyperswitch_domain_models/src/router_request_types.rs b/crates/hyperswitch_domain_models/src/router_request_types.rs index e811b872c8c..c7987122ead 100644 --- a/crates/hyperswitch_domain_models/src/router_request_types.rs +++ b/crates/hyperswitch_domain_models/src/router_request_types.rs @@ -890,7 +890,7 @@ pub struct UploadFileRequestData { #[cfg(feature = "payouts")] #[derive(Debug, Clone)] pub struct PayoutsData { - pub payout_id: String, + pub payout_id: id_type::PayoutId, pub amount: i64, pub connector_payout_id: Option<String>, pub destination_currency: storage_enums::Currency, diff --git a/crates/router/src/compatibility/stripe/errors.rs b/crates/router/src/compatibility/stripe/errors.rs index 58f707b2db6..83f7fe69053 100644 --- a/crates/router/src/compatibility/stripe/errors.rs +++ b/crates/router/src/compatibility/stripe/errors.rs @@ -1,4 +1,4 @@ -use common_utils::errors::ErrorSwitch; +use common_utils::{errors::ErrorSwitch, id_type}; use hyperswitch_domain_models::errors::api_error_response as errors; use crate::core::errors::CustomersErrorResponse; @@ -133,7 +133,7 @@ pub enum StripeErrorCode { EventNotFound, #[error(error_type = StripeErrorType::InvalidRequestError, code = "token_already_used", message = "Duplicate payout request")] - DuplicatePayout { payout_id: String }, + DuplicatePayout { payout_id: id_type::PayoutId }, #[error(error_type = StripeErrorType::InvalidRequestError, code = "parameter_missing", message = "Return url is not available")] ReturnUrlUnavailable, @@ -209,9 +209,7 @@ pub enum StripeErrorCode { PaymentIntentMandateInvalid { message: String }, #[error(error_type = StripeErrorType::InvalidRequestError, code = "", message = "The payment with the specified payment_id already exists in our records.")] - DuplicatePayment { - payment_id: common_utils::id_type::PaymentId, - }, + DuplicatePayment { payment_id: id_type::PaymentId }, #[error(error_type = StripeErrorType::ConnectorError, code = "", message = "{code}: {message}")] ExternalConnectorError { diff --git a/crates/router/src/compatibility/stripe/webhooks.rs b/crates/router/src/compatibility/stripe/webhooks.rs index f5dde401b35..3bd0f83b7db 100644 --- a/crates/router/src/compatibility/stripe/webhooks.rs +++ b/crates/router/src/compatibility/stripe/webhooks.rs @@ -4,9 +4,12 @@ use api_models::{ enums::{Currency, DisputeStatus, MandateStatus}, webhooks::{self as api}, }; -#[cfg(feature = "payouts")] -use common_utils::pii::{self, Email}; use common_utils::{crypto::SignMessage, date_time, ext_traits::Encode}; +#[cfg(feature = "payouts")] +use common_utils::{ + id_type, + pii::{self, Email}, +}; use error_stack::ResultExt; use router_env::logger; use serde::Serialize; @@ -94,7 +97,7 @@ pub struct StripeDisputeResponse { pub id: String, pub amount: String, pub currency: Currency, - pub payment_intent: common_utils::id_type::PaymentId, + pub payment_intent: id_type::PaymentId, pub reason: Option<String>, pub status: StripeDisputeStatus, } @@ -110,7 +113,7 @@ pub struct StripeMandateResponse { #[cfg(feature = "payouts")] #[derive(Clone, Serialize, Debug)] pub struct StripePayoutResponse { - pub id: String, + pub id: id_type::PayoutId, pub amount: i64, pub currency: String, pub payout_type: Option<common_enums::PayoutType>, diff --git a/crates/router/src/core/payments/routing.rs b/crates/router/src/core/payments/routing.rs index 4cc667bdc8a..7126ed9617e 100644 --- a/crates/router/src/core/payments/routing.rs +++ b/crates/router/src/core/payments/routing.rs @@ -483,9 +483,11 @@ pub async fn perform_static_routing_v1( .get_string_repr() .to_string(), #[cfg(feature = "payouts")] - routing::TransactionData::Payout(payout_data) => { - payout_data.payout_attempt.payout_id.clone() - } + routing::TransactionData::Payout(payout_data) => payout_data + .payout_attempt + .payout_id + .get_string_repr() + .to_string(), }; let routing_events_wrapper = utils::RoutingEventsWrapper::new( diff --git a/crates/router/src/core/payout_link.rs b/crates/router/src/core/payout_link.rs index 8c234889630..1d224ffbd79 100644 --- a/crates/router/src/core/payout_link.rs +++ b/crates/router/src/core/payout_link.rs @@ -22,6 +22,7 @@ use crate::{ routes::{app::StorageInterface, SessionState}, services, types::{api, domain, transformers::ForeignFrom}, + utils::get_payout_attempt_id, }; #[cfg(feature = "v2")] @@ -56,7 +57,7 @@ pub async fn initiate_payout_link( let payout_attempt = db .find_payout_attempt_by_merchant_id_payout_attempt_id( merchant_id, - &format!("{}_{}", payout.payout_id, payout.attempt_count), + &get_payout_attempt_id(payout.payout_id.get_string_repr(), payout.attempt_count), merchant_context.get_merchant_account().storage_scheme, ) .await @@ -146,13 +147,11 @@ pub async fn initiate_payout_link( .await .change_context(errors::ApiErrorResponse::InvalidRequestData { message: format!( - "Customer [{}] not found for link_id - {}", - payout_link.primary_reference, payout_link.link_id + "Customer [{:?}] not found for link_id - {}", + customer_id, payout_link.link_id ), }) - .attach_printable_lazy(|| { - format!("customer [{}] not found", payout_link.primary_reference) - })?; + .attach_printable_lazy(|| format!("customer [{:?}] not found", customer_id))?; let address = payout .address_id .as_ref() @@ -169,7 +168,7 @@ pub async fn initiate_payout_link( .change_context(errors::ApiErrorResponse::InternalServerError) .attach_printable_lazy(|| { format!( - "Failed while fetching address [id - {:?}] for payout [id - {}]", + "Failed while fetching address [id - {:?}] for payout [id - {:?}]", payout.address_id, payout.payout_id ) })?; @@ -227,7 +226,7 @@ pub async fn initiate_payout_link( ), client_secret: link_data.client_secret.clone(), payout_link_id: payout_link.link_id, - payout_id: payout_link.primary_reference, + payout_id: payout_link.primary_reference.clone(), customer_id: customer.customer_id, session_expiry: payout_link.expiry, return_url: payout_link @@ -284,7 +283,7 @@ pub async fn initiate_payout_link( .await?; let js_data = payouts::PayoutLinkStatusDetails { payout_link_id: payout_link.link_id, - payout_id: payout_link.primary_reference, + payout_id: payout_link.primary_reference.clone(), customer_id: link_data.customer_id, session_expiry: payout_link.expiry, return_url: payout_link diff --git a/crates/router/src/core/payouts.rs b/crates/router/src/core/payouts.rs index 495bea84eac..3cc996bd9a6 100644 --- a/crates/router/src/core/payouts.rs +++ b/crates/router/src/core/payouts.rs @@ -17,7 +17,7 @@ use common_enums::PayoutRetryType; use common_utils::{ consts, ext_traits::{AsyncExt, ValueExt}, - id_type::CustomerId, + id_type::{self, GenerateId}, link_utils::{GenericLinkStatus, GenericLinkUiConfig, PayoutLinkData, PayoutLinkStatus}, types::{MinorUnit, UnifiedCode, UnifiedMessage}, }; @@ -73,7 +73,7 @@ pub struct PayoutData { pub payouts: storage::Payouts, pub payout_attempt: storage::PayoutAttempt, pub payout_method_data: Option<payouts::PayoutMethodData>, - pub profile_id: common_utils::id_type::ProfileId, + pub profile_id: id_type::ProfileId, pub should_terminate: bool, pub payout_link: Option<PayoutLink>, pub current_locale: String, @@ -451,7 +451,7 @@ pub async fn payouts_update_core( if helpers::is_payout_terminal_state(status) || helpers::is_payout_initiated(status) { return Err(report!(errors::ApiErrorResponse::InvalidRequestData { message: format!( - "Payout {} cannot be updated for status {}", + "Payout {:?} cannot be updated for status {}", payout_id, status ), })); @@ -506,7 +506,7 @@ pub async fn payouts_update_core( pub async fn payouts_retrieve_core( state: SessionState, merchant_context: domain::MerchantContext, - profile_id: Option<common_utils::id_type::ProfileId>, + profile_id: Option<id_type::ProfileId>, req: payouts::PayoutRetrieveRequest, ) -> RouterResponse<payouts::PayoutCreateResponse> { let mut payout_data = Box::pin(make_payout_data( @@ -568,7 +568,7 @@ pub async fn payouts_cancel_core( if helpers::is_payout_terminal_state(status) { return Err(report!(errors::ApiErrorResponse::InvalidRequestData { message: format!( - "Payout {} cannot be cancelled for status {}", + "Payout {:?} cannot be cancelled for status {}", payout_attempt.payout_id, status ), })); @@ -663,7 +663,7 @@ pub async fn payouts_fulfill_core( { return Err(report!(errors::ApiErrorResponse::InvalidRequestData { message: format!( - "Payout {} cannot be fulfilled for status {}", + "Payout {:?} cannot be fulfilled for status {}", payout_attempt.payout_id, status ), })); @@ -733,7 +733,7 @@ pub async fn payouts_fulfill_core( pub async fn payouts_list_core( _state: SessionState, _merchant_context: domain::MerchantContext, - _profile_id_list: Option<Vec<common_utils::id_type::ProfileId>>, + _profile_id_list: Option<Vec<id_type::ProfileId>>, _constraints: payouts::PayoutListConstraints, ) -> RouterResponse<payouts::PayoutListResponse> { todo!() @@ -743,7 +743,7 @@ pub async fn payouts_list_core( pub async fn payouts_list_core( state: SessionState, merchant_context: domain::MerchantContext, - profile_id_list: Option<Vec<common_utils::id_type::ProfileId>>, + profile_id_list: Option<Vec<id_type::ProfileId>>, constraints: payouts::PayoutListConstraints, ) -> RouterResponse<payouts::PayoutListResponse> { validator::validate_payout_list_request(&constraints)?; @@ -765,7 +765,10 @@ pub async fn payouts_list_core( match db .find_payout_attempt_by_merchant_id_payout_attempt_id( merchant_id, - &utils::get_payout_attempt_id(payout.payout_id.clone(), payout.attempt_count), + &utils::get_payout_attempt_id( + payout.payout_id.get_string_repr(), + payout.attempt_count, + ), storage_enums::MerchantStorageScheme::PostgresOnly, ) .await @@ -795,7 +798,7 @@ pub async fn payouts_list_core( }; let payout_id_as_payment_id_type = - common_utils::id_type::PaymentId::wrap(payout.payout_id.clone()) + id_type::PaymentId::wrap(payout.payout_id.get_string_repr().to_string()) .change_context(errors::ApiErrorResponse::InvalidRequestData { message: "payout_id contains invalid data".to_string(), }) @@ -862,7 +865,7 @@ pub async fn payouts_list_core( pub async fn payouts_filtered_list_core( state: SessionState, merchant_context: domain::MerchantContext, - profile_id_list: Option<Vec<common_utils::id_type::ProfileId>>, + profile_id_list: Option<Vec<id_type::ProfileId>>, filters: payouts::PayoutListFilterConstraints, ) -> RouterResponse<payouts::PayoutListResponse> { let limit = &filters.limit; @@ -976,7 +979,7 @@ pub async fn payouts_filtered_list_core( pub async fn payouts_list_available_filters_core( state: SessionState, merchant_context: domain::MerchantContext, - profile_id_list: Option<Vec<common_utils::id_type::ProfileId>>, + profile_id_list: Option<Vec<id_type::ProfileId>>, time_range: common_utils::types::TimeRange, ) -> RouterResponse<api::PayoutListFilters> { let db = state.store.as_ref(); @@ -2540,6 +2543,7 @@ pub async fn response_handler( let response = api::PayoutCreateResponse { payout_id: payouts.payout_id.to_owned(), merchant_id: merchant_context.get_merchant_account().get_id().to_owned(), + merchant_order_reference_id: payout_attempt.merchant_order_reference_id.clone(), amount: payouts.amount, currency: payouts.destination_currency.to_owned(), connector: payout_attempt.connector, @@ -2615,8 +2619,8 @@ pub async fn payout_create_db_entries( state: &SessionState, merchant_context: &domain::MerchantContext, req: &payouts::PayoutCreateRequest, - payout_id: &String, - profile_id: &common_utils::id_type::ProfileId, + payout_id: &id_type::PayoutId, + profile_id: &id_type::ProfileId, stored_payout_method_data: Option<&payouts::PayoutMethodData>, locale: &str, customer: Option<&domain::Customer>, @@ -2655,12 +2659,13 @@ pub async fn payout_create_db_entries( // We have to do this because the function that is being used to create / get address is from payments // which expects a payment_id - let payout_id_as_payment_id_type = - common_utils::id_type::PaymentId::try_from(std::borrow::Cow::Owned(payout_id.to_string())) - .change_context(errors::ApiErrorResponse::InvalidRequestData { - message: "payout_id contains invalid data".to_string(), - }) - .attach_printable("Error converting payout_id to PaymentId type")?; + let payout_id_as_payment_id_type = id_type::PaymentId::try_from(std::borrow::Cow::Owned( + payout_id.get_string_repr().to_string(), + )) + .change_context(errors::ApiErrorResponse::InvalidRequestData { + message: "payout_id contains invalid data".to_string(), + }) + .attach_printable("Error converting payout_id to PaymentId type")?; // Get or create address let billing_address = payment_helpers::create_or_find_address_for_payment_by_request( @@ -2696,7 +2701,7 @@ pub async fn payout_create_db_entries( let client_secret = utils::generate_id( consts::ID_LENGTH, - format!("payout_{payout_id}_secret").as_str(), + format!("payout_{payout_id:?}_secret").as_str(), ); let amount = MinorUnit::from(req.amount.unwrap_or(api::Amount::Zero)); let status = if req.payout_method_data.is_some() @@ -2712,7 +2717,7 @@ pub async fn payout_create_db_entries( }; let payouts_req = storage::PayoutsNew { - payout_id: payout_id.to_string(), + payout_id: payout_id.clone(), merchant_id: merchant_id.to_owned(), customer_id: customer_id.to_owned(), address_id: address_id.to_owned(), @@ -2746,11 +2751,11 @@ pub async fn payout_create_db_entries( ) .await .to_duplicate_response(errors::ApiErrorResponse::DuplicatePayout { - payout_id: payout_id.to_owned(), + payout_id: payout_id.clone(), }) .attach_printable("Error inserting payouts in db")?; // Make payout_attempt entry - let payout_attempt_id = utils::get_payout_attempt_id(payout_id, 1); + let payout_attempt_id = utils::get_payout_attempt_id(payout_id.get_string_repr(), 1); let additional_pm_data_value = req .payout_method_data @@ -2764,9 +2769,10 @@ pub async fn payout_create_db_entries( let payout_attempt_req = storage::PayoutAttemptNew { payout_attempt_id: payout_attempt_id.to_string(), - payout_id: payout_id.to_owned(), + payout_id: payout_id.clone(), additional_payout_method_data: additional_pm_data_value, merchant_id: merchant_id.to_owned(), + merchant_order_reference_id: req.merchant_order_reference_id.clone(), status, business_country: req.business_country.to_owned(), business_label: req.business_label.to_owned(), @@ -2794,7 +2800,7 @@ pub async fn payout_create_db_entries( ) .await .to_duplicate_response(errors::ApiErrorResponse::DuplicatePayout { - payout_id: payout_id.to_owned(), + payout_id: payout_id.clone(), }) .attach_printable("Error inserting payout_attempt in db")?; @@ -2823,7 +2829,7 @@ pub async fn payout_create_db_entries( pub async fn make_payout_data( _state: &SessionState, _merchant_context: &domain::MerchantContext, - _auth_profile_id: Option<common_utils::id_type::ProfileId>, + _auth_profile_id: Option<id_type::ProfileId>, _req: &payouts::PayoutRequest, locale: &str, ) -> RouterResult<PayoutData> { @@ -2834,7 +2840,7 @@ pub async fn make_payout_data( pub async fn make_payout_data( state: &SessionState, merchant_context: &domain::MerchantContext, - auth_profile_id: Option<common_utils::id_type::ProfileId>, + auth_profile_id: Option<id_type::ProfileId>, req: &payouts::PayoutRequest, locale: &str, ) -> RouterResult<PayoutData> { @@ -2842,7 +2848,9 @@ pub async fn make_payout_data( let merchant_id = merchant_context.get_merchant_account().get_id(); let payout_id = match req { payouts::PayoutRequest::PayoutActionRequest(r) => r.payout_id.clone(), - payouts::PayoutRequest::PayoutCreateRequest(r) => r.payout_id.clone().unwrap_or_default(), + payouts::PayoutRequest::PayoutCreateRequest(r) => { + r.payout_id.clone().unwrap_or(id_type::PayoutId::generate()) + } payouts::PayoutRequest::PayoutRetrieveRequest(r) => r.payout_id.clone(), }; @@ -2856,7 +2864,8 @@ pub async fn make_payout_data( .to_not_found_response(errors::ApiErrorResponse::PayoutNotFound)?; core_utils::validate_profile_id_from_auth_layer(auth_profile_id, &payouts)?; - let payout_attempt_id = utils::get_payout_attempt_id(payout_id, payouts.attempt_count); + let payout_attempt_id = + utils::get_payout_attempt_id(payouts.payout_id.get_string_repr(), payouts.attempt_count); let mut payout_attempt = db .find_payout_attempt_by_merchant_id_payout_attempt_id( @@ -2871,9 +2880,9 @@ pub async fn make_payout_data( // We have to do this because the function that is being used to create / get address is from payments // which expects a payment_id - let payout_id_as_payment_id_type = common_utils::id_type::PaymentId::try_from( - std::borrow::Cow::Owned(payouts.payout_id.clone()), - ) + let payout_id_as_payment_id_type = id_type::PaymentId::try_from(std::borrow::Cow::Owned( + payouts.payout_id.get_string_repr().to_string(), + )) .change_context(errors::ApiErrorResponse::InvalidRequestData { message: "payout_id contains invalid data".to_string(), }) @@ -2906,7 +2915,7 @@ pub async fn make_payout_data( .map_err(|err| err.change_context(errors::ApiErrorResponse::InternalServerError)) .attach_printable_lazy(|| { format!( - "Failed while fetching optional customer [id - {:?}] for payout [id - {}]", + "Failed while fetching optional customer [id - {:?}] for payout [id - {:?}]", customer_id, payout_id ) }) @@ -3079,8 +3088,8 @@ pub async fn add_external_account_addition_task( async fn validate_and_get_business_profile( state: &SessionState, merchant_key_store: &domain::MerchantKeyStore, - profile_id: &common_utils::id_type::ProfileId, - merchant_id: &common_utils::id_type::MerchantId, + profile_id: &id_type::ProfileId, + merchant_id: &id_type::MerchantId, ) -> RouterResult<domain::Profile> { let db = &*state.store; let key_manager_state = &state.into(); @@ -3108,10 +3117,10 @@ async fn validate_and_get_business_profile( pub async fn create_payout_link( state: &SessionState, business_profile: &domain::Profile, - customer_id: &CustomerId, - merchant_id: &common_utils::id_type::MerchantId, + customer_id: &id_type::CustomerId, + merchant_id: &id_type::MerchantId, req: &payouts::PayoutCreateRequest, - payout_id: &str, + payout_id: &id_type::PayoutId, locale: &str, ) -> RouterResult<PayoutLink> { let payout_link_config_req = req.payout_link_config.to_owned(); @@ -3175,7 +3184,7 @@ pub async fn create_payout_link( .as_ref() .map_or(default_config.expiry, |expiry| *expiry); let url = format!( - "{base_url}/payout_link/{}/{payout_id}?locale={}", + "{base_url}/payout_link/{}/{payout_id:?}?locale={}", merchant_id.get_string_repr(), locale ); @@ -3214,7 +3223,7 @@ pub async fn create_payout_link( let data = PayoutLinkData { payout_link_id: payout_link_id.clone(), customer_id: customer_id.clone(), - payout_id: payout_id.to_string(), + payout_id: payout_id.clone(), link, client_secret: Secret::new(client_secret), session_expiry, @@ -3232,7 +3241,7 @@ pub async fn create_payout_link( pub async fn create_payout_link_db_entry( state: &SessionState, - merchant_id: &common_utils::id_type::MerchantId, + merchant_id: &id_type::MerchantId, payout_link_data: &PayoutLinkData, return_url: Option<String>, ) -> RouterResult<PayoutLink> { @@ -3244,7 +3253,7 @@ pub async fn create_payout_link_db_entry( let payout_link = GenericLinkNew { link_id: payout_link_data.payout_link_id.to_string(), - primary_reference: payout_link_data.payout_id.to_string(), + primary_reference: payout_link_data.payout_id.get_string_repr().to_string(), merchant_id: merchant_id.to_owned(), link_type: common_enums::GenericLinkType::PayoutLink, link_status: GenericLinkStatus::PayoutLink(PayoutLinkStatus::Initiated), @@ -3267,9 +3276,9 @@ pub async fn create_payout_link_db_entry( pub async fn get_mca_from_profile_id( state: &SessionState, merchant_context: &domain::MerchantContext, - profile_id: &common_utils::id_type::ProfileId, + profile_id: &id_type::ProfileId, connector_name: &str, - merchant_connector_id: Option<&common_utils::id_type::MerchantConnectorAccountId>, + merchant_connector_id: Option<&id_type::MerchantConnectorAccountId>, ) -> RouterResult<payment_helpers::MerchantConnectorAccountType> { let merchant_connector_account = payment_helpers::get_merchant_connector_account( state, diff --git a/crates/router/src/core/payouts/helpers.rs b/crates/router/src/core/payouts/helpers.rs index 1003ee699f2..9e006ed9ce4 100644 --- a/crates/router/src/core/payouts/helpers.rs +++ b/crates/router/src/core/payouts/helpers.rs @@ -1201,7 +1201,8 @@ pub async fn update_payouts_and_payout_attempt( return Err(report!(errors::ApiErrorResponse::InvalidRequestData { message: format!( "Payout {} cannot be updated for status {}", - payout_id, status + payout_id.get_string_repr(), + status ), })); } @@ -1226,12 +1227,13 @@ pub async fn update_payouts_and_payout_attempt( // We have to do this because the function that is being used to create / get address is from payments // which expects a payment_id - let payout_id_as_payment_id_type = - id_type::PaymentId::try_from(std::borrow::Cow::Owned(payout_id.clone())) - .change_context(errors::ApiErrorResponse::InvalidRequestData { - message: "payout_id contains invalid data".to_string(), - }) - .attach_printable("Error converting payout_id to PaymentId type")?; + let payout_id_as_payment_id_type = id_type::PaymentId::try_from(std::borrow::Cow::Owned( + payout_id.get_string_repr().to_string(), + )) + .change_context(errors::ApiErrorResponse::InvalidRequestData { + message: "payout_id contains invalid data for PaymentId conversion".to_string(), + }) + .attach_printable("Error converting payout_id to PaymentId type")?; // Fetch address details from request and create new or else use existing address that was attached let billing_address = payment_helpers::create_or_find_address_for_payment_by_request( diff --git a/crates/router/src/core/payouts/retry.rs b/crates/router/src/core/payouts/retry.rs index 3b5e93eaf11..30100a580d4 100644 --- a/crates/router/src/core/payouts/retry.rs +++ b/crates/router/src/core/payouts/retry.rs @@ -269,12 +269,18 @@ pub async fn modify_trackers( .change_context(errors::ApiErrorResponse::InternalServerError) .attach_printable("Error updating payouts")?; - let payout_attempt_id = - utils::get_payout_attempt_id(payout_id.to_owned(), payout_data.payouts.attempt_count); + let payout_attempt_id = utils::get_payout_attempt_id( + payout_id.get_string_repr(), + payout_data.payouts.attempt_count, + ); let payout_attempt_req = storage::PayoutAttemptNew { payout_attempt_id: payout_attempt_id.to_string(), payout_id: payout_id.to_owned(), + merchant_order_reference_id: payout_data + .payout_attempt + .merchant_order_reference_id + .clone(), customer_id: payout_data.payout_attempt.customer_id.to_owned(), connector: Some(connector.connector_name.to_string()), merchant_id: payout_data.payout_attempt.merchant_id.to_owned(), diff --git a/crates/router/src/core/payouts/transformers.rs b/crates/router/src/core/payouts/transformers.rs index a1c92ec3b29..7040559d9f4 100644 --- a/crates/router/src/core/payouts/transformers.rs +++ b/crates/router/src/core/payouts/transformers.rs @@ -69,6 +69,7 @@ impl payout_id: payout.payout_id, merchant_id: payout.merchant_id, merchant_connector_id: payout_attempt.merchant_connector_id, + merchant_order_reference_id: payout_attempt.merchant_order_reference_id.clone(), amount: payout.amount, currency: payout.destination_currency, connector: payout_attempt.connector, diff --git a/crates/router/src/core/payouts/validator.rs b/crates/router/src/core/payouts/validator.rs index 35c4599dbc2..1af3f4d2cb5 100644 --- a/crates/router/src/core/payouts/validator.rs +++ b/crates/router/src/core/payouts/validator.rs @@ -3,7 +3,10 @@ use std::collections::HashSet; use actix_web::http::header; #[cfg(feature = "olap")] use common_utils::errors::CustomResult; -use common_utils::validation::validate_domain_against_allowed_domains; +use common_utils::{ + id_type::{self, GenerateId}, + validation::validate_domain_against_allowed_domains, +}; use diesel_models::generic_link::PayoutLink; use error_stack::{report, ResultExt}; use hyperswitch_domain_models::payment_methods::PaymentMethod; @@ -29,8 +32,8 @@ use crate::{ #[instrument(skip(db))] pub async fn validate_uniqueness_of_payout_id_against_merchant_id( db: &dyn StorageInterface, - payout_id: &str, - merchant_id: &common_utils::id_type::MerchantId, + payout_id: &id_type::PayoutId, + merchant_id: &id_type::MerchantId, storage_scheme: storage::enums::MerchantStorageScheme, ) -> RouterResult<Option<storage::Payouts>> { let maybe_payouts = db @@ -75,9 +78,9 @@ pub async fn validate_create_request( merchant_context: &domain::MerchantContext, req: &payouts::PayoutCreateRequest, ) -> RouterResult<( - String, + id_type::PayoutId, Option<payouts::PayoutMethodData>, - common_utils::id_type::ProfileId, + id_type::ProfileId, Option<domain::Customer>, Option<PaymentMethod>, )> { @@ -101,7 +104,11 @@ pub async fn validate_create_request( // Payout ID let db: &dyn StorageInterface = &*state.store; - let payout_id = core_utils::get_or_generate_uuid("payout_id", req.payout_id.as_ref())?; + let payout_id = match req.payout_id.as_ref() { + Some(provided_payout_id) => provided_payout_id.clone(), + None => id_type::PayoutId::generate(), + }; + match validate_uniqueness_of_payout_id_against_merchant_id( db, &payout_id, @@ -111,13 +118,12 @@ pub async fn validate_create_request( .await .attach_printable_lazy(|| { format!( - "Unique violation while checking payout_id: {} against merchant_id: {:?}", - payout_id.to_owned(), - merchant_id + "Unique violation while checking payout_id: {:?} against merchant_id: {:?}", + payout_id, merchant_id ) })? { Some(_) => Err(report!(errors::ApiErrorResponse::DuplicatePayout { - payout_id: payout_id.to_owned() + payout_id: payout_id.clone() })), None => Ok(()), }?; diff --git a/crates/router/src/core/utils.rs b/crates/router/src/core/utils.rs index 17ac3f9abd0..d0a27406eb5 100644 --- a/crates/router/src/core/utils.rs +++ b/crates/router/src/core/utils.rs @@ -34,7 +34,6 @@ use masking::{ExposeInterface, PeekInterface}; use maud::{html, PreEscaped}; use regex::Regex; use router_env::{instrument, tracing}; -use uuid::Uuid; use super::payments::helpers; #[cfg(feature = "payouts")] @@ -57,7 +56,7 @@ use crate::{ storage::{self, enums}, PollConfig, }, - utils::{generate_id, generate_uuid, OptionExt, ValueExt}, + utils::{generate_id, OptionExt, ValueExt}, }; pub const IRRELEVANT_CONNECTOR_REQUEST_REFERENCE_ID_IN_DISPUTE_FLOW: &str = @@ -188,7 +187,7 @@ pub async fn construct_payout_router_data<'a, F>( minor_amount_captured: None, payment_method_status: None, request: types::PayoutsData { - payout_id: payouts.payout_id.to_owned(), + payout_id: payouts.payout_id.clone(), amount: payouts.amount.get_amount_as_i64(), minor_amount: payouts.amount, connector_payout_id: payout_attempt.connector_payout_id.clone(), @@ -622,16 +621,6 @@ pub fn get_or_generate_id( .map_or(Ok(generate_id(consts::ID_LENGTH, prefix)), validate_id) } -pub fn get_or_generate_uuid( - key: &str, - provided_id: Option<&String>, -) -> Result<String, errors::ApiErrorResponse> { - let validate_id = |id: String| validate_uuid(id, key); - provided_id - .cloned() - .map_or(Ok(generate_uuid()), validate_id) -} - fn invalid_id_format_error(key: &str) -> errors::ApiErrorResponse { errors::ApiErrorResponse::InvalidDataFormat { field_name: key.to_string(), @@ -650,13 +639,6 @@ pub fn validate_id(id: String, key: &str) -> Result<String, errors::ApiErrorResp } } -pub fn validate_uuid(uuid: String, key: &str) -> Result<String, errors::ApiErrorResponse> { - match (Uuid::parse_str(&uuid), uuid.len() > consts::MAX_ID_LENGTH) { - (Ok(_), false) => Ok(uuid), - (_, _) => Err(invalid_id_format_error(key)), - } -} - #[cfg(feature = "v1")] pub fn get_split_refunds( split_refund_input: refunds_transformers::SplitRefundInput, diff --git a/crates/router/src/core/webhooks/incoming.rs b/crates/router/src/core/webhooks/incoming.rs index 5fef952532f..cc1dc7bc506 100644 --- a/crates/router/src/core/webhooks/incoming.rs +++ b/crates/router/src/core/webhooks/incoming.rs @@ -997,7 +997,10 @@ async fn payouts_incoming_webhook_flow( business_profile, outgoing_event_type, enums::EventClass::Payouts, - updated_payout_attempt.payout_id.clone(), + updated_payout_attempt + .payout_id + .get_string_repr() + .to_string(), enums::EventObjectType::PayoutDetails, api::OutgoingWebhookContent::PayoutDetails(Box::new(payout_create_response)), Some(updated_payout_attempt.created_at), diff --git a/crates/router/src/db/kafka_store.rs b/crates/router/src/db/kafka_store.rs index 48d0d582abb..7f24d2f5c99 100644 --- a/crates/router/src/db/kafka_store.rs +++ b/crates/router/src/db/kafka_store.rs @@ -2325,6 +2325,22 @@ impl PayoutAttemptInterface for KafkaStore {} #[async_trait::async_trait] impl PayoutAttemptInterface for KafkaStore { type Error = errors::StorageError; + + async fn find_payout_attempt_by_merchant_id_merchant_order_reference_id( + &self, + merchant_id: &id_type::MerchantId, + merchant_order_reference_id: &str, + storage_scheme: MerchantStorageScheme, + ) -> CustomResult<storage::PayoutAttempt, errors::StorageError> { + self.diesel_store + .find_payout_attempt_by_merchant_id_merchant_order_reference_id( + merchant_id, + merchant_order_reference_id, + storage_scheme, + ) + .await + } + async fn find_payout_attempt_by_merchant_id_payout_attempt_id( &self, merchant_id: &id_type::MerchantId, @@ -2431,7 +2447,7 @@ impl PayoutsInterface for KafkaStore { async fn find_payout_by_merchant_id_payout_id( &self, merchant_id: &id_type::MerchantId, - payout_id: &str, + payout_id: &id_type::PayoutId, storage_scheme: MerchantStorageScheme, ) -> CustomResult<storage::Payouts, errors::StorageError> { self.diesel_store @@ -2477,7 +2493,7 @@ impl PayoutsInterface for KafkaStore { async fn find_optional_payout_by_merchant_id_payout_id( &self, merchant_id: &id_type::MerchantId, - payout_id: &str, + payout_id: &id_type::PayoutId, storage_scheme: MerchantStorageScheme, ) -> CustomResult<Option<storage::Payouts>, errors::StorageError> { self.diesel_store @@ -2533,7 +2549,7 @@ impl PayoutsInterface for KafkaStore { async fn get_total_count_of_filtered_payouts( &self, merchant_id: &id_type::MerchantId, - active_payout_ids: &[String], + active_payout_ids: &[id_type::PayoutId], connector: Option<Vec<api_models::enums::PayoutConnectors>>, currency: Option<Vec<enums::Currency>>, status: Option<Vec<enums::PayoutStatus>>, @@ -2556,7 +2572,7 @@ impl PayoutsInterface for KafkaStore { &self, merchant_id: &id_type::MerchantId, constraints: &hyperswitch_domain_models::payouts::PayoutFetchConstraints, - ) -> CustomResult<Vec<String>, errors::StorageError> { + ) -> CustomResult<Vec<id_type::PayoutId>, errors::StorageError> { self.diesel_store .filter_active_payout_ids_by_constraints(merchant_id, constraints) .await diff --git a/crates/router/src/events/outgoing_webhook_logs.rs b/crates/router/src/events/outgoing_webhook_logs.rs index 7574332f778..43f2ae54be4 100644 --- a/crates/router/src/events/outgoing_webhook_logs.rs +++ b/crates/router/src/events/outgoing_webhook_logs.rs @@ -38,7 +38,7 @@ pub enum OutgoingWebhookEventContent { content: Value, }, Payout { - payout_id: String, + payout_id: common_utils::id_type::PayoutId, content: Value, }, #[cfg(feature = "v1")] diff --git a/crates/router/src/routes/payout_link.rs b/crates/router/src/routes/payout_link.rs index 0727890bb32..71e3439d337 100644 --- a/crates/router/src/routes/payout_link.rs +++ b/crates/router/src/routes/payout_link.rs @@ -15,7 +15,10 @@ use crate::{ pub async fn render_payout_link( state: web::Data<AppState>, req: actix_web::HttpRequest, - path: web::Path<(common_utils::id_type::MerchantId, String)>, + path: web::Path<( + common_utils::id_type::MerchantId, + common_utils::id_type::PayoutId, + )>, ) -> impl Responder { let flow = Flow::PayoutLinkInitiate; let (merchant_id, payout_id) = path.into_inner(); diff --git a/crates/router/src/routes/payouts.rs b/crates/router/src/routes/payouts.rs index be0aa027d70..5bccdd06668 100644 --- a/crates/router/src/routes/payouts.rs +++ b/crates/router/src/routes/payouts.rs @@ -2,6 +2,7 @@ use actix_web::{ body::{BoxBody, MessageBody}, web, HttpRequest, HttpResponse, Responder, }; +use common_utils::id_type; use router_env::{instrument, tracing, Flow}; use super::app::AppState; @@ -50,7 +51,7 @@ pub async fn payouts_create( pub async fn payouts_retrieve( state: web::Data<AppState>, req: HttpRequest, - path: web::Path<String>, + path: web::Path<id_type::PayoutId>, query_params: web::Query<payout_types::PayoutRetrieveBody>, ) -> HttpResponse { let payout_retrieve_request = payout_types::PayoutRetrieveRequest { @@ -90,7 +91,7 @@ pub async fn payouts_retrieve( pub async fn payouts_update( state: web::Data<AppState>, req: HttpRequest, - path: web::Path<String>, + path: web::Path<id_type::PayoutId>, json_payload: web::Json<payout_types::PayoutCreateRequest>, ) -> HttpResponse { let flow = Flow::PayoutsUpdate; @@ -122,12 +123,12 @@ pub async fn payouts_confirm( state: web::Data<AppState>, req: HttpRequest, json_payload: web::Json<payout_types::PayoutCreateRequest>, - path: web::Path<String>, + path: web::Path<id_type::PayoutId>, ) -> HttpResponse { let flow = Flow::PayoutsConfirm; let mut payload = json_payload.into_inner(); let payout_id = path.into_inner(); - tracing::Span::current().record("payout_id", &payout_id); + tracing::Span::current().record("payout_id", payout_id.get_string_repr()); payload.payout_id = Some(payout_id); payload.confirm = Some(true); let api_auth = auth::ApiKeyAuth::default(); @@ -160,12 +161,12 @@ pub async fn payouts_confirm( pub async fn payouts_cancel( state: web::Data<AppState>, req: HttpRequest, - json_payload: web::Json<payout_types::PayoutActionRequest>, - path: web::Path<String>, + path: web::Path<id_type::PayoutId>, ) -> HttpResponse { let flow = Flow::PayoutsCancel; - let mut payload = json_payload.into_inner(); - payload.payout_id = path.into_inner(); + let payload = payout_types::PayoutActionRequest { + payout_id: path.into_inner(), + }; Box::pin(api::server_wrap( flow, @@ -191,12 +192,12 @@ pub async fn payouts_cancel( pub async fn payouts_fulfill( state: web::Data<AppState>, req: HttpRequest, - json_payload: web::Json<payout_types::PayoutActionRequest>, - path: web::Path<String>, + path: web::Path<id_type::PayoutId>, ) -> HttpResponse { let flow = Flow::PayoutsFulfill; - let mut payload = json_payload.into_inner(); - payload.payout_id = path.into_inner(); + let payload = payout_types::PayoutActionRequest { + payout_id: path.into_inner(), + }; Box::pin(api::server_wrap( flow, diff --git a/crates/router/src/services/kafka/payout.rs b/crates/router/src/services/kafka/payout.rs index babf7c1c568..e27009b3989 100644 --- a/crates/router/src/services/kafka/payout.rs +++ b/crates/router/src/services/kafka/payout.rs @@ -5,7 +5,7 @@ use time::OffsetDateTime; #[derive(serde::Serialize, Debug)] pub struct KafkaPayout<'a> { - pub payout_id: &'a String, + pub payout_id: &'a id_type::PayoutId, pub payout_attempt_id: &'a String, pub merchant_id: &'a id_type::MerchantId, pub customer_id: Option<&'a id_type::CustomerId>, diff --git a/crates/router/src/utils.rs b/crates/router/src/utils.rs index f89dbbec70a..a733de87656 100644 --- a/crates/router/src/utils.rs +++ b/crates/router/src/utils.rs @@ -41,7 +41,6 @@ use nanoid::nanoid; use serde::de::DeserializeOwned; use serde_json::Value; use tracing_futures::Instrument; -use uuid::Uuid; pub use self::ext_traits::{OptionExt, ValidateCall}; use crate::{ @@ -115,11 +114,6 @@ pub fn generate_id(length: usize, prefix: &str) -> String { format!("{}_{}", prefix, nanoid!(length, &consts::ALPHABETS)) } -#[inline] -pub fn generate_uuid() -> String { - Uuid::new_v4().to_string() -} - pub trait ConnectorResponseExt: Sized { fn get_response(self) -> RouterResult<types::Response>; fn get_error_response(self) -> RouterResult<types::Response>; @@ -164,7 +158,7 @@ impl<E> ConnectorResponseExt } #[inline] -pub fn get_payout_attempt_id(payout_id: impl std::fmt::Display, attempt_count: i16) -> String { +pub fn get_payout_attempt_id(payout_id: &str, attempt_count: i16) -> String { format!("{payout_id}_{attempt_count}") } @@ -1356,7 +1350,7 @@ pub async fn trigger_payouts_webhook( business_profile, event_type, diesel_models::enums::EventClass::Payouts, - cloned_response.payout_id.clone(), + cloned_response.payout_id.get_string_repr().to_owned(), diesel_models::enums::EventObjectType::PayoutDetails, webhooks::OutgoingWebhookContent::PayoutDetails(Box::new(cloned_response)), primary_object_created_at, diff --git a/crates/router/src/workflows/outgoing_webhook_retry.rs b/crates/router/src/workflows/outgoing_webhook_retry.rs index 8a04094f31d..243c7382023 100644 --- a/crates/router/src/workflows/outgoing_webhook_retry.rs +++ b/crates/router/src/workflows/outgoing_webhook_retry.rs @@ -8,6 +8,7 @@ use api_models::{ use common_utils::{ consts::DEFAULT_LOCALE, ext_traits::{StringExt, ValueExt}, + id_type, }; use diesel_models::process_tracker::business_status; use error_stack::ResultExt; @@ -283,7 +284,7 @@ impl ProcessTrackerWorkflow<SessionState> for OutgoingWebhookRetryWorkflow { #[instrument(skip_all)] pub(crate) async fn get_webhook_delivery_retry_schedule_time( db: &dyn StorageInterface, - merchant_id: &common_utils::id_type::MerchantId, + merchant_id: &id_type::MerchantId, retry_count: i32, ) -> Option<time::PrimitiveDateTime> { let key = "pt_mapping_outgoing_webhooks"; @@ -329,7 +330,7 @@ pub(crate) async fn get_webhook_delivery_retry_schedule_time( #[instrument(skip_all)] pub(crate) async fn retry_webhook_delivery_task( db: &dyn StorageInterface, - merchant_id: &common_utils::id_type::MerchantId, + merchant_id: &id_type::MerchantId, process: storage::ProcessTracker, ) -> errors::CustomResult<(), errors::StorageError> { let schedule_time = @@ -385,15 +386,14 @@ async fn get_outgoing_webhook_content_and_event_type( match tracking_data.event_class { diesel_models::enums::EventClass::Payments => { let payment_id = tracking_data.primary_object_id.clone(); - let payment_id = - common_utils::id_type::PaymentId::try_from(std::borrow::Cow::Owned(payment_id)) - .map_err(|payment_id_parsing_error| { - logger::error!( - ?payment_id_parsing_error, - "Failed to parse payment ID from tracking data" - ); - errors::ProcessTrackerError::DeserializationFailed - })?; + let payment_id = id_type::PaymentId::try_from(std::borrow::Cow::Owned(payment_id)) + .map_err(|payment_id_parsing_error| { + logger::error!( + ?payment_id_parsing_error, + "Failed to parse payment ID from tracking data" + ); + errors::ProcessTrackerError::DeserializationFailed + })?; let request = PaymentsRetrieveRequest { resource_id: PaymentIdType::PaymentIntentId(payment_id), merchant_id: Some(tracking_data.merchant_id.clone()), @@ -539,7 +539,9 @@ async fn get_outgoing_webhook_content_and_event_type( diesel_models::enums::EventClass::Payouts => { let payout_id = tracking_data.primary_object_id.clone(); let request = payout_models::PayoutRequest::PayoutActionRequest( - payout_models::PayoutActionRequest { payout_id }, + payout_models::PayoutActionRequest { + payout_id: id_type::PayoutId::try_from(std::borrow::Cow::Owned(payout_id))?, + }, ); let payout_data = Box::pin(payouts::make_payout_data( diff --git a/crates/router/tests/connectors/utils.rs b/crates/router/tests/connectors/utils.rs index 4bc234cca24..bf9bc355334 100644 --- a/crates/router/tests/connectors/utils.rs +++ b/crates/router/tests/connectors/utils.rs @@ -1,11 +1,9 @@ use std::{fmt::Debug, marker::PhantomData, str::FromStr, sync::Arc, time::Duration}; use async_trait::async_trait; -use common_utils::pii::Email; +use common_utils::{id_type::GenerateId, pii::Email}; use error_stack::Report; use masking::Secret; -#[cfg(feature = "payouts")] -use router::core::utils as core_utils; use router::{ configs::settings::Settings, core::{errors::ConnectorError, payments}, @@ -454,8 +452,7 @@ pub trait ConnectorActions: Connector { ) -> RouterData<Flow, types::PayoutsData, Res> { self.generate_data( types::PayoutsData { - payout_id: core_utils::get_or_generate_uuid("payout_id", None) - .map_or("payout_3154763247".to_string(), |p| p), + payout_id: common_utils::id_type::PayoutId::generate(), amount: 1, minor_amount: MinorUnit::new(1), connector_payout_id, diff --git a/crates/storage_impl/src/lib.rs b/crates/storage_impl/src/lib.rs index 156ebee2dea..b2a2dba5779 100644 --- a/crates/storage_impl/src/lib.rs +++ b/crates/storage_impl/src/lib.rs @@ -427,7 +427,7 @@ impl UniqueConstraints for diesel_models::Payouts { vec![format!( "po_{}_{}", self.merchant_id.get_string_repr(), - self.payout_id + self.payout_id.get_string_repr() )] } fn table_name(&self) -> &str { diff --git a/crates/storage_impl/src/mock_db/payout_attempt.rs b/crates/storage_impl/src/mock_db/payout_attempt.rs index 1fd2058e95a..008e9f921b0 100644 --- a/crates/storage_impl/src/mock_db/payout_attempt.rs +++ b/crates/storage_impl/src/mock_db/payout_attempt.rs @@ -65,4 +65,13 @@ impl PayoutAttemptInterface for MockDb { > { Err(StorageError::MockDbError)? } + + async fn find_payout_attempt_by_merchant_id_merchant_order_reference_id( + &self, + _merchant_id: &common_utils::id_type::MerchantId, + _merchant_order_reference_id: &str, + _storage_scheme: storage_enums::MerchantStorageScheme, + ) -> CustomResult<PayoutAttempt, StorageError> { + Err(StorageError::MockDbError)? + } } diff --git a/crates/storage_impl/src/mock_db/payouts.rs b/crates/storage_impl/src/mock_db/payouts.rs index ecba8f88df6..648e09bd5c6 100644 --- a/crates/storage_impl/src/mock_db/payouts.rs +++ b/crates/storage_impl/src/mock_db/payouts.rs @@ -13,7 +13,7 @@ impl PayoutsInterface for MockDb { async fn find_payout_by_merchant_id_payout_id( &self, _merchant_id: &common_utils::id_type::MerchantId, - _payout_id: &str, + _payout_id: &common_utils::id_type::PayoutId, _storage_scheme: storage_enums::MerchantStorageScheme, ) -> CustomResult<Payouts, StorageError> { // TODO: Implement function for `MockDb` @@ -43,7 +43,7 @@ impl PayoutsInterface for MockDb { async fn find_optional_payout_by_merchant_id_payout_id( &self, _merchant_id: &common_utils::id_type::MerchantId, - _payout_id: &str, + _payout_id: &common_utils::id_type::PayoutId, _storage_scheme: storage_enums::MerchantStorageScheme, ) -> CustomResult<Option<Payouts>, StorageError> { // TODO: Implement function for `MockDb` @@ -95,7 +95,7 @@ impl PayoutsInterface for MockDb { async fn get_total_count_of_filtered_payouts( &self, _merchant_id: &common_utils::id_type::MerchantId, - _active_payout_ids: &[String], + _active_payout_ids: &[common_utils::id_type::PayoutId], _connector: Option<Vec<api_models::enums::PayoutConnectors>>, _currency: Option<Vec<storage_enums::Currency>>, _status: Option<Vec<storage_enums::PayoutStatus>>, @@ -110,7 +110,7 @@ impl PayoutsInterface for MockDb { &self, _merchant_id: &common_utils::id_type::MerchantId, _constraints: &hyperswitch_domain_models::payouts::PayoutFetchConstraints, - ) -> CustomResult<Vec<String>, StorageError> { + ) -> CustomResult<Vec<common_utils::id_type::PayoutId>, StorageError> { // TODO: Implement function for `MockDb` Err(StorageError::MockDbError)? } diff --git a/crates/storage_impl/src/payouts/payout_attempt.rs b/crates/storage_impl/src/payouts/payout_attempt.rs index e1706fad124..35939c11323 100644 --- a/crates/storage_impl/src/payouts/payout_attempt.rs +++ b/crates/storage_impl/src/payouts/payout_attempt.rs @@ -60,7 +60,7 @@ impl<T: DatabaseStore> PayoutAttemptInterface for KVRouterStore<T> { let payout_attempt_id = new_payout_attempt.payout_id.clone(); let key = PartitionKey::MerchantIdPayoutAttemptId { merchant_id: &merchant_id, - payout_attempt_id: &payout_attempt_id, + payout_attempt_id: payout_attempt_id.get_string_repr(), }; let key_str = key.to_string(); let created_attempt = PayoutAttempt { @@ -88,6 +88,9 @@ impl<T: DatabaseStore> PayoutAttemptInterface for KVRouterStore<T> { routing_info: new_payout_attempt.routing_info.clone(), unified_code: new_payout_attempt.unified_code.clone(), unified_message: new_payout_attempt.unified_message.clone(), + merchant_order_reference_id: new_payout_attempt + .merchant_order_reference_id + .clone(), }; let redis_entry = kv::TypedSql { @@ -149,7 +152,7 @@ impl<T: DatabaseStore> PayoutAttemptInterface for KVRouterStore<T> { ) -> error_stack::Result<PayoutAttempt, errors::StorageError> { let key = PartitionKey::MerchantIdPayoutAttemptId { merchant_id: &this.merchant_id, - payout_attempt_id: &this.payout_id, + payout_attempt_id: this.payout_id.get_string_repr(), }; let field = format!("poa_{}", this.payout_attempt_id); let storage_scheme = Box::pin(decide_storage_scheme::<_, DieselPayoutAttempt>( @@ -378,6 +381,22 @@ impl<T: DatabaseStore> PayoutAttemptInterface for KVRouterStore<T> { .get_filters_for_payouts(payouts, merchant_id, storage_scheme) .await } + + #[instrument(skip_all)] + async fn find_payout_attempt_by_merchant_id_merchant_order_reference_id( + &self, + merchant_id: &common_utils::id_type::MerchantId, + merchant_order_reference_id: &str, + storage_scheme: MerchantStorageScheme, + ) -> error_stack::Result<PayoutAttempt, errors::StorageError> { + self.router_store + .find_payout_attempt_by_merchant_id_merchant_order_reference_id( + merchant_id, + merchant_order_reference_id, + storage_scheme, + ) + .await + } } #[async_trait::async_trait] @@ -504,6 +523,27 @@ impl<T: DatabaseStore> PayoutAttemptInterface for crate::RouterStore<T> { }, ) } + + #[instrument(skip_all)] + async fn find_payout_attempt_by_merchant_id_merchant_order_reference_id( + &self, + merchant_id: &common_utils::id_type::MerchantId, + merchant_order_reference_id: &str, + _storage_scheme: MerchantStorageScheme, + ) -> error_stack::Result<PayoutAttempt, errors::StorageError> { + let conn = pg_connection_read(self).await?; + DieselPayoutAttempt::find_by_merchant_id_merchant_order_reference_id( + &conn, + merchant_id, + merchant_order_reference_id, + ) + .await + .map(PayoutAttempt::from_storage_model) + .map_err(|er| { + let new_err = diesel_error_to_data_error(*er.current_context()); + er.change_context(new_err) + }) + } } impl DataModelExt for PayoutAttempt { @@ -533,6 +573,7 @@ impl DataModelExt for PayoutAttempt { unified_code: self.unified_code, unified_message: self.unified_message, additional_payout_method_data: self.additional_payout_method_data, + merchant_order_reference_id: self.merchant_order_reference_id, } } @@ -560,6 +601,7 @@ impl DataModelExt for PayoutAttempt { unified_code: storage_model.unified_code, unified_message: storage_model.unified_message, additional_payout_method_data: storage_model.additional_payout_method_data, + merchant_order_reference_id: storage_model.merchant_order_reference_id, } } } @@ -590,6 +632,7 @@ impl DataModelExt for PayoutAttemptNew { unified_code: self.unified_code, unified_message: self.unified_message, additional_payout_method_data: self.additional_payout_method_data, + merchant_order_reference_id: self.merchant_order_reference_id, } } @@ -617,6 +660,7 @@ impl DataModelExt for PayoutAttemptNew { unified_code: storage_model.unified_code, unified_message: storage_model.unified_message, additional_payout_method_data: storage_model.additional_payout_method_data, + merchant_order_reference_id: storage_model.merchant_order_reference_id, } } } diff --git a/crates/storage_impl/src/payouts/payouts.rs b/crates/storage_impl/src/payouts/payouts.rs index 484328aabab..c9d16b7d8a2 100644 --- a/crates/storage_impl/src/payouts/payouts.rs +++ b/crates/storage_impl/src/payouts/payouts.rs @@ -80,7 +80,7 @@ impl<T: DatabaseStore> PayoutsInterface for KVRouterStore<T> { payout_id: &payout_id, }; let key_str = key.to_string(); - let field = format!("po_{}", new.payout_id); + let field = format!("po_{}", new.payout_id.get_string_repr()); let created_payout = Payouts { payout_id: new.payout_id.clone(), merchant_id: new.merchant_id.clone(), @@ -151,7 +151,7 @@ impl<T: DatabaseStore> PayoutsInterface for KVRouterStore<T> { merchant_id: &this.merchant_id, payout_id: &this.payout_id, }; - let field = format!("po_{}", this.payout_id); + let field = format!("po_{}", this.payout_id.get_string_repr()); let storage_scheme = Box::pin(decide_storage_scheme::<_, DieselPayouts>( self, storage_scheme, @@ -207,7 +207,7 @@ impl<T: DatabaseStore> PayoutsInterface for KVRouterStore<T> { async fn find_payout_by_merchant_id_payout_id( &self, merchant_id: &common_utils::id_type::MerchantId, - payout_id: &str, + payout_id: &common_utils::id_type::PayoutId, storage_scheme: MerchantStorageScheme, ) -> error_stack::Result<Payouts, StorageError> { let database_call = || async { @@ -232,7 +232,7 @@ impl<T: DatabaseStore> PayoutsInterface for KVRouterStore<T> { merchant_id, payout_id, }; - let field = format!("po_{payout_id}"); + let field = format!("po_{}", payout_id.get_string_repr()); Box::pin(utils::try_redis_get_else_try_database_get( async { Box::pin(kv_wrapper::<DieselPayouts, _, _>( @@ -255,7 +255,7 @@ impl<T: DatabaseStore> PayoutsInterface for KVRouterStore<T> { async fn find_optional_payout_by_merchant_id_payout_id( &self, merchant_id: &common_utils::id_type::MerchantId, - payout_id: &str, + payout_id: &common_utils::id_type::PayoutId, storage_scheme: MerchantStorageScheme, ) -> error_stack::Result<Option<Payouts>, StorageError> { let database_call = || async { @@ -276,20 +276,14 @@ impl<T: DatabaseStore> PayoutsInterface for KVRouterStore<T> { match storage_scheme { MerchantStorageScheme::PostgresOnly => { let maybe_payouts = database_call().await?; - Ok(maybe_payouts.and_then(|payout| { - if payout.payout_id == payout_id { - Some(payout) - } else { - None - } - })) + Ok(maybe_payouts.filter(|payout| &payout.payout_id == payout_id)) } MerchantStorageScheme::RedisKv => { let key = PartitionKey::MerchantIdPayoutId { merchant_id, payout_id, }; - let field = format!("po_{payout_id}"); + let field = format!("po_{}", payout_id.get_string_repr()); Box::pin(utils::try_redis_get_else_try_database_get( async { Box::pin(kv_wrapper::<DieselPayouts, _, _>( @@ -360,7 +354,7 @@ impl<T: DatabaseStore> PayoutsInterface for KVRouterStore<T> { async fn get_total_count_of_filtered_payouts( &self, merchant_id: &common_utils::id_type::MerchantId, - active_payout_ids: &[String], + active_payout_ids: &[common_utils::id_type::PayoutId], connector: Option<Vec<PayoutConnectors>>, currency: Option<Vec<storage_enums::Currency>>, status: Option<Vec<storage_enums::PayoutStatus>>, @@ -383,7 +377,7 @@ impl<T: DatabaseStore> PayoutsInterface for KVRouterStore<T> { &self, merchant_id: &common_utils::id_type::MerchantId, constraints: &PayoutFetchConstraints, - ) -> error_stack::Result<Vec<String>, StorageError> { + ) -> error_stack::Result<Vec<common_utils::id_type::PayoutId>, StorageError> { self.router_store .filter_active_payout_ids_by_constraints(merchant_id, constraints) .await @@ -434,7 +428,7 @@ impl<T: DatabaseStore> PayoutsInterface for crate::RouterStore<T> { async fn find_payout_by_merchant_id_payout_id( &self, merchant_id: &common_utils::id_type::MerchantId, - payout_id: &str, + payout_id: &common_utils::id_type::PayoutId, _storage_scheme: MerchantStorageScheme, ) -> error_stack::Result<Payouts, StorageError> { let conn = pg_connection_read(self).await?; @@ -451,7 +445,7 @@ impl<T: DatabaseStore> PayoutsInterface for crate::RouterStore<T> { async fn find_optional_payout_by_merchant_id_payout_id( &self, merchant_id: &common_utils::id_type::MerchantId, - payout_id: &str, + payout_id: &common_utils::id_type::PayoutId, _storage_scheme: MerchantStorageScheme, ) -> error_stack::Result<Option<Payouts>, StorageError> { let conn = pg_connection_read(self).await?; @@ -498,7 +492,7 @@ impl<T: DatabaseStore> PayoutsInterface for crate::RouterStore<T> { query = query.filter(po_dsl::profile_id.eq(profile_id.clone())); } - query = match (params.starting_at, &params.starting_after_id) { + query = match (params.starting_at, params.starting_after_id.as_ref()) { (Some(starting_at), _) => query.filter(po_dsl::created_at.ge(starting_at)), (None, Some(starting_after_id)) => { // TODO: Fetch partial columns for this query since we only need some columns @@ -515,7 +509,7 @@ impl<T: DatabaseStore> PayoutsInterface for crate::RouterStore<T> { (None, None) => query, }; - query = match (params.ending_at, &params.ending_before_id) { + query = match (params.ending_at, params.ending_before_id.as_ref()) { (Some(ending_at), _) => query.filter(po_dsl::created_at.le(ending_at)), (None, Some(ending_before_id)) => { // TODO: Fetch partial columns for this query since we only need some columns @@ -619,10 +613,18 @@ impl<T: DatabaseStore> PayoutsInterface for crate::RouterStore<T> { query = query.filter(po_dsl::profile_id.eq(profile_id.clone())); } - query = match (params.starting_at, &params.starting_after_id) { + if let Some(merchant_order_reference_id_filter) = + &params.merchant_order_reference_id + { + query = query.filter( + poa_dsl::merchant_order_reference_id + .eq(merchant_order_reference_id_filter.clone()), + ); + } + + query = match (params.starting_at, params.starting_after_id.as_ref()) { (Some(starting_at), _) => query.filter(po_dsl::created_at.ge(starting_at)), (None, Some(starting_after_id)) => { - // TODO: Fetch partial columns for this query since we only need some columns let starting_at = self .find_payout_by_merchant_id_payout_id( merchant_id, @@ -636,10 +638,9 @@ impl<T: DatabaseStore> PayoutsInterface for crate::RouterStore<T> { (None, None) => query, }; - query = match (params.ending_at, &params.ending_before_id) { + query = match (params.ending_at, params.ending_before_id.as_ref()) { (Some(ending_at), _) => query.filter(po_dsl::created_at.le(ending_at)), (None, Some(ending_before_id)) => { - // TODO: Fetch partial columns for this query since we only need some columns let ending_at = self .find_payout_by_merchant_id_payout_id( merchant_id, @@ -665,20 +666,24 @@ impl<T: DatabaseStore> PayoutsInterface for crate::RouterStore<T> { .map(|c| c.iter().map(|c| c.to_string()).collect::<Vec<String>>()); query = match connectors { - Some(connectors) => query.filter(poa_dsl::connector.eq_any(connectors)), - None => query, + Some(conn_filters) if !conn_filters.is_empty() => { + query.filter(poa_dsl::connector.eq_any(conn_filters)) + } + _ => query, }; query = match &params.status { - Some(status) => query.filter(po_dsl::status.eq_any(status.clone())), - None => query, + Some(status_filters) if !status_filters.is_empty() => { + query.filter(po_dsl::status.eq_any(status_filters.clone())) + } + _ => query, }; query = match &params.payout_method { - Some(payout_method) => { + Some(payout_method) if !payout_method.is_empty() => { query.filter(po_dsl::payout_type.eq_any(payout_method.clone())) } - None => query, + _ => query, }; query @@ -760,7 +765,7 @@ impl<T: DatabaseStore> PayoutsInterface for crate::RouterStore<T> { async fn get_total_count_of_filtered_payouts( &self, merchant_id: &common_utils::id_type::MerchantId, - active_payout_ids: &[String], + active_payout_ids: &[common_utils::id_type::PayoutId], connector: Option<Vec<PayoutConnectors>>, currency: Option<Vec<storage_enums::Currency>>, status: Option<Vec<storage_enums::PayoutStatus>>, @@ -800,7 +805,7 @@ impl<T: DatabaseStore> PayoutsInterface for crate::RouterStore<T> { &self, merchant_id: &common_utils::id_type::MerchantId, constraints: &PayoutFetchConstraints, - ) -> error_stack::Result<Vec<String>, StorageError> { + ) -> error_stack::Result<Vec<common_utils::id_type::PayoutId>, StorageError> { let conn = connection::pg_connection_read(self).await?; let conn = async_bb8_diesel::Connection::as_async_conn(&conn); let mut query = DieselPayouts::table() @@ -868,8 +873,14 @@ impl<T: DatabaseStore> PayoutsInterface for crate::RouterStore<T> { error_stack::report!(diesel_models::errors::DatabaseError::from(er)) .attach_printable("Error filtering payout records"), ) - .into() + })? + .into_iter() + .map(|s| { + common_utils::id_type::PayoutId::try_from(std::borrow::Cow::Owned(s)) + .change_context(StorageError::DeserializationFailed) + .attach_printable("Failed to deserialize PayoutId from database string") }) + .collect::<error_stack::Result<Vec<_>, _>>() } #[cfg(all(feature = "olap", feature = "v2"))] @@ -878,7 +889,7 @@ impl<T: DatabaseStore> PayoutsInterface for crate::RouterStore<T> { &self, _merchant_id: &common_utils::id_type::MerchantId, _constraints: &PayoutFetchConstraints, - ) -> error_stack::Result<Vec<String>, StorageError> { + ) -> error_stack::Result<Vec<common_utils::id_type::PayoutId>, StorageError> { todo!() } } diff --git a/crates/storage_impl/src/redis/kv_store.rs b/crates/storage_impl/src/redis/kv_store.rs index fd583f500ed..e7c47c58996 100644 --- a/crates/storage_impl/src/redis/kv_store.rs +++ b/crates/storage_impl/src/redis/kv_store.rs @@ -41,7 +41,7 @@ pub enum PartitionKey<'a> { }, MerchantIdPayoutId { merchant_id: &'a common_utils::id_type::MerchantId, - payout_id: &'a str, + payout_id: &'a common_utils::id_type::PayoutId, }, MerchantIdPayoutAttemptId { merchant_id: &'a common_utils::id_type::MerchantId, @@ -93,8 +93,9 @@ impl std::fmt::Display for PartitionKey<'_> { merchant_id, payout_id, } => f.write_str(&format!( - "mid_{}_po_{payout_id}", - merchant_id.get_string_repr() + "mid_{}_po_{}", + merchant_id.get_string_repr(), + payout_id.get_string_repr() )), PartitionKey::MerchantIdPayoutAttemptId { merchant_id, diff --git a/flake.nix b/flake.nix index 35fa05b73a7..05058a75d9e 100644 --- a/flake.nix +++ b/flake.nix @@ -43,6 +43,7 @@ devPackages = base ++ (with pkgs; [ cargo-watch nixd + protobuf rust-bin.stable.${rustDevVersion}.default swagger-cli ]); diff --git a/migrations/2025-06-19-170656_alter_payout_primary_key/down.sql b/migrations/2025-06-19-170656_alter_payout_primary_key/down.sql new file mode 100644 index 00000000000..e8ff6e1c5a1 --- /dev/null +++ b/migrations/2025-06-19-170656_alter_payout_primary_key/down.sql @@ -0,0 +1,7 @@ +ALTER TABLE payout_attempt DROP COLUMN merchant_order_reference_id; + +ALTER TABLE payout_attempt DROP CONSTRAINT payout_attempt_pkey; +ALTER TABLE payout_attempt ADD PRIMARY KEY (payout_attempt_id); + +ALTER TABLE payouts DROP CONSTRAINT payouts_pkey; +ALTER TABLE payouts ADD PRIMARY KEY (payout_id); diff --git a/migrations/2025-06-19-170656_alter_payout_primary_key/up.sql b/migrations/2025-06-19-170656_alter_payout_primary_key/up.sql new file mode 100644 index 00000000000..d65c931719f --- /dev/null +++ b/migrations/2025-06-19-170656_alter_payout_primary_key/up.sql @@ -0,0 +1,7 @@ +ALTER TABLE payout_attempt DROP CONSTRAINT payout_attempt_pkey; +ALTER TABLE payout_attempt ADD PRIMARY KEY (merchant_id, payout_attempt_id); + +ALTER TABLE payouts DROP CONSTRAINT payouts_pkey; +ALTER TABLE payouts ADD PRIMARY KEY (merchant_id, payout_id); + +ALTER TABLE payout_attempt ADD COLUMN merchant_order_reference_id VARCHAR(255) NULL;

2025-06-20T04:35:56Z

feat(payouts): allow payout_id to be configurable in API request feat(payouts): add merchant_order_reference_id for referencing payouts ## Type of Change  - [ ] Bugfix - [x] New feature - [ ] Enhancement - [x] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description This pull request introduces two main features for payouts: 1. **Configurable `payout_id` in API Requests**: * The `payout_id` field in payout creation API requests can now be optionally provided by the merchant. If provided, this ID will be used for the payout. If not provided, the system will generate one. * Internally, the usage of `payout_id` has been standardized to use the strongly-typed `common_utils::id_type::PayoutId` instead of `String`. This change has been propagated throughout relevant structs and functionalities like `PayoutsData`, data handling logic in `crates/router/src/core/utils.rs`, test utilities and DB queries. 2. **`merchant_order_reference_id` for Payout Referencing**: * The `merchant_order_reference_id` field has been added/updated in payout API models (e.g., `PayoutListFilterConstraints` in `crates/api_models/src/payouts.rs`). This allows merchants to use their own unique identifier to reference payouts. **Refactoring and Connector Updates**: * To support the `id_type::PayoutId` change and ensure correct data flow, connector integrations (Adyen, Adyenplatform, Cybersource, Nomupay) have been refactored. * Connectors now consistently use `RouterData.connector_request_reference_id` (which typically holds the `payout_attempt_id` as a `String`) when a string-based reference is required by the external service, rather than converting the internal `PayoutsData.payout_id`. This ensures that connectors receive the appropriate string identifier (e.g., `payout_attempt_id`) they expect. ### Additional Changes - [x] This PR modifies the API contract. - [x] This PR modifies the database schema. - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context These changes address the need for greater flexibility and type safety in payout processing, as outlined in GitHub issues #8392 and #1321. * **Configurable `payout_id`**: Allows merchants more control over their payout identifiers within the Hyperswitch. * **`merchant_order_reference_id`**: Provides a dedicated field for merchants to use their internal order or reference IDs. * **`PayoutId` Type Standardization**: Using `common_utils::id_type::PayoutId` enhances code robustness and maintainability by leveraging Rust's type system to prevent errors related to ID handling. * **Connector Refactoring**: Ensures that connectors use the correct string-based identifiers (like `payout_attempt_id` via `connector_request_reference_id`) required by external payout processors, maintaining correctness of integrations. Links to issues: * https://github.com/juspay/hyperswitch/issues/8392 * https://github.com/juspay/hyperswitch/issues/1321 ## How did you test it? <details> <summary>1. Card payouts via API</summary> cURL curl --location --request POST 'http://localhost:8080/payouts/create' \ --header 'Content-Type: application/json' \ --header 'api-key: dev_lAISInmiO4UNrMmvkJogzRVKEGKlBKQbRCBFOkLJTXmq6nsD5G1H65BjOd4H72H8' \ --data '{"amount":100,"currency":"EUR","profile_id":"pro_vVSlzCG7M1GSX9SyssY8","customer_id":"cus_WULwykbL8laUbxDUeGEB","connector":["adyenplatform"],"description":"Its my first payout request","payout_type":"card","payout_method_data":{"card":{"card_number":"4111111111111111","expiry_month":"03","expiry_year":"2030"}},"billing":{"address":{"line1":"1467","line2":"Harrison Street","line3":"Harrison Street","city":"San Fransico","state":"CA","zip":"94122","country":"FR","first_name":"John","last_name":"Doe"}},"entity_type":"Individual","recurring":true,"metadata":{"ref":"123"},"confirm":true,"auto_fulfill":true}' Response {"payout_id":"ff21b89d-3cfd-4f0f-b3ff-c468d90d7074","merchant_id":"merchant_1751292662","amount":100,"currency":"EUR","connector":"adyenplatform","payout_type":"card","payout_method_data":{"card":{"card_issuer":null,"card_network":null,"card_type":null,"card_issuing_country":null,"bank_code":null,"last4":"1111","card_isin":"411111","card_extended_bin":null,"card_exp_month":"03","card_exp_year":"2030","card_holder_name":null}},"billing":{"address":{"city":"San Fransico","country":"FR","line1":"1467","line2":"Harrison Street","line3":"Harrison Street","zip":"94122","state":"CA","first_name":"John","last_name":"Doe"},"phone":null,"email":null},"auto_fulfill":true,"customer_id":"cus_WULwykbL8laUbxDUeGEB","customer":{"id":"cus_WULwykbL8laUbxDUeGEB","name":"John Nether","email":null,"phone":"6168205362","phone_country_code":"+1"},"client_secret":"payout_ff21b89d-3cfd-4f0f-b3ff-c468d90d7074_secret_qzFALtOg6ZhYAOAUr2qY","return_url":null,"business_country":null,"business_label":null,"description":"Its my first payout request","entity_type":"Individual","recurring":true,"metadata":{"ref":"123"},"merchant_connector_id":"mca_SfssFvg5RBT2k7iKRRsS","status":"initiated","error_message":null,"error_code":null,"profile_id":"pro_vVSlzCG7M1GSX9SyssY8","created":"2025-06-30T14:12:47.886Z","connector_transaction_id":"38EBIX67HBSYZ30V","priority":null,"payout_link":null,"email":null,"name":"John Nether","phone":"6168205362","phone_country_code":"+1","unified_code":null,"unified_message":null,"payout_method_id":"pm_wScFhCfxELZ7gN13Nbxz"} </details> <details> <summary>2. Card payouts via Payout Links</summary> cURL curl --location --request POST 'http://localhost:8080/payouts/create' \ --header 'Content-Type: application/json' \ --header 'api-key: dev_lAISInmiO4UNrMmvkJogzRVKEGKlBKQbRCBFOkLJTXmq6nsD5G1H65BjOd4H72H8' \ --data '{"amount":1,"currency":"EUR","customer_id":"cus_WULwykbL8laUbxDUeGEB","description":"Its my first payout request","entity_type":"Individual","confirm":false,"auto_fulfill":true,"session_expiry":1000000,"profile_id":"pro_vVSlzCG7M1GSX9SyssY8","payout_link":true,"return_url":"https://www.google.com","payout_link_config":{"form_layout":"journey","theme":"#0066ff","logo":"https://hyperswitch.io/favicon.ico","merchant_name":"HyperSwitch Inc.","test_mode":true}}' Response {"payout_id":"2371746b-df3d-41da-8fa2-455faf921ea9","merchant_id":"merchant_1751292662","amount":1,"currency":"EUR","connector":null,"payout_type":null,"payout_method_data":null,"billing":null,"auto_fulfill":true,"customer_id":"cus_WULwykbL8laUbxDUeGEB","customer":{"id":"cus_WULwykbL8laUbxDUeGEB","name":"John Nether","email":null,"phone":"6168205362","phone_country_code":"+1"},"client_secret":"payout_2371746b-df3d-41da-8fa2-455faf921ea9_secret_VwDeIScMTLFzG7Iz1DZU","return_url":"https://www.google.com","business_country":null,"business_label":null,"description":"Its my first payout request","entity_type":"Individual","recurring":false,"metadata":{},"merchant_connector_id":null,"status":"requires_payout_method_data","error_message":null,"error_code":null,"profile_id":"pro_vVSlzCG7M1GSX9SyssY8","created":"2025-06-30T14:14:48.897Z","connector_transaction_id":null,"priority":null,"payout_link":{"payout_link_id":"payout_link_vITmtOWGkaUfeXopruRs","link":"http://localhost:8080/payout_link/merchant_1751292662/2371746b-df3d-41da-8fa2-455faf921ea9?locale=en"},"email":null,"name":"John Nether","phone":"6168205362","phone_country_code":"+1","unified_code":null,"unified_message":null,"payout_method_id":null} <img width="1719" alt="Screenshot 2025-06-30 at 7 45 32 PM" src="https://github.com/user-attachments/assets/e1ace815-74b5-411a-83be-badb2c04bf7d" /> <img width="1721" alt="Screenshot 2025-06-30 at 7 45 48 PM" src="https://github.com/user-attachments/assets/a8233053-9c1e-402d-87af-e59783fefc9d" /> <img width="913" alt="Screenshot 2025-06-30 at 7 45 54 PM" src="https://github.com/user-attachments/assets/586d1aa9-0116-46f3-b597-91b1f46ba5d2" /> </details> ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.114.0

0c649158a8ee491e2ff6ff37e922266d5b64b22d

juspay/hyperswitch

juspay__hyperswitch-8394

Bug: feat(revenue_recovery): Invoke attempt list instead of payment get in recovery webhooks flow Previously we were using payment get to find whether attempt is present in db or not, but for the first invoice webhook there won't be any attempt present in db and recently we added a validation to use payment get only in case of attempt is present. Also for stripe billing / stripe connector_transaction_id remains same instead charge id keeps changing , so we need to add support for this by checking if charge id is present we compare charge id if not we check for connector transaction id.

diff --git a/api-reference/README.md b/api-reference/README.md index b0343f44e62..ef3537d6b73 100644 --- a/api-reference/README.md +++ b/api-reference/README.md @@ -45,4 +45,4 @@ npx @mintlify/scraping@latest openapi-file v1/openapi_spec_v1.json -o v1 This will generate files in [api-reference](api-reference) folder. These routes should be added to the [mint.json](mint.json) file under navigation, under respective group. -NOTE: For working with V2 API reference, replace every occurence of `v1` with `v2` in above commands \ No newline at end of file +NOTE: For working with V2 API reference, replace every occurrence of `v1` with `v2` in above commands \ No newline at end of file diff --git a/api-reference/v2/openapi_spec_v2.json b/api-reference/v2/openapi_spec_v2.json index b213d96accd..853b0c3c5b5 100644 --- a/api-reference/v2/openapi_spec_v2.json +++ b/api-reference/v2/openapi_spec_v2.json @@ -15711,6 +15711,11 @@ } ], "nullable": true + }, + "charge_id": { + "type": "string", + "example": "ch_123abc456def789ghi012klmn", + "nullable": true } } }, diff --git a/crates/api_models/src/payments.rs b/crates/api_models/src/payments.rs index cb5480ed1f4..25e85c3f90c 100644 --- a/crates/api_models/src/payments.rs +++ b/crates/api_models/src/payments.rs @@ -1668,6 +1668,9 @@ pub struct PaymentAttemptRevenueRecoveryData { /// Flag to find out whether an attempt was created by external or internal system. #[schema(value_type = Option<TriggeredBy>, example = "internal")] pub attempt_triggered_by: common_enums::TriggeredBy, + // stripe specific field used to identify duplicate attempts. + #[schema(value_type = Option<String>, example = "ch_123abc456def789ghi012klmn")] + pub charge_id: Option<String>, } #[derive( @@ -5812,22 +5815,34 @@ pub struct PaymentsResponse { } #[cfg(feature = "v2")] -impl PaymentsResponse { +impl PaymentAttemptListResponse { pub fn find_attempt_in_attempts_list_using_connector_transaction_id( - self, + &self, connector_transaction_id: &common_utils::types::ConnectorTransactionId, ) -> Option<PaymentAttemptResponse> { - self.attempts - .as_ref() - .and_then(|attempts| { - attempts.iter().find(|attempt| { - attempt - .connector_payment_id + self.payment_attempt_list.iter().find_map(|attempt| { + attempt + .connector_payment_id + .as_ref() + .filter(|txn_id| *txn_id == connector_transaction_id) + .map(|_| attempt.clone()) + }) + } + pub fn find_attempt_in_attempts_list_using_charge_id( + &self, + charge_id: String, + ) -> Option<PaymentAttemptResponse> { + self.payment_attempt_list.iter().find_map(|attempt| { + attempt.feature_metadata.as_ref().and_then(|metadata| { + metadata.revenue_recovery.as_ref().and_then(|recovery| { + recovery + .charge_id .as_ref() - .is_some_and(|txn_id| txn_id == connector_transaction_id) + .filter(|id| **id == charge_id) + .map(|_| attempt.clone()) }) }) - .cloned() + }) } } diff --git a/crates/diesel_models/src/payment_attempt.rs b/crates/diesel_models/src/payment_attempt.rs index fa373d2305b..473502ad746 100644 --- a/crates/diesel_models/src/payment_attempt.rs +++ b/crates/diesel_models/src/payment_attempt.rs @@ -3708,6 +3708,8 @@ pub struct PaymentAttemptFeatureMetadata { #[diesel(sql_type = diesel::pg::sql_types::Jsonb)] pub struct PaymentAttemptRecoveryData { pub attempt_triggered_by: common_enums::TriggeredBy, + // stripe specific field used to identify duplicate attempts. + pub charge_id: Option<String>, } #[cfg(feature = "v2")] common_utils::impl_to_sql_from_sql_json!(PaymentAttemptFeatureMetadata); diff --git a/crates/hyperswitch_connectors/src/connectors/chargebee/transformers.rs b/crates/hyperswitch_connectors/src/connectors/chargebee/transformers.rs index 6436cd952e7..e0c84b4b459 100644 --- a/crates/hyperswitch_connectors/src/connectors/chargebee/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/chargebee/transformers.rs @@ -509,6 +509,8 @@ impl TryFrom<ChargebeeWebhookBody> for revenue_recovery::RevenueRecoveryAttemptD invoice_next_billing_time, card_network: Some(payment_method_details.card.brand), card_isin: Some(payment_method_details.card.iin), + // This field is none because it is specific to stripebilling. + charge_id: None, }) } } diff --git a/crates/hyperswitch_connectors/src/connectors/recurly/transformers.rs b/crates/hyperswitch_connectors/src/connectors/recurly/transformers.rs index 9ffd900dc45..70edb327ded 100644 --- a/crates/hyperswitch_connectors/src/connectors/recurly/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/recurly/transformers.rs @@ -208,6 +208,8 @@ impl ), card_network: Some(item.response.payment_method.card_type), card_isin: Some(item.response.payment_method.first_six), + // This none because this field is specific to stripebilling. + charge_id: None, }, ), ..item.data diff --git a/crates/hyperswitch_connectors/src/connectors/stripebilling/transformers.rs b/crates/hyperswitch_connectors/src/connectors/stripebilling/transformers.rs index 1352b874c8a..ca0875ba4ce 100644 --- a/crates/hyperswitch_connectors/src/connectors/stripebilling/transformers.rs +++ b/crates/hyperswitch_connectors/src/connectors/stripebilling/transformers.rs @@ -561,6 +561,7 @@ impl )), // Todo: Fetch Card issuer details. Generally in the other billing connector we are getting card_issuer using the card bin info. But stripe dosent provide any such details. We should find a way for stripe billing case card_isin: None, + charge_id: Some(charge_details.charge_id.clone()), }, ), ..item.data diff --git a/crates/hyperswitch_domain_models/src/payments.rs b/crates/hyperswitch_domain_models/src/payments.rs index 99ce4ca17f3..25e194ca391 100644 --- a/crates/hyperswitch_domain_models/src/payments.rs +++ b/crates/hyperswitch_domain_models/src/payments.rs @@ -746,6 +746,8 @@ impl PaymentIntent { invoice_next_billing_time: None, card_isin: None, card_network: None, + // No charge id is present here since it is an internal payment and we didn't call connector yet. + charge_id: None, }) } diff --git a/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs b/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs index 56e0942431c..c35fbc3163e 100644 --- a/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs +++ b/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs @@ -726,6 +726,12 @@ impl PaymentAttempt { revenue_recovery: Some({ PaymentAttemptRevenueRecoveryData { attempt_triggered_by: request.triggered_by, + charge_id: request.feature_metadata.as_ref().and_then(|metadata| { + metadata + .revenue_recovery + .as_ref() + .and_then(|data| data.charge_id.clone()) + }), } }), }; @@ -2781,6 +2787,8 @@ pub struct PaymentAttemptFeatureMetadata { #[derive(Debug, Clone, serde::Serialize, PartialEq)] pub struct PaymentAttemptRevenueRecoveryData { pub attempt_triggered_by: common_enums::TriggeredBy, + // stripe specific field used to identify duplicate attempts. + pub charge_id: Option<String>, } #[cfg(feature = "v2")] @@ -2791,6 +2799,7 @@ impl From<&PaymentAttemptFeatureMetadata> for DieselPaymentAttemptFeatureMetadat .as_ref() .map(|recovery_data| DieselPassiveChurnRecoveryData { attempt_triggered_by: recovery_data.attempt_triggered_by, + charge_id: recovery_data.charge_id.clone(), }); Self { revenue_recovery } } @@ -2803,6 +2812,7 @@ impl From<DieselPaymentAttemptFeatureMetadata> for PaymentAttemptFeatureMetadata item.revenue_recovery .map(|recovery_data| PaymentAttemptRevenueRecoveryData { attempt_triggered_by: recovery_data.attempt_triggered_by, + charge_id: recovery_data.charge_id, }); Self { revenue_recovery } } diff --git a/crates/hyperswitch_domain_models/src/revenue_recovery.rs b/crates/hyperswitch_domain_models/src/revenue_recovery.rs index 837d5d90839..0485644628a 100644 --- a/crates/hyperswitch_domain_models/src/revenue_recovery.rs +++ b/crates/hyperswitch_domain_models/src/revenue_recovery.rs @@ -52,6 +52,8 @@ pub struct RevenueRecoveryAttemptData { pub card_network: Option<common_enums::CardNetwork>, /// card isin pub card_isin: Option<String>, + /// stripe specific id used to validate duplicate attempts in revenue recovery flow + pub charge_id: Option<String>, } /// This is unified struct for Revenue Recovery Invoice Data and it is constructed from billing connectors @@ -278,6 +280,7 @@ impl invoice_next_billing_time: invoice_details.next_billing_at, card_network: billing_connector_payment_details.card_network.clone(), card_isin: billing_connector_payment_details.card_isin.clone(), + charge_id: billing_connector_payment_details.charge_id.clone(), } } } diff --git a/crates/hyperswitch_domain_models/src/router_response_types/revenue_recovery.rs b/crates/hyperswitch_domain_models/src/router_response_types/revenue_recovery.rs index 8dd6aa2e74c..3df81e6b66d 100644 --- a/crates/hyperswitch_domain_models/src/router_response_types/revenue_recovery.rs +++ b/crates/hyperswitch_domain_models/src/router_response_types/revenue_recovery.rs @@ -32,6 +32,8 @@ pub struct BillingConnectorPaymentsSyncResponse { pub card_network: Option<common_enums::CardNetwork>, /// card isin pub card_isin: Option<String>, + /// stripe specific id used to validate duplicate attempts. + pub charge_id: Option<String>, } #[derive(Debug, Clone)] diff --git a/crates/router/src/core/payments/transformers.rs b/crates/router/src/core/payments/transformers.rs index 5d40a603cbb..65f526af2e3 100644 --- a/crates/router/src/core/payments/transformers.rs +++ b/crates/router/src/core/payments/transformers.rs @@ -4989,6 +4989,7 @@ impl let revenue_recovery = feature_metadata.revenue_recovery.as_ref().map(|recovery| { api_models::payments::PaymentAttemptRevenueRecoveryData { attempt_triggered_by: recovery.attempt_triggered_by, + charge_id: recovery.charge_id.clone(), } }); Self { revenue_recovery } diff --git a/crates/router/src/core/routing/helpers.rs b/crates/router/src/core/routing/helpers.rs index 1dd965a71ce..666d0020260 100644 --- a/crates/router/src/core/routing/helpers.rs +++ b/crates/router/src/core/routing/helpers.rs @@ -1539,7 +1539,7 @@ pub async fn push_metrics_with_update_window_for_contract_based_routing( routing_events::RoutingEngine::IntelligentRouter, routing_events::ApiMethod::Grpc) .change_context(errors::ApiErrorResponse::InternalServerError) - .attach_printable("ContractRouting-Intelligent-Router: Failed to contruct RoutingEventsBuilder")? + .attach_printable("ContractRouting-Intelligent-Router: Failed to construct RoutingEventsBuilder")? .trigger_event(state, closure) .await .change_context(errors::ApiErrorResponse::InternalServerError) diff --git a/crates/router/src/core/webhooks/recovery_incoming.rs b/crates/router/src/core/webhooks/recovery_incoming.rs index cc4e08861ac..f13caeefb76 100644 --- a/crates/router/src/core/webhooks/recovery_incoming.rs +++ b/crates/router/src/core/webhooks/recovery_incoming.rs @@ -467,45 +467,49 @@ impl RevenueRecoveryAttempt { )>, errors::RevenueRecoveryError, > { - let attempt_response = Box::pin(payments::payments_core::< - router_flow_types::payments::PSync, - api_payments::PaymentsResponse, - _, - _, - _, - hyperswitch_domain_models::payments::PaymentStatusData< - router_flow_types::payments::PSync, - >, - >( - state.clone(), - req_state.clone(), - merchant_context.clone(), - profile.clone(), - payments::operations::PaymentGet, - api_payments::PaymentsRetrieveRequest { - force_sync: false, - expand_attempts: true, - param: None, - all_keys_required: None, - merchant_connector_details: None, - }, - payment_intent.payment_id.clone(), - payments::CallConnectorAction::Avoid, - hyperswitch_domain_models::payments::HeaderPayload::default(), - )) - .await; + let attempt_response = + Box::pin(payments::payments_list_attempts_using_payment_intent_id::< + payments::operations::PaymentGetListAttempts, + api_payments::PaymentAttemptListResponse, + _, + payments::operations::payment_attempt_list::PaymentGetListAttempts, + hyperswitch_domain_models::payments::PaymentAttemptListData< + payments::operations::PaymentGetListAttempts, + >, + >( + state.clone(), + req_state.clone(), + merchant_context.clone(), + profile.clone(), + payments::operations::PaymentGetListAttempts, + api_payments::PaymentAttemptListRequest { + payment_intent_id: payment_intent.payment_id.clone(), + }, + payment_intent.payment_id.clone(), + hyperswitch_domain_models::payments::HeaderPayload::default(), + )) + .await; let response = match attempt_response { Ok(services::ApplicationResponse::JsonWithHeaders((payments_response, _))) => { - let final_attempt = - self.0 - .connector_transaction_id - .as_ref() - .and_then(|transaction_id| { - payments_response - .find_attempt_in_attempts_list_using_connector_transaction_id( - transaction_id, - ) - }); + let final_attempt = self + .0 + .charge_id + .as_ref() + .map(|charge_id| { + payments_response + .find_attempt_in_attempts_list_using_charge_id(charge_id.clone()) + }) + .unwrap_or_else(|| { + self.0 + .connector_transaction_id + .as_ref() + .and_then(|transaction_id| { + payments_response + .find_attempt_in_attempts_list_using_connector_transaction_id( + transaction_id, + ) + }) + }); let payment_attempt = final_attempt.map(|attempt_res| revenue_recovery::RecoveryPaymentAttempt { attempt_id: attempt_res.id.to_owned(), @@ -613,6 +617,7 @@ impl RevenueRecoveryAttempt { revenue_recovery: Some(api_payments::PaymentAttemptRevenueRecoveryData { // Since we are recording the external paymenmt attempt, this is hardcoded to External attempt_triggered_by: triggered_by, + charge_id: self.0.charge_id.clone(), }), };

2025-06-19T17:51:05Z

## Type of Change  - [x] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  Previously we were using payment get to find whether attempt is present in db or not, but for the first invoice webhook there won't be any attempt present in db and recently we added a validation to use payment get only in case of attempt is present. This PR solves this issue by invoking payment get attempt list instead of payment get. Also for stripe billing / stripe connector_transaction_id remains same instead charge id keeps changing , so we added a support for this by checking if charge id is present we compare charge id if not we check for connector transaction id. ### Additional Changes - [x] This PR modifies the API contract - [x] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  ## How did you test it?  Tested complete revenue recovery flow with stripebilling 1) Set up merchant and mca for billing and payment connector for stripebilling and stripe 2) Make sure merchant have retry_algorithm_type to cascading in business profile 3) Trigger payment invoice from stripe, after threshold external attempts , pt entry should be done in and start triggering internal payments. ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.114.0

7943fb4bfb156e22d5329d45a580f90e02283604

juspay/hyperswitch

juspay__hyperswitch-8407

Bug: ci(connector): [ARCHIPEL] configure test cases Automate CI Checks by Fixing, Adding and Configuring Test Cases over:- - [Postman](https://github.com/juspay/hyperswitch/pull/8360) - [Cypress](https://github.com/juspay/hyperswitch/pull/8189)

2025-05-30T16:25:08Z

## Type of Change  - [ ] Bugfix - [ ] New feature - [x] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [x] CI/CD ## Description  Enhancements for `archipel` Cypress Tests. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  `archipel` Cypress Tests were failing. ## How did you test it?   <img width="726" height="962" alt="image" src="https://github.com/user-attachments/assets/ee72bc01-69a1-4afb-ac76-8c3edec1c124" /> _PS: There is an issue with Incremental Auth, not anything related to the configs, but the spec itself, addressing it in another PR because that would affect 1 other connector as well, and after it is fixed, it would affect 3 connectors in total._ ## Checklist  - [ ] I formatted the code `cargo +nightly fmt --all` - [ ] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

8ccaac7c10e9366772e43d34f271d946cc4b3baa

juspay/hyperswitch

juspay__hyperswitch-8381

Bug: fix(openapi): Fix broken pages in mintlify (v2) v2 mintlify docs have several broken pages and some endpoints are missing.

diff --git a/api-reference/docs.json b/api-reference/docs.json index ecdf944452c..9688afc3241 100644 --- a/api-reference/docs.json +++ b/api-reference/docs.json @@ -265,11 +265,11 @@ "pages": [ "v2/payment-methods/payment-method--create", "v2/payment-methods/payment-method--create-intent", - "v2/payment-methods/payment-method--payment-methods-list", "v2/payment-methods/payment-method--confirm-intent", "v2/payment-methods/payment-method--update", "v2/payment-methods/payment-method--retrieve", "v2/payment-methods/payment-method--delete", + "v2/payment-methods/payment-method--list-customer-saved-payment-methods", "v2/payment-methods/list-saved-payment-methods-for-a-customer" ] }, @@ -291,13 +291,17 @@ "v2/customers/customers--retrieve", "v2/customers/customers--update", "v2/customers/customers--delete", - "v2/customers/customers--list", - "v2/customers/customers--list-saved-payment-methods" + "v2/customers/customers--list" ] }, { "group": "Refunds", - "pages": ["v2/refunds/refunds--create"] + "pages": [ + "v2/refunds/refunds--create", + "v2/refunds/refunds--metadata-update", + "v2/refunds/refunds--retrieve", + "v2/refunds/refunds--list" + ] } ] }, @@ -373,6 +377,10 @@ { "group": "Tokenization", "pages": ["v2/tokenization/tokenization--create"] + }, + { + "group": "Revenue Recovery", + "pages": ["v2/revenue-recovery/revenue-recovery--retrieve"] } ] } diff --git a/api-reference/v2/customers/customers--update.mdx b/api-reference/v2/customers/customers--update.mdx index 8d4bed86c97..c3e10b62564 100644 --- a/api-reference/v2/customers/customers--update.mdx +++ b/api-reference/v2/customers/customers--update.mdx @@ -1,3 +1,3 @@ --- -openapi: put /v2/customers/{id} +openapi: post /v2/customers/{id} --- diff --git a/api-reference/v2/openapi_spec_v2.json b/api-reference/v2/openapi_spec_v2.json index 0304eaf3b0c..783b7326766 100644 --- a/api-reference/v2/openapi_spec_v2.json +++ b/api-reference/v2/openapi_spec_v2.json @@ -1958,18 +1958,6 @@ "type": "string" }, "example": "pro_abcdefghijklmnop" - }, - { - "name": "X-Client-Secret", - "in": "header", - "description": "Client Secret Associated with the payment intent", - "required": true, - "schema": { - "type": "string" - }, - "example": { - "X-Client-Secret": "12345_pay_0193e41106e07e518940f8b51b9c8121_secret_0193e41107027a928d61d292e6a5dba9" - } } ], "requestBody": { @@ -2222,18 +2210,6 @@ "type": "string" }, "example": "pro_abcdefghijklmnop" - }, - { - "name": "X-Client-Secret", - "in": "header", - "description": "Client Secret Associated with the payment intent", - "required": true, - "schema": { - "type": "string" - }, - "example": { - "X-Client-Secret": "12345_pay_0193e41106e07e518940f8b51b9c8121_secret_0193e41107027a928d61d292e6a5dba9" - } } ], "responses": { @@ -3538,6 +3514,8 @@ "tags": [ "Tokenization" ], + "summary": "Tokenization - Create", + "description": "Create a token with customer_id", "operationId": "create_token_vault_api", "requestBody": { "content": { diff --git a/api-reference/v2/payment-method-session/payment-method-session--confirm-a-payment-method-session.mdx b/api-reference/v2/payment-method-session/payment-method-session--confirm-a-payment-method-session.mdx index d115fc72370..ed9cec389da 100644 --- a/api-reference/v2/payment-method-session/payment-method-session--confirm-a-payment-method-session.mdx +++ b/api-reference/v2/payment-method-session/payment-method-session--confirm-a-payment-method-session.mdx @@ -1,3 +1,3 @@ --- -openapi: post /v2/payment-method-session/:id/confirm +openapi: post /v2/payment-method-session/{id}/confirm --- \ No newline at end of file diff --git a/api-reference/v2/payment-method-session/payment-method-session--delete-a-saved-payment-method.mdx b/api-reference/v2/payment-method-session/payment-method-session--delete-a-saved-payment-method.mdx index 2f9e800ebe8..a4bcd483c6b 100644 --- a/api-reference/v2/payment-method-session/payment-method-session--delete-a-saved-payment-method.mdx +++ b/api-reference/v2/payment-method-session/payment-method-session--delete-a-saved-payment-method.mdx @@ -1,3 +1,3 @@ --- -openapi: delete /v2/payment-method-session/:id +openapi: delete /v2/payment-method-session/{id} --- diff --git a/api-reference/v2/payment-method-session/payment-method-session--list-payment-methods.mdx b/api-reference/v2/payment-method-session/payment-method-session--list-payment-methods.mdx index bbbaf01c297..1dc6cc5eb34 100644 --- a/api-reference/v2/payment-method-session/payment-method-session--list-payment-methods.mdx +++ b/api-reference/v2/payment-method-session/payment-method-session--list-payment-methods.mdx @@ -1,3 +1,3 @@ --- -openapi: get /v2/payment-method-session/:id/list-payment-methods +openapi: get /v2/payment-method-session/{id}/list-payment-methods --- \ No newline at end of file diff --git a/api-reference/v2/payment-method-session/payment-method-session--retrieve.mdx b/api-reference/v2/payment-method-session/payment-method-session--retrieve.mdx index 3f0ab4a7461..4e504390a45 100644 --- a/api-reference/v2/payment-method-session/payment-method-session--retrieve.mdx +++ b/api-reference/v2/payment-method-session/payment-method-session--retrieve.mdx @@ -1,3 +1,3 @@ --- -openapi: get /v2/payment-method-session/:id +openapi: get /v2/payment-method-session/{id} --- \ No newline at end of file diff --git a/api-reference/v2/payment-method-session/payment-method-session--update-a-saved-payment-method.mdx b/api-reference/v2/payment-method-session/payment-method-session--update-a-saved-payment-method.mdx index fab85e2a419..f7e887dbb96 100644 --- a/api-reference/v2/payment-method-session/payment-method-session--update-a-saved-payment-method.mdx +++ b/api-reference/v2/payment-method-session/payment-method-session--update-a-saved-payment-method.mdx @@ -1,3 +1,3 @@ --- -openapi: put /v2/payment-method-session/:id/update-saved-payment-method +openapi: put /v2/payment-method-session/{id}/update-saved-payment-method --- diff --git a/api-reference/v2/payment-methods/list-customer-saved-payment-methods-for-a-payment.mdx b/api-reference/v2/payment-methods/list-customer-saved-payment-methods-for-a-payment.mdx deleted file mode 100644 index 7809830b820..00000000000 --- a/api-reference/v2/payment-methods/list-customer-saved-payment-methods-for-a-payment.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: get /v2/payments/{id}/saved-payment-methods ---- \ No newline at end of file diff --git a/api-reference/v2/payment-methods/list-payment-methods-for-a-customer.mdx b/api-reference/v2/payment-methods/list-payment-methods-for-a-customer.mdx deleted file mode 100644 index ef5a27f9604..00000000000 --- a/api-reference/v2/payment-methods/list-payment-methods-for-a-customer.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: get /v2/customers/{id}/saved-payment-methods ---- \ No newline at end of file diff --git a/api-reference/v2/payment-methods/list-saved-payment-methods-for-a-customer.mdx b/api-reference/v2/payment-methods/list-saved-payment-methods-for-a-customer.mdx deleted file mode 100644 index ef5a27f9604..00000000000 --- a/api-reference/v2/payment-methods/list-saved-payment-methods-for-a-customer.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: get /v2/customers/{id}/saved-payment-methods ---- \ No newline at end of file diff --git a/api-reference/v2/customers/customers--list-saved-payment-methods.mdx b/api-reference/v2/payment-methods/payment-method--list-customer-saved-payment-methods.mdx similarity index 100% rename from api-reference/v2/customers/customers--list-saved-payment-methods.mdx rename to api-reference/v2/payment-methods/payment-method--list-customer-saved-payment-methods.mdx diff --git a/api-reference/v2/refunds/refunds--list.mdx b/api-reference/v2/refunds/refunds--list.mdx new file mode 100644 index 00000000000..18167989707 --- /dev/null +++ b/api-reference/v2/refunds/refunds--list.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /v2/refunds/list +--- \ No newline at end of file diff --git a/api-reference/v2/refunds/refunds--metadata-update.mdx b/api-reference/v2/refunds/refunds--metadata-update.mdx new file mode 100644 index 00000000000..52695bf10fb --- /dev/null +++ b/api-reference/v2/refunds/refunds--metadata-update.mdx @@ -0,0 +1,3 @@ +--- +openapi: put /v2/refunds/{id}/update_metadata +--- \ No newline at end of file diff --git a/api-reference/v2/refunds/refunds--retrieve.mdx b/api-reference/v2/refunds/refunds--retrieve.mdx new file mode 100644 index 00000000000..bd73db1a72e --- /dev/null +++ b/api-reference/v2/refunds/refunds--retrieve.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /v2/refunds/{id} +--- \ No newline at end of file diff --git a/api-reference/v2/revenue-recovery/revenue-recovery--retrieve.mdx b/api-reference/v2/revenue-recovery/revenue-recovery--retrieve.mdx new file mode 100644 index 00000000000..119f750a7ac --- /dev/null +++ b/api-reference/v2/revenue-recovery/revenue-recovery--retrieve.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /v2/process_tracker/revenue_recovery_workflow/{revenue_recovery_id} +--- \ No newline at end of file diff --git a/crates/openapi/src/routes/payments.rs b/crates/openapi/src/routes/payments.rs index 6160b68b44b..2d25ca4f77f 100644 --- a/crates/openapi/src/routes/payments.rs +++ b/crates/openapi/src/routes/payments.rs @@ -923,12 +923,7 @@ pub fn payments_update_intent() {} "X-Profile-Id" = String, Header, description = "Profile ID associated to the payment intent", example = "pro_abcdefghijklmnop" - ), - ( - "X-Client-Secret" = String, Header, - description = "Client Secret Associated with the payment intent", - example = json!({"X-Client-Secret": "12345_pay_0193e41106e07e518940f8b51b9c8121_secret_0193e41107027a928d61d292e6a5dba9"}) - ), + ) ), request_body( content = PaymentsConfirmIntentRequest, @@ -1058,11 +1053,6 @@ pub(crate) enum ForceSync { description = "Profile ID associated to the payment intent", example = "pro_abcdefghijklmnop" ), - ( - "X-Client-Secret" = String, Header, - description = "Client Secret Associated with the payment intent", - example = json!({"X-Client-Secret": "12345_pay_0193e41106e07e518940f8b51b9c8121_secret_0193e41107027a928d61d292e6a5dba9"}) - ), ), responses( (status = 200, description = "Get the payment methods", body = PaymentMethodListResponseForPayments), diff --git a/crates/openapi/src/routes/tokenization.rs b/crates/openapi/src/routes/tokenization.rs index 22f1227a9c0..d69008911ce 100644 --- a/crates/openapi/src/routes/tokenization.rs +++ b/crates/openapi/src/routes/tokenization.rs @@ -1,6 +1,9 @@ use serde_json::json; use utoipa::OpenApi; +/// Tokenization - Create +/// +/// Create a token with customer_id #[cfg(feature = "v2")] #[utoipa::path( post,

2025-06-18T18:02:28Z

## Type of Change  - [x] Bugfix - [ ] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [x] Documentation - [ ] CI/CD ## Description  Fixed the following mintlify pages: - `v2/customers/customers--update.mdx` - `payment-method-session--confirm-a-payment-method-session.mdx` - `payment-method-session--delete-a-saved-payment-method.mdx` - `payment-method-session--list-payment-methods.mdx` - `payment-method-session--retrieve.mdx` - `payment-method-session--update-a-saved-payment-method.mdx` Added the following missing pages: - `payment-method--list-customer-saved-payment-methods.mdx` - `refunds--list.mdx` - `refunds--metadata-update.mdx` - `refunds--retrieve.mdx` - `revenue-recovery--retrieve.mdx` ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  Closes #8381 ## How did you test it?  Verified with `mint dev` ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.114.0

17c30b6105d9086585edac0c89432b1f4568c3de

juspay/hyperswitch

juspay__hyperswitch-8386

Bug: Api contract changes to accept `saving_percentage` in the decision engine response Api contract changes to accept `saving_percentage` in the decision engine response

diff --git a/crates/api_models/src/open_router.rs b/crates/api_models/src/open_router.rs index af91ece3f12..5d5f8f016c0 100644 --- a/crates/api_models/src/open_router.rs +++ b/crates/api_models/src/open_router.rs @@ -67,17 +67,32 @@ pub struct DecidedGateway { #[derive(Debug, Serialize, Deserialize, PartialEq, Clone)] pub struct DebitRoutingOutput { - pub co_badged_card_networks: Vec<common_enums::CardNetwork>, + pub co_badged_card_networks_info: Vec<CoBadgedCardNetworksInfo>, pub issuer_country: common_enums::CountryAlpha2, pub is_regulated: bool, pub regulated_name: Option<common_enums::RegulatedName>, pub card_type: common_enums::CardType, } +#[derive(Debug, Serialize, Deserialize, PartialEq, Clone)] +pub struct CoBadgedCardNetworksInfo { + pub network: common_enums::CardNetwork, + pub saving_percentage: f64, +} + +impl DebitRoutingOutput { + pub fn get_co_badged_card_networks(&self) -> Vec<common_enums::CardNetwork> { + self.co_badged_card_networks_info + .iter() + .map(|data| data.network.clone()) + .collect() + } +} + impl From<&DebitRoutingOutput> for payment_methods::CoBadgedCardData { fn from(output: &DebitRoutingOutput) -> Self { Self { - co_badged_card_networks: output.co_badged_card_networks.clone(), + co_badged_card_networks: output.get_co_badged_card_networks(), issuer_country_code: output.issuer_country, is_regulated: output.is_regulated, regulated_name: output.regulated_name.clone(), @@ -96,7 +111,7 @@ impl TryFrom<(payment_methods::CoBadgedCardData, String)> for DebitRoutingReques })?; Ok(Self { - co_badged_card_networks: output.co_badged_card_networks, + co_badged_card_networks_info: output.co_badged_card_networks, issuer_country: output.issuer_country_code, is_regulated: output.is_regulated, regulated_name: output.regulated_name, @@ -114,7 +129,7 @@ pub struct CoBadgedCardRequest { #[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] pub struct DebitRoutingRequestData { - pub co_badged_card_networks: Vec<common_enums::CardNetwork>, + pub co_badged_card_networks_info: Vec<common_enums::CardNetwork>, pub issuer_country: common_enums::CountryAlpha2, pub is_regulated: bool, pub regulated_name: Option<common_enums::RegulatedName>, diff --git a/crates/router/src/core/debit_routing.rs b/crates/router/src/core/debit_routing.rs index c7de440bbf6..ca03f5d2532 100644 --- a/crates/router/src/core/debit_routing.rs +++ b/crates/router/src/core/debit_routing.rs @@ -256,8 +256,8 @@ where get_debit_routing_output::<F, D>(state, payment_data, acquirer_country).await?; logger::debug!( - "Sorted co-badged networks: {:?}", - debit_routing_output.co_badged_card_networks + "Sorted co-badged networks info: {:?}", + debit_routing_output.co_badged_card_networks_info ); let key_store = db @@ -281,7 +281,7 @@ where &profile_id, &key_store, vec![connector_data.clone()], - debit_routing_output.co_badged_card_networks.clone(), + debit_routing_output.get_co_badged_card_networks(), ) .await .map_err(|error| { @@ -455,7 +455,7 @@ where &profile_id, &key_store, connector_data_list.clone(), - debit_routing_output.co_badged_card_networks.clone(), + debit_routing_output.get_co_badged_card_networks(), ) .await .map_err(|error| {

2025-06-19T08:01:15Z

- [ ] Bugfix - [ ] New feature - [ ] Enhancement - [x] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  This pull request refactors the `DebitRoutingOutput` structure to introduce a new `CoBadgedCardNetworksInfo` type, enhancing the representation of co-badged card networks by including additional metadata such as saving percentages. It also updates related methods and structures to align with this change. ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  ## How did you test it?  -> Enable debit routing for a profile and configure adyen connector -> Make a payment ``` curl --location 'http://localhost:8080/payments' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'x-feature: router-custom' \ --header 'x-tenant-id: hyperswitch' \ --header 'api-key: ' \ --data-raw '{ "amount": 10000, "amount_to_capture": 10000, "currency": "USD", "confirm": true, "capture_method": "automatic", "setup_future_usage": "on_session", "capture_on": "2022-09-10T10:11:12Z", "email": "[email protected]", "name": "John Doe", "phone": "999999999", "phone_country_code": "+1", "description": "Its my first payment request", "authentication_type": "no_three_ds", "customer_id": "cu_1750319776", "return_url": "http://127.0.0.1:4040", "payment_method": "card", "payment_method_type": "debit", "payment_method_data": { "card": { "card_number": "4400 0020 0000 0004", "card_exp_month": "03", "card_exp_year": "2030", "card_holder_name": "joseph Doe", "card_cvc": "737" } }, "billing": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San", "state": "California", "zip": "94122", "country": "US", "first_name": "PiX", "last_name": "ss" }, "email": "[email protected]" }, "shipping": { "address": { "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "city": "San Fransico", "state": "California", "zip": "94122", "country": "US", "first_name": "PiX" } }, "customer_acceptance": { "acceptance_type": "offline", "accepted_at": "1963-05-03T04:07:52.723Z", "online": { "ip_address": "in sit", "user_agent": "amet irure esse" } }, "browser_info": { "user_agent": "Mozilla\/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/70.0.3538.110 Safari\/537.36", "accept_header": "text\/html,application\/xhtml+xml,application\/xml;q=0.9,image\/webp,image\/apng,*\/*;q=0.8", "language": "nl-NL", "color_depth": 24, "screen_height": 723, "screen_width": 1536, "time_zone": 0, "java_enabled": true, "java_script_enabled": true, "ip_address": "125.0.0.1" }, "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "metadata": { "udf1": "value1", "new_customer": "true", "login_date": "2019-09-10T10:11:12Z" } }' ``` ``` { "payment_id": "pay_7aTZkTRH72iemhbxOqvc", "merchant_id": "merchant_1750232289", "status": "succeeded", "amount": 10000, "net_amount": 10000, "shipping_cost": null, "amount_capturable": 0, "amount_received": 10000, "connector": "adyen", "client_secret": "pay_7aTZkTRH72iemhbxOqvc_secret_2v6ATAqLFQsKVhms16hF", "created": "2025-06-18T07:40:06.149Z", "currency": "USD", "customer_id": "cu_1750232406", "customer": { "id": "cu_1750232406", "name": "John Doe", "email": "[email protected]", "phone": "999999999", "phone_country_code": "+1" }, "description": "Its my first payment request", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": "on_session", "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "card", "payment_method_data": { "card": { "last4": "0004", "card_type": null, "card_network": "Accel", "card_issuer": null, "card_issuing_country": null, "card_isin": "440000", "card_extended_bin": null, "card_exp_month": "03", "card_exp_year": "2030", "card_holder_name": "joseph Doe", "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": { "address": { "city": "San Fransico", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "PiX", "last_name": null }, "phone": null, "email": null }, "billing": { "address": { "city": "San", "country": "US", "line1": "1467", "line2": "Harrison Street", "line3": "Harrison Street", "zip": "94122", "state": "California", "first_name": "PiX", "last_name": "ss" }, "phone": null, "email": "[email protected]" }, "order_details": null, "email": "[email protected]", "name": "John Doe", "phone": "999999999", "return_url": "http://127.0.0.1:4040/", "authentication_type": "no_three_ds", "statement_descriptor_name": "joseph", "statement_descriptor_suffix": "JS", "next_action": null, "cancellation_reason": null, "error_code": null, "error_message": null, "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "debit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": { "customer_id": "cu_1750232406", "created_at": 1750232406, "expires": 1750236006, "secret": "epk_1a8a73a55db941eb89b3c5a54b42bc3d" }, "manual_retry_allowed": false, "connector_transaction_id": "JKCHRB6V9DDHL975", "frm_message": null, "metadata": { "udf1": "value1", "login_date": "2019-09-10T10:11:12Z", "new_customer": "true" }, "connector_metadata": null, "feature_metadata": null, "reference_id": "pay_7aTZkTRH72iemhbxOqvc_1", "payment_link": null, "profile_id": "pro_n23wrYOtUyaiFMM71SEq", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_xC22XUKnNCBkg5vHm1W0", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2025-06-18T07:55:06.149Z", "fingerprint": null, "browser_info": { "language": "nl-NL", "time_zone": 0, "ip_address": "125.0.0.1", "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36", "color_depth": 24, "java_enabled": true, "screen_width": 1536, "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8", "screen_height": 723, "java_script_enabled": true }, "payment_method_id": null, "payment_method_status": null, "updated": "2025-06-18T07:40:07.133Z", "split_payments": null, "frm_metadata": null, "extended_authorization_applied": null, "capture_before": null, "merchant_order_reference_id": null, "order_tax_amount": null, "connector_mandate_id": null, "card_discovery": "manual", "force_3ds_challenge": false, "force_3ds_challenge_trigger": false, "issuer_error_code": null, "issuer_error_message": null, "is_iframe_redirection_enabled": null, "whole_connector_response": null } ``` Once the payment is done the api events should have the `saving_percentage` in the decision engine response ``` { "decided_gateway": "ADYEN", "gateway_priority_map": null, "filter_wise_gateways": null, "priority_logic_tag": null, "routing_approach": "NONE", "gateway_before_evaluation": null, "priority_logic_output": null, "debit_routing_output": { "co_badged_card_networks_info": [ { "network": "ACCEL", "saving_percentage": 0.14 }, { "network": "STAR", "saving_percentage": 0.04 }, { "network": "VISA", "saving_percentage": 0.0 } ], "issuer_country": "US", "is_regulated": true, "regulated_name": "GOVERNMENT EXEMPT INTERCHANGE FEE", "card_type": "debit" }, "reset_approach": "NO_RESET", "routing_dimension": null, "routing_dimension_level": null, "is_scheduled_outage": false, "is_dynamic_mga_enabled": false, "gateway_mga_id_map": null } ``` ## Checklist  - [x] I formatted the code `cargo +nightly fmt --all` - [x] I addressed lints thrown by `cargo clippy` - [x] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.114.0

305ca9bda9d3c5bf3cc97458b7ed07b79e894154

juspay/hyperswitch

juspay__hyperswitch-8409

Bug: [FEATURE] Add routing metrics endpoint ### Feature Description Need to add an endpoint for routing metrics. Also add routing approach as a filter in payment analytics ### Possible Implementation Need to add an endpoint for routing metrics. Also add routing approach as a filter in payment analytics ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? Yes, I am willing to submit a PR!

diff --git a/crates/analytics/docs/clickhouse/scripts/payment_attempts.sql b/crates/analytics/docs/clickhouse/scripts/payment_attempts.sql index f5d0ca51fd7..6673b73fedb 100644 --- a/crates/analytics/docs/clickhouse/scripts/payment_attempts.sql +++ b/crates/analytics/docs/clickhouse/scripts/payment_attempts.sql @@ -43,6 +43,7 @@ CREATE TABLE payment_attempt_queue ( `organization_id` String, `profile_id` String, `card_network` Nullable(String), + `routing_approach` LowCardinality(Nullable(String)), `sign_flag` Int8 ) ENGINE = Kafka SETTINGS kafka_broker_list = 'kafka0:29092', kafka_topic_list = 'hyperswitch-payment-attempt-events', @@ -96,6 +97,7 @@ CREATE TABLE payment_attempts ( `organization_id` String, `profile_id` String, `card_network` Nullable(String), + `routing_approach` LowCardinality(Nullable(String)), `sign_flag` Int8, INDEX connectorIndex connector TYPE bloom_filter GRANULARITY 1, INDEX paymentMethodIndex payment_method TYPE bloom_filter GRANULARITY 1, @@ -152,6 +154,7 @@ CREATE MATERIALIZED VIEW payment_attempt_mv TO payment_attempts ( `organization_id` String, `profile_id` String, `card_network` Nullable(String), + `routing_approach` LowCardinality(Nullable(String)), `sign_flag` Int8 ) AS SELECT @@ -200,6 +203,7 @@ SELECT organization_id, profile_id, card_network, + routing_approach, sign_flag FROM payment_attempt_queue diff --git a/crates/analytics/src/core.rs b/crates/analytics/src/core.rs index 980e17bc90a..f3dd8e8eb8c 100644 --- a/crates/analytics/src/core.rs +++ b/crates/analytics/src/core.rs @@ -46,6 +46,11 @@ pub async fn get_domain_info( download_dimensions: None, dimensions: utils::get_dispute_dimensions(), }, + AnalyticsDomain::Routing => GetInfoResponse { + metrics: utils::get_payment_metrics_info(), + download_dimensions: None, + dimensions: utils::get_payment_dimensions(), + }, }; Ok(info) } diff --git a/crates/analytics/src/payments/core.rs b/crates/analytics/src/payments/core.rs index 7291d2f1fcc..e55ba2726af 100644 --- a/crates/analytics/src/payments/core.rs +++ b/crates/analytics/src/payments/core.rs @@ -410,6 +410,7 @@ pub async fn get_filters( PaymentDimensions::CardLast4 => fil.card_last_4, PaymentDimensions::CardIssuer => fil.card_issuer, PaymentDimensions::ErrorReason => fil.error_reason, + PaymentDimensions::RoutingApproach => fil.routing_approach.map(|i| i.as_ref().to_string()), }) .collect::<Vec<String>>(); res.query_data.push(FilterValue { diff --git a/crates/analytics/src/payments/distribution.rs b/crates/analytics/src/payments/distribution.rs index 86a2f06c5f5..ab82e48f407 100644 --- a/crates/analytics/src/payments/distribution.rs +++ b/crates/analytics/src/payments/distribution.rs @@ -37,6 +37,7 @@ pub struct PaymentDistributionRow { pub total: Option<bigdecimal::BigDecimal>, pub count: Option<i64>, pub error_message: Option<String>, + pub routing_approach: Option<DBEnumWrapper<storage_enums::RoutingApproach>>, #[serde(with = "common_utils::custom_serde::iso8601::option")] pub start_bucket: Option<PrimitiveDateTime>, #[serde(with = "common_utils::custom_serde::iso8601::option")] diff --git a/crates/analytics/src/payments/distribution/payment_error_message.rs b/crates/analytics/src/payments/distribution/payment_error_message.rs index 0a92cfbe470..d5fa0569452 100644 --- a/crates/analytics/src/payments/distribution/payment_error_message.rs +++ b/crates/analytics/src/payments/distribution/payment_error_message.rs @@ -160,6 +160,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(|i| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/filters.rs b/crates/analytics/src/payments/filters.rs index 668bdaa6c8b..b6ebf094e81 100644 --- a/crates/analytics/src/payments/filters.rs +++ b/crates/analytics/src/payments/filters.rs @@ -1,6 +1,6 @@ use api_models::analytics::{payments::PaymentDimensions, Granularity, TimeRange}; use common_utils::errors::ReportSwitchExt; -use diesel_models::enums::{AttemptStatus, AuthenticationType, Currency}; +use diesel_models::enums::{AttemptStatus, AuthenticationType, Currency, RoutingApproach}; use error_stack::ResultExt; use time::PrimitiveDateTime; @@ -65,4 +65,5 @@ pub struct PaymentFilterRow { pub card_issuer: Option<String>, pub error_reason: Option<String>, pub first_attempt: Option<bool>, + pub routing_approach: Option<DBEnumWrapper<RoutingApproach>>, } diff --git a/crates/analytics/src/payments/metrics.rs b/crates/analytics/src/payments/metrics.rs index 71d2e57d7fa..67dc50c5152 100644 --- a/crates/analytics/src/payments/metrics.rs +++ b/crates/analytics/src/payments/metrics.rs @@ -50,6 +50,7 @@ pub struct PaymentMetricRow { pub first_attempt: Option<bool>, pub total: Option<bigdecimal::BigDecimal>, pub count: Option<i64>, + pub routing_approach: Option<DBEnumWrapper<storage_enums::RoutingApproach>>, #[serde(with = "common_utils::custom_serde::iso8601::option")] pub start_bucket: Option<PrimitiveDateTime>, #[serde(with = "common_utils::custom_serde::iso8601::option")] diff --git a/crates/analytics/src/payments/metrics/avg_ticket_size.rs b/crates/analytics/src/payments/metrics/avg_ticket_size.rs index 10f350e30ce..8ec175cf8da 100644 --- a/crates/analytics/src/payments/metrics/avg_ticket_size.rs +++ b/crates/analytics/src/payments/metrics/avg_ticket_size.rs @@ -122,6 +122,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(|i| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/connector_success_rate.rs b/crates/analytics/src/payments/metrics/connector_success_rate.rs index 9e6bf31fbfb..eb4518f6d23 100644 --- a/crates/analytics/src/payments/metrics/connector_success_rate.rs +++ b/crates/analytics/src/payments/metrics/connector_success_rate.rs @@ -117,6 +117,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(|i| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/payment_count.rs b/crates/analytics/src/payments/metrics/payment_count.rs index 297aef4fec5..ed23a400fb7 100644 --- a/crates/analytics/src/payments/metrics/payment_count.rs +++ b/crates/analytics/src/payments/metrics/payment_count.rs @@ -108,6 +108,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(|i| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/payment_processed_amount.rs b/crates/analytics/src/payments/metrics/payment_processed_amount.rs index 95846924665..302acf097ed 100644 --- a/crates/analytics/src/payments/metrics/payment_processed_amount.rs +++ b/crates/analytics/src/payments/metrics/payment_processed_amount.rs @@ -122,6 +122,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(|i| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/payment_success_count.rs b/crates/analytics/src/payments/metrics/payment_success_count.rs index 843e2858977..d1f437d812d 100644 --- a/crates/analytics/src/payments/metrics/payment_success_count.rs +++ b/crates/analytics/src/payments/metrics/payment_success_count.rs @@ -115,6 +115,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(|i| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/retries_count.rs b/crates/analytics/src/payments/metrics/retries_count.rs index ced845651cf..63ebfaefca6 100644 --- a/crates/analytics/src/payments/metrics/retries_count.rs +++ b/crates/analytics/src/payments/metrics/retries_count.rs @@ -112,6 +112,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(|i| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/sessionized_metrics/avg_ticket_size.rs b/crates/analytics/src/payments/metrics/sessionized_metrics/avg_ticket_size.rs index e29c19bda88..a5138777361 100644 --- a/crates/analytics/src/payments/metrics/sessionized_metrics/avg_ticket_size.rs +++ b/crates/analytics/src/payments/metrics/sessionized_metrics/avg_ticket_size.rs @@ -123,6 +123,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(|i| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/sessionized_metrics/connector_success_rate.rs b/crates/analytics/src/payments/metrics/sessionized_metrics/connector_success_rate.rs index d8ee7fcb473..626f11aa229 100644 --- a/crates/analytics/src/payments/metrics/sessionized_metrics/connector_success_rate.rs +++ b/crates/analytics/src/payments/metrics/sessionized_metrics/connector_success_rate.rs @@ -118,6 +118,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(|i| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/sessionized_metrics/failure_reasons.rs b/crates/analytics/src/payments/metrics/sessionized_metrics/failure_reasons.rs index d6944d8d0bd..f19185b345e 100644 --- a/crates/analytics/src/payments/metrics/sessionized_metrics/failure_reasons.rs +++ b/crates/analytics/src/payments/metrics/sessionized_metrics/failure_reasons.rs @@ -183,6 +183,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(|i| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/sessionized_metrics/payment_count.rs b/crates/analytics/src/payments/metrics/sessionized_metrics/payment_count.rs index 98735b9383a..79d57477e13 100644 --- a/crates/analytics/src/payments/metrics/sessionized_metrics/payment_count.rs +++ b/crates/analytics/src/payments/metrics/sessionized_metrics/payment_count.rs @@ -109,6 +109,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(|i| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/sessionized_metrics/payment_processed_amount.rs b/crates/analytics/src/payments/metrics/sessionized_metrics/payment_processed_amount.rs index 453f988d229..0a2ab1f8a23 100644 --- a/crates/analytics/src/payments/metrics/sessionized_metrics/payment_processed_amount.rs +++ b/crates/analytics/src/payments/metrics/sessionized_metrics/payment_processed_amount.rs @@ -140,6 +140,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(|i| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/sessionized_metrics/payment_success_count.rs b/crates/analytics/src/payments/metrics/sessionized_metrics/payment_success_count.rs index 14391588b48..e59402933aa 100644 --- a/crates/analytics/src/payments/metrics/sessionized_metrics/payment_success_count.rs +++ b/crates/analytics/src/payments/metrics/sessionized_metrics/payment_success_count.rs @@ -116,6 +116,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(|i| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/sessionized_metrics/payments_distribution.rs b/crates/analytics/src/payments/metrics/sessionized_metrics/payments_distribution.rs index 5c6a8c6adec..d7305cd0792 100644 --- a/crates/analytics/src/payments/metrics/sessionized_metrics/payments_distribution.rs +++ b/crates/analytics/src/payments/metrics/sessionized_metrics/payments_distribution.rs @@ -119,6 +119,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(|i| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/sessionized_metrics/retries_count.rs b/crates/analytics/src/payments/metrics/sessionized_metrics/retries_count.rs index 7d81c48274b..83307d75f7a 100644 --- a/crates/analytics/src/payments/metrics/sessionized_metrics/retries_count.rs +++ b/crates/analytics/src/payments/metrics/sessionized_metrics/retries_count.rs @@ -112,6 +112,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(|i| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/sessionized_metrics/success_rate.rs b/crates/analytics/src/payments/metrics/sessionized_metrics/success_rate.rs index f20308ed3b1..8159a615ba8 100644 --- a/crates/analytics/src/payments/metrics/sessionized_metrics/success_rate.rs +++ b/crates/analytics/src/payments/metrics/sessionized_metrics/success_rate.rs @@ -112,6 +112,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(|i| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/metrics/success_rate.rs b/crates/analytics/src/payments/metrics/success_rate.rs index 6698fe8ce65..032f3219a68 100644 --- a/crates/analytics/src/payments/metrics/success_rate.rs +++ b/crates/analytics/src/payments/metrics/success_rate.rs @@ -111,6 +111,7 @@ where i.card_last_4.clone(), i.card_issuer.clone(), i.error_reason.clone(), + i.routing_approach.as_ref().map(|i| i.0), TimeRange { start_time: match (granularity, i.start_bucket) { (Some(g), Some(st)) => g.clip_to_start(st)?, diff --git a/crates/analytics/src/payments/types.rs b/crates/analytics/src/payments/types.rs index b9af3cd0610..7bb23d7af78 100644 --- a/crates/analytics/src/payments/types.rs +++ b/crates/analytics/src/payments/types.rs @@ -109,6 +109,16 @@ where .add_filter_in_range_clause("first_attempt", &self.first_attempt) .attach_printable("Error adding first attempt filter")?; } + + if !self.routing_approach.is_empty() { + builder + .add_filter_in_range_clause( + PaymentDimensions::RoutingApproach, + &self.routing_approach, + ) + .attach_printable("Error adding routing approach filter")?; + } + Ok(()) } } diff --git a/crates/analytics/src/query.rs b/crates/analytics/src/query.rs index 5effd9e70a7..50d16c68e6f 100644 --- a/crates/analytics/src/query.rs +++ b/crates/analytics/src/query.rs @@ -15,7 +15,7 @@ use api_models::{ }, enums::{ AttemptStatus, AuthenticationType, Connector, Currency, DisputeStage, IntentStatus, - PaymentMethod, PaymentMethodType, + PaymentMethod, PaymentMethodType, RoutingApproach, }, refunds::RefundStatus, }; @@ -514,7 +514,8 @@ impl_to_sql_for_to_string!( &bool, &u64, u64, - Order + Order, + RoutingApproach ); impl_to_sql_for_to_string!( diff --git a/crates/analytics/src/sqlx.rs b/crates/analytics/src/sqlx.rs index 028a1ddc143..53b9cc10e10 100644 --- a/crates/analytics/src/sqlx.rs +++ b/crates/analytics/src/sqlx.rs @@ -13,7 +13,7 @@ use common_utils::{ }; use diesel_models::enums::{ AttemptStatus, AuthenticationType, Currency, FraudCheckStatus, IntentStatus, PaymentMethod, - RefundStatus, + RefundStatus, RoutingApproach, }; use error_stack::ResultExt; use sqlx::{ @@ -103,6 +103,7 @@ db_type!(AuthenticationStatus); db_type!(TransactionStatus); db_type!(AuthenticationConnectors); db_type!(DecoupledAuthenticationType); +db_type!(RoutingApproach); impl<'q, Type> Encode<'q, Postgres> for DBEnumWrapper<Type> where @@ -730,6 +731,11 @@ impl<'a> FromRow<'a, PgRow> for super::payments::metrics::PaymentMetricRow { ColumnNotFound(_) => Ok(Default::default()), e => Err(e), })?; + let routing_approach: Option<DBEnumWrapper<RoutingApproach>> = + row.try_get("routing_approach").or_else(|e| match e { + ColumnNotFound(_) => Ok(Default::default()), + e => Err(e), + })?; let total: Option<bigdecimal::BigDecimal> = row.try_get("total").or_else(|e| match e { ColumnNotFound(_) => Ok(Default::default()), e => Err(e), @@ -761,6 +767,7 @@ impl<'a> FromRow<'a, PgRow> for super::payments::metrics::PaymentMetricRow { card_issuer, error_reason, first_attempt, + routing_approach, total, count, start_bucket, @@ -833,6 +840,11 @@ impl<'a> FromRow<'a, PgRow> for super::payments::distribution::PaymentDistributi ColumnNotFound(_) => Ok(Default::default()), e => Err(e), })?; + let routing_approach: Option<DBEnumWrapper<RoutingApproach>> = + row.try_get("routing_approach").or_else(|e| match e { + ColumnNotFound(_) => Ok(Default::default()), + e => Err(e), + })?; let total: Option<bigdecimal::BigDecimal> = row.try_get("total").or_else(|e| match e { ColumnNotFound(_) => Ok(Default::default()), e => Err(e), @@ -875,6 +887,7 @@ impl<'a> FromRow<'a, PgRow> for super::payments::distribution::PaymentDistributi total, count, error_message, + routing_approach, start_bucket, end_bucket, }) @@ -949,6 +962,11 @@ impl<'a> FromRow<'a, PgRow> for super::payments::filters::PaymentFilterRow { ColumnNotFound(_) => Ok(Default::default()), e => Err(e), })?; + let routing_approach: Option<DBEnumWrapper<RoutingApproach>> = + row.try_get("routing_approach").or_else(|e| match e { + ColumnNotFound(_) => Ok(Default::default()), + e => Err(e), + })?; Ok(Self { currency, status, @@ -965,6 +983,7 @@ impl<'a> FromRow<'a, PgRow> for super::payments::filters::PaymentFilterRow { card_issuer, error_reason, first_attempt, + routing_approach, }) } } diff --git a/crates/analytics/src/types.rs b/crates/analytics/src/types.rs index 28ff2cec8bd..4f9a7655ede 100644 --- a/crates/analytics/src/types.rs +++ b/crates/analytics/src/types.rs @@ -21,6 +21,7 @@ pub enum AnalyticsDomain { SdkEvents, ApiEvents, Dispute, + Routing, } #[derive(Debug, strum::AsRefStr, strum::Display, Clone, Copy)] diff --git a/crates/analytics/src/utils.rs b/crates/analytics/src/utils.rs index 06cc998f3da..36121e56ebb 100644 --- a/crates/analytics/src/utils.rs +++ b/crates/analytics/src/utils.rs @@ -24,6 +24,7 @@ pub fn get_payment_dimensions() -> Vec<NameDescription> { PaymentDimensions::ProfileId, PaymentDimensions::CardNetwork, PaymentDimensions::MerchantId, + PaymentDimensions::RoutingApproach, ] .into_iter() .map(Into::into) diff --git a/crates/api_models/src/analytics/payments.rs b/crates/api_models/src/analytics/payments.rs index 691e827043f..537d6df09d1 100644 --- a/crates/api_models/src/analytics/payments.rs +++ b/crates/api_models/src/analytics/payments.rs @@ -8,7 +8,7 @@ use common_utils::id_type; use super::{ForexMetric, NameDescription, TimeRange}; use crate::enums::{ AttemptStatus, AuthenticationType, CardNetwork, Connector, Currency, PaymentMethod, - PaymentMethodType, + PaymentMethodType, RoutingApproach, }; #[derive(Clone, Debug, Default, serde::Deserialize, serde::Serialize)] @@ -43,6 +43,8 @@ pub struct PaymentFilters { pub error_reason: Vec<String>, #[serde(default)] pub first_attempt: Vec<bool>, + #[serde(default)] + pub routing_approach: Vec<RoutingApproach>, } #[derive( @@ -84,6 +86,7 @@ pub enum PaymentDimensions { CardLast4, CardIssuer, ErrorReason, + RoutingApproach, } #[derive( @@ -200,6 +203,7 @@ pub struct PaymentMetricsBucketIdentifier { pub card_last_4: Option<String>, pub card_issuer: Option<String>, pub error_reason: Option<String>, + pub routing_approach: Option<RoutingApproach>, #[serde(rename = "time_range")] pub time_bucket: TimeRange, // Coz FE sucks @@ -225,6 +229,7 @@ impl PaymentMetricsBucketIdentifier { card_last_4: Option<String>, card_issuer: Option<String>, error_reason: Option<String>, + routing_approach: Option<RoutingApproach>, normalized_time_range: TimeRange, ) -> Self { Self { @@ -242,6 +247,7 @@ impl PaymentMetricsBucketIdentifier { card_last_4, card_issuer, error_reason, + routing_approach, time_bucket: normalized_time_range, start_time: normalized_time_range.start_time, } @@ -264,6 +270,7 @@ impl Hash for PaymentMetricsBucketIdentifier { self.card_last_4.hash(state); self.card_issuer.hash(state); self.error_reason.hash(state); + self.routing_approach.map(|i| i.to_string()).hash(state); self.time_bucket.hash(state); } } diff --git a/crates/common_enums/src/enums.rs b/crates/common_enums/src/enums.rs index 641dc83291c..d7f4a1b2a20 100644 --- a/crates/common_enums/src/enums.rs +++ b/crates/common_enums/src/enums.rs @@ -29,7 +29,7 @@ pub mod diesel_exports { DbPaymentType as PaymentType, DbProcessTrackerStatus as ProcessTrackerStatus, DbRefundStatus as RefundStatus, DbRequestIncrementalAuthorization as RequestIncrementalAuthorization, - DbScaExemptionType as ScaExemptionType, + DbRoutingApproach as RoutingApproach, DbScaExemptionType as ScaExemptionType, DbSuccessBasedRoutingConclusiveState as SuccessBasedRoutingConclusiveState, DbTokenizationFlag as TokenizationFlag, DbWebhookDeliveryAttempt as WebhookDeliveryAttempt, }; @@ -8494,3 +8494,44 @@ pub enum TokenDataType { /// Fetch network token for the given payment method NetworkToken, } + +#[derive( + Clone, + Copy, + Debug, + Default, + Eq, + Hash, + PartialEq, + serde::Deserialize, + serde::Serialize, + strum::Display, + strum::VariantNames, + strum::EnumIter, + strum::EnumString, + ToSchema, +)] +#[router_derive::diesel_enum(storage_type = "db_enum")] +#[serde(rename_all = "snake_case")] +#[strum(serialize_all = "snake_case")] +pub enum RoutingApproach { + SuccessRateExploitation, + SuccessRateExploration, + ContractBasedRouting, + DebitRouting, + RuleBasedRouting, + VolumeBasedRouting, + #[default] + DefaultFallback, +} + +impl RoutingApproach { + pub fn from_decision_engine_approach(approach: &str) -> Self { + match approach { + "SR_SELECTION_V3_ROUTING" => Self::SuccessRateExploitation, + "SR_V3_HEDGING" => Self::SuccessRateExploration, + "NTW_BASED_ROUTING" => Self::DebitRouting, + _ => Self::DefaultFallback, + } + } +} diff --git a/crates/diesel_models/src/enums.rs b/crates/diesel_models/src/enums.rs index fc9417342e1..f7c84368b42 100644 --- a/crates/diesel_models/src/enums.rs +++ b/crates/diesel_models/src/enums.rs @@ -21,7 +21,8 @@ pub mod diesel_exports { DbRelayType as RelayType, DbRequestIncrementalAuthorization as RequestIncrementalAuthorization, DbRevenueRecoveryAlgorithmType as RevenueRecoveryAlgorithmType, DbRoleScope as RoleScope, - DbRoutingAlgorithmKind as RoutingAlgorithmKind, DbScaExemptionType as ScaExemptionType, + DbRoutingAlgorithmKind as RoutingAlgorithmKind, DbRoutingApproach as RoutingApproach, + DbScaExemptionType as ScaExemptionType, DbSuccessBasedRoutingConclusiveState as SuccessBasedRoutingConclusiveState, DbTokenizationFlag as TokenizationFlag, DbTotpStatus as TotpStatus, DbTransactionType as TransactionType, DbUserRoleVersion as UserRoleVersion, diff --git a/crates/diesel_models/src/payment_attempt.rs b/crates/diesel_models/src/payment_attempt.rs index 473502ad746..d438b093513 100644 --- a/crates/diesel_models/src/payment_attempt.rs +++ b/crates/diesel_models/src/payment_attempt.rs @@ -203,6 +203,7 @@ pub struct PaymentAttempt { pub processor_merchant_id: Option<id_type::MerchantId>, pub created_by: Option<String>, pub setup_future_usage_applied: Option<storage_enums::FutureUsage>, + pub routing_approach: Option<storage_enums::RoutingApproach>, } #[cfg(feature = "v1")] @@ -422,6 +423,7 @@ pub struct PaymentAttemptNew { pub processor_merchant_id: Option<id_type::MerchantId>, pub created_by: Option<String>, pub setup_future_usage_applied: Option<storage_enums::FutureUsage>, + pub routing_approach: Option<storage_enums::RoutingApproach>, } #[cfg(feature = "v1")] @@ -495,6 +497,7 @@ pub enum PaymentAttemptUpdate { order_tax_amount: Option<MinorUnit>, connector_mandate_detail: Option<ConnectorMandateReferenceId>, card_discovery: Option<storage_enums::CardDiscovery>, + routing_approach: Option<storage_enums::RoutingApproach>, }, VoidUpdate { status: storage_enums::AttemptStatus, @@ -937,6 +940,7 @@ pub struct PaymentAttemptUpdateInternal { pub issuer_error_code: Option<String>, pub issuer_error_message: Option<String>, pub setup_future_usage_applied: Option<storage_enums::FutureUsage>, + pub routing_approach: Option<storage_enums::RoutingApproach>, } #[cfg(feature = "v1")] @@ -1126,6 +1130,7 @@ impl PaymentAttemptUpdate { issuer_error_code, issuer_error_message, setup_future_usage_applied, + routing_approach, } = PaymentAttemptUpdateInternal::from(self).populate_derived_fields(&source); PaymentAttempt { amount: amount.unwrap_or(source.amount), @@ -1192,6 +1197,7 @@ impl PaymentAttemptUpdate { issuer_error_message: issuer_error_message.or(source.issuer_error_message), setup_future_usage_applied: setup_future_usage_applied .or(source.setup_future_usage_applied), + routing_approach: routing_approach.or(source.routing_approach), ..source } } @@ -2250,6 +2256,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::AuthenticationTypeUpdate { authentication_type, @@ -2312,6 +2319,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::ConfirmUpdate { amount, @@ -2348,6 +2356,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { order_tax_amount, connector_mandate_detail, card_discovery, + routing_approach, } => Self { amount: Some(amount), currency: Some(currency), @@ -2406,6 +2415,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach, }, PaymentAttemptUpdate::VoidUpdate { status, @@ -2469,6 +2479,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::RejectUpdate { status, @@ -2533,6 +2544,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::BlocklistUpdate { status, @@ -2597,6 +2609,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::ConnectorMandateDetailUpdate { connector_mandate_detail, @@ -2659,6 +2672,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::PaymentMethodDetailsUpdate { payment_method_id, @@ -2721,6 +2735,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::ResponseUpdate { status, @@ -2811,6 +2826,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied, + routing_approach: None, } } PaymentAttemptUpdate::ErrorUpdate { @@ -2892,6 +2908,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { card_discovery: None, charges: None, setup_future_usage_applied: None, + routing_approach: None, } } PaymentAttemptUpdate::StatusUpdate { status, updated_by } => Self { @@ -2952,6 +2969,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::UpdateTrackers { payment_token, @@ -3020,6 +3038,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::UnresolvedResponseUpdate { status, @@ -3095,6 +3114,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, } } PaymentAttemptUpdate::PreprocessingUpdate { @@ -3169,6 +3189,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, } } PaymentAttemptUpdate::CaptureUpdate { @@ -3233,6 +3254,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::AmountToCaptureUpdate { status, @@ -3296,6 +3318,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::ConnectorResponse { authentication_data, @@ -3368,6 +3391,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, } } PaymentAttemptUpdate::IncrementalAuthorizationAmountUpdate { @@ -3431,6 +3455,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::AuthenticationUpdate { status, @@ -3496,6 +3521,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, PaymentAttemptUpdate::ManualUpdate { status, @@ -3570,6 +3596,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, } } PaymentAttemptUpdate::PostSessionTokensUpdate { @@ -3633,6 +3660,7 @@ impl From<PaymentAttemptUpdate> for PaymentAttemptUpdateInternal { issuer_error_code: None, issuer_error_message: None, setup_future_usage_applied: None, + routing_approach: None, }, } } diff --git a/crates/diesel_models/src/schema.rs b/crates/diesel_models/src/schema.rs index 522ad271be9..cb690e3f602 100644 --- a/crates/diesel_models/src/schema.rs +++ b/crates/diesel_models/src/schema.rs @@ -950,6 +950,7 @@ diesel::table! { #[max_length = 255] created_by -> Nullable<Varchar>, setup_future_usage_applied -> Nullable<FutureUsage>, + routing_approach -> Nullable<RoutingApproach>, } } diff --git a/crates/diesel_models/src/user/sample_data.rs b/crates/diesel_models/src/user/sample_data.rs index 3e445bb5020..2a21bb7c404 100644 --- a/crates/diesel_models/src/user/sample_data.rs +++ b/crates/diesel_models/src/user/sample_data.rs @@ -216,6 +216,7 @@ pub struct PaymentAttemptBatchNew { pub processor_merchant_id: Option<common_utils::id_type::MerchantId>, pub created_by: Option<String>, pub setup_future_usage_applied: Option<common_enums::FutureUsage>, + pub routing_approach: Option<common_enums::RoutingApproach>, } #[cfg(feature = "v1")] @@ -301,6 +302,7 @@ impl PaymentAttemptBatchNew { processor_merchant_id: self.processor_merchant_id, created_by: self.created_by, setup_future_usage_applied: self.setup_future_usage_applied, + routing_approach: self.routing_approach, } } } diff --git a/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs b/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs index c35fbc3163e..6369c2168fe 100644 --- a/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs +++ b/crates/hyperswitch_domain_models/src/payments/payment_attempt.rs @@ -902,6 +902,7 @@ pub struct PaymentAttempt { /// merchantwho invoked the resource based api (identifier) and through what source (Api, Jwt(Dashboard)) pub created_by: Option<CreatedBy>, pub setup_future_usage_applied: Option<storage_enums::FutureUsage>, + pub routing_approach: Option<storage_enums::RoutingApproach>, } #[cfg(feature = "v1")] @@ -1156,6 +1157,7 @@ pub struct PaymentAttemptNew { /// merchantwho invoked the resource based api (identifier) and through what source (Api, Jwt(Dashboard)) pub created_by: Option<CreatedBy>, pub setup_future_usage_applied: Option<storage_enums::FutureUsage>, + pub routing_approach: Option<storage_enums::RoutingApproach>, } #[cfg(feature = "v1")] @@ -1223,6 +1225,7 @@ pub enum PaymentAttemptUpdate { customer_acceptance: Option<pii::SecretSerdeValue>, connector_mandate_detail: Option<ConnectorMandateReferenceId>, card_discovery: Option<common_enums::CardDiscovery>, + routing_approach: Option<storage_enums::RoutingApproach>, // where all to add this one }, RejectUpdate { status: storage_enums::AttemptStatus, @@ -1481,6 +1484,7 @@ impl PaymentAttemptUpdate { customer_acceptance, connector_mandate_detail, card_discovery, + routing_approach, } => DieselPaymentAttemptUpdate::ConfirmUpdate { amount: net_amount.get_order_amount(), currency, @@ -1516,6 +1520,7 @@ impl PaymentAttemptUpdate { order_tax_amount: net_amount.get_order_tax_amount(), connector_mandate_detail, card_discovery, + routing_approach, }, Self::VoidUpdate { status, @@ -1917,6 +1922,7 @@ impl behaviour::Conversion for PaymentAttempt { connector_transaction_data: None, processor_merchant_id: Some(self.processor_merchant_id), created_by: self.created_by.map(|cb| cb.to_string()), + routing_approach: self.routing_approach, }) } @@ -2012,6 +2018,7 @@ impl behaviour::Conversion for PaymentAttempt { .created_by .and_then(|created_by| created_by.parse::<CreatedBy>().ok()), setup_future_usage_applied: storage_model.setup_future_usage_applied, + routing_approach: storage_model.routing_approach, }) } .await @@ -2100,6 +2107,7 @@ impl behaviour::Conversion for PaymentAttempt { processor_merchant_id: Some(self.processor_merchant_id), created_by: self.created_by.map(|cb| cb.to_string()), setup_future_usage_applied: self.setup_future_usage_applied, + routing_approach: self.routing_approach, }) } } diff --git a/crates/router/src/analytics.rs b/crates/router/src/analytics.rs index ffac49e7a8e..e40bce12339 100644 --- a/crates/router/src/analytics.rs +++ b/crates/router/src/analytics.rs @@ -62,6 +62,10 @@ pub mod routes { web::resource("metrics/payments") .route(web::post().to(get_merchant_payment_metrics)), ) + .service( + web::resource("metrics/routing") + .route(web::post().to(get_merchant_payment_metrics)), + ) .service( web::resource("metrics/refunds") .route(web::post().to(get_merchant_refund_metrics)), @@ -70,6 +74,10 @@ pub mod routes { web::resource("filters/payments") .route(web::post().to(get_merchant_payment_filters)), ) + .service( + web::resource("filters/routing") + .route(web::post().to(get_merchant_payment_filters)), + ) .service( web::resource("filters/frm").route(web::post().to(get_frm_filters)), ) @@ -175,6 +183,10 @@ pub mod routes { web::resource("metrics/payments") .route(web::post().to(get_merchant_payment_metrics)), ) + .service( + web::resource("metrics/routing") + .route(web::post().to(get_merchant_payment_metrics)), + ) .service( web::resource("metrics/refunds") .route(web::post().to(get_merchant_refund_metrics)), @@ -183,6 +195,10 @@ pub mod routes { web::resource("filters/payments") .route(web::post().to(get_merchant_payment_filters)), ) + .service( + web::resource("filters/routing") + .route(web::post().to(get_merchant_payment_filters)), + ) .service( web::resource("filters/refunds") .route(web::post().to(get_merchant_refund_filters)), @@ -241,6 +257,14 @@ pub mod routes { web::resource("filters/payments") .route(web::post().to(get_org_payment_filters)), ) + .service( + web::resource("metrics/routing") + .route(web::post().to(get_org_payment_metrics)), + ) + .service( + web::resource("filters/routing") + .route(web::post().to(get_org_payment_filters)), + ) .service( web::resource("metrics/refunds") .route(web::post().to(get_org_refund_metrics)), @@ -291,6 +315,14 @@ pub mod routes { web::resource("filters/payments") .route(web::post().to(get_profile_payment_filters)), ) + .service( + web::resource("metrics/routing") + .route(web::post().to(get_profile_payment_metrics)), + ) + .service( + web::resource("filters/routing") + .route(web::post().to(get_profile_payment_filters)), + ) .service( web::resource("metrics/refunds") .route(web::post().to(get_profile_refund_metrics)), diff --git a/crates/router/src/core/debit_routing.rs b/crates/router/src/core/debit_routing.rs index ca03f5d2532..4975ffc4bd1 100644 --- a/crates/router/src/core/debit_routing.rs +++ b/crates/router/src/core/debit_routing.rs @@ -306,15 +306,14 @@ where } pub async fn get_debit_routing_output< - F: Clone, - D: OperationSessionGetters<F> + OperationSessionSetters<F>, + F: Clone + Send, + D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, >( state: &SessionState, payment_data: &mut D, acquirer_country: enums::CountryAlpha2, ) -> Option<open_router::DebitRoutingOutput> { logger::debug!("Fetching sorted card networks"); - let payment_attempt = payment_data.get_payment_attempt(); let (saved_co_badged_card_data, saved_card_type, card_isin) = extract_saved_card_info(payment_data); @@ -355,9 +354,9 @@ pub async fn get_debit_routing_output< routing::perform_open_routing_for_debit_routing( state, - payment_attempt, co_badged_card_request, card_isin, + payment_data, ) .await .map_err(|error| { diff --git a/crates/router/src/core/payments.rs b/crates/router/src/core/payments.rs index 59de54f41fa..f361be5a76c 100644 --- a/crates/router/src/core/payments.rs +++ b/crates/router/src/core/payments.rs @@ -7996,7 +7996,7 @@ pub async fn route_connector_v2_for_payments( .as_ref() .or(business_profile.routing_algorithm_id.as_ref()); - let connectors = routing::perform_static_routing_v1( + let (connectors, _) = routing::perform_static_routing_v1( state, merchant_context.get_merchant_account().get_id(), routing_algorithm_id, @@ -8063,7 +8063,7 @@ where algorithm_ref.algorithm_id }; - let connectors = routing::perform_static_routing_v1( + let (connectors, routing_approach) = routing::perform_static_routing_v1( state, merchant_context.get_merchant_account().get_id(), routing_algorithm_id.as_ref(), @@ -8073,6 +8073,8 @@ where .await .change_context(errors::ApiErrorResponse::InternalServerError)?; + payment_data.set_routing_approach_in_attempt(routing_approach); + #[cfg(all(feature = "v1", feature = "dynamic_routing"))] let payment_attempt = transaction_data.payment_attempt.clone(); @@ -8121,6 +8123,7 @@ where connectors.clone(), business_profile, payment_attempt, + payment_data, ) .await .map_err(|e| logger::error!(open_routing_error=?e)) @@ -8163,7 +8166,7 @@ where connectors.clone(), business_profile, dynamic_routing_config_params_interpolator, - payment_data.get_payment_attempt(), + payment_data, ) .await .map_err(|e| logger::error!(dynamic_routing_error=?e)) @@ -8240,7 +8243,7 @@ pub async fn route_connector_v1_for_payouts( algorithm_ref.algorithm_id }; - let connectors = routing::perform_static_routing_v1( + let (connectors, _) = routing::perform_static_routing_v1( state, merchant_context.get_merchant_account().get_id(), routing_algorithm_id.as_ref(), @@ -8965,6 +8968,7 @@ pub trait OperationSessionSetters<F> { &mut self, external_vault_session_details: Option<api::VaultSessionDetails>, ); + fn set_routing_approach_in_attempt(&mut self, routing_approach: Option<enums::RoutingApproach>); } #[cfg(feature = "v1")] @@ -9264,6 +9268,13 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentData<F> { fn set_vault_operation(&mut self, vault_operation: domain_payments::VaultOperation) { self.vault_operation = Some(vault_operation); } + + fn set_routing_approach_in_attempt( + &mut self, + routing_approach: Option<enums::RoutingApproach>, + ) { + self.payment_attempt.routing_approach = routing_approach; + } } #[cfg(feature = "v2")] @@ -9550,6 +9561,13 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentIntentData<F> { ) { self.vault_session_details = vault_session_details; } + + fn set_routing_approach_in_attempt( + &mut self, + routing_approach: Option<enums::RoutingApproach>, + ) { + todo!() + } } #[cfg(feature = "v2")] @@ -9839,6 +9857,13 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentConfirmData<F> { ) { todo!() } + + fn set_routing_approach_in_attempt( + &mut self, + routing_approach: Option<enums::RoutingApproach>, + ) { + todo!() + } } #[cfg(feature = "v2")] @@ -10124,6 +10149,12 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentStatusData<F> { ) { todo!() } + fn set_routing_approach_in_attempt( + &mut self, + routing_approach: Option<enums::RoutingApproach>, + ) { + todo!() + } } #[cfg(feature = "v2")] @@ -10410,6 +10441,13 @@ impl<F: Clone> OperationSessionSetters<F> for PaymentCaptureData<F> { ) { todo!() } + + fn set_routing_approach_in_attempt( + &mut self, + routing_approach: Option<enums::RoutingApproach>, + ) { + todo!() + } } #[cfg(feature = "v2")] diff --git a/crates/router/src/core/payments/helpers.rs b/crates/router/src/core/payments/helpers.rs index 9f6e317531a..a34a169d38a 100644 --- a/crates/router/src/core/payments/helpers.rs +++ b/crates/router/src/core/payments/helpers.rs @@ -4399,6 +4399,7 @@ impl AttemptType { processor_merchant_id: old_payment_attempt.processor_merchant_id, created_by: old_payment_attempt.created_by, setup_future_usage_applied: None, + routing_approach: old_payment_attempt.routing_approach, } } diff --git a/crates/router/src/core/payments/operations/payment_confirm.rs b/crates/router/src/core/payments/operations/payment_confirm.rs index 944f2852b18..866449c74dd 100644 --- a/crates/router/src/core/payments/operations/payment_confirm.rs +++ b/crates/router/src/core/payments/operations/payment_confirm.rs @@ -1794,6 +1794,7 @@ impl<F: Clone + Sync> UpdateTracker<F, PaymentData<F>, api::PaymentsRequest> for .payment_attempt .connector_mandate_detail, card_discovery, + routing_approach: payment_data.payment_attempt.routing_approach, }, storage_scheme, ) diff --git a/crates/router/src/core/payments/operations/payment_create.rs b/crates/router/src/core/payments/operations/payment_create.rs index 68f1b9d9c15..43e9c39c566 100644 --- a/crates/router/src/core/payments/operations/payment_create.rs +++ b/crates/router/src/core/payments/operations/payment_create.rs @@ -1362,6 +1362,7 @@ impl PaymentCreate { processor_merchant_id: merchant_id.to_owned(), created_by: None, setup_future_usage_applied: request.setup_future_usage, + routing_approach: Some(common_enums::RoutingApproach::default()) }, additional_pm_data, diff --git a/crates/router/src/core/payments/retry.rs b/crates/router/src/core/payments/retry.rs index a4d1cc51518..1cc886be828 100644 --- a/crates/router/src/core/payments/retry.rs +++ b/crates/router/src/core/payments/retry.rs @@ -702,6 +702,7 @@ pub fn make_new_payment_attempt( processor_merchant_id: old_payment_attempt.processor_merchant_id, created_by: old_payment_attempt.created_by, setup_future_usage_applied: setup_future_usage_intent, // setup future usage is picked from intent for new payment attempt + routing_approach: old_payment_attempt.routing_approach, } } diff --git a/crates/router/src/core/payments/routing.rs b/crates/router/src/core/payments/routing.rs index 2ab004cccd1..ef7d1d46f53 100644 --- a/crates/router/src/core/payments/routing.rs +++ b/crates/router/src/core/payments/routing.rs @@ -59,7 +59,12 @@ use crate::core::routing::transformers::OpenRouterDecideGatewayRequestExt; use crate::routes::app::SessionStateInfo; use crate::{ core::{ - errors, errors as oss_errors, payments::routing::utils::DecisionEngineApiHandler, routing, + errors, errors as oss_errors, + payments::{ + routing::utils::DecisionEngineApiHandler, OperationSessionGetters, + OperationSessionSetters, + }, + routing, }, logger, services, types::{ @@ -432,7 +437,10 @@ pub async fn perform_static_routing_v1( algorithm_id: Option<&common_utils::id_type::RoutingId>, business_profile: &domain::Profile, transaction_data: &routing::TransactionData<'_>, -) -> RoutingResult<Vec<routing_types::RoutableConnectorChoice>> { +) -> RoutingResult<( + Vec<routing_types::RoutableConnectorChoice>, + Option<common_enums::RoutingApproach>, +)> { let algorithm_id = if let Some(id) = algorithm_id { id } else { @@ -449,7 +457,7 @@ pub async fn perform_static_routing_v1( .get_default_fallback_list_of_connector_under_profile() .change_context(errors::RoutingError::FallbackConfigFetchFailed)?; - return Ok(fallback_config); + return Ok((fallback_config, None)); }; let cached_algorithm = ensure_algorithm_cached_v1( state, @@ -503,14 +511,18 @@ pub async fn perform_static_routing_v1( logger::error!(decision_engine_euclid_evaluate_error=?e, "decision_engine_euclid: error in evaluation of rule") ).unwrap_or_default(); - let routable_connectors = match cached_algorithm.as_ref() { - CachedAlgorithm::Single(conn) => vec![(**conn).clone()], - CachedAlgorithm::Priority(plist) => plist.clone(), - CachedAlgorithm::VolumeSplit(splits) => perform_volume_split(splits.to_vec()) - .change_context(errors::RoutingError::ConnectorSelectionFailed)?, - CachedAlgorithm::Advanced(interpreter) => { - execute_dsl_and_get_connector_v1(backend_input, interpreter)? - } + let (routable_connectors, routing_approach) = match cached_algorithm.as_ref() { + CachedAlgorithm::Single(conn) => (vec![(**conn).clone()], None), + CachedAlgorithm::Priority(plist) => (plist.clone(), None), + CachedAlgorithm::VolumeSplit(splits) => ( + perform_volume_split(splits.to_vec()) + .change_context(errors::RoutingError::ConnectorSelectionFailed)?, + Some(common_enums::RoutingApproach::VolumeBasedRouting), + ), + CachedAlgorithm::Advanced(interpreter) => ( + execute_dsl_and_get_connector_v1(backend_input, interpreter)?, + Some(common_enums::RoutingApproach::RuleBasedRouting), + ), }; utils::compare_and_log_result( @@ -519,13 +531,16 @@ pub async fn perform_static_routing_v1( "evaluate_routing".to_string(), ); - Ok(utils::select_routing_result( - state, - business_profile, - routable_connectors, - de_euclid_connectors, - ) - .await) + Ok(( + utils::select_routing_result( + state, + business_profile, + routable_connectors, + de_euclid_connectors, + ) + .await, + routing_approach, + )) } async fn ensure_algorithm_cached_v1( @@ -1573,12 +1588,17 @@ pub fn make_dsl_input_for_surcharge( } #[cfg(all(feature = "v1", feature = "dynamic_routing"))] -pub async fn perform_dynamic_routing_with_open_router( +pub async fn perform_dynamic_routing_with_open_router<F, D>( state: &SessionState, routable_connectors: Vec<api_routing::RoutableConnectorChoice>, profile: &domain::Profile, payment_data: oss_storage::PaymentAttempt, -) -> RoutingResult<Vec<api_routing::RoutableConnectorChoice>> { + old_payment_data: &mut D, +) -> RoutingResult<Vec<api_routing::RoutableConnectorChoice>> +where + F: Send + Clone, + D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, +{ let dynamic_routing_algo_ref: api_routing::DynamicRoutingAlgorithmRef = profile .dynamic_routing_algorithm .clone() @@ -1610,6 +1630,7 @@ pub async fn perform_dynamic_routing_with_open_router( profile.get_id(), &payment_data, is_elimination_enabled, + old_payment_data, ) .await?; @@ -1642,12 +1663,18 @@ pub async fn perform_dynamic_routing_with_open_router( } #[cfg(feature = "v1")] -pub async fn perform_open_routing_for_debit_routing( +pub async fn perform_open_routing_for_debit_routing<F, D>( state: &SessionState, - payment_attempt: &oss_storage::PaymentAttempt, co_badged_card_request: or_types::CoBadgedCardRequest, card_isin: Option<Secret<String>>, -) -> RoutingResult<or_types::DebitRoutingOutput> { + old_payment_data: &mut D, +) -> RoutingResult<or_types::DebitRoutingOutput> +where + F: Send + Clone, + D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, +{ + let payment_attempt = old_payment_data.get_payment_attempt().clone(); + logger::debug!( "performing debit routing with open_router for profile {}", payment_attempt.profile_id.get_string_repr() @@ -1661,7 +1688,7 @@ pub async fn perform_open_routing_for_debit_routing( ); let open_router_req_body = OpenRouterDecideGatewayRequest::construct_debit_request( - payment_attempt, + &payment_attempt, metadata, card_isin, Some(or_types::RankingAlgorithm::NtwBasedRouting), @@ -1692,11 +1719,14 @@ pub async fn perform_open_routing_for_debit_routing( let output = match response { Ok(events_response) => { - let debit_routing_output = events_response - .response - .ok_or(errors::RoutingError::OpenRouterError( - "Response from decision engine API is empty".to_string(), - ))? + let response = + events_response + .response + .ok_or(errors::RoutingError::OpenRouterError( + "Response from decision engine API is empty".to_string(), + ))?; + + let debit_routing_output = response .debit_routing_output .get_required_value("debit_routing_output") .change_context(errors::RoutingError::OpenRouterError( @@ -1704,6 +1734,12 @@ pub async fn perform_open_routing_for_debit_routing( )) .attach_printable("debit_routing_output is missing in the open routing response")?; + old_payment_data.set_routing_approach_in_attempt(Some( + common_enums::RoutingApproach::from_decision_engine_approach( + &response.routing_approach, + ), + )); + Ok(debit_routing_output) } Err(error_response) => { @@ -1718,13 +1754,17 @@ pub async fn perform_open_routing_for_debit_routing( } #[cfg(all(feature = "v1", feature = "dynamic_routing"))] -pub async fn perform_dynamic_routing_with_intelligent_router( +pub async fn perform_dynamic_routing_with_intelligent_router<F, D>( state: &SessionState, routable_connectors: Vec<api_routing::RoutableConnectorChoice>, profile: &domain::Profile, dynamic_routing_config_params_interpolator: routing::helpers::DynamicRoutingConfigParamsInterpolator, - payment_attempt: &oss_storage::PaymentAttempt, -) -> RoutingResult<Vec<api_routing::RoutableConnectorChoice>> { + payment_data: &mut D, +) -> RoutingResult<Vec<api_routing::RoutableConnectorChoice>> +where + F: Send + Clone, + D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, +{ let dynamic_routing_algo_ref: api_routing::DynamicRoutingAlgorithmRef = profile .dynamic_routing_algorithm .clone() @@ -1744,6 +1784,8 @@ pub async fn perform_dynamic_routing_with_intelligent_router( profile.get_id().get_string_repr() ); + let payment_attempt = payment_data.get_payment_attempt().clone(); + let mut connector_list = match dynamic_routing_algo_ref .success_based_algorithm .as_ref() @@ -1756,6 +1798,7 @@ pub async fn perform_dynamic_routing_with_intelligent_router( &payment_attempt.payment_id, dynamic_routing_config_params_interpolator.clone(), algorithm.clone(), + payment_data, ) }) .await @@ -1779,6 +1822,7 @@ pub async fn perform_dynamic_routing_with_intelligent_router( &payment_attempt.payment_id, dynamic_routing_config_params_interpolator.clone(), algorithm.clone(), + payment_data, ) }) .await @@ -1816,13 +1860,18 @@ pub async fn perform_dynamic_routing_with_intelligent_router( #[cfg(all(feature = "v1", feature = "dynamic_routing"))] #[instrument(skip_all)] -pub async fn perform_decide_gateway_call_with_open_router( +pub async fn perform_decide_gateway_call_with_open_router<F, D>( state: &SessionState, mut routable_connectors: Vec<api_routing::RoutableConnectorChoice>, profile_id: &common_utils::id_type::ProfileId, payment_attempt: &oss_storage::PaymentAttempt, is_elimination_enabled: bool, -) -> RoutingResult<Vec<api_routing::RoutableConnectorChoice>> { + old_payment_data: &mut D, +) -> RoutingResult<Vec<api_routing::RoutableConnectorChoice>> +where + F: Send + Clone, + D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, +{ logger::debug!( "performing decide_gateway call with open_router for profile {}", profile_id.get_string_repr() @@ -1879,6 +1928,12 @@ pub async fn perform_decide_gateway_call_with_open_router( .to_string(), ); + old_payment_data.set_routing_approach_in_attempt(Some( + common_enums::RoutingApproach::from_decision_engine_approach( + &decided_gateway.routing_approach, + ), + )); + if let Some(gateway_priority_map) = decided_gateway.gateway_priority_map { logger::debug!(gateway_priority_map=?gateway_priority_map, routing_approach=decided_gateway.routing_approach, "open_router decide_gateway call response"); routable_connectors.sort_by(|connector_choice_a, connector_choice_b| { @@ -1992,7 +2047,8 @@ pub async fn update_gateway_score_with_open_router( /// success based dynamic routing #[cfg(all(feature = "v1", feature = "dynamic_routing"))] #[instrument(skip_all)] -pub async fn perform_success_based_routing( +#[allow(clippy::too_many_arguments)] +pub async fn perform_success_based_routing<F, D>( state: &SessionState, routable_connectors: Vec<api_routing::RoutableConnectorChoice>, profile_id: &common_utils::id_type::ProfileId, @@ -2000,7 +2056,12 @@ pub async fn perform_success_based_routing( payment_id: &common_utils::id_type::PaymentId, success_based_routing_config_params_interpolator: routing::helpers::DynamicRoutingConfigParamsInterpolator, success_based_algo_ref: api_routing::SuccessBasedAlgorithm, -) -> RoutingResult<Vec<api_routing::RoutableConnectorChoice>> { + payment_data: &mut D, +) -> RoutingResult<Vec<api_routing::RoutableConnectorChoice>> +where + F: Send + Clone, + D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, +{ if success_based_algo_ref.enabled_feature == api_routing::DynamicRoutingFeatures::DynamicConnectorSelection { @@ -2131,6 +2192,9 @@ pub async fn perform_success_based_routing( })?; routing_event.set_routing_approach(success_based_connectors.routing_approach.to_string()); + payment_data.set_routing_approach_in_attempt(Some(common_enums::RoutingApproach::from( + success_based_connectors.routing_approach, + ))); let mut connectors = Vec::with_capacity(success_based_connectors.labels_with_score.len()); for label_with_score in success_based_connectors.labels_with_score { @@ -2367,7 +2431,8 @@ pub async fn perform_elimination_routing( } #[cfg(all(feature = "v1", feature = "dynamic_routing"))] -pub async fn perform_contract_based_routing( +#[allow(clippy::too_many_arguments)] +pub async fn perform_contract_based_routing<F, D>( state: &SessionState, routable_connectors: Vec<api_routing::RoutableConnectorChoice>, profile_id: &common_utils::id_type::ProfileId, @@ -2375,7 +2440,12 @@ pub async fn perform_contract_based_routing( payment_id: &common_utils::id_type::PaymentId, _dynamic_routing_config_params_interpolator: routing::helpers::DynamicRoutingConfigParamsInterpolator, contract_based_algo_ref: api_routing::ContractRoutingAlgorithm, -) -> RoutingResult<Vec<api_routing::RoutableConnectorChoice>> { + payment_data: &mut D, +) -> RoutingResult<Vec<api_routing::RoutableConnectorChoice>> +where + F: Send + Clone, + D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, +{ if contract_based_algo_ref.enabled_feature == api_routing::DynamicRoutingFeatures::DynamicConnectorSelection { @@ -2528,6 +2598,10 @@ pub async fn perform_contract_based_routing( status_code: 500, })?; + payment_data.set_routing_approach_in_attempt(Some( + common_enums::RoutingApproach::ContractBasedRouting, + )); + let mut connectors = Vec::with_capacity(contract_based_connectors.labels_with_score.len()); for label_with_score in contract_based_connectors.labels_with_score { @@ -2565,6 +2639,7 @@ pub async fn perform_contract_based_routing( routing_event.set_status_code(200); routing_event.set_routable_connectors(connectors.clone()); + routing_event.set_routing_approach(api_routing::RoutingApproach::ContractBased.to_string()); state.event_handler().log_event(&routing_event); Ok(connectors) } else { diff --git a/crates/router/src/core/payments/routing/utils.rs b/crates/router/src/core/payments/routing/utils.rs index 4296fea819f..0b74273419b 100644 --- a/crates/router/src/core/payments/routing/utils.rs +++ b/crates/router/src/core/payments/routing/utils.rs @@ -1522,6 +1522,18 @@ impl RoutingApproach { } } +impl From<RoutingApproach> for common_enums::RoutingApproach { + fn from(approach: RoutingApproach) -> Self { + match approach { + RoutingApproach::Exploitation => Self::SuccessRateExploitation, + RoutingApproach::Exploration => Self::SuccessRateExploration, + RoutingApproach::ContractBased => Self::ContractBasedRouting, + RoutingApproach::StaticRouting => Self::RuleBasedRouting, + _ => Self::DefaultFallback, + } + } +} + impl std::fmt::Display for RoutingApproach { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { match self { diff --git a/crates/router/src/core/routing/helpers.rs b/crates/router/src/core/routing/helpers.rs index e73c9c5bc75..6d263eece26 100644 --- a/crates/router/src/core/routing/helpers.rs +++ b/crates/router/src/core/routing/helpers.rs @@ -54,7 +54,10 @@ use crate::{ }; #[cfg(feature = "v1")] use crate::{ - core::payments::routing::utils::{self as routing_utils, DecisionEngineApiHandler}, + core::payments::{ + routing::utils::{self as routing_utils, DecisionEngineApiHandler}, + OperationSessionGetters, OperationSessionSetters, + }, services, }; #[cfg(all(feature = "dynamic_routing", feature = "v1"))] @@ -338,11 +341,7 @@ impl RoutingDecisionData { pub fn apply_routing_decision<F, D>(&self, payment_data: &mut D) where F: Send + Clone, - D: crate::core::payments::OperationSessionGetters<F> - + crate::core::payments::OperationSessionSetters<F> - + Send - + Sync - + Clone, + D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, { match self { Self::DebitRouting(data) => data.apply_debit_routing_decision(payment_data), @@ -364,11 +363,7 @@ impl DebitRoutingDecisionData { pub fn apply_debit_routing_decision<F, D>(&self, payment_data: &mut D) where F: Send + Clone, - D: crate::core::payments::OperationSessionGetters<F> - + crate::core::payments::OperationSessionSetters<F> - + Send - + Sync - + Clone, + D: OperationSessionGetters<F> + OperationSessionSetters<F> + Send + Sync + Clone, { payment_data.set_card_network(self.card_network.clone()); self.debit_routing_result diff --git a/crates/router/src/services/kafka/payment_attempt.rs b/crates/router/src/services/kafka/payment_attempt.rs index f2c18ae9302..68f1d013517 100644 --- a/crates/router/src/services/kafka/payment_attempt.rs +++ b/crates/router/src/services/kafka/payment_attempt.rs @@ -69,6 +69,7 @@ pub struct KafkaPaymentAttempt<'a> { pub organization_id: &'a id_type::OrganizationId, pub card_network: Option<String>, pub card_discovery: Option<String>, + pub routing_approach: Option<storage_enums::RoutingApproach>, } #[cfg(feature = "v1")] @@ -130,6 +131,7 @@ impl<'a> KafkaPaymentAttempt<'a> { card_discovery: attempt .card_discovery .map(|discovery| discovery.to_string()), + routing_approach: attempt.routing_approach, } } } diff --git a/crates/router/src/services/kafka/payment_attempt_event.rs b/crates/router/src/services/kafka/payment_attempt_event.rs index e06f4e014dd..9bfc6f8c31d 100644 --- a/crates/router/src/services/kafka/payment_attempt_event.rs +++ b/crates/router/src/services/kafka/payment_attempt_event.rs @@ -70,6 +70,7 @@ pub struct KafkaPaymentAttemptEvent<'a> { pub organization_id: &'a id_type::OrganizationId, pub card_network: Option<String>, pub card_discovery: Option<String>, + pub routing_approach: Option<storage_enums::RoutingApproach>, } #[cfg(feature = "v1")] @@ -131,6 +132,7 @@ impl<'a> KafkaPaymentAttemptEvent<'a> { card_discovery: attempt .card_discovery .map(|discovery| discovery.to_string()), + routing_approach: attempt.routing_approach, } } } diff --git a/crates/router/src/types/storage/payment_attempt.rs b/crates/router/src/types/storage/payment_attempt.rs index 3a942f70e32..5289ed02af9 100644 --- a/crates/router/src/types/storage/payment_attempt.rs +++ b/crates/router/src/types/storage/payment_attempt.rs @@ -225,6 +225,7 @@ mod tests { processor_merchant_id: Default::default(), created_by: None, setup_future_usage_applied: Default::default(), + routing_approach: Default::default(), }; let store = state @@ -315,6 +316,7 @@ mod tests { processor_merchant_id: Default::default(), created_by: None, setup_future_usage_applied: Default::default(), + routing_approach: Default::default(), }; let store = state .stores @@ -418,6 +420,7 @@ mod tests { processor_merchant_id: Default::default(), created_by: None, setup_future_usage_applied: Default::default(), + routing_approach: Default::default(), }; let store = state .stores diff --git a/crates/router/src/utils/user/sample_data.rs b/crates/router/src/utils/user/sample_data.rs index 989e7db3c0c..52c3d29482e 100644 --- a/crates/router/src/utils/user/sample_data.rs +++ b/crates/router/src/utils/user/sample_data.rs @@ -381,6 +381,7 @@ pub async fn generate_sample_data( processor_merchant_id: Some(merchant_id.clone()), created_by: None, setup_future_usage_applied: None, + routing_approach: None, }; let refund = if refunds_count < number_of_refunds && !is_failed_payment { diff --git a/crates/storage_impl/src/mock_db/payment_attempt.rs b/crates/storage_impl/src/mock_db/payment_attempt.rs index feec3a1f3a9..0de343b94ea 100644 --- a/crates/storage_impl/src/mock_db/payment_attempt.rs +++ b/crates/storage_impl/src/mock_db/payment_attempt.rs @@ -235,6 +235,7 @@ impl PaymentAttemptInterface for MockDb { processor_merchant_id: payment_attempt.processor_merchant_id, created_by: payment_attempt.created_by, setup_future_usage_applied: payment_attempt.setup_future_usage_applied, + routing_approach: payment_attempt.routing_approach, }; payment_attempts.push(payment_attempt.clone()); Ok(payment_attempt) diff --git a/crates/storage_impl/src/payments/payment_attempt.rs b/crates/storage_impl/src/payments/payment_attempt.rs index db3400c5fa4..ea1552248b9 100644 --- a/crates/storage_impl/src/payments/payment_attempt.rs +++ b/crates/storage_impl/src/payments/payment_attempt.rs @@ -680,6 +680,7 @@ impl<T: DatabaseStore> PaymentAttemptInterface for KVRouterStore<T> { processor_merchant_id: payment_attempt.processor_merchant_id.clone(), created_by: payment_attempt.created_by.clone(), setup_future_usage_applied: payment_attempt.setup_future_usage_applied, + routing_approach: payment_attempt.routing_approach, }; let field = format!("pa_{}", created_attempt.attempt_id); @@ -1704,6 +1705,7 @@ impl DataModelExt for PaymentAttempt { issuer_error_code: self.issuer_error_code, issuer_error_message: self.issuer_error_message, setup_future_usage_applied: self.setup_future_usage_applied, + routing_approach: self.routing_approach, // Below fields are deprecated. Please add any new fields above this line. connector_transaction_data: None, processor_merchant_id: Some(self.processor_merchant_id), @@ -1798,6 +1800,7 @@ impl DataModelExt for PaymentAttempt { .created_by .and_then(|created_by| created_by.parse::<CreatedBy>().ok()), setup_future_usage_applied: storage_model.setup_future_usage_applied, + routing_approach: storage_model.routing_approach, } } } @@ -1887,6 +1890,7 @@ impl DataModelExt for PaymentAttemptNew { processor_merchant_id: Some(self.processor_merchant_id), created_by: self.created_by.map(|created_by| created_by.to_string()), setup_future_usage_applied: self.setup_future_usage_applied, + routing_approach: self.routing_approach, } } @@ -1969,6 +1973,7 @@ impl DataModelExt for PaymentAttemptNew { .created_by .and_then(|created_by| created_by.parse::<CreatedBy>().ok()), setup_future_usage_applied: storage_model.setup_future_usage_applied, + routing_approach: storage_model.routing_approach, } } } diff --git a/migrations/2025-06-19-124558_add_routing_approach_to_attempt/down.sql b/migrations/2025-06-19-124558_add_routing_approach_to_attempt/down.sql new file mode 100644 index 00000000000..0c6fce15b58 --- /dev/null +++ b/migrations/2025-06-19-124558_add_routing_approach_to_attempt/down.sql @@ -0,0 +1,6 @@ +-- This file should undo anything in `up.sql` + +ALTER TABLE payment_attempt +DROP COLUMN IF EXISTS routing_approach; + +DROP TYPE "RoutingApproach"; diff --git a/migrations/2025-06-19-124558_add_routing_approach_to_attempt/up.sql b/migrations/2025-06-19-124558_add_routing_approach_to_attempt/up.sql new file mode 100644 index 00000000000..f5ec97a93f3 --- /dev/null +++ b/migrations/2025-06-19-124558_add_routing_approach_to_attempt/up.sql @@ -0,0 +1,15 @@ +-- Your SQL goes here +CREATE TYPE "RoutingApproach" AS ENUM ( + 'success_rate_exploitation', + 'success_rate_exploration', + 'contract_based_routing', + 'debit_routing', + 'rule_based_routing', + 'volume_based_routing', + 'default_fallback' +); + + +ALTER TABLE payment_attempt +ADD COLUMN IF NOT EXISTS routing_approach "RoutingApproach"; + diff --git a/v2_migrations/2025-01-13-081847_drop_v1_columns/up.sql b/v2_migrations/2025-01-13-081847_drop_v1_columns/up.sql index 7913af26d66..8eac6ae97ac 100644 --- a/v2_migrations/2025-01-13-081847_drop_v1_columns/up.sql +++ b/v2_migrations/2025-01-13-081847_drop_v1_columns/up.sql @@ -93,7 +93,8 @@ ALTER TABLE payment_attempt DROP COLUMN attempt_id, DROP COLUMN charge_id, DROP COLUMN issuer_error_code, DROP COLUMN issuer_error_message, - DROP COLUMN setup_future_usage_applied; + DROP COLUMN setup_future_usage_applied, + DROP COLUMN routing_approach; ALTER TABLE payment_methods

2025-06-20T18:09:08Z

## Type of Change  - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description  - Added RoutingApproach column in Payment attempt - Added RoutingApproach as a filter and dimension in payment analytics - Added routing metric endpoints DB queries - ```sql CREATE TYPE "RoutingApproach" AS ENUM ( 'success_rate_exploitation', 'success_rate_exploration', 'contract_based_routing', 'debit_routing', 'rule_based_routing', 'volume_based_routing', 'default_fallback' ); ALTER TABLE payment_attempt ADD COLUMN IF NOT EXISTS routing_approach "RoutingApproach"; ``` ### Additional Changes - [x] This PR modifies the API contract - [x] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  ## How did you test it?  ```bash curl -X GET 'http://localhost:8080/analytics/v1/org/routing/info' \ -H 'Accept: */*' \ -H 'Accept-Language: en-GB,en-US;q=0.9,en;q=0.8' \ -H 'Connection: keep-alive' \ -H 'Content-Type: application/json' \ -H 'Origin: http://localhost:9000' \ -H 'Referer: http://localhost:9000/' \ -H 'Sec-Fetch-Dest: empty' \ -H 'Sec-Fetch-Mode: cors' \ -H 'Sec-Fetch-Site: same-site' \ -H 'User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/136.0.0.0 Safari/537.36' \ -H 'X-Merchant-Id: merchant_1750414514' \ -H 'X-Profile-Id: pro_8QBK8uJG8ZHGwiZfWcAr' \ -H 'api-key: hyperswitch' \ -H 'authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiOGMzNzEwZmMtNDU3NS00NDlmLWFhNzItNWFjOWUyYmJlODViIiwibWVyY2hhbnRfaWQiOiJtZXJjaGFudF8xNzUwNDE0NTE0Iiwicm9sZV9pZCI6Im9yZ19hZG1pbiIsImV4cCI6MTc1MDg1MDY3MCwib3JnX2lkIjoib3JnX2EycGVlblVCaVNqY2dmVzNMQ2xXIiwicHJvZmlsZV9pZCI6InByb184UUJLOHVKRzhaSEd3aVpmV2NBciIsInRlbmFudF9pZCI6InB1YmxpYyJ9.wutHNAmKapYOM4kcOF0t-Lrrx-ZVFKelyFCXk_Xk8JA' \ -H 'sec-ch-ua: "Chromium";v="136", "Google Chrome";v="136", "Not.A/Brand";v="99"' \ -H 'sec-ch-ua-mobile: ?0' \ -H 'sec-ch-ua-platform: "macOS"' ``` response - ```json { "metrics": [ { "name": "payment_success_rate", "desc": "" }, { "name": "payment_count", "desc": "" }, { "name": "payment_success_count", "desc": "" }, { "name": "payment_processed_amount", "desc": "" }, { "name": "avg_ticket_size", "desc": "" }, { "name": "retries_count", "desc": "" }, { "name": "connector_success_rate", "desc": "" }, { "name": "sessionized_payment_success_rate", "desc": "" }, { "name": "sessionized_payment_count", "desc": "" }, { "name": "sessionized_payment_success_count", "desc": "" }, { "name": "sessionized_payment_processed_amount", "desc": "" }, { "name": "sessionized_avg_ticket_size", "desc": "" }, { "name": "sessionized_retries_count", "desc": "" }, { "name": "sessionized_connector_success_rate", "desc": "" }, { "name": "payments_distribution", "desc": "" }, { "name": "failure_reasons", "desc": "" } ], "downloadDimensions": null, "dimensions": [ { "name": "connector", "desc": "" }, { "name": "payment_method", "desc": "" }, { "name": "payment_method_type", "desc": "" }, { "name": "currency", "desc": "" }, { "name": "authentication_type", "desc": "" }, { "name": "status", "desc": "" }, { "name": "client_source", "desc": "" }, { "name": "client_version", "desc": "" }, { "name": "profile_id", "desc": "" }, { "name": "card_network", "desc": "" }, { "name": "merchant_id", "desc": "" }, { "name": "routing_approach", "desc": "" } ] } ``` ```bash curl -X POST http://localhost:8080/analytics/v1/org/filters/routing \ -H "Content-Type: application/json" \ -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiOGMzNzEwZmMtNDU3NS00NDlmLWFhNzItNWFjOWUyYmJlODViIiwibWVyY2hhbnRfaWQiOiJtZXJjaGFudF8xNzUwNDE0NTE0Iiwicm9sZV9pZCI6Im9yZ19hZG1pbiIsImV4cCI6MTc1MDU4NzUzMCwib3JnX2lkIjoib3JnX2EycGVlblVCaVNqY2dmVzNMQ2xXIiwicHJvZmlsZV9pZCI6InByb184UUJLOHVKRzhaSEd3aVpmV2NBciIsInRlbmFudF9pZCI6InB1YmxpYyJ9.4PuaaBWunN6wnLnm6Pxj08r9rXuuMrZ6GfYewQX9IFE" \ -d '{ "timeRange": { "startTime": "2025-06-11T18:30:00.000Z", "endTime": "2025-06-20T11:10:32.000Z" }, "groupByNames": [ "connector", "payment_method", "payment_method_type", "currency", "authentication_type", "status", "client_source", "client_version", "profile_id", "card_network", "merchant_id", "routing_approach" ], "source": "BATCH", "delta": true }' ``` ```bash curl 'http://localhost:8080/analytics/v1/org/metrics/routing' \ -H 'Accept: */*' \ -H 'Accept-Language: en-GB,en-US;q=0.9,en;q=0.8' \ -H 'Connection: keep-alive' \ -H 'Content-Type: application/json' \ -H 'Origin: http://localhost:9000' \ -H 'Referer: http://localhost:9000/' \ -H 'Sec-Fetch-Dest: empty' \ -H 'Sec-Fetch-Mode: cors' \ -H 'Sec-Fetch-Site: same-site' \ -H 'User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/136.0.0.0 Safari/537.36' \ -H 'X-Merchant-Id: merchant_1750414514' \ -H 'X-Profile-Id: pro_8QBK8uJG8ZHGwiZfWcAr' \ -H 'api-key: hyperswitch' \ -H 'authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiOGMzNzEwZmMtNDU3NS00NDlmLWFhNzItNWFjOWUyYmJlODViIiwibWVyY2hhbnRfaWQiOiJtZXJjaGFudF8xNzUwNDE0NTE0Iiwicm9sZV9pZCI6Im9yZ19hZG1pbiIsImV4cCI6MTc1MDg1MDY3MCwib3JnX2lkIjoib3JnX2EycGVlblVCaVNqY2dmVzNMQ2xXIiwicHJvZmlsZV9pZCI6InByb184UUJLOHVKRzhaSEd3aVpmV2NBciIsInRlbmFudF9pZCI6InB1YmxpYyJ9.wutHNAmKapYOM4kcOF0t-Lrrx-ZVFKelyFCXk_Xk8JA' \ -H 'sec-ch-ua: "Chromium";v="136", "Google Chrome";v="136", "Not.A/Brand";v="99"' \ -H 'sec-ch-ua-mobile: ?0' \ -H 'sec-ch-ua-platform: "macOS"' \ --data-raw '[{"timeRange":{"startTime":"2025-06-12T18:30:00Z","endTime":"2025-06-23T18:23:53Z"},"groupByNames":["routing_approach","connector"],"source":"BATCH","metrics":[ "payment_count","payment_success_rate", "payment_processed_amount"],"delta":true}]' ``` Response ```json { "queryData": [ { "payment_success_rate": null, "payment_count": null, "payment_success_count": null, "payment_processed_amount": 20400, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "currency": "USD", "status": null, "connector": "stripe", "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": "rule_based_routing", "time_range": { "start_time": "2025-06-12T18:30:00.000Z", "end_time": "2025-06-23T18:23:53.000Z" }, "time_bucket": "2025-06-12 18:30:00" }, { "payment_success_rate": null, "payment_count": null, "payment_success_count": null, "payment_processed_amount": 20300, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "currency": "USD", "status": null, "connector": "pretendpay", "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": null, "time_range": { "start_time": "2025-06-12T18:30:00.000Z", "end_time": "2025-06-23T18:23:53.000Z" }, "time_bucket": "2025-06-12 18:30:00" }, { "payment_success_rate": 100.0, "payment_count": 2, "payment_success_count": null, "payment_processed_amount": 0, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "currency": null, "status": null, "connector": "stripe", "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": "volume_based_routing", "time_range": { "start_time": "2025-06-12T18:30:00.000Z", "end_time": "2025-06-23T18:23:53.000Z" }, "time_bucket": "2025-06-12 18:30:00" }, { "payment_success_rate": 100.0, "payment_count": 2, "payment_success_count": null, "payment_processed_amount": 0, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "currency": null, "status": null, "connector": "stripe", "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": "rule_based_routing", "time_range": { "start_time": "2025-06-12T18:30:00.000Z", "end_time": "2025-06-23T18:23:53.000Z" }, "time_bucket": "2025-06-12 18:30:00" }, { "payment_success_rate": null, "payment_count": null, "payment_success_count": null, "payment_processed_amount": 10200, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "currency": "USD", "status": null, "connector": "stripe", "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": "default_fallback", "time_range": { "start_time": "2025-06-12T18:30:00.000Z", "end_time": "2025-06-23T18:23:53.000Z" }, "time_bucket": "2025-06-12 18:30:00" }, { "payment_success_rate": 100.0, "payment_count": 4, "payment_success_count": null, "payment_processed_amount": 0, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "currency": null, "status": null, "connector": "stripe", "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": null, "time_range": { "start_time": "2025-06-12T18:30:00.000Z", "end_time": "2025-06-23T18:23:53.000Z" }, "time_bucket": "2025-06-12 18:30:00" }, { "payment_success_rate": 0.0, "payment_count": 12, "payment_success_count": null, "payment_processed_amount": 0, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "currency": null, "status": null, "connector": null, "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": null, "time_range": { "start_time": "2025-06-12T18:30:00.000Z", "end_time": "2025-06-23T18:23:53.000Z" }, "time_bucket": "2025-06-12 18:30:00" }, { "payment_success_rate": 0.0, "payment_count": 6, "payment_success_count": null, "payment_processed_amount": 0, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "currency": null, "status": null, "connector": null, "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": "rule_based_routing", "time_range": { "start_time": "2025-06-12T18:30:00.000Z", "end_time": "2025-06-23T18:23:53.000Z" }, "time_bucket": "2025-06-12 18:30:00" }, { "payment_success_rate": null, "payment_count": null, "payment_success_count": null, "payment_processed_amount": 20000, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "currency": "USD", "status": null, "connector": "stripe", "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": "volume_based_routing", "time_range": { "start_time": "2025-06-12T18:30:00.000Z", "end_time": "2025-06-23T18:23:53.000Z" }, "time_bucket": "2025-06-12 18:30:00" }, { "payment_success_rate": null, "payment_count": null, "payment_success_count": null, "payment_processed_amount": 40000, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "currency": "USD", "status": null, "connector": "stripe", "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": null, "time_range": { "start_time": "2025-06-12T18:30:00.000Z", "end_time": "2025-06-23T18:23:53.000Z" }, "time_bucket": "2025-06-12 18:30:00" }, { "payment_success_rate": 100.0, "payment_count": 2, "payment_success_count": null, "payment_processed_amount": 0, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "currency": null, "status": null, "connector": "pretendpay", "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": null, "time_range": { "start_time": "2025-06-12T18:30:00.000Z", "end_time": "2025-06-23T18:23:53.000Z" }, "time_bucket": "2025-06-12 18:30:00" }, { "payment_success_rate": 100.0, "payment_count": 1, "payment_success_count": null, "payment_processed_amount": 0, "payment_processed_amount_in_usd": null, "payment_processed_count": null, "payment_processed_amount_without_smart_retries": 0, "payment_processed_amount_without_smart_retries_usd": null, "payment_processed_count_without_smart_retries": null, "avg_ticket_size": null, "payment_error_message": null, "retries_count": null, "retries_amount_processed": 0, "connector_success_rate": null, "payments_success_rate_distribution": null, "payments_success_rate_distribution_without_smart_retries": null, "payments_success_rate_distribution_with_only_retries": null, "payments_failure_rate_distribution": null, "payments_failure_rate_distribution_without_smart_retries": null, "payments_failure_rate_distribution_with_only_retries": null, "failure_reason_count": 0, "failure_reason_count_without_smart_retries": 0, "currency": null, "status": null, "connector": "stripe", "authentication_type": null, "payment_method": null, "payment_method_type": null, "client_source": null, "client_version": null, "profile_id": null, "card_network": null, "merchant_id": null, "card_last_4": null, "card_issuer": null, "error_reason": null, "routing_approach": "default_fallback", "time_range": { "start_time": "2025-06-12T18:30:00.000Z", "end_time": "2025-06-23T18:23:53.000Z" }, "time_bucket": "2025-06-12 18:30:00" } ], "metaData": [ { "total_payment_processed_amount": 110900, "total_payment_processed_amount_in_usd": null, "total_payment_processed_amount_without_smart_retries": 0, "total_payment_processed_amount_without_smart_retries_usd": null, "total_payment_processed_count": 0, "total_payment_processed_count_without_smart_retries": 0, "total_failure_reasons_count": 0, "total_failure_reasons_count_without_smart_retries": 0 } ] } ``` ## Checklist  - [ ] I formatted the code `cargo +nightly fmt --all` - [ ] I addressed lints thrown by `cargo clippy` - [ ] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.114.0

0851c6ece574ce961830c14d91e6e2040cb3b286

juspay/hyperswitch

juspay__hyperswitch-8398

Bug: [FEATURE] [AUTHIPAY] Integrate cards non-3ds payments ### Feature Description cards non-3ds payments needs to be integrated for authipay ### Possible Implementation cards non-3ds payments needs to be integrated for authipay ### Have you spent some time checking if this feature request has been raised before? - [x] I checked and didn't find a similar issue ### Have you read the Contributing Guidelines? - [x] I have read the [Contributing Guidelines](https://github.com/juspay/hyperswitch/blob/main/docs/CONTRIBUTING.md) ### Are you willing to submit a PR? None

diff --git a/api-reference/v1/openapi_spec_v1.json b/api-reference/v1/openapi_spec_v1.json index 940922743ca..d748f65261a 100644 --- a/api-reference/v1/openapi_spec_v1.json +++ b/api-reference/v1/openapi_spec_v1.json @@ -10916,6 +10916,7 @@ "Connector": { "type": "string", "enum": [ + "authipay", "adyenplatform", "stripe_billing_test", "phonypay", @@ -27926,6 +27927,7 @@ "type": "string", "description": "RoutableConnectors are the subset of Connectors that are eligible for payments routing", "enum": [ + "authipay", "adyenplatform", "stripe_billing_test", "phonypay", diff --git a/api-reference/v2/openapi_spec_v2.json b/api-reference/v2/openapi_spec_v2.json index 12340ea5dcb..53bbace7dfb 100644 --- a/api-reference/v2/openapi_spec_v2.json +++ b/api-reference/v2/openapi_spec_v2.json @@ -8123,6 +8123,7 @@ "Connector": { "type": "string", "enum": [ + "authipay", "adyenplatform", "stripe_billing_test", "phonypay", @@ -22643,6 +22644,7 @@ "type": "string", "description": "RoutableConnectors are the subset of Connectors that are eligible for payments routing", "enum": [ + "authipay", "adyenplatform", "stripe_billing_test", "phonypay", diff --git a/config/config.example.toml b/config/config.example.toml index 10f796128f7..2b1916d41c2 100644 --- a/config/config.example.toml +++ b/config/config.example.toml @@ -189,6 +189,7 @@ airwallex.base_url = "https://api-demo.airwallex.com/" amazonpay.base_url = "https://pay-api.amazon.com/v2" applepay.base_url = "https://apple-pay-gateway.apple.com/" archipel.base_url = "https://{{merchant_endpoint_prefix}}/ArchiPEL/Transaction/v1" +authipay.base_url = "https://prod.emea.api.fiservapps.com/sandbox/ipp/payments-gateway/v2" authorizedotnet.base_url = "https://apitest.authorize.net/xml/v1/request.api" bambora.base_url = "https://api.na.bambora.com" bamboraapac.base_url = "https://demo.ippayments.com.au/interface/api" @@ -343,6 +344,7 @@ cards = [ "adyen", "adyenplatform", "archipel", + "authipay", "authorizedotnet", "celero", "coinbase", diff --git a/config/deployments/integration_test.toml b/config/deployments/integration_test.toml index 803047dca2e..f839aabbf60 100644 --- a/config/deployments/integration_test.toml +++ b/config/deployments/integration_test.toml @@ -28,6 +28,7 @@ airwallex.base_url = "https://api-demo.airwallex.com/" amazonpay.base_url = "https://pay-api.amazon.com/v2" applepay.base_url = "https://apple-pay-gateway.apple.com/" archipel.base_url = "https://{{merchant_endpoint_prefix}}/ArchiPEL/Transaction/v1" +authipay.base_url = "https://prod.emea.api.fiservapps.com/sandbox/ipp/payments-gateway/v2/" authorizedotnet.base_url = "https://apitest.authorize.net/xml/v1/request.api" bambora.base_url = "https://api.na.bambora.com" bamboraapac.base_url = "https://demo.ippayments.com.au/interface/api" diff --git a/config/deployments/production.toml b/config/deployments/production.toml index 94d8f18d44d..36f80248f9b 100644 --- a/config/deployments/production.toml +++ b/config/deployments/production.toml @@ -32,6 +32,7 @@ airwallex.base_url = "https://api.airwallex.com/" amazonpay.base_url = "https://pay-api.amazon.com/v2" applepay.base_url = "https://apple-pay-gateway.apple.com/" archipel.base_url = "https://{{merchant_endpoint_prefix}}/ArchiPEL/Transaction/v1" +authipay.base_url = "https://prod.emea.api.fiservapps.com/ipp/payments-gateway/v2/" authorizedotnet.base_url = "https://api.authorize.net/xml/v1/request.api" bambora.base_url = "https://api.na.bambora.com" bamboraapac.base_url = "https://www.bambora.co.nz/interface/api/dts.asmx" diff --git a/config/deployments/sandbox.toml b/config/deployments/sandbox.toml index 99daaab178d..3018fb176d0 100644 --- a/config/deployments/sandbox.toml +++ b/config/deployments/sandbox.toml @@ -32,6 +32,7 @@ airwallex.base_url = "https://api-demo.airwallex.com/" amazonpay.base_url = "https://pay-api.amazon.com/v2" applepay.base_url = "https://apple-pay-gateway.apple.com/" archipel.base_url = "https://{{merchant_endpoint_prefix}}/ArchiPEL/Transaction/v1" +authipay.base_url = "https://prod.emea.api.fiservapps.com/sandbox/ipp/payments-gateway/v2" authorizedotnet.base_url = "https://apitest.authorize.net/xml/v1/request.api" bambora.base_url = "https://api.na.bambora.com" bamboraapac.base_url = "https://demo.ippayments.com.au/interface/api" diff --git a/config/development.toml b/config/development.toml index b72f7bcbaee..8808aabb0ef 100644 --- a/config/development.toml +++ b/config/development.toml @@ -99,6 +99,7 @@ cards = [ "airwallex", "amazonpay", "archipel", + "authipay", "authorizedotnet", "bambora", "bamboraapac", @@ -227,6 +228,7 @@ airwallex.base_url = "https://api-demo.airwallex.com/" amazonpay.base_url = "https://pay-api.amazon.com/v2" applepay.base_url = "https://apple-pay-gateway.apple.com/" archipel.base_url = "https://{{merchant_endpoint_prefix}}/ArchiPEL/Transaction/v1" +authipay.base_url = "https://prod.emea.api.fiservapps.com/sandbox/ipp/payments-gateway/v2/" authorizedotnet.base_url = "https://apitest.authorize.net/xml/v1/request.api" bambora.base_url = "https://api.na.bambora.com" bamboraapac.base_url = "https://demo.ippayments.com.au/interface/api" diff --git a/config/docker_compose.toml b/config/docker_compose.toml index ef3ad0b1b05..b232636421f 100644 --- a/config/docker_compose.toml +++ b/config/docker_compose.toml @@ -115,6 +115,7 @@ airwallex.base_url = "https://api-demo.airwallex.com/" amazonpay.base_url = "https://pay-api.amazon.com/v2" applepay.base_url = "https://apple-pay-gateway.apple.com/" archipel.base_url = "https://{{merchant_endpoint_prefix}}/ArchiPEL/Transaction/v1" +authipay.base_url = "https://prod.emea.api.fiservapps.com/sandbox/ipp/payments-gateway/v2/" authorizedotnet.base_url = "https://apitest.authorize.net/xml/v1/request.api" bambora.base_url = "https://api.na.bambora.com" bamboraapac.base_url = "https://demo.ippayments.com.au/interface/api" @@ -251,6 +252,7 @@ cards = [ "airwallex", "amazonpay", "archipel", + "authipay", "authorizedotnet", "bambora", "bamboraapac", diff --git a/config/payment_required_fields_v2.toml b/config/payment_required_fields_v2.toml index cc9ffee29e2..fe1e6e050d2 100644 --- a/config/payment_required_fields_v2.toml +++ b/config/payment_required_fields_v2.toml @@ -47,6 +47,14 @@ common = [ { required_field = "payment_method_data.billing.address.last_name", display_name = "card_holder_name", field_type = "user_full_name" } ] +[required_fields.Card.Debit.fields.Authipay] +common = [ + { required_field = "payment_method_data.card.card_number", display_name = "card_number", field_type = "user_card_number" }, + { required_field = "payment_method_data.card.card_exp_month", display_name = "card_exp_month", field_type = "user_card_expiry_month" }, + { required_field = "payment_method_data.card.card_exp_year", display_name = "card_exp_year", field_type = "user_card_expiry_year" }, + { required_field = "payment_method_data.card.card_cvc", display_name = "card_cvc", field_type = "user_card_cvc" } +] + [required_fields.Card.Debit.fields.Bambora] non_mandate = [ { required_field = "payment_method_data.card.card_number", display_name = "card_number", field_type = "user_card_number" }, @@ -546,6 +554,14 @@ common = [ { required_field = "payment_method_data.card.card_cvc", display_name = "card_cvc", field_type = "user_card_cvc" } ] +[required_fields.Card.Credit.fields.Authipay] +common = [ + { required_field = "payment_method_data.card.card_number", display_name = "card_number", field_type = "user_card_number" }, + { required_field = "payment_method_data.card.card_exp_month", display_name = "card_exp_month", field_type = "user_card_expiry_month" }, + { required_field = "payment_method_data.card.card_exp_year", display_name = "card_exp_year", field_type = "user_card_expiry_year" }, + { required_field = "payment_method_data.card.card_cvc", display_name = "card_cvc", field_type = "user_card_cvc" } +] + [required_fields.Card.Credit.fields.Bambora] non_mandate = [ { required_field = "payment_method_data.card.card_number", display_name = "card_number", field_type = "user_card_number" }, @@ -2341,4 +2357,4 @@ non_mandate = [ [required_fields.card_redirect.momo_atm.fields.Adyen] common = [] mandate = [] -non_mandate = [] \ No newline at end of file +non_mandate = [] diff --git a/crates/common_enums/src/connector_enums.rs b/crates/common_enums/src/connector_enums.rs index 5251b9b3177..41563d56f27 100644 --- a/crates/common_enums/src/connector_enums.rs +++ b/crates/common_enums/src/connector_enums.rs @@ -25,6 +25,7 @@ pub use crate::PaymentMethodType; #[strum(serialize_all = "snake_case")] /// RoutableConnectors are the subset of Connectors that are eligible for payments routing pub enum RoutableConnectors { + Authipay, Adyenplatform, #[cfg(feature = "dummy_connector")] #[serde(rename = "stripe_billing_test")] @@ -184,6 +185,7 @@ pub enum RoutableConnectors { #[serde(rename_all = "snake_case")] #[strum(serialize_all = "snake_case")] pub enum Connector { + Authipay, Adyenplatform, #[cfg(feature = "dummy_connector")] #[serde(rename = "stripe_billing_test")] @@ -404,6 +406,7 @@ impl Connector { | Self::DummyConnector7 => false, Self::Aci // Add Separate authentication support for connectors + | Self::Authipay | Self::Adyen | Self::Adyenplatform | Self::Airwallex @@ -551,6 +554,7 @@ impl Connector { impl From<RoutableConnectors> for Connector { fn from(routable_connector: RoutableConnectors) -> Self { match routable_connector { + RoutableConnectors::Authipay => Self::Authipay, RoutableConnectors::Adyenplatform => Self::Adyenplatform, #[cfg(feature = "dummy_connector")] RoutableConnectors::DummyBillingConnector => Self::DummyBillingConnector, @@ -673,6 +677,7 @@ impl TryFrom<Connector> for RoutableConnectors { fn try_from(connector: Connector) -> Result<Self, Self::Error> { match connector { + Connector::Authipay => Ok(Self::Authipay), Connector::Adyenplatform => Ok(Self::Adyenplatform), #[cfg(feature = "dummy_connector")] Connector::DummyBillingConnector => Ok(Self::DummyBillingConnector), diff --git a/crates/connector_configs/src/connector.rs b/crates/connector_configs/src/connector.rs index f092b543f8c..67e340fa155 100644 --- a/crates/connector_configs/src/connector.rs +++ b/crates/connector_configs/src/connector.rs @@ -171,6 +171,7 @@ pub struct ConnectorTomlConfig { #[serde_with::skip_serializing_none] #[derive(Debug, Deserialize, serde::Serialize, Clone)] pub struct ConnectorConfig { + pub authipay: Option<ConnectorTomlConfig>, pub juspaythreedsserver: Option<ConnectorTomlConfig>, pub aci: Option<ConnectorTomlConfig>, pub adyen: Option<ConnectorTomlConfig>, @@ -369,6 +370,7 @@ impl ConnectorConfig { let connector_data = Self::new()?; match connector { Connector::Aci => Ok(connector_data.aci), + Connector::Authipay => Ok(connector_data.authipay), Connector::Adyen => Ok(connector_data.adyen), Connector::Adyenplatform => Err("Use get_payout_connector_config".to_string()), Connector::Airwallex => Ok(connector_data.airwallex), diff --git a/crates/connector_configs/toml/development.toml b/crates/connector_configs/toml/development.toml index f8919cba957..a8a0baa2661 100644 --- a/crates/connector_configs/toml/development.toml +++ b/crates/connector_configs/toml/development.toml @@ -502,7 +502,21 @@ required=true type="MultiSelect" options=["PAN_ONLY", "CRYPTOGRAM_3DS"] - +[authipay] +[[authipay.credit]] + payment_method_type = "Mastercard" +[[authipay.credit]] + payment_method_type = "Visa" +[[authipay.debit]] + payment_method_type = "Mastercard" +[[authipay.debit]] + payment_method_type = "Visa" +[authipay.connector_auth.SignatureKey] +api_key="API Key" +api_secret="API Secret" +key1="Merchant ID" +[authipay.connector_webhook_details] +merchant_secret="Source verification key" [authorizedotnet] [[authorizedotnet.credit]] diff --git a/crates/connector_configs/toml/production.toml b/crates/connector_configs/toml/production.toml index 667c5028c95..a22b50a9b4f 100644 --- a/crates/connector_configs/toml/production.toml +++ b/crates/connector_configs/toml/production.toml @@ -305,6 +305,22 @@ key1="Client ID" [airwallex.connector_webhook_details] merchant_secret="Source verification key" +[authipay] +[[authipay.credit]] + payment_method_type = "Mastercard" +[[authipay.credit]] + payment_method_type = "Visa" +[[authipay.debit]] + payment_method_type = "Mastercard" +[[authipay.debit]] + payment_method_type = "Visa" +[authipay.connector_auth.SignatureKey] +api_key="API Key" +api_secret="API Secret" +key1="Merchant ID" +[authipay.connector_webhook_details] +merchant_secret="Source verification key" + [authorizedotnet] [[authorizedotnet.credit]] payment_method_type = "Mastercard" diff --git a/crates/connector_configs/toml/sandbox.toml b/crates/connector_configs/toml/sandbox.toml index 20b7cdf09bf..d7026129699 100644 --- a/crates/connector_configs/toml/sandbox.toml +++ b/crates/connector_configs/toml/sandbox.toml @@ -503,7 +503,21 @@ required=true type="MultiSelect" options=["PAN_ONLY", "CRYPTOGRAM_3DS"] - +[authipay] +[[authipay.credit]] + payment_method_type = "Mastercard" +[[authipay.credit]] + payment_method_type = "Visa" +[[authipay.debit]] + payment_method_type = "Mastercard" +[[authipay.debit]] + payment_method_type = "Visa" +[authipay.connector_auth.SignatureKey] +api_key="API Key" +api_secret="API Secret" +key1="Merchant ID" +[authipay.connector_webhook_details] +merchant_secret="Source verification key" [authorizedotnet] [[authorizedotnet.credit]] diff --git a/crates/hyperswitch_connectors/src/connectors.rs b/crates/hyperswitch_connectors/src/connectors.rs index 6583e2ce5b9..84b53c97143 100644 --- a/crates/hyperswitch_connectors/src/connectors.rs +++ b/crates/hyperswitch_connectors/src/connectors.rs @@ -4,6 +4,7 @@ pub mod adyenplatform; pub mod airwallex; pub mod amazonpay; pub mod archipel; +pub mod authipay; pub mod authorizedotnet; pub mod bambora; pub mod bamboraapac; @@ -115,16 +116,16 @@ pub mod zsl; pub use self::dummyconnector::DummyConnector; pub use self::{ aci::Aci, adyen::Adyen, adyenplatform::Adyenplatform, airwallex::Airwallex, - amazonpay::Amazonpay, archipel::Archipel, authorizedotnet::Authorizedotnet, bambora::Bambora, - bamboraapac::Bamboraapac, bankofamerica::Bankofamerica, barclaycard::Barclaycard, - billwerk::Billwerk, bitpay::Bitpay, bluesnap::Bluesnap, boku::Boku, braintree::Braintree, - cashtocode::Cashtocode, celero::Celero, chargebee::Chargebee, checkbook::Checkbook, - checkout::Checkout, coinbase::Coinbase, coingate::Coingate, cryptopay::Cryptopay, - ctp_mastercard::CtpMastercard, cybersource::Cybersource, datatrans::Datatrans, - deutschebank::Deutschebank, digitalvirgo::Digitalvirgo, dlocal::Dlocal, dwolla::Dwolla, - ebanx::Ebanx, elavon::Elavon, facilitapay::Facilitapay, fiserv::Fiserv, fiservemea::Fiservemea, - fiuu::Fiuu, forte::Forte, getnet::Getnet, globalpay::Globalpay, globepay::Globepay, - gocardless::Gocardless, gpayments::Gpayments, helcim::Helcim, hipay::Hipay, + amazonpay::Amazonpay, archipel::Archipel, authipay::Authipay, authorizedotnet::Authorizedotnet, + bambora::Bambora, bamboraapac::Bamboraapac, bankofamerica::Bankofamerica, + barclaycard::Barclaycard, billwerk::Billwerk, bitpay::Bitpay, bluesnap::Bluesnap, boku::Boku, + braintree::Braintree, cashtocode::Cashtocode, celero::Celero, chargebee::Chargebee, + checkbook::Checkbook, checkout::Checkout, coinbase::Coinbase, coingate::Coingate, + cryptopay::Cryptopay, ctp_mastercard::CtpMastercard, cybersource::Cybersource, + datatrans::Datatrans, deutschebank::Deutschebank, digitalvirgo::Digitalvirgo, dlocal::Dlocal, + dwolla::Dwolla, ebanx::Ebanx, elavon::Elavon, facilitapay::Facilitapay, fiserv::Fiserv, + fiservemea::Fiservemea, fiuu::Fiuu, forte::Forte, getnet::Getnet, globalpay::Globalpay, + globepay::Globepay, gocardless::Gocardless, gpayments::Gpayments, helcim::Helcim, hipay::Hipay, hyperswitch_vault::HyperswitchVault, iatapay::Iatapay, inespay::Inespay, itaubank::Itaubank, jpmorgan::Jpmorgan, juspaythreedsserver::Juspaythreedsserver, klarna::Klarna, mifinity::Mifinity, mollie::Mollie, moneris::Moneris, multisafepay::Multisafepay, diff --git a/crates/hyperswitch_connectors/src/connectors/authipay.rs b/crates/hyperswitch_connectors/src/connectors/authipay.rs new file mode 100644 index 00000000000..5a5179ef5f1 --- /dev/null +++ b/crates/hyperswitch_connectors/src/connectors/authipay.rs @@ -0,0 +1,849 @@ +pub mod transformers; + +use std::sync::LazyLock; + +use base64::Engine; +use common_enums::enums; +use common_utils::{ + errors::CustomResult, + ext_traits::BytesExt, + request::{Method, Request, RequestBuilder, RequestContent}, + types::{AmountConvertor, FloatMajorUnit, FloatMajorUnitForConnector}, +}; +use error_stack::{report, ResultExt}; +use hyperswitch_domain_models::{ + router_data::{AccessToken, ConnectorAuthType, ErrorResponse, RouterData}, + router_flow_types::{ + access_token_auth::AccessTokenAuth, + payments::{Authorize, Capture, PSync, PaymentMethodToken, Session, SetupMandate, Void}, + refunds::{Execute, RSync}, + }, + router_request_types::{ + AccessTokenRequestData, PaymentMethodTokenizationData, PaymentsAuthorizeData, + PaymentsCancelData, PaymentsCaptureData, PaymentsSessionData, PaymentsSyncData, + RefundsData, SetupMandateRequestData, + }, + router_response_types::{ + ConnectorInfo, PaymentMethodDetails, PaymentsResponseData, RefundsResponseData, + SupportedPaymentMethods, SupportedPaymentMethodsExt, + }, + types::{ + PaymentsAuthorizeRouterData, PaymentsCancelRouterData, PaymentsCaptureRouterData, + PaymentsSyncRouterData, RefundSyncRouterData, RefundsRouterData, + }, +}; +use hyperswitch_interfaces::{ + api::{ + self, ConnectorCommon, ConnectorCommonExt, ConnectorIntegration, ConnectorSpecifications, + ConnectorValidation, + }, + configs::Connectors, + errors, + events::connector_api_logs::ConnectorEvent, + types::{self, Response}, + webhooks, +}; +use masking::{ExposeInterface, Mask, PeekInterface}; +use transformers as authipay; + +use crate::{constants::headers, types::ResponseRouterData, utils}; + +#[derive(Clone)] +pub struct Authipay { + amount_converter: &'static (dyn AmountConvertor<Output = FloatMajorUnit> + Sync), +} + +impl Authipay { + pub fn new() -> &'static Self { + &Self { + amount_converter: &FloatMajorUnitForConnector, + } + } + + pub fn generate_authorization_signature( + &self, + auth: authipay::AuthipayAuthType, + request_id: &str, + payload: &str, + timestamp: i128, + ) -> CustomResult<String, errors::ConnectorError> { + let authipay::AuthipayAuthType { + api_key, + api_secret, + } = auth; + let raw_signature = format!("{}{request_id}{timestamp}{payload}", api_key.peek()); + + let key = ring::hmac::Key::new(ring::hmac::HMAC_SHA256, api_secret.expose().as_bytes()); + let signature_value = common_utils::consts::BASE64_ENGINE + .encode(ring::hmac::sign(&key, raw_signature.as_bytes()).as_ref()); + Ok(signature_value) + } +} + +impl api::Payment for Authipay {} +impl api::PaymentSession for Authipay {} +impl api::ConnectorAccessToken for Authipay {} +impl api::MandateSetup for Authipay {} +impl api::PaymentAuthorize for Authipay {} +impl api::PaymentSync for Authipay {} +impl api::PaymentCapture for Authipay {} +impl api::PaymentVoid for Authipay {} +impl api::Refund for Authipay {} +impl api::RefundExecute for Authipay {} +impl api::RefundSync for Authipay {} +impl api::PaymentToken for Authipay {} + +impl ConnectorIntegration<PaymentMethodToken, PaymentMethodTokenizationData, PaymentsResponseData> + for Authipay +{ + // Not Implemented (R) +} + +impl<Flow, Request, Response> ConnectorCommonExt<Flow, Request, Response> for Authipay +where + Self: ConnectorIntegration<Flow, Request, Response>, +{ + fn build_headers( + &self, + req: &RouterData<Flow, Request, Response>, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + let timestamp = time::OffsetDateTime::now_utc().unix_timestamp_nanos() / 1_000_000; + let auth: authipay::AuthipayAuthType = + authipay::AuthipayAuthType::try_from(&req.connector_auth_type)?; + let mut auth_header = self.get_auth_header(&req.connector_auth_type)?; + + let authipay_req = self.get_request_body(req, connectors)?; + + let client_request_id = uuid::Uuid::new_v4().to_string(); + let hmac = self + .generate_authorization_signature( + auth, + &client_request_id, + authipay_req.get_inner_value().peek(), + timestamp, + ) + .change_context(errors::ConnectorError::RequestEncodingFailed)?; + let mut headers = vec![ + ( + headers::CONTENT_TYPE.to_string(), + types::PaymentsAuthorizeType::get_content_type(self) + .to_string() + .into(), + ), + ("Client-Request-Id".to_string(), client_request_id.into()), + ("Auth-Token-Type".to_string(), "HMAC".to_string().into()), + (headers::TIMESTAMP.to_string(), timestamp.to_string().into()), + ("Message-Signature".to_string(), hmac.into_masked()), + ]; + headers.append(&mut auth_header); + Ok(headers) + } +} + +impl ConnectorCommon for Authipay { + fn id(&self) -> &'static str { + "authipay" + } + + fn get_currency_unit(&self) -> api::CurrencyUnit { + api::CurrencyUnit::Base + } + + fn common_get_content_type(&self) -> &'static str { + "application/json" + } + + fn base_url<'a>(&self, connectors: &'a Connectors) -> &'a str { + connectors.authipay.base_url.as_ref() + } + + fn get_auth_header( + &self, + auth_type: &ConnectorAuthType, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + let auth = authipay::AuthipayAuthType::try_from(auth_type) + .change_context(errors::ConnectorError::FailedToObtainAuthType)?; + Ok(vec![( + headers::API_KEY.to_string(), + auth.api_key.into_masked(), + )]) + } + + fn build_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + let response: authipay::AuthipayErrorResponse = res + .response + .parse_struct("AuthipayErrorResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + + event_builder.map(|i| i.set_error_response_body(&response)); + + let mut error_response = ErrorResponse::from(&response); + + // Set status code from the response, or 400 if error code is a "404" + if let Some(error_code) = &response.error.code { + if error_code == "404" { + error_response.status_code = 404; + } else { + error_response.status_code = res.status_code; + } + } else { + error_response.status_code = res.status_code; + } + + Ok(error_response) + } +} + +impl ConnectorValidation for Authipay { + fn validate_connector_against_payment_request( + &self, + capture_method: Option<enums::CaptureMethod>, + _payment_method: enums::PaymentMethod, + _pmt: Option<enums::PaymentMethodType>, + ) -> CustomResult<(), errors::ConnectorError> { + let capture_method = capture_method.unwrap_or_default(); + match capture_method { + enums::CaptureMethod::Automatic + | enums::CaptureMethod::Manual + | enums::CaptureMethod::SequentialAutomatic => Ok(()), + enums::CaptureMethod::Scheduled | enums::CaptureMethod::ManualMultiple => Err( + utils::construct_not_implemented_error_report(capture_method, self.id()), + ), + } + } +} + +impl ConnectorIntegration<Session, PaymentsSessionData, PaymentsResponseData> for Authipay { + //TODO: implement sessions flow +} + +impl ConnectorIntegration<AccessTokenAuth, AccessTokenRequestData, AccessToken> for Authipay {} + +impl ConnectorIntegration<SetupMandate, SetupMandateRequestData, PaymentsResponseData> + for Authipay +{ +} + +impl ConnectorIntegration<Authorize, PaymentsAuthorizeData, PaymentsResponseData> for Authipay { + fn get_headers( + &self, + req: &PaymentsAuthorizeRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + _req: &PaymentsAuthorizeRouterData, + connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + Ok(format!("{}payments", self.base_url(connectors))) + } + + fn get_request_body( + &self, + req: &PaymentsAuthorizeRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let amount = utils::convert_amount( + self.amount_converter, + req.request.minor_amount, + req.request.currency, + )?; + + let connector_router_data = authipay::AuthipayRouterData::from((amount, req)); + let connector_req = authipay::AuthipayPaymentsRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &PaymentsAuthorizeRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::PaymentsAuthorizeType::get_url( + self, req, connectors, + )?) + .attach_default_headers() + .headers(types::PaymentsAuthorizeType::get_headers( + self, req, connectors, + )?) + .set_body(types::PaymentsAuthorizeType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsAuthorizeRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsAuthorizeRouterData, errors::ConnectorError> { + let response: authipay::AuthipayPaymentsResponse = res + .response + .parse_struct("Authipay PaymentsAuthorizeResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<PSync, PaymentsSyncData, PaymentsResponseData> for Authipay { + fn get_headers( + &self, + req: &PaymentsSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + req: &PaymentsSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + let connector_transaction_id = req + .request + .connector_transaction_id + .get_connector_transaction_id() + .change_context(errors::ConnectorError::RequestEncodingFailed)?; + Ok(format!( + "{}payments/{}", + self.base_url(connectors), + connector_transaction_id + )) + } + + fn get_request_body( + &self, + _req: &PaymentsSyncRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + Ok(RequestContent::RawBytes(Vec::new())) + } + + fn build_request( + &self, + req: &PaymentsSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Get) + .url(&types::PaymentsSyncType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::PaymentsSyncType::get_headers(self, req, connectors)?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsSyncRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsSyncRouterData, errors::ConnectorError> { + let response: authipay::AuthipayPaymentsResponse = res + .response + .parse_struct("authipay PaymentsSyncResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<Capture, PaymentsCaptureData, PaymentsResponseData> for Authipay { + fn get_headers( + &self, + req: &PaymentsCaptureRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + req: &PaymentsCaptureRouterData, + connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + let connector_transaction_id = req.request.connector_transaction_id.clone(); + Ok(format!( + "{}payments/{}", + self.base_url(connectors), + connector_transaction_id + )) + } + + fn get_request_body( + &self, + req: &PaymentsCaptureRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let amount = utils::convert_amount( + self.amount_converter, + req.request.minor_amount_to_capture, + req.request.currency, + )?; + + let connector_router_data = authipay::AuthipayRouterData::from((amount, req)); + let connector_req = authipay::AuthipayCaptureRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &PaymentsCaptureRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::PaymentsCaptureType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::PaymentsCaptureType::get_headers( + self, req, connectors, + )?) + .set_body(types::PaymentsCaptureType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsCaptureRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsCaptureRouterData, errors::ConnectorError> { + let response: authipay::AuthipayPaymentsResponse = res + .response + .parse_struct("Authipay PaymentsCaptureResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<Void, PaymentsCancelData, PaymentsResponseData> for Authipay { + fn get_headers( + &self, + req: &PaymentsCancelRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + req: &PaymentsCancelRouterData, + connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + // For void operations, Authipay requires using the /orders/{orderId} endpoint + // The orderId should be stored in connector_meta from the authorization response + let order_id = req + .request + .connector_meta + .as_ref() + .and_then(|meta| meta.get("order_id")) + .and_then(|v| v.as_str()) + .ok_or(errors::ConnectorError::RequestEncodingFailed)?; + + Ok(format!("{}orders/{}", self.base_url(connectors), order_id)) + } + + fn get_request_body( + &self, + req: &PaymentsCancelRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + // For void, we don't need amount conversion since it's always full amount + let connector_router_data = + authipay::AuthipayRouterData::from((FloatMajorUnit::zero(), req)); + let connector_req = authipay::AuthipayVoidRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &PaymentsCancelRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Post) + .url(&types::PaymentsVoidType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::PaymentsVoidType::get_headers(self, req, connectors)?) + .set_body(types::PaymentsVoidType::get_request_body( + self, req, connectors, + )?) + .build(), + )) + } + + fn handle_response( + &self, + data: &PaymentsCancelRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<PaymentsCancelRouterData, errors::ConnectorError> { + let response: authipay::AuthipayPaymentsResponse = res + .response + .parse_struct("Authipay PaymentsVoidResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<Execute, RefundsData, RefundsResponseData> for Authipay { + fn get_headers( + &self, + req: &RefundsRouterData<Execute>, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + req: &RefundsRouterData<Execute>, + connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + let connector_payment_id = req.request.connector_transaction_id.clone(); + Ok(format!( + "{}payments/{}", + self.base_url(connectors), + connector_payment_id + )) + } + + fn get_request_body( + &self, + req: &RefundsRouterData<Execute>, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + let refund_amount = utils::convert_amount( + self.amount_converter, + req.request.minor_refund_amount, + req.request.currency, + )?; + + let connector_router_data = authipay::AuthipayRouterData::from((refund_amount, req)); + let connector_req = authipay::AuthipayRefundRequest::try_from(&connector_router_data)?; + Ok(RequestContent::Json(Box::new(connector_req))) + } + + fn build_request( + &self, + req: &RefundsRouterData<Execute>, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + let request = RequestBuilder::new() + .method(Method::Post) + .url(&types::RefundExecuteType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::RefundExecuteType::get_headers( + self, req, connectors, + )?) + .set_body(types::RefundExecuteType::get_request_body( + self, req, connectors, + )?) + .build(); + Ok(Some(request)) + } + + fn handle_response( + &self, + data: &RefundsRouterData<Execute>, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<RefundsRouterData<Execute>, errors::ConnectorError> { + let response: authipay::RefundResponse = res + .response + .parse_struct("authipay RefundResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +impl ConnectorIntegration<RSync, RefundsData, RefundsResponseData> for Authipay { + fn get_headers( + &self, + req: &RefundSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Vec<(String, masking::Maskable<String>)>, errors::ConnectorError> { + self.build_headers(req, connectors) + } + + fn get_content_type(&self) -> &'static str { + self.common_get_content_type() + } + + fn get_url( + &self, + req: &RefundSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<String, errors::ConnectorError> { + let refund_id = req + .request + .connector_refund_id + .clone() + .ok_or(errors::ConnectorError::RequestEncodingFailed)?; + Ok(format!( + "{}payments/{}", + self.base_url(connectors), + refund_id + )) + } + + fn get_request_body( + &self, + _req: &RefundSyncRouterData, + _connectors: &Connectors, + ) -> CustomResult<RequestContent, errors::ConnectorError> { + Ok(RequestContent::RawBytes(Vec::new())) + } + + fn build_request( + &self, + req: &RefundSyncRouterData, + connectors: &Connectors, + ) -> CustomResult<Option<Request>, errors::ConnectorError> { + Ok(Some( + RequestBuilder::new() + .method(Method::Get) + .url(&types::RefundSyncType::get_url(self, req, connectors)?) + .attach_default_headers() + .headers(types::RefundSyncType::get_headers(self, req, connectors)?) + .build(), + )) + } + + fn handle_response( + &self, + data: &RefundSyncRouterData, + event_builder: Option<&mut ConnectorEvent>, + res: Response, + ) -> CustomResult<RefundSyncRouterData, errors::ConnectorError> { + let response: authipay::RefundResponse = res + .response + .parse_struct("authipay RefundSyncResponse") + .change_context(errors::ConnectorError::ResponseDeserializationFailed)?; + event_builder.map(|i| i.set_response_body(&response)); + + RouterData::try_from(ResponseRouterData { + response, + data: data.clone(), + http_code: res.status_code, + }) + } + + fn get_error_response( + &self, + res: Response, + event_builder: Option<&mut ConnectorEvent>, + ) -> CustomResult<ErrorResponse, errors::ConnectorError> { + self.build_error_response(res, event_builder) + } +} + +#[async_trait::async_trait] +impl webhooks::IncomingWebhook for Authipay { + fn get_webhook_object_reference_id( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<api_models::webhooks::ObjectReferenceId, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } + + fn get_webhook_event_type( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<api_models::webhooks::IncomingWebhookEvent, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } + + fn get_webhook_resource_object( + &self, + _request: &webhooks::IncomingWebhookRequestDetails<'_>, + ) -> CustomResult<Box<dyn masking::ErasedMaskSerialize>, errors::ConnectorError> { + Err(report!(errors::ConnectorError::WebhooksNotImplemented)) + } +} + +static AUTHIPAY_SUPPORTED_PAYMENT_METHODS: LazyLock<SupportedPaymentMethods> = + LazyLock::new(|| { + let supported_capture_methods = vec![ + enums::CaptureMethod::Automatic, + enums::CaptureMethod::SequentialAutomatic, + enums::CaptureMethod::Manual, + ]; + + let supported_card_network = vec![ + common_enums::CardNetwork::Visa, + common_enums::CardNetwork::Mastercard, + ]; + + let mut authipay_supported_payment_methods = SupportedPaymentMethods::new(); + + authipay_supported_payment_methods.add( + enums::PaymentMethod::Card, + enums::PaymentMethodType::Credit, + PaymentMethodDetails { + mandates: enums::FeatureStatus::NotSupported, + refunds: enums::FeatureStatus::Supported, + supported_capture_methods: supported_capture_methods.clone(), + specific_features: Some( + api_models::feature_matrix::PaymentMethodSpecificFeatures::Card({ + api_models::feature_matrix::CardSpecificFeatures { + three_ds: common_enums::FeatureStatus::NotSupported, + no_three_ds: common_enums::FeatureStatus::Supported, + supported_card_networks: supported_card_network.clone(), + } + }), + ), + }, + ); + + authipay_supported_payment_methods.add( + enums::PaymentMethod::Card, + enums::PaymentMethodType::Debit, + PaymentMethodDetails { + mandates: enums::FeatureStatus::NotSupported, + refunds: enums::FeatureStatus::Supported, + supported_capture_methods: supported_capture_methods.clone(), + specific_features: Some( + api_models::feature_matrix::PaymentMethodSpecificFeatures::Card({ + api_models::feature_matrix::CardSpecificFeatures { + three_ds: common_enums::FeatureStatus::NotSupported, + no_three_ds: common_enums::FeatureStatus::Supported, + supported_card_networks: supported_card_network.clone(), + } + }), + ), + }, + ); + + authipay_supported_payment_methods + }); + +static AUTHIPAY_CONNECTOR_INFO: ConnectorInfo = ConnectorInfo { + display_name: "Authipay", + description: "Authipay is a Fiserv-powered payment gateway for the EMEA region supporting Visa and Mastercard transactions. Features include flexible capture methods (automatic, manual, sequential), partial captures/refunds, payment tokenization, and secure HMAC SHA256 authentication.", + connector_type: enums::PaymentConnectorCategory::PaymentGateway, +}; + +static AUTHIPAY_SUPPORTED_WEBHOOK_FLOWS: [enums::EventClass; 0] = []; + +impl ConnectorSpecifications for Authipay { + fn get_connector_about(&self) -> Option<&'static ConnectorInfo> { + Some(&AUTHIPAY_CONNECTOR_INFO) + } + + fn get_supported_payment_methods(&self) -> Option<&'static SupportedPaymentMethods> { + Some(&*AUTHIPAY_SUPPORTED_PAYMENT_METHODS) + } + + fn get_supported_webhook_flows(&self) -> Option<&'static [enums::EventClass]> { + Some(&AUTHIPAY_SUPPORTED_WEBHOOK_FLOWS) + } +} diff --git a/crates/hyperswitch_connectors/src/connectors/authipay/transformers.rs b/crates/hyperswitch_connectors/src/connectors/authipay/transformers.rs new file mode 100644 index 00000000000..c7c21404752 --- /dev/null +++ b/crates/hyperswitch_connectors/src/connectors/authipay/transformers.rs @@ -0,0 +1,624 @@ +use cards; +use common_enums::enums; +use common_utils::types::FloatMajorUnit; +use hyperswitch_domain_models::{ + payment_method_data::PaymentMethodData, + router_data::{ConnectorAuthType, ErrorResponse, RouterData}, + router_flow_types::refunds::{Execute, RSync}, + router_request_types::ResponseId, + router_response_types::{PaymentsResponseData, RefundsResponseData}, + types::{ + PaymentsAuthorizeRouterData, PaymentsCancelRouterData, PaymentsCaptureRouterData, + RefundsRouterData, + }, +}; +use hyperswitch_interfaces::errors; +use masking::Secret; +use serde::{Deserialize, Serialize}; + +use crate::{ + types::{RefundsResponseRouterData, ResponseRouterData}, + utils, +}; + +// Type definition for router data with amount +pub struct AuthipayRouterData<T> { + pub amount: FloatMajorUnit, // Amount in major units (e.g., dollars instead of cents) + pub router_data: T, +} + +impl<T> From<(FloatMajorUnit, T)> for AuthipayRouterData<T> { + fn from((amount, item): (FloatMajorUnit, T)) -> Self { + Self { + amount, + router_data: item, + } + } +} + +// Basic request/response structs used across multiple operations + +#[derive(Default, Debug, Serialize, Deserialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct Amount { + total: FloatMajorUnit, + currency: String, + #[serde(skip_serializing_if = "Option::is_none")] + components: Option<AmountComponents>, +} + +#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct AmountComponents { + subtotal: FloatMajorUnit, +} + +#[derive(Default, Debug, Serialize, Deserialize, Clone, Eq, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct ExpiryDate { + month: Secret<String>, + year: Secret<String>, +} + +#[derive(Default, Debug, Serialize, Eq, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct Card { + number: cards::CardNumber, + security_code: Secret<String>, + expiry_date: ExpiryDate, +} + +#[derive(Default, Debug, Serialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct PaymentMethod { + payment_card: Card, +} + +#[derive(Default, Debug, Serialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct SplitShipment { + total_count: i32, + final_shipment: bool, +} + +#[derive(Debug, Serialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct AuthipayPaymentsRequest { + request_type: &'static str, + transaction_amount: Amount, + payment_method: PaymentMethod, + // split_shipment: Option<SplitShipment>, + // incremental_flag: Option<bool>, +} + +impl TryFrom<&AuthipayRouterData<&PaymentsAuthorizeRouterData>> for AuthipayPaymentsRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: &AuthipayRouterData<&PaymentsAuthorizeRouterData>, + ) -> Result<Self, Self::Error> { + // Check if 3DS is being requested - Authipay doesn't support 3DS + if matches!( + item.router_data.auth_type, + enums::AuthenticationType::ThreeDs + ) { + return Err(errors::ConnectorError::NotImplemented( + utils::get_unimplemented_payment_method_error_message("authipay"), + ) + .into()); + } + + match item.router_data.request.payment_method_data.clone() { + PaymentMethodData::Card(req_card) => { + let expiry_date = ExpiryDate { + month: req_card.card_exp_month.clone(), + year: req_card.card_exp_year.clone(), + }; + + let card = Card { + number: req_card.card_number.clone(), + security_code: req_card.card_cvc.clone(), + expiry_date, + }; + + let payment_method = PaymentMethod { payment_card: card }; + + let transaction_amount = Amount { + total: item.amount, + currency: item.router_data.request.currency.to_string(), + components: None, + }; + + // Determine request type based on capture method + let request_type = match item.router_data.request.capture_method { + Some(enums::CaptureMethod::Manual) => "PaymentCardPreAuthTransaction", + Some(enums::CaptureMethod::Automatic) => "PaymentCardSaleTransaction", + Some(enums::CaptureMethod::SequentialAutomatic) => "PaymentCardSaleTransaction", + Some(enums::CaptureMethod::ManualMultiple) + | Some(enums::CaptureMethod::Scheduled) => { + return Err(errors::ConnectorError::NotSupported { + message: "Capture method not supported by Authipay".to_string(), + connector: "Authipay", + } + .into()); + } + None => "PaymentCardSaleTransaction", // Default when not specified + }; + + let request = Self { + request_type, + transaction_amount, + payment_method, + }; + + Ok(request) + } + _ => Err(errors::ConnectorError::NotImplemented( + utils::get_unimplemented_payment_method_error_message("authipay"), + ) + .into()), + } + } +} + +//TODO: Fill the struct with respective fields +// Auth Struct +pub struct AuthipayAuthType { + pub(super) api_key: Secret<String>, + pub(super) api_secret: Secret<String>, +} + +impl TryFrom<&ConnectorAuthType> for AuthipayAuthType { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from(auth_type: &ConnectorAuthType) -> Result<Self, Self::Error> { + match auth_type { + ConnectorAuthType::SignatureKey { + api_key, + api_secret, + .. + } => Ok(Self { + api_key: api_key.to_owned(), + api_secret: api_secret.to_owned(), + }), + _ => Err(errors::ConnectorError::FailedToObtainAuthType.into()), + } + } +} +// Transaction Status enum (like Fiserv's FiservPaymentStatus) +#[derive(Debug, Clone, Default, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "UPPERCASE")] +pub enum AuthipayTransactionStatus { + Authorized, + Captured, + Voided, + Declined, + Failed, + #[default] + Processing, +} + +impl From<AuthipayTransactionStatus> for enums::AttemptStatus { + fn from(item: AuthipayTransactionStatus) -> Self { + match item { + AuthipayTransactionStatus::Captured => Self::Charged, + AuthipayTransactionStatus::Declined | AuthipayTransactionStatus::Failed => { + Self::Failure + } + AuthipayTransactionStatus::Processing => Self::Pending, + AuthipayTransactionStatus::Authorized => Self::Authorized, + AuthipayTransactionStatus::Voided => Self::Voided, + } + } +} + +// Transaction Processing Details (like Fiserv's TransactionProcessingDetails) +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct AuthipayTransactionProcessingDetails { + pub order_id: String, + pub transaction_id: String, +} + +// Gateway Response (like Fiserv's GatewayResponse) +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct AuthipayGatewayResponse { + pub transaction_state: AuthipayTransactionStatus, + pub transaction_processing_details: AuthipayTransactionProcessingDetails, +} + +// Payment Receipt (like Fiserv's PaymentReceipt) +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct AuthipayPaymentReceipt { + pub approved_amount: Amount, + pub processor_response_details: Option<Processor>, +} + +// Main Response (like Fiserv's FiservPaymentsResponse) - but flat for JSON deserialization +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct AuthipayPaymentsResponse { + #[serde(rename = "type")] + response_type: Option<String>, + client_request_id: String, + api_trace_id: String, + ipg_transaction_id: String, + order_id: String, + transaction_type: String, + payment_token: Option<PaymentToken>, + transaction_origin: Option<String>, + payment_method_details: Option<PaymentMethodDetails>, + country: Option<String>, + terminal_id: Option<String>, + merchant_id: Option<String>, + transaction_time: i64, + approved_amount: Amount, + transaction_amount: Amount, + // For payment transactions (SALE) + transaction_status: Option<String>, + // For refund transactions (RETURN) + transaction_result: Option<String>, + transaction_state: Option<String>, + approval_code: String, + scheme_transaction_id: Option<String>, + processor: Processor, +} + +impl AuthipayPaymentsResponse { + /// Get gateway response (like Fiserv's gateway_response) + pub fn gateway_response(&self) -> AuthipayGatewayResponse { + AuthipayGatewayResponse { + transaction_state: self.get_transaction_status(), + transaction_processing_details: AuthipayTransactionProcessingDetails { + order_id: self.order_id.clone(), + transaction_id: self.ipg_transaction_id.clone(), + }, + } + } + + /// Get payment receipt (like Fiserv's payment_receipt) + pub fn payment_receipt(&self) -> AuthipayPaymentReceipt { + AuthipayPaymentReceipt { + approved_amount: self.approved_amount.clone(), + processor_response_details: Some(self.processor.clone()), + } + } + + /// Determine the transaction status based on transaction type and various status fields (like Fiserv) + fn get_transaction_status(&self) -> AuthipayTransactionStatus { + match self.transaction_type.as_str() { + "RETURN" => { + // Refund transaction - use transaction_result + match self.transaction_result.as_deref() { + Some("APPROVED") => AuthipayTransactionStatus::Captured, + Some("DECLINED") | Some("FAILED") => AuthipayTransactionStatus::Failed, + _ => AuthipayTransactionStatus::Processing, + } + } + "VOID" => { + // Void transaction - use transaction_result, fallback to transaction_state + match self.transaction_result.as_deref() { + Some("APPROVED") => AuthipayTransactionStatus::Voided, + Some("DECLINED") | Some("FAILED") => AuthipayTransactionStatus::Failed, + Some("PENDING") | Some("PROCESSING") => AuthipayTransactionStatus::Processing, + _ => { + // Fallback to transaction_state for void operations + match self.transaction_state.as_deref() { + Some("VOIDED") => AuthipayTransactionStatus::Voided, + Some("FAILED") | Some("DECLINED") => AuthipayTransactionStatus::Failed, + _ => AuthipayTransactionStatus::Voided, // Default assumption for void requests + } + } + } + } + _ => { + // Payment transaction - prioritize transaction_state over transaction_status + match self.transaction_state.as_deref() { + Some("AUTHORIZED") => AuthipayTransactionStatus::Authorized, + Some("CAPTURED") => AuthipayTransactionStatus::Captured, + Some("VOIDED") => AuthipayTransactionStatus::Voided, + Some("DECLINED") | Some("FAILED") => AuthipayTransactionStatus::Failed, + _ => { + // Fallback to transaction_status with transaction_type context + match ( + self.transaction_type.as_str(), + self.transaction_status.as_deref(), + ) { + // For PREAUTH transactions, "APPROVED" means authorized and awaiting capture + ("PREAUTH", Some("APPROVED")) => AuthipayTransactionStatus::Authorized, + // For POSTAUTH transactions, "APPROVED" means successfully captured + ("POSTAUTH", Some("APPROVED")) => AuthipayTransactionStatus::Captured, + // For SALE transactions, "APPROVED" means completed payment + ("SALE", Some("APPROVED")) => AuthipayTransactionStatus::Captured, + // For VOID transactions, "APPROVED" means successfully voided + ("VOID", Some("APPROVED")) => AuthipayTransactionStatus::Voided, + // Generic status mappings for other cases + (_, Some("APPROVED")) => AuthipayTransactionStatus::Captured, + (_, Some("AUTHORIZED")) => AuthipayTransactionStatus::Authorized, + (_, Some("DECLINED") | Some("FAILED")) => { + AuthipayTransactionStatus::Failed + } + _ => AuthipayTransactionStatus::Processing, + } + } + } + } + } + } +} + +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct PaymentToken { + reusable: Option<bool>, + decline_duplicates: Option<bool>, + brand: Option<String>, + #[serde(rename = "type")] + token_type: Option<String>, +} + +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct PaymentMethodDetails { + payment_card: Option<PaymentCardDetails>, + payment_method_type: Option<String>, + payment_method_brand: Option<String>, +} + +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct PaymentCardDetails { + expiry_date: ExpiryDate, + bin: String, + last4: String, + brand: String, +} + +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct Processor { + reference_number: Option<String>, + authorization_code: Option<String>, + response_code: String, + response_message: String, + avs_response: Option<AvsResponse>, + security_code_response: Option<String>, + tax_refund_data: Option<serde_json::Value>, +} + +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct AvsResponse { + street_match: Option<String>, + postal_code_match: Option<String>, +} + +impl<F, T> TryFrom<ResponseRouterData<F, AuthipayPaymentsResponse, T, PaymentsResponseData>> + for RouterData<F, T, PaymentsResponseData> +{ + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: ResponseRouterData<F, AuthipayPaymentsResponse, T, PaymentsResponseData>, + ) -> Result<Self, Self::Error> { + // Get gateway response (like Fiserv pattern) + let gateway_resp = item.response.gateway_response(); + + // Store order_id in connector_metadata for void operations (like Fiserv) + let mut metadata = std::collections::HashMap::new(); + metadata.insert( + "order_id".to_string(), + serde_json::Value::String(gateway_resp.transaction_processing_details.order_id.clone()), + ); + let connector_metadata = Some(serde_json::Value::Object(serde_json::Map::from_iter( + metadata, + ))); + + Ok(Self { + status: enums::AttemptStatus::from(gateway_resp.transaction_state.clone()), + response: Ok(PaymentsResponseData::TransactionResponse { + resource_id: ResponseId::ConnectorTransactionId( + gateway_resp + .transaction_processing_details + .transaction_id + .clone(), + ), + redirection_data: Box::new(None), + mandate_reference: Box::new(None), + connector_metadata, + network_txn_id: None, + connector_response_reference_id: Some( + gateway_resp.transaction_processing_details.order_id.clone(), + ), + incremental_authorization_allowed: None, + charges: None, + }), + ..item.data + }) + } +} + +// Type definition for CaptureRequest +#[derive(Debug, Serialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct AuthipayCaptureRequest { + request_type: &'static str, + transaction_amount: Amount, +} + +impl TryFrom<&AuthipayRouterData<&PaymentsCaptureRouterData>> for AuthipayCaptureRequest { + type Error = error_stack::Report<errors::ConnectorError>; + + fn try_from( + item: &AuthipayRouterData<&PaymentsCaptureRouterData>, + ) -> Result<Self, Self::Error> { + Ok(Self { + request_type: "PostAuthTransaction", + transaction_amount: Amount { + total: item.amount, + currency: item.router_data.request.currency.to_string(), + components: None, + }, + }) + } +} + +// Type definition for VoidRequest +#[derive(Debug, Serialize, Clone, PartialEq)] +#[serde(rename_all = "camelCase")] +pub struct AuthipayVoidRequest { + request_type: &'static str, +} + +impl TryFrom<&AuthipayRouterData<&PaymentsCancelRouterData>> for AuthipayVoidRequest { + type Error = error_stack::Report<errors::ConnectorError>; + + fn try_from( + _item: &AuthipayRouterData<&PaymentsCancelRouterData>, + ) -> Result<Self, Self::Error> { + Ok(Self { + request_type: "VoidTransaction", + }) + } +} + +// Type definition for RefundRequest +#[derive(Default, Debug, Serialize)] +#[serde(rename_all = "camelCase")] +pub struct AuthipayRefundRequest { + request_type: &'static str, + transaction_amount: Amount, +} + +impl<F> TryFrom<&AuthipayRouterData<&RefundsRouterData<F>>> for AuthipayRefundRequest { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from(item: &AuthipayRouterData<&RefundsRouterData<F>>) -> Result<Self, Self::Error> { + Ok(Self { + request_type: "ReturnTransaction", + transaction_amount: Amount { + total: item.amount.to_owned(), + currency: item.router_data.request.currency.to_string(), + components: None, + }, + }) + } +} + +// Type definition for Refund Response + +#[allow(dead_code)] +#[derive(Debug, Serialize, Default, Deserialize, Clone)] +pub enum RefundStatus { + Succeeded, + Failed, + #[default] + Processing, +} + +impl From<RefundStatus> for enums::RefundStatus { + fn from(item: RefundStatus) -> Self { + match item { + RefundStatus::Succeeded => Self::Success, + RefundStatus::Failed => Self::Failure, + RefundStatus::Processing => Self::Pending, + //TODO: Review mapping + } + } +} + +// Reusing the payments response structure for refunds +// because Authipay uses the same endpoint and response format +pub type RefundResponse = AuthipayPaymentsResponse; + +impl TryFrom<RefundsResponseRouterData<Execute, RefundResponse>> for RefundsRouterData<Execute> { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: RefundsResponseRouterData<Execute, RefundResponse>, + ) -> Result<Self, Self::Error> { + let refund_status = if item.response.transaction_type == "RETURN" { + match item.response.transaction_result.as_deref() { + Some("APPROVED") => RefundStatus::Succeeded, + Some("DECLINED") | Some("FAILED") => RefundStatus::Failed, + _ => RefundStatus::Processing, + } + } else { + RefundStatus::Processing + }; + + Ok(Self { + response: Ok(RefundsResponseData { + connector_refund_id: item.response.ipg_transaction_id.to_string(), + refund_status: enums::RefundStatus::from(refund_status), + }), + ..item.data + }) + } +} + +impl TryFrom<RefundsResponseRouterData<RSync, RefundResponse>> for RefundsRouterData<RSync> { + type Error = error_stack::Report<errors::ConnectorError>; + fn try_from( + item: RefundsResponseRouterData<RSync, RefundResponse>, + ) -> Result<Self, Self::Error> { + let refund_status = if item.response.transaction_type == "RETURN" { + match item.response.transaction_result.as_deref() { + Some("APPROVED") => RefundStatus::Succeeded, + Some("DECLINED") | Some("FAILED") => RefundStatus::Failed, + _ => RefundStatus::Processing, + } + } else { + RefundStatus::Processing + }; + + Ok(Self { + response: Ok(RefundsResponseData { + connector_refund_id: item.response.ipg_transaction_id.to_string(), + refund_status: enums::RefundStatus::from(refund_status), + }), + ..item.data + }) + } +} + +// Error Response structs +#[derive(Default, Debug, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ErrorDetailItem { + pub field: String, + pub message: String, +} + +#[derive(Default, Debug, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ErrorDetails { + pub code: Option<String>, + pub message: String, + pub details: Option<Vec<ErrorDetailItem>>, +} + +#[derive(Default, Debug, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct AuthipayErrorResponse { + pub client_request_id: Option<String>, + pub api_trace_id: Option<String>, + pub response_type: Option<String>, + #[serde(rename = "type")] + pub response_object_type: Option<String>, + pub error: ErrorDetails, + pub decline_reason_code: Option<String>, +} + +impl From<&AuthipayErrorResponse> for ErrorResponse { + fn from(item: &AuthipayErrorResponse) -> Self { + Self { + status_code: 500, // Default to Internal Server Error, will be overridden by actual HTTP status + code: item.error.code.clone().unwrap_or_default(), + message: item.error.message.clone(), + reason: None, + attempt_status: None, + connector_transaction_id: None, + network_decline_code: None, + network_advice_code: None, + network_error_message: None, + } + } +} diff --git a/crates/hyperswitch_connectors/src/default_implementations.rs b/crates/hyperswitch_connectors/src/default_implementations.rs index 9cc798d57cd..38e63124029 100644 --- a/crates/hyperswitch_connectors/src/default_implementations.rs +++ b/crates/hyperswitch_connectors/src/default_implementations.rs @@ -148,6 +148,7 @@ default_imp_for_authorize_session_token!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -274,6 +275,7 @@ default_imp_for_calculate_tax!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -401,6 +403,7 @@ default_imp_for_session_update!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -528,6 +531,7 @@ default_imp_for_post_session_tokens!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -654,6 +658,7 @@ default_imp_for_create_order!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -781,6 +786,7 @@ default_imp_for_update_metadata!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -911,6 +917,7 @@ default_imp_for_complete_authorize!( connectors::Adyenplatform, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Bamboraapac, connectors::Bankofamerica, connectors::Barclaycard, @@ -1018,6 +1025,7 @@ default_imp_for_incremental_authorization!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1145,6 +1153,7 @@ default_imp_for_create_customer!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1270,6 +1279,7 @@ default_imp_for_connector_redirect_response!( connectors::Adyenplatform, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Billwerk, connectors::Bitpay, connectors::Bamboraapac, @@ -1377,6 +1387,7 @@ default_imp_for_pre_processing_steps!( connectors::Adyenplatform, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1494,6 +1505,7 @@ default_imp_for_post_processing_steps!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1622,6 +1634,7 @@ default_imp_for_approve!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1751,6 +1764,7 @@ default_imp_for_reject!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1880,6 +1894,7 @@ default_imp_for_webhook_source_verification!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2008,6 +2023,7 @@ default_imp_for_accept_dispute!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2135,6 +2151,7 @@ default_imp_for_submit_evidence!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2261,6 +2278,7 @@ default_imp_for_defend_dispute!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2397,6 +2415,7 @@ default_imp_for_file_upload!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2515,6 +2534,7 @@ default_imp_for_payouts!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2637,6 +2657,7 @@ default_imp_for_payouts_create!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2763,6 +2784,7 @@ default_imp_for_payouts_retrieve!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2891,6 +2913,7 @@ default_imp_for_payouts_eligibility!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -3017,6 +3040,7 @@ default_imp_for_payouts_fulfill!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -3140,6 +3164,7 @@ default_imp_for_payouts_cancel!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -3267,6 +3292,7 @@ default_imp_for_payouts_quote!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -3395,6 +3421,7 @@ default_imp_for_payouts_recipient!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -3522,6 +3549,7 @@ default_imp_for_payouts_recipient_account!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -3651,6 +3679,7 @@ default_imp_for_frm_sale!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -3780,6 +3809,7 @@ default_imp_for_frm_checkout!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -3909,6 +3939,7 @@ default_imp_for_frm_transaction!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -4038,6 +4069,7 @@ default_imp_for_frm_fulfillment!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -4167,6 +4199,7 @@ default_imp_for_frm_record_return!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -4293,6 +4326,7 @@ default_imp_for_revoking_mandates!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -4417,6 +4451,7 @@ default_imp_for_uas_pre_authentication!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -4543,6 +4578,7 @@ default_imp_for_uas_post_authentication!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -4670,6 +4706,7 @@ default_imp_for_uas_authentication_confirmation!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -4788,6 +4825,7 @@ default_imp_for_connector_request_id!( connectors::Adyenplatform, connectors::Airwallex, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Amazonpay, connectors::Bambora, @@ -4910,6 +4948,7 @@ default_imp_for_fraud_check!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -5061,6 +5100,7 @@ default_imp_for_connector_authentication!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -5185,6 +5225,7 @@ default_imp_for_uas_authentication!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -5304,6 +5345,7 @@ default_imp_for_revenue_recovery!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -5434,6 +5476,7 @@ default_imp_for_billing_connector_payment_sync!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -5563,6 +5606,7 @@ default_imp_for_revenue_recovery_record_back!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -5690,6 +5734,7 @@ default_imp_for_billing_connector_invoice_sync!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -5812,6 +5857,7 @@ default_imp_for_external_vault!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Barclaycard, connectors::Bambora, @@ -5940,6 +5986,7 @@ default_imp_for_external_vault_insert!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Barclaycard, connectors::Bambora, @@ -6068,6 +6115,7 @@ default_imp_for_external_vault_retrieve!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Barclaycard, connectors::Bambora, @@ -6196,6 +6244,7 @@ default_imp_for_external_vault_delete!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Barclaycard, connectors::Bambora, @@ -6324,6 +6373,7 @@ default_imp_for_external_vault_create!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Barclaycard, connectors::Bambora, diff --git a/crates/hyperswitch_connectors/src/default_implementations_v2.rs b/crates/hyperswitch_connectors/src/default_implementations_v2.rs index 7bc66a1e6cf..89a7b3de2ac 100644 --- a/crates/hyperswitch_connectors/src/default_implementations_v2.rs +++ b/crates/hyperswitch_connectors/src/default_implementations_v2.rs @@ -253,6 +253,7 @@ default_imp_for_new_connector_integration_payment!( connectors::Airwallex, connectors::Amazonpay, connectors::Adyenplatform, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -382,6 +383,7 @@ default_imp_for_new_connector_integration_refund!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -506,6 +508,7 @@ default_imp_for_new_connector_integration_connector_access_token!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -636,6 +639,7 @@ default_imp_for_new_connector_integration_accept_dispute!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -764,6 +768,7 @@ default_imp_for_new_connector_integration_submit_evidence!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -892,6 +897,7 @@ default_imp_for_new_connector_integration_defend_dispute!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1031,6 +1037,7 @@ default_imp_for_new_connector_integration_file_upload!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1162,6 +1169,7 @@ default_imp_for_new_connector_integration_payouts_create!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1293,6 +1301,7 @@ default_imp_for_new_connector_integration_payouts_eligibility!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1424,6 +1433,7 @@ default_imp_for_new_connector_integration_payouts_fulfill!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1555,6 +1565,7 @@ default_imp_for_new_connector_integration_payouts_cancel!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1686,6 +1697,7 @@ default_imp_for_new_connector_integration_payouts_quote!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1817,6 +1829,7 @@ default_imp_for_new_connector_integration_payouts_recipient!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -1948,6 +1961,7 @@ default_imp_for_new_connector_integration_payouts_sync!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2079,6 +2093,7 @@ default_imp_for_new_connector_integration_payouts_recipient_account!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2208,6 +2223,7 @@ default_imp_for_new_connector_integration_webhook_source_verification!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2339,6 +2355,7 @@ default_imp_for_new_connector_integration_frm_sale!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2470,6 +2487,7 @@ default_imp_for_new_connector_integration_frm_checkout!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2601,6 +2619,7 @@ default_imp_for_new_connector_integration_frm_transaction!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2732,6 +2751,7 @@ default_imp_for_new_connector_integration_frm_fulfillment!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2863,6 +2883,7 @@ default_imp_for_new_connector_integration_frm_record_return!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -2991,6 +3012,7 @@ default_imp_for_new_connector_integration_revoking_mandates!( connectors::Adyenplatform, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Authorizedotnet, connectors::Bambora, connectors::Bamboraapac, @@ -3110,6 +3132,7 @@ default_imp_for_new_connector_integration_frm!( connectors::Vgs, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Bambora, connectors::Bamboraapac, connectors::Barclaycard, @@ -3238,6 +3261,7 @@ default_imp_for_new_connector_integration_connector_authentication!( connectors::Vgs, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Bambora, connectors::Bamboraapac, connectors::Barclaycard, @@ -3355,6 +3379,7 @@ default_imp_for_new_connector_integration_revenue_recovery!( connectors::Vgs, connectors::Airwallex, connectors::Amazonpay, + connectors::Authipay, connectors::Bambora, connectors::Bamboraapac, connectors::Barclaycard, @@ -3485,6 +3510,7 @@ default_imp_for_new_connector_integration_external_vault!( connectors::Airwallex, connectors::Amazonpay, connectors::Archipel, + connectors::Authipay, connectors::Authorizedotnet, connectors::Barclaycard, connectors::Bambora, diff --git a/crates/hyperswitch_domain_models/src/configs.rs b/crates/hyperswitch_domain_models/src/configs.rs index 9e64262f78f..9e4b94f9465 100644 --- a/crates/hyperswitch_domain_models/src/configs.rs +++ b/crates/hyperswitch_domain_models/src/configs.rs @@ -12,6 +12,7 @@ use crate::errors::api_error_response; #[serde(default)] pub struct Connectors { pub aci: ConnectorParams, + pub authipay: ConnectorParams, pub adyen: AdyenParamsWithThreeBaseUrls, pub adyenplatform: ConnectorParams, pub airwallex: ConnectorParams, diff --git a/crates/payment_methods/src/configs/payment_connector_required_fields.rs b/crates/payment_methods/src/configs/payment_connector_required_fields.rs index 08baca7e35f..ec3ea46ccd2 100644 --- a/crates/payment_methods/src/configs/payment_connector_required_fields.rs +++ b/crates/payment_methods/src/configs/payment_connector_required_fields.rs @@ -1195,6 +1195,7 @@ impl Default for RequiredFields { fn get_cards_required_fields() -> HashMap<Connector, RequiredFieldFinal> { HashMap::from([ (Connector::Aci, fields(vec![], vec![], card_with_name())), + (Connector::Authipay, fields(vec![], vec![], card_basic())), (Connector::Adyen, fields(vec![], vec![], card_with_name())), (Connector::Airwallex, fields(vec![], card_basic(), vec![])), ( diff --git a/crates/router/src/connector.rs b/crates/router/src/connector.rs index 619608a95de..d50086f5481 100644 --- a/crates/router/src/connector.rs +++ b/crates/router/src/connector.rs @@ -4,16 +4,16 @@ pub mod utils; pub use hyperswitch_connectors::connectors::DummyConnector; pub use hyperswitch_connectors::connectors::{ aci, aci::Aci, adyen, adyen::Adyen, adyenplatform, adyenplatform::Adyenplatform, airwallex, - airwallex::Airwallex, amazonpay, amazonpay::Amazonpay, archipel, archipel::Archipel, - authorizedotnet, authorizedotnet::Authorizedotnet, bambora, bambora::Bambora, bamboraapac, - bamboraapac::Bamboraapac, bankofamerica, bankofamerica::Bankofamerica, barclaycard, - barclaycard::Barclaycard, billwerk, billwerk::Billwerk, bitpay, bitpay::Bitpay, bluesnap, - bluesnap::Bluesnap, boku, boku::Boku, braintree, braintree::Braintree, cashtocode, - cashtocode::Cashtocode, celero, celero::Celero, chargebee, chargebee::Chargebee, checkbook, - checkbook::Checkbook, checkout, checkout::Checkout, coinbase, coinbase::Coinbase, coingate, - coingate::Coingate, cryptopay, cryptopay::Cryptopay, ctp_mastercard, - ctp_mastercard::CtpMastercard, cybersource, cybersource::Cybersource, datatrans, - datatrans::Datatrans, deutschebank, deutschebank::Deutschebank, digitalvirgo, + airwallex::Airwallex, amazonpay, amazonpay::Amazonpay, archipel, archipel::Archipel, authipay, + authipay::Authipay, authorizedotnet, authorizedotnet::Authorizedotnet, bambora, + bambora::Bambora, bamboraapac, bamboraapac::Bamboraapac, bankofamerica, + bankofamerica::Bankofamerica, barclaycard, barclaycard::Barclaycard, billwerk, + billwerk::Billwerk, bitpay, bitpay::Bitpay, bluesnap, bluesnap::Bluesnap, boku, boku::Boku, + braintree, braintree::Braintree, cashtocode, cashtocode::Cashtocode, celero, celero::Celero, + chargebee, chargebee::Chargebee, checkbook, checkbook::Checkbook, checkout, checkout::Checkout, + coinbase, coinbase::Coinbase, coingate, coingate::Coingate, cryptopay, cryptopay::Cryptopay, + ctp_mastercard, ctp_mastercard::CtpMastercard, cybersource, cybersource::Cybersource, + datatrans, datatrans::Datatrans, deutschebank, deutschebank::Deutschebank, digitalvirgo, digitalvirgo::Digitalvirgo, dlocal, dlocal::Dlocal, dwolla, dwolla::Dwolla, ebanx, ebanx::Ebanx, elavon, elavon::Elavon, facilitapay, facilitapay::Facilitapay, fiserv, fiserv::Fiserv, fiservemea, fiservemea::Fiservemea, fiuu, fiuu::Fiuu, forte, forte::Forte, diff --git a/crates/router/src/core/connector_validation.rs b/crates/router/src/core/connector_validation.rs index 655636197d8..6fb5a340ba2 100644 --- a/crates/router/src/core/connector_validation.rs +++ b/crates/router/src/core/connector_validation.rs @@ -89,6 +89,10 @@ impl ConnectorAuthTypeAndMetadataValidation<'_> { archipel::transformers::ArchipelConfigData::try_from(self.connector_meta_data)?; Ok(()) } + api_enums::Connector::Authipay => { + authipay::transformers::AuthipayAuthType::try_from(self.auth_type)?; + Ok(()) + } api_enums::Connector::Authorizedotnet => { authorizedotnet::transformers::AuthorizedotnetAuthType::try_from(self.auth_type)?; Ok(()) diff --git a/crates/router/src/types/api.rs b/crates/router/src/types/api.rs index 45d6dd0d75e..eab04a9f0cc 100644 --- a/crates/router/src/types/api.rs +++ b/crates/router/src/types/api.rs @@ -328,6 +328,10 @@ impl ConnectorData { match enums::Connector::from_str(connector_name) { Ok(name) => match name { enums::Connector::Aci => Ok(ConnectorEnum::Old(Box::new(connector::Aci::new()))), + + enums::Connector::Authipay => { + Ok(ConnectorEnum::Old(Box::new(connector::Authipay::new()))) + } enums::Connector::Adyen => { Ok(ConnectorEnum::Old(Box::new(connector::Adyen::new()))) } diff --git a/crates/router/src/types/transformers.rs b/crates/router/src/types/transformers.rs index 713293568b3..35ba30da6a7 100644 --- a/crates/router/src/types/transformers.rs +++ b/crates/router/src/types/transformers.rs @@ -207,6 +207,7 @@ impl ForeignTryFrom<api_enums::Connector> for common_enums::RoutableConnectors { fn foreign_try_from(from: api_enums::Connector) -> Result<Self, Self::Error> { Ok(match from { api_enums::Connector::Aci => Self::Aci, + api_enums::Connector::Authipay => Self::Authipay, api_enums::Connector::Adyen => Self::Adyen, api_enums::Connector::Adyenplatform => Self::Adyenplatform, api_enums::Connector::Airwallex => Self::Airwallex, diff --git a/crates/router/tests/connectors/authipay.rs b/crates/router/tests/connectors/authipay.rs new file mode 100644 index 00000000000..aa362166fdf --- /dev/null +++ b/crates/router/tests/connectors/authipay.rs @@ -0,0 +1,454 @@ +use std::str::FromStr; +use masking::Secret; +use router::{ + types::{self, api, storage::enums}, + core::errors, +}; +use cards; + +use crate::utils::{self, ConnectorActions}; +use test_utils::connector_auth; + +#[derive(Clone, Copy)] +struct AuthipayTest; +impl ConnectorActions for AuthipayTest {} +impl utils::Connector for AuthipayTest { + fn get_data(&self) -> api::ConnectorData { + use router::connector::Authipay; + api::ConnectorData { + connector: Box::new(Authipay::new()), + connector_name: types::Connector::Authipay, + get_token: types::api::GetToken::Connector, + merchant_connector_id: None, + } + } + + fn get_auth_token(&self) -> types::ConnectorAuthType { + utils::to_connector_auth_type( + connector_auth::ConnectorAuthentication::new() + .authipay + .expect("Missing connector authentication configuration").into(), + ) + } + + fn get_name(&self) -> String { + "authipay".to_string() + } +} + +static CONNECTOR: AuthipayTest = AuthipayTest {}; + +fn get_default_payment_info() -> Option<utils::PaymentInfo> { + Some(utils::PaymentInfo { + payment_id: utils::get_payment_id(), + payment_method: enums::PaymentMethod::Card, + payment_method_type: Some(enums::PaymentMethodType::Credit), + amount: 100, // $1.00 + currency: enums::Currency::USD, + capture_method: Some(enums::CaptureMethod::Manual), + mandate_id: None, + setup_future_usage: None, + off_session: None, + merchant_connector_id: None, + browser_info: None, + recurring_mandate_payment: None, + router_return_url: None, + connector_meta: None, + allowed_payment_method_types: None, + pm_token: None, + payment_experience: None, + webhook_url: None, + customer_id: None, + surcharge_details: None, + connector_request_reference_id: None, + request_incremental_authorization: None, + metadata: None, + payment_type: None, + session_token: None, + terminal_id: None, + card_network: None, + capture_on: None, + incremental_authorization_allowed: None, + }) +} + +fn payment_method_details() -> Option<types::PaymentsAuthorizeData> { + Some(types::PaymentsAuthorizeData { + payment_method_data: api::PaymentMethodData::Card(api::Card { + card_number: cards::CardNumber::from_str("4035874000424977").unwrap(), // Visa test card from Authipay specs + card_exp_month: Secret::new("12".to_string()), + card_exp_year: Secret::new("2024".to_string()), + card_cvc: Secret::new("123".to_string()), + card_holder_name: Secret::new("John Doe".to_string()), + card_issuer: None, + card_network: None, + card_type: None, + card_issuing_country: None, + bank_code: None, + nick_name: Some("Default Card".to_string()), + }), + currency: enums::Currency::USD, + amount: 100, // $1.00 + router_return_url: String::from("http://localhost:8080/"), + payment_method_type: Some(enums::PaymentMethodType::Credit), + ..utils::PaymentAuthorizeType::default().0 + }) +} + +// Cards Positive Tests +// Creates a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_only_authorize_payment() { + let response = CONNECTOR + .authorize_payment(payment_method_details(), get_default_payment_info()) + .await + .expect("Authorize payment response"); + assert_eq!(response.status, enums::AttemptStatus::Authorized); +} + +// Captures a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_capture_authorized_payment() { + let response = CONNECTOR + .authorize_and_capture_payment(payment_method_details(), None, get_default_payment_info()) + .await + .expect("Capture payment response"); + assert_eq!(response.status, enums::AttemptStatus::Charged); +} + +// Partially captures a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_capture_authorized_payment() { + let response = CONNECTOR + .authorize_and_capture_payment( + payment_method_details(), + Some(types::PaymentsCaptureData { + amount_to_capture: 50, + ..utils::PaymentCaptureType::default().0 + }), + get_default_payment_info(), + ) + .await + .expect("Capture payment response"); + assert_eq!(response.status, enums::AttemptStatus::Charged); +} + +// Synchronizes a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_authorized_payment() { + let authorize_response = CONNECTOR + .authorize_payment(payment_method_details(), get_default_payment_info()) + .await + .expect("Authorize payment response"); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + let response = CONNECTOR + .psync_retry_till_status_matches( + enums::AttemptStatus::Authorized, + Some(types::PaymentsSyncData { + connector_transaction_id: types::ResponseId::ConnectorTransactionId( + txn_id.unwrap(), + ), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .expect("PSync response"); + assert_eq!(response.status, enums::AttemptStatus::Authorized,); +} + +// Voids a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_void_authorized_payment() { + let response = CONNECTOR + .authorize_and_void_payment( + payment_method_details(), + Some(types::PaymentsCancelData { + connector_transaction_id: String::from(""), + cancellation_reason: Some("requested_by_customer".to_string()), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .expect("Void payment response"); + assert_eq!(response.status, enums::AttemptStatus::Voided); +} + +// Refunds a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_manually_captured_payment() { + let response = CONNECTOR + .capture_payment_and_refund(payment_method_details(), None, None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Partially refunds a payment using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_refund_manually_captured_payment() { + let response = CONNECTOR + .capture_payment_and_refund( + payment_method_details(), + None, + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Synchronizes a refund using the manual capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_manually_captured_refund() { + let refund_response = CONNECTOR + .capture_payment_and_refund(payment_method_details(), None, None, get_default_payment_info()) + .await + .unwrap(); + let response = CONNECTOR + .rsync_retry_till_status_matches( + enums::RefundStatus::Success, + refund_response.response.unwrap().connector_refund_id, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Creates a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_make_payment() { + let authorize_response = CONNECTOR.make_payment(payment_method_details(), get_default_payment_info()).await.unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); +} + +// Synchronizes a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_auto_captured_payment() { + let authorize_response = CONNECTOR.make_payment(payment_method_details(), get_default_payment_info()).await.unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + assert_ne!(txn_id, None, "Empty connector transaction id"); + let response = CONNECTOR + .psync_retry_till_status_matches( + enums::AttemptStatus::Charged, + Some(types::PaymentsSyncData { + connector_transaction_id: types::ResponseId::ConnectorTransactionId( + txn_id.unwrap(), + ), + capture_method: Some(enums::CaptureMethod::Automatic), + ..Default::default() + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!(response.status, enums::AttemptStatus::Charged,); +} + +// Refunds a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_auto_captured_payment() { + let response = CONNECTOR + .make_payment_and_refund(payment_method_details(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Partially refunds a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_partially_refund_succeeded_payment() { + let refund_response = CONNECTOR + .make_payment_and_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + refund_response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Creates multiple refunds against a payment using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_refund_succeeded_payment_multiple_times() { + CONNECTOR + .make_payment_and_multiple_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 50, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await; +} + +// Synchronizes a refund using the automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_sync_refund() { + let refund_response = CONNECTOR + .make_payment_and_refund(payment_method_details(), None, get_default_payment_info()) + .await + .unwrap(); + let response = CONNECTOR + .rsync_retry_till_status_matches( + enums::RefundStatus::Success, + refund_response.response.unwrap().connector_refund_id, + None, + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap().refund_status, + enums::RefundStatus::Success, + ); +} + +// Cards Negative scenarios +// Creates a payment with incorrect CVC. +#[actix_web::test] +async fn should_fail_payment_for_incorrect_cvc() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: types::api::PaymentMethodData::Card(api::Card { + card_cvc: Secret::new("12345".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's security code is invalid.".to_string(), + ); +} + +// Creates a payment with incorrect expiry month. +#[actix_web::test] +async fn should_fail_payment_for_invalid_exp_month() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: api::PaymentMethodData::Card(api::Card { + card_exp_month: Secret::new("20".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's expiration month is invalid.".to_string(), + ); +} + +// Creates a payment with incorrect expiry year. +#[actix_web::test] +async fn should_fail_payment_for_incorrect_expiry_year() { + let response = CONNECTOR + .make_payment( + Some(types::PaymentsAuthorizeData { + payment_method_data: api::PaymentMethodData::Card(api::Card { + card_exp_year: Secret::new("2000".to_string()), + ..utils::CCardType::default().0 + }), + ..utils::PaymentAuthorizeType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Your card's expiration year is invalid.".to_string(), + ); +} + +// Voids a payment using automatic capture flow (Non 3DS). +#[actix_web::test] +async fn should_fail_void_payment_for_auto_capture() { + let authorize_response = CONNECTOR.make_payment(payment_method_details(), get_default_payment_info()).await.unwrap(); + assert_eq!(authorize_response.status, enums::AttemptStatus::Charged); + let txn_id = utils::get_connector_transaction_id(authorize_response.response); + assert_ne!(txn_id, None, "Empty connector transaction id"); + let void_response = CONNECTOR + .void_payment(txn_id.unwrap(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + void_response.response.unwrap_err().message, + "You cannot cancel this PaymentIntent because it has a status of succeeded." + ); +} + +// Captures a payment using invalid connector payment id. +#[actix_web::test] +async fn should_fail_capture_for_invalid_payment() { + let capture_response = CONNECTOR + .capture_payment("123456789".to_string(), None, get_default_payment_info()) + .await + .unwrap(); + assert_eq!( + capture_response.response.unwrap_err().message, + String::from("No such payment_intent: '123456789'") + ); +} + +// Refunds a payment with refund amount higher than payment amount. +#[actix_web::test] +async fn should_fail_for_refund_amount_higher_than_payment_amount() { + let response = CONNECTOR + .make_payment_and_refund( + payment_method_details(), + Some(types::RefundsData { + refund_amount: 150, + ..utils::PaymentRefundType::default().0 + }), + get_default_payment_info(), + ) + .await + .unwrap(); + assert_eq!( + response.response.unwrap_err().message, + "Refund amount (₹1.50) is greater than charge amount (₹1.00)", + ); +} + +// Connector dependent test cases goes here + +// [#478]: add unit tests for non 3DS, wallets & webhooks in connector tests diff --git a/crates/router/tests/connectors/sample_auth.toml b/crates/router/tests/connectors/sample_auth.toml index 7d5a742aaf5..a7f18afcb78 100644 --- a/crates/router/tests/connectors/sample_auth.toml +++ b/crates/router/tests/connectors/sample_auth.toml @@ -341,10 +341,16 @@ api_key = "MyApiKey" key1 = "Merchant id" api_secret = "Secret key" + +[authipay] +api_key = "MyApiKey" +api_secret = "MySecretKey" + [checkbook] api_key="Client ID" key1 ="Client Secret" + [santander] api_key="Client ID" key1 ="Client Secret" @@ -354,4 +360,5 @@ api_key="Client ID" key1="Client Secret" [payload] -api_key="API Key" \ No newline at end of file +api_key="API Key" + diff --git a/crates/test_utils/src/connector_auth.rs b/crates/test_utils/src/connector_auth.rs index 25fffd09b0f..14e08be1623 100644 --- a/crates/test_utils/src/connector_auth.rs +++ b/crates/test_utils/src/connector_auth.rs @@ -19,6 +19,7 @@ pub struct ConnectorAuthentication { pub airwallex: Option<BodyKey>, pub amazonpay: Option<HeaderKey>, pub archipel: Option<NoKey>, + pub authipay: Option<SignatureKey>, pub authorizedotnet: Option<BodyKey>, pub bambora: Option<BodyKey>, pub bamboraapac: Option<HeaderKey>, diff --git a/loadtest/config/development.toml b/loadtest/config/development.toml index b1c7a7581c4..4711699bdf9 100644 --- a/loadtest/config/development.toml +++ b/loadtest/config/development.toml @@ -82,6 +82,7 @@ airwallex.base_url = "https://api-demo.airwallex.com/" amazonpay.base_url = "https://pay-api.amazon.com/v2" applepay.base_url = "https://apple-pay-gateway.apple.com/" archipel.base_url = "https://{{merchant_endpoint_prefix}}/ArchiPEL/Transaction/v1" +authipay.base_url = "https://prod.emea.api.fiservapps.com/sandbox/ipp/payments-gateway/v2/" authorizedotnet.base_url = "https://apitest.authorize.net/xml/v1/request.api" bambora.base_url = "https://api.na.bambora.com" bamboraapac.base_url = "https://demo.ippayments.com.au/interface/api" @@ -217,6 +218,7 @@ cards = [ "airwallex", "amazonpay", "archipel", + "authipay", "authorizedotnet", "bambora", "bamboraapac", diff --git a/scripts/add_connector.sh b/scripts/add_connector.sh index 90424011957..98490f12324 100755 --- a/scripts/add_connector.sh +++ b/scripts/add_connector.sh @@ -6,7 +6,7 @@ function find_prev_connector() { git checkout $self cp $self $self.tmp # Add new connector to existing list and sort it - connectors=(aci adyen adyenplatform airwallex amazonpay applepay archipel authorizedotnet bambora bamboraapac bankofamerica barclaycard billwerk bitpay bluesnap boku braintree cashtocode celero chargebee checkbook checkout coinbase cryptopay ctp_visa cybersource datatrans deutschebank digitalvirgo dlocal dummyconnector dwolla ebanx elavon facilitapay fiserv fiservemea fiuu forte getnet globalpay globepay gocardless gpayments helcim hipay hyperswitch_vault iatapay inespay itaubank jpmorgan juspaythreedsserver klarna mifinity mollie moneris multisafepay netcetera nexinets nexixpay nomupay noon nordea novalnet nuvei opayo opennode paybox payeezy payload payme payone paypal paystack payu placetopay plaid powertranz prophetpay rapyd razorpay recurly redsys santander shift4 silverflow square stax stripe stripebilling taxjar threedsecureio thunes tokenio trustpay tsys unified_authentication_service vgs volt wellsfargo wellsfargopayout wise worldline worldpay worldpayvantiv worldpayxml xendit zsl "$1") + connectors=(aci adyen adyenplatform airwallex amazonpay applepay archipel authipay authorizedotnet bambora bamboraapac bankofamerica barclaycard billwerk bitpay bluesnap boku braintree cashtocode celero chargebee checkbook checkout coinbase cryptopay ctp_visa cybersource datatrans deutschebank digitalvirgo dlocal dummyconnector dwolla ebanx elavon facilitapay fiserv fiservemea fiuu forte getnet globalpay globepay gocardless gpayments helcim hipay hyperswitch_vault iatapay inespay itaubank jpmorgan juspaythreedsserver klarna mifinity mollie moneris multisafepay netcetera nexinets nexixpay nomupay noon nordea novalnet nuvei opayo opennode paybox payeezy payload payme payone paypal paystack payu placetopay plaid powertranz prophetpay rapyd razorpay recurly redsys santander shift4 silverflow square stax stripe stripebilling taxjar threedsecureio thunes tokenio trustpay tsys unified_authentication_service vgs volt wellsfargo wellsfargopayout wise worldline worldpay worldpayvantiv worldpayxml xendit zsl "$1") IFS=$'\n' sorted=($(sort <<<"${connectors[*]}")); unset IFS res="$(echo ${sorted[@]})"

2025-06-05T09:43:43Z

## Type of Change  - [ ] Bugfix - [x] New feature - [ ] Enhancement - [ ] Refactoring - [ ] Dependency updates - [ ] Documentation - [ ] CI/CD ## Description Cards Non-3DS payments added for authipay https://docs.fiserv.dev/public/reference/payments-intro ### Additional Changes - [ ] This PR modifies the API contract - [ ] This PR modifies the database schema - [ ] This PR modifies application configuration/environment variables  ## Motivation and Context  https://github.com/juspay/hyperswitch/issues/8398 ## How did you test it? Tested using cargo build and cypress test <img width="738" alt="Screenshot 2025-07-04 at 11 49 02 AM" src="https://github.com/user-attachments/assets/d4927935-5af6-4b14-88c4-dc1c9f723886" />  ## Checklist  - [`x`] I formatted the code `cargo +nightly fmt --all` - [`x`] I addressed lints thrown by `cargo clippy` - [`x`] I reviewed the submitted code - [ ] I added unit tests for my changes where possible

v1.115.0

c322eb9cabb2ca7a8ad0c3ed57192dde9bf7eaa4