Banks

If you wish to display a list of banks to your user then use this API to retrieve the list used by fumopay. Some banks have children entries which is used to differentiate between different channels that they offer their clients. How to use this information is explained below.

Request

Live

GET https://fumopay.app/banks/

Test

GET https://fumopay.dev/banks/

Response Example

An array of banks are returned. Below we have two banks with one having multiple channels/children.

[
    {
        "id": 2,
        "name": "Allied Irish Bank",
        "logo_url": "https://images.fumopay.app/banks/aib-logo.png",
    },
    {
        "id": 31,
        "name": "Bank of Scotland",
        "logo_url": "https://images.fumopay.app/banks/bank-of-scotland-logo.png",
        "sub_name": "Personal",
        "children": [
            {
                "id": 32,
                "name": "Bank of Scotland Business",
                "logo_url": "https://images.fumopay.app/banks/bank-of-scotland-logo.png",
                "sub_name": "Business",
            },
            {
                "id": 33,
                "name": "Bank of Scotland Commercial",
                "logo_url": "https://images.fumopay.app/banks/bank-of-scotland-logo.png",
                "sub_name": "Commercial",
                "receive_only": true,
            }
        ]
    },
]

Field descriptions

field	usage
id	The bank's id used by fumo
name	The name of the bank
sub_name	Alternative name for the bank. This is usually used to represent the banking channel eg. Personal or Business
logo_url	The url of the bank logo
children	The other channels available to this bank. See next section for more details
receive_only	Whether the bank can only be used for receiving funds. If this is set to true then the bank can't be used by the refund API

Children/Parent Relationships

When a bank has children entries then that bank uses different channels for their customers to complete payments. The parent bank is the common channel and usually the personal/retail banking channel. Using the Bank of Scotland example they need to be represented with 3 channels, namely Personal, Business and Commercial as defined by sub_name. Your user needs to pick between ids 31, 32 and 33 in this example.

Below is how we use it with fumo where the parent's name is the bank and then the 3 channels/children is nested below using sub_name.

Possible representation