feat(payouts): Add Wallet to Payouts #3502

Sakilmostak · 2024-01-30T13:56:57Z

Type of Change

Description

Wallet for payout is added with implementation on Paypal for adyen

Additional Changes

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

The contract changes are made in the following file:

hyperswitch/crates/api_models/src/payments.rs

"payment_method_data": {
        "wallet": {
            "paypal_redirect": {
                "email": "{{paypal_email_address}}"
            }
        }
    },

hyperswitch/crates/api_models/src/payouts.rs

"payout_method_data": {
        "wallet": {
            "paypal": {
                "email": "{{paypal_email_address}}"
            }
        }
    },

How did you test it?

Tested through Postman:

Create a Merchant Account (Adyen)
Create a Payment Connector (Adyen) with SignatureKey

{
    "connector_type": "fiz_operations",
    "connector_name": "adyen",
    "connector_account_details": {
        "auth_type": "SignatureKey",
        "api_key": "{{api_key}}",
        "key1": "{{merchant_id}}",
        "api_secret": "{{review_key}}"
    },
    "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": "voucher",
            "payment_method_types": [
                {
                    "payment_method_type": "boleto",
                    //"payment_experience": "redirect_to_url",
                    "minimum_amount": 1,
                    "maximum_amount": 68607706,
                    "recurring_enabled": true,
                    "installment_payment_enabled": true
                }
            ]
        },
        {
            "payment_method": "bank_redirect",
            "payment_method_types": [
                {
                    "payment_method_type": "open_banking_uk",
                    "payment_experience": "redirect_to_url",
                    "minimum_amount": 1,
                    "maximum_amount": 68607706,
                    "recurring_enabled": true,
                    "installment_payment_enabled": true
                }
            ]
        },
    ],
    "metadata": {
        "city": "NY",
        "unit": "245"
    },
    "business_country": "US",
    "business_label": "default"
}

Create a Payout Reqeust with Wallet Data

{
    "amount": 1,
    "currency": "EUR",
    "customer_id": "payout_customer",
    "email": "payout_customer@example.com",
    "name": "John Doe",
    "phone": "999999999",
    "phone_country_code": "+65",
    "description": "Its my first payout request",
    "payout_type": "wallet",
    "payout_method_data": {
        "wallet": {
            "email": "{{paypal_email_address}}"
        }
    },
    "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": "999999999",
            "country_code": "+91"
        }
    },
    "entity_type": "NaturalPerson",
    "recurring": false,
    "metadata": {
        "ref": "123"
    },
    "routing": {
        "type": "single",
        "data": "adyen"
    },
    "confirm": true,
    "auto_fulfill": false
}

Status should be requires_fulfillment in the response

Fulfill the Payout

{
    "payout_id": "{{payout_id}}"
}

Status should be success in the response

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
I added a CHANGELOG entry if applicable

kashif-m · 2024-02-01T09:44:22Z

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

+                        .request
+                        .connector_payout_id
+                        .clone()
+                        .unwrap_or("".to_string()),


We can throw an error here, since original_reference is a required field for fulfillment

kashif-m · 2024-02-01T09:51:50Z

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

+            api_models::payouts::PayoutMethodData::Bank(bank) => {
+                let key = key_store.key.get_inner().peek();
+                let enc_data = async {
+                    serde_json::to_value(payout_method_data.to_owned())
+                        .into_report()
+                        .change_context(errors::ApiErrorResponse::InternalServerError)
+                        .attach_printable("Unable to encode payout method data")
+                        .ok()
+                        .map(|v| {
+                            let secret: Secret<String> = Secret::new(v.to_string());
+                            secret
+                        })
+                        .async_lift(|inner| domain_types::encrypt_optional(inner, key))
+                        .await
+                }
+                .await
+                .change_context(errors::ApiErrorResponse::InternalServerError)
+                .attach_printable("Failed to encrypt payout method data")?
+                .map(Encryption::from)
+                .map(|e| e.into_inner())
+                .map_or(Err(errors::ApiErrorResponse::InternalServerError), |e| {
+                    Ok(hex::encode(e.peek()))
+                })?;
+                let payload = StoreLockerReq::LockerGeneric(StoreGenericReq {
+                    merchant_id: &merchant_account.merchant_id,
+                    merchant_customer_id: payout_attempt.customer_id.to_owned(),
+                    enc_data,
+                });
+                (
+                    payload,
+                    None,
+                    Some(bank.to_owned()),
+                    None,
+                    api_enums::PaymentMethodType::foreign_from(bank.to_owned()),
+                )
+            }
+            api_models::payouts::PayoutMethodData::Wallet(wallet) => {
+                let key = key_store.key.get_inner().peek();
+                let enc_data = async {
+                    serde_json::to_value(payout_method_data.to_owned())
+                        .into_report()
+                        .change_context(errors::ApiErrorResponse::InternalServerError)
+                        .attach_printable("Unable to encode payout method data")
+                        .ok()
+                        .map(|v| {
+                            let secret: Secret<String> = Secret::new(v.to_string());
+                            secret
+                        })
+                        .async_lift(|inner| domain_types::encrypt_optional(inner, key))
+                        .await
+                }
+                .await
+                .change_context(errors::ApiErrorResponse::InternalServerError)
+                .attach_printable("Failed to encrypt payout method data")?
+                .map(Encryption::from)
+                .map(|e| e.into_inner())
+                .map_or(Err(errors::ApiErrorResponse::InternalServerError), |e| {
+                    Ok(hex::encode(e.peek()))
+                })?;
+                let payload = StoreLockerReq::LockerGeneric(StoreGenericReq {
+                    merchant_id: &merchant_account.merchant_id,
+                    merchant_customer_id: payout_attempt.customer_id.to_owned(),
+                    enc_data,
+                });
+                (
+                    payload,
+                    None,
+                    None,
+                    Some(wallet.to_owned()),
+                    api_enums::PaymentMethodType::foreign_from(wallet.to_owned()),
+                )
+            }
+        };


