Get Bank Branch Details

GET 
/v1.2/master-data/bank/branches

Use to get the list of branches for a given institution and bank.

Request

Query Parameters

bankId stringrequired

Get bank Ids from Master Data> Get Institutional Bank Accounts

institutionCode stringrequired

Institution Code

Example: TRADE_API_INST_ONE

Header Parameters

Throttle-Key string

Responses

200

OK

application/json

Schema

Schema

status stringrequired

Possible values: [SUCCESS, FAILED]

reason stringnullablerequired
rejectCode integerrequired

Find error codes here

list object[]
Array [
branchId integer
The bank Id
bankBranchName string
Branch Name
bankAddress string
Branch Address
]

Example (from schema)

{
  "status": "SUCCESS",
  "reason": "string",
  "rejectCode": 0,
  "list": [
    {
      "branchId": 0,
      "bankBranchName": "string",
      "bankAddress": "string"
    }
  ]
}

example

{
  "status": "SUCCESS",
  "reason": null,
  "rejectCode": 0,
  "list": [
    {
      "branchId": 7,
      "bankBranchName": "KSA",
      "bankAddress": ""
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

timestamp string
status string
error string
message string
path string
rejectCode string

Example (from schema)

{
  "timestamp": "string",
  "status": "string",
  "error": "string",
  "message": "string",
  "path": "string",
  "rejectCode": "string"
}

Invalid Token

{
  "timestamp": "2023-12-28T09:51:50.682Z",
  "status": "401",
  "error": "Unauthorized",
  "message": "Invalid Token",
  "path": "/api/v1.2/master-data/bank/branches",
  "rejectCode": "1008"
}

Expired Token

{
  "timestamp": "2023-12-28T09:51:50.682Z",
  "status": "401",
  "error": "Unauthorized",
  "message": "Expired Token",
  "path": "/api/v1.2/master-data/bank/branches",
  "rejectCode": "1008"
}

Loading...