feat(payment_method): add logic for setup_future_usage downgrade and add filter based on zero mandate config by Sakilmostak · Pull Request #7775 · juspay/hyperswitch

Sakilmostak · 2025-04-09T11:36:57Z

Type of Change

Description

In list payment method for merchant, list both mandate and non-mandate payment methods unless it is zero mandate flow
If the setup_future_usage is off_session for a payment method, downgrade it to on_session for that payment method
Add config for the zero mandates (being used in list payment method for merchant)
Add setup_future_usage field to payment_attempt to keep track of it for every attempt made

Below contains the new filtering logic:

Below represents the PaymentType for each payment_method_type during list call based the following parameters:

Additional Changes

This PR modifies the API contract
This PR modifies the database schema

Added setup_future_usage column to payment_attempt table

This PR modifies application configuration/environment variables

Added filter config for zero_mandates.
This represent the combination of payment_method, payment_method_type and connector for which zero_mandate flow is present

Motivation and Context

How did you test it?

Testing Payment Method List for Merchant:

Curls:

Create Payment

curl --location '{{baseUrl}}/payments' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'api-key: {{api_key}}' \
--data-raw '{
    "amount": 10,
    "currency": "USD",
    "confirm": false,
    "capture_method": "automatic",
    "capture_on": "2022-09-10T10:11:12Z",
    "customer_id": "{{customer_id}}",
    "email": "guest@example.com",
    "name": "John Doe",
    "phone": "999999999",
    "phone_country_code": "+65",
    "description": "Its my first payment request",
    "authentication_type": "no_three_ds",
    "return_url": "https://duck.com",
    "billing": {
        "address": {
            "city": "test",
            "country": "HR",
            "line1": "here is some \n there is some \n none is some? \n ",
            "line2": "there",
            "line3": "anywhere",
            "zip": "560095",
            "state": "Varaždin County",
            "first_name": "S@k!l",
            "last_name": "M*st@k"
        }
    },
    "shipping": {
        "address": {
            "line1": "1467",
            "line2": "Harrison Street",
            "line3": "Harrison Street",
            "city": "San Fransico",
            "state": "California",
            "zip": "94122",
            "country": "US",
            "first_name": "PiX"
        }
    },
    "statement_descriptor_name": "joseph",
    "statement_descriptor_suffix": "JS",
    "metadata": {
        "udf1": "value1",
        "new_customer": "true",
        "login_date": "2019-09-10T10:11:12Z"
    },
   "setup_future_usage": "off_session",
}'

Payment Method List for Merchant

curl --location '{{baseUrl}}/account/payment_methods?client_secret={{client_secret}}' \
--header 'Accept: application/json' \
--header 'api-key: {{api_key}}'

Scenarios:
Case 1: Non-zero amount and setup_future_usage as on_session
Result:

Payment Method List should have all the payment method type selected by merchant

Case 2: Non-zero amount and setup_future_usage as off_session
Result:

Payment Method List should have all the payment method type selected by merchant

Case 3: Zero amount and setup_future_usage as on_session
Result:

Payment Method List should have all the payment method type selected by merchant

Case 4: Zero amount and setup_future_usage as off_session
Result:

Payment Method List should filter the payment method type based on whether zero mandate is supported

Testing setup_future_usage downgrade logic:

Curls:
Payment Create+Confirm:

curl --location '{{baseUrl}}/payments' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'api-key: ••••••' \
--data-raw '{
    "amount": 141,
    "currency": "EUR",
    "confirm": true,
    "capture_method": "automatic",
    "capture_on": "2022-09-10T10:11:12Z",
    "customer_id": "StripeCustomer",
    "email": "guest@example.com",
    "name": "John Doe",
    "phone": "999999999",
    "phone_country_code": "+1",
    "description": "Its my first payment request",
    "authentication_type": "no_three_ds",
    "return_url": "https://google.com",
    "payment_method": "gift_card",
    "payment_method_type": "givex",
    "payment_method_data": {
        "gift_card": {
            "givex": {
                "number": "{{gift_card_number}}",
                "cvc": "{{gift_card_cvc}}"
            }
        }
    },
    "billing": {
        "address": {
            "line1": "1467",
            "line2": "Harrison Street",
            "line3": "Harrison Street",
            "city": "San Fransico",
            "state": "California",
            "zip": "94122",
            "country": "GB",
            "first_name": "joseph",
            "last_name": "Doe"
        },
        "phone": {
            "number": "8056594427",
            "country_code": "+91"
        }
    },
    "browser_info": {
        "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36",
        "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8",
        "language": "nl-NL",
        "color_depth": 24,
        "screen_height": 723,
        "screen_width": 1536,
        "time_zone": 0,
        "java_enabled": true,
        "java_script_enabled": true,
        "ip_address": "127.0.0.1"
    },
    "shipping": {
        "address": {
            "line1": "1467",
            "line2": "Harrison Street",
            "line3": "Harrison Street",
            "city": "San Fransico",
            "state": "California",
            "zip": "94122",
            "country": "GB",
            "first_name": "joseph",
            "last_name": "Doe"
        },
        "phone": {
            "number": "8056594427",
            "country_code": "+91"
        }
    },
    "statement_descriptor_name": "joseph",
    "statement_descriptor_suffix": "JS",
    "metadata": {
        "udf1": "value1",
        "new_customer": "true",
        "login_date": "2019-09-10T10:11:12Z"
    },
    "setup_future_usage": "off_session"
}'

