{"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/management/banks/{BANK_ID}/endpoint-mappings":{"get":{"tags":["Endpoint-Mapping"],"summary":"Get all Bank Level Endpoint Mappings","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"
Get all Bank Level Endpoint Mappings.
Authentication is Mandatory
","operationId":"getAllBankLevelEndpointMappings","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"type":"object","required":["endpoint-mappings"],"properties":{"endpoint-mappings":{"type":"array","items":{"type":"object","properties":{"operation_id":{"type":"string","example":"OBPv4.0.0-dynamicEndpoint_POST_account"},"request_mapping":{"type":"object","properties":{}},"response_mapping":{"type":"object","properties":{"name":{"type":"object","properties":{"entity":{"type":"string","example":"FooBar"},"field":{"type":"string","example":"name"},"query":{"type":"string","example":"number"}},"required":["entity","field","query"]},"balance":{"type":"object","properties":{"entity":{"type":"string","example":"FashionBrand"},"field":{"type":"string","example":"number"},"query":{"type":"string","example":"number"}},"required":["entity","field","query"]}},"required":["name","balance"]},"endpoint_mapping_id":{"type":"string","example":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50"}},"required":["operation_id","request_mapping","response_mapping","endpoint_mapping_id"]}}}}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankNotFound"}}}},"post":{"tags":["Endpoint-Mapping"],"summary":"Create Bank Level Endpoint Mapping","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Create an Bank Level Endpoint Mapping.
Note: at moment only support the dynamic endpoints
Authentication is Mandatory
","operationId":"createBankLevelEndpointMapping","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"operation_id":{"type":"string","example":"OBPv4.0.0-dynamicEndpoint_POST_account"},"request_mapping":{"type":"object","properties":{}},"response_mapping":{"type":"object","properties":{"name":{"type":"object","properties":{"entity":{"type":"string","example":"FooBar"},"field":{"type":"string","example":"name"},"query":{"type":"string","example":"number"}},"required":["entity","field","query"]},"balance":{"type":"object","properties":{"entity":{"type":"string","example":"FashionBrand"},"field":{"type":"string","example":"number"},"query":{"type":"string","example":"number"}},"required":["entity","field","query"]}},"required":["name","balance"]}},"required":["operation_id","request_mapping","response_mapping"]}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"operation_id":{"type":"string","example":"OBPv4.0.0-dynamicEndpoint_POST_account"},"request_mapping":{"type":"object","properties":{}},"response_mapping":{"type":"object","properties":{"name":{"type":"object","properties":{"entity":{"type":"string","example":"FooBar"},"field":{"type":"string","example":"name"},"query":{"type":"string","example":"number"}},"required":["entity","field","query"]},"balance":{"type":"object","properties":{"entity":{"type":"string","example":"FashionBrand"},"field":{"type":"string","example":"number"},"query":{"type":"string","example":"number"}},"required":["entity","field","query"]}},"required":["name","balance"]}},"required":["operation_id","request_mapping","response_mapping"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankNotFound"}}}}},"/obp/v5.0.0/management/banks/{BANK_ID}/endpoint-mappings/ENDPOINT_MAPPING_ID":{"delete":{"tags":["Endpoint-Mapping"],"summary":"Delete Bank Level Endpoint Mapping","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete a Bank Level Endpoint Mapping.
Authentication is Mandatory
","operationId":"deleteBankLevelEndpointMapping","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"204":{"description":"Success","schema":{"type":"boolean"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankNotFound"}}}},"get":{"tags":["Endpoint-Mapping"],"summary":"Get Bank Level Endpoint Mapping","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get an Bank Level Endpoint Mapping by ENDPOINT_MAPPING_ID.
Authentication is Mandatory
","operationId":"getBankLevelEndpointMapping","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"operation_id":{"type":"string","example":"OBPv4.0.0-dynamicEndpoint_POST_account"},"request_mapping":{"type":"object","properties":{}},"response_mapping":{"type":"object","properties":{"name":{"type":"object","properties":{"entity":{"type":"string","example":"FooBar"},"field":{"type":"string","example":"name"},"query":{"type":"string","example":"number"}},"required":["entity","field","query"]},"balance":{"type":"object","properties":{"entity":{"type":"string","example":"FashionBrand"},"field":{"type":"string","example":"number"},"query":{"type":"string","example":"number"}},"required":["entity","field","query"]}},"required":["name","balance"]},"endpoint_mapping_id":{"type":"string","example":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50"}},"required":["operation_id","request_mapping","response_mapping","endpoint_mapping_id"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankNotFound"}}}},"put":{"tags":["Endpoint-Mapping"],"summary":"Update Bank Level Endpoint Mapping","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update an Bank Level Endpoint Mapping.
Authentication is Mandatory
","operationId":"updateBankLevelEndpointMapping","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"operation_id":{"type":"string","example":"OBPv4.0.0-dynamicEndpoint_POST_account"},"request_mapping":{"type":"object","properties":{}},"response_mapping":{"type":"object","properties":{"name":{"type":"object","properties":{"entity":{"type":"string","example":"FooBar"},"field":{"type":"string","example":"name"},"query":{"type":"string","example":"number"}},"required":["entity","field","query"]},"balance":{"type":"object","properties":{"entity":{"type":"string","example":"FashionBrand"},"field":{"type":"string","example":"number"},"query":{"type":"string","example":"number"}},"required":["entity","field","query"]}},"required":["name","balance"]}},"required":["operation_id","request_mapping","response_mapping"]}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"operation_id":{"type":"string","example":"OBPv4.0.0-dynamicEndpoint_POST_account"},"request_mapping":{"type":"object","properties":{}},"response_mapping":{"type":"object","properties":{"name":{"type":"object","properties":{"entity":{"type":"string","example":"FooBar"},"field":{"type":"string","example":"name"},"query":{"type":"string","example":"number"}},"required":["entity","field","query"]},"balance":{"type":"object","properties":{"entity":{"type":"string","example":"FashionBrand"},"field":{"type":"string","example":"number"},"query":{"type":"string","example":"number"}},"required":["entity","field","query"]}},"required":["name","balance"]},"endpoint_mapping_id":{"type":"string","example":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50"}},"required":["operation_id","request_mapping","response_mapping","endpoint_mapping_id"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankNotFound"}}}}},"/obp/v5.0.0/management/endpoint-mappings":{"get":{"tags":["Endpoint-Mapping"],"summary":"Get all Endpoint Mappings","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get all Endpoint Mappings.
Authentication is Mandatory
","operationId":"getAllEndpointMappings","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","required":["endpoint-mappings"],"properties":{"endpoint-mappings":{"type":"array","items":{"type":"object","properties":{"operation_id":{"type":"string","example":"OBPv4.0.0-dynamicEndpoint_POST_account"},"request_mapping":{"type":"object","properties":{}},"response_mapping":{"type":"object","properties":{"name":{"type":"object","properties":{"entity":{"type":"string","example":"FooBar"},"field":{"type":"string","example":"name"},"query":{"type":"string","example":"number"}},"required":["entity","field","query"]},"balance":{"type":"object","properties":{"entity":{"type":"string","example":"FashionBrand"},"field":{"type":"string","example":"number"},"query":{"type":"string","example":"number"}},"required":["entity","field","query"]}},"required":["name","balance"]},"endpoint_mapping_id":{"type":"string","example":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50"}},"required":["operation_id","request_mapping","response_mapping","endpoint_mapping_id"]}}}}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"post":{"tags":["Endpoint-Mapping"],"summary":"Create Endpoint Mapping","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Create an Endpoint Mapping.
Note: at moment only support the dynamic endpoints
Authentication is Mandatory
","operationId":"createEndpointMapping","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"operation_id":{"type":"string","example":"OBPv4.0.0-dynamicEndpoint_POST_account"},"request_mapping":{"type":"object","properties":{}},"response_mapping":{"type":"object","properties":{"name":{"type":"object","properties":{"entity":{"type":"string","example":"FooBar"},"field":{"type":"string","example":"name"},"query":{"type":"string","example":"number"}},"required":["entity","field","query"]},"balance":{"type":"object","properties":{"entity":{"type":"string","example":"FashionBrand"},"field":{"type":"string","example":"number"},"query":{"type":"string","example":"number"}},"required":["entity","field","query"]}},"required":["name","balance"]}},"required":["operation_id","request_mapping","response_mapping"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"operation_id":{"type":"string","example":"OBPv4.0.0-dynamicEndpoint_POST_account"},"request_mapping":{"type":"object","properties":{}},"response_mapping":{"type":"object","properties":{"name":{"type":"object","properties":{"entity":{"type":"string","example":"FooBar"},"field":{"type":"string","example":"name"},"query":{"type":"string","example":"number"}},"required":["entity","field","query"]},"balance":{"type":"object","properties":{"entity":{"type":"string","example":"FashionBrand"},"field":{"type":"string","example":"number"},"query":{"type":"string","example":"number"}},"required":["entity","field","query"]}},"required":["name","balance"]}},"required":["operation_id","request_mapping","response_mapping"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v5.0.0/management/endpoint-mappings/ENDPOINT_MAPPING_ID":{"delete":{"tags":["Endpoint-Mapping"],"summary":"Delete Endpoint Mapping","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete a Endpoint Mapping.
Authentication is Mandatory
","operationId":"deleteEndpointMapping","parameters":[],"responses":{"204":{"description":"Success","schema":{"type":"boolean"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"get":{"tags":["Endpoint-Mapping"],"summary":"Get Endpoint Mapping by Id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get an Endpoint Mapping by ENDPOINT_MAPPING_ID.
Authentication is Mandatory
","operationId":"getEndpointMapping","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"operation_id":{"type":"string","example":"OBPv4.0.0-dynamicEndpoint_POST_account"},"request_mapping":{"type":"object","properties":{}},"response_mapping":{"type":"object","properties":{"name":{"type":"object","properties":{"entity":{"type":"string","example":"FooBar"},"field":{"type":"string","example":"name"},"query":{"type":"string","example":"number"}},"required":["entity","field","query"]},"balance":{"type":"object","properties":{"entity":{"type":"string","example":"FashionBrand"},"field":{"type":"string","example":"number"},"query":{"type":"string","example":"number"}},"required":["entity","field","query"]}},"required":["name","balance"]},"endpoint_mapping_id":{"type":"string","example":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50"}},"required":["operation_id","request_mapping","response_mapping","endpoint_mapping_id"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"put":{"tags":["Endpoint-Mapping"],"summary":"Update Endpoint Mapping","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update an Endpoint Mapping.
Authentication is Mandatory
","operationId":"updateEndpointMapping","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"operation_id":{"type":"string","example":"OBPv4.0.0-dynamicEndpoint_POST_account"},"request_mapping":{"type":"object","properties":{}},"response_mapping":{"type":"object","properties":{"name":{"type":"object","properties":{"entity":{"type":"string","example":"FooBar"},"field":{"type":"string","example":"name"},"query":{"type":"string","example":"number"}},"required":["entity","field","query"]},"balance":{"type":"object","properties":{"entity":{"type":"string","example":"FashionBrand"},"field":{"type":"string","example":"number"},"query":{"type":"string","example":"number"}},"required":["entity","field","query"]}},"required":["name","balance"]}},"required":["operation_id","request_mapping","response_mapping"]}}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"operation_id":{"type":"string","example":"OBPv4.0.0-dynamicEndpoint_POST_account"},"request_mapping":{"type":"object","properties":{}},"response_mapping":{"type":"object","properties":{"name":{"type":"object","properties":{"entity":{"type":"string","example":"FooBar"},"field":{"type":"string","example":"name"},"query":{"type":"string","example":"number"}},"required":["entity","field","query"]},"balance":{"type":"object","properties":{"entity":{"type":"string","example":"FashionBrand"},"field":{"type":"string","example":"number"},"query":{"type":"string","example":"number"}},"required":["entity","field","query"]}},"required":["name","balance"]},"endpoint_mapping_id":{"type":"string","example":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50"}},"required":["operation_id","request_mapping","response_mapping","endpoint_mapping_id"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}}},"definitions":{"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."}}}}}