Balances

A balances history for a given account.

post
Get Balances

https://api.finqware.com/v1/balances/get
Query/filter for account balances history
Request
Response
Request
Body Parameters
client_id
required
string
An identifier for your tenant app.
client_secret
required
string
A tenant app secret.
credentials_id
required
string
A pointer to the parent bank account resource
access_token
required
string
An auth token for the parent bank account resource
filter
optional
object
A filter object - criteria in the table below (case sensitive)
Response
200: OK
A list of balances - native_date is a 'date' type returned by the bank for certain balance types (eg: end-of-day) - native_timestamp is a 'date-time' type that may describe an intermediate balance (eg: intra-day) - timestamp is the date-time when this balance was queried by the middleware
[
{
"account_id": "69a19df6-../-3bc1bddfd89a",
"data": {
"amount": "210",
"credit_debit_indicator": null,
"credit_line": null,
"currency": "RON",
"native_date": "2018-03-30",
"native_timestamp": null,
"type": "Expected"
},
"id": "6aac5b32-...-8f8c5f6c653d",
"timestamp": "2020-01-29T07:31:51.689168"
}
]
400: Bad Request
Error querying balances
{
"message": "Error message"
}

Filter element

Type

account_id

string

finqware id for the bank account

type

string

The balance type

currency

string

The balance currency

Filter example
"filter": {
"type": "Expected",
"currency": "RON"
}

Balance type

Description

ClosingAvailable

Closing balance of amount of money that is at the disposal of the account owner on the date specified.

ClosingBooked

Balance of the account at the end of the pre-agreed account reporting period. It is the sum of the opening booked balance at the beginning of the period and all entries booked to the account during the pre-agreed account reporting period.

ClosingCleared

Closing balance of amount of money that is cleared on the date specified.

Expected

Balance, composed of booked entries and pending items known at the time of calculation, which projects the end of day balance if everything is booked on the account and no other entry is posted.

ForwardAvailable

Forward available balance of money that is at the disposal of the account owner on the date specified.

Information

Balance for informational purposes.

InterimAvailable

Available balance calculated in the course of the account servicer's business day, at the time specified, and subject to further changes during the business day. The interim balance is calculated on the basis of booked credit and debit items during the calculation time/period specified.

InterimBooked

Balance calculated in the course of the account servicer's business day, at the time specified, and subject to further changes during the business day. The interim balance is calculated on the basis of booked credit and debit items during the calculation time/period specified.

InterimCleared

Cleared balance calculated in the course of the account servicer's business day, at the time specified, and subject to further changes during the business day.

OpeningAvailable

Opening balance of amount of money that is at the disposal of the account owner on the date specified.

OpeningBooked

Book balance of the account at the beginning of the account reporting period. It always equals the closing book balance from the previous report.

OpeningCleared

Opening balance of amount of money that is cleared on the date specified.

PreviouslyClosedBooked

Balance of the account at the previously closed account reporting period. The opening booked balance for the new period has to be equal to this balance. Usage: the previously booked closing balance should equal (inclusive date) the booked closing balance of the date it references and equal the actual booked opening balance of the current date.