feat: add test_mode for quickly testing payout links #5669

kashif-m · 2024-08-22T11:01:33Z

Type of Change

Description

Described in #5668

Additional Changes

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

Motivation and Context

Allows for easily testing payout links in non prod env.

How did you test it?

1. Create payout link without setting allowed_domains - *SHOULD FAIL*

curl --location 'http://localhost:8080/payouts/create' \
    --header 'Accept-Language: fr' \
    --header 'Content-Type: application/json' \
    --header 'api-key: dev_1axlWLG2ZUMWX1B8TMZ7m1Y7EMIzJl5BW1iLEB6etVvLbEQ1XCKSj6rXHYegkkd3' \
    --data '{
        "amount": 1,
        "currency": "EUR",
        "customer_id": "cus_8GU0bxEIp0EyvQiGSoXw",
        "description": "Its my first payout request",
        "billing": {
            "address": {
                "city": "Hoogeveen",
                "country": "NL",
                "line1": "Raadhuisplein",
                "line2": "92",
                "zip": "7901 BW",
                "state": "FL",
                "first_name": "John",
                "last_name": "Doe"
            },
            "phone": {
                "number": "0650242319",
                "country_code": "+31"
            }
        },
        "return_url": "https://www.google.co.in",
        "entity_type": "Individual",
        "confirm": false,
        "auto_fulfill": true,
        "session_expiry": 1000000,
        "priority": "instant",
        "profile_id": "pro_24e5hK7LExVPjGqadW55",
        "payout_link": true,
        "connector": [
            "adyen"
        ],
        "payout_link_config": {
            "theme": "#0066ff",
            "logo": "https://hyperswitch.io/favicon.ico",
            "merchant_name": "HyperSwitch Inc.",
            
            "enabled_payment_methods": [
                {
                    "payment_method": "card",
                    "payment_method_types": [
                        "debit",
                        "credit"
                    ]
                },
                {
                    "payment_method": "bank_transfer",
                    "payment_method_types": [
                        "ach",
                        "bacs",
                        "sepa"
                    ]
                },
                {
                    "payment_method": "wallet",
                    "payment_method_types": [
                        "pix",
                        "paypal",
                        "venmo"
                    ]
                }
            ]
        }
    }'

2. Create payout link without setting allowed_domains in test_mode - *PASS*

curl --location 'http://localhost:8080/payouts/create' \
    --header 'Accept-Language: fr' \
    --header 'Content-Type: application/json' \
    --header 'api-key: dev_1axlWLG2ZUMWX1B8TMZ7m1Y7EMIzJl5BW1iLEB6etVvLbEQ1XCKSj6rXHYegkkd3' \
    --data '{
        "amount": 1,
        "currency": "EUR",
        "customer_id": "cus_8GU0bxEIp0EyvQiGSoXw",
        "description": "Its my first payout request",
        "billing": {
            "address": {
                "city": "Hoogeveen",
                "country": "NL",
                "line1": "Raadhuisplein",
                "line2": "92",
                "zip": "7901 BW",
                "state": "FL",
                "first_name": "John",
                "last_name": "Doe"
            },
            "phone": {
                "number": "0650242319",
                "country_code": "+31"
            }
        },
        "return_url": "https://www.google.co.in",
        "entity_type": "Individual",
        "confirm": false,
        "auto_fulfill": true,
        "session_expiry": 1000000,
        "priority": "instant",
        "profile_id": "pro_24e5hK7LExVPjGqadW55",
        "payout_link": true,
        "connector": [
            "adyen"
        ],
        "payout_link_config": {
            "theme": "#0066ff",
            "logo": "https://hyperswitch.io/favicon.ico",
            "merchant_name": "HyperSwitch Inc.",
            "test_mode": true,
            "enabled_payment_methods": [
                {
                    "payment_method": "card",
                    "payment_method_types": [
                        "debit",
                        "credit"
                    ]
                },
                {
                    "payment_method": "bank_transfer",
                    "payment_method_types": [
                        "ach",
                        "bacs",
                        "sepa"
                    ]
                },
                {
                    "payment_method": "wallet",
                    "payment_method_types": [
                        "pix",
                        "paypal",
                        "venmo"
                    ]
                }
            ]
        }
    }'

3. Create payout link using allowed_domains without test_mode - *SHOULD OPEN ONLY IN AN IFRAME*

