feat(business_profile): added merchant country code in business profile by sahkal · Pull Request #8529 · juspay/hyperswitch

sahkal · 2025-07-02T08:49:05Z

Type of Change

New feature

Description

1. Database Migration

Added: New migration 2025-07-02-071146_add-merchant-country-code-in-business-profile
- Up migration: Adds merchant_country_code INTEGER column to business_profile table
- Down migration: Removes the merchant_country_code column

2. Database Model Updates

File: crates/diesel_models/src/business_profile.rs
- Added merchant_country_code: Option<i32> field to all profile structs:
  - Profile struct (both v1 and v2 versions)
  - ProfileNew struct (both v1 and v2 versions)
  - ProfileUpdateInternal struct (both v1 and v2 versions)
- Updated apply_changeset methods to handle the new field
- Field is positioned as the last field in all structs

3. Domain Model Updates

File: crates/hyperswitch_domain_models/src/business_profile.rs
- Added merchant_country_code: Option<i32> to domain Profile structs (both v1 and v2)
- Added field to ProfileSetter structs
- Updated ProfileGeneralUpdate structs to include the new field
- Updated conversion methods (convert, convert_back, construct_new) to handle the field
- Updated all ProfileUpdate enum variants to include merchant_country_code: None in update operations

4. API Model Updates

File: crates/api_models/src/admin.rs
- Added merchant_country_code field to profile-related structs:
  - ProfileCreate (both v1 and v2 versions)
  - ProfileResponse (both v1 and v2 versions)
  - ProfileUpdate (both v1 and v2 versions)
- Field is documented with schema annotations: value_type = Option<i32>, example = 840
- Field represents a numeric country code (e.g., 840 for United States)

Key Technical Details

Data Type:

Uses Option<i32> to allow null values (optional field)
Stores numeric country codes rather than alpha codes

Backward Compatibility:

All changes maintain backward compatibility by making the field optional
Existing profiles will have NULL values for this field initially
Database migration uses IF NOT EXISTS to safely add the column

Feature Flags:

Changes are properly segregated between v1 and v2 feature flags
Both versions of the API support the new field

Integration Points:

Field is integrated into all CRUD operations for business profiles
Conversion between different model layers (API → Domain → Database) properly handles the field
Update operations preserve existing values when not explicitly changed

Additional Changes

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

Do Profile Acquirer Create

curl --location 'localhost:8080/profile_acquirer' \
--header 'Content-Type: application/json' \
--header 'api-key: dev_yxuko5Ijbd9iJUbWT1EUGXH7tKDQXWXPSh7GAZY9BOsbSDsqFihTVSaMPwrMsGCC' \
--data '{
  "acquirer_assigned_merchant_id": "00002000000",
  "merchant_name": "Demo Merchant",
  "network": "AmericanExpress",
  "acquirer_bin": "400000",
  "acquirer_fraud_rate": 0.2345545234765,
  "profile_id": "pro_czw39KVGhlGIexP6JBzC"
}'

the response should return 200

Create Business_profile with merchant_country_code

curl --location 'http://localhost:8080/account/sahkal11/business_profile'
--header 'Content-Type: application/json'
--header 'api-key: dev_yxuko5Ijbd9iJUbWT1EUGXH7tKDQXWXPSh7GAZY9BOsbSDsqFihTVSaMPwrMsGCC'
--data '{
"profile_name": "dqwdwcweqcewcxqwcwqqd",
"merchant_country_code": 840
}
'

Response

{
    "merchant_id": "sahkal11",
    "profile_id": "pro_d1IU0buWxmb29dk9889e",
    "profile_name": "dqwdwcweqcewcxqwcwqqd",
    "return_url": "https://google.com/success",
    "enable_payment_response_hash": true,
    "payment_response_hash_key": "FFGOhmbQrxLOGIAGmsLSfwkgOGZY8l2ybzh8t7xd29apSI6C665ysYiuKtjB6U2O",
    "redirect_to_merchant_with_http_post": false,
    "webhook_details": {
        "webhook_version": "1.0.1",
        "webhook_username": "ekart_retail",
        "webhook_password": "password_ekart@123",
        "webhook_url": null,
        "payment_created_enabled": true,
        "payment_succeeded_enabled": true,
        "payment_failed_enabled": true,
        "payment_statuses_enabled": null,
        "refund_statuses_enabled": null,
        "payout_statuses_enabled": null
    },
    "metadata": null,
    "routing_algorithm": null,
    "intent_fulfillment_time": 900,
    "frm_routing_algorithm": null,
    "payout_routing_algorithm": null,
    "applepay_verified_domains": null,
    "session_expiry": 900,
    "payment_link_config": null,
    "authentication_connector_details": null,
    "use_billing_as_payment_method_billing": true,
    "extended_card_info_config": null,
    "collect_shipping_details_from_wallet_connector": false,
    "collect_billing_details_from_wallet_connector": false,
    "always_collect_shipping_details_from_wallet_connector": false,
    "always_collect_billing_details_from_wallet_connector": false,
    "is_connector_agnostic_mit_enabled": false,
    "payout_link_config": null,
    "outgoing_webhook_custom_http_headers": null,
    "tax_connector_id": null,
    "is_tax_connector_enabled": false,
    "is_network_tokenization_enabled": false,
    "is_auto_retries_enabled": false,
    "max_auto_retries_enabled": null,
    "always_request_extended_authorization": null,
    "is_click_to_pay_enabled": false,
    "authentication_product_ids": null,
    "card_testing_guard_config": {
        "card_ip_blocking_status": "disabled",
        "card_ip_blocking_threshold": 3,
        "guest_user_card_blocking_status": "disabled",
        "guest_user_card_blocking_threshold": 10,
        "customer_id_blocking_status": "disabled",
        "customer_id_blocking_threshold": 5,
        "card_testing_guard_expiry": 3600
    },
    "is_clear_pan_retries_enabled": false,
    "force_3ds_challenge": false,
    "is_debit_routing_enabled": false,
    "merchant_business_country": null,
    "is_pre_network_tokenization_enabled": false,
    "acquirer_configs": null,
    "is_iframe_redirection_enabled": null,
    "merchant_category_code": null,
    "merchant_country_code": "840"
}

