feat(core): Add support for v2 payments get intent using merchant reference id by srujanchikke · Pull Request #7123 · juspay/hyperswitch

srujanchikke · 2025-01-28T06:04:12Z

Type of Change

Description

This PR adds support for payments get intent in v2 using merchant reference id.

Note : In a distributed setup we will be having many partition, to access data efficiently we need partition_key. For payments partition_key is payment_intent global-id . So to get the partition_key, we need to create a reverse_lookup table which map merchant_reference_id+profile to payment_intent global-id. A constraint based mechanism will be implemented on those tables.

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?

Test case 1:

request :

curl --location 'http://localhost:8080/v2/payments/ref/example' \
--header 'x-profile-id: pro_xVG6fBFDok3HxeI2vklo' \
--header 'api-key: dev_pICbNgHQUSohctLw03CxJUszzttJpYWcuaeqyTS1SjBoaSHulQsdq9y1uqnc1jNq' \
--data ''

response

{
    "id": "12345_pay_0194a76014af73b19c5d487667c0e00e",
    "status": "requires_payment_method",
    "amount_details": {
        "order_amount": 100,
        "currency": "USD",
        "shipping_cost": null,
        "order_tax_amount": null,
        "external_tax_calculation": "skip",
        "surcharge_calculation": "skip",
        "surcharge_amount": null,
        "tax_on_surcharge": null
    },
    "client_secret": "12345_pay_0194a76014af73b19c5d487667c0e00e_secret_0194a76014ba74439ec0fc14e9808ea2",
    "profile_id": "pro_xVG6fBFDok3HxeI2vklo",
    "merchant_reference_id": "example",
    "routing_algorithm_id": null,
    "capture_method": "manual",
    "authentication_type": "no_three_ds",
    "billing": {
        "address": {
            "city": null,
            "country": null,
            "line1": null,
            "line2": null,
            "line3": null,
            "zip": null,
            "state": null,
            "first_name": "John",
            "last_name": "Dough"
        },
        "phone": null,
        "email": "example@example.com"
    },
    "shipping": {
        "address": {
            "city": "Karwar",
            "country": null,
            "line1": null,
            "line2": null,
            "line3": null,
            "zip": "581301",
            "state": "Karnataka",
            "first_name": "John",
            "last_name": "Dough"
        },
        "phone": null,
        "email": "example@example.com"
    },
    "customer_id": null,
    "customer_present": "present",
    "description": null,
    "return_url": null,
    "setup_future_usage": "on_session",
    "apply_mit_exemption": "Skip",
    "statement_descriptor": null,
    "order_details": null,
    "allowed_payment_method_types": null,
    "metadata": null,
    "connector_metadata": null,
    "feature_metadata": {
        "redirect_response": null,
        "search_tags": null,
        "apple_pay_recurring_details": null
    },
    "payment_link_enabled": "Skip",
    "payment_link_config": null,
    "request_incremental_authorization": "default",
    "expires_on": "2025-01-27T11:02:59.418Z",
    "frm_metadata": null,
    "request_external_three_ds_authentication": "Skip"
}

Test case 2 :
Invalid merchant reference id

curl --location 'http://localhost:8080/v2/payments/ref/example1' \
--header 'x-profile-id: pro_xVG6fBFDok3HxeI2vklo' \
--header 'api-key: ••••••' \
--data ''

response

{
    "error": {
        "type": "invalid_request",
        "message": "Payment does not exist in our records",
        "code": "HE_02"
    }
}

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-01-28T06:04:15Z

Review changes with

Changed Files

File	Status
crates/router/src/routes/lock_utils.rs	80% smaller
crates/diesel_models/src/query/payment_intent.rs	0% smaller
crates/hyperswitch_domain_models/src/payments/payment_intent.rs	0% smaller
crates/router/src/core/payments.rs	0% smaller
crates/router/src/db/kafka_store.rs	0% smaller
crates/router/src/routes/app.rs	0% smaller
crates/router/src/routes/payments.rs	0% smaller
crates/router_env/src/logger/types.rs	0% smaller
crates/storage_impl/src/mock_db/payment_intent.rs	0% smaller
crates/storage_impl/src/payments/payment_intent.rs	0% smaller

