{"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":"v4.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/v4.0.0/accounts/public":{"get":{"tags":["Account-Public","Account","PublicData"],"summary":"Get Public Accounts at all Banks","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"
Get public accounts at all banks (Anonymous access).
Returns accounts that contain at least one public view (a view where is_public is true)
For each account the API returns the ID and the available views.
Authentication is Optional
","operationId":"publicAccountsAllBanks","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/BasicAccountsJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorCannotGetAccounts"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/accounts/public":{"get":{"tags":["Account-Public","Account","PublicData"],"summary":"Get Public Accounts at Bank","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Returns a list of the public accounts (Anonymous access) at BANK_ID. For each account the API returns the ID and the available views.
Authentication is Optional
","operationId":"publicAccountsAtOneBank","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/BasicAccountsJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/public/accounts/{ACCOUNT_ID}/{VIEW_ID}/account":{"get":{"tags":["Account-Public","Account"],"summary":"Get Public Account by Id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Returns information about an account that has a public view.
The account is specified by ACCOUNT_ID. The information is moderated by the view specified by VIEW_ID.
PSD2 Context: PSD2 requires customers to have access to their account information via third party applications.
This call provides balance and other account information via delegated authentication using OAuth.
Authentication is Optional
","operationId":"getPublicAccountById","parameters":[{"in":"path","name":"VIEW_ID","description":"The view id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account 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/ModeratedCoreAccountJsonV300"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankNotFound"}}}}}},"definitions":{"ErrorBankNotFound":{"properties":{"message":{"type":"string","example":"OBP-30001: Bank not found. Please specify a valid value for BANK_ID."}}},"ErrorCannotGetAccounts":{"properties":{"message":{"type":"string","example":"OBP-30066: Could not get accounts."}}},"ErrorUnknownError":{"properties":{"message":{"type":"string","example":"OBP-50000: Unknown Error."}}},"AmountOfMoneyJsonV121":{"required":["currency","amount"],"properties":{"currency":{"type":"string","example":"EUR"},"amount":{"type":"string","example":"0"}}},"BasicAccountJSON":{"required":["id","label","bank_id","views_available"],"properties":{"id":{"type":"string","example":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0"},"label":{"type":"string","example":"NoneLabel"},"bank_id":{"type":"string","example":"gh.29.uk"},"views_available":{"type":"array","items":{"$ref":"#/definitions/BasicViewJson"}}}},"AccountRoutingJsonV121":{"required":["scheme","address"],"properties":{"scheme":{"type":"string","example":"AccountNumber"},"address":{"type":"string","example":"4930396"}}},"BasicViewJson":{"required":["id","short_name","is_public"],"properties":{"id":{"type":"string","example":"1"},"short_name":{"type":"string","example":"HHH"},"is_public":{"type":"boolean","example":"true"}}},"ModeratedCoreAccountJsonV300":{"required":["number","account_routings","label","owners","balance","bank_id","id","type","account_rules"],"properties":{"number":{"type":"string","example":""},"account_attributes":{"type":"array","items":{"$ref":"#/definitions/AccountAttributeResponseJson"}},"account_routings":{"type":"array","items":{"$ref":"#/definitions/AccountRoutingJsonV121"}},"label":{"type":"string","example":"My Account"},"owners":{"type":"array","items":{"$ref":"#/definitions/UserJSONV121"}},"balance":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"bank_id":{"type":"string","example":"gh.29.uk"},"id":{"type":"string","example":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"type":{"type":"string","example":""},"account_rules":{"type":"array","items":{"$ref":"#/definitions/AccountRuleJsonV300"}}}},"BasicAccountsJSON":{"required":["accounts"],"properties":{"accounts":{"type":"array","items":{"$ref":"#/definitions/BasicAccountJSON"}}}},"UserJSONV121":{"required":["id","provider","display_name"],"properties":{"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"provider":{"type":"string","example":"http://127.0.0.1:8080"},"display_name":{"type":"string","example":"OBP"}}},"AccountRuleJsonV300":{"required":["scheme","value"],"properties":{"scheme":{"type":"string","example":"OVERDRAFT"},"value":{"type":"string","example":"10"}}},"EmptyClassJson":{"required":["jsonString"],"properties":{"jsonString":{"type":"string","example":"{}"}}}}}