refactor(core): Refactor customer payment method list for v2 #4856

Sarthak1799 · 2024-06-03T13:32:14Z

Type of Change

Description

Refactored customer's pml for v2

The customers Payment method list will be moved under two distinct endpoints:

For Client (with payment tokens) - /payments/:id:/saved_payment_methods
For Server (without payment token) - /customers/:cust_id:/saved_payment_methods

Payment tokens for the listed payment methods would be generated only in case of client calls in a payments context.

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?

Save a card
Create another payment

curl --location --request POST 'http:https://localhost:8080/payments' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'api-key: dev_cHN6hMdCFUUrNWjYSxnwhiuMsg83rXTX9jBmtHmCL6sq9a43PswY304MSt3a9blR' \
--data-raw '{
    "amount": 200,
    "currency": "USD",
    "confirm": false,
    "capture_method": "automatic",
    "capture_on": "2022-09-10T10:11:12Z",
    "customer_id": "Some_cust2",
    "email": "[email protected]",
    "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",
    "billing": {
        "address": {
            "line1": "1467",
            "line2": "Harrison Street",
            "line3": "Harrison Street",
            "city": "San Fransico",
            "state": "California",
            "zip": "94122",
            "country": "US",
            "first_name": "john",
            "last_name": "Doe"
        },
        "phone": {
            "number": "8056594427",
            "country_code": "+91"
        }
    },
    "shipping": {
        "address": {
            "line1": "1467",
            "line2": "Harrison Street",
            "line3": "Harrison Street",
            "city": "San Fransico",
            "state": "California",
            "zip": "94122",
            "country": "US",
            "first_name": "joseph",
            "last_name": "Doe"
        },
        "phone": {
            "number": "8056594430",
            "country_code": "+91"
        }
    },
    "statement_descriptor_name": "joseph",
    "statement_descriptor_suffix": "JS",
    "metadata": {
        "udf1": "value1",
        "new_customer": "true",
        "login_date": "2019-09-10T10:11:12Z"
    }
}'

Response -

{
    "payment_id": "pay_hV3TKmMxSUmAkiLEVN9A",
    "merchant_id": "sarthak1",
    "status": "requires_payment_method",
    "amount": 200,
    "net_amount": 200,
    "amount_capturable": 0,
    "amount_received": null,
    "connector": null,
    "client_secret": "pay_hV3TKmMxSUmAkiLEVN9A_secret_fgnc3nZSRFFXOhrlzNlT",
    "created": "2024-06-26T10:35:00.555Z",
    "currency": "USD",
    "customer_id": "Some_cust2",
    "customer": {
        "id": "Some_cust2",
        "name": "John Doe",
        "email": "[email protected]",
        "phone": "999999999",
        "phone_country_code": "+1"
    },
    "description": "Its my first payment request",
    "refunds": null,
    "disputes": null,
    "mandate_id": null,
    "mandate_data": null,
    "setup_future_usage": null,
    "off_session": null,
    "capture_on": null,
    "capture_method": "automatic",
    "payment_method": null,
    "payment_method_data": null,
    "payment_token": null,
    "shipping": {
        "address": {
            "city": "San Fransico",
            "country": "US",
            "line1": "1467",
            "line2": "Harrison Street",
            "line3": "Harrison Street",
            "zip": "94122",
            "state": "California",
            "first_name": "joseph",
            "last_name": "Doe"
        },
        "phone": {
            "number": "8056594430",
            "country_code": "+91"
        },
        "email": null
    },
    "billing": {
        "address": {
            "city": "San Fransico",
            "country": "US",
            "line1": "1467",
            "line2": "Harrison Street",
            "line3": "Harrison Street",
            "zip": "94122",
            "state": "California",
            "first_name": "john",
            "last_name": "Doe"
        },
        "phone": {
            "number": "8056594427",
            "country_code": "+91"
        },
        "email": null
    },
    "order_details": null,
    "email": "[email protected]",
    "name": "John Doe",
    "phone": "999999999",
    "return_url": "https://google.com/",
    "authentication_type": "no_three_ds",
    "statement_descriptor_name": "joseph",
    "statement_descriptor_suffix": "JS",
    "next_action": null,
    "cancellation_reason": null,
    "error_code": null,
    "error_message": null,
    "unified_code": null,
    "unified_message": null,
    "payment_experience": null,
    "payment_method_type": null,
    "connector_label": null,
    "business_country": null,
    "business_label": "default",
    "business_sub_label": null,
    "allowed_payment_method_types": null,
    "ephemeral_key": {
        "customer_id": "Some_cust2",
        "created_at": 1719398100,
        "expires": 1719401700,
        "secret": "epk_42df89f77c244dddb78526685aa78770"
    },
    "manual_retry_allowed": null,
    "connector_transaction_id": null,
    "frm_message": null,
    "metadata": {
        "udf1": "value1",
        "login_date": "2019-09-10T10:11:12Z",
        "new_customer": "true"
    },
    "connector_metadata": null,
    "feature_metadata": null,
    "reference_id": null,
    "payment_link": null,
    "profile_id": "pro_1HgRzJgJf21X3s7FPrhP",
    "surcharge_details": null,
    "attempt_count": 1,
    "merchant_decision": null,
    "merchant_connector_id": null,
    "incremental_authorization_allowed": null,
    "authorization_count": null,
    "incremental_authorizations": null,
    "external_authentication_details": null,
    "external_3ds_authentication_attempted": false,
    "expires_on": "2024-06-26T10:50:00.555Z",
    "fingerprint": null,
    "browser_info": null,
    "payment_method_id": null,
    "payment_method_status": null,
    "updated": "2024-06-26T10:35:00.600Z",
    "charges": null,
    "frm_metadata": null
}

