Image 1 of 1

Stripe Payments

Product information

By Vendure Open Source

Plugin to enable payments through Stripe via the Payment Intents API.

npm install @vendure/payments-plugin
Support languages
en
Integration type
Core
Category
Payment & Tax
Compatible with
^3.0.0
Latest version
3.1.1
Last published
Dec 17, 2024
Downloads in past month
6,494

Requirements

  1. You will need to create a Stripe account and get your secret key in the dashboard.
  2. Create a webhook endpoint in the Stripe dashboard (Developers -> Webhooks, “Add an endpoint”) which listens to the payment_intent.succeeded and payment_intent.payment_failed events. The URL should be https://my-server.com/payments/stripe, where my-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.
  3. Get the signing secret for the newly created webhook.
  4. Install the Payments plugin and the Stripe Node library:
    npm install @vendure/payments-plugin stripe
    

Setup

  1. Add the plugin to your VendureConfig plugins array:
    import { StripePlugin } from '\@vendure/payments-plugin/package/stripe';
    
    // ...
    
    plugins: [
      StripePlugin.init({
        // This prevents different customers from using the same PaymentIntent
        storeCustomersInStripe: true,
      }),
    ]
    
    For all the plugin options, see the {@link StripePluginOptions} type.
  2. Create a new PaymentMethod in the Admin UI, and select “Stripe payments” as the handler.
  3. Set the webhook secret and API key in the PaymentMethod form.

Complete documentation

See the StripePlugin docs for full documentation

Vendure
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.

Newsletter

Get the latest product news and announcements delivered directly to your inbox.

© Copyright 2022 - 2024, Vendure GmbH. All rights reserved.