ichtrojan/nigerian-banks

An API that provides Nigerian bank logos, slug and code.

Nigerian Banks

Introduction

This project aims to simplify bank data used by developers for Fintech APIs (Flutterwave and Paystack). Paystack uses bank_code to process transfers to accounts while Flutterwave uses bank_slug for the same operation. As a bonus, bank logos are also returned. How is this useful? -- can be used to spice up your bank dropdown/list UI, It doesn't have to be boring.

Usage

Make a get request to https://nigerianbanks.xyz

Prerequisites

• Go installed on your machine
• Docker installed on your machine (optional)

Installation

• Clone this repository 🤷‍♂️ (obviously)

git clone https://github.com/ichtrojan/nigerian-banks.git

• Change directory

cd nigerian-banks

• Duplicate .env.example to .env

cp .env.example .env

• Run application

go run server.go

Alternatively, if you are a Docker fanboy, you can run:

docker-composer up

Your application will be served on port 9090 by default, you can change that by modifying the .env file.

Contributors

• Deji Ajibola - Twitter GitHub
• Adavize Ozorku - Twitter GitHub

Authors

• Kamsi Oleka - Twitter Github
• Michael Trojan Okoh - Twitter Github

nigerian-banks's Issues

Endpoint to fetch a single bank using their slug or code

An endpoint that takes a slug or code query param.

API is down

the api is down at the moment

Bad Gateway

URL Broken

Paycom is not included here as a bank

Please can you kindly add paycom as a nigerian bank to this API as well? It is highly needed

Enhancement Request: Support Palmpay, Opay & Moniepoint

The current version of the Nigerian Banks API lacks support for Palmpay, Opay and Moniepoint banks. As these banks are significant players in the Nigerian financial sector, their inclusion in the API would be highly beneficial for developers working with Nigerian bank data.

App not running on local environment - missing .env parameters

**_Please help provide guiduance here. We are building our Web app and need to call this service locally using the bankCode and BankLogo. But it won't run with the documentation here thus far. maybe i'm doing something wrong. PS i'm in MERN stack person, zero knowledge about GO. see below test.

My aim is actually to run this as a Container using Docker compose._**

root@mycreditchekb2c-mvp-1vcpu-2gb-intel-fra1-01:~/nigerian-banks# go run server.go
go: downloading github.com/ichtrojan/thoth v1.3.0
go: downloading github.com/gorilla/mux v1.7.4
go: downloading github.com/joho/godotenv v1.3.0
go: downloading github.com/rs/cors v1.7.0
go: downloading github.com/gorilla/securecookie v1.1.1
go: downloading github.com/jinzhu/gorm v1.9.16
go: downloading github.com/gorilla/websocket v1.4.2
go: downloading gorm.io/gorm v1.20.12
go: extracting github.com/ichtrojan/thoth v1.3.0
go: extracting github.com/gorilla/mux v1.7.4
go: extracting github.com/joho/godotenv v1.3.0
go: extracting github.com/jinzhu/gorm v1.9.16
go: extracting github.com/rs/cors v1.7.0
go: extracting gorm.io/gorm v1.20.12
go: extracting github.com/gorilla/securecookie v1.1.1
go: extracting github.com/gorilla/websocket v1.4.2
go: downloading github.com/lib/pq v1.1.1
go: downloading github.com/jinzhu/inflection v1.0.0
go: downloading github.com/go-sql-driver/mysql v1.5.0
go: downloading github.com/jinzhu/now v1.1.1
go: extracting github.com/jinzhu/inflection v1.0.0
go: extracting github.com/lib/pq v1.1.1
go: extracting github.com/jinzhu/now v1.1.1
go: extracting github.com/go-sql-driver/mysql v1.5.0
go: finding github.com/gorilla/mux v1.7.4
go: finding github.com/gorilla/securecookie v1.1.1
go: finding github.com/gorilla/websocket v1.4.2
go: finding gorm.io/gorm v1.20.12
go: finding github.com/jinzhu/inflection v1.0.0
go: finding github.com/jinzhu/now v1.1.1
go: finding github.com/jinzhu/gorm v1.9.16
go: finding github.com/go-sql-driver/mysql v1.5.0
go: finding github.com/lib/pq v1.1.1
go: finding github.com/ichtrojan/thoth v1.3.0
go: finding github.com/joho/godotenv v1.3.0
go: finding github.com/rs/cors v1.7.0
2022/03/22 09:46:07 HORUS_DB_USER not set in .env
exit status 1