StripePlugin

StripePlugin

@vendure/payments-pluginstripe.plugin.ts

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

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:

   yarn add @vendure/payments-plugin stripe

   or

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

Storefront usage

The plugin is designed to work with the Custom payment flow. In this flow, Stripe provides libraries which handle the payment UI and confirmation for you. You can install it in your storefront project with:

yarn add @stripe/stripe-js
# or
npm install @stripe/stripe-js

If you are using React, you should also consider installing @stripe/react-stripe-js, which is a wrapper around Stripe Elements.

The high-level workflow is:

1. Create a "payment intent" on the server by executing the createStripePaymentIntent mutation which is exposed by this plugin.
2. Use the returned client secret to instantiate the Stripe Payment Element:

   import { Elements } from '@stripe/react-stripe-js';
   import { loadStripe, Stripe } from '@stripe/stripe-js';
   import { CheckoutForm } from './CheckoutForm';
   
   const stripePromise = getStripe('pk_test_....wr83u');
   
   type StripePaymentsProps = {
     clientSecret: string;
     orderCode: string;
   }
   
   export function StripePayments({ clientSecret, orderCode }: StripePaymentsProps) {
     const options = {
       // passing the client secret obtained from the server
       clientSecret,
     }
     return (
       <Elements stripe={stripePromise} options={options}>
         <CheckoutForm orderCode={orderCode} />
       </Elements>
     );
   }

   // CheckoutForm.tsx
   import { useStripe, useElements, PaymentElement } from '@stripe/react-stripe-js';
   import { FormEvent } from 'react';
   
   export const CheckoutForm = ({ orderCode }: { orderCode: string }) => {
     const stripe = useStripe();
     const elements = useElements();
   
     const handleSubmit = async (event: FormEvent) => {
       // We don't want to let default form submission happen here,
       // which would refresh the page.
       event.preventDefault();
   
       if (!stripe || !elements) {
         // Stripe.js has not yet loaded.
         // Make sure to disable form submission until Stripe.js has loaded.
         return;
       }
   
       const result = await stripe.confirmPayment({
         //`Elements` instance that was used to create the Payment Element
         elements,
         confirmParams: {
           return_url: location.origin + `/checkout/confirmation/${orderCode}`,
         },
       });
   
       if (result.error) {
         // Show error to your customer (for example, payment details incomplete)
         console.log(result.error.message);
       } else {
         // Your customer will be redirected to your `return_url`. For some payment
         // methods like iDEAL, your customer will be redirected to an intermediate
         // site first to authorize the payment, then redirected to the `return_url`.
       }
     };
   
     return (
       <form onSubmit={handleSubmit}>
         <PaymentElement />
         <button disabled={!stripe}>Submit</button>
       </form>
     );
   };
3. Once the form is submitted and Stripe processes the payment, the webhook takes care of updating the order without additional action in the storefront. As in the code above, the customer will be redirected to /checkout/confirmation/${orderCode}.

info

A full working storefront example of the Stripe integration can be found in the Remix Starter repo

Local development

1. Download & install the Stripe CLI: https://stripe.com/docs/stripe-cli
2. From your Stripe dashboard, go to Developers -> Webhooks and click "Add an endpoint" and follow the instructions under "Test in a local environment".
3. The Stripe CLI command will look like

   stripe listen --forward-to localhost:3000/payments/stripe
4. The Stripe CLI will create a webhook signing secret you can then use in your config of the StripePlugin.

Signature

class StripePlugin {
    static options: StripePluginOptions;
    init(options: StripePluginOptions) => Type<StripePlugin>;
}

options

property

StripePluginOptions

init

method

(options: StripePluginOptions) => Type<StripePlugin>

Initialize the Stripe payment plugin

StripePluginOptions

@vendure/payments-plugintypes.ts

Configuration options for the Stripe payments plugin.

Signature

interface StripePluginOptions {
    storeCustomersInStripe?: boolean;
    metadata?: (
        injector: Injector,
        ctx: RequestContext,
        order: Order,
    ) => Stripe.MetadataParam | Promise<Stripe.MetadataParam>;
    paymentIntentCreateParams?: (
        injector: Injector,
        ctx: RequestContext,
        order: Order,
    ) => AdditionalPaymentIntentCreateParams | Promise<AdditionalPaymentIntentCreateParams>;
    requestOptions?: (
        injector: Injector,
        ctx: RequestContext,
        order: Order,
    ) => AdditionalRequestOptions | Promise<AdditionalRequestOptions>;
    customerCreateParams?: (
        injector: Injector,
        ctx: RequestContext,
        order: Order,
    ) => AdditionalCustomerCreateParams | Promise<AdditionalCustomerCreateParams>;
}

