Account Balances

A Balance in Quiltt represents the amount of money currently available on a specific Account. Account Balances are typically updated automatically as part of the regular Connection sync flow.

For payment-related use-cases, you can also trigger a real-time balance refresh to have the underlying provider fetch the latest data from the connected institution. You can see how the real-time balance feature works in the video below:

Link to this section#Schemas & Types

Link to this section#GraphQL Queries

Balances are available on all Accounts in Quiltt. For example, we can fetch the latest balance for all accounts on a profile with the below query:

Link to this section#REST Operations

Link to this section#Trigger a Balance Refresh

POSThttps://api.quiltt.io/v1/accounts/{accountId}/balances/refresh

You can trigger a real-time balance refresh by calling the Trigger a Balance Refresh Platform API endpoint.

Successful requests will return a 202 Accepted status code and trigger a refresh from the underlying provider. As soon as new balance information is available, Quiltt will fire the balance.created event with the new balance data.

Events triggered by real-time balance refreshes can be identified by checking the source field, which will be set to "REFRESH".

Link to this section#Webhooks

Link to this section#balance.created

You can subscribe to new balance data by listening to the balance.created webhook. This event fires anytime new balance information is obtained for an Account.

The webhook will include the balance.created event type and the new Balance information: