feat(payout): [Payone] add payone connector #4553

KiranKBR · 2024-05-06T06:16:03Z

Type of Change

Description

Merchant Connector:

--header 'Content-Type: application/json' \
--header 'api-key: test_admin' \
--data '{
    "connector_type": "payout_processor",
    "connector_name": "payone",
    "connector_account_details": {
        "auth_type": "SignatureKey",
        "api_key": "",
        "api_secret": "",
        "key1": ""
    },
    "test_mode": false,
    "disabled": false,
    "business_country": "US",
    "business_label": "default",
    "payment_methods_enabled": [
        {
            "payment_method": "card",
            "payment_method_types": [
                {
                    "payment_method_type": "credit",
                    "card_networks": [
                        
                
                        "Mastercard",
                        "Visa"
                    ],
                    "minimum_amount": 1,
                    "maximum_amount": 68607706,
                    "recurring_enabled": true,
                    "installment_payment_enabled": true
                },
                {
                    "payment_method_type": "debit",
                    "card_networks": [
                        "AmericanExpress",
                        "Discover",
                        "Interac",
                        "JCB",
                        "Mastercard",
                        "Visa",
                        "DinersClub",
                        "UnionPay",
                        "RuPay"
                    ],
                    "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": false,
                    "installment_payment_enabled": false
                }
            ]
        }
    ],
    "metadata": {
        "city": "NY",
        "unit": "245"
    }
}'

response:

{
    "connector_type": "payout_processor",
    "connector_name": "payone",
    "connector_label": "payone_US_default",
    "merchant_connector_id": "mca_Rufh4UB4ctrHhOV8JQzG",
    "profile_id": "pro_cp4l2sD7NggkM66Cvrfz",
    "connector_account_details": {
        "auth_type": "SignatureKey",
        "api_key": "",
        "api_secret": "",
        "key1": ""
    },
    "payment_methods_enabled": [
        {
            "payment_method": "card",
            "payment_method_types": [
                {
                    "payment_method_type": "credit",
                    "payment_experience": null,
                    "card_networks": [
                        "Mastercard",
                        "Visa"
                    ],
                    "accepted_currencies": null,
                    "accepted_countries": null,
                    "minimum_amount": 1,
                    "maximum_amount": 68607706,
                    "recurring_enabled": true,
                    "installment_payment_enabled": true
                },
                {
                    "payment_method_type": "debit",
                    "payment_experience": null,
                    "card_networks": [
                        "AmericanExpress",
                        "Discover",
                        "Interac",
                        "JCB",
                        "Mastercard",
                        "Visa",
                        "DinersClub",
                        "UnionPay",
                        "RuPay"
                    ],
                    "accepted_currencies": null,
                    "accepted_countries": null,
                    "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",
                    "card_networks": null,
                    "accepted_currencies": null,
                    "accepted_countries": null,
                    "minimum_amount": 1,
                    "maximum_amount": 68607706,
                    "recurring_enabled": false,
                    "installment_payment_enabled": false
                }
            ]
        }
    ],
    "connector_webhook_details": null,
    "metadata": {
        "city": "NY",
        "unit": "245"
    },
    "test_mode": false,
    "disabled": false,
    "frm_configs": null,
    "business_country": "US",
    "business_label": "default",
    "business_sub_label": null,
    "applepay_verified_domains": null,
    "pm_auth_config": null,
    "status": "active"
}

Payout Creation:

{
    "amount": 100,
    "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": "card",
    "payout_method_data": {
        "card": {
            "card_number": "4012000033330026",
            "expiry_month": "05",
            "expiry_year": "30",
            "card_holder_name": "John Smith"
        }
    },
    "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"
    },
        "business_country": "US",
    "business_label": "default",
    // "routing": {
    //     "type": "single",
    //     "data": "adyen"
    // },
    "auto_fulfill": true,
    "confirm": true
}

response:

{
    "payout_id": "5ec9e6ac-1bbc-4236-a217-e0ff890e7f2e",
    "merchant_id": "merchant_1715339934",
    "amount": 100,
    "currency": "EUR",
    "connector": "payone",
    "payout_type": "card",
    "billing": {
        "address": {
            "city": "San Fransico",
            "country": "US",
            "line1": "1467",
            "line2": "Harrison Street",
            "line3": "Harrison Street",
            "zip": "94122",
            "state": "NY",
            "first_name": "John",
            "last_name": "Doe"
        },
        "phone": {
            "number": "8056594427",
            "country_code": "+91"
        },
        "email": null
    },
    "customer_id": "payout_customer",
    "auto_fulfill": true,
    "email": "payout_customer@example.com",
    "name": "John Doe",
    "phone": "999999999",
    "phone_country_code": "+65",
    "client_secret": null,
    "return_url": null,
    "business_country": "US",
    "business_label": "default",
    "description": "Its my first payout request",
    "entity_type": "Individual",
    "recurring": false,
    "metadata": {
        "ref": "123"
    },
    "status": "success",
    "error_message": null,
    "error_code": null,
    "profile_id": "pro_cp4l2sD7NggkM66Cvrfz",
    "created": "2024-05-10T11:25:54.497Z"
}

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?

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

