{"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":"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/v4.0.0/TESTING":{"get":{"tags":["_TESTING","API","New-Style","Dynamic-Endpoint","Dynamic"],"summary":"Get TESTING List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"
Get TESTING List.
Description of this entity, can be markdown text.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"TESTING" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
Can do filter on the fields
e.g: /TESTING?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)
Create new TESTING.
Description of this entity, can be markdown text.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"TESTING" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"OBPv4.0.0-dynamicEntity_createTESTING","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"testing":{"type":"object","properties":{"tESTINGId":{"type":"string","example":"d0a5b4be-e0a7-4ead-9f6b-623045d0c718"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["tESTINGId","name","number"]}},"required":["testing"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/TESTING/T_ESTING_ID":{"delete":{"tags":["_TESTING","API","New-Style","Dynamic-Endpoint","Dynamic"],"summary":"Delete TESTING by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete TESTING by id
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"TESTING" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"OBPv4.0.0-dynamicEntity_deleteTESTING","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"204":{"description":"Success","schema":{"type":"object","properties":{"testing":{"type":"object","properties":{"tESTINGId":{"type":"string","example":"58ee45cd-1f0b-4cc5-bfdf-aaa2f8a3b24f"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["tESTINGId","name","number"]}},"required":["testing"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"get":{"tags":["_TESTING","API","New-Style","Dynamic-Endpoint","Dynamic"],"summary":"Get TESTING by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get TESTING by id.
Description of this entity, can be markdown text.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"TESTING" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"OBPv4.0.0-dynamicEntity_getSingleTESTING","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"testing":{"type":"object","properties":{"tESTINGId":{"type":"string","example":"4474f9b6-4987-4ffc-a1c8-b91bb9040c7f"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["tESTINGId","name","number"]}},"required":["testing"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"put":{"tags":["_TESTING","API","New-Style","Dynamic-Endpoint","Dynamic"],"summary":"Update TESTING","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update TESTING.
Description of this entity, can be markdown text.
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"TESTING" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"OBPv4.0.0-dynamicEntity_updateTESTING","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["name","number"]}}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"testing":{"type":"object","properties":{"tESTINGId":{"type":"string","example":"c3abbf18-35e1-44f7-87d4-faf1843ff86f"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["tESTINGId","name","number"]}},"required":["testing"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/adapter":{"get":{"tags":["API","New-Style"],"summary":"Get Adapter Info","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get basic information about the Adapter.
Authentication is Optional
","operationId":"OBPv3.1.0-getAdapterInfo","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/AdapterInfoJsonV300"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}},"/obp/v4.0.0/api/versions":{"get":{"tags":["Documentation","API"],"summary":"Get scanned API Versions","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get all the scanned API Versions.
Authentication is Optional
","operationId":"OBPv4.0.0-getScannedApiVersions","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","required":["scanned_api_versions"],"properties":{"scanned_api_versions":{"type":"array","items":{"$ref":"#/definitions/ScannedApiVersion"}}}}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/adapter":{"get":{"tags":["API","New-Style"],"summary":"Get Adapter Info for a bank","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get basic information about the Adapter listening on behalf of this bank.
Authentication is Optional
","operationId":"OBPv3.0.0-getAdapterInfoForBank","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/AdapterInfoJsonV300"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}},"/obp/v4.0.0/certs":{"get":{"tags":["API","Account Information Service (AIS)","PSD2","New-Style"],"summary":"Get JSON Web Key (JWK)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get the server's public JSON Web Key (JWK) set and certificate chain.
It is required by client applications to validate ID tokens, self-contained access tokens and other issued objects.
Authentication is Optional
","operationId":"OBPv3.1.0-getServerJWK","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/SeverJWK"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}},"/obp/v4.0.0/config":{"get":{"tags":["API","New-Style"],"summary":"Get API Configuration","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Returns information about:
Authentication is Mandatory
","operationId":"OBPv3.1.0-config","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/ConfigurationJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/connector/loopback":{"get":{"tags":["API","New-Style"],"summary":"Get Connector Status (Loopback)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"This endpoint makes a call to the Connector to check the backend transport (e.g. Kafka) is reachable.
Currently this is only implemented for Kafka based connectors.
For Kafka based connectors, this endpoint writes a message to Kafka and reads it again.
In the future, this endpoint may also return information about database connections etc.
Authentication is Mandatory
","operationId":"OBPv3.1.0-getObpConnectorLoopback","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/ObpApiLoopbackJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}},"/obp/v4.0.0/creditApplicationForm":{"get":{"tags":["_CreditApplicationForm","API","New-Style","Dynamic-Endpoint","Dynamic"],"summary":"Get Credit Application Form List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Credit Application Form List.
Form will be used for applying for a loan trough OBP APIs
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"creditApplicationForm" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
Can do filter on the fields
e.g: /creditApplicationForm?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)
Create new Credit Application Form.
Form will be used for applying for a loan trough OBP APIs
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"creditApplicationForm" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"OBPv4.0.0-dynamicEntity_createcreditApplicationForm","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"Marko Markosky"},"embg":{"type":"string","example":"1234567890123"},"amount":{"type":"integer","format":"int32","example":"30000"},"maturity":{"type":"integer","format":"int32","example":"3"},"mobileNumber":{"type":"string","example":"+38970123456"},"eMail":{"type":"string","example":"example@yahoo.com"},"acptTermsCond":{"type":"boolean","example":"true"}},"required":["name","embg","amount","maturity","mobileNumber","eMail","acptTermsCond"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"credit_application_form":{"type":"object","properties":{"creditApplicationFormId":{"type":"string","example":"6dd466ff-9eb4-47d6-994b-ca314152ec9c"},"name":{"type":"string","example":"Marko Markosky"},"embg":{"type":"string","example":"1234567890123"},"amount":{"type":"integer","format":"int32","example":"30000"},"maturity":{"type":"integer","format":"int32","example":"3"},"mobileNumber":{"type":"string","example":"+38970123456"},"eMail":{"type":"string","example":"example@yahoo.com"},"acptTermsCond":{"type":"boolean","example":"true"}},"required":["creditApplicationFormId","name","embg","amount","maturity","mobileNumber","eMail","acptTermsCond"]}},"required":["credit_application_form"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/creditApplicationForm/CREDIT_APPLICATION_FORM_ID":{"delete":{"tags":["_CreditApplicationForm","API","New-Style","Dynamic-Endpoint","Dynamic"],"summary":"Delete Credit Application Form by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete Credit Application Form by id
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"creditApplicationForm" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"OBPv4.0.0-dynamicEntity_deletecreditApplicationForm","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"Marko Markosky"},"embg":{"type":"string","example":"1234567890123"},"amount":{"type":"integer","format":"int32","example":"30000"},"maturity":{"type":"integer","format":"int32","example":"3"},"mobileNumber":{"type":"string","example":"+38970123456"},"eMail":{"type":"string","example":"example@yahoo.com"},"acptTermsCond":{"type":"boolean","example":"true"}},"required":["name","embg","amount","maturity","mobileNumber","eMail","acptTermsCond"]}}],"responses":{"204":{"description":"Success","schema":{"type":"object","properties":{"credit_application_form":{"type":"object","properties":{"creditApplicationFormId":{"type":"string","example":"a95c76e7-f03b-4d17-964d-6e4157984402"},"name":{"type":"string","example":"Marko Markosky"},"embg":{"type":"string","example":"1234567890123"},"amount":{"type":"integer","format":"int32","example":"30000"},"maturity":{"type":"integer","format":"int32","example":"3"},"mobileNumber":{"type":"string","example":"+38970123456"},"eMail":{"type":"string","example":"example@yahoo.com"},"acptTermsCond":{"type":"boolean","example":"true"}},"required":["creditApplicationFormId","name","embg","amount","maturity","mobileNumber","eMail","acptTermsCond"]}},"required":["credit_application_form"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"get":{"tags":["_CreditApplicationForm","API","New-Style","Dynamic-Endpoint","Dynamic"],"summary":"Get Credit Application Form by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Credit Application Form by id.
Form will be used for applying for a loan trough OBP APIs
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"creditApplicationForm" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"OBPv4.0.0-dynamicEntity_getSinglecreditApplicationForm","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"credit_application_form":{"type":"object","properties":{"creditApplicationFormId":{"type":"string","example":"ff310075-6c00-4988-a554-4adcea3b21c2"},"name":{"type":"string","example":"Marko Markosky"},"embg":{"type":"string","example":"1234567890123"},"amount":{"type":"integer","format":"int32","example":"30000"},"maturity":{"type":"integer","format":"int32","example":"3"},"mobileNumber":{"type":"string","example":"+38970123456"},"eMail":{"type":"string","example":"example@yahoo.com"},"acptTermsCond":{"type":"boolean","example":"true"}},"required":["creditApplicationFormId","name","embg","amount","maturity","mobileNumber","eMail","acptTermsCond"]}},"required":["credit_application_form"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"put":{"tags":["_CreditApplicationForm","API","New-Style","Dynamic-Endpoint","Dynamic"],"summary":"Update Credit Application Form","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update Credit Application Form.
Form will be used for applying for a loan trough OBP APIs
Property List:
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEntityProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"entityName", "value":"creditApplicationForm" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"OBPv4.0.0-dynamicEntity_updatecreditApplicationForm","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"Marko Markosky"},"embg":{"type":"string","example":"1234567890123"},"amount":{"type":"integer","format":"int32","example":"30000"},"maturity":{"type":"integer","format":"int32","example":"3"},"mobileNumber":{"type":"string","example":"+38970123456"},"eMail":{"type":"string","example":"example@yahoo.com"},"acptTermsCond":{"type":"boolean","example":"true"}},"required":["name","embg","amount","maturity","mobileNumber","eMail","acptTermsCond"]}}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"credit_application_form":{"type":"object","properties":{"creditApplicationFormId":{"type":"string","example":"31151b7b-ec42-46da-8f30-207113fa2b30"},"name":{"type":"string","example":"Marko Markosky"},"embg":{"type":"string","example":"1234567890123"},"amount":{"type":"integer","format":"int32","example":"30000"},"maturity":{"type":"integer","format":"int32","example":"3"},"mobileNumber":{"type":"string","example":"+38970123456"},"eMail":{"type":"string","example":"example@yahoo.com"},"acptTermsCond":{"type":"boolean","example":"true"}},"required":["creditApplicationFormId","name","embg","amount","maturity","mobileNumber","eMail","acptTermsCond"]}},"required":["credit_application_form"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/database/info":{"get":{"tags":["API","New-Style"],"summary":"Get Mapper Database Info","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get basic information about the Mapper Database.
Authentication is Mandatory
","operationId":"OBPv4.0.0-getMapperDatabaseInfo","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/AdapterInfoJsonV300"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/development/call_context":{"get":{"tags":["API","New-Style"],"summary":"Get the Call Context of a current call","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get the Call Context of the current call.
Authentication is Mandatory
","operationId":"OBPv4.0.0-getCallContext","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/EmptyClassJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/dynamic/banks":{"get":{"tags":["Swagger Call getBanks","API","New-Style","Dynamic-Entity","Dynamic"],"summary":"Call Obp_Api Get Banks","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Call get banks
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEndpointProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"url_pattern", "value":"https://api.ttk.com.mk/obp/v4.0.0/banks" }, { "key":"http_method", "value":"GET" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"OBPv4.0.0-dynamicEndpoint_GET_banks","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"gh.29.uk"},"short_name":{"type":"string","example":"short name value"},"full_name":{"type":"string","example":"full name value"},"logo":{"type":"string","example":"http://xxx/yyy.png"},"website":{"type":"string","example":"www.openbankproject.com"},"bank_routing":{"type":"object","properties":{"scheme":{"type":"string","example":"Bank_ID"},"address":{"type":"string","example":"gh.29.uk"}},"required":["scheme","address"]}},"required":["id","short_name","full_name","logo","website","bank_routing"]}}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/dynamic/delete/{USER_ID}":{"delete":{"tags":["Example Title","API","New-Style","Dynamic-Entity","Dynamic"],"summary":"Delete User","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete user by user ID
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEndpointProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"url_pattern", "value":"http://localhost:8080/user/delete/{userId}" }, { "key":"http_method", "value":"DELETE" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"OBPv4.0.0-dynamicEndpoint_DELETE_delete_USER_ID","parameters":[{"in":"path","name":"USER_ID","description":"The user id","required":true,"type":"string"}],"responses":{"204":{"description":"Success","schema":{"type":"string"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/dynamic/getById/{USER_ID}":{"get":{"tags":["Example Title","API","New-Style","Dynamic-Entity","Dynamic"],"summary":"Get User","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get reuested user by user ID
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEndpointProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"url_pattern", "value":"http://localhost:8080/user/getById/{userId}" }, { "key":"http_method", "value":"GET" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"OBPv4.0.0-dynamicEndpoint_GET_getById_USER_ID","parameters":[{"in":"path","name":"USER_ID","description":"The user id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":"1"},"first_name":{"type":"string","example":"string"},"last_name":{"type":"string","example":"string"},"age":{"type":"integer","format":"int32","example":"1"},"career":{"type":"string","example":"string"}},"required":["id","first_name","last_name","age","career"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/dynamic/listUsers":{"get":{"tags":["Example Title","API","New-Style","Dynamic-Entity","Dynamic"],"summary":"Get Users","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get list of users
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEndpointProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"url_pattern", "value":"http://localhost:8080/user/listUsers" }, { "key":"http_method", "value":"GET" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"OBPv4.0.0-dynamicEndpoint_GET_listUsers","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":"1"},"first_name":{"type":"string","example":"string"},"last_name":{"type":"string","example":"string"},"age":{"type":"integer","format":"int32","example":"1"},"career":{"type":"string","example":"string"}},"required":["id","first_name","last_name","age","career"]}}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/dynamic/save":{"post":{"tags":["Example Title","API","New-Style","Dynamic-Entity","Dynamic"],"summary":"Create User","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Create User
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEndpointProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"url_pattern", "value":"http://localhost:8080/user/save" }, { "key":"http_method", "value":"POST" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"OBPv4.0.0-dynamicEndpoint_POST_save","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":"1"},"first_name":{"type":"string","example":"string"},"last_name":{"type":"string","example":"string"},"age":{"type":"integer","format":"int32","example":"1"},"career":{"type":"string","example":"string"}},"required":["id","first_name","last_name","age","career"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":"1"},"first_name":{"type":"string","example":"string"},"last_name":{"type":"string","example":"string"},"age":{"type":"integer","format":"int32","example":"1"},"career":{"type":"string","example":"string"}},"required":["id","first_name","last_name","age","career"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/dynamic/updateUser":{"put":{"tags":["Example Title","API","New-Style","Dynamic-Entity","Dynamic"],"summary":"Update User","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update User
MethodRouting settings example:
{ "is_bank_id_exact_match":false, "method_name":"dynamicEndpointProcess", "connector_name":"rest_vMar2019", "bank_id_pattern":".*", "parameters":[ { "key":"url_pattern", "value":"http://localhost:8080/user/updateUser" }, { "key":"http_method", "value":"PUT" } { "key":"url", "value":"http://mydomain.com/xxx" } ]}
Authentication is Mandatory
","operationId":"OBPv4.0.0-dynamicEndpoint_PUT_updateUser","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":"1"},"first_name":{"type":"string","example":"string"},"last_name":{"type":"string","example":"string"},"age":{"type":"integer","format":"int32","example":"1"},"career":{"type":"string","example":"string"}},"required":["id","first_name","last_name","age","career"]}}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":"1"},"first_name":{"type":"string","example":"string"},"last_name":{"type":"string","example":"string"},"age":{"type":"integer","format":"int32","example":"1"},"career":{"type":"string","example":"string"}},"required":["id","first_name","last_name","age","career"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/jwks-uris":{"get":{"tags":["API","New-Style"],"summary":"Get JSON Web Key (JWK) URIs","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get the OAuth2 server's public JSON Web Key (JWK) URIs.
It is required by client applications to validate ID tokens, self-contained access tokens and other issued objects.
Authentication is Optional
","operationId":"OBPv3.1.0-getOAuth2ServerJWKsURIs","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/OAuth2ServerJwksUrisJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}},"/obp/v4.0.0/management/banks/{BANK_ID}/dynamic-entities":{"get":{"tags":["Dynamic-Entity-(Manage)","API","New-Style"],"summary":"Get Bank Level Dynamic Entities","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get all the bank level Dynamic Entities.
Authentication is Mandatory
","operationId":"OBPv4.0.0-getBankLevelDynamicEntities","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"type":"object","required":["dynamic_entities"],"properties":{"dynamic_entities":{"type":"array","items":{"$ref":"#/definitions/DynamicEntityFooBar"}}}}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/management/cascading/banks/{BANK_ID}/accounts/{ACCOUNT_ID}":{"delete":{"tags":["Account","API","New-Style"],"summary":"Delete Account Cascade","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete an Account Cascade specified by ACCOUNT_ID.
Authentication is Mandatory
","operationId":"OBPv4.0.0-deleteAccountCascade","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"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":{"204":{"description":"Success","schema":{"$ref":"#/definitions/EmptyClassJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/management/cascading/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/transactions/{TRANSACTION_ID}":{"delete":{"tags":["Transaction","API","New-Style"],"summary":"Delete Transaction Cascade","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete a Transaction Cascade specified by TRANSACTION_ID.
Authentication is Mandatory
","operationId":"OBPv4.0.0-deleteTransactionCascade","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"TRANSACTION_ID","description":"The transaction 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":{"204":{"description":"Success","schema":{"$ref":"#/definitions/EmptyClassJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/management/cascading/banks/{BANK_ID}/products/{PRODUCT_CODE}":{"delete":{"tags":["Product","API","New-Style"],"summary":"Delete Product Cascade","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete a Product Cascade specified by PRODUCT_CODE.
Authentication is Mandatory
","operationId":"OBPv4.0.0-deleteProductCascade","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"PRODUCT_CODE","description":"the product code","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"204":{"description":"Success","schema":{"$ref":"#/definitions/EmptyClassJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/management/connector/metrics":{"get":{"tags":["Metric","API","New-Style"],"summary":"Get Connector Metrics","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get the all metrics
require CanGetConnectorMetrics role
Filters Part 1.filtering (no wilde cards etc.) parameters to GET /management/connector/metrics
Should be able to filter on the following metrics fields
eg: /management/connector/metrics?from_date=2017-09-19T02:31:05.000Z&to_date=2017-09-19T02:31:05.000Z&limit=50&offset=2
1 from_date (defaults to one week before current date): eg:from_date=2017-09-19T02:31:05.000Z
2 to_date (defaults to current date) eg:to_date=2017-09-19T02:31:05.000Z
3 limit (for pagination: defaults to 1000) eg:limit=2000
4 offset (for pagination: zero index, defaults to 0) eg: offset=10
eg: /management/connector/metrics?from_date=2017-09-19T02:31:05.000Z&to_date=2017-09-19T02:31:05.000Z&limit=100&offset=300
Other filters:
5 connector_name (if null ignore)
6 function_name (if null ignore)
7 correlation_id (if null ignore)
Authentication is Mandatory
","operationId":"OBPv2.2.0-getConnectorMetrics","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/ConnectorMetricsJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorInvalidDateFormat"}}}}},"/obp/v4.0.0/management/consumers":{"get":{"tags":["Consumer","API","New-Style"],"summary":"Get Consumers","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get the all Consumers.
Authentication is Mandatory
","operationId":"OBPv3.1.0-getConsumers","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/ConsumersJsonV310"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/management/consumers/{CONSUMER_ID}":{"get":{"tags":["Consumer","API","New-Style"],"summary":"Get Consumer","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get the Consumer specified by CONSUMER_ID.
Authentication is Mandatory
","operationId":"OBPv3.1.0-getConsumer","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"CONSUMER_ID","description":"new consumer id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ConsumerJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"put":{"tags":["Consumer","API","New-Style"],"summary":"Enable or Disable Consumers","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Enable/Disable a Consumer specified by CONSUMER_ID.
Authentication is Mandatory
","operationId":"OBPv3.1.0-enableDisableConsumers","parameters":[{"in":"body","name":"body","description":"PutEnabledJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PutEnabledJSON"}},{"in":"path","name":"CONSUMER_ID","description":"new consumer id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/PutEnabledJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/management/consumers/{CONSUMER_ID}/consumer/redirect_url":{"put":{"tags":["Consumer","API"],"summary":"Update Consumer RedirectUrl","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update an existing redirectUrl for a Consumer specified by CONSUMER_ID.
CONSUMER_ID can be obtained after you register the application.
Or use the endpoint 'Get Consumers' to get it
Authentication is Mandatory
","operationId":"OBPv2.1.0-updateConsumerRedirectUrl","parameters":[{"in":"body","name":"body","description":"ConsumerRedirectUrlJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/ConsumerRedirectUrlJSON"}},{"in":"path","name":"CONSUMER_ID","description":"new consumer id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ConsumerJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/management/dynamic-endpoints":{"get":{"tags":["Dynamic-Endpoint-(Manage)","API","New-Style"],"summary":" Get Dynamic Endpoints","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Dynamic Endpoints.
Authentication is Mandatory
","operationId":"OBPv4.0.0-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","New-Style"],"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 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":"OBPv4.0.0-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","New-Style"],"summary":" Delete Dynamic Endpoint","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete a DynamicEndpoint specified by DYNAMIC_ENDPOINT_ID.
Authentication is Mandatory
","operationId":"OBPv4.0.0-deleteDynamicEndpoint","parameters":[],"responses":{"204":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"get":{"tags":["Dynamic-Endpoint-(Manage)","API","New-Style"],"summary":" Get Dynamic Endpoint","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get a Dynamic Endpoint.
Get one DynamicEndpoint,
Authentication is Mandatory
","operationId":"OBPv4.0.0-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-entities":{"get":{"tags":["Dynamic-Entity-(Manage)","API","New-Style"],"summary":"Get Dynamic Entities","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get the all Dynamic Entities.
Authentication is Mandatory
","operationId":"OBPv4.0.0-getDynamicEntities","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","required":["dynamic_entities"],"properties":{"dynamic_entities":{"type":"array","items":{"$ref":"#/definitions/DynamicEntityFooBar"}}}}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"post":{"tags":["Dynamic-Entity-(Manage)","API","New-Style"],"summary":"Create Dynamic Entity","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Create a DynamicEntity.
Authentication is Mandatory
Create one DynamicEntity, after created success, the corresponding CRUD endpoints will be generated automatically
Current support field types as follow:
[number, integer, boolean, string, DATE_WITH_DAY, reference]
DATE_WITH_DAY format: yyyy-MM-dd
Value of reference type is corresponding ids, please look at the following examples.
Current supporting reference types and corresponding examples as follow:
"someField0": { "type": "reference:TESTING", "example": "29c17ddb-45d6-4de0-851f-88fd0031ba15"}"someField1": { "type": "reference:creditApplicationForm", "example": "29c17ddb-45d6-4de0-851f-88fd0031ba15"}"someField2": { "type": "reference:Bank", "example": "29c17ddb-45d6-4de0-851f-88fd0031ba15"}"someField3": { "type": "reference:Consumer", "example": "29c17ddb-45d6-4de0-851f-88fd0031ba15"}"someField4": { "type": "reference:Customer", "example": "29c17ddb-45d6-4de0-851f-88fd0031ba15"}"someField5": { "type": "reference:MethodRouting", "example": "29c17ddb-45d6-4de0-851f-88fd0031ba15"}"someField6": { "type": "reference:DynamicEntity", "example": "29c17ddb-45d6-4de0-851f-88fd0031ba15"}"someField7": { "type": "reference:TransactionRequest", "example": "29c17ddb-45d6-4de0-851f-88fd0031ba15"}"someField8": { "type": "reference:ProductAttribute", "example": "29c17ddb-45d6-4de0-851f-88fd0031ba15"}"someField9": { "type": "reference:AccountAttribute", "example": "29c17ddb-45d6-4de0-851f-88fd0031ba15"}"someField10": { "type": "reference:TransactionAttribute", "example": "29c17ddb-45d6-4de0-851f-88fd0031ba15"}"someField11": { "type": "reference:CustomerAttribute", "example": "29c17ddb-45d6-4de0-851f-88fd0031ba15"}"someField12": { "type": "reference:AccountApplication", "example": "29c17ddb-45d6-4de0-851f-88fd0031ba15"}"someField13": { "type": "reference:CardAttribute", "example": "29c17ddb-45d6-4de0-851f-88fd0031ba15"}"someField14": { "type": "reference:Counterparty", "example": "29c17ddb-45d6-4de0-851f-88fd0031ba15"}"someField15": { "type": "reference:Branch:bankId&branchId", "example": "bankId=29c17ddb-45d6-4de0-851f-88fd0031ba15&branchId=1b1454b6-4f3e-42fc-81a6-e6876cf3a13c"}"someField16": { "type": "reference:Atm:bankId&atmId", "example": "bankId=29c17ddb-45d6-4de0-851f-88fd0031ba15&atmId=1b1454b6-4f3e-42fc-81a6-e6876cf3a13c"}"someField17": { "type": "reference:BankAccount:bankId&accountId", "example": "bankId=29c17ddb-45d6-4de0-851f-88fd0031ba15&accountId=1b1454b6-4f3e-42fc-81a6-e6876cf3a13c"}"someField18": { "type": "reference:Product:bankId&productCode", "example": "bankId=29c17ddb-45d6-4de0-851f-88fd0031ba15&productCode=1b1454b6-4f3e-42fc-81a6-e6876cf3a13c"}"someField19": { "type": "reference:PhysicalCard:bankId&cardId", "example": "bankId=29c17ddb-45d6-4de0-851f-88fd0031ba15&cardId=1b1454b6-4f3e-42fc-81a6-e6876cf3a13c"}"someField20": { "type": "reference:Transaction:bankId&accountId&transactionId", "example": "bankId=29c17ddb-45d6-4de0-851f-88fd0031ba15&accountId=1b1454b6-4f3e-42fc-81a6-e6876cf3a13c&transactionId=d7dfa4ca-8d11-4eda-95f9-dff5932f5171"}"someField21": { "type": "reference:Counterparty:bankId&accountId&counterpartyId", "example": "bankId=29c17ddb-45d6-4de0-851f-88fd0031ba15&accountId=1b1454b6-4f3e-42fc-81a6-e6876cf3a13c&counterpartyId=d7dfa4ca-8d11-4eda-95f9-dff5932f5171"}
Note: BankId filed is optional,
if you add it, the entity will be the Bank level.
if you omit it, the entity will be the System level.
Delete a DynamicEntity specified by DYNAMIC_ENTITY_ID.
Authentication is Mandatory
","operationId":"OBPv4.0.0-deleteDynamicEntity","parameters":[{"in":"path","name":"DYNAMIC_ENTITY_ID","description":"the dynamic entity id ","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"put":{"tags":["Dynamic-Entity-(Manage)","API","New-Style"],"summary":"Update Dynamic Entity","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update a DynamicEntity.
Authentication is Mandatory
Update one DynamicEntity, after update finished, the corresponding CRUD endpoints will be changed.
Current support field types as follow:
[number, integer, boolean, string, DATE_WITH_DAY, reference]
DATE_WITH_DAY format: yyyy-MM-dd
Value of reference type is corresponding ids, please look at the following examples.
Current supporting reference types and corresponding examples as follow:
"someField0": { "type": "reference:TESTING", "example": "8013ee7e-d280-4caf-816d-d0534897adb7"}"someField1": { "type": "reference:creditApplicationForm", "example": "8013ee7e-d280-4caf-816d-d0534897adb7"}"someField2": { "type": "reference:Bank", "example": "8013ee7e-d280-4caf-816d-d0534897adb7"}"someField3": { "type": "reference:Consumer", "example": "8013ee7e-d280-4caf-816d-d0534897adb7"}"someField4": { "type": "reference:Customer", "example": "8013ee7e-d280-4caf-816d-d0534897adb7"}"someField5": { "type": "reference:MethodRouting", "example": "8013ee7e-d280-4caf-816d-d0534897adb7"}"someField6": { "type": "reference:DynamicEntity", "example": "8013ee7e-d280-4caf-816d-d0534897adb7"}"someField7": { "type": "reference:TransactionRequest", "example": "8013ee7e-d280-4caf-816d-d0534897adb7"}"someField8": { "type": "reference:ProductAttribute", "example": "8013ee7e-d280-4caf-816d-d0534897adb7"}"someField9": { "type": "reference:AccountAttribute", "example": "8013ee7e-d280-4caf-816d-d0534897adb7"}"someField10": { "type": "reference:TransactionAttribute", "example": "8013ee7e-d280-4caf-816d-d0534897adb7"}"someField11": { "type": "reference:CustomerAttribute", "example": "8013ee7e-d280-4caf-816d-d0534897adb7"}"someField12": { "type": "reference:AccountApplication", "example": "8013ee7e-d280-4caf-816d-d0534897adb7"}"someField13": { "type": "reference:CardAttribute", "example": "8013ee7e-d280-4caf-816d-d0534897adb7"}"someField14": { "type": "reference:Counterparty", "example": "8013ee7e-d280-4caf-816d-d0534897adb7"}"someField15": { "type": "reference:Branch:bankId&branchId", "example": "bankId=8013ee7e-d280-4caf-816d-d0534897adb7&branchId=a4b121f0-b294-4eb5-8218-3b82ff95848b"}"someField16": { "type": "reference:Atm:bankId&atmId", "example": "bankId=8013ee7e-d280-4caf-816d-d0534897adb7&atmId=a4b121f0-b294-4eb5-8218-3b82ff95848b"}"someField17": { "type": "reference:BankAccount:bankId&accountId", "example": "bankId=8013ee7e-d280-4caf-816d-d0534897adb7&accountId=a4b121f0-b294-4eb5-8218-3b82ff95848b"}"someField18": { "type": "reference:Product:bankId&productCode", "example": "bankId=8013ee7e-d280-4caf-816d-d0534897adb7&productCode=a4b121f0-b294-4eb5-8218-3b82ff95848b"}"someField19": { "type": "reference:PhysicalCard:bankId&cardId", "example": "bankId=8013ee7e-d280-4caf-816d-d0534897adb7&cardId=a4b121f0-b294-4eb5-8218-3b82ff95848b"}"someField20": { "type": "reference:Transaction:bankId&accountId&transactionId", "example": "bankId=8013ee7e-d280-4caf-816d-d0534897adb7&accountId=a4b121f0-b294-4eb5-8218-3b82ff95848b&transactionId=aef62a60-595c-4a5a-9a43-86dc18590874"}"someField21": { "type": "reference:Counterparty:bankId&accountId&counterpartyId", "example": "bankId=8013ee7e-d280-4caf-816d-d0534897adb7&accountId=a4b121f0-b294-4eb5-8218-3b82ff95848b&counterpartyId=aef62a60-595c-4a5a-9a43-86dc18590874"}
","operationId":"OBPv4.0.0-updateDynamicEntity","parameters":[{"in":"body","name":"body","description":"DynamicEntityFooBar object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/DynamicEntityFooBar"}},{"in":"path","name":"DYNAMIC_ENTITY_ID","description":"the dynamic entity id ","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/DynamicEntityFooBar"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/management/method_routings":{"get":{"tags":["Method-Routing","API","New-Style"],"summary":"Get MethodRoutings","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get the all MethodRoutings.
Query url parameters:
eg:
https://api.ttk.com.mk/obp/v3.1.0/management/method_routings?active=true
https://api.ttk.com.mk/obp/v3.1.0/management/method_routings?method_name=getBank
Authentication is Mandatory
","operationId":"OBPv3.1.0-getMethodRoutings","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}}],"responses":{"200":{"description":"Success","schema":{"type":"object","required":["method_routings"],"properties":{"method_routings":{"type":"array","items":{"$ref":"#/definitions/MethodRoutingCommons"}}}}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"post":{"tags":["Method-Routing","API","New-Style"],"summary":"Create MethodRouting","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Create a MethodRouting.
Authentication is Mandatory
Explaination of Fields:
note:
If connector name start with rest, parameters can contain "outBoundMapping" and "inBoundMapping", convert OutBound and InBound json structure.
for example:
outBoundMapping example, convert json from source to target:
Build OutBound json value rules:
1 set cId value with: outboundAdapterCallContext.correlationId value
2 set bankId value with: concat bankId.value value with string helloworld
3 set originalJson value with: whole source json, note: the field value expression is $root
inBoundMapping example, convert json from source to target:
Build InBound json value rules:
1 and 2 set inboundAdapterCallContext and status value: because field name ends with "$default", remove "$default" from field name, not change the value
3 set fullName value with: concat string full: with result.name value
4 set bankRoutingScheme value: because source value is Array, but target value is not Array, the mapping field name must ends with [0].
Delete a MethodRouting specified by METHOD_ROUTING_ID.
Authentication is Mandatory
","operationId":"OBPv3.1.0-deleteMethodRouting","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"METHOD_ROUTING_ID","description":"the method routing id ","required":true,"type":"string"}],"responses":{"204":{"description":"Success","schema":{"$ref":"#/definitions/EmptyClassJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"put":{"tags":["Method-Routing","API","New-Style"],"summary":"Update MethodRouting","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update a MethodRouting.
Authentication is Mandatory
Explaination of Fields:
if bank_id_pattern is regex, special characters need to do escape, for example: bank_id_pattern = "some-id_pattern_\\d+"
If connector name start with rest, parameters can contain "outBoundMapping" and "inBoundMapping", to convert OutBound and InBound json structure.
for example:
outBoundMapping example, convert json from source to target:
Build OutBound json value rules:
1 set cId value with: outboundAdapterCallContext.correlationId value
2 set bankId value with: concat bankId.value value with string helloworld
3 set originalJson value with: whole source json, note: the field value expression is $root
inBoundMapping example, convert json from source to target:
Build InBound json value rules:
1 and 2 set inboundAdapterCallContext and status value: because field name ends with "$default", remove "$default" from field name, not change the value
3 set fullName value with: concat string full: with result.name value
4 set bankRoutingScheme value: because source value is Array, but target value is not Array, the mapping field name must ends with [0].
Get the all metrics
require CanReadMetrics role
Filters Part 1.filtering (no wilde cards etc.) parameters to GET /management/metrics
Should be able to filter on the following metrics fields
eg: /management/metrics?from_date=2017-09-19T02:31:05.000Z&to_date=2017-09-19T02:31:05.000Z&limit=50&offset=2
1 from_date (defaults to one week before current date): eg:from_date=2017-09-19T02:31:05.000Z
2 to_date (defaults to current date) eg:to_date=2017-09-19T02:31:05.000Z
3 limit (for pagination: defaults to 50) eg:limit=200
4 offset (for pagination: zero index, defaults to 0) eg: offset=10
5 sort_by (defaults to date field) eg: sort_by=date
possible values:
"url",
"date",
"user_name",
"app_name",
"developer_email",
"implemented_by_partial_function",
"implemented_in_version",
"consumer_id",
"verb"
6 direction (defaults to date desc) eg: direction=desc
eg: /management/metrics?from_date=2017-09-19T02:31:05.000Z&to_date=2017-09-19T02:31:05.000Z&limit=10000&offset=0&anon=false&app_name=TeatApp&implemented_in_version=v2.1.0&verb=POST&user_id=c7b6cb47-cb96-4441-8801-35b57456753a&user_name=susan.uk.29@example.com&consumer_id=78
Other filters:
7 consumer_id (if null ignore)
8 user_id (if null ignore)
9 anon (if null ignore) only support two value : true (return where user_id is null.) or false (return where user_id is not null.)
10 url (if null ignore), note: can not contain '&'.
11 app_name (if null ignore)
12 implemented_by_partial_function (if null ignore),
13 implemented_in_version (if null ignore)
14 verb (if null ignore)
15 correlation_id (if null ignore)
16 duration (if null ignore) non digit chars will be silently omitted
Authentication is Mandatory
","operationId":"OBPv2.1.0-getMetrics","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/MetricsJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/management/user/reset-password-url":{"post":{"tags":["User","API","New-Style"],"summary":"Create password reset url","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Create password reset url.
Authentication is Mandatory
","operationId":"OBPv4.0.0-resetPasswordUrl","parameters":[{"in":"body","name":"body","description":"PostResetPasswordUrlJsonV400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostResetPasswordUrlJsonV400"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/ResetPasswordUrlJsonV400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/management/users/current/consumers":{"get":{"tags":["Consumer","API","New-Style"],"summary":"Get Consumers (logged in User)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get the Consumers for logged in User.
Authentication is Mandatory
","operationId":"OBPv3.1.0-getConsumersForCurrentUser","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/ConsumersJsonV310"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/management/webui_props":{"get":{"tags":["WebUi-Props","API","New-Style"],"summary":"Get WebUiProps","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get the all WebUiProps key values, those props key with "webui_" can be stored in DB, this endpoint get all from DB.
url query parameter:
active: It must be a boolean string. and If active = true, it will show
combination of explicit (inserted) + implicit (default) method_routings.
eg:
https://api.ttk.com.mk/obp/v3.1.0/management/webui_props
https://api.ttk.com.mk/obp/v3.1.0/management/webui_props?active=true
Authentication is Mandatory
","operationId":"OBPv3.1.0-getWebUiProps","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}}],"responses":{"200":{"description":"Success","schema":{"type":"object","required":["webui_props"],"properties":{"webui_props":{"type":"array","items":{"$ref":"#/definitions/WebUiPropsCommons"}}}}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"post":{"tags":["WebUi-Props","API","New-Style"],"summary":"Create WebUiProps","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Create a WebUiProps.
Authentication is Mandatory
Explaination of Fields:
The line break and double quotations should do escape, example:
{"name": "webui_some", "value": "this valuehave "line break" and double quotations."}
should do escape like this:
{"name": "webui_some", "value": "this value\\nhave \\"line break\\" and double quotations."}
Insert image examples:
// set width=100 and height=50{"name": "webui_some_pic", "value": "here is a picture <img alt="hello" src="http://somedomain.com/images/pic.png" width="100" height="50" />"}// only set height=50{"name": "webui_some_pic", "value": "here is a picture <img alt="hello" src="http://somedomain.com/images/pic.png" width="" height="50" />"}// only width=20%{"name": "webui_some_pic", "value": "here is a picture <img alt="hello" src="http://somedomain.com/images/pic.png" width="20%" height="" />"}
","operationId":"OBPv3.1.0-createWebUiProps","parameters":[{"in":"body","name":"body","description":"WebUiPropsCommons object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/WebUiPropsCommons"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/WebUiPropsCommons"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/management/webui_props/{WEB_UI_PROPS_ID}":{"delete":{"tags":["WebUi-Props","API","New-Style"],"summary":"Delete WebUiProps","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete a WebUiProps specified by WEB_UI_PROPS_ID.
Authentication is Mandatory
","operationId":"OBPv3.1.0-deleteWebUiProps","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"WEB_UI_PROPS_ID","description":"the web ui props id","required":true,"type":"string"}],"responses":{"204":{"description":"Success","schema":{"$ref":"#/definitions/EmptyClassJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/message-docs/CONNECTOR":{"get":{"tags":["Documentation","API","New-Style"],"summary":"Get Message Docs","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"These message docs provide example messages sent by OBP to the (Kafka) message queue for processing by the Core Banking / Payment system Adapter - together with an example expected response and possible error codes.
Integrators can use these messages to build Adapters that provide core banking services to OBP.
Note: API Explorer provides a Message Docs page where these messages are displayed.
CONNECTOR
:kafka_vMar2017 , kafka_vJune2017, kafka_vSept2018, stored_procedure_vDec2019 ...
Authentication is Optional
","operationId":"OBPv2.2.0-getMessageDocs","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/MessageDocsJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}},"/obp/v4.0.0/message-docs/CONNECTOR/swagger2.0":{"get":{"tags":["Documentation","API","New-Style"],"summary":"Get Message Docs Swagger","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"This endpoint provides example message docs in swagger format.
It is only relavent for REST Connectors.
This endpoint can be used by the developer building a REST Adapter that connects to the Core Banking System (CBS).
That is, the Adapter developer can use the Swagger surfaced here to build the REST APIs that the OBP REST connector will call to consume CBS services.
i.e.:
OBP API (Core OBP API code) -> OBP REST Connector (OBP REST Connector code) -> OBP REST Adapter (Adapter developer code) -> CBS (Main Frame)
Authentication is Optional
","operationId":"OBPv3.1.0-getMessageDocsSwagger","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/MessageDocsJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}},"/obp/v4.0.0/my/dynamic-endpoints":{"get":{"tags":["Dynamic-Endpoint-(Manage)","API","New-Style"],"summary":"Get My Dynamic Endpoints","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get My Dynamic Endpoints.
Authentication is Mandatory
","operationId":"OBPv4.0.0-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","New-Style"],"summary":"Delete My Dynamic Endpoint","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete a DynamicEndpoint specified by DYNAMIC_ENDPOINT_ID.
Authentication is Mandatory
","operationId":"OBPv4.0.0-deleteMyDynamicEndpoint","parameters":[],"responses":{"204":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/my/dynamic-entities":{"get":{"tags":["Dynamic-Entity-(Manage)","API","New-Style"],"summary":"Get My Dynamic Entities","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get all my Dynamic Entities.
Authentication is Mandatory
","operationId":"OBPv4.0.0-getMyDynamicEntities","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","required":["dynamic_entities"],"properties":{"dynamic_entities":{"type":"array","items":{"$ref":"#/definitions/DynamicEntityFooBar"}}}}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/my/dynamic-entities/{DYNAMIC_ENTITY_ID}":{"delete":{"tags":["Dynamic-Entity-(Manage)","API","New-Style"],"summary":"Delete My Dynamic Entity","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete my DynamicEntity specified by DYNAMIC_ENTITY_ID.
Authentication is Mandatory
","operationId":"OBPv4.0.0-deleteMyDynamicEntity","parameters":[{"in":"path","name":"DYNAMIC_ENTITY_ID","description":"the dynamic entity id ","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"put":{"tags":["Dynamic-Entity-(Manage)","API","New-Style"],"summary":"Update My Dynamic Entity","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Update my DynamicEntity.
Authentication is Mandatory
Update one of my DynamicEntity, after update finished, the corresponding CRUD endpoints will be changed.
Current support filed types as follow:
[number, integer, boolean, string, DATE_WITH_DAY, reference]
DATE_WITH_DAY format: yyyy-MM-dd
Value of reference type is corresponding ids, please look at the following examples.
Current supporting reference types and corresponding examples as follow:
"someField0": { "type": "reference:TESTING", "example": "624167e9-a171-45de-bf2a-be3d3d9f1adf"}"someField1": { "type": "reference:creditApplicationForm", "example": "624167e9-a171-45de-bf2a-be3d3d9f1adf"}"someField2": { "type": "reference:Bank", "example": "624167e9-a171-45de-bf2a-be3d3d9f1adf"}"someField3": { "type": "reference:Consumer", "example": "624167e9-a171-45de-bf2a-be3d3d9f1adf"}"someField4": { "type": "reference:Customer", "example": "624167e9-a171-45de-bf2a-be3d3d9f1adf"}"someField5": { "type": "reference:MethodRouting", "example": "624167e9-a171-45de-bf2a-be3d3d9f1adf"}"someField6": { "type": "reference:DynamicEntity", "example": "624167e9-a171-45de-bf2a-be3d3d9f1adf"}"someField7": { "type": "reference:TransactionRequest", "example": "624167e9-a171-45de-bf2a-be3d3d9f1adf"}"someField8": { "type": "reference:ProductAttribute", "example": "624167e9-a171-45de-bf2a-be3d3d9f1adf"}"someField9": { "type": "reference:AccountAttribute", "example": "624167e9-a171-45de-bf2a-be3d3d9f1adf"}"someField10": { "type": "reference:TransactionAttribute", "example": "624167e9-a171-45de-bf2a-be3d3d9f1adf"}"someField11": { "type": "reference:CustomerAttribute", "example": "624167e9-a171-45de-bf2a-be3d3d9f1adf"}"someField12": { "type": "reference:AccountApplication", "example": "624167e9-a171-45de-bf2a-be3d3d9f1adf"}"someField13": { "type": "reference:CardAttribute", "example": "624167e9-a171-45de-bf2a-be3d3d9f1adf"}"someField14": { "type": "reference:Counterparty", "example": "624167e9-a171-45de-bf2a-be3d3d9f1adf"}"someField15": { "type": "reference:Branch:bankId&branchId", "example": "bankId=624167e9-a171-45de-bf2a-be3d3d9f1adf&branchId=2cfb4ea1-3483-4f76-9d61-37717acf8f0a"}"someField16": { "type": "reference:Atm:bankId&atmId", "example": "bankId=624167e9-a171-45de-bf2a-be3d3d9f1adf&atmId=2cfb4ea1-3483-4f76-9d61-37717acf8f0a"}"someField17": { "type": "reference:BankAccount:bankId&accountId", "example": "bankId=624167e9-a171-45de-bf2a-be3d3d9f1adf&accountId=2cfb4ea1-3483-4f76-9d61-37717acf8f0a"}"someField18": { "type": "reference:Product:bankId&productCode", "example": "bankId=624167e9-a171-45de-bf2a-be3d3d9f1adf&productCode=2cfb4ea1-3483-4f76-9d61-37717acf8f0a"}"someField19": { "type": "reference:PhysicalCard:bankId&cardId", "example": "bankId=624167e9-a171-45de-bf2a-be3d3d9f1adf&cardId=2cfb4ea1-3483-4f76-9d61-37717acf8f0a"}"someField20": { "type": "reference:Transaction:bankId&accountId&transactionId", "example": "bankId=624167e9-a171-45de-bf2a-be3d3d9f1adf&accountId=2cfb4ea1-3483-4f76-9d61-37717acf8f0a&transactionId=6115131a-7c72-4545-856f-ad98612971a4"}"someField21": { "type": "reference:Counterparty:bankId&accountId&counterpartyId", "example": "bankId=624167e9-a171-45de-bf2a-be3d3d9f1adf&accountId=2cfb4ea1-3483-4f76-9d61-37717acf8f0a&counterpartyId=6115131a-7c72-4545-856f-ad98612971a4"}
","operationId":"OBPv4.0.0-updateMyDynamicEntity","parameters":[{"in":"body","name":"body","description":"DynamicEntityFooBar object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/DynamicEntityFooBar"}},{"in":"path","name":"DYNAMIC_ENTITY_ID","description":"the dynamic entity id ","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/DynamicEntityFooBar"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/rate-limiting":{"get":{"tags":["API","New-Style"],"summary":"Get Rate Limiting Info","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get information about the Rate Limiting setup on this OBP Instance such as:
Is rate limiting enabled and active?
What backend is used to keep track of the API calls (e.g. REDIS).
Authentication is Mandatory
","operationId":"OBPv3.1.0-getRateLimitingInfo","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/RateLimitingInfoV310"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}},"/obp/v4.0.0/resource-docs/{API_VERSION}/obp":{"get":{"tags":["Documentation","API"],"summary":"Get Resource Docs.","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get documentation about the RESTful resources on this server including example bodies for POST and PUT requests.
This is the native data format used to document OBP endpoints. Each endpoint has a Resource Doc (a Scala case class) defined in the source code.
This endpoint is used by OBP API Explorer to display and work with the API documentation.
Most (but not all) fields are also available in swagger format. (The Swagger endpoint is built from Resource Docs.)
API_VERSION is the version you want documentation about e.g. v3.0.0
You may filter this endpoint with tags parameter e.g. ?tags=Account,Bank
You may filter this endpoint with functions parameter e.g. ?functions=enableDisableConsumers,getConnectorMetrics
For possible function values, see implemented_by.function in the JSON returned by this endpoint or the OBP source code or the footer of the API Explorer which produces a comma separated list of functions that reflect the server or filtering by API Explorer based on tags etc.
You may filter this endpoint using the 'content' url parameter, e.g. ?content=dynamic
if set content=dynamic, only show dynamic endpoints, if content=static, only show the static endpoints. if omit this parameter, we will show all the endpoints.
You may need some other language resource docs, now we support en and zh , e.g. ?language=zh
See the Resource Doc endpoint for more information.
Following are more examples:
https://api.ttk.com.mk/obp/v3.1.0/resource-docs/v3.1.0/obp
https://api.ttk.com.mk/obp/v3.1.0/resource-docs/v3.1.0/obp?tags=Account,Bank
https://api.ttk.com.mk/obp/v3.1.0/resource-docs/v3.1.0/obp?functions=getBanks,bankById
https://api.ttk.com.mk/obp/v3.1.0/resource-docs/v4.0.0/obp?language=zh
https://api.ttk.com.mk/obp/v3.1.0/resource-docs/v4.0.0/obp?content=static,dynamic,all
Authentication is Optional
","operationId":"OBPv1.4.0-getResourceDocsObp","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"API_VERSION","description":"eg:v2.2.0, v3.0.0","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/EmptyClassJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}},"/obp/v4.0.0/resource-docs/{API_VERSION}/swagger":{"get":{"tags":["Documentation","API"],"summary":"Get Swagger documentation","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Returns documentation about the RESTful resources on this server in Swagger format.
API_VERSION is the version you want documentation about e.g. v3.0.0
You may filter this endpoint using the 'tags' url parameter e.g. ?tags=Account,Bank
(All endpoints are given one or more tags which for used in grouping)
You may filter this endpoint using the 'functions' url parameter e.g. ?functions=getBanks,bankById
(Each endpoint is implemented in the OBP Scala code by a 'function')
See the Resource Doc endpoint for more information.
Following are more examples:
https://api.ttk.com.mk/obp/v3.1.0/resource-docs/v3.1.0/swagger
https://api.ttk.com.mk/obp/v3.1.0/resource-docs/v3.1.0/swagger?tags=Account,Bank
https://api.ttk.com.mk/obp/v3.1.0/resource-docs/v3.1.0/swagger?functions=getBanks,bankById
https://api.ttk.com.mk/obp/v3.1.0/resource-docs/v3.1.0/swagger?tags=Account,Bank,PSD2&functions=getBanks,bankById
Authentication is Optional
","operationId":"OBPv1.4.0-getResourceDocsSwagger","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"API_VERSION","description":"eg:v2.2.0, v3.0.0","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/EmptyClassJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}},"/obp/v4.0.0/root":{"get":{"tags":["API","New-Style"],"summary":"Get API Info (root)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Returns information about:
Authentication is Optional
","operationId":"OBPv4.0.0-root","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/APIInfoJson400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}},"/obp/v4.0.0/sandbox/data-import":{"post":{"tags":["Sandbox","API"],"summary":"Create sandbox","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Import bulk data into the sandbox (Authenticated access).
This call can be used to create banks, users, accounts and transactions which are stored in the local RDBMS.
The user needs to have CanCreateSandbox entitlement.
Note: This is a monolithic call. You could also use a combination of endpoints including create bank, create user, create account and create transaction request to create similar data.
An example of an import set of data (json) can be found here
Authentication is Mandatory
Search the API calls made to this API instance via Elastic Search.
Login is required.
CanSearchMetrics entitlement is required to search metrics data.
parameters:
esType - elasticsearch type
simple query:
q - plain_text_query
df - default field to search
sort - field to sort on
size - number of hits returned, default 10
from - show hits starting from
json query:
source - JSON_query_(URL-escaped)
example usage:
/search/metrics/q=findThis
or:
/search/metrics/source={"query":{"query_string":{"query":"findThis"}}}
Note!!
The whole JSON query string MUST be URL-encoded:
etc..
Only q, source and esType are passed to Elastic
Elastic simple query: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-uri-request.html
Elastic JSON query: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html
Authentication is Mandatory
","operationId":"OBPv2.0.0-elasticSearchMetrics","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/EmptyClassJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}}},"definitions":{"ErrorInvalidDateFormat":{"properties":{"message":{"type":"string","example":"OBP-10005: Invalid Date Format. Could not convert value to a Date."}}},"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."}}},"AkkaJSON":{"required":["ports","log_level"],"properties":{"ports":{"type":"array","items":{"$ref":"#/definitions/PortJSON"}},"log_level":{"type":"string","example":"Debug"},"remote_data_secret_matched":{"type":"boolean","example":"true"}}},"WarehouseJSON":{"required":["property","value"],"properties":{"property":{"type":"string","example":"String"},"value":{"type":"string","example":"ElasticSearch"}}},"ResourceUserJSON":{"required":["provider","email","username","provider_id","user_id"],"properties":{"provider":{"type":"string","example":"http://127.0.0.1:8080"},"email":{"type":"string","example":"felixsmith@example.com"},"username":{"type":"string","example":"felixsmith"},"provider_id":{"type":"string","example":"Chris"},"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}},"RateLimitingInfoV310":{"required":["enabled","technology","service_available","is_active"],"properties":{"enabled":{"type":"boolean","example":"true"},"technology":{"type":"string","example":"REDIS"},"service_available":{"type":"boolean","example":"true"},"is_active":{"type":"boolean","example":"true"}}},"AdapterImplementationJson":{"required":["group","suggested_order"],"properties":{"group":{"type":"string","example":"CORE"},"suggested_order":{"type":"integer","format":"int32","example":"3"}}},"PortJSON":{"required":["property","value"],"properties":{"property":{"type":"string","example":"default"},"value":{"type":"string","example":"8080"}}},"AdapterInfoJsonV300":{"required":["name","version","git_commit","date"],"properties":{"name":{"type":"string","example":"String"},"version":{"type":"string","example":"String"},"git_commit":{"type":"string","example":"String"},"date":{"type":"string","example":"2013-01-21T23:08:00Z"}}},"SuccessMessage":{"required":["success"],"properties":{"success":{"type":"string","example":"Success"}}},"EnergySource400":{"required":["organisation","organisation_website"],"properties":{"organisation":{"type":"string","example":"Stromio"},"organisation_website":{"type":"string","example":"https://www.stromio.de/"}}},"ConsumersJsonV310":{"required":["consumers"],"properties":{"consumers":{"type":"array","items":{"$ref":"#/definitions/ConsumerJsonV310"}}}},"ConsumerJsonV310":{"required":["app_type","description","created_by_user","enabled","redirect_url","developer_email","consumer_id","app_name","created"],"properties":{"app_type":{"type":"string","example":"Web"},"description":{"type":"string","example":"Account Management"},"created_by_user":{"$ref":"#/definitions/ResourceUserJSON"},"enabled":{"type":"boolean","example":"true"},"redirect_url":{"type":"string","example":"www.openbankproject.com"},"developer_email":{"type":"string","example":"felixsmith@example.com"},"consumer_id":{"type":"string","example":"8e716299-4668-4efd-976a-67f57a9984ec"},"app_name":{"type":"string","example":"SOFI"},"created":{"type":"string","format":"date","example":"2017-09-19T00:00:00Z"}}},"MessageDocJson":{"required":["adapter_implementation","example_inbound_message","description","process","message_format","example_outbound_message","dependent_endpoints"],"properties":{"adapter_implementation":{"$ref":"#/definitions/AdapterImplementationJson"},"outboundAvroSchema":{"type":"object","properties":{"jsonString":{"type":"string","example":"{}"}},"required":["jsonString"]},"example_inbound_message":{"type":"object","properties":{"jsonString":{"type":"string","example":"{}"}},"required":["jsonString"]},"inboundAvroSchema":{"type":"object","properties":{"jsonString":{"type":"string","example":"{}"}},"required":["jsonString"]},"requiredFieldInfo":{"$ref":"#/definitions/FieldNameApiVersions"},"description":{"type":"string","example":"get Banks"},"process":{"type":"string","example":"getAccounts"},"message_format":{"type":"string","example":"KafkaV2017"},"example_outbound_message":{"type":"object","properties":{"jsonString":{"type":"string","example":"{}"}},"required":["jsonString"]},"dependent_endpoints":{"type":"array","items":{"$ref":"#/definitions/EndpointInfo"}},"outbound_topic":{"type":"string","example":"to.obp.api.1.caseclass.OutboundGetAccounts"},"inbound_topic":{"type":"string","example":"from.obp.api.1.to.adapter.mf.caseclass.OutboundGetAccounts"}}},"ConsumerJSON":{"required":["created_by_user_id","app_type","description","created_by_user","enabled","redirect_url","developer_email","consumer_id","app_name","created"],"properties":{"created_by_user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"app_type":{"type":"string","example":"Web"},"description":{"type":"string","example":"Account Management"},"created_by_user":{"$ref":"#/definitions/ResourceUserJSON"},"enabled":{"type":"boolean","example":"true"},"redirect_url":{"type":"string","example":"www.openbankproject.com"},"developer_email":{"type":"string","example":"felixsmith@example.com"},"consumer_id":{"type":"integer","format":"int64","example":"1213"},"app_name":{"type":"string","example":"SOFI"},"created":{"type":"string","format":"date","example":"2017-09-19T00:00:00Z"}}},"MetricJson":{"required":["duration","implemented_in_version","url","correlation_id","implemented_by_partial_function","user_id","developer_email","date","consumer_id","verb","app_name","user_name"],"properties":{"duration":{"type":"integer","format":"int64","example":"39"},"implemented_in_version":{"type":"string","example":"v210"},"url":{"type":"string","example":"www.openbankproject.com"},"correlation_id":{"type":"string","example":"v8ho6h5ivel3uq7a5zcnv0w1"},"implemented_by_partial_function":{"type":"string","example":"getBanks"},"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"developer_email":{"type":"string","example":"felixsmith@example.com"},"date":{"type":"string","format":"date","example":"2017-09-19T00:00:00Z"},"consumer_id":{"type":"string","example":"123"},"verb":{"type":"string","example":"get"},"app_name":{"type":"string","example":"SOFI"},"user_name":{"type":"string","example":"OBP"}}},"ElasticSearchJSON":{"required":["metrics","warehouse"],"properties":{"metrics":{"type":"array","items":{"$ref":"#/definitions/MetricsJSON"}},"warehouse":{"type":"array","items":{"$ref":"#/definitions/WarehouseJSON"}}}},"OAuth2ServerJwksUrisJson":{"required":["jwks_uris"],"properties":{"jwks_uris":{"type":"array","items":{"$ref":"#/definitions/OAuth2ServerJWKURIJson"}}}},"MetricsJson":{"required":["metrics"],"properties":{"metrics":{"type":"array","items":{"$ref":"#/definitions/MetricJson"}}}},"MessageDocsJson":{"required":["message_docs"],"properties":{"message_docs":{"type":"array","items":{"$ref":"#/definitions/MessageDocJson"}}}},"MetricsJSON":{"required":["property","value"],"properties":{"property":{"type":"string","example":"String"},"value":{"type":"string","example":"Mapper"}}},"ScopesJSON":{"required":["require_scopes_for_all_roles","require_scopes_for_listed_roles"],"properties":{"require_scopes_for_all_roles":{"type":"boolean","example":"true"},"require_scopes_for_listed_roles":{"type":"array","items":{"type":"string"}}}},"APIInfoJson400":{"required":["version_status","version","hosted_at","connector","energy_source","hosted_by","git_commit"],"properties":{"version_status":{"type":"string","example":"String"},"version":{"type":"string","example":"String"},"hosted_at":{"$ref":"#/definitions/HostedAt400"},"connector":{"type":"string","example":"String"},"energy_source":{"$ref":"#/definitions/EnergySource400"},"hosted_by":{"$ref":"#/definitions/HostedBy400"},"git_commit":{"type":"string","example":"String"}}},"OAuth2ServerJWKURIJson":{"required":["jwks_uri"],"properties":{"jwks_uri":{"type":"string","example":"https://www.googleapis.com/oauth2/v3/certs"}}},"ConnectorMetricJson":{"required":["connector_name","duration","function_name","correlation_id","date"],"properties":{"connector_name":{"type":"string","example":"mapper"},"duration":{"type":"integer","format":"int64","example":"1000"},"function_name":{"type":"string","example":"getBanks"},"correlation_id":{"type":"string","example":"12345"},"date":{"type":"string","format":"date","example":"2017-09-19T00:00:00Z"}}},"HostedBy400":{"required":["organisation","email","phone","organisation_website"],"properties":{"organisation":{"type":"string","example":"String"},"email":{"type":"string","example":"String"},"phone":{"type":"string","example":"String"},"organisation_website":{"type":"string","example":"String"}}},"ConsumerRedirectUrlJSON":{"required":["redirect_url"],"properties":{"redirect_url":{"type":"string","example":"http://localhost:8888"}}},"PutEnabledJSON":{"required":["enabled"],"properties":{"enabled":{"type":"boolean","example":"false"}}},"HostedAt400":{"required":["organisation","organisation_website"],"properties":{"organisation":{"type":"string","example":"Amazon"},"organisation_website":{"type":"string","example":"https://aws.amazon.com/"}}},"CachedFunctionJSON":{"required":["function_name","ttl_in_seconds"],"properties":{"function_name":{"type":"string","example":"getBanks"},"ttl_in_seconds":{"type":"integer","format":"int32","example":"5"}}},"ConfigurationJSON":{"required":["akka","elastic_search","cache","scopes"],"properties":{"akka":{"$ref":"#/definitions/AkkaJSON"},"elastic_search":{"$ref":"#/definitions/ElasticSearchJSON"},"cache":{"type":"array","items":{"$ref":"#/definitions/CachedFunctionJSON"}},"scopes":{"$ref":"#/definitions/ScopesJSON"}}},"SeverJWK":{"required":["e","n","kty","use","kid"],"properties":{"e":{"type":"string","example":"AQAB"},"n":{"type":"string","example":"hrB0OWqg6AeNU3WCnhheG18R5EbQtdNYGOaSeylTjkj2lZr0_vkhNVYvase-CroxO4HOT06InxTYwLnmJiyv2cZxReuoVjTlk--olGu-9MZooiFiqWez0JzndyKxQ27OiAjFsMh0P04kaUXeHKhXRfiU7K2FqBshR1UlnWe7iHLkq2p9rrGjxQc7ff0w-Uc0f-8PWg36Y2Od7s65493iVQwnI13egqMaSvgB1s8_dgm08noEjhr8C5m1aKmr5oipWEPNi-SBV2VNuiCLR1IEPuXq0tOwwZfv31t34KPO-2H2bbaWmzGJy9mMOGqoNrbXyGiUZoyeHRELaNtm1GilyQ"},"kty":{"type":"string","example":"RSA"},"use":{"type":"string","example":"sig"},"kid":{"type":"string","example":"fr6-BxXH5gikFeZ2O6rGk0LUmJpukeswASN_TMW8U_s"}}},"ObpApiLoopbackJson":{"required":["connector_version","git_commit","duration_time"],"properties":{"connector_version":{"type":"string","example":"kafka_vSept2018"},"git_commit":{"type":"string","example":"f0acd4be14cdcb94be3433ec95c1ad65228812a0"},"duration_time":{"type":"string","example":"10 ms"}}},"ConnectorMetricsJson":{"required":["metrics"],"properties":{"metrics":{"type":"array","items":{"$ref":"#/definitions/ConnectorMetricJson"}}}},"SandboxUserImport":{"required":["email","password","user_name"],"properties":{"email":{"type":"string","example":"user1@example.com"},"password":{"type":"string","example":"TESOBE520berlin123!"},"user_name":{"type":"string","example":"User 1"}}},"SandboxBankImport":{"required":["website","full_name","logo","id","short_name"],"properties":{"website":{"type":"string","example":"http://example.com/2"},"full_name":{"type":"string","example":"Bank 2 Inc."},"logo":{"type":"string","example":"http://example.com/logo2"},"id":{"type":"string","example":"bank2"},"short_name":{"type":"string","example":"bank 2"}}},"SandboxTransactionImport":{"required":["id","this_account","details"],"properties":{"id":{"type":"string","example":"blankCounterpartNameTransaction"},"this_account":{"$ref":"#/definitions/SandboxAccountIdImport"},"counterparty":{"$ref":"#/definitions/SandboxTransactionCounterparty"},"details":{"$ref":"#/definitions/SandboxAccountDetailsImport"}}},"SandboxTransactionCounterparty":{"properties":{"name":{"type":"string","example":"Acme Inc."},"account_number":{"type":"string","example":"12345-B"}}},"SandboxAccountDetailsImport":{"required":["new_balance","description","completed","type","value","posted"],"properties":{"new_balance":{"type":"string","example":"1244.00"},"description":{"type":"string","example":"some description"},"completed":{"type":"string","example":"2012-04-07T00:00:00.001Z"},"type":{"type":"string","example":"SEPA"},"value":{"type":"string","example":"-135.33"},"posted":{"type":"string","example":"2012-03-07T00:00:00.001Z"}}},"SandboxAccountImport":{"required":["generate_auditors_view","number","IBAN","label","owners","balance","bank","id","type","generate_accountants_view","generate_public_view"],"properties":{"generate_auditors_view":{"type":"boolean","example":"true"},"number":{"type":"string","example":"22"},"IBAN":{"type":"string","example":"21234567890"},"label":{"type":"string","example":"Account 1 at Bank 2"},"owners":{"type":"array","items":{"type":"string"}},"balance":{"$ref":"#/definitions/SandboxBalanceImport"},"bank":{"type":"string","example":"bank2"},"id":{"type":"string","example":"account1"},"type":{"type":"string","example":"savings"},"generate_accountants_view":{"type":"boolean","example":"true"},"generate_public_view":{"type":"boolean","example":"false"}}},"SandboxLobbyImport":{"required":["hours"],"properties":{"hours":{"type":"string","example":"M-TH 8:30-3:30, F 9-5"}}},"SandboxBalanceImport":{"required":["currency","amount"],"properties":{"currency":{"type":"string","example":"EUR"},"amount":{"type":"string","example":"1000.00"}}},"SandboxCrmEventImport":{"required":["channel","bank_id","id","customer","category","detail","actual_date"],"properties":{"channel":{"type":"string","example":"Phone"},"bank_id":{"type":"string","example":"bank1"},"id":{"type":"string","example":"KIFJA76876AS"},"customer":{"$ref":"#/definitions/SandboxCustomerImport"},"category":{"type":"string","example":"Call"},"detail":{"type":"string","example":"Check mortgage"},"actual_date":{"type":"string","example":"2017-09-19T02:31:05.000Z"}}},"SandboxAccountIdImport":{"required":["id","bank"],"properties":{"id":{"type":"string","example":"account1"},"bank":{"type":"string","example":"bank1"}}},"SandboxProductImport":{"required":["name","more_info_url","super_family","code","bank_id","meta","category","family"],"properties":{"name":{"type":"string","example":"product 1"},"more_info_url":{"type":"string","example":"www.example.com/index1"},"super_family":{"type":"string","example":"sup fam 1"},"code":{"type":"string","example":"prd1"},"bank_id":{"type":"string","example":"bank1"},"meta":{"$ref":"#/definitions/SandboxMetaImport"},"category":{"type":"string","example":"cat1"},"family":{"type":"string","example":"fam1"}}},"SandboxLocationImport":{"required":["latitude","longitude"],"properties":{"latitude":{"type":"number","format":"double","example":"52.556198"},"longitude":{"type":"number","format":"double","example":"13.384099"}}},"SandboxLicenseImport":{"required":["id","name"],"properties":{"id":{"type":"string","example":"pddl"},"name":{"type":"string","example":"Open Data Commons Public Domain Dedication and License (PDDL)"}}},"SandboxAddressImport":{"required":["city","line_2","state","post_code","county","country_code","line_3","line_1"],"properties":{"city":{"type":"string","example":"Ashbourne"},"line_2":{"type":"string","example":"Rosy Place"},"state":{"type":"string","example":""},"post_code":{"type":"string","example":"WHY RU4"},"county":{"type":"string","example":"Derbyshire"},"country_code":{"type":"string","example":"UK"},"line_3":{"type":"string","example":"Sunny Village"},"line_1":{"type":"string","example":"5 Some Street"}}},"SandboxCustomerImport":{"required":["name","number"],"properties":{"name":{"type":"string","example":"James Brown"},"number":{"type":"string","example":"698761728934"}}},"SandboxBranchImport":{"required":["name","location","bank_id","id","meta","address"],"properties":{"name":{"type":"string","example":"Genel Müdürlük"},"location":{"$ref":"#/definitions/SandboxLocationImport"},"driveUp":{"$ref":"#/definitions/SandboxDriveUpImport"},"bank_id":{"type":"string","example":"bank1"},"id":{"type":"string","example":"branch1"},"meta":{"$ref":"#/definitions/SandboxMetaImport"},"lobby":{"$ref":"#/definitions/SandboxLobbyImport"},"address":{"$ref":"#/definitions/SandboxAddressImport"}}},"SandboxMetaImport":{"required":["license"],"properties":{"license":{"$ref":"#/definitions/SandboxLicenseImport"}}},"SandboxAtmImport":{"required":["name","location","bank_id","id","meta","address"],"properties":{"name":{"type":"string","example":"Ashbourne Atm 1"},"location":{"$ref":"#/definitions/SandboxLocationImport"},"bank_id":{"type":"string","example":"bank1"},"id":{"type":"string","example":"atm1"},"meta":{"$ref":"#/definitions/SandboxMetaImport"},"address":{"$ref":"#/definitions/SandboxAddressImport"}}},"SandboxDriveUpImport":{"required":["hours"],"properties":{"hours":{"type":"string","example":"M-Th 8:30-5:30, F-8:30-6, Sat 9-12"}}},"SandboxDataImport":{"required":["crm_events","users","products","banks","branches","transactions","accounts","atms"],"properties":{"crm_events":{"type":"array","items":{"$ref":"#/definitions/SandboxCrmEventImport"}},"users":{"type":"array","items":{"$ref":"#/definitions/SandboxUserImport"}},"products":{"type":"array","items":{"$ref":"#/definitions/SandboxProductImport"}},"banks":{"type":"array","items":{"$ref":"#/definitions/SandboxBankImport"}},"branches":{"type":"array","items":{"$ref":"#/definitions/SandboxBranchImport"}},"transactions":{"type":"array","items":{"$ref":"#/definitions/SandboxTransactionImport"}},"accounts":{"type":"array","items":{"$ref":"#/definitions/SandboxAccountImport"}},"atms":{"type":"array","items":{"$ref":"#/definitions/SandboxAtmImport"}}}},"EndpointInfo":{"required":["name","version"],"properties":{"name":{"type":"string","example":"getAccounts"},"version":{"type":"string","example":"OBPv3.0.0"}}},"FieldNameApiVersions":{"properties":{}},"DynamicEntityFooBar":{"required":["FooBar"],"properties":{"bankId":{"type":"string","example":"gh.29.uk"},"FooBar":{"$ref":"#/definitions/DynamicEntityDefinition"},"dynamicEntityId":{"type":"string","example":""},"userId":{"type":"string","example":""}}},"EmptyClassJson":{"required":["jsonString"],"properties":{"jsonString":{"type":"string","example":"{}"}}},"PostResetPasswordUrlJsonV400":{"required":["username","email","user_id"],"properties":{"username":{"type":"string","example":"jobloggs"},"email":{"type":"string","example":"jo@gmail.com"},"user_id":{"type":"string","example":"74a8ebcc-10e4-4036-bef3-9835922246bf"}}},"MethodRoutingCommons":{"required":["is_bank_id_exact_match","method_name","connector_name","parameters"],"properties":{"is_bank_id_exact_match":{"type":"boolean","example":"true"},"method_name":{"type":"string","example":"getBank"},"connector_name":{"type":"string","example":"rest_vMar2019"},"method_routing_id":{"type":"string","example":""},"bank_id_pattern":{"type":"string","example":"some_bankId"},"parameters":{"type":"array","items":{"$ref":"#/definitions/MethodRoutingParam"}}}},"WebUiPropsCommons":{"required":["name","value"],"properties":{"name":{"type":"string","example":"webui_api_explorer_url"},"value":{"type":"string","example":"https://apiexplorer.openbankproject.com"},"web_ui_props_id":{"type":"string","example":""}}},"ResetPasswordUrlJsonV400":{"required":["reset_password_url"],"properties":{"reset_password_url":{"type":"string","example":"https://apisandbox.openbankproject.com/user_mgt/reset_password/QOL1CPNJPCZ4BRMPX3Z01DPOX1HMGU3L"}}},"DynamicEntityStringTypeExample":{"required":["description","minLength","type","example","maxLength"],"properties":{"description":{"type":"string","example":"description of **name** field, can be markdown text."},"minLength":{"type":"integer","format":"int32","example":"3"},"type":{"type":"string","enum":["number","integer","boolean","string","DATE_WITH_DAY"]},"example":{"type":"string","example":"James Brown"},"maxLength":{"type":"integer","format":"int32","example":"20"}}},"DynamicEntityIntTypeExample":{"required":["type","example","description"],"properties":{"type":{"type":"string","enum":["number","integer","boolean","string","DATE_WITH_DAY"]},"example":{"type":"integer","format":"int32","example":"698761728"},"description":{"type":"string","example":"description of **number** field, can be markdown text."}}},"DynamicEntityFullBarFields":{"required":["name","number"],"properties":{"name":{"$ref":"#/definitions/DynamicEntityStringTypeExample"},"number":{"$ref":"#/definitions/DynamicEntityIntTypeExample"}}},"DynamicEntityDefinition":{"required":["description","required","properties"],"properties":{"description":{"type":"string","example":"description of this entity, can be markdown text."},"required":{"type":"array","items":{"type":"string"}},"properties":{"$ref":"#/definitions/DynamicEntityFullBarFields"}}},"MethodRoutingParam":{"required":["key","value"],"properties":{"key":{"type":"string","example":"url"},"value":{"type":"string","example":"http://mydomain.com/xxx"}}}}}