feat(payment_methods): add v2 api for fetching token data #7629

Sakilmostak · 2025-03-25T12:37:06Z

Type of Change

Description

An endpoint is added to fetch network token related to a payment method (specifically cards)

Add a GET call to fetch network token data with cryptogram
Cryptogram is generated for every api call
No DB changes made since cryptogram is single use

Additional Changes

This PR modifies the API contract
Endpoint:

 {{baseUrl}}/v2/payment-methods/{id}/get-token

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

Motivation and Context

How did you test it?

Tested through postman:

Create Merchant Account
Cretae Organization
Create a Merchant Connector Account
Enable network tokenization in Business Profile

{
    "is_network_tokenization_enabled": true
}

Save a payment method with network token

curl --location '{{baseUrl}}/v2/payment-methods' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'X-Profile-Id: {{profile_id}}' \
--header 'Authorization: api-key={{api_key}}' \
--data '{
    "customer_id": "{{customer_id}}",
    "payment_method_type": "card",
    "payment_method_subtype": "credit",
    "payment_method_data": {
        "card": {
            "card_number": "4761360080000093",
            "card_exp_month": "12",
            "card_exp_year": "2026",
            "card_holder_name": "joseph Doe"
        }
    },
    "network_tokenization":{
        "enable":"Enable"
    }
}'

Get cryptogram for the network token with payment_method_id:

curl --location --request GET '{{base_url}}/v2/payment-methods/{{payment_method_id}}/get-token' \
--header 'X-Profile-Id:{{profile_id}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: api-key={{api_key}}' \
--data '{
    "token_type": "network_token"
}'

Following should be the response:

{
    "payment_method_id": "12345_pm_0195dc62e14d7102b2ee7be5d04fe853",
    "network_token": "4604000460040707",
    "network_token_exp_month": "12",
    "network_token_exp_year": "2026",
    "cryptogram": "AwAAAAABD5dXv0wAmbSeglsLAAA=",
    "card_issuer": "ICICI Bank",
    "card_network": "Visa",
    "card_type": null,
    "card_issuing_country": null,
    "bank_code": null,
    "card_holder_name": "joseph Doe",
    "nick_name": null,
    "eci": "07"
}

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-03-25T12:37:09Z

Review changes with

Changed Files

File	Status
crates/router/src/types/api/payment_methods.rs	96% smaller
crates/router/src/routes/lock_utils.rs	32% smaller
crates/openapi/src/openapi.rs	24% smaller
crates/router/src/routes/app.rs	24% smaller
crates/openapi/src/openapi_v2.rs	9% smaller
crates/router/src/core/payment_methods/network_tokenization.rs	3% smaller
crates/api_models/src/payment_methods.rs	3% smaller
api-reference-v2/openapi_spec.json	0% smaller
api-reference/openapi_spec.json	0% smaller
crates/common_enums/src/enums.rs	0% smaller
crates/hyperswitch_domain_models/src/payment_method_data.rs	0% smaller
crates/payment_methods/Cargo.toml	Unsupported file format
crates/router/src/core/payment_methods.rs	0% smaller
crates/router/src/routes/payment_methods.rs	0% smaller
crates/router/src/types/payment_methods.rs	0% smaller
crates/router_env/src/logger/types.rs	0% smaller

crates/router/src/core/payment_methods.rs

crates/router/src/core/payment_methods/network_tokenization.rs

crates/router/src/core/payment_methods.rs

crates/api_models/src/payment_methods.rs

crates/router/src/core/payment_methods.rs

crates/router/src/core/payment_methods/network_tokenization.rs

crates/hyperswitch_domain_models/src/payment_method_data.rs

crates/cards/src/validate.rs

prasunna09 · 2025-04-28T11:30:04Z

crates/api_models/src/payment_methods.rs

+
+    /// Cryptogram generated by the Network
+    #[schema(value_type = Option<String>)]
+    pub cryptogram: Option<masking::Secret<String>>,


doesn't this have to be mandatory field?, since the aim of this api is to share cryptogram and network token

After discussion it seems cryptogram is not generated for all network token, it is a nullable value, thus couldn't be make mandatory.

prasunna09 · 2025-05-05T09:41:44Z

crates/router/src/core/payment_methods.rs

+            if !is_network_tokenization_enabled {
+                return Err(errors::ApiErrorResponse::UnprocessableEntity {
+                    message: "Network tokenization is not enabled for this profile".to_string(),
+                }
+                .into());
+            }


you can use when method instead of if and early return.

