feat(router): add support for relay refund incoming webhooks #6974

ShankarSinghC · 2025-01-02T13:49:11Z

Type of Change

Description

Some connectors, like Adyen, do not support a refund sync API, so we need to rely on refund webhooks for the status. To address this, support for relay refund webhooks is being added.

To support this use case, a new webhook endpoint needs to be introduced for relay webhooks:
/webhooks/relay/{merchant_id}/{connector_id_or_name}

Once the webhook is identified as a relay webhook, it should be handled based on the flow type, such as refunds, payments, etc. For now, only support for relay refund webhooks has been added.

Additional Changes

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

Motivation and Context

This change is to update the relay status when we have to rely on the connector webhooks for the refund status.

How did you test it?

-> Create a merchant connector account for stripe
-> Setup the webhook url in the stripe dashboard
-> Relay webhook testing
-> Make payment through stripe connector. As this relay webhooks can only handle relay refunds webhooks, we need to return 200 OK for the payments webhooks that we received.

curl --location 'http://localhost:8080/payments' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'x-tenant-id: hyperswitch' \
--header 'api-key:' \
--data-raw '{
    "amount": 100,
    "amount_to_capture": 100,
    "currency": "USD",
    "confirm": true,
    "capture_method": "automatic",
    "capture_on": "2022-09-10T10:11:12Z",
    "email": "[email protected]",
    "name": "John Doe",
    "phone": "999999999",
    "phone_country_code": "+1",
    "description": "Its my first payment request",
    "authentication_type": "no_three_ds",
    "customer_id": "cu_1736430184",
    "return_url": "http://127.0.0.1:4040",
    "customer_acceptance": {
        "acceptance_type": "offline",
        "accepted_at": "1963-05-03T04:07:52.723Z",
        "online": {
            "ip_address": "in sit",
            "user_agent": "amet irure esse"
        }
    },
    "payment_method": "card",
    "payment_method_data": {
        "card": {
            "card_number": "4111111111111111",
            "card_exp_month": "03",
            "card_exp_year": "2030",
            "card_holder_name": "joseph Doe",
            "card_cvc": "737"
        }
    },
    "billing": {
        "address": {
            "line1": "1467",
            "line2": "Harrison Street",
            "line3": "Harrison Street",
            "city": "San",
            "state": "California",
            "zip": "94122",
            "country": "US",
            "first_name": "PiX",
            "last_name": "ss"
        },
        "email": "[email protected]"
    },
    "shipping": {
        "address": {
            "line1": "1467",
            "line2": "Harrison Street",
            "line3": "Harrison Street",
            "city": "San Fransico",
            "state": "California",
            "zip": "94122",
            "country": "US",
            "first_name": "PiX"
        }
    },
    "browser_info": {
        "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",
        "accept_header": "text\/html,application\/xhtml+xml,application\/xml;q=0.9,image\/webp,image\/apng,*\/*;q=0.8",
        "language": "nl-NL",
        "color_depth": 24,
        "screen_height": 723,
        "screen_width": 1536,
        "time_zone": 0,
        "java_enabled": true,
        "java_script_enabled": true,
        "ip_address": "125.0.0.1"
    },
    "routing": {
        "type": "single",
        "data": {
            "connector": "cybersource",
            "merchant_connector_id": "mca_8W0CQfwE89J1BJBbpcnt"
        }
    },
    "statement_descriptor_name": "joseph",
    "statement_descriptor_suffix": "JS",
    "metadata": {
        "udf1": "value1",
        "new_customer": "true",
        "login_date": "2019-09-10T10:11:12Z"
    }
}'

