Skip to content

Twispay/vtex

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

# Twispay Payment Plugin for Your Platform

Twispay is a payment processing solution that allows online businesses to accept payments through a variety of methods. This plugin enables you to integrate Twispay's payment processing capabilities into your platform easily and efficiently.

## Pre-requisites

- Node.js installed on your machine.
- An active Twispay account and access to your API credentials.

## Installation

1. **Clone or Download the Plugin**
   - You can clone this plugin repository using Git or download it as a ZIP file.

git clone [repository_url]


2. **Install Dependencies**
- Navigate to the plugin directory and install the necessary dependencies using npm (Node Package Manager).

cd [plugin_directory] npm install


3. **Configure API Key**
- Open `paymentProcessor.js` and replace the `apiKey` in the constructor with your actual Twispay API key.
```javascript
constructor(apiKey, apiEndpoint) {
    this.apiKey = 'YOUR_TWISPAY_API_KEY';
    this.apiEndpoint = apiEndpoint;
}
  1. Deploy the Plugin
    • Deploy your platform including the Twispay plugin to your desired hosting environment. Ensure that all files, especially the paymentProcessor.js, are included and properly linked in your project.

Usage

Making a Payment

  1. Import and instantiate the PaymentProcessor class.

    const PaymentProcessor = require('./path_to/paymentProcessor.js');
    const paymentProcessor = new PaymentProcessor('YOUR_TWISPAY_API_KEY', 'TWISPAY_API_ENDPOINT');
  2. Use the makePayment Of course! Here's the formatted Markdown content for your README.md`:


# Twispay Payment Plugin for Your Platform

Twispay is a payment processing solution that allows online businesses to accept payments through a variety of methods. This plugin enables you to integrate Twispay's payment processing capabilities into your platform easily and efficiently.

## Pre-requisites

- Node.js installed on your machine.
- An active Twispay account and access to your API credentials.

## Installation

1. **Clone or Download the Plugin**
   - You can clone this plugin repository using Git or download it as a ZIP file.

git clone [repository_url]


2. **Install Dependencies**
- Navigate to the plugin directory and install the necessary dependencies using npm (Node Package Manager).

cd [plugin_directory] npm install


3. **Configure API Key**
- Open `paymentProcessor.js` and replace the `apiKey` in the constructor with your actual Twispay API key.
```javascript
constructor(apiKey, apiEndpoint) {
    this.apiKey = 'YOUR_TWISPAY_API_KEY';
    this.apiEndpoint = apiEndpoint;
}
  1. Deploy the Plugin
    • Deploy your platform including the Twispay plugin to your desired hosting environment. Ensure that all files, especially the paymentProcessor.js, are included and properly linked in your project.

About

Payment module for VTEX

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published