Scenarios:
Case 1: Create a payment with cards for Adyen with setup_future_usage as off_session
Result:

The response should contain payment_method_id and setup_future_usage as off_session
Reason:
Since card for adyen support mandates, the filter allowed for the creation of mandate

Case 2: Create a payment with gift cards for Adyen with setup_future_usage as off_session
Result:

In response, setup_future_usage should be on_session with payment_method_id as null
Reason:
setup_future_usage is downgraded to on_session since mandate is not supported by gift card for adyen

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

… downgrade

semanticdiff-com · 2025-04-09T11:37:01Z

Review changes with

Changed Files

File	Status
crates/router/src/core/payment_methods/cards.rs	2% smaller
crates/router/src/configs/defaults/payment_connector_required_fields.rs	1% smaller
config/config.example.toml	Unsupported file format
config/deployments/integration_test.toml	Unsupported file format
config/deployments/production.toml	Unsupported file format
config/deployments/sandbox.toml	Unsupported file format
config/development.toml	Unsupported file format
config/docker_compose.toml	Unsupported file format
crates/diesel_models/src/payment_attempt.rs	0% smaller
crates/diesel_models/src/schema.rs	0% smaller
crates/diesel_models/src/user/sample_data.rs	0% smaller
crates/hyperswitch_domain_models/src/payments/payment_attempt.rs	0% smaller
crates/router/src/configs/secrets_transformers.rs	0% smaller
crates/router/src/configs/settings.rs	0% smaller
crates/router/src/core/payments/flows/authorize_flow.rs	0% smaller
crates/router/src/core/payments/helpers.rs	0% smaller
crates/router/src/core/payments/operations/payment_create.rs	0% smaller
crates/router/src/core/payments/operations/payment_response.rs	0% smaller
crates/router/src/core/payments/retry.rs	0% smaller
crates/router/src/core/payments/transformers.rs	0% smaller
crates/router/src/types/storage/payment_attempt.rs	0% smaller
crates/router/src/utils/user/sample_data.rs	0% smaller
crates/storage_impl/src/mock_db/payment_attempt.rs	0% smaller
crates/storage_impl/src/payments/payment_attempt.rs	0% smaller
migrations/2025-04-09-074315_add_setup_future_usage_to_payment_attempt/down.sql	Unsupported file format
migrations/2025-04-09-074315_add_setup_future_usage_to_payment_attempt/up.sql	Unsupported file format
v2_migrations/2025-01-13-081847_drop_v1_columns/up.sql	Unsupported file format

kashif-m

Looks good, added some nits and comments

crates/router/src/configs/defaults/payment_connector_required_fields.rs

crates/router/src/core/payment_methods/cards.rs

kashif-m

Looks good 👍

config/config.example.toml

crates/diesel_models/src/payment_attempt.rs

crates/router/src/configs/defaults/payment_connector_required_fields.rs

crates/router/src/core/payment_methods/cards.rs

jarnura · 2025-04-15T15:49:58Z

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

            extended_authorization_applied: None,
            capture_before: None,
            card_discovery: None,
+            setup_future_usage: old_payment_attempt.setup_future_usage,


In retry is this use the old attempts setup future usage or this should be none and calculate actual future usage while doing the next attempt

For each new payment_attempt of retry, the setup_future_usage will be picked from payment_intent since retry calls call_connector_service on every attempt meaning the downgrade logic is ran everytime.

cypress-tests/cypress/e2e/configs/Payment/Cybersource.js

cypress-tests/cypress/e2e/spec/Payment/00014-SaveCardFlow.cy.js

cypress-tests/cypress/e2e/spec/Payment/00015-ZeroAuthMandate.cy.js

crates/router/src/core/payment_methods/cards.rs

crates/router/src/configs/defaults/payment_connector_required_fields.rs

