feat(core): customer_details storage in payment_intent #5007

prajjwalkumar17 · 2024-06-13T20:06:14Z

Type of Change

Description

This change will insure storage of customer_details in our payment_intent table.

if customer_id alone is passed -> Derive customer_details from customer_table and put it in guest_customer_details,
if customer_id is not present -> Put the details in guest_customer_details.
if both are present -> we are ignoring the email, phone etc and deriving them from customer_table and adding to the guest_customer_details field.

Additional Changes

This PR modifies the API contract
This PR modifies the database schema
This PR modifies application configuration/environment variables

The Db Migration:

ALTER TABLE payment_intent ADD COLUMN IF NOT EXISTS customer_details BYTEA DEFAULT NULL;

Motivation and Context

How did you test it?

Testing Scenarios

Payment create request with no `cus_id` and fields name, email, phone, phone country code

Response should be populated like this

"customer_id": null,
"customer": {
    "id": null,
    "name": "light",
    "email": "[email protected]",
    "phone": "9xxxxxxxxx",
    "phone_country_code": "+91"
},

curl --location 'http://127.0.0.1:8080/payments' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'api-key:xxxxx' \
--data-raw '
{
    "amount": 6540,
    "currency": "USD",
    "confirm": false,
    "capture_method": "manual",
    "capture_on": "2022-09-10T10:11:12Z",
    "amount_to_capture": 6540,
    "email": "[email protected]",
    "name": "light",
    "phone": "9xxxxxxxxx",
    "phone_country_code": "+91",
    "description": "Its my first payment request",
    "authentication_type": "no_three_ds",
    "return_url": "https://google.com",
    "setup_future_usage": "on_session",
    "customer_acceptance": {
        "acceptance_type": "offline",
        "accepted_at": "1963-05-03T04:07:52.723Z",
        "online": {
            "ip_address": "127.0.0.1",
            "user_agent": "amet irure esse"
        }
    },
    "statement_descriptor_name": "joseph",
    "statement_descriptor_suffix": "JS",
    "metadata": {
        "udf1": "value1",
        "new_customer": "true",
        "login_date": "2019-09-10T10:11:12Z"
    }
}
'

Payment create request with some random `cus_id`

Response should be populated like this

"customer_id": "id_12343",
"customer": {
    "id": null,
    "name": null,
    "email": null,
    "phone": null,
    "phone_country_code": null
},

curl --location 'http://127.0.0.1:8080/payments' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'api-key:xxxxx' \
--data-raw '
{
    "amount": 6540,
    "currency": "USD",
    "confirm": false,
    "capture_method": "manual",
    "capture_on": "2022-09-10T10:11:12Z",
    "amount_to_capture": 6540,
   "customer_id": "id_12343",
    "description": "Its my first payment request",
    "authentication_type": "no_three_ds",
    "return_url": "https://google.com",
    "setup_future_usage": "on_session",
    "customer_acceptance": {
        "acceptance_type": "offline",
        "accepted_at": "1963-05-03T04:07:52.723Z",
        "online": {
            "ip_address": "127.0.0.1",
            "user_agent": "amet irure esse"
        }
    },
    "statement_descriptor_name": "joseph",
    "statement_descriptor_suffix": "JS",
    "metadata": {
        "udf1": "value1",
        "new_customer": "true",
        "login_date": "2019-09-10T10:11:12Z"
    }
}
'

Payment create request with a created customer's `cus_id`

Response should be populated like this

"customer_id": "id_12343",
"customer": {
    "id": null,
    "name": null,
    "email": null,
    "phone": null,
    "phone_country_code": null
},

curl --location 'http://127.0.0.1:8080/payments' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'api-key:xxxxx' \
--data-raw '
{
    "amount": 6540,
    "currency": "USD",
    "confirm": false,
    "capture_method": "manual",
    "capture_on": "2022-09-10T10:11:12Z",
    "amount_to_capture": 6540,
   "customer_id": "id_12343",
    "description": "Its my first payment request",
    "authentication_type": "no_three_ds",
    "return_url": "https://google.com",
    "setup_future_usage": "on_session",
    "customer_acceptance": {
        "acceptance_type": "offline",
        "accepted_at": "1963-05-03T04:07:52.723Z",
        "online": {
            "ip_address": "127.0.0.1",
            "user_agent": "amet irure esse"
        }
    },
    "statement_descriptor_name": "joseph",
    "statement_descriptor_suffix": "JS",
    "metadata": {
        "udf1": "value1",
        "new_customer": "true",
        "login_date": "2019-09-10T10:11:12Z"
    }
}
'

