feat(charges): integrated PaymentSync for stripe connect #4771

kashif-m · 2024-05-27T06:59:12Z

Type of Change

Description

This PR adds the charges sync capability (for PaymentSync and RefundSync) for Stripe connector.

Additional Changes

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

Motivation and Context

PaymentSync operation makes a get payment intent call to the underlying connector for fetching the payment details. This is used in HyperSwitch for updating the details of the payment stored at HyperSwitch's end. Capability for fetching charged payments for Stripe needs to be added in case a charged payment was made. This was earlier missed in this PR - #4628

How did you test it?

1. Create a 3DS txn

cURL

curl --location 'http://localhost:8080/payments' \
    --header 'Content-Type: application/json' \
    --header 'Accept: application/json' \
    --header 'api-key: dev_fU9hJ1iOCFFN1e5Ao0ikNCnh7GLlNd5GCtW7NHBP1vylXVcKax4BZhelhWCiOOFO' \
    --data '{
        "amount": 200,
        "profile_id": "pro_UyFz4kRsR7cF07w3ABgy",
        "currency": "USD",
        "confirm": true,
        "capture_method": "automatic",
        "amount_to_capture": 200,
        "customer_id": "cust_no_pm",
        "authentication_type": "three_ds",
        "return_url": "https://google.com",
        "name": "John Doe",
        "phone": "999999999",
        "phone_country_code": "+65",
        "description": "Its my first payment request",
        "payment_method": "card",
        "payment_method_type": "debit",
        "payment_method_data": {
            "card": {
                "card_number": "4242424242424242",
                "card_exp_month": "12",
                "card_exp_year": "34",
                "card_holder_name": "joseph Doe",
                "card_cvc": "123"
            }
        },
        "billing": {
            "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": "8056594427",
                "country_code": "+91"
            }
        },
        "charges": {
            "charge_type": "direct",
            "fees": 100,
            "transfer_account_id": "acct_1PDftAIhl7EEkW0O"
        }
    }'

Response

{
    "payment_id": "pay_WuYe8INincbthQtTnOdF",
    "merchant_id": "merchant_1726221242",
    "status": "requires_customer_action",
    "amount": 200,
    "net_amount": 200,
    "amount_capturable": 200,
    "amount_received": 0,
    "connector": "stripe",
    "client_secret": "pay_WuYe8INincbthQtTnOdF_secret_QCiiNSTdanW4BD6lVJ0q",
    "created": "2024-09-13T10:03:35.978Z",
    "currency": "USD",
    "customer_id": "cust_no_pm",
    "customer": {
        "id": "cust_no_pm",
        "name": "John Doe",
        "email": null,
        "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": "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": "12",
            "card_exp_year": "34",
            "card_holder_name": null,
            "payment_checks": null,
            "authentication_data": null
        },
        "billing": null
    },
    "payment_token": null,
    "shipping": null,
    "billing": {
        "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": "8056594427",
            "country_code": "+91"
        },
        "email": null
    },
    "order_details": null,
    "email": null,
    "name": "John Doe",
    "phone": "999999999",
    "return_url": "https://google.com/",
    "authentication_type": "three_ds",
    "statement_descriptor_name": null,
    "statement_descriptor_suffix": null,
    "next_action": {
        "type": "redirect_to_url",
        "redirect_to_url": "http://localhost:8080/payments/redirect/pay_WuYe8INincbthQtTnOdF/merchant_1726221242/pay_WuYe8INincbthQtTnOdF_1"
    },
    "cancellation_reason": null,
    "error_code": null,
    "error_message": null,
    "unified_code": null,
    "unified_message": null,
    "payment_experience": null,
    "payment_method_type": "debit",
    "connector_label": null,
    "business_country": null,
    "business_label": "default",
    "business_sub_label": null,
    "allowed_payment_method_types": null,
    "ephemeral_key": {
        "customer_id": "cust_no_pm",
        "created_at": 1726221815,
        "expires": 1726225415,
        "secret": "epk_f0aafd3930044592b00937e2ea564e8f"
    },
    "manual_retry_allowed": null,
    "connector_transaction_id": "pi_3PyWLkIhl7EEkW0O2rDLaqN6",
    "frm_message": null,
    "metadata": null,
    "connector_metadata": null,
    "feature_metadata": null,
    "reference_id": "pi_3PyWLkIhl7EEkW0O2rDLaqN6",
    "payment_link": null,
    "profile_id": "pro_UyFz4kRsR7cF07w3ABgy",
    "surcharge_details": null,
    "attempt_count": 1,
    "merchant_decision": null,
    "merchant_connector_id": "mca_hUygDAQSZcNuwsf0gy7O",
    "incremental_authorization_allowed": null,
    "authorization_count": null,
    "incremental_authorizations": null,
    "external_authentication_details": null,
    "external_3ds_authentication_attempted": false,
    "expires_on": "2024-09-13T10:18:35.978Z",
    "fingerprint": null,
    "browser_info": null,
    "payment_method_id": null,
    "payment_method_status": null,
    "updated": "2024-09-13T10:03:36.837Z",
    "charges": {
        "charge_id": null,
        "charge_type": "direct",
        "application_fees": 100,
        "transfer_account_id": "acct_1PDftAIhl7EEkW0O"
    },
    "frm_metadata": null,
    "merchant_order_reference_id": null,
    "order_tax_amount": null
}

