feat(payment_methods_session_v2): update flow of payment method session #7263

ShivanshMathurJuspay · 2025-02-13T10:28:26Z

Type of Change

Description

Payment Method Session update flow is implemented for the Payment Method Service where the PR reflects the changes of updating an already present payment-method-session without changing the TTL of the already present session 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?

Create Session

POST CREATE
curl --location 'http://localhost:8080/v2/payment-methods-session' \
--header 'x-profile-id: pro_22n1ZyVAfpw9p19m03KA' \
--header 'Authorization: api-key=dev_yV5KB2TgmKcUOLvbSTyGVmYtukoyNqjxilK0YnfF1uDaj2Vv0wl2HYRdbSAKGeFb' \
--header 'Content-Type: application/json' \
--data-raw '{
    "customer_id": "12345_cus_0194fec3f6667f33828795d53de0cde8",
     "billing": {
        "address": {
            "first_name": "John",
            "last_name": "Dough"
        },
        "email": "[email protected]"
    },
    "expires_in" : 99999999
}

Response -> {
    "id": "12345_pms_019523b520507e7397b70c7a38cde54a",
    "customer_id": "12345_cus_0194fec3f6667f33828795d53de0cde8",
    "billing": {
        "address": {
            "city": null,
            "country": null,
            "line1": null,
            "line2": null,
            "line3": null,
            "zip": null,
            "state": null,
            "first_name": "John",
            "last_name": "Dough"
        },
        "phone": null,
        "email": "[email protected]"
    },
    "psp_tokenization": null,
    "network_tokenization": null,
    "expires_at": "2028-04-23T00:00:26.729Z",
    "client_secret": "cs_019523b520507e7397b70c81a472d306"
}

Retrieve Session ( before update )

GET RETRIEVE BEFORE UPDATE
curl --location 'http://localhost:8080/v2/payment-methods-session/12345_pms_019523b520507e7397b70c7a38cde54a' \
--header 'x-profile-id: pro_22n1ZyVAfpw9p19m03KA' \
--header 'Authorization: publishable-key=pk_dev_98e959071d914b90b92ecd8d5f0234e1,client-secret=cs_019523b520507e7397b70c81a472d306' \
--header 'api-key: dev_yV5KB2TgmKcUOLvbSTyGVmYtukoyNqjxilK0YnfF1uDaj2Vv0wl2HYRdbSAKGeFb'

Response -> {
    "id": "12345_pms_019523b520507e7397b70c7a38cde54a",
    "customer_id": "12345_cus_0194fec3f6667f33828795d53de0cde8",
    "billing": {
        "address": {
            "city": null,
            "country": null,
            "line1": null,
            "line2": null,
            "line3": null,
            "zip": null,
            "state": null,
            "first_name": "John",
            "last_name": "Dough"
        },
        "phone": null,
        "email": "[email protected]"
    },
    "psp_tokenization": null,
    "network_tokenization": null,
    "expires_at": "2028-04-23T00:00:26.729Z",
    "client_secret": "CLIENT_SECRET_REDACTED"
}

Update Session

