feat(core): add support for payment links localization #5530

srujanchikke · 2024-08-05T19:57:54Z

Type of Change

Description

Add support for payment link localization in backend.

Additional Changes

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

Motivation and Context

This pr also passed locale from backend to SDK from Accept-Language headers. Static strings in javascript are declared in key value pairs in js, Using locale we transform the language.

The available languages in the locales constant are:

English (en)
Hebrew (he)
French (fr)
British English (en_GB)
Arabic (ar)
Japanese (ja)
German (de)
Belgian French (fr_BE)
Spanish (es)
Catalan (ca)
Portuguese (pt)
Italian (it)
Polish (pl)
Dutch (nl)
Swedish (sv)
Russian (ru)
Chinese (zh)

How did you test it?

Create a payment link - you can choose any language from above, pass short form any language. below i choose zh(chinese).
Step 1 :

curl --location 'http://localhost:8080/payments' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Accept-Language: zh' \
--header 'api-key: snd_efbc4c35649f45b2ac283bb2c1609730' \
--data-raw '{
    "amount":5000,
    "currency": "USD",
    "confirm": false,
    "payment_link" : true,
    "capture_on": "2029-09-10T10:11:12Z",
    "amount_to_capture": 5000,
    "email": "guest@example.com",
    "name": "John Doe",
    "phone": "999999999",
    "phone_country_code": "+1",
    "description": "Its my first payment request",
    "authentication_type": "three_ds",
    "return_url": "https://google.com",
    "payment_method_data": {
        "card": {
            "card_number": "4242424242424242",
            "card_exp_month": "03",
            "card_exp_year": "25",
            "card_holder_name": "chikke.srujan@juspay.in",
            "card_cvc": "737",
            "card_network": "Visa",
            "card_type": null,
            "card_issuing_country": null,
            "bank_code": null,
            "nick_name" : "srujan"
        },
        "billing": {
            "address": {
                "line1": "1467",
                "line2": "CA",
                "line3": "CA",
                "city": "San Fransico",
                "state": "California",
                "zip": "94122",
                "country": "NL",
                "first_name": "joseph",
                "last_name": "Doe"
            },
            "phone": {
                "number": "8056594427",
                "country_code": "+91"
            }
        }
    },
    "billing": {
            "address": {
                "line1": "1467",
                "line2": "CA",
                "line3": "CA",
                "city": "San Fransico",
                "state": "California",
                "zip": "94122",
                "country": "NL",
                "first_name": "joseph",
                "last_name": "Doe"
            },
            "phone": {
                "number": "8056594427",
                "country_code": "+91"
            }
        },
    "payment_method": "card",
    "payment_method_type" :"credit",
    "profile_id" : "pro_pzQKs5ECdVLWT2anGSz8",
    "customer_acceptance": {
        "acceptance_type": "online",
        "accepted_at": "2026-07-04T10:59:42.232Z",
        "online": {
            "ip_address": null,
            "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36 Edg/126.0.0.0"
        }
    },
    "browser_info": {
        "color_depth": 24,
        "java_enabled": true,
        "java_script_enabled": true,
        "language": "en-GB",
        "screen_height": 720,
        "screen_width": 1280,
        "time_zone": -330,
        "ip_address": "208.127.127.193",
        "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8",
        "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36 Edg/126.0.0.0"
    },
    "shipping": {
        "address": {
            "line1": "1467",
            "line2": "CA",
            "line3": "CA",
            "city": "San Fransico",
            "state": "California",
            "zip": "94122",
            "country": "NL",
            "first_name": "joseph",
            "last_name": "Doe"
        },
        "phone": {
            "number": "8056594427",
            "country_code": "+91"
        }
    },
    "metadata": {
        "udf1": "value1",
        "new_customer": "true",
        "login_date": "2019-09-10T10:11:12Z"
    },
    
    "order_details": [
        {
            "product_name": "Tea",
            "quantity": 1,
            "amount": 110,
            "product_img_link": "https://thumbs.dreamstime.com/b/indian-tea-spices-masala-chai-33827904.jpg"
        },
        {
            "product_name": "Tea",
            "quantity": 1,
            "amount": 110,
            "product_img_link": "https://thumbs.dreamstime.com/b/indian-tea-spices-masala-chai-33827904.jpg"
        },
        {
            "product_name": "Tea",
            "quantity": 1,
            "amount": 110,
            "product_img_link": "https://thumbs.dreamstime.com/b/indian-tea-spices-masala-chai-33827904.jpg"
        }
    ]
}'