…acilitapay-pix-pmt * 'main' of github.com:juspay/hyperswitch: (21 commits) refactor(required_fields): move pm required fields to pm crate (#7539) fix(connector): [noon] address `next_action_url` being `null` for cards in 3ds payment (#7832) refactor(middleware): add middleware to record metrics for request count and duration (#7803) chore(version): 2025.04.18.0 chore(postman): update Postman collection files fix(connector): [globalpay] handle edge case where currency comes as empty upon payment decline (#7812) refactor(cypress-v2): change `Authorization` and `payment_methods_enabled` for v2 cypress tests (#7805) fix(connector): [Cybersource] send type selection indicator for co-batch cards (#7828) feat(payment_method): add logic for setup_future_usage downgrade and add filter based on zero mandate config (#7775) refactor(accounts): move dashboard_metadata table to accounts_schema and point v2 to v1 dashboard_metadata (#7793) chore(analytics): opensearch client creation based on config (#7810) ci(postman): update assertion error message for nmi collection (#7765) feat: add primary key not null query to generic filter function (#7785) chore(version): 2025.04.17.0 chore: change payment method files ownership to `hyperswitch-payment-methods` (#7808) feat(vsaas): modify api key auth to support vsaas cases (#7593) ci(cypress): verify mandate id to be `null` if payment id not `succeeded` (#7749) feat(connector): [chargebee] consumes required fields to support transaction monitoring (#7774) ci(configs): remove vault private key from configs (#7825) chore(version): 2025.04.16.0 ...

feat: add filter based on config and add logic for setup_future_usage…

07e1174

… downgrade

Sakilmostak added C-feature Category: Feature request or enhancement M-database-changes Metadata: This PR involves database schema changes A-payment-methods Area: Payment Methods labels Apr 9, 2025

Sakilmostak added this to the April 2025 Release milestone Apr 9, 2025

Sakilmostak self-assigned this Apr 9, 2025

Sakilmostak requested review from a team as code owners April 9, 2025 11:36

Sakilmostak added 2 commits April 9, 2025 17:13

refactor: add config to all the remaining files

a06ebaa

chore: resolve ci check

e3de4f0

kashif-m reviewed Apr 10, 2025

View reviewed changes

Sakilmostak added 2 commits April 10, 2025 13:47

refactor: resolve comments

f5e4934

refactor: update filter logic

0bf36a5

kashif-m previously approved these changes Apr 10, 2025

View reviewed changes

Aprabhat19 reviewed Apr 11, 2025

View reviewed changes

config/config.example.toml Show resolved Hide resolved

crates/diesel_models/src/payment_attempt.rs Outdated Show resolved Hide resolved

refactor: resolve comments

2e620cb

Sakilmostak dismissed kashif-m’s stale review via 2e620cb April 14, 2025 09:03

Sakilmostak and others added 3 commits April 15, 2025 14:11

refactor: resolve comment

026e613

Merge branch 'main' into pml_config_change

8020c8d

refactor: resolve ci check

89dd59f

Sakilmostak requested a review from a team as a code owner April 15, 2025 13:00

tsdk02 previously approved these changes Apr 15, 2025

View reviewed changes

chore(cypress): run formatter and address lints

da0bc05

hyperswitch-bot bot dismissed tsdk02’s stale review via da0bc05 April 15, 2025 13:07

jarnura requested changes Apr 15, 2025

View reviewed changes

refactor: resolve comments [part 1]

d598d32

kashif-m previously approved these changes Apr 16, 2025

View reviewed changes

Sakilmostak added 3 commits April 16, 2025 13:15

refactor: resolve comments

2a59a15

Merge branch 'main' into pml_config_change

11d8338

refactor: resolve comments [part 3]

618ead6

Sakilmostak dismissed kashif-m’s stale review via 618ead6 April 16, 2025 08:40

Sakilmostak added 2 commits April 16, 2025 14:14

refactor: resolve comments [part 4]

9d6e969

refactor: resolve ci check

d543967

Sakilmostak removed the request for review from a team April 16, 2025 09:42

refactor: only downgrade in case of offsession

35b510a

kashif-m reviewed Apr 17, 2025

View reviewed changes

crates/router/src/configs/defaults/payment_connector_required_fields.rs Show resolved Hide resolved

jarnura approved these changes Apr 17, 2025

View reviewed changes

kashif-m approved these changes Apr 17, 2025

View reviewed changes

tsdk02 approved these changes Apr 17, 2025

View reviewed changes

prasunna09 approved these changes Apr 17, 2025

View reviewed changes

likhinbopanna added this pull request to the merge queue Apr 17, 2025

Merged via the queue into main with commit d061e0a Apr 17, 2025
16 of 20 checks passed

likhinbopanna deleted the pml_config_change branch April 17, 2025 12:09

Conversation

Sakilmostak commented Apr 9, 2025 • 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?

Testing Payment Method List for Merchant:

Testing setup_future_usage downgrade logic:

Checklist

Uh oh!

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

Uh oh!

Uh oh!

kashif-m left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kashif-m left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jarnura Apr 15, 2025

Choose a reason for hiding this comment

Uh oh!

Sakilmostak Apr 16, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Sakilmostak commented Apr 9, 2025 •

edited

Loading

semanticdiff-com bot commented Apr 9, 2025 •

edited

Loading