Balances
The balances endpoint
Balances
The balances endpoint
The Balance endpoint retrieves the real-time balance from the Account’s financial institution.
The Balance endpoint is available as a:
| Type | Use-Case |
|---|---|
Product | On-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.
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>",
}