feat(router): adding generic tokenization endpoint

api-reference-v2/api-reference/tokenization/tokenization--create.mdx

@@ -0,0 +1,3 @@
+---
+openapi: post /v2/tokenize
+---

api-reference-v2/mint.json

@@ -146,6 +146,10 @@
     {
       "group": "Proxy",
       "pages": ["api-reference/proxy/proxy"]
+    },
+    {
+      "group": "Tokenization",
+      "pages": ["api-reference/tokenization/tokenization--create"]
     }
   ],
   "footerSocials": {

api-reference-v2/openapi_spec.json

@@ -3532,6 +3532,67 @@
           }
         ]
       }
+    },
+    "/v2/tokenize": {
+      "post": {
+        "tags": [
+          "Tokenization"
+        ],
+        "operationId": "create_token_vault_api",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/GenericTokenizationRequest"
+              },
+              "examples": {
+                "Create a token with customer_id": {
+                  "value": {
+                    "customer_id": "12345_cus_0196d94b9c207333a297cbcf31f2e8c8",
+                    "token_request": {
+                      "payment_method_data": {
+                        "card": {
+                          "card_holder_name": "test name"
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "Token created successfully",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/GenericTokenizationResponse"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Invalid request"
+          },
+          "401": {
+            "description": "Unauthorized"
+          },
+          "500": {
+            "description": "Internal server error"
+          }
+        },
+        "security": [
+          {
+            "ephemeral_key": []
+          },
+          {
+            "api_key": []
+          }
+        ]
+      }
     }
   },
   "components": {
@@ -11032,6 +11093,50 @@
           }
         }
       },
+      "GenericTokenizationRequest": {
+        "type": "object",
+        "required": [
+          "customer_id",
+          "token_request"
+        ],
+        "properties": {
+          "customer_id": {
+            "type": "string",
+            "description": "Customer ID for which the tokenization is requested",
+            "example": "12345_cus_01926c58bc6e77c09e809964e72af8c8"
+          },
+          "token_request": {
+            "type": "object",
+            "description": "Request for tokenization which contains the data to be tokenized"
+          }
+        }
+      },
+      "GenericTokenizationResponse": {
+        "type": "object",
+        "required": [
+          "id",
+          "created_at",
+          "flag"
+        ],
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "Unique identifier returned by the tokenization service",
+            "example": "12345_tok_01926c58bc6e77c09e809964e72af8c8"
+          },
+          "created_at": {
+            "type": "string",
+            "format": "date-time",
+            "description": "Created time of the tokenization id",
+            "example": "2024-02-24T11:04:09.922Z"
+          },
+          "flag": {
+            "type": "string",
+            "description": "Status of the tokenization id created",
+            "example": "enabled"
+          }
+        }
+      },
       "GiftCardAdditionalData": {
         "oneOf": [
           {
@@ -16595,6 +16700,10 @@
             "example": 900,
             "nullable": true,
             "minimum": 0
+          },
+          "tokenization_data": {
+            "description": "Contains data to be passed on to tokenization service ( if present ) to create token_id for given JSON data",
+            "nullable": true
           }
         }
       },
@@ -16640,6 +16749,10 @@
             ],
             "nullable": true
           },
+          "tokenization_data": {
+            "description": "Contains data to be passed on to tokenization service ( if present ) to create token_id for given JSON data",
+            "nullable": true
+          },
           "expires_at": {
             "type": "string",
             "format": "date-time",
@@ -16678,6 +16791,12 @@
             },
             "description": "The payment method that was created using this payment method session",
             "nullable": true
+          },
+          "associated_token_id": {
+            "type": "string",
+            "description": "The token-id created if there is tokenization_data present",
+            "example": "12345_tok_01926c58bc6e77c09e809964e72af8c8",
+            "nullable": true
           }
         }
       },
@@ -16941,6 +17060,10 @@
               }
             ],
             "nullable": true
+          },
+          "tokenization_data": {
+            "description": "Contains data to be passed on to tokenization service ( if present ) to create token_id for given JSON data",
+            "nullable": true
           }
         }
       },

config/development.toml

@@ -84,28 +84,8 @@ redis_lock_timeout_in_seconds = 100
 redis_ttl_in_seconds = 172800
 
 [jwekey]
