feat(router): add endpoint for listing connector features #6612

AkshayaFoiger · 2024-11-19T12:35:58Z

Type of Change

Description

-> Why?
With new features being added, it is becoming increasingly difficult to track all the additions. This information is essential for accurately representing Hyperswitch's offerings. Having this solution will eliminate inconsistencies between the documentation and the actual implementation, ensuring clarity and alignment.

-> What?

Introduce an API endpoint that provides:
-> A list of all connectors.
-> The payment methods supported by each connector.
-> The status of these payment methods.
-> Whether these payment methods support mandates.

-> How?
-> Pre-validation for Payment Methods:
Before invoking a connector to process a payment, this function will check if the specified payment_method is implemented. This ensures developers update the relevant functions during development and testing.

-> Unified API Endpoint:
Build an endpoint that collects information from all connectors and consolidates it into a unified JSON response. This will act as a single source of truth for supported features.

Additional Changes

This PR modifies the API contract
This PR modifies the database schema
This PR modifies application configuration/environment variables

How did you test it?

Test the validation.
Create a Klarna payment with Bambora. It should fail with "payment method not supported" error.

curl --location 'http://localhost:8080/payments' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'api-key: dev_JHPIA2kkwO2PZt5kIZtkqGbjUotOyUD9ByNeEHTIVMPeLCqsU3qPIqJQ72Jtbdn5' \
--data-raw '{
    "amount": 6540,
    "currency": "GBP",
    "confirm": true,
    "capture_method": "automatic",
    "capture_on": "2022-09-10T10:11:12Z",
    "amount_to_capture": 6540,
    "customer_id": "StripeCustomer",
    "phone_country_code": "+1",
    "description": "Its my first payment request",
    "authentication_type": "no_three_ds",
    "return_url": "https://duck.com",
    "payment_method": "pay_later",
    "payment_method_type": "klarna",
    "payment_experience": "redirect_to_url",
    "payment_method_data": {
        "pay_later": {
            "klarna_redirect": {}
        },
        "billing": {
            "address": {
                "country": "GB"
            },
            "email": "[email protected]"
        }
    }  
}'

Response

{
    "error": {
        "type": "invalid_request",
        "message": "Payment method type not supported",
        "code": "IR_19",
        "reason": "pay_later is not supported by bambora"
    }
}

The payment intent status will be requires_payment_method

Test the endpoint /feature_matrix

curl --location --request GET 'http://localhost:8080/feature_matrix' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'api-key: test_admin' \
--header 'X-Merchant-Id: postman_merchant_GHAction_e70f1cfe-b545-46a4-bb39-4ceb21392117' \
--data '{
     "connectors" : ["bambora"]   // Provide list of connectors, for which you need to list the features 
                                                      // currently only implemented for bambora and deutsche bank. 
}'

Response

{
    "size": 1,
    "data": [
        {
            "connector": "bambora",
            "payment_method_types": [
                {
                    "payment_method_type": "card",
                    "payment_methods": [
                        {
                            "payment_method": "debit",
                            "availability_status": "Live",
                            "supports_mandates": false
                        },
                        {
                            "payment_method": "credit",
                            "availability_status": "Live",
                            "supports_mandates": false
                        }
                    ]
                }
            ]
        }
    ]
}

List for all connector (that implements this feature)

curl --location --request GET 'http://localhost:8080/feature_matrix' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'api-key: test_admin' \
--header 'X-Merchant-Id: postman_merchant_GHAction_e70f1cfe-b545-46a4-bb39-4ceb21392117' \
--data '{
    
}'

Response

{
    "size": 2,
    "data": [
        {
            "connector": "bambora",
            "payment_method_types": [
                {
                    "payment_method_type": "card",
                    "payment_methods": [
                        {
                            "payment_method": "credit",
                            "availability_status": "Live",
                            "supports_mandates": false
                        },
                        {
                            "payment_method": "debit",
                            "availability_status": "Live",
                            "supports_mandates": false
                        }
                    ]
                }
            ]
        },
        {
            "connector": "deutschebank",
            "payment_method_types": [
                {
                    "payment_method_type": "bank_debit",
                    "payment_methods": [
                        {
                            "payment_method": "sepa",
                            "availability_status": "Live",
                            "supports_mandates": true
                        }
                    ]
                }
            ]
        }
    ]
}

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

semanticdiff-com · 2024-11-19T12:36:01Z

Review changes with

Changed Files

File	Status
crates/router/src/types/api/payments.rs	89% smaller
crates/router/src/utils/connector_onboarding/paypal.rs	84% smaller
crates/router/src/lib.rs	75% smaller
crates/router/src/routes.rs	45% smaller
crates/router/src/core/payments/flows/authorize_flow.rs	19% smaller
crates/hyperswitch_connectors/src/connectors/deutschebank.rs	18% smaller
crates/hyperswitch_connectors/src/connectors/bambora.rs	16% smaller
crates/hyperswitch_interfaces/src/api.rs	15% smaller
crates/api_models/src/feature_matrix.rs	0% smaller
crates/api_models/src/lib.rs	0% smaller
crates/common_enums/src/enums.rs	0% smaller
crates/hyperswitch_interfaces/src/types.rs	0% smaller
crates/router/src/routes/app.rs	0% smaller
crates/router/src/routes/feature_matrix.rs	0% smaller
crates/router/src/routes/lock_utils.rs	0% smaller
crates/router/src/services/connector_integration_interface.rs	Unsupported file format
crates/router/src/types/api.rs	0% smaller
crates/router_env/src/logger/types.rs	0% smaller