Open the 3DS link and complete the txn

3. Fetch payment details

cURL

curl --location 'http://localhost:8080/payments/pay_WuYe8INincbthQtTnOdF' \
--header 'Accept: application/json' \
--header 'api-key: dev_fU9hJ1iOCFFN1e5Ao0ikNCnh7GLlNd5GCtW7NHBP1vylXVcKax4BZhelhWCiOOFO'

Response

{
    "payment_id": "pay_WuYe8INincbthQtTnOdF",
    "merchant_id": "merchant_1726221242",
    "status": "succeeded",
    "amount": 200,
    "net_amount": 200,
    "amount_capturable": 0,
    "amount_received": 200,
    "connector": "stripe",
    "client_secret": "pay_WuYe8INincbthQtTnOdF_secret_QCiiNSTdanW4BD6lVJ0q",
    "created": "2024-09-13T10:03:35.978Z",
    "currency": "USD",
    "customer_id": "cust_no_pm",
    "customer": {
        "id": "cust_no_pm",
        "name": "John Doe",
        "email": null,
        "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": "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": "12",
            "card_exp_year": "34",
            "card_holder_name": null,
            "payment_checks": {
                "cvc_check": "pass",
                "address_line1_check": "pass",
                "address_postal_code_check": "pass"
            },
            "authentication_data": {
                "result": "attempt_acknowledged",
                "version": "2.1.0",
                "result_reason": null,
                "transaction_id": "aef2622a-773b-4982-9fa0-8463cb92a48b",
                "authentication_flow": null,
                "exemption_indicator": null,
                "electronic_commerce_indicator": "06"
            }
        },
        "billing": null
    },
    "payment_token": null,
    "shipping": null,
    "billing": {
        "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": "8056594427",
            "country_code": "+91"
        },
        "email": null
    },
    "order_details": null,
    "email": null,
    "name": "John Doe",
    "phone": "999999999",
    "return_url": "https://google.com/",
    "authentication_type": "three_ds",
    "statement_descriptor_name": null,
    "statement_descriptor_suffix": null,
    "next_action": null,
    "cancellation_reason": null,
    "error_code": null,
    "error_message": null,
    "unified_code": null,
    "unified_message": null,
    "payment_experience": null,
    "payment_method_type": "debit",
    "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_3PyWLkIhl7EEkW0O2rDLaqN6",
    "frm_message": null,
    "metadata": null,
    "connector_metadata": null,
    "feature_metadata": null,
    "reference_id": "pi_3PyWLkIhl7EEkW0O2rDLaqN6",
    "payment_link": null,
    "profile_id": "pro_UyFz4kRsR7cF07w3ABgy",
    "surcharge_details": null,
    "attempt_count": 1,
    "merchant_decision": null,
    "merchant_connector_id": "mca_hUygDAQSZcNuwsf0gy7O",
    "incremental_authorization_allowed": null,
    "authorization_count": null,
    "incremental_authorizations": null,
    "external_authentication_details": null,
    "external_3ds_authentication_attempted": false,
    "expires_on": "2024-09-13T10:18:35.978Z",
    "fingerprint": null,
    "browser_info": null,
    "payment_method_id": null,
    "payment_method_status": null,
    "updated": "2024-09-13T10:04:51.217Z",
    "charges": {
        "charge_id": "ch_3PyWLkIhl7EEkW0O2JuGIbKx",
        "charge_type": "direct",
        "application_fees": 100,
        "transfer_account_id": "acct_1PDftAIhl7EEkW0O"
    },
    "frm_metadata": null,
    "merchant_order_reference_id": null,
    "order_tax_amount": null
}

