Get Banks

GET

/public/v3/customers/{customer_id}/banks

Parameters

Parameter	Data type	Required?	Description
customer_id	string	yes	Customer ID

Query parameters

none

Request Body Parameters

none

Response Body Parameters

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

Account Consent

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
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.

Request example

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}'

Response example:

{
    "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)