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

[srujanchikke]

Type of Change

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

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": "[email protected]"
    },
    "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": "[email protected]"
    },
    "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]

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]

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

[srujanchikke]

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

[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]

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]

Suggested change

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