feat(payment_methods_v2): add payment methods list endpoint

[Narayanbhat166]

Type of Change

• New feature

Description

This PR adds payment methods list endpoint for payment methods endpoint for payment methods. This will be used to display the list of payment methods that are enabled by the merchant, and also the saved payment methods by the customer.

Motivation and Context

How did you test it?

• Create a customer

curl --location 'http://localhost:8080/v2/customers' \
--header 'x-profile-id: pro_Jl8KY80C28z1mRdXcDBT' \
--header 'Content-Type: application/json' \
--header 'api-key: dev_6BoCe4RXBXF6bxdXSvDilRNJzAyC44zmEzxrQrBAswLtV2wc91CNOGUTZ2ys5Ff0' \
--data-raw '{   
    "merchant_reference_id": "customer_1735122196",
    "name": "John Doe",
    "email": "[email protected]",
    "phone": "999999999",
    "phone_country_code": "+65",
    "description": "First customer",
    "default_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"
    },
    "default_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"
    },
    "metadata": {
        "udf1": "value1",
        "new_customer": "true",
        "login_date": "2019-09-10T10:11:12Z"
    }
}'

• Create a payment method intent

curl --location 'http://localhost:8080/v2/payment-methods/create-intent' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'X-Profile-Id: pro_Jl8KY80C28z1mRdXcDBT' \
--header 'api-key: dev_6BoCe4RXBXF6bxdXSvDilRNJzAyC44zmEzxrQrBAswLtV2wc91CNOGUTZ2ys5Ff0' \
--data '{
  "customer_id": "12345_cus_0193f9043aae775099131fb81108488f"
}'

• List the payment methods

curl --location 'http://localhost:8080/v2/payment-methods/12345_pm_0193f99973757b30a97807211a19d8fc/list-payment-methods' \
--header 'api-key: dev_6BoCe4RXBXF6bxdXSvDilRNJzAyC44zmEzxrQrBAswLtV2wc91CNOGUTZ2ys5Ff0' \
--header 'Content-Type: application/json' \
--header 'x-profile-id: pro_Jl8KY80C28z1mRdXcDBT'

• Response ( given that stripe connector is created )

{
    "payment_methods_enabled": [
        {
            "payment_method_type": "card_redirect",
            "payment_method_subtype": "card_redirect",
            "required_fields": []
        },
        {
            "payment_method_type": "card",
            "payment_method_subtype": "credit",
            "required_fields": [
                {
                    "required_field": "payment_method_data.card.card_number",
                    "display_name": "card_number",
                    "field_type": "user_card_number",
                    "value": null
                },
                {
                    "required_field": "payment_method_data.card.card_exp_year",
                    "display_name": "card_exp_year",
                    "field_type": "user_card_expiry_year",
                    "value": null
                },
                {
                    "required_field": "payment_method_data.card.card_cvc",
                    "display_name": "card_cvc",
                    "field_type": "user_card_cvc",
                    "value": null
                },
                {
                    "required_field": "payment_method_data.card.card_exp_month",
                    "display_name": "card_exp_month",
                    "field_type": "user_card_expiry_month",
                    "value": null
                }
            ]
        },
        {
            "payment_method_type": "card",
            "payment_method_subtype": "debit",
            "required_fields": []
        }
    ],
    "customer_payment_methods": null
}

Checklist

• I formatted the code cargo +nightly fmt --all
• I addressed lints thrown by cargo clippy
• I reviewed the submitted code

[semanticdiff-com]

Review changes with  

Changed Files

File	Status
crates/router/src/core/webhooks/incoming_v2.rs	96% smaller
crates/router/src/routes/app.rs	70% smaller
crates/router/src/core/admin.rs	50% smaller
crates/hyperswitch_domain_models/src/merchant_connector_account.rs	47% smaller
crates/router/src/core/payments/payment_methods.rs	46% smaller
crates/router/src/core/routing/helpers.rs	46% smaller
crates/router/src/core/payment_methods/transformers.rs	36% smaller
crates/router/src/core/payment_methods/cards.rs	36% smaller
api-reference-v2/mint.json	36% smaller
api-reference-v2/openapi_spec.json	28% smaller
crates/openapi/src/openapi_v2.rs	26% smaller
crates/router/src/configs/defaults/payment_connector_required_fields.rs	25% smaller
crates/common_utils/src/events.rs	23% smaller
crates/router_env/src/logger/config.rs	18% smaller
crates/api_models/src/payment_methods.rs	16% smaller
api-reference/openapi_spec.json	10% smaller
crates/api_models/src/payments.rs	7% smaller
crates/openapi/src/routes/payment_method.rs	6% smaller
crates/router/src/core/payment_methods.rs	2% smaller
crates/api_models/src/connector_enums.rs	1% smaller
crates/common_utils/src/id_type/global_id/payment_methods.rs	1% smaller
Cargo.lock	Unsupported file format
api-reference-v2/api-reference/payment-methods/payment-method--payment-methods-list.mdx	Unsupported file format
config/development.toml	Unsupported file format
config/payment_required_fields_v2.toml	Unsupported file format
crates/api_models/src/admin.rs	0% smaller
crates/api_models/src/events.rs	0% smaller
crates/api_models/src/events/payment.rs	0% smaller
crates/common_enums/src/connector_enums.rs	0% smaller
crates/diesel_models/src/merchant_connector_account.rs	0% smaller
crates/openapi/src/openapi.rs	0% smaller
crates/openapi/src/routes.rs	0% smaller
crates/router/Cargo.toml	Unsupported file format
crates/router/src/configs/defaults/payout_required_fields.rs	0% smaller
crates/router/src/configs/settings.rs	0% smaller
crates/router/src/core/apple_pay_certificates_migration.rs	0% smaller
crates/router/src/core/disputes.rs	0% smaller
crates/router/src/core/payments/flows/session_flow.rs	0% smaller
crates/router/src/core/payments/helpers.rs	0% smaller
crates/router/src/core/payouts/transformers.rs	0% smaller
crates/router/src/core/relay.rs	0% smaller
crates/router/src/core/relay/utils.rs	0% smaller
crates/router/src/core/user/dashboard_metadata.rs	0% smaller
crates/router/src/db/merchant_connector_account.rs	0% smaller
crates/router/src/routes/disputes.rs	0% smaller
crates/router/src/routes/payment_methods.rs	0% smaller
crates/router/src/routes/user.rs	0% smaller

[SanchithHegde]

Do we need this enum variant, is this being used anywhere?

[Narayanbhat166]

This is being used when we receive only global_payment_method_id in the request

[Sarthak1799]

There are conflicts @Narayanbhat166
Also I think the entire development.toml file has been formatted.

[Sarthak1799]

What's the use case for a default Payment Method in v2?