Payment create request with `cus_id` and all other data

Response should be populated like this

"customer_id": null,
"customer": {
    "id": null,
    "name": "light",
    "email": "[email protected]",
    "phone": "9xxxxxxxxx",
    "phone_country_code": "+91"
},

curl --location 'http://127.0.0.1:8080/payments' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'api-key:xxxxx' \
--data-raw '
{
    "amount": 6540,
    "currency": "USD",
    "confirm": false,
    "capture_method": "manual",
    "capture_on": "2022-09-10T10:11:12Z",
    "amount_to_capture": 6540,
   "customer_id": "id_12343",
     "name": "light",
     "email": "[email protected]",
     "phone": "9xxxxxxxxx",
      "phone_country_code": "+91",
    "description": "Its my first payment request",
    "authentication_type": "no_three_ds",
    "return_url": "https://google.com",
    "setup_future_usage": "on_session",
    "customer_acceptance": {
        "acceptance_type": "offline",
        "accepted_at": "1963-05-03T04:07:52.723Z",
        "online": {
            "ip_address": "127.0.0.1",
            "user_agent": "amet irure esse"
        }
    },
    "statement_descriptor_name": "joseph",
    "statement_descriptor_suffix": "JS",
    "metadata": {
        "udf1": "value1",
        "new_customer": "true",
        "login_date": "2019-09-10T10:11:12Z"
    }
}
'

Payment create request with name and payment confirm with email and phone

Response should be populated like this after confirm request

"customer_id": null,
"customer": {
    "id": null,
    "name": "light",
    "email": "[email protected]",
    "phone": "9xxxxxxxxx",
    "phone_country_code": null
},

curl --location 'http://127.0.0.1:8080/payments' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'api-key:xxxxx' \
--data-raw '
{
    "amount": 6540,
    "currency": "USD",
    "confirm": false,
    "capture_method": "manual",
    "capture_on": "2022-09-10T10:11:12Z",
    "amount_to_capture": 6540,
     "name": "light",
    "description": "Its my first payment request",
    "authentication_type": "no_three_ds",
    "return_url": "https://google.com",
    "setup_future_usage": "on_session",
    "customer_acceptance": {
        "acceptance_type": "offline",
        "accepted_at": "1963-05-03T04:07:52.723Z",
        "online": {
            "ip_address": "127.0.0.1",
            "user_agent": "amet irure esse"
        }
    },
    "statement_descriptor_name": "joseph",
    "statement_descriptor_suffix": "JS",
    "metadata": {
        "udf1": "value1",
        "new_customer": "true",
        "login_date": "2019-09-10T10:11:12Z"
    }
}
'

curl --location 'http://127.0.0.1:8080/payments/pay_7m0meCohmJxQJ4RzzlTm/confirm' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'api-key:xxxxxxxxxxxx' \
--data-raw '{
    "email": "[email protected]",
    "phone": "9xxxxxxxxx",
    "payment_method": "card",
    "payment_method_data": {
        "card": {
            "card_number": "4000003920000003",
            "card_exp_month": "10",
            "card_exp_year": "25",
            "card_cvc": "123"
        }
    } 
}'

Payment create request with name and payment update with email and phone

Response should be populated like this after update request

"customer_id": null,
"customer": {
    "id": null,
    "name": "light",
    "email": "[email protected]",
    "phone": "9xxxxxxxxx",
    "phone_country_code": null
},

curl --location 'http://127.0.0.1:8080/payments' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'api-key:xxxxx' \
--data-raw '
{
    "amount": 6540,
    "currency": "USD",
    "confirm": false,
    "capture_method": "manual",
    "capture_on": "2022-09-10T10:11:12Z",
    "amount_to_capture": 6540,
     "name": "light",
    "description": "Its my first payment request",
    "authentication_type": "no_three_ds",
    "return_url": "https://google.com",
    "setup_future_usage": "on_session",
    "customer_acceptance": {
        "acceptance_type": "offline",
        "accepted_at": "1963-05-03T04:07:52.723Z",
        "online": {
            "ip_address": "127.0.0.1",
            "user_agent": "amet irure esse"
        }
    },
    "statement_descriptor_name": "joseph",
    "statement_descriptor_suffix": "JS",
    "metadata": {
        "udf1": "value1",
        "new_customer": "true",
        "login_date": "2019-09-10T10:11:12Z"
    }
}
'

