Cryptomus Payout

Overview

This node integrates with the Cryptomus Payout API to facilitate various cryptocurrency withdrawal and transfer operations. It is designed for users who need to automate payouts, retrieve payout histories or details, manage available payout services, and transfer funds between personal and business wallets within the Cryptomus ecosystem.

Common scenarios include:

• Creating automated cryptocurrency payouts to specified wallet addresses.
• Fetching detailed information about specific payouts.
• Retrieving a history of past payouts for reconciliation or reporting.
• Listing available payout services supported by Cryptomus.
• Transferring funds between personal and business wallets programmatically.

For example, a business paying out crypto rewards to customers can use this node to create payouts automatically, while also tracking their status and history.

Properties

Note: The provided input property "Платежная система" (merchantPaymentSystem) is an additional parameter used in some payout requests to specify the exchange rate source or payment system.

The node supports multiple operations, each with its own set of properties (not all shown here due to focus on Default resource-operation):

• Operation: Selects the action to perform:

  • Create Payout
  • Get Payout History
  • Get Payout Information
  • Get Payout Services
  • Transfer to Business Wallet
  • Transfer to Personal Wallet

• For Create Payout operation, key properties include:

  • Amount: The payout amount.
  • Currency: Cryptocurrency code (e.g., USDT, BTC).
  • Order ID: Unique identifier for the payout in your system.
  • Address: Wallet address to send the payout.
  • Network: Blockchain network code (e.g., TRON, BSC).
  • Deduct Fee From: Whether fees are deducted from your balance or payout amount.
  • Additional Parameters: Optional fields like callback URL, course source (payment system), memo, priority, currency conversion options.

• For Get Payout Information:

  • Identifier Type: Choose between payout UUID or order ID.
  • Payout ID: The identifier value.

• For Get Payout History:

  • Date From / Date To: Filter payouts by date range.

• For Transfer to Business/Personal Wallet:

  • Amount and Currency.

Output

The node outputs JSON data corresponding to the response from the Cryptomus Payout API for the selected operation. The structure varies depending on the operation:

• For Create Payout, the output includes details of the created payout such as IDs, status, and transaction info.
• For Get Payout Information, detailed payout data is returned.
• For Get Payout History, a list of payouts matching the filter criteria is provided.
• For Get Payout Services, a list of available payout services is returned.
• For Transfers, confirmation and details of the transfer operation are output.

No binary data output is produced by this node.

Dependencies

• Requires an API authentication credential for the Cryptomus service configured in n8n.
• Uses HTTP requests to communicate with the Cryptomus Payout API endpoints.
• The node expects the credential to be specifically for the "Payout" API type; using other API types will cause an error.

Troubleshooting

• Error: API type mismatch
  If the credential used is not for the Payout API type, the node throws an error indicating that only Payout API credentials are allowed. Ensure you configure the correct API credential.

• API request failures
  Errors from the Cryptomus API (e.g., invalid parameters, insufficient funds) will be surfaced. Use the error messages to adjust inputs accordingly.

• Continue On Fail behavior
  If enabled, the node will continue processing subsequent items even if one fails, returning error details in the output JSON.

• Invalid or missing required parameters
  Make sure all required fields for the chosen operation are provided, such as amount, currency, and identifiers.

Links and References

• Cryptomus Payout API Documentation (official API docs)
• n8n documentation on creating custom nodes