curl --location 'http://localhost:8080/payouts/create' \
    --header 'Accept-Language: fr' \
    --header 'Content-Type: application/json' \
    --header 'api-key: dev_1axlWLG2ZUMWX1B8TMZ7m1Y7EMIzJl5BW1iLEB6etVvLbEQ1XCKSj6rXHYegkkd3' \
    --data '{
        "amount": 1,
        "currency": "EUR",
        "customer_id": "cus_8GU0bxEIp0EyvQiGSoXw",
        "description": "Its my first payout request",
        "billing": {
            "address": {
                "city": "Hoogeveen",
                "country": "NL",
                "line1": "Raadhuisplein",
                "line2": "92",
                "zip": "7901 BW",
                "state": "FL",
                "first_name": "John",
                "last_name": "Doe"
            },
            "phone": {
                "number": "0650242319",
                "country_code": "+31"
            }
        },
        "return_url": "https://www.google.co.in",
        "entity_type": "Individual",
        "confirm": false,
        "auto_fulfill": true,
        "session_expiry": 1000000,
        "priority": "instant",
        "profile_id": "pro_24e5hK7LExVPjGqadW55",
        "payout_link": true,
        "connector": [
            "adyen"
        ],
        "payout_link_config": {
            "theme": "#0066ff",
            "logo": "https://hyperswitch.io/favicon.ico",
            "merchant_name": "HyperSwitch Inc.",
            
            "enabled_payment_methods": [
                {
                    "payment_method": "card",
                    "payment_method_types": [
                        "debit",
                        "credit"
                    ]
                },
                {
                    "payment_method": "bank_transfer",
                    "payment_method_types": [
                        "ach",
                        "bacs",
                        "sepa"
                    ]
                },
                {
                    "payment_method": "wallet",
                    "payment_method_types": [
                        "pix",
                        "paypal",
                        "venmo"
                    ]
                }
            ]
        }
    }'

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 · 2024-08-22T11:01:36Z

Review changes with SemanticDiff.

Analyzed 8 of 11 files.

Overall, the semantic diff is 69% smaller than the GitHub diff.

	Filename	Status
✔️	crates/router/src/types/transformers.rs	Analyzed
✔️	crates/router/src/core/payout_link.rs	54.4% smaller
✔️	crates/router/src/core/payouts.rs	44.04% smaller
✔️	crates/router/src/core/payouts/validator.rs	89.5% smaller
❔	crates/router/src/core/generic_link/payout_link/initiate/script.js	Unsupported file format
✔️	crates/diesel_models/src/business_profile.rs	Analyzed
❔	crates/common_utils/src/link_utils.rs	Unsupported file format
✔️	crates/api_models/src/admin.rs	Analyzed
❔	crates/api_models/src/payouts.rs	Unsupported file format
✔️	api-reference-v2/openapi_spec.json	12.5% smaller
✔️	api-reference/openapi_spec.json	12.5% smaller

crates/api_models/src/admin.rs

crates/diesel_models/src/business_profile.rs

