cryptomus-toolkit v1.0.3

Cryptomus Toolkit

The Cryptomus Toolkit is a TypeScript library that provides a client interface for interacting with the Cryptomus API. It offers convenient methods for handling payment, payout, and webhook-related operations. This README provides an overview of the library and instructions for getting started.

Installation

You can install the Cryptomus Toolkit via npm:

npm install cryptomus-toolkit

Usage

To use the Cryptomus Toolkit in your project, follow these steps:

1. Import the necessary classes:

import { CryptomusClient } from 'cryptomus-toolkit';

2. Initialize the CryptomusClient with your merchant UUID:

const merchantUuid = 'your-merchant-uuid';
const cryptomusClient = new CryptomusClient(merchantUuid);

3. Use the client to interact with different parts of the API:

Payment

const apiPaymentKey = 'your-api-payment-key';
const paymentClient = cryptomusClient.payment(apiPaymentKey);

// Use paymentClient to perform payment-related operations

Payout

const apiPayoutKey = 'your-api-payout-key';
const payoutClient = cryptomusClient.payout(apiPayoutKey);

// Use payoutClient to perform payout-related operations

Webhook

const apiKey = 'your-webhook-api-key';
const checkClientIp = true; // Optional parameter
const webhookClient = cryptomusClient.webhook(apiKey, checkClientIp);

// Use webhookClient to work with webhook-related functionality

Note: apiKey should correspond to either your API Payment Key or API Payout Key, depending on the type of webhook you are configuring.

API Documentation

For detailed information on available methods and their parameters, refer to the API Documentation section.

Contributing

We welcome contributions to the Cryptomus Toolkit. If you find a bug or have an enhancement in mind, please submit an issue or create a pull request on GitHub.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contact

For any questions or support, please open an issue on GitHub.