Skip to content

feat(core): Add Merchant Tax ID in Merchant Profile #8992

Merged
likhinbopanna merged 3 commits intomainfrom
add_merchant-tax_id
Sep 1, 2025
Merged

feat(core): Add Merchant Tax ID in Merchant Profile #8992
likhinbopanna merged 3 commits intomainfrom
add_merchant-tax_id

Conversation

@awasthi21
Copy link
Contributor

@awasthi21 awasthi21 commented Aug 19, 2025 •
edited
Loading

Type of Change

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

Description

Changes Made

Merchant Tax ID in L2/L3 Data

  • Added merchant_tax_registration_id field to merchant details in merchant profile
  • Added merchant_tax_registration_id field to L2/L3 data structure.
  • Integrated tax ID as card_acceptor_tax_id in Vantiv's DetailTax structure.

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?

MCA without merchant_tax_registration_id

<!--
Did you write an integration/unit/API test to verify the code changes?
Or did you test this change manually (provide relevant screenshots)?
-->
curl --location 'http://localhost:8080/accounts' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'api-key: test_admin' \
--data-raw '{
  "merchant_id": "merchant_1756720797",
  "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": "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",
      "country": "US"
    }
  },
  "return_url": "https://google.com/success",
  "webhook_details": {
    "webhook_version": "1.0.1",
    "webhook_username": "ekart_retail",
    "webhook_password": "password_ekart@123",
    "payment_created_enabled": true,
    "payment_succeeded_enabled": true,
    "payment_failed_enabled": true
  },
  "sub_merchants_enabled": false,
  "metadata": {
    "city": "NY",
    "unit": "245"
  },
  "primary_business_details": [
    {
      "country": "US",
      "business": "default"
    }
  ]
}'

Response

{
    "merchant_id": "merchant_1756720785",
    "merchant_name": "NewAge Retailer",
    "return_url": "https://google.com/success",
    "enable_payment_response_hash": true,
    "payment_response_hash_key": "h9YV1MQpUvv7aYbXIaDDyat4kxEYq5QTPeau4ZXG9qR2JNNTuVbU8bxBq1zD8vN2",
    "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": "www.example.com",
        "about_business": "Online Retail with a wide selection of organic products for North America",
        "address": {
            "city": "San Fransico",
            "country": "US",
            "line1": "1467",
            "line2": "Harrison Street",
            "line3": "Harrison Street",
            "zip": "94122",
            "state": "California",
            "first_name": null,
            "last_name": null,
            "origin_zip": null
        },
        "merchant_tax_registration_id": null
    },
    "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
    },
    "payout_routing_algorithm": null,
    "sub_merchants_enabled": false,
    "parent_merchant_id": null,
    "publishable_key": "pk_dev_a111e19dec254888bc57a36be5addbd8",
    "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_9B6C3zBlLMDGMVceWKpK",
    "is_recon_enabled": false,
    "default_profile": "pro_qUFX9ttJj0DYJc7ukaiI",
    "recon_status": "not_requested",
    "pm_collect_link_config": null,
    "product_type": "orchestration",
    "merchant_account_type": "standard"
}

Merchant Account Create

curl --location 'http://localhost:8080/accounts' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'api-key: test_admin' \
--data-raw '{
  "merchant_id": "merchant_1756221630",
  "locker_id": "m0010",
  "merchant_name": "NewAge Retailer",
  "merchant_details": {
    "primary_contact_person": "John Test",
    "primary_email": "JohnTest@test.com",
    "primary_phone": "sunt laborum",
    "merchant_tax_registration_id":"3243242",
    "secondary_contact_person": "John Test2",
    "secondary_email": "JohnTest2@test.com",
    "secondary_phone": "cillum do dolor id",
    "website": "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",
      "country": "US"
    }
  },
  "return_url": "https://google.com/success",
  "webhook_details": {
    "webhook_version": "1.0.1",
    "webhook_username": "ekart_retail",
    "webhook_password": "password_ekart@123",
    "payment_created_enabled": true,
    "payment_succeeded_enabled": true,
    "payment_failed_enabled": true
  },
  "sub_merchants_enabled": false,
  "metadata": {
    "city": "NY",
    "unit": "245"
  },
  "primary_business_details": [
    {
      "country": "US",
      "business": "default"
    }
  ]
}'

Response

