feat(connector): [Stancer] Add authorize flow for Stancer #2876

beaujean · 2023-11-15T11:31:10Z

Type of Change

Description

Stancer has a clear API with great documentation available here https://wearestancer.gitlab.io/doc/en/API.html

Additional Changes

This PR modifies the API contract
This PR is a first step to adds a new PSP integration
This PR modifies the database schema
This PR modifies application configuration/environment variables

Motivation and Context

Stancer is a new PSP and it desserve its connector in hyperswitch as it is a simple, reliable and cost efficient and transparent payment API. Stancer provides card and SEPA Direct Debit payments methods.
See https://www.stancer.com/

How did you test it?

Tested with the unit tested provided in the project

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

config/config.example.toml

config/development.toml

config/docker_compose.toml

crates/api_models/src/enums.rs

crates/router/tests/connectors/sample_auth.toml

crates/test_utils/src/connector_auth.rs

prasunna09 · 2023-11-16T07:08:33Z

crates/router/src/connector/stancer.rs

+    }
+
+    fn get_url(&self, _req: &types::PaymentsAuthorizeRouterData, _connectors: &settings::Connectors,) -> CustomResult<String,errors::ConnectorError> {
+        Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into())


Can you please implement this get_url function, as this will return the end point of the api call.

prasunna09 · 2023-11-16T07:11:31Z

crates/router/src/connector/stancer.rs

