OPopen-finance

Get all bank branches

get/bank-branches

Request

  • Base URL
    https://api.open-finance.ai/v2
  • URL
    https://api.open-finance.ai/v2/bank-branches
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.open-finance.ai/oauth/token scopes: read:providers

Query parameters

bankCodestring required

The bank code of the bank you would like to get the branches of

Response

Response

branchCodeinteger

The code of the branch

citystring

The city where the branch is located

POBstring nullable

Post Office Box number

branchNamestring

The name of the branch

faxstring nullable

The fax number of the branch

handicapAccessstring

Indicates if the branch has handicap access

dayClosedstring

The day the branch is closed

branchTypestring

The type of the branch

mergeBranchstring nullable

Code of the branch it merged with, if applicable

freeTelstring nullable

Free telephone number

closeDatestring date-time nullable

The date the branch was closed

branchAddressstring

The address of the branch

openDatestring date-time

The date the branch was opened

YCoordinatenumber double

The Y coordinate of the branch location

XCoordinatenumber double

The X coordinate of the branch location

telephonestring

The telephone number of the branch

zipCodestring nullable

The zip code of the branch

bankCodeinteger

The code of the bank

mergeBankstring nullable

Code of the bank it merged with, if applicable

Changes

No recorded changes to this operation across all 1 revision of this API.