{"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":"v5.0.0"},"host":"apisandbox.openbankproject.com","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/v5.0.0/banks/{BANK_ID}/atms":{"get":{"tags":["ATM"],"summary":"Get Bank ATMS","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"
Returns information about ATMs for a single bank specified by BANK_ID including:
Pagination:
By default, 100 records are returned.
You can use the url query parameters limit and offset for pagination
Authentication is Optional
","operationId":"getAtms","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AtmsJsonV400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankNotFound"}}}},"head":{"tags":["ATM"],"summary":"Head Bank ATMS","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Head Bank ATMS.
Authentication is Optional
","operationId":"headAtms","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AtmsJsonV400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankNotFound"}}}},"post":{"tags":["ATM"],"summary":"Create ATM","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Create ATM.
Authentication is Mandatory
","operationId":"createAtm","parameters":[{"in":"body","name":"body","description":"AtmJsonV400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/AtmJsonV400"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/AtmJsonV400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v5.0.0/banks/{BANK_ID}/atms/{ATM_ID}":{"delete":{"tags":["ATM"],"summary":"Delete ATM","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete ATM.
Authentication is Mandatory
","operationId":"deleteAtm","parameters":[{"in":"path","name":"ATM_ID","description":"the atm id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"get":{"tags":["ATM"],"summary":"Get Bank ATM","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Returns information about ATM for a single bank specified by BANK_ID and ATM_ID including:
Update ATM.
Authentication is Mandatory
","operationId":"updateAtm","parameters":[{"in":"body","name":"body","description":"AtmJsonV400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/AtmJsonV400"}},{"in":"path","name":"ATM_ID","description":"the atm id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AtmJsonV400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v5.0.0/banks/{BANK_ID}/atms/{ATM_ID}/accessibility-features":{"put":{"tags":["ATM"],"summary":"Update ATM Accessibility Features","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update ATM Accessibility Features.
Authentication is Mandatory
","operationId":"updateAtmAccessibilityFeatures","parameters":[{"in":"body","name":"body","description":"AccessibilityFeaturesJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/AccessibilityFeaturesJson"}},{"in":"path","name":"ATM_ID","description":"the atm id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AtmAccessibilityFeaturesJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v5.0.0/banks/{BANK_ID}/atms/{ATM_ID}/location-categories":{"put":{"tags":["ATM"],"summary":"Update ATM Location Categories","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update ATM Location Categories.
Authentication is Mandatory
","operationId":"updateAtmLocationCategories","parameters":[{"in":"body","name":"body","description":"AtmLocationCategoriesJsonV400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/AtmLocationCategoriesJsonV400"}},{"in":"path","name":"ATM_ID","description":"the atm id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AtmLocationCategoriesResponseJsonV400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v5.0.0/banks/{BANK_ID}/atms/{ATM_ID}/notes":{"put":{"tags":["ATM"],"summary":"Update ATM Notes","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update ATM Notes.
Authentication is Mandatory
","operationId":"updateAtmNotes","parameters":[{"in":"body","name":"body","description":"AtmNotesJsonV400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/AtmNotesJsonV400"}},{"in":"path","name":"ATM_ID","description":"the atm id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AtmNotesResponseJsonV400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v5.0.0/banks/{BANK_ID}/atms/{ATM_ID}/services":{"put":{"tags":["ATM"],"summary":"Update ATM Services","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update ATM Services.
Authentication is Mandatory
","operationId":"updateAtmServices","parameters":[{"in":"body","name":"body","description":"AtmServicesJsonV400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/AtmServicesJsonV400"}},{"in":"path","name":"ATM_ID","description":"the atm id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AtmServicesResponseJsonV400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v5.0.0/banks/{BANK_ID}/atms/{ATM_ID}/supported-currencies":{"put":{"tags":["ATM"],"summary":"Update ATM Supported Currencies","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update ATM Supported Currencies.
Authentication is Mandatory
","operationId":"updateAtmSupportedCurrencies","parameters":[{"in":"body","name":"body","description":"SupportedCurrenciesJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/SupportedCurrenciesJson"}},{"in":"path","name":"ATM_ID","description":"the atm id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AtmSupportedCurrenciesJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v5.0.0/banks/{BANK_ID}/atms/{ATM_ID}/supported-languages":{"put":{"tags":["ATM"],"summary":"Update ATM Supported Languages","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update ATM Supported Languages.
Authentication is Mandatory
","operationId":"updateAtmSupportedLanguages","parameters":[{"in":"body","name":"body","description":"SupportedLanguagesJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/SupportedLanguagesJson"}},{"in":"path","name":"ATM_ID","description":"the atm id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AtmSupportedLanguagesJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}}},"definitions":{"ErrorInvalidJsonFormat":{"properties":{"message":{"type":"string","example":"OBP-10001: Incorrect json format."}}},"ErrorUserNotLoggedIn":{"properties":{"message":{"type":"string","example":"OBP-20001: User not logged in. Authentication is required!"}}},"ErrorBankNotFound":{"properties":{"message":{"type":"string","example":"OBP-30001: Bank not found. Please specify a valid value for BANK_ID."}}},"AccessibilityFeaturesJson":{"required":["accessibility_features"],"properties":{"accessibility_features":{"type":"array","items":{"type":"string"}}}},"SupportedLanguagesJson":{"required":["supported_languages"],"properties":{"supported_languages":{"type":"array","items":{"type":"string"}}}},"LicenseJsonV140":{"required":["id","name"],"properties":{"id":{"type":"string","example":"ODbL-1.0"},"name":{"type":"string","example":"Open Database License"}}},"SupportedCurrenciesJson":{"required":["supported_currencies"],"properties":{"supported_currencies":{"type":"array","items":{"type":"string"}}}},"AtmAccessibilityFeaturesJson":{"required":["atm_id","accessibility_features"],"properties":{"atm_id":{"type":"string","example":"atme-9a0f-4bfa-b30b-9003aa467f51"},"accessibility_features":{"type":"array","items":{"type":"string"}}}},"AtmNotesResponseJsonV400":{"required":["atm_id","notes"],"properties":{"atm_id":{"type":"string","example":"atme-9a0f-4bfa-b30b-9003aa467f51"},"notes":{"type":"array","items":{"type":"string"}}}},"AtmLocationCategoriesJsonV400":{"required":["location_categories"],"properties":{"location_categories":{"type":"array","items":{"type":"string"}}}},"AtmServicesJsonV400":{"required":["services"],"properties":{"services":{"type":"array","items":{"type":"string"}}}},"MetaJsonV140":{"required":["license"],"properties":{"license":{"$ref":"#/definitions/LicenseJsonV140"}}},"AtmSupportedCurrenciesJson":{"required":["atm_id","supported_currencies"],"properties":{"atm_id":{"type":"string","example":"atme-9a0f-4bfa-b30b-9003aa467f51"},"supported_currencies":{"type":"array","items":{"type":"string"}}}},"LocationJsonV140":{"required":["latitude","longitude"],"properties":{"latitude":{"type":"number","format":"double","example":"11.45"},"longitude":{"type":"number","format":"double","example":"11.45"}}},"AtmNotesJsonV400":{"required":["notes"],"properties":{"notes":{"type":"array","items":{"type":"string"}}}},"AddressJsonV300":{"required":["city","line_2","state","postcode","county","country_code","line_3","line_1"],"properties":{"city":{"type":"string","example":"Berlin"},"line_2":{"type":"string","example":"The Place"},"state":{"type":"string","example":"Brandenburg"},"postcode":{"type":"string","example":"13359"},"county":{"type":"string","example":""},"country_code":{"type":"string","example":"DE"},"line_3":{"type":"string","example":"The Hill"},"line_1":{"type":"string","example":"No 1 the Road"}}},"AtmSupportedLanguagesJson":{"required":["atm_id","supported_languages"],"properties":{"atm_id":{"type":"string","example":"atme-9a0f-4bfa-b30b-9003aa467f51"},"supported_languages":{"type":"array","items":{"type":"string"}}}},"AtmsJsonV400":{"required":["atms"],"properties":{"atms":{"type":"array","items":{"$ref":"#/definitions/AtmJsonV400"}}}},"AtmServicesResponseJsonV400":{"required":["atm_id","services"],"properties":{"atm_id":{"type":"string","example":"atme-9a0f-4bfa-b30b-9003aa467f51"},"services":{"type":"array","items":{"type":"string"}}}},"AtmJsonV400":{"required":["sunday","services","name","location","tuesday","cash_withdrawal_international_fee","wednesday","branch_identification","location_categories","site_identification","monday","has_deposit_capability","balance_inquiry_fee","site_name","more_info","bank_id","meta","supported_languages","supported_currencies","accessibility_features","address","cash_withdrawal_national_fee","friday","notes","is_accessible","thursday","saturday","located_at","minimum_withdrawal"],"properties":{"sunday":{"$ref":"#/definitions/OpeningTimesV300"},"services":{"type":"array","items":{"type":"string"}},"name":{"type":"string","example":"Atm by the Lake"},"location":{"$ref":"#/definitions/LocationJsonV140"},"tuesday":{"$ref":"#/definitions/OpeningTimesV300"},"cash_withdrawal_international_fee":{"type":"string","example":""},"wednesday":{"$ref":"#/definitions/OpeningTimesV300"},"branch_identification":{"type":"string","example":""},"location_categories":{"type":"array","items":{"type":"string"}},"site_identification":{"type":"string","example":""},"monday":{"$ref":"#/definitions/OpeningTimesV300"},"has_deposit_capability":{"type":"string","example":"true"},"balance_inquiry_fee":{"type":"string","example":""},"site_name":{"type":"string","example":""},"more_info":{"type":"string","example":"More information about this fee"},"bank_id":{"type":"string","example":"gh.29.uk"},"id":{"type":"string","example":"atme-9a0f-4bfa-b30b-9003aa467f51"},"meta":{"$ref":"#/definitions/MetaJsonV140"},"supported_languages":{"type":"array","items":{"type":"string"}},"supported_currencies":{"type":"array","items":{"type":"string"}},"accessibility_features":{"type":"array","items":{"type":"string"}},"address":{"$ref":"#/definitions/AddressJsonV300"},"cash_withdrawal_national_fee":{"type":"string","example":""},"friday":{"$ref":"#/definitions/OpeningTimesV300"},"notes":{"type":"array","items":{"type":"string"}},"is_accessible":{"type":"string","example":"true"},"thursday":{"$ref":"#/definitions/OpeningTimesV300"},"saturday":{"$ref":"#/definitions/OpeningTimesV300"},"located_at":{"type":"string","example":""},"minimum_withdrawal":{"type":"string","example":"5"}}},"OpeningTimesV300":{"required":["opening_time","closing_time"],"properties":{"opening_time":{"type":"string","example":"10:00"},"closing_time":{"type":"string","example":"18:00"}}},"AtmLocationCategoriesResponseJsonV400":{"required":["atm_id","location_categories"],"properties":{"atm_id":{"type":"string","example":"atme-9a0f-4bfa-b30b-9003aa467f51"},"location_categories":{"type":"array","items":{"type":"string"}}}}}}