feat(payment_methods_v2): add payment methods list endpoint #6938

Narayanbhat166 · 2024-12-25T10:24:27Z

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'

Checklist

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

…methods list

…payment methods list" This reverts commit 70cb8a1.

…s optional

semanticdiff-com · 2024-12-25T10:24:29Z

Review changes with

Changed Files

File	Status
crates/router/src/routes/app.rs	70% 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
crates/openapi/src/openapi_v2.rs	33% smaller
api-reference-v2/openapi_spec.json	25% smaller
crates/api_models/src/events/payment.rs	12% smaller
crates/api_models/src/payment_methods.rs	9% smaller
crates/openapi/src/routes/payment_method.rs	6% smaller
crates/router/src/core/payment_methods.rs	3% smaller
crates/common_utils/src/id_type/global_id/payment_methods.rs	1% smaller
api-reference-v2/api-reference/payment-methods/payment-method--payment-methods-list.mdx	Unsupported file format
config/development.toml	Unsupported file format
crates/api_models/src/payments.rs	0% smaller
crates/common_utils/src/events.rs	0% smaller
crates/hyperswitch_domain_models/src/merchant_connector_account.rs	0% smaller
crates/router/src/core/payments/payment_methods.rs	0% smaller
crates/router/src/routes/payment_methods.rs	0% smaller

SanchithHegde · 2024-12-25T10:36:24Z

crates/api_models/src/payment_methods.rs

