Payhawk icon

Payhawk

Interact with the Zitadel API

Actions99

Overview

This node is designed to retrieve information about specific fund accounts by their unique identifier. It is useful in scenarios where you need to fetch detailed data about a particular fund account, such as for financial reporting, auditing, or integration with other systems that require up-to-date account details.

For example, if you manage multiple fund accounts and want to automate the retrieval of their current status or metadata, this node can be used to query each account individually by its ID.

Properties

Name Meaning
Account Id Identifier of the account to retrieve. This is a required string input specifying which fund account's details to fetch.

Output

The node outputs JSON data representing the details of the requested fund account. The structure typically includes all relevant fields returned by the external API for a fund account, such as account identifiers, balances, statuses, or related metadata.

If the node supports binary data output (not evident from the provided code), it would represent any associated files or documents linked to the fund account, but no such indication is present here.

Dependencies

  • Requires an API key credential or similar authentication token configured in n8n to access the external service.
  • The node interacts with an external API endpoint defined in the bundled OpenAPI specification (payhawk.api.json).
  • The base URL for API requests is expected to be set via credentials configuration.
  • Uses the @devlikeapro/n8n-openapi-node package for handling OpenAPI-based operations.

Troubleshooting

  • Missing or invalid Account Id: Since the Account Id is required, ensure it is provided and correctly formatted. Errors may occur if this field is empty or incorrect.
  • Authentication errors: If the API key or credentials are missing or invalid, the node will fail to authenticate. Verify that the API credentials are properly set up in n8n.
  • Network or API errors: Connectivity issues or API downtime can cause failures. Check network connectivity and API service status.
  • Unexpected response structure: If the API changes its response format, the node might not parse the output correctly. Review API documentation for updates.

Links and References

  • OpenAPI Specification — Understanding the API definition format used.
  • Documentation for the external API service (referred to as "Payhawk" in the code) should be consulted for detailed information on fund account endpoints and data structures.

Discussion