feat(connector): [Paypal] Add payout flow for wallet(Paypal and Venmo) #4406

Sakilmostak · 2024-04-21T15:49:42Z

Type of Change

Description

Paypal and Venmo wallet is added for payout

Additional Changes

This PR modifies the API contract
Paypal

 "payout_method_data": {
        "wallet": {
            "paypal": {
                "email": "sk.sakil@juspay.in",
                "telephone_number": "16608213349",
                "paypal_id": "G83KXTJ5EHCQ2"
            }
        }
    },

Venmo

 "payout_method_data": {
        "wallet": {
            "venmo": {
                "telephone_number": "16608213349"
            }
        }
    },

Motivation and Context

How did you test it?

Tested through Postman:

Create an MCA(Paypal Payout):

{
    "connector_type": "payout_processor",
    "connector_name": "paypal",
    "connector_account_details": {
        "auth_type": "BodyKey",
        "api_key": "{{api_key}}",
        "key1": "{{key1}}"
    },
    "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": "pay_later",
            "payment_method_types": [
                {
                    "payment_method_type": "klarna",
                    "payment_experience": "redirect_to_url",
                    "minimum_amount": 1,
                    "maximum_amount": 68607706,
                    "recurring_enabled": true,
                    "installment_payment_enabled": true
                },
                {
                    "payment_method_type": "affirm",
                    "payment_experience": "redirect_to_url",
                    "minimum_amount": 1,
                    "maximum_amount": 68607706,
                    "recurring_enabled": true,
                    "installment_payment_enabled": true
                },
                {
                    "payment_method_type": "afterpay_clearpay",
                    "payment_experience": "redirect_to_url",
                    "minimum_amount": 1,
                    "maximum_amount": 68607706,
                    "recurring_enabled": true,
                    "installment_payment_enabled": true
                }
            ]
        },
        {
            "payment_method": "wallet",
            "payment_method_types": [
                {
                    "payment_method_type": "paypal",
                    "payment_experience": "redirect_to_url",
                    "minimum_amount": 1,
                    "maximum_amount": 68607706,
                    "recurring_enabled": true,
                    "installment_payment_enabled": true
                }
                // {
                //     "payment_method_type": "venmo",
                //     "payment_experience": "redirect_to_url",
                //     "minimum_amount": 1,
                //     "maximum_amount": 68607706,
                //     "recurring_enabled": true,
                //     "installment_payment_enabled": true
                // }
            ]
        },
        {
            "payment_method": "bank_transfer",
            "payment_method_types": [
                {
                    "payment_method_type": "sepa",
                    //"payment_experience": "redirect_to_url",
                    "minimum_amount": 1,
                    "maximum_amount": 68607706,
                    "recurring_enabled": true,
                    "installment_payment_enabled": true
                },
                {
                    "payment_method_type": "pix",
                    //"payment_experience": "redirect_to_url",
                    "minimum_amount": 1,
                    "maximum_amount": 68607706,
                    "recurring_enabled": true,
                    "installment_payment_enabled": true
                },
                {
                    "payment_method_type": "bacs",
                    //"payment_experience": "redirect_to_url",
                    "minimum_amount": 1,
                    "maximum_amount": 68607706,
                    "recurring_enabled": true,
                    "installment_payment_enabled": true
                }
            ]
        }
    ],
    "metadata": {
        "merchant_id": "{{merchant_id}}",
        "name": "Mostak"
    },
    "business_country": "US",
    "business_label": "default"
}

Create a Payout:

{
    "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": {
            "paypal": {
                "email": "sk.sakil@juspay.in"
            }
        }
    },
    "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": "NaturalPerson",
    "recurring": false,
    "metadata": {
        "ref": "123"
    },
    "routing": {
        "type": "single",
        "data": "paypal"
    },
    "confirm": true,
    "auto_fulfill": false
}

The status should be requires_fulfillment

Fulfill the payout:

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

The status should be pending

Venmo cant be tested since it is only available in production

Note: This affects only paypal payout flow

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

crates/router/src/connector/paypal.rs

crates/common_enums/src/enums.rs

kashif-m · 2024-04-30T08:57:06Z

crates/api_models/src/payouts.rs

+
+    /// mobile number linked to paypal account
+    #[schema(value_type = String, example = "16608213349")]
+    pub telephone_number: Option<Secret<String>>,


Does it include phone country code as well? eg: +91

kashif-m · 2024-04-30T09:00:45Z

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

@@ -21,6 +23,9 @@ use crate::{
    },
 };

+#[cfg(feature = "payouts")]
+const LANGUAGE: &str = "en-US";


Possible to move this to consts crate? And name it better? PAYPAL_NOTIFICATION_SCRIPT_LANGUAGE ?

kashif-m · 2024-04-30T09:02:40Z

crates/router/src/core/payment_methods/vault.rs

