Account Object

The Account object represents a financial account that exists at a bank, to which you have been granted access through user authorization.

Properties

id
string
required

Unique identifier for the account

bankId
string

The ID of the bank

bankName
string

The name of the bank

financialAddress
array
currency
string

The currency of the balance (ISO 4217 code)

accountName
string

The name of the account

Endpoints

List Accounts

Returns a list of accounts.

POST /api/service/data/accounts/list

Request

Response
{
    "accounts": [
        {
            "id": "bafab4a9-2532-5b78-8c6f-4b9b0ecb6302",
            "financialAddress": [
                {
                    "type": "iban",
                    "iban": {
                        "iban": "GB29NWBK60161331926819",
                        "accountHolderName": "Mickey Mouse"
                    }
                },
                {
                    "type": "sort_code",
                    "sortCode": {
                        "accountHolderName": "Mickey Mouse",
                        "sortCode": "123456",
                        "accountNumber": "12345678"
                    }
                }
            ],
            "bankId": "gb-wise",
            "bankName": "Wise (UK)",
            "currency": "GBP",
            "accountName": "GBP account"
        },
        {
            "id": "e4a387be-81bd-5036-ac04-90366b6c0cb8",
            "financialAddress": [
                {
                    "type": "iban",
                    "iban": {
                        "iban": "BE68539007547034",
                        "accountHolderName": "Mickey Mouse"
                    }
                },
                {
                    "type": "bban",
                    "bban": {
                        "bban": "0012345",
                        "accountHolderName": "Mickey Mouse"
                    }
                }
            ],
            "bankId": "gb-wise",
            "bankName": "Wise (UK)",
            "currency": "EUR",
            "accountName": "EUR account"
        }
    ]
}