razorpay/ifsc

By razorpay

•Updated 7 days ago

Razorpay ifsc-api

Image

10K+

Overview Tags

razorpay/ifsc repository overview

⁠ifsc-api

API server that serves Razorpay's IFSC API.

Current API Root is https://ifsc.razorpay.com/⁠

⁠Documentation

The API documentation is maintained at https://github.com/razorpay/ifsc/wiki/API⁠.

⁠Search API

Route	Method	Response
/search	GET	JSON

⁠Query parameters

state: Filter used for querying by state. Uses the ISO3166 code
city: Filter used for querying by city
bankcode: Filter used for querying by bank code
limit: The number of items to return
offset: The offset from which to return data for pagination

A sample response for /search?limit=1&offset=0&bankcode=DENS:

{
	"BRANCH": "Delhi Nagrik Sehkari Bank IMPS",
	"CENTRE": "DELHI",
	"DISTRICT": "DELHI",
	"STATE": "MAHARASHTRA",
	"ADDRESS": "720, NEAR GHANTAGHAR, SUBZI MANDI, DELHI - 110007",
	"CONTACT": "+919560344685",
	"IMPS": true,
	"CITY": "MUMBAI",
	"UPI": true,
	"MICR": "110196002",
	"RTGS": true,
	"NEFT": true,
	"SWIFT": "",
	"ISO3166": "IN-MH",
	"BANK": "Delhi Nagrik Sehkari Bank",
	"BANKCODE": "DENS",
	"IFSC": "YESB0DNB002"
}

Route	Method	Response
/places	GET	JSON

⁠Query parameters

bankcode: Filter used for querying by bank code
state: Filter used for querying by state. Uses the ISO3166 code
district: Filter used for querying by district

When only bankcode is given then it returns the states in which the bank is present.
When bankcode and state are given then it returns the districts in which the bank is present.
When bankcode, state and district are given, then it returns the branches of the bank.
Any other combination of query parameters returns an error.

A sample response for /places?bankcode=AUBL

{
    "states": [
        "UTTAR PRADESH",
        "RAJASTHAN",
        "KARNATAKA",
        "GUJARAT",
        "PUNJAB",
        "MADHYA PRADESH",
        "DELHI",
        "MAHARASHTRA",
        "TAMIL NADU",
        "HARYANA",
        "WEST BENGAL",
        "TELANGANA",
        "ODISHA",
        "JAMMU AND KASHMIR",
        "KERALA",
        "CHHATTISGARH",
        "GOA",
        "ANDHRA PRADESH",
        "UTTARAKHAND",
        "BIHAR",
        "HIMACHAL PRADESH",
        "ASSAM"
    ]
}

A sample response for /places?state=IN-MP&bankcode=AUBL

{
    "districts": [
        "RATLAM",
        "TIKAMGARH",
        "VIDISHA",
        "INDORE",
        "MANDSAUR",
        "NEEMUCH",
        "KHARGONE",
        "DHUDHANA",
        "SEHORE",
        "DHAR",
        "SAGAR",
        "CHHINDWARA",
        "KATNI",
        "DEWAS",
        "WEST NIMAR",
        "JABALPUR",
        "BHOPAL",
        "HOSHANGABAD",
        "EAST NIMAR",
        "SHAJAPUR",
        "GWALIOR",
        "BARWANI",
        "NAJARPUR",
        "BETUL",
        "AGAR-MALWA",
        "RAJGARH",
        "CHATTARPUR",
        "RAISEN",
        "EA",
        "MANDLA",
        "KACHALIYA",
        "UJJAIN",
        "SATNA"
    ]
}

A sample response for /places?state=IN-MP&bankcode=AUBL&district=INDORE

{
    "branches": [
        "INDORE JAWAHAR MARG",
        "Barlai Jagir",
        "Bhanwar Kuan Road Indore",
        "AB Road Indore",
        "MG ROAD INDORE"
    ]
}

⁠Running the Docker Image

You can pull the image from razorpay/ifsc:latest

Run it with docker run --detach --publish 3000:3000 razorpay/ifsc:latest

This repo has the same tags as the parent IFSC repo.

⁠Development

bundle install
# Make sure redis is running and available at localhost:6379
# This initializes the redis server
bundle exec ruby init.rb
bundle exec rackup

Your server should now be accessible at http://localhost:9292

⁠License

Code is licensed under the MIT License. See LICENSE file for details. Everything under the data/ directory is available under the Public Domain.

Tag summary

Recent tags

Content type

Image

Digest

sha256:3fdd16a7a…

Size

81.5 MB

Last updated

7 days ago

docker pull razorpay/ifsc