curl --location 'http://127.0.0.1:8080/payments/pay_7m0meCohmJxQJ4RzzlTm' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'api-key: dev_Sz1d4HlpPQ71WmZksJ7NghSNmy64WGRkAFy0vhOmTA5QrDUVYNRb43ZSFySsz5KX' \
--data-raw '{
    "payment_method": "card",
    "payment_method_data": {
        "card": {
            "card_number": "4242424242424242",
            "card_exp_month": "10",
            "card_exp_year": "2035",
            "card_holder_name": "John Doe",
            "card_cvc": "123"
        }
    },
    "email": "[email protected]",   
    "phone": "9xxxxxxxxx"
}'

Payment create request with id, name and payment update with email and phone

Response should be populated like this after update request

"customer_id": "id_12343",
"customer": {
    "id": "id_12343",
    "name": "light",
    "email": "[email protected]",
    "phone": "9xxxxxxxxx",
    "phone_country_code": null
},

curl --location 'http://127.0.0.1:8080/payments' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'api-key:xxxxx' \
--data-raw '
{
    "amount": 6540,
    "currency": "USD",
    "confirm": false,
    "capture_method": "manual",
    "capture_on": "2022-09-10T10:11:12Z",
    "amount_to_capture": 6540,
    "customer_id": "id_12343",
     "name": "light",
    "description": "Its my first payment request",
    "authentication_type": "no_three_ds",
    "return_url": "https://google.com",
    "setup_future_usage": "on_session",
    "customer_acceptance": {
        "acceptance_type": "offline",
        "accepted_at": "1963-05-03T04:07:52.723Z",
        "online": {
            "ip_address": "127.0.0.1",
            "user_agent": "amet irure esse"
        }
    },
    "statement_descriptor_name": "joseph",
    "statement_descriptor_suffix": "JS",
    "metadata": {
        "udf1": "value1",
        "new_customer": "true",
        "login_date": "2019-09-10T10:11:12Z"
    }
}
'

curl --location 'http://127.0.0.1:8080/payments/pay_7m0meCohmJxQJ4RzzlTm' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'api-key: dev_Sz1d4HlpPQ71WmZksJ7NghSNmy64WGRkAFy0vhOmTA5QrDUVYNRb43ZSFySsz5KX' \
--data-raw '{
    "payment_method": "card",
    "payment_method_data": {
        "card": {
            "card_number": "4242424242424242",
            "card_exp_month": "10",
            "card_exp_year": "2035",
            "card_holder_name": "John Doe",
            "card_cvc": "123"
        }
    },
    "email": "[email protected]",   
    "phone": "9xxxxxxxxx"
}'

MCA of BOA, email in Payment create request and then List Payment Method with client secret

Response should be populated like this after update request

