feat(payments): [Payment links] add configs for payment link

[cookieg13]

Type of Change

• Bugfix
• New feature
• Enhancement
• Refactoring
• Dependency updates
• Documentation
• CI/CD

Description

1. Added config display_status_screen in payment links to decide whether to show status screen after payment completion

• If config is true, redirect user to status screen and then to return url
• If config is false, or not passed user will be redirected to return url directly

2. Added config background_color to customize background color for payment links
3. Added config payment_button_text_color to customize text color for payment button in payment link

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 locally

Update business_profile configs (with display_status_screen as true)

curl --location --request POST 'http://localhost:8080/account/merchant_1740126811/business_profile/pro_FirWioMrQWWbdkcvq1V5' \
--header 'Content-Type: application/json' \
--header 'api-key: test_admin' \
--data-raw '{
    "payment_link_config": {
        "allowed_domains": [
            "*"
        ],
        "payment_button_text": "PAY DG1",
        "display_status_screen": true
    }
}'

Create payment link

curl --location --request POST 'http://localhost:8080/payments' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'api-key: dev_SlhVlgngA1yBBe0SpxKfzDROCDxqTuFSAYA6Cg4SInxB3DpCODmTQJjHK5UEZqDJ' \
--data-raw '{
    "amount": 700,
    "currency": "USD",
    "payment_link": true,
    "session_expiry": 1000000,
    "return_url": "https://google.com",
    "payment_link_config": {
        "logo": "https://logosandtypes.com/wp-content/uploads/2020/08/zurich.svg",
        "seller_name": "Zurich Inc."
    }
}'

Payment link

Screen.Recording.2025-02-21.at.14.07.49.mov

Update business_profile configs (with display_status_screen as false)

curl --location --request POST 'http://localhost:8080/account/merchant_1740126811/business_profile/pro_FirWioMrQWWbdkcvq1V5' \
--header 'Content-Type: application/json' \
--header 'api-key: test_admin' \
--data-raw '{
    "payment_link_config": {
        "allowed_domains": [
            "*"
        ],
        "payment_button_text": "PAY DG1",
        "display_status_screen": false
    }
}'

Create payment link

curl --location --request POST 'http://localhost:8080/payments' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'api-key: dev_SlhVlgngA1yBBe0SpxKfzDROCDxqTuFSAYA6Cg4SInxB3DpCODmTQJjHK5UEZqDJ' \
--data-raw '{
    "amount": 700,
    "currency": "USD",
    "payment_link": true,
    "session_expiry": 1000000,
    "return_url": "https://google.com",
    "payment_link_config": {
        "logo": "https://logosandtypes.com/wp-content/uploads/2020/08/zurich.svg",
        "seller_name": "Zurich Inc."
    }
}'

Payment link

Screen.Recording.2025-02-21.at.14.08.20.mov

Update business_profile configs (with background_color , payment_button_text_color)

curl --location --request POST 'http://localhost:8080/account/merchant_1740396251/business_profile/pro_BqO3rMoGzXliePMyBIY2' \
--header 'Content-Type: application/json' \
--header 'api-key: test_admin' \
--data-raw '{
    "payment_link_config": {
        "allowed_domains": [
            "*"
        ],
        "payment_button_text": "PAY DG1",
        "display_status_screen": false,
        "background_color": "#afff7b",
        "payment_button_color": "#000000",
        "payment_button_text_color": "#ff0000"
    }
}'

Create payment link

curl --location --request POST 'http://localhost:8080/payments' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'api-key: dev_SlhVlgngA1yBBe0SpxKfzDROCDxqTuFSAYA6Cg4SInxB3DpCODmTQJjHK5UEZqDJ' \
--data-raw '{
    "amount": 700,
    "currency": "USD",
    "payment_link": true,
    "session_expiry": 1000000,
    "return_url": "https://google.com",
    "payment_link_config": {
        "logo": "https://logosandtypes.com/wp-content/uploads/2020/08/zurich.svg",
        "seller_name": "Zurich Inc."
    }
}'

Payment link

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]

Review changes with  

Changed Files

File	Status
crates/router/src/core/payment_link/payment_link_initiate/payment_link.js	18% smaller
crates/router/src/core/payment_link.rs	10% smaller
api-reference-v2/openapi_spec.json	0% smaller
api-reference/openapi_spec.json	0% smaller
crates/api_models/src/admin.rs	0% smaller
crates/api_models/src/payments.rs	0% smaller
crates/diesel_models/src/business_profile.rs	0% smaller
crates/diesel_models/src/payment_intent.rs	0% smaller
crates/hyperswitch_domain_models/src/lib.rs	0% smaller
crates/router/src/core/payments/transformers.rs	0% smaller
crates/router/src/types/transformers.rs	0% smaller

[kashif-m]

We should revert the field back to payment_button_colour as it's already being used.

[sahkal]

Ideal behavior of a payment link is to have status page display, whereas this PR does the opposite. Can we have discussion regarding this before moving forward