{
    "payment_id": "pay_9IYMeErPOtFrHTxEundR",
    "merchant_id": "merchant_1736429319",
    "status": "succeeded",
    "amount": 100,
    "net_amount": 100,
    "shipping_cost": null,
    "amount_capturable": 0,
    "amount_received": 100,
    "connector": "stripe",
    "client_secret": "pay_9IYMeErPOtFrHTxEundR_secret_A9BwRKPAld2g2fPwpN0Z",
    "created": "2025-01-09T13:42:58.438Z",
    "currency": "USD",
    "customer_id": "cu_1736430178",
    "customer": {
        "id": "cu_1736430178",
        "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": "card",
    "payment_method_data": {
        "card": {
            "last4": "1111",
            "card_type": null,
            "card_network": null,
            "card_issuer": null,
            "card_issuing_country": null,
            "card_isin": "411111",
            "card_extended_bin": null,
            "card_exp_month": "03",
            "card_exp_year": "2030",
            "card_holder_name": "joseph Doe",
            "payment_checks": {
                "cvc_check": "pass",
                "address_line1_check": "pass",
                "address_postal_code_check": "pass"
            },
            "authentication_data": null
        },
        "billing": 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": "PiX",
            "last_name": null
        },
        "phone": null,
        "email": null
    },
    "billing": {
        "address": {
            "city": "San",
            "country": "US",
            "line1": "1467",
            "line2": "Harrison Street",
            "line3": "Harrison Street",
            "zip": "94122",
            "state": "California",
            "first_name": "PiX",
            "last_name": "ss"
        },
        "phone": null,
        "email": "[email protected]"
    },
    "order_details": null,
    "email": "[email protected]",
    "name": "John Doe",
    "phone": "999999999",
    "return_url": "http://127.0.0.1:4040/",
    "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": "cu_1736430178",
        "created_at": 1736430178,
        "expires": 1736433778,
        "secret": "epk_54d28c2dcea8416fa84ce3ec9f960102"
    },
    "manual_retry_allowed": false,
    "connector_transaction_id": "pi_3QfM0lD5R7gDAGff1L1eaicn",
    "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_3QfM0lD5R7gDAGff1L1eaicn",
    "payment_link": null,
    "profile_id": "pro_GhoiAnNpnyEAqAAbwULW",
    "surcharge_details": null,
    "attempt_count": 1,
    "merchant_decision": null,
    "merchant_connector_id": "mca_YhBV1Nr6PXdkkG7md9ro",
    "incremental_authorization_allowed": null,
    "authorization_count": null,
    "incremental_authorizations": null,
    "external_authentication_details": null,
    "external_3ds_authentication_attempted": false,
    "expires_on": "2025-01-09T13:57:58.438Z",
    "fingerprint": null,
    "browser_info": {
        "language": "nl-NL",
        "time_zone": 0,
        "ip_address": "125.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": "2025-01-09T13:43:00.565Z",
    "split_payments": null,
    "frm_metadata": null,
    "merchant_order_reference_id": null,
    "order_tax_amount": null,
    "connector_mandate_id": null
}

-> Create a relay refund

curl --location 'http://localhost:8080/relay' \
--header 'Content-Type: application/json' \
--header 'x-profile-id: pro_GhoiAnNpnyEAqAAbwULW' \
--header 'api-key:' \
--data '{
    "connector_id": "mca_YhBV1Nr6PXdkkG7md9ro",
    "connector_resource_id": "pi_3QfM0lD5R7gDAGff1L1eaicn",
    "data": {
        "refund": {
            "amount": 1,
            "currency": "USD"
        }
    },
    "type": "refund"
}'

{
    "id": "relay_WhRindDie9fcGbLRvE3G",
    "status": "success",
    "connector_resource_id": "pi_3QfM0lD5R7gDAGff1L1eaicn",
    "error": null,
    "connector_reference_id": "re_3QfM0lD5R7gDAGff1533tuY2",
    "connector_id": "mca_YhBV1Nr6PXdkkG7md9ro",
    "profile_id": "pro_GhoiAnNpnyEAqAAbwULW",
    "type": "refund",
    "data": {
        "refund": {
            "amount": 1,
            "currency": "USD",
            "reason": null
        }
    }
}

-> Manually setting the db recording the pending to test relay status update by webhook

curl --location 'http://localhost:8080/relay/relay_WhRindDie9fcGbLRvE3G' \
--header 'Content-Type: application/json' \
--header 'X-Idempotency-Key: <x-idempotency-key>' \
--header 'X-Profile-Id: pro_GhoiAnNpnyEAqAAbwULW' \
--header 'api-key:' \
--data ''

