Skip to main content
The Balance endpoint retrieves the real-time balance from the Account’s financial institution. The Balance endpoint is available as a:
TypeUse-Case
ProductOn-Demand real-time balance from the Account’s financial institution

​
Balances Objects

​
id
string
Unique identifier for the Balance.
​
account_id
string
The ID of the associated Account.
​
status
enum
Status of the Balance.
pending
The real-time balance information sync is pending, and should automatically start soon.in_progress
The real-time balance information sync is in progress.completed
The balance information was successfully synced.failed
The balance information failed to sync.
​
amount
number
The balance amount.
​
error
object | null
An object representing an error that occurred while processing this Balance. See Balance errors.
​
created_at
string
Timestamp of when the Balance was created.
​
updated_at
string
Timestamp of when the Balance was last updated.

​
Webhook Payload

The Webhook payload will contain the following information: 
{
  "id": "string",
  "type": "balance.create" | "balance.update",
  "path": "/accounts/<acc_id>/balances/<bal_id>",
}

{
  "id": "bal_ebzh8KaR9HCBG",
  "account_id": "acc_mBxKxAEUmVd6X",
  "status": "completed",
  "amount": 30000,
  "error": null,
  "created_at": "2024-03-14T01:41:28.434Z",
  "updated_at": "2024-03-14T01:41:28.655Z"
}