…adyen-ideal * 'main' of github.com:juspay/hyperswitch: (62 commits) fix(core): language consumption from locale in payment and payout links (#7993) feat(refunds_v2): Add refunds list flow in v2 apis (#7966) refactor(connector): [Noon] auth header (#7977) fix(connector): [Novalnet] send decoded token for apple pay payment (#7973) feat(business_profile): add business_profile config to enable external vault (#7876) feat(vsaas): integrate onboarding flow for vertical saas (#7884) feat(connector): Introduce connector template code for WorldpayXML (#7968) feat(connector): [ADYEN, CHECKOUT] Added In Feature Matrix API (#7914) feat(core): add psync support for recovery external payments (#7855) refactor(open_router): call elimination routing of open router if enabled instead of dynamo (#7961) feat(payment_methods): add v2 api for fetching token data (#7629) ci(cypress): Fix Bank Redirects for stripe test (#8004) chore(version): 2025.05.12.0 refactor(authentication): moved cavv storing from table to temp locker (#7978) chore(version): 2025.05.09.0 feat(connector): [paypal, trustpay] add in feature matrix (#7911) fix(update_metadata): Update Metadata for any connectors other than stripe gives 500 error (#7984) fix(router): Fixed stack over flow for session call in authentication connectors (#7983) chore(version): 2025.05.08.0 fix(payment): disable payment update via client config (#7970) ...

feat: add api for fetching cryptrogram for network token

d4f4832

Sakilmostak added C-feature Category: Feature request or enhancement A-payment-methods Area: Payment Methods labels Mar 25, 2025

Sakilmostak added this to the March 2025 Release milestone Mar 25, 2025

Sakilmostak self-assigned this Mar 25, 2025

Sakilmostak added 4 commits March 26, 2025 13:57

refactor: change endpoint for cryptogram

2894cdb

fix: remove v2 config

80694da

refactor: make fetch token generic

fbd5185

fix: remove v2 config

f1ff932

Sakilmostak changed the title ~~feat(payment_methods): add api for fetching cryptogram~~ feat(payment_methods): add v2 api for fetching token data Mar 26, 2025

Sakilmostak marked this pull request as ready for review March 26, 2025 11:20

Sakilmostak requested review from a team as code owners March 26, 2025 11:20

docs(openapi): re-generate OpenAPI specification

51d6e2d

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

refactor: make get-token generic

e1d53f3

Sakilmostak requested a review from a team as a code owner March 28, 2025 08:01

prasunna09 requested changes Apr 1, 2025

View reviewed changes

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

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

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

refactor: fill more fields in response

785da36

SanchithHegde modified the milestones: March 2025 Release, April 2025 Release Apr 2, 2025

refactor: resolve comments

6130b65

prasunna09 requested changes Apr 7, 2025

View reviewed changes

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

Sakilmostak and others added 2 commits April 9, 2025 17:39

refactor: resolve comments

5efa5ac

Merge branch 'main' into cyrptogram_api

31c96b9

Sakilmostak removed request for a team April 21, 2025 08:18

prasunna09 reviewed Apr 28, 2025

View reviewed changes

refactor: resolve comments

fb88fe8

Sakilmostak requested a review from a team as a code owner April 30, 2025 07:46

chore: remove redundant import

d05a020

prasunna09 previously approved these changes May 5, 2025

View reviewed changes

Sakilmostak added 2 commits May 5, 2025 15:24

Merge branch 'main' into cyrptogram_api

adab92c

refactor: resolve conflict with main

e0f0f76

Sakilmostak dismissed prasunna09’s stale review via e0f0f76 May 5, 2025 10:19

refactor: resolve openapi check

f554887

prasunna09 approved these changes May 5, 2025

View reviewed changes

su-shivanshmathur approved these changes May 6, 2025

View reviewed changes

Gnanasundari24 added this pull request to the merge queue May 12, 2025

Merged via the queue into main with commit 2cefac5 May 12, 2025
28 of 32 checks passed

Gnanasundari24 deleted the cyrptogram_api branch May 12, 2025 14:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(payment_methods): add v2 api for fetching token data #7629

feat(payment_methods): add v2 api for fetching token data #7629

Uh oh!

Sakilmostak commented Mar 25, 2025 •

edited

Loading

Uh oh!

semanticdiff-com bot commented Mar 25, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

prasunna09 Apr 28, 2025

Uh oh!

Sakilmostak Apr 29, 2025

Uh oh!

prasunna09 May 5, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

feat(payment_methods): add v2 api for fetching token data #7629

feat(payment_methods): add v2 api for fetching token data #7629

Uh oh!

Conversation

Sakilmostak commented Mar 25, 2025 • 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 Mar 25, 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!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

prasunna09 Apr 28, 2025

Choose a reason for hiding this comment

Uh oh!

Sakilmostak Apr 29, 2025

Choose a reason for hiding this comment

Uh oh!

prasunna09 May 5, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Sakilmostak commented Mar 25, 2025 •

edited

Loading

semanticdiff-com bot commented Mar 25, 2025 •

edited

Loading