@@ -419,6 +420,9 @@ impl Vaultable for api::CardPayout {
 #[derive(Debug, serde::Serialize, serde::Deserialize)]
 pub struct TokenizedWalletSensitiveValues {
    pub email: Option<Email>,
+    pub telephone_number: Option<masking::Secret<String>>,
+    pub paypal_id: Option<masking::Secret<String>>,


Suggested change

pub paypal_id: Option<masking::Secret<String>>,

pub wallet_id: Option<masking::Secret<String>>,

srujanchikke

Please resolve ci checks, feature flag needs to be added in const.rs

Sakilmostak and others added 12 commits April 15, 2024 19:45

refactor: add configs for payout flows

9d11468

feat: skip payout create for paypal

5ca3f1d

feat: update status for paypal for payout_creation

9e826af

refactor: add configs for payout flows

e0dfa4b

refactor: update condition for payout_object creation

628bdfa

feat: add access_token flow for payout

73e4ecf

docs(openapi): re-generate OpenAPI specification

7cc477b

feat: add seperate access_token module for payouts

e1354a6

refactor: add feature flags for payout specific methods

31794f8

refactor: resolve comments

604297a

chore: run formatter

c2aece2

feat: add payout flow for paypal

f65b2b5

Sakilmostak added A-connector-integration Area: Connector integration C-feature Category: Feature request or enhancement labels Apr 21, 2024

Sakilmostak self-assigned this Apr 21, 2024

Sakilmostak requested review from a team as code owners April 21, 2024 15:49

Sakilmostak changed the base branch from main to payout_access_token_flow April 21, 2024 15:50

Sakilmostak added 4 commits April 21, 2024 21:25

refactor: generate openapi spec

29cd6ab

refactor: resolve ci checks

2a04371

refactor: resolve ci checks

0b4c90e

refactor: resolve ci checks

d9af876

Base automatically changed from payout_access_token_flow to main April 25, 2024 06:47

Sakilmostak and others added 3 commits April 25, 2024 13:03

Merge branch 'main' into paypal_payout

6c5444f

refactor: resolve openapi check

baebc18

docs(openapi): re-generate OpenAPI specification

a98a6e4

kashif-m requested changes Apr 29, 2024

View reviewed changes

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

crates/common_enums/src/enums.rs Outdated Show resolved Hide resolved

refactor: resolve comments

5faa5ca

Sakilmostak added 2 commits April 30, 2024 01:26

refactor: merge main

9997600

refactor: update with main

c2c44b0

Sakilmostak requested review from a team as code owners April 29, 2024 20:31

Merge branch 'main' into paypal_payout

016ec72

Sakilmostak removed request for a team April 29, 2024 20:36

kashif-m previously approved these changes Apr 30, 2024

View reviewed changes

refactor: resolve comments

cb64646

Sakilmostak dismissed kashif-m’s stale review via cb64646 April 30, 2024 11:04

srujanchikke previously approved these changes Apr 30, 2024

View reviewed changes

srujanchikke reviewed Apr 30, 2024

View reviewed changes

refactor: resolve ci checks

fe17397

Sakilmostak dismissed srujanchikke’s stale review via fe17397 May 1, 2024 18:09

srujanchikke approved these changes May 2, 2024

View reviewed changes

kashif-m approved these changes May 2, 2024

View reviewed changes

Narayanbhat166 approved these changes May 2, 2024

View reviewed changes

Chethan-rao approved these changes May 2, 2024

View reviewed changes

Gnanasundari24 added this pull request to the merge queue May 2, 2024

Merged via the queue into main with commit e4ed1e6 May 2, 2024
15 of 18 checks passed

Gnanasundari24 deleted the paypal_payout branch May 2, 2024 10:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(connector): [Paypal] Add payout flow for wallet(Paypal and Venmo) #4406

feat(connector): [Paypal] Add payout flow for wallet(Paypal and Venmo) #4406

Sakilmostak commented Apr 21, 2024 •

edited

kashif-m Apr 30, 2024

Sakilmostak Apr 30, 2024

kashif-m Apr 30, 2024

kashif-m Apr 30, 2024

srujanchikke left a comment •

edited

	pub paypal_id: Option<masking::Secret<String>>,
	pub wallet_id: Option<masking::Secret<String>>,

feat(connector): [Paypal] Add payout flow for wallet(Paypal and Venmo) #4406

feat(connector): [Paypal] Add payout flow for wallet(Paypal and Venmo) #4406

Conversation

Sakilmostak commented Apr 21, 2024 • edited

Type of Change

Description

Additional Changes

Motivation and Context

How did you test it?

Checklist

kashif-m Apr 30, 2024

Choose a reason for hiding this comment

Sakilmostak Apr 30, 2024

Choose a reason for hiding this comment

kashif-m Apr 30, 2024

Choose a reason for hiding this comment

kashif-m Apr 30, 2024

Choose a reason for hiding this comment

srujanchikke left a comment • edited

Choose a reason for hiding this comment

Sakilmostak commented Apr 21, 2024 •

edited

srujanchikke left a comment •

edited