Paystack plugin

Name: Paystack plugin
Author: Fmacmak

Плагин Paystack для Medusa v2: настройка publishable-ключа для каждого магазина, вспомогательные функции для витрины и опциональный проверенный платёжный провайдер.

npm install medusa-paystack-plugin

Категория

Создано

Регионы

Сервис

Версия

0.1.1

Последнее обновление

8 месяцев назад

Ежемесячные загрузки

NPM

Medusa Paystack Browser Plugin

Medusa v2 plugin for Paystack with:

a per-store admin widget for the Paystack publishable key
a public config route for storefronts and mobile apps
a hosted webview checkout route that loads Paystack InlineJS v2
a frontend helper export for browser checkout
an optional verified Medusa payment provider for installs that also configure a Paystack secret key

Modes

Helper mode

Helper mode only needs the Paystack publishable key.

It gives you:

helper functions

In helper mode, the browser callback is only a UX signal. The plugin does not mark a Medusa order as paid from the client callback alone.

Verified mode

Verified mode uses the same browser checkout flow, but also registers the optional payment provider with a Paystack .

In verified mode:

the browser success callback triggers
the provider verifies the Paystack transaction reference server-side
Medusa only completes the cart when verification succeeds
refunds use the stored Paystack transaction id

Installation

npm install medusa-paystack-plugin

Register the plugin in your Medusa app:

1module.exports = defineConfig({
plugins: [
  {
    resolve: "medusa-paystack-plugin",
    options: {},
  },
],
8})

If you want verified Medusa payment completion, also register the provider:

1module.exports = defineConfig({
plugins: [
  {
    resolve: "medusa-paystack-plugin",
    options: {
      secret_key: process.env.PAYSTACK_SECRET_KEY,
    },
  },
],
modules: [
  {
    resolve: "@medusajs/medusa/payment",
    options: {
      providers: [
        {
          resolve: "medusa-paystack-plugin/providers/paystack",
          id: "paystack",
          options: {
            secret_key: process.env.PAYSTACK_SECRET_KEY,
          },
        },
      ],
    },
  },
],
26})

Admin setup

After the plugin is installed, open the store details page in Medusa Admin. A widget is injected into .

Save the store-specific publishable key there. The widget stores it in:

store.metadata.paystack_publishable_key

Store routes

Returns:

1{
2  "store_id": "store_123",
3  "publishable_key": "pk_test_xxx",
4  "verified_mode_enabled": true
5}

If your Medusa installation has more than one store, pass .

Returns a minimal HTML page that loads Paystack InlineJS and starts checkout inside a mobile webview or popup-style browser window.

Supported query params:

On success, cancel, or error the page:

posts a message with source
redirects to when provided

Frontend helper

Import the helper:

1import {
buildPaystackReference,
buildPaystackWebviewUrl,
createPaystackSuccessHandler,
fetchPaystackConfig,
launchPaystackCheckout,
7} from "medusa-paystack-plugin/frontend"

Storefront checkout example

1const config = await fetchPaystackConfig({
2  baseUrl: process.env.NEXT_PUBLIC_MEDUSA_BACKEND_URL,
3  storeId: "store_123",
4})
5
6const onSuccess = createPaystackSuccessHandler({
7  mode: config.verified_mode_enabled ? "verified" : "helper",
8  cartId: cart.id,
9  sdk,
10  redirectUrl: `${window.location.origin}/checkout/complete`,
11})
12
13await launchPaystackCheckout({
14  key: config.publishable_key,
15  email: cart.email!,
16  amount: paymentSession.amount,
17  currency: paymentSession.currency_code,
18  reference:
19    (paymentSession.data as { paystack_reference?: string })?.paystack_reference ??
20    buildPaystackReference(),
21  metadata: {
22    cart_id: cart.id,
23  },
24  successHandler: onSuccess,
25})

Mobile webview example

1const webviewUrl = buildPaystackWebviewUrl({
baseUrl: process.env.NEXT_PUBLIC_MEDUSA_BACKEND_URL,
callbackUrl: "myapp://checkout/complete",
currency: cart.currency_code,
email: cart.email!,
amount: cart.total,
metadata: {
  cart_id: cart.id,
},
storeId: "store_123",
11})

Load that URL in your mobile webview and listen for the message payload or the redirect to your callback URL.

Development

1npm run typecheck
2npm test
3npm run build

Notes

This package uses the Medusa v2 plugin scaffold and exports plus .
If fails because your local Medusa CLI install is incomplete, reinstall dependencies cleanly and rerun the build.