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 fund account, filtered and sorted according to specified criteria. This is useful in scenarios where you need to audit transactions, reconcile accounts, or generate reports on fund account activity over a given period.

Practical examples include:

  • Fetching all bank statement entries for a fund account within a date range.
  • Retrieving the latest 10 transactions ordered by date.
  • Applying complex filters to extract only certain types of transactions or those matching specific conditions.

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 JSON-stringified and URL-encoded filter expression object conforming to a bank statement filter schema. Used to specify filtering criteria such as date ranges or other conditions.
Skip Number of objects to skip from the beginning of the result set (for pagination).
Take Maximum number of objects to return (limits the size of the result set).
Order By JSON-stringified and URL-encoded sort expression object conforming to a bank statement order schema. Defines how results should be sorted (e.g., by date ascending or descending).

Output

The output contains a JSON array of bank statement entries corresponding to the queried fund account. Each entry typically includes details such as transaction dates, amounts, descriptions, and other relevant metadata about individual bank statement lines.

If the node supports binary data output (not explicitly shown here), it would represent downloadable bank statement files or attachments related to the fund account's transactions.

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 service's REST API endpoint that provides fund account bank statements.
  • Proper base URL configuration for the API must be set in the node credentials or environment variables.

Troubleshooting

  • Invalid or missing identifiers: Ensure that both "Account Id" and "Fund Account Id" are correctly provided; otherwise, the API call will fail.
  • Malformed filter or orderBy JSON: The filter and orderBy properties must be valid JSON strings and properly URL-encoded. Invalid JSON will cause request errors.
  • Pagination issues: Setting "Take" to zero might result in no data returned; ensure it is set to a positive integer if expecting results.
  • Authentication errors: Verify that the API key or authentication token is valid and has sufficient permissions to access fund account data.
  • API rate limits or connectivity problems: Network issues or API throttling may cause failures; check logs and retry accordingly.

Links and References

  • Refer to the external financial service API documentation for detailed schemas of IBankStatementFilter and IBankStatementOrderBy.
  • Consult n8n documentation on how to configure credentials and use JSON input parameters effectively.

Discussion