List saved payment method for v2

curl --location --request GET 'http:https://localhost:8080/payments/v2/pay_hV3TKmMxSUmAkiLEVN9A/saved_payment_methods?client_secret=pay_hV3TKmMxSUmAkiLEVN9A_secret_fgnc3nZSRFFXOhrlzNlT' \
--header 'Accept: application/json' \
--header 'api-key: pk_dev_16e38a16176e45298a70da6c56c5028d'

Response -

{
    "customer_payment_methods": [
        {
            "payment_token": "token_nHjU0LP8ZpFGjGIIhZMV",
            "payment_method_id": "pm_R8n4IKXyEpAGcKaEQl0g",
            "customer_id": "Some_cust2",
            "payment_method": "card",
            "payment_method_type": null,
            "payment_method_issuer": null,
            "payment_method_issuer_code": null,
            "recurring_enabled": false,
            "installment_payment_enabled": false,
            "payment_experience": [
                "redirect_to_url"
            ],
            "card": {
                "scheme": null,
                "issuer_country": null,
                "last4_digits": "4242",
                "expiry_month": "10",
                "expiry_year": "2025",
                "card_token": null,
                "card_holder_name": "joseph Doe",
                "card_fingerprint": null,
                "nick_name": null,
                "card_network": null,
                "card_isin": "424242",
                "card_issuer": null,
                "card_type": null,
                "saved_to_locker": true
            },
            "metadata": null,
            "created": "2024-06-26T08:26:47.674Z",
            "bank": null,
            "surcharge_details": null,
            "requires_cvv": true,
            "last_used_at": "2024-06-26T08:26:47.674Z",
            "default_payment_method_set": false,
            "billing": {
                "address": {
                    "city": "San Fransico",
                    "country": "US",
                    "line1": "1467",
                    "line2": "Harrison Street",
                    "line3": "Harrison Street",
                    "zip": "94122",
                    "state": "California",
                    "first_name": "john",
                    "last_name": "Doe"
                },
                "phone": {
                    "number": "8056594427",
                    "country_code": "+91"
                },
                "email": null
            }
        },
        {
            "payment_token": "token_KpVCFyDUyRLAztdCMsjA",
            "payment_method_id": "pm_xFF1OOhEMqVQhzEv3b06",
            "customer_id": "Some_cust2",
            "payment_method": "card",
            "payment_method_type": null,
            "payment_method_issuer": null,
            "payment_method_issuer_code": null,
            "recurring_enabled": false,
            "installment_payment_enabled": false,
            "payment_experience": [
                "redirect_to_url"
            ],
            "card": {
                "scheme": null,
                "issuer_country": null,
                "last4_digits": "4242",
                "expiry_month": "10",
                "expiry_year": "2025",
                "card_token": null,
                "card_holder_name": "joseph Doe",
                "card_fingerprint": null,
                "nick_name": null,
                "card_network": null,
                "card_isin": "424242",
                "card_issuer": null,
                "card_type": null,
                "saved_to_locker": true
            },
            "metadata": null,
            "created": "2024-06-13T11:55:47.828Z",
            "bank": null,
            "surcharge_details": null,
            "requires_cvv": true,
            "last_used_at": "2024-06-13T11:55:47.828Z",
            "default_payment_method_set": true,
            "billing": {
                "address": {
                    "city": "San Fransico",
                    "country": "US",
                    "line1": "1467",
                    "line2": "Harrison Street",
                    "line3": "Harrison Street",
                    "zip": "94122",
                    "state": "California",
                    "first_name": "john",
                    "last_name": "Doe"
                },
                "phone": {
                    "number": "8056594427",
                    "country_code": "+91"
                },
                "email": null
            }
        }
    ],
    "is_guest_customer": false
}

