Get Banks
GET
/public/v3/customers/{customer_id}/banks
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| customer_id | string | yes | Customer ID |
none
none
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| data | array | yes | Array of available banks |
| name | string | yes | Name of the bank |
| slug | string | yes | Bank slug (unique identifier). You will use bank slug in many endpoints to identify bank |
| is_active | boolean | yes | Information if the bank is active now |
| country_code | string | yes | Country code. Currently only GB is supported. |
| type | string | yes | Bank type (Personal or Business) |
| is_working | boolean | yes | Flag if bank's API is responding at this moment |
| is_api_only | boolean | yes | Flag if bank is available only via the API (Connectivity is not available). You can post your data to this kind of banks. |
| account_consents | Account Consent | yes | Bank accounts consents for this bank |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| consent_id | string | yes | Consent ID provided by bank. Min 1 char. |
| creation_date_time | timestamp | yes | Creation timestamp |
| status | string | yes | Consent status, one of: Rejected, AwaitingAuthorisation, Authorised, Revoked |
| status_update_date_time | timestamp | yes | Status update timestamp |
| 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. |
1
2
3
curl --location --request GET 'https://api.friendlyscore.com/public/v3/customers/{customer_id}/banks' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {access_token}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
"data": [
{
"name": "FS Demo Bank",
"slug": "fs-demo-bank",
"is_active": true,
"country_code": null,
"type": null,
"is_working": true,
"is_api_only": false,
"account_consents": [
{
"consent_id": "string",
"creation_date_time": "1553077496",
"status": "string",
"status_update_date_time": "1553077496",
"expiration_date_time": "1553077496",
"transaction_from_date_time": "1553077496",
"transaction_to_date_time": "1553077496"
}]
}
]
}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)