Payhawk icon

Payhawk

Interact with the Zitadel API

Actions99

Overview

This node operation retrieves deposit records associated with a specific fund account within a financial or payment system. It is useful for scenarios where you need to track, audit, or analyze deposits made into fund accounts, such as reconciliation processes, reporting on cash inflows, or monitoring account activity.

For example, a finance team might use this node to fetch all deposits made to a particular fund account over a given period, applying filters to narrow down the results by date or other criteria.

Properties

Name Meaning
Account Id Identifier of the account from which to retrieve fund account deposits.
Fund Account Id Identifier of the specific fund account whose deposits are being queried.
Filter JSON-stringified and URL-encoded filter expression object that conforms to a deposit filter schema. Used to refine the query (e.g., by date ranges or other deposit attributes).
Skip Number of deposit records to skip from the beginning of the result set (useful for pagination).
Take Maximum number of deposit records to return (limits the size of the result set).

Output

The output contains a JSON array of deposit objects corresponding to the specified fund account and applied filters. Each deposit object typically includes details such as deposit amount, date, status, and any metadata related to the deposit transaction.

If the node supports binary data output (not indicated here), it would represent attachments or documents related to deposits, but based on the provided code and properties, the output is purely JSON structured data about deposits.

Dependencies

  • Requires an API key credential or similar authentication token configured in n8n to access the external service managing fund accounts and deposits.
  • The node depends on a REST API endpoint that supports querying fund account deposits with filtering, pagination ($skip, $take), and JSON-based filter expressions.
  • No additional external libraries beyond those bundled with the node are required.

Troubleshooting

  • Common issues:

    • Invalid or missing Account Id or Fund Account Id will cause the API request to fail or return no data.
    • Malformed JSON in the Filter property can lead to errors; ensure the filter is properly stringified and URL-encoded.
    • Pagination parameters (Skip and Take) must be non-negative integers; invalid values may cause unexpected results or errors.
    • Network or authentication errors if the API key or base URL is misconfigured.
  • Error messages:

    • "Unauthorized" or "Authentication failed": Check that the API key credential is correctly set up and has necessary permissions.
    • "Invalid filter format": Verify the JSON structure of the filter expression.
    • "Resource not found": Confirm that the provided account and fund account IDs exist and are correct.

Links and References

  • Refer to the external API documentation for fund accounts and deposits to understand the filter schema and available fields.
  • n8n documentation on using JSON and query parameters in nodes for advanced filtering and pagination.

Discussion