* 'main' of github.com:juspay/hyperswitch: refactor(open_banking): Added merchant data update in mca update (#5655) feat: add test_mode for quickly testing payout links (#5669) refactor: introduce a domain type for profile ID (#5687) ci(cypress): update paybox configs (#5664) feat(openapi): Add open api routes for routing v2 (#5686) feat(connector): [NOVALNET] Add template code (#5670) feat(user): business email update (#5674) chore(config): add production connector-configs for netcetera external 3ds flow (#5698) chore(version): 2024.08.27.0 refactor(euclid): make the disabled node's relation as negative (#5701) feat: populate payment method details in payments response (#5661) build(deps): bump `diesel` to `2.2.3` and `sqlx` to `0.8.1` (#5688)

* 'main' of github.com:juspay/hyperswitch: (134 commits) refactor(open_banking): Added merchant data update in mca update (#5655) feat: add test_mode for quickly testing payout links (#5669) refactor: introduce a domain type for profile ID (#5687) ci(cypress): update paybox configs (#5664) feat(openapi): Add open api routes for routing v2 (#5686) feat(connector): [NOVALNET] Add template code (#5670) feat(user): business email update (#5674) chore(config): add production connector-configs for netcetera external 3ds flow (#5698) chore(version): 2024.08.27.0 refactor(euclid): make the disabled node's relation as negative (#5701) feat: populate payment method details in payments response (#5661) build(deps): bump `diesel` to `2.2.3` and `sqlx` to `0.8.1` (#5688) feat(customer_v2): added list customer v2 end point (#5517) feat(business_profile): add tax_connector_id column in business_profile table (#5576) chore: create v2 route for organization (#5679) refactor(payments_response): remove setter from payments response (#5676) feat(payment_methods_v2): Payment methods v2 API models (#5564) chore(version): 2024.08.26.0 feat(connector): [Adyen] add dispute flows for adyen connector (#5514) chore(version): 2024.08.23.0 ...

…-key-check * 'main' of github.com:juspay/hyperswitch: feat(core): Add mTLS certificates for each request (#5636) refactor(open_banking): Added merchant data update in mca update (#5655) feat: add test_mode for quickly testing payout links (#5669) refactor: introduce a domain type for profile ID (#5687) ci(cypress): update paybox configs (#5664) feat(openapi): Add open api routes for routing v2 (#5686) feat(connector): [NOVALNET] Add template code (#5670) feat(user): business email update (#5674) chore(config): add production connector-configs for netcetera external 3ds flow (#5698) chore(version): 2024.08.27.0 refactor(euclid): make the disabled node's relation as negative (#5701) feat: populate payment method details in payments response (#5661) build(deps): bump `diesel` to `2.2.3` and `sqlx` to `0.8.1` (#5688) feat(customer_v2): added list customer v2 end point (#5517) feat(business_profile): add tax_connector_id column in business_profile table (#5576) chore: create v2 route for organization (#5679) refactor(payments_response): remove setter from payments response (#5676) feat(payment_methods_v2): Payment methods v2 API models (#5564) chore(version): 2024.08.26.0

feat: add test_mode for quickly testing payout links

43e2881

kashif-m added A-core Area: Core flows S-waiting-on-review Status: This PR has been implemented and needs to be reviewed R-waiting-on-L1 Review: Waiting on L1 reviewer Payouts Area: Payouts labels Aug 22, 2024

kashif-m self-assigned this Aug 22, 2024

kashif-m requested review from a team as code owners August 22, 2024 11:01

kashif-m added the M-api-contract-changes Metadata: This PR involves API contract changes label Aug 22, 2024

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

docs(openapi): re-generate OpenAPI specification

7d2362b

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

kashif-m linked an issue Aug 22, 2024 that may be closed by this pull request

[FEATURE] allow testing payout links in test_mode #5668

Closed

2 tasks

SanchithHegde previously approved these changes Aug 23, 2024

View reviewed changes

kashif-m added 2 commits August 26, 2024 12:08

Merge remote-tracking branch 'origin/main' into payout-link-test-mode

27de9b0

refactor: add missing check for test_mode in production

093e1aa

kashif-m dismissed SanchithHegde’s stale review via 093e1aa August 26, 2024 06:47

docs(openapi): re-generate OpenAPI specification

82ced54

jarnura requested changes Aug 26, 2024

View reviewed changes

crates/api_models/src/admin.rs Outdated Show resolved Hide resolved

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

kashif-m and others added 3 commits August 26, 2024 15:00

refactor: rename test_mode to payout_test_mode

ec942fe

Merge remote-tracking branch 'origin/main' into payout-link-test-mode

2552608

docs(openapi): re-generate OpenAPI specification

09389ce

kashif-m requested a review from jarnura August 26, 2024 09:41

jarnura approved these changes Aug 26, 2024

View reviewed changes

kashif-m requested a review from SanchithHegde August 26, 2024 10:09

SanchithHegde approved these changes Aug 26, 2024

View reviewed changes

Gnanasundari24 added this pull request to the merge queue Aug 27, 2024

Merged via the queue into main with commit 406256c Aug 27, 2024
14 checks passed

Gnanasundari24 deleted the payout-link-test-mode branch August 27, 2024 08:31

pixincreate removed S-waiting-on-review Status: This PR has been implemented and needs to be reviewed R-waiting-on-L1 Review: Waiting on L1 reviewer labels Aug 29, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add test_mode for quickly testing payout links #5669

feat: add test_mode for quickly testing payout links #5669

kashif-m commented Aug 22, 2024 •

edited

Loading

semanticdiff-com bot commented Aug 22, 2024 •

edited

Loading

feat: add test_mode for quickly testing payout links #5669

feat: add test_mode for quickly testing payout links #5669

Conversation

kashif-m commented Aug 22, 2024 • edited Loading

Type of Change

Description

Additional Changes

Motivation and Context

How did you test it?

Checklist

semanticdiff-com bot commented Aug 22, 2024 • edited Loading

kashif-m commented Aug 22, 2024 •

edited

Loading

semanticdiff-com bot commented Aug 22, 2024 •

edited

Loading