the response should return 200

Try Updating business profile with merchant_country_code

curl --location 'http://localhost:8080/account/sahkal11/business_profile/pro_d1IU0buWxmb29dk9889e' \
--header 'Content-Type: application/json' \
--header 'api-key: dev_yxuko5Ijbd9iJUbWT1EUGXH7tKDQXWXPSh7GAZY9BOsbSDsqFihTVSaMPwrMsGCC' \
--data '
{
    "merchant_country_code": "840"
}
'

Response should return 200

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 · 2025-07-02T08:49:08Z

Review changes with

Changed Files

File	Status
crates/diesel_models/src/schema_v2.rs	16% smaller
crates/router/src/core/payments/operations/payment_confirm.rs	14% smaller
crates/common_types/src/payments.rs	8% smaller
Cargo.lock	Unsupported file format
api-reference/v1/openapi_spec_v1.json	0% smaller
api-reference/v2/openapi_spec_v2.json	0% smaller
crates/api_models/src/admin.rs	0% smaller
crates/api_models/src/profile_acquirer.rs	0% smaller
crates/common_types/Cargo.toml	Unsupported file format
crates/common_types/src/domain.rs	0% smaller
crates/diesel_models/src/business_profile.rs	0% smaller
crates/diesel_models/src/schema.rs	0% smaller
crates/hyperswitch_domain_models/src/business_profile.rs	0% smaller
crates/openapi/src/openapi.rs	0% smaller
crates/openapi/src/openapi_v2.rs	0% smaller
crates/router/src/core/admin.rs	0% smaller
crates/router/src/core/profile_acquirer.rs	0% smaller
crates/router/src/types/api/admin.rs	0% smaller
migrations/2025-07-02-071146_add-merchant-country-code-in-business-profile/down.sql	Unsupported file format
migrations/2025-07-02-071146_add-merchant-country-code-in-business-profile/up.sql	Unsupported file format

crates/api_models/src/admin.rs

crates/router/src/core/payments/operations/payment_confirm.rs

Chethan-rao · 2025-07-08T07:38:53Z

crates/hyperswitch_domain_models/src/business_profile.rs

+                        router_env::logger::error!("Invalid country code {}: {:?}", code, err);
+                        Err(error_stack::Report::new(
+                            api_error_response::ApiErrorResponse::InvalidDataValue {
+                                field_name: "merchant_country_code",
+                            },
+                        ))


Instead of logging an error and then returning a Report, can we do attach_printable on Report itself. because this will produce 2 different logs (one from logger:error and other from propagated parent error log) and makes debugging little difficult

Chethan-rao · 2025-07-08T07:44:05Z

crates/router/src/core/payments/operations/payment_confirm.rs

                    .clone()
                    .and_then(|network| business_profile.get_acquirer_details_from_network(network))
            });
+            let country = business_profile.get_country_from_merchant_country_code()?;


is it fine to break the flow because of this?

yes, its a required value so breaking the flow for 3ds intelligence should be fine

Chethan-rao · 2025-07-08T07:46:42Z

crates/hyperswitch_domain_models/src/business_profile.rs

+                    router_env::logger::error!(
+                        "Country code {} is negative or too large: {:?}",
+                        country_code,
+                        err
+                    );
+                    Err(error_stack::Report::new(
+                        api_error_response::ApiErrorResponse::InvalidDataValue {
+                            field_name: "merchant_country_code",
+                        },
+                    ))


Chethan-rao · 2025-07-08T07:51:01Z

crates/hyperswitch_domain_models/src/business_profile.rs