{
    "id": "relay_WhRindDie9fcGbLRvE3G",
    "status": "pending",
    "connector_resource_id": "pi_3QfM0lD5R7gDAGff1L1eaicn",
    "error": null,
    "connector_reference_id": "re_3QfM0lD5R7gDAGff1533tuY2",
    "connector_id": "mca_YhBV1Nr6PXdkkG7md9ro",
    "profile_id": "pro_GhoiAnNpnyEAqAAbwULW",
    "type": "refund",
    "data": {
        "refund": {
            "amount": 1,
            "currency": "USD",
            "reason": null
        }
    }
}

-> Re trigger the relay webhook and when retrieved the status is expected to be succeeded

curl --location 'http://localhost:8080/relay/relay_WhRindDie9fcGbLRvE3G' \
--header 'Content-Type: application/json' \
--header 'X-Idempotency-Key: <x-idempotency-key>' \
--header 'X-Profile-Id: pro_GhoiAnNpnyEAqAAbwULW' \
--header 'api-key:' \
--data ''

{
    "id": "relay_WhRindDie9fcGbLRvE3G",
    "status": "success",
    "connector_resource_id": "pi_3QfM0lD5R7gDAGff1L1eaicn",
    "error": null,
    "connector_reference_id": "re_3QfM0lD5R7gDAGff1533tuY2",
    "connector_id": "mca_YhBV1Nr6PXdkkG7md9ro",
    "profile_id": "pro_GhoiAnNpnyEAqAAbwULW",
    "type": "refund",
    "data": {
        "refund": {
            "amount": 1,
            "currency": "USD",
            "reason": null
        }
    }
}

-> Test stripe normal payments webhooks to ensure that the webhook behaviour is not affected for all other events
-> Create a payment

curl --location 'http://localhost:8080/payments' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'x-tenant-id: hyperswitch' \
--header 'api-key:' \
--data-raw '{
    "amount": 100,
    "amount_to_capture": 100,
    "currency": "USD",
    "confirm": true,
    "capture_method": "automatic",
    "capture_on": "2022-09-10T10:11:12Z",
    "email": "[email protected]",
    "name": "John Doe",
    "phone": "999999999",
    "phone_country_code": "+1",
    "description": "Its my first payment request",
    "authentication_type": "no_three_ds",
    "customer_id": "cu_1736432186",
    "return_url": "http://127.0.0.1:4040",
    "customer_acceptance": {
        "acceptance_type": "offline",
        "accepted_at": "1963-05-03T04:07:52.723Z",
        "online": {
            "ip_address": "in sit",
            "user_agent": "amet irure esse"
        }
    },
    "payment_method": "card",
    "payment_method_data": {
        "card": {
            "card_number": "4111111111111111",
            "card_exp_month": "03",
            "card_exp_year": "2030",
            "card_holder_name": "joseph Doe",
            "card_cvc": "737"
        }
    },
    "billing": {
        "address": {
            "line1": "1467",
            "line2": "Harrison Street",
            "line3": "Harrison Street",
            "city": "San",
            "state": "California",
            "zip": "94122",
            "country": "US",
            "first_name": "PiX",
            "last_name": "ss"
        },
        "email": "[email protected]"
    },
    "shipping": {
        "address": {
            "line1": "1467",
            "line2": "Harrison Street",
            "line3": "Harrison Street",
            "city": "San Fransico",
            "state": "California",
            "zip": "94122",
            "country": "US",
            "first_name": "PiX"
        }
    },
    "browser_info": {
        "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",
        "accept_header": "text\/html,application\/xhtml+xml,application\/xml;q=0.9,image\/webp,image\/apng,*\/*;q=0.8",
        "language": "nl-NL",
        "color_depth": 24,
        "screen_height": 723,
        "screen_width": 1536,
        "time_zone": 0,
        "java_enabled": true,
        "java_script_enabled": true,
        "ip_address": "125.0.0.1"
    },
    "routing": {
        "type": "single",
        "data": {
            "connector": "cybersource",
            "merchant_connector_id": "mca_8W0CQfwE89J1BJBbpcnt"
        }
    },
    "statement_descriptor_name": "joseph",
    "statement_descriptor_suffix": "JS",
    "metadata": {
        "udf1": "value1",
        "new_customer": "true",
        "login_date": "2019-09-10T10:11:12Z"
    }
}'

