Skip to content

feat(core): add profile level config for debit routing feature#7470

Merged
likhinbopanna merged 14 commits intomainfrom
add-debit-routing-profile-config
Mar 26, 2025
Merged

feat(core): add profile level config for debit routing feature#7470
likhinbopanna merged 14 commits intomainfrom
add-debit-routing-profile-config

Conversation

@prasunna09
Copy link
Contributor

@prasunna09 prasunna09 commented Mar 10, 2025 •
edited by bsayak03
Loading

Type of Change

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

Description

Added is_debit_routing_enabled in profile Create req types and update Profile table

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?

  1. Merchant Account - Create

Request cURL :

curl --location 'http://localhost:8080/accounts' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'api-key: test_admin' \
--header 'Cookie: PHPSESSID=0b47db9d7de94c37b6b272087a9f2fa7' \
--data-raw '{
  "merchant_id": "merchant_1742827499",
  "locker_id": "m0010",
  "merchant_name": "NewAge Retailer",
  "merchant_details": {
    "primary_contact_person": "John Test",
    "primary_email": "JohnTest@test.com",
    "primary_phone": "sunt laborum",
    "secondary_contact_person": "John Test2",
    "secondary_email": "JohnTest2@test.com",
    "secondary_phone": "cillum do dolor id",
    "website": "https://www.example.com",
    "about_business": "Online Retail with a wide selection of organic products for North America",
    "address": {
      "line1": "1467",
      "line2": "Harrison Street",
      "line3": "Harrison Street",
      "city": "San Fransico",
      "state": "California",
      "zip": "94122",
    
      "first_name":"john",
      "last_name":"Doe"
    }
  },
  "return_url": "https://google.com/success",
  "webhook_details": {
    "webhook_version": "1.0.1",
    "webhook_username": "ekart_retail",
    "webhook_password": "password_ekart@123",
    "webhook_url":"https://webhook.site",
    "payment_created_enabled": true,
    "payment_succeeded_enabled": true,
    "payment_failed_enabled": true
  },
  "sub_merchants_enabled": false,
  "parent_merchant_id":"merchant_123",
  "metadata": {
    "city": "NY",
    "unit": "245"
  },
  "primary_business_details": [
    {
      "country": "US",
      "business": "default"
    }
  ]
}'

Response :

{
    "merchant_id": "merchant_1742827344",
    "merchant_name": "NewAge Retailer",
    "return_url": "https://google.com/success",
    "enable_payment_response_hash": true,
    "payment_response_hash_key": "qvfVV7WEJ3WKGtFFBZ8JC2OnAUMCm0hU5mdgwHf7COAOQgjB8C4VnIhcOY3WuzI7",
    "redirect_to_merchant_with_http_post": false,
    "merchant_details": {
        "primary_contact_person": "John Test",
        "primary_phone": "sunt laborum",
        "primary_email": "JohnTest@test.com",
        "secondary_contact_person": "John Test2",
        "secondary_phone": "cillum do dolor id",
        "secondary_email": "JohnTest2@test.com",
        "website": "https://www.example.com",
        "about_business": "Online Retail with a wide selection of organic products for North America",
        "address": {
            "city": "San Fransico",
            "country": null,
            "line1": "1467",
            "line2": "Harrison Street",
            "line3": "Harrison Street",
            "zip": "94122",
            "state": "California",
            "first_name": "john",
            "last_name": "Doe"
        }
    },
    "webhook_details": {
        "webhook_version": "1.0.1",
        "webhook_username": "ekart_retail",
        "webhook_password": "password_ekart@123",
        "webhook_url": "https://webhook.site",
        "payment_created_enabled": true,
        "payment_succeeded_enabled": true,
        "payment_failed_enabled": true
    },
    "payout_routing_algorithm": null,
    "sub_merchants_enabled": false,
    "parent_merchant_id": null,
    "publishable_key": "pk_dev_fc0b78b1951b4c0aba40c00e17958e97",
    "metadata": {
        "city": "NY",
        "unit": "245",
        "compatible_connector": null
    },
    "locker_id": "m0010",
    "primary_business_details": [
        {
            "country": "US",
            "business": "default"
        }
    ],
    "frm_routing_algorithm": null,
    "organization_id": "org_TvuYRQgMu3e9Zlf9GD04",
    "is_recon_enabled": false,
    "default_profile": "pro_DaZ3vsoT8HQVXt1ZQYNI",
    "recon_status": "not_requested",
    "pm_collect_link_config": null,
    "product_type": "orchestration"
}
  1. Business Profile Retrieve