+            .map(|country_code| match country_code.parse::<u32>() {
+                Ok(code) => match common_enums::Country::from_numeric(code) {
+                    Ok(country) => Ok(country),
+                    Err(err) => {


I see that country_code is being stored in profile table without any validation (similar to one here), but its being validated in payments flow. shouldn't it be validated during save operation also just to be sure that legit code is stored in db and payment could happen without any error? or am i missing something?

sure, have added validation during insert and update Profile

Chethan-rao · 2025-07-08T11:11:53Z

crates/common_types/src/payments.rs

+            .map_err(|_| errors::ValidationError::IncorrectValueProvided {
+                field_name: "merchant_country_code",
+            })


why are you ignoring the error? can we do change_context instead?

Chethan-rao · 2025-07-08T11:11:59Z

crates/common_types/src/payments.rs

+            .map_err(|_| errors::ValidationError::IncorrectValueProvided {
+                field_name: "merchant_country_code",
+            })


…iness-profile-from-acquirer_config

…le-from-acquirer_config' of github.com:juspay/hyperswitch into 10137-flatten-merchant_country_code-into-business-profile-from-acquirer_config

…iness-profile-from-acquirer_config

added merchant country code in business profile

2612898

sahkal added this to the June 2025 Release milestone Jul 2, 2025

sahkal self-assigned this Jul 2, 2025

sahkal added the C-feature Category: Feature request or enhancement label Jul 2, 2025

sahkal requested review from a team as code owners July 2, 2025 08:49

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 Jul 2, 2025

sahkal added 2 commits July 2, 2025 14:36

fixed v2 schema

c0b10fb

added open-api specs for v2

93f31da

sai-harsha-vardhan reviewed Jul 3, 2025

View reviewed changes

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

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

crates/router/src/core/payments/operations/payment_confirm.rs Show resolved Hide resolved

resolved pr comments

3c1e2e7

sahkal requested a review from sai-harsha-vardhan July 7, 2025 07:19

Chethan-rao suggested changes Jul 8, 2025

View reviewed changes

added merchant country code domain type for validation support

3dc7b0b

sahkal requested a review from Chethan-rao July 8, 2025 09:50

Chethan-rao suggested changes Jul 8, 2025

View reviewed changes

sahkal and others added 4 commits July 8, 2025 16:44

Merge branch 'main' into 10137-flatten-merchant_country_code-into-bus…

cded3c9

…iness-profile-from-acquirer_config

chore: update Cargo.lock

1cb0194

resolved pr comments:

c960486

Merge branch '10137-flatten-merchant_country_code-into-business-profi…

0f1dd42

…le-from-acquirer_config' of github.com:juspay/hyperswitch into 10137-flatten-merchant_country_code-into-business-profile-from-acquirer_config

sahkal requested a review from Chethan-rao July 9, 2025 08:10

Chethan-rao previously approved these changes Jul 9, 2025

View reviewed changes

sai-harsha-vardhan previously approved these changes Jul 9, 2025

View reviewed changes

likhinbopanna added this pull request to the merge queue Jul 14, 2025

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jul 14, 2025

sahkal and others added 2 commits July 14, 2025 15:58

Merge branch 'main' into 10137-flatten-merchant_country_code-into-bus…

195f2a5

…iness-profile-from-acquirer_config

fixed clippy error

973c0c3

sahkal dismissed sai-harsha-vardhan’s stale review via 973c0c3 July 14, 2025 10:33

sahkal dismissed Chethan-rao’s stale review via 973c0c3 July 14, 2025 10:33

Chethan-rao approved these changes Jul 14, 2025

View reviewed changes

sai-harsha-vardhan approved these changes Jul 14, 2025

View reviewed changes

likhinbopanna enabled auto-merge July 14, 2025 10:43

likhinbopanna added this pull request to the merge queue Jul 14, 2025

Merged via the queue into main with commit 44f8964 Jul 14, 2025
16 of 20 checks passed

likhinbopanna deleted the 10137-flatten-merchant_country_code-into-business-profile-from-acquirer_config branch July 14, 2025 12:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(business_profile): added merchant country code in business profile#8529

feat(business_profile): added merchant country code in business profile#8529
likhinbopanna merged 11 commits intomainfrom
10137-flatten-merchant_country_code-into-business-profile-from-acquirer_config

sahkal commented Jul 2, 2025 •

edited

Loading

Uh oh!

semanticdiff-com bot commented Jul 2, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Chethan-rao Jul 8, 2025

Uh oh!

Chethan-rao Jul 8, 2025

Uh oh!

sahkal Jul 8, 2025

Uh oh!

Chethan-rao Jul 8, 2025

Uh oh!

Chethan-rao Jul 8, 2025

Uh oh!

sahkal Jul 8, 2025

Uh oh!

Chethan-rao Jul 8, 2025

Uh oh!

Chethan-rao Jul 8, 2025

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

sahkal commented Jul 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Type of Change

Description

1. Database Migration

2. Database Model Updates

3. Domain Model Updates

4. API Model Updates

Key Technical Details

Data Type:

Backward Compatibility:

Feature Flags:

Integration Points:

Additional Changes

Checklist

Uh oh!

semanticdiff-com bot commented Jul 2, 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

sahkal commented Jul 2, 2025 •

edited

Loading

semanticdiff-com bot commented Jul 2, 2025 •

edited

Loading