https://github.com/francis-tg/perfectmoney.js

I build perfectMoney module for nodejs
https://github.com/francis-tg/perfectmoney.js

Last synced: 8 days ago
JSON representation

I build perfectMoney module for nodejs

• Host: GitHub
• URL: https://github.com/francis-tg/perfectmoney.js
• Owner: francis-tg
• Created: 2024-01-18T18:26:24.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-01-18T18:45:14.000Z (10 months ago)
• Last Synced: 2024-01-18T20:11:58.820Z (10 months ago)
• Language: JavaScript
• Size: 8.79 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# PerfectMoney Class Documentation

## Introduction

The `PerfectMoney` class provides a TypeScript implementation for interacting with the PerfectMoney API. It includes methods for various operations such as checking account balance, retrieving transaction history, transferring money, creating e-Vouchers, and validating payment confirmation data.

## Installation

To use this module in your Node.js project, you need to install the required dependencies. Run the following command:

```bash

npm install node-fetch --save

````

Certainly! Below is the provided documentation for the PerfectMoney class in Markdown format:

markdown

Copy code

# PerfectMoney Class Documentation

## Introduction

The `PerfectMoney` class provides a TypeScript implementation for interacting with the PerfectMoney API. It includes methods for various operations such as checking account balance, retrieving transaction history, transferring money, creating e-Vouchers, and validating payment confirmation data.

## Installation

To use this module in your Node.js project, you need to install the required dependencies. Run the following command:

```bash

npm install node-fetch --save

````

Usage

typescript

// Import the PerfectMoney class

```` js

import PerfectMoney from './perfectMoney';

// Create an instance of the PerfectMoney class

const perfectMoney = new PerfectMoney('your_account', 'your_password');

 Example: Get account balance

perfectMoney.balance().then((balance) => {

  console.log('Account Balance:', balance);

});

// Example: Get transaction history

perfectMoney.history('01', '01', '2022', '12', '31', '2022').then((transactions) => {

  console.log('Transaction History:', transactions);

});

// Example: Transfer money

perfectMoney.transfer('payer_account', 'payee_account', '100', 'Payment Memo', '123456')

  .then((result) => {

    console.log('Transfer Result:', result);

});

// Other methods can be used similarly...

Methods

balance(): Promise

Get account balance.

history(startmonth: string, startday: string, startyear: string, endmonth: string, endday: string, endyear: string): Promise

Retrieve transaction history within a specified date range.

transfer(payer: string, payee: string, amount: string, memo: string, payment_id: string): Promise

Transfer money from one account to another.

evCreate(payer: string, amount: string): Promise

Create an e-Voucher.

evcsv(): Promise

Retrieve e-Vouchers in CSV format.

check(payee: string, payer: string, amount: string, units: string, batch_number: string, secret: string, timestamp: string, payment_id: string, v2_hash: string): boolean

Validate SCI payment confirmation data from PerfectMoney server.

Note

Ensure that you replace 'your_account' and 'your_password' with your actual PerfectMoney account details.