Lean Docs

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

Whether the Bank is currently operational.

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.

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

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 POST '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
            }
        ]
    },
    {
        "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
            }
        ]
    }
]

© Lean Technologies Ltd. 2021