Narayanbhat166 · 2025-01-28T14:38:52Z

crates/diesel_models/src/query/payment_intent.rs

+        merchant_reference_id: &common_utils::id_type::PaymentReferenceId,
+        profile_id: &common_utils::id_type::ProfileId,
+    ) -> StorageResult<Self> {
+        generics::generic_find_one::<<Self as HasTable>::Table, _, _>(


can you check if we have this unique index or not?

We don't have unique index on merchant_reference_id & profile id in intent table. We can only get unique intent entry by implementing look up table.
cc : @jarnura

In a distributed setup we will be having many partition, to access data efficiently we need partition_key. For payments partition_key is payment_intent global-id. So to get the partition_key, we need to create a reverse_lookup table which map merchant_reference_id+profile to payment_intent global-id. A constraint based mechanism will be implemented on those tables.

jarnura · 2025-01-29T07:10:06Z

crates/diesel_models/src/query/payment_intent.rs

+        merchant_reference_id: &common_utils::id_type::PaymentReferenceId,
+        profile_id: &common_utils::id_type::ProfileId,
+    ) -> StorageResult<Self> {
+        generics::generic_find_one::<<Self as HasTable>::Table, _, _>(


In a distributed setup we will be having many partition, to access data efficiently we need partition_key. For payments partition_key is payment_intent global-id. So to get the partition_key, we need to create a reverse_lookup table which map merchant_reference_id+profile to payment_intent global-id. A constraint based mechanism will be implemented on those tables.

jarnura · 2025-01-29T07:14:44Z

crates/router/src/routes/app.rs

        );

+        route = route.service(
+            web::resource("/merchant-reference-id/{merchant_reference_id}")


Suggested change

web::resource("/merchant-reference-id/{merchant_reference_id}")

web::resource("/ref/{merchant_reference_id}")

…unt-configurable * 'main' of github.com:juspay/hyperswitch: (37 commits) refactor(router): add display_name field to connector feature api (#7121) ci(cypress): Add Tests for Customer Deletion and Psync flows (#7158) feat(connector): [DataTrans] ADD 3DS Flow (#6026) chore(version): 2025.02.07.0 chore(connectors): [fiuu] update pm_filters for apple pay and google pay (#7182) feat(router): add `organization_id` in authentication table and add it in authentication events (#7168) fix(dashboard_metadata): mask `poc_email` and `data_value` for DashboardMetadata (#7130) feat(core): Add support for v2 payments get intent using merchant reference id (#7123) refactor(customer): return redacted customer instead of error (#7122) fix(connector): handle unexpected error response from bluesnap connector (#7120) feat(routing): Contract based routing integration (#6761) refactor(dynamic_fields): dynamic fields for Adyen and Stripe, renaming klarnaCheckout, WASM for KlarnaCheckout (#7015) feat(connector): [COINGATE] Add Template PR (#7052) chore(roles): remove redundant variant from PermissionGroup (#6985) refactor(router): store `network_transaction_id` for `off_session` payments irrespective of the `is_connector_agnostic_mit_enabled` config (#7083) chore(connector): [Fiuu] log keys in the PSync response (#7189) ci(cypress): fix nmi and paypal (#7173) chore(version): 2025.02.06.0 chore(postman): update Postman collection files feat(connector): [Deutschebank] Add Access Token Error struct (#7127) ...

add support for payment intent get using merchant ref

2e20a09

srujanchikke mentioned this pull request Jan 28, 2025

feat(core) : Add support for v2 payments get intent using merchant reference id #7111

Closed

14 tasks

hyperswitch-bot bot and others added 2 commits January 28, 2025 06:04

chore: run formatter

bc87b3a

remove conf changes

35fb3f2

srujanchikke self-assigned this Jan 28, 2025

srujanchikke added A-core Area: Core flows api-v2 labels Jan 28, 2025

refactor

3551695

srujanchikke marked this pull request as ready for review January 28, 2025 07:21

srujanchikke requested review from a team as code owners January 28, 2025 07:21

srujanchikke requested a review from Narayanbhat166 January 28, 2025 07:22

srujanchikke changed the title ~~feat(core) : Add support for v2 payments get intent using merchant reference id~~ feat(core): Add support for v2 payments get intent using merchant reference id Jan 28, 2025

Chikke Srujan added 2 commits January 28, 2025 14:26

change version settings

4deba7d

remove commented code

30a7a4e

srujanchikke requested a review from jarnura January 28, 2025 10:30

Narayanbhat166 reviewed Jan 28, 2025

View reviewed changes

jarnura approved these changes Jan 29, 2025

View reviewed changes

jarnura requested changes Jan 29, 2025

View reviewed changes

Chikke Srujan and others added 2 commits January 29, 2025 12:50

resolve comments

dfd8a03

chore: run formatter

336cc99

Narayanbhat166 previously approved these changes Jan 29, 2025

View reviewed changes

jarnura previously approved these changes Jan 30, 2025

View reviewed changes

Merge branch 'main' into payments_get_intent_using_merchant_ref

c38c16b

Gnanasundari24 added this pull request to the merge queue Feb 5, 2025

github-merge-queue bot removed this pull request from the merge queue due to no response for status checks Feb 5, 2025

likhinbopanna added this pull request to the merge queue Feb 5, 2025

github-merge-queue bot removed this pull request from the merge queue due to a conflict with the base branch Feb 5, 2025

Merge branch 'main' into payments_get_intent_using_merchant_ref

b8ec2c3

Merge branch 'main' into payments_get_intent_using_merchant_ref

d16f521

srujanchikke dismissed stale reviews from jarnura and Narayanbhat166 via d16f521 February 5, 2025 16:14

Narayanbhat166 approved these changes Feb 6, 2025

View reviewed changes

jarnura approved these changes Feb 6, 2025

View reviewed changes

likhinbopanna added this pull request to the merge queue Feb 6, 2025

Merged via the queue into main with commit e17ffd1 Feb 6, 2025
17 of 20 checks passed

likhinbopanna deleted the payments_get_intent_using_merchant_ref branch February 6, 2025 15:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(core): Add support for v2 payments get intent using merchant reference id#7123

feat(core): Add support for v2 payments get intent using merchant reference id#7123
likhinbopanna merged 11 commits intomainfrom
payments_get_intent_using_merchant_ref

srujanchikke commented Jan 28, 2025 •

edited

Loading

Uh oh!

semanticdiff-com bot commented Jan 28, 2025 •

edited

Loading

Uh oh!

Narayanbhat166 Jan 28, 2025

Uh oh!

srujanchikke Jan 28, 2025

Uh oh!

jarnura Jan 29, 2025

Uh oh!

jarnura Jan 29, 2025

Uh oh!

jarnura Jan 29, 2025

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

	web::resource("/merchant-reference-id/{merchant_reference_id}")
	web::resource("/ref/{merchant_reference_id}")

Conversation

srujanchikke commented Jan 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Type of Change

Description

Additional Changes

Motivation and Context

How did you test it?

Checklist

Uh oh!

semanticdiff-com bot commented Jan 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Narayanbhat166 Jan 28, 2025

Choose a reason for hiding this comment

Uh oh!

srujanchikke Jan 28, 2025

Choose a reason for hiding this comment

Uh oh!

jarnura Jan 29, 2025

Choose a reason for hiding this comment

Uh oh!

jarnura Jan 29, 2025

Choose a reason for hiding this comment

Uh oh!

jarnura Jan 29, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

srujanchikke commented Jan 28, 2025 •

edited

Loading

semanticdiff-com bot commented Jan 28, 2025 •

edited

Loading