refactor(payments): fetch payment method information in attempts list api v2 and add custom billing connector template by NISHANTH1221 · Pull Request #8681 · juspay/hyperswitch

NISHANTH1221 · 2025-07-17T14:01:37Z

Type of Change

Description

This pr adds fetches payment method data in payment attempt list v2 api.

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?

Request:

curl --location 'http://localhost:8080/v2/payments/12345_pay_0198179b2de5751292df2b555eaa3cf2/list_attempts' \
--header 'Content-Type: application/json' \
--header 'x-profile-id: pro_2Kk2ddRcJttgm6ONh0zm' \
--header 'api-key: dev_g5HfT4ijuVQs3QLUPf3xAT6M26ebVgHHTivreiSljKPdRvEsqBNSKxHJrhLboLsT' \
--header 'Authorization: api-key=dev_g5HfT4ijuVQs3QLUPf3xAT6M26ebVgHHTivreiSljKPdRvEsqBNSKxHJrhLboLsT'

Response

{
    "payment_attempt_list": [
        {
            "id": "12345_att_0198179b2e167703a070a6ec12d40213",
            "status": "voided",
            "amount": {
                "net_amount": 10000,
                "amount_to_capture": null,
                "surcharge_amount": null,
                "tax_on_surcharge": null,
                "amount_capturable": 0,
                "shipping_cost": null,
                "order_tax_amount": null
            },
            "connector": "stripe",
            "error": {
                "code": "card_declined",
                "message": "Your card was declined.",
                "unified_code": null,
                "unified_message": null,
                "network_advice_code": null,
                "network_decline_code": null,
                "network_error_message": null
            },
            "authentication_type": "no_three_ds",
            "created_at": "2025-07-16T12:18:21.000Z",
            "modified_at": "2025-07-17T08:58:23.034Z",
            "cancellation_reason": null,
            "payment_token": null,
            "connector_metadata": null,
            "payment_experience": null,
            "payment_method_type": "card",
            "connector_reference_id": null,
            "payment_method_subtype": "credit",
            "connector_payment_id": {
                "TxnId": "pi_3RlUHlCZJlEh6syL1TxJJCst"
            },
            "payment_method_id": null,
            "client_source": null,
            "client_version": null,
            "feature_metadata": {
                "revenue_recovery": {
                    "attempt_triggered_by": "external",
                    "charge_id": "ch_3RlUHlCZJlEh6syL1gLXCiDC"
                }
            },
            "payment_method_data": {
                "card": {
                    "last4": "0008",
                    "card_type": null,
                    "card_network": null,
                    "card_issuer": "Chase",
                    "card_issuing_country": null,
                    "card_isin": null,
                    "card_extended_bin": null,
                    "card_exp_month": "06",
                    "card_exp_year": "50",
                    "card_holder_name": null,
                    "payment_checks": null,
                    "authentication_data": null
                },
                "billing": 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 · 2025-07-17T14:01:41Z

Review changes with

Changed Files

File	Status
crates/router/src/connector.rs	100% smaller
crates/hyperswitch_connectors/src/connectors.rs	65% smaller
crates/hyperswitch_connectors/src/default_implementations.rs	11% smaller
crates/hyperswitch_connectors/src/default_implementations_v2.rs	10% smaller
crates/common_enums/src/connector_enums.rs	9% smaller
api-reference/v1/openapi_spec_v1.json	0% smaller
api-reference/v2/openapi_spec_v2.json	0% smaller
config/docker_compose.toml	Unsupported file format
crates/api_models/src/enums.rs	0% smaller
crates/api_models/src/payments.rs	0% smaller
crates/connector_configs/src/connector.rs	0% smaller
crates/hyperswitch_connectors/src/connectors/custombilling.rs	0% smaller
crates/hyperswitch_connectors/src/connectors/custombilling/transformers.rs	0% smaller
crates/hyperswitch_domain_models/src/connector_endpoints.rs	0% smaller
crates/router/src/core/connector_validation.rs	0% smaller
crates/router/src/core/payments/transformers.rs	0% smaller
crates/router/src/types/api/connector_mapping.rs	0% smaller
crates/router/src/types/connector_transformers.rs	0% smaller
crates/router/tests/connectors/custombilling.rs	0% smaller
loadtest/config/development.toml	Unsupported file format
scripts/add_connector.sh	Unsupported file format

Aprabhat19 · 2025-07-17T19:00:01Z

crates/api_models/src/payments.rs

    pub feature_metadata: Option<PaymentAttemptFeatureMetadata>,
+
+    /// payment method data
+    pub payment_method_data: Option<PaymentMethodDataResponseWithBilling>,


Instead of the entire struct can we just populate the additional_payment_method_Data here

This seemed a better choice since it is being used in struct PaymentsResponse v2 too

ShankarSinghC · 2025-07-18T06:42:36Z

crates/api_models/src/payments.rs

    /// Additional data that might be required by hyperswitch, to enable some specific features.
    pub feature_metadata: Option<PaymentAttemptFeatureMetadata>,
+
+    /// payment method data


Add more descriptive comment. You can refer to the other places where PaymentMethodDataResponseWithBilling` is being used.

ShankarSinghC · 2025-07-18T06:50:22Z

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

+        > = attempt
+            .payment_method_data
+            .clone()
+            .and_then(|data| serde_json::from_value(data.expose().clone()).ok());


Do we want to log the error message ?

No we dont want to log we will just ignore the error here

Why are we ignoring the error here?

Thought of ForeignFrom expects a self not result. Instead of propagating the error could have logged the error. Will pick it up in next pr.

swangi-kumari

Connector changes looks good

…list

deepanshu-iiitu · 2025-07-21T14:08:43Z

crates/hyperswitch_connectors/src/connectors/custombilling/test.rs

Rename this file to custombilling.rs and move it to crates/router/tests/connectors

deepanshu-iiitu · 2025-07-21T14:09:10Z

crates/hyperswitch_connectors/src/default_implementations.rs

 }

 default_imp_for_authorize_session_token!(
+    connectors::Custombilling,


Please follow alphabetical order in this file

deepanshu-iiitu · 2025-07-21T14:09:18Z

crates/hyperswitch_connectors/src/default_implementations_v2.rs

 }

 default_imp_for_new_connector_integration_payment!(
+    connectors::Custombilling,


Please follow alphabetical order in this file

…list

SanchithHegde · 2025-07-21T19:04:45Z

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

+        > = attempt
+            .payment_method_data
+            .clone()
+            .and_then(|data| serde_json::from_value(data.expose().clone()).ok());


Why the .expose().clone()? Isn't .expose() sufficient?

SanchithHegde · 2025-07-21T19:05:24Z

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

+        > = attempt
+            .payment_method_data
+            .clone()
+            .and_then(|data| serde_json::from_value(data.expose().clone()).ok());


Why are we ignoring the error here?

…ordea-sepa * 'main' of github.com:juspay/hyperswitch: refactor(connector): [Adyen] map ssn and session validity for Pix (#8702) feat(core): Implement UCS kill switch for emergency fallback (#8651) fix(openapi): Added Error Response Schema for Status Code 400 (#8684) feat(connector): Add template code for breadpay (#8655) chore(version): 2025.07.21.1 refactor(payments): fetch payment method information in attempts list api v2 and add custom billing connector template (#8681) fix(router): Make v2 endpoints follow standard naming conventions (#8630) fix(connector): [Cybersource] Add type_selection_indicator as 1 for all cards (#8663) feat(routing): Add API key auth for decision engine endpoints (#8640) feat(authentication): Added eligibility flow for modular authentication (#8431) feat(connector): [BLACKHAWKNETWORK] Add Template Code (#8632) fix: remove straight through routing from routing approach (#8695) fix(connector): [Access Worldpay] correct enum deserialization for payment responses for (#8689) chore(version): 2025.07.21.0

…ayload-recurring * 'main' of github.com:juspay/hyperswitch: (48 commits) fix(connector): Add Trustpay in Authentication Providers Config (#8622) refactor(connector): [Adyen] map ssn and session validity for Pix (#8702) feat(core): Implement UCS kill switch for emergency fallback (#8651) fix(openapi): Added Error Response Schema for Status Code 400 (#8684) feat(connector): Add template code for breadpay (#8655) chore(version): 2025.07.21.1 refactor(payments): fetch payment method information in attempts list api v2 and add custom billing connector template (#8681) fix(router): Make v2 endpoints follow standard naming conventions (#8630) fix(connector): [Cybersource] Add type_selection_indicator as 1 for all cards (#8663) feat(routing): Add API key auth for decision engine endpoints (#8640) feat(authentication): Added eligibility flow for modular authentication (#8431) feat(connector): [BLACKHAWKNETWORK] Add Template Code (#8632) fix: remove straight through routing from routing approach (#8695) fix(connector): [Access Worldpay] correct enum deserialization for payment responses for (#8689) chore(version): 2025.07.21.0 feat(debit_routing): add debit routing support for apple pay (#8673) refactor(router): decrypt the wallet token before the debit routing call (#8598) chore: update org retrieve api response to include org type (#8660) feat(routing): Add routing evaluation rule endpoint and related flow (#8656) fix(connector): [AUTHORIZEDOTNET] Added Invoice Number Fix (#8685) ...

…acilitapay-mca-metadata * 'main' of github.com:juspay/hyperswitch: fix(connector): Add Trustpay in Authentication Providers Config (#8622) refactor(connector): [Adyen] map ssn and session validity for Pix (#8702) feat(core): Implement UCS kill switch for emergency fallback (#8651) fix(openapi): Added Error Response Schema for Status Code 400 (#8684) feat(connector): Add template code for breadpay (#8655) chore(version): 2025.07.21.1 refactor(payments): fetch payment method information in attempts list api v2 and add custom billing connector template (#8681) fix(router): Make v2 endpoints follow standard naming conventions (#8630) fix(connector): [Cybersource] Add type_selection_indicator as 1 for all cards (#8663) feat(routing): Add API key auth for decision engine endpoints (#8640) feat(authentication): Added eligibility flow for modular authentication (#8431) feat(connector): [BLACKHAWKNETWORK] Add Template Code (#8632) fix: remove straight through routing from routing approach (#8695) fix(connector): [Access Worldpay] correct enum deserialization for payment responses for (#8689)

fetch payment method information

47935dc

NISHANTH1221 requested review from a team as code owners July 17, 2025 14:01

NISHANTH1221 self-assigned this Jul 17, 2025

chore: run formatter

38c580f

NISHANTH1221 linked an issue Jul 17, 2025 that may be closed by this pull request

refactor(payments): Fetch payment method details n PaymentListAttempt api #8682

Closed

Nishanth Challa and others added 2 commits July 17, 2025 19:36

revert v2 to v1

9357957

docs(openapi): re-generate OpenAPI specification

a22d476

hyperswitch-bot bot added the M-api-contract-changes Metadata: This PR involves API contract changes label Jul 17, 2025

Nishanth Challa and others added 2 commits July 17, 2025 21:37

resolve clippy error

abdf015

docs(openapi): re-generate OpenAPI specification

a9b95ef

Aprabhat19 reviewed Jul 17, 2025

View reviewed changes

NISHANTH1221 added the api-v2 label Jul 17, 2025

ShankarSinghC reviewed Jul 18, 2025

View reviewed changes

add template code for custom billing

65d6732

NISHANTH1221 requested a review from a team as a code owner July 18, 2025 17:13

chore: run formatter

a2fdda8

NISHANTH1221 changed the title ~~refactor(payments): fetch payment method information in attempts list api v2~~ refactor(payments): fetch payment method information in attempts list api v2 and add custom billing connector template Jul 18, 2025

docs(openapi): re-generate OpenAPI specification

ea524c5

swangi-kumari previously approved these changes Jul 19, 2025

View reviewed changes

resolve error causing failed checks

17a584a

NISHANTH1221 dismissed swangi-kumari’s stale review via 17a584a July 20, 2025 00:56

added a detailed comment about the paymentmehtoddataresponsewithbilling

b742c80

ShankarSinghC previously approved these changes Jul 20, 2025

View reviewed changes

swangi-kumari previously approved these changes Jul 20, 2025

View reviewed changes

likhinbopanna added this pull request to the merge queue Jul 20, 2025

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jul 20, 2025

Merge branch 'main' into fetch_payment_method_information_in_attempt_…

3699bd4

…list

Gnanasundari24 added this pull request to the merge queue Jul 21, 2025

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jul 21, 2025

Gnanasundari24 added this pull request to the merge queue Jul 21, 2025

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jul 21, 2025

Gnanasundari24 added this pull request to the merge queue Jul 21, 2025

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

resolve merge conficts

3cf95df

NISHANTH1221 dismissed stale reviews from ShankarSinghC and swangi-kumari via 3cf95df July 21, 2025 11:11

chore: run formatter

db4f74a

ShankarSinghC previously approved these changes Jul 21, 2025

View reviewed changes

NISHANTH1221 requested review from a team and removed request for a team July 21, 2025 13:47

deepanshu-iiitu requested changes Jul 21, 2025

View reviewed changes

resolve conflicts

31607bf

NISHANTH1221 dismissed ShankarSinghC’s stale review via 31607bf July 21, 2025 14:32

chore: run formatter

e2f3a86

swangi-kumari approved these changes Jul 21, 2025

View reviewed changes

NISHANTH1221 requested a review from deepanshu-iiitu July 21, 2025 17:58

Merge branch 'main' into fetch_payment_method_information_in_attempt_…

ee31dee

…list

SanchithHegde approved these changes Jul 21, 2025

View reviewed changes

SanchithHegde merged commit 110beaf into main Jul 21, 2025
16 of 20 checks passed

SanchithHegde deleted the fetch_payment_method_information_in_attempt_list branch July 21, 2025 19:08

Conversation

NISHANTH1221 commented Jul 17, 2025

Type of Change

Description

Additional Changes

Motivation and Context

How did you test it?

Checklist

Uh oh!

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

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

NISHANTH1221 Jul 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

swangi-kumari left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

semanticdiff-com bot commented Jul 17, 2025 •

edited

Loading

NISHANTH1221 Jul 17, 2025 •

edited

Loading