Plugin to enable payments through Stripe via the Payment Intents API.
npm install @vendure/payments-plugin
Support by
Support languages
en
Integration type
Core
Category
Payment & Tax
Repository
Package
Compatible with
^3.0.0
Latest version
3.1.1
Last published
Dec 17, 2024
Downloads in past month
6,494
Requirements
- You will need to create a Stripe account and get your secret key in the dashboard.
- Create a webhook endpoint in the Stripe dashboard (Developers -> Webhooks, “Add an endpoint”) which listens to the
payment_intent.succeeded
andpayment_intent.payment_failed
events. The URL should behttps://my-server.com/payments/stripe
, wheremy-server.com
is the host of your Vendure server. Note: for local development, you’ll need to use the Stripe CLI to test your webhook locally. See the local development section below. - Get the signing secret for the newly created webhook.
- Install the Payments plugin and the Stripe Node library:
npm install @vendure/payments-plugin stripe
Setup
- Add the plugin to your VendureConfig
plugins
array:
For all the plugin options, see the {@link StripePluginOptions} type.import { StripePlugin } from '\@vendure/payments-plugin/package/stripe'; // ... plugins: [ StripePlugin.init({ // This prevents different customers from using the same PaymentIntent storeCustomersInStripe: true, }), ]
- Create a new PaymentMethod in the Admin UI, and select “Stripe payments” as the handler.
- Set the webhook secret and API key in the PaymentMethod form.
Complete documentation
See the StripePlugin docs for full documentation
Get started
Create your first commerce experience with Vendure in less than 2 minutes
Vendure is a registered trademark. Our trademark policy ensures that our brand and products are protected. Feel free to reach out if you have any questions about our trademarks.
Documentation
Newsletter
Get the latest product news and announcements delivered directly to your inbox.