Bank & Branch - os-salahuddin/php8-cluster GitHub Wiki

Get Banks

This API provides list of banks

URL

[GET] http://127.0.0.1:8282/api/v1/private/banks

Sample Response

{
    "code": 200,
    "messages": [],
    "data": {
        "banks": [
            {
                "bank_id": 139,
                "bank_name": "AB Bank Limited",
                "bank_name_bn": "এবি ব্যাংক লিমিটেড",
                "logo": "https://deshipay.s3.ap-southeast-1.amazonaws.com/deshipay/bank/logo/rwHOI1653562249.png",
                "code": "020",
                "is_npsb_enable": true
            },
            {
                "bank_id": 140,
                "bank_name": "Agrani Bank Ltd",
                "bank_name_bn": "অগ্রণী ব্যাংক লিমিটেড",
                "logo": "https://deshipay.s3.ap-southeast-1.amazonaws.com/deshipay/bank/logo/GkCtS1656928096.png",
                "code": "010",
                "is_npsb_enable": true
            },
            {
                "bank_id": 141,
                "bank_name": "Al-Arafah Islami Bank Limited",
                "bank_name_bn": "আল-আরাফাহ ইসলামী ব্যাংক লিমিটেড",
                "logo": "https://deshipay.s3.ap-southeast-1.amazonaws.com/deshipay/bank/logo/e5TpR1656928407.png",
                "code": "015",
                "is_npsb_enable": true
            },
            {
                "bank_id": 142,
                "bank_name": "Ansar VDP Unnayan Bank",
                "bank_name_bn": "আনসার-ভিডিপি উন্নয়ন ব্যাংক",
                "logo": "https://deshipay.s3.ap-southeast-1.amazonaws.com/deshipay/bank/logo/wpTpz1657168438.jpg",
                "code": "ANSAR VDP BANK",
                "is_npsb_enable": false
            },
            {
                "bank_id": 143,
                "bank_name": "Bangladesh Commerce Bank Limited",
                "bank_name_bn": "বাংলাদেশ কমার্স ব্যাংক লিমিটেড",
                "logo": "https://deshipay.s3.ap-southeast-1.amazonaws.com/deshipay/bank/logo/YO3eO1657168352.png",
                "code": "030",
                "is_npsb_enable": true
            }   
        ]
    }
}

Sample Response Format

Parameter	Type	Description	Always Present
code	Int	HTTP code (e.g., 200)	Yes
messages	Array	Result messages (empty if no messages)	Yes
data.banks	Array	List of available banks	Yes
data.banks[].bank_id	Int	Unique ID of the bank	Yes
data.banks[].bank_name	String	Name of the bank in English	Yes
data.banks[].bank_name_bn	String	Name of the bank in Bangla	Yes
data.banks[].logo	String	URL of the bank's logo	Yes
data.banks[].code	String	Bank code	Yes
data.banks[].is_npsb_enable	Bool	Whether the bank supports NPSB transactions	Yes

Get Branch

This API provides list of branches identified by bank id

URL

[GET] http://127.0.0.1:8282/api/v1/bank/branches?bank_id=1

Sample Response

{
    "code": 200,
    "messages": [],
    "data": {
        "branches": [
            {
                "bank_id": 1,
                "branch_id": 18,
                "name": "Agrabad"
            },
            {
                "bank_id": 1,
                "branch_id": 2988,
                "name": "Agrabad Branch"
            },
            {
                "bank_id": 1,
                "branch_id": 3039,
                "name": "Alfadanga Branch"
            },
            {
                "bank_id": 1,
                "branch_id": 3072,
                "name": "Amberkhana Branch"
            },           
            {
                "bank_id": 1,
                "branch_id": 4,
                "name": "Uttara Branch"
            },
            {
                "bank_id": 1,
                "branch_id": 3035,
                "name": "Uttara Branch"
            },
            {
                "bank_id": 1,
                "branch_id": 3036,
                "name": "VIP Road Branch"
            }
        ]
    }
}

Sample Response Format

Parameter	Type	Description	Always Present
code	Int	HTTP code (e.g., 200)	Yes
messages	Array	Result messages (empty if no messages)	Yes
data.branches	Array	List of available bank branches	Yes
data.branches[].bank_id	Int	Unique ID of the bank	Yes
data.branches[].branch_id	Int	Unique ID of the branch	Yes
data.branches[].name	String	Name of the branch	Yes