-vault_encryption_key = """
------BEGIN PUBLIC KEY-----
-MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAwa6siKaSYqD1o4J3AbHq
-Km8oVTvep7GoN/C45qY60C7DO72H1O7Ujt6ZsSiK83EyI0CaUg3ORPS3ayobFNmu
-zR366ckK8GIf3BG7sVI6u/9751z4OvBHZMM9JFWa7Bx/RCPQ8aeM+iJoqf9auuQm
-3NCTlfaZJif45pShswR+xuZTR/bqnsOSP/MFROI9ch0NE7KRogy0tvrZe21lP24i
-Ro2LJJG+bYshxBddhxQf2ryJ85+/Trxdu16PunodGzCl6EMT3bvb4ZC41i15omqU
-aXXV1Z1wYUhlsO0jyd1bVvjyuE/KE1TbBS0gfR/RkacODmmE2zEdZ0EyyiXwqkmc
-oQIDAQAB
------END PUBLIC KEY-----
-"""
-rust_locker_encryption_key = """
------BEGIN PUBLIC KEY-----
-MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAwa6siKaSYqD1o4J3AbHq
-Km8oVTvep7GoN/C45qY60C7DO72H1O7Ujt6ZsSiK83EyI0CaUg3ORPS3ayobFNmu
-zR366ckK8GIf3BG7sVI6u/9751z4OvBHZMM9JFWa7Bx/RCPQ8aeM+iJoqf9auuQm
-3NCTlfaZJif45pShswR+xuZTR/bqnsOSP/MFROI9ch0NE7KRogy0tvrZe21lP24i
-Ro2LJJG+bYshxBddhxQf2ryJ85+/Trxdu16PunodGzCl6EMT3bvb4ZC41i15omqU
-aXXV1Z1wYUhlsO0jyd1bVvjyuE/KE1TbBS0gfR/RkacODmmE2zEdZ0EyyiXwqkmc
-oQIDAQAB
------END PUBLIC KEY-----
-"""
+vault_encryption_key = ""
+rust_locker_encryption_key = ""
 vault_private_key = ""
 tunnel_private_key = ""
 

crates/api_models/Cargo.toml

@@ -17,13 +17,14 @@ olap = []
 openapi = ["common_enums/openapi", "olap", "recon", "dummy_connector", "olap"]
 recon = []
 v1 = ["common_utils/v1"]
-v2 = ["common_types/v2", "common_utils/v2", "customer_v2", "refunds_v2"]
+v2 = ["common_types/v2", "common_utils/v2", "customer_v2", "refunds_v2", "tokenization_v2"]
 customer_v2 = ["common_utils/customer_v2"]
 payment_methods_v2 = ["common_utils/payment_methods_v2", "dep:reqwest"]
 refunds_v2 = []
 dynamic_routing = []
 control_center_theme = ["dep:actix-web", "dep:actix-multipart"]
 revenue_recovery = []
+tokenization_v2 = ["common_utils/tokenization_v2"]
 
 [dependencies]
 actix-multipart = { version = "0.6.1", optional = true }

crates/api_models/src/events.rs

@@ -22,6 +22,8 @@ use common_utils::{
 };
 
 use crate::customers::CustomerListRequest;
+#[cfg(feature = "tokenization_v2")]
+use crate::tokenization;
 #[allow(unused_imports)]
 use crate::{
     admin::*,
@@ -228,3 +230,8 @@ impl ApiEventMetric for PaymentMethodSessionResponse {
         })
     }
 }
+#[cfg(feature = "tokenization_v2")]
+impl ApiEventMetric for tokenization::GenericTokenizationRequest {}
+
+#[cfg(feature = "tokenization_v2")]
+impl ApiEventMetric for tokenization::GenericTokenizationResponse {}

crates/api_models/src/lib.rs

@@ -40,6 +40,8 @@ pub mod refunds;
 pub mod relay;
 pub mod routing;
 pub mod surcharge_decision_configs;
+#[cfg(feature = "tokenization_v2")]
+pub mod tokenization;
 pub mod user;
 pub mod user_role;
 pub mod verifications;

crates/api_models/src/payment_methods.rs

@@ -2861,6 +2861,10 @@ pub struct PaymentMethodSessionRequest {
     /// If not provided, the session will expire in 15 minutes
     #[schema(example = 900, default = 900)]
     pub expires_in: Option<u32>,
+
+    /// Contains data to be passed on to tokenization service ( if present ) to create token_id for given JSON data
+    #[schema(value_type = Option<serde_json::Value>)]
+    pub tokenization_data: Option<pii::SecretSerdeValue>,
 }
 
 #[cfg(feature = "v2")]
@@ -2877,6 +2881,10 @@ pub struct PaymentMethodsSessionUpdateRequest {
     /// The network tokenization configuration if applicable
     #[schema(value_type = Option<NetworkTokenization>)]
     pub network_tokenization: Option<common_types::payment_methods::NetworkTokenization>,
+
+    /// Contains data to be passed on to tokenization service ( if present ) to create token_id for given JSON data
+    #[schema(value_type = Option<serde_json::Value>)]
+    pub tokenization_data: Option<pii::SecretSerdeValue>,
 }
 
 #[cfg(feature = "v2")]
