Skip to content

feat(router): add pre-confirm payments eligibility api#9774

Merged
Gnanasundari24 merged 10 commits intomainfrom
add-core-handling-for-submit-eligibility-api
Oct 16, 2025
Merged

feat(router): add pre-confirm payments eligibility api#9774
Gnanasundari24 merged 10 commits intomainfrom
add-core-handling-for-submit-eligibility-api

Conversation

@sai-harsha-vardhan
Copy link
Contributor

@sai-harsha-vardhan sai-harsha-vardhan commented Oct 9, 2025 •
edited
Loading

Type of Change

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

Description

Payments Eligibility API

This PR introduces the Payments Eligibility API, which is invoked by the SDK after the payment method data filled event. The API pre-processes the submitted payment method data to determine the appropriate next action and checks eligibility based on various parameters.

As part of this change, blocklist checks have been added to the eligibility flow to ensure that ineligible or restricted payment methods are identified early in the process.

image

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?

Tested Manually

  1. Create a blocklist rule for a card_bin (424242)
    CURL
curl --location '{{BASE_URL}}/blocklist' \
--header 'Content-Type: application/json' \
--header 'api-key: {{API_KEY}}' \
--data '{
    "type": "card_bin",
    "data": "424242"
}'

Response

{
    "fingerprint_id": "424242",
    "data_kind": "card_bin",
    "created_at": "2025-10-09T13:52:38.914Z"
}
  1. Call the Eligibility API with blocklisted bin to see next_action being Deny in the response
    CURL
curl --location '{{BASE_URL}}/payments/{{PAYMENT_ID}}/eligibility' \
--header 'Content-Type: application/json' \
--header 'api-key: {{PUBLISHABLE_KEY}}' \
--data '{
    "client_secret": "pay_UvTqxnVPNNChhe1vKk1W_secret_AF9avGOwxxvcwqHhmYv0",
    "payment_method_type": "card",
    "payment_method_data": {
        "card": {
            "card_number": "4242424242424242",
            "card_exp_month": "01",
            "card_exp_year": "2050",
            "card_holder_name": "John Smith",
            "card_cvc": "349",
            "card_network": "Visa"
        },
        "billing": {
            "address": {
                "line1": "1467",
                "line2": "Harrison Street",
                "line3": "Harrison Street",
                "city": "San Fransico",
                "state": "CA",
                "zip": "94122",
                "country": "US",
                "first_name": "John",
                "last_name": "Doe"
            },
            "phone": {
                "number": "8056594427",
                "country_code": "+91"
            }
        }
    }
}'

Response

{
    "payment_id": "pay_UvTqxnVPNNChhe1vKk1W",
    "sdk_next_action": {
        "next_action": {
            "deny": {
                "message": "Card number is blocklisted"
            }
        }
    }
}
  1. Call the Eligibility API with non-blocklisted bin to see next_action being Confirm in the response
    CURL
curl --location '{{BASE_URL}}/payments/{{PAYMENT_ID}}/eligibility' \
--header 'Content-Type: application/json' \
--header 'api-key: {{PUBLISHABLE_KEY}}' \
--data '{
    "client_secret": "pay_UvTqxnVPNNChhe1vKk1W_secret_AF9avGOwxxvcwqHhmYv0",
    "payment_method_type": "card",
    "payment_method_data": {
        "card": {
            "card_number": "411111111111111",
            "card_exp_month": "01",
            "card_exp_year": "2050",
            "card_holder_name": "John Smith",
            "card_cvc": "349",
            "card_network": "Visa"
        },
        "billing": {
            "address": {
                "line1": "1467",
                "line2": "Harrison Street",
                "line3": "Harrison Street",
                "city": "San Fransico",
                "state": "CA",
                "zip": "94122",
                "country": "US",
                "first_name": "John",
                "last_name": "Doe"
            },
            "phone": {
                "number": "8056594427",
                "country_code": "+91"
            }
        }
    }
}'

Response

{
    "payment_id": "pay_UvTqxnVPNNChhe1vKk1W",
    "sdk_next_action": {
        "next_action": "confirm"
    }
}

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

