feature(payments-plugin): PayPal two-step flow implementation #3099

sonntag-philipp · 2024-10-01T11:17:47Z

Description

This PR introduces a PayPal payments plugin based on the PayPal Orders Api with a 2 step flow as specified in the Vendure documentation.

The main purpose of this plugin is to offer the user a solution where PayPal can be used directly without a step in between.

Documentation will be added by me before this plugin is merged. Just want to make sure I don't have to change it after review feedback of the implementation.

Breaking changes

I am not able to determine a breaking change. The implemented features represent new functionality and should have no effect on existing implementations.

Overview

Only supports 2 step payments
Dev server contains ui that can be used to test payments
A single mutation is added to create PayPal orders
Integration and unit tests were added and should cover most of the functionality

Screenshots

Checklist

📌 Always:

I have set a clear title
My PR is small and contains a single feature
I have checked my own PR

👍 Most of the time:

I have added or updated test cases
I have updated the README if needed

vercel · 2024-10-01T11:17:51Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
docs	✅ Ready (Inspect)	Visit Preview	Nov 15, 2024 0:44am

packages/payments-plugin/package.json

sonntag-philipp · 2024-10-10T11:32:46Z

.vscode/launch.json

I'm not quite sure if most of the maintainers use WebStorm, but this makes it way easier to execute a specific test file in VSCode.

Also had to make some changes to the get-package-dir to make it work not only for the e2e within the payments-plugin.

packages/payments-plugin/e2e/paypal-dev-server.ts

sonntag-philipp · 2024-10-10T11:37:24Z

packages/payments-plugin/e2e/paypal-dev-server.ts

+    });
+
+    // eslint-disable-next-line no-console
+    console.log('Auth Token: ', shopClient.getAuthToken());


This token is printed, so we can enter it in the Web UI of the paypal plugin. I would be open to setting this automatically in the Vendure REST Endpoint, but I wasn't quite sure how.

sonntag-philipp · 2024-10-10T11:41:25Z

packages/payments-plugin/e2e/paypal-sdk.plugin.ts

+}
+
+// @ts-ignore
+function html(strings, ...values) {


Well. I know we shouldn't integrate code only for syntax highlighting, but as this isn't code of the library itself and only exists for testing purposes, one could argue that it's still okay.
Especially as it doesn't require additional dependencies.

packages/payments-plugin/src/paypal/paypal-authorization.service.ts

packages/payments-plugin/src/paypal/paypal-base.service.ts

sonntag-philipp · 2024-10-10T12:59:20Z

I still have to implement the idempotency headers supported by the PayPal Api, even though it already works without them. This could also be done is a future PR.

packages/payments-plugin/e2e/paypal-dev-server.ts

DanielBiegler · 2024-10-13T11:25:43Z

packages/payments-plugin/src/paypal/paypal.shop-resolver.ts

+        if (!sessionOrder) {
+            throw new IllegalOperationError('Session has no active order');
+        }
+        if (sessionOrder.state !== 'ArrangingPayment') {
+            throw new IllegalOperationError('Order must be in arranging payment state');
+        }


I think these could be internationalized with existing error message for example there are:

"NO_ACTIVE_ORDER_ERROR": "There is no active Order associated with the current session",

and

"ORDER_MODIFICATION_ERROR": "Order contents may only be modified when in the \"AddingItems\" state", "ORDER_PAYMENT_STATE_ERROR": "A Payment may only be added when Order is in \"ArrangingPayment\" state", "ORDER_STATE_TRANSITION_ERROR": "Cannot transition Order from \"{ fromState }\" to \"{ toState }\"",

Might be good to take a second pass over all thrown errors and see what can be internationalized and reused.

Really good feeback, thank you :) Will definetly do that!

sonntag-philipp · 2024-10-14T16:16:56Z

Renamed the commit messages to fit other scopes and rebased on minor branch.

…nt for assertions

…ng parts

sonarqubecloud · 2024-11-15T12:45:19Z

Quality Gate failed

Failed conditions
25.3% Duplication on New Code (required ≤ 3%)

See analysis details on SonarQube Cloud

sonntag-philipp · 2024-11-15T13:03:24Z

packages/payments-plugin/src/paypal/paypal-authorization.service.ts

+
+            return (await response.json()) as PayPalOrderInformation;
+        } catch (error: any) {
+            const message = 'error.paypal-authorization-details-failed';


Even though SonarQube already mentioned this code is often duplicated, I want to make sure that errors are correctly handled this way in Vendure. Maybe you guys have some feedback on this :)