@@ -2941,6 +2949,10 @@ pub struct PaymentMethodSessionResponse {
     #[schema(value_type = Option<NetworkTokenization>)]
     pub network_tokenization: Option<common_types::payment_methods::NetworkTokenization>,
 
+    /// Contains data to be passed on to tokenization service ( if present ) to create token_id for given JSON data
+    #[schema(value_type = Option<serde_json::Value>)]
+    pub tokenization_data: Option<pii::SecretSerdeValue>,
+
     /// The iso timestamp when the session will expire
     /// Trying to retrieve the session or any operations on the session after this time will result in an error
     #[schema(value_type = PrimitiveDateTime, example = "2023-01-18T11:04:09.922Z")]
@@ -2966,6 +2978,10 @@ pub struct PaymentMethodSessionResponse {
     /// The payment method that was created using this payment method session
     #[schema(value_type = Option<Vec<String>>)]
     pub associated_payment_methods: Option<Vec<id_type::GlobalPaymentMethodId>>,
+
+    /// The token-id created if there is tokenization_data present
+    #[schema(value_type = Option<String>, example = "12345_tok_01926c58bc6e77c09e809964e72af8c8")]
+    pub associated_token_id: Option<id_type::GlobalTokenId>,
 }
 
 #[cfg(feature = "v2")]

crates/api_models/src/tokenization.rs

@@ -0,0 +1,30 @@
+use common_enums;
+use common_utils::id_type::{GlobalCustomerId, GlobalTokenId};
+use masking::Secret;
+use serde::{Deserialize, Serialize};
+use time::PrimitiveDateTime;
+use utoipa::{schema, ToSchema};
+
+#[cfg(all(feature = "v2", feature = "tokenization_v2"))]
+#[derive(Debug, Serialize, Deserialize, ToSchema)]
+pub struct GenericTokenizationResponse {
+    /// Unique identifier returned by the tokenization service
+    #[schema(value_type = String, example = "12345_tok_01926c58bc6e77c09e809964e72af8c8")]
+    pub id: GlobalTokenId,
+    /// Created time of the tokenization id
+    #[schema(value_type = PrimitiveDateTime,example = "2024-02-24T11:04:09.922Z")]
+    pub created_at: PrimitiveDateTime,
+    /// Status of the tokenization id created
+    #[schema(value_type = String,example = "enabled")]
+    pub flag: common_enums::TokenizationFlag,
+}
+#[cfg(all(feature = "v2", feature = "tokenization_v2"))]
+#[derive(Debug, Serialize, Deserialize, ToSchema)]
+pub struct GenericTokenizationRequest {
+    /// Customer ID for which the tokenization is requested
+    #[schema(value_type = String, example = "12345_cus_01926c58bc6e77c09e809964e72af8c8")]
+    pub customer_id: GlobalCustomerId,
+    /// Request for tokenization which contains the data to be tokenized
+    #[schema(value_type = Object,example = json!({ "city": "NY", "unit": "245" }))]
+    pub token_request: masking::Secret<serde_json::Value>,
+}

crates/common_enums/src/enums.rs

@@ -29,7 +29,7 @@ pub mod diesel_exports {
         DbRequestIncrementalAuthorization as RequestIncrementalAuthorization,
         DbScaExemptionType as ScaExemptionType,
         DbSuccessBasedRoutingConclusiveState as SuccessBasedRoutingConclusiveState,
-        DbWebhookDeliveryAttempt as WebhookDeliveryAttempt,
+        DbTokenizationFlag as TokenizationFlag, DbWebhookDeliveryAttempt as WebhookDeliveryAttempt,
     };
 }
 
@@ -8299,6 +8299,28 @@ pub enum CryptoPadding {
     ZeroPadding,
 }
 
+#[derive(
+    Clone,
+    Copy,
+    Debug,
+    Eq,
+    PartialEq,
+    serde::Deserialize,
+    serde::Serialize,
+    strum::Display,
+    strum::EnumString,
+    ToSchema,
+)]
+#[router_derive::diesel_enum(storage_type = "db_enum")]
+#[serde(rename_all = "snake_case")]
+#[strum(serialize_all = "snake_case")]
+pub enum TokenizationFlag {
+    /// Token is active and can be used for payments
+    Enabled,
+    /// Token is inactive and cannot be used for payments
+    Disabled,
+}
+
 /// The type of token data to fetch for get-token endpoint
 
 #[derive(Clone, Copy, Debug, serde::Deserialize, serde::Serialize, ToSchema)]

crates/common_types/Cargo.toml

@@ -10,6 +10,7 @@ license.workspace = true
 default = []
 v1 = ["common_utils/v1"]
 v2 = ["common_utils/v2"]
+tokenization_v2 = ["common_utils/tokenization_v2"]
 
 [dependencies]
 diesel = "2.2.3"

crates/common_utils/Cargo.toml

@@ -23,6 +23,7 @@ v2 = []
 customer_v2 = []
 payment_methods_v2 = []
 crypto_openssl = ["dep:openssl"]
+tokenization_v2 = []
 
 [dependencies]
 async-trait = { version = "0.1.79", optional = true }

crates/common_utils/src/consts.rs

@@ -179,6 +179,10 @@ pub const DEFAULT_CARD_TESTING_GUARD_EXPIRY_IN_SECS: i32 = 3600;
 /// SOAP 1.1 Envelope Namespace
 pub const SOAP_ENV_NAMESPACE: &str = "http://schemas.xmlsoap.org/soap/envelope/";
 
+#[cfg(all(feature = "v2", feature = "tokenization_v2"))]
+/// Length of generated tokens
+pub const TOKEN_LENGTH: usize = 32;
+
 /// The tag name used for identifying the host in metrics.
 pub const METRICS_HOST_TAG_NAME: &str = "host";