@sai-harsha-vardhan sai-harsha-vardhan added this to the July 2025 Release milestone Oct 9, 2025
@sai-harsha-vardhan sai-harsha-vardhan self-assigned this Oct 9, 2025
@sai-harsha-vardhan sai-harsha-vardhan requested review from a team as code owners October 9, 2025 14:39
@sai-harsha-vardhan sai-harsha-vardhan added A-core Area: Core flows C-feature Category: Feature request or enhancement labels Oct 9, 2025
@semanticdiff-com
Copy link

semanticdiff-com bot commented Oct 9, 2025 •
edited
Loading

Review changes with  SemanticDiff

Changed Files
File Status
  crates/router/src/types/api/payments.rs  98% smaller
  crates/router/src/routes/lock_utils.rs  83% smaller
  crates/router/src/core/blocklist/utils.rs  64% smaller
  crates/router/src/routes/app.rs  17% smaller
  crates/api_models/src/payments.rs  16% smaller
  api-reference/v1/openapi_spec_v1.json  7% smaller
  api-reference/v2/openapi_spec_v2.json  4% smaller
  crates/api_models/src/events/payment.rs  0% smaller
  crates/router/src/core/payments.rs  0% smaller
  crates/router/src/routes/payments.rs  0% smaller
  crates/router/src/services/authentication.rs  0% smaller
  crates/router_env/src/logger/types.rs  0% smaller

@hyperswitch-bot hyperswitch-bot bot added the M-api-contract-changes Metadata: This PR involves API contract changes label Oct 10, 2025
jarnura
jarnura requested changes Oct 13, 2025
View reviewed changes
apoorvdixit88
apoorvdixit88 approved these changes Oct 15, 2025
View reviewed changes
Copy link
Contributor

@apoorvdixit88 apoorvdixit88 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Dashboard changes look fine.

@Gnanasundari24 Gnanasundari24 added this pull request to the merge queue Oct 16, 2025
Merged via the queue into main with commit ecf702a Oct 16, 2025
21 of 25 checks passed
@Gnanasundari24 Gnanasundari24 deleted the add-core-handling-for-submit-eligibility-api branch October 16, 2025 07:16
@sai-harsha-vardhan sai-harsha-vardhan mentioned this pull request Oct 16, 2025
Merged
14 tasks
chaitak-gorai pushed a commit that referenced this pull request Oct 16, 2025
@sai-harsha-vardhan @hyperswitch-bot
feat(router): add pre-confirm payments eligibility api (#9774)
6772011 
Co-authored-by: hyperswitch-bot[bot] <148525504+hyperswitch-bot[bot]@users.noreply.github.com>
drdholu pushed a commit to drdholu/hyperswitch that referenced this pull request Oct 30, 2025
@sai-harsha-vardhan @hyperswitch-bot @drdholu
feat(router): add pre-confirm payments eligibility api (juspay#9774)
65d34b6 
Co-authored-by: hyperswitch-bot[bot] <148525504+hyperswitch-bot[bot]@users.noreply.github.com>
aadityaguptaa pushed a commit that referenced this pull request Nov 10, 2025
@sai-harsha-vardhan @hyperswitch-bot @aadityaguptaa
feat(router): add pre-confirm payments eligibility api (#9774)
084e618 
Co-authored-by: hyperswitch-bot[bot] <148525504+hyperswitch-bot[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jarnura jarnura jarnura approved these changes

@apoorvdixit88 apoorvdixit88 apoorvdixit88 approved these changes

@su-shivanshmathur su-shivanshmathur su-shivanshmathur approved these changes

Assignees

@sai-harsha-vardhan sai-harsha-vardhan

Labels

A-core Area: Core flows C-feature Category: Feature request or enhancement M-api-contract-changes Metadata: This PR involves API contract changes

Projects

None yet

Milestone

July 2025 Release

Development

Successfully merging this pull request may close these issues.

5 participants

@sai-harsha-vardhan @jarnura @apoorvdixit88 @su-shivanshmathur @Gnanasundari24