after redirection everything should be chinese in payment link page.

Failure page :

Success page :

Test Case 2: Failed case , pass invalid Aceept-Language in header, it shoulb be able to default it to english.

Test Case 3: Enter pay now without redirecting after hitting payment link , error message should be in Accept-language

Test case 4: Test the same for secure payment links

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

sahkal · 2024-08-06T16:39:30Z

crates/router/src/core/payment_link.rs

-            .await?;
+    let locale = request_headers
+        .get(header::ACCEPT_LANGUAGE)
+        .and_then(|header_value| header_value.to_str().ok())


can we log the error, instead of ignoring it!

sahkal · 2024-08-06T16:40:17Z

crates/router/src/routes/payment_link.rs

+        .get(actix_web::http::header::ACCEPT_LANGUAGE)
+        .and_then(|header_value| header_value.to_str().ok())
+        .map(|str| str.to_owned());


sahkal · 2024-08-06T16:41:55Z

crates/router/src/routes/payment_link.rs

@@ -92,6 +99,7 @@ pub async fn initiate_secure_payment_link(
    let payload = api_models::payments::PaymentLinkInitiateRequest {
        payment_id,
        merchant_id: merchant_id.clone(),
+        locale: None,


is the locale only for open payment links, and not iframe embeded links?

PaymentLinkRequest is used for both payment links and secure payment links. In the case of payment links and status routes, we pass the locale to the flow. However, secure links already pass headers to the initiate_secure_payment_link_flow function. So I was consuming the locale from headers in secure_payment_link, and in all other cases, I am not passing headers to flows; instead, I am directly passing the locale.

can we unify it, it looks confusing at first glance!

sahkal · 2024-08-06T16:42:04Z

crates/router/src/routes/payment_link.rs

+        .get(actix_web::http::header::ACCEPT_LANGUAGE)
+        .and_then(|header_value| header_value.to_str().ok())
+        .map(|str| str.to_owned());
    let payload = api_models::payments::PaymentLinkInitiateRequest {


sahkal · 2024-08-07T07:32:53Z

crates/router/src/routes/payment_link.rs

@@ -92,6 +99,7 @@ pub async fn initiate_secure_payment_link(
    let payload = api_models::payments::PaymentLinkInitiateRequest {
        payment_id,
        merchant_id: merchant_id.clone(),
+        locale: None,


can we unify it, it looks confusing at first glance!

lsampras

rest looks good

lsampras · 2024-08-07T10:45:29Z

crates/router/src/core/payment_link.rs

@@ -64,6 +65,7 @@ pub async fn form_payment_link_data(
    key_store: domain::MerchantKeyStore,
    merchant_id: common_utils::id_type::MerchantId,
    payment_id: String,
+    locale: Option<String>,


this could be an enum for validation

We don't want to throw an error incase if client passes invalid enum of accept headers, that's the reason it was Option.

…e-connector-label-cypress * 'main' of github.com:juspay/hyperswitch: feat(core): add support for payment links localization (#5530) refactor(router): refactor `merchant_connector_account` retrieve and delete v2 apis (#5528) feat(cypress): add core flow tests (#5546) feat(cypress): add mandates and refunds variation cases (#5513) feat(cypress): add configs for not overriding screenshots (#5524) refactor(business_profile): use concrete types for JSON fields (#5531) feat(customer_v2): add customer create v2 endpoint (#5444) refactor(connector): added amount conversion framework for Mifinity (#5460) refactor(connector): added amount conversion framework for Boku (#5459) chore(version): 2024.08.07.0

Chikke Srujan and others added 4 commits August 1, 2024 12:34

add middleware for adding accept language header

900bb4f

chore: run formatter

fcbe2b7

resolve comments

90b6e93

add localization support for payment links

8d10fdb

srujanchikke added the A-core Area: Core flows label Aug 5, 2024

srujanchikke self-assigned this Aug 5, 2024

Chikke Srujan and others added 3 commits August 6, 2024 12:52

git rebase main

49b2d16

chore: run formatter

9b97f09

docs(openapi): re-generate OpenAPI specification

ee4b889

hyperswitch-bot bot added the M-api-contract-changes Metadata: This PR involves API contract changes label Aug 6, 2024

move locales to different file

03df1d6

srujanchikke marked this pull request as ready for review August 6, 2024 08:17

srujanchikke requested review from a team as code owners August 6, 2024 08:17

srujanchikke requested a review from sahkal August 6, 2024 08:17

hyperswitch-bot bot and others added 2 commits August 6, 2024 08:21

chore: run formatter

e9b72ad

exclued typos for locale.js

5f507a5

srujanchikke requested a review from a team as a code owner August 6, 2024 08:22

srujanchikke added C-feature Category: Feature request or enhancement S-waiting-on-review Status: This PR has been implemented and needs to be reviewed labels Aug 6, 2024

add locale

b7a4a94

srujanchikke requested a review from SanchithHegde August 6, 2024 10:10

move get_translation function to locale.js

4625b7e

sahkal reviewed Aug 6, 2024

View reviewed changes

resolve comments

698ccfb

sahkal previously approved these changes Aug 7, 2024

View reviewed changes

Merge branch 'main' into localization_for_payment_links

3d8f7a6

resolve comments

854ef6a

srujanchikke dismissed sahkal’s stale review via 854ef6a August 7, 2024 08:43

hyperswitch-bot bot removed the M-api-contract-changes Metadata: This PR involves API contract changes label Aug 7, 2024

Chikke Srujan added 2 commits August 7, 2024 14:56

remove log

ba44e50

resolve comments

55c4a0a

srujanchikke requested a review from a team as a code owner August 7, 2024 10:37

lsampras previously approved these changes Aug 7, 2024

View reviewed changes

remove try

a61c407

srujanchikke dismissed lsampras’s stale review via a61c407 August 7, 2024 10:59

srujanchikke removed the request for review from a team August 7, 2024 10:59

sahkal approved these changes Aug 7, 2024

View reviewed changes

srujanchikke removed the request for review from SanchithHegde August 7, 2024 11:10

lsampras approved these changes Aug 7, 2024

View reviewed changes

likhinbopanna enabled auto-merge August 7, 2024 11:30

likhinbopanna added this pull request to the merge queue Aug 7, 2024

Merged via the queue into main with commit 3604b4f Aug 7, 2024
26 checks passed

likhinbopanna deleted the localization_for_payment_links branch August 7, 2024 12:34

SanchithHegde removed the S-waiting-on-review Status: This PR has been implemented and needs to be reviewed label Aug 7, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(core): add support for payment links localization #5530

feat(core): add support for payment links localization #5530

srujanchikke commented Aug 5, 2024 •

edited

Loading

sahkal Aug 6, 2024

sahkal Aug 6, 2024

sahkal Aug 6, 2024

srujanchikke Aug 6, 2024

sahkal Aug 7, 2024

sahkal Aug 6, 2024

sahkal Aug 7, 2024

lsampras left a comment

lsampras Aug 7, 2024

srujanchikke Aug 7, 2024

feat(core): add support for payment links localization #5530

feat(core): add support for payment links localization #5530

Conversation

srujanchikke commented Aug 5, 2024 • edited Loading

Type of Change

Description

Additional Changes

Motivation and Context

How did you test it?

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lsampras left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

srujanchikke commented Aug 5, 2024 •

edited

Loading