Banks

Lean's Bank objects make fetching a list of banks available to your application simple. You can use the /banks endpoint to cache the available banks for your application and display your own bank list UI, understand which bank a user is with via mapping of bank_identifiers and much more.

ENDPOINTS

GET /banks/v1

The Bank object

Attributes

id int deprecated

The unique identifier for the bank. This has been superseded by the identifier attribute.


identifier string

The unique identifier for the bank.


name string

The user-friendly name of the bank.


logo url deprecated

A black logo for the bank.


logo_alt url deprecated

A white logo for the bank


main_color string

The hex code for the main brand colour for the bank.


background_color string

The hex code for the secondary brand colour for the bank.


theme string

dark indicates that white text should be overlayed over the main_color, light indicates that black text should be overlayed over the main_color.


country_code string

The 3 letter ISO for the country the bank is located in.


active string _deprecated_

Whether the Bank is currently operational.


availability object

Whether the Bank is currently available for use with the Payments and Data API. Changes to this status trigger banks.availability.updated webhooks.

View details

Active object

Whether Lean has enabled the or disabled the Bank for Payments and Data functionality. When this is false, Lean has taken the bank offline due to stability, maintenance or regulatory reasons.


Enabled object

Whether the bank has been enabled in the application dashboard or not. If you want to hide a bank or disable it from use for any reason - you can log in to the Application Dashboard to enable and disable visibility and functionality of a bank on your platform.


traits array

An array of traits that are used internally to determine the type of bank connection.


supported_account_types array

Indicates the account types Lean supports for this bank. Accepted values are: CURRENT, SAVINGS, and CREDIT.


transfer_limits array

An array of key-value pairs for supported currencies and their associated transfer limits with the bank.


international_transfer_limits array

A list of objects representing the limits for transactions to international destinations. These limits apply to all transfers to international payments.

View international transfer limit attributes

currency string

The ISO 4217 currency code for the currency.


min float

The minimum supported transfer amount.


max float

The maximum supported transfer amount.


international_destinations array

A list of objects representing international destinations to where Lean can initiate international payments for this bank.

View international destination attributes

country_iso_code string

The alpha-3 (3 character) ISO 3166 country code for the destination country the bank can initiate transactions to.


country_name string

The name of the destination country the bank can initiate transactions to.

json

{
"id": 13,
"identifier": "FAB_UAE",
"name": "First Abu Dhabi Bank",
"logo": "https://cdn.leantech.me/img/bank-assets/uae/glyphs/fab/g-white-fab_uae.png",
"logo_alt": "https://cdn.leantech.me/img/bank-assets/uae/glyphs/fab/g-color-fab_uae.png",
"main_color": "#ffffff",
"background_color": "#00458A",
"theme": "dark",
"country_code": "ARE",
"active": true,
"availability": {
"active": { "payments": true, "data": true },
"enabled": { "payments": true, "data": true }
}
"traits": [
"user-input-on-login",
"auth-credentials"
],
"supported_account_types": [
"CREDIT",
"SAVINGS",
"CURRENT"
],
"transfer_limits": [
{
"currency": "AED",
"min": 10.000,
"max": 40000.000
},
{
"currency": "USD",
"min": 3.000,
"max": 10850.000
},
{
"currency": "BHD",
"min": 15.000,
"max": 4100.000
}
],
"international_transfer_limits": [
{
"currency": "BHD",
"min": 20.000,
"max": 4000.000
},
{
"currency": "USD",
"min": 50.000,
"max": 10800.000
}
],
"international_destinations": [
{
"country_iso_code": "BHR",
"country_name": "Bahrain"
},
{
"country_iso_code": "USA",
"country_name": "United States of America"
}
]
}

Fetching a list of Banks

Fetches a list of all banks supported for the current application. This can be used to render your own bank selection UI, and reconcile which banks are connected to your application through the bank_identifier.

Parameters

app_token string

Your application identifier.


Response

Returns an array of Bank objects.

bash

curl -X GET 'https://sandbox.leantech.me/banks/v1/' \
--header 'lean-app-token: YOUR_APP_TOKEN' \
--header 'Content-Type: application/json'

json

[
{
"id": 1,
"identifier": "LEANMB1_SAU",
"name": "Lean Mockbank",
"logo": "https://cdn.leantech.me/img/banks/white-lean.png",
"logo_alt": "https://cdn.leantech.me/img/banks/white-lean.svg",
"main_color": "#1beb75",
"background_color": "#001E26",
"theme": "dark",
"country_code": "SAU",
"active": true,
"traits": [
"user-input-on-login",
"auth-credentials"
],
"supported_account_types": [
"CREDIT",
"SAVINGS",
"CURRENT"
],
"transfer_limits": [
{
"currency": "USD",
"min": 10.000,
"max": 10000.000
},
{
"currency": "AED",
"min": 10.000,
"max": 40000.000
}
],
"international_destinations": [
{
"country_iso_code": "BHR",
"country_name": "Bahrain"
},
{
"country_iso_code": "USA",
"country_name": "United States of America"
}
]
},
{
"id": 34,
"identifier": "LEANMB2_SAU",
"name": "Lean Mockbank Two",
"logo": "https://cdn.leantech.me/img/banks/white-lean.png",
"logo_alt": "https://cdn.leantech.me/img/banks/white-lean.svg",
"main_color": "#1beb75",
"background_color": "#001E26",
"theme": "light",
"country_code": "SAU",
"active": true,
"traits": [
"user-input-on-login",
"auth-credentials"
],
"supported_account_types": [
"CREDIT",
"SAVINGS",
"CURRENT"
],
"transfer_limits": [
{
"currency": "AED",
"min": 10.000,
"max": 40000.000
},
{
"currency": "USD",
"min": 10.000,
"max": 10000.000
}
],
"international_destinations": [
{
"country_iso_code": "BHR",
"country_name": "Bahrain"
},
{
"country_iso_code": "GBR",
"country_name": "United Kingdom"
},
{
"country_iso_code": "IND",
"country_name": "India"
},
{
"country_iso_code": "USA",
"country_name": "United States of America"
},
{
"country_iso_code": "CAN",
"country_name": "Canada"
}
]
}
]