feat(router): Add v2 endpoint to list payment attempts by intent_id by aniketburman014 · Pull Request #8368 · juspay/hyperswitch

aniketburman014 · 2025-06-17T15:08:52Z

Type of Change

Description

This PR introduces an API to list all payment attempts associated with a given intent_id.

Why this is needed:

In payment flows that involve retries—such as smart , cascading retires —a single payment intent may result in multiple attempts. Previously, there was no clean way to retrieve all these attempts together.

Implemented API Flow:

Adds a new endpoint: GET /v2/payments/{intent_id}/list_attempts
Validates the request and ensures merchant authorization
Retrieves all associated payment attempts linked to that intent_id

Additional Changes

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

Motivation and Context

How did you test it?

I inserted two payment attempts for a payment intent as part of testing.

Curl

curl --location 'http://localhost:8080/v2/payments/12345_pay_01978809316e7850b05ab92288ed7746/list_attempts' \
--header 'Content-Type: application/json' \
--header 'x-profile-id: pro_pF6sS2TBfhg0Vdp6N04E' \
--header 'api-key: dev_bzJEoDI7SlTyV0M7Vq6VdtCtbKGwOPphw39wD1mYdu8rY3GoydtnymDbkkMxDopB' \
--header 'Authorization: api-key=dev_bzJEoDI7SlTyV0M7Vq6VdtCtbKGwOPphw39wD1mYdu8rY3GoydtnymDbkkMxDopB'

Response

{
    "payment_attempts": [
        {
            "id": "12345_att_01975ae7bf32760282f479794fbf810c",
            "status": "failure",
            "amount": {
                "net_amount": 10000,
                "amount_to_capture": null,
                "surcharge_amount": null,
                "tax_on_surcharge": null,
                "amount_capturable": 10000,
                "shipping_cost": null,
                "order_tax_amount": null
            },
            "connector": "stripe",
            "error": null,
            "authentication_type": "no_three_ds",
            "created_at": "2025-06-17T13:50:49.173Z",
            "modified_at": "2025-06-17T13:50:49.173Z",
            "cancellation_reason": null,
            "payment_token": null,
            "connector_metadata": null,
            "payment_experience": null,
            "payment_method_type": "card",
            "connector_reference_id": null,
            "payment_method_subtype": "credit",
            "connector_payment_id": {
                "TxnId": "ch_3RYW3N06IkU6uKNZ01mrX2tD"
            },
            "payment_method_id": null,
            "client_source": null,
            "client_version": null,
            "feature_metadata": {
                "revenue_recovery": {
                    "attempt_triggered_by": "external"
                }
            }
        },
        {
            "id": "12345_att_01975ae7bf32760282f479794fbf810d",
            "status": "failure",
            "amount": {
                "net_amount": 10000,
                "amount_to_capture": null,
                "surcharge_amount": null,
                "tax_on_surcharge": null,
                "amount_capturable": 10000,
                "shipping_cost": null,
                "order_tax_amount": null
            },
            "connector": "stripe",
            "error": null,
            "authentication_type": "no_three_ds",
            "created_at": "2025-06-17T13:51:16.812Z",
            "modified_at": "2025-06-17T13:51:16.812Z",
            "cancellation_reason": null,
            "payment_token": null,
            "connector_metadata": null,
            "payment_experience": null,
            "payment_method_type": "card",
            "connector_reference_id": null,
            "payment_method_subtype": "credit",
            "connector_payment_id": {
                "TxnId": "ch_3RYW3N06IkU6uKNZ01mrX2tD"
            },
            "payment_method_id": null,
            "client_source": null,
            "client_version": null,
            "feature_metadata": {
                "revenue_recovery": {
                    "attempt_triggered_by": "external"
                }
            }
        }
    ]
}

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 · 2025-06-17T15:08:55Z

Review changes with

Changed Files

File	Status
crates/router/src/routes/lock_utils.rs	85% smaller
crates/router/src/types/api/payments.rs	58% smaller
crates/router/src/core/payments/operations.rs	29% smaller
crates/router/src/routes/app.rs	17% smaller
crates/api_models/src/events/payment.rs	8% smaller
crates/openapi/src/openapi_v2.rs	3% smaller
crates/router/src/core/payments.rs	2% smaller
api-reference/v2/openapi_spec_v2.json	0% smaller
crates/api_models/src/payments.rs	0% smaller
crates/hyperswitch_domain_models/src/payments.rs	0% smaller
crates/hyperswitch_domain_models/src/router_flow_types/payments.rs	0% smaller
crates/router/src/core/payments/operations/payment_attempt_list.rs	0% smaller
crates/router/src/core/payments/transformers.rs	0% smaller
crates/router/src/routes/payments.rs	0% smaller
crates/router_env/src/logger/types.rs	0% smaller

crates/hyperswitch_domain_models/src/router_flow_types/payments.rs

crates/router/src/routes/app.rs

crates/router/src/core/payments.rs

crates/router/src/types/api/payments.rs

srujanchikke · 2025-06-19T06:35:46Z

We need add get attempt list fetch in revenue recovery incoming webhooks flow instead of fetching attempt list via payment get.

hrithikesh026 · 2025-06-19T16:20:05Z

crates/router/src/routes/app.rs

                    web::resource("/confirm-intent")
                        .route(web::post().to(payments::payment_confirm_intent)),
                )
+                .service(


Please generate open-api spec for this endpoint and validate it.

Nit: If you want the endpoint included in the API reference, then you'd have to update the Mintlify docs / config file as well.

SanchithHegde

Other than that, looks good to me!

SanchithHegde · 2025-06-19T18:16:09Z

crates/api_models/src/payments.rs

 }
