feat(v2): Added Ephemeral auth for v2 #6813

Sarthak1799 · 2024-12-11T18:52:11Z

Type of Change

Description

This PR contains -

Ephemeral auth support for v2 (including resource type product identifier)
Minor Fixes for Payment methods v2 CRUD APIs

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 Payment Method Intent

curl --location --request POST 'http://localhost:8080/v2/payment-methods/create-intent' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'X-Profile-Id: pro_DMmRBLpkNczeVDPd2EKd' \
--header 'api-key: dev_HVwdf7yWqJ9GGfw1CLDbAgjOFYHrPXoisK8pJcVPfdbc73238GROVpDhN3M9cPe2' \
--data-raw '{
  "customer_id": "cus_0193ab7e6cc074939f389817610cd5b1"
}'

Response

{
    "merchant_id": "cloth_seller_pcGA5SfzTmVUTBKvh2T3",
    "customer_id": "cus_0193ab7e6cc074939f389817610cd5b1",
    "payment_method_id": "12345_pm_0193b69ba645716086c0fe21c462cf2d",
    "payment_method_type": null,
    "payment_method_subtype": null,
    "recurring_enabled": false,
    "created": "2024-12-11T16:44:34.261Z",
    "last_used_at": "2024-12-11T16:44:34.261Z",
    "ephemeral_key": "epk_0c6ebab77f51446ab30467640a6f8f02",
    "payment_method_data": null
}

Use Ephemeral key to confirm intent

curl --location --request POST 'http://localhost:8080/v2/payment-methods/12345_pm_0193b69ba645716086c0fe21c462cf2d/confirm-intent' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'X-Profile-Id: pro_DMmRBLpkNczeVDPd2EKd' \
--header 'X-Resource-Type: payment_method' \
--header 'api-key: epk_0c6ebab77f51446ab30467640a6f8f02' \
--data-raw '{
    "payment_method_type": "card",
    "payment_method_subtype": "credit",
    "payment_method_data": {
        "card": {
            "card_number": "4242424242424242",
            "card_exp_month": "12",
            "card_exp_year": "2025",
            "card_holder_name": "joseph Doe"
        }
    },
    "customer_id": "cus_0193ab7e6cc074939f389817610cd5b1"
}'

Response -

{
    "merchant_id": "cloth_seller_pcGA5SfzTmVUTBKvh2T3",
    "customer_id": "cus_0193ab7e6cc074939f389817610cd5b1",
    "payment_method_id": "12345_pm_0193b69ba645716086c0fe21c462cf2d",
    "payment_method_type": "card",
    "payment_method_subtype": "credit",
    "recurring_enabled": false,
    "created": "2024-12-11T16:44:34.261Z",
    "last_used_at": "2024-12-11T16:44:34.261Z",
    "ephemeral_key": null,
    "payment_method_data": {
        "card": {
            "issuer_country": null,
            "last4_digits": "4242",
            "expiry_month": "12",
            "expiry_year": "2025",
            "card_holder_name": "joseph Doe",
            "card_fingerprint": null,
            "nick_name": null,
            "card_network": null,
            "card_isin": null,
            "card_issuer": null,
            "card_type": null,
            "saved_to_locker": true
        }
    }
}

Retrieve a PM -

curl --location --request GET 'http://localhost:8080/v2/payment-methods/12345_pm_0193b69ba645716086c0fe21c462cf2d' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'X-Profile-Id: pro_DMmRBLpkNczeVDPd2EKd' \
--header 'X-Resource-Type: payment_method' \
--header 'api-key: epk_2ce0fd3229b64493bf7e39840837e267'

Response -

