feat(core): Added integrity framework for Authorize and Sync flow with connector as Stripe #5109
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…m/juspay/hyperswitch into change_core_amount_to_domain_type
…m/juspay/hyperswitch into change_core_amount_to_domain_type
…m/juspay/hyperswitch into change_core_amount_to_domain_type
…m/juspay/hyperswitch into change_core_amount_to_domain_type
…m/juspay/hyperswitch into change_core_amount_to_domain_type
hyperswitch-bot
bot
removed
the
M-api-contract-changes
jarnura
previously approved these changes
Jul 2, 2024
sahkal
requested review from
Narayanbhat166,
a team and
SamraatBansal
and removed request for
a team
crates/common_utils/src/errors.rs
Outdated
| @@ -69,6 +69,14 @@ pub enum ValidationError { | |||
| InvalidValue { message: String }, | |||
| } | |||
|
|
|||
| /// Integrity check errors. | |||
| #[allow(missing_docs)] // Only to prevent warnings about struct fields not being documented | |||
There was a problem hiding this comment.
why do you not want to provide docs to fields?
| status: updated_attempt_status, | ||
| connector: None, | ||
| connector_transaction_id: connector_transaction_id.clone(), | ||
| authentication_type: None, |
There was a problem hiding this comment.
why is this update made as None?
There was a problem hiding this comment.
had removed it while resolving merge conflicts my bad! Adding it back
Narayanbhat166
approved these changes
Jul 4, 2024
jarnura
approved these changes
Jul 4, 2024
SamraatBansal
approved these changes
Jul 4, 2024
ThisIsMani
approved these changes
Jul 4, 2024
pixincreate
added a commit
that referenced
this pull request
Jul 5, 2024
…ify-cypress * 'main' of github.com:juspay/hyperswitch: (22 commits) refactor: Adding millisecond to Kafka timestamp (#5202) chore(version): 2024.07.05.0 fix(user_auth_method): make id option in auth select (#5213) Docs: Updated API - ref for payments (#5172) feat(core): add merchant order reference id (#5197) feat(analytics): Refund status serialization issue for ckh analytics (#5199) fix(router): `override setup_future_usage` filed to on_session based on merchant config (#5195) feat(cypress): make tests forcefully skippable (#5176) feat(core): Added integrity framework for Authorize and Sync flow with connector as Stripe (#5109) ci(cypress): Update card number for adyen and status for paypal (#5192) refactor(cypress): error handling and add sync refunds in places where missing (#5128) feat(analytics): FRM Analytics (#4880) chore(version): 2024.07.04.0 feat(pm_auth): Added balance check for PM auth bank account (#5054) refactor(payment_methods): add appropriate missing logs (#5190) refactor(migrations): add commands to make file to run migrations for api v2 (#5169) chore(version): 2024.07.03.0 fix(event): Updated the ApiEventMetric (#5126) feat(router): add refunds manual-update api (#5094) refactor(payment_link): logs payment links logs coverage (#4918) ...
SanchithHegde
removed
the
S-waiting-on-review
Narayanbhat166
added a commit
that referenced
this pull request
Jul 8, 2024
…h connector as Stripe (#5109) Co-authored-by: hyperswitch-bot[bot] <148525504+hyperswitch-bot[bot]@users.noreply.github.com> Co-authored-by: Hrithikesh <[email protected]> Co-authored-by: Narayan Bhat <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Type of Change
Description
With this PR, we are implementing connector integrity checks for the authorize and sync flow. After receiving a response from the connector, we will validate on our end whether the data sent to the connector matches the data received from their end.
If the validation fails we will mark the transaction as processing so that if the connector fixes the response in sync, the status will move to respective terminal state.
At api level the response will be 5xx with connector_transaction_id in response for merchant to reference in case if integrity failures for both sync and authorize.
How did you test it?
Since its a blackbox scenario, we cannot test until and unless there is a error data from connectors end!
Local testing scenario
Scenario[1] Where Connector send wrong currency in both authorize and sync flow
Payments Create
#####Payments Sync
with force_sync as False
response
{ "payment_id": "pay_x99f0Q4DO2drPrt3QZX0", "merchant_id": "merchant_1718267057", "status": "processing", "amount": 250, "net_amount": 250, "amount_capturable": 250, "amount_received": 250, "connector": "stripe", "client_secret": "pay_x99f0Q4DO2drPrt3QZX0_secret_0A6rPzdRv1pvBLdZ61GA", "created": "2024-06-24T11:03:39.655Z", "currency": "USD", "customer_id": "StripeCustomer123", "customer": { "id": "StripeCustomer123", "name": "John Doe", "email": "[email protected]", "phone": "999999999", "phone_country_code": "+65" }, "description": "Please Pay for your XYZ", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": "off_session", "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "card", "payment_method_data": { "card": { "last4": "4242", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "424242", "card_extended_bin": null, "card_exp_month": "08", "card_exp_year": "25", "card_holder_name": "joseph Doe", "payment_checks": null, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": null, "billing": 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": "Integrity Check Failed! Value mismatched for fields currency", "unified_code": null, "unified_message": null, "payment_experience": null, "payment_method_type": "credit", "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_3PVAgTCuXDMKrYZe0L9s7DNy", "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_rhbVuxclv1iy3M2pZkkI", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_sKlZxW37AYQNFv4Z4LGy", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2024-06-24T11:18:39.655Z", "fingerprint": null, "browser_info": { "language": "nl-NL", "time_zone": 0, "ip_address": "127.0.0.1", "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", "color_depth": 24, "java_enabled": true, "screen_width": 1536, "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8", "screen_height": 723, "java_script_enabled": true }, "payment_method_id": null, "payment_method_status": null, "updated": "2024-06-24T11:03:42.546Z", "charges": null, "frm_metadata": null }we should get error message as integrity check failed with status as processing.
with force_sync as true
Scenario[2] Where Connector send wrong currency in both authorize but fixes the same sync flow
#####Payments Create
Payments Sync
with force_sync true
Response
{ "payment_id": "pay_ExsGuWmhYUqDrkkAJnVg", "merchant_id": "merchant_1718267057", "status": "succeeded", "amount": 250, "net_amount": 250, "amount_capturable": 0, "amount_received": 250, "connector": "stripe", "client_secret": "pay_ExsGuWmhYUqDrkkAJnVg_secret_upTfAFa5sOSTcGTMKKIO", "created": "2024-06-24T11:11:45.150Z", "currency": "USD", "customer_id": "StripeCustomer123", "customer": { "id": "StripeCustomer123", "name": "John Doe", "email": "[email protected]", "phone": "999999999", "phone_country_code": "+65" }, "description": "Please Pay for your XYZ", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": "off_session", "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "card", "payment_method_data": { "card": { "last4": "4242", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "424242", "card_extended_bin": null, "card_exp_month": "08", "card_exp_year": "25", "card_holder_name": "joseph Doe", "payment_checks": { "address_line1_check": null, "address_postal_code_check": null, "cvc_check": "pass" }, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": null, "billing": 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": "credit", "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_3PVAoICuXDMKrYZe1GvfbMYa", "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_3PVAoICuXDMKrYZe1GvfbMYa", "payment_link": null, "profile_id": "pro_rhbVuxclv1iy3M2pZkkI", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_sKlZxW37AYQNFv4Z4LGy", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2024-06-24T11:26:45.150Z", "fingerprint": null, "browser_info": { "language": "nl-NL", "time_zone": 0, "ip_address": "127.0.0.1", "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", "color_depth": 24, "java_enabled": true, "screen_width": 1536, "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8", "screen_height": 723, "java_script_enabled": true }, "payment_method_id": null, "payment_method_status": null, "updated": "2024-06-24T11:12:40.350Z", "charges": null, "frm_metadata": null }Status should move to succeeded!
Scenario[3] Where connector sends correct data in both authorize and sync flow
#####Payments Create
Response
{ "payment_id": "pay_HD0mGNbh3sY4SDzEJsPv", "merchant_id": "merchant_1718267057", "status": "succeeded", "amount": 250, "net_amount": 250, "amount_capturable": 0, "amount_received": 250, "connector": "stripe", "client_secret": "pay_HD0mGNbh3sY4SDzEJsPv_secret_EpmbV93ry8SiEMGIjCDF", "created": "2024-06-24T11:16:26.868Z", "currency": "USD", "customer_id": "StripeCustomer123", "customer": { "id": "StripeCustomer123", "name": "John Doe", "email": "[email protected]", "phone": "999999999", "phone_country_code": "+65" }, "description": "Please Pay for your XYZ", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": "off_session", "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "card", "payment_method_data": { "card": { "last4": "4242", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "424242", "card_extended_bin": null, "card_exp_month": "08", "card_exp_year": "25", "card_holder_name": "joseph Doe", "payment_checks": { "address_line1_check": null, "address_postal_code_check": null, "cvc_check": "pass" }, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": null, "billing": 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": "credit", "connector_label": null, "business_country": null, "business_label": "default", "business_sub_label": null, "allowed_payment_method_types": null, "ephemeral_key": { "customer_id": "StripeCustomer123", "created_at": 1719227786, "expires": 1719231386, "secret": "epk_3f099e2eb5f74a1db265f81af40082b3" }, "manual_retry_allowed": false, "connector_transaction_id": "pi_3PVAsqCuXDMKrYZe1FwwRbez", "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_3PVAsqCuXDMKrYZe1FwwRbez", "payment_link": null, "profile_id": "pro_rhbVuxclv1iy3M2pZkkI", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_sKlZxW37AYQNFv4Z4LGy", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2024-06-24T11:31:26.868Z", "fingerprint": null, "browser_info": { "language": "nl-NL", "time_zone": 0, "ip_address": "127.0.0.1", "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", "color_depth": 24, "java_enabled": true, "screen_width": 1536, "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8", "screen_height": 723, "java_script_enabled": true }, "payment_method_id": null, "payment_method_status": null, "updated": "2024-06-24T11:16:29.856Z", "charges": null, "frm_metadata": null }#####Payments Sync
Response
{ "payment_id": "pay_HD0mGNbh3sY4SDzEJsPv", "merchant_id": "merchant_1718267057", "status": "succeeded", "amount": 250, "net_amount": 250, "amount_capturable": 0, "amount_received": 250, "connector": "stripe", "client_secret": "pay_HD0mGNbh3sY4SDzEJsPv_secret_EpmbV93ry8SiEMGIjCDF", "created": "2024-06-24T11:16:26.868Z", "currency": "USD", "customer_id": "StripeCustomer123", "customer": { "id": "StripeCustomer123", "name": "John Doe", "email": "[email protected]", "phone": "999999999", "phone_country_code": "+65" }, "description": "Please Pay for your XYZ", "refunds": null, "disputes": null, "mandate_id": null, "mandate_data": null, "setup_future_usage": "off_session", "off_session": null, "capture_on": null, "capture_method": "automatic", "payment_method": "card", "payment_method_data": { "card": { "last4": "4242", "card_type": null, "card_network": null, "card_issuer": null, "card_issuing_country": null, "card_isin": "424242", "card_extended_bin": null, "card_exp_month": "08", "card_exp_year": "25", "card_holder_name": "joseph Doe", "payment_checks": { "cvc_check": "pass", "address_line1_check": null, "address_postal_code_check": null }, "authentication_data": null }, "billing": null }, "payment_token": null, "shipping": null, "billing": 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": "credit", "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_3PVAsqCuXDMKrYZe1FwwRbez", "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_3PVAsqCuXDMKrYZe1FwwRbez", "payment_link": null, "profile_id": "pro_rhbVuxclv1iy3M2pZkkI", "surcharge_details": null, "attempt_count": 1, "merchant_decision": null, "merchant_connector_id": "mca_sKlZxW37AYQNFv4Z4LGy", "incremental_authorization_allowed": null, "authorization_count": null, "incremental_authorizations": null, "external_authentication_details": null, "external_3ds_authentication_attempted": false, "expires_on": "2024-06-24T11:31:26.868Z", "fingerprint": null, "browser_info": { "language": "nl-NL", "time_zone": 0, "ip_address": "127.0.0.1", "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", "color_depth": 24, "java_enabled": true, "screen_width": 1536, "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8", "screen_height": 723, "java_script_enabled": true }, "payment_method_id": null, "payment_method_status": null, "updated": "2024-06-24T11:16:29.856Z", "charges": null, "frm_metadata": null }Checklist
cargo +nightly fmt --allcargo clippy