Request cURL :

curl --location 'http://localhost:8080/account/merchant_1742878207/business_profile/pro_7QLj5zlucM8yV5zHBl3s' \
--header 'api-key: test_admin' \
--header 'Cookie: PHPSESSID=0b47db9d7de94c37b6b272087a9f2fa7'

Response:

{
    "merchant_id": "merchant_1742878207",
    "profile_id": "pro_7QLj5zlucM8yV5zHBl3s",
    "profile_name": "US_default",
    "return_url": "https://google.com/success",
    "enable_payment_response_hash": true,
    "payment_response_hash_key": "ESrOI4G8uSF15Sr1nzuFqHirYaihkQwlKFUT7nSDiIWOO7PSvcf36g6xIXSZHsjb",
    "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": "https://webhook.site",
        "payment_created_enabled": true,
        "payment_succeeded_enabled": true,
        "payment_failed_enabled": true
    },
    "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
}
  1. Business Profile Update

Request cURL :

curl --location 'http://localhost:8080/account/merchant_1742827344/business_profile/pro_DaZ3vsoT8HQVXt1ZQYNI' \
--header 'Content-Type: application/json' \
--header 'api-key: test_admin' \
--header 'Cookie: PHPSESSID=0b47db9d7de94c37b6b272087a9f2fa7' \
--data-raw '{
    "profile_name": "Update",
    "return_url": "https://google.com/success",
    "enable_payment_response_hash": true,
    "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": "https://webhook.site",
        "payment_created_enabled": true,
        "payment_succeeded_enabled": true,
        "payment_failed_enabled": true
    },
    "metadata": 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,
    "collect_shipping_details_from_wallet_connector": false,
    "collect_billing_details_from_wallet_connector": false,
    "is_connector_agnostic_mit_enabled": false,
    "payout_link_config": null,
    "outgoing_webhook_custom_http_headers": null,
    "is_debit_routing_enabled": true,
    "merchant_business_country": "US"
}'

Response :

{
    "merchant_id": "merchant_1742827344",
    "profile_id": "pro_DaZ3vsoT8HQVXt1ZQYNI",
    "profile_name": "Update",
    "return_url": "https://google.com/success",
    "enable_payment_response_hash": true,
    "payment_response_hash_key": "qvfVV7WEJ3WKGtFFBZ8JC2OnAUMCm0hU5mdgwHf7COAOQgjB8C4VnIhcOY3WuzI7",
    "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": "https://webhook.site",
        "payment_created_enabled": true,
        "payment_succeeded_enabled": true,
        "payment_failed_enabled": true
    },
    "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": true,
    "merchant_business_country": "US"
}
  1. Making a DB query and reconfirming
Screenshot 2025-03-26 at 6 09 29 PM

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

@prasunna09 prasunna09 added A-core Area: Core flows S-waiting-on-review Status: This PR has been implemented and needs to be reviewed labels Mar 10, 2025
@prasunna09 prasunna09 self-assigned this Mar 10, 2025
@prasunna09 prasunna09 requested review from a team as code owners March 10, 2025 11:47
@semanticdiff-com
Copy link

semanticdiff-com bot commented Mar 10, 2025 •
edited
Loading

Review changes with  SemanticDiff

Changed Files
File Status
  crates/diesel_models/src/business_profile.rs  23% smaller
  crates/router/src/core/admin.rs  20% 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/diesel_models/src/schema.rs  0% smaller
  crates/diesel_models/src/schema_v2.rs  0% smaller
  crates/hyperswitch_domain_models/src/business_profile.rs  0% smaller
  crates/router/src/types/api/admin.rs  0% smaller
  migrations/2025-03-10-103959_add_is_debit_routing_enabled_to_profile/down.sql Unsupported file format
  migrations/2025-03-10-103959_add_is_debit_routing_enabled_to_profile/up.sql Unsupported file format
  migrations/2025-03-21-134323_add_merchant_business_country_in_business_profile/down.sql Unsupported file format
  migrations/2025-03-21-134323_add_merchant_business_country_in_business_profile/up.sql Unsupported file format

