feat(payment_methods): payment method id retrieval from payment token for V2 #10834

su-shivanshmathur · 2026-01-06T06:48:59Z

Type of Change

Adding a new API for getting Payment Method Id ( GlobalPaymentMethodId ) from the payment token provided to it

Description

There is no way of getting the Payment method ID for the given token for now, so adding an API for the usecase

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?

Create a Payment Method Session

Request

curl --location 'http://localhost:8080/v2/payment-method-sessions' \
--header 'x-profile-id: pro_9K59ZyPdQhHp2fgnk9FW' \
--header 'Authorization: api-key=API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "customer_id": "12345_cus_019b5979a1387ed1b3b314cbb56a656d",
     "billing": {
        "address": {
            "first_name": "John",
            "last_name": "Dough"
        },
        "email": "[email protected]"
    }
}'

Response

{
    "id": "12345_pms_019b904d507e73708c9480d1a1e050a7",
    "customer_id": "12345_cus_019b5979a1387ed1b3b314cbb56a656d",
    "billing": {
        "address": {
            "city": null,
            "country": null,
            "line1": null,
            "line2": null,
            "line3": null,
            "zip": null,
            "state": null,
            "first_name": "John",
            "last_name": "Dough",
            "origin_zip": null
        },
        "phone": null,
        "email": "[email protected]"
    },
    "psp_tokenization": null,
    "network_tokenization": null,
    "tokenization_data": null,
    "expires_at": "2026-01-05T22:50:44.638Z",
    "client_secret": "cs_019b904d507f7481be1d6717714526e1",
    "return_url": null,
    "next_action": null,
    "authentication_details": null,
    "associated_payment_methods": null,
    "associated_token_id": null,
    "storage_type": null
}

Confirm Payment method session

Request

curl --location 'http://localhost:8080/v2/payment-method-sessions/12345_pms_019b904d507e73708c9480d1a1e050a7/confirm' \
--header 'x-profile-id: pro_9K59ZyPdQhHp2fgnk9FW' \
--header 'Authorization: publishable-key=pk_dev_4fb8a872ef0c4a208d8aa4ae0c314f49,client-secret=cs_019b904d507f7481be1d6717714526e1' \
--header 'Content-Type: application/json' \
--data '{
    "payment_method_data": {
        "card": {
            "card_number": "4242424242424242",
            "card_exp_month": "10",
            "card_exp_year": "25",
            "card_holder_name": "John Doe",
            "card_cvc": "100"
        }
    },
    "payment_method_type": "card",
    "payment_method_subtype": "credit"
}'

Response

{
    "id": "12345_pms_019b904d507e73708c9480d1a1e050a7",
    "customer_id": "12345_cus_019b5979a1387ed1b3b314cbb56a656d",
    "billing": {
        "address": {
            "city": null,
            "country": null,
            "line1": null,
            "line2": null,
            "line3": null,
            "zip": null,
            "state": null,
            "first_name": "John",
            "last_name": "Dough",
            "origin_zip": null
        },
        "phone": null,
        "email": "[email protected]"
    },
    "psp_tokenization": null,
    "network_tokenization": null,
    "tokenization_data": null,
    "expires_at": "2026-01-05T22:50:44.638Z",
    "client_secret": "CLIENT_SECRET_REDACTED",
    "return_url": null,
    "next_action": null,
    "authentication_details": null,
    "associated_payment_methods": [
        "token_OVci7wWJf28RjQPWaJD1"
    ],
    "associated_token_id": null,
    "storage_type": null
}

Get API to get payment method ID from token

curl -v --location 'http://localhost:8080/v2/payment-methods/token/token_OVci7wWJf28RjQPWaJD1/details' \
--header 'x-profile-id: pro_9K59ZyPdQhHp2fgnk9FW' \
--header 'Authorization: api-key=API_KEY' \
--header 'Content-Type: application/json'

