Voltage icon

Voltage

Interact with Voltage API
Join our community

Actions18

Overview

The node integrates with the Voltage API to send Bitcoin payments using different methods: Lightning Network invoices (Bolt11), on-chain Bitcoin transactions, or BIP21 URIs which unify Lightning and on-chain payments. It is designed for scenarios where automated payment processing is needed within an organization’s Bitcoin infrastructure, such as paying invoices, transferring funds on-chain, or handling unified payment requests.

Practical examples include:

  • Automatically paying a Lightning invoice received from a merchant.
  • Sending a specified amount of Bitcoin on-chain to a given address.
  • Processing a BIP21 URI that may contain either Lightning or on-chain payment information.

This node is beneficial in workflows requiring programmatic control over Bitcoin payments, enabling seamless integration with wallets and environments managed via the Voltage platform.

Properties

Name Meaning
Organization ID The identifier of the organization under which the payment is made.
Environment ID The environment ID related to the payment context.
Send Payment Type The type of payment to send. Options: Lightning (Bolt11), On-chain, BIP21 URI.
Send Wallet ID The wallet ID from which the payment will be sent.
Lightning Invoice The Bolt11 Lightning invoice string to pay (required if payment type is Lightning).
On-chain Address The Bitcoin address to send funds to (required if payment type is On-chain).
Amount (millisats) The amount to send in millisatoshis (required if payment type is On-chain).
BIP21 URI The BIP21 payment URI string (required if payment type is BIP21).
Additional Options Optional settings including:
- Max Polling Attempts: Maximum number of attempts to poll for payment status.
- Polling Interval (ms): Time between polling attempts in milliseconds.
- Timeout (ms): Total timeout duration for polling in milliseconds.

Output

The node outputs JSON data representing the result of the payment operation. This includes details about the payment status, identifiers, and any relevant metadata returned by the Voltage API after sending the payment.

If the payment is successful, the output JSON typically contains confirmation details such as transaction IDs, payment state, and timestamps.

The node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the Voltage API.
  • Needs proper configuration of the Voltage API base URL and timeout settings via credentials.
  • The node depends on the voltage-api-sdk library to interact with the Voltage API endpoints.

Troubleshooting

  • Authentication Errors (401): Occur if the API key is invalid or missing. Verify the API key credential and ensure it has correct permissions.
  • Permission Errors (403): Indicate insufficient access rights. Check the API key's scope and organization permissions.
  • Not Found Errors (404): May happen if the organization ID, environment ID, wallet ID, or payment ID is incorrect or does not exist.
  • Validation Errors (422): Result from invalid input parameters, such as malformed invoices or addresses. Review the input fields carefully.
  • Timeouts or Polling Issues: If payments take too long or do not complete, consider adjusting the polling interval, max attempts, or timeout values in additional options.
  • Non-JSON Response Errors: Usually indicate authentication issues or misconfiguration of the organization/environment IDs.

To resolve errors, verify all input parameters, credentials, and network connectivity to the Voltage API.

Links and References

Discussion