sonntag-philipp · 2024-11-15T13:05:29Z

I've added a small documentation on how to get started using this plugin. Reviews are welcome right now :)

@michaelbromley @taxilian

dfernandesbsolus · 2025-06-04T13:29:11Z

@michaelbromley @sonntag-philipp Hey guys, is this pr outdated? This plugin would be a great complement to Braintree which is not available in many countries.

michaelbromley · 2025-06-05T07:52:15Z

Hi @sonntag-philipp - apologies for the long time with no response on this. We'd be interested in getting this merged for the next minor release, v3.4. The conflicts look rather minor, would you have a bit of time to get that resolved?

If not, let me know and one of us can take that on.

sonntag-philipp · 2025-06-05T08:01:35Z

@michaelbromley Oh, I thought the PR was "dismissed" (or something like that) so I moved the PayPal package to my local workspace (without relevant changes) :D

I don't have much time until at least Monday, so I could fix the conflicts until Tuesday next week. If you need it more early for the 3.4 minor release, feel free to work on that :)

michaelbromley · 2025-06-11T11:18:16Z

@sonntag-philipp there's no rush on this. We're looking around the end of June for the 3.4 release.

No, the PR was not dismissed - we just dropped the ball on the communication front with all the things we have going on.

sonntag-philipp · 2025-06-12T11:52:41Z

Sorry guys, I have to meet a deadline on another project. This PR has to wait some more time.

Just the merge would not be the problem, but I think I do not I will be able to respond somewhat fast on issues that occur when this plugin is used.

At least until the end of july I will not be able to spend much time on this.

@michaelbromley

vjung28 · 2025-08-20T08:15:56Z

packages/payments-plugin/src/paypal/paypal.plugin.ts

