{"swagger":"2.0","info":{"title":"UK Open Banking","description":"License: Unknown","contact":{"name":"TESOBE GmbH. / Open Bank Project","url":"https://openbankproject.com","email":"contact@tesobe.com"},"version":"v3.1"},"host":"apisandbox.openbankproject.com","basePath":"/","schemes":["http","https"],"securityDefinitions":{"directLogin":{"type":"apiKey","description":"Direct Login authentication. POST to /obp/v6.0.0/my/logins/direct with header 'DirectLogin: username=YOUR_USERNAME, password=YOUR_PASSWORD, consumer_key=YOUR_CONSUMER_KEY' to obtain a token. Then use header 'DirectLogin: token=YOUR_TOKEN' on subsequent requests. See the OpenAPI 3.1 spec for full details.","in":"header","name":"DirectLogin"},"gatewayLogin":{"type":"apiKey","description":"Gateway Login authentication. The gateway sends a JWT in the Authorization header signed with a pre-shared secret. See the OpenAPI 3.1 spec for full details.","in":"header","name":"Authorization"}},"security":[{"directLogin":[],"gatewayLogin":[]}],"paths":{"/obp/dynamic-endpoint/accounts":{"post":{"tags":["Bank Accounts (Dynamic Endpoint)","Dynamic-Endpoint","Dynamic"],"summary":"Post Accounts","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

POST Accounts

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://obp_mock//accounts"    },    {        "key":"http_method",        "value":"POST"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEndpoint_POST_accounts","parameters":[],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"name":{"type":"string","example":"family account"},"balance":{"type":"integer","format":"int32","example":"1"}},"required":["name","balance"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-endpoint/accounts/{ACCOUNT_ID}":{"get":{"tags":["Bank Accounts (Dynamic Endpoint)","Dynamic-Endpoint","Dynamic"],"summary":"Get Bank Account By Id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get Bank Account

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://obp_mock//accounts/{account_id}"    },    {        "key":"http_method",        "value":"GET"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEndpoint_GET_accounts_ACCOUNT_ID","parameters":[{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"name":{"type":"string","example":"family account"},"balance":{"type":"integer","format":"int32","example":"1"}},"required":["name","balance"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-endpoint/test-dynamic-resource-doc/my_user/MY_USER_ID":{"post":{"tags":["Dynamic-Resource-Doc"],"summary":"A test endpoint","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

A test endpoint.

Just for debug method body of dynamic resource doc.
better watch the following introduction video first
* Dynamic resourceDoc version1

The endpoint return the response from PractiseEndpoint code.
Here, code.api.DynamicEndpoints.dynamic.practise.PractiseEndpoint.process
You can test the method body grammar, and try the business logic, but need to restart the OBP-API code .

User Authentication is Optional. The User need not be logged in.

URL Parameters:

MY_USER_ID: MY_USER_ID

JSON request body fields:

age: 18

hobby: hobby

name: ACCOUNT_MANAGEMENT_FEE

JSON response body fields:

age: 18

hobby: hobby

name: ACCOUNT_MANAGEMENT_FEE

","operationId":"OBPv4.0.0-test-dynamic-resource-doc","parameters":[{"in":"body","name":"body","description":"RequestRootJsonClass object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/RequestRootJsonClass"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/RequestRootJsonClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}},"/obp/dynamic-entity/CovidAPIDays":{"get":{"tags":["_CovidAPIDays","Dynamic-Entity","Dynamic"],"summary":"Get CovidAPIDays List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get CovidAPIDays 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":"CovidAPIDays"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Can do filter on the fields
e.g: /CovidAPIDays?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

","operationId":"OBPv4.0.0-dynamicEntity_getCovidAPIDaysList_","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"covid_api_days_list":{"type":"array","items":{"type":"object","properties":{"covid_api_days_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["covid_api_days_id","name","number"]}}},"required":["covid_api_days_list"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["_CovidAPIDays","Dynamic-Entity","Dynamic"],"summary":"Create new CovidAPIDays","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Create new CovidAPIDays.

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":"CovidAPIDays"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_createCovidAPIDays_","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":{"covid_api_days":{"type":"object","properties":{"covid_api_days_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["covid_api_days_id","name","number"]}},"required":["covid_api_days"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/CovidAPIDays/COVID_API_DAYS_ID":{"delete":{"tags":["_CovidAPIDays","Dynamic-Entity","Dynamic"],"summary":"Delete CovidAPIDays by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Delete CovidAPIDays 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":"CovidAPIDays"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_deleteCovidAPIDays_","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":{"covid_api_days":{"type":"object","properties":{"covid_api_days_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["covid_api_days_id","name","number"]}},"required":["covid_api_days"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"get":{"tags":["_CovidAPIDays","Dynamic-Entity","Dynamic"],"summary":"Get CovidAPIDays by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get CovidAPIDays 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":"CovidAPIDays"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_getSingleCovidAPIDays_","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"covid_api_days":{"type":"object","properties":{"covid_api_days_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["covid_api_days_id","name","number"]}},"required":["covid_api_days"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["_CovidAPIDays","Dynamic-Entity","Dynamic"],"summary":"Update CovidAPIDays","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Update CovidAPIDays.

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":"CovidAPIDays"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_updateCovidAPIDays_","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":{"covid_api_days":{"type":"object","properties":{"covid_api_days_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["covid_api_days_id","name","number"]}},"required":["covid_api_days"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/FishPort":{"get":{"tags":["_FishPort","Dynamic-Entity","Dynamic"],"summary":"Get FishPort List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get FishPort List.

Portfolio of fishbased values

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":"FishPort"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Can do filter on the fields
e.g: /FishPort?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

","operationId":"OBPv4.0.0-dynamicEntity_getFishPortList_","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"fish_port_list":{"type":"array","items":{"type":"object","properties":{"fish_port_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"fish":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"6987233228"}},"required":["fish_port_id","fish","number"]}}},"required":["fish_port_list"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["_FishPort","Dynamic-Entity","Dynamic"],"summary":"Create new FishPort","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Create new FishPort.

Portfolio of fishbased values

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":"FishPort"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_createFishPort_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"fish":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"6987233228"}},"required":["fish","number"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"fish_port":{"type":"object","properties":{"fish_port_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"fish":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"6987233228"}},"required":["fish_port_id","fish","number"]}},"required":["fish_port"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/FishPort/FISH_PORT_ID":{"delete":{"tags":["_FishPort","Dynamic-Entity","Dynamic"],"summary":"Delete FishPort by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Delete FishPort 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":"FishPort"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_deleteFishPort_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"fish":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"6987233228"}},"required":["fish","number"]}}],"responses":{"204":{"description":"Success","schema":{"type":"object","properties":{"fish_port":{"type":"object","properties":{"fish_port_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"fish":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"6987233228"}},"required":["fish_port_id","fish","number"]}},"required":["fish_port"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"get":{"tags":["_FishPort","Dynamic-Entity","Dynamic"],"summary":"Get FishPort by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get FishPort by id.

Portfolio of fishbased values

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":"FishPort"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_getSingleFishPort_","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"fish_port":{"type":"object","properties":{"fish_port_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"fish":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"6987233228"}},"required":["fish_port_id","fish","number"]}},"required":["fish_port"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["_FishPort","Dynamic-Entity","Dynamic"],"summary":"Update FishPort","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Update FishPort.

Portfolio of fishbased values

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":"FishPort"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_updateFishPort_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"fish":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"6987233228"}},"required":["fish","number"]}}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"fish_port":{"type":"object","properties":{"fish_port_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"fish":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"6987233228"}},"required":["fish_port_id","fish","number"]}},"required":["fish_port"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/FooBar":{"get":{"tags":["_FooBar","Dynamic-Entity","Dynamic"],"summary":"Get FooBar List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get FooBar 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":"FooBar"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Can do filter on the fields
e.g: /FooBar?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

","operationId":"OBPv4.0.0-dynamicEntity_getFooBarList_","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"foo_bar_list":{"type":"array","items":{"type":"object","properties":{"foo_bar_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["foo_bar_id","name","number"]}}},"required":["foo_bar_list"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["_FooBar","Dynamic-Entity","Dynamic"],"summary":"Create new FooBar","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Create new FooBar.

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":"FooBar"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_createFooBar_","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":{"foo_bar":{"type":"object","properties":{"foo_bar_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["foo_bar_id","name","number"]}},"required":["foo_bar"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/FooBar/FOO_BAR_ID":{"delete":{"tags":["_FooBar","Dynamic-Entity","Dynamic"],"summary":"Delete FooBar by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Delete FooBar 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":"FooBar"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_deleteFooBar_","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":{"foo_bar":{"type":"object","properties":{"foo_bar_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["foo_bar_id","name","number"]}},"required":["foo_bar"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"get":{"tags":["_FooBar","Dynamic-Entity","Dynamic"],"summary":"Get FooBar by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get FooBar 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":"FooBar"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_getSingleFooBar_","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"foo_bar":{"type":"object","properties":{"foo_bar_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["foo_bar_id","name","number"]}},"required":["foo_bar"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["_FooBar","Dynamic-Entity","Dynamic"],"summary":"Update FooBar","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Update FooBar.

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":"FooBar"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_updateFooBar_","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":{"foo_bar":{"type":"object","properties":{"foo_bar_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["foo_bar_id","name","number"]}},"required":["foo_bar"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/SimonCovid":{"get":{"tags":["_SimonCovid","Dynamic-Entity","Dynamic"],"summary":"Get SimonCovid List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get SimonCovid List.

Let's put Covid99 stuff here

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":"SimonCovid"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Can do filter on the fields
e.g: /SimonCovid?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

","operationId":"OBPv4.0.0-dynamicEntity_getSimonCovidList_","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"simon_covid_list":{"type":"array","items":{"type":"object","properties":{"simon_covid_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["simon_covid_id","name","number"]}}},"required":["simon_covid_list"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["_SimonCovid","Dynamic-Entity","Dynamic"],"summary":"Create new SimonCovid","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Create new SimonCovid.

Let's put Covid99 stuff here

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":"SimonCovid"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_createSimonCovid_","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":{"simon_covid":{"type":"object","properties":{"simon_covid_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["simon_covid_id","name","number"]}},"required":["simon_covid"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/SimonCovid/SIMON_COVID_ID":{"delete":{"tags":["_SimonCovid","Dynamic-Entity","Dynamic"],"summary":"Delete SimonCovid by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Delete SimonCovid 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":"SimonCovid"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_deleteSimonCovid_","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":{"simon_covid":{"type":"object","properties":{"simon_covid_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["simon_covid_id","name","number"]}},"required":["simon_covid"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"get":{"tags":["_SimonCovid","Dynamic-Entity","Dynamic"],"summary":"Get SimonCovid by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get SimonCovid by id.

Let's put Covid99 stuff here

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":"SimonCovid"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_getSingleSimonCovid_","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"simon_covid":{"type":"object","properties":{"simon_covid_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["simon_covid_id","name","number"]}},"required":["simon_covid"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["_SimonCovid","Dynamic-Entity","Dynamic"],"summary":"Update SimonCovid","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Update SimonCovid.

Let's put Covid99 stuff here

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":"SimonCovid"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_updateSimonCovid_","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":{"simon_covid":{"type":"object","properties":{"simon_covid_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["simon_covid_id","name","number"]}},"required":["simon_covid"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/banks/gh.29.uk/D-Entity1":{"get":{"tags":["_D-Entity1(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Get D-Entity1 List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get D-Entity1 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":"D-Entity1"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Can do filter on the fields
e.g: /D-Entity1?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

","operationId":"OBPv4.0.0-dynamicEntity_getD-Entity1List_gh.29.uk","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"d-entity1_list":{"type":"array","items":{"type":"object","properties":{"d-entity1_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["d-entity1_id","name","number"]}}},"required":["bank-id","d-entity1_list"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["_D-Entity1(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Create new D-Entity1","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Create new D-Entity1.

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":"D-Entity1"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_createD-Entity1_gh.29.uk","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":{"bank-id":{"type":"string","example":"gh.29.uk"},"d-entity1":{"type":"object","properties":{"d-entity1_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["d-entity1_id","name","number"]}},"required":["bank-id","d-entity1"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/banks/gh.29.uk/D-Entity1/D-ENTITY1_ID":{"delete":{"tags":["_D-Entity1(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Delete D-Entity1 by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Delete D-Entity1 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":"D-Entity1"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_deleteD-Entity1_gh.29.uk","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":{"bank-id":{"type":"string","example":"gh.29.uk"},"d-entity1":{"type":"object","properties":{"d-entity1_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["d-entity1_id","name","number"]}},"required":["bank-id","d-entity1"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"get":{"tags":["_D-Entity1(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Get D-Entity1 by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get D-Entity1 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":"D-Entity1"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_getSingleD-Entity1_gh.29.uk","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"d-entity1":{"type":"object","properties":{"d-entity1_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["d-entity1_id","name","number"]}},"required":["bank-id","d-entity1"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["_D-Entity1(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Update D-Entity1","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Update D-Entity1.

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":"D-Entity1"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_updateD-Entity1_gh.29.uk","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":{"bank-id":{"type":"string","example":"gh.29.uk"},"d-entity1":{"type":"object","properties":{"d-entity1_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["d-entity1_id","name","number"]}},"required":["bank-id","d-entity1"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/banks/gh.29.uk/InsurancePolicy":{"get":{"tags":["_InsurancePolicy(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Get InsurancePolicy List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get InsurancePolicy List.

Which insurance policies the customer already has.

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":"InsurancePolicy"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Can do filter on the fields
e.g: /InsurancePolicy?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

","operationId":"OBPv4.0.0-dynamicEntity_getInsurancePolicyList_gh.29.uk","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"insurance_policy_list":{"type":"array","items":{"type":"object","properties":{"insurance_policy_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["insurance_policy_id","name","number"]}}},"required":["bank-id","insurance_policy_list"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["_InsurancePolicy(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Create new InsurancePolicy","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Create new InsurancePolicy.

Which insurance policies the customer already has.

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":"InsurancePolicy"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_createInsurancePolicy_gh.29.uk","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":{"bank-id":{"type":"string","example":"gh.29.uk"},"insurance_policy":{"type":"object","properties":{"insurance_policy_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["insurance_policy_id","name","number"]}},"required":["bank-id","insurance_policy"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/banks/gh.29.uk/InsurancePolicy/INSURANCE_POLICY_ID":{"delete":{"tags":["_InsurancePolicy(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Delete InsurancePolicy by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Delete InsurancePolicy 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":"InsurancePolicy"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_deleteInsurancePolicy_gh.29.uk","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":{"bank-id":{"type":"string","example":"gh.29.uk"},"insurance_policy":{"type":"object","properties":{"insurance_policy_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["insurance_policy_id","name","number"]}},"required":["bank-id","insurance_policy"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"get":{"tags":["_InsurancePolicy(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Get InsurancePolicy by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get InsurancePolicy by id.

Which insurance policies the customer already has.

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":"InsurancePolicy"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_getSingleInsurancePolicy_gh.29.uk","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"insurance_policy":{"type":"object","properties":{"insurance_policy_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["insurance_policy_id","name","number"]}},"required":["bank-id","insurance_policy"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["_InsurancePolicy(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Update InsurancePolicy","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Update InsurancePolicy.

Which insurance policies the customer already has.

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":"InsurancePolicy"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_updateInsurancePolicy_gh.29.uk","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":{"bank-id":{"type":"string","example":"gh.29.uk"},"insurance_policy":{"type":"object","properties":{"insurance_policy_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["insurance_policy_id","name","number"]}},"required":["bank-id","insurance_policy"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/banks/gh.29.uk/InsurancePremium":{"get":{"tags":["_InsurancePremium(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Get InsurancePremium List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get InsurancePremium List.

Retrive the premium for the customer.

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":"InsurancePremium"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Can do filter on the fields
e.g: /InsurancePremium?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

","operationId":"OBPv4.0.0-dynamicEntity_getInsurancePremiumList_gh.29.uk","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"insurance_premium_list":{"type":"array","items":{"type":"object","properties":{"insurance_premium_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["insurance_premium_id","name","number"]}}},"required":["bank-id","insurance_premium_list"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["_InsurancePremium(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Create new InsurancePremium","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Create new InsurancePremium.

Retrive the premium for the customer.

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":"InsurancePremium"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_createInsurancePremium_gh.29.uk","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":{"bank-id":{"type":"string","example":"gh.29.uk"},"insurance_premium":{"type":"object","properties":{"insurance_premium_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["insurance_premium_id","name","number"]}},"required":["bank-id","insurance_premium"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/banks/gh.29.uk/InsurancePremium/INSURANCE_PREMIUM_ID":{"delete":{"tags":["_InsurancePremium(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Delete InsurancePremium by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Delete InsurancePremium 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":"InsurancePremium"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_deleteInsurancePremium_gh.29.uk","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":{"bank-id":{"type":"string","example":"gh.29.uk"},"insurance_premium":{"type":"object","properties":{"insurance_premium_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["insurance_premium_id","name","number"]}},"required":["bank-id","insurance_premium"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"get":{"tags":["_InsurancePremium(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Get InsurancePremium by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get InsurancePremium by id.

Retrive the premium for the customer.

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":"InsurancePremium"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_getSingleInsurancePremium_gh.29.uk","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"insurance_premium":{"type":"object","properties":{"insurance_premium_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["insurance_premium_id","name","number"]}},"required":["bank-id","insurance_premium"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["_InsurancePremium(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Update InsurancePremium","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Update InsurancePremium.

Retrive the premium for the customer.

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":"InsurancePremium"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_updateInsurancePremium_gh.29.uk","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":{"bank-id":{"type":"string","example":"gh.29.uk"},"insurance_premium":{"type":"object","properties":{"insurance_premium_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["insurance_premium_id","name","number"]}},"required":["bank-id","insurance_premium"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/banks/gh.29.uk/MarchHare":{"get":{"tags":["_MarchHare(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Get MarchHare List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get MarchHare 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":"MarchHare"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Can do filter on the fields
e.g: /MarchHare?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

","operationId":"OBPv4.0.0-dynamicEntity_getMarchHareList_gh.29.uk","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"march_hare_list":{"type":"array","items":{"type":"object","properties":{"march_hare_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["march_hare_id","name","number"]}}},"required":["bank-id","march_hare_list"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["_MarchHare(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Create new MarchHare","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Create new MarchHare.

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":"MarchHare"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_createMarchHare_gh.29.uk","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":{"bank-id":{"type":"string","example":"gh.29.uk"},"march_hare":{"type":"object","properties":{"march_hare_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["march_hare_id","name","number"]}},"required":["bank-id","march_hare"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/banks/gh.29.uk/MarchHare/MARCH_HARE_ID":{"delete":{"tags":["_MarchHare(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Delete MarchHare by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Delete MarchHare 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":"MarchHare"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_deleteMarchHare_gh.29.uk","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":{"bank-id":{"type":"string","example":"gh.29.uk"},"march_hare":{"type":"object","properties":{"march_hare_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["march_hare_id","name","number"]}},"required":["bank-id","march_hare"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"get":{"tags":["_MarchHare(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Get MarchHare by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get MarchHare 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":"MarchHare"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_getSingleMarchHare_gh.29.uk","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"march_hare":{"type":"object","properties":{"march_hare_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["march_hare_id","name","number"]}},"required":["bank-id","march_hare"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["_MarchHare(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Update MarchHare","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Update MarchHare.

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":"MarchHare"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_updateMarchHare_gh.29.uk","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":{"bank-id":{"type":"string","example":"gh.29.uk"},"march_hare":{"type":"object","properties":{"march_hare_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["march_hare_id","name","number"]}},"required":["bank-id","march_hare"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/banks/gh.29.uk/Odometer":{"get":{"tags":["_Odometer(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Get Odometer List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get Odometer List.

Verify odometer information for flexible contracts.

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":"Odometer"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Can do filter on the fields
e.g: /Odometer?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

","operationId":"OBPv4.0.0-dynamicEntity_getOdometerList_gh.29.uk","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"odometer_list":{"type":"array","items":{"type":"object","properties":{"odometer_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["odometer_id","name","number"]}}},"required":["bank-id","odometer_list"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["_Odometer(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Create new Odometer","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Create new Odometer.

Verify odometer information for flexible contracts.

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":"Odometer"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_createOdometer_gh.29.uk","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":{"bank-id":{"type":"string","example":"gh.29.uk"},"odometer":{"type":"object","properties":{"odometer_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["odometer_id","name","number"]}},"required":["bank-id","odometer"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/banks/gh.29.uk/Odometer/ODOMETER_ID":{"delete":{"tags":["_Odometer(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Delete Odometer by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Delete Odometer 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":"Odometer"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_deleteOdometer_gh.29.uk","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":{"bank-id":{"type":"string","example":"gh.29.uk"},"odometer":{"type":"object","properties":{"odometer_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["odometer_id","name","number"]}},"required":["bank-id","odometer"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"get":{"tags":["_Odometer(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Get Odometer by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get Odometer by id.

Verify odometer information for flexible contracts.

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":"Odometer"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_getSingleOdometer_gh.29.uk","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"odometer":{"type":"object","properties":{"odometer_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["odometer_id","name","number"]}},"required":["bank-id","odometer"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["_Odometer(gh.29.uk)","Dynamic-Entity","Dynamic"],"summary":"Update Odometer","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Update Odometer.

Verify odometer information for flexible contracts.

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":"Odometer"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_updateOdometer_gh.29.uk","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":{"bank-id":{"type":"string","example":"gh.29.uk"},"odometer":{"type":"object","properties":{"odometer_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["odometer_id","name","number"]}},"required":["bank-id","odometer"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/banks/obp.testing.01/ObpActivity":{"get":{"tags":["_ObpActivity(obp.testing.01)","Dynamic-Entity","Dynamic"],"summary":"Get ObpActivity List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get ObpActivity 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":"ObpActivity"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Can do filter on the fields
e.g: /ObpActivity?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

","operationId":"OBPv4.0.0-dynamicEntity_getObpActivityList_obp.testing.01","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"obp_activity_list":{"type":"array","items":{"type":"object","properties":{"obp_activity_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"username":{"type":"string","example":"James Brown"},"created_date":{"type":"string","example":"698761728"}},"required":["obp_activity_id","name","username","created_date"]}}},"required":["bank-id","obp_activity_list"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["_ObpActivity(obp.testing.01)","Dynamic-Entity","Dynamic"],"summary":"Create new ObpActivity","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Create new ObpActivity.

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":"ObpActivity"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_createObpActivity_obp.testing.01","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"},"username":{"type":"string","example":"James Brown"},"created_date":{"type":"string","example":"698761728"}},"required":["name","username","created_date"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"obp_activity":{"type":"object","properties":{"obp_activity_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"username":{"type":"string","example":"James Brown"},"created_date":{"type":"string","example":"698761728"}},"required":["obp_activity_id","name","username","created_date"]}},"required":["bank-id","obp_activity"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/banks/obp.testing.01/ObpActivity/OBP_ACTIVITY_ID":{"delete":{"tags":["_ObpActivity(obp.testing.01)","Dynamic-Entity","Dynamic"],"summary":"Delete ObpActivity by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Delete ObpActivity 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":"ObpActivity"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_deleteObpActivity_obp.testing.01","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"},"username":{"type":"string","example":"James Brown"},"created_date":{"type":"string","example":"698761728"}},"required":["name","username","created_date"]}}],"responses":{"204":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"obp_activity":{"type":"object","properties":{"obp_activity_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"username":{"type":"string","example":"James Brown"},"created_date":{"type":"string","example":"698761728"}},"required":["obp_activity_id","name","username","created_date"]}},"required":["bank-id","obp_activity"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"get":{"tags":["_ObpActivity(obp.testing.01)","Dynamic-Entity","Dynamic"],"summary":"Get ObpActivity by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get ObpActivity 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":"ObpActivity"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_getSingleObpActivity_obp.testing.01","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"obp_activity":{"type":"object","properties":{"obp_activity_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"username":{"type":"string","example":"James Brown"},"created_date":{"type":"string","example":"698761728"}},"required":["obp_activity_id","name","username","created_date"]}},"required":["bank-id","obp_activity"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["_ObpActivity(obp.testing.01)","Dynamic-Entity","Dynamic"],"summary":"Update ObpActivity","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Update ObpActivity.

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":"ObpActivity"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_updateObpActivity_obp.testing.01","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"},"username":{"type":"string","example":"James Brown"},"created_date":{"type":"string","example":"698761728"}},"required":["name","username","created_date"]}}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"bank-id":{"type":"string","example":"gh.29.uk"},"obp_activity":{"type":"object","properties":{"obp_activity_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"username":{"type":"string","example":"James Brown"},"created_date":{"type":"string","example":"698761728"}},"required":["obp_activity_id","name","username","created_date"]}},"required":["bank-id","obp_activity"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/customer_cars":{"get":{"tags":["_Customer_cars","Dynamic-Entity","Dynamic"],"summary":"Get customer_cars List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get customer_cars List.

The car the customer arrived in

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":"customer_cars"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Can do filter on the fields
e.g: /customer_cars?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

","operationId":"OBPv4.0.0-dynamicEntity_getcustomer_carsList_","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"customer_cars_list":{"type":"array","items":{"type":"object","properties":{"customer_cars_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_identifier":{"type":"string","example":"bc37e0fb-b75b-48d3-8fe9-c94ff064aa9a"},"manufacturer":{"type":"string","example":"BMW"}},"required":["customer_cars_id","customer_identifier","manufacturer"]}}},"required":["customer_cars_list"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["_Customer_cars","Dynamic-Entity","Dynamic"],"summary":"Create new customer_cars","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Create new customer_cars.

The car the customer arrived in

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":"customer_cars"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_createcustomer_cars_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"customer_identifier":{"type":"string","example":"bc37e0fb-b75b-48d3-8fe9-c94ff064aa9a"},"manufacturer":{"type":"string","example":"BMW"}},"required":["customer_identifier","manufacturer"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"customer_cars":{"type":"object","properties":{"customer_cars_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_identifier":{"type":"string","example":"bc37e0fb-b75b-48d3-8fe9-c94ff064aa9a"},"manufacturer":{"type":"string","example":"BMW"}},"required":["customer_cars_id","customer_identifier","manufacturer"]}},"required":["customer_cars"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/customer_cars/CUSTOMER_CARS_ID":{"delete":{"tags":["_Customer_cars","Dynamic-Entity","Dynamic"],"summary":"Delete customer_cars by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Delete customer_cars 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":"customer_cars"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_deletecustomer_cars_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"customer_identifier":{"type":"string","example":"bc37e0fb-b75b-48d3-8fe9-c94ff064aa9a"},"manufacturer":{"type":"string","example":"BMW"}},"required":["customer_identifier","manufacturer"]}}],"responses":{"204":{"description":"Success","schema":{"type":"object","properties":{"customer_cars":{"type":"object","properties":{"customer_cars_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_identifier":{"type":"string","example":"bc37e0fb-b75b-48d3-8fe9-c94ff064aa9a"},"manufacturer":{"type":"string","example":"BMW"}},"required":["customer_cars_id","customer_identifier","manufacturer"]}},"required":["customer_cars"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"get":{"tags":["_Customer_cars","Dynamic-Entity","Dynamic"],"summary":"Get customer_cars by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get customer_cars by id.

The car the customer arrived in

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":"customer_cars"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_getSinglecustomer_cars_","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"customer_cars":{"type":"object","properties":{"customer_cars_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_identifier":{"type":"string","example":"bc37e0fb-b75b-48d3-8fe9-c94ff064aa9a"},"manufacturer":{"type":"string","example":"BMW"}},"required":["customer_cars_id","customer_identifier","manufacturer"]}},"required":["customer_cars"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["_Customer_cars","Dynamic-Entity","Dynamic"],"summary":"Update customer_cars","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Update customer_cars.

The car the customer arrived in

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":"customer_cars"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_updatecustomer_cars_","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"customer_identifier":{"type":"string","example":"bc37e0fb-b75b-48d3-8fe9-c94ff064aa9a"},"manufacturer":{"type":"string","example":"BMW"}},"required":["customer_identifier","manufacturer"]}}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"customer_cars":{"type":"object","properties":{"customer_cars_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"customer_identifier":{"type":"string","example":"bc37e0fb-b75b-48d3-8fe9-c94ff064aa9a"},"manufacturer":{"type":"string","example":"BMW"}},"required":["customer_cars_id","customer_identifier","manufacturer"]}},"required":["customer_cars"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/my/test_daniel707":{"get":{"tags":["_Test_daniel707","Dynamic-Entity","Dynamic"],"summary":"Get My test_daniel707 List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get My test_daniel707 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":"test_daniel707"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Can do filter on the fields
e.g: /test_daniel707?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

","operationId":"OBPv4.0.0-dynamicEntity_getMytest_daniel707List_","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"test_daniel707_list":{"type":"array","items":{"type":"object","properties":{"test_daniel707_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["test_daniel707_id","name","number"]}}},"required":["test_daniel707_list"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["_Test_daniel707","Dynamic-Entity","Dynamic"],"summary":"Create new My test_daniel707","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Create new My test_daniel707.

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":"test_daniel707"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_createMytest_daniel707_","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":{"test_daniel707":{"type":"object","properties":{"test_daniel707_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["test_daniel707_id","name","number"]}},"required":["test_daniel707"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/my/test_daniel707/TEST_DANIEL707_ID":{"delete":{"tags":["_Test_daniel707","Dynamic-Entity","Dynamic"],"summary":"Delete My test_daniel707 by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Delete My test_daniel707 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":"test_daniel707"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_deleteMytest_daniel707_","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":{"test_daniel707":{"type":"object","properties":{"test_daniel707_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["test_daniel707_id","name","number"]}},"required":["test_daniel707"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"get":{"tags":["_Test_daniel707","Dynamic-Entity","Dynamic"],"summary":"Get My test_daniel707 by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get My test_daniel707 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":"test_daniel707"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_getSingleMytest_daniel707_","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"test_daniel707":{"type":"object","properties":{"test_daniel707_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["test_daniel707_id","name","number"]}},"required":["test_daniel707"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["_Test_daniel707","Dynamic-Entity","Dynamic"],"summary":"Update My test_daniel707","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Update My test_daniel707.

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":"test_daniel707"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_updateMytest_daniel707_","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":{"test_daniel707":{"type":"object","properties":{"test_daniel707_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["test_daniel707_id","name","number"]}},"required":["test_daniel707"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/sustrans":{"get":{"tags":["_Sustrans","Dynamic-Entity","Dynamic"],"summary":"Get sustrans List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get sustrans 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":"sustrans"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Can do filter on the fields
e.g: /sustrans?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

","operationId":"OBPv4.0.0-dynamicEntity_getsustransList_","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"sustrans_list":{"type":"array","items":{"type":"object","properties":{"sustrans_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["sustrans_id","name","number"]}}},"required":["sustrans_list"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["_Sustrans","Dynamic-Entity","Dynamic"],"summary":"Create new sustrans","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Create new sustrans.

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":"sustrans"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_createsustrans_","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":{"sustrans":{"type":"object","properties":{"sustrans_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["sustrans_id","name","number"]}},"required":["sustrans"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/sustrans/SUSTRANS_ID":{"delete":{"tags":["_Sustrans","Dynamic-Entity","Dynamic"],"summary":"Delete sustrans by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Delete sustrans 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":"sustrans"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_deletesustrans_","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":{"sustrans":{"type":"object","properties":{"sustrans_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["sustrans_id","name","number"]}},"required":["sustrans"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"get":{"tags":["_Sustrans","Dynamic-Entity","Dynamic"],"summary":"Get sustrans by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get sustrans 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":"sustrans"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_getSinglesustrans_","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"sustrans":{"type":"object","properties":{"sustrans_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["sustrans_id","name","number"]}},"required":["sustrans"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["_Sustrans","Dynamic-Entity","Dynamic"],"summary":"Update sustrans","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Update sustrans.

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":"sustrans"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_updatesustrans_","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":{"sustrans":{"type":"object","properties":{"sustrans_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["sustrans_id","name","number"]}},"required":["sustrans"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/test1":{"get":{"tags":["_Test1","Dynamic-Entity","Dynamic"],"summary":"Get test1 List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get test1 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":"test1"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Can do filter on the fields
e.g: /test1?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

","operationId":"OBPv4.0.0-dynamicEntity_gettest1List_","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"test1_list":{"type":"array","items":{"type":"object","properties":{"test1_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["test1_id","name","number"]}}},"required":["test1_list"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["_Test1","Dynamic-Entity","Dynamic"],"summary":"Create new test1","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Create new test1.

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":"test1"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_createtest1_","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":{"test1":{"type":"object","properties":{"test1_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["test1_id","name","number"]}},"required":["test1"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/test1/TEST1_ID":{"delete":{"tags":["_Test1","Dynamic-Entity","Dynamic"],"summary":"Delete test1 by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Delete test1 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":"test1"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_deletetest1_","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":{"test1":{"type":"object","properties":{"test1_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["test1_id","name","number"]}},"required":["test1"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"get":{"tags":["_Test1","Dynamic-Entity","Dynamic"],"summary":"Get test1 by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get test1 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":"test1"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_getSingletest1_","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"test1":{"type":"object","properties":{"test1_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["test1_id","name","number"]}},"required":["test1"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["_Test1","Dynamic-Entity","Dynamic"],"summary":"Update test1","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Update test1.

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":"test1"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_updatetest1_","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":{"test1":{"type":"object","properties":{"test1_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["test1_id","name","number"]}},"required":["test1"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/test_daniel707":{"get":{"tags":["_Test_daniel707","Dynamic-Entity","Dynamic"],"summary":"Get test_daniel707 List","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get test_daniel707 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":"test_daniel707"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Can do filter on the fields
e.g: /test_daniel707?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

","operationId":"OBPv4.0.0-dynamicEntity_gettest_daniel707List_","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"test_daniel707_list":{"type":"array","items":{"type":"object","properties":{"test_daniel707_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["test_daniel707_id","name","number"]}}},"required":["test_daniel707_list"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["_Test_daniel707","Dynamic-Entity","Dynamic"],"summary":"Create new test_daniel707","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Create new test_daniel707.

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":"test_daniel707"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_createtest_daniel707_","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":{"test_daniel707":{"type":"object","properties":{"test_daniel707_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["test_daniel707_id","name","number"]}},"required":["test_daniel707"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/dynamic-entity/test_daniel707/TEST_DANIEL707_ID":{"delete":{"tags":["_Test_daniel707","Dynamic-Entity","Dynamic"],"summary":"Delete test_daniel707 by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Delete test_daniel707 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":"test_daniel707"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_deletetest_daniel707_","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":{"test_daniel707":{"type":"object","properties":{"test_daniel707_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["test_daniel707_id","name","number"]}},"required":["test_daniel707"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"get":{"tags":["_Test_daniel707","Dynamic-Entity","Dynamic"],"summary":"Get test_daniel707 by id","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get test_daniel707 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":"test_daniel707"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_getSingletest_daniel707_","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"test_daniel707":{"type":"object","properties":{"test_daniel707_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["test_daniel707_id","name","number"]}},"required":["test_daniel707"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["_Test_daniel707","Dynamic-Entity","Dynamic"],"summary":"Update test_daniel707","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Update test_daniel707.

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":"test_daniel707"    }    {        "key":"url",        "value":"http://mydomain.com/xxx"    }  ]}

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

","operationId":"OBPv4.0.0-dynamicEntity_updatetest_daniel707_","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":{"test_daniel707":{"type":"object","properties":{"test_daniel707_id":{"type":"string","example":"d8839721-ad8f-45dd-9f78-2080414b93f9"},"name":{"type":"string","example":"James Brown"},"number":{"type":"integer","format":"int32","example":"698761728"}},"required":["test_daniel707_id","name","number"]}},"required":["test_daniel707"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/account-access-consents":{"post":{"tags":["Account Access"],"summary":"Create Account Access Consents","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Create Account Access Consents

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON request body fields:

JSON response body fields:

","operationId":"UKv3.1-createAccountAccessConsents","parameters":[{"in":"body","name":"body","description":"JvalueCaseClass object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/JvalueCaseClass"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/account-access-consents/{CONSENT_ID}":{"delete":{"tags":["Account Access"],"summary":"Delete Account Access Consents","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Delete Account Access Consents

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

CONSENT_ID: 9d429899-24f5-42c8-8565-943ffa6a7947

JSON response body fields:

","operationId":"UKv3.1-deleteAccountAccessConsentsConsentId","parameters":[{"in":"path","name":"CONSENT_ID","description":"the consent id","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"get":{"tags":["Account Access"],"summary":"Get Account Access Consents","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get Account Access Consents

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

CONSENT_ID: 9d429899-24f5-42c8-8565-943ffa6a7947

JSON response body fields:

","operationId":"UKv3.1-getAccountAccessConsentsConsentId","parameters":[{"in":"path","name":"CONSENT_ID","description":"the consent id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/accounts":{"get":{"tags":["Accounts"],"summary":"Get Accounts","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON response body fields:

","operationId":"UKv3.1-getAccounts","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/accounts/ACCOUNTID/beneficiaries":{"get":{"tags":["Beneficiaries","Mocked-Data"],"summary":"Get Beneficiaries","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNTID: ACCOUNTID

JSON response body fields:

","operationId":"UKv3.1-getAccountsAccountIdBeneficiaries","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/accounts/ACCOUNTID/direct-debits":{"get":{"tags":["Direct Debits","Mocked-Data"],"summary":"Get Direct Debits","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNTID: ACCOUNTID

JSON response body fields:

","operationId":"UKv3.1-getAccountsAccountIdDirectDebits","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/accounts/ACCOUNTID/offers":{"get":{"tags":["Offers","Mocked-Data"],"summary":"Get Offers","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNTID: ACCOUNTID

JSON response body fields:

","operationId":"UKv3.1-getAccountsAccountIdOffers","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/accounts/ACCOUNTID/party":{"get":{"tags":["Partys","Mocked-Data"],"summary":"Get Party","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNTID: ACCOUNTID

JSON response body fields:

","operationId":"UKv3.1-getAccountsAccountIdParty","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/accounts/ACCOUNTID/product":{"get":{"tags":["Products","Mocked-Data"],"summary":"Get Products","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNTID: ACCOUNTID

JSON response body fields:

","operationId":"UKv3.1-getAccountsAccountIdProduct","parameters":[],"responses":{"200":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/accounts/ACCOUNTID/scheduled-payments":{"get":{"tags":["Scheduled Payments","Mocked-Data"],"summary":"Get Scheduled Payments","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNTID: ACCOUNTID

JSON response body fields:

","operationId":"UKv3.1-getAccountsAccountIdScheduledPayments","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/accounts/ACCOUNTID/standing-orders":{"get":{"tags":["Standing Orders","Mocked-Data"],"summary":"Get Standing Orders","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNTID: ACCOUNTID

JSON response body fields:

","operationId":"UKv3.1-getAccountsAccountIdStandingOrders","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/accounts/ACCOUNTID/statements":{"get":{"tags":["Statements","Mocked-Data"],"summary":"Get Statements","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNTID: ACCOUNTID

JSON response body fields:

","operationId":"UKv3.1-getAccountsAccountIdStatements","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/accounts/ACCOUNTID/statements/STATEMENTID":{"get":{"tags":["Statements","Mocked-Data"],"summary":"Get Statements","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNTID: ACCOUNTID

STATEMENTID: STATEMENTID

JSON response body fields:

","operationId":"UKv3.1-getAccountsAccountIdStatementsStatementId","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/accounts/ACCOUNTID/statements/STATEMENTID/file":{"get":{"tags":["Statements","Mocked-Data"],"summary":"Get Statements","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNTID: ACCOUNTID

STATEMENTID: STATEMENTID

JSON response body fields:

","operationId":"UKv3.1-getAccountsAccountIdStatementsStatementIdFile","parameters":[],"responses":{"200":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/accounts/ACCOUNTID/statements/STATEMENTID/transactions":{"get":{"tags":["Statements","Transactions","Mocked-Data"],"summary":"Get Transactions","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNTID: ACCOUNTID

STATEMENTID: STATEMENTID

JSON response body fields:

","operationId":"UKv3.1-getAccountsAccountIdStatementsStatementIdTransactions","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/accounts/{ACCOUNT_ID}":{"get":{"tags":["Accounts"],"summary":"Get Accounts","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

JSON response body fields:

","operationId":"UKv3.1-getAccountsAccountId","parameters":[{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/accounts/{ACCOUNT_ID}/balances":{"get":{"tags":["Balances"],"summary":"Get Balances","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

JSON response body fields:

","operationId":"UKv3.1-getAccountsAccountIdBalances","parameters":[{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/accounts/{ACCOUNT_ID}/transactions":{"get":{"tags":["Transactions"],"summary":"Get Transactions","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

JSON response body fields:

","operationId":"UKv3.1-getAccountsAccountIdTransactions","parameters":[{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/balances":{"get":{"tags":["Balances"],"summary":"Get Balances","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON response body fields:

","operationId":"UKv3.1-getBalances","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/beneficiaries":{"get":{"tags":["Beneficiaries","Mocked-Data"],"summary":"Get Beneficiaries","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON response body fields:

","operationId":"UKv3.1-getBeneficiaries","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/direct-debits":{"get":{"tags":["Direct Debits","Mocked-Data"],"summary":"Get Direct Debits","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON response body fields:

","operationId":"UKv3.1-getDirectDebits","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/domestic-payment-consents":{"post":{"tags":["Domestic Payments","Mocked-Data"],"summary":"Create Domestic Payment Consents","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON request body fields:

JSON response body fields:

","operationId":"UKv3.1-createDomesticPaymentConsents","parameters":[],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/domestic-payment-consents/CONSENTID":{"get":{"tags":["Domestic Payments","Mocked-Data"],"summary":"Get Domestic Payment Consents","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

CONSENTID: CONSENTID

JSON response body fields:

","operationId":"UKv3.1-getDomesticPaymentConsentsConsentId","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/domestic-payment-consents/CONSENTID/funds-confirmation":{"get":{"tags":["Domestic Payments","Mocked-Data"],"summary":"Get Domestic Payment Consents Funds Confirmation","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

CONSENTID: CONSENTID

JSON response body fields:

","operationId":"UKv3.1-getDomesticPaymentConsentsConsentIdFundsConfirmation","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/domestic-payments":{"post":{"tags":["Domestic Payments","Mocked-Data"],"summary":"Create Domestic Payments","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON request body fields:

JSON response body fields:

","operationId":"UKv3.1-createDomesticPayments","parameters":[],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/domestic-payments/DOMESTICPAYMENTID":{"get":{"tags":["Domestic Payments","Mocked-Data"],"summary":"Get Domestic Payments","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

DOMESTICPAYMENTID: DOMESTICPAYMENTID

JSON response body fields:

","operationId":"UKv3.1-getDomesticPaymentsDomesticPaymentId","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/domestic-scheduled-payment-consents":{"post":{"tags":["Domestic Scheduled Payments","Mocked-Data"],"summary":"Create Domestic Scheduled Payment Consents","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON request body fields:

JSON response body fields:

","operationId":"UKv3.1-createDomesticScheduledPaymentConsents","parameters":[],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/domestic-scheduled-payment-consents/CONSENTID":{"get":{"tags":["Domestic Scheduled Payments","Mocked-Data"],"summary":"Get Domestic Scheduled Payment Consents","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

CONSENTID: CONSENTID

JSON response body fields:

","operationId":"UKv3.1-getDomesticScheduledPaymentConsentsConsentId","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/domestic-scheduled-payments":{"post":{"tags":["Domestic Scheduled Payments","Mocked-Data"],"summary":"Create Domestic Scheduled Payments","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON request body fields:

JSON response body fields:

","operationId":"UKv3.1-createDomesticScheduledPayments","parameters":[],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/domestic-scheduled-payments/DOMESTICSCHEDULEDPAYMENTID":{"get":{"tags":["Domestic Scheduled Payments","Mocked-Data"],"summary":"Get Domestic Scheduled Payments","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

DOMESTICSCHEDULEDPAYMENTID: DOMESTICSCHEDULEDPAYMENTID

JSON response body fields:

","operationId":"UKv3.1-getDomesticScheduledPaymentsDomesticScheduledPaymentId","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/domestic-standing-order-consents":{"post":{"tags":["Domestic Standing Orders","Mocked-Data"],"summary":"Create Domestic Standing Order Consents","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON request body fields:

JSON response body fields:

","operationId":"UKv3.1-createDomesticStandingOrderConsents","parameters":[],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/domestic-standing-order-consents/CONSENTID":{"get":{"tags":["Domestic Standing Orders","Mocked-Data"],"summary":"Get Domestic Standing Order Consents","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

CONSENTID: CONSENTID

JSON response body fields:

","operationId":"UKv3.1-getDomesticStandingOrderConsentsConsentId","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/domestic-standing-orders":{"post":{"tags":["Domestic Standing Orders","Mocked-Data"],"summary":"Create Domestic Standing Orders","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON request body fields:

JSON response body fields:

","operationId":"UKv3.1-createDomesticStandingOrders","parameters":[],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/domestic-standing-orders/DOMESTICSTANDINGORDERID":{"get":{"tags":["Domestic Standing Orders","Mocked-Data"],"summary":"Get Domestic Standing Orders","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

DOMESTICSTANDINGORDERID: DOMESTICSTANDINGORDERID

JSON response body fields:

","operationId":"UKv3.1-getDomesticStandingOrdersDomesticStandingOrderId","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/file-payment-consents":{"post":{"tags":["File Payments","Mocked-Data"],"summary":"Create File Payment Consents","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON request body fields:

JSON response body fields:

","operationId":"UKv3.1-createFilePaymentConsents","parameters":[],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/file-payment-consents/CONSENTID":{"get":{"tags":["File Payments","Mocked-Data"],"summary":"Get File Payment Consents","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

CONSENTID: CONSENTID

JSON response body fields:

","operationId":"UKv3.1-getFilePaymentConsentsConsentId","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/file-payment-consents/CONSENTID/file":{"get":{"tags":["File Payments","Mocked-Data"],"summary":"Get File Payment Consents","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

CONSENTID: CONSENTID

JSON response body fields:

","operationId":"UKv3.1-getFilePaymentConsentsConsentIdFile","parameters":[],"responses":{"200":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["File Payments","Mocked-Data"],"summary":"Create File Payment Consents","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

CONSENTID: CONSENTID

JSON request body fields:

JSON response body fields:

","operationId":"UKv3.1-createFilePaymentConsentsConsentIdFile","parameters":[],"responses":{"201":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/file-payments":{"post":{"tags":["File Payments","Mocked-Data"],"summary":"Create File Payments","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON request body fields:

JSON response body fields:

","operationId":"UKv3.1-createFilePayments","parameters":[],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/file-payments/FILEPAYMENTID":{"get":{"tags":["File Payments","Mocked-Data"],"summary":"Get File Payments","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

FILEPAYMENTID: FILEPAYMENTID

JSON response body fields:

","operationId":"UKv3.1-getFilePaymentsFilePaymentId","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/file-payments/FILEPAYMENTID/report-file":{"get":{"tags":["File Payments","Mocked-Data"],"summary":"Get File Payments","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

FILEPAYMENTID: FILEPAYMENTID

JSON response body fields:

","operationId":"UKv3.1-getFilePaymentsFilePaymentIdReportFile","parameters":[],"responses":{"200":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/funds-confirmation-consents":{"post":{"tags":["Funds Confirmations","Mocked-Data"],"summary":"Create Funds Confirmation Consent","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON request body fields:

JSON response body fields:

","operationId":"UKv3.1-createFundsConfirmationConsents","parameters":[],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/funds-confirmation-consents/CONSENTID":{"delete":{"tags":["Funds Confirmations","Mocked-Data"],"summary":"Delete Funds Confirmation Consent","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

CONSENTID: CONSENTID

JSON response body fields:

","operationId":"UKv3.1-deleteFundsConfirmationConsentsConsentId","parameters":[],"responses":{"204":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"get":{"tags":["Funds Confirmations","Mocked-Data"],"summary":"Get Funds Confirmation Consent","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

CONSENTID: CONSENTID

JSON response body fields:

","operationId":"UKv3.1-getFundsConfirmationConsentsConsentId","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/funds-confirmations":{"post":{"tags":["Funds Confirmations","Mocked-Data"],"summary":"Create Funds Confirmation","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON request body fields:

JSON response body fields:

","operationId":"UKv3.1-createFundsConfirmations","parameters":[],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/international-payment-consents":{"post":{"tags":["International Payments","Mocked-Data"],"summary":"Create International Payment Consents","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON request body fields:

JSON response body fields:

","operationId":"UKv3.1-createInternationalPaymentConsents","parameters":[],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/international-payment-consents/CONSENTID":{"get":{"tags":["International Payments","Mocked-Data"],"summary":"Get International Payment Consents","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

CONSENTID: CONSENTID

JSON response body fields:

","operationId":"UKv3.1-getInternationalPaymentConsentsConsentId","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/international-payment-consents/CONSENTID/funds-confirmation":{"get":{"tags":["International Payments","Mocked-Data"],"summary":"Get International Payment Consents Funds Confirmation","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

CONSENTID: CONSENTID

JSON response body fields:

","operationId":"UKv3.1-getInternationalPaymentConsentsConsentIdFundsConfirmation","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/international-payments":{"post":{"tags":["International Payments","Mocked-Data"],"summary":"Create International Payments","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON request body fields:

JSON response body fields:

","operationId":"UKv3.1-createInternationalPayments","parameters":[],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/international-payments/INTERNATIONALPAYMENTID":{"get":{"tags":["International Payments","Mocked-Data"],"summary":"Get International Payments","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

INTERNATIONALPAYMENTID: INTERNATIONALPAYMENTID

JSON response body fields:

","operationId":"UKv3.1-getInternationalPaymentsInternationalPaymentId","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/international-scheduled-payment-consents":{"post":{"tags":["International Scheduled Payments","Mocked-Data"],"summary":"Create International Scheduled Payment Consents","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON request body fields:

JSON response body fields:

","operationId":"UKv3.1-createInternationalScheduledPaymentConsents","parameters":[],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/international-scheduled-payment-consents/CONSENTID":{"get":{"tags":["International Scheduled Payments","Mocked-Data"],"summary":"Get International Scheduled Payment Consents","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

CONSENTID: CONSENTID

JSON response body fields:

","operationId":"UKv3.1-getInternationalScheduledPaymentConsentsConsentId","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/international-scheduled-payment-consents/CONSENTID/funds-confirmation":{"get":{"tags":["International Scheduled Payments","Mocked-Data"],"summary":"Get International Scheduled Payment Consents Funds Confirmation","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

CONSENTID: CONSENTID

JSON response body fields:

","operationId":"UKv3.1-getInternationalScheduledPaymentConsentsConsentIdFundsConfirmation","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/international-scheduled-payments":{"post":{"tags":["International Scheduled Payments","Mocked-Data"],"summary":"Create International Scheduled Payments","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON request body fields:

JSON response body fields:

","operationId":"UKv3.1-createInternationalScheduledPayments","parameters":[],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/international-scheduled-payments/INTERNATIONALSCHEDULEDPAYMENTID":{"get":{"tags":["International Scheduled Payments","Mocked-Data"],"summary":"Get International Scheduled Payments","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

INTERNATIONALSCHEDULEDPAYMENTID: INTERNATIONALSCHEDULEDPAYMENTID

JSON response body fields:

","operationId":"UKv3.1-getInternationalScheduledPaymentsInternationalScheduledPaymentId","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/international-standing-order-consents":{"post":{"tags":["International Standing Orders","Mocked-Data"],"summary":"Create International Standing Order Consents","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON request body fields:

JSON response body fields:

","operationId":"UKv3.1-createInternationalStandingOrderConsents","parameters":[],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/international-standing-order-consents/CONSENTID":{"get":{"tags":["International Standing Orders","Mocked-Data"],"summary":"Get International Standing Order Consents","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

CONSENTID: CONSENTID

JSON response body fields:

","operationId":"UKv3.1-getInternationalStandingOrderConsentsConsentId","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/international-standing-orders":{"post":{"tags":["International Standing Orders","Mocked-Data"],"summary":"Create International Standing Orders","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON request body fields:

JSON response body fields:

","operationId":"UKv3.1-createInternationalStandingOrders","parameters":[],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/international-standing-orders/INTERNATIONALSTANDINGORDERPAYMENTID":{"get":{"tags":["International Standing Orders","Mocked-Data"],"summary":"Get International Standing Orders","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

INTERNATIONALSTANDINGORDERPAYMENTID: INTERNATIONALSTANDINGORDERPAYMENTID

JSON response body fields:

","operationId":"UKv3.1-getInternationalStandingOrdersInternationalStandingOrderPaymentId","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/offers":{"get":{"tags":["Offers","Mocked-Data"],"summary":"Get Offers","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON response body fields:

","operationId":"UKv3.1-getOffers","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/party":{"get":{"tags":["Partys","Mocked-Data"],"summary":"Get Party","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON response body fields:

","operationId":"UKv3.1-getParty","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/products":{"get":{"tags":["Products","Mocked-Data"],"summary":"Get Products","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON response body fields:

","operationId":"UKv3.1-getProducts","parameters":[],"responses":{"200":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/scheduled-payments":{"get":{"tags":["Scheduled Payments","Mocked-Data"],"summary":"Get Scheduled Payments","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON response body fields:

","operationId":"UKv3.1-getScheduledPayments","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/standing-orders":{"get":{"tags":["Standing Orders","Mocked-Data"],"summary":"Get Standing Orders","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON response body fields:

","operationId":"UKv3.1-getStandingOrders","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/statements":{"get":{"tags":["Statements","Mocked-Data"],"summary":"Get Statements","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

NOTE: This endpoint currently only returns example data.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON response body fields:

","operationId":"UKv3.1-getStatements","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/open-banking/v3.1/transactions":{"get":{"tags":["Transactions"],"summary":"Get Transactions","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON response body fields:

","operationId":"UKv3.1-getTransactions","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/JvalueCaseClass"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}}},"definitions":{"ErrorAuthenticatedUserIsRequired":{"properties":{"message":{"type":"string","example":"OBP-20001: User not logged in. Authentication is required!"}}},"ErrorUnknownError":{"properties":{"message":{"type":"string","example":"OBP-50000: Unknown Error."}}},"RequestRootJsonClass":{"required":["name","age","hobby"],"properties":{"name":{"type":"string","example":"ACCOUNT_MANAGEMENT_FEE"},"age":{"type":"integer","format":"int64","example":"18"},"hobby":{"type":"array","items":{"type":"string"}}}},"JvalueCaseClass":{"required":["jvalueToCaseclass"],"properties":{"jvalueToCaseclass":{"type":"object","properties":{"Data":{"type":"object","properties":{"Permissions":{"type":"array","items":{"type":"string","example":"ReadAccountsBasic"}},"ExpirationDateTime":{"type":"string","example":"2020-10-20T08:40:47.285Z"},"TransactionFromDateTime":{"type":"string","example":"2020-10-20T08:40:47.285Z"},"TransactionToDateTime":{"type":"string","example":"2020-10-20T08:40:47.285Z"}},"required":["Permissions","ExpirationDateTime","TransactionFromDateTime","TransactionToDateTime"]},"Risk":{"type":"string","example":""}},"required":["Data","Risk"]}}}}}