feat(core): Create Payout Webhook Flow #4696

Sakilmostak · 2024-05-19T16:09:38Z

Type of Change

Description

Create core flow for processing payout webhooks and send respective outgoing webhook

Additional Changes

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

Motivation and Context

How did you test it?

Tested through Postman:

Craete an MCA(Adyen Payout):

{
    "connector_type": "payout_processor",
    "connector_name": "adyen",
    "connector_account_details": {
        "auth_type": "SignatureKey",
        "api_key": "{{api_key}}",
        "key1": "{{key1}}",
        "api_secret": "{{api_secret}}"
    },
    "test_mode": false,
    "disabled": false,
    "payment_methods_enabled": [
        {
            "payment_method": "card",
            "payment_method_types": [
                {
                    "payment_method_type": "credit",
                    "card_networks": [
                        "Visa",
                        "Mastercard"
                    ],
                    "minimum_amount": 1,
                    "maximum_amount": 68607706,
                    "recurring_enabled": true,
                    "installment_payment_enabled": true
                },
                {
                    "payment_method_type": "debit",
                    "card_networks": [
                        "Visa",
                        "Mastercard"
                    ],
                    "minimum_amount": 1,
                    "maximum_amount": 68607706,
                    "recurring_enabled": true,
                    "installment_payment_enabled": true
                }
            ]
        },
        {
            "payment_method": "bank_transfer",
            "payment_method_types": [
                {
                    "payment_method_type": "sepa",
                    "minimum_amount": 1,
                    "maximum_amount": 68607706,
                    "recurring_enabled": true,
                    "installment_payment_enabled": true
                },
                {
                    "payment_method_type": "pix",
                    "minimum_amount": 1,
                    "maximum_amount": 68607706,
                    "recurring_enabled": true,
                    "installment_payment_enabled": true
                },
                {
                    "payment_method_type": "bacs",
                    "minimum_amount": 1,
                    "maximum_amount": 68607706,
                    "recurring_enabled": true,
                    "installment_payment_enabled": true
                }
            ]
        }
    ],
    "metadata": {
        "city": "NY",
        "unit": "245",
        "endpoint_prefix": ""
    },
    "business_country": "US",
    "business_label": "default"
}

Update the MCA with merchant_secret:

{
    "connector_type": "payout_processor",
    "connector_webhook_details": {
        "merchant_secret": "F56C44CD8BCDE3FF0D45DC09E0D494A352B7331EAD78149EB9D8187322BBF8DB"
    }
}

Update the Merchant Account with the outgoing webhook url:

{
    "merchant_id": "{{merchant_id}}",
    "webhook_details": {
        "webhook_version": "1.0.1",
        "webhook_username": "ekart_retail",
        "webhook_password": "password_ekart@123",
        "payment_created_enabled": true,
        "payment_succeeded_enabled": true,
        "payment_failed_enabled": true,
        "webhook_url": "https://webhook.site/c2c092a7-7f8a-45ec-9d83-efdcb3bf87e7"
    }
}

Set up the url at Connector's Dashboard:

Create a payout through Adyen:

{
    "amount": 100,
    "currency": "EUR",
    "customer_id": "{{customer_id}}",
    "email": "payout_customer@example.com",
    "name": "John Doe",
    "phone": "999999999",
    "phone_country_code": "+65",
    "description": "Its my first payout request",
    "payout_type": "bank",
    "payout_method_data": {
        "bank": {
            "bic": "ABNANL2A",
            "iban": "NL46TEST0136169112",
            "bank_name": "Deutsche Bank",
            "bank_country_code": "NL",
            "bank_city": "Amsterdam",
            "tax_id": "12345"
        }
    },
    "billing": {
        "address": {
            "line1": "1467",
            "line2": "Harrison Street",
            "line3": "Harrison Street",
            "city": "San Fransico",
            "state": "NY",
            "zip": "94122",
            "country": "US",
            "first_name": "John",
            "last_name": "Doe"
        },
        "phone": {
            "number": "8056594427",
            "country_code": "+91"
        }
    },
    "entity_type": "Individual",
    "recurring": false,
    "metadata": {
        "ref": "123"
    },"routing": {
        "type": "single",
        "data": "adyen"
    },
    "confirm": true,
    "auto_fulfill": true
}

The webhook should be received at your defined endpoint with event type as payout_initiated

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

kashif-m · 2024-05-21T04:08:57Z

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

+pub fn is_payout_event(event_code: &WebhookEventCode) -> bool {
+    matches!(
+        event_code,
+        WebhookEventCode::PayoutThirdparty | WebhookEventCode::PayoutDecline


Are we not handling PAYOUT_REVERSED and PAYOUT_EXPIRE?

ref - https://docs.adyen.com/online-payments/online-payouts/payout-webhook/

Added support for them

kashif-m · 2024-05-21T04:13:36Z

crates/router/src/events/outgoing_webhook_logs.rs

+            Self::PayoutDetails(payout_payload) => Some(OutgoingWebhookEventContent::Payout {
+                payout_id: payout_payload.payout_id.clone(),
+                content: masking::masked_serialize(&payout_payload)
+                    .unwrap_or(serde_json::json!({"error":"failed to serialize"})),


Is this what we send to merchants if deserialization fails?

kashif-m · 2024-05-21T04:15:21Z

crates/router/src/types.rs

@@ -420,7 +420,7 @@ impl PayoutIndividualDetailsExt for api_models::payouts::PayoutIndividualDetails
 #[derive(Clone, Debug, Default)]
 pub struct PayoutsResponseData {
    pub status: Option<storage_enums::PayoutStatus>,
-    pub connector_payout_id: String,
+    pub connector_payout_id: Option<String>,


TODO for later: make it non optional, and add new struct for connector integration if this field is not consumed in other flows

kashif-m · 2024-05-21T04:19:07Z

crates/common_enums/src/enums.rs

@@ -1107,6 +1108,10 @@ pub enum EventType {
    DisputeLost,
    MandateActive,
    MandateRevoked,
+    PayoutSuccess,


Possible to add PayoutCreated? Trigger - when payout is created at connector's end.

shouldn't we add feature flags here as well?

kashif-m · 2024-05-21T04:23:02Z

crates/storage_impl/src/payouts/payout_attempt.rs

+                    )
+                    .await
+            }
+            MerchantStorageScheme::RedisKv => {


@dracarys18 can you review the reverse lookup bit?

sahkal · 2024-06-04T11:06:59Z

crates/diesel_models/src/enums.rs

@@ -68,6 +68,7 @@ pub enum EventObjectType {
    RefundDetails,
    DisputeDetails,
    MandateDetails,
+    PayoutDetails,


feature flag?

crates/router/src/compatibility/stripe/webhooks.rs

sahkal · 2024-06-04T12:09:18Z

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

@@ -301,7 +301,7 @@ impl<F> TryFrom<types::PayoutsResponseRouterData<F, EbanxFulfillResponse>>
        Ok(Self {
            response: Ok(types::PayoutsResponseData {
                status: Some(storage_enums::PayoutStatus::from(item.response.status)),
-                connector_payout_id: item.data.request.get_transfer_id()?,
+                connector_payout_id: item.data.request.get_transfer_id().ok(),


why are we ignoring the error in this case?

sahkal · 2024-06-04T12:27:17Z