4. Create a refund

cURL

curl --location 'http://localhost:8080/refunds' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'api-key: dev_fU9hJ1iOCFFN1e5Ao0ikNCnh7GLlNd5GCtW7NHBP1vylXVcKax4BZhelhWCiOOFO' \
--data '{
    "payment_id": "pay_WuYe8INincbthQtTnOdF",
    "amount": 100,
    "reason": "Customer returned product",
    "refund_type": "instant",
    "metadata": {
        "udf1": "value1",
        "new_customer": "true",
        "login_date": "2024-05-05T10:11:12Z"
    },
    "charges": {
        "charge_id": "ch_3PyWLkIhl7EEkW0O2JuGIbKx",
        "revert_platform_fee": true
    }
}'

Response

{
    "refund_id": "ref_iHNDw2w1crHCanfz9ups",
    "payment_id": "pay_WuYe8INincbthQtTnOdF",
    "amount": 100,
    "currency": "USD",
    "status": "succeeded",
    "reason": "Customer returned product",
    "metadata": {
        "udf1": "value1",
        "new_customer": "true",
        "login_date": "2024-05-05T10:11:12Z"
    },
    "error_message": null,
    "error_code": null,
    "created_at": "2024-09-13T10:05:46.911Z",
    "updated_at": "2024-09-13T10:05:48.284Z",
    "connector": "stripe",
    "profile_id": "pro_UyFz4kRsR7cF07w3ABgy",
    "merchant_connector_id": "mca_hUygDAQSZcNuwsf0gy7O",
    "charges": {
        "charge_id": "ch_3PyWLkIhl7EEkW0O2JuGIbKx",
        "revert_platform_fee": true,
        "revert_transfer": null
    }
}

5. Sync the charged refund

cURL

curl --location 'http://localhost:8080/refunds/sync' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'api-key: dev_qjitjFb7HmmPae9FVYtkIkxg61y4HbDOPXpjFhgHpvFGFAeb5TMoZyJE65jtBvoQ' \
--data '{
    "refund_id": "ref_N9LQM1JeKldMVb36ATm4",
    "force_sync": true
}'

Response (should not contain any error_code or error_message)

{
    "refund_id": "ref_N9LQM1JeKldMVb36ATm4",
    "payment_id": "pay_AqMMNRDPyg3W0vc7ZPE3",
    "amount": 1,
    "currency": "USD",
    "status": "succeeded",
    "reason": "Customer returned product",
    "metadata": {
        "udf1": "value1",
        "new_customer": "true",
        "login_date": "2024-05-05T10:11:12Z"
    },
    "error_message": null,
    "error_code": null,
    "created_at": "2024-09-17T05:36:53.915Z",
    "updated_at": "2024-09-17T05:37:02.222Z",
    "connector": "stripe",
    "profile_id": "pro_DN1OG5zBAKvedfOXOwUp",
    "merchant_connector_id": "mca_P7ZEY0RUGhoj0uiqSFQx",
    "charges": {
        "charge_id": "ch_3Pztb7Ihl7EEkW0O2ugKycYU",
        "revert_platform_fee": true,
        "revert_transfer": null
    }
}

6. Retrieve the refund

cURL

curl --location 'http://localhost:8080/refunds/ref_N9LQM1JeKldMVb36ATm4' \
--header 'Accept: application/json' \
--header 'api-key: dev_qjitjFb7HmmPae9FVYtkIkxg61y4HbDOPXpjFhgHpvFGFAeb5TMoZyJE65jtBvoQ'

Response (should not contain any error_code or error_message)