Confirm using payment_token

curl --location --request POST 'http:https://localhost:8080/payments/pay_hV3TKmMxSUmAkiLEVN9A/confirm' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'api-key: pk_dev_16e38a16176e45298a70da6c56c5028d' \
--data-raw '{
    "payment_token": "token_nHjU0LP8ZpFGjGIIhZMV",
    "client_secret": "pay_hV3TKmMxSUmAkiLEVN9A_secret_fgnc3nZSRFFXOhrlzNlT",
    "payment_method": "card"
}'

Response -

{
    "payment_id": "pay_hV3TKmMxSUmAkiLEVN9A",
    "merchant_id": "sarthak1",
    "status": "succeeded",
    "amount": 200,
    "net_amount": 200,
    "amount_capturable": 0,
    "amount_received": 200,
    "connector": "stripe",
    "client_secret": "pay_hV3TKmMxSUmAkiLEVN9A_secret_fgnc3nZSRFFXOhrlzNlT",
    "created": "2024-06-26T10:35:00.555Z",
    "currency": "USD",
    "customer_id": "Some_cust2",
    "customer": {
        "id": "Some_cust2",
        "name": "John Doe",
        "email": "[email protected]",
        "phone": "999999999",
        "phone_country_code": "+1"
    },
    "description": "Its my first payment request",
    "refunds": null,
    "disputes": null,
    "mandate_id": null,
    "mandate_data": null,
    "setup_future_usage": null,
    "off_session": null,
    "capture_on": null,
    "capture_method": "automatic",
    "payment_method": null,
    "payment_method_data": null,
    "payment_token": "token_nHjU0LP8ZpFGjGIIhZMV",
    "shipping": {
        "address": {
            "city": "San Fransico",
            "country": "US",
            "line1": "1467",
            "line2": "Harrison Street",
            "line3": "Harrison Street",
            "zip": "94122",
            "state": "California",
            "first_name": "joseph",
            "last_name": "Doe"
        },
        "phone": {
            "number": "8056594430",
            "country_code": "+91"
        },
        "email": null
    },
    "billing": {
        "address": {
            "city": "San Fransico",
            "country": "US",
            "line1": "1467",
            "line2": "Harrison Street",
            "line3": "Harrison Street",
            "zip": "94122",
            "state": "California",
            "first_name": "john",
            "last_name": "Doe"
        },
        "phone": {
            "number": "8056594427",
            "country_code": "+91"
        },
        "email": null
    },
    "order_details": null,
    "email": "[email protected]",
    "name": "John Doe",
    "phone": "999999999",
    "return_url": "https://google.com/",
    "authentication_type": "no_three_ds",
    "statement_descriptor_name": "joseph",
    "statement_descriptor_suffix": "JS",
    "next_action": null,
    "cancellation_reason": null,
    "error_code": null,
    "error_message": null,
    "unified_code": null,
    "unified_message": null,
    "payment_experience": null,
    "payment_method_type": null,
    "connector_label": null,
    "business_country": null,
    "business_label": "default",
    "business_sub_label": null,
    "allowed_payment_method_types": null,
    "ephemeral_key": null,
    "manual_retry_allowed": false,
    "connector_transaction_id": "pi_3PVtGBD5R7gDAGff0A5EOZ7K",
    "frm_message": null,
    "metadata": {
        "udf1": "value1",
        "login_date": "2019-09-10T10:11:12Z",
        "new_customer": "true"
    },
    "connector_metadata": null,
    "feature_metadata": null,
    "reference_id": "pi_3PVtGBD5R7gDAGff0A5EOZ7K",
    "payment_link": null,
    "profile_id": "pro_1HgRzJgJf21X3s7FPrhP",
    "surcharge_details": null,
    "attempt_count": 1,
    "merchant_decision": null,
    "merchant_connector_id": "mca_e7VLlW3sNkytn6HccQAa",
    "incremental_authorization_allowed": null,
    "authorization_count": null,
    "incremental_authorizations": null,
    "external_authentication_details": null,
    "external_3ds_authentication_attempted": false,
    "expires_on": "2024-06-26T10:50:00.555Z",
    "fingerprint": null,
    "browser_info": {
        "language": null,
        "time_zone": null,
        "ip_address": "::1",
        "user_agent": null,
        "color_depth": null,
        "java_enabled": null,
        "screen_width": null,
        "accept_header": null,
        "screen_height": null,
        "java_script_enabled": null
    },
    "payment_method_id": "pm_R8n4IKXyEpAGcKaEQl0g",
    "payment_method_status": "active",
    "updated": "2024-06-26T10:39:32.680Z",
    "charges": null,
    "frm_metadata": null
}

