Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

[Skip CI] added guide how to connect PayPal

Damian Legawiec64ceb8438afc
diff --git a/docs/developer/core-concepts/payments.mdx b/docs/developer/core-concepts/payments.mdx
index c86f0bc61b..8f671500c6 100644
--- a/docs/developer/core-concepts/payments.mdx
+++ b/docs/developer/core-concepts/payments.mdx
@@ -165,16 +165,25 @@ payment.log_entries.first.details
## Supported Gateways
-Spree team maintains several payment gateways integrations, including:
+### Spree Team maintained gateways
-* [Spree Stripe](https://github.com/spree/spree_stripe) - Stripe integration, supports all Stripe payment methods, including credit cards, bank transfers, Apple Pay, Google Pay, Klarna, Afterpay, and more. Also supports quick checkout.
-* [Spree PayPal](https://github.com/spree/spree_paypal) - native PayPal integration, supports PayPal, PayPal Credit, and PayPal Pay Later.
+Spree team maintains several payment gateways integrations. All of these gateways are **fully PCI compliant**, using native gateway SDKs/UIs, meaning no sensitive data is stored or processed through Spree.
-<Info>
- Spree Stripe and Spree PayPal are fully PCI compliant, meaning no sensitive data is stored or processed through Spree.
-</Info>
+<Card title="Stripe" href="/integrations/payments/stripe" icon="link">
+ Stripe integration, supports all Stripe payment methods, including credit cards, bank transfers, Apple Pay, Google Pay, Klarna, Afterpay, and more. Also supports quick checkout.
+</Card>
+
+<Card title="Adyen">
+ We're working on this, stay tuned! If you want to know more, please reach out to us via email at [[email protected]](mailto:[email protected]).
+</Card>
+
+<Card title="PayPal" href="/integrations/payments/paypal" icon="link">
+ Native PayPal integration, supports PayPal, PayPal Credit, and PayPal Pay Later.
+</Card>
+
+### Community maintained gateways
-There are also community-maintained extensions for other payment gateways, such as [Spree Gateway](https://github.com/spree/spree_gateway) extension. This extension currently supports the following gateways:
+There are also community-maintained extensions for other payment gateways combined in the [Spree Gateway](https://github.com/spree/spree_gateway) gem. This gem currently supports the following gateways:
* Authorize.net
* BanWire
diff --git a/docs/docs.json b/docs/docs.json
index 8dee4c17ca..a3b617be1b 100644
--- a/docs/docs.json
+++ b/docs/docs.json
@@ -857,7 +857,8 @@
{
"group": "Payments",
"pages": [
- "integrations/payments/stripe"
+ "integrations/payments/stripe",
+ "integrations/payments/paypal"
]
},
{
diff --git a/docs/images/integrations/logos/paypal.png b/docs/images/integrations/logos/paypal.png
new file mode 100644
index 0000000000..1c312a6ace
Binary files /dev/null and b/docs/images/integrations/logos/paypal.png differ
diff --git a/docs/images/integrations/paypal/paypal_credentials.png b/docs/images/integrations/paypal/paypal_credentials.png
new file mode 100644
index 0000000000..eddd5cbca7
Binary files /dev/null and b/docs/images/integrations/paypal/paypal_credentials.png differ
diff --git a/docs/images/integrations/paypal/paypal_form.png b/docs/images/integrations/paypal/paypal_form.png
new file mode 100644
index 0000000000..d10602eea8
Binary files /dev/null and b/docs/images/integrations/paypal/paypal_form.png differ
diff --git a/docs/images/integrations/paypal/paypal_payment_method_list.png b/docs/images/integrations/paypal/paypal_payment_method_list.png
new file mode 100644
index 0000000000..240ab442d5
Binary files /dev/null and b/docs/images/integrations/paypal/paypal_payment_method_list.png differ
diff --git a/docs/integrations/integrations.mdx b/docs/integrations/integrations.mdx
index 6f2010777e..6ba2b3fee2 100644
--- a/docs/integrations/integrations.mdx
+++ b/docs/integrations/integrations.mdx
@@ -10,6 +10,9 @@ description: "Learn how to connect your Spree Commerce store to third-party serv
<Card title="Stripe" href="/integrations/payments/stripe" img="/images/integrations/logos/stripe.png">
Stripe is a popular payment gateway that allows you to accept payments from your customers. Credit cards, wallets, buy-now-pay-later, installment payments and more.
</Card>
+ <Card title="PayPal" href="/integrations/payments/paypal" img="/images/integrations/logos/paypal.png">
+ PayPal is an online payment system that allows you to send and receive money around the world. You can link your credit card, debit card, or bank account. You can also set up a PayPal Balance account.
+ </Card>
</CardGroup>
## Analytics
@@ -27,5 +30,3 @@ description: "Learn how to connect your Spree Commerce store to third-party serv
Klaviyo is a marketing automation platform that allows you to send email campaigns to your customers.
</Card>
</CardGroup>
-
-## Analytics
diff --git a/docs/integrations/payments/paypal.mdx b/docs/integrations/payments/paypal.mdx
new file mode 100644
index 0000000000..162b1c93e9
--- /dev/null
+++ b/docs/integrations/payments/paypal.mdx
@@ -0,0 +1,43 @@
+---
+title: "Connect PayPal payments to Spree Commerce"
+sidebarTitle: PayPal
+description: "Learn how to set up and manage Spree's native PayPal integration."
+---
+
+PayPal is an online payment system that allows you to send and receive money around the world. You can link your credit card, debit card, or bank account. You can also set up a PayPal Balance account.
+
+## Installation
+
+Before you can enable PayPal, it must be installed. To do so, you need to run the following command:
+
+```bash
+bundle add spree_paypal_checkout && bundle exec rails g spree_paypal_checkout:install
+```
+
+After that, you need to make sure to restart the server.
+
+## Connect PayPal
+
+Sign in to your Spree admin dashboard and navigate to **Settings → Payments**.
+
+![](/images/integrations/paypal/paypal_payment_method_list.png)
+
+Find PayPal under Available Payment Methods and click **Add**.
+
+This will redirect you to the PayPal setup form.
+
+![](/images/integrations/paypal/paypal_form.png)
+
+You will need Client ID and Client Secret from your [PayPal dashboard credentials page](https://www.paypal.com/mep/merchantapps/setup/checkout/apicredentials).
+
+<Tip>
+ To get your credentials, go to `Business Tools`, select `Online Checkout`, click `Get Started`, select `Have a custom-built site? -> Get Started`, `PayPal Checkout -> Get Started`.
+</Tip>
+
+![](/images/integrations/paypal/paypal_credentials.png)
+
+You should see your live and sandbox credentials. Copy API key into `Client ID` and Secret into `Client Secret`.
+
+If you wish to test the PayPal payments before going live, copy sandbox credentials and select `Test Mode` option in Spree.
+
+Click **Create** to enable PayPal as a payment method on your store.
\ No newline at end of file
diff --git a/docs/integrations/payments/stripe.mdx b/docs/integrations/payments/stripe.mdx
index 7cbe8d9e29..2f9bf8a791 100644
--- a/docs/integrations/payments/stripe.mdx
+++ b/docs/integrations/payments/stripe.mdx
@@ -6,11 +6,9 @@ description: "Learn how to set up and manage Spree's native Stripe integration."
Stripe is a widely used payment processor that enables secure and seamless transactions for online businesses. It supports multiple payment methods, automates payouts, and ensures a smooth checkout experience for customers.
-In Spree Enterprise Edition, Stripe can also be used to power marketplace payments, enabling automated vendor payouts, split payments, and secure transaction handling.
-
-<Warning>
- You must have an existing Stripe account to enable Stripe payments in Spree.
-</Warning>
+<Tip>
+ In [Spree Enterprise Edition](https://spreecommerce.org/pricing/), Stripe can also be used to power marketplace payments, enabling automated vendor payouts, split payments, and secure transaction handling.
+</Tip>
## Installation
@@ -56,7 +54,7 @@ You can optionally configure the following settings for your Stripe payment meth
- **Auto Capture**: Decide whether payments should be automatically captured at the time of authorization (recommended), or manually captured later.
- **Active Status**: Enable or disable the payment method. Inactive methods are hidden from checkout but not removed.
-### Enable Apple Pay 
+### Enable Apple Pay
To enable Apple Pay (including Apple Pay quick checkout) as a payment method, follow these steps:
@@ -101,7 +99,7 @@ Spree’s Stripe integration enhances the customer experience with dynamic, cont
- Various payment options on the payment step (cards, BNPL, Apple Pay, Google Pay, Link)
![Quick payments bypassing checkout 1st step (Apple Pay, Google_Pay, Link)](https://vendo-production-res.cloudinary.com/image/upload/w_2000/q_auto/v1742930027/docs/github/Spree_x_Stripe_-_Apple_Pay_Google_Pay_Link_-_Checkout_payment_step_rxxnr9.jpg)
-## Stripe Connect
+## Stripe Connect for Marketplaces
Spree Commerce [Enterprise Edition](https://spreecommerce.org/spree-commerce-version-comparison-community-edition-vs-enterprise-edition/) comes with a fully automated Stripe Connect integration for [multi-vendor marketplace use cases](https://spreecommerce.org/marketplace-ecommerce/):