Sakilmostak · 2024-05-06T18:19:47Z

Required CI checks are failing, could you address that

…one-payout-flows

Sakilmostak · 2024-05-15T07:36:54Z

crates/router/src/connector/payone.rs

+            date_header.trim(),
+            canonicalized_path.trim()
+        );
+        println!("{string_to_hash:?}");


Remove this print statement

Sakilmostak · 2024-05-15T07:42:50Z

crates/router/src/connector/payone.rs

+pub fn get_current_date_time() -> CustomResult<String, errors::ConnectorError> {
+    let format = format_description::parse(
+        "[weekday repr:short], [day] [month repr:short] [year] [hour]:[minute]:[second] GMT",
+    )
+    .change_context(errors::ConnectorError::InvalidDateFormat)?;
+    OffsetDateTime::now_utc()
+        .format(&format)
+        .change_context(errors::ConnectorError::InvalidDateFormat)
+}


Please move this into utils

Please create the utils function in an generalized manner so that the format can be passed as an argument. @KiranKBR

Sakilmostak · 2024-05-15T07:53:45Z

crates/router/src/connector/payone.rs

-            req,
-        ))?;
-        let connector_req = payone::PayoneRefundRequest::try_from(&connector_router_data)?;
+        let connector_req = payone::PayonePayoutFulfillRequest::try_from(req)?;


Create PayoneRouterData first, then create request body

Suggested change

let connector_req = payone::PayonePayoutFulfillRequest::try_from(req)?;

let connector_router_data = payone::PayoneRouterData::try_from((

&self.get_currency_unit(),

req.request.destination_currency,

req.request.amount,

req,

))?;

let connector_req = payone::PayonePayoutFulfillRequest::try_from(&connector_router_data)?;

not required

