{"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/management/banks/{BANK_ID}/dynamic-endpoints":{"get":{"tags":["Dynamic-Endpoint-Manage","API"],"summary":"Get Bank Level Dynamic Endpoints","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"
Get Bank Level Dynamic Endpoints.
Authentication is Mandatory
","operationId":"getBankLevelDynamicEndpoints","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"type":"object","required":["dynamic_endpoints"],"properties":{"dynamic_endpoints":{"type":"array","items":{"type":"object","properties":{"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"dynamic_endpoint_id":{"type":"string","example":"dynamic-endpoint-id"},"swagger_string":{"type":"object","properties":{"swagger":{"type":"string","example":"2.0"}},"required":["swagger"]}},"required":["user_id","dynamic_endpoint_id","swagger_string"]}}}}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankNotFound"}}}},"post":{"tags":["Dynamic-Endpoint-Manage","API"],"summary":"Create Bank Level Dynamic Endpoint","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Create dynamic endpoints.
Create dynamic endpoints with one json format swagger content.
If the host of swagger is dynamic_entity
, then you need link the swagger fields to the dynamic entity fields,
please check Endpoint Mapping
endpoints.
If the host of swagger is obp_mock
, every dynamic endpoint will return example response of swagger,
when create MethodRouting for given dynamic endpoint, it will be routed to given url.
Authentication is Mandatory
","operationId":"createBankLevelDynamicEndpoint","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"swagger":{"type":"string","example":"2.0"}},"required":["swagger"]}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"dynamic_endpoint_id":{"type":"string","example":"dynamic-endpoint-id"},"swagger_string":{"type":"object","properties":{"swagger":{"type":"string","example":"2.0"}},"required":["swagger"]}},"required":["user_id","dynamic_endpoint_id","swagger_string"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankNotFound"}}}}},"/obp/v4.0.0/management/banks/{BANK_ID}/dynamic-endpoints/DYNAMIC_ENDPOINT_ID":{"delete":{"tags":["Dynamic-Endpoint-Manage","API"],"summary":" Delete Bank Level Dynamic Endpoint","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete a Bank Level DynamicEndpoint specified by DYNAMIC_ENDPOINT_ID.
Authentication is Mandatory
","operationId":"deleteBankLevelDynamicEndpoint","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankNotFound"}}}},"get":{"tags":["Dynamic-Endpoint-Manage","API"],"summary":" Get Bank Level Dynamic Endpoint","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get a Bank Level Dynamic Endpoint.
Authentication is Mandatory
","operationId":"getBankLevelDynamicEndpoint","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"dynamic_endpoint_id":{"type":"string","example":"dynamic-endpoint-id"},"swagger_string":{"type":"object","properties":{"swagger":{"type":"string","example":"2.0"}},"required":["swagger"]}},"required":["user_id","dynamic_endpoint_id","swagger_string"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankNotFound"}}}}},"/obp/v4.0.0/management/banks/{BANK_ID}/dynamic-endpoints/DYNAMIC_ENDPOINT_ID/host":{"put":{"tags":["Dynamic-Endpoint-Manage","API"],"summary":" Update Bank Level Dynamic Endpoint Host","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update Bank Level dynamic endpoint Host.
The value can be obp_mock, dynamic_entity, or some service url.
Authentication is Mandatory
","operationId":"updateBankLevelDynamicEndpointHost","parameters":[{"in":"body","name":"body","description":"DynamicEndpointHostJson400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/DynamicEndpointHostJson400"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/DynamicEndpointHostJson400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankNotFound"}}}}},"/obp/v4.0.0/management/dynamic-endpoints":{"get":{"tags":["Dynamic-Endpoint-Manage","API"],"summary":" Get Dynamic Endpoints","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Dynamic Endpoints.
Authentication is Mandatory
","operationId":"getDynamicEndpoints","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","required":["dynamic_endpoints"],"properties":{"dynamic_endpoints":{"type":"array","items":{"type":"object","properties":{"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"dynamic_endpoint_id":{"type":"string","example":"dynamic-endpoint-id"},"swagger_string":{"type":"object","properties":{"swagger":{"type":"string","example":"2.0"}},"required":["swagger"]}},"required":["user_id","dynamic_endpoint_id","swagger_string"]}}}}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"post":{"tags":["Dynamic-Endpoint-Manage","API"],"summary":"Create Dynamic Endpoint","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Create dynamic endpoints.
Create dynamic endpoints with one json format swagger content.
If the host of swagger is dynamic_entity
, then you need link the swagger fields to the dynamic entity fields,
please check Endpoint Mapping
endpoints.
If the host of swagger is obp_mock
, every dynamic endpoint will return example response of swagger,
when create MethodRouting for given dynamic endpoint, it will be routed to given url.
Authentication is Mandatory
","operationId":"createDynamicEndpoint","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"swagger":{"type":"string","example":"2.0"}},"required":["swagger"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"dynamic_endpoint_id":{"type":"string","example":"dynamic-endpoint-id"},"swagger_string":{"type":"object","properties":{"swagger":{"type":"string","example":"2.0"}},"required":["swagger"]}},"required":["user_id","dynamic_endpoint_id","swagger_string"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/management/dynamic-endpoints/DYNAMIC_ENDPOINT_ID":{"delete":{"tags":["Dynamic-Endpoint-Manage","API"],"summary":" Delete Dynamic Endpoint","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete a DynamicEndpoint specified by DYNAMIC_ENDPOINT_ID.
Authentication is Mandatory
","operationId":"deleteDynamicEndpoint","parameters":[],"responses":{"204":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"get":{"tags":["Dynamic-Endpoint-Manage","API"],"summary":"Get Dynamic Endpoint","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get a Dynamic Endpoint.
Get one DynamicEndpoint,
Authentication is Mandatory
","operationId":"getDynamicEndpoint","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"dynamic_endpoint_id":{"type":"string","example":"dynamic-endpoint-id"},"swagger_string":{"type":"object","properties":{"swagger":{"type":"string","example":"2.0"}},"required":["swagger"]}},"required":["user_id","dynamic_endpoint_id","swagger_string"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/management/dynamic-endpoints/DYNAMIC_ENDPOINT_ID/host":{"put":{"tags":["Dynamic-Endpoint-Manage","API"],"summary":" Update Dynamic Endpoint Host","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update dynamic endpoint Host.
The value can be obp_mock, dynamic_entity, or some service url.
Authentication is Mandatory
","operationId":"updateDynamicEndpointHost","parameters":[{"in":"body","name":"body","description":"DynamicEndpointHostJson400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/DynamicEndpointHostJson400"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/DynamicEndpointHostJson400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/my/dynamic-endpoints":{"get":{"tags":["Dynamic-Endpoint-Manage","API"],"summary":"Get My Dynamic Endpoints","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get My Dynamic Endpoints.
Authentication is Mandatory
","operationId":"getMyDynamicEndpoints","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","required":["dynamic_endpoints"],"properties":{"dynamic_endpoints":{"type":"array","items":{"type":"object","properties":{"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"dynamic_endpoint_id":{"type":"string","example":"dynamic-endpoint-id"},"swagger_string":{"type":"object","properties":{"swagger":{"type":"string","example":"2.0"}},"required":["swagger"]}},"required":["user_id","dynamic_endpoint_id","swagger_string"]}}}}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/my/dynamic-endpoints/DYNAMIC_ENDPOINT_ID":{"delete":{"tags":["Dynamic-Endpoint-Manage","API"],"summary":"Delete My Dynamic Endpoint","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete a DynamicEndpoint specified by DYNAMIC_ENDPOINT_ID.
Authentication is Mandatory
","operationId":"deleteMyDynamicEndpoint","parameters":[],"responses":{"204":{"description":"Success"},"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."}}},"DynamicEndpointHostJson400":{"required":["host"],"properties":{"host":{"type":"string","example":"dynamic_entity"}}}}}