oxapay/readme.md

An easy to use nodejs package to integrate your project with oxapay

# **Oxapay Documentation**

Oxapay is a Node.js library for interacting with the Oxapay Merchant API. This documentation provides comprehensive information on how to install, use, and contribute to this library.

Now, you can start using the oxapay library in your Node.js project.

## Installation 
Use the below command in your shell to install the oxapay library

```shell
npm i oxapay
```

## Usage
The oxapay library now supports typescript and cjs. The usage of both is given below: 

### Typescript
```typescript
import { Merchant, Payout, General } from 'oxapay';

const merchant = new Merchant('YOUR_API_KEY')
const payout = new Payout('YOUR_API_KEY')
const general = new General('YOUR_API_KEY')
```

### CommonJS
```javascript
const { Merchant, Payout, General } = require('oxapay');

const merchant = new Merchant('YOUR_API_KEY')
const payout = new Payout('YOUR_API_KEY')
const general = new General('YOUR_API_KEY')
```

## Important Note

For detailed descriptions of the parameters and methods, refer to the official Oxapay API documentation. You can find the latest Oxapay API documentation at [https://docs.oxapay.com](https://docs.oxapay.com).

## Credits

This oxapay library is developed and maintained by ROBBING GAMER from Codinary. It is officially affiliated with Oxapay.

## Contributions

Contributions to this library are welcome. If you would like to contribute, please hit us a dm in [telegram](https://t.me/ROBBING_GAMER)

For more information and detailed API documentation, refer to the official Oxapay API documentation at [https://docs.oxapay.com](https://docs.oxapay.com).

---

This documentation provides comprehensive information on using the oxapay library to interact with the Oxapay Merchant API. If you have any questions or need further assistance, please refer to the official Oxapay documentation or reach out to [@ROBBING_GAMER](https://t.me/ROBBING_GAMER) On telegram Or Reach out to oxapay official support team.