Sakilmostak · 2024-05-15T09:44:52Z

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

 }

 impl TryFrom<&types::ConnectorAuthType> for PayoneAuthType {
    type Error = error_stack::Report<errors::ConnectorError>;
    fn try_from(auth_type: &types::ConnectorAuthType) -> Result<Self, Self::Error> {
-        match auth_type {
-            types::ConnectorAuthType::HeaderKey { api_key } => Ok(Self {
+        if let types::ConnectorAuthType::SignatureKey {


Use match statement instead of if let to for the ConnectorAuthType and state all the enums to know explicitly what we are handling

Sakilmostak · 2024-05-15T09:50:07Z

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

+impl Card {
+    fn get_card_issuer(&self) -> Result<CardIssuer, Error> {
+        for (k, v) in CARD_REGEX.iter() {
+            let regex: Regex = v
+                .clone()
+                .change_context(errors::ConnectorError::RequestEncodingFailed)?;
+            if regex.is_match(self.card_number.clone().get_card_no().as_str()) {
+                return Ok(*k);
+            }
+        }
+        Err(error_stack::Report::new(
+            errors::ConnectorError::NotImplemented("Card Type".into()),
+        ))
    }
 }


Remove this and use the one from utils

Sakilmostak · 2024-05-15T10:00:32Z

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

-                refund_status: enums::RefundStatus::from(item.response.status),
+            response: Ok(types::PayoutsResponseData {
+                status: Some(storage_enums::PayoutStatus::foreign_from(response.status)),
+                connector_payout_id: "".to_string(),


Suggested change

connector_payout_id: "".to_string(),

connector_payout_id: response.id,

You can provide the id present in response as connector_payout_id

…one-payout-flows

SamraatBansal · 2024-05-19T17:48:12Z

crates/router/src/connector/utils.rs

@@ -1096,6 +1096,7 @@ pub trait CardData {
    fn get_expiry_date_as_mmyyyy(&self, delimiter: &str) -> Secret<String>;
    fn get_expiry_year_4_digit(&self) -> Secret<String>;
    fn get_expiry_date_as_yymm(&self) -> Result<Secret<String>, errors::ConnectorError>;
+    fn get_expiry_date_as_mmyy(&self) -> Result<Secret<String>, errors::ConnectorError>;


No need of this util, you can use this function get_card_expiry_month_year_2_digit_with_delimiter

SamraatBansal · 2024-05-19T17:48:38Z

crates/router/src/core/admin.rs

+        api_enums::Connector::Payone => {
+            payone::transformers::PayoneAuthType::try_from(val)?;
+            Ok(())
+        }


Please place this in alphabetical order

SamraatBansal · 2024-05-19T17:49:48Z

crates/router/tests/connectors/payone.rs

            connector: Box::new(&Payone),
            connector_name: types::Connector::Adyen,


I suppose you need to change the name to Payone

Suggested change

connector: Box::new(&Payone),

connector_name: types::Connector::Adyen,

connector: Box::new(&Payone),

connector_name: types::Connector::Payone,

SamraatBansal · 2024-05-19T17:53:39Z

crates/connector_configs/src/connector.rs

@@ -282,6 +285,7 @@ impl ConnectorConfig {
            Connector::Noon => Ok(connector_data.noon),
            Connector::Nuvei => Ok(connector_data.nuvei),
            Connector::Payme => Ok(connector_data.payme),
+            Connector::Payone => Err("Use get_payout_connector_config".to_string()),


What is the difference between Ebanx and Payone? why are we throwing error here?

SamraatBansal · 2024-05-19T18:01:05Z

crates/router/src/connector/payone.rs

+pub fn get_current_date_time() -> CustomResult<String, errors::ConnectorError> {
+    let format = format_description::parse(
+        "[weekday repr:short], [day] [month repr:short] [year] [hour]:[minute]:[second] GMT",
+    )
+    .change_context(errors::ConnectorError::InvalidDateFormat)?;
+    OffsetDateTime::now_utc()
+        .format(&format)
+        .change_context(errors::ConnectorError::InvalidDateFormat)
+}


Please create the utils function in an generalized manner so that the format can be passed as an argument. @KiranKBR

SamraatBansal · 2024-05-19T18:19:55Z

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

+                    currency_code: item.router_data.request.destination_currency.to_string(),
+                };
+                let _card_issuer =
+                    CardAndCardIssuer::try_from(&item.router_data.get_payout_method_data()?)?;


This try_from is not required rather add a match on payment_method_data and then impl a try_from to return the whole Object card_payout_method_specific_input

SamraatBansal · 2024-05-19T18:21:58Z

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

+
+                let card_payout_method_specific_input: CardPayoutMethodSpecificInput =
+                    CardPayoutMethodSpecificInput {
+                        #[allow(clippy::as_conversions)]


Why is this lint added?

SamraatBansal · 2024-05-19T18:22:53Z

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

+        match issuer {
+            CardIssuer::Master => Ok(Self::MasterCard),
+            CardIssuer::Visa => Ok(Self::Visa),
+            _ => Err(errors::ConnectorError::NotImplemented(
+                get_unimplemented_payment_method_error_message("payone"),
+            )
+            .into()),
+        }
+    }
 }


Why are we not covering all the card issuer networks?

SamraatBansal · 2024-05-19T18:23:40Z

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

-            }),
-            ..item.data
-        })
+#[allow(dead_code)]


Why dead_code?

Also Serialize is not required in the derives as this is response.
Please take care of this at all the applicable places

SamraatBansal · 2024-05-19T18:25:15Z

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

+            PayoneStatus::RejectedCredit | PayoneStatus::Rejected => Self::Cancelled,
+            PayoneStatus::Cancelled | PayoneStatus::Reversed => Self::Cancelled,


Suggested change

PayoneStatus::RejectedCredit | PayoneStatus::Rejected => Self::Cancelled,

PayoneStatus::Cancelled | PayoneStatus::Reversed => Self::Cancelled,

PayoneStatus::RejectedCredit | PayoneStatus::Rejected |

PayoneStatus::Cancelled | PayoneStatus::Reversed => Self::Cancelled,

KiranKBR requested review from a team as code owners May 6, 2024 06:16

KiranKBR changed the title ~~(feat) : [Payone Payout] added flows~~ feat(payout): [Payone] May 6, 2024

KiranKBR changed the title ~~feat(payout): [Payone]~~ feat(payout): [Payone] add payone connector May 6, 2024

KiranKBR linked an issue May 7, 2024 that may be closed by this pull request

Fix deserialization errors for sdk_eligible_payment_methods #4566

Closed

2 tasks

KiranKBR added A-connector-integration Area: Connector integration C-feature Category: Feature request or enhancement labels May 7, 2024

KiranKBR self-assigned this May 7, 2024

KiranKBR removed a link to an issue May 7, 2024

Fix deserialization errors for sdk_eligible_payment_methods #4566

Closed

2 tasks

KiranKBR and others added 6 commits May 7, 2024 15:52

added template code for payone

b4474f4

feat: added flows

7cde54e

refactored

c7c1247

chore: run formatter

b0432a0

clippy issues solved

93c5ce0

resolved conflicts

4a9d2b1

KiranKBR force-pushed the payone-payout-flows branch from 59714bb to 4a9d2b1 Compare May 7, 2024 10:59

KiranKBR and others added 2 commits May 8, 2024 11:58

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

1c4a6ac

…one-payout-flows

chore: run formatter

e772fd9

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

KiranKBR added 2 commits May 8, 2024 13:05

resolved MSRV

4b55833

date functions removed

48b86b2

KiranKBR changed the base branch from main to payone-template-code May 8, 2024 09:22

KiranKBR requested review from a team as code owners May 8, 2024 09:22

KiranKBR force-pushed the payone-payout-flows branch from 45c0606 to db1737b Compare May 9, 2024 11:27

MSRV error resolved

1b31b63

KiranKBR force-pushed the payone-payout-flows branch from 625a23c to 1b31b63 Compare May 10, 2024 11:29

unwrap error resolved

d9c8711

KiranKBR force-pushed the payone-payout-flows branch from 6759bf9 to d9c8711 Compare May 10, 2024 12:22

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

82c8fe4

…one-payout-flows

KiranKBR force-pushed the payone-payout-flows branch from 2cf17fd to 82c8fe4 Compare May 13, 2024 10:30

feature config issues solved

25a8001

KiranKBR force-pushed the payone-payout-flows branch from 448e201 to 25a8001 Compare May 13, 2024 10:45

docs(openapi): re-generate OpenAPI specification

15ea5e9

Sakilmostak removed request for a team May 15, 2024 07:33

Sakilmostak reviewed May 15, 2024

View reviewed changes

Sakilmostak requested changes May 15, 2024

View reviewed changes

KiranKBR and others added 8 commits May 16, 2024 15:28

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

038e0c6

…one-payout-flows

comments resolved

88916a8

chore: run formatter

a064c45

Merge branch 'main' into payone-payout-flows

18540e1

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

f4525cc

…one-payout-flows

checks resolved

3ea096a

check issues solved

1aa77fb

chore: run formatter

9b1bf75

KiranKBR requested review from SamraatBansal and Sakilmostak May 17, 2024 06:47

SamraatBansal requested changes May 19, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(payout): [Payone] add payone connector #4553

feat(payout): [Payone] add payone connector #4553

KiranKBR commented May 6, 2024 •

edited

Sakilmostak commented May 6, 2024

Sakilmostak May 15, 2024

Sakilmostak May 15, 2024

SamraatBansal May 19, 2024

Sakilmostak May 15, 2024

KiranKBR May 15, 2024

Sakilmostak May 15, 2024

Sakilmostak May 15, 2024

Sakilmostak May 15, 2024

SamraatBansal May 19, 2024

SamraatBansal May 19, 2024

SamraatBansal May 19, 2024

SamraatBansal May 19, 2024

SamraatBansal May 19, 2024

SamraatBansal May 19, 2024

SamraatBansal May 19, 2024

SamraatBansal May 19, 2024

SamraatBansal May 19, 2024

SamraatBansal May 19, 2024

SamraatBansal May 19, 2024

-        let connector_req = payone::PayonePayoutFulfillRequest::try_from(req)?;
+        let connector_router_data = payone::PayoneRouterData::try_from((
+            &self.get_currency_unit(),
+            req.request.destination_currency,
+            req.request.amount,
+            req,
+        ))?;
+        let connector_req = payone::PayonePayoutFulfillRequest::try_from(&connector_router_data)?;

	connector_payout_id: "".to_string(),
	connector_payout_id: response.id,

		connector: Box::new(&Payone),
		connector_name: types::Connector::Adyen,

		PayoneStatus::RejectedCredit \| PayoneStatus::Rejected => Self::Cancelled,
		PayoneStatus::Cancelled \| PayoneStatus::Reversed => Self::Cancelled,

feat(payout): [Payone] add payone connector #4553

Are you sure you want to change the base?

feat(payout): [Payone] add payone connector #4553

Conversation

KiranKBR commented May 6, 2024 • edited

Type of Change

Description

Additional Changes

Motivation and Context

How did you test it?

Checklist

Sakilmostak commented May 6, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

KiranKBR commented May 6, 2024 •

edited