{"swagger":"2.0","info":{"title":"Open Bank Project API","description":"An Open Source API for Banks. (c) TESOBE GmbH. 2011 - 2024. Licensed under the AGPL and commercial licences.","contact":{"name":"TESOBE GmbH. / Open Bank Project","url":"https://openbankproject.com","email":"contact@tesobe.com"},"version":"v3.1.0"},"host":"api.ttk.com.mk","basePath":"/","schemes":["http","https"],"securityDefinitions":{"directLogin":{"type":"apiKey","description":"https://github.com/OpenBankProject/OBP-API/wiki/Direct-Login","in":"header","name":"Authorization"},"gatewayLogin":{"type":"apiKey","description":"https://github.com/OpenBankProject/OBP-API/wiki/Gateway-Login","in":"header","name":"Authorization"}},"security":[{"directLogin":[],"gatewayLogin":[]}],"paths":{"/obp/v3.1.0/banks":{"get":{"tags":["Bank","Account Information Service (AIS)","PSD2","New-Style"],"summary":"Get Banks","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"
Get banks on this API instance
Returns a list of banks supported on this server:
Authentication is Optional
","operationId":"OBPv3.0.0-getBanks","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/BanksJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}},"/obp/v3.1.0/banks/{BANK_ID}":{"get":{"tags":["Bank","Account Information Service (AIS)","PSD2","New-Style"],"summary":"Get Bank","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get the bank specified by BANK_ID
Returns information about a single bank specified by BANK_ID including:
Authentication is Mandatory
","operationId":"OBPv3.0.0-bankById","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/BankJson400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}}},"definitions":{"ErrorUserNotLoggedIn":{"properties":{"message":{"type":"string","example":"OBP-20001: User not logged in. Authentication is required!"}}},"ErrorUnknownError":{"properties":{"message":{"type":"string","example":"OBP-50000: Unknown Error."}}},"BanksJSON":{"required":["banks"],"properties":{"banks":{"type":"array","items":{"$ref":"#/definitions/BankJSON"}}}},"BankJSON":{"required":["website","full_name","logo","id","short_name","bank_routing"],"properties":{"website":{"type":"string","example":"www.openbankproject.com"},"full_name":{"type":"string","example":"full_name"},"logo":{"type":"string","example":"logo"},"id":{"type":"string","example":"gh.29.uk"},"short_name":{"type":"string","example":"short_name "},"bank_routing":{"$ref":"#/definitions/BankRoutingJsonV121"}}},"BankRoutingJsonV121":{"required":["scheme","address"],"properties":{"scheme":{"type":"string","example":"Bank_ID"},"address":{"type":"string","example":"gh.29.uk"}}},"BankJson400":{"required":["bank_routings","website","full_name","logo","id","short_name"],"properties":{"bank_routings":{"type":"array","items":{"$ref":"#/definitions/BankRoutingJsonV121"}},"website":{"type":"string","example":"www.openbankproject.com"},"full_name":{"type":"string","example":"full_name"},"logo":{"type":"string","example":"logo"},"id":{"type":"string","example":"gh.29.uk"},"short_name":{"type":"string","example":"short_name "}}},"EmptyClassJson":{"required":["jsonString"],"properties":{"jsonString":{"type":"string","example":"{}"}}}}}