Use Merchant API for saved payment methods -

curl --location --request GET 'http:https://localhost:8080/customers/v2/Some_cust2/saved_payment_methods' \
--header 'Accept: application/json' \
--header 'api-key: dev_cHN6hMdCFUUrNWjYSxnwhiuMsg83rXTX9jBmtHmCL6sq9a43PswY304MSt3a9blR'

Response -

{
    "customer_payment_methods": [
        {
            "payment_token": null,
            "payment_method_id": "pm_R8n4IKXyEpAGcKaEQl0g",
            "customer_id": "Some_cust2",
            "payment_method": "card",
            "payment_method_type": null,
            "payment_method_issuer": null,
            "payment_method_issuer_code": null,
            "recurring_enabled": false,
            "installment_payment_enabled": false,
            "payment_experience": [
                "redirect_to_url"
            ],
            "card": {
                "scheme": null,
                "issuer_country": null,
                "last4_digits": "4242",
                "expiry_month": "10",
                "expiry_year": "2025",
                "card_token": null,
                "card_holder_name": "joseph Doe",
                "card_fingerprint": null,
                "nick_name": null,
                "card_network": null,
                "card_isin": "424242",
                "card_issuer": null,
                "card_type": null,
                "saved_to_locker": true
            },
            "metadata": null,
            "created": "2024-06-26T08:26:47.674Z",
            "bank": null,
            "surcharge_details": null,
            "requires_cvv": false,
            "last_used_at": "2024-06-26T10:39:30.552Z",
            "default_payment_method_set": false,
            "billing": {
                "address": {
                    "city": "San Fransico",
                    "country": "US",
                    "line1": "1467",
                    "line2": "Harrison Street",
                    "line3": "Harrison Street",
                    "zip": "94122",
                    "state": "California",
                    "first_name": "john",
                    "last_name": "Doe"
                },
                "phone": {
                    "number": "8056594427",
                    "country_code": "+91"
                },
                "email": null
            }
        },
        {
            "payment_token": null,
            "payment_method_id": "pm_xFF1OOhEMqVQhzEv3b06",
            "customer_id": "Some_cust2",
            "payment_method": "card",
            "payment_method_type": null,
            "payment_method_issuer": null,
            "payment_method_issuer_code": null,
            "recurring_enabled": false,
            "installment_payment_enabled": false,
            "payment_experience": [
                "redirect_to_url"
            ],
            "card": {
                "scheme": null,
                "issuer_country": null,
                "last4_digits": "4242",
                "expiry_month": "10",
                "expiry_year": "2025",
                "card_token": null,
                "card_holder_name": "joseph Doe",
                "card_fingerprint": null,
                "nick_name": null,
                "card_network": null,
                "card_isin": "424242",
                "card_issuer": null,
                "card_type": null,
                "saved_to_locker": true
            },
            "metadata": null,
            "created": "2024-06-13T11:55:47.828Z",
            "bank": null,
            "surcharge_details": null,
            "requires_cvv": false,
            "last_used_at": "2024-06-13T11:55:47.828Z",
            "default_payment_method_set": true,
            "billing": {
                "address": {
                    "city": "San Fransico",
                    "country": "US",
                    "line1": "1467",
                    "line2": "Harrison Street",
                    "line3": "Harrison Street",
                    "zip": "94122",
                    "state": "California",
                    "first_name": "john",
                    "last_name": "Doe"
                },
                "phone": {
                    "number": "8056594427",
                    "country_code": "+91"
                },
                "email": null
            }
        }
    ],
    "is_guest_customer": 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

…stomer-pm-list

crates/router/src/compatibility/stripe/customers/types.rs

crates/router/src/types/storage/payment_method.rs

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

…stomer-pm-list

vspecky · 2024-06-26T08:26:17Z

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

- .await
- .change_context(errors::StorageError::KVError)
+ // Check this block in review
+ if let Some(token) = parent_payment_method_token {


We can just merge this block with the if is_payment_associated {} block right above right? is_payment_associated and parent_payment_method_token.is_some() should always have the same truth value.

yes, they would have the same truth value, I wasn't sure what the block is supposed to do hence the comment.
I'll merge this with the above block.

vspecky · 2024-06-26T08:27:33Z

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

@@ -293,6 +296,12 @@ pub async fn perform_surcharge_decision_management_for_saved_cards(
 .change_context(ConfigError::InputConstructionError)?;

 for customer_payment_method in customer_payment_method_list.iter_mut() {
+ let payment_token = customer_payment_method


@Sarthak1799 Please get @hrithikesh026's review on this.

hrithikesh026

LGTM

refactor(core): Refactor customer pml for v2

b88e259

Sarthak1799 added A-core Area: Core flows A-payment-methods Area: Payment Methods C-refactor Category: Refactor labels Jun 3, 2024

Sarthak1799 self-assigned this Jun 3, 2024

Sarthak1799 requested review from a team as code owners June 3, 2024 13:32

Sarthak1799 linked an issue Jun 3, 2024 that may be closed by this pull request

Refactor Customers Payment Method List to support Client as well as S2S calls #4805

Open

Sarthak1799 and others added 4 commits June 5, 2024 13:43

Merge branch 'main' of github.com:juspay/hyperswitch into refactor-cu…

f2d7e05

…stomer-pm-list

docs(openapi): re-generate OpenAPI specification

cd89296

fix(payment_methods): Fixed clippy errors

a580b35

fix(payment_methods): Fixed clippy errors

4eae216

vspecky requested changes Jun 10, 2024

View reviewed changes

Sarthak1799 added 2 commits June 10, 2024 16:04

fix(payment_methods): Resolved comments

51c7d12

Merge branch 'main' of github.com:juspay/hyperswitch into refactor-cu…

c71e21a

…stomer-pm-list

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

fix(payment_methods): Fixed errors

bc62440

vspecky requested changes Jun 26, 2024

View reviewed changes

fix(payment_methods): Resolved comments

ddd9fd6

hrithikesh026 approved these changes Jun 26, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor(core): Refactor customer payment method list for v2 #4856

refactor(core): Refactor customer payment method list for v2 #4856

Sarthak1799 commented Jun 3, 2024 •

edited

Loading

vspecky Jun 26, 2024

Sarthak1799 Jun 26, 2024

vspecky Jun 26, 2024

hrithikesh026 left a comment

refactor(core): Refactor customer payment method list for v2 #4856

Are you sure you want to change the base?

refactor(core): Refactor customer payment method list for v2 #4856

Conversation

Sarthak1799 commented Jun 3, 2024 • edited Loading

Type of Change

Description

Additional Changes

Motivation and Context

How did you test it?

Checklist

vspecky Jun 26, 2024

Choose a reason for hiding this comment

Sarthak1799 Jun 26, 2024

Choose a reason for hiding this comment

vspecky Jun 26, 2024

Choose a reason for hiding this comment

hrithikesh026 left a comment

Choose a reason for hiding this comment

Sarthak1799 commented Jun 3, 2024 •

edited

Loading