Voltage icon

Voltage

Interact with Voltage API
Join our community

Actions18

Overview

This node interacts with the Voltage API to retrieve the event history of a specific payment. The "Get Payment History" operation under the "Payment" resource fetches detailed chronological events related to a given payment ID within a specified organization and environment.

Typical use cases include auditing payment lifecycle events, tracking status changes, or debugging payment issues by reviewing all recorded events for a payment. For example, a user might want to see when a payment was created, updated, or completed to reconcile records or trigger downstream workflows based on payment state changes.

Properties

Name Meaning
Organization ID The unique identifier of the organization owning the payment.
Environment ID The environment context (e.g., production, staging) in which the payment exists.
Payment ID The unique identifier of the payment whose event history is being retrieved.

Output

The output JSON contains the full event history of the specified payment. This typically includes an array or object detailing each event related to the payment, such as creation, updates, status changes, and other relevant lifecycle events.

Each event entry may contain timestamps, event types, descriptions, and any associated metadata provided by the Voltage API.

No binary data output is involved in 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 necessary via credentials.
  • The user must provide valid Organization ID, Environment ID, and Payment ID parameters.

Troubleshooting

  • Common Issues:

    • Invalid or missing API key can cause authentication failures.
    • Incorrect Organization ID or Environment ID will result in "Not Found" errors.
    • Providing an invalid Payment ID will also lead to resource not found errors.
    • Network or server issues on the Voltage API side may cause timeouts or server errors.

  • Error Messages:

    • Validation Error (422): Indicates invalid request parameters; verify input values.
    • Authentication Error (401): Check that the API key credential is correct and active.
    • Permission Error (403): The API key lacks permissions for the requested operation.
    • Not Found (404): Organization, environment, or payment does not exist or is inaccessible.
    • Server Error (5xx): Temporary issues with the Voltage API; retry after some time.
    • Failed to parse response as JSON: Usually indicates authentication failure or incorrect organization/environment IDs.

  • Resolution Tips:

    • Double-check all input parameters for typos or incorrect values.
    • Ensure the API key has the required permissions.
    • Confirm the payment exists in the specified organization and environment.
    • Review network connectivity and retry if transient errors occur.

Links and References

Discussion