@hyperswitch-bot hyperswitch-bot bot added the M-database-changes Metadata: This PR involves database schema changes label Mar 10, 2025
ShankarSinghC
ShankarSinghC reviewed Mar 12, 2025
View reviewed changes
crates/api_models/src/admin.rs Outdated

/// Indicates if debit routing is enabled or not
#[serde(default)]
pub is_debit_routing_enabled: bool,
Copy link
Contributor

@ShankarSinghC ShankarSinghC Mar 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should not make is as none if merchant has not passed the field, because we won't get to know whether merchant has sent the field or not. Instead we should have this as Optional boolean in api_models and make it as default false in the domain models.

Copy link
Contributor

@bsayak03 bsayak03 Mar 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Resolved

@hyperswitch-bot hyperswitch-bot bot added the M-api-contract-changes Metadata: This PR involves API contract changes label Mar 21, 2025
@bsayak03 bsayak03 force-pushed the add-debit-routing-profile-config branch from 7e51546 to b006c99 Compare March 21, 2025 16:23
@hyperswitch-bot hyperswitch-bot bot removed the M-api-contract-changes Metadata: This PR involves API contract changes label Mar 21, 2025
@bsayak03 bsayak03 force-pushed the add-debit-routing-profile-config branch from e0a1137 to 25dc4bc Compare March 21, 2025 18:48
ShankarSinghC
ShankarSinghC reviewed Mar 23, 2025
View reviewed changes
crates/api_models/src/admin.rs Outdated
Copy link
Contributor

@ShankarSinghC ShankarSinghC Mar 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a documentation comment about the field

Copy link
Contributor

@bsayak03 bsayak03 Mar 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Resolved

crates/api_models/src/admin.rs Outdated
Copy link
Contributor

@ShankarSinghC ShankarSinghC Mar 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here

Copy link
Contributor

@bsayak03 bsayak03 Mar 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Resolved

crates/api_models/src/admin.rs Outdated
Copy link
Contributor

@ShankarSinghC ShankarSinghC Mar 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here

Copy link
Contributor

@bsayak03 bsayak03 Mar 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Resolved

crates/api_models/src/admin.rs Outdated
Copy link
Contributor

@ShankarSinghC ShankarSinghC Mar 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here

Copy link
Contributor

@bsayak03 bsayak03 Mar 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Resolved

migrations/2025-03-21-134323_add_merchant_business_country_in_business_profile/up.sql Outdated
Copy link
Contributor

@ShankarSinghC ShankarSinghC Mar 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ALTER TABLE business_profile
ADD COLUMN IF NOT EXISTS merchant_business_country "CountryAlpha2" DEFAULT NULL;

Copy link
Contributor

@bsayak03 bsayak03 Mar 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Resolved

@bsayak03 bsayak03 force-pushed the add-debit-routing-profile-config branch from 25dc4bc to 4418cdb Compare March 23, 2025 10:42
@hyperswitch-bot hyperswitch-bot bot added the M-api-contract-changes Metadata: This PR involves API contract changes label Mar 23, 2025
@bsayak03 bsayak03 self-assigned this Mar 23, 2025
@bsayak03 bsayak03 force-pushed the add-debit-routing-profile-config branch from d749b10 to 9f68b0c Compare March 24, 2025 14:02
@hyperswitch-bot hyperswitch-bot bot removed the M-api-contract-changes Metadata: This PR involves API contract changes label Mar 24, 2025
@hyperswitch-bot hyperswitch-bot bot added the M-api-contract-changes Metadata: This PR involves API contract changes label Mar 24, 2025
@bsayak03 bsayak03 force-pushed the add-debit-routing-profile-config branch 2 times, most recently from eb661be to 5aa3432 Compare March 24, 2025 18:36
@bsayak03 bsayak03 force-pushed the add-debit-routing-profile-config branch from 3e7a657 to e4368b2 Compare March 25, 2025 02:52
ShankarSinghC
ShankarSinghC reviewed Mar 25, 2025
View reviewed changes
crates/diesel_models/src/business_profile.rs
Comment on lines -444 to -450
pub routing_algorithm_id: Option<common_utils::id_type::RoutingId>,
pub order_fulfillment_time: Option<i64>,
pub order_fulfillment_time_origin: Option<common_enums::OrderFulfillmentTimeOrigin>,
pub frm_routing_algorithm_id: Option<String>,
pub payout_routing_algorithm_id: Option<common_utils::id_type::RoutingId>,
pub default_fallback_routing: Option<pii::SecretSerdeValue>,
pub should_collect_cvv_during_payment: Option<bool>,
Copy link
Contributor