{
    "merchant_id": "merchant_1756196112",
    "merchant_name": "NewAge Retailer",
    "return_url": "https://google.com/success",
    "enable_payment_response_hash": true,
    "payment_response_hash_key": "emximn2G1kgk04HFlgrwCXqRa5qXr9RcztLPiFrbkS92zbuKNGp0W7olSpRotKdr",
    "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": "www.example.com",
        "about_business": "Online Retail with a wide selection of organic products for North America",
        "address": {
            "city": "San Fransico",
            "country": "US",
            "line1": "1467",
            "line2": "Harrison Street",
            "line3": "Harrison Street",
            "zip": "94122",
            "state": "California",
            "first_name": null,
            "last_name": null,
            "origin_zip": null
        },
        "merchant_tax_registration_id": "3243242"
    },
    "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
    },
    "payout_routing_algorithm": null,
    "sub_merchants_enabled": false,
    "parent_merchant_id": null,
    "publishable_key": "",
    "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_67oU0sqPVcn2MapB4diR",
    "is_recon_enabled": false,
    "default_profile": "pro_QCai34tt21MrTW7wq67o",
    "recon_status": "not_requested",
    "pm_collect_link_config": null,
    "product_type": "orchestration",
    "merchant_account_type": "standard"
}

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

@awasthi21 awasthi21 requested review from a team as code owners August 19, 2025 10:06
@semanticdiff-com
Copy link

semanticdiff-com bot commented Aug 19, 2025 •
edited
Loading

Review changes with  SemanticDiff

Changed Files
File Status
  crates/hyperswitch_connectors/src/connectors/worldpayvantiv/transformers.rs  4% smaller
  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/hyperswitch_domain_models/src/merchant_account.rs  0% smaller
  crates/hyperswitch_domain_models/src/router_data.rs  0% smaller
  crates/router/src/core/payments/transformers.rs  0% smaller

@awasthi21 awasthi21 changed the title feat/gpay-encryptedFlow feat(core): Add Merchant Tax ID in Business Profile Aug 19, 2025
@hyperswitch-bot hyperswitch-bot bot added the M-api-contract-changes Metadata: This PR involves API contract changes label Aug 19, 2025
@awasthi21 awasthi21 force-pushed the add_merchant-tax_id branch from 39c561b to 7680f62 Compare August 25, 2025 18:26
@awasthi21 awasthi21 requested a review from a team as a code owner August 25, 2025 18:26
@awasthi21 awasthi21 self-assigned this Aug 25, 2025
Sakilmostak
Sakilmostak previously approved these changes Aug 26, 2025
View reviewed changes
@awasthi21 awasthi21 changed the title feat(core): Add Merchant Tax ID in Business Profile feat(core): Add Merchant Tax ID in Merchant Profile Aug 26, 2025
@awasthi21 awasthi21 changed the title feat(core): Add Merchant Tax ID in Merchant Profile feat(core): Add Merchant Tax ID in Merchant Profile . Add Validations in Vativ Feilds Aug 26, 2025
@awasthi21 awasthi21 dismissed stale reviews from Sakilmostak and deepanshu-iiitu via af64622 August 26, 2025 12:25
@awasthi21 awasthi21 force-pushed the add_merchant-tax_id branch 4 times, most recently from 9c92afc to 7616cc9 Compare August 26, 2025 15:06
@awasthi21 awasthi21 changed the title feat(core): Add Merchant Tax ID in Merchant Profile . Add Validations in Vativ Feilds feat(core): Add Merchant Tax ID in Merchant Profile . Add Validations in Vativ Fields Aug 26, 2025
@awasthi21 awasthi21 changed the title feat(core): Add Merchant Tax ID in Merchant Profile . Add Validations in Vativ Fields feat(core): Add Merchant Tax ID in Merchant Profile . Add Validations in Vantiv Fields Aug 26, 2025
@awasthi21 awasthi21 force-pushed the add_merchant-tax_id branch from 15fefc7 to 85789ad Compare August 26, 2025 15:37
@awasthi21 awasthi21 changed the title feat(core): Add Merchant Tax ID in Merchant Profile . Add Validations in Vantiv Fields feat(core): Add Merchant Tax ID in Merchant Profile Aug 29, 2025
@awasthi21 awasthi21 force-pushed the add_merchant-tax_id branch from eb744db to 1ec4fee Compare August 29, 2025 06:56
@likhinbopanna likhinbopanna added this pull request to the merge queue Sep 1, 2025
@likhinbopanna likhinbopanna removed this pull request from the merge queue due to a manual request Sep 1, 2025
@likhinbopanna likhinbopanna added this pull request to the merge queue Sep 1, 2025
Merged via the queue into main with commit ff14b7c Sep 1, 2025
25 of 29 checks passed
@likhinbopanna likhinbopanna deleted the add_merchant-tax_id branch September 1, 2025 11:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jarnura jarnura jarnura approved these changes

@deepanshu-iiitu deepanshu-iiitu deepanshu-iiitu approved these changes

@Sakilmostak Sakilmostak Awaiting requested review from Sakilmostak

@sai-harsha-vardhan sai-harsha-vardhan Awaiting requested review from sai-harsha-vardhan

Assignees

@awasthi21 awasthi21

Labels

M-api-contract-changes Metadata: This PR involves API contract changes

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@awasthi21 @jarnura @deepanshu-iiitu @Sakilmostak @likhinbopanna