refactor(core): introduce new field in payment_intent to handle longer return_url by Sakilmostak · Pull Request #8135 · juspay/hyperswitch

Sakilmostak · 2025-05-25T20:01:48Z

Type of Change

Description

A new field in introduced in payment_intent table called extended_return_url
This deprecate the existing return_url field since it can take string only upto length 255
extended_return_url can now take length upto 2048 size
write is done into the new field (extended_return_url)
read is backward compatible (return_url as fallback)

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?

Tested through Postman:

Create a Payment with return url length smaller than 2048

curl --location '{{baseUrl}}/payments' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'api-key:{{api_key}}' \
--data-raw '{
    "amount": 499,
    "currency": "USD",
    "confirm": true,
    "capture_method": "automatic",
    "customer_id": "test_rec7",
    "email": "guest@example.com",
    
    "customer_acceptance": {
        "acceptance_type": "online"
    },
    "return_url": "https://www.duckduckgo.com",
    "payment_method": "card",
    "payment_method_type": "credit",
    "payment_method_data": {
        "card": {
            "card_number": "4242424242424242",
            "card_exp_month": "02",
            "card_exp_year": "26",
            "card_holder_name": "Joseph Doe",
            "card_cvc": "999"
        },
        "billing": {
            "address": {
                "line1": "8th block",
                "line2": "8th block",
                "line3": "8th block",
                "city": "Bengaluru",
                "state": "Karnataka",
                "zip": "560095",
                "country": "IN",
                "first_name": "Sakil",
                "last_name": "Mostak"
            }
        }
    },
    "billing": {
        "address": {
            "city": "test",
            "country": "US",
            "line1": "here is some \n there is some \n none is some? \n ",
            "line2": "there",
            "line3": "anywhere",
            "zip": "560095",
            "state": "CA",
            "first_name": "Sakil",
            "last_name": "Mostak"
        },
        "phone": {
            "number": "1234567890",
            "country_code": "+1"
        },
        "email": "guest@example.com"
    },
    "browser_info": {
        "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36",
        "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8",
        "language": "nl-NL",
        "color_depth": 24,
        "screen_height": 723,
        "screen_width": 1536,
        "time_zone": 0,
        "java_enabled": true,
        "java_script_enabled": true,
        "ip_address": "127.0.0.1"
    },
    "authentication_type": "three_ds"
    
}'

Create a Payment with return url length greater than 2048

curl --location '{{baseUrl}}/payments' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'api-key:{{api_key}}' \
--data-raw '{
    "amount": 499,
    "currency": "USD",
    "confirm": true,
    "capture_method": "automatic",
    "customer_id": "test_rec7",
    "email": "guest@example.com",
    
    "customer_acceptance": {
        "acceptance_type": "online"
    },
    "return_url": "https://www.duckduckgo.comaaaqaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "payment_method": "card",
    "payment_method_type": "credit",
    "payment_method_data": {
        "card": {
            "card_number": "4242424242424242",
            "card_exp_month": "02",
            "card_exp_year": "26",
            "card_holder_name": "Joseph Doe",
            "card_cvc": "999"
        },
        "billing": {
            "address": {
                "line1": "8th block",
                "line2": "8th block",
                "line3": "8th block",
                "city": "Bengaluru",
                "state": "Karnataka",
                "zip": "560095",
                "country": "IN",
                "first_name": "Sakil",
                "last_name": "Mostak"
            }
        }
    },
    "billing": {
        "address": {
            "city": "test",
            "country": "US",
            "line1": "here is some \n there is some \n none is some? \n ",
            "line2": "there",
            "line3": "anywhere",
            "zip": "560095",
            "state": "CA",
            "first_name": "Sakil",
            "last_name": "Mostak"
        },
        "phone": {
            "number": "1234567890",
            "country_code": "+1"
        },
        "email": "guest@example.com"
    },
    "browser_info": {
        "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36",
        "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8",
        "language": "nl-NL",
        "color_depth": 24,
        "screen_height": 723,
        "screen_width": 1536,
        "time_zone": 0,
        "java_enabled": true,
        "java_script_enabled": true,
        "ip_address": "127.0.0.1"
    },
    "authentication_type": "three_ds"
}'

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

…rn_url

semanticdiff-com · 2025-05-25T20:01:51Z

Review changes with

Changed Files

File	Status
cypress-tests/cypress/e2e/configs/Payment/Commons.js	73% smaller
api-reference/openapi_spec.json	67% smaller
crates/hyperswitch_domain_models/src/payments/payment_intent.rs	28% smaller
crates/diesel_models/src/payment_intent.rs	1% smaller
crates/api_models/src/payments.rs	0% smaller
crates/diesel_models/src/schema.rs	0% smaller
cypress-tests/cypress/e2e/spec/Payment/00022-Variations.cy.js	0% smaller
migrations/2025-05-25-185220_add-merchant_return_url-column-to-payment_intent/down.sql	Unsupported file format
migrations/2025-05-25-185220_add-merchant_return_url-column-to-payment_intent/up.sql	Unsupported file format
v2_migrations/2025-01-13-081847_drop_v1_columns/up.sql	Unsupported file format

crates/hyperswitch_domain_models/src/payments/payment_intent.rs

crates/diesel_models/src/payment_intent.rs

This reverts commit b5e4f23.