PUT UPDATE
curl --location --request PUT 'http://localhost:8080/v2/payment-methods-session/12345_pms_019523b520507e7397b70c7a38cde54a' \
--header 'Authorization: api-key=dev_yV5KB2TgmKcUOLvbSTyGVmYtukoyNqjxilK0YnfF1uDaj2Vv0wl2HYRdbSAKGeFb' \
--header 'x-profile-id: pro_22n1ZyVAfpw9p19m03KA' \
--header 'Content-Type: application/json' \
--header 'api-key: dev_yV5KB2TgmKcUOLvbSTyGVmYtukoyNqjxilK0YnfF1uDaj2Vv0wl2HYRdbSAKGeFb' \
--data-raw '{
    "billing": {
        "address": {
            "first_name": "MATHUR_TESTSTAS",
            "last_name": "SHIVANSH"
        },
        "email": "[email protected]"
    }
}'`
`Response -> {
    "id": "12345_pms_019523b520507e7397b70c7a38cde54a",
    "customer_id": "12345_cus_0194fec3f6667f33828795d53de0cde8",
    "billing": {
        "address": {
            "city": null,
            "country": null,
            "line1": null,
            "line2": null,
            "line3": null,
            "zip": null,
            "state": null,
            "first_name": "MATHUR_TESTSTAS",
            "last_name": "SHIVANSH"
        },
        "phone": null,
        "email": "[email protected]"
    },
    "psp_tokenization": null,
    "network_tokenization": null,
    "expires_at": "2028-04-23T00:00:26.729Z",
    "client_secret": "CLIENT_SECRET_REDACTED"
}

Retrieve Session ( post update )

GET POST UPDATE
curl --location 'http://localhost:8080/v2/payment-methods-session/12345_pms_019523b520507e7397b70c7a38cde54a' \
--header 'x-profile-id: pro_22n1ZyVAfpw9p19m03KA' \
--header 'Authorization: publishable-key=pk_dev_98e959071d914b90b92ecd8d5f0234e1,client-secret=cs_019523b520507e7397b70c81a472d306' \
--header 'api-key: dev_yV5KB2TgmKcUOLvbSTyGVmYtukoyNqjxilK0YnfF1uDaj2Vv0wl2HYRdbSAKGeFb'

Response -> {
    "id": "12345_pms_019523b520507e7397b70c7a38cde54a",
    "customer_id": "12345_cus_0194fec3f6667f33828795d53de0cde8",
    "billing": {
        "address": {
            "city": null,
            "country": null,
            "line1": null,
            "line2": null,
            "line3": null,
            "zip": null,
            "state": null,
            "first_name": "MATHUR_TESTSTAS",
            "last_name": "SHIVANSH"
        },
        "phone": null,
        "email": "[email protected]"
    },
    "psp_tokenization": null,
    "network_tokenization": null,
    "expires_at": "2028-04-23T00:00:26.729Z",
    "client_secret": "CLIENT_SECRET_REDACTED"
}

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-02-13T10:28:29Z

Review changes with

Changed Files

File	Status
crates/router/src/routes/app.rs	98% smaller
crates/router/src/routes/lock_utils.rs	86% smaller
crates/openapi/src/openapi_v2.rs	9% smaller
api-reference-v2/openapi_spec.json	0% smaller
crates/api_models/src/events.rs	0% smaller
crates/api_models/src/payment_methods.rs	0% smaller
crates/diesel_models/src/payment_methods_session.rs	0% smaller
crates/hyperswitch_domain_models/src/payment_methods.rs	0% smaller
crates/router/src/core/payment_methods.rs	0% smaller
crates/router/src/db/kafka_store.rs	0% smaller
crates/router/src/db/payment_method_session.rs	0% smaller
crates/router/src/routes/payment_methods.rs	0% smaller
crates/router_env/src/logger/types.rs	0% smaller

Narayanbhat166 · 2025-02-18T07:03:46Z

crates/diesel_models/src/payment_methods_session.rs

+#[cfg(feature = "v2")]
+#[derive(Clone, Debug, serde::Serialize, serde::Deserialize)]
+pub struct PaymentMethodsSessionUpdate {
+    pub id: common_utils::id_type::GlobalPaymentMethodSessionId,


do we need id in the updatable struct?

Narayanbhat166 · 2025-02-18T07:23:41Z

crates/router/src/core/payment_methods.rs

@@ -1995,3 +2111,22 @@ impl pm_types::SavedPMLPaymentsInfo {
        Ok(())
    }
 }
+
+#[cfg(feature = "v2")]
+pub async fn payment_method_session_update_to_current_state(


can you add an impl function like this

hyperswitch/crates/diesel_models/src/authentication.rs

Line 236 in 834b42e

impl AuthenticationUpdateInternal {

Narayanbhat166 · 2025-02-18T07:25:32Z

crates/router/src/core/payment_methods.rs

+    db.update_payment_method_session(
+        key_manager_state,
+        &key_store,
+        &payment_method_session_id,
+        update_state_change.clone(),
+    )


This function should take the update enum, then internally in the implementation we can convert the update enum to updateinternal and then insert into the db

Narayanbhat166 · 2025-02-18T07:37:57Z

crates/router/src/db/kafka_store.rs

+        state: &KeyManagerState,
+        key_store: &hyperswitch_domain_models::merchant_key_store::MerchantKeyStore,
+        id: &id_type::GlobalPaymentMethodSessionId,
+        payment_methods_session: hyperswitch_domain_models::payment_methods::PaymentMethodsSession,


instead of this taking the payment method session, it can take payment method session update enum, converting to the payment method session can be done internally. You can see how this logic has been implemented for updating the payment method

Narayanbhat166 · 2025-02-20T14:26:49Z

@ShivanshMathurJuspay can you attach the curl instead of screenshots? This helps in testing as well

crates/hyperswitch_domain_models/src/payment_methods.rs

crates/router/src/core/payment_methods.rs

crates/router/src/routes/payment_methods.rs

…perswitch into update_payment_methods_session

crates/diesel_models/src/payment_methods_session.rs

crates/router/src/core/payment_methods.rs

crates/hyperswitch_domain_models/src/payment_methods.rs

…perswitch into update_payment_methods_session

ShivanshMathurJuspay added 3 commits February 13, 2025 14:56

Update flow of Payment Method Session

9bb2e0c

Changes

09ddeff

openapi changes

b990732

ShivanshMathurJuspay self-assigned this Feb 13, 2025

ShivanshMathurJuspay requested review from a team as code owners February 13, 2025 10:28

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

hyperswitch-bot bot added 2 commits February 13, 2025 10:40

chore: run formatter

a8e7b32

docs(openapi): re-generate OpenAPI specification

48cfcfd

ShivanshMathurJuspay linked an issue Feb 14, 2025 that may be closed by this pull request

[FEATURE] payment method sessions update endpoint #7269

Open

2 tasks

Narayanbhat166 reviewed Feb 18, 2025

View reviewed changes

Changes for better structure

4378976

Narayanbhat166 reviewed Feb 20, 2025

View reviewed changes

crates/hyperswitch_domain_models/src/payment_methods.rs Show resolved Hide resolved

Narayanbhat166 reviewed Feb 20, 2025

View reviewed changes

crates/router/src/core/payment_methods.rs Outdated Show resolved Hide resolved

Narayanbhat166 reviewed Feb 20, 2025

View reviewed changes

crates/router/src/routes/payment_methods.rs Outdated Show resolved Hide resolved

hyperswitch-bot bot and others added 4 commits February 20, 2025 15:16

chore: run formatter

5c1a0be

Return value changes

ebfba33

Merge branch 'update_payment_methods_session' of github.com:juspay/hy…

b86c302

…perswitch into update_payment_methods_session

chore: run formatter

a8a7c62

Narayanbhat166 reviewed Feb 21, 2025

View reviewed changes

crates/diesel_models/src/payment_methods_session.rs Outdated Show resolved Hide resolved

Narayanbhat166 requested changes Feb 21, 2025

View reviewed changes

crates/router/src/core/payment_methods.rs Outdated Show resolved Hide resolved

crates/hyperswitch_domain_models/src/payment_methods.rs Outdated Show resolved Hide resolved

crates/hyperswitch_domain_models/src/payment_methods.rs Outdated Show resolved Hide resolved

ShivanshMathurJuspay and others added 4 commits February 21, 2025 10:55

Removing unwanted Structs

6ec0ac1

chore: run formatter

7e6a187

Removing unwanted structs

d81c836

Merge branch 'update_payment_methods_session' of github.com:juspay/hy…

e48ec06

…perswitch into update_payment_methods_session

ShivanshMathurJuspay changed the title ~~feat(payment_methods_session_v2): update flow of Payment Method Session~~ feat(payment_methods_session_v2): update flow of payment method session Feb 21, 2025

Removing comments

eeb398d

chore: run formatter

68293f0

Narayanbhat166 previously approved these changes Feb 21, 2025

View reviewed changes

jarnura previously approved these changes Feb 21, 2025

View reviewed changes

ShivanshMathurJuspay added 2 commits February 21, 2025 16:21

correcting workflow errors

798605d

Merge branch 'update_payment_methods_session' of github.com:juspay/hy…

9d2f7a8

…perswitch into update_payment_methods_session

ShivanshMathurJuspay dismissed stale reviews from jarnura and Narayanbhat166 via 9d2f7a8 February 21, 2025 10:52

Narayanbhat166 previously approved these changes Feb 21, 2025

View reviewed changes

ShivanshMathurJuspay requested a review from a team February 21, 2025 11:04

jarnura previously approved these changes Feb 21, 2025

View reviewed changes

chore: run formatter

9166f48

hyperswitch-bot bot dismissed stale reviews from jarnura and Narayanbhat166 via 9166f48 February 21, 2025 13:41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(payment_methods_session_v2): update flow of payment method session #7263

feat(payment_methods_session_v2): update flow of payment method session #7263

ShivanshMathurJuspay commented Feb 13, 2025 •

edited

Loading

semanticdiff-com bot commented Feb 13, 2025 •

edited

Loading

Narayanbhat166 Feb 18, 2025

Narayanbhat166 Feb 18, 2025

Narayanbhat166 Feb 18, 2025

Narayanbhat166 Feb 18, 2025

Narayanbhat166 commented Feb 20, 2025

feat(payment_methods_session_v2): update flow of payment method session #7263

Are you sure you want to change the base?

feat(payment_methods_session_v2): update flow of payment method session #7263

Conversation

ShivanshMathurJuspay commented Feb 13, 2025 • edited Loading

Type of Change

Description

Additional Changes

Motivation and Context

How did you test it?

Checklist

semanticdiff-com bot commented Feb 13, 2025 • edited Loading

Narayanbhat166 Feb 18, 2025

Choose a reason for hiding this comment

Narayanbhat166 Feb 18, 2025

Choose a reason for hiding this comment

Narayanbhat166 Feb 18, 2025

Choose a reason for hiding this comment

Narayanbhat166 Feb 18, 2025

Choose a reason for hiding this comment

Narayanbhat166 commented Feb 20, 2025

ShivanshMathurJuspay commented Feb 13, 2025 •

edited

Loading

semanticdiff-com bot commented Feb 13, 2025 •

edited

Loading