{
    "refund_id": "ref_N9LQM1JeKldMVb36ATm4",
    "payment_id": "pay_AqMMNRDPyg3W0vc7ZPE3",
    "amount": 1,
    "currency": "USD",
    "status": "succeeded",
    "reason": "Customer returned product",
    "metadata": {
        "udf1": "value1",
        "new_customer": "true",
        "login_date": "2024-05-05T10:11:12Z"
    },
    "error_message": null,
    "error_code": null,
    "created_at": "2024-09-17T05:36:53.915Z",
    "updated_at": "2024-09-17T05:37:02.222Z",
    "connector": "stripe",
    "profile_id": "pro_DN1OG5zBAKvedfOXOwUp",
    "merchant_connector_id": "mca_P7ZEY0RUGhoj0uiqSFQx",
    "charges": {
        "charge_id": "ch_3Pztb7Ihl7EEkW0O2ugKycYU",
        "revert_platform_fee": true,
        "revert_transfer": 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

crates/router/src/connector/stripe.rs

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

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

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

crates/router/src/core/refunds.rs

sai-harsha-vardhan · 2024-09-25T08:06:43Z

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

+            }
+        }
+        api::Amount::Value(amount) => {
+            if charges.fees.get_amount_as_i64() > amount.into() {


what if charges.fees is lesser than the amount, is it valid?

fees being charged should always be lesser than the actual amount, that's the only* valid case

deepanshu-iiitu

Approving on behalf of connectors

feat(charges): integrated PaymentSync for stripe connect

88b55d6

kashif-m linked an issue May 27, 2024 that may be closed by this pull request

[FEATURE] add support for collecting and refunding charges on payments #4659

Closed

2 tasks

kashif-m added 2 commits May 27, 2024 14:29

Merge remote-tracking branch 'origin/main' into charges_sync

2d8d812

refactor: cargo clippy fixes

67fcdf9

kashif-m marked this pull request as ready for review May 27, 2024 10:16

kashif-m requested review from a team as code owners May 27, 2024 10:16

kashif-m self-assigned this May 27, 2024

kashif-m requested review from Narayanbhat166 and SamraatBansal May 27, 2024 10:16

kashif-m added the S-waiting-on-review Status: This PR has been implemented and needs to be reviewed label May 27, 2024

kashif-m added 5 commits May 28, 2024 14:25

Merge remote-tracking branch 'origin/main' into charges_sync

33be812

Merge remote-tracking branch 'origin/main' into charges_sync

d359255

refactor: update after merging w main

f730bb8

Merge remote-tracking branch 'origin/main' into charges_sync

a51fc50

feat(charges): update refund sync call for charged refunds

62d8a06

kashif-m removed request for Narayanbhat166 and SamraatBansal September 17, 2024 06:18

refactor: clippy fixes

f57e0d9

sai-harsha-vardhan reviewed Sep 19, 2024

View reviewed changes

crates/router/src/connector/stripe.rs Outdated Show resolved Hide resolved

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

kashif-m added 2 commits September 23, 2024 08:52

refactor: resolve comments

7bcf1fa

Merge remote-tracking branch 'origin/main' into charges_sync

b12316b

kashif-m force-pushed the charges_sync branch from e290897 to b12316b Compare September 23, 2024 03:25

kashif-m requested a review from sai-harsha-vardhan September 23, 2024 03:29

refactor: cargo hack fixes for v2 compilation

5fac8d9

sai-harsha-vardhan reviewed Sep 23, 2024

View reviewed changes

kashif-m and others added 2 commits September 25, 2024 09:39

refactor: resolve comments

af19446

chore: run formatter

7677ede

kashif-m requested a review from sai-harsha-vardhan September 25, 2024 06:28

sai-harsha-vardhan approved these changes Sep 25, 2024

View reviewed changes

deepanshu-iiitu approved these changes Sep 25, 2024

View reviewed changes

jarnura approved these changes Sep 25, 2024

View reviewed changes

likhinbopanna added this pull request to the merge queue Sep 26, 2024

Merged via the queue into main with commit e0630a7 Sep 26, 2024
14 checks passed

likhinbopanna deleted the charges_sync branch September 26, 2024 07:42

SanchithHegde removed the S-waiting-on-review Status: This PR has been implemented and needs to be reviewed label Sep 29, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(charges): integrated PaymentSync for stripe connect #4771

feat(charges): integrated PaymentSync for stripe connect #4771

kashif-m commented May 27, 2024 •

edited

Loading

sai-harsha-vardhan Sep 25, 2024 •

edited

Loading

kashif-m Sep 25, 2024 •

edited

Loading

deepanshu-iiitu left a comment

feat(charges): integrated PaymentSync for stripe connect #4771

feat(charges): integrated PaymentSync for stripe connect #4771

Conversation

kashif-m commented May 27, 2024 • edited Loading

Type of Change

Description

Additional Changes

Motivation and Context

How did you test it?

Checklist

sai-harsha-vardhan Sep 25, 2024 • edited Loading

Choose a reason for hiding this comment

kashif-m Sep 25, 2024 • edited Loading

Choose a reason for hiding this comment

deepanshu-iiitu left a comment

Choose a reason for hiding this comment

kashif-m commented May 27, 2024 •

edited

Loading

sai-harsha-vardhan Sep 25, 2024 •

edited

Loading

kashif-m Sep 25, 2024 •

edited

Loading