{
    "payment_id": "pay_bnl7rTJB6WUbfsQRTRU3",
    "merchant_id": "merchant_1736429319",
    "status": "succeeded",
    "amount": 100,
    "net_amount": 100,
    "shipping_cost": null,
    "amount_capturable": 0,
    "amount_received": 100,
    "connector": "stripe",
    "client_secret": "pay_bnl7rTJB6WUbfsQRTRU3_secret_YRCZCEKKcDxD6VnbtBGl",
    "created": "2025-01-09T14:07:10.134Z",
    "currency": "USD",
    "customer_id": "cu_1736431630",
    "customer": {
        "id": "cu_1736431630",
        "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": "card",
    "payment_method_data": {
        "card": {
            "last4": "1111",
            "card_type": null,
            "card_network": null,
            "card_issuer": null,
            "card_issuing_country": null,
            "card_isin": "411111",
            "card_extended_bin": null,
            "card_exp_month": "03",
            "card_exp_year": "2030",
            "card_holder_name": "joseph Doe",
            "payment_checks": {
                "cvc_check": "pass",
                "address_line1_check": "pass",
                "address_postal_code_check": "pass"
            },
            "authentication_data": null
        },
        "billing": 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": "PiX",
            "last_name": null
        },
        "phone": null,
        "email": null
    },
    "billing": {
        "address": {
            "city": "San",
            "country": "US",
            "line1": "1467",
            "line2": "Harrison Street",
            "line3": "Harrison Street",
            "zip": "94122",
            "state": "California",
            "first_name": "PiX",
            "last_name": "ss"
        },
        "phone": null,
        "email": "[email protected]"
    },
    "order_details": null,
    "email": "[email protected]",
    "name": "John Doe",
    "phone": "999999999",
    "return_url": "http://127.0.0.1:4040/",
    "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": "cu_1736431630",
        "created_at": 1736431630,
        "expires": 1736435230,
        "secret": "epk_bf70a02d2bb64f5c81712679dedac0aa"
    },
    "manual_retry_allowed": false,
    "connector_transaction_id": "pi_3QfMOBD5R7gDAGff0l6jmTHK",
    "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_3QfMOBD5R7gDAGff0l6jmTHK",
    "payment_link": null,
    "profile_id": "pro_GhoiAnNpnyEAqAAbwULW",
    "surcharge_details": null,
    "attempt_count": 1,
    "merchant_decision": null,
    "merchant_connector_id": "mca_YhBV1Nr6PXdkkG7md9ro",
    "incremental_authorization_allowed": null,
    "authorization_count": null,
    "incremental_authorizations": null,
    "external_authentication_details": null,
    "external_3ds_authentication_attempted": false,
    "expires_on": "2025-01-09T14:22:10.134Z",
    "fingerprint": null,
    "browser_info": {
        "language": "nl-NL",
        "time_zone": 0,
        "ip_address": "125.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": "2025-01-09T14:07:12.259Z",
    "split_payments": null,
    "frm_metadata": null,
    "merchant_order_reference_id": null,
    "order_tax_amount": null,
    "connector_mandate_id": null
}

-> Manually set the status to pending in the db to test webhooks flow

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

