Payhawk icon

Payhawk

Interact with the Zitadel API

Actions99

Fund Accounts → Get Fund Account Deposit

AI-generated

Overview

This node operation retrieves details of a specific deposit made to a fund account within a financial or accounting system. It is useful when you need to fetch information about a particular deposit transaction, such as verifying payment status, auditing transactions, or displaying deposit details in reports or dashboards.

Practical examples include:

  • Fetching deposit details for reconciliation purposes.
  • Displaying deposit information in a user interface after a transaction.
  • Automating workflows that depend on deposit confirmation or status.

Properties

Name Meaning
Account Id Identifier of the account to which the fund account belongs.
Fund Account Id Identifier of the specific fund account from which the deposit was made.
Deposit Id Identifier of the deposit transaction to retrieve details for.

Output

The node outputs a JSON object containing detailed information about the specified deposit. This typically includes fields such as deposit amount, date, status, and any metadata associated with the deposit transaction.

If the node supports binary data output (not evident from the provided code), it would represent any attached files or documents related to the deposit, such as receipts or confirmations.

Dependencies

  • Requires an API key credential to authenticate requests against the external service managing fund accounts and deposits.
  • The base URL for the API must be configured in the node credentials.
  • Depends on the external API described by the bundled OpenAPI specification (payhawk.api.json).

Troubleshooting

  • Missing or invalid identifiers: Ensure that Account Id, Fund Account Id, and Deposit Id are correctly provided and correspond to existing entities in the external system.
  • Authentication errors: Verify that the API key or authentication token is valid and has sufficient permissions.
  • Network issues: Check connectivity to the API endpoint and confirm the base URL is correctly set.
  • Unexpected API responses: Review the API documentation for possible changes or deprecations affecting this operation.

Links and References

Discussion