feat(router): add /retrieve api for relay by ShankarSinghC · Pull Request #6918 · juspay/hyperswitch

ShankarSinghC · 2024-12-23T09:40:12Z

Type of Change

Description

/relay is a api that will be used to just forward the request sent by merchant without performing any application logic on it. This is particular to support the refunds for the payments that was directly performed with the connector (example stripe) with out hyperswitch involved during the payment flow.

This PR introduces changes to add a retrieve API for relay refunds.

The retrieve API will:

Return the relay status from our database when a retrieve call is made.
If force_sync = true is passed and the relay status is not in a terminal state in our system, the API will call the connector to fetch the latest status.

Flow

Merchant performs payment directly with processor and stores the payment reference id associated with it.
Merchant tiggers the refund through hyperswitch using the processor reference id for the payment.
Merchant makes retrieve call for the relay status

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?

-> Create a merchant connector account
-> Make a refund request with invalid connector_resource_id

curl --location 'http://localhost:8080/relay' \
--header 'Content-Type: application/json' \
--header 'X-Profile-Id: pro_rIikb0gPrzd0vEY8hIiP' \
--header 'api-key: dev_qqMQAuMWCclJSk4uMBeNNSpqAPlsKlBA3blQOwOoq5ogTSFVON3taShABqtqYNA4' \
--data '{
  "connector_id": "mca_8W0CQfwE89J1BJBbpcnt",
  "connector_resource_id": "7349526182906968904951",
  "data": {
      "refund": {
    "amount": 50,
    "currency": "USD"
  }},
  "type": "refund"
}'

{
    "id": "relay_4lgXCQW0EnqKddZ9CC3b",
    "status": "pending",
    "connector_resource_id": "7349526182906968904951",
    "error": null,
    "connector_reference_id": "7349526431306986204951",
    "connector_id": "mca_8W0CQfwE89J1BJBbpcnt",
    "profile_id": "pro_rIikb0gPrzd0vEY8hIiP",
    "type": "refund",
    "data": {
        "refund": {
            "amount": 50,
            "currency": "USD",
            "reason": null
        }
    }
}

-> Relay retrieve

curl --location 'http://localhost:8080/relay/relay_4lgXCQW0EnqKddZ9CC3b' \
--header 'Content-Type: application/json' \
--header 'X-Idempotency-Key: <x-idempotency-key>' \
--header 'X-Profile-Id: pro_rIikb0gPrzd0vEY8hIiP' \
--header 'api-key: dev_qqMQAuMWCclJSk4uMBeNNSpqAPlsKlBA3blQOwOoq5ogTSFVON3taShABqtqYNA4' \
--data ''

{
    "id": "relay_4lgXCQW0EnqKddZ9CC3b",
    "status": "pending",
    "connector_resource_id": "7349526182906968904951",
    "error": null,
    "connector_reference_id": "7349526431306986204951",
    "connector_id": "mca_8W0CQfwE89J1BJBbpcnt",
    "profile_id": "pro_rIikb0gPrzd0vEY8hIiP",
    "type": "refund",
    "data": {
        "refund": {
            "amount": 50,
            "currency": "USD",
            "reason": null
        }
    }
}

-> Relay retrieve force_sync = true

curl --location 'http://localhost:8080/relay/relay_4lgXCQW0EnqKddZ9CC3b?force_sync=true' \
--header 'Content-Type: application/json' \
--header 'X-Idempotency-Key: <x-idempotency-key>' \
--header 'X-Profile-Id: pro_rIikb0gPrzd0vEY8hIiP' \
--header 'api-key: dev_qqMQAuMWCclJSk4uMBeNNSpqAPlsKlBA3blQOwOoq5ogTSFVON3taShABqtqYNA4' \
--data ''

{
    "id": "relay_4lgXCQW0EnqKddZ9CC3b",
    "status": "success",
    "connector_resource_id": "7349526182906968904951",
    "error": null,
    "connector_reference_id": "7349526431306986204951",
    "connector_id": "mca_8W0CQfwE89J1BJBbpcnt",
    "profile_id": "pro_rIikb0gPrzd0vEY8hIiP",
    "type": "refund",
    "data": {
        "refund": {
            "amount": 50,
            "currency": "USD",
            "reason": null
        }
    }
}

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 · 2024-12-23T09:40:15Z

Review changes with

Changed Files

File	Status
crates/api_models/src/relay.rs	10% smaller
crates/router/src/routes/lock_utils.rs	5% smaller
crates/router/src/core/relay.rs	4% smaller
crates/diesel_models/src/query/relay.rs	0% smaller
crates/diesel_models/src/relay.rs	0% smaller
crates/router/src/db/relay.rs	0% smaller
crates/router/src/routes/app.rs	0% smaller
crates/router/src/routes/relay.rs	0% smaller
crates/router_env/src/logger/types.rs	0% smaller

