Category

Payment

Version

0.0.14

Last updated

Feb 13, 2024, 03:49:46 AM2 months ago
</p>

Medusa

Documentation | Website

Building blocks for digital commerce

Billplz payment provider for Medusa commerce

Description

A Medusa plugin to extend its payment ecosystem using Billplz - a fair payment platform.

Set up Project

Prerequisites

Installation

Install plugin package in Medusa backend

npm install @wildev/medusa-payment-billplz

Configure the Billplz plugin

BILLPLZ_COLLECTION_ID=<COLLECTION_ID>
BILLPLZ_API_KEY=<SECRET_KEY>
BILLPLZ_X_SIGNATURE_KEY=<XSIGNATURE_KEY>
STORE_URL=<STORE_URL>
BACKEND_URL=<BACKEND_URL>
BILLPLZ_SANDBOX=true
  • Copy to clipboard
    COLLECTION_ID
    can be retrieved in Billplz billing page.
  • Copy to clipboard
    SECRET_KEY
    and
    Copy to clipboard
    BILLPLZ_X_SIGNATURE_KEY
    is available in your account settings.
  • Copy to clipboard
    STORE_URL
    is the store frontend url
  • Copy to clipboard
    BACKEND_URL
    is medusa backend url
During development it’s highly recommended to set
Copy to clipboard
BILLPLZ_SANDBOX
to true and ensure you have sandbox accounts set up in Billplz.
Then in
Copy to clipboard
medusa-config.js
, add Billplz
Copy to clipboard
plugins
to the plugins array. This is some of the avaibale options that can be passed to the plugin:
const plugins = [
//other plugins...
{
resolve: `@wildev/medusa-payment-billplz`,
options: {
api_key: process.env.BILLPLZ_API_KEY,
x_signature_key: process.env.BILLPLZ_X_SIGNATURE_KEY,
collection_id: process.env.BILLPLZ_COLLECTION_ID,
production: !process.env.BILLPLZ_SANDBOX || false,
store_url: process.env.STORE_URL,
backend_url: process.env.BACKEND_URL
}
}
];

Compatibility

This starter is compatible with versions >= 1.8.0 of
Copy to clipboard
@medusajs/medusa
.

Getting Started

Visit the Quickstart Guide to set up a server.
Visit the Docs to learn more about our system requirements.

What is Medusa

Medusa is a set of commerce modules and tools that allow you to build rich, reliable, and performant commerce applications without reinventing core commerce logic. The modules can be customized and used to build advanced ecommerce stores, marketplaces, or any product that needs foundational commerce primitives. All modules are open-source and freely available on npm.
Learn more about Medusa’s architecture and commerce modules in the Docs.

Roadmap, Upgrades & Plugins

You can view the planned, started and completed features in the Roadmap discussion.
Follow the Upgrade Guides to keep your Medusa project up-to-date.

Community & Contributions

The community and core team are available in GitHub Discussions, where you can ask for support, discuss roadmap, and share ideas.
Join our Discord server to meet other community members.

Other channels

Resources

Build your own plugins

Develop your own plugins with our API to speed up your processes.

Make your plugin available via npm for it to be shared in our Plugin Library with the broader Medusa community.