Paypal Payment plugin for Strapi

paypal Online payment processing for internet businesses. It's a suite of payment APIs that powers commerce for online businesses of all sizes.

Strapi is the leading open-source headless Content Management System. It’s 100% JavaScript, fully customizable and developer-first.

Overview: Start accepting online payments

The Paypal Payments plugin enables you to accept debit and credit card payments on your Strapi website or app.

Setting up the plugin is super easy and can be completed within 10 minutes.

1. Enter your Paypal API credentials.
2. Create some products, for which the plugin will automtically generate the payment button code.
3. Embed the payment button code on your product listing page.
4. On clicking the payment button, your customer will be redirected to the payment page, securely hosted by Stripe.
5. On making payment, your customer is redirected back to your checkout result page that you can customize.

That's all you need to do to turn your Strapi website or application into an e-commerce site!

✨ Features

1. Quick installation and setup.
2. Easily accept online payment for any products (or services) you want to sell on your Strapi site.
3. Automatically creates payment buttons for you to embed anywhere on your site.
4. Add multiple “Buy Now” payment buttons on a page.
5. Specify a custom name, description for a product.
6. Customize the message on the checkout result page.
7. Configure the currency type for the payment.
8. Run in test mode for debugging

🖐 Requirements

The requirements to install the Paypal Payments plugin is the same as those to install Strapi.

Please refer to the official Strapi installation requirement doc here: Installation Requirements.

Minimum environment requirements

• Node.js >=18.x.x
• NPM >=8.x.x

We are following the official Node.js releases timelines.

Supported Strapi versions:

• Strapi v4.11.0 (recently tested)

• Strapi v4.x

The Stripe Payments plugin is designed for Strapi v4.x. It won't work with Strapi v3.x.

⏳ Installation

Use npm to install this plugin within your Strapi project.

Refer to this doc to install npm

npm i strapi-paypal

After successful installation please add the below enviornment variables in .env files

STRAPI_ADMIN_API_TOKEN=*your strapi api token*
STRAPI_ADMIN_PAYPAL_SANDBOX_API_URL=https://api-m.sandbox.paypal.com
STRAPI_ADMIN_PAYPAL_LIVE_API_URL=https://api-m.paypal.com
STRAPI_ADMIN_LIVE_PAYPAL_CLIENT_ID=*your live paypal client id*
STRAPI_ADMIN_LIVE_PAYPAL_CLIENT_SECRET=*your live paypal client secret*
STRAPI_ADMIN_SANDBOX_PAYPAL_CLIENT_ID=*your sandbox paypal client id*
STRAPI_ADMIN_SANDBOX_PAYPAL_CLIENT_SECRET=*your sandbox paypal client secret*

Note: You can get the STRAPI_ADMIN_API_TOKEN from your Strapi Admin Panel. Go to Settings -> Global settings ->API Tokens -> Create new API Token. Make Sure to Select Token duration-> Unlimited and Token type -> Full Access and save it Copy the token and add it in .env file.

Note: Please Make sure to add the .env variables and verify them before starting the server.

# with npm (option 1)
$ npm run build
$ npm run develop

# with npx (option 2)
$ npx strapi  build
$ npx strapi  develop

The Payment plugin should appear in the Plugins section of the Strapi sidebar after you run the app again.

Now you are ready to accept online payments via Stripe on your Strapi website 🎉

🔧 Configuration

You can easily configure the Paypal Payments plugin to connect with your Paypal Account.

• Go to Settings -> PAYPAL -> Configuration.
• On the configiration page, Enter All the fields.
• Using Live Mode Switch Box, you can easily toggle between Paypal Test and Live mode.
• Click on Save to save the Paypal configuration.

Create a Product

After configuring Paypal, you can create products.

The products or subscription that you would create via the plugin will also automatically get created in Paypal.

Follow the steps below to create a product:

1. Click on Paypal in the Plugins section.
2. Click on Add Product.
3. choose Payment type,One-Time or Subscription.
   • For One-Time, you would charge your customer only one-time.
   • For a subscription, you would charge your customer every month.
4. Enter all the required fields.
5. Click on create button to create a product or subscription.

Embed Payment Button Code

After creating a product, click on the Embed Code icon.

You would see a popup with easy-to-follow steps, detailed below, to embed the Payment button on your product listing page.

• Embed the script tag to Your product listing, payment success and payment failure pages.
• Embed the Payment Button Code on your product listing page.
• You can customize the text of the Payment Button (example - Buy Now, Pay Now) and style using the appropriate css.

Your product listing page is where you would show all your products for your customers to browse through and purchase. Setting up the product listing page is beyond the scope of this plugin as that would depend on your choice for the frontend.

Accept Online Payments

After you embedding the Payment Button on your product list page, you are ready to accept online payments.

📝 License

MIT License

Copyright © 2022 AsyncWeb