{"id":"12345_pm_019b8eef5f077163a9f5b3b0973c4301","payment_method_token":"token_OVci7wWJf28RjQPWaJD1"}

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 · 2026-01-06T06:49:02Z

Review changes with

Changed Files

File	Status
crates/router/src/routes/lock_utils.rs	84% smaller
crates/api_models/src/events/payment.rs	20% smaller
crates/router/src/routes/app.rs	19% smaller
api-reference/v2/openapi_spec_v2.json	0% smaller
crates/api_models/src/payment_methods.rs	0% smaller
crates/openapi/src/openapi_v2.rs	0% smaller
crates/openapi/src/routes/payment_method.rs	0% smaller
crates/router/src/core/payment_methods.rs	0% smaller
crates/router/src/routes/payment_methods.rs	0% smaller
crates/router_env/src/logger/types.rs	0% smaller

codecov · 2026-01-06T07:08:47Z

Codecov Report

❌ Patch coverage is 7.46269% with 62 lines in your changes missing coverage. Please review.
⚠️ Please upload report for BASE (main@4df0779). Learn more about missing BASE report.

Files with missing lines	Patch %	Lines
crates/router/src/routes/payment_methods.rs	0.00%	35 Missing ⚠️
crates/router/src/core/payment_methods.rs	0.00%	19 Missing ⚠️
crates/api_models/src/events/payment.rs	0.00%	7 Missing ⚠️
crates/router/src/routes/lock_utils.rs	0.00%	1 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main   #10834   +/-   ##
=======================================
  Coverage        ?    6.33%           
=======================================
  Files           ?     1273           
  Lines           ?   322138           
  Branches        ?        0           
=======================================
  Hits            ?    20394           
  Misses          ?   301744           
  Partials        ?        0

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

…t-method-id-by-payment-token

…juspay/hyperswitch into feat/payment-method-id-by-payment-token

Sarthak1799 · 2026-01-07T09:46:25Z

crates/router/src/core/payment_methods.rs

+                },
+            ))
+        }
+        Ok(_) => Err(errors::ApiErrorResponse::PaymentMethodNotFound.into()),


Why do we send an error in case of other kinds of token data?

in case guest checkout flow,
currently we have permenant card, but it should temporary.
@su-shivanshmathur we need to verify on how we are insert this payment method token, when storage type is volatile

Sarthak1799 · 2026-01-07T10:44:53Z

crates/router/src/routes/payment_methods.rs

+    pub async fn get_data_for_token(
+        &self,
+        state: &SessionState,
+    ) -> CustomResult<PaymentTokenData, errors::ApiErrorResponse> {
+        let redis_conn = state
+            .store
+            .get_redis_conn()
+            .change_context(errors::ApiErrorResponse::InternalServerError)
+            .attach_printable("Failed to get redis connection")?;
+
+        logger::debug!(
+            "Fetching payment method token data from redis for key: {}",
+            self.key_for_token
+        );
+
+        let pm_token_data = redis_conn
+            .get_and_deserialize_key::<PaymentTokenData>(
+                &self.key_for_token.as_str().into(),
+                "Token Data",
+            )
+            .await
+            .map_err(|e| error_stack::report!(storage_impl::StorageError::from(e)))
+            .to_not_found_response(errors::ApiErrorResponse::GenericNotFoundError {
+                message: "Payment method token either expired or does not exist".to_string(),
+            })?;
+        Ok(pm_token_data)
+    }


Can you once check if retrieve_payment_token_data fn from crates/router/src/core/payment_methods/utils.rs can be reused here?

Let's refactor later on to depricate this utils fn if not required. @su-shivanshmathur

can we create an issue for this?

…juspay/hyperswitch into feat/payment-method-id-by-payment-token

prasunna09 · 2026-01-08T05:56:06Z

api-reference/v2/openapi_spec_v2.json

+          "Payment Methods"
+        ],
+        "summary": "Payment Method - Get Payment Method Token Data",
+        "description": "Retrieve the Payment method id associated with a payment method.",


