Cryptomus Payout icon

Cryptomus Payout

Working with the Cryptomus Payout API for processing cryptocurrency withdrawals

Overview

The Cryptomus Payout node enables users to interact with the Cryptomus Payout API, primarily for processing cryptocurrency withdrawals and managing related payout operations. It supports creating new payouts, retrieving payout history and information, listing available payout services, and transferring funds between personal and business wallets.

This node is beneficial in scenarios where automated cryptocurrency payouts are required, such as paying freelancers or vendors in crypto, managing internal wallet transfers, or tracking payout statuses programmatically. For example, an e-commerce platform could automate vendor payments in various cryptocurrencies using this node, specifying amounts, currencies, and blockchain networks.

Properties

Name Meaning
Operation The action to perform: Create Payout, Get Payout History, Get Payout Information, Get Payout Services, Transfer to Business Wallet, or Transfer to Personal Wallet.
Amount The amount of cryptocurrency to payout or transfer (e.g., "10.50").
Currency Cryptocurrency code for the payout or transfer (e.g., USDT, BTC, ETH).
Order ID Unique identifier for the payout order in your system (required for creating a payout).
Address Wallet address to which the payout will be sent (required for creating a payout).
Network Blockchain network code for the payout (e.g., TRON, BSC, ETH).
Deduct Fee From Defines where the withdrawal fee will be deducted: from your balance or from the payout amount.
Additional Parameters A collection of optional fields for creating a payout, including:
- Callback URL: URL to receive notifications about payout status changes.
- Course Source: Exchange rate source (Binance, Binance P2P, Exmo, Kucoin).
- From Currency: Currency to convert from (currently only USDT).
- Memo: Additional identifier for TON blockchain.
- Priority: Transaction priority affecting fees (Recommended, Economy, High, Highest).
- To Currency: Cryptocurrency code for conversion when using fiat currency.
Identifier Type Type of identifier used to find a payout (Payout UUID or Order ID) for getting payout info.
Payout ID Identifier value for the payout to retrieve information about.
Request Parameters Parameters for filtering payout history, including date range (Date From, Date To).
Платежная система Payment system selection (Binance, BinanceP2p, Exmo, Kucoin).

Output

The node outputs JSON data corresponding to the response from the Cryptomus Payout API for the selected operation:

  • Create Payout: Returns details of the created payout transaction.
  • Get Payout History: Returns a list of past payout transactions filtered by parameters.
  • Get Payout Information: Returns detailed information about a specific payout.
  • Get Payout Services: Returns a list of available payout services.
  • Transfer to Personal/Business Wallet: Returns confirmation and details of the transfer.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the Cryptomus Payout API.
  • The node expects the API type in credentials to be set specifically for payout operations.
  • Uses HTTP requests to communicate with the Cryptomus API endpoints.
  • No additional external dependencies beyond the configured API credentials.

Troubleshooting

  • API Type Mismatch: If the provided API credential is not configured for payout operations, the node throws an error indicating that only payout-type API credentials are allowed.
  • Invalid or Missing Required Fields: Omitting required properties like amount, currency, order ID, address, or network for payout creation will cause errors.
  • HTTP Request Failures: Network issues or invalid API keys can cause request failures; ensure valid credentials and network connectivity.
  • Continue On Fail Behavior: When enabled, the node will continue processing subsequent items even if one fails, returning error messages in the output JSON.
  • Error Handling: Errors from the API are caught and handled gracefully, but users should verify input parameters and API access rights.

Links and References

Discussion