refactor(bank-transfer): remove billing from banktransfer payment data #4377

swangi-kumari · 2024-04-17T08:00:36Z

Type of Change

Description

This PR includes changes to use payment_method_data.billing.first_name , payment_method_data.last_name and payment_method_data.email instead of payment_method_data.[BankTransfers->BillingDetails] at the connector level. The backwards compatibility is provided.

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 a ACH bank transfer via Sripe

{
    "amount": 800,
    "currency": "USD",
    "confirm": false,
    "capture_method": "automatic",
    "capture_on": "2022-09-10T10:11:12Z",
    "amount_to_capture": 800,
    "customer_id": "poll",
    "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://hs-payments-test.netlify.app/payments",
    "statement_descriptor_name": "Juspay",
    "statement_descriptor_suffix": "Router",
    "metadata": {
        "udf1": "value1",
        "new_customer": "true",
        "login_date": "2019-09-10T10:11:12Z"
    },
    "billing": {
        "address": {
            "line1": "1467",
            "line2": "HarrisonStreet",
            "line3": "HarrisonStreet",
            "city": "SanFransico",
            "state": "California",
            "zip": "94122",
            "country": "US",
            "first_name": "Swangi",
            "last_name": "Kumari"
        },
        "email": "guest@example.com"
    },
    "routing": {
        "type": "single",
        "data": "stripe"
    }
}

Response

{
    "payment_id": "pay_PwoaBj57cd97qTY3fD2i",
    "merchant_id": "postman_merchant_GHAction_d6c78e4f-0f9d-4f4a-9743-6766d9fdf233",
    "status": "requires_payment_method",
    "amount": 800,
    "net_amount": 800,
    "amount_capturable": 0,
    "amount_received": null,
    "connector": null,
    "client_secret": "pay_PwoaBj57cd97qTY3fD2i_secret_tTbRu9L1cHCJW5u9FpPR",
    "created": "2024-04-22T06:12:35.400Z",
    "currency": "USD",
    "customer_id": "poll",
    "customer": {
        "id": "poll",
        "name": "John Doe",
        "email": "guest@example.com",
        "phone": "999999999",
        "phone_country_code": "+65"
    },
    "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": null,
    "billing": {
        "address": {
            "city": "SanFransico",
            "country": "US",
            "line1": "1467",
            "line2": "HarrisonStreet",
            "line3": "HarrisonStreet",
            "zip": "94122",
            "state": "California",
            "first_name": "Swangi",
            "last_name": "Kumari"
        },
        "phone": null,
        "email": "guest@example.com"
    },
    "order_details": null,
    "email": "guest@example.com",
    "name": "John Doe",
    "phone": "999999999",
    "return_url": "https://hs-payments-test.netlify.app/payments",
    "authentication_type": "no_three_ds",
    "statement_descriptor_name": "Juspay",
    "statement_descriptor_suffix": "Router",
    "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": "poll",
        "created_at": 1713766355,
        "expires": 1713769955,
        "secret": "epk_be566b80279a4733b916245f2b312084"
    },
    "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_5XMYHhXjaL8JU6uri9nT",
    "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-04-22T06:27:35.399Z",
    "fingerprint": null,
    "browser_info": null,
    "payment_method_id": null,
    "payment_method_status": null,
    "updated": "2024-04-22T06:12:35.413Z"
}

Confirm Payment

{
    "payment_method": "bank_transfer",
    "payment_method_type": "ach",
    "payment_method_data": {
        "bank_transfer": {
            "ach_bank_transfer": {
                
            }
        }
    },
    "client_secret": "{{client_secret}}"
}

Response:

{
    "payment_id": "pay_PwoaBj57cd97qTY3fD2i",
    "merchant_id": "postman_merchant_GHAction_d6c78e4f-0f9d-4f4a-9743-6766d9fdf233",
    "status": "requires_customer_action",
    "amount": 800,
    "net_amount": 800,
    "amount_capturable": 800,
    "amount_received": null,
    "connector": "stripe",
    "client_secret": "pay_PwoaBj57cd97qTY3fD2i_secret_tTbRu9L1cHCJW5u9FpPR",
    "created": "2024-04-22T06:12:35.400Z",
    "currency": "USD",
    "customer_id": "poll",
    "customer": {
        "id": "poll",
        "name": "John Doe",
        "email": "guest@example.com",
        "phone": "999999999",
        "phone_country_code": "+65"
    },
    "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_y0va7HQFGFLXKHBGI04r",
    "shipping": null,
    "billing": {
        "address": {
            "city": "SanFransico",
            "country": "US",
            "line1": "1467",
            "line2": "HarrisonStreet",
            "line3": "HarrisonStreet",
            "zip": "94122",
            "state": "California",
            "first_name": "Swangi",
            "last_name": "Kumari"
        },
        "phone": null,
        "email": "guest@example.com"
    },
    "order_details": null,
    "email": "guest@example.com",
    "name": "John Doe",
    "phone": "999999999",
    "return_url": "https://hs-payments-test.netlify.app/payments",
    "authentication_type": "no_three_ds",
    "statement_descriptor_name": "Juspay",
    "statement_descriptor_suffix": "Router",
    "next_action": {
        "type": "display_bank_transfer_information",
        "bank_transfer_steps_and_charges_details": {
            "ach_credit_transfer": {
                "account_number": "test_4da19cff5e84",
                "bank_name": "TEST BANK",
                "routing_number": "110000000",
                "swift_code": "TSTEZ122"
            },
            "receiver": {
                "amount_received": 0,
                "amount_charged": 0,
                "amount_remaining": null
            }
        }
    },
    "cancellation_reason": null,
    "error_code": null,
    "error_message": null,
    "unified_code": null,
    "unified_message": null,
    "payment_experience": null,
    "payment_method_type": "ach",
    "connector_label": null,
    "business_country": null,
    "business_label": "default",
    "business_sub_label": null,
    "allowed_payment_method_types": null,
    "ephemeral_key": null,
    "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_5XMYHhXjaL8JU6uri9nT",
    "surcharge_details": null,
    "attempt_count": 1,
    "merchant_decision": null,
    "merchant_connector_id": "mca_I4CDvZU9TtNMzAgdFIZX",
    "incremental_authorization_allowed": null,
    "authorization_count": null,
    "incremental_authorizations": null,
    "external_authentication_details": null,
    "external_3ds_authentication_attempted": false,
    "expires_on": "2024-04-22T06:27:35.399Z",
    "fingerprint": null,
    "browser_info": {
        "language": null,
        "time_zone": null,
        "ip_address": null,
        "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": null,
    "payment_method_status": null,
    "updated": "2024-04-22T06:12:45.594Z"
}

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
I added a CHANGELOG entry if applicable

Narayanbhat166 · 2024-05-07T10:48:01Z

crates/router/src/connector/stripe/transformers.rs

@@ -1252,12 +1252,13 @@ fn get_bank_debit_data(
    }
 }

