Introduction

This API allows the users to check which banks are supported by the API. These banks are supported for payments (outgoing) from local wallets. Payments from cross border wallets are not yet allowed to banks.

📘

The API endpoint is

https://api.beyonic.com/api/banks

The Bank object

The Bank object has the following fields.

Field

Type

Description

id

long integer

Unique object identifier

name

string

The bank name

country

object

Expanded country object

swift_code

string

International swift code

{
            "id": 1,
            "name": "BANK OF AFRICA-UGANDA LTD",
            "country": {
                "iso": "UG",
                "iso3": "",
                "iso_numeric": null,
                "name": "Uganda",
                "printable_name": "Uganda",
                "phone_prefix": "+256",
                "supported": true
            },
            "swift_code": null
        }

Listing all Banks

To retrieve a list of all banks, make a GET request to the banks end point. This will return a list of banks.

Sample Request

curl https://api.beyonic.com/api/banks -H "Authorization: Token ab594c14986612f6167a975e1c369e71edab6900"
package com.beyonic.samples;

import com.beyonic.exceptions.BeyonicException;
import com.beyonic.models.*;

Beyonic.API_KEY = "ab594c14986612f6167a975e1c369e71edab6900";

String response = null;

try{
    response = new Bank().get();
    System.out.println(response);
}
catch (Exception e){
    e.printStackTrace();
}
<?php
require_once('./lib/Beyonic.php');
Beyonic::setApiKey("ab594c14986612f6167a975e1c369e71edab6900");

$banks = Beyonic_Bank::getAll();
?>
import beyonic
beyonic.api_key = 'ab594c14986612f6167a975e1c369e71edab6900'

banks = beyonic.Bank.list()
require 'beyonic'
Beyonic.api_key = 'ab594c14986612f6167a975e1c369e71edab6900'

banks = Beyonic::Bank.list

Sample Response
List of banks.

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 1,
            "name": "BANK OF AFRICA-UGANDA LTD",
            "country": {
                "iso": "UG",
                "iso3": "",
                "iso_numeric": null,
                "name": "Uganda",
                "printable_name": "Uganda",
                "phone_prefix": "+256",
                "supported": true
            },
            "swift_code": null
    }
  ]
}