Step 4: Get list of Banks



Get the list of Banks

For endpoint authorization use Authorization: AppUserToken {customer_token} header. Create customer tokento use it in the header.



Query parameters


Request Body Parameters


Response Body Parameters

ParameterData typeRequired?Description
ArrayBankyesArray of Banks


ParameterData typeRequired?Description
bankBank MetadatayesBank metadata
accountsAccountyesArray of connected accounts
connectedboolyesDetermines if a Bank is connected
last_account_consentintnoTimestamp of the last consent

Bank Metadata

ParameterData typeRequired?Description
namestringyesName of the bank
logo_urlstringyesLogo URL
bank_configurationBank ConfigurationyesConfiguration of the bank
slugstringyesUnique bank slug
is_activebooleanyesDetermines if the bank is active and should be displayed to customers
country_codestringyesCountry Code
typestringyesType of a bank. Allowed values: Personal, Business, null (personal and business bank accounts)
is_workingbooleanyesDetermines if Planky has connection to particular bank at this moment
is_api_onlybooleanyesDetermines if the bank is used only for posting data to Planky and cannot be displayed to customers


ParameterData typeRequired?Description
account_typestringyesType of the bank account. Allowed values: Personal, Business
account_numberstringyesAccount number
is_authorizedbooleanyesDetermines if Planky is authorized to pull data for this bank account

Bank Configuration

ParameterData typeRequired?Description
transactions_consent_fromintyesNumber of historical months for which bank account data will be accessed from the bank
transactions_consent_tointyesNumber of months in the future for which bank account data will be accessible

Request example

1 2 3 curl --location --request GET '' \ --header 'Content-Type: application/json' \ --header 'Authorization: AppUserToken {customer_token}'

Response example:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 [ { "bank": { "name": "Planky Demo Bank", "logo_url": " bank@3x.png", "bank_configuration": { "transactions_consent_from": 36, "transactions_consent_to": 72 }, "slug": "fs-demo-bank", "is_active": true, "country_code": "GB", "type": null, "is_working": true, "is_api_only": false }, "accounts": [ { "account_type": "Personal", "account_number": "12345678" } ], "connected": false, "last_account_consent": null } ]

Was this article helpful?

Friendly Score UK Ltd.

84 Brook Street

London W1K 5EH

Call us on +44 20 3709 6726

Company registered in England

Company number 09168668, ICO ZA111687

VAT registration number 206 9758 80

Authorised and Regulated by the Financial Conduct Authority. (FRN: 821100, 781963)