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 certain period, applying filters to narrow down the results by date or other criteria.

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 deposits are being retrieved.
Filter JSON-stringified and URL-encoded filter expression object that conforms to a deposit filter schema. Used to specify conditions such as date ranges or other deposit attributes to refine the query results.
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 relevant to the deposit transaction.

If the node supports binary data output (not indicated here), it would represent attachments or documents related to deposits, but in this case, the output is purely JSON-based deposit data.

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 interacts with an external API endpoint that provides fund account deposit data.
  • Proper base URL and authentication credentials must be set up in n8n for successful API communication.

Troubleshooting

  • Common issues:

    • Invalid or missing Account Id or Fund Account Id will cause the API request to fail or return no data.
    • Incorrectly formatted filter JSON may lead to errors or unexpected results.
    • Pagination parameters (Skip and Take) not set properly could result in incomplete data retrieval or performance issues.
    • Authentication failures if API credentials are not correctly configured.
  • Error messages:

    • "Unauthorized" or "Authentication failed": Check API credentials and ensure they are valid and have necessary permissions.
    • "Invalid filter format": Verify that the filter JSON is correctly structured and URL-encoded.
    • "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 and deposit endpoints to understand available filter options and response structure.
  • n8n documentation on how to configure API credentials and handle pagination in nodes.

Discussion