@zukrein/cryptomus
v1.0.0
Published
A simple and lightweight TypeScript SDK for interacting with the Cryptomus API. Easily manage crypto payments, wallets, and refunds in your Node.js applications.
Maintainers
Readme
💸 Cryptomus TypeScript SDK
A simple and lightweight TypeScript SDK for interacting with the Cryptomus API. Easily manage crypto payments, wallets, and refunds in your Node.js applications.
🚀 Features
- 🔐 Generate secure signatures
- 💰 Create and refund payments
- 👛 Create and block wallets
- 📄 Retrieve payment and wallet info
- 🧾 View payment history
- 🔁 Resend webhooks
- 🧩 List supported services
- 📦 Fully written in TypeScript
📦 Installation
npm install @zukrein/cryptomus🔧 Usage
import { Cryptomus } from "@zukrein/cryptomus";
const cryptomus = new Cryptomus({
paymentKey: "YOUR_PAYMENT_KEY",
payoutKey: "YOUR_PAYOUT_KEY",
merchantId: "YOUR_MERCHANT_ID",
});
// Create a payment
const payment = await cryptomus.createPayment({
amount: "10",
currency: "USD",
orderId: "ORDER12345",
url_callback: "https://yourdomain.com/callback",
url_return: "https://yourdomain.com/return",
});
console.log(payment);📚 API Methods
| Method | Description |
| ----------------------------------------- | ---------------------------------------- |
| createPayment(options) | Create a new payment |
| getPayment({ uuid, order_id }) | Get payment details |
| refundPayment(options) | Issue a refund for a payment |
| createWallet(options) | Create a new wallet address |
| blockWallet(options) | Block a wallet (optionally force refund) |
| refundFromBlockedWallet(options) | Refund from a blocked wallet |
| generateQrCode({ wallet_address_uuid }) | Generate a QR code for a wallet |
| resendWebhook({ uuid, order_id }) | Resend a webhook |
| listServices() | List available currencies and services |
| paymentHistory({ date_from, date_to }) | Retrieve payment history |
🧪 Type Safety
This SDK uses TypeScript interfaces and enums to provide autocomplete and ensure safe integration into your project.
📄 License
MIT License
🤝 Contributing
Contributions, issues, and feature requests are welcome!
- Fork the project
- Create your feature branch (
git checkout -b feature/YourFeature) - Commit your changes (
git commit -m 'Add YourFeature') - Push to the branch (
git push origin feature/YourFeature) - Open a Pull Request