-fn create_stripe_payment_method(
+fn create_stripe_payment_method<F, Req, Res>(
    payment_method_data: &domain::PaymentMethodData,
    auth_type: enums::AuthenticationType,
    payment_method_token: Option<types::PaymentMethodToken>,
    is_customer_initiated_mandate_payment: Option<bool>,
    billing_address: StripeBillingAddress,


you already have the billing address here right, do we need to use routerdata again here?

Narayanbhat166 · 2024-05-07T10:49:36Z

crates/router/src/connector/stripe/transformers.rs

                    let billing_details = StripeBillingAddress {
-                        email: Some(billing_details.email.clone()),
-                        name: Some(billing_details.name.clone()),
+                        email: item.get_optional_billing_email(),
+                        name: item.get_optional_billing_full_name(),
                        ..Default::default()
                    };


This billing address need not be constructed, since we already have the billing address

Narayanbhat166 · 2024-05-07T10:50:06Z

crates/router/src/connector/stripe/transformers.rs

+                        email: item.get_optional_billing_email(),
+                        name: item.get_optional_billing_full_name(),


In this case too, this need not be constructed

refactor: remove billing from banktransfer payment data

2d07b99

swangi-kumari added the A-connector-compatibility Area: Connector compatibility label Apr 17, 2024

swangi-kumari self-assigned this Apr 17, 2024

hyperswitch-bot bot and others added 4 commits April 17, 2024 08:02

docs(openapi): re-generate OpenAPI specification

c964ced

refactor: stripe bank transfer

f3b4c66

refactor: add postman test for ach bank transfer for stripe connector

5c9aaff

Merge branch 'main' into bank-transfer-billing

e640115

swangi-kumari marked this pull request as ready for review April 22, 2024 10:38

swangi-kumari requested review from a team as code owners April 22, 2024 10:38

swangi-kumari added A-connector-integration Area: Connector integration M-configuration-changes Metadata: This PR involves configuration changes labels Apr 22, 2024

swangi-kumari and others added 6 commits April 24, 2024 16:53

Merge branch 'main' into bank-transfer-billing

857e241

refactor: fix

e1ca4be

docs(openapi): re-generate OpenAPI specification

5d2d332

Merge branch 'main' into bank-transfer-billing

595fa35

refactor: resolve conflicts

2a4d57f

refactor: fix

2a5e367

Narayanbhat166 reviewed May 7, 2024

View reviewed changes

swangi-kumari added 3 commits May 8, 2024 19:38

Merge branch 'main' into bank-transfer-billing

be291bd

refactor: resolve comments

1dc2bb8

refactor: error message

8dd38f6

Narayanbhat166 approved these changes May 10, 2024

View reviewed changes

Sakilmostak approved these changes May 10, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor(bank-transfer): remove billing from banktransfer payment data #4377

refactor(bank-transfer): remove billing from banktransfer payment data #4377

swangi-kumari commented Apr 17, 2024 •

edited

Narayanbhat166 May 7, 2024

Narayanbhat166 May 7, 2024

Narayanbhat166 May 7, 2024

		email: item.get_optional_billing_email(),
		name: item.get_optional_billing_full_name(),

refactor(bank-transfer): remove billing from banktransfer payment data #4377

Are you sure you want to change the base?

refactor(bank-transfer): remove billing from banktransfer payment data #4377

Conversation

swangi-kumari commented Apr 17, 2024 • edited

Type of Change

Description

Additional Changes

Motivation and Context

How did you test it?

Checklist

Narayanbhat166 May 7, 2024

Choose a reason for hiding this comment

Narayanbhat166 May 7, 2024

Choose a reason for hiding this comment

Narayanbhat166 May 7, 2024

Choose a reason for hiding this comment

swangi-kumari commented Apr 17, 2024 •

edited