feat(payments_v2): implement create and confirm setup intent flow

[SanchithHegde]

Type of Change

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

Description

This PR introduces the setup intent flow for payments v2. As of now, this PR includes a single endpoint that handles both the create intent and confirm intent steps. This is done so as to allow the payment methods v2 endpoints to create multiple-use tokens for a specified customer's payment method. The implementation mostly builds on top of payment create intent v2 and payment confirm intent v2 implementations. Note that the API contract is not finalized and is possibly subject to change.

Let me know if I should include this endpoint in the OpenAPI specification and Mintlify reference.

Additional Changes

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

This PR introduces a new setup intent endpoint for payments v2.

Motivation and Context

The endpoint introduced in this PR would allow the creation of multiple-use tokens by the payments methods v2 endpoints.

How did you test it?

1. Using the v2 endpoints, create an organization, merchant account, profile, API key and merchant connector account.

2. Call the setup intent endpoint:

   • Since the request body is a union of the payment create intent v2 and payment confirm intent v2 request bodies, the required fields for this endpoint are amount_details, payment_method_data, payment_method_type and payment_method_subtype.

   The request and response are included below:

   $ curl --location 'http://localhost:8080/v2/payments/setup-intent' \
       --header 'x-profile-id: pro_9UhMqBMEOooRIvJFFdeW' \
       --header 'Content-Type: application/json' \
       --header 'api-key: <API key>' \
       --data '{
           "amount_details": {
               "order_amount": 0,
               "currency": "USD"
           },
           "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"
       }'
   {
       "confirm_intent_response": {
           "id": "12345_pay_01949d17c4637540ae2a1d96a449ed63",
           "status": "succeeded",
           "amount": {
               "order_amount": 0,
               "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": 0,
               "amount_to_capture": null,
               "amount_capturable": 0,
               "amount_captured": 0
           },
           "customer_id": null,
           "connector": "stripe",
           "client_secret": "12345_pay_01949d17c4637540ae2a1d96a449ed63_secret_01949d17c4647323a1f55b7c5ef73b6e",
           "created": "2025-01-25T10:52:48.100Z",
           "payment_method_data": {
               "billing": null
           },
           "payment_method_type": "card",
           "payment_method_subtype": "credit",
           "next_action": null,
           "connector_transaction_id": "seti_1Ql6yqD5R7gDAGffgNCIGUVI",
           "connector_reference_id": null,
           "merchant_connector_id": "mca_oC8RE28uRRcVKDjgwfzG",
           "browser_info": null,
           "error": null
       },
       "connector_mandate_reference_id": {
           "connector_mandate_id": "pm_1Ql6yqD5R7gDAGff11qr6pqg",
           "payment_method_id": null,
           "update_history": null,
           "mandate_metadata": null,
           "connector_mandate_request_reference_id": null
       }
   }

   • Additional fields may be passed in the request, such as customer_id, etc. which would be reflected in the response and database entries.

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/routes/app.rs	75% smaller
crates/router/src/types/api/payments.rs	74% smaller
crates/hyperswitch_domain_models/src/payments/payment_attempt.rs	51% smaller
crates/router/src/routes/lock_utils.rs	26% smaller
crates/hyperswitch_domain_models/src/router_data.rs	13% smaller
crates/api_models/src/events/payment.rs	10% smaller
crates/router/src/core/payments/flows/setup_mandate_flow.rs	8% smaller
crates/api_models/src/payments.rs	0% smaller
crates/diesel_models/src/payment_attempt.rs	0% smaller
crates/hyperswitch_domain_models/src/router_response_types.rs	0% smaller
crates/router/src/core/payments.rs	0% smaller
crates/router/src/core/payments/operations/payment_response.rs	0% smaller
crates/router/src/core/payments/transformers.rs	0% smaller
crates/router/src/routes/payments.rs	0% smaller
crates/router/src/services/api.rs	0% smaller
crates/router_env/src/logger/types.rs	0% smaller

[SanchithHegde]

Had to move this as a separate struct because of the clippy::large_enum_variant lint being thrown.

[SanchithHegde]

This is almost entirely a copy-paste of the implementation of the Autorize flow. Didn't bother to reduce code duplication between these two implementations.

[SanchithHegde]

Again, a copy-paste of the authorize flow implementation.

[SanchithHegde]

Let me know if the path needs to be changed.

[SanchithHegde]

Removed this redundant log line, since the response is being logged (with the same key) on line 589, before the match block.

[jarnura]

This API is not setup-intent, it is just /payments. The term we need to use payments and not setup-intent.

[jarnura]

This can be a normal payments_intent_core(PaymentCreateIntent), why we need a separate one?