{
    "merchant_id": "cloth_seller_pcGA5SfzTmVUTBKvh2T3",
    "customer_id": "cus_0193ab7e6cc074939f389817610cd5b1",
    "payment_method_id": "12345_pm_0193b69ba645716086c0fe21c462cf2d",
    "payment_method_type": "card",
    "payment_method_subtype": "credit",
    "recurring_enabled": false,
    "created": "2024-12-11T16:44:34.261Z",
    "last_used_at": "2024-12-11T16:44:34.261Z",
    "ephemeral_key": null,
    "payment_method_data": {
        "card": {
            "issuer_country": null,
            "last4_digits": "4242",
            "expiry_month": "12",
            "expiry_year": "2025",
            "card_holder_name": "joseph",
            "card_fingerprint": null,
            "nick_name": "some_name11",
            "card_network": null,
            "card_isin": null,
            "card_issuer": null,
            "card_type": null,
            "saved_to_locker": true
        }
    }
}

Update a PM -

curl --location --request PATCH 'http://localhost:8080/v2/payment-methods/12345_pm_0193b69ba645716086c0fe21c462cf2d/update-saved-payment-method' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'X-Profile-Id: pro_DMmRBLpkNczeVDPd2EKd' \
--header 'X-Resource-Type: payment_method' \
--header 'api-key: epk_0c6ebab77f51446ab30467640a6f8f02' \
--data-raw '{
    "payment_method_data": {
        "card": {
            "card_holder_name": "joseph",
            "nick_name": "some_name11"
        }
    }
}'

Response -

{
    "merchant_id": "cloth_seller_pcGA5SfzTmVUTBKvh2T3",
    "customer_id": "cus_0193ab7e6cc074939f389817610cd5b1",
    "payment_method_id": "12345_pm_0193b69ba645716086c0fe21c462cf2d",
    "payment_method_type": "card",
    "payment_method_subtype": "credit",
    "recurring_enabled": false,
    "created": "2024-12-11T16:44:34.261Z",
    "last_used_at": "2024-12-11T16:44:34.261Z",
    "ephemeral_key": null,
    "payment_method_data": {
        "card": {
            "issuer_country": null,
            "last4_digits": "4242",
            "expiry_month": "12",
            "expiry_year": "2025",
            "card_holder_name": "joseph",
            "card_fingerprint": null,
            "nick_name": "some_name11",
            "card_network": null,
            "card_isin": null,
            "card_issuer": null,
            "card_type": null,
            "saved_to_locker": true
        }
    }
}

Delete a PM -

curl --location --request DELETE 'http://localhost:8080/v2/payment-methods/12345_pm_0193b69ba645716086c0fe21c462cf2d' \
--header 'Accept: application/json' \
--header 'X-Profile-Id: pro_DMmRBLpkNczeVDPd2EKd' \
--header 'X-Resource-Type: payment_method' \
--header 'api-key: epk_0c6ebab77f51446ab30467640a6f8f02'

Response -

{
    "payment_method_id": "12345_pm_0193b69ba645716086c0fe21c462cf2d"
}

Standalone Ephemeral key create -

curl --location --request POST 'http://localhost:8080/v2/ephemeral-keys' \
--header 'Content-Type: application/json' \
--header 'X-Profile-Id: pro_DMmRBLpkNczeVDPd2EKd' \
--header 'X-Resource-Type: payment_method' \
--header 'api-key: dev_HVwdf7yWqJ9GGfw1CLDbAgjOFYHrPXoisK8pJcVPfdbc73238GROVpDhN3M9cPe2' \
--data-raw '{
    "merchant_reference_id": "cus_0193ab7e6cc074939f389817610cd5b1"
}'

Response -

{
    "id": "eki_AJe5hpQZrLEdNgdkbcUF",
    "merchant_id": "cloth_seller_pcGA5SfzTmVUTBKvh2T3",
    "customer_id": "cus_0193ab7e6cc074939f389817610cd5b1",
    "resource_type": "payment_method",
    "created_at": 1733936777,
    "expires": 1733940377,
    "secret": "epk_2ce0fd3229b64493bf7e39840837e267"
}

Can use the ephemeral key obtained here to hit the above APIs

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-11T18:52:14Z

Review changes with

Changed Files

