Banks
bank objects represent bank branches authorised by RBI. The API allows you to retrieve banks. You can retrieve individual banks. This database is updated once a month, and may be updated more frequently if any major changes require publishing.
This endpoint is useful for you to determine whether an IFSC is recognised by our system, for translating an IFSC to a NACH bank, and for checking whether the NACH bank corresponding to the IFSC is live for the various NACH mandate variants. For example, if your customer is banking with ICICI Bank branch 'ICIC0000047', you might query to see if the IFSC is recognised by our system (this is required for 'physical variant and emandate_esign variant), or you may want to see if the bank is enabled for the emandate_api variant of NACH Debit. If it is enabled, you would proceed using the Source API endpoint.
The bank object
ATTRIBUTES
|
Attribute
|
Description
|
|---|---|
object string, value is "bank"
| String representing the object’s type. Objects of the same type share the same value.
|
livemode boolean
| Has the value true if the object exists in live mode or the value false if the object exists in test mode.
|
ifsc string
| 11-character IFSC identifier of the bank branch.
|
micr string
| 9-character MICR identifier of the bank branch.
|
name string
| The name of the bank.
|
branch string
| The name of the bank branch.
|
city string
| The city of the bank branch.
|
bank_data hash
| The full RBI bank branch data, including headers for UPI, BANK, CITY, IFSC, IMPS, MICR, NEFT, RTGS, STATE, SWIFT, BRANCH, CENTRE, ADDRESS, CONTACT, IS03166 (STATE CODE), DISTRICT.
|
nach_bank boolean
| Has the value true if the bank branch belongs to a live NACH bank, else the value false.
|
nach_bank_data hash
| The full GET NACH Bank response if nach_bank is true, else nil.
|