Voltage icon

Voltage

Interact with Voltage API
Join our community

Actions18

Overview

The node integrates with the Voltage API to manage and retrieve payment-related data within an organization’s environment. Specifically, the Get Payment operation fetches detailed information about a single payment by its unique ID.

This node is useful in scenarios where you need to:

  • Retrieve the status and details of a specific payment.
  • Monitor or audit individual payments programmatically.
  • Integrate payment data into workflows for reporting, notifications, or further processing.

Example use case:
You have an automated workflow that triggers when a payment is made, and you want to fetch the full payment details (amount, status, timestamps) to update your internal systems or notify stakeholders.

Properties

Name Meaning
Organization ID The unique identifier of the organization under which the payment exists.
Environment ID The environment ID associated with the payment (e.g., production or staging environment).
Payment ID The unique identifier of the payment to retrieve.

Output

The output is a JSON object representing the payment details as returned by the Voltage API. This typically includes fields such as payment amount, currency, status, timestamps, payment kind, wallet information, and other metadata related to the payment.

The node does not output binary data for this operation.

Example structure (simplified):

{
  "id": "string",
  "wallet_id": "string",
  "currency": "string",
  "amount_msats": number,
  "status": "string",
  "payment_kind": "string",
  "created_at": "string (ISO date)",
  "updated_at": "string (ISO date)",
  // ...additional payment-specific fields
}

Dependencies

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

Troubleshooting

Common Issues

  • Authentication errors: If the API key is invalid or missing, the node will fail to authenticate.
  • Not found errors: Providing incorrect organization ID, environment ID, or payment ID will result in resource not found errors.
  • Validation errors: Incorrect parameter formats or missing required parameters can cause validation failures.
  • Timeouts: Network issues or slow API responses may cause timeouts.

Error Messages and Resolutions

Error Message Cause Resolution
Authentication Error (401): Invalid API key or credentials. Invalid or missing API key Verify and update the API key credential in n8n.
Not Found (404): Organization, environment, or resource not found. Incorrect organization ID, environment ID, or payment ID Double-check the IDs provided in the node parameters.
Validation Error (422): The request data is invalid. Please check your parameters. Parameter format or value issues Ensure all required parameters are correctly set and valid.
Server Error (5xx): The Voltage API is experiencing issues. Server-side problems Retry later or contact Voltage support if persistent.
API returned non-JSON response (Status: XXX). Check your API credentials and organization ID. Possible authentication or configuration issue Confirm API credentials and organization/environment IDs are correct.

Links and References

Discussion