feat(router): add endpoint for listing connector features

[AkshayaFoiger]

Type of Change

• Bugfix
• New feature
• Enhancement
• Refactoring
• Dependency updates
• Documentation
• CI/CD

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

2. 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]

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