@ShankarSinghC ShankarSinghC Mar 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this moved ?

Copy link
Contributor

@bsayak03 bsayak03 Mar 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to make the ordering in sync with the one in schema & diesel models

crates/diesel_models/src/business_profile.rs
Comment on lines -393 to -400
pub routing_algorithm_id: Option<common_utils::id_type::RoutingId>,
pub order_fulfillment_time: Option<i64>,
pub order_fulfillment_time_origin: Option<common_enums::OrderFulfillmentTimeOrigin>,
pub frm_routing_algorithm_id: Option<String>,
pub payout_routing_algorithm_id: Option<common_utils::id_type::RoutingId>,
pub default_fallback_routing: Option<pii::SecretSerdeValue>,
pub should_collect_cvv_during_payment: bool,
pub id: common_utils::id_type::ProfileId,
Copy link
Contributor

@ShankarSinghC ShankarSinghC Mar 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here

Copy link
Contributor

@bsayak03 bsayak03 Mar 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to make the ordering in sync with the one in schema & diesel models

@likhinbopanna likhinbopanna added this pull request to the merge queue Mar 26, 2025
Merged via the queue into main with commit 8e85465 Mar 26, 2025
28 of 32 checks passed
@likhinbopanna likhinbopanna deleted the add-debit-routing-profile-config branch March 26, 2025 14:19
GauravRawat369 pushed a commit that referenced this pull request Mar 27, 2025
@prasunna09 @hyperswitch-bot
@bsayak03 @GauravRawat369
feat(core): add profile level config for debit routing feature (#7470)
d2d68bd 
Co-authored-by: hyperswitch-bot[bot] <148525504+hyperswitch-bot[bot]@users.noreply.github.com>
Co-authored-by: Sayak Bhattacharya <sayak.b@Sayak-Bhattacharya-G092THXJ34.local>
Co-authored-by: Sayak Bhattacharya <sayakofficial21@gmail.com>
pixincreate added a commit that referenced this pull request Mar 27, 2025
@pixincreate
Merge branch 'main' of github.com:juspay/hyperswitch into ci/pm_activ…
f50ffab 
…e-status-check

* 'main' of github.com:juspay/hyperswitch:
  build(docker): specify user for runner stage (#7641)
  chore(version): 2025.03.27.0
  fix(connector): [Nexixpay] update status mapping nexixpay (#7612)
  refactor(connector): [TrustPay] Fix status and wasm changes  (#7649)
  fix(connector): [redsys] psync transaction type mapping (#7628)
  feat(themes): Add email configuration support for themes (#7580)
  feat(core): add profile level config for debit routing feature (#7470)
  fix(connector): [CYBERSOURCE]  change ucaf_collection_indicator for mastercard payments via netcetera (#7623)
  fix(connector): fix required fields for mandates supported connectors (#6930)
  chore(cypress): bump cypress to `v14.2.0` (#7640)
  feat(connector): [BRAINTREE] Pass connector request reference id (#7609)
  fix(connector): [GlobalPay] Address `5xx` when cancelling a paypal transaction (#7605)
  feat(dashboard_metadata): Add `ReconStatus` in `dashboard_metadata` (#7595)
  fix(connectors): [Adyen] remove redundant enums  (#7601)
  feat: add routing support for v2 sdk session flow (#6763)
@hyperswitch-bot hyperswitch-bot bot removed the S-waiting-on-review Status: This PR has been implemented and needs to be reviewed label Mar 30, 2025
This was referenced May 21, 2025
Closed
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sai-harsha-vardhan sai-harsha-vardhan sai-harsha-vardhan approved these changes

@ShankarSinghC ShankarSinghC ShankarSinghC approved these changes

@bsayak03 bsayak03 bsayak03 approved these changes

Assignees

@prasunna09 prasunna09

@bsayak03 bsayak03

Labels

A-core Area: Core flows M-api-contract-changes Metadata: This PR involves API contract changes M-database-changes Metadata: This PR involves database schema changes

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@prasunna09 @sai-harsha-vardhan @ShankarSinghC @bsayak03 @likhinbopanna