Suggested change

api_models::payouts::PayoutMethodData::Bank(bank) => {

let key = key_store.key.get_inner().peek();

let enc_data = async {

serde_json::to_value(payout_method_data.to_owned())

.into_report()

.change_context(errors::ApiErrorResponse::InternalServerError)

.attach_printable("Unable to encode payout method data")

.ok()

.map(|v| {

let secret: Secret<String> = Secret::new(v.to_string());

secret

})

.async_lift(|inner| domain_types::encrypt_optional(inner, key))

.await

}

.await

.change_context(errors::ApiErrorResponse::InternalServerError)

.attach_printable("Failed to encrypt payout method data")?

.map(Encryption::from)

.map(|e| e.into_inner())

.map_or(Err(errors::ApiErrorResponse::InternalServerError), |e| {

Ok(hex::encode(e.peek()))

})?;

let payload = StoreLockerReq::LockerGeneric(StoreGenericReq {

merchant_id: &merchant_account.merchant_id,

merchant_customer_id: payout_attempt.customer_id.to_owned(),

enc_data,

});

(

payload,

None,

Some(bank.to_owned()),

None,

api_enums::PaymentMethodType::foreign_from(bank.to_owned()),

)

}

api_models::payouts::PayoutMethodData::Wallet(wallet) => {

let key = key_store.key.get_inner().peek();

let enc_data = async {

serde_json::to_value(payout_method_data.to_owned())

.into_report()

.change_context(errors::ApiErrorResponse::InternalServerError)

.attach_printable("Unable to encode payout method data")

.ok()

.map(|v| {

let secret: Secret<String> = Secret::new(v.to_string());

secret

})

.async_lift(|inner| domain_types::encrypt_optional(inner, key))

.await

}

.await

.change_context(errors::ApiErrorResponse::InternalServerError)

.attach_printable("Failed to encrypt payout method data")?

.map(Encryption::from)

.map(|e| e.into_inner())

.map_or(Err(errors::ApiErrorResponse::InternalServerError), |e| {

Ok(hex::encode(e.peek()))

})?;

let payload = StoreLockerReq::LockerGeneric(StoreGenericReq {

merchant_id: &merchant_account.merchant_id,

merchant_customer_id: payout_attempt.customer_id.to_owned(),

enc_data,

});

(

payload,

None,

None,

Some(wallet.to_owned()),

api_enums::PaymentMethodType::foreign_from(wallet.to_owned()),

)

}

};

_ => {

let key = key_store.key.get_inner().peek();

let enc_data = async {

serde_json::to_value(payout_method_data.to_owned())

.into_report()

.change_context(errors::ApiErrorResponse::InternalServerError)

.attach_printable("Unable to encode payout method data")

.ok()

.map(|v| {

let secret: Secret<String> = Secret::new(v.to_string());

secret

})

.async_lift(|inner| domain_types::encrypt_optional(inner, key))

.await

}

.await

.change_context(errors::ApiErrorResponse::InternalServerError)

.attach_printable("Failed to encrypt payout method data")?

.map(Encryption::from)

.map(|e| e.into_inner())

.map_or(Err(errors::ApiErrorResponse::InternalServerError), |e| {

Ok(hex::encode(e.peek()))

})?;

let payload = StoreLockerReq::LockerGeneric(StoreGenericReq {

merchant_id: &merchant_account.merchant_id,

merchant_customer_id: payout_attempt.customer_id.to_owned(),

enc_data,

});

match payout_method_data {

api_models::payouts::PayoutMethodData::Bank(b) => {

(

payload,

None,

Some(bank.to_owned()),

None,

api_enums::PaymentMethodType::foreign_from(bank.to_owned()),

)

}

api_models::payouts::PayoutMethodData::Wallet(w) => {

(

payload,

None,

None,

Some(wallet.to_owned()),

api_enums::PaymentMethodType::foreign_from(wallet.to_owned()),

)

}

}

}

};