crates/router/src/core/relay.rs

crates/diesel_models/src/query/relay.rs

crates/router/src/core/relay.rs

crates/router/src/routes/relay.rs

crates/router/src/core/relay.rs

…r-verifyurl-in-redirection-handler * 'main' of github.com:juspay/hyperswitch: (444 commits) ci: add tests that make use of locker (juspay#6735) chore(version): 2024.12.26.1 fix(router): populate `profile_id` in for the HeaderAuth of v1 (juspay#6936) docs(openapi): update /relay request example (juspay#6942) chore(version): 2024.12.26.0 fix(payments_list): handle same payment/attempt ids for different merchants (juspay#6917) refactor(core): remove merchant return url from `router_data` (juspay#6895) feat(router): add endpoint for listing connector features (juspay#6612) fix(wasm): remove chasenet from jpmorgan wasm as ChaseNet doesn’t exist in PMT (juspay#6927) fix(cors): expose all headers set by application in `access-control-expose-headers` header value (juspay#6877) chore(version): 2024.12.24.0 feat(cypress): valdiate `error_code` and `error_message` and make it visible in `reports` (juspay#6913) fix(wasm): remove extra space from wasm for payment_method_type of JPMorgan (juspay#6923) fix(wasm): fix feature dependencies in `connector_configs` crate for WASM builds (juspay#6832) feat(router): add /retrieve api for relay (juspay#6918) feat(core): implemented platform merchant account (juspay#6882) feat(payments_v2): add payment method list endpoint (juspay#6805) fix(connector): [Cybersource] fix the required fields for wallet mandate payments (juspay#6911) chore(version): 2024.12.23.0 feat(connector): [JPMORGAN] add Payment flows for cards (juspay#6668) ...

feat(router): add /retrieve api for relay

84c8ad9

ShankarSinghC self-assigned this Dec 23, 2024

ShankarSinghC requested review from a team as code owners December 23, 2024 09:40

ShankarSinghC added A-core Area: Core flows A-payment-methods Area: Payment Methods labels Dec 23, 2024

address failing checks

f5d9e0f

sai-harsha-vardhan reviewed Dec 23, 2024

View reviewed changes

crates/router/src/core/relay.rs Outdated Show resolved Hide resolved

crates/diesel_models/src/query/relay.rs Outdated Show resolved Hide resolved

crates/router/src/core/relay.rs Outdated Show resolved Hide resolved

crates/router/src/routes/relay.rs Outdated Show resolved Hide resolved

ShankarSinghC linked an issue Dec 23, 2024 that may be closed by this pull request

add retrieve api support for relay #6919

Closed

address pr comments

769271c

ShankarSinghC requested a review from sai-harsha-vardhan December 23, 2024 11:08

sai-harsha-vardhan reviewed Dec 23, 2024

View reviewed changes

crates/router/src/core/relay.rs Outdated Show resolved Hide resolved

jarnura previously approved these changes Dec 23, 2024

View reviewed changes

address pr comments

5d5bc12

ShankarSinghC dismissed jarnura’s stale review via 5d5bc12 December 23, 2024 11:28

ShankarSinghC requested review from jarnura and sai-harsha-vardhan December 23, 2024 11:46

sai-harsha-vardhan approved these changes Dec 23, 2024

View reviewed changes

jarnura approved these changes Dec 23, 2024

View reviewed changes

Gnanasundari24 added this pull request to the merge queue Dec 23, 2024

Merged via the queue into main with commit 0478731 Dec 23, 2024

Gnanasundari24 deleted the relay/add-retrieve-api branch December 23, 2024 13:21

ShankarSinghC added a commit that referenced this pull request Dec 23, 2024

feat(router): add /retrieve api for relay (#6918)

40148f6

ShankarSinghC mentioned this pull request Dec 23, 2024

feat(router): add /retrieve api for relay #6924

Merged

14 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(router): add /retrieve api for relay#6918

feat(router): add /retrieve api for relay#6918
Gnanasundari24 merged 4 commits intomainfrom
relay/add-retrieve-api

ShankarSinghC commented Dec 23, 2024 •

edited

Loading

Uh oh!

semanticdiff-com bot commented Dec 23, 2024 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

ShankarSinghC commented Dec 23, 2024 • 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 Dec 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ShankarSinghC commented Dec 23, 2024 •

edited

Loading

semanticdiff-com bot commented Dec 23, 2024 •

edited

Loading