@@ -776,6 +765,10 @@ pub struct PaymentMethodResponse {
 #[cfg(all(feature = "v2", feature = "payment_methods_v2"))]
 #[derive(Debug, serde::Deserialize, serde::Serialize, ToSchema, Clone)]
 pub struct PaymentMethodResponse {
+    /// The unique identifier of the Payment method
+    #[schema(value_type = String, example = "card_rGK4Vi5iSW70MY7J2mIg")]


Nit: Could you update the example here?

SanchithHegde · 2024-12-25T10:37:03Z

crates/api_models/src/payment_methods.rs

+    /// The list of payment methods that are enabled for the business profile
+    #[schema(value_type = Vec<ResponsePaymentMethodTypes>)]
+    pub payment_methods_enabled: Vec<ResponsePaymentMethodTypes>,
+
+    /// The list of payment methods that are saved by the given customer
+    /// This field is only returned if the customer_id is provided in the request
+    #[schema(value_type = Option<Vec<CustomerPaymentMethod>>)]
+    pub customer_payment_methods: Option<Vec<CustomerPaymentMethod>>,


I don't think the value_type necessarily needs to be specified for both the fields.

SanchithHegde · 2024-12-25T10:38:01Z

config/development.toml

-ttl_for_storage_in_secs = 220752000
+host = "http://127.0.0.1:3000"
+host_rs = "http://127.0.0.1:3000"
+mock_locker = false


Specifying mock_locker = false would force everyone running the application locally to set up the card vault. Is that the intended behavior?

SanchithHegde · 2024-12-25T10:38:56Z

crates/api_models/src/payment_methods.rs

@@ -1758,9 +1758,11 @@ pub struct PaymentMethodDeleteResponse {
 #[derive(Debug, serde::Serialize, ToSchema)]
 pub struct PaymentMethodDeleteResponse {
    /// The unique identifier of the Payment method
-    #[schema(example = "card_rGK4Vi5iSW70MY7J2mIg")]
-    pub payment_method_id: String,
+    #[schema(value_type = String, example = "card_rGK4Vi5iSW70MY7J2mIg")]


Nit: Can you update the example here?

SanchithHegde · 2024-12-25T10:39:48Z

crates/api_models/src/payments.rs

    #[schema(value_type = Vec<ResponsePaymentMethodTypes>)]
-    pub payment_methods_enabled: Vec<payment_methods::ResponsePaymentMethodTypes>,
+    pub payment_methods_enabled: Vec<ResponsePaymentMethodTypesForPayments>,


Should we update the value_type here?

SanchithHegde · 2024-12-25T10:40:05Z

crates/api_models/src/payments.rs

+    #[schema(example = "klarna", value_type = PaymentMethodType)]
+    pub payment_method_type: common_enums::PaymentMethod,


Suggested change

#[schema(example = "klarna", value_type = PaymentMethodType)]

pub payment_method_type: common_enums::PaymentMethod,

#[schema(example = "klarna", value_type = PaymentMethod)]

pub payment_method_type: common_enums::PaymentMethod,

SanchithHegde · 2024-12-25T10:41:50Z

crates/common_utils/src/events.rs

+    #[cfg(feature = "v2")]
+    PaymentMethodListForPaymentMethods {
+        payment_method_id: id_type::GlobalPaymentMethodId,
+    },


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

SanchithHegde · 2024-12-25T10:45:01Z

crates/router/src/routes/app.rs

+                )
+                .service(
+                    web::resource("/update-saved-payment-method")
+                        .route(web::patch().to(payment_methods::payment_method_update_api)),


Is this supposed to be put(), to keep things consistent with the other v2 APIs?

@Sarthak1799

SanchithHegde and others added 30 commits December 6, 2024 15:13

chore: add comments with improvements to be made in merchant payment …

70cb8a1

…methods list

Merge branch 'main' into initial-merchant-payment-method-list-v2

947795f

refactor: change payment_methods_enabled column to type for v2

3e7833f

feat(payments_v2): implement payment methods list for v2

560d3f6

feat(payments_v2): add customers_payment_methods in pm list

09acb50

feat(payments_v2): add list_payment_methods to openapi

940e2c1

feat(payments_v2): add list_payment_methods to openapi

19ae04f

chore: run formatter

f895608

chore: add doc comments

1096cbe

Merge branch 'main' into initial-merchant-payment-method-list-v2

db9652e

refactor: address PR comments

b6ab7d2

Revert "chore: add comments with improvements to be made in merchant …

6a2c2c1

…payment methods list" This reverts commit 70cb8a1.

docs(openapi): re-generate OpenAPI specification

fac8521

chore: cargo clippy

65f8113

Merge branch 'main' into initial-merchant-payment-method-list-v2

2b5216e

chore: rename fields

593df4d

Merge branch 'main' into initial-merchant-payment-method-list-v2

fbcf8aa

chore: rename fields

6938d61

chore: cargo clippy

5d51092

chore: fix openapi

c92ced0

Merge branch 'main' into initial-merchant-payment-method-list-v2

28bf4ba

chore: add .vscode/settings to gitignore

a6f1da5

refactor: move payment methods type to common_types

c3dd71d

chore: run formatter

32122ad

Merge branch 'main' into initial-merchant-payment-method-list-v2

31360f9

chore: cargo clippy_v2

fc2453c

chore: fix openapi

60a82e2

chore: cargo clippy_v2

7618c9d

chore: add extra information enum and make customer_payment_methods a…

a801fed

…s optional

docs(openapi): re-generate OpenAPI specification

79c2a5b

Narayanbhat166 and others added 17 commits December 20, 2024 18:06

chore: add serde flatten

4acd9e0

docs(openapi): re-generate OpenAPI specification

a4c5b93

chore: change route to use kebab-case

d58841d

docs(openapi): re-generate OpenAPI specification

5025e64

refactor: fix openapi

51ad828

docs(openapi): re-generate OpenAPI specification

40146e5

fix: openapi_v2

ac8074d

Merge branch 'main' into initial-merchant-payment-method-list-v2

d186904

chore: cargo clippy_v2

7ae9fb4

chore: merge fixes

5bc9c59

chore: remove specific imports

eaff74e

Merge branch 'main' into payment_methods_list_for_payment_methods

b10edf9

chore: remove redundant code because of merge conflicts

ea72deb

refactor: add locker config

c4b9b72

Merge branch 'main' into payment_methods_list_for_payment_methods

c90cc04

feat(payment_methods): add payment methods list

4f31d6a

Merge branch 'main' into payment_methods_list_for_payment_methods

22ae53e

Narayanbhat166 self-assigned this Dec 25, 2024

Narayanbhat166 requested review from a team as code owners December 25, 2024 10:24

docs(openapi): re-generate OpenAPI specification

89f90c6

hyperswitch-bot bot added the M-api-contract-changes Metadata: This PR involves API contract changes label Dec 25, 2024

SanchithHegde reviewed Dec 25, 2024

View reviewed changes

feat: add openapi endpoints for payment methods list

289b0e5

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(payment_methods_v2): add payment methods list endpoint #6938

feat(payment_methods_v2): add payment methods list endpoint #6938

Narayanbhat166 commented Dec 25, 2024 •

edited

Loading

semanticdiff-com bot commented Dec 25, 2024 •

edited

Loading

SanchithHegde Dec 25, 2024

SanchithHegde Dec 25, 2024 •

edited

Loading

SanchithHegde Dec 25, 2024

SanchithHegde Dec 25, 2024

SanchithHegde Dec 25, 2024

SanchithHegde Dec 25, 2024

SanchithHegde Dec 25, 2024

SanchithHegde Dec 25, 2024

Narayanbhat166 Dec 25, 2024

		#[schema(example = "klarna", value_type = PaymentMethodType)]
		pub payment_method_type: common_enums::PaymentMethod,

feat(payment_methods_v2): add payment methods list endpoint #6938

Are you sure you want to change the base?

feat(payment_methods_v2): add payment methods list endpoint #6938

Conversation

Narayanbhat166 commented Dec 25, 2024 • edited Loading

Type of Change

Description

Motivation and Context

How did you test it?

Checklist

semanticdiff-com bot commented Dec 25, 2024 • edited Loading

Choose a reason for hiding this comment

SanchithHegde Dec 25, 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

Narayanbhat166 commented Dec 25, 2024 •

edited

Loading

semanticdiff-com bot commented Dec 25, 2024 •

edited

Loading

SanchithHegde Dec 25, 2024 •

edited

Loading