Encryption of data is done the same way for both banks and wallets, so we can merge the steps

kashif-m · 2024-02-01T09:53:07Z

migrations/2024-01-30-090815_alter_payout_type/down.sql

@@ -0,0 +1,2 @@
+-- This file should undo anything in `up.sql`
+SELECT 1;


Is this supposed to be this?

Yes, it is the default case since we don't necessarily need to rollback for a type alter👍

kashif-m

Added minor comments. I don't see provision for storing wallet details in payment_methods table, let's do it as a separate task in a separate PR?

ArjunKarthik · 2024-02-05T17:14:38Z

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

    merchant_account: Secret<String>,
-    bank: PayoutBankDetails,
+    bank: Option<PayoutBankDetails>,
+    additional_data: Option<PayoutAdditionalData>,


Let's create enums for payment method data instead of making all fields optional

ArjunKarthik · 2024-02-05T17:19:12Z

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

+                    shopper_reference: item.router_data.merchant_id.to_owned(),
+                    shopper_email: customer_email,
+                    shopper_name: ShopperName {
+                        first_name: address.get_first_name().ok().cloned(),


Don't we need to throw missing field error in case of first_name and last_name none?

Since it is a mandatory field, error propagation is enabled now

feat: add wallet to payout

6a7b756

Sakilmostak requested review from ArjunKarthik and kashif-m January 30, 2024 13:56

Sakilmostak self-assigned this Jan 30, 2024

Sakilmostak requested review from a team as code owners January 30, 2024 13:56

Sakilmostak added 5 commits January 30, 2024 19:28

Merge branch 'main' into payout_wallet

0d7b811

refactor: update down.sql in migration

7e5aaad

refactor: openapi_spec

4417765

refactor: api contract and add wasm changes

e6f5322

refactor: openapi_spec generation

f5dc0bf

Sakilmostak requested a review from a team as a code owner January 31, 2024 08:01

refactor: remove swagger-cli module

55ff734

kashif-m reviewed Feb 1, 2024

View reviewed changes

Sakilmostak added 2 commits February 1, 2024 18:09

refactor: comments

01a0dbf

refactor: resolve comments

39efec8

kashif-m previously approved these changes Feb 1, 2024

View reviewed changes

ArjunKarthik requested changes Feb 5, 2024

View reviewed changes

refactor: comments

6862ffe

Sakilmostak dismissed kashif-m’s stale review via 6862ffe February 6, 2024 07:51

ArjunKarthik approved these changes Feb 6, 2024

View reviewed changes

kashif-m approved these changes Feb 6, 2024

View reviewed changes

sai-harsha-vardhan approved these changes Feb 6, 2024

View reviewed changes

likhinbopanna added this pull request to the merge queue Feb 7, 2024

Merged via the queue into main with commit 3af6aaf Feb 7, 2024
10 of 12 checks passed

likhinbopanna deleted the payout_wallet branch February 7, 2024 07:06

kashif-m mentioned this pull request Feb 13, 2024

[TRACKER] Payouts #3586

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(payouts): Add Wallet to Payouts #3502

feat(payouts): Add Wallet to Payouts #3502

Sakilmostak commented Jan 30, 2024 •

edited

Loading

kashif-m Feb 1, 2024

kashif-m Feb 1, 2024

kashif-m Feb 1, 2024

Sakilmostak Feb 1, 2024

kashif-m left a comment

ArjunKarthik Feb 5, 2024

ArjunKarthik Feb 5, 2024

Sakilmostak Feb 6, 2024

		@@ -0,0 +1,2 @@
		-- This file should undo anything in `up.sql`
		SELECT 1;

feat(payouts): Add Wallet to Payouts #3502

feat(payouts): Add Wallet to Payouts #3502

Conversation

Sakilmostak commented Jan 30, 2024 • edited Loading

Type of Change

Description

Additional Changes

How did you test it?

Checklist

kashif-m Feb 1, 2024

Choose a reason for hiding this comment

kashif-m Feb 1, 2024

Choose a reason for hiding this comment

kashif-m Feb 1, 2024

Choose a reason for hiding this comment

Sakilmostak Feb 1, 2024

Choose a reason for hiding this comment

kashif-m left a comment

Choose a reason for hiding this comment

ArjunKarthik Feb 5, 2024

Choose a reason for hiding this comment

ArjunKarthik Feb 5, 2024

Choose a reason for hiding this comment

Sakilmostak Feb 6, 2024

Choose a reason for hiding this comment

Sakilmostak commented Jan 30, 2024 •

edited

Loading