+            .change_context(errors::ConnectorError::FailedToObtainAuthType)?;
+        Ok(vec![(
+            headers::AUTHORIZATION.to_string(),
+            format!("Bearer {}", auth.api_key.expose()).into_masked(),


Suggested change

format!("Bearer {}", auth.api_key.expose()).into_masked(),

format!("Basic {}", auth.api_key.expose()).into_masked(),

According to documentation, stancer uses Basic Authentication.

prasunna09 · 2023-11-16T07:20:35Z

crates/router/src/connector/stancer.rs

+}
+
+impl
+    ConnectorIntegration<api::PSync, types::PaymentsSyncData, types::PaymentsResponseData>


@beaujean Are you willing to work on this PSync, as this is required to retrieve payments.
you can refer here - get-payment-data

prasunna09 · 2023-11-16T07:44:07Z

@beaujean Could you please resolve the conflicts?

SamraatBansal

Hey @beaujean !
Thanks for raising this amazing PR and we appreciate your contribution in Hyperswitch.

We have added some comments (Mostly to avoid errors at compile time and follow coding best-practices). Will merge into our codebase once these are addressed.

Also would suggest you to run cargo c to get the compile time warnings and errors in your systems and address those.
Also please make sure the request and response fields type are matching with what Stancer is accepting, e.g: Stancer expects a String in case of amount

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

SamraatBansal · 2023-11-16T10:31:01Z

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

+        Ok(Self {
+            amount,
+            router_data: item,
+        })


Since Stancer accepts in String, transform the type using the below utils function

Suggested change

Ok(Self {

amount,

router_data: item,

})

let amount = utils::get_amount_as_string(currency_unit, amount, currency)?;

Ok(Self {

amount,

router_data,

})

SamraatBansal · 2023-11-16T10:31:23Z

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

+    currency: String,
+    auth: Option<StancerAuth>,
+    card: Option<StancerCard>,
+    sepa: Option>StancerSepa>,


Suggested change

sepa: Option>StancerSepa>,

sepa: Option<StancerSepa>,

SamraatBansal · 2023-11-16T10:33:15Z

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

+// Auth Struct
+pub struct StancerAuthType {
+    pub(super) api_key: Secret<String>
+    pub(super) api_secret: Secret<String>,


No need of this field api_secret, since Stancer only uses 1 key.

SamraatBansal · 2023-11-16T10:36:57Z

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

+
+#[derive(Default, Debug, Serialize, Eq, PartialEq)]
+pub struct StancerPaymentsRequest {
+    amount: i32,


As per Stancer docs it accepts String in PaymentsRequest Body

Suggested change

amount: i32,

amount: String,

SamraatBansal · 2023-11-16T10:56:16Z

crates/router/src/connector/stancer.rs

+        Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into())
+    }


Please add the appropriate endpoint url required to be called for a Refund Request to Stancer

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

SamraatBansal · 2023-11-16T11:00:05Z

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

+        Ok(Self {
+            amount: item.amount.to_owned(),
+        })


Suggested change

Ok(Self {

amount: item.amount.to_owned(),

})

Ok(Self {

amount: item.amount.to_owned(),

payment:item.router_data.request.connector_transaction_id.clone(),

})

SamraatBansal · 2023-11-16T11:01:00Z

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

+pub enum RefundStatus {
+    Failed,
+    Not_Honored,
+    Refund_Sent,
+    Refunded,
+    #[default]
+    To_Refund,
+}


Suggested change

pub enum RefundStatus {

Failed,

Not_Honored,

Refund_Sent,

Refunded,

#[default]

To_Refund,

}

#[serde(rename_all = 'snake_case']

pub enum RefundStatus {

Failed,

NotHonored,

RefundSent,

Refunded,

#[default]

ToRefund,

}

SamraatBansal · 2023-11-16T11:01:25Z

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

+pub struct RefundResponse {
+    id: String,
+    status: RefundStatus
+    amount: i32,


Suggested change

amount: i32,

amount: String,

… issues

(cherry picked from commit 31c08e0406c0f6d410833ec5c0d4bc2fb2dbaceb)

(cherry picked from commit e5245ec46461582117923822afa0a52ccdde7951)

(cherry picked from commit 2282207dd9a93169cfe9da1daed72d9178f4d05a)

(cherry picked from commit 35fcb6c7ee4af951e8e89415ce061a30e375ce3e)

(cherry picked from commit 1a5e442b45bf28107eec773614f6817c376b8e1c)

(cherry picked from commit 6eda4ca28d00d0325438c6b92bef72451cc66864)

(cherry picked from commit 477a2c5148603421039be81db666be9323d842b1)

(cherry picked from commit 2347c7588d56d8910e03d6b6339ede2c3225b83f)

(cherry picked from commit fa17be77d46f3bfa7caeb8981093284f0efd8576)

(cherry picked from commit 17bb0bec52c4b2e17ad8e411552555f5ce0e0525)

(cherry picked from commit 96ba6ce1cf0618f112ff5b139788b4e6bedafc07)

rsecob · 2023-11-27T14:47:33Z

@SamraatBansal @prasunna09 Could we have a review please 🙏

prasunna09 · 2024-01-31T09:20:13Z

config/config.example.toml

@@ -220,6 +220,7 @@ shift4.base_url = "https://api.shift4.com/"
 signifyd.base_url = "https://api.signifyd.com/"
 square.base_url = "https://connect.squareupsandbox.com/"
 square.secondary_base_url = "https://pci-connect.squareupsandbox.com/"
+stancer.base_url = "https://api.stancer.com/"


since prod base url and sbx url is same,
we can add a note in wasm dashboard that api keys for test env starts with stest_xxx and for prod env starts with sprod_xxx to avoid making a actual payment in sbx if prod keys are configured.

Of course, where is the wasm dashboard?

prasunna09 · 2024-01-31T09:25:13Z

crates/common_enums/src/enums.rs

@@ -151,6 +151,7 @@ pub enum RoutableConnectors {
    Shift4,
    Signifyd,
    Square,
+    Stancer,


can we comment this out as this connector is not tested end to end

Does this make this connector unusable?

prasunna09 · 2024-01-31T09:28:30Z

crates/router/src/connector/stancer.rs

+        Ok(format!(
+            "{}{}/{}",
+            self.base_url(_connectors),
+            "v1/checkout",
+            req.request.get_connector_transaction_id()?
+        ))


Suggested change

Ok(format!(

"{}{}/{}",

self.base_url(_connectors),

"v1/checkout",

req.request.get_connector_transaction_id()?

))

Ok(format!(

"{}v1/checkout/{}",

self.base_url(_connectors),

req.request.get_connector_transaction_id()?

))

prasunna09 · 2024-01-31T09:30:51Z

crates/router/src/connector/stancer.rs

+            status_code: res.status_code,
+            code: error_type,
+            message: message.to_string(),
+            reason: None,


populate the error reason with error message.

prasunna09 · 2024-01-31T09:30:53Z

crates/router/src/connector/stancer.rs

+            message: message.to_string(),
+            reason: None,
+            attempt_status: None,
+            connector_transaction_id: None,


do they send connector_transaction_id in error_response? if yes, pls update this.

prasunna09 · 2024-01-31T09:45:04Z

crates/router/src/connector/stancer.rs

+        _req: &types::RefundsRouterData<api::Execute>,
+        _connectors: &settings::Connectors,
+    ) -> CustomResult<String, errors::ConnectorError> {
+        Ok(format!("{}{}", self.base_url(_connectors), "v1/refunds"))


Suggested change

Ok(format!("{}{}", self.base_url(_connectors), "v1/refunds"))

Ok(format!("{}v1/refunds", self.base_url(_connectors)))

prasunna09 · 2024-01-31T09:46:03Z

crates/router/src/connector/stancer.rs

+        Ok(format!(
+            "{}{}/{}",
+            self.base_url(connectors),
+            "v1/refunds",
+            req.request.get_connector_refund_id()?
+        ))


Suggested change

Ok(format!(

"{}{}/{}",

self.base_url(connectors),

"v1/refunds",

req.request.get_connector_refund_id()?

))

Ok(format!(

"{}v1/refunds/{}",

self.base_url(connectors),

req.request.get_connector_refund_id()?

))

prasunna09 · 2024-01-31T09:48:51Z

crates/router/src/connector/stancer.rs

+                .set_body(types::RefundSyncType::get_request_body(
+                    self, req, connectors,
+                )?)


please remove this set_body method since there is no get_request_body func for rsync. by default it would give an empty object instead of body being None

prasunna09 · 2024-01-31T09:51:30Z

crates/router/src/connector/stancer.rs

+    ) -> CustomResult<types::RefundSyncRouterData, errors::ConnectorError> {
+        let response: Refund = res
+            .response
+            .parse_struct("stancer Refund")


Suggested change

.parse_struct("stancer Refund")

.parse_struct("stancer RefundSync")

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

SamraatBansal · 2024-01-07T17:43:36Z

crates/router/src/connector/stancer.rs

+            headers::AUTHORIZATION.to_string(),
+            format!(
+                "Basic {}",
+                consts::BASE64_ENGINE.encode(format!("{}:", auth.api_key.peek()))


Is this expected to encode api_key:, if this : is not required please remove this

SamraatBansal · 2024-02-15T08:27:55Z

crates/common_enums/src/enums.rs

@@ -151,6 +151,7 @@ pub enum RoutableConnectors {
    Shift4,
    Signifyd,
    Square,
+    // Stancer,


No need to comment, it is not a template draft PR, we have the implementation of the connector.

Suggested change

// Stancer,

Stancer,

SamraatBansal · 2024-02-18T14:29:07Z

crates/router/src/connector/stancer.rs

+    async fn execute_pretasks(
+        &self,
+        router_data: &mut types::PaymentsAuthorizeRouterData,
+        app_state: &routes::AppState,
+    ) -> CustomResult<(), errors::ConnectorError> {
+        if let (api::PaymentMethodData::Card { .. }, enums::AuthenticationType::ThreeDs) = (
+            &router_data.request.payment_method_data,
+            &router_data.auth_type,
+        ) {
+            let types::RouterData { response, .. } = services::execute_connector_processing_step(
+                app_state,
+                Box::new(self),
+                router_data,
+                payments::CallConnectorAction::Trigger,
+                None,
+            )
+            .await?;
+            let response: types::PaymentsResponseData = response.map_err(|err| {
+                errors::ConnectorError::UnexpectedResponseError(err.message.into())
+            })?;
+
+            if let types::PaymentsResponseData::ThreeDSEnrollmentResponse {
+                enrolled_v2: three_ds_enrolled,
+                ..
+            } = response
+            {
+                router_data.request.enrolled_for_3ds = three_ds_enrolled;
+            }
+        }
+
+        Ok(())
+    }


To run execute_pretask() function, it is suggested to execute InitPayment flow please refer to airwallex.rs or shift4.rs

SamraatBansal · 2024-02-18T14:34:51Z

crates/router/src/core/payments/flows.rs

@@ -335,6 +337,7 @@ default_imp_for_create_customer!(
    connector::Shift4,
    connector::Signifyd,
    connector::Square,
+    // connector::Stancer,


You can remove this line all together rather than commenting it out.

Suggested change

// connector::Stancer,

SamraatBansal · 2024-02-20T09:36:39Z

Hey @rsecob !

We have commented a set of changes that are required, Can you please address those.

Thanks and Regards

Aurélien Beaujean added 5 commits November 2, 2023 20:46

add_connector.sh inital commit

7bcdf45

Stancer API handles amount in lower unit (cents)

3968eb6

Enable capture methods as automatic, manual, manual multiple

13e78e4

Bearer token API auth

8cc578b

Fill Stancer structs

ed3ceda

beaujean requested review from a team as code owners November 15, 2023 11:31

github-actions bot added the S-conventions-not-followed Status: This PR does not follow contributing guidelines label Nov 15, 2023

prasunna09 changed the title ~~Stancer~~ feat(connector): [Stancer] Add authorize flow for Stancer. Nov 16, 2023

github-actions bot removed the S-conventions-not-followed Status: This PR does not follow contributing guidelines label Nov 16, 2023

prasunna09 changed the title ~~feat(connector): [Stancer] Add authorize flow for Stancer.~~ feat(connector): [Stancer] Add authorize flow for Stancer Nov 16, 2023

prasunna09 requested changes Nov 16, 2023

View reviewed changes

prasunna09 assigned beaujean Nov 16, 2023

prasunna09 added A-connector-integration Area: Connector integration C-feature Category: Feature request or enhancement S-waiting-on-review Status: This PR has been implemented and needs to be reviewed labels Nov 16, 2023

SamraatBansal requested changes Nov 16, 2023

View reviewed changes

Aurélien Beaujean and others added 10 commits November 20, 2023 13:40

maintain alphabetical order

9d0e640

fix issie from add_connector.sh

72e8bc8

maintain alphabetical order

258c64c

maintain alphabetical order

08c1f3e

fix typos

748eb2a

useless use of snake_case

0c3f9de

merge main

5860d47

add connector stancer with add_connector script + fix compilation…

1dfed33

… issues

add stancer models

d84f499

set currency unit + format auth headers

56ad320

(cherry picked from commit 31c08e0406c0f6d410833ec5c0d4bc2fb2dbaceb)

rsecob added 10 commits November 23, 2023 22:09

implement ConnectorValidation

6dc83d6

(cherry picked from commit e5245ec46461582117923822afa0a52ccdde7951)

add generic error response

28a4370

(cherry picked from commit 2282207dd9a93169cfe9da1daed72d9178f4d05a)

change amount type in router data + transform CreatePaymentRequest

513fa44

(cherry picked from commit 35fcb6c7ee4af951e8e89415ce061a30e375ce3e)

tranform Payment

e810e25

(cherry picked from commit 1a5e442b45bf28107eec773614f6817c376b8e1c)

tranform Refund

2a55bba

(cherry picked from commit 6eda4ca28d00d0325438c6b92bef72451cc66864)

update get_url for authorize flow

bb921d9

(cherry picked from commit 477a2c5148603421039be81db666be9323d842b1)

update url for payment sync flow

8628f97

(cherry picked from commit 2347c7588d56d8910e03d6b6339ede2c3225b83f)

transform UpdatePaymentRequest + update impl of capture flow

611865e

(cherry picked from commit fa17be77d46f3bfa7caeb8981093284f0efd8576)

update url for refund & refund sync flows

691123a

(cherry picked from commit 17bb0bec52c4b2e17ad8e411552555f5ce0e0525)

add ConnectorCustomer flow

4c9d433

(cherry picked from commit 96ba6ce1cf0618f112ff5b139788b4e6bedafc07)

rsecob requested a review from a team as a code owner November 24, 2023 03:12

rsecob added 2 commits November 24, 2023 01:04

remove duplicated urls

c388b27

downgrade 3ds request if not enrolled

1eea005

swangi-kumari added 5 commits January 18, 2024 13:24

Merge branch 'main' into stancer

b86aa9a

refactor: resolved conflicts and errors

dc71bd0

refactor: merged model.rs file in transformers.rs

fc589e7

refactor: resolve clippy warnings and openspecs

64017e2

Merge branch 'main' into stancer

f12d2d8

prasunna09 requested changes Jan 31, 2024

View reviewed changes

rsecob added 2 commits February 1, 2024 13:33

address comments

e13ce0f

comment connector

7de44d0

SamraatBansal requested changes Feb 19, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(connector): [Stancer] Add authorize flow for Stancer #2876

feat(connector): [Stancer] Add authorize flow for Stancer #2876

beaujean commented Nov 15, 2023

prasunna09 Nov 16, 2023 •

edited

Loading

prasunna09 Nov 16, 2023

prasunna09 Nov 16, 2023

prasunna09 commented Nov 16, 2023

SamraatBansal left a comment •

edited

Loading

SamraatBansal Nov 16, 2023

SamraatBansal Nov 16, 2023

SamraatBansal Nov 16, 2023

SamraatBansal Nov 16, 2023

SamraatBansal Nov 16, 2023

SamraatBansal Nov 16, 2023

SamraatBansal Nov 16, 2023

SamraatBansal Nov 16, 2023

rsecob commented Nov 27, 2023

prasunna09 Jan 31, 2024

rsecob Feb 1, 2024

prasunna09 Jan 31, 2024

rsecob Feb 1, 2024

prasunna09 Jan 31, 2024

prasunna09 Jan 31, 2024

prasunna09 Jan 31, 2024

prasunna09 Jan 31, 2024

prasunna09 Jan 31, 2024

prasunna09 Jan 31, 2024

prasunna09 Jan 31, 2024

SamraatBansal Jan 7, 2024

SamraatBansal Feb 15, 2024

SamraatBansal Feb 18, 2024

SamraatBansal Feb 18, 2024

SamraatBansal commented Feb 20, 2024

	format!("Bearer {}", auth.api_key.expose()).into_masked(),
	format!("Basic {}", auth.api_key.expose()).into_masked(),

		Err(errors::ConnectorError::NotImplemented("get_url method".to_string()).into())
		}

	Ok(format!("{}{}", self.base_url(_connectors), "v1/refunds"))
	Ok(format!("{}v1/refunds", self.base_url(_connectors)))

	.parse_struct("stancer Refund")
	.parse_struct("stancer RefundSync")

feat(connector): [Stancer] Add authorize flow for Stancer #2876

Are you sure you want to change the base?

feat(connector): [Stancer] Add authorize flow for Stancer #2876

Conversation

beaujean commented Nov 15, 2023

Type of Change

Description

Additional Changes

Motivation and Context

How did you test it?

Checklist

prasunna09 Nov 16, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

prasunna09 commented Nov 16, 2023

SamraatBansal left a comment • edited Loading

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

rsecob commented Nov 27, 2023

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

SamraatBansal commented Feb 20, 2024

prasunna09 Nov 16, 2023 •

edited

Loading

SamraatBansal left a comment •

edited

Loading