npm.io
2.22.7 • Published 4d ago

@medusajs/payment

Licence
MIT
Version
2.22.7
Deps
1
Size
397 kB
Vulns
0
Weekly
0
Stars
36.8K

Medusa logo

@medusajs/payment

Documentation | Website

Building blocks for digital commerce

Medusa is released under the MIT license. PRs welcome! Discord Chat Follow @medusajs

Payment Module for Medusa: manages payment collections, payment sessions, payments, captures, refunds, refund reasons, account holders, and payment providers. Use it to process payments for carts, orders, or any resource through pluggable payment providers. It ships with @medusajs/medusa and is registered by default, so Medusa applications don't install it directly.

At a glance

Package @medusajs/payment
Type Commerce Module
Module key Modules.PAYMENT ("payment")
Registered by default Yes
Import from @medusajs/medusa/payment

Features

  • Group payment sessions and payments for a resource in a payment collection.
  • Authorize, capture, and refund payments, with refund reasons.
  • Store account holders to save customers' payment methods with a provider.
  • Handle provider webhook events.

Payment providers

The module delegates payment processing to Payment Module Providers, registered through the providers option. A system provider (pp_system_default) is always registered for manual payments.

Official providers in this repository:

Installation

No installation needed. The module is included in @medusajs/medusa and registered by default.

Usage

Register payment providers in medusa-config.ts:

import { defineConfig } from "@medusajs/framework/utils"

module.exports = defineConfig({
  // ...
  modules: [
    {
      resolve: "@medusajs/medusa/payment",
      options: {
        providers: [
          {
            resolve: "@medusajs/medusa/payment-stripe",
            id: "stripe",
            options: {
              apiKey: process.env.STRIPE_API_KEY,
            },
          },
        ],
      },
    },
  ],
})

Configuration

Option Type Description Default
providers { resolve: string, id: string, options?: Record<string, unknown> }[] Payment Module Providers to register. []

Resources