Skip to content

Latest commit

 

History

History
85 lines (54 loc) · 2.55 KB

README.md

File metadata and controls

85 lines (54 loc) · 2.55 KB

[Plugin Name]

Short description of what this plugin does

Receive payments on your Medusa commerce application using Stripe.

Add any of your links to the following links.

Plugin Documentation | Medusa Website | Medusa Repository

Features

Either a bullet list of features or a checklist of features. The checklist is helpful if you're planning on adding more features in the future and can act as a roadmap.

  • Receive payments from any sales channel.
  • Capture payments from the admin dashboard.
  • View payment analytics through Stripe's dashboard.

Prerequisites

A bullet list of requirements before installing and using the plugin. The requirements can be tools to be installed, accounts to be created, keys to be retrieved, or anything similar. Also, include a link that helps developers learn how to install the tool.

How to Install

List the steps necessary to install the plugin.

1. Run the following command in the directory of the Medusa backend:

npm install medusa-payment-stripe

2. Set the following environment variables in .env:

STRIPE_API_KEY=sk_...
STRIPE_WEBHOOK_SECRET=whsec_...

3. In medusa-config.js add the following at the end of the plugins array:

const plugins = [
  // ...
  {
    resolve: `medusa-payment-stripe`,
    options: {
      api_key: process.env.STRIPE_API_KEY,
      webhook_secret: process.env.STRIPE_WEBHOOK_SECRET,
    },
  },
]

Test the Plugin

List the steps necessary to test the plugin.

1. Run the following command in the directory of the Medusa backend to run the backend:

npm start

2. Enable Stripe in a region in the admin. You can refer to this User Guide to learn how to do that. Alternatively, you can use the Admin APIs.

3. Place an order using a storefront or the Store APIs. You should be able to use Stripe as a payment method.

Additional Resources

List here any additional resources that can be helpful in the development or usage of this plugin.