Voltage icon

Voltage

Interact with Voltage API
Join our community

Actions18

Overview

The node interacts with the Voltage API to retrieve payment data. Specifically, the "Get All Payments" operation fetches a list of payments within a specified organization and environment, supporting various filters such as wallet ID, payment status, kind, direction, date range, sorting key, and order.

This node is useful for financial or accounting workflows where you need to aggregate or analyze payment transactions programmatically. For example, it can be used to:

  • Retrieve all payments made or received in a given environment.
  • Filter payments by status (e.g., only succeeded payments).
  • Analyze payment trends over time by filtering with start and end dates.
  • Paginate through large sets of payments using limit and offset.
  • Sort payments by creation or update timestamps.

Properties

Name Meaning
Organization ID The unique identifier of the organization whose payments are being queried.
Environment ID The environment identifier within the organization for which payments are retrieved.
Filters A collection of optional filters to refine the payment query:
- Limit Maximum number of payment results to return. Default is 50.
- Offset Number of payment results to skip (for pagination). Default is 0.
- Wallet ID Filter Filter payments by a specific wallet ID.
- Payment Statuses Filter payments by one or more statuses. Possible values: Created, Ready, Paid, Failed, Expired, Succeeded.
- Payment Kind Filter by payment type/kind. Options: Lightning (Bolt11), On-chain, BIP21.
- Payment Direction Filter by payment direction: Send or Receive.
- Start Date Filter payments created after this date/time.
- End Date Filter payments created before this date/time.
- Sort Key Field to sort results by: Created At or Updated At. Default is Created At.
- Sort Order Sort order direction: Ascending or Descending. Default is Descending.

Output

The output is an array of JSON objects representing individual payments matching the filter criteria. Each payment object contains detailed information about the payment, such as its ID, status, kind, amount, timestamps, wallet association, and other metadata as provided by the Voltage API.

If multiple payments are returned, each payment is output as a separate item in the node's output array, preserving the input item pairing.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Voltage API.
  • The node uses the Voltage API SDK client internally to communicate with the service.
  • Proper configuration of the API base URL and timeout settings is required via credentials.
  • The user must provide valid Organization ID and Environment ID parameters.

Troubleshooting

  • Authentication Errors (401): Occur if the API key is invalid or missing. Verify that the API key credential is correctly configured.
  • Permission Errors (403): Indicate insufficient permissions for the API key. Ensure the key has access to the requested organization's data.
  • Not Found Errors (404): May happen if the organization or environment IDs are incorrect or do not exist. Double-check these IDs.
  • Validation Errors (422): Result from invalid request parameters or filters. Review the filter values and ensure they conform to expected formats.
  • Server Errors (5xx): Indicate issues on the Voltage API side. Retry later or contact support.
  • Non-JSON Response: If the API returns a non-JSON response, it often signals authentication or configuration problems. Check credentials and organization/environment IDs.

The node supports continuing on failure, allowing partial processing of multiple inputs even if some fail.

Links and References

Discussion