Accounts

Query for bank accounts.

GET Accounts

POST https://api.finqware.com/v1/accounts/get

Get account data.

Request Body

Name	Type	Description
client_id*	string	An identifier for your tenant app.
client_secret*	string	A tenant app secret.
credentials_id*	string	A pointer to a consent record created via an onboarding session.
access_token*	string	An authorization key for this particular consent record.
tenant_user_id*	string	A unique identifier for your end-user.
include_errors	boolean	Optional, defaults to false. When true, the response also includes the errors from the latest bank synchronisations and its shape changes from a plain array to an envelope. See Sync errors.

200: OK A list of bank accounts and related info.

[
    {
        "data": {
            "account_schemes": [
                {
                    "identification": "CZ6355...254079",
                    "scheme_name": "IBAN"
                },
                {
                    "identification": "BRDEROBUXXX",
                    "scheme_name": "BICFI"
                }
            ],
            "balances": [
                {
                    // always a positive decimal number.
                    // for overdraft/negative balances check the credit_debit_indicator.
                    "balance_amount": "123.34",

                    "balance_currency": "RON",

                    // check the balances docs page for all supported types
                    "balance_type": "Expected",

                    "credit_limit_included": false,

                    // credit   -> positive or zero amount
                    // debit    -> negative amount (overdraft)
                    "credit_debit_indicator": "credit"
                }
            ],
            "account_sub_type": "Account sub-type",
            "account_type": "Personal current account",
            "currency": "RON",
            "name": "",
            "nickname": ""
        },
        "id": "f3dc1a92-...-b715a988553d",
        "servicer_id": "e5c11467-...-52a6492054d8",
        "servicer_name": "XYZ Bank",
        "timestamp": "2021-02-01T13:14:52Z"
    }
]

400: Bad Request

// check the errors docs page for details
{
  "id": "uuid",
  "type": "invalid_request",
  "http": 400,
  "code": "invalid_client_id",
  "message": "error message"
}