File	Status
crates/hyperswitch_domain_models/src/payments.rs	64% smaller
crates/router/src/core/payment_methods.rs	51% smaller
crates/router/src/routes/app.rs	48% smaller
crates/router/src/core/payment_methods/vault.rs	41% smaller
crates/router/src/lib.rs	36% smaller
crates/router/src/routes/payment_methods.rs	20% smaller
crates/router/src/routes/ephemeral_key.rs	5% smaller
crates/router/src/core/payments/helpers.rs	3% smaller
crates/api_models/src/events/customer.rs	1% smaller
api-reference-v2/openapi_spec.json	0% smaller
crates/api_models/src/payment_methods.rs	0% smaller
crates/diesel_models/src/ephemeral_key.rs	0% smaller
crates/diesel_models/src/payment_method.rs	0% smaller
crates/router/src/consts.rs	0% smaller
crates/router/src/core/payment_methods/transformers.rs	0% smaller
crates/router/src/db/ephemeral_key.rs	0% smaller
crates/router/src/services/authentication.rs	0% smaller
crates/router/src/types/payment_methods.rs	0% smaller
crates/router/src/types/storage/ephemeral_key.rs	0% smaller

crates/router/src/core/payments/helpers.rs

jarnura · 2024-12-12T07:07:08Z

crates/router/src/routes/payment_methods.rs

@@ -251,6 +261,11 @@ pub async fn payment_method_delete_api(
    })
    .into_inner();

+    let auth = match auth::is_ephemeral_auth(req.headers()) {


This is api-key based auth and not ephemeral_auth

Should our SDK not handle the delete API? Will the SDK not support delete API or will there be a callback to merchant for this?

jarnura · 2024-12-12T07:10:56Z

crates/router/src/routes/payment_methods.rs

@@ -224,6 +229,11 @@ pub async fn payment_method_retrieve_api(
    })
    .into_inner();

+    let auth = match auth::is_ephemeral_auth(req.headers()) {


What is reason to make retrieve as ephemeral_auth?

Remove ephemeral_auth, this should be only api-key based auth.

Sarthak1799 added 2 commits December 11, 2024 18:19

feat(v2): Add ephemeral auth for v2

77b6c06

refactor: Refactored pm v2 code

4927db3

Sarthak1799 self-assigned this Dec 11, 2024

Sarthak1799 requested review from a team as code owners December 11, 2024 18:52

hyperswitch-bot bot added 2 commits December 11, 2024 18:52

chore: run formatter

8078355

docs(openapi): re-generate OpenAPI specification

7d0a4db

hyperswitch-bot bot added the M-api-contract-changes Metadata: This PR involves API contract changes label Dec 11, 2024

fix: Fixed error responses and eph endpoint

423c713

Sarthak1799 linked an issue Dec 11, 2024 that may be closed by this pull request

[FEATURE] Ephemeral Auth for v2 #6814

Open

2 tasks

fix: Added checks on pm retrieve

241921c

jarnura requested changes Dec 12, 2024

View reviewed changes

Sarthak1799 added 2 commits December 12, 2024 14:51

fix: Fixed errors

f8d6dd9

chore: Resolved comments

b0e1365

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(v2): Added Ephemeral auth for v2 #6813

feat(v2): Added Ephemeral auth for v2 #6813

Sarthak1799 commented Dec 11, 2024 •

edited

Loading

semanticdiff-com bot commented Dec 11, 2024 •

edited

Loading

jarnura Dec 12, 2024

Sarthak1799 Dec 12, 2024

jarnura Dec 12, 2024

feat(v2): Added Ephemeral auth for v2 #6813

Are you sure you want to change the base?

feat(v2): Added Ephemeral auth for v2 #6813

Conversation

Sarthak1799 commented Dec 11, 2024 • edited Loading

Type of Change

Description

Additional Changes

Motivation and Context

How did you test it?

Checklist

semanticdiff-com bot commented Dec 11, 2024 • edited Loading

jarnura Dec 12, 2024

Choose a reason for hiding this comment

Sarthak1799 Dec 12, 2024

Choose a reason for hiding this comment

jarnura Dec 12, 2024

Choose a reason for hiding this comment

Sarthak1799 commented Dec 11, 2024 •

edited

Loading

semanticdiff-com bot commented Dec 11, 2024 •

edited

Loading