Skip to content

A simple and lightweight TypeScript SDK for interacting with the Cryptomus API. Easily manage crypto payments, wallets, and refunds in your Node.js applications.

Notifications You must be signed in to change notification settings

zukreindev/cryptomus

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

1 Commit
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ’Έ 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!

  1. Fork the project
  2. Create your feature branch (git checkout -b feature/YourFeature)
  3. Commit your changes (git commit -m 'Add YourFeature')
  4. Push to the branch (git push origin feature/YourFeature)
  5. Open a Pull Request

About

A simple and lightweight TypeScript SDK for interacting with the Cryptomus API. Easily manage crypto payments, wallets, and refunds in your Node.js applications.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published