storeCustomersInStripe

property

boolean

default:

false

If set to true, a Customer object will be created in Stripe - if it doesn't already exist - for authenticated users, which prevents payment methods attached to other Customers to be used with the same PaymentIntent. This is done by adding a custom field to the Customer entity to store the Stripe customer ID, so switching this on will require a database migration / synchronization.

metadata

property

v1.9.7

( injector: Injector, ctx: RequestContext, order: Order, ) => Stripe.MetadataParam | Promise<Stripe.MetadataParam>

Attach extra metadata to Stripe payment intent creation call.

Example

import { EntityHydrator, VendureConfig } from '@vendure/core';
import { StripePlugin } from '@vendure/payments-plugin/package/stripe';

export const config: VendureConfig = {
  // ...
  plugins: [
    StripePlugin.init({
      metadata: async (injector, ctx, order) => {
        const hydrator = injector.get(EntityHydrator);
        await hydrator.hydrate(ctx, order, { relations: ['customer'] });
        return {
          description: `Order #${order.code} for ${order.customer!.emailAddress}`
        },
      }
    }),
  ],
};

Note: If the paymentIntentCreateParams is also used and returns a metadata key, then the values returned by both functions will be merged.

paymentIntentCreateParams

property

v2.1.0

( injector: Injector, ctx: RequestContext, order: Order, ) => AdditionalPaymentIntentCreateParams | Promise<AdditionalPaymentIntentCreateParams>

Provide additional parameters to the Stripe payment intent creation. By default, the plugin will already pass the amount, currency, customer and automatic_payment_methods: { enabled: true } parameters.

For example, if you want to provide a description for the payment intent, you can do so like this:

Example

import { VendureConfig } from '@vendure/core';
import { StripePlugin } from '@vendure/payments-plugin/package/stripe';

export const config: VendureConfig = {
  // ...
  plugins: [
    StripePlugin.init({
      paymentIntentCreateParams: (injector, ctx, order) => {
        return {
          description: `Order #${order.code} for ${order.customer?.emailAddress}`
        },
      }
    }),
  ],
};

requestOptions

property

v3.1.0

( injector: Injector, ctx: RequestContext, order: Order, ) => AdditionalRequestOptions | Promise<AdditionalRequestOptions>

Provide additional options to the Stripe payment intent creation. By default, the plugin will already pass the idempotencyKey parameter.

For example, if you want to provide a stripeAccount for the payment intent, you can do so like this:

Example

import { VendureConfig } from '@vendure/core';
import { StripePlugin } from '@vendure/payments-plugin/package/stripe';

export const config: VendureConfig = {
  // ...
  plugins: [
    StripePlugin.init({
      requestOptions: (injector, ctx, order) => {
        return {
          stripeAccount: ctx.channel.seller?.customFields.connectedAccountId
        },
      }
    }),
  ],
};

customerCreateParams

property

v2.1.0

( injector: Injector, ctx: RequestContext, order: Order, ) => AdditionalCustomerCreateParams | Promise<AdditionalCustomerCreateParams>

Provide additional parameters to the Stripe customer creation. By default, the plugin will already pass the email and name parameters.

For example, if you want to provide an address for the customer:

Example

import { EntityHydrator, VendureConfig } from '@vendure/core';
import { StripePlugin } from '@vendure/payments-plugin/package/stripe';

export const config: VendureConfig = {
  // ...
  plugins: [
    StripePlugin.init({
      storeCustomersInStripe: true,
      customerCreateParams: async (injector, ctx, order) => {
        const entityHydrator = injector.get(EntityHydrator);
        const customer = order.customer;
        await entityHydrator.hydrate(ctx, customer, { relations: ['addresses'] });
        const defaultBillingAddress = customer.addresses.find(a => a.defaultBillingAddress) ?? customer.addresses[0];
        return {
          address: {
              line1: defaultBillingAddress.streetLine1 || order.shippingAddress?.streetLine1,
              postal_code: defaultBillingAddress.postalCode || order.shippingAddress?.postalCode,
              city: defaultBillingAddress.city || order.shippingAddress?.city,
              state: defaultBillingAddress.province || order.shippingAddress?.province,
              country: defaultBillingAddress.country.code || order.shippingAddress?.countryCode,
          },
        },
      }
    }),
  ],
};