…nktransfer * 'main' of github.com:juspay/hyperswitch: (211 commits) feat(tokenio): Add OpenBanking Redirection Flow (#8152) fix: Unified scarf setup (#8238) feat(health): Health check for Decision engine (#8243) chore: Update apple pay currency filter configs (#8217) refactor(customers_v2): Remove merchant reference id from v2 customer update (#7879) chore(version): 2025.06.09.0 chore(postman): update Postman collection files ci(postman): add tunnel collection to postman tests (#8269) feat(connector): Added recurring payments support for split payments in Stripe (#8271) feat(connector): [STRIPE] Added Connector Tokenization Flow for Cards (#8248) refactor(core): introduce new field in payment_intent to handle longer return_url (#8135) fix(connector): [AUTHORIZEDOTNET] Remove country PM filters (#8278) refactor(config): redact config urls for hyperswitch vault (#8276) feat(vsaas): enable onboarding of Standard Merchant Accounts in Platform Organization (#8231) feat(router): add three_ds decision rule execute api (#8148) feat(router): Save payment method on payments confirm (V2) (#8090) ci(cypress): Add Airwallex Connector Test (#8187) feat(payment_methods): add `external_vault_details` for payments v2 sdk session call (#8003) fix(connector): [facilitapay] cpf is a required field (#8274) fix: Fixed spell check (#8227) ...

…r return_url (#8135) Co-authored-by: hyperswitch-bot[bot] <148525504+hyperswitch-bot[bot]@users.noreply.github.com>

refactor: introduce new field in payment_intent to handle longer retu…

dbed6ad

…rn_url

Sakilmostak added this to the May 2025 Release milestone May 25, 2025

Sakilmostak self-assigned this May 25, 2025

Sakilmostak requested a review from a team as a code owner May 25, 2025 20:01

Sakilmostak added A-core Area: Core flows C-refactor Category: Refactor labels May 25, 2025

hyperswitch-bot bot added M-database-changes Metadata: This PR involves database schema changes M-api-contract-changes Metadata: This PR involves API contract changes labels May 25, 2025

refactor: enable cypress test for return_url_length

da93b70

Sakilmostak requested a review from a team as a code owner May 26, 2025 08:58

Narayanbhat166 reviewed May 26, 2025

View reviewed changes

crates/hyperswitch_domain_models/src/payments/payment_intent.rs Outdated Show resolved Hide resolved

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

refactor: resolve comments

f8f3ec6

Sakilmostak requested a review from Narayanbhat166 May 27, 2025 07:30

sai-harsha-vardhan reviewed May 30, 2025

View reviewed changes

crates/diesel_models/src/payment_intent.rs Show resolved Hide resolved

crates/diesel_models/src/payment_intent.rs Show resolved Hide resolved

Sakilmostak and others added 3 commits June 4, 2025 16:00

refactor: write to legacay field as well

b5e4f23

Merge branch 'main' into extended_return_url

72eeaea

chore(cypress): run formatter and address lints

1ada127

kashif-m previously approved these changes Jun 5, 2025

View reviewed changes

Revert "refactor: write to legacay field as well"

b75053c

This reverts commit b5e4f23.

Sakilmostak dismissed kashif-m’s stale review via b75053c June 7, 2025 07:26

sai-harsha-vardhan approved these changes Jun 7, 2025

View reviewed changes

su-shivanshmathur approved these changes Jun 7, 2025

View reviewed changes

Gnanasundari24 approved these changes Jun 7, 2025

View reviewed changes

Gnanasundari24 added this pull request to the merge queue Jun 7, 2025

Merged via the queue into main with commit a88eebd Jun 7, 2025
15 of 20 checks passed

Gnanasundari24 deleted the extended_return_url branch June 7, 2025 10:03

Sakilmostak added a commit that referenced this pull request Jun 11, 2025

refactor(core): introduce new field in payment_intent to handle longe…

0a9a740

…r return_url (#8135) Co-authored-by: hyperswitch-bot[bot] <148525504+hyperswitch-bot[bot]@users.noreply.github.com>

Sakilmostak mentioned this pull request Jun 11, 2025

refactor(core): introduce new field in payment_intent to handle longer return_url #8321

Merged

14 tasks

Sakilmostak added a commit that referenced this pull request Jun 11, 2025

refactor(core): introduce new field in payment_intent to handle longe…

67955d7

…r return_url (#8135) Co-authored-by: hyperswitch-bot[bot] <148525504+hyperswitch-bot[bot]@users.noreply.github.com>

Sakilmostak mentioned this pull request Jun 11, 2025

refactor(core): introduce new field in payment_intent to handle longer return_url #8322

Merged

14 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor(core): introduce new field in payment_intent to handle longer return_url#8135

refactor(core): introduce new field in payment_intent to handle longer return_url#8135
Gnanasundari24 merged 7 commits intomainfrom
extended_return_url

Sakilmostak commented May 25, 2025 •

edited by sai-harsha-vardhan

Loading

Uh oh!

semanticdiff-com bot commented May 25, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Conversation

Sakilmostak commented May 25, 2025 • edited by sai-harsha-vardhan 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 May 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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Sakilmostak commented May 25, 2025 •

edited by sai-harsha-vardhan

Loading

semanticdiff-com bot commented May 25, 2025 •

edited

Loading