+#[cfg(feature = "v2")]
+#[derive(Debug, serde::Serialize, serde::Deserialize, Clone, ToSchema)]
+pub struct PaymentAttemptListRequest {


Nit: Would appreciate documentation comments being added.

SanchithHegde · 2025-06-19T18:19:06Z

crates/router/src/core/payments/operations.rs

 #[cfg(feature = "v2")]
 pub mod payment_update_intent;
+#[cfg(feature = "v2")]
+pub mod proxy_payments_intent;


Nit: We should consider renaming the module to be proxy_payment_intent instead (not payments intent).

SanchithHegde · 2025-06-19T18:20:30Z

crates/router/src/routes/app.rs

                    web::resource("/confirm-intent")
                        .route(web::post().to(payments::payment_confirm_intent)),
                )
+                .service(


Nit: If you want the endpoint included in the API reference, then you'd have to update the Mintlify docs / config file as well.

SanchithHegde · 2025-06-19T18:22:41Z

crates/router_env/src/logger/types.rs

    /// Payments create and confirm intent flow
    PaymentsCreateAndConfirmIntent,
+    /// Payment attempt list flow
+    PaymentAttemptsList,


Nit: We might want to consider naming this as PaymentsAttemptsList, to maintain consistency with the other payments related enum variants.

…8368) Co-authored-by: Aniket Burman <aniket.burman@Aniket-Burman-JDXHW2PH34.local> Co-authored-by: hyperswitch-bot[bot] <148525504+hyperswitch-bot[bot]@users.noreply.github.com>

attempt list api

9650314

aniketburman014 requested review from a team as code owners June 17, 2025 15:08

chore: run formatter

c6ab4b5

aniketburman014 self-assigned this Jun 18, 2025

aniketburman014 changed the title ~~attempt list api~~ feat(router): Add v2 endpoint to list payment attempts by intent_id Jun 18, 2025

aniketburman014 linked an issue Jun 18, 2025 that may be closed by this pull request

feat(router): Add v2 endpoint to list payment attempts by intent_id #8377

Closed

srujanchikke reviewed Jun 18, 2025

View reviewed changes

aniketburman014 and others added 4 commits June 19, 2025 13:14

Merge branch 'main' into payment_attempt_list

15fcf1f

name changes

4fae87f

chore: run formatter

5afb5e6

change name

34b72dc

srujanchikke previously approved these changes Jun 19, 2025

View reviewed changes

aniketburman014 added the api-v2 label Jun 19, 2025

maverox previously approved these changes Jun 19, 2025

View reviewed changes

tsdk02 previously approved these changes Jun 19, 2025

View reviewed changes

hrithikesh026 reviewed Jun 19, 2025

View reviewed changes

spec.json changes

54bffa9

aniketburman014 dismissed stale reviews from tsdk02, maverox, and srujanchikke via 54bffa9 June 19, 2025 16:53

hyperswitch-bot bot added the M-api-contract-changes Metadata: This PR involves API contract changes label Jun 19, 2025

aniketburman014 requested review from hrithikesh026, maverox, srujanchikke and tsdk02 June 19, 2025 16:54

tsdk02 approved these changes Jun 19, 2025

View reviewed changes

srujanchikke approved these changes Jun 19, 2025

View reviewed changes

hrithikesh026 approved these changes Jun 19, 2025

View reviewed changes

SanchithHegde approved these changes Jun 19, 2025

View reviewed changes

maverox approved these changes Jun 20, 2025

View reviewed changes

likhinbopanna added this pull request to the merge queue Jun 20, 2025

Merged via the queue into main with commit 7943fb4 Jun 20, 2025
15 of 20 checks passed

likhinbopanna deleted the payment_attempt_list branch June 20, 2025 06:58

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(router): Add v2 endpoint to list payment attempts by intent_id#8368

feat(router): Add v2 endpoint to list payment attempts by intent_id#8368
likhinbopanna merged 7 commits intomainfrom
payment_attempt_list

aniketburman014 commented Jun 17, 2025 •

edited

Loading

Uh oh!

semanticdiff-com bot commented Jun 17, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

srujanchikke commented Jun 19, 2025

Uh oh!

hrithikesh026 Jun 19, 2025

Uh oh!

aniketburman014 Jun 19, 2025

Uh oh!

SanchithHegde Jun 19, 2025

Uh oh!

SanchithHegde left a comment

Uh oh!

SanchithHegde Jun 19, 2025

Uh oh!

SanchithHegde Jun 19, 2025

Uh oh!

SanchithHegde Jun 19, 2025

Uh oh!

SanchithHegde Jun 19, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Conversation

aniketburman014 commented Jun 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Type of Change

Description

Why this is needed:

Implemented API Flow:

Additional Changes

Motivation and Context

How did you test it?

Curl

Response

Checklist

Uh oh!

semanticdiff-com bot commented Jun 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

srujanchikke commented Jun 19, 2025

Uh oh!

hrithikesh026 Jun 19, 2025

Choose a reason for hiding this comment

Uh oh!

aniketburman014 Jun 19, 2025

Choose a reason for hiding this comment

Uh oh!

SanchithHegde Jun 19, 2025

Choose a reason for hiding this comment

Uh oh!

SanchithHegde left a comment

Choose a reason for hiding this comment

Uh oh!

SanchithHegde Jun 19, 2025

Choose a reason for hiding this comment

Uh oh!

SanchithHegde Jun 19, 2025

Choose a reason for hiding this comment

Uh oh!

SanchithHegde Jun 19, 2025

Choose a reason for hiding this comment

Uh oh!

SanchithHegde Jun 19, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

aniketburman014 commented Jun 17, 2025 •

edited

Loading

semanticdiff-com bot commented Jun 17, 2025 •

edited

Loading