Cryptomus Payment icon

Cryptomus Payment

Working with the Cryptomus API for processing cryptocurrency payments

Overview

The node integrates with the Cryptomus API to manage cryptocurrency payments. Specifically, the "Refund Blocked Payment" operation allows users to refund funds that are currently blocked in a payment transaction. This is useful when a payment cannot be completed or needs to be reversed due to issues such as failed processing or disputes.

Common scenarios include:

  • Automatically refunding blocked funds to a customer's wallet address.
  • Handling refunds programmatically within a payment workflow.
  • Managing test payments by specifying if the refund is for testing purposes.

Example use case: After detecting a blocked payment via your system, you can trigger this node to refund the blocked amount back to the user's specified wallet address, optionally specifying a partial refund amount.

Properties

Name Meaning
Identifier Type The type of identifier used to find the payment. Options: "Payment UUID", "Order ID".
Payment ID The actual identifier value (UUID or Order ID) of the payment to refund.
Refund Address The wallet address where the refunded funds will be sent.
Refund Amount The amount to refund. If left empty, the entire blocked amount will be refunded.
Test Payment Boolean flag indicating whether this refund is for testing purposes (true/false).

Output

The output JSON contains the response from the Cryptomus API after attempting the refund of blocked funds. It typically includes details about the refund status, any errors, and confirmation data returned by the API.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential configured with access to the Cryptomus Payment API.
  • The node uses HTTP POST requests to Cryptomus endpoints.
  • No additional environment variables are required beyond the API credentials.

Troubleshooting

  • Error: Credentials with API type "Payment" are required
    This error occurs if the provided API credentials do not have the correct API type set. Ensure you configure credentials specifically for payment operations.

  • Invalid Payment ID or Identifier Type
    Make sure the payment identifier matches the selected identifier type (UUID or Order ID). Using mismatched types will cause the API call to fail.

  • Refund Address Missing or Invalid
    The refund wallet address must be valid and correctly formatted. An invalid address will result in an API error.

  • Refund Amount Issues
    If specifying a refund amount, ensure it does not exceed the blocked amount. Leaving it empty refunds the full blocked amount.

  • API Request Failures
    Network issues or incorrect API keys can cause request failures. Verify connectivity and credential validity.

Links and References

Discussion