+    },
+    compatibility: '^3.0.0',
+    adminApiExtensions: {
+        schema: shopSchemaExtensions,


isn't the shop and admin schema swapped here?

true! good catch

dlhck · 2025-11-03T17:57:19Z

@sonntag-philipp I would really like to get this PR merged as it is a great improvement. Do you know if you can spend some more time to finish this? Please let me know.

larsdecker · 2025-11-11T11:27:45Z

Any news on this topic? It would be really good to see a Paypal Integration in Vendure.

vercel bot deployed to Preview October 1, 2024 11:21 View deployment

sonntag-philipp commented Oct 1, 2024

View reviewed changes

packages/payments-plugin/package.json Outdated Show resolved Hide resolved

vercel bot deployed to Preview October 1, 2024 16:50 View deployment

vercel bot deployed to Preview October 3, 2024 10:50 View deployment

vercel bot deployed to Preview October 8, 2024 13:12 View deployment

vercel bot deployed to Preview October 8, 2024 19:28 View deployment

sonntag-philipp changed the title ~~Feature/payments plugin paypal~~ feature(payments-plugin): Create PayPal integration without Braintree Oct 8, 2024

vercel bot deployed to Preview October 10, 2024 11:32 View deployment

sonntag-philipp commented Oct 10, 2024

View reviewed changes

packages/payments-plugin/e2e/paypal-dev-server.ts Show resolved Hide resolved

sonntag-philipp commented Oct 10, 2024

View reviewed changes

packages/payments-plugin/src/paypal/paypal-authorization.service.ts Outdated Show resolved Hide resolved

sonntag-philipp commented Oct 10, 2024

View reviewed changes

packages/payments-plugin/src/paypal/paypal-authorization.service.ts Outdated Show resolved Hide resolved

sonntag-philipp commented Oct 10, 2024

View reviewed changes

packages/payments-plugin/src/paypal/paypal-base.service.ts Outdated Show resolved Hide resolved

sonntag-philipp changed the title ~~feature(payments-plugin): Create PayPal integration without Braintree~~ feature(payments-plugin): PayPal two-step flow implementation Oct 10, 2024

sonntag-philipp marked this pull request as ready for review October 10, 2024 14:12

vercel bot deployed to Preview October 11, 2024 19:42 View deployment

DanielBiegler reviewed Oct 13, 2024

View reviewed changes

packages/payments-plugin/e2e/paypal-dev-server.ts Outdated Show resolved Hide resolved

DanielBiegler reviewed Oct 13, 2024

View reviewed changes

sonntag-philipp changed the base branch from master to minor October 14, 2024 16:00

sonntag-philipp force-pushed the feature/payments-plugin-paypal branch from a46fc50 to 3674cc2 Compare October 14, 2024 16:07

vercel bot deployed to Preview October 14, 2024 16:09 View deployment

sonntag-philipp force-pushed the feature/payments-plugin-paypal branch from 3674cc2 to cda6f72 Compare October 14, 2024 16:15

vercel bot deployed to Preview October 14, 2024 16:17 View deployment

vercel bot deployed to Preview October 16, 2024 10:03 View deployment

sonntag-philipp force-pushed the feature/payments-plugin-paypal branch from 058e1e3 to dc6eaeb Compare October 16, 2024 10:56

sonntag-philipp added 11 commits November 15, 2024 13:42

refactor(payments-plugin): Added translations to PayPal errors

a35c1d4

fix(payments-plugin): Fixed issue with paypal-sdk plugin of dev server

ed3cef0

fix(payments-plugin): Fixed PayPal e2e tests and updated translations

50140ba

chore: Updated package lockfile

7886553

test(payments-plugin): Fixed e2e tests of the payments plugin

a5a978a

fix(payments-plugin): Fixed stripe tests

4c704a2

test(payments-plugin): Modified test cases so array order is irreleva…

5b02301

…nt for assertions

docs(payments-plugin): Added initial documentation to PayPalPlugin

bbd8317

docs: Incremented theme search typesense version and upgraded remaini…

82db1a8

…ng parts

docs(payments-plugin): Added documentation to PayPal plugin

d390175

docs(payments-plugin): Smaller fixes for the PayPal plugin documentation

05251c8

sonntag-philipp force-pushed the feature/payments-plugin-paypal branch from 94099ff to 05251c8 Compare November 15, 2024 12:43

vercel bot deployed to Preview November 15, 2024 12:44 View deployment

sonntag-philipp commented Nov 15, 2024

View reviewed changes

michaelbromley force-pushed the minor branch from 1b58d17 to dbf0016 Compare March 31, 2025 14:13

vjung28 suggested changes Aug 20, 2025

View reviewed changes

github-project-automation bot moved this from 👀 Under consideration to ♻️ In progress in Vendure OS Roadmap Aug 20, 2025

dlhck added this to the v3.6.0 milestone Aug 22, 2025

dlhck removed this from Vendure OS Roadmap Aug 26, 2025

dlhck removed this from the v3.6.0 milestone Aug 26, 2025

larsdecker mentioned this pull request Oct 28, 2025

[Official Paypal plugin] Has there been any progress regarding the official paypal plugin? #3886

Closed

Uh oh!

feature(payments-plugin): PayPal two-step flow implementation #3099

Are you sure you want to change the base?

feature(payments-plugin): PayPal two-step flow implementation #3099

Uh oh!

Conversation

sonntag-philipp commented Oct 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Breaking changes

Overview

Screenshots

Checklist

Uh oh!

vercel bot commented Oct 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

sonntag-philipp Oct 10, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sonntag-philipp Oct 10, 2024

Choose a reason for hiding this comment

Uh oh!

sonntag-philipp Oct 10, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sonntag-philipp commented Oct 10, 2024

Uh oh!

Uh oh!

DanielBiegler Oct 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sonntag-philipp Oct 14, 2024

Choose a reason for hiding this comment

Uh oh!

sonntag-philipp commented Oct 14, 2024

Uh oh!

sonarqubecloud bot commented Nov 15, 2024

Quality Gate failed

Uh oh!

sonntag-philipp Nov 15, 2024

Choose a reason for hiding this comment

Uh oh!

sonntag-philipp commented Nov 15, 2024

Uh oh!

dfernandesbsolus commented Jun 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

michaelbromley commented Jun 5, 2025

Uh oh!

sonntag-philipp commented Jun 5, 2025

Uh oh!

michaelbromley commented Jun 11, 2025

Uh oh!

sonntag-philipp commented Jun 12, 2025

Uh oh!

vjung28 Aug 20, 2025

Choose a reason for hiding this comment

Uh oh!

dlhck Aug 20, 2025

Choose a reason for hiding this comment

Uh oh!

dlhck commented Nov 3, 2025

Uh oh!

larsdecker commented Nov 11, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants

sonntag-philipp commented Oct 1, 2024 •

edited

Loading

vercel bot commented Oct 1, 2024 •

edited

Loading

DanielBiegler Oct 13, 2024 •

edited

Loading

dfernandesbsolus commented Jun 4, 2025 •

edited

Loading