Payhawk icon

Payhawk

Interact with the Zitadel API

Actions99

Overview

This node operation retrieves the bank statement for a specific fund account within a financial system. It allows users to query detailed transaction records or statements associated with a particular fund account, filtered and sorted according to user-defined criteria. This is useful in scenarios where you need to audit transactions, reconcile accounts, or generate reports on fund account activities.

For example, a finance team could use this node to fetch all bank statement entries for a given fund account over a certain date range, ordered by transaction date, to verify payments and receipts.

Properties

Name Meaning
Account Id Identifier of the account to which the fund account belongs.
Fund Account Id Identifier of the specific fund account whose bank statement is being requested.
Filter A JSON-stringified and URL-encoded filter expression object that defines criteria to narrow down the bank statement results. It conforms to a schema allowing complex filtering such as by date ranges or other attributes.
Skip Number of objects (bank statement entries) to skip from the beginning of the result set, useful for pagination.
Take Maximum number of bank statement objects to return, controlling the size of the result set.
Order By A JSON-stringified and URL-encoded sort expression object defining how to order the returned bank statement entries, e.g., by date ascending or descending.

Output

The output contains a JSON array of bank statement entries corresponding to the specified fund account. Each entry typically includes details such as transaction dates, amounts, descriptions, and other relevant banking information. The structure follows the API's bank statement schema.

If the node supports binary data output (not indicated here), it would represent downloadable bank statement files or attachments; however, based on the provided code and properties, the output is purely JSON data representing the bank statement records.

Dependencies

  • Requires an API key credential or similar authentication token configured in n8n to access the external financial service API.
  • The node depends on the external API endpoint that provides fund account bank statements.
  • Proper base URL configuration for the API must be set in the credentials or node settings.

Troubleshooting

  • Common issues:

    • Invalid or missing Account Id or Fund Account Id will cause the API request to fail.
    • Malformed JSON in the Filter or Order By fields can lead to errors; ensure these are correctly stringified and URL-encoded.
    • Pagination parameters (Skip and Take) set incorrectly might result in empty responses or incomplete data.
    • Network or authentication errors if API credentials are not properly configured.
  • Error messages:

    • "Unauthorized" or "Authentication failed": Check that the API key or authentication token is valid and correctly set up.
    • "Invalid filter format": Verify the JSON structure of the filter parameter.
    • "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 the fund account bank statement endpoint for detailed schema and examples.
  • n8n documentation on using JSON and URL encoding in node parameters.
  • General best practices for API authentication and error handling in n8n workflows.

Discussion