{
"redirect_url": "https://google.com/success",
"currency": "USD",
"payment_methods": [
{
"payment_method": "wallet",
"payment_method_types": [
{
"payment_method_type": "google_pay",
"payment_experience": [
{
"payment_experience_type": "redirect_to_url",
"eligible_connectors": [
"bankofamerica"
]
}
],
"card_networks": null,
"bank_names": null,
"bank_debits": null,
"bank_transfers": null,
"required_fields": {
"billing.address.zip": {
"required_field": "payment_method_data.billing.address.zip",
"display_name": "zip",
"field_type": "user_address_pincode",
"value": "94122"
},
"email": {
"required_field": "email",
"display_name": "email",
"field_type": "user_email_address",
"value": "[email protected]"
},
........

curl --location 'http://127.0.0.1:8080/payments' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'api-key:xxxxx' \
--data-raw '
{
    "amount": 6540,
    "currency": "USD",
    "confirm": false,
    "capture_method": "manual",
    "capture_on": "2022-09-10T10:11:12Z",
    "amount_to_capture": 6540,
    "email": "[email protected]",
    "description": "Its my first payment request",
    "authentication_type": "no_three_ds",
    "return_url": "https://google.com",
    "setup_future_usage": "on_session",
    "customer_acceptance": {
        "acceptance_type": "offline",
        "accepted_at": "1963-05-03T04:07:52.723Z",
        "online": {
            "ip_address": "127.0.0.1",
            "user_agent": "amet irure esse"
        }
    },
    "statement_descriptor_name": "joseph",
    "statement_descriptor_suffix": "JS",
    "metadata": {
        "udf1": "value1",
        "new_customer": "true",
        "login_date": "2019-09-10T10:11:12Z"
    }
}
'

curl --location 'http://127.0.0.1:8080/account/payment_methods?client_secret=pay_7m0meCohmJxQJ4RzzlTm_secret_ybvSTH07m5MGTGQDHA3R' \
--header 'Accept: application/json' \
--header 'api-key: xxxxxxxxx' \
--data ''

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

…er details

crates/diesel_models/src/payment_intent.rs

crates/diesel_models/src/schema.rs

crates/router/src/core/payments/operations/payment_create.rs

Narayanbhat166

Try if we can update the customer details in payment intent only if necessary rather then updating all the time. This is not critical for now and can be taken up in a later PR as well

crates/router/src/core/payments/operations/payment_update.rs

crates/router/src/core/payments/operations/payment_confirm.rs

crates/router/src/core/payments/operations/payment_create.rs

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

…d payment_confirm flows

…ait func get_or_update_customer

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

Narayanbhat166 · 2024-06-27T12:03:42Z

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

+    // For the case when we don't have Customer data directly stored in Payment intent
+    let customer_table_response: Option<CustomerDetailsResponse> =
+        customer.as_ref().map(ForeignInto::foreign_into);
+
+    // If we have customer data in Payment Intent, We are populating the Retrieve response from the
+    // same
+    let customer_details_response =
+        if let Some(customer_details_raw) = payment_intent.customer_details.clone() {
+            let customer_details_encrypted =
+                serde_json::from_value::<CustomerData>(customer_details_raw.into_inner().expose());
+            if let Ok(customer_details_encrypted_data) = customer_details_encrypted {


you can move this to a function

…t/guest_customer_details

…ay/hyperswitch into feat/guest_customer_details

apoorvdixit88

Looks fine for Dashboard specific changes

…ror-handling-in-cypress * 'main' of github.com:juspay/hyperswitch: Docs: Api reference docs update for Payments - Create (#4955) feat(cypress): add iatapay connector (#5093) chore: fix ui-test configs (#5152) chore(cards): add configuration option to change the decryption scheme locker (#5140) refactor(hyperswitch_constraint_graph): Removal of lifetime from the Constraint Graph framework (#5132) feat(core): customer_details storage in payment_intent (#5007) fix(connector): [ADYEN] send `browser_info` for all the card and googlepay payments (#5153) fix(users): clear cookie and alter parsing for sso (#5147) refactor(connector): added amount framework to paypal, payouts and routing (#4865) chore(version): 2024.06.28.0 chore(postman): update Postman collection files chore: use generic phone numbers instead (#5142)

Narayanbhat166 · 2024-07-06T09:12:58Z

we should also consider the guest customer details that is provided as a part of the customer object in payments request.

hyperswitch/crates/api_models/src/payments.rs

Line 307 in f68cde7

pub customer: Option<CustomerDetails>,

The customer_id field is mandatory here, this should be made optional and allowed to pass guest customer information without the customer id field.

Narayanbhat166 and others added 11 commits June 4, 2024 06:46

refactor: remove id column from intent and attempt

98715e8

feat: impl behaviour for payment_intent insert

c4f0470

implement encryption for find and update

b4039d9

refactor: remove datamodel trait for pi

7abbf36

Merge branch 'main' into storage_changes_for_v2

c1e8105

chore: run formatter

42da49b

chore: cargo clippy

7a16a80

Merge branch 'main' into storage_changes_for_v2

011e8b0

chore: cargo clippy

1cb2485

chore: address PR comments

b049676

feat: adds customer_details coloumn in payment_intent to store custom…

7ccbe16

…er details

prajjwalkumar17 added A-core Area: Core flows M-database-changes Metadata: This PR involves database schema changes labels Jun 13, 2024

prajjwalkumar17 added this to the May 2024 Release milestone Jun 13, 2024

prajjwalkumar17 self-assigned this Jun 13, 2024

prajjwalkumar17 requested review from a team as code owners June 13, 2024 20:06

chore: addresses clippy lints

d7a4083

prajjwalkumar17 linked an issue Jun 14, 2024 that may be closed by this pull request

[FEATURE] Inclusion of customer details in payment_intent column #5008

Closed

2 tasks

prajjwalkumar17 added 3 commits June 14, 2024 10:18

Merge branch 'storage_changes_for_v2' into feat/guest_customer_details

24da808

Merge branch 'main' into storage_changes_for_v2

b238ea7

Merge branch 'storage_changes_for_v2' into feat/guest_customer_details

b76c4f5

SanchithHegde modified the milestones: May 2024 Release, June 2024 Release Jun 14, 2024

chore: addressing postman tests

0dc0bb0

Narayanbhat166 reviewed Jun 18, 2024

View reviewed changes

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

Narayanbhat166 requested changes Jun 18, 2024

View reviewed changes

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

crates/router/src/core/payments/operations/payment_create.rs Outdated Show resolved Hide resolved

Base automatically changed from storage_changes_for_v2 to main June 19, 2024 11:55

prajjwalkumar17 requested a review from a team as a code owner June 19, 2024 11:55

Narayanbhat166 reviewed Jun 25, 2024

View reviewed changes

prajjwalkumar17 and others added 3 commits June 25, 2024 14:47

chore: tryfrom implementation

b9240bf

chore: run formatter

592a9a2

chore: addition for updation of customer details in payment_update an…

920fffb

…d payment_confirm flows

prajjwalkumar17 requested a review from Narayanbhat166 June 26, 2024 12:23

chore: run formatter

0c5e9bb

prajjwalkumar17 requested a review from apoorvdixit88 June 26, 2024 14:03

prajjwalkumar17 and others added 4 commits June 27, 2024 15:13

chore: added the customer_details update function to a centralized tr…

93b6e3c

…ait func get_or_update_customer

chore: beautification of code

88e362f

chore: run formatter

fb9a2f2

docs(openapi): re-generate OpenAPI specification

a0bafcc

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

Narayanbhat166 reviewed Jun 27, 2024

View reviewed changes

crates/router/src/core/payments/helpers.rs Outdated Show resolved Hide resolved

Narayanbhat166 reviewed Jun 27, 2024

View reviewed changes

Narayanbhat166 previously approved these changes Jun 27, 2024

View reviewed changes

prajjwalkumar17 added 4 commits June 27, 2024 18:28

Merge branch 'main' of https://github.com/juspay/hyperswitch into fea…

7956387

…t/guest_customer_details

Merge branch 'main' into feat/guest_customer_details

731e9d7

Merge branch 'feat/guest_customer_details' of https://github.com/jusp…

7ce4789

…ay/hyperswitch into feat/guest_customer_details

chore: addition of fallback for the customer data

dbde6ec

prajjwalkumar17 dismissed Narayanbhat166’s stale review via dbde6ec June 27, 2024 13:07

prajjwalkumar17 requested a review from Narayanbhat166 June 27, 2024 13:08

chore: run formatter

19c17b4

Narayanbhat166 approved these changes Jun 27, 2024

View reviewed changes

apoorvdixit88 approved these changes Jun 27, 2024

View reviewed changes

Gnanasundari24 added this pull request to the merge queue Jun 28, 2024

Merged via the queue into main with commit bb9a971 Jun 28, 2024
11 checks passed

Gnanasundari24 deleted the feat/guest_customer_details branch June 28, 2024 09:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(core): customer_details storage in payment_intent #5007

feat(core): customer_details storage in payment_intent #5007

prajjwalkumar17 commented Jun 13, 2024 •

edited

Loading

Narayanbhat166 left a comment

Narayanbhat166 Jun 27, 2024

apoorvdixit88 left a comment

Narayanbhat166 commented Jul 6, 2024

feat(core): customer_details storage in payment_intent #5007

feat(core): customer_details storage in payment_intent #5007

Conversation

prajjwalkumar17 commented Jun 13, 2024 • edited Loading

Type of Change

Description

Additional Changes

Motivation and Context

How did you test it?

Testing Scenarios

Payment create request with no cus_id and fields name, email, phone, phone country code

Payment create request with some random cus_id

Payment create request with a created customer's cus_id

Payment create request with cus_id and all other data

Payment create request with name and payment confirm with email and phone

Payment create request with name and payment update with email and phone

Payment create request with id, name and payment update with email and phone

MCA of BOA, email in Payment create request and then List Payment Method with client secret

Checklist

Narayanbhat166 left a comment

Choose a reason for hiding this comment

Narayanbhat166 Jun 27, 2024

Choose a reason for hiding this comment

apoorvdixit88 left a comment

Choose a reason for hiding this comment

Narayanbhat166 commented Jul 6, 2024

prajjwalkumar17 commented Jun 13, 2024 •

edited

Loading

Payment create request with no `cus_id` and fields name, email, phone, phone country code

Payment create request with some random `cus_id`

Payment create request with a created customer's `cus_id`

Payment create request with `cus_id` and all other data