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 a workflow.

Practical examples include:

  • Fetching deposit details for reconciliation purposes.
  • Displaying deposit information in a dashboard or report.
  • Triggering follow-up actions based on deposit status or attributes.

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 output JSON contains detailed information about the specified deposit associated with the given fund account. This typically includes fields such as deposit amount, date, status, and any metadata related to 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 node uses a base URL configured in the credentials to connect to the relevant API endpoint.
  • The underlying implementation depends on an OpenAPI specification (payhawk.api.json) that defines the available operations and their parameters.

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 system.
  • Authentication errors: Verify that the API key or authentication token is valid and has sufficient permissions to access fund account deposit data.
  • Network or API errors: Check connectivity and API availability; transient issues may cause request failures.
  • Unexpected response structure: If the API changes, the node might not parse responses correctly; updating the OpenAPI spec or node version may be necessary.

Links and References

Discussion