Suggested change

"description": "Retrieve the Payment method id associated with a payment method.",

"description": "Retrieve the Payment method id associated with a payment method token.",

prasunna09 · 2026-01-08T05:58:31Z

crates/api_models/src/payment_methods.rs

+
+    /// The tokenization id associated with the payment method
+    #[schema(value_type = String, example = "token_CSum555d9YxDOpGwYq6q")]
+    pub token: String,


Suggested change

pub token: String,

pub payment_method_token: String,

also please modify the doc comment.
we have a different tokenization id in our service. this will create confusion

prasunna09 · 2026-01-08T06:06:02Z

crates/router/src/routes/app.rs

                        .route(web::get().to(payment_methods::network_token_status_check_api)),
+                )
+                .service(
+                    web::resource("/details/{temporary_token}").route(


Suggested change

web::resource("/details/{temporary_token}").route(

web::resource("/token/{payment_method_token}/details").route(

prasunna09 · 2026-01-08T06:07:30Z

crates/router/src/routes/payment_methods.rs

+    pub async fn get_data_for_token(
+        &self,
+        state: &SessionState,
+    ) -> CustomResult<PaymentTokenData, errors::ApiErrorResponse> {
+        let redis_conn = state
+            .store
+            .get_redis_conn()
+            .change_context(errors::ApiErrorResponse::InternalServerError)
+            .attach_printable("Failed to get redis connection")?;
+
+        logger::debug!(
+            "Fetching payment method token data from redis for key: {}",
+            self.key_for_token
+        );
+
+        let pm_token_data = redis_conn
+            .get_and_deserialize_key::<PaymentTokenData>(
+                &self.key_for_token.as_str().into(),
+                "Token Data",
+            )
+            .await
+            .map_err(|e| error_stack::report!(storage_impl::StorageError::from(e)))
+            .to_not_found_response(errors::ApiErrorResponse::GenericNotFoundError {
+                message: "Payment method token either expired or does not exist".to_string(),
+            })?;
+        Ok(pm_token_data)
+    }


can we create an issue for this?

prasunna09 · 2026-01-08T06:08:07Z

crates/router/src/routes/payment_methods.rs

+            let temporary_token = temporary_token.clone();
+            async move {
+                let platform: domain::Platform = auth.platform;
+                payment_methods_routes::payment_method_get_token(


nit:

Suggested change

payment_methods_routes::payment_method_get_token(

payment_methods_routes::payment_method_get_token_details_core(

…juspay/hyperswitch into feat/payment-method-id-by-payment-token

prasunna09 · 2026-01-08T09:49:54Z

crates/router/src/core/payment_methods.rs

+                },
+            ))
+        }
+        Ok(_) => Err(errors::ApiErrorResponse::PaymentMethodNotFound.into()),


in case guest checkout flow,
currently we have permenant card, but it should temporary.
@su-shivanshmathur we need to verify on how we are insert this payment method token, when storage type is volatile

… for V2 (#10834) Co-authored-by: hyperswitch-bot[bot] <148525504+hyperswitch-bot[bot]@users.noreply.github.com>

su-shivanshmathur added 4 commits January 5, 2026 21:58

Token generation and query changes for the same

9c20dde

Payment method retrival from payment token

1919286

Response changes

ca9992d

Removing early return

5beac1a

su-shivanshmathur requested review from a team as code owners January 6, 2026 06:49

su-shivanshmathur self-assigned this Jan 6, 2026

chore: run formatter

c939cba

Base automatically changed from chore/payment-token-v2-changes to main January 6, 2026 11:59

su-shivanshmathur requested a review from a team as a code owner January 6, 2026 11:59

su-shivanshmathur and others added 6 commits January 6, 2026 22:10

Merge branch 'main' of github.com:juspay/hyperswitch into feat/paymen…

82b79f2

…t-method-id-by-payment-token

Merge branch 'feat/payment-method-id-by-payment-token' of github.com:…

7495031

…juspay/hyperswitch into feat/payment-method-id-by-payment-token

chore: run formatter

d5713c8

token value change

cfcc282

Merge branch 'feat/payment-method-id-by-payment-token' of github.com:…

625aeac

…juspay/hyperswitch into feat/payment-method-id-by-payment-token

chore: run formatter

3cdd977

su-shivanshmathur changed the title ~~feat(payment_methods): payment method id retrival from payment token for V2~~ feat(payment_methods): payment method id retrieval from payment token for V2 Jan 6, 2026

su-shivanshmathur and others added 3 commits January 6, 2026 22:45

clippy errors

3e7d8ae

Merge branch 'feat/payment-method-id-by-payment-token' of github.com:…

04dc31f

…juspay/hyperswitch into feat/payment-method-id-by-payment-token

chore: run formatter

c8d14c3

maverox previously approved these changes Jan 6, 2026

View reviewed changes

Sarthak1799 reviewed Jan 7, 2026

View reviewed changes

Sarthak1799 previously approved these changes Jan 7, 2026

View reviewed changes

su-shivanshmathur added 2 commits January 8, 2026 10:58

openapi changes

af38577

Merge branch 'feat/payment-method-id-by-payment-token' of github.com:…

87c62b6

…juspay/hyperswitch into feat/payment-method-id-by-payment-token

su-shivanshmathur dismissed Sarthak1799’s stale review via 87c62b6 January 8, 2026 05:28

su-shivanshmathur dismissed maverox’s stale review via 87c62b6 January 8, 2026 05:28

hyperswitch-bot bot added the M-api-contract-changes Metadata: This PR involves API contract changes label Jan 8, 2026

chore: run formatter

9e573de

prasunna09 requested changes Jan 8, 2026

View reviewed changes

su-shivanshmathur and others added 3 commits January 8, 2026 11:41

Comment resolution

c6e03d8

Merge branch 'feat/payment-method-id-by-payment-token' of github.com:…

7e7eeab

…juspay/hyperswitch into feat/payment-method-id-by-payment-token

chore: run formatter

fce9dac

ShankarSinghC approved these changes Jan 8, 2026

View reviewed changes

maverox approved these changes Jan 8, 2026

View reviewed changes

prasunna09 approved these changes Jan 8, 2026

View reviewed changes

bernard-eugine added this pull request to the merge queue Jan 8, 2026

Merged via the queue into main with commit f928daf Jan 8, 2026
27 of 29 checks passed

bernard-eugine deleted the feat/payment-method-id-by-payment-token branch January 8, 2026 10:39

siaass842 pushed a commit that referenced this pull request Jan 14, 2026

feat(payment_methods): payment method id retrieval from payment token…

c5bf1ae

… for V2 (#10834) Co-authored-by: hyperswitch-bot[bot] <148525504+hyperswitch-bot[bot]@users.noreply.github.com>

	"description": "Retrieve the Payment method id associated with a payment method.",
	"description": "Retrieve the Payment method id associated with a payment method token.",

	web::resource("/details/{temporary_token}").route(
	web::resource("/token/{payment_method_token}/details").route(

	payment_methods_routes::payment_method_get_token(
	payment_methods_routes::payment_method_get_token_details_core(

feat(payment_methods): payment method id retrieval from payment token for V2 #10834

feat(payment_methods): payment method id retrieval from payment token for V2 #10834

Uh oh!

Conversation

su-shivanshmathur commented Jan 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Type of Change

Description

Additional Changes

Motivation and Context

How did you test it?

Checklist

Uh oh!

semanticdiff-com bot commented Jan 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Jan 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Sarthak1799 Jan 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

su-shivanshmathur commented Jan 6, 2026 •

edited

Loading

semanticdiff-com bot commented Jan 6, 2026 •

edited

Loading

codecov bot commented Jan 6, 2026 •

edited

Loading

Sarthak1799 Jan 7, 2026 •

edited

Loading