medusa-payment-streampay
v0.0.1
Published
A MedusaJS Strean Payment Gateway.
Downloads
8
Maintainers
Readme
Medusa Payment Provider for StreamPay
This repository contains the Medusa payment provider integration for StreamPay, allowing you to process payments using StreamPay in your Medusa-powered e-commerce application.
Table of Contents
Overview
Provide a brief introduction to the project and its purpose. Explain why integrating StreamPay into Medusa is beneficial for e-commerce businesses.
Getting Started
Prerequisites
- Medusa backend
- StreamPayments Account
Installation
Clone this repository:
git clone https://github.com/stream-protocol/medusa-payment-streampay.git
Install dependencies:
cd medusa-payment-streampay npm install
Configuration
Explain how users can configure the integration to work with their StreamPay account and Medusa setup. Include details on configuration files, environment variables, or any other settings that need to be adjusted.
// Example configuration file (medusa-config.json)
{
"apiKey": "YOUR_STREAMPAY_API_KEY",
"solanaProviderUrl": "https://api.mainnet-beta.solana.com",
"taxRate": 24
}
Usage
Provide examples and usage instructions for integrating StreamPay as a payment provider in a Medusa application. Include code snippets and explanations for common use cases, such as creating payments, handling callbacks, and capturing payments.
// Example code for creating a StreamPay payment
const { StreamPayService } = require('medusa-payment-streampay');
const streamPay = new StreamPayService();
const paymentData = {
amount: 100, // Payment amount in your currency
currency: 'USD',
description: 'Order #12345',
};
const payment = streamPay.createPayment(paymentData);
Contributing
Explain how others can contribute to the project. Include information about submitting issues, pull requests, coding standards, and guidelines for contributors.
License
StreamPay Payment Plugin is licensed under the MIT License.