PrerequisitesCopied!

Ensure a valid Account is linked, as it is a requirement to have a valid account ID for the use of the Refresh endpoints. Refer to the integration documentation for details on requesting the necessary permissions for your specific use case.

Note: The balances permission is the minimum required permission for the ability to request a refresh on an Account.

Initiating a Data RefreshCopied!

Depending on the activity of the record you are trying to refresh, there could be a significant amount of data that may take time to retrieve. For efficiency, refreshing account data is an asynchronous process. After initiating the refresh, you must wait for its completion before retrieving the updated results.

To initiate the refresh, use the Refresh API to start a refresh for an account.

Due to the expensive nature of this operation, we limit the amount you can trigger a refresh of an account to once an hour.

Monitoring the Refresh StatusCopied!

The balance_refresh or transaction_refresh fields in the account object show the refresh status. When a refresh is initiated, the status changes to pending, then to either succeeded or failed.

• Next Available Refresh: The next_refresh_available_at field indicates when the next refresh can be initiated.

Polling for UpdatesCopied!

Hoseki does not currently support webhooks for refresh completion notifications. You will need to manually poll the refresh status to check for updates.

Retrieving Updated Account DataCopied!

Once the refresh is complete, you can retrieve the updated account data using the Retrieve Account API or List Records for an Account API.

Note: When using the 'Get Next Receive Address' helper endpoint, you must refresh it to ensure you receive the most up-to-date address. If the transactions aren't refreshed, the next receive address could be inaccurate due to outdated transaction data.