Narayanbhat166 · 2024-11-20T08:01:07Z

crates/common_enums/src/enums.rs

+    Live,
+    /// Payment Method available in sandbox
+    Beta,
+    /// Payment Method not available


In my opinion this should be the default value. We cannot have Live as the default value.

Narayanbhat166 · 2024-11-20T09:56:54Z

crates/router/src/routes/feature_matrix.rs

+    let feature_matrix_response: Vec<payment_types::FeatureMatrixResponse> = connector_list
+        .into_iter()
+        .filter_map(|connector_name| {
+            api_types::ConnectorData::convert_connector(&connector_name.to_string())


why do we have so much of nesting here?

if possible try idiomatic approach and reduce the nesting

Narayanbhat166 · 2024-11-20T09:59:31Z

crates/api_models/src/feature_matrix.rs

+#[derive(Default, Debug, Deserialize, Serialize, Clone, ToSchema)]
+pub struct FeatureMatrixRequest {
+    // List of connectors for which the feature matrix is requested
+    pub connectors: Option<Vec<enums::Connector>>,


we should not accept any connector from the request, application will know how many connectors are supported, so this value should be provided by the application

Narayanbhat166 · 2024-11-20T10:00:03Z

crates/common_enums/src/enums.rs

+    ToSchema,
+)]
+#[strum(serialize_all = "snake_case")]
+pub enum PaymentMethodStage {


rename this to PaymentMethodAvailabilityStage

Narayanbhat166 · 2024-11-20T10:00:26Z

crates/common_enums/src/enums.rs

+#[strum(serialize_all = "snake_case")]
+pub enum PaymentMethodStage {
+    /// Payment Method available in production
+    #[default]


remove the default value, we should not infer any default values

Narayanbhat166 · 2024-11-20T10:01:11Z

crates/hyperswitch_connectors/src/connectors/bambora.rs

+        let mut supported_payment_methods = SupportedPaymentMethods::new();
+        let mut card_payment_method = PaymentMethodTypeMetadata::new();
+        card_payment_method.insert(
+            enums::PaymentMethodType::Credit,
+            PaymentMethodDetails {
+                availability_status: enums::PaymentMethodStage::Live,
+                supports_mandates: false,
+            },
+        );
+        card_payment_method.insert(
+            enums::PaymentMethodType::Debit,
+            PaymentMethodDetails {
+                availability_status: enums::PaymentMethodStage::Live,
+                supports_mandates: false,
+            },
+        );
+        supported_payment_methods.insert(enums::PaymentMethod::Card, card_payment_method);
+        Some(supported_payment_methods)
+    }


define a toml file for the config and get these values from that config file. That will be maintainable

Narayanbhat166 · 2024-11-20T10:02:32Z

crates/hyperswitch_interfaces/src/api.rs

+    /// fn validate_payment_method
+    fn validate_payment_method(
+        &self,
+        payment_method_type: &Option<PaymentMethodType>,


why is this optional in the request, if we want to validate this.

AkshayaFoiger added 2 commits November 17, 2024 15:37

add payment method validation

35a6128

add /feature_matrix endpoint

0e82f43

AkshayaFoiger requested review from a team as code owners November 19, 2024 12:35

AkshayaFoiger self-assigned this Nov 19, 2024

AkshayaFoiger added C-feature Category: Feature request or enhancement C-refactor Category: Refactor M-api-contract-changes Metadata: This PR involves API contract changes labels Nov 19, 2024

Merge branch 'main' into pm-details-doc

3a508bb

AkshayaFoiger changed the title ~~feat(router): add an api for listing connector features and add a payment method function~~ feat(router): add endpoint for listing connector features Nov 19, 2024

hyperswitch-bot bot removed the M-api-contract-changes Metadata: This PR involves API contract changes label Nov 19, 2024

hyperswitch-bot bot and others added 3 commits November 19, 2024 12:53

chore: run formatter

81082ec

add support for deutshebank

fc46d91

chore: run formatter

9f1e4fe

Narayanbhat166 requested changes Nov 20, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(router): add endpoint for listing connector features #6612

feat(router): add endpoint for listing connector features #6612

AkshayaFoiger commented Nov 19, 2024 •

edited

Loading

semanticdiff-com bot commented Nov 19, 2024 •

edited

Loading

Narayanbhat166 Nov 20, 2024

Narayanbhat166 Nov 20, 2024

Narayanbhat166 Nov 20, 2024

Narayanbhat166 Nov 20, 2024

Narayanbhat166 Nov 20, 2024

Narayanbhat166 Nov 20, 2024

Narayanbhat166 Nov 20, 2024

Narayanbhat166 Nov 20, 2024

feat(router): add endpoint for listing connector features #6612

Are you sure you want to change the base?

feat(router): add endpoint for listing connector features #6612

Conversation

AkshayaFoiger commented Nov 19, 2024 • edited Loading

Type of Change

Description

Additional Changes

How did you test it?

Checklist

semanticdiff-com bot commented Nov 19, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AkshayaFoiger commented Nov 19, 2024 •

edited

Loading

semanticdiff-com bot commented Nov 19, 2024 •

edited

Loading