Step 4: Get list of Banks
GET
/public/v3/webflow/banks
Get the list of Banks
For endpoint authorization use Authorization: AppUserToken {customer_token} header. Create customer tokento use it in the header.
none
none
none
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| Array | Bank | yes | Array of Banks |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| bank | Bank Metadata | yes | Bank metadata |
| accounts | Account | yes | Array of connected accounts |
| connected | bool | yes | Determines if a Bank is connected |
| last_account_consent | Account Consent | no | Account Consent Details |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| name | string | yes | Name of the bank |
| logo_url | string | yes | Logo URL |
| bank_configuration | Bank Configuration | yes | Configuration of the bank |
| slug | string | yes | Unique bank slug |
| is_active | boolean | yes | Determines if the bank is active and should be displayed to customers |
| country_code | string | yes | Country Code |
| type | string | yes | Type of a bank. Allowed values: Personal, Business, null (personal and business bank accounts) |
| is_working | boolean | yes | Determines if Planky has connection to particular bank at this moment |
| is_api_only | boolean | yes | Determines if the bank is used only for posting data to Planky and cannot be displayed to customers |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| account_type | string | yes | Type of the bank account. Allowed values: Personal, Business |
| account_number | string | yes | Account number |
| is_authorized | boolean | yes | Determines if Planky is authorized to pull data for this bank account |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| consent_id | string | yes | Consent ID provided by the bank. Min 1 char. |
| creation_date_time | timestamp | yes | Creation timestamp |
| status | string | yes | Consent status, one of: Rejected, Awaiting Authorisation, Authorised, Revoked |
| status_update_date_time | timestamp | yes | Status update timestamp |
| permissions | array | yes | List of permissions |
| expiration_date_time | timestamp | yes | Specified timestamp when the permissions will expire. If it is null, the permissions will not expire. |
| transaction_from_date_time | timestamp | yes | Specified timestamp for the transaction query period. If this is not populated, the start date will be open-ended, and data will be returned from the earliest available transaction |
| transaction_to_date_time | timestamp | yes | Specified timestamp for the transaction query period. If this is not populated, the end date will be open-ended, and data will be returned to the latest available transaction. |
| consent_reconfirmation_date | timestamp | yes | Specified timestamp for the consent reconfirmation date. Consent must be reconfirmed by the end customer every 90 days. The bank feed will not be updated if you do not reconfirm with end customer consent every 90 days. |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| transactions_consent_from | int | yes | Number of historical months for which bank account data will be accessed from the bank |
| transactions_consent_to | int | yes | Number of months in the future for which bank account data will be accessible |
1
2
3
curl --location --request GET 'https://api.friendlyscore.com/public/v3/webflow/banks' \
--header 'Content-Type: application/json' \
--header 'Authorization: AppUserToken {customer_token}'
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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
[
{
"bank": {
"name": "Planky Demo Bank",
"logo_url": "https://api.friendlyscore.com/bank-logos/x3/sandbox 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": "123",
"is_authorized": true
}
],
"connected": true,
"last_account_consent": {
"consent_id": "123",
"creation_date_time": 1737455998,
"status": "Authorised",
"status_update_date_time": 1737456072,
"permissions": [
"ReadAccountsBasic",
"ReadAccountsDetail",
"ReadBalances",
"ReadBeneficiariesBasic",
"ReadBeneficiariesDetail",
"ReadDirectDebits",
"ReadTransactionsCredits",
"ReadTransactionsDebits",
"ReadTransactionsDetail",
"ReadProducts",
"ReadStandingOrdersDetail",
"ReadParty",
"ReadStatementsBasic",
"ReadStatementsDetail"
],
"expiration_date_time": null,
"transaction_from_date_time": 1642761597,
"transaction_to_date_time": 1745228397,
"consent_reconfirmation_date": 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)