Skip to main content
Skip table of contents

Introduction to Balance Check

The service performs a Balances Check on the basis of the stored in the data source data about the latest imported account balance and (if available) overdraft limit. This report ist appropriate for B2B and B2C use cases.

What it solves

To ensure that a customer can pay an amount, a balance check can be performed.
This checks whether there is enough money available and can pay attention to whether the overdraft should be included or not.

Balance Check

Balance checks make it easy to check whether an amount is available in the account.
It can be decided whether an overdraft should be included or not.

Used data fields

No Case is required for checks. Only one data source must have been synchronized successfully.

The balance of the account(s) and the amount to be checked are mainly used as input data in this check.

Result

This gives you a quick overview of the data used in the report through aggregated values that can serve as a summary.

A full API schema can be seen here: https://docs.finapi.io/?product=di#post-/checks/balancesCheck

Field

Description

Mandatory

checkData

List of the check result, organized by accounts.

yes

checkData[].checkPassed

Returns a simple true or false whether the verification passed.

yes

checkData[].latestBalanceDate

The date of the latest available account balance.

no

checkData[].overdraftAvailable

Indicates whether the overdraft limit has been taken into account, while conducting the check.

In case the overdraft limit is available for the given account and was taken into consideration while conducting the check, overdraftAvailable is set to true.

yes

checkData[].accountId

UUID of the bank account belonging to the imported bank connection.

yes

checkData[].accountIban

IBAN of the bank account.

yes

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.