Built by

ibnumalik

Category

Payment

Version

0.0.6

Last updated

Oct 23, 2022, 19:47:38 PMa year ago

Billplz payment provider for Medusa commerce

About

Participants

GitHubDiscordTwitter
@ibnumalikibnumalik#3920@ibnumalikmy

Description

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

Preview

Set up Project

Prerequisites

Installation

Install plugin package in Medusa backend

npm install 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: `medusa-payment-billplz`,
options: {
api_key: BILLPLZ_API_KEY,
x_signature_key: BILLPLZ_X_SIGNATURE_KEY,
collection_id: BILLPLZ_COLLECTION_ID,
production: !BILLPLZ_SANDBOX || false,
store_url: STORE_URL,
backend_url: BACKEND_URL
}
}
];

Resources

TODO

  • Add instruction to use in NextJS storefront starter.
  • Add library to provide components and hooks to use this plugins.

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.