{
    "payment_id": "pay_bnl7rTJB6WUbfsQRTRU3",
    "merchant_id": "merchant_1736429319",
    "status": "processing",
    "amount": 100,
    "net_amount": 100,
    "shipping_cost": null,
    "amount_capturable": 0,
    "amount_received": 100,
    "connector": "stripe",
    "client_secret": "pay_bnl7rTJB6WUbfsQRTRU3_secret_YRCZCEKKcDxD6VnbtBGl",
    "created": "2025-01-09T14:07:10.134Z",
    "currency": "USD",
    "customer_id": "cu_1736431630",
    "customer": {
        "id": "cu_1736431630",
        "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": "card",
    "payment_method_data": {
        "card": {
            "last4": "1111",
            "card_type": null,
            "card_network": null,
            "card_issuer": null,
            "card_issuing_country": null,
            "card_isin": "411111",
            "card_extended_bin": null,
            "card_exp_month": "03",
            "card_exp_year": "2030",
            "card_holder_name": "joseph Doe",
            "payment_checks": {
                "cvc_check": "pass",
                "address_line1_check": "pass",
                "address_postal_code_check": "pass"
            },
            "authentication_data": null
        },
        "billing": 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": "PiX",
            "last_name": null
        },
        "phone": null,
        "email": null
    },
    "billing": {
        "address": {
            "city": "San",
            "country": "US",
            "line1": "1467",
            "line2": "Harrison Street",
            "line3": "Harrison Street",
            "zip": "94122",
            "state": "California",
            "first_name": "PiX",
            "last_name": "ss"
        },
        "phone": null,
        "email": "[email protected]"
    },
    "order_details": null,
    "email": "[email protected]",
    "name": "John Doe",
    "phone": "999999999",
    "return_url": "http://127.0.0.1:4040/",
    "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_3QfMOBD5R7gDAGff0l6jmTHK",
    "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_3QfMOBD5R7gDAGff0l6jmTHK",
    "payment_link": null,
    "profile_id": "pro_GhoiAnNpnyEAqAAbwULW",
    "surcharge_details": null,
    "attempt_count": 1,
    "merchant_decision": null,
    "merchant_connector_id": "mca_YhBV1Nr6PXdkkG7md9ro",
    "incremental_authorization_allowed": null,
    "authorization_count": null,
    "incremental_authorizations": null,
    "external_authentication_details": null,
    "external_3ds_authentication_attempted": false,
    "expires_on": "2025-01-09T14:22:10.134Z",
    "fingerprint": null,
    "browser_info": {
        "language": "nl-NL",
        "time_zone": 0,
        "ip_address": "125.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": "pm_2aJAicSBjlanyP8w6jYQ",
    "payment_method_status": "active",
    "updated": "2025-01-09T14:15:56.696Z",
    "split_payments": null,
    "frm_metadata": null,
    "merchant_order_reference_id": null,
    "order_tax_amount": null,
    "connector_mandate_id": null
}

-> resend the webhook and when retrieved the payment status is expected to be succeeded

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

{
    "payment_id": "pay_bnl7rTJB6WUbfsQRTRU3",
    "merchant_id": "merchant_1736429319",
    "status": "succeeded",
    "amount": 100,
    "net_amount": 100,
    "shipping_cost": null,
    "amount_capturable": 0,
    "amount_received": 100,
    "connector": "stripe",
    "client_secret": "pay_bnl7rTJB6WUbfsQRTRU3_secret_YRCZCEKKcDxD6VnbtBGl",
    "created": "2025-01-09T14:07:10.134Z",
    "currency": "USD",
    "customer_id": "cu_1736431630",
    "customer": {
        "id": "cu_1736431630",
        "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": "card",
    "payment_method_data": {
        "card": {
            "last4": "1111",
            "card_type": null,
            "card_network": null,
            "card_issuer": null,
            "card_issuing_country": null,
            "card_isin": "411111",
            "card_extended_bin": null,
            "card_exp_month": "03",
            "card_exp_year": "2030",
            "card_holder_name": "joseph Doe",
            "payment_checks": {
                "cvc_check": "pass",
                "address_line1_check": "pass",
                "address_postal_code_check": "pass"
            },
            "authentication_data": null
        },
        "billing": 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": "PiX",
            "last_name": null
        },
        "phone": null,
        "email": null
    },
    "billing": {
        "address": {
            "city": "San",
            "country": "US",
            "line1": "1467",
            "line2": "Harrison Street",
            "line3": "Harrison Street",
            "zip": "94122",
            "state": "California",
            "first_name": "PiX",
            "last_name": "ss"
        },
        "phone": null,
        "email": "[email protected]"
    },
    "order_details": null,
    "email": "[email protected]",
    "name": "John Doe",
    "phone": "999999999",
    "return_url": "http://127.0.0.1:4040/",
    "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_3QfMOBD5R7gDAGff0l6jmTHK",
    "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_3QfMOBD5R7gDAGff0l6jmTHK",
    "payment_link": null,
    "profile_id": "pro_GhoiAnNpnyEAqAAbwULW",
    "surcharge_details": null,
    "attempt_count": 1,
    "merchant_decision": null,
    "merchant_connector_id": "mca_YhBV1Nr6PXdkkG7md9ro",
    "incremental_authorization_allowed": null,
    "authorization_count": null,
    "incremental_authorizations": null,
    "external_authentication_details": null,
    "external_3ds_authentication_attempted": false,
    "expires_on": "2025-01-09T14:22:10.134Z",
    "fingerprint": null,
    "browser_info": {
        "language": "nl-NL",
        "time_zone": 0,
        "ip_address": "125.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": "pm_2aJAicSBjlanyP8w6jYQ",
    "payment_method_status": "active",
    "updated": "2025-01-09T14:21:04.293Z",
    "split_payments": null,
    "frm_metadata": null,
    "merchant_order_reference_id": null,
    "order_tax_amount": null,
    "connector_mandate_id": 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

semanticdiff-com · 2025-01-02T13:49:13Z

Review changes with

Changed Files

File	Status
crates/router/src/core/webhooks/incoming.rs	48% smaller
crates/hyperswitch_domain_models/src/relay.rs	43% smaller
crates/router/src/routes/lock_utils.rs	30% smaller
crates/router/src/lib.rs	18% smaller
crates/router/src/routes.rs	7% smaller
crates/diesel_models/src/query/relay.rs	1% smaller
crates/api_models/src/webhooks.rs	0% smaller
crates/common_utils/src/id_type/relay.rs	0% smaller
crates/router/src/core/webhooks/incoming_v2.rs	0% smaller
crates/router/src/db/relay.rs	0% smaller
crates/router/src/routes/app.rs	0% smaller
crates/router/src/routes/webhooks.rs	0% smaller
crates/router/src/types/transformers.rs	0% smaller
crates/router_env/src/logger/types.rs	0% smaller
migrations/2025-01-07-105739_create_index_for_relay/down.sql	Unsupported file format
migrations/2025-01-07-105739_create_index_for_relay/up.sql	Unsupported file format

crates/router/src/core/webhooks/incoming.rs

sai-harsha-vardhan · 2025-01-06T08:01:52Z

crates/router/src/routes/webhooks.rs

+) -> impl Responder {
+    let flow = Flow::IncomingWebhookReceive;
+    let (merchant_id, connector_id_or_name) = path.into_inner();
+    let is_relay_webhook = true;


Move this to a const

Can we consider using an enum instead of a bool maybe?

Can I take this up in my next pr ?
I have a relay refactor pr, will address this in the same pr.
#6954

crates/router/src/routes/app.rs

crates/router/src/core/webhooks/incoming.rs

…perswitch into relay/incoming-webhook

…ay/incoming-webhook

crates/diesel_models/src/query/relay.rs

crates/router/src/core/webhooks/incoming.rs

crates/router/src/routes/app.rs

…perswitch into relay/incoming-webhook

…ay/incoming-webhook

crates/diesel_models/src/query/relay.rs

crates/router/src/db/relay.rs

SanchithHegde · 2025-01-07T19:31:32Z

crates/router/src/routes/app.rs

+impl RelayWebhooks {
+    pub fn server(state: AppState) -> Scope {
+        use api_models::webhooks as webhook_type;
+        web::scope("/webhooks/relay")


Have we confirmed that this doesn't affect the existing incoming webhooks flows, due to the possibly conflicting routes?

Yes, I have added the test cases for it

SanchithHegde · 2025-01-07T19:32:38Z

crates/router/src/routes/webhooks.rs

+) -> impl Responder {
+    let flow = Flow::IncomingWebhookReceive;
+    let (merchant_id, connector_id_or_name) = path.into_inner();
+    let is_relay_webhook = true;


Can we consider using an enum instead of a bool maybe?

crates/router/src/routes/webhooks.rs

migrations/2025-01-07-105739_create_index_for_relay/up.sql

…perswitch into relay/incoming-webhook

…d-memory-cache * 'main' of github.com:juspay/hyperswitch: feat(connector): [Novalnet] Add zero auth mandate (#6631) feat(router): add support for relay refund incoming webhooks (#6974) chore(version): 2025.01.10.0

add support for relay refund incoming wehooks

94c7a43

ShankarSinghC added A-core Area: Core flows C-refactor Category: Refactor A-refunds Area: Refund flows labels Jan 2, 2025

ShankarSinghC self-assigned this Jan 2, 2025

ShankarSinghC requested review from a team as code owners January 2, 2025 13:49

chore: run formatter

981d0e9

ShankarSinghC changed the title ~~add support for relay refund incoming webhooks~~ feat(router): add support for relay refund incoming webhooks Jan 2, 2025

ShankarSinghC linked an issue Jan 2, 2025 that may be closed by this pull request

add support for relay refund incoming webhooks #6975

Closed

sai-harsha-vardhan reviewed Jan 6, 2025

View reviewed changes

ShankarSinghC and others added 6 commits January 6, 2025 16:22

address pr comments

2f56a6a

address pr comments

9e822e1

address pr comments

bdbc7b7

Merge branch 'relay/incoming-webhook' of https://github.com/juspay/hy…

041909a

…perswitch into relay/incoming-webhook

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

3fe9701

…ay/incoming-webhook

chore: run formatter

4586498

sai-harsha-vardhan reviewed Jan 7, 2025

View reviewed changes

ShankarSinghC added 3 commits January 7, 2025 16:51

address pr comments

09db34a

Merge branch 'relay/incoming-webhook' of https://github.com/juspay/hy…

d6eab60

…perswitch into relay/incoming-webhook

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

0d74735

…ay/incoming-webhook

hyperswitch-bot bot added the M-database-changes Metadata: This PR involves database schema changes label Jan 7, 2025

chore: run formatter

8e59f55

sai-harsha-vardhan previously approved these changes Jan 7, 2025

View reviewed changes

SanchithHegde reviewed Jan 7, 2025

View reviewed changes

ShankarSinghC added 2 commits January 9, 2025 18:24

address pr comments

61c6199

Merge branch 'relay/incoming-webhook' of https://github.com/juspay/hy…

d91ce97

…perswitch into relay/incoming-webhook

ShankarSinghC dismissed sai-harsha-vardhan’s stale review via d91ce97 January 9, 2025 12:56

fix clippy errors

e4e864d

ShankarSinghC requested review from SanchithHegde and sai-harsha-vardhan January 9, 2025 14:22

use connector error reason if present, for the refund error response

333f05f

SanchithHegde approved these changes Jan 9, 2025

View reviewed changes

sai-harsha-vardhan approved these changes Jan 10, 2025

View reviewed changes

Gnanasundari24 added this pull request to the merge queue Jan 10, 2025

Merged via the queue into main with commit d850f17 Jan 10, 2025
17 of 19 checks passed

Gnanasundari24 deleted the relay/incoming-webhook branch January 10, 2025 08:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(router): add support for relay refund incoming webhooks #6974

feat(router): add support for relay refund incoming webhooks #6974

ShankarSinghC commented Jan 2, 2025 •

edited

Loading

semanticdiff-com bot commented Jan 2, 2025 •

edited

Loading

sai-harsha-vardhan Jan 6, 2025

SanchithHegde Jan 7, 2025

ShankarSinghC Jan 9, 2025

SanchithHegde Jan 7, 2025

ShankarSinghC Jan 9, 2025

SanchithHegde Jan 7, 2025

feat(router): add support for relay refund incoming webhooks #6974

feat(router): add support for relay refund incoming webhooks #6974

Conversation

ShankarSinghC commented Jan 2, 2025 • edited Loading

Type of Change

Description

Additional Changes

Motivation and Context

How did you test it?

Checklist

semanticdiff-com bot commented Jan 2, 2025 • edited Loading

sai-harsha-vardhan Jan 6, 2025

Choose a reason for hiding this comment

SanchithHegde Jan 7, 2025

Choose a reason for hiding this comment

ShankarSinghC Jan 9, 2025

Choose a reason for hiding this comment

SanchithHegde Jan 7, 2025

Choose a reason for hiding this comment

ShankarSinghC Jan 9, 2025

Choose a reason for hiding this comment

SanchithHegde Jan 7, 2025

Choose a reason for hiding this comment

ShankarSinghC commented Jan 2, 2025 •

edited

Loading

semanticdiff-com bot commented Jan 2, 2025 •

edited

Loading